wp-sdk 1.0.0

data/lib/reporting_settlement_research_api/models/transaction_summary.rb

@@ -0,0 +1,182 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # TransactionSummary Model.
+  class TransactionSummary < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The total sum of transactions processed and finalized within a specific
+    # time period.
+    # @return [Float]
+    attr_accessor :settlement_amount
+
+    # The approved amount of money to be charged.
+    # @return [Float]
+    attr_accessor :authorization_amount
+
+    # The amount of the discount applied.
+    # @return [Float]
+    attr_accessor :discount_amount
+
+    # The number of card sales over a given period of time.
+    # @return [Float]
+    attr_accessor :sales_count
+
+    # The number of returns over a given period of time.
+    # @return [Float]
+    attr_accessor :returns_count
+
+    # The number of transactions over a given period of time.
+    # @return [Float]
+    attr_accessor :transactions_count
+
+    # The number of reversals over a given period of time.
+    # @return [Float]
+    attr_accessor :reversals_count
+
+    # The number of corrections or changes made to finalized transactions.
+    # @return [Float]
+    attr_accessor :adjustments_count
+
+    # The amount of the transaction totals changed for accuracy and
+    # reconciliation purposes.
+    # @return [Float]
+    attr_accessor :adjustments_amount
+
+    # The agreed upon sum for a transaction after authorization and processing
+    # steps.
+    # @return [Float]
+    attr_accessor :approved_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['settlement_amount'] = 'settlementAmount'
+      @_hash['authorization_amount'] = 'authorizationAmount'
+      @_hash['discount_amount'] = 'discountAmount'
+      @_hash['sales_count'] = 'salesCount'
+      @_hash['returns_count'] = 'returnsCount'
+      @_hash['transactions_count'] = 'transactionsCount'
+      @_hash['reversals_count'] = 'reversalsCount'
+      @_hash['adjustments_count'] = 'adjustmentsCount'
+      @_hash['adjustments_amount'] = 'adjustmentsAmount'
+      @_hash['approved_amount'] = 'approvedAmount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        settlement_amount
+        authorization_amount
+        discount_amount
+        sales_count
+        returns_count
+        transactions_count
+        reversals_count
+        adjustments_count
+        adjustments_amount
+        approved_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(settlement_amount: SKIP, authorization_amount: SKIP,
+                   discount_amount: SKIP, sales_count: SKIP,
+                   returns_count: SKIP, transactions_count: SKIP,
+                   reversals_count: SKIP, adjustments_count: SKIP,
+                   adjustments_amount: SKIP, approved_amount: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @settlement_amount = settlement_amount unless settlement_amount == SKIP
+      @authorization_amount = authorization_amount unless authorization_amount == SKIP
+      @discount_amount = discount_amount unless discount_amount == SKIP
+      @sales_count = sales_count unless sales_count == SKIP
+      @returns_count = returns_count unless returns_count == SKIP
+      @transactions_count = transactions_count unless transactions_count == SKIP
+      @reversals_count = reversals_count unless reversals_count == SKIP
+      @adjustments_count = adjustments_count unless adjustments_count == SKIP
+      @adjustments_amount = adjustments_amount unless adjustments_amount == SKIP
+      @approved_amount = approved_amount unless approved_amount == 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.
+      settlement_amount =
+        hash.key?('settlementAmount') ? hash['settlementAmount'] : SKIP
+      authorization_amount =
+        hash.key?('authorizationAmount') ? hash['authorizationAmount'] : SKIP
+      discount_amount =
+        hash.key?('discountAmount') ? hash['discountAmount'] : SKIP
+      sales_count = hash.key?('salesCount') ? hash['salesCount'] : SKIP
+      returns_count = hash.key?('returnsCount') ? hash['returnsCount'] : SKIP
+      transactions_count =
+        hash.key?('transactionsCount') ? hash['transactionsCount'] : SKIP
+      reversals_count =
+        hash.key?('reversalsCount') ? hash['reversalsCount'] : SKIP
+      adjustments_count =
+        hash.key?('adjustmentsCount') ? hash['adjustmentsCount'] : SKIP
+      adjustments_amount =
+        hash.key?('adjustmentsAmount') ? hash['adjustmentsAmount'] : SKIP
+      approved_amount =
+        hash.key?('approvedAmount') ? hash['approvedAmount'] : 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.
+      TransactionSummary.new(settlement_amount: settlement_amount,
+                             authorization_amount: authorization_amount,
+                             discount_amount: discount_amount,
+                             sales_count: sales_count,
+                             returns_count: returns_count,
+                             transactions_count: transactions_count,
+                             reversals_count: reversals_count,
+                             adjustments_count: adjustments_count,
+                             adjustments_amount: adjustments_amount,
+                             approved_amount: approved_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} settlement_amount: #{@settlement_amount}, authorization_amount:"\
+      " #{@authorization_amount}, discount_amount: #{@discount_amount}, sales_count:"\
+      " #{@sales_count}, returns_count: #{@returns_count}, transactions_count:"\
+      " #{@transactions_count}, reversals_count: #{@reversals_count}, adjustments_count:"\
+      " #{@adjustments_count}, adjustments_amount: #{@adjustments_amount}, approved_amount:"\
+      " #{@approved_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} settlement_amount: #{@settlement_amount.inspect}, authorization_amount:"\
+      " #{@authorization_amount.inspect}, discount_amount: #{@discount_amount.inspect},"\
+      " sales_count: #{@sales_count.inspect}, returns_count: #{@returns_count.inspect},"\
+      " transactions_count: #{@transactions_count.inspect}, reversals_count:"\
+      " #{@reversals_count.inspect}, adjustments_count: #{@adjustments_count.inspect},"\
+      " adjustments_amount: #{@adjustments_amount.inspect}, approved_amount:"\
+      " #{@approved_amount.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/reporting_settlement_research_api/models/transaction_summary_data.rb

@@ -0,0 +1,182 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # The summary of the transaction data.
+  class TransactionSummaryData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The total sum of transactions processed and finalized within a specific
+    # time period.
+    # @return [Float]
+    attr_accessor :settlement_amount
+
+    # The approved amount of money to be charged.
+    # @return [Float]
+    attr_accessor :authorization_amount
+
+    # The amount of the discount applied.
+    # @return [Float]
+    attr_accessor :discount_amount
+
+    # The number of card sales over a given period of time.
+    # @return [Float]
+    attr_accessor :sales_count
+
+    # The number of returns over a given period of time.
+    # @return [Float]
+    attr_accessor :returns_count
+
+    # The number of transactions over a given period of time.
+    # @return [Float]
+    attr_accessor :transactions_count
+
+    # The number of reversals over a given period of time.
+    # @return [Float]
+    attr_accessor :reversals_count
+
+    # The number of corrections or changes made to finalized transactions.
+    # @return [Float]
+    attr_accessor :adjustments_count
+
+    # The amount of the transaction totals changed for accuracy and
+    # reconciliation purposes.
+    # @return [Float]
+    attr_accessor :adjustments_amount
+
+    # The agreed upon sum for a transaction after authorization and processing
+    # steps.
+    # @return [Float]
+    attr_accessor :approved_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['settlement_amount'] = 'settlementAmount'
+      @_hash['authorization_amount'] = 'authorizationAmount'
+      @_hash['discount_amount'] = 'discountAmount'
+      @_hash['sales_count'] = 'salesCount'
+      @_hash['returns_count'] = 'returnsCount'
+      @_hash['transactions_count'] = 'transactionsCount'
+      @_hash['reversals_count'] = 'reversalsCount'
+      @_hash['adjustments_count'] = 'adjustmentsCount'
+      @_hash['adjustments_amount'] = 'adjustmentsAmount'
+      @_hash['approved_amount'] = 'approvedAmount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        settlement_amount
+        authorization_amount
+        discount_amount
+        sales_count
+        returns_count
+        transactions_count
+        reversals_count
+        adjustments_count
+        adjustments_amount
+        approved_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(settlement_amount: SKIP, authorization_amount: SKIP,
+                   discount_amount: SKIP, sales_count: SKIP,
+                   returns_count: SKIP, transactions_count: SKIP,
+                   reversals_count: SKIP, adjustments_count: SKIP,
+                   adjustments_amount: SKIP, approved_amount: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @settlement_amount = settlement_amount unless settlement_amount == SKIP
+      @authorization_amount = authorization_amount unless authorization_amount == SKIP
+      @discount_amount = discount_amount unless discount_amount == SKIP
+      @sales_count = sales_count unless sales_count == SKIP
+      @returns_count = returns_count unless returns_count == SKIP
+      @transactions_count = transactions_count unless transactions_count == SKIP
+      @reversals_count = reversals_count unless reversals_count == SKIP
+      @adjustments_count = adjustments_count unless adjustments_count == SKIP
+      @adjustments_amount = adjustments_amount unless adjustments_amount == SKIP
+      @approved_amount = approved_amount unless approved_amount == 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.
+      settlement_amount =
+        hash.key?('settlementAmount') ? hash['settlementAmount'] : SKIP
+      authorization_amount =
+        hash.key?('authorizationAmount') ? hash['authorizationAmount'] : SKIP
+      discount_amount =
+        hash.key?('discountAmount') ? hash['discountAmount'] : SKIP
+      sales_count = hash.key?('salesCount') ? hash['salesCount'] : SKIP
+      returns_count = hash.key?('returnsCount') ? hash['returnsCount'] : SKIP
+      transactions_count =
+        hash.key?('transactionsCount') ? hash['transactionsCount'] : SKIP
+      reversals_count =
+        hash.key?('reversalsCount') ? hash['reversalsCount'] : SKIP
+      adjustments_count =
+        hash.key?('adjustmentsCount') ? hash['adjustmentsCount'] : SKIP
+      adjustments_amount =
+        hash.key?('adjustmentsAmount') ? hash['adjustmentsAmount'] : SKIP
+      approved_amount =
+        hash.key?('approvedAmount') ? hash['approvedAmount'] : 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.
+      TransactionSummaryData.new(settlement_amount: settlement_amount,
+                                 authorization_amount: authorization_amount,
+                                 discount_amount: discount_amount,
+                                 sales_count: sales_count,
+                                 returns_count: returns_count,
+                                 transactions_count: transactions_count,
+                                 reversals_count: reversals_count,
+                                 adjustments_count: adjustments_count,
+                                 adjustments_amount: adjustments_amount,
+                                 approved_amount: approved_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} settlement_amount: #{@settlement_amount}, authorization_amount:"\
+      " #{@authorization_amount}, discount_amount: #{@discount_amount}, sales_count:"\
+      " #{@sales_count}, returns_count: #{@returns_count}, transactions_count:"\
+      " #{@transactions_count}, reversals_count: #{@reversals_count}, adjustments_count:"\
+      " #{@adjustments_count}, adjustments_amount: #{@adjustments_amount}, approved_amount:"\
+      " #{@approved_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} settlement_amount: #{@settlement_amount.inspect}, authorization_amount:"\
+      " #{@authorization_amount.inspect}, discount_amount: #{@discount_amount.inspect},"\
+      " sales_count: #{@sales_count.inspect}, returns_count: #{@returns_count.inspect},"\
+      " transactions_count: #{@transactions_count.inspect}, reversals_count:"\
+      " #{@reversals_count.inspect}, adjustments_count: #{@adjustments_count.inspect},"\
+      " adjustments_amount: #{@adjustments_amount.inspect}, approved_amount:"\
+      " #{@approved_amount.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/reporting_settlement_research_api/models/transaction_type.rb

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

@@ -0,0 +1,98 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # The codes for the type of transactions.
+  class TransactionTypeCode < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The code of the transaction type.
+    # @return [String]
+    attr_accessor :code
+
+    # The short description of the transaction type.
+    # @return [String]
+    attr_accessor :short_description
+
+    # The long description of the transaction type.
+    # @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.
+      TransactionTypeCode.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