metronome-sdk 0.3.0 → 2.0.0

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

@@ -16,7 +16,7 @@ module MetronomeSDK
               )
             end
 
-          # The Metronome ID of the alert
+          # The Metronome ID of the threshold notification
           sig { returns(String) }
           attr_accessor :alert_id
 
@@ -24,8 +24,31 @@ module MetronomeSDK
           sig { returns(String) }
           attr_accessor :customer_id
 
-          # When parallel alerts are enabled during migration, this flag denotes whether to
-          # fetch alerts for plans or contracts.
+          # Only present for `spend_threshold_reached` notifications. Retrieve the
+          # notification for a specific group key-value pair.
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  MetronomeSDK::V1::Customers::AlertRetrieveParams::GroupValue
+                ]
+              )
+            )
+          end
+          attr_reader :group_values
+
+          sig do
+            params(
+              group_values:
+                T::Array[
+                  MetronomeSDK::V1::Customers::AlertRetrieveParams::GroupValue::OrHash
+                ]
+            ).void
+          end
+          attr_writer :group_values
+
+          # When parallel threshold notifications are enabled during migration, this flag
+          # denotes whether to fetch notifications for plans or contracts.
           sig do
             returns(
               T.nilable(
@@ -47,18 +70,25 @@ module MetronomeSDK
             params(
               alert_id: String,
               customer_id: String,
+              group_values:
+                T::Array[
+                  MetronomeSDK::V1::Customers::AlertRetrieveParams::GroupValue::OrHash
+                ],
               plans_or_contracts:
                 MetronomeSDK::V1::Customers::AlertRetrieveParams::PlansOrContracts::OrSymbol,
               request_options: MetronomeSDK::RequestOptions::OrHash
             ).returns(T.attached_class)
           end
           def self.new(
-            # The Metronome ID of the alert
+            # The Metronome ID of the threshold notification
             alert_id:,
             # The Metronome ID of the customer
             customer_id:,
-            # When parallel alerts are enabled during migration, this flag denotes whether to
-            # fetch alerts for plans or contracts.
+            # Only present for `spend_threshold_reached` notifications. Retrieve the
+            # notification for a specific group key-value pair.
+            group_values: nil,
+            # When parallel threshold notifications are enabled during migration, this flag
+            # denotes whether to fetch notifications for plans or contracts.
             plans_or_contracts: nil,
             request_options: {}
           )
@@ -69,6 +99,10 @@ module MetronomeSDK
               {
                 alert_id: String,
                 customer_id: String,
+                group_values:
+                  T::Array[
+                    MetronomeSDK::V1::Customers::AlertRetrieveParams::GroupValue
+                  ],
                 plans_or_contracts:
                   MetronomeSDK::V1::Customers::AlertRetrieveParams::PlansOrContracts::OrSymbol,
                 request_options: MetronomeSDK::RequestOptions
@@ -78,8 +112,34 @@ module MetronomeSDK
           def to_hash
           end
 
-          # When parallel alerts are enabled during migration, this flag denotes whether to
-          # fetch alerts for plans or contracts.
+          class GroupValue < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::V1::Customers::AlertRetrieveParams::GroupValue,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            sig { returns(String) }
+            attr_accessor :key
+
+            sig { returns(String) }
+            attr_accessor :value
+
+            # Scopes threshold notification evaluation to a specific presentation group key on
+            # individual line items. Only present for spend notifications.
+            sig { params(key: String, value: String).returns(T.attached_class) }
+            def self.new(key:, value:)
+            end
+
+            sig { override.returns({ key: String, value: String }) }
+            def to_hash
+            end
+          end
+
+          # When parallel threshold notifications are enabled during migration, this flag
+          # denotes whether to fetch notifications for plans or contracts.
           module PlansOrContracts
             extend MetronomeSDK::Internal::Type::Enum
 

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

@@ -352,6 +352,16 @@ module MetronomeSDK
                 :send_invoice,
                 MetronomeSDK::V1::Customers::BillingConfigCreateParams::StripeCollectionMethod::TaggedSymbol
               )
+            AUTO_CHARGE_PAYMENT_INTENT =
+              T.let(
+                :auto_charge_payment_intent,
+                MetronomeSDK::V1::Customers::BillingConfigCreateParams::StripeCollectionMethod::TaggedSymbol
+              )
+            MANUALLY_CHARGE_PAYMENT_INTENT =
+              T.let(
+                :manually_charge_payment_intent,
+                MetronomeSDK::V1::Customers::BillingConfigCreateParams::StripeCollectionMethod::TaggedSymbol
+              )
 
             sig do
               override.returns(

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

@@ -438,6 +438,16 @@ module MetronomeSDK
                   :send_invoice,
                   MetronomeSDK::Models::V1::Customers::BillingConfigRetrieveResponse::Data::StripeCollectionMethod::TaggedSymbol
                 )
+              AUTO_CHARGE_PAYMENT_INTENT =
+                T.let(
+                  :auto_charge_payment_intent,
+                  MetronomeSDK::Models::V1::Customers::BillingConfigRetrieveResponse::Data::StripeCollectionMethod::TaggedSymbol
+                )
+              MANUALLY_CHARGE_PAYMENT_INTENT =
+                T.let(
+                  :manually_charge_payment_intent,
+                  MetronomeSDK::Models::V1::Customers::BillingConfigRetrieveResponse::Data::StripeCollectionMethod::TaggedSymbol
+                )
 
               sig do
                 override.returns(

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

@@ -79,6 +79,7 @@ module MetronomeSDK
           sig { params(applicable_product_tags: T::Array[String]).void }
           attr_writer :applicable_product_tags
 
+          # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           sig { returns(T.nilable(T::Hash[Symbol, String])) }
           attr_reader :custom_fields
 
@@ -165,22 +166,13 @@ module MetronomeSDK
           # 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
-                ]
-              )
-            )
+            returns(T.nilable(T::Array[MetronomeSDK::CommitSpecifierInput]))
           end
           attr_reader :specifiers
 
           sig do
             params(
-              specifiers:
-                T::Array[
-                  MetronomeSDK::V1::Customers::CommitCreateParams::Specifier::OrHash
-                ]
+              specifiers: T::Array[MetronomeSDK::CommitSpecifierInput::OrHash]
             ).void
           end
           attr_writer :specifiers
@@ -217,10 +209,7 @@ module MetronomeSDK
               rate_type:
                 MetronomeSDK::V1::Customers::CommitCreateParams::RateType::OrSymbol,
               salesforce_opportunity_id: String,
-              specifiers:
-                T::Array[
-                  MetronomeSDK::V1::Customers::CommitCreateParams::Specifier::OrHash
-                ],
+              specifiers: T::Array[MetronomeSDK::CommitSpecifierInput::OrHash],
               uniqueness_key: String,
               request_options: MetronomeSDK::RequestOptions::OrHash
             ).returns(T.attached_class)
@@ -248,6 +237,7 @@ module MetronomeSDK
             # applicable_product_tags or specifiers are not provided, the commit applies to
             # all products.
             applicable_product_tags: nil,
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             custom_fields: nil,
             # Used only in UI/API. It is not exposed to end customers.
             description: nil,
@@ -304,10 +294,7 @@ module MetronomeSDK
                 rate_type:
                   MetronomeSDK::V1::Customers::CommitCreateParams::RateType::OrSymbol,
                 salesforce_opportunity_id: String,
-                specifiers:
-                  T::Array[
-                    MetronomeSDK::V1::Customers::CommitCreateParams::Specifier
-                  ],
+                specifiers: T::Array[MetronomeSDK::CommitSpecifierInput],
                 uniqueness_key: String,
                 request_options: MetronomeSDK::RequestOptions
               }
@@ -879,77 +866,6 @@ 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

@@ -67,6 +67,7 @@ module MetronomeSDK
           sig { params(applicable_product_tags: T::Array[String]).void }
           attr_writer :applicable_product_tags
 
+          # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           sig { returns(T.nilable(T::Hash[Symbol, String])) }
           attr_reader :custom_fields
 
@@ -123,22 +124,13 @@ module MetronomeSDK
           # 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
-                ]
-              )
-            )
+            returns(T.nilable(T::Array[MetronomeSDK::CommitSpecifierInput]))
           end
           attr_reader :specifiers
 
           sig do
             params(
-              specifiers:
-                T::Array[
-                  MetronomeSDK::V1::Customers::CreditCreateParams::Specifier::OrHash
-                ]
+              specifiers: T::Array[MetronomeSDK::CommitSpecifierInput::OrHash]
             ).void
           end
           attr_writer :specifiers
@@ -170,10 +162,7 @@ module MetronomeSDK
               rate_type:
                 MetronomeSDK::V1::Customers::CreditCreateParams::RateType::OrSymbol,
               salesforce_opportunity_id: String,
-              specifiers:
-                T::Array[
-                  MetronomeSDK::V1::Customers::CreditCreateParams::Specifier::OrHash
-                ],
+              specifiers: T::Array[MetronomeSDK::CommitSpecifierInput::OrHash],
               uniqueness_key: String,
               request_options: MetronomeSDK::RequestOptions::OrHash
             ).returns(T.attached_class)
@@ -195,6 +184,7 @@ 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,
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             custom_fields: nil,
             # Used only in UI/API. It is not exposed to end customers.
             description: nil,
@@ -237,10 +227,7 @@ module MetronomeSDK
                 rate_type:
                   MetronomeSDK::V1::Customers::CreditCreateParams::RateType::OrSymbol,
                 salesforce_opportunity_id: String,
-                specifiers:
-                  T::Array[
-                    MetronomeSDK::V1::Customers::CreditCreateParams::Specifier
-                  ],
+                specifiers: T::Array[MetronomeSDK::CommitSpecifierInput],
                 uniqueness_key: String,
                 request_options: MetronomeSDK::RequestOptions
               }
@@ -384,77 +371,6 @@ 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/customers/customer_alert.rbi

@@ -25,8 +25,8 @@ module MetronomeSDK
           end
           attr_writer :alert
 
-          # The status of the customer alert. If the alert is archived, null will be
-          # returned.
+          # The status of the threshold notification. If the notification is archived, null
+          # will be returned.
           sig do
             returns(
               T.nilable(
@@ -36,7 +36,7 @@ module MetronomeSDK
           end
           attr_accessor :customer_status
 
-          # If present, indicates the reason the alert was triggered.
+          # If present, indicates the reason the threshold notification was triggered.
           sig { returns(T.nilable(String)) }
           attr_accessor :triggered_by
 
@@ -52,10 +52,10 @@ module MetronomeSDK
           end
           def self.new(
             alert:,
-            # The status of the customer alert. If the alert is archived, null will be
-            # returned.
+            # The status of the threshold notification. If the notification is archived, null
+            # will be returned.
             customer_status:,
-            # If present, indicates the reason the alert was triggered.
+            # If present, indicates the reason the threshold notification was triggered.
             triggered_by: nil
           )
           end
@@ -84,15 +84,15 @@ module MetronomeSDK
                 )
               end
 
-            # the Metronome ID of the alert
+            # the Metronome ID of the threshold notification
             sig { returns(String) }
             attr_accessor :id
 
-            # Name of the alert
+            # Name of the threshold notification
             sig { returns(String) }
             attr_accessor :name
 
-            # Status of the alert
+            # Status of the threshold notification
             sig do
               returns(
                 MetronomeSDK::V1::Customers::CustomerAlert::Alert::Status::TaggedSymbol
@@ -100,11 +100,11 @@ module MetronomeSDK
             end
             attr_accessor :status
 
-            # Threshold value of the alert policy
+            # Threshold value of the notification policy
             sig { returns(Float) }
             attr_accessor :threshold
 
-            # Type of the alert
+            # Type of the threshold notification
             sig do
               returns(
                 MetronomeSDK::V1::Customers::CustomerAlert::Alert::Type::TaggedSymbol
@@ -112,13 +112,14 @@ module MetronomeSDK
             end
             attr_accessor :type
 
-            # Timestamp for when the alert was last updated
+            # Timestamp for when the threshold notification was last updated
             sig { returns(Time) }
             attr_accessor :updated_at
 
-            # An array of strings, representing a way to filter the credit grant this alert
-            # applies to, by looking at the credit_grant_type field on the credit grant. This
-            # field is only defined for CreditPercentage and CreditBalance alerts
+            # An array of strings, representing a way to filter the credit grant this
+            # threshold notification applies to, by looking at the credit_grant_type field on
+            # the credit grant. This field is only defined for CreditPercentage and
+            # CreditBalance notifications
             sig { returns(T.nilable(T::Array[String])) }
             attr_reader :credit_grant_type_filters
 
@@ -135,7 +136,8 @@ module MetronomeSDK
             end
             attr_writer :credit_type
 
-            # A list of custom field filters for alert types that support advanced filtering
+            # A list of custom field filters for notification types that support advanced
+            # filtering
             sig do
               returns(
                 T.nilable(
@@ -157,8 +159,8 @@ module MetronomeSDK
             end
             attr_writer :custom_field_filters
 
-            # Scopes alert evaluation to a specific presentation group key on individual line
-            # items. Only present for spend alerts.
+            # Scopes threshold notification evaluation to a specific presentation group key on
+            # individual line items. Only present for spend notifications.
             sig do
               returns(
                 T.nilable(
@@ -176,8 +178,8 @@ 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.
+            # Only present for `spend_threshold_reached` notifications. Scope notification to
+            # a specific group key on individual line items.
             sig do
               returns(
                 T.nilable(
@@ -199,8 +201,8 @@ module MetronomeSDK
             end
             attr_writer :group_values
 
-            # Only supported for invoice_total_reached alerts. A list of invoice types to
-            # evaluate.
+            # Only supported for invoice_total_reached threshold notifications. A list of
+            # invoice types to evaluate.
             sig { returns(T.nilable(T::Array[String])) }
             attr_reader :invoice_types_filter
 
@@ -243,33 +245,35 @@ module MetronomeSDK
               ).returns(T.attached_class)
             end
             def self.new(
-              # the Metronome ID of the alert
+              # the Metronome ID of the threshold notification
               id:,
-              # Name of the alert
+              # Name of the threshold notification
               name:,
-              # Status of the alert
+              # Status of the threshold notification
               status:,
-              # Threshold value of the alert policy
+              # Threshold value of the notification policy
               threshold:,
-              # Type of the alert
+              # Type of the threshold notification
               type:,
-              # Timestamp for when the alert was last updated
+              # Timestamp for when the threshold notification was last updated
               updated_at:,
-              # An array of strings, representing a way to filter the credit grant this alert
-              # applies to, by looking at the credit_grant_type field on the credit grant. This
-              # field is only defined for CreditPercentage and CreditBalance alerts
+              # An array of strings, representing a way to filter the credit grant this
+              # threshold notification applies to, by looking at the credit_grant_type field on
+              # the credit grant. This field is only defined for CreditPercentage and
+              # CreditBalance notifications
               credit_grant_type_filters: nil,
               credit_type: nil,
-              # A list of custom field filters for alert types that support advanced filtering
+              # A list of custom field filters for notification types that support advanced
+              # filtering
               custom_field_filters: nil,
-              # Scopes alert evaluation to a specific presentation group key on individual line
-              # items. Only present for spend alerts.
+              # Scopes threshold notification evaluation to a specific presentation group key on
+              # individual line items. Only present for spend notifications.
               group_key_filter: nil,
-              # Only present for `spend_threshold_reached` alerts. Scope alert to a specific
-              # group key on individual line items.
+              # Only present for `spend_threshold_reached` notifications. Scope notification 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.
+              # Only supported for invoice_total_reached threshold notifications. A list of
+              # invoice types to evaluate.
               invoice_types_filter: nil,
               # Prevents the creation of duplicates. If a request to create a record is made
               # with a previously used uniqueness key, a new record will not be created and the
@@ -309,7 +313,7 @@ module MetronomeSDK
             def to_hash
             end
 
-            # Status of the alert
+            # Status of the threshold notification
             module Status
               extend MetronomeSDK::Internal::Type::Enum
 
@@ -349,7 +353,7 @@ module MetronomeSDK
               end
             end
 
-            # Type of the alert
+            # Type of the threshold notification
             module Type
               extend MetronomeSDK::Internal::Type::Enum
 
@@ -545,8 +549,8 @@ module MetronomeSDK
               sig { returns(String) }
               attr_accessor :value
 
-              # Scopes alert evaluation to a specific presentation group key on individual line
-              # items. Only present for spend alerts.
+              # Scopes threshold notification evaluation to a specific presentation group key on
+              # individual line items. Only present for spend notifications.
               sig do
                 params(key: String, value: String).returns(T.attached_class)
               end
@@ -570,13 +574,16 @@ module MetronomeSDK
               sig { returns(String) }
               attr_accessor :key
 
-              sig { returns(String) }
-              attr_accessor :value
+              sig { returns(T.nilable(String)) }
+              attr_reader :value
+
+              sig { params(value: String).void }
+              attr_writer :value
 
               sig do
                 params(key: String, value: String).returns(T.attached_class)
               end
-              def self.new(key:, value:)
+              def self.new(key:, value: nil)
               end
 
               sig { override.returns({ key: String, value: String }) }
@@ -585,8 +592,8 @@ module MetronomeSDK
             end
           end
 
-          # The status of the customer alert. If the alert is archived, null will be
-          # returned.
+          # The status of the threshold notification. If the notification is archived, null
+          # will be returned.
           module CustomerStatus
             extend MetronomeSDK::Internal::Type::Enum