10632098809

Committed 30 Aug 2024 11:45AM UTC coverage: 41.952% (-0.009%) from 41.961%

Build # 10632098809

Build Type

Pull #329

github

Committed by

web-flow

Commit Message

Merge 02e5292ad into 3751eea67

Pull Request Pull Request #329: Fix: Do not store data in-memory during download process in Python (box/box-codegen#557)

Run Details

4000 of 16427 branches covered (24.35%)

Branch coverage included in aggregate %.

13047 of 24208 relevant lines covered (53.9%)

74.73 hits per line

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

55.87

/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 { DateTime } from '../internal/utils.js';
import { BoxSdkError } from '../box/errors.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;
}
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;
  /**
   * 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;
  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;
  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
        ? void 0
        : (val.files.map(function (item: FileMini): SerializedData {
            return serializeFileMini(item);
          }) as readonly any[]),
    ['is_ready_for_download']:
      val.isReadyForDownload == void 0 ? void 0 : 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 ? void 0 : serializeSignRequestTypeField(val.type),
      ['source_files']:
        val.sourceFiles == void 0
          ? void 0
          : (val.sourceFiles.map(function (item: FileBase): SerializedData {
              return serializeFileBase(item);
            }) as readonly any[]),
      ['signers']:
        val.signers == void 0
          ? void 0
          : (val.signers.map(function (
              item: SignRequestSigner
            ): SerializedData {
              return serializeSignRequestSigner(item);
            }) as readonly any[]),
      ['signature_color']:
        val.signatureColor == void 0 ? void 0 : val.signatureColor,
      ['id']: val.id == void 0 ? void 0 : val.id,
      ['prepare_url']: val.prepareUrl == void 0 ? void 0 : val.prepareUrl,
      ['signing_log']:
        val.signingLog == void 0 ? void 0 : serializeFileMini(val.signingLog),
      ['status']:
        val.status == void 0
          ? void 0
          : serializeSignRequestStatusField(val.status),
      ['sign_files']:
        val.signFiles == void 0
          ? void 0
          : serializeSignRequestSignFilesField(val.signFiles),
      ['auto_expire_at']:
        val.autoExpireAt == void 0
          ? void 0
          : serializeDateTime(val.autoExpireAt),
      ['parent_folder']:
        val.parentFolder == void 0
          ? void 0
          : 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.is_phone_verification_required_to_view == void 0) &&
    !sdIsBoolean(val.is_phone_verification_required_to_view)
  ) {
    throw new BoxSdkError({
      message:
        'Expecting boolean for "is_phone_verification_required_to_view" of type "SignRequest"',
    });
  }
  const isPhoneVerificationRequiredToView: undefined | boolean =
    val.is_phone_verification_required_to_view == void 0
      ? void 0
      : val.is_phone_verification_required_to_view;
  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,
    isPhoneVerificationRequiredToView: isPhoneVerificationRequiredToView,
    templateId: templateId,
    externalSystemName: externalSystemName,
  } satisfies SignRequest;
}

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

box / box-typescript-sdk-gen / 10632098809

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