@unofficialbox/box-open-sdk 0.4.0 → 0.4.2

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

@@ -0,0 +1,172 @@
+import type { AiAgentAskType, AiAgentBasicGenToolEmbeddings, AiAgentExtractType, AiAgentSpreadsheetTool, AiAgentTextGenType, AiLlmEndpointParams, GroupType, UserBase } from '../schemas.js';
+export type AiAgentAllowedEntity = (UserBase & {
+    type: "user";
+}) | (GroupBase & {
+    type: "group";
+}) | {
+    type: string;
+    [key: string]: unknown;
+};
+export interface AiMultipleAgentResponse {
+    limit?: number;
+    next_marker?: string | null;
+    prev_marker?: string | null;
+    entries: Array<AiSingleAgentResponseFull>;
+}
+export interface AiSingleAgentResponseFull {
+    id: string;
+    type?: AiSingleAgentResponseType;
+    origin: string;
+    name: string;
+    access_state: string;
+    created_by?: UserBase;
+    created_at?: string;
+    modified_by?: UserBase;
+    modified_at?: string;
+    icon_reference?: string;
+    allowed_entities?: Array<AiAgentAllowedEntity>;
+    ask?: AiStudioAgentAskResponse;
+    text_gen?: AiStudioAgentTextGenResponse;
+    extract?: AiStudioAgentExtractResponse;
+}
+export interface AiStudioAgentAsk {
+    type: AiAgentAskType;
+    access_state: string;
+    description: string;
+    custom_instructions?: string | null;
+    suggested_questions?: Array<string>;
+    long_text?: AiStudioAgentLongTextTool;
+    basic_text?: AiStudioAgentBasicTextTool;
+    basic_image?: AiStudioAgentBasicTextTool;
+    spreadsheet?: AiStudioAgentSpreadsheetTool;
+    long_text_multi?: AiStudioAgentLongTextTool;
+    basic_text_multi?: AiStudioAgentBasicTextTool;
+    basic_image_multi?: AiStudioAgentBasicTextTool;
+}
+export interface AiStudioAgentAskResponse {
+    type: AiAgentAskType;
+    access_state: string;
+    description: string;
+    custom_instructions?: string | null;
+    suggested_questions?: Array<string>;
+    long_text?: AiStudioAgentLongTextToolResponse;
+    basic_text?: AiStudioAgentBasicTextToolResponse;
+    basic_image?: AiStudioAgentBasicTextToolResponse;
+    spreadsheet?: AiStudioAgentSpreadsheetToolResponse;
+    long_text_multi?: AiStudioAgentLongTextToolResponse;
+    basic_text_multi?: AiStudioAgentBasicTextToolResponse;
+    basic_image_multi?: AiStudioAgentBasicTextToolResponse;
+}
+export interface AiStudioAgentBasicGenTool {
+    model?: string;
+    num_tokens_for_completion?: number;
+    llm_endpoint_params?: AiLlmEndpointParams;
+    system_message?: string;
+    prompt_template?: string;
+    embeddings?: AiAgentBasicGenToolEmbeddings;
+    content_template?: string;
+    is_custom_instructions_included?: boolean;
+}
+export interface AiStudioAgentBasicGenToolResponse {
+    model?: string;
+    num_tokens_for_completion?: number;
+    llm_endpoint_params?: AiLlmEndpointParams;
+    system_message?: string;
+    prompt_template?: string;
+    embeddings?: AiAgentBasicGenToolEmbeddings;
+    content_template?: string;
+    is_custom_instructions_included?: boolean;
+    warnings?: Array<string>;
+}
+export interface AiStudioAgentBasicTextTool {
+    model?: string;
+    num_tokens_for_completion?: number;
+    llm_endpoint_params?: AiLlmEndpointParams;
+    system_message?: string;
+    prompt_template?: string;
+    is_custom_instructions_included?: boolean;
+}
+export interface AiStudioAgentBasicTextToolResponse {
+    model?: string;
+    num_tokens_for_completion?: number;
+    llm_endpoint_params?: AiLlmEndpointParams;
+    system_message?: string;
+    prompt_template?: string;
+    is_custom_instructions_included?: boolean;
+    warnings?: Array<string>;
+}
+export interface AiStudioAgentExtract {
+    type: AiAgentExtractType;
+    access_state: string;
+    description: string;
+    custom_instructions?: string | null;
+    long_text?: AiStudioAgentLongTextTool;
+    basic_text?: AiStudioAgentBasicTextTool;
+    basic_image?: AiStudioAgentBasicTextTool;
+}
+export interface AiStudioAgentExtractResponse {
+    type: AiAgentExtractType;
+    access_state: string;
+    description: string;
+    custom_instructions?: string | null;
+    long_text?: AiStudioAgentLongTextToolResponse;
+    basic_text?: AiStudioAgentBasicTextToolResponse;
+    basic_image?: AiStudioAgentBasicTextToolResponse;
+}
+export interface AiStudioAgentLongTextTool {
+    model?: string;
+    num_tokens_for_completion?: number;
+    llm_endpoint_params?: AiLlmEndpointParams;
+    system_message?: string;
+    prompt_template?: string;
+    embeddings?: AiAgentBasicGenToolEmbeddings;
+    is_custom_instructions_included?: boolean;
+}
+export interface AiStudioAgentLongTextToolResponse {
+    model?: string;
+    num_tokens_for_completion?: number;
+    llm_endpoint_params?: AiLlmEndpointParams;
+    system_message?: string;
+    prompt_template?: string;
+    embeddings?: AiAgentBasicGenToolEmbeddings;
+    is_custom_instructions_included?: boolean;
+    warnings?: Array<string>;
+}
+export type AiStudioAgentSpreadsheetTool = AiAgentSpreadsheetTool;
+export interface AiStudioAgentSpreadsheetToolResponse {
+    model?: string;
+    num_tokens_for_completion?: number;
+    llm_endpoint_params?: AiLlmEndpointParams;
+    warnings?: Array<string>;
+}
+export interface AiStudioAgentTextGen {
+    type: AiAgentTextGenType;
+    access_state: string;
+    description: string;
+    custom_instructions?: string | null;
+    suggested_questions?: Array<string>;
+    basic_gen?: AiStudioAgentBasicGenTool;
+}
+export interface AiStudioAgentTextGenResponse {
+    type: AiAgentTextGenType;
+    access_state: string;
+    description: string;
+    custom_instructions?: string | null;
+    suggested_questions?: Array<string>;
+    basic_gen?: AiStudioAgentBasicGenToolResponse;
+}
+export interface CreateAiAgent {
+    type: AiSingleAgentResponseType;
+    name: string;
+    access_state: string;
+    icon_reference?: string;
+    allowed_entities?: Array<AiAgentAllowedEntity>;
+    ask?: AiStudioAgentAsk;
+    text_gen?: AiStudioAgentTextGen;
+    extract?: AiStudioAgentExtract;
+}
+export interface GroupBase {
+    id: string;
+    type: GroupType;
+}
+export type AiSingleAgentResponseType = "ai_agent" | (string & {});

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

@@ -0,0 +1,34 @@
+import type { AppItem, FileBase, FolderType, TrashWebLinkType } from '../schemas.js';
+export type AppItemAssociatedItem = (FileBase & {
+    type: "file";
+}) | (FolderBase & {
+    type: "folder";
+}) | (WebLinkBase & {
+    type: "web_link";
+}) | {
+    type: string;
+    [key: string]: unknown;
+};
+export interface AppItemAssociation {
+    id: string;
+    type: AppItemAssociationType;
+    app_item: AppItem;
+    item: AppItemAssociatedItem;
+}
+export interface AppItemAssociations {
+    limit?: number;
+    next_marker?: string | null;
+    prev_marker?: string | null;
+    entries?: Array<AppItemAssociation>;
+}
+export interface FolderBase {
+    id: string;
+    etag?: string | null;
+    type: FolderType;
+}
+export interface WebLinkBase {
+    id: string;
+    type: TrashWebLinkType;
+    etag?: string;
+}
+export type AppItemAssociationType = "app_item_association" | (string & {});

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

@@ -0,0 +1,27 @@
+export interface Archive {
+    id: string;
+    type: ArchiveType;
+    name: string;
+    size: number;
+    description?: string | null;
+    owned_by?: ArchiveOwnedBy;
+}
+export interface Archives {
+    entries?: Array<Archive>;
+    limit?: number;
+    next_marker?: string | null;
+}
+export type ArchiveType = "archive" | (string & {});
+export interface ArchiveOwnedBy {
+    id: string;
+    type: string;
+}
+export interface CreateArchiveRequest {
+    name: string;
+    description?: string;
+    storage_policy_id?: string;
+}
+export interface UpdateArchiveRequest {
+    name?: string;
+    description?: string;
+}

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

@@ -0,0 +1,43 @@
+import type { AccessTokenType, ResourceScope } from '../schemas.js';
+export interface AccessToken {
+    access_token?: string;
+    expires_in?: number;
+    token_type?: AccessTokenType;
+    restricted_to?: Array<ResourceScope>;
+    refresh_token?: string;
+    issued_token_type?: AccessTokenIssuedTokenType;
+}
+export interface PostOAuth2Revoke {
+    client_id?: string;
+    client_secret?: string;
+    token?: string;
+}
+export interface PostOAuth2Token {
+    grant_type: PostOAuth2TokenGrantType;
+    client_id?: string;
+    client_secret?: string;
+    code?: string;
+    refresh_token?: string;
+    assertion?: string;
+    subject_token?: string;
+    subject_token_type?: AccessTokenIssuedTokenType;
+    actor_token?: string;
+    actor_token_type?: PostOAuth2TokenActorTokenType;
+    scope?: string;
+    resource?: string;
+    box_subject_type?: PostOAuth2TokenBoxSubjectType;
+    box_subject_id?: string;
+    box_shared_link?: string;
+}
+export interface PostOAuth2TokenRefreshAccessToken {
+    grant_type: PostOAuth2TokenRefreshAccessTokenGrantType;
+    client_id: string;
+    client_secret: string;
+    refresh_token: string;
+}
+export type AccessTokenIssuedTokenType = "urn:ietf:params:oauth:token-type:access_token" | (string & {});
+export type PostOAuth2TokenGrantType = "authorization_code" | "refresh_token" | "client_credentials" | "urn:ietf:params:oauth:grant-type:jwt-bearer" | "urn:ietf:params:oauth:grant-type:token-exchange" | (string & {});
+export type PostOAuth2TokenActorTokenType = "urn:ietf:params:oauth:token-type:id_token" | (string & {});
+export type PostOAuth2TokenBoxSubjectType = "enterprise" | "user" | (string & {});
+export type PostOAuth2TokenRefreshAccessTokenGrantType = "refresh_token" | (string & {});
+export type GetAuthorizeResponseType = "code" | (string & {});

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

@@ -0,0 +1,29 @@
+import type { UserMini } from '../schemas.js';
+export interface AutomateWorkflowAction {
+    id: string;
+    type: AutomateWorkflowActionType;
+    action_type: AutomateWorkflowActionType2;
+    description?: string;
+    created_at?: string;
+    updated_at?: string;
+    created_by?: UserMini;
+    updated_by?: UserMini;
+    workflow: AutomateWorkflowReference;
+}
+export interface AutomateWorkflowReference {
+    id: string;
+    type: AutomateWorkflowReferenceType;
+    name?: string;
+}
+export interface AutomateWorkflows {
+    entries?: Array<AutomateWorkflowAction>;
+    limit?: number;
+    next_marker?: string | null;
+}
+export interface AutomateWorkflowStartRequest {
+    workflow_action_id: string;
+    file_ids: Array<string>;
+}
+export type AutomateWorkflowActionType = "workflow_action" | (string & {});
+export type AutomateWorkflowActionType2 = "run_workflow" | (string & {});
+export type AutomateWorkflowReferenceType = "workflow" | (string & {});

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

@@ -0,0 +1,11 @@
+export interface UserAvatar {
+    pic_urls?: UserAvatarPicUrls;
+}
+export interface UserAvatarPicUrls {
+    small?: string;
+    large?: string;
+    preview?: string;
+}
+export interface CreateUserAvatarRequest {
+    pic: Blob;
+}

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

@@ -0,0 +1,47 @@
+import type { CollectionsOrder } from '../schemas.js';
+export interface UploadedPart {
+    part?: UploadPart;
+}
+export interface UploadPart {
+    part_id?: string;
+    offset?: number;
+    size?: number;
+    sha1?: string;
+}
+export interface UploadParts {
+    total_count?: number;
+    limit?: number;
+    offset?: number;
+    order?: Array<CollectionsOrder>;
+    entries?: Array<UploadPart>;
+}
+export interface UploadSession {
+    id?: string;
+    type?: UploadSessionType;
+    session_expires_at?: string;
+    part_size?: number;
+    total_parts?: number;
+    num_parts_processed?: number;
+    session_endpoints?: UploadSessionEndpoints;
+}
+export type UploadSessionType = "upload_session" | (string & {});
+export interface UploadSessionEndpoints {
+    upload_part?: string;
+    commit?: string;
+    abort?: string;
+    list_parts?: string;
+    status?: string;
+    log_event?: string;
+}
+export interface CreateFileUploadSessionRequest {
+    folder_id: string;
+    file_size: number;
+    file_name: string;
+}
+export interface CreateFileVersionUploadSessionRequest {
+    file_size: number;
+    file_name?: string;
+}
+export interface CommitFileUploadSessionRequest {
+    parts: Array<UploadPart>;
+}

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

@@ -0,0 +1,66 @@
+import type { ClassificationTemplate2, EnterpriseType, MetadataTemplateType } from '../schemas.js';
+export interface ClassificationTemplate {
+    id: string;
+    type: MetadataTemplateType;
+    scope: string;
+    templateKey: ClassificationTemplate2;
+    displayName: ClassificationTemplateDisplayName;
+    hidden?: boolean;
+    copyInstanceOnItemCopy?: boolean;
+    fields: Array<ClassificationTemplateFields>;
+}
+export type ClassificationTemplateDisplayName = "Classification" | (string & {});
+export type FieldsType = "enum" | (string & {});
+export type FieldsKey = "Box__Security__Classification__Key" | (string & {});
+export interface StaticConfigClassification {
+    classificationDefinition?: string;
+    colorID?: number;
+}
+export interface OptionsStaticConfig {
+    classification?: StaticConfigClassification;
+}
+export interface ClassificationTemplateFieldsOptions {
+    id: string;
+    key: string;
+    staticConfig?: OptionsStaticConfig;
+}
+export interface ClassificationTemplateFields {
+    id: string;
+    type: FieldsType;
+    key: FieldsKey;
+    displayName: ClassificationTemplateDisplayName;
+    hidden?: boolean;
+    options: Array<ClassificationTemplateFieldsOptions>;
+}
+export type PutAddOp = "addEnumOption" | (string & {});
+export interface PutAddData {
+    key: string;
+    staticConfig?: OptionsStaticConfig;
+}
+export interface UpdateClassificationAddRequest {
+    op: PutAddOp;
+    fieldKey: FieldsKey;
+    data: PutAddData;
+}
+export type PutUpdateOp = "editEnumOption" | (string & {});
+export interface UpdateClassificationUpdateRequest {
+    op: PutUpdateOp;
+    fieldKey: FieldsKey;
+    enumOptionKey: string;
+    data: PutAddData;
+}
+export interface PostMetadataTemplateSchemaClassificationsFields {
+    type: FieldsType;
+    key: FieldsKey;
+    displayName: ClassificationTemplateDisplayName;
+    hidden?: boolean;
+    options: Array<PutAddData>;
+}
+export interface CreateMetadataTemplateSchemaClassificationsRequest {
+    scope: EnterpriseType;
+    templateKey: ClassificationTemplate2;
+    displayName: ClassificationTemplateDisplayName;
+    hidden?: boolean;
+    copyInstanceOnItemCopy?: boolean;
+    fields: Array<PostMetadataTemplateSchemaClassificationsFields>;
+}

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

@@ -0,0 +1,21 @@
+import type { CollaborationAllowlistEntryEnterprise } from '../schemas.js';
+export interface CollaborationAllowlistEntries {
+    limit?: number;
+    next_marker?: string | null;
+    prev_marker?: string | null;
+    entries?: Array<CollaborationAllowlistEntry>;
+}
+export interface CollaborationAllowlistEntry {
+    id?: string;
+    type?: CollaborationAllowlistEntryType;
+    domain?: string;
+    direction?: CollaborationAllowlistEntryDirection;
+    enterprise?: CollaborationAllowlistEntryEnterprise;
+    created_at?: string;
+}
+export type CollaborationAllowlistEntryType = "collaboration_whitelist_entry" | (string & {});
+export type CollaborationAllowlistEntryDirection = "inbound" | "outbound" | "both" | (string & {});
+export interface CreateCollaborationAllowlistEntryRequest {
+    domain: string;
+    direction: CollaborationAllowlistEntryDirection;
+}

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

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

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

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

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

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

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

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

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

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

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

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

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

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