modern_treasury 0.1.0.pre.alpha.18 → 0.1.0.pre.alpha.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b3943d01cdc8c201df2448d6a46bf5620e94cffd46801ff2b737d9e4b7c50f4
-  data.tar.gz: 65030953f4f68d7adc5c494c36392e9f16d01f7968e40bf8bb916cfd5c607894
+  metadata.gz: bd1003cb64621e98061d4ea560dfbbae6f3a45716922765fcca9e3041ac78f90
+  data.tar.gz: a1991e3bf60a3ac44bcd607c4777dafbdef7d6ecb3368f1808abd420bbf547c6
 SHA512:
-  metadata.gz: 14b1fb7cbb760e00acabbd7cd48e479865ab3e698802bb6e96fb1e3c2cb9c17fd2354249de8cf3f5f14bd4c0e59d51bb6b28ef9bd265db3a32fc7491c74111c5
-  data.tar.gz: a6fb54d21ceac08ecda9cb74e1478ed0fd5993145a34af929d9952d100cd58434513eb6daf004ba7b224c73de03cbd5152f89e7f6ff430fe458849a4530e5148
+  metadata.gz: 9864551a559538d8ea3e34bea4057e64f4d68d775458b822cfdaa5a696c08b1747a3e03e78be226b8d4019568a03356286aa569e432ae39808c3b7b05c06a2c9
+  data.tar.gz: 82eb2cbb206557691cf3aafc61e0fd69ade2801145f8e9d0300292c7abbe92ec44f70421d0f244a75df8350381254f80e0f46be8943474b5f1438adbe2d3ca6f

data/CHANGELOG.md

@@ -1,5 +1,101 @@
 # Changelog
 
+## 0.1.0-alpha.20 (2025-05-23)
+
+Full Changelog: [v0.1.0-alpha.19...v0.1.0-alpha.20](https://github.com/Modern-Treasury/modern-treasury-ruby/compare/v0.1.0-alpha.19...v0.1.0-alpha.20)
+
+### Features
+
+* **api:** api update ([51f2558](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/51f2558e2bc2a89aa925e1e3f1dc64d5e3c5c162))
+* **api:** manual updates ([452bb1c](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/452bb1cbf073c0763b7b5e542042a320ab88c817))
+* bump default connection pool size limit to minimum of 99 ([f9b80ac](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/f9b80ace0577c91d113b36f8c02906cd2df41495))
+
+
+### Bug Fixes
+
+* correctly instantiate sorbet type aliases for enums and unions ([c2c4dba](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/c2c4dba8a02c3c7bf84fed51cc8d9d06dd94d7a6))
+* prevent rubocop from mangling `===` to `is_a?` check ([18009bb](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/18009bbd0286587025edead104ea029abaa71278))
+
+
+### Chores
+
+* **docs:** grammar improvements ([e533b50](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/e533b5028d204cc9537f17a88167b8c2f40e9d6c))
+* force utf-8 locale via `RUBYOPT` when formatting ([cf86688](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/cf866885c2f426bc3f129f12e7320c62d9a9e2c0))
+* refine Yard and Sorbet types and ensure linting is turned on for examples ([601bc22](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/601bc22d020b65bc19362566685aabc295d0598d))
+* use fully qualified names for yard annotations and rbs aliases ([621ed43](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/621ed43f77f526d2623989a48f3f1e9149ff800a))
+* use sorbet union aliases where available ([6701427](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/6701427854edd85ae958c7c53c8177af7fa68ec5))
+* whitespaces ([45f3cea](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/45f3cea94c88bb71356d502cce7f4fceb033f613))
+
+
+### Documentation
+
+* rewrite much of README.md for readability ([e426334](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/e426334cca1f4df82faa6675a909601f3480c186))
+
+## 0.1.0-alpha.19 (2025-05-13)
+
+Full Changelog: [v0.1.0-alpha.18...v0.1.0-alpha.19](https://github.com/Modern-Treasury/modern-treasury-ruby/compare/v0.1.0-alpha.18...v0.1.0-alpha.19)
+
+### Features
+
+* **api:** only send idempotency headers on PUT / POST requests ([83fd4af](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/83fd4af298abec1b714675e7acc40a276f1283f2))
+* expose base client options as read only attributes ([60a211d](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/60a211d7ae5e60e4a53e90fe22d543b130744de4))
+* expose recursive `#to_h` conversion ([06efb53](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/06efb534c53987cb36ca7ccee45bf50d426ed36b))
+* implement `#hash` for data containers ([d96aea7](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/d96aea756785f1cc2cd327d201424786fd20d5b0))
+* support sorbet aliases at the runtime ([c606bc7](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/c606bc705110611d96dffbe82f4dd53f5bca2679))
+* support specifying content-type with FilePart class ([db20b0a](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/db20b0afeeb1b6db89f454045f55acb39b6f9fa4))
+* support webmock for testing ([4644eaa](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/4644eaa0de6336e235c200158efc2927613f27e2))
+
+
+### Bug Fixes
+
+* always check if current page is empty in `next_page?` ([6efc146](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/6efc146540017fdc0cc7fb0475e1afc4a6d7ecfc))
+* ensure gem release is unaffected by renaming ([606ca8c](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/606ca8cc2e6c40c0abb89bd22ebe99a11c2de4d5))
+* **internal:** ensure formatting always uses c.utf-8 locale ([4303382](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/43033823e1670e0e66970524ad253d56b4e4ceb9))
+* **internal:** fix formatting script for macos ([850b98b](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/850b98b36836357549b7c056fd382027dea014f4))
+* **internal:** update gemspec name ([db69e0e](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/db69e0efc6b4fed197f481336fdb29a4025ae13a))
+* make a typo for `FilePart.content` ([442af9e](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/442af9e1e043f36ceaa0a2dc863ab93dc3fa7c66))
+
+
+### Chores
+
+* accept all nd-json mimetype variants ([d009d1a](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/d009d1a3e63bb3cffe1d77ec6708d4df2e804178))
+* add generator safe directory ([c7c4009](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/c7c4009c059fc4af63c464b5b368d13b821695b5))
+* broadly detect json family of content-type headers ([4e9190f](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/4e9190f728bf54a3d05bd21bc34cb4379d35d683))
+* **ci:** add timeout thresholds for CI jobs ([51098dd](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/51098dde2b1e6a0d5da51579efa6d3222ae0b6e7))
+* **ci:** only use depot for staging repos ([163402a](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/163402af8b04a17a425a72d958d7d9017030d84b))
+* **ci:** run on more branches and use depot runners ([1aaaa6f](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/1aaaa6f569a67f3e33d5d2529d38494f49e4808a))
+* consistently use string in examples, even for enums ([3766f9f](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/3766f9fd246d700b7c1fd936d16a5988267b3030))
+* documentation improvements ([ae02ed8](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/ae02ed86227ef8a2aba567eb8b82400b3a16c16d))
+* explicitly mark apis public under `Internal` module ([6358f72](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/6358f727a0bf1a4841d297a94a535335ee62b57e))
+* fix misc linting / minor issues ([de1286e](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/de1286ec80d18859be5bc2d402d1cef3aa3bd158))
+* **internal:** annotate request options with type aliases in sorbet ([a6d3efa](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/a6d3efa58e61ef821a4b77fde957a086b5ca430a))
+* **internal:** codegen related update ([13f2ea4](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/13f2ea46f28401e2265af8ffc60ebd9b16277bea))
+* **internal:** codegen related update ([a70306b](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/a70306bf04b718b8386bbb5498e5f1a2e103d4bf))
+* **internal:** codegen related update ([320f66e](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/320f66efad24e22c522025127a9ac4f06daf2a99))
+* **internal:** improve response envelope unwrap functionality ([91c54a5](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/91c54a535ab97caa3f0f10f5909803f8fd484a49))
+* **internal:** minor type annotation improvements ([80c7729](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/80c7729b33c9c8ae9f14b5ab2792ad37a7299379))
+* **internal:** remove unnecessary `rbi/lib` folder ([6d6e5ed](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/6d6e5ed2c64f7afd36b0304ce363efb64c13bc5f))
+* loosen rubocop rules that don't always make sense ([a7ecdad](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/a7ecdad7899b6b85ad59c08617740a27544db180))
+* make sorbet enums easier to read ([3dc3765](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/3dc37654a43d57db2c759714933d73efa31837f7))
+* migrate away from deprecated `JSON#fast_generate` ([9cf605d](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/9cf605dd27df53480a369f01677f886809afa69e))
+* more accurate type annotations and aliases ([dd1f15d](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/dd1f15dbf267e6d437b7ed83d1377f8aca17350e))
+* re-export top level models under library namespace ([ac629fe](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/ac629fecccb2b54de95280c575178c48be04416f))
+* refine `#inspect` and `#to_s` for model classes ([786b22a](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/786b22a499a6ba7f923926c42f971af82ce65ac0))
+* remove Gemfile.lock during bootstrap ([08680ae](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/08680ae4ffe4c4caccba19359315a1151a181599))
+* reorganize type aliases ([c28f2b8](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/c28f2b8ca8350ae72b7f5d39b6f5c939a7eb4a17))
+* revert ignoring Gemfile.lock ([6a27e21](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/6a27e21bee317a61e8abf393cd98686787dc970d))
+* show truncated parameter docs in yard ([5df7631](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/5df7631e3e10b14d383e6e38a6d4efc79d0883a4))
+* simplify yard annotations by removing most `@!parse` directives ([5a3e8a7](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/5a3e8a75fe86fb7539a7b0396294eb905f20f58e))
+* update README with recommended editor plugins ([aadf96a](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/aadf96a28e21ea93f09b9db44f7878f00c57c394))
+* use `@!method` instead of `@!parse` for virtual method type definitions ([d23861f](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/d23861f35b0d7a9ff65efa2a9f4ff3f6e962f251))
+* validate request option coercion correctness ([313bbc7](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/313bbc7003e71a20a5268115bfadf2feda148db8))
+
+
+### Documentation
+
+* illustrate environmental defaults for auth variables ([2313757](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/23137570576c7d32b0581f9d4b3b2581b5e563aa))
+* **readme:** fix typo ([90db191](https://github.com/Modern-Treasury/modern-treasury-ruby/commit/90db19112353146360a44a9abb0bdc061d991915))
+
 ## 0.1.0-alpha.18 (2025-04-17)
 
 Full Changelog: [v0.1.0-alpha.17...v0.1.0-alpha.18](https://github.com/Modern-Treasury/modern-treasury-ruby/compare/v0.1.0-alpha.17...v0.1.0-alpha.18)

data/README.md

@@ -1,6 +1,6 @@
 # Modern Treasury Ruby API library
 
-The Modern Treasury Ruby library provides convenient access to the Modern Treasury REST API from any Ruby 3.1.0+ application.
+The Modern Treasury Ruby library provides convenient access to the Modern Treasury REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/Modern-Treasury/modern-treasury-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.
 
 ## Documentation
 
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "modern_treasury", "~> 0.1.0.pre.alpha.18"
+gem "modern_treasury", "~> 0.1.0.pre.alpha.20"
 ```
 
 <!-- x-release-please-end -->
@@ -27,8 +27,8 @@ require "bundler/setup"
 require "modern_treasury"
 
 modern_treasury = ModernTreasury::Client.new(
-  organization_id: "my-organization-ID", # defaults to ENV["MODERN_TREASURY_ORGANIZATION_ID"]
-  api_key: "My API Key" # defaults to ENV["MODERN_TREASURY_API_KEY"]
+  organization_id: ENV["MODERN_TREASURY_ORGANIZATION_ID"], # This is the default and can be omitted
+  api_key: ENV["MODERN_TREASURY_API_KEY"] # This is the default and can be omitted
 )
 
 counterparty = modern_treasury.counterparties.create(name: "my first counterparty")
@@ -55,44 +55,68 @@ page.auto_paging_each do |counterparty|
 end
 ```
 
+Alternatively, you can use the `#next_page?` and `#next_page` methods for more granular control working with pages.
+
+```ruby
+if page.next_page?
+  new_page = page.next_page
+  puts(new_page.items[0].id)
+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.
+Request parameters that correspond to file uploads can be passed as raw contents, a [`Pathname`](https://rubyapi.org/3.2/o/pathname) instance, [`StringIO`](https://rubyapi.org/3.2/o/stringio), or more.
 
 ```ruby
 require "pathname"
 
-# using `Pathname`, the file will be lazily read, without reading everything in to memory
+# Use `Pathname` to send the filename and/or avoid paging a large file into 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
+# Alternatively, pass file contents or a `StringIO` directly:
 document = modern_treasury.documents.create(
   documentable_id: "24c6b7a3-02...",
   documentable_type: "counterparties",
-  file: StringIO.new(file)
+  file: File.read("my/file.txt")
+)
+
+# Or, to control the filename and/or content type:
+file = ModernTreasury::FilePart.new(File.read("my/file.txt"), filename: "my/file.txt", content_type: "…")
+document = modern_treasury.documents.create(
+  documentable_id: "24c6b7a3-02...",
+  documentable_type: "counterparties",
+  file: file
 )
 
 puts(document.id)
 ```
 
-### Errors
+Note that you can also pass a raw `IO` descriptor, but this disables retries, as the library can't be sure if the descriptor is a file or pipe (which cannot be rewound).
+
+### Handling 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::Errors::APIError` will be thrown:
 
 ```ruby
 begin
   external_account = modern_treasury.external_accounts.create(counterparty_id: "missing")
-rescue ModernTreasury::Errors::APIError => e
-  puts(e.status) # 400
+rescue ModernTreasury::Errors::APIConnectionError => e
+  puts("The server could not be reached")
+  puts(e.cause)  # an underlying Exception, likely raised within `net/http`
+rescue ModernTreasury::Errors::RateLimitError => e
+  puts("A 429 status code was received; we should back off a bit.")
+rescue ModernTreasury::Errors::APIStatusError => e
+  puts("Another non-200-range status code was received")
+  puts(e.status)
 end
 ```
 
-Error codes are as followed:
+Error codes are as follows:
 
 | Cause            | Error Type                 |
 | ---------------- | -------------------------- |
@@ -128,11 +152,7 @@ modern_treasury.counterparties.create(name: "my first counterparty", request_opt
 
 ### Timeouts
 
-By default, requests will time out after 60 seconds.
-
-Timeouts are applied separately to the initial connection and the overall request time, so in some cases a request could wait 2\*timeout seconds before it fails.
-
-You can use the `timeout` option to configure or disable this:
+By default, requests will time out after 60 seconds. You can use the timeout option to configure or disable this:
 
 ```ruby
 # Configure the default for all requests:
@@ -144,88 +164,122 @@ modern_treasury = ModernTreasury::Client.new(
 modern_treasury.counterparties.create(name: "my first counterparty", request_options: {timeout: 5})
 ```
 
-## LSP Support
+On timeout, `ModernTreasury::Errors::APITimeoutError` is raised.
 
-### Solargraph
+Note that requests that time out are retried by default.
 
-This library includes [Solargraph](https://solargraph.org) support for both auto completion and go to definition.
+## Advanced concepts
 
-```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:
+### BaseModel
 
-```sh
-bundle exec solargraph gems
-```
+All parameter and response objects inherit from `ModernTreasury::Internal::Type::BaseModel`, which provides several conveniences, including:
 
-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.
+1. All fields, including unknown ones, are accessible with `obj[:prop]` syntax, and can be destructured with `obj => {prop: prop}` or pattern-matching syntax.
 
-```yaml
-include:
-  - 'vendor/bundle/ruby/*/gems/modern_treasury-*/lib/**/*.rb'
-```
+2. Structural equivalence for equality; if two API calls return the same values, comparing the responses with == will return true.
 
-Otherwise Solargraph will not be able to provide type information or auto-completion for any non-indexed libraries.
+3. Both instances and the classes themselves can be pretty-printed.
 
-### Sorbet
+4. Helpers such as `#to_h`, `#deep_to_h`, `#to_json`, and `#to_yaml`.
 
-This library is written with [Sorbet type definitions](https://sorbet.org/docs/rbi). However, there is no runtime dependency on the `sorbet-runtime`.
+### Making custom or undocumented requests
 
-What this means is that while you can use Sorbet to type check your code statically, and benefit from the [Sorbet Language Server](https://sorbet.org/docs/lsp) in your editor, there is no runtime type checking and execution overhead from Sorbet itself.
+#### Undocumented properties
 
-Due to limitations with the Sorbet type system, where a method otherwise can take an instance of `ModernTreasury::BaseModel` class, you will need to use the `**` splat operator to pass the arguments:
+You can send undocumented parameters to any endpoint, and read undocumented response properties, like so:
 
-Please follow Sorbet's [setup guides](https://sorbet.org/docs/adopting) for best experience.
+Note: the `extra_` parameters of the same name overrides the documented parameters.
 
 ```ruby
-params = ModernTreasury::Models::CounterpartyCreateParams.new(name: "my first counterparty")
+counterparty =
+  modern_treasury.counterparties.create(
+    name: "my first counterparty",
+    request_options: {
+      extra_query: {my_query_parameter: value},
+      extra_body: {my_body_parameter: value},
+      extra_headers: {"my-header": value}
+    }
+  )
 
-modern_treasury.counterparties.create(**params)
+puts(counterparty[:my_undocumented_property])
 ```
 
-Note: **This library emits an intentional warning under the [`tapioca` toolchain](https://github.com/Shopify/tapioca)**. This is normal, and does not impact functionality.
+#### 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 request, as seen in the examples above.
+
+#### Undocumented endpoints
+
+To make requests to undocumented endpoints while retaining the benefit of auth, retries, and so on, you can make requests using `client.request`, like so:
 
-### Ruby LSP
+```ruby
+response = client.request(
+  method: :post,
+  path: '/undocumented/endpoint',
+  query: {"dog": "woof"},
+  headers: {"useful-header": "interesting-value"},
+  body: {"hello": "world"}
+)
+```
 
-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.
+### Concurrency & connection pooling
 
-## Advanced
+The `ModernTreasury::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.
 
-### Making custom/undocumented requests
+Each instance of `ModernTreasury::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings.
 
-This library is typed for convenient access to the documented API.
+When all available connections from the pool are checked out, requests wait for a new connection to become available, with queue time counting towards the request timeout.
 
-If you need to access undocumented endpoints, params, or response properties, the library can still be used.
+Unless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure.
 
-#### Undocumented request params
+## Sorbet
 
-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.
+This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitions, and has no dependency on sorbet-runtime.
 
-#### Undocumented endpoints
+You can provide typesafe request parameters like so:
 
-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
+modern_treasury.counterparties.create(name: "my first counterparty")
+```
+
+Or, equivalently:
 
 ```ruby
-response = client.request(
-    method: :post,
-    path: '/undocumented/endpoint',
-    query: {"dog": "woof"},
-    headers: {"useful-header": "interesting-value"},
-    body: {"he": "llo"},
-  )
+# Hashes work, but are not typesafe:
+modern_treasury.counterparties.create(name: "my first counterparty")
+
+# You can also splat a full Params class:
+params = ModernTreasury::CounterpartyCreateParams.new(name: "my first counterparty")
+modern_treasury.counterparties.create(**params)
 ```
 
-### Concurrency & Connection Pooling
+### Enums
 
-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.
+Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
 
-When the maximum number of connections has been checked out from the connection pool, the `Client` will wait for an in use connection to become available. The queue time for this mechanism is accounted for by the per-request timeout.
+```ruby
+# :denied
+puts(ModernTreasury::CounterpartyCreateParams::VerificationStatus::DENIED)
 
-Unless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure.
+# Revealed type: `T.all(ModernTreasury::CounterpartyCreateParams::VerificationStatus, Symbol)`
+T.reveal_type(ModernTreasury::CounterpartyCreateParams::VerificationStatus::DENIED)
+```
+
+Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
+
+```ruby
+# Using the enum constants preserves the tagged type information:
+modern_treasury.counterparties.create(
+  verification_status: ModernTreasury::CounterpartyCreateParams::VerificationStatus::DENIED,
+  # …
+)
 
-Currently, `ModernTreasury::Client` instances are only fork-safe if there are no in-flight HTTP requests.
+# Literal values are also permissible:
+modern_treasury.counterparties.create(
+  verification_status: :denied,
+  # …
+)
+```
 
 ## Versioning
 
@@ -235,4 +289,8 @@ This package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` typ
 
 ## Requirements
 
-Ruby 3.1.0 or higher.
+Ruby 3.2.0 or higher.
+
+## Contributing
+
+See [the contributing documentation](https://github.com/Modern-Treasury/modern-treasury-ruby/tree/main/CONTRIBUTING.md).

data/SECURITY.md

@@ -16,11 +16,11 @@ 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.
+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.
+Please contact sdk-feedback@moderntreasury.com for any questions or concerns regarding the security of our services.
 
 ---
 

data/lib/modern_treasury/client.rb

@@ -132,6 +132,9 @@ module ModernTreasury
     # @return [ModernTreasury::Resources::LegalEntityAssociations]
     attr_reader :legal_entity_associations
 
+    # @return [ModernTreasury::Resources::PaymentActions]
+    attr_reader :payment_actions
+
     # A test endpoint often used to confirm credentials and headers are being passed
     # in correctly.
     #
@@ -146,7 +149,7 @@ module ModernTreasury
       request(
         method: :get,
         path: "api/ping",
-        model: ModernTreasury::Models::PingResponse,
+        model: ModernTreasury::PingResponse,
         options: params[:request_options]
       )
     end
@@ -183,10 +186,10 @@ module ModernTreasury
       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,
-      max_retry_delay: DEFAULT_MAX_RETRY_DELAY,
+      max_retries: self.class::DEFAULT_MAX_RETRIES,
+      timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY,
       idempotency_header: "Idempotency-Key"
     )
       base_url ||= "https://app.moderntreasury.com"
@@ -248,6 +251,7 @@ module ModernTreasury
       @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)
+      @payment_actions = ModernTreasury::Resources::PaymentActions.new(client: self)
     end
   end
 end

data/lib/modern_treasury/errors.rb

@@ -3,9 +3,9 @@
 module ModernTreasury
   module Errors
     class Error < StandardError
-      # @!parse
-      #   # @return [StandardError, nil]
-      #   attr_accessor :cause
+      # @!attribute cause
+      #
+      #   @return [StandardError, nil]
     end
 
     class ConversionError < ModernTreasury::Errors::Error
@@ -40,13 +40,13 @@ module ModernTreasury
     end
 
     class APIConnectionError < ModernTreasury::Errors::APIError
-      # @!parse
-      #   # @return [nil]
-      #   attr_accessor :status
+      # @!attribute status
+      #
+      #   @return [nil]
 
-      # @!parse
-      #   # @return [nil]
-      #   attr_accessor :body
+      # @!attribute body
+      #
+      #   @return [nil]
 
       # @api private
       #
@@ -99,7 +99,7 @@ module ModernTreasury
       # @param response [nil]
       # @param message [String, nil]
       #
-      # @return [ModernTreasury::Errors::APIStatusError]
+      # @return [self]
       def self.for(url:, status:, body:, request:, response:, message: nil)
         kwargs = {
           url: url,

data/lib/modern_treasury/file_part.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  class FilePart
+    # @return [Pathname, StringIO, IO, String]
+    attr_reader :content
+
+    # @return [String, nil]
+    attr_reader :content_type
+
+    # @return [String, nil]
+    attr_reader :filename
+
+    # @api private
+    #
+    # @return [String]
+    private def read
+      case content
+      in Pathname
+        content.read(binmode: true)
+      in StringIO
+        content.string
+      in IO
+        content.read
+      in String
+        content
+      end
+    end
+
+    # @param a [Object]
+    #
+    # @return [String]
+    def to_json(*a) = read.to_json(*a)
+
+    # @param a [Object]
+    #
+    # @return [String]
+    def to_yaml(*a) = read.to_yaml(*a)
+
+    # @param content [Pathname, StringIO, IO, String]
+    # @param filename [String, nil]
+    # @param content_type [String, nil]
+    def initialize(content, filename: nil, content_type: nil)
+      @content = content
+      @filename =
+        case content
+        in Pathname
+          filename.nil? ? content.basename.to_path : ::File.basename(filename)
+        else
+          filename.nil? ? nil : ::File.basename(filename)
+        end
+      @content_type = content_type
+    end
+  end
+end

data/lib/modern_treasury/internal/page.rb

@@ -24,11 +24,11 @@ module ModernTreasury
 
       # @return [Boolean]
       def next_page?
-        !after_cursor.nil?
+        !empty? && !after_cursor.to_s.empty?
       end
 
       # @raise [ModernTreasury::HTTP::Error]
-      # @return [ModernTreasury::Internal::Page]
+      # @return [self]
       def next_page
         unless next_page?
           message = "No more pages available. Please check #next_page? before calling ##{__method__}"