wp-sdk 1.0.0

data/lib/reporting_settlement_research_api/models/interchange_details.rb

@@ -0,0 +1,215 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # InterchangeDetails Model.
+  class InterchangeDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [CardProductResults]
+    attr_accessor :card_product_results
+
+    # TODO: Write general description for this method
+    # @return [CardProductType]
+    attr_accessor :card_product_type
+
+    # The number of days late.
+    # @return [String]
+    attr_accessor :days_late
+
+    # The amount of the discount applied.
+    # @return [String]
+    attr_accessor :discount_amount
+
+    # The amount of the discount applied.
+    # @return [InterchangeCode]
+    attr_accessor :interchange_code
+
+    # Fees between banks for processing credit and debit transactions
+    # interchangeably.
+    # @return [String]
+    attr_accessor :interchange_fee
+
+    # Indicator of organization interchange.
+    # @return [String]
+    attr_accessor :original_interchange_indicator
+
+    # The additional fee added to the original cost or payment.
+    # @return [String]
+    attr_accessor :surcharge_amount
+
+    # The additional fee added to the original cost or payment.
+    # @return [SurchargeReason]
+    attr_accessor :surcharge_reason
+
+    # The additional fee imposed by a merchant for using a particular payment
+    # method or service.
+    # @return [String]
+    attr_accessor :merchant_surcharge_amount
+
+    # The charge for the convenience of using a service or making a transaction,
+    # typically online.
+    # @return [String]
+    attr_accessor :convenience_fee
+
+    # The charge for the convenience of using a service or making a transaction,
+    # typically online.
+    # @return [BillingIndicator]
+    attr_accessor :billing_indicator
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card_product_results'] = 'cardProductResults'
+      @_hash['card_product_type'] = 'cardProductType'
+      @_hash['days_late'] = 'daysLate'
+      @_hash['discount_amount'] = 'discountAmount'
+      @_hash['interchange_code'] = 'interchangeCode'
+      @_hash['interchange_fee'] = 'interchangeFee'
+      @_hash['original_interchange_indicator'] =
+        'originalInterchangeIndicator'
+      @_hash['surcharge_amount'] = 'surchargeAmount'
+      @_hash['surcharge_reason'] = 'surchargeReason'
+      @_hash['merchant_surcharge_amount'] = 'merchantSurchargeAmount'
+      @_hash['convenience_fee'] = 'convenienceFee'
+      @_hash['billing_indicator'] = 'billingIndicator'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card_product_results
+        card_product_type
+        days_late
+        discount_amount
+        interchange_code
+        interchange_fee
+        original_interchange_indicator
+        surcharge_amount
+        surcharge_reason
+        merchant_surcharge_amount
+        convenience_fee
+        billing_indicator
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(card_product_results: SKIP, card_product_type: SKIP,
+                   days_late: SKIP, discount_amount: SKIP,
+                   interchange_code: SKIP, interchange_fee: SKIP,
+                   original_interchange_indicator: SKIP, surcharge_amount: SKIP,
+                   surcharge_reason: SKIP, merchant_surcharge_amount: SKIP,
+                   convenience_fee: SKIP, billing_indicator: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @card_product_results = card_product_results unless card_product_results == SKIP
+      @card_product_type = card_product_type unless card_product_type == SKIP
+      @days_late = days_late unless days_late == SKIP
+      @discount_amount = discount_amount unless discount_amount == SKIP
+      @interchange_code = interchange_code unless interchange_code == SKIP
+      @interchange_fee = interchange_fee unless interchange_fee == SKIP
+      unless original_interchange_indicator == SKIP
+        @original_interchange_indicator =
+          original_interchange_indicator
+      end
+      @surcharge_amount = surcharge_amount unless surcharge_amount == SKIP
+      @surcharge_reason = surcharge_reason unless surcharge_reason == SKIP
+      unless merchant_surcharge_amount == SKIP
+        @merchant_surcharge_amount =
+          merchant_surcharge_amount
+      end
+      @convenience_fee = convenience_fee unless convenience_fee == SKIP
+      @billing_indicator = billing_indicator unless billing_indicator == 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.
+      card_product_results = CardProductResults.from_hash(hash['cardProductResults']) if
+        hash['cardProductResults']
+      card_product_type = CardProductType.from_hash(hash['cardProductType']) if
+        hash['cardProductType']
+      days_late = hash.key?('daysLate') ? hash['daysLate'] : SKIP
+      discount_amount =
+        hash.key?('discountAmount') ? hash['discountAmount'] : SKIP
+      interchange_code = InterchangeCode.from_hash(hash['interchangeCode']) if
+        hash['interchangeCode']
+      interchange_fee =
+        hash.key?('interchangeFee') ? hash['interchangeFee'] : SKIP
+      original_interchange_indicator =
+        hash.key?('originalInterchangeIndicator') ? hash['originalInterchangeIndicator'] : SKIP
+      surcharge_amount =
+        hash.key?('surchargeAmount') ? hash['surchargeAmount'] : SKIP
+      surcharge_reason = SurchargeReason.from_hash(hash['surchargeReason']) if
+        hash['surchargeReason']
+      merchant_surcharge_amount =
+        hash.key?('merchantSurchargeAmount') ? hash['merchantSurchargeAmount'] : SKIP
+      convenience_fee =
+        hash.key?('convenienceFee') ? hash['convenienceFee'] : SKIP
+      billing_indicator = BillingIndicator.from_hash(hash['billingIndicator']) if
+        hash['billingIndicator']
+
+      # 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.
+      InterchangeDetails.new(card_product_results: card_product_results,
+                             card_product_type: card_product_type,
+                             days_late: days_late,
+                             discount_amount: discount_amount,
+                             interchange_code: interchange_code,
+                             interchange_fee: interchange_fee,
+                             original_interchange_indicator: original_interchange_indicator,
+                             surcharge_amount: surcharge_amount,
+                             surcharge_reason: surcharge_reason,
+                             merchant_surcharge_amount: merchant_surcharge_amount,
+                             convenience_fee: convenience_fee,
+                             billing_indicator: billing_indicator,
+                             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} card_product_results: #{@card_product_results}, card_product_type:"\
+      " #{@card_product_type}, days_late: #{@days_late}, discount_amount: #{@discount_amount},"\
+      " interchange_code: #{@interchange_code}, interchange_fee: #{@interchange_fee},"\
+      " original_interchange_indicator: #{@original_interchange_indicator}, surcharge_amount:"\
+      " #{@surcharge_amount}, surcharge_reason: #{@surcharge_reason}, merchant_surcharge_amount:"\
+      " #{@merchant_surcharge_amount}, convenience_fee: #{@convenience_fee}, billing_indicator:"\
+      " #{@billing_indicator}, 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} card_product_results: #{@card_product_results.inspect}, card_product_type:"\
+      " #{@card_product_type.inspect}, days_late: #{@days_late.inspect}, discount_amount:"\
+      " #{@discount_amount.inspect}, interchange_code: #{@interchange_code.inspect},"\
+      " interchange_fee: #{@interchange_fee.inspect}, original_interchange_indicator:"\
+      " #{@original_interchange_indicator.inspect}, surcharge_amount:"\
+      " #{@surcharge_amount.inspect}, surcharge_reason: #{@surcharge_reason.inspect},"\
+      " merchant_surcharge_amount: #{@merchant_surcharge_amount.inspect}, convenience_fee:"\
+      " #{@convenience_fee.inspect}, billing_indicator: #{@billing_indicator.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/reporting_settlement_research_api/models/interchange_details1.rb

@@ -0,0 +1,116 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # InterchangeDetails1 Model.
+  class InterchangeDetails1 < 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.
+      InterchangeDetails1.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

data/lib/reporting_settlement_research_api/models/international_indicator.rb

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

data/lib/reporting_settlement_research_api/models/level.rb

@@ -0,0 +1,45 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # The support levels such as Chain, Division, Store, and Merchant with a
+  # maximum limit of 2000 values.
+  class Level
+    LEVEL = [
+      # TODO: Write general description for MERCHANT
+      MERCHANT = 'MERCHANT'.freeze,
+
+      # TODO: Write general description for STORE
+      STORE = 'STORE'.freeze,
+
+      # TODO: Write general description for DIVISION
+      DIVISION = 'DIVISION'.freeze,
+
+      # TODO: Write general description for CHAIN
+      CHAIN = 'CHAIN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = MERCHANT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'merchant' then MERCHANT
+      when 'store' then STORE
+      when 'division' then DIVISION
+      when 'chain' then CHAIN
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/reporting_settlement_research_api/models/level1.rb

@@ -0,0 +1,49 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # The support levels such as Super_Chain with a maximum limit of 7 values,
+  # Chain, Division, Store, and Merchant with a maximum limit of 2000 values.
+  class Level1
+    LEVEL1 = [
+      # TODO: Write general description for MERCHANT
+      MERCHANT = 'MERCHANT'.freeze,
+
+      # TODO: Write general description for STORE
+      STORE = 'STORE'.freeze,
+
+      # TODO: Write general description for DIVISION
+      DIVISION = 'DIVISION'.freeze,
+
+      # TODO: Write general description for CHAIN
+      CHAIN = 'CHAIN'.freeze,
+
+      # TODO: Write general description for SUPER_CHAIN
+      SUPER_CHAIN = 'SUPER_CHAIN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = MERCHANT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'merchant' then MERCHANT
+      when 'store' then STORE
+      when 'division' then DIVISION
+      when 'chain' then CHAIN
+      when 'super_chain' then SUPER_CHAIN
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/reporting_settlement_research_api/models/level2.rb

@@ -0,0 +1,37 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # Support levels such as Chain and Merchant with a maximum limit of 2,000
+  # values.
+  class Level2
+    LEVEL2 = [
+      # TODO: Write general description for MERCHANT
+      MERCHANT = 'MERCHANT'.freeze,
+
+      # TODO: Write general description for CHAIN
+      CHAIN = 'CHAIN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = MERCHANT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'merchant' then MERCHANT
+      when 'chain' then CHAIN
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/reporting_settlement_research_api/models/level3.rb

@@ -0,0 +1,67 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # The support levels such as SalesOrganization and Sales Channel with a
+  # maximum limit of 1 value, National, SuperChain, and Partner with a maximum
+  # limit of 10 values, and Chain, Division, Store, and Merchant with a maximum
+  # limit of 2,000 values.
+  class Level3
+    LEVEL3 = [
+      # TODO: Write general description for MERCHANT
+      MERCHANT = 'MERCHANT'.freeze,
+
+      # TODO: Write general description for STORE
+      STORE = 'STORE'.freeze,
+
+      # TODO: Write general description for DIVISION
+      DIVISION = 'DIVISION'.freeze,
+
+      # TODO: Write general description for CHAIN
+      CHAIN = 'CHAIN'.freeze,
+
+      # TODO: Write general description for PARTNER
+      PARTNER = 'PARTNER'.freeze,
+
+      # TODO: Write general description for SUPER_CHAIN
+      SUPER_CHAIN = 'SUPER_CHAIN'.freeze,
+
+      # TODO: Write general description for NATIONAL
+      NATIONAL = 'NATIONAL'.freeze,
+
+      # TODO: Write general description for INDEPENDENT_SALES_CHANNEL
+      INDEPENDENT_SALES_CHANNEL = 'INDEPENDENT_SALES_CHANNEL'.freeze,
+
+      # TODO: Write general description for INDEPENDENT_SALES_ORGANIZATION
+      INDEPENDENT_SALES_ORGANIZATION = 'INDEPENDENT_SALES_ORGANIZATION'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = MERCHANT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'merchant' then MERCHANT
+      when 'store' then STORE
+      when 'division' then DIVISION
+      when 'chain' then CHAIN
+      when 'partner' then PARTNER
+      when 'super_chain' then SUPER_CHAIN
+      when 'national' then NATIONAL
+      when 'independent_sales_channel' then INDEPENDENT_SALES_CHANNEL
+      when 'independent_sales_organization' then INDEPENDENT_SALES_ORGANIZATION
+      else
+        default_value
+      end
+    end
+  end
+end