apimatic-cp-sdk 0.0.1

data/lib/cell_point_api/models/apple_tokenized_token.rb

@@ -0,0 +1,143 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module CellPointApi
+  # AppleTokenizedToken Model.
+  class AppleTokenizedToken < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Card token identifier. Used for both cards and Apple Pay.
+    # @return [String]
+    attr_accessor :token
+
+    # When Apple Pay token will expire.
+    # TBD
+    # @return [DateTime]
+    attr_accessor :expires_at
+
+    # Display Payment Card Name.
+    # A string, suitable for display, that describes the card.
+    # For debit and credit cards, the display name often includes the card brand
+    # and the last four digits of the credit card number when available, for
+    # example: “************0492”, “Visa 1233”, “MasterCard 5678”, “AmEx 9876”.
+    # For Apple Pay Cash cards, the display name is “Apple Pay Cash”. However,
+    # there is no guarantee about the display name’s content or format.
+    # To protect the user’s privacy, Apple Pay sets the display name only after
+    # the user authorizes the purchase.
+    # @return [String]
+    attr_accessor :display_name
+
+    # Display Payment Card Name.
+    # A string, suitable for display, that describes the card.
+    # For debit and credit cards, the display name often includes the card brand
+    # and the last four digits of the credit card number when available, for
+    # example: “************0492”, “Visa 1233”, “MasterCard 5678”, “AmEx 9876”.
+    # For Apple Pay Cash cards, the display name is “Apple Pay Cash”. However,
+    # there is no guarantee about the display name’s content or format.
+    # To protect the user’s privacy, Apple Pay sets the display name only after
+    # the user authorizes the purchase.
+    # @return [String]
+    attr_accessor :order_id
+
+    # Card Scheme networks connects acquiring banks to issuing banks so that a
+    # customer transaction can be verified.
+    # Is a middle man that also provide additional services, such as data
+    # processing, international transactions, etc.
+    # @return [CardScheme]
+    attr_accessor :scheme
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['token'] = 'token'
+      @_hash['expires_at'] = 'expiresAt'
+      @_hash['display_name'] = 'displayName'
+      @_hash['order_id'] = 'orderId'
+      @_hash['scheme'] = 'scheme'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        expires_at
+        display_name
+        order_id
+        scheme
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(token:, expires_at: SKIP, display_name: SKIP, order_id: SKIP,
+                   scheme: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @token = token
+      @expires_at = expires_at unless expires_at == SKIP
+      @display_name = display_name unless display_name == SKIP
+      @order_id = order_id unless order_id == SKIP
+      @scheme = scheme unless scheme == 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.
+      token = hash.key?('token') ? hash['token'] : nil
+      expires_at = if hash.key?('expiresAt')
+                     (DateTimeHelper.from_rfc3339(hash['expiresAt']) if hash['expiresAt'])
+                   else
+                     SKIP
+                   end
+      display_name = hash.key?('displayName') ? hash['displayName'] : SKIP
+      order_id = hash.key?('orderId') ? hash['orderId'] : SKIP
+      scheme = hash.key?('scheme') ? hash['scheme'] : 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.
+      AppleTokenizedToken.new(token: token,
+                              expires_at: expires_at,
+                              display_name: display_name,
+                              order_id: order_id,
+                              scheme: scheme,
+                              additional_properties: additional_properties)
+    end
+
+    def to_custom_expires_at
+      DateTimeHelper.to_rfc3339(expires_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} token: #{@token}, expires_at: #{@expires_at}, display_name:"\
+      " #{@display_name}, order_id: #{@order_id}, scheme: #{@scheme}, 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} token: #{@token.inspect}, expires_at: #{@expires_at.inspect}, display_name:"\
+      " #{@display_name.inspect}, order_id: #{@order_id.inspect}, scheme: #{@scheme.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/audience.rb

@@ -0,0 +1,36 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # The intended audience for the client assertion.
+  class Audience
+    AUDIENCE = [
+      # TODO: Write general description for PAYMENTS
+      PAYMENTS = 'payments'.freeze,
+
+      # TODO: Write general description for DOCUMENTPROXY
+      DOCUMENTPROXY = 'document-proxy'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      AUDIENCE.include?(value)
+    end
+
+    def self.from_value(value, default_value = PAYMENTS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'payments' then PAYMENTS
+      when 'documentproxy' then DOCUMENTPROXY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/cell_point_api/models/authorization.rb

@@ -0,0 +1,145 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Contains the authorization request object.
+  class Authorization < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The payment instrument to be used for the authorization.
+    # @return [Object]
+    attr_accessor :payment_instrument
+
+    # Amount to be authorized related to the order, if it's null, the order's
+    # total amount will be authorized, if it's bigger than the order's total
+    # amount, no authorization will happen
+    # @return [NonNegativeAmount]
+    attr_accessor :amount
+
+    # Whether the Terms and Conditions have been accepted.
+    # Before the order can transition to a PAID state, the terms and conditions
+    # must be accepted.
+    # Each payment can mark itself as accepting those terms, but if the payments
+    # weren't marked so,
+    # an additional call to this `confirm-payments` operation in `Orders` would
+    # be required after all the payments have been made.
+    # The first payment to accept the terms and conditions accepts it for all
+    # further payments for the same order.
+    # Further requests to accept the terms and conditions do nothing.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_accepted_terms_and_conditions
+
+    # Custom data to attach to the authorization for tracking and analytical
+    # reasons by a merchant.
+    # > Note: These properties are not used by CellPoint Digital for any payment
+    # processing and will not be passed to any acquirers.
+    # @return [Hash[String, String]]
+    attr_accessor :custom
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payment_instrument'] = 'paymentInstrument'
+      @_hash['amount'] = 'amount'
+      @_hash['has_accepted_terms_and_conditions'] =
+        'hasAcceptedTermsAndConditions'
+      @_hash['custom'] = 'custom'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount
+        custom
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payment_instrument:, has_accepted_terms_and_conditions:,
+                   amount: SKIP, custom: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @payment_instrument = payment_instrument
+      @amount = amount unless amount == SKIP
+      @has_accepted_terms_and_conditions = has_accepted_terms_and_conditions
+      @custom = custom unless custom == 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.
+      payment_instrument = hash.key?('paymentInstrument') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:AuthorizationPaymentInstrument), hash['paymentInstrument']
+      ) : nil
+      has_accepted_terms_and_conditions =
+        hash.key?('hasAcceptedTermsAndConditions') ? hash['hasAcceptedTermsAndConditions'] : nil
+      amount = NonNegativeAmount.from_hash(hash['amount']) if hash['amount']
+      custom = hash.key?('custom') ? hash['custom'] : 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.
+      Authorization.new(payment_instrument: payment_instrument,
+                        has_accepted_terms_and_conditions: has_accepted_terms_and_conditions,
+                        amount: amount,
+                        custom: custom,
+                        additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Authorization | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          UnionTypeLookUp.get(:AuthorizationPaymentInstrument)
+                         .validate(value.payment_instrument) and
+            APIHelper.valid_type?(value.has_accepted_terms_and_conditions,
+                                  ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        UnionTypeLookUp.get(:AuthorizationPaymentInstrument)
+                       .validate(value['paymentInstrument']) and
+          APIHelper.valid_type?(value['hasAcceptedTermsAndConditions'],
+                                ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payment_instrument: #{@payment_instrument}, amount: #{@amount},"\
+      " has_accepted_terms_and_conditions: #{@has_accepted_terms_and_conditions}, custom:"\
+      " #{@custom}, 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} payment_instrument: #{@payment_instrument.inspect}, amount:"\
+      " #{@amount.inspect}, has_accepted_terms_and_conditions:"\
+      " #{@has_accepted_terms_and_conditions.inspect}, custom: #{@custom.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/authorization_group.rb

@@ -0,0 +1,99 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # A means of grouping line items together into separate authorizations for
+  # Aggregate Payments.
+  class AuthorizationGroup < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique id within the order for the authorization group.
+    # If an authorization group exists, all line items must correspond to an
+    # appropriate authorization group.
+    # @return [String]
+    attr_accessor :id
+
+    # Total amount of authorization. Should match the total when adding all line
+    # items with authorization group identifier.
+    # @return [NonNegativeAmount]
+    attr_accessor :total_amount
+
+    # Should only be specified for payments handled by an external supplier.
+    # @return [String]
+    attr_accessor :external_supplier
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['total_amount'] = 'totalAmount'
+      @_hash['external_supplier'] = 'externalSupplier'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        external_supplier
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id:, total_amount:, external_supplier: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @total_amount = total_amount
+      @external_supplier = external_supplier unless external_supplier == 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.
+      id = hash.key?('id') ? hash['id'] : nil
+      total_amount = NonNegativeAmount.from_hash(hash['totalAmount']) if hash['totalAmount']
+      external_supplier =
+        hash.key?('externalSupplier') ? hash['externalSupplier'] : 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.
+      AuthorizationGroup.new(id: id,
+                             total_amount: total_amount,
+                             external_supplier: external_supplier,
+                             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} id: #{@id}, total_amount: #{@total_amount}, external_supplier:"\
+      " #{@external_supplier}, 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}, total_amount: #{@total_amount.inspect},"\
+      " external_supplier: #{@external_supplier.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/authorization_group1.rb

@@ -0,0 +1,216 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # AuthorizationGroup1 Model.
+  class AuthorizationGroup1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique id within the order for the authorization group.
+    # If an authorization group exists, all line items must correspond to an
+    # appropriate authorization group.
+    # @return [String]
+    attr_accessor :id
+
+    # Total amount of authorization. Should match the total when adding all line
+    # items with authorization group identifier.
+    # @return [NonNegativeAmount]
+    attr_accessor :total_amount
+
+    # Should only be specified for payments handled by an external supplier.
+    # @return [String]
+    attr_accessor :external_supplier
+
+    # Statement descriptors to explain the charges or payments on bank
+    # statements.
+    # @return [String]
+    attr_accessor :statement_descriptor
+
+    # Merchant configured for authorization group to be processed with.
+    # > NOTE: By default if not passed, this will be the main merchant.
+    # # !!!! This is future documentation, for once we have multi-merchant
+    # payments. !!!!
+    # #
+    # # Passing different merchants in authorization groups will cause
+    # multi-merchant payments,
+    # # where money will be processed into different merchant accounts (MIDs).
+    # #
+    # # These sub-merchant must be configured on the main account in order to
+    # process with them.
+    # @return [String]
+    attr_accessor :merchant
+
+    # 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.
+    # @return [Type1]
+    attr_accessor :type
+
+    # List of payment transactions created against this authorization group.
+    # Multiple transactions may exist in the case of split payment.
+    # @return [Array[String]]
+    attr_accessor :transactions
+
+    # Stock Keeping Unit (SKU) is a product and service identification code for
+    # a specific product.
+    # @return [Array[String]]
+    attr_accessor :skus
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['total_amount'] = 'totalAmount'
+      @_hash['external_supplier'] = 'externalSupplier'
+      @_hash['statement_descriptor'] = 'statementDescriptor'
+      @_hash['merchant'] = 'merchant'
+      @_hash['type'] = 'type'
+      @_hash['transactions'] = 'transactions'
+      @_hash['skus'] = 'skus'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        external_supplier
+        statement_descriptor
+        merchant
+        type
+        transactions
+        skus
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id:, total_amount:, external_supplier: SKIP,
+                   statement_descriptor: SKIP, merchant: SKIP,
+                   type: Type1::PAYMENT, transactions: SKIP, skus: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @total_amount = total_amount
+      @external_supplier = external_supplier unless external_supplier == SKIP
+      @statement_descriptor = statement_descriptor unless statement_descriptor == SKIP
+      @merchant = merchant unless merchant == SKIP
+      @type = type unless type == SKIP
+      @transactions = transactions unless transactions == SKIP
+      @skus = skus unless skus == 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.
+      id = hash.key?('id') ? hash['id'] : nil
+      total_amount = NonNegativeAmount.from_hash(hash['totalAmount']) if hash['totalAmount']
+      external_supplier =
+        hash.key?('externalSupplier') ? hash['externalSupplier'] : SKIP
+      statement_descriptor =
+        hash.key?('statementDescriptor') ? hash['statementDescriptor'] : SKIP
+      merchant = hash.key?('merchant') ? hash['merchant'] : SKIP
+      type = hash['type'] ||= Type1::PAYMENT
+      transactions = hash.key?('transactions') ? hash['transactions'] : SKIP
+      skus = hash.key?('skus') ? hash['skus'] : 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.
+      AuthorizationGroup1.new(id: id,
+                              total_amount: total_amount,
+                              external_supplier: external_supplier,
+                              statement_descriptor: statement_descriptor,
+                              merchant: merchant,
+                              type: type,
+                              transactions: transactions,
+                              skus: skus,
+                              additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AuthorizationGroup1 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.id,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.total_amount,
+                                  ->(val) { NonNegativeAmount.validate(val) },
+                                  is_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['id'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['totalAmount'],
+                                ->(val) { NonNegativeAmount.validate(val) },
+                                is_model_hash: true)
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, total_amount: #{@total_amount}, external_supplier:"\
+      " #{@external_supplier}, statement_descriptor: #{@statement_descriptor}, merchant:"\
+      " #{@merchant}, type: #{@type}, transactions: #{@transactions}, skus: #{@skus},"\
+      " 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}, total_amount: #{@total_amount.inspect},"\
+      " external_supplier: #{@external_supplier.inspect}, statement_descriptor:"\
+      " #{@statement_descriptor.inspect}, merchant: #{@merchant.inspect}, type: #{@type.inspect},"\
+      " transactions: #{@transactions.inspect}, skus: #{@skus.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end