apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/models/enhance_transactions_request.rb

@@ -0,0 +1,143 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # EnhanceTransactionsRequest Model.
+  class EnhanceTransactionsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The monetary amount of the `transaction`.
+    # @return [Float]
+    attr_accessor :amount
+
+    # The description of the `transaction` to be enhanced.
+    # @return [String]
+    attr_accessor :description
+
+    # The transaction type assigned by the partner.
+    # @return [String]
+    attr_accessor :extended_transaction_type
+
+    # The unique partner-defined identifier for the `transaction`.
+    # @return [String]
+    attr_accessor :id
+
+    # This field contains additional descriptive information about the
+    # `transaction`.
+    # @return [String]
+    attr_accessor :memo
+
+    # The ISO 18245 category code for the `transaction`.
+    # @return [Integer]
+    attr_accessor :merchant_category_code
+
+    # The type of transaction. Can be either `CREDIT` or `DEBIT`.
+    # @return [Type]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['description'] = 'description'
+      @_hash['extended_transaction_type'] = 'extended_transaction_type'
+      @_hash['id'] = 'id'
+      @_hash['memo'] = 'memo'
+      @_hash['merchant_category_code'] = 'merchant_category_code'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount
+        extended_transaction_type
+        memo
+        merchant_category_code
+        type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        amount
+      ]
+    end
+
+    def initialize(description:, id:, amount: SKIP,
+                   extended_transaction_type: SKIP, memo: SKIP,
+                   merchant_category_code: SKIP, type: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @amount = amount unless amount == SKIP
+      @description = description
+      unless extended_transaction_type == SKIP
+        @extended_transaction_type =
+          extended_transaction_type
+      end
+      @id = id
+      @memo = memo unless memo == SKIP
+      @merchant_category_code = merchant_category_code unless merchant_category_code == SKIP
+      @type = type unless type == 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.
+      description = hash.key?('description') ? hash['description'] : nil
+      id = hash.key?('id') ? hash['id'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      extended_transaction_type =
+        hash.key?('extended_transaction_type') ? hash['extended_transaction_type'] : SKIP
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      merchant_category_code =
+        hash.key?('merchant_category_code') ? hash['merchant_category_code'] : SKIP
+      type = hash.key?('type') ? hash['type'] : 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.
+      EnhanceTransactionsRequest.new(description: description,
+                                     id: id,
+                                     amount: amount,
+                                     extended_transaction_type: extended_transaction_type,
+                                     memo: memo,
+                                     merchant_category_code: merchant_category_code,
+                                     type: type,
+                                     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} amount: #{@amount}, description: #{@description},"\
+      " extended_transaction_type: #{@extended_transaction_type}, id: #{@id}, memo: #{@memo},"\
+      " merchant_category_code: #{@merchant_category_code}, type: #{@type}, 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} amount: #{@amount.inspect}, description: #{@description.inspect},"\
+      " extended_transaction_type: #{@extended_transaction_type.inspect}, id: #{@id.inspect},"\
+      " memo: #{@memo.inspect}, merchant_category_code: #{@merchant_category_code.inspect}, type:"\
+      " #{@type.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/enhance_transactions_request_body.rb

@@ -0,0 +1,85 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # EnhanceTransactionsRequestBody Model.
+  class EnhanceTransactionsRequestBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[EnhanceTransactionsRequest]]
+    attr_accessor :transactions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transactions'] = 'transactions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transactions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transactions: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @transactions = transactions unless transactions == 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
+      transactions = nil
+      unless hash['transactions'].nil?
+        transactions = []
+        hash['transactions'].each do |structure|
+          transactions << (EnhanceTransactionsRequest.from_hash(structure) if structure)
+        end
+      end
+
+      transactions = SKIP unless hash.key?('transactions')
+
+      # 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.
+      EnhanceTransactionsRequestBody.new(transactions: transactions,
+                                         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} transactions: #{@transactions}, 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} transactions: #{@transactions.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/enhance_transactions_response_body.rb

@@ -0,0 +1,85 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # EnhanceTransactionsResponseBody Model.
+  class EnhanceTransactionsResponseBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[EnhanceTransactionResponse]]
+    attr_accessor :transactions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transactions'] = 'transactions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transactions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transactions: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @transactions = transactions unless transactions == 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
+      transactions = nil
+      unless hash['transactions'].nil?
+        transactions = []
+        hash['transactions'].each do |structure|
+          transactions << (EnhanceTransactionResponse.from_hash(structure) if structure)
+        end
+      end
+
+      transactions = SKIP unless hash.key?('transactions')
+
+      # 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.
+      EnhanceTransactionsResponseBody.new(transactions: transactions,
+                                          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} transactions: #{@transactions}, 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} transactions: #{@transactions.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/error.rb

@@ -0,0 +1,106 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # Error Model.
+  class Error < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of error that occurred.
+    # @return [String]
+    attr_accessor :error_type
+
+    # The specific error code.
+    # @return [String]
+    attr_accessor :error_code
+
+    # A human-readable message describing the error.
+    # @return [String]
+    attr_accessor :error_message
+
+    # A human-readable message intended for the end user.
+    # @return [String]
+    attr_accessor :user_message
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['error_type'] = 'error_type'
+      @_hash['error_code'] = 'error_code'
+      @_hash['error_message'] = 'error_message'
+      @_hash['user_message'] = 'user_message'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        error_type
+        error_code
+        error_message
+        user_message
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(error_type: SKIP, error_code: SKIP, error_message: SKIP,
+                   user_message: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @error_type = error_type unless error_type == SKIP
+      @error_code = error_code unless error_code == SKIP
+      @error_message = error_message unless error_message == SKIP
+      @user_message = user_message unless user_message == 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_type = hash.key?('error_type') ? hash['error_type'] : SKIP
+      error_code = hash.key?('error_code') ? hash['error_code'] : SKIP
+      error_message = hash.key?('error_message') ? hash['error_message'] : SKIP
+      user_message = hash.key?('user_message') ? hash['user_message'] : 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_type: error_type,
+                error_code: error_code,
+                error_message: error_message,
+                user_message: user_message,
+                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_type: #{@error_type}, error_code: #{@error_code}, error_message:"\
+      " #{@error_message}, user_message: #{@user_message}, 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_type: #{@error_type.inspect}, error_code: #{@error_code.inspect},"\
+      " error_message: #{@error_message.inspect}, user_message: #{@user_message.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/federal_insurance_status.rb

@@ -0,0 +1,42 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # The federal insurance status of the account. Indicates whether the account
+  # is insured by the FDIC (banks) or NCUA (credit unions). Returns an integer
+  # (`UNKNOWN_INSURED` = 0, `INSURED` = 1, `NOT_INSURED` = 2).
+  class FederalInsuranceStatus
+    FEDERAL_INSURANCE_STATUS = [
+      # TODO: Write general description for UNKNOWN_INSURED
+      UNKNOWN_INSURED = 'UNKNOWN_INSURED'.freeze,
+
+      # TODO: Write general description for INSURED
+      INSURED = 'INSURED'.freeze,
+
+      # TODO: Write general description for NOT_INSURED
+      NOT_INSURED = 'NOT_INSURED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FEDERAL_INSURANCE_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = UNKNOWN_INSURED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'unknown_insured' then UNKNOWN_INSURED
+      when 'insured' then INSURED
+      when 'not_insured' then NOT_INSURED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/mx_platform_api/models/geolocation.rb

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