apimatic-cp-sdk 0.0.1

data/lib/cell_point_api/models/airline_fare.rb

@@ -0,0 +1,348 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Represents an airline fare that is part of a bundle.
+  class AirlineFare < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Discriminator used to identify the type of line item.
+    # @return [String]
+    attr_reader :type
+
+    # What should be shown as the title of the line item on a receipt or billing
+    # summary.
+    # @return [String]
+    attr_accessor :title
+
+    # AuthorizationGroup that the line item should be part of for splitting
+    # authorizations for Aggregate Payments Payments.
+    # If this is set, there must be a matching AuthorizationGroup created in the
+    # PriceSummary.
+    # > NOTE: Items within a Bundle should not have an `authorizationGroupId`,
+    # they will use the same `authorizationGroupId` as the top-level bundle.
+    # @return [String]
+    attr_accessor :authorization_group_id
+
+    # Stock Keeping Unit (SKU) is a product and service identification code for
+    # a specific product.
+    # @return [String]
+    attr_accessor :sku
+
+    # Stock Keeping Unit (SKU) is a product and service identification code for
+    # a specific product.
+    # @return [Integer]
+    attr_accessor :quantity
+
+    # An amount that is a nonnegative number, i.e. {0, 1, 2, 3, 4, 5,…}
+    # @return [NonNegativeAmount]
+    attr_accessor :unit_price
+
+    # Total Price for the line item. Should be equal to `unitPrice` *
+    # `quantity`, if `unitPrice` is specified.
+    # @return [NonNegativeAmount]
+    attr_accessor :total_price
+
+    # Passenger Name Record.
+    # MUST match a PNR in `IndustryData.AirlineData`.
+    # @return [String]
+    attr_accessor :pnr
+
+    # Passenger Name Record.
+    # MUST match a PNR in `IndustryData.AirlineData`.
+    # @return [String]
+    attr_accessor :carrier_name
+
+    # Passenger Name Record.
+    # MUST match a PNR in `IndustryData.AirlineData`.
+    # @return [Array[String]]
+    attr_accessor :passenger_ids
+
+    # Passenger Name Record.
+    # MUST match a PNR in `IndustryData.AirlineData`.
+    # @return [Array[String]]
+    attr_accessor :fare_basis_codes
+
+    # Type of itinerary being booked for travel.
+    # <table>
+    # <thead>
+    #   <tr>
+    #     <th>Itinerary Type</th>
+    #     <th>Description</th>
+    #   </tr>
+    # </thead>
+    # <tbody>
+    #   <tr>
+    #     <td>ONE_WAY</td>
+    #     <td>Only a single journey is being taken, with no return journey
+    # booked.</td>
+    #   </tr>
+    #   <tr>
+    #     <td>ROUND_TRIP</td>
+    #     <td>Two journeys are being booked, one outbound and one inbound. Final
+    # inbound journey will be returning to where the traveler started.</td>
+    #   </tr>
+    #   <tr>
+    #     <td>MULTI_CITY</td>
+    #     <td>Multiple journeys are being booked at once between various
+    # cities.</td>
+    #   </tr>
+    # </tbody>
+    # </table>
+    # @return [ItineraryType]
+    attr_accessor :itinerary_type
+
+    # Segment of the journey. 
+    # Given an the following `ItineraryType`, here are the example
+    # JourneySegment to use:
+    # <table>
+    # <thead>
+    #   <tr>
+    #     <th>Itinerary Type</th>
+    #     <th>Journey Segment</th>
+    #     <th>Description</th>
+    #   </tr>
+    # </thead>
+    # <tbody>
+    #   <tr>
+    #     <td>ONE_WAY</td>
+    #     <td>OUTBOUND</td>
+    #     <td>Single Journey</td>
+    #   </tr>
+    #   <tr>
+    #     <td>ROUND_TRIP</td>
+    #     <td>OUTBOUND</td>
+    #     <td>First Journey, leaving.</td>
+    #   </tr>
+    #   <tr>
+    #     <td>ROUND_TRIP</td>
+    #     <td>INBOUND</td>
+    #     <td>Second Journey, returning.</td>
+    #   </tr>
+    #   <tr>
+    #     <td>MULTI_CITY</td>
+    #     <td>MULTI_CITY_1</td>
+    #     <td>First Journey </td>
+    #   </tr>
+    #   <tr>
+    #     <td>MULTI_CITY</td>
+    #     <td>MULTI_CITY_2</td>
+    #     <td>Second Journey </td>
+    #   </tr>
+    #   <tr>
+    #     <td>MULTI_CITY</td>
+    #     <td>MULTI_CITY_3</td>
+    #     <td>Third Journey </td>
+    #   </tr>
+    # </tbody>
+    # </table>
+    # @return [JourneySegment]
+    attr_accessor :journey_segment
+
+    # Passenger type code (PTC). IATA PTC values are 3-letter alphabetical.
+    # Example: ADT, SRC, CNN, INS.
+    # Commonly used codes include (but definitely not limited to):
+    # - `ADT`: Adult
+    # - `CNN`: Child
+    # - `INF`: Infant without a seat
+    # - `INS`: Infant with a seat
+    # - `SRC`: Senior Citizen
+    # However, several carriers use non-standard codes that can be up to 5
+    # alphanumeric characters.
+    # @return [String]
+    attr_accessor :passenger_type_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['title'] = 'title'
+      @_hash['authorization_group_id'] = 'authorizationGroupId'
+      @_hash['sku'] = 'sku'
+      @_hash['quantity'] = 'quantity'
+      @_hash['unit_price'] = 'unitPrice'
+      @_hash['total_price'] = 'totalPrice'
+      @_hash['pnr'] = 'pnr'
+      @_hash['carrier_name'] = 'carrierName'
+      @_hash['passenger_ids'] = 'passengerIds'
+      @_hash['fare_basis_codes'] = 'fareBasisCodes'
+      @_hash['itinerary_type'] = 'itineraryType'
+      @_hash['journey_segment'] = 'journeySegment'
+      @_hash['passenger_type_code'] = 'passengerTypeCode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        authorization_group_id
+        passenger_ids
+        journey_segment
+        passenger_type_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(title:, sku:, quantity: 1, unit_price:, total_price:, pnr:,
+                   carrier_name:, fare_basis_codes:, itinerary_type:,
+                   authorization_group_id: SKIP, passenger_ids: SKIP,
+                   journey_segment: SKIP, passenger_type_code: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = 'AIRLINE_FARE'
+      @title = title
+      @authorization_group_id = authorization_group_id unless authorization_group_id == SKIP
+      @sku = sku
+      @quantity = quantity
+      @unit_price = unit_price
+      @total_price = total_price
+      @pnr = pnr
+      @carrier_name = carrier_name
+      @passenger_ids = passenger_ids unless passenger_ids == SKIP
+      @fare_basis_codes = fare_basis_codes
+      @itinerary_type = itinerary_type
+      @journey_segment = journey_segment unless journey_segment == SKIP
+      @passenger_type_code = passenger_type_code unless passenger_type_code == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      title = hash.key?('title') ? hash['title'] : nil
+      sku = hash.key?('sku') ? hash['sku'] : nil
+      quantity = hash['quantity'] ||= 1
+      unit_price = NonNegativeAmount.from_hash(hash['unitPrice']) if hash['unitPrice']
+      total_price = NonNegativeAmount.from_hash(hash['totalPrice']) if hash['totalPrice']
+      pnr = hash.key?('pnr') ? hash['pnr'] : nil
+      carrier_name = hash.key?('carrierName') ? hash['carrierName'] : nil
+      fare_basis_codes =
+        hash.key?('fareBasisCodes') ? hash['fareBasisCodes'] : nil
+      itinerary_type = hash.key?('itineraryType') ? hash['itineraryType'] : nil
+      authorization_group_id =
+        hash.key?('authorizationGroupId') ? hash['authorizationGroupId'] : SKIP
+      passenger_ids = hash.key?('passengerIds') ? hash['passengerIds'] : SKIP
+      journey_segment =
+        hash.key?('journeySegment') ? hash['journeySegment'] : SKIP
+      passenger_type_code =
+        hash.key?('passengerTypeCode') ? hash['passengerTypeCode'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      AirlineFare.new(title: title,
+                      sku: sku,
+                      quantity: quantity,
+                      unit_price: unit_price,
+                      total_price: total_price,
+                      pnr: pnr,
+                      carrier_name: carrier_name,
+                      fare_basis_codes: fare_basis_codes,
+                      itinerary_type: itinerary_type,
+                      authorization_group_id: authorization_group_id,
+                      passenger_ids: passenger_ids,
+                      journey_segment: journey_segment,
+                      passenger_type_code: passenger_type_code,
+                      additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AirlineFare | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.type,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.title,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.sku,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.quantity,
+                                  ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.unit_price,
+                                  ->(val) { NonNegativeAmount.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.total_price,
+                                  ->(val) { NonNegativeAmount.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.pnr,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.carrier_name,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.fare_basis_codes,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.itinerary_type,
+                                  ->(val) { ItineraryType.validate(val) })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['type'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['title'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['sku'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['quantity'],
+                                ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['unitPrice'],
+                                ->(val) { NonNegativeAmount.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['totalPrice'],
+                                ->(val) { NonNegativeAmount.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['pnr'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['carrierName'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['fareBasisCodes'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['itineraryType'],
+                                ->(val) { ItineraryType.validate(val) })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, title: #{@title}, authorization_group_id:"\
+      " #{@authorization_group_id}, sku: #{@sku}, quantity: #{@quantity}, unit_price:"\
+      " #{@unit_price}, total_price: #{@total_price}, pnr: #{@pnr}, carrier_name:"\
+      " #{@carrier_name}, passenger_ids: #{@passenger_ids}, fare_basis_codes:"\
+      " #{@fare_basis_codes}, itinerary_type: #{@itinerary_type}, journey_segment:"\
+      " #{@journey_segment}, passenger_type_code: #{@passenger_type_code}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}, title: #{@title.inspect}, authorization_group_id:"\
+      " #{@authorization_group_id.inspect}, sku: #{@sku.inspect}, quantity: #{@quantity.inspect},"\
+      " unit_price: #{@unit_price.inspect}, total_price: #{@total_price.inspect}, pnr:"\
+      " #{@pnr.inspect}, carrier_name: #{@carrier_name.inspect}, passenger_ids:"\
+      " #{@passenger_ids.inspect}, fare_basis_codes: #{@fare_basis_codes.inspect}, itinerary_type:"\
+      " #{@itinerary_type.inspect}, journey_segment: #{@journey_segment.inspect},"\
+      " passenger_type_code: #{@passenger_type_code.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/airline_fare_data.rb

@@ -0,0 +1,217 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Airline specific data.
+  class AirlineFareData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Passenger Name Record.
+    # MUST match a PNR in `IndustryData.AirlineData`.
+    # @return [String]
+    attr_accessor :pnr
+
+    # Passenger Name Record.
+    # MUST match a PNR in `IndustryData.AirlineData`.
+    # @return [String]
+    attr_accessor :carrier_name
+
+    # Passenger Name Record.
+    # MUST match a PNR in `IndustryData.AirlineData`.
+    # @return [Array[String]]
+    attr_accessor :passenger_ids
+
+    # Passenger Name Record.
+    # MUST match a PNR in `IndustryData.AirlineData`.
+    # @return [Array[String]]
+    attr_accessor :fare_basis_codes
+
+    # Type of itinerary being booked for travel.
+    # <table>
+    # <thead>
+    #   <tr>
+    #     <th>Itinerary Type</th>
+    #     <th>Description</th>
+    #   </tr>
+    # </thead>
+    # <tbody>
+    #   <tr>
+    #     <td>ONE_WAY</td>
+    #     <td>Only a single journey is being taken, with no return journey
+    # booked.</td>
+    #   </tr>
+    #   <tr>
+    #     <td>ROUND_TRIP</td>
+    #     <td>Two journeys are being booked, one outbound and one inbound. Final
+    # inbound journey will be returning to where the traveler started.</td>
+    #   </tr>
+    #   <tr>
+    #     <td>MULTI_CITY</td>
+    #     <td>Multiple journeys are being booked at once between various
+    # cities.</td>
+    #   </tr>
+    # </tbody>
+    # </table>
+    # @return [ItineraryType]
+    attr_accessor :itinerary_type
+
+    # Segment of the journey. 
+    # Given an the following `ItineraryType`, here are the example
+    # JourneySegment to use:
+    # <table>
+    # <thead>
+    #   <tr>
+    #     <th>Itinerary Type</th>
+    #     <th>Journey Segment</th>
+    #     <th>Description</th>
+    #   </tr>
+    # </thead>
+    # <tbody>
+    #   <tr>
+    #     <td>ONE_WAY</td>
+    #     <td>OUTBOUND</td>
+    #     <td>Single Journey</td>
+    #   </tr>
+    #   <tr>
+    #     <td>ROUND_TRIP</td>
+    #     <td>OUTBOUND</td>
+    #     <td>First Journey, leaving.</td>
+    #   </tr>
+    #   <tr>
+    #     <td>ROUND_TRIP</td>
+    #     <td>INBOUND</td>
+    #     <td>Second Journey, returning.</td>
+    #   </tr>
+    #   <tr>
+    #     <td>MULTI_CITY</td>
+    #     <td>MULTI_CITY_1</td>
+    #     <td>First Journey </td>
+    #   </tr>
+    #   <tr>
+    #     <td>MULTI_CITY</td>
+    #     <td>MULTI_CITY_2</td>
+    #     <td>Second Journey </td>
+    #   </tr>
+    #   <tr>
+    #     <td>MULTI_CITY</td>
+    #     <td>MULTI_CITY_3</td>
+    #     <td>Third Journey </td>
+    #   </tr>
+    # </tbody>
+    # </table>
+    # @return [JourneySegment]
+    attr_accessor :journey_segment
+
+    # Passenger type code (PTC). IATA PTC values are 3-letter alphabetical.
+    # Example: ADT, SRC, CNN, INS.
+    # Commonly used codes include (but definitely not limited to):
+    # - `ADT`: Adult
+    # - `CNN`: Child
+    # - `INF`: Infant without a seat
+    # - `INS`: Infant with a seat
+    # - `SRC`: Senior Citizen
+    # However, several carriers use non-standard codes that can be up to 5
+    # alphanumeric characters.
+    # @return [String]
+    attr_accessor :passenger_type_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['pnr'] = 'pnr'
+      @_hash['carrier_name'] = 'carrierName'
+      @_hash['passenger_ids'] = 'passengerIds'
+      @_hash['fare_basis_codes'] = 'fareBasisCodes'
+      @_hash['itinerary_type'] = 'itineraryType'
+      @_hash['journey_segment'] = 'journeySegment'
+      @_hash['passenger_type_code'] = 'passengerTypeCode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        passenger_ids
+        journey_segment
+        passenger_type_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(pnr:, carrier_name:, fare_basis_codes:, itinerary_type:,
+                   passenger_ids: SKIP, journey_segment: SKIP,
+                   passenger_type_code: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @pnr = pnr
+      @carrier_name = carrier_name
+      @passenger_ids = passenger_ids unless passenger_ids == SKIP
+      @fare_basis_codes = fare_basis_codes
+      @itinerary_type = itinerary_type
+      @journey_segment = journey_segment unless journey_segment == SKIP
+      @passenger_type_code = passenger_type_code unless passenger_type_code == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      pnr = hash.key?('pnr') ? hash['pnr'] : nil
+      carrier_name = hash.key?('carrierName') ? hash['carrierName'] : nil
+      fare_basis_codes =
+        hash.key?('fareBasisCodes') ? hash['fareBasisCodes'] : nil
+      itinerary_type = hash.key?('itineraryType') ? hash['itineraryType'] : nil
+      passenger_ids = hash.key?('passengerIds') ? hash['passengerIds'] : SKIP
+      journey_segment =
+        hash.key?('journeySegment') ? hash['journeySegment'] : SKIP
+      passenger_type_code =
+        hash.key?('passengerTypeCode') ? hash['passengerTypeCode'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      AirlineFareData.new(pnr: pnr,
+                          carrier_name: carrier_name,
+                          fare_basis_codes: fare_basis_codes,
+                          itinerary_type: itinerary_type,
+                          passenger_ids: passenger_ids,
+                          journey_segment: journey_segment,
+                          passenger_type_code: passenger_type_code,
+                          additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} pnr: #{@pnr}, carrier_name: #{@carrier_name}, passenger_ids:"\
+      " #{@passenger_ids}, fare_basis_codes: #{@fare_basis_codes}, itinerary_type:"\
+      " #{@itinerary_type}, journey_segment: #{@journey_segment}, passenger_type_code:"\
+      " #{@passenger_type_code}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} pnr: #{@pnr.inspect}, carrier_name: #{@carrier_name.inspect},"\
+      " passenger_ids: #{@passenger_ids.inspect}, fare_basis_codes: #{@fare_basis_codes.inspect},"\
+      " itinerary_type: #{@itinerary_type.inspect}, journey_segment: #{@journey_segment.inspect},"\
+      " passenger_type_code: #{@passenger_type_code.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end