duffelhq / duffel-api-javascript Goto Github PK

Attempting to build my project with @duffel/[email protected] and TSC version 5.2.2 I'm getting the following errors:

node_modules/@duffel/api/dist/typings.d.ts:1288:32 - error TS2307: Cannot find module 'types' or its corresponding type declarations.

1288     import { OrderSlice } from 'types';
                                    ~~~~~~~

node_modules/@duffel/api/dist/typings.d.ts:3767:36 - error TS2307: Cannot find module 'types' or its corresponding type declarations.

3767     import { PaginationMeta } from 'types';
                                        ~~~~~~~

node_modules/@duffel/api/dist/typings.d.ts:3921:12 - error TS1038: A 'declare' modifier cannot be used in an already ambient context.

3921     export declare class Airlines extends Resource {
                ~~~~~~~

It looks like a few similar issues were recently fixed: #794

Thanks for your support!

We cannot import @duffel/api, error: Error: Cannot find module 'node:http'. Node version = 14.18.3. OS = windows 10.

I was receiving a 404 when using duffel.paymentIntents.create on @duffel/api version 1.7.0 and 1.7.1

I looked up the endpoint that was being called here and it was set to 'air/payments/payment_intents'
The documentation says to go directly to /payments/payment_intents and so I added duffel.paymentIntents.path = "payments/payment_intents"; to my server code right before duffel.paymentIntents.create and it works now

it looks like some of the other endpoints also have "air/" in them but work properly so I don't know if this is a javascript library issue or an api issue but it was blocking me from taking orders.

import{URL as s,URLSearchParams as e}from"url" error showing when trying to compile the code

Hello!

I hope you are doing well!

We are a security research team. Our tool automatically detected a vulnerability in this repository. We want to disclose it responsibly. GitHub has a feature called Private vulnerability reporting, which enables security research to privately disclose a vulnerability. Unfortunately, it is not enabled for this repository.

Can you enable it, so that we can report it?

Thanks in advance!

PS: you can read about how to enable private vulnerability reporting here: https://docs.github.com/en/code-security/security-advisories/repository-security-advisories/configuring-private-vulnerability-reporting-for-a-repository

"name" is not on the type

The type definition

If I check the docs I see that "query" deprecated.
https://duffel.com/docs/api/v1/places/get-place-suggestions

Referencing the documentation provided here: https://duffel.com/docs/api/places/get-place-suggestions

I implemented a quick function to test the suggestions function.

Duffel Component

var { Duffel } = require('@duffel/api');

const duffel = new Duffel({
  token: "duffel_test_XXX",
  debug: { verbose: true }
});

module.exports = duffel;

Router Component

var express = require("express");
var router = express.Router();
var duffel = require('../duffel');

router.get("/", async (req, res, next) => {
    const autosuggestion = await duffel.suggestions.list(
        {
        "query": "heathr"
      }
      )
    res.send(autosuggestion);
});

module.exports = router;

Error Message

TypeError: Cannot read properties of undefined (reading 'list')

It seems as though the suggestions function does not exist.

Please help.

The docs specify 5 possible values for PassengerTitle, but the typescript types represent 3 of them in upper and lowercase, and miss the other 2:

Just testing this cool feature :).

Hello,
We have been struggling to get x-request-id header in our Node app. We use Duffel JS to get Api body but we do not get the header information. Please can you help?

It would be very useful to be able to obtain the detailed fare rules such as penalties, seating policies, refund policies etc by providing the fare basis code.

The docs state that some fields on responses can be null, for example penalty_currency when the change/refund is not allowed,

If refunds aren't allowed, the conditions.refund_before_departure.allowed attribute will be false, and the penalty amount and currency will be null

however the typing for this does not accept this as the case as seen here:

/**
 * The currency of the `penalty_amount` as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
 * This will be in a currency determined by the airline, which is not necessarily the same as the currency of the order or offer.
 * If this is `null` then `penalty_amount` will also be `null`.
 * @example "GBP"
 */
penalty_currency: string

It looks as if recently some changes have been made around this, including making penalty_amount nullable, so perhaps some have been missed.

Hi,
it seems that the stops key is missing in the OfferSliceSegment type.
Can this be added in the next update?

Trying to find instructions on how to use the CLI tool. (how to generate a new app?). Is there a boilerplate or example repo available on Github? Thanks in advance.

Hello!

We are in the services part regarding the JS SDK integration but we are running into a problem. When trying to Create an Order, the response is undefined and the SDK does not return errors.

It had happened before but it turned out to be because of a sum error in the "amount" (which also doesn't return errors when it's wrong as far as we've tested). But now, with several services, for some reason it fails and we believe that this time the sum is correct. The same booking, but with less baggage services, did work.

We also enabled debug mode in the SDK to check more accurately but it didn't help much.

The log and the information with which we tried to create an order, in the test environment:

 [2023-03-23T02:26:25.815Z] Endpoint:  https://api.duffel.com/air/orders
 [2023-03-23T02:26:25.815Z] Method:  POST
 [2023-03-23T02:26:25.815Z] Body Parameters:  {
   selected_offers: [ 'off_0000ATtQPgBS0joLrbNcY7' ],
   payments: [ { type: 'balance', currency: 'EUR', amount: '253.91' } ],
   passengers: [
     {
       type: 'adult',
       loyalty_programme_accounts: [],
       id: 'pas_0000ATtQPdvQPLnsrJrnHu',
       given_name: 'Leonardo',
       family_name: 'Godoy',
       age: null,
       born_on: '1980-02-02',
       email: 'REDACTED',
       phone_number: 'REDACTED',
       gender: 'm',
       title: 'mr'
     }
   ],
   type: 'instant',
   services: [
     { id: 'ase_0000ATtQPlOz1hvW9V553C', quantity: 1 },
     { id: 'ase_0000ATtQPlOz1hvW9V553A', quantity: 3 },
     { id: 'ase_0000ATtQPlOz1hvW9V553B', quantity: 3 }
   ]
 }

If I give duffel.offerRequests.create a max_connections value it works but I get a type error:

const { data } = await duffel.offerRequests.create({
    ...
    max_connections: 0 // <-- this shows a type error
});

I'd make a PR for this but given the problems we had with #653 I thought it would just be easier to make this issue.

Greetings,

I'm unable to find the answer to these two questions in Duffel's documentation:

1. How long should one wait between creating an OfferRequest (i.e., offerRequests.create) and reviewing/listing offers (i.e., offers.list)? I'm asking largely because this part of the documentation mentions response times + the fact that Duffel acts as proxy.

2. Somewhat linked to the above question -- this documentation mentions a return_offers argument ... what is the purpose of that argument? If set to true will offers immediately be returned (eliminating the need to use offers.list)?

Thank you

Attempting to build my project which uses the Duffel API, but getting the error:
Cannot find module 'Client' or its corresponding type declarations
multiple times in my compilation.

I went through some of the older Issues and found #372 on version 1.7, and after looking around I have a slight suspicion that relative paths have stopped being used since.

Could this be looked into please?

EDIT: Referenced the wrong issue

Hello Team,

The CardPayment component isn't working. I tried both the React and Vanilla JS components and both throw an error.

Component URL
https://duffel.com/docs/guides/collecting-customer-card-payments

Please check the attached screenshot below

Please let me know if there is any other way I can collect the Payments from the customer?

Regards,
Charles

Me again... Really sorry!

interface OfferRequestSlice {
    ...
    /**
     * The city or airport the passengers want to travel to
     */
    destination: Place | string;
    /**
     * The city or airport the passengers want to depart from
     */
    origin: Place | string;
   ....
}

Should these just be set to Place? Is there an example of a time when these might be a string?

OK I promise this is the last one from me today!

Pretty much the same as #653 but for OfferPassenger

Hi!

A part of the implementation that was previously working and is no longer working is the selection of services, specifically baggage.

meta: { status: 422, request_id: 'F1FXLmKy-Q5QFmIAb2yB' },
errors: [
     {
       	type: 'validation_error',
       	title: 'Linked record(s) not found',
      	source: [Object],
     	message: "Field 'id' contains ID(s) of linked record(s) that were not found in your account",
    	documentation_url: 'https://duffel.com/docs/api/overview/errors',
   		code: 'not_found'
	}
]

Since we call the GetOffer endpoint multiple times to check that the flight is still available, it is understandable and to be expected that the ID of the services will change. The problem is that in this case, when doing the retrieval of selected services, we are using the last Offer received with its corresponding services.

In this case, the services to be added to the booking are:

 [{"id":"ase_0000AU9mw1Siuc9ifftYY7","quantity":3}]

Below, in order of extraction, are all the services that we received in the Offers. The last one would be the GetOffer before CreateOrder(), and, consequently, the Offer.services that we use to obtain the ID to use in this flight.

[
  [
    {
      "type": "baggage",
      "total_currency": "EUR",
      "total_amount": "72.67",
      "segment_ids": [
        "seg_0000AU9mYFlZSEOU53adhG",
        "seg_0000AU9mYFlZSEOU53adhI"
      ],
      "passenger_ids": ["pas_0000AU9mYDWFoCxB6yPNXn"],
      "metadata": {
        "type": "checked",
        "maximum_weight_kg": 23,
        "maximum_length_cm": null,
        "maximum_height_cm": null,
        "maximum_depth_cm": null
      },
      "maximum_quantity": 3,
      "id": "ase_0000AU9mq2Jgp5UJaDobSa"
    },
    {
      "type": "baggage",
      "total_currency": "EUR",
      "total_amount": "61.31",
      "segment_ids": [
        "seg_0000AU9mYFlZSEOU53adhG",
        "seg_0000AU9mYFlZSEOU53adhI"
      ],
      "passenger_ids": ["pas_0000AU9mYDWFoCxB6yPNXn"],
      "metadata": {
        "type": "checked",
        "maximum_weight_kg": 15,
        "maximum_length_cm": null,
        "maximum_height_cm": null,
        "maximum_depth_cm": null
      },
      "maximum_quantity": 3,
      "id": "ase_0000AU9mq2Jgp5UJaDobSb"
    },
    {
      "type": "baggage",
      "total_currency": "EUR",
      "total_amount": "36.32",
      "segment_ids": [
        "seg_0000AU9mYFlZSEOU53adhG",
        "seg_0000AU9mYFlZSEOU53adhI"
      ],
      "passenger_ids": ["pas_0000AU9mYDWFoCxB6yPNXn"],
      "metadata": {
        "type": "carry_on",
        "maximum_weight_kg": null,
        "maximum_length_cm": null,
        "maximum_height_cm": null,
        "maximum_depth_cm": null
      },
      "maximum_quantity": 1,
      "id": "ase_0000AU9mq2Jgp5UJaDobSc"
    }
  ],
  [
    {
      "type": "baggage",
      "total_currency": "EUR",
      "total_amount": "72.67",
      "segment_ids": [
        "seg_0000AU9mqEdbIBUnebCdsi",
        "seg_0000AU9mqEdbIBUnebCdsl"
      ],
      "passenger_ids": ["pas_0000AU9mqCNDi7CkdDWX4N"],
      "metadata": {
        "type": "checked",
        "maximum_weight_kg": 23,
        "maximum_length_cm": null,
        "maximum_height_cm": null,
        "maximum_depth_cm": null
      },
      "maximum_quantity": 3,
      "id": "ase_0000AU9mqOtGGo07agqAN6"
    },
    {
      "type": "baggage",
      "total_currency": "EUR",
      "total_amount": "61.31",
      "segment_ids": [
        "seg_0000AU9mqEdbIBUnebCdsi",
        "seg_0000AU9mqEdbIBUnebCdsl"
      ],
      "passenger_ids": ["pas_0000AU9mqCNDi7CkdDWX4N"],
      "metadata": {
        "type": "checked",
        "maximum_weight_kg": 15,
        "maximum_length_cm": null,
        "maximum_height_cm": null,
        "maximum_depth_cm": null
      },
      "maximum_quantity": 3,
      "id": "ase_0000AU9mqOtGGo07agqAN7"
    },
    {
      "type": "baggage",
      "total_currency": "EUR",
      "total_amount": "36.32",
      "segment_ids": [
        "seg_0000AU9mqEdbIBUnebCdsi",
        "seg_0000AU9mqEdbIBUnebCdsl"
      ],
      "passenger_ids": ["pas_0000AU9mqCNDi7CkdDWX4N"],
      "metadata": {
        "type": "carry_on",
        "maximum_weight_kg": null,
        "maximum_length_cm": null,
        "maximum_height_cm": null,
        "maximum_depth_cm": null
      },
      "maximum_quantity": 1,
      "id": "ase_0000AU9mqOtGGo07agqAN8"
    }
  ],
  [
    {
      "type": "baggage",
      "total_currency": "EUR",
      "total_amount": "72.67",
      "segment_ids": [
        "seg_0000AU9mqEdbIBUnebCdsi",
        "seg_0000AU9mqEdbIBUnebCdsl"
      ],
      "passenger_ids": ["pas_0000AU9mqCNDi7CkdDWX4N"],
      "metadata": {
        "type": "checked",
        "maximum_weight_kg": 23,
        "maximum_length_cm": null,
        "maximum_height_cm": null,
        "maximum_depth_cm": null
      },
      "maximum_quantity": 3,
      "id": "ase_0000AU9mviFwbCawxgkYDM"
    },
    {
      "type": "baggage",
      "total_currency": "EUR",
      "total_amount": "61.31",
      "segment_ids": [
        "seg_0000AU9mqEdbIBUnebCdsi",
        "seg_0000AU9mqEdbIBUnebCdsl"
      ],
      "passenger_ids": ["pas_0000AU9mqCNDi7CkdDWX4N"],
      "metadata": {
        "type": "checked",
        "maximum_weight_kg": 15,
        "maximum_length_cm": null,
        "maximum_height_cm": null,
        "maximum_depth_cm": null
      },
      "maximum_quantity": 3,
      "id": "ase_0000AU9mviFwbCawxgkYDO"
    },
    {
      "type": "baggage",
      "total_currency": "EUR",
      "total_amount": "36.32",
      "segment_ids": [
        "seg_0000AU9mqEdbIBUnebCdsi",
        "seg_0000AU9mqEdbIBUnebCdsl"
      ],
      "passenger_ids": ["pas_0000AU9mqCNDi7CkdDWX4N"],
      "metadata": {
        "type": "carry_on",
        "maximum_weight_kg": null,
        "maximum_length_cm": null,
        "maximum_height_cm": null,
        "maximum_depth_cm": null
      },
      "maximum_quantity": 1,
      "id": "ase_0000AU9mviFwbCawxgkYDQ"
    }
  ],
  [
    {
      "type": "baggage",
      "total_currency": "EUR",
      "total_amount": "72.67",
      "segment_ids": [
        "seg_0000AU9mqEdbIBUnebCdsi",
        "seg_0000AU9mqEdbIBUnebCdsl"
      ],
      "passenger_ids": ["pas_0000AU9mqCNDi7CkdDWX4N"],
      "metadata": {
        "type": "checked",
        "maximum_weight_kg": 23,
        "maximum_length_cm": null,
        "maximum_height_cm": null,
        "maximum_depth_cm": null
      },
      "maximum_quantity": 3,
      "id": "ase_0000AU9mw1Siuc9ifftYY7"
    },
    {
      "type": "baggage",
      "total_currency": "EUR",
      "total_amount": "61.31",
      "segment_ids": [
        "seg_0000AU9mqEdbIBUnebCdsi",
        "seg_0000AU9mqEdbIBUnebCdsl" 
      ],
      "passenger_ids": ["pas_0000AU9mqCNDi7CkdDWX4N"],
      "metadata": {
        "type": "checked",
        "maximum_weight_kg": 15,
        "maximum_length_cm": null,
        "maximum_height_cm": null,
        "maximum_depth_cm": null
      },
      "maximum_quantity": 3,
      "id": "ase_0000AU9mw1Siuc9ifftYY9"
    },
    {
      "type": "baggage",
      "total_currency": "EUR",
      "total_amount": "36.32",
      "segment_ids": [
        "seg_0000AU9mqEdbIBUnebCdsi",
        "seg_0000AU9mqEdbIBUnebCdsl"
      ],
      "passenger_ids": ["pas_0000AU9mqCNDi7CkdDWX4N"],
      "metadata": {
        "type": "carry_on",
        "maximum_weight_kg": null,
        "maximum_length_cm": null,
        "maximum_height_cm": null,
        "maximum_depth_cm": null
      },
      "maximum_quantity": 1,
      "id": "ase_0000AU9mw1Siuc9ifftYYB"
    }
  ]
]

In the list I concentrated for better readability all the times we received services, and as you can see the user's selection matches the last Array of available services.

It should be noted that as booking token for the Order we are using the ID of the last Offer extracted.

Thanks!

The docs specify a field called conditions_of_carriage_url on the Airline object, but this is not present in the TypeScript types:

I started reading the documentation here: https://duffel.com/docs/guides/getting-started-with-flights

Looked at the code:

duffel.offerRequests.create({
  slices : [
    {
      origin: "NYC",
      destination: "ATL",
      departure_date: "2021-06-21"
    },
    {
      origin: "ATL",
      destination: "NYC",
      departure_date: "2021-07-21"
    }
  ],
  passengers: [{ type: "adult" }, { type: "adult" }, { age: 1 }],
  cabin_class: "business",
})

But it seems that this way of searching for flights is not available anymore, now you need to pass in a Place for the origin and destination objects.

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

• build(deps): update dependency @types/node to v18.19.29
• build(deps): update peter-evans/create-pull-request action to v5.0.3
• build(deps): update dependency dotenv to v16.4.5
• build(deps): update dependency eslint to v8.57.0
• build(deps): update dependency eslint-config-prettier to v9.1.0
• build(deps): update dependency nock to v13.5.4
• build(deps): update dependency node to v18.20.0
• build(deps): update dependency prettier to v3.2.5
• build(deps): update dependency rollup to v4.14.0
• build(deps): update dependency semver to v7.6.0
• build(deps): update dependency typescript to v5.4.3
• build(deps): update node.js to v20.12
• build(deps): update typescript-eslint monorepo to v6.21.0 (@typescript-eslint/eslint-plugin, @typescript-eslint/parser)
• build(deps): update actions/cache action to v4
• build(deps): update actions/setup-node action to v4
• build(deps): update commitlint monorepo to v19 (major) (@commitlint/cli, @commitlint/config-angular, @commitlint/cz-commitlint)
• build(deps): update dependency husky to v9
• build(deps): update dependency lint-staged to v15
• build(deps): update dependency node to v20 (node, @types/node)
• build(deps): update dependency node-fetch to v3
• build(deps): update dependency semantic-release to v23
• build(deps): update node.js to v21
• build(deps): update peter-evans/create-pull-request action to v6
• build(deps): update typescript-eslint monorepo to v7 (major) (@typescript-eslint/eslint-plugin, @typescript-eslint/parser)

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• build(deps): replace dependency rollup-plugin-terser with @rollup/plugin-terser 0.1.0

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• build(deps): update dependency ansi-regex to v6

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

Hi,
I have been trying to use the SDK with my firebase Cloud Functions,

I have initialized and exported a new instance of Duffel

import { Duffel } from '@duffel/api';

const duffel = new Duffel({
    token: 'duffel**********************************4J-o3',
});

export default duffel;

which I was using on an express request handler,

const airports = await duffel.airports.list({
        limit: 100,
 });

but when building and testing the code,
I am getting this error

node_modules/@duffel/api/dist/types/index.d.ts:1:36 - error TS2307: Cannot find module 'Client' or its corresponding type declarations.

1 import { Client as Client$1 } from 'Client';

Is this a bug with the SDK or something is wrong on my end

The API documents a really useful method of tracking rate limiting. Are there any plans to incorporate that in the library? It would be nice if the library could track that internally, but I see a bunch of potholes with that method. At the very least, it would be great to expose the values of those headers in the response.

Hi Team,

I' am getting the below error, please help. BTW I love your product so much!

  const duffel = new Duffel({
    // Store your access token in an environment variable, keep it secret and only readable on your server
    token: 'My Token,
  });
  
  const offerRequestResponse = await duffel.offerRequests.create({
    slices : [
      {
        origin: "NYC",
        destination: "ATL",
        departure_date: "2022-06-21"
      },
      {
        origin: "ATL",
        destination: "NYC",
        departure_date: "2022-07-21"
      }
    ],
    passengers: [{ type: "adult" }, { type: "adult" }, { age: 1 }],
    cabin_class: "business",
    return_offers: true
  })
  
  console.log(offerRequestResponse.data.id);

Hi,
I am using the return_offers flag for an offers request. I find the response odd in these cases:
when flag is true I only usually receive around 20 offers, when setting it as false and the querying the offers list request with the offer id I get more than 100 offers in total.
Is this something that is done on purpose while using the test data or am I doing something wrong? I would expect to receive all offers if the return_offers flag is true

Thank you!

Hi,

I understand the need for a different type for the segments on OfferSlices and OrderSlices, due to some fields being unavailable before placing an order, or others being irrelevant after the order is placed, but I'm interested to know more about why OfferSliceSegment destinations/origins are Airports, but on the OrderSlice segments they are Places, implying they could be a City instead.

Looking at the docs it actually seems the destination/origin type is intended to be a Place, even on the offer. What does it mean for a segment to arrive at or depart from a city?

Finally, many of the fields on City are marked as nullable or even undefined, though the docs specify them as required and not nullable (e.g. latitude, longitude, timezone)

Thanks in advance 👍

Hi there, I am using a test token and I would like to know whether it exists any type of restriction in the number of pages, I am only receive one page in all requests.
Thanks for your time.