apimatic-cp-sdk 0.0.1

data/lib/cell_point_api/models/identifying_document_type.rb

@@ -0,0 +1,60 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Identification document types.
+  class IdentifyingDocumentType
+    IDENTIFYING_DOCUMENT_TYPE = [
+      # TODO: Write general description for PASSPORT
+      PASSPORT = 'PASSPORT'.freeze,
+
+      # TODO: Write general description for ID_CARD
+      ID_CARD = 'ID_CARD'.freeze,
+
+      # TODO: Write general description for DRIVING_LICENSE
+      DRIVING_LICENSE = 'DRIVING_LICENSE'.freeze,
+
+      # TODO: Write general description for SOCIAL_SECURITY_NUMBER
+      SOCIAL_SECURITY_NUMBER = 'SOCIAL_SECURITY_NUMBER'.freeze,
+
+      # TODO: Write general description for TAX_IDENTIFICATION_NUMBER
+      TAX_IDENTIFICATION_NUMBER = 'TAX_IDENTIFICATION_NUMBER'.freeze,
+
+      # TODO: Write general description for NATIONAL_INSURANCE_NUMBER
+      NATIONAL_INSURANCE_NUMBER = 'NATIONAL_INSURANCE_NUMBER'.freeze,
+
+      # TODO: Write general description for NATIONAL_IDENTITY_CARD
+      NATIONAL_IDENTITY_CARD = 'NATIONAL_IDENTITY_CARD'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      IDENTIFYING_DOCUMENT_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = PASSPORT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'passport' then PASSPORT
+      when 'id_card' then ID_CARD
+      when 'driving_license' then DRIVING_LICENSE
+      when 'social_security_number' then SOCIAL_SECURITY_NUMBER
+      when 'tax_identification_number' then TAX_IDENTIFICATION_NUMBER
+      when 'national_insurance_number' then NATIONAL_INSURANCE_NUMBER
+      when 'national_identity_card' then NATIONAL_IDENTITY_CARD
+      when 'other' then OTHER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/cell_point_api/models/industry_data.rb

@@ -0,0 +1,124 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Industry specific data required based on agreements between merchant and
+  # acquirers and for fraud detection.
+  class IndustryData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[AirlineIndustryData]]
+    attr_accessor :airline_data
+
+    # TODO: Write general description for this method
+    # @return [Array[LodgingIndustryData]]
+    attr_accessor :lodging_data
+
+    # TODO: Write general description for this method
+    # @return [Array[AutoRentalIndustryData]]
+    attr_accessor :auto_rental_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['airline_data'] = 'airlineData'
+      @_hash['lodging_data'] = 'lodgingData'
+      @_hash['auto_rental_data'] = 'autoRentalData'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        airline_data
+        lodging_data
+        auto_rental_data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(airline_data: SKIP, lodging_data: SKIP,
+                   auto_rental_data: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @airline_data = airline_data unless airline_data == SKIP
+      @lodging_data = lodging_data unless lodging_data == SKIP
+      @auto_rental_data = auto_rental_data unless auto_rental_data == 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.
+      # Parameter is an array, so we need to iterate through it
+      airline_data = nil
+      unless hash['airlineData'].nil?
+        airline_data = []
+        hash['airlineData'].each do |structure|
+          airline_data << (AirlineIndustryData.from_hash(structure) if structure)
+        end
+      end
+
+      airline_data = SKIP unless hash.key?('airlineData')
+      # Parameter is an array, so we need to iterate through it
+      lodging_data = nil
+      unless hash['lodgingData'].nil?
+        lodging_data = []
+        hash['lodgingData'].each do |structure|
+          lodging_data << (LodgingIndustryData.from_hash(structure) if structure)
+        end
+      end
+
+      lodging_data = SKIP unless hash.key?('lodgingData')
+      # Parameter is an array, so we need to iterate through it
+      auto_rental_data = nil
+      unless hash['autoRentalData'].nil?
+        auto_rental_data = []
+        hash['autoRentalData'].each do |structure|
+          auto_rental_data << (AutoRentalIndustryData.from_hash(structure) if structure)
+        end
+      end
+
+      auto_rental_data = SKIP unless hash.key?('autoRentalData')
+
+      # 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.
+      IndustryData.new(airline_data: airline_data,
+                       lodging_data: lodging_data,
+                       auto_rental_data: auto_rental_data,
+                       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} airline_data: #{@airline_data}, lodging_data: #{@lodging_data},"\
+      " auto_rental_data: #{@auto_rental_data}, 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} airline_data: #{@airline_data.inspect}, lodging_data:"\
+      " #{@lodging_data.inspect}, auto_rental_data: #{@auto_rental_data.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/informational_price_row.rb

@@ -0,0 +1,97 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Row to show for informational pricing.
+  class InformationalPriceRow < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Text to show the buyer, informing them of the title informational price
+    # row.
+    # @return [String]
+    attr_accessor :title
+
+    # The amount an item costs.
+    # @return [Amount]
+    attr_accessor :amount
+
+    # Optional descriptor that should appear with the amount. 
+    # This descriptor may not be available everywhere, depending on the design
+    # of the page.
+    # @return [String]
+    attr_accessor :amount_descriptor
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['title'] = 'title'
+      @_hash['amount'] = 'amount'
+      @_hash['amount_descriptor'] = 'amountDescriptor'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount_descriptor
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(title:, amount:, amount_descriptor: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @title = title
+      @amount = amount
+      @amount_descriptor = amount_descriptor unless amount_descriptor == 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
+      amount = Amount.from_hash(hash['amount']) if hash['amount']
+      amount_descriptor =
+        hash.key?('amountDescriptor') ? hash['amountDescriptor'] : 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.
+      InformationalPriceRow.new(title: title,
+                                amount: amount,
+                                amount_descriptor: amount_descriptor,
+                                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} title: #{@title}, amount: #{@amount}, amount_descriptor:"\
+      " #{@amount_descriptor}, 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} title: #{@title.inspect}, amount: #{@amount.inspect}, amount_descriptor:"\
+      " #{@amount_descriptor.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/informational_price_section.rb

@@ -0,0 +1,104 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Section of the informational price breakdown.
+  class InformationalPriceSection < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Optional type of row that can be passed.
+    # Depending on where this displayed, this field may or may not be used.
+    # @return [String]
+    attr_accessor :type
+
+    # Optional type of row that can be passed.
+    # Depending on where this displayed, this field may or may not be used.
+    # @return [Array[InformationalPriceRow]]
+    attr_accessor :rows
+
+    # Optional type of row that can be passed.
+    # Depending on where this displayed, this field may or may not be used.
+    # @return [TotalRow]
+    attr_accessor :total_row
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['rows'] = 'rows'
+      @_hash['total_row'] = 'totalRow'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(rows:, total_row:, type: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type unless type == SKIP
+      @rows = rows
+      @total_row = total_row
+      @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.
+      # Parameter is an array, so we need to iterate through it
+      rows = nil
+      unless hash['rows'].nil?
+        rows = []
+        hash['rows'].each do |structure|
+          rows << (InformationalPriceRow.from_hash(structure) if structure)
+        end
+      end
+
+      rows = nil unless hash.key?('rows')
+      total_row = TotalRow.from_hash(hash['totalRow']) if hash['totalRow']
+      type = hash.key?('type') ? hash['type'] : 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.
+      InformationalPriceSection.new(rows: rows,
+                                    total_row: total_row,
+                                    type: type,
+                                    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} type: #{@type}, rows: #{@rows}, total_row: #{@total_row},"\
+      " 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}, rows: #{@rows.inspect}, total_row:"\
+      " #{@total_row.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/itinerary_type.rb

@@ -0,0 +1,47 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # 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>
+  class ItineraryType
+    ITINERARY_TYPE = [
+      # TODO: Write general description for ONE_WAY
+      ONE_WAY = 'ONE_WAY'.freeze,
+
+      # TODO: Write general description for ROUND_TRIP
+      ROUND_TRIP = 'ROUND_TRIP'.freeze,
+
+      # TODO: Write general description for MULTI_CITY
+      MULTI_CITY = 'MULTI_CITY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ITINERARY_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = ONE_WAY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'one_way' then ONE_WAY
+      when 'round_trip' then ROUND_TRIP
+      when 'multi_city' then MULTI_CITY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/cell_point_api/models/journey_segment.rb

@@ -0,0 +1,83 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # 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>
+  class JourneySegment
+    JOURNEY_SEGMENT = [
+      # TODO: Write general description for OUTBOUND
+      OUTBOUND = 'OUTBOUND'.freeze,
+
+      # TODO: Write general description for INBOUND
+      INBOUND = 'INBOUND'.freeze,
+
+      # TODO: Write general description for MULTI_CITY_1
+      MULTI_CITY_1 = 'MULTI_CITY_1'.freeze,
+
+      # TODO: Write general description for MULTI_CITY_2
+      MULTI_CITY_2 = 'MULTI_CITY_2'.freeze,
+
+      # TODO: Write general description for MULTI_CITY_3
+      MULTI_CITY_3 = 'MULTI_CITY_3'.freeze,
+
+      # TODO: Write general description for MULTI_CITY_4
+      MULTI_CITY_4 = 'MULTI_CITY_4'.freeze,
+
+      # TODO: Write general description for MULTI_CITY_5
+      MULTI_CITY_5 = 'MULTI_CITY_5'.freeze,
+
+      # TODO: Write general description for MULTI_CITY_6
+      MULTI_CITY_6 = 'MULTI_CITY_6'.freeze,
+
+      # TODO: Write general description for MULTI_CITY_7
+      MULTI_CITY_7 = 'MULTI_CITY_7'.freeze,
+
+      # TODO: Write general description for MULTI_CITY_8
+      MULTI_CITY_8 = 'MULTI_CITY_8'.freeze,
+
+      # TODO: Write general description for MULTI_CITY_9
+      MULTI_CITY_9 = 'MULTI_CITY_9'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      JOURNEY_SEGMENT.include?(value)
+    end
+
+    def self.from_value(value, default_value = OUTBOUND)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'outbound' then OUTBOUND
+      when 'inbound' then INBOUND
+      when 'multi_city_1' then MULTI_CITY_1
+      when 'multi_city_2' then MULTI_CITY_2
+      when 'multi_city_3' then MULTI_CITY_3
+      when 'multi_city_4' then MULTI_CITY_4
+      when 'multi_city_5' then MULTI_CITY_5
+      when 'multi_city_6' then MULTI_CITY_6
+      when 'multi_city_7' then MULTI_CITY_7
+      when 'multi_city_8' then MULTI_CITY_8
+      when 'multi_city_9' then MULTI_CITY_9
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/cell_point_api/models/line_item_base.rb

@@ -0,0 +1,101 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Line item base. Represents the common fields shared across all billable
+  # items on an order.
+  class LineItemBase < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # What should be shown as the title of the line item on a receipt or billing
+    # summary.
+    # @return [String]
+    attr_accessor :title
+
+    # The type of line item.
+    # @return [LineItemType]
+    attr_accessor :type
+
+    # 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['title'] = 'title'
+      @_hash['type'] = 'type'
+      @_hash['authorization_group_id'] = 'authorizationGroupId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        authorization_group_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(title:, type:, authorization_group_id: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @title = title
+      @type = type
+      @authorization_group_id = authorization_group_id unless authorization_group_id == 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
+      type = hash.key?('type') ? hash['type'] : nil
+      authorization_group_id =
+        hash.key?('authorizationGroupId') ? hash['authorizationGroupId'] : 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.
+      LineItemBase.new(title: title,
+                       type: type,
+                       authorization_group_id: authorization_group_id,
+                       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} title: #{@title}, type: #{@type}, authorization_group_id:"\
+      " #{@authorization_group_id}, 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} title: #{@title.inspect}, type: #{@type.inspect}, authorization_group_id:"\
+      " #{@authorization_group_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/line_item_type.rb

@@ -0,0 +1,60 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # The type of line item.
+  class LineItemType
+    LINE_ITEM_TYPE = [
+      # TODO: Write general description for ACTIVITY
+      ACTIVITY = 'ACTIVITY'.freeze,
+
+      # TODO: Write general description for AIRLINE_ANCILLARY
+      AIRLINE_ANCILLARY = 'AIRLINE_ANCILLARY'.freeze,
+
+      # TODO: Write general description for AIRLINE_FARE
+      AIRLINE_FARE = 'AIRLINE_FARE'.freeze,
+
+      # TODO: Write general description for AUTO_RENTAL
+      AUTO_RENTAL = 'AUTO_RENTAL'.freeze,
+
+      # TODO: Write general description for BUNDLE
+      BUNDLE = 'BUNDLE'.freeze,
+
+      # TODO: Write general description for DISCOUNT
+      DISCOUNT = 'DISCOUNT'.freeze,
+
+      # TODO: Write general description for LODGING_RESERVATION
+      LODGING_RESERVATION = 'LODGING_RESERVATION'.freeze,
+
+      # TODO: Write general description for PRODUCT
+      PRODUCT = 'PRODUCT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      LINE_ITEM_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = ACTIVITY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'activity' then ACTIVITY
+      when 'airline_ancillary' then AIRLINE_ANCILLARY
+      when 'airline_fare' then AIRLINE_FARE
+      when 'auto_rental' then AUTO_RENTAL
+      when 'bundle' then BUNDLE
+      when 'discount' then DISCOUNT
+      when 'lodging_reservation' then LODGING_RESERVATION
+      when 'product' then PRODUCT
+      else
+        default_value
+      end
+    end
+  end
+end