modern_treasury 0.1.0.pre.alpha.16 → 0.1.0.pre.alpha.18

data/README.md

@@ -1,32 +1,24 @@
 # Modern Treasury Ruby API library
 
-The Modern Treasury Ruby library provides convenient access to the Modern Treasury REST API from any Ruby 3.0.0+ application.
+The Modern Treasury Ruby library provides convenient access to the Modern Treasury REST API from any Ruby 3.1.0+ application.
 
 ## Documentation
 
-Documentation for released of this gem can be found [on RubyDoc](https://gemdocs.org/gems/modern_treasury).
+Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/modern_treasury).
 
-The underlying REST API documentation can be found on [docs.moderntreasury.com](https://docs.moderntreasury.com).
+The REST API documentation can be found on [docs.moderntreasury.com](https://docs.moderntreasury.com).
 
 ## Installation
 
-To use this gem during the beta, install directly from GitHub with Bundler by adding the following to your application's `Gemfile`:
+To use this gem, install via Bundler by adding the following to your application's `Gemfile`:
 
-```ruby
-gem "modern_treasury", git: "https://github.com/Modern-Treasury/modern-treasury-ruby", branch: "main"
-```
-
-To fetch an initial copy of the gem:
+<!-- x-release-please-start-version -->
 
-```sh
-bundle install
+```ruby
+gem "modern_treasury", "~> 0.1.0.pre.alpha.18"
 ```
 
-To update the version used by your application when updates are pushed to GitHub:
-
-```sh
-bundle update modern_treasury
-```
+<!-- x-release-please-end -->
 
 ## Usage
 
@@ -63,14 +55,39 @@ page.auto_paging_each do |counterparty|
 end
 ```
 
+### File uploads
+
+Request parameters that correspond to file uploads can be passed as `StringIO`, or a [`Pathname`](https://rubyapi.org/3.1/o/pathname) instance.
+
+```ruby
+require "pathname"
+
+# using `Pathname`, the file will be lazily read, without reading everything in to memory
+document = modern_treasury.documents.create(
+  documentable_id: "24c6b7a3-02...",
+  documentable_type: "counterparties",
+  file: Pathname("my/file.txt")
+)
+
+file = File.read("my/file.txt")
+# using `StringIO`, useful if you already have the data in memory
+document = modern_treasury.documents.create(
+  documentable_id: "24c6b7a3-02...",
+  documentable_type: "counterparties",
+  file: StringIO.new(file)
+)
+
+puts(document.id)
+```
+
 ### Errors
 
-When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `ModernTreasury::Error` will be thrown:
+When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `ModernTreasury::Errors::APIError` will be thrown:
 
 ```ruby
 begin
   external_account = modern_treasury.external_accounts.create(counterparty_id: "missing")
-rescue ModernTreasury::Error => e
+rescue ModernTreasury::Errors::APIError => e
   puts(e.status) # 400
 end
 ```
@@ -86,7 +103,7 @@ Error codes are as followed:
 | HTTP 409         | `ConflictError`            |
 | HTTP 422         | `UnprocessableEntityError` |
 | HTTP 429         | `RateLimitError`           |
-| HTTP >=500       | `InternalServerError`      |
+| HTTP >= 500      | `InternalServerError`      |
 | Other HTTP error | `APIStatusError`           |
 | Timeout          | `APITimeoutError`          |
 | Network error    | `APIConnectionError`       |
@@ -127,9 +144,32 @@ modern_treasury = ModernTreasury::Client.new(
 modern_treasury.counterparties.create(name: "my first counterparty", request_options: {timeout: 5})
 ```
 
-## Sorbet Support
+## LSP Support
+
+### Solargraph
+
+This library includes [Solargraph](https://solargraph.org) support for both auto completion and go to definition.
+
+```ruby
+gem "solargraph", group: :development
+```
+
+After Solargraph is installed, **you must populate its index** either via the provided editor command, or by running the following in your terminal:
+
+```sh
+bundle exec solargraph gems
+```
 
-**This library emits an intentional warning under the [`tapioca` toolchain](https://github.com/Shopify/tapioca)**. This is normal, and does not impact functionality.
+Note: if you had installed the gem either using a `git:` or `github:` URL, or had vendored the gem using bundler, you will need to set up your [`.solargraph.yml`](https://solargraph.org/guides/configuration) to include the path to the gem's `lib` directory.
+
+```yaml
+include:
+  - 'vendor/bundle/ruby/*/gems/modern_treasury-*/lib/**/*.rb'
+```
+
+Otherwise Solargraph will not be able to provide type information or auto-completion for any non-indexed libraries.
+
+### Sorbet
 
 This library is written with [Sorbet type definitions](https://sorbet.org/docs/rbi). However, there is no runtime dependency on the `sorbet-runtime`.
 
@@ -140,13 +180,43 @@ Due to limitations with the Sorbet type system, where a method otherwise can tak
 Please follow Sorbet's [setup guides](https://sorbet.org/docs/adopting) for best experience.
 
 ```ruby
-model = CounterpartyCreateParams.new(name: "my first counterparty")
+params = ModernTreasury::Models::CounterpartyCreateParams.new(name: "my first counterparty")
 
-modern_treasury.counterparties.create(**model)
+modern_treasury.counterparties.create(**params)
 ```
 
+Note: **This library emits an intentional warning under the [`tapioca` toolchain](https://github.com/Shopify/tapioca)**. This is normal, and does not impact functionality.
+
+### Ruby LSP
+
+The Ruby LSP has [best effort support](https://shopify.github.io/ruby-lsp/#guessed-types) for inferring type information from Ruby code, and as such it may not always be able to provide accurate type information.
+
 ## Advanced
 
+### Making custom/undocumented requests
+
+This library is typed for convenient access to the documented API.
+
+If you need to access undocumented endpoints, params, or response properties, the library can still be used.
+
+#### Undocumented request params
+
+If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a requests as seen in examples above.
+
+#### Undocumented endpoints
+
+To make requests to undocumented endpoints, you can make requests using `client.request`. Options on the client will be respected (such as retries) when making this request.
+
+```ruby
+response = client.request(
+    method: :post,
+    path: '/undocumented/endpoint',
+    query: {"dog": "woof"},
+    headers: {"useful-header": "interesting-value"},
+    body: {"he": "llo"},
+  )
+```
+
 ### Concurrency & Connection Pooling
 
 The `ModernTreasury::Client` instances are thread-safe, and should be re-used across multiple threads. By default, each `Client` have their own HTTP connection pool, with a maximum number of connections equal to thread count.
@@ -165,4 +235,4 @@ This package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` typ
 
 ## Requirements
 
-Ruby 3.0.0 or higher.
+Ruby 3.1.0 or higher.

data/SECURITY.md

@@ -0,0 +1,27 @@
+# Security Policy
+
+## Reporting Security Issues
+
+This SDK is generated by [Stainless Software Inc](http://stainless.com). Stainless takes security seriously, and encourages you to report any security vulnerability promptly so that appropriate action can be taken.
+
+To report a security issue, please contact the Stainless team at security@stainless.com.
+
+## Responsible Disclosure
+
+We appreciate the efforts of security researchers and individuals who help us maintain the security of
+SDKs we generate. If you believe you have found a security vulnerability, please adhere to responsible
+disclosure practices by allowing us a reasonable amount of time to investigate and address the issue
+before making any information public.
+
+## Reporting Non-SDK Related Security Issues
+
+If you encounter security issues that are not directly related to SDKs but pertain to the services
+or products provided by Modern Treasury please follow the respective company's security reporting guidelines.
+
+### Modern Treasury Terms and Policies
+
+Please contact sdk-feedback@moderntreasury.com for any questions or concerns regarding security of our services.
+
+---
+
+Thank you for helping us keep the SDKs and systems they interact with secure.

data/lib/modern_treasury/client.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module ModernTreasury
-  class Client < ModernTreasury::BaseClient
+  class Client < ModernTreasury::Internal::Transport::BaseClient
     # Default max number of retries to attempt after a failed retryable request.
     DEFAULT_MAX_RETRIES = 2
 
@@ -133,13 +133,15 @@ module ModernTreasury
     attr_reader :legal_entity_associations
 
     # A test endpoint often used to confirm credentials and headers are being passed
-    #   in correctly.
+    # in correctly.
     #
-    # @param params [ModernTreasury::Models::ClientPingParams, Hash{Symbol=>Object}] .
+    # @overload ping(request_options: {})
     #
-    #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+    # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
     #
     # @return [ModernTreasury::Models::PingResponse]
+    #
+    # @see ModernTreasury::Models::ClientPingParams
     def ping(params = {})
       request(
         method: :get,
@@ -161,12 +163,13 @@ module ModernTreasury
 
     # 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 base_url [String, nil] Override the default base URL for the API, e.g.,
+    # `"https://api.example.com/v2/"`. Defaults to `ENV["MODERN_TREASURY_BASE_URL"]`
+    #
     # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request.
     #
     # @param timeout [Float]
@@ -177,9 +180,9 @@ module ModernTreasury
     #
     # @param idempotency_header [String]
     def initialize(
-      base_url: nil,
       api_key: ENV["MODERN_TREASURY_API_KEY"],
       organization_id: ENV["MODERN_TREASURY_ORGANIZATION_ID"],
+      base_url: ENV["MODERN_TREASURY_BASE_URL"],
       max_retries: DEFAULT_MAX_RETRIES,
       timeout: DEFAULT_TIMEOUT_IN_SECONDS,
       initial_retry_delay: DEFAULT_INITIAL_RETRY_DELAY,
@@ -189,10 +192,10 @@ module ModernTreasury
       base_url ||= "https://app.moderntreasury.com"
 
       if api_key.nil?
-        raise ArgumentError.new("api_key is required")
+        raise ArgumentError.new("api_key is required, and can be set via environ: \"MODERN_TREASURY_API_KEY\"")
       end
       if organization_id.nil?
-        raise ArgumentError.new("organization_id is required")
+        raise ArgumentError.new("organization_id is required, and can be set via environ: \"MODERN_TREASURY_ORGANIZATION_ID\"")
       end
 
       @api_key = api_key.to_s

data/lib/modern_treasury/errors.rb

@@ -1,183 +1,192 @@
 # frozen_string_literal: true
 
 module ModernTreasury
-  class Error < StandardError
-    # @!parse
-    #   # @return [StandardError, nil]
-    #   attr_accessor :cause
-  end
-
-  class ConversionError < ModernTreasury::Error
-  end
-
-  class APIError < ModernTreasury::Error
-    # @return [URI::Generic]
-    attr_accessor :url
-
-    # @return [Integer, nil]
-    attr_accessor :status
-
-    # @return [Object, nil]
-    attr_accessor :body
-
-    # @api 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)
+  module Errors
+    class Error < StandardError
+      # @!parse
+      #   # @return [StandardError, nil]
+      #   attr_accessor :cause
     end
-  end
 
-  class APIConnectionError < ModernTreasury::APIError
-    # @!parse
-    #   # @return [nil]
-    #   attr_accessor :status
-
-    # @!parse
-    #   # @return [nil]
-    #   attr_accessor :body
-
-    # @api 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
+    class ConversionError < ModernTreasury::Errors::Error
     end
-  end
 
-  class APITimeoutError < ModernTreasury::APIConnectionError
-    # @api 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
+    class APIError < ModernTreasury::Errors::Error
+      # @return [URI::Generic]
+      attr_accessor :url
+
+      # @return [Integer, nil]
+      attr_accessor :status
+
+      # @return [Object, nil]
+      attr_accessor :body
+
+      # @api 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
-  end
 
-  class APIStatusError < ModernTreasury::APIError
-    # @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:, message: nil)
-      kwargs = {url: url, status: status, body: body, request: request, response: response, message: message}
-
-      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)
+    class APIConnectionError < ModernTreasury::Errors::APIError
+      # @!parse
+      #   # @return [nil]
+      #   attr_accessor :status
+
+      # @!parse
+      #   # @return [nil]
+      #   attr_accessor :body
+
+      # @api 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
 
-    # @!parse
-    #   # @return [Integer]
-    #   attr_accessor :status
-
-    # @api 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
+    class APITimeoutError < ModernTreasury::Errors::APIConnectionError
+      # @api 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
-  end
 
-  class BadRequestError < ModernTreasury::APIStatusError
-    HTTP_STATUS = 400
-  end
+    class APIStatusError < ModernTreasury::Errors::APIError
+      # @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::Errors::APIStatusError]
+      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
+          ModernTreasury::Errors::BadRequestError.new(**kwargs)
+        in 401
+          ModernTreasury::Errors::AuthenticationError.new(**kwargs)
+        in 403
+          ModernTreasury::Errors::PermissionDeniedError.new(**kwargs)
+        in 404
+          ModernTreasury::Errors::NotFoundError.new(**kwargs)
+        in 409
+          ModernTreasury::Errors::ConflictError.new(**kwargs)
+        in 422
+          ModernTreasury::Errors::UnprocessableEntityError.new(**kwargs)
+        in 429
+          ModernTreasury::Errors::RateLimitError.new(**kwargs)
+        in (500..)
+          ModernTreasury::Errors::InternalServerError.new(**kwargs)
+        else
+          ModernTreasury::Errors::APIStatusError.new(**kwargs)
+        end
+      end
 
-  class AuthenticationError < ModernTreasury::APIStatusError
-    HTTP_STATUS = 401
-  end
+      # @!parse
+      #   # @return [Integer]
+      #   attr_accessor :status
+
+      # @api 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 PermissionDeniedError < ModernTreasury::APIStatusError
-    HTTP_STATUS = 403
-  end
+    class BadRequestError < ModernTreasury::Errors::APIStatusError
+      HTTP_STATUS = 400
+    end
 
-  class NotFoundError < ModernTreasury::APIStatusError
-    HTTP_STATUS = 404
-  end
+    class AuthenticationError < ModernTreasury::Errors::APIStatusError
+      HTTP_STATUS = 401
+    end
 
-  class ConflictError < ModernTreasury::APIStatusError
-    HTTP_STATUS = 409
-  end
+    class PermissionDeniedError < ModernTreasury::Errors::APIStatusError
+      HTTP_STATUS = 403
+    end
 
-  class UnprocessableEntityError < ModernTreasury::APIStatusError
-    HTTP_STATUS = 422
-  end
+    class NotFoundError < ModernTreasury::Errors::APIStatusError
+      HTTP_STATUS = 404
+    end
 
-  class RateLimitError < ModernTreasury::APIStatusError
-    HTTP_STATUS = 429
-  end
+    class ConflictError < ModernTreasury::Errors::APIStatusError
+      HTTP_STATUS = 409
+    end
+
+    class UnprocessableEntityError < ModernTreasury::Errors::APIStatusError
+      HTTP_STATUS = 422
+    end
 
-  class InternalServerError < ModernTreasury::APIStatusError
-    HTTP_STATUS = (500..)
+    class RateLimitError < ModernTreasury::Errors::APIStatusError
+      HTTP_STATUS = 429
+    end
+
+    class InternalServerError < ModernTreasury::Errors::APIStatusError
+      HTTP_STATUS = (500..)
+    end
   end
 end