swoop-common 2.2.159 → 2.2.161

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.
@@ -5,6 +5,7 @@ import type { Metadata } from './Metadata';
5
5
  export type Branches = {
6
6
  enquiryId: InternalSwoopId;
7
7
  tag: BranchTag;
8
+ branchName?: string;
8
9
  version: number;
9
10
  itineraryId: ItineraryId;
10
11
  metadata: Metadata;
@@ -8,7 +8,6 @@ import type { Title } from './Title';
8
8
  export type DTOItineraryCreate = {
9
9
  enquiryId?: InternalSwoopId;
10
10
  title: Title;
11
- branchName?: string;
12
11
  welcomeNote?: string;
13
12
  values?: Array<ItineraryValue>;
14
13
  amendments?: Array<Amendment>;
@@ -6,7 +6,6 @@ import type { QuoteOptions } from './QuoteOptions';
6
6
  import type { Title } from './Title';
7
7
  export type DTOItineraryUpdate = {
8
8
  title?: Title;
9
- branchName?: string;
10
9
  welcomeNote?: string;
11
10
  values?: Array<ItineraryValue>;
12
11
  componentInstances?: Array<ComponentInstance>;
@@ -5,4 +5,5 @@ export type DTOSnapshotCreate = {
5
5
  name: Title;
6
6
  itineraryId: ItineraryId;
7
7
  enquiryId: InternalSwoopId;
8
+ createdByName?: string;
8
9
  };
@@ -9,4 +9,5 @@ export type DTOSnapshotEntity = {
9
9
  name: Title;
10
10
  itineraryId: ItineraryId;
11
11
  enquiryId: InternalSwoopId;
12
+ createdByName?: string;
12
13
  };
@@ -9,4 +9,5 @@ export type DTOSnapshotRead = {
9
9
  name: Title;
10
10
  itineraryId: ItineraryId;
11
11
  enquiryId: InternalSwoopId;
12
+ createdByName?: string;
12
13
  };
@@ -5,6 +5,7 @@ import type { ComponentBatchResponse } from '../models/ComponentBatchResponse';
5
5
  import type { ComponentId } from '../models/ComponentId';
6
6
  import type { ComponentState } from '../models/ComponentState';
7
7
  import type { Destination } from '../models/Destination';
8
+ import type { DTOBranchRead } from '../models/DTOBranchRead';
8
9
  import type { DTOComponentCreate } from '../models/DTOComponentCreate';
9
10
  import type { DTOComponentRead } from '../models/DTOComponentRead';
10
11
  import type { DTOComponentUpdate } from '../models/DTOComponentUpdate';
@@ -151,6 +152,19 @@ export declare class CoreService {
151
152
  * @throws ApiError
152
153
  */
153
154
  itineraryUpdateAsNewRevision(enquiryId: InternalSwoopId, tag: string, requestBody: DTOItineraryUpdate, error?: number): CancelablePromise<DTOItineraryRead>;
155
+ /**
156
+ * Patch an Itinerary Option
157
+ * Updates branch-level fields (e.g. branchName) without creating a new itinerary revision.
158
+ * @param enquiryId Enquiry Id
159
+ * @param tag the branch tag
160
+ * @param requestBody
161
+ * @param error error can be set to 1, 100, 101, 200, and 201 to mock sync error responses
162
+ * @returns DTOBranchRead Branch updated with new name
163
+ * @throws ApiError
164
+ */
165
+ patchItineraryOption(enquiryId: InternalSwoopId, tag: string, requestBody: {
166
+ branchName: string;
167
+ }, error?: number): CancelablePromise<DTOBranchRead>;
154
168
  /**
155
169
  * Fork an Itinerary
156
170
  * this will create a new sub branch off the corresponding itinerary (enquiry id/tag/version). This does not sync with the Swoop CRM.
@@ -311,6 +311,37 @@ export class CoreService {
311
311
  },
312
312
  });
313
313
  }
314
+ /**
315
+ * Patch an Itinerary Option
316
+ * Updates branch-level fields (e.g. branchName) without creating a new itinerary revision.
317
+ * @param enquiryId Enquiry Id
318
+ * @param tag the branch tag
319
+ * @param requestBody
320
+ * @param error error can be set to 1, 100, 101, 200, and 201 to mock sync error responses
321
+ * @returns DTOBranchRead Branch updated with new name
322
+ * @throws ApiError
323
+ */
324
+ patchItineraryOption(enquiryId, tag, requestBody, error) {
325
+ return __request(OpenAPI, {
326
+ method: 'PATCH',
327
+ url: '/itinerary/{enquiryId}/{tag}',
328
+ path: {
329
+ 'enquiryId': enquiryId,
330
+ 'tag': tag,
331
+ },
332
+ query: {
333
+ 'error': error,
334
+ },
335
+ body: requestBody,
336
+ mediaType: 'application/json',
337
+ errors: {
338
+ 400: `If the payload is malformed`,
339
+ 401: `When the client is not authorised`,
340
+ 404: `If a resource does not exist`,
341
+ 500: `When an unexpected error occurs`,
342
+ },
343
+ });
344
+ }
314
345
  /**
315
346
  * Fork an Itinerary
316
347
  * this will create a new sub branch off the corresponding itinerary (enquiry id/tag/version). This does not sync with the Swoop CRM.
@@ -1,5 +1,6 @@
1
1
  import type { Branches } from '../models/Branches';
2
2
  import type { BranchTag } from '../models/BranchTag';
3
+ import type { DTOBranchRead } from '../models/DTOBranchRead';
3
4
  import type { DTOItineraryCreate } from '../models/DTOItineraryCreate';
4
5
  import type { DTOItineraryRead } from '../models/DTOItineraryRead';
5
6
  import type { DTOItineraryUpdate } from '../models/DTOItineraryUpdate';
@@ -66,6 +67,19 @@ export declare class ItineraryService {
66
67
  * @throws ApiError
67
68
  */
68
69
  static itineraryUpdateAsNewRevision(enquiryId: InternalSwoopId, tag: string, requestBody: DTOItineraryUpdate, error?: number): CancelablePromise<DTOItineraryRead>;
70
+ /**
71
+ * Patch an Itinerary Option
72
+ * Updates branch-level fields (e.g. branchName) without creating a new itinerary revision.
73
+ * @param enquiryId Enquiry Id
74
+ * @param tag the branch tag
75
+ * @param requestBody
76
+ * @param error error can be set to 1, 100, 101, 200, and 201 to mock sync error responses
77
+ * @returns DTOBranchRead Branch updated with new name
78
+ * @throws ApiError
79
+ */
80
+ static patchItineraryOption(enquiryId: InternalSwoopId, tag: string, requestBody: {
81
+ branchName: string;
82
+ }, error?: number): CancelablePromise<DTOBranchRead>;
69
83
  /**
70
84
  * Fork an Itinerary
71
85
  * this will create a new sub branch off the corresponding itinerary (enquiry id/tag/version). This does not sync with the Swoop CRM.
@@ -157,6 +157,37 @@ export class ItineraryService {
157
157
  },
158
158
  });
159
159
  }
160
+ /**
161
+ * Patch an Itinerary Option
162
+ * Updates branch-level fields (e.g. branchName) without creating a new itinerary revision.
163
+ * @param enquiryId Enquiry Id
164
+ * @param tag the branch tag
165
+ * @param requestBody
166
+ * @param error error can be set to 1, 100, 101, 200, and 201 to mock sync error responses
167
+ * @returns DTOBranchRead Branch updated with new name
168
+ * @throws ApiError
169
+ */
170
+ static patchItineraryOption(enquiryId, tag, requestBody, error) {
171
+ return __request(OpenAPI, {
172
+ method: 'PATCH',
173
+ url: '/itinerary/{enquiryId}/{tag}',
174
+ path: {
175
+ 'enquiryId': enquiryId,
176
+ 'tag': tag,
177
+ },
178
+ query: {
179
+ 'error': error,
180
+ },
181
+ body: requestBody,
182
+ mediaType: 'application/json',
183
+ errors: {
184
+ 400: `If the payload is malformed`,
185
+ 401: `When the client is not authorised`,
186
+ 404: `If a resource does not exist`,
187
+ 500: `When an unexpected error occurs`,
188
+ },
189
+ });
190
+ }
160
191
  /**
161
192
  * Fork an Itinerary
162
193
  * this will create a new sub branch off the corresponding itinerary (enquiry id/tag/version). This does not sync with the Swoop CRM.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "swoop-common",
3
- "version": "2.2.159",
3
+ "version": "2.2.161",
4
4
  "main": "dist/api/index.js",
5
5
  "types": "dist/api/index.d.ts",
6
6
  "exports": {