12373074501

Committed 17 Dec 2024 12:32PM UTC coverage: 43.446% (+0.05%) from 43.401%

Build # 12373074501

Build Type

Pull #450

github

Committed by

web-flow

Commit Message

Merge 2b9f7a5b0 into 03d7f3ef2

Pull Request Pull Request #450: docs: remove parameter from Sign page (box/box-openapi#489)

Run Details

3911 of 15217 branches covered (25.7%)

Branch coverage included in aggregate %.

6 of 12 new or added lines in 1 file covered. (50.0%)

8 existing lines in 6 files now uncovered.

13670 of 25249 relevant lines covered (54.14%)

81.18 hits per line

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

57.19

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

box / box-typescript-sdk-gen / 12373074501

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