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
|
@@ -375,19 +375,34 @@ module MetronomeSDK
|
|
|
375
375
|
required :schedule_items,
|
|
376
376
|
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::PackageCreateParams::Commit::AccessSchedule::ScheduleItem] }
|
|
377
377
|
|
|
378
|
+
# @!attribute access_type
|
|
379
|
+
# Determines how the balance is drawn down. `SPEND` deducts the dollar cost of
|
|
380
|
+
# usage. `QUANTITY` deducts the number of units used. Defaults to `SPEND` if
|
|
381
|
+
# omitted.
|
|
382
|
+
#
|
|
383
|
+
# @return [Symbol, MetronomeSDK::Models::V1::PackageCreateParams::Commit::AccessSchedule::AccessType, nil]
|
|
384
|
+
optional :access_type,
|
|
385
|
+
enum: -> { MetronomeSDK::V1::PackageCreateParams::Commit::AccessSchedule::AccessType }
|
|
386
|
+
|
|
378
387
|
# @!attribute credit_type_id
|
|
379
388
|
# Defaults to USD (cents) if not passed
|
|
380
389
|
#
|
|
381
390
|
# @return [String, nil]
|
|
382
391
|
optional :credit_type_id, String
|
|
383
392
|
|
|
384
|
-
# @!method initialize(schedule_items:, credit_type_id: nil)
|
|
393
|
+
# @!method initialize(schedule_items:, access_type: nil, credit_type_id: nil)
|
|
394
|
+
# Some parameter documentations has been truncated, see
|
|
395
|
+
# {MetronomeSDK::Models::V1::PackageCreateParams::Commit::AccessSchedule} for more
|
|
396
|
+
# details.
|
|
397
|
+
#
|
|
385
398
|
# Required: Schedule for distributing the commit to the customer. For "POSTPAID"
|
|
386
399
|
# commits only one schedule item is allowed and amount must match invoice_schedule
|
|
387
400
|
# total.
|
|
388
401
|
#
|
|
389
402
|
# @param schedule_items [Array<MetronomeSDK::Models::V1::PackageCreateParams::Commit::AccessSchedule::ScheduleItem>]
|
|
390
403
|
#
|
|
404
|
+
# @param access_type [Symbol, MetronomeSDK::Models::V1::PackageCreateParams::Commit::AccessSchedule::AccessType] Determines how the balance is drawn down. `SPEND` deducts the dollar cost of usa
|
|
405
|
+
#
|
|
391
406
|
# @param credit_type_id [String] Defaults to USD (cents) if not passed
|
|
392
407
|
|
|
393
408
|
class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
|
|
@@ -489,6 +504,21 @@ module MetronomeSDK
|
|
|
489
504
|
end
|
|
490
505
|
end
|
|
491
506
|
end
|
|
507
|
+
|
|
508
|
+
# Determines how the balance is drawn down. `SPEND` deducts the dollar cost of
|
|
509
|
+
# usage. `QUANTITY` deducts the number of units used. Defaults to `SPEND` if
|
|
510
|
+
# omitted.
|
|
511
|
+
#
|
|
512
|
+
# @see MetronomeSDK::Models::V1::PackageCreateParams::Commit::AccessSchedule#access_type
|
|
513
|
+
module AccessType
|
|
514
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
515
|
+
|
|
516
|
+
SPEND = :SPEND
|
|
517
|
+
QUANTITY = :QUANTITY
|
|
518
|
+
|
|
519
|
+
# @!method self.values
|
|
520
|
+
# @return [Array<Symbol>]
|
|
521
|
+
end
|
|
492
522
|
end
|
|
493
523
|
|
|
494
524
|
# @see MetronomeSDK::Models::V1::PackageCreateParams::Commit#type
|
|
@@ -712,17 +742,32 @@ module MetronomeSDK
|
|
|
712
742
|
required :schedule_items,
|
|
713
743
|
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::PackageCreateParams::Credit::AccessSchedule::ScheduleItem] }
|
|
714
744
|
|
|
745
|
+
# @!attribute access_type
|
|
746
|
+
# Determines how the balance is drawn down. `SPEND` deducts the dollar cost of
|
|
747
|
+
# usage. `QUANTITY` deducts the number of units used. Defaults to `SPEND` if
|
|
748
|
+
# omitted.
|
|
749
|
+
#
|
|
750
|
+
# @return [Symbol, MetronomeSDK::Models::V1::PackageCreateParams::Credit::AccessSchedule::AccessType, nil]
|
|
751
|
+
optional :access_type,
|
|
752
|
+
enum: -> { MetronomeSDK::V1::PackageCreateParams::Credit::AccessSchedule::AccessType }
|
|
753
|
+
|
|
715
754
|
# @!attribute credit_type_id
|
|
716
755
|
# Defaults to USD (cents) if not passed
|
|
717
756
|
#
|
|
718
757
|
# @return [String, nil]
|
|
719
758
|
optional :credit_type_id, String
|
|
720
759
|
|
|
721
|
-
# @!method initialize(schedule_items:, credit_type_id: nil)
|
|
760
|
+
# @!method initialize(schedule_items:, access_type: nil, credit_type_id: nil)
|
|
761
|
+
# Some parameter documentations has been truncated, see
|
|
762
|
+
# {MetronomeSDK::Models::V1::PackageCreateParams::Credit::AccessSchedule} for more
|
|
763
|
+
# details.
|
|
764
|
+
#
|
|
722
765
|
# Schedule for distributing the credit to the customer.
|
|
723
766
|
#
|
|
724
767
|
# @param schedule_items [Array<MetronomeSDK::Models::V1::PackageCreateParams::Credit::AccessSchedule::ScheduleItem>]
|
|
725
768
|
#
|
|
769
|
+
# @param access_type [Symbol, MetronomeSDK::Models::V1::PackageCreateParams::Credit::AccessSchedule::AccessType] Determines how the balance is drawn down. `SPEND` deducts the dollar cost of usa
|
|
770
|
+
#
|
|
726
771
|
# @param credit_type_id [String] Defaults to USD (cents) if not passed
|
|
727
772
|
|
|
728
773
|
class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
|
|
@@ -824,6 +869,21 @@ module MetronomeSDK
|
|
|
824
869
|
end
|
|
825
870
|
end
|
|
826
871
|
end
|
|
872
|
+
|
|
873
|
+
# Determines how the balance is drawn down. `SPEND` deducts the dollar cost of
|
|
874
|
+
# usage. `QUANTITY` deducts the number of units used. Defaults to `SPEND` if
|
|
875
|
+
# omitted.
|
|
876
|
+
#
|
|
877
|
+
# @see MetronomeSDK::Models::V1::PackageCreateParams::Credit::AccessSchedule#access_type
|
|
878
|
+
module AccessType
|
|
879
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
880
|
+
|
|
881
|
+
SPEND = :SPEND
|
|
882
|
+
QUANTITY = :QUANTITY
|
|
883
|
+
|
|
884
|
+
# @!method self.values
|
|
885
|
+
# @return [Array<Symbol>]
|
|
886
|
+
end
|
|
827
887
|
end
|
|
828
888
|
|
|
829
889
|
# @see MetronomeSDK::Models::V1::PackageCreateParams::Credit#rate_type
|
|
@@ -1468,16 +1528,25 @@ module MetronomeSDK
|
|
|
1468
1528
|
|
|
1469
1529
|
# @see MetronomeSDK::Models::V1::PackageCreateParams::RecurringCommit#access_amount
|
|
1470
1530
|
class AccessAmount < MetronomeSDK::Internal::Type::BaseModel
|
|
1471
|
-
# @!attribute credit_type_id
|
|
1472
|
-
#
|
|
1473
|
-
# @return [String]
|
|
1474
|
-
required :credit_type_id, String
|
|
1475
|
-
|
|
1476
1531
|
# @!attribute unit_price
|
|
1477
1532
|
#
|
|
1478
1533
|
# @return [Float]
|
|
1479
1534
|
required :unit_price, Float
|
|
1480
1535
|
|
|
1536
|
+
# @!attribute access_type
|
|
1537
|
+
# Indicates how the balance of child commits is drawn down. `SPEND` deducts the
|
|
1538
|
+
# dollar cost of usage. `QUANTITY` deducts the number of units used.
|
|
1539
|
+
#
|
|
1540
|
+
# @return [Symbol, MetronomeSDK::Models::V1::PackageCreateParams::RecurringCommit::AccessAmount::AccessType, nil]
|
|
1541
|
+
optional :access_type,
|
|
1542
|
+
enum: -> { MetronomeSDK::V1::PackageCreateParams::RecurringCommit::AccessAmount::AccessType }
|
|
1543
|
+
|
|
1544
|
+
# @!attribute credit_type_id
|
|
1545
|
+
# Defaults to USD (cents) if not passed
|
|
1546
|
+
#
|
|
1547
|
+
# @return [String, nil]
|
|
1548
|
+
optional :credit_type_id, String
|
|
1549
|
+
|
|
1481
1550
|
# @!attribute quantity
|
|
1482
1551
|
# This field is required unless a subscription is attached via
|
|
1483
1552
|
# `subscription_config`.
|
|
@@ -1485,18 +1554,34 @@ module MetronomeSDK
|
|
|
1485
1554
|
# @return [Float, nil]
|
|
1486
1555
|
optional :quantity, Float
|
|
1487
1556
|
|
|
1488
|
-
# @!method initialize(
|
|
1557
|
+
# @!method initialize(unit_price:, access_type: nil, credit_type_id: nil, quantity: nil)
|
|
1489
1558
|
# Some parameter documentations has been truncated, see
|
|
1490
1559
|
# {MetronomeSDK::Models::V1::PackageCreateParams::RecurringCommit::AccessAmount}
|
|
1491
1560
|
# for more details.
|
|
1492
1561
|
#
|
|
1493
1562
|
# The amount of commit to grant.
|
|
1494
1563
|
#
|
|
1495
|
-
# @param credit_type_id [String]
|
|
1496
|
-
#
|
|
1497
1564
|
# @param unit_price [Float]
|
|
1498
1565
|
#
|
|
1566
|
+
# @param access_type [Symbol, MetronomeSDK::Models::V1::PackageCreateParams::RecurringCommit::AccessAmount::AccessType] Indicates how the balance of child commits is drawn down. `SPEND` deducts the do
|
|
1567
|
+
#
|
|
1568
|
+
# @param credit_type_id [String] Defaults to USD (cents) if not passed
|
|
1569
|
+
#
|
|
1499
1570
|
# @param quantity [Float] This field is required unless a subscription is attached via `subscription_confi
|
|
1571
|
+
|
|
1572
|
+
# Indicates how the balance of child commits is drawn down. `SPEND` deducts the
|
|
1573
|
+
# dollar cost of usage. `QUANTITY` deducts the number of units used.
|
|
1574
|
+
#
|
|
1575
|
+
# @see MetronomeSDK::Models::V1::PackageCreateParams::RecurringCommit::AccessAmount#access_type
|
|
1576
|
+
module AccessType
|
|
1577
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
1578
|
+
|
|
1579
|
+
SPEND = :SPEND
|
|
1580
|
+
QUANTITY = :QUANTITY
|
|
1581
|
+
|
|
1582
|
+
# @!method self.values
|
|
1583
|
+
# @return [Array<Symbol>]
|
|
1584
|
+
end
|
|
1500
1585
|
end
|
|
1501
1586
|
|
|
1502
1587
|
# @see MetronomeSDK::Models::V1::PackageCreateParams::RecurringCommit#commit_duration
|
|
@@ -2004,16 +2089,25 @@ module MetronomeSDK
|
|
|
2004
2089
|
|
|
2005
2090
|
# @see MetronomeSDK::Models::V1::PackageCreateParams::RecurringCredit#access_amount
|
|
2006
2091
|
class AccessAmount < MetronomeSDK::Internal::Type::BaseModel
|
|
2007
|
-
# @!attribute credit_type_id
|
|
2008
|
-
#
|
|
2009
|
-
# @return [String]
|
|
2010
|
-
required :credit_type_id, String
|
|
2011
|
-
|
|
2012
2092
|
# @!attribute unit_price
|
|
2013
2093
|
#
|
|
2014
2094
|
# @return [Float]
|
|
2015
2095
|
required :unit_price, Float
|
|
2016
2096
|
|
|
2097
|
+
# @!attribute access_type
|
|
2098
|
+
# Indicates how the balance of child commits is drawn down. `SPEND` deducts the
|
|
2099
|
+
# dollar cost of usage. `QUANTITY` deducts the number of units used.
|
|
2100
|
+
#
|
|
2101
|
+
# @return [Symbol, MetronomeSDK::Models::V1::PackageCreateParams::RecurringCredit::AccessAmount::AccessType, nil]
|
|
2102
|
+
optional :access_type,
|
|
2103
|
+
enum: -> { MetronomeSDK::V1::PackageCreateParams::RecurringCredit::AccessAmount::AccessType }
|
|
2104
|
+
|
|
2105
|
+
# @!attribute credit_type_id
|
|
2106
|
+
# Defaults to USD (cents) if not passed
|
|
2107
|
+
#
|
|
2108
|
+
# @return [String, nil]
|
|
2109
|
+
optional :credit_type_id, String
|
|
2110
|
+
|
|
2017
2111
|
# @!attribute quantity
|
|
2018
2112
|
# This field is required unless a subscription is attached via
|
|
2019
2113
|
# `subscription_config`.
|
|
@@ -2021,18 +2115,34 @@ module MetronomeSDK
|
|
|
2021
2115
|
# @return [Float, nil]
|
|
2022
2116
|
optional :quantity, Float
|
|
2023
2117
|
|
|
2024
|
-
# @!method initialize(
|
|
2118
|
+
# @!method initialize(unit_price:, access_type: nil, credit_type_id: nil, quantity: nil)
|
|
2025
2119
|
# Some parameter documentations has been truncated, see
|
|
2026
2120
|
# {MetronomeSDK::Models::V1::PackageCreateParams::RecurringCredit::AccessAmount}
|
|
2027
2121
|
# for more details.
|
|
2028
2122
|
#
|
|
2029
2123
|
# The amount of commit to grant.
|
|
2030
2124
|
#
|
|
2031
|
-
# @param credit_type_id [String]
|
|
2032
|
-
#
|
|
2033
2125
|
# @param unit_price [Float]
|
|
2034
2126
|
#
|
|
2127
|
+
# @param access_type [Symbol, MetronomeSDK::Models::V1::PackageCreateParams::RecurringCredit::AccessAmount::AccessType] Indicates how the balance of child commits is drawn down. `SPEND` deducts the do
|
|
2128
|
+
#
|
|
2129
|
+
# @param credit_type_id [String] Defaults to USD (cents) if not passed
|
|
2130
|
+
#
|
|
2035
2131
|
# @param quantity [Float] This field is required unless a subscription is attached via `subscription_confi
|
|
2132
|
+
|
|
2133
|
+
# Indicates how the balance of child commits is drawn down. `SPEND` deducts the
|
|
2134
|
+
# dollar cost of usage. `QUANTITY` deducts the number of units used.
|
|
2135
|
+
#
|
|
2136
|
+
# @see MetronomeSDK::Models::V1::PackageCreateParams::RecurringCredit::AccessAmount#access_type
|
|
2137
|
+
module AccessType
|
|
2138
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
2139
|
+
|
|
2140
|
+
SPEND = :SPEND
|
|
2141
|
+
QUANTITY = :QUANTITY
|
|
2142
|
+
|
|
2143
|
+
# @!method self.values
|
|
2144
|
+
# @return [Array<Symbol>]
|
|
2145
|
+
end
|
|
2036
2146
|
end
|
|
2037
2147
|
|
|
2038
2148
|
# @see MetronomeSDK::Models::V1::PackageCreateParams::RecurringCredit#commit_duration
|
|
@@ -3008,6 +3118,7 @@ module MetronomeSDK
|
|
|
3008
3118
|
|
|
3009
3119
|
FIRST_OF_MONTH = :FIRST_OF_MONTH
|
|
3010
3120
|
CONTRACT_START = :CONTRACT_START
|
|
3121
|
+
CUSTOM_DATE = :CUSTOM_DATE
|
|
3011
3122
|
|
|
3012
3123
|
# @!method self.values
|
|
3013
3124
|
# @return [Array<Symbol>]
|
|
@@ -370,12 +370,27 @@ module MetronomeSDK
|
|
|
370
370
|
required :schedule_items,
|
|
371
371
|
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::PackageListResponse::Commit::AccessSchedule::ScheduleItem] }
|
|
372
372
|
|
|
373
|
-
# @!
|
|
373
|
+
# @!attribute access_type
|
|
374
|
+
# Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
|
|
375
|
+
# usage. `QUANTITY` deducts the number of units used.
|
|
376
|
+
#
|
|
377
|
+
# @return [Symbol, MetronomeSDK::Models::V1::PackageListResponse::Commit::AccessSchedule::AccessType, nil]
|
|
378
|
+
optional :access_type,
|
|
379
|
+
enum: -> { MetronomeSDK::Models::V1::PackageListResponse::Commit::AccessSchedule::AccessType }
|
|
380
|
+
|
|
381
|
+
# @!method initialize(credit_type:, schedule_items:, access_type: nil)
|
|
382
|
+
# Some parameter documentations has been truncated, see
|
|
383
|
+
# {MetronomeSDK::Models::V1::PackageListResponse::Commit::AccessSchedule} for more
|
|
384
|
+
# details.
|
|
385
|
+
#
|
|
374
386
|
# The schedule that the customer will gain access to the credits purposed with
|
|
375
387
|
# this commit.
|
|
376
388
|
#
|
|
377
389
|
# @param credit_type [MetronomeSDK::Models::CreditTypeData]
|
|
390
|
+
#
|
|
378
391
|
# @param schedule_items [Array<MetronomeSDK::Models::V1::PackageListResponse::Commit::AccessSchedule::ScheduleItem>]
|
|
392
|
+
#
|
|
393
|
+
# @param access_type [Symbol, MetronomeSDK::Models::V1::PackageListResponse::Commit::AccessSchedule::AccessType] Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of usag
|
|
379
394
|
|
|
380
395
|
class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
|
|
381
396
|
# @!attribute id
|
|
@@ -468,6 +483,20 @@ module MetronomeSDK
|
|
|
468
483
|
end
|
|
469
484
|
end
|
|
470
485
|
end
|
|
486
|
+
|
|
487
|
+
# Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
|
|
488
|
+
# usage. `QUANTITY` deducts the number of units used.
|
|
489
|
+
#
|
|
490
|
+
# @see MetronomeSDK::Models::V1::PackageListResponse::Commit::AccessSchedule#access_type
|
|
491
|
+
module AccessType
|
|
492
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
493
|
+
|
|
494
|
+
SPEND = :SPEND
|
|
495
|
+
QUANTITY = :QUANTITY
|
|
496
|
+
|
|
497
|
+
# @!method self.values
|
|
498
|
+
# @return [Array<Symbol>]
|
|
499
|
+
end
|
|
471
500
|
end
|
|
472
501
|
|
|
473
502
|
# @see MetronomeSDK::Models::V1::PackageListResponse::Commit#invoice_schedule
|
|
@@ -1005,6 +1034,7 @@ module MetronomeSDK
|
|
|
1005
1034
|
|
|
1006
1035
|
FIRST_OF_MONTH = :FIRST_OF_MONTH
|
|
1007
1036
|
CONTRACT_START = :CONTRACT_START
|
|
1037
|
+
CUSTOM_DATE = :CUSTOM_DATE
|
|
1008
1038
|
|
|
1009
1039
|
# @!method self.values
|
|
1010
1040
|
# @return [Array<Symbol>]
|
|
@@ -1167,9 +1197,24 @@ module MetronomeSDK
|
|
|
1167
1197
|
required :schedule_items,
|
|
1168
1198
|
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::PackageListResponse::Credit::AccessSchedule::ScheduleItem] }
|
|
1169
1199
|
|
|
1170
|
-
# @!
|
|
1200
|
+
# @!attribute access_type
|
|
1201
|
+
# Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
|
|
1202
|
+
# usage. `QUANTITY` deducts the number of units used.
|
|
1203
|
+
#
|
|
1204
|
+
# @return [Symbol, MetronomeSDK::Models::V1::PackageListResponse::Credit::AccessSchedule::AccessType, nil]
|
|
1205
|
+
optional :access_type,
|
|
1206
|
+
enum: -> { MetronomeSDK::Models::V1::PackageListResponse::Credit::AccessSchedule::AccessType }
|
|
1207
|
+
|
|
1208
|
+
# @!method initialize(credit_type:, schedule_items:, access_type: nil)
|
|
1209
|
+
# Some parameter documentations has been truncated, see
|
|
1210
|
+
# {MetronomeSDK::Models::V1::PackageListResponse::Credit::AccessSchedule} for more
|
|
1211
|
+
# details.
|
|
1212
|
+
#
|
|
1171
1213
|
# @param credit_type [MetronomeSDK::Models::CreditTypeData]
|
|
1214
|
+
#
|
|
1172
1215
|
# @param schedule_items [Array<MetronomeSDK::Models::V1::PackageListResponse::Credit::AccessSchedule::ScheduleItem>]
|
|
1216
|
+
#
|
|
1217
|
+
# @param access_type [Symbol, MetronomeSDK::Models::V1::PackageListResponse::Credit::AccessSchedule::AccessType] Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of usag
|
|
1173
1218
|
|
|
1174
1219
|
class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
|
|
1175
1220
|
# @!attribute id
|
|
@@ -1262,6 +1307,20 @@ module MetronomeSDK
|
|
|
1262
1307
|
end
|
|
1263
1308
|
end
|
|
1264
1309
|
end
|
|
1310
|
+
|
|
1311
|
+
# Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
|
|
1312
|
+
# usage. `QUANTITY` deducts the number of units used.
|
|
1313
|
+
#
|
|
1314
|
+
# @see MetronomeSDK::Models::V1::PackageListResponse::Credit::AccessSchedule#access_type
|
|
1315
|
+
module AccessType
|
|
1316
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
1317
|
+
|
|
1318
|
+
SPEND = :SPEND
|
|
1319
|
+
QUANTITY = :QUANTITY
|
|
1320
|
+
|
|
1321
|
+
# @!method self.values
|
|
1322
|
+
# @return [Array<Symbol>]
|
|
1323
|
+
end
|
|
1265
1324
|
end
|
|
1266
1325
|
|
|
1267
1326
|
# @see MetronomeSDK::Models::V1::PackageListResponse::Credit#rate_type
|
|
@@ -1512,6 +1571,8 @@ module MetronomeSDK
|
|
|
1512
1571
|
# @see MetronomeSDK::Models::V1::PackageListResponse::RecurringCommit#access_amount
|
|
1513
1572
|
class AccessAmount < MetronomeSDK::Internal::Type::BaseModel
|
|
1514
1573
|
# @!attribute credit_type_id
|
|
1574
|
+
# This ID identifies the credit type for the access amount. Quantity-based
|
|
1575
|
+
# recurring commits and credits return the null credit type UUID.
|
|
1515
1576
|
#
|
|
1516
1577
|
# @return [String]
|
|
1517
1578
|
required :credit_type_id, String
|
|
@@ -1521,17 +1582,47 @@ module MetronomeSDK
|
|
|
1521
1582
|
# @return [Float]
|
|
1522
1583
|
required :unit_price, Float
|
|
1523
1584
|
|
|
1585
|
+
# @!attribute access_type
|
|
1586
|
+
# Indicates how the balance of child commits is drawn down. `SPEND` deducts the
|
|
1587
|
+
# dollar cost of usage. `QUANTITY` deducts the number of units used.
|
|
1588
|
+
#
|
|
1589
|
+
# @return [Symbol, MetronomeSDK::Models::V1::PackageListResponse::RecurringCommit::AccessAmount::AccessType, nil]
|
|
1590
|
+
optional :access_type,
|
|
1591
|
+
enum: -> { MetronomeSDK::Models::V1::PackageListResponse::RecurringCommit::AccessAmount::AccessType }
|
|
1592
|
+
|
|
1524
1593
|
# @!attribute quantity
|
|
1525
1594
|
#
|
|
1526
1595
|
# @return [Float, nil]
|
|
1527
1596
|
optional :quantity, Float
|
|
1528
1597
|
|
|
1529
|
-
# @!method initialize(credit_type_id:, unit_price:, quantity: nil)
|
|
1598
|
+
# @!method initialize(credit_type_id:, unit_price:, access_type: nil, quantity: nil)
|
|
1599
|
+
# Some parameter documentations has been truncated, see
|
|
1600
|
+
# {MetronomeSDK::Models::V1::PackageListResponse::RecurringCommit::AccessAmount}
|
|
1601
|
+
# for more details.
|
|
1602
|
+
#
|
|
1530
1603
|
# The amount of commit to grant.
|
|
1531
1604
|
#
|
|
1532
|
-
# @param credit_type_id [String]
|
|
1605
|
+
# @param credit_type_id [String] This ID identifies the credit type for the access amount. Quantity-based recurri
|
|
1606
|
+
#
|
|
1533
1607
|
# @param unit_price [Float]
|
|
1608
|
+
#
|
|
1609
|
+
# @param access_type [Symbol, MetronomeSDK::Models::V1::PackageListResponse::RecurringCommit::AccessAmount::AccessType] Indicates how the balance of child commits is drawn down. `SPEND` deducts the do
|
|
1610
|
+
#
|
|
1534
1611
|
# @param quantity [Float]
|
|
1612
|
+
|
|
1613
|
+
# Indicates how the balance of child commits is drawn down. `SPEND` deducts the
|
|
1614
|
+
# dollar cost of usage. `QUANTITY` deducts the number of units used.
|
|
1615
|
+
#
|
|
1616
|
+
# @see MetronomeSDK::Models::V1::PackageListResponse::RecurringCommit::AccessAmount#access_type
|
|
1617
|
+
module AccessType
|
|
1618
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
1619
|
+
|
|
1620
|
+
SPEND = :SPEND
|
|
1621
|
+
QUANTITY = :QUANTITY
|
|
1622
|
+
|
|
1623
|
+
# @!method self.values
|
|
1624
|
+
# @return [Array<Symbol>]
|
|
1625
|
+
end
|
|
1535
1626
|
end
|
|
1536
1627
|
|
|
1537
1628
|
# @see MetronomeSDK::Models::V1::PackageListResponse::RecurringCommit#commit_duration
|
|
@@ -2042,6 +2133,8 @@ module MetronomeSDK
|
|
|
2042
2133
|
# @see MetronomeSDK::Models::V1::PackageListResponse::RecurringCredit#access_amount
|
|
2043
2134
|
class AccessAmount < MetronomeSDK::Internal::Type::BaseModel
|
|
2044
2135
|
# @!attribute credit_type_id
|
|
2136
|
+
# This ID identifies the credit type for the access amount. Quantity-based
|
|
2137
|
+
# recurring commits and credits return the null credit type UUID.
|
|
2045
2138
|
#
|
|
2046
2139
|
# @return [String]
|
|
2047
2140
|
required :credit_type_id, String
|
|
@@ -2051,17 +2144,47 @@ module MetronomeSDK
|
|
|
2051
2144
|
# @return [Float]
|
|
2052
2145
|
required :unit_price, Float
|
|
2053
2146
|
|
|
2147
|
+
# @!attribute access_type
|
|
2148
|
+
# Indicates how the balance of child commits is drawn down. `SPEND` deducts the
|
|
2149
|
+
# dollar cost of usage. `QUANTITY` deducts the number of units used.
|
|
2150
|
+
#
|
|
2151
|
+
# @return [Symbol, MetronomeSDK::Models::V1::PackageListResponse::RecurringCredit::AccessAmount::AccessType, nil]
|
|
2152
|
+
optional :access_type,
|
|
2153
|
+
enum: -> { MetronomeSDK::Models::V1::PackageListResponse::RecurringCredit::AccessAmount::AccessType }
|
|
2154
|
+
|
|
2054
2155
|
# @!attribute quantity
|
|
2055
2156
|
#
|
|
2056
2157
|
# @return [Float, nil]
|
|
2057
2158
|
optional :quantity, Float
|
|
2058
2159
|
|
|
2059
|
-
# @!method initialize(credit_type_id:, unit_price:, quantity: nil)
|
|
2160
|
+
# @!method initialize(credit_type_id:, unit_price:, access_type: nil, quantity: nil)
|
|
2161
|
+
# Some parameter documentations has been truncated, see
|
|
2162
|
+
# {MetronomeSDK::Models::V1::PackageListResponse::RecurringCredit::AccessAmount}
|
|
2163
|
+
# for more details.
|
|
2164
|
+
#
|
|
2060
2165
|
# The amount of commit to grant.
|
|
2061
2166
|
#
|
|
2062
|
-
# @param credit_type_id [String]
|
|
2167
|
+
# @param credit_type_id [String] This ID identifies the credit type for the access amount. Quantity-based recurri
|
|
2168
|
+
#
|
|
2063
2169
|
# @param unit_price [Float]
|
|
2170
|
+
#
|
|
2171
|
+
# @param access_type [Symbol, MetronomeSDK::Models::V1::PackageListResponse::RecurringCredit::AccessAmount::AccessType] Indicates how the balance of child commits is drawn down. `SPEND` deducts the do
|
|
2172
|
+
#
|
|
2064
2173
|
# @param quantity [Float]
|
|
2174
|
+
|
|
2175
|
+
# Indicates how the balance of child commits is drawn down. `SPEND` deducts the
|
|
2176
|
+
# dollar cost of usage. `QUANTITY` deducts the number of units used.
|
|
2177
|
+
#
|
|
2178
|
+
# @see MetronomeSDK::Models::V1::PackageListResponse::RecurringCredit::AccessAmount#access_type
|
|
2179
|
+
module AccessType
|
|
2180
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
2181
|
+
|
|
2182
|
+
SPEND = :SPEND
|
|
2183
|
+
QUANTITY = :QUANTITY
|
|
2184
|
+
|
|
2185
|
+
# @!method self.values
|
|
2186
|
+
# @return [Array<Symbol>]
|
|
2187
|
+
end
|
|
2065
2188
|
end
|
|
2066
2189
|
|
|
2067
2190
|
# @see MetronomeSDK::Models::V1::PackageListResponse::RecurringCredit#commit_duration
|
|
@@ -2479,6 +2602,13 @@ module MetronomeSDK
|
|
|
2479
2602
|
optional :billing_cycle_config,
|
|
2480
2603
|
-> { MetronomeSDK::Models::V1::PackageListResponse::Subscription::BillingCycleConfig }
|
|
2481
2604
|
|
|
2605
|
+
# @!attribute custom_credit_type_id
|
|
2606
|
+
# If provided, the subscription's price will be in terms of this custom pricing
|
|
2607
|
+
# unit instead of the fiat currency.
|
|
2608
|
+
#
|
|
2609
|
+
# @return [String, nil]
|
|
2610
|
+
optional :custom_credit_type_id, String
|
|
2611
|
+
|
|
2482
2612
|
# @!attribute custom_fields
|
|
2483
2613
|
# Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
2484
2614
|
#
|
|
@@ -2536,7 +2666,7 @@ module MetronomeSDK
|
|
|
2536
2666
|
optional :starting_at_offset,
|
|
2537
2667
|
-> { MetronomeSDK::Models::V1::PackageListResponse::Subscription::StartingAtOffset }
|
|
2538
2668
|
|
|
2539
|
-
# @!method initialize(collection_schedule:, proration:, subscription_rate:, id: nil, billing_cycle_config: nil, custom_fields: nil, description: nil, duration: nil, fiat_credit_type_id: nil, initial_quantity: nil, name: nil, quantity_management_mode: nil, seat_config: nil, starting_at_offset: nil)
|
|
2669
|
+
# @!method initialize(collection_schedule:, proration:, subscription_rate:, id: nil, billing_cycle_config: nil, custom_credit_type_id: nil, custom_fields: nil, description: nil, duration: nil, fiat_credit_type_id: nil, initial_quantity: nil, name: nil, quantity_management_mode: nil, seat_config: nil, starting_at_offset: nil)
|
|
2540
2670
|
# Some parameter documentations has been truncated, see
|
|
2541
2671
|
# {MetronomeSDK::Models::V1::PackageListResponse::Subscription} for more details.
|
|
2542
2672
|
#
|
|
@@ -2550,6 +2680,8 @@ module MetronomeSDK
|
|
|
2550
2680
|
#
|
|
2551
2681
|
# @param billing_cycle_config [MetronomeSDK::Models::V1::PackageListResponse::Subscription::BillingCycleConfig]
|
|
2552
2682
|
#
|
|
2683
|
+
# @param custom_credit_type_id [String] If provided, the subscription's price will be in terms of this custom pricing un
|
|
2684
|
+
#
|
|
2553
2685
|
# @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
2554
2686
|
#
|
|
2555
2687
|
# @param description [String]
|