apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/models/accounts_merge_request_body.rb

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

data/lib/mx_platform_api/models/accounts_response_body.rb

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

data/lib/mx_platform_api/models/ach_response.rb

@@ -0,0 +1,424 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # AchResponse Model.
+  class AchResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier for an account. Defined by MX.
+    # @return [String]
+    attr_accessor :account_guid
+
+    # The last 4 digits of the account number used for the transaction by the
+    # Originating Depository Financial Institution (ODFI).
+    # @return [String]
+    attr_accessor :account_number_last_four
+
+    # The type of account. Some account types may include subtypes.
+    # @return [AccountType]
+    attr_accessor :account_type
+
+    # The date and time when the transaction was initiated by the Originating
+    # Depository Financial Institution (ODFI) in ISO 8601 format without
+    # timestamp.
+    # @return [String]
+    attr_accessor :ach_initiated_at
+
+    # The unique identifier for the client associated with the insight. Defined
+    # by MX.
+    # @return [String]
+    attr_accessor :client_guid
+
+    # The account number correction reported by the RDFI. Populate only if the
+    # `resolution_code` is `NOTICE_OF_CHANGE`.
+    # @return [String]
+    attr_accessor :corrected_account_number
+
+    # The routing number correction reported by the RDFI. Populated only if the
+    # `resolution_code` is `NOTICE_OF_CHANGE`. Must be a valid 9-digit routing
+    # number format.
+    # @return [String]
+    attr_accessor :corrected_routing_number
+
+    # The date and time the ACH return was created, represented in ISO 8601
+    # format with a timestamp.
+    # @return [String]
+    attr_accessor :created_at
+
+    # The unique identifier for the ACH return record. Defined by MX.
+    # @return [String]
+    attr_accessor :guid
+
+    # Client-defined identifier for this specific return submission. Allows you
+    # to track and reference your requests.
+    # @return [String]
+    attr_accessor :id
+
+    # The unique identifier for an institution. Defined by MX.
+    # @return [String]
+    attr_accessor :institution_guid
+
+    # Notes added by Product Support during investigation of the ACH return.
+    # @return [String]
+    attr_accessor :investigation_notes
+
+    # The unique identifier for the member. Defined by MX.
+    # @return [String]
+    attr_accessor :member_guid
+
+    # Any errors that occurred during processing.
+    # @return [String]
+    attr_accessor :processing_errors
+
+    # A short, machine-readable code that categorizes the type of resolution or
+    # reason for the status. See [Resolution
+    # Codes](/api-reference/platform-api/reference/ach-return-fields#resolution-
+    # codes) for a complete list.
+    # @return [String]
+    attr_accessor :resolution_code
+
+    # A more detailed, human-readable message providing context and next steps
+    # related to the `return_status` and `resolution_code`.
+    # @return [String]
+    attr_accessor :resolution_detail
+
+    # Date and time when the return was marked as resolved.
+    # @return [String]
+    attr_accessor :resolved_status_at
+
+    # The associated ACH return codes and notice of change codes (for example,
+    # R02, R03, R04, R05, R20, NOC). See [Return
+    # Codes](/api-reference/platform-api/reference/ach-return-fields#return-code
+    # s) for a complete list
+    # @return [String]
+    attr_accessor :return_code
+
+    # Notes that you set to inform MX on internal ACH processing.
+    # @return [String]
+    attr_accessor :return_notes
+
+    # Incorrect account number used in the ACH transaction.
+    # @return [String]
+    attr_accessor :return_account_number
+
+    # Incorrect routing number used in the ACH transaction.
+    # @return [String]
+    attr_accessor :return_routing_number
+
+    # The current processing status of the ACH return. See [Return
+    # Status](/api-reference/platform-api/reference/ach-return-fields#return-sta
+    # tus) for a complete list of statuses.
+    # @return [String]
+    attr_accessor :return_status
+
+    # The date and time when the return was reported by the Receiving Financial
+    # Depository Institution (RDFI) in ISO 8601 format without timestamp.
+    # @return [String]
+    attr_accessor :returned_at
+
+    # The three-letter SEC code (Standard Entry Class Code) describing how a
+    # payment was authorized (for example, `WEB`). See [SEC
+    # Codes](/api-reference/platform-api/reference/ach-return-fields#sec-codes)
+    # for a complete list.
+    # @return [String]
+    attr_accessor :sec_code
+
+    # Date and time when MX started processing the return.
+    # @return [String]
+    attr_accessor :started_processing_at
+
+    # Date and time when the record was submitted through the API.
+    # @return [String]
+    attr_accessor :submitted_at
+
+    # The amount of the transaction.
+    # @return [Float]
+    attr_accessor :transaction_amount
+
+    # Date and time when the ACH return record was last updated.
+    # @return [String]
+    attr_accessor :updated_at
+
+    # The unique identifier for the user. Defined by MX.
+    # @return [String]
+    attr_accessor :user_guid
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_guid'] = 'account_guid'
+      @_hash['account_number_last_four'] = 'account_number_last_four'
+      @_hash['account_type'] = 'account_type'
+      @_hash['ach_initiated_at'] = 'ach_initiated_at'
+      @_hash['client_guid'] = 'client_guid'
+      @_hash['corrected_account_number'] = 'corrected_account_number'
+      @_hash['corrected_routing_number'] = 'corrected_routing_number'
+      @_hash['created_at'] = 'created_at'
+      @_hash['guid'] = 'guid'
+      @_hash['id'] = 'id'
+      @_hash['institution_guid'] = 'institution_guid'
+      @_hash['investigation_notes'] = 'investigation_notes'
+      @_hash['member_guid'] = 'member_guid'
+      @_hash['processing_errors'] = 'processing_errors'
+      @_hash['resolution_code'] = 'resolution_code'
+      @_hash['resolution_detail'] = 'resolution_detail'
+      @_hash['resolved_status_at'] = 'resolved_status_at'
+      @_hash['return_code'] = 'return_code'
+      @_hash['return_notes'] = 'return_notes'
+      @_hash['return_account_number'] = 'return_account_number'
+      @_hash['return_routing_number'] = 'return_routing_number'
+      @_hash['return_status'] = 'return_status'
+      @_hash['returned_at'] = 'returned_at'
+      @_hash['sec_code'] = 'sec_code'
+      @_hash['started_processing_at'] = 'started_processing_at'
+      @_hash['submitted_at'] = 'submitted_at'
+      @_hash['transaction_amount'] = 'transaction_amount'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash['user_guid'] = 'user_guid'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_guid
+        account_number_last_four
+        account_type
+        ach_initiated_at
+        client_guid
+        corrected_account_number
+        corrected_routing_number
+        created_at
+        guid
+        id
+        institution_guid
+        investigation_notes
+        member_guid
+        processing_errors
+        resolution_code
+        resolution_detail
+        resolved_status_at
+        return_code
+        return_notes
+        return_account_number
+        return_routing_number
+        return_status
+        returned_at
+        sec_code
+        started_processing_at
+        submitted_at
+        transaction_amount
+        updated_at
+        user_guid
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_number_last_four
+        account_type
+        ach_initiated_at
+        corrected_account_number
+        corrected_routing_number
+        investigation_notes
+        processing_errors
+        resolution_code
+        resolution_detail
+        resolved_status_at
+        return_notes
+        return_account_number
+        return_routing_number
+        return_status
+        returned_at
+        sec_code
+        started_processing_at
+        submitted_at
+        transaction_amount
+      ]
+    end
+
+    def initialize(account_guid: SKIP, account_number_last_four: SKIP,
+                   account_type: SKIP, ach_initiated_at: SKIP,
+                   client_guid: SKIP, corrected_account_number: SKIP,
+                   corrected_routing_number: SKIP, created_at: SKIP, guid: SKIP,
+                   id: SKIP, institution_guid: SKIP, investigation_notes: SKIP,
+                   member_guid: SKIP, processing_errors: SKIP,
+                   resolution_code: SKIP, resolution_detail: SKIP,
+                   resolved_status_at: SKIP, return_code: SKIP,
+                   return_notes: SKIP, return_account_number: SKIP,
+                   return_routing_number: SKIP, return_status: SKIP,
+                   returned_at: SKIP, sec_code: SKIP,
+                   started_processing_at: SKIP, submitted_at: SKIP,
+                   transaction_amount: SKIP, updated_at: SKIP, user_guid: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_guid = account_guid unless account_guid == SKIP
+      @account_number_last_four = account_number_last_four unless account_number_last_four == SKIP
+      @account_type = account_type unless account_type == SKIP
+      @ach_initiated_at = ach_initiated_at unless ach_initiated_at == SKIP
+      @client_guid = client_guid unless client_guid == SKIP
+      @corrected_account_number = corrected_account_number unless corrected_account_number == SKIP
+      @corrected_routing_number = corrected_routing_number unless corrected_routing_number == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @guid = guid unless guid == SKIP
+      @id = id unless id == SKIP
+      @institution_guid = institution_guid unless institution_guid == SKIP
+      @investigation_notes = investigation_notes unless investigation_notes == SKIP
+      @member_guid = member_guid unless member_guid == SKIP
+      @processing_errors = processing_errors unless processing_errors == SKIP
+      @resolution_code = resolution_code unless resolution_code == SKIP
+      @resolution_detail = resolution_detail unless resolution_detail == SKIP
+      @resolved_status_at = resolved_status_at unless resolved_status_at == SKIP
+      @return_code = return_code unless return_code == SKIP
+      @return_notes = return_notes unless return_notes == SKIP
+      @return_account_number = return_account_number unless return_account_number == SKIP
+      @return_routing_number = return_routing_number unless return_routing_number == SKIP
+      @return_status = return_status unless return_status == SKIP
+      @returned_at = returned_at unless returned_at == SKIP
+      @sec_code = sec_code unless sec_code == SKIP
+      @started_processing_at = started_processing_at unless started_processing_at == SKIP
+      @submitted_at = submitted_at unless submitted_at == SKIP
+      @transaction_amount = transaction_amount unless transaction_amount == SKIP
+      @updated_at = updated_at unless updated_at == SKIP
+      @user_guid = user_guid unless user_guid == 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.
+      account_guid = hash.key?('account_guid') ? hash['account_guid'] : SKIP
+      account_number_last_four =
+        hash.key?('account_number_last_four') ? hash['account_number_last_four'] : SKIP
+      account_type = hash.key?('account_type') ? hash['account_type'] : SKIP
+      ach_initiated_at =
+        hash.key?('ach_initiated_at') ? hash['ach_initiated_at'] : SKIP
+      client_guid = hash.key?('client_guid') ? hash['client_guid'] : SKIP
+      corrected_account_number =
+        hash.key?('corrected_account_number') ? hash['corrected_account_number'] : SKIP
+      corrected_routing_number =
+        hash.key?('corrected_routing_number') ? hash['corrected_routing_number'] : SKIP
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      guid = hash.key?('guid') ? hash['guid'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      institution_guid =
+        hash.key?('institution_guid') ? hash['institution_guid'] : SKIP
+      investigation_notes =
+        hash.key?('investigation_notes') ? hash['investigation_notes'] : SKIP
+      member_guid = hash.key?('member_guid') ? hash['member_guid'] : SKIP
+      processing_errors =
+        hash.key?('processing_errors') ? hash['processing_errors'] : SKIP
+      resolution_code =
+        hash.key?('resolution_code') ? hash['resolution_code'] : SKIP
+      resolution_detail =
+        hash.key?('resolution_detail') ? hash['resolution_detail'] : SKIP
+      resolved_status_at =
+        hash.key?('resolved_status_at') ? hash['resolved_status_at'] : SKIP
+      return_code = hash.key?('return_code') ? hash['return_code'] : SKIP
+      return_notes = hash.key?('return_notes') ? hash['return_notes'] : SKIP
+      return_account_number =
+        hash.key?('return_account_number') ? hash['return_account_number'] : SKIP
+      return_routing_number =
+        hash.key?('return_routing_number') ? hash['return_routing_number'] : SKIP
+      return_status = hash.key?('return_status') ? hash['return_status'] : SKIP
+      returned_at = hash.key?('returned_at') ? hash['returned_at'] : SKIP
+      sec_code = hash.key?('sec_code') ? hash['sec_code'] : SKIP
+      started_processing_at =
+        hash.key?('started_processing_at') ? hash['started_processing_at'] : SKIP
+      submitted_at = hash.key?('submitted_at') ? hash['submitted_at'] : SKIP
+      transaction_amount =
+        hash.key?('transaction_amount') ? hash['transaction_amount'] : SKIP
+      updated_at = hash.key?('updated_at') ? hash['updated_at'] : SKIP
+      user_guid = hash.key?('user_guid') ? hash['user_guid'] : 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.
+      AchResponse.new(account_guid: account_guid,
+                      account_number_last_four: account_number_last_four,
+                      account_type: account_type,
+                      ach_initiated_at: ach_initiated_at,
+                      client_guid: client_guid,
+                      corrected_account_number: corrected_account_number,
+                      corrected_routing_number: corrected_routing_number,
+                      created_at: created_at,
+                      guid: guid,
+                      id: id,
+                      institution_guid: institution_guid,
+                      investigation_notes: investigation_notes,
+                      member_guid: member_guid,
+                      processing_errors: processing_errors,
+                      resolution_code: resolution_code,
+                      resolution_detail: resolution_detail,
+                      resolved_status_at: resolved_status_at,
+                      return_code: return_code,
+                      return_notes: return_notes,
+                      return_account_number: return_account_number,
+                      return_routing_number: return_routing_number,
+                      return_status: return_status,
+                      returned_at: returned_at,
+                      sec_code: sec_code,
+                      started_processing_at: started_processing_at,
+                      submitted_at: submitted_at,
+                      transaction_amount: transaction_amount,
+                      updated_at: updated_at,
+                      user_guid: user_guid,
+                      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} account_guid: #{@account_guid}, account_number_last_four:"\
+      " #{@account_number_last_four}, account_type: #{@account_type}, ach_initiated_at:"\
+      " #{@ach_initiated_at}, client_guid: #{@client_guid}, corrected_account_number:"\
+      " #{@corrected_account_number}, corrected_routing_number: #{@corrected_routing_number},"\
+      " created_at: #{@created_at}, guid: #{@guid}, id: #{@id}, institution_guid:"\
+      " #{@institution_guid}, investigation_notes: #{@investigation_notes}, member_guid:"\
+      " #{@member_guid}, processing_errors: #{@processing_errors}, resolution_code:"\
+      " #{@resolution_code}, resolution_detail: #{@resolution_detail}, resolved_status_at:"\
+      " #{@resolved_status_at}, return_code: #{@return_code}, return_notes: #{@return_notes},"\
+      " return_account_number: #{@return_account_number}, return_routing_number:"\
+      " #{@return_routing_number}, return_status: #{@return_status}, returned_at: #{@returned_at},"\
+      " sec_code: #{@sec_code}, started_processing_at: #{@started_processing_at}, submitted_at:"\
+      " #{@submitted_at}, transaction_amount: #{@transaction_amount}, updated_at: #{@updated_at},"\
+      " user_guid: #{@user_guid}, 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} account_guid: #{@account_guid.inspect}, account_number_last_four:"\
+      " #{@account_number_last_four.inspect}, account_type: #{@account_type.inspect},"\
+      " ach_initiated_at: #{@ach_initiated_at.inspect}, client_guid: #{@client_guid.inspect},"\
+      " corrected_account_number: #{@corrected_account_number.inspect}, corrected_routing_number:"\
+      " #{@corrected_routing_number.inspect}, created_at: #{@created_at.inspect}, guid:"\
+      " #{@guid.inspect}, id: #{@id.inspect}, institution_guid: #{@institution_guid.inspect},"\
+      " investigation_notes: #{@investigation_notes.inspect}, member_guid:"\
+      " #{@member_guid.inspect}, processing_errors: #{@processing_errors.inspect},"\
+      " resolution_code: #{@resolution_code.inspect}, resolution_detail:"\
+      " #{@resolution_detail.inspect}, resolved_status_at: #{@resolved_status_at.inspect},"\
+      " return_code: #{@return_code.inspect}, return_notes: #{@return_notes.inspect},"\
+      " return_account_number: #{@return_account_number.inspect}, return_routing_number:"\
+      " #{@return_routing_number.inspect}, return_status: #{@return_status.inspect}, returned_at:"\
+      " #{@returned_at.inspect}, sec_code: #{@sec_code.inspect}, started_processing_at:"\
+      " #{@started_processing_at.inspect}, submitted_at: #{@submitted_at.inspect},"\
+      " transaction_amount: #{@transaction_amount.inspect}, updated_at: #{@updated_at.inspect},"\
+      " user_guid: #{@user_guid.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end