Merge pull request #1072 from duffelhq/igorp1/tsp-512-add-users-array-to-createorder-and-staysbookingpayload

Adds user related types to order and booking creation

Author: igorp1

src/Stays/Bookings/Bookings.spec.ts

@@ -17,6 +17,7 @@ const mockBookingParams: StaysBookingPayload = {
   metadata: {
     customer_reference_number: 'ABXYZZ53Z',
   },
+  users: ['icu_00009htyDGjIfajdNBZRlw'],
 }
 
 const duffel = new Duffel({ token: 'mockToken' })

src/Stays/Bookings/Bookings.ts

@@ -9,12 +9,23 @@ export interface StaysBookingPayload {
   guests: Array<{
     given_name: string
     family_name: string
+    /**
+     * Creates an association between the guest and a previously created user.
+     * This is intended to allow guests the ability to manage their own bookings.
+     * @example ["icu_0000000000000000000000"]
+     */
+    user_id?: string
   }>
   email: string
   phone_number: string
   accommodation_special_requests?: string
   payment?: { card_id: string } | { three_d_secure_session_id: string }
   metadata?: StaysBooking['metadata']
+  /**
+   * The ids of users that would be allowed to manage the booking.
+   * @example ["icu_0000000000000000000000"]
+   */
+  users?: string[]
 }
 
 export class Bookings extends Resource {

src/Stays/mocks.ts

@@ -239,6 +239,7 @@ export const MOCK_CREATE_BOOKING_PAYLOAD: StaysBookingPayload = {
   email: '[email protected]',
   phone_number: '+44 07242242424',
   accommodation_special_requests: '',
+  users: ['icu_00009htyDGjIfajdNBZRlw'],
 }
 
 export const MOCK_QUOTE: StaysQuote = {

src/booking/Orders/OrdersTypes.ts

@@ -213,6 +213,13 @@ export interface CreateOrderPassenger extends Omit<OrderPassenger, 'type'> {
    */
   identity_documents?: OrderPassengerIdentityDocument[]
 
+  /**
+   * Creates an association between the passenger and a previously created user.
+   * This is intended to allow passengers the ability to manage their own orders.
+   * @example "icu_0000000000000000000000"
+   */
+  user_id?: string
+
   /**
    * The passenger's email address
    * @example "[email protected]"
@@ -630,6 +637,12 @@ export interface CreateOrder {
    */
   type: 'instant' | 'pay_later'
 
+  /**
+   * The ids of users that would be allowed to manage the order.
+   * @example ["icu_0000000000000000000000"]
+   */
+  users?: string[]
+
   /**
    * Metadata contains a set of key-value pairs that you can attach to an object. It can be useful for storing additional information about the object, in a structured format. Duffel does not use this information. You should not store sensitive information in this field.
    *

src/booking/Orders/mockOrders.ts

@@ -40,8 +40,10 @@ export const mockCreateOrderRequest: CreateOrder = {
       family_name: 'Earhart',
       email: '[email protected]',
       born_on: '1987-07-24',
+      user_id: 'icu_00009htyDGjIfajdNBZRlw',
     },
   ],
+  users: ['icu_00009htyDGjIfajdNBZRlw'],
 }
 
 export const mockOrder: Order = {