mt-sdk 0.0.1

data/lib/modern_treasury/models/expected_payment_update_request.rb

@@ -0,0 +1,239 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # ExpectedPaymentUpdateRequest Model.
+  class ExpectedPaymentUpdateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The highest amount this expected payment may be equal to. Value in
+    # specified currency's smallest unit. e.g. $10 would be represented as 1000.
+    # @return [Integer]
+    attr_accessor :amount_upper_bound
+
+    # The lowest amount this expected payment may be equal to. Value in
+    # specified currency's smallest unit. e.g. $10 would be represented as 1000.
+    # @return [Integer]
+    attr_accessor :amount_lower_bound
+
+    # One of credit or debit. When you are receiving money, use credit. When you
+    # are being charged, use debit.
+    # @return [Direction1Enum]
+    attr_accessor :direction
+
+    # The ID of the Internal Account for the expected payment.
+    # @return [UUID | String]
+    attr_accessor :internal_account_id
+
+    # One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp,
+    # sen, sepa, signet, wire.
+    # @return [Type1Enum]
+    attr_accessor :type
+
+    # Three-letter ISO currency code.
+    # @return [CurrencyEnum]
+    attr_accessor :currency
+
+    # The latest date the payment may come in. Format: yyyy-mm-dd
+    # @return [Date]
+    attr_accessor :date_upper_bound
+
+    # The earliest date the payment may come in. Format: yyyy-mm-dd
+    # @return [Date]
+    attr_accessor :date_lower_bound
+
+    # An optional description for internal use.
+    # @return [String]
+    attr_accessor :description
+
+    # The statement description you expect to see on the transaction. For ACH
+    # payments, this will be the full line item passed from the bank. For wire
+    # payments, this will be the OBI field on the wire. For check payments, this
+    # will be the memo field.
+    # @return [String]
+    attr_accessor :statement_descriptor
+
+    # Additional data represented as key-value pairs. Both the key and value
+    # must be strings.
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # The ID of the counterparty you expect for this payment.
+    # @return [UUID | String]
+    attr_accessor :counterparty_id
+
+    # For `ach`, this field will be passed through on an addenda record. For
+    # `wire` payments the field will be passed through as the "Originator to
+    # Beneficiary Information", also known as OBI or Fedwire tag 6000.
+    # @return [String]
+    attr_accessor :remittance_information
+
+    # The reconciliation groups you have for this payment.
+    # @return [Object]
+    attr_accessor :reconciliation_groups
+
+    # The reconciliation filters you have for this payment.
+    # @return [Object]
+    attr_accessor :reconciliation_filters
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount_upper_bound'] = 'amount_upper_bound'
+      @_hash['amount_lower_bound'] = 'amount_lower_bound'
+      @_hash['direction'] = 'direction'
+      @_hash['internal_account_id'] = 'internal_account_id'
+      @_hash['type'] = 'type'
+      @_hash['currency'] = 'currency'
+      @_hash['date_upper_bound'] = 'date_upper_bound'
+      @_hash['date_lower_bound'] = 'date_lower_bound'
+      @_hash['description'] = 'description'
+      @_hash['statement_descriptor'] = 'statement_descriptor'
+      @_hash['metadata'] = 'metadata'
+      @_hash['counterparty_id'] = 'counterparty_id'
+      @_hash['remittance_information'] = 'remittance_information'
+      @_hash['reconciliation_groups'] = 'reconciliation_groups'
+      @_hash['reconciliation_filters'] = 'reconciliation_filters'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount_upper_bound
+        amount_lower_bound
+        direction
+        internal_account_id
+        type
+        currency
+        date_upper_bound
+        date_lower_bound
+        description
+        statement_descriptor
+        metadata
+        counterparty_id
+        remittance_information
+        reconciliation_groups
+        reconciliation_filters
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        type
+        date_upper_bound
+        date_lower_bound
+        description
+        statement_descriptor
+        counterparty_id
+        remittance_information
+        reconciliation_groups
+        reconciliation_filters
+      ]
+    end
+
+    def initialize(amount_upper_bound = SKIP, amount_lower_bound = SKIP,
+                   direction = SKIP, internal_account_id = SKIP, type = SKIP,
+                   currency = SKIP, date_upper_bound = SKIP,
+                   date_lower_bound = SKIP, description = SKIP,
+                   statement_descriptor = SKIP, metadata = SKIP,
+                   counterparty_id = SKIP, remittance_information = SKIP,
+                   reconciliation_groups = SKIP, reconciliation_filters = SKIP)
+      @amount_upper_bound = amount_upper_bound unless amount_upper_bound == SKIP
+      @amount_lower_bound = amount_lower_bound unless amount_lower_bound == SKIP
+      @direction = direction unless direction == SKIP
+      @internal_account_id = internal_account_id unless internal_account_id == SKIP
+      @type = type unless type == SKIP
+      @currency = currency unless currency == SKIP
+      @date_upper_bound = date_upper_bound unless date_upper_bound == SKIP
+      @date_lower_bound = date_lower_bound unless date_lower_bound == SKIP
+      @description = description unless description == SKIP
+      @statement_descriptor = statement_descriptor unless statement_descriptor == SKIP
+      @metadata = metadata unless metadata == SKIP
+      @counterparty_id = counterparty_id unless counterparty_id == SKIP
+      @remittance_information = remittance_information unless remittance_information == SKIP
+      @reconciliation_groups = reconciliation_groups unless reconciliation_groups == SKIP
+      @reconciliation_filters = reconciliation_filters unless reconciliation_filters == 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.
+      amount_upper_bound =
+        hash.key?('amount_upper_bound') ? hash['amount_upper_bound'] : SKIP
+      amount_lower_bound =
+        hash.key?('amount_lower_bound') ? hash['amount_lower_bound'] : SKIP
+      direction = hash.key?('direction') ? hash['direction'] : SKIP
+      internal_account_id =
+        hash.key?('internal_account_id') ? hash['internal_account_id'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      date_upper_bound =
+        hash.key?('date_upper_bound') ? hash['date_upper_bound'] : SKIP
+      date_lower_bound =
+        hash.key?('date_lower_bound') ? hash['date_lower_bound'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      statement_descriptor =
+        hash.key?('statement_descriptor') ? hash['statement_descriptor'] : SKIP
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      counterparty_id =
+        hash.key?('counterparty_id') ? hash['counterparty_id'] : SKIP
+      remittance_information =
+        hash.key?('remittance_information') ? hash['remittance_information'] : SKIP
+      reconciliation_groups =
+        hash.key?('reconciliation_groups') ? hash['reconciliation_groups'] : SKIP
+      reconciliation_filters =
+        hash.key?('reconciliation_filters') ? hash['reconciliation_filters'] : SKIP
+
+      # Create object from extracted values.
+      ExpectedPaymentUpdateRequest.new(amount_upper_bound,
+                                       amount_lower_bound,
+                                       direction,
+                                       internal_account_id,
+                                       type,
+                                       currency,
+                                       date_upper_bound,
+                                       date_lower_bound,
+                                       description,
+                                       statement_descriptor,
+                                       metadata,
+                                       counterparty_id,
+                                       remittance_information,
+                                       reconciliation_groups,
+                                       reconciliation_filters)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount_upper_bound: #{@amount_upper_bound}, amount_lower_bound:"\
+      " #{@amount_lower_bound}, direction: #{@direction}, internal_account_id:"\
+      " #{@internal_account_id}, type: #{@type}, currency: #{@currency}, date_upper_bound:"\
+      " #{@date_upper_bound}, date_lower_bound: #{@date_lower_bound}, description:"\
+      " #{@description}, statement_descriptor: #{@statement_descriptor}, metadata: #{@metadata},"\
+      " counterparty_id: #{@counterparty_id}, remittance_information: #{@remittance_information},"\
+      " reconciliation_groups: #{@reconciliation_groups}, reconciliation_filters:"\
+      " #{@reconciliation_filters}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount_upper_bound: #{@amount_upper_bound.inspect}, amount_lower_bound:"\
+      " #{@amount_lower_bound.inspect}, direction: #{@direction.inspect}, internal_account_id:"\
+      " #{@internal_account_id.inspect}, type: #{@type.inspect}, currency: #{@currency.inspect},"\
+      " date_upper_bound: #{@date_upper_bound.inspect}, date_lower_bound:"\
+      " #{@date_lower_bound.inspect}, description: #{@description.inspect}, statement_descriptor:"\
+      " #{@statement_descriptor.inspect}, metadata: #{@metadata.inspect}, counterparty_id:"\
+      " #{@counterparty_id.inspect}, remittance_information: #{@remittance_information.inspect},"\
+      " reconciliation_groups: #{@reconciliation_groups.inspect}, reconciliation_filters:"\
+      " #{@reconciliation_filters.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/external_account.rb

@@ -0,0 +1,283 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ModernTreasury
+  # ExternalAccount Model.
+  class ExternalAccount < 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 [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[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['counterparty_id'] = 'counterparty_id'
+      @_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
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        discarded_at
+        party_type
+        party_address
+        name
+        counterparty_id
+        ledger_account_id
+      ]
+    end
+
+    def initialize(id = nil, object = nil, live_mode = nil, created_at = nil,
+                   updated_at = nil, discarded_at = nil, account_type = nil,
+                   party_type = nil, party_address = nil, name = nil,
+                   counterparty_id = nil, account_details = nil,
+                   routing_details = nil, metadata = nil, party_name = nil,
+                   contact_details = nil, ledger_account_id = nil,
+                   verification_status = nil)
+      @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
+      @counterparty_id = counterparty_id
+      @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
+
+    # 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'] : nil
+      object = hash.key?('object') ? hash['object'] : nil
+      live_mode = hash.key?('live_mode') ? hash['live_mode'] : nil
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   end
+      updated_at = if hash.key?('updated_at')
+                     (DateTimeHelper.from_rfc3339(hash['updated_at']) if hash['updated_at'])
+                   end
+      discarded_at = if hash.key?('discarded_at')
+                       (DateTimeHelper.from_rfc3339(hash['discarded_at']) if hash['discarded_at'])
+                     end
+      account_type = hash.key?('account_type') ? hash['account_type'] : nil
+      party_type = hash.key?('party_type') ? hash['party_type'] : nil
+      party_address = Address.from_hash(hash['party_address']) if hash['party_address']
+      name = hash.key?('name') ? hash['name'] : nil
+      counterparty_id =
+        hash.key?('counterparty_id') ? hash['counterparty_id'] : nil
+      # 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 = nil 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 = nil unless hash.key?('routing_details')
+      metadata = hash.key?('metadata') ? hash['metadata'] : nil
+      party_name = hash.key?('party_name') ? hash['party_name'] : nil
+      # 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 = nil unless hash.key?('contact_details')
+      ledger_account_id =
+        hash.key?('ledger_account_id') ? hash['ledger_account_id'] : nil
+      verification_status =
+        hash.key?('verification_status') ? hash['verification_status'] : nil
+
+      # Create object from extracted values.
+      ExternalAccount.new(id,
+                          object,
+                          live_mode,
+                          created_at,
+                          updated_at,
+                          discarded_at,
+                          account_type,
+                          party_type,
+                          party_address,
+                          name,
+                          counterparty_id,
+                          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
+
+    # 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}, counterparty_id: #{@counterparty_id}, 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}, counterparty_id:"\
+      " #{@counterparty_id.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/external_account_complete_verification_request.rb

@@ -0,0 +1,62 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # ExternalAccountCompleteVerificationRequest Model.
+  class ExternalAccountCompleteVerificationRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[Integer]]
+    attr_accessor :amounts
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amounts'] = 'amounts'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amounts
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amounts = SKIP)
+      @amounts = amounts unless amounts == 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.
+      amounts = hash.key?('amounts') ? hash['amounts'] : SKIP
+
+      # Create object from extracted values.
+      ExternalAccountCompleteVerificationRequest.new(amounts)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amounts: #{@amounts}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amounts: #{@amounts.inspect}>"
+    end
+  end
+end