box-node-sdk 10.3.0 → 10.5.0

package/lib/bundle.js

@@ -3622,7 +3622,7 @@
     var browserExports = browser.exports;
     var nodeFetch = /*@__PURE__*/getDefaultExportFromCjs(browserExports);
 
-    const sdkVersion = '10.3.0';
+    const sdkVersion = '10.5.0';
 
     class BoxRetryStrategy {
         constructor(fields) {
@@ -3707,6 +3707,46 @@
             (options.responseFormat === 'binary' ||
                 options.responseFormat === 'no_content'));
     };
+    function createAbortSignalWithTimeout(baseSignal, timeoutMs) {
+        var _a;
+        const controller = new AbortController();
+        const upstream = baseSignal;
+        let timedOut = false;
+        const abortFromUpstream = () => {
+            try {
+                controller.abort(upstream === null || upstream === void 0 ? void 0 : upstream.reason);
+            }
+            catch (_a) {
+                controller.abort();
+            }
+        };
+        if (upstream) {
+            if (upstream.aborted) {
+                abortFromUpstream();
+            }
+            else {
+                upstream.addEventListener('abort', abortFromUpstream, { once: true });
+            }
+        }
+        const timeoutId = setTimeout(() => {
+            timedOut = true;
+            controller.abort();
+        }, timeoutMs);
+        // Node.js timers keep the event loop alive. If the only pending work is this
+        // watchdog timeout, we don't want it to prevent process exit (e.g. short CLI
+        // runs, tests, scripts). `unref()` detaches the timer from the event loop.
+        // It’s a no-op in environments where `unref` isn’t available.
+        (_a = timeoutId === null || timeoutId === void 0 ? void 0 : timeoutId.unref) === null || _a === void 0 ? void 0 : _a.call(timeoutId);
+        return {
+            signal: controller.signal,
+            clearTimeout: () => {
+                clearTimeout(timeoutId);
+                if (upstream)
+                    upstream.removeEventListener('abort', abortFromUpstream);
+            },
+            didTimeout: () => timedOut,
+        };
+    }
     function createRequestInit(options) {
         return __awaiter$1(this, void 0, void 0, function* () {
             var _a, _b;
@@ -3809,11 +3849,18 @@
                         : void 0, multipartData: multipartBuffer
                         ? multipartBufferToStream(multipartBuffer)
                         : void 0 }));
+                const timeoutConfig = (_j = fetchOptions.networkSession) === null || _j === void 0 ? void 0 : _j.timeoutConfig;
+                const timeoutMs = timeoutConfig === null || timeoutConfig === void 0 ? void 0 : timeoutConfig.timeoutMs;
+                const requestTimeout = timeoutMs != null && timeoutMs > 0
+                    ? createAbortSignalWithTimeout(requestInit.signal, timeoutMs)
+                    : undefined;
+                const requestInitWithTimeout = requestTimeout
+                    ? Object.assign(Object.assign({}, requestInit), { signal: requestTimeout.signal }) : requestInit;
                 try {
-                    const response = yield nodeFetch(''.concat(fetchOptions.url, Object.keys(params).length === 0 || fetchOptions.url.endsWith('?')
+                    const requestUrl = ''.concat(fetchOptions.url, Object.keys(params).length === 0 || fetchOptions.url.endsWith('?')
                         ? ''
-                        : '?', new URLSearchParams(params).toString()), Object.assign(Object.assign({}, requestInit), { redirect: isBrowser() ? 'follow' : 'manual' }));
-                    const contentType = (_j = response.headers.get('content-type')) !== null && _j !== void 0 ? _j : '';
+                        : '?', new URLSearchParams(params).toString());
+                    const response = yield nodeFetch(requestUrl, Object.assign(Object.assign({}, requestInitWithTimeout), { redirect: isBrowser() ? 'follow' : 'manual' }));
                     const ignoreResponseBody = fetchOptions.followRedirects === false;
                     let data;
                     let content = generateByteStreamFromBuffer(new Uint8Array().buffer);
@@ -3845,16 +3892,24 @@
                 catch (error) {
                     isExceptionCase = true;
                     numberOfRetriesOnException++;
-                    caughtError = error instanceof Error ? error : new Error(String(error));
+                    if (requestTimeout === null || requestTimeout === void 0 ? void 0 : requestTimeout.didTimeout()) {
+                        caughtError = new Error(`Connection timeout after ${timeoutMs}ms`);
+                    }
+                    else {
+                        caughtError = error instanceof Error ? error : new Error(String(error));
+                    }
                     fetchResponse = fetchResponse !== null && fetchResponse !== void 0 ? fetchResponse : { status: 0, headers: {} };
                 }
+                finally {
+                    requestTimeout === null || requestTimeout === void 0 ? void 0 : requestTimeout.clearTimeout();
+                }
                 const attemptForRetry = isExceptionCase
                     ? numberOfRetriesOnException
                     : attemptNumber;
                 const shouldRetry = yield retryStrategy.shouldRetry(fetchOptions, fetchResponse, attemptForRetry);
                 if (shouldRetry) {
                     const retryTimeout = retryStrategy.retryAfter(fetchOptions, fetchResponse, attemptForRetry);
-                    yield new Promise((resolve) => setTimeout(resolve, retryTimeout));
+                    yield new Promise((resolve) => setTimeout(resolve, retryTimeout * 1000));
                     return this.fetch(Object.assign(Object.assign({}, options), { attemptNumber: attemptNumber + 1, numberOfRetriesOnException: numberOfRetriesOnException, fileStream: fileStreamBuffer
                             ? generateByteStreamFromBuffer(fileStreamBuffer)
                             : void 0, multipartData: multipartBuffer
@@ -3891,7 +3946,7 @@
                     : [];
                 if (fetchResponse.status === 0) {
                     throw new BoxSdkError({
-                        message: `Unexpected Error occurred`,
+                        message: (caughtError === null || caughtError === void 0 ? void 0 : caughtError.message) || `Unexpected Error occurred`,
                         timestamp: `${Date.now()}`,
                         error: caughtError,
                     });
@@ -3976,6 +4031,9 @@
             if (fields.dataSanitizer !== undefined) {
                 this.dataSanitizer = fields.dataSanitizer;
             }
+            if (fields.timeoutConfig !== undefined) {
+                this.timeoutConfig = fields.timeoutConfig;
+            }
         }
         /**
            * Generate a fresh network session by duplicating the existing configuration and network parameters, while also including additional headers to be attached to every API call.
@@ -4013,6 +4071,7 @@
                 networkClient: this.networkClient,
                 retryStrategy: this.retryStrategy,
                 dataSanitizer: this.dataSanitizer,
+                timeoutConfig: this.timeoutConfig,
             });
         }
         /**
@@ -4031,6 +4090,7 @@
                 networkClient: this.networkClient,
                 retryStrategy: this.retryStrategy,
                 dataSanitizer: this.dataSanitizer,
+                timeoutConfig: this.timeoutConfig,
             });
         }
         /**
@@ -4049,6 +4109,7 @@
                 networkClient: this.networkClient,
                 retryStrategy: this.retryStrategy,
                 dataSanitizer: this.dataSanitizer,
+                timeoutConfig: this.timeoutConfig,
             });
         }
         /**
@@ -4067,6 +4128,7 @@
                 networkClient: this.networkClient,
                 retryStrategy: this.retryStrategy,
                 dataSanitizer: this.dataSanitizer,
+                timeoutConfig: this.timeoutConfig,
             });
         }
         /**
@@ -4085,6 +4147,7 @@
                 networkClient: networkClient,
                 retryStrategy: this.retryStrategy,
                 dataSanitizer: this.dataSanitizer,
+                timeoutConfig: this.timeoutConfig,
             });
         }
         /**
@@ -4103,6 +4166,7 @@
                 networkClient: this.networkClient,
                 retryStrategy: retryStrategy,
                 dataSanitizer: this.dataSanitizer,
+                timeoutConfig: this.timeoutConfig,
             });
         }
         /**
@@ -4122,6 +4186,26 @@
                 networkClient: this.networkClient,
                 retryStrategy: this.retryStrategy,
                 dataSanitizer: dataSanitizer,
+                timeoutConfig: this.timeoutConfig,
+            });
+        }
+        /**
+         * Generate a fresh network session by duplicating the existing configuration and network parameters, while also applying timeout config
+         * @param {TimeoutConfig} timeoutConfig
+         * @returns {NetworkSession}
+         */
+        withTimeoutConfig(timeoutConfig) {
+            return new NetworkSession({
+                additionalHeaders: this.additionalHeaders,
+                baseUrls: this.baseUrls,
+                interceptors: this.interceptors,
+                agent: this.agent,
+                agentOptions: this.agentOptions,
+                proxyConfig: this.proxyConfig,
+                networkClient: this.networkClient,
+                retryStrategy: this.retryStrategy,
+                dataSanitizer: this.dataSanitizer,
+                timeoutConfig: timeoutConfig,
             });
         }
     }
@@ -4796,7 +4880,7 @@
          * An Access Token is a string that enables Box to verify that a
          * request belongs to an authorized session. In the normal order of
          * operations you will begin by requesting authentication from the
-         * [authorize](#get-authorize) endpoint and Box will send you an
+         * [authorize](https://developer.box.com/reference/get-authorize) endpoint and Box will send you an
          * authorization code.
          *
          * You will then send this code to this endpoint to exchange it for
@@ -6462,6 +6546,13 @@
             });
         }
         const canViewAnnotationsSelf = val.can_view_annotations_self;
+        if (!(val.can_apply_watermark == void 0) &&
+            !sdIsBoolean(val.can_apply_watermark)) {
+            throw new BoxSdkError({
+                message: 'Expecting boolean for "can_apply_watermark" of type "FileFullPermissionsField"',
+            });
+        }
+        const canApplyWatermark = val.can_apply_watermark == void 0 ? void 0 : val.can_apply_watermark;
         return {
             canDelete: canDelete,
             canDownload: canDownload,
@@ -6475,6 +6566,7 @@
             canUpload: canUpload,
             canViewAnnotationsAll: canViewAnnotationsAll,
             canViewAnnotationsSelf: canViewAnnotationsSelf,
+            canApplyWatermark: canApplyWatermark,
         };
     }
     function deserializeFileFullLockTypeField(val) {
@@ -6619,7 +6711,27 @@
             });
         }
         const isWatermarked = val.is_watermarked == void 0 ? void 0 : val.is_watermarked;
-        return { isWatermarked: isWatermarked };
+        if (!(val.is_watermark_inherited == void 0) &&
+            !sdIsBoolean(val.is_watermark_inherited)) {
+            throw new BoxSdkError({
+                message: 'Expecting boolean for "is_watermark_inherited" of type "FileFullWatermarkInfoField"',
+            });
+        }
+        const isWatermarkInherited = val.is_watermark_inherited == void 0 ? void 0 : val.is_watermark_inherited;
+        if (!(val.is_watermarked_by_access_policy == void 0) &&
+            !sdIsBoolean(val.is_watermarked_by_access_policy)) {
+            throw new BoxSdkError({
+                message: 'Expecting boolean for "is_watermarked_by_access_policy" of type "FileFullWatermarkInfoField"',
+            });
+        }
+        const isWatermarkedByAccessPolicy = val.is_watermarked_by_access_policy == void 0
+            ? void 0
+            : val.is_watermarked_by_access_policy;
+        return {
+            isWatermarked: isWatermarked,
+            isWatermarkInherited: isWatermarkInherited,
+            isWatermarkedByAccessPolicy: isWatermarkedByAccessPolicy,
+        };
     }
     function deserializeFileFullAllowedInviteeRolesField(val) {
         if (val == 'editor') {
@@ -17046,6 +17158,13 @@
             });
         }
         const canUpload = val.can_upload;
+        if (!(val.can_apply_watermark == void 0) &&
+            !sdIsBoolean(val.can_apply_watermark)) {
+            throw new BoxSdkError({
+                message: 'Expecting boolean for "can_apply_watermark" of type "FolderFullPermissionsField"',
+            });
+        }
+        const canApplyWatermark = val.can_apply_watermark == void 0 ? void 0 : val.can_apply_watermark;
         return {
             canDelete: canDelete,
             canDownload: canDownload,
@@ -17054,6 +17173,7 @@
             canSetShareAccess: canSetShareAccess,
             canShare: canShare,
             canUpload: canUpload,
+            canApplyWatermark: canApplyWatermark,
         };
     }
     function deserializeFolderFullMetadataField(val) {
@@ -17142,8 +17262,26 @@
             });
         }
         const isWatermarked = val.is_watermarked == void 0 ? void 0 : val.is_watermarked;
+        if (!(val.is_watermark_inherited == void 0) &&
+            !sdIsBoolean(val.is_watermark_inherited)) {
+            throw new BoxSdkError({
+                message: 'Expecting boolean for "is_watermark_inherited" of type "FolderFullWatermarkInfoField"',
+            });
+        }
+        const isWatermarkInherited = val.is_watermark_inherited == void 0 ? void 0 : val.is_watermark_inherited;
+        if (!(val.is_watermarked_by_access_policy == void 0) &&
+            !sdIsBoolean(val.is_watermarked_by_access_policy)) {
+            throw new BoxSdkError({
+                message: 'Expecting boolean for "is_watermarked_by_access_policy" of type "FolderFullWatermarkInfoField"',
+            });
+        }
+        const isWatermarkedByAccessPolicy = val.is_watermarked_by_access_policy == void 0
+            ? void 0
+            : val.is_watermarked_by_access_policy;
         return {
             isWatermarked: isWatermarked,
+            isWatermarkInherited: isWatermarkInherited,
+            isWatermarkedByAccessPolicy: isWatermarkedByAccessPolicy,
         };
     }
     function deserializeFolderFullClassificationField(val) {
@@ -17789,7 +17927,7 @@
            * folders, and web links.
            *
            * To request more information about the folder itself, like its size,
-           * use the [Get a folder](#get-folders-id) endpoint instead.
+           * use the [Get a folder](https://developer.box.com/reference/get-folders-id) endpoint instead.
            * @param {string} folderId The unique identifier that represent a folder.
           
           The ID for any folder can be determined
@@ -29806,7 +29944,7 @@
         }
         /**
          * Returns a list of real-time servers that can be used for long-polling updates
-         * to the [event stream](#get-events).
+         * to the [event stream](https://developer.box.com/reference/get-events).
          *
          * Long polling is the concept where a HTTP request is kept open until the
          * server sends a response, then repeating the process over and over to receive
@@ -29821,7 +29959,7 @@
          * When an event occurs in monitored account a response with the value
          * `new_change` will be sent. The response contains no other details as
          * it only serves as a prompt to take further action such as sending a
-         * request to the [events endpoint](#get-events) with the last known
+         * request to the [events endpoint](https://developer.box.com/reference/get-events) with the last known
          * `stream_position`.
          *
          * After the server sends this response it closes the connection. You must now
@@ -31749,11 +31887,25 @@
             });
         }
         const fileVersion = val.file_version == void 0 ? void 0 : val.file_version;
+        if (!(val.ownership == void 0) && !sdIsNumber(val.ownership)) {
+            throw new BoxSdkError({
+                message: 'Expecting number for "ownership" of type "LegalHoldPolicyAssignmentCountsField"',
+            });
+        }
+        const ownership = val.ownership == void 0 ? void 0 : val.ownership;
+        if (!(val.interactions == void 0) && !sdIsNumber(val.interactions)) {
+            throw new BoxSdkError({
+                message: 'Expecting number for "interactions" of type "LegalHoldPolicyAssignmentCountsField"',
+            });
+        }
+        const interactions = val.interactions == void 0 ? void 0 : val.interactions;
         return {
             user: user,
             folder: folder,
             file: file,
             fileVersion: fileVersion,
+            ownership: ownership,
+            interactions: interactions,
         };
     }
     function deserializeLegalHoldPolicy(val) {
@@ -32510,7 +32662,7 @@
             });
         }
         /**
-         * Assign a legal hold to a file, file version, folder, or user.
+         * Assign a legal hold to an item type of: file, file version, folder, user, ownership, or interactions.
          * @param {CreateLegalHoldPolicyAssignmentRequestBody} requestBody Request body of createLegalHoldPolicyAssignment method
          * @param {CreateLegalHoldPolicyAssignmentOptionalsInput} optionalsInput
          * @returns {Promise<LegalHoldPolicyAssignment>}
@@ -37915,6 +38067,7 @@
             ['password']: val.password,
             ['signer_group_id']: val.signerGroupId,
             ['suppress_notifications']: val.suppressNotifications,
+            ['language']: val.language,
         };
     }
 
@@ -38640,6 +38793,12 @@
             });
         }
         const suppressNotifications = val.suppress_notifications == void 0 ? void 0 : val.suppress_notifications;
+        if (!(val.language == void 0) && !sdIsString(val.language)) {
+            throw new BoxSdkError({
+                message: 'Expecting string for "language" of type "SignRequestSigner"',
+            });
+        }
+        const language = val.language == void 0 ? void 0 : val.language;
         return {
             hasViewedDocument: hasViewedDocument,
             signerDecision: signerDecision,
@@ -38659,6 +38818,7 @@
             password: password,
             signerGroupId: signerGroupId,
             suppressNotifications: suppressNotifications,
+            language: language,
         };
     }
 
@@ -38971,6 +39131,10 @@
         };
     }
 
+    function serializeSignRequestCancelRequest(val) {
+        return { ['reason']: val.reason };
+    }
+
     function deserializeSignRequests(val) {
         if (!sdIsMap(val)) {
             throw new BoxSdkError({ message: 'Expecting a map for "SignRequests"' });
@@ -39036,8 +39200,12 @@
 
     class CancelSignRequestOptionals {
         constructor(fields) {
+            this.requestBody = void 0;
             this.headers = new CancelSignRequestHeaders({});
             this.cancellationToken = void 0;
+            if (fields.requestBody !== undefined) {
+                this.requestBody = fields.requestBody;
+            }
             if (fields.headers !== undefined) {
                 this.headers = fields.headers;
             }
@@ -39152,9 +39320,11 @@
         cancelSignRequest(signRequestId_1) {
             return __awaiter$1(this, arguments, void 0, function* (signRequestId, optionalsInput = {}) {
                 const optionals = new CancelSignRequestOptionals({
+                    requestBody: optionalsInput.requestBody,
                     headers: optionalsInput.headers,
                     cancellationToken: optionalsInput.cancellationToken,
                 });
+                const requestBody = optionals.requestBody;
                 const headers = optionals.headers;
                 const cancellationToken = optionals.cancellationToken;
                 const headersMap = prepareParams(Object.assign({}, headers.extraHeaders));
@@ -39162,6 +39332,10 @@
                     url: ''.concat(this.networkSession.baseUrls.baseUrl, '/2.0/sign_requests/', toString(signRequestId), '/cancel'),
                     method: 'POST',
                     headers: headersMap,
+                    data: !(requestBody == void 0)
+                        ? serializeSignRequestCancelRequest(requestBody)
+                        : void 0,
+                    contentType: 'application/json',
                     responseFormat: 'json',
                     auth: this.auth,
                     networkSession: this.networkSession,
@@ -43065,6 +43239,21 @@
             });
         }
         const completionReason = val.completion_reason == void 0 ? void 0 : val.completion_reason;
+        if (!(val.confidence_score == void 0) && !sdIsMap(val.confidence_score)) {
+            throw new BoxSdkError({
+                message: 'Expecting object for "confidence_score" of type "AiExtractStructuredResponse"',
+            });
+        }
+        const confidenceScore = val.confidence_score == void 0
+            ? void 0
+            : sdIsMap(val.confidence_score)
+                ? Object.fromEntries(Object.entries(val.confidence_score).map(([k, v]) => [
+                    k,
+                    (function (v) {
+                        return v;
+                    })(v),
+                ]))
+                : {};
         const aiAgentInfo = val.ai_agent_info == void 0
             ? void 0
             : deserializeAiAgentInfo(val.ai_agent_info);
@@ -43072,6 +43261,7 @@
             answer: answer,
             createdAt: createdAt,
             completionReason: completionReason,
+            confidenceScore: confidenceScore,
             aiAgentInfo: aiAgentInfo,
         };
     }
@@ -43128,6 +43318,7 @@
                 : val.fields.map(function (item) {
                     return serializeAiExtractStructuredFieldsField(item);
                 }),
+            ['include_confidence_score']: val.includeConfidenceScore,
             ['ai_agent']: val.aiAgent == void 0
                 ? val.aiAgent
                 : serializeAiExtractStructuredAgent(val.aiAgent),
@@ -48885,6 +49076,15 @@
         const canSharedLinkBeCreated = val.can_shared_link_be_created == void 0
             ? void 0
             : val.can_shared_link_be_created;
+        if (!(val.can_public_shared_link_be_created == void 0) &&
+            !sdIsBoolean(val.can_public_shared_link_be_created)) {
+            throw new BoxSdkError({
+                message: 'Expecting boolean for "can_public_shared_link_be_created" of type "HubV2025R0"',
+            });
+        }
+        const canPublicSharedLinkBeCreated = val.can_public_shared_link_be_created == void 0
+            ? void 0
+            : val.can_public_shared_link_be_created;
         if (val.id == void 0) {
             throw new BoxSdkError({
                 message: 'Expecting "id" of type "HubV2025R0" to be defined',
@@ -48914,6 +49114,7 @@
             isCollaborationRestrictedToEnterprise: isCollaborationRestrictedToEnterprise,
             canNonOwnersInvite: canNonOwnersInvite,
             canSharedLinkBeCreated: canSharedLinkBeCreated,
+            canPublicSharedLinkBeCreated: canPublicSharedLinkBeCreated,
             id: id,
             type: type,
         };
@@ -48966,6 +49167,7 @@
             ['is_collaboration_restricted_to_enterprise']: val.isCollaborationRestrictedToEnterprise,
             ['can_non_owners_invite']: val.canNonOwnersInvite,
             ['can_shared_link_be_created']: val.canSharedLinkBeCreated,
+            ['can_public_shared_link_be_created']: val.canPublicSharedLinkBeCreated,
         };
     }
 
@@ -51644,6 +51846,10 @@
            * Permanently deletes an archive.
            *
            * To learn more about the archive APIs, see the [Archive API Guide](https://developer.box.com/guides/archives).
+           *
+           * <Danger>
+           * This endpoint is currently unavailable. Please contact support for assistance.
+           * </Danger>
            * @param {string} archiveId The ID of the archive.
           Example: "982312"
            * @param {DeleteArchiveByIdV2025R0OptionalsInput} optionalsInput
@@ -52325,6 +52531,17 @@
                 networkSession: this.networkSession.withProxy(config),
             });
         }
+        /**
+         * Create a new client with custom timeouts that will be used for every API call
+         * @param {TimeoutConfig} config Timeout configuration.
+         * @returns {BoxClient}
+         */
+        withTimeouts(config) {
+            return new BoxClient({
+                auth: this.auth,
+                networkSession: this.networkSession.withTimeoutConfig(config),
+            });
+        }
         /**
          * Create a new client with a custom set of agent options that will be used for every API call
          * @param {AgentOptions} agentOptions Custom set of agent options that will be used for every API call