From 866844d171984ee1a708c82e7c6e6dfc0956d399 Mon Sep 17 00:00:00 2001 From: box-sdk-build Date: Mon, 19 Feb 2024 02:53:37 -0800 Subject: [PATCH] chore: release 3.5.0 --- CHANGELOG.md | 12 + docs/jsdoc/APIRequest.html | 4 +- docs/jsdoc/APIRequestManager.html | 4 +- docs/jsdoc/AppAuthSession.html | 4 +- docs/jsdoc/BasicSession.html | 4 +- docs/jsdoc/BoxClient.html | 4 +- docs/jsdoc/BoxSDKNode.html | 4 +- docs/jsdoc/CCGSession.html | 4 +- docs/jsdoc/Chunk_Chunk.html | 4 +- docs/jsdoc/ChunkedUploader.html | 4 +- .../ChunkedUploader_ChunkedUploader.html | 4 +- docs/jsdoc/CollaborationAllowlist.html | 4 +- docs/jsdoc/Collaborations.html | 4 +- docs/jsdoc/Collections.html | 4 +- docs/jsdoc/Comments.html | 4 +- docs/jsdoc/Config.html | 4 +- docs/jsdoc/DevicePins.html | 4 +- docs/jsdoc/Enterprise.html | 4 +- docs/jsdoc/EnterpriseBase.html | 4 +- docs/jsdoc/EnterpriseEventStream.html | 4 +- docs/jsdoc/EventStream.html | 4 +- docs/jsdoc/Events.html | 4 +- docs/jsdoc/FileBase.html | 4 +- docs/jsdoc/FileMini.html | 4 +- docs/jsdoc/FileVersionBase.html | 4 +- docs/jsdoc/FileVersionMini.html | 4 +- docs/jsdoc/Files.html | 4 +- docs/jsdoc/FolderBase.html | 4 +- docs/jsdoc/FolderMini.html | 8 +- docs/jsdoc/Folders.html | 4 +- docs/jsdoc/Groups.html | 4 +- docs/jsdoc/IntegrationMapping.html | 4 +- docs/jsdoc/IntegrationMappingBase.html | 4 +- .../jsdoc/IntegrationMappingBoxItemSlack.html | 4 +- .../IntegrationMappingPartnerItemSlack.html | 4 +- .../IntegrationMappingSlackCreateRequest.html | 4 +- .../jsdoc/IntegrationMappingSlackOptions.html | 4 +- docs/jsdoc/IntegrationMappings.html | 4 +- docs/jsdoc/IntegrationMappingsManager.html | 4 +- ...ngsManager_IntegrationMappingsManager.html | 4 +- docs/jsdoc/LegalHoldPolicies.html | 4 +- docs/jsdoc/Metadata.html | 4 +- docs/jsdoc/PagingIterator.html | 4 +- docs/jsdoc/PagingIterator_PagingIterator.html | 4 +- docs/jsdoc/PersistentSession.html | 4 +- docs/jsdoc/RecentItems.html | 4 +- docs/jsdoc/RetentionPolicies.html | 4 +- docs/jsdoc/Search.html | 4 +- docs/jsdoc/SharedItems.html | 4 +- docs/jsdoc/ShieldInformationBarrier.html | 4 +- docs/jsdoc/ShieldInformationBarrierBase.html | 4 +- .../ShieldInformationBarrierManager.html | 24 +- ...nager_ShieldInformationBarrierManager.html | 4 +- .../ShieldInformationBarrierReference.html | 4 +- .../jsdoc/ShieldInformationBarrierReport.html | 4 +- .../ShieldInformationBarrierReportBase.html | 4 +- ...ShieldInformationBarrierReportDetails.html | 4 +- .../ShieldInformationBarrierReports.html | 360 ++++++++++++++++++ ...hieldInformationBarrierReportsManager.html | 16 +- ...hieldInformationBarrierReportsManager.html | 4 +- .../ShieldInformationBarrierSegment.html | 4 +- ...ShieldInformationBarrierSegmentMember.html | 4 +- ...ldInformationBarrierSegmentMemberBase.html | 4 +- ...ldInformationBarrierSegmentMemberMini.html | 4 +- ...hieldInformationBarrierSegmentMembers.html | 360 ++++++++++++++++++ ...formationBarrierSegmentMembersManager.html | 12 +- ...formationBarrierSegmentMembersManager.html | 4 +- ...dInformationBarrierSegmentRestriction.html | 4 +- ...ormationBarrierSegmentRestrictionBase.html | 4 +- ...ormationBarrierSegmentRestrictionMini.html | 4 +- ...InformationBarrierSegmentRestrictions.html | 360 ++++++++++++++++++ ...tionBarrierSegmentRestrictionsManager.html | 12 +- ...tionBarrierSegmentRestrictionsManager.html | 4 +- .../ShieldInformationBarrierSegments.html | 360 ++++++++++++++++++ ...ieldInformationBarrierSegmentsManager.html | 12 +- ...ieldInformationBarrierSegmentsManager.html | 4 +- docs/jsdoc/ShieldInformationBarriers.html | 359 +++++++++++++++++ docs/jsdoc/SignRequest.html | 4 +- docs/jsdoc/SignRequestBase.html | 4 +- docs/jsdoc/SignRequestCreateRequest.html | 88 ++++- docs/jsdoc/SignRequestCreateSigner.html | 100 ++++- docs/jsdoc/SignRequestPrefillTag.html | 6 +- docs/jsdoc/SignRequestSigner.html | 4 +- docs/jsdoc/SignRequestSignerInput.html | 38 +- docs/jsdoc/SignRequests.html | 87 +---- docs/jsdoc/SignRequestsManager.html | 4 +- ...gnRequestsManager_SignRequestsManager.html | 4 +- docs/jsdoc/SignTemplate.html | 4 +- docs/jsdoc/SignTemplates.html | 156 +++++++- docs/jsdoc/SignTemplatesManager.html | 4 +- ...TemplatesManager_SignTemplatesManager.html | 4 +- docs/jsdoc/StoragePolicies.html | 4 +- docs/jsdoc/Tasks.html | 4 +- docs/jsdoc/TemplateSigner.html | 79 +++- docs/jsdoc/TemplateSignerInput.html | 82 +++- docs/jsdoc/TermsOfService.html | 4 +- docs/jsdoc/TokenManager.html | 4 +- docs/jsdoc/Trash.html | 4 +- docs/jsdoc/UserBase.html | 4 +- docs/jsdoc/UserIntegrationMappings.html | 4 +- docs/jsdoc/Users.html | 4 +- docs/jsdoc/WebLinks.html | 4 +- docs/jsdoc/Webhooks.html | 4 +- docs/jsdoc/api-request-manager.ts.html | 4 +- docs/jsdoc/api-request.ts.html | 4 +- docs/jsdoc/box-client.ts.html | 4 +- docs/jsdoc/box-node-sdk.ts.html | 4 +- docs/jsdoc/chunked-uploader.ts.html | 4 +- docs/jsdoc/enterprise-event-stream.ts.html | 4 +- docs/jsdoc/event-stream.ts.html | 4 +- docs/jsdoc/global.html | 4 +- docs/jsdoc/index.html | 4 +- .../managers_collaboration-allowlist.ts.html | 4 +- docs/jsdoc/managers_collaborations.ts.html | 4 +- docs/jsdoc/managers_collections.ts.html | 4 +- docs/jsdoc/managers_comments.ts.html | 4 +- docs/jsdoc/managers_device-pins.ts.html | 4 +- docs/jsdoc/managers_enterprise.ts.html | 4 +- docs/jsdoc/managers_events.ts.html | 4 +- .../managers_file-requests-manager.ts.html | 4 +- docs/jsdoc/managers_files.ts.html | 4 +- docs/jsdoc/managers_folders.ts.html | 4 +- docs/jsdoc/managers_groups.ts.html | 4 +- .../managers_integration-mappings.ts.html | 4 +- .../managers_legal-hold-policies.ts.html | 4 +- docs/jsdoc/managers_metadata.ts.html | 4 +- docs/jsdoc/managers_recent-items.ts.html | 4 +- .../jsdoc/managers_retention-policies.ts.html | 4 +- docs/jsdoc/managers_search.ts.html | 4 +- docs/jsdoc/managers_shared-items.ts.html | 4 +- ...ormation-barrier-reports.generated.ts.html | 10 +- ...-barrier-segment-members.generated.ts.html | 8 +- ...ier-segment-restrictions.generated.ts.html | 8 +- ...rmation-barrier-segments.generated.ts.html | 8 +- ...eld-information-barriers.generated.ts.html | 28 +- .../managers_sign-requests.generated.ts.html | 4 +- .../managers_sign-templates.generated.ts.html | 4 +- docs/jsdoc/managers_storage-policies.ts.html | 4 +- docs/jsdoc/managers_tasks.ts.html | 4 +- docs/jsdoc/managers_terms-of-service.ts.html | 4 +- docs/jsdoc/managers_trash.ts.html | 4 +- docs/jsdoc/managers_users.ts.html | 4 +- docs/jsdoc/managers_web-links.ts.html | 4 +- docs/jsdoc/managers_webhooks.ts.html | 4 +- .../schemas_enterprise-base.generated.ts.html | 4 +- .../jsdoc/schemas_file-base.generated.ts.html | 4 +- .../jsdoc/schemas_file-mini.generated.ts.html | 4 +- ...chemas_file-version-base.generated.ts.html | 4 +- ...chemas_file-version-mini.generated.ts.html | 4 +- .../schemas_folder-base.generated.ts.html | 4 +- .../schemas_folder-mini.generated.ts.html | 14 +- .../schemas_integration-mapping-base.ts.html | 4 +- ...integration-mapping-box-item-slack.ts.html | 4 +- ...gration-mapping-partner-item-slack.ts.html | 4 +- ...ation-mapping-slack-create-request.ts.html | 4 +- ..._integration-mapping-slack-options.ts.html | 4 +- .../jsdoc/schemas_integration-mapping.ts.html | 4 +- .../schemas_integration-mappings.ts.html | 4 +- ...information-barrier-base.generated.ts.html | 4 +- ...mation-barrier-reference.generated.ts.html | 4 +- ...tion-barrier-report-base.generated.ts.html | 4 +- ...n-barrier-report-details.generated.ts.html | 4 +- ...formation-barrier-report.generated.ts.html | 4 +- ...ormation-barrier-reports.generated.ts.html | 77 ++++ ...rier-segment-member-base.generated.ts.html | 4 +- ...rier-segment-member-mini.generated.ts.html | 4 +- ...n-barrier-segment-member.generated.ts.html | 4 +- ...-barrier-segment-members.generated.ts.html | 77 ++++ ...segment-restriction-base.generated.ts.html | 4 +- ...segment-restriction-mini.generated.ts.html | 4 +- ...rier-segment-restriction.generated.ts.html | 4 +- ...ier-segment-restrictions.generated.ts.html | 77 ++++ ...ormation-barrier-segment.generated.ts.html | 4 +- ...rmation-barrier-segments.generated.ts.html | 77 ++++ ...ield-information-barrier.generated.ts.html | 4 +- ...eld-information-barriers.generated.ts.html | 76 ++++ ...chemas_sign-request-base.generated.ts.html | 4 +- ...n-request-create-request.generated.ts.html | 12 +- ...gn-request-create-signer.generated.ts.html | 16 +- ...sign-request-prefill-tag.generated.ts.html | 6 +- ...ign-request-signer-input.generated.ts.html | 24 +- ...emas_sign-request-signer.generated.ts.html | 4 +- .../schemas_sign-request.generated.ts.html | 4 +- .../schemas_sign-requests.generated.ts.html | 15 +- .../schemas_sign-template.generated.ts.html | 4 +- .../schemas_sign-templates.generated.ts.html | 22 +- ...as_template-signer-input.generated.ts.html | 18 +- .../schemas_template-signer.generated.ts.html | 11 +- .../jsdoc/schemas_user-base.generated.ts.html | 4 +- .../schemas_user-integration-mappings.ts.html | 4 +- docs/jsdoc/sessions_app-auth-session.ts.html | 4 +- docs/jsdoc/sessions_basic-session.ts.html | 4 +- docs/jsdoc/sessions_ccg-session.ts.html | 4 +- .../jsdoc/sessions_persistent-session.ts.html | 4 +- docs/jsdoc/token-manager.ts.html | 4 +- docs/jsdoc/util_config.ts.html | 4 +- docs/jsdoc/util_errors.ts.html | 4 +- docs/jsdoc/util_exponential-backoff.ts.html | 4 +- docs/jsdoc/util_paging-iterator.ts.html | 4 +- docs/jsdoc/util_url-path.ts.html | 4 +- examples/app-auth/package.json | 2 +- package-lock.json | 2 +- package.json | 2 +- 203 files changed, 3199 insertions(+), 566 deletions(-) create mode 100644 docs/jsdoc/ShieldInformationBarrierReports.html create mode 100644 docs/jsdoc/ShieldInformationBarrierSegmentMembers.html create mode 100644 docs/jsdoc/ShieldInformationBarrierSegmentRestrictions.html create mode 100644 docs/jsdoc/ShieldInformationBarrierSegments.html create mode 100644 docs/jsdoc/ShieldInformationBarriers.html create mode 100644 docs/jsdoc/schemas_shield-information-barrier-reports.generated.ts.html create mode 100644 docs/jsdoc/schemas_shield-information-barrier-segment-members.generated.ts.html create mode 100644 docs/jsdoc/schemas_shield-information-barrier-segment-restrictions.generated.ts.html create mode 100644 docs/jsdoc/schemas_shield-information-barrier-segments.generated.ts.html create mode 100644 docs/jsdoc/schemas_shield-information-barriers.generated.ts.html diff --git a/CHANGELOG.md b/CHANGELOG.md index 4fd4646e..f40c0ed2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,18 @@ 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.5.0](https://github.com/box/box-node-sdk/compare/v3.4.2...v3.5.0) (2024-02-19) + + +### New Features and Enhancements + +* Sign request group ([#870](https://github.com/box/box-node-sdk/issues/870)) ([11bf5d2](https://github.com/box/box-node-sdk/commit/11bf5d2db7e0cefc669aab99c8b65c632289ac46)) + +### Bug Fixes + +* Bumped proxy-agent to 6.4.0 ([#874](https://github.com/box/box-node-sdk/issues/874)) ([55a8a0b](https://github.com/box/box-node-sdk/commit/55a8a0baebe151f4107fdbec0a1022e9534f88a4)) +* Remove delete classification ([#869](https://github.com/box/box-node-sdk/issues/869)) ([22384ab](https://github.com/box/box-node-sdk/commit/22384abc3abbc35800cbcdea7c7eb9a452cc4859)) + ### [3.4.2](https://github.com/box/box-node-sdk/compare/v3.4.1...v3.4.2) (2023-11-08) diff --git a/docs/jsdoc/APIRequest.html b/docs/jsdoc/APIRequest.html index f92f8ea2..65c503c0 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 70c6b35e..c7d935fc 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 4480d129..dc134c4c 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 67db49ee..181d42b2 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 2cfc7d81..c5d1a1de 100644 --- a/docs/jsdoc/BoxClient.html +++ b/docs/jsdoc/BoxClient.html @@ -4447,13 +4447,13 @@
Returns:

diff --git a/docs/jsdoc/BoxSDKNode.html b/docs/jsdoc/BoxSDKNode.html index 159bd86e..f27ecdd4 100644 --- a/docs/jsdoc/BoxSDKNode.html +++ b/docs/jsdoc/BoxSDKNode.html @@ -5909,13 +5909,13 @@
Returns:

diff --git a/docs/jsdoc/CCGSession.html b/docs/jsdoc/CCGSession.html index a7a24370..aa556998 100644 --- a/docs/jsdoc/CCGSession.html +++ b/docs/jsdoc/CCGSession.html @@ -1519,13 +1519,13 @@
Returns:

diff --git a/docs/jsdoc/Chunk_Chunk.html b/docs/jsdoc/Chunk_Chunk.html index 68742bfb..a050cf17 100644 --- a/docs/jsdoc/Chunk_Chunk.html +++ b/docs/jsdoc/Chunk_Chunk.html @@ -371,13 +371,13 @@
Properties

diff --git a/docs/jsdoc/ChunkedUploader.html b/docs/jsdoc/ChunkedUploader.html index 2d1617a9..4138a743 100644 --- a/docs/jsdoc/ChunkedUploader.html +++ b/docs/jsdoc/ChunkedUploader.html @@ -1514,13 +1514,13 @@
Returns:

diff --git a/docs/jsdoc/ChunkedUploader_ChunkedUploader.html b/docs/jsdoc/ChunkedUploader_ChunkedUploader.html index f6a4caf7..11addb2c 100644 --- a/docs/jsdoc/ChunkedUploader_ChunkedUploader.html +++ b/docs/jsdoc/ChunkedUploader_ChunkedUploader.html @@ -492,13 +492,13 @@
Properties

diff --git a/docs/jsdoc/CollaborationAllowlist.html b/docs/jsdoc/CollaborationAllowlist.html index 60b56e03..e63308eb 100644 --- a/docs/jsdoc/CollaborationAllowlist.html +++ b/docs/jsdoc/CollaborationAllowlist.html @@ -4164,13 +4164,13 @@
Returns:

diff --git a/docs/jsdoc/Collaborations.html b/docs/jsdoc/Collaborations.html index 421cedf8..c10f8c64 100644 --- a/docs/jsdoc/Collaborations.html +++ b/docs/jsdoc/Collaborations.html @@ -6048,13 +6048,13 @@
Returns:

diff --git a/docs/jsdoc/Collections.html b/docs/jsdoc/Collections.html index f598745f..f1ec5649 100644 --- a/docs/jsdoc/Collections.html +++ b/docs/jsdoc/Collections.html @@ -1050,13 +1050,13 @@
Returns:

diff --git a/docs/jsdoc/Comments.html b/docs/jsdoc/Comments.html index 844be283..f6f815a1 100644 --- a/docs/jsdoc/Comments.html +++ b/docs/jsdoc/Comments.html @@ -3472,13 +3472,13 @@
Returns:

diff --git a/docs/jsdoc/Config.html b/docs/jsdoc/Config.html index d14c9d8d..e51ed580 100644 --- a/docs/jsdoc/Config.html +++ b/docs/jsdoc/Config.html @@ -529,13 +529,13 @@
Returns:

diff --git a/docs/jsdoc/DevicePins.html b/docs/jsdoc/DevicePins.html index dba8023b..18fe4c60 100644 --- a/docs/jsdoc/DevicePins.html +++ b/docs/jsdoc/DevicePins.html @@ -1592,13 +1592,13 @@
Returns:

diff --git a/docs/jsdoc/Enterprise.html b/docs/jsdoc/Enterprise.html index adb19962..9671137a 100644 --- a/docs/jsdoc/Enterprise.html +++ b/docs/jsdoc/Enterprise.html @@ -4554,13 +4554,13 @@
Returns:

diff --git a/docs/jsdoc/EnterpriseBase.html b/docs/jsdoc/EnterpriseBase.html index 0af01486..01f1db01 100644 --- a/docs/jsdoc/EnterpriseBase.html +++ b/docs/jsdoc/EnterpriseBase.html @@ -270,13 +270,13 @@
Type:

diff --git a/docs/jsdoc/EnterpriseEventStream.html b/docs/jsdoc/EnterpriseEventStream.html index 47a07eb9..590e9d58 100644 --- a/docs/jsdoc/EnterpriseEventStream.html +++ b/docs/jsdoc/EnterpriseEventStream.html @@ -1266,13 +1266,13 @@
Returns:

diff --git a/docs/jsdoc/EventStream.html b/docs/jsdoc/EventStream.html index 3f69642a..70c7af13 100644 --- a/docs/jsdoc/EventStream.html +++ b/docs/jsdoc/EventStream.html @@ -546,13 +546,13 @@
Returns:

diff --git a/docs/jsdoc/Events.html b/docs/jsdoc/Events.html index 72a39d58..3b2355f7 100644 --- a/docs/jsdoc/Events.html +++ b/docs/jsdoc/Events.html @@ -3606,13 +3606,13 @@
Returns:

diff --git a/docs/jsdoc/FileBase.html b/docs/jsdoc/FileBase.html index dcec4421..8698f47c 100644 --- a/docs/jsdoc/FileBase.html +++ b/docs/jsdoc/FileBase.html @@ -352,13 +352,13 @@
Type:

diff --git a/docs/jsdoc/FileMini.html b/docs/jsdoc/FileMini.html index c89fafe3..46c27ca8 100644 --- a/docs/jsdoc/FileMini.html +++ b/docs/jsdoc/FileMini.html @@ -428,13 +428,13 @@
Type:

diff --git a/docs/jsdoc/FileVersionBase.html b/docs/jsdoc/FileVersionBase.html index 802f4db4..b539b6e1 100644 --- a/docs/jsdoc/FileVersionBase.html +++ b/docs/jsdoc/FileVersionBase.html @@ -271,13 +271,13 @@
Type:

diff --git a/docs/jsdoc/FileVersionMini.html b/docs/jsdoc/FileVersionMini.html index 64d50498..8e2bdf0b 100644 --- a/docs/jsdoc/FileVersionMini.html +++ b/docs/jsdoc/FileVersionMini.html @@ -197,13 +197,13 @@
Type:

diff --git a/docs/jsdoc/Files.html b/docs/jsdoc/Files.html index d2674ba9..86f152c3 100644 --- a/docs/jsdoc/Files.html +++ b/docs/jsdoc/Files.html @@ -27302,13 +27302,13 @@
Returns:

diff --git a/docs/jsdoc/FolderBase.html b/docs/jsdoc/FolderBase.html index e834e928..8a556827 100644 --- a/docs/jsdoc/FolderBase.html +++ b/docs/jsdoc/FolderBase.html @@ -352,13 +352,13 @@
Type:

diff --git a/docs/jsdoc/FolderMini.html b/docs/jsdoc/FolderMini.html index aa3b1339..de7e1050 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:

diff --git a/docs/jsdoc/Folders.html b/docs/jsdoc/Folders.html index bd859279..4651f2ec 100644 --- a/docs/jsdoc/Folders.html +++ b/docs/jsdoc/Folders.html @@ -13062,13 +13062,13 @@
Returns:

diff --git a/docs/jsdoc/Groups.html b/docs/jsdoc/Groups.html index f7cea7dc..ce7a43e9 100644 --- a/docs/jsdoc/Groups.html +++ b/docs/jsdoc/Groups.html @@ -6943,13 +6943,13 @@
Returns:

diff --git a/docs/jsdoc/IntegrationMapping.html b/docs/jsdoc/IntegrationMapping.html index 53b5dfd8..b2df130b 100644 --- a/docs/jsdoc/IntegrationMapping.html +++ b/docs/jsdoc/IntegrationMapping.html @@ -782,13 +782,13 @@
Type:

diff --git a/docs/jsdoc/IntegrationMappingBase.html b/docs/jsdoc/IntegrationMappingBase.html index 5b571236..307942e6 100644 --- a/docs/jsdoc/IntegrationMappingBase.html +++ b/docs/jsdoc/IntegrationMappingBase.html @@ -275,13 +275,13 @@
Type:

diff --git a/docs/jsdoc/IntegrationMappingBoxItemSlack.html b/docs/jsdoc/IntegrationMappingBoxItemSlack.html index 7d02f536..aaec2fa9 100644 --- a/docs/jsdoc/IntegrationMappingBoxItemSlack.html +++ b/docs/jsdoc/IntegrationMappingBoxItemSlack.html @@ -269,13 +269,13 @@
Type:

diff --git a/docs/jsdoc/IntegrationMappingPartnerItemSlack.html b/docs/jsdoc/IntegrationMappingPartnerItemSlack.html index 3ad2f102..0e2c6121 100644 --- a/docs/jsdoc/IntegrationMappingPartnerItemSlack.html +++ b/docs/jsdoc/IntegrationMappingPartnerItemSlack.html @@ -415,13 +415,13 @@
Type:

diff --git a/docs/jsdoc/IntegrationMappingSlackCreateRequest.html b/docs/jsdoc/IntegrationMappingSlackCreateRequest.html index 58010e09..1c508341 100644 --- a/docs/jsdoc/IntegrationMappingSlackCreateRequest.html +++ b/docs/jsdoc/IntegrationMappingSlackCreateRequest.html @@ -120,13 +120,13 @@

IntegrationMappingSlackCreateRequest


diff --git a/docs/jsdoc/IntegrationMappingSlackOptions.html b/docs/jsdoc/IntegrationMappingSlackOptions.html index 8a71652a..2a518519 100644 --- a/docs/jsdoc/IntegrationMappingSlackOptions.html +++ b/docs/jsdoc/IntegrationMappingSlackOptions.html @@ -200,13 +200,13 @@
Type:

diff --git a/docs/jsdoc/IntegrationMappings.html b/docs/jsdoc/IntegrationMappings.html index 500fd899..6b28edfa 100644 --- a/docs/jsdoc/IntegrationMappings.html +++ b/docs/jsdoc/IntegrationMappings.html @@ -345,13 +345,13 @@
Type:

diff --git a/docs/jsdoc/IntegrationMappingsManager.html b/docs/jsdoc/IntegrationMappingsManager.html index 2696b595..9571f1be 100644 --- a/docs/jsdoc/IntegrationMappingsManager.html +++ b/docs/jsdoc/IntegrationMappingsManager.html @@ -2719,13 +2719,13 @@
Returns:

diff --git a/docs/jsdoc/IntegrationMappingsManager_IntegrationMappingsManager.html b/docs/jsdoc/IntegrationMappingsManager_IntegrationMappingsManager.html index 26114d64..2a68f813 100644 --- a/docs/jsdoc/IntegrationMappingsManager_IntegrationMappingsManager.html +++ b/docs/jsdoc/IntegrationMappingsManager_IntegrationMappingsManager.html @@ -201,13 +201,13 @@
Parameters:

diff --git a/docs/jsdoc/LegalHoldPolicies.html b/docs/jsdoc/LegalHoldPolicies.html index e6304eb8..9b1e9aa0 100644 --- a/docs/jsdoc/LegalHoldPolicies.html +++ b/docs/jsdoc/LegalHoldPolicies.html @@ -6422,13 +6422,13 @@
Returns:

diff --git a/docs/jsdoc/Metadata.html b/docs/jsdoc/Metadata.html index 2a692e43..b5ecec61 100644 --- a/docs/jsdoc/Metadata.html +++ b/docs/jsdoc/Metadata.html @@ -6818,13 +6818,13 @@
Returns:

diff --git a/docs/jsdoc/PagingIterator.html b/docs/jsdoc/PagingIterator.html index 91f75b54..036a8358 100644 --- a/docs/jsdoc/PagingIterator.html +++ b/docs/jsdoc/PagingIterator.html @@ -1269,13 +1269,13 @@
Returns:

diff --git a/docs/jsdoc/PagingIterator_PagingIterator.html b/docs/jsdoc/PagingIterator_PagingIterator.html index bb7be088..a01be3b2 100644 --- a/docs/jsdoc/PagingIterator_PagingIterator.html +++ b/docs/jsdoc/PagingIterator_PagingIterator.html @@ -271,13 +271,13 @@
Returns:

diff --git a/docs/jsdoc/PersistentSession.html b/docs/jsdoc/PersistentSession.html index bb776f09..6fe17fe2 100644 --- a/docs/jsdoc/PersistentSession.html +++ b/docs/jsdoc/PersistentSession.html @@ -1929,13 +1929,13 @@
Returns:

diff --git a/docs/jsdoc/RecentItems.html b/docs/jsdoc/RecentItems.html index c89567db..84667e0f 100644 --- a/docs/jsdoc/RecentItems.html +++ b/docs/jsdoc/RecentItems.html @@ -894,13 +894,13 @@
Returns:

diff --git a/docs/jsdoc/RetentionPolicies.html b/docs/jsdoc/RetentionPolicies.html index 7f346e77..ff628dea 100644 --- a/docs/jsdoc/RetentionPolicies.html +++ b/docs/jsdoc/RetentionPolicies.html @@ -8928,13 +8928,13 @@
Returns:

diff --git a/docs/jsdoc/Search.html b/docs/jsdoc/Search.html index 5f6446b6..c5d2cf96 100644 --- a/docs/jsdoc/Search.html +++ b/docs/jsdoc/Search.html @@ -2102,13 +2102,13 @@
Returns:

diff --git a/docs/jsdoc/SharedItems.html b/docs/jsdoc/SharedItems.html index 2ec492fb..f1ed7c9b 100644 --- a/docs/jsdoc/SharedItems.html +++ b/docs/jsdoc/SharedItems.html @@ -768,13 +768,13 @@
Returns:

diff --git a/docs/jsdoc/ShieldInformationBarrier.html b/docs/jsdoc/ShieldInformationBarrier.html index 770d6a97..65109bbd 100644 --- a/docs/jsdoc/ShieldInformationBarrier.html +++ b/docs/jsdoc/ShieldInformationBarrier.html @@ -863,13 +863,13 @@
Type:

diff --git a/docs/jsdoc/ShieldInformationBarrierBase.html b/docs/jsdoc/ShieldInformationBarrierBase.html index 574da105..a4d4c6b5 100644 --- a/docs/jsdoc/ShieldInformationBarrierBase.html +++ b/docs/jsdoc/ShieldInformationBarrierBase.html @@ -270,13 +270,13 @@
Type:

diff --git a/docs/jsdoc/ShieldInformationBarrierManager.html b/docs/jsdoc/ShieldInformationBarrierManager.html index cc94d00e..f0f79409 100644 --- a/docs/jsdoc/ShieldInformationBarrierManager.html +++ b/docs/jsdoc/ShieldInformationBarrierManager.html @@ -731,7 +731,7 @@
Parameters:
-schemas.ShieldInformationBarrier +object @@ -970,7 +970,7 @@
Parameters:
-schemas.ShieldInformationBarrier +object @@ -1153,7 +1153,7 @@
Returns:
-

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

+

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

@@ -1282,7 +1282,7 @@
Properties
- 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`. + Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. @@ -1436,7 +1436,7 @@
Returns:
-Promise.<object> +Promise.<schemas.ShieldInformationBarriers>
@@ -1454,7 +1454,7 @@
Returns:
-

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

+

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

@@ -1583,7 +1583,7 @@
Properties
- 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`. + Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. @@ -1737,7 +1737,7 @@
Returns:
-Promise.<object> +Promise.<schemas.ShieldInformationBarriers>
@@ -1765,7 +1765,7 @@

getById Get shield information barrier with specified ID -Get shield information barrier based on provided ID.. +Get shield information barrier based on provided ID. @@ -2018,7 +2018,7 @@

getById Get shield information barrier with specified ID -Get shield information barrier based on provided ID.. +Get shield information barrier based on provided ID. @@ -2271,13 +2271,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierManager_ShieldInformationBarrierManager.html b/docs/jsdoc/ShieldInformationBarrierManager_ShieldInformationBarrierManager.html index 4f19a19f..ce36a32d 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 Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierReference.html b/docs/jsdoc/ShieldInformationBarrierReference.html index 8e02e63d..2b9d25f1 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 Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierReport.html b/docs/jsdoc/ShieldInformationBarrierReport.html index fa99de91..e2ff3db5 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 Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierReportBase.html b/docs/jsdoc/ShieldInformationBarrierReportBase.html index f67bec8d..ae8da177 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 Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierReportDetails.html b/docs/jsdoc/ShieldInformationBarrierReportDetails.html index 8e9391b5..5f9a161f 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 Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierReports.html b/docs/jsdoc/ShieldInformationBarrierReports.html new file mode 100644 index 00000000..f953eca0 --- /dev/null +++ b/docs/jsdoc/ShieldInformationBarrierReports.html @@ -0,0 +1,360 @@ + + + + + JSDoc: Interface: ShieldInformationBarrierReports + + + + + + + + + + +
+ +

Interface: ShieldInformationBarrierReports

+ + + + + + +
+ +
+ +

ShieldInformationBarrierReports

+ + +
+ +
+
+ + +
List of Shield Information Barrier Reports + +The part of an API response that describes marker +based pagination
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + +
+ + + + + + + + + + + + + + +

Members

+ + + +

entries :Array

+ + + + +
+ A list of shield information +barrier reports. +
+ + + +
Type:
+
    +
  • + +Array + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

limit :number

+ + + + +
+ The limit that was used for these entries. This will be the same as the +`limit` query parameter unless that value exceeded the maximum value +allowed. The maximum value varies by API. +Example: 1000 +
+ + + +
Type:
+
    +
  • + +number + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

next_marker :string

+ + + + +
+ The marker for the start of the next page of results. +Example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii +
+ + + +
Type:
+
    +
  • + +string + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time) +
+ + + + + \ No newline at end of file diff --git a/docs/jsdoc/ShieldInformationBarrierReportsManager.html b/docs/jsdoc/ShieldInformationBarrierReportsManager.html index 22d4f903..de634205 100644 --- a/docs/jsdoc/ShieldInformationBarrierReportsManager.html +++ b/docs/jsdoc/ShieldInformationBarrierReportsManager.html @@ -675,7 +675,7 @@
Returns:
-

getAll(options, callbackopt) → {Promise.<object>}

+

getAll(options, callbackopt) → {Promise.<schemas.ShieldInformationBarrierReports>}

@@ -685,7 +685,7 @@

getAll List shield information barrier reports -Lists shield information barrier reports with specific IDs. +Lists shield information barrier reports. @@ -986,7 +986,7 @@
Returns:
-Promise.<object> +Promise.<schemas.ShieldInformationBarrierReports>
@@ -1004,7 +1004,7 @@
Returns:
-

getAll(options, callbackopt) → {Promise.<object>}

+

getAll(options, callbackopt) → {Promise.<schemas.ShieldInformationBarrierReports>}

@@ -1014,7 +1014,7 @@

getAll List shield information barrier reports -Lists shield information barrier reports with specific IDs. +Lists shield information barrier reports. @@ -1315,7 +1315,7 @@
Returns:
-Promise.<object> +Promise.<schemas.ShieldInformationBarrierReports>
@@ -1849,13 +1849,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierReportsManager_ShieldInformationBarrierReportsManager.html b/docs/jsdoc/ShieldInformationBarrierReportsManager_ShieldInformationBarrierReportsManager.html index c4d61847..ac0a7a8b 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 Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegment.html b/docs/jsdoc/ShieldInformationBarrierSegment.html index 3d2e09ec..e909050d 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 Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentMember.html b/docs/jsdoc/ShieldInformationBarrierSegmentMember.html index b5043480..a997a867 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 Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentMemberBase.html b/docs/jsdoc/ShieldInformationBarrierSegmentMemberBase.html index 0bfeb49c..8cebec93 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 Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentMemberMini.html b/docs/jsdoc/ShieldInformationBarrierSegmentMemberMini.html index 3e74c263..b7cb994c 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 Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentMembers.html b/docs/jsdoc/ShieldInformationBarrierSegmentMembers.html new file mode 100644 index 00000000..dbd2c585 --- /dev/null +++ b/docs/jsdoc/ShieldInformationBarrierSegmentMembers.html @@ -0,0 +1,360 @@ + + + + + JSDoc: Interface: ShieldInformationBarrierSegmentMembers + + + + + + + + + + +
+ +

Interface: ShieldInformationBarrierSegmentMembers

+ + + + + + +
+ +
+ +

ShieldInformationBarrierSegmentMembers

+ + +
+ +
+
+ + +
List of Shield Information Barrier Segment Members + +The part of an API response that describes marker +based pagination
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + +
+ + + + + + + + + + + + + + +

Members

+ + + +

entries :Array

+ + + + +
+ A list of shield information +barrier segment members +
+ + + +
Type:
+
    +
  • + +Array + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

limit :number

+ + + + +
+ The limit that was used for these entries. This will be the same as the +`limit` query parameter unless that value exceeded the maximum value +allowed. The maximum value varies by API. +Example: 1000 +
+ + + +
Type:
+
    +
  • + +number + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

next_marker :string

+ + + + +
+ The marker for the start of the next page of results. +Example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii +
+ + + +
Type:
+
    +
  • + +string + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time) +
+ + + + + \ No newline at end of file diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentMembersManager.html b/docs/jsdoc/ShieldInformationBarrierSegmentMembersManager.html index 9883b064..eeef8ba7 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentMembersManager.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentMembersManager.html @@ -1183,7 +1183,7 @@
Returns:
-

getAll(options, callbackopt) → {Promise.<object>}

+

getAll(options, callbackopt) → {Promise.<schemas.ShieldInformationBarrierSegmentMembers>}

@@ -1495,7 +1495,7 @@
Returns:
-Promise.<object> +Promise.<schemas.ShieldInformationBarrierSegmentMembers>
@@ -1513,7 +1513,7 @@
Returns:
-

getAll(options, callbackopt) → {Promise.<object>}

+

getAll(options, callbackopt) → {Promise.<schemas.ShieldInformationBarrierSegmentMembers>}

@@ -1825,7 +1825,7 @@
Returns:
-Promise.<object> +Promise.<schemas.ShieldInformationBarrierSegmentMembers>
@@ -2361,13 +2361,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentMembersManager_ShieldInformationBarrierSegmentMembersManager.html b/docs/jsdoc/ShieldInformationBarrierSegmentMembersManager_ShieldInformationBarrierSegmentMembersManager.html index d2c359fa..c61ff432 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 Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentRestriction.html b/docs/jsdoc/ShieldInformationBarrierSegmentRestriction.html index a2800835..8ab7da42 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 Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionBase.html b/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionBase.html index 594f59db..bec8df7a 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 Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionMini.html b/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionMini.html index daf604ea..ecfa7d7a 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 Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentRestrictions.html b/docs/jsdoc/ShieldInformationBarrierSegmentRestrictions.html new file mode 100644 index 00000000..e5d202a9 --- /dev/null +++ b/docs/jsdoc/ShieldInformationBarrierSegmentRestrictions.html @@ -0,0 +1,360 @@ + + + + + JSDoc: Interface: ShieldInformationBarrierSegmentRestrictions + + + + + + + + + + +
+ +

Interface: ShieldInformationBarrierSegmentRestrictions

+ + + + + + +
+ +
+ +

ShieldInformationBarrierSegmentRestrictions

+ + +
+ +
+
+ + +
List of Shield Information Barrier Segment Restrictions + +The part of an API response that describes marker +based pagination
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + +
+ + + + + + + + + + + + + + +

Members

+ + + +

entries :Array

+ + + + +
+ A list of shield information barrier +segment restriction objects +
+ + + +
Type:
+
    +
  • + +Array + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

limit :number

+ + + + +
+ The limit that was used for these entries. This will be the same as the +`limit` query parameter unless that value exceeded the maximum value +allowed. The maximum value varies by API. +Example: 1000 +
+ + + +
Type:
+
    +
  • + +number + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

next_marker :string

+ + + + +
+ The marker for the start of the next page of results. +Example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii +
+ + + +
Type:
+
    +
  • + +string + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time) +
+ + + + + \ No newline at end of file diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionsManager.html b/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionsManager.html index 4ac1f94e..30ec5531 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionsManager.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionsManager.html @@ -1185,7 +1185,7 @@
Returns:
-

getAll(options, callbackopt) → {Promise.<object>}

+

getAll(options, callbackopt) → {Promise.<schemas.ShieldInformationBarrierSegmentRestrictions>}

@@ -1497,7 +1497,7 @@
Returns:
-Promise.<object> +Promise.<schemas.ShieldInformationBarrierSegmentRestrictions>
@@ -1515,7 +1515,7 @@
Returns:
-

getAll(options, callbackopt) → {Promise.<object>}

+

getAll(options, callbackopt) → {Promise.<schemas.ShieldInformationBarrierSegmentRestrictions>}

@@ -1827,7 +1827,7 @@
Returns:
-Promise.<object> +Promise.<schemas.ShieldInformationBarrierSegmentRestrictions>
@@ -2363,13 +2363,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionsManager_ShieldInformationBarrierSegmentRestrictionsManager.html b/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionsManager_ShieldInformationBarrierSegmentRestrictionsManager.html index 86234ebb..f568e5d3 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 Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegments.html b/docs/jsdoc/ShieldInformationBarrierSegments.html new file mode 100644 index 00000000..9035682a --- /dev/null +++ b/docs/jsdoc/ShieldInformationBarrierSegments.html @@ -0,0 +1,360 @@ + + + + + JSDoc: Interface: ShieldInformationBarrierSegments + + + + + + + + + + +
+ +

Interface: ShieldInformationBarrierSegments

+ + + + + + +
+ +
+ +

ShieldInformationBarrierSegments

+ + +
+ +
+
+ + +
List of Shield Information Barrier Segments + +The part of an API response that describes marker +based pagination
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + +
+ + + + + + + + + + + + + + +

Members

+ + + +

entries :Array

+ + + + +
+ A list of shield information barrier +segments +
+ + + +
Type:
+
    +
  • + +Array + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

limit :number

+ + + + +
+ The limit that was used for these entries. This will be the same as the +`limit` query parameter unless that value exceeded the maximum value +allowed. The maximum value varies by API. +Example: 1000 +
+ + + +
Type:
+
    +
  • + +number + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

next_marker :string

+ + + + +
+ The marker for the start of the next page of results. +Example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii +
+ + + +
Type:
+
    +
  • + +string + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time) +
+ + + + + \ No newline at end of file diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentsManager.html b/docs/jsdoc/ShieldInformationBarrierSegmentsManager.html index a0162c34..728099ab 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentsManager.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentsManager.html @@ -1183,7 +1183,7 @@
Returns:
-

getAll(options, callbackopt) → {Promise.<object>}

+

getAll(options, callbackopt) → {Promise.<schemas.ShieldInformationBarrierSegments>}

@@ -1495,7 +1495,7 @@
Returns:
-Promise.<object> +Promise.<schemas.ShieldInformationBarrierSegments>
@@ -1513,7 +1513,7 @@
Returns:
-

getAll(options, callbackopt) → {Promise.<object>}

+

getAll(options, callbackopt) → {Promise.<schemas.ShieldInformationBarrierSegments>}

@@ -1825,7 +1825,7 @@
Returns:
-Promise.<object> +Promise.<schemas.ShieldInformationBarrierSegments>
@@ -2927,13 +2927,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentsManager_ShieldInformationBarrierSegmentsManager.html b/docs/jsdoc/ShieldInformationBarrierSegmentsManager_ShieldInformationBarrierSegmentsManager.html index 6cf9377c..143db54a 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 Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/ShieldInformationBarriers.html b/docs/jsdoc/ShieldInformationBarriers.html new file mode 100644 index 00000000..d8c5d72d --- /dev/null +++ b/docs/jsdoc/ShieldInformationBarriers.html @@ -0,0 +1,359 @@ + + + + + JSDoc: Interface: ShieldInformationBarriers + + + + + + + + + + +
+ +

Interface: ShieldInformationBarriers

+ + + + + + +
+ +
+ +

ShieldInformationBarriers

+ + +
+ +
+
+ + +
List of Shield Information Barriers + +The part of an API response that describes marker +based pagination
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + +
+ + + + + + + + + + + + + + +

Members

+ + + +

entries :Array

+ + + + +
+ A list of shield information barrier objects +
+ + + +
Type:
+
    +
  • + +Array + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

limit :number

+ + + + +
+ The limit that was used for these entries. This will be the same as the +`limit` query parameter unless that value exceeded the maximum value +allowed. The maximum value varies by API. +Example: 1000 +
+ + + +
Type:
+
    +
  • + +number + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

next_marker :string

+ + + + +
+ The marker for the start of the next page of results. +Example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii +
+ + + +
Type:
+
    +
  • + +string + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time) +
+ + + + + \ No newline at end of file diff --git a/docs/jsdoc/SignRequest.html b/docs/jsdoc/SignRequest.html index b7558128..56cb8d84 100644 --- a/docs/jsdoc/SignRequest.html +++ b/docs/jsdoc/SignRequest.html @@ -887,13 +887,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/SignRequestBase.html b/docs/jsdoc/SignRequestBase.html index 45272e7d..b4e7b22c 100644 --- a/docs/jsdoc/SignRequestBase.html +++ b/docs/jsdoc/SignRequestBase.html @@ -1150,13 +1150,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/SignRequestCreateRequest.html b/docs/jsdoc/SignRequestCreateRequest.html index 4394b746..1e16c189 100644 --- a/docs/jsdoc/SignRequestCreateRequest.html +++ b/docs/jsdoc/SignRequestCreateRequest.html @@ -107,14 +107,92 @@

Members

+

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

+ + + + +
+ Force a specific color for the signature (blue, black, or red) +Example: blue +
+ + + +
Type:
+
    +
  • + +'blue' +| + +'black' +| + +'red' + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +

signers :Array

- Array of signers for the sign request. 35 is the -max number of signers permitted. + Array of signers for the sign request. 35 is the max number of signers permitted.
@@ -162,7 +240,7 @@
Type:
Source:
@@ -268,13 +346,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/SignRequestCreateSigner.html b/docs/jsdoc/SignRequestCreateSigner.html index e46b4276..92ab2858 100644 --- a/docs/jsdoc/SignRequestCreateSigner.html +++ b/docs/jsdoc/SignRequestCreateSigner.html @@ -165,7 +165,7 @@
Type:
Source:
@@ -189,7 +189,8 @@

email - Email address of the signer + Email address of the signer. +The email address of the signer is required when making signature requests, except when using templates that are configured to include emails. Example: example@gmail.com @@ -312,7 +313,7 @@
Type:
Source:
@@ -386,7 +387,7 @@
Type:
Source:
@@ -462,7 +463,7 @@
Type:
Source:
@@ -535,7 +536,7 @@
Type:
Source:
@@ -609,7 +610,7 @@
Type:
Source:
@@ -687,7 +688,7 @@
Type:
Source:
@@ -774,7 +775,82 @@
Type:
Source:
+ + + + + + + + + + + + + + + + +

signer_group_id :string

+ + + + +
+ If set, signers who have the same group ID will be assigned to the same input. +A signer group is expected to have more than one signer. When a group contains fewer than two signers, +it will be converted to a single signer and the group will be removed. +Example: cd4ff89-8fc1-42cf-8b29-1890dedd26d7 +
+ + + +
Type:
+
    +
  • + +string + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
@@ -848,7 +924,7 @@
Type:
Source:
@@ -882,13 +958,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/SignRequestPrefillTag.html b/docs/jsdoc/SignRequestPrefillTag.html index e7cad51c..8bcba0dd 100644 --- a/docs/jsdoc/SignRequestPrefillTag.html +++ b/docs/jsdoc/SignRequestPrefillTag.html @@ -188,7 +188,7 @@

date_value<
Date prefill value -Example: 2021-04-26T08:12:13.982Z +Example: 2021-04-26
@@ -416,13 +416,13 @@

Type:

- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/SignRequestSigner.html b/docs/jsdoc/SignRequestSigner.html index 82c5d1b2..51ca54a6 100644 --- a/docs/jsdoc/SignRequestSigner.html +++ b/docs/jsdoc/SignRequestSigner.html @@ -419,13 +419,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/SignRequestSignerInput.html b/docs/jsdoc/SignRequestSignerInput.html index 5508ab3c..61c50a0b 100644 --- a/docs/jsdoc/SignRequestSignerInput.html +++ b/docs/jsdoc/SignRequestSignerInput.html @@ -107,7 +107,7 @@

Members

-

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

+

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

@@ -123,22 +123,22 @@
Type:
+ + + + + + + + +

limit :number

+ + + + +
+ The limit that was used for these entries. This will be the same as the +`limit` query parameter unless that value exceeded the maximum value +allowed. The maximum value varies by API. +Example: 1000 +
+ + + +
Type:
+
    +
  • + +number + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + @@ -180,6 +255,79 @@
Type:
+

next_marker :string

+ + + + +
+ The marker for the start of the next page of results. +Example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii +
+ + + +
Type:
+
    +
  • + +string + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +

prev_marker :string

@@ -187,7 +335,7 @@

prev_marke
The marker for the start of the previous page of results. -Example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii +Example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih
@@ -235,7 +383,7 @@

Type:
Source:
@@ -269,13 +417,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/SignTemplatesManager.html b/docs/jsdoc/SignTemplatesManager.html index 42939bf8..79861100 100644 --- a/docs/jsdoc/SignTemplatesManager.html +++ b/docs/jsdoc/SignTemplatesManager.html @@ -1321,13 +1321,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/SignTemplatesManager_SignTemplatesManager.html b/docs/jsdoc/SignTemplatesManager_SignTemplatesManager.html index 27c1be87..cf957b77 100644 --- a/docs/jsdoc/SignTemplatesManager_SignTemplatesManager.html +++ b/docs/jsdoc/SignTemplatesManager_SignTemplatesManager.html @@ -201,13 +201,13 @@
Parameters:

- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/StoragePolicies.html b/docs/jsdoc/StoragePolicies.html index 5a100f5a..d4d499c7 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 Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/Tasks.html b/docs/jsdoc/Tasks.html index 6c43c454..4a68c30d 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 Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/TemplateSigner.html b/docs/jsdoc/TemplateSigner.html index 3f0fe62c..15a923c6 100644 --- a/docs/jsdoc/TemplateSigner.html +++ b/docs/jsdoc/TemplateSigner.html @@ -415,6 +415,81 @@
Type:
+ +

signer_group_id :string

+ + + + +
+ If set, signers who have the same group ID will be assigned to the same input. +A signer group is expected to have more than one signer. When a group contains fewer than two signers, +it will be converted to a single signer and the group will be removed. +Example: cd4ff89-8fc1-42cf-8b29-1890dedd26d7 +
+ + + +
Type:
+
    +
  • + +string + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + @@ -432,13 +507,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/TemplateSignerInput.html b/docs/jsdoc/TemplateSignerInput.html index 7a841c9c..eb494b0d 100644 --- a/docs/jsdoc/TemplateSignerInput.html +++ b/docs/jsdoc/TemplateSignerInput.html @@ -658,6 +658,79 @@
Type:
+

label :string

+ + + + +
+ The label field is used especially for text, attachment, radio, and checkbox type inputs. +Example: Legal name +
+ + + +
Type:
+
    +
  • + +string + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +

page_index :number

@@ -731,7 +804,7 @@
Type:
-

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

+

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

@@ -759,6 +832,9 @@
Type:
'checkbox' | +'attachment' +| + 'radio' | @@ -835,13 +911,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/TermsOfService.html b/docs/jsdoc/TermsOfService.html index e803bb97..0bd1b0a5 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 Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:35 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/TokenManager.html b/docs/jsdoc/TokenManager.html index 25d55c05..76f46727 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 Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:36 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/Trash.html b/docs/jsdoc/Trash.html index 5c3b9a05..5f6c2958 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 Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:36 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/UserBase.html b/docs/jsdoc/UserBase.html index a2a25e6b..d4ab6aea 100644 --- a/docs/jsdoc/UserBase.html +++ b/docs/jsdoc/UserBase.html @@ -270,13 +270,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:36 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/UserIntegrationMappings.html b/docs/jsdoc/UserIntegrationMappings.html index 0a68e38f..e6086858 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 Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:36 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/Users.html b/docs/jsdoc/Users.html index 27066fdf..327b3540 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 Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:36 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/WebLinks.html b/docs/jsdoc/WebLinks.html index 096c1773..37707604 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 Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:36 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/Webhooks.html b/docs/jsdoc/Webhooks.html index fcf1a8da..38c40103 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 Nov 08 2023 06:28:45 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:36 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/api-request-manager.ts.html b/docs/jsdoc/api-request-manager.ts.html index b877655d..f2bd5b12 100644 --- a/docs/jsdoc/api-request-manager.ts.html +++ b/docs/jsdoc/api-request-manager.ts.html @@ -139,13 +139,13 @@

Source: api-request-manager.ts


- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/api-request.ts.html b/docs/jsdoc/api-request.ts.html index 05635517..6128c939 100644 --- a/docs/jsdoc/api-request.ts.html +++ b/docs/jsdoc/api-request.ts.html @@ -462,13 +462,13 @@

Source: api-request.ts


- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/box-client.ts.html b/docs/jsdoc/box-client.ts.html index aee91206..752d3742 100644 --- a/docs/jsdoc/box-client.ts.html +++ b/docs/jsdoc/box-client.ts.html @@ -825,13 +825,13 @@

Source: box-client.ts


- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/box-node-sdk.ts.html b/docs/jsdoc/box-node-sdk.ts.html index a414874c..41427ffd 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/chunked-uploader.ts.html b/docs/jsdoc/chunked-uploader.ts.html index dfe70709..135ee53d 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/enterprise-event-stream.ts.html b/docs/jsdoc/enterprise-event-stream.ts.html index 018c8d83..af0ee335 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/event-stream.ts.html b/docs/jsdoc/event-stream.ts.html index 674f0535..459d675b 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/global.html b/docs/jsdoc/global.html index 3f79c3c8..6b6a4e28 100644 --- a/docs/jsdoc/global.html +++ b/docs/jsdoc/global.html @@ -8239,13 +8239,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/index.html b/docs/jsdoc/index.html index ec6f2d0c..f901bb9b 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_collaboration-allowlist.ts.html b/docs/jsdoc/managers_collaboration-allowlist.ts.html index 210422bb..802fdbf3 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_collaborations.ts.html b/docs/jsdoc/managers_collaborations.ts.html index 0e4560eb..18191838 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_collections.ts.html b/docs/jsdoc/managers_collections.ts.html index 5a30560a..f8ff17f5 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_comments.ts.html b/docs/jsdoc/managers_comments.ts.html index 63832066..f43e0954 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_device-pins.ts.html b/docs/jsdoc/managers_device-pins.ts.html index ef1724d1..25e661b7 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_enterprise.ts.html b/docs/jsdoc/managers_enterprise.ts.html index fcbd65fe..dca7c287 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_events.ts.html b/docs/jsdoc/managers_events.ts.html index 637a9d46..68a6f866 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_file-requests-manager.ts.html b/docs/jsdoc/managers_file-requests-manager.ts.html index e5d040a0..8e1786de 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_files.ts.html b/docs/jsdoc/managers_files.ts.html index 74d0c4ae..3221add6 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_folders.ts.html b/docs/jsdoc/managers_folders.ts.html index c49cb82b..caab8c29 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_groups.ts.html b/docs/jsdoc/managers_groups.ts.html index 16b0bfb1..c87545a6 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_integration-mappings.ts.html b/docs/jsdoc/managers_integration-mappings.ts.html index 92fe30fa..477fa5d5 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_legal-hold-policies.ts.html b/docs/jsdoc/managers_legal-hold-policies.ts.html index ac4ef998..5c15442a 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_metadata.ts.html b/docs/jsdoc/managers_metadata.ts.html index 0b3ef0ec..47927c9c 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_recent-items.ts.html b/docs/jsdoc/managers_recent-items.ts.html index 79910c2b..094113d2 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_retention-policies.ts.html b/docs/jsdoc/managers_retention-policies.ts.html index f7f7b61a..cc865eda 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_search.ts.html b/docs/jsdoc/managers_search.ts.html index fccded63..10cf5d65 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_shared-items.ts.html b/docs/jsdoc/managers_shared-items.ts.html index 568458e0..1975330e 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard 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 3fdaaf6c..b6530ff8 100644 --- a/docs/jsdoc/managers_shield-information-barrier-reports.generated.ts.html +++ b/docs/jsdoc/managers_shield-information-barrier-reports.generated.ts.html @@ -77,13 +77,13 @@

Source: managers/shield-information-barrier-reports.gener /** * List shield information barrier reports * - * Lists shield information barrier reports with specific IDs. + * Lists shield information barrier reports. * @param {object} options Options for the request * @param {string} options.shield_information_barrier_id The ID of the shield information barrier. * @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<object>} A promise resolving to the result or rejecting with an error + * @returns {Promise<schemas.ShieldInformationBarrierReports>} A promise resolving to the result or rejecting with an error */ getAll( options: { @@ -104,7 +104,7 @@

Source: managers/shield-information-barrier-reports.gener readonly limit?: number; }, callback?: Function - ): Promise<object> { + ): Promise<schemas.ShieldInformationBarrierReports> { const { ...queryParams } = options, apiPath = urlPath('shield_information_barrier_reports'), params = { @@ -154,13 +154,13 @@

Source: managers/shield-information-barrier-reports.gener
- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard 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 a5580e2c..459c76e8 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 @@ -86,7 +86,7 @@

Source: managers/shield-information-barrier-segment-membe * @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<object>} A promise resolving to the result or rejecting with an error + * @returns {Promise<schemas.ShieldInformationBarrierSegmentMembers>} A promise resolving to the result or rejecting with an error */ getAll( options: { @@ -107,7 +107,7 @@

Source: managers/shield-information-barrier-segment-membe readonly limit?: number; }, callback?: Function - ): Promise<object> { + ): Promise<schemas.ShieldInformationBarrierSegmentMembers> { const { ...queryParams } = options, apiPath = urlPath('shield_information_barrier_segment_members'), params = { @@ -194,13 +194,13 @@

Source: managers/shield-information-barrier-segment-membe
- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard 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 e2ecab1e..f847c853 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 @@ -86,7 +86,7 @@

Source: managers/shield-information-barrier-segment-restr * @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<object>} A promise resolving to the result or rejecting with an error + * @returns {Promise<schemas.ShieldInformationBarrierSegmentRestrictions>} A promise resolving to the result or rejecting with an error */ getAll( options: { @@ -107,7 +107,7 @@

Source: managers/shield-information-barrier-segment-restr readonly limit?: number; }, callback?: Function - ): Promise<object> { + ): Promise<schemas.ShieldInformationBarrierSegmentRestrictions> { const { ...queryParams } = options, apiPath = urlPath('shield_information_barrier_segment_restrictions'), params = { @@ -195,13 +195,13 @@

Source: managers/shield-information-barrier-segment-restr
- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard 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 9ef60c9b..1edc20d0 100644 --- a/docs/jsdoc/managers_shield-information-barrier-segments.generated.ts.html +++ b/docs/jsdoc/managers_shield-information-barrier-segments.generated.ts.html @@ -85,7 +85,7 @@

Source: managers/shield-information-barrier-segments.gene * @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<object>} A promise resolving to the result or rejecting with an error + * @returns {Promise<schemas.ShieldInformationBarrierSegments>} A promise resolving to the result or rejecting with an error */ getAll( options: { @@ -106,7 +106,7 @@

Source: managers/shield-information-barrier-segments.gene readonly limit?: number; }, callback?: Function - ): Promise<object> { + ): Promise<schemas.ShieldInformationBarrierSegments> { const { ...queryParams } = options, apiPath = urlPath('shield_information_barrier_segments'), params = { @@ -232,13 +232,13 @@

Source: managers/shield-information-barrier-segments.gene
- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_shield-information-barriers.generated.ts.html b/docs/jsdoc/managers_shield-information-barriers.generated.ts.html index d666d0c2..fb069f78 100644 --- a/docs/jsdoc/managers_shield-information-barriers.generated.ts.html +++ b/docs/jsdoc/managers_shield-information-barriers.generated.ts.html @@ -42,7 +42,7 @@

Source: managers/shield-information-barriers.generated.ts /** * Get shield information barrier with specified ID * - * Get shield information barrier based on provided ID.. + * Get shield information barrier based on provided ID. * @param {object} options Options for the request * @param {string} options.shield_information_barrier_id The ID of the shield information barrier. * @param {Function} [callback] Passed the result if successful, error otherwise @@ -80,18 +80,16 @@

Source: managers/shield-information-barriers.generated.ts * Retrieves a list of shield information barrier objects * for the enterprise of JWT. * @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 {string} [options.marker] Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. * @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<object>} A promise resolving to the result or rejecting with an error + * @returns {Promise<schemas.ShieldInformationBarriers>} 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; /** @@ -100,7 +98,7 @@

Source: managers/shield-information-barriers.generated.ts readonly limit?: number; }, callback?: Function - ): Promise<object> { + ): Promise<schemas.ShieldInformationBarriers> { const { ...queryParams } = options, apiPath = urlPath('shield_information_barriers'), params = { @@ -118,13 +116,18 @@

Source: managers/shield-information-barriers.generated.ts * Creates a shield information barrier to * separate individuals/groups within the same * firm and prevents confidential information passing between them. - * @param {schemas.ShieldInformationBarrier} body + * @param {object} body * @param {object} [options] Options for the request * @param {Function} [callback] Passed the result if successful, error otherwise * @returns {Promise<schemas.ShieldInformationBarrier>} A promise resolving to the result or rejecting with an error */ create( - body: schemas.ShieldInformationBarrier, + body: { + enterprise: { + type: string; + id: string; + }; + }, options?: {}, callback?: Function ): Promise<schemas.ShieldInformationBarrier> { @@ -150,7 +153,10 @@

Source: managers/shield-information-barriers.generated.ts * @returns {Promise<schemas.ShieldInformationBarrier>} A promise resolving to the result or rejecting with an error */ changeStatusById( - body: object, + body: { + id: string; + status: string; + }, options?: {}, callback?: Function ): Promise<schemas.ShieldInformationBarrier> { @@ -178,13 +184,13 @@

Source: managers/shield-information-barriers.generated.ts
- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_sign-requests.generated.ts.html b/docs/jsdoc/managers_sign-requests.generated.ts.html index df2df3ce..3381a143 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_sign-templates.generated.ts.html b/docs/jsdoc/managers_sign-templates.generated.ts.html index aeb9acc3..671a970e 100644 --- a/docs/jsdoc/managers_sign-templates.generated.ts.html +++ b/docs/jsdoc/managers_sign-templates.generated.ts.html @@ -118,13 +118,13 @@

Source: managers/sign-templates.generated.ts


- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_storage-policies.ts.html b/docs/jsdoc/managers_storage-policies.ts.html index e390d0e4..eff24cc2 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_tasks.ts.html b/docs/jsdoc/managers_tasks.ts.html index e3923fa7..b3650eb8 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_terms-of-service.ts.html b/docs/jsdoc/managers_terms-of-service.ts.html index 9a0c3846..d4405c0f 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_trash.ts.html b/docs/jsdoc/managers_trash.ts.html index f8ae02a5..8e0037e2 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_users.ts.html b/docs/jsdoc/managers_users.ts.html index 7c5854ac..ac82ee78 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_web-links.ts.html b/docs/jsdoc/managers_web-links.ts.html index 71832392..c15059ca 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/managers_webhooks.ts.html b/docs/jsdoc/managers_webhooks.ts.html index 7f31d3a5..c003d8b1 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/schemas_enterprise-base.generated.ts.html b/docs/jsdoc/schemas_enterprise-base.generated.ts.html index c2dcbd13..9f02412d 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/schemas_file-base.generated.ts.html b/docs/jsdoc/schemas_file-base.generated.ts.html index 14032170..bad4aec7 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/schemas_file-mini.generated.ts.html b/docs/jsdoc/schemas_file-mini.generated.ts.html index 027bdf4e..df22d2a4 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/schemas_file-version-base.generated.ts.html b/docs/jsdoc/schemas_file-version-base.generated.ts.html index 9667f0b7..6890cc1f 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/schemas_file-version-mini.generated.ts.html b/docs/jsdoc/schemas_file-version-mini.generated.ts.html index d6d0a8da..d313f7ff 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/schemas_folder-base.generated.ts.html b/docs/jsdoc/schemas_folder-base.generated.ts.html index d46e6c79..97b69e06 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/schemas_folder-mini.generated.ts.html b/docs/jsdoc/schemas_folder-mini.generated.ts.html index f7cc9404..2ec1337a 100644 --- a/docs/jsdoc/schemas_folder-mini.generated.ts.html +++ b/docs/jsdoc/schemas_folder-mini.generated.ts.html @@ -34,11 +34,6 @@

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. @@ -56,6 +51,11 @@

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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/schemas_integration-mapping-base.ts.html b/docs/jsdoc/schemas_integration-mapping-base.ts.html index d88955d8..560b1cd0 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard 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 17110f6b..39e644db 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard 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 c7af3286..7f73ebac 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard 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 1056fe72..b78d9ac8 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/schemas_integration-mapping-slack-options.ts.html b/docs/jsdoc/schemas_integration-mapping-slack-options.ts.html index 73367c11..329f924c 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/schemas_integration-mapping.ts.html b/docs/jsdoc/schemas_integration-mapping.ts.html index bb49deaf..1e390186 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/schemas_integration-mappings.ts.html b/docs/jsdoc/schemas_integration-mappings.ts.html index 2155c68d..10666b48 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard 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 e1d6b8c3..97916333 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard 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 3720ae6f..fd7643f7 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard 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 511b8191..65d96899 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard 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 9f200b90..e53c4bac 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard 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 60254fc7..3048c953 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/schemas_shield-information-barrier-reports.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier-reports.generated.ts.html new file mode 100644 index 00000000..eb1e9aec --- /dev/null +++ b/docs/jsdoc/schemas_shield-information-barrier-reports.generated.ts.html @@ -0,0 +1,77 @@ + + + + + JSDoc: Source: schemas/shield-information-barrier-reports.generated.ts + + + + + + + + + + +
+ +

Source: schemas/shield-information-barrier-reports.generated.ts

+ + + + + + +
+
+ 
import * as schemas from '.';
+/**
+ * List of Shield Information Barrier Reports
+ *
+ * The part of an API response that describes marker
+ * based pagination
+ */
+export interface ShieldInformationBarrierReports {
+	/**
+	 * The limit that was used for these entries. This will be the same as the
+	 * `limit` query parameter unless that value exceeded the maximum value
+	 * allowed. The maximum value varies by API.
+	 * Example: 1000
+	 */
+	limit?: number;
+	/**
+	 * The marker for the start of the next page of results.
+	 * Example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
+	 */
+	next_marker?: string;
+	/**
+	 * A list of shield information
+	 * barrier reports.
+	 */
+	entries?: schemas.ShieldInformationBarrierReport[];
+}
+
+
+
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard 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 88b18cf1..98bb5a91 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard 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 53d43655..fc48b786 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard 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 73ee0404..eec0cbc8 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/schemas_shield-information-barrier-segment-members.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier-segment-members.generated.ts.html new file mode 100644 index 00000000..5b10458b --- /dev/null +++ b/docs/jsdoc/schemas_shield-information-barrier-segment-members.generated.ts.html @@ -0,0 +1,77 @@ + + + + + JSDoc: Source: schemas/shield-information-barrier-segment-members.generated.ts + + + + + + + + + + +
+ +

Source: schemas/shield-information-barrier-segment-members.generated.ts

+ + + + + + +
+
+ 
import * as schemas from '.';
+/**
+ * List of Shield Information Barrier Segment Members
+ *
+ * The part of an API response that describes marker
+ * based pagination
+ */
+export interface ShieldInformationBarrierSegmentMembers {
+	/**
+	 * The limit that was used for these entries. This will be the same as the
+	 * `limit` query parameter unless that value exceeded the maximum value
+	 * allowed. The maximum value varies by API.
+	 * Example: 1000
+	 */
+	limit?: number;
+	/**
+	 * The marker for the start of the next page of results.
+	 * Example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
+	 */
+	next_marker?: string;
+	/**
+	 * A list of shield information
+	 * barrier segment members
+	 */
+	entries?: schemas.ShieldInformationBarrierSegmentMember[];
+}
+
+
+
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard 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 e5b55af0..edae6097 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard 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 148e0096..af390bb0 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard 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 7bb4d6df..78dcf1e7 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/schemas_shield-information-barrier-segment-restrictions.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier-segment-restrictions.generated.ts.html new file mode 100644 index 00000000..343dac3e --- /dev/null +++ b/docs/jsdoc/schemas_shield-information-barrier-segment-restrictions.generated.ts.html @@ -0,0 +1,77 @@ + + + + + JSDoc: Source: schemas/shield-information-barrier-segment-restrictions.generated.ts + + + + + + + + + + +
+ +

Source: schemas/shield-information-barrier-segment-restrictions.generated.ts

+ + + + + + +
+
+ 
import * as schemas from '.';
+/**
+ * List of Shield Information Barrier Segment Restrictions
+ *
+ * The part of an API response that describes marker
+ * based pagination
+ */
+export interface ShieldInformationBarrierSegmentRestrictions {
+	/**
+	 * The limit that was used for these entries. This will be the same as the
+	 * `limit` query parameter unless that value exceeded the maximum value
+	 * allowed. The maximum value varies by API.
+	 * Example: 1000
+	 */
+	limit?: number;
+	/**
+	 * The marker for the start of the next page of results.
+	 * Example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
+	 */
+	next_marker?: string;
+	/**
+	 * A list of shield information barrier
+	 * segment restriction objects
+	 */
+	entries?: schemas.ShieldInformationBarrierSegmentRestriction[];
+}
+
+
+
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard 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 5cac074d..56e1a2a0 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/schemas_shield-information-barrier-segments.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier-segments.generated.ts.html new file mode 100644 index 00000000..b5beeb70 --- /dev/null +++ b/docs/jsdoc/schemas_shield-information-barrier-segments.generated.ts.html @@ -0,0 +1,77 @@ + + + + + JSDoc: Source: schemas/shield-information-barrier-segments.generated.ts + + + + + + + + + + +
+ +

Source: schemas/shield-information-barrier-segments.generated.ts

+ + + + + + +
+
+ 
import * as schemas from '.';
+/**
+ * List of Shield Information Barrier Segments
+ *
+ * The part of an API response that describes marker
+ * based pagination
+ */
+export interface ShieldInformationBarrierSegments {
+	/**
+	 * The limit that was used for these entries. This will be the same as the
+	 * `limit` query parameter unless that value exceeded the maximum value
+	 * allowed. The maximum value varies by API.
+	 * Example: 1000
+	 */
+	limit?: number;
+	/**
+	 * The marker for the start of the next page of results.
+	 * Example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
+	 */
+	next_marker?: string;
+	/**
+	 * A list of shield information barrier
+	 * segments
+	 */
+	entries?: schemas.ShieldInformationBarrierSegment[];
+}
+
+
+
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time) +
+ + + + + diff --git a/docs/jsdoc/schemas_shield-information-barrier.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier.generated.ts.html index 8d15e263..a19a74d7 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/schemas_shield-information-barriers.generated.ts.html b/docs/jsdoc/schemas_shield-information-barriers.generated.ts.html new file mode 100644 index 00000000..5d77b72c --- /dev/null +++ b/docs/jsdoc/schemas_shield-information-barriers.generated.ts.html @@ -0,0 +1,76 @@ + + + + + JSDoc: Source: schemas/shield-information-barriers.generated.ts + + + + + + + + + + +
+ +

Source: schemas/shield-information-barriers.generated.ts

+ + + + + + +
+
+ 
import * as schemas from '.';
+/**
+ * List of Shield Information Barriers
+ *
+ * The part of an API response that describes marker
+ * based pagination
+ */
+export interface ShieldInformationBarriers {
+	/**
+	 * The limit that was used for these entries. This will be the same as the
+	 * `limit` query parameter unless that value exceeded the maximum value
+	 * allowed. The maximum value varies by API.
+	 * Example: 1000
+	 */
+	limit?: number;
+	/**
+	 * The marker for the start of the next page of results.
+	 * Example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
+	 */
+	next_marker?: string;
+	/**
+	 * A list of shield information barrier objects
+	 */
+	entries?: schemas.ShieldInformationBarrier[];
+}
+
+
+
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time) +
+ + + + + diff --git a/docs/jsdoc/schemas_sign-request-base.generated.ts.html b/docs/jsdoc/schemas_sign-request-base.generated.ts.html index 4dae7f29..4fbc3040 100644 --- a/docs/jsdoc/schemas_sign-request-base.generated.ts.html +++ b/docs/jsdoc/schemas_sign-request-base.generated.ts.html @@ -115,13 +115,13 @@

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


- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard 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 496460cf..8083137c 100644 --- a/docs/jsdoc/schemas_sign-request-create-request.generated.ts.html +++ b/docs/jsdoc/schemas_sign-request-create-request.generated.ts.html @@ -38,8 +38,12 @@

Source: schemas/sign-request-create-request.generated.ts< */ source_files?: schemas.FileBase[]; /** - * Array of signers for the sign request. 35 is the - * max number of signers permitted. + * Force a specific color for the signature (blue, black, or red) + * Example: blue + */ + signature_color?: 'blue' | 'black' | 'red'; + /** + * Array of signers for the sign request. 35 is the max number of signers permitted. */ signers: schemas.SignRequestCreateSigner[]; } @@ -53,13 +57,13 @@

Source: schemas/sign-request-create-request.generated.ts<
- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard 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 8e6c8081..734b37b8 100644 --- a/docs/jsdoc/schemas_sign-request-create-signer.generated.ts.html +++ b/docs/jsdoc/schemas_sign-request-create-signer.generated.ts.html @@ -34,10 +34,11 @@

Source: schemas/sign-request-create-signer.generated.tsSource: schemas/sign-request-create-signer.generated.ts @@ -113,13 +121,13 @@

Source: schemas/sign-request-create-signer.generated.ts
- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard 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 e7ef41be..c8835b1a 100644 --- a/docs/jsdoc/schemas_sign-request-prefill-tag.generated.ts.html +++ b/docs/jsdoc/schemas_sign-request-prefill-tag.generated.ts.html @@ -51,7 +51,7 @@

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

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


- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard 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 bbf3d5f7..93b74d66 100644 --- a/docs/jsdoc/schemas_sign-request-signer-input.generated.ts.html +++ b/docs/jsdoc/schemas_sign-request-signer-input.generated.ts.html @@ -37,25 +37,27 @@

Source: schemas/sign-request-signer-input.generated.tsSource: schemas/sign-request-signer-input.generated.ts
- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/schemas_sign-request-signer.generated.ts.html b/docs/jsdoc/schemas_sign-request-signer.generated.ts.html index c4b35220..7a100f39 100644 --- a/docs/jsdoc/schemas_sign-request-signer.generated.ts.html +++ b/docs/jsdoc/schemas_sign-request-signer.generated.ts.html @@ -69,13 +69,13 @@

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


- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/schemas_sign-request.generated.ts.html b/docs/jsdoc/schemas_sign-request.generated.ts.html index 3d4581c9..02a23ddc 100644 --- a/docs/jsdoc/schemas_sign-request.generated.ts.html +++ b/docs/jsdoc/schemas_sign-request.generated.ts.html @@ -107,13 +107,13 @@

Source: schemas/sign-request.generated.ts


- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/schemas_sign-requests.generated.ts.html b/docs/jsdoc/schemas_sign-requests.generated.ts.html index 36b81d70..321e9416 100644 --- a/docs/jsdoc/schemas_sign-requests.generated.ts.html +++ b/docs/jsdoc/schemas_sign-requests.generated.ts.html @@ -28,7 +28,7 @@

Source: schemas/sign-requests.generated.ts

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

 	limit?: number;
 	/**
 	 * The marker for the start of the next page of results.
-	 * Example: 3000
+	 * Example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
 	 */
-	next_marker?: number;
-	/**
-	 * The marker for the start of the previous page of results.
-	 * Example: 1000
-	 */
-	prev_marker?: number;
+	next_marker?: string;
 	/**
 	 * A list of sign requests
 	 */
@@ -66,13 +61,13 @@ 
Source: schemas/sign-requests.generated.ts

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time)
+    Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
 

 
 
diff --git a/docs/jsdoc/schemas_sign-template.generated.ts.html b/docs/jsdoc/schemas_sign-template.generated.ts.html
index 4348d5aa..fbca7844 100644
--- a/docs/jsdoc/schemas_sign-template.generated.ts.html
+++ b/docs/jsdoc/schemas_sign-template.generated.ts.html
@@ -124,13 +124,13 @@ 
Source: schemas/sign-template.generated.ts

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time)
+    Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
 

 
 
diff --git a/docs/jsdoc/schemas_sign-templates.generated.ts.html b/docs/jsdoc/schemas_sign-templates.generated.ts.html
index 935f81db..a22f3bcb 100644
--- a/docs/jsdoc/schemas_sign-templates.generated.ts.html
+++ b/docs/jsdoc/schemas_sign-templates.generated.ts.html
@@ -35,14 +35,26 @@ 
Source: schemas/sign-templates.generated.ts

  */
 export interface SignTemplates {
 	/**
-	 * A list of templates.
+	 * The limit that was used for these entries. This will be the same as the
+	 * `limit` query parameter unless that value exceeded the maximum value
+	 * allowed. The maximum value varies by API.
+	 * Example: 1000
 	 */
-	entries?: schemas.SignTemplate[];
+	limit?: number;
 	/**
-	 * The marker for the start of the previous page of results.
+	 * The marker for the start of the next page of results.
 	 * Example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
 	 */
+	next_marker?: string;
+	/**
+	 * The marker for the start of the previous page of results.
+	 * Example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih
+	 */
 	prev_marker?: string;
+	/**
+	 * A list of templates.
+	 */
+	entries?: schemas.SignTemplate[];
 }
@@ -54,13 +66,13 @@

Source: schemas/sign-templates.generated.ts


- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/schemas_template-signer-input.generated.ts.html b/docs/jsdoc/schemas_template-signer-input.generated.ts.html index 686e8815..4b1d895e 100644 --- a/docs/jsdoc/schemas_template-signer-input.generated.ts.html +++ b/docs/jsdoc/schemas_template-signer-input.generated.ts.html @@ -37,7 +37,14 @@

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

* Type of input * Example: text */ - type?: 'signature' | 'date' | 'text' | 'checkbox' | 'radio' | 'dropdown'; + type?: + | 'signature' + | 'date' + | 'text' + | 'checkbox' + | 'attachment' + | 'radio' + | 'dropdown'; /** * Content type of input * Example: text @@ -91,6 +98,11 @@

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

* The size of the input. */ dimensions?: object; + /** + * The label field is used especially for text, attachment, radio, and checkbox type inputs. + * Example: Legal name + */ + label?: string; } @@ -102,13 +114,13 @@

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


- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/schemas_template-signer.generated.ts.html b/docs/jsdoc/schemas_template-signer.generated.ts.html index 5c79138e..b5f48e26 100644 --- a/docs/jsdoc/schemas_template-signer.generated.ts.html +++ b/docs/jsdoc/schemas_template-signer.generated.ts.html @@ -61,6 +61,13 @@

Source: schemas/template-signer.generated.ts

* Example: 2 */ order?: number; + /** + * If set, signers who have the same group ID will be assigned to the same input. + * A signer group is expected to have more than one signer. When a group contains fewer than two signers, + * it will be converted to a single signer and the group will be removed. + * Example: cd4ff89-8fc1-42cf-8b29-1890dedd26d7 + */ + signer_group_id?: string; } @@ -72,13 +79,13 @@

Source: schemas/template-signer.generated.ts


- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/schemas_user-base.generated.ts.html b/docs/jsdoc/schemas_user-base.generated.ts.html index f5dea444..1eaedc0c 100644 --- a/docs/jsdoc/schemas_user-base.generated.ts.html +++ b/docs/jsdoc/schemas_user-base.generated.ts.html @@ -55,13 +55,13 @@

Source: schemas/user-base.generated.ts


- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/schemas_user-integration-mappings.ts.html b/docs/jsdoc/schemas_user-integration-mappings.ts.html index 2374e14c..6af32d85 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/sessions_app-auth-session.ts.html b/docs/jsdoc/sessions_app-auth-session.ts.html index 98997a64..571976f1 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/sessions_basic-session.ts.html b/docs/jsdoc/sessions_basic-session.ts.html index ebdad64a..88c0e62a 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/sessions_ccg-session.ts.html b/docs/jsdoc/sessions_ccg-session.ts.html index abccc033..db219aaf 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/sessions_persistent-session.ts.html b/docs/jsdoc/sessions_persistent-session.ts.html index 7e875f4c..435a0956 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/token-manager.ts.html b/docs/jsdoc/token-manager.ts.html index ecbdf26e..ee3a9c09 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/util_config.ts.html b/docs/jsdoc/util_config.ts.html index 0cf0b9d5..a27d7a56 100644 --- a/docs/jsdoc/util_config.ts.html +++ b/docs/jsdoc/util_config.ts.html @@ -340,13 +340,13 @@

Source: util/config.ts


- Documentation generated by JSDoc 3.6.11 on Wed Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/util_errors.ts.html b/docs/jsdoc/util_errors.ts.html index ad9f9898..b407ba21 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/util_exponential-backoff.ts.html b/docs/jsdoc/util_exponential-backoff.ts.html index 87db70b6..30ed9a08 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/util_paging-iterator.ts.html b/docs/jsdoc/util_paging-iterator.ts.html index fe5923d6..bed06583 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/docs/jsdoc/util_url-path.ts.html b/docs/jsdoc/util_url-path.ts.html index dd850546..3e661c1f 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 Nov 08 2023 06:28:44 GMT-0800 (Pacific Standard Time) + Documentation generated by JSDoc 3.6.11 on Mon Feb 19 2024 02:53:34 GMT-0800 (Pacific Standard Time)
diff --git a/examples/app-auth/package.json b/examples/app-auth/package.json index aa4f9b55..20922808 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.4.2", + "box-node-sdk": "^3.5.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 e9c8d207..38e21007 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "box-node-sdk", - "version": "3.4.2", + "version": "3.5.0", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 68b58c5c..49fa5a1c 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "box-node-sdk", "author": "Box ", - "version": "3.4.2", + "version": "3.5.0", "description": "Official SDK for Box Plaform APIs", "license": "Apache-2.0", "repository": {