mt-sdk 0.0.1

data/lib/modern_treasury/models/expected_payment.rb

@@ -0,0 +1,343 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ModernTreasury
+  # ExpectedPayment Model.
+  class ExpectedPayment < 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
+
+    # 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
+
+    # The ID of the Transaction this expected payment object has been matched
+    # to.
+    # @return [UUID | String]
+    attr_accessor :transaction_id
+
+    # The ID of the Transaction Line Item this expected payment has been matched
+    # to.
+    # @return [UUID | String]
+    attr_accessor :transaction_line_item_id
+
+    # One of unreconciled, reconciled, or archived.
+    # @return [Status1Enum]
+    attr_accessor :status
+
+    # 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.
+    # @return [ReconciliationMethodEnum]
+    attr_accessor :reconciliation_method
+
+    # The ID of the ledger transaction linked to the expected payment.
+    # @return [UUID | String]
+    attr_accessor :ledger_transaction_id
+
+    # 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['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['transaction_id'] = 'transaction_id'
+      @_hash['transaction_line_item_id'] = 'transaction_line_item_id'
+      @_hash['status'] = 'status'
+      @_hash['reconciliation_method'] = 'reconciliation_method'
+      @_hash['ledger_transaction_id'] = 'ledger_transaction_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    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
+        transaction_id
+        transaction_line_item_id
+        reconciliation_method
+        ledger_transaction_id
+      ]
+    end
+
+    def initialize(id = nil, object = nil, live_mode = nil, created_at = nil,
+                   updated_at = nil, amount_upper_bound = nil,
+                   amount_lower_bound = nil, direction = nil,
+                   internal_account_id = nil, type = nil, currency = nil,
+                   date_upper_bound = nil, date_lower_bound = nil,
+                   description = nil, statement_descriptor = nil,
+                   metadata = nil, counterparty_id = nil,
+                   remittance_information = nil, reconciliation_groups = nil,
+                   reconciliation_filters = nil, transaction_id = nil,
+                   transaction_line_item_id = nil, status = nil,
+                   reconciliation_method = nil, ledger_transaction_id = nil)
+      @id = id
+      @object = object
+      @live_mode = live_mode
+      @created_at = created_at
+      @updated_at = updated_at
+      @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
+      @transaction_id = transaction_id
+      @transaction_line_item_id = transaction_line_item_id
+      @status = status
+      @reconciliation_method = reconciliation_method
+      @ledger_transaction_id = ledger_transaction_id
+    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
+      amount_upper_bound =
+        hash.key?('amount_upper_bound') ? hash['amount_upper_bound'] : nil
+      amount_lower_bound =
+        hash.key?('amount_lower_bound') ? hash['amount_lower_bound'] : nil
+      direction = hash.key?('direction') ? hash['direction'] : nil
+      internal_account_id =
+        hash.key?('internal_account_id') ? hash['internal_account_id'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      date_upper_bound =
+        hash.key?('date_upper_bound') ? hash['date_upper_bound'] : nil
+      date_lower_bound =
+        hash.key?('date_lower_bound') ? hash['date_lower_bound'] : nil
+      description = hash.key?('description') ? hash['description'] : nil
+      statement_descriptor =
+        hash.key?('statement_descriptor') ? hash['statement_descriptor'] : nil
+      metadata = hash.key?('metadata') ? hash['metadata'] : nil
+      counterparty_id =
+        hash.key?('counterparty_id') ? hash['counterparty_id'] : nil
+      remittance_information =
+        hash.key?('remittance_information') ? hash['remittance_information'] : nil
+      reconciliation_groups =
+        hash.key?('reconciliation_groups') ? hash['reconciliation_groups'] : nil
+      reconciliation_filters =
+        hash.key?('reconciliation_filters') ? hash['reconciliation_filters'] : nil
+      transaction_id =
+        hash.key?('transaction_id') ? hash['transaction_id'] : nil
+      transaction_line_item_id =
+        hash.key?('transaction_line_item_id') ? hash['transaction_line_item_id'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      reconciliation_method =
+        hash.key?('reconciliation_method') ? hash['reconciliation_method'] : nil
+      ledger_transaction_id =
+        hash.key?('ledger_transaction_id') ? hash['ledger_transaction_id'] : nil
+
+      # Create object from extracted values.
+      ExpectedPayment.new(id,
+                          object,
+                          live_mode,
+                          created_at,
+                          updated_at,
+                          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,
+                          transaction_id,
+                          transaction_line_item_id,
+                          status,
+                          reconciliation_method,
+                          ledger_transaction_id)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    def to_custom_updated_at
+      DateTimeHelper.to_rfc3339(updated_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}, 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}, transaction_id: #{@transaction_id}, transaction_line_item_id:"\
+      " #{@transaction_line_item_id}, status: #{@status}, reconciliation_method:"\
+      " #{@reconciliation_method}, ledger_transaction_id: #{@ledger_transaction_id}>"
+    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}, 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}, transaction_id: #{@transaction_id.inspect},"\
+      " transaction_line_item_id: #{@transaction_line_item_id.inspect}, status:"\
+      " #{@status.inspect}, reconciliation_method: #{@reconciliation_method.inspect},"\
+      " ledger_transaction_id: #{@ledger_transaction_id.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/expected_payment_create_request.rb

@@ -0,0 +1,254 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # ExpectedPaymentCreateRequest Model.
+  class ExpectedPaymentCreateRequest < 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
+
+    # The reconciliation filters you have for this payment.
+    # @return [Array[LineItemRequest]]
+    attr_accessor :line_items
+
+    # 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['line_items'] = 'line_items'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        currency
+        date_upper_bound
+        date_lower_bound
+        description
+        statement_descriptor
+        metadata
+        counterparty_id
+        remittance_information
+        reconciliation_groups
+        reconciliation_filters
+        line_items
+      ]
+    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 = nil, amount_lower_bound = nil,
+                   direction = nil, internal_account_id = nil, 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,
+                   line_items = SKIP)
+      @amount_upper_bound = amount_upper_bound
+      @amount_lower_bound = amount_lower_bound
+      @direction = direction
+      @internal_account_id = internal_account_id
+      @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
+      @line_items = line_items unless line_items == 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'] : nil
+      amount_lower_bound =
+        hash.key?('amount_lower_bound') ? hash['amount_lower_bound'] : nil
+      direction = hash.key?('direction') ? hash['direction'] : nil
+      internal_account_id =
+        hash.key?('internal_account_id') ? hash['internal_account_id'] : nil
+      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
+      # Parameter is an array, so we need to iterate through it
+      line_items = nil
+      unless hash['line_items'].nil?
+        line_items = []
+        hash['line_items'].each do |structure|
+          line_items << (LineItemRequest.from_hash(structure) if structure)
+        end
+      end
+
+      line_items = SKIP unless hash.key?('line_items')
+
+      # Create object from extracted values.
+      ExpectedPaymentCreateRequest.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,
+                                       line_items)
+    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}, line_items: #{@line_items}>"
+    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}, line_items: #{@line_items.inspect}>"
+    end
+  end
+end