apimatic-gp-sdk 0.0.1

data/lib/batches/models/host_breakdown_item.rb

@@ -0,0 +1,128 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # HostBreakdownItem Model.
+  class HostBreakdownItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The merchant name that is associated with the batch.
+    # @return [String]
+    attr_accessor :merchant_name
+
+    # A reference for the batch from the host.
+    # @return [String]
+    attr_accessor :reference
+
+    # The batch amount that is an aggregation of all the transactions' amounts
+    # in the batch. It is always represented in the lowest denomination of the
+    # related currency.
+    # @return [String]
+    attr_accessor :amount
+
+    # The number of transactions in the batch.
+    # @return [Float]
+    attr_accessor :count
+
+    # The number of transactions in the batch.
+    # @return [FundingDebit5]
+    attr_accessor :funding_debit
+
+    # The number of transactions in the batch.
+    # @return [FundingCredit5]
+    attr_accessor :funding_credit
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['merchant_name'] = 'merchant_name'
+      @_hash['reference'] = 'reference'
+      @_hash['amount'] = 'amount'
+      @_hash['count'] = 'count'
+      @_hash['funding_debit'] = 'funding_debit'
+      @_hash['funding_credit'] = 'funding_credit'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        merchant_name
+        reference
+        amount
+        count
+        funding_debit
+        funding_credit
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(merchant_name: SKIP, reference: SKIP, amount: SKIP,
+                   count: SKIP, funding_debit: SKIP, funding_credit: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @merchant_name = merchant_name unless merchant_name == SKIP
+      @reference = reference unless reference == SKIP
+      @amount = amount unless amount == SKIP
+      @count = count unless count == SKIP
+      @funding_debit = funding_debit unless funding_debit == SKIP
+      @funding_credit = funding_credit unless funding_credit == 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.
+      merchant_name = hash.key?('merchant_name') ? hash['merchant_name'] : SKIP
+      reference = hash.key?('reference') ? hash['reference'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      count = hash.key?('count') ? hash['count'] : SKIP
+      funding_debit = FundingDebit5.from_hash(hash['funding_debit']) if hash['funding_debit']
+      funding_credit = FundingCredit5.from_hash(hash['funding_credit']) if hash['funding_credit']
+
+      # 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.
+      HostBreakdownItem.new(merchant_name: merchant_name,
+                            reference: reference,
+                            amount: amount,
+                            count: count,
+                            funding_debit: funding_debit,
+                            funding_credit: funding_credit,
+                            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} merchant_name: #{@merchant_name}, reference: #{@reference}, amount:"\
+      " #{@amount}, count: #{@count}, funding_debit: #{@funding_debit}, funding_credit:"\
+      " #{@funding_credit}, 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} merchant_name: #{@merchant_name.inspect}, reference: #{@reference.inspect},"\
+      " amount: #{@amount.inspect}, count: #{@count.inspect}, funding_debit:"\
+      " #{@funding_debit.inspect}, funding_credit: #{@funding_credit.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/batches/models/not_authorized403.rb

@@ -0,0 +1,102 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # Forbidden
+  class NotAuthorized403 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This action is not authorized with the credentials being used.
+    # @return [ErrorCode2]
+    attr_accessor :error_code
+
+    # Unique reference to identify the error.
+    # @return [DetailedErrorCode2]
+    attr_accessor :detailed_error_code
+
+    # Unique Text describing the specific error.
+    # @return [String]
+    attr_accessor :detailed_error_description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['error_code'] = 'error_code'
+      @_hash['detailed_error_code'] = 'detailed_error_code'
+      @_hash['detailed_error_description'] = 'detailed_error_description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        error_code
+        detailed_error_code
+        detailed_error_description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(error_code: SKIP, detailed_error_code: SKIP,
+                   detailed_error_description: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @error_code = error_code unless error_code == SKIP
+      @detailed_error_code = detailed_error_code unless detailed_error_code == SKIP
+      unless detailed_error_description == SKIP
+        @detailed_error_description =
+          detailed_error_description
+      end
+      @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.
+      error_code = hash.key?('error_code') ? hash['error_code'] : SKIP
+      detailed_error_code =
+        hash.key?('detailed_error_code') ? hash['detailed_error_code'] : SKIP
+      detailed_error_description =
+        hash.key?('detailed_error_description') ? hash['detailed_error_description'] : 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.
+      NotAuthorized403.new(error_code: error_code,
+                           detailed_error_code: detailed_error_code,
+                           detailed_error_description: detailed_error_description,
+                           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} error_code: #{@error_code}, detailed_error_code: #{@detailed_error_code},"\
+      " detailed_error_description: #{@detailed_error_description}, 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} error_code: #{@error_code.inspect}, detailed_error_code:"\
+      " #{@detailed_error_code.inspect}, detailed_error_description:"\
+      " #{@detailed_error_description.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/batches/models/obj_request_invalid400.rb

@@ -0,0 +1,102 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # Bad Request
+  class ObjRequestInvalid400 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This indicates an issue with the API request.
+    # @return [ErrorCode]
+    attr_accessor :error_code
+
+    # Unique reference to identify the error.
+    # @return [DetailedErrorCode]
+    attr_accessor :detailed_error_code
+
+    # Unique Text describing the specific error.
+    # @return [String]
+    attr_accessor :detailed_error_description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['error_code'] = 'error_code'
+      @_hash['detailed_error_code'] = 'detailed_error_code'
+      @_hash['detailed_error_description'] = 'detailed_error_description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        error_code
+        detailed_error_code
+        detailed_error_description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(error_code: SKIP, detailed_error_code: SKIP,
+                   detailed_error_description: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @error_code = error_code unless error_code == SKIP
+      @detailed_error_code = detailed_error_code unless detailed_error_code == SKIP
+      unless detailed_error_description == SKIP
+        @detailed_error_description =
+          detailed_error_description
+      end
+      @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.
+      error_code = hash.key?('error_code') ? hash['error_code'] : SKIP
+      detailed_error_code =
+        hash.key?('detailed_error_code') ? hash['detailed_error_code'] : SKIP
+      detailed_error_description =
+        hash.key?('detailed_error_description') ? hash['detailed_error_description'] : 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.
+      ObjRequestInvalid400.new(error_code: error_code,
+                               detailed_error_code: detailed_error_code,
+                               detailed_error_description: detailed_error_description,
+                               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} error_code: #{@error_code}, detailed_error_code: #{@detailed_error_code},"\
+      " detailed_error_description: #{@detailed_error_description}, 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} error_code: #{@error_code.inspect}, detailed_error_code:"\
+      " #{@detailed_error_code.inspect}, detailed_error_description:"\
+      " #{@detailed_error_description.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/batches/models/payment_method.rb

@@ -0,0 +1,167 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # PaymentMethod Model.
+  class PaymentMethod < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the owner of the payment method
+    # @return [String]
+    attr_accessor :name
+
+    # Indicates how the payment method information was obtained by the Merchant
+    # for this transaction. 
+    #                          * `MOTO` - A CNP channel entry mode where the
+    # payment method information was obtained over the phone or via postal mail.
+    # 
+    #                          * `ECOM` - A CNP channel entry mode where the
+    # payment method was obtained via a browser. 
+    #                          * `IN_APP` - A CNP channel entry mode where the
+    # payment method was obtained via an application and applies to digital
+    # wallets only. 
+    #                          * `CHIP` - A CP channel entry mode where the
+    # payment method information was obtained from a chip. E.g. card is inserted
+    # into a device to read the chip. 
+    #                          * `SWIPE` - A CP channel entry mode where the
+    # payment method information was obtained from swiping a magnetic strip.
+    # E.g. card's magnetic strip is swiped through a device to read the card
+    # information. 
+    #                          * `MANUAL` - A CP channel entry mode where the
+    # payment method information was obtained by manually keying the payment
+    # method information into the device. 
+    #                          * `CONTACTLESS_CHIP` -  A CP channel entry mode
+    # where the payment method information was obtained by bringing the payment
+    # method to close proximity of a device. E.g. tap a card on or near a device
+    # to exchange card information. 
+    #                          * `CONTACTLESS_SWIPE` -  A CP channel entry mode
+    # where the payment method information was obtained by bringing the payment
+    # method to close proximity of a device and also swiping the card. E.g. tap
+    # a card on or near a device and swipe it through device to exchange card
+    # information 
+    #                          * `PHONE` - A CNP channel entry mode where the
+    # payment method was obtained over the phone. 
+    #                          * `MAIL` - A CNP channel entry mode where the
+    # payment method was obtained via postal mail.
+    #                          * `PRESENT`- The entry mode cannot be determined
+    # but it is a Customer Present transaction.
+    #                          * `UNKNOWN` - The entry mode for this transaction
+    # cannot be determined.
+    # @return [EntryModeBatchesTransactionsPaymentMethodEntryMode]
+    attr_accessor :entry_mode
+
+    # Indicates how the payment method information was obtained by the Merchant
+    # for this transaction. 
+    #                          * `MOTO` - A CNP channel entry mode where the
+    # payment method information was obtained over the phone or via postal mail.
+    # 
+    #                          * `ECOM` - A CNP channel entry mode where the
+    # payment method was obtained via a browser. 
+    #                          * `IN_APP` - A CNP channel entry mode where the
+    # payment method was obtained via an application and applies to digital
+    # wallets only. 
+    #                          * `CHIP` - A CP channel entry mode where the
+    # payment method information was obtained from a chip. E.g. card is inserted
+    # into a device to read the chip. 
+    #                          * `SWIPE` - A CP channel entry mode where the
+    # payment method information was obtained from swiping a magnetic strip.
+    # E.g. card's magnetic strip is swiped through a device to read the card
+    # information. 
+    #                          * `MANUAL` - A CP channel entry mode where the
+    # payment method information was obtained by manually keying the payment
+    # method information into the device. 
+    #                          * `CONTACTLESS_CHIP` -  A CP channel entry mode
+    # where the payment method information was obtained by bringing the payment
+    # method to close proximity of a device. E.g. tap a card on or near a device
+    # to exchange card information. 
+    #                          * `CONTACTLESS_SWIPE` -  A CP channel entry mode
+    # where the payment method information was obtained by bringing the payment
+    # method to close proximity of a device and also swiping the card. E.g. tap
+    # a card on or near a device and swipe it through device to exchange card
+    # information 
+    #                          * `PHONE` - A CNP channel entry mode where the
+    # payment method was obtained over the phone. 
+    #                          * `MAIL` - A CNP channel entry mode where the
+    # payment method was obtained via postal mail.
+    #                          * `PRESENT`- The entry mode cannot be determined
+    # but it is a Customer Present transaction.
+    #                          * `UNKNOWN` - The entry mode for this transaction
+    # cannot be determined.
+    # @return [Card]
+    attr_accessor :card
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['entry_mode'] = 'entry_mode'
+      @_hash['card'] = 'card'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        entry_mode
+        card
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, entry_mode: SKIP, card: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name unless name == SKIP
+      @entry_mode = entry_mode unless entry_mode == SKIP
+      @card = card unless card == 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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      entry_mode = hash.key?('entry_mode') ? hash['entry_mode'] : SKIP
+      card = Card.from_hash(hash['card']) if hash['card']
+
+      # 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.
+      PaymentMethod.new(name: name,
+                        entry_mode: entry_mode,
+                        card: card,
+                        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} name: #{@name}, entry_mode: #{@entry_mode}, card: #{@card},"\
+      " 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} name: #{@name.inspect}, entry_mode: #{@entry_mode.inspect}, card:"\
+      " #{@card.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/batches/models/payment_method2.rb

@@ -0,0 +1,52 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # PaymentMethod2.
+  class PaymentMethod2
+    PAYMENT_METHOD2 = [
+      # TODO: Write general description for CARD
+      CARD = 'CARD'.freeze,
+
+      # TODO: Write general description for DIGITAL_WALLET
+      DIGITAL_WALLET = 'DIGITAL_WALLET'.freeze,
+
+      # TODO: Write general description for APM
+      APM = 'APM'.freeze,
+
+      # TODO: Write general description for BANK_TRANSFER
+      BANK_TRANSFER = 'BANK_TRANSFER'.freeze,
+
+      # TODO: Write general description for BNPL
+      BNPL = 'BNPL'.freeze,
+
+      # TODO: Write general description for NETWORK_TOKEN
+      NETWORK_TOKEN = 'NETWORK_TOKEN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PAYMENT_METHOD2.include?(value)
+    end
+
+    def self.from_value(value, default_value = CARD)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'card' then CARD
+      when 'digital_wallet' then DIGITAL_WALLET
+      when 'apm' then APM
+      when 'bank_transfer' then BANK_TRANSFER
+      when 'bnpl' then BNPL
+      when 'network_token' then NETWORK_TOKEN
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/batches/models/payment_methods_batches_payment_method.rb

@@ -0,0 +1,52 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # payment_methods_BATCHES.payment_method.
+  class PaymentMethodsBatchesPaymentMethod
+    PAYMENT_METHODS_BATCHES_PAYMENT_METHOD = [
+      # TODO: Write general description for CARD
+      CARD = 'CARD'.freeze,
+
+      # TODO: Write general description for DIGITAL_WALLET
+      DIGITAL_WALLET = 'DIGITAL_WALLET'.freeze,
+
+      # TODO: Write general description for APM
+      APM = 'APM'.freeze,
+
+      # TODO: Write general description for BANK_TRANSFER
+      BANK_TRANSFER = 'BANK_TRANSFER'.freeze,
+
+      # TODO: Write general description for BNPL
+      BNPL = 'BNPL'.freeze,
+
+      # TODO: Write general description for NETWORK_TOKEN
+      NETWORK_TOKEN = 'NETWORK_TOKEN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PAYMENT_METHODS_BATCHES_PAYMENT_METHOD.include?(value)
+    end
+
+    def self.from_value(value, default_value = CARD)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'card' then CARD
+      when 'digital_wallet' then DIGITAL_WALLET
+      when 'apm' then APM
+      when 'bank_transfer' then BANK_TRANSFER
+      when 'bnpl' then BNPL
+      when 'network_token' then NETWORK_TOKEN
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/batches/models/refunds.rb

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