@unofficialbox/box-open-sdk 0.3.1 → 0.4.1

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

@@ -0,0 +1,26 @@
+import type { CollaborationRole, EventSourceItemType, FileFullAllowedInviteeRoles } from '../schemas.js';
+export type PutCollaborationIdStatus = "pending" | "accepted" | "rejected" | (string & {});
+export interface UpdateCollaborationRequest {
+    role?: CollaborationRole;
+    status?: PutCollaborationIdStatus;
+    expires_at?: string;
+    can_view_path?: boolean;
+}
+export interface PostCollaborationsItem {
+    type?: EventSourceItemType;
+    id?: string;
+}
+export type AccessibleByType = "user" | "group" | (string & {});
+export interface PostCollaborationsAccessibleBy {
+    type: AccessibleByType;
+    id?: string;
+    login?: string;
+}
+export interface CreateCollaborationsRequest {
+    item: PostCollaborationsItem;
+    accessible_by: PostCollaborationsAccessibleBy;
+    role: FileFullAllowedInviteeRoles;
+    is_access_only?: boolean;
+    can_view_path?: boolean;
+    expires_at?: string;
+}

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

@@ -0,0 +1,98 @@
+import type { CollaborationAllowlistEntryEnterprise, CollectionsOrder, UserNotificationEmail, UserStatus, VariableValueType } from '../schemas.js';
+export interface TrackingCode {
+    type?: TrackingCodeType;
+    name?: string;
+    value?: string;
+}
+export interface UserFull {
+    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;
+    role?: UserFullRole;
+    tracking_codes?: Array<TrackingCode>;
+    can_see_managed_users?: boolean;
+    is_sync_enabled?: boolean;
+    is_external_collab_restricted?: boolean;
+    is_exempt_from_device_limits?: boolean;
+    is_exempt_from_login_verification?: boolean;
+    is_collaborated_content_available_when_owner_inactive?: boolean;
+    enterprise?: CollaborationAllowlistEntryEnterprise;
+    my_tags?: Array<string>;
+    hostname?: string;
+    is_platform_access_only?: boolean;
+    external_app_user_id?: string;
+}
+export interface Users {
+    limit?: number;
+    next_marker?: string | null;
+    prev_marker?: string | null;
+    total_count?: number;
+    offset?: number;
+    order?: Array<CollectionsOrder>;
+    entries?: Array<UserFull>;
+}
+export type TrackingCodeType = "tracking_code" | (string & {});
+export type UserFullRole = "admin" | "coadmin" | "user" | (string & {});
+export type GetUserType = "all" | "managed" | "external" | (string & {});
+export type PostRole = "coadmin" | "user" | (string & {});
+export interface CreateUserRequest {
+    name: string;
+    login?: string;
+    is_platform_access_only?: boolean;
+    role?: PostRole;
+    language?: string;
+    is_sync_enabled?: boolean;
+    job_title?: string;
+    phone?: string;
+    address?: string;
+    space_amount?: number;
+    tracking_codes?: Array<TrackingCode>;
+    can_see_managed_users?: boolean;
+    timezone?: string;
+    is_external_collab_restricted?: boolean;
+    is_exempt_from_device_limits?: boolean;
+    is_exempt_from_login_verification?: boolean;
+    status?: UserStatus;
+    external_app_user_id?: string;
+}
+export interface PutIdNotificationEmail {
+    email?: string;
+}
+export interface UpdateUserRequest {
+    enterprise?: string | null;
+    notify?: boolean;
+    name?: string;
+    login?: string;
+    role?: PostRole;
+    language?: string;
+    is_sync_enabled?: boolean;
+    job_title?: string;
+    phone?: string;
+    address?: string;
+    tracking_codes?: Array<TrackingCode>;
+    can_see_managed_users?: boolean;
+    timezone?: string;
+    is_external_collab_restricted?: boolean;
+    is_exempt_from_device_limits?: boolean;
+    is_exempt_from_login_verification?: boolean;
+    is_password_reset_required?: boolean;
+    is_collaborated_content_available_when_owner_inactive?: boolean;
+    status?: UserStatus;
+    space_amount?: number;
+    notification_email?: PutIdNotificationEmail | null;
+    external_app_user_id?: string;
+}

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

@@ -0,0 +1,20 @@
+import type { AttributesParent, PutIdParent, SharedLinkAccess } from '../schemas.js';
+export interface CreateWebLinkRequest {
+    url: string;
+    parent: AttributesParent;
+    name?: string;
+    description?: string;
+}
+export interface UpdateWebLinkRequestSharedLink {
+    access?: SharedLinkAccess;
+    password?: string | null;
+    vanity_name?: string;
+    unshared_at?: string;
+}
+export interface UpdateWebLinkRequest {
+    url?: string;
+    parent?: PutIdParent;
+    name?: string;
+    description?: string;
+    shared_link?: UpdateWebLinkRequestSharedLink;
+}

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

@@ -0,0 +1,37 @@
+import type { EventSourceItemType, UserMini } from '../schemas.js';
+export interface Webhook {
+    id?: string;
+    type?: WebhookType;
+    target?: WebhookTarget;
+    created_by?: UserMini;
+    created_at?: string;
+    address?: string;
+    triggers?: Array<WebhookTriggers>;
+}
+export interface WebhookMini {
+    id?: string;
+    type?: WebhookType;
+    target?: WebhookTarget;
+}
+export interface Webhooks {
+    limit?: number;
+    next_marker?: string | null;
+    prev_marker?: string | null;
+    entries?: Array<WebhookMini>;
+}
+export type WebhookType = "webhook" | (string & {});
+export interface WebhookTarget {
+    id?: string;
+    type?: EventSourceItemType;
+}
+export type WebhookTriggers = "FILE.UPLOADED" | "FILE.PREVIEWED" | "FILE.DOWNLOADED" | "FILE.TRASHED" | "FILE.DELETED" | "FILE.RESTORED" | "FILE.COPIED" | "FILE.MOVED" | "FILE.LOCKED" | "FILE.UNLOCKED" | "FILE.RENAMED" | "COMMENT.CREATED" | "COMMENT.UPDATED" | "COMMENT.DELETED" | "TASK_ASSIGNMENT.CREATED" | "TASK_ASSIGNMENT.UPDATED" | "METADATA_INSTANCE.CREATED" | "METADATA_INSTANCE.UPDATED" | "METADATA_INSTANCE.DELETED" | "FOLDER.CREATED" | "FOLDER.RENAMED" | "FOLDER.DOWNLOADED" | "FOLDER.RESTORED" | "FOLDER.DELETED" | "FOLDER.COPIED" | "FOLDER.MOVED" | "FOLDER.TRASHED" | "WEBHOOK.DELETED" | "COLLABORATION.CREATED" | "COLLABORATION.ACCEPTED" | "COLLABORATION.REJECTED" | "COLLABORATION.REMOVED" | "COLLABORATION.UPDATED" | "SHARED_LINK.DELETED" | "SHARED_LINK.CREATED" | "SHARED_LINK.UPDATED" | "SIGN_REQUEST.COMPLETED" | "SIGN_REQUEST.DECLINED" | "SIGN_REQUEST.EXPIRED" | "SIGN_REQUEST.SIGNER_EMAIL_BOUNCED" | "SIGN_REQUEST.SIGN_SIGNER_SIGNED" | "SIGN_REQUEST.SIGN_DOCUMENT_CREATED" | "SIGN_REQUEST.SIGN_ERROR_FINALIZING" | (string & {});
+export interface CreateWebhookRequest {
+    target: WebhookTarget;
+    address: string;
+    triggers: Array<WebhookTriggers>;
+}
+export interface UpdateWebhookRequest {
+    target?: WebhookTarget;
+    address?: string;
+    triggers?: Array<WebhookTriggers>;
+}

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

@@ -0,0 +1,93 @@
+import type { CollaboratorVariableVariableValue, FileFullAllowedInviteeRoles, MetadataCascadePolicyParent, PutSkillInvocationIdFile, UserBase } from '../schemas.js';
+export interface CollaboratorVariable {
+    type: CollaboratorVariableType;
+    variable_type: CollaboratorVariableVariableType;
+    variable_value: Array<CollaboratorVariableVariableValue>;
+}
+export interface CompletionRuleVariable {
+    type: CollaboratorVariableType;
+    variable_type: CompletionRuleVariableVariableType;
+    variable_value: CompletionRuleVariableVariableValue;
+}
+export interface Outcome {
+    id: string;
+    collaborators?: CollaboratorVariable;
+    completion_rule?: CompletionRuleVariable;
+    file_collaborator_role?: RoleVariable;
+    task_collaborators?: CollaboratorVariable;
+    role?: RoleVariable;
+}
+export interface RoleVariable {
+    type: CollaboratorVariableType;
+    variable_type: RoleVariableVariableType;
+    variable_value: FileFullAllowedInviteeRoles;
+}
+export interface Workflow {
+    id?: string;
+    type?: WorkflowType;
+    name?: string;
+    description?: string;
+    is_enabled?: boolean;
+    flows?: Array<WorkflowFlows>;
+}
+export interface Workflows {
+    limit?: number;
+    next_marker?: string | null;
+    prev_marker?: string | null;
+    entries?: Array<Workflow>;
+}
+export type CollaboratorVariableType = "variable" | (string & {});
+export type CollaboratorVariableVariableType = "user_list" | (string & {});
+export type CompletionRuleVariableVariableType = "task_completion_rule" | (string & {});
+export type CompletionRuleVariableVariableValue = "all_assignees" | "any_assignees" | (string & {});
+export type RoleVariableVariableType = "collaborator_role" | (string & {});
+export type WorkflowType = "workflow" | (string & {});
+export type FlowsType = "flow" | (string & {});
+export type TriggerType = "trigger" | (string & {});
+export type TriggerTriggerType = "WORKFLOW_MANUAL_START" | (string & {});
+export type ScopeType = "trigger_scope" | (string & {});
+export interface TriggerScope {
+    type?: ScopeType;
+    ref?: string;
+    object?: MetadataCascadePolicyParent;
+}
+export interface FlowsTrigger {
+    type?: TriggerType;
+    trigger_type?: TriggerTriggerType;
+    scope?: Array<TriggerScope>;
+}
+export type OutcomesType = "outcome" | (string & {});
+export type OutcomesActionType = "add_metadata" | "assign_task" | "copy_file" | "copy_folder" | "create_folder" | "delete_file" | "delete_folder" | "lock_file" | "move_file" | "move_folder" | "remove_watermark_file" | "rename_folder" | "restore_folder" | "share_file" | "share_folder" | "unlock_file" | "upload_file" | "wait_for_task" | "watermark_file" | "go_back_to_step" | "apply_file_classification" | "apply_folder_classification" | "send_notification" | (string & {});
+export interface OutcomesIfRejected {
+    id?: string;
+    type?: OutcomesType;
+    name?: string;
+    action_type?: OutcomesActionType;
+}
+export interface FlowsOutcomes {
+    id?: string;
+    type?: OutcomesType;
+    name?: string;
+    action_type?: OutcomesActionType;
+    if_rejected?: Array<OutcomesIfRejected>;
+}
+export interface WorkflowFlows {
+    id?: string;
+    type?: FlowsType;
+    trigger?: FlowsTrigger;
+    outcomes?: Array<FlowsOutcomes>;
+    created_at?: string;
+    created_by?: UserBase;
+}
+export type PostIdStartType = "workflow_parameters" | (string & {});
+export interface PostIdStartFlow {
+    type?: string;
+    id?: string;
+}
+export interface StartWorkflowRequest {
+    type?: PostIdStartType;
+    flow: PostIdStartFlow;
+    files: Array<PutSkillInvocationIdFile>;
+    folder: MetadataCascadePolicyParent;
+    outcomes?: Array<Outcome>;
+}

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

@@ -0,0 +1,29 @@
+import type { EventSourceItemType } from '../schemas.js';
+export interface ZipDownload {
+    download_url?: string;
+    status_url?: string;
+    expires_at?: string;
+    name_conflicts?: Array<Array<ZipDownloadNameConflicts>>;
+}
+export interface ZipDownloadRequest {
+    items: Array<ZipDownloadRequestItems>;
+    download_file_name?: string;
+}
+export interface ZipDownloadStatus {
+    total_file_count?: number;
+    downloaded_file_count?: number;
+    skipped_file_count?: number;
+    skipped_folder_count?: number;
+    state?: ZipDownloadStatusState;
+}
+export interface ZipDownloadNameConflicts {
+    id?: string;
+    type?: EventSourceItemType;
+    original_name?: string;
+    download_name?: string;
+}
+export interface ZipDownloadRequestItems {
+    type: EventSourceItemType;
+    id: string;
+}
+export type ZipDownloadStatusState = "in_progress" | "failed" | "succeeded" | (string & {});