mt-sdk 0.0.1

data/lib/modern_treasury/models/external_account_create_request.rb

@@ -0,0 +1,230 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # ExternalAccountCreateRequest Model.
+  class ExternalAccountCreateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Can be `checking`, `savings` or `other`.
+    # @return [AccountTypeEnum]
+    attr_accessor :account_type
+
+    # Either `individual` or `business`.
+    # @return [PartyTypeEnum]
+    attr_accessor :party_type
+
+    # Either `individual` or `business`.
+    # @return [AddressRequest]
+    attr_accessor :party_address
+
+    # A nickname for the external account. This is only for internal usage and
+    # won't affect any payments
+    # @return [String]
+    attr_accessor :name
+
+    # A nickname for the external account. This is only for internal usage and
+    # won't affect any payments
+    # @return [UUID | String]
+    attr_accessor :counterparty_id
+
+    # A nickname for the external account. This is only for internal usage and
+    # won't affect any payments
+    # @return [Array[AccountDetail1]]
+    attr_accessor :account_details
+
+    # A nickname for the external account. This is only for internal usage and
+    # won't affect any payments
+    # @return [Array[RoutingDetail1]]
+    attr_accessor :routing_details
+
+    # Additional data represented as key-value pairs. Both the key and value
+    # must be strings.
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # If this value isn't provided, it will be inherited from the counterparty's
+    # name.
+    # @return [String]
+    attr_accessor :party_name
+
+    # If this value isn't provided, it will be inherited from the counterparty's
+    # name.
+    # @return [String]
+    attr_accessor :party_identifier
+
+    # If this value isn't provided, it will be inherited from the counterparty's
+    # name.
+    # @return [LedgerAccountCreateRequest]
+    attr_accessor :ledger_account
+
+    # If you've enabled the Modern Treasury + Plaid integration in your Plaid
+    # account, you can pass the processor token in this field.
+    # @return [String]
+    attr_accessor :plaid_processor_token
+
+    # If you've enabled the Modern Treasury + Plaid integration in your Plaid
+    # account, you can pass the processor token in this field.
+    # @return [Array[ContactDetailCreateRequest]]
+    attr_accessor :contact_details
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_type'] = 'account_type'
+      @_hash['party_type'] = 'party_type'
+      @_hash['party_address'] = 'party_address'
+      @_hash['name'] = 'name'
+      @_hash['counterparty_id'] = 'counterparty_id'
+      @_hash['account_details'] = 'account_details'
+      @_hash['routing_details'] = 'routing_details'
+      @_hash['metadata'] = 'metadata'
+      @_hash['party_name'] = 'party_name'
+      @_hash['party_identifier'] = 'party_identifier'
+      @_hash['ledger_account'] = 'ledger_account'
+      @_hash['plaid_processor_token'] = 'plaid_processor_token'
+      @_hash['contact_details'] = 'contact_details'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_type
+        party_type
+        party_address
+        name
+        account_details
+        routing_details
+        metadata
+        party_name
+        party_identifier
+        ledger_account
+        plaid_processor_token
+        contact_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        party_type
+        name
+        counterparty_id
+      ]
+    end
+
+    def initialize(counterparty_id = nil, account_type = SKIP,
+                   party_type = SKIP, party_address = SKIP, name = SKIP,
+                   account_details = SKIP, routing_details = SKIP,
+                   metadata = SKIP, party_name = SKIP, party_identifier = SKIP,
+                   ledger_account = SKIP, plaid_processor_token = SKIP,
+                   contact_details = SKIP)
+      @account_type = account_type unless account_type == SKIP
+      @party_type = party_type unless party_type == SKIP
+      @party_address = party_address unless party_address == SKIP
+      @name = name unless name == SKIP
+      @counterparty_id = counterparty_id
+      @account_details = account_details unless account_details == SKIP
+      @routing_details = routing_details unless routing_details == SKIP
+      @metadata = metadata unless metadata == SKIP
+      @party_name = party_name unless party_name == SKIP
+      @party_identifier = party_identifier unless party_identifier == SKIP
+      @ledger_account = ledger_account unless ledger_account == SKIP
+      @plaid_processor_token = plaid_processor_token unless plaid_processor_token == SKIP
+      @contact_details = contact_details unless contact_details == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      counterparty_id =
+        hash.key?('counterparty_id') ? hash['counterparty_id'] : nil
+      account_type = hash.key?('account_type') ? hash['account_type'] : SKIP
+      party_type = hash.key?('party_type') ? hash['party_type'] : SKIP
+      party_address = AddressRequest.from_hash(hash['party_address']) if hash['party_address']
+      name = hash.key?('name') ? hash['name'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      account_details = nil
+      unless hash['account_details'].nil?
+        account_details = []
+        hash['account_details'].each do |structure|
+          account_details << (AccountDetail1.from_hash(structure) if structure)
+        end
+      end
+
+      account_details = SKIP unless hash.key?('account_details')
+      # Parameter is an array, so we need to iterate through it
+      routing_details = nil
+      unless hash['routing_details'].nil?
+        routing_details = []
+        hash['routing_details'].each do |structure|
+          routing_details << (RoutingDetail1.from_hash(structure) if structure)
+        end
+      end
+
+      routing_details = SKIP unless hash.key?('routing_details')
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      party_name = hash.key?('party_name') ? hash['party_name'] : SKIP
+      party_identifier =
+        hash.key?('party_identifier') ? hash['party_identifier'] : SKIP
+      ledger_account = LedgerAccountCreateRequest.from_hash(hash['ledger_account']) if
+        hash['ledger_account']
+      plaid_processor_token =
+        hash.key?('plaid_processor_token') ? hash['plaid_processor_token'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      contact_details = nil
+      unless hash['contact_details'].nil?
+        contact_details = []
+        hash['contact_details'].each do |structure|
+          contact_details << (ContactDetailCreateRequest.from_hash(structure) if structure)
+        end
+      end
+
+      contact_details = SKIP unless hash.key?('contact_details')
+
+      # Create object from extracted values.
+      ExternalAccountCreateRequest.new(counterparty_id,
+                                       account_type,
+                                       party_type,
+                                       party_address,
+                                       name,
+                                       account_details,
+                                       routing_details,
+                                       metadata,
+                                       party_name,
+                                       party_identifier,
+                                       ledger_account,
+                                       plaid_processor_token,
+                                       contact_details)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_type: #{@account_type}, party_type: #{@party_type}, party_address:"\
+      " #{@party_address}, name: #{@name}, counterparty_id: #{@counterparty_id}, account_details:"\
+      " #{@account_details}, routing_details: #{@routing_details}, metadata: #{@metadata},"\
+      " party_name: #{@party_name}, party_identifier: #{@party_identifier}, ledger_account:"\
+      " #{@ledger_account}, plaid_processor_token: #{@plaid_processor_token}, contact_details:"\
+      " #{@contact_details}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_type: #{@account_type.inspect}, party_type: #{@party_type.inspect},"\
+      " party_address: #{@party_address.inspect}, name: #{@name.inspect}, counterparty_id:"\
+      " #{@counterparty_id.inspect}, account_details: #{@account_details.inspect},"\
+      " routing_details: #{@routing_details.inspect}, metadata: #{@metadata.inspect}, party_name:"\
+      " #{@party_name.inspect}, party_identifier: #{@party_identifier.inspect}, ledger_account:"\
+      " #{@ledger_account.inspect}, plaid_processor_token: #{@plaid_processor_token.inspect},"\
+      " contact_details: #{@contact_details.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/external_account_update_request.rb

@@ -0,0 +1,132 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # ExternalAccountUpdateRequest Model.
+  class ExternalAccountUpdateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Either `individual` or `business`.
+    # @return [PartyTypeEnum]
+    attr_accessor :party_type
+
+    # Can be `checking`, `savings` or `other`.
+    # @return [AccountTypeEnum]
+    attr_accessor :account_type
+
+    # Can be `checking`, `savings` or `other`.
+    # @return [UUID | String]
+    attr_accessor :counterparty_id
+
+    # A nickname for the external account. This is only for internal usage and
+    # won't affect any payments
+    # @return [String]
+    attr_accessor :name
+
+    # If this value isn't provided, it will be inherited from the counterparty's
+    # name.
+    # @return [String]
+    attr_accessor :party_name
+
+    # If this value isn't provided, it will be inherited from the counterparty's
+    # name.
+    # @return [AddressRequest]
+    attr_accessor :party_address
+
+    # Additional data in the form of key-value pairs. Pairs can be removed by
+    # passing an empty string or `null` as the value.
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['party_type'] = 'party_type'
+      @_hash['account_type'] = 'account_type'
+      @_hash['counterparty_id'] = 'counterparty_id'
+      @_hash['name'] = 'name'
+      @_hash['party_name'] = 'party_name'
+      @_hash['party_address'] = 'party_address'
+      @_hash['metadata'] = 'metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        party_type
+        account_type
+        counterparty_id
+        name
+        party_name
+        party_address
+        metadata
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        party_type
+        counterparty_id
+        name
+      ]
+    end
+
+    def initialize(party_type = SKIP, account_type = SKIP,
+                   counterparty_id = SKIP, name = SKIP, party_name = SKIP,
+                   party_address = SKIP, metadata = SKIP)
+      @party_type = party_type unless party_type == SKIP
+      @account_type = account_type unless account_type == SKIP
+      @counterparty_id = counterparty_id unless counterparty_id == SKIP
+      @name = name unless name == SKIP
+      @party_name = party_name unless party_name == SKIP
+      @party_address = party_address unless party_address == SKIP
+      @metadata = metadata unless metadata == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      party_type = hash.key?('party_type') ? hash['party_type'] : SKIP
+      account_type = hash.key?('account_type') ? hash['account_type'] : SKIP
+      counterparty_id =
+        hash.key?('counterparty_id') ? hash['counterparty_id'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      party_name = hash.key?('party_name') ? hash['party_name'] : SKIP
+      party_address = AddressRequest.from_hash(hash['party_address']) if hash['party_address']
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+
+      # Create object from extracted values.
+      ExternalAccountUpdateRequest.new(party_type,
+                                       account_type,
+                                       counterparty_id,
+                                       name,
+                                       party_name,
+                                       party_address,
+                                       metadata)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} party_type: #{@party_type}, account_type: #{@account_type},"\
+      " counterparty_id: #{@counterparty_id}, name: #{@name}, party_name: #{@party_name},"\
+      " party_address: #{@party_address}, metadata: #{@metadata}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} party_type: #{@party_type.inspect}, account_type: #{@account_type.inspect},"\
+      " counterparty_id: #{@counterparty_id.inspect}, name: #{@name.inspect}, party_name:"\
+      " #{@party_name.inspect}, party_address: #{@party_address.inspect}, metadata:"\
+      " #{@metadata.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/external_account_verify_request.rb

@@ -0,0 +1,83 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # ExternalAccountVerifyRequest Model.
+  class ExternalAccountVerifyRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the internal account where the micro-deposits originate from.
+    # Both credit and debit capabilities must be enabled.
+    # @return [UUID | String]
+    attr_accessor :originating_account_id
+
+    # Both ach and eft are supported payment types.
+    # @return [PaymentType4Enum]
+    attr_accessor :payment_type
+
+    # Three-letter ISO currency code.
+    # @return [CurrencyEnum]
+    attr_accessor :currency
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['originating_account_id'] = 'originating_account_id'
+      @_hash['payment_type'] = 'payment_type'
+      @_hash['currency'] = 'currency'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        currency
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(originating_account_id = nil, payment_type = nil,
+                   currency = SKIP)
+      @originating_account_id = originating_account_id
+      @payment_type = payment_type
+      @currency = currency unless currency == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      originating_account_id =
+        hash.key?('originating_account_id') ? hash['originating_account_id'] : nil
+      payment_type = hash.key?('payment_type') ? hash['payment_type'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+
+      # Create object from extracted values.
+      ExternalAccountVerifyRequest.new(originating_account_id,
+                                       payment_type,
+                                       currency)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} originating_account_id: #{@originating_account_id}, payment_type:"\
+      " #{@payment_type}, currency: #{@currency}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} originating_account_id: #{@originating_account_id.inspect}, payment_type:"\
+      " #{@payment_type.inspect}, currency: #{@currency.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/fallback_type_enum.rb

@@ -0,0 +1,28 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # A payment type to fallback to if the original type is not valid for the
+  # receiving account. Currently, this only supports falling back from RTP to
+  # ACH (type=rtp and fallback_type=ach)
+  class FallbackTypeEnum
+    FALLBACK_TYPE_ENUM = [
+      # TODO: Write general description for ACH
+      ACH = 'ach'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FALLBACK_TYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ACH)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/modern_treasury/models/field_enum.rb

@@ -0,0 +1,112 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # Field.
+  class FieldEnum
+    FIELD_ENUM = [
+      # TODO: Write general description for NAME
+      NAME = 'name'.freeze,
+
+      # TODO: Write general description for NAMEONACCOUNT
+      NAMEONACCOUNT = 'nameOnAccount'.freeze,
+
+      # TODO: Write general description for TAXPAYERIDENTIFIER
+      TAXPAYERIDENTIFIER = 'taxpayerIdentifier'.freeze,
+
+      # TODO: Write general description for ACCOUNTTYPE
+      ACCOUNTTYPE = 'accountType'.freeze,
+
+      # TODO: Write general description for ACCOUNTNUMBER
+      ACCOUNTNUMBER = 'accountNumber'.freeze,
+
+      # TODO: Write general description for IBANNUMBER
+      IBANNUMBER = 'ibanNumber'.freeze,
+
+      # TODO: Write general description for CLABENUMBER
+      CLABENUMBER = 'clabeNumber'.freeze,
+
+      # TODO: Write general description for WALLETADDRESS
+      WALLETADDRESS = 'walletAddress'.freeze,
+
+      # TODO: Write general description for PANNUMBER
+      PANNUMBER = 'panNumber'.freeze,
+
+      # TODO: Write general description for ROUTINGNUMBER
+      ROUTINGNUMBER = 'routingNumber'.freeze,
+
+      # TODO: Write general description for ABAWIREROUTINGNUMBER
+      ABAWIREROUTINGNUMBER = 'abaWireRoutingNumber'.freeze,
+
+      # TODO: Write general description for SWIFTCODE
+      SWIFTCODE = 'swiftCode'.freeze,
+
+      # TODO: Write general description for AUBSB
+      AUBSB = 'auBsb'.freeze,
+
+      # TODO: Write general description for CACPA
+      CACPA = 'caCpa'.freeze,
+
+      # TODO: Write general description for CNAPS
+      CNAPS = 'cnaps'.freeze,
+
+      # TODO: Write general description for GBSORTCODE
+      GBSORTCODE = 'gbSortCode'.freeze,
+
+      # TODO: Write general description for INIFSC
+      INIFSC = 'inIfsc'.freeze,
+
+      # TODO: Write general description for MYBRANCHCODE
+      MYBRANCHCODE = 'myBranchCode'.freeze,
+
+      # TODO: Write general description for BRCODIGO
+      BRCODIGO = 'brCodigo'.freeze,
+
+      # TODO: Write general description for ROUTINGNUMBERTYPE
+      ROUTINGNUMBERTYPE = 'routingNumberType'.freeze,
+
+      # TODO: Write general description for ADDRESS
+      ADDRESS = 'address'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FIELD_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = NAME)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'name' then NAME
+      when 'nameonaccount' then NAMEONACCOUNT
+      when 'taxpayeridentifier' then TAXPAYERIDENTIFIER
+      when 'accounttype' then ACCOUNTTYPE
+      when 'accountnumber' then ACCOUNTNUMBER
+      when 'ibannumber' then IBANNUMBER
+      when 'clabenumber' then CLABENUMBER
+      when 'walletaddress' then WALLETADDRESS
+      when 'pannumber' then PANNUMBER
+      when 'routingnumber' then ROUTINGNUMBER
+      when 'abawireroutingnumber' then ABAWIREROUTINGNUMBER
+      when 'swiftcode' then SWIFTCODE
+      when 'aubsb' then AUBSB
+      when 'cacpa' then CACPA
+      when 'cnaps' then CNAPS
+      when 'gbsortcode' then GBSORTCODE
+      when 'inifsc' then INIFSC
+      when 'mybranchcode' then MYBRANCHCODE
+      when 'brcodigo' then BRCODIGO
+      when 'routingnumbertype' then ROUTINGNUMBERTYPE
+      when 'address' then ADDRESS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/file.rb

@@ -0,0 +1,81 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # File Model.
+  class File < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The size of the document in bytes.
+    # @return [Integer]
+    attr_accessor :size
+
+    # The original filename of the document.
+    # @return [String]
+    attr_accessor :filename
+
+    # The MIME content type of the document.
+    # @return [String]
+    attr_accessor :content_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['size'] = 'size'
+      @_hash['filename'] = 'filename'
+      @_hash['content_type'] = 'content_type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        size
+        filename
+        content_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(size = SKIP, filename = SKIP, content_type = SKIP)
+      @size = size unless size == SKIP
+      @filename = filename unless filename == SKIP
+      @content_type = content_type unless content_type == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      size = hash.key?('size') ? hash['size'] : SKIP
+      filename = hash.key?('filename') ? hash['filename'] : SKIP
+      content_type = hash.key?('content_type') ? hash['content_type'] : SKIP
+
+      # Create object from extracted values.
+      File.new(size,
+               filename,
+               content_type)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} size: #{@size}, filename: #{@filename}, content_type: #{@content_type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} size: #{@size.inspect}, filename: #{@filename.inspect}, content_type:"\
+      " #{@content_type.inspect}>"
+    end
+  end
+end