@unofficialbox/box-open-sdk 0.3.1 → 0.4.1
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 +2 -0
- package/dist/cjs/auth.js +3 -3
- package/dist/cjs/buildinfo.js +2 -2
- package/dist/cjs/client.js +3 -0
- package/dist/cjs/jwt.js +1 -1
- package/dist/cjs/managers/collaboration_allowlist_entries.js +6 -6
- package/dist/cjs/managers/collaboration_allowlist_exempt_targets.js +6 -6
- package/dist/cjs/managers/index.js +1 -0
- package/dist/cjs/managers/memberships.js +4 -4
- package/dist/cjs/managers/query.js +68 -0
- package/dist/cjs/models/schemas/ai.js +3 -0
- package/dist/cjs/models/schemas/ai_studio.js +3 -0
- package/dist/cjs/models/schemas/app_item_associations.js +3 -0
- package/dist/cjs/models/schemas/archives.js +3 -0
- package/dist/cjs/models/schemas/authorization.js +3 -0
- package/dist/cjs/models/schemas/automate_workflows.js +3 -0
- package/dist/cjs/models/schemas/avatars.js +3 -0
- package/dist/cjs/models/schemas/chunked_uploads.js +3 -0
- package/dist/cjs/models/schemas/classifications.js +3 -0
- package/dist/cjs/models/schemas/collaboration_allowlist_entries.js +3 -0
- package/dist/cjs/models/schemas/collaboration_allowlist_exempt_targets.js +3 -0
- package/dist/cjs/models/schemas/collections.js +3 -0
- package/dist/cjs/models/schemas/comments.js +3 -0
- package/dist/cjs/models/schemas/device_pinners.js +3 -0
- package/dist/cjs/models/schemas/docgen.js +3 -0
- package/dist/cjs/models/schemas/docgen_template.js +3 -0
- package/dist/cjs/models/schemas/email_aliases.js +3 -0
- package/dist/cjs/models/schemas/enterprise_configurations.js +3 -0
- package/dist/cjs/models/schemas/events.js +3 -0
- package/dist/cjs/models/schemas/external_users.js +3 -0
- package/dist/cjs/models/schemas/file_requests.js +3 -0
- package/dist/cjs/models/schemas/file_version_legal_holds.js +3 -0
- package/dist/cjs/models/schemas/file_version_retentions.js +3 -0
- package/dist/cjs/models/schemas/file_versions.js +3 -0
- package/dist/cjs/models/schemas/files.js +3 -0
- package/dist/cjs/models/schemas/folder_locks.js +3 -0
- package/dist/cjs/models/schemas/folders.js +3 -0
- package/dist/cjs/models/schemas/groups.js +3 -0
- package/dist/cjs/models/schemas/hub_collaborations.js +3 -0
- package/dist/cjs/models/schemas/hub_document.js +3 -0
- package/dist/cjs/models/schemas/hub_items.js +3 -0
- package/dist/cjs/models/schemas/hubs.js +3 -0
- package/dist/cjs/models/schemas/integration_mappings.js +3 -0
- package/dist/cjs/models/schemas/invites.js +3 -0
- package/dist/cjs/models/schemas/legal_hold_policies.js +3 -0
- package/dist/cjs/models/schemas/legal_hold_policy_assignments.js +3 -0
- package/dist/cjs/models/schemas/list_collaborations.js +3 -0
- package/dist/cjs/models/schemas/memberships.js +3 -0
- package/dist/cjs/models/schemas/metadata_cascade_policies.js +3 -0
- package/dist/cjs/models/schemas/metadata_taxonomies.js +3 -0
- package/dist/cjs/models/schemas/metadata_templates.js +3 -0
- package/dist/cjs/models/schemas/notes.js +3 -0
- package/dist/cjs/models/schemas/query.js +3 -0
- package/dist/cjs/models/schemas/recent_items.js +3 -0
- package/dist/cjs/models/schemas/retention_policies.js +3 -0
- package/dist/cjs/models/schemas/retention_policy_assignments.js +3 -0
- package/dist/cjs/models/schemas/search.js +3 -0
- package/dist/cjs/models/schemas/session_termination.js +3 -0
- package/dist/cjs/models/schemas/shared_links_folders.js +3 -0
- package/dist/cjs/models/schemas/shield_information_barrier_reports.js +3 -0
- package/dist/cjs/models/schemas/shield_information_barrier_segment_members.js +3 -0
- package/dist/cjs/models/schemas/shield_information_barrier_segment_restrictions.js +3 -0
- package/dist/cjs/models/schemas/shield_information_barrier_segments.js +3 -0
- package/dist/cjs/models/schemas/shield_information_barriers.js +3 -0
- package/dist/cjs/models/schemas/shield_lists.js +3 -0
- package/dist/cjs/models/schemas/sign_requests.js +3 -0
- package/dist/cjs/models/schemas/sign_templates.js +3 -0
- package/dist/cjs/models/schemas/skills.js +3 -0
- package/dist/cjs/models/schemas/storage_policies.js +3 -0
- package/dist/cjs/models/schemas/storage_policy_assignments.js +3 -0
- package/dist/cjs/models/schemas/task_assignments.js +3 -0
- package/dist/cjs/models/schemas/tasks.js +3 -0
- package/dist/cjs/models/schemas/terms_of_service_user_statuses.js +3 -0
- package/dist/cjs/models/schemas/terms_of_services.js +3 -0
- package/dist/cjs/models/schemas/transfer.js +3 -0
- package/dist/cjs/models/schemas/trashed_files.js +3 -0
- package/dist/cjs/models/schemas/trashed_folders.js +3 -0
- package/dist/cjs/models/schemas/trashed_items.js +3 -0
- package/dist/cjs/models/schemas/trashed_web_links.js +3 -0
- package/dist/cjs/models/schemas/uploads.js +3 -0
- package/dist/cjs/models/schemas/user_collaborations.js +3 -0
- package/dist/cjs/models/schemas/users.js +3 -0
- package/dist/cjs/models/schemas/web_links.js +3 -0
- package/dist/cjs/models/schemas/webhooks.js +3 -0
- package/dist/cjs/models/schemas/workflows.js +3 -0
- package/dist/cjs/models/schemas/zip_downloads.js +3 -0
- package/dist/cjs/models/schemas.js +91 -1
- package/dist/cjs/runtime.js +8 -3
- package/dist/cjs/tokens.js +5 -3
- package/dist/esm/auth.js +3 -3
- package/dist/esm/buildinfo.js +2 -2
- package/dist/esm/client.js +3 -0
- package/dist/esm/jwt.js +1 -1
- package/dist/esm/managers/collaboration_allowlist_entries.js +6 -6
- package/dist/esm/managers/collaboration_allowlist_exempt_targets.js +6 -6
- package/dist/esm/managers/index.js +1 -0
- package/dist/esm/managers/memberships.js +4 -4
- package/dist/esm/managers/query.js +31 -0
- package/dist/esm/models/schemas/ai.js +2 -0
- package/dist/esm/models/schemas/ai_studio.js +2 -0
- package/dist/esm/models/schemas/app_item_associations.js +2 -0
- package/dist/esm/models/schemas/archives.js +2 -0
- package/dist/esm/models/schemas/authorization.js +2 -0
- package/dist/esm/models/schemas/automate_workflows.js +2 -0
- package/dist/esm/models/schemas/avatars.js +2 -0
- package/dist/esm/models/schemas/chunked_uploads.js +2 -0
- package/dist/esm/models/schemas/classifications.js +2 -0
- package/dist/esm/models/schemas/collaboration_allowlist_entries.js +2 -0
- package/dist/esm/models/schemas/collaboration_allowlist_exempt_targets.js +2 -0
- package/dist/esm/models/schemas/collections.js +2 -0
- package/dist/esm/models/schemas/comments.js +2 -0
- package/dist/esm/models/schemas/device_pinners.js +2 -0
- package/dist/esm/models/schemas/docgen.js +2 -0
- package/dist/esm/models/schemas/docgen_template.js +2 -0
- package/dist/esm/models/schemas/email_aliases.js +2 -0
- package/dist/esm/models/schemas/enterprise_configurations.js +2 -0
- package/dist/esm/models/schemas/events.js +2 -0
- package/dist/esm/models/schemas/external_users.js +2 -0
- package/dist/esm/models/schemas/file_requests.js +2 -0
- package/dist/esm/models/schemas/file_version_legal_holds.js +2 -0
- package/dist/esm/models/schemas/file_version_retentions.js +2 -0
- package/dist/esm/models/schemas/file_versions.js +2 -0
- package/dist/esm/models/schemas/files.js +2 -0
- package/dist/esm/models/schemas/folder_locks.js +2 -0
- package/dist/esm/models/schemas/folders.js +2 -0
- package/dist/esm/models/schemas/groups.js +2 -0
- package/dist/esm/models/schemas/hub_collaborations.js +2 -0
- package/dist/esm/models/schemas/hub_document.js +2 -0
- package/dist/esm/models/schemas/hub_items.js +2 -0
- package/dist/esm/models/schemas/hubs.js +2 -0
- package/dist/esm/models/schemas/integration_mappings.js +2 -0
- package/dist/esm/models/schemas/invites.js +2 -0
- package/dist/esm/models/schemas/legal_hold_policies.js +2 -0
- package/dist/esm/models/schemas/legal_hold_policy_assignments.js +2 -0
- package/dist/esm/models/schemas/list_collaborations.js +2 -0
- package/dist/esm/models/schemas/memberships.js +2 -0
- package/dist/esm/models/schemas/metadata_cascade_policies.js +2 -0
- package/dist/esm/models/schemas/metadata_taxonomies.js +2 -0
- package/dist/esm/models/schemas/metadata_templates.js +2 -0
- package/dist/esm/models/schemas/notes.js +2 -0
- package/dist/esm/models/schemas/query.js +2 -0
- package/dist/esm/models/schemas/recent_items.js +2 -0
- package/dist/esm/models/schemas/retention_policies.js +2 -0
- package/dist/esm/models/schemas/retention_policy_assignments.js +2 -0
- package/dist/esm/models/schemas/search.js +2 -0
- package/dist/esm/models/schemas/session_termination.js +2 -0
- package/dist/esm/models/schemas/shared_links_folders.js +2 -0
- package/dist/esm/models/schemas/shield_information_barrier_reports.js +2 -0
- package/dist/esm/models/schemas/shield_information_barrier_segment_members.js +2 -0
- package/dist/esm/models/schemas/shield_information_barrier_segment_restrictions.js +2 -0
- package/dist/esm/models/schemas/shield_information_barrier_segments.js +2 -0
- package/dist/esm/models/schemas/shield_information_barriers.js +2 -0
- package/dist/esm/models/schemas/shield_lists.js +2 -0
- package/dist/esm/models/schemas/sign_requests.js +2 -0
- package/dist/esm/models/schemas/sign_templates.js +2 -0
- package/dist/esm/models/schemas/skills.js +2 -0
- package/dist/esm/models/schemas/storage_policies.js +2 -0
- package/dist/esm/models/schemas/storage_policy_assignments.js +2 -0
- package/dist/esm/models/schemas/task_assignments.js +2 -0
- package/dist/esm/models/schemas/tasks.js +2 -0
- package/dist/esm/models/schemas/terms_of_service_user_statuses.js +2 -0
- package/dist/esm/models/schemas/terms_of_services.js +2 -0
- package/dist/esm/models/schemas/transfer.js +2 -0
- package/dist/esm/models/schemas/trashed_files.js +2 -0
- package/dist/esm/models/schemas/trashed_folders.js +2 -0
- package/dist/esm/models/schemas/trashed_items.js +2 -0
- package/dist/esm/models/schemas/trashed_web_links.js +2 -0
- package/dist/esm/models/schemas/uploads.js +2 -0
- package/dist/esm/models/schemas/user_collaborations.js +2 -0
- package/dist/esm/models/schemas/users.js +2 -0
- package/dist/esm/models/schemas/web_links.js +2 -0
- package/dist/esm/models/schemas/webhooks.js +2 -0
- package/dist/esm/models/schemas/workflows.js +2 -0
- package/dist/esm/models/schemas/zip_downloads.js +2 -0
- package/dist/esm/models/schemas.js +77 -2
- package/dist/esm/runtime.js +8 -3
- package/dist/esm/tokens.js +5 -3
- package/dist/types/auth.d.ts +8 -0
- package/dist/types/buildinfo.d.ts +1 -1
- package/dist/types/client.d.ts +2 -0
- package/dist/types/jwt.d.ts +4 -0
- package/dist/types/managers/archives.d.ts +2 -2
- package/dist/types/managers/avatars.d.ts +1 -1
- package/dist/types/managers/chunked_uploads.d.ts +3 -3
- package/dist/types/managers/classifications.d.ts +3 -3
- package/dist/types/managers/collaboration_allowlist_entries.d.ts +7 -7
- package/dist/types/managers/collaboration_allowlist_exempt_targets.d.ts +7 -7
- package/dist/types/managers/comments.d.ts +2 -2
- package/dist/types/managers/email_aliases.d.ts +1 -1
- package/dist/types/managers/file_classifications.d.ts +2 -2
- package/dist/types/managers/file_metadata.d.ts +4 -4
- package/dist/types/managers/file_versions.d.ts +2 -2
- package/dist/types/managers/file_watermarks.d.ts +1 -1
- package/dist/types/managers/files.d.ts +2 -2
- package/dist/types/managers/folder_classifications.d.ts +2 -2
- package/dist/types/managers/folder_locks.d.ts +1 -1
- package/dist/types/managers/folder_metadata.d.ts +4 -4
- package/dist/types/managers/folder_watermarks.d.ts +1 -1
- package/dist/types/managers/folders.d.ts +3 -3
- package/dist/types/managers/groups.d.ts +2 -2
- package/dist/types/managers/index.d.ts +1 -0
- package/dist/types/managers/integration_mappings.d.ts +2 -2
- package/dist/types/managers/invites.d.ts +1 -1
- package/dist/types/managers/legal_hold_policies.d.ts +2 -2
- package/dist/types/managers/legal_hold_policy_assignments.d.ts +1 -1
- package/dist/types/managers/memberships.d.ts +10 -10
- package/dist/types/managers/metadata_cascade_policies.d.ts +2 -2
- package/dist/types/managers/metadata_taxonomies.d.ts +6 -6
- package/dist/types/managers/metadata_templates.d.ts +4 -4
- package/dist/types/managers/query.d.ts +9 -0
- package/dist/types/managers/retention_policies.d.ts +2 -2
- package/dist/types/managers/retention_policy_assignments.d.ts +1 -1
- package/dist/types/managers/session_termination.d.ts +2 -2
- package/dist/types/managers/shared_links_files.d.ts +3 -3
- package/dist/types/managers/shared_links_folders.d.ts +3 -3
- package/dist/types/managers/shared_links_web_links.d.ts +3 -3
- package/dist/types/managers/shield_information_barrier_segment_members.d.ts +1 -1
- package/dist/types/managers/shield_information_barrier_segment_restrictions.d.ts +1 -1
- package/dist/types/managers/shield_information_barrier_segments.d.ts +2 -2
- package/dist/types/managers/shield_information_barriers.d.ts +2 -2
- package/dist/types/managers/skills.d.ts +3 -3
- package/dist/types/managers/storage_policy_assignments.d.ts +2 -2
- package/dist/types/managers/task_assignments.d.ts +2 -2
- package/dist/types/managers/tasks.d.ts +2 -2
- package/dist/types/managers/terms_of_service_user_statuses.d.ts +2 -2
- package/dist/types/managers/terms_of_services.d.ts +2 -2
- package/dist/types/managers/transfer.d.ts +1 -1
- package/dist/types/managers/trashed_files.d.ts +1 -1
- package/dist/types/managers/trashed_folders.d.ts +1 -1
- package/dist/types/managers/trashed_web_links.d.ts +1 -1
- package/dist/types/managers/uploads.d.ts +2 -2
- package/dist/types/managers/user_collaborations.d.ts +2 -2
- package/dist/types/managers/users.d.ts +2 -2
- package/dist/types/managers/web_links.d.ts +2 -2
- package/dist/types/managers/webhooks.d.ts +2 -2
- package/dist/types/managers/workflows.d.ts +1 -1
- package/dist/types/models/schemas/ai.d.ts +240 -0
- package/dist/types/models/schemas/ai_studio.d.ts +172 -0
- package/dist/types/models/schemas/app_item_associations.d.ts +34 -0
- package/dist/types/models/schemas/archives.d.ts +27 -0
- package/dist/types/models/schemas/authorization.d.ts +43 -0
- package/dist/types/models/schemas/automate_workflows.d.ts +29 -0
- package/dist/types/models/schemas/avatars.d.ts +11 -0
- package/dist/types/models/schemas/chunked_uploads.d.ts +47 -0
- package/dist/types/models/schemas/classifications.d.ts +66 -0
- package/dist/types/models/schemas/collaboration_allowlist_entries.d.ts +21 -0
- package/dist/types/models/schemas/collaboration_allowlist_exempt_targets.d.ts +19 -0
- package/dist/types/models/schemas/collections.d.ts +15 -0
- package/dist/types/models/schemas/comments.d.ts +33 -0
- package/dist/types/models/schemas/device_pinners.d.ts +20 -0
- package/dist/types/models/schemas/docgen.d.ts +40 -0
- package/dist/types/models/schemas/docgen_template.d.ts +29 -0
- package/dist/types/models/schemas/email_aliases.d.ts +14 -0
- package/dist/types/models/schemas/enterprise_configurations.d.ts +251 -0
- package/dist/types/models/schemas/events.d.ts +71 -0
- package/dist/types/models/schemas/external_users.d.ts +16 -0
- package/dist/types/models/schemas/file_requests.d.ts +41 -0
- package/dist/types/models/schemas/file_version_legal_holds.d.ts +16 -0
- package/dist/types/models/schemas/file_version_retentions.d.ts +17 -0
- package/dist/types/models/schemas/file_versions.d.ts +32 -0
- package/dist/types/models/schemas/files.d.ts +27 -0
- package/dist/types/models/schemas/folder_locks.d.ts +27 -0
- package/dist/types/models/schemas/folders.d.ts +28 -0
- package/dist/types/models/schemas/groups.d.ts +42 -0
- package/dist/types/models/schemas/hub_collaborations.d.ts +57 -0
- package/dist/types/models/schemas/hub_document.d.ts +67 -0
- package/dist/types/models/schemas/hub_items.d.ts +46 -0
- package/dist/types/models/schemas/hubs.d.ts +43 -0
- package/dist/types/models/schemas/integration_mappings.d.ts +83 -0
- package/dist/types/models/schemas/invites.d.ts +19 -0
- package/dist/types/models/schemas/legal_hold_policies.d.ts +43 -0
- package/dist/types/models/schemas/legal_hold_policy_assignments.d.ts +43 -0
- package/dist/types/models/schemas/list_collaborations.d.ts +14 -0
- package/dist/types/models/schemas/memberships.d.ts +29 -0
- package/dist/types/models/schemas/metadata_cascade_policies.d.ts +29 -0
- package/dist/types/models/schemas/metadata_taxonomies.d.ts +60 -0
- package/dist/types/models/schemas/metadata_templates.d.ts +71 -0
- package/dist/types/models/schemas/notes.d.ts +13 -0
- package/dist/types/models/schemas/query.d.ts +62 -0
- package/dist/types/models/schemas/recent_items.d.ts +25 -0
- package/dist/types/models/schemas/retention_policies.d.ts +60 -0
- package/dist/types/models/schemas/retention_policy_assignments.d.ts +47 -0
- package/dist/types/models/schemas/search.d.ts +98 -0
- package/dist/types/models/schemas/session_termination.d.ts +10 -0
- package/dist/types/models/schemas/shared_links_folders.d.ts +11 -0
- package/dist/types/models/schemas/shield_information_barrier_reports.d.ts +27 -0
- package/dist/types/models/schemas/shield_information_barrier_segment_members.d.ts +24 -0
- package/dist/types/models/schemas/shield_information_barrier_segment_restrictions.d.ts +24 -0
- package/dist/types/models/schemas/shield_information_barrier_segments.d.ts +26 -0
- package/dist/types/models/schemas/shield_information_barriers.d.ts +31 -0
- package/dist/types/models/schemas/shield_lists.d.ts +88 -0
- package/dist/types/models/schemas/sign_requests.d.ts +136 -0
- package/dist/types/models/schemas/sign_templates.d.ts +90 -0
- package/dist/types/models/schemas/skills.d.ts +120 -0
- package/dist/types/models/schemas/storage_policies.d.ts +12 -0
- package/dist/types/models/schemas/storage_policy_assignments.d.ts +34 -0
- package/dist/types/models/schemas/task_assignments.d.ts +17 -0
- package/dist/types/models/schemas/tasks.d.ts +37 -0
- package/dist/types/models/schemas/terms_of_service_user_statuses.d.ts +27 -0
- package/dist/types/models/schemas/terms_of_services.d.ts +27 -0
- package/dist/types/models/schemas/transfer.d.ts +4 -0
- package/dist/types/models/schemas/trashed_files.d.ts +49 -0
- package/dist/types/models/schemas/trashed_folders.d.ts +47 -0
- package/dist/types/models/schemas/trashed_items.d.ts +1 -0
- package/dist/types/models/schemas/trashed_web_links.d.ts +41 -0
- package/dist/types/models/schemas/uploads.d.ts +28 -0
- package/dist/types/models/schemas/user_collaborations.d.ts +26 -0
- package/dist/types/models/schemas/users.d.ts +98 -0
- package/dist/types/models/schemas/web_links.d.ts +20 -0
- package/dist/types/models/schemas/webhooks.d.ts +37 -0
- package/dist/types/models/schemas/workflows.d.ts +93 -0
- package/dist/types/models/schemas/zip_downloads.d.ts +29 -0
- package/dist/types/models/schemas.d.ts +157 -3493
- package/dist/types/runtime.d.ts +10 -0
- package/dist/types/tokens.d.ts +4 -2
- package/docs/README.md +1 -0
- package/docs/managers/archives.md +2 -2
- package/docs/managers/avatars.md +1 -1
- package/docs/managers/chunked_uploads.md +3 -3
- package/docs/managers/classifications.md +3 -3
- package/docs/managers/collaboration_allowlist_entries.md +10 -10
- package/docs/managers/collaboration_allowlist_exempt_targets.md +10 -10
- package/docs/managers/comments.md +2 -2
- package/docs/managers/email_aliases.md +1 -1
- package/docs/managers/file_classifications.md +2 -2
- package/docs/managers/file_metadata.md +5 -5
- package/docs/managers/file_versions.md +2 -2
- package/docs/managers/file_watermarks.md +1 -1
- package/docs/managers/files.md +2 -2
- package/docs/managers/folder_classifications.md +2 -2
- package/docs/managers/folder_locks.md +1 -1
- package/docs/managers/folder_metadata.md +5 -5
- package/docs/managers/folder_watermarks.md +1 -1
- package/docs/managers/folders.md +3 -3
- package/docs/managers/groups.md +2 -2
- package/docs/managers/integration_mappings.md +2 -2
- package/docs/managers/invites.md +1 -1
- package/docs/managers/legal_hold_policies.md +2 -2
- package/docs/managers/legal_hold_policy_assignments.md +1 -1
- package/docs/managers/memberships.md +10 -10
- package/docs/managers/metadata_cascade_policies.md +2 -2
- package/docs/managers/metadata_taxonomies.md +6 -6
- package/docs/managers/metadata_templates.md +5 -5
- package/docs/managers/query.md +33 -0
- package/docs/managers/retention_policies.md +2 -2
- package/docs/managers/retention_policy_assignments.md +1 -1
- package/docs/managers/session_termination.md +2 -2
- package/docs/managers/shared_links_files.md +3 -3
- package/docs/managers/shared_links_folders.md +3 -3
- package/docs/managers/shared_links_web_links.md +3 -3
- package/docs/managers/shield_information_barrier_segment_members.md +1 -1
- package/docs/managers/shield_information_barrier_segment_restrictions.md +1 -1
- package/docs/managers/shield_information_barrier_segments.md +2 -2
- package/docs/managers/shield_information_barriers.md +2 -2
- package/docs/managers/skills.md +3 -3
- package/docs/managers/storage_policy_assignments.md +2 -2
- package/docs/managers/task_assignments.md +2 -2
- package/docs/managers/tasks.md +2 -2
- package/docs/managers/terms_of_service_user_statuses.md +2 -2
- package/docs/managers/terms_of_services.md +2 -2
- package/docs/managers/transfer.md +1 -1
- package/docs/managers/trashed_files.md +1 -1
- package/docs/managers/trashed_folders.md +1 -1
- package/docs/managers/trashed_web_links.md +1 -1
- package/docs/managers/uploads.md +2 -2
- package/docs/managers/user_collaborations.md +2 -2
- package/docs/managers/users.md +2 -2
- package/docs/managers/web_links.md +2 -2
- package/docs/managers/webhooks.md +2 -2
- package/docs/managers/workflows.md +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,240 @@
|
|
|
1
|
+
import type { AiAgentAskType, AiAgentBasicGenToolEmbeddings, AiAgentExtractType, AiAgentSpreadsheetTool, AiAgentTextGenType, AiCitationType, AiLlmEndpointParams, FieldsOptions, MetadataTemplateType } from '../schemas.js';
|
|
2
|
+
export type AiAgent = (AiAgentAsk & {
|
|
3
|
+
type: "ai_agent_ask";
|
|
4
|
+
}) | (AiAgentTextGen & {
|
|
5
|
+
type: "ai_agent_text_gen";
|
|
6
|
+
}) | (AiAgentExtract & {
|
|
7
|
+
type: "ai_agent_extract";
|
|
8
|
+
}) | (AiAgentExtractStructured & {
|
|
9
|
+
type: "ai_agent_extract_structured";
|
|
10
|
+
}) | {
|
|
11
|
+
type: string;
|
|
12
|
+
[key: string]: unknown;
|
|
13
|
+
};
|
|
14
|
+
export interface AiAgentAsk {
|
|
15
|
+
type: AiAgentAskType;
|
|
16
|
+
long_text?: AiAgentLongTextTool;
|
|
17
|
+
basic_text?: AiAgentBasicTextTool;
|
|
18
|
+
spreadsheet?: AiAgentSpreadsheetTool;
|
|
19
|
+
long_text_multi?: AiAgentLongTextTool;
|
|
20
|
+
basic_text_multi?: AiAgentBasicTextTool;
|
|
21
|
+
basic_image?: AiAgentBasicTextTool;
|
|
22
|
+
basic_image_multi?: AiAgentBasicTextTool;
|
|
23
|
+
}
|
|
24
|
+
export interface AiAgentBasicGenTool {
|
|
25
|
+
model?: string;
|
|
26
|
+
num_tokens_for_completion?: number;
|
|
27
|
+
llm_endpoint_params?: AiLlmEndpointParams;
|
|
28
|
+
system_message?: string;
|
|
29
|
+
prompt_template?: string;
|
|
30
|
+
embeddings?: AiAgentBasicGenToolEmbeddings;
|
|
31
|
+
content_template?: string;
|
|
32
|
+
}
|
|
33
|
+
export interface AiAgentBasicTextTool {
|
|
34
|
+
model?: string;
|
|
35
|
+
num_tokens_for_completion?: number;
|
|
36
|
+
llm_endpoint_params?: AiLlmEndpointParams;
|
|
37
|
+
system_message?: string;
|
|
38
|
+
prompt_template?: string;
|
|
39
|
+
}
|
|
40
|
+
export interface AiAgentExtract {
|
|
41
|
+
type: AiAgentExtractType;
|
|
42
|
+
long_text?: AiAgentLongTextTool;
|
|
43
|
+
basic_text?: AiAgentBasicTextTool;
|
|
44
|
+
basic_image?: AiAgentBasicTextTool;
|
|
45
|
+
}
|
|
46
|
+
export interface AiAgentExtractStructured {
|
|
47
|
+
type: AiAgentExtractStructuredType;
|
|
48
|
+
long_text?: AiAgentLongTextTool;
|
|
49
|
+
basic_text?: AiAgentBasicTextTool;
|
|
50
|
+
basic_image?: AiAgentBasicTextTool;
|
|
51
|
+
}
|
|
52
|
+
export interface AiAgentInfo {
|
|
53
|
+
models?: Array<AiAgentInfoModels>;
|
|
54
|
+
processor?: string;
|
|
55
|
+
}
|
|
56
|
+
export interface AiAgentLongTextTool {
|
|
57
|
+
model?: string;
|
|
58
|
+
num_tokens_for_completion?: number;
|
|
59
|
+
llm_endpoint_params?: AiLlmEndpointParams;
|
|
60
|
+
system_message?: string;
|
|
61
|
+
prompt_template?: string;
|
|
62
|
+
embeddings?: AiAgentBasicGenToolEmbeddings;
|
|
63
|
+
}
|
|
64
|
+
export interface AiAgentReference {
|
|
65
|
+
type: AiAgentReferenceType;
|
|
66
|
+
id: string;
|
|
67
|
+
}
|
|
68
|
+
export interface AiAgentTextGen {
|
|
69
|
+
type: AiAgentTextGenType;
|
|
70
|
+
basic_gen?: AiAgentBasicGenTool;
|
|
71
|
+
}
|
|
72
|
+
export interface AiAsk {
|
|
73
|
+
mode: AiAskMode;
|
|
74
|
+
prompt: string;
|
|
75
|
+
items: Array<AiItemAsk>;
|
|
76
|
+
dialogue_history?: Array<AiDialogueHistory>;
|
|
77
|
+
include_citations?: boolean;
|
|
78
|
+
ai_agent?: AiAskAgent;
|
|
79
|
+
}
|
|
80
|
+
export type AiAskAgent = (AiAgentReference & {
|
|
81
|
+
type: "ai_agent_id";
|
|
82
|
+
}) | (AiAgentAsk & {
|
|
83
|
+
type: "ai_agent_ask";
|
|
84
|
+
}) | {
|
|
85
|
+
type: string;
|
|
86
|
+
[key: string]: unknown;
|
|
87
|
+
};
|
|
88
|
+
export interface AiCitation {
|
|
89
|
+
content?: string;
|
|
90
|
+
id?: string;
|
|
91
|
+
type?: AiCitationType;
|
|
92
|
+
name?: string;
|
|
93
|
+
}
|
|
94
|
+
export interface AiDialogueHistory {
|
|
95
|
+
prompt?: string;
|
|
96
|
+
answer?: string;
|
|
97
|
+
created_at?: string;
|
|
98
|
+
}
|
|
99
|
+
export interface AiExtract {
|
|
100
|
+
prompt: string;
|
|
101
|
+
items: Array<AiItemBase>;
|
|
102
|
+
ai_agent?: AiExtractAgent;
|
|
103
|
+
}
|
|
104
|
+
export type AiExtractAgent = (AiAgentReference & {
|
|
105
|
+
type: "ai_agent_id";
|
|
106
|
+
}) | (AiAgentExtract & {
|
|
107
|
+
type: "ai_agent_extract";
|
|
108
|
+
}) | {
|
|
109
|
+
type: string;
|
|
110
|
+
[key: string]: unknown;
|
|
111
|
+
};
|
|
112
|
+
export interface AiExtractFieldOption {
|
|
113
|
+
key: string;
|
|
114
|
+
}
|
|
115
|
+
export type AiExtractResponse = Record<string, unknown>;
|
|
116
|
+
export interface AiExtractStructured {
|
|
117
|
+
items: Array<AiItemBase>;
|
|
118
|
+
metadata_template?: AiExtractStructuredMetadataTemplate;
|
|
119
|
+
fields?: Array<AiExtractStructuredFields>;
|
|
120
|
+
ai_agent?: AiExtractStructuredAgent;
|
|
121
|
+
include_confidence_score?: boolean;
|
|
122
|
+
include_reference?: boolean;
|
|
123
|
+
taxonomy_sources?: Array<AiTaxonomySource>;
|
|
124
|
+
}
|
|
125
|
+
export type AiExtractStructuredAgent = (AiAgentReference & {
|
|
126
|
+
type: "ai_agent_id";
|
|
127
|
+
}) | (AiAgentExtractStructured & {
|
|
128
|
+
type: "ai_agent_extract_structured";
|
|
129
|
+
}) | {
|
|
130
|
+
type: string;
|
|
131
|
+
[key: string]: unknown;
|
|
132
|
+
};
|
|
133
|
+
export interface AiExtractStructuredResponse {
|
|
134
|
+
answer: AiExtractResponse;
|
|
135
|
+
created_at: string;
|
|
136
|
+
completion_reason?: string;
|
|
137
|
+
confidence_score?: Record<string, unknown>;
|
|
138
|
+
reference?: Record<string, unknown>;
|
|
139
|
+
ai_agent_info?: AiAgentInfo;
|
|
140
|
+
}
|
|
141
|
+
export interface AiExtractSubField {
|
|
142
|
+
key: string;
|
|
143
|
+
description?: string;
|
|
144
|
+
displayName?: string;
|
|
145
|
+
prompt?: string;
|
|
146
|
+
type?: string;
|
|
147
|
+
options?: Array<AiExtractFieldOption>;
|
|
148
|
+
}
|
|
149
|
+
export interface AiItemBase {
|
|
150
|
+
id: string;
|
|
151
|
+
type: AiCitationType;
|
|
152
|
+
content?: string;
|
|
153
|
+
}
|
|
154
|
+
export interface AiItemAsk {
|
|
155
|
+
id: string;
|
|
156
|
+
type: AiItemAskType;
|
|
157
|
+
content?: string;
|
|
158
|
+
}
|
|
159
|
+
export interface AiOptionsRules {
|
|
160
|
+
multi_select?: boolean;
|
|
161
|
+
selectable_levels?: Array<number>;
|
|
162
|
+
}
|
|
163
|
+
export interface AiResponse {
|
|
164
|
+
answer: string;
|
|
165
|
+
created_at: string;
|
|
166
|
+
completion_reason?: string;
|
|
167
|
+
ai_agent_info?: AiAgentInfo;
|
|
168
|
+
}
|
|
169
|
+
export interface AiResponseFull {
|
|
170
|
+
answer: string;
|
|
171
|
+
created_at: string;
|
|
172
|
+
completion_reason?: string;
|
|
173
|
+
ai_agent_info?: AiAgentInfo;
|
|
174
|
+
citations?: Array<AiCitation>;
|
|
175
|
+
}
|
|
176
|
+
export interface AiTaxonomyFileReference {
|
|
177
|
+
type?: AiCitationType;
|
|
178
|
+
taxonomy_key?: string;
|
|
179
|
+
id?: string;
|
|
180
|
+
}
|
|
181
|
+
export interface AiTaxonomyReference {
|
|
182
|
+
type?: AiTaxonomyReferenceType;
|
|
183
|
+
taxonomy_key?: string;
|
|
184
|
+
namespace?: string;
|
|
185
|
+
}
|
|
186
|
+
export type AiTaxonomySource = (AiTaxonomyReference & {
|
|
187
|
+
type: "taxonomy";
|
|
188
|
+
}) | (AiTaxonomyFileReference & {
|
|
189
|
+
type: "file";
|
|
190
|
+
}) | {
|
|
191
|
+
type: string;
|
|
192
|
+
[key: string]: unknown;
|
|
193
|
+
};
|
|
194
|
+
export interface AiTextGen {
|
|
195
|
+
prompt: string;
|
|
196
|
+
items: Array<AiTextGenItems>;
|
|
197
|
+
dialogue_history?: Array<AiDialogueHistory>;
|
|
198
|
+
ai_agent?: AiTextGenAgent;
|
|
199
|
+
}
|
|
200
|
+
export type AiTextGenAgent = (AiAgentReference & {
|
|
201
|
+
type: "ai_agent_id";
|
|
202
|
+
}) | (AiAgentTextGen & {
|
|
203
|
+
type: "ai_agent_text_gen";
|
|
204
|
+
}) | {
|
|
205
|
+
type: string;
|
|
206
|
+
[key: string]: unknown;
|
|
207
|
+
};
|
|
208
|
+
export type AiAgentExtractStructuredType = "ai_agent_extract_structured" | (string & {});
|
|
209
|
+
export interface AiAgentInfoModels {
|
|
210
|
+
name?: string;
|
|
211
|
+
provider?: string;
|
|
212
|
+
supported_purpose?: string;
|
|
213
|
+
}
|
|
214
|
+
export type AiAgentReferenceType = "ai_agent_id" | (string & {});
|
|
215
|
+
export type AiAskMode = "multiple_item_qa" | "single_item_qa" | (string & {});
|
|
216
|
+
export interface AiExtractStructuredMetadataTemplate {
|
|
217
|
+
template_key?: string;
|
|
218
|
+
type?: MetadataTemplateType;
|
|
219
|
+
scope?: string;
|
|
220
|
+
}
|
|
221
|
+
export interface AiExtractStructuredFields {
|
|
222
|
+
key: string;
|
|
223
|
+
description?: string;
|
|
224
|
+
displayName?: string;
|
|
225
|
+
prompt?: string;
|
|
226
|
+
type?: string;
|
|
227
|
+
options?: Array<FieldsOptions>;
|
|
228
|
+
fields?: Array<AiExtractSubField>;
|
|
229
|
+
taxonomy_key?: string;
|
|
230
|
+
namespace?: string;
|
|
231
|
+
options_rules?: AiOptionsRules;
|
|
232
|
+
}
|
|
233
|
+
export type AiItemAskType = "file" | "hubs" | (string & {});
|
|
234
|
+
export type AiTaxonomyReferenceType = "taxonomy" | (string & {});
|
|
235
|
+
export interface AiTextGenItems {
|
|
236
|
+
id: string;
|
|
237
|
+
type: AiCitationType;
|
|
238
|
+
content?: string;
|
|
239
|
+
}
|
|
240
|
+
export type GetAgentDefaultMode = "ask" | "text_gen" | "extract" | "extract_structured" | (string & {});
|
|
@@ -0,0 +1,172 @@
|
|
|
1
|
+
import type { AiAgentAskType, AiAgentBasicGenToolEmbeddings, AiAgentExtractType, AiAgentSpreadsheetTool, AiAgentTextGenType, AiLlmEndpointParams, GroupType, UserBase } from '../schemas.js';
|
|
2
|
+
export type AiAgentAllowedEntity = (UserBase & {
|
|
3
|
+
type: "user";
|
|
4
|
+
}) | (GroupBase & {
|
|
5
|
+
type: "group";
|
|
6
|
+
}) | {
|
|
7
|
+
type: string;
|
|
8
|
+
[key: string]: unknown;
|
|
9
|
+
};
|
|
10
|
+
export interface AiMultipleAgentResponse {
|
|
11
|
+
limit?: number;
|
|
12
|
+
next_marker?: string | null;
|
|
13
|
+
prev_marker?: string | null;
|
|
14
|
+
entries: Array<AiSingleAgentResponseFull>;
|
|
15
|
+
}
|
|
16
|
+
export interface AiSingleAgentResponseFull {
|
|
17
|
+
id: string;
|
|
18
|
+
type?: AiSingleAgentResponseType;
|
|
19
|
+
origin: string;
|
|
20
|
+
name: string;
|
|
21
|
+
access_state: string;
|
|
22
|
+
created_by?: UserBase;
|
|
23
|
+
created_at?: string;
|
|
24
|
+
modified_by?: UserBase;
|
|
25
|
+
modified_at?: string;
|
|
26
|
+
icon_reference?: string;
|
|
27
|
+
allowed_entities?: Array<AiAgentAllowedEntity>;
|
|
28
|
+
ask?: AiStudioAgentAskResponse;
|
|
29
|
+
text_gen?: AiStudioAgentTextGenResponse;
|
|
30
|
+
extract?: AiStudioAgentExtractResponse;
|
|
31
|
+
}
|
|
32
|
+
export interface AiStudioAgentAsk {
|
|
33
|
+
type: AiAgentAskType;
|
|
34
|
+
access_state: string;
|
|
35
|
+
description: string;
|
|
36
|
+
custom_instructions?: string | null;
|
|
37
|
+
suggested_questions?: Array<string>;
|
|
38
|
+
long_text?: AiStudioAgentLongTextTool;
|
|
39
|
+
basic_text?: AiStudioAgentBasicTextTool;
|
|
40
|
+
basic_image?: AiStudioAgentBasicTextTool;
|
|
41
|
+
spreadsheet?: AiStudioAgentSpreadsheetTool;
|
|
42
|
+
long_text_multi?: AiStudioAgentLongTextTool;
|
|
43
|
+
basic_text_multi?: AiStudioAgentBasicTextTool;
|
|
44
|
+
basic_image_multi?: AiStudioAgentBasicTextTool;
|
|
45
|
+
}
|
|
46
|
+
export interface AiStudioAgentAskResponse {
|
|
47
|
+
type: AiAgentAskType;
|
|
48
|
+
access_state: string;
|
|
49
|
+
description: string;
|
|
50
|
+
custom_instructions?: string | null;
|
|
51
|
+
suggested_questions?: Array<string>;
|
|
52
|
+
long_text?: AiStudioAgentLongTextToolResponse;
|
|
53
|
+
basic_text?: AiStudioAgentBasicTextToolResponse;
|
|
54
|
+
basic_image?: AiStudioAgentBasicTextToolResponse;
|
|
55
|
+
spreadsheet?: AiStudioAgentSpreadsheetToolResponse;
|
|
56
|
+
long_text_multi?: AiStudioAgentLongTextToolResponse;
|
|
57
|
+
basic_text_multi?: AiStudioAgentBasicTextToolResponse;
|
|
58
|
+
basic_image_multi?: AiStudioAgentBasicTextToolResponse;
|
|
59
|
+
}
|
|
60
|
+
export interface AiStudioAgentBasicGenTool {
|
|
61
|
+
model?: string;
|
|
62
|
+
num_tokens_for_completion?: number;
|
|
63
|
+
llm_endpoint_params?: AiLlmEndpointParams;
|
|
64
|
+
system_message?: string;
|
|
65
|
+
prompt_template?: string;
|
|
66
|
+
embeddings?: AiAgentBasicGenToolEmbeddings;
|
|
67
|
+
content_template?: string;
|
|
68
|
+
is_custom_instructions_included?: boolean;
|
|
69
|
+
}
|
|
70
|
+
export interface AiStudioAgentBasicGenToolResponse {
|
|
71
|
+
model?: string;
|
|
72
|
+
num_tokens_for_completion?: number;
|
|
73
|
+
llm_endpoint_params?: AiLlmEndpointParams;
|
|
74
|
+
system_message?: string;
|
|
75
|
+
prompt_template?: string;
|
|
76
|
+
embeddings?: AiAgentBasicGenToolEmbeddings;
|
|
77
|
+
content_template?: string;
|
|
78
|
+
is_custom_instructions_included?: boolean;
|
|
79
|
+
warnings?: Array<string>;
|
|
80
|
+
}
|
|
81
|
+
export interface AiStudioAgentBasicTextTool {
|
|
82
|
+
model?: string;
|
|
83
|
+
num_tokens_for_completion?: number;
|
|
84
|
+
llm_endpoint_params?: AiLlmEndpointParams;
|
|
85
|
+
system_message?: string;
|
|
86
|
+
prompt_template?: string;
|
|
87
|
+
is_custom_instructions_included?: boolean;
|
|
88
|
+
}
|
|
89
|
+
export interface AiStudioAgentBasicTextToolResponse {
|
|
90
|
+
model?: string;
|
|
91
|
+
num_tokens_for_completion?: number;
|
|
92
|
+
llm_endpoint_params?: AiLlmEndpointParams;
|
|
93
|
+
system_message?: string;
|
|
94
|
+
prompt_template?: string;
|
|
95
|
+
is_custom_instructions_included?: boolean;
|
|
96
|
+
warnings?: Array<string>;
|
|
97
|
+
}
|
|
98
|
+
export interface AiStudioAgentExtract {
|
|
99
|
+
type: AiAgentExtractType;
|
|
100
|
+
access_state: string;
|
|
101
|
+
description: string;
|
|
102
|
+
custom_instructions?: string | null;
|
|
103
|
+
long_text?: AiStudioAgentLongTextTool;
|
|
104
|
+
basic_text?: AiStudioAgentBasicTextTool;
|
|
105
|
+
basic_image?: AiStudioAgentBasicTextTool;
|
|
106
|
+
}
|
|
107
|
+
export interface AiStudioAgentExtractResponse {
|
|
108
|
+
type: AiAgentExtractType;
|
|
109
|
+
access_state: string;
|
|
110
|
+
description: string;
|
|
111
|
+
custom_instructions?: string | null;
|
|
112
|
+
long_text?: AiStudioAgentLongTextToolResponse;
|
|
113
|
+
basic_text?: AiStudioAgentBasicTextToolResponse;
|
|
114
|
+
basic_image?: AiStudioAgentBasicTextToolResponse;
|
|
115
|
+
}
|
|
116
|
+
export interface AiStudioAgentLongTextTool {
|
|
117
|
+
model?: string;
|
|
118
|
+
num_tokens_for_completion?: number;
|
|
119
|
+
llm_endpoint_params?: AiLlmEndpointParams;
|
|
120
|
+
system_message?: string;
|
|
121
|
+
prompt_template?: string;
|
|
122
|
+
embeddings?: AiAgentBasicGenToolEmbeddings;
|
|
123
|
+
is_custom_instructions_included?: boolean;
|
|
124
|
+
}
|
|
125
|
+
export interface AiStudioAgentLongTextToolResponse {
|
|
126
|
+
model?: string;
|
|
127
|
+
num_tokens_for_completion?: number;
|
|
128
|
+
llm_endpoint_params?: AiLlmEndpointParams;
|
|
129
|
+
system_message?: string;
|
|
130
|
+
prompt_template?: string;
|
|
131
|
+
embeddings?: AiAgentBasicGenToolEmbeddings;
|
|
132
|
+
is_custom_instructions_included?: boolean;
|
|
133
|
+
warnings?: Array<string>;
|
|
134
|
+
}
|
|
135
|
+
export type AiStudioAgentSpreadsheetTool = AiAgentSpreadsheetTool;
|
|
136
|
+
export interface AiStudioAgentSpreadsheetToolResponse {
|
|
137
|
+
model?: string;
|
|
138
|
+
num_tokens_for_completion?: number;
|
|
139
|
+
llm_endpoint_params?: AiLlmEndpointParams;
|
|
140
|
+
warnings?: Array<string>;
|
|
141
|
+
}
|
|
142
|
+
export interface AiStudioAgentTextGen {
|
|
143
|
+
type: AiAgentTextGenType;
|
|
144
|
+
access_state: string;
|
|
145
|
+
description: string;
|
|
146
|
+
custom_instructions?: string | null;
|
|
147
|
+
suggested_questions?: Array<string>;
|
|
148
|
+
basic_gen?: AiStudioAgentBasicGenTool;
|
|
149
|
+
}
|
|
150
|
+
export interface AiStudioAgentTextGenResponse {
|
|
151
|
+
type: AiAgentTextGenType;
|
|
152
|
+
access_state: string;
|
|
153
|
+
description: string;
|
|
154
|
+
custom_instructions?: string | null;
|
|
155
|
+
suggested_questions?: Array<string>;
|
|
156
|
+
basic_gen?: AiStudioAgentBasicGenToolResponse;
|
|
157
|
+
}
|
|
158
|
+
export interface CreateAiAgent {
|
|
159
|
+
type: AiSingleAgentResponseType;
|
|
160
|
+
name: string;
|
|
161
|
+
access_state: string;
|
|
162
|
+
icon_reference?: string;
|
|
163
|
+
allowed_entities?: Array<AiAgentAllowedEntity>;
|
|
164
|
+
ask?: AiStudioAgentAsk;
|
|
165
|
+
text_gen?: AiStudioAgentTextGen;
|
|
166
|
+
extract?: AiStudioAgentExtract;
|
|
167
|
+
}
|
|
168
|
+
export interface GroupBase {
|
|
169
|
+
id: string;
|
|
170
|
+
type: GroupType;
|
|
171
|
+
}
|
|
172
|
+
export type AiSingleAgentResponseType = "ai_agent" | (string & {});
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import type { AppItem, FileBase, FolderType, TrashWebLinkType } from '../schemas.js';
|
|
2
|
+
export type AppItemAssociatedItem = (FileBase & {
|
|
3
|
+
type: "file";
|
|
4
|
+
}) | (FolderBase & {
|
|
5
|
+
type: "folder";
|
|
6
|
+
}) | (WebLinkBase & {
|
|
7
|
+
type: "web_link";
|
|
8
|
+
}) | {
|
|
9
|
+
type: string;
|
|
10
|
+
[key: string]: unknown;
|
|
11
|
+
};
|
|
12
|
+
export interface AppItemAssociation {
|
|
13
|
+
id: string;
|
|
14
|
+
type: AppItemAssociationType;
|
|
15
|
+
app_item: AppItem;
|
|
16
|
+
item: AppItemAssociatedItem;
|
|
17
|
+
}
|
|
18
|
+
export interface AppItemAssociations {
|
|
19
|
+
limit?: number;
|
|
20
|
+
next_marker?: string | null;
|
|
21
|
+
prev_marker?: string | null;
|
|
22
|
+
entries?: Array<AppItemAssociation>;
|
|
23
|
+
}
|
|
24
|
+
export interface FolderBase {
|
|
25
|
+
id: string;
|
|
26
|
+
etag?: string | null;
|
|
27
|
+
type: FolderType;
|
|
28
|
+
}
|
|
29
|
+
export interface WebLinkBase {
|
|
30
|
+
id: string;
|
|
31
|
+
type: TrashWebLinkType;
|
|
32
|
+
etag?: string;
|
|
33
|
+
}
|
|
34
|
+
export type AppItemAssociationType = "app_item_association" | (string & {});
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
export interface Archive {
|
|
2
|
+
id: string;
|
|
3
|
+
type: ArchiveType;
|
|
4
|
+
name: string;
|
|
5
|
+
size: number;
|
|
6
|
+
description?: string | null;
|
|
7
|
+
owned_by?: ArchiveOwnedBy;
|
|
8
|
+
}
|
|
9
|
+
export interface Archives {
|
|
10
|
+
entries?: Array<Archive>;
|
|
11
|
+
limit?: number;
|
|
12
|
+
next_marker?: string | null;
|
|
13
|
+
}
|
|
14
|
+
export type ArchiveType = "archive" | (string & {});
|
|
15
|
+
export interface ArchiveOwnedBy {
|
|
16
|
+
id: string;
|
|
17
|
+
type: string;
|
|
18
|
+
}
|
|
19
|
+
export interface CreateArchiveRequest {
|
|
20
|
+
name: string;
|
|
21
|
+
description?: string;
|
|
22
|
+
storage_policy_id?: string;
|
|
23
|
+
}
|
|
24
|
+
export interface UpdateArchiveRequest {
|
|
25
|
+
name?: string;
|
|
26
|
+
description?: string;
|
|
27
|
+
}
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import type { AccessTokenTokenType, ResourceScope } from '../schemas.js';
|
|
2
|
+
export interface AccessToken {
|
|
3
|
+
access_token?: string;
|
|
4
|
+
expires_in?: number;
|
|
5
|
+
token_type?: AccessTokenTokenType;
|
|
6
|
+
restricted_to?: Array<ResourceScope>;
|
|
7
|
+
refresh_token?: string;
|
|
8
|
+
issued_token_type?: AccessTokenIssuedTokenType;
|
|
9
|
+
}
|
|
10
|
+
export interface PostOAuth2Revoke {
|
|
11
|
+
client_id?: string;
|
|
12
|
+
client_secret?: string;
|
|
13
|
+
token?: string;
|
|
14
|
+
}
|
|
15
|
+
export interface PostOAuth2Token {
|
|
16
|
+
grant_type: PostOAuth2TokenGrantType;
|
|
17
|
+
client_id?: string;
|
|
18
|
+
client_secret?: string;
|
|
19
|
+
code?: string;
|
|
20
|
+
refresh_token?: string;
|
|
21
|
+
assertion?: string;
|
|
22
|
+
subject_token?: string;
|
|
23
|
+
subject_token_type?: AccessTokenIssuedTokenType;
|
|
24
|
+
actor_token?: string;
|
|
25
|
+
actor_token_type?: PostOAuth2TokenActorTokenType;
|
|
26
|
+
scope?: string;
|
|
27
|
+
resource?: string;
|
|
28
|
+
box_subject_type?: PostOAuth2TokenBoxSubjectType;
|
|
29
|
+
box_subject_id?: string;
|
|
30
|
+
box_shared_link?: string;
|
|
31
|
+
}
|
|
32
|
+
export interface PostOAuth2TokenRefreshAccessToken {
|
|
33
|
+
grant_type: PostOAuth2TokenRefreshAccessTokenGrantType;
|
|
34
|
+
client_id: string;
|
|
35
|
+
client_secret: string;
|
|
36
|
+
refresh_token: string;
|
|
37
|
+
}
|
|
38
|
+
export type AccessTokenIssuedTokenType = "urn:ietf:params:oauth:token-type:access_token" | (string & {});
|
|
39
|
+
export type PostOAuth2TokenGrantType = "authorization_code" | "refresh_token" | "client_credentials" | "urn:ietf:params:oauth:grant-type:jwt-bearer" | "urn:ietf:params:oauth:grant-type:token-exchange" | (string & {});
|
|
40
|
+
export type PostOAuth2TokenActorTokenType = "urn:ietf:params:oauth:token-type:id_token" | (string & {});
|
|
41
|
+
export type PostOAuth2TokenBoxSubjectType = "enterprise" | "user" | (string & {});
|
|
42
|
+
export type PostOAuth2TokenRefreshAccessTokenGrantType = "refresh_token" | (string & {});
|
|
43
|
+
export type GetAuthorizeResponseType = "code" | (string & {});
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import type { UserMini } from '../schemas.js';
|
|
2
|
+
export interface AutomateWorkflowAction {
|
|
3
|
+
id: string;
|
|
4
|
+
type: AutomateWorkflowActionType;
|
|
5
|
+
action_type: AutomateWorkflowActionActionType;
|
|
6
|
+
description?: string;
|
|
7
|
+
created_at?: string;
|
|
8
|
+
updated_at?: string;
|
|
9
|
+
created_by?: UserMini;
|
|
10
|
+
updated_by?: UserMini;
|
|
11
|
+
workflow: AutomateWorkflowReference;
|
|
12
|
+
}
|
|
13
|
+
export interface AutomateWorkflowReference {
|
|
14
|
+
id: string;
|
|
15
|
+
type: AutomateWorkflowReferenceType;
|
|
16
|
+
name?: string;
|
|
17
|
+
}
|
|
18
|
+
export interface AutomateWorkflows {
|
|
19
|
+
entries?: Array<AutomateWorkflowAction>;
|
|
20
|
+
limit?: number;
|
|
21
|
+
next_marker?: string | null;
|
|
22
|
+
}
|
|
23
|
+
export interface AutomateWorkflowStartRequest {
|
|
24
|
+
workflow_action_id: string;
|
|
25
|
+
file_ids: Array<string>;
|
|
26
|
+
}
|
|
27
|
+
export type AutomateWorkflowActionType = "workflow_action" | (string & {});
|
|
28
|
+
export type AutomateWorkflowActionActionType = "run_workflow" | (string & {});
|
|
29
|
+
export type AutomateWorkflowReferenceType = "workflow" | (string & {});
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
import type { CollectionsOrder } from '../schemas.js';
|
|
2
|
+
export interface UploadedPart {
|
|
3
|
+
part?: UploadPart;
|
|
4
|
+
}
|
|
5
|
+
export interface UploadPart {
|
|
6
|
+
part_id?: string;
|
|
7
|
+
offset?: number;
|
|
8
|
+
size?: number;
|
|
9
|
+
sha1?: string;
|
|
10
|
+
}
|
|
11
|
+
export interface UploadParts {
|
|
12
|
+
total_count?: number;
|
|
13
|
+
limit?: number;
|
|
14
|
+
offset?: number;
|
|
15
|
+
order?: Array<CollectionsOrder>;
|
|
16
|
+
entries?: Array<UploadPart>;
|
|
17
|
+
}
|
|
18
|
+
export interface UploadSession {
|
|
19
|
+
id?: string;
|
|
20
|
+
type?: UploadSessionType;
|
|
21
|
+
session_expires_at?: string;
|
|
22
|
+
part_size?: number;
|
|
23
|
+
total_parts?: number;
|
|
24
|
+
num_parts_processed?: number;
|
|
25
|
+
session_endpoints?: UploadSessionSessionEndpoints;
|
|
26
|
+
}
|
|
27
|
+
export type UploadSessionType = "upload_session" | (string & {});
|
|
28
|
+
export interface UploadSessionSessionEndpoints {
|
|
29
|
+
upload_part?: string;
|
|
30
|
+
commit?: string;
|
|
31
|
+
abort?: string;
|
|
32
|
+
list_parts?: string;
|
|
33
|
+
status?: string;
|
|
34
|
+
log_event?: string;
|
|
35
|
+
}
|
|
36
|
+
export interface CreateFileUploadSessionRequest {
|
|
37
|
+
folder_id: string;
|
|
38
|
+
file_size: number;
|
|
39
|
+
file_name: string;
|
|
40
|
+
}
|
|
41
|
+
export interface CreateFileVersionUploadSessionRequest {
|
|
42
|
+
file_size: number;
|
|
43
|
+
file_name?: string;
|
|
44
|
+
}
|
|
45
|
+
export interface CommitFileUploadSessionRequest {
|
|
46
|
+
parts: Array<UploadPart>;
|
|
47
|
+
}
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
import type { ClassificationTemplate2, EnterpriseType, MetadataTemplateType } from '../schemas.js';
|
|
2
|
+
export interface ClassificationTemplate {
|
|
3
|
+
id: string;
|
|
4
|
+
type: MetadataTemplateType;
|
|
5
|
+
scope: string;
|
|
6
|
+
templateKey: ClassificationTemplate2;
|
|
7
|
+
displayName: ClassificationTemplateDisplayName;
|
|
8
|
+
hidden?: boolean;
|
|
9
|
+
copyInstanceOnItemCopy?: boolean;
|
|
10
|
+
fields: Array<ClassificationTemplateFields>;
|
|
11
|
+
}
|
|
12
|
+
export type ClassificationTemplateDisplayName = "Classification" | (string & {});
|
|
13
|
+
export type FieldsType = "enum" | (string & {});
|
|
14
|
+
export type FieldsKey = "Box__Security__Classification__Key" | (string & {});
|
|
15
|
+
export interface StaticConfigClassification {
|
|
16
|
+
classificationDefinition?: string;
|
|
17
|
+
colorID?: number;
|
|
18
|
+
}
|
|
19
|
+
export interface OptionsStaticConfig {
|
|
20
|
+
classification?: StaticConfigClassification;
|
|
21
|
+
}
|
|
22
|
+
export interface ClassificationTemplateFieldsOptions {
|
|
23
|
+
id: string;
|
|
24
|
+
key: string;
|
|
25
|
+
staticConfig?: OptionsStaticConfig;
|
|
26
|
+
}
|
|
27
|
+
export interface ClassificationTemplateFields {
|
|
28
|
+
id: string;
|
|
29
|
+
type: FieldsType;
|
|
30
|
+
key: FieldsKey;
|
|
31
|
+
displayName: ClassificationTemplateDisplayName;
|
|
32
|
+
hidden?: boolean;
|
|
33
|
+
options: Array<ClassificationTemplateFieldsOptions>;
|
|
34
|
+
}
|
|
35
|
+
export type PutAddOp = "addEnumOption" | (string & {});
|
|
36
|
+
export interface PutAddData {
|
|
37
|
+
key: string;
|
|
38
|
+
staticConfig?: OptionsStaticConfig;
|
|
39
|
+
}
|
|
40
|
+
export interface UpdateClassificationAddRequest {
|
|
41
|
+
op: PutAddOp;
|
|
42
|
+
fieldKey: FieldsKey;
|
|
43
|
+
data: PutAddData;
|
|
44
|
+
}
|
|
45
|
+
export type PutUpdateOp = "editEnumOption" | (string & {});
|
|
46
|
+
export interface UpdateClassificationUpdateRequest {
|
|
47
|
+
op: PutUpdateOp;
|
|
48
|
+
fieldKey: FieldsKey;
|
|
49
|
+
enumOptionKey: string;
|
|
50
|
+
data: PutAddData;
|
|
51
|
+
}
|
|
52
|
+
export interface PostMetadataTemplateSchemaClassificationsFields {
|
|
53
|
+
type: FieldsType;
|
|
54
|
+
key: FieldsKey;
|
|
55
|
+
displayName: ClassificationTemplateDisplayName;
|
|
56
|
+
hidden?: boolean;
|
|
57
|
+
options: Array<PutAddData>;
|
|
58
|
+
}
|
|
59
|
+
export interface CreateMetadataTemplateSchemaClassificationsRequest {
|
|
60
|
+
scope: EnterpriseType;
|
|
61
|
+
templateKey: ClassificationTemplate2;
|
|
62
|
+
displayName: ClassificationTemplateDisplayName;
|
|
63
|
+
hidden?: boolean;
|
|
64
|
+
copyInstanceOnItemCopy?: boolean;
|
|
65
|
+
fields: Array<PostMetadataTemplateSchemaClassificationsFields>;
|
|
66
|
+
}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import type { CollaborationAllowlistEntryEnterprise } from '../schemas.js';
|
|
2
|
+
export interface CollaborationAllowlistEntries {
|
|
3
|
+
limit?: number;
|
|
4
|
+
next_marker?: string | null;
|
|
5
|
+
prev_marker?: string | null;
|
|
6
|
+
entries?: Array<CollaborationAllowlistEntry>;
|
|
7
|
+
}
|
|
8
|
+
export interface CollaborationAllowlistEntry {
|
|
9
|
+
id?: string;
|
|
10
|
+
type?: CollaborationAllowlistEntryType;
|
|
11
|
+
domain?: string;
|
|
12
|
+
direction?: CollaborationAllowlistEntryDirection;
|
|
13
|
+
enterprise?: CollaborationAllowlistEntryEnterprise;
|
|
14
|
+
created_at?: string;
|
|
15
|
+
}
|
|
16
|
+
export type CollaborationAllowlistEntryType = "collaboration_whitelist_entry" | (string & {});
|
|
17
|
+
export type CollaborationAllowlistEntryDirection = "inbound" | "outbound" | "both" | (string & {});
|
|
18
|
+
export interface CreateCollaborationAllowlistEntryRequest {
|
|
19
|
+
domain: string;
|
|
20
|
+
direction: CollaborationAllowlistEntryDirection;
|
|
21
|
+
}
|