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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a44d5d1875ab2a3f6799d850de8e858790cf3b1effe78faf11aaf66cb63108bb
-  data.tar.gz: e8a0924693987951798904c088ba86857560fbf85a32948f1dde31a04cb2c1eb
+  metadata.gz: 1f9187736fec618127a408109837bbb6e2d715b3ae0debd060599129149fea1e
+  data.tar.gz: d41f6d4d3f47eae6467c52876975a9aa6c2aa40028bd35b364dfef51aa1f3593
 SHA512:
-  metadata.gz: 041527374ecc4da3c21f5b5971ac35962814ac7fbe8f80791b168b9daaff0cf2ab6360d6a0c98f5b63e41c4eecfa3edbbc29c5dda5cfdbd830a073a72b383dd3
-  data.tar.gz: 4f1c4fabe61b612eee4e20203a62c5c3cebe1df469d59cc9d6d299495f51fc9d5b489f82ed339b0008347ed6d04ee00d4026888410ee1bdc1565942fcf8869b5
+  metadata.gz: 337a65e90e271961a81fb9f54a24b9da95b8570043e2c62946638799c7ca15fb16f747e60db4fb81a2f7bf870210b4428e34ab1550a1229f4e4df2d23549bdf3
+  data.tar.gz: 73612d3f74abcd90e3ee46c16bbeb68837c3cb1da6206171ac0535a7e638e684e9c6495be268cf90f65d319ad2400d75f99628a049c0b171e301a89e72235c4c

data/CHANGELOG.md

@@ -1,5 +1,35 @@
 # Changelog
 
+## 0.2.0 (2025-07-31)
+
+Full Changelog: [v0.1.0...v0.2.0](https://github.com/Metronome-Industries/metronome-ruby/compare/v0.1.0...v0.2.0)
+
+### Features
+* **api:** Add support for spend threshold alerts for specific group keys. See [updated alert documentation](https://docs.metronome.com/manage-product-access/create-manage-alerts/#spend-alerts).
+* **api:** Add support for recurring commits linked to subscriptions. See documentation for [hybrid billing models](https://docs.metronome.com/launch-guides/hybrid-business/#implement-a-hybrid-model-for-a-customer).
+* **api:** Add support for new styles in embeddable dashboards.
+* **api:** Add reference to contract on commit objects.
+
+### Chores
+
+* **docs:** Improved documentation.
+
+## 0.1.0 (2025-07-24)
+
+Full Changelog: [v0.1.0-alpha.4...v0.1.0](https://github.com/Metronome-Industries/metronome-ruby/compare/v0.1.0-alpha.4...v0.1.0)
+
+### Features
+
+* **api:** Allow for Pagination past empty pages ([b608e5e](https://github.com/Metronome-Industries/metronome-ruby/commit/b608e5e7b9109f7859371c4816d07b4ccd25e976))
+* **api:** api update ([44cce30](https://github.com/Metronome-Industries/metronome-ruby/commit/44cce30fe4d15233fe4bb0b42cd46ceda2faa0a7))
+* **api:** api update ([d205568](https://github.com/Metronome-Industries/metronome-ruby/commit/d2055689feba86efebd0e926cf2c18a8f6682080))
+* **api:** api update ([ead65db](https://github.com/Metronome-Industries/metronome-ruby/commit/ead65db988e30be27317d6e0dfc57fc8a58f8aad))
+
+
+### Chores
+
+* **internal:** version bump ([eabd459](https://github.com/Metronome-Industries/metronome-ruby/commit/eabd459fc04f484ee853a336b2f0d30f6b2382b1))
+
 ## 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)

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.1.0.pre.alpha.4"
+gem "metronome-sdk", "~> 0.2.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/metronome_sdk/internal/cursor_page.rb

@@ -24,7 +24,7 @@ module MetronomeSDK
 
       # @return [Boolean]
       def next_page?
-        !data.to_a.empty? && !next_page_.to_s.empty?
+        !next_page_.to_s.empty?
       end
 
       # @raise [MetronomeSDK::HTTP::Error]

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

@@ -365,7 +365,7 @@ module MetronomeSDK
         #
         # @raise [MetronomeSDK::Errors::APIError]
         # @return [Array(Integer, Net::HTTPResponse, Enumerable<String>)]
-        private def send_request(request, redirect_count:, retry_count:, send_retry_header:)
+        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),

data/lib/metronome_sdk/models/commit.rb

@@ -103,7 +103,7 @@ module MetronomeSDK
       #   A list of ordered events that impact the balance of a commit. For example, an
       #   invoice deduction or a rollover.
       #
-      #   @return [Array<MetronomeSDK::Models::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitRolloverLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitExpirationLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCanceledLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCreditedLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitRolloverLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitTrueupLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitManualLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitManualLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitExpirationLedgerEntry>, nil]
+      #   @return [Array<MetronomeSDK::Models::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitRolloverLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitExpirationLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCanceledLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCreditedLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitRolloverLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitTrueupLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitManualLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitManualLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitExpirationLedgerEntry>, nil]
       optional :ledger, -> { MetronomeSDK::Internal::Type::ArrayOf[union: MetronomeSDK::Commit::Ledger] }
 
       # @!attribute name
@@ -198,7 +198,7 @@ module MetronomeSDK
       #
       #   @param invoice_schedule [MetronomeSDK::Models::SchedulePointInTime] The schedule that the customer will be invoiced for this commit.
       #
-      #   @param ledger [Array<MetronomeSDK::Models::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitRolloverLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitExpirationLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCanceledLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCreditedLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitRolloverLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitTrueupLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitManualLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitManualLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitExpirationLedgerEntry>] A list of ordered events that impact the balance of a commit. For example, an in
+      #   @param ledger [Array<MetronomeSDK::Models::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitRolloverLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitExpirationLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCanceledLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCreditedLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitRolloverLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitTrueupLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitManualLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitManualLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitExpirationLedgerEntry>] A list of ordered events that impact the balance of a commit. For example, an in
       #
       #   @param name [String]
       #
@@ -393,6 +393,8 @@ module MetronomeSDK
 
         variant -> { MetronomeSDK::Commit::Ledger::PrepaidCommitCreditedLedgerEntry }
 
+        variant -> { MetronomeSDK::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry }
+
         variant -> { MetronomeSDK::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry }
 
         variant -> { MetronomeSDK::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry }
@@ -477,12 +479,18 @@ module MetronomeSDK
                      MetronomeSDK::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry::Type
                    }
 
-          # @!method initialize(amount:, invoice_id:, segment_id:, timestamp:, type:)
+          # @!attribute contract_id
+          #
+          #   @return [String, nil]
+          optional :contract_id, String
+
+          # @!method initialize(amount:, invoice_id:, segment_id:, timestamp:, type:, contract_id: nil)
           #   @param amount [Float]
           #   @param invoice_id [String]
           #   @param segment_id [String]
           #   @param timestamp [Time]
           #   @param type [Symbol, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry::Type]
+          #   @param contract_id [String]
 
           # @see MetronomeSDK::Models::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry#type
           module Type
@@ -603,12 +611,18 @@ module MetronomeSDK
           #   @return [Symbol, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCanceledLedgerEntry::Type]
           required :type, enum: -> { MetronomeSDK::Commit::Ledger::PrepaidCommitCanceledLedgerEntry::Type }
 
-          # @!method initialize(amount:, invoice_id:, segment_id:, timestamp:, type:)
+          # @!attribute contract_id
+          #
+          #   @return [String, nil]
+          optional :contract_id, String
+
+          # @!method initialize(amount:, invoice_id:, segment_id:, timestamp:, type:, contract_id: nil)
           #   @param amount [Float]
           #   @param invoice_id [String]
           #   @param segment_id [String]
           #   @param timestamp [Time]
           #   @param type [Symbol, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCanceledLedgerEntry::Type]
+          #   @param contract_id [String]
 
           # @see MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCanceledLedgerEntry#type
           module Type
@@ -647,12 +661,18 @@ module MetronomeSDK
           #   @return [Symbol, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCreditedLedgerEntry::Type]
           required :type, enum: -> { MetronomeSDK::Commit::Ledger::PrepaidCommitCreditedLedgerEntry::Type }
 
-          # @!method initialize(amount:, invoice_id:, segment_id:, timestamp:, type:)
+          # @!attribute contract_id
+          #
+          #   @return [String, nil]
+          optional :contract_id, String
+
+          # @!method initialize(amount:, invoice_id:, segment_id:, timestamp:, type:, contract_id: nil)
           #   @param amount [Float]
           #   @param invoice_id [String]
           #   @param segment_id [String]
           #   @param timestamp [Time]
           #   @param type [Symbol, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCreditedLedgerEntry::Type]
+          #   @param contract_id [String]
 
           # @see MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCreditedLedgerEntry#type
           module Type
@@ -665,6 +685,47 @@ module MetronomeSDK
           end
         end
 
+        class PrepaidCommitSeatBasedAdjustmentLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute amount
+          #
+          #   @return [Float]
+          required :amount, Float
+
+          # @!attribute segment_id
+          #
+          #   @return [String]
+          required :segment_id, String
+
+          # @!attribute timestamp
+          #
+          #   @return [Time]
+          required :timestamp, Time
+
+          # @!attribute type
+          #
+          #   @return [Symbol, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry::Type]
+          required :type,
+                   enum: -> {
+                     MetronomeSDK::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry::Type
+                   }
+
+          # @!method initialize(amount:, segment_id:, timestamp:, type:)
+          #   @param amount [Float]
+          #   @param segment_id [String]
+          #   @param timestamp [Time]
+          #   @param type [Symbol, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry::Type]
+
+          # @see MetronomeSDK::Models::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry#type
+          module Type
+            extend MetronomeSDK::Internal::Type::Enum
+
+            PREPAID_COMMIT_SEAT_BASED_ADJUSTMENT = :PREPAID_COMMIT_SEAT_BASED_ADJUSTMENT
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
         class PostpaidCommitInitialBalanceLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
           # @!attribute amount
           #
@@ -729,12 +790,18 @@ module MetronomeSDK
                      MetronomeSDK::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry::Type
                    }
 
-          # @!method initialize(amount:, invoice_id:, segment_id:, timestamp:, type:)
+          # @!attribute contract_id
+          #
+          #   @return [String, nil]
+          optional :contract_id, String
+
+          # @!method initialize(amount:, invoice_id:, segment_id:, timestamp:, type:, contract_id: nil)
           #   @param amount [Float]
           #   @param invoice_id [String]
           #   @param segment_id [String]
           #   @param timestamp [Time]
           #   @param type [Symbol, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry::Type]
+          #   @param contract_id [String]
 
           # @see MetronomeSDK::Models::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry#type
           module Type
@@ -812,11 +879,17 @@ module MetronomeSDK
           #   @return [Symbol, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitTrueupLedgerEntry::Type]
           required :type, enum: -> { MetronomeSDK::Commit::Ledger::PostpaidCommitTrueupLedgerEntry::Type }
 
-          # @!method initialize(amount:, invoice_id:, timestamp:, type:)
+          # @!attribute contract_id
+          #
+          #   @return [String, nil]
+          optional :contract_id, String
+
+          # @!method initialize(amount:, invoice_id:, timestamp:, type:, contract_id: nil)
           #   @param amount [Float]
           #   @param invoice_id [String]
           #   @param timestamp [Time]
           #   @param type [Symbol, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitTrueupLedgerEntry::Type]
+          #   @param contract_id [String]
 
           # @see MetronomeSDK::Models::Commit::Ledger::PostpaidCommitTrueupLedgerEntry#type
           module Type
@@ -938,7 +1011,7 @@ module MetronomeSDK
         end
 
         # @!method self.variants
-        #   @return [Array(MetronomeSDK::Models::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitRolloverLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitExpirationLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCanceledLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCreditedLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitRolloverLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitTrueupLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitManualLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitManualLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitExpirationLedgerEntry)]
+        #   @return [Array(MetronomeSDK::Models::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitRolloverLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitExpirationLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCanceledLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCreditedLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitRolloverLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitTrueupLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitManualLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitManualLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitExpirationLedgerEntry)]
       end
 
       # @see MetronomeSDK::Models::Commit#rate_type