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
|
@@ -22,8 +22,9 @@ module MetronomeSDK
|
|
|
22
22
|
required :customer_id, String
|
|
23
23
|
|
|
24
24
|
# @!attribute alert_specifiers
|
|
25
|
-
# Can be used with
|
|
26
|
-
#
|
|
25
|
+
# Can be used only with `low_remaining_contract_credit_and_commit_balance_reached`
|
|
26
|
+
# and `low_remaining_contract_credit_and_commit_percentage_reached` notifications.
|
|
27
|
+
# Used to filter the alert by the custom field key-value pair.
|
|
27
28
|
#
|
|
28
29
|
# @return [Array<MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::AlertSpecifier>, nil]
|
|
29
30
|
optional :alert_specifiers,
|
|
@@ -60,7 +61,7 @@ module MetronomeSDK
|
|
|
60
61
|
#
|
|
61
62
|
# @param customer_id [String] The Metronome ID of the customer
|
|
62
63
|
#
|
|
63
|
-
# @param alert_specifiers [Array<MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::AlertSpecifier>] Can be used with
|
|
64
|
+
# @param alert_specifiers [Array<MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::AlertSpecifier>] Can be used only with `low_remaining_contract_credit_and_commit_balance_reached`
|
|
64
65
|
#
|
|
65
66
|
# @param group_values [Array<MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::GroupValue>] Only present for `spend_threshold_reached` notifications. Retrieve the notificat
|
|
66
67
|
#
|
|
@@ -48,8 +48,7 @@ module MetronomeSDK
|
|
|
48
48
|
optional :aws_region, enum: -> { MetronomeSDK::V1::Customers::BillingConfigCreateParams::AwsRegion }
|
|
49
49
|
|
|
50
50
|
# @!attribute stripe_collection_method
|
|
51
|
-
# The collection method for the customer's invoices.
|
|
52
|
-
# `auto_charge_payment_intent` and `manually_charge_payment_intent` are in beta.
|
|
51
|
+
# The collection method for the customer's invoices.
|
|
53
52
|
#
|
|
54
53
|
# @return [Symbol, MetronomeSDK::Models::V1::Customers::BillingConfigCreateParams::StripeCollectionMethod, nil]
|
|
55
54
|
optional :stripe_collection_method,
|
|
@@ -128,15 +127,12 @@ module MetronomeSDK
|
|
|
128
127
|
# @return [Array<Symbol>]
|
|
129
128
|
end
|
|
130
129
|
|
|
131
|
-
# The collection method for the customer's invoices.
|
|
132
|
-
# `auto_charge_payment_intent` and `manually_charge_payment_intent` are in beta.
|
|
130
|
+
# The collection method for the customer's invoices.
|
|
133
131
|
module StripeCollectionMethod
|
|
134
132
|
extend MetronomeSDK::Internal::Type::Enum
|
|
135
133
|
|
|
136
134
|
CHARGE_AUTOMATICALLY = :charge_automatically
|
|
137
135
|
SEND_INVOICE = :send_invoice
|
|
138
|
-
AUTO_CHARGE_PAYMENT_INTENT = :auto_charge_payment_intent
|
|
139
|
-
MANUALLY_CHARGE_PAYMENT_INTENT = :manually_charge_payment_intent
|
|
140
136
|
|
|
141
137
|
# @!method self.values
|
|
142
138
|
# @return [Array<Symbol>]
|
|
@@ -84,8 +84,7 @@ module MetronomeSDK
|
|
|
84
84
|
optional :billing_provider_customer_id, String
|
|
85
85
|
|
|
86
86
|
# @!attribute stripe_collection_method
|
|
87
|
-
# The collection method for the customer's invoices.
|
|
88
|
-
# `auto_charge_payment_intent` and `manually_charge_payment_intent` are in beta.
|
|
87
|
+
# The collection method for the customer's invoices.
|
|
89
88
|
#
|
|
90
89
|
# @return [Symbol, MetronomeSDK::Models::V1::Customers::BillingConfigRetrieveResponse::Data::StripeCollectionMethod, nil]
|
|
91
90
|
optional :stripe_collection_method,
|
|
@@ -167,8 +166,7 @@ module MetronomeSDK
|
|
|
167
166
|
# @return [Array<Symbol>]
|
|
168
167
|
end
|
|
169
168
|
|
|
170
|
-
# The collection method for the customer's invoices.
|
|
171
|
-
# `auto_charge_payment_intent` and `manually_charge_payment_intent` are in beta.
|
|
169
|
+
# The collection method for the customer's invoices.
|
|
172
170
|
#
|
|
173
171
|
# @see MetronomeSDK::Models::V1::Customers::BillingConfigRetrieveResponse::Data#stripe_collection_method
|
|
174
172
|
module StripeCollectionMethod
|
|
@@ -176,8 +174,6 @@ module MetronomeSDK
|
|
|
176
174
|
|
|
177
175
|
CHARGE_AUTOMATICALLY = :charge_automatically
|
|
178
176
|
SEND_INVOICE = :send_invoice
|
|
179
|
-
AUTO_CHARGE_PAYMENT_INTENT = :auto_charge_payment_intent
|
|
180
|
-
MANUALLY_CHARGE_PAYMENT_INTENT = :manually_charge_payment_intent
|
|
181
177
|
|
|
182
178
|
# @!method self.values
|
|
183
179
|
# @return [Array<Symbol>]
|
|
@@ -182,18 +182,33 @@ module MetronomeSDK
|
|
|
182
182
|
required :schedule_items,
|
|
183
183
|
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CommitCreateParams::AccessSchedule::ScheduleItem] }
|
|
184
184
|
|
|
185
|
+
# @!attribute access_type
|
|
186
|
+
# Determines how the balance is drawn down. `SPEND` deducts the dollar cost of
|
|
187
|
+
# usage. `QUANTITY` deducts the number of units used. Defaults to `SPEND` if
|
|
188
|
+
# omitted.
|
|
189
|
+
#
|
|
190
|
+
# @return [Symbol, MetronomeSDK::Models::V1::Customers::CommitCreateParams::AccessSchedule::AccessType, nil]
|
|
191
|
+
optional :access_type,
|
|
192
|
+
enum: -> { MetronomeSDK::V1::Customers::CommitCreateParams::AccessSchedule::AccessType }
|
|
193
|
+
|
|
185
194
|
# @!attribute credit_type_id
|
|
186
195
|
# Defaults to USD (cents) if not passed
|
|
187
196
|
#
|
|
188
197
|
# @return [String, nil]
|
|
189
198
|
optional :credit_type_id, String
|
|
190
199
|
|
|
191
|
-
# @!method initialize(schedule_items:, credit_type_id: nil)
|
|
200
|
+
# @!method initialize(schedule_items:, access_type: nil, credit_type_id: nil)
|
|
201
|
+
# Some parameter documentations has been truncated, see
|
|
202
|
+
# {MetronomeSDK::Models::V1::Customers::CommitCreateParams::AccessSchedule} for
|
|
203
|
+
# more details.
|
|
204
|
+
#
|
|
192
205
|
# Schedule for distributing the commit to the customer. For "POSTPAID" commits
|
|
193
206
|
# only one schedule item is allowed and amount must match invoice_schedule total.
|
|
194
207
|
#
|
|
195
208
|
# @param schedule_items [Array<MetronomeSDK::Models::V1::Customers::CommitCreateParams::AccessSchedule::ScheduleItem>]
|
|
196
209
|
#
|
|
210
|
+
# @param access_type [Symbol, MetronomeSDK::Models::V1::Customers::CommitCreateParams::AccessSchedule::AccessType] Determines how the balance is drawn down. `SPEND` deducts the dollar cost of usa
|
|
211
|
+
#
|
|
197
212
|
# @param credit_type_id [String] Defaults to USD (cents) if not passed
|
|
198
213
|
|
|
199
214
|
class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
|
|
@@ -221,6 +236,21 @@ module MetronomeSDK
|
|
|
221
236
|
#
|
|
222
237
|
# @param starting_at [Time] RFC 3339 timestamp (inclusive)
|
|
223
238
|
end
|
|
239
|
+
|
|
240
|
+
# Determines how the balance is drawn down. `SPEND` deducts the dollar cost of
|
|
241
|
+
# usage. `QUANTITY` deducts the number of units used. Defaults to `SPEND` if
|
|
242
|
+
# omitted.
|
|
243
|
+
#
|
|
244
|
+
# @see MetronomeSDK::Models::V1::Customers::CommitCreateParams::AccessSchedule#access_type
|
|
245
|
+
module AccessType
|
|
246
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
247
|
+
|
|
248
|
+
SPEND = :SPEND
|
|
249
|
+
QUANTITY = :QUANTITY
|
|
250
|
+
|
|
251
|
+
# @!method self.values
|
|
252
|
+
# @return [Array<Symbol>]
|
|
253
|
+
end
|
|
224
254
|
end
|
|
225
255
|
|
|
226
256
|
module Type
|
|
@@ -14,6 +14,13 @@ module MetronomeSDK
|
|
|
14
14
|
# @return [String]
|
|
15
15
|
required :customer_id, String
|
|
16
16
|
|
|
17
|
+
# @!attribute access_type
|
|
18
|
+
# Filters commits by how their balances are drawn down. `SPEND` deducts the dollar
|
|
19
|
+
# cost of usage. `QUANTITY` deducts the number of units used.
|
|
20
|
+
#
|
|
21
|
+
# @return [Symbol, MetronomeSDK::Models::V1::Customers::CommitListParams::AccessType, nil]
|
|
22
|
+
optional :access_type, enum: -> { MetronomeSDK::V1::Customers::CommitListParams::AccessType }
|
|
23
|
+
|
|
17
24
|
# @!attribute commit_id
|
|
18
25
|
#
|
|
19
26
|
# @return [String, nil]
|
|
@@ -75,12 +82,14 @@ module MetronomeSDK
|
|
|
75
82
|
# @return [Time, nil]
|
|
76
83
|
optional :starting_at, Time
|
|
77
84
|
|
|
78
|
-
# @!method initialize(customer_id:, commit_id: nil, covering_date: nil, effective_before: nil, include_archived: nil, include_balance: nil, include_contract_commits: nil, include_ledgers: nil, limit: nil, next_page: nil, starting_at: nil, request_options: {})
|
|
85
|
+
# @!method initialize(customer_id:, access_type: nil, commit_id: nil, covering_date: nil, effective_before: nil, include_archived: nil, include_balance: nil, include_contract_commits: nil, include_ledgers: nil, limit: nil, next_page: nil, starting_at: nil, request_options: {})
|
|
79
86
|
# Some parameter documentations has been truncated, see
|
|
80
87
|
# {MetronomeSDK::Models::V1::Customers::CommitListParams} for more details.
|
|
81
88
|
#
|
|
82
89
|
# @param customer_id [String]
|
|
83
90
|
#
|
|
91
|
+
# @param access_type [Symbol, MetronomeSDK::Models::V1::Customers::CommitListParams::AccessType] Filters commits by how their balances are drawn down. `SPEND` deducts the dollar
|
|
92
|
+
#
|
|
84
93
|
# @param commit_id [String]
|
|
85
94
|
#
|
|
86
95
|
# @param covering_date [Time] Include only commits that have access schedules that "cover" the provided date
|
|
@@ -102,6 +111,18 @@ module MetronomeSDK
|
|
|
102
111
|
# @param starting_at [Time] Include only commits that have any access on or after the provided date
|
|
103
112
|
#
|
|
104
113
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
114
|
+
|
|
115
|
+
# Filters commits by how their balances are drawn down. `SPEND` deducts the dollar
|
|
116
|
+
# cost of usage. `QUANTITY` deducts the number of units used.
|
|
117
|
+
module AccessType
|
|
118
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
119
|
+
|
|
120
|
+
SPEND = :SPEND
|
|
121
|
+
QUANTITY = :QUANTITY
|
|
122
|
+
|
|
123
|
+
# @!method self.values
|
|
124
|
+
# @return [Array<Symbol>]
|
|
125
|
+
end
|
|
105
126
|
end
|
|
106
127
|
end
|
|
107
128
|
end
|
|
@@ -149,17 +149,32 @@ module MetronomeSDK
|
|
|
149
149
|
required :schedule_items,
|
|
150
150
|
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CreditCreateParams::AccessSchedule::ScheduleItem] }
|
|
151
151
|
|
|
152
|
+
# @!attribute access_type
|
|
153
|
+
# Determines how the balance is drawn down. `SPEND` deducts the dollar cost of
|
|
154
|
+
# usage. `QUANTITY` deducts the number of units used. Defaults to `SPEND` if
|
|
155
|
+
# omitted.
|
|
156
|
+
#
|
|
157
|
+
# @return [Symbol, MetronomeSDK::Models::V1::Customers::CreditCreateParams::AccessSchedule::AccessType, nil]
|
|
158
|
+
optional :access_type,
|
|
159
|
+
enum: -> { MetronomeSDK::V1::Customers::CreditCreateParams::AccessSchedule::AccessType }
|
|
160
|
+
|
|
152
161
|
# @!attribute credit_type_id
|
|
153
162
|
# Defaults to USD (cents) if not passed
|
|
154
163
|
#
|
|
155
164
|
# @return [String, nil]
|
|
156
165
|
optional :credit_type_id, String
|
|
157
166
|
|
|
158
|
-
# @!method initialize(schedule_items:, credit_type_id: nil)
|
|
167
|
+
# @!method initialize(schedule_items:, access_type: nil, credit_type_id: nil)
|
|
168
|
+
# Some parameter documentations has been truncated, see
|
|
169
|
+
# {MetronomeSDK::Models::V1::Customers::CreditCreateParams::AccessSchedule} for
|
|
170
|
+
# more details.
|
|
171
|
+
#
|
|
159
172
|
# Schedule for distributing the credit to the customer.
|
|
160
173
|
#
|
|
161
174
|
# @param schedule_items [Array<MetronomeSDK::Models::V1::Customers::CreditCreateParams::AccessSchedule::ScheduleItem>]
|
|
162
175
|
#
|
|
176
|
+
# @param access_type [Symbol, MetronomeSDK::Models::V1::Customers::CreditCreateParams::AccessSchedule::AccessType] Determines how the balance is drawn down. `SPEND` deducts the dollar cost of usa
|
|
177
|
+
#
|
|
163
178
|
# @param credit_type_id [String] Defaults to USD (cents) if not passed
|
|
164
179
|
|
|
165
180
|
class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
|
|
@@ -187,6 +202,21 @@ module MetronomeSDK
|
|
|
187
202
|
#
|
|
188
203
|
# @param starting_at [Time] RFC 3339 timestamp (inclusive)
|
|
189
204
|
end
|
|
205
|
+
|
|
206
|
+
# Determines how the balance is drawn down. `SPEND` deducts the dollar cost of
|
|
207
|
+
# usage. `QUANTITY` deducts the number of units used. Defaults to `SPEND` if
|
|
208
|
+
# omitted.
|
|
209
|
+
#
|
|
210
|
+
# @see MetronomeSDK::Models::V1::Customers::CreditCreateParams::AccessSchedule#access_type
|
|
211
|
+
module AccessType
|
|
212
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
213
|
+
|
|
214
|
+
SPEND = :SPEND
|
|
215
|
+
QUANTITY = :QUANTITY
|
|
216
|
+
|
|
217
|
+
# @!method self.values
|
|
218
|
+
# @return [Array<Symbol>]
|
|
219
|
+
end
|
|
190
220
|
end
|
|
191
221
|
|
|
192
222
|
module RateType
|
|
@@ -74,10 +74,25 @@ module MetronomeSDK
|
|
|
74
74
|
# @return [Time]
|
|
75
75
|
required :updated_at, Time
|
|
76
76
|
|
|
77
|
+
# @!attribute access_type
|
|
78
|
+
# Indicates the commit access type this notification is scoped to. Defaults to
|
|
79
|
+
# `SPEND` if not otherwise specified. Only present for
|
|
80
|
+
# `low_remaining_commit_balance_reached`,
|
|
81
|
+
# `low_remaining_commit_percentage_reached`,
|
|
82
|
+
# `low_remaining_contract_credit_and_commit_balance_reached`,
|
|
83
|
+
# `low_remaining_contract_credit_and_commit_percentage_reached`,
|
|
84
|
+
# `low_remaining_contract_credit_balance_reached`,
|
|
85
|
+
# `low_remaining_contract_credit_percentage_reached`, and
|
|
86
|
+
# `low_remaining_seat_balance_reached` notifications.
|
|
87
|
+
#
|
|
88
|
+
# @return [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::AccessType, nil]
|
|
89
|
+
optional :access_type, enum: -> { MetronomeSDK::V1::Customers::CustomerAlert::Alert::AccessType }
|
|
90
|
+
|
|
77
91
|
# @!attribute alert_specifiers
|
|
78
|
-
# Present for `low_remaining_contract_credit_and_commit_balance_reached`
|
|
79
|
-
# notifications. The
|
|
80
|
-
#
|
|
92
|
+
# Present for `low_remaining_contract_credit_and_commit_balance_reached` and
|
|
93
|
+
# `low_remaining_contract_credit_and_commit_percentage_reached` notifications. The
|
|
94
|
+
# filters that define the commits and credits used to calculate the remaining
|
|
95
|
+
# balance or percentage.
|
|
81
96
|
#
|
|
82
97
|
# @return [Array<MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::AlertSpecifier>, nil]
|
|
83
98
|
optional :alert_specifiers,
|
|
@@ -142,7 +157,7 @@ module MetronomeSDK
|
|
|
142
157
|
# @return [String, nil]
|
|
143
158
|
optional :uniqueness_key, String
|
|
144
159
|
|
|
145
|
-
# @!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)
|
|
160
|
+
# @!method initialize(id:, name:, status:, threshold:, type:, updated_at:, access_type: nil, 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)
|
|
146
161
|
# Some parameter documentations has been truncated, see
|
|
147
162
|
# {MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert} for more details.
|
|
148
163
|
#
|
|
@@ -158,7 +173,10 @@ module MetronomeSDK
|
|
|
158
173
|
#
|
|
159
174
|
# @param updated_at [Time] Timestamp for when the threshold notification's customer status was last updated
|
|
160
175
|
#
|
|
161
|
-
# @param
|
|
176
|
+
# @param access_type [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::AccessType] Indicates the commit access type this notification is scoped to. Defaults to `SP
|
|
177
|
+
#
|
|
178
|
+
# @param alert_specifiers [Array<MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::AlertSpecifier>] Present for `low_remaining_contract_credit_and_commit_balance_reached` and
|
|
179
|
+
# `low\_
|
|
162
180
|
#
|
|
163
181
|
# @param credit_grant_type_filters [Array<String>] An array of strings, representing a way to filter the credit grant this threshol
|
|
164
182
|
#
|
|
@@ -211,6 +229,8 @@ module MetronomeSDK
|
|
|
211
229
|
LOW_REMAINING_CONTRACT_CREDIT_PERCENTAGE_REACHED = :low_remaining_contract_credit_percentage_reached
|
|
212
230
|
LOW_REMAINING_CONTRACT_CREDIT_AND_COMMIT_BALANCE_REACHED =
|
|
213
231
|
:low_remaining_contract_credit_and_commit_balance_reached
|
|
232
|
+
LOW_REMAINING_CONTRACT_CREDIT_AND_COMMIT_PERCENTAGE_REACHED =
|
|
233
|
+
:low_remaining_contract_credit_and_commit_percentage_reached
|
|
214
234
|
LOW_REMAINING_SEAT_BALANCE_REACHED = :low_remaining_seat_balance_reached
|
|
215
235
|
INVOICE_TOTAL_REACHED = :invoice_total_reached
|
|
216
236
|
|
|
@@ -218,6 +238,27 @@ module MetronomeSDK
|
|
|
218
238
|
# @return [Array<Symbol>]
|
|
219
239
|
end
|
|
220
240
|
|
|
241
|
+
# Indicates the commit access type this notification is scoped to. Defaults to
|
|
242
|
+
# `SPEND` if not otherwise specified. Only present for
|
|
243
|
+
# `low_remaining_commit_balance_reached`,
|
|
244
|
+
# `low_remaining_commit_percentage_reached`,
|
|
245
|
+
# `low_remaining_contract_credit_and_commit_balance_reached`,
|
|
246
|
+
# `low_remaining_contract_credit_and_commit_percentage_reached`,
|
|
247
|
+
# `low_remaining_contract_credit_balance_reached`,
|
|
248
|
+
# `low_remaining_contract_credit_percentage_reached`, and
|
|
249
|
+
# `low_remaining_seat_balance_reached` notifications.
|
|
250
|
+
#
|
|
251
|
+
# @see MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert#access_type
|
|
252
|
+
module AccessType
|
|
253
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
254
|
+
|
|
255
|
+
SPEND = :SPEND
|
|
256
|
+
QUANTITY = :QUANTITY
|
|
257
|
+
|
|
258
|
+
# @!method self.values
|
|
259
|
+
# @return [Array<Symbol>]
|
|
260
|
+
end
|
|
261
|
+
|
|
221
262
|
class AlertSpecifier < MetronomeSDK::Internal::Type::BaseModel
|
|
222
263
|
# @!attribute custom_field_filters
|
|
223
264
|
# A list of custom field filters for notification types that support advanced
|
|
@@ -48,7 +48,8 @@ module MetronomeSDK
|
|
|
48
48
|
optional :amendment_id, String
|
|
49
49
|
|
|
50
50
|
# @!attribute billable_status
|
|
51
|
-
#
|
|
51
|
+
# Indicates if the invoice has been or will be sent to the configured customer
|
|
52
|
+
# billing provider. Defaults to `billable`.
|
|
52
53
|
#
|
|
53
54
|
# @return [Object, nil]
|
|
54
55
|
optional :billable_status, MetronomeSDK::Internal::Type::Unknown
|
|
@@ -209,7 +210,7 @@ module MetronomeSDK
|
|
|
209
210
|
#
|
|
210
211
|
# @param amendment_id [String]
|
|
211
212
|
#
|
|
212
|
-
# @param billable_status [Object]
|
|
213
|
+
# @param billable_status [Object] Indicates if the invoice has been or will be sent to the configured customer bil
|
|
213
214
|
#
|
|
214
215
|
# @param constituent_invoices [Array<MetronomeSDK::Models::V1::Customers::Invoice::ConstituentInvoice>] Required on invoices with type USAGE_CONSOLIDATED. List of constituent invoices
|
|
215
216
|
#
|
|
@@ -303,8 +304,8 @@ module MetronomeSDK
|
|
|
303
304
|
|
|
304
305
|
# @!attribute applied_commit_or_credit
|
|
305
306
|
# Details about the credit or commit that was applied to this line item. Only
|
|
306
|
-
# present on line items with product of `USAGE`, `SUBSCRIPTION` or
|
|
307
|
-
# types.
|
|
307
|
+
# present on line items with product of `USAGE`, `SUBSCRIPTION`, `COMPOSITE`, or
|
|
308
|
+
# `CPU_CONVERSION` types.
|
|
308
309
|
#
|
|
309
310
|
# @return [MetronomeSDK::Models::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit, nil]
|
|
310
311
|
optional :applied_commit_or_credit,
|
|
@@ -317,10 +318,10 @@ module MetronomeSDK
|
|
|
317
318
|
optional :commit_custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
|
|
318
319
|
|
|
319
320
|
# @!attribute commit_id
|
|
320
|
-
# For line items with product of `USAGE`, `SUBSCRIPTION`,
|
|
321
|
-
# the ID of the credit or commit that was applied to this
|
|
322
|
-
# items with product type of `FIXED`, the ID of the prepaid or
|
|
323
|
-
# that is being paid for.
|
|
321
|
+
# For line items with product of `USAGE`, `SUBSCRIPTION`, `COMPOSITE`, or
|
|
322
|
+
# `CPU_CONVERSION` types, the ID of the credit or commit that was applied to this
|
|
323
|
+
# line item. For line items with product type of `FIXED`, the ID of the prepaid or
|
|
324
|
+
# postpaid commit that is being paid for.
|
|
324
325
|
#
|
|
325
326
|
# @return [String, nil]
|
|
326
327
|
optional :commit_id, String
|
|
@@ -490,6 +491,13 @@ module MetronomeSDK
|
|
|
490
491
|
# @return [Float, nil]
|
|
491
492
|
optional :quantity, Float
|
|
492
493
|
|
|
494
|
+
# @!attribute quantity_consumed
|
|
495
|
+
# Present on applied commit line items for quantity-based commits. Represents the
|
|
496
|
+
# unit quantity deducted the commit.
|
|
497
|
+
#
|
|
498
|
+
# @return [Float, nil]
|
|
499
|
+
optional :quantity_consumed, Float
|
|
500
|
+
|
|
493
501
|
# @!attribute reseller_type
|
|
494
502
|
#
|
|
495
503
|
# @return [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::LineItem::ResellerType, nil]
|
|
@@ -544,7 +552,7 @@ module MetronomeSDK
|
|
|
544
552
|
# @return [Float, nil]
|
|
545
553
|
optional :unit_price, Float
|
|
546
554
|
|
|
547
|
-
# @!method initialize(credit_type:, name:, total:, type:, applied_commit_or_credit: nil, commit_custom_fields: nil, commit_id: nil, commit_netsuite_item_id: nil, commit_netsuite_sales_order_id: nil, commit_segment_id: nil, commit_type: nil, custom_fields: nil, discount_custom_fields: nil, discount_id: nil, ending_before: nil, group_key: nil, group_value: nil, is_prorated: nil, list_price: nil, metadata: nil, netsuite_invoice_billing_end: nil, netsuite_invoice_billing_start: nil, netsuite_item_id: nil, origin: nil, postpaid_commit: nil, presentation_group_values: nil, pricing_group_values: nil, product_custom_fields: nil, product_id: nil, product_tags: nil, product_type: nil, professional_service_custom_fields: nil, professional_service_id: nil, quantity: nil, reseller_type: nil, scheduled_charge_custom_fields: nil, scheduled_charge_id: nil, starting_at: nil, sub_line_items: nil, subscription_custom_fields: nil, subscription_id: nil, tier: nil, unit_price: nil)
|
|
555
|
+
# @!method initialize(credit_type:, name:, total:, type:, applied_commit_or_credit: nil, commit_custom_fields: nil, commit_id: nil, commit_netsuite_item_id: nil, commit_netsuite_sales_order_id: nil, commit_segment_id: nil, commit_type: nil, custom_fields: nil, discount_custom_fields: nil, discount_id: nil, ending_before: nil, group_key: nil, group_value: nil, is_prorated: nil, list_price: nil, metadata: nil, netsuite_invoice_billing_end: nil, netsuite_invoice_billing_start: nil, netsuite_item_id: nil, origin: nil, postpaid_commit: nil, presentation_group_values: nil, pricing_group_values: nil, product_custom_fields: nil, product_id: nil, product_tags: nil, product_type: nil, professional_service_custom_fields: nil, professional_service_id: nil, quantity: nil, quantity_consumed: nil, reseller_type: nil, scheduled_charge_custom_fields: nil, scheduled_charge_id: nil, starting_at: nil, sub_line_items: nil, subscription_custom_fields: nil, subscription_id: nil, tier: nil, unit_price: nil)
|
|
548
556
|
# Some parameter documentations has been truncated, see
|
|
549
557
|
# {MetronomeSDK::Models::V1::Customers::Invoice::LineItem} for more details.
|
|
550
558
|
#
|
|
@@ -560,7 +568,7 @@ module MetronomeSDK
|
|
|
560
568
|
#
|
|
561
569
|
# @param commit_custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
562
570
|
#
|
|
563
|
-
# @param commit_id [String] For line items with product of `USAGE`, `SUBSCRIPTION`,
|
|
571
|
+
# @param commit_id [String] For line items with product of `USAGE`, `SUBSCRIPTION`, `COMPOSITE`, or `CPU_CON
|
|
564
572
|
#
|
|
565
573
|
# @param commit_netsuite_item_id [String]
|
|
566
574
|
#
|
|
@@ -616,6 +624,8 @@ module MetronomeSDK
|
|
|
616
624
|
#
|
|
617
625
|
# @param quantity [Float] The quantity associated with the line item.
|
|
618
626
|
#
|
|
627
|
+
# @param quantity_consumed [Float] Present on applied commit line items for quantity-based commits. Represents the
|
|
628
|
+
#
|
|
619
629
|
# @param reseller_type [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::LineItem::ResellerType]
|
|
620
630
|
#
|
|
621
631
|
# @param scheduled_charge_custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
@@ -646,13 +656,28 @@ module MetronomeSDK
|
|
|
646
656
|
# @return [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit::Type]
|
|
647
657
|
required :type, enum: -> { MetronomeSDK::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit::Type }
|
|
648
658
|
|
|
649
|
-
# @!
|
|
659
|
+
# @!attribute access_type
|
|
660
|
+
# Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
|
|
661
|
+
# usage. `QUANTITY` deducts the number of units used.
|
|
662
|
+
#
|
|
663
|
+
# @return [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit::AccessType, nil]
|
|
664
|
+
optional :access_type,
|
|
665
|
+
enum: -> { MetronomeSDK::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit::AccessType }
|
|
666
|
+
|
|
667
|
+
# @!method initialize(id:, type:, access_type: nil)
|
|
668
|
+
# Some parameter documentations has been truncated, see
|
|
669
|
+
# {MetronomeSDK::Models::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit}
|
|
670
|
+
# for more details.
|
|
671
|
+
#
|
|
650
672
|
# Details about the credit or commit that was applied to this line item. Only
|
|
651
|
-
# present on line items with product of `USAGE`, `SUBSCRIPTION` or
|
|
652
|
-
# types.
|
|
673
|
+
# present on line items with product of `USAGE`, `SUBSCRIPTION`, `COMPOSITE`, or
|
|
674
|
+
# `CPU_CONVERSION` types.
|
|
653
675
|
#
|
|
654
676
|
# @param id [String]
|
|
677
|
+
#
|
|
655
678
|
# @param type [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit::Type]
|
|
679
|
+
#
|
|
680
|
+
# @param access_type [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit::AccessType] Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of usag
|
|
656
681
|
|
|
657
682
|
# @see MetronomeSDK::Models::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit#type
|
|
658
683
|
module Type
|
|
@@ -665,6 +690,20 @@ module MetronomeSDK
|
|
|
665
690
|
# @!method self.values
|
|
666
691
|
# @return [Array<Symbol>]
|
|
667
692
|
end
|
|
693
|
+
|
|
694
|
+
# Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
|
|
695
|
+
# usage. `QUANTITY` deducts the number of units used.
|
|
696
|
+
#
|
|
697
|
+
# @see MetronomeSDK::Models::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit#access_type
|
|
698
|
+
module AccessType
|
|
699
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
700
|
+
|
|
701
|
+
SPEND = :SPEND
|
|
702
|
+
QUANTITY = :QUANTITY
|
|
703
|
+
|
|
704
|
+
# @!method self.values
|
|
705
|
+
# @return [Array<Symbol>]
|
|
706
|
+
end
|
|
668
707
|
end
|
|
669
708
|
|
|
670
709
|
# @see MetronomeSDK::Models::V1::Customers::Invoice::LineItem#origin
|
|
@@ -33,6 +33,13 @@ module MetronomeSDK
|
|
|
33
33
|
# @return [Time, nil]
|
|
34
34
|
optional :ending_before, Time
|
|
35
35
|
|
|
36
|
+
# @!attribute include_historical_commit_invoices
|
|
37
|
+
# When true, includes historical commit invoices alongside active invoices.
|
|
38
|
+
# Defaults to false.
|
|
39
|
+
#
|
|
40
|
+
# @return [Boolean, nil]
|
|
41
|
+
optional :include_historical_commit_invoices, MetronomeSDK::Internal::Type::Boolean
|
|
42
|
+
|
|
36
43
|
# @!attribute limit
|
|
37
44
|
# Max number of results that should be returned
|
|
38
45
|
#
|
|
@@ -84,7 +91,7 @@ module MetronomeSDK
|
|
|
84
91
|
# @return [String, nil]
|
|
85
92
|
optional :webhook_notification_id, String
|
|
86
93
|
|
|
87
|
-
# @!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: {})
|
|
94
|
+
# @!method initialize(customer_id:, contract_id: nil, credit_type_id: nil, ending_before: nil, include_historical_commit_invoices: 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: {})
|
|
88
95
|
# Some parameter documentations has been truncated, see
|
|
89
96
|
# {MetronomeSDK::Models::V1::Customers::InvoiceListParams} for more details.
|
|
90
97
|
#
|
|
@@ -96,6 +103,8 @@ module MetronomeSDK
|
|
|
96
103
|
#
|
|
97
104
|
# @param ending_before [Time] RFC 3339 timestamp (exclusive). Invoices will only be returned for billing perio
|
|
98
105
|
#
|
|
106
|
+
# @param include_historical_commit_invoices [Boolean] When true, includes historical commit invoices alongside active invoices. Defaul
|
|
107
|
+
#
|
|
99
108
|
# @param limit [Integer] Max number of results that should be returned
|
|
100
109
|
#
|
|
101
110
|
# @param next_page [String] Cursor that indicates where the next page of results should start.
|