metronome-sdk 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b6d2ecfc5a635976f250cecb6fa6c7b332f5779a7f947aa9fec0a3bdbe709ac
-  data.tar.gz: 9f2e2e93d6e3582458bb1a147ab3961df59656ff060e379b9e82c9a3014eefc8
+  metadata.gz: 2446e983c08f573e1756e7aeb0fd0cac0d67056f18c3c0464e2d0422f63aa2f2
+  data.tar.gz: 282cfc878a3a3d74b38184a1b473a9080e265fb0224ee7b3d2dce2ae5aa7caab
 SHA512:
-  metadata.gz: 819a57ee71e4d1f8220dd90b691fed840c893225ef19e80196660bdfe8acdbe915babaa211881ab69c463e1886607203ffadb0f3ff7b0e64aa6123081c1fbd51
-  data.tar.gz: 80a9dcdb292e99ca7dc6759fe7c4694f2d48a50bfe272a650ef2901a85f7b70e02c013baca5e5385e5b0c7944fc28473d0f822cf4aa1838d683625851ce32fef
+  metadata.gz: a379c84d235c7957ca683790821b637b2eac2f86ca46c0bc31c6093b699974b89e3e1def7092aee0b692dda2acb1cc76109a9e588b37c1f4b248203e2090d659
+  data.tar.gz: 621e6552b720ac41ef0bff931ddfbdfa22c0eec89ca9a2c143c930ee631dcb67fe7c24c428bd7f521a704e734834aad81079ee7ac1e6261bcc035233d016cbcc

data/CHANGELOG.md

@@ -1,5 +1,41 @@
 # Changelog
 
+## 1.0.0 (2025-09-15)
+
+Full Changelog: [v0.3.0...v1.0.0](https://github.com/Metronome-Industries/metronome-ruby/compare/v0.3.0...v1.0.0)
+
+### ⚠ BREAKING CHANGES
+
+* **api:** add pagination support to multiple endpoints - Added pagination to CustomerList, AlertList, InvoiceList, CommitList, CreditList, CreditGrantList, CustomerAlerts, UsageList, CustomFields list, and ContractListBalances endpoints.
+* **api:** enhance subscriptions and commits/credits - Added Individual enum to SubscriptionConfig and rate_type enums to UpdateCredit/UpdateCommit.
+* **api:** add comprehensive shared types to SDK - Added 34 new shared types including BaseThresholdCommit, BaseUsageFilter, Commit, CommitHierarchyConfiguration, CommitRate, CommitSpecifier, CommitSpecifierInput, Contract, ContractV2, ContractWithoutAmendments, Credit, CreditTypeData, Discount, EventTypeFilter, HierarchyConfiguration, ID, Override, OverrideTier, OverwriteRate, PaymentGateConfig, PaymentGateConfigV2, PrepaidBalanceThresholdConfiguration, PrepaidBalanceThresholdConfigurationV2, PropertyFilter, ProService, Rate, RecurringCommitSubscriptionConfig, ScheduledCharge, ScheduleDuration, SchedulePointInTime, SpendThresholdConfiguration, SpendThresholdConfigurationV2, Subscription, Tier, and UpdateBaseThresholdCommit.
+
+### Features
+
+* **api:** add archived_at field to CustomerBillingConfiguration ([8eb235f](https://github.com/Metronome-Industries/metronome-ruby/commit/8eb235f643fec7937b291ce3435598b5e09f0081))
+* **api:** add comprehensive shared types to SDK - Added 34 new shared types including BaseThresholdCommit, BaseUsageFilter, Commit, CommitHierarchyConfiguration, CommitRate, CommitSpecifier, CommitSpecifierInput, Contract, ContractV2, ContractWithoutAmendments, Credit, CreditTypeData, Discount, EventTypeFilter, HierarchyConfiguration, ID, Override, OverrideTier, OverwriteRate, PaymentGateConfig, PaymentGateConfigV2, PrepaidBalanceThresholdConfiguration, PrepaidBalanceThresholdConfigurationV2, PropertyFilter, ProService, Rate, RecurringCommitSubscriptionConfig, ScheduledCharge, ScheduleDuration, SchedulePointInTime, SpendThresholdConfiguration, SpendThresholdConfigurationV2, Subscription, Tier, and UpdateBaseThresholdCommit. ([8eb235f](https://github.com/Metronome-Industries/metronome-ruby/commit/8eb235f643fec7937b291ce3435598b5e09f0081))
+* **api:** add created_at field to Commit ([8eb235f](https://github.com/Metronome-Industries/metronome-ruby/commit/8eb235f643fec7937b291ce3435598b5e09f0081))
+* **api:** add customer billing configuration endpoints - Added set and retrieve endpoints for customer billing configurations. ([8eb235f](https://github.com/Metronome-Industries/metronome-ruby/commit/8eb235f643fec7937b291ce3435598b5e09f0081))
+* **api:** add pagination support to multiple endpoints - Added pagination to CustomerList, AlertList, InvoiceList, CommitList, CreditList, CreditGrantList, CustomerAlerts, UsageList, CustomFields list, and ContractListBalances endpoints. ([8eb235f](https://github.com/Metronome-Industries/metronome-ruby/commit/8eb235f643fec7937b291ce3435598b5e09f0081))
+* **api:** Add support for granular spend threshold alerts with group key filters. ([8eb235f](https://github.com/Metronome-Industries/metronome-ruby/commit/8eb235f643fec7937b291ce3435598b5e09f0081))
+* **api:** enhance subscriptions and commits/credits - Added Individual enum to SubscriptionConfig and rate_type enums to UpdateCredit/UpdateCommit. ([8eb235f](https://github.com/Metronome-Industries/metronome-ruby/commit/8eb235f643fec7937b291ce3435598b5e09f0081))
+
+
+### Bug Fixes
+
+* bump sorbet version and fix new type errors from the breaking change ([8eb235f](https://github.com/Metronome-Industries/metronome-ruby/commit/8eb235f643fec7937b291ce3435598b5e09f0081))
+
+
+### Chores
+
+* add json schema comment for rubocop.yml ([8eb235f](https://github.com/Metronome-Industries/metronome-ruby/commit/8eb235f643fec7937b291ce3435598b5e09f0081))
+* revert version bump ([d7acdc6](https://github.com/Metronome-Industries/metronome-ruby/commit/d7acdc6fe3c9ecd51ecb5d67b3033280d02400b6))
+
+
+### Documentation
+
+* enhance API documentation - Added more detailed descriptions and styling improvements, and enhanced usage filter documentation with additional context. ([8eb235f](https://github.com/Metronome-Industries/metronome-ruby/commit/8eb235f643fec7937b291ce3435598b5e09f0081))
+
 ## 0.3.0 (2025-08-15)
 
 Full Changelog: [v0.2.0...v0.3.0](https://github.com/Metronome-Industries/metronome-ruby/compare/v0.2.0...v0.3.0)

data/README.md

@@ -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.3.0"
+gem "metronome-sdk", "~> 1.0.0"
 ```
 
 <!-- x-release-please-end -->
@@ -277,25 +277,25 @@ metronome.v1.usage.ingest(**params)
 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)
+# :LIST_RATE
+puts(MetronomeSDK::V2::ContractEditCommitParams::RateType::LIST_RATE)
 
-# Revealed type: `T.all(MetronomeSDK::V1::AlertCreateParams::AlertType, Symbol)`
-T.reveal_type(MetronomeSDK::V1::AlertCreateParams::AlertType::LOW_CREDIT_BALANCE_REACHED)
+# Revealed type: `T.all(MetronomeSDK::V2::ContractEditCommitParams::RateType, Symbol)`
+T.reveal_type(MetronomeSDK::V2::ContractEditCommitParams::RateType::LIST_RATE)
 ```
 
 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,
+metronome.v2.contracts.edit_commit(
+  rate_type: MetronomeSDK::V2::ContractEditCommitParams::RateType::LIST_RATE,
   # …
 )
 
 # Literal values are also permissible:
-metronome.v1.alerts.create(
-  alert_type: :low_credit_balance_reached,
+metronome.v2.contracts.edit_commit(
+  rate_type: :LIST_RATE,
   # …
 )
 ```

data/lib/metronome_sdk/internal/body_cursor_page.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Internal
+    # @generic Elem
+    #
+    # @example
+    #   if body_cursor_page.has_next?
+    #     body_cursor_page = body_cursor_page.next_page
+    #   end
+    #
+    # @example
+    #   body_cursor_page.auto_paging_each do |commit|
+    #     puts(commit)
+    #   end
+    class BodyCursorPage
+      include MetronomeSDK::Internal::Type::BasePage
+
+      # @return [String]
+      attr_accessor :next_page_
+
+      # @return [Array<generic<Elem>>, nil]
+      attr_accessor :data
+
+      # @return [Boolean]
+      def next_page?
+        !next_page_.to_s.empty?
+      end
+
+      # @raise [MetronomeSDK::HTTP::Error]
+      # @return [self]
+      def next_page
+        unless next_page?
+          message = "No more pages available. Please check #next_page? before calling ##{__method__}"
+          raise RuntimeError.new(message)
+        end
+
+        req = MetronomeSDK::Internal::Util.deep_merge(@req, {body: {next_page: next_page_}})
+        @client.request(req)
+      end
+
+      # @param blk [Proc]
+      #
+      # @yieldparam [generic<Elem>]
+      def auto_paging_each(&blk)
+        unless block_given?
+          raise ArgumentError.new("A block must be given to ##{__method__}")
+        end
+
+        page = self
+        loop do
+          page.data&.each(&blk)
+
+          break unless page.next_page?
+          page = page.next_page
+        end
+      end
+
+      # @api private
+      #
+      # @param client [MetronomeSDK::Internal::Transport::BaseClient]
+      # @param req [Hash{Symbol=>Object}]
+      # @param headers [Hash{String=>String}, Net::HTTPHeader]
+      # @param page_data [Hash{Symbol=>Object}]
+      def initialize(client:, req:, headers:, page_data:)
+        super
+
+        @next_page_ = page_data[:next_page]
+        case page_data
+        in {data: Array => data}
+          @data = data.map { MetronomeSDK::Internal::Type::Converter.coerce(@model, _1) }
+        else
+        end
+      end
+
+      # @api private
+      #
+      # @return [String]
+      def inspect
+        model = MetronomeSDK::Internal::Type::Converter.inspect(@model, depth: 1)
+
+        "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)} next_page_=#{next_page_.inspect}>"
+      end
+    end
+  end
+end

data/lib/metronome_sdk/internal/cursor_page_without_limit.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Internal
+    # @generic Elem
+    #
+    # @example
+    #   if cursor_page_without_limit.has_next?
+    #     cursor_page_without_limit = cursor_page_without_limit.next_page
+    #   end
+    #
+    # @example
+    #   cursor_page_without_limit.auto_paging_each do |credit_grant|
+    #     puts(credit_grant)
+    #   end
+    class CursorPageWithoutLimit
+      include MetronomeSDK::Internal::Type::BasePage
+
+      # @return [String]
+      attr_accessor :next_page_
+
+      # @return [Array<generic<Elem>>, nil]
+      attr_accessor :data
+
+      # @return [Boolean]
+      def next_page?
+        !next_page_.to_s.empty?
+      end
+
+      # @raise [MetronomeSDK::HTTP::Error]
+      # @return [self]
+      def next_page
+        unless next_page?
+          message = "No more pages available. Please check #next_page? before calling ##{__method__}"
+          raise RuntimeError.new(message)
+        end
+
+        req = MetronomeSDK::Internal::Util.deep_merge(@req, {query: {next_page: next_page_}})
+        @client.request(req)
+      end
+
+      # @param blk [Proc]
+      #
+      # @yieldparam [generic<Elem>]
+      def auto_paging_each(&blk)
+        unless block_given?
+          raise ArgumentError.new("A block must be given to ##{__method__}")
+        end
+
+        page = self
+        loop do
+          page.data&.each(&blk)
+
+          break unless page.next_page?
+          page = page.next_page
+        end
+      end
+
+      # @api private
+      #
+      # @param client [MetronomeSDK::Internal::Transport::BaseClient]
+      # @param req [Hash{Symbol=>Object}]
+      # @param headers [Hash{String=>String}, Net::HTTPHeader]
+      # @param page_data [Hash{Symbol=>Object}]
+      def initialize(client:, req:, headers:, page_data:)
+        super
+
+        @next_page_ = page_data[:next_page]
+        case page_data
+        in {data: Array => data}
+          @data = data.map { MetronomeSDK::Internal::Type::Converter.coerce(@model, _1) }
+        else
+        end
+      end
+
+      # @api private
+      #
+      # @return [String]
+      def inspect
+        model = MetronomeSDK::Internal::Type::Converter.inspect(@model, depth: 1)
+
+        "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)} next_page_=#{next_page_.inspect}>"
+      end
+    end
+  end
+end

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

@@ -367,10 +367,7 @@ module MetronomeSDK
         # @return [Array(Integer, Net::HTTPResponse, Enumerable<String>)]
         def send_request(request, redirect_count:, retry_count:, send_retry_header:)
           url, headers, max_retries, timeout = request.fetch_values(:url, :headers, :max_retries, :timeout)
-          input = {
-            **request.except(:timeout),
-            deadline: MetronomeSDK::Internal::Util.monotonic_secs + timeout
-          }
+          input = {**request.except(:timeout), deadline: MetronomeSDK::Internal::Util.monotonic_secs + timeout}
 
           if send_retry_header
             headers["x-stainless-retry-count"] = retry_count.to_s

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

@@ -193,15 +193,7 @@ module MetronomeSDK
         end
 
         define_sorbet_constant!(:Request) do
-          T.type_alias do
-            {
-              method: Symbol,
-              url: URI::Generic,
-              headers: T::Hash[String, String],
-              body: T.anything,
-              deadline: Float
-            }
-          end
+          T.type_alias { {method: Symbol, url: URI::Generic, headers: T::Hash[String, String], body: T.anything, deadline: Float} }
         end
       end
     end

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

@@ -64,14 +64,7 @@ module MetronomeSDK
             setter = :"#{name_sym}="
             api_name = info.fetch(:api_name, name_sym)
             nilable = info.fetch(:nil?, false)
-            const = if required && !nilable
-              info.fetch(
-                :const,
-                MetronomeSDK::Internal::OMIT
-              )
-            else
-              MetronomeSDK::Internal::OMIT
-            end
+            const = required && !nilable ? info.fetch(:const, MetronomeSDK::Internal::OMIT) : MetronomeSDK::Internal::OMIT
 
             [name_sym, setter].each { undef_method(_1) } if known_fields.key?(name_sym)
 
@@ -445,11 +438,11 @@ module MetronomeSDK
         # @return [Hash{Symbol=>Object}]
         #
         # @example
-        #   # `base_usage_filter` is a `MetronomeSDK::BaseUsageFilter`
-        #   base_usage_filter => {
-        #     group_key: group_key,
-        #     group_values: group_values,
-        #     starting_at: starting_at
+        #   # `base_threshold_commit` is a `MetronomeSDK::BaseThresholdCommit`
+        #   base_threshold_commit => {
+        #     product_id: product_id,
+        #     description: description,
+        #     name: name
         #   }
         def deconstruct_keys(keys)
           (keys || self.class.known_fields.keys)

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

@@ -4,6 +4,17 @@ module MetronomeSDK
   module Internal
     module Type
       # @api private
+      #
+      # @example
+      #   # `hierarchy_configuration` is a `MetronomeSDK::HierarchyConfiguration`
+      #   case hierarchy_configuration
+      #   when MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration
+      #     puts(hierarchy_configuration.children)
+      #   when MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration
+      #     puts(hierarchy_configuration.parent)
+      #   else
+      #     puts(hierarchy_configuration)
+      #   end
       module Union
         include MetronomeSDK::Internal::Type::Converter
         include MetronomeSDK::Internal::Util::SorbetRuntimeSupport

data/lib/metronome_sdk/internal/util.rb

@@ -244,7 +244,7 @@ module MetronomeSDK
         #
         # @return [String]
         def uri_origin(uri)
-          "#{uri.scheme}://#{uri.host}#{uri.port == uri.default_port ? '' : ":#{uri.port}"}"
+          "#{uri.scheme}://#{uri.host}#{":#{uri.port}" unless uri.port == uri.default_port}"
         end
 
         # @api private

data/lib/metronome_sdk/models/base_threshold_commit.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    class BaseThresholdCommit < MetronomeSDK::Internal::Type::BaseModel
+      # @!attribute product_id
+      #   The commit product that will be used to generate the line item for commit
+      #   payment.
+      #
+      #   @return [String]
+      required :product_id, String
+
+      # @!attribute description
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!attribute name
+      #   Specify the name of the line item for the threshold charge. If left blank, it
+      #   will default to the commit product name.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!method initialize(product_id:, description: nil, name: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {MetronomeSDK::Models::BaseThresholdCommit} for more details.
+      #
+      #   @param product_id [String] The commit product that will be used to generate the line item for commit paymen
+      #
+      #   @param description [String]
+      #
+      #   @param name [String] Specify the name of the line item for the threshold charge. If left blank, it wi
+    end
+  end
+end