metronome-sdk 0.1.0.pre.alpha.2 → 0.1.0.pre.alpha.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b49fbb83290c83ee3d66cd3b2e5ae7e8055f745b97f8d1ab14ece932b89a23e0
-  data.tar.gz: 526a11304c8b163141bd09f107dc6a2e32c9c992549b5b521cad8c3229407a14
+  metadata.gz: a44d5d1875ab2a3f6799d850de8e858790cf3b1effe78faf11aaf66cb63108bb
+  data.tar.gz: e8a0924693987951798904c088ba86857560fbf85a32948f1dde31a04cb2c1eb
 SHA512:
-  metadata.gz: fb6e5add40c34fc28319a79a8cf445a2e770a8d523bbeebdd89e7047fcb683658dcaa3775a52e94c5dc00032594e3ca254e077b3164fad2669691123c4944ab4
-  data.tar.gz: aacf5f90cddbb3756686efb8873d992f6df59fc6012bfcb2d770f0297eec754adaddfc82ef1960e948a93e594fda30f228e78caada919724f9f0774fd2bb371a
+  metadata.gz: 041527374ecc4da3c21f5b5971ac35962814ac7fbe8f80791b168b9daaff0cf2ab6360d6a0c98f5b63e41c4eecfa3edbbc29c5dda5cfdbd830a073a72b383dd3
+  data.tar.gz: 4f1c4fabe61b612eee4e20203a62c5c3cebe1df469d59cc9d6d299495f51fc9d5b489f82ed339b0008347ed6d04ee00d4026888410ee1bdc1565942fcf8869b5

data/CHANGELOG.md

@@ -1,5 +1,90 @@
 # Changelog
 
+## 0.1.0-alpha.4 (2025-07-18)
+
+Full Changelog: [v0.1.0-alpha.3...v0.1.0-alpha.4](https://github.com/Metronome-Industries/metronome-ruby/compare/v0.1.0-alpha.3...v0.1.0-alpha.4)
+
+### Features
+
+* **api:** Add Event Search API for finding events to match to customers and billable metrics ([26a0a0d](https://github.com/Metronome-Industries/metronome-ruby/commit/26a0a0d293496c532c635a9936dd2ba7c3f14683))
+* **api:** add previewEvents API for generating draft invoices with provided events ([e2e5795](https://github.com/Metronome-Industries/metronome-ruby/commit/e2e579573a289ce749608a9c08a97b074ead387d))
+* **api:** update v2 contracts list documentation to specify chronological order ([b322bbc](https://github.com/Metronome-Industries/metronome-ruby/commit/b322bbc373ac7b90fe771fa6a2a2bef1fdc504ff))
+* **api:** add support for Anrok and Precalculated tax types in payment gateway configuration ([ee0d2af](https://github.com/Metronome-Industries/metronome-ruby/commit/ee0d2af6cc3cb1fb2bbc321f619ccd941db06c44))
+* **api:** add hierarchy configuration to v1 contracts ([f076da2](https://github.com/Metronome-Industries/metronome-ruby/commit/f076da2387c85f5e4f94c2b9a5f0ab279a778c92))
+* **api:** improve Event Search API documentation and rate limiting details ([e8618a3](https://github.com/Metronome-Industries/metronome-ruby/commit/e8618a3b86ec4d9e19df9dd24f5381288071313e))
+* **api:** improve previewEvents API documentation and make custom_credit_type_id nullable ([12c5814](https://github.com/Metronome-Industries/metronome-ruby/commit/12c5814b48b6bf441c5b6b8a22adb683c185c007))
+* **api:** add custom credit type support to prepaid balance thresholds ([1b75766](https://github.com/Metronome-Industries/metronome-ruby/commit/1b75766b321ca146dd911c56c47bf286f928f550))
+* **api:** add Event Search API ([8065b4c](https://github.com/Metronome-Industries/metronome-ruby/commit/8065b4c8053818b19a40faf3dc99e17396d1f546))
+* **api:** remove Event Search API and add contract priority field ([ae63c04](https://github.com/Metronome-Industries/metronome-ruby/commit/ae63c045c280949ba69c636c9ed25ea5942822ad))
+* **api:** add shared type aliases for commit/credit types ([2f8a188](https://github.com/Metronome-Industries/metronome-ruby/commit/2f8a18824b0f5b6455dce126799de441be282a78))
+* **api:** remove shared type aliases for commit/credit types ([e86a139](https://github.com/Metronome-Industries/metronome-ruby/commit/e86a139fca3e4b1919d8de7e1fb5841eb4835e3b))
+* **api:** add contract hierarchy configuration to shared types ([4a31b46](https://github.com/Metronome-Industries/metronome-ruby/commit/4a31b4636526937656b65c265e74119c1944fb82))
+* **api:** change recurring commit/credit access amount quantity field from required to optional ([2403df6](https://github.com/Metronome-Industries/metronome-ruby/commit/2403df68d460ddbdac8d0e5ef51c64b9d95a3029))
+* **api:** add sort parameter to credit grant list entries API ([a56f5cb](https://github.com/Metronome-Industries/metronome-ruby/commit/a56f5cb1a04d956a282e21e520e25855b45807a6))
+* **client:** add debug log helper ([fbc9042](https://github.com/Metronome-Industries/metronome-ruby/commit/fbc904277c1a3e96f3a0a03f3b2f65863802be2d))
+
+
+### Bug Fixes
+
+* `to_sorbet_type` should not return branded types ([9fda15f](https://github.com/Metronome-Industries/metronome-ruby/commit/9fda15fbb91924034acacadd4e4b88ba49bb9e61))
+* **ci:** release-doctor — report correct token name ([ea3a4df](https://github.com/Metronome-Industries/metronome-ruby/commit/ea3a4dfc3c361601f10d7bf0bf9e8472404a413b))
+* default content-type for text in multi-part formdata uploads should be text/plain ([c566bfd](https://github.com/Metronome-Industries/metronome-ruby/commit/c566bfd18faba7624ccf41b9275ecfa2610c40ed))
+* issue where we cannot mutate arrays on base model derivatives ([8020ba8](https://github.com/Metronome-Industries/metronome-ruby/commit/8020ba8df6fbdb8362dd00223ad360a93acc0666))
+
+
+### Chores
+
+* **ci:** enable for pull requests ([0dbe09f](https://github.com/Metronome-Industries/metronome-ruby/commit/0dbe09f41e8b56a873bcf1151ab5dff3a39a2d30))
+* **ci:** link to correct github repo ([ca6bdf8](https://github.com/Metronome-Industries/metronome-ruby/commit/ca6bdf8a4edfe037c672b8e1fc4a800656391a49))
+* **ci:** only run for pushes and fork pull requests ([e21f43c](https://github.com/Metronome-Industries/metronome-ruby/commit/e21f43ca4d03f0246693dc04393c2f82391d617a))
+* **internal:** allow streams to also be unwrapped on a per-row basis ([b40d49a](https://github.com/Metronome-Industries/metronome-ruby/commit/b40d49a3e3915cc4bb47ebdcebac5e139ad7f07b))
+* **internal:** version bump ([c50a620](https://github.com/Metronome-Industries/metronome-ruby/commit/c50a620ff8154b422aeb80e827986f28eded7da5))
+
+## 0.1.0-alpha.3 (2025-05-30)
+
+Full Changelog: [v0.1.0-alpha.2...v0.1.0-alpha.3](https://github.com/Metronome-Industries/metronome-ruby/compare/v0.1.0-alpha.2...v0.1.0-alpha.3)
+
+### Features
+
+* **api:** add subscription quantity history endpoint ([e351c6a](https://github.com/Metronome-Industries/metronome-ruby/commit/e351c6a19805c7ee8b81bf91a53eba9aca23de3b))
+* **api:** api update ([74509d0](https://github.com/Metronome-Industries/metronome-ruby/commit/74509d026a2b1d05de8f01d632265712ec76902c))
+* **api:** api update ([fd3ee7b](https://github.com/Metronome-Industries/metronome-ruby/commit/fd3ee7b5a91c376610c43bca936275acc2496d9a))
+* **api:** api update ([cf7391b](https://github.com/Metronome-Industries/metronome-ruby/commit/cf7391bae153f1ef054eca2b823c2ad24b2a4ca2))
+* **api:** api update ([d20737d](https://github.com/Metronome-Industries/metronome-ruby/commit/d20737d6b20aff070f442cb3d839a6936cefbfd9))
+* **api:** api update ([43088af](https://github.com/Metronome-Industries/metronome-ruby/commit/43088af50aedccdc33d881d798abae2ae43effd4))
+* **api:** api update ([a594256](https://github.com/Metronome-Industries/metronome-ruby/commit/a5942561ba77e6737f173845b8c77851d01bc29e))
+* **api:** api update ([abef131](https://github.com/Metronome-Industries/metronome-ruby/commit/abef13148c6c87616bf17b9d8ddd27fa0720b4d2))
+* **api:** api update ([e43c423](https://github.com/Metronome-Industries/metronome-ruby/commit/e43c4232914c39e151e48408f5e7bc92e3bba344))
+* **api:** api update ([b380b6b](https://github.com/Metronome-Industries/metronome-ruby/commit/b380b6b419c5632c69042c59e56da7dd77b1c48d))
+* **api:** api update ([5f4769e](https://github.com/Metronome-Industries/metronome-ruby/commit/5f4769ef4d7618986889aa65eb27b216925b6b88))
+* **api:** api update ([6bc1ed9](https://github.com/Metronome-Industries/metronome-ruby/commit/6bc1ed9258a3e91af051ad66ce1154ca8f935672))
+* **api:** rename get subscription quantity history to retrieve ([f42dd95](https://github.com/Metronome-Industries/metronome-ruby/commit/f42dd9512d9753529e30d84581d773266d3430a1))
+* bump default connection pool size limit to minimum of 99 ([3505102](https://github.com/Metronome-Industries/metronome-ruby/commit/35051025eee8e1cc82573c6cdb22e5cdbba8bac4))
+
+
+### Bug Fixes
+
+* correctly instantiate sorbet type aliases for enums and unions ([1f185c4](https://github.com/Metronome-Industries/metronome-ruby/commit/1f185c48f242edd584803dbe80446c7d1fda8dd0))
+* prevent rubocop from mangling `===` to `is_a?` check ([c83f973](https://github.com/Metronome-Industries/metronome-ruby/commit/c83f9731040b4fb2681463e1462ce0c58fa76a9d))
+* sorbet types for enums, and make tapioca detection ignore `tapioca dsl` ([20f971e](https://github.com/Metronome-Industries/metronome-ruby/commit/20f971e01e29c18fa9da3d8997501ced4201dbcf))
+
+
+### Chores
+
+* configure new SDK language ([f533e8d](https://github.com/Metronome-Industries/metronome-ruby/commit/f533e8dd8644c8ea438f6415107dae372e066b42))
+* **docs:** grammar improvements ([75acd0d](https://github.com/Metronome-Industries/metronome-ruby/commit/75acd0d91d514981f2289a30d5814b22572937e1))
+* force utf-8 locale via `RUBYOPT` when formatting ([f0d61eb](https://github.com/Metronome-Industries/metronome-ruby/commit/f0d61eb00cc448aea60b083e39becc33ca1dbcda))
+* refine Yard and Sorbet types and ensure linting is turned on for examples ([17087f7](https://github.com/Metronome-Industries/metronome-ruby/commit/17087f718e886d75803b500f31e271eb1372fb1d))
+* update SDK settings ([cba0fb7](https://github.com/Metronome-Industries/metronome-ruby/commit/cba0fb75b0455b8a49cdf6b184a4976792a34e6e))
+* use fully qualified names for yard annotations and rbs aliases ([e6c95d3](https://github.com/Metronome-Industries/metronome-ruby/commit/e6c95d341d8d28396ccc7a986afe0930749d32c8))
+* use sorbet union aliases where available ([0070ea5](https://github.com/Metronome-Industries/metronome-ruby/commit/0070ea559f406fa847bc4078f346923469a404d8))
+* whitespaces ([e343538](https://github.com/Metronome-Industries/metronome-ruby/commit/e343538c481650b8e1ad74a25e32635261f4d132))
+
+
+### Documentation
+
+* rewrite much of README.md for readability ([c653f5e](https://github.com/Metronome-Industries/metronome-ruby/commit/c653f5e7a6c5b176c3ca4b566afd0ed612ef4e3d))
+
 ## 0.1.0-alpha.2 (2025-05-14)
 
 Full Changelog: [v0.1.0-alpha.1...v0.1.0-alpha.2](https://github.com/Metronome-Industries/metronome-ruby/compare/v0.1.0-alpha.1...v0.1.0-alpha.2)

data/README.md

@@ -1,6 +1,6 @@
 # Metronome Ruby API library
 
-The Metronome Ruby library provides convenient access to the Metronome REST API from any Ruby 3.2.0+ application.
+The Metronome Ruby library provides convenient access to the Metronome 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/Metronome-Industries/metronome-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.
 
 It is generated with [Stainless](https://www.stainless.com/).
 
@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "metronome-sdk", "~> 0.1.0.pre.alpha.2"
+gem "metronome-sdk", "~> 0.1.0.pre.alpha.4"
 ```
 
 <!-- x-release-please-end -->
@@ -47,26 +47,6 @@ result = metronome.v1.usage.ingest(
 puts(result)
 ```
 
-## Sorbet
-
-This library is written with [Sorbet type definitions](https://sorbet.org/docs/rbi). However, there is no runtime dependency on the `sorbet-runtime`.
-
-When using sorbet, it is recommended to use model classes as below. This provides stronger type checking and tooling integration.
-
-```ruby
-metronome.v1.usage.ingest(
-  usage: [
-    MetronomeSDK::V1::UsageIngestParams::Usage.new(
-      transaction_id: "90e9401f-0f8c-4cd3-9a9f-d6beb56d8d72",
-      customer_id: "team@example.com",
-      event_type: "heartbeat",
-      timestamp: "2024-01-01T00:00:00Z",
-      properties: {cluster_id: "42", cpu_seconds: 60, region: "Europe"}
-    )
-  ]
-)
-```
-
 ### Pagination
 
 List methods in the Metronome API are paginated.
@@ -86,7 +66,16 @@ page.auto_paging_each do |product|
 end
 ```
 
-### Errors
+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.data[0].id)
+end
+```
+
+### 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 `MetronomeSDK::Errors::APIError` will be thrown:
 
@@ -96,8 +85,14 @@ begin
     customer_id: "13117714-3f05-48e5-a6e9-a66093f13b4d",
     starting_at: "2020-01-01T00:00:00.000Z"
   )
-rescue MetronomeSDK::Errors::APIError => e
-  puts(e.status) # 400
+rescue MetronomeSDK::Errors::APIConnectionError => e
+  puts("The server could not be reached")
+  puts(e.cause)  # an underlying Exception, likely raised within `net/http`
+rescue MetronomeSDK::Errors::RateLimitError => e
+  puts("A 429 status code was received; we should back off a bit.")
+rescue MetronomeSDK::Errors::APIStatusError => e
+  puts("Another non-200-range status code was received")
+  puts(e.status)
 end
 ```
 
@@ -141,11 +136,7 @@ metronome.v1.contracts.create(
 
 ### 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:
@@ -161,57 +152,54 @@ metronome.v1.contracts.create(
 )
 ```
 
-## Model DSL
+On timeout, `MetronomeSDK::Errors::APITimeoutError` is raised.
 
-This library uses a simple DSL to represent request parameters and response shapes in `lib/metronome_sdk/models`.
+Note that requests that time out are retried by default.
 
-With the right [editor plugins](https://shopify.github.io/ruby-lsp), you can ctrl-click on elements of the DSL to navigate around and explore the library.
+## Advanced concepts
 
-In all places where a `BaseModel` type is specified, vanilla Ruby `Hash` can also be used. For example, the following are interchangeable as arguments:
+### BaseModel
 
-```ruby
-# This has tooling readability, for auto-completion, static analysis, and goto definition with supported language services
-params = MetronomeSDK::Models::V1::UsageIngestParams.new(
-  usage: [
-    MetronomeSDK::V1::UsageIngestParams::Usage.new(
-      transaction_id: "90e9401f-0f8c-4cd3-9a9f-d6beb56d8d72",
-      customer_id: "team@example.com",
-      event_type: "heartbeat",
-      timestamp: "2024-01-01T00:00:00Z",
-      properties: {cluster_id: "42", cpu_seconds: 60, region: "Europe"}
-    )
-  ]
-)
+All parameter and response objects inherit from `MetronomeSDK::Internal::Type::BaseModel`, which provides several conveniences, including:
 
-# This also works
-params = {
-  usage: [
-    {
-      transaction_id: "90e9401f-0f8c-4cd3-9a9f-d6beb56d8d72",
-      customer_id: "team@example.com",
-      event_type: "heartbeat",
-      timestamp: "2024-01-01T00:00:00Z",
-      properties: {cluster_id: "42", cpu_seconds: 60, region: "Europe"}
-    }
-  ]
-}
-```
+1. All fields, including unknown ones, are accessible with `obj[:prop]` syntax, and can be destructured with `obj => {prop: prop}` or pattern-matching syntax.
 
-## Editor support
+2. Structural equivalence for equality; if two API calls return the same values, comparing the responses with == will return true.
 
-A combination of [Shopify LSP](https://shopify.github.io/ruby-lsp) and [Solargraph](https://solargraph.org/) is recommended for non-[Sorbet](https://sorbet.org) users. The former is especially good at go to definition, while the latter has much better auto-completion support.
+3. Both instances and the classes themselves can be pretty-printed.
 
-## Advanced concepts
+4. Helpers such as `#to_h`, `#deep_to_h`, `#to_json`, and `#to_yaml`.
+
+### Making custom or undocumented requests
+
+#### Undocumented properties
 
-### Making custom/undocumented requests
+You can send undocumented parameters to any endpoint, and read undocumented response properties, like so:
+
+Note: the `extra_` parameters of the same name overrides the documented parameters.
+
+```ruby
+contract =
+  metronome.v1.contracts.create(
+    customer_id: "13117714-3f05-48e5-a6e9-a66093f13b4d",
+    starting_at: "2020-01-01T00:00:00.000Z",
+    request_options: {
+      extra_query: {my_query_parameter: value},
+      extra_body: {my_body_parameter: value},
+      extra_headers: {"my-header": value}
+    }
+  )
+
+puts(contract[:my_undocumented_property])
+```
 
 #### 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.
+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, you can make requests using `client.request`. Options on the client will be respected (such as retries) when making this request.
+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
 response = client.request(
@@ -219,28 +207,58 @@ response = client.request(
   path: '/undocumented/endpoint',
   query: {"dog": "woof"},
   headers: {"useful-header": "interesting-value"},
-  body: {"he": "llo"},
+  body: {"hello": "world"}
 )
 ```
 
 ### Concurrency & connection pooling
 
-The `MetronomeSDK::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.
+The `MetronomeSDK::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.
+
+Each instance of `MetronomeSDK::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.
 
-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.
+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.
 
 Unless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure.
 
-Currently, `MetronomeSDK::Client` instances are only fork-safe if there are no in-flight HTTP requests.
+## Sorbet
 
-### Sorbet
+This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitions, and has no dependency on sorbet-runtime.
 
-#### Argument passing trick
+You can provide typesafe request parameters like so:
 
-It is possible to pass a compatible model / parameter class to a method that expects keyword arguments by using the `**` splat operator.
+```ruby
+metronome.v1.usage.ingest(
+  usage: [
+    MetronomeSDK::V1::UsageIngestParams::Usage.new(
+      transaction_id: "90e9401f-0f8c-4cd3-9a9f-d6beb56d8d72",
+      customer_id: "team@example.com",
+      event_type: "heartbeat",
+      timestamp: "2024-01-01T00:00:00Z",
+      properties: {cluster_id: "42", cpu_seconds: 60, region: "Europe"}
+    )
+  ]
+)
+```
+
+Or, equivalently:
 
 ```ruby
-params = MetronomeSDK::Models::V1::UsageIngestParams.new(
+# Hashes work, but are not typesafe:
+metronome.v1.usage.ingest(
+  usage: [
+    {
+      transaction_id: "90e9401f-0f8c-4cd3-9a9f-d6beb56d8d72",
+      customer_id: "team@example.com",
+      event_type: "heartbeat",
+      timestamp: "2024-01-01T00:00:00Z",
+      properties: {cluster_id: "42", cpu_seconds: 60, region: "Europe"}
+    }
+  ]
+)
+
+# You can also splat a full Params class:
+params = MetronomeSDK::V1::UsageIngestParams.new(
   usage: [
     MetronomeSDK::V1::UsageIngestParams::Usage.new(
       transaction_id: "90e9401f-0f8c-4cd3-9a9f-d6beb56d8d72",
@@ -254,6 +272,34 @@ params = MetronomeSDK::Models::V1::UsageIngestParams.new(
 metronome.v1.usage.ingest(**params)
 ```
 
+### Enums
+
+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:
+
+```ruby
+# :low_credit_balance_reached
+puts(MetronomeSDK::V1::AlertCreateParams::AlertType::LOW_CREDIT_BALANCE_REACHED)
+
+# Revealed type: `T.all(MetronomeSDK::V1::AlertCreateParams::AlertType, Symbol)`
+T.reveal_type(MetronomeSDK::V1::AlertCreateParams::AlertType::LOW_CREDIT_BALANCE_REACHED)
+```
+
+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:
+metronome.v1.alerts.create(
+  alert_type: MetronomeSDK::V1::AlertCreateParams::AlertType::LOW_CREDIT_BALANCE_REACHED,
+  # …
+)
+
+# Literal values are also permissible:
+metronome.v1.alerts.create(
+  alert_type: :low_credit_balance_reached,
+  # …
+)
+```
+
 ## Versioning
 
 This package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the library is in initial development and has a major version of `0`, APIs may change at any time.

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 Metronome please follow the respective company's security reporting guidelines.
+or products provided by Metronome, please follow the respective company's security reporting guidelines.
 
 ### Metronome Terms and Policies
 
-Please contact dev-feedback@metronome.com for any questions or concerns regarding security of our services.
+Please contact dev-feedback@metronome.com for any questions or concerns regarding the security of our services.
 
 ---
 

data/lib/metronome_sdk/client.rb

@@ -50,10 +50,10 @@ module MetronomeSDK
     def initialize(
       bearer_token: ENV["METRONOME_BEARER_TOKEN"],
       base_url: ENV["METRONOME_BASE_URL"],
-      max_retries: MetronomeSDK::Client::DEFAULT_MAX_RETRIES,
-      timeout: MetronomeSDK::Client::DEFAULT_TIMEOUT_IN_SECONDS,
-      initial_retry_delay: MetronomeSDK::Client::DEFAULT_INITIAL_RETRY_DELAY,
-      max_retry_delay: MetronomeSDK::Client::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
     )
       base_url ||= "https://api.metronome.com"
 

data/lib/metronome_sdk/errors.rb

@@ -9,6 +9,28 @@ module MetronomeSDK
     end
 
     class ConversionError < MetronomeSDK::Errors::Error
+      # @return [StandardError, nil]
+      def cause = @cause.nil? ? super : @cause
+
+      # @api private
+      #
+      # @param on [Class<StandardError>]
+      # @param method [Symbol]
+      # @param target [Object]
+      # @param value [Object]
+      # @param cause [StandardError, nil]
+      def initialize(on:, method:, target:, value:, cause: nil)
+        cls = on.name.split("::").last
+
+        message = [
+          "Failed to parse #{cls}.#{method} from #{value.class} to #{target.inspect}.",
+          "To get the unparsed API response, use #{cls}[#{method.inspect}].",
+          cause && "Cause: #{cause.message}"
+        ].filter(&:itself).join(" ")
+
+        @cause = cause
+        super(message)
+      end
     end
 
     class APIError < MetronomeSDK::Errors::Error

data/lib/metronome_sdk/internal/transport/base_client.rb

@@ -474,6 +474,7 @@ module MetronomeSDK
           self.class.validate!(req)
           model = req.fetch(:model) { MetronomeSDK::Internal::Type::Unknown }
           opts = req[:options].to_h
+          unwrap = req[:unwrap]
           MetronomeSDK::RequestOptions.validate!(opts)
           request = build_request(req.except(:options), opts)
           url = request.fetch(:url)
@@ -490,11 +491,18 @@ module MetronomeSDK
           decoded = MetronomeSDK::Internal::Util.decode_content(response, stream: stream)
           case req
           in {stream: Class => st}
-            st.new(model: model, url: url, status: status, response: response, stream: decoded)
+            st.new(
+              model: model,
+              url: url,
+              status: status,
+              response: response,
+              unwrap: unwrap,
+              stream: decoded
+            )
           in {page: Class => page}
             page.new(client: self, req: req, headers: response, page_data: decoded)
           else
-            unwrapped = MetronomeSDK::Internal::Util.dig(decoded, req[:unwrap])
+            unwrapped = MetronomeSDK::Internal::Util.dig(decoded, unwrap)
             MetronomeSDK::Internal::Type::Converter.coerce(model, unwrapped)
           end
         end

data/lib/metronome_sdk/internal/transport/pooled_net_requester.rb

@@ -11,6 +11,8 @@ module MetronomeSDK
         # https://github.com/golang/go/blob/c8eced8580028328fde7c03cbfcb720ce15b2358/src/net/http/transport.go#L49
         KEEP_ALIVE_TIMEOUT = 30
 
+        DEFAULT_MAX_CONNECTIONS = [Etc.nprocessors, 99].max
+
         class << self
           # @api private
           #
@@ -184,7 +186,7 @@ module MetronomeSDK
         # @api private
         #
         # @param size [Integer]
-        def initialize(size: Etc.nprocessors)
+        def initialize(size: self.class::DEFAULT_MAX_CONNECTIONS)
           @mutex = Mutex.new
           @size = size
           @pools = {}

data/lib/metronome_sdk/internal/type/array_of.rb

@@ -12,6 +12,7 @@ module MetronomeSDK
       # Array of items of a given type.
       class ArrayOf
         include MetronomeSDK::Internal::Type::Converter
+        include MetronomeSDK::Internal::Util::SorbetRuntimeSupport
 
         private_class_method :new
 
@@ -61,10 +62,14 @@ module MetronomeSDK
         #
         # @param state [Hash{Symbol=>Object}] .
         #
-        #   @option state [Boolean, :strong] :strictness
+        #   @option state [Boolean] :translate_names
+        #
+        #   @option state [Boolean] :strictness
         #
         #   @option state [Hash{Symbol=>Object}] :exactness
         #
+        #   @option state [Class<StandardError>] :error
+        #
         #   @option state [Integer] :branched
         #
         # @return [Array<Object>, Object]
@@ -73,6 +78,7 @@ module MetronomeSDK
 
           unless value.is_a?(Array)
             exactness[:no] += 1
+            state[:error] = TypeError.new("#{value.class} can't be coerced into #{Array}")
             return value
           end
 
@@ -110,6 +116,13 @@ module MetronomeSDK
           end
         end
 
+        # @api private
+        #
+        # @return [Object]
+        def to_sorbet_type
+          T::Array[MetronomeSDK::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(item_type)]
+        end
+
         # @api private
         #
         # @return [generic<Elem>]