swoop-common 2.2.43 → 2.2.48

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 (71) hide show
  1. package/dist/api/generated/core/exports.d.ts +9 -13
  2. package/dist/api/generated/core/exports.js +1 -0
  3. package/dist/api/generated/core/index.d.ts +10 -14
  4. package/dist/api/generated/core/index.js +2 -1
  5. package/dist/api/generated/core/models/Amendment.d.ts +8 -6
  6. package/dist/api/generated/core/models/AmendmentTravellers.d.ts +5 -0
  7. package/dist/api/generated/core/models/AmendmentType.d.ts +3 -0
  8. package/dist/api/generated/core/models/AmendmentType.js +8 -0
  9. package/dist/api/generated/core/models/AssignedPassenger.d.ts +3 -2
  10. package/dist/api/generated/core/models/AssignedTravellerGroup.d.ts +2 -1
  11. package/dist/api/generated/core/models/Branches.d.ts +2 -2
  12. package/dist/api/generated/core/models/ComponentInstance.d.ts +9 -8
  13. package/dist/api/generated/core/models/ComponentInstanceId.d.ts +1 -0
  14. package/dist/api/generated/core/models/DTOItineraryCreate.d.ts +4 -2
  15. package/dist/api/generated/core/models/DTOItineraryEntity.d.ts +4 -2
  16. package/dist/api/generated/core/models/DTOItineraryRead.d.ts +4 -2
  17. package/dist/api/generated/core/models/DTOItineraryUpdate.d.ts +2 -0
  18. package/dist/api/generated/core/models/DTOPublicSnapshotCreate.d.ts +9 -4
  19. package/dist/api/generated/core/models/DTOPublicSnapshotEntity.d.ts +9 -4
  20. package/dist/api/generated/core/models/DTOPublicSnapshotRead.d.ts +9 -4
  21. package/dist/api/generated/core/models/DTOPublicSnapshotUpdate.d.ts +4 -1
  22. package/dist/api/generated/core/models/DTOSnapshotCreate.d.ts +2 -2
  23. package/dist/api/generated/core/models/DTOSnapshotEntity.d.ts +2 -2
  24. package/dist/api/generated/core/models/DTOSnapshotRead.d.ts +2 -2
  25. package/dist/api/generated/core/models/DTOSwoopSync.d.ts +2 -2
  26. package/dist/api/generated/core/models/EnquiryId.d.ts +2 -1
  27. package/dist/api/generated/core/models/EnquiryIdPathParam.d.ts +2 -2
  28. package/dist/api/generated/core/models/{IdMap.d.ts → ExpandedMap.d.ts} +1 -2
  29. package/dist/api/generated/core/models/Flag.d.ts +4 -0
  30. package/dist/api/generated/core/models/InternalSwoopId.d.ts +1 -0
  31. package/dist/api/generated/core/models/ItineraryCreateResponse.d.ts +2 -2
  32. package/dist/api/generated/core/models/Partner.d.ts +2 -1
  33. package/dist/api/generated/core/models/Partners.d.ts +2 -2
  34. package/dist/api/generated/core/models/PublicSnapShotEnquiryStatus.d.ts +8 -0
  35. package/dist/api/generated/core/models/PublicSnapshotPerson.d.ts +11 -0
  36. package/dist/api/generated/core/models/{Error.d.ts → SwoopError.d.ts} +1 -2
  37. package/dist/api/generated/core/models/SwoopSyncComponentInstance.d.ts +5 -3
  38. package/dist/api/generated/core/services/CoreService.d.ts +16 -53
  39. package/dist/api/generated/core/services/CoreService.js +22 -101
  40. package/dist/api/generated/core/services/ItineraryService.d.ts +8 -8
  41. package/dist/api/generated/core/services/PublicService.d.ts +12 -0
  42. package/dist/api/generated/core/services/PublicService.js +26 -0
  43. package/dist/api/generated/core/services/SnapshotService.d.ts +8 -0
  44. package/dist/api/generated/core/services/SnapshotService.js +22 -0
  45. package/package.json +1 -1
  46. package/dist/api/generated/core/models/DTOSwooperCreate.d.ts +0 -20
  47. package/dist/api/generated/core/models/DTOSwooperEntity.d.ts +0 -24
  48. package/dist/api/generated/core/models/DTOSwooperRead.d.ts +0 -24
  49. package/dist/api/generated/core/models/DTOSwooperUpdate.d.ts +0 -19
  50. package/dist/api/generated/core/models/SwoopContactInfo.d.ts +0 -5
  51. package/dist/api/generated/core/models/SwooperExperience.d.ts +0 -7
  52. package/dist/api/generated/core/models/SwooperHighlights.d.ts +0 -5
  53. package/dist/api/generated/core/models/SwooperHighlights.js +0 -1
  54. package/dist/api/generated/core/models/SwooperId.d.ts +0 -1
  55. package/dist/api/generated/core/models/SwooperId.js +0 -1
  56. package/dist/api/generated/core/models/SwooperIdPathParam.d.ts +0 -5
  57. package/dist/api/generated/core/models/SwooperIdPathParam.js +0 -1
  58. package/dist/api/generated/core/models/SwooperInfo.d.ts +0 -6
  59. package/dist/api/generated/core/models/SwooperInfo.js +0 -1
  60. package/dist/api/generated/core/models/SwooperPersonalInfo.d.ts +0 -7
  61. package/dist/api/generated/core/models/SwooperPersonalInfo.js +0 -1
  62. package/dist/api/generated/core/services/SwooperService.d.ts +0 -50
  63. package/dist/api/generated/core/services/SwooperService.js +0 -105
  64. /package/dist/api/generated/core/models/{DTOSwooperCreate.js → AmendmentTravellers.js} +0 -0
  65. /package/dist/api/generated/core/models/{DTOSwooperEntity.js → ComponentInstanceId.js} +0 -0
  66. /package/dist/api/generated/core/models/{DTOSwooperRead.js → ExpandedMap.js} +0 -0
  67. /package/dist/api/generated/core/models/{DTOSwooperUpdate.js → Flag.js} +0 -0
  68. /package/dist/api/generated/core/models/{Error.js → InternalSwoopId.js} +0 -0
  69. /package/dist/api/generated/core/models/{IdMap.js → PublicSnapShotEnquiryStatus.js} +0 -0
  70. /package/dist/api/generated/core/models/{SwoopContactInfo.js → PublicSnapshotPerson.js} +0 -0
  71. /package/dist/api/generated/core/models/{SwooperExperience.js → SwoopError.js} +0 -0
@@ -8,24 +8,28 @@ import type { DTOComponentUpdate } from '../models/DTOComponentUpdate';
8
8
  import type { DTOItineraryCreate } from '../models/DTOItineraryCreate';
9
9
  import type { DTOItineraryRead } from '../models/DTOItineraryRead';
10
10
  import type { DTOItineraryUpdate } from '../models/DTOItineraryUpdate';
11
+ import type { DTOPublicSnapshotRead } from '../models/DTOPublicSnapshotRead';
11
12
  import type { DTORegionCreate } from '../models/DTORegionCreate';
12
13
  import type { DTORegionRead } from '../models/DTORegionRead';
13
14
  import type { DTOSnapshotCreate } from '../models/DTOSnapshotCreate';
14
15
  import type { DTOSnapshotRead } from '../models/DTOSnapshotRead';
15
- import type { DTOSwooperCreate } from '../models/DTOSwooperCreate';
16
- import type { DTOSwooperRead } from '../models/DTOSwooperRead';
17
- import type { DTOSwooperUpdate } from '../models/DTOSwooperUpdate';
18
16
  import type { DTOTemplateCreate } from '../models/DTOTemplateCreate';
19
17
  import { DTOTemplateRead } from '../models/DTOTemplateRead';
20
18
  import type { DTOTemplateUpdate } from '../models/DTOTemplateUpdate';
21
- import type { EnquiryId } from '../models/EnquiryId';
19
+ import type { InternalSwoopId } from '../models/InternalSwoopId';
22
20
  import type { ItineraryCreateResponse } from '../models/ItineraryCreateResponse';
23
21
  import type { Pagination } from '../models/Pagination';
24
22
  import type { SnapshotId } from '../models/SnapshotId';
25
- import type { SwooperId } from '../models/SwooperId';
26
23
  import type { TemplateId } from '../models/TemplateId';
27
24
  import { CancelablePromise } from '../core/CancelablePromise';
28
25
  export declare class CoreService {
26
+ /**
27
+ * Fetch the publicly available snapshot information.
28
+ * @param snapshotId
29
+ * @returns DTOPublicSnapshotRead The publicly available snapshot information
30
+ * @throws ApiError
31
+ */
32
+ publicSnapshotList(snapshotId: SnapshotId): CancelablePromise<DTOPublicSnapshotRead>;
29
33
  /**
30
34
  * Create a Snapshot
31
35
  * Creates a new snapshot. A snapshot is a reference to a specific itinerary revision group id.
@@ -88,7 +92,7 @@ export declare class CoreService {
88
92
  * @returns any The tree list view of all itineraries. This response is not paginated.
89
93
  * @throws ApiError
90
94
  */
91
- itineraryList(enquiryId: EnquiryId): CancelablePromise<{
95
+ itineraryList(enquiryId: InternalSwoopId): CancelablePromise<{
92
96
  tree?: Array<Branches>;
93
97
  }>;
94
98
  /**
@@ -100,7 +104,7 @@ export declare class CoreService {
100
104
  * @returns ItineraryCreateResponse When a itinerary is created an object containing the tag, enquiry id, and the associated itinerary is returned. This will also sync with the Swoop CRM.
101
105
  * @throws ApiError
102
106
  */
103
- itineraryCreate(enquiryId: EnquiryId, requestBody: DTOItineraryCreate, error?: number): CancelablePromise<ItineraryCreateResponse>;
107
+ itineraryCreate(enquiryId: InternalSwoopId, requestBody: DTOItineraryCreate, error?: number): CancelablePromise<ItineraryCreateResponse>;
104
108
  /**
105
109
  * Get Itinerary
106
110
  * Get itinerary via ID
@@ -110,7 +114,7 @@ export declare class CoreService {
110
114
  * @returns any The corresponding itinerary that matches the enquiry id, tag, and version
111
115
  * @throws ApiError
112
116
  */
113
- itineraryGet(enquiryId: EnquiryId, tag: string, version: string): CancelablePromise<any>;
117
+ itineraryGet(enquiryId: InternalSwoopId, tag: string, version: string): CancelablePromise<any>;
114
118
  /**
115
119
  * Update Itinerary as New Revision
116
120
  * Updates an itinerary as a new revision on the latest version of a branch. This will also sync with the Swoop CRM.
@@ -121,7 +125,7 @@ export declare class CoreService {
121
125
  * @returns DTOItineraryRead When a new revision is created successfully
122
126
  * @throws ApiError
123
127
  */
124
- itineraryUpdateAsNewRevision(enquiryId: EnquiryId, tag: string, requestBody: DTOItineraryUpdate, error?: number): CancelablePromise<DTOItineraryRead>;
128
+ itineraryUpdateAsNewRevision(enquiryId: InternalSwoopId, tag: string, requestBody: DTOItineraryUpdate, error?: number): CancelablePromise<DTOItineraryRead>;
125
129
  /**
126
130
  * Fork an Itinerary
127
131
  * this will create a new sub branch off the corresponding itinerary (enquiry id/tag/version). This does not sync with the Swoop CRM.
@@ -132,10 +136,10 @@ export declare class CoreService {
132
136
  * @returns any When the fork was successful
133
137
  * @throws ApiError
134
138
  */
135
- forkItinerary(enquiryId: EnquiryId, tag: string, version: string, error?: number): CancelablePromise<{
139
+ forkItinerary(enquiryId: InternalSwoopId, tag: string, version: string, error?: number): CancelablePromise<{
136
140
  itinerary?: DTOItineraryRead;
137
141
  tag?: BranchTag;
138
- enquiryId?: EnquiryId;
142
+ enquiryId?: InternalSwoopId;
139
143
  }>;
140
144
  /**
141
145
  * Promote an Itinerary
@@ -147,7 +151,7 @@ export declare class CoreService {
147
151
  * @returns DTOItineraryRead The new head of the parent branch
148
152
  * @throws ApiError
149
153
  */
150
- promoteItinerary(enquiryId: EnquiryId, tag: string, version: string, error?: number): CancelablePromise<DTOItineraryRead>;
154
+ promoteItinerary(enquiryId: InternalSwoopId, tag: string, version: string, error?: number): CancelablePromise<DTOItineraryRead>;
151
155
  /**
152
156
  * List Regions
153
157
  * List all regions
@@ -288,47 +292,6 @@ export declare class CoreService {
288
292
  * @throws ApiError
289
293
  */
290
294
  componentStateUpdate(componentId: ComponentId, state: ComponentState): CancelablePromise<DTOComponentRead>;
291
- /**
292
- * List Swoopers
293
- * List all swoopers
294
- * @param page Pagination, starting at page 1
295
- * @param limit Number of items per page
296
- * @param order Order the sort query parameter values either by ascending or descending order
297
- * @param sort List of fields to sort by, this requires the order query param
298
- * @param search The search strings to apply to the on query parameter values
299
- * @param on The fields to apply the search to, the list follows the order and length of the search values in the search query
300
- * @returns any Paginated response of swoopers
301
- * @throws ApiError
302
- */
303
- swooperList(page?: number, limit?: number, order?: 'asc' | 'desc', sort?: Array<string>, search?: Array<string>, on?: Array<string>): CancelablePromise<{
304
- pagination?: Pagination;
305
- data?: Array<DTOTemplateRead>;
306
- }>;
307
- /**
308
- * Create Swooper
309
- * Create a Swooper
310
- * @param requestBody
311
- * @returns DTOSwooperRead OK
312
- * @throws ApiError
313
- */
314
- swooperCreate(requestBody?: DTOSwooperCreate): CancelablePromise<DTOSwooperRead>;
315
- /**
316
- * Get Swooper
317
- * Get Swooper via ID
318
- * @param swooperId Swooper Id
319
- * @returns any The corresponding Swooper that matches their Swooper id
320
- * @throws ApiError
321
- */
322
- swooperGet(swooperId: SwooperId): CancelablePromise<any>;
323
- /**
324
- * Update Swooper
325
- * Update Swooper via ID
326
- * @param swooperId Swooper Id
327
- * @param requestBody
328
- * @returns any The corresponding Swooper that matches their Swooper id
329
- * @throws ApiError
330
- */
331
- swooperUpdate(swooperId: SwooperId, requestBody: DTOSwooperUpdate): CancelablePromise<any>;
332
295
  /**
333
296
  * Resolve template hierarchy
334
297
  * @returns Array<DTOTemplateRead> OK
@@ -12,6 +12,28 @@ 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
+ * Fetch the publicly available snapshot information.
17
+ * @param snapshotId
18
+ * @returns DTOPublicSnapshotRead The publicly available snapshot information
19
+ * @throws ApiError
20
+ */
21
+ publicSnapshotList(snapshotId) {
22
+ return __request(OpenAPI, {
23
+ method: 'GET',
24
+ url: '/public/snapshot/{snapshotId}',
25
+ path: {
26
+ 'snapshotId': snapshotId,
27
+ },
28
+ errors: {
29
+ 400: `If the payload is malformed`,
30
+ 401: `When the client is not authorised`,
31
+ 403: `When the snapshot is missing from the requests context`,
32
+ 404: `If a resource does not exist`,
33
+ 500: `When an unexpected error occurs`,
34
+ },
35
+ });
36
+ }
15
37
  /**
16
38
  * Create a Snapshot
17
39
  * Creates a new snapshot. A snapshot is a reference to a specific itinerary revision group id.
@@ -654,107 +676,6 @@ export class CoreService {
654
676
  },
655
677
  });
656
678
  }
657
- /**
658
- * List Swoopers
659
- * List all swoopers
660
- * @param page Pagination, starting at page 1
661
- * @param limit Number of items per page
662
- * @param order Order the sort query parameter values either by ascending or descending order
663
- * @param sort List of fields to sort by, this requires the order query param
664
- * @param search The search strings to apply to the on query parameter values
665
- * @param on The fields to apply the search to, the list follows the order and length of the search values in the search query
666
- * @returns any Paginated response of swoopers
667
- * @throws ApiError
668
- */
669
- swooperList(page, limit, order, sort, search, on) {
670
- return __request(OpenAPI, {
671
- method: 'GET',
672
- url: '/swooper',
673
- query: {
674
- 'page': page,
675
- 'limit': limit,
676
- 'order': order,
677
- 'sort': sort,
678
- 'search': search,
679
- 'on': on,
680
- },
681
- errors: {
682
- 400: `If the payload is malformed`,
683
- 401: `When the client is not authorised`,
684
- 500: `When an unexpected error occurs`,
685
- },
686
- });
687
- }
688
- /**
689
- * Create Swooper
690
- * Create a Swooper
691
- * @param requestBody
692
- * @returns DTOSwooperRead OK
693
- * @throws ApiError
694
- */
695
- swooperCreate(requestBody) {
696
- return __request(OpenAPI, {
697
- method: 'POST',
698
- url: '/swooper',
699
- body: requestBody,
700
- mediaType: 'application/json',
701
- errors: {
702
- 400: `If the payload is malformed`,
703
- 401: `Unauthorized - Missing or invalid Authorization header`,
704
- 403: `Forbidden - The client is authenticated but not authorized to access this resource`,
705
- 500: `Internal Server Error`,
706
- },
707
- });
708
- }
709
- /**
710
- * Get Swooper
711
- * Get Swooper via ID
712
- * @param swooperId Swooper Id
713
- * @returns any The corresponding Swooper that matches their Swooper id
714
- * @throws ApiError
715
- */
716
- swooperGet(swooperId) {
717
- return __request(OpenAPI, {
718
- method: 'GET',
719
- url: '/swooper/{swooperId}',
720
- path: {
721
- 'swooperId': swooperId,
722
- },
723
- errors: {
724
- 400: `If the payload is malformed`,
725
- 401: `Unauthorized - Missing or invalid Authorization header`,
726
- 403: `Forbidden - The client is authenticated but not authorized to access this resource`,
727
- 404: `If a resource does not exist`,
728
- 500: `Internal Server Error`,
729
- },
730
- });
731
- }
732
- /**
733
- * Update Swooper
734
- * Update Swooper via ID
735
- * @param swooperId Swooper Id
736
- * @param requestBody
737
- * @returns any The corresponding Swooper that matches their Swooper id
738
- * @throws ApiError
739
- */
740
- swooperUpdate(swooperId, requestBody) {
741
- return __request(OpenAPI, {
742
- method: 'PATCH',
743
- url: '/swooper/{swooperId}',
744
- path: {
745
- 'swooperId': swooperId,
746
- },
747
- body: requestBody,
748
- mediaType: 'application/json',
749
- errors: {
750
- 400: `If the payload is malformed`,
751
- 401: `Unauthorized - Missing or invalid Authorization header`,
752
- 403: `Forbidden - The client is authenticated but not authorized to access this resource`,
753
- 404: `If a resource does not exist`,
754
- 500: `Internal Server Error`,
755
- },
756
- });
757
- }
758
679
  /**
759
680
  * Resolve template hierarchy
760
681
  * @returns Array<DTOTemplateRead> OK
@@ -3,7 +3,7 @@ import type { BranchTag } from '../models/BranchTag';
3
3
  import type { DTOItineraryCreate } from '../models/DTOItineraryCreate';
4
4
  import type { DTOItineraryRead } from '../models/DTOItineraryRead';
5
5
  import type { DTOItineraryUpdate } from '../models/DTOItineraryUpdate';
6
- import type { EnquiryId } from '../models/EnquiryId';
6
+ import type { InternalSwoopId } from '../models/InternalSwoopId';
7
7
  import type { ItineraryCreateResponse } from '../models/ItineraryCreateResponse';
8
8
  import type { CancelablePromise } from '../core/CancelablePromise';
9
9
  export declare class ItineraryService {
@@ -14,7 +14,7 @@ export declare class ItineraryService {
14
14
  * @returns any The tree list view of all itineraries. This response is not paginated.
15
15
  * @throws ApiError
16
16
  */
17
- static itineraryList(enquiryId: EnquiryId): CancelablePromise<{
17
+ static itineraryList(enquiryId: InternalSwoopId): CancelablePromise<{
18
18
  tree?: Array<Branches>;
19
19
  }>;
20
20
  /**
@@ -26,7 +26,7 @@ export declare class ItineraryService {
26
26
  * @returns ItineraryCreateResponse When a itinerary is created an object containing the tag, enquiry id, and the associated itinerary is returned. This will also sync with the Swoop CRM.
27
27
  * @throws ApiError
28
28
  */
29
- static itineraryCreate(enquiryId: EnquiryId, requestBody: DTOItineraryCreate, error?: number): CancelablePromise<ItineraryCreateResponse>;
29
+ static itineraryCreate(enquiryId: InternalSwoopId, requestBody: DTOItineraryCreate, error?: number): CancelablePromise<ItineraryCreateResponse>;
30
30
  /**
31
31
  * Get Itinerary
32
32
  * Get itinerary via ID
@@ -36,7 +36,7 @@ export declare class ItineraryService {
36
36
  * @returns any The corresponding itinerary that matches the enquiry id, tag, and version
37
37
  * @throws ApiError
38
38
  */
39
- static itineraryGet(enquiryId: EnquiryId, tag: string, version: string): CancelablePromise<any>;
39
+ static itineraryGet(enquiryId: InternalSwoopId, tag: string, version: string): CancelablePromise<any>;
40
40
  /**
41
41
  * Update Itinerary as New Revision
42
42
  * Updates an itinerary as a new revision on the latest version of a branch. This will also sync with the Swoop CRM.
@@ -47,7 +47,7 @@ export declare class ItineraryService {
47
47
  * @returns DTOItineraryRead When a new revision is created successfully
48
48
  * @throws ApiError
49
49
  */
50
- static itineraryUpdateAsNewRevision(enquiryId: EnquiryId, tag: string, requestBody: DTOItineraryUpdate, error?: number): CancelablePromise<DTOItineraryRead>;
50
+ static itineraryUpdateAsNewRevision(enquiryId: InternalSwoopId, tag: string, requestBody: DTOItineraryUpdate, error?: number): CancelablePromise<DTOItineraryRead>;
51
51
  /**
52
52
  * Fork an Itinerary
53
53
  * this will create a new sub branch off the corresponding itinerary (enquiry id/tag/version). This does not sync with the Swoop CRM.
@@ -58,10 +58,10 @@ export declare class ItineraryService {
58
58
  * @returns any When the fork was successful
59
59
  * @throws ApiError
60
60
  */
61
- static forkItinerary(enquiryId: EnquiryId, tag: string, version: string, error?: number): CancelablePromise<{
61
+ static forkItinerary(enquiryId: InternalSwoopId, tag: string, version: string, error?: number): CancelablePromise<{
62
62
  itinerary?: DTOItineraryRead;
63
63
  tag?: BranchTag;
64
- enquiryId?: EnquiryId;
64
+ enquiryId?: InternalSwoopId;
65
65
  }>;
66
66
  /**
67
67
  * Promote an Itinerary
@@ -73,5 +73,5 @@ export declare class ItineraryService {
73
73
  * @returns DTOItineraryRead The new head of the parent branch
74
74
  * @throws ApiError
75
75
  */
76
- static promoteItinerary(enquiryId: EnquiryId, tag: string, version: string, error?: number): CancelablePromise<DTOItineraryRead>;
76
+ static promoteItinerary(enquiryId: InternalSwoopId, tag: string, version: string, error?: number): CancelablePromise<DTOItineraryRead>;
77
77
  }
@@ -0,0 +1,12 @@
1
+ import type { DTOPublicSnapshotRead } from '../models/DTOPublicSnapshotRead';
2
+ import type { SnapshotId } from '../models/SnapshotId';
3
+ import type { CancelablePromise } from '../core/CancelablePromise';
4
+ export declare class PublicService {
5
+ /**
6
+ * Fetch the publicly available snapshot information.
7
+ * @param snapshotId
8
+ * @returns DTOPublicSnapshotRead The publicly available snapshot information
9
+ * @throws ApiError
10
+ */
11
+ static publicSnapshotList(snapshotId: SnapshotId): CancelablePromise<DTOPublicSnapshotRead>;
12
+ }
@@ -0,0 +1,26 @@
1
+ import { OpenAPI } from '../core/OpenAPI';
2
+ import { request as __request } from '../core/request';
3
+ export class PublicService {
4
+ /**
5
+ * Fetch the publicly available snapshot information.
6
+ * @param snapshotId
7
+ * @returns DTOPublicSnapshotRead The publicly available snapshot information
8
+ * @throws ApiError
9
+ */
10
+ static publicSnapshotList(snapshotId) {
11
+ return __request(OpenAPI, {
12
+ method: 'GET',
13
+ url: '/public/snapshot/{snapshotId}',
14
+ path: {
15
+ 'snapshotId': snapshotId,
16
+ },
17
+ errors: {
18
+ 400: `If the payload is malformed`,
19
+ 401: `When the client is not authorised`,
20
+ 403: `When the snapshot is missing from the requests context`,
21
+ 404: `If a resource does not exist`,
22
+ 500: `When an unexpected error occurs`,
23
+ },
24
+ });
25
+ }
26
+ }
@@ -1,10 +1,18 @@
1
1
  import type { DTOItineraryRead } from '../models/DTOItineraryRead';
2
+ import type { DTOPublicSnapshotRead } from '../models/DTOPublicSnapshotRead';
2
3
  import type { DTOSnapshotCreate } from '../models/DTOSnapshotCreate';
3
4
  import type { DTOSnapshotRead } from '../models/DTOSnapshotRead';
4
5
  import type { Pagination } from '../models/Pagination';
5
6
  import type { SnapshotId } from '../models/SnapshotId';
6
7
  import type { CancelablePromise } from '../core/CancelablePromise';
7
8
  export declare class SnapshotService {
9
+ /**
10
+ * Fetch the publicly available snapshot information.
11
+ * @param snapshotId
12
+ * @returns DTOPublicSnapshotRead The publicly available snapshot information
13
+ * @throws ApiError
14
+ */
15
+ static publicSnapshotList(snapshotId: SnapshotId): CancelablePromise<DTOPublicSnapshotRead>;
8
16
  /**
9
17
  * Create a Snapshot
10
18
  * Creates a new snapshot. A snapshot is a reference to a specific itinerary revision group id.
@@ -1,6 +1,28 @@
1
1
  import { OpenAPI } from '../core/OpenAPI';
2
2
  import { request as __request } from '../core/request';
3
3
  export class SnapshotService {
4
+ /**
5
+ * Fetch the publicly available snapshot information.
6
+ * @param snapshotId
7
+ * @returns DTOPublicSnapshotRead The publicly available snapshot information
8
+ * @throws ApiError
9
+ */
10
+ static publicSnapshotList(snapshotId) {
11
+ return __request(OpenAPI, {
12
+ method: 'GET',
13
+ url: '/public/snapshot/{snapshotId}',
14
+ path: {
15
+ 'snapshotId': snapshotId,
16
+ },
17
+ errors: {
18
+ 400: `If the payload is malformed`,
19
+ 401: `When the client is not authorised`,
20
+ 403: `When the snapshot is missing from the requests context`,
21
+ 404: `If a resource does not exist`,
22
+ 500: `When an unexpected error occurs`,
23
+ },
24
+ });
25
+ }
4
26
  /**
5
27
  * Create a Snapshot
6
28
  * Creates a new snapshot. A snapshot is a reference to a specific itinerary revision group id.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "swoop-common",
3
- "version": "2.2.43",
3
+ "version": "2.2.48",
4
4
  "main": "dist/api/index.js",
5
5
  "types": "dist/api/index.d.ts",
6
6
  "exports": {
@@ -1,20 +0,0 @@
1
- import type { Media } from './Media';
2
- import type { SwoopContactInfo } from './SwoopContactInfo';
3
- import type { SwooperExperience } from './SwooperExperience';
4
- import type { SwooperInfo } from './SwooperInfo';
5
- import type { SwooperPersonalInfo } from './SwooperPersonalInfo';
6
- export type DTOSwooperCreate = {
7
- swoopId: string;
8
- portrait?: string;
9
- avatar?: string;
10
- banner?: string;
11
- bio?: string;
12
- name: string;
13
- fullName: string;
14
- media?: Media;
15
- info: SwooperInfo;
16
- personal: SwooperPersonalInfo;
17
- experience: SwooperExperience;
18
- contact: SwoopContactInfo;
19
- customerReviews?: Array<string>;
20
- };
@@ -1,24 +0,0 @@
1
- import type { Media } from './Media';
2
- import type { Metadata } from './Metadata';
3
- import type { SwoopContactInfo } from './SwoopContactInfo';
4
- import type { SwooperExperience } from './SwooperExperience';
5
- import type { SwooperId } from './SwooperId';
6
- import type { SwooperInfo } from './SwooperInfo';
7
- import type { SwooperPersonalInfo } from './SwooperPersonalInfo';
8
- export type DTOSwooperEntity = {
9
- id: SwooperId;
10
- swoopId: string;
11
- metadata: Metadata;
12
- portrait: string;
13
- avatar: string;
14
- banner: string;
15
- bio: string;
16
- name: string;
17
- fullName: string;
18
- media: Media;
19
- info: SwooperInfo;
20
- personal: SwooperPersonalInfo;
21
- experience: SwooperExperience;
22
- contact: SwoopContactInfo;
23
- customerReviews: Array<string>;
24
- };
@@ -1,24 +0,0 @@
1
- import type { Media } from './Media';
2
- import type { Metadata } from './Metadata';
3
- import type { SwoopContactInfo } from './SwoopContactInfo';
4
- import type { SwooperExperience } from './SwooperExperience';
5
- import type { SwooperId } from './SwooperId';
6
- import type { SwooperInfo } from './SwooperInfo';
7
- import type { SwooperPersonalInfo } from './SwooperPersonalInfo';
8
- export type DTOSwooperRead = {
9
- id: SwooperId;
10
- swoopId: string;
11
- metadata: Metadata;
12
- portrait?: string;
13
- avatar?: string;
14
- banner?: string;
15
- bio?: string;
16
- name: string;
17
- fullName: string;
18
- media: Media;
19
- info: SwooperInfo;
20
- personal: SwooperPersonalInfo;
21
- experience: SwooperExperience;
22
- contact: SwoopContactInfo;
23
- customerReviews: Array<string>;
24
- };
@@ -1,19 +0,0 @@
1
- import type { Media } from './Media';
2
- import type { SwoopContactInfo } from './SwoopContactInfo';
3
- import type { SwooperExperience } from './SwooperExperience';
4
- import type { SwooperInfo } from './SwooperInfo';
5
- import type { SwooperPersonalInfo } from './SwooperPersonalInfo';
6
- export type DTOSwooperUpdate = {
7
- portrait?: string;
8
- avatar?: string;
9
- banner?: string;
10
- bio?: string;
11
- name?: string;
12
- fullName?: string;
13
- media?: Media;
14
- info?: SwooperInfo;
15
- personal?: SwooperPersonalInfo;
16
- experience?: SwooperExperience;
17
- contact?: SwoopContactInfo;
18
- customerReviews?: Array<string>;
19
- };
@@ -1,5 +0,0 @@
1
- export type SwoopContactInfo = {
2
- email: string;
3
- phone: string;
4
- calendly: string;
5
- };
@@ -1,7 +0,0 @@
1
- export type SwooperExperience = {
2
- specialisations: Array<string>;
3
- regions?: Array<string>;
4
- roles: Array<string>;
5
- projects: Array<string>;
6
- locations: Array<string>;
7
- };
@@ -1,5 +0,0 @@
1
- export type SwooperHighlights = {
2
- firstExperience: string;
3
- topExperiences: Array<string>;
4
- loveForRegion: string;
5
- };
@@ -1 +0,0 @@
1
- export {};
@@ -1 +0,0 @@
1
- export type SwooperId = string;
@@ -1 +0,0 @@
1
- export {};
@@ -1,5 +0,0 @@
1
- import type { SwooperId } from './SwooperId';
2
- /**
3
- * Swooper Id
4
- */
5
- export type SwooperIdPathParam = SwooperId;
@@ -1 +0,0 @@
1
- export {};
@@ -1,6 +0,0 @@
1
- export type SwooperInfo = {
2
- based: string;
3
- currentRole: string;
4
- initialRole: string;
5
- yearJoined: number;
6
- };
@@ -1 +0,0 @@
1
- export {};
@@ -1,7 +0,0 @@
1
- import type { SwooperHighlights } from './SwooperHighlights';
2
- export type SwooperPersonalInfo = {
3
- highlights: SwooperHighlights;
4
- interests: Array<string>;
5
- dayToDay: string;
6
- startedInTravel: number;
7
- };
@@ -1 +0,0 @@
1
- export {};
@@ -1,50 +0,0 @@
1
- import type { DTOSwooperCreate } from '../models/DTOSwooperCreate';
2
- import type { DTOSwooperRead } from '../models/DTOSwooperRead';
3
- import type { DTOSwooperUpdate } from '../models/DTOSwooperUpdate';
4
- import type { DTOTemplateRead } from '../models/DTOTemplateRead';
5
- import type { Pagination } from '../models/Pagination';
6
- import type { SwooperId } from '../models/SwooperId';
7
- import type { CancelablePromise } from '../core/CancelablePromise';
8
- export declare class SwooperService {
9
- /**
10
- * List Swoopers
11
- * List all swoopers
12
- * @param page Pagination, starting at page 1
13
- * @param limit Number of items per page
14
- * @param order Order the sort query parameter values either by ascending or descending order
15
- * @param sort List of fields to sort by, this requires the order query param
16
- * @param search The search strings to apply to the on query parameter values
17
- * @param on The fields to apply the search to, the list follows the order and length of the search values in the search query
18
- * @returns any Paginated response of swoopers
19
- * @throws ApiError
20
- */
21
- static swooperList(page?: number, limit?: number, order?: 'asc' | 'desc', sort?: Array<string>, search?: Array<string>, on?: Array<string>): CancelablePromise<{
22
- pagination?: Pagination;
23
- data?: Array<DTOTemplateRead>;
24
- }>;
25
- /**
26
- * Create Swooper
27
- * Create a Swooper
28
- * @param requestBody
29
- * @returns DTOSwooperRead OK
30
- * @throws ApiError
31
- */
32
- static swooperCreate(requestBody?: DTOSwooperCreate): CancelablePromise<DTOSwooperRead>;
33
- /**
34
- * Get Swooper
35
- * Get Swooper via ID
36
- * @param swooperId Swooper Id
37
- * @returns any The corresponding Swooper that matches their Swooper id
38
- * @throws ApiError
39
- */
40
- static swooperGet(swooperId: SwooperId): CancelablePromise<any>;
41
- /**
42
- * Update Swooper
43
- * Update Swooper via ID
44
- * @param swooperId Swooper Id
45
- * @param requestBody
46
- * @returns any The corresponding Swooper that matches their Swooper id
47
- * @throws ApiError
48
- */
49
- static swooperUpdate(swooperId: SwooperId, requestBody: DTOSwooperUpdate): CancelablePromise<any>;
50
- }