box-node-sdk 10.0.1 → 10.2.0

package/src/managers/workflows.ts

@@ -42,7 +42,7 @@ export class GetWorkflowsOptionals {
 }
 export interface GetWorkflowsOptionalsInput {
   readonly headers?: GetWorkflowsHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class StartWorkflowOptionals {
   readonly headers: StartWorkflowHeaders = new StartWorkflowHeaders({});
@@ -61,7 +61,7 @@ export class StartWorkflowOptionals {
 }
 export interface StartWorkflowOptionalsInput {
   readonly headers?: StartWorkflowHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export interface GetWorkflowsQueryParams {
   /**
@@ -107,11 +107,9 @@ export class GetWorkflowsHeaders {
 export interface GetWorkflowsHeadersInput {
   /**
    * Extra headers that will be included in the HTTP request. */
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
+  readonly extraHeaders?: {
+    readonly [key: string]: undefined | string;
+  };
 }
 export type StartWorkflowRequestBodyTypeField = 'workflow_parameters';
 export interface StartWorkflowRequestBodyFlowField {
@@ -180,11 +178,9 @@ export class StartWorkflowHeaders {
 export interface StartWorkflowHeadersInput {
   /**
    * Extra headers that will be included in the HTTP request. */
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
+  readonly extraHeaders?: {
+    readonly [key: string]: undefined | string;
+  };
 }
 export class WorkflowsManager {
   readonly auth?: Authentication;

package/src/managers/zipDownloads.ts

@@ -47,7 +47,7 @@ export class CreateZipDownloadOptionals {
 }
 export interface CreateZipDownloadOptionalsInput {
   readonly headers?: CreateZipDownloadHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class GetZipDownloadContentOptionals {
   readonly headers: GetZipDownloadContentHeaders =
@@ -72,7 +72,7 @@ export class GetZipDownloadContentOptionals {
 }
 export interface GetZipDownloadContentOptionalsInput {
   readonly headers?: GetZipDownloadContentHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class GetZipDownloadStatusOptionals {
   readonly headers: GetZipDownloadStatusHeaders =
@@ -97,7 +97,7 @@ export class GetZipDownloadStatusOptionals {
 }
 export interface GetZipDownloadStatusOptionalsInput {
   readonly headers?: GetZipDownloadStatusHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class DownloadZipOptionals {
   readonly headers: DownloadZipHeaders = new DownloadZipHeaders({});
@@ -116,7 +116,7 @@ export class DownloadZipOptionals {
 }
 export interface DownloadZipOptionalsInput {
   readonly headers?: DownloadZipHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class CreateZipDownloadHeaders {
   /**
@@ -136,11 +136,9 @@ export class CreateZipDownloadHeaders {
 export interface CreateZipDownloadHeadersInput {
   /**
    * Extra headers that will be included in the HTTP request. */
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
+  readonly extraHeaders?: {
+    readonly [key: string]: undefined | string;
+  };
 }
 export class GetZipDownloadContentHeaders {
   /**
@@ -160,11 +158,9 @@ export class GetZipDownloadContentHeaders {
 export interface GetZipDownloadContentHeadersInput {
   /**
    * Extra headers that will be included in the HTTP request. */
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
+  readonly extraHeaders?: {
+    readonly [key: string]: undefined | string;
+  };
 }
 export class GetZipDownloadStatusHeaders {
   /**
@@ -184,11 +180,9 @@ export class GetZipDownloadStatusHeaders {
 export interface GetZipDownloadStatusHeadersInput {
   /**
    * Extra headers that will be included in the HTTP request. */
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
+  readonly extraHeaders?: {
+    readonly [key: string]: undefined | string;
+  };
 }
 export class DownloadZipHeaders {
   /**
@@ -208,11 +202,9 @@ export class DownloadZipHeaders {
 export interface DownloadZipHeadersInput {
   /**
    * Extra headers that will be included in the HTTP request. */
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
+  readonly extraHeaders?: {
+    readonly [key: string]: undefined | string;
+  };
 }
 export class ZipDownloadsManager {
   readonly auth?: Authentication;

package/src/networking/boxNetworkClient.ts

@@ -178,8 +178,9 @@ export class BoxNetworkClient implements NetworkClient {
       : void 0;
 
     let isExceptionCase: boolean = false;
-    let fetchResponse: FetchResponse;
+    let fetchResponse: FetchResponse | undefined;
     let responseBytesBuffer;
+    let caughtError: Error | undefined;
     const { params = {} } = fetchOptions;
 
     const requestInit = await createRequestInit({
@@ -243,10 +244,8 @@ export class BoxNetworkClient implements NetworkClient {
     } catch (error) {
       isExceptionCase = true;
       numberOfRetriesOnException++;
-      fetchResponse = {
-        status: 0,
-        headers: {},
-      };
+      caughtError = error instanceof Error ? error : new Error(String(error));
+      fetchResponse = fetchResponse ?? { status: 0, headers: {} };
     }
     const attemptForRetry = isExceptionCase
       ? numberOfRetriesOnException
@@ -303,9 +302,15 @@ export class BoxNetworkClient implements NetworkClient {
       return fetchResponse;
     }
 
-    const [code, contextInfo, requestId, helpUrl, message] = sdIsMap(
-      fetchResponse.data,
-    )
+    const [
+      code,
+      contextInfo,
+      requestId,
+      helpUrl,
+      message,
+      error,
+      errorDescription,
+    ] = sdIsMap(fetchResponse.data)
       ? [
           sdToJson(fetchResponse.data['code']),
           sdIsMap(fetchResponse.data['context_info'])
@@ -314,11 +319,27 @@ export class BoxNetworkClient implements NetworkClient {
           sdToJson(fetchResponse.data['request_id']),
           sdToJson(fetchResponse.data['help_url']),
           sdToJson(fetchResponse.data['message']),
+          sdToJson(fetchResponse.data['error']),
+          sdToJson(fetchResponse.data['error_description']),
         ]
       : [];
+    if (fetchResponse.status === 0) {
+      throw new BoxSdkError({
+        message: `Unexpected Error occurred`,
+        timestamp: `${Date.now()}`,
+        error: caughtError,
+      });
+    }
 
+    const errorMessage = [
+      [fetchResponse.status, code, message].filter(Boolean).join(' '),
+      requestId && `Request ID: ${requestId}`,
+      error && `${error} - ${errorDescription}`,
+    ]
+      .filter(Boolean)
+      .join('; ');
     throw new BoxApiError({
-      message: `${fetchResponse.status} ${message}; Request ID: ${requestId}`,
+      message: errorMessage,
       timestamp: `${Date.now()}`,
       requestInfo: {
         method: requestInit.method!,

package/src/networking/fetchOptions.ts

@@ -158,5 +158,5 @@ export interface FetchOptionsInput {
   readonly cancellationToken?: CancellationToken;
   /**
    * A boolean value indicate if the request should follow redirects. Defaults to True. Not supported in Browser environment. */
-  readonly followRedirects?: undefined | boolean;
+  readonly followRedirects?: boolean;
 }

package/src/networking/retries.ts

@@ -80,7 +80,9 @@ export class BoxRetryStrategy implements RetryStrategy {
     const isSuccessful: boolean =
       fetchResponse.status >= 200 && fetchResponse.status < 400;
     const retryAfterHeader: undefined | string =
-      fetchResponse.headers['Retry-After'];
+      'Retry-After' in fetchResponse.headers
+        ? fetchResponse.headers['Retry-After']
+        : void 0;
     const isAcceptedWithRetryAfter: boolean =
       fetchResponse.status == 202 && !(retryAfterHeader == void 0);
     if (attemptNumber >= this.maxAttempts) {

package/src/networking/version.ts

@@ -1 +1 @@
-export const sdkVersion = '10.0.1';
+export const sdkVersion = '10.2.0';

package/src/schemas/index.ts

@@ -138,9 +138,10 @@ export * from './templateSigner';
 export * from './signTemplate';
 export * from './signTemplates';
 export * from './signRequestSignerInput';
-export * from './signRequestSigner';
 export * from './signRequestBase';
 export * from './signRequestCreateRequest';
+export * from './signRequestSignerAttachment';
+export * from './signRequestSigner';
 export * from './signRequest';
 export * from './signRequests';
 export * from './statusSkillCard';

package/src/schemas/signRequest.ts

@@ -93,6 +93,15 @@ export type SignRequest = SignRequestBase & {
   /**
    * The collaborator level of the user to the sign request. Values can include "owner", "editor", and "viewer". */
   readonly collaboratorLevel?: string | null;
+  /**
+   * Short identifier for the sign request. */
+  readonly shortId?: string;
+  /**
+   * Timestamp marking when the sign request was created. */
+  readonly createdAt?: DateTime;
+  /**
+   * Timestamp indicating when all signing actions completed. */
+  readonly finishedAt?: DateTime | null;
   /**
    * The email address of the sender of the sign request. */
   readonly senderEmail?: string | null;
@@ -263,6 +272,15 @@ export function serializeSignRequest(val: SignRequest): SerializedData {
           ? val.parentFolder
           : serializeFolderMini(val.parentFolder),
       ['collaborator_level']: val.collaboratorLevel,
+      ['short_id']: val.shortId,
+      ['created_at']:
+        val.createdAt == void 0
+          ? val.createdAt
+          : serializeDateTime(val.createdAt),
+      ['finished_at']:
+        val.finishedAt == void 0
+          ? val.finishedAt
+          : serializeDateTime(val.finishedAt),
       ['sender_email']: val.senderEmail,
       ['sender_id']: val.senderId,
     },
@@ -354,6 +372,27 @@ export function deserializeSignRequest(val: SerializedData): SignRequest {
   }
   const collaboratorLevel: undefined | string =
     val.collaborator_level == void 0 ? void 0 : val.collaborator_level;
+  if (!(val.short_id == void 0) && !sdIsString(val.short_id)) {
+    throw new BoxSdkError({
+      message: 'Expecting string for "short_id" of type "SignRequest"',
+    });
+  }
+  const shortId: undefined | string =
+    val.short_id == void 0 ? void 0 : val.short_id;
+  if (!(val.created_at == void 0) && !sdIsString(val.created_at)) {
+    throw new BoxSdkError({
+      message: 'Expecting string for "created_at" of type "SignRequest"',
+    });
+  }
+  const createdAt: undefined | DateTime =
+    val.created_at == void 0 ? void 0 : deserializeDateTime(val.created_at);
+  if (!(val.finished_at == void 0) && !sdIsString(val.finished_at)) {
+    throw new BoxSdkError({
+      message: 'Expecting string for "finished_at" of type "SignRequest"',
+    });
+  }
+  const finishedAt: undefined | DateTime =
+    val.finished_at == void 0 ? void 0 : deserializeDateTime(val.finished_at);
   if (!(val.sender_email == void 0) && !sdIsString(val.sender_email)) {
     throw new BoxSdkError({
       message: 'Expecting string for "sender_email" of type "SignRequest"',
@@ -503,6 +542,9 @@ export function deserializeSignRequest(val: SerializedData): SignRequest {
     autoExpireAt: autoExpireAt,
     parentFolder: parentFolder,
     collaboratorLevel: collaboratorLevel,
+    shortId: shortId,
+    createdAt: createdAt,
+    finishedAt: finishedAt,
     senderEmail: senderEmail,
     senderId: senderId,
     isDocumentPreparationNeeded: isDocumentPreparationNeeded,

package/src/schemas/signRequestSigner.ts

@@ -4,11 +4,14 @@ import { serializeSignRequestCreateSigner } from './signRequestCreateSigner';
 import { deserializeSignRequestCreateSigner } from './signRequestCreateSigner';
 import { serializeSignRequestSignerInput } from './signRequestSignerInput';
 import { deserializeSignRequestSignerInput } from './signRequestSignerInput';
+import { serializeSignRequestSignerAttachment } from './signRequestSignerAttachment';
+import { deserializeSignRequestSignerAttachment } from './signRequestSignerAttachment';
 import { serializeDateTime } from '../internal/utils';
 import { deserializeDateTime } from '../internal/utils';
 import { SignRequestCreateSignerRoleField } from './signRequestCreateSigner';
 import { SignRequestCreateSigner } from './signRequestCreateSigner';
 import { SignRequestSignerInput } from './signRequestSignerInput';
+import { SignRequestSignerAttachment } from './signRequestSignerAttachment';
 import { BoxSdkError } from '../box/errors';
 import { DateTime } from '../internal/utils';
 import { SerializedData } from '../serialization/json';
@@ -50,6 +53,9 @@ export type SignRequestSigner = SignRequestCreateSigner & {
    * parameter was passed in the
    * `create Box Sign request` call. */
   readonly iframeableEmbedUrl?: string | null;
+  /**
+   * Attachments that the signer uploaded. */
+  readonly attachments?: readonly SignRequestSignerAttachment[] | null;
 };
 export function serializeSignRequestSignerSignerDecisionTypeField(
   val: SignRequestSignerSignerDecisionTypeField,
@@ -145,6 +151,14 @@ export function serializeSignRequestSigner(
             }) as readonly any[]),
       ['embed_url']: val.embedUrl,
       ['iframeable_embed_url']: val.iframeableEmbedUrl,
+      ['attachments']:
+        val.attachments == void 0
+          ? val.attachments
+          : (val.attachments.map(function (
+              item: SignRequestSignerAttachment,
+            ): SerializedData {
+              return serializeSignRequestSignerAttachment(item);
+            }) as readonly any[]),
     },
   };
 }
@@ -204,6 +218,21 @@ export function deserializeSignRequestSigner(
   }
   const iframeableEmbedUrl: undefined | string =
     val.iframeable_embed_url == void 0 ? void 0 : val.iframeable_embed_url;
+  if (!(val.attachments == void 0) && !sdIsList(val.attachments)) {
+    throw new BoxSdkError({
+      message: 'Expecting array for "attachments" of type "SignRequestSigner"',
+    });
+  }
+  const attachments: undefined | readonly SignRequestSignerAttachment[] =
+    val.attachments == void 0
+      ? void 0
+      : sdIsList(val.attachments)
+        ? (val.attachments.map(function (
+            itm: SerializedData,
+          ): SignRequestSignerAttachment {
+            return deserializeSignRequestSignerAttachment(itm);
+          }) as readonly any[])
+        : [];
   if (!(val.email == void 0) && !sdIsString(val.email)) {
     throw new BoxSdkError({
       message: 'Expecting string for "email" of type "SignRequestSigner"',
@@ -313,6 +342,7 @@ export function deserializeSignRequestSigner(
     inputs: inputs,
     embedUrl: embedUrl,
     iframeableEmbedUrl: iframeableEmbedUrl,
+    attachments: attachments,
     email: email,
     role: role,
     isInPerson: isInPerson,

package/src/schemas/signRequestSignerAttachment.ts

@@ -0,0 +1,46 @@
+import { BoxSdkError } from '../box/errors';
+import { SerializedData } from '../serialization/json';
+import { sdIsEmpty } from '../serialization/json';
+import { sdIsBoolean } from '../serialization/json';
+import { sdIsNumber } from '../serialization/json';
+import { sdIsString } from '../serialization/json';
+import { sdIsList } from '../serialization/json';
+import { sdIsMap } from '../serialization/json';
+export interface SignRequestSignerAttachment {
+  /**
+   * Identifier of the attachment file. */
+  readonly id?: string | null;
+  /**
+   * Display name of the attachment file. */
+  readonly name?: string | null;
+  readonly rawData?: SerializedData;
+}
+export function serializeSignRequestSignerAttachment(
+  val: SignRequestSignerAttachment,
+): SerializedData {
+  return { ['id']: val.id, ['name']: val.name };
+}
+export function deserializeSignRequestSignerAttachment(
+  val: SerializedData,
+): SignRequestSignerAttachment {
+  if (!sdIsMap(val)) {
+    throw new BoxSdkError({
+      message: 'Expecting a map for "SignRequestSignerAttachment"',
+    });
+  }
+  if (!(val.id == void 0) && !sdIsString(val.id)) {
+    throw new BoxSdkError({
+      message:
+        'Expecting string for "id" of type "SignRequestSignerAttachment"',
+    });
+  }
+  const id: undefined | string = val.id == void 0 ? void 0 : val.id;
+  if (!(val.name == void 0) && !sdIsString(val.name)) {
+    throw new BoxSdkError({
+      message:
+        'Expecting string for "name" of type "SignRequestSignerAttachment"',
+    });
+  }
+  const name: undefined | string = val.name == void 0 ? void 0 : val.name;
+  return { id: id, name: name } satisfies SignRequestSignerAttachment;
+}

package/src/schemas/v2025R0/archiveV2025R0.ts

@@ -7,12 +7,21 @@ import { sdIsString } from '../../serialization/json';
 import { sdIsList } from '../../serialization/json';
 import { sdIsMap } from '../../serialization/json';
 export type ArchiveV2025R0TypeField = 'archive';
+export interface ArchiveV2025R0OwnedByField {
+  /**
+   * The unique identifier that represents a user who owns the archive. */
+  readonly id: string;
+  /**
+   * The value is always `user`. */
+  readonly type: string;
+  readonly rawData?: SerializedData;
+}
 export class ArchiveV2025R0 {
   /**
    * The unique identifier that represents an archive. */
   readonly id!: string;
   /**
-   * The value will always be `archive`. */
+   * The value is always `archive`. */
   readonly type: ArchiveV2025R0TypeField = 'archive' as ArchiveV2025R0TypeField;
   /**
    * The name of the archive.
@@ -25,6 +34,12 @@ export class ArchiveV2025R0 {
   /**
    * The size of the archive in bytes. */
   readonly size!: number;
+  /**
+   * The description of the archive. */
+  readonly description?: string | null;
+  /**
+   * The part of an archive API response that describes the user who owns the archive. */
+  readonly ownedBy?: ArchiveV2025R0OwnedByField;
   readonly rawData?: SerializedData;
   constructor(
     fields: Omit<ArchiveV2025R0, 'type'> &
@@ -42,6 +57,12 @@ export class ArchiveV2025R0 {
     if (fields.size !== undefined) {
       this.size = fields.size;
     }
+    if (fields.description !== undefined) {
+      this.description = fields.description;
+    }
+    if (fields.ownedBy !== undefined) {
+      this.ownedBy = fields.ownedBy;
+    }
     if (fields.rawData !== undefined) {
       this.rawData = fields.rawData;
     }
@@ -52,7 +73,7 @@ export interface ArchiveV2025R0Input {
    * The unique identifier that represents an archive. */
   readonly id: string;
   /**
-   * The value will always be `archive`. */
+   * The value is always `archive`. */
   readonly type?: ArchiveV2025R0TypeField;
   /**
    * The name of the archive.
@@ -65,6 +86,12 @@ export interface ArchiveV2025R0Input {
   /**
    * The size of the archive in bytes. */
   readonly size: number;
+  /**
+   * The description of the archive. */
+  readonly description?: string | null;
+  /**
+   * The part of an archive API response that describes the user who owns the archive. */
+  readonly ownedBy?: ArchiveV2025R0OwnedByField;
   readonly rawData?: SerializedData;
 }
 export function serializeArchiveV2025R0TypeField(
@@ -82,12 +109,57 @@ export function deserializeArchiveV2025R0TypeField(
     message: "Can't deserialize ArchiveV2025R0TypeField",
   });
 }
+export function serializeArchiveV2025R0OwnedByField(
+  val: ArchiveV2025R0OwnedByField,
+): SerializedData {
+  return { ['id']: val.id, ['type']: val.type };
+}
+export function deserializeArchiveV2025R0OwnedByField(
+  val: SerializedData,
+): ArchiveV2025R0OwnedByField {
+  if (!sdIsMap(val)) {
+    throw new BoxSdkError({
+      message: 'Expecting a map for "ArchiveV2025R0OwnedByField"',
+    });
+  }
+  if (val.id == void 0) {
+    throw new BoxSdkError({
+      message:
+        'Expecting "id" of type "ArchiveV2025R0OwnedByField" to be defined',
+    });
+  }
+  if (!sdIsString(val.id)) {
+    throw new BoxSdkError({
+      message: 'Expecting string for "id" of type "ArchiveV2025R0OwnedByField"',
+    });
+  }
+  const id: string = val.id;
+  if (val.type == void 0) {
+    throw new BoxSdkError({
+      message:
+        'Expecting "type" of type "ArchiveV2025R0OwnedByField" to be defined',
+    });
+  }
+  if (!sdIsString(val.type)) {
+    throw new BoxSdkError({
+      message:
+        'Expecting string for "type" of type "ArchiveV2025R0OwnedByField"',
+    });
+  }
+  const type: string = val.type;
+  return { id: id, type: type } satisfies ArchiveV2025R0OwnedByField;
+}
 export function serializeArchiveV2025R0(val: ArchiveV2025R0): SerializedData {
   return {
     ['id']: val.id,
     ['type']: serializeArchiveV2025R0TypeField(val.type),
     ['name']: val.name,
     ['size']: val.size,
+    ['description']: val.description,
+    ['owned_by']:
+      val.ownedBy == void 0
+        ? val.ownedBy
+        : serializeArchiveV2025R0OwnedByField(val.ownedBy),
   };
 }
 export function deserializeArchiveV2025R0(val: SerializedData): ArchiveV2025R0 {
@@ -135,11 +207,24 @@ export function deserializeArchiveV2025R0(val: SerializedData): ArchiveV2025R0 {
     });
   }
   const size: number = val.size;
+  if (!(val.description == void 0) && !sdIsString(val.description)) {
+    throw new BoxSdkError({
+      message: 'Expecting string for "description" of type "ArchiveV2025R0"',
+    });
+  }
+  const description: undefined | string =
+    val.description == void 0 ? void 0 : val.description;
+  const ownedBy: undefined | ArchiveV2025R0OwnedByField =
+    val.owned_by == void 0
+      ? void 0
+      : deserializeArchiveV2025R0OwnedByField(val.owned_by);
   return {
     id: id,
     type: type,
     name: name,
     size: size,
+    description: description,
+    ownedBy: ownedBy,
   } satisfies ArchiveV2025R0;
 }
 export function serializeArchiveV2025R0Input(
@@ -153,6 +238,11 @@ export function serializeArchiveV2025R0Input(
         : serializeArchiveV2025R0TypeField(val.type),
     ['name']: val.name,
     ['size']: val.size,
+    ['description']: val.description,
+    ['owned_by']:
+      val.ownedBy == void 0
+        ? val.ownedBy
+        : serializeArchiveV2025R0OwnedByField(val.ownedBy),
   };
 }
 export function deserializeArchiveV2025R0Input(
@@ -198,10 +288,24 @@ export function deserializeArchiveV2025R0Input(
     });
   }
   const size: number = val.size;
+  if (!(val.description == void 0) && !sdIsString(val.description)) {
+    throw new BoxSdkError({
+      message:
+        'Expecting string for "description" of type "ArchiveV2025R0Input"',
+    });
+  }
+  const description: undefined | string =
+    val.description == void 0 ? void 0 : val.description;
+  const ownedBy: undefined | ArchiveV2025R0OwnedByField =
+    val.owned_by == void 0
+      ? void 0
+      : deserializeArchiveV2025R0OwnedByField(val.owned_by);
   return {
     id: id,
     type: type,
     name: name,
     size: size,
+    description: description,
+    ownedBy: ownedBy,
   } satisfies ArchiveV2025R0Input;
 }