apimatic-gp-sdk 0.0.1

data/lib/batches/models/brand_breakdown_item.rb

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

data/lib/batches/models/card.rb

@@ -0,0 +1,170 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # Card Model.
+  class Card < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates how the card is funded:
+    #                            * `DEBIT` - indicates the card is a debit card
+    # where the funds may be present in an account to fulfill the transaction
+    # amount. 
+    #                            * `CREDIT` - indicates the card is a credit
+    # card where the funds may be available on credit to the payer to fulfill
+    # the transaction amount.
+    #                            * `FOOD_STAMP` - indicates the card is an,
+    # Electronic Benefits Transfer, for food stamps.
+    #                            * `CASH_BENEFITS` - indicates the card is an,
+    # Electronic Benefits Transfer, for cash benefits.
+    #                            * `PREPAID` - indicates the card is a prepaid
+    # card where the funds are loaded to the card account to fulfill the
+    # transaction amount. Unlike a debit card, a prepaid is not linked to a bank
+    # account.
+    # @return [FundingBatchesTransactionsPaymentMethodCardFunding]
+    attr_accessor :funding
+
+    # Indicates the card brand that issued the card.
+    # @return [BrandBatchesTransactionsPaymentMethodCardBrand]
+    attr_accessor :brand
+
+    # Masked card number with the front 6 and last 4 digits visible.
+    # @return [String]
+    attr_accessor :masked_number_first6last4
+
+    # Code generated by the card provider when the card is successfully
+    # authorized.
+    # @return [String]
+    attr_accessor :authcode
+
+    # The result of the CVV check.
+    # @return [CvvResultBatchesTransactionsPaymentMethodCardCvvResult]
+    attr_accessor :cvv_result
+
+    # First line of the address associated with the card.
+    # @return [String]
+    attr_accessor :avs_address
+
+    # The result of the AVS address check.
+    # @return [AvsAddressResultBatchesTransactionsPaymentMethodCardAvsAddressResult]
+    attr_accessor :avs_address_result
+
+    # The result of the AVS postal code check.
+    # @return [AvsPostalCodeResultBatchesTransactionsPaymentMethodCardAvsPostalCodeResult]
+    attr_accessor :avs_postal_code_result
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['funding'] = 'funding'
+      @_hash['brand'] = 'brand'
+      @_hash['masked_number_first6last4'] = 'masked_number_first6last4'
+      @_hash['authcode'] = 'authcode'
+      @_hash['cvv_result'] = 'cvv_result'
+      @_hash['avs_address'] = 'avs_address'
+      @_hash['avs_address_result'] = 'avs_address_result'
+      @_hash['avs_postal_code_result'] = 'avs_postal_code_result'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        funding
+        brand
+        masked_number_first6last4
+        authcode
+        cvv_result
+        avs_address
+        avs_address_result
+        avs_postal_code_result
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(funding: SKIP, brand: SKIP, masked_number_first6last4: SKIP,
+                   authcode: SKIP, cvv_result: SKIP, avs_address: SKIP,
+                   avs_address_result: SKIP, avs_postal_code_result: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @funding = funding unless funding == SKIP
+      @brand = brand unless brand == SKIP
+      unless masked_number_first6last4 == SKIP
+        @masked_number_first6last4 =
+          masked_number_first6last4
+      end
+      @authcode = authcode unless authcode == SKIP
+      @cvv_result = cvv_result unless cvv_result == SKIP
+      @avs_address = avs_address unless avs_address == SKIP
+      @avs_address_result = avs_address_result unless avs_address_result == SKIP
+      @avs_postal_code_result = avs_postal_code_result unless avs_postal_code_result == 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.
+      funding = hash.key?('funding') ? hash['funding'] : SKIP
+      brand = hash.key?('brand') ? hash['brand'] : SKIP
+      masked_number_first6last4 =
+        hash.key?('masked_number_first6last4') ? hash['masked_number_first6last4'] : SKIP
+      authcode = hash.key?('authcode') ? hash['authcode'] : SKIP
+      cvv_result = hash.key?('cvv_result') ? hash['cvv_result'] : SKIP
+      avs_address = hash.key?('avs_address') ? hash['avs_address'] : SKIP
+      avs_address_result =
+        hash.key?('avs_address_result') ? hash['avs_address_result'] : SKIP
+      avs_postal_code_result =
+        hash.key?('avs_postal_code_result') ? hash['avs_postal_code_result'] : 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.
+      Card.new(funding: funding,
+               brand: brand,
+               masked_number_first6last4: masked_number_first6last4,
+               authcode: authcode,
+               cvv_result: cvv_result,
+               avs_address: avs_address,
+               avs_address_result: avs_address_result,
+               avs_postal_code_result: avs_postal_code_result,
+               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} funding: #{@funding}, brand: #{@brand}, masked_number_first6last4:"\
+      " #{@masked_number_first6last4}, authcode: #{@authcode}, cvv_result: #{@cvv_result},"\
+      " avs_address: #{@avs_address}, avs_address_result: #{@avs_address_result},"\
+      " avs_postal_code_result: #{@avs_postal_code_result}, 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} funding: #{@funding.inspect}, brand: #{@brand.inspect},"\
+      " masked_number_first6last4: #{@masked_number_first6last4.inspect}, authcode:"\
+      " #{@authcode.inspect}, cvv_result: #{@cvv_result.inspect}, avs_address:"\
+      " #{@avs_address.inspect}, avs_address_result: #{@avs_address_result.inspect},"\
+      " avs_postal_code_result: #{@avs_postal_code_result.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/batches/models/channel_batches_channel.rb

@@ -0,0 +1,44 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # Describes whether the transaction was processed in a face to face(CP)
+  # scenario or a Customer Not Present (CNP) scenario.                  * `CP` -
+  # A Customer Present transaction is when the payer and the merchant are in
+  # direct face to face contact when exchanging payment method information to
+  # fulfill a transaction. e.g. in a store and paying at the counter that is
+  # attended by a clerk.                  * `CNP` - A Customer NOT Present
+  # transaction is when the payer and the merchant are not together when
+  # exchanging payment method information to fulfill a transaction. e.g. a
+  # transaction executed from a merchant's website or over the phone
+  class ChannelBatchesChannel
+    CHANNEL_BATCHES_CHANNEL = [
+      # TODO: Write general description for CP
+      CP = 'CP'.freeze,
+
+      # TODO: Write general description for CNP
+      CNP = 'CNP'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CHANNEL_BATCHES_CHANNEL.include?(value)
+    end
+
+    def self.from_value(value, default_value = CP)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'cp' then CP
+      when 'cnp' then CNP
+      else
+        default_value
+      end
+    end
+  end
+end