worldpay-apimatic-sdk 0.0.1

data/lib/reporting_authorization_summary_api/models/summary2.rb

@@ -0,0 +1,190 @@
+# reporting_authorization_summary_api
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingAuthorizationSummaryApi
+  # Summary2 Model.
+  class Summary2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Count of the approved transactions.
+    # @return [Integer]
+    attr_accessor :approved_count
+
+    # Sum of the amount of approved transactions.
+    # @return [Float]
+    attr_accessor :approved_amount
+
+    # Count of the declined transactions.
+    # @return [Integer]
+    attr_accessor :declined_count
+
+    # Sum of the amount of the declined transactions.
+    # @return [Float]
+    attr_accessor :declined_amount
+
+    # Ratio of the count of the approved transactions to the count of total
+    # transctions.
+    # @return [Float]
+    attr_accessor :approved_count_percent
+
+    # Ratio of the sum of the amount of approved transactions to the sum of the
+    # amount of total transctions.
+    # @return [Float]
+    attr_accessor :approved_amount_percent
+
+    # Ratio of the count of the declined transactions to the count of total
+    # transctions.
+    # @return [Float]
+    attr_accessor :declined_count_percent
+
+    # Ratio of the sum of the amount of declined transactions to the sum of the
+    # amount of total transctions.
+    # @return [Float]
+    attr_accessor :declined_amount_percent
+
+    # 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
+
+    # The lowest roll-up level in the hierarchy system, grouping multiple
+    # merchant account numbers (MIDs) used in a single merchant location
+    # assigned to different terminals and/or business lines (MCCs). A Store
+    # Number is nine digits and unique to a particular Chain, meaning the same
+    # Store Number can exist for a Store under a different Divison/Chain, but
+    # not duplicates under the same Divison/Chain. <br> Supports entities Chain,
+    # National.
+    # @return [String]
+    attr_accessor :store_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['approved_count'] = 'approvedCount'
+      @_hash['approved_amount'] = 'approvedAmount'
+      @_hash['declined_count'] = 'declinedCount'
+      @_hash['declined_amount'] = 'declinedAmount'
+      @_hash['approved_count_percent'] = 'approvedCountPercent'
+      @_hash['approved_amount_percent'] = 'approvedAmountPercent'
+      @_hash['declined_count_percent'] = 'declinedCountPercent'
+      @_hash['declined_amount_percent'] = 'declinedAmountPercent'
+      @_hash['chain_code'] = 'chainCode'
+      @_hash['store_number'] = 'storeNumber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        approved_count
+        approved_amount
+        declined_count
+        declined_amount
+        approved_count_percent
+        approved_amount_percent
+        declined_count_percent
+        declined_amount_percent
+        chain_code
+        store_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(approved_count: SKIP, approved_amount: SKIP,
+                   declined_count: SKIP, declined_amount: SKIP,
+                   approved_count_percent: SKIP, approved_amount_percent: SKIP,
+                   declined_count_percent: SKIP, declined_amount_percent: SKIP,
+                   chain_code: SKIP, store_number: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @approved_count = approved_count unless approved_count == SKIP
+      @approved_amount = approved_amount unless approved_amount == SKIP
+      @declined_count = declined_count unless declined_count == SKIP
+      @declined_amount = declined_amount unless declined_amount == SKIP
+      @approved_count_percent = approved_count_percent unless approved_count_percent == SKIP
+      @approved_amount_percent = approved_amount_percent unless approved_amount_percent == SKIP
+      @declined_count_percent = declined_count_percent unless declined_count_percent == SKIP
+      @declined_amount_percent = declined_amount_percent unless declined_amount_percent == SKIP
+      @chain_code = chain_code unless chain_code == SKIP
+      @store_number = store_number unless store_number == 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.
+      approved_count = hash.key?('approvedCount') ? hash['approvedCount'] : SKIP
+      approved_amount =
+        hash.key?('approvedAmount') ? hash['approvedAmount'] : SKIP
+      declined_count = hash.key?('declinedCount') ? hash['declinedCount'] : SKIP
+      declined_amount =
+        hash.key?('declinedAmount') ? hash['declinedAmount'] : SKIP
+      approved_count_percent =
+        hash.key?('approvedCountPercent') ? hash['approvedCountPercent'] : SKIP
+      approved_amount_percent =
+        hash.key?('approvedAmountPercent') ? hash['approvedAmountPercent'] : SKIP
+      declined_count_percent =
+        hash.key?('declinedCountPercent') ? hash['declinedCountPercent'] : SKIP
+      declined_amount_percent =
+        hash.key?('declinedAmountPercent') ? hash['declinedAmountPercent'] : SKIP
+      chain_code = hash.key?('chainCode') ? hash['chainCode'] : SKIP
+      store_number = hash.key?('storeNumber') ? hash['storeNumber'] : 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.
+      Summary2.new(approved_count: approved_count,
+                   approved_amount: approved_amount,
+                   declined_count: declined_count,
+                   declined_amount: declined_amount,
+                   approved_count_percent: approved_count_percent,
+                   approved_amount_percent: approved_amount_percent,
+                   declined_count_percent: declined_count_percent,
+                   declined_amount_percent: declined_amount_percent,
+                   chain_code: chain_code,
+                   store_number: store_number,
+                   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} approved_count: #{@approved_count}, approved_amount: #{@approved_amount},"\
+      " declined_count: #{@declined_count}, declined_amount: #{@declined_amount},"\
+      " approved_count_percent: #{@approved_count_percent}, approved_amount_percent:"\
+      " #{@approved_amount_percent}, declined_count_percent: #{@declined_count_percent},"\
+      " declined_amount_percent: #{@declined_amount_percent}, chain_code: #{@chain_code},"\
+      " store_number: #{@store_number}, 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} approved_count: #{@approved_count.inspect}, approved_amount:"\
+      " #{@approved_amount.inspect}, declined_count: #{@declined_count.inspect}, declined_amount:"\
+      " #{@declined_amount.inspect}, approved_count_percent: #{@approved_count_percent.inspect},"\
+      " approved_amount_percent: #{@approved_amount_percent.inspect}, declined_count_percent:"\
+      " #{@declined_count_percent.inspect}, declined_amount_percent:"\
+      " #{@declined_amount_percent.inspect}, chain_code: #{@chain_code.inspect}, store_number:"\
+      " #{@store_number.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/reporting_authorization_summary_api/models/summary3.rb

@@ -0,0 +1,189 @@
+# reporting_authorization_summary_api
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingAuthorizationSummaryApi
+  # Summary3 Model.
+  class Summary3 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Count of the approved transactions.
+    # @return [Integer]
+    attr_accessor :approved_count
+
+    # Sum of the amount of approved transactions.
+    # @return [Float]
+    attr_accessor :approved_amount
+
+    # Count of the declined transactions.
+    # @return [Integer]
+    attr_accessor :declined_count
+
+    # Sum of the amount of the declined transactions.
+    # @return [Float]
+    attr_accessor :declined_amount
+
+    # Ratio of the count of the approved transactions to the count of total
+    # transctions.
+    # @return [Float]
+    attr_accessor :approved_count_percent
+
+    # Ratio of the sum of the amount of approved transactions to the sum of the
+    # amount of total transctions.
+    # @return [Float]
+    attr_accessor :approved_amount_percent
+
+    # Ratio of the count of the declined transactions to the count of total
+    # transctions.
+    # @return [Float]
+    attr_accessor :declined_count_percent
+
+    # Ratio of the sum of the amount of declined transactions to the sum of the
+    # amount of total transctions.
+    # @return [Float]
+    attr_accessor :declined_amount_percent
+
+    # 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
+
+    # The hierarchy level that enables merchants to roll-up child entities for
+    # Stores/Locations into different groups under a Chain. It is an optional
+    # hierarchy level, but if created, is required for all child entities under
+    # the Division Number which is unique to that particular Chain. <br>
+    # Supports entities Chain, National.
+    # @return [String]
+    attr_accessor :division_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['approved_count'] = 'approvedCount'
+      @_hash['approved_amount'] = 'approvedAmount'
+      @_hash['declined_count'] = 'declinedCount'
+      @_hash['declined_amount'] = 'declinedAmount'
+      @_hash['approved_count_percent'] = 'approvedCountPercent'
+      @_hash['approved_amount_percent'] = 'approvedAmountPercent'
+      @_hash['declined_count_percent'] = 'declinedCountPercent'
+      @_hash['declined_amount_percent'] = 'declinedAmountPercent'
+      @_hash['chain_code'] = 'chainCode'
+      @_hash['division_number'] = 'divisionNumber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        approved_count
+        approved_amount
+        declined_count
+        declined_amount
+        approved_count_percent
+        approved_amount_percent
+        declined_count_percent
+        declined_amount_percent
+        chain_code
+        division_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(approved_count: SKIP, approved_amount: SKIP,
+                   declined_count: SKIP, declined_amount: SKIP,
+                   approved_count_percent: SKIP, approved_amount_percent: SKIP,
+                   declined_count_percent: SKIP, declined_amount_percent: SKIP,
+                   chain_code: SKIP, division_number: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @approved_count = approved_count unless approved_count == SKIP
+      @approved_amount = approved_amount unless approved_amount == SKIP
+      @declined_count = declined_count unless declined_count == SKIP
+      @declined_amount = declined_amount unless declined_amount == SKIP
+      @approved_count_percent = approved_count_percent unless approved_count_percent == SKIP
+      @approved_amount_percent = approved_amount_percent unless approved_amount_percent == SKIP
+      @declined_count_percent = declined_count_percent unless declined_count_percent == SKIP
+      @declined_amount_percent = declined_amount_percent unless declined_amount_percent == SKIP
+      @chain_code = chain_code unless chain_code == SKIP
+      @division_number = division_number unless division_number == 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.
+      approved_count = hash.key?('approvedCount') ? hash['approvedCount'] : SKIP
+      approved_amount =
+        hash.key?('approvedAmount') ? hash['approvedAmount'] : SKIP
+      declined_count = hash.key?('declinedCount') ? hash['declinedCount'] : SKIP
+      declined_amount =
+        hash.key?('declinedAmount') ? hash['declinedAmount'] : SKIP
+      approved_count_percent =
+        hash.key?('approvedCountPercent') ? hash['approvedCountPercent'] : SKIP
+      approved_amount_percent =
+        hash.key?('approvedAmountPercent') ? hash['approvedAmountPercent'] : SKIP
+      declined_count_percent =
+        hash.key?('declinedCountPercent') ? hash['declinedCountPercent'] : SKIP
+      declined_amount_percent =
+        hash.key?('declinedAmountPercent') ? hash['declinedAmountPercent'] : SKIP
+      chain_code = hash.key?('chainCode') ? hash['chainCode'] : SKIP
+      division_number =
+        hash.key?('divisionNumber') ? hash['divisionNumber'] : 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.
+      Summary3.new(approved_count: approved_count,
+                   approved_amount: approved_amount,
+                   declined_count: declined_count,
+                   declined_amount: declined_amount,
+                   approved_count_percent: approved_count_percent,
+                   approved_amount_percent: approved_amount_percent,
+                   declined_count_percent: declined_count_percent,
+                   declined_amount_percent: declined_amount_percent,
+                   chain_code: chain_code,
+                   division_number: division_number,
+                   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} approved_count: #{@approved_count}, approved_amount: #{@approved_amount},"\
+      " declined_count: #{@declined_count}, declined_amount: #{@declined_amount},"\
+      " approved_count_percent: #{@approved_count_percent}, approved_amount_percent:"\
+      " #{@approved_amount_percent}, declined_count_percent: #{@declined_count_percent},"\
+      " declined_amount_percent: #{@declined_amount_percent}, chain_code: #{@chain_code},"\
+      " division_number: #{@division_number}, 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} approved_count: #{@approved_count.inspect}, approved_amount:"\
+      " #{@approved_amount.inspect}, declined_count: #{@declined_count.inspect}, declined_amount:"\
+      " #{@declined_amount.inspect}, approved_count_percent: #{@approved_count_percent.inspect},"\
+      " approved_amount_percent: #{@approved_amount_percent.inspect}, declined_count_percent:"\
+      " #{@declined_count_percent.inspect}, declined_amount_percent:"\
+      " #{@declined_amount_percent.inspect}, chain_code: #{@chain_code.inspect}, division_number:"\
+      " #{@division_number.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/reporting_authorization_summary_api/models/summary4.rb

@@ -0,0 +1,174 @@
+# reporting_authorization_summary_api
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingAuthorizationSummaryApi
+  # Summary4 Model.
+  class Summary4 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Count of the approved transactions.
+    # @return [Integer]
+    attr_accessor :approved_count
+
+    # Sum of the amount of approved transactions.
+    # @return [Float]
+    attr_accessor :approved_amount
+
+    # Count of the declined transactions.
+    # @return [Integer]
+    attr_accessor :declined_count
+
+    # Sum of the amount of the declined transactions.
+    # @return [Float]
+    attr_accessor :declined_amount
+
+    # Ratio of the count of the approved transactions to the count of total
+    # transctions.
+    # @return [Float]
+    attr_accessor :approved_count_percent
+
+    # Ratio of the sum of the amount of approved transactions to the sum of the
+    # amount of total transctions.
+    # @return [Float]
+    attr_accessor :approved_amount_percent
+
+    # Ratio of the count of the declined transactions to the count of total
+    # transctions.
+    # @return [Float]
+    attr_accessor :declined_count_percent
+
+    # Ratio of the sum of the amount of declined transactions to the sum of the
+    # amount of total transctions.
+    # @return [Float]
+    attr_accessor :declined_amount_percent
+
+    # 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['approved_count'] = 'approvedCount'
+      @_hash['approved_amount'] = 'approvedAmount'
+      @_hash['declined_count'] = 'declinedCount'
+      @_hash['declined_amount'] = 'declinedAmount'
+      @_hash['approved_count_percent'] = 'approvedCountPercent'
+      @_hash['approved_amount_percent'] = 'approvedAmountPercent'
+      @_hash['declined_count_percent'] = 'declinedCountPercent'
+      @_hash['declined_amount_percent'] = 'declinedAmountPercent'
+      @_hash['merchant_id'] = 'merchantId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        approved_count
+        approved_amount
+        declined_count
+        declined_amount
+        approved_count_percent
+        approved_amount_percent
+        declined_count_percent
+        declined_amount_percent
+        merchant_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(approved_count: SKIP, approved_amount: SKIP,
+                   declined_count: SKIP, declined_amount: SKIP,
+                   approved_count_percent: SKIP, approved_amount_percent: SKIP,
+                   declined_count_percent: SKIP, declined_amount_percent: SKIP,
+                   merchant_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @approved_count = approved_count unless approved_count == SKIP
+      @approved_amount = approved_amount unless approved_amount == SKIP
+      @declined_count = declined_count unless declined_count == SKIP
+      @declined_amount = declined_amount unless declined_amount == SKIP
+      @approved_count_percent = approved_count_percent unless approved_count_percent == SKIP
+      @approved_amount_percent = approved_amount_percent unless approved_amount_percent == SKIP
+      @declined_count_percent = declined_count_percent unless declined_count_percent == SKIP
+      @declined_amount_percent = declined_amount_percent unless declined_amount_percent == SKIP
+      @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.
+      approved_count = hash.key?('approvedCount') ? hash['approvedCount'] : SKIP
+      approved_amount =
+        hash.key?('approvedAmount') ? hash['approvedAmount'] : SKIP
+      declined_count = hash.key?('declinedCount') ? hash['declinedCount'] : SKIP
+      declined_amount =
+        hash.key?('declinedAmount') ? hash['declinedAmount'] : SKIP
+      approved_count_percent =
+        hash.key?('approvedCountPercent') ? hash['approvedCountPercent'] : SKIP
+      approved_amount_percent =
+        hash.key?('approvedAmountPercent') ? hash['approvedAmountPercent'] : SKIP
+      declined_count_percent =
+        hash.key?('declinedCountPercent') ? hash['declinedCountPercent'] : SKIP
+      declined_amount_percent =
+        hash.key?('declinedAmountPercent') ? hash['declinedAmountPercent'] : SKIP
+      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.
+      Summary4.new(approved_count: approved_count,
+                   approved_amount: approved_amount,
+                   declined_count: declined_count,
+                   declined_amount: declined_amount,
+                   approved_count_percent: approved_count_percent,
+                   approved_amount_percent: approved_amount_percent,
+                   declined_count_percent: declined_count_percent,
+                   declined_amount_percent: declined_amount_percent,
+                   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} approved_count: #{@approved_count}, approved_amount: #{@approved_amount},"\
+      " declined_count: #{@declined_count}, declined_amount: #{@declined_amount},"\
+      " approved_count_percent: #{@approved_count_percent}, approved_amount_percent:"\
+      " #{@approved_amount_percent}, declined_count_percent: #{@declined_count_percent},"\
+      " declined_amount_percent: #{@declined_amount_percent}, 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} approved_count: #{@approved_count.inspect}, approved_amount:"\
+      " #{@approved_amount.inspect}, declined_count: #{@declined_count.inspect}, declined_amount:"\
+      " #{@declined_amount.inspect}, approved_count_percent: #{@approved_count_percent.inspect},"\
+      " approved_amount_percent: #{@approved_amount_percent.inspect}, declined_count_percent:"\
+      " #{@declined_count_percent.inspect}, declined_amount_percent:"\
+      " #{@declined_amount_percent.inspect}, merchant_id: #{@merchant_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end