swoop-common 2.1.78 → 2.1.80

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.
@@ -97,4 +97,5 @@ export type { ValidationSchemas } from './models/ValidationSchemas';
97
97
  export type { VersionPathParam } from './models/VersionPathParam';
98
98
  export { ComponentService } from './services/ComponentService';
99
99
  export { CoreService } from './services/CoreService';
100
+ export { SwooperService } from './services/SwooperService';
100
101
  export { TemplateService } from './services/TemplateService';
@@ -15,4 +15,5 @@ export { OrgId } from './models/OrgId';
15
15
  export { UrgencyCTA } from './models/UrgencyCTA';
16
16
  export { ComponentService } from './services/ComponentService';
17
17
  export { CoreService } from './services/CoreService';
18
+ export { SwooperService } from './services/SwooperService';
18
19
  export { TemplateService } from './services/TemplateService';
@@ -3,10 +3,14 @@ import type { ComponentState } from '../models/ComponentState';
3
3
  import type { DTOComponentCreate } from '../models/DTOComponentCreate';
4
4
  import type { DTOComponentRead } from '../models/DTOComponentRead';
5
5
  import type { DTOComponentUpdate } from '../models/DTOComponentUpdate';
6
+ import type { DTOSwooperCreate } from '../models/DTOSwooperCreate';
7
+ import type { DTOSwooperRead } from '../models/DTOSwooperRead';
8
+ import type { DTOSwooperUpdate } from '../models/DTOSwooperUpdate';
6
9
  import type { DTOTemplateCreate } from '../models/DTOTemplateCreate';
7
10
  import { DTOTemplateRead } from '../models/DTOTemplateRead';
8
11
  import type { DTOTemplateUpdate } from '../models/DTOTemplateUpdate';
9
12
  import type { Pagination } from '../models/Pagination';
13
+ import type { SwooperId } from '../models/SwooperId';
10
14
  import type { TemplateId } from '../models/TemplateId';
11
15
  import { CancelablePromise } from '../core/CancelablePromise';
12
16
  export declare class CoreService {
@@ -35,13 +39,13 @@ export declare class CoreService {
35
39
  */
36
40
  templateCreate(requestBody: DTOTemplateCreate): CancelablePromise<DTOTemplateRead>;
37
41
  /**
38
- * Get Itinerary
39
- * Get itinerary via ID
42
+ * Get Template
43
+ * Get Template via ID
40
44
  * @param templateId Id of a template
41
45
  * @returns any OK
42
46
  * @throws ApiError
43
47
  */
44
- itineraryGet(templateId: TemplateId): CancelablePromise<any>;
48
+ templateGet(templateId: TemplateId): CancelablePromise<any>;
45
49
  /**
46
50
  * Update Template as New Revision
47
51
  * Updates an template as a new revision
@@ -126,6 +130,47 @@ export declare class CoreService {
126
130
  * @throws ApiError
127
131
  */
128
132
  componentStateUpdate(componentId: ComponentId, state: ComponentState): CancelablePromise<any>;
133
+ /**
134
+ * List Swoopers
135
+ * List all swoopers
136
+ * @param page Pagination, starting at page 1
137
+ * @param limit Number of items per page
138
+ * @param order Order the sort query parameter values either by ascending or descending order
139
+ * @param sort List of fields to sort by, this requires the order query param
140
+ * @param search The search strings to apply to the on query parameter values
141
+ * @param on The fields to apply the search to, the list follows the order and length of the search values in the search query
142
+ * @returns any OK
143
+ * @throws ApiError
144
+ */
145
+ swooperList(page?: number, limit?: number, order?: 'asc' | 'desc', sort?: any[], search?: Array<string>, on?: Array<string>): CancelablePromise<{
146
+ data?: Array<DTOSwooperRead>;
147
+ pagination?: Pagination;
148
+ }>;
149
+ /**
150
+ * Create Swooper
151
+ * Create a Swooper
152
+ * @param requestBody
153
+ * @returns DTOSwooperRead OK
154
+ * @throws ApiError
155
+ */
156
+ swooperCreate(requestBody?: DTOSwooperCreate): CancelablePromise<DTOSwooperRead>;
157
+ /**
158
+ * Get Swooper
159
+ * Get Swooper via ID
160
+ * @param swooperId Swooper Id
161
+ * @returns any The corresponding Swooper that matches their Swooper id
162
+ * @throws ApiError
163
+ */
164
+ swooperGet(swooperId: SwooperId): CancelablePromise<any>;
165
+ /**
166
+ * Update Swooper
167
+ * Update Swooper via ID
168
+ * @param swooperId Swooper Id
169
+ * @param requestBody
170
+ * @returns any The corresponding Swooper that matches their Swooper id
171
+ * @throws ApiError
172
+ */
173
+ swooperUpdate(swooperId: SwooperId, requestBody: DTOSwooperUpdate): CancelablePromise<any>;
129
174
  /**
130
175
  * Resolve template hierarchy
131
176
  * @returns Array<DTOTemplateRead> OK
@@ -66,13 +66,13 @@ export class CoreService {
66
66
  });
67
67
  }
68
68
  /**
69
- * Get Itinerary
70
- * Get itinerary via ID
69
+ * Get Template
70
+ * Get Template via ID
71
71
  * @param templateId Id of a template
72
72
  * @returns any OK
73
73
  * @throws ApiError
74
74
  */
75
- itineraryGet(templateId) {
75
+ templateGet(templateId) {
76
76
  return __request(OpenAPI, {
77
77
  method: 'GET',
78
78
  url: '/templates/{templateId}',
@@ -82,7 +82,7 @@ export class CoreService {
82
82
  errors: {
83
83
  401: `Unauthorized - Missing or invalid Authorization header`,
84
84
  403: `Forbidden - The client is authenticated but not authorized to access this resource`,
85
- 404: `If the itinerary does not exist`,
85
+ 404: `If the Template does not exist`,
86
86
  },
87
87
  });
88
88
  }
@@ -309,6 +309,108 @@ export class CoreService {
309
309
  },
310
310
  });
311
311
  }
312
+ /**
313
+ * List Swoopers
314
+ * List all swoopers
315
+ * @param page Pagination, starting at page 1
316
+ * @param limit Number of items per page
317
+ * @param order Order the sort query parameter values either by ascending or descending order
318
+ * @param sort List of fields to sort by, this requires the order query param
319
+ * @param search The search strings to apply to the on query parameter values
320
+ * @param on The fields to apply the search to, the list follows the order and length of the search values in the search query
321
+ * @returns any OK
322
+ * @throws ApiError
323
+ */
324
+ swooperList(page, limit, order, sort, search, on) {
325
+ return __request(OpenAPI, {
326
+ method: 'GET',
327
+ url: '/swooper',
328
+ query: {
329
+ 'page': page,
330
+ 'limit': limit,
331
+ 'order': order,
332
+ 'sort': sort,
333
+ 'search': search,
334
+ 'on': on,
335
+ },
336
+ errors: {
337
+ 400: `If the filter options or query parameters contain invalid values`,
338
+ 401: `Unauthorized - Missing or invalid Authorization header`,
339
+ 404: `When the Swooper is not found`,
340
+ 500: `When an internal server error occurs when listing all related swoopers`,
341
+ 503: `Service Unavailable - The server is temporarily unable to handle the request`,
342
+ },
343
+ });
344
+ }
345
+ /**
346
+ * Create Swooper
347
+ * Create a Swooper
348
+ * @param requestBody
349
+ * @returns DTOSwooperRead OK
350
+ * @throws ApiError
351
+ */
352
+ swooperCreate(requestBody) {
353
+ return __request(OpenAPI, {
354
+ method: 'POST',
355
+ url: '/swooper',
356
+ body: requestBody,
357
+ mediaType: 'application/json',
358
+ errors: {
359
+ 400: `If the payload is malformed`,
360
+ 401: `Unauthorized - Missing or invalid Authorization header`,
361
+ 404: `When the Swooper is not found`,
362
+ 500: `When an internal server error occurs when creating a swooper entity`,
363
+ 503: `Service Unavailable - The server is temporarily unable to handle the request`,
364
+ },
365
+ });
366
+ }
367
+ /**
368
+ * Get Swooper
369
+ * Get Swooper via ID
370
+ * @param swooperId Swooper Id
371
+ * @returns any The corresponding Swooper that matches their Swooper id
372
+ * @throws ApiError
373
+ */
374
+ swooperGet(swooperId) {
375
+ return __request(OpenAPI, {
376
+ method: 'GET',
377
+ url: '/swooper/{swooperId}',
378
+ path: {
379
+ 'swooperId': swooperId,
380
+ },
381
+ errors: {
382
+ 400: `If the payload is malformed`,
383
+ 401: `Unauthorized - Missing or invalid Authorization header`,
384
+ 404: `When the Swooper is not found`,
385
+ 503: `Service Unavailable - The server is temporarily unable to handle the request`,
386
+ },
387
+ });
388
+ }
389
+ /**
390
+ * Update Swooper
391
+ * Update Swooper via ID
392
+ * @param swooperId Swooper Id
393
+ * @param requestBody
394
+ * @returns any The corresponding Swooper that matches their Swooper id
395
+ * @throws ApiError
396
+ */
397
+ swooperUpdate(swooperId, requestBody) {
398
+ return __request(OpenAPI, {
399
+ method: 'PATCH',
400
+ url: '/swooper/{swooperId}',
401
+ path: {
402
+ 'swooperId': swooperId,
403
+ },
404
+ body: requestBody,
405
+ mediaType: 'application/json',
406
+ errors: {
407
+ 400: `If the payload is malformed`,
408
+ 401: `Unauthorized - Missing or invalid Authorization header`,
409
+ 404: `When the Swooper is not found`,
410
+ 503: `Service Unavailable - The server is temporarily unable to handle the request`,
411
+ },
412
+ });
413
+ }
312
414
  /**
313
415
  * Resolve template hierarchy
314
416
  * @returns Array<DTOTemplateRead> OK
@@ -28,6 +28,7 @@ export class SwooperService {
28
28
  errors: {
29
29
  400: `If the filter options or query parameters contain invalid values`,
30
30
  401: `Unauthorized - Missing or invalid Authorization header`,
31
+ 404: `When the Swooper is not found`,
31
32
  500: `When an internal server error occurs when listing all related swoopers`,
32
33
  503: `Service Unavailable - The server is temporarily unable to handle the request`,
33
34
  },
@@ -49,6 +50,7 @@ export class SwooperService {
49
50
  errors: {
50
51
  400: `If the payload is malformed`,
51
52
  401: `Unauthorized - Missing or invalid Authorization header`,
53
+ 404: `When the Swooper is not found`,
52
54
  500: `When an internal server error occurs when creating a swooper entity`,
53
55
  503: `Service Unavailable - The server is temporarily unable to handle the request`,
54
56
  },
@@ -71,7 +73,7 @@ export class SwooperService {
71
73
  errors: {
72
74
  400: `If the payload is malformed`,
73
75
  401: `Unauthorized - Missing or invalid Authorization header`,
74
- 404: `If the Swooper does not exist as it does not match the Swooper id`,
76
+ 404: `When the Swooper is not found`,
75
77
  503: `Service Unavailable - The server is temporarily unable to handle the request`,
76
78
  },
77
79
  });
@@ -96,7 +98,7 @@ export class SwooperService {
96
98
  errors: {
97
99
  400: `If the payload is malformed`,
98
100
  401: `Unauthorized - Missing or invalid Authorization header`,
99
- 404: `If the Swooper does not exist as it does not match the Swooper id`,
101
+ 404: `When the Swooper is not found`,
100
102
  503: `Service Unavailable - The server is temporarily unable to handle the request`,
101
103
  },
102
104
  });
@@ -30,13 +30,13 @@ export declare class TemplateService {
30
30
  */
31
31
  static templateCreate(requestBody: DTOTemplateCreate): CancelablePromise<DTOTemplateRead>;
32
32
  /**
33
- * Get Itinerary
34
- * Get itinerary via ID
33
+ * Get Template
34
+ * Get Template via ID
35
35
  * @param templateId Id of a template
36
36
  * @returns any OK
37
37
  * @throws ApiError
38
38
  */
39
- static itineraryGet(templateId: TemplateId): CancelablePromise<any>;
39
+ static templateGet(templateId: TemplateId): CancelablePromise<any>;
40
40
  /**
41
41
  * Update Template as New Revision
42
42
  * Updates an template as a new revision
@@ -55,13 +55,13 @@ export class TemplateService {
55
55
  });
56
56
  }
57
57
  /**
58
- * Get Itinerary
59
- * Get itinerary via ID
58
+ * Get Template
59
+ * Get Template via ID
60
60
  * @param templateId Id of a template
61
61
  * @returns any OK
62
62
  * @throws ApiError
63
63
  */
64
- static itineraryGet(templateId) {
64
+ static templateGet(templateId) {
65
65
  return __request(OpenAPI, {
66
66
  method: 'GET',
67
67
  url: '/templates/{templateId}',
@@ -71,7 +71,7 @@ export class TemplateService {
71
71
  errors: {
72
72
  401: `Unauthorized - Missing or invalid Authorization header`,
73
73
  403: `Forbidden - The client is authenticated but not authorized to access this resource`,
74
- 404: `If the itinerary does not exist`,
74
+ 404: `If the Template does not exist`,
75
75
  },
76
76
  });
77
77
  }
@@ -99,4 +99,3 @@ export { AuditService } from './services/AuditService';
99
99
  export { ItineraryService } from './services/ItineraryService';
100
100
  export { RegionService } from './services/RegionService';
101
101
  export { SnapshotService } from './services/SnapshotService';
102
- export { SwooperService } from './services/SwooperService';
@@ -17,4 +17,3 @@ export { AuditService } from './services/AuditService';
17
17
  export { ItineraryService } from './services/ItineraryService';
18
18
  export { RegionService } from './services/RegionService';
19
19
  export { SnapshotService } from './services/SnapshotService';
20
- export { SwooperService } from './services/SwooperService';
@@ -7,14 +7,10 @@ import type { DTORegionCreate } from '../models/DTORegionCreate';
7
7
  import type { DTORegionRead } from '../models/DTORegionRead';
8
8
  import type { DTOSnapshotCreate } from '../models/DTOSnapshotCreate';
9
9
  import type { DTOSnapshotRead } from '../models/DTOSnapshotRead';
10
- import type { DTOSwooperCreate } from '../models/DTOSwooperCreate';
11
- import type { DTOSwooperRead } from '../models/DTOSwooperRead';
12
- import type { DTOSwooperUpdate } from '../models/DTOSwooperUpdate';
13
10
  import type { EnquiryId } from '../models/EnquiryId';
14
11
  import type { ItineraryId } from '../models/ItineraryId';
15
12
  import type { Pagination } from '../models/Pagination';
16
13
  import type { SnapshotId } from '../models/SnapshotId';
17
- import type { SwooperId } from '../models/SwooperId';
18
14
  import type { CancelablePromise } from '../core/CancelablePromise';
19
15
  export declare class ItineraryService {
20
16
  /**
@@ -181,45 +177,4 @@ export declare class ItineraryService {
181
177
  * @throws ApiError
182
178
  */
183
179
  regionCreate(requestBody?: DTORegionCreate): CancelablePromise<DTORegionRead>;
184
- /**
185
- * List Swoopers
186
- * List all swoopers
187
- * @param page Pagination, starting at page 1
188
- * @param limit Number of items per page
189
- * @param order Order the sort query parameter values either by ascending or descending order
190
- * @param sort List of fields to sort by, this requires the order query param
191
- * @param search The search strings to apply to the on query parameter values
192
- * @param on The fields to apply the search to, the list follows the order and length of the search values in the search query
193
- * @returns any OK
194
- * @throws ApiError
195
- */
196
- swooperList(page?: number, limit?: number, order?: 'asc' | 'desc', sort?: any[], search?: Array<string>, on?: Array<string>): CancelablePromise<{
197
- data?: Array<DTOSwooperRead>;
198
- pagination?: Pagination;
199
- }>;
200
- /**
201
- * Create Swooper
202
- * Create a Swooper
203
- * @param requestBody
204
- * @returns DTOSwooperRead OK
205
- * @throws ApiError
206
- */
207
- swooperCreate(requestBody?: DTOSwooperCreate): CancelablePromise<DTOSwooperRead>;
208
- /**
209
- * Get Swooper
210
- * Get Swooper via ID
211
- * @param swooperId Swooper Id
212
- * @returns any The corresponding Swooper that matches their Swooper id
213
- * @throws ApiError
214
- */
215
- swooperGet(swooperId: SwooperId): CancelablePromise<any>;
216
- /**
217
- * Update Swooper
218
- * Update Swooper via ID
219
- * @param swooperId Swooper Id
220
- * @param requestBody
221
- * @returns any The corresponding Swooper that matches their Swooper id
222
- * @throws ApiError
223
- */
224
- swooperUpdate(swooperId: SwooperId, requestBody: DTOSwooperUpdate): CancelablePromise<any>;
225
180
  }
@@ -379,104 +379,4 @@ export class ItineraryService {
379
379
  },
380
380
  });
381
381
  }
382
- /**
383
- * List Swoopers
384
- * List all swoopers
385
- * @param page Pagination, starting at page 1
386
- * @param limit Number of items per page
387
- * @param order Order the sort query parameter values either by ascending or descending order
388
- * @param sort List of fields to sort by, this requires the order query param
389
- * @param search The search strings to apply to the on query parameter values
390
- * @param on The fields to apply the search to, the list follows the order and length of the search values in the search query
391
- * @returns any OK
392
- * @throws ApiError
393
- */
394
- swooperList(page, limit, order, sort, search, on) {
395
- return __request(OpenAPI, {
396
- method: 'GET',
397
- url: '/swooper',
398
- query: {
399
- 'page': page,
400
- 'limit': limit,
401
- 'order': order,
402
- 'sort': sort,
403
- 'search': search,
404
- 'on': on,
405
- },
406
- errors: {
407
- 400: `If the filter options or query parameters contain invalid values`,
408
- 401: `Unauthorized - Missing or invalid Authorization header`,
409
- 500: `When an internal server error occurs when listing all related swoopers`,
410
- 503: `Service Unavailable - The server is temporarily unable to handle the request`,
411
- },
412
- });
413
- }
414
- /**
415
- * Create Swooper
416
- * Create a Swooper
417
- * @param requestBody
418
- * @returns DTOSwooperRead OK
419
- * @throws ApiError
420
- */
421
- swooperCreate(requestBody) {
422
- return __request(OpenAPI, {
423
- method: 'POST',
424
- url: '/swooper',
425
- body: requestBody,
426
- mediaType: 'application/json',
427
- errors: {
428
- 400: `If the payload is malformed`,
429
- 401: `Unauthorized - Missing or invalid Authorization header`,
430
- 500: `When an internal server error occurs when creating a swooper entity`,
431
- 503: `Service Unavailable - The server is temporarily unable to handle the request`,
432
- },
433
- });
434
- }
435
- /**
436
- * Get Swooper
437
- * Get Swooper via ID
438
- * @param swooperId Swooper Id
439
- * @returns any The corresponding Swooper that matches their Swooper id
440
- * @throws ApiError
441
- */
442
- swooperGet(swooperId) {
443
- return __request(OpenAPI, {
444
- method: 'GET',
445
- url: '/swooper/{swooperId}',
446
- path: {
447
- 'swooperId': swooperId,
448
- },
449
- errors: {
450
- 400: `If the payload is malformed`,
451
- 401: `Unauthorized - Missing or invalid Authorization header`,
452
- 404: `If the Swooper does not exist as it does not match the Swooper id`,
453
- 503: `Service Unavailable - The server is temporarily unable to handle the request`,
454
- },
455
- });
456
- }
457
- /**
458
- * Update Swooper
459
- * Update Swooper via ID
460
- * @param swooperId Swooper Id
461
- * @param requestBody
462
- * @returns any The corresponding Swooper that matches their Swooper id
463
- * @throws ApiError
464
- */
465
- swooperUpdate(swooperId, requestBody) {
466
- return __request(OpenAPI, {
467
- method: 'PATCH',
468
- url: '/swooper/{swooperId}',
469
- path: {
470
- 'swooperId': swooperId,
471
- },
472
- body: requestBody,
473
- mediaType: 'application/json',
474
- errors: {
475
- 400: `If the payload is malformed`,
476
- 401: `Unauthorized - Missing or invalid Authorization header`,
477
- 404: `If the Swooper does not exist as it does not match the Swooper id`,
478
- 503: `Service Unavailable - The server is temporarily unable to handle the request`,
479
- },
480
- });
481
- }
482
382
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "swoop-common",
3
- "version": "2.1.78",
3
+ "version": "2.1.80",
4
4
  "main": "dist/api/index.js",
5
5
  "types": "dist/api/index.d.ts",
6
6
  "exports": {