apimatic-cp-sdk 0.0.1

data/lib/cell_point_api/models/order_status.rb

@@ -0,0 +1,161 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Status on the order level.
+  class OrderStatus < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Status of the order.
+    # <table>
+    #   <thead>
+    #     <tr>
+    #       <th>Type</th>
+    #       <th>Description</th>
+    #     </tr>
+    #   </thead>
+    #   <tbody>
+    #     <tr>
+    #       <td>ACTIVE</td>
+    #       <td>Order is currently active and is pending payment.</td>
+    #     </tr>
+    #     <tr>
+    #       <td>CANCELED</td>
+    #       <td>Order has been canceled. See `reason` for why order has been
+    # canceled.</td>
+    #     </tr>
+    #     <tr>
+    #       <td>PAID</td>
+    #       <td>Order has been fully paid for by the buyer. There are now
+    # transactions associated with the order.</td>
+    #     </tr>
+    #     <tr>
+    #       <td>FULFILLED</td>
+    #       <td>Order has been fulfilled by the merchant.</td>
+    #     </tr>
+    #     <tr>
+    #       <td>COMPLETED</td>
+    #       <td>Order has been marked as complete and all transactions have been
+    # captured.</td>
+    #     </tr>
+    #   </tbody>
+    # </table>
+    # @return [OrderStatusType]
+    attr_accessor :type
+
+    # Reason that the order was canceled.
+    # Will only be sent if order state is `CANCELED`.
+    # <table>
+    #   <thead>
+    #     <tr>
+    #       <th>Type</th>
+    #       <th>Description</th>
+    #     </tr>
+    #   </thead>
+    #   <tbody>
+    #     <tr>
+    #       <td>ABANDONED</td>
+    #       <td>Order has been abandoned. Time is out to complete payment.
+    # Please create a new order.</td>
+    #     </tr>
+    #     <tr>
+    #       <td>FULFILLMENT_FAILURE</td>
+    #       <td>Order was unable to be fulfilled by the merchant. All
+    # transactions have been canceled.</td>
+    #     </tr>
+    #     <tr>
+    #       <td>FRAUD_REJECT</td>
+    #       <td>Order was canceled due to the detection of fraud.</td>
+    #     </tr>
+    #     <tr>
+    #       <td>MAXIMUM_NUMBER_OF_PAYMENT_ATTEMPTS_EXCEEDED</td>
+    #       <td>Order was canceled because the maximum number of payment
+    # attempts has been exceeded on every possible payment method</td>
+    #     </tr>
+    #   </tbody>
+    # </table>
+    # @return [OrderCanceledReason]
+    attr_accessor :reason
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['reason'] = 'reason'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reason
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type:, reason: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type
+      @reason = reason unless reason == 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.
+      type = hash.key?('type') ? hash['type'] : nil
+      reason = hash.key?('reason') ? hash['reason'] : 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.
+      OrderStatus.new(type: type,
+                      reason: reason,
+                      additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [OrderStatus | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.type,
+                                     ->(val) { OrderStatusType.validate(val) })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['type'],
+                            ->(val) { OrderStatusType.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}, reason: #{@reason}, 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}, reason: #{@reason.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/order_status_type.rb

@@ -0,0 +1,58 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Status of the order. <table>   <thead>     <tr>       <th>Type</th>
+  # <th>Description</th>     </tr>   </thead>   <tbody>     <tr>
+  # <td>ACTIVE</td>       <td>Order is currently active and is pending
+  # payment.</td>     </tr>     <tr>       <td>CANCELED</td>       <td>Order has
+  # been canceled. See `reason` for why order has been canceled.</td>     </tr>
+  #    <tr>       <td>PAID</td>       <td>Order has been fully paid for by the
+  # buyer. There are now transactions associated with the order.</td>     </tr>
+  #    <tr>       <td>FULFILLED</td>       <td>Order has been fulfilled by the
+  # merchant.</td>     </tr>     <tr>       <td>COMPLETED</td>       <td>Order
+  # has been marked as complete and all transactions have been captured.</td>
+  #  </tr>   </tbody> </table>
+  class OrderStatusType
+    ORDER_STATUS_TYPE = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'ACTIVE'.freeze,
+
+      # TODO: Write general description for CANCELED
+      CANCELED = 'CANCELED'.freeze,
+
+      # TODO: Write general description for PAID
+      PAID = 'PAID'.freeze,
+
+      # TODO: Write general description for FULFILLED
+      FULFILLED = 'FULFILLED'.freeze,
+
+      # TODO: Write general description for COMPLETED
+      COMPLETED = 'COMPLETED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ORDER_STATUS_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = ACTIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'active' then ACTIVE
+      when 'canceled' then CANCELED
+      when 'paid' then PAID
+      when 'fulfilled' then FULFILLED
+      when 'completed' then COMPLETED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/cell_point_api/models/order_transactions.rb

@@ -0,0 +1,88 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # List of transactions associated with an order.
+  class OrderTransactions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[Object]]
+    attr_accessor :transactions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transactions'] = 'transactions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transactions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transactions: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @transactions = transactions unless transactions == 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.
+      transactions = hash.key?('transactions') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:Transaction), hash['transactions']
+      ) : 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.
+      OrderTransactions.new(transactions: transactions,
+                            additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [OrderTransactions | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transactions: #{@transactions}, 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} transactions: #{@transactions.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/owner.rb

@@ -0,0 +1,131 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Owner Model.
+  class Owner < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :loyalty_account_id
+
+    # Name bestowed upon an individual to differentiate them from other members
+    # of a group that share a family name. 
+    # In the U.S., the first name of a Person.
+    # @return [String]
+    attr_accessor :given_name
+
+    # Name bestowed upon an individual to denote membership in a group or
+    # family. 
+    # In the U.S., the last name of a Person.
+    # @return [String]
+    attr_accessor :family_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['loyalty_account_id'] = 'loyaltyAccountId'
+      @_hash['given_name'] = 'givenName'
+      @_hash['family_name'] = 'familyName'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        loyalty_account_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(given_name:, family_name:, id: SKIP,
+                   loyalty_account_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @loyalty_account_id = loyalty_account_id unless loyalty_account_id == SKIP
+      @given_name = given_name
+      @family_name = family_name
+      @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.
+      given_name = hash.key?('givenName') ? hash['givenName'] : nil
+      family_name = hash.key?('familyName') ? hash['familyName'] : nil
+      id = hash.key?('id') ? hash['id'] : SKIP
+      loyalty_account_id =
+        hash.key?('loyaltyAccountId') ? hash['loyaltyAccountId'] : 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.
+      Owner.new(given_name: given_name,
+                family_name: family_name,
+                id: id,
+                loyalty_account_id: loyalty_account_id,
+                additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Owner | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.given_name,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.family_name,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['givenName'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['familyName'],
+                                ->(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} id: #{@id}, loyalty_account_id: #{@loyalty_account_id}, given_name:"\
+      " #{@given_name}, family_name: #{@family_name}, 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} id: #{@id.inspect}, loyalty_account_id: #{@loyalty_account_id.inspect},"\
+      " given_name: #{@given_name.inspect}, family_name: #{@family_name.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/page_type.rb

@@ -0,0 +1,26 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Type of page to use for the Hosted Payment Page.
+  class PageType
+    PAGE_TYPE = [
+      # TODO: Write general description for FULL_PAGE_REDIRECT
+      FULL_PAGE_REDIRECT = 'FULL_PAGE_REDIRECT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PAGE_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = FULL_PAGE_REDIRECT)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/cell_point_api/models/passenger.rb

@@ -0,0 +1,229 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Passenger that is traveling.
+  class Passenger < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name bestowed upon an individual to differentiate them from other members
+    # of a group that share a family name. 
+    # In the U.S., the first name of a Person.
+    # @return [String]
+    attr_accessor :given_name
+
+    # Name bestowed upon an individual to denote membership in a group or
+    # family. 
+    # In the U.S., the last name of a Person.
+    # @return [String]
+    attr_accessor :family_name
+
+    # Secondary name bestowed upon an individual to differentiate them from
+    # others that have the same given name.
+    # @return [String]
+    attr_accessor :middle_name
+
+    # The portion of a name's full form of address that precedes the name
+    # itself.
+    # @return [String]
+    attr_accessor :name_prefix
+
+    # The portion of a name's full form of address that follows the name itself.
+    # @return [String]
+    attr_accessor :name_suffix
+
+    # The shopper's date of birth.
+    # Format ISO-8601: YYYY-MM-DD
+    # @return [Date]
+    attr_accessor :date_of_birth
+
+    # Genders for individuals
+    # @return [Gender]
+    attr_accessor :gender
+
+    # User email address
+    # @return [String]
+    attr_accessor :email
+
+    # Telephone number.
+    # @return [Phone]
+    attr_accessor :phone
+
+    # Identifier for passenger that is unique within this order.
+    # This identifier should be used for any reference to this passenger
+    # elsewhere,
+    # such as fares or ancillaries in the price summary.
+    # How this identifier is generated is up to the merchant, as long as it is
+    # unique within the order.
+    # @return [String]
+    attr_accessor :id
+
+    # 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 :type
+
+    # 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 [Array[IdentifyingDocument]]
+    attr_accessor :documents
+
+    # Loyalty account information.
+    # @return [LoyaltyAccount]
+    attr_accessor :loyalty_account
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['given_name'] = 'givenName'
+      @_hash['family_name'] = 'familyName'
+      @_hash['middle_name'] = 'middleName'
+      @_hash['name_prefix'] = 'namePrefix'
+      @_hash['name_suffix'] = 'nameSuffix'
+      @_hash['date_of_birth'] = 'dateOfBirth'
+      @_hash['gender'] = 'gender'
+      @_hash['email'] = 'email'
+      @_hash['phone'] = 'phone'
+      @_hash['id'] = 'id'
+      @_hash['type'] = 'type'
+      @_hash['documents'] = 'documents'
+      @_hash['loyalty_account'] = 'loyaltyAccount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        middle_name
+        name_prefix
+        name_suffix
+        date_of_birth
+        gender
+        email
+        phone
+        documents
+        loyalty_account
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(given_name:, family_name:, id:, type:, middle_name: SKIP,
+                   name_prefix: SKIP, name_suffix: SKIP, date_of_birth: SKIP,
+                   gender: SKIP, email: SKIP, phone: SKIP, documents: SKIP,
+                   loyalty_account: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @given_name = given_name
+      @family_name = family_name
+      @middle_name = middle_name unless middle_name == SKIP
+      @name_prefix = name_prefix unless name_prefix == SKIP
+      @name_suffix = name_suffix unless name_suffix == SKIP
+      @date_of_birth = date_of_birth unless date_of_birth == SKIP
+      @gender = gender unless gender == SKIP
+      @email = email unless email == SKIP
+      @phone = phone unless phone == SKIP
+      @id = id
+      @type = type
+      @documents = documents unless documents == SKIP
+      @loyalty_account = loyalty_account unless loyalty_account == 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.
+      given_name = hash.key?('givenName') ? hash['givenName'] : nil
+      family_name = hash.key?('familyName') ? hash['familyName'] : nil
+      id = hash.key?('id') ? hash['id'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      middle_name = hash.key?('middleName') ? hash['middleName'] : SKIP
+      name_prefix = hash.key?('namePrefix') ? hash['namePrefix'] : SKIP
+      name_suffix = hash.key?('nameSuffix') ? hash['nameSuffix'] : SKIP
+      date_of_birth = hash.key?('dateOfBirth') ? hash['dateOfBirth'] : SKIP
+      gender = hash.key?('gender') ? hash['gender'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      phone = Phone.from_hash(hash['phone']) if hash['phone']
+      # Parameter is an array, so we need to iterate through it
+      documents = nil
+      unless hash['documents'].nil?
+        documents = []
+        hash['documents'].each do |structure|
+          documents << (IdentifyingDocument.from_hash(structure) if structure)
+        end
+      end
+
+      documents = SKIP unless hash.key?('documents')
+      loyalty_account = LoyaltyAccount.from_hash(hash['loyaltyAccount']) if hash['loyaltyAccount']
+
+      # 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.
+      Passenger.new(given_name: given_name,
+                    family_name: family_name,
+                    id: id,
+                    type: type,
+                    middle_name: middle_name,
+                    name_prefix: name_prefix,
+                    name_suffix: name_suffix,
+                    date_of_birth: date_of_birth,
+                    gender: gender,
+                    email: email,
+                    phone: phone,
+                    documents: documents,
+                    loyalty_account: loyalty_account,
+                    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} given_name: #{@given_name}, family_name: #{@family_name}, middle_name:"\
+      " #{@middle_name}, name_prefix: #{@name_prefix}, name_suffix: #{@name_suffix},"\
+      " date_of_birth: #{@date_of_birth}, gender: #{@gender}, email: #{@email}, phone: #{@phone},"\
+      " id: #{@id}, type: #{@type}, documents: #{@documents}, loyalty_account:"\
+      " #{@loyalty_account}, 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} given_name: #{@given_name.inspect}, family_name: #{@family_name.inspect},"\
+      " middle_name: #{@middle_name.inspect}, name_prefix: #{@name_prefix.inspect}, name_suffix:"\
+      " #{@name_suffix.inspect}, date_of_birth: #{@date_of_birth.inspect}, gender:"\
+      " #{@gender.inspect}, email: #{@email.inspect}, phone: #{@phone.inspect}, id:"\
+      " #{@id.inspect}, type: #{@type.inspect}, documents: #{@documents.inspect}, loyalty_account:"\
+      " #{@loyalty_account.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end