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

data/rbi/metronome_sdk/models/v1/customers/commit_create_params.rbi

@@ -61,16 +61,18 @@ module MetronomeSDK
           sig { params(applicable_contract_ids: T::Array[String]).void }
           attr_writer :applicable_contract_ids
 
-          # Which products the commit applies to. If both applicable_product_ids and
-          # applicable_product_tags are not provided, the commit applies to all products.
+          # Which products the commit applies to. If applicable_product_ids,
+          # applicable_product_tags or specifiers are not provided, the commit applies to
+          # all products.
           sig { returns(T.nilable(T::Array[String])) }
           attr_reader :applicable_product_ids
 
           sig { params(applicable_product_ids: T::Array[String]).void }
           attr_writer :applicable_product_ids
 
-          # Which tags the commit applies to. If both applicable_product_ids and
-          # applicable_product_tags are not provided, the commit applies to all products.
+          # Which tags the commit applies to. If applicable_product_ids,
+          # applicable_product_tags or specifiers are not provided, the commit applies to
+          # all products.
           sig { returns(T.nilable(T::Array[String])) }
           attr_reader :applicable_product_tags
 
@@ -158,6 +160,31 @@ module MetronomeSDK
           sig { params(salesforce_opportunity_id: String).void }
           attr_writer :salesforce_opportunity_id
 
+          # List of filters that determine what kind of customer usage draws down a commit
+          # or credit. A customer's usage needs to meet the condition of at least one of the
+          # specifiers to contribute to a commit's or credit's drawdown. This field cannot
+          # be used together with `applicable_product_ids` or `applicable_product_tags`.
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  MetronomeSDK::V1::Customers::CommitCreateParams::Specifier
+                ]
+              )
+            )
+          end
+          attr_reader :specifiers
+
+          sig do
+            params(
+              specifiers:
+                T::Array[
+                  MetronomeSDK::V1::Customers::CommitCreateParams::Specifier::OrHash
+                ]
+            ).void
+          end
+          attr_writer :specifiers
+
           # Prevents the creation of duplicates. If a request to create a commit or credit
           # is made with a uniqueness key that was previously used to create a commit or
           # credit, a new record will not be created and the request will fail with a 409
@@ -190,6 +217,10 @@ module MetronomeSDK
               rate_type:
                 MetronomeSDK::V1::Customers::CommitCreateParams::RateType::OrSymbol,
               salesforce_opportunity_id: String,
+              specifiers:
+                T::Array[
+                  MetronomeSDK::V1::Customers::CommitCreateParams::Specifier::OrHash
+                ],
               uniqueness_key: String,
               request_options: MetronomeSDK::RequestOptions::OrHash
             ).returns(T.attached_class)
@@ -209,11 +240,13 @@ module MetronomeSDK
             # Which contract the commit applies to. If not provided, the commit applies to all
             # contracts.
             applicable_contract_ids: nil,
-            # Which products the commit applies to. If both applicable_product_ids and
-            # applicable_product_tags are not provided, the commit applies to all products.
+            # Which products the commit applies to. If applicable_product_ids,
+            # applicable_product_tags or specifiers are not provided, the commit applies to
+            # all products.
             applicable_product_ids: nil,
-            # Which tags the commit applies to. If both applicable_product_ids and
-            # applicable_product_tags are not provided, the commit applies to all products.
+            # Which tags the commit applies to. If applicable_product_ids,
+            # applicable_product_tags or specifiers are not provided, the commit applies to
+            # all products.
             applicable_product_tags: nil,
             custom_fields: nil,
             # Used only in UI/API. It is not exposed to end customers.
@@ -234,6 +267,11 @@ module MetronomeSDK
             rate_type: nil,
             # This field's availability is dependent on your client's configuration.
             salesforce_opportunity_id: nil,
+            # List of filters that determine what kind of customer usage draws down a commit
+            # or credit. A customer's usage needs to meet the condition of at least one of the
+            # specifiers to contribute to a commit's or credit's drawdown. This field cannot
+            # be used together with `applicable_product_ids` or `applicable_product_tags`.
+            specifiers: nil,
             # Prevents the creation of duplicates. If a request to create a commit or credit
             # is made with a uniqueness key that was previously used to create a commit or
             # credit, a new record will not be created and the request will fail with a 409
@@ -266,6 +304,10 @@ module MetronomeSDK
                 rate_type:
                   MetronomeSDK::V1::Customers::CommitCreateParams::RateType::OrSymbol,
                 salesforce_opportunity_id: String,
+                specifiers:
+                  T::Array[
+                    MetronomeSDK::V1::Customers::CommitCreateParams::Specifier
+                  ],
                 uniqueness_key: String,
                 request_options: MetronomeSDK::RequestOptions
               }
@@ -824,6 +866,77 @@ module MetronomeSDK
             def self.values
             end
           end
+
+          class Specifier < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::V1::Customers::CommitCreateParams::Specifier,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            sig { returns(T.nilable(T::Hash[Symbol, String])) }
+            attr_reader :presentation_group_values
+
+            sig do
+              params(presentation_group_values: T::Hash[Symbol, String]).void
+            end
+            attr_writer :presentation_group_values
+
+            sig { returns(T.nilable(T::Hash[Symbol, String])) }
+            attr_reader :pricing_group_values
+
+            sig { params(pricing_group_values: T::Hash[Symbol, String]).void }
+            attr_writer :pricing_group_values
+
+            # If provided, the specifier will only apply to the product with the specified ID.
+            sig { returns(T.nilable(String)) }
+            attr_reader :product_id
+
+            sig { params(product_id: String).void }
+            attr_writer :product_id
+
+            # If provided, the specifier will only apply to products with all the specified
+            # tags.
+            sig { returns(T.nilable(T::Array[String])) }
+            attr_reader :product_tags
+
+            sig { params(product_tags: T::Array[String]).void }
+            attr_writer :product_tags
+
+            sig do
+              params(
+                presentation_group_values: T::Hash[Symbol, String],
+                pricing_group_values: T::Hash[Symbol, String],
+                product_id: String,
+                product_tags: T::Array[String]
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              presentation_group_values: nil,
+              pricing_group_values: nil,
+              # If provided, the specifier will only apply to the product with the specified ID.
+              product_id: nil,
+              # If provided, the specifier will only apply to products with all the specified
+              # tags.
+              product_tags: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  presentation_group_values: T::Hash[Symbol, String],
+                  pricing_group_values: T::Hash[Symbol, String],
+                  product_id: String,
+                  product_tags: T::Array[String]
+                }
+              )
+            end
+            def to_hash
+            end
+          end
         end
       end
     end

data/rbi/metronome_sdk/models/v1/customers/credit_create_params.rbi

@@ -118,6 +118,31 @@ module MetronomeSDK
           sig { params(salesforce_opportunity_id: String).void }
           attr_writer :salesforce_opportunity_id
 
+          # List of filters that determine what kind of customer usage draws down a commit
+          # or credit. A customer's usage needs to meet the condition of at least one of the
+          # specifiers to contribute to a commit's or credit's drawdown. This field cannot
+          # be used together with `applicable_product_ids` or `applicable_product_tags`.
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  MetronomeSDK::V1::Customers::CreditCreateParams::Specifier
+                ]
+              )
+            )
+          end
+          attr_reader :specifiers
+
+          sig do
+            params(
+              specifiers:
+                T::Array[
+                  MetronomeSDK::V1::Customers::CreditCreateParams::Specifier::OrHash
+                ]
+            ).void
+          end
+          attr_writer :specifiers
+
           # Prevents the creation of duplicates. If a request to create a commit or credit
           # is made with a uniqueness key that was previously used to create a commit or
           # credit, a new record will not be created and the request will fail with a 409
@@ -145,6 +170,10 @@ module MetronomeSDK
               rate_type:
                 MetronomeSDK::V1::Customers::CreditCreateParams::RateType::OrSymbol,
               salesforce_opportunity_id: String,
+              specifiers:
+                T::Array[
+                  MetronomeSDK::V1::Customers::CreditCreateParams::Specifier::OrHash
+                ],
               uniqueness_key: String,
               request_options: MetronomeSDK::RequestOptions::OrHash
             ).returns(T.attached_class)
@@ -176,6 +205,11 @@ module MetronomeSDK
             rate_type: nil,
             # This field's availability is dependent on your client's configuration.
             salesforce_opportunity_id: nil,
+            # List of filters that determine what kind of customer usage draws down a commit
+            # or credit. A customer's usage needs to meet the condition of at least one of the
+            # specifiers to contribute to a commit's or credit's drawdown. This field cannot
+            # be used together with `applicable_product_ids` or `applicable_product_tags`.
+            specifiers: nil,
             # Prevents the creation of duplicates. If a request to create a commit or credit
             # is made with a uniqueness key that was previously used to create a commit or
             # credit, a new record will not be created and the request will fail with a 409
@@ -203,6 +237,10 @@ module MetronomeSDK
                 rate_type:
                   MetronomeSDK::V1::Customers::CreditCreateParams::RateType::OrSymbol,
                 salesforce_opportunity_id: String,
+                specifiers:
+                  T::Array[
+                    MetronomeSDK::V1::Customers::CreditCreateParams::Specifier
+                  ],
                 uniqueness_key: String,
                 request_options: MetronomeSDK::RequestOptions
               }
@@ -346,6 +384,77 @@ module MetronomeSDK
             def self.values
             end
           end
+
+          class Specifier < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::V1::Customers::CreditCreateParams::Specifier,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            sig { returns(T.nilable(T::Hash[Symbol, String])) }
+            attr_reader :presentation_group_values
+
+            sig do
+              params(presentation_group_values: T::Hash[Symbol, String]).void
+            end
+            attr_writer :presentation_group_values
+
+            sig { returns(T.nilable(T::Hash[Symbol, String])) }
+            attr_reader :pricing_group_values
+
+            sig { params(pricing_group_values: T::Hash[Symbol, String]).void }
+            attr_writer :pricing_group_values
+
+            # If provided, the specifier will only apply to the product with the specified ID.
+            sig { returns(T.nilable(String)) }
+            attr_reader :product_id
+
+            sig { params(product_id: String).void }
+            attr_writer :product_id
+
+            # If provided, the specifier will only apply to products with all the specified
+            # tags.
+            sig { returns(T.nilable(T::Array[String])) }
+            attr_reader :product_tags
+
+            sig { params(product_tags: T::Array[String]).void }
+            attr_writer :product_tags
+
+            sig do
+              params(
+                presentation_group_values: T::Hash[Symbol, String],
+                pricing_group_values: T::Hash[Symbol, String],
+                product_id: String,
+                product_tags: T::Array[String]
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              presentation_group_values: nil,
+              pricing_group_values: nil,
+              # If provided, the specifier will only apply to the product with the specified ID.
+              product_id: nil,
+              # If provided, the specifier will only apply to products with all the specified
+              # tags.
+              product_tags: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  presentation_group_values: T::Hash[Symbol, String],
+                  pricing_group_values: T::Hash[Symbol, String],
+                  product_id: String,
+                  product_tags: T::Array[String]
+                }
+              )
+            end
+            def to_hash
+            end
+          end
         end
       end
     end

data/rbi/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rbi

@@ -179,6 +179,11 @@ module MetronomeSDK
               :credits,
               MetronomeSDK::V1::DashboardGetEmbeddableURLParams::Dashboard::TaggedSymbol
             )
+          COMMITS_AND_CREDITS =
+            T.let(
+              :commits_and_credits,
+              MetronomeSDK::V1::DashboardGetEmbeddableURLParams::Dashboard::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/metronome_sdk/models/v1/usage_search_params.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      class UsageSearchParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::V1::UsageSearchParams,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        # The transaction IDs of the events to retrieve
+        sig { returns(T::Array[String]) }
+        attr_accessor :transaction_ids
+
+        sig do
+          params(
+            transaction_ids: T::Array[String],
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The transaction IDs of the events to retrieve
+          transaction_ids:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              transaction_ids: T::Array[String],
+              request_options: MetronomeSDK::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end