apimatic-cp-sdk 0.0.1

data/lib/cell_point_api/models/type.rb

@@ -0,0 +1,67 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # The type of line item <table>   <thead>     <tr>       <th>Line Item
+  # Type</th>       <th>Description</th>     </tr>   </thead>   <tbody>     <tr>
+  #       <td>ACTIVITY</td>       <td>Activities, such as tours, museum tickets,
+  # etc.</td>     </tr>     <tr>       <td>AIRLINE_ANCILLARY</td>
+  # <td>Ancillary services offered by airlines, such as baggage fees, seat
+  # upgrades, etc.</td>     </tr>     <tr>       <td>AIRLINE_FARE</td>
+  # <td>Fares for a flight.</td>     </tr>     <tr>       <td>AUTO_RENTAL</td>
+  #     <td>Auto rental</td>     </tr>     <tr>       <td>DISCOUNT</td>
+  # <td>Discount</td>     </tr>     <tr>       <td>LODGING_RESERVATION</td>
+  #  <td>Bookings of a room at a hotel, hostel, etc.</td>     </tr>     <tr>
+  #   <td>PRODUCT</td>       <td>Product is a catch-all for any other line item
+  # type not listed here.</td>     </tr>   </tbody> </table>
+  class Type
+    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 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?
+
+      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 'discount' then DISCOUNT
+      when 'lodging_reservation' then LODGING_RESERVATION
+      when 'product' then PRODUCT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/cell_point_api/models/type1.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 transaction that can be performed. <table> <tbody>   <tr>
+  # <td>PAYMENT</td>   <td>   A standard payment transaction processed by
+  # CellPoint.   <br/><br/>   This is the default type and represents a typical
+  # payment flow.   </td>   </tr>   <tr> <td>EXTERNAL</td>   <td>   An external
+  # transaction is one that is not processed by CellPoint,   but by an external
+  # third-party.   <br/><br/>   CellPoint takes no part in this transaction and
+  # is not responsible for the state.   <br/><br/>   This type of transaction
+  # will purely be created as an indicator to our system and in our   reporting
+  # applications, that a transaction has happened externally.   <br/><br/>   For
+  # the purposes of checking if an order is fully paid for, we will count
+  # external   transactions towards the completion. </td> </tr> </tbody>
+  # </table> > NOTE: By default, this will be a standard Payment.
+  class Type1
+    TYPE1 = [
+      # TODO: Write general description for PAYMENT
+      PAYMENT = 'PAYMENT'.freeze,
+
+      # TODO: Write general description for EXTERNAL
+      EXTERNAL = 'EXTERNAL'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE1.include?(value)
+    end
+
+    def self.from_value(value, default_value = PAYMENT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'payment' then PAYMENT
+      when 'external' then EXTERNAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/cell_point_api/models/type2.rb

@@ -0,0 +1,40 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Discriminator used to identify the type of transaction.
+  class Type2
+    TYPE2 = [
+      # TODO: Write general description for PAYMENT
+      PAYMENT = 'PAYMENT'.freeze,
+
+      # TODO: Write general description for REFUND
+      REFUND = 'REFUND'.freeze,
+
+      # TODO: Write general description for EXTERNAL
+      EXTERNAL = 'EXTERNAL'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE2.include?(value)
+    end
+
+    def self.from_value(value, default_value = PAYMENT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'payment' then PAYMENT
+      when 'refund' then REFUND
+      when 'external' then EXTERNAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/cell_point_api/models/type3.rb

@@ -0,0 +1,41 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Type of fraud assessment being performed. Options:   <table>     <thead>
+  #   <tr>         <th>Type</th>         <th>Description</th>       </tr>
+  # </thead>     <tbody>       <tr>         <td>PRE_AUTHORIZATION</td>
+  # <td>Assessment is performed before authorization.</td>       </tr>
+  # <tr>         <td>POST_AUTHORIZATION</td>         <td>Assessment is performed
+  # after authorization.</td>       </tr>     </tbody>   </table>
+  class Type3
+    TYPE3 = [
+      # TODO: Write general description for PRE_AUTHORIZATION
+      PRE_AUTHORIZATION = 'PRE_AUTHORIZATION'.freeze,
+
+      # TODO: Write general description for POST_AUTHORIZATION
+      POST_AUTHORIZATION = 'POST_AUTHORIZATION'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE3.include?(value)
+    end
+
+    def self.from_value(value, default_value = PRE_AUTHORIZATION)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'pre_authorization' then PRE_AUTHORIZATION
+      when 'post_authorization' then POST_AUTHORIZATION
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/cell_point_api/models/type4.rb

@@ -0,0 +1,56 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Type4.
+  class Type4
+    TYPE4 = [
+      # TODO: Write general description for CANCEL
+      CANCEL = 'CANCEL'.freeze,
+
+      # TODO: Write general description for CAPTURE
+      CAPTURE = 'CAPTURE'.freeze,
+
+      # TODO: Write general description for REFUND
+      REFUND = 'REFUND'.freeze,
+
+      # TODO: Write general description for CLOSE
+      CLOSE = 'CLOSE'.freeze,
+
+      # TODO: Write general description for RECONCILIATION
+      RECONCILIATION = 'RECONCILIATION'.freeze,
+
+      # TODO: Write general description for POST_AUTH_FRAUD_CHECK
+      POST_AUTH_FRAUD_CHECK = 'POST_AUTH_FRAUD_CHECK'.freeze,
+
+      # TODO: Write general description for REFUND_RETRY
+      REFUND_RETRY = 'REFUND_RETRY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE4.include?(value)
+    end
+
+    def self.from_value(value, default_value = CANCEL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'cancel' then CANCEL
+      when 'capture' then CAPTURE
+      when 'refund' then REFUND
+      when 'close' then CLOSE
+      when 'reconciliation' then RECONCILIATION
+      when 'post_auth_fraud_check' then POST_AUTH_FRAUD_CHECK
+      when 'refund_retry' then REFUND_RETRY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/cell_point_api/models/type5.rb

@@ -0,0 +1,78 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # The type of line item. Note that while in [Create
+  # Order](#tag/Orders/operation/create-order), there are additional fields with
+  # certain types of line items, on fulfillment -- as this data is already known
+  # from [Create Order](#tag/Orders/operation/create-order), it is unnecessary.
+  # Anything other than a `Discount`, just requires the level of details of a
+  # normal `Product` type. <table>   <thead>     <tr>       <th>Line Item
+  # Type</th>       <th>Description</th>     </tr>   </thead>   <tbody>     <tr>
+  #       <td>ACTIVITY</td>       <td>Activities, such as tours, museum tickets,
+  # etc.</td>     </tr>     <tr>       <td>AIRLINE_ANCILLARY</td>
+  # <td>Ancillary services offered by airlines, such as baggage fees, seat
+  # upgrades, etc.</td>     </tr>     <tr>       <td>AIRLINE_FARE</td>
+  # <td>Fares for a flight.</td>     </tr>     <tr>       <td>AUTO_RENTAL</td>
+  #     <td>Auto rental</td>     </tr>     <tr>       <td>BUNDLE</td>
+  # <td>A collection of line items and products have been packaged together into
+  # a single unit.</td>     </tr>     <tr>       <td>DISCOUNT</td>
+  # <td>Discount</td>     </tr>     <tr>       <td>LODGING_RESERVATION</td>
+  #  <td>Bookings of a room at a hotel, hostel, etc.</td>     </tr>     <tr>
+  #   <td>PRODUCT</td>       <td>Product is a catch-all for any other line item
+  # type not listed here.</td>     </tr>   </tbody> </table>
+  class Type5
+    TYPE5 = [
+      # 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?
+
+      TYPE5.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

data/lib/cell_point_api/models/uplift_config.rb

@@ -0,0 +1,73 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Configuration for Uplift.
+  class UpliftConfig < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Merchant's Uplift client ID
+    # @return [String]
+    attr_accessor :up_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['up_id'] = 'upId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(up_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @up_id = up_id
+      @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.
+      up_id = hash.key?('upId') ? hash['upId'] : nil
+
+      # 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.
+      UpliftConfig.new(up_id: up_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} up_id: #{@up_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} up_id: #{@up_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/uplift_payment_instrument.rb

@@ -0,0 +1,102 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # The Uplift payment instrument used in the transaction.
+  class UpliftPaymentInstrument < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Discriminator for Uplift payment instrument.
+    # @return [String]
+    attr_reader :method
+
+    # Merchant's Uplift client ID
+    # @return [String]
+    attr_accessor :up_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['method'] = 'method'
+      @_hash['up_id'] = 'upId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(up_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @method = 'UPLIFT'
+      @up_id = up_id
+      @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.
+      up_id = hash.key?('upId') ? hash['upId'] : nil
+
+      # 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.
+      UpliftPaymentInstrument.new(up_id: up_id,
+                                  additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [UpliftPaymentInstrument | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.method,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.up_id,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['method'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['upId'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} method: #{@method}, up_id: #{@up_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} method: #{@method.inspect}, up_id: #{@up_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/vehicle.rb

@@ -0,0 +1,139 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # A vehicle that is being rented from an automobile rental company.
+  class Vehicle < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :description
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :vehicle_type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :manufacturer
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :model
+
+    # Number of doors the vehicle has.
+    # @return [Integer]
+    attr_accessor :num_doors
+
+    # Number of passengers (excluding driver) that the vehicle can hold.
+    # > Example: A four seat car can hold 3 passengers.
+    # @return [Integer]
+    attr_accessor :passenger_capacity
+
+    # If vehicle has air conditioning.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :airconditioned
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['description'] = 'description'
+      @_hash['vehicle_type'] = 'vehicleType'
+      @_hash['manufacturer'] = 'manufacturer'
+      @_hash['model'] = 'model'
+      @_hash['num_doors'] = 'numDoors'
+      @_hash['passenger_capacity'] = 'passengerCapacity'
+      @_hash['airconditioned'] = 'airconditioned'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        vehicle_type
+        manufacturer
+        model
+        num_doors
+        passenger_capacity
+        airconditioned
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(description:, vehicle_type: SKIP, manufacturer: SKIP,
+                   model: SKIP, num_doors: SKIP, passenger_capacity: SKIP,
+                   airconditioned: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @description = description
+      @vehicle_type = vehicle_type unless vehicle_type == SKIP
+      @manufacturer = manufacturer unless manufacturer == SKIP
+      @model = model unless model == SKIP
+      @num_doors = num_doors unless num_doors == SKIP
+      @passenger_capacity = passenger_capacity unless passenger_capacity == SKIP
+      @airconditioned = airconditioned unless airconditioned == 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.
+      description = hash.key?('description') ? hash['description'] : nil
+      vehicle_type = hash.key?('vehicleType') ? hash['vehicleType'] : SKIP
+      manufacturer = hash.key?('manufacturer') ? hash['manufacturer'] : SKIP
+      model = hash.key?('model') ? hash['model'] : SKIP
+      num_doors = hash.key?('numDoors') ? hash['numDoors'] : SKIP
+      passenger_capacity =
+        hash.key?('passengerCapacity') ? hash['passengerCapacity'] : SKIP
+      airconditioned =
+        hash.key?('airconditioned') ? hash['airconditioned'] : 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.
+      Vehicle.new(description: description,
+                  vehicle_type: vehicle_type,
+                  manufacturer: manufacturer,
+                  model: model,
+                  num_doors: num_doors,
+                  passenger_capacity: passenger_capacity,
+                  airconditioned: airconditioned,
+                  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} description: #{@description}, vehicle_type: #{@vehicle_type}, manufacturer:"\
+      " #{@manufacturer}, model: #{@model}, num_doors: #{@num_doors}, passenger_capacity:"\
+      " #{@passenger_capacity}, airconditioned: #{@airconditioned}, 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} description: #{@description.inspect}, vehicle_type:"\
+      " #{@vehicle_type.inspect}, manufacturer: #{@manufacturer.inspect}, model:"\
+      " #{@model.inspect}, num_doors: #{@num_doors.inspect}, passenger_capacity:"\
+      " #{@passenger_capacity.inspect}, airconditioned: #{@airconditioned.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end