apimatic-gp-sdk 0.0.1

data/lib/batches/models/entry_mode_batches_transactions_payment_method_entry_mode.rb

@@ -0,0 +1,104 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # 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.
+  class EntryModeBatchesTransactionsPaymentMethodEntryMode
+    ENTRY_MODE_BATCHES_TRANSACTIONS_PAYMENT_METHOD_ENTRY_MODE = [
+      # TODO: Write general description for MOTO
+      MOTO = 'MOTO'.freeze,
+
+      # TODO: Write general description for ECOM
+      ECOM = 'ECOM'.freeze,
+
+      # TODO: Write general description for IN_APP
+      IN_APP = 'IN_APP'.freeze,
+
+      # TODO: Write general description for CHIP
+      CHIP = 'CHIP'.freeze,
+
+      # TODO: Write general description for SWIPE
+      SWIPE = 'SWIPE'.freeze,
+
+      # TODO: Write general description for MANUAL
+      MANUAL = 'MANUAL'.freeze,
+
+      # TODO: Write general description for PHONE
+      PHONE = 'PHONE'.freeze,
+
+      # TODO: Write general description for MAIL
+      MAIL = 'MAIL'.freeze,
+
+      # TODO: Write general description for CONTACTLESS_CHIP
+      CONTACTLESS_CHIP = 'CONTACTLESS_CHIP'.freeze,
+
+      # TODO: Write general description for CONTACTLESS_SWIPE
+      CONTACTLESS_SWIPE = 'CONTACTLESS_SWIPE'.freeze,
+
+      # TODO: Write general description for PRESENT
+      PRESENT = 'PRESENT'.freeze,
+
+      # TODO: Write general description for UNKNOWN
+      UNKNOWN = 'UNKNOWN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ENTRY_MODE_BATCHES_TRANSACTIONS_PAYMENT_METHOD_ENTRY_MODE.include?(value)
+    end
+
+    def self.from_value(value, default_value = MOTO)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'moto' then MOTO
+      when 'ecom' then ECOM
+      when 'in_app' then IN_APP
+      when 'chip' then CHIP
+      when 'swipe' then SWIPE
+      when 'manual' then MANUAL
+      when 'phone' then PHONE
+      when 'mail' then MAIL
+      when 'contactless_chip' then CONTACTLESS_CHIP
+      when 'contactless_swipe' then CONTACTLESS_SWIPE
+      when 'present' then PRESENT
+      when 'unknown' then UNKNOWN
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/batches/models/error_code.rb

@@ -0,0 +1,52 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # This indicates an issue with the API request.
+  class ErrorCode
+    ERROR_CODE = [
+      # TODO: Write general description for DUPLICATE_TRANSACTION
+      DUPLICATE_TRANSACTION = 'DUPLICATE_TRANSACTION'.freeze,
+
+      # TODO: Write general description for INVALID_BATCH_ACTION
+      INVALID_BATCH_ACTION = 'INVALID_BATCH_ACTION'.freeze,
+
+      # TODO: Write general description for INVALID_REQUEST_DATA
+      INVALID_REQUEST_DATA = 'INVALID_REQUEST_DATA'.freeze,
+
+      # TODO: Write general description for INVALID_TRANSACTION_ACTION
+      INVALID_TRANSACTION_ACTION = 'INVALID_TRANSACTION_ACTION'.freeze,
+
+      # TODO: Write general description for MANDATORY_DATA_MISSING
+      MANDATORY_DATA_MISSING = 'MANDATORY_DATA_MISSING'.freeze,
+
+      # TODO: Write general description for TRANSACTION_NOT_FOUND
+      TRANSACTION_NOT_FOUND = 'TRANSACTION_NOT_FOUND'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ERROR_CODE.include?(value)
+    end
+
+    def self.from_value(value, default_value = DUPLICATE_TRANSACTION)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'duplicate_transaction' then DUPLICATE_TRANSACTION
+      when 'invalid_batch_action' then INVALID_BATCH_ACTION
+      when 'invalid_request_data' then INVALID_REQUEST_DATA
+      when 'invalid_transaction_action' then INVALID_TRANSACTION_ACTION
+      when 'mandatory_data_missing' then MANDATORY_DATA_MISSING
+      when 'transaction_not_found' then TRANSACTION_NOT_FOUND
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/batches/models/error_code1.rb

@@ -0,0 +1,26 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # This action failed as token in the request is not valid.
+  class ErrorCode1
+    ERROR_CODE1 = [
+      # TODO: Write general description for NOT_AUTHENTICATED
+      NOT_AUTHENTICATED = 'NOT_AUTHENTICATED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ERROR_CODE1.include?(value)
+    end
+
+    def self.from_value(value, default_value = NOT_AUTHENTICATED)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/batches/models/error_code2.rb

@@ -0,0 +1,26 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # This action is not authorized with the credentials being used.
+  class ErrorCode2
+    ERROR_CODE2 = [
+      # TODO: Write general description for ACTION_NOT_AUTHORIZED
+      ACTION_NOT_AUTHORIZED = 'ACTION_NOT_AUTHORIZED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ERROR_CODE2.include?(value)
+    end
+
+    def self.from_value(value, default_value = ACTION_NOT_AUTHORIZED)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/batches/models/error_code3.rb

@@ -0,0 +1,26 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # This indicates an unexpected issue occurred on the Global Payments system.
+  class ErrorCode3
+    ERROR_CODE3 = [
+      # TODO: Write general description for SYSTEM_ERROR_DOWNSTREAM
+      SYSTEM_ERROR_DOWNSTREAM = 'SYSTEM_ERROR_DOWNSTREAM'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ERROR_CODE3.include?(value)
+    end
+
+    def self.from_value(value, default_value = SYSTEM_ERROR_DOWNSTREAM)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/batches/models/error_code4.rb

@@ -0,0 +1,26 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # This is an error not yet handled or mapped properly.
+  class ErrorCode4
+    ERROR_CODE4 = [
+      # TODO: Write general description for UNKNOWN_RESPONSE
+      UNKNOWN_RESPONSE = 'UNKNOWN_RESPONSE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ERROR_CODE4.include?(value)
+    end
+
+    def self.from_value(value, default_value = UNKNOWN_RESPONSE)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/batches/models/error_code5.rb

@@ -0,0 +1,27 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # This is an error indicating there was an issue connecting to a partner
+  # system..
+  class ErrorCode5
+    ERROR_CODE5 = [
+      # TODO: Write general description for UNAUTHORIZED_DOWNSTREAM
+      UNAUTHORIZED_DOWNSTREAM = 'UNAUTHORIZED_DOWNSTREAM'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ERROR_CODE5.include?(value)
+    end
+
+    def self.from_value(value, default_value = UNAUTHORIZED_DOWNSTREAM)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/batches/models/error_code6.rb

@@ -0,0 +1,26 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # This is an error indicating there was a timeout issue to another  system.
+  class ErrorCode6
+    ERROR_CODE6 = [
+      # TODO: Write general description for TIMEOUT_DOWNSTREAM
+      TIMEOUT_DOWNSTREAM = 'TIMEOUT_DOWNSTREAM'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ERROR_CODE6.include?(value)
+    end
+
+    def self.from_value(value, default_value = TIMEOUT_DOWNSTREAM)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/batches/models/filter.rb

@@ -0,0 +1,76 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # Filter Model.
+  class Filter < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A unique identifier for the object created by Global Payments. The first 3
+    # characters identifies the resource an id relates to.
+    # @return [String]
+    attr_accessor :batch_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['batch_id'] = 'batch_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        batch_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(batch_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @batch_id = batch_id unless batch_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.
+      batch_id = hash.key?('batch_id') ? hash['batch_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.
+      Filter.new(batch_id: batch_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} batch_id: #{@batch_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} batch_id: #{@batch_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/batches/models/funding_batches_transactions_payment_method_card_funding.rb

@@ -0,0 +1,59 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # 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.
+  class FundingBatchesTransactionsPaymentMethodCardFunding
+    FUNDING_BATCHES_TRANSACTIONS_PAYMENT_METHOD_CARD_FUNDING = [
+      # TODO: Write general description for DEBIT
+      DEBIT = 'DEBIT'.freeze,
+
+      # TODO: Write general description for CREDIT
+      CREDIT = 'CREDIT'.freeze,
+
+      # TODO: Write general description for CASH_BENEFITS
+      CASH_BENEFITS = 'CASH_BENEFITS'.freeze,
+
+      # TODO: Write general description for FOOD_STAMP
+      FOOD_STAMP = 'FOOD_STAMP'.freeze,
+
+      # TODO: Write general description for PREPAID
+      PREPAID = 'PREPAID'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FUNDING_BATCHES_TRANSACTIONS_PAYMENT_METHOD_CARD_FUNDING.include?(value)
+    end
+
+    def self.from_value(value, default_value = DEBIT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'debit' then DEBIT
+      when 'credit' then CREDIT
+      when 'cash_benefits' then CASH_BENEFITS
+      when 'food_stamp' then FOOD_STAMP
+      when 'prepaid' then PREPAID
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/batches/models/funding_credit.rb

@@ -0,0 +1,85 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # FundingCredit Model.
+  class FundingCredit < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The total number of Credit card transactions.
+    # @return [Float]
+    attr_accessor :count
+
+    # The total amount of Credit card 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.
+      FundingCredit.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

data/lib/batches/models/funding_credit1.rb

@@ -0,0 +1,85 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # FundingCredit1 Model.
+  class FundingCredit1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The total number of Credit card transactions for this brand.
+    # @return [Float]
+    attr_accessor :count
+
+    # The total amount of Credit card transactions for this brand.
+    # @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.
+      FundingCredit1.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