modern_treasury 0.0.0 → 0.1.0.pre.alpha.15

data/sig/modern_treasury/base_model.rbs

@@ -0,0 +1,246 @@
+module ModernTreasury
+  module Converter
+    type input = ModernTreasury::Converter | Class
+
+    def coerce: (top value) -> top
+
+    def dump: (top value) -> top
+
+    def try_strict_coerce: (
+      top value
+    ) -> ([true, top, nil] | [false, bool, Integer])
+
+    def self.type_info: (
+      {
+        const: (nil | bool | Integer | Float | Symbol)?,
+        enum: ^-> ModernTreasury::Converter::input?,
+        union: ^-> ModernTreasury::Converter::input?
+      }
+      | ^-> ModernTreasury::Converter::input
+      | ModernTreasury::Converter::input spec
+    ) -> (^-> top)
+
+    def self.coerce: (ModernTreasury::Converter::input target, top value) -> top
+
+    def self.dump: (ModernTreasury::Converter::input target, top value) -> top
+
+    def self.try_strict_coerce: (
+      ModernTreasury::Converter::input target,
+      top value
+    ) -> top
+  end
+
+  class Unknown
+    extend ModernTreasury::Converter
+
+    def self.===: (top other) -> bool
+
+    def self.==: (top other) -> bool
+
+    def self.coerce: (top value) -> top
+
+    def self.dump: (top value) -> top
+
+    def self.try_strict_coerce: (
+      top value
+    ) -> ([true, top, nil] | [false, bool, Integer])
+  end
+
+  class BooleanModel
+    extend ModernTreasury::Converter
+
+    def self.===: (top other) -> bool
+
+    def self.==: (top other) -> bool
+
+    def self.coerce: (bool | top value) -> (bool | top)
+
+    def self.dump: (bool | top value) -> (bool | top)
+
+    def self.try_strict_coerce: (
+      top value
+    ) -> ([true, top, nil] | [false, bool, Integer])
+  end
+
+  class Enum
+    extend ModernTreasury::Converter
+
+    def self.values: -> ::Array[(nil | bool | Integer | Float | Symbol)]
+
+    private def self.finalize!: -> void
+
+    def self.===: (top other) -> bool
+
+    def self.==: (top other) -> bool
+
+    def self.coerce: (String | Symbol | top value) -> (Symbol | top)
+
+    def self.dump: (Symbol | top value) -> (Symbol | top)
+
+    def self.try_strict_coerce: (
+      top value
+    ) -> ([true, top, nil] | [false, bool, Integer])
+  end
+
+  class Union
+    extend ModernTreasury::Extern
+    extend ModernTreasury::Converter
+
+    private def self.known_variants: -> ::Array[[Symbol?, Proc]]
+
+    def self.variants: -> ::Array[[Symbol?, top]]
+
+    private def self.discriminator: (Symbol property) -> void
+
+    private def self.variant: (
+      Symbol
+      | ::Hash[Symbol, top]
+      | ^-> ModernTreasury::Converter::input
+      | ModernTreasury::Converter::input key,
+      ?::Hash[Symbol, top]
+      | ^-> ModernTreasury::Converter::input
+      | ModernTreasury::Converter::input spec
+    ) -> void
+
+    private def self.resolve_variant: (
+      top value
+    ) -> ModernTreasury::Converter::input?
+
+    def self.===: (top other) -> bool
+
+    def self.==: (top other) -> bool
+
+    def self.coerce: (top value) -> top
+
+    def self.dump: (top value) -> top
+
+    def self.try_strict_coerce: (
+      top value
+    ) -> ([true, top, nil] | [false, bool, Integer])
+  end
+
+  class ArrayOf
+    include ModernTreasury::Converter
+
+    def ===: (top other) -> bool
+
+    def ==: (top other) -> bool
+
+    def coerce: (Enumerable[top] | top value) -> (::Array[top] | top)
+
+    def dump: (Enumerable[top] | top value) -> (::Array[top] | top)
+
+    def try_strict_coerce: (
+      top value
+    ) -> ([true, top, nil] | [false, bool, Integer])
+
+    def item_type: -> ModernTreasury::Converter::input
+
+    def initialize: (
+      ::Hash[Symbol, top]
+      | ^-> ModernTreasury::Converter::input
+      | ModernTreasury::Converter::input type_info,
+      ?::Hash[Symbol, top] spec
+    ) -> void
+  end
+
+  class HashOf
+    include ModernTreasury::Converter
+
+    def ===: (top other) -> bool
+
+    def ==: (top other) -> bool
+
+    def coerce: (::Hash[top, top] | top value) -> (::Hash[Symbol, top] | top)
+
+    def dump: (::Hash[top, top] | top value) -> (::Hash[Symbol, top] | top)
+
+    def try_strict_coerce: (
+      top value
+    ) -> ([true, top, nil] | [false, bool, Integer])
+
+    def item_type: -> ModernTreasury::Converter::input
+
+    def initialize: (
+      ::Hash[Symbol, top]
+      | ^-> ModernTreasury::Converter::input
+      | ModernTreasury::Converter::input type_info,
+      ?::Hash[Symbol, top] spec
+    ) -> void
+  end
+
+  class BaseModel
+    extend ModernTreasury::Extern
+    extend ModernTreasury::Converter
+
+    type known_field = { mode: (:coerce | :dump)?, required: bool }
+
+    def self.known_fields: -> ::Hash[Symbol, (ModernTreasury::BaseModel::known_field
+    & { type_fn: (^-> ModernTreasury::Converter::input) })]
+
+    def self.fields: -> ::Hash[Symbol, (ModernTreasury::BaseModel::known_field
+    & { type: ModernTreasury::Converter::input })]
+
+    def self.defaults: -> ::Hash[Symbol, (^-> Class)]
+
+    private def self.add_field: (
+      Symbol name_sym,
+      required: bool,
+      type_info: {
+        const: (nil | bool | Integer | Float | Symbol)?,
+        enum: ^-> ModernTreasury::Converter::input?,
+        union: ^-> ModernTreasury::Converter::input?,
+        api_name: Symbol
+      }
+      | ^-> ModernTreasury::Converter::input
+      | ModernTreasury::Converter::input,
+      spec: ::Hash[Symbol, top]
+    ) -> void
+
+    def self.required: (
+      Symbol name_sym,
+      ::Hash[Symbol, top]
+      | ^-> ModernTreasury::Converter::input
+      | ModernTreasury::Converter::input type_info,
+      ?::Hash[Symbol, top] spec
+    ) -> void
+
+    def self.optional: (
+      Symbol name_sym,
+      ::Hash[Symbol, top]
+      | ^-> ModernTreasury::Converter::input
+      | ModernTreasury::Converter::input type_info,
+      ?::Hash[Symbol, top] spec
+    ) -> void
+
+    private def self.request_only: { -> void } -> void
+
+    private def self.response_only: { -> void } -> void
+
+    def ==: (top other) -> bool
+
+    def self.coerce: (
+      ModernTreasury::BaseModel | ::Hash[top, top] | top value
+    ) -> (instance | top)
+
+    def self.dump: (instance | top value) -> (::Hash[top, top] | top)
+
+    def self.try_strict_coerce: (
+      top value
+    ) -> ([true, top, nil] | [false, bool, Integer])
+
+    def []: (Symbol key) -> top?
+
+    def to_h: -> ::Hash[Symbol, top]
+
+    alias to_hash to_h
+
+    def deconstruct_keys: (::Array[Symbol]? keys) -> ::Hash[Symbol, top]
+
+    def initialize: (?::Hash[Symbol, top] | self data) -> void
+
+    def to_s: -> String
+
+    def inspect: -> String
+  end
+end

data/sig/modern_treasury/base_page.rbs

@@ -0,0 +1,20 @@
+module ModernTreasury
+  module BasePage[Elem]
+    def next_page?: -> bool
+
+    def next_page: -> self
+
+    def auto_paging_each: { (Elem arg0) -> void } -> void
+
+    def to_enum: -> Enumerable[Elem]
+
+    alias enum_for to_enum
+
+    def initialize: (
+      client: ModernTreasury::BaseClient,
+      req: ModernTreasury::BaseClient::request_components,
+      headers: ::Hash[String, String],
+      unwrapped: top
+    ) -> void
+  end
+end

data/sig/modern_treasury/client.rbs

@@ -0,0 +1,102 @@
+module ModernTreasury
+  class Client < ModernTreasury::BaseClient
+    DEFAULT_MAX_RETRIES: 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS: Float
+
+    DEFAULT_INITIAL_RETRY_DELAY: Float
+
+    DEFAULT_MAX_RETRY_DELAY: Float
+
+    attr_reader api_key: String
+
+    attr_reader organization_id: String
+
+    attr_reader connections: ModernTreasury::Resources::Connections
+
+    attr_reader counterparties: ModernTreasury::Resources::Counterparties
+
+    attr_reader events: ModernTreasury::Resources::Events
+
+    attr_reader expected_payments: ModernTreasury::Resources::ExpectedPayments
+
+    attr_reader external_accounts: ModernTreasury::Resources::ExternalAccounts
+
+    attr_reader incoming_payment_details: ModernTreasury::Resources::IncomingPaymentDetails
+
+    attr_reader invoices: ModernTreasury::Resources::Invoices
+
+    attr_reader documents: ModernTreasury::Resources::Documents
+
+    attr_reader account_collection_flows: ModernTreasury::Resources::AccountCollectionFlows
+
+    attr_reader account_details: ModernTreasury::Resources::AccountDetails
+
+    attr_reader routing_details: ModernTreasury::Resources::RoutingDetails
+
+    attr_reader internal_accounts: ModernTreasury::Resources::InternalAccounts
+
+    attr_reader ledgers: ModernTreasury::Resources::Ledgers
+
+    attr_reader ledgerable_events: ModernTreasury::Resources::LedgerableEvents
+
+    attr_reader ledger_account_categories: ModernTreasury::Resources::LedgerAccountCategories
+
+    attr_reader ledger_accounts: ModernTreasury::Resources::LedgerAccounts
+
+    attr_reader ledger_account_balance_monitors: ModernTreasury::Resources::LedgerAccountBalanceMonitors
+
+    attr_reader ledger_account_statements: ModernTreasury::Resources::LedgerAccountStatements
+
+    attr_reader ledger_entries: ModernTreasury::Resources::LedgerEntries
+
+    attr_reader ledger_event_handlers: ModernTreasury::Resources::LedgerEventHandlers
+
+    attr_reader ledger_transactions: ModernTreasury::Resources::LedgerTransactions
+
+    attr_reader line_items: ModernTreasury::Resources::LineItems
+
+    attr_reader payment_flows: ModernTreasury::Resources::PaymentFlows
+
+    attr_reader payment_orders: ModernTreasury::Resources::PaymentOrders
+
+    attr_reader payment_references: ModernTreasury::Resources::PaymentReferences
+
+    attr_reader returns: ModernTreasury::Resources::Returns
+
+    attr_reader transactions: ModernTreasury::Resources::Transactions
+
+    attr_reader validations: ModernTreasury::Resources::Validations
+
+    attr_reader paper_items: ModernTreasury::Resources::PaperItems
+
+    attr_reader virtual_accounts: ModernTreasury::Resources::VirtualAccounts
+
+    attr_reader bulk_requests: ModernTreasury::Resources::BulkRequests
+
+    attr_reader bulk_results: ModernTreasury::Resources::BulkResults
+
+    attr_reader ledger_account_settlements: ModernTreasury::Resources::LedgerAccountSettlements
+
+    attr_reader foreign_exchange_quotes: ModernTreasury::Resources::ForeignExchangeQuotes
+
+    attr_reader connection_legal_entities: ModernTreasury::Resources::ConnectionLegalEntities
+
+    attr_reader legal_entities: ModernTreasury::Resources::LegalEntities
+
+    attr_reader legal_entity_associations: ModernTreasury::Resources::LegalEntityAssociations
+
+    private def auth_headers: -> ::Hash[String, String]
+
+    def initialize: (
+      base_url: String?,
+      api_key: String?,
+      organization_id: String?,
+      max_retries: Integer,
+      timeout: Float,
+      initial_retry_delay: Float,
+      max_retry_delay: Float,
+      idempotency_header: String
+    ) -> void
+  end
+end

data/sig/modern_treasury/errors.rbs

@@ -0,0 +1,98 @@
+module ModernTreasury
+  class Error < StandardError
+    attr_reader cause: StandardError?
+  end
+
+  class ConversionError < ModernTreasury::Error
+  end
+
+  class APIError < ModernTreasury::Error
+    attr_reader url: URI::Generic
+
+    attr_reader status: Integer?
+
+    attr_reader body: top?
+
+    def initialize: (
+      url: URI::Generic,
+      status: Integer?,
+      body: Object?,
+      request: nil,
+      response: nil,
+      message: String?
+    ) -> void
+  end
+
+  class APIConnectionError < ModernTreasury::APIError
+    def initialize: (
+      url: URI::Generic,
+      status: nil,
+      body: nil,
+      request: nil,
+      response: nil,
+      message: String?
+    ) -> void
+  end
+
+  class APITimeoutError < ModernTreasury::APIConnectionError
+    def initialize: (
+      url: URI::Generic,
+      status: nil,
+      body: nil,
+      request: nil,
+      response: nil,
+      message: String?
+    ) -> void
+  end
+
+  class APIStatusError < ModernTreasury::APIError
+    def self.for: (
+      url: URI::Generic,
+      status: Integer,
+      body: Object?,
+      request: nil,
+      response: nil
+    ) -> instance
+
+    def initialize: (
+      url: URI::Generic,
+      status: Integer,
+      body: Object?,
+      request: nil,
+      response: nil,
+      message: String?
+    ) -> void
+  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: Range[Integer]
+  end
+end

data/sig/modern_treasury/extern.rbs

@@ -0,0 +1,4 @@
+module ModernTreasury
+  module Extern
+  end
+end

data/sig/modern_treasury/models/account_collection_flow.rbs

@@ -0,0 +1,146 @@
+module ModernTreasury
+  module Models
+    type account_collection_flow =
+      {
+        counterparty_id: String,
+        payment_types: ::Array[ModernTreasury::Models::AccountCollectionFlow::payment_type],
+        id: String,
+        client_token: String,
+        created_at: Time,
+        external_account_id: String?,
+        live_mode: bool,
+        object: String,
+        receiving_countries: ::Array[ModernTreasury::Models::AccountCollectionFlow::receiving_country],
+        status: ModernTreasury::Models::AccountCollectionFlow::status,
+        updated_at: Time
+      }
+
+    class AccountCollectionFlow < ModernTreasury::BaseModel
+      attr_accessor counterparty_id: String
+
+      attr_accessor payment_types: ::Array[ModernTreasury::Models::AccountCollectionFlow::payment_type]
+
+      attr_reader id: String?
+
+      def id=: (String) -> String
+
+      attr_reader client_token: String?
+
+      def client_token=: (String) -> String
+
+      attr_reader created_at: Time?
+
+      def created_at=: (Time) -> Time
+
+      attr_accessor external_account_id: String?
+
+      attr_reader live_mode: bool?
+
+      def live_mode=: (bool) -> bool
+
+      attr_reader object: String?
+
+      def object=: (String) -> String
+
+      attr_reader receiving_countries: ::Array[ModernTreasury::Models::AccountCollectionFlow::receiving_country]?
+
+      def receiving_countries=: (
+        ::Array[ModernTreasury::Models::AccountCollectionFlow::receiving_country]
+      ) -> ::Array[ModernTreasury::Models::AccountCollectionFlow::receiving_country]
+
+      attr_reader status: ModernTreasury::Models::AccountCollectionFlow::status?
+
+      def status=: (
+        ModernTreasury::Models::AccountCollectionFlow::status
+      ) -> ModernTreasury::Models::AccountCollectionFlow::status
+
+      attr_reader updated_at: Time?
+
+      def updated_at=: (Time) -> Time
+
+      def initialize:
+        (
+          counterparty_id: String,
+          payment_types: ::Array[ModernTreasury::Models::AccountCollectionFlow::payment_type],
+          id: String,
+          client_token: String,
+          created_at: Time,
+          external_account_id: String?,
+          live_mode: bool,
+          object: String,
+          receiving_countries: ::Array[ModernTreasury::Models::AccountCollectionFlow::receiving_country],
+          status: ModernTreasury::Models::AccountCollectionFlow::status,
+          updated_at: Time
+        ) -> void
+        | (
+          ?ModernTreasury::Models::account_collection_flow
+          | ModernTreasury::BaseModel data
+        ) -> void
+
+      def to_hash: -> ModernTreasury::Models::account_collection_flow
+
+      type payment_type = :ach | :wire
+
+      class PaymentType < ModernTreasury::Enum
+        ACH: :ach
+        WIRE: :wire
+
+        def self.values: -> ::Array[ModernTreasury::Models::AccountCollectionFlow::payment_type]
+      end
+
+      type receiving_country =
+        :USA
+        | :AUS
+        | :BEL
+        | :CAN
+        | :CHL
+        | :CHN
+        | :COL
+        | :FRA
+        | :DEU
+        | :HKG
+        | :IND
+        | :IRL
+        | :ITA
+        | :MEX
+        | :NLD
+        | :PER
+        | :ESP
+        | :GBR
+
+      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
+
+        def self.values: -> ::Array[ModernTreasury::Models::AccountCollectionFlow::receiving_country]
+      end
+
+      type status = :cancelled | :completed | :expired | :pending
+
+      class Status < ModernTreasury::Enum
+        CANCELLED: :cancelled
+        COMPLETED: :completed
+        EXPIRED: :expired
+        PENDING: :pending
+
+        def self.values: -> ::Array[ModernTreasury::Models::AccountCollectionFlow::status]
+      end
+    end
+  end
+end

data/sig/modern_treasury/models/account_collection_flow_create_params.rbs

@@ -0,0 +1,83 @@
+module ModernTreasury
+  module Models
+    type account_collection_flow_create_params =
+      {
+        counterparty_id: String,
+        payment_types: ::Array[String],
+        receiving_countries: ::Array[ModernTreasury::Models::AccountCollectionFlowCreateParams::receiving_country]
+      }
+      & ModernTreasury::request_parameters
+
+    class AccountCollectionFlowCreateParams < ModernTreasury::BaseModel
+      extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      attr_accessor counterparty_id: String
+
+      attr_accessor payment_types: ::Array[String]
+
+      attr_reader receiving_countries: ::Array[ModernTreasury::Models::AccountCollectionFlowCreateParams::receiving_country]?
+
+      def receiving_countries=: (
+        ::Array[ModernTreasury::Models::AccountCollectionFlowCreateParams::receiving_country]
+      ) -> ::Array[ModernTreasury::Models::AccountCollectionFlowCreateParams::receiving_country]
+
+      def initialize:
+        (
+          counterparty_id: String,
+          payment_types: ::Array[String],
+          receiving_countries: ::Array[ModernTreasury::Models::AccountCollectionFlowCreateParams::receiving_country],
+          request_options: ModernTreasury::request_opts
+        ) -> void
+        | (
+          ?ModernTreasury::Models::account_collection_flow_create_params
+          | ModernTreasury::BaseModel data
+        ) -> void
+
+      def to_hash: -> ModernTreasury::Models::account_collection_flow_create_params
+
+      type receiving_country =
+        :USA
+        | :AUS
+        | :BEL
+        | :CAN
+        | :CHL
+        | :CHN
+        | :COL
+        | :FRA
+        | :DEU
+        | :HKG
+        | :IND
+        | :IRL
+        | :ITA
+        | :MEX
+        | :NLD
+        | :PER
+        | :ESP
+        | :GBR
+
+      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
+
+        def self.values: -> ::Array[ModernTreasury::Models::AccountCollectionFlowCreateParams::receiving_country]
+      end
+    end
+  end
+end