@unofficialbox/box-open-sdk 0.1.0

package/dist/esm/managers/comments.js

@@ -0,0 +1,94 @@
+// Code generated by box-gantry. DO NOT EDIT.
+import * as runtime from '../runtime.js';
+import { pathEscape } from '../internal.js';
+/** Operations for the "comments" API area. */
+export class CommentsManager {
+    session;
+    constructor(session) {
+        this.session = session;
+    }
+    /** Iterate every `models.schemas.CommentFull` across pages, threading the offset cursor. */
+    async *listFile(fileId, opts) {
+        const options = { ...opts };
+        for (;;) {
+            const page = await this.listFilePage(fileId, options);
+            const items = page.entries ?? [];
+            for (const item of items) {
+                yield item;
+            }
+            if (items.length === 0) {
+                return;
+            }
+            options.offset = (options.offset ?? 0) + items.length;
+        }
+    }
+    async listFilePage(fileId, opts) {
+        let url = this.session.baseUrl("api");
+        url += "/files";
+        url += '/' + pathEscape(fileId);
+        url += "/comments";
+        let req = this.session.newRequest("GET", url);
+        const options = opts ?? {};
+        if (options.fields !== undefined) {
+            req = runtime.withQuery(req, "fields", options.fields.join(','));
+        }
+        if (options.limit !== undefined) {
+            req = runtime.withQuery(req, "limit", String(options.limit));
+        }
+        if (options.offset !== undefined) {
+            req = runtime.withQuery(req, "offset", String(options.offset));
+        }
+        const resp = await this.session.fetch(req);
+        const data = runtime.responseBytes(resp);
+        return JSON.parse(new TextDecoder().decode(data));
+    }
+    async get(commentId, opts) {
+        let url = this.session.baseUrl("api");
+        url += "/comments";
+        url += '/' + pathEscape(commentId);
+        let req = this.session.newRequest("GET", url);
+        const options = opts ?? {};
+        if (options.fields !== undefined) {
+            req = runtime.withQuery(req, "fields", options.fields.join(','));
+        }
+        const resp = await this.session.fetch(req);
+        const data = runtime.responseBytes(resp);
+        return JSON.parse(new TextDecoder().decode(data));
+    }
+    async update(commentId, body, opts) {
+        let url = this.session.baseUrl("api");
+        url += "/comments";
+        url += '/' + pathEscape(commentId);
+        let req = this.session.newRequest("PUT", url);
+        const options = opts ?? {};
+        if (options.fields !== undefined) {
+            req = runtime.withQuery(req, "fields", options.fields.join(','));
+        }
+        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 delete_(commentId) {
+        let url = this.session.baseUrl("api");
+        url += "/comments";
+        url += '/' + pathEscape(commentId);
+        let req = this.session.newRequest("DELETE", url);
+        await this.session.fetch(req);
+    }
+    async create(body, opts) {
+        let url = this.session.baseUrl("api");
+        url += "/comments";
+        let req = this.session.newRequest("POST", url);
+        const options = opts ?? {};
+        if (options.fields !== undefined) {
+            req = runtime.withQuery(req, "fields", options.fields.join(','));
+        }
+        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));
+    }
+}

package/dist/esm/managers/device_pinners.js

@@ -0,0 +1,62 @@
+// Code generated by box-gantry. DO NOT EDIT.
+import * as runtime from '../runtime.js';
+import { pathEscape } from '../internal.js';
+/** Operations for the "device_pinners" API area. */
+export class DevicePinnersManager {
+    session;
+    constructor(session) {
+        this.session = session;
+    }
+    async get(devicePinnerId) {
+        let url = this.session.baseUrl("api");
+        url += "/device_pinners";
+        url += '/' + pathEscape(devicePinnerId);
+        let req = this.session.newRequest("GET", url);
+        const resp = await this.session.fetch(req);
+        const data = runtime.responseBytes(resp);
+        return JSON.parse(new TextDecoder().decode(data));
+    }
+    async delete_(devicePinnerId) {
+        let url = this.session.baseUrl("api");
+        url += "/device_pinners";
+        url += '/' + pathEscape(devicePinnerId);
+        let req = this.session.newRequest("DELETE", url);
+        await this.session.fetch(req);
+    }
+    /** Iterate every `models.schemas.DevicePinner` across pages, threading the marker cursor. */
+    async *listEnterprise(enterpriseId, opts) {
+        const options = { ...opts };
+        for (;;) {
+            const page = await this.listEnterprisePage(enterpriseId, options);
+            const items = page.entries ?? [];
+            for (const item of items) {
+                yield item;
+            }
+            const cursor = page.next_marker;
+            if (cursor === undefined || cursor === null) {
+                return;
+            }
+            options.marker = String(cursor);
+        }
+    }
+    async listEnterprisePage(enterpriseId, opts) {
+        let url = this.session.baseUrl("api");
+        url += "/enterprises";
+        url += '/' + pathEscape(enterpriseId);
+        url += "/device_pinners";
+        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));
+        }
+        if (options.direction !== undefined) {
+            req = runtime.withQuery(req, "direction", options.direction);
+        }
+        const resp = await this.session.fetch(req);
+        const data = runtime.responseBytes(resp);
+        return JSON.parse(new TextDecoder().decode(data));
+    }
+}

package/dist/esm/managers/docgen.js

@@ -0,0 +1,96 @@
+// Code generated by box-gantry. DO NOT EDIT.
+import * as runtime from '../runtime.js';
+import { pathEscape } from '../internal.js';
+/** Operations for the "docgen" API area. */
+export class DocgenManager {
+    session;
+    constructor(session) {
+        this.session = session;
+    }
+    async getJob(jobId) {
+        let url = this.session.baseUrl("api");
+        url += "/docgen_jobs";
+        url += '/' + pathEscape(jobId);
+        let req = this.session.newRequest("GET", url);
+        req = runtime.withHeader(req, "box-version", "2025.0");
+        const resp = await this.session.fetch(req);
+        const data = runtime.responseBytes(resp);
+        return JSON.parse(new TextDecoder().decode(data));
+    }
+    /** Iterate every `models.schemas.DocGenJobFull` across pages, threading the marker cursor. */
+    async *listJobs(opts) {
+        const options = { ...opts };
+        for (;;) {
+            const page = await this.listJobsPage(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 listJobsPage(opts) {
+        let url = this.session.baseUrl("api");
+        url += "/docgen_jobs";
+        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", "2025.0");
+        const resp = await this.session.fetch(req);
+        const data = runtime.responseBytes(resp);
+        return JSON.parse(new TextDecoder().decode(data));
+    }
+    /** Iterate every `models.schemas.DocGenJob` across pages, threading the marker cursor. */
+    async *listBatchJob(batchId, opts) {
+        const options = { ...opts };
+        for (;;) {
+            const page = await this.listBatchJobPage(batchId, 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 listBatchJobPage(batchId, opts) {
+        let url = this.session.baseUrl("api");
+        url += "/docgen_batch_jobs";
+        url += '/' + pathEscape(batchId);
+        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", "2025.0");
+        const resp = await this.session.fetch(req);
+        const data = runtime.responseBytes(resp);
+        return JSON.parse(new TextDecoder().decode(data));
+    }
+    async createBatches(body) {
+        let url = this.session.baseUrl("api");
+        url += "/docgen_batches";
+        let req = this.session.newRequest("POST", url);
+        req = runtime.withHeader(req, "box-version", "2025.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));
+    }
+}

package/dist/esm/managers/docgen_template.js

@@ -0,0 +1,141 @@
+// Code generated by box-gantry. DO NOT EDIT.
+import * as runtime from '../runtime.js';
+import { pathEscape } from '../internal.js';
+/** Operations for the "docgen_template" API area. */
+export class DocgenTemplateManager {
+    session;
+    constructor(session) {
+        this.session = session;
+    }
+    /** Iterate every `models.schemas.DocGenTemplate` across pages, threading the marker cursor. */
+    async *listDocgenTemplates(opts) {
+        const options = { ...opts };
+        for (;;) {
+            const page = await this.listDocgenTemplatesPage(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 listDocgenTemplatesPage(opts) {
+        let url = this.session.baseUrl("api");
+        url += "/docgen_templates";
+        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", "2025.0");
+        const resp = await this.session.fetch(req);
+        const data = runtime.responseBytes(resp);
+        return JSON.parse(new TextDecoder().decode(data));
+    }
+    async createDocgenTemplates(body) {
+        let url = this.session.baseUrl("api");
+        url += "/docgen_templates";
+        let req = this.session.newRequest("POST", url);
+        req = runtime.withHeader(req, "box-version", "2025.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 getDocgenTemplate(templateId) {
+        let url = this.session.baseUrl("api");
+        url += "/docgen_templates";
+        url += '/' + pathEscape(templateId);
+        let req = this.session.newRequest("GET", url);
+        req = runtime.withHeader(req, "box-version", "2025.0");
+        const resp = await this.session.fetch(req);
+        const data = runtime.responseBytes(resp);
+        return JSON.parse(new TextDecoder().decode(data));
+    }
+    async deleteDocgenTemplate(templateId) {
+        let url = this.session.baseUrl("api");
+        url += "/docgen_templates";
+        url += '/' + pathEscape(templateId);
+        let req = this.session.newRequest("DELETE", url);
+        req = runtime.withHeader(req, "box-version", "2025.0");
+        await this.session.fetch(req);
+    }
+    /** Iterate every `models.schemas.DocGenTag` across pages, threading the marker cursor. */
+    async *listDocgenTemplateTags(templateId, opts) {
+        const options = { ...opts };
+        for (;;) {
+            const page = await this.listDocgenTemplateTagsPage(templateId, 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 listDocgenTemplateTagsPage(templateId, opts) {
+        let url = this.session.baseUrl("api");
+        url += "/docgen_templates";
+        url += '/' + pathEscape(templateId);
+        url += "/tags";
+        let req = this.session.newRequest("GET", url);
+        const options = opts ?? {};
+        if (options.template_version_id !== undefined) {
+            req = runtime.withQuery(req, "template_version_id", options.template_version_id);
+        }
+        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", "2025.0");
+        const resp = await this.session.fetch(req);
+        const data = runtime.responseBytes(resp);
+        return JSON.parse(new TextDecoder().decode(data));
+    }
+    /** Iterate every `models.schemas.DocGenJob` across pages, threading the marker cursor. */
+    async *listJob(templateId, opts) {
+        const options = { ...opts };
+        for (;;) {
+            const page = await this.listJobPage(templateId, 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 listJobPage(templateId, opts) {
+        let url = this.session.baseUrl("api");
+        url += "/docgen_template_jobs";
+        url += '/' + pathEscape(templateId);
+        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", "2025.0");
+        const resp = await this.session.fetch(req);
+        const data = runtime.responseBytes(resp);
+        return JSON.parse(new TextDecoder().decode(data));
+    }
+}

package/dist/esm/managers/downloads.js

@@ -0,0 +1,32 @@
+// Code generated by box-gantry. DO NOT EDIT.
+import * as runtime from '../runtime.js';
+import { pathEscape } from '../internal.js';
+/** Operations for the "downloads" API area. */
+export class DownloadsManager {
+    session;
+    constructor(session) {
+        this.session = session;
+    }
+    async getFileContent(fileId, opts) {
+        let url = this.session.baseUrl("api");
+        url += "/files";
+        url += '/' + pathEscape(fileId);
+        url += "/content";
+        let req = this.session.newRequest("GET", url);
+        const options = opts ?? {};
+        if (options.range !== undefined) {
+            req = runtime.withHeader(req, "range", options.range);
+        }
+        if (options.boxapi !== undefined) {
+            req = runtime.withHeader(req, "boxapi", options.boxapi);
+        }
+        if (options.version !== undefined) {
+            req = runtime.withQuery(req, "version", options.version);
+        }
+        if (options.access_token !== undefined) {
+            req = runtime.withQuery(req, "access_token", options.access_token);
+        }
+        const resp = await this.session.fetch(req);
+        return runtime.responseStream(resp);
+    }
+}

package/dist/esm/managers/email_aliases.js

@@ -0,0 +1,41 @@
+// Code generated by box-gantry. DO NOT EDIT.
+import * as runtime from '../runtime.js';
+import { pathEscape } from '../internal.js';
+/** Operations for the "email_aliases" API area. */
+export class EmailAliasesManager {
+    session;
+    constructor(session) {
+        this.session = session;
+    }
+    async listUser(userId) {
+        let url = this.session.baseUrl("api");
+        url += "/users";
+        url += '/' + pathEscape(userId);
+        url += "/email_aliases";
+        let req = this.session.newRequest("GET", url);
+        const resp = await this.session.fetch(req);
+        const data = runtime.responseBytes(resp);
+        return JSON.parse(new TextDecoder().decode(data));
+    }
+    async createUser(userId, body) {
+        let url = this.session.baseUrl("api");
+        url += "/users";
+        url += '/' + pathEscape(userId);
+        url += "/email_aliases";
+        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 deleteUser(userId, emailAliasId) {
+        let url = this.session.baseUrl("api");
+        url += "/users";
+        url += '/' + pathEscape(userId);
+        url += "/email_aliases";
+        url += '/' + pathEscape(emailAliasId);
+        let req = this.session.newRequest("DELETE", url);
+        await this.session.fetch(req);
+    }
+}

package/dist/esm/managers/enterprise_configurations.js

@@ -0,0 +1,21 @@
+// Code generated by box-gantry. DO NOT EDIT.
+import * as runtime from '../runtime.js';
+import { pathEscape } from '../internal.js';
+/** Operations for the "enterprise_configurations" API area. */
+export class EnterpriseConfigurationsManager {
+    session;
+    constructor(session) {
+        this.session = session;
+    }
+    async get(enterpriseId, categories) {
+        let url = this.session.baseUrl("api");
+        url += "/enterprise_configurations";
+        url += '/' + pathEscape(enterpriseId);
+        let req = this.session.newRequest("GET", url);
+        req = runtime.withQuery(req, "categories", categories.join(','));
+        req = runtime.withHeader(req, "box-version", "2025.0");
+        const resp = await this.session.fetch(req);
+        const data = runtime.responseBytes(resp);
+        return JSON.parse(new TextDecoder().decode(data));
+    }
+}

package/dist/esm/managers/events.js

@@ -0,0 +1,45 @@
+// Code generated by box-gantry. DO NOT EDIT.
+import * as runtime from '../runtime.js';
+import { join } from '../internal.js';
+/** Operations for the "events" API area. */
+export class EventsManager {
+    session;
+    constructor(session) {
+        this.session = session;
+    }
+    async list(opts) {
+        let url = this.session.baseUrl("api");
+        url += "/events";
+        let req = this.session.newRequest("GET", url);
+        const options = opts ?? {};
+        if (options.stream_type !== undefined) {
+            req = runtime.withQuery(req, "stream_type", options.stream_type);
+        }
+        if (options.stream_position !== undefined) {
+            req = runtime.withQuery(req, "stream_position", options.stream_position);
+        }
+        if (options.limit !== undefined) {
+            req = runtime.withQuery(req, "limit", String(options.limit));
+        }
+        if (options.event_type !== undefined) {
+            req = runtime.withQuery(req, "event_type", join(options.event_type, (v) => v));
+        }
+        if (options.created_after !== undefined) {
+            req = runtime.withQuery(req, "created_after", options.created_after);
+        }
+        if (options.created_before !== undefined) {
+            req = runtime.withQuery(req, "created_before", options.created_before);
+        }
+        const resp = await this.session.fetch(req);
+        const data = runtime.responseBytes(resp);
+        return JSON.parse(new TextDecoder().decode(data));
+    }
+    async options() {
+        let url = this.session.baseUrl("api");
+        url += "/events";
+        let req = this.session.newRequest("OPTIONS", url);
+        const resp = await this.session.fetch(req);
+        const data = runtime.responseBytes(resp);
+        return JSON.parse(new TextDecoder().decode(data));
+    }
+}

package/dist/esm/managers/external_users.js

@@ -0,0 +1,21 @@
+// Code generated by box-gantry. DO NOT EDIT.
+import * as runtime from '../runtime.js';
+/** Operations for the "external_users" API area. */
+export class ExternalUsersManager {
+    session;
+    constructor(session) {
+        this.session = session;
+    }
+    async createSubmitDeleteJob(body) {
+        let url = this.session.baseUrl("api");
+        url += "/external_users";
+        url += "/submit_delete_job";
+        let req = this.session.newRequest("POST", url);
+        req = runtime.withHeader(req, "box-version", "2025.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));
+    }
+}

package/dist/esm/managers/file_classifications.js

@@ -0,0 +1,60 @@
+// Code generated by box-gantry. DO NOT EDIT.
+import * as runtime from '../runtime.js';
+import { pathEscape } from '../internal.js';
+/** Operations for the "file_classifications" API area. */
+export class FileClassificationsManager {
+    session;
+    constructor(session) {
+        this.session = session;
+    }
+    async get(fileId) {
+        let url = this.session.baseUrl("api");
+        url += "/files";
+        url += '/' + pathEscape(fileId);
+        url += "/metadata";
+        url += "/enterprise";
+        url += "/securityClassification-6VMVochwUWo";
+        let req = this.session.newRequest("GET", url);
+        const resp = await this.session.fetch(req);
+        const data = runtime.responseBytes(resp);
+        return JSON.parse(new TextDecoder().decode(data));
+    }
+    async update(fileId, body) {
+        let url = this.session.baseUrl("api");
+        url += "/files";
+        url += '/' + pathEscape(fileId);
+        url += "/metadata";
+        url += "/enterprise";
+        url += "/securityClassification-6VMVochwUWo";
+        let req = this.session.newRequest("PUT", 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 create(fileId, body) {
+        let url = this.session.baseUrl("api");
+        url += "/files";
+        url += '/' + pathEscape(fileId);
+        url += "/metadata";
+        url += "/enterprise";
+        url += "/securityClassification-6VMVochwUWo";
+        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 delete_(fileId) {
+        let url = this.session.baseUrl("api");
+        url += "/files";
+        url += '/' + pathEscape(fileId);
+        url += "/metadata";
+        url += "/enterprise";
+        url += "/securityClassification-6VMVochwUWo";
+        let req = this.session.newRequest("DELETE", url);
+        await this.session.fetch(req);
+    }
+}