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
@@ -10,9 +10,9 @@ module MetronomeSDK
|
|
10
10
|
#
|
11
11
|
# Create a new commit at the customer level.
|
12
12
|
#
|
13
|
-
# @overload create(access_schedule:, customer_id:, priority:, product_id:, type:, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, custom_fields: nil, description: nil, invoice_contract_id: nil, invoice_schedule: nil, name: nil, netsuite_sales_order_id: nil, rate_type: nil, salesforce_opportunity_id: nil, uniqueness_key: nil, request_options: {})
|
13
|
+
# @overload create(access_schedule:, customer_id:, priority:, product_id:, type:, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, custom_fields: nil, description: nil, invoice_contract_id: nil, invoice_schedule: nil, name: nil, netsuite_sales_order_id: nil, rate_type: nil, salesforce_opportunity_id: nil, specifiers: nil, uniqueness_key: nil, request_options: {})
|
14
14
|
#
|
15
|
-
# @param access_schedule [MetronomeSDK::V1::Customers::CommitCreateParams::AccessSchedule] Schedule for distributing the commit to the customer. For "POSTPAID" commits onl
|
15
|
+
# @param access_schedule [MetronomeSDK::Models::V1::Customers::CommitCreateParams::AccessSchedule] Schedule for distributing the commit to the customer. For "POSTPAID" commits onl
|
16
16
|
#
|
17
17
|
# @param customer_id [String]
|
18
18
|
#
|
@@ -20,13 +20,13 @@ module MetronomeSDK
|
|
20
20
|
#
|
21
21
|
# @param product_id [String] ID of the fixed product associated with the commit. This is required because pro
|
22
22
|
#
|
23
|
-
# @param type [Symbol, MetronomeSDK::V1::Customers::CommitCreateParams::Type]
|
23
|
+
# @param type [Symbol, MetronomeSDK::Models::V1::Customers::CommitCreateParams::Type]
|
24
24
|
#
|
25
25
|
# @param applicable_contract_ids [Array<String>] Which contract the commit applies to. If not provided, the commit applies to all
|
26
26
|
#
|
27
|
-
# @param applicable_product_ids [Array<String>] Which products the commit applies to. If
|
27
|
+
# @param applicable_product_ids [Array<String>] Which products the commit applies to. If applicable_product_ids, applicable_prod
|
28
28
|
#
|
29
|
-
# @param applicable_product_tags [Array<String>] Which tags the commit applies to. If
|
29
|
+
# @param applicable_product_tags [Array<String>] Which tags the commit applies to. If applicable*product_ids, applicable_product*
|
30
30
|
#
|
31
31
|
# @param custom_fields [Hash{Symbol=>String}]
|
32
32
|
#
|
@@ -34,16 +34,18 @@ module MetronomeSDK
|
|
34
34
|
#
|
35
35
|
# @param invoice_contract_id [String] The contract that this commit will be billed on. This is required for "POSTPAID"
|
36
36
|
#
|
37
|
-
# @param invoice_schedule [MetronomeSDK::V1::Customers::CommitCreateParams::InvoiceSchedule] Required for "POSTPAID" commits: the true up invoice will be generated at this t
|
37
|
+
# @param invoice_schedule [MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule] Required for "POSTPAID" commits: the true up invoice will be generated at this t
|
38
38
|
#
|
39
39
|
# @param name [String] displayed on invoices
|
40
40
|
#
|
41
41
|
# @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
|
42
42
|
#
|
43
|
-
# @param rate_type [Symbol, MetronomeSDK::V1::Customers::CommitCreateParams::RateType]
|
43
|
+
# @param rate_type [Symbol, MetronomeSDK::Models::V1::Customers::CommitCreateParams::RateType]
|
44
44
|
#
|
45
45
|
# @param salesforce_opportunity_id [String] This field's availability is dependent on your client's configuration.
|
46
46
|
#
|
47
|
+
# @param specifiers [Array<MetronomeSDK::Models::V1::Customers::CommitCreateParams::Specifier>] List of filters that determine what kind of customer usage draws down a commit o
|
48
|
+
#
|
47
49
|
# @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a commit or credit i
|
48
50
|
#
|
49
51
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
@@ -10,9 +10,9 @@ module MetronomeSDK
|
|
10
10
|
#
|
11
11
|
# Create a new credit at the customer level.
|
12
12
|
#
|
13
|
-
# @overload create(access_schedule:, customer_id:, priority:, product_id:, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, custom_fields: nil, description: nil, name: nil, netsuite_sales_order_id: nil, rate_type: nil, salesforce_opportunity_id: nil, uniqueness_key: nil, request_options: {})
|
13
|
+
# @overload create(access_schedule:, customer_id:, priority:, product_id:, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, custom_fields: nil, description: nil, name: nil, netsuite_sales_order_id: nil, rate_type: nil, salesforce_opportunity_id: nil, specifiers: nil, uniqueness_key: nil, request_options: {})
|
14
14
|
#
|
15
|
-
# @param access_schedule [MetronomeSDK::V1::Customers::CreditCreateParams::AccessSchedule] Schedule for distributing the credit to the customer.
|
15
|
+
# @param access_schedule [MetronomeSDK::Models::V1::Customers::CreditCreateParams::AccessSchedule] Schedule for distributing the credit to the customer.
|
16
16
|
#
|
17
17
|
# @param customer_id [String]
|
18
18
|
#
|
@@ -34,10 +34,12 @@ module MetronomeSDK
|
|
34
34
|
#
|
35
35
|
# @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
|
36
36
|
#
|
37
|
-
# @param rate_type [Symbol, MetronomeSDK::V1::Customers::CreditCreateParams::RateType]
|
37
|
+
# @param rate_type [Symbol, MetronomeSDK::Models::V1::Customers::CreditCreateParams::RateType]
|
38
38
|
#
|
39
39
|
# @param salesforce_opportunity_id [String] This field's availability is dependent on your client's configuration.
|
40
40
|
#
|
41
|
+
# @param specifiers [Array<MetronomeSDK::Models::V1::Customers::CreditCreateParams::Specifier>] List of filters that determine what kind of customer usage draws down a commit o
|
42
|
+
#
|
41
43
|
# @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a commit or credit i
|
42
44
|
#
|
43
45
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
@@ -62,7 +62,7 @@ module MetronomeSDK
|
|
62
62
|
#
|
63
63
|
# @param skip_zero_qty_line_items [Boolean] Query param: If set, all zero quantity line items will be filtered out of the re
|
64
64
|
#
|
65
|
-
# @param sort [Symbol, MetronomeSDK::V1::Customers::InvoiceListParams::Sort] Query param: Invoice sort order by issued_at, e.g. date_asc or date_desc. Defau
|
65
|
+
# @param sort [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListParams::Sort] Query param: Invoice sort order by issued_at, e.g. date_asc or date_desc. Defau
|
66
66
|
#
|
67
67
|
# @param starting_on [Time] Query param: RFC 3339 timestamp (inclusive). Invoices will only be returned for
|
68
68
|
#
|
@@ -70,7 +70,7 @@ module MetronomeSDK
|
|
70
70
|
#
|
71
71
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
72
72
|
#
|
73
|
-
# @return [MetronomeSDK::Internal::CursorPage<MetronomeSDK::V1::Customers::Invoice>]
|
73
|
+
# @return [MetronomeSDK::Internal::CursorPage<MetronomeSDK::Models::V1::Customers::Invoice>]
|
74
74
|
#
|
75
75
|
# @see MetronomeSDK::Models::V1::Customers::InvoiceListParams
|
76
76
|
def list(params)
|
@@ -156,11 +156,11 @@ module MetronomeSDK
|
|
156
156
|
#
|
157
157
|
# @param skip_zero_qty_line_items [Boolean] Query param: If set, all zero quantity line items will be filtered out of the re
|
158
158
|
#
|
159
|
-
# @param sort [Symbol, MetronomeSDK::V1::Customers::InvoiceListBreakdownsParams::Sort] Query param: Invoice sort order by issued_at, e.g. date_asc or date_desc. Defau
|
159
|
+
# @param sort [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsParams::Sort] Query param: Invoice sort order by issued_at, e.g. date_asc or date_desc. Defau
|
160
160
|
#
|
161
161
|
# @param status [String] Query param: Invoice status, e.g. DRAFT or FINALIZED
|
162
162
|
#
|
163
|
-
# @param window_size [Symbol, MetronomeSDK::V1::Customers::InvoiceListBreakdownsParams::WindowSize] Query param: The granularity of the breakdowns to return. Defaults to day.
|
163
|
+
# @param window_size [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsParams::WindowSize] Query param: The granularity of the breakdowns to return. Defaults to day.
|
164
164
|
#
|
165
165
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
166
166
|
#
|
@@ -55,11 +55,11 @@ module MetronomeSDK
|
|
55
55
|
#
|
56
56
|
# @param net_payment_terms_days [Float] Body param: Number of days after issuance of invoice after which the invoice is
|
57
57
|
#
|
58
|
-
# @param overage_rate_adjustments [Array<MetronomeSDK::V1::Customers::PlanAddParams::OverageRateAdjustment>] Body param: An optional list of overage rates that override the rates of the ori
|
58
|
+
# @param overage_rate_adjustments [Array<MetronomeSDK::Models::V1::Customers::PlanAddParams::OverageRateAdjustment>] Body param: An optional list of overage rates that override the rates of the ori
|
59
59
|
#
|
60
|
-
# @param price_adjustments [Array<MetronomeSDK::V1::Customers::PlanAddParams::PriceAdjustment>] Body param: A list of price adjustments can be applied on top of the pricing in
|
60
|
+
# @param price_adjustments [Array<MetronomeSDK::Models::V1::Customers::PlanAddParams::PriceAdjustment>] Body param: A list of price adjustments can be applied on top of the pricing in
|
61
61
|
#
|
62
|
-
# @param trial_spec [MetronomeSDK::V1::Customers::PlanAddParams::TrialSpec] Body param: A custom trial can be set for the customer's plan. See the [trial co
|
62
|
+
# @param trial_spec [MetronomeSDK::Models::V1::Customers::PlanAddParams::TrialSpec] Body param: A custom trial can be set for the customer's plan. See the [trial co
|
63
63
|
#
|
64
64
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
65
65
|
#
|
@@ -34,11 +34,11 @@ module MetronomeSDK
|
|
34
34
|
#
|
35
35
|
# @param name [String] This will be truncated to 160 characters if the provided name is longer.
|
36
36
|
#
|
37
|
-
# @param billing_config [MetronomeSDK::V1::CustomerCreateParams::BillingConfig]
|
37
|
+
# @param billing_config [MetronomeSDK::Models::V1::CustomerCreateParams::BillingConfig]
|
38
38
|
#
|
39
39
|
# @param custom_fields [Hash{Symbol=>String}]
|
40
40
|
#
|
41
|
-
# @param customer_billing_provider_configurations [Array<MetronomeSDK::V1::CustomerCreateParams::CustomerBillingProviderConfiguration>]
|
41
|
+
# @param customer_billing_provider_configurations [Array<MetronomeSDK::Models::V1::CustomerCreateParams::CustomerBillingProviderConfiguration>]
|
42
42
|
#
|
43
43
|
# @param external_id [String] (deprecated, use ingest_aliases instead) an alias that can be used to refer to t
|
44
44
|
#
|
@@ -105,7 +105,7 @@ module MetronomeSDK
|
|
105
105
|
#
|
106
106
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
107
107
|
#
|
108
|
-
# @return [MetronomeSDK::Internal::CursorPage<MetronomeSDK::V1::CustomerDetail>]
|
108
|
+
# @return [MetronomeSDK::Internal::CursorPage<MetronomeSDK::Models::V1::CustomerDetail>]
|
109
109
|
#
|
110
110
|
# @see MetronomeSDK::Models::V1::CustomerListParams
|
111
111
|
def list(params = {})
|
@@ -120,7 +120,8 @@ module MetronomeSDK
|
|
120
120
|
)
|
121
121
|
end
|
122
122
|
|
123
|
-
# Archive a customer
|
123
|
+
# Archive a customer Note: any alerts associated with the customer will not be
|
124
|
+
# triggered.
|
124
125
|
#
|
125
126
|
# @overload archive(id:, request_options: {})
|
126
127
|
#
|
@@ -216,6 +217,44 @@ module MetronomeSDK
|
|
216
217
|
)
|
217
218
|
end
|
218
219
|
|
220
|
+
# Some parameter documentations has been truncated, see
|
221
|
+
# {MetronomeSDK::Models::V1::CustomerPreviewEventsParams} for more details.
|
222
|
+
#
|
223
|
+
# Preview how a set of events will affect a customer's invoice. Generates a draft
|
224
|
+
# invoice for a customer using their current contract configuration and the
|
225
|
+
# provided events. This is useful for testing how new events will affect the
|
226
|
+
# customer's invoice before they are actually processed.
|
227
|
+
#
|
228
|
+
# @overload preview_events(customer_id:, events:, mode: nil, skip_zero_qty_line_items: nil, request_options: {})
|
229
|
+
#
|
230
|
+
# @param customer_id [String] Path param:
|
231
|
+
#
|
232
|
+
# @param events [Array<MetronomeSDK::Models::V1::CustomerPreviewEventsParams::Event>] Body param:
|
233
|
+
#
|
234
|
+
# @param mode [Symbol, MetronomeSDK::Models::V1::CustomerPreviewEventsParams::Mode] Body param: If set to "replace", the preview will be generated as if those were
|
235
|
+
#
|
236
|
+
# @param skip_zero_qty_line_items [Boolean] Body param: If set, all zero quantity line items will be filtered out of the res
|
237
|
+
#
|
238
|
+
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
239
|
+
#
|
240
|
+
# @return [MetronomeSDK::Models::V1::CustomerPreviewEventsResponse]
|
241
|
+
#
|
242
|
+
# @see MetronomeSDK::Models::V1::CustomerPreviewEventsParams
|
243
|
+
def preview_events(params)
|
244
|
+
parsed, options = MetronomeSDK::V1::CustomerPreviewEventsParams.dump_request(params)
|
245
|
+
customer_id =
|
246
|
+
parsed.delete(:customer_id) do
|
247
|
+
raise ArgumentError.new("missing required path argument #{_1}")
|
248
|
+
end
|
249
|
+
@client.request(
|
250
|
+
method: :post,
|
251
|
+
path: ["v1/customers/%1$s/previewEvents", customer_id],
|
252
|
+
body: parsed,
|
253
|
+
model: MetronomeSDK::Models::V1::CustomerPreviewEventsResponse,
|
254
|
+
options: options
|
255
|
+
)
|
256
|
+
end
|
257
|
+
|
219
258
|
# Sets the ingest aliases for a customer. Ingest aliases can be used in the
|
220
259
|
# `customer_id` field when sending usage events to Metronome. This call is
|
221
260
|
# idempotent. It fully replaces the set of ingest aliases for the given customer.
|
@@ -12,13 +12,13 @@ module MetronomeSDK
|
|
12
12
|
#
|
13
13
|
# @param customer_id [String]
|
14
14
|
#
|
15
|
-
# @param dashboard [Symbol, MetronomeSDK::V1::DashboardGetEmbeddableURLParams::Dashboard] The type of dashboard to retrieve.
|
15
|
+
# @param dashboard [Symbol, MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::Dashboard] The type of dashboard to retrieve.
|
16
16
|
#
|
17
|
-
# @param bm_group_key_overrides [Array<MetronomeSDK::V1::DashboardGetEmbeddableURLParams::BmGroupKeyOverride>] Optional list of billable metric group key overrides
|
17
|
+
# @param bm_group_key_overrides [Array<MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::BmGroupKeyOverride>] Optional list of billable metric group key overrides
|
18
18
|
#
|
19
|
-
# @param color_overrides [Array<MetronomeSDK::V1::DashboardGetEmbeddableURLParams::ColorOverride>] Optional list of colors to override
|
19
|
+
# @param color_overrides [Array<MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::ColorOverride>] Optional list of colors to override
|
20
20
|
#
|
21
|
-
# @param dashboard_options [Array<MetronomeSDK::V1::DashboardGetEmbeddableURLParams::DashboardOption>] Optional dashboard specific options
|
21
|
+
# @param dashboard_options [Array<MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::DashboardOption>] Optional dashboard specific options
|
22
22
|
#
|
23
23
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
24
24
|
#
|
@@ -98,7 +98,7 @@ module MetronomeSDK
|
|
98
98
|
#
|
99
99
|
# @param next_page [String] Query param: Cursor that indicates where the next page of results should start.
|
100
100
|
#
|
101
|
-
# @param status [Symbol, MetronomeSDK::V1::PlanListCustomersParams::Status] Query param: Status of customers on a given plan. Defaults to `active`.
|
101
|
+
# @param status [Symbol, MetronomeSDK::Models::V1::PlanListCustomersParams::Status] Query param: Status of customers on a given plan. Defaults to `active`.
|
102
102
|
#
|
103
103
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
104
104
|
#
|
@@ -16,11 +16,11 @@ module MetronomeSDK
|
|
16
16
|
#
|
17
17
|
# @param starting_on [Time] Body param:
|
18
18
|
#
|
19
|
-
# @param window_size [Symbol, MetronomeSDK::V1::UsageListParams::WindowSize] Body param: A window_size of "day" or "hour" will return the usage for the speci
|
19
|
+
# @param window_size [Symbol, MetronomeSDK::Models::V1::UsageListParams::WindowSize] Body param: A window_size of "day" or "hour" will return the usage for the speci
|
20
20
|
#
|
21
21
|
# @param next_page [String] Query param: Cursor that indicates where the next page of results should start.
|
22
22
|
#
|
23
|
-
# @param billable_metrics [Array<MetronomeSDK::V1::UsageListParams::BillableMetric>] Body param: A list of billable metrics to fetch usage for. If absent, all billab
|
23
|
+
# @param billable_metrics [Array<MetronomeSDK::Models::V1::UsageListParams::BillableMetric>] Body param: A list of billable metrics to fetch usage for. If absent, all billab
|
24
24
|
#
|
25
25
|
# @param customer_ids [Array<String>] Body param: A list of Metronome customer IDs to fetch usage for. If absent, usag
|
26
26
|
#
|
@@ -50,7 +50,7 @@ module MetronomeSDK
|
|
50
50
|
#
|
51
51
|
# @overload ingest(usage: nil, request_options: {})
|
52
52
|
#
|
53
|
-
# @param usage [Array<MetronomeSDK::V1::UsageIngestParams::Usage>]
|
53
|
+
# @param usage [Array<MetronomeSDK::Models::V1::UsageIngestParams::Usage>]
|
54
54
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
55
55
|
#
|
56
56
|
# @return [nil]
|
@@ -79,7 +79,7 @@ module MetronomeSDK
|
|
79
79
|
#
|
80
80
|
# @param customer_id [String] Body param:
|
81
81
|
#
|
82
|
-
# @param window_size [Symbol, MetronomeSDK::V1::UsageListWithGroupsParams::WindowSize] Body param: A window_size of "day" or "hour" will return the usage for the speci
|
82
|
+
# @param window_size [Symbol, MetronomeSDK::Models::V1::UsageListWithGroupsParams::WindowSize] Body param: A window_size of "day" or "hour" will return the usage for the speci
|
83
83
|
#
|
84
84
|
# @param limit [Integer] Query param: Max number of results that should be returned
|
85
85
|
#
|
@@ -89,7 +89,7 @@ module MetronomeSDK
|
|
89
89
|
#
|
90
90
|
# @param ending_before [Time] Body param:
|
91
91
|
#
|
92
|
-
# @param group_by [MetronomeSDK::V1::UsageListWithGroupsParams::GroupBy] Body param:
|
92
|
+
# @param group_by [MetronomeSDK::Models::V1::UsageListWithGroupsParams::GroupBy] Body param:
|
93
93
|
#
|
94
94
|
# @param starting_on [Time] Body param:
|
95
95
|
#
|
@@ -112,6 +112,31 @@ module MetronomeSDK
|
|
112
112
|
)
|
113
113
|
end
|
114
114
|
|
115
|
+
# For a set of events, look up matched billable metrics and customers by
|
116
|
+
# transaction id. This endpoint looks at transactions that occurred in the last 34
|
117
|
+
# days, and is intended for sampling-based testing workflows. It is heavily rate
|
118
|
+
# limited.
|
119
|
+
#
|
120
|
+
# @overload search(transaction_ids:, request_options: {})
|
121
|
+
#
|
122
|
+
# @param transaction_ids [Array<String>] The transaction IDs of the events to retrieve
|
123
|
+
#
|
124
|
+
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
125
|
+
#
|
126
|
+
# @return [Array<MetronomeSDK::Models::V1::UsageSearchResponseItem>]
|
127
|
+
#
|
128
|
+
# @see MetronomeSDK::Models::V1::UsageSearchParams
|
129
|
+
def search(params)
|
130
|
+
parsed, options = MetronomeSDK::V1::UsageSearchParams.dump_request(params)
|
131
|
+
@client.request(
|
132
|
+
method: :post,
|
133
|
+
path: "v1/events/search",
|
134
|
+
body: parsed,
|
135
|
+
model: MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::UsageSearchResponseItem],
|
136
|
+
options: options
|
137
|
+
)
|
138
|
+
end
|
139
|
+
|
115
140
|
# @api private
|
116
141
|
#
|
117
142
|
# @param client [MetronomeSDK::Client]
|
@@ -41,8 +41,8 @@ module MetronomeSDK
|
|
41
41
|
# Some parameter documentations has been truncated, see
|
42
42
|
# {MetronomeSDK::Models::V2::ContractListParams} for more details.
|
43
43
|
#
|
44
|
-
# List all contracts for a customer. New clients should use
|
45
|
-
# than the v1 endpoint.
|
44
|
+
# List all contracts for a customer in chronological order. New clients should use
|
45
|
+
# this endpoint rather than the v1 endpoint.
|
46
46
|
#
|
47
47
|
# @overload list(customer_id:, covering_date: nil, include_archived: nil, include_balance: nil, include_ledgers: nil, starting_at: nil, request_options: {})
|
48
48
|
#
|
@@ -79,55 +79,65 @@ module MetronomeSDK
|
|
79
79
|
#
|
80
80
|
# Edit a contract. Contract editing must be enabled to use this endpoint.
|
81
81
|
#
|
82
|
-
# @overload edit(contract_id:, customer_id:, add_commits: nil, add_credits: nil, add_discounts: nil, add_overrides: nil, add_prepaid_balance_threshold_configuration: nil, add_professional_services: nil, add_recurring_commits: nil, add_recurring_credits: nil, add_reseller_royalties: nil, add_scheduled_charges: nil, add_spend_threshold_configuration: nil, allow_contract_ending_before_finalized_invoice: nil, archive_commits: nil, archive_credits: nil, archive_scheduled_charges: nil, remove_overrides: nil, update_commits: nil, update_contract_end_date: nil, update_credits: nil, update_prepaid_balance_threshold_configuration: nil, update_scheduled_charges: nil, update_spend_threshold_configuration: nil, request_options: {})
|
82
|
+
# @overload edit(contract_id:, customer_id:, add_commits: nil, add_credits: nil, add_discounts: nil, add_overrides: nil, add_prepaid_balance_threshold_configuration: nil, add_professional_services: nil, add_recurring_commits: nil, add_recurring_credits: nil, add_reseller_royalties: nil, add_scheduled_charges: nil, add_spend_threshold_configuration: nil, add_subscriptions: nil, allow_contract_ending_before_finalized_invoice: nil, archive_commits: nil, archive_credits: nil, archive_scheduled_charges: nil, remove_overrides: nil, update_commits: nil, update_contract_end_date: nil, update_contract_name: nil, update_credits: nil, update_prepaid_balance_threshold_configuration: nil, update_recurring_commits: nil, update_recurring_credits: nil, update_scheduled_charges: nil, update_spend_threshold_configuration: nil, update_subscriptions: nil, request_options: {})
|
83
83
|
#
|
84
84
|
# @param contract_id [String] ID of the contract being edited
|
85
85
|
#
|
86
86
|
# @param customer_id [String] ID of the customer whose contract is being edited
|
87
87
|
#
|
88
|
-
# @param add_commits [Array<MetronomeSDK::V2::ContractEditParams::AddCommit>]
|
88
|
+
# @param add_commits [Array<MetronomeSDK::Models::V2::ContractEditParams::AddCommit>]
|
89
89
|
#
|
90
|
-
# @param add_credits [Array<MetronomeSDK::V2::ContractEditParams::AddCredit>]
|
90
|
+
# @param add_credits [Array<MetronomeSDK::Models::V2::ContractEditParams::AddCredit>]
|
91
91
|
#
|
92
|
-
# @param add_discounts [Array<MetronomeSDK::V2::ContractEditParams::AddDiscount>]
|
92
|
+
# @param add_discounts [Array<MetronomeSDK::Models::V2::ContractEditParams::AddDiscount>]
|
93
93
|
#
|
94
|
-
# @param add_overrides [Array<MetronomeSDK::V2::ContractEditParams::AddOverride>]
|
94
|
+
# @param add_overrides [Array<MetronomeSDK::Models::V2::ContractEditParams::AddOverride>]
|
95
95
|
#
|
96
|
-
# @param add_prepaid_balance_threshold_configuration [MetronomeSDK::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration]
|
96
|
+
# @param add_prepaid_balance_threshold_configuration [MetronomeSDK::Models::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration]
|
97
97
|
#
|
98
|
-
# @param add_professional_services [Array<MetronomeSDK::V2::ContractEditParams::AddProfessionalService>] This field's availability is dependent on your client's configuration.
|
98
|
+
# @param add_professional_services [Array<MetronomeSDK::Models::V2::ContractEditParams::AddProfessionalService>] This field's availability is dependent on your client's configuration.
|
99
99
|
#
|
100
|
-
# @param add_recurring_commits [Array<MetronomeSDK::V2::ContractEditParams::AddRecurringCommit>]
|
100
|
+
# @param add_recurring_commits [Array<MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCommit>]
|
101
101
|
#
|
102
|
-
# @param add_recurring_credits [Array<MetronomeSDK::V2::ContractEditParams::AddRecurringCredit>]
|
102
|
+
# @param add_recurring_credits [Array<MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCredit>]
|
103
103
|
#
|
104
|
-
# @param add_reseller_royalties [Array<MetronomeSDK::V2::ContractEditParams::AddResellerRoyalty>]
|
104
|
+
# @param add_reseller_royalties [Array<MetronomeSDK::Models::V2::ContractEditParams::AddResellerRoyalty>]
|
105
105
|
#
|
106
|
-
# @param add_scheduled_charges [Array<MetronomeSDK::V2::ContractEditParams::AddScheduledCharge>]
|
106
|
+
# @param add_scheduled_charges [Array<MetronomeSDK::Models::V2::ContractEditParams::AddScheduledCharge>]
|
107
107
|
#
|
108
|
-
# @param add_spend_threshold_configuration [MetronomeSDK::V2::ContractEditParams::AddSpendThresholdConfiguration]
|
108
|
+
# @param add_spend_threshold_configuration [MetronomeSDK::Models::V2::ContractEditParams::AddSpendThresholdConfiguration]
|
109
|
+
#
|
110
|
+
# @param add_subscriptions [Array<MetronomeSDK::Models::V2::ContractEditParams::AddSubscription>] Optional list of [subscriptions](https://docs.metronome.com/manage-product-acces
|
109
111
|
#
|
110
112
|
# @param allow_contract_ending_before_finalized_invoice [Boolean] If true, allows setting the contract end date earlier than the end_timestamp of
|
111
113
|
#
|
112
|
-
# @param archive_commits [Array<MetronomeSDK::V2::ContractEditParams::ArchiveCommit>] IDs of commits to archive
|
114
|
+
# @param archive_commits [Array<MetronomeSDK::Models::V2::ContractEditParams::ArchiveCommit>] IDs of commits to archive
|
115
|
+
#
|
116
|
+
# @param archive_credits [Array<MetronomeSDK::Models::V2::ContractEditParams::ArchiveCredit>] IDs of credits to archive
|
117
|
+
#
|
118
|
+
# @param archive_scheduled_charges [Array<MetronomeSDK::Models::V2::ContractEditParams::ArchiveScheduledCharge>] IDs of scheduled charges to archive
|
119
|
+
#
|
120
|
+
# @param remove_overrides [Array<MetronomeSDK::Models::V2::ContractEditParams::RemoveOverride>] IDs of overrides to remove
|
113
121
|
#
|
114
|
-
# @param
|
122
|
+
# @param update_commits [Array<MetronomeSDK::Models::V2::ContractEditParams::UpdateCommit>]
|
115
123
|
#
|
116
|
-
# @param
|
124
|
+
# @param update_contract_end_date [Time, nil] RFC 3339 timestamp indicating when the contract will end (exclusive).
|
117
125
|
#
|
118
|
-
# @param
|
126
|
+
# @param update_contract_name [String, nil] Value to update the contract name to. If not provided, the contract name will re
|
119
127
|
#
|
120
|
-
# @param
|
128
|
+
# @param update_credits [Array<MetronomeSDK::Models::V2::ContractEditParams::UpdateCredit>]
|
121
129
|
#
|
122
|
-
# @param
|
130
|
+
# @param update_prepaid_balance_threshold_configuration [MetronomeSDK::Models::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration]
|
123
131
|
#
|
124
|
-
# @param
|
132
|
+
# @param update_recurring_commits [Array<MetronomeSDK::Models::V2::ContractEditParams::UpdateRecurringCommit>] Edits to these recurring commits will only affect commits whose access schedules
|
125
133
|
#
|
126
|
-
# @param
|
134
|
+
# @param update_recurring_credits [Array<MetronomeSDK::Models::V2::ContractEditParams::UpdateRecurringCredit>] Edits to these recurring credits will only affect credits whose access schedules
|
127
135
|
#
|
128
|
-
# @param update_scheduled_charges [Array<MetronomeSDK::V2::ContractEditParams::UpdateScheduledCharge>]
|
136
|
+
# @param update_scheduled_charges [Array<MetronomeSDK::Models::V2::ContractEditParams::UpdateScheduledCharge>]
|
129
137
|
#
|
130
|
-
# @param update_spend_threshold_configuration [MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration]
|
138
|
+
# @param update_spend_threshold_configuration [MetronomeSDK::Models::V2::ContractEditParams::UpdateSpendThresholdConfiguration]
|
139
|
+
#
|
140
|
+
# @param update_subscriptions [Array<MetronomeSDK::Models::V2::ContractEditParams::UpdateSubscription>] Optional list of subscriptions to update.
|
131
141
|
#
|
132
142
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
133
143
|
#
|
@@ -151,24 +161,26 @@ module MetronomeSDK
|
|
151
161
|
# Edit a customer or contract commit. Contract commits can only be edited using
|
152
162
|
# this endpoint if contract editing is enabled.
|
153
163
|
#
|
154
|
-
# @overload edit_commit(commit_id:, customer_id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, invoice_contract_id: nil, invoice_schedule: nil, product_id: nil, request_options: {})
|
164
|
+
# @overload edit_commit(commit_id:, customer_id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, invoice_contract_id: nil, invoice_schedule: nil, product_id: nil, specifiers: nil, request_options: {})
|
155
165
|
#
|
156
166
|
# @param commit_id [String] ID of the commit to edit
|
157
167
|
#
|
158
168
|
# @param customer_id [String] ID of the customer whose commit is being edited
|
159
169
|
#
|
160
|
-
# @param access_schedule [MetronomeSDK::V2::ContractEditCommitParams::AccessSchedule]
|
170
|
+
# @param access_schedule [MetronomeSDK::Models::V2::ContractEditCommitParams::AccessSchedule]
|
161
171
|
#
|
162
|
-
# @param applicable_product_ids [Array<String>, nil] Which products the commit applies to. If
|
172
|
+
# @param applicable_product_ids [Array<String>, nil] Which products the commit applies to. If applicable_product_ids, applicable_prod
|
163
173
|
#
|
164
|
-
# @param applicable_product_tags [Array<String>, nil] Which tags the commit applies to. If
|
174
|
+
# @param applicable_product_tags [Array<String>, nil] Which tags the commit applies to. If applicable*product_ids, applicable_product*
|
165
175
|
#
|
166
176
|
# @param invoice_contract_id [String] ID of contract to use for invoicing
|
167
177
|
#
|
168
|
-
# @param invoice_schedule [MetronomeSDK::V2::ContractEditCommitParams::InvoiceSchedule]
|
178
|
+
# @param invoice_schedule [MetronomeSDK::Models::V2::ContractEditCommitParams::InvoiceSchedule]
|
169
179
|
#
|
170
180
|
# @param product_id [String]
|
171
181
|
#
|
182
|
+
# @param specifiers [Array<MetronomeSDK::Models::V2::ContractEditCommitParams::Specifier>, nil] List of filters that determine what kind of customer usage draws down a commit o
|
183
|
+
#
|
172
184
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
173
185
|
#
|
174
186
|
# @return [MetronomeSDK::Models::V2::ContractEditCommitResponse]
|
@@ -191,13 +203,13 @@ module MetronomeSDK
|
|
191
203
|
# Edit a customer or contract credit. Contract credits can only be edited using
|
192
204
|
# this endpoint if contract editing is enabled.
|
193
205
|
#
|
194
|
-
# @overload edit_credit(credit_id:, customer_id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, product_id: nil, request_options: {})
|
206
|
+
# @overload edit_credit(credit_id:, customer_id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, product_id: nil, specifiers: nil, request_options: {})
|
195
207
|
#
|
196
208
|
# @param credit_id [String] ID of the credit to edit
|
197
209
|
#
|
198
210
|
# @param customer_id [String] ID of the customer whose credit is being edited
|
199
211
|
#
|
200
|
-
# @param access_schedule [MetronomeSDK::V2::ContractEditCreditParams::AccessSchedule]
|
212
|
+
# @param access_schedule [MetronomeSDK::Models::V2::ContractEditCreditParams::AccessSchedule]
|
201
213
|
#
|
202
214
|
# @param applicable_product_ids [Array<String>, nil] Which products the credit applies to. If both applicable_product_ids and applica
|
203
215
|
#
|
@@ -205,6 +217,8 @@ module MetronomeSDK
|
|
205
217
|
#
|
206
218
|
# @param product_id [String]
|
207
219
|
#
|
220
|
+
# @param specifiers [Array<MetronomeSDK::Models::V2::ContractEditCreditParams::Specifier>, nil] List of filters that determine what kind of customer usage draws down a commit o
|
221
|
+
#
|
208
222
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
209
223
|
#
|
210
224
|
# @return [MetronomeSDK::Models::V2::ContractEditCreditResponse]
|
data/lib/metronome_sdk.rb
CHANGED
@@ -20,7 +20,9 @@ require "uri"
|
|
20
20
|
|
21
21
|
# We already ship the preferred sorbet manifests in the package itself.
|
22
22
|
# `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
|
23
|
-
if Object.const_defined?(:Tapioca) &&
|
23
|
+
if Object.const_defined?(:Tapioca) &&
|
24
|
+
caller.chain([$PROGRAM_NAME]).chain(ARGV).any?(/tapioca/) &&
|
25
|
+
ARGV.none?(/dsl/)
|
24
26
|
return
|
25
27
|
end
|
26
28
|
|
@@ -97,6 +99,8 @@ require_relative "metronome_sdk/models/v1/contract_retrieve_params"
|
|
97
99
|
require_relative "metronome_sdk/models/v1/contract_retrieve_rate_schedule_params"
|
98
100
|
require_relative "metronome_sdk/models/v1/contract_retrieve_rate_schedule_response"
|
99
101
|
require_relative "metronome_sdk/models/v1/contract_retrieve_response"
|
102
|
+
require_relative "metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_params"
|
103
|
+
require_relative "metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_response"
|
100
104
|
require_relative "metronome_sdk/models/v1/contracts/named_schedule_retrieve_params"
|
101
105
|
require_relative "metronome_sdk/models/v1/contracts/named_schedule_retrieve_response"
|
102
106
|
require_relative "metronome_sdk/models/v1/contracts/named_schedule_update_params"
|
@@ -165,6 +169,8 @@ require_relative "metronome_sdk/models/v1/customer_list_billable_metrics_respons
|
|
165
169
|
require_relative "metronome_sdk/models/v1/customer_list_costs_params"
|
166
170
|
require_relative "metronome_sdk/models/v1/customer_list_costs_response"
|
167
171
|
require_relative "metronome_sdk/models/v1/customer_list_params"
|
172
|
+
require_relative "metronome_sdk/models/v1/customer_preview_events_params"
|
173
|
+
require_relative "metronome_sdk/models/v1/customer_preview_events_response"
|
168
174
|
require_relative "metronome_sdk/models/v1/customer_retrieve_params"
|
169
175
|
require_relative "metronome_sdk/models/v1/customer_retrieve_response"
|
170
176
|
require_relative "metronome_sdk/models/v1/customers/alert_list_params"
|
@@ -243,6 +249,8 @@ require_relative "metronome_sdk/models/v1/usage_list_params"
|
|
243
249
|
require_relative "metronome_sdk/models/v1/usage_list_response"
|
244
250
|
require_relative "metronome_sdk/models/v1/usage_list_with_groups_params"
|
245
251
|
require_relative "metronome_sdk/models/v1/usage_list_with_groups_response"
|
252
|
+
require_relative "metronome_sdk/models/v1/usage_search_params"
|
253
|
+
require_relative "metronome_sdk/models/v1/usage_search_response"
|
246
254
|
require_relative "metronome_sdk/models/v2/contract_edit_commit_params"
|
247
255
|
require_relative "metronome_sdk/models/v2/contract_edit_commit_response"
|
248
256
|
require_relative "metronome_sdk/models/v2/contract_edit_credit_params"
|
@@ -8,6 +8,22 @@ module MetronomeSDK
|
|
8
8
|
end
|
9
9
|
|
10
10
|
class ConversionError < MetronomeSDK::Errors::Error
|
11
|
+
sig { returns(T.nilable(StandardError)) }
|
12
|
+
def cause
|
13
|
+
end
|
14
|
+
|
15
|
+
# @api private
|
16
|
+
sig do
|
17
|
+
params(
|
18
|
+
on: T::Class[StandardError],
|
19
|
+
method: Symbol,
|
20
|
+
target: T.anything,
|
21
|
+
value: T.anything,
|
22
|
+
cause: T.nilable(StandardError)
|
23
|
+
).returns(T.attached_class)
|
24
|
+
end
|
25
|
+
def self.new(on:, method:, target:, value:, cause: nil)
|
26
|
+
end
|
11
27
|
end
|
12
28
|
|
13
29
|
class APIError < MetronomeSDK::Errors::Error
|
@@ -22,6 +22,8 @@ module MetronomeSDK
|
|
22
22
|
# https://github.com/golang/go/blob/c8eced8580028328fde7c03cbfcb720ce15b2358/src/net/http/transport.go#L49
|
23
23
|
KEEP_ALIVE_TIMEOUT = 30
|
24
24
|
|
25
|
+
DEFAULT_MAX_CONNECTIONS = T.let(T.unsafe(nil), Integer)
|
26
|
+
|
25
27
|
class << self
|
26
28
|
# @api private
|
27
29
|
sig { params(url: URI::Generic).returns(Net::HTTP) }
|
@@ -68,7 +70,9 @@ module MetronomeSDK
|
|
68
70
|
|
69
71
|
# @api private
|
70
72
|
sig { params(size: Integer).returns(T.attached_class) }
|
71
|
-
def self.new(
|
73
|
+
def self.new(
|
74
|
+
size: MetronomeSDK::Internal::Transport::PooledNetRequester::DEFAULT_MAX_CONNECTIONS
|
75
|
+
)
|
72
76
|
end
|
73
77
|
end
|
74
78
|
end
|
@@ -8,6 +8,7 @@ module MetronomeSDK
|
|
8
8
|
# Array of items of a given type.
|
9
9
|
class ArrayOf
|
10
10
|
include MetronomeSDK::Internal::Type::Converter
|
11
|
+
include MetronomeSDK::Internal::Util::SorbetRuntimeSupport
|
11
12
|
|
12
13
|
abstract!
|
13
14
|
|
@@ -63,6 +64,11 @@ module MetronomeSDK
|
|
63
64
|
def dump(value, state:)
|
64
65
|
end
|
65
66
|
|
67
|
+
# @api private
|
68
|
+
sig { returns(T.anything) }
|
69
|
+
def to_sorbet_type
|
70
|
+
end
|
71
|
+
|
66
72
|
# @api private
|
67
73
|
sig { returns(Elem) }
|
68
74
|
protected def item_type
|
@@ -8,6 +8,7 @@ module MetronomeSDK
|
|
8
8
|
# Ruby has no Boolean class; this is something for models to refer to.
|
9
9
|
class Boolean
|
10
10
|
extend MetronomeSDK::Internal::Type::Converter
|
11
|
+
extend MetronomeSDK::Internal::Util::SorbetRuntimeSupport
|
11
12
|
|
12
13
|
abstract!
|
13
14
|
|
@@ -21,6 +22,8 @@ module MetronomeSDK
|
|
21
22
|
|
22
23
|
class << self
|
23
24
|
# @api private
|
25
|
+
#
|
26
|
+
# Coerce value to Boolean if possible, otherwise return the original value.
|
24
27
|
sig do
|
25
28
|
override
|
26
29
|
.params(
|
@@ -43,6 +46,11 @@ module MetronomeSDK
|
|
43
46
|
end
|
44
47
|
def dump(value, state:)
|
45
48
|
end
|
49
|
+
|
50
|
+
# @api private
|
51
|
+
sig { returns(T.anything) }
|
52
|
+
def to_sorbet_type
|
53
|
+
end
|
46
54
|
end
|
47
55
|
end
|
48
56
|
end
|