swoop-common 2.1.52 → 2.1.53

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.
@@ -1,5 +1,7 @@
1
1
  export type { AddressSwoop } from './index';
2
2
  export type { Address_jsonldSwoop } from './index';
3
+ export type { BookingGroupSwoop } from './index';
4
+ export type { BookingGroup_jsonldSwoop } from './index';
3
5
  export type { BookingItemTypeSwoop } from './index';
4
6
  export type { BookingItemType_jsonldSwoop } from './index';
5
7
  export type { CategorySwoop } from './index';
@@ -22,6 +24,8 @@ export type { CustomerLookupEnquirySwoop } from './index';
22
24
  export type { CustomerLookupEnquiry_jsonldSwoop } from './index';
23
25
  export type { CustomerLookupSalesPersonSwoop } from './index';
24
26
  export type { CustomerLookupSalesPerson_jsonldSwoop } from './index';
27
+ export type { DepartureSwoop } from './index';
28
+ export type { Departure_jsonldSwoop } from './index';
25
29
  export type { EmergencyDetailsSwoop } from './index';
26
30
  export type { EmergencyDetails_jsonldSwoop } from './index';
27
31
  export type { EnquirySwoop } from './index';
@@ -50,3 +54,5 @@ export type { TravellerGroupSwoop } from './index';
50
54
  export type { TravellerGroup_jsonldSwoop } from './index';
51
55
  export type { TripSwoop } from './index';
52
56
  export type { Trip_jsonldSwoop } from './index';
57
+ export type { VesselSwoop } from './index';
58
+ export type { Vessel_jsonldSwoop } from './index';
@@ -4,6 +4,8 @@ export { OpenAPI } from './core/OpenAPI';
4
4
  export type { OpenAPIConfig } from './core/OpenAPI';
5
5
  export type { Address as AddressSwoop } from './models/Address';
6
6
  export type { Address_jsonld as Address_jsonldSwoop } from './models/Address_jsonld';
7
+ export type { BookingGroup as BookingGroupSwoop } from './models/BookingGroup';
8
+ export type { BookingGroup_jsonld as BookingGroup_jsonldSwoop } from './models/BookingGroup_jsonld';
7
9
  export type { BookingItemType as BookingItemTypeSwoop } from './models/BookingItemType';
8
10
  export type { BookingItemType_jsonld as BookingItemType_jsonldSwoop } from './models/BookingItemType_jsonld';
9
11
  export type { Category as CategorySwoop } from './models/Category';
@@ -26,6 +28,8 @@ export type { CustomerLookupEnquiry as CustomerLookupEnquirySwoop } from './mode
26
28
  export type { CustomerLookupEnquiry_jsonld as CustomerLookupEnquiry_jsonldSwoop } from './models/CustomerLookupEnquiry_jsonld';
27
29
  export type { CustomerLookupSalesPerson as CustomerLookupSalesPersonSwoop } from './models/CustomerLookupSalesPerson';
28
30
  export type { CustomerLookupSalesPerson_jsonld as CustomerLookupSalesPerson_jsonldSwoop } from './models/CustomerLookupSalesPerson_jsonld';
31
+ export type { Departure as DepartureSwoop } from './models/Departure';
32
+ export type { Departure_jsonld as Departure_jsonldSwoop } from './models/Departure_jsonld';
29
33
  export type { EmergencyDetails as EmergencyDetailsSwoop } from './models/EmergencyDetails';
30
34
  export type { EmergencyDetails_jsonld as EmergencyDetails_jsonldSwoop } from './models/EmergencyDetails_jsonld';
31
35
  export type { Enquiry as EnquirySwoop } from './models/Enquiry';
@@ -54,4 +58,6 @@ export type { TravellerGroup as TravellerGroupSwoop } from './models/TravellerGr
54
58
  export type { TravellerGroup_jsonld as TravellerGroup_jsonldSwoop } from './models/TravellerGroup_jsonld';
55
59
  export type { Trip as TripSwoop } from './models/Trip';
56
60
  export type { Trip_jsonld as Trip_jsonldSwoop } from './models/Trip_jsonld';
61
+ export type { Vessel as VesselSwoop } from './models/Vessel';
62
+ export type { Vessel_jsonld as Vessel_jsonldSwoop } from './models/Vessel_jsonld';
57
63
  export { SwoopService } from './services/SwoopService';
@@ -0,0 +1,6 @@
1
+ import type { Status } from './Status';
2
+ export type BookingGroup = {
3
+ id?: string;
4
+ name?: string;
5
+ status?: Status;
6
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,9 @@
1
+ import type { Status_jsonld } from './Status_jsonld';
2
+ export type BookingGroup_jsonld = {
3
+ readonly '@context'?: (string | Record<string, any>);
4
+ readonly '@id'?: string;
5
+ readonly '@type'?: string;
6
+ id?: string;
7
+ name?: string;
8
+ status?: Status_jsonld;
9
+ };
@@ -0,0 +1,25 @@
1
+ import type { Status } from './Status';
2
+ import type { Vessel } from './Vessel';
3
+ export type Departure = {
4
+ /**
5
+ * The external ID of the departure, formatted as {region}-{id}, e.g., ANT-12345
6
+ */
7
+ id?: string;
8
+ departureId?: number;
9
+ /**
10
+ * The date of the departure in YYYY-MM-DD format
11
+ */
12
+ date?: string;
13
+ /**
14
+ * The status of the departure
15
+ */
16
+ status?: (Status | null);
17
+ /**
18
+ * The Cabins associated with this departure
19
+ */
20
+ cabins?: Array<string>;
21
+ /**
22
+ * The Vessel associated with this departure
23
+ */
24
+ vessel?: (Vessel | null);
25
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,27 @@
1
+ import type { Status_jsonld } from './Status_jsonld';
2
+ import type { Vessel_jsonld } from './Vessel_jsonld';
3
+ export type Departure_jsonld = {
4
+ readonly '@id'?: string;
5
+ readonly '@type'?: string;
6
+ /**
7
+ * The external ID of the departure, formatted as {region}-{id}, e.g., ANT-12345
8
+ */
9
+ id?: string;
10
+ departureId?: number;
11
+ /**
12
+ * The date of the departure in YYYY-MM-DD format
13
+ */
14
+ date?: string;
15
+ /**
16
+ * The status of the departure
17
+ */
18
+ status?: (Status_jsonld | null);
19
+ /**
20
+ * The Cabins associated with this departure
21
+ */
22
+ cabins?: Array<string>;
23
+ /**
24
+ * The Vessel associated with this departure
25
+ */
26
+ vessel?: (Vessel_jsonld | null);
27
+ };
@@ -1,3 +1,4 @@
1
+ import type { BookingGroup } from './BookingGroup';
1
2
  import type { Customer } from './Customer';
2
3
  import type { EnquiryPerson } from './EnquiryPerson';
3
4
  import type { EnquiryStatus } from './EnquiryStatus';
@@ -8,4 +9,5 @@ export type Enquiry = {
8
9
  cxPerson?: (EnquiryPerson | null);
9
10
  enquiryStatus?: (EnquiryStatus | null);
10
11
  customer?: (Customer | null);
12
+ bookingGroups?: Array<BookingGroup>;
11
13
  };
@@ -1,3 +1,4 @@
1
+ import type { BookingGroup_jsonld } from './BookingGroup_jsonld';
1
2
  import type { Customer_jsonld } from './Customer_jsonld';
2
3
  import type { EnquiryPerson_jsonld } from './EnquiryPerson_jsonld';
3
4
  import type { EnquiryStatus_jsonld } from './EnquiryStatus_jsonld';
@@ -11,4 +12,5 @@ export type Enquiry_jsonld = {
11
12
  cxPerson?: (EnquiryPerson_jsonld | null);
12
13
  enquiryStatus?: (EnquiryStatus_jsonld | null);
13
14
  customer?: (Customer_jsonld | null);
15
+ bookingGroups?: Array<BookingGroup_jsonld>;
14
16
  };
@@ -1,3 +1,4 @@
1
+ import type { Customer } from './Customer';
1
2
  import type { PaymentType } from './PaymentType';
2
3
  import type { Status } from './Status';
3
4
  export type Payment = {
@@ -13,8 +14,8 @@ export type Payment = {
13
14
  transactionFee?: number | null;
14
15
  feePercent?: number | null;
15
16
  expiryDate?: string;
16
- url?: string;
17
+ paymentLink?: string;
17
18
  status?: (Status | null);
18
19
  paymentType?: (PaymentType | null);
19
- lead?: string | null;
20
+ lead?: (Customer | null);
20
21
  };
@@ -1,3 +1,4 @@
1
+ import type { Customer_jsonld } from './Customer_jsonld';
1
2
  import type { PaymentType_jsonld } from './PaymentType_jsonld';
2
3
  import type { Status_jsonld } from './Status_jsonld';
3
4
  export type Payment_jsonld = {
@@ -15,8 +16,8 @@ export type Payment_jsonld = {
15
16
  transactionFee?: number | null;
16
17
  feePercent?: number | null;
17
18
  expiryDate?: string;
18
- url?: string;
19
+ paymentLink?: string;
19
20
  status?: (Status_jsonld | null);
20
21
  paymentType?: (PaymentType_jsonld | null);
21
- lead?: string | null;
22
+ lead?: (Customer_jsonld | null);
22
23
  };
@@ -5,4 +5,5 @@ export type Trip = {
5
5
  title?: string;
6
6
  alias?: string | null;
7
7
  publishState?: (PublishState | null);
8
+ partner?: string | null;
8
9
  };
@@ -8,4 +8,5 @@ export type Trip_jsonld = {
8
8
  title?: string;
9
9
  alias?: string | null;
10
10
  publishState?: (PublishState_jsonld | null);
11
+ partner?: string | null;
11
12
  };
@@ -0,0 +1,5 @@
1
+ export type Vessel = {
2
+ id?: string;
3
+ title?: string | null;
4
+ alias?: string | null;
5
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,8 @@
1
+ export type Vessel_jsonld = {
2
+ readonly '@context'?: (string | Record<string, any>);
3
+ readonly '@id'?: string;
4
+ readonly '@type'?: string;
5
+ id?: string;
6
+ title?: string | null;
7
+ alias?: string | null;
8
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -5,6 +5,7 @@ import type { CurrencyConversion } from '../models/CurrencyConversion';
5
5
  import type { CurrencyConversionBatch } from '../models/CurrencyConversionBatch';
6
6
  import type { Customer } from '../models/Customer';
7
7
  import type { CustomerLookup } from '../models/CustomerLookup';
8
+ import type { Departure } from '../models/Departure';
8
9
  import type { Enquiry } from '../models/Enquiry';
9
10
  import type { EnquiryStatus } from '../models/EnquiryStatus';
10
11
  import type { Partner } from '../models/Partner';
@@ -105,6 +106,16 @@ export declare class SwoopService {
105
106
  * @throws ApiError
106
107
  */
107
108
  customersLookUpGet(telephone?: string, region?: string): CancelablePromise<CustomerLookup>;
109
+ /**
110
+ * Retrieves the collection of Departure resources.
111
+ * Retrieves the collection of Departure resources.
112
+ * @param page The collection page number
113
+ * @param itemsPerPage The number of items per page
114
+ * @param tripId Trip ID: ANT-5
115
+ * @returns Departure Departure collection
116
+ * @throws ApiError
117
+ */
118
+ departuresGetCollection(page?: number, itemsPerPage?: number, tripId?: string): CancelablePromise<Array<Departure>>;
108
119
  /**
109
120
  * Retrieves a Enquiry resource.
110
121
  * Retrieves a Enquiry resource.
@@ -144,11 +155,13 @@ export declare class SwoopService {
144
155
  /**
145
156
  * Retrieves the collection of Payment resources.
146
157
  * Retrieves the collection of Payment resources.
147
- * @param enquiryId by enquiry ID
158
+ * @param enquiryId The unique identifier example: ANT-12345 ({REGION}-{enquiry_id}})
159
+ * @param status Optional: payment status filter. Supports comma-separated values for multiple statuses (e.g. pending,completed)
160
+ * @param withDeleted Optional: Include deleted records (1 = include, 0 = exclude)
148
161
  * @returns Payment Payment collection
149
162
  * @throws ApiError
150
163
  */
151
- paymentsGetCollection(enquiryId?: string): CancelablePromise<Array<Payment>>;
164
+ paymentsGetCollection(enquiryId?: string, status?: string, withDeleted?: string): CancelablePromise<Array<Payment>>;
152
165
  /**
153
166
  * Retrieves the collection of Person resources.
154
167
  * Retrieves the collection of Person resources.
@@ -159,6 +159,26 @@ export class SwoopService {
159
159
  },
160
160
  });
161
161
  }
162
+ /**
163
+ * Retrieves the collection of Departure resources.
164
+ * Retrieves the collection of Departure resources.
165
+ * @param page The collection page number
166
+ * @param itemsPerPage The number of items per page
167
+ * @param tripId Trip ID: ANT-5
168
+ * @returns Departure Departure collection
169
+ * @throws ApiError
170
+ */
171
+ departuresGetCollection(page = 1, itemsPerPage = 30, tripId) {
172
+ return __request(OpenAPI, {
173
+ method: 'GET',
174
+ url: '/api/departures',
175
+ query: {
176
+ 'page': page,
177
+ 'itemsPerPage': itemsPerPage,
178
+ 'tripId': tripId,
179
+ },
180
+ });
181
+ }
162
182
  /**
163
183
  * Retrieves a Enquiry resource.
164
184
  * Retrieves a Enquiry resource.
@@ -240,16 +260,20 @@ export class SwoopService {
240
260
  /**
241
261
  * Retrieves the collection of Payment resources.
242
262
  * Retrieves the collection of Payment resources.
243
- * @param enquiryId by enquiry ID
263
+ * @param enquiryId The unique identifier example: ANT-12345 ({REGION}-{enquiry_id}})
264
+ * @param status Optional: payment status filter. Supports comma-separated values for multiple statuses (e.g. pending,completed)
265
+ * @param withDeleted Optional: Include deleted records (1 = include, 0 = exclude)
244
266
  * @returns Payment Payment collection
245
267
  * @throws ApiError
246
268
  */
247
- paymentsGetCollection(enquiryId) {
269
+ paymentsGetCollection(enquiryId, status, withDeleted) {
248
270
  return __request(OpenAPI, {
249
271
  method: 'GET',
250
272
  url: '/api/payments',
251
273
  query: {
252
274
  'enquiry_id': enquiryId,
275
+ 'status': status,
276
+ 'with_deleted': withDeleted,
253
277
  },
254
278
  });
255
279
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "swoop-common",
3
- "version": "2.1.52",
3
+ "version": "2.1.53",
4
4
  "main": "dist/api/index.js",
5
5
  "types": "dist/api/index.d.ts",
6
6
  "exports": {