modern_treasury 0.1.0.pre.alpha.15 → 0.1.0.pre.alpha.16

data/lib/modern_treasury/base_page.rb

@@ -1,40 +1,59 @@
 # frozen_string_literal: true
 
 module ModernTreasury
-  # @private
+  # @example
+  #   if page.has_next?
+  #     page = page.next_page
+  #   end
   #
-  # @abstract
+  # @example
+  #   page.auto_paging_each do |client|
+  #     puts(client)
+  #   end
   #
+  # @example
+  #   clients =
+  #     page
+  #     .to_enum
+  #     .lazy
+  #     .select { _1.object_id.even? }
+  #     .map(&:itself)
+  #     .take(2)
+  #     .to_a
+  #
+  #   clients => Array
   module BasePage
+    # rubocop:disable Lint/UnusedMethodArgument
+
     # @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
+    # @api private
+    #
+    # @param client [ModernTreasury::BaseClient]
+    # @param req [Hash{Symbol=>Object}]
+    # @param headers [Hash{String=>String}, Net::HTTPHeader]
+    # @param page_data [Object]
+    def initialize(client:, req:, headers:, page_data:)
+      @client = client
+      @req = req
+      super()
+    end
+
+    # rubocop:enable Lint/UnusedMethodArgument
   end
 end

data/lib/modern_treasury/client.rb

@@ -15,11 +15,9 @@ module ModernTreasury
     # 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
 
@@ -134,15 +132,31 @@ module ModernTreasury
     # @return [ModernTreasury::Resources::LegalEntityAssociations]
     attr_reader :legal_entity_associations
 
-    # @private
+    # A test endpoint often used to confirm credentials and headers are being passed
+    #   in correctly.
     #
-    # @return [Hash{String=>String}]
+    # @param params [ModernTreasury::Models::ClientPingParams, Hash{Symbol=>Object}] .
+    #
+    #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+    #
+    # @return [ModernTreasury::Models::PingResponse]
+    def ping(params = {})
+      request(
+        method: :get,
+        path: "api/ping",
+        model: ModernTreasury::Models::PingResponse,
+        options: params[:request_options]
+      )
+    end
+
+    # @api 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}"}
+      {"authorization" => "Basic #{base64_credentials}"}
     end
 
     # Creates and returns a new client for interacting with the API.
@@ -162,7 +176,6 @@ module ModernTreasury
     # @param max_retry_delay [Float]
     #
     # @param idempotency_header [String]
-    #
     def initialize(
       base_url: nil,
       api_key: ENV["MODERN_TREASURY_API_KEY"],
@@ -210,7 +223,8 @@ module ModernTreasury
       @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_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)

data/lib/modern_treasury/errors.rb

@@ -4,7 +4,7 @@ module ModernTreasury
   class Error < StandardError
     # @!parse
     #   # @return [StandardError, nil]
-    #   attr_reader :cause
+    #   attr_accessor :cause
   end
 
   class ConversionError < ModernTreasury::Error
@@ -12,15 +12,15 @@ module ModernTreasury
 
   class APIError < ModernTreasury::Error
     # @return [URI::Generic]
-    attr_reader :url
+    attr_accessor :url
 
     # @return [Integer, nil]
-    attr_reader :status
+    attr_accessor :status
 
     # @return [Object, nil]
-    attr_reader :body
+    attr_accessor :body
 
-    # @private
+    # @api private
     #
     # @param url [URI::Generic]
     # @param status [Integer, nil]
@@ -28,7 +28,6 @@ module ModernTreasury
     # @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
@@ -42,13 +41,13 @@ module ModernTreasury
   class APIConnectionError < ModernTreasury::APIError
     # @!parse
     #   # @return [nil]
-    #   attr_reader :status
+    #   attr_accessor :status
 
     # @!parse
     #   # @return [nil]
-    #   attr_reader :body
+    #   attr_accessor :body
 
-    # @private
+    # @api private
     #
     # @param url [URI::Generic]
     # @param status [nil]
@@ -56,7 +55,6 @@ module ModernTreasury
     # @param request [nil]
     # @param response [nil]
     # @param message [String, nil]
-    #
     def initialize(
       url:,
       status: nil,
@@ -70,7 +68,7 @@ module ModernTreasury
   end
 
   class APITimeoutError < ModernTreasury::APIConnectionError
-    # @private
+    # @api private
     #
     # @param url [URI::Generic]
     # @param status [nil]
@@ -78,7 +76,6 @@ module ModernTreasury
     # @param request [nil]
     # @param response [nil]
     # @param message [String, nil]
-    #
     def initialize(
       url:,
       status: nil,
@@ -92,18 +89,18 @@ module ModernTreasury
   end
 
   class APIStatusError < ModernTreasury::APIError
-    # @private
+    # @api private
     #
     # @param url [URI::Generic]
     # @param status [Integer]
     # @param body [Object, nil]
     # @param request [nil]
     # @param response [nil]
+    # @param message [String, nil]
     #
     # @return [ModernTreasury::APIStatusError]
-    #
-    def self.for(url:, status:, body:, request:, response:)
-      kwargs = {url: url, status: status, body: body, request: request, response: response}
+    def self.for(url:, status:, body:, request:, response:, message: nil)
+      kwargs = {url: url, status: status, body: body, request: request, response: response, message: message}
 
       case status
       in 400
@@ -129,9 +126,9 @@ module ModernTreasury
 
     # @!parse
     #   # @return [Integer]
-    #   attr_reader :status
+    #   attr_accessor :status
 
-    # @private
+    # @api private
     #
     # @param url [URI::Generic]
     # @param status [Integer]
@@ -139,7 +136,6 @@ module ModernTreasury
     # @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(

data/lib/modern_treasury/extern.rb

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

data/lib/modern_treasury/models/account_collection_flow.rb

@@ -133,20 +133,10 @@ module ModernTreasury
 
       # 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
+      module PaymentType
+        extend ModernTreasury::Enum
+
         ACH = :ach
         WIRE = :wire
 
@@ -154,33 +144,14 @@ module ModernTreasury
 
         # @!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
+      module ReceivingCountry
+        extend ModernTreasury::Enum
+
         USA = :USA
         AUS = :AUS
         BEL = :BEL
@@ -204,29 +175,14 @@ module ModernTreasury
 
         # @!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
+      module Status
+        extend ModernTreasury::Enum
+
         CANCELLED = :cancelled
         COMPLETED = :completed
         EXPIRED = :expired
@@ -236,7 +192,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/account_collection_flow_create_params.rb

@@ -38,28 +38,10 @@ module ModernTreasury
 
       # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-      # @abstract
-      #
       # Optional. Array of 3-digit ISO country codes.
-      #
-      # @example
-      # ```ruby
-      # case receiving_country
-      # in :USA
-      #   # ...
-      # in :AUS
-      #   # ...
-      # in :BEL
-      #   # ...
-      # in :CAN
-      #   # ...
-      # in :CHL
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class ReceivingCountry < ModernTreasury::Enum
+      module ReceivingCountry
+        extend ModernTreasury::Enum
+
         USA = :USA
         AUS = :AUS
         BEL = :BEL
@@ -83,7 +65,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/account_collection_flow_update_params.rb

@@ -22,26 +22,17 @@ module ModernTreasury
 
       # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-      # @abstract
-      #
       # Required. The updated status of the account collection flow. Can only be used to
       #   mark a flow as `cancelled`.
-      #
-      # @example
-      # ```ruby
-      # case status
-      # in :cancelled
-      #   # ...
-      # end
-      # ```
-      class Status < ModernTreasury::Enum
+      module Status
+        extend ModernTreasury::Enum
+
         CANCELLED = :cancelled
 
         finalize!
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/account_detail.rb

@@ -86,29 +86,11 @@ module ModernTreasury
 
       # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-      # @abstract
-      #
       # One of `iban`, `clabe`, `wallet_address`, or `other`. Use `other` if the bank
       #   account number is in a generic format.
-      #
-      # @example
-      # ```ruby
-      # case account_number_type
-      # in :au_number
-      #   # ...
-      # in :clabe
-      #   # ...
-      # in :hk_number
-      #   # ...
-      # in :iban
-      #   # ...
-      # in :id_number
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class AccountNumberType < ModernTreasury::Enum
+      module AccountNumberType
+        extend ModernTreasury::Enum
+
         AU_NUMBER = :au_number
         CLABE = :clabe
         HK_NUMBER = :hk_number
@@ -124,7 +106,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/account_detail_create_params.rb

@@ -40,49 +40,23 @@ module ModernTreasury
 
       # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-      # @abstract
-      #
-      # @example
-      # ```ruby
-      # case accounts_type
-      # in :external_accounts
-      #   # ...
-      # end
-      # ```
-      class AccountsType < ModernTreasury::Enum
+      module AccountsType
+        extend ModernTreasury::Enum
+
         EXTERNAL_ACCOUNTS = :external_accounts
 
         finalize!
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # One of `iban`, `clabe`, `wallet_address`, or `other`. Use `other` if the bank
       #   account number is in a generic format.
-      #
-      # @example
-      # ```ruby
-      # case account_number_type
-      # in :au_number
-      #   # ...
-      # in :clabe
-      #   # ...
-      # in :hk_number
-      #   # ...
-      # in :iban
-      #   # ...
-      # in :id_number
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class AccountNumberType < ModernTreasury::Enum
+      module AccountNumberType
+        extend ModernTreasury::Enum
+
         AU_NUMBER = :au_number
         CLABE = :clabe
         HK_NUMBER = :hk_number
@@ -98,7 +72,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/account_detail_delete_params.rb

@@ -26,23 +26,15 @@ module ModernTreasury
 
       # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-      # @abstract
-      #
-      # @example
-      # ```ruby
-      # case accounts_type
-      # in :external_accounts
-      #   # ...
-      # end
-      # ```
-      class AccountsType < ModernTreasury::Enum
+      module AccountsType
+        extend ModernTreasury::Enum
+
         EXTERNAL_ACCOUNTS = :external_accounts
 
         finalize!
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/accounts_type.rb

@@ -2,18 +2,9 @@
 
 module ModernTreasury
   module Models
-    # @abstract
-    #
-    # @example
-    # ```ruby
-    # case accounts_type
-    # in :external_accounts
-    #   # ...
-    # in :internal_accounts
-    #   # ...
-    # end
-    # ```
-    class AccountsType < ModernTreasury::Enum
+    module AccountsType
+      extend ModernTreasury::Enum
+
       EXTERNAL_ACCOUNTS = :external_accounts
       INTERNAL_ACCOUNTS = :internal_accounts
 
@@ -21,7 +12,6 @@ module ModernTreasury
 
       # @!parse
       #   # @return [Array<Symbol>]
-      #   #
       #   def self.values; end
     end
   end

data/lib/modern_treasury/models/bulk_request.rb

@@ -109,22 +109,10 @@ module ModernTreasury
 
       # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-      # @abstract
-      #
       # One of create, or update.
-      #
-      # @example
-      # ```ruby
-      # case action_type
-      # in :create
-      #   # ...
-      # in :update
-      #   # ...
-      # in :delete
-      #   # ...
-      # end
-      # ```
-      class ActionType < ModernTreasury::Enum
+      module ActionType
+        extend ModernTreasury::Enum
+
         CREATE = :create
         UPDATE = :update
         DELETE = :delete
@@ -133,28 +121,13 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # One of payment_order, expected_payment, or ledger_transaction.
-      #
-      # @example
-      # ```ruby
-      # case resource_type
-      # in :payment_order
-      #   # ...
-      # in :ledger_transaction
-      #   # ...
-      # in :transaction
-      #   # ...
-      # in :expected_payment
-      #   # ...
-      # end
-      # ```
-      class ResourceType < ModernTreasury::Enum
+      module ResourceType
+        extend ModernTreasury::Enum
+
         PAYMENT_ORDER = :payment_order
         LEDGER_TRANSACTION = :ledger_transaction
         TRANSACTION = :transaction
@@ -164,26 +137,13 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # One of pending, processing, or completed.
-      #
-      # @example
-      # ```ruby
-      # case status
-      # in :pending
-      #   # ...
-      # in :processing
-      #   # ...
-      # in :completed
-      #   # ...
-      # end
-      # ```
-      class Status < ModernTreasury::Enum
+      module Status
+        extend ModernTreasury::Enum
+
         PENDING = :pending
         PROCESSING = :processing
         COMPLETED = :completed
@@ -192,7 +152,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end