12885736841

Committed 21 Jan 2025 11:12AM UTC coverage: 42.412% (-0.007%) from 42.419%

Build # 12885736841

Build Type

Pull #489

github

Committed by

web-flow

Commit Message

Merge 93beb8af7 into 2a24c7a0d

Pull Request Pull Request #489: fix: correct param types in file representation (box/box-openapi#503)

Run Details

3990 of 16001 branches covered (24.94%)

Branch coverage included in aggregate %.

1 of 5 new or added lines in 2 files covered. (20.0%)

4 existing lines in 2 files now uncovered.

14247 of 26999 relevant lines covered (52.77%)

92.89 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

56.62

/src/schemas/signRequest.generated.ts

import { serializeSignRequestPrefillTag } from './signRequestPrefillTag.generated.js';
import { deserializeSignRequestPrefillTag } from './signRequestPrefillTag.generated.js';
import { serializeSignRequestBase } from './signRequestBase.generated.js';
import { deserializeSignRequestBase } from './signRequestBase.generated.js';
import { serializeFileBase } from './fileBase.generated.js';
import { deserializeFileBase } from './fileBase.generated.js';
import { serializeSignRequestSigner } from './signRequestSigner.generated.js';
import { deserializeSignRequestSigner } from './signRequestSigner.generated.js';
import { serializeFileMini } from './fileMini.generated.js';
import { deserializeFileMini } from './fileMini.generated.js';
import { serializeFolderMini } from './folderMini.generated.js';
import { deserializeFolderMini } from './folderMini.generated.js';
import { serializeDateTime } from '../internal/utils.js';
import { deserializeDateTime } from '../internal/utils.js';
import { SignRequestPrefillTag } from './signRequestPrefillTag.generated.js';
import { SignRequestBase } from './signRequestBase.generated.js';
import { FileBase } from './fileBase.generated.js';
import { SignRequestSigner } from './signRequestSigner.generated.js';
import { FileMini } from './fileMini.generated.js';
import { FolderMini } from './folderMini.generated.js';
import { BoxSdkError } from '../box/errors.js';
import { DateTime } from '../internal/utils.js';
import { SerializedData } from '../serialization/json.js';
import { sdIsEmpty } from '../serialization/json.js';
import { sdIsBoolean } from '../serialization/json.js';
import { sdIsNumber } from '../serialization/json.js';
import { sdIsString } from '../serialization/json.js';
import { sdIsList } from '../serialization/json.js';
import { sdIsMap } from '../serialization/json.js';
export type SignRequestTypeField = 'sign-request';
export type SignRequestStatusField =
  | 'converting'
  | 'created'
  | 'sent'
  | 'viewed'
  | 'signed'
  | 'cancelled'
  | 'declined'
  | 'error_converting'
  | 'error_sending'
  | 'expired'
  | 'finalizing'
  | 'error_finalizing'
  | string;
export interface SignRequestSignFilesField {
  readonly files?: readonly FileMini[];
  /**
   * Indicates whether the `sign_files` documents are processing
   * and the PDFs may be out of date. A change to any document
   * requires processing on all `sign_files`. We
   * recommended waiting until processing is finished
   * (and this value is true) before downloading the PDFs. */
  readonly isReadyForDownload?: boolean;
  readonly rawData?: SerializedData;
}
export type SignRequest = SignRequestBase & {
  /**
   * object type */
  readonly type?: SignRequestTypeField;
  /**
   * List of files to create a signing document from. This is currently limited to ten files. Only the ID and type fields are required for each file. */
  readonly sourceFiles?: readonly FileBase[];
  /**
   * Array of signers for the signature request. */
  readonly signers?: readonly SignRequestSigner[];
  /**
   * Force a specific color for the signature (blue, black, or red). */
  readonly signatureColor?: string | null;
  /**
   * Box Sign request ID. */
  readonly id?: string;
  /**
   * This URL is returned if `is_document_preparation_needed` is
   * set to `true` in the request. The parameter is used to prepare
   * the signature request
   * using the UI. The signature request is not
   * sent until the preparation
   * phase is complete. */
  readonly prepareUrl?: string | null;
  readonly signingLog?: FileMini;
  /**
   * Describes the status of the signature request. */
  readonly status?: SignRequestStatusField;
  /**
   * List of files that will be signed, which are copies of the original
   * source files. A new version of these files are created as signers sign
   * and can be downloaded at any point in the signing process. */
  readonly signFiles?: SignRequestSignFilesField;
  /**
   * Uses `days_valid` to calculate the date and time, in GMT, the sign request will expire if unsigned. */
  readonly autoExpireAt?: DateTime | null;
  readonly parentFolder?: FolderMini;
};
export function serializeSignRequestTypeField(
  val: SignRequestTypeField,
): SerializedData {
  return val;
}
export function deserializeSignRequestTypeField(
  val: SerializedData,
): SignRequestTypeField {
  if (val == 'sign-request') {
    return val;
  }
  throw new BoxSdkError({ message: "Can't deserialize SignRequestTypeField" });
}
export function serializeSignRequestStatusField(
  val: SignRequestStatusField,
): SerializedData {
  return val;
}
export function deserializeSignRequestStatusField(
  val: SerializedData,
): SignRequestStatusField {
  if (val == 'converting') {
    return val;
  }
  if (val == 'created') {
    return val;
  }
  if (val == 'sent') {
    return val;
  }
  if (val == 'viewed') {
    return val;
  }
  if (val == 'signed') {
    return val;
  }
  if (val == 'cancelled') {
    return val;
  }
  if (val == 'declined') {
    return val;
  }
  if (val == 'error_converting') {
    return val;
  }
  if (val == 'error_sending') {
    return val;
  }
  if (val == 'expired') {
    return val;
  }
  if (val == 'finalizing') {
    return val;
  }
  if (val == 'error_finalizing') {
    return val;
  }
  if (sdIsString(val)) {
    return val;
  }
  throw new BoxSdkError({
    message: "Can't deserialize SignRequestStatusField",
  });
}
export function serializeSignRequestSignFilesField(
  val: SignRequestSignFilesField,
): SerializedData {
  return {
    ['files']:
      val.files == void 0
        ? val.files
        : (val.files.map(function (item: FileMini): SerializedData {
            return serializeFileMini(item);
          }) as readonly any[]),
    ['is_ready_for_download']: val.isReadyForDownload,
  };
}
export function deserializeSignRequestSignFilesField(
  val: SerializedData,
): SignRequestSignFilesField {
  if (!sdIsMap(val)) {
    throw new BoxSdkError({
      message: 'Expecting a map for "SignRequestSignFilesField"',
    });
  }
  if (!(val.files == void 0) && !sdIsList(val.files)) {
    throw new BoxSdkError({
      message:
        'Expecting array for "files" of type "SignRequestSignFilesField"',
    });
  }
  const files: undefined | readonly FileMini[] =
    val.files == void 0
      ? void 0
      : sdIsList(val.files)
        ? (val.files.map(function (itm: SerializedData): FileMini {
            return deserializeFileMini(itm);
          }) as readonly any[])
        : [];
  if (
    !(val.is_ready_for_download == void 0) &&
    !sdIsBoolean(val.is_ready_for_download)
  ) {
    throw new BoxSdkError({
      message:
        'Expecting boolean for "is_ready_for_download" of type "SignRequestSignFilesField"',
    });
  }
  const isReadyForDownload: undefined | boolean =
    val.is_ready_for_download == void 0 ? void 0 : val.is_ready_for_download;
  return {
    files: files,
    isReadyForDownload: isReadyForDownload,
  } satisfies SignRequestSignFilesField;
}
export function serializeSignRequest(val: SignRequest): SerializedData {
  const base: any = serializeSignRequestBase(val);
  if (!sdIsMap(base)) {
    throw new BoxSdkError({ message: 'Expecting a map for "SignRequest"' });
  }
  return {
    ...base,
    ...{
      ['type']:
        val.type == void 0 ? val.type : serializeSignRequestTypeField(val.type),
      ['source_files']:
        val.sourceFiles == void 0
          ? val.sourceFiles
          : (val.sourceFiles.map(function (item: FileBase): SerializedData {
              return serializeFileBase(item);
            }) as readonly any[]),
      ['signers']:
        val.signers == void 0
          ? val.signers
          : (val.signers.map(function (
              item: SignRequestSigner,
            ): SerializedData {
              return serializeSignRequestSigner(item);
            }) as readonly any[]),
      ['signature_color']: val.signatureColor,
      ['id']: val.id,
      ['prepare_url']: val.prepareUrl,
      ['signing_log']:
        val.signingLog == void 0
          ? val.signingLog
          : serializeFileMini(val.signingLog),
      ['status']:
        val.status == void 0
          ? val.status
          : serializeSignRequestStatusField(val.status),
      ['sign_files']:
        val.signFiles == void 0
          ? val.signFiles
          : serializeSignRequestSignFilesField(val.signFiles),
      ['auto_expire_at']:
        val.autoExpireAt == void 0
          ? val.autoExpireAt
          : serializeDateTime(val.autoExpireAt),
      ['parent_folder']:
        val.parentFolder == void 0
          ? val.parentFolder
          : serializeFolderMini(val.parentFolder),
    },
  };
}
export function deserializeSignRequest(val: SerializedData): SignRequest {
  if (!sdIsMap(val)) {
    throw new BoxSdkError({ message: 'Expecting a map for "SignRequest"' });
  }
  const type: undefined | SignRequestTypeField =
    val.type == void 0 ? void 0 : deserializeSignRequestTypeField(val.type);
  if (!(val.source_files == void 0) && !sdIsList(val.source_files)) {
    throw new BoxSdkError({
      message: 'Expecting array for "source_files" of type "SignRequest"',
    });
  }
  const sourceFiles: undefined | readonly FileBase[] =
    val.source_files == void 0
      ? void 0
      : sdIsList(val.source_files)
        ? (val.source_files.map(function (itm: SerializedData): FileBase {
            return deserializeFileBase(itm);
          }) as readonly any[])
        : [];
  if (!(val.signers == void 0) && !sdIsList(val.signers)) {
    throw new BoxSdkError({
      message: 'Expecting array for "signers" of type "SignRequest"',
    });
  }
  const signers: undefined | readonly SignRequestSigner[] =
    val.signers == void 0
      ? void 0
      : sdIsList(val.signers)
        ? (val.signers.map(function (itm: SerializedData): SignRequestSigner {
            return deserializeSignRequestSigner(itm);
          }) as readonly any[])
        : [];
  if (!(val.signature_color == void 0) && !sdIsString(val.signature_color)) {
    throw new BoxSdkError({
      message: 'Expecting string for "signature_color" of type "SignRequest"',
    });
  }
  const signatureColor: undefined | string =
    val.signature_color == void 0 ? void 0 : val.signature_color;
  if (!(val.id == void 0) && !sdIsString(val.id)) {
    throw new BoxSdkError({
      message: 'Expecting string for "id" of type "SignRequest"',
    });
  }
  const id: undefined | string = val.id == void 0 ? void 0 : val.id;
  if (!(val.prepare_url == void 0) && !sdIsString(val.prepare_url)) {
    throw new BoxSdkError({
      message: 'Expecting string for "prepare_url" of type "SignRequest"',
    });
  }
  const prepareUrl: undefined | string =
    val.prepare_url == void 0 ? void 0 : val.prepare_url;
  const signingLog: undefined | FileMini =
    val.signing_log == void 0 ? void 0 : deserializeFileMini(val.signing_log);
  const status: undefined | SignRequestStatusField =
    val.status == void 0
      ? void 0
      : deserializeSignRequestStatusField(val.status);
  const signFiles: undefined | SignRequestSignFilesField =
    val.sign_files == void 0
      ? void 0
      : deserializeSignRequestSignFilesField(val.sign_files);
  if (!(val.auto_expire_at == void 0) && !sdIsString(val.auto_expire_at)) {
    throw new BoxSdkError({
      message: 'Expecting string for "auto_expire_at" of type "SignRequest"',
    });
  }
  const autoExpireAt: undefined | DateTime =
    val.auto_expire_at == void 0
      ? void 0
      : deserializeDateTime(val.auto_expire_at);
  const parentFolder: undefined | FolderMini =
    val.parent_folder == void 0
      ? void 0
      : deserializeFolderMini(val.parent_folder);
  if (
    !(val.is_document_preparation_needed == void 0) &&
    !sdIsBoolean(val.is_document_preparation_needed)
  ) {
    throw new BoxSdkError({
      message:
        'Expecting boolean for "is_document_preparation_needed" of type "SignRequest"',
    });
  }
  const isDocumentPreparationNeeded: undefined | boolean =
    val.is_document_preparation_needed == void 0
      ? void 0
      : val.is_document_preparation_needed;
  if (!(val.redirect_url == void 0) && !sdIsString(val.redirect_url)) {
    throw new BoxSdkError({
      message: 'Expecting string for "redirect_url" of type "SignRequest"',
    });
  }
  const redirectUrl: undefined | string =
    val.redirect_url == void 0 ? void 0 : val.redirect_url;
  if (
    !(val.declined_redirect_url == void 0) &&
    !sdIsString(val.declined_redirect_url)
  ) {
    throw new BoxSdkError({
      message:
        'Expecting string for "declined_redirect_url" of type "SignRequest"',
    });
  }
  const declinedRedirectUrl: undefined | string =
    val.declined_redirect_url == void 0 ? void 0 : val.declined_redirect_url;
  if (
    !(val.are_text_signatures_enabled == void 0) &&
    !sdIsBoolean(val.are_text_signatures_enabled)
  ) {
    throw new BoxSdkError({
      message:
        'Expecting boolean for "are_text_signatures_enabled" of type "SignRequest"',
    });
  }
  const areTextSignaturesEnabled: undefined | boolean =
    val.are_text_signatures_enabled == void 0
      ? void 0
      : val.are_text_signatures_enabled;
  if (!(val.email_subject == void 0) && !sdIsString(val.email_subject)) {
    throw new BoxSdkError({
      message: 'Expecting string for "email_subject" of type "SignRequest"',
    });
  }
  const emailSubject: undefined | string =
    val.email_subject == void 0 ? void 0 : val.email_subject;
  if (!(val.email_message == void 0) && !sdIsString(val.email_message)) {
    throw new BoxSdkError({
      message: 'Expecting string for "email_message" of type "SignRequest"',
    });
  }
  const emailMessage: undefined | string =
    val.email_message == void 0 ? void 0 : val.email_message;
  if (
    !(val.are_reminders_enabled == void 0) &&
    !sdIsBoolean(val.are_reminders_enabled)
  ) {
    throw new BoxSdkError({
      message:
        'Expecting boolean for "are_reminders_enabled" of type "SignRequest"',
    });
  }
  const areRemindersEnabled: undefined | boolean =
    val.are_reminders_enabled == void 0 ? void 0 : val.are_reminders_enabled;
  if (!(val.name == void 0) && !sdIsString(val.name)) {
    throw new BoxSdkError({
      message: 'Expecting string for "name" of type "SignRequest"',
    });
  }
  const name: undefined | string = val.name == void 0 ? void 0 : val.name;
  if (!(val.prefill_tags == void 0) && !sdIsList(val.prefill_tags)) {
    throw new BoxSdkError({
      message: 'Expecting array for "prefill_tags" of type "SignRequest"',
    });
  }
  const prefillTags: undefined | readonly SignRequestPrefillTag[] =
    val.prefill_tags == void 0
      ? void 0
      : sdIsList(val.prefill_tags)
        ? (val.prefill_tags.map(function (
            itm: SerializedData,
          ): SignRequestPrefillTag {
            return deserializeSignRequestPrefillTag(itm);
          }) as readonly any[])
        : [];
  if (!(val.days_valid == void 0) && !sdIsNumber(val.days_valid)) {
    throw new BoxSdkError({
      message: 'Expecting number for "days_valid" of type "SignRequest"',
    });
  }
  const daysValid: undefined | number =
    val.days_valid == void 0 ? void 0 : val.days_valid;
  if (!(val.external_id == void 0) && !sdIsString(val.external_id)) {
    throw new BoxSdkError({
      message: 'Expecting string for "external_id" of type "SignRequest"',
    });
  }
  const externalId: undefined | string =
    val.external_id == void 0 ? void 0 : val.external_id;
  if (!(val.template_id == void 0) && !sdIsString(val.template_id)) {
    throw new BoxSdkError({
      message: 'Expecting string for "template_id" of type "SignRequest"',
    });
  }
  const templateId: undefined | string =
    val.template_id == void 0 ? void 0 : val.template_id;
  if (
    !(val.external_system_name == void 0) &&
    !sdIsString(val.external_system_name)
  ) {
    throw new BoxSdkError({
      message:
        'Expecting string for "external_system_name" of type "SignRequest"',
    });
  }
  const externalSystemName: undefined | string =
    val.external_system_name == void 0 ? void 0 : val.external_system_name;
  return {
    type: type,
    sourceFiles: sourceFiles,
    signers: signers,
    signatureColor: signatureColor,
    id: id,
    prepareUrl: prepareUrl,
    signingLog: signingLog,
    status: status,
    signFiles: signFiles,
    autoExpireAt: autoExpireAt,
    parentFolder: parentFolder,
    isDocumentPreparationNeeded: isDocumentPreparationNeeded,
    redirectUrl: redirectUrl,
    declinedRedirectUrl: declinedRedirectUrl,
    areTextSignaturesEnabled: areTextSignaturesEnabled,
    emailSubject: emailSubject,
    emailMessage: emailMessage,
    areRemindersEnabled: areRemindersEnabled,
    name: name,
    prefillTags: prefillTags,
    daysValid: daysValid,
    externalId: externalId,
    templateId: templateId,
    externalSystemName: externalSystemName,
  } satisfies SignRequest;
}

1	import { serializeSignRequestPrefillTag } from './signRequestPrefillTag.generated.js';
2	import { deserializeSignRequestPrefillTag } from './signRequestPrefillTag.generated.js';	144✔
3	import { serializeSignRequestBase } from './signRequestBase.generated.js';	144✔
4	import { deserializeSignRequestBase } from './signRequestBase.generated.js';
5	import { serializeFileBase } from './fileBase.generated.js';	144✔
6	import { deserializeFileBase } from './fileBase.generated.js';	144✔
7	import { serializeSignRequestSigner } from './signRequestSigner.generated.js';	144✔
8	import { deserializeSignRequestSigner } from './signRequestSigner.generated.js';	144✔
9	import { serializeFileMini } from './fileMini.generated.js';	144✔
10	import { deserializeFileMini } from './fileMini.generated.js';	144✔
11	import { serializeFolderMini } from './folderMini.generated.js';	144✔
12	import { deserializeFolderMini } from './folderMini.generated.js';	144✔
13	import { serializeDateTime } from '../internal/utils.js';	144✔
14	import { deserializeDateTime } from '../internal/utils.js';	144✔
15	import { SignRequestPrefillTag } from './signRequestPrefillTag.generated.js';
16	import { SignRequestBase } from './signRequestBase.generated.js';
17	import { FileBase } from './fileBase.generated.js';
18	import { SignRequestSigner } from './signRequestSigner.generated.js';
19	import { FileMini } from './fileMini.generated.js';
20	import { FolderMini } from './folderMini.generated.js';
21	import { BoxSdkError } from '../box/errors.js';	144✔
22	import { DateTime } from '../internal/utils.js';
23	import { SerializedData } from '../serialization/json.js';
24	import { sdIsEmpty } from '../serialization/json.js';
25	import { sdIsBoolean } from '../serialization/json.js';	144✔
26	import { sdIsNumber } from '../serialization/json.js';	144✔
27	import { sdIsString } from '../serialization/json.js';	144✔
28	import { sdIsList } from '../serialization/json.js';	144✔
29	import { sdIsMap } from '../serialization/json.js';	144✔
30	export type SignRequestTypeField = 'sign-request';
31	export type SignRequestStatusField =
32	\| 'converting'
33	\| 'created'
34	\| 'sent'
35	\| 'viewed'
36	\| 'signed'
37	\| 'cancelled'
38	\| 'declined'
39	\| 'error_converting'
40	\| 'error_sending'
41	\| 'expired'
42	\| 'finalizing'
43	\| 'error_finalizing'
44	\| string;
45	export interface SignRequestSignFilesField {
46	readonly files?: readonly FileMini[];
47	/**
48	* Indicates whether the `sign_files` documents are processing
49	* and the PDFs may be out of date. A change to any document
50	* requires processing on all `sign_files`. We
51	* recommended waiting until processing is finished
52	* (and this value is true) before downloading the PDFs. */
53	readonly isReadyForDownload?: boolean;
54	readonly rawData?: SerializedData;
55	}
56	export type SignRequest = SignRequestBase & {
57	/**
58	* object type */
59	readonly type?: SignRequestTypeField;
60	/**
61	* List of files to create a signing document from. This is currently limited to ten files. Only the ID and type fields are required for each file. */
62	readonly sourceFiles?: readonly FileBase[];
63	/**
64	* Array of signers for the signature request. */
65	readonly signers?: readonly SignRequestSigner[];
66	/**
67	* Force a specific color for the signature (blue, black, or red). */
68	readonly signatureColor?: string \| null;
69	/**
70	* Box Sign request ID. */
71	readonly id?: string;
72	/**
73	* This URL is returned if `is_document_preparation_needed` is
74	* set to `true` in the request. The parameter is used to prepare
75	* the signature request
76	* using the UI. The signature request is not
77	* sent until the preparation
78	* phase is complete. */
79	readonly prepareUrl?: string \| null;
80	readonly signingLog?: FileMini;
81	/**
82	* Describes the status of the signature request. */
83	readonly status?: SignRequestStatusField;
84	/**
85	* List of files that will be signed, which are copies of the original
86	* source files. A new version of these files are created as signers sign
87	* and can be downloaded at any point in the signing process. */
88	readonly signFiles?: SignRequestSignFilesField;
89	/**
90	* Uses `days_valid` to calculate the date and time, in GMT, the sign request will expire if unsigned. */
91	readonly autoExpireAt?: DateTime \| null;
92	readonly parentFolder?: FolderMini;
93	};
94	export function serializeSignRequestTypeField(	144✔
95	val: SignRequestTypeField,
96	): SerializedData {
97	return val;	×
98	}
99	export function deserializeSignRequestTypeField(	144✔
100	val: SerializedData,
101	): SignRequestTypeField {
102	if (val == 'sign-request') {	10✔
103	return val;	10✔
104	}
105	throw new BoxSdkError({ message: "Can't deserialize SignRequestTypeField" });	×
106	}
107	export function serializeSignRequestStatusField(	144✔
108	val: SignRequestStatusField,
109	): SerializedData {
110	return val;	×
111	}
112	export function deserializeSignRequestStatusField(	144✔
113	val: SerializedData,
114	): SignRequestStatusField {
115	if (val == 'converting') {	10✔
116	return val;	6✔
117	}
118	if (val == 'created') {	4!
119	return val;	×
120	}
121	if (val == 'sent') {	4!
122	return val;	×
123	}
124	if (val == 'viewed') {	4!
125	return val;	×
126	}
127	if (val == 'signed') {	4!
128	return val;	×
129	}
130	if (val == 'cancelled') {	4✔
131	return val;	4✔
132	}
UNCOV 133	if (val == 'declined') {	×
134	return val;	×
135	}
UNCOV 136	if (val == 'error_converting') {	×
UNCOV 137	return val;	×
138	}
139	if (val == 'error_sending') {	×
140	return val;	×
141	}
142	if (val == 'expired') {	×
143	return val;	×
144	}
145	if (val == 'finalizing') {	×
146	return val;	×
147	}
148	if (val == 'error_finalizing') {	×
149	return val;	×
150	}
151	if (sdIsString(val)) {	×
152	return val;	×
153	}
154	throw new BoxSdkError({	×
155	message: "Can't deserialize SignRequestStatusField",
156	});
157	}
158	export function serializeSignRequestSignFilesField(	144✔
159	val: SignRequestSignFilesField,
160	): SerializedData {
161	return {	×
162	['files']:
163	val.files == void 0	×
164	? val.files
165	: (val.files.map(function (item: FileMini): SerializedData {
166	return serializeFileMini(item);	×
167	}) as readonly any[]),
168	['is_ready_for_download']: val.isReadyForDownload,
169	};
170	}
171	export function deserializeSignRequestSignFilesField(	144✔
172	val: SerializedData,
173	): SignRequestSignFilesField {
174	if (!sdIsMap(val)) {	10!
175	throw new BoxSdkError({	×
176	message: 'Expecting a map for "SignRequestSignFilesField"',
177	});
178	}
179	if (!(val.files == void 0) && !sdIsList(val.files)) {	10!
180	throw new BoxSdkError({	×
181	message:
182	'Expecting array for "files" of type "SignRequestSignFilesField"',
183	});
184	}
185	const files: undefined \| readonly FileMini[] =
186	val.files == void 0	10!
187	? void 0
188	: sdIsList(val.files)	10!
189	? (val.files.map(function (itm: SerializedData): FileMini {
190	return deserializeFileMini(itm);	10✔
191	}) as readonly any[])
192	: [];
193	if (	10!
194	!(val.is_ready_for_download == void 0) &&	20✔
195	!sdIsBoolean(val.is_ready_for_download)
196	) {
197	throw new BoxSdkError({	×
198	message:
199	'Expecting boolean for "is_ready_for_download" of type "SignRequestSignFilesField"',
200	});
201	}
202	const isReadyForDownload: undefined \| boolean =
203	val.is_ready_for_download == void 0 ? void 0 : val.is_ready_for_download;	10!
204	return {	10✔
205	files: files,
206	isReadyForDownload: isReadyForDownload,
207	} satisfies SignRequestSignFilesField;
208	}
209	export function serializeSignRequest(val: SignRequest): SerializedData {	144✔
210	const base: any = serializeSignRequestBase(val);	×
211	if (!sdIsMap(base)) {	×
212	throw new BoxSdkError({ message: 'Expecting a map for "SignRequest"' });	×
213	}
214	return {	×
215	...base,
216	...{
217	['type']:
218	val.type == void 0 ? val.type : serializeSignRequestTypeField(val.type),	×
219	['source_files']:
220	val.sourceFiles == void 0	×
221	? val.sourceFiles
222	: (val.sourceFiles.map(function (item: FileBase): SerializedData {
223	return serializeFileBase(item);	×
224	}) as readonly any[]),
225	['signers']:
226	val.signers == void 0	×
227	? val.signers
228	: (val.signers.map(function (
229	item: SignRequestSigner,
230	): SerializedData {
231	return serializeSignRequestSigner(item);	×
232	}) as readonly any[]),
233	['signature_color']: val.signatureColor,
234	['id']: val.id,
235	['prepare_url']: val.prepareUrl,
236	['signing_log']:
237	val.signingLog == void 0	×
238	? val.signingLog
239	: serializeFileMini(val.signingLog),
240	['status']:
241	val.status == void 0	×
242	? val.status
243	: serializeSignRequestStatusField(val.status),
244	['sign_files']:
245	val.signFiles == void 0	×
246	? val.signFiles
247	: serializeSignRequestSignFilesField(val.signFiles),
248	['auto_expire_at']:
249	val.autoExpireAt == void 0	×
250	? val.autoExpireAt
251	: serializeDateTime(val.autoExpireAt),
252	['parent_folder']:
253	val.parentFolder == void 0	×
254	? val.parentFolder
255	: serializeFolderMini(val.parentFolder),
256	},
257	};
258	}
259	export function deserializeSignRequest(val: SerializedData): SignRequest {	144✔
260	if (!sdIsMap(val)) {	10!
261	throw new BoxSdkError({ message: 'Expecting a map for "SignRequest"' });	×
262	}
263	const type: undefined \| SignRequestTypeField =
264	val.type == void 0 ? void 0 : deserializeSignRequestTypeField(val.type);	10!
265	if (!(val.source_files == void 0) && !sdIsList(val.source_files)) {	10!
266	throw new BoxSdkError({	×
267	message: 'Expecting array for "source_files" of type "SignRequest"',
268	});
269	}
270	const sourceFiles: undefined \| readonly FileBase[] =
271	val.source_files == void 0	10!
272	? void 0
273	: sdIsList(val.source_files)	10!
274	? (val.source_files.map(function (itm: SerializedData): FileBase {
275	return deserializeFileBase(itm);	10✔
276	}) as readonly any[])
277	: [];
278	if (!(val.signers == void 0) && !sdIsList(val.signers)) {	10!
279	throw new BoxSdkError({	×
280	message: 'Expecting array for "signers" of type "SignRequest"',
281	});
282	}
283	const signers: undefined \| readonly SignRequestSigner[] =
284	val.signers == void 0	10!
285	? void 0
286	: sdIsList(val.signers)	10!
287	? (val.signers.map(function (itm: SerializedData): SignRequestSigner {
288	return deserializeSignRequestSigner(itm);	22✔
289	}) as readonly any[])
290	: [];
291	if (!(val.signature_color == void 0) && !sdIsString(val.signature_color)) {	10!
292	throw new BoxSdkError({	×
293	message: 'Expecting string for "signature_color" of type "SignRequest"',
294	});
295	}
296	const signatureColor: undefined \| string =
297	val.signature_color == void 0 ? void 0 : val.signature_color;	10!
298	if (!(val.id == void 0) && !sdIsString(val.id)) {	10!
299	throw new BoxSdkError({	×
300	message: 'Expecting string for "id" of type "SignRequest"',
301	});
302	}
303	const id: undefined \| string = val.id == void 0 ? void 0 : val.id;	10!
304	if (!(val.prepare_url == void 0) && !sdIsString(val.prepare_url)) {	10!
305	throw new BoxSdkError({	×
306	message: 'Expecting string for "prepare_url" of type "SignRequest"',
307	});
308	}
309	const prepareUrl: undefined \| string =
310	val.prepare_url == void 0 ? void 0 : val.prepare_url;	10!
311	const signingLog: undefined \| FileMini =
312	val.signing_log == void 0 ? void 0 : deserializeFileMini(val.signing_log);	10!
313	const status: undefined \| SignRequestStatusField =
314	val.status == void 0	10!
315	? void 0
316	: deserializeSignRequestStatusField(val.status);
317	const signFiles: undefined \| SignRequestSignFilesField =
318	val.sign_files == void 0	10!
319	? void 0
320	: deserializeSignRequestSignFilesField(val.sign_files);
321	if (!(val.auto_expire_at == void 0) && !sdIsString(val.auto_expire_at)) {	10!
322	throw new BoxSdkError({	×
323	message: 'Expecting string for "auto_expire_at" of type "SignRequest"',
324	});
325	}
326	const autoExpireAt: undefined \| DateTime =
327	val.auto_expire_at == void 0	10✔
328	? void 0
329	: deserializeDateTime(val.auto_expire_at);
330	const parentFolder: undefined \| FolderMini =
331	val.parent_folder == void 0	10!
332	? void 0
333	: deserializeFolderMini(val.parent_folder);
334	if (	10!
335	!(val.is_document_preparation_needed == void 0) &&	20✔
336	!sdIsBoolean(val.is_document_preparation_needed)
337	) {
338	throw new BoxSdkError({	×
339	message:
340	'Expecting boolean for "is_document_preparation_needed" of type "SignRequest"',
341	});
342	}
343	const isDocumentPreparationNeeded: undefined \| boolean =
344	val.is_document_preparation_needed == void 0	10!
345	? void 0
346	: val.is_document_preparation_needed;
347	if (!(val.redirect_url == void 0) && !sdIsString(val.redirect_url)) {	10!
348	throw new BoxSdkError({	×
349	message: 'Expecting string for "redirect_url" of type "SignRequest"',
350	});
351	}
352	const redirectUrl: undefined \| string =
353	val.redirect_url == void 0 ? void 0 : val.redirect_url;	10✔
354	if (	10!
355	!(val.declined_redirect_url == void 0) &&	18✔
356	!sdIsString(val.declined_redirect_url)
357	) {
358	throw new BoxSdkError({	×
359	message:
360	'Expecting string for "declined_redirect_url" of type "SignRequest"',
361	});
362	}
363	const declinedRedirectUrl: undefined \| string =
364	val.declined_redirect_url == void 0 ? void 0 : val.declined_redirect_url;	10✔
365	if (	10!
366	!(val.are_text_signatures_enabled == void 0) &&	20✔
367	!sdIsBoolean(val.are_text_signatures_enabled)
368	) {
369	throw new BoxSdkError({	×
370	message:
371	'Expecting boolean for "are_text_signatures_enabled" of type "SignRequest"',
372	});
373	}
374	const areTextSignaturesEnabled: undefined \| boolean =
375	val.are_text_signatures_enabled == void 0	10!
376	? void 0
377	: val.are_text_signatures_enabled;
378	if (!(val.email_subject == void 0) && !sdIsString(val.email_subject)) {	10!
379	throw new BoxSdkError({	×
380	message: 'Expecting string for "email_subject" of type "SignRequest"',
381	});
382	}
383	const emailSubject: undefined \| string =
384	val.email_subject == void 0 ? void 0 : val.email_subject;	10✔
385	if (!(val.email_message == void 0) && !sdIsString(val.email_message)) {	10!
386	throw new BoxSdkError({	×
387	message: 'Expecting string for "email_message" of type "SignRequest"',
388	});
389	}
390	const emailMessage: undefined \| string =
391	val.email_message == void 0 ? void 0 : val.email_message;	10✔
392	if (	10!
393	!(val.are_reminders_enabled == void 0) &&	20✔
394	!sdIsBoolean(val.are_reminders_enabled)
395	) {
396	throw new BoxSdkError({	×
397	message:
398	'Expecting boolean for "are_reminders_enabled" of type "SignRequest"',
399	});
400	}
401	const areRemindersEnabled: undefined \| boolean =
402	val.are_reminders_enabled == void 0 ? void 0 : val.are_reminders_enabled;	10!
403	if (!(val.name == void 0) && !sdIsString(val.name)) {	10!
404	throw new BoxSdkError({	×
405	message: 'Expecting string for "name" of type "SignRequest"',
406	});
407	}
408	const name: undefined \| string = val.name == void 0 ? void 0 : val.name;	10!
409	if (!(val.prefill_tags == void 0) && !sdIsList(val.prefill_tags)) {	10!
410	throw new BoxSdkError({	×
411	message: 'Expecting array for "prefill_tags" of type "SignRequest"',
412	});
413	}
414	const prefillTags: undefined \| readonly SignRequestPrefillTag[] =
415	val.prefill_tags == void 0	10!
416	? void 0
417	: sdIsList(val.prefill_tags)	10!
418	? (val.prefill_tags.map(function (
419	itm: SerializedData,
420	): SignRequestPrefillTag {
421	return deserializeSignRequestPrefillTag(itm);	8✔
422	}) as readonly any[])
423	: [];
424	if (!(val.days_valid == void 0) && !sdIsNumber(val.days_valid)) {	10!
425	throw new BoxSdkError({	×
426	message: 'Expecting number for "days_valid" of type "SignRequest"',
427	});
428	}
429	const daysValid: undefined \| number =
430	val.days_valid == void 0 ? void 0 : val.days_valid;	10✔
431	if (!(val.external_id == void 0) && !sdIsString(val.external_id)) {	10!
432	throw new BoxSdkError({	×
433	message: 'Expecting string for "external_id" of type "SignRequest"',
434	});
435	}
436	const externalId: undefined \| string =
437	val.external_id == void 0 ? void 0 : val.external_id;	10✔
438	if (!(val.template_id == void 0) && !sdIsString(val.template_id)) {	10!
439	throw new BoxSdkError({	×
440	message: 'Expecting string for "template_id" of type "SignRequest"',
441	});
442	}
443	const templateId: undefined \| string =
444	val.template_id == void 0 ? void 0 : val.template_id;	10!
445	if (	10!
446	!(val.external_system_name == void 0) &&	18✔
447	!sdIsString(val.external_system_name)
448	) {
449	throw new BoxSdkError({	×
450	message:
451	'Expecting string for "external_system_name" of type "SignRequest"',
452	});
453	}
454	const externalSystemName: undefined \| string =
455	val.external_system_name == void 0 ? void 0 : val.external_system_name;	10✔
456	return {	10✔
457	type: type,
458	sourceFiles: sourceFiles,
459	signers: signers,
460	signatureColor: signatureColor,
461	id: id,
462	prepareUrl: prepareUrl,
463	signingLog: signingLog,
464	status: status,
465	signFiles: signFiles,
466	autoExpireAt: autoExpireAt,
467	parentFolder: parentFolder,
468	isDocumentPreparationNeeded: isDocumentPreparationNeeded,
469	redirectUrl: redirectUrl,
470	declinedRedirectUrl: declinedRedirectUrl,
471	areTextSignaturesEnabled: areTextSignaturesEnabled,
472	emailSubject: emailSubject,
473	emailMessage: emailMessage,
474	areRemindersEnabled: areRemindersEnabled,
475	name: name,
476	prefillTags: prefillTags,
477	daysValid: daysValid,
478	externalId: externalId,
479	templateId: templateId,
480	externalSystemName: externalSystemName,
481	} satisfies SignRequest;
482	}

box / box-typescript-sdk-gen / 12885736841

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous