box-node-sdk 3.8.0 → 3.8.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +89 -69
- package/config/package.schema.json +42 -42
- package/lib/api-request-manager.d.ts +0 -2
- package/lib/api-request-manager.js.map +1 -1
- package/lib/api-request.d.ts +0 -3
- package/lib/api-request.js.map +1 -1
- package/lib/box-client.d.ts +7 -7
- package/lib/box-client.js +6 -3
- package/lib/box-client.js.map +1 -1
- package/lib/box-node-sdk.d.ts +1 -3
- package/lib/box-node-sdk.js +26 -10
- package/lib/box-node-sdk.js.map +1 -1
- package/lib/chunked-uploader.d.ts +0 -5
- package/lib/chunked-uploader.js.map +1 -1
- package/lib/enterprise-event-stream.d.ts +0 -1
- package/lib/enterprise-event-stream.js +3 -3
- package/lib/enterprise-event-stream.js.map +1 -1
- package/lib/event-stream.d.ts +0 -2
- package/lib/event-stream.js.map +1 -1
- package/lib/managers/ai.generated.js.map +1 -1
- package/lib/managers/collaboration-allowlist.js.map +1 -1
- package/lib/managers/collaborations.d.ts +3 -3
- package/lib/managers/collaborations.js +23 -23
- package/lib/managers/collaborations.js.map +1 -1
- package/lib/managers/collections.js.map +1 -1
- package/lib/managers/comments.js.map +1 -1
- package/lib/managers/device-pins.js.map +1 -1
- package/lib/managers/enterprise.js.map +1 -1
- package/lib/managers/events.d.ts +0 -1
- package/lib/managers/events.js +3 -1
- package/lib/managers/events.js.map +1 -1
- package/lib/managers/file-requests-manager.d.ts +2 -2
- package/lib/managers/file-requests-manager.js +1 -1
- package/lib/managers/file-requests-manager.js.map +1 -1
- package/lib/managers/files.d.ts +1 -4
- package/lib/managers/files.js +6 -2
- package/lib/managers/files.js.map +1 -1
- package/lib/managers/folders.d.ts +1 -1
- package/lib/managers/folders.js +3 -1
- package/lib/managers/folders.js.map +1 -1
- package/lib/managers/groups.js +2 -2
- package/lib/managers/groups.js.map +1 -1
- package/lib/managers/integration-mappings.js.map +1 -1
- package/lib/managers/legal-hold-policies.js.map +1 -1
- package/lib/managers/metadata.js.map +1 -1
- package/lib/managers/recent-items.js.map +1 -1
- package/lib/managers/retention-policies.d.ts +1 -1
- package/lib/managers/retention-policies.js.map +1 -1
- package/lib/managers/search.d.ts +1 -1
- package/lib/managers/search.js.map +1 -1
- package/lib/managers/shared-items.js.map +1 -1
- package/lib/managers/shield-information-barrier-reports.generated.js.map +1 -1
- package/lib/managers/shield-information-barrier-segment-members.generated.js.map +1 -1
- package/lib/managers/shield-information-barrier-segment-restrictions.generated.js.map +1 -1
- package/lib/managers/shield-information-barrier-segments.generated.js.map +1 -1
- package/lib/managers/shield-information-barriers.generated.js.map +1 -1
- package/lib/managers/sign-requests.generated.js.map +1 -1
- package/lib/managers/sign-templates.generated.js.map +1 -1
- package/lib/managers/storage-policies.js.map +1 -1
- package/lib/managers/tasks.js.map +1 -1
- package/lib/managers/terms-of-service.js.map +1 -1
- package/lib/managers/trash.js.map +1 -1
- package/lib/managers/users.d.ts +0 -3
- package/lib/managers/users.js +1 -1
- package/lib/managers/users.js.map +1 -1
- package/lib/managers/web-links.js +3 -1
- package/lib/managers/web-links.js.map +1 -1
- package/lib/managers/webhooks.d.ts +11 -11
- package/lib/managers/webhooks.js +24 -14
- package/lib/managers/webhooks.js.map +1 -1
- package/lib/schemas/collaboration-update.d.ts +1 -1
- package/lib/schemas/collaboration.d.ts +3 -3
- package/lib/schemas/collaborations.d.ts +1 -1
- package/lib/schemas/file-request.d.ts +2 -2
- package/lib/sessions/app-auth-session.js.map +1 -1
- package/lib/sessions/basic-session.d.ts +0 -1
- package/lib/sessions/basic-session.js.map +1 -1
- package/lib/sessions/ccg-session.js.map +1 -1
- package/lib/sessions/persistent-session.js.map +1 -1
- package/lib/token-manager.js +4 -2
- package/lib/token-manager.js.map +1 -1
- package/lib/util/config.d.ts +0 -2
- package/lib/util/config.js +18 -8
- package/lib/util/config.js.map +1 -1
- package/lib/util/errors.js +17 -7
- package/lib/util/errors.js.map +1 -1
- package/lib/util/exponential-backoff.js.map +1 -1
- package/lib/util/paging-iterator.js +17 -7
- package/lib/util/paging-iterator.js.map +1 -1
- package/lib/util/serializable.js.map +1 -1
- package/lib/util/url-path.js.map +1 -1
- package/lib-esm/api-request-manager.d.ts +36 -0
- package/lib-esm/api-request-manager.js +78 -0
- package/lib-esm/api-request-manager.js.map +1 -0
- package/lib-esm/api-request.d.ts +135 -0
- package/lib-esm/api-request.js +282 -0
- package/lib-esm/api-request.js.map +1 -0
- package/lib-esm/box-client.d.ts +274 -0
- package/lib-esm/box-client.js +594 -0
- package/lib-esm/box-client.js.map +1 -0
- package/lib-esm/box-node-sdk.d.ts +227 -0
- package/lib-esm/box-node-sdk.js +373 -0
- package/lib-esm/box-node-sdk.js.map +1 -0
- package/lib-esm/chunked-uploader.d.ts +128 -0
- package/lib-esm/chunked-uploader.js +276 -0
- package/lib-esm/chunked-uploader.js.map +1 -0
- package/lib-esm/enterprise-event-stream.d.ts +82 -0
- package/lib-esm/enterprise-event-stream.js +205 -0
- package/lib-esm/enterprise-event-stream.js.map +1 -0
- package/lib-esm/event-stream.d.ts +91 -0
- package/lib-esm/event-stream.js +277 -0
- package/lib-esm/event-stream.js.map +1 -0
- package/lib-esm/managers/ai.generated.d.ts +58 -0
- package/lib-esm/managers/ai.generated.js +66 -0
- package/lib-esm/managers/ai.generated.js.map +1 -0
- package/lib-esm/managers/collaboration-allowlist.d.ts +133 -0
- package/lib-esm/managers/collaboration-allowlist.js +194 -0
- package/lib-esm/managers/collaboration-allowlist.js.map +1 -0
- package/lib-esm/managers/collaborations.d.ts +173 -0
- package/lib-esm/managers/collaborations.js +252 -0
- package/lib-esm/managers/collaborations.js.map +1 -0
- package/lib-esm/managers/collections.d.ts +42 -0
- package/lib-esm/managers/collections.js +62 -0
- package/lib-esm/managers/collections.js.map +1 -0
- package/lib-esm/managers/comments.d.ts +103 -0
- package/lib-esm/managers/comments.js +175 -0
- package/lib-esm/managers/comments.js.map +1 -0
- package/lib-esm/managers/device-pins.d.ts +52 -0
- package/lib-esm/managers/device-pins.js +91 -0
- package/lib-esm/managers/device-pins.js.map +1 -0
- package/lib-esm/managers/enterprise.d.ts +164 -0
- package/lib-esm/managers/enterprise.js +193 -0
- package/lib-esm/managers/enterprise.js.map +1 -0
- package/lib-esm/managers/events.d.ts +222 -0
- package/lib-esm/managers/events.js +295 -0
- package/lib-esm/managers/events.js.map +1 -0
- package/lib-esm/managers/file-requests-manager.d.ts +56 -0
- package/lib-esm/managers/file-requests-manager.js +81 -0
- package/lib-esm/managers/file-requests-manager.js.map +1 -0
- package/lib-esm/managers/files.d.ts +817 -0
- package/lib-esm/managers/files.js +1408 -0
- package/lib-esm/managers/files.js.map +1 -0
- package/lib-esm/managers/folders.d.ts +396 -0
- package/lib-esm/managers/folders.js +570 -0
- package/lib-esm/managers/folders.js.map +1 -0
- package/lib-esm/managers/groups.d.ts +213 -0
- package/lib-esm/managers/groups.js +289 -0
- package/lib-esm/managers/groups.js.map +1 -0
- package/lib-esm/managers/integration-mappings.d.ts +116 -0
- package/lib-esm/managers/integration-mappings.js +101 -0
- package/lib-esm/managers/integration-mappings.js.map +1 -0
- package/lib-esm/managers/legal-hold-policies.d.ts +190 -0
- package/lib-esm/managers/legal-hold-policies.js +254 -0
- package/lib-esm/managers/legal-hold-policies.js.map +1 -0
- package/lib-esm/managers/metadata.d.ts +232 -0
- package/lib-esm/managers/metadata.js +288 -0
- package/lib-esm/managers/metadata.js.map +1 -0
- package/lib-esm/managers/recent-items.d.ts +38 -0
- package/lib-esm/managers/recent-items.js +49 -0
- package/lib-esm/managers/recent-items.js.map +1 -0
- package/lib-esm/managers/retention-policies.d.ts +308 -0
- package/lib-esm/managers/retention-policies.js +374 -0
- package/lib-esm/managers/retention-policies.js.map +1 -0
- package/lib-esm/managers/search.d.ts +82 -0
- package/lib-esm/managers/search.js +90 -0
- package/lib-esm/managers/search.js.map +1 -0
- package/lib-esm/managers/shared-items.d.ts +33 -0
- package/lib-esm/managers/shared-items.js +74 -0
- package/lib-esm/managers/shared-items.js.map +1 -0
- package/lib-esm/managers/shield-information-barrier-reports.generated.d.ts +65 -0
- package/lib-esm/managers/shield-information-barrier-reports.generated.js +65 -0
- package/lib-esm/managers/shield-information-barrier-reports.generated.js.map +1 -0
- package/lib-esm/managers/shield-information-barrier-segment-members.generated.d.ts +83 -0
- package/lib-esm/managers/shield-information-barrier-segment-members.generated.js +83 -0
- package/lib-esm/managers/shield-information-barrier-segment-members.generated.js.map +1 -0
- package/lib-esm/managers/shield-information-barrier-segment-restrictions.generated.d.ts +84 -0
- package/lib-esm/managers/shield-information-barrier-segment-restrictions.generated.js +84 -0
- package/lib-esm/managers/shield-information-barrier-segment-restrictions.generated.js.map +1 -0
- package/lib-esm/managers/shield-information-barrier-segments.generated.d.ts +98 -0
- package/lib-esm/managers/shield-information-barrier-segments.generated.js +99 -0
- package/lib-esm/managers/shield-information-barrier-segments.generated.js.map +1 -0
- package/lib-esm/managers/shield-information-barriers.generated.d.ts +79 -0
- package/lib-esm/managers/shield-information-barriers.generated.js +83 -0
- package/lib-esm/managers/shield-information-barriers.generated.js.map +1 -0
- package/lib-esm/managers/sign-requests.generated.d.ts +93 -0
- package/lib-esm/managers/sign-requests.generated.js +97 -0
- package/lib-esm/managers/sign-requests.generated.js.map +1 -0
- package/lib-esm/managers/sign-templates.generated.d.ts +51 -0
- package/lib-esm/managers/sign-templates.generated.js +49 -0
- package/lib-esm/managers/sign-templates.generated.js.map +1 -0
- package/lib-esm/managers/storage-policies.d.ts +86 -0
- package/lib-esm/managers/storage-policies.js +174 -0
- package/lib-esm/managers/storage-policies.js.map +1 -0
- package/lib-esm/managers/tasks.d.ts +161 -0
- package/lib-esm/managers/tasks.js +243 -0
- package/lib-esm/managers/tasks.js.map +1 -0
- package/lib-esm/managers/terms-of-service.d.ts +161 -0
- package/lib-esm/managers/terms-of-service.js +283 -0
- package/lib-esm/managers/terms-of-service.js.map +1 -0
- package/lib-esm/managers/trash.d.ts +30 -0
- package/lib-esm/managers/trash.js +47 -0
- package/lib-esm/managers/trash.js.map +1 -0
- package/lib-esm/managers/users.d.ts +171 -0
- package/lib-esm/managers/users.js +230 -0
- package/lib-esm/managers/users.js.map +1 -0
- package/lib-esm/managers/web-links.d.ts +127 -0
- package/lib-esm/managers/web-links.js +200 -0
- package/lib-esm/managers/web-links.js.map +1 -0
- package/lib-esm/managers/webhooks.d.ts +169 -0
- package/lib-esm/managers/webhooks.js +398 -0
- package/lib-esm/managers/webhooks.js.map +1 -0
- package/lib-esm/schemas/ai-agent-ask.generated.d.ts +17 -0
- package/lib-esm/schemas/ai-agent-ask.generated.js +3 -0
- package/lib-esm/schemas/ai-agent-ask.generated.js.map +1 -0
- package/lib-esm/schemas/ai-agent-basic-gen-tool.generated.d.ts +14 -0
- package/lib-esm/schemas/ai-agent-basic-gen-tool.generated.js +3 -0
- package/lib-esm/schemas/ai-agent-basic-gen-tool.generated.js.map +1 -0
- package/lib-esm/schemas/ai-agent-basic-text-tool-ask.generated.d.ts +34 -0
- package/lib-esm/schemas/ai-agent-basic-text-tool-ask.generated.js +3 -0
- package/lib-esm/schemas/ai-agent-basic-text-tool-ask.generated.js.map +1 -0
- package/lib-esm/schemas/ai-agent-basic-text-tool-text-gen.generated.d.ts +36 -0
- package/lib-esm/schemas/ai-agent-basic-text-tool-text-gen.generated.js +3 -0
- package/lib-esm/schemas/ai-agent-basic-text-tool-text-gen.generated.js.map +1 -0
- package/lib-esm/schemas/ai-agent-long-text-tool.generated.d.ts +9 -0
- package/lib-esm/schemas/ai-agent-long-text-tool.generated.js +3 -0
- package/lib-esm/schemas/ai-agent-long-text-tool.generated.js.map +1 -0
- package/lib-esm/schemas/ai-agent-text-gen.generated.d.ts +14 -0
- package/lib-esm/schemas/ai-agent-text-gen.generated.js +3 -0
- package/lib-esm/schemas/ai-agent-text-gen.generated.js.map +1 -0
- package/lib-esm/schemas/ai-ask.generated.d.ts +40 -0
- package/lib-esm/schemas/ai-ask.generated.js +3 -0
- package/lib-esm/schemas/ai-ask.generated.js.map +1 -0
- package/lib-esm/schemas/ai-citation.generated.d.ts +27 -0
- package/lib-esm/schemas/ai-citation.generated.js +3 -0
- package/lib-esm/schemas/ai-citation.generated.js.map +1 -0
- package/lib-esm/schemas/ai-dialogue-history.generated.d.ts +22 -0
- package/lib-esm/schemas/ai-dialogue-history.generated.js +3 -0
- package/lib-esm/schemas/ai-dialogue-history.generated.js.map +1 -0
- package/lib-esm/schemas/ai-llm-endpoint-params-google.generated.d.ts +31 -0
- package/lib-esm/schemas/ai-llm-endpoint-params-google.generated.js +3 -0
- package/lib-esm/schemas/ai-llm-endpoint-params-google.generated.js.map +1 -0
- package/lib-esm/schemas/ai-llm-endpoint-params-open-ai.generated.d.ts +43 -0
- package/lib-esm/schemas/ai-llm-endpoint-params-open-ai.generated.js +3 -0
- package/lib-esm/schemas/ai-llm-endpoint-params-open-ai.generated.js.map +1 -0
- package/lib-esm/schemas/ai-response-full.generated.d.ts +12 -0
- package/lib-esm/schemas/ai-response-full.generated.js +3 -0
- package/lib-esm/schemas/ai-response-full.generated.js.map +1 -0
- package/lib-esm/schemas/ai-response.generated.d.ts +22 -0
- package/lib-esm/schemas/ai-response.generated.js +3 -0
- package/lib-esm/schemas/ai-response.generated.js.map +1 -0
- package/lib-esm/schemas/ai-text-gen.generated.d.ts +30 -0
- package/lib-esm/schemas/ai-text-gen.generated.js +3 -0
- package/lib-esm/schemas/ai-text-gen.generated.js.map +1 -0
- package/lib-esm/schemas/collaboration-create.d.ts +5 -0
- package/lib-esm/schemas/collaboration-create.js +3 -0
- package/lib-esm/schemas/collaboration-create.js.map +1 -0
- package/lib-esm/schemas/collaboration-update.d.ts +7 -0
- package/lib-esm/schemas/collaboration-update.js +3 -0
- package/lib-esm/schemas/collaboration-update.js.map +1 -0
- package/lib-esm/schemas/collaboration.d.ts +108 -0
- package/lib-esm/schemas/collaboration.js +3 -0
- package/lib-esm/schemas/collaboration.js.map +1 -0
- package/lib-esm/schemas/collaborations.d.ts +13 -0
- package/lib-esm/schemas/collaborations.js +3 -0
- package/lib-esm/schemas/collaborations.js.map +1 -0
- package/lib-esm/schemas/enterprise-base.generated.d.ts +18 -0
- package/lib-esm/schemas/enterprise-base.generated.js +3 -0
- package/lib-esm/schemas/enterprise-base.generated.js.map +1 -0
- package/lib-esm/schemas/file-base.generated.d.ts +32 -0
- package/lib-esm/schemas/file-base.generated.js +3 -0
- package/lib-esm/schemas/file-base.generated.js.map +1 -0
- package/lib-esm/schemas/file-mini.generated.d.ts +41 -0
- package/lib-esm/schemas/file-mini.generated.js +3 -0
- package/lib-esm/schemas/file-mini.generated.js.map +1 -0
- package/lib-esm/schemas/file-request.d.ts +41 -0
- package/lib-esm/schemas/file-request.js +3 -0
- package/lib-esm/schemas/file-request.js.map +1 -0
- package/lib-esm/schemas/file-version-base.generated.d.ts +19 -0
- package/lib-esm/schemas/file-version-base.generated.js +3 -0
- package/lib-esm/schemas/file-version-base.generated.js.map +1 -0
- package/lib-esm/schemas/file-version-mini.generated.d.ts +14 -0
- package/lib-esm/schemas/file-version-mini.generated.js +3 -0
- package/lib-esm/schemas/file-version-mini.generated.js.map +1 -0
- package/lib-esm/schemas/folder-base.generated.d.ts +32 -0
- package/lib-esm/schemas/folder-base.generated.js +3 -0
- package/lib-esm/schemas/folder-base.generated.js.map +1 -0
- package/lib-esm/schemas/folder-mini.generated.d.ts +31 -0
- package/lib-esm/schemas/folder-mini.generated.js +3 -0
- package/lib-esm/schemas/folder-mini.generated.js.map +1 -0
- package/lib-esm/schemas/index.d.ts +15 -0
- package/lib-esm/schemas/index.generated.d.ts +52 -0
- package/lib-esm/schemas/index.generated.js +69 -0
- package/lib-esm/schemas/index.generated.js.map +1 -0
- package/lib-esm/schemas/index.js +32 -0
- package/lib-esm/schemas/index.js.map +1 -0
- package/lib-esm/schemas/integration-mapping-base.d.ts +23 -0
- package/lib-esm/schemas/integration-mapping-base.js +3 -0
- package/lib-esm/schemas/integration-mapping-base.js.map +1 -0
- package/lib-esm/schemas/integration-mapping-box-item-slack.d.ts +17 -0
- package/lib-esm/schemas/integration-mapping-box-item-slack.js +3 -0
- package/lib-esm/schemas/integration-mapping-box-item-slack.js.map +1 -0
- package/lib-esm/schemas/integration-mapping-partner-item-slack.d.ts +27 -0
- package/lib-esm/schemas/integration-mapping-partner-item-slack.js +3 -0
- package/lib-esm/schemas/integration-mapping-partner-item-slack.js.map +1 -0
- package/lib-esm/schemas/integration-mapping-slack-create-request.d.ts +12 -0
- package/lib-esm/schemas/integration-mapping-slack-create-request.js +3 -0
- package/lib-esm/schemas/integration-mapping-slack-create-request.js.map +1 -0
- package/lib-esm/schemas/integration-mapping-slack-options.d.ts +16 -0
- package/lib-esm/schemas/integration-mapping-slack-options.js +3 -0
- package/lib-esm/schemas/integration-mapping-slack-options.js.map +1 -0
- package/lib-esm/schemas/integration-mapping.d.ts +55 -0
- package/lib-esm/schemas/integration-mapping.js +3 -0
- package/lib-esm/schemas/integration-mapping.js.map +1 -0
- package/lib-esm/schemas/integration-mappings.d.ts +27 -0
- package/lib-esm/schemas/integration-mappings.js +3 -0
- package/lib-esm/schemas/integration-mappings.js.map +1 -0
- package/lib-esm/schemas/shield-information-barrier-base.generated.d.ts +18 -0
- package/lib-esm/schemas/shield-information-barrier-base.generated.js +3 -0
- package/lib-esm/schemas/shield-information-barrier-base.generated.js.map +1 -0
- package/lib-esm/schemas/shield-information-barrier-reference.generated.d.ts +9 -0
- package/lib-esm/schemas/shield-information-barrier-reference.generated.js +3 -0
- package/lib-esm/schemas/shield-information-barrier-reference.generated.js.map +1 -0
- package/lib-esm/schemas/shield-information-barrier-report-base.generated.d.ts +18 -0
- package/lib-esm/schemas/shield-information-barrier-report-base.generated.js +3 -0
- package/lib-esm/schemas/shield-information-barrier-report-base.generated.js.map +1 -0
- package/lib-esm/schemas/shield-information-barrier-report-details.generated.d.ts +9 -0
- package/lib-esm/schemas/shield-information-barrier-report-details.generated.js +3 -0
- package/lib-esm/schemas/shield-information-barrier-report-details.generated.js.map +1 -0
- package/lib-esm/schemas/shield-information-barrier-report.generated.d.ts +32 -0
- package/lib-esm/schemas/shield-information-barrier-report.generated.js +3 -0
- package/lib-esm/schemas/shield-information-barrier-report.generated.js.map +1 -0
- package/lib-esm/schemas/shield-information-barrier-reports.generated.d.ts +26 -0
- package/lib-esm/schemas/shield-information-barrier-reports.generated.js +3 -0
- package/lib-esm/schemas/shield-information-barrier-reports.generated.js.map +1 -0
- package/lib-esm/schemas/shield-information-barrier-segment-member-base.generated.d.ts +19 -0
- package/lib-esm/schemas/shield-information-barrier-segment-member-base.generated.js +3 -0
- package/lib-esm/schemas/shield-information-barrier-segment-member-base.generated.js.map +1 -0
- package/lib-esm/schemas/shield-information-barrier-segment-member-mini.generated.d.ts +13 -0
- package/lib-esm/schemas/shield-information-barrier-segment-member-mini.generated.js +3 -0
- package/lib-esm/schemas/shield-information-barrier-segment-member-mini.generated.js.map +1 -0
- package/lib-esm/schemas/shield-information-barrier-segment-member.generated.d.ts +39 -0
- package/lib-esm/schemas/shield-information-barrier-segment-member.generated.js +3 -0
- package/lib-esm/schemas/shield-information-barrier-segment-member.generated.js.map +1 -0
- package/lib-esm/schemas/shield-information-barrier-segment-members.generated.d.ts +26 -0
- package/lib-esm/schemas/shield-information-barrier-segment-members.generated.js +3 -0
- package/lib-esm/schemas/shield-information-barrier-segment-members.generated.js.map +1 -0
- package/lib-esm/schemas/shield-information-barrier-segment-restriction-base.generated.d.ts +20 -0
- package/lib-esm/schemas/shield-information-barrier-segment-restriction-base.generated.js +3 -0
- package/lib-esm/schemas/shield-information-barrier-segment-restriction-base.generated.js.map +1 -0
- package/lib-esm/schemas/shield-information-barrier-segment-restriction-mini.generated.d.ts +20 -0
- package/lib-esm/schemas/shield-information-barrier-segment-restriction-mini.generated.js +3 -0
- package/lib-esm/schemas/shield-information-barrier-segment-restriction-mini.generated.js.map +1 -0
- package/lib-esm/schemas/shield-information-barrier-segment-restriction.generated.d.ts +33 -0
- package/lib-esm/schemas/shield-information-barrier-segment-restriction.generated.js +3 -0
- package/lib-esm/schemas/shield-information-barrier-segment-restriction.generated.js.map +1 -0
- package/lib-esm/schemas/shield-information-barrier-segment-restrictions.generated.d.ts +26 -0
- package/lib-esm/schemas/shield-information-barrier-segment-restrictions.generated.js +3 -0
- package/lib-esm/schemas/shield-information-barrier-segment-restrictions.generated.js.map +1 -0
- package/lib-esm/schemas/shield-information-barrier-segment.generated.d.ts +50 -0
- package/lib-esm/schemas/shield-information-barrier-segment.generated.js +3 -0
- package/lib-esm/schemas/shield-information-barrier-segment.generated.js.map +1 -0
- package/lib-esm/schemas/shield-information-barrier-segments.generated.d.ts +26 -0
- package/lib-esm/schemas/shield-information-barrier-segments.generated.js +3 -0
- package/lib-esm/schemas/shield-information-barrier-segments.generated.js.map +1 -0
- package/lib-esm/schemas/shield-information-barrier.generated.d.ts +56 -0
- package/lib-esm/schemas/shield-information-barrier.generated.js +3 -0
- package/lib-esm/schemas/shield-information-barrier.generated.js.map +1 -0
- package/lib-esm/schemas/shield-information-barriers.generated.d.ts +25 -0
- package/lib-esm/schemas/shield-information-barriers.generated.js +3 -0
- package/lib-esm/schemas/shield-information-barriers.generated.js.map +1 -0
- package/lib-esm/schemas/sign-request-base.generated.d.ts +78 -0
- package/lib-esm/schemas/sign-request-base.generated.js +3 -0
- package/lib-esm/schemas/sign-request-base.generated.js.map +1 -0
- package/lib-esm/schemas/sign-request-create-request.generated.d.ts +39 -0
- package/lib-esm/schemas/sign-request-create-request.generated.js +3 -0
- package/lib-esm/schemas/sign-request-create-request.generated.js.map +1 -0
- package/lib-esm/schemas/sign-request-create-signer.generated.d.ts +95 -0
- package/lib-esm/schemas/sign-request-create-signer.generated.js +3 -0
- package/lib-esm/schemas/sign-request-create-signer.generated.js.map +1 -0
- package/lib-esm/schemas/sign-request-prefill-tag.generated.d.ts +28 -0
- package/lib-esm/schemas/sign-request-prefill-tag.generated.js +3 -0
- package/lib-esm/schemas/sign-request-prefill-tag.generated.js.map +1 -0
- package/lib-esm/schemas/sign-request-signer-input.generated.d.ts +28 -0
- package/lib-esm/schemas/sign-request-signer-input.generated.js +3 -0
- package/lib-esm/schemas/sign-request-signer-input.generated.js.map +1 -0
- package/lib-esm/schemas/sign-request-signer.generated.d.ts +34 -0
- package/lib-esm/schemas/sign-request-signer.generated.js +3 -0
- package/lib-esm/schemas/sign-request-signer.generated.js.map +1 -0
- package/lib-esm/schemas/sign-request.generated.d.ts +72 -0
- package/lib-esm/schemas/sign-request.generated.js +3 -0
- package/lib-esm/schemas/sign-request.generated.js.map +1 -0
- package/lib-esm/schemas/sign-requests.generated.d.ts +25 -0
- package/lib-esm/schemas/sign-requests.generated.js +3 -0
- package/lib-esm/schemas/sign-requests.generated.js.map +1 -0
- package/lib-esm/schemas/sign-template.generated.d.ts +94 -0
- package/lib-esm/schemas/sign-template.generated.js +3 -0
- package/lib-esm/schemas/sign-template.generated.js.map +1 -0
- package/lib-esm/schemas/sign-templates.generated.d.ts +30 -0
- package/lib-esm/schemas/sign-templates.generated.js +3 -0
- package/lib-esm/schemas/sign-templates.generated.js.map +1 -0
- package/lib-esm/schemas/template-signer-input.generated.d.ts +61 -0
- package/lib-esm/schemas/template-signer-input.generated.js +3 -0
- package/lib-esm/schemas/template-signer-input.generated.js.map +1 -0
- package/lib-esm/schemas/template-signer.generated.d.ts +43 -0
- package/lib-esm/schemas/template-signer.generated.js +3 -0
- package/lib-esm/schemas/template-signer.generated.js.map +1 -0
- package/lib-esm/schemas/user-base.generated.d.ts +18 -0
- package/lib-esm/schemas/user-base.generated.js +3 -0
- package/lib-esm/schemas/user-base.generated.js.map +1 -0
- package/lib-esm/schemas/user-integration-mappings.d.ts +19 -0
- package/lib-esm/schemas/user-integration-mappings.js +3 -0
- package/lib-esm/schemas/user-integration-mappings.js.map +1 -0
- package/lib-esm/schemas/user-mini.d.ts +6 -0
- package/lib-esm/schemas/user-mini.js +3 -0
- package/lib-esm/schemas/user-mini.js.map +1 -0
- package/lib-esm/sessions/app-auth-session.d.ts +92 -0
- package/lib-esm/sessions/app-auth-session.js +176 -0
- package/lib-esm/sessions/app-auth-session.js.map +1 -0
- package/lib-esm/sessions/basic-session.d.ts +55 -0
- package/lib-esm/sessions/basic-session.js +62 -0
- package/lib-esm/sessions/basic-session.js.map +1 -0
- package/lib-esm/sessions/ccg-session.d.ts +72 -0
- package/lib-esm/sessions/ccg-session.js +111 -0
- package/lib-esm/sessions/ccg-session.js.map +1 -0
- package/lib-esm/sessions/persistent-session.d.ts +96 -0
- package/lib-esm/sessions/persistent-session.js +234 -0
- package/lib-esm/sessions/persistent-session.js.map +1 -0
- package/lib-esm/token-manager.d.ts +191 -0
- package/lib-esm/token-manager.js +453 -0
- package/lib-esm/token-manager.js.map +1 -0
- package/lib-esm/util/config.d.ts +85 -0
- package/lib-esm/util/config.js +212 -0
- package/lib-esm/util/config.js.map +1 -0
- package/lib-esm/util/errors.d.ts +50 -0
- package/lib-esm/util/errors.js +176 -0
- package/lib-esm/util/errors.js.map +1 -0
- package/lib-esm/util/exponential-backoff.d.ts +11 -0
- package/lib-esm/util/exponential-backoff.js +17 -0
- package/lib-esm/util/exponential-backoff.js.map +1 -0
- package/lib-esm/util/paging-iterator.d.ts +53 -0
- package/lib-esm/util/paging-iterator.js +247 -0
- package/lib-esm/util/paging-iterator.js.map +1 -0
- package/lib-esm/util/serializable.d.ts +10 -0
- package/lib-esm/util/serializable.js +17 -0
- package/lib-esm/util/serializable.js.map +1 -0
- package/lib-esm/util/url-path.d.ts +16 -0
- package/lib-esm/util/url-path.js +36 -0
- package/lib-esm/util/url-path.js.map +1 -0
- package/package.json +33 -28
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
import BoxClient from '../box-client';
|
|
2
|
+
import * as schemas from '../schemas';
|
|
3
|
+
/**
|
|
4
|
+
*/
|
|
5
|
+
declare class ShieldInformationBarrierSegmentsManager {
|
|
6
|
+
client: BoxClient;
|
|
7
|
+
/**
|
|
8
|
+
* @param {BoxClient} client The Box API Client that is responsible for making calls to the API
|
|
9
|
+
*/
|
|
10
|
+
constructor(client: BoxClient);
|
|
11
|
+
/**
|
|
12
|
+
* Get shield information barrier segment with specified ID
|
|
13
|
+
*
|
|
14
|
+
* Retrieves shield information barrier segment based on provided ID..
|
|
15
|
+
* @param {object} options Options for the request
|
|
16
|
+
* @param {string} options.shield_information_barrier_segment_id The ID of the shield information barrier segment.
|
|
17
|
+
* @param {Function} [callback] Passed the result if successful, error otherwise
|
|
18
|
+
* @returns {Promise<schemas.ShieldInformationBarrierSegment>} A promise resolving to the result or rejecting with an error
|
|
19
|
+
*/
|
|
20
|
+
getById(options: {
|
|
21
|
+
/**
|
|
22
|
+
* The ID of the shield information barrier segment.
|
|
23
|
+
*/
|
|
24
|
+
readonly shield_information_barrier_segment_id: string;
|
|
25
|
+
}, callback?: Function): Promise<schemas.ShieldInformationBarrierSegment>;
|
|
26
|
+
/**
|
|
27
|
+
* List shield information barrier segments
|
|
28
|
+
*
|
|
29
|
+
* Retrieves a list of shield information barrier segment objects
|
|
30
|
+
* for the specified Information Barrier ID.
|
|
31
|
+
* @param {object} options Options for the request
|
|
32
|
+
* @param {string} options.shield_information_barrier_id The ID of the shield information barrier.
|
|
33
|
+
* @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`.
|
|
34
|
+
* @param {number} [options.limit] The maximum number of items to return per page.
|
|
35
|
+
* @param {Function} [callback] Passed the result if successful, error otherwise
|
|
36
|
+
* @returns {Promise<schemas.ShieldInformationBarrierSegments>} A promise resolving to the result or rejecting with an error
|
|
37
|
+
*/
|
|
38
|
+
getAll(options: {
|
|
39
|
+
/**
|
|
40
|
+
* The ID of the shield information barrier.
|
|
41
|
+
*/
|
|
42
|
+
readonly shield_information_barrier_id: string;
|
|
43
|
+
/**
|
|
44
|
+
* Defines the position marker at which to begin returning results. This is
|
|
45
|
+
* used when paginating using marker-based pagination.
|
|
46
|
+
*
|
|
47
|
+
* This requires `usemarker` to be set to `true`.
|
|
48
|
+
*/
|
|
49
|
+
readonly marker?: string;
|
|
50
|
+
/**
|
|
51
|
+
* The maximum number of items to return per page.
|
|
52
|
+
*/
|
|
53
|
+
readonly limit?: number;
|
|
54
|
+
}, callback?: Function): Promise<schemas.ShieldInformationBarrierSegments>;
|
|
55
|
+
/**
|
|
56
|
+
* Create shield information barrier segment
|
|
57
|
+
*
|
|
58
|
+
* Creates a shield information barrier segment.
|
|
59
|
+
* @param {object} body
|
|
60
|
+
* @param {object} [options] Options for the request
|
|
61
|
+
* @param {Function} [callback] Passed the result if successful, error otherwise
|
|
62
|
+
* @returns {Promise<schemas.ShieldInformationBarrierSegment>} A promise resolving to the result or rejecting with an error
|
|
63
|
+
*/
|
|
64
|
+
create(body: object, options?: {}, callback?: Function): Promise<schemas.ShieldInformationBarrierSegment>;
|
|
65
|
+
/**
|
|
66
|
+
* Update shield information barrier segment with specified ID
|
|
67
|
+
*
|
|
68
|
+
* Updates the shield information barrier segment based on provided ID..
|
|
69
|
+
* @param {object} body
|
|
70
|
+
* @param {object} options Options for the request
|
|
71
|
+
* @param {string} options.shield_information_barrier_segment_id The ID of the shield information barrier segment.
|
|
72
|
+
* @param {Function} [callback] Passed the result if successful, error otherwise
|
|
73
|
+
* @returns {Promise<schemas.ShieldInformationBarrierSegment>} A promise resolving to the result or rejecting with an error
|
|
74
|
+
*/
|
|
75
|
+
update(body: object, options: {
|
|
76
|
+
/**
|
|
77
|
+
* The ID of the shield information barrier segment.
|
|
78
|
+
*/
|
|
79
|
+
readonly shield_information_barrier_segment_id: string;
|
|
80
|
+
}, callback?: Function): Promise<schemas.ShieldInformationBarrierSegment>;
|
|
81
|
+
/**
|
|
82
|
+
* Delete shield information barrier segment
|
|
83
|
+
*
|
|
84
|
+
* Deletes the shield information barrier segment
|
|
85
|
+
* based on provided ID.
|
|
86
|
+
* @param {object} options Options for the request
|
|
87
|
+
* @param {string} options.shield_information_barrier_segment_id The ID of the shield information barrier segment.
|
|
88
|
+
* @param {Function} [callback] Passed the result if successful, error otherwise
|
|
89
|
+
* @returns {Promise<void>} A promise resolving to the result or rejecting with an error
|
|
90
|
+
*/
|
|
91
|
+
deleteById(options: {
|
|
92
|
+
/**
|
|
93
|
+
* The ID of the shield information barrier segment.
|
|
94
|
+
*/
|
|
95
|
+
readonly shield_information_barrier_segment_id: string;
|
|
96
|
+
}, callback?: Function): Promise<void>;
|
|
97
|
+
}
|
|
98
|
+
export = ShieldInformationBarrierSegmentsManager;
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
const url_path_1 = __importDefault(require("../util/url-path"));
|
|
6
|
+
/**
|
|
7
|
+
*/
|
|
8
|
+
class ShieldInformationBarrierSegmentsManager {
|
|
9
|
+
/**
|
|
10
|
+
* @param {BoxClient} client The Box API Client that is responsible for making calls to the API
|
|
11
|
+
*/
|
|
12
|
+
constructor(client) {
|
|
13
|
+
this.client = client;
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* Get shield information barrier segment with specified ID
|
|
17
|
+
*
|
|
18
|
+
* Retrieves shield information barrier segment based on provided ID..
|
|
19
|
+
* @param {object} options Options for the request
|
|
20
|
+
* @param {string} options.shield_information_barrier_segment_id The ID of the shield information barrier segment.
|
|
21
|
+
* @param {Function} [callback] Passed the result if successful, error otherwise
|
|
22
|
+
* @returns {Promise<schemas.ShieldInformationBarrierSegment>} A promise resolving to the result or rejecting with an error
|
|
23
|
+
*/
|
|
24
|
+
getById(options, callback) {
|
|
25
|
+
const { shield_information_barrier_segment_id: shieldInformationBarrierSegmentId, ...queryParams } = options, apiPath = (0, url_path_1.default)('shield_information_barrier_segments', shieldInformationBarrierSegmentId), params = {
|
|
26
|
+
qs: queryParams,
|
|
27
|
+
};
|
|
28
|
+
return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* List shield information barrier segments
|
|
32
|
+
*
|
|
33
|
+
* Retrieves a list of shield information barrier segment objects
|
|
34
|
+
* for the specified Information Barrier ID.
|
|
35
|
+
* @param {object} options Options for the request
|
|
36
|
+
* @param {string} options.shield_information_barrier_id The ID of the shield information barrier.
|
|
37
|
+
* @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`.
|
|
38
|
+
* @param {number} [options.limit] The maximum number of items to return per page.
|
|
39
|
+
* @param {Function} [callback] Passed the result if successful, error otherwise
|
|
40
|
+
* @returns {Promise<schemas.ShieldInformationBarrierSegments>} A promise resolving to the result or rejecting with an error
|
|
41
|
+
*/
|
|
42
|
+
getAll(options, callback) {
|
|
43
|
+
const { ...queryParams } = options, apiPath = (0, url_path_1.default)('shield_information_barrier_segments'), params = {
|
|
44
|
+
qs: queryParams,
|
|
45
|
+
};
|
|
46
|
+
return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* Create shield information barrier segment
|
|
50
|
+
*
|
|
51
|
+
* Creates a shield information barrier segment.
|
|
52
|
+
* @param {object} body
|
|
53
|
+
* @param {object} [options] Options for the request
|
|
54
|
+
* @param {Function} [callback] Passed the result if successful, error otherwise
|
|
55
|
+
* @returns {Promise<schemas.ShieldInformationBarrierSegment>} A promise resolving to the result or rejecting with an error
|
|
56
|
+
*/
|
|
57
|
+
create(body, options, callback) {
|
|
58
|
+
const { ...queryParams } = options, apiPath = (0, url_path_1.default)('shield_information_barrier_segments'), params = {
|
|
59
|
+
qs: queryParams,
|
|
60
|
+
body: body,
|
|
61
|
+
};
|
|
62
|
+
return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
|
|
63
|
+
}
|
|
64
|
+
/**
|
|
65
|
+
* Update shield information barrier segment with specified ID
|
|
66
|
+
*
|
|
67
|
+
* Updates the shield information barrier segment based on provided ID..
|
|
68
|
+
* @param {object} body
|
|
69
|
+
* @param {object} options Options for the request
|
|
70
|
+
* @param {string} options.shield_information_barrier_segment_id The ID of the shield information barrier segment.
|
|
71
|
+
* @param {Function} [callback] Passed the result if successful, error otherwise
|
|
72
|
+
* @returns {Promise<schemas.ShieldInformationBarrierSegment>} A promise resolving to the result or rejecting with an error
|
|
73
|
+
*/
|
|
74
|
+
update(body, options, callback) {
|
|
75
|
+
const { shield_information_barrier_segment_id: shieldInformationBarrierSegmentId, ...queryParams } = options, apiPath = (0, url_path_1.default)('shield_information_barrier_segments', shieldInformationBarrierSegmentId), params = {
|
|
76
|
+
qs: queryParams,
|
|
77
|
+
body: body,
|
|
78
|
+
};
|
|
79
|
+
return this.client.wrapWithDefaultHandler(this.client.put)(apiPath, params, callback);
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* Delete shield information barrier segment
|
|
83
|
+
*
|
|
84
|
+
* Deletes the shield information barrier segment
|
|
85
|
+
* based on provided ID.
|
|
86
|
+
* @param {object} options Options for the request
|
|
87
|
+
* @param {string} options.shield_information_barrier_segment_id The ID of the shield information barrier segment.
|
|
88
|
+
* @param {Function} [callback] Passed the result if successful, error otherwise
|
|
89
|
+
* @returns {Promise<void>} A promise resolving to the result or rejecting with an error
|
|
90
|
+
*/
|
|
91
|
+
deleteById(options, callback) {
|
|
92
|
+
const { shield_information_barrier_segment_id: shieldInformationBarrierSegmentId, ...queryParams } = options, apiPath = (0, url_path_1.default)('shield_information_barrier_segments', shieldInformationBarrierSegmentId), params = {
|
|
93
|
+
qs: queryParams,
|
|
94
|
+
};
|
|
95
|
+
return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, params, callback);
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
module.exports = ShieldInformationBarrierSegmentsManager;
|
|
99
|
+
//# sourceMappingURL=shield-information-barrier-segments.generated.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"shield-information-barrier-segments.generated.js","sourceRoot":"","sources":["../../src/managers/shield-information-barrier-segments.generated.ts"],"names":[],"mappings":";;;;AACA,gEAAuC;AAEvC;GACG;AACH,MAAM,uCAAuC;IAE3C;;OAEG;IACH,YAAY,MAAiB;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IACD;;;;;;;;OAQG;IACH,OAAO,CACL,OAKC,EACD,QAAmB;QAEnB,MAAM,EACF,qCAAqC,EACnC,iCAAiC,EACnC,GAAG,WAAW,EACf,GAAG,OAAO,EACX,OAAO,GAAG,IAAA,kBAAO,EACf,qCAAqC,EACrC,iCAAiC,CAClC,EACD,MAAM,GAAG;YACP,EAAE,EAAE,WAAW;SAChB,CAAC;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IACD;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,OAgBC,EACD,QAAmB;QAEnB,MAAM,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,EAChC,OAAO,GAAG,IAAA,kBAAO,EAAC,qCAAqC,CAAC,EACxD,MAAM,GAAG;YACP,EAAE,EAAE,WAAW;SAChB,CAAC;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IACD;;;;;;;;OAQG;IACH,MAAM,CACJ,IAAY,EACZ,OAAY,EACZ,QAAmB;QAEnB,MAAM,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,EAChC,OAAO,GAAG,IAAA,kBAAO,EAAC,qCAAqC,CAAC,EACxD,MAAM,GAAG;YACP,EAAE,EAAE,WAAW;YACf,IAAI,EAAE,IAAI;SACX,CAAC;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IACD;;;;;;;;;OASG;IACH,MAAM,CACJ,IAAY,EACZ,OAKC,EACD,QAAmB;QAEnB,MAAM,EACF,qCAAqC,EACnC,iCAAiC,EACnC,GAAG,WAAW,EACf,GAAG,OAAO,EACX,OAAO,GAAG,IAAA,kBAAO,EACf,qCAAqC,EACrC,iCAAiC,CAClC,EACD,MAAM,GAAG;YACP,EAAE,EAAE,WAAW;YACf,IAAI,EAAE,IAAI;SACX,CAAC;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IACD;;;;;;;;;OASG;IACH,UAAU,CACR,OAKC,EACD,QAAmB;QAEnB,MAAM,EACF,qCAAqC,EACnC,iCAAiC,EACnC,GAAG,WAAW,EACf,GAAG,OAAO,EACX,OAAO,GAAG,IAAA,kBAAO,EACf,qCAAqC,EACrC,iCAAiC,CAClC,EACD,MAAM,GAAG;YACP,EAAE,EAAE,WAAW;SAChB,CAAC;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;CACF;AACD,iBAAS,uCAAuC,CAAC"}
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
import BoxClient from '../box-client';
|
|
2
|
+
import * as schemas from '../schemas';
|
|
3
|
+
/**
|
|
4
|
+
*/
|
|
5
|
+
declare class ShieldInformationBarrierManager {
|
|
6
|
+
client: BoxClient;
|
|
7
|
+
/**
|
|
8
|
+
* @param {BoxClient} client The Box API Client that is responsible for making calls to the API
|
|
9
|
+
*/
|
|
10
|
+
constructor(client: BoxClient);
|
|
11
|
+
/**
|
|
12
|
+
* Get shield information barrier with specified ID
|
|
13
|
+
*
|
|
14
|
+
* Get shield information barrier based on provided ID.
|
|
15
|
+
* @param {object} options Options for the request
|
|
16
|
+
* @param {string} options.shield_information_barrier_id The ID of the shield information barrier.
|
|
17
|
+
* @param {Function} [callback] Passed the result if successful, error otherwise
|
|
18
|
+
* @returns {Promise<schemas.ShieldInformationBarrier>} A promise resolving to the result or rejecting with an error
|
|
19
|
+
*/
|
|
20
|
+
getById(options: {
|
|
21
|
+
/**
|
|
22
|
+
* The ID of the shield information barrier.
|
|
23
|
+
*/
|
|
24
|
+
readonly shield_information_barrier_id: string;
|
|
25
|
+
}, callback?: Function): Promise<schemas.ShieldInformationBarrier>;
|
|
26
|
+
/**
|
|
27
|
+
* List shield information barriers
|
|
28
|
+
*
|
|
29
|
+
* Retrieves a list of shield information barrier objects
|
|
30
|
+
* for the enterprise of JWT.
|
|
31
|
+
* @param {object} [options] Options for the request
|
|
32
|
+
* @param {string} [options.marker] Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.
|
|
33
|
+
* @param {number} [options.limit] The maximum number of items to return per page.
|
|
34
|
+
* @param {Function} [callback] Passed the result if successful, error otherwise
|
|
35
|
+
* @returns {Promise<schemas.ShieldInformationBarriers>} A promise resolving to the result or rejecting with an error
|
|
36
|
+
*/
|
|
37
|
+
getAll(options?: {
|
|
38
|
+
/**
|
|
39
|
+
* Defines the position marker at which to begin returning results. This is
|
|
40
|
+
* used when paginating using marker-based pagination.
|
|
41
|
+
*/
|
|
42
|
+
readonly marker?: string;
|
|
43
|
+
/**
|
|
44
|
+
* The maximum number of items to return per page.
|
|
45
|
+
*/
|
|
46
|
+
readonly limit?: number;
|
|
47
|
+
}, callback?: Function): Promise<schemas.ShieldInformationBarriers>;
|
|
48
|
+
/**
|
|
49
|
+
* Create shield information barrier
|
|
50
|
+
*
|
|
51
|
+
* Creates a shield information barrier to
|
|
52
|
+
* separate individuals/groups within the same
|
|
53
|
+
* firm and prevents confidential information passing between them.
|
|
54
|
+
* @param {object} body
|
|
55
|
+
* @param {object} [options] Options for the request
|
|
56
|
+
* @param {Function} [callback] Passed the result if successful, error otherwise
|
|
57
|
+
* @returns {Promise<schemas.ShieldInformationBarrier>} A promise resolving to the result or rejecting with an error
|
|
58
|
+
*/
|
|
59
|
+
create(body: {
|
|
60
|
+
enterprise: {
|
|
61
|
+
type: string;
|
|
62
|
+
id: string;
|
|
63
|
+
};
|
|
64
|
+
}, options?: {}, callback?: Function): Promise<schemas.ShieldInformationBarrier>;
|
|
65
|
+
/**
|
|
66
|
+
* Add changed status of shield information barrier with specified ID
|
|
67
|
+
*
|
|
68
|
+
* Change status of shield information barrier with the specified ID.
|
|
69
|
+
* @param {object} body
|
|
70
|
+
* @param {object} [options] Options for the request
|
|
71
|
+
* @param {Function} [callback] Passed the result if successful, error otherwise
|
|
72
|
+
* @returns {Promise<schemas.ShieldInformationBarrier>} A promise resolving to the result or rejecting with an error
|
|
73
|
+
*/
|
|
74
|
+
changeStatusById(body: {
|
|
75
|
+
id: string;
|
|
76
|
+
status: string;
|
|
77
|
+
}, options?: {}, callback?: Function): Promise<schemas.ShieldInformationBarrier>;
|
|
78
|
+
}
|
|
79
|
+
export = ShieldInformationBarrierManager;
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
const url_path_1 = __importDefault(require("../util/url-path"));
|
|
6
|
+
/**
|
|
7
|
+
*/
|
|
8
|
+
class ShieldInformationBarrierManager {
|
|
9
|
+
/**
|
|
10
|
+
* @param {BoxClient} client The Box API Client that is responsible for making calls to the API
|
|
11
|
+
*/
|
|
12
|
+
constructor(client) {
|
|
13
|
+
this.client = client;
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* Get shield information barrier with specified ID
|
|
17
|
+
*
|
|
18
|
+
* Get shield information barrier based on provided ID.
|
|
19
|
+
* @param {object} options Options for the request
|
|
20
|
+
* @param {string} options.shield_information_barrier_id The ID of the shield information barrier.
|
|
21
|
+
* @param {Function} [callback] Passed the result if successful, error otherwise
|
|
22
|
+
* @returns {Promise<schemas.ShieldInformationBarrier>} A promise resolving to the result or rejecting with an error
|
|
23
|
+
*/
|
|
24
|
+
getById(options, callback) {
|
|
25
|
+
const { shield_information_barrier_id: shieldInformationBarrierId, ...queryParams } = options, apiPath = (0, url_path_1.default)('shield_information_barriers', shieldInformationBarrierId), params = {
|
|
26
|
+
qs: queryParams,
|
|
27
|
+
};
|
|
28
|
+
return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* List shield information barriers
|
|
32
|
+
*
|
|
33
|
+
* Retrieves a list of shield information barrier objects
|
|
34
|
+
* for the enterprise of JWT.
|
|
35
|
+
* @param {object} [options] Options for the request
|
|
36
|
+
* @param {string} [options.marker] Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.
|
|
37
|
+
* @param {number} [options.limit] The maximum number of items to return per page.
|
|
38
|
+
* @param {Function} [callback] Passed the result if successful, error otherwise
|
|
39
|
+
* @returns {Promise<schemas.ShieldInformationBarriers>} A promise resolving to the result or rejecting with an error
|
|
40
|
+
*/
|
|
41
|
+
getAll(options, callback) {
|
|
42
|
+
const { ...queryParams } = options, apiPath = (0, url_path_1.default)('shield_information_barriers'), params = {
|
|
43
|
+
qs: queryParams,
|
|
44
|
+
};
|
|
45
|
+
return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* Create shield information barrier
|
|
49
|
+
*
|
|
50
|
+
* Creates a shield information barrier to
|
|
51
|
+
* separate individuals/groups within the same
|
|
52
|
+
* firm and prevents confidential information passing between them.
|
|
53
|
+
* @param {object} body
|
|
54
|
+
* @param {object} [options] Options for the request
|
|
55
|
+
* @param {Function} [callback] Passed the result if successful, error otherwise
|
|
56
|
+
* @returns {Promise<schemas.ShieldInformationBarrier>} A promise resolving to the result or rejecting with an error
|
|
57
|
+
*/
|
|
58
|
+
create(body, options, callback) {
|
|
59
|
+
const { ...queryParams } = options, apiPath = (0, url_path_1.default)('shield_information_barriers'), params = {
|
|
60
|
+
qs: queryParams,
|
|
61
|
+
body: body,
|
|
62
|
+
};
|
|
63
|
+
return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* Add changed status of shield information barrier with specified ID
|
|
67
|
+
*
|
|
68
|
+
* Change status of shield information barrier with the specified ID.
|
|
69
|
+
* @param {object} body
|
|
70
|
+
* @param {object} [options] Options for the request
|
|
71
|
+
* @param {Function} [callback] Passed the result if successful, error otherwise
|
|
72
|
+
* @returns {Promise<schemas.ShieldInformationBarrier>} A promise resolving to the result or rejecting with an error
|
|
73
|
+
*/
|
|
74
|
+
changeStatusById(body, options, callback) {
|
|
75
|
+
const { ...queryParams } = options, apiPath = (0, url_path_1.default)('shield_information_barriers', 'change_status'), params = {
|
|
76
|
+
qs: queryParams,
|
|
77
|
+
body: body,
|
|
78
|
+
};
|
|
79
|
+
return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
module.exports = ShieldInformationBarrierManager;
|
|
83
|
+
//# sourceMappingURL=shield-information-barriers.generated.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"shield-information-barriers.generated.js","sourceRoot":"","sources":["../../src/managers/shield-information-barriers.generated.ts"],"names":[],"mappings":";;;;AACA,gEAAuC;AAEvC;GACG;AACH,MAAM,+BAA+B;IAEnC;;OAEG;IACH,YAAY,MAAiB;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IACD;;;;;;;;OAQG;IACH,OAAO,CACL,OAKC,EACD,QAAmB;QAEnB,MAAM,EACF,6BAA6B,EAAE,0BAA0B,EACzD,GAAG,WAAW,EACf,GAAG,OAAO,EACX,OAAO,GAAG,IAAA,kBAAO,EACf,6BAA6B,EAC7B,0BAA0B,CAC3B,EACD,MAAM,GAAG;YACP,EAAE,EAAE,WAAW;SAChB,CAAC;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IACD;;;;;;;;;;OAUG;IACH,MAAM,CACJ,OAUC,EACD,QAAmB;QAEnB,MAAM,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,EAChC,OAAO,GAAG,IAAA,kBAAO,EAAC,6BAA6B,CAAC,EAChD,MAAM,GAAG;YACP,EAAE,EAAE,WAAW;SAChB,CAAC;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IACD;;;;;;;;;;OAUG;IACH,MAAM,CACJ,IAKC,EACD,OAAY,EACZ,QAAmB;QAEnB,MAAM,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,EAChC,OAAO,GAAG,IAAA,kBAAO,EAAC,6BAA6B,CAAC,EAChD,MAAM,GAAG;YACP,EAAE,EAAE,WAAW;YACf,IAAI,EAAE,IAAI;SACX,CAAC;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IACD;;;;;;;;OAQG;IACH,gBAAgB,CACd,IAGC,EACD,OAAY,EACZ,QAAmB;QAEnB,MAAM,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,EAChC,OAAO,GAAG,IAAA,kBAAO,EAAC,6BAA6B,EAAE,eAAe,CAAC,EACjE,MAAM,GAAG;YACP,EAAE,EAAE,WAAW;YACf,IAAI,EAAE,IAAI;SACX,CAAC;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;CACF;AACD,iBAAS,+BAA+B,CAAC"}
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
import BoxClient from '../box-client';
|
|
2
|
+
import * as schemas from '../schemas';
|
|
3
|
+
/**
|
|
4
|
+
* Simple manager for interacting with all Sign Requests endpoints and actions.
|
|
5
|
+
*/
|
|
6
|
+
declare class SignRequestsManager {
|
|
7
|
+
client: BoxClient;
|
|
8
|
+
/**
|
|
9
|
+
* @param {BoxClient} client The Box API Client that is responsible for making calls to the API
|
|
10
|
+
*/
|
|
11
|
+
constructor(client: BoxClient);
|
|
12
|
+
/**
|
|
13
|
+
* Get Box Sign request by ID
|
|
14
|
+
*
|
|
15
|
+
* Gets a sign request by ID.
|
|
16
|
+
* @param {object} options Options for the request
|
|
17
|
+
* @param {string} options.sign_request_id The ID of the signature request
|
|
18
|
+
* @param {Function} [callback] Passed the result if successful, error otherwise
|
|
19
|
+
* @returns {Promise<schemas.SignRequest>} A promise resolving to the result or rejecting with an error
|
|
20
|
+
*/
|
|
21
|
+
getById(options: {
|
|
22
|
+
/**
|
|
23
|
+
* The ID of the signature request
|
|
24
|
+
*/
|
|
25
|
+
readonly sign_request_id: string;
|
|
26
|
+
}, callback?: Function): Promise<schemas.SignRequest>;
|
|
27
|
+
/**
|
|
28
|
+
* List Box Sign requests
|
|
29
|
+
*
|
|
30
|
+
* Gets signature requests created by a user. If the `sign_files` and/or
|
|
31
|
+
* `parent_folder` are deleted, the signature request will not return in the list.
|
|
32
|
+
* @param {object} [options] Options for the request
|
|
33
|
+
* @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`.
|
|
34
|
+
* @param {number} [options.limit] The maximum number of items to return per page.
|
|
35
|
+
* @param {Function} [callback] Passed the result if successful, error otherwise
|
|
36
|
+
* @returns {Promise<schemas.SignRequests>} A promise resolving to the result or rejecting with an error
|
|
37
|
+
*/
|
|
38
|
+
getAll(options?: {
|
|
39
|
+
/**
|
|
40
|
+
* Defines the position marker at which to begin returning results. This is
|
|
41
|
+
* used when paginating using marker-based pagination.
|
|
42
|
+
*
|
|
43
|
+
* This requires `usemarker` to be set to `true`.
|
|
44
|
+
*/
|
|
45
|
+
readonly marker?: string;
|
|
46
|
+
/**
|
|
47
|
+
* The maximum number of items to return per page.
|
|
48
|
+
*/
|
|
49
|
+
readonly limit?: number;
|
|
50
|
+
}, callback?: Function): Promise<schemas.SignRequests>;
|
|
51
|
+
/**
|
|
52
|
+
* Create Box Sign request
|
|
53
|
+
*
|
|
54
|
+
* Creates a signature request. This involves preparing a document for signing and
|
|
55
|
+
* sending the signature request to signers.
|
|
56
|
+
* @param {schemas.SignRequestCreateRequest} body
|
|
57
|
+
* @param {object} [options] Options for the request
|
|
58
|
+
* @param {Function} [callback] Passed the result if successful, error otherwise
|
|
59
|
+
* @returns {Promise<schemas.SignRequest>} A promise resolving to the result or rejecting with an error
|
|
60
|
+
*/
|
|
61
|
+
create(body: schemas.SignRequestCreateRequest, options?: {}, callback?: Function): Promise<schemas.SignRequest>;
|
|
62
|
+
/**
|
|
63
|
+
* Cancel Box Sign request
|
|
64
|
+
*
|
|
65
|
+
* Cancels a sign request.
|
|
66
|
+
* @param {object} options Options for the request
|
|
67
|
+
* @param {string} options.sign_request_id The ID of the signature request
|
|
68
|
+
* @param {Function} [callback] Passed the result if successful, error otherwise
|
|
69
|
+
* @returns {Promise<schemas.SignRequest>} A promise resolving to the result or rejecting with an error
|
|
70
|
+
*/
|
|
71
|
+
cancelById(options: {
|
|
72
|
+
/**
|
|
73
|
+
* The ID of the signature request
|
|
74
|
+
*/
|
|
75
|
+
readonly sign_request_id: string;
|
|
76
|
+
}, callback?: Function): Promise<schemas.SignRequest>;
|
|
77
|
+
/**
|
|
78
|
+
* Resend Box Sign request
|
|
79
|
+
*
|
|
80
|
+
* Resends a signature request email to all outstanding signers.
|
|
81
|
+
* @param {object} options Options for the request
|
|
82
|
+
* @param {string} options.sign_request_id The ID of the signature request
|
|
83
|
+
* @param {Function} [callback] Passed the result if successful, error otherwise
|
|
84
|
+
* @returns {Promise<void>} A promise resolving to the result or rejecting with an error
|
|
85
|
+
*/
|
|
86
|
+
resendById(options: {
|
|
87
|
+
/**
|
|
88
|
+
* The ID of the signature request
|
|
89
|
+
*/
|
|
90
|
+
readonly sign_request_id: string;
|
|
91
|
+
}, callback?: Function): Promise<void>;
|
|
92
|
+
}
|
|
93
|
+
export = SignRequestsManager;
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
const url_path_1 = __importDefault(require("../util/url-path"));
|
|
6
|
+
/**
|
|
7
|
+
* Simple manager for interacting with all Sign Requests endpoints and actions.
|
|
8
|
+
*/
|
|
9
|
+
class SignRequestsManager {
|
|
10
|
+
/**
|
|
11
|
+
* @param {BoxClient} client The Box API Client that is responsible for making calls to the API
|
|
12
|
+
*/
|
|
13
|
+
constructor(client) {
|
|
14
|
+
this.client = client;
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* Get Box Sign request by ID
|
|
18
|
+
*
|
|
19
|
+
* Gets a sign request by ID.
|
|
20
|
+
* @param {object} options Options for the request
|
|
21
|
+
* @param {string} options.sign_request_id The ID of the signature request
|
|
22
|
+
* @param {Function} [callback] Passed the result if successful, error otherwise
|
|
23
|
+
* @returns {Promise<schemas.SignRequest>} A promise resolving to the result or rejecting with an error
|
|
24
|
+
*/
|
|
25
|
+
getById(options, callback) {
|
|
26
|
+
const { sign_request_id: signRequestId, ...queryParams } = options, apiPath = (0, url_path_1.default)('sign_requests', signRequestId), params = {
|
|
27
|
+
qs: queryParams,
|
|
28
|
+
};
|
|
29
|
+
return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* List Box Sign requests
|
|
33
|
+
*
|
|
34
|
+
* Gets signature requests created by a user. If the `sign_files` and/or
|
|
35
|
+
* `parent_folder` are deleted, the signature request will not return in the list.
|
|
36
|
+
* @param {object} [options] Options for the request
|
|
37
|
+
* @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`.
|
|
38
|
+
* @param {number} [options.limit] The maximum number of items to return per page.
|
|
39
|
+
* @param {Function} [callback] Passed the result if successful, error otherwise
|
|
40
|
+
* @returns {Promise<schemas.SignRequests>} A promise resolving to the result or rejecting with an error
|
|
41
|
+
*/
|
|
42
|
+
getAll(options, callback) {
|
|
43
|
+
const { ...queryParams } = options, apiPath = (0, url_path_1.default)('sign_requests'), params = {
|
|
44
|
+
qs: queryParams,
|
|
45
|
+
};
|
|
46
|
+
return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* Create Box Sign request
|
|
50
|
+
*
|
|
51
|
+
* Creates a signature request. This involves preparing a document for signing and
|
|
52
|
+
* sending the signature request to signers.
|
|
53
|
+
* @param {schemas.SignRequestCreateRequest} body
|
|
54
|
+
* @param {object} [options] Options for the request
|
|
55
|
+
* @param {Function} [callback] Passed the result if successful, error otherwise
|
|
56
|
+
* @returns {Promise<schemas.SignRequest>} A promise resolving to the result or rejecting with an error
|
|
57
|
+
*/
|
|
58
|
+
create(body, options, callback) {
|
|
59
|
+
const { ...queryParams } = options, apiPath = (0, url_path_1.default)('sign_requests'), params = {
|
|
60
|
+
qs: queryParams,
|
|
61
|
+
body: body,
|
|
62
|
+
};
|
|
63
|
+
return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* Cancel Box Sign request
|
|
67
|
+
*
|
|
68
|
+
* Cancels a sign request.
|
|
69
|
+
* @param {object} options Options for the request
|
|
70
|
+
* @param {string} options.sign_request_id The ID of the signature request
|
|
71
|
+
* @param {Function} [callback] Passed the result if successful, error otherwise
|
|
72
|
+
* @returns {Promise<schemas.SignRequest>} A promise resolving to the result or rejecting with an error
|
|
73
|
+
*/
|
|
74
|
+
cancelById(options, callback) {
|
|
75
|
+
const { sign_request_id: signRequestId, ...queryParams } = options, apiPath = (0, url_path_1.default)('sign_requests', signRequestId, 'cancel'), params = {
|
|
76
|
+
qs: queryParams,
|
|
77
|
+
};
|
|
78
|
+
return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
|
|
79
|
+
}
|
|
80
|
+
/**
|
|
81
|
+
* Resend Box Sign request
|
|
82
|
+
*
|
|
83
|
+
* Resends a signature request email to all outstanding signers.
|
|
84
|
+
* @param {object} options Options for the request
|
|
85
|
+
* @param {string} options.sign_request_id The ID of the signature request
|
|
86
|
+
* @param {Function} [callback] Passed the result if successful, error otherwise
|
|
87
|
+
* @returns {Promise<void>} A promise resolving to the result or rejecting with an error
|
|
88
|
+
*/
|
|
89
|
+
resendById(options, callback) {
|
|
90
|
+
const { sign_request_id: signRequestId, ...queryParams } = options, apiPath = (0, url_path_1.default)('sign_requests', signRequestId, 'resend'), params = {
|
|
91
|
+
qs: queryParams,
|
|
92
|
+
};
|
|
93
|
+
return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
module.exports = SignRequestsManager;
|
|
97
|
+
//# sourceMappingURL=sign-requests.generated.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sign-requests.generated.js","sourceRoot":"","sources":["../../src/managers/sign-requests.generated.ts"],"names":[],"mappings":";;;;AACA,gEAAuC;AAEvC;;GAEG;AACH,MAAM,mBAAmB;IAEvB;;OAEG;IACH,YAAY,MAAiB;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IACD;;;;;;;;OAQG;IACH,OAAO,CACL,OAKC,EACD,QAAmB;QAEnB,MAAM,EAAE,eAAe,EAAE,aAAa,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,EAChE,OAAO,GAAG,IAAA,kBAAO,EAAC,eAAe,EAAE,aAAa,CAAC,EACjD,MAAM,GAAG;YACP,EAAE,EAAE,WAAW;SAChB,CAAC;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IACD;;;;;;;;;;OAUG;IACH,MAAM,CACJ,OAYC,EACD,QAAmB;QAEnB,MAAM,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,EAChC,OAAO,GAAG,IAAA,kBAAO,EAAC,eAAe,CAAC,EAClC,MAAM,GAAG;YACP,EAAE,EAAE,WAAW;SAChB,CAAC;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IACD;;;;;;;;;OASG;IACH,MAAM,CACJ,IAAsC,EACtC,OAAY,EACZ,QAAmB;QAEnB,MAAM,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,EAChC,OAAO,GAAG,IAAA,kBAAO,EAAC,eAAe,CAAC,EAClC,MAAM,GAAG;YACP,EAAE,EAAE,WAAW;YACf,IAAI,EAAE,IAAI;SACX,CAAC;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IACD;;;;;;;;OAQG;IACH,UAAU,CACR,OAKC,EACD,QAAmB;QAEnB,MAAM,EAAE,eAAe,EAAE,aAAa,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,EAChE,OAAO,GAAG,IAAA,kBAAO,EAAC,eAAe,EAAE,aAAa,EAAE,QAAQ,CAAC,EAC3D,MAAM,GAAG;YACP,EAAE,EAAE,WAAW;SAChB,CAAC;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IACD;;;;;;;;OAQG;IACH,UAAU,CACR,OAKC,EACD,QAAmB;QAEnB,MAAM,EAAE,eAAe,EAAE,aAAa,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,EAChE,OAAO,GAAG,IAAA,kBAAO,EAAC,eAAe,EAAE,aAAa,EAAE,QAAQ,CAAC,EAC3D,MAAM,GAAG;YACP,EAAE,EAAE,WAAW;SAChB,CAAC;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;CACF;AACD,iBAAS,mBAAmB,CAAC"}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
import BoxClient from '../box-client';
|
|
2
|
+
import * as schemas from '../schemas';
|
|
3
|
+
/**
|
|
4
|
+
* Simple manager for interacting with all Sign Templates endpoints and actions.
|
|
5
|
+
*/
|
|
6
|
+
declare class SignTemplatesManager {
|
|
7
|
+
client: BoxClient;
|
|
8
|
+
/**
|
|
9
|
+
* @param {BoxClient} client The Box API Client that is responsible for making calls to the API
|
|
10
|
+
*/
|
|
11
|
+
constructor(client: BoxClient);
|
|
12
|
+
/**
|
|
13
|
+
* Get Box Sign template by ID
|
|
14
|
+
*
|
|
15
|
+
* Fetches details of a specific Box Sign template.
|
|
16
|
+
* @param {object} options Options for the request
|
|
17
|
+
* @param {string} options.template_id The ID of a Box Sign template.
|
|
18
|
+
* @param {Function} [callback] Passed the result if successful, error otherwise
|
|
19
|
+
* @returns {Promise<schemas.SignTemplate>} A promise resolving to the result or rejecting with an error
|
|
20
|
+
*/
|
|
21
|
+
getById(options: {
|
|
22
|
+
/**
|
|
23
|
+
* The ID of a Box Sign template.
|
|
24
|
+
*/
|
|
25
|
+
readonly template_id: string;
|
|
26
|
+
}, callback?: Function): Promise<schemas.SignTemplate>;
|
|
27
|
+
/**
|
|
28
|
+
* List Box Sign templates
|
|
29
|
+
*
|
|
30
|
+
* Gets Box Sign templates created by a user.
|
|
31
|
+
* @param {object} [options] Options for the request
|
|
32
|
+
* @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`.
|
|
33
|
+
* @param {number} [options.limit] The maximum number of items to return per page.
|
|
34
|
+
* @param {Function} [callback] Passed the result if successful, error otherwise
|
|
35
|
+
* @returns {Promise<schemas.SignTemplates>} A promise resolving to the result or rejecting with an error
|
|
36
|
+
*/
|
|
37
|
+
getAll(options?: {
|
|
38
|
+
/**
|
|
39
|
+
* Defines the position marker at which to begin returning results. This is
|
|
40
|
+
* used when paginating using marker-based pagination.
|
|
41
|
+
*
|
|
42
|
+
* This requires `usemarker` to be set to `true`.
|
|
43
|
+
*/
|
|
44
|
+
readonly marker?: string;
|
|
45
|
+
/**
|
|
46
|
+
* The maximum number of items to return per page.
|
|
47
|
+
*/
|
|
48
|
+
readonly limit?: number;
|
|
49
|
+
}, callback?: Function): Promise<schemas.SignTemplates>;
|
|
50
|
+
}
|
|
51
|
+
export = SignTemplatesManager;
|