@unofficialbox/box-open-sdk 0.2.0 → 0.4.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/LICENSE +21 -0
- package/README.md +3 -1
- package/dist/cjs/auth.js +3 -3
- package/dist/cjs/buildinfo.js +2 -2
- package/dist/cjs/chunked_upload.js +108 -0
- package/dist/cjs/client.js +3 -0
- package/dist/cjs/index.js +3 -1
- package/dist/cjs/jwt.js +1 -1
- package/dist/cjs/managers/chunked_uploads.js +4 -4
- 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.js +1 -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/chunked_upload.js +104 -0
- package/dist/esm/client.js +3 -0
- package/dist/esm/index.js +1 -0
- package/dist/esm/jwt.js +1 -1
- package/dist/esm/managers/chunked_uploads.js +4 -4
- 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.js +1 -1
- 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/chunked_upload.d.ts +21 -0
- package/dist/types/client.d.ts +2 -0
- package/dist/types/index.d.ts +1 -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.d.ts +204 -141
- 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 +7 -7
- 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 +3 -3
|
@@ -152,7 +152,7 @@ export type AiExtractAgent = (AiAgentReference & {
|
|
|
152
152
|
export interface AiExtractFieldOption {
|
|
153
153
|
key: string;
|
|
154
154
|
}
|
|
155
|
-
export type AiExtractResponse = Record<string,
|
|
155
|
+
export type AiExtractResponse = Record<string, unknown>;
|
|
156
156
|
export interface AiExtractStructured {
|
|
157
157
|
items: Array<AiItemBase>;
|
|
158
158
|
metadata_template?: AiExtractStructuredMetadataTemplate;
|
|
@@ -779,6 +779,11 @@ export interface FileFull {
|
|
|
779
779
|
disposition_at?: string | null;
|
|
780
780
|
shared_link_permission_options?: Array<FileFullSharedLinkPermissionOptions> | null;
|
|
781
781
|
is_associated_with_app_item?: boolean;
|
|
782
|
+
collections?: Array<Collection>;
|
|
783
|
+
is_download_available?: boolean;
|
|
784
|
+
download_url?: string;
|
|
785
|
+
authenticated_download_url?: string;
|
|
786
|
+
allowed_shared_link_access_levels?: Array<SharedLinkAccess>;
|
|
782
787
|
}
|
|
783
788
|
export interface FileMini {
|
|
784
789
|
id: string;
|
|
@@ -999,6 +1004,7 @@ export interface FolderFull {
|
|
|
999
1004
|
can_non_owners_view_collaborators?: boolean;
|
|
1000
1005
|
classification?: FileFullClassification | null;
|
|
1001
1006
|
is_associated_with_app_item?: boolean;
|
|
1007
|
+
collections?: Array<Collection>;
|
|
1002
1008
|
}
|
|
1003
1009
|
export interface FolderMini {
|
|
1004
1010
|
id: string;
|
|
@@ -1025,7 +1031,7 @@ export interface FolderReference {
|
|
|
1025
1031
|
type: FolderType;
|
|
1026
1032
|
id: string;
|
|
1027
1033
|
}
|
|
1028
|
-
export type GenericSource = Record<string,
|
|
1034
|
+
export type GenericSource = Record<string, unknown>;
|
|
1029
1035
|
export interface Group {
|
|
1030
1036
|
id: string;
|
|
1031
1037
|
type: GroupType;
|
|
@@ -1816,7 +1822,7 @@ export interface SignRequestSignerInput {
|
|
|
1816
1822
|
content_type?: SignRequestSignerInputContentType;
|
|
1817
1823
|
page_index: number;
|
|
1818
1824
|
read_only?: boolean;
|
|
1819
|
-
validation?:
|
|
1825
|
+
validation?: SignRequestSignerInputValidation | null;
|
|
1820
1826
|
reason?: string | null;
|
|
1821
1827
|
is_validated?: boolean | null;
|
|
1822
1828
|
}
|
|
@@ -1992,7 +1998,7 @@ export interface TemplateSignerInput {
|
|
|
1992
1998
|
dimensions?: TemplateSignerInputDimensions;
|
|
1993
1999
|
label?: string | null;
|
|
1994
2000
|
read_only?: boolean;
|
|
1995
|
-
validation?:
|
|
2001
|
+
validation?: SignRequestSignerInputValidation | null;
|
|
1996
2002
|
}
|
|
1997
2003
|
export interface TermsOfService {
|
|
1998
2004
|
id: string;
|
|
@@ -2273,6 +2279,7 @@ export interface UserFull {
|
|
|
2273
2279
|
is_external_collab_restricted?: boolean;
|
|
2274
2280
|
is_exempt_from_device_limits?: boolean;
|
|
2275
2281
|
is_exempt_from_login_verification?: boolean;
|
|
2282
|
+
is_collaborated_content_available_when_owner_inactive?: boolean;
|
|
2276
2283
|
enterprise?: CollaborationAllowlistEntryEnterprise;
|
|
2277
2284
|
my_tags?: Array<string>;
|
|
2278
2285
|
hostname?: string;
|
|
@@ -2345,6 +2352,8 @@ export interface WebLink {
|
|
|
2345
2352
|
owned_by?: UserMini;
|
|
2346
2353
|
shared_link?: FileSharedLink | null;
|
|
2347
2354
|
item_status?: FileItemStatus;
|
|
2355
|
+
collections?: Array<Collection>;
|
|
2356
|
+
allowed_shared_link_access_levels?: Array<SharedLinkAccess>;
|
|
2348
2357
|
}
|
|
2349
2358
|
export interface WebLinkBase {
|
|
2350
2359
|
id: string;
|
|
@@ -2465,7 +2474,7 @@ export interface StaticConfigClassification {
|
|
|
2465
2474
|
export interface OptionsStaticConfig {
|
|
2466
2475
|
classification?: StaticConfigClassification;
|
|
2467
2476
|
}
|
|
2468
|
-
export interface
|
|
2477
|
+
export interface ClassificationTemplateFieldsOptions {
|
|
2469
2478
|
id: string;
|
|
2470
2479
|
key: string;
|
|
2471
2480
|
staticConfig?: OptionsStaticConfig;
|
|
@@ -2476,7 +2485,7 @@ export interface ClassificationTemplateFields {
|
|
|
2476
2485
|
key: FieldsKey;
|
|
2477
2486
|
displayName: ClassificationTemplateDisplayName;
|
|
2478
2487
|
hidden?: boolean;
|
|
2479
|
-
options: Array<
|
|
2488
|
+
options: Array<ClassificationTemplateFieldsOptions>;
|
|
2480
2489
|
}
|
|
2481
2490
|
export type ClientErrorType = "error" | (string & {});
|
|
2482
2491
|
export type ClientErrorCode = "created" | "accepted" | "no_content" | "redirect" | "not_modified" | "bad_request" | "unauthorized" | "forbidden" | "not_found" | "method_not_allowed" | "conflict" | "precondition_failed" | "too_many_requests" | "internal_server_error" | "unavailable" | "item_name_invalid" | "insufficient_scope" | (string & {});
|
|
@@ -2536,13 +2545,13 @@ export interface ConflictErrorContextInfo {
|
|
|
2536
2545
|
}
|
|
2537
2546
|
export type DevicePinnerType = "device_pinner" | (string & {});
|
|
2538
2547
|
export type OrderBy = "id" | (string & {});
|
|
2539
|
-
export type
|
|
2548
|
+
export type DevicePinnersOrderDirection = "asc" | "desc" | (string & {});
|
|
2540
2549
|
export interface DevicePinnersOrder {
|
|
2541
2550
|
by?: OrderBy;
|
|
2542
|
-
direction?:
|
|
2551
|
+
direction?: DevicePinnersOrderDirection;
|
|
2543
2552
|
}
|
|
2544
2553
|
export type EmailAliasType = "email_alias" | (string & {});
|
|
2545
|
-
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_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 & {});
|
|
2554
|
+
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 & {});
|
|
2546
2555
|
export type EventsNextStreamPosition = unknown;
|
|
2547
2556
|
export type EventSourceItemType = "file" | "folder" | (string & {});
|
|
2548
2557
|
export interface EventSourceClassification {
|
|
@@ -2738,8 +2747,8 @@ export interface MetadataQueryOrderBy {
|
|
|
2738
2747
|
field_key?: string;
|
|
2739
2748
|
direction?: OrderByDirection;
|
|
2740
2749
|
}
|
|
2741
|
-
export type
|
|
2742
|
-
export interface
|
|
2750
|
+
export type MetadataTemplateFieldsType = "string" | "float" | "date" | "enum" | "multiSelect" | "taxonomy" | "integer" | (string & {});
|
|
2751
|
+
export interface MetadataTemplateFieldsOptions {
|
|
2743
2752
|
key: string;
|
|
2744
2753
|
id?: string;
|
|
2745
2754
|
}
|
|
@@ -2748,12 +2757,12 @@ export interface FieldsOptionsRules {
|
|
|
2748
2757
|
selectableLevels?: Array<number>;
|
|
2749
2758
|
}
|
|
2750
2759
|
export interface MetadataTemplateFields {
|
|
2751
|
-
type:
|
|
2760
|
+
type: MetadataTemplateFieldsType;
|
|
2752
2761
|
key: string;
|
|
2753
2762
|
displayName: string;
|
|
2754
2763
|
description?: string;
|
|
2755
2764
|
hidden?: boolean;
|
|
2756
|
-
options?: Array<
|
|
2765
|
+
options?: Array<MetadataTemplateFieldsOptions>;
|
|
2757
2766
|
taxonomyKey?: string;
|
|
2758
2767
|
taxonomyId?: string;
|
|
2759
2768
|
namespace?: string;
|
|
@@ -2820,7 +2829,6 @@ export interface SignRequestSignerSignerDecision {
|
|
|
2820
2829
|
}
|
|
2821
2830
|
export type SignRequestSignerInputType = "signature" | "date" | "text" | "checkbox" | "radio" | "dropdown" | (string & {});
|
|
2822
2831
|
export type SignRequestSignerInputContentType = "signature" | "initial" | "stamp" | "date" | "checkbox" | "text" | "full_name" | "first_name" | "last_name" | "company" | "title" | "email" | "attachment" | "radio" | "dropdown" | (string & {});
|
|
2823
|
-
export type SignRequestSignerInputValidation2 = unknown;
|
|
2824
2832
|
export type SignRequestSignerInputCustomValidationValidationType = "custom" | (string & {});
|
|
2825
2833
|
export type SignRequestSignerInputDateAsiaValidationValidationType = "date_asia" | (string & {});
|
|
2826
2834
|
export type SignRequestSignerInputDateEUValidationValidationType = "date_eu" | (string & {});
|
|
@@ -2893,12 +2901,12 @@ export interface TimelineSkillCardEntries {
|
|
|
2893
2901
|
}
|
|
2894
2902
|
export type TrackingCodeType = "tracking_code" | (string & {});
|
|
2895
2903
|
export type TranscriptSkillCardSkillCardType = "transcript" | (string & {});
|
|
2896
|
-
export interface
|
|
2904
|
+
export interface TranscriptSkillCardEntriesAppears {
|
|
2897
2905
|
start?: number;
|
|
2898
2906
|
}
|
|
2899
2907
|
export interface TranscriptSkillCardEntries {
|
|
2900
2908
|
text?: string;
|
|
2901
|
-
appears?: Array<
|
|
2909
|
+
appears?: Array<TranscriptSkillCardEntriesAppears>;
|
|
2902
2910
|
}
|
|
2903
2911
|
export interface PathCollectionEntries {
|
|
2904
2912
|
type?: FolderType;
|
|
@@ -2996,7 +3004,7 @@ export interface PutIdParent {
|
|
|
2996
3004
|
id?: string;
|
|
2997
3005
|
user_id?: string;
|
|
2998
3006
|
}
|
|
2999
|
-
export interface
|
|
3007
|
+
export interface UpdateFileRequestSharedLinkPermissions {
|
|
3000
3008
|
can_download?: boolean;
|
|
3001
3009
|
}
|
|
3002
3010
|
export interface PutIdSharedLink {
|
|
@@ -3004,7 +3012,7 @@ export interface PutIdSharedLink {
|
|
|
3004
3012
|
password?: string | null;
|
|
3005
3013
|
vanity_name?: string;
|
|
3006
3014
|
unshared_at?: string;
|
|
3007
|
-
permissions?:
|
|
3015
|
+
permissions?: UpdateFileRequestSharedLinkPermissions;
|
|
3008
3016
|
}
|
|
3009
3017
|
export interface PutIdLock {
|
|
3010
3018
|
access?: LockType;
|
|
@@ -3015,7 +3023,7 @@ export type PermissionsCanDownload = "open" | "company" | (string & {});
|
|
|
3015
3023
|
export interface PutIdPermissions {
|
|
3016
3024
|
can_download?: PermissionsCanDownload;
|
|
3017
3025
|
}
|
|
3018
|
-
export interface
|
|
3026
|
+
export interface UpdateFileRequest {
|
|
3019
3027
|
name?: string;
|
|
3020
3028
|
description?: string;
|
|
3021
3029
|
parent?: PutIdParent;
|
|
@@ -3029,7 +3037,7 @@ export interface FileUpdateRequest {
|
|
|
3029
3037
|
export interface PostFileIdParent {
|
|
3030
3038
|
id?: string;
|
|
3031
3039
|
}
|
|
3032
|
-
export interface
|
|
3040
|
+
export interface CreateFileRequest {
|
|
3033
3041
|
name?: string;
|
|
3034
3042
|
parent?: PostFileIdParent;
|
|
3035
3043
|
}
|
|
@@ -3037,7 +3045,7 @@ export interface PostFileIdContentAttributes {
|
|
|
3037
3045
|
name: string;
|
|
3038
3046
|
content_modified_at?: string;
|
|
3039
3047
|
}
|
|
3040
|
-
export interface
|
|
3048
|
+
export interface CreateFileIdContentRequest {
|
|
3041
3049
|
attributes: PostFileIdContentAttributes;
|
|
3042
3050
|
file: Blob;
|
|
3043
3051
|
}
|
|
@@ -3050,7 +3058,7 @@ export interface PostFileContentAttributes {
|
|
|
3050
3058
|
content_created_at?: string;
|
|
3051
3059
|
content_modified_at?: string;
|
|
3052
3060
|
}
|
|
3053
|
-
export interface
|
|
3061
|
+
export interface CreateFileContentRequest {
|
|
3054
3062
|
attributes: PostFileContentAttributes;
|
|
3055
3063
|
file: Blob;
|
|
3056
3064
|
}
|
|
@@ -3059,69 +3067,69 @@ export interface OptionFileContentRequest {
|
|
|
3059
3067
|
size?: number;
|
|
3060
3068
|
parent?: PostFileIdParent;
|
|
3061
3069
|
}
|
|
3062
|
-
export interface
|
|
3070
|
+
export interface CreateFileUploadSessionRequest {
|
|
3063
3071
|
folder_id: string;
|
|
3064
3072
|
file_size: number;
|
|
3065
3073
|
file_name: string;
|
|
3066
3074
|
}
|
|
3067
|
-
export interface
|
|
3075
|
+
export interface CreateFileVersionUploadSessionRequest {
|
|
3068
3076
|
file_size: number;
|
|
3069
3077
|
file_name?: string;
|
|
3070
3078
|
}
|
|
3071
|
-
export interface
|
|
3079
|
+
export interface CommitFileUploadSessionRequest {
|
|
3072
3080
|
parts: Array<UploadPart>;
|
|
3073
3081
|
}
|
|
3074
|
-
export interface
|
|
3082
|
+
export interface CopyFileRequest {
|
|
3075
3083
|
name?: string;
|
|
3076
3084
|
version?: string;
|
|
3077
3085
|
parent: AttributesParent;
|
|
3078
3086
|
}
|
|
3079
3087
|
export type GetIdThumbnailIdExtension = "png" | "jpg" | (string & {});
|
|
3080
|
-
export interface
|
|
3088
|
+
export interface UpdateFileVersionRequest {
|
|
3081
3089
|
trashed_at?: string | null;
|
|
3082
3090
|
}
|
|
3083
|
-
export interface
|
|
3091
|
+
export interface CreateFileVersionCurrentRequest {
|
|
3084
3092
|
id?: string;
|
|
3085
3093
|
type?: FileVersionType;
|
|
3086
3094
|
}
|
|
3087
3095
|
export type PutOp = "replace" | (string & {});
|
|
3088
3096
|
export type PutPath = "/Box__Security__Classification__Key" | (string & {});
|
|
3089
|
-
export interface
|
|
3097
|
+
export interface UpdateFileClassificationRequest {
|
|
3090
3098
|
op: PutOp;
|
|
3091
3099
|
path: PutPath;
|
|
3092
3100
|
value: string;
|
|
3093
3101
|
}
|
|
3094
|
-
export interface
|
|
3102
|
+
export interface CreateFileClassificationRequest {
|
|
3095
3103
|
Box__Security__Classification__Key?: string;
|
|
3096
3104
|
}
|
|
3097
|
-
export type
|
|
3098
|
-
export type
|
|
3099
|
-
export interface
|
|
3100
|
-
op?:
|
|
3105
|
+
export type GetFileIdMetadataIdScope = "global" | "enterprise" | (string & {});
|
|
3106
|
+
export type PutFileIdMetadataIdOp = "add" | "replace" | "remove" | "test" | "move" | "copy" | (string & {});
|
|
3107
|
+
export interface UpdateFileMetadataRequest {
|
|
3108
|
+
op?: PutFileIdMetadataIdOp;
|
|
3101
3109
|
path?: string;
|
|
3102
3110
|
value?: MetadataInstanceValue;
|
|
3103
3111
|
from?: string;
|
|
3104
3112
|
}
|
|
3105
|
-
export interface
|
|
3113
|
+
export interface UpdateSkillRequest {
|
|
3106
3114
|
op?: PutOp;
|
|
3107
3115
|
path?: string;
|
|
3108
3116
|
value?: SkillCard;
|
|
3109
3117
|
}
|
|
3110
|
-
export interface
|
|
3118
|
+
export interface CreateSkillRequest {
|
|
3111
3119
|
cards: Array<SkillCard>;
|
|
3112
3120
|
}
|
|
3113
3121
|
export type WatermarkImprint = "default" | (string & {});
|
|
3114
3122
|
export interface PutFileIdWatermarkWatermark {
|
|
3115
3123
|
imprint: WatermarkImprint;
|
|
3116
3124
|
}
|
|
3117
|
-
export interface
|
|
3125
|
+
export interface UpdateFileWatermarkRequest {
|
|
3118
3126
|
watermark: PutFileIdWatermarkWatermark;
|
|
3119
3127
|
}
|
|
3120
3128
|
export type GetIdSort = "id" | "name" | "date" | "size" | (string & {});
|
|
3121
3129
|
export interface PutIdFolderUploadEmail {
|
|
3122
3130
|
access?: FolderUploadEmailAccess;
|
|
3123
3131
|
}
|
|
3124
|
-
export interface
|
|
3132
|
+
export interface UpdateFolderRequest {
|
|
3125
3133
|
name?: string;
|
|
3126
3134
|
description?: string;
|
|
3127
3135
|
sync_state?: FolderFullSyncState;
|
|
@@ -3134,13 +3142,13 @@ export interface FolderUpdateRequest {
|
|
|
3134
3142
|
collections?: Array<CommentItem> | null;
|
|
3135
3143
|
can_non_owners_view_collaborators?: boolean;
|
|
3136
3144
|
}
|
|
3137
|
-
export interface
|
|
3145
|
+
export interface CreateFolderRequest {
|
|
3138
3146
|
name: string;
|
|
3139
3147
|
parent: AttributesParent;
|
|
3140
3148
|
folder_upload_email?: PutIdFolderUploadEmail;
|
|
3141
3149
|
sync_state?: FolderFullSyncState;
|
|
3142
3150
|
}
|
|
3143
|
-
export interface
|
|
3151
|
+
export interface CopyFolderRequest {
|
|
3144
3152
|
name?: string;
|
|
3145
3153
|
parent: AttributesParent;
|
|
3146
3154
|
}
|
|
@@ -3149,7 +3157,7 @@ export interface PostFolder {
|
|
|
3149
3157
|
type: string;
|
|
3150
3158
|
id: string;
|
|
3151
3159
|
}
|
|
3152
|
-
export interface
|
|
3160
|
+
export interface CreateFolderLockRequest {
|
|
3153
3161
|
locked_operations?: FolderLockLockedOperations;
|
|
3154
3162
|
folder: PostFolder;
|
|
3155
3163
|
}
|
|
@@ -3158,21 +3166,21 @@ export interface PutAddData {
|
|
|
3158
3166
|
key: string;
|
|
3159
3167
|
staticConfig?: OptionsStaticConfig;
|
|
3160
3168
|
}
|
|
3161
|
-
export interface
|
|
3169
|
+
export interface UpdateClassificationAddRequest {
|
|
3162
3170
|
op: PutAddOp;
|
|
3163
3171
|
fieldKey: FieldsKey;
|
|
3164
3172
|
data: PutAddData;
|
|
3165
3173
|
}
|
|
3166
3174
|
export type PutUpdateOp = "editEnumOption" | (string & {});
|
|
3167
|
-
export interface
|
|
3175
|
+
export interface UpdateClassificationUpdateRequest {
|
|
3168
3176
|
op: PutUpdateOp;
|
|
3169
3177
|
fieldKey: FieldsKey;
|
|
3170
3178
|
enumOptionKey: string;
|
|
3171
3179
|
data: PutAddData;
|
|
3172
3180
|
}
|
|
3173
|
-
export type
|
|
3174
|
-
export interface
|
|
3175
|
-
op:
|
|
3181
|
+
export type PutIdSchemaOp = "editTemplate" | "addField" | "reorderFields" | "addEnumOption" | "reorderEnumOptions" | "reorderMultiSelectOptions" | "addMultiSelectOption" | "editField" | "removeField" | "editEnumOption" | "removeEnumOption" | "editMultiSelectOption" | "removeMultiSelectOption" | (string & {});
|
|
3182
|
+
export interface UpdateSchemaRequest {
|
|
3183
|
+
op: PutIdSchemaOp;
|
|
3176
3184
|
data?: Record<string, unknown>;
|
|
3177
3185
|
fieldKey?: string;
|
|
3178
3186
|
fieldKeys?: Array<string>;
|
|
@@ -3181,9 +3189,9 @@ export interface SchemaUpdateRequest {
|
|
|
3181
3189
|
multiSelectOptionKey?: string;
|
|
3182
3190
|
multiSelectOptionKeys?: Array<string>;
|
|
3183
3191
|
}
|
|
3184
|
-
export type
|
|
3192
|
+
export type CreateSchemaRequestFieldsType = "string" | "float" | "date" | "enum" | "multiSelect" | "taxonomy" | (string & {});
|
|
3185
3193
|
export interface PostSchemaFields {
|
|
3186
|
-
type:
|
|
3194
|
+
type: CreateSchemaRequestFieldsType;
|
|
3187
3195
|
key: string;
|
|
3188
3196
|
displayName: string;
|
|
3189
3197
|
description?: string;
|
|
@@ -3194,7 +3202,7 @@ export interface PostSchemaFields {
|
|
|
3194
3202
|
namespace?: string;
|
|
3195
3203
|
optionsRules?: FieldsOptionsRules;
|
|
3196
3204
|
}
|
|
3197
|
-
export interface
|
|
3205
|
+
export interface CreateSchemaRequest {
|
|
3198
3206
|
scope: string;
|
|
3199
3207
|
templateKey?: string;
|
|
3200
3208
|
displayName: string;
|
|
@@ -3209,7 +3217,7 @@ export interface PostMetadataTemplateSchemaClassificationsFields {
|
|
|
3209
3217
|
hidden?: boolean;
|
|
3210
3218
|
options: Array<PutAddData>;
|
|
3211
3219
|
}
|
|
3212
|
-
export interface
|
|
3220
|
+
export interface CreateMetadataTemplateSchemaClassificationsRequest {
|
|
3213
3221
|
scope: EnterpriseType;
|
|
3214
3222
|
templateKey: ClassificationTemplate2;
|
|
3215
3223
|
displayName: ClassificationTemplateDisplayName;
|
|
@@ -3217,16 +3225,16 @@ export interface MetadataTemplateSchemaCreateRequest {
|
|
|
3217
3225
|
copyInstanceOnItemCopy?: boolean;
|
|
3218
3226
|
fields: Array<PostMetadataTemplateSchemaClassificationsFields>;
|
|
3219
3227
|
}
|
|
3220
|
-
export interface
|
|
3228
|
+
export interface CreateMetadataCascadePolicyRequest {
|
|
3221
3229
|
folder_id: string;
|
|
3222
|
-
scope:
|
|
3230
|
+
scope: GetFileIdMetadataIdScope;
|
|
3223
3231
|
templateKey: string;
|
|
3224
3232
|
}
|
|
3225
3233
|
export type PostIdApplyConflictResolution = "none" | "overwrite" | (string & {});
|
|
3226
|
-
export interface
|
|
3234
|
+
export interface ApplyMetadataCascadePolicyRequest {
|
|
3227
3235
|
conflict_resolution: PostIdApplyConflictResolution;
|
|
3228
3236
|
}
|
|
3229
|
-
export interface
|
|
3237
|
+
export interface UpdateCommentRequest {
|
|
3230
3238
|
message?: string;
|
|
3231
3239
|
}
|
|
3232
3240
|
export type ItemType = "file" | "comment" | (string & {});
|
|
@@ -3234,13 +3242,13 @@ export interface PostItem {
|
|
|
3234
3242
|
id: string;
|
|
3235
3243
|
type: ItemType;
|
|
3236
3244
|
}
|
|
3237
|
-
export interface
|
|
3245
|
+
export interface CreateCommentRequest {
|
|
3238
3246
|
message: string;
|
|
3239
3247
|
tagged_message?: string;
|
|
3240
3248
|
item: PostItem;
|
|
3241
3249
|
}
|
|
3242
3250
|
export type PutCollaborationIdStatus = "pending" | "accepted" | "rejected" | (string & {});
|
|
3243
|
-
export interface
|
|
3251
|
+
export interface UpdateCollaborationRequest {
|
|
3244
3252
|
role?: CollaborationRole;
|
|
3245
3253
|
status?: PutCollaborationIdStatus;
|
|
3246
3254
|
expires_at?: string;
|
|
@@ -3257,7 +3265,7 @@ export interface PostCollaborationsAccessibleBy {
|
|
|
3257
3265
|
id?: string;
|
|
3258
3266
|
login?: string;
|
|
3259
3267
|
}
|
|
3260
|
-
export interface
|
|
3268
|
+
export interface CreateCollaborationsRequest {
|
|
3261
3269
|
item: PostCollaborationsItem;
|
|
3262
3270
|
accessible_by: PostCollaborationsAccessibleBy;
|
|
3263
3271
|
role: FileFullAllowedInviteeRoles;
|
|
@@ -3271,18 +3279,18 @@ export type GetType = "file" | "folder" | "web_link" | (string & {});
|
|
|
3271
3279
|
export type GetTrashContent = "non_trashed_only" | "trashed_only" | "all_items" | (string & {});
|
|
3272
3280
|
export type GetSort = "modified_at" | "relevance" | (string & {});
|
|
3273
3281
|
export type GetDirection = "DESC" | "ASC" | (string & {});
|
|
3274
|
-
export interface
|
|
3282
|
+
export interface CreateTaskRequestItem {
|
|
3275
3283
|
id?: string;
|
|
3276
3284
|
type?: AiCitationType;
|
|
3277
3285
|
}
|
|
3278
|
-
export interface
|
|
3279
|
-
item:
|
|
3286
|
+
export interface CreateTaskRequest {
|
|
3287
|
+
item: CreateTaskRequestItem;
|
|
3280
3288
|
action?: TaskAction;
|
|
3281
3289
|
message?: string;
|
|
3282
3290
|
due_at?: string;
|
|
3283
3291
|
completion_rule?: TaskCompletionRule;
|
|
3284
3292
|
}
|
|
3285
|
-
export interface
|
|
3293
|
+
export interface UpdateTaskRequest {
|
|
3286
3294
|
action?: TaskAction;
|
|
3287
3295
|
message?: string;
|
|
3288
3296
|
due_at?: string;
|
|
@@ -3296,15 +3304,15 @@ export interface PostAssignTo {
|
|
|
3296
3304
|
id?: string;
|
|
3297
3305
|
login?: string;
|
|
3298
3306
|
}
|
|
3299
|
-
export interface
|
|
3307
|
+
export interface CreateTaskAssignmentRequest {
|
|
3300
3308
|
task: PostTask;
|
|
3301
3309
|
assign_to: PostAssignTo;
|
|
3302
3310
|
}
|
|
3303
|
-
export interface
|
|
3311
|
+
export interface UpdateTaskAssignmentRequest {
|
|
3304
3312
|
message?: string;
|
|
3305
3313
|
resolution_state?: TaskAssignmentResolutionState;
|
|
3306
3314
|
}
|
|
3307
|
-
export interface
|
|
3315
|
+
export interface UpdateFileAddSharedLinkRequestSharedLinkPermissions {
|
|
3308
3316
|
can_download?: boolean;
|
|
3309
3317
|
can_preview?: boolean;
|
|
3310
3318
|
can_edit?: boolean;
|
|
@@ -3314,12 +3322,12 @@ export interface PutFileIdAddSharedLinkSharedLink {
|
|
|
3314
3322
|
password?: string | null;
|
|
3315
3323
|
vanity_name?: string;
|
|
3316
3324
|
unshared_at?: string;
|
|
3317
|
-
permissions?:
|
|
3325
|
+
permissions?: UpdateFileAddSharedLinkRequestSharedLinkPermissions;
|
|
3318
3326
|
}
|
|
3319
|
-
export interface
|
|
3327
|
+
export interface UpdateFileAddSharedLinkRequest {
|
|
3320
3328
|
shared_link?: PutFileIdAddSharedLinkSharedLink;
|
|
3321
3329
|
}
|
|
3322
|
-
export interface
|
|
3330
|
+
export interface UpdateFileRemoveSharedLinkRequest {
|
|
3323
3331
|
shared_link?: Record<string, unknown> | null;
|
|
3324
3332
|
}
|
|
3325
3333
|
export interface PutFolderIdUpdateSharedLinkSharedLink {
|
|
@@ -3327,33 +3335,33 @@ export interface PutFolderIdUpdateSharedLinkSharedLink {
|
|
|
3327
3335
|
password?: string;
|
|
3328
3336
|
vanity_name?: string;
|
|
3329
3337
|
unshared_at?: string;
|
|
3330
|
-
permissions?:
|
|
3338
|
+
permissions?: UpdateFileAddSharedLinkRequestSharedLinkPermissions;
|
|
3331
3339
|
}
|
|
3332
|
-
export interface
|
|
3340
|
+
export interface UpdateFolderUpdateSharedLinkRequest {
|
|
3333
3341
|
shared_link?: PutFolderIdUpdateSharedLinkSharedLink;
|
|
3334
3342
|
}
|
|
3335
|
-
export interface
|
|
3343
|
+
export interface CreateWebLinkRequest {
|
|
3336
3344
|
url: string;
|
|
3337
3345
|
parent: AttributesParent;
|
|
3338
3346
|
name?: string;
|
|
3339
3347
|
description?: string;
|
|
3340
3348
|
}
|
|
3341
|
-
export interface
|
|
3349
|
+
export interface UpdateWebLinkRequestSharedLink {
|
|
3342
3350
|
access?: SharedLinkAccess;
|
|
3343
3351
|
password?: string | null;
|
|
3344
3352
|
vanity_name?: string;
|
|
3345
3353
|
unshared_at?: string;
|
|
3346
3354
|
}
|
|
3347
|
-
export interface
|
|
3355
|
+
export interface UpdateWebLinkRequest {
|
|
3348
3356
|
url?: string;
|
|
3349
3357
|
parent?: PutIdParent;
|
|
3350
3358
|
name?: string;
|
|
3351
3359
|
description?: string;
|
|
3352
|
-
shared_link?:
|
|
3360
|
+
shared_link?: UpdateWebLinkRequestSharedLink;
|
|
3353
3361
|
}
|
|
3354
3362
|
export type GetUserType = "all" | "managed" | "external" | (string & {});
|
|
3355
3363
|
export type PostRole = "coadmin" | "user" | (string & {});
|
|
3356
|
-
export interface
|
|
3364
|
+
export interface CreateUserRequest {
|
|
3357
3365
|
name: string;
|
|
3358
3366
|
login?: string;
|
|
3359
3367
|
is_platform_access_only?: boolean;
|
|
@@ -3373,14 +3381,14 @@ export interface UserCreateRequest {
|
|
|
3373
3381
|
status?: UserStatus;
|
|
3374
3382
|
external_app_user_id?: string;
|
|
3375
3383
|
}
|
|
3376
|
-
export interface
|
|
3384
|
+
export interface CreateUserTerminateSessionsRequest {
|
|
3377
3385
|
user_ids: Array<string>;
|
|
3378
3386
|
user_logins: Array<string>;
|
|
3379
3387
|
}
|
|
3380
3388
|
export interface PutIdNotificationEmail {
|
|
3381
3389
|
email?: string;
|
|
3382
3390
|
}
|
|
3383
|
-
export interface
|
|
3391
|
+
export interface UpdateUserRequest {
|
|
3384
3392
|
enterprise?: string | null;
|
|
3385
3393
|
notify?: boolean;
|
|
3386
3394
|
name?: string;
|
|
@@ -3398,28 +3406,29 @@ export interface UserUpdateRequest {
|
|
|
3398
3406
|
is_exempt_from_device_limits?: boolean;
|
|
3399
3407
|
is_exempt_from_login_verification?: boolean;
|
|
3400
3408
|
is_password_reset_required?: boolean;
|
|
3409
|
+
is_collaborated_content_available_when_owner_inactive?: boolean;
|
|
3401
3410
|
status?: UserStatus;
|
|
3402
3411
|
space_amount?: number;
|
|
3403
3412
|
notification_email?: PutIdNotificationEmail | null;
|
|
3404
3413
|
external_app_user_id?: string;
|
|
3405
3414
|
}
|
|
3406
|
-
export interface
|
|
3415
|
+
export interface CreateUserAvatarRequest {
|
|
3407
3416
|
pic: Blob;
|
|
3408
3417
|
}
|
|
3409
|
-
export interface
|
|
3418
|
+
export interface TransferFoldersRequest {
|
|
3410
3419
|
owned_by: AttributesParent;
|
|
3411
3420
|
}
|
|
3412
|
-
export interface
|
|
3421
|
+
export interface CreateUserIdRequest {
|
|
3413
3422
|
email: string;
|
|
3414
3423
|
}
|
|
3415
3424
|
export interface PostActionableBy {
|
|
3416
3425
|
login?: string;
|
|
3417
3426
|
}
|
|
3418
|
-
export interface
|
|
3427
|
+
export interface CreateInviteRequest {
|
|
3419
3428
|
enterprise: AttributesParent;
|
|
3420
3429
|
actionable_by: PostActionableBy;
|
|
3421
3430
|
}
|
|
3422
|
-
export interface
|
|
3431
|
+
export interface CreateGroupRequest {
|
|
3423
3432
|
name: string;
|
|
3424
3433
|
provenance?: string;
|
|
3425
3434
|
external_sync_identifier?: string;
|
|
@@ -3427,10 +3436,10 @@ export interface GroupCreateRequest {
|
|
|
3427
3436
|
invitability_level?: GroupFullInvitabilityLevel;
|
|
3428
3437
|
member_viewability_level?: GroupFullInvitabilityLevel;
|
|
3429
3438
|
}
|
|
3430
|
-
export interface
|
|
3439
|
+
export interface CreateGroupTerminateSessionsRequest {
|
|
3431
3440
|
group_ids: Array<string>;
|
|
3432
3441
|
}
|
|
3433
|
-
export interface
|
|
3442
|
+
export interface UpdateGroupRequest {
|
|
3434
3443
|
name?: string;
|
|
3435
3444
|
provenance?: string;
|
|
3436
3445
|
external_sync_identifier?: string;
|
|
@@ -3438,22 +3447,22 @@ export interface GroupUpdateRequest {
|
|
|
3438
3447
|
invitability_level?: GroupFullInvitabilityLevel;
|
|
3439
3448
|
member_viewability_level?: GroupFullInvitabilityLevel;
|
|
3440
3449
|
}
|
|
3441
|
-
export interface
|
|
3450
|
+
export interface CreateGroupMembershipRequest {
|
|
3442
3451
|
user: AttributesParent;
|
|
3443
3452
|
group: AttributesParent;
|
|
3444
3453
|
role?: GroupMembershipRole;
|
|
3445
3454
|
configurable_permissions?: Record<string, boolean> | null;
|
|
3446
3455
|
}
|
|
3447
|
-
export interface
|
|
3456
|
+
export interface UpdateGroupMembershipRequest {
|
|
3448
3457
|
role?: GroupMembershipRole;
|
|
3449
3458
|
configurable_permissions?: Record<string, boolean> | null;
|
|
3450
3459
|
}
|
|
3451
|
-
export interface
|
|
3460
|
+
export interface CreateWebhookRequest {
|
|
3452
3461
|
target: WebhookTarget;
|
|
3453
3462
|
address: string;
|
|
3454
3463
|
triggers: Array<WebhookTriggers>;
|
|
3455
3464
|
}
|
|
3456
|
-
export interface
|
|
3465
|
+
export interface UpdateWebhookRequest {
|
|
3457
3466
|
target?: WebhookTarget;
|
|
3458
3467
|
address?: string;
|
|
3459
3468
|
triggers?: Array<WebhookTriggers>;
|
|
@@ -3473,7 +3482,7 @@ export interface PutSkillInvocationIdUsage {
|
|
|
3473
3482
|
unit?: string;
|
|
3474
3483
|
value?: number;
|
|
3475
3484
|
}
|
|
3476
|
-
export interface
|
|
3485
|
+
export interface UpdateSkillInvocationRequest {
|
|
3477
3486
|
status: StatusCode;
|
|
3478
3487
|
metadata: PutSkillInvocationIdMetadata;
|
|
3479
3488
|
file: PutSkillInvocationIdFile;
|
|
@@ -3481,9 +3490,9 @@ export interface SkillInvocationUpdateRequest {
|
|
|
3481
3490
|
usage?: PutSkillInvocationIdUsage;
|
|
3482
3491
|
}
|
|
3483
3492
|
export type GetStreamType = "all" | "changes" | "sync" | "admin_logs" | "admin_logs_streaming" | (string & {});
|
|
3484
|
-
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_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_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 & {});
|
|
3493
|
+
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 & {});
|
|
3485
3494
|
export type PostRetentionLength = unknown;
|
|
3486
|
-
export interface
|
|
3495
|
+
export interface CreateRetentionPolicyRequest {
|
|
3487
3496
|
policy_name: string;
|
|
3488
3497
|
description?: string;
|
|
3489
3498
|
policy_type: RetentionPolicyPolicyType;
|
|
@@ -3496,7 +3505,7 @@ export interface RetentionPolicyCreateRequest {
|
|
|
3496
3505
|
custom_notification_recipients?: Array<UserMini>;
|
|
3497
3506
|
}
|
|
3498
3507
|
export type PutIdDispositionAction = unknown;
|
|
3499
|
-
export interface
|
|
3508
|
+
export interface UpdateRetentionPolicyRequest {
|
|
3500
3509
|
policy_name?: string | null;
|
|
3501
3510
|
description?: string | null;
|
|
3502
3511
|
disposition_action?: PutIdDispositionAction;
|
|
@@ -3509,7 +3518,7 @@ export interface RetentionPolicyUpdateRequest {
|
|
|
3509
3518
|
custom_notification_recipients?: Array<UserBase> | null;
|
|
3510
3519
|
}
|
|
3511
3520
|
export type AssignToType = "enterprise" | "folder" | "metadata_template" | (string & {});
|
|
3512
|
-
export interface
|
|
3521
|
+
export interface CreateRetentionPolicyAssignmentRequestAssignTo {
|
|
3513
3522
|
type: AssignToType;
|
|
3514
3523
|
id?: string | null;
|
|
3515
3524
|
}
|
|
@@ -3517,68 +3526,68 @@ export interface PostFilterFields {
|
|
|
3517
3526
|
field?: string;
|
|
3518
3527
|
value?: string;
|
|
3519
3528
|
}
|
|
3520
|
-
export interface
|
|
3529
|
+
export interface CreateRetentionPolicyAssignmentRequest {
|
|
3521
3530
|
policy_id: string;
|
|
3522
|
-
assign_to:
|
|
3531
|
+
assign_to: CreateRetentionPolicyAssignmentRequestAssignTo;
|
|
3523
3532
|
filter_fields?: Array<PostFilterFields>;
|
|
3524
3533
|
start_date_field?: string;
|
|
3525
3534
|
}
|
|
3526
|
-
export interface
|
|
3535
|
+
export interface CreateLegalHoldPolicyRequest {
|
|
3527
3536
|
policy_name: string;
|
|
3528
3537
|
description?: string;
|
|
3529
3538
|
filter_started_at?: string;
|
|
3530
3539
|
filter_ended_at?: string;
|
|
3531
3540
|
is_ongoing?: boolean;
|
|
3532
3541
|
}
|
|
3533
|
-
export interface
|
|
3542
|
+
export interface UpdateLegalHoldPolicyRequest {
|
|
3534
3543
|
policy_name?: string;
|
|
3535
3544
|
description?: string;
|
|
3536
3545
|
release_notes?: string;
|
|
3537
3546
|
}
|
|
3538
|
-
export interface
|
|
3547
|
+
export interface CreateLegalHoldPolicyAssignmentRequestAssignTo {
|
|
3539
3548
|
type: LegalHoldPolicyAssignedItemType;
|
|
3540
3549
|
id: string;
|
|
3541
3550
|
}
|
|
3542
|
-
export interface
|
|
3551
|
+
export interface CreateLegalHoldPolicyAssignmentRequest {
|
|
3543
3552
|
policy_id: string;
|
|
3544
|
-
assign_to:
|
|
3553
|
+
assign_to: CreateLegalHoldPolicyAssignmentRequestAssignTo;
|
|
3545
3554
|
}
|
|
3546
3555
|
export type PostChangeStatusStatus = "pending" | "disabled" | (string & {});
|
|
3547
|
-
export interface
|
|
3556
|
+
export interface CreateChangeStatusRequest {
|
|
3548
3557
|
id: string;
|
|
3549
3558
|
status: PostChangeStatusStatus;
|
|
3550
3559
|
}
|
|
3551
|
-
export interface
|
|
3560
|
+
export interface CreateShieldInformationBarrierRequest {
|
|
3552
3561
|
enterprise: EnterpriseBase;
|
|
3553
3562
|
}
|
|
3554
|
-
export interface
|
|
3563
|
+
export interface UpdateShieldInformationBarrierSegmentRequest {
|
|
3555
3564
|
name?: string;
|
|
3556
3565
|
description?: string | null;
|
|
3557
3566
|
}
|
|
3558
|
-
export interface
|
|
3567
|
+
export interface CreateShieldInformationBarrierSegmentRequest {
|
|
3559
3568
|
shield_information_barrier: ShieldInformationBarrierBase;
|
|
3560
3569
|
name: string;
|
|
3561
3570
|
description?: string;
|
|
3562
3571
|
}
|
|
3563
|
-
export interface
|
|
3572
|
+
export interface CreateShieldInformationBarrierSegmentMemberRequest {
|
|
3564
3573
|
type?: ShieldInformationBarrierSegmentMemberType;
|
|
3565
3574
|
shield_information_barrier?: ShieldInformationBarrierBase;
|
|
3566
3575
|
shield_information_barrier_segment: ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegment;
|
|
3567
3576
|
user: UserBase;
|
|
3568
3577
|
}
|
|
3569
|
-
export interface
|
|
3578
|
+
export interface CreateShieldInformationBarrierSegmentRestrictionRequest {
|
|
3570
3579
|
type: ShieldInformationBarrierSegmentRestrictionType;
|
|
3571
3580
|
shield_information_barrier?: ShieldInformationBarrierBase;
|
|
3572
3581
|
shield_information_barrier_segment: ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegment;
|
|
3573
3582
|
restricted_segment: ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegment;
|
|
3574
3583
|
}
|
|
3575
3584
|
export type GetTosType = "external" | "managed" | (string & {});
|
|
3576
|
-
export interface
|
|
3585
|
+
export interface CreateTermsOfServiceRequest {
|
|
3577
3586
|
status: TermsOfServiceStatus;
|
|
3578
3587
|
tos_type?: GetTosType;
|
|
3579
3588
|
text: string;
|
|
3580
3589
|
}
|
|
3581
|
-
export interface
|
|
3590
|
+
export interface UpdateTermsOfServiceRequest {
|
|
3582
3591
|
status: TermsOfServiceStatus;
|
|
3583
3592
|
text: string;
|
|
3584
3593
|
}
|
|
@@ -3586,19 +3595,19 @@ export interface PostTos {
|
|
|
3586
3595
|
type: TermsOfServiceType;
|
|
3587
3596
|
id: string;
|
|
3588
3597
|
}
|
|
3589
|
-
export interface
|
|
3598
|
+
export interface CreateTermsOfServiceUserStatusRequest {
|
|
3590
3599
|
tos: PostTos;
|
|
3591
3600
|
user: CollaboratorVariableVariableValue;
|
|
3592
3601
|
is_accepted: boolean;
|
|
3593
3602
|
}
|
|
3594
|
-
export interface
|
|
3603
|
+
export interface UpdateTermsOfServiceUserStatusRequest {
|
|
3595
3604
|
is_accepted: boolean;
|
|
3596
3605
|
}
|
|
3597
|
-
export interface
|
|
3606
|
+
export interface CreateCollaborationAllowlistEntryRequest {
|
|
3598
3607
|
domain: string;
|
|
3599
3608
|
direction: CollaborationAllowlistEntryDirection;
|
|
3600
3609
|
}
|
|
3601
|
-
export interface
|
|
3610
|
+
export interface CreateCollaborationAllowlistExemptTargetRequest {
|
|
3602
3611
|
user: AttributesParent;
|
|
3603
3612
|
}
|
|
3604
3613
|
export type GetResolvedForType = "user" | "enterprise" | (string & {});
|
|
@@ -3610,11 +3619,11 @@ export interface PostAssignedTo {
|
|
|
3610
3619
|
type: GetResolvedForType;
|
|
3611
3620
|
id: string;
|
|
3612
3621
|
}
|
|
3613
|
-
export interface
|
|
3622
|
+
export interface CreateStoragePolicyAssignmentRequest {
|
|
3614
3623
|
storage_policy: PostStoragePolicy;
|
|
3615
3624
|
assigned_to: PostAssignedTo;
|
|
3616
3625
|
}
|
|
3617
|
-
export interface
|
|
3626
|
+
export interface UpdateStoragePolicyAssignmentRequest {
|
|
3618
3627
|
storage_policy: PostStoragePolicy;
|
|
3619
3628
|
}
|
|
3620
3629
|
export type PostIdStartType = "workflow_parameters" | (string & {});
|
|
@@ -3622,39 +3631,39 @@ export interface PostIdStartFlow {
|
|
|
3622
3631
|
type?: string;
|
|
3623
3632
|
id?: string;
|
|
3624
3633
|
}
|
|
3625
|
-
export interface
|
|
3634
|
+
export interface StartWorkflowRequest {
|
|
3626
3635
|
type?: PostIdStartType;
|
|
3627
3636
|
flow: PostIdStartFlow;
|
|
3628
3637
|
files: Array<PutSkillInvocationIdFile>;
|
|
3629
3638
|
folder: MetadataCascadePolicyParent;
|
|
3630
3639
|
outcomes?: Array<Outcome>;
|
|
3631
3640
|
}
|
|
3632
|
-
export interface
|
|
3641
|
+
export interface UpdateSlackRequest {
|
|
3633
3642
|
box_item?: IntegrationMappingBoxItemSlack;
|
|
3634
3643
|
options?: IntegrationMappingSlackOptions;
|
|
3635
3644
|
}
|
|
3636
|
-
export interface
|
|
3645
|
+
export interface UpdateTeamRequest {
|
|
3637
3646
|
box_item?: FolderReference;
|
|
3638
3647
|
}
|
|
3639
3648
|
export type GetAgentDefaultMode = "ask" | "text_gen" | "extract" | "extract_structured" | (string & {});
|
|
3640
|
-
export interface
|
|
3649
|
+
export interface CreateMetadataTaxonomyRequest {
|
|
3641
3650
|
key?: string;
|
|
3642
3651
|
displayName: string;
|
|
3643
3652
|
namespace: string;
|
|
3644
3653
|
}
|
|
3645
|
-
export interface
|
|
3654
|
+
export interface UpdateMetadataTaxonomyRequest {
|
|
3646
3655
|
displayName: string;
|
|
3647
3656
|
}
|
|
3648
|
-
export interface
|
|
3657
|
+
export interface UpdateLevelRequest {
|
|
3649
3658
|
displayName: string;
|
|
3650
3659
|
description?: string;
|
|
3651
3660
|
}
|
|
3652
|
-
export interface
|
|
3661
|
+
export interface CreateNodesRequest {
|
|
3653
3662
|
displayName: string;
|
|
3654
3663
|
level: number;
|
|
3655
3664
|
parentId?: string;
|
|
3656
3665
|
}
|
|
3657
|
-
export interface
|
|
3666
|
+
export interface UpdateNodeRequest {
|
|
3658
3667
|
displayName?: string;
|
|
3659
3668
|
}
|
|
3660
3669
|
export interface Archive {
|
|
@@ -3705,8 +3714,8 @@ export interface DocGenJob {
|
|
|
3705
3714
|
batch: DocGenBatchBase;
|
|
3706
3715
|
template_file: FileReference;
|
|
3707
3716
|
template_file_version: FileVersionBase;
|
|
3708
|
-
output_file?:
|
|
3709
|
-
output_file_version?:
|
|
3717
|
+
output_file?: FileReference | null;
|
|
3718
|
+
output_file_version?: FileVersionBase | null;
|
|
3710
3719
|
status: DocGenJobStatus;
|
|
3711
3720
|
output_type: string;
|
|
3712
3721
|
failures?: DocGenJobFailures | null;
|
|
@@ -3721,8 +3730,8 @@ export interface DocGenJobFull {
|
|
|
3721
3730
|
batch: DocGenBatchBase;
|
|
3722
3731
|
template_file: FileReference;
|
|
3723
3732
|
template_file_version: FileVersionBase;
|
|
3724
|
-
output_file?:
|
|
3725
|
-
output_file_version?:
|
|
3733
|
+
output_file?: FileReference | null;
|
|
3734
|
+
output_file_version?: FileVersionBase | null;
|
|
3726
3735
|
status: DocGenJobStatus;
|
|
3727
3736
|
output_type: string;
|
|
3728
3737
|
failures?: DocGenJobFailures | null;
|
|
@@ -3776,10 +3785,10 @@ export interface DocGenTemplates {
|
|
|
3776
3785
|
export interface EnterpriseConfiguration {
|
|
3777
3786
|
id?: string;
|
|
3778
3787
|
type?: EnterpriseConfigurationType;
|
|
3779
|
-
security?:
|
|
3780
|
-
content_and_sharing?:
|
|
3781
|
-
user_settings?:
|
|
3782
|
-
shield?:
|
|
3788
|
+
security?: EnterpriseConfigurationSecurity | null;
|
|
3789
|
+
content_and_sharing?: EnterpriseConfigurationContentAndSharing | null;
|
|
3790
|
+
user_settings?: EnterpriseConfigurationUserSettings | null;
|
|
3791
|
+
shield?: EnterpriseConfigurationShield | null;
|
|
3783
3792
|
}
|
|
3784
3793
|
export interface EnterpriseConfigurationContentAndSharing {
|
|
3785
3794
|
enterprise_feature_settings?: Array<EnterpriseFeatureSettingsItem>;
|
|
@@ -4255,8 +4264,6 @@ export interface DocGenBatchCreateRequestDestinationFolder {
|
|
|
4255
4264
|
id: string;
|
|
4256
4265
|
}
|
|
4257
4266
|
export type DocGenJobType = "docgen_job" | (string & {});
|
|
4258
|
-
export type DocGenJobOutputFile = unknown;
|
|
4259
|
-
export type DocGenJobOutputFileVersion = unknown;
|
|
4260
4267
|
export type DocGenJobStatus = "submitted" | "completed" | "failed" | "completed_with_error" | "pending" | (string & {});
|
|
4261
4268
|
export interface DocGenJobFailures {
|
|
4262
4269
|
errors: Array<string>;
|
|
@@ -4264,10 +4271,6 @@ export interface DocGenJobFailures {
|
|
|
4264
4271
|
}
|
|
4265
4272
|
export type DocGenTagTagType = "text" | "arithmetic" | "conditional" | "for-loop" | "table-loop" | "image" | (string & {});
|
|
4266
4273
|
export type EnterpriseConfigurationType = "enterprise_configuration" | (string & {});
|
|
4267
|
-
export type EnterpriseConfigurationSecurity2 = unknown;
|
|
4268
|
-
export type EnterpriseConfigurationContentAndSharing2 = unknown;
|
|
4269
|
-
export type EnterpriseConfigurationUserSettings2 = unknown;
|
|
4270
|
-
export type EnterpriseConfigurationShield2 = unknown;
|
|
4271
4274
|
export interface EnterpriseConfigurationContentAndSharingSharedLinkDefaultPermissionsSelected {
|
|
4272
4275
|
is_used?: boolean;
|
|
4273
4276
|
value?: SharedLinkPermissions;
|
|
@@ -4292,15 +4295,13 @@ export interface EnterpriseConfigurationSecurityLastPasswordResetAt {
|
|
|
4292
4295
|
is_used?: boolean;
|
|
4293
4296
|
value?: string | null;
|
|
4294
4297
|
}
|
|
4295
|
-
export type ExternalCollabMultiFactorAuthSettingsValue = unknown;
|
|
4296
4298
|
export interface EnterpriseConfigurationSecurityExternalCollabMultiFactorAuthSettings {
|
|
4297
4299
|
is_used?: boolean;
|
|
4298
|
-
value?:
|
|
4300
|
+
value?: ExternalCollabSecuritySettings | null;
|
|
4299
4301
|
}
|
|
4300
|
-
export type KeysafeValue = unknown;
|
|
4301
4302
|
export interface EnterpriseConfigurationSecurityKeysafe {
|
|
4302
4303
|
is_used?: boolean;
|
|
4303
|
-
value?:
|
|
4304
|
+
value?: KeysafeSettings | null;
|
|
4304
4305
|
}
|
|
4305
4306
|
export interface EnterpriseConfigurationSecurityCustomSessionDurationGroups {
|
|
4306
4307
|
is_used?: boolean;
|
|
@@ -4371,12 +4372,12 @@ export type ShieldRuleItemPriority = "informational" | "low" | "medium" | "high"
|
|
|
4371
4372
|
export type TermsOfServiceBaseType = "terms_of_service" | (string & {});
|
|
4372
4373
|
export type UserOrGroupReferenceType = "user" | "group" | (string & {});
|
|
4373
4374
|
export type WeblinkReferenceType = "web_link" | (string & {});
|
|
4374
|
-
export interface
|
|
4375
|
+
export interface CreateArchiveRequest {
|
|
4375
4376
|
name: string;
|
|
4376
4377
|
description?: string;
|
|
4377
4378
|
storage_policy_id?: string;
|
|
4378
4379
|
}
|
|
4379
|
-
export interface
|
|
4380
|
+
export interface UpdateArchiveRequest {
|
|
4380
4381
|
name?: string;
|
|
4381
4382
|
description?: string;
|
|
4382
4383
|
}
|
|
@@ -4415,10 +4416,72 @@ export interface NotesConvertResponse {
|
|
|
4415
4416
|
type: NotesConvertResponseType;
|
|
4416
4417
|
id: string;
|
|
4417
4418
|
}
|
|
4419
|
+
export interface QueryAncestorReference {
|
|
4420
|
+
id: string;
|
|
4421
|
+
type: string;
|
|
4422
|
+
}
|
|
4423
|
+
export interface QueryInsightEntry {
|
|
4424
|
+
key: Array<string>;
|
|
4425
|
+
type: QueryInsightEntryType;
|
|
4426
|
+
metrics: Record<string, QueryInsightMetricResult>;
|
|
4427
|
+
}
|
|
4428
|
+
export interface QueryInsightMetricResult {
|
|
4429
|
+
type: string;
|
|
4430
|
+
values: Record<string, number>;
|
|
4431
|
+
}
|
|
4432
|
+
export interface QueryInsights {
|
|
4433
|
+
insights: Array<QueryInsightEntry>;
|
|
4434
|
+
}
|
|
4435
|
+
export interface QueryInsightsGroupBy {
|
|
4436
|
+
field: string;
|
|
4437
|
+
bucket_limit?: number;
|
|
4438
|
+
}
|
|
4439
|
+
export interface QueryInsightsMetricDefinition {
|
|
4440
|
+
type: QueryInsightsMetricDefinitionType;
|
|
4441
|
+
field: string;
|
|
4442
|
+
}
|
|
4443
|
+
export interface QueryInsightsRequestBody {
|
|
4444
|
+
query: QueryInsightsRequestBodyQuery;
|
|
4445
|
+
metrics: Record<string, QueryInsightsMetricDefinition>;
|
|
4446
|
+
}
|
|
4447
|
+
export interface QueryOrderBy {
|
|
4448
|
+
field_key: string;
|
|
4449
|
+
direction: QueryOrderByDirection;
|
|
4450
|
+
}
|
|
4451
|
+
export interface QueryRequestBody {
|
|
4452
|
+
query: QueryRequestBodyQuery;
|
|
4453
|
+
order_by?: Array<QueryOrderBy>;
|
|
4454
|
+
limit?: number;
|
|
4455
|
+
fields?: Array<string>;
|
|
4456
|
+
marker?: string;
|
|
4457
|
+
}
|
|
4458
|
+
export type QueryResultEntry = {
|
|
4459
|
+
id: string;
|
|
4460
|
+
type: string;
|
|
4461
|
+
} & Record<string, unknown>;
|
|
4462
|
+
export interface QueryResults {
|
|
4463
|
+
entries: Array<QueryResultEntry>;
|
|
4464
|
+
next_marker: string | null;
|
|
4465
|
+
limit: number;
|
|
4466
|
+
}
|
|
4418
4467
|
export type AutomateWorkflowActionType = "workflow_action" | (string & {});
|
|
4419
4468
|
export type AutomateWorkflowActionActionType = "run_workflow" | (string & {});
|
|
4420
4469
|
export type AutomateWorkflowReferenceType = "workflow" | (string & {});
|
|
4421
4470
|
export type FolderReferenceType = "folder" | (string & {});
|
|
4422
4471
|
export type NotesConvertRequestBodyContentFormat = "markdown" | (string & {});
|
|
4423
4472
|
export type NotesConvertResponseType = "file" | (string & {});
|
|
4473
|
+
export type QueryInsightEntryType = "group" | "overall" | "other" | (string & {});
|
|
4474
|
+
export type QueryInsightsMetricDefinitionType = "sum" | "avg" | "min" | "max" | "count" | (string & {});
|
|
4475
|
+
export interface QueryInsightsRequestBodyQuery {
|
|
4476
|
+
predicate: string;
|
|
4477
|
+
params?: Record<string, unknown>;
|
|
4478
|
+
ancestors?: Array<QueryAncestorReference>;
|
|
4479
|
+
group_by?: Array<QueryInsightsGroupBy>;
|
|
4480
|
+
}
|
|
4481
|
+
export type QueryOrderByDirection = "asc" | "desc" | (string & {});
|
|
4482
|
+
export interface QueryRequestBodyQuery {
|
|
4483
|
+
predicate: string;
|
|
4484
|
+
params?: Record<string, unknown>;
|
|
4485
|
+
ancestors?: Array<QueryAncestorReference>;
|
|
4486
|
+
}
|
|
4424
4487
|
export type UserBaseType = "user" | (string & {});
|