modern_treasury 0.0.0 → 0.1.0.pre.alpha.15

data/lib/modern_treasury/request_options.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  # @private
+  #
+  # @abstract
+  #
+  module RequestParameters
+    # @!parse
+    #   # Options to specify HTTP behaviour for this request.
+    #   # @return [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+    #   attr_accessor :request_options
+
+    # @param mod [Module]
+    #
+    def self.included(mod)
+      return unless mod <= ModernTreasury::BaseModel
+
+      mod.extend(ModernTreasury::RequestParameters::Converter)
+      mod.optional(:request_options, ModernTreasury::RequestOptions)
+    end
+
+    # @private
+    #
+    module Converter
+      # @private
+      #
+      # @param params [Object]
+      #
+      # @return [Array(Object, Hash{Symbol=>Object})]
+      #
+      def dump_request(params)
+        case (dumped = dump(params))
+        in Hash
+          [dumped.except(:request_options), dumped[:request_options]]
+        else
+          [dumped, nil]
+        end
+      end
+    end
+  end
+
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  #   or override those provided at the client level.
+  #
+  #   When making a request, you can pass an actual {RequestOptions} instance, or
+  #   simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < ModernTreasury::BaseModel
+    # @private
+    #
+    # @param opts [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+    #
+    # @raise [ArgumentError]
+    #
+    def self.validate!(opts)
+      case opts
+      in ModernTreasury::RequestOptions | Hash
+        opts.to_h.each_key do |k|
+          unless fields.include?(k)
+            raise ArgumentError.new("Request `opts` keys must be one of #{fields.keys}, got #{k.inspect}")
+          end
+        end
+      else
+        raise ArgumentError.new("Request `opts` must be a Hash or RequestOptions, got #{opts.inspect}")
+      end
+    end
+
+    # @!attribute idempotency_key
+    #   Idempotency key to send with request and all associated retries. Will only be
+    #     sent for write requests.
+    #
+    #   @return [String, nil]
+    optional :idempotency_key, String
+
+    # @!attribute extra_query
+    #   Extra query params to send with the request. These are `.merge`’d into any
+    #     `query` given at the client level.
+    #
+    #   @return [Hash{String=>Array<String>, String, nil}, nil]
+    optional :extra_query, ModernTreasury::HashOf[ModernTreasury::ArrayOf[String]]
+
+    # @!attribute extra_headers
+    #   Extra headers to send with the request. These are `.merged`’d into any
+    #     `extra_headers` given at the client level.
+    #
+    #   @return [Hash{String=>String, nil}, nil]
+    optional :extra_headers, ModernTreasury::HashOf[String, nil?: true]
+
+    # @!attribute extra_body
+    #   Extra data to send with the request. These are deep merged into any data
+    #     generated as part of the normal request.
+    #
+    #   @return [Hash{Symbol=>Object}, nil]
+    optional :extra_body, ModernTreasury::HashOf[ModernTreasury::Unknown]
+
+    # @!attribute max_retries
+    #   Maximum number of retries to attempt after a failed initial request.
+    #
+    #   @return [Integer, nil]
+    optional :max_retries, Integer
+
+    # @!attribute timeout
+    #   Request timeout in seconds.
+    #
+    #   @return [Float, nil]
+    optional :timeout, Float
+
+    # @!parse
+    #   # Returns a new instance of RequestOptions.
+    #   #
+    #   # @param values [Hash{Symbol=>Object}]
+    #   #
+    #   def initialize(values = {}) = super
+  end
+end

data/lib/modern_treasury/resources/account_collection_flows.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Resources
+    class AccountCollectionFlows
+      # create account_collection_flow
+      #
+      # @param params [ModernTreasury::Models::AccountCollectionFlowCreateParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [String] :counterparty_id Required.
+      #
+      #   @option params [Array<String>] :payment_types
+      #
+      #   @option params [Array<Symbol, ModernTreasury::Models::AccountCollectionFlowCreateParams::ReceivingCountry>] :receiving_countries
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::AccountCollectionFlow]
+      #
+      def create(params)
+        parsed, options = ModernTreasury::Models::AccountCollectionFlowCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "api/account_collection_flows",
+          body: parsed,
+          model: ModernTreasury::Models::AccountCollectionFlow,
+          options: options
+        )
+      end
+
+      # get account_collection_flow
+      #
+      # @param id [String] id
+      #
+      # @param params [ModernTreasury::Models::AccountCollectionFlowRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::AccountCollectionFlow]
+      #
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["api/account_collection_flows/%0s", id],
+          model: ModernTreasury::Models::AccountCollectionFlow,
+          options: params[:request_options]
+        )
+      end
+
+      # update account_collection_flow
+      #
+      # @param id [String] id
+      #
+      # @param params [ModernTreasury::Models::AccountCollectionFlowUpdateParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Symbol, ModernTreasury::Models::AccountCollectionFlowUpdateParams::Status] :status Required. The updated status of the account collection flow. Can only be used to
+      #     mark a flow as `cancelled`.
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::AccountCollectionFlow]
+      #
+      def update(id, params)
+        parsed, options = ModernTreasury::Models::AccountCollectionFlowUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["api/account_collection_flows/%0s", id],
+          body: parsed,
+          model: ModernTreasury::Models::AccountCollectionFlow,
+          options: options
+        )
+      end
+
+      # list account_collection_flows
+      #
+      # @param params [ModernTreasury::Models::AccountCollectionFlowListParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [String, nil] :after_cursor
+      #
+      #   @option params [String] :client_token
+      #
+      #   @option params [String] :counterparty_id
+      #
+      #   @option params [String] :external_account_id
+      #
+      #   @option params [Integer] :per_page
+      #
+      #   @option params [String] :status
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Page<ModernTreasury::Models::AccountCollectionFlow>]
+      #
+      def list(params = {})
+        parsed, options = ModernTreasury::Models::AccountCollectionFlowListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "api/account_collection_flows",
+          query: parsed,
+          page: ModernTreasury::Page,
+          model: ModernTreasury::Models::AccountCollectionFlow,
+          options: options
+        )
+      end
+
+      # @param client [ModernTreasury::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/modern_treasury/resources/account_details.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Resources
+    class AccountDetails
+      # Create an account detail for an external account.
+      #
+      # @param account_id [String] Path param: The ID of the account.
+      #
+      # @param params [ModernTreasury::Models::AccountDetailCreateParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Symbol, ModernTreasury::Models::AccountDetailCreateParams::AccountsType] :accounts_type Path param:
+      #
+      #   @option params [String] :account_number Body param: The account number for the bank account.
+      #
+      #   @option params [Symbol, ModernTreasury::Models::AccountDetailCreateParams::AccountNumberType] :account_number_type Body param: One of `iban`, `clabe`, `wallet_address`, or `other`. Use `other` if
+      #     the bank account number is in a generic format.
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::AccountDetail]
+      #
+      def create(account_id, params)
+        parsed, options = ModernTreasury::Models::AccountDetailCreateParams.dump_request(params)
+        accounts_type = parsed.fetch(:accounts_type) do
+          raise ArgumentError.new("missing required path argument #{_1}")
+        end
+        @client.request(
+          method: :post,
+          path: ["api/%0s/%1s/account_details", accounts_type, account_id],
+          body: parsed.except(:accounts_type),
+          model: ModernTreasury::Models::AccountDetail,
+          options: options
+        )
+      end
+
+      # Get a single account detail for a single internal or external account.
+      #
+      # @param id [String] The ID of the account detail.
+      #
+      # @param params [ModernTreasury::Models::AccountDetailRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Symbol, ModernTreasury::Models::AccountsType] :accounts_type
+      #
+      #   @option params [String] :account_id The ID of the account.
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::AccountDetail]
+      #
+      def retrieve(id, params)
+        parsed, options = ModernTreasury::Models::AccountDetailRetrieveParams.dump_request(params)
+        accounts_type = parsed.fetch(:accounts_type) do
+          raise ArgumentError.new("missing required path argument #{_1}")
+        end
+        account_id = parsed.fetch(:account_id) do
+          raise ArgumentError.new("missing required path argument #{_1}")
+        end
+        @client.request(
+          method: :get,
+          path: ["api/%0s/%1s/account_details/%2s", accounts_type, account_id, id],
+          model: ModernTreasury::Models::AccountDetail,
+          options: options
+        )
+      end
+
+      # Get a list of account details for a single internal or external account.
+      #
+      # @param account_id [String] Path param: The ID of the account.
+      #
+      # @param params [ModernTreasury::Models::AccountDetailListParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Symbol, ModernTreasury::Models::AccountsType] :accounts_type Path param:
+      #
+      #   @option params [String, nil] :after_cursor Query param:
+      #
+      #   @option params [Integer] :per_page Query param:
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Page<ModernTreasury::Models::AccountDetail>]
+      #
+      def list(account_id, params)
+        parsed, options = ModernTreasury::Models::AccountDetailListParams.dump_request(params)
+        accounts_type = parsed.fetch(:accounts_type) do
+          raise ArgumentError.new("missing required path argument #{_1}")
+        end
+        @client.request(
+          method: :get,
+          path: ["api/%0s/%1s/account_details", accounts_type, account_id],
+          query: parsed.except(:accounts_type),
+          page: ModernTreasury::Page,
+          model: ModernTreasury::Models::AccountDetail,
+          options: options
+        )
+      end
+
+      # Delete a single account detail for an external account.
+      #
+      # @param id [String] The ID of the account detail.
+      #
+      # @param params [ModernTreasury::Models::AccountDetailDeleteParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Symbol, ModernTreasury::Models::AccountDetailDeleteParams::AccountsType] :accounts_type
+      #
+      #   @option params [String] :account_id The ID of the account.
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [nil]
+      #
+      def delete(id, params)
+        parsed, options = ModernTreasury::Models::AccountDetailDeleteParams.dump_request(params)
+        accounts_type = parsed.fetch(:accounts_type) do
+          raise ArgumentError.new("missing required path argument #{_1}")
+        end
+        account_id = parsed.fetch(:account_id) do
+          raise ArgumentError.new("missing required path argument #{_1}")
+        end
+        @client.request(
+          method: :delete,
+          path: ["api/%0s/%1s/account_details/%2s", accounts_type, account_id, id],
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # @param client [ModernTreasury::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/modern_treasury/resources/bulk_requests.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Resources
+    class BulkRequests
+      # create bulk_request
+      #
+      # @param params [ModernTreasury::Models::BulkRequestCreateParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Symbol, ModernTreasury::Models::BulkRequestCreateParams::ActionType] :action_type One of create, or update.
+      #
+      #   @option params [Symbol, ModernTreasury::Models::BulkRequestCreateParams::ResourceType] :resource_type One of payment_order, expected_payment, or ledger_transaction.
+      #
+      #   @option params [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ID, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID>] :resources An array of objects where each object contains the input params for a single
+      #     `action_type` request on a `resource_type` resource
+      #
+      #   @option params [Hash{Symbol=>String}] :metadata Additional data represented as key-value pairs. Both the key and value must be
+      #     strings.
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::BulkRequest]
+      #
+      def create(params)
+        parsed, options = ModernTreasury::Models::BulkRequestCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "api/bulk_requests",
+          body: parsed,
+          model: ModernTreasury::Models::BulkRequest,
+          options: options
+        )
+      end
+
+      # get bulk_request
+      #
+      # @param id [String] id
+      #
+      # @param params [ModernTreasury::Models::BulkRequestRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::BulkRequest]
+      #
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["api/bulk_requests/%0s", id],
+          model: ModernTreasury::Models::BulkRequest,
+          options: params[:request_options]
+        )
+      end
+
+      # list bulk_requests
+      #
+      # @param params [ModernTreasury::Models::BulkRequestListParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Symbol, ModernTreasury::Models::BulkRequestListParams::ActionType] :action_type One of create, or update.
+      #
+      #   @option params [String, nil] :after_cursor
+      #
+      #   @option params [Hash{Symbol=>String}] :metadata For example, if you want to query for records with metadata key `Type` and value
+      #     `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
+      #     parameters.
+      #
+      #   @option params [Integer] :per_page
+      #
+      #   @option params [Symbol, ModernTreasury::Models::BulkRequestListParams::ResourceType] :resource_type One of payment_order, expected_payment, or ledger_transaction.
+      #
+      #   @option params [Symbol, ModernTreasury::Models::BulkRequestListParams::Status] :status One of pending, processing, or completed.
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Page<ModernTreasury::Models::BulkRequest>]
+      #
+      def list(params = {})
+        parsed, options = ModernTreasury::Models::BulkRequestListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "api/bulk_requests",
+          query: parsed,
+          page: ModernTreasury::Page,
+          model: ModernTreasury::Models::BulkRequest,
+          options: options
+        )
+      end
+
+      # @param client [ModernTreasury::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/modern_treasury/resources/bulk_results.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Resources
+    class BulkResults
+      # get bulk_result
+      #
+      # @param id [String] id
+      #
+      # @param params [ModernTreasury::Models::BulkResultRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::BulkResult]
+      #
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["api/bulk_results/%0s", id],
+          model: ModernTreasury::Models::BulkResult,
+          options: params[:request_options]
+        )
+      end
+
+      # list bulk_results
+      #
+      # @param params [ModernTreasury::Models::BulkResultListParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [String, nil] :after_cursor
+      #
+      #   @option params [String] :entity_id Unique identifier for the result entity object.
+      #
+      #   @option params [Symbol, ModernTreasury::Models::BulkResultListParams::EntityType] :entity_type The type of the request that created this result. bulk_request is the only
+      #     supported `request_type`
+      #
+      #   @option params [Integer] :per_page
+      #
+      #   @option params [String] :request_id Unique identifier for the request that created this bulk result. This is the ID
+      #     of the bulk request when `request_type` is bulk_request
+      #
+      #   @option params [Symbol, ModernTreasury::Models::BulkResultListParams::RequestType] :request_type The type of the request that created this result. bulk_request is the only
+      #     supported `request_type`
+      #
+      #   @option params [Symbol, ModernTreasury::Models::BulkResultListParams::Status] :status One of successful or failed.
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Page<ModernTreasury::Models::BulkResult>]
+      #
+      def list(params = {})
+        parsed, options = ModernTreasury::Models::BulkResultListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "api/bulk_results",
+          query: parsed,
+          page: ModernTreasury::Page,
+          model: ModernTreasury::Models::BulkResult,
+          options: options
+        )
+      end
+
+      # @param client [ModernTreasury::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/modern_treasury/resources/connection_legal_entities.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Resources
+    class ConnectionLegalEntities
+      # Create a connection legal entity.
+      #
+      # @param params [ModernTreasury::Models::ConnectionLegalEntityCreateParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [String] :connection_id The ID of the connection.
+      #
+      #   @option params [ModernTreasury::Models::ConnectionLegalEntityCreateParams::LegalEntity] :legal_entity The legal entity.
+      #
+      #   @option params [String] :legal_entity_id The ID of the legal entity.
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::ConnectionLegalEntity]
+      #
+      def create(params)
+        parsed, options = ModernTreasury::Models::ConnectionLegalEntityCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "api/connection_legal_entities",
+          body: parsed,
+          model: ModernTreasury::Models::ConnectionLegalEntity,
+          options: options
+        )
+      end
+
+      # Get details on a single connection legal entity.
+      #
+      # @param id [String] The id of an existing connection legal entity.
+      #
+      # @param params [ModernTreasury::Models::ConnectionLegalEntityRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::ConnectionLegalEntity]
+      #
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["api/connection_legal_entities/%0s", id],
+          model: ModernTreasury::Models::ConnectionLegalEntity,
+          options: params[:request_options]
+        )
+      end
+
+      # Update a connection legal entity.
+      #
+      # @param id [String] The id of an existing connection legal entity.
+      #
+      # @param params [ModernTreasury::Models::ConnectionLegalEntityUpdateParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Symbol, ModernTreasury::Models::ConnectionLegalEntityUpdateParams::Status] :status The status of the connection legal entity.
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::ConnectionLegalEntity]
+      #
+      def update(id, params = {})
+        parsed, options = ModernTreasury::Models::ConnectionLegalEntityUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["api/connection_legal_entities/%0s", id],
+          body: parsed,
+          model: ModernTreasury::Models::ConnectionLegalEntity,
+          options: options
+        )
+      end
+
+      # Get a list of all connection legal entities.
+      #
+      # @param params [ModernTreasury::Models::ConnectionLegalEntityListParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [String, nil] :after_cursor
+      #
+      #   @option params [String] :connection_id
+      #
+      #   @option params [String] :legal_entity_id
+      #
+      #   @option params [Integer] :per_page
+      #
+      #   @option params [Symbol, ModernTreasury::Models::ConnectionLegalEntityListParams::Status] :status
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Page<ModernTreasury::Models::ConnectionLegalEntity>]
+      #
+      def list(params = {})
+        parsed, options = ModernTreasury::Models::ConnectionLegalEntityListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "api/connection_legal_entities",
+          query: parsed,
+          page: ModernTreasury::Page,
+          model: ModernTreasury::Models::ConnectionLegalEntity,
+          options: options
+        )
+      end
+
+      # @param client [ModernTreasury::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/modern_treasury/resources/connections.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Resources
+    class Connections
+      # Get a list of all connections.
+      #
+      # @param params [ModernTreasury::Models::ConnectionListParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [String, nil] :after_cursor
+      #
+      #   @option params [String] :entity A string code representing the vendor (i.e. bank).
+      #
+      #   @option params [Integer] :per_page
+      #
+      #   @option params [String] :vendor_customer_id An identifier assigned by the vendor to your organization.
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Page<ModernTreasury::Models::Connection>]
+      #
+      def list(params = {})
+        parsed, options = ModernTreasury::Models::ConnectionListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "api/connections",
+          query: parsed,
+          page: ModernTreasury::Page,
+          model: ModernTreasury::Models::Connection,
+          options: options
+        )
+      end
+
+      # @param client [ModernTreasury::Client]
+      #
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end