modern_treasury 0.0.0 → 0.1.0.pre.alpha.16

data/lib/modern_treasury/models/document_create_params.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class DocumentCreateParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute documentable_id
+      #   The unique identifier for the associated object.
+      #
+      #   @return [String]
+      required :documentable_id, String
+
+      # @!attribute documentable_type
+      #
+      #   @return [Symbol, ModernTreasury::Models::DocumentCreateParams::DocumentableType]
+      required :documentable_type, enum: -> { ModernTreasury::Models::DocumentCreateParams::DocumentableType }
+
+      # @!attribute file
+      #
+      #   @return [IO, StringIO]
+      required :file, IO
+
+      # @!attribute [r] document_type
+      #   A category given to the document, can be `null`.
+      #
+      #   @return [String, nil]
+      optional :document_type, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :document_type
+
+      # @!parse
+      #   # @param documentable_id [String]
+      #   # @param documentable_type [Symbol, ModernTreasury::Models::DocumentCreateParams::DocumentableType]
+      #   # @param file [IO, StringIO]
+      #   # @param document_type [String]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(documentable_id:, documentable_type:, file:, document_type: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      module DocumentableType
+        extend ModernTreasury::Enum
+
+        CASES = :cases
+        COUNTERPARTIES = :counterparties
+        EXPECTED_PAYMENTS = :expected_payments
+        EXTERNAL_ACCOUNTS = :external_accounts
+        INCOMING_PAYMENT_DETAILS = :incoming_payment_details
+        INTERNAL_ACCOUNTS = :internal_accounts
+        ORGANIZATIONS = :organizations
+        PAPER_ITEMS = :paper_items
+        PAYMENT_ORDERS = :payment_orders
+        TRANSACTIONS = :transactions
+        DECISIONS = :decisions
+        CONNECTIONS = :connections
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/document_list_params.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class DocumentListParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute after_cursor
+      #
+      #   @return [String, nil]
+      optional :after_cursor, String, nil?: true
+
+      # @!attribute [r] documentable_id
+      #   The unique identifier for the associated object.
+      #
+      #   @return [String, nil]
+      optional :documentable_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :documentable_id
+
+      # @!attribute [r] documentable_type
+      #   The type of the associated object. Currently can be one of `payment_order`,
+      #     `transaction`, `paper_item`, `expected_payment`, `counterparty`, `organization`,
+      #     `case`, `internal_account`, `decision`, or `external_account`.
+      #
+      #   @return [Symbol, ModernTreasury::Models::DocumentListParams::DocumentableType, nil]
+      optional :documentable_type, enum: -> { ModernTreasury::Models::DocumentListParams::DocumentableType }
+
+      # @!parse
+      #   # @return [Symbol, ModernTreasury::Models::DocumentListParams::DocumentableType]
+      #   attr_writer :documentable_type
+
+      # @!attribute [r] per_page
+      #
+      #   @return [Integer, nil]
+      optional :per_page, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :per_page
+
+      # @!parse
+      #   # @param after_cursor [String, nil]
+      #   # @param documentable_id [String]
+      #   # @param documentable_type [Symbol, ModernTreasury::Models::DocumentListParams::DocumentableType]
+      #   # @param per_page [Integer]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(after_cursor: nil, documentable_id: nil, documentable_type: nil, per_page: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      # The type of the associated object. Currently can be one of `payment_order`,
+      #   `transaction`, `paper_item`, `expected_payment`, `counterparty`, `organization`,
+      #   `case`, `internal_account`, `decision`, or `external_account`.
+      module DocumentableType
+        extend ModernTreasury::Enum
+
+        CASES = :cases
+        COUNTERPARTIES = :counterparties
+        EXPECTED_PAYMENTS = :expected_payments
+        EXTERNAL_ACCOUNTS = :external_accounts
+        INCOMING_PAYMENT_DETAILS = :incoming_payment_details
+        INTERNAL_ACCOUNTS = :internal_accounts
+        ORGANIZATIONS = :organizations
+        PAPER_ITEMS = :paper_items
+        PAYMENT_ORDERS = :payment_orders
+        TRANSACTIONS = :transactions
+        DECISIONS = :decisions
+        CONNECTIONS = :connections
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/document_retrieve_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class DocumentRetrieveParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!parse
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(request_options: {}, **) = super
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+    end
+  end
+end

data/lib/modern_treasury/models/event.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class Event < ModernTreasury::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute data
+      #   The body of the event.
+      #
+      #   @return [Hash{Symbol=>Object}]
+      required :data, ModernTreasury::HashOf[ModernTreasury::Unknown]
+
+      # @!attribute entity_id
+      #   The ID of the entity for the event.
+      #
+      #   @return [String]
+      required :entity_id, String
+
+      # @!attribute event_name
+      #   The name of the event.
+      #
+      #   @return [String]
+      required :event_name, String
+
+      # @!attribute event_time
+      #   The time of the event.
+      #
+      #   @return [Time]
+      required :event_time, Time
+
+      # @!attribute 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 [Boolean]
+      required :live_mode, ModernTreasury::BooleanModel
+
+      # @!attribute object
+      #
+      #   @return [String]
+      required :object, String
+
+      # @!attribute resource
+      #   The type of resource for the event.
+      #
+      #   @return [String]
+      required :resource, String
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!parse
+      #   # @param id [String]
+      #   # @param created_at [Time]
+      #   # @param data [Hash{Symbol=>Object}]
+      #   # @param entity_id [String]
+      #   # @param event_name [String]
+      #   # @param event_time [Time]
+      #   # @param live_mode [Boolean]
+      #   # @param object [String]
+      #   # @param resource [String]
+      #   # @param updated_at [Time]
+      #   #
+      #   def initialize(
+      #     id:,
+      #     created_at:,
+      #     data:,
+      #     entity_id:,
+      #     event_name:,
+      #     event_time:,
+      #     live_mode:,
+      #     object:,
+      #     resource:,
+      #     updated_at:,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+    end
+  end
+end

data/lib/modern_treasury/models/event_list_params.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class EventListParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute after_cursor
+      #
+      #   @return [String, nil]
+      optional :after_cursor, String, nil?: true
+
+      # @!attribute [r] entity_id
+      #
+      #   @return [String, nil]
+      optional :entity_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :entity_id
+
+      # @!attribute [r] event_name
+      #
+      #   @return [String, nil]
+      optional :event_name, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :event_name
+
+      # @!attribute [r] event_time_end
+      #   An inclusive upper bound for when the event occurred
+      #
+      #   @return [Time, nil]
+      optional :event_time_end, Time
+
+      # @!parse
+      #   # @return [Time]
+      #   attr_writer :event_time_end
+
+      # @!attribute [r] event_time_start
+      #   An inclusive lower bound for when the event occurred
+      #
+      #   @return [Time, nil]
+      optional :event_time_start, Time
+
+      # @!parse
+      #   # @return [Time]
+      #   attr_writer :event_time_start
+
+      # @!attribute [r] per_page
+      #
+      #   @return [Integer, nil]
+      optional :per_page, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :per_page
+
+      # @!attribute [r] resource
+      #
+      #   @return [String, nil]
+      optional :resource, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :resource
+
+      # @!parse
+      #   # @param after_cursor [String, nil]
+      #   # @param entity_id [String]
+      #   # @param event_name [String]
+      #   # @param event_time_end [Time]
+      #   # @param event_time_start [Time]
+      #   # @param per_page [Integer]
+      #   # @param resource [String]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     after_cursor: nil,
+      #     entity_id: nil,
+      #     event_name: nil,
+      #     event_time_end: nil,
+      #     event_time_start: nil,
+      #     per_page: nil,
+      #     resource: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+    end
+  end
+end

data/lib/modern_treasury/models/event_retrieve_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class EventRetrieveParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!parse
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(request_options: {}, **) = super
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+    end
+  end
+end

data/lib/modern_treasury/models/expected_payment.rb

@@ -0,0 +1,285 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class ExpectedPayment < ModernTreasury::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute amount_lower_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, nil]
+      required :amount_lower_bound, Integer, nil?: true
+
+      # @!attribute amount_upper_bound
+      #   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, nil]
+      required :amount_upper_bound, Integer, nil?: true
+
+      # @!attribute counterparty_id
+      #   The ID of the counterparty you expect for this payment.
+      #
+      #   @return [String, nil]
+      required :counterparty_id, String, nil?: true
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute currency
+      #   Must conform to ISO 4217. Defaults to the currency of the internal account.
+      #
+      #   @return [Symbol, ModernTreasury::Models::Currency, nil]
+      required :currency, enum: -> { ModernTreasury::Models::Currency }, nil?: true
+
+      # @!attribute date_lower_bound
+      #   The earliest date the payment may come in. Format: yyyy-mm-dd
+      #
+      #   @return [Date, nil]
+      required :date_lower_bound, Date, nil?: true
+
+      # @!attribute date_upper_bound
+      #   The latest date the payment may come in. Format: yyyy-mm-dd
+      #
+      #   @return [Date, nil]
+      required :date_upper_bound, Date, nil?: true
+
+      # @!attribute description
+      #   An optional description for internal use.
+      #
+      #   @return [String, nil]
+      required :description, String, nil?: true
+
+      # @!attribute direction
+      #   One of credit or debit. When you are receiving money, use credit. When you are
+      #     being charged, use debit.
+      #
+      #   @return [Symbol, ModernTreasury::Models::ExpectedPayment::Direction, nil]
+      required :direction, enum: -> { ModernTreasury::Models::ExpectedPayment::Direction }, nil?: true
+
+      # @!attribute internal_account_id
+      #   The ID of the Internal Account for the expected payment.
+      #
+      #   @return [String, nil]
+      required :internal_account_id, String, nil?: true
+
+      # @!attribute ledger_transaction_id
+      #   The ID of the ledger transaction linked to the expected payment.
+      #
+      #   @return [String, nil]
+      required :ledger_transaction_id, String, nil?: true
+
+      # @!attribute 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 [Boolean]
+      required :live_mode, ModernTreasury::BooleanModel
+
+      # @!attribute metadata
+      #   Additional data represented as key-value pairs. Both the key and value must be
+      #     strings.
+      #
+      #   @return [Hash{Symbol=>String}]
+      required :metadata, ModernTreasury::HashOf[String]
+
+      # @!attribute object
+      #
+      #   @return [String]
+      required :object, String
+
+      # @!attribute reconciliation_filters
+      #   The reconciliation filters you have for this payment.
+      #
+      #   @return [Object, nil]
+      required :reconciliation_filters, ModernTreasury::Unknown, nil?: true
+
+      # @!attribute reconciliation_groups
+      #   The reconciliation groups you have for this payment.
+      #
+      #   @return [Object, nil]
+      required :reconciliation_groups, ModernTreasury::Unknown, nil?: true
+
+      # @!attribute reconciliation_method
+      #   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 [Symbol, ModernTreasury::Models::ExpectedPayment::ReconciliationMethod, nil]
+      required :reconciliation_method,
+               enum: -> { ModernTreasury::Models::ExpectedPayment::ReconciliationMethod },
+               nil?: true
+
+      # @!attribute reconciliation_rule_variables
+      #   An array of reconciliation rule variables for this payment.
+      #
+      #   @return [Array<ModernTreasury::Models::ReconciliationRule>, nil]
+      required :reconciliation_rule_variables,
+               -> { ModernTreasury::ArrayOf[ModernTreasury::Models::ReconciliationRule] },
+               nil?: true
+
+      # @!attribute remittance_information
+      #   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, nil]
+      required :remittance_information, String, nil?: true
+
+      # @!attribute statement_descriptor
+      #   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, nil]
+      required :statement_descriptor, String, nil?: true
+
+      # @!attribute status
+      #   One of unreconciled, partially_reconciled, reconciled, or archived.
+      #
+      #   @return [Symbol, ModernTreasury::Models::ExpectedPayment::Status]
+      required :status, enum: -> { ModernTreasury::Models::ExpectedPayment::Status }
+
+      # @!attribute transaction_id
+      #   The ID of the Transaction this expected payment object has been matched to.
+      #
+      #   @return [String, nil]
+      required :transaction_id, String, nil?: true
+
+      # @!attribute transaction_line_item_id
+      #   The ID of the Transaction Line Item this expected payment has been matched to.
+      #
+      #   @return [String, nil]
+      required :transaction_line_item_id, String, nil?: true
+
+      # @!attribute type
+      #   One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen,
+      #     sepa, signet, wire.
+      #
+      #   @return [Symbol, ModernTreasury::Models::ExpectedPaymentType, nil]
+      required :type, enum: -> { ModernTreasury::Models::ExpectedPaymentType }, nil?: true
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!parse
+      #   # @param id [String]
+      #   # @param amount_lower_bound [Integer, nil]
+      #   # @param amount_upper_bound [Integer, nil]
+      #   # @param counterparty_id [String, nil]
+      #   # @param created_at [Time]
+      #   # @param currency [Symbol, ModernTreasury::Models::Currency, nil]
+      #   # @param date_lower_bound [Date, nil]
+      #   # @param date_upper_bound [Date, nil]
+      #   # @param description [String, nil]
+      #   # @param direction [Symbol, ModernTreasury::Models::ExpectedPayment::Direction, nil]
+      #   # @param internal_account_id [String, nil]
+      #   # @param ledger_transaction_id [String, nil]
+      #   # @param live_mode [Boolean]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param object [String]
+      #   # @param reconciliation_filters [Object, nil]
+      #   # @param reconciliation_groups [Object, nil]
+      #   # @param reconciliation_method [Symbol, ModernTreasury::Models::ExpectedPayment::ReconciliationMethod, nil]
+      #   # @param reconciliation_rule_variables [Array<ModernTreasury::Models::ReconciliationRule>, nil]
+      #   # @param remittance_information [String, nil]
+      #   # @param statement_descriptor [String, nil]
+      #   # @param status [Symbol, ModernTreasury::Models::ExpectedPayment::Status]
+      #   # @param transaction_id [String, nil]
+      #   # @param transaction_line_item_id [String, nil]
+      #   # @param type [Symbol, ModernTreasury::Models::ExpectedPaymentType, nil]
+      #   # @param updated_at [Time]
+      #   #
+      #   def initialize(
+      #     id:,
+      #     amount_lower_bound:,
+      #     amount_upper_bound:,
+      #     counterparty_id:,
+      #     created_at:,
+      #     currency:,
+      #     date_lower_bound:,
+      #     date_upper_bound:,
+      #     description:,
+      #     direction:,
+      #     internal_account_id:,
+      #     ledger_transaction_id:,
+      #     live_mode:,
+      #     metadata:,
+      #     object:,
+      #     reconciliation_filters:,
+      #     reconciliation_groups:,
+      #     reconciliation_method:,
+      #     reconciliation_rule_variables:,
+      #     remittance_information:,
+      #     statement_descriptor:,
+      #     status:,
+      #     transaction_id:,
+      #     transaction_line_item_id:,
+      #     type:,
+      #     updated_at:,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      # One of credit or debit. When you are receiving money, use credit. When you are
+      #   being charged, use debit.
+      module Direction
+        extend ModernTreasury::Enum
+
+        CREDIT = :credit
+        DEBIT = :debit
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      # 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.
+      module ReconciliationMethod
+        extend ModernTreasury::Enum
+
+        AUTOMATIC = :automatic
+        MANUAL = :manual
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      # One of unreconciled, partially_reconciled, reconciled, or archived.
+      module Status
+        extend ModernTreasury::Enum
+
+        ARCHIVED = :archived
+        PARTIALLY_RECONCILED = :partially_reconciled
+        RECONCILED = :reconciled
+        UNRECONCILED = :unreconciled
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end