swoop-common 2.2.219 → 2.2.221

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.
@@ -115,6 +115,7 @@ export type { PublicSnapshotTraveller } from './index';
115
115
  export type { 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';
@@ -115,6 +115,7 @@ export type { PublicSnapshotTraveller } from './models/PublicSnapshotTraveller';
115
115
  export type { 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';
@@ -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
  };
@@ -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
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "swoop-common",
3
- "version": "2.2.219",
3
+ "version": "2.2.221",
4
4
  "main": "dist/api/index.js",
5
5
  "types": "dist/api/index.d.ts",
6
6
  "exports": {