• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

box / box-typescript-sdk-gen / 9837260278

08 Jul 2024 09:42AM UTC coverage: 42.016% (-0.02%) from 42.04%
9837260278

Pull #247

github

web-flow
Merge 4ff81369a into c6944f7c9
Pull Request #247: fix: Update chunked upload (box/box-codegen#523)

3882 of 15893 branches covered (24.43%)

Branch coverage included in aggregate %.

17 of 24 new or added lines in 4 files covered. (70.83%)

7 existing lines in 5 files now uncovered.

12654 of 23463 relevant lines covered (53.93%)

75.94 hits per line

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

57.14
/src/schemas/signRequest.generated.ts
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
  readonly isReadyForDownload?: boolean;
47
}
48
export type SignRequest = SignRequestBase & {
49
  readonly type?: SignRequestTypeField;
50
  readonly sourceFiles?: readonly FileBase[];
51
  readonly signers?: readonly SignRequestSigner[];
52
  readonly signatureColor?: string;
53
  readonly id?: string;
54
  readonly prepareUrl?: string;
55
  readonly signingLog?: FileMini;
56
  readonly status?: SignRequestStatusField;
57
  readonly signFiles?: SignRequestSignFilesField;
58
  readonly autoExpireAt?: DateTime;
59
  readonly parentFolder?: FolderMini;
60
};
61
export function serializeSignRequestTypeField(
138✔
62
  val: SignRequestTypeField
63
): SerializedData {
64
  return val;
×
65
}
66
export function deserializeSignRequestTypeField(
138✔
67
  val: SerializedData
68
): SignRequestTypeField {
69
  if (val == 'sign-request') {
10✔
70
    return val;
10✔
71
  }
72
  throw new BoxSdkError({ message: "Can't deserialize SignRequestTypeField" });
×
73
}
74
export function serializeSignRequestStatusField(
138✔
75
  val: SignRequestStatusField
76
): SerializedData {
77
  return val;
×
78
}
79
export function deserializeSignRequestStatusField(
138✔
80
  val: SerializedData
81
): SignRequestStatusField {
82
  if (val == 'converting') {
10✔
83
    return val;
5✔
84
  }
85
  if (val == 'created') {
5!
UNCOV
86
    return val;
×
87
  }
88
  if (val == 'sent') {
5!
89
    return val;
×
90
  }
91
  if (val == 'viewed') {
5!
92
    return val;
×
93
  }
94
  if (val == 'signed') {
5!
95
    return val;
×
96
  }
97
  if (val == 'cancelled') {
5✔
98
    return val;
4✔
99
  }
100
  if (val == 'declined') {
1!
101
    return val;
×
102
  }
103
  if (val == 'error_converting') {
1✔
104
    return val;
1✔
105
  }
106
  if (val == 'error_sending') {
×
107
    return val;
×
108
  }
109
  if (val == 'expired') {
×
110
    return val;
×
111
  }
112
  if (val == 'finalizing') {
×
113
    return val;
×
114
  }
115
  if (val == 'error_finalizing') {
×
116
    return val;
×
117
  }
118
  throw new BoxSdkError({
×
119
    message: "Can't deserialize SignRequestStatusField",
120
  });
121
}
122
export function serializeSignRequestSignFilesField(
138✔
123
  val: SignRequestSignFilesField
124
): SerializedData {
125
  return {
×
126
    ['files']:
127
      val.files == void 0
×
128
        ? void 0
129
        : (val.files.map(function (item: FileMini): SerializedData {
130
            return serializeFileMini(item);
×
131
          }) as readonly any[]),
132
    ['is_ready_for_download']:
133
      val.isReadyForDownload == void 0 ? void 0 : val.isReadyForDownload,
×
134
  };
135
}
136
export function deserializeSignRequestSignFilesField(
138✔
137
  val: SerializedData
138
): SignRequestSignFilesField {
139
  if (!sdIsMap(val)) {
10!
140
    throw new BoxSdkError({
×
141
      message: 'Expecting a map for "SignRequestSignFilesField"',
142
    });
143
  }
144
  if (!(val.files == void 0) && !sdIsList(val.files)) {
10!
145
    throw new BoxSdkError({
×
146
      message:
147
        'Expecting array for "files" of type "SignRequestSignFilesField"',
148
    });
149
  }
150
  const files: undefined | readonly FileMini[] =
151
    val.files == void 0
10!
152
      ? void 0
153
      : sdIsList(val.files)
10!
154
      ? (val.files.map(function (itm: SerializedData): FileMini {
155
          return deserializeFileMini(itm);
10✔
156
        }) as readonly any[])
157
      : [];
158
  if (
10!
159
    !(val.is_ready_for_download == void 0) &&
20✔
160
    !sdIsBoolean(val.is_ready_for_download)
161
  ) {
162
    throw new BoxSdkError({
×
163
      message:
164
        'Expecting boolean for "is_ready_for_download" of type "SignRequestSignFilesField"',
165
    });
166
  }
167
  const isReadyForDownload: undefined | boolean =
168
    val.is_ready_for_download == void 0 ? void 0 : val.is_ready_for_download;
10!
169
  return {
10✔
170
    files: files,
171
    isReadyForDownload: isReadyForDownload,
172
  } satisfies SignRequestSignFilesField;
173
}
174
export function serializeSignRequest(val: SignRequest): SerializedData {
138✔
175
  const base: any = serializeSignRequestBase(val);
×
176
  if (!sdIsMap(base)) {
×
177
    throw new BoxSdkError({ message: 'Expecting a map for "SignRequest"' });
×
178
  }
179
  return {
×
180
    ...base,
181
    ...{
182
      ['type']:
183
        val.type == void 0 ? void 0 : serializeSignRequestTypeField(val.type),
×
184
      ['source_files']:
185
        val.sourceFiles == void 0
×
186
          ? void 0
187
          : (val.sourceFiles.map(function (item: FileBase): SerializedData {
188
              return serializeFileBase(item);
×
189
            }) as readonly any[]),
190
      ['signers']:
191
        val.signers == void 0
×
192
          ? void 0
193
          : (val.signers.map(function (
194
              item: SignRequestSigner
195
            ): SerializedData {
196
              return serializeSignRequestSigner(item);
×
197
            }) as readonly any[]),
198
      ['signature_color']:
199
        val.signatureColor == void 0 ? void 0 : val.signatureColor,
×
200
      ['id']: val.id == void 0 ? void 0 : val.id,
×
201
      ['prepare_url']: val.prepareUrl == void 0 ? void 0 : val.prepareUrl,
×
202
      ['signing_log']:
203
        val.signingLog == void 0 ? void 0 : serializeFileMini(val.signingLog),
×
204
      ['status']:
205
        val.status == void 0
×
206
          ? void 0
207
          : serializeSignRequestStatusField(val.status),
208
      ['sign_files']:
209
        val.signFiles == void 0
×
210
          ? void 0
211
          : serializeSignRequestSignFilesField(val.signFiles),
212
      ['auto_expire_at']:
213
        val.autoExpireAt == void 0
×
214
          ? void 0
215
          : serializeDateTime(val.autoExpireAt),
216
      ['parent_folder']:
217
        val.parentFolder == void 0
×
218
          ? void 0
219
          : serializeFolderMini(val.parentFolder),
220
    },
221
  };
222
}
223
export function deserializeSignRequest(val: SerializedData): SignRequest {
138✔
224
  if (!sdIsMap(val)) {
10!
225
    throw new BoxSdkError({ message: 'Expecting a map for "SignRequest"' });
×
226
  }
227
  const type: undefined | SignRequestTypeField =
228
    val.type == void 0 ? void 0 : deserializeSignRequestTypeField(val.type);
10!
229
  if (!(val.source_files == void 0) && !sdIsList(val.source_files)) {
10!
230
    throw new BoxSdkError({
×
231
      message: 'Expecting array for "source_files" of type "SignRequest"',
232
    });
233
  }
234
  const sourceFiles: undefined | readonly FileBase[] =
235
    val.source_files == void 0
10!
236
      ? void 0
237
      : sdIsList(val.source_files)
10!
238
      ? (val.source_files.map(function (itm: SerializedData): FileBase {
239
          return deserializeFileBase(itm);
10✔
240
        }) as readonly any[])
241
      : [];
242
  if (!(val.signers == void 0) && !sdIsList(val.signers)) {
10!
243
    throw new BoxSdkError({
×
244
      message: 'Expecting array for "signers" of type "SignRequest"',
245
    });
246
  }
247
  const signers: undefined | readonly SignRequestSigner[] =
248
    val.signers == void 0
10!
249
      ? void 0
250
      : sdIsList(val.signers)
10!
251
      ? (val.signers.map(function (itm: SerializedData): SignRequestSigner {
252
          return deserializeSignRequestSigner(itm);
22✔
253
        }) as readonly any[])
254
      : [];
255
  if (!(val.signature_color == void 0) && !sdIsString(val.signature_color)) {
10!
256
    throw new BoxSdkError({
×
257
      message: 'Expecting string for "signature_color" of type "SignRequest"',
258
    });
259
  }
260
  const signatureColor: undefined | string =
261
    val.signature_color == void 0 ? void 0 : val.signature_color;
10!
262
  if (!(val.id == void 0) && !sdIsString(val.id)) {
10!
263
    throw new BoxSdkError({
×
264
      message: 'Expecting string for "id" of type "SignRequest"',
265
    });
266
  }
267
  const id: undefined | string = val.id == void 0 ? void 0 : val.id;
10!
268
  if (!(val.prepare_url == void 0) && !sdIsString(val.prepare_url)) {
10!
269
    throw new BoxSdkError({
×
270
      message: 'Expecting string for "prepare_url" of type "SignRequest"',
271
    });
272
  }
273
  const prepareUrl: undefined | string =
274
    val.prepare_url == void 0 ? void 0 : val.prepare_url;
10!
275
  const signingLog: undefined | FileMini =
276
    val.signing_log == void 0 ? void 0 : deserializeFileMini(val.signing_log);
10!
277
  const status: undefined | SignRequestStatusField =
278
    val.status == void 0
10!
279
      ? void 0
280
      : deserializeSignRequestStatusField(val.status);
281
  const signFiles: undefined | SignRequestSignFilesField =
282
    val.sign_files == void 0
10!
283
      ? void 0
284
      : deserializeSignRequestSignFilesField(val.sign_files);
285
  if (!(val.auto_expire_at == void 0) && !sdIsString(val.auto_expire_at)) {
10!
286
    throw new BoxSdkError({
×
287
      message: 'Expecting string for "auto_expire_at" of type "SignRequest"',
288
    });
289
  }
290
  const autoExpireAt: undefined | DateTime =
291
    val.auto_expire_at == void 0
10✔
292
      ? void 0
293
      : deserializeDateTime(val.auto_expire_at);
294
  const parentFolder: undefined | FolderMini =
295
    val.parent_folder == void 0
10!
296
      ? void 0
297
      : deserializeFolderMini(val.parent_folder);
298
  if (
10!
299
    !(val.is_document_preparation_needed == void 0) &&
20✔
300
    !sdIsBoolean(val.is_document_preparation_needed)
301
  ) {
302
    throw new BoxSdkError({
×
303
      message:
304
        'Expecting boolean for "is_document_preparation_needed" of type "SignRequest"',
305
    });
306
  }
307
  const isDocumentPreparationNeeded: undefined | boolean =
308
    val.is_document_preparation_needed == void 0
10!
309
      ? void 0
310
      : val.is_document_preparation_needed;
311
  if (!(val.redirect_url == void 0) && !sdIsString(val.redirect_url)) {
10!
312
    throw new BoxSdkError({
×
313
      message: 'Expecting string for "redirect_url" of type "SignRequest"',
314
    });
315
  }
316
  const redirectUrl: undefined | string =
317
    val.redirect_url == void 0 ? void 0 : val.redirect_url;
10✔
318
  if (
10!
319
    !(val.declined_redirect_url == void 0) &&
18✔
320
    !sdIsString(val.declined_redirect_url)
321
  ) {
322
    throw new BoxSdkError({
×
323
      message:
324
        'Expecting string for "declined_redirect_url" of type "SignRequest"',
325
    });
326
  }
327
  const declinedRedirectUrl: undefined | string =
328
    val.declined_redirect_url == void 0 ? void 0 : val.declined_redirect_url;
10✔
329
  if (
10!
330
    !(val.are_text_signatures_enabled == void 0) &&
20✔
331
    !sdIsBoolean(val.are_text_signatures_enabled)
332
  ) {
333
    throw new BoxSdkError({
×
334
      message:
335
        'Expecting boolean for "are_text_signatures_enabled" of type "SignRequest"',
336
    });
337
  }
338
  const areTextSignaturesEnabled: undefined | boolean =
339
    val.are_text_signatures_enabled == void 0
10!
340
      ? void 0
341
      : val.are_text_signatures_enabled;
342
  if (!(val.email_subject == void 0) && !sdIsString(val.email_subject)) {
10!
343
    throw new BoxSdkError({
×
344
      message: 'Expecting string for "email_subject" of type "SignRequest"',
345
    });
346
  }
347
  const emailSubject: undefined | string =
348
    val.email_subject == void 0 ? void 0 : val.email_subject;
10✔
349
  if (!(val.email_message == void 0) && !sdIsString(val.email_message)) {
10!
350
    throw new BoxSdkError({
×
351
      message: 'Expecting string for "email_message" of type "SignRequest"',
352
    });
353
  }
354
  const emailMessage: undefined | string =
355
    val.email_message == void 0 ? void 0 : val.email_message;
10✔
356
  if (
10!
357
    !(val.are_reminders_enabled == void 0) &&
20✔
358
    !sdIsBoolean(val.are_reminders_enabled)
359
  ) {
360
    throw new BoxSdkError({
×
361
      message:
362
        'Expecting boolean for "are_reminders_enabled" of type "SignRequest"',
363
    });
364
  }
365
  const areRemindersEnabled: undefined | boolean =
366
    val.are_reminders_enabled == void 0 ? void 0 : val.are_reminders_enabled;
10!
367
  if (!(val.name == void 0) && !sdIsString(val.name)) {
10!
368
    throw new BoxSdkError({
×
369
      message: 'Expecting string for "name" of type "SignRequest"',
370
    });
371
  }
372
  const name: undefined | string = val.name == void 0 ? void 0 : val.name;
10!
373
  if (!(val.prefill_tags == void 0) && !sdIsList(val.prefill_tags)) {
10!
374
    throw new BoxSdkError({
×
375
      message: 'Expecting array for "prefill_tags" of type "SignRequest"',
376
    });
377
  }
378
  const prefillTags: undefined | readonly SignRequestPrefillTag[] =
379
    val.prefill_tags == void 0
10!
380
      ? void 0
381
      : sdIsList(val.prefill_tags)
10!
382
      ? (val.prefill_tags.map(function (
383
          itm: SerializedData
384
        ): SignRequestPrefillTag {
385
          return deserializeSignRequestPrefillTag(itm);
8✔
386
        }) as readonly any[])
387
      : [];
388
  if (!(val.days_valid == void 0) && !sdIsNumber(val.days_valid)) {
10!
389
    throw new BoxSdkError({
×
390
      message: 'Expecting number for "days_valid" of type "SignRequest"',
391
    });
392
  }
393
  const daysValid: undefined | number =
394
    val.days_valid == void 0 ? void 0 : val.days_valid;
10✔
395
  if (!(val.external_id == void 0) && !sdIsString(val.external_id)) {
10!
396
    throw new BoxSdkError({
×
397
      message: 'Expecting string for "external_id" of type "SignRequest"',
398
    });
399
  }
400
  const externalId: undefined | string =
401
    val.external_id == void 0 ? void 0 : val.external_id;
10✔
402
  if (
10!
403
    !(val.is_phone_verification_required_to_view == void 0) &&
20✔
404
    !sdIsBoolean(val.is_phone_verification_required_to_view)
405
  ) {
406
    throw new BoxSdkError({
×
407
      message:
408
        'Expecting boolean for "is_phone_verification_required_to_view" of type "SignRequest"',
409
    });
410
  }
411
  const isPhoneVerificationRequiredToView: undefined | boolean =
412
    val.is_phone_verification_required_to_view == void 0
10!
413
      ? void 0
414
      : val.is_phone_verification_required_to_view;
415
  if (!(val.template_id == void 0) && !sdIsString(val.template_id)) {
10!
416
    throw new BoxSdkError({
×
417
      message: 'Expecting string for "template_id" of type "SignRequest"',
418
    });
419
  }
420
  const templateId: undefined | string =
421
    val.template_id == void 0 ? void 0 : val.template_id;
10!
422
  if (
10!
423
    !(val.external_system_name == void 0) &&
18✔
424
    !sdIsString(val.external_system_name)
425
  ) {
426
    throw new BoxSdkError({
×
427
      message:
428
        'Expecting string for "external_system_name" of type "SignRequest"',
429
    });
430
  }
431
  const externalSystemName: undefined | string =
432
    val.external_system_name == void 0 ? void 0 : val.external_system_name;
10✔
433
  return {
10✔
434
    type: type,
435
    sourceFiles: sourceFiles,
436
    signers: signers,
437
    signatureColor: signatureColor,
438
    id: id,
439
    prepareUrl: prepareUrl,
440
    signingLog: signingLog,
441
    status: status,
442
    signFiles: signFiles,
443
    autoExpireAt: autoExpireAt,
444
    parentFolder: parentFolder,
445
    isDocumentPreparationNeeded: isDocumentPreparationNeeded,
446
    redirectUrl: redirectUrl,
447
    declinedRedirectUrl: declinedRedirectUrl,
448
    areTextSignaturesEnabled: areTextSignaturesEnabled,
449
    emailSubject: emailSubject,
450
    emailMessage: emailMessage,
451
    areRemindersEnabled: areRemindersEnabled,
452
    name: name,
453
    prefillTags: prefillTags,
454
    daysValid: daysValid,
455
    externalId: externalId,
456
    isPhoneVerificationRequiredToView: isPhoneVerificationRequiredToView,
457
    templateId: templateId,
458
    externalSystemName: externalSystemName,
459
  } satisfies SignRequest;
460
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2025 Coveralls, Inc