Merge pull request #1131 from duffelhq/thep/grnd-249-add-cars-api-to-javascript-sdk

Add Cars rental API to the SDK

Author: Thepnathi

src/Cars/Bookings/Bookings.spec.ts

@@ -0,0 +1,54 @@
+import nock from 'nock'
+import { Duffel } from '../../index'
+import { MOCK_BOOKING, MOCK_CREATE_BOOKING_PAYLOAD } from '../mocks'
+
+const duffel = new Duffel({ token: 'mockToken' })
+describe('Cars/Bookings', () => {
+  afterEach(() => {
+    nock.cleanAll()
+  })
+
+  it('should post to /cars/bookings when `create` is called', async () => {
+    const mockResponse = { data: MOCK_BOOKING }
+
+    nock(/(.*)/)
+      .post('/cars/bookings', (body) => {
+        expect(body.data).toEqual(MOCK_CREATE_BOOKING_PAYLOAD)
+        return true
+      })
+      .reply(200, mockResponse)
+
+    const response = await duffel.cars.bookings.create(
+      MOCK_CREATE_BOOKING_PAYLOAD,
+    )
+    expect(response.data).toEqual(mockResponse.data)
+  })
+
+  it('should get /cars/bookings/{id} when `get` is called', async () => {
+    const bookingId = 'boo_0000Cx4Af0b5l45AT50eqO'
+    const mockResponse = { data: MOCK_BOOKING }
+
+    nock(/(.*)/).get(`/cars/bookings/${bookingId}`).reply(200, mockResponse)
+
+    const response = await duffel.cars.bookings.get(bookingId)
+    expect(response.data).toEqual(mockResponse.data)
+  })
+
+  it('should post to /cars/bookings/{id}/actions/cancel when `cancel` is called', async () => {
+    const bookingId = 'boo_0000Cx4Af0b5l45AT50eqO'
+    const mockResponse = {
+      data: {
+        ...MOCK_BOOKING,
+        status: 'cancelled',
+        cancelled_at: '2024-01-16T10:00:00Z',
+      },
+    }
+
+    nock(/(.*)/)
+      .post(`/cars/bookings/${bookingId}/actions/cancel`)
+      .reply(200, mockResponse)
+
+    const response = await duffel.cars.bookings.cancel(bookingId)
+    expect(response.data).toEqual(mockResponse.data)
+  })
+})

src/Cars/Bookings/Bookings.ts

@@ -0,0 +1,73 @@
+import { Client } from '../../Client'
+import { CarsBooking } from '../CarsTypes'
+import { Resource } from '../../Resource'
+import { DuffelResponse } from '../../types'
+
+export interface CarsBookingPayload {
+  quote_id: string
+  driver: {
+    given_name: string
+    family_name: string
+    email: string
+    phone_number: string
+    date_of_birth: string
+    user_id?: string
+  }
+  inbound_flight_number?: string
+  supplier_loyalty_programme_account_number?: string
+  payment?: {
+    method: 'card'
+    card_id: string
+  }
+  metadata?: Record<string, string>
+  users?: string[]
+}
+
+export class Bookings extends Resource {
+  /**
+   * Endpoint path
+   */
+  path: string
+
+  constructor(client: Client) {
+    super(client)
+    this.path = 'cars/bookings'
+  }
+
+  /**
+   * Create a booking from a quote
+   * @param {object} payload - The booking payload, including quote id and driver information
+   */
+  public create = async (
+    payload: CarsBookingPayload,
+  ): Promise<DuffelResponse<CarsBooking>> =>
+    this.request({
+      method: 'POST',
+      path: this.path,
+      data: payload,
+    })
+
+  /**
+   * Get a booking by ID
+   * @param {string} bookingId - The ID of the booking
+   */
+  public get = async (
+    bookingId: string,
+  ): Promise<DuffelResponse<CarsBooking>> =>
+    this.request({
+      method: 'GET',
+      path: `${this.path}/${bookingId}`,
+    })
+
+  /**
+   * Cancel a booking
+   * @param {string} bookingId - The ID of the booking to cancel
+   */
+  public cancel = async (
+    bookingId: string,
+  ): Promise<DuffelResponse<CarsBooking>> =>
+    this.request({
+      method: 'POST',
+      path: `${this.path}/${bookingId}/actions/cancel`,
+    })
+}

src/Cars/Bookings/index.ts

@@ -0,0 +1 @@
+export * from './Bookings'

src/Cars/Cars.spec.ts

@@ -0,0 +1,24 @@
+import nock from 'nock'
+import { Duffel } from '../index'
+import { MOCK_SEARCH, MOCK_SEARCH_PARAMS } from './mocks'
+
+const duffel = new Duffel({ token: 'mockToken' })
+describe('Cars', () => {
+  afterEach(() => {
+    nock.cleanAll()
+  })
+
+  it('should post to /cars/search when `search` is called', async () => {
+    const mockResponse = { data: MOCK_SEARCH }
+
+    nock(/(.*)/)
+      .post('/cars/search', (body) => {
+        expect(body.data).toEqual(MOCK_SEARCH_PARAMS)
+        return true
+      })
+      .reply(200, mockResponse)
+
+    const response = await duffel.cars.search(MOCK_SEARCH_PARAMS)
+    expect(response.data).toEqual(mockResponse.data)
+  })
+})

src/Cars/Cars.ts

@@ -0,0 +1,33 @@
+import { Client } from '../Client'
+import { CarsSearchParams, CarsSearch } from './CarsTypes'
+import { Resource } from '../Resource'
+import { DuffelResponse } from '../types'
+import { Bookings } from './Bookings'
+import { Quotes } from './Quotes'
+
+export class Cars extends Resource {
+  /**
+   * Endpoint path
+   */
+  path: string
+
+  public bookings: Bookings
+  public quotes: Quotes
+
+  constructor(client: Client) {
+    super(client)
+    this.path = 'cars'
+
+    this.bookings = new Bookings(client)
+    this.quotes = new Quotes(client)
+  }
+
+  /**
+   * Search for available rental cars
+   * @param {object} params - The search parameters
+   */
+  public search = async (
+    params: CarsSearchParams,
+  ): Promise<DuffelResponse<CarsSearch>> =>
+    this.request({ method: 'POST', path: `${this.path}/search`, data: params })
+}