mt-sdk 0.0.1

data/lib/modern_treasury/models/receiving_account.rb

@@ -0,0 +1,304 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ModernTreasury
+  # ReceivingAccount Model.
+  class ReceivingAccount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :object
+
+    # This field will be true if this object exists in the live environment or
+    # false if it exists in the test environment.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :live_mode
+
+    # This field will be true if this object exists in the live environment or
+    # false if it exists in the test environment.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # This field will be true if this object exists in the live environment or
+    # false if it exists in the test environment.
+    # @return [DateTime]
+    attr_accessor :updated_at
+
+    # This field will be true if this object exists in the live environment or
+    # false if it exists in the test environment.
+    # @return [DateTime]
+    attr_accessor :discarded_at
+
+    # 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 [Address]
+    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 [Array[AccountDetail]]
+    attr_accessor :account_details
+
+    # A nickname for the external account. This is only for internal usage and
+    # won't affect any payments
+    # @return [Array[RoutingDetail]]
+    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
+
+    # The legal name of the entity which owns the account.
+    # @return [String]
+    attr_accessor :party_name
+
+    # The legal name of the entity which owns the account.
+    # @return [Array[ContactDetail]]
+    attr_accessor :contact_details
+
+    # If the external account links to a ledger account in Modern Treasury, the
+    # id of the ledger account will be populated here.
+    # @return [UUID | String]
+    attr_accessor :ledger_account_id
+
+    # If the external account links to a ledger account in Modern Treasury, the
+    # id of the ledger account will be populated here.
+    # @return [VerificationStatusEnum]
+    attr_accessor :verification_status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['object'] = 'object'
+      @_hash['live_mode'] = 'live_mode'
+      @_hash['created_at'] = 'created_at'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash['discarded_at'] = 'discarded_at'
+      @_hash['account_type'] = 'account_type'
+      @_hash['party_type'] = 'party_type'
+      @_hash['party_address'] = 'party_address'
+      @_hash['name'] = 'name'
+      @_hash['account_details'] = 'account_details'
+      @_hash['routing_details'] = 'routing_details'
+      @_hash['metadata'] = 'metadata'
+      @_hash['party_name'] = 'party_name'
+      @_hash['contact_details'] = 'contact_details'
+      @_hash['ledger_account_id'] = 'ledger_account_id'
+      @_hash['verification_status'] = 'verification_status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        object
+        live_mode
+        created_at
+        updated_at
+        discarded_at
+        account_type
+        party_type
+        party_address
+        name
+        account_details
+        routing_details
+        metadata
+        party_name
+        contact_details
+        ledger_account_id
+        verification_status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        discarded_at
+        party_type
+        party_address
+        name
+        ledger_account_id
+      ]
+    end
+
+    def initialize(id = SKIP, object = SKIP, live_mode = SKIP,
+                   created_at = SKIP, updated_at = SKIP, discarded_at = SKIP,
+                   account_type = SKIP, party_type = SKIP, party_address = SKIP,
+                   name = SKIP, account_details = SKIP, routing_details = SKIP,
+                   metadata = SKIP, party_name = SKIP, contact_details = SKIP,
+                   ledger_account_id = SKIP, verification_status = SKIP)
+      @id = id unless id == SKIP
+      @object = object unless object == SKIP
+      @live_mode = live_mode unless live_mode == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @updated_at = updated_at unless updated_at == SKIP
+      @discarded_at = discarded_at unless discarded_at == 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
+      @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
+      @contact_details = contact_details unless contact_details == SKIP
+      @ledger_account_id = ledger_account_id unless ledger_account_id == SKIP
+      @verification_status = verification_status unless verification_status == 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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      object = hash.key?('object') ? hash['object'] : SKIP
+      live_mode = hash.key?('live_mode') ? hash['live_mode'] : SKIP
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   else
+                     SKIP
+                   end
+      updated_at = if hash.key?('updated_at')
+                     (DateTimeHelper.from_rfc3339(hash['updated_at']) if hash['updated_at'])
+                   else
+                     SKIP
+                   end
+      discarded_at = if hash.key?('discarded_at')
+                       (DateTimeHelper.from_rfc3339(hash['discarded_at']) if hash['discarded_at'])
+                     else
+                       SKIP
+                     end
+      account_type = hash.key?('account_type') ? hash['account_type'] : SKIP
+      party_type = hash.key?('party_type') ? hash['party_type'] : SKIP
+      party_address = Address.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 << (AccountDetail.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 << (RoutingDetail.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
+      # 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 << (ContactDetail.from_hash(structure) if structure)
+        end
+      end
+
+      contact_details = SKIP unless hash.key?('contact_details')
+      ledger_account_id =
+        hash.key?('ledger_account_id') ? hash['ledger_account_id'] : SKIP
+      verification_status =
+        hash.key?('verification_status') ? hash['verification_status'] : SKIP
+
+      # Create object from extracted values.
+      ReceivingAccount.new(id,
+                           object,
+                           live_mode,
+                           created_at,
+                           updated_at,
+                           discarded_at,
+                           account_type,
+                           party_type,
+                           party_address,
+                           name,
+                           account_details,
+                           routing_details,
+                           metadata,
+                           party_name,
+                           contact_details,
+                           ledger_account_id,
+                           verification_status)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    def to_custom_updated_at
+      DateTimeHelper.to_rfc3339(updated_at)
+    end
+
+    def to_custom_discarded_at
+      DateTimeHelper.to_rfc3339(discarded_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ReceivingAccount | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, object: #{@object}, live_mode: #{@live_mode}, created_at:"\
+      " #{@created_at}, updated_at: #{@updated_at}, discarded_at: #{@discarded_at}, account_type:"\
+      " #{@account_type}, party_type: #{@party_type}, party_address: #{@party_address}, name:"\
+      " #{@name}, account_details: #{@account_details}, routing_details: #{@routing_details},"\
+      " metadata: #{@metadata}, party_name: #{@party_name}, contact_details: #{@contact_details},"\
+      " ledger_account_id: #{@ledger_account_id}, verification_status: #{@verification_status}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, object: #{@object.inspect}, live_mode:"\
+      " #{@live_mode.inspect}, created_at: #{@created_at.inspect}, updated_at:"\
+      " #{@updated_at.inspect}, discarded_at: #{@discarded_at.inspect}, account_type:"\
+      " #{@account_type.inspect}, party_type: #{@party_type.inspect}, party_address:"\
+      " #{@party_address.inspect}, name: #{@name.inspect}, account_details:"\
+      " #{@account_details.inspect}, routing_details: #{@routing_details.inspect}, metadata:"\
+      " #{@metadata.inspect}, party_name: #{@party_name.inspect}, contact_details:"\
+      " #{@contact_details.inspect}, ledger_account_id: #{@ledger_account_id.inspect},"\
+      " verification_status: #{@verification_status.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/receiving_account1.rb

@@ -0,0 +1,219 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # Either `receiving_account` or `receiving_account_id` must be present. When
+  # using `receiving_account_id`, you may pass the id of an external account or
+  # an internal account.
+  class ReceivingAccount1 < 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 [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['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
+      ]
+    end
+
+    def initialize(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
+      @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.
+      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.
+      ReceivingAccount1.new(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}, 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}, 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/receiving_account_type_enum.rb

@@ -0,0 +1,36 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # ReceivingAccountType.
+  class ReceivingAccountTypeEnum
+    RECEIVING_ACCOUNT_TYPE_ENUM = [
+      # TODO: Write general description for INTERNAL_ACCOUNT
+      INTERNAL_ACCOUNT = 'internal_account'.freeze,
+
+      # TODO: Write general description for EXTERNAL_ACCOUNT
+      EXTERNAL_ACCOUNT = 'external_account'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      RECEIVING_ACCOUNT_TYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = INTERNAL_ACCOUNT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'internal_account' then INTERNAL_ACCOUNT
+      when 'external_account' then EXTERNAL_ACCOUNT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/reconciliation_method_enum.rb

@@ -0,0 +1,38 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # One of manual if this expected payment was manually reconciled in the
+  # dashboard, automatic if it was automatically reconciled by Modern Treasury,
+  # or null if it is unreconciled.
+  class ReconciliationMethodEnum
+    RECONCILIATION_METHOD_ENUM = [
+      # TODO: Write general description for AUTOMATIC
+      AUTOMATIC = 'automatic'.freeze,
+
+      # TODO: Write general description for MANUAL
+      MANUAL = 'manual'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      RECONCILIATION_METHOD_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = AUTOMATIC)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'automatic' then AUTOMATIC
+      when 'manual' then MANUAL
+      else
+        default_value
+      end
+    end
+  end
+end