swoop-common 2.2.151 → 2.2.152

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.
@@ -2,6 +2,7 @@ export { ApiError } from './index';
2
2
  export { CancelablePromise, CancelError } from './index';
3
3
  export { OpenAPI } from './index';
4
4
  export type { OpenAPIConfig } from './index';
5
+ export type { AdventurePlannerConfig } from './index';
5
6
  export type { Amendment } from './index';
6
7
  export type { AmendmentTravellers } from './index';
7
8
  export { AmendmentType } from './index';
@@ -2,6 +2,7 @@ export { ApiError } from './core/ApiError';
2
2
  export { CancelablePromise, CancelError } from './core/CancelablePromise';
3
3
  export { OpenAPI } from './core/OpenAPI';
4
4
  export type { OpenAPIConfig } from './core/OpenAPI';
5
+ export type { AdventurePlannerConfig } from './models/AdventurePlannerConfig';
5
6
  export type { Amendment } from './models/Amendment';
6
7
  export type { AmendmentTravellers } from './models/AmendmentTravellers';
7
8
  export { AmendmentType } from './models/AmendmentType';
@@ -0,0 +1,6 @@
1
+ export type AdventurePlannerConfig = {
2
+ /**
3
+ * The selected itinerary snapshot ID, or null if none is selected.
4
+ */
5
+ selectedItinerary?: string | null;
6
+ };
@@ -1,3 +1,4 @@
1
+ import type { AdventurePlannerConfig } from './AdventurePlannerConfig';
1
2
  import type { Amendment } from './Amendment';
2
3
  import type { ComponentInstance } from './ComponentInstance';
3
4
  import type { InternalSwoopId } from './InternalSwoopId';
@@ -13,4 +14,5 @@ export type DTOItineraryCreate = {
13
14
  componentInstances?: Array<ComponentInstance>;
14
15
  quoteOption?: QuoteOptions;
15
16
  isLateBookingConfirmed?: boolean;
17
+ adventurePlannerConfig?: AdventurePlannerConfig;
16
18
  };
@@ -1,3 +1,4 @@
1
+ import type { AdventurePlannerConfig } from './AdventurePlannerConfig';
1
2
  import type { Amendment } from './Amendment';
2
3
  import type { ComponentInstance } from './ComponentInstance';
3
4
  import type { InternalSwoopId } from './InternalSwoopId';
@@ -20,4 +21,5 @@ export type DTOItineraryEntity = {
20
21
  componentInstances: Array<ComponentInstance>;
21
22
  quoteOption?: QuoteOptions;
22
23
  isLateBookingConfirmed: boolean;
24
+ adventurePlannerConfig?: AdventurePlannerConfig;
23
25
  };
@@ -1,3 +1,4 @@
1
+ import type { AdventurePlannerConfig } from './AdventurePlannerConfig';
1
2
  import type { Amendment } from './Amendment';
2
3
  import type { ComponentInstance } from './ComponentInstance';
3
4
  import type { InternalSwoopId } from './InternalSwoopId';
@@ -20,4 +21,5 @@ export type DTOItineraryRead = {
20
21
  componentInstances: Array<ComponentInstance>;
21
22
  quoteOption?: QuoteOptions;
22
23
  isLateBookingConfirmed: boolean;
24
+ adventurePlannerConfig?: AdventurePlannerConfig;
23
25
  };
@@ -1,3 +1,4 @@
1
+ import type { AdventurePlannerConfig } from './AdventurePlannerConfig';
1
2
  import type { Amendment } from './Amendment';
2
3
  import type { ComponentInstance } from './ComponentInstance';
3
4
  import type { ItineraryValue } from './ItineraryValue';
@@ -11,4 +12,5 @@ export type DTOItineraryUpdate = {
11
12
  amendments?: Array<Amendment>;
12
13
  quoteOption?: QuoteOptions;
13
14
  isLateBookingConfirmed?: boolean;
15
+ adventurePlannerConfig?: AdventurePlannerConfig;
14
16
  };
@@ -39,6 +39,22 @@ export declare class CoreService {
39
39
  * @throws ApiError
40
40
  */
41
41
  publicSnapshotList(snapshotId: SnapshotId): CancelablePromise<DTOPublicSnapshotRead>;
42
+ /**
43
+ * Fetch adventure planner itinerary data by enquiryId. Returns a stored public snapshot if one is selected, otherwise enriches the latest itinerary live.
44
+ * @param enquiryId The enquiry ID (e.g. PAT-123) to fetch adventure planner data for.
45
+ * @returns DTOPublicSnapshotRead The adventure planner itinerary data
46
+ * @throws ApiError
47
+ */
48
+ adventurePlanner(enquiryId: InternalSwoopId): CancelablePromise<DTOPublicSnapshotRead>;
49
+ /**
50
+ * Fetch enriched itinerary information by snapshotId or enquiryId.
51
+ * @param snapshotId The snapshot ID to look up a stored snapshot (snapshot_* format).
52
+ * @param enquiryId The enquiry ID (e.g. PAT-123) to fetch and enrich the latest itinerary on the fly.
53
+ * @param tag Branch tag for the itinerary lookup. Required when enquiryId is provided.
54
+ * @returns DTOPublicSnapshotRead The publicly available itinerary information
55
+ * @throws ApiError
56
+ */
57
+ enrichedItinerary(snapshotId?: SnapshotId, enquiryId?: InternalSwoopId, tag?: string): CancelablePromise<DTOPublicSnapshotRead>;
42
58
  /**
43
59
  * Create a Snapshot
44
60
  * Creates a new snapshot. A snapshot is a reference to a specific itinerary revision group id.
@@ -34,6 +34,51 @@ export class CoreService {
34
34
  },
35
35
  });
36
36
  }
37
+ /**
38
+ * Fetch adventure planner itinerary data by enquiryId. Returns a stored public snapshot if one is selected, otherwise enriches the latest itinerary live.
39
+ * @param enquiryId The enquiry ID (e.g. PAT-123) to fetch adventure planner data for.
40
+ * @returns DTOPublicSnapshotRead The adventure planner itinerary data
41
+ * @throws ApiError
42
+ */
43
+ adventurePlanner(enquiryId) {
44
+ return __request(OpenAPI, {
45
+ method: 'GET',
46
+ url: '/itinerary/adventure-planner',
47
+ query: {
48
+ 'enquiryId': enquiryId,
49
+ },
50
+ errors: {
51
+ 400: `If required parameters are missing or malformed`,
52
+ 401: `When the client is not authorised`,
53
+ 404: `If the itinerary or snapshot does not exist`,
54
+ 500: `When an unexpected error occurs`,
55
+ },
56
+ });
57
+ }
58
+ /**
59
+ * Fetch enriched itinerary information by snapshotId or enquiryId.
60
+ * @param snapshotId The snapshot ID to look up a stored snapshot (snapshot_* format).
61
+ * @param enquiryId The enquiry ID (e.g. PAT-123) to fetch and enrich the latest itinerary on the fly.
62
+ * @param tag Branch tag for the itinerary lookup. Required when enquiryId is provided.
63
+ * @returns DTOPublicSnapshotRead The publicly available itinerary information
64
+ * @throws ApiError
65
+ */
66
+ enrichedItinerary(snapshotId, enquiryId, tag) {
67
+ return __request(OpenAPI, {
68
+ method: 'GET',
69
+ url: '/itinerary/enriched',
70
+ query: {
71
+ 'snapshotId': snapshotId,
72
+ 'enquiryId': enquiryId,
73
+ 'tag': tag,
74
+ },
75
+ errors: {
76
+ 400: `If the payload is malformed or required parameters are missing`,
77
+ 404: `If the itinerary or public snapshot does not exist`,
78
+ 500: `When an unexpected error occurs`,
79
+ },
80
+ });
81
+ }
37
82
  /**
38
83
  * Create a Snapshot
39
84
  * Creates a new snapshot. A snapshot is a reference to a specific itinerary revision group id.
@@ -3,10 +3,28 @@ 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 { DTOPublicSnapshotRead } from '../models/DTOPublicSnapshotRead';
6
7
  import type { InternalSwoopId } from '../models/InternalSwoopId';
7
8
  import type { ItineraryCreateResponse } from '../models/ItineraryCreateResponse';
9
+ import type { SnapshotId } from '../models/SnapshotId';
8
10
  import type { CancelablePromise } from '../core/CancelablePromise';
9
11
  export declare class ItineraryService {
12
+ /**
13
+ * Fetch adventure planner itinerary data by enquiryId. Returns a stored public snapshot if one is selected, otherwise enriches the latest itinerary live.
14
+ * @param enquiryId The enquiry ID (e.g. PAT-123) to fetch adventure planner data for.
15
+ * @returns DTOPublicSnapshotRead The adventure planner itinerary data
16
+ * @throws ApiError
17
+ */
18
+ static adventurePlanner(enquiryId: InternalSwoopId): CancelablePromise<DTOPublicSnapshotRead>;
19
+ /**
20
+ * Fetch enriched itinerary information by snapshotId or enquiryId.
21
+ * @param snapshotId The snapshot ID to look up a stored snapshot (snapshot_* format).
22
+ * @param enquiryId The enquiry ID (e.g. PAT-123) to fetch and enrich the latest itinerary on the fly.
23
+ * @param tag Branch tag for the itinerary lookup. Required when enquiryId is provided.
24
+ * @returns DTOPublicSnapshotRead The publicly available itinerary information
25
+ * @throws ApiError
26
+ */
27
+ static enrichedItinerary(snapshotId?: SnapshotId, enquiryId?: InternalSwoopId, tag?: string): CancelablePromise<DTOPublicSnapshotRead>;
10
28
  /**
11
29
  * List Tree view of Itineraries
12
30
  * List all itineraries in a tree view for a specific enquiry id
@@ -1,6 +1,51 @@
1
1
  import { OpenAPI } from '../core/OpenAPI';
2
2
  import { request as __request } from '../core/request';
3
3
  export class ItineraryService {
4
+ /**
5
+ * Fetch adventure planner itinerary data by enquiryId. Returns a stored public snapshot if one is selected, otherwise enriches the latest itinerary live.
6
+ * @param enquiryId The enquiry ID (e.g. PAT-123) to fetch adventure planner data for.
7
+ * @returns DTOPublicSnapshotRead The adventure planner itinerary data
8
+ * @throws ApiError
9
+ */
10
+ static adventurePlanner(enquiryId) {
11
+ return __request(OpenAPI, {
12
+ method: 'GET',
13
+ url: '/itinerary/adventure-planner',
14
+ query: {
15
+ 'enquiryId': enquiryId,
16
+ },
17
+ errors: {
18
+ 400: `If required parameters are missing or malformed`,
19
+ 401: `When the client is not authorised`,
20
+ 404: `If the itinerary or snapshot does not exist`,
21
+ 500: `When an unexpected error occurs`,
22
+ },
23
+ });
24
+ }
25
+ /**
26
+ * Fetch enriched itinerary information by snapshotId or enquiryId.
27
+ * @param snapshotId The snapshot ID to look up a stored snapshot (snapshot_* format).
28
+ * @param enquiryId The enquiry ID (e.g. PAT-123) to fetch and enrich the latest itinerary on the fly.
29
+ * @param tag Branch tag for the itinerary lookup. Required when enquiryId is provided.
30
+ * @returns DTOPublicSnapshotRead The publicly available itinerary information
31
+ * @throws ApiError
32
+ */
33
+ static enrichedItinerary(snapshotId, enquiryId, tag) {
34
+ return __request(OpenAPI, {
35
+ method: 'GET',
36
+ url: '/itinerary/enriched',
37
+ query: {
38
+ 'snapshotId': snapshotId,
39
+ 'enquiryId': enquiryId,
40
+ 'tag': tag,
41
+ },
42
+ errors: {
43
+ 400: `If the payload is malformed or required parameters are missing`,
44
+ 404: `If the itinerary or public snapshot does not exist`,
45
+ 500: `When an unexpected error occurs`,
46
+ },
47
+ });
48
+ }
4
49
  /**
5
50
  * List Tree view of Itineraries
6
51
  * List all itineraries in a tree view for a specific enquiry id
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "swoop-common",
3
- "version": "2.2.151",
3
+ "version": "2.2.152",
4
4
  "main": "dist/api/index.js",
5
5
  "types": "dist/api/index.d.ts",
6
6
  "exports": {