metronome-sdk 3.7.0 → 3.9.0

data/lib/metronome_sdk/models/v1/customers/alert_retrieve_params.rb

@@ -21,6 +21,14 @@ module MetronomeSDK
           #   @return [String]
           required :customer_id, String
 
+          # @!attribute alert_specifiers
+          #   Can be used with only `low_remaining_contract_credit_and_commit_balance_reached`
+          #   notifications. Used to filter the alert by the custom field key-value pair.
+          #
+          #   @return [Array<MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::AlertSpecifier>, nil]
+          optional :alert_specifiers,
+                   -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::AlertRetrieveParams::AlertSpecifier] }
+
           # @!attribute group_values
           #   Only present for `spend_threshold_reached` notifications. Retrieve the
           #   notification for a specific group key-value pair.
@@ -44,7 +52,7 @@ module MetronomeSDK
           #   @return [MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::SeatFilter, nil]
           optional :seat_filter, -> { MetronomeSDK::V1::Customers::AlertRetrieveParams::SeatFilter }
 
-          # @!method initialize(alert_id:, customer_id:, group_values: nil, plans_or_contracts: nil, seat_filter: nil, request_options: {})
+          # @!method initialize(alert_id:, customer_id:, alert_specifiers: nil, group_values: nil, plans_or_contracts: nil, seat_filter: nil, request_options: {})
           #   Some parameter documentations has been truncated, see
           #   {MetronomeSDK::Models::V1::Customers::AlertRetrieveParams} for more details.
           #
@@ -52,6 +60,8 @@ module MetronomeSDK
           #
           #   @param customer_id [String] The Metronome ID of the customer
           #
+          #   @param alert_specifiers [Array<MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::AlertSpecifier>] Can be used with only `low_remaining_contract_credit_and_commit_balance_reached`
+          #
           #   @param group_values [Array<MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::GroupValue>] Only present for `spend_threshold_reached` notifications. Retrieve the notificat
           #
           #   @param plans_or_contracts [Symbol, MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::PlansOrContracts] When parallel threshold notifications are enabled during migration, this flag de
@@ -60,6 +70,122 @@ module MetronomeSDK
           #
           #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
 
+          class AlertSpecifier < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute custom_field_filters
+            #   A list of custom field filters for notification types that support advanced
+            #   filtering
+            #
+            #   @return [Array<MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::AlertSpecifier::CustomFieldFilter>]
+            required :custom_field_filters,
+                     -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::AlertRetrieveParams::AlertSpecifier::CustomFieldFilter] }
+
+            # @!attribute exclude
+            #   If provided, the specifier will not apply to balances that matches the inclusion
+            #   criteria and any of the excluding values.
+            #
+            #   @return [Array<MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::AlertSpecifier::Exclude>, nil]
+            optional :exclude,
+                     -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::AlertRetrieveParams::AlertSpecifier::Exclude] }
+
+            # @!method initialize(custom_field_filters:, exclude: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::AlertSpecifier} for
+            #   more details.
+            #
+            #   @param custom_field_filters [Array<MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::AlertSpecifier::CustomFieldFilter>] A list of custom field filters for notification types that support advanced filt
+            #
+            #   @param exclude [Array<MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::AlertSpecifier::Exclude>] If provided, the specifier will not apply to balances that matches the inclusion
+
+            class CustomFieldFilter < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute entity
+              #
+              #   @return [Symbol, MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::AlertSpecifier::CustomFieldFilter::Entity]
+              required :entity,
+                       enum: -> { MetronomeSDK::V1::Customers::AlertRetrieveParams::AlertSpecifier::CustomFieldFilter::Entity }
+
+              # @!attribute key
+              #
+              #   @return [String]
+              required :key, String
+
+              # @!attribute value
+              #
+              #   @return [String]
+              required :value, String
+
+              # @!method initialize(entity:, key:, value:)
+              #   @param entity [Symbol, MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::AlertSpecifier::CustomFieldFilter::Entity]
+              #   @param key [String]
+              #   @param value [String]
+
+              # @see MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::AlertSpecifier::CustomFieldFilter#entity
+              module Entity
+                extend MetronomeSDK::Internal::Type::Enum
+
+                CONTRACT = :Contract
+                COMMIT = :Commit
+                CONTRACT_CREDIT = :ContractCredit
+                CONTRACT_CREDIT_OR_COMMIT = :ContractCreditOrCommit
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+
+            class Exclude < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute custom_field_filters
+              #   A list of custom field filters for notification types that support advanced
+              #   filtering
+              #
+              #   @return [Array<MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::AlertSpecifier::Exclude::CustomFieldFilter>, nil]
+              optional :custom_field_filters,
+                       -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::AlertRetrieveParams::AlertSpecifier::Exclude::CustomFieldFilter] }
+
+              # @!method initialize(custom_field_filters: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::AlertSpecifier::Exclude}
+              #   for more details.
+              #
+              #   @param custom_field_filters [Array<MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::AlertSpecifier::Exclude::CustomFieldFilter>] A list of custom field filters for notification types that support advanced filt
+
+              class CustomFieldFilter < MetronomeSDK::Internal::Type::BaseModel
+                # @!attribute entity
+                #
+                #   @return [Symbol, MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::AlertSpecifier::Exclude::CustomFieldFilter::Entity]
+                required :entity,
+                         enum: -> { MetronomeSDK::V1::Customers::AlertRetrieveParams::AlertSpecifier::Exclude::CustomFieldFilter::Entity }
+
+                # @!attribute key
+                #
+                #   @return [String]
+                required :key, String
+
+                # @!attribute value
+                #
+                #   @return [String]
+                required :value, String
+
+                # @!method initialize(entity:, key:, value:)
+                #   @param entity [Symbol, MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::AlertSpecifier::Exclude::CustomFieldFilter::Entity]
+                #   @param key [String]
+                #   @param value [String]
+
+                # @see MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::AlertSpecifier::Exclude::CustomFieldFilter#entity
+                module Entity
+                  extend MetronomeSDK::Internal::Type::Enum
+
+                  CONTRACT = :Contract
+                  COMMIT = :Commit
+                  CONTRACT_CREDIT = :ContractCredit
+                  CONTRACT_CREDIT_OR_COMMIT = :ContractCreditOrCommit
+
+                  # @!method self.values
+                  #   @return [Array<Symbol>]
+                end
+              end
+            end
+          end
+
           class GroupValue < MetronomeSDK::Internal::Type::BaseModel
             # @!attribute key
             #

data/lib/metronome_sdk/models/v1/customers/customer_alert.rb

@@ -69,11 +69,20 @@ module MetronomeSDK
             required :type, enum: -> { MetronomeSDK::V1::Customers::CustomerAlert::Alert::Type }
 
             # @!attribute updated_at
-            #   Timestamp for when the threshold notification was last updated
+            #   Timestamp for when the threshold notification's customer status was last updated
             #
             #   @return [Time]
             required :updated_at, Time
 
+            # @!attribute alert_specifiers
+            #   Present for `low_remaining_contract_credit_and_commit_balance_reached`
+            #   notifications. The filters that define the balances that are considered when
+            #   evaluating the alert.
+            #
+            #   @return [Array<MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::AlertSpecifier>, nil]
+            optional :alert_specifiers,
+                     -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CustomerAlert::Alert::AlertSpecifier] }
+
             # @!attribute credit_grant_type_filters
             #   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
@@ -133,7 +142,7 @@ module MetronomeSDK
             #   @return [String, nil]
             optional :uniqueness_key, String
 
-            # @!method initialize(id:, name:, status:, threshold:, type:, updated_at:, credit_grant_type_filters: nil, credit_type: nil, custom_field_filters: nil, group_key_filter: nil, group_values: nil, invoice_types_filter: nil, seat_filter: nil, uniqueness_key: nil)
+            # @!method initialize(id:, name:, status:, threshold:, type:, updated_at:, alert_specifiers: nil, credit_grant_type_filters: nil, credit_type: nil, custom_field_filters: nil, group_key_filter: nil, group_values: nil, invoice_types_filter: nil, seat_filter: nil, uniqueness_key: nil)
             #   Some parameter documentations has been truncated, see
             #   {MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert} for more details.
             #
@@ -147,7 +156,9 @@ module MetronomeSDK
             #
             #   @param type [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::Type] Type of the threshold notification
             #
-            #   @param updated_at [Time] Timestamp for when the threshold notification was last updated
+            #   @param updated_at [Time] Timestamp for when the threshold notification's customer status was last updated
+            #
+            #   @param alert_specifiers [Array<MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::AlertSpecifier>] Present for `low_remaining_contract_credit_and_commit_balance_reached` notificat
             #
             #   @param credit_grant_type_filters [Array<String>] An array of strings, representing a way to filter the credit grant this threshol
             #
@@ -207,6 +218,122 @@ module MetronomeSDK
               #   @return [Array<Symbol>]
             end
 
+            class AlertSpecifier < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute custom_field_filters
+              #   A list of custom field filters for notification types that support advanced
+              #   filtering
+              #
+              #   @return [Array<MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::AlertSpecifier::CustomFieldFilter>, nil]
+              optional :custom_field_filters,
+                       -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CustomerAlert::Alert::AlertSpecifier::CustomFieldFilter] }
+
+              # @!attribute exclude
+              #   If provided, the specifier will not apply to balances that matches the inclusion
+              #   criteria and any of the excluding values.
+              #
+              #   @return [Array<MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::AlertSpecifier::Exclude>, nil]
+              optional :exclude,
+                       -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CustomerAlert::Alert::AlertSpecifier::Exclude] }
+
+              # @!method initialize(custom_field_filters: nil, exclude: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::AlertSpecifier} for
+              #   more details.
+              #
+              #   @param custom_field_filters [Array<MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::AlertSpecifier::CustomFieldFilter>] A list of custom field filters for notification types that support advanced filt
+              #
+              #   @param exclude [Array<MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::AlertSpecifier::Exclude>] If provided, the specifier will not apply to balances that matches the inclusion
+
+              class CustomFieldFilter < MetronomeSDK::Internal::Type::BaseModel
+                # @!attribute entity
+                #
+                #   @return [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::AlertSpecifier::CustomFieldFilter::Entity]
+                required :entity,
+                         enum: -> { MetronomeSDK::V1::Customers::CustomerAlert::Alert::AlertSpecifier::CustomFieldFilter::Entity }
+
+                # @!attribute key
+                #
+                #   @return [String]
+                required :key, String
+
+                # @!attribute value
+                #
+                #   @return [String, nil]
+                optional :value, String
+
+                # @!method initialize(entity:, key:, value: nil)
+                #   @param entity [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::AlertSpecifier::CustomFieldFilter::Entity]
+                #   @param key [String]
+                #   @param value [String]
+
+                # @see MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::AlertSpecifier::CustomFieldFilter#entity
+                module Entity
+                  extend MetronomeSDK::Internal::Type::Enum
+
+                  CONTRACT = :Contract
+                  COMMIT = :Commit
+                  CONTRACT_CREDIT = :ContractCredit
+                  CONTRACT_CREDIT_OR_COMMIT = :ContractCreditOrCommit
+
+                  # @!method self.values
+                  #   @return [Array<Symbol>]
+                end
+              end
+
+              class Exclude < MetronomeSDK::Internal::Type::BaseModel
+                # @!attribute custom_field_filters
+                #   A list of custom field filters for notification types that support advanced
+                #   filtering
+                #
+                #   @return [Array<MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::AlertSpecifier::Exclude::CustomFieldFilter>, nil]
+                optional :custom_field_filters,
+                         -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CustomerAlert::Alert::AlertSpecifier::Exclude::CustomFieldFilter] }
+
+                # @!method initialize(custom_field_filters: nil)
+                #   Some parameter documentations has been truncated, see
+                #   {MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::AlertSpecifier::Exclude}
+                #   for more details.
+                #
+                #   @param custom_field_filters [Array<MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::AlertSpecifier::Exclude::CustomFieldFilter>] A list of custom field filters for notification types that support advanced filt
+
+                class CustomFieldFilter < MetronomeSDK::Internal::Type::BaseModel
+                  # @!attribute entity
+                  #
+                  #   @return [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::AlertSpecifier::Exclude::CustomFieldFilter::Entity]
+                  required :entity,
+                           enum: -> { MetronomeSDK::V1::Customers::CustomerAlert::Alert::AlertSpecifier::Exclude::CustomFieldFilter::Entity }
+
+                  # @!attribute key
+                  #
+                  #   @return [String]
+                  required :key, String
+
+                  # @!attribute value
+                  #
+                  #   @return [String]
+                  required :value, String
+
+                  # @!method initialize(entity:, key:, value:)
+                  #   @param entity [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::AlertSpecifier::Exclude::CustomFieldFilter::Entity]
+                  #   @param key [String]
+                  #   @param value [String]
+
+                  # @see MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::AlertSpecifier::Exclude::CustomFieldFilter#entity
+                  module Entity
+                    extend MetronomeSDK::Internal::Type::Enum
+
+                    CONTRACT = :Contract
+                    COMMIT = :Commit
+                    CONTRACT_CREDIT = :ContractCredit
+                    CONTRACT_CREDIT_OR_COMMIT = :ContractCreditOrCommit
+
+                    # @!method self.values
+                    #   @return [Array<Symbol>]
+                  end
+                end
+              end
+            end
+
             class CustomFieldFilter < MetronomeSDK::Internal::Type::BaseModel
               # @!attribute entity
               #

data/lib/metronome_sdk/models/v1/customers/invoice_list_params.rb

@@ -77,7 +77,14 @@ module MetronomeSDK
           #   @return [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListParams::Type, nil]
           optional :type, enum: -> { MetronomeSDK::V1::Customers::InvoiceListParams::Type }
 
-          # @!method initialize(customer_id:, contract_id: nil, credit_type_id: nil, ending_before: nil, limit: nil, next_page: nil, skip_zero_qty_line_items: nil, sort: nil, starting_on: nil, status: nil, type: nil, request_options: {})
+          # @!attribute webhook_notification_id
+          #   Indicates that this API request was triggered by a webhook notification with the
+          #   provided ID.
+          #
+          #   @return [String, nil]
+          optional :webhook_notification_id, String
+
+          # @!method initialize(customer_id:, contract_id: nil, credit_type_id: nil, ending_before: nil, limit: nil, next_page: nil, skip_zero_qty_line_items: nil, sort: nil, starting_on: nil, status: nil, type: nil, webhook_notification_id: nil, request_options: {})
           #   Some parameter documentations has been truncated, see
           #   {MetronomeSDK::Models::V1::Customers::InvoiceListParams} for more details.
           #
@@ -103,6 +110,8 @@ module MetronomeSDK
           #
           #   @param type [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListParams::Type] Filter invoices by type. Defaults to returning all invoice types.
           #
+          #   @param webhook_notification_id [String] Indicates that this API request was triggered by a webhook notification with the
+          #
           #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
 
           # Invoice sort order by issued_at, e.g. date_asc or date_desc. Defaults to

data/lib/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rb

@@ -143,6 +143,8 @@ module MetronomeSDK
             PRIMARY_RED = :Primary_red
             PROGRESS_BAR = :Progress_bar
             PROGRESS_BAR_BACKGROUND = :Progress_bar_background
+            ACTION = :Action
+            ACTION_HOVER = :Action_hover
 
             # @!method self.values
             #   @return [Array<Symbol>]