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
|
@@ -66,6 +66,8 @@ module MetronomeSDK
|
|
|
66
66
|
required :balance, Float
|
|
67
67
|
|
|
68
68
|
# @!attribute credit_type_id
|
|
69
|
+
# This ID identifies the credit type for the balance. Quantity-based balances
|
|
70
|
+
# return the null credit type UUID.
|
|
69
71
|
#
|
|
70
72
|
# @return [String]
|
|
71
73
|
required :credit_type_id, String
|
|
@@ -77,16 +79,40 @@ module MetronomeSDK
|
|
|
77
79
|
# @return [Float]
|
|
78
80
|
required :starting_balance, Float
|
|
79
81
|
|
|
80
|
-
# @!
|
|
82
|
+
# @!attribute access_type
|
|
83
|
+
# Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
|
|
84
|
+
# usage. `QUANTITY` deducts the number of units used.
|
|
85
|
+
#
|
|
86
|
+
# @return [Symbol, MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Balance::AccessType, nil]
|
|
87
|
+
optional :access_type,
|
|
88
|
+
enum: -> { MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Balance::AccessType }
|
|
89
|
+
|
|
90
|
+
# @!method initialize(balance:, credit_type_id:, starting_balance:, access_type: nil)
|
|
81
91
|
# Some parameter documentations has been truncated, see
|
|
82
92
|
# {MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Balance} for
|
|
83
93
|
# more details.
|
|
84
94
|
#
|
|
85
95
|
# @param balance [Float] The total balance across all commits and credits for this seat, of this credit t
|
|
86
96
|
#
|
|
87
|
-
# @param credit_type_id [String]
|
|
97
|
+
# @param credit_type_id [String] This ID identifies the credit type for the balance. Quantity-based balances retu
|
|
88
98
|
#
|
|
89
99
|
# @param starting_balance [Float] The total initial balances of all commits and credits for this seat, of this cre
|
|
100
|
+
#
|
|
101
|
+
# @param access_type [Symbol, MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Balance::AccessType] Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of usag
|
|
102
|
+
|
|
103
|
+
# Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
|
|
104
|
+
# usage. `QUANTITY` deducts the number of units used.
|
|
105
|
+
#
|
|
106
|
+
# @see MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Balance#access_type
|
|
107
|
+
module AccessType
|
|
108
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
109
|
+
|
|
110
|
+
SPEND = :SPEND
|
|
111
|
+
QUANTITY = :QUANTITY
|
|
112
|
+
|
|
113
|
+
# @!method self.values
|
|
114
|
+
# @return [Array<Symbol>]
|
|
115
|
+
end
|
|
90
116
|
end
|
|
91
117
|
|
|
92
118
|
class Commit < MetronomeSDK::Internal::Type::BaseModel
|
|
@@ -108,6 +134,21 @@ module MetronomeSDK
|
|
|
108
134
|
# @return [Time]
|
|
109
135
|
required :start_date, Time
|
|
110
136
|
|
|
137
|
+
# @!attribute access_type
|
|
138
|
+
# Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
|
|
139
|
+
# usage. `QUANTITY` deducts the number of units used.
|
|
140
|
+
#
|
|
141
|
+
# @return [Symbol, MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit::AccessType, nil]
|
|
142
|
+
optional :access_type,
|
|
143
|
+
enum: -> { MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit::AccessType }
|
|
144
|
+
|
|
145
|
+
# @!attribute credit_type_id
|
|
146
|
+
# The credit type for this commit. Quantity-based commits return the null credit
|
|
147
|
+
# type UUID.
|
|
148
|
+
#
|
|
149
|
+
# @return [String, nil]
|
|
150
|
+
optional :credit_type_id, String
|
|
151
|
+
|
|
111
152
|
# @!attribute end_date
|
|
112
153
|
# The datetime when the commit expires
|
|
113
154
|
#
|
|
@@ -122,7 +163,7 @@ module MetronomeSDK
|
|
|
122
163
|
optional :ledger_entries,
|
|
123
164
|
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit::LedgerEntry] }
|
|
124
165
|
|
|
125
|
-
# @!method initialize(id:, balance:, start_date:, end_date: nil, ledger_entries: nil)
|
|
166
|
+
# @!method initialize(id:, balance:, start_date:, access_type: nil, credit_type_id: nil, end_date: nil, ledger_entries: nil)
|
|
126
167
|
# Some parameter documentations has been truncated, see
|
|
127
168
|
# {MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit} for
|
|
128
169
|
# more details.
|
|
@@ -133,10 +174,28 @@ module MetronomeSDK
|
|
|
133
174
|
#
|
|
134
175
|
# @param start_date [Time] The datetime when the commit becomes active
|
|
135
176
|
#
|
|
177
|
+
# @param access_type [Symbol, MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit::AccessType] Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of usag
|
|
178
|
+
#
|
|
179
|
+
# @param credit_type_id [String] The credit type for this commit. Quantity-based commits return the null credit t
|
|
180
|
+
#
|
|
136
181
|
# @param end_date [Time, nil] The datetime when the commit expires
|
|
137
182
|
#
|
|
138
183
|
# @param ledger_entries [Array<MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit::LedgerEntry>] Transaction history for this commit for this seat (only included if include_ledg
|
|
139
184
|
|
|
185
|
+
# Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
|
|
186
|
+
# usage. `QUANTITY` deducts the number of units used.
|
|
187
|
+
#
|
|
188
|
+
# @see MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit#access_type
|
|
189
|
+
module AccessType
|
|
190
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
191
|
+
|
|
192
|
+
SPEND = :SPEND
|
|
193
|
+
QUANTITY = :QUANTITY
|
|
194
|
+
|
|
195
|
+
# @!method self.values
|
|
196
|
+
# @return [Array<Symbol>]
|
|
197
|
+
end
|
|
198
|
+
|
|
140
199
|
class LedgerEntry < MetronomeSDK::Internal::Type::BaseModel
|
|
141
200
|
# @!attribute amount
|
|
142
201
|
# Amount of the ledger entry
|
|
@@ -204,6 +263,21 @@ module MetronomeSDK
|
|
|
204
263
|
# @return [Time]
|
|
205
264
|
required :start_date, Time
|
|
206
265
|
|
|
266
|
+
# @!attribute access_type
|
|
267
|
+
# Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
|
|
268
|
+
# usage. `QUANTITY` deducts the number of units used.
|
|
269
|
+
#
|
|
270
|
+
# @return [Symbol, MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit::AccessType, nil]
|
|
271
|
+
optional :access_type,
|
|
272
|
+
enum: -> { MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit::AccessType }
|
|
273
|
+
|
|
274
|
+
# @!attribute credit_type_id
|
|
275
|
+
# The credit type for this credit. Quantity-based credits return the null credit
|
|
276
|
+
# type UUID.
|
|
277
|
+
#
|
|
278
|
+
# @return [String, nil]
|
|
279
|
+
optional :credit_type_id, String
|
|
280
|
+
|
|
207
281
|
# @!attribute end_date
|
|
208
282
|
# The datetime when the credit expires
|
|
209
283
|
#
|
|
@@ -218,7 +292,7 @@ module MetronomeSDK
|
|
|
218
292
|
optional :ledger_entries,
|
|
219
293
|
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit::LedgerEntry] }
|
|
220
294
|
|
|
221
|
-
# @!method initialize(id:, balance:, start_date:, end_date: nil, ledger_entries: nil)
|
|
295
|
+
# @!method initialize(id:, balance:, start_date:, access_type: nil, credit_type_id: nil, end_date: nil, ledger_entries: nil)
|
|
222
296
|
# Some parameter documentations has been truncated, see
|
|
223
297
|
# {MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit} for
|
|
224
298
|
# more details.
|
|
@@ -229,10 +303,28 @@ module MetronomeSDK
|
|
|
229
303
|
#
|
|
230
304
|
# @param start_date [Time] The datetime when the credit becomes active
|
|
231
305
|
#
|
|
306
|
+
# @param access_type [Symbol, MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit::AccessType] Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of usag
|
|
307
|
+
#
|
|
308
|
+
# @param credit_type_id [String] The credit type for this credit. Quantity-based credits return the null credit t
|
|
309
|
+
#
|
|
232
310
|
# @param end_date [Time, nil] The datetime when the credit expires
|
|
233
311
|
#
|
|
234
312
|
# @param ledger_entries [Array<MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit::LedgerEntry>] Transaction history for this credit for this seat (only included if include_ledg
|
|
235
313
|
|
|
314
|
+
# Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
|
|
315
|
+
# usage. `QUANTITY` deducts the number of units used.
|
|
316
|
+
#
|
|
317
|
+
# @see MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit#access_type
|
|
318
|
+
module AccessType
|
|
319
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
320
|
+
|
|
321
|
+
SPEND = :SPEND
|
|
322
|
+
QUANTITY = :QUANTITY
|
|
323
|
+
|
|
324
|
+
# @!method self.values
|
|
325
|
+
# @return [Array<Symbol>]
|
|
326
|
+
end
|
|
327
|
+
|
|
236
328
|
class LedgerEntry < MetronomeSDK::Internal::Type::BaseModel
|
|
237
329
|
# @!attribute amount
|
|
238
330
|
# Amount of the ledger entry
|
data/lib/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_response.rb
CHANGED
|
@@ -15,6 +15,13 @@ module MetronomeSDK
|
|
|
15
15
|
|
|
16
16
|
# @see MetronomeSDK::Models::V1::ContractRetrieveSubscriptionQuantityHistoryResponse#data
|
|
17
17
|
class Data < MetronomeSDK::Internal::Type::BaseModel
|
|
18
|
+
# @!attribute custom_credit_type_id
|
|
19
|
+
# The pricing unit for history prices when present. Otherwise prices use
|
|
20
|
+
# fiat_credit_type_id.
|
|
21
|
+
#
|
|
22
|
+
# @return [String, nil]
|
|
23
|
+
optional :custom_credit_type_id, String
|
|
24
|
+
|
|
18
25
|
# @!attribute fiat_credit_type_id
|
|
19
26
|
#
|
|
20
27
|
# @return [String, nil]
|
|
@@ -31,9 +38,17 @@ module MetronomeSDK
|
|
|
31
38
|
# @return [String, nil]
|
|
32
39
|
optional :subscription_id, String
|
|
33
40
|
|
|
34
|
-
# @!method initialize(fiat_credit_type_id: nil, history: nil, subscription_id: nil)
|
|
41
|
+
# @!method initialize(custom_credit_type_id: nil, fiat_credit_type_id: nil, history: nil, subscription_id: nil)
|
|
42
|
+
# Some parameter documentations has been truncated, see
|
|
43
|
+
# {MetronomeSDK::Models::V1::ContractRetrieveSubscriptionQuantityHistoryResponse::Data}
|
|
44
|
+
# for more details.
|
|
45
|
+
#
|
|
46
|
+
# @param custom_credit_type_id [String] The pricing unit for history prices when present. Otherwise prices use fiat_cred
|
|
47
|
+
#
|
|
35
48
|
# @param fiat_credit_type_id [String]
|
|
49
|
+
#
|
|
36
50
|
# @param history [Array<MetronomeSDK::Models::V1::ContractRetrieveSubscriptionQuantityHistoryResponse::Data::History>]
|
|
51
|
+
#
|
|
37
52
|
# @param subscription_id [String]
|
|
38
53
|
|
|
39
54
|
class History < MetronomeSDK::Internal::Type::BaseModel
|
|
@@ -51,6 +51,13 @@ module MetronomeSDK
|
|
|
51
51
|
# @return [Boolean, nil]
|
|
52
52
|
optional :exclude_free_usage, MetronomeSDK::Internal::Type::Boolean
|
|
53
53
|
|
|
54
|
+
# @!attribute include_composite_spend
|
|
55
|
+
# Only for composite products. If true, allows a composite to incorporate spend
|
|
56
|
+
# from other composite products. Defaults to false
|
|
57
|
+
#
|
|
58
|
+
# @return [Boolean, nil]
|
|
59
|
+
optional :include_composite_spend, MetronomeSDK::Internal::Type::Boolean
|
|
60
|
+
|
|
54
61
|
# @!attribute is_refundable
|
|
55
62
|
# This field's availability is dependent on your client's configuration. Defaults
|
|
56
63
|
# to true.
|
|
@@ -125,7 +132,7 @@ module MetronomeSDK
|
|
|
125
132
|
# @return [Array<String>, nil]
|
|
126
133
|
optional :tags, MetronomeSDK::Internal::Type::ArrayOf[String]
|
|
127
134
|
|
|
128
|
-
# @!method initialize(name:, type:, billable_metric_id: nil, composite_product_ids: nil, composite_tags: nil, custom_fields: nil, exclude_free_usage: nil, is_refundable: nil, netsuite_internal_item_id: nil, netsuite_overage_item_id: nil, presentation_group_key: nil, pricing_group_key: nil, quantity_conversion: nil, quantity_rounding: nil, sql_breakdown_granularity: nil, tags: nil, request_options: {})
|
|
135
|
+
# @!method initialize(name:, type:, billable_metric_id: nil, composite_product_ids: nil, composite_tags: nil, custom_fields: nil, exclude_free_usage: nil, include_composite_spend: nil, is_refundable: nil, netsuite_internal_item_id: nil, netsuite_overage_item_id: nil, presentation_group_key: nil, pricing_group_key: nil, quantity_conversion: nil, quantity_rounding: nil, sql_breakdown_granularity: nil, tags: nil, request_options: {})
|
|
129
136
|
# Some parameter documentations has been truncated, see
|
|
130
137
|
# {MetronomeSDK::Models::V1::Contracts::ProductCreateParams} for more details.
|
|
131
138
|
#
|
|
@@ -143,6 +150,8 @@ module MetronomeSDK
|
|
|
143
150
|
#
|
|
144
151
|
# @param exclude_free_usage [Boolean] Beta feature only available for composite products. If true, products with $0 wi
|
|
145
152
|
#
|
|
153
|
+
# @param include_composite_spend [Boolean] Only for composite products. If true, allows a composite to incorporate spend fr
|
|
154
|
+
#
|
|
146
155
|
# @param is_refundable [Boolean] This field's availability is dependent on your client's configuration. Defaults
|
|
147
156
|
#
|
|
148
157
|
# @param netsuite_internal_item_id [String] This field's availability is dependent on your client's configuration.
|
|
@@ -40,6 +40,13 @@ module MetronomeSDK
|
|
|
40
40
|
# @return [Boolean, nil]
|
|
41
41
|
optional :exclude_free_usage, MetronomeSDK::Internal::Type::Boolean
|
|
42
42
|
|
|
43
|
+
# @!attribute include_composite_spend
|
|
44
|
+
# Only for composite products. If true, allows a composite to incorporate spend
|
|
45
|
+
# from other composite products. Defaults to false
|
|
46
|
+
#
|
|
47
|
+
# @return [Boolean, nil]
|
|
48
|
+
optional :include_composite_spend, MetronomeSDK::Internal::Type::Boolean
|
|
49
|
+
|
|
43
50
|
# @!attribute is_refundable
|
|
44
51
|
# This field's availability is dependent on your client's configuration.
|
|
45
52
|
#
|
|
@@ -106,7 +113,7 @@ module MetronomeSDK
|
|
|
106
113
|
# @return [Array<String>, nil]
|
|
107
114
|
optional :tags, MetronomeSDK::Internal::Type::ArrayOf[String]
|
|
108
115
|
|
|
109
|
-
# @!method initialize(created_at:, created_by:, name:, billable_metric_id: nil, composite_product_ids: nil, composite_tags: nil, exclude_free_usage: nil, is_refundable: nil, netsuite_internal_item_id: nil, netsuite_overage_item_id: nil, presentation_group_key: nil, pricing_group_key: nil, quantity_conversion: nil, quantity_rounding: nil, starting_at: nil, tags: nil)
|
|
116
|
+
# @!method initialize(created_at:, created_by:, name:, billable_metric_id: nil, composite_product_ids: nil, composite_tags: nil, exclude_free_usage: nil, include_composite_spend: nil, is_refundable: nil, netsuite_internal_item_id: nil, netsuite_overage_item_id: nil, presentation_group_key: nil, pricing_group_key: nil, quantity_conversion: nil, quantity_rounding: nil, starting_at: nil, tags: nil)
|
|
110
117
|
# Some parameter documentations has been truncated, see
|
|
111
118
|
# {MetronomeSDK::Models::V1::Contracts::ProductListItemState} for more details.
|
|
112
119
|
#
|
|
@@ -124,6 +131,8 @@ module MetronomeSDK
|
|
|
124
131
|
#
|
|
125
132
|
# @param exclude_free_usage [Boolean]
|
|
126
133
|
#
|
|
134
|
+
# @param include_composite_spend [Boolean] Only for composite products. If true, allows a composite to incorporate spend fr
|
|
135
|
+
#
|
|
127
136
|
# @param is_refundable [Boolean] This field's availability is dependent on your client's configuration.
|
|
128
137
|
#
|
|
129
138
|
# @param netsuite_internal_item_id [String] This field's availability is dependent on your client's configuration.
|
|
@@ -103,6 +103,13 @@ module MetronomeSDK
|
|
|
103
103
|
# @return [Boolean, nil]
|
|
104
104
|
optional :exclude_free_usage, MetronomeSDK::Internal::Type::Boolean
|
|
105
105
|
|
|
106
|
+
# @!attribute include_composite_spend
|
|
107
|
+
# Only for composite products. If true, allows a composite to incorporate spend
|
|
108
|
+
# from other composite products. Defaults to false
|
|
109
|
+
#
|
|
110
|
+
# @return [Boolean, nil]
|
|
111
|
+
optional :include_composite_spend, MetronomeSDK::Internal::Type::Boolean
|
|
112
|
+
|
|
106
113
|
# @!attribute is_refundable
|
|
107
114
|
#
|
|
108
115
|
# @return [Boolean, nil]
|
|
@@ -173,7 +180,7 @@ module MetronomeSDK
|
|
|
173
180
|
# @return [Array<String>, nil]
|
|
174
181
|
optional :tags, MetronomeSDK::Internal::Type::ArrayOf[String]
|
|
175
182
|
|
|
176
|
-
# @!method initialize(created_at:, created_by:, billable_metric_id: nil, composite_product_ids: nil, composite_tags: nil, exclude_free_usage: nil, is_refundable: nil, name: nil, netsuite_internal_item_id: nil, netsuite_overage_item_id: nil, presentation_group_key: nil, pricing_group_key: nil, quantity_conversion: nil, quantity_rounding: nil, starting_at: nil, tags: nil)
|
|
183
|
+
# @!method initialize(created_at:, created_by:, billable_metric_id: nil, composite_product_ids: nil, composite_tags: nil, exclude_free_usage: nil, include_composite_spend: nil, is_refundable: nil, name: nil, netsuite_internal_item_id: nil, netsuite_overage_item_id: nil, presentation_group_key: nil, pricing_group_key: nil, quantity_conversion: nil, quantity_rounding: nil, starting_at: nil, tags: nil)
|
|
177
184
|
# Some parameter documentations has been truncated, see
|
|
178
185
|
# {MetronomeSDK::Models::V1::Contracts::ProductListResponse::Update} for more
|
|
179
186
|
# details.
|
|
@@ -190,6 +197,8 @@ module MetronomeSDK
|
|
|
190
197
|
#
|
|
191
198
|
# @param exclude_free_usage [Boolean]
|
|
192
199
|
#
|
|
200
|
+
# @param include_composite_spend [Boolean] Only for composite products. If true, allows a composite to incorporate spend fr
|
|
201
|
+
#
|
|
193
202
|
# @param is_refundable [Boolean]
|
|
194
203
|
#
|
|
195
204
|
# @param name [String]
|
|
@@ -113,6 +113,13 @@ module MetronomeSDK
|
|
|
113
113
|
# @return [Boolean, nil]
|
|
114
114
|
optional :exclude_free_usage, MetronomeSDK::Internal::Type::Boolean
|
|
115
115
|
|
|
116
|
+
# @!attribute include_composite_spend
|
|
117
|
+
# Only for composite products. If true, allows a composite to incorporate spend
|
|
118
|
+
# from other composite products. Defaults to false
|
|
119
|
+
#
|
|
120
|
+
# @return [Boolean, nil]
|
|
121
|
+
optional :include_composite_spend, MetronomeSDK::Internal::Type::Boolean
|
|
122
|
+
|
|
116
123
|
# @!attribute is_refundable
|
|
117
124
|
#
|
|
118
125
|
# @return [Boolean, nil]
|
|
@@ -187,7 +194,7 @@ module MetronomeSDK
|
|
|
187
194
|
# @return [Array<String>, nil]
|
|
188
195
|
optional :tags, MetronomeSDK::Internal::Type::ArrayOf[String]
|
|
189
196
|
|
|
190
|
-
# @!method initialize(created_at:, created_by:, billable_metric_id: nil, composite_product_ids: nil, composite_tags: nil, exclude_free_usage: nil, is_refundable: nil, name: nil, netsuite_internal_item_id: nil, netsuite_overage_item_id: nil, presentation_group_key: nil, pricing_group_key: nil, quantity_conversion: nil, quantity_rounding: nil, starting_at: nil, tags: nil)
|
|
197
|
+
# @!method initialize(created_at:, created_by:, billable_metric_id: nil, composite_product_ids: nil, composite_tags: nil, exclude_free_usage: nil, include_composite_spend: nil, is_refundable: nil, name: nil, netsuite_internal_item_id: nil, netsuite_overage_item_id: nil, presentation_group_key: nil, pricing_group_key: nil, quantity_conversion: nil, quantity_rounding: nil, starting_at: nil, tags: nil)
|
|
191
198
|
# Some parameter documentations has been truncated, see
|
|
192
199
|
# {MetronomeSDK::Models::V1::Contracts::ProductRetrieveResponse::Data::Update} for
|
|
193
200
|
# more details.
|
|
@@ -204,6 +211,8 @@ module MetronomeSDK
|
|
|
204
211
|
#
|
|
205
212
|
# @param exclude_free_usage [Boolean]
|
|
206
213
|
#
|
|
214
|
+
# @param include_composite_spend [Boolean] Only for composite products. If true, allows a composite to incorporate spend fr
|
|
215
|
+
#
|
|
207
216
|
# @param is_refundable [Boolean]
|
|
208
217
|
#
|
|
209
218
|
# @param name [String]
|
|
@@ -50,6 +50,13 @@ module MetronomeSDK
|
|
|
50
50
|
# @return [Boolean, nil]
|
|
51
51
|
optional :exclude_free_usage, MetronomeSDK::Internal::Type::Boolean
|
|
52
52
|
|
|
53
|
+
# @!attribute include_composite_spend
|
|
54
|
+
# Only for composite products. If true, allows a composite to incorporate spend
|
|
55
|
+
# from other composite products. Defaults to false
|
|
56
|
+
#
|
|
57
|
+
# @return [Boolean, nil]
|
|
58
|
+
optional :include_composite_spend, MetronomeSDK::Internal::Type::Boolean
|
|
59
|
+
|
|
53
60
|
# @!attribute is_refundable
|
|
54
61
|
# Defaults to product's current refundability status. This field's availability is
|
|
55
62
|
# dependent on your client's configuration.
|
|
@@ -134,7 +141,7 @@ module MetronomeSDK
|
|
|
134
141
|
# @return [Array<String>, nil]
|
|
135
142
|
optional :tags, MetronomeSDK::Internal::Type::ArrayOf[String]
|
|
136
143
|
|
|
137
|
-
# @!method initialize(product_id:, starting_at:, billable_metric_id: nil, composite_product_ids: nil, composite_tags: nil, exclude_free_usage: nil, is_refundable: nil, name: nil, netsuite_internal_item_id: nil, netsuite_overage_item_id: nil, presentation_group_key: nil, pricing_group_key: nil, quantity_conversion: nil, quantity_rounding: nil, sql_breakdown_granularity: nil, tags: nil, request_options: {})
|
|
144
|
+
# @!method initialize(product_id:, starting_at:, billable_metric_id: nil, composite_product_ids: nil, composite_tags: nil, exclude_free_usage: nil, include_composite_spend: nil, is_refundable: nil, name: nil, netsuite_internal_item_id: nil, netsuite_overage_item_id: nil, presentation_group_key: nil, pricing_group_key: nil, quantity_conversion: nil, quantity_rounding: nil, sql_breakdown_granularity: nil, tags: nil, request_options: {})
|
|
138
145
|
# Some parameter documentations has been truncated, see
|
|
139
146
|
# {MetronomeSDK::Models::V1::Contracts::ProductUpdateParams} for more details.
|
|
140
147
|
#
|
|
@@ -150,6 +157,8 @@ module MetronomeSDK
|
|
|
150
157
|
#
|
|
151
158
|
# @param exclude_free_usage [Boolean] Beta feature only available for composite products. If true, products with $0 wi
|
|
152
159
|
#
|
|
160
|
+
# @param include_composite_spend [Boolean] Only for composite products. If true, allows a composite to incorporate spend fr
|
|
161
|
+
#
|
|
153
162
|
# @param is_refundable [Boolean] Defaults to product's current refundability status. This field's availability is
|
|
154
163
|
#
|
|
155
164
|
# @param name [String] displayed on invoices. If not provided, defaults to product's current name.
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module MetronomeSDK
|
|
4
|
+
module Models
|
|
5
|
+
module V1
|
|
6
|
+
module Contracts
|
|
7
|
+
module RateCards
|
|
8
|
+
# @see MetronomeSDK::Resources::V1::Contracts::RateCards::NamedSchedules#list
|
|
9
|
+
class NamedScheduleListParams < MetronomeSDK::Internal::Type::BaseModel
|
|
10
|
+
extend MetronomeSDK::Internal::Type::RequestParameters::Converter
|
|
11
|
+
include MetronomeSDK::Internal::Type::RequestParameters
|
|
12
|
+
|
|
13
|
+
# @!attribute customer_id
|
|
14
|
+
# ID of the customer to list contract named schedules for
|
|
15
|
+
#
|
|
16
|
+
# @return [String]
|
|
17
|
+
required :customer_id, String
|
|
18
|
+
|
|
19
|
+
# @!attribute contract_id
|
|
20
|
+
# Optional ID of a contract to scope the results to a single contract
|
|
21
|
+
#
|
|
22
|
+
# @return [String, nil]
|
|
23
|
+
optional :contract_id, String
|
|
24
|
+
|
|
25
|
+
# @!attribute covering_date
|
|
26
|
+
# If provided, result contains at most one segment covering this date for each
|
|
27
|
+
# schedule.
|
|
28
|
+
#
|
|
29
|
+
# @return [Time, nil]
|
|
30
|
+
optional :covering_date, Time
|
|
31
|
+
|
|
32
|
+
# @!attribute limit
|
|
33
|
+
# Maximum number of named schedules to return.
|
|
34
|
+
#
|
|
35
|
+
# @return [Integer, nil]
|
|
36
|
+
optional :limit, Integer
|
|
37
|
+
|
|
38
|
+
# @!attribute next_page
|
|
39
|
+
# Cursor for pagination. Use the value from a previous response's next_page.
|
|
40
|
+
#
|
|
41
|
+
# @return [String, nil]
|
|
42
|
+
optional :next_page, String
|
|
43
|
+
|
|
44
|
+
# @!attribute properties
|
|
45
|
+
# Optional key-value filters. A schedule matches when it contains at least this
|
|
46
|
+
# subset of properties.
|
|
47
|
+
#
|
|
48
|
+
# @return [Hash{Symbol=>String}, nil]
|
|
49
|
+
optional :properties, MetronomeSDK::Internal::Type::HashOf[String]
|
|
50
|
+
|
|
51
|
+
# @!attribute schedule_name
|
|
52
|
+
# Optional filter to scope the results to a single schedule name
|
|
53
|
+
#
|
|
54
|
+
# @return [String, nil]
|
|
55
|
+
optional :schedule_name, String
|
|
56
|
+
|
|
57
|
+
# @!method initialize(customer_id:, contract_id: nil, covering_date: nil, limit: nil, next_page: nil, properties: nil, schedule_name: nil, request_options: {})
|
|
58
|
+
# Some parameter documentations has been truncated, see
|
|
59
|
+
# {MetronomeSDK::Models::V1::Contracts::RateCards::NamedScheduleListParams} for
|
|
60
|
+
# more details.
|
|
61
|
+
#
|
|
62
|
+
# @param customer_id [String] ID of the customer to list contract named schedules for
|
|
63
|
+
#
|
|
64
|
+
# @param contract_id [String] Optional ID of a contract to scope the results to a single contract
|
|
65
|
+
#
|
|
66
|
+
# @param covering_date [Time] If provided, result contains at most one segment covering this date for each sch
|
|
67
|
+
#
|
|
68
|
+
# @param limit [Integer] Maximum number of named schedules to return.
|
|
69
|
+
#
|
|
70
|
+
# @param next_page [String] Cursor for pagination. Use the value from a previous response's next_page.
|
|
71
|
+
#
|
|
72
|
+
# @param properties [Hash{Symbol=>String}] Optional key-value filters. A schedule matches when it contains at least this su
|
|
73
|
+
#
|
|
74
|
+
# @param schedule_name [String] Optional filter to scope the results to a single schedule name
|
|
75
|
+
#
|
|
76
|
+
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
77
|
+
end
|
|
78
|
+
end
|
|
79
|
+
end
|
|
80
|
+
end
|
|
81
|
+
end
|
|
82
|
+
end
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module MetronomeSDK
|
|
4
|
+
module Models
|
|
5
|
+
module V1
|
|
6
|
+
module Contracts
|
|
7
|
+
module RateCards
|
|
8
|
+
# @see MetronomeSDK::Resources::V1::Contracts::RateCards::NamedSchedules#list
|
|
9
|
+
class NamedScheduleListResponse < MetronomeSDK::Internal::Type::BaseModel
|
|
10
|
+
# @!attribute contract_id
|
|
11
|
+
# ID of the contract this named schedule belongs to.
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :contract_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute schedule_name
|
|
17
|
+
# Name of the schedule.
|
|
18
|
+
#
|
|
19
|
+
# @return [String]
|
|
20
|
+
required :schedule_name, String
|
|
21
|
+
|
|
22
|
+
# @!attribute segments
|
|
23
|
+
#
|
|
24
|
+
# @return [Array<MetronomeSDK::Models::V1::Contracts::RateCards::NamedScheduleListResponse::Segment>]
|
|
25
|
+
required :segments,
|
|
26
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::Contracts::RateCards::NamedScheduleListResponse::Segment] }
|
|
27
|
+
|
|
28
|
+
# @!attribute properties
|
|
29
|
+
# Properties on this named schedule.
|
|
30
|
+
#
|
|
31
|
+
# @return [Hash{Symbol=>String}, nil]
|
|
32
|
+
optional :properties, MetronomeSDK::Internal::Type::HashOf[String]
|
|
33
|
+
|
|
34
|
+
# @!method initialize(contract_id:, schedule_name:, segments:, properties: nil)
|
|
35
|
+
# @param contract_id [String] ID of the contract this named schedule belongs to.
|
|
36
|
+
#
|
|
37
|
+
# @param schedule_name [String] Name of the schedule.
|
|
38
|
+
#
|
|
39
|
+
# @param segments [Array<MetronomeSDK::Models::V1::Contracts::RateCards::NamedScheduleListResponse::Segment>]
|
|
40
|
+
#
|
|
41
|
+
# @param properties [Hash{Symbol=>String}] Properties on this named schedule.
|
|
42
|
+
|
|
43
|
+
class Segment < MetronomeSDK::Internal::Type::BaseModel
|
|
44
|
+
# @!attribute starting_at
|
|
45
|
+
#
|
|
46
|
+
# @return [Time]
|
|
47
|
+
required :starting_at, Time
|
|
48
|
+
|
|
49
|
+
# @!attribute value
|
|
50
|
+
#
|
|
51
|
+
# @return [Object]
|
|
52
|
+
required :value, MetronomeSDK::Internal::Type::Unknown
|
|
53
|
+
|
|
54
|
+
# @!attribute ending_before
|
|
55
|
+
#
|
|
56
|
+
# @return [Time, nil]
|
|
57
|
+
optional :ending_before, Time
|
|
58
|
+
|
|
59
|
+
# @!method initialize(starting_at:, value:, ending_before: nil)
|
|
60
|
+
# @param starting_at [Time]
|
|
61
|
+
# @param value [Object]
|
|
62
|
+
# @param ending_before [Time]
|
|
63
|
+
end
|
|
64
|
+
end
|
|
65
|
+
end
|
|
66
|
+
end
|
|
67
|
+
end
|
|
68
|
+
end
|
|
69
|
+
end
|
|
@@ -35,7 +35,14 @@ module MetronomeSDK
|
|
|
35
35
|
# @return [Time, nil]
|
|
36
36
|
optional :covering_date, Time
|
|
37
37
|
|
|
38
|
-
# @!
|
|
38
|
+
# @!attribute properties
|
|
39
|
+
# A set of key-value pairs that qualifies which schedule should be applied when
|
|
40
|
+
# looking up a schedule by name.
|
|
41
|
+
#
|
|
42
|
+
# @return [Hash{Symbol=>String}, nil]
|
|
43
|
+
optional :properties, MetronomeSDK::Internal::Type::HashOf[String]
|
|
44
|
+
|
|
45
|
+
# @!method initialize(contract_id:, customer_id:, schedule_name:, covering_date: nil, properties: nil, request_options: {})
|
|
39
46
|
# Some parameter documentations has been truncated, see
|
|
40
47
|
# {MetronomeSDK::Models::V1::Contracts::RateCards::NamedScheduleRetrieveParams}
|
|
41
48
|
# for more details.
|
|
@@ -48,6 +55,8 @@ module MetronomeSDK
|
|
|
48
55
|
#
|
|
49
56
|
# @param covering_date [Time] If provided, at most one schedule segment will be returned (the one that covers
|
|
50
57
|
#
|
|
58
|
+
# @param properties [Hash{Symbol=>String}] A set of key-value pairs that qualifies which schedule should be applied when lo
|
|
59
|
+
#
|
|
51
60
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
52
61
|
end
|
|
53
62
|
end
|
|
@@ -45,7 +45,14 @@ module MetronomeSDK
|
|
|
45
45
|
# @return [Time, nil]
|
|
46
46
|
optional :ending_before, Time
|
|
47
47
|
|
|
48
|
-
# @!
|
|
48
|
+
# @!attribute properties
|
|
49
|
+
# A set of key-value pairs that qualifies which schedule should be applied when
|
|
50
|
+
# looking up a schedule by name.
|
|
51
|
+
#
|
|
52
|
+
# @return [Hash{Symbol=>String}, nil]
|
|
53
|
+
optional :properties, MetronomeSDK::Internal::Type::HashOf[String]
|
|
54
|
+
|
|
55
|
+
# @!method initialize(contract_id:, customer_id:, schedule_name:, starting_at:, value:, ending_before: nil, properties: nil, request_options: {})
|
|
49
56
|
# Some parameter documentations has been truncated, see
|
|
50
57
|
# {MetronomeSDK::Models::V1::Contracts::RateCards::NamedScheduleUpdateParams} for
|
|
51
58
|
# more details.
|
|
@@ -62,6 +69,8 @@ module MetronomeSDK
|
|
|
62
69
|
#
|
|
63
70
|
# @param ending_before [Time]
|
|
64
71
|
#
|
|
72
|
+
# @param properties [Hash{Symbol=>String}] A set of key-value pairs that qualifies which schedule should be applied when lo
|
|
73
|
+
#
|
|
65
74
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
66
75
|
end
|
|
67
76
|
end
|
|
@@ -109,18 +109,13 @@ module MetronomeSDK
|
|
|
109
109
|
optional :aws_region, enum: -> { MetronomeSDK::V1::CustomerCreateParams::BillingConfig::AwsRegion }
|
|
110
110
|
|
|
111
111
|
# @!attribute stripe_collection_method
|
|
112
|
-
# The collection method for the customer's invoices.
|
|
113
|
-
# `auto_charge_payment_intent` and `manually_charge_payment_intent` are in beta.
|
|
112
|
+
# The collection method for the customer's invoices.
|
|
114
113
|
#
|
|
115
114
|
# @return [Symbol, MetronomeSDK::Models::V1::CustomerCreateParams::BillingConfig::StripeCollectionMethod, nil]
|
|
116
115
|
optional :stripe_collection_method,
|
|
117
116
|
enum: -> { MetronomeSDK::V1::CustomerCreateParams::BillingConfig::StripeCollectionMethod }
|
|
118
117
|
|
|
119
118
|
# @!method initialize(billing_provider_customer_id:, billing_provider_type:, aws_customer_account_id: nil, aws_customer_id: nil, aws_is_subscription_product: nil, aws_product_code: nil, aws_region: nil, stripe_collection_method: nil)
|
|
120
|
-
# Some parameter documentations has been truncated, see
|
|
121
|
-
# {MetronomeSDK::Models::V1::CustomerCreateParams::BillingConfig} for more
|
|
122
|
-
# details.
|
|
123
|
-
#
|
|
124
119
|
# @param billing_provider_customer_id [String]
|
|
125
120
|
#
|
|
126
121
|
# @param billing_provider_type [Symbol, MetronomeSDK::Models::V1::CustomerCreateParams::BillingConfig::BillingProviderType]
|
|
@@ -189,8 +184,7 @@ module MetronomeSDK
|
|
|
189
184
|
# @return [Array<Symbol>]
|
|
190
185
|
end
|
|
191
186
|
|
|
192
|
-
# The collection method for the customer's invoices.
|
|
193
|
-
# `auto_charge_payment_intent` and `manually_charge_payment_intent` are in beta.
|
|
187
|
+
# The collection method for the customer's invoices.
|
|
194
188
|
#
|
|
195
189
|
# @see MetronomeSDK::Models::V1::CustomerCreateParams::BillingConfig#stripe_collection_method
|
|
196
190
|
module StripeCollectionMethod
|
|
@@ -198,8 +192,6 @@ module MetronomeSDK
|
|
|
198
192
|
|
|
199
193
|
CHARGE_AUTOMATICALLY = :charge_automatically
|
|
200
194
|
SEND_INVOICE = :send_invoice
|
|
201
|
-
AUTO_CHARGE_PAYMENT_INTENT = :auto_charge_payment_intent
|
|
202
|
-
MANUALLY_CHARGE_PAYMENT_INTENT = :manually_charge_payment_intent
|
|
203
195
|
|
|
204
196
|
# @!method self.values
|
|
205
197
|
# @return [Array<Symbol>]
|
|
@@ -241,8 +233,7 @@ module MetronomeSDK
|
|
|
241
233
|
# @!attribute tax_provider
|
|
242
234
|
# Specifies which tax provider Metronome should use for tax calculation when
|
|
243
235
|
# billing through Stripe. This is only supported for Stripe billing provider
|
|
244
|
-
# configurations
|
|
245
|
-
# collection methods.
|
|
236
|
+
# configurations.
|
|
246
237
|
#
|
|
247
238
|
# @return [Symbol, MetronomeSDK::Models::V1::CustomerCreateParams::CustomerBillingProviderConfiguration::TaxProvider, nil]
|
|
248
239
|
optional :tax_provider,
|
|
@@ -297,8 +288,7 @@ module MetronomeSDK
|
|
|
297
288
|
|
|
298
289
|
# Specifies which tax provider Metronome should use for tax calculation when
|
|
299
290
|
# billing through Stripe. This is only supported for Stripe billing provider
|
|
300
|
-
# configurations
|
|
301
|
-
# collection methods.
|
|
291
|
+
# configurations.
|
|
302
292
|
#
|
|
303
293
|
# @see MetronomeSDK::Models::V1::CustomerCreateParams::CustomerBillingProviderConfiguration#tax_provider
|
|
304
294
|
module TaxProvider
|
|
@@ -61,8 +61,7 @@ module MetronomeSDK
|
|
|
61
61
|
# @!attribute tax_provider
|
|
62
62
|
# Specifies which tax provider Metronome should use for tax calculation when
|
|
63
63
|
# billing through Stripe. This is only supported for Stripe billing provider
|
|
64
|
-
# configurations
|
|
65
|
-
# collection methods.
|
|
64
|
+
# configurations.
|
|
66
65
|
#
|
|
67
66
|
# @return [Symbol, MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsParams::Data::TaxProvider, nil]
|
|
68
67
|
optional :tax_provider,
|
|
@@ -123,8 +122,7 @@ module MetronomeSDK
|
|
|
123
122
|
|
|
124
123
|
# Specifies which tax provider Metronome should use for tax calculation when
|
|
125
124
|
# billing through Stripe. This is only supported for Stripe billing provider
|
|
126
|
-
# configurations
|
|
127
|
-
# collection methods.
|
|
125
|
+
# configurations.
|
|
128
126
|
#
|
|
129
127
|
# @see MetronomeSDK::Models::V1::CustomerSetBillingConfigurationsParams::Data#tax_provider
|
|
130
128
|
module TaxProvider
|