dna-apimatic-sdk 0.0.1

data/lib/dna_payments_partner_reporting_settlement_ap_is/models/pos_transaction.rb

@@ -0,0 +1,298 @@
+# dna_payments_partner_reporting_settlement_ap_is
+#
+# This file was
+# automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module DnaPaymentsPartnerReportingSettlementApIs
+  # PosTransaction Model.
+  class PosTransaction < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique ID for the merchant, allocated by DNA Payments.
+    # @return [String]
+    attr_accessor :merchant_id
+
+    # Name of the merchant.
+    # @return [String]
+    attr_accessor :merchant_name
+
+    # Date/time the transaction was created on the DNA Platform.
+    # @return [DateTime]
+    attr_accessor :transaction_date
+
+    # Transaction amount.
+    # @return [Float]
+    attr_accessor :amount
+
+    # Transaction currency code. ISO 4217 format, e.g. GBP.
+    # @return [String]
+    attr_accessor :currency
+
+    # success: successful transaction. failed: failed transaction.
+    # @return [Status1]
+    attr_accessor :status
+
+    # Response code returned by the Acquirer during the authorisation process.
+    # @return [String]
+    attr_accessor :return_code
+
+    # Description of the returnCode returned by the Acquirer.
+    # @return [String]
+    attr_accessor :return_code_description
+
+    # Unique ID allocated to the transaction.
+    # @return [String]
+    attr_accessor :transaction_id
+
+    # Unique Terminal ID for the merchant, allocated by DNA Payments.
+    # @return [String]
+    attr_accessor :terminal_id
+
+    # Confirmation of the operation performed.
+    # @return [Operation]
+    attr_accessor :operation
+
+    # Type of transaction/fee recorded in the Settlement (and, by reference, POS
+    # Reporting) API.
+    # @return [TransactionType]
+    attr_accessor :transaction_type
+
+    # Country where the transaction was processed.
+    # @return [String]
+    attr_accessor :transaction_country
+
+    # City where the transaction was processed.
+    # @return [String]
+    attr_accessor :transaction_city
+
+    # Card scheme used in the transaction, e.g. mastercard, visa.
+    # @return [String]
+    attr_accessor :card_scheme
+
+    # Masked PAN for the payment card used; contains the first six and last four
+    # digits.
+    # @return [String]
+    attr_accessor :card_mask
+
+    # Type of card used in the transaction.
+    # @return [String]
+    attr_accessor :card_type
+
+    # Whether the card used was issued in Europe (including the UK).
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_european_card
+
+    # Whether the card used is a corporate card.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_corporate_card
+
+    # Capture method for the transaction.
+    # @return [CaptureMethod]
+    attr_accessor :capture_method
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['merchant_id'] = 'merchantId'
+      @_hash['merchant_name'] = 'merchantName'
+      @_hash['transaction_date'] = 'transactionDate'
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash['status'] = 'status'
+      @_hash['return_code'] = 'returnCode'
+      @_hash['return_code_description'] = 'returnCodeDescription'
+      @_hash['transaction_id'] = 'transactionId'
+      @_hash['terminal_id'] = 'terminalId'
+      @_hash['operation'] = 'operation'
+      @_hash['transaction_type'] = 'transactionType'
+      @_hash['transaction_country'] = 'transactionCountry'
+      @_hash['transaction_city'] = 'transactionCity'
+      @_hash['card_scheme'] = 'cardScheme'
+      @_hash['card_mask'] = 'cardMask'
+      @_hash['card_type'] = 'cardType'
+      @_hash['is_european_card'] = 'isEuropeanCard'
+      @_hash['is_corporate_card'] = 'isCorporateCard'
+      @_hash['capture_method'] = 'captureMethod'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        merchant_id
+        merchant_name
+        transaction_date
+        amount
+        currency
+        status
+        return_code
+        return_code_description
+        transaction_id
+        terminal_id
+        operation
+        transaction_type
+        transaction_country
+        transaction_city
+        card_scheme
+        card_mask
+        card_type
+        is_european_card
+        is_corporate_card
+        capture_method
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        transaction_country
+        transaction_city
+        card_scheme
+        card_mask
+        card_type
+        is_european_card
+        is_corporate_card
+        capture_method
+      ]
+    end
+
+    def initialize(merchant_id: SKIP, merchant_name: SKIP,
+                   transaction_date: SKIP, amount: SKIP, currency: SKIP,
+                   status: SKIP, return_code: SKIP,
+                   return_code_description: SKIP, transaction_id: SKIP,
+                   terminal_id: SKIP, operation: SKIP, transaction_type: SKIP,
+                   transaction_country: SKIP, transaction_city: SKIP,
+                   card_scheme: SKIP, card_mask: SKIP, card_type: SKIP,
+                   is_european_card: SKIP, is_corporate_card: SKIP,
+                   capture_method: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @merchant_id = merchant_id unless merchant_id == SKIP
+      @merchant_name = merchant_name unless merchant_name == SKIP
+      @transaction_date = transaction_date unless transaction_date == SKIP
+      @amount = amount unless amount == SKIP
+      @currency = currency unless currency == SKIP
+      @status = status unless status == SKIP
+      @return_code = return_code unless return_code == SKIP
+      @return_code_description = return_code_description unless return_code_description == SKIP
+      @transaction_id = transaction_id unless transaction_id == SKIP
+      @terminal_id = terminal_id unless terminal_id == SKIP
+      @operation = operation unless operation == SKIP
+      @transaction_type = transaction_type unless transaction_type == SKIP
+      @transaction_country = transaction_country unless transaction_country == SKIP
+      @transaction_city = transaction_city unless transaction_city == SKIP
+      @card_scheme = card_scheme unless card_scheme == SKIP
+      @card_mask = card_mask unless card_mask == SKIP
+      @card_type = card_type unless card_type == SKIP
+      @is_european_card = is_european_card unless is_european_card == SKIP
+      @is_corporate_card = is_corporate_card unless is_corporate_card == SKIP
+      @capture_method = capture_method unless capture_method == 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_id = hash.key?('merchantId') ? hash['merchantId'] : SKIP
+      merchant_name = hash.key?('merchantName') ? hash['merchantName'] : SKIP
+      transaction_date = if hash.key?('transactionDate')
+                           (DateTimeHelper.from_rfc3339(hash['transactionDate']) if hash['transactionDate'])
+                         else
+                           SKIP
+                         end
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      return_code = hash.key?('returnCode') ? hash['returnCode'] : SKIP
+      return_code_description =
+        hash.key?('returnCodeDescription') ? hash['returnCodeDescription'] : SKIP
+      transaction_id = hash.key?('transactionId') ? hash['transactionId'] : SKIP
+      terminal_id = hash.key?('terminalId') ? hash['terminalId'] : SKIP
+      operation = hash.key?('operation') ? hash['operation'] : SKIP
+      transaction_type =
+        hash.key?('transactionType') ? hash['transactionType'] : SKIP
+      transaction_country =
+        hash.key?('transactionCountry') ? hash['transactionCountry'] : SKIP
+      transaction_city =
+        hash.key?('transactionCity') ? hash['transactionCity'] : SKIP
+      card_scheme = hash.key?('cardScheme') ? hash['cardScheme'] : SKIP
+      card_mask = hash.key?('cardMask') ? hash['cardMask'] : SKIP
+      card_type = hash.key?('cardType') ? hash['cardType'] : SKIP
+      is_european_card =
+        hash.key?('isEuropeanCard') ? hash['isEuropeanCard'] : SKIP
+      is_corporate_card =
+        hash.key?('isCorporateCard') ? hash['isCorporateCard'] : SKIP
+      capture_method = hash.key?('captureMethod') ? hash['captureMethod'] : 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.
+      PosTransaction.new(merchant_id: merchant_id,
+                         merchant_name: merchant_name,
+                         transaction_date: transaction_date,
+                         amount: amount,
+                         currency: currency,
+                         status: status,
+                         return_code: return_code,
+                         return_code_description: return_code_description,
+                         transaction_id: transaction_id,
+                         terminal_id: terminal_id,
+                         operation: operation,
+                         transaction_type: transaction_type,
+                         transaction_country: transaction_country,
+                         transaction_city: transaction_city,
+                         card_scheme: card_scheme,
+                         card_mask: card_mask,
+                         card_type: card_type,
+                         is_european_card: is_european_card,
+                         is_corporate_card: is_corporate_card,
+                         capture_method: capture_method,
+                         additional_properties: additional_properties)
+    end
+
+    def to_custom_transaction_date
+      DateTimeHelper.to_rfc3339(transaction_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} merchant_id: #{@merchant_id}, merchant_name: #{@merchant_name},"\
+      " transaction_date: #{@transaction_date}, amount: #{@amount}, currency: #{@currency},"\
+      " status: #{@status}, return_code: #{@return_code}, return_code_description:"\
+      " #{@return_code_description}, transaction_id: #{@transaction_id}, terminal_id:"\
+      " #{@terminal_id}, operation: #{@operation}, transaction_type: #{@transaction_type},"\
+      " transaction_country: #{@transaction_country}, transaction_city: #{@transaction_city},"\
+      " card_scheme: #{@card_scheme}, card_mask: #{@card_mask}, card_type: #{@card_type},"\
+      " is_european_card: #{@is_european_card}, is_corporate_card: #{@is_corporate_card},"\
+      " capture_method: #{@capture_method}, 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_id: #{@merchant_id.inspect}, merchant_name:"\
+      " #{@merchant_name.inspect}, transaction_date: #{@transaction_date.inspect}, amount:"\
+      " #{@amount.inspect}, currency: #{@currency.inspect}, status: #{@status.inspect},"\
+      " return_code: #{@return_code.inspect}, return_code_description:"\
+      " #{@return_code_description.inspect}, transaction_id: #{@transaction_id.inspect},"\
+      " terminal_id: #{@terminal_id.inspect}, operation: #{@operation.inspect}, transaction_type:"\
+      " #{@transaction_type.inspect}, transaction_country: #{@transaction_country.inspect},"\
+      " transaction_city: #{@transaction_city.inspect}, card_scheme: #{@card_scheme.inspect},"\
+      " card_mask: #{@card_mask.inspect}, card_type: #{@card_type.inspect}, is_european_card:"\
+      " #{@is_european_card.inspect}, is_corporate_card: #{@is_corporate_card.inspect},"\
+      " capture_method: #{@capture_method.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/dna_payments_partner_reporting_settlement_ap_is/models/pos_transactions_response.rb

@@ -0,0 +1,105 @@
+# dna_payments_partner_reporting_settlement_ap_is
+#
+# This file was
+# automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module DnaPaymentsPartnerReportingSettlementApIs
+  # PosTransactionsResponse Model.
+  class PosTransactionsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Total amount for the requested time period.
+    # @return [Float]
+    attr_accessor :total_amount
+
+    # Total count of records for the requested time period.
+    # @return [Integer]
+    attr_accessor :total_count
+
+    # Total count of records for the requested time period.
+    # @return [Array[PosTransaction]]
+    attr_accessor :data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['total_amount'] = 'totalAmount'
+      @_hash['total_count'] = 'totalCount'
+      @_hash['data'] = 'data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        total_amount
+        total_count
+        data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(total_amount: SKIP, total_count: SKIP, data: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @total_amount = total_amount unless total_amount == SKIP
+      @total_count = total_count unless total_count == SKIP
+      @data = data unless data == 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.
+      total_amount = hash.key?('totalAmount') ? hash['totalAmount'] : SKIP
+      total_count = hash.key?('totalCount') ? hash['totalCount'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      data = nil
+      unless hash['data'].nil?
+        data = []
+        hash['data'].each do |structure|
+          data << (PosTransaction.from_hash(structure) if structure)
+        end
+      end
+
+      data = SKIP unless hash.key?('data')
+
+      # 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.
+      PosTransactionsResponse.new(total_amount: total_amount,
+                                  total_count: total_count,
+                                  data: data,
+                                  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} total_amount: #{@total_amount}, total_count: #{@total_count}, data:"\
+      " #{@data}, 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} total_amount: #{@total_amount.inspect}, total_count:"\
+      " #{@total_count.inspect}, data: #{@data.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/dna_payments_partner_reporting_settlement_ap_is/models/processor.rb

@@ -0,0 +1,36 @@
+# dna_payments_partner_reporting_settlement_ap_is
+#
+# This file was
+# automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module DnaPaymentsPartnerReportingSettlementApIs
+  # processor.
+  class Processor
+    PROCESSOR = [
+      # TODO: Write general description for DNA
+      DNA = 'dna'.freeze,
+
+      # TODO: Write general description for OPTOMANY
+      OPTOMANY = 'optomany'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PROCESSOR.include?(value)
+    end
+
+    def self.from_value(value, default_value = DNA)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'dna' then DNA
+      when 'optomany' then OPTOMANY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/dna_payments_partner_reporting_settlement_ap_is/models/scope.rb

@@ -0,0 +1,26 @@
+# dna_payments_partner_reporting_settlement_ap_is
+#
+# This file was
+# automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module DnaPaymentsPartnerReportingSettlementApIs
+  # Scope of the action to be performed with the credentials.
+  class Scope
+    SCOPE = [
+      # TODO: Write general description for PARTNERS_REPORTING
+      PARTNERS_REPORTING = 'partners_reporting'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SCOPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = PARTNERS_REPORTING)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/dna_payments_partner_reporting_settlement_ap_is/models/search_by.rb

@@ -0,0 +1,36 @@
+# dna_payments_partner_reporting_settlement_ap_is
+#
+# This file was
+# automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module DnaPaymentsPartnerReportingSettlementApIs
+  # searchBy.
+  class SearchBy
+    SEARCH_BY = [
+      # TODO: Write general description for PROCESSEDDATE
+      PROCESSEDDATE = 'processed-date'.freeze,
+
+      # TODO: Write general description for SETTLEMENTDATE
+      SETTLEMENTDATE = 'settlement-date'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SEARCH_BY.include?(value)
+    end
+
+    def self.from_value(value, default_value = PROCESSEDDATE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'processeddate' then PROCESSEDDATE
+      when 'settlementdate' then SETTLEMENTDATE
+      else
+        default_value
+      end
+    end
+  end
+end