metronome-sdk 3.5.0 → 3.7.0

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

@@ -143,6 +143,29 @@ module MetronomeSDK
           end
           attr_writer :quantity_rounding
 
+          # Defines the breakdown behavior when calculating usage from SQL Billable Metrics.
+          # If set to 'service_period' (default), the usage will be evaluated once for all
+          # events the invoice service period and the usage will be applied at the last
+          # instant of the invoice. If set to 'hour', it will be broken down and evaluated
+          # for each hour. For most use cases, 'hour' is recommended. The setting has no
+          # effect for Streaming Billable Metrics.
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::V1::Contracts::ProductCreateParams::SqlBreakdownGranularity::OrSymbol
+              )
+            )
+          end
+          attr_reader :sql_breakdown_granularity
+
+          sig do
+            params(
+              sql_breakdown_granularity:
+                MetronomeSDK::V1::Contracts::ProductCreateParams::SqlBreakdownGranularity::OrSymbol
+            ).void
+          end
+          attr_writer :sql_breakdown_granularity
+
           sig { returns(T.nilable(T::Array[String])) }
           attr_reader :tags
 
@@ -172,6 +195,8 @@ module MetronomeSDK
                 T.nilable(
                   MetronomeSDK::V1::Contracts::QuantityRounding::OrHash
                 ),
+              sql_breakdown_granularity:
+                MetronomeSDK::V1::Contracts::ProductCreateParams::SqlBreakdownGranularity::OrSymbol,
               tags: T::Array[String],
               request_options: MetronomeSDK::RequestOptions::OrHash
             ).returns(T.attached_class)
@@ -220,6 +245,13 @@ module MetronomeSDK
             # the method is "round up" and the decimal places is 0, then the quantity will be
             # rounded up to the nearest integer.
             quantity_rounding: nil,
+            # Defines the breakdown behavior when calculating usage from SQL Billable Metrics.
+            # If set to 'service_period' (default), the usage will be evaluated once for all
+            # events the invoice service period and the usage will be applied at the last
+            # instant of the invoice. If set to 'hour', it will be broken down and evaluated
+            # for each hour. For most use cases, 'hour' is recommended. The setting has no
+            # effect for Streaming Billable Metrics.
+            sql_breakdown_granularity: nil,
             tags: nil,
             request_options: {}
           )
@@ -245,6 +277,8 @@ module MetronomeSDK
                   T.nilable(MetronomeSDK::V1::Contracts::QuantityConversion),
                 quantity_rounding:
                   T.nilable(MetronomeSDK::V1::Contracts::QuantityRounding),
+                sql_breakdown_granularity:
+                  MetronomeSDK::V1::Contracts::ProductCreateParams::SqlBreakdownGranularity::OrSymbol,
                 tags: T::Array[String],
                 request_options: MetronomeSDK::RequestOptions
               }
@@ -306,6 +340,46 @@ module MetronomeSDK
             def self.values
             end
           end
+
+          # Defines the breakdown behavior when calculating usage from SQL Billable Metrics.
+          # If set to 'service_period' (default), the usage will be evaluated once for all
+          # events the invoice service period and the usage will be applied at the last
+          # instant of the invoice. If set to 'hour', it will be broken down and evaluated
+          # for each hour. For most use cases, 'hour' is recommended. The setting has no
+          # effect for Streaming Billable Metrics.
+          module SqlBreakdownGranularity
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  MetronomeSDK::V1::Contracts::ProductCreateParams::SqlBreakdownGranularity
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            HOUR =
+              T.let(
+                :HOUR,
+                MetronomeSDK::V1::Contracts::ProductCreateParams::SqlBreakdownGranularity::TaggedSymbol
+              )
+            SERVICE_PERIOD =
+              T.let(
+                :SERVICE_PERIOD,
+                MetronomeSDK::V1::Contracts::ProductCreateParams::SqlBreakdownGranularity::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::V1::Contracts::ProductCreateParams::SqlBreakdownGranularity::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
         end
       end
     end

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

@@ -147,6 +147,29 @@ module MetronomeSDK
           end
           attr_writer :quantity_rounding
 
+          # Defines the breakdown behavior when calculating usage from SQL Billable Metrics.
+          # If set to 'service_period' (default), the usage will be evaluated once for all
+          # events the invoice service period and the usage will be applied at the last
+          # instant of the invoice. If set to 'hour', it will be broken down and evaluated
+          # for each hour. For most use cases, 'hour' is recommended. The setting has no
+          # effect for Streaming Billable Metrics.
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::V1::Contracts::ProductUpdateParams::SqlBreakdownGranularity::OrSymbol
+              )
+            )
+          end
+          attr_reader :sql_breakdown_granularity
+
+          sig do
+            params(
+              sql_breakdown_granularity:
+                MetronomeSDK::V1::Contracts::ProductUpdateParams::SqlBreakdownGranularity::OrSymbol
+            ).void
+          end
+          attr_writer :sql_breakdown_granularity
+
           # If not provided, defaults to product's current tags
           sig { returns(T.nilable(T::Array[String])) }
           attr_reader :tags
@@ -176,6 +199,8 @@ module MetronomeSDK
                 T.nilable(
                   MetronomeSDK::V1::Contracts::QuantityRounding::OrHash
                 ),
+              sql_breakdown_granularity:
+                MetronomeSDK::V1::Contracts::ProductUpdateParams::SqlBreakdownGranularity::OrSymbol,
               tags: T::Array[String],
               request_options: MetronomeSDK::RequestOptions::OrHash
             ).returns(T.attached_class)
@@ -232,6 +257,13 @@ module MetronomeSDK
             # the method is "round up" and the decimal places is 0, then the quantity will be
             # rounded up to the nearest integer.
             quantity_rounding: nil,
+            # Defines the breakdown behavior when calculating usage from SQL Billable Metrics.
+            # If set to 'service_period' (default), the usage will be evaluated once for all
+            # events the invoice service period and the usage will be applied at the last
+            # instant of the invoice. If set to 'hour', it will be broken down and evaluated
+            # for each hour. For most use cases, 'hour' is recommended. The setting has no
+            # effect for Streaming Billable Metrics.
+            sql_breakdown_granularity: nil,
             # If not provided, defaults to product's current tags
             tags: nil,
             request_options: {}
@@ -257,6 +289,8 @@ module MetronomeSDK
                   T.nilable(MetronomeSDK::V1::Contracts::QuantityConversion),
                 quantity_rounding:
                   T.nilable(MetronomeSDK::V1::Contracts::QuantityRounding),
+                sql_breakdown_granularity:
+                  MetronomeSDK::V1::Contracts::ProductUpdateParams::SqlBreakdownGranularity::OrSymbol,
                 tags: T::Array[String],
                 request_options: MetronomeSDK::RequestOptions
               }
@@ -264,6 +298,46 @@ module MetronomeSDK
           end
           def to_hash
           end
+
+          # Defines the breakdown behavior when calculating usage from SQL Billable Metrics.
+          # If set to 'service_period' (default), the usage will be evaluated once for all
+          # events the invoice service period and the usage will be applied at the last
+          # instant of the invoice. If set to 'hour', it will be broken down and evaluated
+          # for each hour. For most use cases, 'hour' is recommended. The setting has no
+          # effect for Streaming Billable Metrics.
+          module SqlBreakdownGranularity
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  MetronomeSDK::V1::Contracts::ProductUpdateParams::SqlBreakdownGranularity
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            HOUR =
+              T.let(
+                :HOUR,
+                MetronomeSDK::V1::Contracts::ProductUpdateParams::SqlBreakdownGranularity::TaggedSymbol
+              )
+            SERVICE_PERIOD =
+              T.let(
+                :SERVICE_PERIOD,
+                MetronomeSDK::V1::Contracts::ProductUpdateParams::SqlBreakdownGranularity::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::V1::Contracts::ProductUpdateParams::SqlBreakdownGranularity::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
         end
       end
     end

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

@@ -552,6 +552,11 @@ module MetronomeSDK
                     :ContractCredit,
                     MetronomeSDK::V1::Customers::CustomerAlert::Alert::CustomFieldFilter::Entity::TaggedSymbol
                   )
+                CONTRACT_CREDIT_OR_COMMIT =
+                  T.let(
+                    :ContractCreditOrCommit,
+                    MetronomeSDK::V1::Customers::CustomerAlert::Alert::CustomFieldFilter::Entity::TaggedSymbol
+                  )
 
                 sig do
                   override.returns(

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

@@ -222,6 +222,12 @@ module MetronomeSDK
           sig { params(plan_name: String).void }
           attr_writer :plan_name
 
+          sig { returns(T.nilable(String)) }
+          attr_reader :regenerated_from_invoice_id
+
+          sig { params(regenerated_from_invoice_id: String).void }
+          attr_writer :regenerated_from_invoice_id
+
           # Only present for contract invoices with reseller royalties.
           sig do
             returns(
@@ -310,6 +316,7 @@ module MetronomeSDK
               plan_custom_fields: T::Hash[Symbol, String],
               plan_id: String,
               plan_name: String,
+              regenerated_from_invoice_id: String,
               reseller_royalty:
                 MetronomeSDK::V1::Customers::Invoice::ResellerRoyalty::OrHash,
               revenue_system_invoices:
@@ -363,6 +370,7 @@ module MetronomeSDK
             plan_custom_fields: nil,
             plan_id: nil,
             plan_name: nil,
+            regenerated_from_invoice_id: nil,
             # Only present for contract invoices with reseller royalties.
             reseller_royalty: nil,
             revenue_system_invoices: nil,
@@ -414,6 +422,7 @@ module MetronomeSDK
                 plan_custom_fields: T::Hash[Symbol, String],
                 plan_id: String,
                 plan_name: String,
+                regenerated_from_invoice_id: String,
                 reseller_royalty:
                   MetronomeSDK::V1::Customers::Invoice::ResellerRoyalty,
                 revenue_system_invoices:

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

@@ -19,6 +19,13 @@ module MetronomeSDK
           sig { returns(String) }
           attr_accessor :customer_id
 
+          # Only return invoices for the specified contract
+          sig { returns(T.nilable(String)) }
+          attr_reader :contract_id
+
+          sig { params(contract_id: String).void }
+          attr_writer :contract_id
+
           # Only return invoices for the specified credit type
           sig { returns(T.nilable(String)) }
           attr_reader :credit_type_id
@@ -89,9 +96,28 @@ module MetronomeSDK
           sig { params(status: String).void }
           attr_writer :status
 
+          # Filter invoices by type. Defaults to returning all invoice types.
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::V1::Customers::InvoiceListParams::Type::OrSymbol
+              )
+            )
+          end
+          attr_reader :type
+
+          sig do
+            params(
+              type:
+                MetronomeSDK::V1::Customers::InvoiceListParams::Type::OrSymbol
+            ).void
+          end
+          attr_writer :type
+
           sig do
             params(
               customer_id: String,
+              contract_id: String,
               credit_type_id: String,
               ending_before: Time,
               limit: Integer,
@@ -101,11 +127,15 @@ module MetronomeSDK
                 MetronomeSDK::V1::Customers::InvoiceListParams::Sort::OrSymbol,
               starting_on: Time,
               status: String,
+              type:
+                MetronomeSDK::V1::Customers::InvoiceListParams::Type::OrSymbol,
               request_options: MetronomeSDK::RequestOptions::OrHash
             ).returns(T.attached_class)
           end
           def self.new(
             customer_id:,
+            # Only return invoices for the specified contract
+            contract_id: nil,
             # Only return invoices for the specified credit type
             credit_type_id: nil,
             # RFC 3339 timestamp (exclusive). Invoices will only be returned for billing
@@ -125,6 +155,8 @@ module MetronomeSDK
             starting_on: nil,
             # Invoice status, e.g. DRAFT, FINALIZED, or VOID
             status: nil,
+            # Filter invoices by type. Defaults to returning all invoice types.
+            type: nil,
             request_options: {}
           )
           end
@@ -133,6 +165,7 @@ module MetronomeSDK
             override.returns(
               {
                 customer_id: String,
+                contract_id: String,
                 credit_type_id: String,
                 ending_before: Time,
                 limit: Integer,
@@ -142,6 +175,8 @@ module MetronomeSDK
                   MetronomeSDK::V1::Customers::InvoiceListParams::Sort::OrSymbol,
                 starting_on: Time,
                 status: String,
+                type:
+                  MetronomeSDK::V1::Customers::InvoiceListParams::Type::OrSymbol,
                 request_options: MetronomeSDK::RequestOptions
               }
             )
@@ -184,6 +219,46 @@ module MetronomeSDK
             def self.values
             end
           end
+
+          # Filter invoices by type. Defaults to returning all invoice types.
+          module Type
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  MetronomeSDK::V1::Customers::InvoiceListParams::Type
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            USAGE =
+              T.let(
+                :USAGE,
+                MetronomeSDK::V1::Customers::InvoiceListParams::Type::TaggedSymbol
+              )
+            USAGE_CONSOLIDATED =
+              T.let(
+                :USAGE_CONSOLIDATED,
+                MetronomeSDK::V1::Customers::InvoiceListParams::Type::TaggedSymbol
+              )
+            SCHEDULED =
+              T.let(
+                :SCHEDULED,
+                MetronomeSDK::V1::Customers::InvoiceListParams::Type::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::V1::Customers::InvoiceListParams::Type::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
         end
       end
     end