box-node-sdk 3.8.2 → 4.0.0

package/lib-esm/sdk-gen/managers/fileRequests.d.ts

@@ -0,0 +1,189 @@
+import { FileRequest } from '../schemas/fileRequest';
+import { FileRequestUpdateRequest } from '../schemas/fileRequestUpdateRequest';
+import { FileRequestCopyRequest } from '../schemas/fileRequestCopyRequest';
+import { Authentication } from '../networking/auth';
+import { NetworkSession } from '../networking/network';
+import { CancellationToken } from '../internal/utils';
+export declare class GetFileRequestByIdOptionals {
+    readonly headers: GetFileRequestByIdHeaders;
+    readonly cancellationToken?: CancellationToken;
+    constructor(fields: Omit<GetFileRequestByIdOptionals, 'headers' | 'cancellationToken'> & Partial<Pick<GetFileRequestByIdOptionals, 'headers' | 'cancellationToken'>>);
+}
+export interface GetFileRequestByIdOptionalsInput {
+    readonly headers?: GetFileRequestByIdHeaders;
+    readonly cancellationToken?: undefined | CancellationToken;
+}
+export declare class UpdateFileRequestByIdOptionals {
+    readonly headers: UpdateFileRequestByIdHeaders;
+    readonly cancellationToken?: CancellationToken;
+    constructor(fields: Omit<UpdateFileRequestByIdOptionals, 'headers' | 'cancellationToken'> & Partial<Pick<UpdateFileRequestByIdOptionals, 'headers' | 'cancellationToken'>>);
+}
+export interface UpdateFileRequestByIdOptionalsInput {
+    readonly headers?: UpdateFileRequestByIdHeaders;
+    readonly cancellationToken?: undefined | CancellationToken;
+}
+export declare class DeleteFileRequestByIdOptionals {
+    readonly headers: DeleteFileRequestByIdHeaders;
+    readonly cancellationToken?: CancellationToken;
+    constructor(fields: Omit<DeleteFileRequestByIdOptionals, 'headers' | 'cancellationToken'> & Partial<Pick<DeleteFileRequestByIdOptionals, 'headers' | 'cancellationToken'>>);
+}
+export interface DeleteFileRequestByIdOptionalsInput {
+    readonly headers?: DeleteFileRequestByIdHeaders;
+    readonly cancellationToken?: undefined | CancellationToken;
+}
+export declare class CreateFileRequestCopyOptionals {
+    readonly headers: CreateFileRequestCopyHeaders;
+    readonly cancellationToken?: CancellationToken;
+    constructor(fields: Omit<CreateFileRequestCopyOptionals, 'headers' | 'cancellationToken'> & Partial<Pick<CreateFileRequestCopyOptionals, 'headers' | 'cancellationToken'>>);
+}
+export interface CreateFileRequestCopyOptionalsInput {
+    readonly headers?: CreateFileRequestCopyHeaders;
+    readonly cancellationToken?: undefined | CancellationToken;
+}
+export declare class GetFileRequestByIdHeaders {
+    /**
+     * Extra headers that will be included in the HTTP request. */
+    readonly extraHeaders?: {
+        readonly [key: string]: undefined | string;
+    };
+    constructor(fields: Omit<GetFileRequestByIdHeaders, 'extraHeaders'> & Partial<Pick<GetFileRequestByIdHeaders, 'extraHeaders'>>);
+}
+export interface GetFileRequestByIdHeadersInput {
+    /**
+     * Extra headers that will be included in the HTTP request. */
+    readonly extraHeaders?: undefined | {
+        readonly [key: string]: undefined | string;
+    };
+}
+export declare class UpdateFileRequestByIdHeaders {
+    /**
+     * Ensures this item hasn't recently changed before
+     * making changes.
+     *
+     * Pass in the item's last observed `etag` value
+     * into this header and the endpoint will fail
+     * with a `412 Precondition Failed` if it
+     * has changed since. */
+    readonly ifMatch?: string;
+    /**
+     * Extra headers that will be included in the HTTP request. */
+    readonly extraHeaders?: {
+        readonly [key: string]: undefined | string;
+    };
+    constructor(fields: Omit<UpdateFileRequestByIdHeaders, 'extraHeaders'> & Partial<Pick<UpdateFileRequestByIdHeaders, 'extraHeaders'>>);
+}
+export interface UpdateFileRequestByIdHeadersInput {
+    /**
+     * Ensures this item hasn't recently changed before
+     * making changes.
+     *
+     * Pass in the item's last observed `etag` value
+     * into this header and the endpoint will fail
+     * with a `412 Precondition Failed` if it
+     * has changed since. */
+    readonly ifMatch?: string;
+    /**
+     * Extra headers that will be included in the HTTP request. */
+    readonly extraHeaders?: undefined | {
+        readonly [key: string]: undefined | string;
+    };
+}
+export declare class DeleteFileRequestByIdHeaders {
+    /**
+     * Extra headers that will be included in the HTTP request. */
+    readonly extraHeaders?: {
+        readonly [key: string]: undefined | string;
+    };
+    constructor(fields: Omit<DeleteFileRequestByIdHeaders, 'extraHeaders'> & Partial<Pick<DeleteFileRequestByIdHeaders, 'extraHeaders'>>);
+}
+export interface DeleteFileRequestByIdHeadersInput {
+    /**
+     * Extra headers that will be included in the HTTP request. */
+    readonly extraHeaders?: undefined | {
+        readonly [key: string]: undefined | string;
+    };
+}
+export declare class CreateFileRequestCopyHeaders {
+    /**
+     * Extra headers that will be included in the HTTP request. */
+    readonly extraHeaders?: {
+        readonly [key: string]: undefined | string;
+    };
+    constructor(fields: Omit<CreateFileRequestCopyHeaders, 'extraHeaders'> & Partial<Pick<CreateFileRequestCopyHeaders, 'extraHeaders'>>);
+}
+export interface CreateFileRequestCopyHeadersInput {
+    /**
+     * Extra headers that will be included in the HTTP request. */
+    readonly extraHeaders?: undefined | {
+        readonly [key: string]: undefined | string;
+    };
+}
+export declare class FileRequestsManager {
+    readonly auth?: Authentication;
+    readonly networkSession: NetworkSession;
+    constructor(fields: Omit<FileRequestsManager, 'networkSession' | 'getFileRequestById' | 'updateFileRequestById' | 'deleteFileRequestById' | 'createFileRequestCopy'> & Partial<Pick<FileRequestsManager, 'networkSession'>>);
+    /**
+       * Retrieves the information about a file request.
+       * @param {string} fileRequestId The unique identifier that represent a file request.
+      
+      The ID for any file request can be determined
+      by visiting a file request builder in the web application
+      and copying the ID from the URL. For example,
+      for the URL `https://*.app.box.com/filerequest/123`
+      the `file_request_id` is `123`.
+      Example: "123"
+       * @param {GetFileRequestByIdOptionalsInput} optionalsInput
+       * @returns {Promise<FileRequest>}
+       */
+    getFileRequestById(fileRequestId: string, optionalsInput?: GetFileRequestByIdOptionalsInput): Promise<FileRequest>;
+    /**
+       * Updates a file request. This can be used to activate or
+       * deactivate a file request.
+       * @param {string} fileRequestId The unique identifier that represent a file request.
+      
+      The ID for any file request can be determined
+      by visiting a file request builder in the web application
+      and copying the ID from the URL. For example,
+      for the URL `https://*.app.box.com/filerequest/123`
+      the `file_request_id` is `123`.
+      Example: "123"
+       * @param {FileRequestUpdateRequest} requestBody Request body of updateFileRequestById method
+       * @param {UpdateFileRequestByIdOptionalsInput} optionalsInput
+       * @returns {Promise<FileRequest>}
+       */
+    updateFileRequestById(fileRequestId: string, requestBody: FileRequestUpdateRequest, optionalsInput?: UpdateFileRequestByIdOptionalsInput): Promise<FileRequest>;
+    /**
+       * Deletes a file request permanently.
+       * @param {string} fileRequestId The unique identifier that represent a file request.
+      
+      The ID for any file request can be determined
+      by visiting a file request builder in the web application
+      and copying the ID from the URL. For example,
+      for the URL `https://*.app.box.com/filerequest/123`
+      the `file_request_id` is `123`.
+      Example: "123"
+       * @param {DeleteFileRequestByIdOptionalsInput} optionalsInput
+       * @returns {Promise<undefined>}
+       */
+    deleteFileRequestById(fileRequestId: string, optionalsInput?: DeleteFileRequestByIdOptionalsInput): Promise<undefined>;
+    /**
+       * Copies an existing file request that is already present on one folder,
+       * and applies it to another folder.
+       * @param {string} fileRequestId The unique identifier that represent a file request.
+      
+      The ID for any file request can be determined
+      by visiting a file request builder in the web application
+      and copying the ID from the URL. For example,
+      for the URL `https://*.app.box.com/filerequest/123`
+      the `file_request_id` is `123`.
+      Example: "123"
+       * @param {FileRequestCopyRequest} requestBody Request body of createFileRequestCopy method
+       * @param {CreateFileRequestCopyOptionalsInput} optionalsInput
+       * @returns {Promise<FileRequest>}
+       */
+    createFileRequestCopy(fileRequestId: string, requestBody: FileRequestCopyRequest, optionalsInput?: CreateFileRequestCopyOptionalsInput): Promise<FileRequest>;
+}
+export interface FileRequestsManagerInput {
+    readonly auth?: Authentication;
+    readonly networkSession?: NetworkSession;
+}

package/lib-esm/sdk-gen/managers/fileRequests.js

@@ -0,0 +1,280 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileRequestsManager = exports.CreateFileRequestCopyHeaders = exports.DeleteFileRequestByIdHeaders = exports.UpdateFileRequestByIdHeaders = exports.GetFileRequestByIdHeaders = exports.CreateFileRequestCopyOptionals = exports.DeleteFileRequestByIdOptionals = exports.UpdateFileRequestByIdOptionals = exports.GetFileRequestByIdOptionals = void 0;
+const fileRequest_1 = require("../schemas/fileRequest");
+const fileRequestUpdateRequest_1 = require("../schemas/fileRequestUpdateRequest");
+const fileRequestCopyRequest_1 = require("../schemas/fileRequestCopyRequest");
+const network_1 = require("../networking/network");
+const fetchOptions_1 = require("../networking/fetchOptions");
+const utils_1 = require("../internal/utils");
+const utils_2 = require("../internal/utils");
+class GetFileRequestByIdOptionals {
+    headers = new GetFileRequestByIdHeaders({});
+    cancellationToken = void 0;
+    constructor(fields) {
+        if (fields.headers !== undefined) {
+            this.headers = fields.headers;
+        }
+        if (fields.cancellationToken !== undefined) {
+            this.cancellationToken = fields.cancellationToken;
+        }
+    }
+}
+exports.GetFileRequestByIdOptionals = GetFileRequestByIdOptionals;
+class UpdateFileRequestByIdOptionals {
+    headers = new UpdateFileRequestByIdHeaders({});
+    cancellationToken = void 0;
+    constructor(fields) {
+        if (fields.headers !== undefined) {
+            this.headers = fields.headers;
+        }
+        if (fields.cancellationToken !== undefined) {
+            this.cancellationToken = fields.cancellationToken;
+        }
+    }
+}
+exports.UpdateFileRequestByIdOptionals = UpdateFileRequestByIdOptionals;
+class DeleteFileRequestByIdOptionals {
+    headers = new DeleteFileRequestByIdHeaders({});
+    cancellationToken = void 0;
+    constructor(fields) {
+        if (fields.headers !== undefined) {
+            this.headers = fields.headers;
+        }
+        if (fields.cancellationToken !== undefined) {
+            this.cancellationToken = fields.cancellationToken;
+        }
+    }
+}
+exports.DeleteFileRequestByIdOptionals = DeleteFileRequestByIdOptionals;
+class CreateFileRequestCopyOptionals {
+    headers = new CreateFileRequestCopyHeaders({});
+    cancellationToken = void 0;
+    constructor(fields) {
+        if (fields.headers !== undefined) {
+            this.headers = fields.headers;
+        }
+        if (fields.cancellationToken !== undefined) {
+            this.cancellationToken = fields.cancellationToken;
+        }
+    }
+}
+exports.CreateFileRequestCopyOptionals = CreateFileRequestCopyOptionals;
+class GetFileRequestByIdHeaders {
+    /**
+     * Extra headers that will be included in the HTTP request. */
+    extraHeaders = {};
+    constructor(fields) {
+        if (fields.extraHeaders !== undefined) {
+            this.extraHeaders = fields.extraHeaders;
+        }
+    }
+}
+exports.GetFileRequestByIdHeaders = GetFileRequestByIdHeaders;
+class UpdateFileRequestByIdHeaders {
+    /**
+     * Ensures this item hasn't recently changed before
+     * making changes.
+     *
+     * Pass in the item's last observed `etag` value
+     * into this header and the endpoint will fail
+     * with a `412 Precondition Failed` if it
+     * has changed since. */
+    ifMatch;
+    /**
+     * Extra headers that will be included in the HTTP request. */
+    extraHeaders = {};
+    constructor(fields) {
+        if (fields.ifMatch !== undefined) {
+            this.ifMatch = fields.ifMatch;
+        }
+        if (fields.extraHeaders !== undefined) {
+            this.extraHeaders = fields.extraHeaders;
+        }
+    }
+}
+exports.UpdateFileRequestByIdHeaders = UpdateFileRequestByIdHeaders;
+class DeleteFileRequestByIdHeaders {
+    /**
+     * Extra headers that will be included in the HTTP request. */
+    extraHeaders = {};
+    constructor(fields) {
+        if (fields.extraHeaders !== undefined) {
+            this.extraHeaders = fields.extraHeaders;
+        }
+    }
+}
+exports.DeleteFileRequestByIdHeaders = DeleteFileRequestByIdHeaders;
+class CreateFileRequestCopyHeaders {
+    /**
+     * Extra headers that will be included in the HTTP request. */
+    extraHeaders = {};
+    constructor(fields) {
+        if (fields.extraHeaders !== undefined) {
+            this.extraHeaders = fields.extraHeaders;
+        }
+    }
+}
+exports.CreateFileRequestCopyHeaders = CreateFileRequestCopyHeaders;
+class FileRequestsManager {
+    auth;
+    networkSession = new network_1.NetworkSession({});
+    constructor(fields) {
+        if (fields.auth !== undefined) {
+            this.auth = fields.auth;
+        }
+        if (fields.networkSession !== undefined) {
+            this.networkSession = fields.networkSession;
+        }
+    }
+    /**
+       * Retrieves the information about a file request.
+       * @param {string} fileRequestId The unique identifier that represent a file request.
+      
+      The ID for any file request can be determined
+      by visiting a file request builder in the web application
+      and copying the ID from the URL. For example,
+      for the URL `https://*.app.box.com/filerequest/123`
+      the `file_request_id` is `123`.
+      Example: "123"
+       * @param {GetFileRequestByIdOptionalsInput} optionalsInput
+       * @returns {Promise<FileRequest>}
+       */
+    async getFileRequestById(fileRequestId, optionalsInput = {}) {
+        const optionals = new GetFileRequestByIdOptionals({
+            headers: optionalsInput.headers,
+            cancellationToken: optionalsInput.cancellationToken,
+        });
+        const headers = optionals.headers;
+        const cancellationToken = optionals.cancellationToken;
+        const headersMap = (0, utils_1.prepareParams)({ ...{}, ...headers.extraHeaders });
+        const response = await this.networkSession.networkClient.fetch(new fetchOptions_1.FetchOptions({
+            url: ''.concat(this.networkSession.baseUrls.baseUrl, '/2.0/file_requests/', (0, utils_2.toString)(fileRequestId)),
+            method: 'GET',
+            headers: headersMap,
+            responseFormat: 'json',
+            auth: this.auth,
+            networkSession: this.networkSession,
+            cancellationToken: cancellationToken,
+        }));
+        return {
+            ...(0, fileRequest_1.deserializeFileRequest)(response.data),
+            rawData: response.data,
+        };
+    }
+    /**
+       * Updates a file request. This can be used to activate or
+       * deactivate a file request.
+       * @param {string} fileRequestId The unique identifier that represent a file request.
+      
+      The ID for any file request can be determined
+      by visiting a file request builder in the web application
+      and copying the ID from the URL. For example,
+      for the URL `https://*.app.box.com/filerequest/123`
+      the `file_request_id` is `123`.
+      Example: "123"
+       * @param {FileRequestUpdateRequest} requestBody Request body of updateFileRequestById method
+       * @param {UpdateFileRequestByIdOptionalsInput} optionalsInput
+       * @returns {Promise<FileRequest>}
+       */
+    async updateFileRequestById(fileRequestId, requestBody, optionalsInput = {}) {
+        const optionals = new UpdateFileRequestByIdOptionals({
+            headers: optionalsInput.headers,
+            cancellationToken: optionalsInput.cancellationToken,
+        });
+        const headers = optionals.headers;
+        const cancellationToken = optionals.cancellationToken;
+        const headersMap = (0, utils_1.prepareParams)({
+            ...{ ['if-match']: (0, utils_2.toString)(headers.ifMatch) },
+            ...headers.extraHeaders,
+        });
+        const response = await this.networkSession.networkClient.fetch(new fetchOptions_1.FetchOptions({
+            url: ''.concat(this.networkSession.baseUrls.baseUrl, '/2.0/file_requests/', (0, utils_2.toString)(fileRequestId)),
+            method: 'PUT',
+            headers: headersMap,
+            data: (0, fileRequestUpdateRequest_1.serializeFileRequestUpdateRequest)(requestBody),
+            contentType: 'application/json',
+            responseFormat: 'json',
+            auth: this.auth,
+            networkSession: this.networkSession,
+            cancellationToken: cancellationToken,
+        }));
+        return {
+            ...(0, fileRequest_1.deserializeFileRequest)(response.data),
+            rawData: response.data,
+        };
+    }
+    /**
+       * Deletes a file request permanently.
+       * @param {string} fileRequestId The unique identifier that represent a file request.
+      
+      The ID for any file request can be determined
+      by visiting a file request builder in the web application
+      and copying the ID from the URL. For example,
+      for the URL `https://*.app.box.com/filerequest/123`
+      the `file_request_id` is `123`.
+      Example: "123"
+       * @param {DeleteFileRequestByIdOptionalsInput} optionalsInput
+       * @returns {Promise<undefined>}
+       */
+    async deleteFileRequestById(fileRequestId, optionalsInput = {}) {
+        const optionals = new DeleteFileRequestByIdOptionals({
+            headers: optionalsInput.headers,
+            cancellationToken: optionalsInput.cancellationToken,
+        });
+        const headers = optionals.headers;
+        const cancellationToken = optionals.cancellationToken;
+        const headersMap = (0, utils_1.prepareParams)({ ...{}, ...headers.extraHeaders });
+        const response = await this.networkSession.networkClient.fetch(new fetchOptions_1.FetchOptions({
+            url: ''.concat(this.networkSession.baseUrls.baseUrl, '/2.0/file_requests/', (0, utils_2.toString)(fileRequestId)),
+            method: 'DELETE',
+            headers: headersMap,
+            responseFormat: 'no_content',
+            auth: this.auth,
+            networkSession: this.networkSession,
+            cancellationToken: cancellationToken,
+        }));
+        return void 0;
+    }
+    /**
+       * Copies an existing file request that is already present on one folder,
+       * and applies it to another folder.
+       * @param {string} fileRequestId The unique identifier that represent a file request.
+      
+      The ID for any file request can be determined
+      by visiting a file request builder in the web application
+      and copying the ID from the URL. For example,
+      for the URL `https://*.app.box.com/filerequest/123`
+      the `file_request_id` is `123`.
+      Example: "123"
+       * @param {FileRequestCopyRequest} requestBody Request body of createFileRequestCopy method
+       * @param {CreateFileRequestCopyOptionalsInput} optionalsInput
+       * @returns {Promise<FileRequest>}
+       */
+    async createFileRequestCopy(fileRequestId, requestBody, optionalsInput = {}) {
+        const optionals = new CreateFileRequestCopyOptionals({
+            headers: optionalsInput.headers,
+            cancellationToken: optionalsInput.cancellationToken,
+        });
+        const headers = optionals.headers;
+        const cancellationToken = optionals.cancellationToken;
+        const headersMap = (0, utils_1.prepareParams)({ ...{}, ...headers.extraHeaders });
+        const response = await this.networkSession.networkClient.fetch(new fetchOptions_1.FetchOptions({
+            url: ''.concat(this.networkSession.baseUrls.baseUrl, '/2.0/file_requests/', (0, utils_2.toString)(fileRequestId), '/copy'),
+            method: 'POST',
+            headers: headersMap,
+            data: (0, fileRequestCopyRequest_1.serializeFileRequestCopyRequest)(requestBody),
+            contentType: 'application/json',
+            responseFormat: 'json',
+            auth: this.auth,
+            networkSession: this.networkSession,
+            cancellationToken: cancellationToken,
+        }));
+        return {
+            ...(0, fileRequest_1.deserializeFileRequest)(response.data),
+            rawData: response.data,
+        };
+    }
+}
+exports.FileRequestsManager = FileRequestsManager;
+//# sourceMappingURL=fileRequests.js.map

package/lib-esm/sdk-gen/managers/fileRequests.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileRequests.js","sourceRoot":"","sources":["../../../src/sdk-gen/managers/fileRequests.ts"],"names":[],"mappings":";;;AACA,wDAAgE;AAGhE,kFAAwF;AAExF,8EAAoF;AASpF,mDAAuD;AACvD,6DAA0D;AAE1D,6CAAkD;AAClD,6CAA6C;AAW7C,MAAa,2BAA2B;IAC7B,OAAO,GAA8B,IAAI,yBAAyB,CACzE,EAAE,CACH,CAAC;IACO,iBAAiB,GAAuB,KAAK,CAAC,CAAC;IACxD,YACE,MAGG;QAEH,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACjC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAChC,CAAC;QACD,IAAI,MAAM,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;YAC3C,IAAI,CAAC,iBAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAC;QACpD,CAAC;IACH,CAAC;CACF;AAlBD,kEAkBC;AAKD,MAAa,8BAA8B;IAChC,OAAO,GACd,IAAI,4BAA4B,CAAC,EAAE,CAAC,CAAC;IAC9B,iBAAiB,GAAuB,KAAK,CAAC,CAAC;IACxD,YACE,MAMG;QAEH,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACjC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAChC,CAAC;QACD,IAAI,MAAM,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;YAC3C,IAAI,CAAC,iBAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAC;QACpD,CAAC;IACH,CAAC;CACF;AApBD,wEAoBC;AAKD,MAAa,8BAA8B;IAChC,OAAO,GACd,IAAI,4BAA4B,CAAC,EAAE,CAAC,CAAC;IAC9B,iBAAiB,GAAuB,KAAK,CAAC,CAAC;IACxD,YACE,MAMG;QAEH,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACjC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAChC,CAAC;QACD,IAAI,MAAM,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;YAC3C,IAAI,CAAC,iBAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAC;QACpD,CAAC;IACH,CAAC;CACF;AApBD,wEAoBC;AAKD,MAAa,8BAA8B;IAChC,OAAO,GACd,IAAI,4BAA4B,CAAC,EAAE,CAAC,CAAC;IAC9B,iBAAiB,GAAuB,KAAK,CAAC,CAAC;IACxD,YACE,MAMG;QAEH,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACjC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAChC,CAAC;QACD,IAAI,MAAM,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;YAC3C,IAAI,CAAC,iBAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAC;QACpD,CAAC;IACH,CAAC;CACF;AApBD,wEAoBC;AAKD,MAAa,yBAAyB;IACpC;kEAC8D;IACrD,YAAY,GAEjB,EAAE,CAAC;IACP,YACE,MAC0D;QAE1D,IAAI,MAAM,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YACtC,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QAC1C,CAAC;IACH,CAAC;CACF;AAdD,8DAcC;AAUD,MAAa,4BAA4B;IACvC;;;;;;;4BAOwB;IACf,OAAO,CAAU;IAC1B;kEAC8D;IACrD,YAAY,GAEjB,EAAE,CAAC;IACP,YACE,MAC6D;QAE7D,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACjC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAChC,CAAC;QACD,IAAI,MAAM,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YACtC,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QAC1C,CAAC;IACH,CAAC;CACF;AA1BD,oEA0BC;AAmBD,MAAa,4BAA4B;IACvC;kEAC8D;IACrD,YAAY,GAEjB,EAAE,CAAC;IACP,YACE,MAC6D;QAE7D,IAAI,MAAM,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YACtC,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QAC1C,CAAC;IACH,CAAC;CACF;AAdD,oEAcC;AAUD,MAAa,4BAA4B;IACvC;kEAC8D;IACrD,YAAY,GAEjB,EAAE,CAAC;IACP,YACE,MAC6D;QAE7D,IAAI,MAAM,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YACtC,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QAC1C,CAAC;IACH,CAAC;CACF;AAdD,oEAcC;AAUD,MAAa,mBAAmB;IACrB,IAAI,CAAkB;IACtB,cAAc,GAAmB,IAAI,wBAAc,CAAC,EAAE,CAAC,CAAC;IACjE,YACE,MAQsD;QAEtD,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC9B,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QAC1B,CAAC;QACD,IAAI,MAAM,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;YACxC,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;QAC9C,CAAC;IACH,CAAC;IACD;;;;;;;;;;;;SAYK;IACL,KAAK,CAAC,kBAAkB,CACtB,aAAqB,EACrB,iBAAmD,EAAE;QAErD,MAAM,SAAS,GACb,IAAI,2BAA2B,CAAC;YAC9B,OAAO,EAAE,cAAc,CAAC,OAAO;YAC/B,iBAAiB,EAAE,cAAc,CAAC,iBAAiB;SACpD,CAAC,CAAC;QACL,MAAM,OAAO,GAAQ,SAAS,CAAC,OAAO,CAAC;QACvC,MAAM,iBAAiB,GAAQ,SAAS,CAAC,iBAAiB,CAAC;QAC3D,MAAM,UAAU,GAEZ,IAAA,qBAAa,EAAC,EAAE,GAAG,EAAE,EAAE,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;QACtD,MAAM,QAAQ,GACZ,MAAM,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,KAAK,CAC3C,IAAI,2BAAY,CAAC;YACf,GAAG,EAAE,EAAE,CAAC,MAAM,CACZ,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,OAAO,EACpC,qBAAqB,EACrB,IAAA,gBAAQ,EAAC,aAAa,CAAW,CACxB;YACX,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,UAAU;YACnB,cAAc,EAAE,MAAwB;YACxC,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,iBAAiB,EAAE,iBAAiB;SACrC,CAAC,CACH,CAAC;QACJ,OAAO;YACL,GAAG,IAAA,oCAAsB,EAAC,QAAQ,CAAC,IAAK,CAAC;YACzC,OAAO,EAAE,QAAQ,CAAC,IAAK;SACxB,CAAC;IACJ,CAAC;IACD;;;;;;;;;;;;;;SAcK;IACL,KAAK,CAAC,qBAAqB,CACzB,aAAqB,EACrB,WAAqC,EACrC,iBAAsD,EAAE;QAExD,MAAM,SAAS,GACb,IAAI,8BAA8B,CAAC;YACjC,OAAO,EAAE,cAAc,CAAC,OAAO;YAC/B,iBAAiB,EAAE,cAAc,CAAC,iBAAiB;SACpD,CAAC,CAAC;QACL,MAAM,OAAO,GAAQ,SAAS,CAAC,OAAO,CAAC;QACvC,MAAM,iBAAiB,GAAQ,SAAS,CAAC,iBAAiB,CAAC;QAC3D,MAAM,UAAU,GAEZ,IAAA,qBAAa,EAAC;YAChB,GAAG,EAAE,CAAC,UAAU,CAAC,EAAE,IAAA,gBAAQ,EAAC,OAAO,CAAC,OAAO,CAAW,EAAE;YACxD,GAAG,OAAO,CAAC,YAAY;SACxB,CAAC,CAAC;QACH,MAAM,QAAQ,GACZ,MAAM,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,KAAK,CAC3C,IAAI,2BAAY,CAAC;YACf,GAAG,EAAE,EAAE,CAAC,MAAM,CACZ,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,OAAO,EACpC,qBAAqB,EACrB,IAAA,gBAAQ,EAAC,aAAa,CAAW,CACxB;YACX,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,UAAU;YACnB,IAAI,EAAE,IAAA,4DAAiC,EAAC,WAAW,CAAC;YACpD,WAAW,EAAE,kBAAkB;YAC/B,cAAc,EAAE,MAAwB;YACxC,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,iBAAiB,EAAE,iBAAiB;SACrC,CAAC,CACH,CAAC;QACJ,OAAO;YACL,GAAG,IAAA,oCAAsB,EAAC,QAAQ,CAAC,IAAK,CAAC;YACzC,OAAO,EAAE,QAAQ,CAAC,IAAK;SACxB,CAAC;IACJ,CAAC;IACD;;;;;;;;;;;;SAYK;IACL,KAAK,CAAC,qBAAqB,CACzB,aAAqB,EACrB,iBAAsD,EAAE;QAExD,MAAM,SAAS,GACb,IAAI,8BAA8B,CAAC;YACjC,OAAO,EAAE,cAAc,CAAC,OAAO;YAC/B,iBAAiB,EAAE,cAAc,CAAC,iBAAiB;SACpD,CAAC,CAAC;QACL,MAAM,OAAO,GAAQ,SAAS,CAAC,OAAO,CAAC;QACvC,MAAM,iBAAiB,GAAQ,SAAS,CAAC,iBAAiB,CAAC;QAC3D,MAAM,UAAU,GAEZ,IAAA,qBAAa,EAAC,EAAE,GAAG,EAAE,EAAE,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;QACtD,MAAM,QAAQ,GACZ,MAAM,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,KAAK,CAC3C,IAAI,2BAAY,CAAC;YACf,GAAG,EAAE,EAAE,CAAC,MAAM,CACZ,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,OAAO,EACpC,qBAAqB,EACrB,IAAA,gBAAQ,EAAC,aAAa,CAAW,CACxB;YACX,MAAM,EAAE,QAAQ;YAChB,OAAO,EAAE,UAAU;YACnB,cAAc,EAAE,YAA8B;YAC9C,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,iBAAiB,EAAE,iBAAiB;SACrC,CAAC,CACH,CAAC;QACJ,OAAO,KAAK,CAAC,CAAC;IAChB,CAAC;IACD;;;;;;;;;;;;;;SAcK;IACL,KAAK,CAAC,qBAAqB,CACzB,aAAqB,EACrB,WAAmC,EACnC,iBAAsD,EAAE;QAExD,MAAM,SAAS,GACb,IAAI,8BAA8B,CAAC;YACjC,OAAO,EAAE,cAAc,CAAC,OAAO;YAC/B,iBAAiB,EAAE,cAAc,CAAC,iBAAiB;SACpD,CAAC,CAAC;QACL,MAAM,OAAO,GAAQ,SAAS,CAAC,OAAO,CAAC;QACvC,MAAM,iBAAiB,GAAQ,SAAS,CAAC,iBAAiB,CAAC;QAC3D,MAAM,UAAU,GAEZ,IAAA,qBAAa,EAAC,EAAE,GAAG,EAAE,EAAE,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;QACtD,MAAM,QAAQ,GACZ,MAAM,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,KAAK,CAC3C,IAAI,2BAAY,CAAC;YACf,GAAG,EAAE,EAAE,CAAC,MAAM,CACZ,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,OAAO,EACpC,qBAAqB,EACrB,IAAA,gBAAQ,EAAC,aAAa,CAAW,EACjC,OAAO,CACE;YACX,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,UAAU;YACnB,IAAI,EAAE,IAAA,wDAA+B,EAAC,WAAW,CAAC;YAClD,WAAW,EAAE,kBAAkB;YAC/B,cAAc,EAAE,MAAwB;YACxC,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,iBAAiB,EAAE,iBAAiB;SACrC,CAAC,CACH,CAAC;QACJ,OAAO;YACL,GAAG,IAAA,oCAAsB,EAAC,QAAQ,CAAC,IAAK,CAAC;YACzC,OAAO,EAAE,QAAQ,CAAC,IAAK;SACxB,CAAC;IACJ,CAAC;CACF;AAhOD,kDAgOC"}

package/lib-esm/sdk-gen/managers/fileVersionLegalHolds.d.ts

@@ -0,0 +1,112 @@
+import { FileVersionLegalHold } from '../schemas/fileVersionLegalHold';
+import { FileVersionLegalHolds } from '../schemas/fileVersionLegalHolds';
+import { Authentication } from '../networking/auth';
+import { NetworkSession } from '../networking/network';
+import { CancellationToken } from '../internal/utils';
+export declare class GetFileVersionLegalHoldByIdOptionals {
+    readonly headers: GetFileVersionLegalHoldByIdHeaders;
+    readonly cancellationToken?: CancellationToken;
+    constructor(fields: Omit<GetFileVersionLegalHoldByIdOptionals, 'headers' | 'cancellationToken'> & Partial<Pick<GetFileVersionLegalHoldByIdOptionals, 'headers' | 'cancellationToken'>>);
+}
+export interface GetFileVersionLegalHoldByIdOptionalsInput {
+    readonly headers?: GetFileVersionLegalHoldByIdHeaders;
+    readonly cancellationToken?: undefined | CancellationToken;
+}
+export declare class GetFileVersionLegalHoldsOptionals {
+    readonly headers: GetFileVersionLegalHoldsHeaders;
+    readonly cancellationToken?: CancellationToken;
+    constructor(fields: Omit<GetFileVersionLegalHoldsOptionals, 'headers' | 'cancellationToken'> & Partial<Pick<GetFileVersionLegalHoldsOptionals, 'headers' | 'cancellationToken'>>);
+}
+export interface GetFileVersionLegalHoldsOptionalsInput {
+    readonly headers?: GetFileVersionLegalHoldsHeaders;
+    readonly cancellationToken?: undefined | CancellationToken;
+}
+export declare class GetFileVersionLegalHoldByIdHeaders {
+    /**
+     * Extra headers that will be included in the HTTP request. */
+    readonly extraHeaders?: {
+        readonly [key: string]: undefined | string;
+    };
+    constructor(fields: Omit<GetFileVersionLegalHoldByIdHeaders, 'extraHeaders'> & Partial<Pick<GetFileVersionLegalHoldByIdHeaders, 'extraHeaders'>>);
+}
+export interface GetFileVersionLegalHoldByIdHeadersInput {
+    /**
+     * Extra headers that will be included in the HTTP request. */
+    readonly extraHeaders?: undefined | {
+        readonly [key: string]: undefined | string;
+    };
+}
+export interface GetFileVersionLegalHoldsQueryParams {
+    /**
+     * The ID of the legal hold policy to get the file version legal
+     * holds for. */
+    readonly policyId: string;
+    /**
+     * Defines the position marker at which to begin returning results. This is
+     * used when paginating using marker-based pagination.
+     *
+     * This requires `usemarker` to be set to `true`. */
+    readonly marker?: string;
+    /**
+     * The maximum number of items to return per page. */
+    readonly limit?: number;
+}
+export declare class GetFileVersionLegalHoldsHeaders {
+    /**
+     * Extra headers that will be included in the HTTP request. */
+    readonly extraHeaders?: {
+        readonly [key: string]: undefined | string;
+    };
+    constructor(fields: Omit<GetFileVersionLegalHoldsHeaders, 'extraHeaders'> & Partial<Pick<GetFileVersionLegalHoldsHeaders, 'extraHeaders'>>);
+}
+export interface GetFileVersionLegalHoldsHeadersInput {
+    /**
+     * Extra headers that will be included in the HTTP request. */
+    readonly extraHeaders?: undefined | {
+        readonly [key: string]: undefined | string;
+    };
+}
+export declare class FileVersionLegalHoldsManager {
+    readonly auth?: Authentication;
+    readonly networkSession: NetworkSession;
+    constructor(fields: Omit<FileVersionLegalHoldsManager, 'networkSession' | 'getFileVersionLegalHoldById' | 'getFileVersionLegalHolds'> & Partial<Pick<FileVersionLegalHoldsManager, 'networkSession'>>);
+    /**
+       * Retrieves information about the legal hold policies
+       * assigned to a file version.
+       * @param {string} fileVersionLegalHoldId The ID of the file version legal hold.
+      Example: "2348213"
+       * @param {GetFileVersionLegalHoldByIdOptionalsInput} optionalsInput
+       * @returns {Promise<FileVersionLegalHold>}
+       */
+    getFileVersionLegalHoldById(fileVersionLegalHoldId: string, optionalsInput?: GetFileVersionLegalHoldByIdOptionalsInput): Promise<FileVersionLegalHold>;
+    /**
+     * Get a list of file versions on legal hold for a legal hold
+     * assignment.
+     *
+     * Due to ongoing re-architecture efforts this API might not return all file
+     * versions for this policy ID.
+     *
+     * Instead, this API will only return file versions held in the legacy
+     * architecture. Two new endpoints will available to request any file versions
+     * held in the new architecture.
+     *
+     * For file versions held in the new architecture, the `GET
+     * /legal_hold_policy_assignments/:id/file_versions_on_hold` API can be used to
+     * return all past file versions available for this policy assignment, and the
+     * `GET /legal_hold_policy_assignments/:id/files_on_hold` API can be used to
+     * return any current (latest) versions of a file under legal hold.
+     *
+     * The `GET /legal_hold_policy_assignments?policy_id={id}` API can be used to
+     * find a list of policy assignments for a given policy ID.
+     *
+     * Once the re-architecture is completed this API will be deprecated.
+     * @param {GetFileVersionLegalHoldsQueryParams} queryParams Query parameters of getFileVersionLegalHolds method
+     * @param {GetFileVersionLegalHoldsOptionalsInput} optionalsInput
+     * @returns {Promise<FileVersionLegalHolds>}
+     */
+    getFileVersionLegalHolds(queryParams: GetFileVersionLegalHoldsQueryParams, optionalsInput?: GetFileVersionLegalHoldsOptionalsInput): Promise<FileVersionLegalHolds>;
+}
+export interface FileVersionLegalHoldsManagerInput {
+    readonly auth?: Authentication;
+    readonly networkSession?: NetworkSession;
+}