metronome-sdk 0.1.0.pre.alpha.2 → 0.1.0.pre.alpha.4
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 +85 -0
- data/README.md +120 -74
- data/SECURITY.md +2 -2
- data/lib/metronome_sdk/client.rb +4 -4
- data/lib/metronome_sdk/errors.rb +22 -0
- data/lib/metronome_sdk/internal/transport/base_client.rb +10 -2
- data/lib/metronome_sdk/internal/transport/pooled_net_requester.rb +3 -1
- data/lib/metronome_sdk/internal/type/array_of.rb +14 -1
- data/lib/metronome_sdk/internal/type/base_model.rb +92 -23
- data/lib/metronome_sdk/internal/type/boolean.rb +15 -1
- data/lib/metronome_sdk/internal/type/converter.rb +42 -34
- data/lib/metronome_sdk/internal/type/enum.rb +25 -2
- data/lib/metronome_sdk/internal/type/file_input.rb +13 -1
- data/lib/metronome_sdk/internal/type/hash_of.rb +14 -1
- data/lib/metronome_sdk/internal/type/union.rb +27 -7
- data/lib/metronome_sdk/internal/type/unknown.rb +15 -1
- data/lib/metronome_sdk/internal/util.rb +62 -10
- data/lib/metronome_sdk/internal.rb +3 -0
- data/lib/metronome_sdk/models/commit.rb +230 -87
- data/lib/metronome_sdk/models/contract_without_amendments.rb +551 -185
- data/lib/metronome_sdk/models/credit.rb +201 -51
- data/lib/metronome_sdk/models/discount.rb +5 -5
- data/lib/metronome_sdk/models/event_type_filter.rb +1 -1
- data/lib/metronome_sdk/models/override.rb +53 -34
- data/lib/metronome_sdk/models/pro_service.rb +2 -2
- data/lib/metronome_sdk/models/property_filter.rb +1 -1
- data/lib/metronome_sdk/models/rate.rb +9 -9
- data/lib/metronome_sdk/models/schedule_duration.rb +4 -4
- data/lib/metronome_sdk/models/schedule_point_in_time.rb +11 -11
- data/lib/metronome_sdk/models/scheduled_charge.rb +5 -5
- data/lib/metronome_sdk/models/v1/alert_archive_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/alert_create_params.rb +15 -12
- data/lib/metronome_sdk/models/v1/alert_create_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/audit_log_list_params.rb +2 -2
- data/lib/metronome_sdk/models/v1/billable_metric_archive_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/billable_metric_create_params.rb +6 -6
- data/lib/metronome_sdk/models/v1/billable_metric_create_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/billable_metric_list_response.rb +4 -4
- data/lib/metronome_sdk/models/v1/billable_metric_retrieve_response.rb +4 -4
- data/lib/metronome_sdk/models/v1/contract_amend_params.rb +577 -152
- data/lib/metronome_sdk/models/v1/contract_amend_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/contract_archive_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/contract_create_historical_invoices_params.rb +12 -12
- data/lib/metronome_sdk/models/v1/contract_create_historical_invoices_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/contract_create_params.rb +1317 -341
- data/lib/metronome_sdk/models/v1/contract_create_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/contract_list_balances_response.rb +3 -7
- data/lib/metronome_sdk/models/v1/contract_list_response.rb +421 -36
- data/lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rb +33 -5
- data/lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rb +28 -7
- data/lib/metronome_sdk/models/v1/contract_retrieve_response.rb +422 -36
- data/lib/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_params.rb +34 -0
- data/lib/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_response.rb +81 -0
- data/lib/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_params.rb +4 -4
- data/lib/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/contract_update_end_date_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/contracts/product_archive_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/contracts/product_create_params.rb +6 -6
- data/lib/metronome_sdk/models/v1/contracts/product_create_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/contracts/product_list_item_state.rb +5 -5
- data/lib/metronome_sdk/models/v1/contracts/product_list_params.rb +4 -4
- data/lib/metronome_sdk/models/v1/contracts/product_list_response.rb +8 -8
- data/lib/metronome_sdk/models/v1/contracts/product_retrieve_response.rb +8 -8
- data/lib/metronome_sdk/models/v1/contracts/product_update_params.rb +4 -4
- data/lib/metronome_sdk/models/v1/contracts/product_update_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/contracts/quantity_conversion.rb +3 -3
- data/lib/metronome_sdk/models/v1/contracts/quantity_rounding.rb +3 -3
- data/lib/metronome_sdk/models/v1/contracts/rate_card_archive_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/contracts/rate_card_create_params.rb +4 -4
- data/lib/metronome_sdk/models/v1/contracts/rate_card_create_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/contracts/rate_card_list_response.rb +4 -4
- data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rb +33 -5
- data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rb +26 -5
- data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rb +4 -4
- data/lib/metronome_sdk/models/v1/contracts/rate_card_update_params.rb +2 -2
- data/lib/metronome_sdk/models/v1/contracts/rate_card_update_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_params.rb +2 -2
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rb +46 -18
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb +36 -12
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rb +6 -6
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_params.rb +33 -5
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rb +26 -5
- data/lib/metronome_sdk/models/v1/credit_grant_create_params.rb +12 -20
- data/lib/metronome_sdk/models/v1/credit_grant_create_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/credit_grant_edit_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/credit_grant_list_entries_params.rb +20 -1
- data/lib/metronome_sdk/models/v1/credit_grant_list_entries_response.rb +6 -6
- data/lib/metronome_sdk/models/v1/credit_grant_list_response.rb +8 -8
- data/lib/metronome_sdk/models/v1/credit_grant_void_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/credit_ledger_entry.rb +1 -1
- data/lib/metronome_sdk/models/v1/custom_field_add_key_params.rb +2 -2
- data/lib/metronome_sdk/models/v1/custom_field_delete_values_params.rb +2 -2
- data/lib/metronome_sdk/models/v1/custom_field_list_keys_params.rb +2 -2
- data/lib/metronome_sdk/models/v1/custom_field_remove_key_params.rb +2 -2
- data/lib/metronome_sdk/models/v1/custom_field_set_values_params.rb +2 -2
- data/lib/metronome_sdk/models/v1/customer.rb +1 -1
- data/lib/metronome_sdk/models/v1/customer_archive_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/customer_create_params.rb +20 -20
- data/lib/metronome_sdk/models/v1/customer_create_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/customer_detail.rb +10 -10
- data/lib/metronome_sdk/models/v1/customer_list_billable_metrics_response.rb +4 -4
- data/lib/metronome_sdk/models/v1/customer_preview_events_params.rb +115 -0
- data/lib/metronome_sdk/models/v1/customer_preview_events_response.rb +18 -0
- data/lib/metronome_sdk/models/v1/customer_retrieve_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/customer_set_name_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/customers/alert_list_params.rb +2 -2
- data/lib/metronome_sdk/models/v1/customers/alert_list_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/customers/alert_retrieve_params.rb +2 -2
- data/lib/metronome_sdk/models/v1/customers/alert_retrieve_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/customers/billing_config_create_params.rb +6 -6
- data/lib/metronome_sdk/models/v1/customers/billing_config_delete_params.rb +2 -2
- data/lib/metronome_sdk/models/v1/customers/billing_config_retrieve_params.rb +2 -2
- data/lib/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rb +9 -1
- data/lib/metronome_sdk/models/v1/customers/commit_create_params.rb +86 -32
- data/lib/metronome_sdk/models/v1/customers/commit_create_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/customers/commit_list_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/customers/commit_update_end_date_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/customers/credit_create_params.rb +59 -7
- data/lib/metronome_sdk/models/v1/customers/credit_create_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/customers/credit_list_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/customers/credit_update_end_date_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/customers/customer_alert.rb +24 -24
- data/lib/metronome_sdk/models/v1/customers/invoice.rb +74 -73
- data/lib/metronome_sdk/models/v1/customers/invoice_list_breakdowns_params.rb +4 -4
- data/lib/metronome_sdk/models/v1/customers/invoice_list_params.rb +2 -2
- data/lib/metronome_sdk/models/v1/customers/invoice_retrieve_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/customers/plan_add_params.rb +16 -15
- data/lib/metronome_sdk/models/v1/customers/plan_add_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/customers/plan_list_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rb +14 -13
- data/lib/metronome_sdk/models/v1/plan_detail.rb +18 -18
- data/lib/metronome_sdk/models/v1/plan_get_details_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/plan_list_charges_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/plan_list_customers_params.rb +2 -2
- data/lib/metronome_sdk/models/v1/plan_list_customers_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/rollover_amount_max_amount.rb +3 -3
- data/lib/metronome_sdk/models/v1/rollover_amount_max_percentage.rb +3 -3
- data/lib/metronome_sdk/models/v1/usage_ingest_params.rb +2 -2
- data/lib/metronome_sdk/models/v1/usage_list_params.rb +9 -8
- data/lib/metronome_sdk/models/v1/usage_list_with_groups_params.rb +5 -5
- data/lib/metronome_sdk/models/v1/usage_search_params.rb +24 -0
- data/lib/metronome_sdk/models/v1/usage_search_response.rb +249 -0
- data/lib/metronome_sdk/models/v2/contract_edit_commit_params.rb +78 -23
- data/lib/metronome_sdk/models/v2/contract_edit_commit_response.rb +2 -2
- data/lib/metronome_sdk/models/v2/contract_edit_credit_params.rb +62 -9
- data/lib/metronome_sdk/models/v2/contract_edit_credit_response.rb +2 -2
- data/lib/metronome_sdk/models/v2/contract_edit_params.rb +1995 -443
- data/lib/metronome_sdk/models/v2/contract_edit_response.rb +2 -2
- data/lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb +1959 -140
- data/lib/metronome_sdk/models/v2/contract_list_response.rb +963 -91
- data/lib/metronome_sdk/models/v2/contract_retrieve_response.rb +964 -91
- data/lib/metronome_sdk/models.rb +30 -19
- data/lib/metronome_sdk/resources/v1/alerts.rb +4 -4
- data/lib/metronome_sdk/resources/v1/audit_logs.rb +1 -1
- data/lib/metronome_sdk/resources/v1/billable_metrics.rb +3 -3
- data/lib/metronome_sdk/resources/v1/contracts/products.rb +9 -6
- data/lib/metronome_sdk/resources/v1/contracts/rate_cards/product_orders.rb +1 -1
- data/lib/metronome_sdk/resources/v1/contracts/rate_cards/rates.rb +8 -6
- data/lib/metronome_sdk/resources/v1/contracts/rate_cards.rb +4 -4
- data/lib/metronome_sdk/resources/v1/contracts.rb +59 -28
- data/lib/metronome_sdk/resources/v1/credit_grants.rb +7 -5
- data/lib/metronome_sdk/resources/v1/custom_fields.rb +5 -5
- data/lib/metronome_sdk/resources/v1/customers/alerts.rb +2 -2
- data/lib/metronome_sdk/resources/v1/customers/billing_config.rb +5 -5
- data/lib/metronome_sdk/resources/v1/customers/commits.rb +9 -7
- data/lib/metronome_sdk/resources/v1/customers/credits.rb +5 -3
- data/lib/metronome_sdk/resources/v1/customers/invoices.rb +4 -4
- data/lib/metronome_sdk/resources/v1/customers/plans.rb +3 -3
- data/lib/metronome_sdk/resources/v1/customers.rb +43 -4
- data/lib/metronome_sdk/resources/v1/dashboards.rb +4 -4
- data/lib/metronome_sdk/resources/v1/plans.rb +1 -1
- data/lib/metronome_sdk/resources/v1/usage.rb +30 -5
- data/lib/metronome_sdk/resources/v2/contracts.rb +45 -31
- data/lib/metronome_sdk/version.rb +1 -1
- data/lib/metronome_sdk.rb +9 -1
- data/rbi/metronome_sdk/errors.rbi +16 -0
- data/rbi/metronome_sdk/internal/transport/pooled_net_requester.rbi +5 -1
- data/rbi/metronome_sdk/internal/type/array_of.rbi +6 -0
- data/rbi/metronome_sdk/internal/type/base_model.rbi +5 -0
- data/rbi/metronome_sdk/internal/type/boolean.rbi +8 -0
- data/rbi/metronome_sdk/internal/type/converter.rbi +15 -15
- data/rbi/metronome_sdk/internal/type/enum.rbi +5 -0
- data/rbi/metronome_sdk/internal/type/file_input.rbi +5 -0
- data/rbi/metronome_sdk/internal/type/hash_of.rbi +6 -0
- data/rbi/metronome_sdk/internal/type/union.rbi +10 -0
- data/rbi/metronome_sdk/internal/type/unknown.rbi +8 -0
- data/rbi/metronome_sdk/internal/util.rbi +36 -0
- data/rbi/metronome_sdk/internal.rbi +5 -0
- data/rbi/metronome_sdk/models/commit.rbi +376 -39
- data/rbi/metronome_sdk/models/contract_without_amendments.rbi +791 -54
- data/rbi/metronome_sdk/models/credit.rbi +376 -25
- data/rbi/metronome_sdk/models/override.rbi +66 -0
- data/rbi/metronome_sdk/models/schedule_point_in_time.rbi +9 -9
- data/rbi/metronome_sdk/models/v1/alert_create_params.rbi +10 -4
- data/rbi/metronome_sdk/models/v1/contract_amend_params.rbi +995 -17
- data/rbi/metronome_sdk/models/v1/contract_create_params.rbi +2220 -136
- data/rbi/metronome_sdk/models/v1/contract_list_balances_response.rbi +9 -2
- data/rbi/metronome_sdk/models/v1/contract_list_response.rbi +820 -28
- data/rbi/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rbi +72 -0
- data/rbi/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rbi +66 -0
- data/rbi/metronome_sdk/models/v1/contract_retrieve_response.rbi +820 -28
- data/rbi/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_params.rbi +58 -0
- data/rbi/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_response.rbi +212 -0
- data/rbi/metronome_sdk/models/v1/contracts/product_list_params.rbi +3 -3
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rbi +72 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rbi +66 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rbi +72 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbi +72 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_list_params.rbi +72 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rbi +66 -0
- data/rbi/metronome_sdk/models/v1/credit_grant_list_entries_params.rbi +58 -0
- data/rbi/metronome_sdk/models/v1/customer_preview_events_params.rbi +214 -0
- data/rbi/metronome_sdk/models/v1/customer_preview_events_response.rbi +35 -0
- data/rbi/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbi +11 -0
- data/rbi/metronome_sdk/models/v1/customers/commit_create_params.rbi +121 -8
- data/rbi/metronome_sdk/models/v1/customers/credit_create_params.rbi +109 -0
- data/rbi/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rbi +5 -0
- data/rbi/metronome_sdk/models/v1/usage_search_params.rbi +48 -0
- data/rbi/metronome_sdk/models/v1/usage_search_response.rbi +438 -0
- data/rbi/metronome_sdk/models/v2/contract_edit_commit_params.rbi +113 -8
- data/rbi/metronome_sdk/models/v2/contract_edit_credit_params.rbi +101 -0
- data/rbi/metronome_sdk/models/v2/contract_edit_params.rbi +3667 -315
- data/rbi/metronome_sdk/models/v2/contract_get_edit_history_response.rbi +5965 -2014
- data/rbi/metronome_sdk/models/v2/contract_list_response.rbi +2279 -226
- data/rbi/metronome_sdk/models/v2/contract_retrieve_response.rbi +2279 -226
- data/rbi/metronome_sdk/resources/v1/alerts.rbi +5 -2
- data/rbi/metronome_sdk/resources/v1/contracts/products.rbi +2 -1
- data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbi +5 -0
- data/rbi/metronome_sdk/resources/v1/contracts.rbi +36 -1
- data/rbi/metronome_sdk/resources/v1/credit_grants.rbi +4 -0
- data/rbi/metronome_sdk/resources/v1/customers/commits.rbi +15 -4
- data/rbi/metronome_sdk/resources/v1/customers/credits.rbi +9 -0
- data/rbi/metronome_sdk/resources/v1/customers.rbi +35 -1
- data/rbi/metronome_sdk/resources/v1/usage.rbi +17 -0
- data/rbi/metronome_sdk/resources/v2/contracts.rbi +65 -7
- data/sig/metronome_sdk/errors.rbs +9 -0
- data/sig/metronome_sdk/internal/transport/pooled_net_requester.rbs +2 -0
- data/sig/metronome_sdk/internal/type/array_of.rbs +3 -0
- data/sig/metronome_sdk/internal/type/base_model.rbs +2 -0
- data/sig/metronome_sdk/internal/type/boolean.rbs +3 -0
- data/sig/metronome_sdk/internal/type/converter.rbs +7 -1
- data/sig/metronome_sdk/internal/type/enum.rbs +2 -0
- data/sig/metronome_sdk/internal/type/file_input.rbs +2 -0
- data/sig/metronome_sdk/internal/type/hash_of.rbs +3 -0
- data/sig/metronome_sdk/internal/type/union.rbs +2 -0
- data/sig/metronome_sdk/internal/type/unknown.rbs +3 -0
- data/sig/metronome_sdk/internal/util.rbs +12 -0
- data/sig/metronome_sdk/internal.rbs +2 -0
- data/sig/metronome_sdk/models/base_usage_filter.rbs +6 -0
- data/sig/metronome_sdk/models/commit.rbs +374 -68
- data/sig/metronome_sdk/models/contract_without_amendments.rbs +620 -110
- data/sig/metronome_sdk/models/credit.rbs +286 -40
- data/sig/metronome_sdk/models/credit_type_data.rbs +2 -0
- data/sig/metronome_sdk/models/discount.rbs +11 -0
- data/sig/metronome_sdk/models/event_type_filter.rbs +5 -0
- data/sig/metronome_sdk/models/id.rbs +2 -0
- data/sig/metronome_sdk/models/override.rbs +92 -22
- data/sig/metronome_sdk/models/pro_service.rbs +11 -0
- data/sig/metronome_sdk/models/property_filter.rbs +7 -0
- data/sig/metronome_sdk/models/rate.rbs +16 -4
- data/sig/metronome_sdk/models/schedule_duration.rbs +12 -0
- data/sig/metronome_sdk/models/schedule_point_in_time.rbs +20 -6
- data/sig/metronome_sdk/models/scheduled_charge.rbs +12 -0
- data/sig/metronome_sdk/models/tier.rbs +2 -0
- data/sig/metronome_sdk/models/v1/alert_archive_params.rbs +6 -0
- data/sig/metronome_sdk/models/v1/alert_archive_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/alert_create_params.rbs +29 -4
- data/sig/metronome_sdk/models/v1/alert_create_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/audit_log_list_params.rbs +11 -0
- data/sig/metronome_sdk/models/v1/audit_log_list_response.rbs +16 -0
- data/sig/metronome_sdk/models/v1/billable_metric_archive_params.rbs +2 -0
- data/sig/metronome_sdk/models/v1/billable_metric_archive_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/billable_metric_create_params.rbs +12 -0
- data/sig/metronome_sdk/models/v1/billable_metric_create_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/billable_metric_list_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/billable_metric_list_response.rbs +13 -0
- data/sig/metronome_sdk/models/v1/billable_metric_retrieve_params.rbs +5 -0
- data/sig/metronome_sdk/models/v1/billable_metric_retrieve_response.rbs +17 -0
- data/sig/metronome_sdk/models/v1/contract_add_manual_balance_entry_params.rbs +11 -0
- data/sig/metronome_sdk/models/v1/contract_amend_params.rbs +719 -75
- data/sig/metronome_sdk/models/v1/contract_amend_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contract_archive_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/contract_archive_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contract_create_historical_invoices_params.rbs +47 -12
- data/sig/metronome_sdk/models/v1/contract_create_historical_invoices_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contract_create_params.rbs +1503 -250
- data/sig/metronome_sdk/models/v1/contract_create_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contract_list_balances_params.rbs +14 -0
- data/sig/metronome_sdk/models/v1/contract_list_balances_response.rbs +5 -0
- data/sig/metronome_sdk/models/v1/contract_list_params.rbs +10 -0
- data/sig/metronome_sdk/models/v1/contract_list_response.rbs +459 -10
- data/sig/metronome_sdk/models/v1/contract_retrieve_params.rbs +8 -0
- data/sig/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rbs +39 -0
- data/sig/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rbs +48 -0
- data/sig/metronome_sdk/models/v1/contract_retrieve_response.rbs +459 -10
- data/sig/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_params.rbs +34 -0
- data/sig/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_response.rbs +101 -0
- data/sig/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_params.rbs +21 -0
- data/sig/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contract_set_usage_filter_params.rbs +9 -0
- data/sig/metronome_sdk/models/v1/contract_update_end_date_params.rbs +8 -0
- data/sig/metronome_sdk/models/v1/contract_update_end_date_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contracts/named_schedule_retrieve_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/contracts/named_schedule_retrieve_response.rbs +10 -0
- data/sig/metronome_sdk/models/v1/contracts/named_schedule_update_params.rbs +9 -0
- data/sig/metronome_sdk/models/v1/contracts/product_archive_params.rbs +5 -0
- data/sig/metronome_sdk/models/v1/contracts/product_archive_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contracts/product_create_params.rbs +18 -0
- data/sig/metronome_sdk/models/v1/contracts/product_create_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contracts/product_list_item_state.rbs +19 -0
- data/sig/metronome_sdk/models/v1/contracts/product_list_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/contracts/product_list_response.rbs +29 -0
- data/sig/metronome_sdk/models/v1/contracts/product_retrieve_params.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contracts/product_retrieve_response.rbs +33 -0
- data/sig/metronome_sdk/models/v1/contracts/product_update_params.rbs +19 -0
- data/sig/metronome_sdk/models/v1/contracts/product_update_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contracts/quantity_conversion.rbs +10 -4
- data/sig/metronome_sdk/models/v1/contracts/quantity_rounding.rbs +9 -4
- data/sig/metronome_sdk/models/v1/contracts/rate_card_archive_params.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_archive_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_create_params.rbs +21 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_create_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_list_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_list_response.rbs +23 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_params.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rbs +38 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rbs +46 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rbs +27 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_update_params.rbs +14 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_update_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_params.rbs +8 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_response.rbs +10 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_update_params.rbs +10 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_params.rbs +6 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_params.rbs +8 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rbs +59 -8
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbs +51 -4
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rbs +23 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_list_params.rbs +38 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rbs +41 -0
- data/sig/metronome_sdk/models/v1/credit_grant_create_params.rbs +32 -4
- data/sig/metronome_sdk/models/v1/credit_grant_create_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/credit_grant_edit_params.rbs +8 -0
- data/sig/metronome_sdk/models/v1/credit_grant_edit_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/credit_grant_list_entries_params.rbs +29 -0
- data/sig/metronome_sdk/models/v1/credit_grant_list_entries_response.rbs +30 -0
- data/sig/metronome_sdk/models/v1/credit_grant_list_params.rbs +11 -0
- data/sig/metronome_sdk/models/v1/credit_grant_list_response.rbs +38 -0
- data/sig/metronome_sdk/models/v1/credit_grant_void_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/credit_grant_void_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/credit_ledger_entry.rbs +10 -0
- data/sig/metronome_sdk/models/v1/custom_field_add_key_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/custom_field_delete_values_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/custom_field_list_keys_params.rbs +12 -6
- data/sig/metronome_sdk/models/v1/custom_field_list_keys_response.rbs +11 -0
- data/sig/metronome_sdk/models/v1/custom_field_remove_key_params.rbs +6 -0
- data/sig/metronome_sdk/models/v1/custom_field_set_values_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/customer.rbs +8 -0
- data/sig/metronome_sdk/models/v1/customer_archive_params.rbs +2 -0
- data/sig/metronome_sdk/models/v1/customer_archive_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/customer_create_params.rbs +52 -26
- data/sig/metronome_sdk/models/v1/customer_create_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/customer_detail.rbs +23 -4
- data/sig/metronome_sdk/models/v1/customer_list_billable_metrics_params.rbs +9 -0
- data/sig/metronome_sdk/models/v1/customer_list_billable_metrics_response.rbs +17 -0
- data/sig/metronome_sdk/models/v1/customer_list_costs_params.rbs +9 -0
- data/sig/metronome_sdk/models/v1/customer_list_costs_response.rbs +19 -0
- data/sig/metronome_sdk/models/v1/customer_list_params.rbs +10 -0
- data/sig/metronome_sdk/models/v1/customer_preview_events_params.rbs +105 -0
- data/sig/metronome_sdk/models/v1/customer_preview_events_response.rbs +16 -0
- data/sig/metronome_sdk/models/v1/customer_retrieve_params.rbs +5 -0
- data/sig/metronome_sdk/models/v1/customer_retrieve_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/customer_set_ingest_aliases_params.rbs +6 -0
- data/sig/metronome_sdk/models/v1/customer_set_name_params.rbs +6 -0
- data/sig/metronome_sdk/models/v1/customer_set_name_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/customer_update_config_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/customers/alert_list_params.rbs +13 -6
- data/sig/metronome_sdk/models/v1/customers/alert_list_response.rbs +5 -0
- data/sig/metronome_sdk/models/v1/customers/alert_reset_params.rbs +6 -0
- data/sig/metronome_sdk/models/v1/customers/alert_retrieve_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/customers/alert_retrieve_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/customers/billing_config_create_params.rbs +10 -0
- data/sig/metronome_sdk/models/v1/customers/billing_config_delete_params.rbs +6 -0
- data/sig/metronome_sdk/models/v1/customers/billing_config_retrieve_params.rbs +6 -0
- data/sig/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbs +23 -0
- data/sig/metronome_sdk/models/v1/customers/commit_create_params.rbs +116 -8
- data/sig/metronome_sdk/models/v1/customers/commit_create_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/customers/commit_list_params.rbs +14 -0
- data/sig/metronome_sdk/models/v1/customers/commit_list_response.rbs +5 -0
- data/sig/metronome_sdk/models/v1/customers/commit_update_end_date_params.rbs +8 -0
- data/sig/metronome_sdk/models/v1/customers/commit_update_end_date_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/customers/credit_create_params.rbs +82 -0
- data/sig/metronome_sdk/models/v1/customers/credit_create_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/customers/credit_list_params.rbs +14 -0
- data/sig/metronome_sdk/models/v1/customers/credit_list_response.rbs +5 -0
- data/sig/metronome_sdk/models/v1/customers/credit_update_end_date_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/customers/credit_update_end_date_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/customers/customer_alert.rbs +45 -16
- data/sig/metronome_sdk/models/v1/customers/invoice.rbs +195 -40
- data/sig/metronome_sdk/models/v1/customers/invoice_add_charge_params.rbs +11 -0
- data/sig/metronome_sdk/models/v1/customers/invoice_add_charge_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/customers/invoice_list_breakdowns_params.rbs +14 -0
- data/sig/metronome_sdk/models/v1/customers/invoice_list_breakdowns_response.rbs +5 -0
- data/sig/metronome_sdk/models/v1/customers/invoice_list_params.rbs +13 -0
- data/sig/metronome_sdk/models/v1/customers/invoice_retrieve_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/customers/invoice_retrieve_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/customers/named_schedule_retrieve_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/customers/named_schedule_retrieve_response.rbs +10 -0
- data/sig/metronome_sdk/models/v1/customers/named_schedule_update_params.rbs +9 -0
- data/sig/metronome_sdk/models/v1/customers/plan_add_params.rbs +38 -4
- data/sig/metronome_sdk/models/v1/customers/plan_add_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/customers/plan_end_params.rbs +9 -0
- data/sig/metronome_sdk/models/v1/customers/plan_end_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/customers/plan_list_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/customers/plan_list_price_adjustments_params.rbs +8 -0
- data/sig/metronome_sdk/models/v1/customers/plan_list_price_adjustments_response.rbs +14 -0
- data/sig/metronome_sdk/models/v1/customers/plan_list_response.rbs +23 -0
- data/sig/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rbs +30 -7
- data/sig/metronome_sdk/models/v1/dashboard_get_embeddable_url_response.rbs +6 -0
- data/sig/metronome_sdk/models/v1/invoice_regenerate_params.rbs +5 -0
- data/sig/metronome_sdk/models/v1/invoice_regenerate_response.rbs +6 -0
- data/sig/metronome_sdk/models/v1/invoice_void_params.rbs +5 -0
- data/sig/metronome_sdk/models/v1/invoice_void_response.rbs +6 -0
- data/sig/metronome_sdk/models/v1/plan_detail.rbs +38 -0
- data/sig/metronome_sdk/models/v1/plan_get_details_params.rbs +5 -0
- data/sig/metronome_sdk/models/v1/plan_get_details_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/plan_list_charges_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/plan_list_charges_response.rbs +28 -0
- data/sig/metronome_sdk/models/v1/plan_list_customers_params.rbs +8 -0
- data/sig/metronome_sdk/models/v1/plan_list_customers_response.rbs +14 -0
- data/sig/metronome_sdk/models/v1/plan_list_params.rbs +6 -0
- data/sig/metronome_sdk/models/v1/plan_list_response.rbs +7 -0
- data/sig/metronome_sdk/models/v1/pricing_unit_list_params.rbs +6 -0
- data/sig/metronome_sdk/models/v1/pricing_unit_list_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/rollover_amount_max_amount.rbs +12 -4
- data/sig/metronome_sdk/models/v1/rollover_amount_max_percentage.rbs +9 -4
- data/sig/metronome_sdk/models/v1/service_list_params.rbs +2 -0
- data/sig/metronome_sdk/models/v1/service_list_response.rbs +10 -0
- data/sig/metronome_sdk/models/v1/usage_ingest_params.rbs +13 -0
- data/sig/metronome_sdk/models/v1/usage_list_params.rbs +17 -0
- data/sig/metronome_sdk/models/v1/usage_list_response.rbs +15 -0
- data/sig/metronome_sdk/models/v1/usage_list_with_groups_params.rbs +15 -0
- data/sig/metronome_sdk/models/v1/usage_list_with_groups_response.rbs +8 -0
- data/sig/metronome_sdk/models/v1/usage_search_params.rbs +26 -0
- data/sig/metronome_sdk/models/v1/usage_search_response.rbs +230 -0
- data/sig/metronome_sdk/models/v2/contract_edit_commit_params.rbs +106 -1
- data/sig/metronome_sdk/models/v2/contract_edit_commit_response.rbs +2 -0
- data/sig/metronome_sdk/models/v2/contract_edit_credit_params.rbs +81 -1
- data/sig/metronome_sdk/models/v2/contract_edit_credit_response.rbs +2 -0
- data/sig/metronome_sdk/models/v2/contract_edit_params.rbs +2233 -303
- data/sig/metronome_sdk/models/v2/contract_edit_response.rbs +2 -0
- data/sig/metronome_sdk/models/v2/contract_get_edit_history_params.rbs +6 -0
- data/sig/metronome_sdk/models/v2/contract_get_edit_history_response.rbs +2475 -453
- data/sig/metronome_sdk/models/v2/contract_list_params.rbs +10 -0
- data/sig/metronome_sdk/models/v2/contract_list_response.rbs +1400 -43
- data/sig/metronome_sdk/models/v2/contract_retrieve_params.rbs +9 -0
- data/sig/metronome_sdk/models/v2/contract_retrieve_response.rbs +1400 -43
- data/sig/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbs +1 -0
- data/sig/metronome_sdk/resources/v1/contracts.rbs +10 -0
- data/sig/metronome_sdk/resources/v1/credit_grants.rbs +1 -0
- data/sig/metronome_sdk/resources/v1/custom_fields.rbs +1 -1
- data/sig/metronome_sdk/resources/v1/customers/alerts.rbs +1 -1
- data/sig/metronome_sdk/resources/v1/customers/commits.rbs +1 -0
- data/sig/metronome_sdk/resources/v1/customers/credits.rbs +1 -0
- data/sig/metronome_sdk/resources/v1/customers.rbs +8 -0
- data/sig/metronome_sdk/resources/v1/usage.rbs +5 -0
- data/sig/metronome_sdk/resources/v2/contracts.rbs +8 -1
- metadata +20 -2
@@ -44,7 +44,7 @@ module MetronomeSDK
|
|
44
44
|
# An optional list of overage rates that override the rates of the original plan
|
45
45
|
# configuration. These new rates will apply to all pricing ramps.
|
46
46
|
#
|
47
|
-
# @return [Array<MetronomeSDK::V1::Customers::PlanAddParams::OverageRateAdjustment>, nil]
|
47
|
+
# @return [Array<MetronomeSDK::Models::V1::Customers::PlanAddParams::OverageRateAdjustment>, nil]
|
48
48
|
optional :overage_rate_adjustments,
|
49
49
|
-> {
|
50
50
|
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::PlanAddParams::OverageRateAdjustment]
|
@@ -56,7 +56,7 @@ module MetronomeSDK
|
|
56
56
|
# [price adjustments documentation](https://plans-docs.metronome.com/pricing/managing-plans/#price-adjustments)
|
57
57
|
# for details.
|
58
58
|
#
|
59
|
-
# @return [Array<MetronomeSDK::V1::Customers::PlanAddParams::PriceAdjustment>, nil]
|
59
|
+
# @return [Array<MetronomeSDK::Models::V1::Customers::PlanAddParams::PriceAdjustment>, nil]
|
60
60
|
optional :price_adjustments,
|
61
61
|
-> {
|
62
62
|
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::PlanAddParams::PriceAdjustment]
|
@@ -67,7 +67,7 @@ module MetronomeSDK
|
|
67
67
|
# [trial configuration documentation](https://docs.metronome.com/provisioning/configure-trials/)
|
68
68
|
# for details.
|
69
69
|
#
|
70
|
-
# @return [MetronomeSDK::V1::Customers::PlanAddParams::TrialSpec, nil]
|
70
|
+
# @return [MetronomeSDK::Models::V1::Customers::PlanAddParams::TrialSpec, nil]
|
71
71
|
optional :trial_spec, -> { MetronomeSDK::V1::Customers::PlanAddParams::TrialSpec }
|
72
72
|
|
73
73
|
# @!method initialize(customer_id:, plan_id:, starting_on:, ending_before: nil, net_payment_terms_days: nil, overage_rate_adjustments: nil, price_adjustments: nil, trial_spec: nil, request_options: {})
|
@@ -84,11 +84,11 @@ module MetronomeSDK
|
|
84
84
|
#
|
85
85
|
# @param net_payment_terms_days [Float] Number of days after issuance of invoice after which the invoice is due (e.g. Ne
|
86
86
|
#
|
87
|
-
# @param overage_rate_adjustments [Array<MetronomeSDK::V1::Customers::PlanAddParams::OverageRateAdjustment>] An optional list of overage rates that override the rates of the original plan c
|
87
|
+
# @param overage_rate_adjustments [Array<MetronomeSDK::Models::V1::Customers::PlanAddParams::OverageRateAdjustment>] An optional list of overage rates that override the rates of the original plan c
|
88
88
|
#
|
89
|
-
# @param price_adjustments [Array<MetronomeSDK::V1::Customers::PlanAddParams::PriceAdjustment>] A list of price adjustments can be applied on top of the pricing in the plans. S
|
89
|
+
# @param price_adjustments [Array<MetronomeSDK::Models::V1::Customers::PlanAddParams::PriceAdjustment>] A list of price adjustments can be applied on top of the pricing in the plans. S
|
90
90
|
#
|
91
|
-
# @param trial_spec [MetronomeSDK::V1::Customers::PlanAddParams::TrialSpec] A custom trial can be set for the customer's plan. See the [trial configuration
|
91
|
+
# @param trial_spec [MetronomeSDK::Models::V1::Customers::PlanAddParams::TrialSpec] A custom trial can be set for the customer's plan. See the [trial configuration
|
92
92
|
#
|
93
93
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
|
94
94
|
|
@@ -120,7 +120,7 @@ module MetronomeSDK
|
|
120
120
|
class PriceAdjustment < MetronomeSDK::Internal::Type::BaseModel
|
121
121
|
# @!attribute adjustment_type
|
122
122
|
#
|
123
|
-
# @return [Symbol, MetronomeSDK::V1::Customers::PlanAddParams::PriceAdjustment::AdjustmentType]
|
123
|
+
# @return [Symbol, MetronomeSDK::Models::V1::Customers::PlanAddParams::PriceAdjustment::AdjustmentType]
|
124
124
|
required :adjustment_type,
|
125
125
|
enum: -> { MetronomeSDK::V1::Customers::PlanAddParams::PriceAdjustment::AdjustmentType }
|
126
126
|
|
@@ -158,9 +158,10 @@ module MetronomeSDK
|
|
158
158
|
|
159
159
|
# @!method initialize(adjustment_type:, charge_id:, start_period:, quantity: nil, tier: nil, value: nil)
|
160
160
|
# Some parameter documentations has been truncated, see
|
161
|
-
# {MetronomeSDK::V1::Customers::PlanAddParams::PriceAdjustment} for more
|
161
|
+
# {MetronomeSDK::Models::V1::Customers::PlanAddParams::PriceAdjustment} for more
|
162
|
+
# details.
|
162
163
|
#
|
163
|
-
# @param adjustment_type [Symbol, MetronomeSDK::V1::Customers::PlanAddParams::PriceAdjustment::AdjustmentType]
|
164
|
+
# @param adjustment_type [Symbol, MetronomeSDK::Models::V1::Customers::PlanAddParams::PriceAdjustment::AdjustmentType]
|
164
165
|
#
|
165
166
|
# @param charge_id [String]
|
166
167
|
#
|
@@ -172,7 +173,7 @@ module MetronomeSDK
|
|
172
173
|
#
|
173
174
|
# @param value [Float] The amount of change to a price. Percentage and fixed adjustments can be positiv
|
174
175
|
|
175
|
-
# @see MetronomeSDK::V1::Customers::PlanAddParams::PriceAdjustment#adjustment_type
|
176
|
+
# @see MetronomeSDK::Models::V1::Customers::PlanAddParams::PriceAdjustment#adjustment_type
|
176
177
|
module AdjustmentType
|
177
178
|
extend MetronomeSDK::Internal::Type::Enum
|
178
179
|
|
@@ -195,7 +196,7 @@ module MetronomeSDK
|
|
195
196
|
|
196
197
|
# @!attribute spending_cap
|
197
198
|
#
|
198
|
-
# @return [MetronomeSDK::V1::Customers::PlanAddParams::TrialSpec::SpendingCap, nil]
|
199
|
+
# @return [MetronomeSDK::Models::V1::Customers::PlanAddParams::TrialSpec::SpendingCap, nil]
|
199
200
|
optional :spending_cap, -> { MetronomeSDK::V1::Customers::PlanAddParams::TrialSpec::SpendingCap }
|
200
201
|
|
201
202
|
# @!method initialize(length_in_days:, spending_cap: nil)
|
@@ -205,9 +206,9 @@ module MetronomeSDK
|
|
205
206
|
#
|
206
207
|
# @param length_in_days [Float] Length of the trial period in days.
|
207
208
|
#
|
208
|
-
# @param spending_cap [MetronomeSDK::V1::Customers::PlanAddParams::TrialSpec::SpendingCap]
|
209
|
+
# @param spending_cap [MetronomeSDK::Models::V1::Customers::PlanAddParams::TrialSpec::SpendingCap]
|
209
210
|
|
210
|
-
# @see MetronomeSDK::V1::Customers::PlanAddParams::TrialSpec#spending_cap
|
211
|
+
# @see MetronomeSDK::Models::V1::Customers::PlanAddParams::TrialSpec#spending_cap
|
211
212
|
class SpendingCap < MetronomeSDK::Internal::Type::BaseModel
|
212
213
|
# @!attribute amount
|
213
214
|
# The credit amount in the given denomination based on the credit type, e.g. US
|
@@ -224,8 +225,8 @@ module MetronomeSDK
|
|
224
225
|
|
225
226
|
# @!method initialize(amount:, credit_type_id:)
|
226
227
|
# Some parameter documentations has been truncated, see
|
227
|
-
# {MetronomeSDK::V1::Customers::PlanAddParams::TrialSpec::SpendingCap} for
|
228
|
-
# details.
|
228
|
+
# {MetronomeSDK::Models::V1::Customers::PlanAddParams::TrialSpec::SpendingCap} for
|
229
|
+
# more details.
|
229
230
|
#
|
230
231
|
# @param amount [Float] The credit amount in the given denomination based on the credit type, e.g. US ce
|
231
232
|
#
|
@@ -8,11 +8,11 @@ module MetronomeSDK
|
|
8
8
|
class PlanAddResponse < MetronomeSDK::Internal::Type::BaseModel
|
9
9
|
# @!attribute data
|
10
10
|
#
|
11
|
-
# @return [MetronomeSDK::ID]
|
11
|
+
# @return [MetronomeSDK::Models::ID]
|
12
12
|
required :data, -> { MetronomeSDK::ID }
|
13
13
|
|
14
14
|
# @!method initialize(data:)
|
15
|
-
# @param data [MetronomeSDK::ID]
|
15
|
+
# @param data [MetronomeSDK::Models::ID]
|
16
16
|
end
|
17
17
|
end
|
18
18
|
end
|
@@ -102,13 +102,13 @@ module MetronomeSDK
|
|
102
102
|
|
103
103
|
# @!attribute credit_type
|
104
104
|
#
|
105
|
-
# @return [MetronomeSDK::CreditTypeData]
|
105
|
+
# @return [MetronomeSDK::Models::CreditTypeData]
|
106
106
|
required :credit_type, -> { MetronomeSDK::CreditTypeData }
|
107
107
|
|
108
108
|
# @!method initialize(amount:, amount_remaining:, credit_type:)
|
109
109
|
# @param amount [Float]
|
110
110
|
# @param amount_remaining [Float]
|
111
|
-
# @param credit_type [MetronomeSDK::CreditTypeData]
|
111
|
+
# @param credit_type [MetronomeSDK::Models::CreditTypeData]
|
112
112
|
end
|
113
113
|
end
|
114
114
|
end
|
@@ -16,13 +16,13 @@ module MetronomeSDK
|
|
16
16
|
# @!attribute dashboard
|
17
17
|
# The type of dashboard to retrieve.
|
18
18
|
#
|
19
|
-
# @return [Symbol, MetronomeSDK::V1::DashboardGetEmbeddableURLParams::Dashboard]
|
19
|
+
# @return [Symbol, MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::Dashboard]
|
20
20
|
required :dashboard, enum: -> { MetronomeSDK::V1::DashboardGetEmbeddableURLParams::Dashboard }
|
21
21
|
|
22
22
|
# @!attribute bm_group_key_overrides
|
23
23
|
# Optional list of billable metric group key overrides
|
24
24
|
#
|
25
|
-
# @return [Array<MetronomeSDK::V1::DashboardGetEmbeddableURLParams::BmGroupKeyOverride>, nil]
|
25
|
+
# @return [Array<MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::BmGroupKeyOverride>, nil]
|
26
26
|
optional :bm_group_key_overrides,
|
27
27
|
-> {
|
28
28
|
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::DashboardGetEmbeddableURLParams::BmGroupKeyOverride]
|
@@ -31,7 +31,7 @@ module MetronomeSDK
|
|
31
31
|
# @!attribute color_overrides
|
32
32
|
# Optional list of colors to override
|
33
33
|
#
|
34
|
-
# @return [Array<MetronomeSDK::V1::DashboardGetEmbeddableURLParams::ColorOverride>, nil]
|
34
|
+
# @return [Array<MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::ColorOverride>, nil]
|
35
35
|
optional :color_overrides,
|
36
36
|
-> {
|
37
37
|
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::DashboardGetEmbeddableURLParams::ColorOverride]
|
@@ -40,7 +40,7 @@ module MetronomeSDK
|
|
40
40
|
# @!attribute dashboard_options
|
41
41
|
# Optional dashboard specific options
|
42
42
|
#
|
43
|
-
# @return [Array<MetronomeSDK::V1::DashboardGetEmbeddableURLParams::DashboardOption>, nil]
|
43
|
+
# @return [Array<MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::DashboardOption>, nil]
|
44
44
|
optional :dashboard_options,
|
45
45
|
-> {
|
46
46
|
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::DashboardGetEmbeddableURLParams::DashboardOption]
|
@@ -49,13 +49,13 @@ module MetronomeSDK
|
|
49
49
|
# @!method initialize(customer_id:, dashboard:, bm_group_key_overrides: nil, color_overrides: nil, dashboard_options: nil, request_options: {})
|
50
50
|
# @param customer_id [String]
|
51
51
|
#
|
52
|
-
# @param dashboard [Symbol, MetronomeSDK::V1::DashboardGetEmbeddableURLParams::Dashboard] The type of dashboard to retrieve.
|
52
|
+
# @param dashboard [Symbol, MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::Dashboard] The type of dashboard to retrieve.
|
53
53
|
#
|
54
|
-
# @param bm_group_key_overrides [Array<MetronomeSDK::V1::DashboardGetEmbeddableURLParams::BmGroupKeyOverride>] Optional list of billable metric group key overrides
|
54
|
+
# @param bm_group_key_overrides [Array<MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::BmGroupKeyOverride>] Optional list of billable metric group key overrides
|
55
55
|
#
|
56
|
-
# @param color_overrides [Array<MetronomeSDK::V1::DashboardGetEmbeddableURLParams::ColorOverride>] Optional list of colors to override
|
56
|
+
# @param color_overrides [Array<MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::ColorOverride>] Optional list of colors to override
|
57
57
|
#
|
58
|
-
# @param dashboard_options [Array<MetronomeSDK::V1::DashboardGetEmbeddableURLParams::DashboardOption>] Optional dashboard specific options
|
58
|
+
# @param dashboard_options [Array<MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::DashboardOption>] Optional dashboard specific options
|
59
59
|
#
|
60
60
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
|
61
61
|
|
@@ -66,6 +66,7 @@ module MetronomeSDK
|
|
66
66
|
INVOICES = :invoices
|
67
67
|
USAGE = :usage
|
68
68
|
CREDITS = :credits
|
69
|
+
COMMITS_AND_CREDITS = :commits_and_credits
|
69
70
|
|
70
71
|
# @!method self.values
|
71
72
|
# @return [Array<Symbol>]
|
@@ -94,8 +95,8 @@ module MetronomeSDK
|
|
94
95
|
|
95
96
|
# @!method initialize(group_key_name:, display_name: nil, value_display_names: nil)
|
96
97
|
# Some parameter documentations has been truncated, see
|
97
|
-
# {MetronomeSDK::V1::DashboardGetEmbeddableURLParams::BmGroupKeyOverride}
|
98
|
-
# details.
|
98
|
+
# {MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::BmGroupKeyOverride}
|
99
|
+
# for more details.
|
99
100
|
#
|
100
101
|
# @param group_key_name [String] The name of the billable metric group key.
|
101
102
|
#
|
@@ -108,7 +109,7 @@ module MetronomeSDK
|
|
108
109
|
# @!attribute name
|
109
110
|
# The color to override
|
110
111
|
#
|
111
|
-
# @return [Symbol, MetronomeSDK::V1::DashboardGetEmbeddableURLParams::ColorOverride::Name, nil]
|
112
|
+
# @return [Symbol, MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::ColorOverride::Name, nil]
|
112
113
|
optional :name, enum: -> { MetronomeSDK::V1::DashboardGetEmbeddableURLParams::ColorOverride::Name }
|
113
114
|
|
114
115
|
# @!attribute value
|
@@ -118,13 +119,13 @@ module MetronomeSDK
|
|
118
119
|
optional :value, String
|
119
120
|
|
120
121
|
# @!method initialize(name: nil, value: nil)
|
121
|
-
# @param name [Symbol, MetronomeSDK::V1::DashboardGetEmbeddableURLParams::ColorOverride::Name] The color to override
|
122
|
+
# @param name [Symbol, MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::ColorOverride::Name] The color to override
|
122
123
|
#
|
123
124
|
# @param value [String] Hex value representation of the color
|
124
125
|
|
125
126
|
# The color to override
|
126
127
|
#
|
127
|
-
# @see MetronomeSDK::V1::DashboardGetEmbeddableURLParams::ColorOverride#name
|
128
|
+
# @see MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::ColorOverride#name
|
128
129
|
module Name
|
129
130
|
extend MetronomeSDK::Internal::Type::Enum
|
130
131
|
|
@@ -21,7 +21,7 @@ module MetronomeSDK
|
|
21
21
|
|
22
22
|
# @!attribute credit_grants
|
23
23
|
#
|
24
|
-
# @return [Array<MetronomeSDK::V1::PlanDetail::CreditGrant>, nil]
|
24
|
+
# @return [Array<MetronomeSDK::Models::V1::PlanDetail::CreditGrant>, nil]
|
25
25
|
optional :credit_grants,
|
26
26
|
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::PlanDetail::CreditGrant] }
|
27
27
|
|
@@ -32,7 +32,7 @@ module MetronomeSDK
|
|
32
32
|
|
33
33
|
# @!attribute minimums
|
34
34
|
#
|
35
|
-
# @return [Array<MetronomeSDK::V1::PlanDetail::Minimum>, nil]
|
35
|
+
# @return [Array<MetronomeSDK::Models::V1::PlanDetail::Minimum>, nil]
|
36
36
|
optional :minimums,
|
37
37
|
-> {
|
38
38
|
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::PlanDetail::Minimum]
|
@@ -40,7 +40,7 @@ module MetronomeSDK
|
|
40
40
|
|
41
41
|
# @!attribute overage_rates
|
42
42
|
#
|
43
|
-
# @return [Array<MetronomeSDK::V1::PlanDetail::OverageRate>, nil]
|
43
|
+
# @return [Array<MetronomeSDK::Models::V1::PlanDetail::OverageRate>, nil]
|
44
44
|
optional :overage_rates,
|
45
45
|
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::PlanDetail::OverageRate] }
|
46
46
|
|
@@ -48,10 +48,10 @@ module MetronomeSDK
|
|
48
48
|
# @param id [String]
|
49
49
|
# @param custom_fields [Hash{Symbol=>String}]
|
50
50
|
# @param name [String]
|
51
|
-
# @param credit_grants [Array<MetronomeSDK::V1::PlanDetail::CreditGrant>]
|
51
|
+
# @param credit_grants [Array<MetronomeSDK::Models::V1::PlanDetail::CreditGrant>]
|
52
52
|
# @param description [String]
|
53
|
-
# @param minimums [Array<MetronomeSDK::V1::PlanDetail::Minimum>]
|
54
|
-
# @param overage_rates [Array<MetronomeSDK::V1::PlanDetail::OverageRate>]
|
53
|
+
# @param minimums [Array<MetronomeSDK::Models::V1::PlanDetail::Minimum>]
|
54
|
+
# @param overage_rates [Array<MetronomeSDK::Models::V1::PlanDetail::OverageRate>]
|
55
55
|
|
56
56
|
class CreditGrant < MetronomeSDK::Internal::Type::BaseModel
|
57
57
|
# @!attribute amount_granted
|
@@ -61,7 +61,7 @@ module MetronomeSDK
|
|
61
61
|
|
62
62
|
# @!attribute amount_granted_credit_type
|
63
63
|
#
|
64
|
-
# @return [MetronomeSDK::CreditTypeData]
|
64
|
+
# @return [MetronomeSDK::Models::CreditTypeData]
|
65
65
|
required :amount_granted_credit_type, -> { MetronomeSDK::CreditTypeData }
|
66
66
|
|
67
67
|
# @!attribute amount_paid
|
@@ -71,7 +71,7 @@ module MetronomeSDK
|
|
71
71
|
|
72
72
|
# @!attribute amount_paid_credit_type
|
73
73
|
#
|
74
|
-
# @return [MetronomeSDK::CreditTypeData]
|
74
|
+
# @return [MetronomeSDK::Models::CreditTypeData]
|
75
75
|
required :amount_paid_credit_type, -> { MetronomeSDK::CreditTypeData }
|
76
76
|
|
77
77
|
# @!attribute effective_duration
|
@@ -111,9 +111,9 @@ module MetronomeSDK
|
|
111
111
|
|
112
112
|
# @!method initialize(amount_granted:, amount_granted_credit_type:, amount_paid:, amount_paid_credit_type:, effective_duration:, name:, priority:, send_invoice:, reason: nil, recurrence_duration: nil, recurrence_interval: nil)
|
113
113
|
# @param amount_granted [Float]
|
114
|
-
# @param amount_granted_credit_type [MetronomeSDK::CreditTypeData]
|
114
|
+
# @param amount_granted_credit_type [MetronomeSDK::Models::CreditTypeData]
|
115
115
|
# @param amount_paid [Float]
|
116
|
-
# @param amount_paid_credit_type [MetronomeSDK::CreditTypeData]
|
116
|
+
# @param amount_paid_credit_type [MetronomeSDK::Models::CreditTypeData]
|
117
117
|
# @param effective_duration [Float]
|
118
118
|
# @param name [String]
|
119
119
|
# @param priority [String]
|
@@ -126,7 +126,7 @@ module MetronomeSDK
|
|
126
126
|
class Minimum < MetronomeSDK::Internal::Type::BaseModel
|
127
127
|
# @!attribute credit_type
|
128
128
|
#
|
129
|
-
# @return [MetronomeSDK::CreditTypeData]
|
129
|
+
# @return [MetronomeSDK::Models::CreditTypeData]
|
130
130
|
required :credit_type, -> { MetronomeSDK::CreditTypeData }
|
131
131
|
|
132
132
|
# @!attribute name
|
@@ -148,9 +148,9 @@ module MetronomeSDK
|
|
148
148
|
|
149
149
|
# @!method initialize(credit_type:, name:, start_period:, value:)
|
150
150
|
# Some parameter documentations has been truncated, see
|
151
|
-
# {MetronomeSDK::V1::PlanDetail::Minimum} for more details.
|
151
|
+
# {MetronomeSDK::Models::V1::PlanDetail::Minimum} for more details.
|
152
152
|
#
|
153
|
-
# @param credit_type [MetronomeSDK::CreditTypeData]
|
153
|
+
# @param credit_type [MetronomeSDK::Models::CreditTypeData]
|
154
154
|
#
|
155
155
|
# @param name [String]
|
156
156
|
#
|
@@ -162,12 +162,12 @@ module MetronomeSDK
|
|
162
162
|
class OverageRate < MetronomeSDK::Internal::Type::BaseModel
|
163
163
|
# @!attribute credit_type
|
164
164
|
#
|
165
|
-
# @return [MetronomeSDK::CreditTypeData]
|
165
|
+
# @return [MetronomeSDK::Models::CreditTypeData]
|
166
166
|
required :credit_type, -> { MetronomeSDK::CreditTypeData }
|
167
167
|
|
168
168
|
# @!attribute fiat_credit_type
|
169
169
|
#
|
170
|
-
# @return [MetronomeSDK::CreditTypeData]
|
170
|
+
# @return [MetronomeSDK::Models::CreditTypeData]
|
171
171
|
required :fiat_credit_type, -> { MetronomeSDK::CreditTypeData }
|
172
172
|
|
173
173
|
# @!attribute start_period
|
@@ -184,11 +184,11 @@ module MetronomeSDK
|
|
184
184
|
|
185
185
|
# @!method initialize(credit_type:, fiat_credit_type:, start_period:, to_fiat_conversion_factor:)
|
186
186
|
# Some parameter documentations has been truncated, see
|
187
|
-
# {MetronomeSDK::V1::PlanDetail::OverageRate} for more details.
|
187
|
+
# {MetronomeSDK::Models::V1::PlanDetail::OverageRate} for more details.
|
188
188
|
#
|
189
|
-
# @param credit_type [MetronomeSDK::CreditTypeData]
|
189
|
+
# @param credit_type [MetronomeSDK::Models::CreditTypeData]
|
190
190
|
#
|
191
|
-
# @param fiat_credit_type [MetronomeSDK::CreditTypeData]
|
191
|
+
# @param fiat_credit_type [MetronomeSDK::Models::CreditTypeData]
|
192
192
|
#
|
193
193
|
# @param start_period [Float] Used in price ramps. Indicates how many billing periods pass before the charge
|
194
194
|
#
|
@@ -7,11 +7,11 @@ module MetronomeSDK
|
|
7
7
|
class PlanGetDetailsResponse < MetronomeSDK::Internal::Type::BaseModel
|
8
8
|
# @!attribute data
|
9
9
|
#
|
10
|
-
# @return [MetronomeSDK::V1::PlanDetail]
|
10
|
+
# @return [MetronomeSDK::Models::V1::PlanDetail]
|
11
11
|
required :data, -> { MetronomeSDK::V1::PlanDetail }
|
12
12
|
|
13
13
|
# @!method initialize(data:)
|
14
|
-
# @param data [MetronomeSDK::V1::PlanDetail]
|
14
|
+
# @param data [MetronomeSDK::Models::V1::PlanDetail]
|
15
15
|
end
|
16
16
|
end
|
17
17
|
end
|
@@ -17,7 +17,7 @@ module MetronomeSDK
|
|
17
17
|
|
18
18
|
# @!attribute credit_type
|
19
19
|
#
|
20
|
-
# @return [MetronomeSDK::CreditTypeData]
|
20
|
+
# @return [MetronomeSDK::Models::CreditTypeData]
|
21
21
|
required :credit_type, -> { MetronomeSDK::CreditTypeData }
|
22
22
|
|
23
23
|
# @!attribute custom_fields
|
@@ -79,7 +79,7 @@ module MetronomeSDK
|
|
79
79
|
#
|
80
80
|
# @param charge_type [Symbol, MetronomeSDK::Models::V1::PlanListChargesResponse::ChargeType]
|
81
81
|
#
|
82
|
-
# @param credit_type [MetronomeSDK::CreditTypeData]
|
82
|
+
# @param credit_type [MetronomeSDK::Models::CreditTypeData]
|
83
83
|
#
|
84
84
|
# @param custom_fields [Hash{Symbol=>String}]
|
85
85
|
#
|
@@ -36,7 +36,7 @@ module MetronomeSDK
|
|
36
36
|
# Multiple statuses can be OR'd together using commas, e.g. `active,ended`.
|
37
37
|
# **Note:** `ended,upcoming` combination is not yet supported.
|
38
38
|
#
|
39
|
-
# @return [Symbol, MetronomeSDK::V1::PlanListCustomersParams::Status, nil]
|
39
|
+
# @return [Symbol, MetronomeSDK::Models::V1::PlanListCustomersParams::Status, nil]
|
40
40
|
optional :status, enum: -> { MetronomeSDK::V1::PlanListCustomersParams::Status }
|
41
41
|
|
42
42
|
# @!method initialize(plan_id:, limit: nil, next_page: nil, status: nil, request_options: {})
|
@@ -49,7 +49,7 @@ module MetronomeSDK
|
|
49
49
|
#
|
50
50
|
# @param next_page [String] Cursor that indicates where the next page of results should start.
|
51
51
|
#
|
52
|
-
# @param status [Symbol, MetronomeSDK::V1::PlanListCustomersParams::Status] Status of customers on a given plan. Defaults to `active`.
|
52
|
+
# @param status [Symbol, MetronomeSDK::Models::V1::PlanListCustomersParams::Status] Status of customers on a given plan. Defaults to `active`.
|
53
53
|
#
|
54
54
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
|
55
55
|
|
@@ -7,7 +7,7 @@ module MetronomeSDK
|
|
7
7
|
class PlanListCustomersResponse < MetronomeSDK::Internal::Type::BaseModel
|
8
8
|
# @!attribute customer_details
|
9
9
|
#
|
10
|
-
# @return [MetronomeSDK::V1::CustomerDetail]
|
10
|
+
# @return [MetronomeSDK::Models::V1::CustomerDetail]
|
11
11
|
required :customer_details, -> { MetronomeSDK::V1::CustomerDetail }
|
12
12
|
|
13
13
|
# @!attribute plan_details
|
@@ -16,7 +16,7 @@ module MetronomeSDK
|
|
16
16
|
required :plan_details, -> { MetronomeSDK::Models::V1::PlanListCustomersResponse::PlanDetails }
|
17
17
|
|
18
18
|
# @!method initialize(customer_details:, plan_details:)
|
19
|
-
# @param customer_details [MetronomeSDK::V1::CustomerDetail]
|
19
|
+
# @param customer_details [MetronomeSDK::Models::V1::CustomerDetail]
|
20
20
|
# @param plan_details [MetronomeSDK::Models::V1::PlanListCustomersResponse::PlanDetails]
|
21
21
|
|
22
22
|
# @see MetronomeSDK::Models::V1::PlanListCustomersResponse#plan_details
|
@@ -7,7 +7,7 @@ module MetronomeSDK
|
|
7
7
|
# @!attribute type
|
8
8
|
# Rollover up to a fixed amount of the original credit grant amount.
|
9
9
|
#
|
10
|
-
# @return [Symbol, MetronomeSDK::V1::RolloverAmountMaxAmount::Type]
|
10
|
+
# @return [Symbol, MetronomeSDK::Models::V1::RolloverAmountMaxAmount::Type]
|
11
11
|
required :type, enum: -> { MetronomeSDK::V1::RolloverAmountMaxAmount::Type }
|
12
12
|
|
13
13
|
# @!attribute value
|
@@ -17,13 +17,13 @@ module MetronomeSDK
|
|
17
17
|
required :value, Float
|
18
18
|
|
19
19
|
# @!method initialize(type:, value:)
|
20
|
-
# @param type [Symbol, MetronomeSDK::V1::RolloverAmountMaxAmount::Type] Rollover up to a fixed amount of the original credit grant amount.
|
20
|
+
# @param type [Symbol, MetronomeSDK::Models::V1::RolloverAmountMaxAmount::Type] Rollover up to a fixed amount of the original credit grant amount.
|
21
21
|
#
|
22
22
|
# @param value [Float] The maximum amount to rollover.
|
23
23
|
|
24
24
|
# Rollover up to a fixed amount of the original credit grant amount.
|
25
25
|
#
|
26
|
-
# @see MetronomeSDK::V1::RolloverAmountMaxAmount#type
|
26
|
+
# @see MetronomeSDK::Models::V1::RolloverAmountMaxAmount#type
|
27
27
|
module Type
|
28
28
|
extend MetronomeSDK::Internal::Type::Enum
|
29
29
|
|
@@ -7,7 +7,7 @@ module MetronomeSDK
|
|
7
7
|
# @!attribute type
|
8
8
|
# Rollover up to a percentage of the original credit grant amount.
|
9
9
|
#
|
10
|
-
# @return [Symbol, MetronomeSDK::V1::RolloverAmountMaxPercentage::Type]
|
10
|
+
# @return [Symbol, MetronomeSDK::Models::V1::RolloverAmountMaxPercentage::Type]
|
11
11
|
required :type, enum: -> { MetronomeSDK::V1::RolloverAmountMaxPercentage::Type }
|
12
12
|
|
13
13
|
# @!attribute value
|
@@ -17,13 +17,13 @@ module MetronomeSDK
|
|
17
17
|
required :value, Float
|
18
18
|
|
19
19
|
# @!method initialize(type:, value:)
|
20
|
-
# @param type [Symbol, MetronomeSDK::V1::RolloverAmountMaxPercentage::Type] Rollover up to a percentage of the original credit grant amount.
|
20
|
+
# @param type [Symbol, MetronomeSDK::Models::V1::RolloverAmountMaxPercentage::Type] Rollover up to a percentage of the original credit grant amount.
|
21
21
|
#
|
22
22
|
# @param value [Float] The maximum percentage (0-1) of the original credit grant to rollover.
|
23
23
|
|
24
24
|
# Rollover up to a percentage of the original credit grant amount.
|
25
25
|
#
|
26
|
-
# @see MetronomeSDK::V1::RolloverAmountMaxPercentage#type
|
26
|
+
# @see MetronomeSDK::Models::V1::RolloverAmountMaxPercentage#type
|
27
27
|
module Type
|
28
28
|
extend MetronomeSDK::Internal::Type::Enum
|
29
29
|
|
@@ -10,14 +10,14 @@ module MetronomeSDK
|
|
10
10
|
|
11
11
|
# @!attribute usage
|
12
12
|
#
|
13
|
-
# @return [Array<MetronomeSDK::V1::UsageIngestParams::Usage>, nil]
|
13
|
+
# @return [Array<MetronomeSDK::Models::V1::UsageIngestParams::Usage>, nil]
|
14
14
|
optional :usage,
|
15
15
|
-> {
|
16
16
|
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::UsageIngestParams::Usage]
|
17
17
|
}
|
18
18
|
|
19
19
|
# @!method initialize(usage: nil, request_options: {})
|
20
|
-
# @param usage [Array<MetronomeSDK::V1::UsageIngestParams::Usage>]
|
20
|
+
# @param usage [Array<MetronomeSDK::Models::V1::UsageIngestParams::Usage>]
|
21
21
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
|
22
22
|
|
23
23
|
class Usage < MetronomeSDK::Internal::Type::BaseModel
|
@@ -23,7 +23,7 @@ module MetronomeSDK
|
|
23
23
|
# segmented into daily or hourly aggregates. A window_size of "none" will return a
|
24
24
|
# single usage aggregate for the entirety of the specified period.
|
25
25
|
#
|
26
|
-
# @return [Symbol, MetronomeSDK::V1::UsageListParams::WindowSize]
|
26
|
+
# @return [Symbol, MetronomeSDK::Models::V1::UsageListParams::WindowSize]
|
27
27
|
required :window_size, enum: -> { MetronomeSDK::V1::UsageListParams::WindowSize }
|
28
28
|
|
29
29
|
# @!attribute next_page
|
@@ -36,7 +36,7 @@ module MetronomeSDK
|
|
36
36
|
# A list of billable metrics to fetch usage for. If absent, all billable metrics
|
37
37
|
# will be returned.
|
38
38
|
#
|
39
|
-
# @return [Array<MetronomeSDK::V1::UsageListParams::BillableMetric>, nil]
|
39
|
+
# @return [Array<MetronomeSDK::Models::V1::UsageListParams::BillableMetric>, nil]
|
40
40
|
optional :billable_metrics,
|
41
41
|
-> {
|
42
42
|
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::UsageListParams::BillableMetric]
|
@@ -57,11 +57,11 @@ module MetronomeSDK
|
|
57
57
|
#
|
58
58
|
# @param starting_on [Time]
|
59
59
|
#
|
60
|
-
# @param window_size [Symbol, MetronomeSDK::V1::UsageListParams::WindowSize] A window_size of "day" or "hour" will return the usage for the specified period
|
60
|
+
# @param window_size [Symbol, MetronomeSDK::Models::V1::UsageListParams::WindowSize] A window_size of "day" or "hour" will return the usage for the specified period
|
61
61
|
#
|
62
62
|
# @param next_page [String] Cursor that indicates where the next page of results should start.
|
63
63
|
#
|
64
|
-
# @param billable_metrics [Array<MetronomeSDK::V1::UsageListParams::BillableMetric>] A list of billable metrics to fetch usage for. If absent, all billable metrics w
|
64
|
+
# @param billable_metrics [Array<MetronomeSDK::Models::V1::UsageListParams::BillableMetric>] A list of billable metrics to fetch usage for. If absent, all billable metrics w
|
65
65
|
#
|
66
66
|
# @param customer_ids [Array<String>] A list of Metronome customer IDs to fetch usage for. If absent, usage for all cu
|
67
67
|
#
|
@@ -89,14 +89,14 @@ module MetronomeSDK
|
|
89
89
|
|
90
90
|
# @!attribute group_by
|
91
91
|
#
|
92
|
-
# @return [MetronomeSDK::V1::UsageListParams::BillableMetric::GroupBy, nil]
|
92
|
+
# @return [MetronomeSDK::Models::V1::UsageListParams::BillableMetric::GroupBy, nil]
|
93
93
|
optional :group_by, -> { MetronomeSDK::V1::UsageListParams::BillableMetric::GroupBy }
|
94
94
|
|
95
95
|
# @!method initialize(id:, group_by: nil)
|
96
96
|
# @param id [String]
|
97
|
-
# @param group_by [MetronomeSDK::V1::UsageListParams::BillableMetric::GroupBy]
|
97
|
+
# @param group_by [MetronomeSDK::Models::V1::UsageListParams::BillableMetric::GroupBy]
|
98
98
|
|
99
|
-
# @see MetronomeSDK::V1::UsageListParams::BillableMetric#group_by
|
99
|
+
# @see MetronomeSDK::Models::V1::UsageListParams::BillableMetric#group_by
|
100
100
|
class GroupBy < MetronomeSDK::Internal::Type::BaseModel
|
101
101
|
# @!attribute key
|
102
102
|
# The name of the group_by key to use
|
@@ -113,7 +113,8 @@ module MetronomeSDK
|
|
113
113
|
|
114
114
|
# @!method initialize(key:, values: nil)
|
115
115
|
# Some parameter documentations has been truncated, see
|
116
|
-
# {MetronomeSDK::V1::UsageListParams::BillableMetric::GroupBy} for more
|
116
|
+
# {MetronomeSDK::Models::V1::UsageListParams::BillableMetric::GroupBy} for more
|
117
|
+
# details.
|
117
118
|
#
|
118
119
|
# @param key [String] The name of the group_by key to use
|
119
120
|
#
|
@@ -23,7 +23,7 @@ module MetronomeSDK
|
|
23
23
|
# segmented into daily or hourly aggregates. A window_size of "none" will return a
|
24
24
|
# single usage aggregate for the entirety of the specified period.
|
25
25
|
#
|
26
|
-
# @return [Symbol, MetronomeSDK::V1::UsageListWithGroupsParams::WindowSize]
|
26
|
+
# @return [Symbol, MetronomeSDK::Models::V1::UsageListWithGroupsParams::WindowSize]
|
27
27
|
required :window_size, enum: -> { MetronomeSDK::V1::UsageListWithGroupsParams::WindowSize }
|
28
28
|
|
29
29
|
# @!attribute limit
|
@@ -53,7 +53,7 @@ module MetronomeSDK
|
|
53
53
|
|
54
54
|
# @!attribute group_by
|
55
55
|
#
|
56
|
-
# @return [MetronomeSDK::V1::UsageListWithGroupsParams::GroupBy, nil]
|
56
|
+
# @return [MetronomeSDK::Models::V1::UsageListWithGroupsParams::GroupBy, nil]
|
57
57
|
optional :group_by, -> { MetronomeSDK::V1::UsageListWithGroupsParams::GroupBy }
|
58
58
|
|
59
59
|
# @!attribute starting_on
|
@@ -69,7 +69,7 @@ module MetronomeSDK
|
|
69
69
|
#
|
70
70
|
# @param customer_id [String]
|
71
71
|
#
|
72
|
-
# @param window_size [Symbol, MetronomeSDK::V1::UsageListWithGroupsParams::WindowSize] A window_size of "day" or "hour" will return the usage for the specified period
|
72
|
+
# @param window_size [Symbol, MetronomeSDK::Models::V1::UsageListWithGroupsParams::WindowSize] A window_size of "day" or "hour" will return the usage for the specified period
|
73
73
|
#
|
74
74
|
# @param limit [Integer] Max number of results that should be returned
|
75
75
|
#
|
@@ -79,7 +79,7 @@ module MetronomeSDK
|
|
79
79
|
#
|
80
80
|
# @param ending_before [Time]
|
81
81
|
#
|
82
|
-
# @param group_by [MetronomeSDK::V1::UsageListWithGroupsParams::GroupBy]
|
82
|
+
# @param group_by [MetronomeSDK::Models::V1::UsageListWithGroupsParams::GroupBy]
|
83
83
|
#
|
84
84
|
# @param starting_on [Time]
|
85
85
|
#
|
@@ -115,7 +115,7 @@ module MetronomeSDK
|
|
115
115
|
|
116
116
|
# @!method initialize(key:, values: nil)
|
117
117
|
# Some parameter documentations has been truncated, see
|
118
|
-
# {MetronomeSDK::V1::UsageListWithGroupsParams::GroupBy} for more details.
|
118
|
+
# {MetronomeSDK::Models::V1::UsageListWithGroupsParams::GroupBy} for more details.
|
119
119
|
#
|
120
120
|
# @param key [String] The name of the group_by key to use
|
121
121
|
#
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module MetronomeSDK
|
4
|
+
module Models
|
5
|
+
module V1
|
6
|
+
# @see MetronomeSDK::Resources::V1::Usage#search
|
7
|
+
class UsageSearchParams < MetronomeSDK::Internal::Type::BaseModel
|
8
|
+
extend MetronomeSDK::Internal::Type::RequestParameters::Converter
|
9
|
+
include MetronomeSDK::Internal::Type::RequestParameters
|
10
|
+
|
11
|
+
# @!attribute transaction_ids
|
12
|
+
# The transaction IDs of the events to retrieve
|
13
|
+
#
|
14
|
+
# @return [Array<String>]
|
15
|
+
required :transaction_ids, MetronomeSDK::Internal::Type::ArrayOf[String], api_name: :transactionIds
|
16
|
+
|
17
|
+
# @!method initialize(transaction_ids:, request_options: {})
|
18
|
+
# @param transaction_ids [Array<String>] The transaction IDs of the events to retrieve
|
19
|
+
#
|
20
|
+
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|