metronome-sdk 0.3.0 → 2.0.0

data/rbi/metronome_sdk/models/v1/plan_list_customers_response.rbi

@@ -71,6 +71,7 @@ module MetronomeSDK
           sig { returns(String) }
           attr_accessor :id
 
+          # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           sig { returns(T::Hash[Symbol, String]) }
           attr_accessor :custom_fields
 
@@ -100,6 +101,7 @@ module MetronomeSDK
           end
           def self.new(
             id:,
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             custom_fields:,
             customer_plan_id:,
             name:,

data/rbi/metronome_sdk/models/v1/plan_list_response.rbi

@@ -21,6 +21,7 @@ module MetronomeSDK
         sig { returns(String) }
         attr_accessor :name
 
+        # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
         sig { returns(T.nilable(T::Hash[Symbol, String])) }
         attr_reader :custom_fields
 
@@ -35,7 +36,13 @@ module MetronomeSDK
             custom_fields: T::Hash[Symbol, String]
           ).returns(T.attached_class)
         end
-        def self.new(id:, description:, name:, custom_fields: nil)
+        def self.new(
+          id:,
+          description:,
+          name:,
+          # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+          custom_fields: nil
+        )
         end
 
         sig do

data/rbi/metronome_sdk/models/v1/usage_list_response.rbi

@@ -12,74 +12,59 @@ module MetronomeSDK
             )
           end
 
-        sig do
-          returns(T::Array[MetronomeSDK::Models::V1::UsageListResponse::Data])
-        end
-        attr_accessor :data
-
-        sig { returns(T.nilable(String)) }
-        attr_accessor :next_page
-
-        sig do
-          params(
-            data:
-              T::Array[
-                MetronomeSDK::Models::V1::UsageListResponse::Data::OrHash
-              ],
-            next_page: T.nilable(String)
-          ).returns(T.attached_class)
-        end
-        def self.new(data:, next_page:)
-        end
-
-        sig do
-          override.returns(
-            {
-              data: T::Array[MetronomeSDK::Models::V1::UsageListResponse::Data],
-              next_page: T.nilable(String)
-            }
-          )
-        end
-        def to_hash
-        end
+        sig { returns(String) }
+        attr_accessor :billable_metric_id
 
-        class Data < MetronomeSDK::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                MetronomeSDK::Models::V1::UsageListResponse::Data,
-                MetronomeSDK::Internal::AnyHash
-              )
-            end
+        sig { returns(String) }
+        attr_accessor :billable_metric_name
 
-          sig { returns(String) }
-          attr_accessor :billable_metric_id
+        sig { returns(String) }
+        attr_accessor :customer_id
 
-          sig { returns(String) }
-          attr_accessor :billable_metric_name
+        sig { returns(Time) }
+        attr_accessor :end_timestamp
 
-          sig { returns(String) }
-          attr_accessor :customer_id
+        sig { returns(Time) }
+        attr_accessor :start_timestamp
 
-          sig { returns(Time) }
-          attr_accessor :end_timestamp
+        sig { returns(T.nilable(Float)) }
+        attr_accessor :value
 
-          sig { returns(Time) }
-          attr_accessor :start_timestamp
+        # Values will be either a number or null. Null indicates that there were no
+        # matches for the group_by value.
+        sig { returns(T.nilable(T::Hash[Symbol, T.nilable(Float)])) }
+        attr_reader :groups
 
-          sig { returns(T.nilable(Float)) }
-          attr_accessor :value
+        sig { params(groups: T::Hash[Symbol, T.nilable(Float)]).void }
+        attr_writer :groups
 
+        sig do
+          params(
+            billable_metric_id: String,
+            billable_metric_name: String,
+            customer_id: String,
+            end_timestamp: Time,
+            start_timestamp: Time,
+            value: T.nilable(Float),
+            groups: T::Hash[Symbol, T.nilable(Float)]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          billable_metric_id:,
+          billable_metric_name:,
+          customer_id:,
+          end_timestamp:,
+          start_timestamp:,
+          value:,
           # Values will be either a number or null. Null indicates that there were no
           # matches for the group_by value.
-          sig { returns(T.nilable(T::Hash[Symbol, T.nilable(Float)])) }
-          attr_reader :groups
-
-          sig { params(groups: T::Hash[Symbol, T.nilable(Float)]).void }
-          attr_writer :groups
+          groups: nil
+        )
+        end
 
-          sig do
-            params(
+        sig do
+          override.returns(
+            {
               billable_metric_id: String,
               billable_metric_name: String,
               customer_id: String,
@@ -87,36 +72,10 @@ module MetronomeSDK
               start_timestamp: Time,
               value: T.nilable(Float),
               groups: T::Hash[Symbol, T.nilable(Float)]
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            billable_metric_id:,
-            billable_metric_name:,
-            customer_id:,
-            end_timestamp:,
-            start_timestamp:,
-            value:,
-            # Values will be either a number or null. Null indicates that there were no
-            # matches for the group_by value.
-            groups: nil
+            }
           )
-          end
-
-          sig do
-            override.returns(
-              {
-                billable_metric_id: String,
-                billable_metric_name: String,
-                customer_id: String,
-                end_timestamp: Time,
-                start_timestamp: Time,
-                value: T.nilable(Float),
-                groups: T::Hash[Symbol, T.nilable(Float)]
-              }
-            )
-          end
-          def to_hash
-          end
+        end
+        def to_hash
         end
       end
     end

data/rbi/metronome_sdk/models/v1/usage_search_response.rbi

@@ -206,6 +206,7 @@ module MetronomeSDK
           sig { params(archived_at: Time).void }
           attr_writer :archived_at
 
+          # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           sig { returns(T.nilable(T::Hash[Symbol, String])) }
           attr_reader :custom_fields
 
@@ -300,6 +301,7 @@ module MetronomeSDK
             # RFC 3339 timestamp indicating when the billable metric was archived. If not
             # provided, the billable metric is not archived.
             archived_at: nil,
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             custom_fields: nil,
             # An optional filtering rule to match the 'event_type' property of an event.
             event_type_filter: nil,

data/rbi/metronome_sdk/models/v2/contract_edit_commit_params.rbi

@@ -52,6 +52,18 @@ module MetronomeSDK
         sig { returns(T.nilable(T::Array[String])) }
         attr_accessor :applicable_product_tags
 
+        # Optional configuration for commit hierarchy access control
+        sig { returns(T.nilable(MetronomeSDK::CommitHierarchyConfiguration)) }
+        attr_reader :hierarchy_configuration
+
+        sig do
+          params(
+            hierarchy_configuration:
+              MetronomeSDK::CommitHierarchyConfiguration::OrHash
+          ).void
+        end
+        attr_writer :hierarchy_configuration
+
         # ID of contract to use for invoicing
         sig { returns(T.nilable(String)) }
         attr_reader :invoice_contract_id
@@ -87,19 +99,33 @@ module MetronomeSDK
         sig { params(product_id: String).void }
         attr_writer :product_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`.
-        # Instead, to target usage by product or product tag, pass those values in the
-        # body of `specifiers`.
+        # If provided, updates the commit to use the specified rate type for current and
+        # future invoices. Previously finalized invoices will need to be voided and
+        # regenerated to reflect the rate type change.
         sig do
           returns(
             T.nilable(
-              T::Array[MetronomeSDK::V2::ContractEditCommitParams::Specifier]
+              MetronomeSDK::V2::ContractEditCommitParams::RateType::OrSymbol
             )
           )
         end
+        attr_reader :rate_type
+
+        sig do
+          params(
+            rate_type:
+              MetronomeSDK::V2::ContractEditCommitParams::RateType::OrSymbol
+          ).void
+        end
+        attr_writer :rate_type
+
+        # 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`.
+        # Instead, to target usage by product or product tag, pass those values in the
+        # body of `specifiers`.
+        sig { returns(T.nilable(T::Array[MetronomeSDK::CommitSpecifierInput])) }
         attr_accessor :specifiers
 
         sig do
@@ -110,17 +136,17 @@ module MetronomeSDK
               MetronomeSDK::V2::ContractEditCommitParams::AccessSchedule::OrHash,
             applicable_product_ids: T.nilable(T::Array[String]),
             applicable_product_tags: T.nilable(T::Array[String]),
+            hierarchy_configuration:
+              MetronomeSDK::CommitHierarchyConfiguration::OrHash,
             invoice_contract_id: String,
             invoice_schedule:
               MetronomeSDK::V2::ContractEditCommitParams::InvoiceSchedule::OrHash,
             priority: T.nilable(Float),
             product_id: String,
+            rate_type:
+              MetronomeSDK::V2::ContractEditCommitParams::RateType::OrSymbol,
             specifiers:
-              T.nilable(
-                T::Array[
-                  MetronomeSDK::V2::ContractEditCommitParams::Specifier::OrHash
-                ]
-              ),
+              T.nilable(T::Array[MetronomeSDK::CommitSpecifierInput::OrHash]),
             request_options: MetronomeSDK::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -138,6 +164,8 @@ module MetronomeSDK
           # applicable_product_tags or specifiers are not provided, the commit applies to
           # all products.
           applicable_product_tags: nil,
+          # Optional configuration for commit hierarchy access control
+          hierarchy_configuration: nil,
           # ID of contract to use for invoicing
           invoice_contract_id: nil,
           invoice_schedule: nil,
@@ -145,6 +173,10 @@ module MetronomeSDK
           # first.
           priority: nil,
           product_id: nil,
+          # If provided, updates the commit to use the specified rate type for current and
+          # future invoices. Previously finalized invoices will need to be voided and
+          # regenerated to reflect the rate type change.
+          rate_type: 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
@@ -165,17 +197,17 @@ module MetronomeSDK
                 MetronomeSDK::V2::ContractEditCommitParams::AccessSchedule,
               applicable_product_ids: T.nilable(T::Array[String]),
               applicable_product_tags: T.nilable(T::Array[String]),
+              hierarchy_configuration:
+                MetronomeSDK::CommitHierarchyConfiguration,
               invoice_contract_id: String,
               invoice_schedule:
                 MetronomeSDK::V2::ContractEditCommitParams::InvoiceSchedule,
               priority: T.nilable(Float),
               product_id: String,
+              rate_type:
+                MetronomeSDK::V2::ContractEditCommitParams::RateType::OrSymbol,
               specifiers:
-                T.nilable(
-                  T::Array[
-                    MetronomeSDK::V2::ContractEditCommitParams::Specifier
-                  ]
-                ),
+                T.nilable(T::Array[MetronomeSDK::CommitSpecifierInput]),
               request_options: MetronomeSDK::RequestOptions
             }
           )
@@ -680,74 +712,40 @@ module MetronomeSDK
           end
         end
 
-        class Specifier < MetronomeSDK::Internal::Type::BaseModel
-          OrHash =
+        # If provided, updates the commit to use the specified rate type for current and
+        # future invoices. Previously finalized invoices will need to be voided and
+        # regenerated to reflect the rate type change.
+        module RateType
+          extend MetronomeSDK::Internal::Type::Enum
+
+          TaggedSymbol =
             T.type_alias do
-              T.any(
-                MetronomeSDK::V2::ContractEditCommitParams::Specifier,
-                MetronomeSDK::Internal::AnyHash
+              T.all(
+                Symbol,
+                MetronomeSDK::V2::ContractEditCommitParams::RateType
               )
             end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-          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
+          LIST_RATE =
+            T.let(
+              :LIST_RATE,
+              MetronomeSDK::V2::ContractEditCommitParams::RateType::TaggedSymbol
+            )
+          COMMIT_RATE =
+            T.let(
+              :COMMIT_RATE,
+              MetronomeSDK::V2::ContractEditCommitParams::RateType::TaggedSymbol
+            )
 
           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]
-              }
+              T::Array[
+                MetronomeSDK::V2::ContractEditCommitParams::RateType::TaggedSymbol
+              ]
             )
           end
-          def to_hash
+          def self.values
           end
         end
       end

data/rbi/metronome_sdk/models/v2/contract_edit_credit_params.rbi

@@ -50,6 +50,18 @@ module MetronomeSDK
         sig { returns(T.nilable(T::Array[String])) }
         attr_accessor :applicable_product_tags
 
+        # Optional configuration for credit hierarchy access control
+        sig { returns(T.nilable(MetronomeSDK::CommitHierarchyConfiguration)) }
+        attr_reader :hierarchy_configuration
+
+        sig do
+          params(
+            hierarchy_configuration:
+              MetronomeSDK::CommitHierarchyConfiguration::OrHash
+          ).void
+        end
+        attr_writer :hierarchy_configuration
+
         # If multiple commits are applicable, the one with the lower priority will apply
         # first.
         sig { returns(T.nilable(Float)) }
@@ -61,19 +73,33 @@ module MetronomeSDK
         sig { params(product_id: String).void }
         attr_writer :product_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`.
-        # Instead, to target usage by product or product tag, pass those values in the
-        # body of `specifiers`.
+        # If provided, updates the credit to use the specified rate type for current and
+        # future invoices. Previously finalized invoices will need to be voided and
+        # regenerated to reflect the rate type change.
         sig do
           returns(
             T.nilable(
-              T::Array[MetronomeSDK::V2::ContractEditCreditParams::Specifier]
+              MetronomeSDK::V2::ContractEditCreditParams::RateType::OrSymbol
             )
           )
         end
+        attr_reader :rate_type
+
+        sig do
+          params(
+            rate_type:
+              MetronomeSDK::V2::ContractEditCreditParams::RateType::OrSymbol
+          ).void
+        end
+        attr_writer :rate_type
+
+        # 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`.
+        # Instead, to target usage by product or product tag, pass those values in the
+        # body of `specifiers`.
+        sig { returns(T.nilable(T::Array[MetronomeSDK::CommitSpecifierInput])) }
         attr_accessor :specifiers
 
         sig do
@@ -84,14 +110,14 @@ module MetronomeSDK
               MetronomeSDK::V2::ContractEditCreditParams::AccessSchedule::OrHash,
             applicable_product_ids: T.nilable(T::Array[String]),
             applicable_product_tags: T.nilable(T::Array[String]),
+            hierarchy_configuration:
+              MetronomeSDK::CommitHierarchyConfiguration::OrHash,
             priority: T.nilable(Float),
             product_id: String,
+            rate_type:
+              MetronomeSDK::V2::ContractEditCreditParams::RateType::OrSymbol,
             specifiers:
-              T.nilable(
-                T::Array[
-                  MetronomeSDK::V2::ContractEditCreditParams::Specifier::OrHash
-                ]
-              ),
+              T.nilable(T::Array[MetronomeSDK::CommitSpecifierInput::OrHash]),
             request_options: MetronomeSDK::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -107,10 +133,16 @@ module MetronomeSDK
           # Which tags the credit applies to. If both applicable_product_ids and
           # applicable_product_tags are not provided, the credit applies to all products.
           applicable_product_tags: nil,
+          # Optional configuration for credit hierarchy access control
+          hierarchy_configuration: nil,
           # If multiple commits are applicable, the one with the lower priority will apply
           # first.
           priority: nil,
           product_id: nil,
+          # If provided, updates the credit to use the specified rate type for current and
+          # future invoices. Previously finalized invoices will need to be voided and
+          # regenerated to reflect the rate type change.
+          rate_type: 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
@@ -131,14 +163,14 @@ module MetronomeSDK
                 MetronomeSDK::V2::ContractEditCreditParams::AccessSchedule,
               applicable_product_ids: T.nilable(T::Array[String]),
               applicable_product_tags: T.nilable(T::Array[String]),
+              hierarchy_configuration:
+                MetronomeSDK::CommitHierarchyConfiguration,
               priority: T.nilable(Float),
               product_id: String,
+              rate_type:
+                MetronomeSDK::V2::ContractEditCreditParams::RateType::OrSymbol,
               specifiers:
-                T.nilable(
-                  T::Array[
-                    MetronomeSDK::V2::ContractEditCreditParams::Specifier
-                  ]
-                ),
+                T.nilable(T::Array[MetronomeSDK::CommitSpecifierInput]),
               request_options: MetronomeSDK::RequestOptions
             }
           )
@@ -376,74 +408,40 @@ module MetronomeSDK
           end
         end
 
-        class Specifier < MetronomeSDK::Internal::Type::BaseModel
-          OrHash =
+        # If provided, updates the credit to use the specified rate type for current and
+        # future invoices. Previously finalized invoices will need to be voided and
+        # regenerated to reflect the rate type change.
+        module RateType
+          extend MetronomeSDK::Internal::Type::Enum
+
+          TaggedSymbol =
             T.type_alias do
-              T.any(
-                MetronomeSDK::V2::ContractEditCreditParams::Specifier,
-                MetronomeSDK::Internal::AnyHash
+              T.all(
+                Symbol,
+                MetronomeSDK::V2::ContractEditCreditParams::RateType
               )
             end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-          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
+          LIST_RATE =
+            T.let(
+              :LIST_RATE,
+              MetronomeSDK::V2::ContractEditCreditParams::RateType::TaggedSymbol
+            )
+          COMMIT_RATE =
+            T.let(
+              :COMMIT_RATE,
+              MetronomeSDK::V2::ContractEditCreditParams::RateType::TaggedSymbol
+            )
 
           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]
-              }
+              T::Array[
+                MetronomeSDK::V2::ContractEditCreditParams::RateType::TaggedSymbol
+              ]
             )
           end
-          def to_hash
+          def self.values
           end
         end
       end