apimatic-gp-sdk 0.0.1

data/lib/batches/models/close_response.rb

@@ -0,0 +1,356 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # CloseResponse Model.
+  class CloseResponse < 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 :id
+
+    # Indicates where a batch is in its life cycle. *`OPEN` - Batch is open and
+    # can accept more transactions.
+    # *`CLOSED` - Batch is closed and cannot accept more transactions.
+    # @return [StatusBatchesStatus]
+    attr_accessor :status
+
+    # Time indicating when the batch was created in ISO-8601 format..
+    # @return [String]
+    attr_accessor :time_created
+
+    # Global Payments time indicating when the batch was last updated in
+    # ISO-8601 format..
+    # @return [String]
+    attr_accessor :time_last_updated
+
+    # Time indicating when the batch was closed
+    # @return [String]
+    attr_accessor :time_closed
+
+    # An identifier generated by Global Payments to uniquely identify the action
+    # that opened the batch.
+    # @return [String]
+    attr_accessor :open_action_id
+
+    # An identifier generated by Global Payments to uniquely identify the action
+    # that closed the batch.
+    # @return [String]
+    attr_accessor :close_action_id
+
+    # A unique identifier that is used to identify and reference an instance of
+    # this resource. This id is used when actioning or referencing a specific
+    # merchant. Begins with the three letters, MER.
+    # @return [String]
+    attr_accessor :merchant_id
+
+    # A meaningful label that better identifies the merchant.
+    # @return [String]
+    attr_accessor :merchant_name
+
+    # A unique identifier that is used to identify and reference an instance of
+    # this resource. This id is used when actioning or referencing a specific
+    # account. Begins with the three letters, TRA.
+    # @return [String]
+    attr_accessor :account_id
+
+    # A meaningful label that better identifies the account.
+    # @return [String]
+    attr_accessor :account_name
+
+    # A reference for the location that created the batch.
+    # @return [String]
+    attr_accessor :site_reference
+
+    # A reference for the device that created the batch
+    # @return [String]
+    attr_accessor :device_reference
+
+    # The number of transactions in the batch.
+    # @return [Float]
+    attr_accessor :transaction_count
+
+    # 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 currency of the amount in ISO-4217(alpha-3)
+    # @return [String]
+    attr_accessor :currency
+
+    # The amount that is an aggregation of all the transactions' gratuity
+    # amounts in the batch. 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. It is always represented in the lowest denomination
+    # of the related currency.
+    # @return [Sales]
+    attr_accessor :sales
+
+    # The amount that is an aggregation of all the transactions' gratuity
+    # amounts in the batch. It is always represented in the lowest denomination
+    # of the related currency.
+    # @return [Refunds]
+    attr_accessor :refunds
+
+    # The amount that is an aggregation of all the transactions' gratuity
+    # amounts in the batch. It is always represented in the lowest denomination
+    # of the related currency.
+    # @return [FundingDebit]
+    attr_accessor :funding_debit
+
+    # The amount that is an aggregation of all the transactions' gratuity
+    # amounts in the batch. It is always represented in the lowest denomination
+    # of the related currency.
+    # @return [FundingCredit]
+    attr_accessor :funding_credit
+
+    # The amount that is an aggregation of all the transactions' gratuity
+    # amounts in the batch. It is always represented in the lowest denomination
+    # of the related currency.
+    # @return [Array[BrandBreakdownItem]]
+    attr_accessor :brand_breakdown
+
+    # The amount that is an aggregation of all the transactions' gratuity
+    # amounts in the batch. It is always represented in the lowest denomination
+    # of the related currency.
+    # @return [HostBreakdownItem]
+    attr_accessor :host_breakdown
+
+    # The amount that is an aggregation of all the transactions' gratuity
+    # amounts in the batch. It is always represented in the lowest denomination
+    # of the related currency.
+    # @return [Action]
+    attr_accessor :action
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['status'] = 'status'
+      @_hash['time_created'] = 'time_created'
+      @_hash['time_last_updated'] = 'time_last_updated'
+      @_hash['time_closed'] = 'time_closed'
+      @_hash['open_action_id'] = 'open_action_id'
+      @_hash['close_action_id'] = 'close_action_id'
+      @_hash['merchant_id'] = 'merchant_id'
+      @_hash['merchant_name'] = 'merchant_name'
+      @_hash['account_id'] = 'account_id'
+      @_hash['account_name'] = 'account_name'
+      @_hash['site_reference'] = 'site_reference'
+      @_hash['device_reference'] = 'device_reference'
+      @_hash['transaction_count'] = 'transaction_count'
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash['gratuity_amount'] = 'gratuity_amount'
+      @_hash['sales'] = 'sales'
+      @_hash['refunds'] = 'refunds'
+      @_hash['funding_debit'] = 'funding_debit'
+      @_hash['funding_credit'] = 'funding_credit'
+      @_hash['brand_breakdown'] = 'brand_breakdown'
+      @_hash['host_breakdown'] = 'host_breakdown'
+      @_hash['action'] = 'action'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        status
+        time_created
+        time_last_updated
+        time_closed
+        open_action_id
+        close_action_id
+        merchant_id
+        merchant_name
+        account_id
+        account_name
+        site_reference
+        device_reference
+        transaction_count
+        amount
+        currency
+        gratuity_amount
+        sales
+        refunds
+        funding_debit
+        funding_credit
+        brand_breakdown
+        host_breakdown
+        action
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, status: SKIP, time_created: SKIP,
+                   time_last_updated: SKIP, time_closed: SKIP,
+                   open_action_id: SKIP, close_action_id: SKIP,
+                   merchant_id: SKIP, merchant_name: SKIP, account_id: SKIP,
+                   account_name: SKIP, site_reference: SKIP,
+                   device_reference: SKIP, transaction_count: SKIP,
+                   amount: SKIP, currency: SKIP, gratuity_amount: SKIP,
+                   sales: SKIP, refunds: SKIP, funding_debit: SKIP,
+                   funding_credit: SKIP, brand_breakdown: SKIP,
+                   host_breakdown: SKIP, action: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @status = status unless status == SKIP
+      @time_created = time_created unless time_created == SKIP
+      @time_last_updated = time_last_updated unless time_last_updated == SKIP
+      @time_closed = time_closed unless time_closed == SKIP
+      @open_action_id = open_action_id unless open_action_id == SKIP
+      @close_action_id = close_action_id unless close_action_id == SKIP
+      @merchant_id = merchant_id unless merchant_id == SKIP
+      @merchant_name = merchant_name unless merchant_name == SKIP
+      @account_id = account_id unless account_id == SKIP
+      @account_name = account_name unless account_name == SKIP
+      @site_reference = site_reference unless site_reference == SKIP
+      @device_reference = device_reference unless device_reference == SKIP
+      @transaction_count = transaction_count unless transaction_count == SKIP
+      @amount = amount unless amount == SKIP
+      @currency = currency unless currency == 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
+      @brand_breakdown = brand_breakdown unless brand_breakdown == SKIP
+      @host_breakdown = host_breakdown unless host_breakdown == SKIP
+      @action = action unless action == 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
+      status = hash.key?('status') ? hash['status'] : SKIP
+      time_created = hash.key?('time_created') ? hash['time_created'] : SKIP
+      time_last_updated =
+        hash.key?('time_last_updated') ? hash['time_last_updated'] : SKIP
+      time_closed = hash.key?('time_closed') ? hash['time_closed'] : SKIP
+      open_action_id =
+        hash.key?('open_action_id') ? hash['open_action_id'] : SKIP
+      close_action_id =
+        hash.key?('close_action_id') ? hash['close_action_id'] : SKIP
+      merchant_id = hash.key?('merchant_id') ? hash['merchant_id'] : SKIP
+      merchant_name = hash.key?('merchant_name') ? hash['merchant_name'] : SKIP
+      account_id = hash.key?('account_id') ? hash['account_id'] : SKIP
+      account_name = hash.key?('account_name') ? hash['account_name'] : SKIP
+      site_reference =
+        hash.key?('site_reference') ? hash['site_reference'] : SKIP
+      device_reference =
+        hash.key?('device_reference') ? hash['device_reference'] : SKIP
+      transaction_count =
+        hash.key?('transaction_count') ? hash['transaction_count'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      gratuity_amount =
+        hash.key?('gratuity_amount') ? hash['gratuity_amount'] : SKIP
+      sales = Sales.from_hash(hash['sales']) if hash['sales']
+      refunds = Refunds.from_hash(hash['refunds']) if hash['refunds']
+      funding_debit = FundingDebit.from_hash(hash['funding_debit']) if hash['funding_debit']
+      funding_credit = FundingCredit.from_hash(hash['funding_credit']) if hash['funding_credit']
+      # Parameter is an array, so we need to iterate through it
+      brand_breakdown = nil
+      unless hash['brand_breakdown'].nil?
+        brand_breakdown = []
+        hash['brand_breakdown'].each do |structure|
+          brand_breakdown << (BrandBreakdownItem.from_hash(structure) if structure)
+        end
+      end
+
+      brand_breakdown = SKIP unless hash.key?('brand_breakdown')
+      host_breakdown = HostBreakdownItem.from_hash(hash['host_breakdown']) if
+        hash['host_breakdown']
+      action = Action.from_hash(hash['action']) if hash['action']
+
+      # 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.
+      CloseResponse.new(id: id,
+                        status: status,
+                        time_created: time_created,
+                        time_last_updated: time_last_updated,
+                        time_closed: time_closed,
+                        open_action_id: open_action_id,
+                        close_action_id: close_action_id,
+                        merchant_id: merchant_id,
+                        merchant_name: merchant_name,
+                        account_id: account_id,
+                        account_name: account_name,
+                        site_reference: site_reference,
+                        device_reference: device_reference,
+                        transaction_count: transaction_count,
+                        amount: amount,
+                        currency: currency,
+                        gratuity_amount: gratuity_amount,
+                        sales: sales,
+                        refunds: refunds,
+                        funding_debit: funding_debit,
+                        funding_credit: funding_credit,
+                        brand_breakdown: brand_breakdown,
+                        host_breakdown: host_breakdown,
+                        action: action,
+                        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}, status: #{@status}, time_created: #{@time_created},"\
+      " time_last_updated: #{@time_last_updated}, time_closed: #{@time_closed}, open_action_id:"\
+      " #{@open_action_id}, close_action_id: #{@close_action_id}, merchant_id: #{@merchant_id},"\
+      " merchant_name: #{@merchant_name}, account_id: #{@account_id}, account_name:"\
+      " #{@account_name}, site_reference: #{@site_reference}, device_reference:"\
+      " #{@device_reference}, transaction_count: #{@transaction_count}, amount: #{@amount},"\
+      " currency: #{@currency}, gratuity_amount: #{@gratuity_amount}, sales: #{@sales}, refunds:"\
+      " #{@refunds}, funding_debit: #{@funding_debit}, funding_credit: #{@funding_credit},"\
+      " brand_breakdown: #{@brand_breakdown}, host_breakdown: #{@host_breakdown}, action:"\
+      " #{@action}, 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}, status: #{@status.inspect}, time_created:"\
+      " #{@time_created.inspect}, time_last_updated: #{@time_last_updated.inspect}, time_closed:"\
+      " #{@time_closed.inspect}, open_action_id: #{@open_action_id.inspect}, close_action_id:"\
+      " #{@close_action_id.inspect}, merchant_id: #{@merchant_id.inspect}, merchant_name:"\
+      " #{@merchant_name.inspect}, account_id: #{@account_id.inspect}, account_name:"\
+      " #{@account_name.inspect}, site_reference: #{@site_reference.inspect}, device_reference:"\
+      " #{@device_reference.inspect}, transaction_count: #{@transaction_count.inspect}, amount:"\
+      " #{@amount.inspect}, currency: #{@currency.inspect}, gratuity_amount:"\
+      " #{@gratuity_amount.inspect}, sales: #{@sales.inspect}, refunds: #{@refunds.inspect},"\
+      " funding_debit: #{@funding_debit.inspect}, funding_credit: #{@funding_credit.inspect},"\
+      " brand_breakdown: #{@brand_breakdown.inspect}, host_breakdown: #{@host_breakdown.inspect},"\
+      " action: #{@action.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/batches/models/currency_batches_transactions_currency.rb

@@ -0,0 +1,60 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # The currency of the amount in ISO-4217(alpha-3).
+  class CurrencyBatchesTransactionsCurrency
+    CURRENCY_BATCHES_TRANSACTIONS_CURRENCY = [
+      # TODO: Write general description for USD
+      USD = 'USD'.freeze,
+
+      # TODO: Write general description for EUR
+      EUR = 'EUR'.freeze,
+
+      # TODO: Write general description for GBP
+      GBP = 'GBP'.freeze,
+
+      # TODO: Write general description for CAD
+      CAD = 'CAD'.freeze,
+
+      # TODO: Write general description for CHF
+      CHF = 'CHF'.freeze,
+
+      # TODO: Write general description for HKD
+      HKD = 'HKD'.freeze,
+
+      # TODO: Write general description for SGD
+      SGD = 'SGD'.freeze,
+
+      # TODO: Write general description for ENUM_MOP_ETC
+      ENUM_MOP_ETC = 'MOP etc.'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CURRENCY_BATCHES_TRANSACTIONS_CURRENCY.include?(value)
+    end
+
+    def self.from_value(value, default_value = USD)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'usd' then USD
+      when 'eur' then EUR
+      when 'gbp' then GBP
+      when 'cad' then CAD
+      when 'chf' then CHF
+      when 'hkd' then HKD
+      when 'sgd' then SGD
+      when 'enum_mop_etc' then ENUM_MOP_ETC
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/batches/models/cvv_result_batches_transactions_payment_method_card_cvv_result.rb

@@ -0,0 +1,40 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # The result of the CVV check.
+  class CvvResultBatchesTransactionsPaymentMethodCardCvvResult
+    CVV_RESULT_BATCHES_TRANSACTIONS_PAYMENT_METHOD_CARD_CVV_RESULT = [
+      # TODO: Write general description for MATCHED
+      MATCHED = 'MATCHED'.freeze,
+
+      # TODO: Write general description for NOT_MATCHED
+      NOT_MATCHED = 'NOT_MATCHED'.freeze,
+
+      # TODO: Write general description for NOT_CHECKED
+      NOT_CHECKED = 'NOT_CHECKED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CVV_RESULT_BATCHES_TRANSACTIONS_PAYMENT_METHOD_CARD_CVV_RESULT.include?(value)
+    end
+
+    def self.from_value(value, default_value = MATCHED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'matched' then MATCHED
+      when 'not_matched' then NOT_MATCHED
+      when 'not_checked' then NOT_CHECKED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/batches/models/detailed_error_code.rb

@@ -0,0 +1,26 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # Unique reference to identify the error.
+  class DetailedErrorCode
+    DETAILED_ERROR_CODE = [
+      # TODO: Write general description for ENUM_40016
+      ENUM_40016 = '40016'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      DETAILED_ERROR_CODE.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_40016)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/batches/models/detailed_error_code1.rb

@@ -0,0 +1,36 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # Unique reference to identify the error.
+  class DetailedErrorCode1
+    DETAILED_ERROR_CODE1 = [
+      # TODO: Write general description for ENUM_40001
+      ENUM_40001 = '40001'.freeze,
+
+      # TODO: Write general description for ENUM_40002
+      ENUM_40002 = '40002'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      DETAILED_ERROR_CODE1.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_40001)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_40001' then ENUM_40001
+      when 'enum_40002' then ENUM_40002
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/batches/models/detailed_error_code2.rb

@@ -0,0 +1,36 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # Unique reference to identify the error.
+  class DetailedErrorCode2
+    DETAILED_ERROR_CODE2 = [
+      # TODO: Write general description for ENUM_40003
+      ENUM_40003 = '40003'.freeze,
+
+      # TODO: Write general description for ENUM_40004
+      ENUM_40004 = '40004'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      DETAILED_ERROR_CODE2.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_40003)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_40003' then ENUM_40003
+      when 'enum_40004' then ENUM_40004
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/batches/models/detailed_error_code3.rb

@@ -0,0 +1,26 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # Unique reference to identify the error.
+  class DetailedErrorCode3
+    DETAILED_ERROR_CODE3 = [
+      # TODO: Write general description for ENUM_50011
+      ENUM_50011 = '50011'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      DETAILED_ERROR_CODE3.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_50011)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/batches/models/detailed_error_code4.rb

@@ -0,0 +1,26 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # Unique reference to identify the error.
+  class DetailedErrorCode4
+    DETAILED_ERROR_CODE4 = [
+      # TODO: Write general description for ENUM_50012
+      ENUM_50012 = '50012'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      DETAILED_ERROR_CODE4.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_50012)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/batches/models/detailed_error_code5.rb

@@ -0,0 +1,26 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # Unique reference to identify the error.
+  class DetailedErrorCode5
+    DETAILED_ERROR_CODE5 = [
+      # TODO: Write general description for ENUM_50002
+      ENUM_50002 = '50002'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      DETAILED_ERROR_CODE5.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_50002)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/batches/models/detailed_error_code6.rb

@@ -0,0 +1,26 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # Unique reference to identify the error.
+  class DetailedErrorCode6
+    DETAILED_ERROR_CODE6 = [
+      # TODO: Write general description for ENUM_50008
+      ENUM_50008 = '50008'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      DETAILED_ERROR_CODE6.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_50008)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end