metronome-sdk 3.10.0 → 3.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +50 -0
- data/README.md +1 -10
- data/lib/metronome_sdk/internal/body_cursor_page_cursor_field.rb +86 -0
- data/lib/metronome_sdk/models/contract_v2.rb +111 -7
- data/lib/metronome_sdk/models/contract_without_amendments.rb +86 -6
- data/lib/metronome_sdk/models/credit.rb +13 -1
- data/lib/metronome_sdk/models/prepaid_balance_threshold_configuration.rb +70 -1
- data/lib/metronome_sdk/models/prepaid_balance_threshold_configuration_v2.rb +70 -1
- data/lib/metronome_sdk/models/schedule_duration.rb +28 -1
- data/lib/metronome_sdk/models/subscription.rb +27 -1
- data/lib/metronome_sdk/models/v1/alert_create_params.rb +43 -5
- data/lib/metronome_sdk/models/v1/billable_metric_update_params.rb +31 -0
- data/lib/metronome_sdk/models/v1/billable_metric_update_response.rb +18 -0
- data/lib/metronome_sdk/models/v1/contract_add_manual_balance_entry_params.rb +11 -1
- data/lib/metronome_sdk/models/v1/contract_amend_params.rb +62 -2
- data/lib/metronome_sdk/models/v1/contract_create_params.rb +128 -18
- data/lib/metronome_sdk/models/v1/contract_create_response.rb +86 -6
- data/lib/metronome_sdk/models/v1/contract_get_net_balance_params.rb +22 -1
- data/lib/metronome_sdk/models/v1/contract_get_net_balance_response.rb +4 -3
- data/lib/metronome_sdk/models/v1/contract_list_balances_params.rb +22 -1
- data/lib/metronome_sdk/models/v1/contract_list_params.rb +18 -2
- data/lib/metronome_sdk/models/v1/contract_list_seat_balances_response.rb +96 -4
- data/lib/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_response.rb +16 -1
- data/lib/metronome_sdk/models/v1/contracts/product_create_params.rb +10 -1
- data/lib/metronome_sdk/models/v1/contracts/product_list_item_state.rb +10 -1
- data/lib/metronome_sdk/models/v1/contracts/product_list_response.rb +10 -1
- data/lib/metronome_sdk/models/v1/contracts/product_retrieve_response.rb +10 -1
- data/lib/metronome_sdk/models/v1/contracts/product_update_params.rb +10 -1
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_list_params.rb +82 -0
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_list_response.rb +69 -0
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_params.rb +10 -1
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_update_params.rb +10 -1
- data/lib/metronome_sdk/models/v1/customer_create_params.rb +4 -14
- data/lib/metronome_sdk/models/v1/customer_set_billing_configurations_params.rb +2 -4
- data/lib/metronome_sdk/models/v1/customers/alert_retrieve_params.rb +4 -3
- data/lib/metronome_sdk/models/v1/customers/billing_config_create_params.rb +2 -6
- data/lib/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rb +2 -6
- data/lib/metronome_sdk/models/v1/customers/commit_create_params.rb +31 -1
- data/lib/metronome_sdk/models/v1/customers/commit_list_params.rb +22 -1
- data/lib/metronome_sdk/models/v1/customers/credit_create_params.rb +31 -1
- data/lib/metronome_sdk/models/v1/customers/customer_alert.rb +46 -5
- data/lib/metronome_sdk/models/v1/customers/invoice.rb +52 -13
- data/lib/metronome_sdk/models/v1/customers/invoice_list_params.rb +10 -1
- data/lib/metronome_sdk/models/v1/package_create_params.rb +129 -18
- data/lib/metronome_sdk/models/v1/package_list_response.rb +139 -7
- data/lib/metronome_sdk/models/v1/package_retrieve_response.rb +139 -7
- data/lib/metronome_sdk/models/v1/pricing_unit_archive_params.rb +16 -0
- data/lib/metronome_sdk/models/v1/pricing_unit_archive_response.rb +18 -0
- data/lib/metronome_sdk/models/v1/pricing_unit_create_params.rb +24 -0
- data/lib/metronome_sdk/models/v1/pricing_unit_create_response.rb +18 -0
- data/lib/metronome_sdk/models/v1/usage_list_params.rb +4 -2
- data/lib/metronome_sdk/models/v1/usage_list_with_groups_params.rb +11 -8
- data/lib/metronome_sdk/models/v2/contract_edit_params.rb +221 -20
- data/lib/metronome_sdk/models/v2/contract_edit_response.rb +200 -9
- data/lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb +200 -9
- data/lib/metronome_sdk/models/v2/contract_list_params.rb +17 -1
- data/lib/metronome_sdk/models/v2/lifecycle_event_offset_notification_config.rb +104 -0
- data/lib/metronome_sdk/models/v2/lifecycle_event_system_notification_config.rb +45 -0
- data/lib/metronome_sdk/models/v2/notifications/offset_archive_params.rb +29 -0
- data/lib/metronome_sdk/models/v2/notifications/offset_archive_response.rb +20 -0
- data/lib/metronome_sdk/models/v2/notifications/offset_create_params.rb +77 -0
- data/lib/metronome_sdk/models/v2/notifications/offset_create_response.rb +20 -0
- data/lib/metronome_sdk/models/v2/notifications/offset_edit_params.rb +98 -0
- data/lib/metronome_sdk/models/v2/notifications/offset_edit_response.rb +32 -0
- data/lib/metronome_sdk/models/v2/notifications/offset_list_params.rb +57 -0
- data/lib/metronome_sdk/models/v2/notifications/offset_retrieve_params.rb +26 -0
- data/lib/metronome_sdk/models/v2/notifications/offset_retrieve_response.rb +20 -0
- data/lib/metronome_sdk/models/v2/notifications/system_list_params.rb +18 -0
- data/lib/metronome_sdk/models/v2/notifications/system_list_response.rb +27 -0
- data/lib/metronome_sdk/resources/v1/alerts.rb +6 -2
- data/lib/metronome_sdk/resources/v1/billable_metrics.rb +45 -0
- data/lib/metronome_sdk/resources/v1/contracts/products.rb +6 -2
- data/lib/metronome_sdk/resources/v1/contracts/rate_cards/named_schedules.rb +46 -2
- data/lib/metronome_sdk/resources/v1/contracts.rb +26 -9
- data/lib/metronome_sdk/resources/v1/custom_fields.rb +3 -0
- data/lib/metronome_sdk/resources/v1/customers/alerts.rb +1 -1
- data/lib/metronome_sdk/resources/v1/customers/commits.rb +6 -1
- data/lib/metronome_sdk/resources/v1/customers/credits.rb +3 -0
- data/lib/metronome_sdk/resources/v1/customers/invoices.rb +3 -1
- data/lib/metronome_sdk/resources/v1/pricing_units.rb +45 -0
- data/lib/metronome_sdk/resources/v1/usage.rb +12 -10
- data/lib/metronome_sdk/resources/v2/contracts.rb +15 -6
- data/lib/metronome_sdk/resources/v2/notifications/offset.rb +157 -0
- data/lib/metronome_sdk/resources/v2/notifications/system.rb +37 -0
- data/lib/metronome_sdk/resources/v2/notifications.rb +24 -0
- data/lib/metronome_sdk/resources/v2.rb +4 -0
- data/lib/metronome_sdk/version.rb +1 -1
- data/lib/metronome_sdk.rb +25 -2
- data/rbi/metronome_sdk/internal/body_cursor_page_cursor_field.rbi +22 -0
- data/rbi/metronome_sdk/models/contract_v2.rbi +202 -4
- data/rbi/metronome_sdk/models/contract_without_amendments.rbi +168 -4
- data/rbi/metronome_sdk/models/credit.rbi +19 -0
- data/rbi/metronome_sdk/models/prepaid_balance_threshold_configuration.rbi +186 -0
- data/rbi/metronome_sdk/models/prepaid_balance_threshold_configuration_v2.rbi +186 -0
- data/rbi/metronome_sdk/models/schedule_duration.rbi +57 -1
- data/rbi/metronome_sdk/models/subscription.rbi +34 -0
- data/rbi/metronome_sdk/models/v1/alert_create_params.rbi +91 -6
- data/rbi/metronome_sdk/models/v1/billable_metric_update_params.rbi +54 -0
- data/rbi/metronome_sdk/models/v1/billable_metric_update_response.rbi +31 -0
- data/rbi/metronome_sdk/models/v1/contract_add_manual_balance_entry_params.rbi +15 -0
- data/rbi/metronome_sdk/models/v1/contract_amend_params.rbi +130 -0
- data/rbi/metronome_sdk/models/v1/contract_create_params.rbi +284 -12
- data/rbi/metronome_sdk/models/v1/contract_create_response.rbi +158 -2
- data/rbi/metronome_sdk/models/v1/contract_get_net_balance_params.rbi +62 -0
- data/rbi/metronome_sdk/models/v1/contract_get_net_balance_response.rbi +6 -4
- data/rbi/metronome_sdk/models/v1/contract_list_balances_params.rbi +62 -0
- data/rbi/metronome_sdk/models/v1/contract_list_params.rbi +24 -2
- data/rbi/metronome_sdk/models/v1/contract_list_seat_balances_response.rbi +219 -3
- data/rbi/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_response.rbi +13 -0
- data/rbi/metronome_sdk/models/v1/contracts/product_create_params.rbi +13 -0
- data/rbi/metronome_sdk/models/v1/contracts/product_list_item_state.rbi +13 -0
- data/rbi/metronome_sdk/models/v1/contracts/product_list_response.rbi +13 -0
- data/rbi/metronome_sdk/models/v1/contracts/product_retrieve_response.rbi +13 -0
- data/rbi/metronome_sdk/models/v1/contracts/product_update_params.rbi +13 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_list_params.rbi +122 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_list_response.rbi +123 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_params.rbi +13 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_update_params.rbi +13 -0
- data/rbi/metronome_sdk/models/v1/customer_create_params.rbi +6 -22
- data/rbi/metronome_sdk/models/v1/customer_set_billing_configurations_params.rbi +3 -6
- data/rbi/metronome_sdk/models/v1/customers/alert_retrieve_params.rbi +6 -4
- data/rbi/metronome_sdk/models/v1/customers/billing_config_create_params.rbi +3 -16
- data/rbi/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbi +3 -16
- data/rbi/metronome_sdk/models/v1/customers/commit_create_params.rbi +65 -0
- data/rbi/metronome_sdk/models/v1/customers/commit_list_params.rbi +62 -0
- data/rbi/metronome_sdk/models/v1/customers/credit_create_params.rbi +65 -0
- data/rbi/metronome_sdk/models/v1/customers/customer_alert.rbi +96 -6
- data/rbi/metronome_sdk/models/v1/customers/invoice.rbi +99 -19
- data/rbi/metronome_sdk/models/v1/customers/invoice_list_params.rbi +13 -0
- data/rbi/metronome_sdk/models/v1/package_create_params.rbi +289 -12
- data/rbi/metronome_sdk/models/v1/package_list_response.rbi +306 -10
- data/rbi/metronome_sdk/models/v1/package_retrieve_response.rbi +306 -10
- data/rbi/metronome_sdk/models/v1/pricing_unit_archive_params.rbi +34 -0
- data/rbi/metronome_sdk/models/v1/pricing_unit_archive_response.rbi +31 -0
- data/rbi/metronome_sdk/models/v1/pricing_unit_create_params.rbi +45 -0
- data/rbi/metronome_sdk/models/v1/pricing_unit_create_response.rbi +31 -0
- data/rbi/metronome_sdk/models/v1/usage_list_params.rbi +4 -0
- data/rbi/metronome_sdk/models/v1/usage_list_with_groups_params.rbi +16 -10
- data/rbi/metronome_sdk/models/v2/contract_edit_params.rbi +492 -14
- data/rbi/metronome_sdk/models/v2/contract_edit_response.rbi +394 -2
- data/rbi/metronome_sdk/models/v2/contract_get_edit_history_response.rbi +402 -4
- data/rbi/metronome_sdk/models/v2/contract_list_params.rbi +22 -0
- data/rbi/metronome_sdk/models/v2/lifecycle_event_offset_notification_config.rbi +147 -0
- data/rbi/metronome_sdk/models/v2/lifecycle_event_system_notification_config.rbi +98 -0
- data/rbi/metronome_sdk/models/v2/notifications/offset_archive_params.rbi +47 -0
- data/rbi/metronome_sdk/models/v2/notifications/offset_archive_response.rbi +49 -0
- data/rbi/metronome_sdk/models/v2/notifications/offset_create_params.rbi +127 -0
- data/rbi/metronome_sdk/models/v2/notifications/offset_create_response.rbi +49 -0
- data/rbi/metronome_sdk/models/v2/notifications/offset_edit_params.rbi +181 -0
- data/rbi/metronome_sdk/models/v2/notifications/offset_edit_response.rbi +71 -0
- data/rbi/metronome_sdk/models/v2/notifications/offset_list_params.rbi +127 -0
- data/rbi/metronome_sdk/models/v2/notifications/offset_retrieve_params.rbi +47 -0
- data/rbi/metronome_sdk/models/v2/notifications/offset_retrieve_response.rbi +49 -0
- data/rbi/metronome_sdk/models/v2/notifications/system_list_params.rbi +36 -0
- data/rbi/metronome_sdk/models/v2/notifications/system_list_response.rbi +55 -0
- data/rbi/metronome_sdk/resources/v1/alerts.rbi +18 -3
- data/rbi/metronome_sdk/resources/v1/billable_metrics.rbi +34 -0
- data/rbi/metronome_sdk/resources/v1/contracts/products.rbi +8 -0
- data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/named_schedules.rbi +47 -0
- data/rbi/metronome_sdk/resources/v1/contracts.rbi +36 -5
- data/rbi/metronome_sdk/resources/v1/custom_fields.rbi +3 -0
- data/rbi/metronome_sdk/resources/v1/customers/alerts.rbi +3 -2
- data/rbi/metronome_sdk/resources/v1/customers/billing_config.rbi +1 -2
- data/rbi/metronome_sdk/resources/v1/customers/commits.rbi +8 -0
- data/rbi/metronome_sdk/resources/v1/customers/credits.rbi +3 -0
- data/rbi/metronome_sdk/resources/v1/customers/invoices.rbi +4 -0
- data/rbi/metronome_sdk/resources/v1/pricing_units.rbi +26 -0
- data/rbi/metronome_sdk/resources/v1/usage.rbi +18 -13
- data/rbi/metronome_sdk/resources/v2/contracts.rbi +18 -4
- data/rbi/metronome_sdk/resources/v2/notifications/offset.rbi +130 -0
- data/rbi/metronome_sdk/resources/v2/notifications/system.rbi +28 -0
- data/rbi/metronome_sdk/resources/v2/notifications.rbi +20 -0
- data/rbi/metronome_sdk/resources/v2.rbi +3 -0
- data/sig/metronome_sdk/internal/body_cursor_page_cursor_field.rbs +13 -0
- data/sig/metronome_sdk/models/contract_v2.rbs +81 -2
- data/sig/metronome_sdk/models/contract_without_amendments.rbs +60 -2
- data/sig/metronome_sdk/models/credit.rbs +7 -0
- data/sig/metronome_sdk/models/prepaid_balance_threshold_configuration.rbs +71 -0
- data/sig/metronome_sdk/models/prepaid_balance_threshold_configuration_v2.rbs +71 -0
- data/sig/metronome_sdk/models/schedule_duration.rbs +20 -0
- data/sig/metronome_sdk/models/subscription.rbs +21 -0
- data/sig/metronome_sdk/models/v1/alert_create_params.rbs +22 -0
- data/sig/metronome_sdk/models/v1/billable_metric_update_params.rbs +30 -0
- data/sig/metronome_sdk/models/v1/billable_metric_update_response.rbs +15 -0
- data/sig/metronome_sdk/models/v1/contract_add_manual_balance_entry_params.rbs +8 -1
- data/sig/metronome_sdk/models/v1/contract_amend_params.rbs +40 -0
- data/sig/metronome_sdk/models/v1/contract_create_params.rbs +102 -10
- data/sig/metronome_sdk/models/v1/contract_create_response.rbs +60 -2
- data/sig/metronome_sdk/models/v1/contract_get_net_balance_params.rbs +20 -0
- data/sig/metronome_sdk/models/v1/contract_list_balances_params.rbs +20 -0
- data/sig/metronome_sdk/models/v1/contract_list_params.rbs +14 -0
- data/sig/metronome_sdk/models/v1/contract_list_seat_balances_response.rbs +81 -3
- data/sig/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_response.rbs +7 -0
- data/sig/metronome_sdk/models/v1/contracts/product_create_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/contracts/product_list_item_state.rbs +7 -0
- data/sig/metronome_sdk/models/v1/contracts/product_list_response.rbs +7 -0
- data/sig/metronome_sdk/models/v1/contracts/product_retrieve_response.rbs +7 -0
- data/sig/metronome_sdk/models/v1/contracts/product_update_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_list_params.rbs +74 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_list_response.rbs +68 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_params.rbs +8 -1
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_update_params.rbs +8 -1
- data/sig/metronome_sdk/models/v1/customer_create_params.rbs +1 -7
- data/sig/metronome_sdk/models/v1/customers/billing_config_create_params.rbs +1 -7
- data/sig/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbs +1 -6
- data/sig/metronome_sdk/models/v1/customers/commit_create_params.rbs +20 -0
- data/sig/metronome_sdk/models/v1/customers/commit_list_params.rbs +20 -0
- data/sig/metronome_sdk/models/v1/customers/credit_create_params.rbs +20 -0
- data/sig/metronome_sdk/models/v1/customers/customer_alert.rbs +22 -0
- data/sig/metronome_sdk/models/v1/customers/invoice.rbs +30 -3
- data/sig/metronome_sdk/models/v1/customers/invoice_list_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/package_create_params.rbs +104 -11
- data/sig/metronome_sdk/models/v1/package_list_response.rbs +105 -9
- data/sig/metronome_sdk/models/v1/package_retrieve_response.rbs +105 -9
- data/sig/metronome_sdk/models/v1/pricing_unit_archive_params.rbs +17 -0
- data/sig/metronome_sdk/models/v1/pricing_unit_archive_response.rbs +15 -0
- data/sig/metronome_sdk/models/v1/pricing_unit_create_params.rbs +25 -0
- data/sig/metronome_sdk/models/v1/pricing_unit_create_response.rbs +15 -0
- data/sig/metronome_sdk/models/v2/contract_edit_params.rbs +180 -10
- data/sig/metronome_sdk/models/v2/contract_edit_response.rbs +159 -2
- data/sig/metronome_sdk/models/v2/contract_get_edit_history_response.rbs +159 -2
- data/sig/metronome_sdk/models/v2/contract_list_params.rbs +14 -0
- data/sig/metronome_sdk/models/v2/lifecycle_event_offset_notification_config.rbs +69 -0
- data/sig/metronome_sdk/models/v2/lifecycle_event_system_notification_config.rbs +44 -0
- data/sig/metronome_sdk/models/v2/notifications/offset_archive_params.rbs +27 -0
- data/sig/metronome_sdk/models/v2/notifications/offset_archive_response.rbs +22 -0
- data/sig/metronome_sdk/models/v2/notifications/offset_create_params.rbs +54 -0
- data/sig/metronome_sdk/models/v2/notifications/offset_create_response.rbs +22 -0
- data/sig/metronome_sdk/models/v2/notifications/offset_edit_params.rbs +77 -0
- data/sig/metronome_sdk/models/v2/notifications/offset_edit_response.rbs +34 -0
- data/sig/metronome_sdk/models/v2/notifications/offset_list_params.rbs +60 -0
- data/sig/metronome_sdk/models/v2/notifications/offset_retrieve_params.rbs +27 -0
- data/sig/metronome_sdk/models/v2/notifications/offset_retrieve_response.rbs +22 -0
- data/sig/metronome_sdk/models/v2/notifications/system_list_params.rbs +19 -0
- data/sig/metronome_sdk/models/v2/notifications/system_list_response.rbs +29 -0
- data/sig/metronome_sdk/resources/v1/alerts.rbs +1 -0
- data/sig/metronome_sdk/resources/v1/billable_metrics.rbs +6 -0
- data/sig/metronome_sdk/resources/v1/contracts/products.rbs +2 -0
- data/sig/metronome_sdk/resources/v1/contracts/rate_cards/named_schedules.rbs +13 -0
- data/sig/metronome_sdk/resources/v1/contracts.rbs +6 -1
- data/sig/metronome_sdk/resources/v1/customers/commits.rbs +1 -0
- data/sig/metronome_sdk/resources/v1/customers/invoices.rbs +1 -0
- data/sig/metronome_sdk/resources/v1/pricing_units.rbs +10 -0
- data/sig/metronome_sdk/resources/v2/contracts.rbs +3 -1
- data/sig/metronome_sdk/resources/v2/notifications/offset.rbs +42 -0
- data/sig/metronome_sdk/resources/v2/notifications/system.rbs +15 -0
- data/sig/metronome_sdk/resources/v2/notifications.rbs +13 -0
- data/sig/metronome_sdk/resources/v2.rbs +2 -0
- metadata +77 -8
- data/lib/metronome_sdk/models/v1/contract_list_response.rb +0 -18
- data/lib/metronome_sdk/models/v2/contract_list_response.rb +0 -18
- data/rbi/metronome_sdk/models/v1/contract_list_response.rbi +0 -32
- data/rbi/metronome_sdk/models/v2/contract_list_response.rbi +0 -32
- data/sig/metronome_sdk/models/v1/contract_list_response.rbs +0 -15
- data/sig/metronome_sdk/models/v2/contract_list_response.rbs +0 -15
|
@@ -0,0 +1,181 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module MetronomeSDK
|
|
4
|
+
module Models
|
|
5
|
+
module V2
|
|
6
|
+
module Notifications
|
|
7
|
+
class OffsetEditParams < MetronomeSDK::Internal::Type::BaseModel
|
|
8
|
+
extend MetronomeSDK::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include MetronomeSDK::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
OrHash =
|
|
12
|
+
T.type_alias do
|
|
13
|
+
T.any(
|
|
14
|
+
MetronomeSDK::V2::Notifications::OffsetEditParams,
|
|
15
|
+
MetronomeSDK::Internal::AnyHash
|
|
16
|
+
)
|
|
17
|
+
end
|
|
18
|
+
|
|
19
|
+
# Updated policy configuration. The policy.type must match the existing lifecycle
|
|
20
|
+
# event type.
|
|
21
|
+
sig do
|
|
22
|
+
returns(
|
|
23
|
+
T.any(
|
|
24
|
+
MetronomeSDK::V2::Notifications::OffsetEditParams::Policy::LifecycleEventOffsetPolicy,
|
|
25
|
+
MetronomeSDK::V2::Notifications::OffsetEditParams::Policy::LifecycleEventSystemPolicy
|
|
26
|
+
)
|
|
27
|
+
)
|
|
28
|
+
end
|
|
29
|
+
attr_accessor :policy
|
|
30
|
+
|
|
31
|
+
# The ID of the notification configuration to edit. Not provided when updating the
|
|
32
|
+
# configuration for system events
|
|
33
|
+
sig { returns(T.nilable(String)) }
|
|
34
|
+
attr_reader :id
|
|
35
|
+
|
|
36
|
+
sig { params(id: String).void }
|
|
37
|
+
attr_writer :id
|
|
38
|
+
|
|
39
|
+
# Set to true to enable webhook messages for the notification indicated in the
|
|
40
|
+
# policy, false to disable. Only supported by system lifecycle events.
|
|
41
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
42
|
+
attr_reader :is_enabled
|
|
43
|
+
|
|
44
|
+
sig { params(is_enabled: T::Boolean).void }
|
|
45
|
+
attr_writer :is_enabled
|
|
46
|
+
|
|
47
|
+
sig do
|
|
48
|
+
params(
|
|
49
|
+
policy:
|
|
50
|
+
T.any(
|
|
51
|
+
MetronomeSDK::V2::Notifications::OffsetEditParams::Policy::LifecycleEventOffsetPolicy::OrHash,
|
|
52
|
+
MetronomeSDK::V2::Notifications::OffsetEditParams::Policy::LifecycleEventSystemPolicy::OrHash
|
|
53
|
+
),
|
|
54
|
+
id: String,
|
|
55
|
+
is_enabled: T::Boolean,
|
|
56
|
+
request_options: MetronomeSDK::RequestOptions::OrHash
|
|
57
|
+
).returns(T.attached_class)
|
|
58
|
+
end
|
|
59
|
+
def self.new(
|
|
60
|
+
# Updated policy configuration. The policy.type must match the existing lifecycle
|
|
61
|
+
# event type.
|
|
62
|
+
policy:,
|
|
63
|
+
# The ID of the notification configuration to edit. Not provided when updating the
|
|
64
|
+
# configuration for system events
|
|
65
|
+
id: nil,
|
|
66
|
+
# Set to true to enable webhook messages for the notification indicated in the
|
|
67
|
+
# policy, false to disable. Only supported by system lifecycle events.
|
|
68
|
+
is_enabled: nil,
|
|
69
|
+
request_options: {}
|
|
70
|
+
)
|
|
71
|
+
end
|
|
72
|
+
|
|
73
|
+
sig do
|
|
74
|
+
override.returns(
|
|
75
|
+
{
|
|
76
|
+
policy:
|
|
77
|
+
T.any(
|
|
78
|
+
MetronomeSDK::V2::Notifications::OffsetEditParams::Policy::LifecycleEventOffsetPolicy,
|
|
79
|
+
MetronomeSDK::V2::Notifications::OffsetEditParams::Policy::LifecycleEventSystemPolicy
|
|
80
|
+
),
|
|
81
|
+
id: String,
|
|
82
|
+
is_enabled: T::Boolean,
|
|
83
|
+
request_options: MetronomeSDK::RequestOptions
|
|
84
|
+
}
|
|
85
|
+
)
|
|
86
|
+
end
|
|
87
|
+
def to_hash
|
|
88
|
+
end
|
|
89
|
+
|
|
90
|
+
# Updated policy configuration. The policy.type must match the existing lifecycle
|
|
91
|
+
# event type.
|
|
92
|
+
module Policy
|
|
93
|
+
extend MetronomeSDK::Internal::Type::Union
|
|
94
|
+
|
|
95
|
+
Variants =
|
|
96
|
+
T.type_alias do
|
|
97
|
+
T.any(
|
|
98
|
+
MetronomeSDK::V2::Notifications::OffsetEditParams::Policy::LifecycleEventOffsetPolicy,
|
|
99
|
+
MetronomeSDK::V2::Notifications::OffsetEditParams::Policy::LifecycleEventSystemPolicy
|
|
100
|
+
)
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
class LifecycleEventOffsetPolicy < MetronomeSDK::Internal::Type::BaseModel
|
|
104
|
+
OrHash =
|
|
105
|
+
T.type_alias do
|
|
106
|
+
T.any(
|
|
107
|
+
MetronomeSDK::V2::Notifications::OffsetEditParams::Policy::LifecycleEventOffsetPolicy,
|
|
108
|
+
MetronomeSDK::Internal::AnyHash
|
|
109
|
+
)
|
|
110
|
+
end
|
|
111
|
+
|
|
112
|
+
# ISO-8601 duration string indicating how much time before or after the base event
|
|
113
|
+
# this notification should be sent. Positive values indicate notifications after
|
|
114
|
+
# the event, negative values indicate notifications before the event. Examples:
|
|
115
|
+
# "P1D" (1 day after), "-PT2H" (2 hours before)
|
|
116
|
+
sig { returns(String) }
|
|
117
|
+
attr_accessor :offset
|
|
118
|
+
|
|
119
|
+
# The type of lifecycle event that this offset is based on.
|
|
120
|
+
sig { returns(String) }
|
|
121
|
+
attr_accessor :type
|
|
122
|
+
|
|
123
|
+
sig do
|
|
124
|
+
params(offset: String, type: String).returns(T.attached_class)
|
|
125
|
+
end
|
|
126
|
+
def self.new(
|
|
127
|
+
# ISO-8601 duration string indicating how much time before or after the base event
|
|
128
|
+
# this notification should be sent. Positive values indicate notifications after
|
|
129
|
+
# the event, negative values indicate notifications before the event. Examples:
|
|
130
|
+
# "P1D" (1 day after), "-PT2H" (2 hours before)
|
|
131
|
+
offset:,
|
|
132
|
+
# The type of lifecycle event that this offset is based on.
|
|
133
|
+
type:
|
|
134
|
+
)
|
|
135
|
+
end
|
|
136
|
+
|
|
137
|
+
sig { override.returns({ offset: String, type: String }) }
|
|
138
|
+
def to_hash
|
|
139
|
+
end
|
|
140
|
+
end
|
|
141
|
+
|
|
142
|
+
class LifecycleEventSystemPolicy < MetronomeSDK::Internal::Type::BaseModel
|
|
143
|
+
OrHash =
|
|
144
|
+
T.type_alias do
|
|
145
|
+
T.any(
|
|
146
|
+
MetronomeSDK::V2::Notifications::OffsetEditParams::Policy::LifecycleEventSystemPolicy,
|
|
147
|
+
MetronomeSDK::Internal::AnyHash
|
|
148
|
+
)
|
|
149
|
+
end
|
|
150
|
+
|
|
151
|
+
# The type of lifecycle event (e.g., "contract.create", "contract.start")
|
|
152
|
+
sig { returns(String) }
|
|
153
|
+
attr_accessor :type
|
|
154
|
+
|
|
155
|
+
sig { params(type: String).returns(T.attached_class) }
|
|
156
|
+
def self.new(
|
|
157
|
+
# The type of lifecycle event (e.g., "contract.create", "contract.start")
|
|
158
|
+
type:
|
|
159
|
+
)
|
|
160
|
+
end
|
|
161
|
+
|
|
162
|
+
sig { override.returns({ type: String }) }
|
|
163
|
+
def to_hash
|
|
164
|
+
end
|
|
165
|
+
end
|
|
166
|
+
|
|
167
|
+
sig do
|
|
168
|
+
override.returns(
|
|
169
|
+
T::Array[
|
|
170
|
+
MetronomeSDK::V2::Notifications::OffsetEditParams::Policy::Variants
|
|
171
|
+
]
|
|
172
|
+
)
|
|
173
|
+
end
|
|
174
|
+
def self.variants
|
|
175
|
+
end
|
|
176
|
+
end
|
|
177
|
+
end
|
|
178
|
+
end
|
|
179
|
+
end
|
|
180
|
+
end
|
|
181
|
+
end
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module MetronomeSDK
|
|
4
|
+
module Models
|
|
5
|
+
module V2
|
|
6
|
+
module Notifications
|
|
7
|
+
class OffsetEditResponse < MetronomeSDK::Internal::Type::BaseModel
|
|
8
|
+
OrHash =
|
|
9
|
+
T.type_alias do
|
|
10
|
+
T.any(
|
|
11
|
+
MetronomeSDK::Models::V2::Notifications::OffsetEditResponse,
|
|
12
|
+
MetronomeSDK::Internal::AnyHash
|
|
13
|
+
)
|
|
14
|
+
end
|
|
15
|
+
|
|
16
|
+
sig do
|
|
17
|
+
returns(
|
|
18
|
+
MetronomeSDK::Models::V2::Notifications::OffsetEditResponse::Data::Variants
|
|
19
|
+
)
|
|
20
|
+
end
|
|
21
|
+
attr_accessor :data
|
|
22
|
+
|
|
23
|
+
sig do
|
|
24
|
+
params(
|
|
25
|
+
data:
|
|
26
|
+
T.any(
|
|
27
|
+
MetronomeSDK::V2::LifecycleEventSystemNotificationConfig::OrHash,
|
|
28
|
+
MetronomeSDK::V2::LifecycleEventOffsetNotificationConfig::OrHash
|
|
29
|
+
)
|
|
30
|
+
).returns(T.attached_class)
|
|
31
|
+
end
|
|
32
|
+
def self.new(data:)
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
sig do
|
|
36
|
+
override.returns(
|
|
37
|
+
{
|
|
38
|
+
data:
|
|
39
|
+
MetronomeSDK::Models::V2::Notifications::OffsetEditResponse::Data::Variants
|
|
40
|
+
}
|
|
41
|
+
)
|
|
42
|
+
end
|
|
43
|
+
def to_hash
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
module Data
|
|
47
|
+
extend MetronomeSDK::Internal::Type::Union
|
|
48
|
+
|
|
49
|
+
Variants =
|
|
50
|
+
T.type_alias do
|
|
51
|
+
T.any(
|
|
52
|
+
MetronomeSDK::V2::LifecycleEventSystemNotificationConfig,
|
|
53
|
+
MetronomeSDK::V2::LifecycleEventOffsetNotificationConfig
|
|
54
|
+
)
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
sig do
|
|
58
|
+
override.returns(
|
|
59
|
+
T::Array[
|
|
60
|
+
MetronomeSDK::Models::V2::Notifications::OffsetEditResponse::Data::Variants
|
|
61
|
+
]
|
|
62
|
+
)
|
|
63
|
+
end
|
|
64
|
+
def self.variants
|
|
65
|
+
end
|
|
66
|
+
end
|
|
67
|
+
end
|
|
68
|
+
end
|
|
69
|
+
end
|
|
70
|
+
end
|
|
71
|
+
end
|
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module MetronomeSDK
|
|
4
|
+
module Models
|
|
5
|
+
module V2
|
|
6
|
+
module Notifications
|
|
7
|
+
class OffsetListParams < MetronomeSDK::Internal::Type::BaseModel
|
|
8
|
+
extend MetronomeSDK::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include MetronomeSDK::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
OrHash =
|
|
12
|
+
T.type_alias do
|
|
13
|
+
T.any(
|
|
14
|
+
MetronomeSDK::V2::Notifications::OffsetListParams,
|
|
15
|
+
MetronomeSDK::Internal::AnyHash
|
|
16
|
+
)
|
|
17
|
+
end
|
|
18
|
+
|
|
19
|
+
# Filter options for the notification configurations. If not provided, defaults to
|
|
20
|
+
# NOT_ARCHIVED.
|
|
21
|
+
sig do
|
|
22
|
+
returns(
|
|
23
|
+
T.nilable(
|
|
24
|
+
MetronomeSDK::V2::Notifications::OffsetListParams::ArchiveFilter::OrSymbol
|
|
25
|
+
)
|
|
26
|
+
)
|
|
27
|
+
end
|
|
28
|
+
attr_reader :archive_filter
|
|
29
|
+
|
|
30
|
+
sig do
|
|
31
|
+
params(
|
|
32
|
+
archive_filter:
|
|
33
|
+
MetronomeSDK::V2::Notifications::OffsetListParams::ArchiveFilter::OrSymbol
|
|
34
|
+
).void
|
|
35
|
+
end
|
|
36
|
+
attr_writer :archive_filter
|
|
37
|
+
|
|
38
|
+
sig { returns(T.nilable(String)) }
|
|
39
|
+
attr_reader :cursor
|
|
40
|
+
|
|
41
|
+
sig { params(cursor: String).void }
|
|
42
|
+
attr_writer :cursor
|
|
43
|
+
|
|
44
|
+
sig { returns(T.nilable(Float)) }
|
|
45
|
+
attr_reader :limit
|
|
46
|
+
|
|
47
|
+
sig { params(limit: Float).void }
|
|
48
|
+
attr_writer :limit
|
|
49
|
+
|
|
50
|
+
sig do
|
|
51
|
+
params(
|
|
52
|
+
archive_filter:
|
|
53
|
+
MetronomeSDK::V2::Notifications::OffsetListParams::ArchiveFilter::OrSymbol,
|
|
54
|
+
cursor: String,
|
|
55
|
+
limit: Float,
|
|
56
|
+
request_options: MetronomeSDK::RequestOptions::OrHash
|
|
57
|
+
).returns(T.attached_class)
|
|
58
|
+
end
|
|
59
|
+
def self.new(
|
|
60
|
+
# Filter options for the notification configurations. If not provided, defaults to
|
|
61
|
+
# NOT_ARCHIVED.
|
|
62
|
+
archive_filter: nil,
|
|
63
|
+
cursor: nil,
|
|
64
|
+
limit: nil,
|
|
65
|
+
request_options: {}
|
|
66
|
+
)
|
|
67
|
+
end
|
|
68
|
+
|
|
69
|
+
sig do
|
|
70
|
+
override.returns(
|
|
71
|
+
{
|
|
72
|
+
archive_filter:
|
|
73
|
+
MetronomeSDK::V2::Notifications::OffsetListParams::ArchiveFilter::OrSymbol,
|
|
74
|
+
cursor: String,
|
|
75
|
+
limit: Float,
|
|
76
|
+
request_options: MetronomeSDK::RequestOptions
|
|
77
|
+
}
|
|
78
|
+
)
|
|
79
|
+
end
|
|
80
|
+
def to_hash
|
|
81
|
+
end
|
|
82
|
+
|
|
83
|
+
# Filter options for the notification configurations. If not provided, defaults to
|
|
84
|
+
# NOT_ARCHIVED.
|
|
85
|
+
module ArchiveFilter
|
|
86
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
87
|
+
|
|
88
|
+
TaggedSymbol =
|
|
89
|
+
T.type_alias do
|
|
90
|
+
T.all(
|
|
91
|
+
Symbol,
|
|
92
|
+
MetronomeSDK::V2::Notifications::OffsetListParams::ArchiveFilter
|
|
93
|
+
)
|
|
94
|
+
end
|
|
95
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
96
|
+
|
|
97
|
+
ARCHIVED =
|
|
98
|
+
T.let(
|
|
99
|
+
:ARCHIVED,
|
|
100
|
+
MetronomeSDK::V2::Notifications::OffsetListParams::ArchiveFilter::TaggedSymbol
|
|
101
|
+
)
|
|
102
|
+
NOT_ARCHIVED =
|
|
103
|
+
T.let(
|
|
104
|
+
:NOT_ARCHIVED,
|
|
105
|
+
MetronomeSDK::V2::Notifications::OffsetListParams::ArchiveFilter::TaggedSymbol
|
|
106
|
+
)
|
|
107
|
+
ALL =
|
|
108
|
+
T.let(
|
|
109
|
+
:ALL,
|
|
110
|
+
MetronomeSDK::V2::Notifications::OffsetListParams::ArchiveFilter::TaggedSymbol
|
|
111
|
+
)
|
|
112
|
+
|
|
113
|
+
sig do
|
|
114
|
+
override.returns(
|
|
115
|
+
T::Array[
|
|
116
|
+
MetronomeSDK::V2::Notifications::OffsetListParams::ArchiveFilter::TaggedSymbol
|
|
117
|
+
]
|
|
118
|
+
)
|
|
119
|
+
end
|
|
120
|
+
def self.values
|
|
121
|
+
end
|
|
122
|
+
end
|
|
123
|
+
end
|
|
124
|
+
end
|
|
125
|
+
end
|
|
126
|
+
end
|
|
127
|
+
end
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module MetronomeSDK
|
|
4
|
+
module Models
|
|
5
|
+
module V2
|
|
6
|
+
module Notifications
|
|
7
|
+
class OffsetRetrieveParams < MetronomeSDK::Internal::Type::BaseModel
|
|
8
|
+
extend MetronomeSDK::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include MetronomeSDK::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
OrHash =
|
|
12
|
+
T.type_alias do
|
|
13
|
+
T.any(
|
|
14
|
+
MetronomeSDK::V2::Notifications::OffsetRetrieveParams,
|
|
15
|
+
MetronomeSDK::Internal::AnyHash
|
|
16
|
+
)
|
|
17
|
+
end
|
|
18
|
+
|
|
19
|
+
# The ID of the notification configuration to retrieve
|
|
20
|
+
sig { returns(String) }
|
|
21
|
+
attr_accessor :id
|
|
22
|
+
|
|
23
|
+
sig do
|
|
24
|
+
params(
|
|
25
|
+
id: String,
|
|
26
|
+
request_options: MetronomeSDK::RequestOptions::OrHash
|
|
27
|
+
).returns(T.attached_class)
|
|
28
|
+
end
|
|
29
|
+
def self.new(
|
|
30
|
+
# The ID of the notification configuration to retrieve
|
|
31
|
+
id:,
|
|
32
|
+
request_options: {}
|
|
33
|
+
)
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
sig do
|
|
37
|
+
override.returns(
|
|
38
|
+
{ id: String, request_options: MetronomeSDK::RequestOptions }
|
|
39
|
+
)
|
|
40
|
+
end
|
|
41
|
+
def to_hash
|
|
42
|
+
end
|
|
43
|
+
end
|
|
44
|
+
end
|
|
45
|
+
end
|
|
46
|
+
end
|
|
47
|
+
end
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module MetronomeSDK
|
|
4
|
+
module Models
|
|
5
|
+
module V2
|
|
6
|
+
module Notifications
|
|
7
|
+
class OffsetRetrieveResponse < MetronomeSDK::Internal::Type::BaseModel
|
|
8
|
+
OrHash =
|
|
9
|
+
T.type_alias do
|
|
10
|
+
T.any(
|
|
11
|
+
MetronomeSDK::Models::V2::Notifications::OffsetRetrieveResponse,
|
|
12
|
+
MetronomeSDK::Internal::AnyHash
|
|
13
|
+
)
|
|
14
|
+
end
|
|
15
|
+
|
|
16
|
+
sig do
|
|
17
|
+
returns(MetronomeSDK::V2::LifecycleEventOffsetNotificationConfig)
|
|
18
|
+
end
|
|
19
|
+
attr_reader :data
|
|
20
|
+
|
|
21
|
+
sig do
|
|
22
|
+
params(
|
|
23
|
+
data:
|
|
24
|
+
MetronomeSDK::V2::LifecycleEventOffsetNotificationConfig::OrHash
|
|
25
|
+
).void
|
|
26
|
+
end
|
|
27
|
+
attr_writer :data
|
|
28
|
+
|
|
29
|
+
sig do
|
|
30
|
+
params(
|
|
31
|
+
data:
|
|
32
|
+
MetronomeSDK::V2::LifecycleEventOffsetNotificationConfig::OrHash
|
|
33
|
+
).returns(T.attached_class)
|
|
34
|
+
end
|
|
35
|
+
def self.new(data:)
|
|
36
|
+
end
|
|
37
|
+
|
|
38
|
+
sig do
|
|
39
|
+
override.returns(
|
|
40
|
+
{ data: MetronomeSDK::V2::LifecycleEventOffsetNotificationConfig }
|
|
41
|
+
)
|
|
42
|
+
end
|
|
43
|
+
def to_hash
|
|
44
|
+
end
|
|
45
|
+
end
|
|
46
|
+
end
|
|
47
|
+
end
|
|
48
|
+
end
|
|
49
|
+
end
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module MetronomeSDK
|
|
4
|
+
module Models
|
|
5
|
+
module V2
|
|
6
|
+
module Notifications
|
|
7
|
+
class SystemListParams < MetronomeSDK::Internal::Type::BaseModel
|
|
8
|
+
extend MetronomeSDK::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include MetronomeSDK::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
OrHash =
|
|
12
|
+
T.type_alias do
|
|
13
|
+
T.any(
|
|
14
|
+
MetronomeSDK::V2::Notifications::SystemListParams,
|
|
15
|
+
MetronomeSDK::Internal::AnyHash
|
|
16
|
+
)
|
|
17
|
+
end
|
|
18
|
+
|
|
19
|
+
sig do
|
|
20
|
+
params(
|
|
21
|
+
request_options: MetronomeSDK::RequestOptions::OrHash
|
|
22
|
+
).returns(T.attached_class)
|
|
23
|
+
end
|
|
24
|
+
def self.new(request_options: {})
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
sig do
|
|
28
|
+
override.returns({ request_options: MetronomeSDK::RequestOptions })
|
|
29
|
+
end
|
|
30
|
+
def to_hash
|
|
31
|
+
end
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
end
|
|
35
|
+
end
|
|
36
|
+
end
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module MetronomeSDK
|
|
4
|
+
module Models
|
|
5
|
+
module V2
|
|
6
|
+
module Notifications
|
|
7
|
+
class SystemListResponse < MetronomeSDK::Internal::Type::BaseModel
|
|
8
|
+
OrHash =
|
|
9
|
+
T.type_alias do
|
|
10
|
+
T.any(
|
|
11
|
+
MetronomeSDK::Models::V2::Notifications::SystemListResponse,
|
|
12
|
+
MetronomeSDK::Internal::AnyHash
|
|
13
|
+
)
|
|
14
|
+
end
|
|
15
|
+
|
|
16
|
+
sig do
|
|
17
|
+
returns(
|
|
18
|
+
T::Array[MetronomeSDK::V2::LifecycleEventSystemNotificationConfig]
|
|
19
|
+
)
|
|
20
|
+
end
|
|
21
|
+
attr_accessor :data
|
|
22
|
+
|
|
23
|
+
sig { returns(T.nilable(String)) }
|
|
24
|
+
attr_accessor :cursor
|
|
25
|
+
|
|
26
|
+
sig do
|
|
27
|
+
params(
|
|
28
|
+
data:
|
|
29
|
+
T::Array[
|
|
30
|
+
MetronomeSDK::V2::LifecycleEventSystemNotificationConfig::OrHash
|
|
31
|
+
],
|
|
32
|
+
cursor: T.nilable(String)
|
|
33
|
+
).returns(T.attached_class)
|
|
34
|
+
end
|
|
35
|
+
def self.new(data:, cursor: nil)
|
|
36
|
+
end
|
|
37
|
+
|
|
38
|
+
sig do
|
|
39
|
+
override.returns(
|
|
40
|
+
{
|
|
41
|
+
data:
|
|
42
|
+
T::Array[
|
|
43
|
+
MetronomeSDK::V2::LifecycleEventSystemNotificationConfig
|
|
44
|
+
],
|
|
45
|
+
cursor: T.nilable(String)
|
|
46
|
+
}
|
|
47
|
+
)
|
|
48
|
+
end
|
|
49
|
+
def to_hash
|
|
50
|
+
end
|
|
51
|
+
end
|
|
52
|
+
end
|
|
53
|
+
end
|
|
54
|
+
end
|
|
55
|
+
end
|
|
@@ -60,6 +60,8 @@ module MetronomeSDK
|
|
|
60
60
|
MetronomeSDK::V1::AlertCreateParams::AlertType::OrSymbol,
|
|
61
61
|
name: String,
|
|
62
62
|
threshold: Float,
|
|
63
|
+
access_type:
|
|
64
|
+
MetronomeSDK::V1::AlertCreateParams::AccessType::OrSymbol,
|
|
63
65
|
alert_specifiers:
|
|
64
66
|
T::Array[
|
|
65
67
|
MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::OrHash
|
|
@@ -92,9 +94,20 @@ module MetronomeSDK
|
|
|
92
94
|
# type, this number may represent a financial amount, the days remaining, or a
|
|
93
95
|
# percentage reached.
|
|
94
96
|
threshold:,
|
|
95
|
-
#
|
|
96
|
-
#
|
|
97
|
-
#
|
|
97
|
+
# Filters the notification to commits/credits with this access type. Only
|
|
98
|
+
# supported for `low_remaining_commit_balance_reached`,
|
|
99
|
+
# `low_remaining_commit_percentage_reached`,
|
|
100
|
+
# `low_remaining_contract_credit_and_commit_balance_reached`,
|
|
101
|
+
# `low_remaining_contract_credit_and_commit_percentage_reached`,
|
|
102
|
+
# `low_remaining_contract_credit_balance_reached`,
|
|
103
|
+
# `low_remaining_contract_credit_percentage_reached`, and
|
|
104
|
+
# `low_remaining_seat_balance_reached` notifications. Credit type cannot be
|
|
105
|
+
# specified if using QUANTITY access type.
|
|
106
|
+
access_type: nil,
|
|
107
|
+
# Can be used only with `low_remaining_contract_credit_and_commit_balance_reached`
|
|
108
|
+
# and `low_remaining_contract_credit_and_commit_percentage_reached` notifications.
|
|
109
|
+
# Defines the commits and credits used to calculate the remaining balance or
|
|
110
|
+
# percentage.
|
|
98
111
|
alert_specifiers: nil,
|
|
99
112
|
# For threshold notifications of type `usage_threshold_reached`, specifies which
|
|
100
113
|
# billable metric to track the usage for.
|
|
@@ -166,6 +179,8 @@ module MetronomeSDK
|
|
|
166
179
|
# customers
|
|
167
180
|
# - Historical preservation: Archive operation maintains threshold notification
|
|
168
181
|
# history and configuration for compliance and auditing
|
|
182
|
+
# - Idempotent: Archiving an already-archived threshold notification returns the
|
|
183
|
+
# same successful response
|
|
169
184
|
sig do
|
|
170
185
|
params(
|
|
171
186
|
id: String,
|
|
@@ -98,6 +98,40 @@ module MetronomeSDK
|
|
|
98
98
|
def retrieve(billable_metric_id:, request_options: {})
|
|
99
99
|
end
|
|
100
100
|
|
|
101
|
+
# Updates only the display name of an existing billable metric. Use this to
|
|
102
|
+
# correct mistakes or apply standardized naming conventions across all billable
|
|
103
|
+
# metrics. Returns the billable metric ID to confirm the update.
|
|
104
|
+
#
|
|
105
|
+
# Important: Only the name can be modified via this endpoint; configurations
|
|
106
|
+
# cannot be changed after creation.
|
|
107
|
+
#
|
|
108
|
+
# #### Example workflow:
|
|
109
|
+
#
|
|
110
|
+
# If you need to make changes to a streaming billable metric, for example,
|
|
111
|
+
# Metronome supports easily rolling out these changes using a simple workflow:
|
|
112
|
+
#
|
|
113
|
+
# 1. Duplicate the billable metric
|
|
114
|
+
# 2. Make required changes
|
|
115
|
+
# 3. Save the metric
|
|
116
|
+
# 4. Navigate to the product you have associated with the incorrect metric
|
|
117
|
+
# 5. Schedule the product to reference the newly created metric on the appropriate
|
|
118
|
+
# date
|
|
119
|
+
sig do
|
|
120
|
+
params(
|
|
121
|
+
billable_metric_id: String,
|
|
122
|
+
name: String,
|
|
123
|
+
request_options: MetronomeSDK::RequestOptions::OrHash
|
|
124
|
+
).returns(MetronomeSDK::Models::V1::BillableMetricUpdateResponse)
|
|
125
|
+
end
|
|
126
|
+
def update(
|
|
127
|
+
# Path param
|
|
128
|
+
billable_metric_id:,
|
|
129
|
+
# Body param: The new name of the metric
|
|
130
|
+
name:,
|
|
131
|
+
request_options: {}
|
|
132
|
+
)
|
|
133
|
+
end
|
|
134
|
+
|
|
101
135
|
# Retrieves all billable metrics with their complete configurations. Use this for
|
|
102
136
|
# programmatic discovery and management of billable metrics, such as associating
|
|
103
137
|
# metrics to products and auditing for orphaned or archived metrics. Important:
|
|
@@ -21,6 +21,7 @@ module MetronomeSDK
|
|
|
21
21
|
composite_tags: T::Array[String],
|
|
22
22
|
custom_fields: T::Hash[Symbol, String],
|
|
23
23
|
exclude_free_usage: T::Boolean,
|
|
24
|
+
include_composite_spend: T::Boolean,
|
|
24
25
|
is_refundable: T::Boolean,
|
|
25
26
|
netsuite_internal_item_id: String,
|
|
26
27
|
netsuite_overage_item_id: String,
|
|
@@ -57,6 +58,9 @@ module MetronomeSDK
|
|
|
57
58
|
# Beta feature only available for composite products. If true, products with $0
|
|
58
59
|
# will not be included when computing composite usage. Defaults to false
|
|
59
60
|
exclude_free_usage: nil,
|
|
61
|
+
# Only for composite products. If true, allows a composite to incorporate spend
|
|
62
|
+
# from other composite products. Defaults to false
|
|
63
|
+
include_composite_spend: nil,
|
|
60
64
|
# This field's availability is dependent on your client's configuration. Defaults
|
|
61
65
|
# to true.
|
|
62
66
|
is_refundable: nil,
|
|
@@ -129,6 +133,7 @@ module MetronomeSDK
|
|
|
129
133
|
composite_product_ids: T::Array[String],
|
|
130
134
|
composite_tags: T::Array[String],
|
|
131
135
|
exclude_free_usage: T::Boolean,
|
|
136
|
+
include_composite_spend: T::Boolean,
|
|
132
137
|
is_refundable: T::Boolean,
|
|
133
138
|
name: String,
|
|
134
139
|
netsuite_internal_item_id: String,
|
|
@@ -169,6 +174,9 @@ module MetronomeSDK
|
|
|
169
174
|
# Beta feature only available for composite products. If true, products with $0
|
|
170
175
|
# will not be included when computing composite usage. Defaults to false
|
|
171
176
|
exclude_free_usage: nil,
|
|
177
|
+
# Only for composite products. If true, allows a composite to incorporate spend
|
|
178
|
+
# from other composite products. Defaults to false
|
|
179
|
+
include_composite_spend: nil,
|
|
172
180
|
# Defaults to product's current refundability status. This field's availability is
|
|
173
181
|
# dependent on your client's configuration.
|
|
174
182
|
is_refundable: nil,
|