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

box / box-typescript-sdk-gen / 12870156465

20 Jan 2025 02:28PM UTC coverage: 42.419%. First build
12870156465

push

github

web-flow
feat: Use extensible enums (box/box-codegen#639) (#487)

3990 of 15999 branches covered (24.94%)

Branch coverage included in aggregate %.

0 of 408 new or added lines in 104 files covered. (0.0%)

14249 of 26998 relevant lines covered (52.78%)

93.02 hits per line

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

49.24
/src/managers/taskAssignments.generated.ts
1
import { serializeTaskAssignments } from '../schemas/taskAssignments.generated.js';
2
import { deserializeTaskAssignments } from '../schemas/taskAssignments.generated.js';
144✔
3
import { serializeClientError } from '../schemas/clientError.generated.js';
4
import { deserializeClientError } from '../schemas/clientError.generated.js';
5
import { serializeTaskAssignment } from '../schemas/taskAssignment.generated.js';
6
import { deserializeTaskAssignment } from '../schemas/taskAssignment.generated.js';
144✔
7
import { ResponseFormat } from '../networking/fetchOptions.generated.js';
8
import { TaskAssignments } from '../schemas/taskAssignments.generated.js';
9
import { ClientError } from '../schemas/clientError.generated.js';
10
import { TaskAssignment } from '../schemas/taskAssignment.generated.js';
11
import { BoxSdkError } from '../box/errors.js';
144✔
12
import { Authentication } from '../networking/auth.generated.js';
13
import { NetworkSession } from '../networking/network.generated.js';
144✔
14
import { FetchOptions } from '../networking/fetchOptions.generated.js';
144✔
15
import { FetchResponse } from '../networking/fetchResponse.generated.js';
16
import { prepareParams } from '../internal/utils.js';
144✔
17
import { toString } from '../internal/utils.js';
144✔
18
import { ByteStream } from '../internal/utils.js';
19
import { CancellationToken } from '../internal/utils.js';
20
import { sdToJson } from '../serialization/json.js';
21
import { SerializedData } from '../serialization/json.js';
22
import { sdIsEmpty } from '../serialization/json.js';
23
import { sdIsBoolean } from '../serialization/json.js';
24
import { sdIsNumber } from '../serialization/json.js';
25
import { sdIsString } from '../serialization/json.js';
144✔
26
import { sdIsList } from '../serialization/json.js';
27
import { sdIsMap } from '../serialization/json.js';
144✔
28
export class GetTaskAssignmentsOptionals {
144✔
29
  readonly headers: GetTaskAssignmentsHeaders = new GetTaskAssignmentsHeaders(
2✔
30
    {},
31
  );
32
  readonly cancellationToken?: CancellationToken = void 0;
2✔
33
  constructor(
34
    fields: Omit<GetTaskAssignmentsOptionals, 'headers' | 'cancellationToken'> &
35
      Partial<
36
        Pick<GetTaskAssignmentsOptionals, 'headers' | 'cancellationToken'>
37
      >,
38
  ) {
39
    if (fields.headers !== undefined) {
2!
40
      this.headers = fields.headers;
×
41
    }
42
    if (fields.cancellationToken !== undefined) {
2!
43
      this.cancellationToken = fields.cancellationToken;
×
44
    }
45
  }
46
}
47
export interface GetTaskAssignmentsOptionalsInput {
48
  readonly headers?: GetTaskAssignmentsHeaders;
49
  readonly cancellationToken?: undefined | CancellationToken;
50
}
51
export class CreateTaskAssignmentOptionals {
144✔
52
  readonly headers: CreateTaskAssignmentHeaders =
2✔
53
    new CreateTaskAssignmentHeaders({});
54
  readonly cancellationToken?: CancellationToken = void 0;
2✔
55
  constructor(
56
    fields: Omit<
57
      CreateTaskAssignmentOptionals,
58
      'headers' | 'cancellationToken'
59
    > &
60
      Partial<
61
        Pick<CreateTaskAssignmentOptionals, 'headers' | 'cancellationToken'>
62
      >,
63
  ) {
64
    if (fields.headers !== undefined) {
2!
65
      this.headers = fields.headers;
×
66
    }
67
    if (fields.cancellationToken !== undefined) {
2!
68
      this.cancellationToken = fields.cancellationToken;
×
69
    }
70
  }
71
}
72
export interface CreateTaskAssignmentOptionalsInput {
73
  readonly headers?: CreateTaskAssignmentHeaders;
74
  readonly cancellationToken?: undefined | CancellationToken;
75
}
76
export class GetTaskAssignmentByIdOptionals {
144✔
77
  readonly headers: GetTaskAssignmentByIdHeaders =
2✔
78
    new GetTaskAssignmentByIdHeaders({});
79
  readonly cancellationToken?: CancellationToken = void 0;
2✔
80
  constructor(
81
    fields: Omit<
82
      GetTaskAssignmentByIdOptionals,
83
      'headers' | 'cancellationToken'
84
    > &
85
      Partial<
86
        Pick<GetTaskAssignmentByIdOptionals, 'headers' | 'cancellationToken'>
87
      >,
88
  ) {
89
    if (fields.headers !== undefined) {
2!
90
      this.headers = fields.headers;
×
91
    }
92
    if (fields.cancellationToken !== undefined) {
2!
93
      this.cancellationToken = fields.cancellationToken;
×
94
    }
95
  }
96
}
97
export interface GetTaskAssignmentByIdOptionalsInput {
98
  readonly headers?: GetTaskAssignmentByIdHeaders;
99
  readonly cancellationToken?: undefined | CancellationToken;
100
}
101
export class UpdateTaskAssignmentByIdOptionals {
144✔
102
  readonly requestBody: UpdateTaskAssignmentByIdRequestBody =
2✔
103
    {} satisfies UpdateTaskAssignmentByIdRequestBody;
104
  readonly headers: UpdateTaskAssignmentByIdHeaders =
2✔
105
    new UpdateTaskAssignmentByIdHeaders({});
106
  readonly cancellationToken?: CancellationToken = void 0;
2✔
107
  constructor(
108
    fields: Omit<
109
      UpdateTaskAssignmentByIdOptionals,
110
      'requestBody' | 'headers' | 'cancellationToken'
111
    > &
112
      Partial<
113
        Pick<
114
          UpdateTaskAssignmentByIdOptionals,
115
          'requestBody' | 'headers' | 'cancellationToken'
116
        >
117
      >,
118
  ) {
119
    if (fields.requestBody !== undefined) {
2✔
120
      this.requestBody = fields.requestBody;
2✔
121
    }
122
    if (fields.headers !== undefined) {
2!
123
      this.headers = fields.headers;
×
124
    }
125
    if (fields.cancellationToken !== undefined) {
2!
126
      this.cancellationToken = fields.cancellationToken;
×
127
    }
128
  }
129
}
130
export interface UpdateTaskAssignmentByIdOptionalsInput {
131
  readonly requestBody?: UpdateTaskAssignmentByIdRequestBody;
132
  readonly headers?: UpdateTaskAssignmentByIdHeaders;
133
  readonly cancellationToken?: undefined | CancellationToken;
134
}
135
export class DeleteTaskAssignmentByIdOptionals {
144✔
136
  readonly headers: DeleteTaskAssignmentByIdHeaders =
2✔
137
    new DeleteTaskAssignmentByIdHeaders({});
138
  readonly cancellationToken?: CancellationToken = void 0;
2✔
139
  constructor(
140
    fields: Omit<
141
      DeleteTaskAssignmentByIdOptionals,
142
      'headers' | 'cancellationToken'
143
    > &
144
      Partial<
145
        Pick<DeleteTaskAssignmentByIdOptionals, 'headers' | 'cancellationToken'>
146
      >,
147
  ) {
148
    if (fields.headers !== undefined) {
2!
149
      this.headers = fields.headers;
×
150
    }
151
    if (fields.cancellationToken !== undefined) {
2!
152
      this.cancellationToken = fields.cancellationToken;
×
153
    }
154
  }
155
}
156
export interface DeleteTaskAssignmentByIdOptionalsInput {
157
  readonly headers?: DeleteTaskAssignmentByIdHeaders;
158
  readonly cancellationToken?: undefined | CancellationToken;
159
}
160
export class GetTaskAssignmentsHeaders {
144✔
161
  /**
162
   * Extra headers that will be included in the HTTP request. */
163
  readonly extraHeaders?: {
2✔
164
    readonly [key: string]: undefined | string;
165
  } = {};
166
  constructor(
167
    fields: Omit<GetTaskAssignmentsHeaders, 'extraHeaders'> &
168
      Partial<Pick<GetTaskAssignmentsHeaders, 'extraHeaders'>>,
169
  ) {
170
    if (fields.extraHeaders !== undefined) {
2!
171
      this.extraHeaders = fields.extraHeaders;
×
172
    }
173
  }
174
}
175
export interface GetTaskAssignmentsHeadersInput {
176
  /**
177
   * Extra headers that will be included in the HTTP request. */
178
  readonly extraHeaders?:
179
    | undefined
180
    | {
181
        readonly [key: string]: undefined | string;
182
      };
183
}
184
export type CreateTaskAssignmentRequestBodyTaskTypeField = 'task';
185
export class CreateTaskAssignmentRequestBodyTaskField {
144✔
186
  /**
187
   * The ID of the task */
188
  readonly id!: string;
189
  /**
190
   * The type of the item to assign. */
191
  readonly type: CreateTaskAssignmentRequestBodyTaskTypeField =
2✔
192
    'task' as CreateTaskAssignmentRequestBodyTaskTypeField;
193
  readonly rawData?: SerializedData;
194
  constructor(
195
    fields: Omit<CreateTaskAssignmentRequestBodyTaskField, 'type'> &
196
      Partial<Pick<CreateTaskAssignmentRequestBodyTaskField, 'type'>>,
197
  ) {
198
    if (fields.id !== undefined) {
2✔
199
      this.id = fields.id;
2✔
200
    }
201
    if (fields.type !== undefined) {
2✔
202
      this.type = fields.type;
2✔
203
    }
204
    if (fields.rawData !== undefined) {
2!
205
      this.rawData = fields.rawData;
×
206
    }
207
  }
208
}
209
export interface CreateTaskAssignmentRequestBodyTaskFieldInput {
210
  /**
211
   * The ID of the task */
212
  readonly id: string;
213
  /**
214
   * The type of the item to assign. */
215
  readonly type?: CreateTaskAssignmentRequestBodyTaskTypeField;
216
  readonly rawData?: SerializedData;
217
}
218
export interface CreateTaskAssignmentRequestBodyAssignToField {
219
  /**
220
   * The ID of the user to assign to the
221
   * task.
222
   *
223
   * To specify a user by their email
224
   * address use the `login` parameter. */
225
  readonly id?: string;
226
  /**
227
   * The email address of the user to assign to the task.
228
   * To specify a user by their user ID please use the `id` parameter. */
229
  readonly login?: string;
230
  readonly rawData?: SerializedData;
231
}
232
export interface CreateTaskAssignmentRequestBody {
233
  /**
234
   * The task to assign to a user. */
235
  readonly task: CreateTaskAssignmentRequestBodyTaskField;
236
  /**
237
   * The user to assign the task to. */
238
  readonly assignTo: CreateTaskAssignmentRequestBodyAssignToField;
239
  readonly rawData?: SerializedData;
240
}
241
export class CreateTaskAssignmentHeaders {
144✔
242
  /**
243
   * Extra headers that will be included in the HTTP request. */
244
  readonly extraHeaders?: {
2✔
245
    readonly [key: string]: undefined | string;
246
  } = {};
247
  constructor(
248
    fields: Omit<CreateTaskAssignmentHeaders, 'extraHeaders'> &
249
      Partial<Pick<CreateTaskAssignmentHeaders, 'extraHeaders'>>,
250
  ) {
251
    if (fields.extraHeaders !== undefined) {
2!
252
      this.extraHeaders = fields.extraHeaders;
×
253
    }
254
  }
255
}
256
export interface CreateTaskAssignmentHeadersInput {
257
  /**
258
   * Extra headers that will be included in the HTTP request. */
259
  readonly extraHeaders?:
260
    | undefined
261
    | {
262
        readonly [key: string]: undefined | string;
263
      };
264
}
265
export class GetTaskAssignmentByIdHeaders {
144✔
266
  /**
267
   * Extra headers that will be included in the HTTP request. */
268
  readonly extraHeaders?: {
2✔
269
    readonly [key: string]: undefined | string;
270
  } = {};
271
  constructor(
272
    fields: Omit<GetTaskAssignmentByIdHeaders, 'extraHeaders'> &
273
      Partial<Pick<GetTaskAssignmentByIdHeaders, 'extraHeaders'>>,
274
  ) {
275
    if (fields.extraHeaders !== undefined) {
2!
276
      this.extraHeaders = fields.extraHeaders;
×
277
    }
278
  }
279
}
280
export interface GetTaskAssignmentByIdHeadersInput {
281
  /**
282
   * Extra headers that will be included in the HTTP request. */
283
  readonly extraHeaders?:
284
    | undefined
285
    | {
286
        readonly [key: string]: undefined | string;
287
      };
288
}
289
export type UpdateTaskAssignmentByIdRequestBodyResolutionStateField =
290
  | 'completed'
291
  | 'incomplete'
292
  | 'approved'
293
  | 'rejected'
294
  | string;
295
export interface UpdateTaskAssignmentByIdRequestBody {
296
  /**
297
   * An optional message by the assignee that can be added to the task. */
298
  readonly message?: string;
299
  /**
300
   * The state of the task assigned to the user.
301
   *
302
   * * For a task with an `action` value of `complete` this can be
303
   * `incomplete` or `completed`.
304
   * * For a task with an `action` of `review` this can be
305
   * `incomplete`, `approved`, or `rejected`. */
306
  readonly resolutionState?: UpdateTaskAssignmentByIdRequestBodyResolutionStateField;
307
  readonly rawData?: SerializedData;
308
}
309
export class UpdateTaskAssignmentByIdHeaders {
144✔
310
  /**
311
   * Extra headers that will be included in the HTTP request. */
312
  readonly extraHeaders?: {
2✔
313
    readonly [key: string]: undefined | string;
314
  } = {};
315
  constructor(
316
    fields: Omit<UpdateTaskAssignmentByIdHeaders, 'extraHeaders'> &
317
      Partial<Pick<UpdateTaskAssignmentByIdHeaders, 'extraHeaders'>>,
318
  ) {
319
    if (fields.extraHeaders !== undefined) {
2!
320
      this.extraHeaders = fields.extraHeaders;
×
321
    }
322
  }
323
}
324
export interface UpdateTaskAssignmentByIdHeadersInput {
325
  /**
326
   * Extra headers that will be included in the HTTP request. */
327
  readonly extraHeaders?:
328
    | undefined
329
    | {
330
        readonly [key: string]: undefined | string;
331
      };
332
}
333
export class DeleteTaskAssignmentByIdHeaders {
144✔
334
  /**
335
   * Extra headers that will be included in the HTTP request. */
336
  readonly extraHeaders?: {
2✔
337
    readonly [key: string]: undefined | string;
338
  } = {};
339
  constructor(
340
    fields: Omit<DeleteTaskAssignmentByIdHeaders, 'extraHeaders'> &
341
      Partial<Pick<DeleteTaskAssignmentByIdHeaders, 'extraHeaders'>>,
342
  ) {
343
    if (fields.extraHeaders !== undefined) {
2!
344
      this.extraHeaders = fields.extraHeaders;
×
345
    }
346
  }
347
}
348
export interface DeleteTaskAssignmentByIdHeadersInput {
349
  /**
350
   * Extra headers that will be included in the HTTP request. */
351
  readonly extraHeaders?:
352
    | undefined
353
    | {
354
        readonly [key: string]: undefined | string;
355
      };
356
}
357
export class TaskAssignmentsManager {
144✔
358
  readonly auth?: Authentication;
359
  readonly networkSession: NetworkSession = new NetworkSession({});
312✔
360
  constructor(
361
    fields: Omit<
362
      TaskAssignmentsManager,
363
      | 'networkSession'
364
      | 'getTaskAssignments'
365
      | 'createTaskAssignment'
366
      | 'getTaskAssignmentById'
367
      | 'updateTaskAssignmentById'
368
      | 'deleteTaskAssignmentById'
369
    > &
370
      Partial<Pick<TaskAssignmentsManager, 'networkSession'>>,
371
  ) {
372
    if (fields.auth !== undefined) {
312✔
373
      this.auth = fields.auth;
312✔
374
    }
375
    if (fields.networkSession !== undefined) {
312✔
376
      this.networkSession = fields.networkSession;
312✔
377
    }
378
  }
379
  /**
380
     * Lists all of the assignments for a given task.
381
     * @param {string} taskId The ID of the task.
382
    Example: "12345"
383
     * @param {GetTaskAssignmentsOptionalsInput} optionalsInput
384
     * @returns {Promise<TaskAssignments>}
385
     */
386
  async getTaskAssignments(
387
    taskId: string,
2✔
388
    optionalsInput: GetTaskAssignmentsOptionalsInput = {},
2✔
389
  ): Promise<TaskAssignments> {
390
    const optionals: GetTaskAssignmentsOptionals =
391
      new GetTaskAssignmentsOptionals({
2✔
392
        headers: optionalsInput.headers,
393
        cancellationToken: optionalsInput.cancellationToken,
394
      });
395
    const headers: any = optionals.headers;
2✔
396
    const cancellationToken: any = optionals.cancellationToken;
2✔
397
    const headersMap: {
398
      readonly [key: string]: string;
399
    } = prepareParams({ ...{}, ...headers.extraHeaders });
2✔
400
    const response: FetchResponse =
401
      await this.networkSession.networkClient.fetch(
2✔
402
        new FetchOptions({
403
          url: ''.concat(
404
            this.networkSession.baseUrls.baseUrl,
405
            '/2.0/tasks/',
406
            toString(taskId) as string,
407
            '/assignments',
408
          ) as string,
409
          method: 'GET',
410
          headers: headersMap,
411
          responseFormat: 'json' as ResponseFormat,
412
          auth: this.auth,
413
          networkSession: this.networkSession,
414
          cancellationToken: cancellationToken,
415
        }),
416
      );
417
    return {
2✔
418
      ...deserializeTaskAssignments(response.data!),
419
      rawData: response.data!,
420
    };
421
  }
422
  /**
423
   * Assigns a task to a user.
424
   *
425
   * A task can be assigned to more than one user by creating multiple
426
   * assignments.
427
   * @param {CreateTaskAssignmentRequestBody} requestBody Request body of createTaskAssignment method
428
   * @param {CreateTaskAssignmentOptionalsInput} optionalsInput
429
   * @returns {Promise<TaskAssignment>}
430
   */
431
  async createTaskAssignment(
432
    requestBody: CreateTaskAssignmentRequestBody,
2✔
433
    optionalsInput: CreateTaskAssignmentOptionalsInput = {},
2✔
434
  ): Promise<TaskAssignment> {
435
    const optionals: CreateTaskAssignmentOptionals =
436
      new CreateTaskAssignmentOptionals({
2✔
437
        headers: optionalsInput.headers,
438
        cancellationToken: optionalsInput.cancellationToken,
439
      });
440
    const headers: any = optionals.headers;
2✔
441
    const cancellationToken: any = optionals.cancellationToken;
2✔
442
    const headersMap: {
443
      readonly [key: string]: string;
444
    } = prepareParams({ ...{}, ...headers.extraHeaders });
2✔
445
    const response: FetchResponse =
446
      await this.networkSession.networkClient.fetch(
2✔
447
        new FetchOptions({
448
          url: ''.concat(
449
            this.networkSession.baseUrls.baseUrl,
450
            '/2.0/task_assignments',
451
          ) as string,
452
          method: 'POST',
453
          headers: headersMap,
454
          data: serializeCreateTaskAssignmentRequestBody(requestBody),
455
          contentType: 'application/json',
456
          responseFormat: 'json' as ResponseFormat,
457
          auth: this.auth,
458
          networkSession: this.networkSession,
459
          cancellationToken: cancellationToken,
460
        }),
461
      );
462
    return {
2✔
463
      ...deserializeTaskAssignment(response.data!),
464
      rawData: response.data!,
465
    };
466
  }
467
  /**
468
     * Retrieves information about a task assignment.
469
     * @param {string} taskAssignmentId The ID of the task assignment.
470
    Example: "12345"
471
     * @param {GetTaskAssignmentByIdOptionalsInput} optionalsInput
472
     * @returns {Promise<TaskAssignment>}
473
     */
474
  async getTaskAssignmentById(
475
    taskAssignmentId: string,
2✔
476
    optionalsInput: GetTaskAssignmentByIdOptionalsInput = {},
2✔
477
  ): Promise<TaskAssignment> {
478
    const optionals: GetTaskAssignmentByIdOptionals =
479
      new GetTaskAssignmentByIdOptionals({
2✔
480
        headers: optionalsInput.headers,
481
        cancellationToken: optionalsInput.cancellationToken,
482
      });
483
    const headers: any = optionals.headers;
2✔
484
    const cancellationToken: any = optionals.cancellationToken;
2✔
485
    const headersMap: {
486
      readonly [key: string]: string;
487
    } = prepareParams({ ...{}, ...headers.extraHeaders });
2✔
488
    const response: FetchResponse =
489
      await this.networkSession.networkClient.fetch(
2✔
490
        new FetchOptions({
491
          url: ''.concat(
492
            this.networkSession.baseUrls.baseUrl,
493
            '/2.0/task_assignments/',
494
            toString(taskAssignmentId) as string,
495
          ) as string,
496
          method: 'GET',
497
          headers: headersMap,
498
          responseFormat: 'json' as ResponseFormat,
499
          auth: this.auth,
500
          networkSession: this.networkSession,
501
          cancellationToken: cancellationToken,
502
        }),
503
      );
504
    return {
2✔
505
      ...deserializeTaskAssignment(response.data!),
506
      rawData: response.data!,
507
    };
508
  }
509
  /**
510
     * Updates a task assignment. This endpoint can be
511
     * used to update the state of a task assigned to a user.
512
     * @param {string} taskAssignmentId The ID of the task assignment.
513
    Example: "12345"
514
     * @param {UpdateTaskAssignmentByIdOptionalsInput} optionalsInput
515
     * @returns {Promise<TaskAssignment>}
516
     */
517
  async updateTaskAssignmentById(
518
    taskAssignmentId: string,
2✔
519
    optionalsInput: UpdateTaskAssignmentByIdOptionalsInput = {},
×
520
  ): Promise<TaskAssignment> {
521
    const optionals: UpdateTaskAssignmentByIdOptionals =
522
      new UpdateTaskAssignmentByIdOptionals({
2✔
523
        requestBody: optionalsInput.requestBody,
524
        headers: optionalsInput.headers,
525
        cancellationToken: optionalsInput.cancellationToken,
526
      });
527
    const requestBody: any = optionals.requestBody;
2✔
528
    const headers: any = optionals.headers;
2✔
529
    const cancellationToken: any = optionals.cancellationToken;
2✔
530
    const headersMap: {
531
      readonly [key: string]: string;
532
    } = prepareParams({ ...{}, ...headers.extraHeaders });
2✔
533
    const response: FetchResponse =
534
      await this.networkSession.networkClient.fetch(
2✔
535
        new FetchOptions({
536
          url: ''.concat(
537
            this.networkSession.baseUrls.baseUrl,
538
            '/2.0/task_assignments/',
539
            toString(taskAssignmentId) as string,
540
          ) as string,
541
          method: 'PUT',
542
          headers: headersMap,
543
          data: serializeUpdateTaskAssignmentByIdRequestBody(requestBody),
544
          contentType: 'application/json',
545
          responseFormat: 'json' as ResponseFormat,
546
          auth: this.auth,
547
          networkSession: this.networkSession,
548
          cancellationToken: cancellationToken,
549
        }),
550
      );
551
    return {
2✔
552
      ...deserializeTaskAssignment(response.data!),
553
      rawData: response.data!,
554
    };
555
  }
556
  /**
557
     * Deletes a specific task assignment.
558
     * @param {string} taskAssignmentId The ID of the task assignment.
559
    Example: "12345"
560
     * @param {DeleteTaskAssignmentByIdOptionalsInput} optionalsInput
561
     * @returns {Promise<undefined>}
562
     */
563
  async deleteTaskAssignmentById(
564
    taskAssignmentId: string,
2✔
565
    optionalsInput: DeleteTaskAssignmentByIdOptionalsInput = {},
2✔
566
  ): Promise<undefined> {
567
    const optionals: DeleteTaskAssignmentByIdOptionals =
568
      new DeleteTaskAssignmentByIdOptionals({
2✔
569
        headers: optionalsInput.headers,
570
        cancellationToken: optionalsInput.cancellationToken,
571
      });
572
    const headers: any = optionals.headers;
2✔
573
    const cancellationToken: any = optionals.cancellationToken;
2✔
574
    const headersMap: {
575
      readonly [key: string]: string;
576
    } = prepareParams({ ...{}, ...headers.extraHeaders });
2✔
577
    const response: FetchResponse =
578
      await this.networkSession.networkClient.fetch(
2✔
579
        new FetchOptions({
580
          url: ''.concat(
581
            this.networkSession.baseUrls.baseUrl,
582
            '/2.0/task_assignments/',
583
            toString(taskAssignmentId) as string,
584
          ) as string,
585
          method: 'DELETE',
586
          headers: headersMap,
587
          responseFormat: 'no_content' as ResponseFormat,
588
          auth: this.auth,
589
          networkSession: this.networkSession,
590
          cancellationToken: cancellationToken,
591
        }),
592
      );
593
    return void 0;
×
594
  }
595
}
596
export interface TaskAssignmentsManagerInput {
597
  readonly auth?: Authentication;
598
  readonly networkSession?: NetworkSession;
599
}
600
export function serializeCreateTaskAssignmentRequestBodyTaskTypeField(
144✔
601
  val: CreateTaskAssignmentRequestBodyTaskTypeField,
602
): SerializedData {
603
  return val;
2✔
604
}
605
export function deserializeCreateTaskAssignmentRequestBodyTaskTypeField(
144✔
606
  val: SerializedData,
607
): CreateTaskAssignmentRequestBodyTaskTypeField {
608
  if (val == 'task') {
×
609
    return val;
×
610
  }
611
  throw new BoxSdkError({
×
612
    message: "Can't deserialize CreateTaskAssignmentRequestBodyTaskTypeField",
613
  });
614
}
615
export function serializeCreateTaskAssignmentRequestBodyTaskField(
144✔
616
  val: CreateTaskAssignmentRequestBodyTaskField,
617
): SerializedData {
618
  return {
2✔
619
    ['id']: val.id,
620
    ['type']: serializeCreateTaskAssignmentRequestBodyTaskTypeField(val.type),
621
  };
622
}
623
export function deserializeCreateTaskAssignmentRequestBodyTaskField(
144✔
624
  val: SerializedData,
625
): CreateTaskAssignmentRequestBodyTaskField {
626
  if (!sdIsMap(val)) {
×
627
    throw new BoxSdkError({
×
628
      message: 'Expecting a map for "CreateTaskAssignmentRequestBodyTaskField"',
629
    });
630
  }
631
  if (val.id == void 0) {
×
632
    throw new BoxSdkError({
×
633
      message:
634
        'Expecting "id" of type "CreateTaskAssignmentRequestBodyTaskField" to be defined',
635
    });
636
  }
637
  if (!sdIsString(val.id)) {
×
638
    throw new BoxSdkError({
×
639
      message:
640
        'Expecting string for "id" of type "CreateTaskAssignmentRequestBodyTaskField"',
641
    });
642
  }
643
  const id: string = val.id;
×
644
  if (val.type == void 0) {
×
645
    throw new BoxSdkError({
×
646
      message:
647
        'Expecting "type" of type "CreateTaskAssignmentRequestBodyTaskField" to be defined',
648
    });
649
  }
650
  const type: CreateTaskAssignmentRequestBodyTaskTypeField =
651
    deserializeCreateTaskAssignmentRequestBodyTaskTypeField(val.type);
×
652
  return {
×
653
    id: id,
654
    type: type,
655
  } satisfies CreateTaskAssignmentRequestBodyTaskField;
656
}
657
export function serializeCreateTaskAssignmentRequestBodyTaskFieldInput(
144✔
658
  val: CreateTaskAssignmentRequestBodyTaskFieldInput,
659
): SerializedData {
660
  return {
×
661
    ['id']: val.id,
662
    ['type']:
663
      val.type == void 0
×
664
        ? val.type
665
        : serializeCreateTaskAssignmentRequestBodyTaskTypeField(val.type),
666
  };
667
}
668
export function deserializeCreateTaskAssignmentRequestBodyTaskFieldInput(
144✔
669
  val: SerializedData,
670
): CreateTaskAssignmentRequestBodyTaskFieldInput {
671
  if (!sdIsMap(val)) {
×
672
    throw new BoxSdkError({
×
673
      message:
674
        'Expecting a map for "CreateTaskAssignmentRequestBodyTaskFieldInput"',
675
    });
676
  }
677
  if (val.id == void 0) {
×
678
    throw new BoxSdkError({
×
679
      message:
680
        'Expecting "id" of type "CreateTaskAssignmentRequestBodyTaskFieldInput" to be defined',
681
    });
682
  }
683
  if (!sdIsString(val.id)) {
×
684
    throw new BoxSdkError({
×
685
      message:
686
        'Expecting string for "id" of type "CreateTaskAssignmentRequestBodyTaskFieldInput"',
687
    });
688
  }
689
  const id: string = val.id;
×
690
  const type: undefined | CreateTaskAssignmentRequestBodyTaskTypeField =
691
    val.type == void 0
×
692
      ? void 0
693
      : deserializeCreateTaskAssignmentRequestBodyTaskTypeField(val.type);
694
  return {
×
695
    id: id,
696
    type: type,
697
  } satisfies CreateTaskAssignmentRequestBodyTaskFieldInput;
698
}
699
export function serializeCreateTaskAssignmentRequestBodyAssignToField(
144✔
700
  val: CreateTaskAssignmentRequestBodyAssignToField,
701
): SerializedData {
702
  return { ['id']: val.id, ['login']: val.login };
2✔
703
}
704
export function deserializeCreateTaskAssignmentRequestBodyAssignToField(
144✔
705
  val: SerializedData,
706
): CreateTaskAssignmentRequestBodyAssignToField {
707
  if (!sdIsMap(val)) {
×
708
    throw new BoxSdkError({
×
709
      message:
710
        'Expecting a map for "CreateTaskAssignmentRequestBodyAssignToField"',
711
    });
712
  }
713
  if (!(val.id == void 0) && !sdIsString(val.id)) {
×
714
    throw new BoxSdkError({
×
715
      message:
716
        'Expecting string for "id" of type "CreateTaskAssignmentRequestBodyAssignToField"',
717
    });
718
  }
719
  const id: undefined | string = val.id == void 0 ? void 0 : val.id;
×
720
  if (!(val.login == void 0) && !sdIsString(val.login)) {
×
721
    throw new BoxSdkError({
×
722
      message:
723
        'Expecting string for "login" of type "CreateTaskAssignmentRequestBodyAssignToField"',
724
    });
725
  }
726
  const login: undefined | string = val.login == void 0 ? void 0 : val.login;
×
727
  return {
×
728
    id: id,
729
    login: login,
730
  } satisfies CreateTaskAssignmentRequestBodyAssignToField;
731
}
732
export function serializeCreateTaskAssignmentRequestBody(
144✔
733
  val: CreateTaskAssignmentRequestBody,
734
): SerializedData {
735
  return {
2✔
736
    ['task']: serializeCreateTaskAssignmentRequestBodyTaskField(val.task),
737
    ['assign_to']: serializeCreateTaskAssignmentRequestBodyAssignToField(
738
      val.assignTo,
739
    ),
740
  };
741
}
742
export function deserializeCreateTaskAssignmentRequestBody(
144✔
743
  val: SerializedData,
744
): CreateTaskAssignmentRequestBody {
745
  if (!sdIsMap(val)) {
×
746
    throw new BoxSdkError({
×
747
      message: 'Expecting a map for "CreateTaskAssignmentRequestBody"',
748
    });
749
  }
750
  if (val.task == void 0) {
×
751
    throw new BoxSdkError({
×
752
      message:
753
        'Expecting "task" of type "CreateTaskAssignmentRequestBody" to be defined',
754
    });
755
  }
756
  const task: CreateTaskAssignmentRequestBodyTaskField =
757
    deserializeCreateTaskAssignmentRequestBodyTaskField(val.task);
×
758
  if (val.assign_to == void 0) {
×
759
    throw new BoxSdkError({
×
760
      message:
761
        'Expecting "assign_to" of type "CreateTaskAssignmentRequestBody" to be defined',
762
    });
763
  }
764
  const assignTo: CreateTaskAssignmentRequestBodyAssignToField =
765
    deserializeCreateTaskAssignmentRequestBodyAssignToField(val.assign_to);
×
766
  return {
×
767
    task: task,
768
    assignTo: assignTo,
769
  } satisfies CreateTaskAssignmentRequestBody;
770
}
771
export function serializeUpdateTaskAssignmentByIdRequestBodyResolutionStateField(
144✔
772
  val: UpdateTaskAssignmentByIdRequestBodyResolutionStateField,
773
): SerializedData {
774
  return val;
2✔
775
}
776
export function deserializeUpdateTaskAssignmentByIdRequestBodyResolutionStateField(
144✔
777
  val: SerializedData,
778
): UpdateTaskAssignmentByIdRequestBodyResolutionStateField {
779
  if (val == 'completed') {
×
780
    return val;
×
781
  }
782
  if (val == 'incomplete') {
×
783
    return val;
×
784
  }
785
  if (val == 'approved') {
×
786
    return val;
×
787
  }
788
  if (val == 'rejected') {
×
789
    return val;
×
790
  }
NEW
791
  if (sdIsString(val)) {
×
NEW
792
    return val;
×
793
  }
794
  throw new BoxSdkError({
×
795
    message:
796
      "Can't deserialize UpdateTaskAssignmentByIdRequestBodyResolutionStateField",
797
  });
798
}
799
export function serializeUpdateTaskAssignmentByIdRequestBody(
144✔
800
  val: UpdateTaskAssignmentByIdRequestBody,
801
): SerializedData {
802
  return {
2✔
803
    ['message']: val.message,
804
    ['resolution_state']:
805
      val.resolutionState == void 0
2!
806
        ? val.resolutionState
807
        : serializeUpdateTaskAssignmentByIdRequestBodyResolutionStateField(
808
            val.resolutionState,
809
          ),
810
  };
811
}
812
export function deserializeUpdateTaskAssignmentByIdRequestBody(
144✔
813
  val: SerializedData,
814
): UpdateTaskAssignmentByIdRequestBody {
815
  if (!sdIsMap(val)) {
×
816
    throw new BoxSdkError({
×
817
      message: 'Expecting a map for "UpdateTaskAssignmentByIdRequestBody"',
818
    });
819
  }
820
  if (!(val.message == void 0) && !sdIsString(val.message)) {
×
821
    throw new BoxSdkError({
×
822
      message:
823
        'Expecting string for "message" of type "UpdateTaskAssignmentByIdRequestBody"',
824
    });
825
  }
826
  const message: undefined | string =
827
    val.message == void 0 ? void 0 : val.message;
×
828
  const resolutionState:
829
    | undefined
830
    | UpdateTaskAssignmentByIdRequestBodyResolutionStateField =
831
    val.resolution_state == void 0
×
832
      ? void 0
833
      : deserializeUpdateTaskAssignmentByIdRequestBodyResolutionStateField(
834
          val.resolution_state,
835
        );
836
  return {
×
837
    message: message,
838
    resolutionState: resolutionState,
839
  } satisfies UpdateTaskAssignmentByIdRequestBody;
840
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE TRIAL · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc