diff --git a/CHANGELOG.md b/CHANGELOG.md index a23a3fe3..151f3ab3 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.2.0](https://github.com/box/box-node-sdk/compare/v3.1.1...v3.2.0) (2023-09-07) + + +### New Features and Enhancements + +* Support sign template ([#848](https://github.com/box/box-node-sdk/issues/848)) ([18d3413](https://github.com/box/box-node-sdk/commit/18d3413afeddf43c62dfd0caf1279e61c99b6b83)) + ### [3.1.1](https://github.com/box/box-node-sdk/compare/v3.1.0...v3.1.1) (2023-07-19) diff --git a/docs/jsdoc/APIRequest.html b/docs/jsdoc/APIRequest.html index 1da19852..4ff6710c 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 1a5e1fa8..73265513 100644 --- a/docs/jsdoc/APIRequestManager.html +++ b/docs/jsdoc/APIRequestManager.html @@ -867,13 +867,13 @@
Returns:

diff --git a/docs/jsdoc/AppAuthSession.html b/docs/jsdoc/AppAuthSession.html index 52a96a16..327d5739 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 e953b0c9..a0425f71 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 7f2596cd..912928eb 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/BoxSDKNode.html b/docs/jsdoc/BoxSDKNode.html index 399fc675..a675b96a 100644 --- a/docs/jsdoc/BoxSDKNode.html +++ b/docs/jsdoc/BoxSDKNode.html @@ -5909,13 +5909,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/CCGSession.html b/docs/jsdoc/CCGSession.html index fbb5bd8b..cdd0fada 100644 --- a/docs/jsdoc/CCGSession.html +++ b/docs/jsdoc/CCGSession.html @@ -1519,13 +1519,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Chunk_Chunk.html b/docs/jsdoc/Chunk_Chunk.html index 80c8301a..16da020f 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ChunkedUploader.html b/docs/jsdoc/ChunkedUploader.html index ea7b6b48..cf0d6cb2 100644 --- a/docs/jsdoc/ChunkedUploader.html +++ b/docs/jsdoc/ChunkedUploader.html @@ -1514,13 +1514,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ChunkedUploader_ChunkedUploader.html b/docs/jsdoc/ChunkedUploader_ChunkedUploader.html index 3466a459..2652e774 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/CollaborationAllowlist.html b/docs/jsdoc/CollaborationAllowlist.html index 32c842c3..5c3b55c0 100644 --- a/docs/jsdoc/CollaborationAllowlist.html +++ b/docs/jsdoc/CollaborationAllowlist.html @@ -4164,13 +4164,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Collaborations.html b/docs/jsdoc/Collaborations.html index 62dd12a2..226e8c99 100644 --- a/docs/jsdoc/Collaborations.html +++ b/docs/jsdoc/Collaborations.html @@ -6048,13 +6048,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Collections.html b/docs/jsdoc/Collections.html index 59c598d6..990030d1 100644 --- a/docs/jsdoc/Collections.html +++ b/docs/jsdoc/Collections.html @@ -1050,13 +1050,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Comments.html b/docs/jsdoc/Comments.html index 9fd126e6..903ecb8d 100644 --- a/docs/jsdoc/Comments.html +++ b/docs/jsdoc/Comments.html @@ -3472,13 +3472,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Config.html b/docs/jsdoc/Config.html index 35c00994..2c1b25de 100644 --- a/docs/jsdoc/Config.html +++ b/docs/jsdoc/Config.html @@ -529,13 +529,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/DevicePins.html b/docs/jsdoc/DevicePins.html index d31de2d2..95a8eea1 100644 --- a/docs/jsdoc/DevicePins.html +++ b/docs/jsdoc/DevicePins.html @@ -1592,13 +1592,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Enterprise.html b/docs/jsdoc/Enterprise.html index f39d4351..8645c2e7 100644 --- a/docs/jsdoc/Enterprise.html +++ b/docs/jsdoc/Enterprise.html @@ -4554,13 +4554,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/EnterpriseBase.html b/docs/jsdoc/EnterpriseBase.html index 115004de..d08e3881 100644 --- a/docs/jsdoc/EnterpriseBase.html +++ b/docs/jsdoc/EnterpriseBase.html @@ -270,13 +270,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/EnterpriseEventStream.html b/docs/jsdoc/EnterpriseEventStream.html index fcc078a5..70d88746 100644 --- a/docs/jsdoc/EnterpriseEventStream.html +++ b/docs/jsdoc/EnterpriseEventStream.html @@ -1266,13 +1266,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/EventStream.html b/docs/jsdoc/EventStream.html index 1772f111..ca9e703b 100644 --- a/docs/jsdoc/EventStream.html +++ b/docs/jsdoc/EventStream.html @@ -546,13 +546,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Events.html b/docs/jsdoc/Events.html index 3f41037f..4c167b98 100644 --- a/docs/jsdoc/Events.html +++ b/docs/jsdoc/Events.html @@ -3606,13 +3606,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/FileBase.html b/docs/jsdoc/FileBase.html index 98ebcfa4..b2e8745d 100644 --- a/docs/jsdoc/FileBase.html +++ b/docs/jsdoc/FileBase.html @@ -352,13 +352,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/FileMini.html b/docs/jsdoc/FileMini.html index f5e612c6..f4d34d0e 100644 --- a/docs/jsdoc/FileMini.html +++ b/docs/jsdoc/FileMini.html @@ -428,13 +428,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/FileVersionBase.html b/docs/jsdoc/FileVersionBase.html index 572a5d0c..94a8bdc5 100644 --- a/docs/jsdoc/FileVersionBase.html +++ b/docs/jsdoc/FileVersionBase.html @@ -271,13 +271,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/FileVersionMini.html b/docs/jsdoc/FileVersionMini.html index 7e8d1ddf..af0e9d9a 100644 --- a/docs/jsdoc/FileVersionMini.html +++ b/docs/jsdoc/FileVersionMini.html @@ -197,13 +197,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Files.html b/docs/jsdoc/Files.html index b0cabfe4..3cdc72d4 100644 --- a/docs/jsdoc/Files.html +++ b/docs/jsdoc/Files.html @@ -27302,13 +27302,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/FolderBase.html b/docs/jsdoc/FolderBase.html index 659a621c..a96adf9d 100644 --- a/docs/jsdoc/FolderBase.html +++ b/docs/jsdoc/FolderBase.html @@ -352,13 +352,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/FolderMini.html b/docs/jsdoc/FolderMini.html index 1f84ee7c..dfb979bf 100644 --- a/docs/jsdoc/FolderMini.html +++ b/docs/jsdoc/FolderMini.html @@ -163,7 +163,7 @@
Type:
Source:
@@ -248,7 +248,7 @@
Type:
Source:
@@ -282,13 +282,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Folders.html b/docs/jsdoc/Folders.html index 2e5dfe34..22741b02 100644 --- a/docs/jsdoc/Folders.html +++ b/docs/jsdoc/Folders.html @@ -13062,13 +13062,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Groups.html b/docs/jsdoc/Groups.html index f3698e08..0952d60c 100644 --- a/docs/jsdoc/Groups.html +++ b/docs/jsdoc/Groups.html @@ -6943,13 +6943,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/IntegrationMapping.html b/docs/jsdoc/IntegrationMapping.html index 5c4a50cb..2483f3c3 100644 --- a/docs/jsdoc/IntegrationMapping.html +++ b/docs/jsdoc/IntegrationMapping.html @@ -782,13 +782,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/IntegrationMappingBase.html b/docs/jsdoc/IntegrationMappingBase.html index a20e9f49..83740395 100644 --- a/docs/jsdoc/IntegrationMappingBase.html +++ b/docs/jsdoc/IntegrationMappingBase.html @@ -275,13 +275,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/IntegrationMappingBoxItemSlack.html b/docs/jsdoc/IntegrationMappingBoxItemSlack.html index 0ad77db7..f217bebc 100644 --- a/docs/jsdoc/IntegrationMappingBoxItemSlack.html +++ b/docs/jsdoc/IntegrationMappingBoxItemSlack.html @@ -269,13 +269,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/IntegrationMappingPartnerItemSlack.html b/docs/jsdoc/IntegrationMappingPartnerItemSlack.html index 3b00c3f5..272313b8 100644 --- a/docs/jsdoc/IntegrationMappingPartnerItemSlack.html +++ b/docs/jsdoc/IntegrationMappingPartnerItemSlack.html @@ -415,13 +415,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/IntegrationMappingSlackCreateRequest.html b/docs/jsdoc/IntegrationMappingSlackCreateRequest.html index f3979e34..65614171 100644 --- a/docs/jsdoc/IntegrationMappingSlackCreateRequest.html +++ b/docs/jsdoc/IntegrationMappingSlackCreateRequest.html @@ -120,13 +120,13 @@

IntegrationMappingSlackCreateRequest


- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/IntegrationMappingSlackOptions.html b/docs/jsdoc/IntegrationMappingSlackOptions.html index f118190f..d1a4a65a 100644 --- a/docs/jsdoc/IntegrationMappingSlackOptions.html +++ b/docs/jsdoc/IntegrationMappingSlackOptions.html @@ -200,13 +200,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/IntegrationMappings.html b/docs/jsdoc/IntegrationMappings.html index c129655b..d7d0bbd0 100644 --- a/docs/jsdoc/IntegrationMappings.html +++ b/docs/jsdoc/IntegrationMappings.html @@ -345,13 +345,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/IntegrationMappingsManager.html b/docs/jsdoc/IntegrationMappingsManager.html index c840b631..07074998 100644 --- a/docs/jsdoc/IntegrationMappingsManager.html +++ b/docs/jsdoc/IntegrationMappingsManager.html @@ -2719,13 +2719,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/IntegrationMappingsManager_IntegrationMappingsManager.html b/docs/jsdoc/IntegrationMappingsManager_IntegrationMappingsManager.html index 39de1371..afb849c4 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 Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/LegalHoldPolicies.html b/docs/jsdoc/LegalHoldPolicies.html index c68a4b7e..3e7a2844 100644 --- a/docs/jsdoc/LegalHoldPolicies.html +++ b/docs/jsdoc/LegalHoldPolicies.html @@ -6422,13 +6422,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Metadata.html b/docs/jsdoc/Metadata.html index 878f10be..2712a033 100644 --- a/docs/jsdoc/Metadata.html +++ b/docs/jsdoc/Metadata.html @@ -6818,13 +6818,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/PagingIterator.html b/docs/jsdoc/PagingIterator.html index 89a2ac02..c22e0ac2 100644 --- a/docs/jsdoc/PagingIterator.html +++ b/docs/jsdoc/PagingIterator.html @@ -1269,13 +1269,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/PagingIterator_PagingIterator.html b/docs/jsdoc/PagingIterator_PagingIterator.html index 116bc488..50472a87 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 Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/PersistentSession.html b/docs/jsdoc/PersistentSession.html index 58b21f87..3aa8bf0b 100644 --- a/docs/jsdoc/PersistentSession.html +++ b/docs/jsdoc/PersistentSession.html @@ -1929,13 +1929,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/RecentItems.html b/docs/jsdoc/RecentItems.html index 889a799a..50ad40c3 100644 --- a/docs/jsdoc/RecentItems.html +++ b/docs/jsdoc/RecentItems.html @@ -894,13 +894,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/RetentionPolicies.html b/docs/jsdoc/RetentionPolicies.html index a9e71b6c..e7bebcfa 100644 --- a/docs/jsdoc/RetentionPolicies.html +++ b/docs/jsdoc/RetentionPolicies.html @@ -8928,13 +8928,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Search.html b/docs/jsdoc/Search.html index 3fd88fe3..9afbf372 100644 --- a/docs/jsdoc/Search.html +++ b/docs/jsdoc/Search.html @@ -2102,13 +2102,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SharedItems.html b/docs/jsdoc/SharedItems.html index 92d544f7..7ef0c301 100644 --- a/docs/jsdoc/SharedItems.html +++ b/docs/jsdoc/SharedItems.html @@ -768,13 +768,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrier.html b/docs/jsdoc/ShieldInformationBarrier.html index 782ab6f2..f9a85577 100644 --- a/docs/jsdoc/ShieldInformationBarrier.html +++ b/docs/jsdoc/ShieldInformationBarrier.html @@ -863,13 +863,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierBase.html b/docs/jsdoc/ShieldInformationBarrierBase.html index 2cc8506b..1f8b225e 100644 --- a/docs/jsdoc/ShieldInformationBarrierBase.html +++ b/docs/jsdoc/ShieldInformationBarrierBase.html @@ -270,13 +270,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierManager.html b/docs/jsdoc/ShieldInformationBarrierManager.html index bf6d5149..895bf6f8 100644 --- a/docs/jsdoc/ShieldInformationBarrierManager.html +++ b/docs/jsdoc/ShieldInformationBarrierManager.html @@ -2271,13 +2271,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierManager_ShieldInformationBarrierManager.html b/docs/jsdoc/ShieldInformationBarrierManager_ShieldInformationBarrierManager.html index 06623eff..bee0b822 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 Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierReference.html b/docs/jsdoc/ShieldInformationBarrierReference.html index f5bff19e..0960f553 100644 --- a/docs/jsdoc/ShieldInformationBarrierReference.html +++ b/docs/jsdoc/ShieldInformationBarrierReference.html @@ -119,13 +119,13 @@

ShieldInformationBarrierReference


- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierReport.html b/docs/jsdoc/ShieldInformationBarrierReport.html index 76e36549..61f8cc19 100644 --- a/docs/jsdoc/ShieldInformationBarrierReport.html +++ b/docs/jsdoc/ShieldInformationBarrierReport.html @@ -426,13 +426,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierReportBase.html b/docs/jsdoc/ShieldInformationBarrierReportBase.html index d6c42acd..de06e5f2 100644 --- a/docs/jsdoc/ShieldInformationBarrierReportBase.html +++ b/docs/jsdoc/ShieldInformationBarrierReportBase.html @@ -270,13 +270,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierReportDetails.html b/docs/jsdoc/ShieldInformationBarrierReportDetails.html index 93f19162..23d9e4f7 100644 --- a/docs/jsdoc/ShieldInformationBarrierReportDetails.html +++ b/docs/jsdoc/ShieldInformationBarrierReportDetails.html @@ -120,13 +120,13 @@

ShieldInformationBarrierReportDetails


- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierReportsManager.html b/docs/jsdoc/ShieldInformationBarrierReportsManager.html index dec3f5e1..450881e1 100644 --- a/docs/jsdoc/ShieldInformationBarrierReportsManager.html +++ b/docs/jsdoc/ShieldInformationBarrierReportsManager.html @@ -1849,13 +1849,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierReportsManager_ShieldInformationBarrierReportsManager.html b/docs/jsdoc/ShieldInformationBarrierReportsManager_ShieldInformationBarrierReportsManager.html index 50d216d3..998d9823 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 Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegment.html b/docs/jsdoc/ShieldInformationBarrierSegment.html index a91b0e29..508787a2 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegment.html +++ b/docs/jsdoc/ShieldInformationBarrierSegment.html @@ -708,13 +708,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentMember.html b/docs/jsdoc/ShieldInformationBarrierSegmentMember.html index 9d5d26e0..1c66fe7a 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentMember.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentMember.html @@ -561,13 +561,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentMemberBase.html b/docs/jsdoc/ShieldInformationBarrierSegmentMemberBase.html index aac1bb59..a2d2632c 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentMemberBase.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentMemberBase.html @@ -271,13 +271,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentMemberMini.html b/docs/jsdoc/ShieldInformationBarrierSegmentMemberMini.html index d08fb982..59079681 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentMemberMini.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentMemberMini.html @@ -196,13 +196,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentMembersManager.html b/docs/jsdoc/ShieldInformationBarrierSegmentMembersManager.html index 49064658..8041cdd6 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentMembersManager.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentMembersManager.html @@ -2361,13 +2361,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentMembersManager_ShieldInformationBarrierSegmentMembersManager.html b/docs/jsdoc/ShieldInformationBarrierSegmentMembersManager_ShieldInformationBarrierSegmentMembersManager.html index cae4ac14..a55e845f 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 Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentRestriction.html b/docs/jsdoc/ShieldInformationBarrierSegmentRestriction.html index 68b9f5e3..e3bfbaa2 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentRestriction.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentRestriction.html @@ -419,13 +419,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionBase.html b/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionBase.html index e0a0437d..c38802df 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionBase.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionBase.html @@ -272,13 +272,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionMini.html b/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionMini.html index a242b92f..5f5b533c 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionMini.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionMini.html @@ -271,13 +271,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionsManager.html b/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionsManager.html index f56a51a2..76fba382 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionsManager.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionsManager.html @@ -2363,13 +2363,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionsManager_ShieldInformationBarrierSegmentRestrictionsManager.html b/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionsManager_ShieldInformationBarrierSegmentRestrictionsManager.html index c782c034..722d1fb0 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 Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentsManager.html b/docs/jsdoc/ShieldInformationBarrierSegmentsManager.html index 634fe899..ad89e2fe 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentsManager.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentsManager.html @@ -2927,13 +2927,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentsManager_ShieldInformationBarrierSegmentsManager.html b/docs/jsdoc/ShieldInformationBarrierSegmentsManager_ShieldInformationBarrierSegmentsManager.html index 354b25f4..97a84a19 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 Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SignRequest.html b/docs/jsdoc/SignRequest.html index 2b19b9f2..082e4ce3 100644 --- a/docs/jsdoc/SignRequest.html +++ b/docs/jsdoc/SignRequest.html @@ -162,7 +162,7 @@
Type:
Source:
@@ -235,7 +235,7 @@
Type:
Source:
@@ -310,7 +310,7 @@
Type:
Source:
@@ -384,7 +384,7 @@
Type:
Source:
@@ -457,7 +457,7 @@
Type:
Source:
@@ -529,7 +529,7 @@
Type:
Source:
@@ -602,7 +602,7 @@
Type:
Source:
@@ -626,7 +626,7 @@

source_fi
- List of files to create a signing document from. Only the ID and type fields are required for each file. The array will be empty if the `source_files` are deleted. + List of files to create a signing document from. This is currently limited to ten files. Only the ID and type fields are required for each file.
@@ -674,7 +674,7 @@

Type:
Source:
@@ -692,7 +692,7 @@
Type:
-

status :'converting'|'created'|'sent'|'viewed'|'signed'|'cancelled'|'declined'|'error_converting'|'error_sending'|'expired'

+

status :'converting'|'created'|'sent'|'viewed'|'signed'|'cancelled'|'declined'|'error_converting'|'error_sending'|'expired'|'finalizing'|'error_finalizing'

@@ -736,6 +736,12 @@
Type:
| 'expired' +| + +'finalizing' +| + +'error_finalizing' @@ -774,7 +780,7 @@
Type:
Source:
@@ -881,13 +887,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SignRequestBase.html b/docs/jsdoc/SignRequestBase.html index 19f2413a..28fbd3c8 100644 --- a/docs/jsdoc/SignRequestBase.html +++ b/docs/jsdoc/SignRequestBase.html @@ -37,7 +37,7 @@

SignRequestBase

-
Create a sign request +
Sign Request (Base) A request to create a sign request object
@@ -264,7 +264,7 @@

days_valid<
- Number of days after which this request will automatically expire if not completed. + Set the number of days after which the created signature request will automatically expire if not completed. By default, we do not apply any expiration date on signature requests, and the signature request does not expire. Example: 2
@@ -1060,6 +1060,79 @@

Type:
+ +

template_id :string

+ + + + +
+ When a signature request is created from a template this field will indicate the id of that template. +Example: 123075213-af2c8822-3ef2-4952-8557-52d69c2fe9cb +
+ + + +
Type:
+
    +
  • + +string + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + @@ -1077,13 +1150,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SignRequestCreateRequest.html b/docs/jsdoc/SignRequestCreateRequest.html index 313c92a4..f0af6e7a 100644 --- a/docs/jsdoc/SignRequestCreateRequest.html +++ b/docs/jsdoc/SignRequestCreateRequest.html @@ -107,85 +107,6 @@

Members

-

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

- - - - -
- Force a specific signature color (blue, black, or red). -Example: blue -
- - - -
Type:
-
    -
  • - -'blue' -| - -'black' -| - -'red' - - -
  • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - -

signers :Array

@@ -241,7 +162,7 @@
Type:
Source:
@@ -265,10 +186,7 @@

source_fi
- List of files to create a signing document from. This is currently -limited to 10 files. Only the ID and type fields are required -for each file. The array will be empty if the `source_files` -are deleted. + List of files to create a signing document from. This is currently limited to ten files. Only the ID and type fields are required for each file.
@@ -350,13 +268,13 @@

Type:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SignRequestCreateSigner.html b/docs/jsdoc/SignRequestCreateSigner.html index 2682d727..e4c34ee1 100644 --- a/docs/jsdoc/SignRequestCreateSigner.html +++ b/docs/jsdoc/SignRequestCreateSigner.html @@ -882,13 +882,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SignRequestPrefillTag.html b/docs/jsdoc/SignRequestPrefillTag.html index 66f27d64..09b792ef 100644 --- a/docs/jsdoc/SignRequestPrefillTag.html +++ b/docs/jsdoc/SignRequestPrefillTag.html @@ -416,13 +416,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SignRequestSigner.html b/docs/jsdoc/SignRequestSigner.html index 86ef4cc1..2c52f164 100644 --- a/docs/jsdoc/SignRequestSigner.html +++ b/docs/jsdoc/SignRequestSigner.html @@ -253,6 +253,84 @@
Type:
+

iframeable_embed_url :string

+ + + + +
+ This URL is specifically designed for +signing documents within an HTML `iframe` tag. +It will be returned in the response +only if the `embed_url_external_user_id` +parameter was passed in the +`create sign request` call. +Example: https://app.box.com/embed/sign/document/gfhr4222-a331-494b-808b-79bc7f3992a3/f14d7098-a331-494b-808b-79bc7f3992a4 +
+ + + +
Type:
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +

signer_decision :object

@@ -341,13 +419,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SignRequestSignerInput.html b/docs/jsdoc/SignRequestSignerInput.html index 56313093..6b838feb 100644 --- a/docs/jsdoc/SignRequestSignerInput.html +++ b/docs/jsdoc/SignRequestSignerInput.html @@ -387,13 +387,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SignRequests.html b/docs/jsdoc/SignRequests.html index 16c22f7f..3b0d9b46 100644 --- a/docs/jsdoc/SignRequests.html +++ b/docs/jsdoc/SignRequests.html @@ -108,6 +108,78 @@

Members

+

entries :Array

+ + + + +
+ A list of sign requests +
+ + + +
Type:
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +

limit :number

@@ -345,13 +417,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SignRequestsManager.html b/docs/jsdoc/SignRequestsManager.html index a6c0d99e..f284e9f4 100644 --- a/docs/jsdoc/SignRequestsManager.html +++ b/docs/jsdoc/SignRequestsManager.html @@ -2811,13 +2811,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SignRequestsManager_SignRequestsManager.html b/docs/jsdoc/SignRequestsManager_SignRequestsManager.html index c8c9f19f..d42a891e 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 Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SignTemplate.html b/docs/jsdoc/SignTemplate.html new file mode 100644 index 00000000..568b86bb --- /dev/null +++ b/docs/jsdoc/SignTemplate.html @@ -0,0 +1,1374 @@ + + + + + JSDoc: Interface: SignTemplate + + + + + + + + + + +
+ +

Interface: SignTemplate

+ + + + + + +
+ +
+ +

SignTemplate

+ + +
+ +
+
+ + +
Box Sign template + +A Box Sign template object
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + +
+ + + + + + + + + + + + + + +

Members

+ + + +

additional_info :object

+ + + + +
+ Additional information on which fields are required and which fields are not editable. +
+ + + +
Type:
+
    +
  • + +object + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

are_email_settings_locked :boolean

+ + + + +
+ Indicates if the template email settings are editable or not. +Example: true +
+ + + +
Type:
+
    +
  • + +boolean + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

are_fields_locked :boolean

+ + + + +
+ Indicates if the template input fields are editable or not. +
+ + + +
Type:
+
    +
  • + +boolean + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

are_files_locked :boolean

+ + + + +
+ Indicates if the template files are editable or not. This includes deleting or renaming template files. +Example: true +
+ + + +
Type:
+
    +
  • + +boolean + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

are_options_locked :boolean

+ + + + +
+ Indicates if the template document options are editable or not, for example renaming the document. +Example: true +
+ + + +
Type:
+
    +
  • + +boolean + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

are_recipients_locked :boolean

+ + + + +
+ Indicates if the template signers are editable or not. +
+ + + +
Type:
+
    +
  • + +boolean + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

custom_branding :object

+ + + + +
+ Custom branding applied to notifications +and signature requests. +
+ + + +
Type:
+
    +
  • + +object + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

days_valid :number

+ + + + +
+ Set the number of days after which the created signature request will automatically expire if not completed. By default, we do not apply any expiration date on signature requests, and the signature request does not expire. +Example: 2 +
+ + + +
Type:
+
    +
  • + +number + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

email_message :string

+ + + + +
+ Message to include in signature request email. The field is cleaned through sanitization of specific characters. However, some html tags are allowed. Links included in the message are also converted to hyperlinks in the email. The message may contain the following html tags including `a`, `abbr`, `acronym`, `b`, `blockquote`, `code`, `em`, `i`, `ul`, `li`, `ol`, and `strong`. Be aware that when the text to html ratio is too high, the email may end up in spam filters. Custom styles on these tags are not allowed. If this field is not passed, a default message will be used. +Example: Hello! Please sign the document below +
+ + + +
Type:
+
    +
  • + +string + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

email_subject :string

+ + + + +
+ Subject of signature request email. This is cleaned by sign request. If this field is not passed, a default subject will be used. +Example: Sign Request from Acme +
+ + + +
Type:
+
    +
  • + +string + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

id :string

+ + + + +
+ Template identifier. +Example: 4206996024-14944f75-c34b-478a-95a1-264b1ff80d35 +
+ + + +
Type:
+
    +
  • + +string + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

name :string

+ + + + +
+ The name of the template. +Example: Official contract +
+ + + +
Type:
+
    +
  • + +string + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

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. +
+ + + +
Type:
+
    +
  • + +schemas.FolderMini + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + +
+ Box's ready-sign link feature enables you to create a link to a signature request that you've created from a template. Use this link when you want to post a signature request on a public form — such as an email, social media post, or web page — without knowing who the signers will be. Note: The ready-sign link feature is limited to Enterprise Plus customers and not available to Box Verified Enterprises. +
+ + + +
Type:
+
    +
  • + +object + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

signers :Array

+ + + + +
+ Array of signers for the template. +
+ + + +
Type:
+
    +
  • + +Array + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

source_files :Array

+ + + + +
+ List of files to create a signing document from. Only the ID and type fields are required for each file. +
+ + + +
Type:
+
    +
  • + +Array + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

type :'sign-template'

+ + + + +
+ object type +Example: sign-template +
+ + + +
Type:
+
    +
  • + +'sign-template' + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time) +
+ + + + + \ No newline at end of file diff --git a/docs/jsdoc/SignTemplates.html b/docs/jsdoc/SignTemplates.html new file mode 100644 index 00000000..3c483c0f --- /dev/null +++ b/docs/jsdoc/SignTemplates.html @@ -0,0 +1,284 @@ + + + + + JSDoc: Interface: SignTemplates + + + + + + + + + + +
+ +

Interface: SignTemplates

+ + + + + + +
+ +
+ +

SignTemplates

+ + +
+ +
+
+ + +
Box Sign templates + +The part of an API response that describes marker +based pagination
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + +
+ + + + + + + + + + + + + + +

Members

+ + + +

entries :Array

+ + + + +
+ A list of templates. +
+ + + +
Type:
+
    +
  • + +Array + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

prev_marker :string

+ + + + +
+ The marker for the start of the previous page of results. +Example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii +
+ + + +
Type:
+
    +
  • + +string + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time) +
+ + + + + \ No newline at end of file diff --git a/docs/jsdoc/SignTemplatesManager.html b/docs/jsdoc/SignTemplatesManager.html new file mode 100644 index 00000000..aef269ac --- /dev/null +++ b/docs/jsdoc/SignTemplatesManager.html @@ -0,0 +1,1336 @@ + + + + + JSDoc: Class: SignTemplatesManager + + + + + + + + + + +
+ +

Class: SignTemplatesManager

+ + + + + + +
+ +
+ +

SignTemplatesManager(client)

+ +
Simple manager for interacting with all Sign Templates endpoints and actions.
+ + +
+ +
+
+ + + + +

Constructor

+ + + +

new SignTemplatesManager(client)

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

Classes

+ +
+
SignTemplatesManager
+
+
+ + + + + + + + + + + +

Methods

+ + + + + + + +

getAll(optionsopt, callbackopt) → {Promise.<schemas.SignTemplates>}

+ + + + + + +
+ List Box Sign templates + +Gets Box Sign templates created by a user. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +object + + + + + + <optional>
+ + + + + +
Options for the request +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
marker + + +string + + + + + + <optional>
+ + + + + +
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`.
limit + + +number + + + + + + <optional>
+ + + + + +
The maximum number of items to return per page.
+ +
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.SignTemplates> + + +
+
+ + + + + + + + + + + + + +

getAll(optionsopt, callbackopt) → {Promise.<schemas.SignTemplates>}

+ + + + + + +
+ List Box Sign templates + +Gets Box Sign templates created by a user. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +object + + + + + + <optional>
+ + + + + +
Options for the request +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
marker + + +string + + + + + + <optional>
+ + + + + +
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`.
limit + + +number + + + + + + <optional>
+ + + + + +
The maximum number of items to return per page.
+ +
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.SignTemplates> + + +
+
+ + + + + + + + + + + + + +

getById(options, callbackopt) → {Promise.<schemas.SignTemplate>}

+ + + + + + +
+ Get Box Sign template by ID + +Fetches details of a specific Box Sign template. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +object + + + + + + + + + + Options for the request +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
template_id + + +string + + + + The ID of a Box Sign template.
+ +
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.SignTemplate> + + +
+
+ + + + + + + + + + + + + +

getById(options, callbackopt) → {Promise.<schemas.SignTemplate>}

+ + + + + + +
+ Get Box Sign template by ID + +Fetches details of a specific Box Sign template. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +object + + + + + + + + + + Options for the request +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
template_id + + +string + + + + The ID of a Box Sign template.
+ +
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.SignTemplate> + + +
+
+ + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time) +
+ + + + + \ No newline at end of file diff --git a/docs/jsdoc/SignTemplatesManager_SignTemplatesManager.html b/docs/jsdoc/SignTemplatesManager_SignTemplatesManager.html new file mode 100644 index 00000000..9e04ec8d --- /dev/null +++ b/docs/jsdoc/SignTemplatesManager_SignTemplatesManager.html @@ -0,0 +1,216 @@ + + + + + JSDoc: Class: SignTemplatesManager + + + + + + + + + + +
+ +

Class: SignTemplatesManager

+ + + + + + +
+ +
+ +

+ SignTemplatesManager#SignTemplatesManager(client)

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

new SignTemplatesManager(client)

+ + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
client + + +BoxClient + + + + The Box API Client that is responsible for making calls to the API
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time) +
+ + + + + \ No newline at end of file diff --git a/docs/jsdoc/StoragePolicies.html b/docs/jsdoc/StoragePolicies.html index 2942c383..3aa17719 100644 --- a/docs/jsdoc/StoragePolicies.html +++ b/docs/jsdoc/StoragePolicies.html @@ -4162,13 +4162,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Tasks.html b/docs/jsdoc/Tasks.html index 439182ce..9b9d6458 100644 --- a/docs/jsdoc/Tasks.html +++ b/docs/jsdoc/Tasks.html @@ -5478,13 +5478,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/TemplateSigner.html b/docs/jsdoc/TemplateSigner.html new file mode 100644 index 00000000..2109bde8 --- /dev/null +++ b/docs/jsdoc/TemplateSigner.html @@ -0,0 +1,447 @@ + + + + + JSDoc: Interface: TemplateSigner + + + + + + + + + + +
+ +

Interface: TemplateSigner

+ + + + + + +
+ +
+ +

TemplateSigner

+ + +
+ +
+
+ + +
Signer fields for Templates + +The schema for a Signer for Templates
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + +
+ + + + + + + + + + + + + + +

Members

+ + + +

email :string

+ + + + +
+ Email address of the signer +Example: example@mail.com +
+ + + +
Type:
+
    +
  • + +string + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

is_in_person :boolean

+ + + + +
+ Used in combination with an embed URL for a sender. +After the sender signs, they will be +redirected to the next `in_person` signer. +Example: true +
+ + + +
Type:
+
    +
  • + +boolean + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

order :number

+ + + + +
+ Order of the signer +Example: 2 +
+ + + +
Type:
+
    +
  • + +number + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

role :'signer'|'approver'|'final_copy_reader'

+ + + + +
+ Defines the role of the signer in the signature request. A role of +`signer` needs to sign the document, a role `approver` +approves the document and +a `final_copy_reader` role only +receives the final signed document and signing log. +Example: signer +
+ + + +
Type:
+
    +
  • + +'signer' +| + +'approver' +| + +'final_copy_reader' + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
Default Value:
+
    +
  • signer
  • +
+ + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time) +
+ + + + + \ No newline at end of file diff --git a/docs/jsdoc/TemplateSignerInput.html b/docs/jsdoc/TemplateSignerInput.html new file mode 100644 index 00000000..ce616f45 --- /dev/null +++ b/docs/jsdoc/TemplateSignerInput.html @@ -0,0 +1,850 @@ + + + + + JSDoc: Interface: TemplateSignerInput + + + + + + + + + + +
+ +

Interface: TemplateSignerInput

+ + + + + + +
+ +
+ +

TemplateSignerInput

+ + +
+ +
+
+ + +
Template Signer Input + +Input created by a Signer on a Template
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + +
+ + + + + + + + + + + + + + +

Members

+ + + +

content_type :'signature'|'initial'|'stamp'|'date'|'checkbox'|'text'|'full_name'|'first_name'|'last_name'|'company'|'title'|'email'|'attachment'|'radio'|'dropdown'

+ + + + +
+ Content type of input +Example: text +
+ + + +
Type:
+
    +
  • + +'signature' +| + +'initial' +| + +'stamp' +| + +'date' +| + +'checkbox' +| + +'text' +| + +'full_name' +| + +'first_name' +| + +'last_name' +| + +'company' +| + +'title' +| + +'email' +| + +'attachment' +| + +'radio' +| + +'dropdown' + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

coordinates :object

+ + + + +
+ Where the input is located on a page. +
+ + + +
Type:
+
    +
  • + +object + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

dimensions :object

+ + + + +
+ The size of the input. +
+ + + +
Type:
+
    +
  • + +object + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

document_id :string

+ + + + +
+ Document identifier. +Example: 123075213-eb54b537-8b25-445e-87c1-5a1c67d8cbd7 +
+ + + +
Type:
+
    +
  • + +string + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + +
+ When the input is of the type `dropdown` this values will be filled with all the dropdown options. +Example: Yes,No,Maybe +
+ + + +
Type:
+
    +
  • + +Array + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

group_id :string

+ + + + +
+ When the input is of type `radio` they can be grouped to gather with this identifier. +Example: da317330-225a-4c72-89ad-0d6dcaaf4df6 +
+ + + +
Type:
+
    +
  • + +string + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

is_required :boolean

+ + + + +
+ Whether or not the input is required. +Example: true +
+ + + +
Type:
+
    +
  • + +boolean + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

page_index :number

+ + + + +
+ Index of page that the input is on. +Example: 4 +
+ + + +
Type:
+
    +
  • + +number + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

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

+ + + + +
+ Type of input +Example: text +
+ + + +
Type:
+
    +
  • + +'signature' +| + +'date' +| + +'text' +| + +'checkbox' +| + +'radio' +| + +'dropdown' + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time) +
+ + + + + \ No newline at end of file diff --git a/docs/jsdoc/TermsOfService.html b/docs/jsdoc/TermsOfService.html index e3b175a3..12979afd 100644 --- a/docs/jsdoc/TermsOfService.html +++ b/docs/jsdoc/TermsOfService.html @@ -5140,13 +5140,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/TokenManager.html b/docs/jsdoc/TokenManager.html index c635a9bd..96526954 100644 --- a/docs/jsdoc/TokenManager.html +++ b/docs/jsdoc/TokenManager.html @@ -4175,13 +4175,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Trash.html b/docs/jsdoc/Trash.html index 4845d120..25b4a30b 100644 --- a/docs/jsdoc/Trash.html +++ b/docs/jsdoc/Trash.html @@ -762,13 +762,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/UserBase.html b/docs/jsdoc/UserBase.html index c519e111..f203cbda 100644 --- a/docs/jsdoc/UserBase.html +++ b/docs/jsdoc/UserBase.html @@ -236,7 +236,7 @@
Type:
Source:
@@ -270,13 +270,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/UserIntegrationMappings.html b/docs/jsdoc/UserIntegrationMappings.html index dc624863..eced3d04 100644 --- a/docs/jsdoc/UserIntegrationMappings.html +++ b/docs/jsdoc/UserIntegrationMappings.html @@ -270,13 +270,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Users.html b/docs/jsdoc/Users.html index e914f357..ea704bca 100644 --- a/docs/jsdoc/Users.html +++ b/docs/jsdoc/Users.html @@ -5954,13 +5954,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/WebLinks.html b/docs/jsdoc/WebLinks.html index eaa13903..9295ec9b 100644 --- a/docs/jsdoc/WebLinks.html +++ b/docs/jsdoc/WebLinks.html @@ -4574,13 +4574,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Webhooks.html b/docs/jsdoc/Webhooks.html index af193383..94aa0fc0 100644 --- a/docs/jsdoc/Webhooks.html +++ b/docs/jsdoc/Webhooks.html @@ -4580,13 +4580,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:51 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:06 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/api-request-manager.ts.html b/docs/jsdoc/api-request-manager.ts.html index fc516e12..15c1a73f 100644 --- a/docs/jsdoc/api-request-manager.ts.html +++ b/docs/jsdoc/api-request-manager.ts.html @@ -136,13 +136,13 @@

Source: api-request-manager.ts


- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/api-request.ts.html b/docs/jsdoc/api-request.ts.html index 0199912d..f7fb34b3 100644 --- a/docs/jsdoc/api-request.ts.html +++ b/docs/jsdoc/api-request.ts.html @@ -461,13 +461,13 @@

Source: api-request.ts


- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/box-client.ts.html b/docs/jsdoc/box-client.ts.html index ca143c49..bc90607c 100644 --- a/docs/jsdoc/box-client.ts.html +++ b/docs/jsdoc/box-client.ts.html @@ -51,6 +51,7 @@

Source: box-client.ts

import Search from './managers/search'; import SharedItems from './managers/shared-items'; import SignRequests from './managers/sign-requests.generated'; +import SignTemplates from './managers/sign-templates.generated'; import StoragePolicies from './managers/storage-policies'; import Tasks from './managers/tasks'; import TermsOfService from './managers/terms-of-service'; @@ -228,6 +229,7 @@

Source: box-client.ts

termsOfService: any; storagePolicies: any; signRequests: SignRequests; + signTemplates: SignTemplates; shieldInformationBarriers: ShieldInformationBarriers; shieldInformationBarrierSegments: ShieldInformationBarrierSegments; shieldInformationBarrierSegmentMembers: ShieldInformationBarrierSegmentMembers; @@ -302,6 +304,7 @@

Source: box-client.ts

this.termsOfService = new TermsOfService(this); this.storagePolicies = new StoragePolicies(this); this.signRequests = new SignRequests(this); + this.signTemplates = new SignTemplates(this); this.shieldInformationBarriers = new ShieldInformationBarriers(this); this.shieldInformationBarrierSegments = new ShieldInformationBarrierSegments(this); this.shieldInformationBarrierSegmentMembers = new ShieldInformationBarrierSegmentMembers(this); @@ -822,13 +825,13 @@

Source: box-client.ts


- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/box-node-sdk.ts.html b/docs/jsdoc/box-node-sdk.ts.html index fe648b62..bf44a79a 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/chunked-uploader.ts.html b/docs/jsdoc/chunked-uploader.ts.html index 74ba1238..176a91d8 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/enterprise-event-stream.ts.html b/docs/jsdoc/enterprise-event-stream.ts.html index 147a3836..c61a878a 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/event-stream.ts.html b/docs/jsdoc/event-stream.ts.html index deb84cb6..3276f980 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/global.html b/docs/jsdoc/global.html index fa075be6..e87ec090 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/index.html b/docs/jsdoc/index.html index 136ba63a..6602a075 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_collaboration-allowlist.ts.html b/docs/jsdoc/managers_collaboration-allowlist.ts.html index 761a40fa..9067454f 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_collaborations.ts.html b/docs/jsdoc/managers_collaborations.ts.html index 83662987..af44ed3a 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_collections.ts.html b/docs/jsdoc/managers_collections.ts.html index 4150b8ae..7cd0b4cc 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_comments.ts.html b/docs/jsdoc/managers_comments.ts.html index 0cb88a18..a02c41dc 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_device-pins.ts.html b/docs/jsdoc/managers_device-pins.ts.html index 63270963..01eacf9c 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_enterprise.ts.html b/docs/jsdoc/managers_enterprise.ts.html index 51af56ee..58590af2 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_events.ts.html b/docs/jsdoc/managers_events.ts.html index 5e69f0de..f9933b27 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 4f40f726..ac45df7f 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_files.ts.html b/docs/jsdoc/managers_files.ts.html index e7cae533..249a35e5 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_folders.ts.html b/docs/jsdoc/managers_folders.ts.html index 4660c51b..651083b7 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_groups.ts.html b/docs/jsdoc/managers_groups.ts.html index b60440f7..755639e9 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_integration-mappings.ts.html b/docs/jsdoc/managers_integration-mappings.ts.html index 2e361df6..0d43efd9 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 cc2fc436..756610f9 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_metadata.ts.html b/docs/jsdoc/managers_metadata.ts.html index ad3424f6..f20cd9c5 100644 --- a/docs/jsdoc/managers_metadata.ts.html +++ b/docs/jsdoc/managers_metadata.ts.html @@ -485,13 +485,13 @@

Source: managers/metadata.ts


- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_recent-items.ts.html b/docs/jsdoc/managers_recent-items.ts.html index ab007042..1575a90e 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_retention-policies.ts.html b/docs/jsdoc/managers_retention-policies.ts.html index 907a403f..7093fdbc 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_search.ts.html b/docs/jsdoc/managers_search.ts.html index b3766e2f..2ac8fa63 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_shared-items.ts.html b/docs/jsdoc/managers_shared-items.ts.html index b54b0e8a..06caf568 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 57b1ad17..f7132616 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 ec420251..d0a5dd26 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 09570011..2c8d3918 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 54162517..83cee015 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 04923378..e539212d 100644 --- a/docs/jsdoc/managers_shield-information-barriers.generated.ts.html +++ b/docs/jsdoc/managers_shield-information-barriers.generated.ts.html @@ -178,13 +178,13 @@

Source: managers/shield-information-barriers.generated.ts
- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 6bcf3653..2ded5840 100644 --- a/docs/jsdoc/managers_sign-requests.generated.ts.html +++ b/docs/jsdoc/managers_sign-requests.generated.ts.html @@ -204,13 +204,13 @@

Source: managers/sign-requests.generated.ts


- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 new file mode 100644 index 00000000..a839e59b --- /dev/null +++ b/docs/jsdoc/managers_sign-templates.generated.ts.html @@ -0,0 +1,133 @@ + + + + + JSDoc: Source: managers/sign-templates.generated.ts + + + + + + + + + + +
+ +

Source: managers/sign-templates.generated.ts

+ + + + + + +
+
+
import BoxClient from '../box-client';
+import urlPath from '../util/url-path';
+import * as schemas from '../schemas';
+/**
+ * Simple manager for interacting with all Sign Templates endpoints and actions.
+ */
+class SignTemplatesManager {
+	client: BoxClient;
+	/**
+	 * @param {BoxClient} client The Box API Client that is responsible for making calls to the API
+	 */
+	constructor(client: BoxClient) {
+		this.client = client;
+	}
+	/**
+	 * Get Box Sign template by ID
+	 *
+	 * Fetches details of a specific Box Sign template.
+	 * @param {object} options Options for the request
+	 * @param {string} options.template_id The ID of a Box Sign template.
+	 * @param {Function} [callback] Passed the result if successful, error otherwise
+	 * @returns {Promise<schemas.SignTemplate>} A promise resolving to the result or rejecting with an error
+	 */
+	getById(
+		options: {
+			/**
+			 * The ID of a Box Sign template.
+			 */
+			readonly template_id: string;
+		},
+		callback?: Function
+	): Promise<schemas.SignTemplate> {
+		const { template_id: templateId, ...queryParams } = options,
+			apiPath = urlPath('sign_templates', templateId),
+			params = {
+				qs: queryParams,
+			};
+		return this.client.wrapWithDefaultHandler(this.client.get)(
+			apiPath,
+			params,
+			callback
+		);
+	}
+	/**
+	 * List Box Sign templates
+	 *
+	 * Gets Box Sign templates created by a user.
+	 * @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.
+	 * @param {Function} [callback] Passed the result if successful, error otherwise
+	 * @returns {Promise<schemas.SignTemplates>} A promise resolving to the result or rejecting with an error
+	 */
+	getAll(
+		options?: {
+			/**
+			 * 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`.
+			 */
+			readonly marker?: string;
+			/**
+			 * The maximum number of items to return per page.
+			 */
+			readonly limit?: number;
+		},
+		callback?: Function
+	): Promise<schemas.SignTemplates> {
+		const { ...queryParams } = options,
+			apiPath = urlPath('sign_templates'),
+			params = {
+				qs: queryParams,
+			};
+		return this.client.wrapWithDefaultHandler(this.client.get)(
+			apiPath,
+			params,
+			callback
+		);
+	}
+}
+export = SignTemplatesManager;
+
+
+
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time) +
+ + + + + diff --git a/docs/jsdoc/managers_storage-policies.ts.html b/docs/jsdoc/managers_storage-policies.ts.html index d4f8b12f..19d26526 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_tasks.ts.html b/docs/jsdoc/managers_tasks.ts.html index cc8bcfba..eaf557fa 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 c91bf080..b122f9fa 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_trash.ts.html b/docs/jsdoc/managers_trash.ts.html index 3f55f813..aab93d2b 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_users.ts.html b/docs/jsdoc/managers_users.ts.html index da26c3d5..cfbf2549 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_web-links.ts.html b/docs/jsdoc/managers_web-links.ts.html index 81faecc1..fd03d6cc 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_webhooks.ts.html b/docs/jsdoc/managers_webhooks.ts.html index 769e87b7..6dfd5de3 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 70c948ed..b49d4120 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 80fb05fa..a4500506 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 be6764f3..7a824062 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 af88aeb0..3558e6d9 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 73dca717..39532c29 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 98f34ee4..5139c5bc 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 48311483..7bab615f 100644 --- a/docs/jsdoc/schemas_folder-mini.generated.ts.html +++ b/docs/jsdoc/schemas_folder-mini.generated.ts.html @@ -34,6 +34,11 @@

Source: schemas/folder-mini.generated.ts

* nested under another resource. */ export interface FolderMini extends schemas.FolderBase { + /** + * The name of the folder. + * Example: Contracts + */ + name?: string; /** * A numeric identifier that represents the most recent user event * that has been applied to this item. @@ -51,11 +56,6 @@

Source: schemas/folder-mini.generated.ts

* Example: 3 */ sequence_id?: string; - /** - * The name of the folder. - * Example: Contracts - */ - name?: string; } @@ -67,13 +67,13 @@

Source: schemas/folder-mini.generated.ts


- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 7b9f09ec..9ee5041b 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 7df8db61..3be937f7 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 0ed62380..3c07c44e 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 116a9c62..e4f0244b 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 3a560048..99dfd930 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_integration-mapping.ts.html b/docs/jsdoc/schemas_integration-mapping.ts.html index b78652da..78b43780 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_integration-mappings.ts.html b/docs/jsdoc/schemas_integration-mappings.ts.html index d5d6e2d6..95846d9c 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 d6fde706..35f9788c 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 f20b1372..c1e0b03a 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 d904758a..1e293a83 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 9787108e..7ea07667 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 fa2ccdda..7080a7ea 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 b0b75b44..e4892631 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 6ae7bf31..74a1b8df 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 e6daf5ec..598d1a2a 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 7a6d4d7a..a8e35a28 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 e009db3c..521ae810 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 de555e05..7feacab1 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 6f321ff2..c31e1d6f 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 cb7a7c48..3bda50d9 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 e52cf45a..6cdde1fa 100644 --- a/docs/jsdoc/schemas_sign-request-base.generated.ts.html +++ b/docs/jsdoc/schemas_sign-request-base.generated.ts.html @@ -28,7 +28,7 @@

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

import * as schemas from '.';
 /**
- * Create a sign request
+ * Sign Request (Base)
  *
  * A request to create a sign request object
  */
@@ -85,7 +85,7 @@ 

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

*/ prefill_tags?: schemas.SignRequestPrefillTag[]; /** - * Number of days after which this request will automatically expire if not completed. + * Set the number of days after which the created signature request will automatically expire if not completed. By default, we do not apply any expiration date on signature requests, and the signature request does not expire. * Example: 2 */ days_valid?: number; @@ -99,6 +99,11 @@

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

* Example: true */ is_phone_verification_required_to_view?: boolean; + /** + * When a signature request is created from a template this field will indicate the id of that template. + * Example: 123075213-af2c8822-3ef2-4952-8557-52d69c2fe9cb + */ + template_id?: string; }
@@ -110,13 +115,13 @@

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


- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 43b3b2b2..49fbb63a 100644 --- a/docs/jsdoc/schemas_sign-request-create-request.generated.ts.html +++ b/docs/jsdoc/schemas_sign-request-create-request.generated.ts.html @@ -34,17 +34,9 @@

Source: schemas/sign-request-create-request.generated.ts< */ export interface SignRequestCreateRequest extends schemas.SignRequestBase { /** - * List of files to create a signing document from. This is currently - * limited to 10 files. Only the ID and type fields are required - * for each file. The array will be empty if the `source_files` - * are deleted. + * List of files to create a signing document from. This is currently limited to ten files. Only the ID and type fields are required for each file. */ - source_files?: schemas.FileMini[]; - /** - * Force a specific signature color (blue, black, or red). - * Example: blue - */ - signature_color?: 'blue' | 'black' | 'red'; + source_files?: schemas.FileBase[]; /** * Array of signers for the sign request. 35 is the * max number of signers permitted. @@ -61,13 +53,13 @@

Source: schemas/sign-request-create-request.generated.ts<
- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 83183ac1..5f05b870 100644 --- a/docs/jsdoc/schemas_sign-request-create-signer.generated.ts.html +++ b/docs/jsdoc/schemas_sign-request-create-signer.generated.ts.html @@ -113,13 +113,13 @@

Source: schemas/sign-request-create-signer.generated.ts
- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 caccdeed..eb9823e5 100644 --- a/docs/jsdoc/schemas_sign-request-prefill-tag.generated.ts.html +++ b/docs/jsdoc/schemas_sign-request-prefill-tag.generated.ts.html @@ -65,13 +65,13 @@

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


- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 12cd67dc..8091ccef 100644 --- a/docs/jsdoc/schemas_sign-request-signer-input.generated.ts.html +++ b/docs/jsdoc/schemas_sign-request-signer-input.generated.ts.html @@ -72,13 +72,13 @@

Source: schemas/sign-request-signer-input.generated.ts
- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 c2f53c5c..376bb559 100644 --- a/docs/jsdoc/schemas_sign-request-signer.generated.ts.html +++ b/docs/jsdoc/schemas_sign-request-signer.generated.ts.html @@ -48,6 +48,16 @@

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

* Example: https://example.com */ embed_url?: string; + /** + * This URL is specifically designed for + * signing documents within an HTML `iframe` tag. + * It will be returned in the response + * only if the `embed_url_external_user_id` + * parameter was passed in the + * `create 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; } @@ -59,13 +69,13 @@

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


- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 7182e04f..5331863a 100644 --- a/docs/jsdoc/schemas_sign-request.generated.ts.html +++ b/docs/jsdoc/schemas_sign-request.generated.ts.html @@ -38,6 +38,10 @@

Source: schemas/sign-request.generated.ts

* Example: sign-request */ type?: 'sign-request'; + /** + * List of files to create a signing document from. This is currently limited to ten files. Only the ID and type fields are required for each file. + */ + source_files?: schemas.FileBase[]; /** * Array of signers for the sign request */ @@ -78,7 +82,9 @@

Source: schemas/sign-request.generated.ts

| 'declined' | 'error_converting' | 'error_sending' - | 'expired'; + | 'expired' + | 'finalizing' + | 'error_finalizing'; /** * List of files that will be signed, which are copies of the original * source files. A new version of these files are created as signers sign @@ -90,10 +96,6 @@

Source: schemas/sign-request.generated.ts

* Example: 2021-04-26T08:12:13.982Z */ auto_expire_at?: string; - /** - * List of files to create a signing document from. Only the ID and type fields are required for each file. The array will be empty if the `source_files` are deleted. - */ - source_files?: schemas.FileMini[]; } @@ -105,13 +107,13 @@

Source: schemas/sign-request.generated.ts


- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 cb4e6028..6781d409 100644 --- a/docs/jsdoc/schemas_sign-requests.generated.ts.html +++ b/docs/jsdoc/schemas_sign-requests.generated.ts.html @@ -51,6 +51,9 @@

Source: schemas/sign-requests.generated.ts

* Example: 1000 */ prev_marker?: number; + /** + * A list of sign requests + */ entries?: schemas.SignRequest[]; } @@ -63,13 +66,13 @@

Source: schemas/sign-requests.generated.ts


- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 new file mode 100644 index 00000000..369c1490 --- /dev/null +++ b/docs/jsdoc/schemas_sign-template.generated.ts.html @@ -0,0 +1,139 @@ + + + + + JSDoc: Source: schemas/sign-template.generated.ts + + + + + + + + + + +
+ +

Source: schemas/sign-template.generated.ts

+ + + + + + +
+
+
import * as schemas from '.';
+/**
+ * Box Sign template
+ *
+ * A Box Sign template object
+ */
+export interface SignTemplate {
+	/**
+	 * object type
+	 * Example: sign-template
+	 */
+	type?: 'sign-template';
+	/**
+	 * Template identifier.
+	 * Example: 4206996024-14944f75-c34b-478a-95a1-264b1ff80d35
+	 */
+	id?: string;
+	/**
+	 * The name of the template.
+	 * Example: Official contract
+	 */
+	name?: string;
+	/**
+	 * Subject of signature request email. This is cleaned by sign request. If this field is not passed, a default subject will be used.
+	 * Example: Sign Request from Acme
+	 */
+	email_subject?: string;
+	/**
+	 * Message to include in signature request email. The field is cleaned through sanitization of specific characters. However, some html tags are allowed. Links included in the message are also converted to hyperlinks in the email. The message may contain the following html tags including `a`, `abbr`, `acronym`, `b`, `blockquote`, `code`, `em`, `i`, `ul`, `li`, `ol`, and `strong`. Be aware that when the text to html ratio is too high, the email may end up in spam filters. Custom styles on these tags are not allowed. If this field is not passed, a default message will be used.
+	 * Example: Hello! Please sign the document below
+	 */
+	email_message?: string;
+	/**
+	 * Set the number of days after which the created signature request will automatically expire if not completed. By default, we do not apply any expiration date on signature requests, and the signature request does not expire.
+	 * Example: 2
+	 */
+	days_valid?: number;
+	/**
+	 * 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;
+	/**
+	 * List of files to create a signing document from. Only the ID and type fields are required for each file.
+	 */
+	source_files?: schemas.FileMini[];
+	/**
+	 * Indicates if the template input fields are editable or not.
+	 */
+	are_fields_locked?: boolean;
+	/**
+	 * Indicates if the template document options are editable or not, for example renaming the document.
+	 * Example: true
+	 */
+	are_options_locked?: boolean;
+	/**
+	 * Indicates if the template signers are editable or not.
+	 */
+	are_recipients_locked?: boolean;
+	/**
+	 * Indicates if the template email settings are editable or not.
+	 * Example: true
+	 */
+	are_email_settings_locked?: boolean;
+	/**
+	 * Indicates if the template files are editable or not. This includes deleting or renaming template files.
+	 * Example: true
+	 */
+	are_files_locked?: boolean;
+	/**
+	 * Array of signers for the template.
+	 */
+	signers?: schemas.TemplateSigner[];
+	/**
+	 * Additional information on which fields are required and which fields are not editable.
+	 */
+	additional_info?: object;
+	/**
+	 * Box's ready-sign link feature enables you to create a link to a signature request that you've created from a template. Use this link when you want to post a signature request on a public form — such as an email, social media post, or web page — without knowing who the signers will be. Note: The ready-sign link feature is limited to Enterprise Plus customers and not available to Box Verified Enterprises.
+	 */
+	ready_sign_link?: object;
+	/**
+	 * Custom branding applied to notifications
+	 * and signature requests.
+	 */
+	custom_branding?: object;
+}
+
+
+
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 new file mode 100644 index 00000000..6f078eff --- /dev/null +++ b/docs/jsdoc/schemas_sign-templates.generated.ts.html @@ -0,0 +1,69 @@ + + + + + JSDoc: Source: schemas/sign-templates.generated.ts + + + + + + + + + + +
+ +

Source: schemas/sign-templates.generated.ts

+ + + + + + +
+
+
import * as schemas from '.';
+/**
+ * Box Sign templates
+ *
+ * The part of an API response that describes marker
+ * based pagination
+ */
+export interface SignTemplates {
+	/**
+	 * A list of templates.
+	 */
+	entries?: schemas.SignTemplate[];
+	/**
+	 * The marker for the start of the previous page of results.
+	 * Example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
+	 */
+	prev_marker?: string;
+}
+
+
+
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 new file mode 100644 index 00000000..7eb1254f --- /dev/null +++ b/docs/jsdoc/schemas_template-signer-input.generated.ts.html @@ -0,0 +1,117 @@ + + + + + JSDoc: Source: schemas/template-signer-input.generated.ts + + + + + + + + + + +
+ +

Source: schemas/template-signer-input.generated.ts

+ + + + + + +
+
+
import * as schemas from '.';
+/**
+ * Template Signer Input
+ *
+ * Input created by a Signer on a Template
+ */
+export interface TemplateSignerInput extends schemas.SignRequestPrefillTag {
+	/**
+	 * Type of input
+	 * Example: text
+	 */
+	type?: 'signature' | 'date' | 'text' | 'checkbox' | 'radio' | 'dropdown';
+	/**
+	 * Content type of input
+	 * Example: text
+	 */
+	content_type?:
+		| 'signature'
+		| 'initial'
+		| 'stamp'
+		| 'date'
+		| 'checkbox'
+		| 'text'
+		| 'full_name'
+		| 'first_name'
+		| 'last_name'
+		| 'company'
+		| 'title'
+		| 'email'
+		| 'attachment'
+		| 'radio'
+		| 'dropdown';
+	/**
+	 * Whether or not the input is required.
+	 * Example: true
+	 */
+	is_required?: boolean;
+	/**
+	 * Index of page that the input is on.
+	 * Example: 4
+	 */
+	page_index: number;
+	/**
+	 * Document identifier.
+	 * Example: 123075213-eb54b537-8b25-445e-87c1-5a1c67d8cbd7
+	 */
+	document_id?: string;
+	/**
+	 * When the input is of the type `dropdown` this values will be filled with all the dropdown options.
+	 * Example: Yes,No,Maybe
+	 */
+	dropdown_choices?: string[];
+	/**
+	 * When the input is of type `radio` they can be grouped to gather with this identifier.
+	 * Example: da317330-225a-4c72-89ad-0d6dcaaf4df6
+	 */
+	group_id?: string;
+	/**
+	 * Where the input is located on a page.
+	 */
+	coordinates?: object;
+	/**
+	 * The size of the input.
+	 */
+	dimensions?: object;
+}
+
+
+
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 new file mode 100644 index 00000000..6b0996d8 --- /dev/null +++ b/docs/jsdoc/schemas_template-signer.generated.ts.html @@ -0,0 +1,87 @@ + + + + + JSDoc: Source: schemas/template-signer.generated.ts + + + + + + + + + + +
+ +

Source: schemas/template-signer.generated.ts

+ + + + + + +
+
+
import * as schemas from '.';
+/**
+ * Signer fields for Templates
+ *
+ * The schema for a Signer for Templates
+ */
+export interface TemplateSigner {
+	inputs?: schemas.TemplateSignerInput[];
+	/**
+	 * Email address of the signer
+	 * Example: example@mail.com
+	 */
+	email?: string;
+	/**
+	 * Defines the role of the signer in the signature request. A role of
+	 * `signer` needs to sign the document, a role `approver`
+	 * approves the document and
+	 * a `final_copy_reader` role only
+	 * receives the final signed document and signing log.
+	 * Example: signer
+	 * @default signer
+	 */
+	role?: 'signer' | 'approver' | 'final_copy_reader';
+	/**
+	 * Used in combination with an embed URL for a sender.
+	 * After the sender signs, they will be
+	 * redirected to the next `in_person` signer.
+	 * Example: true
+	 */
+	is_in_person?: boolean;
+	/**
+	 * Order of the signer
+	 * Example: 2
+	 */
+	order?: number;
+}
+
+
+
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 ecab546e..80a2889e 100644 --- a/docs/jsdoc/schemas_user-base.generated.ts.html +++ b/docs/jsdoc/schemas_user-base.generated.ts.html @@ -38,7 +38,7 @@

Source: schemas/user-base.generated.ts

* The unique identifier for this user * Example: 11446498 */ - id?: string; + id: string; /** * `user` * Example: user @@ -55,13 +55,13 @@

Source: schemas/user-base.generated.ts


- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 7dca7d4a..1d65f7be 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 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 70d5c736..9fb14563 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/sessions_basic-session.ts.html b/docs/jsdoc/sessions_basic-session.ts.html index 723534c4..f3adb4d9 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/sessions_ccg-session.ts.html b/docs/jsdoc/sessions_ccg-session.ts.html index fa8ef774..4abf0a84 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/sessions_persistent-session.ts.html b/docs/jsdoc/sessions_persistent-session.ts.html index f0d9338e..ac7b8405 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/token-manager.ts.html b/docs/jsdoc/token-manager.ts.html index da7eebba..b6e71123 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/util_config.ts.html b/docs/jsdoc/util_config.ts.html index e25bd4a5..79a21938 100644 --- a/docs/jsdoc/util_config.ts.html +++ b/docs/jsdoc/util_config.ts.html @@ -338,13 +338,13 @@

Source: util/config.ts


- Documentation generated by JSDoc 3.6.11 on Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/util_errors.ts.html b/docs/jsdoc/util_errors.ts.html index a48aaa8a..e2f59a22 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/util_exponential-backoff.ts.html b/docs/jsdoc/util_exponential-backoff.ts.html index a1f6c55c..61e7082c 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/util_paging-iterator.ts.html b/docs/jsdoc/util_paging-iterator.ts.html index 717657af..0e6bc70c 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/util_url-path.ts.html b/docs/jsdoc/util_url-path.ts.html index 81d2a9c2..028c1ebb 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 Wed Jul 19 2023 02:23:50 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Thu Sep 07 2023 03:52:05 GMT-0700 (Pacific Daylight Time)
diff --git a/examples/app-auth/package.json b/examples/app-auth/package.json index b50b9f8e..5a327821 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.1.1", + "box-node-sdk": "^3.2.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 0297e44c..4071f875 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "box-node-sdk", - "version": "3.1.1", + "version": "3.2.0", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index dfde1b49..2440aea3 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "box-node-sdk", "author": "Box ", - "version": "3.1.1", + "version": "3.2.0", "description": "Official SDK for Box Plaform APIs", "license": "Apache-2.0", "repository": {