@duffel/api 1.7.3 → 1.7.7

package/dist/types/index.d.ts

@@ -511,7 +511,7 @@ interface OfferRequest {
     /**
      * The offers returned by the airlines
      */
-    offers?: Omit<Offer, 'available_services'>[];
+    offers: Omit<Offer, 'available_services'>[];
     /**
      * The passengers who want to travel. A passenger will have only a type or an age.
      */
@@ -521,7 +521,7 @@ interface CreateOfferRequest {
     /**
      * The cabin that the passengers want to travel in
      */
-    cabin_class: CabinClass;
+    cabin_class?: CabinClass;
     /**
      * The passengers who want to travel.
      * If you specify an age for a passenger, the type may differ for the same passenger in different offers due to airline's different rules. e.g. one airline may treat a 14 year old as an adult, and another as a young adult.
@@ -540,7 +540,7 @@ interface CreateOfferRequestQueryParameters {
      * To retrieve the associated `offers` later, use the [List Offers](https://duffel.com/docs/api/offers/get-offers) endpoint, specifying the `offer_request_id`.
      * You should use this option if you want to take advantage of the pagination, sorting and filtering that the [List Offers](https://duffel.com/docs/api/offers/get-offers) endpoint provides.
      */
-    return_offers: boolean;
+    return_offers?: boolean;
 }
 
 interface CreateOrderCancellation {
@@ -2185,7 +2185,7 @@ declare class OfferRequests extends Resource {
      * Endpoint path
      */
     path: string;
-    constructor(args: any);
+    constructor(client: any);
     /**
      * Retrieves an offer request by its ID
      * @param {string} id - Duffel's unique identifier for the offer request
@@ -2207,11 +2207,14 @@ declare class OfferRequests extends Resource {
      * 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`).
      * It may also include additional filters (e.g. a particular cabin to travel in).
-     * @param {boolean} [return_offers] - When set to `true`, the offer request resource returned will include all the `offers` returned by the airlines.
+     * @param {Object} [options] - the parameters for making an offer requests (required: slices, passengers; optional: cabin_class, return_offers)
+     * When `return_offers` is set to `true`, the offer request resource returned will include all the `offers` returned by the airlines.
      * 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`.
      * @link https://duffel.com/docs/api/offer-requests/create-offer-request
      */
-    create: (options: Partial<CreateOfferRequest & CreateOfferRequestQueryParameters>) => Promise<DuffelResponse<OfferRequest>>;
+    create: <QueryParams extends CreateOfferRequestQueryParameters>(options: CreateOfferRequest & QueryParams) => Promise<DuffelResponse<QueryParams extends {
+        return_offers: false;
+    } ? Omit<OfferRequest, "offers"> : OfferRequest>>;
 }
 
 interface UpdateOfferBodyParameters {
@@ -2219,9 +2222,6 @@ interface UpdateOfferBodyParameters {
     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
@@ -2232,7 +2232,7 @@ declare class Offers extends Resource {
      * Endpoint path
      */
     path: string;
-    constructor(args: any);
+    constructor(client: any);
     /**
      * Retrieves an offer by its ID
      * @param {string} id - Duffel's unique identifier for the offer
@@ -2260,11 +2260,11 @@ declare class Offers extends Resource {
      * 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 {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.
+     * @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.
      * @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>>;
+    update: (offerId: string, passengerId: string, params: UpdateOfferBodyParameters) => Promise<DuffelResponse<UpdateOffer>>;
 }
 
 declare class OrderCancellations extends Resource {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@duffel/api",
-  "version": "1.7.3",
+  "version": "1.7.7",
   "description": "Javascript client library for the Duffel API",
   "main": "dist/index.js",
   "module": "dist/index.es.js",
@@ -48,7 +48,7 @@
   },
   "dependencies": {
     "@types/node": "^17.0.1",
-    "isomorphic-unfetch": "^3.1.0"
+    "node-fetch": "^3.2.0"
   },
   "devDependencies": {
     "@babel/core": "^7.15.5",
@@ -59,13 +59,13 @@
     "@commitlint/cz-commitlint": "^16.0.0",
     "@rollup/plugin-commonjs": "^21.0.0",
     "@rollup/plugin-multi-entry": "^4.0.0",
-    "@rollup/plugin-node-resolve": "^13.0.0",
+    "@rollup/plugin-node-resolve": "^13.1.3",
     "@types/jest": "^27.0.1",
     "@typescript-eslint/eslint-plugin": "^4.26.1",
     "@typescript-eslint/parser": "^4.26.1",
     "colors": "^1.4.0",
     "commitizen": "^4.2.4",
-    "dotenv": "^10.0.0",
+    "dotenv": "^14.2.0",
     "eslint": "^7.26.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-spellcheck": "^0.0.19",
@@ -74,8 +74,8 @@
     "lint-staged": "^12.0.1",
     "nock": "^13.1.0",
     "prettier": "^2.4.1",
-    "rollup": "^2.51.2",
-    "rollup-plugin-dts": "^4.0.0",
+    "rollup": "^2.66.1",
+    "rollup-plugin-dts": "^4.1.0",
     "rollup-plugin-inject-process-env": "^1.3.1",
     "rollup-plugin-peer-deps-external": "^2.2.4",
     "rollup-plugin-terser": "^7.0.2",
@@ -91,17 +91,17 @@
   "engines": {
     "node": ">=14.*"
   },
-  "plugins": [
-    [
-      "@semantic-release/commit-analyzer"
-    ],
-    [
-      "@semantic-release/release-notes-generator"
-    ],
-    "@semantic-release/npm",
-    "@semantic-release/github"
-  ],
   "release": {
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer"
+      ],
+      [
+        "@semantic-release/release-notes-generator"
+      ],
+      "@semantic-release/npm",
+      "@semantic-release/github"
+    ],
     "branches": [
       "main"
     ]