metronome-sdk 0.1.0 → 0.3.0

data/rbi/metronome_sdk/models/v1/contracts/product_create_params.rbi

@@ -48,6 +48,12 @@ module MetronomeSDK
           sig { params(composite_tags: T::Array[String]).void }
           attr_writer :composite_tags
 
+          sig { returns(T.nilable(T::Hash[Symbol, String])) }
+          attr_reader :custom_fields
+
+          sig { params(custom_fields: T::Hash[Symbol, String]).void }
+          attr_writer :custom_fields
+
           # Beta feature only available for composite products. If true, products with $0
           # will not be included when computing composite usage. Defaults to false
           sig { returns(T.nilable(T::Boolean)) }
@@ -150,6 +156,7 @@ module MetronomeSDK
               billable_metric_id: String,
               composite_product_ids: T::Array[String],
               composite_tags: T::Array[String],
+              custom_fields: T::Hash[Symbol, String],
               exclude_free_usage: T::Boolean,
               is_refundable: T::Boolean,
               netsuite_internal_item_id: String,
@@ -178,6 +185,7 @@ module MetronomeSDK
             composite_product_ids: nil,
             # Required for COMPOSITE products
             composite_tags: nil,
+            custom_fields: nil,
             # Beta feature only available for composite products. If true, products with $0
             # will not be included when computing composite usage. Defaults to false
             exclude_free_usage: nil,
@@ -224,6 +232,7 @@ module MetronomeSDK
                 billable_metric_id: String,
                 composite_product_ids: T::Array[String],
                 composite_tags: T::Array[String],
+                custom_fields: T::Hash[Symbol, String],
                 exclude_free_usage: T::Boolean,
                 is_refundable: T::Boolean,
                 netsuite_internal_item_id: String,

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

@@ -469,6 +469,14 @@ module MetronomeSDK
             sig { params(credit_type_id: String).void }
             attr_writer :credit_type_id
 
+            # This field is only applicable to commit invoice schedules. If true, this
+            # schedule will not generate an invoice.
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_reader :do_not_invoice
+
+            sig { params(do_not_invoice: T::Boolean).void }
+            attr_writer :do_not_invoice
+
             # Enter the unit price and quantity for the charge or instead only send the
             # amount. If amount is sent, the unit price is assumed to be the amount and
             # quantity is inferred to be 1.
@@ -518,6 +526,7 @@ module MetronomeSDK
             sig do
               params(
                 credit_type_id: String,
+                do_not_invoice: T::Boolean,
                 recurring_schedule:
                   MetronomeSDK::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule::OrHash,
                 schedule_items:
@@ -529,6 +538,9 @@ module MetronomeSDK
             def self.new(
               # Defaults to USD (cents) if not passed.
               credit_type_id: nil,
+              # This field is only applicable to commit invoice schedules. If true, this
+              # schedule will not generate an invoice.
+              do_not_invoice: nil,
               # Enter the unit price and quantity for the charge or instead only send the
               # amount. If amount is sent, the unit price is assumed to be the amount and
               # quantity is inferred to be 1.
@@ -542,6 +554,7 @@ module MetronomeSDK
               override.returns(
                 {
                   credit_type_id: String,
+                  do_not_invoice: T::Boolean,
                   recurring_schedule:
                     MetronomeSDK::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule,
                   schedule_items:

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

@@ -176,6 +176,29 @@ module MetronomeSDK
             end
             attr_writer :group_key_filter
 
+            # Only present for `spend_threshold_reached` alerts. Scope alert to a specific
+            # group key on individual line items.
+            sig do
+              returns(
+                T.nilable(
+                  T::Array[
+                    MetronomeSDK::V1::Customers::CustomerAlert::Alert::GroupValue
+                  ]
+                )
+              )
+            end
+            attr_reader :group_values
+
+            sig do
+              params(
+                group_values:
+                  T::Array[
+                    MetronomeSDK::V1::Customers::CustomerAlert::Alert::GroupValue::OrHash
+                  ]
+              ).void
+            end
+            attr_writer :group_values
+
             # Only supported for invoice_total_reached alerts. A list of invoice types to
             # evaluate.
             sig { returns(T.nilable(T::Array[String])) }
@@ -211,6 +234,10 @@ module MetronomeSDK
                   ],
                 group_key_filter:
                   MetronomeSDK::V1::Customers::CustomerAlert::Alert::GroupKeyFilter::OrHash,
+                group_values:
+                  T::Array[
+                    MetronomeSDK::V1::Customers::CustomerAlert::Alert::GroupValue::OrHash
+                  ],
                 invoice_types_filter: T::Array[String],
                 uniqueness_key: String
               ).returns(T.attached_class)
@@ -238,6 +265,9 @@ module MetronomeSDK
               # Scopes alert evaluation to a specific presentation group key on individual line
               # items. Only present for spend alerts.
               group_key_filter: nil,
+              # Only present for `spend_threshold_reached` alerts. Scope alert to a specific
+              # group key on individual line items.
+              group_values: nil,
               # Only supported for invoice_total_reached alerts. A list of invoice types to
               # evaluate.
               invoice_types_filter: nil,
@@ -267,6 +297,10 @@ module MetronomeSDK
                     ],
                   group_key_filter:
                     MetronomeSDK::V1::Customers::CustomerAlert::Alert::GroupKeyFilter,
+                  group_values:
+                    T::Array[
+                      MetronomeSDK::V1::Customers::CustomerAlert::Alert::GroupValue
+                    ],
                   invoice_types_filter: T::Array[String],
                   uniqueness_key: String
                 }
@@ -523,6 +557,32 @@ module MetronomeSDK
               def to_hash
               end
             end
+
+            class GroupValue < MetronomeSDK::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    MetronomeSDK::V1::Customers::CustomerAlert::Alert::GroupValue,
+                    MetronomeSDK::Internal::AnyHash
+                  )
+                end
+
+              sig { returns(String) }
+              attr_accessor :key
+
+              sig { returns(String) }
+              attr_accessor :value
+
+              sig do
+                params(key: String, value: String).returns(T.attached_class)
+              end
+              def self.new(key:, value:)
+              end
+
+              sig { override.returns({ key: String, value: String }) }
+              def to_hash
+              end
+            end
           end
 
           # The status of the customer alert. If the alert is archived, null will be

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

@@ -384,6 +384,14 @@ module MetronomeSDK
             sig { returns(Float) }
             attr_accessor :total
 
+            # The type of line item. Possible values are 'aws_royalty',
+            # 'applied_commit_or_credit', 'scheduled', 'commit_purchase', 'cpu_conversion',
+            # 'discount', 'gcp_royalty', 'postpaid_trueup', 'professional_services',
+            # 'subscription', 'usage', 'legacy', 'minimum', 'product_charge',
+            # 'trial_discount', 'rollover', 'seat', 'grouped_charge'.
+            sig { returns(String) }
+            attr_accessor :type
+
             # Details about the credit or commit that was applied to this line item. Only
             # present on line items with product of `USAGE`, `SUBSCRIPTION` or `COMPOSITE`
             # types.
@@ -713,6 +721,7 @@ module MetronomeSDK
                 credit_type: MetronomeSDK::CreditTypeData::OrHash,
                 name: String,
                 total: Float,
+                type: String,
                 applied_commit_or_credit:
                   MetronomeSDK::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit::OrHash,
                 commit_custom_fields: T::Hash[Symbol, String],
@@ -763,6 +772,12 @@ module MetronomeSDK
               credit_type:,
               name:,
               total:,
+              # The type of line item. Possible values are 'aws_royalty',
+              # 'applied_commit_or_credit', 'scheduled', 'commit_purchase', 'cpu_conversion',
+              # 'discount', 'gcp_royalty', 'postpaid_trueup', 'professional_services',
+              # 'subscription', 'usage', 'legacy', 'minimum', 'product_charge',
+              # 'trial_discount', 'rollover', 'seat', 'grouped_charge'.
+              type:,
               # Details about the credit or commit that was applied to this line item. Only
               # present on line items with product of `USAGE`, `SUBSCRIPTION` or `COMPOSITE`
               # types.
@@ -843,6 +858,7 @@ module MetronomeSDK
                   credit_type: MetronomeSDK::CreditTypeData,
                   name: String,
                   total: Float,
+                  type: String,
                   applied_commit_or_credit:
                     MetronomeSDK::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit,
                   commit_custom_fields: T::Hash[Symbol, String],

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

@@ -424,6 +424,16 @@ module MetronomeSDK
                 :Primary_red,
                 MetronomeSDK::V1::DashboardGetEmbeddableURLParams::ColorOverride::Name::TaggedSymbol
               )
+            PROGRESS_BAR =
+              T.let(
+                :Progress_bar,
+                MetronomeSDK::V1::DashboardGetEmbeddableURLParams::ColorOverride::Name::TaggedSymbol
+              )
+            PROGRESS_BAR_BACKGROUND =
+              T.let(
+                :Progress_bar_background,
+                MetronomeSDK::V1::DashboardGetEmbeddableURLParams::ColorOverride::Name::TaggedSymbol
+              )
 
             sig do
               override.returns(

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

@@ -76,6 +76,11 @@ module MetronomeSDK
         end
         attr_writer :invoice_schedule
 
+        # If multiple commits are applicable, the one with the lower priority will apply
+        # first.
+        sig { returns(T.nilable(Float)) }
+        attr_accessor :priority
+
         sig { returns(T.nilable(String)) }
         attr_reader :product_id
 
@@ -86,6 +91,8 @@ module MetronomeSDK
         # 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 do
           returns(
             T.nilable(
@@ -106,6 +113,7 @@ module MetronomeSDK
             invoice_contract_id: String,
             invoice_schedule:
               MetronomeSDK::V2::ContractEditCommitParams::InvoiceSchedule::OrHash,
+            priority: T.nilable(Float),
             product_id: String,
             specifiers:
               T.nilable(
@@ -133,11 +141,16 @@ module MetronomeSDK
           # ID of contract to use for invoicing
           invoice_contract_id: nil,
           invoice_schedule: nil,
+          # If multiple commits are applicable, the one with the lower priority will apply
+          # first.
+          priority: nil,
           product_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`.
+          # Instead, to target usage by product or product tag, pass those values in the
+          # body of `specifiers`.
           specifiers: nil,
           request_options: {}
         )
@@ -155,6 +168,7 @@ module MetronomeSDK
               invoice_contract_id: String,
               invoice_schedule:
                 MetronomeSDK::V2::ContractEditCommitParams::InvoiceSchedule,
+              priority: T.nilable(Float),
               product_id: String,
               specifiers:
                 T.nilable(

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

@@ -50,6 +50,11 @@ module MetronomeSDK
         sig { returns(T.nilable(T::Array[String])) }
         attr_accessor :applicable_product_tags
 
+        # If multiple commits are applicable, the one with the lower priority will apply
+        # first.
+        sig { returns(T.nilable(Float)) }
+        attr_accessor :priority
+
         sig { returns(T.nilable(String)) }
         attr_reader :product_id
 
@@ -60,6 +65,8 @@ module MetronomeSDK
         # 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 do
           returns(
             T.nilable(
@@ -77,6 +84,7 @@ module MetronomeSDK
               MetronomeSDK::V2::ContractEditCreditParams::AccessSchedule::OrHash,
             applicable_product_ids: T.nilable(T::Array[String]),
             applicable_product_tags: T.nilable(T::Array[String]),
+            priority: T.nilable(Float),
             product_id: String,
             specifiers:
               T.nilable(
@@ -99,11 +107,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,
+          # If multiple commits are applicable, the one with the lower priority will apply
+          # first.
+          priority: nil,
           product_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`.
+          # Instead, to target usage by product or product tag, pass those values in the
+          # body of `specifiers`.
           specifiers: nil,
           request_options: {}
         )
@@ -118,6 +131,7 @@ module MetronomeSDK
                 MetronomeSDK::V2::ContractEditCreditParams::AccessSchedule,
               applicable_product_ids: T.nilable(T::Array[String]),
               applicable_product_tags: T.nilable(T::Array[String]),
+              priority: T.nilable(Float),
               product_id: String,
               specifiers:
                 T.nilable(