@unofficialbox/box-open-sdk 0.4.0 → 0.4.1

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

@@ -0,0 +1,120 @@
+import type { FileVersionType, PutOp, PutSkillInvocationIdFile } from '../schemas.js';
+export interface KeywordSkillCard {
+    created_at?: string;
+    type: KeywordSkillCardType;
+    skill_card_type: KeywordSkillCardSkillCardType;
+    skill_card_title?: KeywordSkillCardSkillCardTitle;
+    skill: KeywordSkillCardSkill;
+    invocation: KeywordSkillCardInvocation;
+    entries: Array<KeywordSkillCardEntries>;
+}
+export type SkillCard = unknown;
+export interface SkillCardsMetadata {
+    $canEdit?: boolean;
+    $id?: string;
+    $parent?: string;
+    $scope?: string;
+    $template?: string;
+    $type?: string;
+    $typeVersion?: number;
+    $version?: number;
+    cards?: Array<SkillCard>;
+}
+export interface StatusSkillCard {
+    created_at?: string;
+    type: KeywordSkillCardType;
+    skill_card_type: StatusSkillCardSkillCardType;
+    skill_card_title?: KeywordSkillCardSkillCardTitle;
+    status: StatusSkillCardStatus;
+    skill: KeywordSkillCardSkill;
+    invocation: KeywordSkillCardInvocation;
+}
+export interface TimelineSkillCard {
+    created_at?: string;
+    type: KeywordSkillCardType;
+    skill_card_type: TimelineSkillCardSkillCardType;
+    skill_card_title?: KeywordSkillCardSkillCardTitle;
+    skill: KeywordSkillCardSkill;
+    invocation: KeywordSkillCardInvocation;
+    duration?: number;
+    entries: Array<TimelineSkillCardEntries>;
+}
+export interface TranscriptSkillCard {
+    created_at?: string;
+    type: KeywordSkillCardType;
+    skill_card_type: TranscriptSkillCardSkillCardType;
+    skill_card_title?: KeywordSkillCardSkillCardTitle;
+    skill: KeywordSkillCardSkill;
+    invocation: KeywordSkillCardInvocation;
+    duration?: number;
+    entries: Array<TranscriptSkillCardEntries>;
+}
+export type KeywordSkillCardType = "skill_card" | (string & {});
+export type KeywordSkillCardSkillCardType = "keyword" | (string & {});
+export interface KeywordSkillCardSkillCardTitle {
+    code?: string;
+    message: string;
+}
+export type SkillType = "service" | (string & {});
+export interface KeywordSkillCardSkill {
+    type: SkillType;
+    id: string;
+}
+export type InvocationType = "skill_invocation" | (string & {});
+export interface KeywordSkillCardInvocation {
+    type: InvocationType;
+    id: string;
+}
+export interface KeywordSkillCardEntries {
+    text?: string;
+}
+export type StatusSkillCardSkillCardType = "status" | (string & {});
+export type StatusCode = "invoked" | "processing" | "success" | "transient_failure" | "permanent_failure" | (string & {});
+export interface StatusSkillCardStatus {
+    code: StatusCode;
+    message?: string;
+}
+export type TimelineSkillCardSkillCardType = "timeline" | (string & {});
+export interface EntriesAppears {
+    start?: number;
+    end?: number;
+}
+export interface TimelineSkillCardEntries {
+    text?: string;
+    appears?: Array<EntriesAppears>;
+    image_url?: string;
+}
+export type TranscriptSkillCardSkillCardType = "transcript" | (string & {});
+export interface TranscriptSkillCardEntriesAppears {
+    start?: number;
+}
+export interface TranscriptSkillCardEntries {
+    text?: string;
+    appears?: Array<TranscriptSkillCardEntriesAppears>;
+}
+export interface UpdateSkillRequest {
+    op?: PutOp;
+    path?: string;
+    value?: SkillCard;
+}
+export interface CreateSkillRequest {
+    cards: Array<SkillCard>;
+}
+export interface PutSkillInvocationIdMetadata {
+    cards?: Array<SkillCard>;
+}
+export interface PutSkillInvocationIdFileVersion {
+    type?: FileVersionType;
+    id?: string;
+}
+export interface PutSkillInvocationIdUsage {
+    unit?: string;
+    value?: number;
+}
+export interface UpdateSkillInvocationRequest {
+    status: StatusCode;
+    metadata: PutSkillInvocationIdMetadata;
+    file: PutSkillInvocationIdFile;
+    file_version?: PutSkillInvocationIdFileVersion;
+    usage?: PutSkillInvocationIdUsage;
+}

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

@@ -0,0 +1,12 @@
+import type { StoragePolicyType } from '../schemas.js';
+export interface StoragePolicies {
+    limit?: number;
+    next_marker?: string | null;
+    prev_marker?: string | null;
+    entries?: Array<StoragePolicy>;
+}
+export interface StoragePolicy {
+    id: string;
+    type: StoragePolicyType;
+    name?: string;
+}

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

@@ -0,0 +1,34 @@
+import type { CommentItem, StoragePolicyType } from '../schemas.js';
+export interface StoragePolicyMini {
+    id: string;
+    type: StoragePolicyType;
+}
+export interface StoragePolicyAssignment {
+    id: string;
+    type: StoragePolicyAssignmentType;
+    storage_policy?: StoragePolicyMini;
+    assigned_to?: CommentItem;
+}
+export interface StoragePolicyAssignments {
+    limit?: number;
+    next_marker?: string | null;
+    prev_marker?: string | null;
+    entries?: Array<StoragePolicyAssignment>;
+}
+export type StoragePolicyAssignmentType = "storage_policy_assignment" | (string & {});
+export type GetResolvedForType = "user" | "enterprise" | (string & {});
+export interface PostStoragePolicy {
+    type: StoragePolicyType;
+    id: string;
+}
+export interface PostAssignedTo {
+    type: GetResolvedForType;
+    id: string;
+}
+export interface CreateStoragePolicyAssignmentRequest {
+    storage_policy: PostStoragePolicy;
+    assigned_to: PostAssignedTo;
+}
+export interface UpdateStoragePolicyAssignmentRequest {
+    storage_policy: PostStoragePolicy;
+}

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

@@ -0,0 +1,17 @@
+import type { TaskAssignmentResolutionState, TaskType } from '../schemas.js';
+export interface PostTask {
+    id: string;
+    type: TaskType;
+}
+export interface PostAssignTo {
+    id?: string;
+    login?: string;
+}
+export interface CreateTaskAssignmentRequest {
+    task: PostTask;
+    assign_to: PostAssignTo;
+}
+export interface UpdateTaskAssignmentRequest {
+    message?: string;
+    resolution_state?: TaskAssignmentResolutionState;
+}

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

@@ -0,0 +1,37 @@
+import type { AiCitationType, FileMini, TaskAssignments, TaskType, UserMini } from '../schemas.js';
+export interface Task {
+    id?: string;
+    type?: TaskType;
+    item?: FileMini;
+    due_at?: string;
+    action?: TaskAction;
+    message?: string;
+    task_assignment_collection?: TaskAssignments;
+    is_completed?: boolean;
+    created_by?: UserMini;
+    created_at?: string;
+    completion_rule?: TaskCompletionRule;
+}
+export interface Tasks {
+    total_count?: number;
+    entries?: Array<Task>;
+}
+export type TaskAction = "review" | "complete" | (string & {});
+export type TaskCompletionRule = "all_assignees" | "any_assignee" | (string & {});
+export interface CreateTaskRequestItem {
+    id?: string;
+    type?: AiCitationType;
+}
+export interface CreateTaskRequest {
+    item: CreateTaskRequestItem;
+    action?: TaskAction;
+    message?: string;
+    due_at?: string;
+    completion_rule?: TaskCompletionRule;
+}
+export interface UpdateTaskRequest {
+    action?: TaskAction;
+    message?: string;
+    due_at?: string;
+    completion_rule?: TaskCompletionRule;
+}

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

@@ -0,0 +1,27 @@
+import type { CollaboratorVariableVariableValue, TermsOfServiceBase, TermsOfServiceType, UserMini } from '../schemas.js';
+export interface TermsOfServiceUserStatus {
+    id: string;
+    type: TermsOfServiceUserStatusType;
+    tos?: TermsOfServiceBase;
+    user?: UserMini;
+    is_accepted?: boolean;
+    created_at?: string;
+    modified_at?: string;
+}
+export interface TermsOfServiceUserStatuses {
+    total_count?: number;
+    entries?: Array<TermsOfServiceUserStatus>;
+}
+export type TermsOfServiceUserStatusType = "terms_of_service_user_status" | (string & {});
+export interface PostTos {
+    type: TermsOfServiceType;
+    id: string;
+}
+export interface CreateTermsOfServiceUserStatusRequest {
+    tos: PostTos;
+    user: CollaboratorVariableVariableValue;
+    is_accepted: boolean;
+}
+export interface UpdateTermsOfServiceUserStatusRequest {
+    is_accepted: boolean;
+}

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

@@ -0,0 +1,27 @@
+import type { CollaborationAllowlistEntryEnterprise, TermsOfServiceType } from '../schemas.js';
+export interface TermsOfService {
+    id: string;
+    type: TermsOfServiceType;
+    status?: TermsOfServiceStatus;
+    enterprise?: CollaborationAllowlistEntryEnterprise;
+    tos_type?: TermsOfServiceTosType;
+    text?: string;
+    created_at?: string;
+    modified_at?: string;
+}
+export interface TermsOfServices {
+    total_count?: number;
+    entries?: Array<TermsOfService>;
+}
+export type TermsOfServiceStatus = "enabled" | "disabled" | (string & {});
+export type TermsOfServiceTosType = "managed" | "external" | (string & {});
+export type GetTosType = "external" | "managed" | (string & {});
+export interface CreateTermsOfServiceRequest {
+    status: TermsOfServiceStatus;
+    tos_type?: GetTosType;
+    text: string;
+}
+export interface UpdateTermsOfServiceRequest {
+    status: TermsOfServiceStatus;
+    text: string;
+}

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

@@ -0,0 +1,4 @@
+import type { AttributesParent } from '../schemas.js';
+export interface TransferFoldersRequest {
+    owned_by: AttributesParent;
+}

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

@@ -0,0 +1,49 @@
+import type { AiCitationType, FileItemStatus, FilePathCollection, FileVersionMini, FolderMini, TrashFilePathCollection, UserMini } from '../schemas.js';
+export interface TrashFile {
+    id: string;
+    etag?: string | null;
+    type: AiCitationType;
+    sequence_id: string;
+    name?: string;
+    sha1: string;
+    file_version?: FileVersionMini;
+    description: string;
+    size: number;
+    path_collection: TrashFilePathCollection;
+    created_at: string;
+    modified_at: string;
+    trashed_at?: string | null;
+    purged_at?: string | null;
+    content_created_at?: string | null;
+    content_modified_at?: string | null;
+    created_by?: UserMini;
+    modified_by: UserMini;
+    owned_by: UserMini;
+    shared_link?: string | null;
+    parent?: FolderMini | null;
+    item_status: FileItemStatus;
+}
+export interface TrashFileRestored {
+    id: string;
+    etag?: string | null;
+    type: AiCitationType;
+    sequence_id: string;
+    name?: string;
+    sha1: string;
+    file_version?: FileVersionMini;
+    description: string;
+    size: number;
+    path_collection: FilePathCollection;
+    created_at: string;
+    modified_at: string;
+    trashed_at?: string | null;
+    purged_at?: string | null;
+    content_created_at?: string | null;
+    content_modified_at?: string | null;
+    created_by?: UserMini;
+    modified_by: UserMini;
+    owned_by: UserMini;
+    shared_link?: string | null;
+    parent?: FolderMini | null;
+    item_status: FileItemStatus;
+}

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

@@ -0,0 +1,47 @@
+import type { FileItemStatus, FilePathCollection, FolderMini, FolderType, TrashFilePathCollection, UserMini } from '../schemas.js';
+export interface TrashFolder {
+    id: string;
+    etag?: string | null;
+    type: FolderType;
+    sequence_id?: string;
+    name: string;
+    created_at?: string | null;
+    modified_at?: string | null;
+    description: string;
+    size: number;
+    path_collection: TrashFilePathCollection;
+    created_by: UserMini;
+    modified_by: UserMini;
+    trashed_at?: string | null;
+    purged_at?: string | null;
+    content_created_at?: string | null;
+    content_modified_at?: string | null;
+    owned_by: UserMini;
+    shared_link?: string | null;
+    folder_upload_email?: string | null;
+    parent?: FolderMini | null;
+    item_status: FileItemStatus;
+}
+export interface TrashFolderRestored {
+    id?: string;
+    etag?: string | null;
+    type?: FolderType;
+    sequence_id?: string;
+    name?: string;
+    created_at?: string | null;
+    modified_at?: string | null;
+    description?: string;
+    size?: number;
+    path_collection?: FilePathCollection;
+    created_by?: UserMini;
+    modified_by?: UserMini;
+    trashed_at?: string | null;
+    purged_at?: string | null;
+    content_created_at?: string | null;
+    content_modified_at?: string | null;
+    owned_by?: UserMini;
+    shared_link?: string | null;
+    folder_upload_email?: string | null;
+    parent?: FolderMini | null;
+    item_status?: FileItemStatus;
+}

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

@@ -0,0 +1 @@
+export type GetFolderTrashItemsSort = "name" | "date" | "size" | (string & {});

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

@@ -0,0 +1,41 @@
+import type { FileItemStatus, FilePathCollection, FolderMini, TrashFilePathCollection, TrashWebLinkType, UserMini } from '../schemas.js';
+export interface TrashWebLink {
+    type?: TrashWebLinkType;
+    id?: string;
+    sequence_id?: string;
+    etag?: string;
+    name?: string;
+    url?: string;
+    parent?: FolderMini;
+    description?: string;
+    path_collection?: TrashFilePathCollection;
+    created_at?: string;
+    modified_at?: string;
+    trashed_at?: string | null;
+    purged_at?: string | null;
+    created_by?: UserMini;
+    modified_by?: UserMini;
+    owned_by?: UserMini;
+    shared_link?: string | null;
+    item_status?: FileItemStatus;
+}
+export interface TrashWebLinkRestored {
+    type?: TrashWebLinkType;
+    id?: string;
+    sequence_id: string;
+    etag?: string;
+    name?: string;
+    url?: string;
+    parent?: FolderMini;
+    description?: string;
+    path_collection: FilePathCollection;
+    created_at?: string;
+    modified_at?: string;
+    trashed_at?: string | null;
+    purged_at?: string | null;
+    created_by?: UserMini;
+    modified_by?: UserMini;
+    owned_by?: UserMini;
+    shared_link?: string | null;
+    item_status?: FileItemStatus;
+}

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

@@ -0,0 +1,28 @@
+import type { AttributesParent, PostFileIdParent } from '../schemas.js';
+export interface UploadUrl {
+    upload_url?: string;
+    upload_token?: string;
+}
+export interface PostFileIdContentAttributes {
+    name: string;
+    content_modified_at?: string;
+}
+export interface CreateFileIdContentRequest {
+    attributes: PostFileIdContentAttributes;
+    file: Blob;
+}
+export interface PostFileContentAttributes {
+    name: string;
+    parent: AttributesParent;
+    content_created_at?: string;
+    content_modified_at?: string;
+}
+export interface CreateFileContentRequest {
+    attributes: PostFileContentAttributes;
+    file: Blob;
+}
+export interface OptionFileContentRequest {
+    name?: string;
+    size?: number;
+    parent?: PostFileIdParent;
+}

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>;
+}