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

data/lib/metronome_sdk/resources/v1/alerts.rb

@@ -9,7 +9,7 @@ module MetronomeSDK
         #
         # Create a new alert
         #
-        # @overload create(alert_type:, name:, threshold:, billable_metric_id: nil, credit_grant_type_filters: nil, credit_type_id: nil, custom_field_filters: nil, customer_id: nil, evaluate_on_create: nil, group_key_filter: nil, invoice_types_filter: nil, plan_id: nil, uniqueness_key: nil, request_options: {})
+        # @overload create(alert_type:, name:, threshold:, billable_metric_id: nil, credit_grant_type_filters: nil, credit_type_id: nil, custom_field_filters: nil, customer_id: nil, evaluate_on_create: nil, group_values: nil, invoice_types_filter: nil, plan_id: nil, uniqueness_key: nil, request_options: {})
         #
         # @param alert_type [Symbol, MetronomeSDK::Models::V1::AlertCreateParams::AlertType] Type of the alert
         #
@@ -29,7 +29,7 @@ module MetronomeSDK
         #
         # @param evaluate_on_create [Boolean] If true, the alert will evaluate immediately on customers that already meet the
         #
-        # @param group_key_filter [MetronomeSDK::Models::V1::AlertCreateParams::GroupKeyFilter] Scopes alert evaluation to a specific presentation group key on individual line
+        # @param group_values [Array<MetronomeSDK::Models::V1::AlertCreateParams::GroupValue>] Only present for `spend_threshold_reached` alerts. Scope alert to a specific gro
         #
         # @param invoice_types_filter [Array<String>] Only supported for invoice_total_reached alerts. A list of invoice types to eval
         #

data/lib/metronome_sdk/resources/v1/contracts.rb

@@ -314,7 +314,7 @@ module MetronomeSDK
         #
         # List balances (commits and credits).
         #
-        # @overload list_balances(customer_id:, id: nil, covering_date: nil, effective_before: nil, include_archived: nil, include_balance: nil, include_contract_balances: nil, include_ledgers: nil, next_page: nil, starting_at: nil, request_options: {})
+        # @overload list_balances(customer_id:, id: nil, covering_date: nil, effective_before: nil, include_archived: nil, include_balance: nil, include_contract_balances: nil, include_ledgers: nil, limit: nil, next_page: nil, starting_at: nil, request_options: {})
         #
         # @param customer_id [String]
         #
@@ -332,6 +332,8 @@ module MetronomeSDK
         #
         # @param include_ledgers [Boolean] Include ledgers in the response. Setting this flag may cause the query to be slo
         #
+        # @param limit [Integer] The maximum number of commits to return. Defaults to 25.
+        #
         # @param next_page [String] The next page token from a previous response.
         #
         # @param starting_at [Time] Include only balances that have any access on or after the provided date

data/lib/metronome_sdk/resources/v1/customers/commits.rb

@@ -69,7 +69,7 @@ module MetronomeSDK
           #
           # List commits.
           #
-          # @overload list(customer_id:, commit_id: nil, covering_date: nil, effective_before: nil, include_archived: nil, include_balance: nil, include_contract_commits: nil, include_ledgers: nil, next_page: nil, starting_at: nil, request_options: {})
+          # @overload list(customer_id:, commit_id: nil, covering_date: nil, effective_before: nil, include_archived: nil, include_balance: nil, include_contract_commits: nil, include_ledgers: nil, limit: nil, next_page: nil, starting_at: nil, request_options: {})
           #
           # @param customer_id [String]
           #
@@ -87,6 +87,8 @@ module MetronomeSDK
           #
           # @param include_ledgers [Boolean] Include commit ledgers in the response. Setting this flag may cause the query to
           #
+          # @param limit [Integer] The maximum number of commits to return. Defaults to 25.
+          #
           # @param next_page [String] The next page token from a previous response.
           #
           # @param starting_at [Time] Include only commits that have any access on or after the provided date

data/lib/metronome_sdk/resources/v1/customers/credits.rb

@@ -63,7 +63,7 @@ module MetronomeSDK
           #
           # List credits.
           #
-          # @overload list(customer_id:, covering_date: nil, credit_id: nil, effective_before: nil, include_archived: nil, include_balance: nil, include_contract_credits: nil, include_ledgers: nil, next_page: nil, starting_at: nil, request_options: {})
+          # @overload list(customer_id:, covering_date: nil, credit_id: nil, effective_before: nil, include_archived: nil, include_balance: nil, include_contract_credits: nil, include_ledgers: nil, limit: nil, next_page: nil, starting_at: nil, request_options: {})
           #
           # @param customer_id [String]
           #
@@ -81,6 +81,8 @@ module MetronomeSDK
           #
           # @param include_ledgers [Boolean] Include credit ledgers in the response. Setting this flag may cause the query to
           #
+          # @param limit [Integer] The maximum number of commits to return. Defaults to 25.
+          #
           # @param next_page [String] The next page token from a previous response.
           #
           # @param starting_at [Time] Include only credits that have any access on or after the provided date

data/lib/metronome_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MetronomeSDK
-  VERSION = "0.1.0.pre.alpha.4"
+  VERSION = "0.2.0"
 end

data/rbi/metronome_sdk/internal/transport/base_client.rbi

@@ -221,7 +221,7 @@ module MetronomeSDK
             send_retry_header: T::Boolean
           ).returns([Integer, Net::HTTPResponse, T::Enumerable[String]])
         end
-        private def send_request(
+        def send_request(
           request,
           redirect_count:,
           retry_count:,

data/rbi/metronome_sdk/models/commit.rbi

@@ -145,6 +145,7 @@ module MetronomeSDK
                 MetronomeSDK::Commit::Ledger::PrepaidCommitExpirationLedgerEntry::OrHash,
                 MetronomeSDK::Commit::Ledger::PrepaidCommitCanceledLedgerEntry::OrHash,
                 MetronomeSDK::Commit::Ledger::PrepaidCommitCreditedLedgerEntry::OrHash,
+                MetronomeSDK::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry::OrHash,
                 MetronomeSDK::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry::OrHash,
                 MetronomeSDK::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry::OrHash,
                 MetronomeSDK::Commit::Ledger::PostpaidCommitRolloverLedgerEntry::OrHash,
@@ -259,6 +260,7 @@ module MetronomeSDK
                 MetronomeSDK::Commit::Ledger::PrepaidCommitExpirationLedgerEntry::OrHash,
                 MetronomeSDK::Commit::Ledger::PrepaidCommitCanceledLedgerEntry::OrHash,
                 MetronomeSDK::Commit::Ledger::PrepaidCommitCreditedLedgerEntry::OrHash,
+                MetronomeSDK::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry::OrHash,
                 MetronomeSDK::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry::OrHash,
                 MetronomeSDK::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry::OrHash,
                 MetronomeSDK::Commit::Ledger::PostpaidCommitRolloverLedgerEntry::OrHash,
@@ -738,6 +740,7 @@ module MetronomeSDK
               MetronomeSDK::Commit::Ledger::PrepaidCommitExpirationLedgerEntry,
               MetronomeSDK::Commit::Ledger::PrepaidCommitCanceledLedgerEntry,
               MetronomeSDK::Commit::Ledger::PrepaidCommitCreditedLedgerEntry,
+              MetronomeSDK::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry,
               MetronomeSDK::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry,
               MetronomeSDK::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry,
               MetronomeSDK::Commit::Ledger::PostpaidCommitRolloverLedgerEntry,
@@ -857,6 +860,12 @@ module MetronomeSDK
           end
           attr_accessor :type
 
+          sig { returns(T.nilable(String)) }
+          attr_reader :contract_id
+
+          sig { params(contract_id: String).void }
+          attr_writer :contract_id
+
           sig do
             params(
               amount: Float,
@@ -864,10 +873,18 @@ module MetronomeSDK
               segment_id: String,
               timestamp: Time,
               type:
-                MetronomeSDK::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry::Type::OrSymbol
+                MetronomeSDK::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry::Type::OrSymbol,
+              contract_id: String
             ).returns(T.attached_class)
           end
-          def self.new(amount:, invoice_id:, segment_id:, timestamp:, type:)
+          def self.new(
+            amount:,
+            invoice_id:,
+            segment_id:,
+            timestamp:,
+            type:,
+            contract_id: nil
+          )
           end
 
           sig do
@@ -878,7 +895,8 @@ module MetronomeSDK
                 segment_id: String,
                 timestamp: Time,
                 type:
-                  MetronomeSDK::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry::Type::TaggedSymbol
+                  MetronomeSDK::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry::Type::TaggedSymbol,
+                contract_id: String
               }
             )
           end
@@ -1116,6 +1134,12 @@ module MetronomeSDK
           end
           attr_accessor :type
 
+          sig { returns(T.nilable(String)) }
+          attr_reader :contract_id
+
+          sig { params(contract_id: String).void }
+          attr_writer :contract_id
+
           sig do
             params(
               amount: Float,
@@ -1123,10 +1147,18 @@ module MetronomeSDK
               segment_id: String,
               timestamp: Time,
               type:
-                MetronomeSDK::Commit::Ledger::PrepaidCommitCanceledLedgerEntry::Type::OrSymbol
+                MetronomeSDK::Commit::Ledger::PrepaidCommitCanceledLedgerEntry::Type::OrSymbol,
+              contract_id: String
             ).returns(T.attached_class)
           end
-          def self.new(amount:, invoice_id:, segment_id:, timestamp:, type:)
+          def self.new(
+            amount:,
+            invoice_id:,
+            segment_id:,
+            timestamp:,
+            type:,
+            contract_id: nil
+          )
           end
 
           sig do
@@ -1137,7 +1169,8 @@ module MetronomeSDK
                 segment_id: String,
                 timestamp: Time,
                 type:
-                  MetronomeSDK::Commit::Ledger::PrepaidCommitCanceledLedgerEntry::Type::TaggedSymbol
+                  MetronomeSDK::Commit::Ledger::PrepaidCommitCanceledLedgerEntry::Type::TaggedSymbol,
+                contract_id: String
               }
             )
           end
@@ -1202,6 +1235,12 @@ module MetronomeSDK
           end
           attr_accessor :type
 
+          sig { returns(T.nilable(String)) }
+          attr_reader :contract_id
+
+          sig { params(contract_id: String).void }
+          attr_writer :contract_id
+
           sig do
             params(
               amount: Float,
@@ -1209,10 +1248,18 @@ module MetronomeSDK
               segment_id: String,
               timestamp: Time,
               type:
-                MetronomeSDK::Commit::Ledger::PrepaidCommitCreditedLedgerEntry::Type::OrSymbol
+                MetronomeSDK::Commit::Ledger::PrepaidCommitCreditedLedgerEntry::Type::OrSymbol,
+              contract_id: String
             ).returns(T.attached_class)
           end
-          def self.new(amount:, invoice_id:, segment_id:, timestamp:, type:)
+          def self.new(
+            amount:,
+            invoice_id:,
+            segment_id:,
+            timestamp:,
+            type:,
+            contract_id: nil
+          )
           end
 
           sig do
@@ -1223,7 +1270,8 @@ module MetronomeSDK
                 segment_id: String,
                 timestamp: Time,
                 type:
-                  MetronomeSDK::Commit::Ledger::PrepaidCommitCreditedLedgerEntry::Type::TaggedSymbol
+                  MetronomeSDK::Commit::Ledger::PrepaidCommitCreditedLedgerEntry::Type::TaggedSymbol,
+                contract_id: String
               }
             )
           end
@@ -1260,6 +1308,87 @@ module MetronomeSDK
           end
         end
 
+        class PrepaidCommitSeatBasedAdjustmentLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          sig { returns(Float) }
+          attr_accessor :amount
+
+          sig { returns(String) }
+          attr_accessor :segment_id
+
+          sig { returns(Time) }
+          attr_accessor :timestamp
+
+          sig do
+            returns(
+              MetronomeSDK::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry::Type::TaggedSymbol
+            )
+          end
+          attr_accessor :type
+
+          sig do
+            params(
+              amount: Float,
+              segment_id: String,
+              timestamp: Time,
+              type:
+                MetronomeSDK::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry::Type::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(amount:, segment_id:, timestamp:, type:)
+          end
+
+          sig do
+            override.returns(
+              {
+                amount: Float,
+                segment_id: String,
+                timestamp: Time,
+                type:
+                  MetronomeSDK::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry::Type::TaggedSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          module Type
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  MetronomeSDK::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry::Type
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            PREPAID_COMMIT_SEAT_BASED_ADJUSTMENT =
+              T.let(
+                :PREPAID_COMMIT_SEAT_BASED_ADJUSTMENT,
+                MetronomeSDK::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry::Type::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry::Type::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
         class PostpaidCommitInitialBalanceLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
           OrHash =
             T.type_alias do
@@ -1364,6 +1493,12 @@ module MetronomeSDK
           end
           attr_accessor :type
 
+          sig { returns(T.nilable(String)) }
+          attr_reader :contract_id
+
+          sig { params(contract_id: String).void }
+          attr_writer :contract_id
+
           sig do
             params(
               amount: Float,
@@ -1371,10 +1506,18 @@ module MetronomeSDK
               segment_id: String,
               timestamp: Time,
               type:
-                MetronomeSDK::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry::Type::OrSymbol
+                MetronomeSDK::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry::Type::OrSymbol,
+              contract_id: String
             ).returns(T.attached_class)
           end
-          def self.new(amount:, invoice_id:, segment_id:, timestamp:, type:)
+          def self.new(
+            amount:,
+            invoice_id:,
+            segment_id:,
+            timestamp:,
+            type:,
+            contract_id: nil
+          )
           end
 
           sig do
@@ -1385,7 +1528,8 @@ module MetronomeSDK
                 segment_id: String,
                 timestamp: Time,
                 type:
-                  MetronomeSDK::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry::Type::TaggedSymbol
+                  MetronomeSDK::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry::Type::TaggedSymbol,
+                contract_id: String
               }
             )
           end
@@ -1539,16 +1683,29 @@ module MetronomeSDK
           end
           attr_accessor :type
 
+          sig { returns(T.nilable(String)) }
+          attr_reader :contract_id
+
+          sig { params(contract_id: String).void }
+          attr_writer :contract_id
+
           sig do
             params(
               amount: Float,
               invoice_id: String,
               timestamp: Time,
               type:
-                MetronomeSDK::Commit::Ledger::PostpaidCommitTrueupLedgerEntry::Type::OrSymbol
+                MetronomeSDK::Commit::Ledger::PostpaidCommitTrueupLedgerEntry::Type::OrSymbol,
+              contract_id: String
             ).returns(T.attached_class)
           end
-          def self.new(amount:, invoice_id:, timestamp:, type:)
+          def self.new(
+            amount:,
+            invoice_id:,
+            timestamp:,
+            type:,
+            contract_id: nil
+          )
           end
 
           sig do
@@ -1558,7 +1715,8 @@ module MetronomeSDK
                 invoice_id: String,
                 timestamp: Time,
                 type:
-                  MetronomeSDK::Commit::Ledger::PostpaidCommitTrueupLedgerEntry::Type::TaggedSymbol
+                  MetronomeSDK::Commit::Ledger::PostpaidCommitTrueupLedgerEntry::Type::TaggedSymbol,
+                contract_id: String
               }
             )
           end