metronome-sdk 0.1.0.pre.alpha.1 → 0.1.0.pre.alpha.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a881fed2cf5ff5c2eabfc23eb2d229ec29288933edd7d3cbb2267d61e27096b
-  data.tar.gz: 28ce7dc9da20e9cb577dff3380d16bc071eb4bd2789ae5e3a67274fca31e8e0a
+  metadata.gz: 3a645770b02b7440ae82c30bcd41b416cca3d0c02650fa028b80ad469ae2af33
+  data.tar.gz: 607059caf25c134bc90370fc6bcc86e64a78ca3b8bffde779e7df6f95c9184ff
 SHA512:
-  metadata.gz: 4b557ed8d9c7de4e7a764937bedfeb25e5a26c6d9f6b68610b133bebab463cf0d943f8f5d37018e296415208c85bae92002244b7e6f3943e64b162f05c7c33fe
-  data.tar.gz: 3a2b97a7b75f283fc5f1468fb3bcbfbbf1a3d530f13105fcb9b80e37950c5b473946fd877e7a8801d476521c4c0ad2e567a2c4c2d8854f20fc73cef9161185a4
+  metadata.gz: 557dd905500c38ad75d825d159a590f01172d300003fd53c79b48b618f4a5386e7cc521c36be80bd456664e85189bf50528dcf5733fc2adbfec4a3949ef0fe47
+  data.tar.gz: c6a62d5582657414e56451293aa6ccbf3727bc47816f1747e1aacee986f9ae79bb07397200bcf7076312f1fcc0a4e45dd39cfa41c079182e013ebc9fdd28b351

data/CHANGELOG.md

@@ -1,5 +1,102 @@
 # Changelog
 
+## 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)
+
+### Features
+
+* **api:** api update ([a4f836d](https://github.com/Metronome-Industries/metronome-ruby/commit/a4f836d0ae211f507a54922859668ff35f94ce8e))
+* **api:** api update ([688aade](https://github.com/Metronome-Industries/metronome-ruby/commit/688aade989f1758a41c10b7f7fe7e45a58f698bd))
+* **api:** api update ([5ab431c](https://github.com/Metronome-Industries/metronome-ruby/commit/5ab431c2dc27ce3534f7d3afc3b4f5279438039d))
+* **api:** api update ([b2a6fc9](https://github.com/Metronome-Industries/metronome-ruby/commit/b2a6fc947c7b844733d8064ec0e69997aeee34ce))
+* **api:** api update ([01b3764](https://github.com/Metronome-Industries/metronome-ruby/commit/01b3764c3dcf27595b55098c751e1c2a93e5cfe5))
+* **api:** api update ([6046a6d](https://github.com/Metronome-Industries/metronome-ruby/commit/6046a6db516552be6164f54f3e810461a9c18bd1))
+* **api:** api update ([1aa390e](https://github.com/Metronome-Industries/metronome-ruby/commit/1aa390e7a464b8668e96574cf429b590ecc52914))
+* **api:** api update ([c03bee8](https://github.com/Metronome-Industries/metronome-ruby/commit/c03bee8d5f7c5b9db872275edf5b69f912be7e13))
+* **api:** api update ([9d59ec2](https://github.com/Metronome-Industries/metronome-ruby/commit/9d59ec25eed7f832cf734545fa50b3a5bd8c2bec))
+* **api:** api update ([2650244](https://github.com/Metronome-Industries/metronome-ruby/commit/26502443fad8129531a2a74dcd69593a1fa64823))
+* expose base client options as read only attributes ([4f569b2](https://github.com/Metronome-Industries/metronome-ruby/commit/4f569b2a9eee829bf49214da8f478f8588c600bb))
+* expose recursive `#to_h` conversion ([d780fc3](https://github.com/Metronome-Industries/metronome-ruby/commit/d780fc3aa31b3d1b9418d86626ca8366f9e9a6ce))
+* support sorbet aliases at the runtime ([9f251f3](https://github.com/Metronome-Industries/metronome-ruby/commit/9f251f3d72fe0032aa22feeed55417ac3ea87315))
+
+
+### Bug Fixes
+
+* **internal:** ensure formatting always uses c.utf-8 locale ([47ab8ad](https://github.com/Metronome-Industries/metronome-ruby/commit/47ab8ad4e70b382911b002a5d06c637ebb63e9f2))
+* **internal:** fix formatting script for macos ([cd28a47](https://github.com/Metronome-Industries/metronome-ruby/commit/cd28a47d72d6e2c0ca42348bb0851ce5d10a7c5b))
+* **internal:** update gemspec name ([1e9d5b2](https://github.com/Metronome-Industries/metronome-ruby/commit/1e9d5b242fb7a15182ce0908bc7dd2ce141f67e0))
+
+
+### Chores
+
+* accept all nd-json mimetype variants ([c8cc15c](https://github.com/Metronome-Industries/metronome-ruby/commit/c8cc15c35825ca171c9f831924d854bcf29a71f0))
+* always check if current page is empty in `next_page?` ([af6bc25](https://github.com/Metronome-Industries/metronome-ruby/commit/af6bc253a97f594f109516027a76fb3ae143a529))
+* fix misc linting / minor issues ([afd7f7c](https://github.com/Metronome-Industries/metronome-ruby/commit/afd7f7c2cd1ced12d750a19bb97c1789160d329b))
+* **internal:** codegen related update ([4c6b071](https://github.com/Metronome-Industries/metronome-ruby/commit/4c6b071f35043f8f449a489fb893f83103933afa))
+* **internal:** codegen related update ([ce299e2](https://github.com/Metronome-Industries/metronome-ruby/commit/ce299e225e9d43e7e7e55bfd057ffaa32d958368))
+* **internal:** codegen related update ([f5b8a2b](https://github.com/Metronome-Industries/metronome-ruby/commit/f5b8a2b7e65c01e6bffd12f2c505bf175309b197))
+* **internal:** codegen related update ([4e241c7](https://github.com/Metronome-Industries/metronome-ruby/commit/4e241c7c11c917708bca0abea5e9723922b3dc09))
+* loosen rubocop rules that don't always make sense ([f69c36b](https://github.com/Metronome-Industries/metronome-ruby/commit/f69c36bb3fac830b3142cfceab8bb190c3c47c4f))
+* migrate away from deprecated `JSON#fast_generate` ([8b10970](https://github.com/Metronome-Industries/metronome-ruby/commit/8b109703a565463d836b639dc1bd8770dfd4d650))
+* re-export top level models under library namespace ([2498d75](https://github.com/Metronome-Industries/metronome-ruby/commit/2498d75c53a4aa16a05dd1776d2d1d2ca8c14815))
+* remove Gemfile.lock during bootstrap ([459e324](https://github.com/Metronome-Industries/metronome-ruby/commit/459e324ac0108b3bc68e8c0a173e36dcd0242019))
+* reorganize type aliases ([bc60bc8](https://github.com/Metronome-Industries/metronome-ruby/commit/bc60bc83989da9809c45477034015c6e993e5827))
+* revert ignoring Gemfile.lock ([51f355e](https://github.com/Metronome-Industries/metronome-ruby/commit/51f355ec8087755200d92f1c499ee694d187288d))
+* validate request option coercion correctness ([940e426](https://github.com/Metronome-Industries/metronome-ruby/commit/940e4261d5730dc65821703c5bb64971331f4be4))
+
+
+### Documentation
+
+* illustrate environmental defaults for auth variables ([731c295](https://github.com/Metronome-Industries/metronome-ruby/commit/731c2954a9fa2c3b60f6243a02b0afdefaf738c4))
+* **readme:** fix typo ([c88281b](https://github.com/Metronome-Industries/metronome-ruby/commit/c88281b645e5f0c4cd1ec042cb8a4db0f83c156c))
+* remove or fix invalid readme examples ([780d102](https://github.com/Metronome-Industries/metronome-ruby/commit/780d10248cd977d4d7cb6c5d99f3e60db5716ef0))
+
 ## 0.1.0-alpha.1 (2025-04-28)
 
 Full Changelog: [v0.0.1-alpha.0...v0.1.0-alpha.1](https://github.com/Metronome-Industries/metronome-ruby/compare/v0.0.1-alpha.0...v0.1.0-alpha.1)

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.1.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.1"
+gem "metronome-sdk", "~> 0.1.0.pre.alpha.3"
 ```
 
 <!-- x-release-please-end -->
@@ -29,7 +29,7 @@ require "bundler/setup"
 require "metronome_sdk"
 
 metronome = MetronomeSDK::Client.new(
-  bearer_token: "My Bearer Token" # defaults to ENV["METRONOME_BEARER_TOKEN"]
+  bearer_token: ENV["METRONOME_BEARER_TOKEN"] # This is the default and can be omitted
 )
 
 result = metronome.v1.usage.ingest(
@@ -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::Models::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,19 +66,37 @@ 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:
 
 ```ruby
 begin
-  contract = metronome.v1.contracts.create
-rescue MetronomeSDK::Errors::APIError => e
-  puts(e.status) # 400
+  contract = metronome.v1.contracts.create(
+    customer_id: "13117714-3f05-48e5-a6e9-a66093f13b4d",
+    starting_at: "2020-01-01T00:00:00.000Z"
+  )
+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
 ```
 
-Error codes are as followed:
+Error codes are as follows:
 
 | Cause            | Error Type                 |
 | ---------------- | -------------------------- |
@@ -129,16 +127,16 @@ metronome = MetronomeSDK::Client.new(
 )
 
 # Or, configure per-request:
-metronome.v1.contracts.create(request_options: {max_retries: 5})
+metronome.v1.contracts.create(
+  customer_id: "13117714-3f05-48e5-a6e9-a66093f13b4d",
+  starting_at: "2020-01-01T00:00:00.000Z",
+  request_options: {max_retries: 5}
+)
 ```
 
 ### 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:
@@ -147,60 +145,61 @@ metronome = MetronomeSDK::Client.new(
 )
 
 # Or, configure per-request:
-metronome.v1.contracts.create(request_options: {timeout: 5})
+metronome.v1.contracts.create(
+  customer_id: "13117714-3f05-48e5-a6e9-a66093f13b4d",
+  starting_at: "2020-01-01T00:00:00.000Z",
+  request_options: {timeout: 5}
+)
 ```
 
-## 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::Models::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/undocumented requests
+### Making custom or undocumented requests
+
+#### Undocumented properties
+
+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(
@@ -208,30 +207,60 @@ 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
+
+This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitions, and has no dependency on sorbet-runtime.
 
-### Sorbet
+You can provide typesafe request parameters like so:
 
-#### Argument passing trick
+```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"}
+    )
+  ]
+)
+```
 
-It is possible to pass a compatible model / parameter class to a method that expects keyword arguments by using the `**` splat operator.
+Or, equivalently:
 
 ```ruby
-params = MetronomeSDK::Models::V1::UsageIngestParams.new(
+# Hashes work, but are not typesafe:
+metronome.v1.usage.ingest(
   usage: [
-    MetronomeSDK::Models::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"}
+    }
+  ]
+)
+
+# 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",
       customer_id: "team@example.com",
       event_type: "heartbeat",
@@ -243,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.
@@ -251,7 +308,7 @@ 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
 

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

@@ -99,7 +99,7 @@ module MetronomeSDK
       # @param response [nil]
       # @param message [String, nil]
       #
-      # @return [MetronomeSDK::Errors::APIStatusError]
+      # @return [self]
       def self.for(url:, status:, body:, request:, response:, message: nil)
         kwargs = {
           url: url,

data/lib/metronome_sdk/file_part.rb

@@ -45,9 +45,9 @@ module MetronomeSDK
       @filename =
         case content
         in Pathname
-          filename.nil? ? content.basename.to_path : File.basename(filename)
+          filename.nil? ? content.basename.to_path : ::File.basename(filename)
         else
-          filename.nil? ? nil : File.basename(filename)
+          filename.nil? ? nil : ::File.basename(filename)
         end
       @content_type = content_type
     end

data/lib/metronome_sdk/internal/cursor_page.rb

@@ -24,7 +24,7 @@ module MetronomeSDK
 
       # @return [Boolean]
       def next_page?
-        !next_page_.nil?
+        !data.to_a.empty? && !next_page_.to_s.empty?
       end
 
       # @raise [MetronomeSDK::HTTP::Error]
@@ -67,8 +67,8 @@ module MetronomeSDK
 
         @next_page_ = page_data[:next_page]
         case page_data
-        in {data: Array | nil => data}
-          @data = data&.map { MetronomeSDK::Internal::Type::Converter.coerce(@model, _1) }
+        in {data: Array => data}
+          @data = data.map { MetronomeSDK::Internal::Type::Converter.coerce(@model, _1) }
         else
         end
       end