apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/models/ach_return_create_request.rb

@@ -0,0 +1,256 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # AchReturnCreateRequest Model.
+  class AchReturnCreateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier for the account associated with the transaction.
+    # 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 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 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
+
+    # Client-defined identifier for this specific return submission. Allows you
+    # to track and reference you requests.
+    # @return [String]
+    attr_accessor :id
+
+    # The unique identifier for the member associated with the transaction.
+    # Defined by MX.
+    # @return [String]
+    attr_accessor :member_guid
+
+    # Incorrect account number used in the ACH transaction.
+    # @return [String]
+    attr_accessor :return_account_number
+
+    # 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 :return_code
+
+    # Notes that you set to inform MX on internal ACH processing.
+    # @return [String]
+    attr_accessor :return_notes
+
+    # Incorrect routing number used in the ACH transaction.
+    # @return [String]
+    attr_accessor :return_routing_number
+
+    # 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 SEC code (Standard Entry Class Code)–a three-letter code describing
+    # how a payment was authorized (for example, `WEB`). See [SEC
+    # Codes](#sec-codes) for a complete list.
+    # @return [String]
+    attr_accessor :sec_code
+
+    # The amount of the transaction.
+    # @return [Float]
+    attr_accessor :transaction_amount
+
+    # The transaction amount range, used for impact assessment.
+    # @return [Float]
+    attr_accessor :transaction_amount_range
+
+    # MX-defined identifier for the user associated with the ACH return.
+    # @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['ach_initiated_at'] = 'ach_initiated_at'
+      @_hash['corrected_account_number'] = 'corrected_account_number'
+      @_hash['corrected_routing_number'] = 'corrected_routing_number'
+      @_hash['id'] = 'id'
+      @_hash['member_guid'] = 'member_guid'
+      @_hash['return_account_number'] = 'return_account_number'
+      @_hash['return_code'] = 'return_code'
+      @_hash['return_notes'] = 'return_notes'
+      @_hash['return_routing_number'] = 'return_routing_number'
+      @_hash['returned_at'] = 'returned_at'
+      @_hash['sec_code'] = 'sec_code'
+      @_hash['transaction_amount'] = 'transaction_amount'
+      @_hash['transaction_amount_range'] = 'transaction_amount_range'
+      @_hash['user_guid'] = 'user_guid'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_number_last_four
+        ach_initiated_at
+        corrected_account_number
+        corrected_routing_number
+        return_account_number
+        return_notes
+        return_routing_number
+        returned_at
+        sec_code
+        transaction_amount
+        transaction_amount_range
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_number_last_four
+        ach_initiated_at
+        corrected_account_number
+        corrected_routing_number
+      ]
+    end
+
+    def initialize(account_guid:, id:, member_guid:, return_code:, user_guid:,
+                   account_number_last_four: SKIP, ach_initiated_at: SKIP,
+                   corrected_account_number: SKIP,
+                   corrected_routing_number: SKIP, return_account_number: SKIP,
+                   return_notes: SKIP, return_routing_number: SKIP,
+                   returned_at: SKIP, sec_code: SKIP, transaction_amount: SKIP,
+                   transaction_amount_range: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_guid = account_guid
+      @account_number_last_four = account_number_last_four unless account_number_last_four == SKIP
+      @ach_initiated_at = ach_initiated_at unless ach_initiated_at == SKIP
+      @corrected_account_number = corrected_account_number unless corrected_account_number == SKIP
+      @corrected_routing_number = corrected_routing_number unless corrected_routing_number == SKIP
+      @id = id
+      @member_guid = member_guid
+      @return_account_number = return_account_number unless return_account_number == SKIP
+      @return_code = return_code
+      @return_notes = return_notes unless return_notes == SKIP
+      @return_routing_number = return_routing_number unless return_routing_number == SKIP
+      @returned_at = returned_at unless returned_at == SKIP
+      @sec_code = sec_code unless sec_code == SKIP
+      @transaction_amount = transaction_amount unless transaction_amount == SKIP
+      @transaction_amount_range = transaction_amount_range unless transaction_amount_range == SKIP
+      @user_guid = user_guid
+      @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'] : nil
+      id = hash.key?('id') ? hash['id'] : nil
+      member_guid = hash.key?('member_guid') ? hash['member_guid'] : nil
+      return_code = hash.key?('return_code') ? hash['return_code'] : nil
+      user_guid = hash.key?('user_guid') ? hash['user_guid'] : nil
+      account_number_last_four =
+        hash.key?('account_number_last_four') ? hash['account_number_last_four'] : SKIP
+      ach_initiated_at =
+        hash.key?('ach_initiated_at') ? hash['ach_initiated_at'] : 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
+      return_account_number =
+        hash.key?('return_account_number') ? hash['return_account_number'] : SKIP
+      return_notes = hash.key?('return_notes') ? hash['return_notes'] : SKIP
+      return_routing_number =
+        hash.key?('return_routing_number') ? hash['return_routing_number'] : SKIP
+      returned_at = hash.key?('returned_at') ? hash['returned_at'] : SKIP
+      sec_code = hash.key?('sec_code') ? hash['sec_code'] : SKIP
+      transaction_amount =
+        hash.key?('transaction_amount') ? hash['transaction_amount'] : SKIP
+      transaction_amount_range =
+        hash.key?('transaction_amount_range') ? hash['transaction_amount_range'] : 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.
+      AchReturnCreateRequest.new(account_guid: account_guid,
+                                 id: id,
+                                 member_guid: member_guid,
+                                 return_code: return_code,
+                                 user_guid: user_guid,
+                                 account_number_last_four: account_number_last_four,
+                                 ach_initiated_at: ach_initiated_at,
+                                 corrected_account_number: corrected_account_number,
+                                 corrected_routing_number: corrected_routing_number,
+                                 return_account_number: return_account_number,
+                                 return_notes: return_notes,
+                                 return_routing_number: return_routing_number,
+                                 returned_at: returned_at,
+                                 sec_code: sec_code,
+                                 transaction_amount: transaction_amount,
+                                 transaction_amount_range: transaction_amount_range,
+                                 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}, ach_initiated_at: #{@ach_initiated_at},"\
+      " corrected_account_number: #{@corrected_account_number}, corrected_routing_number:"\
+      " #{@corrected_routing_number}, id: #{@id}, member_guid: #{@member_guid},"\
+      " return_account_number: #{@return_account_number}, return_code: #{@return_code},"\
+      " return_notes: #{@return_notes}, return_routing_number: #{@return_routing_number},"\
+      " returned_at: #{@returned_at}, sec_code: #{@sec_code}, transaction_amount:"\
+      " #{@transaction_amount}, transaction_amount_range: #{@transaction_amount_range}, 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}, ach_initiated_at: #{@ach_initiated_at.inspect},"\
+      " corrected_account_number: #{@corrected_account_number.inspect}, corrected_routing_number:"\
+      " #{@corrected_routing_number.inspect}, id: #{@id.inspect}, member_guid:"\
+      " #{@member_guid.inspect}, return_account_number: #{@return_account_number.inspect},"\
+      " return_code: #{@return_code.inspect}, return_notes: #{@return_notes.inspect},"\
+      " return_routing_number: #{@return_routing_number.inspect}, returned_at:"\
+      " #{@returned_at.inspect}, sec_code: #{@sec_code.inspect}, transaction_amount:"\
+      " #{@transaction_amount.inspect}, transaction_amount_range:"\
+      " #{@transaction_amount_range.inspect}, user_guid: #{@user_guid.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/ach_return_create_request_body.rb

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

data/lib/mx_platform_api/models/ach_return_response_body.rb

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

data/lib/mx_platform_api/models/ach_returns_response_body.rb

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

data/lib/mx_platform_api/models/authorization_code_request.rb

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

data/lib/mx_platform_api/models/authorization_code_request_body.rb

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