@unofficialbox/box-open-sdk 0.1.0
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 +13 -0
- package/dist/cjs/auth.js +112 -0
- package/dist/cjs/buildinfo.js +10 -0
- package/dist/cjs/client.js +268 -0
- package/dist/cjs/errors.js +20 -0
- package/dist/cjs/index.js +43 -0
- package/dist/cjs/internal.js +37 -0
- package/dist/cjs/jwt.js +122 -0
- package/dist/cjs/managers/ai.js +106 -0
- package/dist/cjs/managers/ai_studio.js +131 -0
- package/dist/cjs/managers/app_item_associations.js +119 -0
- package/dist/cjs/managers/archives.js +110 -0
- package/dist/cjs/managers/authorization.js +149 -0
- package/dist/cjs/managers/automate_workflows.js +91 -0
- package/dist/cjs/managers/avatars.js +76 -0
- package/dist/cjs/managers/chunked_uploads.js +156 -0
- package/dist/cjs/managers/classifications.js +94 -0
- package/dist/cjs/managers/collaboration_allowlist_entries.js +104 -0
- package/dist/cjs/managers/collaboration_allowlist_exempt_targets.js +104 -0
- package/dist/cjs/managers/collections.js +124 -0
- package/dist/cjs/managers/comments.js +131 -0
- package/dist/cjs/managers/device_pinners.js +99 -0
- package/dist/cjs/managers/docgen.js +133 -0
- package/dist/cjs/managers/docgen_template.js +178 -0
- package/dist/cjs/managers/downloads.js +69 -0
- package/dist/cjs/managers/email_aliases.js +78 -0
- package/dist/cjs/managers/enterprise_configurations.js +58 -0
- package/dist/cjs/managers/events.js +82 -0
- package/dist/cjs/managers/external_users.js +58 -0
- package/dist/cjs/managers/file_classifications.js +97 -0
- package/dist/cjs/managers/file_metadata.js +115 -0
- package/dist/cjs/managers/file_requests.js +90 -0
- package/dist/cjs/managers/file_version_legal_holds.js +88 -0
- package/dist/cjs/managers/file_version_retentions.js +105 -0
- package/dist/cjs/managers/file_versions.js +140 -0
- package/dist/cjs/managers/file_watermarks.js +77 -0
- package/dist/cjs/managers/files.js +138 -0
- package/dist/cjs/managers/folder_classifications.js +97 -0
- package/dist/cjs/managers/folder_locks.js +73 -0
- package/dist/cjs/managers/folder_metadata.js +111 -0
- package/dist/cjs/managers/folder_watermarks.js +77 -0
- package/dist/cjs/managers/folders.js +191 -0
- package/dist/cjs/managers/groups.js +132 -0
- package/dist/cjs/managers/hub_collaborations.js +121 -0
- package/dist/cjs/managers/hub_document.js +113 -0
- package/dist/cjs/managers/hub_items.js +96 -0
- package/dist/cjs/managers/hubs.js +186 -0
- package/dist/cjs/managers/index.js +102 -0
- package/dist/cjs/managers/integration_mappings.js +178 -0
- package/dist/cjs/managers/invites.js +74 -0
- package/dist/cjs/managers/legal_hold_policies.js +121 -0
- package/dist/cjs/managers/legal_hold_policy_assignments.js +186 -0
- package/dist/cjs/managers/list_collaborations.js +185 -0
- package/dist/cjs/managers/memberships.js +160 -0
- package/dist/cjs/managers/metadata_cascade_policies.js +118 -0
- package/dist/cjs/managers/metadata_taxonomies.js +322 -0
- package/dist/cjs/managers/metadata_templates.js +196 -0
- package/dist/cjs/managers/notes.js +58 -0
- package/dist/cjs/managers/recent_items.js +80 -0
- package/dist/cjs/managers/retention_policies.js +131 -0
- package/dist/cjs/managers/retention_policy_assignments.js +182 -0
- package/dist/cjs/managers/search.js +130 -0
- package/dist/cjs/managers/session_termination.js +68 -0
- package/dist/cjs/managers/shared_links_app_items.js +55 -0
- package/dist/cjs/managers/shared_links_files.js +109 -0
- package/dist/cjs/managers/shared_links_folders.js +109 -0
- package/dist/cjs/managers/shared_links_web_links.js +109 -0
- package/dist/cjs/managers/shield_information_barrier_reports.js +98 -0
- package/dist/cjs/managers/shield_information_barrier_segment_members.js +105 -0
- package/dist/cjs/managers/shield_information_barrier_segment_restrictions.js +105 -0
- package/dist/cjs/managers/shield_information_barrier_segments.js +116 -0
- package/dist/cjs/managers/shield_information_barriers.js +108 -0
- package/dist/cjs/managers/shield_lists.js +97 -0
- package/dist/cjs/managers/sign_requests.js +123 -0
- package/dist/cjs/managers/sign_templates.js +87 -0
- package/dist/cjs/managers/skills.js +106 -0
- package/dist/cjs/managers/storage_policies.js +90 -0
- package/dist/cjs/managers/storage_policy_assignments.js +114 -0
- package/dist/cjs/managers/task_assignments.js +94 -0
- package/dist/cjs/managers/tasks.js +94 -0
- package/dist/cjs/managers/terms_of_service_user_statuses.js +81 -0
- package/dist/cjs/managers/terms_of_services.js +89 -0
- package/dist/cjs/managers/transfer.js +67 -0
- package/dist/cjs/managers/trashed_files.js +84 -0
- package/dist/cjs/managers/trashed_folders.js +84 -0
- package/dist/cjs/managers/trashed_items.js +94 -0
- package/dist/cjs/managers/trashed_web_links.js +84 -0
- package/dist/cjs/managers/uploads.js +98 -0
- package/dist/cjs/managers/user_collaborations.js +95 -0
- package/dist/cjs/managers/users.js +165 -0
- package/dist/cjs/managers/web_links.js +88 -0
- package/dist/cjs/managers/webhooks.js +115 -0
- package/dist/cjs/managers/workflows.js +92 -0
- package/dist/cjs/managers/zip_downloads.js +76 -0
- package/dist/cjs/models/index.js +38 -0
- package/dist/cjs/models/schemas.js +3 -0
- package/dist/cjs/package.json +3 -0
- package/dist/cjs/runtime.js +304 -0
- package/dist/cjs/tokens.js +121 -0
- package/dist/esm/auth.js +105 -0
- package/dist/esm/buildinfo.js +7 -0
- package/dist/esm/client.js +264 -0
- package/dist/esm/errors.js +16 -0
- package/dist/esm/index.js +6 -0
- package/dist/esm/internal.js +32 -0
- package/dist/esm/jwt.js +86 -0
- package/dist/esm/managers/ai.js +69 -0
- package/dist/esm/managers/ai_studio.js +94 -0
- package/dist/esm/managers/app_item_associations.js +82 -0
- package/dist/esm/managers/archives.js +73 -0
- package/dist/esm/managers/authorization.js +112 -0
- package/dist/esm/managers/automate_workflows.js +54 -0
- package/dist/esm/managers/avatars.js +39 -0
- package/dist/esm/managers/chunked_uploads.js +119 -0
- package/dist/esm/managers/classifications.js +57 -0
- package/dist/esm/managers/collaboration_allowlist_entries.js +67 -0
- package/dist/esm/managers/collaboration_allowlist_exempt_targets.js +67 -0
- package/dist/esm/managers/collections.js +87 -0
- package/dist/esm/managers/comments.js +94 -0
- package/dist/esm/managers/device_pinners.js +62 -0
- package/dist/esm/managers/docgen.js +96 -0
- package/dist/esm/managers/docgen_template.js +141 -0
- package/dist/esm/managers/downloads.js +32 -0
- package/dist/esm/managers/email_aliases.js +41 -0
- package/dist/esm/managers/enterprise_configurations.js +21 -0
- package/dist/esm/managers/events.js +45 -0
- package/dist/esm/managers/external_users.js +21 -0
- package/dist/esm/managers/file_classifications.js +60 -0
- package/dist/esm/managers/file_metadata.js +78 -0
- package/dist/esm/managers/file_requests.js +53 -0
- package/dist/esm/managers/file_version_legal_holds.js +51 -0
- package/dist/esm/managers/file_version_retentions.js +68 -0
- package/dist/esm/managers/file_versions.js +103 -0
- package/dist/esm/managers/file_watermarks.js +40 -0
- package/dist/esm/managers/files.js +101 -0
- package/dist/esm/managers/folder_classifications.js +60 -0
- package/dist/esm/managers/folder_locks.js +36 -0
- package/dist/esm/managers/folder_metadata.js +74 -0
- package/dist/esm/managers/folder_watermarks.js +40 -0
- package/dist/esm/managers/folders.js +154 -0
- package/dist/esm/managers/groups.js +95 -0
- package/dist/esm/managers/hub_collaborations.js +84 -0
- package/dist/esm/managers/hub_document.js +76 -0
- package/dist/esm/managers/hub_items.js +59 -0
- package/dist/esm/managers/hubs.js +149 -0
- package/dist/esm/managers/index.js +86 -0
- package/dist/esm/managers/integration_mappings.js +141 -0
- package/dist/esm/managers/invites.js +37 -0
- package/dist/esm/managers/legal_hold_policies.js +84 -0
- package/dist/esm/managers/legal_hold_policy_assignments.js +149 -0
- package/dist/esm/managers/list_collaborations.js +148 -0
- package/dist/esm/managers/memberships.js +123 -0
- package/dist/esm/managers/metadata_cascade_policies.js +81 -0
- package/dist/esm/managers/metadata_taxonomies.js +285 -0
- package/dist/esm/managers/metadata_templates.js +159 -0
- package/dist/esm/managers/notes.js +21 -0
- package/dist/esm/managers/recent_items.js +43 -0
- package/dist/esm/managers/retention_policies.js +94 -0
- package/dist/esm/managers/retention_policy_assignments.js +145 -0
- package/dist/esm/managers/search.js +93 -0
- package/dist/esm/managers/session_termination.js +31 -0
- package/dist/esm/managers/shared_links_app_items.js +18 -0
- package/dist/esm/managers/shared_links_files.js +72 -0
- package/dist/esm/managers/shared_links_folders.js +72 -0
- package/dist/esm/managers/shared_links_web_links.js +72 -0
- package/dist/esm/managers/shield_information_barrier_reports.js +61 -0
- package/dist/esm/managers/shield_information_barrier_segment_members.js +68 -0
- package/dist/esm/managers/shield_information_barrier_segment_restrictions.js +68 -0
- package/dist/esm/managers/shield_information_barrier_segments.js +79 -0
- package/dist/esm/managers/shield_information_barriers.js +71 -0
- package/dist/esm/managers/shield_lists.js +60 -0
- package/dist/esm/managers/sign_requests.js +86 -0
- package/dist/esm/managers/sign_templates.js +50 -0
- package/dist/esm/managers/skills.js +69 -0
- package/dist/esm/managers/storage_policies.js +53 -0
- package/dist/esm/managers/storage_policy_assignments.js +77 -0
- package/dist/esm/managers/task_assignments.js +57 -0
- package/dist/esm/managers/tasks.js +57 -0
- package/dist/esm/managers/terms_of_service_user_statuses.js +44 -0
- package/dist/esm/managers/terms_of_services.js +52 -0
- package/dist/esm/managers/transfer.js +30 -0
- package/dist/esm/managers/trashed_files.js +47 -0
- package/dist/esm/managers/trashed_folders.js +47 -0
- package/dist/esm/managers/trashed_items.js +57 -0
- package/dist/esm/managers/trashed_web_links.js +47 -0
- package/dist/esm/managers/uploads.js +61 -0
- package/dist/esm/managers/user_collaborations.js +58 -0
- package/dist/esm/managers/users.js +128 -0
- package/dist/esm/managers/web_links.js +51 -0
- package/dist/esm/managers/webhooks.js +78 -0
- package/dist/esm/managers/workflows.js +55 -0
- package/dist/esm/managers/zip_downloads.js +39 -0
- package/dist/esm/models/index.js +2 -0
- package/dist/esm/models/schemas.js +2 -0
- package/dist/esm/package.json +3 -0
- package/dist/esm/runtime.js +272 -0
- package/dist/esm/tokens.js +116 -0
- package/dist/types/auth.d.ts +56 -0
- package/dist/types/buildinfo.d.ts +6 -0
- package/dist/types/client.d.ts +176 -0
- package/dist/types/errors.d.ts +19 -0
- package/dist/types/index.d.ts +5 -0
- package/dist/types/internal.d.ts +9 -0
- package/dist/types/jwt.d.ts +23 -0
- package/dist/types/managers/ai.d.ts +17 -0
- package/dist/types/managers/ai_studio.d.ts +27 -0
- package/dist/types/managers/app_item_associations.d.ts +25 -0
- package/dist/types/managers/archives.d.ts +18 -0
- package/dist/types/managers/authorization.d.ts +17 -0
- package/dist/types/managers/automate_workflows.d.ts +16 -0
- package/dist/types/managers/avatars.d.ts +10 -0
- package/dist/types/managers/chunked_uploads.d.ts +26 -0
- package/dist/types/managers/classifications.d.ts +11 -0
- package/dist/types/managers/collaboration_allowlist_entries.d.ts +18 -0
- package/dist/types/managers/collaboration_allowlist_exempt_targets.d.ts +18 -0
- package/dist/types/managers/collections.d.ts +26 -0
- package/dist/types/managers/comments.d.ts +32 -0
- package/dist/types/managers/device_pinners.d.ts +18 -0
- package/dist/types/managers/docgen.d.ts +25 -0
- package/dist/types/managers/docgen_template.d.ts +35 -0
- package/dist/types/managers/downloads.d.ts +14 -0
- package/dist/types/managers/email_aliases.d.ts +10 -0
- package/dist/types/managers/enterprise_configurations.d.ts +8 -0
- package/dist/types/managers/events.d.ts +18 -0
- package/dist/types/managers/external_users.d.ts +8 -0
- package/dist/types/managers/file_classifications.d.ts +11 -0
- package/dist/types/managers/file_metadata.d.ts +20 -0
- package/dist/types/managers/file_requests.d.ts +15 -0
- package/dist/types/managers/file_version_legal_holds.d.ts +16 -0
- package/dist/types/managers/file_version_retentions.d.ts +22 -0
- package/dist/types/managers/file_versions.d.ts +32 -0
- package/dist/types/managers/file_watermarks.d.ts +10 -0
- package/dist/types/managers/files.d.ts +39 -0
- package/dist/types/managers/folder_classifications.d.ts +11 -0
- package/dist/types/managers/folder_locks.d.ts +10 -0
- package/dist/types/managers/folder_metadata.d.ts +16 -0
- package/dist/types/managers/folder_watermarks.d.ts +10 -0
- package/dist/types/managers/folders.d.ts +54 -0
- package/dist/types/managers/groups.d.ts +33 -0
- package/dist/types/managers/hub_collaborations.d.ts +19 -0
- package/dist/types/managers/hub_document.d.ts +23 -0
- package/dist/types/managers/hub_items.d.ts +17 -0
- package/dist/types/managers/hubs.d.ts +35 -0
- package/dist/types/managers/index.d.ts +85 -0
- package/dist/types/managers/integration_mappings.d.ts +34 -0
- package/dist/types/managers/invites.d.ts +17 -0
- package/dist/types/managers/legal_hold_policies.d.ts +21 -0
- package/dist/types/managers/legal_hold_policy_assignments.d.ts +39 -0
- package/dist/types/managers/list_collaborations.d.ts +42 -0
- package/dist/types/managers/memberships.d.ts +39 -0
- package/dist/types/managers/metadata_cascade_policies.d.ts +20 -0
- package/dist/types/managers/metadata_taxonomies.d.ts +54 -0
- package/dist/types/managers/metadata_templates.d.ts +36 -0
- package/dist/types/managers/notes.d.ts +8 -0
- package/dist/types/managers/recent_items.d.ts +16 -0
- package/dist/types/managers/retention_policies.d.ts +27 -0
- package/dist/types/managers/retention_policy_assignments.d.ts +40 -0
- package/dist/types/managers/search.d.ts +33 -0
- package/dist/types/managers/session_termination.d.ts +9 -0
- package/dist/types/managers/shared_links_app_items.d.ts +8 -0
- package/dist/types/managers/shared_links_files.d.ts +17 -0
- package/dist/types/managers/shared_links_folders.d.ts +17 -0
- package/dist/types/managers/shared_links_web_links.d.ts +17 -0
- package/dist/types/managers/shield_information_barrier_reports.d.ts +17 -0
- package/dist/types/managers/shield_information_barrier_segment_members.d.ts +18 -0
- package/dist/types/managers/shield_information_barrier_segment_restrictions.d.ts +18 -0
- package/dist/types/managers/shield_information_barrier_segments.d.ts +19 -0
- package/dist/types/managers/shield_information_barriers.d.ts +18 -0
- package/dist/types/managers/shield_lists.d.ts +12 -0
- package/dist/types/managers/sign_requests.d.ts +21 -0
- package/dist/types/managers/sign_templates.d.ts +16 -0
- package/dist/types/managers/skills.d.ts +12 -0
- package/dist/types/managers/storage_policies.d.ts +17 -0
- package/dist/types/managers/storage_policy_assignments.d.ts +18 -0
- package/dist/types/managers/task_assignments.d.ts +12 -0
- package/dist/types/managers/tasks.d.ts +12 -0
- package/dist/types/managers/terms_of_service_user_statuses.d.ts +14 -0
- package/dist/types/managers/terms_of_services.d.ts +15 -0
- package/dist/types/managers/transfer.d.ts +13 -0
- package/dist/types/managers/trashed_files.d.ts +18 -0
- package/dist/types/managers/trashed_folders.d.ts +18 -0
- package/dist/types/managers/trashed_items.d.ts +20 -0
- package/dist/types/managers/trashed_web_links.d.ts +18 -0
- package/dist/types/managers/uploads.d.ts +21 -0
- package/dist/types/managers/user_collaborations.d.ts +20 -0
- package/dist/types/managers/users.d.ts +47 -0
- package/dist/types/managers/web_links.d.ts +15 -0
- package/dist/types/managers/webhooks.d.ts +19 -0
- package/dist/types/managers/workflows.d.ts +17 -0
- package/dist/types/managers/zip_downloads.d.ts +10 -0
- package/dist/types/models/index.d.ts +1 -0
- package/dist/types/models/schemas.d.ts +4424 -0
- package/dist/types/runtime.d.ts +85 -0
- package/dist/types/tokens.d.ts +50 -0
- package/docs/README.md +101 -0
- package/docs/auth.md +60 -0
- package/docs/errors.md +20 -0
- package/docs/managers/ai.md +49 -0
- package/docs/managers/ai_studio.md +63 -0
- package/docs/managers/app_item_associations.md +35 -0
- package/docs/managers/archives.md +48 -0
- package/docs/managers/authorization.md +43 -0
- package/docs/managers/automate_workflows.md +31 -0
- package/docs/managers/avatars.md +37 -0
- package/docs/managers/chunked_uploads.md +88 -0
- package/docs/managers/classifications.md +35 -0
- package/docs/managers/collaboration_allowlist_entries.md +46 -0
- package/docs/managers/collaboration_allowlist_exempt_targets.md +46 -0
- package/docs/managers/collections.md +44 -0
- package/docs/managers/comments.md +66 -0
- package/docs/managers/device_pinners.md +40 -0
- package/docs/managers/docgen.md +50 -0
- package/docs/managers/docgen_template.md +75 -0
- package/docs/managers/downloads.md +19 -0
- package/docs/managers/email_aliases.md +38 -0
- package/docs/managers/enterprise_configurations.md +16 -0
- package/docs/managers/events.md +26 -0
- package/docs/managers/external_users.md +13 -0
- package/docs/managers/file_classifications.md +49 -0
- package/docs/managers/file_metadata.md +69 -0
- package/docs/managers/file_requests.md +50 -0
- package/docs/managers/file_version_legal_holds.md +29 -0
- package/docs/managers/file_version_retentions.md +34 -0
- package/docs/managers/file_versions.md +70 -0
- package/docs/managers/file_watermarks.md +37 -0
- package/docs/managers/files.md +72 -0
- package/docs/managers/folder_classifications.md +49 -0
- package/docs/managers/folder_locks.md +33 -0
- package/docs/managers/folder_metadata.md +68 -0
- package/docs/managers/folder_watermarks.md +37 -0
- package/docs/managers/folders.md +93 -0
- package/docs/managers/groups.md +66 -0
- package/docs/managers/hub_collaborations.md +59 -0
- package/docs/managers/hub_document.md +34 -0
- package/docs/managers/hub_items.md +32 -0
- package/docs/managers/hubs.md +90 -0
- package/docs/managers/integration_mappings.md +96 -0
- package/docs/managers/invites.md +28 -0
- package/docs/managers/legal_hold_policies.md +60 -0
- package/docs/managers/legal_hold_policy_assignments.md +80 -0
- package/docs/managers/list_collaborations.md +64 -0
- package/docs/managers/memberships.md +79 -0
- package/docs/managers/metadata_cascade_policies.md +60 -0
- package/docs/managers/metadata_taxonomies.md +206 -0
- package/docs/managers/metadata_templates.md +98 -0
- package/docs/managers/notes.md +13 -0
- package/docs/managers/recent_items.md +19 -0
- package/docs/managers/retention_policies.md +63 -0
- package/docs/managers/retention_policy_assignments.md +78 -0
- package/docs/managers/search.md +43 -0
- package/docs/managers/session_termination.md +21 -0
- package/docs/managers/shared_links_app_items.md +15 -0
- package/docs/managers/shared_links_files.md +67 -0
- package/docs/managers/shared_links_folders.md +67 -0
- package/docs/managers/shared_links_web_links.md +67 -0
- package/docs/managers/shield_information_barrier_reports.md +37 -0
- package/docs/managers/shield_information_barrier_segment_members.md +47 -0
- package/docs/managers/shield_information_barrier_segment_restrictions.md +47 -0
- package/docs/managers/shield_information_barrier_segments.md +59 -0
- package/docs/managers/shield_information_barriers.md +44 -0
- package/docs/managers/shield_lists.md +51 -0
- package/docs/managers/sign_requests.md +60 -0
- package/docs/managers/sign_templates.md +28 -0
- package/docs/managers/skills.md +61 -0
- package/docs/managers/storage_policies.md +29 -0
- package/docs/managers/storage_policy_assignments.md +59 -0
- package/docs/managers/task_assignments.md +55 -0
- package/docs/managers/tasks.md +55 -0
- package/docs/managers/terms_of_service_user_statuses.md +36 -0
- package/docs/managers/terms_of_services.md +45 -0
- package/docs/managers/transfer.md +19 -0
- package/docs/managers/trashed_files.md +39 -0
- package/docs/managers/trashed_folders.md +39 -0
- package/docs/managers/trashed_items.md +23 -0
- package/docs/managers/trashed_web_links.md +39 -0
- package/docs/managers/uploads.md +41 -0
- package/docs/managers/user_collaborations.md +51 -0
- package/docs/managers/users.md +82 -0
- package/docs/managers/web_links.md +46 -0
- package/docs/managers/webhooks.md +58 -0
- package/docs/managers/workflows.md +32 -0
- package/docs/managers/zip_downloads.md +33 -0
- package/docs/pagination.md +17 -0
- package/package.json +32 -0
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import * as runtime from '../runtime.js';
|
|
2
|
+
import type * as models from '../models/index.js';
|
|
3
|
+
/** Optional parameters for CollectionsManager.list. */
|
|
4
|
+
export interface CollectionsManagerListOptions {
|
|
5
|
+
fields?: Array<string>;
|
|
6
|
+
offset?: number;
|
|
7
|
+
limit?: number;
|
|
8
|
+
}
|
|
9
|
+
/** Optional parameters for CollectionsManager.listItems. */
|
|
10
|
+
export interface CollectionsManagerListItemsOptions {
|
|
11
|
+
fields?: Array<string>;
|
|
12
|
+
offset?: number;
|
|
13
|
+
limit?: number;
|
|
14
|
+
}
|
|
15
|
+
/** Operations for the "collections" API area. */
|
|
16
|
+
export declare class CollectionsManager {
|
|
17
|
+
private readonly session;
|
|
18
|
+
constructor(session: runtime.Client);
|
|
19
|
+
/** Iterate every `models.schemas.Collection` across pages, threading the offset cursor. */
|
|
20
|
+
list(opts?: CollectionsManagerListOptions): AsyncIterableIterator<models.schemas.Collection>;
|
|
21
|
+
private listPage;
|
|
22
|
+
/** Iterate every `models.schemas.Item` across pages, threading the offset cursor. */
|
|
23
|
+
listItems(collectionId: string, opts?: CollectionsManagerListItemsOptions): AsyncIterableIterator<models.schemas.Item>;
|
|
24
|
+
private listItemsPage;
|
|
25
|
+
get(collectionId: string): Promise<models.schemas.Collection>;
|
|
26
|
+
}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import * as runtime from '../runtime.js';
|
|
2
|
+
import type * as models from '../models/index.js';
|
|
3
|
+
/** Optional parameters for CommentsManager.listFile. */
|
|
4
|
+
export interface CommentsManagerListFileOptions {
|
|
5
|
+
fields?: Array<string>;
|
|
6
|
+
limit?: number;
|
|
7
|
+
offset?: number;
|
|
8
|
+
}
|
|
9
|
+
/** Optional parameters for CommentsManager.get. */
|
|
10
|
+
export interface CommentsManagerGetOptions {
|
|
11
|
+
fields?: Array<string>;
|
|
12
|
+
}
|
|
13
|
+
/** Optional parameters for CommentsManager.update. */
|
|
14
|
+
export interface CommentsManagerUpdateOptions {
|
|
15
|
+
fields?: Array<string>;
|
|
16
|
+
}
|
|
17
|
+
/** Optional parameters for CommentsManager.create. */
|
|
18
|
+
export interface CommentsManagerCreateOptions {
|
|
19
|
+
fields?: Array<string>;
|
|
20
|
+
}
|
|
21
|
+
/** Operations for the "comments" API area. */
|
|
22
|
+
export declare class CommentsManager {
|
|
23
|
+
private readonly session;
|
|
24
|
+
constructor(session: runtime.Client);
|
|
25
|
+
/** Iterate every `models.schemas.CommentFull` across pages, threading the offset cursor. */
|
|
26
|
+
listFile(fileId: string, opts?: CommentsManagerListFileOptions): AsyncIterableIterator<models.schemas.CommentFull>;
|
|
27
|
+
private listFilePage;
|
|
28
|
+
get(commentId: string, opts?: CommentsManagerGetOptions): Promise<models.schemas.CommentFull>;
|
|
29
|
+
update(commentId: string, body: models.schemas.CommentUpdateRequest, opts?: CommentsManagerUpdateOptions): Promise<models.schemas.CommentFull>;
|
|
30
|
+
delete_(commentId: string): Promise<void>;
|
|
31
|
+
create(body: models.schemas.CommentCreateRequest, opts?: CommentsManagerCreateOptions): Promise<models.schemas.CommentFull>;
|
|
32
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import * as runtime from '../runtime.js';
|
|
2
|
+
import type * as models from '../models/index.js';
|
|
3
|
+
/** Optional parameters for DevicePinnersManager.listEnterprise. */
|
|
4
|
+
export interface DevicePinnersManagerListEnterpriseOptions {
|
|
5
|
+
marker?: string;
|
|
6
|
+
limit?: number;
|
|
7
|
+
direction?: models.schemas.OrderDirection;
|
|
8
|
+
}
|
|
9
|
+
/** Operations for the "device_pinners" API area. */
|
|
10
|
+
export declare class DevicePinnersManager {
|
|
11
|
+
private readonly session;
|
|
12
|
+
constructor(session: runtime.Client);
|
|
13
|
+
get(devicePinnerId: string): Promise<models.schemas.DevicePinner>;
|
|
14
|
+
delete_(devicePinnerId: string): Promise<void>;
|
|
15
|
+
/** Iterate every `models.schemas.DevicePinner` across pages, threading the marker cursor. */
|
|
16
|
+
listEnterprise(enterpriseId: string, opts?: DevicePinnersManagerListEnterpriseOptions): AsyncIterableIterator<models.schemas.DevicePinner>;
|
|
17
|
+
private listEnterprisePage;
|
|
18
|
+
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import * as runtime from '../runtime.js';
|
|
2
|
+
import type * as models from '../models/index.js';
|
|
3
|
+
/** Optional parameters for DocgenManager.listJobs. */
|
|
4
|
+
export interface DocgenManagerListJobsOptions {
|
|
5
|
+
marker?: string;
|
|
6
|
+
limit?: number;
|
|
7
|
+
}
|
|
8
|
+
/** Optional parameters for DocgenManager.listBatchJob. */
|
|
9
|
+
export interface DocgenManagerListBatchJobOptions {
|
|
10
|
+
marker?: string;
|
|
11
|
+
limit?: number;
|
|
12
|
+
}
|
|
13
|
+
/** Operations for the "docgen" API area. */
|
|
14
|
+
export declare class DocgenManager {
|
|
15
|
+
private readonly session;
|
|
16
|
+
constructor(session: runtime.Client);
|
|
17
|
+
getJob(jobId: string): Promise<models.schemas.DocGenJob>;
|
|
18
|
+
/** Iterate every `models.schemas.DocGenJobFull` across pages, threading the marker cursor. */
|
|
19
|
+
listJobs(opts?: DocgenManagerListJobsOptions): AsyncIterableIterator<models.schemas.DocGenJobFull>;
|
|
20
|
+
private listJobsPage;
|
|
21
|
+
/** Iterate every `models.schemas.DocGenJob` across pages, threading the marker cursor. */
|
|
22
|
+
listBatchJob(batchId: string, opts?: DocgenManagerListBatchJobOptions): AsyncIterableIterator<models.schemas.DocGenJob>;
|
|
23
|
+
private listBatchJobPage;
|
|
24
|
+
createBatches(body: models.schemas.DocGenBatchCreateRequest): Promise<models.schemas.DocGenBatchBase>;
|
|
25
|
+
}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import * as runtime from '../runtime.js';
|
|
2
|
+
import type * as models from '../models/index.js';
|
|
3
|
+
/** Optional parameters for DocgenTemplateManager.listDocgenTemplates. */
|
|
4
|
+
export interface DocgenTemplateManagerListDocgenTemplatesOptions {
|
|
5
|
+
marker?: string;
|
|
6
|
+
limit?: number;
|
|
7
|
+
}
|
|
8
|
+
/** Optional parameters for DocgenTemplateManager.listDocgenTemplateTags. */
|
|
9
|
+
export interface DocgenTemplateManagerListDocgenTemplateTagsOptions {
|
|
10
|
+
template_version_id?: string;
|
|
11
|
+
marker?: string;
|
|
12
|
+
limit?: number;
|
|
13
|
+
}
|
|
14
|
+
/** Optional parameters for DocgenTemplateManager.listJob. */
|
|
15
|
+
export interface DocgenTemplateManagerListJobOptions {
|
|
16
|
+
marker?: string;
|
|
17
|
+
limit?: number;
|
|
18
|
+
}
|
|
19
|
+
/** Operations for the "docgen_template" API area. */
|
|
20
|
+
export declare class DocgenTemplateManager {
|
|
21
|
+
private readonly session;
|
|
22
|
+
constructor(session: runtime.Client);
|
|
23
|
+
/** Iterate every `models.schemas.DocGenTemplate` across pages, threading the marker cursor. */
|
|
24
|
+
listDocgenTemplates(opts?: DocgenTemplateManagerListDocgenTemplatesOptions): AsyncIterableIterator<models.schemas.DocGenTemplate>;
|
|
25
|
+
private listDocgenTemplatesPage;
|
|
26
|
+
createDocgenTemplates(body: models.schemas.DocGenTemplateCreateRequest): Promise<models.schemas.DocGenTemplateBase>;
|
|
27
|
+
getDocgenTemplate(templateId: string): Promise<models.schemas.DocGenTemplate>;
|
|
28
|
+
deleteDocgenTemplate(templateId: string): Promise<void>;
|
|
29
|
+
/** Iterate every `models.schemas.DocGenTag` across pages, threading the marker cursor. */
|
|
30
|
+
listDocgenTemplateTags(templateId: string, opts?: DocgenTemplateManagerListDocgenTemplateTagsOptions): AsyncIterableIterator<models.schemas.DocGenTag>;
|
|
31
|
+
private listDocgenTemplateTagsPage;
|
|
32
|
+
/** Iterate every `models.schemas.DocGenJob` across pages, threading the marker cursor. */
|
|
33
|
+
listJob(templateId: string, opts?: DocgenTemplateManagerListJobOptions): AsyncIterableIterator<models.schemas.DocGenJob>;
|
|
34
|
+
private listJobPage;
|
|
35
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import * as runtime from '../runtime.js';
|
|
2
|
+
/** Optional parameters for DownloadsManager.getFileContent. */
|
|
3
|
+
export interface DownloadsManagerGetFileContentOptions {
|
|
4
|
+
range?: string;
|
|
5
|
+
boxapi?: string;
|
|
6
|
+
version?: string;
|
|
7
|
+
access_token?: string;
|
|
8
|
+
}
|
|
9
|
+
/** Operations for the "downloads" API area. */
|
|
10
|
+
export declare class DownloadsManager {
|
|
11
|
+
private readonly session;
|
|
12
|
+
constructor(session: runtime.Client);
|
|
13
|
+
getFileContent(fileId: string, opts?: DownloadsManagerGetFileContentOptions): Promise<runtime.Stream>;
|
|
14
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import * as runtime from '../runtime.js';
|
|
2
|
+
import type * as models from '../models/index.js';
|
|
3
|
+
/** Operations for the "email_aliases" API area. */
|
|
4
|
+
export declare class EmailAliasesManager {
|
|
5
|
+
private readonly session;
|
|
6
|
+
constructor(session: runtime.Client);
|
|
7
|
+
listUser(userId: string): Promise<models.schemas.EmailAliases>;
|
|
8
|
+
createUser(userId: string, body: models.schemas.UserIdCreateRequest): Promise<models.schemas.EmailAlias>;
|
|
9
|
+
deleteUser(userId: string, emailAliasId: string): Promise<void>;
|
|
10
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import * as runtime from '../runtime.js';
|
|
2
|
+
import type * as models from '../models/index.js';
|
|
3
|
+
/** Operations for the "enterprise_configurations" API area. */
|
|
4
|
+
export declare class EnterpriseConfigurationsManager {
|
|
5
|
+
private readonly session;
|
|
6
|
+
constructor(session: runtime.Client);
|
|
7
|
+
get(enterpriseId: string, categories: Array<string>): Promise<models.schemas.EnterpriseConfiguration>;
|
|
8
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import * as runtime from '../runtime.js';
|
|
2
|
+
import type * as models from '../models/index.js';
|
|
3
|
+
/** Optional parameters for EventsManager.list. */
|
|
4
|
+
export interface EventsManagerListOptions {
|
|
5
|
+
stream_type?: models.schemas.GetStreamType;
|
|
6
|
+
stream_position?: string;
|
|
7
|
+
limit?: number;
|
|
8
|
+
event_type?: Array<models.schemas.GetEventType>;
|
|
9
|
+
created_after?: string;
|
|
10
|
+
created_before?: string;
|
|
11
|
+
}
|
|
12
|
+
/** Operations for the "events" API area. */
|
|
13
|
+
export declare class EventsManager {
|
|
14
|
+
private readonly session;
|
|
15
|
+
constructor(session: runtime.Client);
|
|
16
|
+
list(opts?: EventsManagerListOptions): Promise<models.schemas.Events>;
|
|
17
|
+
options(): Promise<models.schemas.RealtimeServers>;
|
|
18
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import * as runtime from '../runtime.js';
|
|
2
|
+
import type * as models from '../models/index.js';
|
|
3
|
+
/** Operations for the "external_users" API area. */
|
|
4
|
+
export declare class ExternalUsersManager {
|
|
5
|
+
private readonly session;
|
|
6
|
+
constructor(session: runtime.Client);
|
|
7
|
+
createSubmitDeleteJob(body: models.schemas.ExternalUsersSubmitDeleteJobRequest): Promise<models.schemas.ExternalUsersSubmitDeleteJobResponse>;
|
|
8
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import * as runtime from '../runtime.js';
|
|
2
|
+
import type * as models from '../models/index.js';
|
|
3
|
+
/** Operations for the "file_classifications" API area. */
|
|
4
|
+
export declare class FileClassificationsManager {
|
|
5
|
+
private readonly session;
|
|
6
|
+
constructor(session: runtime.Client);
|
|
7
|
+
get(fileId: string): Promise<models.schemas.Classification>;
|
|
8
|
+
update(fileId: string, body: Array<models.schemas.FileClassificationUpdateRequest>): Promise<models.schemas.Classification>;
|
|
9
|
+
create(fileId: string, body: models.schemas.FileClassificationCreateRequest): Promise<models.schemas.Classification>;
|
|
10
|
+
delete_(fileId: string): Promise<void>;
|
|
11
|
+
}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import * as runtime from '../runtime.js';
|
|
2
|
+
import type * as models from '../models/index.js';
|
|
3
|
+
/** Optional parameters for FileMetadataManager.listFileMetadata. */
|
|
4
|
+
export interface FileMetadataManagerListFileMetadataOptions {
|
|
5
|
+
view?: string;
|
|
6
|
+
}
|
|
7
|
+
/** Optional parameters for FileMetadataManager.getFileMetadata. */
|
|
8
|
+
export interface FileMetadataManagerGetFileMetadataOptions {
|
|
9
|
+
view?: string;
|
|
10
|
+
}
|
|
11
|
+
/** Operations for the "file_metadata" API area. */
|
|
12
|
+
export declare class FileMetadataManager {
|
|
13
|
+
private readonly session;
|
|
14
|
+
constructor(session: runtime.Client);
|
|
15
|
+
listFileMetadata(fileId: string, opts?: FileMetadataManagerListFileMetadataOptions): Promise<models.schemas.Metadatas>;
|
|
16
|
+
getFileMetadata(fileId: string, scope: models.schemas.GetFileIdMetadataIdIdScope, templateKey: string, opts?: FileMetadataManagerGetFileMetadataOptions): Promise<models.schemas.MetadataFull>;
|
|
17
|
+
updateFileMetadata(fileId: string, scope: models.schemas.GetFileIdMetadataIdIdScope, templateKey: string, body: Array<models.schemas.FileMetadataUpdateRequest>): Promise<models.schemas.MetadataFull>;
|
|
18
|
+
createFileMetadata(fileId: string, scope: models.schemas.GetFileIdMetadataIdIdScope, templateKey: string, body: Record<string, unknown>): Promise<models.schemas.MetadataFull>;
|
|
19
|
+
deleteFileMetadata(fileId: string, scope: models.schemas.GetFileIdMetadataIdIdScope, templateKey: string): Promise<void>;
|
|
20
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import * as runtime from '../runtime.js';
|
|
2
|
+
import type * as models from '../models/index.js';
|
|
3
|
+
/** Optional parameters for FileRequestsManager.update. */
|
|
4
|
+
export interface FileRequestsManagerUpdateOptions {
|
|
5
|
+
"if-match"?: string;
|
|
6
|
+
}
|
|
7
|
+
/** Operations for the "file_requests" API area. */
|
|
8
|
+
export declare class FileRequestsManager {
|
|
9
|
+
private readonly session;
|
|
10
|
+
constructor(session: runtime.Client);
|
|
11
|
+
get(fileRequestId: string): Promise<models.schemas.FileRequest>;
|
|
12
|
+
update(fileRequestId: string, body: models.schemas.FileRequestUpdateRequest, opts?: FileRequestsManagerUpdateOptions): Promise<models.schemas.FileRequest>;
|
|
13
|
+
delete_(fileRequestId: string): Promise<void>;
|
|
14
|
+
copy(fileRequestId: string, body: models.schemas.FileRequestCopyRequest): Promise<models.schemas.FileRequest>;
|
|
15
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import * as runtime from '../runtime.js';
|
|
2
|
+
import type * as models from '../models/index.js';
|
|
3
|
+
/** Optional parameters for FileVersionLegalHoldsManager.list. */
|
|
4
|
+
export interface FileVersionLegalHoldsManagerListOptions {
|
|
5
|
+
marker?: string;
|
|
6
|
+
limit?: number;
|
|
7
|
+
}
|
|
8
|
+
/** Operations for the "file_version_legal_holds" API area. */
|
|
9
|
+
export declare class FileVersionLegalHoldsManager {
|
|
10
|
+
private readonly session;
|
|
11
|
+
constructor(session: runtime.Client);
|
|
12
|
+
get(fileVersionLegalHoldId: string): Promise<models.schemas.FileVersionLegalHold>;
|
|
13
|
+
/** Iterate every `models.schemas.FileVersionLegalHold` across pages, threading the marker cursor. */
|
|
14
|
+
list(policyId: string, opts?: FileVersionLegalHoldsManagerListOptions): AsyncIterableIterator<models.schemas.FileVersionLegalHold>;
|
|
15
|
+
private listPage;
|
|
16
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import * as runtime from '../runtime.js';
|
|
2
|
+
import type * as models from '../models/index.js';
|
|
3
|
+
/** Optional parameters for FileVersionRetentionsManager.list. */
|
|
4
|
+
export interface FileVersionRetentionsManagerListOptions {
|
|
5
|
+
file_id?: string;
|
|
6
|
+
file_version_id?: string;
|
|
7
|
+
policy_id?: string;
|
|
8
|
+
disposition_action?: models.schemas.RetentionPolicyDispositionAction;
|
|
9
|
+
disposition_before?: string;
|
|
10
|
+
disposition_after?: string;
|
|
11
|
+
limit?: number;
|
|
12
|
+
marker?: string;
|
|
13
|
+
}
|
|
14
|
+
/** Operations for the "file_version_retentions" API area. */
|
|
15
|
+
export declare class FileVersionRetentionsManager {
|
|
16
|
+
private readonly session;
|
|
17
|
+
constructor(session: runtime.Client);
|
|
18
|
+
/** Iterate every `models.schemas.FileVersionRetention` across pages, threading the marker cursor. */
|
|
19
|
+
list(opts?: FileVersionRetentionsManagerListOptions): AsyncIterableIterator<models.schemas.FileVersionRetention>;
|
|
20
|
+
private listPage;
|
|
21
|
+
get(fileVersionRetentionId: string): Promise<models.schemas.FileVersionRetention>;
|
|
22
|
+
}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import * as runtime from '../runtime.js';
|
|
2
|
+
import type * as models from '../models/index.js';
|
|
3
|
+
/** Optional parameters for FileVersionsManager.listFileVersions. */
|
|
4
|
+
export interface FileVersionsManagerListFileVersionsOptions {
|
|
5
|
+
fields?: Array<string>;
|
|
6
|
+
limit?: number;
|
|
7
|
+
offset?: number;
|
|
8
|
+
}
|
|
9
|
+
/** Optional parameters for FileVersionsManager.getFileVersion. */
|
|
10
|
+
export interface FileVersionsManagerGetFileVersionOptions {
|
|
11
|
+
fields?: Array<string>;
|
|
12
|
+
}
|
|
13
|
+
/** Optional parameters for FileVersionsManager.deleteFileVersion. */
|
|
14
|
+
export interface FileVersionsManagerDeleteFileVersionOptions {
|
|
15
|
+
"if-match"?: string;
|
|
16
|
+
}
|
|
17
|
+
/** Optional parameters for FileVersionsManager.createFileVersionCurrent. */
|
|
18
|
+
export interface FileVersionsManagerCreateFileVersionCurrentOptions {
|
|
19
|
+
fields?: Array<string>;
|
|
20
|
+
}
|
|
21
|
+
/** Operations for the "file_versions" API area. */
|
|
22
|
+
export declare class FileVersionsManager {
|
|
23
|
+
private readonly session;
|
|
24
|
+
constructor(session: runtime.Client);
|
|
25
|
+
/** Iterate every `models.schemas.FileVersionFull` across pages, threading the offset cursor. */
|
|
26
|
+
listFileVersions(fileId: string, opts?: FileVersionsManagerListFileVersionsOptions): AsyncIterableIterator<models.schemas.FileVersionFull>;
|
|
27
|
+
private listFileVersionsPage;
|
|
28
|
+
getFileVersion(fileId: string, fileVersionId: string, opts?: FileVersionsManagerGetFileVersionOptions): Promise<models.schemas.FileVersionFull>;
|
|
29
|
+
updateFileVersion(fileId: string, fileVersionId: string, body: models.schemas.FileVersionUpdateRequest): Promise<models.schemas.FileVersionFull>;
|
|
30
|
+
deleteFileVersion(fileId: string, fileVersionId: string, opts?: FileVersionsManagerDeleteFileVersionOptions): Promise<void>;
|
|
31
|
+
createFileVersionCurrent(fileId: string, body: models.schemas.FileVersionCurrentCreateRequest, opts?: FileVersionsManagerCreateFileVersionCurrentOptions): Promise<models.schemas.FileVersionFull>;
|
|
32
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import * as runtime from '../runtime.js';
|
|
2
|
+
import type * as models from '../models/index.js';
|
|
3
|
+
/** Operations for the "file_watermarks" API area. */
|
|
4
|
+
export declare class FileWatermarksManager {
|
|
5
|
+
private readonly session;
|
|
6
|
+
constructor(session: runtime.Client);
|
|
7
|
+
getFileWatermark(fileId: string): Promise<models.schemas.Watermark>;
|
|
8
|
+
updateFileWatermark(fileId: string, body: models.schemas.FileWatermarkUpdateRequest): Promise<models.schemas.Watermark>;
|
|
9
|
+
deleteFileWatermark(fileId: string): Promise<void>;
|
|
10
|
+
}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import * as runtime from '../runtime.js';
|
|
2
|
+
import type * as models from '../models/index.js';
|
|
3
|
+
/** Optional parameters for FilesManager.get. */
|
|
4
|
+
export interface FilesManagerGetOptions {
|
|
5
|
+
fields?: Array<string>;
|
|
6
|
+
"if-none-match"?: string;
|
|
7
|
+
boxapi?: string;
|
|
8
|
+
"x-rep-hints"?: string;
|
|
9
|
+
}
|
|
10
|
+
/** Optional parameters for FilesManager.update. */
|
|
11
|
+
export interface FilesManagerUpdateOptions {
|
|
12
|
+
fields?: Array<string>;
|
|
13
|
+
"if-match"?: string;
|
|
14
|
+
}
|
|
15
|
+
/** Optional parameters for FilesManager.delete_. */
|
|
16
|
+
export interface FilesManagerDeleteOptions {
|
|
17
|
+
"if-match"?: string;
|
|
18
|
+
}
|
|
19
|
+
/** Optional parameters for FilesManager.copy. */
|
|
20
|
+
export interface FilesManagerCopyOptions {
|
|
21
|
+
fields?: Array<string>;
|
|
22
|
+
}
|
|
23
|
+
/** Optional parameters for FilesManager.getThumbnail. */
|
|
24
|
+
export interface FilesManagerGetThumbnailOptions {
|
|
25
|
+
min_height?: number;
|
|
26
|
+
min_width?: number;
|
|
27
|
+
max_height?: number;
|
|
28
|
+
max_width?: number;
|
|
29
|
+
}
|
|
30
|
+
/** Operations for the "files" API area. */
|
|
31
|
+
export declare class FilesManager {
|
|
32
|
+
private readonly session;
|
|
33
|
+
constructor(session: runtime.Client);
|
|
34
|
+
get(fileId: string, opts?: FilesManagerGetOptions): Promise<models.schemas.FileFull>;
|
|
35
|
+
update(fileId: string, body: models.schemas.FileUpdateRequest, opts?: FilesManagerUpdateOptions): Promise<models.schemas.FileFull>;
|
|
36
|
+
delete_(fileId: string, opts?: FilesManagerDeleteOptions): Promise<void>;
|
|
37
|
+
copy(fileId: string, body: models.schemas.FileCopyRequest, opts?: FilesManagerCopyOptions): Promise<models.schemas.FileFull>;
|
|
38
|
+
getThumbnail(fileId: string, extension: models.schemas.GetIdThumbnailIdExtension, opts?: FilesManagerGetThumbnailOptions): Promise<runtime.Stream>;
|
|
39
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import * as runtime from '../runtime.js';
|
|
2
|
+
import type * as models from '../models/index.js';
|
|
3
|
+
/** Operations for the "folder_classifications" API area. */
|
|
4
|
+
export declare class FolderClassificationsManager {
|
|
5
|
+
private readonly session;
|
|
6
|
+
constructor(session: runtime.Client);
|
|
7
|
+
get(folderId: string): Promise<models.schemas.Classification>;
|
|
8
|
+
update(folderId: string, body: Array<models.schemas.FileClassificationUpdateRequest>): Promise<models.schemas.Classification>;
|
|
9
|
+
create(folderId: string, body: models.schemas.FileClassificationCreateRequest): Promise<models.schemas.Classification>;
|
|
10
|
+
delete_(folderId: string): Promise<void>;
|
|
11
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import * as runtime from '../runtime.js';
|
|
2
|
+
import type * as models from '../models/index.js';
|
|
3
|
+
/** Operations for the "folder_locks" API area. */
|
|
4
|
+
export declare class FolderLocksManager {
|
|
5
|
+
private readonly session;
|
|
6
|
+
constructor(session: runtime.Client);
|
|
7
|
+
list(folderId: string): Promise<models.schemas.FolderLocks>;
|
|
8
|
+
create(body: models.schemas.FolderLockCreateRequest): Promise<models.schemas.FolderLock>;
|
|
9
|
+
delete_(folderLockId: string): Promise<void>;
|
|
10
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import * as runtime from '../runtime.js';
|
|
2
|
+
import type * as models from '../models/index.js';
|
|
3
|
+
/** Optional parameters for FolderMetadataManager.listFolderMetadata. */
|
|
4
|
+
export interface FolderMetadataManagerListFolderMetadataOptions {
|
|
5
|
+
view?: string;
|
|
6
|
+
}
|
|
7
|
+
/** Operations for the "folder_metadata" API area. */
|
|
8
|
+
export declare class FolderMetadataManager {
|
|
9
|
+
private readonly session;
|
|
10
|
+
constructor(session: runtime.Client);
|
|
11
|
+
listFolderMetadata(folderId: string, opts?: FolderMetadataManagerListFolderMetadataOptions): Promise<models.schemas.Metadatas>;
|
|
12
|
+
getFolderMetadata(folderId: string, scope: models.schemas.GetFileIdMetadataIdIdScope, templateKey: string): Promise<models.schemas.MetadataFull>;
|
|
13
|
+
updateFolderMetadata(folderId: string, scope: models.schemas.GetFileIdMetadataIdIdScope, templateKey: string, body: Array<models.schemas.FileMetadataUpdateRequest>): Promise<models.schemas.MetadataFull>;
|
|
14
|
+
createFolderMetadata(folderId: string, scope: models.schemas.GetFileIdMetadataIdIdScope, templateKey: string, body: Record<string, unknown>): Promise<models.schemas.MetadataFull>;
|
|
15
|
+
deleteFolderMetadata(folderId: string, scope: models.schemas.GetFileIdMetadataIdIdScope, templateKey: string): Promise<void>;
|
|
16
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import * as runtime from '../runtime.js';
|
|
2
|
+
import type * as models from '../models/index.js';
|
|
3
|
+
/** Operations for the "folder_watermarks" API area. */
|
|
4
|
+
export declare class FolderWatermarksManager {
|
|
5
|
+
private readonly session;
|
|
6
|
+
constructor(session: runtime.Client);
|
|
7
|
+
getFolderWatermark(folderId: string): Promise<models.schemas.Watermark>;
|
|
8
|
+
updateFolderWatermark(folderId: string, body: models.schemas.FileWatermarkUpdateRequest): Promise<models.schemas.Watermark>;
|
|
9
|
+
deleteFolderWatermark(folderId: string): Promise<void>;
|
|
10
|
+
}
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
import * as runtime from '../runtime.js';
|
|
2
|
+
import type * as models from '../models/index.js';
|
|
3
|
+
/** Optional parameters for FoldersManager.get. */
|
|
4
|
+
export interface FoldersManagerGetOptions {
|
|
5
|
+
fields?: Array<string>;
|
|
6
|
+
"if-none-match"?: string;
|
|
7
|
+
boxapi?: string;
|
|
8
|
+
sort?: models.schemas.GetIdSort;
|
|
9
|
+
direction?: models.schemas.OrderDirection;
|
|
10
|
+
offset?: number;
|
|
11
|
+
limit?: number;
|
|
12
|
+
}
|
|
13
|
+
/** Optional parameters for FoldersManager.update. */
|
|
14
|
+
export interface FoldersManagerUpdateOptions {
|
|
15
|
+
fields?: Array<string>;
|
|
16
|
+
"if-match"?: string;
|
|
17
|
+
}
|
|
18
|
+
/** Optional parameters for FoldersManager.delete_. */
|
|
19
|
+
export interface FoldersManagerDeleteOptions {
|
|
20
|
+
"if-match"?: string;
|
|
21
|
+
recursive?: boolean;
|
|
22
|
+
}
|
|
23
|
+
/** Optional parameters for FoldersManager.listItems. */
|
|
24
|
+
export interface FoldersManagerListItemsOptions {
|
|
25
|
+
fields?: Array<string>;
|
|
26
|
+
usemarker?: boolean;
|
|
27
|
+
marker?: string;
|
|
28
|
+
offset?: number;
|
|
29
|
+
limit?: number;
|
|
30
|
+
boxapi?: string;
|
|
31
|
+
sort?: models.schemas.GetIdSort;
|
|
32
|
+
direction?: models.schemas.OrderDirection;
|
|
33
|
+
}
|
|
34
|
+
/** Optional parameters for FoldersManager.create. */
|
|
35
|
+
export interface FoldersManagerCreateOptions {
|
|
36
|
+
fields?: Array<string>;
|
|
37
|
+
}
|
|
38
|
+
/** Optional parameters for FoldersManager.copy. */
|
|
39
|
+
export interface FoldersManagerCopyOptions {
|
|
40
|
+
fields?: Array<string>;
|
|
41
|
+
}
|
|
42
|
+
/** Operations for the "folders" API area. */
|
|
43
|
+
export declare class FoldersManager {
|
|
44
|
+
private readonly session;
|
|
45
|
+
constructor(session: runtime.Client);
|
|
46
|
+
get(folderId: string, opts?: FoldersManagerGetOptions): Promise<models.schemas.FolderFull>;
|
|
47
|
+
update(folderId: string, body: models.schemas.FolderUpdateRequest, opts?: FoldersManagerUpdateOptions): Promise<models.schemas.FolderFull>;
|
|
48
|
+
delete_(folderId: string, opts?: FoldersManagerDeleteOptions): Promise<void>;
|
|
49
|
+
/** Iterate every `models.schemas.Item` across pages, threading the marker cursor. */
|
|
50
|
+
listItems(folderId: string, opts?: FoldersManagerListItemsOptions): AsyncIterableIterator<models.schemas.Item>;
|
|
51
|
+
private listItemsPage;
|
|
52
|
+
create(body: models.schemas.FolderCreateRequest, opts?: FoldersManagerCreateOptions): Promise<models.schemas.FolderFull>;
|
|
53
|
+
copy(folderId: string, body: models.schemas.FolderCopyRequest, opts?: FoldersManagerCopyOptions): Promise<models.schemas.FolderFull>;
|
|
54
|
+
}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import * as runtime from '../runtime.js';
|
|
2
|
+
import type * as models from '../models/index.js';
|
|
3
|
+
/** Optional parameters for GroupsManager.list. */
|
|
4
|
+
export interface GroupsManagerListOptions {
|
|
5
|
+
filter_term?: string;
|
|
6
|
+
fields?: Array<string>;
|
|
7
|
+
limit?: number;
|
|
8
|
+
offset?: number;
|
|
9
|
+
}
|
|
10
|
+
/** Optional parameters for GroupsManager.create. */
|
|
11
|
+
export interface GroupsManagerCreateOptions {
|
|
12
|
+
fields?: Array<string>;
|
|
13
|
+
}
|
|
14
|
+
/** Optional parameters for GroupsManager.get. */
|
|
15
|
+
export interface GroupsManagerGetOptions {
|
|
16
|
+
fields?: Array<string>;
|
|
17
|
+
}
|
|
18
|
+
/** Optional parameters for GroupsManager.update. */
|
|
19
|
+
export interface GroupsManagerUpdateOptions {
|
|
20
|
+
fields?: Array<string>;
|
|
21
|
+
}
|
|
22
|
+
/** Operations for the "groups" API area. */
|
|
23
|
+
export declare class GroupsManager {
|
|
24
|
+
private readonly session;
|
|
25
|
+
constructor(session: runtime.Client);
|
|
26
|
+
/** Iterate every `models.schemas.GroupFull` across pages, threading the offset cursor. */
|
|
27
|
+
list(opts?: GroupsManagerListOptions): AsyncIterableIterator<models.schemas.GroupFull>;
|
|
28
|
+
private listPage;
|
|
29
|
+
create(body: models.schemas.GroupCreateRequest, opts?: GroupsManagerCreateOptions): Promise<models.schemas.GroupFull>;
|
|
30
|
+
get(groupId: string, opts?: GroupsManagerGetOptions): Promise<models.schemas.GroupFull>;
|
|
31
|
+
update(groupId: string, body: models.schemas.GroupUpdateRequest, opts?: GroupsManagerUpdateOptions): Promise<models.schemas.GroupFull>;
|
|
32
|
+
delete_(groupId: string): Promise<void>;
|
|
33
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import * as runtime from '../runtime.js';
|
|
2
|
+
import type * as models from '../models/index.js';
|
|
3
|
+
/** Optional parameters for HubCollaborationsManager.list. */
|
|
4
|
+
export interface HubCollaborationsManagerListOptions {
|
|
5
|
+
marker?: string;
|
|
6
|
+
limit?: number;
|
|
7
|
+
}
|
|
8
|
+
/** Operations for the "hub_collaborations" API area. */
|
|
9
|
+
export declare class HubCollaborationsManager {
|
|
10
|
+
private readonly session;
|
|
11
|
+
constructor(session: runtime.Client);
|
|
12
|
+
/** Iterate every `models.schemas.HubCollaboration` across pages, threading the marker cursor. */
|
|
13
|
+
list(hubId: string, opts?: HubCollaborationsManagerListOptions): AsyncIterableIterator<models.schemas.HubCollaboration>;
|
|
14
|
+
private listPage;
|
|
15
|
+
create(body: models.schemas.HubCollaborationCreateRequest): Promise<models.schemas.HubCollaboration>;
|
|
16
|
+
get(hubCollaborationId: string): Promise<models.schemas.HubCollaboration>;
|
|
17
|
+
update(hubCollaborationId: string, body: models.schemas.HubCollaborationUpdateRequest): Promise<models.schemas.HubCollaboration>;
|
|
18
|
+
delete_(hubCollaborationId: string): Promise<void>;
|
|
19
|
+
}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import * as runtime from '../runtime.js';
|
|
2
|
+
import type * as models from '../models/index.js';
|
|
3
|
+
/** Optional parameters for HubDocumentManager.listPages. */
|
|
4
|
+
export interface HubDocumentManagerListPagesOptions {
|
|
5
|
+
marker?: string;
|
|
6
|
+
limit?: number;
|
|
7
|
+
}
|
|
8
|
+
/** Optional parameters for HubDocumentManager.listBlocks. */
|
|
9
|
+
export interface HubDocumentManagerListBlocksOptions {
|
|
10
|
+
marker?: string;
|
|
11
|
+
limit?: number;
|
|
12
|
+
}
|
|
13
|
+
/** Operations for the "hub_document" API area. */
|
|
14
|
+
export declare class HubDocumentManager {
|
|
15
|
+
private readonly session;
|
|
16
|
+
constructor(session: runtime.Client);
|
|
17
|
+
/** Iterate every `models.schemas.HubDocumentPage` across pages, threading the marker cursor. */
|
|
18
|
+
listPages(hubId: string, opts?: HubDocumentManagerListPagesOptions): AsyncIterableIterator<models.schemas.HubDocumentPage>;
|
|
19
|
+
private listPagesPage;
|
|
20
|
+
/** Iterate every `models.schemas.HubDocumentBlockEntry` across pages, threading the marker cursor. */
|
|
21
|
+
listBlocks(hubId: string, pageId: string, opts?: HubDocumentManagerListBlocksOptions): AsyncIterableIterator<models.schemas.HubDocumentBlockEntry>;
|
|
22
|
+
private listBlocksPage;
|
|
23
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import * as runtime from '../runtime.js';
|
|
2
|
+
import type * as models from '../models/index.js';
|
|
3
|
+
/** Optional parameters for HubItemsManager.list. */
|
|
4
|
+
export interface HubItemsManagerListOptions {
|
|
5
|
+
parent_id?: string;
|
|
6
|
+
marker?: string;
|
|
7
|
+
limit?: number;
|
|
8
|
+
}
|
|
9
|
+
/** Operations for the "hub_items" API area. */
|
|
10
|
+
export declare class HubItemsManager {
|
|
11
|
+
private readonly session;
|
|
12
|
+
constructor(session: runtime.Client);
|
|
13
|
+
/** Iterate every `models.schemas.HubItem` across pages, threading the marker cursor. */
|
|
14
|
+
list(hubId: string, opts?: HubItemsManagerListOptions): AsyncIterableIterator<models.schemas.HubItem>;
|
|
15
|
+
private listPage;
|
|
16
|
+
createHubManageItems(hubId: string, body: models.schemas.HubItemsManageRequest): Promise<models.schemas.HubItemsManageResponse>;
|
|
17
|
+
}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import * as runtime from '../runtime.js';
|
|
2
|
+
import type * as models from '../models/index.js';
|
|
3
|
+
/** Optional parameters for HubsManager.list. */
|
|
4
|
+
export interface HubsManagerListOptions {
|
|
5
|
+
query?: string;
|
|
6
|
+
scope?: string;
|
|
7
|
+
sort?: string;
|
|
8
|
+
direction?: models.schemas.GetDirection;
|
|
9
|
+
marker?: string;
|
|
10
|
+
limit?: number;
|
|
11
|
+
}
|
|
12
|
+
/** Optional parameters for HubsManager.listEnterprise. */
|
|
13
|
+
export interface HubsManagerListEnterpriseOptions {
|
|
14
|
+
query?: string;
|
|
15
|
+
sort?: string;
|
|
16
|
+
direction?: models.schemas.GetDirection;
|
|
17
|
+
marker?: string;
|
|
18
|
+
limit?: number;
|
|
19
|
+
}
|
|
20
|
+
/** Operations for the "hubs" API area. */
|
|
21
|
+
export declare class HubsManager {
|
|
22
|
+
private readonly session;
|
|
23
|
+
constructor(session: runtime.Client);
|
|
24
|
+
/** Iterate every `models.schemas.Hub` across pages, threading the marker cursor. */
|
|
25
|
+
list(opts?: HubsManagerListOptions): AsyncIterableIterator<models.schemas.Hub>;
|
|
26
|
+
private listPage;
|
|
27
|
+
create(body: models.schemas.HubCreateRequest): Promise<models.schemas.Hub>;
|
|
28
|
+
/** Iterate every `models.schemas.Hub` across pages, threading the marker cursor. */
|
|
29
|
+
listEnterprise(opts?: HubsManagerListEnterpriseOptions): AsyncIterableIterator<models.schemas.Hub>;
|
|
30
|
+
private listEnterprisePage;
|
|
31
|
+
get(hubId: string): Promise<models.schemas.Hub>;
|
|
32
|
+
update(hubId: string, body: models.schemas.HubUpdateRequest): Promise<models.schemas.Hub>;
|
|
33
|
+
delete_(hubId: string): Promise<void>;
|
|
34
|
+
copy(hubId: string, body: models.schemas.HubCopyRequest): Promise<models.schemas.Hub>;
|
|
35
|
+
}
|