worldpay-apimatic-sdk 0.0.1

data/lib/reporting_authorization_summary_api/models/entity.rb

@@ -0,0 +1,99 @@
+# reporting_authorization_summary_api
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingAuthorizationSummaryApi
+  # Entity Model.
+  class Entity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Level]
+    attr_accessor :level
+
+    # Refers to hierarchy id. Accepts a list of ids.
+    # @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 a MDB (Merchant Database) system. <br> Chain code
+    # is mandatory when the hierarchy level selected 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.
+      Entity.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_authorization_summary_api/models/entity_division_response.rb

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

data/lib/reporting_authorization_summary_api/models/entity_store_response.rb

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

data/lib/reporting_authorization_summary_api/models/error.rb

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

data/lib/reporting_authorization_summary_api/models/error_response.rb

@@ -0,0 +1,84 @@
+# reporting_authorization_summary_api
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingAuthorizationSummaryApi
+  # ErrorResponse Model.
+  class ErrorResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The list of errors.
+    # @return [Array[Error]]
+    attr_accessor :errors
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['errors'] = 'errors'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        errors
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(errors: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @errors = errors unless errors == 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.
+      # Parameter is an array, so we need to iterate through it
+      errors = nil
+      unless hash['errors'].nil?
+        errors = []
+        hash['errors'].each do |structure|
+          errors << (Error.from_hash(structure) if structure)
+        end
+      end
+
+      errors = SKIP unless hash.key?('errors')
+
+      # 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.
+      ErrorResponse.new(errors: errors,
+                        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} errors: #{@errors}, 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} errors: #{@errors.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/reporting_authorization_summary_api/models/level.rb

@@ -0,0 +1,67 @@
+# reporting_authorization_summary_api
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingAuthorizationSummaryApi
+  # Supports entities such as Independent Sales Organization and Independent
+  # Sales Channel with a limit of one entity, <br>National, SuperChain, Partner
+  # with a maximum limit of 10 entities, <br>Chain, Division, Store, and
+  # Merchant with a maximum limit of 2000 entities.
+  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,
+
+      # TODO: Write general description for PARTNER
+      PARTNER = 'PARTNER'.freeze,
+
+      # TODO: Write general description for SUPERCHAIN
+      SUPERCHAIN = 'SUPERCHAIN'.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?
+
+      LEVEL.include?(value)
+    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 'superchain' then SUPERCHAIN
+      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

data/lib/reporting_authorization_summary_api/models/pagination.rb

@@ -0,0 +1,87 @@
+# reporting_authorization_summary_api
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingAuthorizationSummaryApi
+  # Pagination Model.
+  class Pagination < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The number of the specific page you want to retrieve. <br>Default is page
+    # number 01.
+    # @return [Integer]
+    attr_accessor :page_number
+
+    # The number of records that you would want to retrieve per page.
+    # <br>Default is 25 items per page.
+    # @return [Integer]
+    attr_accessor :page_size
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['page_number'] = 'pageNumber'
+      @_hash['page_size'] = 'pageSize'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        page_number
+        page_size
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(page_number: 1, page_size: 25, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @page_number = page_number unless page_number == SKIP
+      @page_size = page_size unless page_size == 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.
+      page_number = hash['pageNumber'] ||= 1
+      page_size = hash['pageSize'] ||= 25
+
+      # 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.
+      Pagination.new(page_number: page_number,
+                     page_size: page_size,
+                     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} page_number: #{@page_number}, page_size: #{@page_size},"\
+      " 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} page_number: #{@page_number.inspect}, page_size: #{@page_size.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end