@unofficialbox/box-open-sdk 0.4.4 → 0.6.0

package/README.md

@@ -83,6 +83,19 @@ credentials (CCG)**, **OAuth 2.0** (with a pluggable refresh-token store), and
 **JWT** (server auth, exposed as the Node-only `./jwt` subpath). See
 [`docs/auth.md`](./docs/auth.md).
 
+## HTTP versions
+
+Requests go through the platform `fetch`, so the platform picks the protocol:
+browsers, Deno, and Bun negotiate HTTP/2 or HTTP/3, while Node's built-in
+`fetch` uses HTTP/1.1. For HTTP/2 from Node, pass a `fetch` that dispatches
+through an undici `Agent` with `allowH2: true`:
+
+```ts
+const client = new Client(auth.developerToken('DEVELOPER_TOKEN'), { fetch: h2Fetch });
+```
+
+The same options set `maxRetries`, default `headers`, and `baseUrls`.
+
 ## Documentation
 
 The [`docs/`](./docs/README.md) tree carries the per-manager reference and the

package/dist/cjs/buildinfo.js

@@ -1,10 +1,10 @@
 "use strict";
-// Code generated by box-gantry 0.1.0 (spec 3fb3510fe12f2f80). DO NOT EDIT.
+// Code generated by box-gantry 0.1.0 (spec 3283827dcf199770). DO NOT EDIT.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TARGET = exports.SPEC_FINGERPRINT = exports.ENGINE = void 0;
 /** The box-gantry engine version that generated this SDK. */
 exports.ENGINE = "0.1.0";
 /** Fingerprint of the input spec set. */
-exports.SPEC_FINGERPRINT = "3fb3510fe12f2f80";
+exports.SPEC_FINGERPRINT = "3283827dcf199770";
 /** The target language key (FR-4). */
 exports.TARGET = "typescript";

package/dist/cjs/client.js

@@ -19,6 +19,7 @@ const comments_js_1 = require("./managers/comments.js");
 const device_pinners_js_1 = require("./managers/device_pinners.js");
 const docgen_js_1 = require("./managers/docgen.js");
 const docgen_template_js_1 = require("./managers/docgen_template.js");
+const document_split_js_1 = require("./managers/document_split.js");
 const downloads_js_1 = require("./managers/downloads.js");
 const email_aliases_js_1 = require("./managers/email_aliases.js");
 const enterprise_configurations_js_1 = require("./managers/enterprise_configurations.js");
@@ -68,6 +69,7 @@ const shield_information_barrier_segment_restrictions_js_1 = require("./managers
 const shield_information_barrier_segments_js_1 = require("./managers/shield_information_barrier_segments.js");
 const shield_information_barriers_js_1 = require("./managers/shield_information_barriers.js");
 const shield_lists_js_1 = require("./managers/shield_lists.js");
+const shuttle_js_1 = require("./managers/shuttle.js");
 const sign_requests_js_1 = require("./managers/sign_requests.js");
 const sign_templates_js_1 = require("./managers/sign_templates.js");
 const skills_js_1 = require("./managers/skills.js");
@@ -107,6 +109,7 @@ class Client {
     devicePinners;
     docgen;
     docgenTemplate;
+    documentSplit;
     downloads;
     emailAliases;
     enterpriseConfigurations;
@@ -156,6 +159,7 @@ class Client {
     shieldInformationBarrierSegments;
     shieldInformationBarriers;
     shieldLists;
+    shuttle;
     signRequests;
     signTemplates;
     skills;
@@ -177,9 +181,10 @@ class Client {
     webhooks;
     workflows;
     zipDownloads;
-    /** Build a client for an authentication flow. */
-    constructor(auth) {
-        const session = new runtime_js_1.Client(auth);
+    /** Build a client for an authentication flow; `options` configures the
+     * runtime session (retries, `fetch`, default headers, base URLs). */
+    constructor(auth, options = {}) {
+        const session = new runtime_js_1.Client(auth, options);
         this.ai = new ai_js_1.AiManager(session);
         this.aiStudio = new ai_studio_js_1.AiStudioManager(session);
         this.appItemAssociations = new app_item_associations_js_1.AppItemAssociationsManager(session);
@@ -196,6 +201,7 @@ class Client {
         this.devicePinners = new device_pinners_js_1.DevicePinnersManager(session);
         this.docgen = new docgen_js_1.DocgenManager(session);
         this.docgenTemplate = new docgen_template_js_1.DocgenTemplateManager(session);
+        this.documentSplit = new document_split_js_1.DocumentSplitManager(session);
         this.downloads = new downloads_js_1.DownloadsManager(session);
         this.emailAliases = new email_aliases_js_1.EmailAliasesManager(session);
         this.enterpriseConfigurations = new enterprise_configurations_js_1.EnterpriseConfigurationsManager(session);
@@ -245,6 +251,7 @@ class Client {
         this.shieldInformationBarrierSegments = new shield_information_barrier_segments_js_1.ShieldInformationBarrierSegmentsManager(session);
         this.shieldInformationBarriers = new shield_information_barriers_js_1.ShieldInformationBarriersManager(session);
         this.shieldLists = new shield_lists_js_1.ShieldListsManager(session);
+        this.shuttle = new shuttle_js_1.ShuttleManager(session);
         this.signRequests = new sign_requests_js_1.SignRequestsManager(session);
         this.signTemplates = new sign_templates_js_1.SignTemplatesManager(session);
         this.skills = new skills_js_1.SkillsManager(session);

package/dist/cjs/errors.js

@@ -2,6 +2,7 @@
 // Code generated by box-gantry (vendored from runtimes/typescript/gantryruntime/src/errors.ts). DO NOT EDIT.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BoxApiError = void 0;
+exports.apiErrorFromResponse = apiErrorFromResponse;
 /**
  * A runtime error: a failed request, auth acquisition, or body decode. The
  * generated SDK's exceptions model (TR-TS.3) surfaces every failure as a thrown
@@ -11,10 +12,56 @@ exports.BoxApiError = void 0;
 class BoxApiError extends Error {
     /** The HTTP status, when the error carries a response. */
     status;
+    /** Box's error `code` (e.g. `not_found`), when the body was a Box error. */
+    code;
+    /** Box's error `message`, when the body was a Box error. */
+    boxMessage;
+    /** Box's `request_id`, when the body was a Box error. */
+    requestId;
+    /** The raw response body of a non-2xx response. */
+    body;
     constructor(message, options = {}) {
         super(message, options.cause !== undefined ? { cause: options.cause } : undefined);
         this.name = 'BoxApiError';
         this.status = options.status;
+        this.code = options.code;
+        this.boxMessage = options.boxMessage;
+        this.requestId = options.requestId;
+        this.body = options.body;
     }
 }
 exports.BoxApiError = BoxApiError;
+/** The error for a non-2xx response: `Client.fetch` throws it once the retry
+ * budget and the single 401 refresh are spent, so a caller never mistakes an
+ * error body for a result. Box's error fields are read from the body when it
+ * is a Box error object; the raw body is kept either way. */
+function apiErrorFromResponse(status, body) {
+    let payload;
+    try {
+        payload = JSON.parse(new TextDecoder().decode(body));
+    }
+    catch {
+        payload = undefined;
+    }
+    const field = (key) => {
+        if (typeof payload !== 'object' || payload === null) {
+            return undefined;
+        }
+        const value = payload[key];
+        return typeof value === 'string' ? value : undefined;
+    };
+    const code = field('code');
+    const boxMessage = field('message');
+    const requestId = field('request_id');
+    let message = `box: status ${status}`;
+    if (code !== undefined) {
+        message += ` ${code}`;
+    }
+    if (boxMessage !== undefined) {
+        message += `: ${boxMessage}`;
+    }
+    if (requestId !== undefined) {
+        message += ` (request_id ${requestId})`;
+    }
+    return new BoxApiError(message, { status, code, boxMessage, requestId, body });
+}

package/dist/cjs/managers/chunked_uploads.js

@@ -131,6 +131,19 @@ class ChunkedUploadsManager {
         const data = runtime.responseBytes(resp);
         return JSON.parse(new TextDecoder().decode(data));
     }
+    async createFileUploadSessionPlan(uploadSessionId, body) {
+        let url = this.session.baseUrl("upload_session");
+        url += "/files";
+        url += "/upload_sessions";
+        url += '/' + (0, internal_js_1.pathEscape)(uploadSessionId);
+        url += "/plan";
+        let req = this.session.newRequest("POST", url);
+        const payload = new TextEncoder().encode(JSON.stringify(body));
+        req = runtime.withJsonBody(req, payload);
+        const resp = await this.session.fetch(req);
+        const data = runtime.responseBytes(resp);
+        return JSON.parse(new TextDecoder().decode(data));
+    }
     async commitFileUploadSession(uploadSessionId, digest, body, opts) {
         let url = this.session.baseUrl("upload_session");
         url += "/files";

package/dist/cjs/managers/document_split.js

@@ -0,0 +1,100 @@
+"use strict";
+// Code generated by box-gantry. DO NOT EDIT.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentSplitManager = void 0;
+const runtime = __importStar(require("../runtime.js"));
+const internal_js_1 = require("../internal.js");
+/** Operations for the "document_split" API area. */
+class DocumentSplitManager {
+    session;
+    constructor(session) {
+        this.session = session;
+    }
+    /** Iterate every `models.schemas.DocumentSplit` across pages, threading the marker cursor. */
+    async *listDocumentSplits(opts) {
+        const options = { ...opts };
+        for (;;) {
+            const page = await this.listDocumentSplitsPage(options);
+            const items = page.entries ?? [];
+            for (const item of items) {
+                yield item;
+            }
+            const cursor = page.next_marker;
+            if (cursor === undefined || cursor === null || cursor === '') {
+                return;
+            }
+            options.marker = cursor;
+        }
+    }
+    async listDocumentSplitsPage(opts) {
+        let url = this.session.baseUrl("api");
+        url += "/document_splits";
+        let req = this.session.newRequest("GET", url);
+        const options = opts ?? {};
+        if (options.marker !== undefined) {
+            req = runtime.withQuery(req, "marker", options.marker);
+        }
+        if (options.limit !== undefined) {
+            req = runtime.withQuery(req, "limit", String(options.limit));
+        }
+        req = runtime.withHeader(req, "box-version", "2026.0");
+        const resp = await this.session.fetch(req);
+        const data = runtime.responseBytes(resp);
+        return JSON.parse(new TextDecoder().decode(data));
+    }
+    async createDocumentSplits(body) {
+        let url = this.session.baseUrl("api");
+        url += "/document_splits";
+        let req = this.session.newRequest("POST", url);
+        req = runtime.withHeader(req, "box-version", "2026.0");
+        const payload = new TextEncoder().encode(JSON.stringify(body));
+        req = runtime.withJsonBody(req, payload);
+        const resp = await this.session.fetch(req);
+        const data = runtime.responseBytes(resp);
+        return JSON.parse(new TextDecoder().decode(data));
+    }
+    async getDocumentSplit(documentSplitId) {
+        let url = this.session.baseUrl("api");
+        url += "/document_splits";
+        url += '/' + (0, internal_js_1.pathEscape)(documentSplitId);
+        let req = this.session.newRequest("GET", url);
+        req = runtime.withHeader(req, "box-version", "2026.0");
+        const resp = await this.session.fetch(req);
+        const data = runtime.responseBytes(resp);
+        return JSON.parse(new TextDecoder().decode(data));
+    }
+}
+exports.DocumentSplitManager = DocumentSplitManager;

package/dist/cjs/managers/index.js

@@ -31,6 +31,7 @@ __exportStar(require("./comments.js"), exports);
 __exportStar(require("./device_pinners.js"), exports);
 __exportStar(require("./docgen.js"), exports);
 __exportStar(require("./docgen_template.js"), exports);
+__exportStar(require("./document_split.js"), exports);
 __exportStar(require("./downloads.js"), exports);
 __exportStar(require("./email_aliases.js"), exports);
 __exportStar(require("./enterprise_configurations.js"), exports);
@@ -80,6 +81,7 @@ __exportStar(require("./shield_information_barrier_segment_restrictions.js"), ex
 __exportStar(require("./shield_information_barrier_segments.js"), exports);
 __exportStar(require("./shield_information_barriers.js"), exports);
 __exportStar(require("./shield_lists.js"), exports);
+__exportStar(require("./shuttle.js"), exports);
 __exportStar(require("./sign_requests.js"), exports);
 __exportStar(require("./sign_templates.js"), exports);
 __exportStar(require("./skills.js"), exports);