modern_treasury 0.0.0 → 0.1.0.pre.alpha.15

data/lib/modern_treasury/base_page.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  # @private
+  #
+  # @abstract
+  #
+  module BasePage
+    # @return [Boolean]
+    #
+    def next_page? = (raise NotImplementedError)
+
+    # @raise [ModernTreasury::APIError]
+    # @return [ModernTreasury::BasePage]
+    #
+    def next_page = (raise NotImplementedError)
+
+    # @param blk [Proc]
+    #
+    # @return [void]
+    #
+    def auto_paging_each(&) = (raise NotImplementedError)
+
+    # @return [Enumerable]
+    #
+    def to_enum = super(:auto_paging_each)
+
+    alias_method :enum_for, :to_enum
+
+    # @!parse
+    #   # @private
+    #   #
+    #   # @param client [ModernTreasury::BaseClient]
+    #   # @param req [Hash{Symbol=>Object}]
+    #   # @param headers [Hash{String=>String}, Net::HTTPHeader]
+    #   # @param unwrapped [Object]
+    #   #
+    #   def initialize(client:, req:, headers:, unwrapped:); end
+  end
+end

data/lib/modern_treasury/client.rb

@@ -0,0 +1,236 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  class Client < ModernTreasury::BaseClient
+    # Default max number of retries to attempt after a failed retryable request.
+    DEFAULT_MAX_RETRIES = 2
+
+    # Default per-request timeout.
+    DEFAULT_TIMEOUT_IN_SECONDS = 60.0
+
+    # Default initial retry delay in seconds.
+    # Overall delay is calculated using exponential backoff + jitter.
+    DEFAULT_INITIAL_RETRY_DELAY = 0.5
+
+    # Default max retry delay in seconds.
+    DEFAULT_MAX_RETRY_DELAY = 8.0
+
+    # Client option
+    # @return [String]
+    attr_reader :api_key
+
+    # Client option
+    # @return [String]
+    attr_reader :organization_id
+
+    # @return [ModernTreasury::Resources::Connections]
+    attr_reader :connections
+
+    # @return [ModernTreasury::Resources::Counterparties]
+    attr_reader :counterparties
+
+    # @return [ModernTreasury::Resources::Events]
+    attr_reader :events
+
+    # @return [ModernTreasury::Resources::ExpectedPayments]
+    attr_reader :expected_payments
+
+    # @return [ModernTreasury::Resources::ExternalAccounts]
+    attr_reader :external_accounts
+
+    # @return [ModernTreasury::Resources::IncomingPaymentDetails]
+    attr_reader :incoming_payment_details
+
+    # @return [ModernTreasury::Resources::Invoices]
+    attr_reader :invoices
+
+    # @return [ModernTreasury::Resources::Documents]
+    attr_reader :documents
+
+    # @return [ModernTreasury::Resources::AccountCollectionFlows]
+    attr_reader :account_collection_flows
+
+    # @return [ModernTreasury::Resources::AccountDetails]
+    attr_reader :account_details
+
+    # @return [ModernTreasury::Resources::RoutingDetails]
+    attr_reader :routing_details
+
+    # @return [ModernTreasury::Resources::InternalAccounts]
+    attr_reader :internal_accounts
+
+    # @return [ModernTreasury::Resources::Ledgers]
+    attr_reader :ledgers
+
+    # @return [ModernTreasury::Resources::LedgerableEvents]
+    attr_reader :ledgerable_events
+
+    # @return [ModernTreasury::Resources::LedgerAccountCategories]
+    attr_reader :ledger_account_categories
+
+    # @return [ModernTreasury::Resources::LedgerAccounts]
+    attr_reader :ledger_accounts
+
+    # @return [ModernTreasury::Resources::LedgerAccountBalanceMonitors]
+    attr_reader :ledger_account_balance_monitors
+
+    # @return [ModernTreasury::Resources::LedgerAccountStatements]
+    attr_reader :ledger_account_statements
+
+    # @return [ModernTreasury::Resources::LedgerEntries]
+    attr_reader :ledger_entries
+
+    # @return [ModernTreasury::Resources::LedgerEventHandlers]
+    attr_reader :ledger_event_handlers
+
+    # @return [ModernTreasury::Resources::LedgerTransactions]
+    attr_reader :ledger_transactions
+
+    # @return [ModernTreasury::Resources::LineItems]
+    attr_reader :line_items
+
+    # @return [ModernTreasury::Resources::PaymentFlows]
+    attr_reader :payment_flows
+
+    # @return [ModernTreasury::Resources::PaymentOrders]
+    attr_reader :payment_orders
+
+    # @return [ModernTreasury::Resources::PaymentReferences]
+    attr_reader :payment_references
+
+    # @return [ModernTreasury::Resources::Returns]
+    attr_reader :returns
+
+    # @return [ModernTreasury::Resources::Transactions]
+    attr_reader :transactions
+
+    # @return [ModernTreasury::Resources::Validations]
+    attr_reader :validations
+
+    # @return [ModernTreasury::Resources::PaperItems]
+    attr_reader :paper_items
+
+    # @return [ModernTreasury::Resources::VirtualAccounts]
+    attr_reader :virtual_accounts
+
+    # @return [ModernTreasury::Resources::BulkRequests]
+    attr_reader :bulk_requests
+
+    # @return [ModernTreasury::Resources::BulkResults]
+    attr_reader :bulk_results
+
+    # @return [ModernTreasury::Resources::LedgerAccountSettlements]
+    attr_reader :ledger_account_settlements
+
+    # @return [ModernTreasury::Resources::ForeignExchangeQuotes]
+    attr_reader :foreign_exchange_quotes
+
+    # @return [ModernTreasury::Resources::ConnectionLegalEntities]
+    attr_reader :connection_legal_entities
+
+    # @return [ModernTreasury::Resources::LegalEntities]
+    attr_reader :legal_entities
+
+    # @return [ModernTreasury::Resources::LegalEntityAssociations]
+    attr_reader :legal_entity_associations
+
+    # @private
+    #
+    # @return [Hash{String=>String}]
+    #
+    private def auth_headers
+      return {} if @organization_id.nil? || @api_key.nil?
+
+      base64_credentials = ["#{@organization_id}:#{@api_key}"].pack("m0")
+      {"Authorization" => "Basic #{base64_credentials}"}
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    #
+    # @param base_url [String, nil] Override the default base URL for the API, e.g., `"https://api.example.com/v2/"`
+    #
+    # @param api_key [String, nil] Defaults to `ENV["MODERN_TREASURY_API_KEY"]`
+    #
+    # @param organization_id [String, nil] Defaults to `ENV["MODERN_TREASURY_ORGANIZATION_ID"]`
+    #
+    # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request.
+    #
+    # @param timeout [Float]
+    #
+    # @param initial_retry_delay [Float]
+    #
+    # @param max_retry_delay [Float]
+    #
+    # @param idempotency_header [String]
+    #
+    def initialize(
+      base_url: nil,
+      api_key: ENV["MODERN_TREASURY_API_KEY"],
+      organization_id: ENV["MODERN_TREASURY_ORGANIZATION_ID"],
+      max_retries: DEFAULT_MAX_RETRIES,
+      timeout: DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: DEFAULT_MAX_RETRY_DELAY,
+      idempotency_header: "Idempotency-Key"
+    )
+      base_url ||= "https://app.moderntreasury.com"
+
+      if api_key.nil?
+        raise ArgumentError.new("api_key is required")
+      end
+      if organization_id.nil?
+        raise ArgumentError.new("organization_id is required")
+      end
+
+      @api_key = api_key.to_s
+      @organization_id = organization_id.to_s
+
+      super(
+        base_url: base_url,
+        timeout: timeout,
+        max_retries: max_retries,
+        initial_retry_delay: initial_retry_delay,
+        max_retry_delay: max_retry_delay,
+        idempotency_header: idempotency_header
+      )
+
+      @connections = ModernTreasury::Resources::Connections.new(client: self)
+      @counterparties = ModernTreasury::Resources::Counterparties.new(client: self)
+      @events = ModernTreasury::Resources::Events.new(client: self)
+      @expected_payments = ModernTreasury::Resources::ExpectedPayments.new(client: self)
+      @external_accounts = ModernTreasury::Resources::ExternalAccounts.new(client: self)
+      @incoming_payment_details = ModernTreasury::Resources::IncomingPaymentDetails.new(client: self)
+      @invoices = ModernTreasury::Resources::Invoices.new(client: self)
+      @documents = ModernTreasury::Resources::Documents.new(client: self)
+      @account_collection_flows = ModernTreasury::Resources::AccountCollectionFlows.new(client: self)
+      @account_details = ModernTreasury::Resources::AccountDetails.new(client: self)
+      @routing_details = ModernTreasury::Resources::RoutingDetails.new(client: self)
+      @internal_accounts = ModernTreasury::Resources::InternalAccounts.new(client: self)
+      @ledgers = ModernTreasury::Resources::Ledgers.new(client: self)
+      @ledgerable_events = ModernTreasury::Resources::LedgerableEvents.new(client: self)
+      @ledger_account_categories = ModernTreasury::Resources::LedgerAccountCategories.new(client: self)
+      @ledger_accounts = ModernTreasury::Resources::LedgerAccounts.new(client: self)
+      @ledger_account_balance_monitors = ModernTreasury::Resources::LedgerAccountBalanceMonitors.new(client: self)
+      @ledger_account_statements = ModernTreasury::Resources::LedgerAccountStatements.new(client: self)
+      @ledger_entries = ModernTreasury::Resources::LedgerEntries.new(client: self)
+      @ledger_event_handlers = ModernTreasury::Resources::LedgerEventHandlers.new(client: self)
+      @ledger_transactions = ModernTreasury::Resources::LedgerTransactions.new(client: self)
+      @line_items = ModernTreasury::Resources::LineItems.new(client: self)
+      @payment_flows = ModernTreasury::Resources::PaymentFlows.new(client: self)
+      @payment_orders = ModernTreasury::Resources::PaymentOrders.new(client: self)
+      @payment_references = ModernTreasury::Resources::PaymentReferences.new(client: self)
+      @returns = ModernTreasury::Resources::Returns.new(client: self)
+      @transactions = ModernTreasury::Resources::Transactions.new(client: self)
+      @validations = ModernTreasury::Resources::Validations.new(client: self)
+      @paper_items = ModernTreasury::Resources::PaperItems.new(client: self)
+      @virtual_accounts = ModernTreasury::Resources::VirtualAccounts.new(client: self)
+      @bulk_requests = ModernTreasury::Resources::BulkRequests.new(client: self)
+      @bulk_results = ModernTreasury::Resources::BulkResults.new(client: self)
+      @ledger_account_settlements = ModernTreasury::Resources::LedgerAccountSettlements.new(client: self)
+      @foreign_exchange_quotes = ModernTreasury::Resources::ForeignExchangeQuotes.new(client: self)
+      @connection_legal_entities = ModernTreasury::Resources::ConnectionLegalEntities.new(client: self)
+      @legal_entities = ModernTreasury::Resources::LegalEntities.new(client: self)
+      @legal_entity_associations = ModernTreasury::Resources::LegalEntityAssociations.new(client: self)
+    end
+  end
+end

data/lib/modern_treasury/errors.rb

@@ -0,0 +1,187 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  class Error < StandardError
+    # @!parse
+    #   # @return [StandardError, nil]
+    #   attr_reader :cause
+  end
+
+  class ConversionError < ModernTreasury::Error
+  end
+
+  class APIError < ModernTreasury::Error
+    # @return [URI::Generic]
+    attr_reader :url
+
+    # @return [Integer, nil]
+    attr_reader :status
+
+    # @return [Object, nil]
+    attr_reader :body
+
+    # @private
+    #
+    # @param url [URI::Generic]
+    # @param status [Integer, nil]
+    # @param body [Object, nil]
+    # @param request [nil]
+    # @param response [nil]
+    # @param message [String, nil]
+    #
+    def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: nil)
+      @url = url
+      @status = status
+      @body = body
+      @request = request
+      @response = response
+      super(message)
+    end
+  end
+
+  class APIConnectionError < ModernTreasury::APIError
+    # @!parse
+    #   # @return [nil]
+    #   attr_reader :status
+
+    # @!parse
+    #   # @return [nil]
+    #   attr_reader :body
+
+    # @private
+    #
+    # @param url [URI::Generic]
+    # @param status [nil]
+    # @param body [nil]
+    # @param request [nil]
+    # @param response [nil]
+    # @param message [String, nil]
+    #
+    def initialize(
+      url:,
+      status: nil,
+      body: nil,
+      request: nil,
+      response: nil,
+      message: "Connection error."
+    )
+      super
+    end
+  end
+
+  class APITimeoutError < ModernTreasury::APIConnectionError
+    # @private
+    #
+    # @param url [URI::Generic]
+    # @param status [nil]
+    # @param body [nil]
+    # @param request [nil]
+    # @param response [nil]
+    # @param message [String, nil]
+    #
+    def initialize(
+      url:,
+      status: nil,
+      body: nil,
+      request: nil,
+      response: nil,
+      message: "Request timed out."
+    )
+      super
+    end
+  end
+
+  class APIStatusError < ModernTreasury::APIError
+    # @private
+    #
+    # @param url [URI::Generic]
+    # @param status [Integer]
+    # @param body [Object, nil]
+    # @param request [nil]
+    # @param response [nil]
+    #
+    # @return [ModernTreasury::APIStatusError]
+    #
+    def self.for(url:, status:, body:, request:, response:)
+      kwargs = {url: url, status: status, body: body, request: request, response: response}
+
+      case status
+      in 400
+        ModernTreasury::BadRequestError.new(**kwargs)
+      in 401
+        ModernTreasury::AuthenticationError.new(**kwargs)
+      in 403
+        ModernTreasury::PermissionDeniedError.new(**kwargs)
+      in 404
+        ModernTreasury::NotFoundError.new(**kwargs)
+      in 409
+        ModernTreasury::ConflictError.new(**kwargs)
+      in 422
+        ModernTreasury::UnprocessableEntityError.new(**kwargs)
+      in 429
+        ModernTreasury::RateLimitError.new(**kwargs)
+      in (500..)
+        ModernTreasury::InternalServerError.new(**kwargs)
+      else
+        ModernTreasury::APIStatusError.new(**kwargs)
+      end
+    end
+
+    # @!parse
+    #   # @return [Integer]
+    #   attr_reader :status
+
+    # @private
+    #
+    # @param url [URI::Generic]
+    # @param status [Integer]
+    # @param body [Object, nil]
+    # @param request [nil]
+    # @param response [nil]
+    # @param message [String, nil]
+    #
+    def initialize(url:, status:, body:, request:, response:, message: nil)
+      message ||= {url: url.to_s, status: status, body: body}
+      super(
+        url: url,
+        status: status,
+        body: body,
+        request: request,
+        response: response,
+        message: message&.to_s
+      )
+    end
+  end
+
+  class BadRequestError < ModernTreasury::APIStatusError
+    HTTP_STATUS = 400
+  end
+
+  class AuthenticationError < ModernTreasury::APIStatusError
+    HTTP_STATUS = 401
+  end
+
+  class PermissionDeniedError < ModernTreasury::APIStatusError
+    HTTP_STATUS = 403
+  end
+
+  class NotFoundError < ModernTreasury::APIStatusError
+    HTTP_STATUS = 404
+  end
+
+  class ConflictError < ModernTreasury::APIStatusError
+    HTTP_STATUS = 409
+  end
+
+  class UnprocessableEntityError < ModernTreasury::APIStatusError
+    HTTP_STATUS = 422
+  end
+
+  class RateLimitError < ModernTreasury::APIStatusError
+    HTTP_STATUS = 429
+  end
+
+  class InternalServerError < ModernTreasury::APIStatusError
+    HTTP_STATUS = (500..)
+  end
+end

data/lib/modern_treasury/extern.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  # @private
+  #
+  # @abstract
+  #
+  module Extern
+  end
+end

data/lib/modern_treasury/models/account_collection_flow.rb

@@ -0,0 +1,244 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class AccountCollectionFlow < ModernTreasury::BaseModel
+      # @!attribute counterparty_id
+      #   The ID of a counterparty. An external account created with this flow will be
+      #     associated with this counterparty.
+      #
+      #   @return [String]
+      required :counterparty_id, String
+
+      # @!attribute payment_types
+      #
+      #   @return [Array<Symbol, ModernTreasury::Models::AccountCollectionFlow::PaymentType>]
+      required :payment_types,
+               -> { ModernTreasury::ArrayOf[enum: ModernTreasury::Models::AccountCollectionFlow::PaymentType] }
+
+      # @!attribute [r] id
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :id
+
+      # @!attribute [r] client_token
+      #   The client token of the account collection flow. This token can be used to embed
+      #     account collection in your client-side application.
+      #
+      #   @return [String, nil]
+      optional :client_token, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :client_token
+
+      # @!attribute [r] created_at
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time
+
+      # @!parse
+      #   # @return [Time]
+      #   attr_writer :created_at
+
+      # @!attribute external_account_id
+      #   If present, the ID of the external account created using this flow.
+      #
+      #   @return [String, nil]
+      optional :external_account_id, String, nil?: true
+
+      # @!attribute [r] 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, nil]
+      optional :live_mode, ModernTreasury::BooleanModel
+
+      # @!parse
+      #   # @return [Boolean]
+      #   attr_writer :live_mode
+
+      # @!attribute [r] object
+      #
+      #   @return [String, nil]
+      optional :object, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :object
+
+      # @!attribute [r] receiving_countries
+      #
+      #   @return [Array<Symbol, ModernTreasury::Models::AccountCollectionFlow::ReceivingCountry>, nil]
+      optional :receiving_countries,
+               -> { ModernTreasury::ArrayOf[enum: ModernTreasury::Models::AccountCollectionFlow::ReceivingCountry] }
+
+      # @!parse
+      #   # @return [Array<Symbol, ModernTreasury::Models::AccountCollectionFlow::ReceivingCountry>]
+      #   attr_writer :receiving_countries
+
+      # @!attribute [r] status
+      #   The current status of the account collection flow. One of `pending`,
+      #     `completed`, `expired`, or `cancelled`.
+      #
+      #   @return [Symbol, ModernTreasury::Models::AccountCollectionFlow::Status, nil]
+      optional :status, enum: -> { ModernTreasury::Models::AccountCollectionFlow::Status }
+
+      # @!parse
+      #   # @return [Symbol, ModernTreasury::Models::AccountCollectionFlow::Status]
+      #   attr_writer :status
+
+      # @!attribute [r] updated_at
+      #
+      #   @return [Time, nil]
+      optional :updated_at, Time
+
+      # @!parse
+      #   # @return [Time]
+      #   attr_writer :updated_at
+
+      # @!parse
+      #   # @param counterparty_id [String]
+      #   # @param payment_types [Array<Symbol, ModernTreasury::Models::AccountCollectionFlow::PaymentType>]
+      #   # @param id [String]
+      #   # @param client_token [String]
+      #   # @param created_at [Time]
+      #   # @param external_account_id [String, nil]
+      #   # @param live_mode [Boolean]
+      #   # @param object [String]
+      #   # @param receiving_countries [Array<Symbol, ModernTreasury::Models::AccountCollectionFlow::ReceivingCountry>]
+      #   # @param status [Symbol, ModernTreasury::Models::AccountCollectionFlow::Status]
+      #   # @param updated_at [Time]
+      #   #
+      #   def initialize(
+      #     counterparty_id:,
+      #     payment_types:,
+      #     id: nil,
+      #     client_token: nil,
+      #     created_at: nil,
+      #     external_account_id: nil,
+      #     live_mode: nil,
+      #     object: nil,
+      #     receiving_countries: nil,
+      #     status: nil,
+      #     updated_at: nil,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      # @abstract
+      #
+      # An account created with this flow will support payments of one of these types.
+      #
+      # @example
+      # ```ruby
+      # case payment_type
+      # in :ach
+      #   # ...
+      # in :wire
+      #   # ...
+      # end
+      # ```
+      class PaymentType < ModernTreasury::Enum
+        ACH = :ach
+        WIRE = :wire
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+
+      # @abstract
+      #
+      # An account created with this flow will support wires from the US to these
+      #   countries.
+      #
+      # @example
+      # ```ruby
+      # case receiving_country
+      # in :USA
+      #   # ...
+      # in :AUS
+      #   # ...
+      # in :BEL
+      #   # ...
+      # in :CAN
+      #   # ...
+      # in :CHL
+      #   # ...
+      # in ...
+      #   #...
+      # end
+      # ```
+      class ReceivingCountry < ModernTreasury::Enum
+        USA = :USA
+        AUS = :AUS
+        BEL = :BEL
+        CAN = :CAN
+        CHL = :CHL
+        CHN = :CHN
+        COL = :COL
+        FRA = :FRA
+        DEU = :DEU
+        HKG = :HKG
+        IND = :IND
+        IRL = :IRL
+        ITA = :ITA
+        MEX = :MEX
+        NLD = :NLD
+        PER = :PER
+        ESP = :ESP
+        GBR = :GBR
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+
+      # @abstract
+      #
+      # The current status of the account collection flow. One of `pending`,
+      #   `completed`, `expired`, or `cancelled`.
+      #
+      # @example
+      # ```ruby
+      # case status
+      # in :cancelled
+      #   # ...
+      # in :completed
+      #   # ...
+      # in :expired
+      #   # ...
+      # in :pending
+      #   # ...
+      # end
+      # ```
+      class Status < ModernTreasury::Enum
+        CANCELLED = :cancelled
+        COMPLETED = :completed
+        EXPIRED = :expired
+        PENDING = :pending
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+    end
+  end
+end