@duffel/api 1.4.0 → 1.7.0

package/dist/types/index.d.ts

@@ -192,6 +192,28 @@ interface OfferPassenger {
      * The type of the passenger.
      */
     type?: 'adult';
+    /**
+     * The passenger's family name. Only `space`, `-`, `'`, and letters from the `ASCII`, `Latin-1 Supplement` and `Latin
+     * Extended-A` (with the exceptions of `Æ`, `æ`, `IJ`, `ij`, `Œ`, `œ`, `Þ`, , and `ð`) Unicode charts are accepted. All
+     * other characters will result in a validation error. The minimum length is 1 character, and the maximum is 20
+     * characters.
+     *
+     * This is only required if you're also including **Loyalty Programme Accounts**.
+     */
+    family_name?: string;
+    /**
+     * The passenger's given name. Only `space`, `-`, `'`, and letters from the `ASCII`, `Latin-1 Supplement` and `Latin
+     * Extended-A` (with the exceptions of `Æ`, `æ`, `IJ`, `ij`, `Œ`, `œ`, `Þ`, , and `ð`) Unicode charts are accepted. All
+     * other characters will result in a validation error. The minimum length is 1 character, and the maximum is 20
+     * characters.
+     *
+     * This is only required if you're also including **Loyalty Programme Accounts**.
+     */
+    given_name?: string;
+    /**
+     * The **Loyalty Programme Accounts** for this passenger.
+     */
+    loyalty_programme_accounts?: LoyaltyProgrammeAccount[];
     /**
      * The identifier for the passenger, unique within this Offer Request and across all Offer Requests.
      * This ID will be generated by Duffel unless you had optionally provided one.
@@ -361,6 +383,24 @@ interface ListOffersParams extends PaginationMeta {
      * By default the sorting order will be ascending, if you wish to sort in descending order a - will need to be prepended to the sorting attribute (i.e: `-total_amount`).
      */
     sort?: 'total_amount' | 'total_duration';
+}
+interface LoyaltyProgrammeAccounts {
+    /**
+     * The passenger's account number for this Loyalty Programme Account
+     */
+    account_number: string;
+    /**
+     * The IATA code for the airline that this Loyalty Programme Account belongs to
+     */
+    airline_iata_code: string;
+}
+interface UpdateOffer {
+    type: string;
+    loyalty_programme_accounts: LoyaltyProgrammeAccounts;
+    id: string;
+    given_name: string;
+    family_name: string;
+    age: number;
 }
 
 interface OfferRequestSlice {
@@ -1050,6 +1090,10 @@ interface OrderPassenger {
      * @return "adult", "child", or "infant_without_seat"
      */
     infant_passenger_id?: string | null;
+    /**
+     * The **Loyalty Programme Accounts** for this passenger.
+     */
+    loyalty_programme_accounts?: LoyaltyProgrammeAccount[];
 }
 interface OrderPassengerIdentityDocument {
     /**
@@ -1713,6 +1757,119 @@ interface Airport {
     time_zone: string;
 }
 
+interface PaymentIntent {
+    /**
+     * The amount of the Payment Intent that covers the cost of the flight being sold and any additional markup.
+     * The card payment will be charged this amount.
+     */
+    amount: string;
+    /**
+     * The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code of the country that issued the card used to confirm the Payment Intent.
+     * It will be null until the Payment Intent is confirmed.
+     */
+    card_country_code: string | null;
+    /**
+     * The last four digits of the card used to confirm the Payment Intent.
+     * It will be null until the Payment Intent is confirmed.
+     */
+    card_last_four_digits: string | null;
+    /**
+     * The card network in which the Payment Intent was processed on.
+     * It will be null until the Payment Intent is confirmed.
+     */
+    card_network: 'amex' | 'cartes_bancaires' | 'diners' | 'discover' | 'interac' | 'jcb' | 'mastercard' | 'unionpay' | 'visa' | 'unknown' | null;
+    /**
+     * This value is used when displaying the payment collection form to securely identify and transmit the values to Duffel.
+     */
+    client_token: string;
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the Payment Intent was confirmed
+     */
+    confirmed_at: string;
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the Payment Intent was created
+     */
+    created_at: string;
+    /**
+     * The currency of the `amount`, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
+     * The card payment will be charged in this currency.
+     * If it's different to your Balance currency, it will be converted to your Balance currency before the Balance is topped up.
+     */
+    currency: string;
+    /**
+     * The amount of the fees to process the Payment Intent.
+     * It will be `null` until the Payment Intent is confirmed.
+     */
+    fees_amount: string | null;
+    /**
+     * The currency of the fees_amount, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
+     * This currency will match your Balance currency.
+     * It will be null until the Payment Intent is confirmed.
+     */
+    fees_currency: string | null;
+    /**
+     * Duffel's unique identifier for the `Payment Intent`
+     */
+    id: string;
+    /**
+     * Whether the Payment Intent was created in live mode. This field will be set to `true` if the Payment Intent was created in live mode, or `false` if it was created in test mode.
+     */
+    live_mode: boolean;
+    /**
+     * The amount of the Payment Intent that was added to the Balance.
+     * It'll be `amount` (in the Balance currency) less the `fees_amount`.
+     * It will be `null` until the Payment Intent is confirmed.
+     */
+    net_amount: string | null;
+    /**
+     * The currency of the net_amount, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
+     * This currency will match your Balance currency.
+     * It will be null until the Payment Intent is confirmed.
+     */
+    net_currency: string | null;
+    /**
+     * The Refunds for this Payment Intent
+     * @link https://duffel.com/docs/api/payment-intents/schema#payment-intents-schema-refunds
+     */
+    refunds: {
+        amount: string;
+        arrival: string;
+        created_at: string;
+        currency: string;
+        destination: string;
+        id: string;
+        live_mode: boolean;
+        net_amount: string;
+        net_currency: string;
+        payment_intent_id: string;
+        status: 'succeeded' | 'pending' | 'failed';
+        updated_at: string;
+    }[];
+    /**
+     * The status of this Payment Intent
+     */
+    status: null | 'requires_payment_method' | 'requires_confirmation' | 'requires_action' | 'processing' | 'requires_capture' | 'cancelled' | 'succeeded';
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the Payment Intent was updated
+     */
+    updated_at: string;
+}
+interface CreatePaymentIntent {
+    /**
+     * This is the amount that the card payment being taken will be charged.
+     * It should be enough to cover the service(s) you want to sell (enough to book an Offer for example) and the processing fees.
+     * If the currency is different from your Balance currency you should also account for foreign exchange.
+     * It can be higher than that, in which case the remainder will be considered your markup.
+     * If it's higher than the maximum allowed for you organisation you will get a validation error. By default the maximum is 5,000.00 GBP (or equivalent in the same currency). If you need a maximum higher than the default please get in touch with us via help@duffel.com.
+     */
+    amount: string;
+    /**
+     * The currency of the amount, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
+     * This is going to be the currency that the card payment being taken in will be charged in.
+     */
+    currency: string;
+}
+
 /**
  * The metropolitan area where the airport is located.
  * Only present for airports which are registered with IATA as belonging to a metropolitan area.
@@ -1938,7 +2095,7 @@ interface DuffelResponse<T_Data> {
 declare class DuffelError extends Error {
     meta: ApiResponseMeta;
     errors: ApiResponseError[];
-    constructor({ meta, errors }: {
+    constructor({ meta, errors, }: {
         meta: ApiResponseMeta;
         errors: ApiResponseError[];
     });
@@ -1965,14 +2122,14 @@ declare class Client {
     private apiVersion;
     private debug;
     constructor({ token, basePath, apiVersion, debug }: Config);
-    request: <T_Data = any>({ method, path, data, params, compress }: {
+    request: <T_Data = any>({ method, path, data, params, compress, }: {
         method: string;
         path: string;
         data?: Record<string, any> | undefined;
         params?: Record<string, any> | undefined;
         compress?: boolean | undefined;
     }) => Promise<DuffelResponse<T_Data>>;
-    paginatedRequest<T_Data = any>({ path, params }: {
+    paginatedRequest<T_Data = any>({ path, params, }: {
         path: string;
         params?: Record<string, any>;
     }): AsyncGenerator<DuffelResponse<T_Data>, void, unknown>;
@@ -1981,18 +2138,44 @@ declare class Client {
 declare class Resource {
     private client;
     constructor(client: Client);
-    protected request: <T_Data = any>({ method, path, data, params }: {
+    protected request: <T_Data = any>({ method, path, data, params, }: {
         method: string;
         path: string;
         data?: Record<string, any> | undefined;
         params?: Record<string, any> | undefined;
     }) => Promise<DuffelResponse<T_Data>>;
-    protected paginatedRequest: <T_Data = any>({ path, params }: {
+    protected paginatedRequest: <T_Data = any>({ path, params, }: {
         path: string;
         params?: Record<string, any> | undefined;
     }) => AsyncGenerator<DuffelResponse<T_Data>, void, unknown>;
 }
 
+declare class PaymentIntents extends Resource {
+    /**
+     * Endpoint path
+     */
+    path: string;
+    constructor(args: any);
+    /**
+     * You should use this API to get the complete, up-to-date information about a Payment Intent.
+     * @param {string} id - Duffel's unique identifier for the Payment Intent
+     * @link https://duffel.com/docs/api/payment-intents/get-payment-intent-by-id
+     */
+    get: (id: string) => Promise<DuffelResponse<PaymentIntent>>;
+    /**
+     * Once you've successfully collected the customer's card details, using the `client_token` from when you first created the Payment Intent, you then need to confirm it using this endpoint.
+     * Once confirmed, the amount charged to your customer's card will be added to your `Balance` (minus any Duffel Payment fees).
+     */
+    confirm: (id: string) => Promise<DuffelResponse<PaymentIntent>>;
+    /**
+     * To begin the process of collecting a card payment from your customer, you need to create a Payment Intent.
+     * The Payment Intent will contain a `client_token` that you use to collect the card payment in your application.
+     * If the Payment Intent is created in test mode you should use a [test card](https://duffel.com/docs/api/overview/test-mode/test-card-numbers).
+     * @param {Object.<CreatePaymentIntent>} params - Endpoint params (amount and string)
+     */
+    create: (params: CreatePaymentIntent) => Promise<DuffelResponse<PaymentIntent>>;
+}
+
 /**
  * To search for flights, you'll need to create an `offer request`.
  * An offer request describes the passengers and where and when they want to travel (in the form of a list of `slices`).
@@ -2034,6 +2217,14 @@ declare class OfferRequests extends Resource {
     create: (options: Partial<CreateOfferRequest & CreateOfferRequestQueryParameters>) => Promise<DuffelResponse<OfferRequest>>;
 }
 
+interface UpdateOfferBodyParameters {
+    loyalty_programme_accounts: LoyaltyProgrammeAccounts[];
+    given_name: string;
+    family_name: string;
+}
+interface UpdateOfferBodyParametersWithoutLoyalty {
+    loyalty_programme_accounts: never;
+}
 /**
  * Each offer represents flights you can buy from an airline at a particular price that meet your search criteria.
  * @class
@@ -2068,6 +2259,15 @@ declare class Offers extends Resource {
      * @link https://duffel.com/docs/api/offers/get-offers
      */
     listWithGenerator: ({ offer_request_id, ...params }: ListOffersParams) => AsyncGenerator<DuffelResponse<Offer>, void, unknown>;
+    /**
+     * Some offer passenger fields are updateable. Each field that can be updated is detailed in the request object.
+     * @param {string} offerId - Duffel's unique identifier for the offer
+     * @param {string} passengerId - The identifier for the passenger. This ID will be generated by Duffel
+     * @param {string} params.family_name - The passenger's family name. Only space, -, ', and letters from the ASCII, Latin-1 Supplement and Latin Extended-A (with the exceptions of Æ, æ, IJ, ij, Œ, œ, Þ, and ð) Unicode charts are accepted. All other characters will result in a validation error. The minimum length is 1 character, and the maximum is 20 characters. This is only required if you're also including Loyalty Programme Accounts.
+     * @param {string} params.given_name - The passenger's given name. Only space, -, ', and letters from the ASCII, Latin-1 Supplement and Latin Extended-A (with the exceptions of Æ, æ, IJ, ij, Œ, œ, Þ, and ð) Unicode charts are accepted. All other characters will result in a validation error. The minimum length is 1 character, and the maximum is 20 characters. This is only required if you're also including Loyalty Programme Accounts.
+     * @param {Object.<LoyaltyProgrammeAccounts>} params.loyalty_programme_accounts - The Loyalty Programme Accounts for this passenger
+     */
+    update: (offerId: string, passengerId: string, params?: UpdateOfferBodyParameters | UpdateOfferBodyParametersWithoutLoyalty | undefined) => Promise<DuffelResponse<UpdateOffer>>;
 }
 
 declare class OrderCancellations extends Resource {
@@ -2370,7 +2570,8 @@ declare class Duffel {
     orderCancellations: OrderCancellations;
     payments: Payments;
     seatMaps: SeatMaps;
+    paymentIntents: PaymentIntents;
     constructor(config: Config);
 }
 
-export { Aircraft$1 as Aircraft, Airline, Airport, ApiResponseError, ApiResponseMeta, BaggageType, CabinClass, City, ConfirmOrderChangePayment, CreateOfferRequest, CreateOfferRequestQueryParameters, CreateOrder, CreateOrderCancellation, CreateOrderChangeParameters, CreateOrderChangeRequest, CreateOrderPassenger, CreatePayment, Duffel, DuffelAPIClient, DuffelError, DuffelPassengerGender, DuffelPassengerTitle, DuffelPassengerType, DuffelResponse, FlightsConditions, ListOffersParams, ListParamsOrders, LoyaltyProgrammeAccount, Offer, OfferAvailableService, OfferAvailableServiceBaggageMetadata, OfferAvailableServiceMetadataMap, OfferAvailableServiceType, OfferPassenger, OfferRequest, OfferRequestPassenger, OfferRequestSlice, OfferSlice, OfferSliceSegment, OfferSliceSegmentPassenger, OfferSliceSegmentPassengerBaggage, Order, OrderCancellation, OrderChange, OrderChangeOffer, OrderChangeOfferSlice, OrderChangeOfferSlices, OrderChangeOffers$1 as OrderChangeOffers, OrderChangeRequestResponse, OrderChangeSliceResponse, OrderDocument, OrderDocumentsType, OrderPassenger, OrderPassengerIdentityDocument, OrderPayment, OrderPaymentStatus, OrderSegmentPassenger, OrderSegmentPassengerBaggage, OrderService, OrderServiceBaggageMetadata, OrderSlice, OrderSliceSegment, PaginationMeta, PassengerIdentityDocumentType, Payment, PaymentRequirements, PaymentType, Place, PlaceType, SDKOptions, Seat, SeatMap, SeatMapCabin, SeatMapCabinRow, SeatMapCabinRowSection, SeatMapCabinRowSectionAvailableService, SeatMapCabinRowSectionElement, SeatMapCabinRowSectionElementAmenity, SeatMapCabinRowSectionElementBassinet, SeatMapCabinRowSectionElementCloset, SeatMapCabinRowSectionElementEmpty, SeatMapCabinRowSectionElementExitRow, SeatMapCabinRowSectionElementGalley, SeatMapCabinRowSectionElementLavatory, SeatMapCabinRowSectionElementSeat, SeatMapCabinRowSectionElementStairs, SeatMapCabinRowSectionElementType, UpdateSingleOrder, ValidationError };
+export { Aircraft$1 as Aircraft, Airline, Airport, ApiResponseError, ApiResponseMeta, BaggageType, CabinClass, City, ConfirmOrderChangePayment, CreateOfferRequest, CreateOfferRequestQueryParameters, CreateOrder, CreateOrderCancellation, CreateOrderChangeParameters, CreateOrderChangeRequest, CreateOrderPassenger, CreatePayment, CreatePaymentIntent, Duffel, DuffelAPIClient, DuffelError, DuffelPassengerGender, DuffelPassengerTitle, DuffelPassengerType, DuffelResponse, FlightsConditions, ListOffersParams, ListParamsOrders, LoyaltyProgrammeAccount, LoyaltyProgrammeAccounts, Offer, OfferAvailableService, OfferAvailableServiceBaggageMetadata, OfferAvailableServiceMetadataMap, OfferAvailableServiceType, OfferPassenger, OfferRequest, OfferRequestPassenger, OfferRequestSlice, OfferSlice, OfferSliceSegment, OfferSliceSegmentPassenger, OfferSliceSegmentPassengerBaggage, Order, OrderCancellation, OrderChange, OrderChangeOffer, OrderChangeOfferSlice, OrderChangeOfferSlices, OrderChangeOffers$1 as OrderChangeOffers, OrderChangeRequestResponse, OrderChangeSliceResponse, OrderDocument, OrderDocumentsType, OrderPassenger, OrderPassengerIdentityDocument, OrderPayment, OrderPaymentStatus, OrderSegmentPassenger, OrderSegmentPassengerBaggage, OrderService, OrderServiceBaggageMetadata, OrderSlice, OrderSliceSegment, PaginationMeta, PassengerIdentityDocumentType, Payment, PaymentIntent, PaymentRequirements, PaymentType, Place, PlaceType, SDKOptions, Seat, SeatMap, SeatMapCabin, SeatMapCabinRow, SeatMapCabinRowSection, SeatMapCabinRowSectionAvailableService, SeatMapCabinRowSectionElement, SeatMapCabinRowSectionElementAmenity, SeatMapCabinRowSectionElementBassinet, SeatMapCabinRowSectionElementCloset, SeatMapCabinRowSectionElementEmpty, SeatMapCabinRowSectionElementExitRow, SeatMapCabinRowSectionElementGalley, SeatMapCabinRowSectionElementLavatory, SeatMapCabinRowSectionElementSeat, SeatMapCabinRowSectionElementStairs, SeatMapCabinRowSectionElementType, UpdateOffer, UpdateSingleOrder, ValidationError };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@duffel/api",
-  "version": "1.4.0",
+  "version": "1.7.0",
   "description": "Javascript client library for the Duffel API",
   "main": "dist/index.js",
   "module": "dist/index.es.js",
@@ -22,19 +22,30 @@
     "dev": "ts-node ./src/index.ts",
     "lint": "eslint . --ext .ts,.tsx",
     "test": "jest",
-    "pre-push-check": "yarn lint && yarn test && yarn build:test",
+    "pre-commit-check": "yarn lint-staged && yarn test && yarn build:test",
     "prepare": "husky install",
     "example": "ts-node ./examples/example.ts",
     "get-version": "echo $npm_package_version",
     "release": "npx semantic-release",
     "commit": "git-cz",
-    "commitlint": "commitlint"
+    "commitlint": "commitlint",
+    "prettier": "prettier --write --loglevel=warn .",
+    "prettier-check": "prettier --check ."
   },
   "config": {
     "commitizen": {
       "path": "@commitlint/cz-commitlint"
     }
   },
+  "lint-staged": {
+    "*.{ts,tsx}": [
+      "eslint",
+      "prettier --write"
+    ],
+    "*.{js,jsx,md,yml,yaml}": [
+      "prettier --write"
+    ]
+  },
   "dependencies": {
     "@types/node": "^16.0.0",
     "isomorphic-unfetch": "^3.1.0"
@@ -43,9 +54,9 @@
     "@babel/core": "^7.15.5",
     "@babel/preset-env": "^7.15.4",
     "@babel/preset-typescript": "^7.14.5",
-    "@commitlint/cli": "^13.1.0",
-    "@commitlint/config-angular": "^13.1.0",
-    "@commitlint/cz-commitlint": "^13.1.0",
+    "@commitlint/cli": "^14.1.0",
+    "@commitlint/config-angular": "^14.1.0",
+    "@commitlint/cz-commitlint": "^14.1.0",
     "@rollup/plugin-commonjs": "^21.0.0",
     "@rollup/plugin-multi-entry": "^4.0.0",
     "@rollup/plugin-node-resolve": "^13.0.0",
@@ -56,10 +67,13 @@
     "commitizen": "^4.2.4",
     "dotenv": "^10.0.0",
     "eslint": "^7.26.0",
+    "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-spellcheck": "^0.0.19",
     "husky": "^7.0.0",
     "jest": "^26.6.3",
+    "lint-staged": "^12.0.1",
     "nock": "^13.1.0",
+    "prettier": "^2.4.1",
     "rollup": "^2.51.2",
     "rollup-plugin-dts": "^4.0.0",
     "rollup-plugin-inject-process-env": "^1.3.1",