feat(booking): add new fields to passenger data (#258)

- add new loyalty programme fields to the OfferRequestPassenger interface and validate
- add unit test

Author: matthewp5

src/booking/OfferRequests/OfferRequests.spec.ts

@@ -1,5 +1,6 @@
 import nock from 'nock'
 import { Client } from '../../Client'
+import { CreateOfferRequest } from './OfferRequestsTypes'
 import { mockCreateOfferRequest, mockOfferRequest } from './mockOfferRequest'
 import { OfferRequests } from './OfferRequests'
 
@@ -49,6 +50,42 @@ describe('OfferRequests', () => {
     expect(response.data?.id).toBe(mockOfferRequest.id)
   })
 
+  test('should create an offer request and return an offer with passenger loyalty programme details', async () => {
+    const passengersWithLoyaltyProgrammes: CreateOfferRequest['passengers'] = [
+      {
+        type: 'adult',
+        given_name: 'Tony',
+        family_name: 'Stark',
+        loyalty_programme_accounts: [
+          {
+            account_number: '12901014',
+            airline_iata_code: 'BA'
+          }
+        ],
+      },
+    ]
+
+    const mockResponseWithLoyaltyProgrammes = {
+      ...mockOfferRequest,
+      passengers: [
+        {
+          ...passengersWithLoyaltyProgrammes[0],
+          id: 'pas_0000AD3shfu6ubXmZr5R1H'
+        },
+      ]
+    }
+
+    nock(/(.*)/)
+      .post('/air/offer_requests/')
+      .reply(200, { data: mockResponseWithLoyaltyProgrammes })
+
+    const response = await new OfferRequests(new Client({ token: 'mockToken' })).create({
+      ...mockCreateOfferRequest,
+      passengers: passengersWithLoyaltyProgrammes
+    })
+    expect(response.data?.passengers[0].loyalty_programme_accounts).toHaveLength(1)
+  })
+
   test('should create an offer request and no offers should return when requested', async () => {
     const mockResponseWithoutOffer = { ...mockOfferRequest }
     delete mockResponseWithoutOffer.offers

src/booking/OfferRequests/OfferRequests.ts

@@ -4,7 +4,8 @@ import {
   CreateOfferRequestQueryParameters,
   DuffelResponse,
   OfferRequest,
-  PaginationMeta
+  PaginationMeta,
+  ValidationError
 } from '../../types'
 
 /**
@@ -60,6 +61,17 @@ export class OfferRequests extends Resource {
     options: Partial<CreateOfferRequest & CreateOfferRequestQueryParameters>
   ): Promise<DuffelResponse<OfferRequest>> => {
     const { return_offers, ...data } = options
+
+    data.passengers && data.passengers.forEach(passenger => {
+      if (
+        passenger.loyalty_programme_accounts
+        && passenger.loyalty_programme_accounts.length > 0
+        && (!passenger.given_name || !passenger.family_name)
+      ) {
+        throw new ValidationError('loyalty programme requires family_name and given_name parameters')
+      }
+    })
+
     return this.request({
       method: 'POST',
       path: `${this.path}/`,

src/booking/OfferRequests/OfferRequestsTypes.ts

@@ -1,4 +1,4 @@
-import { CabinClass, Place, PlaceType } from '../../types'
+import { Airline, CabinClass, Place, PlaceType } from '../../types'
 import { Offer } from '../Offers/OfferTypes'
 
 export interface OfferRequestSlice {
@@ -42,6 +42,31 @@ export interface OfferRequestPassenger {
    */
   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.
@@ -50,6 +75,21 @@ export interface OfferRequestPassenger {
   id: string
 }
 
+/**
+ * The **Loyalty Programme Account** details.
+ */
+export interface LoyaltyProgrammeAccount {
+  /**
+   * 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: Airline['iata_code']
+}
+
 /**
  * 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).

src/types/ClientType.ts

@@ -86,6 +86,13 @@ export class DuffelError extends Error {
   }
 }
 
+export class ValidationError extends Error {
+  constructor(message: string) {
+    super('Invalid data: ' + message)
+    this.name = "ValidationError";
+  }
+}
+
 export interface SDKOptions {
   /**
    * If `true` it will output the path and the method called