@unofficialbox/box-open-sdk 0.4.4 → 0.6.0

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

@@ -22,6 +22,7 @@ export * from './schemas/comments.js';
 export * from './schemas/device_pinners.js';
 export * from './schemas/docgen.js';
 export * from './schemas/docgen_template.js';
+export * from './schemas/document_split.js';
 export * from './schemas/email_aliases.js';
 export * from './schemas/enterprise_configurations.js';
 export * from './schemas/events.js';
@@ -61,6 +62,7 @@ export * from './schemas/shield_information_barrier_segment_restrictions.js';
 export * from './schemas/shield_information_barrier_segments.js';
 export * from './schemas/shield_information_barriers.js';
 export * from './schemas/shield_lists.js';
+export * from './schemas/shuttle.js';
 export * from './schemas/sign_requests.js';
 export * from './schemas/sign_templates.js';
 export * from './schemas/skills.js';
@@ -206,11 +208,11 @@ export type CollaborationAccessGrantee = (UserCollaborations & {
     type: string;
     [key: string]: unknown;
 };
-export type CollaborationItem = (File & {
+export type CollaborationItem = (FileMini & {
     type: "file";
-}) | (Folder & {
+}) | (FolderMini & {
     type: "folder";
-}) | (WebLink & {
+}) | (WebLinkMini & {
     type: "web_link";
 }) | {
     type: string;
@@ -220,7 +222,7 @@ export interface Collection {
     id?: string;
     type?: CollectionType;
     name?: CollectionName;
-    collection_type?: CollectionType2;
+    collection_type?: CollectionCollectionType;
 }
 export interface Comment {
     id?: string;
@@ -245,30 +247,6 @@ export interface ConflictError {
     help_url?: string;
     request_id?: string;
 }
-export interface File {
-    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?: FileSharedLink | null;
-    parent?: FolderMini | null;
-    item_status?: FileItemStatus;
-}
 export interface FileBase {
     id: string;
     etag?: string | null;
@@ -355,30 +333,6 @@ export interface FileVersionMini {
     type: FileVersionType;
     sha1?: string;
 }
-export interface Folder {
-    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?: FileSharedLink | null;
-    folder_upload_email?: FolderUploadEmail | null;
-    parent?: FolderMini | null;
-    item_status?: FileItemStatus;
-    item_collection?: Items;
-}
 export interface FolderFull {
     id: string;
     etag?: string | null;
@@ -434,7 +388,7 @@ export interface Group {
     id: string;
     type: GroupType;
     name?: string;
-    group_type?: GroupType2;
+    group_type?: GroupGroupType;
     created_at?: string;
     modified_at?: string;
 }
@@ -442,7 +396,7 @@ export interface GroupMini {
     id: string;
     type: GroupType;
     name?: string;
-    group_type?: GroupType2;
+    group_type?: GroupGroupType;
 }
 export interface IntegrationMappingBase {
     id: string;
@@ -528,7 +482,7 @@ export type Resource = (FolderMini & {
     [key: string]: unknown;
 };
 export interface ResourceScope {
-    scope?: ResourceScope2;
+    scope?: ResourceScopeScope;
     object?: Resource;
 }
 export interface RetentionPolicyBase {
@@ -544,6 +498,27 @@ export interface RetentionPolicyMini {
     max_extension_length?: RetentionPolicyMaxExtensionLengthResponse;
 }
 export type RetentionPolicyMaxExtensionLengthResponse = unknown;
+export interface SharedLinkOtpAllowlistEntry {
+    type: SharedLinkOtpAllowlistEntryType;
+    value: string;
+    created_at: string;
+    created_by: UserBase;
+}
+export interface SharedLinkOtpAllowlistEntryWritable {
+    type: SharedLinkOtpAllowlistEntryType;
+    value: string;
+}
+export type SharedLinkOtpWritable = unknown;
+export interface SharedLinkOtpWritableAllowlist {
+    mode: SharedLinkOtpWritableAllowlistMode;
+    allowlist: Array<SharedLinkOtpAllowlistEntryWritable>;
+}
+export interface SharedLinkOtpWritableNone {
+    mode: RetentionPolicyMaxExtensionLengthRequestVariant0;
+}
+export interface SharedLinkOtpWritableOpen {
+    mode: SharedLinkOtpWritableOpenMode;
+}
 export interface ShieldInformationBarrierBase {
     id?: string;
     type?: ShieldInformationBarrierType;
@@ -620,6 +595,9 @@ export type SignRequestSignerInputValidation = unknown;
 export interface SignRequestSignerInputZIP4Validation {
     validation_type: SignRequestSignerInputZIP4ValidationType;
 }
+export interface SignRequestSignerInputZIPJPValidation {
+    validation_type: SignRequestSignerInputZIPJPValidationType;
+}
 export interface SignRequestSignerInputZIPValidation {
     validation_type: SignRequestSignerInputZIPValidationType;
 }
@@ -666,7 +644,7 @@ export interface UserMini {
     login?: string;
 }
 export interface Watermark {
-    watermark?: Watermark2;
+    watermark?: WatermarkWatermark;
 }
 export interface WebLink {
     id: string;
@@ -729,7 +707,7 @@ export type AiLlmEndpointParamsOpenAiType = "openai_params" | (string & {});
 export type AppItemType = "app_item" | (string & {});
 export type ClassificationTemplate2 = "securityClassification-6VMVochwUWo" | (string & {});
 export type ClientErrorType = "error" | (string & {});
-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 & {});
+export type ClientErrorCode = "created" | "accepted" | "no_content" | "redirect" | "not_modified" | "bad_request" | "unauthorized" | "forbidden" | "not_found" | "method_not_allowed" | "conflict" | "precondition_failed" | "unprocessable_entity" | "too_many_requests" | "internal_server_error" | "unavailable" | "item_name_invalid" | "insufficient_scope" | (string & {});
 export type CollaborationType = "collaboration" | (string & {});
 export type CollaborationRole = "editor" | "viewer" | "previewer" | "uploader" | "previewer uploader" | "viewer uploader" | "co-owner" | "owner" | (string & {});
 export type CollaborationStatus = "accepted" | "pending" | "rejected" | (string & {});
@@ -763,7 +741,7 @@ export interface CollaboratorVariableValue {
 }
 export type CollectionType = "collection" | (string & {});
 export type CollectionName = "Favorites" | (string & {});
-export type CollectionType2 = "favorites" | (string & {});
+export type CollectionCollectionType = "favorites" | (string & {});
 export type OrderDirection = "ASC" | "DESC" | (string & {});
 export interface CollectionsOrder {
     by?: string;
@@ -792,6 +770,10 @@ export interface SharedLinkPermissions {
     notes_shared_link_option?: string | null;
     default_notes_shared_link_type?: string | null;
 }
+export interface SharedLinkOneTimePasscode {
+    mode: string;
+    allowlist?: Array<SharedLinkOtpAllowlistEntry>;
+}
 export interface FileSharedLink {
     url: string;
     download_url?: string | null;
@@ -805,6 +787,7 @@ export interface FileSharedLink {
     permissions?: SharedLinkPermissions;
     download_count: number;
     preview_count: number;
+    one_time_passcode: SharedLinkOneTimePasscode;
 }
 export type FileItemStatus = "active" | "trashed" | "deleted" | (string & {});
 export interface FileFullPermissions {
@@ -896,7 +879,7 @@ export interface FolderFullPermissions {
     can_apply_watermark?: boolean;
 }
 export type GroupType = "group" | (string & {});
-export type GroupType2 = "managed_group" | "all_users_group" | (string & {});
+export type GroupGroupType = "managed_group" | "all_users_group" | (string & {});
 export type LegalHoldPolicyType = "legal_hold_policy" | (string & {});
 export type LegalHoldPolicyAssignedItemType = "file" | "file_version" | "folder" | "user" | "ownership" | "interactions" | (string & {});
 export type LegalHoldPolicyAssignmentType = "legal_hold_policy_assignment" | (string & {});
@@ -904,10 +887,13 @@ export interface MetadataCascadePolicyParent {
     type?: FolderType;
     id?: string;
 }
-export type ResourceScope2 = "annotation_edit" | "annotation_view_all" | "annotation_view_self" | "base_explorer" | "base_picker" | "base_preview" | "base_upload" | "item_delete" | "item_download" | "item_preview" | "item_rename" | "item_share" | "item_upload" | "item_read" | (string & {});
+export type ResourceScopeScope = "annotation_edit" | "annotation_view_all" | "annotation_view_self" | "base_explorer" | "base_picker" | "base_preview" | "base_upload" | "item_delete" | "item_download" | "item_preview" | "item_rename" | "item_share" | "item_upload" | "item_read" | (string & {});
 export type RetentionPolicyType = "retention_policy" | (string & {});
 export type RetentionPolicyDispositionAction = "permanently_delete" | "remove_retention" | (string & {});
 export type RetentionPolicyMaxExtensionLengthRequestVariant0 = "none" | (string & {});
+export type SharedLinkOtpAllowlistEntryType = "email" | "domain" | (string & {});
+export type SharedLinkOtpWritableAllowlistMode = "allowlist" | (string & {});
+export type SharedLinkOtpWritableOpenMode = "open" | (string & {});
 export type ShieldInformationBarrierType = "shield_information_barrier" | (string & {});
 export type ShieldInformationBarrierSegmentType = "shield_information_barrier_segment" | (string & {});
 export interface ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegment {
@@ -926,6 +912,7 @@ export type SignRequestSignerInputNumberWithCommaValidationType = "number_with_c
 export type SignRequestSignerInputNumberWithPeriodValidationType = "number_with_period" | (string & {});
 export type SignRequestSignerInputSSNValidationType = "ssn" | (string & {});
 export type SignRequestSignerInputZIP4ValidationType = "zip_4" | (string & {});
+export type SignRequestSignerInputZIPJPValidationType = "zip_jp" | (string & {});
 export type SignRequestSignerInputZIPValidationType = "zip" | (string & {});
 export type StoragePolicyType = "storage_policy" | (string & {});
 export type TaskType = "task" | (string & {});
@@ -949,7 +936,7 @@ export interface UserNotificationEmail {
     email?: string;
     is_confirmed?: boolean;
 }
-export interface Watermark2 {
+export interface WatermarkWatermark {
     created_at?: string;
     modified_at?: string;
 }
@@ -966,6 +953,7 @@ export interface PutIdSharedLink {
     vanity_name?: string;
     unshared_at?: string;
     permissions?: UpdateFileRequestSharedLinkPermissions;
+    one_time_passcode?: SharedLinkOtpWritable;
 }
 export interface PostFileIdParent {
     id?: string;
@@ -1014,6 +1002,7 @@ export interface PutFileIdAddSharedLink {
     vanity_name?: string;
     unshared_at?: string;
     permissions?: UpdateFileAddSharedLinkRequestSharedLinkPermissions;
+    one_time_passcode?: SharedLinkOtpWritable;
 }
 export interface UpdateFileAddSharedLinkRequest {
     shared_link?: PutFileIdAddSharedLink;
@@ -1032,6 +1021,7 @@ export interface DocGenBatchBase {
 export interface DocGenJob {
     id: string;
     type: DocGenJobType;
+    external_id?: string;
     batch: DocGenBatchBase;
     template_file: FileReference;
     template_file_version: FileVersionBase;

package/docs/README.md

@@ -21,7 +21,7 @@ One resource manager per Box API tag, reached through the single
 | [AuthorizationManager](managers/authorization.md) | 4 |
 | [AutomateWorkflowsManager](managers/automate_workflows.md) | 2 |
 | [AvatarsManager](managers/avatars.md) | 3 |
-| [ChunkedUploadsManager](managers/chunked_uploads.md) | 7 |
+| [ChunkedUploadsManager](managers/chunked_uploads.md) | 8 |
 | [ClassificationsManager](managers/classifications.md) | 4 |
 | [CollaborationAllowlistEntriesManager](managers/collaboration_allowlist_entries.md) | 4 |
 | [CollaborationAllowlistExemptTargetsManager](managers/collaboration_allowlist_exempt_targets.md) | 4 |
@@ -30,6 +30,7 @@ One resource manager per Box API tag, reached through the single
 | [DevicePinnersManager](managers/device_pinners.md) | 3 |
 | [DocgenManager](managers/docgen.md) | 4 |
 | [DocgenTemplateManager](managers/docgen_template.md) | 6 |
+| [DocumentSplitManager](managers/document_split.md) | 3 |
 | [DownloadsManager](managers/downloads.md) | 1 |
 | [EmailAliasesManager](managers/email_aliases.md) | 3 |
 | [EnterpriseConfigurationsManager](managers/enterprise_configurations.md) | 1 |
@@ -79,6 +80,7 @@ One resource manager per Box API tag, reached through the single
 | [ShieldInformationBarrierSegmentsManager](managers/shield_information_barrier_segments.md) | 5 |
 | [ShieldInformationBarriersManager](managers/shield_information_barriers.md) | 4 |
 | [ShieldListsManager](managers/shield_lists.md) | 5 |
+| [ShuttleManager](managers/shuttle.md) | 39 |
 | [SignRequestsManager](managers/sign_requests.md) | 5 |
 | [SignTemplatesManager](managers/sign_templates.md) | 2 |
 | [SkillsManager](managers/skills.md) | 5 |

package/docs/errors.md

@@ -4,9 +4,10 @@
 Methods are `async` and surface failure by throwing — the return type only
 describes the success value. A thrown `BoxApiError` is either a transport
 failure or a non-2xx response after the network layer's retries (exponential
-backoff + jitter, `401` refresh, `Retry-After`). It carries the HTTP `status`
-when the failure came with a response, and the underlying `cause` for
-transport or decode failures:
+backoff + jitter, `401` refresh, `Retry-After`). For a non-2xx response it
+carries the HTTP `status`, Box's error `code`, `boxMessage`, and `requestId`,
+and the raw `body`; transport and decode failures carry the underlying
+`cause` instead:
 
 ```ts
 import { runtime } from '@unofficialbox/box-open-sdk';
@@ -14,7 +15,7 @@ try {
 await client.files.getFileById(fileId);
 } catch (err) {
 if (err instanceof runtime.BoxApiError) {
-// err.status (number | undefined), err.cause
+// err.status, err.code, err.boxMessage, err.requestId, err.body, err.cause
 }
 }
 ```

package/docs/managers/chunked_uploads.md

@@ -109,6 +109,24 @@ for await (const item of client.chunkedUploads.listFileUploadSessionParts("UPLOA
 
 Paginated — `listFileUploadSessionParts(...)` is an async iterable that yields each entry across pages (`for await (const item of ...)`), threading the cursor for you. See the [pagination guide](../pagination.md).
 
+## createFileUploadSessionPlan
+
+`POST /files/upload_sessions/{upload_session_id}/plan`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `upload_session_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `UploadSessionPlanRequest`
+
+**Returns:** `UploadSessionPlanResponse`
+
+**Example**
+
+```ts
+const result = await client.chunkedUploads.createFileUploadSessionPlan("UPLOAD_SESSION_ID", { /* … */ });
+```
+
 ## commitFileUploadSession
 
 `POST /files/upload_sessions/{upload_session_id}/commit`

package/docs/managers/document_split.md

@@ -0,0 +1,56 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# DocumentSplitManager
+
+Reach these methods through the `documentSplit` field on `Client`.
+
+## listDocumentSplits
+
+`GET /document_splits`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `DocumentSplits`
+
+**Example**
+
+```ts
+for await (const item of client.documentSplit.listDocumentSplits()) {
+  // use item
+}
+```
+
+Paginated — `listDocumentSplits(...)` is an async iterable that yields each entry across pages (`for await (const item of ...)`), threading the cursor for you. See the [pagination guide](../pagination.md).
+
+## createDocumentSplits
+
+`POST /document_splits`
+
+**Request body** (`application/json`): `DocumentSplitCreateRequest`
+
+**Returns:** `DocumentSplitCreateResponse`
+
+**Example**
+
+```ts
+const result = await client.documentSplit.createDocumentSplits({ /* … */ });
+```
+
+## getDocumentSplit
+
+`GET /document_splits/{document_split_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `document_split_id` | path | `string` | yes |
+
+**Returns:** `DocumentSplit`
+
+**Example**
+
+```ts
+const result = await client.documentSplit.getDocumentSplit("DOCUMENT_SPLIT_ID");
+```
+

package/docs/managers/retention_policies.md

@@ -10,7 +10,7 @@ Reach these methods through the `retentionPolicies` field on `Client`.
 | Parameter | In | Type | Required |
 |---|---|---|---|
 | `policy_name` | query | `string` | no |
-| `policy_type` | query | `RetentionPolicyType2` | no |
+| `policy_type` | query | `RetentionPolicyPolicyType` | no |
 | `created_by_user_id` | query | `string` | no |
 | `fields` | query | `Array<string>` | no |
 | `limit` | query | `number` | no |