swoop-common 2.2.220 → 2.2.222

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 (28) hide show
  1. package/dist/api/generated/core/exports.d.ts +2 -1
  2. package/dist/api/generated/core/exports.js +1 -0
  3. package/dist/api/generated/core/index.d.ts +2 -1
  4. package/dist/api/generated/core/index.js +1 -0
  5. package/dist/api/generated/core/models/ComponentInstance.d.ts +1 -0
  6. package/dist/api/generated/core/models/DTOTripComparisonRead.d.ts +4 -0
  7. package/dist/api/generated/core/models/QuoteOptions.d.ts +8 -0
  8. package/dist/api/generated/core/models/QuoteOptions.js +9 -1
  9. package/dist/api/generated/core/models/SalesActionedRequest.d.ts +6 -0
  10. package/dist/api/generated/core/models/SalesActionedRequest.js +1 -0
  11. package/dist/api/generated/core/models/TripComparisonItem.d.ts +4 -0
  12. package/dist/api/generated/core/services/CoreService.d.ts +10 -0
  13. package/dist/api/generated/core/services/CoreService.js +24 -0
  14. package/dist/api/generated/core/services/TripComparisonService.d.ts +10 -0
  15. package/dist/api/generated/core/services/TripComparisonService.js +24 -0
  16. package/dist/api/generated/swoop/exports.d.ts +4 -0
  17. package/dist/api/generated/swoop/index.d.ts +4 -0
  18. package/dist/api/generated/swoop/models/IbAudit_jsonld_read.d.ts +12 -0
  19. package/dist/api/generated/swoop/models/IbAudit_jsonld_read.js +1 -0
  20. package/dist/api/generated/swoop/models/IbAudit_jsonld_write.d.ts +9 -0
  21. package/dist/api/generated/swoop/models/IbAudit_jsonld_write.js +1 -0
  22. package/dist/api/generated/swoop/models/IbAudit_read.d.ts +11 -0
  23. package/dist/api/generated/swoop/models/IbAudit_read.js +1 -0
  24. package/dist/api/generated/swoop/models/IbAudit_write.d.ts +9 -0
  25. package/dist/api/generated/swoop/models/IbAudit_write.js +1 -0
  26. package/dist/api/generated/swoop/services/SwoopService.d.ts +19 -0
  27. package/dist/api/generated/swoop/services/SwoopService.js +37 -0
  28. package/package.json +1 -1
@@ -112,9 +112,10 @@ export type { PublicSnapShotPayment } from './index';
112
112
  export type { PublicSnapshotPerson } from './index';
113
113
  export type { PublicSnapshotPricing } from './index';
114
114
  export type { PublicSnapshotTraveller } from './index';
115
- export type { QuoteOptions } from './index';
115
+ export { QuoteOptions } from './index';
116
116
  export type { RegionId } from './index';
117
117
  export type { ReserveTripRequest } from './index';
118
+ export type { SalesActionedRequest } from './index';
118
119
  export type { SearchQueryParam } from './index';
119
120
  export type { SnapshotId } from './index';
120
121
  export type { SnapshotIdPathParam } from './index';
@@ -12,4 +12,5 @@ export { Destination } from './index';
12
12
  export { InfoNote } from './index';
13
13
  export { OrderQueryParam } from './index';
14
14
  export { OrgId } from './index';
15
+ export { QuoteOptions } from './index';
15
16
  export { UrgencyCTA } from './index';
@@ -112,9 +112,10 @@ export type { PublicSnapShotPayment } from './models/PublicSnapShotPayment';
112
112
  export type { PublicSnapshotPerson } from './models/PublicSnapshotPerson';
113
113
  export type { PublicSnapshotPricing } from './models/PublicSnapshotPricing';
114
114
  export type { PublicSnapshotTraveller } from './models/PublicSnapshotTraveller';
115
- export type { QuoteOptions } from './models/QuoteOptions';
115
+ export { QuoteOptions } from './models/QuoteOptions';
116
116
  export type { RegionId } from './models/RegionId';
117
117
  export type { ReserveTripRequest } from './models/ReserveTripRequest';
118
+ export type { SalesActionedRequest } from './models/SalesActionedRequest';
118
119
  export type { SearchQueryParam } from './models/SearchQueryParam';
119
120
  export type { SnapshotId } from './models/SnapshotId';
120
121
  export type { SnapshotIdPathParam } from './models/SnapshotIdPathParam';
@@ -15,6 +15,7 @@ export { Destination } from './models/Destination';
15
15
  export { InfoNote } from './models/InfoNote';
16
16
  export { OrderQueryParam } from './models/OrderQueryParam';
17
17
  export { OrgId } from './models/OrgId';
18
+ export { QuoteOptions } from './models/QuoteOptions';
18
19
  export { UrgencyCTA } from './models/UrgencyCTA';
19
20
  export { ComponentService } from './services/ComponentService';
20
21
  export { CoreService } from './services/CoreService';
@@ -34,6 +34,7 @@ export type ComponentInstance = {
34
34
  flag: Flag;
35
35
  bookingStatus: BookingStatus;
36
36
  isCancellationFee?: boolean;
37
+ hideFromCustomer?: boolean;
37
38
  sortOrder?: number;
38
39
  creditEntries?: Array<CreditEntry>;
39
40
  topLevelNotes?: Array<InfoNote>;
@@ -10,5 +10,9 @@ export type DTOTripComparisonRead = {
10
10
  selectedSalesStaff: Record<string, any>;
11
11
  versionName?: string;
12
12
  selectedCurrency: Record<string, any>;
13
+ /**
14
+ * Whether the salesperson has actioned the customer's trip selection (applied or dismissed the prompt).
15
+ */
16
+ salesActioned?: boolean;
13
17
  metadata: Metadata;
14
18
  };
@@ -10,4 +10,12 @@ export type QuoteOptions = {
10
10
  savingMade: string;
11
11
  currency?: Currency;
12
12
  onBehalfOf?: string;
13
+ feeVisibility?: QuoteOptions.feeVisibility;
13
14
  };
15
+ export declare namespace QuoteOptions {
16
+ enum feeVisibility {
17
+ DEFAULT = "default",
18
+ SHOW_ALL = "showAll",
19
+ HIDE_ALL = "hideAll"
20
+ }
21
+ }
@@ -1 +1,9 @@
1
- export {};
1
+ export var QuoteOptions;
2
+ (function (QuoteOptions) {
3
+ let feeVisibility;
4
+ (function (feeVisibility) {
5
+ feeVisibility["DEFAULT"] = "default";
6
+ feeVisibility["SHOW_ALL"] = "showAll";
7
+ feeVisibility["HIDE_ALL"] = "hideAll";
8
+ })(feeVisibility = QuoteOptions.feeVisibility || (QuoteOptions.feeVisibility = {}));
9
+ })(QuoteOptions || (QuoteOptions = {}));
@@ -0,0 +1,6 @@
1
+ export type SalesActionedRequest = {
2
+ /**
3
+ * The value to set for salesActioned. Defaults to true when omitted.
4
+ */
5
+ salesActioned?: boolean;
6
+ };
@@ -8,5 +8,9 @@ export type TripComparisonItem = {
8
8
  selectedSalesStaff: Record<string, any>;
9
9
  versionName?: string;
10
10
  selectedCurrency: Record<string, any>;
11
+ /**
12
+ * Whether the salesperson has actioned the customer's trip selection (applied or dismissed the prompt). Optional for backwards compatibility with existing items.
13
+ */
14
+ salesActioned?: boolean;
11
15
  metadata: Metadata;
12
16
  };
@@ -33,6 +33,7 @@ import type { InternalSwoopId } from '../models/InternalSwoopId';
33
33
  import type { ItineraryCreateResponse } from '../models/ItineraryCreateResponse';
34
34
  import type { Pagination } from '../models/Pagination';
35
35
  import type { ReserveTripRequest } from '../models/ReserveTripRequest';
36
+ import type { SalesActionedRequest } from '../models/SalesActionedRequest';
36
37
  import type { SnapshotId } from '../models/SnapshotId';
37
38
  import type { TemplateId } from '../models/TemplateId';
38
39
  import type { TripComparisonItemId } from '../models/TripComparisonItemId';
@@ -498,6 +499,15 @@ export declare class CoreService {
498
499
  * @throws ApiError
499
500
  */
500
501
  reserveTrip(uuid: TripComparisonItemId, tripIndex: number, requestBody?: ReserveTripRequest): CancelablePromise<DTOTripComparisonRead>;
502
+ /**
503
+ * Mark a trip comparison item as actioned by the salesperson
504
+ * Sets the salesActioned flag on the given TripComparisonItem. Called by the salesperson-facing UI when they apply or dismiss the prompt for a customer-selected trip, so the prompt does not reappear. Defaults salesActioned to true when no body is provided.
505
+ * @param uuid UUID of a trip comparison item
506
+ * @param requestBody
507
+ * @returns DTOTripComparisonRead The updated trip comparison item
508
+ * @throws ApiError
509
+ */
510
+ setSalesActioned(uuid: TripComparisonItemId, requestBody?: SalesActionedRequest): CancelablePromise<DTOTripComparisonRead>;
501
511
  /**
502
512
  * Resolve template hierarchy
503
513
  * @returns Array<DTOTemplateRead> OK
@@ -1160,6 +1160,30 @@ export class CoreService {
1160
1160
  },
1161
1161
  });
1162
1162
  }
1163
+ /**
1164
+ * Mark a trip comparison item as actioned by the salesperson
1165
+ * Sets the salesActioned flag on the given TripComparisonItem. Called by the salesperson-facing UI when they apply or dismiss the prompt for a customer-selected trip, so the prompt does not reappear. Defaults salesActioned to true when no body is provided.
1166
+ * @param uuid UUID of a trip comparison item
1167
+ * @param requestBody
1168
+ * @returns DTOTripComparisonRead The updated trip comparison item
1169
+ * @throws ApiError
1170
+ */
1171
+ setSalesActioned(uuid, requestBody) {
1172
+ return __request(OpenAPI, {
1173
+ method: 'PATCH',
1174
+ url: '/trip-comparison/{uuid}/sales-actioned',
1175
+ path: {
1176
+ 'uuid': uuid,
1177
+ },
1178
+ body: requestBody,
1179
+ mediaType: 'application/json',
1180
+ errors: {
1181
+ 401: `When the bearer token is missing or invalid`,
1182
+ 404: `If the trip comparison item does not exist`,
1183
+ 500: `When an unexpected error occurs`,
1184
+ },
1185
+ });
1186
+ }
1163
1187
  /**
1164
1188
  * Resolve template hierarchy
1165
1189
  * @returns Array<DTOTemplateRead> OK
@@ -3,6 +3,7 @@ import type { DTOTripComparisonRead } from '../models/DTOTripComparisonRead';
3
3
  import type { DTOTripComparisonUpdate } from '../models/DTOTripComparisonUpdate';
4
4
  import type { InternalSwoopId } from '../models/InternalSwoopId';
5
5
  import type { ReserveTripRequest } from '../models/ReserveTripRequest';
6
+ import type { SalesActionedRequest } from '../models/SalesActionedRequest';
6
7
  import type { TripComparisonItemId } from '../models/TripComparisonItemId';
7
8
  import type { CancelablePromise } from '../core/CancelablePromise';
8
9
  export declare class TripComparisonService {
@@ -58,4 +59,13 @@ export declare class TripComparisonService {
58
59
  * @throws ApiError
59
60
  */
60
61
  static reserveTrip(uuid: TripComparisonItemId, tripIndex: number, requestBody?: ReserveTripRequest): CancelablePromise<DTOTripComparisonRead>;
62
+ /**
63
+ * Mark a trip comparison item as actioned by the salesperson
64
+ * Sets the salesActioned flag on the given TripComparisonItem. Called by the salesperson-facing UI when they apply or dismiss the prompt for a customer-selected trip, so the prompt does not reappear. Defaults salesActioned to true when no body is provided.
65
+ * @param uuid UUID of a trip comparison item
66
+ * @param requestBody
67
+ * @returns DTOTripComparisonRead The updated trip comparison item
68
+ * @throws ApiError
69
+ */
70
+ static setSalesActioned(uuid: TripComparisonItemId, requestBody?: SalesActionedRequest): CancelablePromise<DTOTripComparisonRead>;
61
71
  }
@@ -142,4 +142,28 @@ export class TripComparisonService {
142
142
  },
143
143
  });
144
144
  }
145
+ /**
146
+ * Mark a trip comparison item as actioned by the salesperson
147
+ * Sets the salesActioned flag on the given TripComparisonItem. Called by the salesperson-facing UI when they apply or dismiss the prompt for a customer-selected trip, so the prompt does not reappear. Defaults salesActioned to true when no body is provided.
148
+ * @param uuid UUID of a trip comparison item
149
+ * @param requestBody
150
+ * @returns DTOTripComparisonRead The updated trip comparison item
151
+ * @throws ApiError
152
+ */
153
+ static setSalesActioned(uuid, requestBody) {
154
+ return __request(OpenAPI, {
155
+ method: 'PATCH',
156
+ url: '/trip-comparison/{uuid}/sales-actioned',
157
+ path: {
158
+ 'uuid': uuid,
159
+ },
160
+ body: requestBody,
161
+ mediaType: 'application/json',
162
+ errors: {
163
+ 401: `When the bearer token is missing or invalid`,
164
+ 404: `If the trip comparison item does not exist`,
165
+ 500: `When an unexpected error occurs`,
166
+ },
167
+ });
168
+ }
145
169
  }
@@ -52,6 +52,10 @@ export type { ExchangeRateSwoop } from './index';
52
52
  export type { ExchangeRate_jsonldSwoop } from './index';
53
53
  export type { HydraCollectionBaseSchemaSwoop } from './index';
54
54
  export type { HydraItemBaseSchemaSwoop } from './index';
55
+ export type { IbAudit_jsonld_readSwoop } from './index';
56
+ export type { IbAudit_jsonld_writeSwoop } from './index';
57
+ export type { IbAudit_readSwoop } from './index';
58
+ export type { IbAudit_writeSwoop } from './index';
55
59
  export type { Itinerary_ItinerarySaveInputSwoop } from './index';
56
60
  export type { Itinerary_ItinerarySaveInput_jsonldSwoop } from './index';
57
61
  export type { Itinerary_ItinerarySaveOutputSwoop } from './index';
@@ -56,6 +56,10 @@ export type { ExchangeRate as ExchangeRateSwoop } from './models/ExchangeRate';
56
56
  export type { ExchangeRate_jsonld as ExchangeRate_jsonldSwoop } from './models/ExchangeRate_jsonld';
57
57
  export type { HydraCollectionBaseSchema as HydraCollectionBaseSchemaSwoop } from './models/HydraCollectionBaseSchema';
58
58
  export type { HydraItemBaseSchema as HydraItemBaseSchemaSwoop } from './models/HydraItemBaseSchema';
59
+ export type { IbAudit_jsonld_read as IbAudit_jsonld_readSwoop } from './models/IbAudit_jsonld_read';
60
+ export type { IbAudit_jsonld_write as IbAudit_jsonld_writeSwoop } from './models/IbAudit_jsonld_write';
61
+ export type { IbAudit_read as IbAudit_readSwoop } from './models/IbAudit_read';
62
+ export type { IbAudit_write as IbAudit_writeSwoop } from './models/IbAudit_write';
59
63
  export type { Itinerary_ItinerarySaveInput as Itinerary_ItinerarySaveInputSwoop } from './models/Itinerary_ItinerarySaveInput';
60
64
  export type { Itinerary_ItinerarySaveInput_jsonld as Itinerary_ItinerarySaveInput_jsonldSwoop } from './models/Itinerary_ItinerarySaveInput_jsonld';
61
65
  export type { Itinerary_ItinerarySaveOutput as Itinerary_ItinerarySaveOutputSwoop } from './models/Itinerary_ItinerarySaveOutput';
@@ -0,0 +1,12 @@
1
+ import type { HydraItemBaseSchema } from './HydraItemBaseSchema';
2
+ export type IbAudit_jsonld_read = (HydraItemBaseSchema & {
3
+ id?: string;
4
+ enquiryId?: string | null;
5
+ entityId?: string | null;
6
+ entityType?: string | null;
7
+ action?: string | null;
8
+ changes?: Array<null>;
9
+ userEmail?: string | null;
10
+ userId?: string | null;
11
+ createdAt?: string | null;
12
+ });
@@ -0,0 +1,9 @@
1
+ export type IbAudit_jsonld_write = {
2
+ enquiryId?: string | null;
3
+ entityId?: string | null;
4
+ entityType?: string | null;
5
+ action?: string | null;
6
+ changes?: Array<null>;
7
+ userEmail?: string | null;
8
+ userId?: string | null;
9
+ };
@@ -0,0 +1,11 @@
1
+ export type IbAudit_read = {
2
+ id?: string;
3
+ enquiryId?: string | null;
4
+ entityId?: string | null;
5
+ entityType?: string | null;
6
+ action?: string | null;
7
+ changes?: Array<null>;
8
+ userEmail?: string | null;
9
+ userId?: string | null;
10
+ createdAt?: string | null;
11
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,9 @@
1
+ export type IbAudit_write = {
2
+ enquiryId?: string | null;
3
+ entityId?: string | null;
4
+ entityType?: string | null;
5
+ action?: string | null;
6
+ changes?: Array<null>;
7
+ userEmail?: string | null;
8
+ userId?: string | null;
9
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -14,6 +14,8 @@ import type { Departure } from '../models/Departure';
14
14
  import type { Enquiry } from '../models/Enquiry';
15
15
  import type { EnquiryStatus } from '../models/EnquiryStatus';
16
16
  import type { ExchangeRate } from '../models/ExchangeRate';
17
+ import type { IbAudit_read } from '../models/IbAudit_read';
18
+ import type { IbAudit_write } from '../models/IbAudit_write';
17
19
  import type { Itinerary_ItinerarySaveInput } from '../models/Itinerary_ItinerarySaveInput';
18
20
  import type { Itinerary_ItinerarySaveOutput } from '../models/Itinerary_ItinerarySaveOutput';
19
21
  import type { MediaAsset } from '../models/MediaAsset';
@@ -239,6 +241,23 @@ export declare class SwoopService {
239
241
  * @throws ApiError
240
242
  */
241
243
  exchangeRateGetCollection(): CancelablePromise<Array<ExchangeRate>>;
244
+ /**
245
+ * Retrieves the collection of IbAudit resources.
246
+ * Retrieves the collection of IbAudit resources.
247
+ * @param enquiryId Enquiry external id, e.g. PAT-62076
248
+ * @param entityId Entity external id to filter by
249
+ * @returns IbAudit_read IbAudit collection
250
+ * @throws ApiError
251
+ */
252
+ ibAuditGetCollection(enquiryId?: string, entityId?: string): CancelablePromise<Array<IbAudit_read>>;
253
+ /**
254
+ * Creates a IbAudit resource.
255
+ * Creates a IbAudit resource.
256
+ * @param requestBody The new IbAudit resource
257
+ * @returns IbAudit_read IbAudit resource created
258
+ * @throws ApiError
259
+ */
260
+ ibAuditPost(requestBody: IbAudit_write): CancelablePromise<IbAudit_read>;
242
261
  /**
243
262
  * Replaces the Itinerary resource.
244
263
  * Replaces the Itinerary resource.
@@ -343,6 +343,43 @@ export class SwoopService {
343
343
  url: '/api/exchange-rate',
344
344
  });
345
345
  }
346
+ /**
347
+ * Retrieves the collection of IbAudit resources.
348
+ * Retrieves the collection of IbAudit resources.
349
+ * @param enquiryId Enquiry external id, e.g. PAT-62076
350
+ * @param entityId Entity external id to filter by
351
+ * @returns IbAudit_read IbAudit collection
352
+ * @throws ApiError
353
+ */
354
+ ibAuditGetCollection(enquiryId, entityId) {
355
+ return __request(OpenAPI, {
356
+ method: 'GET',
357
+ url: '/api/ib-audit',
358
+ query: {
359
+ 'enquiryId': enquiryId,
360
+ 'entityId': entityId,
361
+ },
362
+ });
363
+ }
364
+ /**
365
+ * Creates a IbAudit resource.
366
+ * Creates a IbAudit resource.
367
+ * @param requestBody The new IbAudit resource
368
+ * @returns IbAudit_read IbAudit resource created
369
+ * @throws ApiError
370
+ */
371
+ ibAuditPost(requestBody) {
372
+ return __request(OpenAPI, {
373
+ method: 'POST',
374
+ url: '/api/ib-audit',
375
+ body: requestBody,
376
+ mediaType: 'application/json',
377
+ errors: {
378
+ 400: `Invalid input`,
379
+ 422: `Validation Error`,
380
+ },
381
+ });
382
+ }
346
383
  /**
347
384
  * Replaces the Itinerary resource.
348
385
  * Replaces the Itinerary resource.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "swoop-common",
3
- "version": "2.2.220",
3
+ "version": "2.2.222",
4
4
  "main": "dist/api/index.js",
5
5
  "types": "dist/api/index.d.ts",
6
6
  "exports": {