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
@@ -20,7 +20,7 @@ module MetronomeSDK
|
|
20
20
|
|
21
21
|
# @!attribute credit_type
|
22
22
|
#
|
23
|
-
# @return [MetronomeSDK::CreditTypeData, nil]
|
23
|
+
# @return [MetronomeSDK::Models::CreditTypeData, nil]
|
24
24
|
optional :credit_type, -> { MetronomeSDK::CreditTypeData }
|
25
25
|
|
26
26
|
# @!attribute ending_before
|
@@ -52,19 +52,19 @@ module MetronomeSDK
|
|
52
52
|
|
53
53
|
# @!attribute override_specifiers
|
54
54
|
#
|
55
|
-
# @return [Array<MetronomeSDK::Override::OverrideSpecifier>, nil]
|
55
|
+
# @return [Array<MetronomeSDK::Models::Override::OverrideSpecifier>, nil]
|
56
56
|
optional :override_specifiers,
|
57
57
|
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Override::OverrideSpecifier] }
|
58
58
|
|
59
59
|
# @!attribute override_tiers
|
60
60
|
#
|
61
|
-
# @return [Array<MetronomeSDK::Override::OverrideTier>, nil]
|
61
|
+
# @return [Array<MetronomeSDK::Models::Override::OverrideTier>, nil]
|
62
62
|
optional :override_tiers,
|
63
63
|
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Override::OverrideTier] }
|
64
64
|
|
65
65
|
# @!attribute overwrite_rate
|
66
66
|
#
|
67
|
-
# @return [MetronomeSDK::Override::OverwriteRate, nil]
|
67
|
+
# @return [MetronomeSDK::Models::Override::OverwriteRate, nil]
|
68
68
|
optional :overwrite_rate, -> { MetronomeSDK::Override::OverwriteRate }
|
69
69
|
|
70
70
|
# @!attribute price
|
@@ -81,7 +81,7 @@ module MetronomeSDK
|
|
81
81
|
|
82
82
|
# @!attribute product
|
83
83
|
#
|
84
|
-
# @return [MetronomeSDK::Override::Product, nil]
|
84
|
+
# @return [MetronomeSDK::Models::Override::Product, nil]
|
85
85
|
optional :product, -> { MetronomeSDK::Override::Product }
|
86
86
|
|
87
87
|
# @!attribute quantity
|
@@ -92,23 +92,23 @@ module MetronomeSDK
|
|
92
92
|
|
93
93
|
# @!attribute rate_type
|
94
94
|
#
|
95
|
-
# @return [Symbol, MetronomeSDK::Override::RateType, nil]
|
95
|
+
# @return [Symbol, MetronomeSDK::Models::Override::RateType, nil]
|
96
96
|
optional :rate_type, enum: -> { MetronomeSDK::Override::RateType }
|
97
97
|
|
98
98
|
# @!attribute target
|
99
99
|
#
|
100
|
-
# @return [Symbol, MetronomeSDK::Override::Target, nil]
|
100
|
+
# @return [Symbol, MetronomeSDK::Models::Override::Target, nil]
|
101
101
|
optional :target, enum: -> { MetronomeSDK::Override::Target }
|
102
102
|
|
103
103
|
# @!attribute tiers
|
104
104
|
# Only set for TIERED rate_type.
|
105
105
|
#
|
106
|
-
# @return [Array<MetronomeSDK::Tier>, nil]
|
106
|
+
# @return [Array<MetronomeSDK::Models::Tier>, nil]
|
107
107
|
optional :tiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Tier] }
|
108
108
|
|
109
109
|
# @!attribute type
|
110
110
|
#
|
111
|
-
# @return [Symbol, MetronomeSDK::Override::Type, nil]
|
111
|
+
# @return [Symbol, MetronomeSDK::Models::Override::Type, nil]
|
112
112
|
optional :type, enum: -> { MetronomeSDK::Override::Type }
|
113
113
|
|
114
114
|
# @!attribute value
|
@@ -119,8 +119,8 @@ module MetronomeSDK
|
|
119
119
|
optional :value, MetronomeSDK::Internal::Type::HashOf[MetronomeSDK::Internal::Type::Unknown]
|
120
120
|
|
121
121
|
# @!method initialize(id:, starting_at:, applicable_product_tags: nil, credit_type: nil, ending_before: nil, entitled: nil, is_commit_specific: nil, is_prorated: nil, multiplier: nil, override_specifiers: nil, override_tiers: nil, overwrite_rate: nil, price: nil, priority: nil, product: nil, quantity: nil, rate_type: nil, target: nil, tiers: nil, type: nil, value: nil)
|
122
|
-
# Some parameter documentations has been truncated, see
|
123
|
-
# for more details.
|
122
|
+
# Some parameter documentations has been truncated, see
|
123
|
+
# {MetronomeSDK::Models::Override} for more details.
|
124
124
|
#
|
125
125
|
# @param id [String]
|
126
126
|
#
|
@@ -128,7 +128,7 @@ module MetronomeSDK
|
|
128
128
|
#
|
129
129
|
# @param applicable_product_tags [Array<String>]
|
130
130
|
#
|
131
|
-
# @param credit_type [MetronomeSDK::CreditTypeData]
|
131
|
+
# @param credit_type [MetronomeSDK::Models::CreditTypeData]
|
132
132
|
#
|
133
133
|
# @param ending_before [Time]
|
134
134
|
#
|
@@ -140,31 +140,36 @@ module MetronomeSDK
|
|
140
140
|
#
|
141
141
|
# @param multiplier [Float]
|
142
142
|
#
|
143
|
-
# @param override_specifiers [Array<MetronomeSDK::Override::OverrideSpecifier>]
|
143
|
+
# @param override_specifiers [Array<MetronomeSDK::Models::Override::OverrideSpecifier>]
|
144
144
|
#
|
145
|
-
# @param override_tiers [Array<MetronomeSDK::Override::OverrideTier>]
|
145
|
+
# @param override_tiers [Array<MetronomeSDK::Models::Override::OverrideTier>]
|
146
146
|
#
|
147
|
-
# @param overwrite_rate [MetronomeSDK::Override::OverwriteRate]
|
147
|
+
# @param overwrite_rate [MetronomeSDK::Models::Override::OverwriteRate]
|
148
148
|
#
|
149
149
|
# @param price [Float] Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type, t
|
150
150
|
#
|
151
151
|
# @param priority [Float]
|
152
152
|
#
|
153
|
-
# @param product [MetronomeSDK::Override::Product]
|
153
|
+
# @param product [MetronomeSDK::Models::Override::Product]
|
154
154
|
#
|
155
155
|
# @param quantity [Float] Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
|
156
156
|
#
|
157
|
-
# @param rate_type [Symbol, MetronomeSDK::Override::RateType]
|
157
|
+
# @param rate_type [Symbol, MetronomeSDK::Models::Override::RateType]
|
158
158
|
#
|
159
|
-
# @param target [Symbol, MetronomeSDK::Override::Target]
|
159
|
+
# @param target [Symbol, MetronomeSDK::Models::Override::Target]
|
160
160
|
#
|
161
|
-
# @param tiers [Array<MetronomeSDK::Tier>] Only set for TIERED rate_type.
|
161
|
+
# @param tiers [Array<MetronomeSDK::Models::Tier>] Only set for TIERED rate_type.
|
162
162
|
#
|
163
|
-
# @param type [Symbol, MetronomeSDK::Override::Type]
|
163
|
+
# @param type [Symbol, MetronomeSDK::Models::Override::Type]
|
164
164
|
#
|
165
165
|
# @param value [Hash{Symbol=>Object}] Only set for CUSTOM rate_type. This field is interpreted by custom rate processo
|
166
166
|
|
167
167
|
class OverrideSpecifier < MetronomeSDK::Internal::Type::BaseModel
|
168
|
+
# @!attribute billing_frequency
|
169
|
+
#
|
170
|
+
# @return [Symbol, MetronomeSDK::Models::Override::OverrideSpecifier::BillingFrequency, nil]
|
171
|
+
optional :billing_frequency, enum: -> { MetronomeSDK::Override::OverrideSpecifier::BillingFrequency }
|
172
|
+
|
168
173
|
# @!attribute commit_ids
|
169
174
|
#
|
170
175
|
# @return [Array<String>, nil]
|
@@ -200,7 +205,8 @@ module MetronomeSDK
|
|
200
205
|
# @return [Array<String>, nil]
|
201
206
|
optional :recurring_credit_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
|
202
207
|
|
203
|
-
# @!method initialize(commit_ids: nil, presentation_group_values: nil, pricing_group_values: nil, product_id: nil, product_tags: nil, recurring_commit_ids: nil, recurring_credit_ids: nil)
|
208
|
+
# @!method initialize(billing_frequency: nil, commit_ids: nil, presentation_group_values: nil, pricing_group_values: nil, product_id: nil, product_tags: nil, recurring_commit_ids: nil, recurring_credit_ids: nil)
|
209
|
+
# @param billing_frequency [Symbol, MetronomeSDK::Models::Override::OverrideSpecifier::BillingFrequency]
|
204
210
|
# @param commit_ids [Array<String>]
|
205
211
|
# @param presentation_group_values [Hash{Symbol=>String, nil}]
|
206
212
|
# @param pricing_group_values [Hash{Symbol=>String}]
|
@@ -208,6 +214,19 @@ module MetronomeSDK
|
|
208
214
|
# @param product_tags [Array<String>]
|
209
215
|
# @param recurring_commit_ids [Array<String>]
|
210
216
|
# @param recurring_credit_ids [Array<String>]
|
217
|
+
|
218
|
+
# @see MetronomeSDK::Models::Override::OverrideSpecifier#billing_frequency
|
219
|
+
module BillingFrequency
|
220
|
+
extend MetronomeSDK::Internal::Type::Enum
|
221
|
+
|
222
|
+
MONTHLY = :MONTHLY
|
223
|
+
QUARTERLY = :QUARTERLY
|
224
|
+
ANNUAL = :ANNUAL
|
225
|
+
WEEKLY = :WEEKLY
|
226
|
+
|
227
|
+
# @!method self.values
|
228
|
+
# @return [Array<Symbol>]
|
229
|
+
end
|
211
230
|
end
|
212
231
|
|
213
232
|
class OverrideTier < MetronomeSDK::Internal::Type::BaseModel
|
@@ -226,16 +245,16 @@ module MetronomeSDK
|
|
226
245
|
# @param size [Float]
|
227
246
|
end
|
228
247
|
|
229
|
-
# @see MetronomeSDK::Override#overwrite_rate
|
248
|
+
# @see MetronomeSDK::Models::Override#overwrite_rate
|
230
249
|
class OverwriteRate < MetronomeSDK::Internal::Type::BaseModel
|
231
250
|
# @!attribute rate_type
|
232
251
|
#
|
233
|
-
# @return [Symbol, MetronomeSDK::Override::OverwriteRate::RateType]
|
252
|
+
# @return [Symbol, MetronomeSDK::Models::Override::OverwriteRate::RateType]
|
234
253
|
required :rate_type, enum: -> { MetronomeSDK::Override::OverwriteRate::RateType }
|
235
254
|
|
236
255
|
# @!attribute credit_type
|
237
256
|
#
|
238
|
-
# @return [MetronomeSDK::CreditTypeData, nil]
|
257
|
+
# @return [MetronomeSDK::Models::CreditTypeData, nil]
|
239
258
|
optional :credit_type, -> { MetronomeSDK::CreditTypeData }
|
240
259
|
|
241
260
|
# @!attribute custom_rate
|
@@ -268,16 +287,16 @@ module MetronomeSDK
|
|
268
287
|
# @!attribute tiers
|
269
288
|
# Only set for TIERED rate_type.
|
270
289
|
#
|
271
|
-
# @return [Array<MetronomeSDK::Tier>, nil]
|
290
|
+
# @return [Array<MetronomeSDK::Models::Tier>, nil]
|
272
291
|
optional :tiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Tier] }
|
273
292
|
|
274
293
|
# @!method initialize(rate_type:, credit_type: nil, custom_rate: nil, is_prorated: nil, price: nil, quantity: nil, tiers: nil)
|
275
294
|
# Some parameter documentations has been truncated, see
|
276
|
-
# {MetronomeSDK::Override::OverwriteRate} for more details.
|
295
|
+
# {MetronomeSDK::Models::Override::OverwriteRate} for more details.
|
277
296
|
#
|
278
|
-
# @param rate_type [Symbol, MetronomeSDK::Override::OverwriteRate::RateType]
|
297
|
+
# @param rate_type [Symbol, MetronomeSDK::Models::Override::OverwriteRate::RateType]
|
279
298
|
#
|
280
|
-
# @param credit_type [MetronomeSDK::CreditTypeData]
|
299
|
+
# @param credit_type [MetronomeSDK::Models::CreditTypeData]
|
281
300
|
#
|
282
301
|
# @param custom_rate [Hash{Symbol=>Object}] Only set for CUSTOM rate_type. This field is interpreted by custom rate processo
|
283
302
|
#
|
@@ -287,9 +306,9 @@ module MetronomeSDK
|
|
287
306
|
#
|
288
307
|
# @param quantity [Float] Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
|
289
308
|
#
|
290
|
-
# @param tiers [Array<MetronomeSDK::Tier>] Only set for TIERED rate_type.
|
309
|
+
# @param tiers [Array<MetronomeSDK::Models::Tier>] Only set for TIERED rate_type.
|
291
310
|
|
292
|
-
# @see MetronomeSDK::Override::OverwriteRate#rate_type
|
311
|
+
# @see MetronomeSDK::Models::Override::OverwriteRate#rate_type
|
293
312
|
module RateType
|
294
313
|
extend MetronomeSDK::Internal::Type::Enum
|
295
314
|
|
@@ -304,7 +323,7 @@ module MetronomeSDK
|
|
304
323
|
end
|
305
324
|
end
|
306
325
|
|
307
|
-
# @see MetronomeSDK::Override#product
|
326
|
+
# @see MetronomeSDK::Models::Override#product
|
308
327
|
class Product < MetronomeSDK::Internal::Type::BaseModel
|
309
328
|
# @!attribute id
|
310
329
|
#
|
@@ -321,7 +340,7 @@ module MetronomeSDK
|
|
321
340
|
# @param name [String]
|
322
341
|
end
|
323
342
|
|
324
|
-
# @see MetronomeSDK::Override#rate_type
|
343
|
+
# @see MetronomeSDK::Models::Override#rate_type
|
325
344
|
module RateType
|
326
345
|
extend MetronomeSDK::Internal::Type::Enum
|
327
346
|
|
@@ -335,7 +354,7 @@ module MetronomeSDK
|
|
335
354
|
# @return [Array<Symbol>]
|
336
355
|
end
|
337
356
|
|
338
|
-
# @see MetronomeSDK::Override#target
|
357
|
+
# @see MetronomeSDK::Models::Override#target
|
339
358
|
module Target
|
340
359
|
extend MetronomeSDK::Internal::Type::Enum
|
341
360
|
|
@@ -346,7 +365,7 @@ module MetronomeSDK
|
|
346
365
|
# @return [Array<Symbol>]
|
347
366
|
end
|
348
367
|
|
349
|
-
# @see MetronomeSDK::Override#type
|
368
|
+
# @see MetronomeSDK::Models::Override#type
|
350
369
|
module Type
|
351
370
|
extend MetronomeSDK::Internal::Type::Enum
|
352
371
|
|
@@ -50,8 +50,8 @@ module MetronomeSDK
|
|
50
50
|
optional :netsuite_sales_order_id, String
|
51
51
|
|
52
52
|
# @!method initialize(id:, max_amount:, product_id:, quantity:, unit_price:, custom_fields: nil, description: nil, netsuite_sales_order_id: nil)
|
53
|
-
# Some parameter documentations has been truncated, see
|
54
|
-
# for more details.
|
53
|
+
# Some parameter documentations has been truncated, see
|
54
|
+
# {MetronomeSDK::Models::ProService} for more details.
|
55
55
|
#
|
56
56
|
# @param id [String]
|
57
57
|
#
|
@@ -38,7 +38,7 @@ module MetronomeSDK
|
|
38
38
|
|
39
39
|
# @!method initialize(name:, exists: nil, in_values: nil, not_in_values: nil)
|
40
40
|
# Some parameter documentations has been truncated, see
|
41
|
-
# {MetronomeSDK::PropertyFilter} for more details.
|
41
|
+
# {MetronomeSDK::Models::PropertyFilter} for more details.
|
42
42
|
#
|
43
43
|
# @param name [String] The name of the event property.
|
44
44
|
#
|
@@ -5,12 +5,12 @@ module MetronomeSDK
|
|
5
5
|
class Rate < MetronomeSDK::Internal::Type::BaseModel
|
6
6
|
# @!attribute rate_type
|
7
7
|
#
|
8
|
-
# @return [Symbol, MetronomeSDK::Rate::RateType]
|
8
|
+
# @return [Symbol, MetronomeSDK::Models::Rate::RateType]
|
9
9
|
required :rate_type, enum: -> { MetronomeSDK::Rate::RateType }
|
10
10
|
|
11
11
|
# @!attribute credit_type
|
12
12
|
#
|
13
|
-
# @return [MetronomeSDK::CreditTypeData, nil]
|
13
|
+
# @return [MetronomeSDK::Models::CreditTypeData, nil]
|
14
14
|
optional :credit_type, -> { MetronomeSDK::CreditTypeData }
|
15
15
|
|
16
16
|
# @!attribute custom_rate
|
@@ -50,7 +50,7 @@ module MetronomeSDK
|
|
50
50
|
# @!attribute tiers
|
51
51
|
# Only set for TIERED rate_type.
|
52
52
|
#
|
53
|
-
# @return [Array<MetronomeSDK::Tier>, nil]
|
53
|
+
# @return [Array<MetronomeSDK::Models::Tier>, nil]
|
54
54
|
optional :tiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Tier] }
|
55
55
|
|
56
56
|
# @!attribute use_list_prices
|
@@ -62,12 +62,12 @@ module MetronomeSDK
|
|
62
62
|
optional :use_list_prices, MetronomeSDK::Internal::Type::Boolean
|
63
63
|
|
64
64
|
# @!method initialize(rate_type:, credit_type: nil, custom_rate: nil, is_prorated: nil, price: nil, pricing_group_values: nil, quantity: nil, tiers: nil, use_list_prices: nil)
|
65
|
-
# Some parameter documentations has been truncated, see
|
66
|
-
# more details.
|
65
|
+
# Some parameter documentations has been truncated, see
|
66
|
+
# {MetronomeSDK::Models::Rate} for more details.
|
67
67
|
#
|
68
|
-
# @param rate_type [Symbol, MetronomeSDK::Rate::RateType]
|
68
|
+
# @param rate_type [Symbol, MetronomeSDK::Models::Rate::RateType]
|
69
69
|
#
|
70
|
-
# @param credit_type [MetronomeSDK::CreditTypeData]
|
70
|
+
# @param credit_type [MetronomeSDK::Models::CreditTypeData]
|
71
71
|
#
|
72
72
|
# @param custom_rate [Hash{Symbol=>Object}] Only set for CUSTOM rate_type. This field is interpreted by custom rate processo
|
73
73
|
#
|
@@ -79,11 +79,11 @@ module MetronomeSDK
|
|
79
79
|
#
|
80
80
|
# @param quantity [Float] Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
|
81
81
|
#
|
82
|
-
# @param tiers [Array<MetronomeSDK::Tier>] Only set for TIERED rate_type.
|
82
|
+
# @param tiers [Array<MetronomeSDK::Models::Tier>] Only set for TIERED rate_type.
|
83
83
|
#
|
84
84
|
# @param use_list_prices [Boolean] Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
|
85
85
|
|
86
|
-
# @see MetronomeSDK::Rate#rate_type
|
86
|
+
# @see MetronomeSDK::Models::Rate#rate_type
|
87
87
|
module RateType
|
88
88
|
extend MetronomeSDK::Internal::Type::Enum
|
89
89
|
|
@@ -5,18 +5,18 @@ module MetronomeSDK
|
|
5
5
|
class ScheduleDuration < MetronomeSDK::Internal::Type::BaseModel
|
6
6
|
# @!attribute schedule_items
|
7
7
|
#
|
8
|
-
# @return [Array<MetronomeSDK::ScheduleDuration::ScheduleItem>]
|
8
|
+
# @return [Array<MetronomeSDK::Models::ScheduleDuration::ScheduleItem>]
|
9
9
|
required :schedule_items,
|
10
10
|
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ScheduleDuration::ScheduleItem] }
|
11
11
|
|
12
12
|
# @!attribute credit_type
|
13
13
|
#
|
14
|
-
# @return [MetronomeSDK::CreditTypeData, nil]
|
14
|
+
# @return [MetronomeSDK::Models::CreditTypeData, nil]
|
15
15
|
optional :credit_type, -> { MetronomeSDK::CreditTypeData }
|
16
16
|
|
17
17
|
# @!method initialize(schedule_items:, credit_type: nil)
|
18
|
-
# @param schedule_items [Array<MetronomeSDK::ScheduleDuration::ScheduleItem>]
|
19
|
-
# @param credit_type [MetronomeSDK::CreditTypeData]
|
18
|
+
# @param schedule_items [Array<MetronomeSDK::Models::ScheduleDuration::ScheduleItem>]
|
19
|
+
# @param credit_type [MetronomeSDK::Models::CreditTypeData]
|
20
20
|
|
21
21
|
class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
|
22
22
|
# @!attribute id
|
@@ -5,18 +5,18 @@ module MetronomeSDK
|
|
5
5
|
class SchedulePointInTime < MetronomeSDK::Internal::Type::BaseModel
|
6
6
|
# @!attribute credit_type
|
7
7
|
#
|
8
|
-
# @return [MetronomeSDK::CreditTypeData, nil]
|
8
|
+
# @return [MetronomeSDK::Models::CreditTypeData, nil]
|
9
9
|
optional :credit_type, -> { MetronomeSDK::CreditTypeData }
|
10
10
|
|
11
11
|
# @!attribute schedule_items
|
12
12
|
#
|
13
|
-
# @return [Array<MetronomeSDK::SchedulePointInTime::ScheduleItem>, nil]
|
13
|
+
# @return [Array<MetronomeSDK::Models::SchedulePointInTime::ScheduleItem>, nil]
|
14
14
|
optional :schedule_items,
|
15
15
|
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::SchedulePointInTime::ScheduleItem] }
|
16
16
|
|
17
17
|
# @!method initialize(credit_type: nil, schedule_items: nil)
|
18
|
-
# @param credit_type [MetronomeSDK::CreditTypeData]
|
19
|
-
# @param schedule_items [Array<MetronomeSDK::SchedulePointInTime::ScheduleItem>]
|
18
|
+
# @param credit_type [MetronomeSDK::Models::CreditTypeData]
|
19
|
+
# @param schedule_items [Array<MetronomeSDK::Models::SchedulePointInTime::ScheduleItem>]
|
20
20
|
|
21
21
|
class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
|
22
22
|
# @!attribute id
|
@@ -29,11 +29,6 @@ module MetronomeSDK
|
|
29
29
|
# @return [Float]
|
30
30
|
required :amount, Float
|
31
31
|
|
32
|
-
# @!attribute invoice_id
|
33
|
-
#
|
34
|
-
# @return [String]
|
35
|
-
required :invoice_id, String
|
36
|
-
|
37
32
|
# @!attribute quantity
|
38
33
|
#
|
39
34
|
# @return [Float]
|
@@ -49,13 +44,18 @@ module MetronomeSDK
|
|
49
44
|
# @return [Float]
|
50
45
|
required :unit_price, Float
|
51
46
|
|
52
|
-
# @!
|
47
|
+
# @!attribute invoice_id
|
48
|
+
#
|
49
|
+
# @return [String, nil]
|
50
|
+
optional :invoice_id, String, nil?: true
|
51
|
+
|
52
|
+
# @!method initialize(id:, amount:, quantity:, timestamp:, unit_price:, invoice_id: nil)
|
53
53
|
# @param id [String]
|
54
54
|
# @param amount [Float]
|
55
|
-
# @param invoice_id [String]
|
56
55
|
# @param quantity [Float]
|
57
56
|
# @param timestamp [Time]
|
58
57
|
# @param unit_price [Float]
|
58
|
+
# @param invoice_id [String, nil]
|
59
59
|
end
|
60
60
|
end
|
61
61
|
end
|
@@ -10,12 +10,12 @@ module MetronomeSDK
|
|
10
10
|
|
11
11
|
# @!attribute product
|
12
12
|
#
|
13
|
-
# @return [MetronomeSDK::ScheduledCharge::Product]
|
13
|
+
# @return [MetronomeSDK::Models::ScheduledCharge::Product]
|
14
14
|
required :product, -> { MetronomeSDK::ScheduledCharge::Product }
|
15
15
|
|
16
16
|
# @!attribute schedule
|
17
17
|
#
|
18
|
-
# @return [MetronomeSDK::SchedulePointInTime]
|
18
|
+
# @return [MetronomeSDK::Models::SchedulePointInTime]
|
19
19
|
required :schedule, -> { MetronomeSDK::SchedulePointInTime }
|
20
20
|
|
21
21
|
# @!attribute archived_at
|
@@ -43,9 +43,9 @@ module MetronomeSDK
|
|
43
43
|
# @!method initialize(id:, product:, schedule:, archived_at: nil, custom_fields: nil, name: nil, netsuite_sales_order_id: nil)
|
44
44
|
# @param id [String]
|
45
45
|
#
|
46
|
-
# @param product [MetronomeSDK::ScheduledCharge::Product]
|
46
|
+
# @param product [MetronomeSDK::Models::ScheduledCharge::Product]
|
47
47
|
#
|
48
|
-
# @param schedule [MetronomeSDK::SchedulePointInTime]
|
48
|
+
# @param schedule [MetronomeSDK::Models::SchedulePointInTime]
|
49
49
|
#
|
50
50
|
# @param archived_at [Time]
|
51
51
|
#
|
@@ -55,7 +55,7 @@ module MetronomeSDK
|
|
55
55
|
#
|
56
56
|
# @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
|
57
57
|
|
58
|
-
# @see MetronomeSDK::ScheduledCharge#product
|
58
|
+
# @see MetronomeSDK::Models::ScheduledCharge#product
|
59
59
|
class Product < MetronomeSDK::Internal::Type::BaseModel
|
60
60
|
# @!attribute id
|
61
61
|
#
|
@@ -7,11 +7,11 @@ module MetronomeSDK
|
|
7
7
|
class AlertArchiveResponse < MetronomeSDK::Internal::Type::BaseModel
|
8
8
|
# @!attribute data
|
9
9
|
#
|
10
|
-
# @return [MetronomeSDK::ID]
|
10
|
+
# @return [MetronomeSDK::Models::ID]
|
11
11
|
required :data, -> { MetronomeSDK::ID }
|
12
12
|
|
13
13
|
# @!method initialize(data:)
|
14
|
-
# @param data [MetronomeSDK::ID]
|
14
|
+
# @param data [MetronomeSDK::Models::ID]
|
15
15
|
end
|
16
16
|
end
|
17
17
|
end
|
@@ -11,7 +11,7 @@ module MetronomeSDK
|
|
11
11
|
# @!attribute alert_type
|
12
12
|
# Type of the alert
|
13
13
|
#
|
14
|
-
# @return [Symbol, MetronomeSDK::V1::AlertCreateParams::AlertType]
|
14
|
+
# @return [Symbol, MetronomeSDK::Models::V1::AlertCreateParams::AlertType]
|
15
15
|
required :alert_type, enum: -> { MetronomeSDK::V1::AlertCreateParams::AlertType }
|
16
16
|
|
17
17
|
# @!attribute name
|
@@ -43,6 +43,9 @@ module MetronomeSDK
|
|
43
43
|
optional :credit_grant_type_filters, MetronomeSDK::Internal::Type::ArrayOf[String]
|
44
44
|
|
45
45
|
# @!attribute credit_type_id
|
46
|
+
# ID of the credit's currency, defaults to USD. If the specific alert type
|
47
|
+
# requires a pricing unit/currency, find the ID in the
|
48
|
+
# [Metronome app](https://app.metronome.com/offering/pricing-units).
|
46
49
|
#
|
47
50
|
# @return [String, nil]
|
48
51
|
optional :credit_type_id, String
|
@@ -51,7 +54,7 @@ module MetronomeSDK
|
|
51
54
|
# A list of custom field filters for alert types that support advanced filtering.
|
52
55
|
# Only present for contract invoices.
|
53
56
|
#
|
54
|
-
# @return [Array<MetronomeSDK::V1::AlertCreateParams::CustomFieldFilter>, nil]
|
57
|
+
# @return [Array<MetronomeSDK::Models::V1::AlertCreateParams::CustomFieldFilter>, nil]
|
55
58
|
optional :custom_field_filters,
|
56
59
|
-> {
|
57
60
|
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::AlertCreateParams::CustomFieldFilter]
|
@@ -59,7 +62,7 @@ module MetronomeSDK
|
|
59
62
|
|
60
63
|
# @!attribute customer_id
|
61
64
|
# If provided, will create this alert for this specific customer. To create an
|
62
|
-
# alert for all customers, do not specify `customer_id
|
65
|
+
# alert for all customers, do not specify a `customer_id`.
|
63
66
|
#
|
64
67
|
# @return [String, nil]
|
65
68
|
optional :customer_id, String
|
@@ -76,7 +79,7 @@ module MetronomeSDK
|
|
76
79
|
# Scopes alert evaluation to a specific presentation group key on individual line
|
77
80
|
# items. Only present for spend alerts.
|
78
81
|
#
|
79
|
-
# @return [MetronomeSDK::V1::AlertCreateParams::GroupKeyFilter, nil]
|
82
|
+
# @return [MetronomeSDK::Models::V1::AlertCreateParams::GroupKeyFilter, nil]
|
80
83
|
optional :group_key_filter, -> { MetronomeSDK::V1::AlertCreateParams::GroupKeyFilter }
|
81
84
|
|
82
85
|
# @!attribute invoice_types_filter
|
@@ -88,7 +91,7 @@ module MetronomeSDK
|
|
88
91
|
|
89
92
|
# @!attribute plan_id
|
90
93
|
# If provided, will create this alert for this specific plan. To create an alert
|
91
|
-
# for all customers, do not specify
|
94
|
+
# for all customers, do not specify a `plan_id`.
|
92
95
|
#
|
93
96
|
# @return [String, nil]
|
94
97
|
optional :plan_id, String
|
@@ -105,7 +108,7 @@ module MetronomeSDK
|
|
105
108
|
# Some parameter documentations has been truncated, see
|
106
109
|
# {MetronomeSDK::Models::V1::AlertCreateParams} for more details.
|
107
110
|
#
|
108
|
-
# @param alert_type [Symbol, MetronomeSDK::V1::AlertCreateParams::AlertType] Type of the alert
|
111
|
+
# @param alert_type [Symbol, MetronomeSDK::Models::V1::AlertCreateParams::AlertType] Type of the alert
|
109
112
|
#
|
110
113
|
# @param name [String] Name of the alert
|
111
114
|
#
|
@@ -115,15 +118,15 @@ module MetronomeSDK
|
|
115
118
|
#
|
116
119
|
# @param credit_grant_type_filters [Array<String>] An array of strings, representing a way to filter the credit grant this alert ap
|
117
120
|
#
|
118
|
-
# @param credit_type_id [String]
|
121
|
+
# @param credit_type_id [String] ID of the credit's currency, defaults to USD. If the specific alert type require
|
119
122
|
#
|
120
|
-
# @param custom_field_filters [Array<MetronomeSDK::V1::AlertCreateParams::CustomFieldFilter>] A list of custom field filters for alert types that support advanced filtering.
|
123
|
+
# @param custom_field_filters [Array<MetronomeSDK::Models::V1::AlertCreateParams::CustomFieldFilter>] A list of custom field filters for alert types that support advanced filtering.
|
121
124
|
#
|
122
125
|
# @param customer_id [String] If provided, will create this alert for this specific customer. To create an ale
|
123
126
|
#
|
124
127
|
# @param evaluate_on_create [Boolean] If true, the alert will evaluate immediately on customers that already meet the
|
125
128
|
#
|
126
|
-
# @param group_key_filter [MetronomeSDK::V1::AlertCreateParams::GroupKeyFilter] Scopes alert evaluation to a specific presentation group key on individual line
|
129
|
+
# @param group_key_filter [MetronomeSDK::Models::V1::AlertCreateParams::GroupKeyFilter] Scopes alert evaluation to a specific presentation group key on individual line
|
127
130
|
#
|
128
131
|
# @param invoice_types_filter [Array<String>] Only supported for invoice_total_reached alerts. A list of invoice types to eval
|
129
132
|
#
|
@@ -161,7 +164,7 @@ module MetronomeSDK
|
|
161
164
|
class CustomFieldFilter < MetronomeSDK::Internal::Type::BaseModel
|
162
165
|
# @!attribute entity
|
163
166
|
#
|
164
|
-
# @return [Symbol, MetronomeSDK::V1::AlertCreateParams::CustomFieldFilter::Entity]
|
167
|
+
# @return [Symbol, MetronomeSDK::Models::V1::AlertCreateParams::CustomFieldFilter::Entity]
|
165
168
|
required :entity, enum: -> { MetronomeSDK::V1::AlertCreateParams::CustomFieldFilter::Entity }
|
166
169
|
|
167
170
|
# @!attribute key
|
@@ -175,11 +178,11 @@ module MetronomeSDK
|
|
175
178
|
required :value, String
|
176
179
|
|
177
180
|
# @!method initialize(entity:, key:, value:)
|
178
|
-
# @param entity [Symbol, MetronomeSDK::V1::AlertCreateParams::CustomFieldFilter::Entity]
|
181
|
+
# @param entity [Symbol, MetronomeSDK::Models::V1::AlertCreateParams::CustomFieldFilter::Entity]
|
179
182
|
# @param key [String]
|
180
183
|
# @param value [String]
|
181
184
|
|
182
|
-
# @see MetronomeSDK::V1::AlertCreateParams::CustomFieldFilter#entity
|
185
|
+
# @see MetronomeSDK::Models::V1::AlertCreateParams::CustomFieldFilter#entity
|
183
186
|
module Entity
|
184
187
|
extend MetronomeSDK::Internal::Type::Enum
|
185
188
|
|
@@ -7,11 +7,11 @@ module MetronomeSDK
|
|
7
7
|
class AlertCreateResponse < MetronomeSDK::Internal::Type::BaseModel
|
8
8
|
# @!attribute data
|
9
9
|
#
|
10
|
-
# @return [MetronomeSDK::ID]
|
10
|
+
# @return [MetronomeSDK::Models::ID]
|
11
11
|
required :data, -> { MetronomeSDK::ID }
|
12
12
|
|
13
13
|
# @!method initialize(data:)
|
14
|
-
# @param data [MetronomeSDK::ID]
|
14
|
+
# @param data [MetronomeSDK::Models::ID]
|
15
15
|
end
|
16
16
|
end
|
17
17
|
end
|
@@ -43,7 +43,7 @@ module MetronomeSDK
|
|
43
43
|
# @!attribute sort
|
44
44
|
# Sort order by timestamp, e.g. date_asc or date_desc. Defaults to date_asc.
|
45
45
|
#
|
46
|
-
# @return [Symbol, MetronomeSDK::V1::AuditLogListParams::Sort, nil]
|
46
|
+
# @return [Symbol, MetronomeSDK::Models::V1::AuditLogListParams::Sort, nil]
|
47
47
|
optional :sort, enum: -> { MetronomeSDK::V1::AuditLogListParams::Sort }
|
48
48
|
|
49
49
|
# @!attribute starting_on
|
@@ -67,7 +67,7 @@ module MetronomeSDK
|
|
67
67
|
#
|
68
68
|
# @param resource_type [String] Optional parameter that can be used to filter which audit logs are returned. If
|
69
69
|
#
|
70
|
-
# @param sort [Symbol, MetronomeSDK::V1::AuditLogListParams::Sort] Sort order by timestamp, e.g. date_asc or date_desc. Defaults to date_asc.
|
70
|
+
# @param sort [Symbol, MetronomeSDK::Models::V1::AuditLogListParams::Sort] Sort order by timestamp, e.g. date_asc or date_desc. Defaults to date_asc.
|
71
71
|
#
|
72
72
|
# @param starting_on [Time] RFC 3339 timestamp of the earliest audit log to return. Cannot be used with 'nex
|
73
73
|
#
|
@@ -7,11 +7,11 @@ module MetronomeSDK
|
|
7
7
|
class BillableMetricArchiveResponse < MetronomeSDK::Internal::Type::BaseModel
|
8
8
|
# @!attribute data
|
9
9
|
#
|
10
|
-
# @return [MetronomeSDK::ID]
|
10
|
+
# @return [MetronomeSDK::Models::ID]
|
11
11
|
required :data, -> { MetronomeSDK::ID }
|
12
12
|
|
13
13
|
# @!method initialize(data:)
|
14
|
-
# @param data [MetronomeSDK::ID]
|
14
|
+
# @param data [MetronomeSDK::Models::ID]
|
15
15
|
end
|
16
16
|
end
|
17
17
|
end
|
@@ -24,7 +24,7 @@ module MetronomeSDK
|
|
24
24
|
# @!attribute aggregation_type
|
25
25
|
# Specifies the type of aggregation performed on matching events.
|
26
26
|
#
|
27
|
-
# @return [Symbol, MetronomeSDK::V1::BillableMetricCreateParams::AggregationType, nil]
|
27
|
+
# @return [Symbol, MetronomeSDK::Models::V1::BillableMetricCreateParams::AggregationType, nil]
|
28
28
|
optional :aggregation_type, enum: -> { MetronomeSDK::V1::BillableMetricCreateParams::AggregationType }
|
29
29
|
|
30
30
|
# @!attribute custom_fields
|
@@ -36,7 +36,7 @@ module MetronomeSDK
|
|
36
36
|
# @!attribute event_type_filter
|
37
37
|
# An optional filtering rule to match the 'event_type' property of an event.
|
38
38
|
#
|
39
|
-
# @return [MetronomeSDK::EventTypeFilter, nil]
|
39
|
+
# @return [MetronomeSDK::Models::EventTypeFilter, nil]
|
40
40
|
optional :event_type_filter, -> { MetronomeSDK::EventTypeFilter }
|
41
41
|
|
42
42
|
# @!attribute group_keys
|
@@ -52,7 +52,7 @@ module MetronomeSDK
|
|
52
52
|
# rule on an event property. All rules must pass for the event to match the
|
53
53
|
# billable metric.
|
54
54
|
#
|
55
|
-
# @return [Array<MetronomeSDK::PropertyFilter>, nil]
|
55
|
+
# @return [Array<MetronomeSDK::Models::PropertyFilter>, nil]
|
56
56
|
optional :property_filters, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::PropertyFilter] }
|
57
57
|
|
58
58
|
# @!attribute sql
|
@@ -72,15 +72,15 @@ module MetronomeSDK
|
|
72
72
|
#
|
73
73
|
# @param aggregation_key [String] Specifies the type of aggregation performed on matching events. Required if `sql
|
74
74
|
#
|
75
|
-
# @param aggregation_type [Symbol, MetronomeSDK::V1::BillableMetricCreateParams::AggregationType] Specifies the type of aggregation performed on matching events.
|
75
|
+
# @param aggregation_type [Symbol, MetronomeSDK::Models::V1::BillableMetricCreateParams::AggregationType] Specifies the type of aggregation performed on matching events.
|
76
76
|
#
|
77
77
|
# @param custom_fields [Hash{Symbol=>String}] Custom fields to attach to the billable metric.
|
78
78
|
#
|
79
|
-
# @param event_type_filter [MetronomeSDK::EventTypeFilter] An optional filtering rule to match the 'event_type' property of an event.
|
79
|
+
# @param event_type_filter [MetronomeSDK::Models::EventTypeFilter] An optional filtering rule to match the 'event_type' property of an event.
|
80
80
|
#
|
81
81
|
# @param group_keys [Array<Array<String>>] Property names that are used to group usage costs on an invoice. Each entry repr
|
82
82
|
#
|
83
|
-
# @param property_filters [Array<MetronomeSDK::PropertyFilter>] A list of filters to match events to this billable metric. Each filter defines a
|
83
|
+
# @param property_filters [Array<MetronomeSDK::Models::PropertyFilter>] A list of filters to match events to this billable metric. Each filter defines a
|
84
84
|
#
|
85
85
|
# @param sql [String] The SQL query associated with the billable metric. This field is mutually exclus
|
86
86
|
#
|