box-node-sdk 3.8.1 → 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/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 +18 -4
|
@@ -0,0 +1,243 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* @fileoverview Manager for the Tasks Resource
|
|
4
|
+
*/
|
|
5
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
6
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
7
|
+
};
|
|
8
|
+
const url_path_1 = __importDefault(require("../util/url-path"));
|
|
9
|
+
// -----------------------------------------------------------------------------
|
|
10
|
+
// Typedefs
|
|
11
|
+
// -----------------------------------------------------------------------------
|
|
12
|
+
/**
|
|
13
|
+
* Enum of valid task resolution states
|
|
14
|
+
* @readonly
|
|
15
|
+
* @enum {TaskResolutionState}
|
|
16
|
+
*/
|
|
17
|
+
var TaskResolutionState;
|
|
18
|
+
(function (TaskResolutionState) {
|
|
19
|
+
TaskResolutionState["COMPLETE"] = "completed";
|
|
20
|
+
TaskResolutionState["INCOMPLETE"] = "incomplete";
|
|
21
|
+
TaskResolutionState["APPROVED"] = "approved";
|
|
22
|
+
TaskResolutionState["REJECTED"] = "rejected";
|
|
23
|
+
})(TaskResolutionState || (TaskResolutionState = {}));
|
|
24
|
+
// -----------------------------------------------------------------------------
|
|
25
|
+
// Private
|
|
26
|
+
// -----------------------------------------------------------------------------
|
|
27
|
+
const BASE_PATH = '/tasks', ASSIGNMENTS_SUBRESOURCE = 'assignments', ASSIGNMENTS_PATH = '/task_assignments', REVIEW_ACTION = 'review';
|
|
28
|
+
// -----------------------------------------------------------------------------
|
|
29
|
+
// Public
|
|
30
|
+
// -----------------------------------------------------------------------------
|
|
31
|
+
/**
|
|
32
|
+
* Simple manager for interacting with all 'Tasks' endpoints and actions.
|
|
33
|
+
*
|
|
34
|
+
* @constructor
|
|
35
|
+
* @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
|
|
36
|
+
* @returns {void}
|
|
37
|
+
*/
|
|
38
|
+
class Tasks {
|
|
39
|
+
constructor(client) {
|
|
40
|
+
this.client = client;
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* Used to create a single task for single user on a single file.
|
|
44
|
+
*
|
|
45
|
+
* API Endpoint: '/tasks'
|
|
46
|
+
* Method: POST
|
|
47
|
+
*
|
|
48
|
+
* @param {string} fileID - The ID of the item this task is for
|
|
49
|
+
* @param {Object} [options] - Additional parameters
|
|
50
|
+
* @param {string} [options.message] - An optional message to include with the task
|
|
51
|
+
* @param {string} [options.due_at] - The day at which this task is due
|
|
52
|
+
* @param {Function} [callback] - Passed the new task information if it was acquired successfully, error otherwise
|
|
53
|
+
* @returns {Promise<Object>} A promise resolving to the created task object
|
|
54
|
+
*/
|
|
55
|
+
create(fileID, options, callback) {
|
|
56
|
+
var apiPath = (0, url_path_1.default)(BASE_PATH), params = {
|
|
57
|
+
body: {
|
|
58
|
+
item: {
|
|
59
|
+
type: 'file',
|
|
60
|
+
id: fileID,
|
|
61
|
+
},
|
|
62
|
+
action: REVIEW_ACTION,
|
|
63
|
+
},
|
|
64
|
+
};
|
|
65
|
+
Object.assign(params.body, options);
|
|
66
|
+
return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Fetches a specific task.
|
|
70
|
+
*
|
|
71
|
+
* API Endpoint: '/tasks/:taskID'
|
|
72
|
+
* Method: GET
|
|
73
|
+
*
|
|
74
|
+
* @param {string} taskID - The Box ID of the task being requested
|
|
75
|
+
* @param {Object} [options] - Additional options for the request. Can be left null in most cases.
|
|
76
|
+
* @param {Function} [callback] - Passed the task information if it was acquired successfully, error otherwise
|
|
77
|
+
* @returns {Promise<Object>} A promise resolving to the task object
|
|
78
|
+
*/
|
|
79
|
+
get(taskID, options, callback) {
|
|
80
|
+
var apiPath = (0, url_path_1.default)(BASE_PATH, taskID), params = {
|
|
81
|
+
qs: options,
|
|
82
|
+
};
|
|
83
|
+
return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* Updates a specific task.
|
|
87
|
+
*
|
|
88
|
+
* API Endpoint: '/tasks/:taskID'
|
|
89
|
+
* Method: PUT
|
|
90
|
+
*
|
|
91
|
+
* @param {string} taskID - The Box ID of the task being updated
|
|
92
|
+
* @param {Object} updates - Fields of the task object to update
|
|
93
|
+
* @param {string} [updates.message] - An optional message to include with the task
|
|
94
|
+
* @param {string} [updates.due_at] - The day at which this task is due
|
|
95
|
+
* @param {Function} [callback] - Passed the updated task information if it was acquired successfully, error otherwise
|
|
96
|
+
* @returns {Promise<Object>} A promise resolving to the updated task object
|
|
97
|
+
*/
|
|
98
|
+
update(taskID, updates, callback) {
|
|
99
|
+
var apiPath = (0, url_path_1.default)(BASE_PATH, taskID), params = {
|
|
100
|
+
body: updates,
|
|
101
|
+
};
|
|
102
|
+
return this.client.wrapWithDefaultHandler(this.client.put)(apiPath, params, callback);
|
|
103
|
+
}
|
|
104
|
+
/**
|
|
105
|
+
* Permanently deletes a specific task.
|
|
106
|
+
*
|
|
107
|
+
* API Endpoint: '/tasks/:taskID'
|
|
108
|
+
* Method: DELETE
|
|
109
|
+
*
|
|
110
|
+
* @param {string} taskID - The Box ID of the task being deleted
|
|
111
|
+
* @param {Function} [callback] - Empty body passed if successful, error otherwise
|
|
112
|
+
* @returns {Promise<void>} A promise resolving to nothing
|
|
113
|
+
*/
|
|
114
|
+
delete(taskID, callback) {
|
|
115
|
+
var apiPath = (0, url_path_1.default)(BASE_PATH, taskID);
|
|
116
|
+
return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, null, callback);
|
|
117
|
+
}
|
|
118
|
+
/**
|
|
119
|
+
* Get a list of assignments for a given task
|
|
120
|
+
*
|
|
121
|
+
* API Endpoint: '/tasks/:taskID/assignments'
|
|
122
|
+
* Method: GET
|
|
123
|
+
*
|
|
124
|
+
* @param {string} taskID - The Box ID of the task to get assignments for
|
|
125
|
+
* @param {Object} [options] - Additional parameters, can be left null in most cases
|
|
126
|
+
* @param {Function} [callback] - Passed the list of assignments if successful, error otherwise
|
|
127
|
+
* @returns {Promise<Object>} A promise resolving to the collection of assignment objects
|
|
128
|
+
*/
|
|
129
|
+
getAssignments(taskID, options, callback) {
|
|
130
|
+
var apiPath = (0, url_path_1.default)(BASE_PATH, taskID, ASSIGNMENTS_SUBRESOURCE), params = {
|
|
131
|
+
qs: options,
|
|
132
|
+
};
|
|
133
|
+
return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
|
|
134
|
+
}
|
|
135
|
+
/**
|
|
136
|
+
* Get a specific task assignment
|
|
137
|
+
*
|
|
138
|
+
* API Endpoint: '/task_assignments/:assignmentID'
|
|
139
|
+
* Method: GET
|
|
140
|
+
*
|
|
141
|
+
* @param {string} assignmentID - The Box ID of the task assignment to retrieve
|
|
142
|
+
* @param {Object} [options] - Additional parameters, can be left null in most cases
|
|
143
|
+
* @param {Function} [callback] - Passed the task assignment if successful, error otherwise
|
|
144
|
+
* @returns {Promise<Object>} A promise resolving to the assignment object
|
|
145
|
+
*/
|
|
146
|
+
getAssignment(assignmentID, options, callback) {
|
|
147
|
+
var apiPath = (0, url_path_1.default)(ASSIGNMENTS_PATH, assignmentID), params = {
|
|
148
|
+
qs: options,
|
|
149
|
+
};
|
|
150
|
+
return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
|
|
151
|
+
}
|
|
152
|
+
/**
|
|
153
|
+
* Assign a task to a specific user by ID
|
|
154
|
+
*
|
|
155
|
+
* API Endpoint: '/task_assignments'
|
|
156
|
+
* Method: POST
|
|
157
|
+
*
|
|
158
|
+
* @param {string} taskID - The Box ID of the task to assign
|
|
159
|
+
* @param {string} userID - The ID of the user to assign the task to
|
|
160
|
+
* @param {Function} [callback] - Passed the task assignment if successful, error otherwise
|
|
161
|
+
* @returns {Promise<Object>} A promise resolving to the new assignment object
|
|
162
|
+
*/
|
|
163
|
+
assignByUserID(taskID, userID, callback) {
|
|
164
|
+
var apiPath = (0, url_path_1.default)(ASSIGNMENTS_PATH), params = {
|
|
165
|
+
body: {
|
|
166
|
+
task: {
|
|
167
|
+
type: 'task',
|
|
168
|
+
id: taskID,
|
|
169
|
+
},
|
|
170
|
+
assign_to: {
|
|
171
|
+
id: userID,
|
|
172
|
+
},
|
|
173
|
+
},
|
|
174
|
+
};
|
|
175
|
+
return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
|
|
176
|
+
}
|
|
177
|
+
/**
|
|
178
|
+
* Assign a task to a specific user by email address
|
|
179
|
+
*
|
|
180
|
+
* API Endpoint: '/task_assignments'
|
|
181
|
+
* Method: POST
|
|
182
|
+
*
|
|
183
|
+
* @param {string} taskID - The Box ID of the task to assign
|
|
184
|
+
* @param {string} email - The email address of the user to assign the task to
|
|
185
|
+
* @param {Function} [callback] - Passed the task assignment if successful, error otherwise
|
|
186
|
+
* @returns {Promise<Object>} A promise resolving to the new assignment object
|
|
187
|
+
*/
|
|
188
|
+
assignByEmail(taskID, email, callback) {
|
|
189
|
+
var apiPath = (0, url_path_1.default)(ASSIGNMENTS_PATH), params = {
|
|
190
|
+
body: {
|
|
191
|
+
task: {
|
|
192
|
+
type: 'task',
|
|
193
|
+
id: taskID,
|
|
194
|
+
},
|
|
195
|
+
assign_to: {
|
|
196
|
+
login: email,
|
|
197
|
+
},
|
|
198
|
+
},
|
|
199
|
+
};
|
|
200
|
+
return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
|
|
201
|
+
}
|
|
202
|
+
/**
|
|
203
|
+
* Update a task assignment. This is used to resolve or complete a task.
|
|
204
|
+
*
|
|
205
|
+
* API Endpoint: '/task_assignments/:assignmentID'
|
|
206
|
+
* Method: PUT
|
|
207
|
+
*
|
|
208
|
+
* @param {string} assignmentID - The Box ID of the task assignment to update
|
|
209
|
+
* @param {Object} options - The fields of the assignment to update
|
|
210
|
+
* @param {string} [options.message] - A message from the assignee about this task
|
|
211
|
+
* @param {TaskResolutionState} [options.resolution_state] - Resolution of the task
|
|
212
|
+
* @param {Function} [callback] - Passed the updated task assignment if successful, error otherwise
|
|
213
|
+
* @returns {Promise<Object>} A promise resolving to the updated assignment object
|
|
214
|
+
*/
|
|
215
|
+
updateAssignment(assignmentID, options, callback) {
|
|
216
|
+
var apiPath = (0, url_path_1.default)(ASSIGNMENTS_PATH, assignmentID), params = {
|
|
217
|
+
body: options,
|
|
218
|
+
};
|
|
219
|
+
return this.client.wrapWithDefaultHandler(this.client.put)(apiPath, params, callback);
|
|
220
|
+
}
|
|
221
|
+
/**
|
|
222
|
+
* Delete a task assignment. This unassigns a user from the related task.
|
|
223
|
+
*
|
|
224
|
+
* API Endpoint: '/task_assignments/:assignmentID'
|
|
225
|
+
* Method: DELETE
|
|
226
|
+
*
|
|
227
|
+
* @param {string} assignmentID - The Box ID of the task assignment to delete
|
|
228
|
+
* @param {Function} [callback] - Passed nothing if successful, error otherwise
|
|
229
|
+
* @returns {Promise<void>} A promise resolving to nothing
|
|
230
|
+
*/
|
|
231
|
+
deleteAssignment(assignmentID, callback) {
|
|
232
|
+
var apiPath = (0, url_path_1.default)(ASSIGNMENTS_PATH, assignmentID);
|
|
233
|
+
return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, null, callback);
|
|
234
|
+
}
|
|
235
|
+
}
|
|
236
|
+
/**
|
|
237
|
+
* Enum of valid task resolution states
|
|
238
|
+
* @readonly
|
|
239
|
+
* @enum {TaskResolutionState}
|
|
240
|
+
*/
|
|
241
|
+
Tasks.prototype.resolutionStates = TaskResolutionState;
|
|
242
|
+
module.exports = Tasks;
|
|
243
|
+
//# sourceMappingURL=tasks.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tasks.js","sourceRoot":"","sources":["../../src/managers/tasks.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;AAOH,gEAAuC;AAEvC,gFAAgF;AAChF,WAAW;AACX,gFAAgF;AAEhF;;;;GAIG;AACH,IAAK,mBAKJ;AALD,WAAK,mBAAmB;IACtB,6CAAsB,CAAA;IACtB,gDAAyB,CAAA;IACzB,4CAAqB,CAAA;IACrB,4CAAqB,CAAA;AACvB,CAAC,EALI,mBAAmB,KAAnB,mBAAmB,QAKvB;AAED,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF,MAAM,SAAS,GAAG,QAAQ,EACxB,uBAAuB,GAAG,aAAa,EACvC,gBAAgB,GAAG,mBAAmB,EACtC,aAAa,GAAG,QAAQ,CAAC;AAE3B,gFAAgF;AAChF,SAAS;AACT,gFAAgF;AAEhF;;;;;;GAMG;AACH,MAAM,KAAK;IAKT,YAAY,MAAiB;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,MAAc,EACd,OAGC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,CAAC,EAC9B,MAAM,GAAG;YACP,IAAI,EAAE;gBACJ,IAAI,EAAE;oBACJ,IAAI,EAAE,MAAM;oBACZ,EAAE,EAAE,MAAM;iBACX;gBACD,MAAM,EAAE,aAAa;aACtB;SACF,CAAC;QAEJ,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAEpC,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,GAAG,CAAC,MAAc,EAAE,OAA6B,EAAE,QAAmB;QACpE,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,MAAM,CAAC,EACtC,MAAM,GAAG;YACP,EAAE,EAAE,OAAO;SACZ,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,MAAc,EACd,OAGC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,MAAM,CAAC,EACtC,MAAM,GAAG;YACP,IAAI,EAAE,OAAO;SACd,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAc,EAAE,QAAmB;QACxC,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAEzC,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,IAAI,EACJ,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,cAAc,CACZ,MAAc,EACd,OAA6B,EAC7B,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,MAAM,EAAE,uBAAuB,CAAC,EAC/D,MAAM,GAAG;YACP,EAAE,EAAE,OAAO;SACZ,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,aAAa,CACX,YAAoB,EACpB,OAA6B,EAC7B,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,gBAAgB,EAAE,YAAY,CAAC,EACnD,MAAM,GAAG;YACP,EAAE,EAAE,OAAO;SACZ,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,cAAc,CAAC,MAAc,EAAE,MAAc,EAAE,QAAmB;QAChE,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,gBAAgB,CAAC,EACrC,MAAM,GAAG;YACP,IAAI,EAAE;gBACJ,IAAI,EAAE;oBACJ,IAAI,EAAE,MAAM;oBACZ,EAAE,EAAE,MAAM;iBACX;gBACD,SAAS,EAAE;oBACT,EAAE,EAAE,MAAM;iBACX;aACF;SACF,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,aAAa,CAAC,MAAc,EAAE,KAAa,EAAE,QAAmB;QAC9D,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,gBAAgB,CAAC,EACrC,MAAM,GAAG;YACP,IAAI,EAAE;gBACJ,IAAI,EAAE;oBACJ,IAAI,EAAE,MAAM;oBACZ,EAAE,EAAE,MAAM;iBACX;gBACD,SAAS,EAAE;oBACT,KAAK,EAAE,KAAK;iBACb;aACF;SACF,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,gBAAgB,CACd,YAAoB,EACpB,OAGC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,gBAAgB,EAAE,YAAY,CAAC,EACnD,MAAM,GAAG;YACP,IAAI,EAAE,OAAO;SACd,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,gBAAgB,CAAC,YAAoB,EAAE,QAAmB;QACxD,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,gBAAgB,EAAE,YAAY,CAAC,CAAC;QAEtD,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,IAAI,EACJ,QAAQ,CACT,CAAC;IACJ,CAAC;CACF;AAED;;;;GAIG;AACH,KAAK,CAAC,SAAS,CAAC,gBAAgB,GAAG,mBAAmB,CAAC;AAEvD,iBAAS,KAAK,CAAC"}
|
|
@@ -0,0 +1,161 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @fileoverview Manager for the Box Terms of Service Resource
|
|
3
|
+
*/
|
|
4
|
+
import BoxClient from '../box-client';
|
|
5
|
+
/**
|
|
6
|
+
* Enum value of scope of the custom terms of services set to either managed by an enterprise or enternal to an enterprise
|
|
7
|
+
*
|
|
8
|
+
* @readonly
|
|
9
|
+
* @enum {TermsOfServicesType}
|
|
10
|
+
*/
|
|
11
|
+
declare enum TermsOfServicesType {
|
|
12
|
+
MANAGED = "managed",
|
|
13
|
+
EXTERNAL = "external"
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* Enum value of status of the custom terms of services, either currently enabled or currently disabled
|
|
17
|
+
*
|
|
18
|
+
* @readonly
|
|
19
|
+
* @enum {TermsOfServicesStatus}
|
|
20
|
+
*/
|
|
21
|
+
declare enum TermsOfServicesStatus {
|
|
22
|
+
ENABLED = "enabled",
|
|
23
|
+
DISABLED = "disabled"
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Simple manager for interacting with all 'Terms of Services' and 'Terms of Service User Statuses' endpoints and actions.
|
|
27
|
+
*
|
|
28
|
+
* @param {BoxClient} client The Box API Client that is responsible for making calls to the API
|
|
29
|
+
* @constructor
|
|
30
|
+
*/
|
|
31
|
+
declare class TermsOfService {
|
|
32
|
+
client: BoxClient;
|
|
33
|
+
type: typeof TermsOfServicesType;
|
|
34
|
+
status: typeof TermsOfServicesStatus;
|
|
35
|
+
constructor(client: BoxClient);
|
|
36
|
+
/**
|
|
37
|
+
* Creates a custom terms of services with user specified values
|
|
38
|
+
*
|
|
39
|
+
* API Endpoint: '/terms_of_services'
|
|
40
|
+
* Method: POST
|
|
41
|
+
*
|
|
42
|
+
* @param {TermsOfServicesType} termsOfServicesType - Determine if the custom terms of service is scoped internall or externally to an enterprise
|
|
43
|
+
* @param {TermsOfServicesStatus} termsOfServicesStatus - Determine if the custom terms of service is enabled or disabled
|
|
44
|
+
* @param {string} termsOfServicesText - Text field for message associated with custom terms of services
|
|
45
|
+
* @param {Function} [callback] - Passed the terms of services information if successful, error otherwise
|
|
46
|
+
* @returns {Promise<Object>} A promise resolving to the terms of services object
|
|
47
|
+
*/
|
|
48
|
+
create(termsOfServicesType: TermsOfServicesType, termsOfServicesStatus: TermsOfServicesStatus, termsOfServicesText: string, callback?: Function): any;
|
|
49
|
+
/**
|
|
50
|
+
* Updates a custom terms of services with new specified values
|
|
51
|
+
*
|
|
52
|
+
* API Endpoint: '/terms_of_services/:termsOfServicesID'
|
|
53
|
+
* Method: PUT
|
|
54
|
+
*
|
|
55
|
+
* @param {string} termsOfServicesID - The id of the custom terms of services to update
|
|
56
|
+
* @param {Object} updates - Fields ot the Terms of Service to update
|
|
57
|
+
* @param {TermsOfServicesStatus} [updates.status] - Determine if the custom terms of service is scoped internall or externally to an enterprise
|
|
58
|
+
* @param {string} [updates.text] - Text field for message associated with custom terms of services
|
|
59
|
+
* @param {Function} [callback] - Passed the terms of services updated information if successful, error otherwise
|
|
60
|
+
* @returns {Promise<Object>} A promise resolving to the terms of services object
|
|
61
|
+
*/
|
|
62
|
+
update(termsOfServicesID: string, updates: {
|
|
63
|
+
status?: TermsOfServicesStatus;
|
|
64
|
+
text?: string;
|
|
65
|
+
}, callback?: Function): any;
|
|
66
|
+
/**
|
|
67
|
+
* Gets a specific custom terms of services with specified ID
|
|
68
|
+
*
|
|
69
|
+
* API Endpoint: '/terms_of_services/:termsOfServicesID'
|
|
70
|
+
* Method: GET
|
|
71
|
+
*
|
|
72
|
+
* @param {string} termsOfServicesID - The id of the custom terms of services to retrieve
|
|
73
|
+
* @param {Object} [options] - Additional options. Can be left null in most cases.
|
|
74
|
+
* @param {string} [options.fields] - Comma-separated list of fields to return on the collaboration objects
|
|
75
|
+
* @param {Function} [callback] - Passed the terms of services information with specified ID if successful, error otherwise
|
|
76
|
+
* @returns {Promise<Object>} A promise resolving to the terms of services object
|
|
77
|
+
*/
|
|
78
|
+
get(termsOfServicesID: string, options?: {
|
|
79
|
+
fields?: string;
|
|
80
|
+
}, callback?: Function): any;
|
|
81
|
+
/**
|
|
82
|
+
* Gets custom terms of services for the user's enterprise
|
|
83
|
+
*
|
|
84
|
+
* API Endpoint: '/terms_of_services'
|
|
85
|
+
* Method: GET
|
|
86
|
+
*
|
|
87
|
+
* @param {Object} [options] - Additional options. Can be left null in most cases.
|
|
88
|
+
* @param {TermsOfServiceType} [options.tos_type] - Optional, indicates whether the terms of service is set for external or managed under enterprise
|
|
89
|
+
* @param {string} [options.fields] - Comma-separated list of fields to return on the collaboration objects
|
|
90
|
+
* @param {Function} [callback] - Passed the terms of services information if successful, error otherwise
|
|
91
|
+
* @returns {Promise<Object>} A promise resolving to the terms of services object
|
|
92
|
+
*/
|
|
93
|
+
getAll(options?: {
|
|
94
|
+
tos_type?: TermsOfServicesType;
|
|
95
|
+
fields?: string;
|
|
96
|
+
}, callback?: Function): any;
|
|
97
|
+
/**
|
|
98
|
+
* Accepts/rejects custom terms of services for the user
|
|
99
|
+
*
|
|
100
|
+
* API Endpoint: '/terms_of_service_user_statuses'
|
|
101
|
+
* Method: POST
|
|
102
|
+
*
|
|
103
|
+
* @param {string} termsOfServicesID - Terms of services ID to retrieve user statuses on
|
|
104
|
+
* @param {boolean} isAccepted - Determines wehether the terms of services has been accepted or rejected
|
|
105
|
+
* @param {Object} [options] - Additional options. Can be left null in most cases.
|
|
106
|
+
* @param {string} [options.user_id] - Optional, user id to retrieve terms of service status on, default is current user
|
|
107
|
+
* @param {Function} [callback] - Passed the terms of service user status information if successful, error otherwise
|
|
108
|
+
* @returns {Promise<Object>} A promise resolving to the terms of service user status
|
|
109
|
+
*/
|
|
110
|
+
createUserStatus(termsOfServicesID: string, isAccepted: boolean, options?: {
|
|
111
|
+
user_id?: string;
|
|
112
|
+
}, callback?: Function): any;
|
|
113
|
+
/**
|
|
114
|
+
* Gets a terms os service status given the terms of services id
|
|
115
|
+
*
|
|
116
|
+
* API Endpoint: '/terms_of_service_user_statuses'
|
|
117
|
+
* Method: GET
|
|
118
|
+
*
|
|
119
|
+
* @param {string} termsOfServicesID - The ID of the terms of services to retrieve status on
|
|
120
|
+
* @param {Object} [options] - Additional options. Can be left null in most cases
|
|
121
|
+
* @param {string} [options.user_id] - Optional, the id of the user to retrieve status of custom terms and service on
|
|
122
|
+
* @param {Function} [callback] - Passed the terms of service user status information if successful, error otherwise
|
|
123
|
+
* @returns {Promise<Object>} A promise resolving to the terms of service user status
|
|
124
|
+
*/
|
|
125
|
+
getUserStatus(termsOfServicesID: string, options?: {
|
|
126
|
+
user_id?: string;
|
|
127
|
+
}, callback?: Function): any;
|
|
128
|
+
/**
|
|
129
|
+
* Accepts/rejects custom terms of services for the user
|
|
130
|
+
*
|
|
131
|
+
* API Endpoint: '/terms_of_service_user_statuses'
|
|
132
|
+
* Method: PUT
|
|
133
|
+
*
|
|
134
|
+
* @param {string} termsOfServiceUserStatusID - Terms of service user status object ID
|
|
135
|
+
* @param {boolean} isAccepted - Determines wehether the terms of services has been accepted or rejected
|
|
136
|
+
* @param {Function} [callback] - Passed the terms of service user status updated information if successful, error otherwise
|
|
137
|
+
* @returns {Promise<Object>} A promise resolving to the updated terms of service user status
|
|
138
|
+
*/
|
|
139
|
+
updateUserStatus(termsOfServiceUserStatusID: string, isAccepted: boolean, callback?: Function): any;
|
|
140
|
+
/**
|
|
141
|
+
* Creates a user status for terms of service, if already exists then update existing user status for terms of service
|
|
142
|
+
*
|
|
143
|
+
* API Endpoint: '/terms_of_service_user_statuses'
|
|
144
|
+
* Method: POST/PUT
|
|
145
|
+
*
|
|
146
|
+
* @param {string} termsOfServicesID - Terms of services ID to retrieve user statuses on
|
|
147
|
+
* @param {boolean} isAccepted - Determines wehether the terms of services has been accepted or rejected
|
|
148
|
+
* @param {Object} [options] - Additional options. Can be left null in most cases.
|
|
149
|
+
* @param {string} [options.user_id] - Optional, user id to retrieve terms of service status on, default is current user
|
|
150
|
+
* @param {Function} [callback] - Passed the terms of service user status information if successful, error otherwise
|
|
151
|
+
* @returns {Promise<Object>} A promise resolving to the terms of service user status
|
|
152
|
+
*/
|
|
153
|
+
setUserStatus(termsOfServicesID: string, isAccepted: boolean, options?: {
|
|
154
|
+
user_id?: string;
|
|
155
|
+
}, callback?: Function): any;
|
|
156
|
+
}
|
|
157
|
+
/**
|
|
158
|
+
* @module box-node-sdk/lib/managers/terms-of-service
|
|
159
|
+
* @see {@Link TermsOfService}
|
|
160
|
+
*/
|
|
161
|
+
export = TermsOfService;
|