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,52 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @fileoverview Manager for the Device Pins resource
|
|
3
|
+
* @author mwiller
|
|
4
|
+
*/
|
|
5
|
+
import BoxClient from '../box-client';
|
|
6
|
+
/**
|
|
7
|
+
* Simple manager for interacting with all Device Pin endpoints and actions.
|
|
8
|
+
*
|
|
9
|
+
* @constructor
|
|
10
|
+
* @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
|
|
11
|
+
* @returns {void}
|
|
12
|
+
*/
|
|
13
|
+
declare class DevicePins {
|
|
14
|
+
client: BoxClient;
|
|
15
|
+
constructor(client: BoxClient);
|
|
16
|
+
/**
|
|
17
|
+
* Get a specific device pinning record
|
|
18
|
+
*
|
|
19
|
+
* API Endpoint: '/device_pinners/:pinID'
|
|
20
|
+
* Method: GET
|
|
21
|
+
*
|
|
22
|
+
* @param {string} pinID - The ID of the pin to retrieve
|
|
23
|
+
* @param {Object} [options] - Optional paramters, can be left null in many cases
|
|
24
|
+
* @param {Function} [callback] - Passed the device pin if successful, error otherwise
|
|
25
|
+
* @returns {Promise<Object>} A promise resolving to the device pin object
|
|
26
|
+
*/
|
|
27
|
+
get(pinID: string, options?: Record<string, any>, callback?: Function): any;
|
|
28
|
+
/**
|
|
29
|
+
* Delete a specific device pinning record
|
|
30
|
+
*
|
|
31
|
+
* API Endpoint: '/device_pinners/:pinID'
|
|
32
|
+
* Method: DELETE
|
|
33
|
+
*
|
|
34
|
+
* @param {string} pinID - The ID of the pin to delete
|
|
35
|
+
* @param {Object} [options] - Optional paramters, can be left null in many cases
|
|
36
|
+
* @param {Function} [callback] - Passed nothing if successful, error otherwise
|
|
37
|
+
* @returns {Promise<void>} A promise resolving to nothing
|
|
38
|
+
*/
|
|
39
|
+
delete(pinID: string, options?: Record<string, any>, callback?: Function): any;
|
|
40
|
+
/**
|
|
41
|
+
* Get all device pin records for the current enterprise
|
|
42
|
+
*
|
|
43
|
+
* API Endpoint: '/enterprises/:enterpriseID/device_pinners'
|
|
44
|
+
* Method: GET
|
|
45
|
+
*
|
|
46
|
+
* @param {Object} [options] - Optional paramters, can be left null in many cases
|
|
47
|
+
* @param {Function} [callback] - Passed a list of device pins if successful, error otherwise
|
|
48
|
+
* @returns {Promise<Object>} A promise resolving to the collection of device pins
|
|
49
|
+
*/
|
|
50
|
+
getAll(options?: Record<string, any>, callback?: Function): any;
|
|
51
|
+
}
|
|
52
|
+
export = DevicePins;
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* @fileoverview Manager for the Device Pins resource
|
|
4
|
+
* @author mwiller
|
|
5
|
+
*/
|
|
6
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
7
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
8
|
+
};
|
|
9
|
+
const url_path_1 = __importDefault(require("../util/url-path"));
|
|
10
|
+
// -----------------------------------------------------------------------------
|
|
11
|
+
// Typedefs
|
|
12
|
+
// -----------------------------------------------------------------------------
|
|
13
|
+
// ------------------------------------------------------------------------------
|
|
14
|
+
// Private
|
|
15
|
+
// ------------------------------------------------------------------------------
|
|
16
|
+
const BASE_PATH = '/device_pinners', ENTERPRISES_PATH = '/enterprises', DEVICE_PINNERS_SUBRESOURCE = 'device_pinners';
|
|
17
|
+
// ------------------------------------------------------------------------------
|
|
18
|
+
// Public
|
|
19
|
+
// ------------------------------------------------------------------------------
|
|
20
|
+
/**
|
|
21
|
+
* Simple manager for interacting with all Device Pin endpoints and actions.
|
|
22
|
+
*
|
|
23
|
+
* @constructor
|
|
24
|
+
* @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
|
|
25
|
+
* @returns {void}
|
|
26
|
+
*/
|
|
27
|
+
class DevicePins {
|
|
28
|
+
constructor(client) {
|
|
29
|
+
this.client = client;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Get a specific device pinning record
|
|
33
|
+
*
|
|
34
|
+
* API Endpoint: '/device_pinners/:pinID'
|
|
35
|
+
* Method: GET
|
|
36
|
+
*
|
|
37
|
+
* @param {string} pinID - The ID of the pin to retrieve
|
|
38
|
+
* @param {Object} [options] - Optional paramters, can be left null in many cases
|
|
39
|
+
* @param {Function} [callback] - Passed the device pin if successful, error otherwise
|
|
40
|
+
* @returns {Promise<Object>} A promise resolving to the device pin object
|
|
41
|
+
*/
|
|
42
|
+
get(pinID, options, callback) {
|
|
43
|
+
var apiPath = (0, url_path_1.default)(BASE_PATH, pinID), params = {
|
|
44
|
+
qs: options,
|
|
45
|
+
};
|
|
46
|
+
return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* Delete a specific device pinning record
|
|
50
|
+
*
|
|
51
|
+
* API Endpoint: '/device_pinners/:pinID'
|
|
52
|
+
* Method: DELETE
|
|
53
|
+
*
|
|
54
|
+
* @param {string} pinID - The ID of the pin to delete
|
|
55
|
+
* @param {Object} [options] - Optional paramters, can be left null in many cases
|
|
56
|
+
* @param {Function} [callback] - Passed nothing if successful, error otherwise
|
|
57
|
+
* @returns {Promise<void>} A promise resolving to nothing
|
|
58
|
+
*/
|
|
59
|
+
delete(pinID, options, callback) {
|
|
60
|
+
var apiPath = (0, url_path_1.default)(BASE_PATH, pinID), params = {
|
|
61
|
+
qs: options,
|
|
62
|
+
};
|
|
63
|
+
return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, params, callback);
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* Get all device pin records for the current enterprise
|
|
67
|
+
*
|
|
68
|
+
* API Endpoint: '/enterprises/:enterpriseID/device_pinners'
|
|
69
|
+
* Method: GET
|
|
70
|
+
*
|
|
71
|
+
* @param {Object} [options] - Optional paramters, can be left null in many cases
|
|
72
|
+
* @param {Function} [callback] - Passed a list of device pins if successful, error otherwise
|
|
73
|
+
* @returns {Promise<Object>} A promise resolving to the collection of device pins
|
|
74
|
+
*/
|
|
75
|
+
getAll(options, callback) {
|
|
76
|
+
return this.client.users
|
|
77
|
+
.get(this.client.CURRENT_USER_ID, { fields: 'enterprise' })
|
|
78
|
+
.then((data /* FIXME */) => {
|
|
79
|
+
if (!data.enterprise || !data.enterprise.id) {
|
|
80
|
+
throw new Error('User must be in an enterprise to view device pins');
|
|
81
|
+
}
|
|
82
|
+
var apiPath = (0, url_path_1.default)(ENTERPRISES_PATH, data.enterprise.id, DEVICE_PINNERS_SUBRESOURCE), params = {
|
|
83
|
+
qs: options,
|
|
84
|
+
};
|
|
85
|
+
return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params);
|
|
86
|
+
})
|
|
87
|
+
.asCallback(callback);
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
module.exports = DevicePins;
|
|
91
|
+
//# sourceMappingURL=device-pins.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"device-pins.js","sourceRoot":"","sources":["../../src/managers/device-pins.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;AAOH,gEAAuC;AAEvC,gFAAgF;AAChF,WAAW;AACX,gFAAgF;AAEhF,iFAAiF;AACjF,UAAU;AACV,iFAAiF;AAEjF,MAAM,SAAS,GAAG,iBAAiB,EACjC,gBAAgB,GAAG,cAAc,EACjC,0BAA0B,GAAG,gBAAgB,CAAC;AAEhD,iFAAiF;AACjF,SAAS;AACT,iFAAiF;AAEjF;;;;;;GAMG;AACH,MAAM,UAAU;IAGd,YAAY,MAAiB;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;;;;;OAUG;IACH,GAAG,CAAC,KAAa,EAAE,OAA6B,EAAE,QAAmB;QACnE,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,KAAK,CAAC,EACrC,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,MAAM,CAAC,KAAa,EAAE,OAA6B,EAAE,QAAmB;QACtE,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,KAAK,CAAC,EACrC,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;;;;;;;;;OASG;IACH,MAAM,CAAC,OAA6B,EAAE,QAAmB;QACvD,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK;aACrB,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC;aAC1D,IAAI,CAAC,CAAC,IAAS,CAAC,WAAW,EAAE,EAAE;YAC9B,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;gBAC5C,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;YACvE,CAAC;YAED,IAAI,OAAO,GAAG,IAAA,kBAAO,EACjB,gBAAgB,EAChB,IAAI,CAAC,UAAU,CAAC,EAAE,EAClB,0BAA0B,CAC3B,EACD,MAAM,GAAG;gBACP,EAAE,EAAE,OAAO;aACZ,CAAC;YAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,CACP,CAAC;QACJ,CAAC,CAAC;aACD,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC1B,CAAC;CACF;AAED,iBAAS,UAAU,CAAC"}
|
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @fileoverview Manager for Enterprise resources
|
|
3
|
+
*/
|
|
4
|
+
import BoxClient from '../box-client';
|
|
5
|
+
/**
|
|
6
|
+
* List of valid user types
|
|
7
|
+
* @readonly
|
|
8
|
+
* @enum {EnterpriseUserType}
|
|
9
|
+
*/
|
|
10
|
+
declare enum EnterpriseUserType {
|
|
11
|
+
ALL = "all",
|
|
12
|
+
MANAGED = "managed",
|
|
13
|
+
EXTERNAL = "external"
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* List of valid user statuses
|
|
17
|
+
* @readonly
|
|
18
|
+
* @enum {EnterpriseUserStatus}
|
|
19
|
+
*/
|
|
20
|
+
declare enum EnterpriseUserStatus {
|
|
21
|
+
ACTIVE = "active",
|
|
22
|
+
INACTIVE = "inactive",
|
|
23
|
+
CANNOT_DELETE_OR_EDIT = "cannot_delete_edit",
|
|
24
|
+
CANNOT_DELETE_EDIT_OR_UPLOAD = "cannot_delete_edit_upload"
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* List of valid roles
|
|
28
|
+
* @readonly
|
|
29
|
+
* @enum {EnterpriseRole}
|
|
30
|
+
*/
|
|
31
|
+
declare enum EnterpriseRole {
|
|
32
|
+
USER = "user",
|
|
33
|
+
COADMIN = "coadmin"
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* Simple manager for interacting with all Enterprise endpoints and actions.
|
|
37
|
+
*
|
|
38
|
+
* @constructor
|
|
39
|
+
* @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
|
|
40
|
+
* @returns {void}
|
|
41
|
+
*/
|
|
42
|
+
declare class Enterprise {
|
|
43
|
+
client: BoxClient;
|
|
44
|
+
userTypes: typeof EnterpriseUserType;
|
|
45
|
+
userStatuses: typeof EnterpriseUserStatus;
|
|
46
|
+
userRoles: typeof EnterpriseRole;
|
|
47
|
+
constructor(client: BoxClient);
|
|
48
|
+
/**
|
|
49
|
+
* Get a list of users in the current enterprise
|
|
50
|
+
*
|
|
51
|
+
* API Endpoint: '/users'
|
|
52
|
+
* Method: GET
|
|
53
|
+
*
|
|
54
|
+
* @param {Object} [options] - Optional parameters, can be left null in most cases
|
|
55
|
+
* @param {string} [options.filter_term] - Filter the results to only users starting with the filter_term in either the name or the login
|
|
56
|
+
* @param {int} [options.limit=100] - The number of records to return
|
|
57
|
+
* @param {boolean} [options.usemarker=false] - Whether or not to use marker-based pagination
|
|
58
|
+
* @param {string} [options.marker=''] - The marker for the page at which to start. Default is the first page
|
|
59
|
+
* @param {int} [options.offset=0] - The record at which to start
|
|
60
|
+
* @param {EnterpriseUserType} [options.user_type=managed] - The type of user to search for
|
|
61
|
+
* @param {Function} [callback] - Passed the list of users if successful, error otherwise
|
|
62
|
+
* @returns {Promise<Object>} A promise resolving to the collection of users
|
|
63
|
+
*/
|
|
64
|
+
getUsers(options?: {
|
|
65
|
+
filter_term?: string;
|
|
66
|
+
limit?: number;
|
|
67
|
+
usemarker?: boolean;
|
|
68
|
+
marker?: string;
|
|
69
|
+
offset?: number;
|
|
70
|
+
user_type?: EnterpriseUserType;
|
|
71
|
+
}, callback?: Function): any;
|
|
72
|
+
/**
|
|
73
|
+
* Invites a user to join the enterprise
|
|
74
|
+
*
|
|
75
|
+
* API Endpoint: '/invites'
|
|
76
|
+
* Method: POST
|
|
77
|
+
*
|
|
78
|
+
* @param {string} enterpriseID - The ID of the enterprise to invite the user to
|
|
79
|
+
* @param {string} email - The email address of the user to invite
|
|
80
|
+
* @param {Function} [callback] - Passed the invite object if successful, error otherwise
|
|
81
|
+
* @returns {Promise<Object>} A promise resolving to the invite object
|
|
82
|
+
*/
|
|
83
|
+
inviteUser(enterpriseID: string, email: string, callback?: Function): any;
|
|
84
|
+
/**
|
|
85
|
+
* Create a new user in the current enterprise
|
|
86
|
+
*
|
|
87
|
+
* API Endpoint: '/users'
|
|
88
|
+
* Method: POST
|
|
89
|
+
*
|
|
90
|
+
* @param {string} login - The email address this user uses to login
|
|
91
|
+
* @param {string} name - The name of this user
|
|
92
|
+
* @param {Object} [options] - Optional parameters, can be left null in most cases
|
|
93
|
+
* @param {EnterpriseRole} [options.role] - This user’s enterprise role
|
|
94
|
+
* @param {string} [options.language] - The user's language
|
|
95
|
+
* @param {boolean} [options.is_sync_enabled] - Whether or not this user can use Box Sync
|
|
96
|
+
* @param {string} [options.job_title] - The user’s job title
|
|
97
|
+
* @param {string} [options.phone] - The user’s phone number
|
|
98
|
+
* @param {string} [options.address] - The user’s address
|
|
99
|
+
* @param {int} [options.space_amount] - The user’s total available storage space in bytes
|
|
100
|
+
* @param {Array} [options.tracking_codes] - An array of key/value pairs set by the user’s admin
|
|
101
|
+
* @param {EnterpriseUserStatus} [options.status] - The user's status
|
|
102
|
+
* @param {boolean} [options.can_see_managed_users] - Whether the user should be able to see other managed users
|
|
103
|
+
* @param {string} [options.timezone] - The user's timezone
|
|
104
|
+
* @param {boolean} [options.is_exempt_from_device_limits] - Whether to exempt this user from Enterprise device limits
|
|
105
|
+
* @param {boolean} [options.is_exempt_from_login_verification] - Whether or not this user must use two-factor authentication
|
|
106
|
+
* @param {boolean} [options.is_external_collab_restricted] - Whether the user is allowed to collaborate with users outside their enterprise
|
|
107
|
+
* @param {Function} [callback] - Passed the created user if successful, error otherwise
|
|
108
|
+
* @returns {Promise<Object>} A promise resolving to the created user
|
|
109
|
+
*/
|
|
110
|
+
addUser(login: string, name: string, options?: {
|
|
111
|
+
role?: EnterpriseRole;
|
|
112
|
+
language?: string;
|
|
113
|
+
is_sync_enabled?: boolean;
|
|
114
|
+
job_title?: string;
|
|
115
|
+
phone?: string;
|
|
116
|
+
address?: string;
|
|
117
|
+
space_amount?: number;
|
|
118
|
+
tracking_codes?: [string, any][];
|
|
119
|
+
status?: EnterpriseUserStatus;
|
|
120
|
+
can_see_managed_users?: boolean;
|
|
121
|
+
timezone?: string;
|
|
122
|
+
is_exempt_from_device_limits?: boolean;
|
|
123
|
+
is_exempt_from_login_verification?: boolean;
|
|
124
|
+
is_external_collab_restricted?: boolean;
|
|
125
|
+
}, callback?: Function): any;
|
|
126
|
+
/**
|
|
127
|
+
* Create a new app user in the current enterprise
|
|
128
|
+
*
|
|
129
|
+
* API Endpoint: '/users'
|
|
130
|
+
* Method: POST
|
|
131
|
+
*
|
|
132
|
+
* @param {string} name - The name of this user
|
|
133
|
+
* @param {Object} [options] - Optional parameters, can be left null in most cases
|
|
134
|
+
* @param {string} [options.language] - The user's language
|
|
135
|
+
* @param {string} [options.job_title] - The user’s job title
|
|
136
|
+
* @param {string} [options.phone] - The user’s phone number
|
|
137
|
+
* @param {string} [options.address] - The user’s address
|
|
138
|
+
* @param {int} [options.space_amount] - The user’s total available storage space in bytes
|
|
139
|
+
* @param {string} [options.timezone] - The user's timezone
|
|
140
|
+
* @param {Function} [callback] - Passed the created user if successful, error otherwise
|
|
141
|
+
* @returns {Promise<Object>} A promise resolving to the created user
|
|
142
|
+
*/
|
|
143
|
+
addAppUser(name: string, options?: {
|
|
144
|
+
language?: string;
|
|
145
|
+
job_title?: string;
|
|
146
|
+
phone?: string;
|
|
147
|
+
address?: string;
|
|
148
|
+
space_amount?: number;
|
|
149
|
+
timezone?: string;
|
|
150
|
+
}, callback?: Function): any;
|
|
151
|
+
/**
|
|
152
|
+
* Transfers all of a user's files into another user's account.
|
|
153
|
+
*
|
|
154
|
+
* API Endpoint: '/users/:sourceUserID/folders/0'
|
|
155
|
+
* Method: PUT
|
|
156
|
+
*
|
|
157
|
+
* @param {string} sourceUserID - The ID of the user whose files will be transferred
|
|
158
|
+
* @param {string} destUserID - The ID of the user to transfer the files to
|
|
159
|
+
* @param {Function} [callback] - Passed the new folder which contains all the files if successful, error otherwise
|
|
160
|
+
* @returns {Promise<Object>} A promise resolving to the folder containing the transferred content
|
|
161
|
+
*/
|
|
162
|
+
transferUserContent(sourceUserID: string, destUserID: string, callback?: Function): any;
|
|
163
|
+
}
|
|
164
|
+
export = Enterprise;
|
|
@@ -0,0 +1,193 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* @fileoverview Manager for Enterprise resources
|
|
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
|
+
* List of valid user types
|
|
14
|
+
* @readonly
|
|
15
|
+
* @enum {EnterpriseUserType}
|
|
16
|
+
*/
|
|
17
|
+
var EnterpriseUserType;
|
|
18
|
+
(function (EnterpriseUserType) {
|
|
19
|
+
EnterpriseUserType["ALL"] = "all";
|
|
20
|
+
EnterpriseUserType["MANAGED"] = "managed";
|
|
21
|
+
EnterpriseUserType["EXTERNAL"] = "external";
|
|
22
|
+
})(EnterpriseUserType || (EnterpriseUserType = {}));
|
|
23
|
+
/**
|
|
24
|
+
* List of valid user statuses
|
|
25
|
+
* @readonly
|
|
26
|
+
* @enum {EnterpriseUserStatus}
|
|
27
|
+
*/
|
|
28
|
+
var EnterpriseUserStatus;
|
|
29
|
+
(function (EnterpriseUserStatus) {
|
|
30
|
+
EnterpriseUserStatus["ACTIVE"] = "active";
|
|
31
|
+
EnterpriseUserStatus["INACTIVE"] = "inactive";
|
|
32
|
+
EnterpriseUserStatus["CANNOT_DELETE_OR_EDIT"] = "cannot_delete_edit";
|
|
33
|
+
EnterpriseUserStatus["CANNOT_DELETE_EDIT_OR_UPLOAD"] = "cannot_delete_edit_upload";
|
|
34
|
+
})(EnterpriseUserStatus || (EnterpriseUserStatus = {}));
|
|
35
|
+
/**
|
|
36
|
+
* List of valid roles
|
|
37
|
+
* @readonly
|
|
38
|
+
* @enum {EnterpriseRole}
|
|
39
|
+
*/
|
|
40
|
+
var EnterpriseRole;
|
|
41
|
+
(function (EnterpriseRole) {
|
|
42
|
+
EnterpriseRole["USER"] = "user";
|
|
43
|
+
EnterpriseRole["COADMIN"] = "coadmin";
|
|
44
|
+
})(EnterpriseRole || (EnterpriseRole = {}));
|
|
45
|
+
// -----------------------------------------------------------------------------
|
|
46
|
+
// Private
|
|
47
|
+
// -----------------------------------------------------------------------------
|
|
48
|
+
const USERS_PATH = '/users', INVITES_PATH = '/invites', FOLDERS_SUBRESOURCE = 'folders', ROOT_FOLDER_ID = '0';
|
|
49
|
+
// -----------------------------------------------------------------------------
|
|
50
|
+
// Public
|
|
51
|
+
// -----------------------------------------------------------------------------
|
|
52
|
+
/**
|
|
53
|
+
* Simple manager for interacting with all Enterprise endpoints and actions.
|
|
54
|
+
*
|
|
55
|
+
* @constructor
|
|
56
|
+
* @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
|
|
57
|
+
* @returns {void}
|
|
58
|
+
*/
|
|
59
|
+
class Enterprise {
|
|
60
|
+
constructor(client) {
|
|
61
|
+
this.client = client;
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* Get a list of users in the current enterprise
|
|
65
|
+
*
|
|
66
|
+
* API Endpoint: '/users'
|
|
67
|
+
* Method: GET
|
|
68
|
+
*
|
|
69
|
+
* @param {Object} [options] - Optional parameters, can be left null in most cases
|
|
70
|
+
* @param {string} [options.filter_term] - Filter the results to only users starting with the filter_term in either the name or the login
|
|
71
|
+
* @param {int} [options.limit=100] - The number of records to return
|
|
72
|
+
* @param {boolean} [options.usemarker=false] - Whether or not to use marker-based pagination
|
|
73
|
+
* @param {string} [options.marker=''] - The marker for the page at which to start. Default is the first page
|
|
74
|
+
* @param {int} [options.offset=0] - The record at which to start
|
|
75
|
+
* @param {EnterpriseUserType} [options.user_type=managed] - The type of user to search for
|
|
76
|
+
* @param {Function} [callback] - Passed the list of users if successful, error otherwise
|
|
77
|
+
* @returns {Promise<Object>} A promise resolving to the collection of users
|
|
78
|
+
*/
|
|
79
|
+
getUsers(options, callback) {
|
|
80
|
+
var apiPath = (0, url_path_1.default)(USERS_PATH), params = {
|
|
81
|
+
qs: options,
|
|
82
|
+
};
|
|
83
|
+
return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* Invites a user to join the enterprise
|
|
87
|
+
*
|
|
88
|
+
* API Endpoint: '/invites'
|
|
89
|
+
* Method: POST
|
|
90
|
+
*
|
|
91
|
+
* @param {string} enterpriseID - The ID of the enterprise to invite the user to
|
|
92
|
+
* @param {string} email - The email address of the user to invite
|
|
93
|
+
* @param {Function} [callback] - Passed the invite object if successful, error otherwise
|
|
94
|
+
* @returns {Promise<Object>} A promise resolving to the invite object
|
|
95
|
+
*/
|
|
96
|
+
inviteUser(enterpriseID, email, callback) {
|
|
97
|
+
var apiPath = (0, url_path_1.default)(INVITES_PATH), params = {
|
|
98
|
+
body: {
|
|
99
|
+
enterprise: {
|
|
100
|
+
id: enterpriseID,
|
|
101
|
+
},
|
|
102
|
+
actionable_by: {
|
|
103
|
+
login: email,
|
|
104
|
+
},
|
|
105
|
+
},
|
|
106
|
+
};
|
|
107
|
+
return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
|
|
108
|
+
}
|
|
109
|
+
/**
|
|
110
|
+
* Create a new user in the current enterprise
|
|
111
|
+
*
|
|
112
|
+
* API Endpoint: '/users'
|
|
113
|
+
* Method: POST
|
|
114
|
+
*
|
|
115
|
+
* @param {string} login - The email address this user uses to login
|
|
116
|
+
* @param {string} name - The name of this user
|
|
117
|
+
* @param {Object} [options] - Optional parameters, can be left null in most cases
|
|
118
|
+
* @param {EnterpriseRole} [options.role] - This user’s enterprise role
|
|
119
|
+
* @param {string} [options.language] - The user's language
|
|
120
|
+
* @param {boolean} [options.is_sync_enabled] - Whether or not this user can use Box Sync
|
|
121
|
+
* @param {string} [options.job_title] - The user’s job title
|
|
122
|
+
* @param {string} [options.phone] - The user’s phone number
|
|
123
|
+
* @param {string} [options.address] - The user’s address
|
|
124
|
+
* @param {int} [options.space_amount] - The user’s total available storage space in bytes
|
|
125
|
+
* @param {Array} [options.tracking_codes] - An array of key/value pairs set by the user’s admin
|
|
126
|
+
* @param {EnterpriseUserStatus} [options.status] - The user's status
|
|
127
|
+
* @param {boolean} [options.can_see_managed_users] - Whether the user should be able to see other managed users
|
|
128
|
+
* @param {string} [options.timezone] - The user's timezone
|
|
129
|
+
* @param {boolean} [options.is_exempt_from_device_limits] - Whether to exempt this user from Enterprise device limits
|
|
130
|
+
* @param {boolean} [options.is_exempt_from_login_verification] - Whether or not this user must use two-factor authentication
|
|
131
|
+
* @param {boolean} [options.is_external_collab_restricted] - Whether the user is allowed to collaborate with users outside their enterprise
|
|
132
|
+
* @param {Function} [callback] - Passed the created user if successful, error otherwise
|
|
133
|
+
* @returns {Promise<Object>} A promise resolving to the created user
|
|
134
|
+
*/
|
|
135
|
+
addUser(login, name, options, callback) {
|
|
136
|
+
var apiPath = (0, url_path_1.default)(USERS_PATH), params = {
|
|
137
|
+
body: { login, name },
|
|
138
|
+
};
|
|
139
|
+
Object.assign(params.body, options);
|
|
140
|
+
return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
|
|
141
|
+
}
|
|
142
|
+
/**
|
|
143
|
+
* Create a new app user in the current enterprise
|
|
144
|
+
*
|
|
145
|
+
* API Endpoint: '/users'
|
|
146
|
+
* Method: POST
|
|
147
|
+
*
|
|
148
|
+
* @param {string} name - The name of this user
|
|
149
|
+
* @param {Object} [options] - Optional parameters, can be left null in most cases
|
|
150
|
+
* @param {string} [options.language] - The user's language
|
|
151
|
+
* @param {string} [options.job_title] - The user’s job title
|
|
152
|
+
* @param {string} [options.phone] - The user’s phone number
|
|
153
|
+
* @param {string} [options.address] - The user’s address
|
|
154
|
+
* @param {int} [options.space_amount] - The user’s total available storage space in bytes
|
|
155
|
+
* @param {string} [options.timezone] - The user's timezone
|
|
156
|
+
* @param {Function} [callback] - Passed the created user if successful, error otherwise
|
|
157
|
+
* @returns {Promise<Object>} A promise resolving to the created user
|
|
158
|
+
*/
|
|
159
|
+
addAppUser(name, options, callback) {
|
|
160
|
+
var apiPath = (0, url_path_1.default)(USERS_PATH), params = {
|
|
161
|
+
body: {
|
|
162
|
+
name,
|
|
163
|
+
is_platform_access_only: true,
|
|
164
|
+
},
|
|
165
|
+
};
|
|
166
|
+
Object.assign(params.body, options);
|
|
167
|
+
return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
|
|
168
|
+
}
|
|
169
|
+
/**
|
|
170
|
+
* Transfers all of a user's files into another user's account.
|
|
171
|
+
*
|
|
172
|
+
* API Endpoint: '/users/:sourceUserID/folders/0'
|
|
173
|
+
* Method: PUT
|
|
174
|
+
*
|
|
175
|
+
* @param {string} sourceUserID - The ID of the user whose files will be transferred
|
|
176
|
+
* @param {string} destUserID - The ID of the user to transfer the files to
|
|
177
|
+
* @param {Function} [callback] - Passed the new folder which contains all the files if successful, error otherwise
|
|
178
|
+
* @returns {Promise<Object>} A promise resolving to the folder containing the transferred content
|
|
179
|
+
*/
|
|
180
|
+
transferUserContent(sourceUserID, destUserID, callback) {
|
|
181
|
+
var apiPath = (0, url_path_1.default)(USERS_PATH, sourceUserID, FOLDERS_SUBRESOURCE, ROOT_FOLDER_ID), params = {
|
|
182
|
+
body: {
|
|
183
|
+
owned_by: { id: destUserID },
|
|
184
|
+
},
|
|
185
|
+
};
|
|
186
|
+
return this.client.wrapWithDefaultHandler(this.client.put)(apiPath, params, callback);
|
|
187
|
+
}
|
|
188
|
+
}
|
|
189
|
+
Enterprise.prototype.userTypes = EnterpriseUserType;
|
|
190
|
+
Enterprise.prototype.userStatuses = EnterpriseUserStatus;
|
|
191
|
+
Enterprise.prototype.userRoles = EnterpriseRole;
|
|
192
|
+
module.exports = Enterprise;
|
|
193
|
+
//# sourceMappingURL=enterprise.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"enterprise.js","sourceRoot":"","sources":["../../src/managers/enterprise.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;AAOH,gEAAuC;AAEvC,gFAAgF;AAChF,WAAW;AACX,gFAAgF;AAEhF;;;;GAIG;AACH,IAAK,kBAIJ;AAJD,WAAK,kBAAkB;IACrB,iCAAW,CAAA;IACX,yCAAmB,CAAA;IACnB,2CAAqB,CAAA;AACvB,CAAC,EAJI,kBAAkB,KAAlB,kBAAkB,QAItB;AAED;;;;GAIG;AACH,IAAK,oBAKJ;AALD,WAAK,oBAAoB;IACvB,yCAAiB,CAAA;IACjB,6CAAqB,CAAA;IACrB,oEAA4C,CAAA;IAC5C,kFAA0D,CAAA;AAC5D,CAAC,EALI,oBAAoB,KAApB,oBAAoB,QAKxB;AAED;;;;GAIG;AACH,IAAK,cAGJ;AAHD,WAAK,cAAc;IACjB,+BAAa,CAAA;IACb,qCAAmB,CAAA;AACrB,CAAC,EAHI,cAAc,KAAd,cAAc,QAGlB;AAED,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF,MAAM,UAAU,GAAG,QAAQ,EACzB,YAAY,GAAG,UAAU,EACzB,mBAAmB,GAAG,SAAS,EAC/B,cAAc,GAAG,GAAG,CAAC;AAEvB,gFAAgF;AAChF,SAAS;AACT,gFAAgF;AAEhF;;;;;;GAMG;AACH,MAAM,UAAU;IAMd,YAAY,MAAiB;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CACN,OAOC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,UAAU,CAAC,EAC/B,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,UAAU,CAAC,YAAoB,EAAE,KAAa,EAAE,QAAmB;QACjE,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,YAAY,CAAC,EACjC,MAAM,GAAG;YACP,IAAI,EAAE;gBACJ,UAAU,EAAE;oBACV,EAAE,EAAE,YAAY;iBACjB;gBACD,aAAa,EAAE;oBACb,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;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,OAAO,CACL,KAAa,EACb,IAAY,EACZ,OAeC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,UAAU,CAAC,EAC/B,MAAM,GAAG;YACP,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE;SACtB,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;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CACR,IAAY,EACZ,OAOC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,UAAU,CAAC,EAC/B,MAAM,GAAG;YACP,IAAI,EAAE;gBACJ,IAAI;gBACJ,uBAAuB,EAAE,IAAI;aAC9B;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,mBAAmB,CACjB,YAAoB,EACpB,UAAkB,EAClB,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EACjB,UAAU,EACV,YAAY,EACZ,mBAAmB,EACnB,cAAc,CACf,EACD,MAAM,GAAG;YACP,IAAI,EAAE;gBACJ,QAAQ,EAAE,EAAE,EAAE,EAAE,UAAU,EAAE;aAC7B;SACF,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;CACF;AAED,UAAU,CAAC,SAAS,CAAC,SAAS,GAAG,kBAAkB,CAAC;AACpD,UAAU,CAAC,SAAS,CAAC,YAAY,GAAG,oBAAoB,CAAC;AACzD,UAAU,CAAC,SAAS,CAAC,SAAS,GAAG,cAAc,CAAC;AAEhD,iBAAS,UAAU,CAAC"}
|