wp-sdk 1.0.0

data/lib/reporting_settlement_research_api/models/hierarchy7.rb

@@ -0,0 +1,131 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # Hierarchy7 Model.
+  class Hierarchy7 < 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 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 typically three-digit Division Number which is unique to that
+    # particular Chain.
+    # @return [String]
+    attr_accessor :division_number
+
+    # The lowest roll-up level in the hierarchy system, grouping multiple
+    # merchant account numbers (MIDs) used in a single merchant location. The
+    # Store/Locations are used to link multiple merchant numbers assigned to
+    # different terminals and/or business lines (MCC’s). A Store Number is of
+    # nice digits and unique to a particular Chain.
+    # @return [String]
+    attr_accessor :store_number
+
+    # The identifier code associated with a given merchant under a Store-level
+    # hierarchy.
+    # @return [String]
+    attr_accessor :merchant_id
+
+    # The name of a business or registered name of the company or entity
+    # operating the business.
+    # @return [String]
+    attr_accessor :merchant_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['chain_code'] = 'chainCode'
+      @_hash['division_number'] = 'divisionNumber'
+      @_hash['store_number'] = 'storeNumber'
+      @_hash['merchant_id'] = 'merchantId'
+      @_hash['merchant_name'] = 'merchantName'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        chain_code
+        division_number
+        store_number
+        merchant_id
+        merchant_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(chain_code: SKIP, division_number: SKIP, store_number: SKIP,
+                   merchant_id: SKIP, merchant_name: 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
+      @division_number = division_number unless division_number == SKIP
+      @store_number = store_number unless store_number == SKIP
+      @merchant_id = merchant_id unless merchant_id == SKIP
+      @merchant_name = merchant_name unless merchant_name == 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
+      division_number =
+        hash.key?('divisionNumber') ? hash['divisionNumber'] : SKIP
+      store_number = hash.key?('storeNumber') ? hash['storeNumber'] : SKIP
+      merchant_id = hash.key?('merchantId') ? hash['merchantId'] : SKIP
+      merchant_name = hash.key?('merchantName') ? hash['merchantName'] : 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.
+      Hierarchy7.new(chain_code: chain_code,
+                     division_number: division_number,
+                     store_number: store_number,
+                     merchant_id: merchant_id,
+                     merchant_name: merchant_name,
+                     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}, division_number: #{@division_number},"\
+      " store_number: #{@store_number}, merchant_id: #{@merchant_id}, merchant_name:"\
+      " #{@merchant_name}, 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}, division_number:"\
+      " #{@division_number.inspect}, store_number: #{@store_number.inspect}, merchant_id:"\
+      " #{@merchant_id.inspect}, merchant_name: #{@merchant_name.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/reporting_settlement_research_api/models/hierarchy9.rb

@@ -0,0 +1,119 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # Hierarchy9 Model.
+  class Hierarchy9 < 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 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 typically three-digit Division Number which is unique to that
+    # particular Chain.
+    # @return [String]
+    attr_accessor :division_number
+
+    # The lowest roll-up level in the hierarchy system, grouping multiple
+    # merchant account numbers (MIDs) used in a single merchant location. The
+    # Store/Locations are used to link multiple merchant numbers assigned to
+    # different terminals and/or business lines (MCC’s). A Store Number is nine
+    # digits and unique to a particular Chain.
+    # @return [String]
+    attr_accessor :store_number
+
+    # The identifier code associated with a given merchant under a Store-level
+    # hierarchy.
+    # @return [String]
+    attr_accessor :merchant_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['chain_code'] = 'chainCode'
+      @_hash['division_number'] = 'divisionNumber'
+      @_hash['store_number'] = 'storeNumber'
+      @_hash['merchant_id'] = 'merchantId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        chain_code
+        division_number
+        store_number
+        merchant_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(chain_code: SKIP, division_number: SKIP, store_number: SKIP,
+                   merchant_id: 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
+      @division_number = division_number unless division_number == SKIP
+      @store_number = store_number unless store_number == 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.
+      chain_code = hash.key?('chainCode') ? hash['chainCode'] : SKIP
+      division_number =
+        hash.key?('divisionNumber') ? hash['divisionNumber'] : SKIP
+      store_number = hash.key?('storeNumber') ? hash['storeNumber'] : 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.
+      Hierarchy9.new(chain_code: chain_code,
+                     division_number: division_number,
+                     store_number: store_number,
+                     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} chain_code: #{@chain_code}, division_number: #{@division_number},"\
+      " store_number: #{@store_number}, 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} chain_code: #{@chain_code.inspect}, division_number:"\
+      " #{@division_number.inspect}, store_number: #{@store_number.inspect}, merchant_id:"\
+      " #{@merchant_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/reporting_settlement_research_api/models/hierarchy_level.rb

@@ -0,0 +1,99 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # The merchant hierarchy levels.
+  class HierarchyLevel < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Level1]
+    attr_accessor :level
+
+    # The values of the hierarchy levels.
+    # @return [Array[String]]
+    attr_accessor :values
+
+    # 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 MDB (Merchant Database) system. <br> Chain Code
+    # is mandatory when the level is store or division.
+    # @return [String]
+    attr_accessor :chain_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['level'] = 'level'
+      @_hash['values'] = 'values'
+      @_hash['chain_code'] = 'chainCode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        level
+        values
+        chain_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(level: SKIP, values: SKIP, chain_code: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @level = level unless level == SKIP
+      @values = values unless values == SKIP
+      @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.
+      level = hash.key?('level') ? hash['level'] : SKIP
+      values = hash.key?('values') ? hash['values'] : SKIP
+      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.
+      HierarchyLevel.new(level: level,
+                         values: values,
+                         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} level: #{@level}, values: #{@values}, 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} level: #{@level.inspect}, values: #{@values.inspect}, chain_code:"\
+      " #{@chain_code.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/reporting_settlement_research_api/models/hierarchy_levels.rb

@@ -0,0 +1,99 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # The merchant hierarchy levels.
+  class HierarchyLevels < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Level]
+    attr_accessor :level
+
+    # The values of the hierarchy levels.
+    # @return [Array[String]]
+    attr_accessor :values
+
+    # 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 MDB (Merchant Database) system. <br> Chain Code
+    # is mandatory when the level is store or division.
+    # @return [String]
+    attr_accessor :chain_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['level'] = 'level'
+      @_hash['values'] = 'values'
+      @_hash['chain_code'] = 'chainCode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        level
+        values
+        chain_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(level: SKIP, values: SKIP, chain_code: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @level = level unless level == SKIP
+      @values = values unless values == SKIP
+      @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.
+      level = hash.key?('level') ? hash['level'] : SKIP
+      values = hash.key?('values') ? hash['values'] : SKIP
+      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.
+      HierarchyLevels.new(level: level,
+                          values: values,
+                          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} level: #{@level}, values: #{@values}, 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} level: #{@level.inspect}, values: #{@values.inspect}, chain_code:"\
+      " #{@chain_code.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/reporting_settlement_research_api/models/interchange_code.rb

@@ -0,0 +1,85 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # InterchangeCode Model.
+  class InterchangeCode < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The identifier code.
+    # @return [String]
+    attr_accessor :code
+
+    # The description of the code.
+    # @return [String]
+    attr_accessor :description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash['description'] = 'description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code: SKIP, description: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @code = code unless code == SKIP
+      @description = description unless description == 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.
+      code = hash.key?('code') ? hash['code'] : SKIP
+      description = hash.key?('description') ? hash['description'] : 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.
+      InterchangeCode.new(code: code,
+                          description: description,
+                          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} code: #{@code}, description: #{@description}, 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} code: #{@code.inspect}, description: #{@description.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/reporting_settlement_research_api/models/interchange_data.rb

@@ -0,0 +1,116 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # Refers to interchange data.
+  class InterchangeData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Mechanism to resolve disputes or conflicts in settlements.
+    # @return [String]
+    attr_accessor :tie_breaker
+
+    # Fees between banks for processing credit and debit transactions
+    # interchangeably.
+    # @return [Float]
+    attr_accessor :interchange_fees
+
+    # An additional fee added to the original cost or payment.
+    # @return [Float]
+    attr_accessor :surcharge_amount
+
+    # An additional fee imposed by a merchant for using a particular payment
+    # method or service.
+    # @return [Float]
+    attr_accessor :merchant_surcharge_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tie_breaker'] = 'tieBreaker'
+      @_hash['interchange_fees'] = 'interchangeFees'
+      @_hash['surcharge_amount'] = 'surchargeAmount'
+      @_hash['merchant_surcharge_amount'] = 'merchantSurchargeAmount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tie_breaker
+        interchange_fees
+        surcharge_amount
+        merchant_surcharge_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tie_breaker: SKIP, interchange_fees: SKIP,
+                   surcharge_amount: SKIP, merchant_surcharge_amount: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @tie_breaker = tie_breaker unless tie_breaker == SKIP
+      @interchange_fees = interchange_fees unless interchange_fees == SKIP
+      @surcharge_amount = surcharge_amount unless surcharge_amount == SKIP
+      unless merchant_surcharge_amount == SKIP
+        @merchant_surcharge_amount =
+          merchant_surcharge_amount
+      end
+      @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.
+      tie_breaker = hash.key?('tieBreaker') ? hash['tieBreaker'] : SKIP
+      interchange_fees =
+        hash.key?('interchangeFees') ? hash['interchangeFees'] : SKIP
+      surcharge_amount =
+        hash.key?('surchargeAmount') ? hash['surchargeAmount'] : SKIP
+      merchant_surcharge_amount =
+        hash.key?('merchantSurchargeAmount') ? hash['merchantSurchargeAmount'] : 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.
+      InterchangeData.new(tie_breaker: tie_breaker,
+                          interchange_fees: interchange_fees,
+                          surcharge_amount: surcharge_amount,
+                          merchant_surcharge_amount: merchant_surcharge_amount,
+                          additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} tie_breaker: #{@tie_breaker}, interchange_fees: #{@interchange_fees},"\
+      " surcharge_amount: #{@surcharge_amount}, merchant_surcharge_amount:"\
+      " #{@merchant_surcharge_amount}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} tie_breaker: #{@tie_breaker.inspect}, interchange_fees:"\
+      " #{@interchange_fees.inspect}, surcharge_amount: #{@surcharge_amount.inspect},"\
+      " merchant_surcharge_amount: #{@merchant_surcharge_amount.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end