Add missing types (#968)

__what__ We started using the types from our client library in our dashboard and in doing so identified a few things we can improve and other bits that need fixing. This addresses the gaps we found. Please see the comments for links to documentation to compare with. --------- Co-authored-by: Igor <igordepaula1@gmail.com>
duffelhq · Oct 10, 2024 · d0a80d8 · d0a80d8
1 parent ebec324
commit d0a80d8
Show file tree

Hide file tree

Showing 26 changed files with 473 additions and 550 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -55,11 +55,13 @@ module.exports = {
           '&nbsp;',
           '^[-\\w]+/[-\\w\\.]+$',
           '^[a-z]{3,4}_[a-zA-Z0-9]{21,23}$',
-          'pas_00009hj8USM7Ncg31cBCLL',
-          'ord_00009hthhsUZ8W4LxQgkjo',
-          'ser_00009UhD4ongolulWd9123',
-          'seg_00009hj8USM7Ncg31cB456',
-          'pit_00009htYpSCXrwaB9DnUm2',
+          'pas_[a-zA-Z0-9]{22}',
+          'ord_[a-zA-Z0-9]{22}',
+          'ser_[a-zA-Z0-9]{22}',
+          'seg_[a-zA-Z0-9]{22}',
+          'sto_[a-zA-Z0-9]{22}',
+          'pit_[a-zA-Z0-9]{22}',
+          'quo_[a-zA-Z0-9]{22}',
           'g2wAAAACbQAAABBBZXJvbWlzdC1LaGFya2l2bQAAAB=',
           'Earhart',
           'Embraer',

diff --git a/src/Places/Suggestions/mockSuggestions.ts b/src/Places/Suggestions/mockSuggestions.ts
@@ -18,6 +18,7 @@ export const mockPlacesSuggestionsResponse: Places = {
     id: 'cit_lon_gb',
     iata_country_code: 'GB',
     iata_code: 'LON',
+    type: 'city',
   },
   airports: [
     {
@@ -30,11 +31,14 @@ export const mockPlacesSuggestionsResponse: Places = {
       iata_country_code: 'GB',
       iata_code: 'LHR',
       city_name: 'London',
+      type: 'airport',
+      iata_city_code: 'LON',
       city: {
         name: 'London',
         id: 'cit_lon_gb',
         iata_country_code: 'GB',
         iata_code: 'LON',
+        type: 'city',
       },
     },
   ],

diff --git a/src/Stays/StaysTypes.ts b/src/Stays/StaysTypes.ts
@@ -13,6 +13,7 @@ export interface StaysBed {
 }
 
 export interface StaysRating {
+  // eslint-disable-next-line spellcheck/spell-checker
   /**
    * The source of this rating. Possible values: `"aaa"` (American Automobile Association Diamond Rating), `"northstar"` (Northstar Crown Rating), `"priceline"` (Priceline star rating)
    */

diff --git a/src/Stays/mocks.ts b/src/Stays/mocks.ts
@@ -165,6 +165,7 @@ export const MOCK_BOOKING: StaysBooking = {
   email: 'jean@example.com',
   phone_number: '+4407242242424',
   status: 'confirmed',
+  // eslint-disable-next-line spellcheck/spell-checker
   reference: 'dhg-4692ARxBI85qTkbDDEZMO8',
   id: 'bok_0000ARxBI85qTkbDDEZMO3',
   confirmed_at: '2022-12-20T15:45:03.000000Z',
@@ -173,7 +174,7 @@ export const MOCK_BOOKING: StaysBooking = {
   cancelled_at: null,
   guests: [
     {
-      given_name: 'Raiden',
+      given_name: 'John',
       family_name: 'Ei',
     },
   ],
@@ -194,7 +195,7 @@ export const MOCK_CREATE_BOOKING_PAYLOAD: StaysBookingPayload = {
   guests: [
     {
       given_name: 'Jean',
-      family_name: 'Gunnhildr',
+      family_name: 'Gun',
     },
   ],
   email: 'jean@example.com',

diff --git a/src/booking/AirlineInitiatedChanges/AirlineInitiatedChangesTypes.ts b/src/booking/AirlineInitiatedChanges/AirlineInitiatedChangesTypes.ts
@@ -11,6 +11,17 @@ export type AirlineInitiatedChangeAvailableAction =
   | 'change'
   | 'update'
 
+/**
+ * The associated Travel Agent Ticket, if any, for this Airline-Initiated Change.
+ * This value will be present for Airline-Initiated changes that take some time to be processed.
+ */
+export interface TravelAgentTicket {
+  id: string
+  external_ticket_id: string
+}
+
+type EmptyObject = Record<string, unknown>
+
 export interface AirlineInitiatedChange {
   /**
    * The action taken in response to this airline-initiated change. Accepted,
@@ -66,7 +77,7 @@ export interface AirlineInitiatedChange {
    * Change. This value will be present for Airline-Initiated changes that take
    * some time to be processed.
    */
-  travel_agent_ticket: any | null
+  travel_agent_ticket: TravelAgentTicket | EmptyObject | null
 
   /**
    * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which

diff --git a/src/booking/AirlineInitiatedChanges/mockAirlineInitiatedChanges.ts b/src/booking/AirlineInitiatedChanges/mockAirlineInitiatedChanges.ts
@@ -11,6 +11,7 @@ export const mockAirlineInitiatedChange: AirlineInitiatedChange = {
           penalty_amount: '100.00',
           allowed: true,
         },
+        refund_before_departure: null,
       },
       destination_type: 'airport',
       origin_type: 'airport',
@@ -23,6 +24,9 @@ export const mockAirlineInitiatedChange: AirlineInitiatedChange = {
               baggages: [],
             },
           ],
+          origin_terminal: 'A',
+          destination_terminal: '1',
+          stops: [],
           origin: {
             time_zone: 'Europe/London',
             name: 'Heathrow Airport',
@@ -34,11 +38,13 @@ export const mockAirlineInitiatedChange: AirlineInitiatedChange = {
             iata_code: 'LHR',
             iata_city_code: 'LON',
             city_name: 'London',
+            type: 'airport',
             city: {
               name: 'London',
               id: 'cit_lon_gb',
               iata_country_code: 'GB',
               iata_code: 'LON',
+              type: 'city',
             },
           },
           operating_carrier_flight_number: '0472',
@@ -67,7 +73,7 @@ export const mockAirlineInitiatedChange: AirlineInitiatedChange = {
           },
           id: 'seg_00009htYpSCXrwaB9Dn456',
           duration: 'PT2H10M',
-          distance: null,
+          distance: '123.1',
           destination: {
             time_zone: 'Europe/Madrid',
             name: 'Barcelona–El Prat Josep Tarradellas Airport',
@@ -80,6 +86,7 @@ export const mockAirlineInitiatedChange: AirlineInitiatedChange = {
             iata_city_code: 'BCN',
             city_name: 'Barcelona',
             city: null,
+            type: 'airport',
           },
           departing_at: '2023-03-26T06:15:00',
           arriving_at: '2023-03-26T09:25:00',
@@ -101,11 +108,13 @@ export const mockAirlineInitiatedChange: AirlineInitiatedChange = {
         iata_code: 'LHR',
         iata_city_code: 'LON',
         city_name: 'London',
+        type: 'airport',
         city: {
           name: 'London',
           id: 'cit_lon_gb',
           iata_country_code: 'GB',
           iata_code: 'LON',
+          type: 'city',
         },
       },
       id: 'sli_00009htYpSCXrwaB9Dn123',
@@ -122,6 +131,7 @@ export const mockAirlineInitiatedChange: AirlineInitiatedChange = {
         iata_city_code: 'BCN',
         city_name: 'Barcelona',
         city: null,
+        type: 'airport',
       },
     },
   ],
@@ -137,6 +147,7 @@ export const mockAirlineInitiatedChange: AirlineInitiatedChange = {
           penalty_amount: '100.00',
           allowed: true,
         },
+        refund_before_departure: null,
       },
       destination_type: 'airport',
       origin_type: 'airport',
@@ -149,6 +160,9 @@ export const mockAirlineInitiatedChange: AirlineInitiatedChange = {
               baggages: [],
             },
           ],
+          destination_terminal: '1',
+          origin_terminal: 'B',
+          stops: [],
           origin: {
             time_zone: 'Europe/London',
             name: 'Heathrow Airport',
@@ -160,11 +174,13 @@ export const mockAirlineInitiatedChange: AirlineInitiatedChange = {
             iata_code: 'LHR',
             iata_city_code: 'LON',
             city_name: 'London',
+            type: 'airport',
             city: {
               name: 'London',
               id: 'cit_lon_gb',
               iata_country_code: 'GB',
               iata_code: 'LON',
+              type: 'city',
             },
           },
           operating_carrier_flight_number: '0474',
@@ -193,7 +209,7 @@ export const mockAirlineInitiatedChange: AirlineInitiatedChange = {
           },
           id: 'seg_00009htYpSCXrwaB9Dn457',
           duration: 'PT2H15M',
-          distance: null,
+          distance: '42.1',
           destination: {
             time_zone: 'Europe/Madrid',
             name: 'Barcelona–El Prat Josep Tarradellas Airport',
@@ -206,10 +222,12 @@ export const mockAirlineInitiatedChange: AirlineInitiatedChange = {
             iata_city_code: 'BCN',
             city_name: 'Barcelona',
             city: null,
+            type: 'airport',
           },
           departing_at: '2023-03-28T11:00:00',
           arriving_at: '2023-03-28T14:15:00',
           aircraft: {
+            // eslint-disable-next-line spellcheck/spell-checker
             name: 'Airbus A320neo',
             id: 'arc_00009lcSPZuSbgKG1u4Pkn',
             iata_code: '32N',
@@ -227,11 +245,13 @@ export const mockAirlineInitiatedChange: AirlineInitiatedChange = {
         iata_code: 'LHR',
         iata_city_code: 'LON',
         city_name: 'London',
+        type: 'airport',
         city: {
           name: 'London',
           id: 'cit_lon_gb',
           iata_country_code: 'GB',
           iata_code: 'LON',
+          type: 'city',
         },
       },
       id: 'sli_00009htYpSCXrwaB9Dn124',
@@ -247,6 +267,7 @@ export const mockAirlineInitiatedChange: AirlineInitiatedChange = {
         iata_code: 'BCN',
         iata_city_code: 'BCN',
         city_name: 'Barcelona',
+        type: 'airport',
         city: null,
       },
     },

diff --git a/src/booking/Identity/ComponentClientKey/ComponentClientKeys.spec.ts b/src/booking/Identity/ComponentClientKey/ComponentClientKeys.spec.ts
@@ -18,6 +18,7 @@ describe('component client keys', () => {
     ).create()
 
     const regex_to_match_jwt = new RegExp(
+      // eslint-disable-next-line spellcheck/spell-checker
       'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.[a-zA-Z0-9_-]*.[a-zA-Z0-9_-]*',
     )
     expect(response.data.component_client_key).toMatch(regex_to_match_jwt)

diff --git a/src/booking/Identity/ComponentClientKey/mockComponentClientKey.ts b/src/booking/Identity/ComponentClientKey/mockComponentClientKey.ts
@@ -2,5 +2,6 @@ import { type ComponentClientKey } from './types'
 
 export const mockComponentClientKey: ComponentClientKey = {
   component_client_key:
+    // eslint-disable-next-line spellcheck/spell-checker
     'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoiaWN1XzAwMDBBZ1ppdHBPblF0ZDNOUXhqd08iLCJvcmRlcl9pZCI6Im9yZF8wMDAwQUJkWm5nZ1NjdDdCb3JhVTFvIiwiaWF0IjoxNTE2MjM5MDIyfQ.GtJDKrfum7aLlNaXmUj-RtQIbx0-Opwjdid0fiJk6DE',
 }
diff --git a/src/booking/OfferRequests/OfferRequestsTypes.ts b/src/booking/OfferRequests/OfferRequestsTypes.ts
@@ -1,7 +1,7 @@
 import {
   Airline,
   CabinClass,
-  DuffelPassengerType,
+  PassengerType,
   Place,
   PlaceType,
 } from '../../types'
@@ -75,7 +75,7 @@ export interface CreateOfferRequestAdultPassenger
    * specify their `age` instead of a `type`. A passenger can have only a type
    * or an age, but not both.
    */
-  type: Extract<DuffelPassengerType, 'adult'>
+  type: Extract<PassengerType, 'adult'>
 }
 
 export interface CreateOfferRequestNonAdultPassenger
@@ -157,7 +157,7 @@ export interface OfferRequestPassenger {
   /**
    * The type of the passenger.
    */
-  type?: DuffelPassengerType
+  type?: PassengerType
 
   /**
    * The passenger's family name. Only `space`, `-`, `'`, and letters from the `ASCII`, `Latin-1 Supplement` and `Latin

diff --git a/src/booking/OfferRequests/mockOfferRequest.ts b/src/booking/OfferRequests/mockOfferRequest.ts
@@ -42,26 +42,8 @@ export const mockOfferRequest: OfferRequest = {
           id: 'cit_lon_gb',
           iata_country_code: 'GB',
           iata_code: 'LON',
+          type: 'city',
         },
-        airports: [
-          {
-            time_zone: 'Europe/London',
-            name: 'Heathrow',
-            longitude: -141.951519,
-            latitude: 64.068865,
-            id: 'arp_lhr_gb',
-            icao_code: 'EGLL',
-            iata_country_code: 'GB',
-            iata_code: 'LHR',
-            city_name: 'London',
-            city: {
-              name: 'London',
-              id: 'cit_lon_gb',
-              iata_country_code: 'GB',
-              iata_code: 'LON',
-            },
-          },
-        ],
       },
       destination_type: 'airport',
       destination: {
@@ -81,26 +63,8 @@ export const mockOfferRequest: OfferRequest = {
           id: 'cit_lon_gb',
           iata_country_code: 'GB',
           iata_code: 'LON',
+          type: 'city',
         },
-        airports: [
-          {
-            time_zone: 'Europe/London',
-            name: 'Heathrow',
-            longitude: -141.951519,
-            latitude: 64.068865,
-            id: 'arp_lhr_gb',
-            icao_code: 'EGLL',
-            iata_country_code: 'GB',
-            iata_code: 'LHR',
-            city_name: 'London',
-            city: {
-              name: 'London',
-              id: 'cit_lon_gb',
-              iata_country_code: 'GB',
-              iata_code: 'LON',
-            },
-          },
-        ],
       },
       departure_date: '2020-04-24',
     },
-Original file line number
+Diff line change
@@ Expand Up / @@ -13,6 +13,7 @@ export interface StaysBed { @@
     }
     export interface StaysRating {
+      // eslint-disable-next-line spellcheck/spell-checker
       /**
        * The source of this rating. Possible values: `"aaa"` (American Automobile Association Diamond Rating), `"northstar"` (Northstar Crown Rating), `"priceline"` (Priceline star rating)
        */
@@ Expand Down @@