Class: MetronomeSDK::Resources::V1::Customers::Alerts

Inherits:
Object
  • Object
show all
Defined in:
lib/metronome_sdk/resources/v1/customers/alerts.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Alerts

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Alerts.

Parameters:



210
211
212
 
# File 'lib/metronome_sdk/resources/v1/customers/alerts.rb', line 210

def initialize(client:)
  @client = client
end

Instance Method Details

#list(customer_id: , next_page: nil, alert_statuses: nil, request_options: {}) ⇒ MetronomeSDK::Internal::CursorPageWithoutLimit<MetronomeSDK::Models::V1::Customers::CustomerAlert>

Some parameter documentations has been truncated, see Models::V1::Customers::AlertListParams for more details.

Retrieve all threshold notification configurations and their current statuses for a specific customer in a single API call. This endpoint provides a comprehensive view of all threshold notification monitoring a customer account.

### Use this endpoint to:

  • Display all active threshold notifications for a customer in dashboards or admin panels

  • Quickly identify which threshold notifications a customer is currently triggering

  • Audit threshold notification coverage for specific accounts

  • Filter threshold notifications by status (enabled, disabled, or archived)

### Key response fields:

  • data: Array of CustomerAlert objects, each containing:

    • Current evaluation status (‘ok`, `in_alarm`, `evaluating`, or `null`)

    • Complete threshold notification configuration and threshold details

    • Threshold notification metadata including type, name, and last update time

  • next_page: Pagination cursor for retrieving additional results

### Usage guidelines:

  • Default behavior: Returns only enabled threshold notifications unless ‘alert_statuses` filter is specified

  • Pagination: Use the ‘next_page` cursor to retrieve all results for customers with many notifications

  • Performance: Efficiently retrieves multiple threshold notification statuses in a single request instead of making individual calls

  • Filtering: Pass the ‘alert_statuses` array to include disabled or archived threshold notifications in results

Parameters:

Returns:

See Also:



141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/metronome_sdk/resources/v1/customers/alerts.rb', line 141

def list(params)
  parsed, options = MetronomeSDK::V1::Customers::AlertListParams.dump_request(params)
  query_params = [:next_page]
  @client.request(
    method: :post,
    path: "v1/customer-alerts/list",
    query: parsed.slice(*query_params),
    body: parsed.except(*query_params),
    page: MetronomeSDK::Internal::CursorPageWithoutLimit,
    model: MetronomeSDK::V1::Customers::CustomerAlert,
    options: options
  )
end

#reset(alert_id: , customer_id: , request_options: {}) ⇒ nil

Force an immediate re-evaluation of a specific threshold notification for a customer, clearing any previous state and triggering a fresh assessment against current thresholds. This endpoint ensures threshold notification accuracy after configuration changes or data corrections.

### Use this endpoint to:

  • Clear false positive threshold notifications after fixing data issues

  • Re-evaluate threshold notifications after adjusting customer balances or credits

  • Test threshold notification behavior during development and debugging

  • Resolve stuck threshold notification that may be in an incorrect state

  • Trigger immediate evaluation after threshold modifications

### Key response fields:

  • 200 Success: Confirmation that the threshold notification has been reset and re-evaluation initiated

  • No response body is returned - the operation completes asynchronously

### Usage guidelines:

  • Immediate effect: Triggers re-evaluation instantly, which may result in new webhook notifications if thresholds are breached

  • State clearing: Removes any cached evaluation state, ensuring a fresh assessment

  • Use sparingly: Intended for exceptional cases, not routine operations

  • Asynchronous processing: The reset completes immediately, but re-evaluation happens in the background

Parameters:

  • alert_id (String) —

    The Metronome ID of the threshold notification

  • customer_id (String) —

    The Metronome ID of the customer

  • request_options (MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

  • (nil)

See Also:



196
197
198
199
200
201
202
203
204
205
 
# File 'lib/metronome_sdk/resources/v1/customers/alerts.rb', line 196

def reset(params)
  parsed, options = MetronomeSDK::V1::Customers::AlertResetParams.dump_request(params)
  @client.request(
    method: :post,
    path: "v1/customer-alerts/reset",
    body: parsed,
    model: NilClass,
    options: options
  )
end

#retrieve(alert_id: , customer_id: , group_values: nil, plans_or_contracts: nil, request_options: {}) ⇒ MetronomeSDK::Models::V1::Customers::AlertRetrieveResponse

Some parameter documentations has been truncated, see Models::V1::Customers::AlertRetrieveParams for more details.

Retrieve the real-time evaluation status for a specific threshold notification-customer pair. This endpoint provides instant visibility into whether a customer has triggered a threshold notification condition, enabling you to monitor account health and take proactive action based on current threshold notification states.

### Use this endpoint to:

  • Check if a specific customer is currently violating an threshold notification (‘in_alarm` status)

  • Verify threshold notification configuration details and threshold values for a customer

  • Monitor the evaluation state of newly created or recently modified threshold notification

  • Build dashboards or automated workflows that respond to specific threshold notification conditions

  • Validate threshold notification behavior before deploying to production customers

  • Integrate threshold notification status checks into customer support tools or admin interfaces

### Key response fields:

A CustomerAlert object containing:

  • ‘customer_status`: The current evaluation state

  • ‘ok` - Customer is within acceptable thresholds

  • ‘in_alarm` - Customer has breached the threshold for the notification

  • ‘evaluating` - Notification is currently being evaluated (typically during initial setup)

  • ‘null` - Notification has been archived

  • ‘triggered_by`: Additional context about what caused the notification to trigger (when applicable)

  • alert: Complete threshold notification configuration including:

    • Notification ID, name, and type

    • Current threshold values and credit type information

    • Notification status (enabled, disabled, or archived)

    • Last update timestamp

    • Any applied filters (credit grant types, custom fields, group values)

### Usage guidelines:

  • Customer status: Returns the current evaluation state, not historical data. For threshold notification history, use webhook notifications or event logs

  • Required parameters: Both customer_id and alert_id must be valid UUIDs that exist in your organization

  • Archived notifications: Returns null for customer_status if the notification has been archived, but still includes the notification configuration details

  • Performance considerations: This endpoint queries live evaluation state, making it ideal for real-time monitoring but not for bulk status checks

  • Integration patterns: Best used for on-demand status checks in response to user actions or as part of targeted monitoring workflows

  • Error handling: Returns 404 if either the customer or alert_id doesn’t exist or isn’t accessible to your organization

Parameters:

Returns:

See Also:



82
83
84
85
86
87
88
89
90
91
 
# File 'lib/metronome_sdk/resources/v1/customers/alerts.rb', line 82

def retrieve(params)
  parsed, options = MetronomeSDK::V1::Customers::AlertRetrieveParams.dump_request(params)
  @client.request(
    method: :post,
    path: "v1/customer-alerts/get",
    body: parsed,
    model: MetronomeSDK::Models::V1::Customers::AlertRetrieveResponse,
    options: options
  )
end