apimatic-cp-sdk 0.0.1

data/lib/cell_point_api/models/payment_transaction_processing_fee.rb

@@ -0,0 +1,106 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # If there is a fee for using the payment method (i.e. $5 fee for using ACH),
+  # that should be included here.
+  class PaymentTransactionProcessingFee < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ISO 4217 currency code. Must be UPPERCASE.
+    # @return [String]
+    attr_accessor :currency
+
+    # Cost in the lowest denominator of the currency. 
+    # E.g. 101 for £1.01
+    # @return [Integer]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currency'] = 'currency'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(currency:, value:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @currency = currency
+      @value = value
+      @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.
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      value = hash.key?('value') ? hash['value'] : 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.
+      PaymentTransactionProcessingFee.new(currency: currency,
+                                          value: value,
+                                          additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentTransactionProcessingFee | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.currency,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.value,
+                                  ->(val) { val.instance_of? Integer })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['currency'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['value'],
+                                ->(val) { val.instance_of? Integer })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} currency: #{@currency}, value: #{@value}, 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} currency: #{@currency.inspect}, value: #{@value.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/payment_transaction_refunded_amount.rb

@@ -0,0 +1,105 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Amount refunded from a captured transaction.
+  class PaymentTransactionRefundedAmount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ISO 4217 currency code. Must be UPPERCASE.
+    # @return [String]
+    attr_accessor :currency
+
+    # Cost in the lowest denominator of the currency. 
+    # E.g. 101 for £1.01
+    # @return [Integer]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currency'] = 'currency'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(currency:, value:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @currency = currency
+      @value = value
+      @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.
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      value = hash.key?('value') ? hash['value'] : 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.
+      PaymentTransactionRefundedAmount.new(currency: currency,
+                                           value: value,
+                                           additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentTransactionRefundedAmount | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.currency,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.value,
+                                  ->(val) { val.instance_of? Integer })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['currency'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['value'],
+                                ->(val) { val.instance_of? Integer })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} currency: #{@currency}, value: #{@value}, 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} currency: #{@currency.inspect}, value: #{@value.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/payments_v1_bulks_response.rb

@@ -0,0 +1,74 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # PaymentsV1BulksResponse Model.
+  class PaymentsV1BulksResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Identifier of the triggered bulk.
+    # @return [String]
+    attr_accessor :id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless 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.
+      id = hash.key?('id') ? hash['id'] : 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.
+      PaymentsV1BulksResponse.new(id: 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} id: #{@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} id: #{@id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/payments_v1_orders_payments_retry_failed_refunds_request.rb

@@ -0,0 +1,74 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # PaymentsV1OrdersPaymentsRetryFailedRefundsRequest Model.
+  class PaymentsV1OrdersPaymentsRetryFailedRefundsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Optional note to attach to the refund retry.
+    # @return [String]
+    attr_accessor :note
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['note'] = 'note'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        note
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(note: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @note = note unless note == 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.
+      note = hash.key?('note') ? hash['note'] : 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.
+      PaymentsV1OrdersPaymentsRetryFailedRefundsRequest.new(note: note,
+                                                            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} note: #{@note}, 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} note: #{@note.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/payments_v1_refunds_closures_request.rb

@@ -0,0 +1,74 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # PaymentsV1RefundsClosuresRequest Model.
+  class PaymentsV1RefundsClosuresRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Optional note to attach to the refund closure.
+    # @return [String]
+    attr_accessor :note
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['note'] = 'note'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        note
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(note: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @note = note unless note == 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.
+      note = hash.key?('note') ? hash['note'] : 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.
+      PaymentsV1RefundsClosuresRequest.new(note: note,
+                                           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} note: #{@note}, 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} note: #{@note.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/payments_v1_refunds_retry_failed_refunds_request.rb

@@ -0,0 +1,74 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # PaymentsV1RefundsRetryFailedRefundsRequest Model.
+  class PaymentsV1RefundsRetryFailedRefundsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Optional note to attach to the refund retry.
+    # @return [String]
+    attr_accessor :note
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['note'] = 'note'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        note
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(note: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @note = note unless note == 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.
+      note = hash.key?('note') ? hash['note'] : 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.
+      PaymentsV1RefundsRetryFailedRefundsRequest.new(note: note,
+                                                     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} note: #{@note}, 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} note: #{@note.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/payments_v1_schemes_response.rb

@@ -0,0 +1,76 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # PaymentsV1SchemesResponse Model.
+  class PaymentsV1SchemesResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[CardScheme]]
+    attr_accessor :card_schemes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card_schemes'] = 'cardSchemes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card_schemes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(card_schemes: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @card_schemes = card_schemes unless card_schemes == 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.
+      card_schemes = hash.key?('cardSchemes') ? hash['cardSchemes'] : 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.
+      PaymentsV1SchemesResponse.new(card_schemes: card_schemes,
+                                    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} card_schemes: #{@card_schemes}, 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} card_schemes: #{@card_schemes.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/paypal_config.rb

@@ -0,0 +1,94 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Configuration for PayPal.
+  class PaypalConfig < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Merchant's PayPal client ID
+    # @return [String]
+    attr_accessor :client_id
+
+    # Merchant's PayPal merchant ID
+    # @return [String]
+    attr_accessor :merchant_id
+
+    # Merchant's PayPal business number code, used for tracking and reporting.
+    # @return [String]
+    attr_accessor :bn_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['client_id'] = 'clientId'
+      @_hash['merchant_id'] = 'merchantId'
+      @_hash['bn_code'] = 'bnCode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        merchant_id
+        bn_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_id:, merchant_id: SKIP, bn_code: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @client_id = client_id
+      @merchant_id = merchant_id unless merchant_id == SKIP
+      @bn_code = bn_code unless bn_code == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      client_id = hash.key?('clientId') ? hash['clientId'] : nil
+      merchant_id = hash.key?('merchantId') ? hash['merchantId'] : SKIP
+      bn_code = hash.key?('bnCode') ? hash['bnCode'] : 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.
+      PaypalConfig.new(client_id: client_id,
+                       merchant_id: merchant_id,
+                       bn_code: bn_code,
+                       additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} client_id: #{@client_id}, merchant_id: #{@merchant_id}, bn_code:"\
+      " #{@bn_code}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} client_id: #{@client_id.inspect}, merchant_id: #{@merchant_id.inspect},"\
+      " bn_code: #{@bn_code.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end