@unofficialbox/box-open-sdk 0.3.1 → 0.4.1

package/dist/types/models/schemas/collaboration_allowlist_exempt_targets.d.ts

@@ -0,0 +1,19 @@
+import type { AttributesParent, CollaborationAllowlistEntryEnterprise, UserMini } from '../schemas.js';
+export interface CollaborationAllowlistExemptTarget {
+    id?: string;
+    type?: CollaborationAllowlistExemptTargetType;
+    enterprise?: CollaborationAllowlistEntryEnterprise;
+    user?: UserMini;
+    created_at?: string;
+    modified_at?: string;
+}
+export interface CollaborationAllowlistExemptTargets {
+    limit?: number;
+    next_marker?: string | null;
+    prev_marker?: string | null;
+    entries?: Array<CollaborationAllowlistExemptTarget>;
+}
+export type CollaborationAllowlistExemptTargetType = "collaboration_whitelist_exempt_target" | (string & {});
+export interface CreateCollaborationAllowlistExemptTargetRequest {
+    user: AttributesParent;
+}

package/dist/types/models/schemas/collections.d.ts

@@ -0,0 +1,15 @@
+import type { Collection, CollectionsOrder, Item } from '../schemas.js';
+export interface Collections {
+    total_count?: number;
+    limit?: number;
+    offset?: number;
+    order?: Array<CollectionsOrder>;
+    entries?: Array<Collection>;
+}
+export interface ItemsOffsetPaginated {
+    total_count?: number;
+    limit?: number;
+    offset?: number;
+    order?: Array<CollectionsOrder>;
+    entries?: Array<Item>;
+}

package/dist/types/models/schemas/comments.d.ts

@@ -0,0 +1,33 @@
+import type { CollectionsOrder, CommentItem, UserMini } from '../schemas.js';
+export interface CommentFull {
+    id?: string;
+    type?: CommentType;
+    is_reply_comment?: boolean;
+    message?: string;
+    created_by?: UserMini;
+    created_at?: string;
+    modified_at?: string;
+    item?: CommentItem;
+    tagged_message?: string;
+}
+export interface Comments {
+    total_count?: number;
+    limit?: number;
+    offset?: number;
+    order?: Array<CollectionsOrder>;
+    entries?: Array<CommentFull>;
+}
+export type CommentType = "comment" | (string & {});
+export interface UpdateCommentRequest {
+    message?: string;
+}
+export type ItemType = "file" | "comment" | (string & {});
+export interface PostItem {
+    id: string;
+    type: ItemType;
+}
+export interface CreateCommentRequest {
+    message: string;
+    tagged_message?: string;
+    item: PostItem;
+}

package/dist/types/models/schemas/device_pinners.d.ts

@@ -0,0 +1,20 @@
+import type { UserMini } from '../schemas.js';
+export interface DevicePinner {
+    id?: string;
+    type?: DevicePinnerType;
+    owned_by?: UserMini;
+    product_name?: string;
+}
+export interface DevicePinners {
+    entries?: Array<DevicePinner>;
+    limit?: number;
+    next_marker?: number;
+    order?: Array<DevicePinnersOrder>;
+}
+export type DevicePinnerType = "device_pinner" | (string & {});
+export type OrderBy = "id" | (string & {});
+export type DevicePinnersOrderDirection = "asc" | "desc" | (string & {});
+export interface DevicePinnersOrder {
+    by?: OrderBy;
+    direction?: DevicePinnersOrderDirection;
+}

package/dist/types/models/schemas/docgen.d.ts

@@ -0,0 +1,40 @@
+import type { DocGenBatchBase, DocGenJobFailures, DocGenJobStatus, DocGenJobType, EnterpriseReference, FileReference, FileVersionBase, UserBase } from '../schemas.js';
+export interface DocGenBatchCreateRequest {
+    file: FileReference;
+    file_version?: FileVersionBase;
+    input_source: string;
+    destination_folder: DocGenBatchCreateRequestDestinationFolder;
+    output_type: string;
+    document_generation_data: Array<DocGenDocumentGenerationData>;
+}
+export interface DocGenDocumentGenerationData {
+    generated_file_name: string;
+    user_input: Record<string, unknown>;
+}
+export interface DocGenJobFull {
+    id: string;
+    type: DocGenJobType;
+    batch: DocGenBatchBase;
+    template_file: FileReference;
+    template_file_version: FileVersionBase;
+    output_file?: FileReference | null;
+    output_file_version?: FileVersionBase | null;
+    status: DocGenJobStatus;
+    output_type: string;
+    failures?: DocGenJobFailures | null;
+    created_at?: string;
+    created_by: UserBase;
+    enterprise: EnterpriseReference;
+    source: string;
+}
+export interface DocGenJobsFull {
+    limit?: number;
+    next_marker?: string | null;
+    prev_marker?: string | null;
+    entries?: Array<DocGenJobFull>;
+}
+export type DestinationFolderType = "folder" | (string & {});
+export interface DocGenBatchCreateRequestDestinationFolder {
+    type: DestinationFolderType;
+    id: string;
+}

package/dist/types/models/schemas/docgen_template.d.ts

@@ -0,0 +1,29 @@
+import type { FileReference } from '../schemas.js';
+export interface DocGenTag {
+    tag_content: string;
+    tag_type: DocGenTagTagType;
+    json_paths: Array<string>;
+}
+export interface DocGenTags {
+    limit?: number;
+    next_marker?: string | null;
+    prev_marker?: string | null;
+    entries?: Array<DocGenTag>;
+}
+export interface DocGenTemplate {
+    file?: FileReference;
+    file_name?: string | null;
+}
+export interface DocGenTemplateBase {
+    file?: FileReference;
+}
+export interface DocGenTemplateCreateRequest {
+    file: FileReference;
+}
+export interface DocGenTemplates {
+    limit?: number;
+    next_marker?: string | null;
+    prev_marker?: string | null;
+    entries?: Array<DocGenTemplate>;
+}
+export type DocGenTagTagType = "text" | "arithmetic" | "conditional" | "for-loop" | "table-loop" | "image" | (string & {});

package/dist/types/models/schemas/email_aliases.d.ts

@@ -0,0 +1,14 @@
+export interface EmailAlias {
+    id?: string;
+    type?: EmailAliasType;
+    email?: string;
+    is_confirmed?: boolean;
+}
+export interface EmailAliases {
+    total_count?: number;
+    entries?: Array<EmailAlias>;
+}
+export type EmailAliasType = "email_alias" | (string & {});
+export interface CreateUserIdRequest {
+    email: string;
+}

package/dist/types/models/schemas/enterprise_configurations.d.ts

@@ -0,0 +1,251 @@
+import type { SharedLinkPermissions } from '../schemas.js';
+export interface CollaborationPermissions {
+    is_co_owner_role_enabled?: boolean;
+    is_editor_role_enabled?: boolean;
+    is_previewer_role_enabled?: boolean;
+    is_previewer_uploader_role_enabled?: boolean;
+    is_uploader_role_enabled?: boolean;
+    is_viewer_role_enabled?: boolean;
+    is_viewer_uploader_role_enabled?: boolean;
+}
+export interface CustomSessionDurationGroupItem {
+    id?: string;
+    name?: string;
+}
+export interface EnterpriseConfiguration {
+    id?: string;
+    type?: EnterpriseConfigurationType;
+    security?: EnterpriseConfigurationSecurity | null;
+    content_and_sharing?: EnterpriseConfigurationContentAndSharing | null;
+    user_settings?: EnterpriseConfigurationUserSettings | null;
+    shield?: EnterpriseConfigurationShield | null;
+}
+export interface EnterpriseConfigurationContentAndSharing {
+    enterprise_feature_settings?: Array<EnterpriseFeatureSettingsItem>;
+    sharing_item_type?: EnterpriseConfigurationItemString;
+    shared_link_company_definition?: EnterpriseConfigurationItemString;
+    shared_link_access?: EnterpriseConfigurationItemString;
+    shared_link_default_access?: EnterpriseConfigurationItemString;
+    shared_link_default_permissions_selected?: EnterpriseConfigurationContentAndSharingSharedLinkDefaultPermissionsSelected;
+    is_open_custom_urls_disabled?: EnterpriseConfigurationItemBoolean;
+    is_custom_domain_hidden_in_shared_link?: EnterpriseConfigurationItemBoolean;
+    collaboration_permissions?: EnterpriseConfigurationContentAndSharingCollaborationPermissions;
+    default_collaboration_role?: EnterpriseConfigurationItemString;
+    is_invite_privilege_restricted?: EnterpriseConfigurationItemBoolean;
+    collaboration_restrictions?: EnterpriseConfigurationContentAndSharingCollaborationRestrictions;
+    is_collaborator_invite_links_disabled?: EnterpriseConfigurationItemBoolean;
+    is_invite_group_collaborator_disabled?: EnterpriseConfigurationItemBoolean;
+    is_ownership_transfer_restricted?: EnterpriseConfigurationItemBoolean;
+    external_collaboration_status?: EnterpriseConfigurationContentAndSharingExternalCollaborationStatus;
+    external_collaboration_allowlist_users?: EnterpriseConfigurationContentAndSharingExternalCollaborationAllowlistUsers;
+    is_watermarking_enterprise_feature_enabled?: EnterpriseConfigurationItemBoolean;
+    is_root_content_creation_restricted?: EnterpriseConfigurationItemBoolean;
+    is_tag_creation_restricted?: EnterpriseConfigurationItemBoolean;
+    tag_creation_restriction?: EnterpriseConfigurationItemString;
+    is_email_uploads_enabled?: EnterpriseConfigurationItemBoolean;
+    is_custom_settings_enabled?: EnterpriseConfigurationItemBoolean;
+    is_forms_login_required?: EnterpriseConfigurationItemBoolean;
+    is_forms_branding_default_enabled?: EnterpriseConfigurationItemBoolean;
+    is_cc_free_trial_active?: EnterpriseConfigurationItemBoolean;
+    is_file_request_editors_allowed?: EnterpriseConfigurationItemBoolean;
+    is_file_request_branding_default_enabled?: EnterpriseConfigurationItemBoolean;
+    is_file_request_login_required?: EnterpriseConfigurationItemBoolean;
+    is_shared_links_expiration_enabled?: EnterpriseConfigurationItemBoolean;
+    shared_links_expiration_days?: EnterpriseConfigurationItemInteger;
+    is_public_shared_links_expiration_enabled?: EnterpriseConfigurationItemBoolean;
+    public_shared_links_expiration_days?: EnterpriseConfigurationItemInteger;
+    shared_expiration_target?: EnterpriseConfigurationItemString;
+    is_shared_links_expiration_notification_enabled?: EnterpriseConfigurationItemBoolean;
+    shared_links_expiration_notification_days?: EnterpriseConfigurationItemInteger;
+    is_shared_links_expiration_notification_prevented?: EnterpriseConfigurationItemBoolean;
+    is_auto_delete_enabled?: EnterpriseConfigurationItemBoolean;
+    auto_delete_days?: EnterpriseConfigurationItemInteger;
+    is_auto_delete_expiration_modification_prevented?: EnterpriseConfigurationItemBoolean;
+    auto_delete_target?: EnterpriseConfigurationItemString;
+    is_collaboration_expiration_enabled?: EnterpriseConfigurationItemBoolean;
+    collaboration_expiration_days?: EnterpriseConfigurationItemInteger;
+    is_collaboration_expiration_modification_prevented?: EnterpriseConfigurationItemBoolean;
+    is_collaboration_expiration_notification_enabled?: EnterpriseConfigurationItemBoolean;
+    collaboration_expiration_target?: EnterpriseConfigurationItemString;
+    trash_auto_clear_time?: EnterpriseConfigurationItemInteger;
+    permanent_deletion_access?: EnterpriseConfigurationItemString;
+    permanent_deletion_allowlist_users?: EnterpriseConfigurationContentAndSharingExternalCollaborationAllowlistUsers;
+}
+export interface EnterpriseConfigurationItemBoolean {
+    is_used?: boolean;
+    value?: boolean | null;
+}
+export interface EnterpriseConfigurationItemInteger {
+    is_used?: boolean;
+    value?: number | null;
+}
+export interface EnterpriseConfigurationItemString {
+    is_used?: boolean;
+    value?: string | null;
+}
+export interface EnterpriseConfigurationSecurity {
+    is_managed_user_signup_enabled?: EnterpriseConfigurationItemBoolean;
+    is_managed_user_signup_notification_enabled?: EnterpriseConfigurationItemBoolean;
+    is_managed_user_signup_corporate_email_enabled?: EnterpriseConfigurationItemBoolean;
+    is_new_user_notification_daily_digest_enabled?: EnterpriseConfigurationItemBoolean;
+    is_managed_user_email_change_disabled?: EnterpriseConfigurationItemBoolean;
+    is_multi_factor_auth_required?: EnterpriseConfigurationItemBoolean;
+    is_weak_password_prevention_enabled?: EnterpriseConfigurationItemBoolean;
+    is_password_leak_detection_enabled?: EnterpriseConfigurationItemBoolean;
+    last_password_reset_at?: EnterpriseConfigurationSecurityLastPasswordResetAt;
+    is_password_request_notification_enabled?: EnterpriseConfigurationItemBoolean;
+    is_password_change_notification_enabled?: EnterpriseConfigurationItemBoolean;
+    is_strong_password_for_ext_collab_enabled?: EnterpriseConfigurationItemBoolean;
+    is_managed_user_migration_disabled?: EnterpriseConfigurationItemBoolean;
+    join_link?: EnterpriseConfigurationItemString;
+    join_url?: EnterpriseConfigurationItemString;
+    failed_login_attempts_to_trigger_admin_notification?: EnterpriseConfigurationItemInteger;
+    password_min_length?: EnterpriseConfigurationItemInteger;
+    password_min_uppercase_characters?: EnterpriseConfigurationItemInteger;
+    password_min_numeric_characters?: EnterpriseConfigurationItemInteger;
+    password_min_special_characters?: EnterpriseConfigurationItemInteger;
+    password_reset_frequency?: EnterpriseConfigurationItemString;
+    previous_password_reuse_limit?: EnterpriseConfigurationItemString;
+    session_duration?: EnterpriseConfigurationItemString;
+    external_collab_multi_factor_auth_settings?: EnterpriseConfigurationSecurityExternalCollabMultiFactorAuthSettings;
+    keysafe?: EnterpriseConfigurationSecurityKeysafe;
+    is_custom_session_duration_enabled?: EnterpriseConfigurationItemBoolean;
+    custom_session_duration_value?: EnterpriseConfigurationItemString;
+    custom_session_duration_groups?: EnterpriseConfigurationSecurityCustomSessionDurationGroups;
+    multi_factor_auth_type?: EnterpriseConfigurationItemString;
+    enforced_mfa_frequency?: EnterpriseConfigurationSecurityEnforcedMfaFrequency;
+}
+export interface EnterpriseConfigurationShield {
+    shield_rules?: Array<ShieldRuleItem>;
+}
+export interface EnterpriseConfigurationUserSettings {
+    enterprise_feature_settings?: Array<EnterpriseFeatureSettingsItem>;
+    user_invites_expiration_time_frame?: EnterpriseConfigurationItemString;
+    is_username_change_restricted?: EnterpriseConfigurationItemBoolean;
+    is_box_sync_restricted_for_new_users?: EnterpriseConfigurationItemBoolean;
+    is_view_all_users_enabled_for_new_users?: EnterpriseConfigurationItemBoolean;
+    is_device_limit_exemption_enabled_for_new_users?: EnterpriseConfigurationItemBoolean;
+    is_external_collaboration_restricted_for_new_users?: EnterpriseConfigurationItemBoolean;
+    is_unlimited_storage_enabled_for_new_users?: EnterpriseConfigurationItemBoolean;
+    new_user_default_storage_limit?: EnterpriseConfigurationItemInteger;
+    new_user_default_timezone?: EnterpriseConfigurationItemString;
+    new_user_default_language?: EnterpriseConfigurationItemString;
+    is_enterprise_sso_required?: EnterpriseConfigurationItemBoolean;
+    is_enterprise_sso_in_testing?: EnterpriseConfigurationItemBoolean;
+    is_sso_auto_add_groups_enabled?: EnterpriseConfigurationItemBoolean;
+    is_sso_auto_add_user_to_groups_enabled?: EnterpriseConfigurationItemBoolean;
+    is_sso_auto_remove_user_from_groups_enabled?: EnterpriseConfigurationItemBoolean;
+    user_tracking_codes?: EnterpriseConfigurationUserSettingsUserTrackingCodes;
+    number_of_user_tracking_codes_remaining?: EnterpriseConfigurationItemInteger;
+    is_instant_login_restricted?: EnterpriseConfigurationItemBoolean;
+}
+export interface EnterpriseFeatureSetting {
+    id?: string | null;
+    feature?: EnterpriseFeatureSettingFeature;
+    state?: string | null;
+    can_configure?: boolean | null;
+    is_configured?: boolean | null;
+    allowlist?: Array<UserOrGroupReference> | null;
+    denylist?: Array<UserOrGroupReference> | null;
+}
+export interface EnterpriseFeatureSettingsItem {
+    is_used?: boolean;
+    value?: EnterpriseFeatureSetting;
+}
+export interface ExternalCollabSecuritySettings {
+    denylist_domains?: Array<string>;
+    denylist_emails?: Array<string>;
+    allowlist_domains?: Array<string>;
+    allowlist_emails?: Array<string>;
+    state?: string | null;
+    scheduled_status?: string | null;
+    scheduled_at?: string | null;
+    factor_type_settings?: string | null;
+}
+export interface KeysafeSettings {
+    keysafe_enabled?: boolean;
+    cloud_provider?: string | null;
+    key_id?: string | null;
+    account_id?: string | null;
+    location_id?: string | null;
+    project_id?: string | null;
+    keyring_id?: string | null;
+}
+export interface ListUser {
+    id?: number | null;
+    name?: string | null;
+    email?: string | null;
+}
+export interface ShieldRuleItem {
+    id?: string;
+    type?: ShieldRuleItemType;
+    rule_category?: string;
+    name?: string;
+    description?: string;
+    priority?: ShieldRuleItemPriority;
+    created_at?: string;
+    modified_at?: string;
+}
+export interface UserOrGroupReference {
+    type?: UserOrGroupReferenceType;
+    id?: string;
+}
+export interface UserTrackingCode {
+    id?: number | null;
+    name?: string | null;
+}
+export type EnterpriseConfigurationType = "enterprise_configuration" | (string & {});
+export interface EnterpriseConfigurationContentAndSharingSharedLinkDefaultPermissionsSelected {
+    is_used?: boolean;
+    value?: SharedLinkPermissions;
+}
+export interface EnterpriseConfigurationContentAndSharingCollaborationPermissions {
+    is_used?: boolean;
+    value?: CollaborationPermissions;
+}
+export interface EnterpriseConfigurationContentAndSharingCollaborationRestrictions {
+    is_used?: boolean;
+    value?: Array<string>;
+}
+export interface EnterpriseConfigurationContentAndSharingExternalCollaborationStatus {
+    is_used?: boolean;
+    value?: string | null;
+}
+export interface EnterpriseConfigurationContentAndSharingExternalCollaborationAllowlistUsers {
+    is_used?: boolean;
+    value?: Array<ListUser>;
+}
+export interface EnterpriseConfigurationSecurityLastPasswordResetAt {
+    is_used?: boolean;
+    value?: string | null;
+}
+export interface EnterpriseConfigurationSecurityExternalCollabMultiFactorAuthSettings {
+    is_used?: boolean;
+    value?: ExternalCollabSecuritySettings | null;
+}
+export interface EnterpriseConfigurationSecurityKeysafe {
+    is_used?: boolean;
+    value?: KeysafeSettings | null;
+}
+export interface EnterpriseConfigurationSecurityCustomSessionDurationGroups {
+    is_used?: boolean;
+    value?: Array<CustomSessionDurationGroupItem>;
+}
+export interface EnforcedMfaFrequencyValue {
+    days?: number | null;
+    hours?: number | null;
+}
+export interface EnterpriseConfigurationSecurityEnforcedMfaFrequency {
+    is_used?: boolean;
+    value?: EnforcedMfaFrequencyValue;
+}
+export interface EnterpriseConfigurationUserSettingsUserTrackingCodes {
+    is_used?: boolean;
+    value?: Array<UserTrackingCode>;
+}
+export interface EnterpriseFeatureSettingFeature {
+    id?: string | null;
+}
+export type ShieldRuleItemType = "shield_rule" | (string & {});
+export type ShieldRuleItemPriority = "informational" | "low" | "medium" | "high" | "critical" | (string & {});
+export type UserOrGroupReferenceType = "user" | "group" | (string & {});

package/dist/types/models/schemas/events.d.ts

@@ -0,0 +1,71 @@
+import type { AppItemType, EventSourceItemType, FolderMini, GroupMini, UserMini, UserNotificationEmail, UserStatus, VariableValueType } from '../schemas.js';
+export interface AppItemEventSource {
+    id: string;
+    type: AppItemType;
+    app_item_type: string;
+    user?: UserMini;
+    group?: GroupMini;
+}
+export interface Event {
+    type?: string;
+    created_at?: string;
+    recorded_at?: string;
+    event_id?: string;
+    created_by?: UserMini;
+    event_type?: EventEventType;
+    session_id?: string;
+    source?: EventSourceResource;
+    additional_details?: Record<string, unknown>;
+}
+export interface Events {
+    chunk_size?: number;
+    next_stream_position?: EventsNextStreamPosition;
+    entries?: Array<Event>;
+}
+export interface EventSource {
+    item_type: EventSourceItemType;
+    item_id: string;
+    item_name: string;
+    classification?: EventSourceClassification;
+    parent?: FolderMini | null;
+    owned_by?: UserMini;
+}
+export type EventSourceResource = unknown;
+export type GenericSource = Record<string, unknown>;
+export interface RealtimeServer {
+    type?: string;
+    url?: string;
+    ttl?: string;
+    max_retries?: string;
+    retry_timeout?: number;
+}
+export interface RealtimeServers {
+    chunk_size?: number;
+    entries?: Array<RealtimeServer>;
+}
+export interface User {
+    id: string;
+    type: VariableValueType;
+    name?: string;
+    login?: string;
+    created_at?: string;
+    modified_at?: string;
+    language?: string;
+    timezone?: string;
+    space_amount?: number;
+    space_used?: number;
+    max_upload_size?: number;
+    status?: UserStatus;
+    job_title?: string;
+    phone?: string;
+    address?: string;
+    avatar_url?: string;
+    notification_email?: UserNotificationEmail | null;
+}
+export type EventEventType = "ACCESS_GRANTED" | "ACCESS_REVOKED" | "ADD_DEVICE_ASSOCIATION" | "ADD_LOGIN_ACTIVITY_DEVICE" | "ADMIN_LOGIN" | "ADVANCED_FOLDER_SETTINGS_UPDATE" | "AI_SECURITY_DETECTION" | "ANNOTATIONV2_CREATE" | "ANNOTATIONV2_DELETE" | "ANNOTATIONV2_EDIT" | "APPLICATION_CREATED" | "APPLICATION_PUBLIC_KEY_ADDED" | "APPLICATION_PUBLIC_KEY_DELETED" | "BOX_AI_USER_FAILED_REQUEST" | "BOX_AI_USER_REQUEST" | "CHANGE_ADMIN_ROLE" | "CHANGE_FOLDER_PERMISSION" | "COLLABORATION_ACCEPT" | "COLLABORATION_EXPIRATION" | "COLLABORATION_INVITE" | "COLLABORATION_REMOVE" | "COLLABORATION_ROLE_CHANGE" | "COLLAB_ADD_COLLABORATOR" | "COLLAB_INVITE_COLLABORATOR" | "COLLAB_REMOVE_COLLABORATOR" | "COLLAB_ROLE_CHANGE" | "COLLECTION_CREATE" | "COLLECTION_DELETE" | "COLLECTION_ITEM_CREATE" | "COLLECTION_ITEM_DELETE" | "COLLECTION_ITEM_UPDATE" | "COLLECTION_UPDATE" | "COMMENT_CREATE" | "COMMENT_DELETE" | "COMMENT_EDIT" | "CONTENT_ACCESS" | "CONTENT_RECOVERY_REPORT_CREATE" | "CONTENT_RECOVERY_REPORT_DELETE" | "CONTENT_RECOVERY_REPORT_INITIATE" | "CONTENT_WORKFLOW_ABNORMAL_DOWNLOAD_ACTIVITY" | "CONTENT_WORKFLOW_AUTOMATION_ADD" | "CONTENT_WORKFLOW_AUTOMATION_DELETE" | "CONTENT_WORKFLOW_POLICY_ADD" | "CONTENT_WORKFLOW_SHARING_POLICY_VIOLATION" | "CONTENT_WORKFLOW_UPLOAD_POLICY_VIOLATION" | "COPY" | "DATA_RETENTION_CREATE_RETENTION" | "DATA_RETENTION_REMOVE_RETENTION" | "DELETE" | "DELETE_USER" | "DEVICE_TRUST_CHECK_FAILED" | "DISABLE_MULTI_FACTOR_AUTH" | "DOWNLOAD" | "EDIT" | "EDIT_USER" | "EDR_CROWDSTRIKE_ACCESS_ALLOWED_NO_CROWDSTRIKE_DEVICE" | "EDR_CROWDSTRIKE_ACCESS_REVOKED" | "EDR_CROWDSTRIKE_BOX_TOOLS_OUTDATED" | "EDR_CROWDSTRIKE_DEVICE_DETECTED" | "EDR_CROWDSTRIKE_DRIVE_OUTDATED" | "EDR_CROWDSTRIKE_NO_BOX_TOOLS" | "EMAIL_ALIAS_CONFIRM" | "EMAIL_ALIAS_PRIMARY" | "EMAIL_ALIAS_REMOVE" | "EMAIL_UPLOAD_DISABLED" | "EMAIL_UPLOAD_ENABLED" | "ENABLE_MULTI_FACTOR_AUTH" | "ENABLE_TWO_FACTOR_AUTH" | "ENTERPRISE_APP_AUTHORIZATION_UPDATE" | "EXTERNAL_COLLAB_SECURITY_SETTINGS" | "FAILED_LOGIN" | "FAVORITE" | "FILE_MARKED_MALICIOUS" | "FILE_REQUEST_CREATE" | "FILE_REQUEST_DELETE" | "FILE_REQUEST_UPDATE" | "FILE_VERSION_RESTORE" | "FILE_WATERMARKED_DOWNLOAD" | "GROUP_ADD_ITEM" | "GROUP_ADD_USER" | "GROUP_ADMIN_CREATED" | "GROUP_ADMIN_DELETED" | "GROUP_ADMIN_PERMISSIONS_UPDATED" | "GROUP_CREATION" | "GROUP_DELETION" | "GROUP_EDITED" | "GROUP_REMOVE_ITEM" | "GROUP_REMOVE_USER" | "ILLEGAL_ITEM_OWNERSHIP_TRANSFER_BY_USER" | "ITEM_ASSOCIATION_CREATED" | "ITEM_ASSOCIATION_DELETED" | "ITEM_ASSOCIATION_UPDATED" | "ITEM_COPY" | "ITEM_CREATE" | "ITEM_DOWNLOAD" | "ITEM_EMAIL_SEND" | "ITEM_MAKE_CURRENT_VERSION" | "ITEM_MODIFY" | "ITEM_MOVE" | "ITEM_OPEN" | "ITEM_PREVIEW" | "ITEM_RENAME" | "ITEM_SHARED" | "ITEM_SHARED_CREATE" | "ITEM_SHARED_UNSHARE" | "ITEM_SHARED_UPDATE" | "ITEM_SYNC" | "ITEM_TRASH" | "ITEM_UNDELETE_VIA_TRASH" | "ITEM_UNSYNC" | "ITEM_UPLOAD" | "LEGAL_HOLD_ASSIGNMENT_CREATE" | "LEGAL_HOLD_ASSIGNMENT_DELETE" | "LEGAL_HOLD_POLICY_CREATE" | "LEGAL_HOLD_POLICY_DELETE" | "LEGAL_HOLD_POLICY_UPDATE" | "LOCK" | "LOCK_CREATE" | "LOCK_DESTROY" | "LOGIN" | "MASTER_INVITE_ACCEPT" | "MASTER_INVITE_REJECT" | "METADATA_CASCADE_POLICY_APPLY" | "METADATA_CASCADE_POLICY_CREATE" | "METADATA_INSTANCE_COPY" | "METADATA_INSTANCE_CREATE" | "METADATA_INSTANCE_DELETE" | "METADATA_INSTANCE_UPDATE" | "METADATA_TEMPLATE_CREATE" | "METADATA_TEMPLATE_DELETE" | "METADATA_TEMPLATE_UPDATE" | "MOVE" | "NEW_USER" | "OAUTH2_ACCESS_TOKEN_REVOKE" | "OAUTH2_REFRESH_TOKEN_REVOKE" | "PREVIEW" | "REMOVE_DEVICE_ASSOCIATION" | "REMOVE_LOGIN_ACTIVITY_DEVICE" | "RENAME" | "RETENTION_POLICY_ASSIGNMENT_ADD" | "SHARE" | "SHARED_LINK_REDIRECT_OUT_OF_SHARED_CONTEXT" | "SHARED_LINK_SEND" | "SHARE_EXPIRATION" | "SHIELD_ACCESS_POLICY_CREATED" | "SHIELD_ACCESS_POLICY_DELETED" | "SHIELD_ACCESS_POLICY_UPDATED" | "SHIELD_ALERT" | "SHIELD_DOWNLOAD_BLOCKED" | "SHIELD_EXTERNAL_COLLAB_ACCESS_BLOCKED" | "SHIELD_EXTERNAL_COLLAB_ACCESS_BLOCKED_MISSING_JUSTIFICATION" | "SHIELD_EXTERNAL_COLLAB_INVITE_BLOCKED" | "SHIELD_EXTERNAL_COLLAB_INVITE_BLOCKED_MISSING_JUSTIFICATION" | "SHIELD_EXTERNAL_COLLAB_INVITE_JUSTIFIED" | "SHIELD_INFORMATION_BARRIER_COLLAB_BLOCKED" | "SHIELD_INFORMATION_BARRIER_DISABLED" | "SHIELD_INFORMATION_BARRIER_ENABLED" | "SHIELD_INFORMATION_BARRIER_GROUP_ADD_USER_BLOCKED" | "SHIELD_INFORMATION_BARRIER_ITEM_COPY_BLOCKED" | "SHIELD_INFORMATION_BARRIER_ITEM_MOVE_BLOCKED" | "SHIELD_INFORMATION_BARRIER_ITEM_OWNER_TRANSFER_BLOCKED" | "SHIELD_INFORMATION_BARRIER_PENDING" | "SHIELD_INFORMATION_BARRIER_SHARED_ITEM_ACCESS_BLOCKED" | "SHIELD_JUSTIFICATION_APPROVAL" | "SHIELD_PREVIEW_BLOCKED" | "SHIELD_SHARED_LINK_ACCESS_BLOCKED" | "SHIELD_SHARED_LINK_STATUS_RESTRICTED_ON_CREATE" | "SHIELD_SHARED_LINK_STATUS_RESTRICTED_ON_UPDATE" | "SIGN_DOCUMENT_ASSIGNED" | "SIGN_DOCUMENT_CANCELLED" | "SIGN_DOCUMENT_COMPLETED" | "SIGN_DOCUMENT_CONVERTED" | "SIGN_DOCUMENT_CREATED" | "SIGN_DOCUMENT_DECLINED" | "SIGN_DOCUMENT_EXPIRED" | "SIGN_DOCUMENT_SIGNED" | "SIGN_DOCUMENT_VIEWED_BY_SIGNED" | "SIGN_DOCUMENT_VIEWED_BY_SIGNER" | "SIGNER_DOWNLOADED" | "SIGNER_FORWARDED" | "STORAGE_EXPIRATION" | "TAG_ITEM_CREATE" | "TASK_ASSIGNMENT_CREATE" | "TASK_ASSIGNMENT_DELETE" | "TASK_ASSIGNMENT_UPDATE" | "TASK_CREATE" | "TASK_UPDATE" | "TERMS_OF_SERVICE_ACCEPT" | "TERMS_OF_SERVICE_REJECT" | "UNDELETE" | "UNFAVORITE" | "UNLOCK" | "UNSHARE" | "UPDATE_COLLABORATION_EXPIRATION" | "UPDATE_SHARE_EXPIRATION" | "UPLOAD" | "USER_AUTHENTICATE_OAUTH2_ACCESS_TOKEN_CREATE" | "WATERMARK_LABEL_CREATE" | "WATERMARK_LABEL_DELETE" | "WORKFLOW_AUTOMATION_CREATE" | "WORKFLOW_AUTOMATION_DELETE" | "WORKFLOW_AUTOMATION_UPDATE" | (string & {});
+export type EventsNextStreamPosition = unknown;
+export interface EventSourceClassification {
+    name?: string;
+}
+export type GetStreamType = "all" | "changes" | "sync" | "admin_logs" | "admin_logs_streaming" | (string & {});
+export type GetEventType = "ACCESS_GRANTED" | "ACCESS_REVOKED" | "ADD_DEVICE_ASSOCIATION" | "ADD_LOGIN_ACTIVITY_DEVICE" | "ADMIN_LOGIN" | "ADVANCED_FOLDER_SETTINGS_UPDATE" | "APPLICATION_CREATED" | "APPLICATION_PUBLIC_KEY_ADDED" | "APPLICATION_PUBLIC_KEY_DELETED" | "CHANGE_ADMIN_ROLE" | "CHANGE_FOLDER_PERMISSION" | "COLLABORATION_ACCEPT" | "COLLABORATION_EXPIRATION" | "COLLABORATION_INVITE" | "COLLABORATION_REMOVE" | "COLLABORATION_ROLE_CHANGE" | "COMMENT_CREATE" | "COMMENT_DELETE" | "COMMENT_EDIT" | "CONTENT_WORKFLOW_ABNORMAL_DOWNLOAD_ACTIVITY" | "CONTENT_WORKFLOW_AUTOMATION_ADD" | "CONTENT_WORKFLOW_AUTOMATION_DELETE" | "CONTENT_WORKFLOW_POLICY_ADD" | "CONTENT_WORKFLOW_SHARING_POLICY_VIOLATION" | "CONTENT_WORKFLOW_UPLOAD_POLICY_VIOLATION" | "COPY" | "DATA_RETENTION_CREATE_RETENTION" | "DATA_RETENTION_REMOVE_RETENTION" | "DELETE" | "DELETE_USER" | "DEVICE_TRUST_CHECK_FAILED" | "DOWNLOAD" | "EDIT" | "EDIT_USER" | "EMAIL_ALIAS_CONFIRM" | "EMAIL_ALIAS_PRIMARY" | "EMAIL_ALIAS_REMOVE" | "EMAIL_UPLOAD_DISABLED" | "EMAIL_UPLOAD_ENABLED" | "ENTERPRISE_APP_AUTHORIZATION_UPDATE" | "EXTERNAL_COLLAB_SECURITY_SETTINGS" | "FAILED_LOGIN" | "FAVORITE" | "FILE_MARKED_MALICIOUS" | "FILE_REQUEST_CREATE" | "FILE_REQUEST_DELETE" | "FILE_REQUEST_UPDATE" | "FILE_VERSION_RESTORE" | "FILE_WATERMARKED_DOWNLOAD" | "GROUP_ADD_ITEM" | "GROUP_ADD_USER" | "GROUP_CREATION" | "GROUP_DELETION" | "GROUP_EDITED" | "GROUP_REMOVE_ITEM" | "GROUP_REMOVE_USER" | "ILLEGAL_ITEM_OWNERSHIP_TRANSFER_BY_USER" | "ITEM_EMAIL_SEND" | "ITEM_MODIFY" | "ITEM_OPEN" | "ITEM_SHARED_UPDATE" | "ITEM_SYNC" | "ITEM_UNSYNC" | "LEGAL_HOLD_ASSIGNMENT_CREATE" | "LEGAL_HOLD_ASSIGNMENT_DELETE" | "LEGAL_HOLD_POLICY_CREATE" | "LEGAL_HOLD_POLICY_DELETE" | "LEGAL_HOLD_POLICY_UPDATE" | "LOCK" | "LOGIN" | "METADATA_CASCADE_POLICY_APPLY" | "METADATA_CASCADE_POLICY_CREATE" | "METADATA_INSTANCE_COPY" | "METADATA_INSTANCE_CREATE" | "METADATA_INSTANCE_DELETE" | "METADATA_INSTANCE_UPDATE" | "METADATA_TEMPLATE_CREATE" | "METADATA_TEMPLATE_DELETE" | "METADATA_TEMPLATE_UPDATE" | "MOVE" | "NEW_USER" | "OAUTH2_ACCESS_TOKEN_REVOKE" | "OAUTH2_REFRESH_TOKEN_REVOKE" | "PREVIEW" | "REMOVE_DEVICE_ASSOCIATION" | "REMOVE_LOGIN_ACTIVITY_DEVICE" | "RENAME" | "RETENTION_POLICY_ASSIGNMENT_ADD" | "SHARE" | "SHARED_LINK_SEND" | "SHARE_EXPIRATION" | "SHIELD_ALERT" | "SHIELD_DOWNLOAD_BLOCKED" | "SHIELD_EXTERNAL_COLLAB_ACCESS_BLOCKED" | "SHIELD_EXTERNAL_COLLAB_ACCESS_BLOCKED_MISSING_JUSTIFICATION" | "SHIELD_EXTERNAL_COLLAB_INVITE_BLOCKED" | "SHIELD_EXTERNAL_COLLAB_INVITE_BLOCKED_MISSING_JUSTIFICATION" | "SHIELD_JUSTIFICATION_APPROVAL" | "SHIELD_PREVIEW_BLOCKED" | "SHIELD_SHARED_LINK_ACCESS_BLOCKED" | "SHIELD_SHARED_LINK_STATUS_RESTRICTED_ON_CREATE" | "SHIELD_SHARED_LINK_STATUS_RESTRICTED_ON_UPDATE" | "SIGN_DOCUMENT_ASSIGNED" | "SIGN_DOCUMENT_CANCELLED" | "SIGN_DOCUMENT_COMPLETED" | "SIGN_DOCUMENT_CONVERTED" | "SIGN_DOCUMENT_CREATED" | "SIGN_DOCUMENT_DECLINED" | "SIGN_DOCUMENT_EXPIRED" | "SIGN_DOCUMENT_SIGNED" | "SIGN_DOCUMENT_VIEWED_BY_SIGNED" | "SIGNER_DOWNLOADED" | "SIGNER_FORWARDED" | "STORAGE_EXPIRATION" | "TASK_ASSIGNMENT_CREATE" | "TASK_ASSIGNMENT_DELETE" | "TASK_ASSIGNMENT_UPDATE" | "TASK_CREATE" | "TASK_UPDATE" | "TERMS_OF_SERVICE_ACCEPT" | "TERMS_OF_SERVICE_REJECT" | "UNDELETE" | "UNFAVORITE" | "UNLOCK" | "UNSHARE" | "UPDATE_COLLABORATION_EXPIRATION" | "UPDATE_SHARE_EXPIRATION" | "UPLOAD" | "USER_AUTHENTICATE_OAUTH2_ACCESS_TOKEN_CREATE" | "WATERMARK_LABEL_CREATE" | "WATERMARK_LABEL_DELETE" | "WORKFLOW_AUTOMATION_CREATE" | "WORKFLOW_AUTOMATION_DELETE" | "WORKFLOW_AUTOMATION_UPDATE" | (string & {});

package/dist/types/models/schemas/external_users.d.ts

@@ -0,0 +1,16 @@
+import type { HubCollaborationUserType } from '../schemas.js';
+export interface ExternalUserDeletionResult {
+    user_id: string;
+    status: number;
+    detail?: string;
+}
+export interface ExternalUsersSubmitDeleteJobRequest {
+    external_users: Array<UserReference>;
+}
+export interface ExternalUsersSubmitDeleteJobResponse {
+    entries: Array<ExternalUserDeletionResult>;
+}
+export interface UserReference {
+    type: HubCollaborationUserType;
+    id: string;
+}

package/dist/types/models/schemas/file_requests.d.ts

@@ -0,0 +1,41 @@
+import type { FolderMini, FolderType, UserMini } from '../schemas.js';
+export interface FileRequest {
+    id: string;
+    type: FileRequestType;
+    title?: string;
+    description?: string | null;
+    status?: FileRequestStatus;
+    is_email_required?: boolean;
+    is_description_required?: boolean;
+    expires_at?: string;
+    folder: FolderMini;
+    url?: string;
+    etag?: string | null;
+    created_by?: UserMini;
+    created_at: string;
+    updated_by?: UserMini;
+    updated_at: string;
+}
+export interface FileRequestCopyRequest {
+    title?: string;
+    description?: string;
+    status?: FileRequestStatus;
+    is_email_required?: boolean;
+    is_description_required?: boolean;
+    expires_at?: string;
+    folder: FileRequestCopyRequestFolder;
+}
+export interface FileRequestUpdateRequest {
+    title?: string;
+    description?: string;
+    status?: FileRequestStatus;
+    is_email_required?: boolean;
+    is_description_required?: boolean;
+    expires_at?: string;
+}
+export type FileRequestType = "file_request" | (string & {});
+export type FileRequestStatus = "active" | "inactive" | (string & {});
+export interface FileRequestCopyRequestFolder {
+    type?: FolderType;
+    id: string;
+}

package/dist/types/models/schemas/file_version_legal_holds.d.ts

@@ -0,0 +1,16 @@
+import type { FileMini, FileVersionMini, LegalHoldPolicyAssignment } from '../schemas.js';
+export interface FileVersionLegalHold {
+    id?: string;
+    type?: FileVersionLegalHoldType;
+    file_version?: FileVersionMini;
+    file?: FileMini;
+    legal_hold_policy_assignments?: Array<LegalHoldPolicyAssignment>;
+    deleted_at?: string;
+}
+export interface FileVersionLegalHolds {
+    limit?: number;
+    next_marker?: string | null;
+    prev_marker?: string | null;
+    entries?: Array<FileVersionLegalHold>;
+}
+export type FileVersionLegalHoldType = "file_version_legal_hold" | (string & {});

package/dist/types/models/schemas/file_version_retentions.d.ts

@@ -0,0 +1,17 @@
+import type { FileMini, FileVersionMini, RetentionPolicyMini } from '../schemas.js';
+export interface FileVersionRetention {
+    id?: string;
+    type?: FileVersionRetentionType;
+    file_version?: FileVersionMini;
+    file?: FileMini;
+    applied_at?: string;
+    disposition_at?: string;
+    winning_retention_policy?: RetentionPolicyMini;
+}
+export interface FileVersionRetentions {
+    limit?: number;
+    next_marker?: string | null;
+    prev_marker?: string | null;
+    entries?: Array<FileVersionRetention>;
+}
+export type FileVersionRetentionType = "file_version_retention" | (string & {});

package/dist/types/models/schemas/file_versions.d.ts

@@ -0,0 +1,32 @@
+import type { CollectionsOrder, FileVersionType, UserMini } from '../schemas.js';
+export interface FileVersionFull {
+    id: string;
+    type: FileVersionType;
+    sha1?: string;
+    name?: string;
+    size?: number;
+    created_at?: string;
+    modified_at?: string;
+    modified_by?: UserMini;
+    trashed_at?: string | null;
+    trashed_by?: UserMini;
+    restored_at?: string | null;
+    restored_by?: UserMini;
+    purged_at?: string | null;
+    uploader_display_name?: string;
+    version_number?: string;
+}
+export interface FileVersions {
+    total_count?: number;
+    limit?: number;
+    offset?: number;
+    order?: Array<CollectionsOrder>;
+    entries?: Array<FileVersionFull>;
+}
+export interface UpdateFileVersionRequest {
+    trashed_at?: string | null;
+}
+export interface CreateFileVersionCurrentRequest {
+    id?: string;
+    type?: FileVersionType;
+}