swoop-common 2.2.3 → 2.2.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (25) hide show
  1. package/README.md +225 -225
  2. package/dist/api/generated/core/exports.d.ts +0 -1
  3. package/dist/api/generated/core/index.d.ts +0 -2
  4. package/dist/api/generated/core/index.js +0 -1
  5. package/dist/api/generated/core/models/SortQueryParam.d.ts +1 -1
  6. package/dist/api/generated/core/models/SwooperPersonalInfo.d.ts +4 -4
  7. package/dist/api/generated/core/services/ComponentService.d.ts +5 -5
  8. package/dist/api/generated/core/services/ComponentService.js +19 -17
  9. package/dist/api/generated/core/services/CoreService.d.ts +25 -34
  10. package/dist/api/generated/core/services/CoreService.js +99 -127
  11. package/dist/api/generated/core/services/ItineraryService.d.ts +2 -2
  12. package/dist/api/generated/core/services/ItineraryService.js +22 -22
  13. package/dist/api/generated/core/services/RegionService.d.ts +4 -4
  14. package/dist/api/generated/core/services/RegionService.js +8 -9
  15. package/dist/api/generated/core/services/SnapshotService.d.ts +9 -7
  16. package/dist/api/generated/core/services/SnapshotService.js +20 -22
  17. package/dist/api/generated/core/services/SwooperService.d.ts +4 -3
  18. package/dist/api/generated/core/services/SwooperService.js +12 -13
  19. package/dist/api/generated/core/services/TemplateService.d.ts +3 -3
  20. package/dist/api/generated/core/services/TemplateService.js +18 -20
  21. package/package.json +60 -60
  22. package/dist/api/generated/core/models/B64StringQueryParam.d.ts +0 -4
  23. package/dist/api/generated/core/models/B64StringQueryParam.js +0 -1
  24. package/dist/api/generated/core/services/AuditService.d.ts +0 -13
  25. package/dist/api/generated/core/services/AuditService.js +0 -28
@@ -12,35 +12,11 @@ import { OpenAPI } from '../core/OpenAPI';
12
12
  import { request as __request } from '../core/request';
13
13
  import { resolveTemplateHierarchy } from '../../../additions/templateHierarchyResolver';
14
14
  export class CoreService {
15
- /**
16
- * Audit a Copy to Clipboard
17
- * Audits when a user copies something to their clipboard
18
- * @param itineraryId Itinerary Id
19
- * @param content Base64 encoding of the copied content
20
- * @returns void
21
- * @throws ApiError
22
- */
23
- auditCopyClipboard(itineraryId, content) {
24
- return __request(OpenAPI, {
25
- method: 'POST',
26
- url: '/audit/copyClipboard/{itineraryId}',
27
- path: {
28
- 'itineraryId': itineraryId,
29
- },
30
- query: {
31
- 'content': content,
32
- },
33
- errors: {
34
- 400: `When the content query b64 string is invalid`,
35
- 401: `Unauthorized - Missing or invalid Authorization header`,
36
- },
37
- });
38
- }
39
15
  /**
40
16
  * Create a Snapshot
41
17
  * Creates a new snapshot. A snapshot is a reference to a specific itinerary revision group id.
42
18
  * @param requestBody
43
- * @returns DTOSnapshotRead When the entity is created
19
+ * @returns DTOSnapshotRead When the snapshot is created
44
20
  * @throws ApiError
45
21
  */
46
22
  snapshotCreate(requestBody) {
@@ -51,15 +27,15 @@ export class CoreService {
51
27
  mediaType: 'application/json',
52
28
  errors: {
53
29
  400: `If the payload is malformed`,
54
- 401: `When the user is not authorised to make a request`,
55
- 404: `If the entity does not exist`,
56
- 500: `When an internal server error occurs when creating the entity`,
30
+ 401: `When the client is not authorised`,
31
+ 404: `If a resource does not exist`,
32
+ 500: `When an unexpected error occurs`,
57
33
  },
58
34
  });
59
35
  }
60
36
  /**
61
37
  * List Snapshots
62
- * List all available snapshots relating to the query params
38
+ * Get a paginated response of available snapshots
63
39
  * @param enquiryId
64
40
  * @param page Pagination, starting at page 1
65
41
  * @param limit Number of items per page
@@ -67,7 +43,7 @@ export class CoreService {
67
43
  * @param sort List of fields to sort by, this requires the order query param
68
44
  * @param search The search strings to apply to the on query parameter values
69
45
  * @param on The fields to apply the search to, the list follows the order and length of the search values in the search query
70
- * @returns any The list of all snapshots given the parameters used
46
+ * @returns any Paginated response of snapshots
71
47
  * @throws ApiError
72
48
  */
73
49
  snapshotList(enquiryId, page, limit, order, sort, search, on) {
@@ -85,8 +61,8 @@ export class CoreService {
85
61
  },
86
62
  errors: {
87
63
  400: `If the payload is malformed`,
88
- 401: `When the user is not authorised to make a request`,
89
- 500: `When an internal server error occurs when creating the entity`,
64
+ 401: `When the client is not authorised`,
65
+ 500: `When an unexpected error occurs`,
90
66
  },
91
67
  });
92
68
  }
@@ -94,7 +70,7 @@ export class CoreService {
94
70
  * Get Snapshot va ID
95
71
  * Returns the specific snapshot given its Id
96
72
  * @param snapshotId
97
- * @returns any OK
73
+ * @returns any A object containing the snapshot entity and the itinerary associated with it
98
74
  * @throws ApiError
99
75
  */
100
76
  snapshotGet(snapshotId) {
@@ -106,9 +82,9 @@ export class CoreService {
106
82
  },
107
83
  errors: {
108
84
  400: `If the payload is malformed`,
109
- 401: `Unauthorized - Missing or invalid Authorization header`,
110
- 404: `If the snapshot does not exist`,
111
- 500: `When an internal server error occurs when reading snapshot`,
85
+ 401: `When the client is not authorised`,
86
+ 404: `If a resource does not exist`,
87
+ 500: `When an unexpected error occurs`,
112
88
  },
113
89
  });
114
90
  }
@@ -127,11 +103,10 @@ export class CoreService {
127
103
  'snapshotId': snapshotId,
128
104
  },
129
105
  errors: {
130
- 400: `When the snapshot doesn't exist in the first place, or when a before hook fails before deleting the item`,
131
- 401: `Unauthorized - Missing or invalid Authorization header`,
132
- 404: `If the snapshot to delete to does not exist`,
133
- 500: `When the snapshot fails to delete due to an internal server error`,
134
- 503: `Service Unavailable - The server is temporarily unable to handle the request`,
106
+ 400: `If the payload is malformed`,
107
+ 401: `When the client is not authorised`,
108
+ 404: `If a resource does not exist`,
109
+ 500: `When an unexpected error occurs`,
135
110
  },
136
111
  });
137
112
  }
@@ -139,7 +114,7 @@ export class CoreService {
139
114
  * Restore Snapshot
140
115
  * Creates a new itinerary revision given the content the snapshot refers to
141
116
  * @param snapshotId
142
- * @returns any When a snapshot is restored as the latest version
117
+ * @returns any When a snapshot is restored as the latest version. A object containing the snapshot entity and the itinerary associated with it.
143
118
  * @throws ApiError
144
119
  */
145
120
  snapshotRestore(snapshotId) {
@@ -151,10 +126,9 @@ export class CoreService {
151
126
  },
152
127
  errors: {
153
128
  400: `If the payload is malformed`,
154
- 401: `Unauthorized - Missing or invalid Authorization header`,
155
- 404: `If the entity does not exists`,
156
- 500: `When the snapshot fails to restore due to an internal server error`,
157
- 503: `Service Unavailable - The server is temporarily unable to handle the request`,
129
+ 401: `When the client is not authorised`,
130
+ 404: `If a resource does not exist`,
131
+ 500: `When an unexpected error occurs`,
158
132
  },
159
133
  });
160
134
  }
@@ -162,7 +136,7 @@ export class CoreService {
162
136
  * List Tree view of Itineraries
163
137
  * List all itineraries in a tree view for a specific enquiry id
164
138
  * @param enquiryId Enquiry Id
165
- * @returns any The tree list view of all itineraries given the parameters used
139
+ * @returns any The tree list view of all itineraries. This response is not paginated.
166
140
  * @throws ApiError
167
141
  */
168
142
  itineraryList(enquiryId) {
@@ -173,10 +147,10 @@ export class CoreService {
173
147
  'enquiryId': enquiryId,
174
148
  },
175
149
  errors: {
176
- 400: `If the filter options or query parameters contain invalid values`,
177
- 401: `Unauthorized - Missing or invalid Authorization header`,
178
- 500: `When an internal server error occurs when listing all related itineraries`,
179
- 503: `Service Unavailable - The server is temporarily unable to handle the request`,
150
+ 400: `If the payload is malformed`,
151
+ 401: `When the client is not authorised`,
152
+ 404: `If a resource does not exist`,
153
+ 500: `When an unexpected error occurs`,
180
154
  },
181
155
  });
182
156
  }
@@ -186,7 +160,7 @@ export class CoreService {
186
160
  * @param enquiryId Enquiry Id
187
161
  * @param requestBody
188
162
  * @param error error can be set to 1, 100, 101, 200, and 201 to mock sync error responses
189
- * @returns any When a itinerary is created
163
+ * @returns any When a itinerary is created an object containing the tag, enquiry id, and the associated itinerary is returned.
190
164
  * @throws ApiError
191
165
  */
192
166
  itineraryCreate(enquiryId, requestBody, error) {
@@ -203,11 +177,11 @@ export class CoreService {
203
177
  mediaType: 'application/json',
204
178
  errors: {
205
179
  400: `If the payload is malformed`,
206
- 401: `Unauthorized - Missing or invalid Authorization header`,
207
- 404: `the customer linked via enquiryId does not exist or has been deleted or a referenced traveller group or traveller ID was not found`,
180
+ 401: `When the client is not authorised`,
181
+ 404: `If a resource does not exist`,
182
+ 409: `If a branch already exists with corresponding tag and enquiryId`,
208
183
  422: `An itinerary meets CRM 'late' criteria but 'isLateBookingConfirmed' is false`,
209
- 500: `When an internal server error occurs when creating a itinerary entity`,
210
- 503: `Service Unavailable - The server is temporarily unable to handle the request`,
184
+ 500: `When an unexpected error occurs`,
211
185
  },
212
186
  });
213
187
  }
@@ -231,9 +205,9 @@ export class CoreService {
231
205
  },
232
206
  errors: {
233
207
  400: `If the payload is malformed`,
234
- 401: `Unauthorized - Missing or invalid Authorization header`,
235
- 404: `If the itinerary does not exist as it does not match the enquiry id, tag, and version`,
236
- 503: `Service Unavailable - The server is temporarily unable to handle the request`,
208
+ 401: `When the client is not authorised`,
209
+ 404: `If a resource does not exist`,
210
+ 500: `When an unexpected error occurs`,
237
211
  },
238
212
  });
239
213
  }
@@ -262,10 +236,10 @@ export class CoreService {
262
236
  mediaType: 'application/json',
263
237
  errors: {
264
238
  400: `If the payload is malformed`,
265
- 401: `Unauthorized - Missing or invalid Authorization header`,
266
- 404: `When the itinerary enquiry id and tag do not exists, or the customer linked via enquiryId does not exist, or has been deleted or a referenced traveller group or traveller ID was not found`,
239
+ 401: `When the client is not authorised`,
240
+ 404: `If a resource does not exist`,
267
241
  422: `An itinerary meets CRM 'late' criteria but 'isLateBookingConfirmed' is false`,
268
- 500: `When an internal server error occurs updating an itinerary as a new revision`,
242
+ 500: `When an unexpected error occurs`,
269
243
  },
270
244
  });
271
245
  }
@@ -293,10 +267,10 @@ export class CoreService {
293
267
  },
294
268
  errors: {
295
269
  400: `If the payload is malformed`,
296
- 401: `Unauthorized - Missing or invalid Authorization header`,
297
- 404: `When the itinerary enquiry id and tag do not exists, or the customer linked via enquiryId does not exist, or has been deleted or a referenced traveller group or traveller ID was not found`,
270
+ 401: `When the client is not authorised`,
271
+ 404: `If a resource does not exist`,
298
272
  422: `An itinerary meets CRM 'late' criteria but 'isLateBookingConfirmed' is false`,
299
- 500: `When an internal server error occurs updating an itinerary as a new revision`,
273
+ 500: `When an unexpected error occurs`,
300
274
  },
301
275
  });
302
276
  }
@@ -324,10 +298,10 @@ export class CoreService {
324
298
  },
325
299
  errors: {
326
300
  400: `If the payload is malformed`,
327
- 401: `Unauthorized - Missing or invalid Authorization header`,
328
- 404: `When the itinerary enquiry id and tag do not exists, or the customer linked via enquiryId does not exist, or has been deleted or a referenced traveller group or traveller ID was not found`,
301
+ 401: `When the client is not authorised`,
302
+ 404: `If a resource does not exist`,
329
303
  422: `An itinerary meets CRM 'late' criteria but 'isLateBookingConfirmed' is false`,
330
- 500: `When an internal server error occurs updating an itinerary as a new revision`,
304
+ 500: `When an unexpected error occurs`,
331
305
  },
332
306
  });
333
307
  }
@@ -340,7 +314,7 @@ export class CoreService {
340
314
  * @param sort List of fields to sort by, this requires the order query param
341
315
  * @param search The search strings to apply to the on query parameter values
342
316
  * @param on The fields to apply the search to, the list follows the order and length of the search values in the search query
343
- * @returns any OK
317
+ * @returns any Paginated response of regions
344
318
  * @throws ApiError
345
319
  */
346
320
  regionList(page, limit, order, sort, search, on) {
@@ -356,10 +330,9 @@ export class CoreService {
356
330
  'on': on,
357
331
  },
358
332
  errors: {
359
- 400: `If the filter options or query parameters contain invalid values`,
360
- 401: `Unauthorized - Missing or invalid Authorization header`,
361
- 500: `When an internal server error occurs when listing all related regions`,
362
- 503: `Service Unavailable - The server is temporarily unable to handle the request`,
333
+ 400: `If the payload is malformed`,
334
+ 401: `When the client is not authorised`,
335
+ 500: `When an unexpected error occurs`,
363
336
  },
364
337
  });
365
338
  }
@@ -367,7 +340,7 @@ export class CoreService {
367
340
  * Create Region
368
341
  * Create a region
369
342
  * @param requestBody
370
- * @returns DTORegionRead OK
343
+ * @returns DTORegionRead When a region is created
371
344
  * @throws ApiError
372
345
  */
373
346
  regionCreate(requestBody) {
@@ -378,9 +351,9 @@ export class CoreService {
378
351
  mediaType: 'application/json',
379
352
  errors: {
380
353
  400: `If the payload is malformed`,
381
- 401: `Unauthorized - Missing or invalid Authorization header`,
382
- 500: `When an internal server error occurs when creating a region entity`,
383
- 503: `Service Unavailable - The server is temporarily unable to handle the request`,
354
+ 401: `When the client is not authorised`,
355
+ 404: `If a resource does not exist`,
356
+ 500: `When an unexpected error occurs`,
384
357
  },
385
358
  });
386
359
  }
@@ -393,7 +366,7 @@ export class CoreService {
393
366
  * @param sort List of fields to sort by, this requires the order query param
394
367
  * @param search The search strings to apply to the on query parameter values
395
368
  * @param on The fields to apply the search to, the list follows the order and length of the search values in the search query
396
- * @returns any The list of all templates given the parameters used
369
+ * @returns any Paginated response of templates
397
370
  * @throws ApiError
398
371
  */
399
372
  templateList(page, limit, order, sort, search, on) {
@@ -409,10 +382,9 @@ export class CoreService {
409
382
  'on': on,
410
383
  },
411
384
  errors: {
412
- 400: `If the filter options or query parameters contain invalid values`,
413
- 401: `Unauthorized - Missing or invalid Authorization header`,
414
- 403: `Forbidden - The client is authenticated but not authorized to access this resource`,
415
- 500: `When an internal server error occurs when listing all related templates`,
385
+ 400: `If the payload is malformed`,
386
+ 401: `When the client is not authorised`,
387
+ 500: `When an unexpected error occurs`,
416
388
  },
417
389
  });
418
390
  }
@@ -431,9 +403,9 @@ export class CoreService {
431
403
  mediaType: 'application/json',
432
404
  errors: {
433
405
  400: `If the payload is malformed`,
434
- 401: `Unauthorized - Missing or invalid Authorization header`,
435
- 403: `Forbidden - The client is authenticated but not authorized to access this resource`,
436
- 500: `When an internal server error occurs when creating a template entity`,
406
+ 401: `When the client is not authorised`,
407
+ 404: `If a resource does not exist`,
408
+ 500: `When an unexpected error occurs`,
437
409
  },
438
410
  });
439
411
  }
@@ -452,9 +424,10 @@ export class CoreService {
452
424
  'templateId': templateId,
453
425
  },
454
426
  errors: {
455
- 401: `Unauthorized - Missing or invalid Authorization header`,
456
- 403: `Forbidden - The client is authenticated but not authorized to access this resource`,
457
- 404: `If the Template does not exist`,
427
+ 400: `If the payload is malformed`,
428
+ 401: `When the client is not authorised`,
429
+ 404: `If a resource does not exist`,
430
+ 500: `When an unexpected error occurs`,
458
431
  },
459
432
  });
460
433
  }
@@ -477,10 +450,9 @@ export class CoreService {
477
450
  mediaType: 'application/json',
478
451
  errors: {
479
452
  400: `If the payload is malformed`,
480
- 401: `Unauthorized - Missing or invalid Authorization header`,
481
- 403: `Forbidden - The client is authenticated but not authorized to access this resource`,
482
- 404: `When the template id to create a new revision from is not found`,
483
- 500: `When an internal server error occurs updating a template as a new revision`,
453
+ 401: `When the client is not authorised`,
454
+ 404: `If a resource does not exist`,
455
+ 500: `When an unexpected error occurs`,
484
456
  },
485
457
  });
486
458
  }
@@ -499,11 +471,10 @@ export class CoreService {
499
471
  'templateId': templateId,
500
472
  },
501
473
  errors: {
502
- 400: `When the template doesn't exist in the first place, or when a before hook fails before deleting the item`,
503
- 401: `Unauthorized - Missing or invalid Authorization header`,
504
- 403: `Forbidden - The client is authenticated but not authorized to access this resource`,
505
- 404: `Not Found`,
506
- 500: `When the template fails to delete due to an internal server error`,
474
+ 400: `If the payload is malformed`,
475
+ 401: `When the client is not authorised`,
476
+ 404: `If a resource does not exist`,
477
+ 500: `When an unexpected error occurs`,
507
478
  },
508
479
  });
509
480
  }
@@ -516,7 +487,7 @@ export class CoreService {
516
487
  * @param sort List of fields to sort by, this requires the order query param
517
488
  * @param search The search strings to apply to the on query parameter values
518
489
  * @param on The fields to apply the search to, the list follows the order and length of the search values in the search query
519
- * @returns any The list of all component given the parameters used
490
+ * @returns any Paginated response of components
520
491
  * @throws ApiError
521
492
  */
522
493
  componentList(page, limit, order, sort, search, on) {
@@ -532,10 +503,9 @@ export class CoreService {
532
503
  'on': on,
533
504
  },
534
505
  errors: {
535
- 400: `If the filter options or query parameters contain invalid values`,
536
- 401: `Unauthorized - Missing or invalid Authorization header`,
537
- 403: `Forbidden - The client is authenticated but not authorized to access this resource`,
538
- 500: `When an internal server error occurs when listing all related component`,
506
+ 400: `If the payload is malformed`,
507
+ 401: `When the client is not authorised`,
508
+ 500: `When an unexpected error occurs`,
539
509
  },
540
510
  });
541
511
  }
@@ -575,9 +545,10 @@ export class CoreService {
575
545
  'componentId': componentId,
576
546
  },
577
547
  errors: {
578
- 401: `Missing or invalid Authorization header`,
579
- 403: `The client is authenticated but not authorized to access this resource`,
580
- 404: `If a resource is not found`,
548
+ 400: `If the payload is malformed`,
549
+ 401: `Unauthorized - Missing or invalid Authorization header`,
550
+ 403: `Forbidden - The client is authenticated but not authorized to access this resource`,
551
+ 404: `If a resource does not exist`,
581
552
  500: `Internal Server Error`,
582
553
  },
583
554
  });
@@ -603,8 +574,8 @@ export class CoreService {
603
574
  400: `If the payload is malformed`,
604
575
  401: `Unauthorized - Missing or invalid Authorization header`,
605
576
  403: `Forbidden - The client is authenticated but not authorized to access this resource`,
606
- 404: `When the component id to create a new revision from is not found`,
607
- 500: `When an internal server error occurs updating a component as a new revision`,
577
+ 404: `If a resource does not exist`,
578
+ 500: `Internal Server Error`,
608
579
  },
609
580
  });
610
581
  }
@@ -629,8 +600,8 @@ export class CoreService {
629
600
  400: `If the payload is malformed`,
630
601
  401: `Unauthorized - Missing or invalid Authorization header`,
631
602
  403: `Forbidden - The client is authenticated but not authorized to access this resource`,
632
- 404: `When the component id to update is not found`,
633
- 500: `When an internal server error occurs updating a component`,
603
+ 404: `If a resource does not exist`,
604
+ 500: `Internal Server Error`,
634
605
  },
635
606
  });
636
607
  }
@@ -649,11 +620,11 @@ export class CoreService {
649
620
  'componentId': componentId,
650
621
  },
651
622
  errors: {
652
- 400: `When the component doesn't exist in the first place, or when a before hook fails before deleting the item`,
623
+ 400: `If the payload is malformed`,
653
624
  401: `Unauthorized - Missing or invalid Authorization header`,
654
625
  403: `Forbidden - The client is authenticated but not authorized to access this resource`,
655
- 404: `Not Found`,
656
- 500: `When the component fails to delete due to an internal server error`,
626
+ 404: `If a resource does not exist`,
627
+ 500: `Internal Server Error`,
657
628
  },
658
629
  });
659
630
  }
@@ -662,7 +633,7 @@ export class CoreService {
662
633
  * Directly update component state. This does not create a new revision
663
634
  * @param componentId Id of a component
664
635
  * @param state The publishing state of the component
665
- * @returns any OK
636
+ * @returns DTOComponentRead When the state was updated successfully
666
637
  * @throws ApiError
667
638
  */
668
639
  componentStateUpdate(componentId, state) {
@@ -676,9 +647,11 @@ export class CoreService {
676
647
  'state': state,
677
648
  },
678
649
  errors: {
650
+ 400: `If the payload is malformed`,
679
651
  401: `Unauthorized - Missing or invalid Authorization header`,
680
652
  403: `Forbidden - The client is authenticated but not authorized to access this resource`,
681
- 404: `Not Found`,
653
+ 404: `If a resource does not exist`,
654
+ 500: `Internal Server Error`,
682
655
  },
683
656
  });
684
657
  }
@@ -691,7 +664,7 @@ export class CoreService {
691
664
  * @param sort List of fields to sort by, this requires the order query param
692
665
  * @param search The search strings to apply to the on query parameter values
693
666
  * @param on The fields to apply the search to, the list follows the order and length of the search values in the search query
694
- * @returns any OK
667
+ * @returns any Paginated response of swoopers
695
668
  * @throws ApiError
696
669
  */
697
670
  swooperList(page, limit, order, sort, search, on) {
@@ -707,11 +680,9 @@ export class CoreService {
707
680
  'on': on,
708
681
  },
709
682
  errors: {
710
- 400: `If the filter options or query parameters contain invalid values`,
711
- 401: `Unauthorized - Missing or invalid Authorization header`,
712
- 404: `When the Swooper is not found`,
713
- 500: `When an internal server error occurs when listing all related swoopers`,
714
- 503: `Service Unavailable - The server is temporarily unable to handle the request`,
683
+ 400: `If the payload is malformed`,
684
+ 401: `When the client is not authorised`,
685
+ 500: `When an unexpected error occurs`,
715
686
  },
716
687
  });
717
688
  }
@@ -731,9 +702,8 @@ export class CoreService {
731
702
  errors: {
732
703
  400: `If the payload is malformed`,
733
704
  401: `Unauthorized - Missing or invalid Authorization header`,
734
- 404: `When the Swooper is not found`,
735
- 500: `When an internal server error occurs when creating a swooper entity`,
736
- 503: `Service Unavailable - The server is temporarily unable to handle the request`,
705
+ 403: `Forbidden - The client is authenticated but not authorized to access this resource`,
706
+ 500: `Internal Server Error`,
737
707
  },
738
708
  });
739
709
  }
@@ -754,8 +724,9 @@ export class CoreService {
754
724
  errors: {
755
725
  400: `If the payload is malformed`,
756
726
  401: `Unauthorized - Missing or invalid Authorization header`,
757
- 404: `When the Swooper is not found`,
758
- 503: `Service Unavailable - The server is temporarily unable to handle the request`,
727
+ 403: `Forbidden - The client is authenticated but not authorized to access this resource`,
728
+ 404: `If a resource does not exist`,
729
+ 500: `Internal Server Error`,
759
730
  },
760
731
  });
761
732
  }
@@ -779,8 +750,9 @@ export class CoreService {
779
750
  errors: {
780
751
  400: `If the payload is malformed`,
781
752
  401: `Unauthorized - Missing or invalid Authorization header`,
782
- 404: `When the Swooper is not found`,
783
- 503: `Service Unavailable - The server is temporarily unable to handle the request`,
753
+ 403: `Forbidden - The client is authenticated but not authorized to access this resource`,
754
+ 404: `If a resource does not exist`,
755
+ 500: `Internal Server Error`,
784
756
  },
785
757
  });
786
758
  }
@@ -10,7 +10,7 @@ export declare class ItineraryService {
10
10
  * List Tree view of Itineraries
11
11
  * List all itineraries in a tree view for a specific enquiry id
12
12
  * @param enquiryId Enquiry Id
13
- * @returns any The tree list view of all itineraries given the parameters used
13
+ * @returns any The tree list view of all itineraries. This response is not paginated.
14
14
  * @throws ApiError
15
15
  */
16
16
  static itineraryList(enquiryId: EnquiryId): CancelablePromise<{
@@ -22,7 +22,7 @@ export declare class ItineraryService {
22
22
  * @param enquiryId Enquiry Id
23
23
  * @param requestBody
24
24
  * @param error error can be set to 1, 100, 101, 200, and 201 to mock sync error responses
25
- * @returns any When a itinerary is created
25
+ * @returns any When a itinerary is created an object containing the tag, enquiry id, and the associated itinerary is returned.
26
26
  * @throws ApiError
27
27
  */
28
28
  static itineraryCreate(enquiryId: EnquiryId, requestBody: DTOItineraryCreate, error?: number): CancelablePromise<{
@@ -5,7 +5,7 @@ export class ItineraryService {
5
5
  * List Tree view of Itineraries
6
6
  * List all itineraries in a tree view for a specific enquiry id
7
7
  * @param enquiryId Enquiry Id
8
- * @returns any The tree list view of all itineraries given the parameters used
8
+ * @returns any The tree list view of all itineraries. This response is not paginated.
9
9
  * @throws ApiError
10
10
  */
11
11
  static itineraryList(enquiryId) {
@@ -16,10 +16,10 @@ export class ItineraryService {
16
16
  'enquiryId': enquiryId,
17
17
  },
18
18
  errors: {
19
- 400: `If the filter options or query parameters contain invalid values`,
20
- 401: `Unauthorized - Missing or invalid Authorization header`,
21
- 500: `When an internal server error occurs when listing all related itineraries`,
22
- 503: `Service Unavailable - The server is temporarily unable to handle the request`,
19
+ 400: `If the payload is malformed`,
20
+ 401: `When the client is not authorised`,
21
+ 404: `If a resource does not exist`,
22
+ 500: `When an unexpected error occurs`,
23
23
  },
24
24
  });
25
25
  }
@@ -29,7 +29,7 @@ export class ItineraryService {
29
29
  * @param enquiryId Enquiry Id
30
30
  * @param requestBody
31
31
  * @param error error can be set to 1, 100, 101, 200, and 201 to mock sync error responses
32
- * @returns any When a itinerary is created
32
+ * @returns any When a itinerary is created an object containing the tag, enquiry id, and the associated itinerary is returned.
33
33
  * @throws ApiError
34
34
  */
35
35
  static itineraryCreate(enquiryId, requestBody, error) {
@@ -46,11 +46,11 @@ export class ItineraryService {
46
46
  mediaType: 'application/json',
47
47
  errors: {
48
48
  400: `If the payload is malformed`,
49
- 401: `Unauthorized - Missing or invalid Authorization header`,
50
- 404: `the customer linked via enquiryId does not exist or has been deleted or a referenced traveller group or traveller ID was not found`,
49
+ 401: `When the client is not authorised`,
50
+ 404: `If a resource does not exist`,
51
+ 409: `If a branch already exists with corresponding tag and enquiryId`,
51
52
  422: `An itinerary meets CRM 'late' criteria but 'isLateBookingConfirmed' is false`,
52
- 500: `When an internal server error occurs when creating a itinerary entity`,
53
- 503: `Service Unavailable - The server is temporarily unable to handle the request`,
53
+ 500: `When an unexpected error occurs`,
54
54
  },
55
55
  });
56
56
  }
@@ -74,9 +74,9 @@ export class ItineraryService {
74
74
  },
75
75
  errors: {
76
76
  400: `If the payload is malformed`,
77
- 401: `Unauthorized - Missing or invalid Authorization header`,
78
- 404: `If the itinerary does not exist as it does not match the enquiry id, tag, and version`,
79
- 503: `Service Unavailable - The server is temporarily unable to handle the request`,
77
+ 401: `When the client is not authorised`,
78
+ 404: `If a resource does not exist`,
79
+ 500: `When an unexpected error occurs`,
80
80
  },
81
81
  });
82
82
  }
@@ -105,10 +105,10 @@ export class ItineraryService {
105
105
  mediaType: 'application/json',
106
106
  errors: {
107
107
  400: `If the payload is malformed`,
108
- 401: `Unauthorized - Missing or invalid Authorization header`,
109
- 404: `When the itinerary enquiry id and tag do not exists, or the customer linked via enquiryId does not exist, or has been deleted or a referenced traveller group or traveller ID was not found`,
108
+ 401: `When the client is not authorised`,
109
+ 404: `If a resource does not exist`,
110
110
  422: `An itinerary meets CRM 'late' criteria but 'isLateBookingConfirmed' is false`,
111
- 500: `When an internal server error occurs updating an itinerary as a new revision`,
111
+ 500: `When an unexpected error occurs`,
112
112
  },
113
113
  });
114
114
  }
@@ -136,10 +136,10 @@ export class ItineraryService {
136
136
  },
137
137
  errors: {
138
138
  400: `If the payload is malformed`,
139
- 401: `Unauthorized - Missing or invalid Authorization header`,
140
- 404: `When the itinerary enquiry id and tag do not exists, or the customer linked via enquiryId does not exist, or has been deleted or a referenced traveller group or traveller ID was not found`,
139
+ 401: `When the client is not authorised`,
140
+ 404: `If a resource does not exist`,
141
141
  422: `An itinerary meets CRM 'late' criteria but 'isLateBookingConfirmed' is false`,
142
- 500: `When an internal server error occurs updating an itinerary as a new revision`,
142
+ 500: `When an unexpected error occurs`,
143
143
  },
144
144
  });
145
145
  }
@@ -167,10 +167,10 @@ export class ItineraryService {
167
167
  },
168
168
  errors: {
169
169
  400: `If the payload is malformed`,
170
- 401: `Unauthorized - Missing or invalid Authorization header`,
171
- 404: `When the itinerary enquiry id and tag do not exists, or the customer linked via enquiryId does not exist, or has been deleted or a referenced traveller group or traveller ID was not found`,
170
+ 401: `When the client is not authorised`,
171
+ 404: `If a resource does not exist`,
172
172
  422: `An itinerary meets CRM 'late' criteria but 'isLateBookingConfirmed' is false`,
173
- 500: `When an internal server error occurs updating an itinerary as a new revision`,
173
+ 500: `When an unexpected error occurs`,
174
174
  },
175
175
  });
176
176
  }