adyen-apimatic-sdk 1.0.0

data/lib/adyen_ap_is/models/additional_data_lodging.rb

@@ -0,0 +1,359 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # AdditionalDataLodging Model.
+  class AdditionalDataLodging < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A code that corresponds to the category of lodging charges for the
+    # payment. Possible values:
+    # * 1: Lodging
+    # * 2: No show reservation
+    # * 3: Advanced deposit
+    # @return [String]
+    attr_accessor :lodging_special_program_code
+
+    # The arrival date.
+    # * Date format: **yyyyMmDd**. For example, for 2023 April 22, **20230422**.
+    # @return [String]
+    attr_accessor :lodging_check_in_date
+
+    # The departure date.
+    # * Date format: **yyyyMmDd**. For example, for 2023 April 22, **20230422**.
+    # @return [String]
+    attr_accessor :lodging_check_out_date
+
+    # The toll-free phone number for the lodging.
+    # * Format: numeric
+    # * Max length: 17 characters.
+    # * For US and CA numbers must be 10 characters in length
+    # * Must not start with a space
+    # * Must not contain any special characters such as + or -
+    # * Must not be all zeros.
+    # @return [String]
+    attr_accessor :lodging_customer_service_toll_free_number
+
+    # Identifies that the facility complies with the Hotel and Motel Fire Safety
+    # Act of 1990. Must be 'Y' or 'N'.
+    # * Format: alphabetic
+    # * Max length: 1 character
+    # @return [String]
+    attr_accessor :lodging_fire_safety_act_indicator
+
+    # The folio cash advances, in [minor
+    # units](https://docs.adyen.com/development-resources/currency-codes).
+    # * Format: numeric
+    # * Max length: 12 characters
+    # @return [String]
+    attr_accessor :lodging_folio_cash_advances
+
+    # The card acceptor’s internal invoice or billing ID reference number.
+    # * Max length: 25 characters
+    # * Must not start with a space
+    # * Must not contain any special characters
+    # * Must not be all zeros.
+    # @return [String]
+    attr_accessor :lodging_folio_number
+
+    # Any charges for food and beverages associated with the booking, in [minor
+    # units](https://docs.adyen.com/development-resources/currency-codes).
+    # * Format: numeric
+    # * Max length: 12 characters
+    # @return [String]
+    attr_accessor :lodging_food_beverage_charges
+
+    # Indicates if the customer didn't check in for their booking.
+    #  Possible values: 
+    # * **Y**: the customer didn't check in 
+    # * **N**: the customer checked in
+    # @return [String]
+    attr_accessor :lodging_no_show_indicator
+
+    # The prepaid expenses for the booking.
+    # * Format: numeric
+    # * Max length: 12 characters
+    # @return [String]
+    attr_accessor :lodging_prepaid_expenses
+
+    # The lodging property location's phone number.
+    # * Format: numeric
+    # * Min length: 10 characters
+    # * Max length: 17 characters
+    # * For US and CA numbers must be 10 characters in length
+    # * Must not start with a space
+    # * Must not contain any special characters such as + or -
+    # * Must not be all zeros.
+    # @return [String]
+    attr_accessor :lodging_property_phone_number
+
+    # The total number of nights the room is booked for.
+    # * Format: numeric
+    # * Must be a number between 0 and 99
+    # * Max length: 4 characters
+    # @return [String]
+    attr_accessor :lodging_room1_number_of_nights
+
+    # The rate for the room, in [minor
+    # units](https://docs.adyen.com/development-resources/currency-codes).
+    # * Format: numeric
+    # * Max length: 12 characters
+    # * Must not be a negative number
+    # @return [String]
+    attr_accessor :lodging_room1_rate
+
+    # The total room tax amount, in [minor
+    # units](https://docs.adyen.com/development-resources/currency-codes).
+    # * Format: numeric
+    # * Max length: 12 characters
+    # * Must not be a negative number
+    # @return [String]
+    attr_accessor :lodging_total_room_tax
+
+    # The total tax amount, in [minor
+    # units](https://docs.adyen.com/development-resources/currency-codes).
+    # * Format: numeric
+    # * Max length: 12 characters
+    # * Must not be a negative number
+    # @return [String]
+    attr_accessor :lodging_total_tax
+
+    # The number of nights. This should be included in the auth message.
+    # * Format: numeric
+    # * Max length: 4 characters
+    # @return [String]
+    attr_accessor :travel_entertainment_auth_data_duration
+
+    # Indicates what market-specific dataset will be submitted. Must be 'H' for
+    # Hotel. This should be included in the auth message.
+    # * Format: alphanumeric
+    # * Max length: 1 character
+    # @return [String]
+    attr_accessor :travel_entertainment_auth_data_market
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['lodging_special_program_code'] = 'lodging.SpecialProgramCode'
+      @_hash['lodging_check_in_date'] = 'lodging.checkInDate'
+      @_hash['lodging_check_out_date'] = 'lodging.checkOutDate'
+      @_hash['lodging_customer_service_toll_free_number'] =
+        'lodging.customerServiceTollFreeNumber'
+      @_hash['lodging_fire_safety_act_indicator'] =
+        'lodging.fireSafetyActIndicator'
+      @_hash['lodging_folio_cash_advances'] = 'lodging.folioCashAdvances'
+      @_hash['lodging_folio_number'] = 'lodging.folioNumber'
+      @_hash['lodging_food_beverage_charges'] = 'lodging.foodBeverageCharges'
+      @_hash['lodging_no_show_indicator'] = 'lodging.noShowIndicator'
+      @_hash['lodging_prepaid_expenses'] = 'lodging.prepaidExpenses'
+      @_hash['lodging_property_phone_number'] = 'lodging.propertyPhoneNumber'
+      @_hash['lodging_room1_number_of_nights'] =
+        'lodging.room1.numberOfNights'
+      @_hash['lodging_room1_rate'] = 'lodging.room1.rate'
+      @_hash['lodging_total_room_tax'] = 'lodging.totalRoomTax'
+      @_hash['lodging_total_tax'] = 'lodging.totalTax'
+      @_hash['travel_entertainment_auth_data_duration'] =
+        'travelEntertainmentAuthData.duration'
+      @_hash['travel_entertainment_auth_data_market'] =
+        'travelEntertainmentAuthData.market'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        lodging_special_program_code
+        lodging_check_in_date
+        lodging_check_out_date
+        lodging_customer_service_toll_free_number
+        lodging_fire_safety_act_indicator
+        lodging_folio_cash_advances
+        lodging_folio_number
+        lodging_food_beverage_charges
+        lodging_no_show_indicator
+        lodging_prepaid_expenses
+        lodging_property_phone_number
+        lodging_room1_number_of_nights
+        lodging_room1_rate
+        lodging_total_room_tax
+        lodging_total_tax
+        travel_entertainment_auth_data_duration
+        travel_entertainment_auth_data_market
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(lodging_special_program_code: SKIP,
+                   lodging_check_in_date: SKIP, lodging_check_out_date: SKIP,
+                   lodging_customer_service_toll_free_number: SKIP,
+                   lodging_fire_safety_act_indicator: SKIP,
+                   lodging_folio_cash_advances: SKIP,
+                   lodging_folio_number: SKIP,
+                   lodging_food_beverage_charges: SKIP,
+                   lodging_no_show_indicator: SKIP,
+                   lodging_prepaid_expenses: SKIP,
+                   lodging_property_phone_number: SKIP,
+                   lodging_room1_number_of_nights: SKIP,
+                   lodging_room1_rate: SKIP, lodging_total_room_tax: SKIP,
+                   lodging_total_tax: SKIP,
+                   travel_entertainment_auth_data_duration: SKIP,
+                   travel_entertainment_auth_data_market: SKIP)
+      unless lodging_special_program_code == SKIP
+        @lodging_special_program_code =
+          lodging_special_program_code
+      end
+      @lodging_check_in_date = lodging_check_in_date unless lodging_check_in_date == SKIP
+      @lodging_check_out_date = lodging_check_out_date unless lodging_check_out_date == SKIP
+      unless lodging_customer_service_toll_free_number == SKIP
+        @lodging_customer_service_toll_free_number =
+          lodging_customer_service_toll_free_number
+      end
+      unless lodging_fire_safety_act_indicator == SKIP
+        @lodging_fire_safety_act_indicator =
+          lodging_fire_safety_act_indicator
+      end
+      unless lodging_folio_cash_advances == SKIP
+        @lodging_folio_cash_advances =
+          lodging_folio_cash_advances
+      end
+      @lodging_folio_number = lodging_folio_number unless lodging_folio_number == SKIP
+      unless lodging_food_beverage_charges == SKIP
+        @lodging_food_beverage_charges =
+          lodging_food_beverage_charges
+      end
+      unless lodging_no_show_indicator == SKIP
+        @lodging_no_show_indicator =
+          lodging_no_show_indicator
+      end
+      @lodging_prepaid_expenses = lodging_prepaid_expenses unless lodging_prepaid_expenses == SKIP
+      unless lodging_property_phone_number == SKIP
+        @lodging_property_phone_number =
+          lodging_property_phone_number
+      end
+      unless lodging_room1_number_of_nights == SKIP
+        @lodging_room1_number_of_nights =
+          lodging_room1_number_of_nights
+      end
+      @lodging_room1_rate = lodging_room1_rate unless lodging_room1_rate == SKIP
+      @lodging_total_room_tax = lodging_total_room_tax unless lodging_total_room_tax == SKIP
+      @lodging_total_tax = lodging_total_tax unless lodging_total_tax == SKIP
+      unless travel_entertainment_auth_data_duration == SKIP
+        @travel_entertainment_auth_data_duration =
+          travel_entertainment_auth_data_duration
+      end
+      unless travel_entertainment_auth_data_market == SKIP
+        @travel_entertainment_auth_data_market =
+          travel_entertainment_auth_data_market
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      lodging_special_program_code =
+        hash.key?('lodging.SpecialProgramCode') ? hash['lodging.SpecialProgramCode'] : SKIP
+      lodging_check_in_date =
+        hash.key?('lodging.checkInDate') ? hash['lodging.checkInDate'] : SKIP
+      lodging_check_out_date =
+        hash.key?('lodging.checkOutDate') ? hash['lodging.checkOutDate'] : SKIP
+      lodging_customer_service_toll_free_number =
+        hash.key?('lodging.customerServiceTollFreeNumber') ? hash['lodging.customerServiceTollFreeNumber'] : SKIP
+      lodging_fire_safety_act_indicator =
+        hash.key?('lodging.fireSafetyActIndicator') ? hash['lodging.fireSafetyActIndicator'] : SKIP
+      lodging_folio_cash_advances =
+        hash.key?('lodging.folioCashAdvances') ? hash['lodging.folioCashAdvances'] : SKIP
+      lodging_folio_number =
+        hash.key?('lodging.folioNumber') ? hash['lodging.folioNumber'] : SKIP
+      lodging_food_beverage_charges =
+        hash.key?('lodging.foodBeverageCharges') ? hash['lodging.foodBeverageCharges'] : SKIP
+      lodging_no_show_indicator =
+        hash.key?('lodging.noShowIndicator') ? hash['lodging.noShowIndicator'] : SKIP
+      lodging_prepaid_expenses =
+        hash.key?('lodging.prepaidExpenses') ? hash['lodging.prepaidExpenses'] : SKIP
+      lodging_property_phone_number =
+        hash.key?('lodging.propertyPhoneNumber') ? hash['lodging.propertyPhoneNumber'] : SKIP
+      lodging_room1_number_of_nights =
+        hash.key?('lodging.room1.numberOfNights') ? hash['lodging.room1.numberOfNights'] : SKIP
+      lodging_room1_rate =
+        hash.key?('lodging.room1.rate') ? hash['lodging.room1.rate'] : SKIP
+      lodging_total_room_tax =
+        hash.key?('lodging.totalRoomTax') ? hash['lodging.totalRoomTax'] : SKIP
+      lodging_total_tax =
+        hash.key?('lodging.totalTax') ? hash['lodging.totalTax'] : SKIP
+      travel_entertainment_auth_data_duration =
+        hash.key?('travelEntertainmentAuthData.duration') ? hash['travelEntertainmentAuthData.duration'] : SKIP
+      travel_entertainment_auth_data_market =
+        hash.key?('travelEntertainmentAuthData.market') ? hash['travelEntertainmentAuthData.market'] : SKIP
+
+      # Create object from extracted values.
+      AdditionalDataLodging.new(lodging_special_program_code: lodging_special_program_code,
+                                lodging_check_in_date: lodging_check_in_date,
+                                lodging_check_out_date: lodging_check_out_date,
+                                lodging_customer_service_toll_free_number: lodging_customer_service_toll_free_number,
+                                lodging_fire_safety_act_indicator: lodging_fire_safety_act_indicator,
+                                lodging_folio_cash_advances: lodging_folio_cash_advances,
+                                lodging_folio_number: lodging_folio_number,
+                                lodging_food_beverage_charges: lodging_food_beverage_charges,
+                                lodging_no_show_indicator: lodging_no_show_indicator,
+                                lodging_prepaid_expenses: lodging_prepaid_expenses,
+                                lodging_property_phone_number: lodging_property_phone_number,
+                                lodging_room1_number_of_nights: lodging_room1_number_of_nights,
+                                lodging_room1_rate: lodging_room1_rate,
+                                lodging_total_room_tax: lodging_total_room_tax,
+                                lodging_total_tax: lodging_total_tax,
+                                travel_entertainment_auth_data_duration: travel_entertainment_auth_data_duration,
+                                travel_entertainment_auth_data_market: travel_entertainment_auth_data_market)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} lodging_special_program_code: #{@lodging_special_program_code},"\
+      " lodging_check_in_date: #{@lodging_check_in_date}, lodging_check_out_date:"\
+      " #{@lodging_check_out_date}, lodging_customer_service_toll_free_number:"\
+      " #{@lodging_customer_service_toll_free_number}, lodging_fire_safety_act_indicator:"\
+      " #{@lodging_fire_safety_act_indicator}, lodging_folio_cash_advances:"\
+      " #{@lodging_folio_cash_advances}, lodging_folio_number: #{@lodging_folio_number},"\
+      " lodging_food_beverage_charges: #{@lodging_food_beverage_charges},"\
+      " lodging_no_show_indicator: #{@lodging_no_show_indicator}, lodging_prepaid_expenses:"\
+      " #{@lodging_prepaid_expenses}, lodging_property_phone_number:"\
+      " #{@lodging_property_phone_number}, lodging_room1_number_of_nights:"\
+      " #{@lodging_room1_number_of_nights}, lodging_room1_rate: #{@lodging_room1_rate},"\
+      " lodging_total_room_tax: #{@lodging_total_room_tax}, lodging_total_tax:"\
+      " #{@lodging_total_tax}, travel_entertainment_auth_data_duration:"\
+      " #{@travel_entertainment_auth_data_duration}, travel_entertainment_auth_data_market:"\
+      " #{@travel_entertainment_auth_data_market}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} lodging_special_program_code: #{@lodging_special_program_code.inspect},"\
+      " lodging_check_in_date: #{@lodging_check_in_date.inspect}, lodging_check_out_date:"\
+      " #{@lodging_check_out_date.inspect}, lodging_customer_service_toll_free_number:"\
+      " #{@lodging_customer_service_toll_free_number.inspect}, lodging_fire_safety_act_indicator:"\
+      " #{@lodging_fire_safety_act_indicator.inspect}, lodging_folio_cash_advances:"\
+      " #{@lodging_folio_cash_advances.inspect}, lodging_folio_number:"\
+      " #{@lodging_folio_number.inspect}, lodging_food_beverage_charges:"\
+      " #{@lodging_food_beverage_charges.inspect}, lodging_no_show_indicator:"\
+      " #{@lodging_no_show_indicator.inspect}, lodging_prepaid_expenses:"\
+      " #{@lodging_prepaid_expenses.inspect}, lodging_property_phone_number:"\
+      " #{@lodging_property_phone_number.inspect}, lodging_room1_number_of_nights:"\
+      " #{@lodging_room1_number_of_nights.inspect}, lodging_room1_rate:"\
+      " #{@lodging_room1_rate.inspect}, lodging_total_room_tax:"\
+      " #{@lodging_total_room_tax.inspect}, lodging_total_tax: #{@lodging_total_tax.inspect},"\
+      ' travel_entertainment_auth_data_duration:'\
+      " #{@travel_entertainment_auth_data_duration.inspect},"\
+      " travel_entertainment_auth_data_market: #{@travel_entertainment_auth_data_market.inspect}>"
+    end
+  end
+end