apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/models/micro_deposit.rb

@@ -0,0 +1,223 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # MicroDeposit Model.
+  class MicroDeposit < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The human-readable name for the account.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The account number associated with the account. This will typically be a
+    # masked or partial account number.
+    # @return [String]
+    attr_accessor :account_number
+
+    # The type of account. Some account types may include subtypes.
+    # @return [AccountType]
+    attr_accessor :account_type
+
+    # The email address associated with the account.
+    # @return [String]
+    attr_accessor :email
+
+    # The account owner's first name. This may also include a middle name. This
+    # field will be `null` unless name splitting has been enabled. Contact MX to
+    # have this feature enabled.
+    # @return [String]
+    attr_accessor :first_name
+
+    # The last name of the account holder.
+    # @return [String]
+    attr_accessor :last_name
+
+    # The routing number for the `account`.
+    # @return [String]
+    attr_accessor :routing_number
+
+    # A message describing an error that occurred.
+    # @return [String]
+    attr_accessor :error_message
+
+    # The unique identifier for the microdeposit. Defined by MX.
+    # @return [String]
+    attr_accessor :guid
+
+    # The code identifying a financial institution.
+    # @return [String]
+    attr_accessor :institution_code
+
+    # An easy-to-read name for an institution. May be `null` for institutions
+    # that are not in the MX system.
+    # @return [String]
+    attr_accessor :institution_name
+
+    # The name of the current status. See [Microdeposit
+    # Statuses](/api-reference/platform-api/reference/microdeposits#microdeposit
+    # -statuseses).
+    # @return [String]
+    attr_accessor :status
+
+    # The date and time the resource was last updated in ISO 8601 format with a
+    # timestamp.
+    # For categories, this field will always be `null` when `is_default` is
+    # `true`.
+    # @return [String]
+    attr_accessor :updated_at
+
+    # The date and time at which the microdeposit status changed from
+    # `DEPOSITED` to `VERIFIED`.
+    # @return [String]
+    attr_accessor :verified_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'account_name'
+      @_hash['account_number'] = 'account_number'
+      @_hash['account_type'] = 'account_type'
+      @_hash['email'] = 'email'
+      @_hash['first_name'] = 'first_name'
+      @_hash['last_name'] = 'last_name'
+      @_hash['routing_number'] = 'routing_number'
+      @_hash['error_message'] = 'error_message'
+      @_hash['guid'] = 'guid'
+      @_hash['institution_code'] = 'institution_code'
+      @_hash['institution_name'] = 'institution_name'
+      @_hash['status'] = 'status'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash['verified_at'] = 'verified_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        email
+        first_name
+        last_name
+        error_message
+        guid
+        institution_code
+        institution_name
+        status
+        updated_at
+        verified_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_type
+        error_message
+        verified_at
+      ]
+    end
+
+    def initialize(account_number:, account_type:, routing_number:,
+                   account_name: SKIP, email: SKIP, first_name: SKIP,
+                   last_name: SKIP, error_message: SKIP, guid: SKIP,
+                   institution_code: SKIP, institution_name: SKIP, status: SKIP,
+                   updated_at: SKIP, verified_at: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_name = account_name unless account_name == SKIP
+      @account_number = account_number
+      @account_type = account_type
+      @email = email unless email == SKIP
+      @first_name = first_name unless first_name == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @routing_number = routing_number
+      @error_message = error_message unless error_message == SKIP
+      @guid = guid unless guid == SKIP
+      @institution_code = institution_code unless institution_code == SKIP
+      @institution_name = institution_name unless institution_name == SKIP
+      @status = status unless status == SKIP
+      @updated_at = updated_at unless updated_at == SKIP
+      @verified_at = verified_at unless verified_at == 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_number =
+        hash.key?('account_number') ? hash['account_number'] : nil
+      account_type = hash.key?('account_type') ? hash['account_type'] : nil
+      routing_number =
+        hash.key?('routing_number') ? hash['routing_number'] : nil
+      account_name = hash.key?('account_name') ? hash['account_name'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      first_name = hash.key?('first_name') ? hash['first_name'] : SKIP
+      last_name = hash.key?('last_name') ? hash['last_name'] : SKIP
+      error_message = hash.key?('error_message') ? hash['error_message'] : SKIP
+      guid = hash.key?('guid') ? hash['guid'] : SKIP
+      institution_code =
+        hash.key?('institution_code') ? hash['institution_code'] : SKIP
+      institution_name =
+        hash.key?('institution_name') ? hash['institution_name'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      updated_at = hash.key?('updated_at') ? hash['updated_at'] : SKIP
+      verified_at = hash.key?('verified_at') ? hash['verified_at'] : 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.
+      MicroDeposit.new(account_number: account_number,
+                       account_type: account_type,
+                       routing_number: routing_number,
+                       account_name: account_name,
+                       email: email,
+                       first_name: first_name,
+                       last_name: last_name,
+                       error_message: error_message,
+                       guid: guid,
+                       institution_code: institution_code,
+                       institution_name: institution_name,
+                       status: status,
+                       updated_at: updated_at,
+                       verified_at: verified_at,
+                       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_name: #{@account_name}, account_number: #{@account_number},"\
+      " account_type: #{@account_type}, email: #{@email}, first_name: #{@first_name}, last_name:"\
+      " #{@last_name}, routing_number: #{@routing_number}, error_message: #{@error_message}, guid:"\
+      " #{@guid}, institution_code: #{@institution_code}, institution_name: #{@institution_name},"\
+      " status: #{@status}, updated_at: #{@updated_at}, verified_at: #{@verified_at},"\
+      " 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_name: #{@account_name.inspect}, account_number:"\
+      " #{@account_number.inspect}, account_type: #{@account_type.inspect}, email:"\
+      " #{@email.inspect}, first_name: #{@first_name.inspect}, last_name: #{@last_name.inspect},"\
+      " routing_number: #{@routing_number.inspect}, error_message: #{@error_message.inspect},"\
+      " guid: #{@guid.inspect}, institution_code: #{@institution_code.inspect}, institution_name:"\
+      " #{@institution_name.inspect}, status: #{@status.inspect}, updated_at:"\
+      " #{@updated_at.inspect}, verified_at: #{@verified_at.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/microdeposit_elements.rb

@@ -0,0 +1,141 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # MicrodepositElements Model.
+  class MicrodepositElements < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The human-readable name for the account.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The account number associated with the account. This will typically be a
+    # masked or partial account number.
+    # @return [String]
+    attr_accessor :account_number
+
+    # The type of account. Some account types may include subtypes.
+    # @return [AccountType]
+    attr_accessor :account_type
+
+    # The email address associated with the account.
+    # @return [String]
+    attr_accessor :email
+
+    # The account owner's first name. This may also include a middle name. This
+    # field will be `null` unless name splitting has been enabled. Contact MX to
+    # have this feature enabled.
+    # @return [String]
+    attr_accessor :first_name
+
+    # The last name of the account holder.
+    # @return [String]
+    attr_accessor :last_name
+
+    # The routing number for the `account`.
+    # @return [String]
+    attr_accessor :routing_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'account_name'
+      @_hash['account_number'] = 'account_number'
+      @_hash['account_type'] = 'account_type'
+      @_hash['email'] = 'email'
+      @_hash['first_name'] = 'first_name'
+      @_hash['last_name'] = 'last_name'
+      @_hash['routing_number'] = 'routing_number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        email
+        first_name
+        last_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_type
+      ]
+    end
+
+    def initialize(account_number:, account_type:, routing_number:,
+                   account_name: SKIP, email: SKIP, first_name: SKIP,
+                   last_name: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_name = account_name unless account_name == SKIP
+      @account_number = account_number
+      @account_type = account_type
+      @email = email unless email == SKIP
+      @first_name = first_name unless first_name == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @routing_number = routing_number
+      @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_number =
+        hash.key?('account_number') ? hash['account_number'] : nil
+      account_type = hash.key?('account_type') ? hash['account_type'] : nil
+      routing_number =
+        hash.key?('routing_number') ? hash['routing_number'] : nil
+      account_name = hash.key?('account_name') ? hash['account_name'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      first_name = hash.key?('first_name') ? hash['first_name'] : SKIP
+      last_name = hash.key?('last_name') ? hash['last_name'] : 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.
+      MicrodepositElements.new(account_number: account_number,
+                               account_type: account_type,
+                               routing_number: routing_number,
+                               account_name: account_name,
+                               email: email,
+                               first_name: first_name,
+                               last_name: last_name,
+                               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_name: #{@account_name}, account_number: #{@account_number},"\
+      " account_type: #{@account_type}, email: #{@email}, first_name: #{@first_name}, last_name:"\
+      " #{@last_name}, routing_number: #{@routing_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} account_name: #{@account_name.inspect}, account_number:"\
+      " #{@account_number.inspect}, account_type: #{@account_type.inspect}, email:"\
+      " #{@email.inspect}, first_name: #{@first_name.inspect}, last_name: #{@last_name.inspect},"\
+      " routing_number: #{@routing_number.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/microdeposit_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
+  # MicrodepositRequestBody Model.
+  class MicrodepositRequestBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [MicrodepositElements]
+    attr_accessor :micro_deposit
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['micro_deposit'] = 'micro_deposit'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        micro_deposit
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(micro_deposit: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @micro_deposit = micro_deposit unless micro_deposit == 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.
+      micro_deposit = MicrodepositElements.from_hash(hash['micro_deposit']) if
+        hash['micro_deposit']
+
+      # 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.
+      MicrodepositRequestBody.new(micro_deposit: micro_deposit,
+                                  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} micro_deposit: #{@micro_deposit}, 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} micro_deposit: #{@micro_deposit.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/microdeposit_response.rb

@@ -0,0 +1,149 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # MicrodepositResponse Model.
+  class MicrodepositResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A message describing an error that occurred.
+    # @return [String]
+    attr_accessor :error_message
+
+    # The unique identifier for the microdeposit. Defined by MX.
+    # @return [String]
+    attr_accessor :guid
+
+    # The code identifying a financial institution.
+    # @return [String]
+    attr_accessor :institution_code
+
+    # An easy-to-read name for an institution. May be `null` for institutions
+    # that are not in the MX system.
+    # @return [String]
+    attr_accessor :institution_name
+
+    # The name of the current status. See [Microdeposit
+    # Statuses](/api-reference/platform-api/reference/microdeposits#microdeposit
+    # -statuseses).
+    # @return [String]
+    attr_accessor :status
+
+    # The date and time the resource was last updated in ISO 8601 format with a
+    # timestamp.
+    # For categories, this field will always be `null` when `is_default` is
+    # `true`.
+    # @return [String]
+    attr_accessor :updated_at
+
+    # The date and time at which the microdeposit status changed from
+    # `DEPOSITED` to `VERIFIED`.
+    # @return [String]
+    attr_accessor :verified_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['error_message'] = 'error_message'
+      @_hash['guid'] = 'guid'
+      @_hash['institution_code'] = 'institution_code'
+      @_hash['institution_name'] = 'institution_name'
+      @_hash['status'] = 'status'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash['verified_at'] = 'verified_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        error_message
+        guid
+        institution_code
+        institution_name
+        status
+        updated_at
+        verified_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        error_message
+        verified_at
+      ]
+    end
+
+    def initialize(error_message: SKIP, guid: SKIP, institution_code: SKIP,
+                   institution_name: SKIP, status: SKIP, updated_at: SKIP,
+                   verified_at: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @error_message = error_message unless error_message == SKIP
+      @guid = guid unless guid == SKIP
+      @institution_code = institution_code unless institution_code == SKIP
+      @institution_name = institution_name unless institution_name == SKIP
+      @status = status unless status == SKIP
+      @updated_at = updated_at unless updated_at == SKIP
+      @verified_at = verified_at unless verified_at == 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_message = hash.key?('error_message') ? hash['error_message'] : SKIP
+      guid = hash.key?('guid') ? hash['guid'] : SKIP
+      institution_code =
+        hash.key?('institution_code') ? hash['institution_code'] : SKIP
+      institution_name =
+        hash.key?('institution_name') ? hash['institution_name'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      updated_at = hash.key?('updated_at') ? hash['updated_at'] : SKIP
+      verified_at = hash.key?('verified_at') ? hash['verified_at'] : 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.
+      MicrodepositResponse.new(error_message: error_message,
+                               guid: guid,
+                               institution_code: institution_code,
+                               institution_name: institution_name,
+                               status: status,
+                               updated_at: updated_at,
+                               verified_at: verified_at,
+                               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_message: #{@error_message}, guid: #{@guid}, institution_code:"\
+      " #{@institution_code}, institution_name: #{@institution_name}, status: #{@status},"\
+      " updated_at: #{@updated_at}, verified_at: #{@verified_at}, 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_message: #{@error_message.inspect}, guid: #{@guid.inspect},"\
+      " institution_code: #{@institution_code.inspect}, institution_name:"\
+      " #{@institution_name.inspect}, status: #{@status.inspect}, updated_at:"\
+      " #{@updated_at.inspect}, verified_at: #{@verified_at.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/microdeposit_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
+  # MicrodepositResponseBody Model.
+  class MicrodepositResponseBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[MicroDeposit]]
+    attr_accessor :micro_deposit
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['micro_deposit'] = 'micro_deposit'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        micro_deposit
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(micro_deposit: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @micro_deposit = micro_deposit unless micro_deposit == 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
+      micro_deposit = nil
+      unless hash['micro_deposit'].nil?
+        micro_deposit = []
+        hash['micro_deposit'].each do |structure|
+          micro_deposit << (MicroDeposit.from_hash(structure) if structure)
+        end
+      end
+
+      micro_deposit = SKIP unless hash.key?('micro_deposit')
+
+      # 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.
+      MicrodepositResponseBody.new(micro_deposit: micro_deposit,
+                                   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} micro_deposit: #{@micro_deposit}, 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} micro_deposit: #{@micro_deposit.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end