diff --git a/CHANGELOG.md b/CHANGELOG.md index b0cac4d4..71dce6e6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,13 @@ All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. +## [3.7.0](https://github.com/box/box-node-sdk/compare/v3.6.0...v3.7.0) (2024-07-16) + + +### New Features and Enhancements + +* Support AI APIs ([#883](https://github.com/box/box-node-sdk/issues/883)) ([bb81e07](https://github.com/box/box-node-sdk/commit/bb81e074eb1017bd742c90159e6cf4e6ce9d9776)) + ## [3.6.0](https://github.com/box/box-node-sdk/compare/v3.5.1...v3.6.0) (2024-05-20) diff --git a/docs/jsdoc/AIManager.html b/docs/jsdoc/AIManager.html new file mode 100644 index 00000000..e7d5eb2b --- /dev/null +++ b/docs/jsdoc/AIManager.html @@ -0,0 +1,1174 @@ + + + + + JSDoc: Class: AIManager + + + + + + + + + + +
+ +

Class: AIManager

+ + + + + + +
+ +
+ +

AIManager(client)

+ + +
+ +
+
+ + + + + + +

new AIManager(client)

+ + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
client + + +BoxClient + + + + The Box API Client that is responsible for making calls to the API
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +

Classes

+ +
+
AIManager
+
+
+ + + + + + + + + + + +

Methods

+ + + + + + + +

ask(body, optionsopt, callbackopt) → {Promise.<schemas.AiResponse>}

+ + + + + + +
+ Send AI question request + +Sends an AI request to supported LLMs and returns an answer specifically focused on the user's question given the provided context. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
body + + +schemas.AiAsk + + + + + + + + + +
options + + +object + + + + + + <optional>
+ + + + + + 		Options for the request
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the result if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the result or rejecting with an error +
+ + + +
+
+ Type +
+
+ +Promise.<schemas.AiResponse> + + +
+
+ + + + + + + + + + + + + +

ask(body, optionsopt, callbackopt) → {Promise.<schemas.AiResponse>}

+ + + + + + +
+ Send AI question request + +Sends an AI request to supported LLMs and returns an answer specifically focused on the user's question given the provided context. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
body + + +schemas.AiAsk + + + + + + + + + +
options + + +object + + + + + + <optional>
+ + + + + + 		Options for the request
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the result if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the result or rejecting with an error +
+ + + +
+
+ Type +
+
+ +Promise.<schemas.AiResponse> + + +
+
+ + + + + + + + + + + + + +

textGen(body, optionsopt, callbackopt) → {Promise.<schemas.AiResponse>}

+ + + + + + +
+ Send AI request to generate text + +Sends an AI request to supported LLMs and returns an answer specifically focused on the creation of new text. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
body + + +schemas.AiTextGen + + + + + + + + + +
options + + +object + + + + + + <optional>
+ + + + + + 		Options for the request
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the result if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the result or rejecting with an error +
+ + + +
+
+ Type +
+
+ +Promise.<schemas.AiResponse> + + +
+
+ + + + + + + + + + + + + +

textGen(body, optionsopt, callbackopt) → {Promise.<schemas.AiResponse>}

+ + + + + + +
+ Send AI request to generate text + +Sends an AI request to supported LLMs and returns an answer specifically focused on the creation of new text. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
body + + +schemas.AiTextGen + + + + + + + + + +
options + + +object + + + + + + <optional>
+ + + + + + 		Options for the request
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the result if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the result or rejecting with an error +
+ + + +
+
+ Type +
+
+ +Promise.<schemas.AiResponse> + + +
+
+ + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + + \ No newline at end of file diff --git a/docs/jsdoc/AIManager_AIManager.html b/docs/jsdoc/AIManager_AIManager.html new file mode 100644 index 00000000..652beffc --- /dev/null +++ b/docs/jsdoc/AIManager_AIManager.html @@ -0,0 +1,216 @@ + + + + + JSDoc: Class: AIManager + + + + + + + + + + +
+ +

Class: AIManager

+ + + + + + +
+ +
+ +

+ AIManager#AIManager(client)

+ + +
+ +
+
+ + + + + + +

new AIManager(client)

+ + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
client + + +BoxClient + + + + The Box API Client that is responsible for making calls to the API
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + + \ No newline at end of file diff --git a/docs/jsdoc/APIRequest.html b/docs/jsdoc/APIRequest.html index 9c14c1e9..66fd44fe 100644 --- a/docs/jsdoc/APIRequest.html +++ b/docs/jsdoc/APIRequest.html @@ -794,13 +794,13 @@
Returns:

diff --git a/docs/jsdoc/APIRequestManager.html b/docs/jsdoc/APIRequestManager.html index 7d61f068..5cbf7a03 100644 --- a/docs/jsdoc/APIRequestManager.html +++ b/docs/jsdoc/APIRequestManager.html @@ -867,13 +867,13 @@
Returns:

diff --git a/docs/jsdoc/AiAsk.html b/docs/jsdoc/AiAsk.html new file mode 100644 index 00000000..b8c6ff75 --- /dev/null +++ b/docs/jsdoc/AiAsk.html @@ -0,0 +1,487 @@ + + + + + JSDoc: Interface: AiAsk + + + + + + + + + + +
+ +

Interface: AiAsk

+ + + + + + +
+ +
+ +

AiAsk

+ + +
+ +
+
+ + +
AI Ask Request + +AI Ask request object
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + +
+ + + + + + + + + + + + + + +

Members

+ + + +

items :Array

+ + + + +
+ The items to be processed by the LLM, often files. + +**Note**: Box AI handles documents with text representations up to 1MB in size, or a maximum of 25 files, whichever comes first. +If the file size exceeds 1MB, the first 1MB of text representation will be processed. +If you set `mode` parameter to `single_item_qa`, the `items` array can have one element only. +
+ + + +
Type:
+
    +
  • + +Array + + +
    • +
+ + + + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
[].id + + +string + + + + + + <optional>
+ + + +
[].type + + +string + + + + + + <optional>
+ + + +
[].content + + +string + + + + + + <optional>
+ + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

mode :'multiple_item_qa'|'single_item_qa'

+ + + + +
+ The mode specifies if this request is for a single or multiple items. If you select `single_item_qa` the `items` array can have one element only. Selecting `multiple_item_qa` allows you to provide up to 25 items. +Example: multiple_item_qa +
+ + + +
Type:
+
    +
  • + +'multiple_item_qa' +| + +'single_item_qa' + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

prompt :string

+ + + + +
+ The prompt provided by the client to be answered by the LLM. The prompt's length is limited to 10000 characters. +Example: What is the value provided by public APIs based on this document? +
+ + + +
Type:
+
    +
  • + +string + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + + \ No newline at end of file diff --git a/docs/jsdoc/AiResponse.html b/docs/jsdoc/AiResponse.html new file mode 100644 index 00000000..d6f39516 --- /dev/null +++ b/docs/jsdoc/AiResponse.html @@ -0,0 +1,357 @@ + + + + + JSDoc: Interface: AiResponse + + + + + + + + + + +
+ +

Interface: AiResponse

+ + + + + + +
+ +
+ +

AiResponse

+ + +
+ +
+
+ + +
AI Response + +AI response
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + +
+ + + + + + + + + + + + + + +

Members

+ + + +

answer :string

+ + + + +
+ The answer provided by the LLM. +Example: Public APIs are important because of key and important reasons. +
+ + + +
Type:
+
    +
  • + +string + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

completion_reason :string

+ + + + +
+ The reason the response finishes. +Example: done +
+ + + +
Type:
+
    +
  • + +string + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

created_at :string

+ + + + +
+ The ISO date formatted timestamp of when the answer to the prompt was created. +Example: 2012-12-12T10:53:43-08:00 +
+ + + +
Type:
+
    +
  • + +string + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + + \ No newline at end of file diff --git a/docs/jsdoc/AiTextGen.html b/docs/jsdoc/AiTextGen.html new file mode 100644 index 00000000..d5f5e65c --- /dev/null +++ b/docs/jsdoc/AiTextGen.html @@ -0,0 +1,607 @@ + + + + + JSDoc: Interface: AiTextGen + + + + + + + + + + +
+ +

Interface: AiTextGen

+ + + + + + +
+ +
+ +

AiTextGen

+ + +
+ +
+
+ + +
AI Text Gen Request + +AI Text Gen Request object
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + +
+ + + + + + + + + + + + + + +

Members

+ + + +

dialogue_history :Array

+ + + + +
+ The history of prompts and answers previously passed to the LLM. This provides additional context to the LLM in generating the response. +
+ + + +
Type:
+
    +
  • + +Array + + +
    • +
+ + + + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
[].answer + + +string + + + + + + <optional>
+ + + +
[].created_at + + +string + + + + + + <optional>
+ + + +
[].prompt + + +string + + + + + + <optional>
+ + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

items :Array

+ + + + +
+ The items to be processed by the LLM, often files. +The array can include **exactly one** element. + +**Note**: Box AI handles documents with text representations up to 1MB in size. +If the file size exceeds 1MB, the first 1MB of text representation will be processed. +
+ + + +
Type:
+
    +
  • + +Array + + +
    • +
+ + + + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
[].id + + +string + + + + + + <optional>
+ + + +
[].type + + +string + + + + + + <optional>
+ + + +
[].content + + +string + + + + + + <optional>
+ + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

prompt :string

+ + + + +
+ The prompt provided by the client to be answered by the LLM. The prompt's length is limited to 10000 characters. +Example: Write an email to a client about the importance of public APIs. +
+ + + +
Type:
+
    +
  • + +string + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + + \ No newline at end of file diff --git a/docs/jsdoc/AppAuthSession.html b/docs/jsdoc/AppAuthSession.html index c697f725..9ca82897 100644 --- a/docs/jsdoc/AppAuthSession.html +++ b/docs/jsdoc/AppAuthSession.html @@ -2033,13 +2033,13 @@
Returns:

diff --git a/docs/jsdoc/BasicSession.html b/docs/jsdoc/BasicSession.html index 6dcd412d..264618ba 100644 --- a/docs/jsdoc/BasicSession.html +++ b/docs/jsdoc/BasicSession.html @@ -1465,13 +1465,13 @@
Returns:

diff --git a/docs/jsdoc/BoxClient.html b/docs/jsdoc/BoxClient.html index 78f60e78..3595da41 100644 --- a/docs/jsdoc/BoxClient.html +++ b/docs/jsdoc/BoxClient.html @@ -191,7 +191,7 @@
Parameters:
Source:
@@ -296,7 +296,7 @@
Type:
Source:
@@ -581,7 +581,7 @@
Properties:
Source:
@@ -649,7 +649,7 @@
Type:
Source:
@@ -796,7 +796,7 @@
Properties:
Source:
@@ -877,7 +877,7 @@

asSelfSource:
@@ -1033,7 +1033,7 @@
Parameters:
Source:
@@ -1231,7 +1231,7 @@
Parameters:
Source:
@@ -1392,7 +1392,7 @@
Parameters:
Source:
@@ -1625,7 +1625,7 @@
Parameters:
Source:
@@ -1986,7 +1986,7 @@
Properties
Source:
@@ -2221,7 +2221,7 @@
Parameters:
Source:
@@ -2450,7 +2450,7 @@
Parameters:
Source:
@@ -2679,7 +2679,7 @@
Parameters:
Source:
@@ -2922,7 +2922,7 @@
Parameters:
Source:
@@ -3151,7 +3151,7 @@
Parameters:
Source:
@@ -3257,7 +3257,7 @@

re
Source:
@@ -3425,7 +3425,7 @@

Parameters:
Source:
@@ -3608,7 +3608,7 @@
Parameters:
Source:
@@ -3764,7 +3764,7 @@
Parameters:
Source:
@@ -3962,7 +3962,7 @@
Parameters:
Source:
@@ -4224,7 +4224,7 @@
Parameters:
Source:
@@ -4379,7 +4379,7 @@
Parameters:
Source:
@@ -4447,13 +4447,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/BoxSDKNode.html b/docs/jsdoc/BoxSDKNode.html index d35ebaad..1ca27f15 100644 --- a/docs/jsdoc/BoxSDKNode.html +++ b/docs/jsdoc/BoxSDKNode.html @@ -5909,13 +5909,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/CCGSession.html b/docs/jsdoc/CCGSession.html index f108b2de..e25c94b0 100644 --- a/docs/jsdoc/CCGSession.html +++ b/docs/jsdoc/CCGSession.html @@ -1519,13 +1519,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Chunk_Chunk.html b/docs/jsdoc/Chunk_Chunk.html index a48f8898..3e7b3a37 100644 --- a/docs/jsdoc/Chunk_Chunk.html +++ b/docs/jsdoc/Chunk_Chunk.html @@ -371,13 +371,13 @@
Properties

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ChunkedUploader.html b/docs/jsdoc/ChunkedUploader.html index cdca3c6d..de15f72b 100644 --- a/docs/jsdoc/ChunkedUploader.html +++ b/docs/jsdoc/ChunkedUploader.html @@ -1514,13 +1514,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ChunkedUploader_ChunkedUploader.html b/docs/jsdoc/ChunkedUploader_ChunkedUploader.html index 5a377434..bc959ac4 100644 --- a/docs/jsdoc/ChunkedUploader_ChunkedUploader.html +++ b/docs/jsdoc/ChunkedUploader_ChunkedUploader.html @@ -492,13 +492,13 @@
Properties

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/CollaborationAllowlist.html b/docs/jsdoc/CollaborationAllowlist.html index 850cb53f..e886f8e3 100644 --- a/docs/jsdoc/CollaborationAllowlist.html +++ b/docs/jsdoc/CollaborationAllowlist.html @@ -4164,13 +4164,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Collaborations.html b/docs/jsdoc/Collaborations.html index 98cc38ec..1021f4a9 100644 --- a/docs/jsdoc/Collaborations.html +++ b/docs/jsdoc/Collaborations.html @@ -6048,13 +6048,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Collections.html b/docs/jsdoc/Collections.html index 3469d888..d6513194 100644 --- a/docs/jsdoc/Collections.html +++ b/docs/jsdoc/Collections.html @@ -1050,13 +1050,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Comments.html b/docs/jsdoc/Comments.html index 31768759..ba0aef9a 100644 --- a/docs/jsdoc/Comments.html +++ b/docs/jsdoc/Comments.html @@ -3472,13 +3472,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Config.html b/docs/jsdoc/Config.html index a7375f32..7f4720c1 100644 --- a/docs/jsdoc/Config.html +++ b/docs/jsdoc/Config.html @@ -529,13 +529,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/DevicePins.html b/docs/jsdoc/DevicePins.html index fd6442dd..585fd472 100644 --- a/docs/jsdoc/DevicePins.html +++ b/docs/jsdoc/DevicePins.html @@ -1592,13 +1592,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Enterprise.html b/docs/jsdoc/Enterprise.html index e621cc4d..9afa1ec4 100644 --- a/docs/jsdoc/Enterprise.html +++ b/docs/jsdoc/Enterprise.html @@ -4554,13 +4554,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/EnterpriseBase.html b/docs/jsdoc/EnterpriseBase.html index 2d2f096c..53c871c9 100644 --- a/docs/jsdoc/EnterpriseBase.html +++ b/docs/jsdoc/EnterpriseBase.html @@ -270,13 +270,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/EnterpriseEventStream.html b/docs/jsdoc/EnterpriseEventStream.html index ba783886..8a4f7a72 100644 --- a/docs/jsdoc/EnterpriseEventStream.html +++ b/docs/jsdoc/EnterpriseEventStream.html @@ -1266,13 +1266,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/EventStream.html b/docs/jsdoc/EventStream.html index 73c0d66a..2faebd53 100644 --- a/docs/jsdoc/EventStream.html +++ b/docs/jsdoc/EventStream.html @@ -546,13 +546,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Events.html b/docs/jsdoc/Events.html index b7114079..443837f1 100644 --- a/docs/jsdoc/Events.html +++ b/docs/jsdoc/Events.html @@ -3606,13 +3606,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/FileBase.html b/docs/jsdoc/FileBase.html index e9e29e5a..d08908e7 100644 --- a/docs/jsdoc/FileBase.html +++ b/docs/jsdoc/FileBase.html @@ -352,13 +352,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/FileMini.html b/docs/jsdoc/FileMini.html index c8c07209..cb98f00f 100644 --- a/docs/jsdoc/FileMini.html +++ b/docs/jsdoc/FileMini.html @@ -428,13 +428,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/FileVersionBase.html b/docs/jsdoc/FileVersionBase.html index 302aff61..c04597bd 100644 --- a/docs/jsdoc/FileVersionBase.html +++ b/docs/jsdoc/FileVersionBase.html @@ -271,13 +271,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/FileVersionMini.html b/docs/jsdoc/FileVersionMini.html index ac7a9d11..f8c1f696 100644 --- a/docs/jsdoc/FileVersionMini.html +++ b/docs/jsdoc/FileVersionMini.html @@ -197,13 +197,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Files.html b/docs/jsdoc/Files.html index 019e2417..5fc04c7d 100644 --- a/docs/jsdoc/Files.html +++ b/docs/jsdoc/Files.html @@ -27302,13 +27302,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/FolderBase.html b/docs/jsdoc/FolderBase.html index 5448c69e..a7d0437b 100644 --- a/docs/jsdoc/FolderBase.html +++ b/docs/jsdoc/FolderBase.html @@ -352,13 +352,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/FolderMini.html b/docs/jsdoc/FolderMini.html index 1f9c9c23..a4a176a8 100644 --- a/docs/jsdoc/FolderMini.html +++ b/docs/jsdoc/FolderMini.html @@ -282,13 +282,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Folders.html b/docs/jsdoc/Folders.html index e73337b3..430aa1e6 100644 --- a/docs/jsdoc/Folders.html +++ b/docs/jsdoc/Folders.html @@ -13062,13 +13062,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Groups.html b/docs/jsdoc/Groups.html index 17a5c5cc..456c7ae4 100644 --- a/docs/jsdoc/Groups.html +++ b/docs/jsdoc/Groups.html @@ -6943,13 +6943,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/IntegrationMapping.html b/docs/jsdoc/IntegrationMapping.html index 89ade679..a6bf569d 100644 --- a/docs/jsdoc/IntegrationMapping.html +++ b/docs/jsdoc/IntegrationMapping.html @@ -782,13 +782,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/IntegrationMappingBase.html b/docs/jsdoc/IntegrationMappingBase.html index 6fe21d0f..8033a9d7 100644 --- a/docs/jsdoc/IntegrationMappingBase.html +++ b/docs/jsdoc/IntegrationMappingBase.html @@ -275,13 +275,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/IntegrationMappingBoxItemSlack.html b/docs/jsdoc/IntegrationMappingBoxItemSlack.html index 3b007d3a..a337a703 100644 --- a/docs/jsdoc/IntegrationMappingBoxItemSlack.html +++ b/docs/jsdoc/IntegrationMappingBoxItemSlack.html @@ -269,13 +269,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/IntegrationMappingPartnerItemSlack.html b/docs/jsdoc/IntegrationMappingPartnerItemSlack.html index 3dc0758f..b5738284 100644 --- a/docs/jsdoc/IntegrationMappingPartnerItemSlack.html +++ b/docs/jsdoc/IntegrationMappingPartnerItemSlack.html @@ -415,13 +415,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/IntegrationMappingSlackCreateRequest.html b/docs/jsdoc/IntegrationMappingSlackCreateRequest.html index f2e26fda..891a89f9 100644 --- a/docs/jsdoc/IntegrationMappingSlackCreateRequest.html +++ b/docs/jsdoc/IntegrationMappingSlackCreateRequest.html @@ -120,13 +120,13 @@

IntegrationMappingSlackCreateRequest


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/IntegrationMappingSlackOptions.html b/docs/jsdoc/IntegrationMappingSlackOptions.html index 8b8e52b3..14ef087b 100644 --- a/docs/jsdoc/IntegrationMappingSlackOptions.html +++ b/docs/jsdoc/IntegrationMappingSlackOptions.html @@ -200,13 +200,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/IntegrationMappings.html b/docs/jsdoc/IntegrationMappings.html index 912e129f..33c5fa24 100644 --- a/docs/jsdoc/IntegrationMappings.html +++ b/docs/jsdoc/IntegrationMappings.html @@ -345,13 +345,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/IntegrationMappingsManager.html b/docs/jsdoc/IntegrationMappingsManager.html index 112ac660..e45208ca 100644 --- a/docs/jsdoc/IntegrationMappingsManager.html +++ b/docs/jsdoc/IntegrationMappingsManager.html @@ -2719,13 +2719,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/IntegrationMappingsManager_IntegrationMappingsManager.html b/docs/jsdoc/IntegrationMappingsManager_IntegrationMappingsManager.html index 9cffdc25..b3692126 100644 --- a/docs/jsdoc/IntegrationMappingsManager_IntegrationMappingsManager.html +++ b/docs/jsdoc/IntegrationMappingsManager_IntegrationMappingsManager.html @@ -201,13 +201,13 @@
Parameters:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/LegalHoldPolicies.html b/docs/jsdoc/LegalHoldPolicies.html index b3cd741b..f808485c 100644 --- a/docs/jsdoc/LegalHoldPolicies.html +++ b/docs/jsdoc/LegalHoldPolicies.html @@ -6422,13 +6422,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Metadata.html b/docs/jsdoc/Metadata.html index b15a5728..f2ee71c9 100644 --- a/docs/jsdoc/Metadata.html +++ b/docs/jsdoc/Metadata.html @@ -7006,13 +7006,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/PagingIterator.html b/docs/jsdoc/PagingIterator.html index a9c2de81..7d32bdc5 100644 --- a/docs/jsdoc/PagingIterator.html +++ b/docs/jsdoc/PagingIterator.html @@ -1269,13 +1269,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/PagingIterator_PagingIterator.html b/docs/jsdoc/PagingIterator_PagingIterator.html index c18b15c2..b9a128db 100644 --- a/docs/jsdoc/PagingIterator_PagingIterator.html +++ b/docs/jsdoc/PagingIterator_PagingIterator.html @@ -271,13 +271,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/PersistentSession.html b/docs/jsdoc/PersistentSession.html index 0efd65e6..715375d2 100644 --- a/docs/jsdoc/PersistentSession.html +++ b/docs/jsdoc/PersistentSession.html @@ -1929,13 +1929,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/RecentItems.html b/docs/jsdoc/RecentItems.html index 03c35326..aa613d61 100644 --- a/docs/jsdoc/RecentItems.html +++ b/docs/jsdoc/RecentItems.html @@ -894,13 +894,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/RetentionPolicies.html b/docs/jsdoc/RetentionPolicies.html index 110e2839..0fb595a0 100644 --- a/docs/jsdoc/RetentionPolicies.html +++ b/docs/jsdoc/RetentionPolicies.html @@ -8928,13 +8928,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Search.html b/docs/jsdoc/Search.html index 4b5c0197..222eca76 100644 --- a/docs/jsdoc/Search.html +++ b/docs/jsdoc/Search.html @@ -2102,13 +2102,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SharedItems.html b/docs/jsdoc/SharedItems.html index 32f36dab..bb667839 100644 --- a/docs/jsdoc/SharedItems.html +++ b/docs/jsdoc/SharedItems.html @@ -768,13 +768,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrier.html b/docs/jsdoc/ShieldInformationBarrier.html index 8b83770b..bc513ba4 100644 --- a/docs/jsdoc/ShieldInformationBarrier.html +++ b/docs/jsdoc/ShieldInformationBarrier.html @@ -863,13 +863,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierBase.html b/docs/jsdoc/ShieldInformationBarrierBase.html index 88fafb49..6aedca7c 100644 --- a/docs/jsdoc/ShieldInformationBarrierBase.html +++ b/docs/jsdoc/ShieldInformationBarrierBase.html @@ -270,13 +270,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierManager.html b/docs/jsdoc/ShieldInformationBarrierManager.html index a61559c7..29b3ce48 100644 --- a/docs/jsdoc/ShieldInformationBarrierManager.html +++ b/docs/jsdoc/ShieldInformationBarrierManager.html @@ -2271,13 +2271,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierManager_ShieldInformationBarrierManager.html b/docs/jsdoc/ShieldInformationBarrierManager_ShieldInformationBarrierManager.html index dd18453a..bf486ed6 100644 --- a/docs/jsdoc/ShieldInformationBarrierManager_ShieldInformationBarrierManager.html +++ b/docs/jsdoc/ShieldInformationBarrierManager_ShieldInformationBarrierManager.html @@ -201,13 +201,13 @@
Parameters:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierReference.html b/docs/jsdoc/ShieldInformationBarrierReference.html index 9b9ea21f..0912e69a 100644 --- a/docs/jsdoc/ShieldInformationBarrierReference.html +++ b/docs/jsdoc/ShieldInformationBarrierReference.html @@ -119,13 +119,13 @@

ShieldInformationBarrierReference


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierReport.html b/docs/jsdoc/ShieldInformationBarrierReport.html index 96f6d4a9..5d0883fe 100644 --- a/docs/jsdoc/ShieldInformationBarrierReport.html +++ b/docs/jsdoc/ShieldInformationBarrierReport.html @@ -426,13 +426,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierReportBase.html b/docs/jsdoc/ShieldInformationBarrierReportBase.html index 745064c0..33ae27c5 100644 --- a/docs/jsdoc/ShieldInformationBarrierReportBase.html +++ b/docs/jsdoc/ShieldInformationBarrierReportBase.html @@ -270,13 +270,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierReportDetails.html b/docs/jsdoc/ShieldInformationBarrierReportDetails.html index 39f7d552..e64aba97 100644 --- a/docs/jsdoc/ShieldInformationBarrierReportDetails.html +++ b/docs/jsdoc/ShieldInformationBarrierReportDetails.html @@ -120,13 +120,13 @@

ShieldInformationBarrierReportDetails


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierReports.html b/docs/jsdoc/ShieldInformationBarrierReports.html index 112bc981..6a4fb723 100644 --- a/docs/jsdoc/ShieldInformationBarrierReports.html +++ b/docs/jsdoc/ShieldInformationBarrierReports.html @@ -345,13 +345,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierReportsManager.html b/docs/jsdoc/ShieldInformationBarrierReportsManager.html index 7b2713d0..e26af2f3 100644 --- a/docs/jsdoc/ShieldInformationBarrierReportsManager.html +++ b/docs/jsdoc/ShieldInformationBarrierReportsManager.html @@ -1849,13 +1849,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierReportsManager_ShieldInformationBarrierReportsManager.html b/docs/jsdoc/ShieldInformationBarrierReportsManager_ShieldInformationBarrierReportsManager.html index 78e7c7f0..5af6f360 100644 --- a/docs/jsdoc/ShieldInformationBarrierReportsManager_ShieldInformationBarrierReportsManager.html +++ b/docs/jsdoc/ShieldInformationBarrierReportsManager_ShieldInformationBarrierReportsManager.html @@ -201,13 +201,13 @@
Parameters:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegment.html b/docs/jsdoc/ShieldInformationBarrierSegment.html index 75e895e7..f975af81 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegment.html +++ b/docs/jsdoc/ShieldInformationBarrierSegment.html @@ -708,13 +708,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentMember.html b/docs/jsdoc/ShieldInformationBarrierSegmentMember.html index 71943fb0..a75239cc 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentMember.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentMember.html @@ -561,13 +561,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentMemberBase.html b/docs/jsdoc/ShieldInformationBarrierSegmentMemberBase.html index ef40b60a..751927ea 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentMemberBase.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentMemberBase.html @@ -271,13 +271,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentMemberMini.html b/docs/jsdoc/ShieldInformationBarrierSegmentMemberMini.html index b7c52c2c..a88373c6 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentMemberMini.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentMemberMini.html @@ -196,13 +196,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentMembers.html b/docs/jsdoc/ShieldInformationBarrierSegmentMembers.html index a0c576f3..b24253b4 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentMembers.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentMembers.html @@ -345,13 +345,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentMembersManager.html b/docs/jsdoc/ShieldInformationBarrierSegmentMembersManager.html index c1a3e33b..069a8913 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentMembersManager.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentMembersManager.html @@ -2361,13 +2361,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentMembersManager_ShieldInformationBarrierSegmentMembersManager.html b/docs/jsdoc/ShieldInformationBarrierSegmentMembersManager_ShieldInformationBarrierSegmentMembersManager.html index eb3a74ea..de8e8980 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentMembersManager_ShieldInformationBarrierSegmentMembersManager.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentMembersManager_ShieldInformationBarrierSegmentMembersManager.html @@ -201,13 +201,13 @@
Parameters:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentRestriction.html b/docs/jsdoc/ShieldInformationBarrierSegmentRestriction.html index acad39bc..308cfa4e 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentRestriction.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentRestriction.html @@ -419,13 +419,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionBase.html b/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionBase.html index 63a384ad..2d58b29b 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionBase.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionBase.html @@ -272,13 +272,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionMini.html b/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionMini.html index 2dc419e1..237b13ad 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionMini.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionMini.html @@ -271,13 +271,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentRestrictions.html b/docs/jsdoc/ShieldInformationBarrierSegmentRestrictions.html index 8da3f3da..ae30a45b 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentRestrictions.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentRestrictions.html @@ -345,13 +345,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionsManager.html b/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionsManager.html index 0073e0dc..0d9a556d 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionsManager.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionsManager.html @@ -2363,13 +2363,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionsManager_ShieldInformationBarrierSegmentRestrictionsManager.html b/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionsManager_ShieldInformationBarrierSegmentRestrictionsManager.html index b6d2bf70..bf462d1a 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionsManager_ShieldInformationBarrierSegmentRestrictionsManager.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionsManager_ShieldInformationBarrierSegmentRestrictionsManager.html @@ -201,13 +201,13 @@
Parameters:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegments.html b/docs/jsdoc/ShieldInformationBarrierSegments.html index 569c4793..51b4bdc2 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegments.html +++ b/docs/jsdoc/ShieldInformationBarrierSegments.html @@ -345,13 +345,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentsManager.html b/docs/jsdoc/ShieldInformationBarrierSegmentsManager.html index 2b3164dd..529e6b1e 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentsManager.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentsManager.html @@ -2927,13 +2927,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentsManager_ShieldInformationBarrierSegmentsManager.html b/docs/jsdoc/ShieldInformationBarrierSegmentsManager_ShieldInformationBarrierSegmentsManager.html index d05a24b2..1969c47d 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentsManager_ShieldInformationBarrierSegmentsManager.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentsManager_ShieldInformationBarrierSegmentsManager.html @@ -201,13 +201,13 @@
Parameters:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarriers.html b/docs/jsdoc/ShieldInformationBarriers.html index 4641e78d..02affe73 100644 --- a/docs/jsdoc/ShieldInformationBarriers.html +++ b/docs/jsdoc/ShieldInformationBarriers.html @@ -344,13 +344,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:15 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SignRequest.html b/docs/jsdoc/SignRequest.html index 4d07d34d..9cf7be20 100644 --- a/docs/jsdoc/SignRequest.html +++ b/docs/jsdoc/SignRequest.html @@ -37,9 +37,9 @@

SignRequest

-
Sign Request +
Box Sign request -A Sign Request Object
+A Box Sign request object.
@@ -162,7 +162,7 @@
Type:
Source:
@@ -186,7 +186,7 @@

id - Sign request ID + Box Sign request ID. Example: 12345

@@ -253,6 +253,84 @@
Type:
+

parent_folder :schemas.FolderMini

+ + + + +
+ The destination folder to place final, signed document and signing +log. + +When this value was not passed in when the signature request was +created, then we will use a default folder which is either the parent +folder of the first source file in the payload if we have the permission +to upload to that folder or a folder called "My Sign Requests". +
+ + + +
Type:
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +

prepare_url :string

@@ -260,8 +338,11 @@

prepare_ur
This URL is returned if `is_document_preparation_needed` is -set to `true` in the request. It is used to prepare the sign request -via UI. The sign request is not sent until preparation is complete. +set to `true` in the request. The parameter is used to prepare +the signature request +using the UI. The signature request is not +sent until the preparation +phase is complete. Example: https://prepareurl.com
@@ -384,7 +465,7 @@

Type:
Source:
@@ -481,7 +562,7 @@

signers - Array of signers for the sign request + Array of signers for the signature request. @@ -554,7 +635,7 @@

signing_lo
Reference to a file that holds a log of all signer activity for -the request +the request.
@@ -602,7 +683,7 @@

Type:
Source:
@@ -698,7 +779,7 @@

status - Describes the status of the sign request + Describes the status of the signature request. Example: converting @@ -780,7 +861,7 @@
Type:
Source:
@@ -887,13 +968,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:16 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SignRequestBase.html b/docs/jsdoc/SignRequestBase.html index d0f48bb5..1bf9e6ed 100644 --- a/docs/jsdoc/SignRequestBase.html +++ b/docs/jsdoc/SignRequestBase.html @@ -37,9 +37,9 @@

SignRequestBase

-
Sign Request (Base) +
Box Sign request (Base) -A request to create a sign request object
+A standard representation of a signature request object.
@@ -313,7 +313,7 @@
Type:
Source:
@@ -605,7 +605,7 @@
Type:
Source:
@@ -623,14 +623,14 @@
Type:
-

is_document_preparation_needed :boolean

+

external_system_name :string

- Indicates if the sender should receive a `prepare_url` in the response to complete document preparation via UI. -Example: true + Used as an optional system name to appear in the signature log next to the signers who have been assigned the `embed_url_external_id`. +Example: Box
@@ -639,7 +639,7 @@
Type:
  • -boolean +string
    • @@ -678,7 +678,7 @@
    Type:
    Source:
    @@ -696,13 +696,13 @@
    Type:
    -

    is_phone_verification_required_to_view :boolean

    +

    is_document_preparation_needed :boolean

    - Forces signers to verify a text message prior to viewing the document. You must specify the phone number of signers to have this setting apply to them. + Indicates if the sender should receive a `prepare_url` in the response to complete document preparation using the UI. Example: true
    @@ -751,7 +751,7 @@
    Type:
    Source:
    @@ -769,14 +769,14 @@
    Type:
    -

    name :string

    +

    is_phone_verification_required_to_view :boolean

    - Name of the sign request. -Example: name + Forces signers to verify a text message prior to viewing the document. You must specify the phone number of signers to have this setting apply to them. +Example: true
    @@ -785,7 +785,7 @@
    Type:
    • -string +boolean
      • @@ -824,7 +824,7 @@
      Type:
      Source:
      @@ -842,15 +842,14 @@
      Type:
      -

      parent_folder :schemas.FolderMini

      +

      name :string

      - The destination folder to place final, signed document and signing -log. Only `ID` and `type` fields are required. The root folder, -folder ID `0`, cannot be used. + Name of the signature request. +Example: name
      @@ -859,7 +858,7 @@
      Type:
      • -schemas.FolderMini +string
        • @@ -922,7 +921,7 @@

        prefill_t
        - When a document contains sign related tags in the content, you can prefill them using this `prefill_tags` by referencing the 'id' of the tag as the `external_id` field of the prefill tag. + When a document contains sign-related tags in the content, you can prefill them using this `prefill_tags` by referencing the 'id' of the tag as the `external_id` field of the prefill tag.
        @@ -970,7 +969,7 @@

        Type:
        Source:
        @@ -994,7 +993,7 @@

        redirect_
        - When specified, signature request will be redirected to this url when a document is signed. + When specified, the signature request will be redirected to this url when a document is signed. Example: https://www.example.com
        @@ -1116,7 +1115,7 @@

        Type:
        Source:
        @@ -1150,13 +1149,13 @@
        Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:16 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SignRequestCreateRequest.html b/docs/jsdoc/SignRequestCreateRequest.html index 3c41522b..3a87c7bb 100644 --- a/docs/jsdoc/SignRequestCreateRequest.html +++ b/docs/jsdoc/SignRequestCreateRequest.html @@ -37,9 +37,9 @@

SignRequestCreateRequest

-
Create a sign request +
Create a Box Sign request -A request to create a sign request object
+Creates a Box Sign request object.
@@ -107,6 +107,85 @@

Members

+

parent_folder :schemas.FolderMini

+ + + + +
+ The destination folder to place final, signed document and signing +log. Only `ID` and `type` fields are required. The root folder, +folder ID `0`, cannot be used and can also not be null. + +When this value is not passed in when the signature request, then +we will use a default folder which is either the parent folder of +the first source file in the payload if we have the permission to +upload to that folder or a folder called "My Sign Requests". +
+ + + +
Type:
+
    +
  • + +schemas.FolderMini + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +

signature_color :'blue'|'black'|'red'

@@ -192,7 +271,14 @@

signers - Array of signers for the sign request. 35 is the max number of signers permitted. + Array of signers for the signature request. 35 is the +max number of signers permitted. + +**Note**: It may happen that some signers belong to conflicting [segments](r://shield-information-barrier-segment-member) (user groups). +This means that due to the security policies, users are assigned to segments to prevent exchanges or communication that could lead to ethical conflicts. +In such a case, an attempt to send the sign request will result in an error. + +Read more about [segments and ethical walls](https://support.box.com/hc/en-us/articles/9920431507603-Understanding-Information-Barriers#h_01GFVJEHQA06N7XEZ4GCZ9GFAQ).

@@ -346,13 +432,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:16 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SignRequestCreateSigner.html b/docs/jsdoc/SignRequestCreateSigner.html index a86220a1..a637bf39 100644 --- a/docs/jsdoc/SignRequestCreateSigner.html +++ b/docs/jsdoc/SignRequestCreateSigner.html @@ -37,9 +37,10 @@

SignRequestCreateSigner

-
Signer fields for Create Sign Request +
Signer fields used to create a Box Sign request object. -The schema for a Signer in a POST Sign Request request body
+The schema for a Signer object used in +for creating a Box Sign request object.
@@ -165,7 +166,7 @@
Type:
Source:
@@ -239,7 +240,7 @@
Type:
Source:
@@ -313,7 +314,7 @@
Type:
Source:
@@ -387,7 +388,7 @@
Type:
Source:
@@ -411,10 +412,11 @@

login_r
- If set to true, signer will need to login to a Box account + If set to true, the signer will need to log in to a Box account before signing the request. If the signer does not have -an existing account, they will have an option to create -a free Box account. +an existing account, they will have the option to create +a free Box account. Cannot be selected in combination with +`verification_phone_number`. Example: true
@@ -463,7 +465,7 @@

Type:
Source:
@@ -536,7 +538,7 @@
Type:
Source:
@@ -610,7 +612,7 @@
Type:
Source:
@@ -688,7 +690,7 @@
Type:
Source:
@@ -712,7 +714,7 @@

role - Defines the role of the signer in the sign request. A `signer` + Defines the role of the signer in the signature request. A `signer` must sign the document and an `approver` must approve the document. A `final_copy_reader` only receives the final signed document and signing log. @@ -775,7 +777,7 @@
Type:
Source:
@@ -799,9 +801,13 @@

signer
- If set, signers who have the same group ID will be assigned to the same input. -A signer group is expected to have more than one signer. When a group contains fewer than two signers, -it will be converted to a single signer and the group will be removed. + If set, signers who have the same value will be assigned to the same input and to the same signer group. +A signer group is not a Box Group. It is an entity that belongs to a Sign Request and can only be +used/accessed within this Sign Request. A signer group is expected to have more than one signer. +If the provided value is only used for one signer, this value will be ignored and request will be handled +as it was intended for an individual signer. The value provided can be any string and only used to +determine which signers belongs to same group. A successful response will provide a generated UUID value +instead for signers in the same signer group. Example: cd4ff89-8fc1-42cf-8b29-1890dedd26d7
@@ -850,7 +856,79 @@

Type:
Source:
+ + + + + + + + + + + + + + + + +

suppress_notifications :boolean

+ + + + +
+ If true, no emails about the sign request will be sent +
+ + + +
Type:
+
    +
  • + +boolean + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
@@ -874,8 +952,9 @@

- If set, this phone number is be used to verify the signer -via two factor authentication before they are able to sign the document. + If set, this phone number will be used to verify the signer +via two-factor authentication before they are able to sign the document. +Cannot be selected in combination with `login_required`. Example: 6314578901

@@ -924,7 +1003,7 @@
Type:
Source:
@@ -958,13 +1037,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:16 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SignRequestPrefillTag.html b/docs/jsdoc/SignRequestPrefillTag.html index 1f999718..112a3cc8 100644 --- a/docs/jsdoc/SignRequestPrefillTag.html +++ b/docs/jsdoc/SignRequestPrefillTag.html @@ -37,7 +37,7 @@

SignRequestPrefillTag

-
Sign Request Prefill Tag +
Sign request prefill tag Prefill tags are used to prefill placeholders with signer input data. Only one value field can be included.
@@ -260,7 +260,7 @@

docume
- This references the ID of a specific tag contained in a file of the sign request. + This references the ID of a specific tag contained in a file of the signature request. Example: 1234
@@ -416,13 +416,13 @@

Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:16 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SignRequestSigner.html b/docs/jsdoc/SignRequestSigner.html index 4f3dcfbc..34692fe2 100644 --- a/docs/jsdoc/SignRequestSigner.html +++ b/docs/jsdoc/SignRequestSigner.html @@ -37,9 +37,10 @@

SignRequestSigner

-
Signer fields for GET Sign Request response +
Signer fields for Box Sign request response -The schema for a Signer in a GET Sign Request request body
+The schema for a Signer object used +on the body of a Box Sign request object.
@@ -162,7 +163,7 @@
Type:
Source:
@@ -235,7 +236,7 @@
Type:
Source:
@@ -264,7 +265,7 @@

i It will be returned in the response only if the `embed_url_external_user_id` parameter was passed in the -`create sign request` call. +`create Box Sign request` call. Example: https://app.box.com/embed/sign/document/gfhr4222-a331-494b-808b-79bc7f3992a3/f14d7098-a331-494b-808b-79bc7f3992a4

@@ -313,7 +314,7 @@
Type:
Source:
@@ -337,7 +338,7 @@

signer
- Final decision made by the signer + Final decision made by the signer.
@@ -385,7 +386,7 @@

Type:
Source:
@@ -419,13 +420,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:16 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SignRequestSignerInput.html b/docs/jsdoc/SignRequestSignerInput.html index 291964ec..7062de6a 100644 --- a/docs/jsdoc/SignRequestSignerInput.html +++ b/docs/jsdoc/SignRequestSignerInput.html @@ -295,6 +295,79 @@
Type:
+

read_only :boolean

+ + + + +
+ Whether this input was defined as read-only(immutable by signers) or not +Example: true +
+ + + +
Type:
+
    +
  • + +boolean + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +

type :'signature'|'date'|'text'|'checkbox'|'radio'|'dropdown'

@@ -399,13 +472,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:16 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SignRequests.html b/docs/jsdoc/SignRequests.html index 73d9f98b..82b72f8d 100644 --- a/docs/jsdoc/SignRequests.html +++ b/docs/jsdoc/SignRequests.html @@ -37,7 +37,7 @@

SignRequests

-
Box Sign +
Box Sign requests The part of an API response that describes marker based pagination
@@ -114,7 +114,7 @@

entries - A list of sign requests + A list of Box Sign requests.

@@ -344,13 +344,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:16 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SignRequestsManager.html b/docs/jsdoc/SignRequestsManager.html index f5577f6b..bf8790c2 100644 --- a/docs/jsdoc/SignRequestsManager.html +++ b/docs/jsdoc/SignRequestsManager.html @@ -213,7 +213,7 @@

cancelById<
- Cancel sign request + Cancel Box Sign request Cancels a sign request.
@@ -319,7 +319,7 @@

Properties
- The ID of the sign request + The ID of the signature request @@ -466,7 +466,7 @@

cancelById<
- Cancel sign request + Cancel Box Sign request Cancels a sign request.
@@ -572,7 +572,7 @@

Properties
- The ID of the sign request + The ID of the signature request @@ -719,10 +719,10 @@

create - Create sign request + Create Box Sign request -Creates a sign request. This involves preparing a document for signing and -sending the sign request to signers. +Creates a signature request. This involves preparing a document for signing and +sending the signature request to signers. @@ -957,10 +957,10 @@

create - Create sign request + Create Box Sign request -Creates a sign request. This involves preparing a document for signing and -sending the sign request to signers. +Creates a signature request. This involves preparing a document for signing and +sending the signature request to signers. @@ -1195,10 +1195,10 @@

getAll - List sign requests + List Box Sign requests -Gets sign requests created by a user. If the `sign_files` and/or -`parent_folder` are deleted, the sign request will not return in the list. +Gets signature requests created by a user. If the `sign_files` and/or +`parent_folder` are deleted, the signature request will not return in the list. @@ -1496,10 +1496,10 @@

getAll - List sign requests + List Box Sign requests -Gets sign requests created by a user. If the `sign_files` and/or -`parent_folder` are deleted, the sign request will not return in the list. +Gets signature requests created by a user. If the `sign_files` and/or +`parent_folder` are deleted, the signature request will not return in the list. @@ -1797,7 +1797,7 @@

getById - Get sign request by ID + Get Box Sign request by ID Gets a sign request by ID. @@ -1903,7 +1903,7 @@
Properties
- The ID of the sign request + The ID of the signature request @@ -2050,7 +2050,7 @@

getById - Get sign request by ID + Get Box Sign request by ID Gets a sign request by ID. @@ -2156,7 +2156,7 @@
Properties
- The ID of the sign request + The ID of the signature request @@ -2303,9 +2303,9 @@

resendById<
- Resend sign request + Resend Box Sign request -Resends a sign request email to all outstanding signers. +Resends a signature request email to all outstanding signers.
@@ -2409,7 +2409,7 @@

Properties
- The ID of the sign request + The ID of the signature request @@ -2556,9 +2556,9 @@

resendById<
- Resend sign request + Resend Box Sign request -Resends a sign request email to all outstanding signers. +Resends a signature request email to all outstanding signers.
@@ -2662,7 +2662,7 @@

Properties
- The ID of the sign request + The ID of the signature request @@ -2811,13 +2811,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:16 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SignRequestsManager_SignRequestsManager.html b/docs/jsdoc/SignRequestsManager_SignRequestsManager.html index 93cb80f0..278574e0 100644 --- a/docs/jsdoc/SignRequestsManager_SignRequestsManager.html +++ b/docs/jsdoc/SignRequestsManager_SignRequestsManager.html @@ -201,13 +201,13 @@
Parameters:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:16 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SignTemplate.html b/docs/jsdoc/SignTemplate.html index 19148306..9edf00f1 100644 --- a/docs/jsdoc/SignTemplate.html +++ b/docs/jsdoc/SignTemplate.html @@ -161,7 +161,7 @@
Type:
Source:
@@ -597,7 +597,7 @@
Type:
Source:
@@ -1108,7 +1108,7 @@
Type:
Source:
@@ -1133,6 +1133,12 @@

signers Array of signers for the template. + +**Note**: It may happen that some signers specified in the template belong to conflicting [segments](r://shield-information-barrier-segment-member) (user groups). +This means that due to the security policies, users are assigned to segments to prevent exchanges or communication that could lead to ethical conflicts. +In such a case, an attempt to send a sign request based on a template that lists signers in conflicting segments will result in an error. + +Read more about [segments and ethical walls](https://support.box.com/hc/en-us/articles/9920431507603-Understanding-Information-Barriers#h_01GFVJEHQA06N7XEZ4GCZ9GFAQ). @@ -1359,13 +1365,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:16 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SignTemplates.html b/docs/jsdoc/SignTemplates.html index 98500723..f9e1a02e 100644 --- a/docs/jsdoc/SignTemplates.html +++ b/docs/jsdoc/SignTemplates.html @@ -417,13 +417,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:16 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SignTemplatesManager.html b/docs/jsdoc/SignTemplatesManager.html index 38a2539f..5a790604 100644 --- a/docs/jsdoc/SignTemplatesManager.html +++ b/docs/jsdoc/SignTemplatesManager.html @@ -1321,13 +1321,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:16 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SignTemplatesManager_SignTemplatesManager.html b/docs/jsdoc/SignTemplatesManager_SignTemplatesManager.html index a9c2daca..2434f234 100644 --- a/docs/jsdoc/SignTemplatesManager_SignTemplatesManager.html +++ b/docs/jsdoc/SignTemplatesManager_SignTemplatesManager.html @@ -201,13 +201,13 @@
Parameters:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:16 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/StoragePolicies.html b/docs/jsdoc/StoragePolicies.html index ca2be117..d7388fbc 100644 --- a/docs/jsdoc/StoragePolicies.html +++ b/docs/jsdoc/StoragePolicies.html @@ -4162,13 +4162,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:16 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Tasks.html b/docs/jsdoc/Tasks.html index 3f18f478..3c8010cf 100644 --- a/docs/jsdoc/Tasks.html +++ b/docs/jsdoc/Tasks.html @@ -5478,13 +5478,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:16 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/TemplateSigner.html b/docs/jsdoc/TemplateSigner.html index eb5c23b5..60c9a9e8 100644 --- a/docs/jsdoc/TemplateSigner.html +++ b/docs/jsdoc/TemplateSigner.html @@ -422,9 +422,9 @@

signer
- If set, signers who have the same group ID will be assigned to the same input. -A signer group is expected to have more than one signer. When a group contains fewer than two signers, -it will be converted to a single signer and the group will be removed. + If provided, this value points signers that are assigned the same inputs and belongs to same signer group. +A signer group is not a Box Group. It is an entity that belongs to the template itself and can only be used +within Box Sign requests created from it. Example: cd4ff89-8fc1-42cf-8b29-1890dedd26d7
@@ -507,13 +507,13 @@

Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:16 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/TemplateSignerInput.html b/docs/jsdoc/TemplateSignerInput.html index 90df37f9..e4252870 100644 --- a/docs/jsdoc/TemplateSignerInput.html +++ b/docs/jsdoc/TemplateSignerInput.html @@ -804,6 +804,79 @@
Type:
+

read_only :boolean

+ + + + +
+ Whether this input was defined as read-only(immutable by signers) or not +Example: true +
+ + + +
Type:
+
    +
  • + +boolean + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +

type :'signature'|'date'|'text'|'checkbox'|'attachment'|'radio'|'dropdown'

@@ -911,13 +984,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:16 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/TermsOfService.html b/docs/jsdoc/TermsOfService.html index 3b0f276b..93874029 100644 --- a/docs/jsdoc/TermsOfService.html +++ b/docs/jsdoc/TermsOfService.html @@ -5140,13 +5140,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:16 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/TokenManager.html b/docs/jsdoc/TokenManager.html index ba8cd4fd..34c02330 100644 --- a/docs/jsdoc/TokenManager.html +++ b/docs/jsdoc/TokenManager.html @@ -4175,13 +4175,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:16 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Trash.html b/docs/jsdoc/Trash.html index 360eb3c6..ae81c770 100644 --- a/docs/jsdoc/Trash.html +++ b/docs/jsdoc/Trash.html @@ -762,13 +762,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:16 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/UserBase.html b/docs/jsdoc/UserBase.html index 0c5f7817..7189d686 100644 --- a/docs/jsdoc/UserBase.html +++ b/docs/jsdoc/UserBase.html @@ -270,13 +270,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:16 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/UserIntegrationMappings.html b/docs/jsdoc/UserIntegrationMappings.html index cbcf2fa3..9e6d47dc 100644 --- a/docs/jsdoc/UserIntegrationMappings.html +++ b/docs/jsdoc/UserIntegrationMappings.html @@ -270,13 +270,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:16 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Users.html b/docs/jsdoc/Users.html index 2658b0b6..d15369e1 100644 --- a/docs/jsdoc/Users.html +++ b/docs/jsdoc/Users.html @@ -5954,13 +5954,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:16 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/WebLinks.html b/docs/jsdoc/WebLinks.html index 0a935026..0e0d5649 100644 --- a/docs/jsdoc/WebLinks.html +++ b/docs/jsdoc/WebLinks.html @@ -4574,13 +4574,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:16 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Webhooks.html b/docs/jsdoc/Webhooks.html index d201ed6d..e407bc43 100644 --- a/docs/jsdoc/Webhooks.html +++ b/docs/jsdoc/Webhooks.html @@ -4580,13 +4580,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:16 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:53 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/api-request-manager.ts.html b/docs/jsdoc/api-request-manager.ts.html index 5a2037a3..72281374 100644 --- a/docs/jsdoc/api-request-manager.ts.html +++ b/docs/jsdoc/api-request-manager.ts.html @@ -139,13 +139,13 @@

Source: api-request-manager.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/api-request.ts.html b/docs/jsdoc/api-request.ts.html index 86263596..32ef8eaf 100644 --- a/docs/jsdoc/api-request.ts.html +++ b/docs/jsdoc/api-request.ts.html @@ -462,13 +462,13 @@

Source: api-request.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/box-client.ts.html b/docs/jsdoc/box-client.ts.html index 7ea95b74..5d5d0935 100644 --- a/docs/jsdoc/box-client.ts.html +++ b/docs/jsdoc/box-client.ts.html @@ -34,6 +34,7 @@

Source: box-client.ts

// ------------------------------------------------------------------------------ // API Resource Managers // ------------------------------------------------------------------------------ +import AI from './managers/ai.generated'; import CollaborationAllowlist from './managers/collaboration-allowlist'; import Collaborations from './managers/collaborations'; import Collections from './managers/collections'; @@ -204,6 +205,7 @@

Source: box-client.ts

_analyticsClient: any; _tokenOptions: any; + ai: AI; users: any; files: Files; fileRequests: FileRequestsManager; @@ -279,6 +281,7 @@

Source: box-client.ts

this._analyticsClient = config.analyticsClient; // Attach API Resource Managers + this.ai = new AI(this); this.users = new Users(this); this.files = new Files(this); this.fileRequests = new FileRequestsManager(this); @@ -825,13 +828,13 @@

Source: box-client.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/box-node-sdk.ts.html b/docs/jsdoc/box-node-sdk.ts.html index dfa9e3b5..e85f29d5 100644 --- a/docs/jsdoc/box-node-sdk.ts.html +++ b/docs/jsdoc/box-node-sdk.ts.html @@ -529,13 +529,13 @@

Source: box-node-sdk.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/chunked-uploader.ts.html b/docs/jsdoc/chunked-uploader.ts.html index f1e9e9f5..68d4b865 100644 --- a/docs/jsdoc/chunked-uploader.ts.html +++ b/docs/jsdoc/chunked-uploader.ts.html @@ -478,13 +478,13 @@

Source: chunked-uploader.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/enterprise-event-stream.ts.html b/docs/jsdoc/enterprise-event-stream.ts.html index 8b3a7b31..8d713b78 100644 --- a/docs/jsdoc/enterprise-event-stream.ts.html +++ b/docs/jsdoc/enterprise-event-stream.ts.html @@ -311,13 +311,13 @@

Source: enterprise-event-stream.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/event-stream.ts.html b/docs/jsdoc/event-stream.ts.html index 097c83a7..498dd1a3 100644 --- a/docs/jsdoc/event-stream.ts.html +++ b/docs/jsdoc/event-stream.ts.html @@ -399,13 +399,13 @@

Source: event-stream.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/global.html b/docs/jsdoc/global.html index 37cbaaf6..9c155fbc 100644 --- a/docs/jsdoc/global.html +++ b/docs/jsdoc/global.html @@ -1876,7 +1876,7 @@
Parameters:
Source:
@@ -2492,7 +2492,7 @@
Type:
Source:
@@ -4550,7 +4550,7 @@
Type:
Source:
@@ -4622,7 +4622,7 @@
Type:
Source:
@@ -8239,13 +8239,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/index.html b/docs/jsdoc/index.html index ea41706b..4c141392 100644 --- a/docs/jsdoc/index.html +++ b/docs/jsdoc/index.html @@ -2189,13 +2189,13 @@

util/url-path.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_ai.generated.ts.html b/docs/jsdoc/managers_ai.generated.ts.html new file mode 100644 index 00000000..e0a6513c --- /dev/null +++ b/docs/jsdoc/managers_ai.generated.ts.html @@ -0,0 +1,118 @@ + + + + + JSDoc: Source: managers/ai.generated.ts + + + + + + + + + + +
+ +

Source: managers/ai.generated.ts

+ + + + + + +
+
+ 
import BoxClient from '../box-client';
+import urlPath from '../util/url-path';
+import * as schemas from '../schemas';
+/**
+ */
+class AIManager {
+	client: BoxClient;
+	/**
+	 * @param {BoxClient} client The Box API Client that is responsible for making calls to the API
+	 */
+	constructor(client: BoxClient) {
+		this.client = client;
+	}
+	/**
+	 * Send AI question request
+	 *
+	 * Sends an AI request to supported LLMs and returns an answer specifically focused on the user's question given the provided context.
+	 * @param {schemas.AiAsk} body
+	 * @param {object} [options] Options for the request
+	 * @param {Function} [callback] Passed the result if successful, error otherwise
+	 * @returns {Promise<schemas.AiResponse>} A promise resolving to the result or rejecting with an error
+	 */
+	ask(
+		body: schemas.AiAsk,
+		options?: {},
+		callback?: Function
+	): Promise<schemas.AiResponse> {
+		const { ...queryParams } = options,
+			apiPath = urlPath('ai', 'ask'),
+			params = {
+				qs: queryParams,
+				body: body,
+			};
+		return this.client.wrapWithDefaultHandler(this.client.post)(
+			apiPath,
+			params,
+			callback
+		);
+	}
+	/**
+	 * Send AI request to generate text
+	 *
+	 * Sends an AI request to supported LLMs and returns an answer specifically focused on the creation of new text.
+	 * @param {schemas.AiTextGen} body
+	 * @param {object} [options] Options for the request
+	 * @param {Function} [callback] Passed the result if successful, error otherwise
+	 * @returns {Promise<schemas.AiResponse>} A promise resolving to the result or rejecting with an error
+	 */
+	textGen(
+		body: schemas.AiTextGen,
+		options?: {},
+		callback?: Function
+	): Promise<schemas.AiResponse> {
+		const { ...queryParams } = options,
+			apiPath = urlPath('ai', 'text_gen'),
+			params = {
+				qs: queryParams,
+				body: body,
+			};
+		return this.client.wrapWithDefaultHandler(this.client.post)(
+			apiPath,
+			params,
+			callback
+		);
+	}
+}
+export = AIManager;
+
+
+
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time) +
+ + + + + diff --git a/docs/jsdoc/managers_collaboration-allowlist.ts.html b/docs/jsdoc/managers_collaboration-allowlist.ts.html index c0faff85..bfb6b7f7 100644 --- a/docs/jsdoc/managers_collaboration-allowlist.ts.html +++ b/docs/jsdoc/managers_collaboration-allowlist.ts.html @@ -316,13 +316,13 @@

Source: managers/collaboration-allowlist.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_collaborations.ts.html b/docs/jsdoc/managers_collaborations.ts.html index e68f4bbe..09455334 100644 --- a/docs/jsdoc/managers_collaborations.ts.html +++ b/docs/jsdoc/managers_collaborations.ts.html @@ -424,13 +424,13 @@

Source: managers/collaborations.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_collections.ts.html b/docs/jsdoc/managers_collections.ts.html index 0354bbc2..0080116d 100644 --- a/docs/jsdoc/managers_collections.ts.html +++ b/docs/jsdoc/managers_collections.ts.html @@ -125,13 +125,13 @@

Source: managers/collections.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_comments.ts.html b/docs/jsdoc/managers_comments.ts.html index fb44e4c3..2a8aa72b 100644 --- a/docs/jsdoc/managers_comments.ts.html +++ b/docs/jsdoc/managers_comments.ts.html @@ -268,13 +268,13 @@

Source: managers/comments.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_device-pins.ts.html b/docs/jsdoc/managers_device-pins.ts.html index cf687c8b..51d1e320 100644 --- a/docs/jsdoc/managers_device-pins.ts.html +++ b/docs/jsdoc/managers_device-pins.ts.html @@ -163,13 +163,13 @@

Source: managers/device-pins.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_enterprise.ts.html b/docs/jsdoc/managers_enterprise.ts.html index df603625..e4b52cc6 100644 --- a/docs/jsdoc/managers_enterprise.ts.html +++ b/docs/jsdoc/managers_enterprise.ts.html @@ -332,13 +332,13 @@

Source: managers/enterprise.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_events.ts.html b/docs/jsdoc/managers_events.ts.html index e251d787..b909ff88 100644 --- a/docs/jsdoc/managers_events.ts.html +++ b/docs/jsdoc/managers_events.ts.html @@ -402,13 +402,13 @@

Source: managers/events.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_file-requests-manager.ts.html b/docs/jsdoc/managers_file-requests-manager.ts.html index 81f70000..f47ae4cb 100644 --- a/docs/jsdoc/managers_file-requests-manager.ts.html +++ b/docs/jsdoc/managers_file-requests-manager.ts.html @@ -138,13 +138,13 @@

Source: managers/file-requests-manager.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_files.ts.html b/docs/jsdoc/managers_files.ts.html index 4cffd72c..820cd39d 100644 --- a/docs/jsdoc/managers_files.ts.html +++ b/docs/jsdoc/managers_files.ts.html @@ -2105,13 +2105,13 @@

Source: managers/files.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_folders.ts.html b/docs/jsdoc/managers_folders.ts.html index f6ba6b22..3b4fec41 100644 --- a/docs/jsdoc/managers_folders.ts.html +++ b/docs/jsdoc/managers_folders.ts.html @@ -905,13 +905,13 @@

Source: managers/folders.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_groups.ts.html b/docs/jsdoc/managers_groups.ts.html index 3819a3d6..1026d56d 100644 --- a/docs/jsdoc/managers_groups.ts.html +++ b/docs/jsdoc/managers_groups.ts.html @@ -472,13 +472,13 @@

Source: managers/groups.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_integration-mappings.ts.html b/docs/jsdoc/managers_integration-mappings.ts.html index 3773fe69..2ac55328 100644 --- a/docs/jsdoc/managers_integration-mappings.ts.html +++ b/docs/jsdoc/managers_integration-mappings.ts.html @@ -217,13 +217,13 @@

Source: managers/integration-mappings.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_legal-hold-policies.ts.html b/docs/jsdoc/managers_legal-hold-policies.ts.html index 193cdfe6..174475d6 100644 --- a/docs/jsdoc/managers_legal-hold-policies.ts.html +++ b/docs/jsdoc/managers_legal-hold-policies.ts.html @@ -427,13 +427,13 @@

Source: managers/legal-hold-policies.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_metadata.ts.html b/docs/jsdoc/managers_metadata.ts.html index 0b82aa00..8dc60cfe 100644 --- a/docs/jsdoc/managers_metadata.ts.html +++ b/docs/jsdoc/managers_metadata.ts.html @@ -489,13 +489,13 @@

Source: managers/metadata.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_recent-items.ts.html b/docs/jsdoc/managers_recent-items.ts.html index ed0c6638..5caf0c3b 100644 --- a/docs/jsdoc/managers_recent-items.ts.html +++ b/docs/jsdoc/managers_recent-items.ts.html @@ -109,13 +109,13 @@

Source: managers/recent-items.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_retention-policies.ts.html b/docs/jsdoc/managers_retention-policies.ts.html index b81a4a33..2df3402d 100644 --- a/docs/jsdoc/managers_retention-policies.ts.html +++ b/docs/jsdoc/managers_retention-policies.ts.html @@ -624,13 +624,13 @@

Source: managers/retention-policies.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_search.ts.html b/docs/jsdoc/managers_search.ts.html index fb5453f5..bfe0a72e 100644 --- a/docs/jsdoc/managers_search.ts.html +++ b/docs/jsdoc/managers_search.ts.html @@ -185,13 +185,13 @@

Source: managers/search.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_shared-items.ts.html b/docs/jsdoc/managers_shared-items.ts.html index 1eafe7a8..9b4b1ab0 100644 --- a/docs/jsdoc/managers_shared-items.ts.html +++ b/docs/jsdoc/managers_shared-items.ts.html @@ -128,13 +128,13 @@

Source: managers/shared-items.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_shield-information-barrier-reports.generated.ts.html b/docs/jsdoc/managers_shield-information-barrier-reports.generated.ts.html index 7825d31f..4fbbe81b 100644 --- a/docs/jsdoc/managers_shield-information-barrier-reports.generated.ts.html +++ b/docs/jsdoc/managers_shield-information-barrier-reports.generated.ts.html @@ -154,13 +154,13 @@

Source: managers/shield-information-barrier-reports.gener
- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_shield-information-barrier-segment-members.generated.ts.html b/docs/jsdoc/managers_shield-information-barrier-segment-members.generated.ts.html index 89cf9221..bd839b47 100644 --- a/docs/jsdoc/managers_shield-information-barrier-segment-members.generated.ts.html +++ b/docs/jsdoc/managers_shield-information-barrier-segment-members.generated.ts.html @@ -194,13 +194,13 @@

Source: managers/shield-information-barrier-segment-membe
- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_shield-information-barrier-segment-restrictions.generated.ts.html b/docs/jsdoc/managers_shield-information-barrier-segment-restrictions.generated.ts.html index 9efb2a0b..2c6985cf 100644 --- a/docs/jsdoc/managers_shield-information-barrier-segment-restrictions.generated.ts.html +++ b/docs/jsdoc/managers_shield-information-barrier-segment-restrictions.generated.ts.html @@ -195,13 +195,13 @@

Source: managers/shield-information-barrier-segment-restr
- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_shield-information-barrier-segments.generated.ts.html b/docs/jsdoc/managers_shield-information-barrier-segments.generated.ts.html index bc56a4dc..0d7922e1 100644 --- a/docs/jsdoc/managers_shield-information-barrier-segments.generated.ts.html +++ b/docs/jsdoc/managers_shield-information-barrier-segments.generated.ts.html @@ -232,13 +232,13 @@

Source: managers/shield-information-barrier-segments.gene
- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_shield-information-barriers.generated.ts.html b/docs/jsdoc/managers_shield-information-barriers.generated.ts.html index f235e4e3..5bbebf5d 100644 --- a/docs/jsdoc/managers_shield-information-barriers.generated.ts.html +++ b/docs/jsdoc/managers_shield-information-barriers.generated.ts.html @@ -184,13 +184,13 @@

Source: managers/shield-information-barriers.generated.ts
- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_sign-requests.generated.ts.html b/docs/jsdoc/managers_sign-requests.generated.ts.html index 65c25bfd..3aec61bb 100644 --- a/docs/jsdoc/managers_sign-requests.generated.ts.html +++ b/docs/jsdoc/managers_sign-requests.generated.ts.html @@ -41,18 +41,18 @@

Source: managers/sign-requests.generated.ts

this.client = client; } /** - * Get sign request by ID + * Get Box Sign request by ID * * Gets a sign request by ID. * @param {object} options Options for the request - * @param {string} options.sign_request_id The ID of the sign request + * @param {string} options.sign_request_id The ID of the signature request * @param {Function} [callback] Passed the result if successful, error otherwise * @returns {Promise<schemas.SignRequest>} A promise resolving to the result or rejecting with an error */ getById( options: { /** - * The ID of the sign request + * The ID of the signature request */ readonly sign_request_id: string; }, @@ -70,10 +70,10 @@

Source: managers/sign-requests.generated.ts

); } /** - * List sign requests + * List Box Sign requests * - * Gets sign requests created by a user. If the `sign_files` and/or - * `parent_folder` are deleted, the sign request will not return in the list. + * Gets signature requests created by a user. If the `sign_files` and/or + * `parent_folder` are deleted, the signature request will not return in the list. * @param {object} [options] Options for the request * @param {string} [options.marker] Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`. * @param {number} [options.limit] The maximum number of items to return per page. @@ -108,10 +108,10 @@

Source: managers/sign-requests.generated.ts

); } /** - * Create sign request + * Create Box Sign request * - * Creates a sign request. This involves preparing a document for signing and - * sending the sign request to signers. + * Creates a signature request. This involves preparing a document for signing and + * sending the signature request to signers. * @param {schemas.SignRequestCreateRequest} body * @param {object} [options] Options for the request * @param {Function} [callback] Passed the result if successful, error otherwise @@ -135,18 +135,18 @@

Source: managers/sign-requests.generated.ts

); } /** - * Cancel sign request + * Cancel Box Sign request * * Cancels a sign request. * @param {object} options Options for the request - * @param {string} options.sign_request_id The ID of the sign request + * @param {string} options.sign_request_id The ID of the signature request * @param {Function} [callback] Passed the result if successful, error otherwise * @returns {Promise<schemas.SignRequest>} A promise resolving to the result or rejecting with an error */ cancelById( options: { /** - * The ID of the sign request + * The ID of the signature request */ readonly sign_request_id: string; }, @@ -164,18 +164,18 @@

Source: managers/sign-requests.generated.ts

); } /** - * Resend sign request + * Resend Box Sign request * - * Resends a sign request email to all outstanding signers. + * Resends a signature request email to all outstanding signers. * @param {object} options Options for the request - * @param {string} options.sign_request_id The ID of the sign request + * @param {string} options.sign_request_id The ID of the signature request * @param {Function} [callback] Passed the result if successful, error otherwise * @returns {Promise<void>} A promise resolving to the result or rejecting with an error */ resendById( options: { /** - * The ID of the sign request + * The ID of the signature request */ readonly sign_request_id: string; }, @@ -204,13 +204,13 @@

Source: managers/sign-requests.generated.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_sign-templates.generated.ts.html b/docs/jsdoc/managers_sign-templates.generated.ts.html index 9a515381..87c7c9c2 100644 --- a/docs/jsdoc/managers_sign-templates.generated.ts.html +++ b/docs/jsdoc/managers_sign-templates.generated.ts.html @@ -118,13 +118,13 @@

Source: managers/sign-templates.generated.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_storage-policies.ts.html b/docs/jsdoc/managers_storage-policies.ts.html index f9736bc6..a964e225 100644 --- a/docs/jsdoc/managers_storage-policies.ts.html +++ b/docs/jsdoc/managers_storage-policies.ts.html @@ -289,13 +289,13 @@

Source: managers/storage-policies.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_tasks.ts.html b/docs/jsdoc/managers_tasks.ts.html index 90e633e0..c44a77fe 100644 --- a/docs/jsdoc/managers_tasks.ts.html +++ b/docs/jsdoc/managers_tasks.ts.html @@ -392,13 +392,13 @@

Source: managers/tasks.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_terms-of-service.ts.html b/docs/jsdoc/managers_terms-of-service.ts.html index 0255cad4..8df8196a 100644 --- a/docs/jsdoc/managers_terms-of-service.ts.html +++ b/docs/jsdoc/managers_terms-of-service.ts.html @@ -432,13 +432,13 @@

Source: managers/terms-of-service.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_trash.ts.html b/docs/jsdoc/managers_trash.ts.html index 508a83bc..bdfe7a62 100644 --- a/docs/jsdoc/managers_trash.ts.html +++ b/docs/jsdoc/managers_trash.ts.html @@ -105,13 +105,13 @@

Source: managers/trash.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_users.ts.html b/docs/jsdoc/managers_users.ts.html index f1290e73..10a3b910 100644 --- a/docs/jsdoc/managers_users.ts.html +++ b/docs/jsdoc/managers_users.ts.html @@ -392,13 +392,13 @@

Source: managers/users.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_web-links.ts.html b/docs/jsdoc/managers_web-links.ts.html index 3f28be40..ca2aa0a5 100644 --- a/docs/jsdoc/managers_web-links.ts.html +++ b/docs/jsdoc/managers_web-links.ts.html @@ -319,13 +319,13 @@

Source: managers/web-links.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_webhooks.ts.html b/docs/jsdoc/managers_webhooks.ts.html index 8b0d9799..ecfa7f42 100644 --- a/docs/jsdoc/managers_webhooks.ts.html +++ b/docs/jsdoc/managers_webhooks.ts.html @@ -564,13 +564,13 @@

Source: managers/webhooks.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_ai-ask.generated.ts.html b/docs/jsdoc/schemas_ai-ask.generated.ts.html new file mode 100644 index 00000000..379e69a9 --- /dev/null +++ b/docs/jsdoc/schemas_ai-ask.generated.ts.html @@ -0,0 +1,81 @@ + + + + + JSDoc: Source: schemas/ai-ask.generated.ts + + + + + + + + + + +
+ +

Source: schemas/ai-ask.generated.ts

+ + + + + + +
+
+ 
import * as schemas from '.';
+/**
+ * AI Ask Request
+ *
+ * AI Ask request object
+ */
+export interface AiAsk {
+	/**
+	 * The mode specifies if this request is for a single or multiple items. If you select `single_item_qa` the `items` array can have one element only. Selecting `multiple_item_qa` allows you to provide up to 25 items.
+	 * Example: multiple_item_qa
+	 */
+	mode: 'multiple_item_qa' | 'single_item_qa';
+	/**
+	 * The prompt provided by the client to be answered by the LLM. The prompt's length is limited to 10000 characters.
+	 * Example: What is the value provided by public APIs based on this document?
+	 */
+	prompt: string;
+	/**
+	 * The items to be processed by the LLM, often files.
+	 *
+	 * **Note**: Box AI handles documents with text representations up to 1MB in size, or a maximum of 25 files, whichever comes first.
+	 * If the file size exceeds 1MB, the first 1MB of text representation will be processed.
+	 * If you set `mode` parameter to `single_item_qa`, the `items` array can have one element only.
+	 */
+	items: {
+		id?: string;
+		type?: string;
+		content?: string;
+	}[];
+}
+
+
+
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time) +
+ + + + + diff --git a/docs/jsdoc/schemas_ai-response.generated.ts.html b/docs/jsdoc/schemas_ai-response.generated.ts.html new file mode 100644 index 00000000..4194a175 --- /dev/null +++ b/docs/jsdoc/schemas_ai-response.generated.ts.html @@ -0,0 +1,74 @@ + + + + + JSDoc: Source: schemas/ai-response.generated.ts + + + + + + + + + + +
+ +

Source: schemas/ai-response.generated.ts

+ + + + + + +
+
+ 
import * as schemas from '.';
+/**
+ * AI Response
+ *
+ * AI response
+ */
+export interface AiResponse {
+	/**
+	 * The answer provided by the LLM.
+	 * Example: Public APIs are important because of key and important reasons.
+	 */
+	answer: string;
+	/**
+	 * The ISO date formatted timestamp of when the answer to the prompt was created.
+	 * Example: 2012-12-12T10:53:43-08:00
+	 */
+	created_at: string;
+	/**
+	 * The reason the response finishes.
+	 * Example: done
+	 */
+	completion_reason?: string;
+}
+
+
+
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time) +
+ + + + + diff --git a/docs/jsdoc/schemas_ai-text-gen.generated.ts.html b/docs/jsdoc/schemas_ai-text-gen.generated.ts.html new file mode 100644 index 00000000..dad0f57b --- /dev/null +++ b/docs/jsdoc/schemas_ai-text-gen.generated.ts.html @@ -0,0 +1,84 @@ + + + + + JSDoc: Source: schemas/ai-text-gen.generated.ts + + + + + + + + + + +
+ +

Source: schemas/ai-text-gen.generated.ts

+ + + + + + +
+
+ 
import * as schemas from '.';
+/**
+ * AI Text Gen Request
+ *
+ * AI Text Gen Request object
+ */
+export interface AiTextGen {
+	/**
+	 * The prompt provided by the client to be answered by the LLM. The prompt's length is limited to 10000 characters.
+	 * Example: Write an email to a client about the importance of public APIs.
+	 */
+	prompt: string;
+	/**
+	 * The items to be processed by the LLM, often files.
+	 * The array can include **exactly one** element.
+	 *
+	 * **Note**: Box AI handles documents with text representations up to 1MB in size.
+	 * If the file size exceeds 1MB, the first 1MB of text representation will be processed.
+	 */
+	items: {
+		id?: string;
+		type?: string;
+		content?: string;
+	}[];
+	/**
+	 * The history of prompts and answers previously passed to the LLM. This provides additional context to the LLM in generating the response.
+	 */
+	dialogue_history?: {
+		answer?: string;
+		created_at?: string;
+		prompt?: string;
+	}[];
+}
+
+
+
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time) +
+ + + + + diff --git a/docs/jsdoc/schemas_enterprise-base.generated.ts.html b/docs/jsdoc/schemas_enterprise-base.generated.ts.html index c37a7863..81726bcd 100644 --- a/docs/jsdoc/schemas_enterprise-base.generated.ts.html +++ b/docs/jsdoc/schemas_enterprise-base.generated.ts.html @@ -55,13 +55,13 @@

Source: schemas/enterprise-base.generated.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_file-base.generated.ts.html b/docs/jsdoc/schemas_file-base.generated.ts.html index 163bf030..457ce252 100644 --- a/docs/jsdoc/schemas_file-base.generated.ts.html +++ b/docs/jsdoc/schemas_file-base.generated.ts.html @@ -69,13 +69,13 @@

Source: schemas/file-base.generated.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_file-mini.generated.ts.html b/docs/jsdoc/schemas_file-mini.generated.ts.html index 63c23582..432e5a46 100644 --- a/docs/jsdoc/schemas_file-mini.generated.ts.html +++ b/docs/jsdoc/schemas_file-mini.generated.ts.html @@ -77,13 +77,13 @@

Source: schemas/file-mini.generated.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_file-version-base.generated.ts.html b/docs/jsdoc/schemas_file-version-base.generated.ts.html index 1ee4ce17..8ad63602 100644 --- a/docs/jsdoc/schemas_file-version-base.generated.ts.html +++ b/docs/jsdoc/schemas_file-version-base.generated.ts.html @@ -56,13 +56,13 @@

Source: schemas/file-version-base.generated.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_file-version-mini.generated.ts.html b/docs/jsdoc/schemas_file-version-mini.generated.ts.html index 925dea71..ac953406 100644 --- a/docs/jsdoc/schemas_file-version-mini.generated.ts.html +++ b/docs/jsdoc/schemas_file-version-mini.generated.ts.html @@ -50,13 +50,13 @@

Source: schemas/file-version-mini.generated.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_folder-base.generated.ts.html b/docs/jsdoc/schemas_folder-base.generated.ts.html index a4b4eb9a..c26229b5 100644 --- a/docs/jsdoc/schemas_folder-base.generated.ts.html +++ b/docs/jsdoc/schemas_folder-base.generated.ts.html @@ -69,13 +69,13 @@

Source: schemas/folder-base.generated.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_folder-mini.generated.ts.html b/docs/jsdoc/schemas_folder-mini.generated.ts.html index 9081ccf1..d57d017c 100644 --- a/docs/jsdoc/schemas_folder-mini.generated.ts.html +++ b/docs/jsdoc/schemas_folder-mini.generated.ts.html @@ -67,13 +67,13 @@

Source: schemas/folder-mini.generated.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_integration-mapping-base.ts.html b/docs/jsdoc/schemas_integration-mapping-base.ts.html index f2f8777d..5111ab0e 100644 --- a/docs/jsdoc/schemas_integration-mapping-base.ts.html +++ b/docs/jsdoc/schemas_integration-mapping-base.ts.html @@ -60,13 +60,13 @@

Source: schemas/integration-mapping-base.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_integration-mapping-box-item-slack.ts.html b/docs/jsdoc/schemas_integration-mapping-box-item-slack.ts.html index bdae4fd5..edb3f46d 100644 --- a/docs/jsdoc/schemas_integration-mapping-box-item-slack.ts.html +++ b/docs/jsdoc/schemas_integration-mapping-box-item-slack.ts.html @@ -54,13 +54,13 @@

Source: schemas/integration-mapping-box-item-slack.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_integration-mapping-partner-item-slack.ts.html b/docs/jsdoc/schemas_integration-mapping-partner-item-slack.ts.html index 74b01f7f..71f7e02b 100644 --- a/docs/jsdoc/schemas_integration-mapping-partner-item-slack.ts.html +++ b/docs/jsdoc/schemas_integration-mapping-partner-item-slack.ts.html @@ -64,13 +64,13 @@

Source: schemas/integration-mapping-partner-item-slack.ts
- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_integration-mapping-slack-create-request.ts.html b/docs/jsdoc/schemas_integration-mapping-slack-create-request.ts.html index acfa8d80..704ec245 100644 --- a/docs/jsdoc/schemas_integration-mapping-slack-create-request.ts.html +++ b/docs/jsdoc/schemas_integration-mapping-slack-create-request.ts.html @@ -48,13 +48,13 @@

Source: schemas/integration-mapping-slack-create-request.
- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_integration-mapping-slack-options.ts.html b/docs/jsdoc/schemas_integration-mapping-slack-options.ts.html index b207fc85..e2aef1c4 100644 --- a/docs/jsdoc/schemas_integration-mapping-slack-options.ts.html +++ b/docs/jsdoc/schemas_integration-mapping-slack-options.ts.html @@ -53,13 +53,13 @@

Source: schemas/integration-mapping-slack-options.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_integration-mapping.ts.html b/docs/jsdoc/schemas_integration-mapping.ts.html index fa59b792..73a109be 100644 --- a/docs/jsdoc/schemas_integration-mapping.ts.html +++ b/docs/jsdoc/schemas_integration-mapping.ts.html @@ -91,13 +91,13 @@

Source: schemas/integration-mapping.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_integration-mappings.ts.html b/docs/jsdoc/schemas_integration-mappings.ts.html index ae1f96c7..2a02ce68 100644 --- a/docs/jsdoc/schemas_integration-mappings.ts.html +++ b/docs/jsdoc/schemas_integration-mappings.ts.html @@ -63,13 +63,13 @@

Source: schemas/integration-mappings.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_shield-information-barrier-base.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier-base.generated.ts.html index d6c142cc..2f09ead5 100644 --- a/docs/jsdoc/schemas_shield-information-barrier-base.generated.ts.html +++ b/docs/jsdoc/schemas_shield-information-barrier-base.generated.ts.html @@ -55,13 +55,13 @@

Source: schemas/shield-information-barrier-base.generated
- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_shield-information-barrier-reference.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier-reference.generated.ts.html index b6bf6eec..fd382823 100644 --- a/docs/jsdoc/schemas_shield-information-barrier-reference.generated.ts.html +++ b/docs/jsdoc/schemas_shield-information-barrier-reference.generated.ts.html @@ -45,13 +45,13 @@

Source: schemas/shield-information-barrier-reference.gene
- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_shield-information-barrier-report-base.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier-report-base.generated.ts.html index ed2e2795..01811fcd 100644 --- a/docs/jsdoc/schemas_shield-information-barrier-report-base.generated.ts.html +++ b/docs/jsdoc/schemas_shield-information-barrier-report-base.generated.ts.html @@ -55,13 +55,13 @@

Source: schemas/shield-information-barrier-report-base.ge
- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_shield-information-barrier-report-details.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier-report-details.generated.ts.html index 095363c7..f4d74427 100644 --- a/docs/jsdoc/schemas_shield-information-barrier-report-details.generated.ts.html +++ b/docs/jsdoc/schemas_shield-information-barrier-report-details.generated.ts.html @@ -46,13 +46,13 @@

Source: schemas/shield-information-barrier-report-details
- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_shield-information-barrier-report.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier-report.generated.ts.html index bbae5506..0fc9fcd6 100644 --- a/docs/jsdoc/schemas_shield-information-barrier-report.generated.ts.html +++ b/docs/jsdoc/schemas_shield-information-barrier-report.generated.ts.html @@ -69,13 +69,13 @@

Source: schemas/shield-information-barrier-report.generat
- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_shield-information-barrier-reports.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier-reports.generated.ts.html index 5ab0c8a4..b9aa5bf5 100644 --- a/docs/jsdoc/schemas_shield-information-barrier-reports.generated.ts.html +++ b/docs/jsdoc/schemas_shield-information-barrier-reports.generated.ts.html @@ -62,13 +62,13 @@

Source: schemas/shield-information-barrier-reports.genera
- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_shield-information-barrier-segment-member-base.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier-segment-member-base.generated.ts.html index 09ee2f04..54fad092 100644 --- a/docs/jsdoc/schemas_shield-information-barrier-segment-member-base.generated.ts.html +++ b/docs/jsdoc/schemas_shield-information-barrier-segment-member-base.generated.ts.html @@ -56,13 +56,13 @@

Source: schemas/shield-information-barrier-segment-member
- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_shield-information-barrier-segment-member-mini.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier-segment-member-mini.generated.ts.html index f66dcf00..33822182 100644 --- a/docs/jsdoc/schemas_shield-information-barrier-segment-member-mini.generated.ts.html +++ b/docs/jsdoc/schemas_shield-information-barrier-segment-member-mini.generated.ts.html @@ -50,13 +50,13 @@

Source: schemas/shield-information-barrier-segment-member
- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_shield-information-barrier-segment-member.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier-segment-member.generated.ts.html index d1a76d17..37ad5e2a 100644 --- a/docs/jsdoc/schemas_shield-information-barrier-segment-member.generated.ts.html +++ b/docs/jsdoc/schemas_shield-information-barrier-segment-member.generated.ts.html @@ -76,13 +76,13 @@

Source: schemas/shield-information-barrier-segment-member
- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_shield-information-barrier-segment-members.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier-segment-members.generated.ts.html index 63194803..540c3dae 100644 --- a/docs/jsdoc/schemas_shield-information-barrier-segment-members.generated.ts.html +++ b/docs/jsdoc/schemas_shield-information-barrier-segment-members.generated.ts.html @@ -62,13 +62,13 @@

Source: schemas/shield-information-barrier-segment-member
- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_shield-information-barrier-segment-restriction-base.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier-segment-restriction-base.generated.ts.html index 05f14abd..1099592e 100644 --- a/docs/jsdoc/schemas_shield-information-barrier-segment-restriction-base.generated.ts.html +++ b/docs/jsdoc/schemas_shield-information-barrier-segment-restriction-base.generated.ts.html @@ -57,13 +57,13 @@

Source: schemas/shield-information-barrier-segment-restri
- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_shield-information-barrier-segment-restriction-mini.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier-segment-restriction-mini.generated.ts.html index 14a537e0..e695bbf4 100644 --- a/docs/jsdoc/schemas_shield-information-barrier-segment-restriction-mini.generated.ts.html +++ b/docs/jsdoc/schemas_shield-information-barrier-segment-restriction-mini.generated.ts.html @@ -57,13 +57,13 @@

Source: schemas/shield-information-barrier-segment-restri
- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_shield-information-barrier-segment-restriction.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier-segment-restriction.generated.ts.html index 3e65ba92..2ebd33d0 100644 --- a/docs/jsdoc/schemas_shield-information-barrier-segment-restriction.generated.ts.html +++ b/docs/jsdoc/schemas_shield-information-barrier-segment-restriction.generated.ts.html @@ -70,13 +70,13 @@

Source: schemas/shield-information-barrier-segment-restri
- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_shield-information-barrier-segment-restrictions.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier-segment-restrictions.generated.ts.html index ffb37274..3b095678 100644 --- a/docs/jsdoc/schemas_shield-information-barrier-segment-restrictions.generated.ts.html +++ b/docs/jsdoc/schemas_shield-information-barrier-segment-restrictions.generated.ts.html @@ -62,13 +62,13 @@

Source: schemas/shield-information-barrier-segment-restri
- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_shield-information-barrier-segment.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier-segment.generated.ts.html index 2be51467..f0b6de12 100644 --- a/docs/jsdoc/schemas_shield-information-barrier-segment.generated.ts.html +++ b/docs/jsdoc/schemas_shield-information-barrier-segment.generated.ts.html @@ -86,13 +86,13 @@

Source: schemas/shield-information-barrier-segment.genera
- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_shield-information-barrier-segments.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier-segments.generated.ts.html index 8137c824..f1673e74 100644 --- a/docs/jsdoc/schemas_shield-information-barrier-segments.generated.ts.html +++ b/docs/jsdoc/schemas_shield-information-barrier-segments.generated.ts.html @@ -62,13 +62,13 @@

Source: schemas/shield-information-barrier-segments.gener
- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_shield-information-barrier.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier.generated.ts.html index 7de3c9be..f395f65d 100644 --- a/docs/jsdoc/schemas_shield-information-barrier.generated.ts.html +++ b/docs/jsdoc/schemas_shield-information-barrier.generated.ts.html @@ -92,13 +92,13 @@

Source: schemas/shield-information-barrier.generated.ts
- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_shield-information-barriers.generated.ts.html b/docs/jsdoc/schemas_shield-information-barriers.generated.ts.html index 0339aaeb..048273d1 100644 --- a/docs/jsdoc/schemas_shield-information-barriers.generated.ts.html +++ b/docs/jsdoc/schemas_shield-information-barriers.generated.ts.html @@ -61,13 +61,13 @@

Source: schemas/shield-information-barriers.generated.ts<
- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_sign-request-base.generated.ts.html b/docs/jsdoc/schemas_sign-request-base.generated.ts.html index 4b0e2b7c..fbf198f5 100644 --- a/docs/jsdoc/schemas_sign-request-base.generated.ts.html +++ b/docs/jsdoc/schemas_sign-request-base.generated.ts.html @@ -28,18 +28,18 @@

Source: schemas/sign-request-base.generated.ts

import * as schemas from '.';
 /**
- * Sign Request (Base)
+ * Box Sign request (Base)
  *
- * A request to create a sign request object
+ * A standard representation of a signature request object.
  */
 export interface SignRequestBase {
 	/**
-	 * Indicates if the sender should receive a `prepare_url` in the response to complete document preparation via UI.
+	 * Indicates if the sender should receive a `prepare_url` in the response to complete document preparation using the UI.
 	 * Example: true
 	 */
 	is_document_preparation_needed?: boolean;
 	/**
-	 * When specified, signature request will be redirected to this url when a document is signed.
+	 * When specified, the signature request will be redirected to this url when a document is signed.
 	 * Example: https://www.example.com
 	 */
 	redirect_url?: string;
@@ -70,18 +70,12 @@ 
Source: schemas/sign-request-base.generated.ts

 	 */
 	are_reminders_enabled?: boolean;
 	/**
-	 * The destination folder to place final, signed document and signing
-	 * log. Only `ID` and `type` fields are required. The root folder,
-	 * folder ID `0`, cannot be used.
-	 */
-	parent_folder: schemas.FolderMini;
-	/**
-	 * Name of the sign request.
+	 * Name of the signature request.
 	 * Example: name
 	 */
 	name?: string;
 	/**
-	 * When a document contains sign related tags in the content, you can prefill them using this `prefill_tags` by referencing the 'id' of the tag as the `external_id` field of the prefill tag.
+	 * When a document contains sign-related tags in the content, you can prefill them using this `prefill_tags` by referencing the 'id' of the tag as the `external_id` field of the prefill tag.
 	 */
 	prefill_tags?: schemas.SignRequestPrefillTag[];
 	/**
@@ -104,6 +98,11 @@ 
Source: schemas/sign-request-base.generated.ts

 	 * Example: 123075213-af2c8822-3ef2-4952-8557-52d69c2fe9cb
 	 */
 	template_id?: string;
+	/**
+	 * Used as an optional system name to appear in the signature log next to the signers who have been assigned the `embed_url_external_id`.
+	 * Example: Box
+	 */
+	external_system_name?: string;
 }
@@ -115,13 +114,13 @@

Source: schemas/sign-request-base.generated.ts


- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_sign-request-create-request.generated.ts.html b/docs/jsdoc/schemas_sign-request-create-request.generated.ts.html index 8d4861b6..5465a9ed 100644 --- a/docs/jsdoc/schemas_sign-request-create-request.generated.ts.html +++ b/docs/jsdoc/schemas_sign-request-create-request.generated.ts.html @@ -28,9 +28,9 @@

Source: schemas/sign-request-create-request.generated.ts< 
import * as schemas from '.';
 /**
- * Create a sign request
+ * Create a Box Sign request
  *
- * A request to create a sign request object
+ * Creates a Box Sign request object.
  */
 export interface SignRequestCreateRequest extends schemas.SignRequestBase {
 	/**
@@ -43,9 +43,27 @@ 
Source: schemas/sign-request-create-request.generated.ts<
 	 */
 	signature_color?: 'blue' | 'black' | 'red';
 	/**
-	 * Array of signers for the sign request. 35 is the max number of signers permitted.
+	 * Array of signers for the signature request. 35 is the
+	 * max number of signers permitted.
+	 *
+	 * **Note**: It may happen that some signers belong to conflicting [segments](r://shield-information-barrier-segment-member) (user groups).
+	 * This means that due to the security policies, users are assigned to segments to prevent exchanges or communication that could lead to ethical conflicts.
+	 * In such a case, an attempt to send the sign request will result in an error.
+	 *
+	 * Read more about [segments and ethical walls](https://support.box.com/hc/en-us/articles/9920431507603-Understanding-Information-Barriers#h_01GFVJEHQA06N7XEZ4GCZ9GFAQ).
 	 */
 	signers: schemas.SignRequestCreateSigner[];
+	/**
+	 * The destination folder to place final, signed document and signing
+	 * log. Only `ID` and `type` fields are required. The root folder,
+	 * folder ID `0`, cannot be used and can also not be null.
+	 *
+	 * When this value is not passed in when the signature request, then
+	 * we will use a default folder which is either the parent folder of
+	 * the first source file in the payload if we have the permission to
+	 * upload to that folder or a folder called "My Sign Requests".
+	 */
+	parent_folder?: schemas.FolderMini;
 }
@@ -57,13 +75,13 @@

Source: schemas/sign-request-create-request.generated.ts<
- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_sign-request-create-signer.generated.ts.html b/docs/jsdoc/schemas_sign-request-create-signer.generated.ts.html index 5c5a233a..7fc576cf 100644 --- a/docs/jsdoc/schemas_sign-request-create-signer.generated.ts.html +++ b/docs/jsdoc/schemas_sign-request-create-signer.generated.ts.html @@ -28,9 +28,10 @@

Source: schemas/sign-request-create-signer.generated.ts 
import * as schemas from '.';
 /**
- * Signer fields for Create Sign Request
+ * Signer fields used to create a Box Sign request object.
  *
- * The schema for a Signer in a POST Sign Request request body
+ * The schema for a Signer object used in
+ * for creating a Box Sign request object.
  */
 export interface SignRequestCreateSigner {
 	/**
@@ -40,7 +41,7 @@ 
Source: schemas/sign-request-create-signer.generated.tsSource: schemas/sign-request-create-signer.generated.tsSource: schemas/sign-request-create-signer.generated.ts
@@ -121,13 +132,13 @@

Source: schemas/sign-request-create-signer.generated.ts
- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_sign-request-prefill-tag.generated.ts.html b/docs/jsdoc/schemas_sign-request-prefill-tag.generated.ts.html index ce37085a..dabff463 100644 --- a/docs/jsdoc/schemas_sign-request-prefill-tag.generated.ts.html +++ b/docs/jsdoc/schemas_sign-request-prefill-tag.generated.ts.html @@ -28,14 +28,14 @@

Source: schemas/sign-request-prefill-tag.generated.ts

import * as schemas from '.';
 /**
- * Sign Request Prefill Tag
+ * Sign request prefill tag
  *
  * Prefill tags are used to prefill placeholders with signer input data. Only
  * one value field can be included.
  */
 export interface SignRequestPrefillTag {
 	/**
-	 * This references the ID of a specific tag contained in a file of the sign request.
+	 * This references the ID of a specific tag contained in a file of the signature request.
 	 * Example: 1234
 	 */
 	document_tag_id?: string;
@@ -65,13 +65,13 @@ 
Source: schemas/sign-request-prefill-tag.generated.ts

 
 
 
 

 
 

-    Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time)
+    Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
 

 
 
diff --git a/docs/jsdoc/schemas_sign-request-signer-input.generated.ts.html b/docs/jsdoc/schemas_sign-request-signer-input.generated.ts.html
index 5b0a8d8c..3ba2d704 100644
--- a/docs/jsdoc/schemas_sign-request-signer-input.generated.ts.html
+++ b/docs/jsdoc/schemas_sign-request-signer-input.generated.ts.html
@@ -63,6 +63,11 @@ 
Source: schemas/sign-request-signer-input.generated.ts
@@ -74,13 +79,13 @@

Source: schemas/sign-request-signer-input.generated.ts
- Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_sign-request-signer.generated.ts.html b/docs/jsdoc/schemas_sign-request-signer.generated.ts.html index af8d8c13..7a938098 100644 --- a/docs/jsdoc/schemas_sign-request-signer.generated.ts.html +++ b/docs/jsdoc/schemas_sign-request-signer.generated.ts.html @@ -28,9 +28,10 @@

Source: schemas/sign-request-signer.generated.ts

import * as schemas from '.';
 /**
- * Signer fields for GET Sign Request response
+ * Signer fields for Box Sign request response
  *
- * The schema for a Signer in a GET Sign Request request body
+ * The schema for a Signer object used
+ * on the body of a Box Sign request object.
  */
 export interface SignRequestSigner extends schemas.SignRequestCreateSigner {
 	/**
@@ -39,7 +40,7 @@ 
Source: schemas/sign-request-signer.generated.ts

 	 */
 	has_viewed_document?: boolean;
 	/**
-	 * Final decision made by the signer
+	 * Final decision made by the signer.
 	 */
 	signer_decision?: object;
 	inputs?: schemas.SignRequestSignerInput[];
@@ -54,7 +55,7 @@ 
Source: schemas/sign-request-signer.generated.ts

 	 * It will be returned in the response
 	 * only if the `embed_url_external_user_id`
 	 * parameter was passed in the
-	 * `create sign request` call.
+	 * `create Box Sign request` call.
 	 * Example: https://app.box.com/embed/sign/document/gfhr4222-a331-494b-808b-79bc7f3992a3/f14d7098-a331-494b-808b-79bc7f3992a4
 	 */
 	iframeable_embed_url?: string;
@@ -69,13 +70,13 @@ 
Source: schemas/sign-request-signer.generated.ts

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time)
+    Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
 

 
 
diff --git a/docs/jsdoc/schemas_sign-request.generated.ts.html b/docs/jsdoc/schemas_sign-request.generated.ts.html
index 3930da04..d10497ee 100644
--- a/docs/jsdoc/schemas_sign-request.generated.ts.html
+++ b/docs/jsdoc/schemas_sign-request.generated.ts.html
@@ -28,9 +28,9 @@ 
Source: schemas/sign-request.generated.ts

         

             
import * as schemas from '.';
 /**
- * Sign Request
+ * Box Sign request
  *
- * A Sign Request Object
+ * A Box Sign request object.
  */
 export interface SignRequest extends schemas.SignRequestBase {
 	/**
@@ -43,7 +43,7 @@ 
Source: schemas/sign-request.generated.ts

 	 */
 	source_files?: schemas.FileBase[];
 	/**
-	 * Array of signers for the sign request
+	 * Array of signers for the signature request.
 	 */
 	signers?: schemas.SignRequestSigner[];
 	/**
@@ -52,24 +52,27 @@ 
Source: schemas/sign-request.generated.ts

 	 */
 	signature_color?: string;
 	/**
-	 * Sign request ID
+	 * Box Sign request ID.
 	 * Example: 12345
 	 */
 	id?: string;
 	/**
 	 * This URL is returned if `is_document_preparation_needed` is
-	 * set to `true` in the request. It is used to prepare the sign request
-	 * via UI. The sign request is not sent until preparation is complete.
+	 * set to `true` in the request. The parameter is used to prepare
+	 * the signature request
+	 * using the UI. The signature request is not
+	 * sent until the preparation
+	 * phase is complete.
 	 * Example: https://prepareurl.com
 	 */
 	prepare_url?: string;
 	/**
 	 * Reference to a file that holds a log of all signer activity for
-	 * the request
+	 * the request.
 	 */
 	signing_log?: schemas.FileMini;
 	/**
-	 * Describes the status of the sign request
+	 * Describes the status of the signature request.
 	 * Example: converting
 	 */
 	status?:
@@ -96,6 +99,16 @@ 
Source: schemas/sign-request.generated.ts

 	 * Example: 2021-04-26T08:12:13.982Z
 	 */
 	auto_expire_at?: string;
+	/**
+	 * The destination folder to place final, signed document and signing
+	 * log.
+	 *
+	 * When this value was not passed in when the signature request was
+	 * created, then we will use a default folder which is either the parent
+	 * folder of the first source file in the payload if we have the permission
+	 * to upload to that folder or a folder called "My Sign Requests".
+	 */
+	parent_folder?: schemas.FolderMini;
 }
 

         

@@ -107,13 +120,13 @@ 
Source: schemas/sign-request.generated.ts

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time)
+    Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
 

 
 
diff --git a/docs/jsdoc/schemas_sign-requests.generated.ts.html b/docs/jsdoc/schemas_sign-requests.generated.ts.html
index ab1fa93c..83a77d48 100644
--- a/docs/jsdoc/schemas_sign-requests.generated.ts.html
+++ b/docs/jsdoc/schemas_sign-requests.generated.ts.html
@@ -28,7 +28,7 @@ 
Source: schemas/sign-requests.generated.ts

         

             
import * as schemas from '.';
 /**
- * Box Sign
+ * Box Sign requests
  *
  * The part of an API response that describes marker
  * based pagination
@@ -47,7 +47,7 @@ 
Source: schemas/sign-requests.generated.ts

 	 */
 	next_marker?: string;
 	/**
-	 * A list of sign requests
+	 * A list of Box Sign requests.
 	 */
 	entries?: schemas.SignRequest[];
 }
@@ -61,13 +61,13 @@ 
Source: schemas/sign-requests.generated.ts

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time)
+    Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
 

 
 
diff --git a/docs/jsdoc/schemas_sign-template.generated.ts.html b/docs/jsdoc/schemas_sign-template.generated.ts.html
index 02ffe279..380bfbaf 100644
--- a/docs/jsdoc/schemas_sign-template.generated.ts.html
+++ b/docs/jsdoc/schemas_sign-template.generated.ts.html
@@ -98,6 +98,12 @@ 
Source: schemas/sign-template.generated.ts

 	are_files_locked?: boolean;
 	/**
 	 * Array of signers for the template.
+	 *
+	 * **Note**: It may happen that some signers specified in the template belong to conflicting [segments](r://shield-information-barrier-segment-member) (user groups).
+	 * This means that due to the security policies, users are assigned to segments to prevent exchanges or communication that could lead to ethical conflicts.
+	 * In such a case, an attempt to send a sign request based on a template that lists signers in conflicting segments will result in an error.
+	 *
+	 * Read more about [segments and ethical walls](https://support.box.com/hc/en-us/articles/9920431507603-Understanding-Information-Barriers#h_01GFVJEHQA06N7XEZ4GCZ9GFAQ).
 	 */
 	signers?: schemas.TemplateSigner[];
 	/**
@@ -124,13 +130,13 @@ 
Source: schemas/sign-template.generated.ts

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time)
+    Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
 

 
 
diff --git a/docs/jsdoc/schemas_sign-templates.generated.ts.html b/docs/jsdoc/schemas_sign-templates.generated.ts.html
index 93783b3d..2310438c 100644
--- a/docs/jsdoc/schemas_sign-templates.generated.ts.html
+++ b/docs/jsdoc/schemas_sign-templates.generated.ts.html
@@ -66,13 +66,13 @@ 
Source: schemas/sign-templates.generated.ts

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time)
+    Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
 

 
 
diff --git a/docs/jsdoc/schemas_template-signer-input.generated.ts.html b/docs/jsdoc/schemas_template-signer-input.generated.ts.html
index 7b599179..576b4cc1 100644
--- a/docs/jsdoc/schemas_template-signer-input.generated.ts.html
+++ b/docs/jsdoc/schemas_template-signer-input.generated.ts.html
@@ -103,6 +103,11 @@ 
Source: schemas/template-signer-input.generated.ts

 	 * Example: Legal name
 	 */
 	label?: string;
+	/**
+	 * Whether this input was defined as read-only(immutable by signers) or not
+	 * Example: true
+	 */
+	read_only?: boolean;
 }
 

         

@@ -114,13 +119,13 @@ 
Source: schemas/template-signer-input.generated.ts

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time)
+    Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
 

 
 
diff --git a/docs/jsdoc/schemas_template-signer.generated.ts.html b/docs/jsdoc/schemas_template-signer.generated.ts.html
index 3d5a5bb4..438cd053 100644
--- a/docs/jsdoc/schemas_template-signer.generated.ts.html
+++ b/docs/jsdoc/schemas_template-signer.generated.ts.html
@@ -62,9 +62,9 @@ 
Source: schemas/template-signer.generated.ts

 	 */
 	order?: number;
 	/**
-	 * If set, signers who have the same group ID will be assigned to the same input.
-	 * A signer group is expected to have more than one signer. When a group contains fewer than two signers,
-	 * it will be converted to a single signer and the group will be removed.
+	 * If provided, this value points signers that are assigned the same inputs and belongs to same signer group.
+	 * A signer group is not a Box Group. It is an entity that belongs to the template itself and can only be used
+	 * within Box Sign requests created from it.
 	 * Example: cd4ff89-8fc1-42cf-8b29-1890dedd26d7
 	 */
 	signer_group_id?: string;
@@ -79,13 +79,13 @@ 
Source: schemas/template-signer.generated.ts

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time)
+    Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
 

 
 
diff --git a/docs/jsdoc/schemas_user-base.generated.ts.html b/docs/jsdoc/schemas_user-base.generated.ts.html
index 7003a2b7..33002b13 100644
--- a/docs/jsdoc/schemas_user-base.generated.ts.html
+++ b/docs/jsdoc/schemas_user-base.generated.ts.html
@@ -55,13 +55,13 @@ 
Source: schemas/user-base.generated.ts

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time)
+    Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
 

 
 
diff --git a/docs/jsdoc/schemas_user-integration-mappings.ts.html b/docs/jsdoc/schemas_user-integration-mappings.ts.html
index be427f34..5e9f8faf 100644
--- a/docs/jsdoc/schemas_user-integration-mappings.ts.html
+++ b/docs/jsdoc/schemas_user-integration-mappings.ts.html
@@ -55,13 +55,13 @@ 
Source: schemas/user-integration-mappings.ts

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time)
+    Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
 

 
 
diff --git a/docs/jsdoc/sessions_app-auth-session.ts.html b/docs/jsdoc/sessions_app-auth-session.ts.html
index 6b20477e..15ec90d2 100644
--- a/docs/jsdoc/sessions_app-auth-session.ts.html
+++ b/docs/jsdoc/sessions_app-auth-session.ts.html
@@ -275,13 +275,13 @@ 
Source: sessions/app-auth-session.ts

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time)
+    Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
 

 
 
diff --git a/docs/jsdoc/sessions_basic-session.ts.html b/docs/jsdoc/sessions_basic-session.ts.html
index e03080e2..f78ae9ea 100644
--- a/docs/jsdoc/sessions_basic-session.ts.html
+++ b/docs/jsdoc/sessions_basic-session.ts.html
@@ -131,13 +131,13 @@ 
Source: sessions/basic-session.ts

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time)
+    Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
 

 
 
diff --git a/docs/jsdoc/sessions_ccg-session.ts.html b/docs/jsdoc/sessions_ccg-session.ts.html
index 6c66250d..80cebd24 100644
--- a/docs/jsdoc/sessions_ccg-session.ts.html
+++ b/docs/jsdoc/sessions_ccg-session.ts.html
@@ -188,13 +188,13 @@ 
Source: sessions/ccg-session.ts

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time)
+    Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
 

 
 
diff --git a/docs/jsdoc/sessions_persistent-session.ts.html b/docs/jsdoc/sessions_persistent-session.ts.html
index 37685aef..6373e69d 100644
--- a/docs/jsdoc/sessions_persistent-session.ts.html
+++ b/docs/jsdoc/sessions_persistent-session.ts.html
@@ -340,13 +340,13 @@ 
Source: sessions/persistent-session.ts

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time)
+    Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
 

 
 
diff --git a/docs/jsdoc/token-manager.ts.html b/docs/jsdoc/token-manager.ts.html
index 14b9c76a..979e7c9b 100644
--- a/docs/jsdoc/token-manager.ts.html
+++ b/docs/jsdoc/token-manager.ts.html
@@ -674,13 +674,13 @@ 
Source: token-manager.ts

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time)
+    Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
 

 
 
diff --git a/docs/jsdoc/util_config.ts.html b/docs/jsdoc/util_config.ts.html
index 83a63207..daf62fbb 100644
--- a/docs/jsdoc/util_config.ts.html
+++ b/docs/jsdoc/util_config.ts.html
@@ -340,13 +340,13 @@ 
Source: util/config.ts

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time)
+    Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
 

 
 
diff --git a/docs/jsdoc/util_errors.ts.html b/docs/jsdoc/util_errors.ts.html
index 99089ab3..7890d66d 100644
--- a/docs/jsdoc/util_errors.ts.html
+++ b/docs/jsdoc/util_errors.ts.html
@@ -214,13 +214,13 @@ 
Source: util/errors.ts

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time)
+    Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
 

 
 
diff --git a/docs/jsdoc/util_exponential-backoff.ts.html b/docs/jsdoc/util_exponential-backoff.ts.html
index c00c23b2..d899ac1f 100644
--- a/docs/jsdoc/util_exponential-backoff.ts.html
+++ b/docs/jsdoc/util_exponential-backoff.ts.html
@@ -61,13 +61,13 @@ 
Source: util/exponential-backoff.ts

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time)
+    Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
 

 
 
diff --git a/docs/jsdoc/util_paging-iterator.ts.html b/docs/jsdoc/util_paging-iterator.ts.html
index 4ce17810..a3c03980 100644
--- a/docs/jsdoc/util_paging-iterator.ts.html
+++ b/docs/jsdoc/util_paging-iterator.ts.html
@@ -288,13 +288,13 @@ 
Source: util/paging-iterator.ts

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time)
+    Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
 

 
 
diff --git a/docs/jsdoc/util_url-path.ts.html b/docs/jsdoc/util_url-path.ts.html
index 17eb9836..6d5d7908 100644
--- a/docs/jsdoc/util_url-path.ts.html
+++ b/docs/jsdoc/util_url-path.ts.html
@@ -91,13 +91,13 @@ 
Source: util/url-path.ts

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.6.11 on Mon May 20 2024 07:28:14 GMT-0700 (Pacific Daylight Time)
+    Documentation generated by JSDoc 3.6.11 on Tue Jul 16 2024 05:09:52 GMT-0700 (Pacific Daylight Time)
 

 
 
diff --git a/examples/app-auth/package.json b/examples/app-auth/package.json
index a655a28b..8de2be11 100644
--- a/examples/app-auth/package.json
+++ b/examples/app-auth/package.json
@@ -12,7 +12,7 @@
   "license": "Apache-2.0",
   "dependencies": {
     "body-parser": "^1.15.0",
-    "box-node-sdk": "^3.6.0",
+    "box-node-sdk": "^3.7.0",
     "express": "^4.13.4",
     "express-formidable": "^0.1.2",
     "express-handlebars": "^3.0.0",
diff --git a/package-lock.json b/package-lock.json
index e24a0c55..716c82ab 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,6 +1,6 @@
 {
   "name": "box-node-sdk",
-  "version": "3.6.0",
+  "version": "3.7.0",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {
diff --git a/package.json b/package.json
index e9f5ced0..4c7a4479 100644
--- a/package.json
+++ b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "box-node-sdk",
   "author": "Box ",
-  "version": "3.6.0",
+  "version": "3.7.0",
   "description": "Official SDK for Box Plaform APIs",
   "license": "Apache-2.0",
   "repository": {