worldpay-apimatic-sdk 0.0.1

data/lib/reporting_authorization_summary_api/models/summary_detail_chain.rb

@@ -0,0 +1,233 @@
+# reporting_authorization_summary_api
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingAuthorizationSummaryApi
+  # SummaryDetailChain Model.
+  class SummaryDetailChain < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [PaginationResponse]
+    attr_accessor :pagination
+
+    # Count of the approved transactions.
+    # @return [Integer]
+    attr_accessor :total_approved_count
+
+    # Sum of the amount of approved transactions.
+    # @return [Float]
+    attr_accessor :total_approved_amount
+
+    # Count of the declined transactions.
+    # @return [Integer]
+    attr_accessor :total_declined_count
+
+    # Sum of the amount of declined transactions.
+    # @return [Float]
+    attr_accessor :total_declined_amount
+
+    # Ratio of the count of approved transactions to the count of total
+    # transctions.
+    # @return [Float]
+    attr_accessor :total_approved_count_percent
+
+    # Ratio of the sum of the amount of the approved transactions to the sum of
+    # amount of total transctions.
+    # @return [Float]
+    attr_accessor :total_approved_amount_percent
+
+    # Ratio of the count of the declined transactions to the count of total
+    # transctions.
+    # @return [Float]
+    attr_accessor :total_declined_count_percent
+
+    # Ratio of the sum of the amount of the declined transactions to the sum of
+    # the amount of total transctions.
+    # @return [Float]
+    attr_accessor :total_declined_amount_percent
+
+    # Sum of the count of the approved transactions and the count of the
+    # declined transactions.
+    # @return [Integer]
+    attr_accessor :total_count
+
+    # Sum of the amount of approved transactions and the amount of the declined
+    # transactions.
+    # @return [Float]
+    attr_accessor :total_amount
+
+    # Capturing the fields.
+    # @return [Array[Summary5]]
+    attr_accessor :summaries
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['pagination'] = 'pagination'
+      @_hash['total_approved_count'] = 'totalApprovedCount'
+      @_hash['total_approved_amount'] = 'totalApprovedAmount'
+      @_hash['total_declined_count'] = 'totalDeclinedCount'
+      @_hash['total_declined_amount'] = 'totalDeclinedAmount'
+      @_hash['total_approved_count_percent'] = 'totalApprovedCountPercent'
+      @_hash['total_approved_amount_percent'] = 'totalApprovedAmountPercent'
+      @_hash['total_declined_count_percent'] = 'totalDeclinedCountPercent'
+      @_hash['total_declined_amount_percent'] = 'totalDeclinedAmountPercent'
+      @_hash['total_count'] = 'totalCount'
+      @_hash['total_amount'] = 'totalAmount'
+      @_hash['summaries'] = 'summaries'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        pagination
+        total_approved_count
+        total_approved_amount
+        total_declined_count
+        total_declined_amount
+        total_approved_count_percent
+        total_approved_amount_percent
+        total_declined_count_percent
+        total_declined_amount_percent
+        total_count
+        total_amount
+        summaries
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(pagination: SKIP, total_approved_count: SKIP,
+                   total_approved_amount: SKIP, total_declined_count: SKIP,
+                   total_declined_amount: SKIP,
+                   total_approved_count_percent: SKIP,
+                   total_approved_amount_percent: SKIP,
+                   total_declined_count_percent: SKIP,
+                   total_declined_amount_percent: SKIP, total_count: SKIP,
+                   total_amount: SKIP, summaries: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @pagination = pagination unless pagination == SKIP
+      @total_approved_count = total_approved_count unless total_approved_count == SKIP
+      @total_approved_amount = total_approved_amount unless total_approved_amount == SKIP
+      @total_declined_count = total_declined_count unless total_declined_count == SKIP
+      @total_declined_amount = total_declined_amount unless total_declined_amount == SKIP
+      unless total_approved_count_percent == SKIP
+        @total_approved_count_percent =
+          total_approved_count_percent
+      end
+      unless total_approved_amount_percent == SKIP
+        @total_approved_amount_percent =
+          total_approved_amount_percent
+      end
+      unless total_declined_count_percent == SKIP
+        @total_declined_count_percent =
+          total_declined_count_percent
+      end
+      unless total_declined_amount_percent == SKIP
+        @total_declined_amount_percent =
+          total_declined_amount_percent
+      end
+      @total_count = total_count unless total_count == SKIP
+      @total_amount = total_amount unless total_amount == SKIP
+      @summaries = summaries unless summaries == 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.
+      pagination = PaginationResponse.from_hash(hash['pagination']) if hash['pagination']
+      total_approved_count =
+        hash.key?('totalApprovedCount') ? hash['totalApprovedCount'] : SKIP
+      total_approved_amount =
+        hash.key?('totalApprovedAmount') ? hash['totalApprovedAmount'] : SKIP
+      total_declined_count =
+        hash.key?('totalDeclinedCount') ? hash['totalDeclinedCount'] : SKIP
+      total_declined_amount =
+        hash.key?('totalDeclinedAmount') ? hash['totalDeclinedAmount'] : SKIP
+      total_approved_count_percent =
+        hash.key?('totalApprovedCountPercent') ? hash['totalApprovedCountPercent'] : SKIP
+      total_approved_amount_percent =
+        hash.key?('totalApprovedAmountPercent') ? hash['totalApprovedAmountPercent'] : SKIP
+      total_declined_count_percent =
+        hash.key?('totalDeclinedCountPercent') ? hash['totalDeclinedCountPercent'] : SKIP
+      total_declined_amount_percent =
+        hash.key?('totalDeclinedAmountPercent') ? hash['totalDeclinedAmountPercent'] : SKIP
+      total_count = hash.key?('totalCount') ? hash['totalCount'] : SKIP
+      total_amount = hash.key?('totalAmount') ? hash['totalAmount'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      summaries = nil
+      unless hash['summaries'].nil?
+        summaries = []
+        hash['summaries'].each do |structure|
+          summaries << (Summary5.from_hash(structure) if structure)
+        end
+      end
+
+      summaries = SKIP unless hash.key?('summaries')
+
+      # 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.
+      SummaryDetailChain.new(pagination: pagination,
+                             total_approved_count: total_approved_count,
+                             total_approved_amount: total_approved_amount,
+                             total_declined_count: total_declined_count,
+                             total_declined_amount: total_declined_amount,
+                             total_approved_count_percent: total_approved_count_percent,
+                             total_approved_amount_percent: total_approved_amount_percent,
+                             total_declined_count_percent: total_declined_count_percent,
+                             total_declined_amount_percent: total_declined_amount_percent,
+                             total_count: total_count,
+                             total_amount: total_amount,
+                             summaries: summaries,
+                             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} pagination: #{@pagination}, total_approved_count: #{@total_approved_count},"\
+      " total_approved_amount: #{@total_approved_amount}, total_declined_count:"\
+      " #{@total_declined_count}, total_declined_amount: #{@total_declined_amount},"\
+      " total_approved_count_percent: #{@total_approved_count_percent},"\
+      " total_approved_amount_percent: #{@total_approved_amount_percent},"\
+      " total_declined_count_percent: #{@total_declined_count_percent},"\
+      " total_declined_amount_percent: #{@total_declined_amount_percent}, total_count:"\
+      " #{@total_count}, total_amount: #{@total_amount}, summaries: #{@summaries},"\
+      " 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} pagination: #{@pagination.inspect}, total_approved_count:"\
+      " #{@total_approved_count.inspect}, total_approved_amount:"\
+      " #{@total_approved_amount.inspect}, total_declined_count: #{@total_declined_count.inspect},"\
+      " total_declined_amount: #{@total_declined_amount.inspect}, total_approved_count_percent:"\
+      " #{@total_approved_count_percent.inspect}, total_approved_amount_percent:"\
+      " #{@total_approved_amount_percent.inspect}, total_declined_count_percent:"\
+      " #{@total_declined_count_percent.inspect}, total_declined_amount_percent:"\
+      " #{@total_declined_amount_percent.inspect}, total_count: #{@total_count.inspect},"\
+      " total_amount: #{@total_amount.inspect}, summaries: #{@summaries.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/reporting_authorization_summary_api/models/summary_detail_division.rb

@@ -0,0 +1,233 @@
+# reporting_authorization_summary_api
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingAuthorizationSummaryApi
+  # SummaryDetailDivision Model.
+  class SummaryDetailDivision < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [PaginationResponse]
+    attr_accessor :pagination
+
+    # Count of the approved transactions.
+    # @return [Integer]
+    attr_accessor :total_approved_count
+
+    # Sum of the amount of approved transactions.
+    # @return [Float]
+    attr_accessor :total_approved_amount
+
+    # Count of the declined transactions.
+    # @return [Integer]
+    attr_accessor :total_declined_count
+
+    # Sum of the amount of declined transactions.
+    # @return [Float]
+    attr_accessor :total_declined_amount
+
+    # Ratio of the count of approved transactions to the count of total
+    # transctions.
+    # @return [Float]
+    attr_accessor :total_approved_count_percent
+
+    # Ratio of the sum of the amount of the approved transactions to the sum of
+    # amount of total transctions.
+    # @return [Float]
+    attr_accessor :total_approved_amount_percent
+
+    # Ratio of the count of the declined transactions to the count of total
+    # transctions.
+    # @return [Float]
+    attr_accessor :total_declined_count_percent
+
+    # Ratio of the sum of the amount of the declined transactions to the sum of
+    # the amount of total transctions.
+    # @return [Float]
+    attr_accessor :total_declined_amount_percent
+
+    # Sum of the count of the approved transactions and the count of the
+    # declined transactions.
+    # @return [Integer]
+    attr_accessor :total_count
+
+    # Sum of the amount of approved transactions and the amount of the declined
+    # transactions.
+    # @return [Float]
+    attr_accessor :total_amount
+
+    # Capturing the fields.
+    # @return [Array[Summary3]]
+    attr_accessor :summaries
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['pagination'] = 'pagination'
+      @_hash['total_approved_count'] = 'totalApprovedCount'
+      @_hash['total_approved_amount'] = 'totalApprovedAmount'
+      @_hash['total_declined_count'] = 'totalDeclinedCount'
+      @_hash['total_declined_amount'] = 'totalDeclinedAmount'
+      @_hash['total_approved_count_percent'] = 'totalApprovedCountPercent'
+      @_hash['total_approved_amount_percent'] = 'totalApprovedAmountPercent'
+      @_hash['total_declined_count_percent'] = 'totalDeclinedCountPercent'
+      @_hash['total_declined_amount_percent'] = 'totalDeclinedAmountPercent'
+      @_hash['total_count'] = 'totalCount'
+      @_hash['total_amount'] = 'totalAmount'
+      @_hash['summaries'] = 'summaries'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        pagination
+        total_approved_count
+        total_approved_amount
+        total_declined_count
+        total_declined_amount
+        total_approved_count_percent
+        total_approved_amount_percent
+        total_declined_count_percent
+        total_declined_amount_percent
+        total_count
+        total_amount
+        summaries
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(pagination: SKIP, total_approved_count: SKIP,
+                   total_approved_amount: SKIP, total_declined_count: SKIP,
+                   total_declined_amount: SKIP,
+                   total_approved_count_percent: SKIP,
+                   total_approved_amount_percent: SKIP,
+                   total_declined_count_percent: SKIP,
+                   total_declined_amount_percent: SKIP, total_count: SKIP,
+                   total_amount: SKIP, summaries: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @pagination = pagination unless pagination == SKIP
+      @total_approved_count = total_approved_count unless total_approved_count == SKIP
+      @total_approved_amount = total_approved_amount unless total_approved_amount == SKIP
+      @total_declined_count = total_declined_count unless total_declined_count == SKIP
+      @total_declined_amount = total_declined_amount unless total_declined_amount == SKIP
+      unless total_approved_count_percent == SKIP
+        @total_approved_count_percent =
+          total_approved_count_percent
+      end
+      unless total_approved_amount_percent == SKIP
+        @total_approved_amount_percent =
+          total_approved_amount_percent
+      end
+      unless total_declined_count_percent == SKIP
+        @total_declined_count_percent =
+          total_declined_count_percent
+      end
+      unless total_declined_amount_percent == SKIP
+        @total_declined_amount_percent =
+          total_declined_amount_percent
+      end
+      @total_count = total_count unless total_count == SKIP
+      @total_amount = total_amount unless total_amount == SKIP
+      @summaries = summaries unless summaries == 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.
+      pagination = PaginationResponse.from_hash(hash['pagination']) if hash['pagination']
+      total_approved_count =
+        hash.key?('totalApprovedCount') ? hash['totalApprovedCount'] : SKIP
+      total_approved_amount =
+        hash.key?('totalApprovedAmount') ? hash['totalApprovedAmount'] : SKIP
+      total_declined_count =
+        hash.key?('totalDeclinedCount') ? hash['totalDeclinedCount'] : SKIP
+      total_declined_amount =
+        hash.key?('totalDeclinedAmount') ? hash['totalDeclinedAmount'] : SKIP
+      total_approved_count_percent =
+        hash.key?('totalApprovedCountPercent') ? hash['totalApprovedCountPercent'] : SKIP
+      total_approved_amount_percent =
+        hash.key?('totalApprovedAmountPercent') ? hash['totalApprovedAmountPercent'] : SKIP
+      total_declined_count_percent =
+        hash.key?('totalDeclinedCountPercent') ? hash['totalDeclinedCountPercent'] : SKIP
+      total_declined_amount_percent =
+        hash.key?('totalDeclinedAmountPercent') ? hash['totalDeclinedAmountPercent'] : SKIP
+      total_count = hash.key?('totalCount') ? hash['totalCount'] : SKIP
+      total_amount = hash.key?('totalAmount') ? hash['totalAmount'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      summaries = nil
+      unless hash['summaries'].nil?
+        summaries = []
+        hash['summaries'].each do |structure|
+          summaries << (Summary3.from_hash(structure) if structure)
+        end
+      end
+
+      summaries = SKIP unless hash.key?('summaries')
+
+      # 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.
+      SummaryDetailDivision.new(pagination: pagination,
+                                total_approved_count: total_approved_count,
+                                total_approved_amount: total_approved_amount,
+                                total_declined_count: total_declined_count,
+                                total_declined_amount: total_declined_amount,
+                                total_approved_count_percent: total_approved_count_percent,
+                                total_approved_amount_percent: total_approved_amount_percent,
+                                total_declined_count_percent: total_declined_count_percent,
+                                total_declined_amount_percent: total_declined_amount_percent,
+                                total_count: total_count,
+                                total_amount: total_amount,
+                                summaries: summaries,
+                                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} pagination: #{@pagination}, total_approved_count: #{@total_approved_count},"\
+      " total_approved_amount: #{@total_approved_amount}, total_declined_count:"\
+      " #{@total_declined_count}, total_declined_amount: #{@total_declined_amount},"\
+      " total_approved_count_percent: #{@total_approved_count_percent},"\
+      " total_approved_amount_percent: #{@total_approved_amount_percent},"\
+      " total_declined_count_percent: #{@total_declined_count_percent},"\
+      " total_declined_amount_percent: #{@total_declined_amount_percent}, total_count:"\
+      " #{@total_count}, total_amount: #{@total_amount}, summaries: #{@summaries},"\
+      " 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} pagination: #{@pagination.inspect}, total_approved_count:"\
+      " #{@total_approved_count.inspect}, total_approved_amount:"\
+      " #{@total_approved_amount.inspect}, total_declined_count: #{@total_declined_count.inspect},"\
+      " total_declined_amount: #{@total_declined_amount.inspect}, total_approved_count_percent:"\
+      " #{@total_approved_count_percent.inspect}, total_approved_amount_percent:"\
+      " #{@total_approved_amount_percent.inspect}, total_declined_count_percent:"\
+      " #{@total_declined_count_percent.inspect}, total_declined_amount_percent:"\
+      " #{@total_declined_amount_percent.inspect}, total_count: #{@total_count.inspect},"\
+      " total_amount: #{@total_amount.inspect}, summaries: #{@summaries.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/reporting_authorization_summary_api/models/summary_detail_entity_chain.rb

@@ -0,0 +1,79 @@
+# reporting_authorization_summary_api
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingAuthorizationSummaryApi
+  # SummaryDetailEntityChain Model.
+  class SummaryDetailEntityChain < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The level of the merchant hierarchy that groups merchant identifiers
+    # (MIDs) and any related roll-up values under a common identifier for
+    # settlement, billing, and reporting. Chain Code is the primary identifier
+    # for merchants boarded in a MDB (Merchant Database) system.
+    # @return [String]
+    attr_accessor :chain_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['chain_code'] = 'chainCode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        chain_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(chain_code: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @chain_code = chain_code unless chain_code == 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.
+      chain_code = hash.key?('chainCode') ? hash['chainCode'] : 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.
+      SummaryDetailEntityChain.new(chain_code: chain_code,
+                                   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} chain_code: #{@chain_code}, 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} chain_code: #{@chain_code.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/reporting_authorization_summary_api/models/summary_detail_entity_entity.rb

@@ -0,0 +1,79 @@
+# reporting_authorization_summary_api
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingAuthorizationSummaryApi
+  # SummaryDetailEntityEntity Model.
+  class SummaryDetailEntityEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The last level in the Vertical Hierarchy and the unique identifier
+    # assigned for a processing location, business type, and MCC Code. It
+    # requires a specific value to define merchant authorizations, settlement,
+    # reporting, pricing, and billing levels.
+    # @return [String]
+    attr_accessor :merchant_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['merchant_id'] = 'merchantId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        merchant_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(merchant_id: 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
+      @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
+
+      # 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.
+      SummaryDetailEntityEntity.new(merchant_id: merchant_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} merchant_id: #{@merchant_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} merchant_id: #{@merchant_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end