@duffel/api 2.5.3 → 2.5.4
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.
- package/dist/DuffelPayments/PaymentIntents/PaymentIntents.d.ts +28 -28
- package/dist/DuffelPayments/PaymentIntents/PaymentIntents.spec.d.ts +1 -1
- package/dist/DuffelPayments/PaymentIntents/PaymentIntentsType.d.ts +112 -112
- package/dist/DuffelPayments/PaymentIntents/index.d.ts +1 -1
- package/dist/DuffelPayments/Refunds/Refunds.d.ts +21 -21
- package/dist/DuffelPayments/Refunds/Refunds.spec.d.ts +1 -1
- package/dist/DuffelPayments/Refunds/RefundsType.d.ts +70 -70
- package/dist/DuffelPayments/Refunds/index.d.ts +1 -1
- package/dist/DuffelPayments/index.d.ts +1 -1
- package/dist/Links/Sessions/Sessions.d.ts +63 -63
- package/dist/Links/Sessions/Sessions.spec.d.ts +1 -1
- package/dist/Links/Sessions/index.d.ts +1 -1
- package/dist/Links/index.d.ts +1 -1
- package/dist/Places/Suggestions/Suggestions.d.ts +42 -42
- package/dist/Places/Suggestions/Suggestions.spec.d.ts +1 -1
- package/dist/Places/Suggestions/SuggestionsType.d.ts +59 -59
- package/dist/Places/Suggestions/index.d.ts +1 -1
- package/dist/Places/index.d.ts +1 -1
- package/dist/Stays/Bookings/Bookings.d.ts +41 -41
- package/dist/Stays/Bookings/Bookings.spec.d.ts +1 -1
- package/dist/Stays/Bookings/index.d.ts +1 -1
- package/dist/Stays/Quotes/Quotes.d.ts +16 -16
- package/dist/Stays/Quotes/Quotes.spec.d.ts +1 -1
- package/dist/Stays/Quotes/index.d.ts +1 -1
- package/dist/Stays/SearchResults/SearchResults.d.ts +16 -16
- package/dist/Stays/SearchResults/SearchResults.spec.d.ts +1 -1
- package/dist/Stays/SearchResults/index.d.ts +1 -1
- package/dist/Stays/Stays.d.ts +22 -22
- package/dist/Stays/Stays.spec.d.ts +1 -1
- package/dist/Stays/StaysTypes.d.ts +454 -454
- package/dist/booking/AirlineInitiatedChanges/AirlineInitiatedChanges.d.ts +63 -63
- package/dist/booking/AirlineInitiatedChanges/AirlineInitiatedChanges.spec.d.ts +1 -1
- package/dist/booking/AirlineInitiatedChanges/AirlineInitiatedChangesTypes.d.ts +57 -57
- package/dist/booking/AirlineInitiatedChanges/index.d.ts +1 -1
- package/dist/booking/OfferRequests/OfferRequests.d.ts +46 -46
- package/dist/booking/OfferRequests/OfferRequests.spec.d.ts +1 -1
- package/dist/booking/OfferRequests/OfferRequestsTypes.d.ts +240 -240
- package/dist/booking/OfferRequests/index.d.ts +1 -1
- package/dist/booking/Offers/OfferTypes.d.ts +495 -495
- package/dist/booking/Offers/Offers.d.ts +53 -53
- package/dist/booking/Offers/Offers.spec.d.ts +1 -1
- package/dist/booking/Offers/index.d.ts +1 -1
- package/dist/booking/OrderCancellations/OrderCancellations.d.ts +41 -41
- package/dist/booking/OrderCancellations/OrderCancellations.spec.d.ts +1 -1
- package/dist/booking/OrderCancellations/OrderCancellationsTypes.d.ts +53 -53
- package/dist/booking/OrderCancellations/index.d.ts +1 -1
- package/dist/booking/OrderChangeOffers/OrderChangeOfferTypes.d.ts +113 -113
- package/dist/booking/OrderChangeOffers/OrderChangeOffers.d.ts +31 -31
- package/dist/booking/OrderChangeOffers/OrderChangeOffers.spec.d.ts +1 -1
- package/dist/booking/OrderChangeOffers/index.d.ts +1 -1
- package/dist/booking/OrderChangeRequests/OrderChangeRequests.d.ts +29 -29
- package/dist/booking/OrderChangeRequests/OrderChangeRequestsTypes.d.ts +141 -141
- package/dist/booking/OrderChangeRequests/OrderRequestChanges.spec.d.ts +1 -1
- package/dist/booking/OrderChangeRequests/index.d.ts +1 -1
- package/dist/booking/OrderChanges/OrderChanges.d.ts +31 -31
- package/dist/booking/OrderChanges/OrderChanges.spec.d.ts +1 -1
- package/dist/booking/OrderChanges/OrderChangesTypes.d.ts +102 -102
- package/dist/booking/OrderChanges/index.d.ts +1 -1
- package/dist/booking/Orders/Orders.d.ts +52 -52
- package/dist/booking/Orders/Orders.spec.d.ts +1 -1
- package/dist/booking/Orders/OrdersTypes.d.ts +500 -500
- package/dist/booking/Orders/index.d.ts +1 -1
- package/dist/booking/PartialOfferRequests/PartialOfferRequestTypes.d.ts +6 -6
- package/dist/booking/PartialOfferRequests/PartialOfferRequests.d.ts +40 -40
- package/dist/booking/PartialOfferRequests/PartialOfferRequests.spec.d.ts +1 -1
- package/dist/booking/PartialOfferRequests/index.d.ts +1 -1
- package/dist/booking/Payments/Payments.d.ts +16 -16
- package/dist/booking/Payments/Payments.spec.d.ts +1 -1
- package/dist/booking/Payments/PaymentsTypes.d.ts +43 -43
- package/dist/booking/Payments/index.d.ts +1 -1
- package/dist/booking/SeatMaps/SeatMapTypes.d.ts +190 -190
- package/dist/booking/SeatMaps/SeatMaps.d.ts +17 -17
- package/dist/booking/SeatMaps/SeatMaps.spec.d.ts +1 -1
- package/dist/booking/SeatMaps/index.d.ts +1 -1
- package/dist/booking/index.d.ts +11 -11
- package/dist/index.es.js +1 -1
- package/dist/index.js +1 -1
- package/dist/notifications/Webhooks/Webhooks.d.ts +51 -51
- package/dist/notifications/Webhooks/Webhooks.spec.d.ts +1 -1
- package/dist/notifications/Webhooks/WebhooksType.d.ts +113 -113
- package/dist/notifications/Webhooks/index.d.ts +1 -1
- package/dist/notifications/index.d.ts +1 -1
- package/dist/supportingResources/Aircraft/Aircraft.d.ts +30 -30
- package/dist/supportingResources/Aircraft/Aircraft.spec.d.ts +1 -1
- package/dist/supportingResources/Aircraft/AircraftTypes.d.ts +18 -18
- package/dist/supportingResources/Aircraft/index.d.ts +1 -1
- package/dist/supportingResources/Airlines/Airlines.d.ts +29 -29
- package/dist/supportingResources/Airlines/Airlines.spec.d.ts +1 -1
- package/dist/supportingResources/Airlines/AirlinesTypes.d.ts +17 -17
- package/dist/supportingResources/Airlines/index.d.ts +2 -2
- package/dist/supportingResources/Airports/Airports.d.ts +30 -30
- package/dist/supportingResources/Airports/Airports.spec.d.ts +1 -1
- package/dist/supportingResources/Airports/AirportsTypes.d.ts +55 -55
- package/dist/supportingResources/Airports/index.d.ts +2 -2
- package/dist/supportingResources/index.d.ts +3 -3
- package/package.json +15 -15
|
@@ -1,63 +1,63 @@
|
|
|
1
|
-
import { Client } from '../../Client';
|
|
2
|
-
import { Resource } from '../../Resource';
|
|
3
|
-
import { DuffelResponse, Order } from '../../types';
|
|
4
|
-
import { AirlineInitiatedChange, AirlineInitiatedChangeActionTaken } from './AirlineInitiatedChangesTypes';
|
|
5
|
-
/**
|
|
6
|
-
* Sometimes there can be changes to your order initiated by the airline, for
|
|
7
|
-
* example a flight being delayed. We record every one of these changes so that
|
|
8
|
-
* you can view them all or for an order. You can filter changes for a specific
|
|
9
|
-
* order using the `order_id` parameter.
|
|
10
|
-
*
|
|
11
|
-
* Each airline-initiated change contains an `added` and `removed` field. `added`
|
|
12
|
-
* contains the updated slices following the change. These slices and their
|
|
13
|
-
* segments may have a new ID based on the change. `removed` contains a list of
|
|
14
|
-
* slices and their segments as they were before the change.
|
|
15
|
-
*/
|
|
16
|
-
export declare class AirlineInitiatedChanges extends Resource {
|
|
17
|
-
/**
|
|
18
|
-
* Endpoint path
|
|
19
|
-
*/
|
|
20
|
-
path: string;
|
|
21
|
-
constructor(client: Client);
|
|
22
|
-
/**
|
|
23
|
-
* This endpoint is only available to those airline-initiated changes that
|
|
24
|
-
* Duffel cannot accept on behalf of the customer. Duffel is unable to accept
|
|
25
|
-
* an airline-initiated change when these two conditions are true: the order
|
|
26
|
-
* was booked with the merchant's IATA number and Duffel is unable to accept
|
|
27
|
-
* the airline-initiated change programatically. In this case you, the
|
|
28
|
-
* customer, are responsible to resolve airline-initiated changes concerning
|
|
29
|
-
* this order (e.g. by contacting the airline directly). Once these have been
|
|
30
|
-
* resolved, you need to inform us of the action taken so we can mark it
|
|
31
|
-
* accordingly in our system.
|
|
32
|
-
*
|
|
33
|
-
* @param {AirlineInitiatedChange['id']} id - Duffel's unique identifier for
|
|
34
|
-
* the airline-initiated change
|
|
35
|
-
*
|
|
36
|
-
* @param action_taken - The action taken in response to this
|
|
37
|
-
* airline-initiated change. Accepted, cancelled and changed reflect your
|
|
38
|
-
* action in accepting the change, cancelling the order or changing the order
|
|
39
|
-
* respectively.
|
|
40
|
-
*
|
|
41
|
-
* @link https://duffel.com/docs/api/v1/airline-initiated-changes/update-airline-initiated-changes
|
|
42
|
-
*/
|
|
43
|
-
update: (id: AirlineInitiatedChange['id'], action_taken: AirlineInitiatedChangeActionTaken) => Promise<DuffelResponse<AirlineInitiatedChange>>;
|
|
44
|
-
/**
|
|
45
|
-
* Once there is an airline-initiated change you can choose to accept it.
|
|
46
|
-
*
|
|
47
|
-
* @param {AirlineInitiatedChange['id']} id - Duffel's unique identifier for
|
|
48
|
-
* the airline-initiated change
|
|
49
|
-
*
|
|
50
|
-
* @link https://duffel.com/docs/api/v1/airline-initiated-changes/accept-airline-initiated-changes
|
|
51
|
-
*/
|
|
52
|
-
accept: (id: AirlineInitiatedChange['id']) => Promise<DuffelResponse<AirlineInitiatedChange>>;
|
|
53
|
-
/**
|
|
54
|
-
* Retrieves a list of all airline-initiated changes.
|
|
55
|
-
*
|
|
56
|
-
* @param order_id - Filters airline-initiated changes by their order ID.
|
|
57
|
-
* Value must be a valid order ID. Check the [Order schema](https://duffel.com/docs/api/orders/schema#orders-schema-id)
|
|
58
|
-
* for details.
|
|
59
|
-
*
|
|
60
|
-
* @link https://duffel.com/docs/api/v1/airline-initiated-changes/get-airline-initiated-changes
|
|
61
|
-
*/
|
|
62
|
-
list: (order_id: Order['id']) => Promise<DuffelResponse<Order['airline_initiated_changes']>>;
|
|
63
|
-
}
|
|
1
|
+
import { Client } from '../../Client';
|
|
2
|
+
import { Resource } from '../../Resource';
|
|
3
|
+
import { DuffelResponse, Order } from '../../types';
|
|
4
|
+
import { AirlineInitiatedChange, AirlineInitiatedChangeActionTaken } from './AirlineInitiatedChangesTypes';
|
|
5
|
+
/**
|
|
6
|
+
* Sometimes there can be changes to your order initiated by the airline, for
|
|
7
|
+
* example a flight being delayed. We record every one of these changes so that
|
|
8
|
+
* you can view them all or for an order. You can filter changes for a specific
|
|
9
|
+
* order using the `order_id` parameter.
|
|
10
|
+
*
|
|
11
|
+
* Each airline-initiated change contains an `added` and `removed` field. `added`
|
|
12
|
+
* contains the updated slices following the change. These slices and their
|
|
13
|
+
* segments may have a new ID based on the change. `removed` contains a list of
|
|
14
|
+
* slices and their segments as they were before the change.
|
|
15
|
+
*/
|
|
16
|
+
export declare class AirlineInitiatedChanges extends Resource {
|
|
17
|
+
/**
|
|
18
|
+
* Endpoint path
|
|
19
|
+
*/
|
|
20
|
+
path: string;
|
|
21
|
+
constructor(client: Client);
|
|
22
|
+
/**
|
|
23
|
+
* This endpoint is only available to those airline-initiated changes that
|
|
24
|
+
* Duffel cannot accept on behalf of the customer. Duffel is unable to accept
|
|
25
|
+
* an airline-initiated change when these two conditions are true: the order
|
|
26
|
+
* was booked with the merchant's IATA number and Duffel is unable to accept
|
|
27
|
+
* the airline-initiated change programatically. In this case you, the
|
|
28
|
+
* customer, are responsible to resolve airline-initiated changes concerning
|
|
29
|
+
* this order (e.g. by contacting the airline directly). Once these have been
|
|
30
|
+
* resolved, you need to inform us of the action taken so we can mark it
|
|
31
|
+
* accordingly in our system.
|
|
32
|
+
*
|
|
33
|
+
* @param {AirlineInitiatedChange['id']} id - Duffel's unique identifier for
|
|
34
|
+
* the airline-initiated change
|
|
35
|
+
*
|
|
36
|
+
* @param action_taken - The action taken in response to this
|
|
37
|
+
* airline-initiated change. Accepted, cancelled and changed reflect your
|
|
38
|
+
* action in accepting the change, cancelling the order or changing the order
|
|
39
|
+
* respectively.
|
|
40
|
+
*
|
|
41
|
+
* @link https://duffel.com/docs/api/v1/airline-initiated-changes/update-airline-initiated-changes
|
|
42
|
+
*/
|
|
43
|
+
update: (id: AirlineInitiatedChange['id'], action_taken: AirlineInitiatedChangeActionTaken) => Promise<DuffelResponse<AirlineInitiatedChange>>;
|
|
44
|
+
/**
|
|
45
|
+
* Once there is an airline-initiated change you can choose to accept it.
|
|
46
|
+
*
|
|
47
|
+
* @param {AirlineInitiatedChange['id']} id - Duffel's unique identifier for
|
|
48
|
+
* the airline-initiated change
|
|
49
|
+
*
|
|
50
|
+
* @link https://duffel.com/docs/api/v1/airline-initiated-changes/accept-airline-initiated-changes
|
|
51
|
+
*/
|
|
52
|
+
accept: (id: AirlineInitiatedChange['id']) => Promise<DuffelResponse<AirlineInitiatedChange>>;
|
|
53
|
+
/**
|
|
54
|
+
* Retrieves a list of all airline-initiated changes.
|
|
55
|
+
*
|
|
56
|
+
* @param order_id - Filters airline-initiated changes by their order ID.
|
|
57
|
+
* Value must be a valid order ID. Check the [Order schema](https://duffel.com/docs/api/orders/schema#orders-schema-id)
|
|
58
|
+
* for details.
|
|
59
|
+
*
|
|
60
|
+
* @link https://duffel.com/docs/api/v1/airline-initiated-changes/get-airline-initiated-changes
|
|
61
|
+
*/
|
|
62
|
+
list: (order_id: Order['id']) => Promise<DuffelResponse<Order['airline_initiated_changes']>>;
|
|
63
|
+
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export {};
|
|
1
|
+
export {};
|
|
@@ -1,57 +1,57 @@
|
|
|
1
|
-
import { OrderSlice } from 'types';
|
|
2
|
-
export type AirlineInitiatedChangeActionTaken = 'accepted' | 'cancelled' | 'changed';
|
|
3
|
-
export type AirlineInitiatedChangeAvailableAction = 'accept' | 'cancel' | 'change' | 'update';
|
|
4
|
-
export interface AirlineInitiatedChange {
|
|
5
|
-
/**
|
|
6
|
-
* The action taken in response to this airline-initiated change. Accepted,
|
|
7
|
-
* cancelled and changed reflect your action in accepting the change,
|
|
8
|
-
* cancelling the order or changing the order respectively.
|
|
9
|
-
*/
|
|
10
|
-
action_taken: AirlineInitiatedChangeActionTaken | null;
|
|
11
|
-
/**
|
|
12
|
-
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which an
|
|
13
|
-
* action was taken.
|
|
14
|
-
*/
|
|
15
|
-
action_taken_at: string | null;
|
|
16
|
-
/**
|
|
17
|
-
* List of updated (slices and segments)[https://duffel.com/docs/api/orders/schema#orders-schema-slices]
|
|
18
|
-
* following the change. These slices and segments may each have a new ID as a
|
|
19
|
-
* result of the changes.
|
|
20
|
-
*/
|
|
21
|
-
added: OrderSlice[];
|
|
22
|
-
/**
|
|
23
|
-
* The available actions you can take on this Airline-Initiated Change through
|
|
24
|
-
* our API.`"update"` means that you can use the update endpoint for an
|
|
25
|
-
* Airline-Initiated Change.
|
|
26
|
-
*/
|
|
27
|
-
available_actions: AirlineInitiatedChangeAvailableAction[];
|
|
28
|
-
/**
|
|
29
|
-
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which we
|
|
30
|
-
* detected the airline-initiated change.
|
|
31
|
-
*/
|
|
32
|
-
created_at: string;
|
|
33
|
-
/**
|
|
34
|
-
* Duffel's unique identifier for the airline-initiated change.
|
|
35
|
-
*/
|
|
36
|
-
id: string;
|
|
37
|
-
/**
|
|
38
|
-
* Duffel's unique identifier for the order.
|
|
39
|
-
*/
|
|
40
|
-
order_id: string;
|
|
41
|
-
/**
|
|
42
|
-
* List of (slices and segments)[https://duffel.com/docs/api/orders/schema#orders-schema-slices]
|
|
43
|
-
* as they were before the change.
|
|
44
|
-
*/
|
|
45
|
-
removed: OrderSlice[];
|
|
46
|
-
/**
|
|
47
|
-
* The associated Travel Agent Ticket, if any, for this Airline-Initiated
|
|
48
|
-
* Change. This value will be present for Airline-Initiated changes that take
|
|
49
|
-
* some time to be processed.
|
|
50
|
-
*/
|
|
51
|
-
travel_agent_ticket: any | null;
|
|
52
|
-
/**
|
|
53
|
-
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which
|
|
54
|
-
* the airline-initiated change was last updated.
|
|
55
|
-
*/
|
|
56
|
-
updated_at: string;
|
|
57
|
-
}
|
|
1
|
+
import { OrderSlice } from 'types';
|
|
2
|
+
export type AirlineInitiatedChangeActionTaken = 'accepted' | 'cancelled' | 'changed';
|
|
3
|
+
export type AirlineInitiatedChangeAvailableAction = 'accept' | 'cancel' | 'change' | 'update';
|
|
4
|
+
export interface AirlineInitiatedChange {
|
|
5
|
+
/**
|
|
6
|
+
* The action taken in response to this airline-initiated change. Accepted,
|
|
7
|
+
* cancelled and changed reflect your action in accepting the change,
|
|
8
|
+
* cancelling the order or changing the order respectively.
|
|
9
|
+
*/
|
|
10
|
+
action_taken: AirlineInitiatedChangeActionTaken | null;
|
|
11
|
+
/**
|
|
12
|
+
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which an
|
|
13
|
+
* action was taken.
|
|
14
|
+
*/
|
|
15
|
+
action_taken_at: string | null;
|
|
16
|
+
/**
|
|
17
|
+
* List of updated (slices and segments)[https://duffel.com/docs/api/orders/schema#orders-schema-slices]
|
|
18
|
+
* following the change. These slices and segments may each have a new ID as a
|
|
19
|
+
* result of the changes.
|
|
20
|
+
*/
|
|
21
|
+
added: OrderSlice[];
|
|
22
|
+
/**
|
|
23
|
+
* The available actions you can take on this Airline-Initiated Change through
|
|
24
|
+
* our API.`"update"` means that you can use the update endpoint for an
|
|
25
|
+
* Airline-Initiated Change.
|
|
26
|
+
*/
|
|
27
|
+
available_actions: AirlineInitiatedChangeAvailableAction[];
|
|
28
|
+
/**
|
|
29
|
+
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which we
|
|
30
|
+
* detected the airline-initiated change.
|
|
31
|
+
*/
|
|
32
|
+
created_at: string;
|
|
33
|
+
/**
|
|
34
|
+
* Duffel's unique identifier for the airline-initiated change.
|
|
35
|
+
*/
|
|
36
|
+
id: string;
|
|
37
|
+
/**
|
|
38
|
+
* Duffel's unique identifier for the order.
|
|
39
|
+
*/
|
|
40
|
+
order_id: string;
|
|
41
|
+
/**
|
|
42
|
+
* List of (slices and segments)[https://duffel.com/docs/api/orders/schema#orders-schema-slices]
|
|
43
|
+
* as they were before the change.
|
|
44
|
+
*/
|
|
45
|
+
removed: OrderSlice[];
|
|
46
|
+
/**
|
|
47
|
+
* The associated Travel Agent Ticket, if any, for this Airline-Initiated
|
|
48
|
+
* Change. This value will be present for Airline-Initiated changes that take
|
|
49
|
+
* some time to be processed.
|
|
50
|
+
*/
|
|
51
|
+
travel_agent_ticket: any | null;
|
|
52
|
+
/**
|
|
53
|
+
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which
|
|
54
|
+
* the airline-initiated change was last updated.
|
|
55
|
+
*/
|
|
56
|
+
updated_at: string;
|
|
57
|
+
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export * from './AirlineInitiatedChanges';
|
|
1
|
+
export * from './AirlineInitiatedChanges';
|
|
@@ -1,46 +1,46 @@
|
|
|
1
|
-
import { Client } from '../../Client';
|
|
2
|
-
import { Resource } from '../../Resource';
|
|
3
|
-
import { CreateOfferRequest, CreateOfferRequestQueryParameters, DuffelResponse, OfferRequest, PaginationMeta } from '../../types';
|
|
4
|
-
/**
|
|
5
|
-
* To search for flights, you'll need to create an `offer request`.
|
|
6
|
-
* An offer request describes the passengers and where and when they want to travel (in the form of a list of `slices`).
|
|
7
|
-
* It may also include additional filters (e.g. a particular cabin to travel in).
|
|
8
|
-
* @class
|
|
9
|
-
* @link https://duffel.com/docs/api/offer-requests
|
|
10
|
-
*/
|
|
11
|
-
export declare class OfferRequests extends Resource {
|
|
12
|
-
/**
|
|
13
|
-
* Endpoint path
|
|
14
|
-
*/
|
|
15
|
-
path: string;
|
|
16
|
-
constructor(client: Client);
|
|
17
|
-
/**
|
|
18
|
-
* Retrieves an offer request by its ID
|
|
19
|
-
* @param {string} id - Duffel's unique identifier for the offer request
|
|
20
|
-
* @link https:/duffel.com/docs/api/offer-requests/get-offer-request-by-id
|
|
21
|
-
*/
|
|
22
|
-
get: (id: string) => Promise<DuffelResponse<OfferRequest>>;
|
|
23
|
-
/**
|
|
24
|
-
* Retrieves a page of offer requests. The results may be returned in any order.
|
|
25
|
-
* @param {Object} [options] - Pagination options (optional: limit, after, before)
|
|
26
|
-
* @link https://duffel.com/docs/api/offer-requests/get-offer-requests
|
|
27
|
-
*/
|
|
28
|
-
list: (options?: PaginationMeta) => Promise<DuffelResponse<OfferRequest[]>>;
|
|
29
|
-
/**
|
|
30
|
-
* Retrieves a generator of all offer requests. The results may be returned in any order.
|
|
31
|
-
* @link https://duffel.com/docs/api/offer-requests/get-offer-requests
|
|
32
|
-
*/
|
|
33
|
-
listWithGenerator: () => AsyncGenerator<DuffelResponse<OfferRequest>, void, unknown>;
|
|
34
|
-
/**
|
|
35
|
-
* To search for flights, you'll need to create an `offer request`.
|
|
36
|
-
* An offer request describes the passengers and where and when they want to travel (in the form of a list of `slices`).
|
|
37
|
-
* It may also include additional filters (e.g. a particular cabin to travel in).
|
|
38
|
-
* @param {Object} [options] - the parameters for making an offer requests (required: slices, passengers; optional: cabin_class, return_offers)
|
|
39
|
-
* When `return_offers` is set to `true`, the offer request resource returned will include all the `offers` returned by the airlines.
|
|
40
|
-
* If set to false, the offer request resource won't include any `offers`. To retrieve the associated offers later, use the List Offers endpoint, specifying the `offer_request_id`.
|
|
41
|
-
* @link https://duffel.com/docs/api/offer-requests/create-offer-request
|
|
42
|
-
*/
|
|
43
|
-
create: <QueryParams extends CreateOfferRequestQueryParameters>(options: CreateOfferRequest & QueryParams) => Promise<DuffelResponse<QueryParams extends {
|
|
44
|
-
return_offers: false;
|
|
45
|
-
} ? Omit<OfferRequest, "offers"> : OfferRequest>>;
|
|
46
|
-
}
|
|
1
|
+
import { Client } from '../../Client';
|
|
2
|
+
import { Resource } from '../../Resource';
|
|
3
|
+
import { CreateOfferRequest, CreateOfferRequestQueryParameters, DuffelResponse, OfferRequest, PaginationMeta } from '../../types';
|
|
4
|
+
/**
|
|
5
|
+
* To search for flights, you'll need to create an `offer request`.
|
|
6
|
+
* An offer request describes the passengers and where and when they want to travel (in the form of a list of `slices`).
|
|
7
|
+
* It may also include additional filters (e.g. a particular cabin to travel in).
|
|
8
|
+
* @class
|
|
9
|
+
* @link https://duffel.com/docs/api/offer-requests
|
|
10
|
+
*/
|
|
11
|
+
export declare class OfferRequests extends Resource {
|
|
12
|
+
/**
|
|
13
|
+
* Endpoint path
|
|
14
|
+
*/
|
|
15
|
+
path: string;
|
|
16
|
+
constructor(client: Client);
|
|
17
|
+
/**
|
|
18
|
+
* Retrieves an offer request by its ID
|
|
19
|
+
* @param {string} id - Duffel's unique identifier for the offer request
|
|
20
|
+
* @link https:/duffel.com/docs/api/offer-requests/get-offer-request-by-id
|
|
21
|
+
*/
|
|
22
|
+
get: (id: string) => Promise<DuffelResponse<OfferRequest>>;
|
|
23
|
+
/**
|
|
24
|
+
* Retrieves a page of offer requests. The results may be returned in any order.
|
|
25
|
+
* @param {Object} [options] - Pagination options (optional: limit, after, before)
|
|
26
|
+
* @link https://duffel.com/docs/api/offer-requests/get-offer-requests
|
|
27
|
+
*/
|
|
28
|
+
list: (options?: PaginationMeta) => Promise<DuffelResponse<OfferRequest[]>>;
|
|
29
|
+
/**
|
|
30
|
+
* Retrieves a generator of all offer requests. The results may be returned in any order.
|
|
31
|
+
* @link https://duffel.com/docs/api/offer-requests/get-offer-requests
|
|
32
|
+
*/
|
|
33
|
+
listWithGenerator: () => AsyncGenerator<DuffelResponse<OfferRequest>, void, unknown>;
|
|
34
|
+
/**
|
|
35
|
+
* To search for flights, you'll need to create an `offer request`.
|
|
36
|
+
* An offer request describes the passengers and where and when they want to travel (in the form of a list of `slices`).
|
|
37
|
+
* It may also include additional filters (e.g. a particular cabin to travel in).
|
|
38
|
+
* @param {Object} [options] - the parameters for making an offer requests (required: slices, passengers; optional: cabin_class, return_offers)
|
|
39
|
+
* When `return_offers` is set to `true`, the offer request resource returned will include all the `offers` returned by the airlines.
|
|
40
|
+
* If set to false, the offer request resource won't include any `offers`. To retrieve the associated offers later, use the List Offers endpoint, specifying the `offer_request_id`.
|
|
41
|
+
* @link https://duffel.com/docs/api/offer-requests/create-offer-request
|
|
42
|
+
*/
|
|
43
|
+
create: <QueryParams extends CreateOfferRequestQueryParameters>(options: CreateOfferRequest & QueryParams) => Promise<DuffelResponse<QueryParams extends {
|
|
44
|
+
return_offers: false;
|
|
45
|
+
} ? Omit<OfferRequest, "offers"> : OfferRequest>>;
|
|
46
|
+
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export {};
|
|
1
|
+
export {};
|