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

box / box-typescript-sdk-gen / 12373074501

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

Pull #450

github

web-flow
Merge 2b9f7a5b0 into 03d7f3ef2
Pull Request #450: docs: remove parameter from Sign page (box/box-openapi#489)

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

14.44
/src/schemas/signRequestCreateRequest.generated.ts
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 { serializeSignRequestCreateSigner } from './signRequestCreateSigner.generated.js';
140✔
8
import { deserializeSignRequestCreateSigner } from './signRequestCreateSigner.generated.js';
140✔
9
import { serializeFolderMini } from './folderMini.generated.js';
140✔
10
import { deserializeFolderMini } from './folderMini.generated.js';
140✔
11
import { SignRequestPrefillTag } from './signRequestPrefillTag.generated.js';
12
import { SignRequestBase } from './signRequestBase.generated.js';
13
import { FileBase } from './fileBase.generated.js';
14
import { SignRequestCreateSigner } from './signRequestCreateSigner.generated.js';
15
import { FolderMini } from './folderMini.generated.js';
16
import { BoxSdkError } from '../box/errors.js';
140✔
17
import { SerializedData } from '../serialization/json.js';
18
import { sdIsEmpty } from '../serialization/json.js';
19
import { sdIsBoolean } from '../serialization/json.js';
140✔
20
import { sdIsNumber } from '../serialization/json.js';
140✔
21
import { sdIsString } from '../serialization/json.js';
140✔
22
import { sdIsList } from '../serialization/json.js';
140✔
23
import { sdIsMap } from '../serialization/json.js';
140✔
24
export type SignRequestCreateRequestSignatureColorField =
25
  | 'blue'
26
  | 'black'
27
  | 'red';
28
export type SignRequestCreateRequest = SignRequestBase & {
29
  /**
30
   * 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. */
31
  readonly sourceFiles?: readonly FileBase[] | null;
32
  /**
33
   * Force a specific color for the signature (blue, black, or red) */
34
  readonly signatureColor?: SignRequestCreateRequestSignatureColorField | null;
35
  /**
36
   * Array of signers for the signature request. 35 is the
37
   * max number of signers permitted.
38
   *
39
   * **Note**: It may happen that some signers belong to conflicting [segments](r://shield-information-barrier-segment-member) (user groups).
40
   * This means that due to the security policies, users are assigned to segments to prevent exchanges or communication that could lead to ethical conflicts.
41
   * In such a case, an attempt to send the sign request will result in an error.
42
   *
43
   * Read more about [segments and ethical walls](https://support.box.com/hc/en-us/articles/9920431507603-Understanding-Information-Barriers#h_01GFVJEHQA06N7XEZ4GCZ9GFAQ). */
44
  readonly signers: readonly SignRequestCreateSigner[];
45
  readonly parentFolder?: FolderMini;
46
};
47
export function serializeSignRequestCreateRequestSignatureColorField(
140✔
48
  val: SignRequestCreateRequestSignatureColorField,
49
): SerializedData {
50
  return val;
×
51
}
52
export function deserializeSignRequestCreateRequestSignatureColorField(
140✔
53
  val: SerializedData,
54
): SignRequestCreateRequestSignatureColorField {
55
  if (val == 'blue') {
×
56
    return val;
×
57
  }
58
  if (val == 'black') {
×
59
    return val;
×
60
  }
61
  if (val == 'red') {
×
62
    return val;
×
63
  }
64
  throw new BoxSdkError({
×
65
    message: "Can't deserialize SignRequestCreateRequestSignatureColorField",
66
  });
67
}
68
export function serializeSignRequestCreateRequest(
140✔
69
  val: SignRequestCreateRequest,
70
): SerializedData {
71
  const base: any = serializeSignRequestBase(val);
4✔
72
  if (!sdIsMap(base)) {
4!
73
    throw new BoxSdkError({
×
74
      message: 'Expecting a map for "SignRequestCreateRequest"',
75
    });
76
  }
77
  return {
4✔
78
    ...base,
79
    ...{
80
      ['source_files']:
81
        val.sourceFiles == void 0
4!
82
          ? val.sourceFiles
83
          : (val.sourceFiles.map(function (item: FileBase): SerializedData {
84
              return serializeFileBase(item);
4✔
85
            }) as readonly any[]),
86
      ['signature_color']:
87
        val.signatureColor == void 0
4!
88
          ? val.signatureColor
89
          : serializeSignRequestCreateRequestSignatureColorField(
90
              val.signatureColor,
91
            ),
92
      ['signers']: val.signers.map(function (
93
        item: SignRequestCreateSigner,
94
      ): SerializedData {
95
        return serializeSignRequestCreateSigner(item);
6✔
96
      }) as readonly any[],
97
      ['parent_folder']:
98
        val.parentFolder == void 0
4!
99
          ? val.parentFolder
100
          : serializeFolderMini(val.parentFolder),
101
    },
102
  };
103
}
104
export function deserializeSignRequestCreateRequest(
140✔
105
  val: SerializedData,
106
): SignRequestCreateRequest {
107
  if (!sdIsMap(val)) {
×
108
    throw new BoxSdkError({
×
109
      message: 'Expecting a map for "SignRequestCreateRequest"',
110
    });
111
  }
112
  if (!(val.source_files == void 0) && !sdIsList(val.source_files)) {
×
113
    throw new BoxSdkError({
×
114
      message:
115
        'Expecting array for "source_files" of type "SignRequestCreateRequest"',
116
    });
117
  }
118
  const sourceFiles: undefined | readonly FileBase[] =
119
    val.source_files == void 0
×
120
      ? void 0
121
      : sdIsList(val.source_files)
×
122
        ? (val.source_files.map(function (itm: SerializedData): FileBase {
123
            return deserializeFileBase(itm);
×
124
          }) as readonly any[])
125
        : [];
126
  const signatureColor:
127
    | undefined
128
    | SignRequestCreateRequestSignatureColorField =
129
    val.signature_color == void 0
×
130
      ? void 0
131
      : deserializeSignRequestCreateRequestSignatureColorField(
132
          val.signature_color,
133
        );
134
  if (val.signers == void 0) {
×
135
    throw new BoxSdkError({
×
136
      message:
137
        'Expecting "signers" of type "SignRequestCreateRequest" to be defined',
138
    });
139
  }
140
  if (!sdIsList(val.signers)) {
×
141
    throw new BoxSdkError({
×
142
      message:
143
        'Expecting array for "signers" of type "SignRequestCreateRequest"',
144
    });
145
  }
146
  const signers: readonly SignRequestCreateSigner[] = sdIsList(val.signers)
×
147
    ? (val.signers.map(function (itm: SerializedData): SignRequestCreateSigner {
148
        return deserializeSignRequestCreateSigner(itm);
×
149
      }) as readonly any[])
150
    : [];
151
  const parentFolder: undefined | FolderMini =
152
    val.parent_folder == void 0
×
153
      ? void 0
154
      : deserializeFolderMini(val.parent_folder);
155
  if (
×
156
    !(val.is_document_preparation_needed == void 0) &&
×
157
    !sdIsBoolean(val.is_document_preparation_needed)
158
  ) {
159
    throw new BoxSdkError({
×
160
      message:
161
        'Expecting boolean for "is_document_preparation_needed" of type "SignRequestCreateRequest"',
162
    });
163
  }
164
  const isDocumentPreparationNeeded: undefined | boolean =
165
    val.is_document_preparation_needed == void 0
×
166
      ? void 0
167
      : val.is_document_preparation_needed;
168
  if (!(val.redirect_url == void 0) && !sdIsString(val.redirect_url)) {
×
169
    throw new BoxSdkError({
×
170
      message:
171
        'Expecting string for "redirect_url" of type "SignRequestCreateRequest"',
172
    });
173
  }
174
  const redirectUrl: undefined | string =
175
    val.redirect_url == void 0 ? void 0 : val.redirect_url;
×
176
  if (
×
177
    !(val.declined_redirect_url == void 0) &&
×
178
    !sdIsString(val.declined_redirect_url)
179
  ) {
180
    throw new BoxSdkError({
×
181
      message:
182
        'Expecting string for "declined_redirect_url" of type "SignRequestCreateRequest"',
183
    });
184
  }
185
  const declinedRedirectUrl: undefined | string =
186
    val.declined_redirect_url == void 0 ? void 0 : val.declined_redirect_url;
×
187
  if (
×
188
    !(val.are_text_signatures_enabled == void 0) &&
×
189
    !sdIsBoolean(val.are_text_signatures_enabled)
190
  ) {
191
    throw new BoxSdkError({
×
192
      message:
193
        'Expecting boolean for "are_text_signatures_enabled" of type "SignRequestCreateRequest"',
194
    });
195
  }
196
  const areTextSignaturesEnabled: undefined | boolean =
197
    val.are_text_signatures_enabled == void 0
×
198
      ? void 0
199
      : val.are_text_signatures_enabled;
200
  if (!(val.email_subject == void 0) && !sdIsString(val.email_subject)) {
×
201
    throw new BoxSdkError({
×
202
      message:
203
        'Expecting string for "email_subject" of type "SignRequestCreateRequest"',
204
    });
205
  }
206
  const emailSubject: undefined | string =
207
    val.email_subject == void 0 ? void 0 : val.email_subject;
×
208
  if (!(val.email_message == void 0) && !sdIsString(val.email_message)) {
×
209
    throw new BoxSdkError({
×
210
      message:
211
        'Expecting string for "email_message" of type "SignRequestCreateRequest"',
212
    });
213
  }
214
  const emailMessage: undefined | string =
215
    val.email_message == void 0 ? void 0 : val.email_message;
×
216
  if (
×
217
    !(val.are_reminders_enabled == void 0) &&
×
218
    !sdIsBoolean(val.are_reminders_enabled)
219
  ) {
220
    throw new BoxSdkError({
×
221
      message:
222
        'Expecting boolean for "are_reminders_enabled" of type "SignRequestCreateRequest"',
223
    });
224
  }
225
  const areRemindersEnabled: undefined | boolean =
226
    val.are_reminders_enabled == void 0 ? void 0 : val.are_reminders_enabled;
×
227
  if (!(val.name == void 0) && !sdIsString(val.name)) {
×
228
    throw new BoxSdkError({
×
229
      message: 'Expecting string for "name" of type "SignRequestCreateRequest"',
230
    });
231
  }
232
  const name: undefined | string = val.name == void 0 ? void 0 : val.name;
×
233
  if (!(val.prefill_tags == void 0) && !sdIsList(val.prefill_tags)) {
×
234
    throw new BoxSdkError({
×
235
      message:
236
        'Expecting array for "prefill_tags" of type "SignRequestCreateRequest"',
237
    });
238
  }
239
  const prefillTags: undefined | readonly SignRequestPrefillTag[] =
240
    val.prefill_tags == void 0
×
241
      ? void 0
242
      : sdIsList(val.prefill_tags)
×
243
        ? (val.prefill_tags.map(function (
244
            itm: SerializedData,
245
          ): SignRequestPrefillTag {
246
            return deserializeSignRequestPrefillTag(itm);
×
247
          }) as readonly any[])
248
        : [];
249
  if (!(val.days_valid == void 0) && !sdIsNumber(val.days_valid)) {
×
250
    throw new BoxSdkError({
×
251
      message:
252
        'Expecting number for "days_valid" of type "SignRequestCreateRequest"',
253
    });
254
  }
255
  const daysValid: undefined | number =
256
    val.days_valid == void 0 ? void 0 : val.days_valid;
×
257
  if (!(val.external_id == void 0) && !sdIsString(val.external_id)) {
×
258
    throw new BoxSdkError({
×
259
      message:
260
        'Expecting string for "external_id" of type "SignRequestCreateRequest"',
261
    });
262
  }
263
  const externalId: undefined | string =
264
    val.external_id == void 0 ? void 0 : val.external_id;
×
265
  if (!(val.template_id == void 0) && !sdIsString(val.template_id)) {
×
UNCOV
266
    throw new BoxSdkError({
×
267
      message:
268
        'Expecting string for "template_id" of type "SignRequestCreateRequest"',
269
    });
270
  }
271
  const templateId: undefined | string =
272
    val.template_id == void 0 ? void 0 : val.template_id;
×
273
  if (
×
274
    !(val.external_system_name == void 0) &&
×
275
    !sdIsString(val.external_system_name)
276
  ) {
277
    throw new BoxSdkError({
×
278
      message:
279
        'Expecting string for "external_system_name" of type "SignRequestCreateRequest"',
280
    });
281
  }
282
  const externalSystemName: undefined | string =
283
    val.external_system_name == void 0 ? void 0 : val.external_system_name;
×
284
  return {
×
285
    sourceFiles: sourceFiles,
286
    signatureColor: signatureColor,
287
    signers: signers,
288
    parentFolder: parentFolder,
289
    isDocumentPreparationNeeded: isDocumentPreparationNeeded,
290
    redirectUrl: redirectUrl,
291
    declinedRedirectUrl: declinedRedirectUrl,
292
    areTextSignaturesEnabled: areTextSignaturesEnabled,
293
    emailSubject: emailSubject,
294
    emailMessage: emailMessage,
295
    areRemindersEnabled: areRemindersEnabled,
296
    name: name,
297
    prefillTags: prefillTags,
298
    daysValid: daysValid,
299
    externalId: externalId,
300
    templateId: templateId,
301
    externalSystemName: externalSystemName,
302
  } satisfies SignRequestCreateRequest;
303
}
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