metronome-sdk 0.1.0.pre.alpha.1 → 0.1.0.pre.alpha.2
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 +52 -0
- data/README.md +22 -11
- data/lib/metronome_sdk/errors.rb +1 -1
- data/lib/metronome_sdk/file_part.rb +2 -2
- data/lib/metronome_sdk/internal/cursor_page.rb +3 -3
- data/lib/metronome_sdk/internal/transport/base_client.rb +80 -8
- data/lib/metronome_sdk/internal/transport/pooled_net_requester.rb +14 -0
- data/lib/metronome_sdk/internal/type/array_of.rb +1 -1
- data/lib/metronome_sdk/internal/type/base_model.rb +63 -39
- data/lib/metronome_sdk/internal/type/converter.rb +18 -0
- data/lib/metronome_sdk/internal/type/enum.rb +1 -0
- data/lib/metronome_sdk/internal/type/hash_of.rb +1 -1
- data/lib/metronome_sdk/internal/type/request_parameters.rb +6 -12
- data/lib/metronome_sdk/internal/type/union.rb +1 -0
- data/lib/metronome_sdk/internal/util.rb +77 -5
- data/lib/metronome_sdk/internal.rb +6 -0
- data/lib/metronome_sdk/models/commit.rb +129 -110
- data/lib/metronome_sdk/models/contract_without_amendments.rb +245 -239
- data/lib/metronome_sdk/models/credit.rb +68 -60
- data/lib/metronome_sdk/models/discount.rb +7 -7
- data/lib/metronome_sdk/models/event_type_filter.rb +1 -3
- data/lib/metronome_sdk/models/override.rb +45 -51
- data/lib/metronome_sdk/models/pro_service.rb +2 -4
- data/lib/metronome_sdk/models/property_filter.rb +1 -4
- data/lib/metronome_sdk/models/rate.rb +12 -17
- data/lib/metronome_sdk/models/schedule_duration.rb +6 -6
- data/lib/metronome_sdk/models/schedule_point_in_time.rb +6 -6
- data/lib/metronome_sdk/models/scheduled_charge.rb +7 -7
- data/lib/metronome_sdk/models/v1/alert_archive_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/alert_create_params.rb +15 -23
- data/lib/metronome_sdk/models/v1/alert_create_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/audit_log_list_params.rb +3 -6
- data/lib/metronome_sdk/models/v1/billable_metric_archive_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/billable_metric_create_params.rb +9 -15
- data/lib/metronome_sdk/models/v1/billable_metric_create_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/billable_metric_list_response.rb +6 -11
- data/lib/metronome_sdk/models/v1/billable_metric_retrieve_response.rb +8 -10
- data/lib/metronome_sdk/models/v1/contract_add_manual_balance_entry_params.rb +0 -2
- data/lib/metronome_sdk/models/v1/contract_amend_params.rb +229 -234
- data/lib/metronome_sdk/models/v1/contract_amend_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/contract_archive_params.rb +0 -1
- data/lib/metronome_sdk/models/v1/contract_archive_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/contract_create_historical_invoices_params.rb +27 -21
- data/lib/metronome_sdk/models/v1/contract_create_historical_invoices_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/contract_create_params.rb +625 -622
- data/lib/metronome_sdk/models/v1/contract_create_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/contract_list_balances_params.rb +0 -2
- data/lib/metronome_sdk/models/v1/contract_list_balances_response.rb +9 -5
- data/lib/metronome_sdk/models/v1/contract_list_params.rb +0 -4
- data/lib/metronome_sdk/models/v1/contract_list_response.rb +424 -29
- data/lib/metronome_sdk/models/v1/contract_retrieve_params.rb +0 -2
- data/lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rb +7 -10
- data/lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rb +9 -10
- data/lib/metronome_sdk/models/v1/contract_retrieve_response.rb +424 -29
- data/lib/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_params.rb +7 -7
- data/lib/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/contract_update_end_date_params.rb +0 -2
- data/lib/metronome_sdk/models/v1/contract_update_end_date_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/contracts/named_schedule_retrieve_params.rb +0 -1
- data/lib/metronome_sdk/models/v1/contracts/named_schedule_update_params.rb +0 -1
- data/lib/metronome_sdk/models/v1/contracts/product_archive_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/contracts/product_create_params.rb +9 -15
- data/lib/metronome_sdk/models/v1/contracts/product_create_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/contracts/product_list_item_state.rb +7 -11
- data/lib/metronome_sdk/models/v1/contracts/product_list_params.rb +3 -4
- data/lib/metronome_sdk/models/v1/contracts/product_list_response.rb +12 -16
- data/lib/metronome_sdk/models/v1/contracts/product_retrieve_response.rb +16 -16
- data/lib/metronome_sdk/models/v1/contracts/product_update_params.rb +6 -18
- data/lib/metronome_sdk/models/v1/contracts/product_update_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/contracts/quantity_conversion.rb +4 -4
- data/lib/metronome_sdk/models/v1/contracts/quantity_rounding.rb +6 -4
- data/lib/metronome_sdk/models/v1/contracts/rate_card_archive_params.rb +18 -0
- data/lib/metronome_sdk/models/v1/contracts/rate_card_archive_response.rb +20 -0
- data/lib/metronome_sdk/models/v1/contracts/rate_card_create_params.rb +10 -8
- data/lib/metronome_sdk/models/v1/contracts/rate_card_create_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/contracts/rate_card_list_response.rb +6 -6
- data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rb +7 -9
- data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rb +6 -7
- data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rb +6 -6
- data/lib/metronome_sdk/models/v1/contracts/rate_card_update_params.rb +5 -4
- data/lib/metronome_sdk/models/v1/contracts/rate_card_update_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_params.rb +0 -1
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_update_params.rb +0 -1
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_params.rb +5 -3
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rb +29 -30
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb +18 -23
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rb +9 -15
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_params.rb +7 -9
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rb +6 -7
- data/lib/metronome_sdk/models/v1/credit_grant_create_params.rb +26 -24
- data/lib/metronome_sdk/models/v1/credit_grant_create_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/credit_grant_edit_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/credit_grant_list_entries_params.rb +0 -4
- data/lib/metronome_sdk/models/v1/credit_grant_list_entries_response.rb +11 -15
- data/lib/metronome_sdk/models/v1/credit_grant_list_params.rb +0 -3
- data/lib/metronome_sdk/models/v1/credit_grant_list_response.rb +14 -18
- data/lib/metronome_sdk/models/v1/credit_grant_void_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/credit_ledger_entry.rb +1 -3
- data/lib/metronome_sdk/models/v1/custom_field_add_key_params.rb +3 -3
- data/lib/metronome_sdk/models/v1/custom_field_delete_values_params.rb +3 -3
- data/lib/metronome_sdk/models/v1/custom_field_list_keys_params.rb +5 -3
- data/lib/metronome_sdk/models/v1/custom_field_remove_key_params.rb +3 -3
- data/lib/metronome_sdk/models/v1/custom_field_set_values_params.rb +3 -3
- data/lib/metronome_sdk/models/v1/customer.rb +1 -3
- data/lib/metronome_sdk/models/v1/customer_archive_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/customer_create_params.rb +33 -32
- data/lib/metronome_sdk/models/v1/customer_create_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/customer_detail.rb +13 -16
- data/lib/metronome_sdk/models/v1/customer_list_billable_metrics_params.rb +0 -1
- data/lib/metronome_sdk/models/v1/customer_list_billable_metrics_response.rb +6 -11
- data/lib/metronome_sdk/models/v1/customer_list_params.rb +0 -2
- data/lib/metronome_sdk/models/v1/customer_retrieve_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/customer_set_name_params.rb +0 -1
- data/lib/metronome_sdk/models/v1/customer_set_name_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/customer_update_config_params.rb +0 -1
- data/lib/metronome_sdk/models/v1/customers/alert_list_params.rb +5 -4
- data/lib/metronome_sdk/models/v1/customers/alert_list_response.rb +5 -3
- data/lib/metronome_sdk/models/v1/customers/alert_retrieve_params.rb +26 -1
- data/lib/metronome_sdk/models/v1/customers/alert_retrieve_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/customers/billing_config_create_params.rb +9 -11
- data/lib/metronome_sdk/models/v1/customers/billing_config_delete_params.rb +3 -3
- data/lib/metronome_sdk/models/v1/customers/billing_config_retrieve_params.rb +3 -3
- data/lib/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rb +0 -3
- data/lib/metronome_sdk/models/v1/customers/commit_create_params.rb +44 -51
- data/lib/metronome_sdk/models/v1/customers/commit_create_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/customers/commit_list_params.rb +0 -2
- data/lib/metronome_sdk/models/v1/customers/commit_list_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/customers/commit_update_end_date_params.rb +0 -2
- data/lib/metronome_sdk/models/v1/customers/commit_update_end_date_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/customers/credit_create_params.rb +11 -14
- data/lib/metronome_sdk/models/v1/customers/credit_create_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/customers/credit_list_params.rb +0 -2
- data/lib/metronome_sdk/models/v1/customers/credit_list_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/customers/credit_update_end_date_params.rb +0 -1
- data/lib/metronome_sdk/models/v1/customers/credit_update_end_date_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/customers/customer_alert.rb +38 -37
- data/lib/metronome_sdk/models/v1/customers/invoice.rb +137 -118
- data/lib/metronome_sdk/models/v1/customers/invoice_add_charge_params.rb +0 -2
- data/lib/metronome_sdk/models/v1/customers/invoice_list_breakdowns_params.rb +8 -10
- data/lib/metronome_sdk/models/v1/customers/invoice_list_params.rb +3 -6
- data/lib/metronome_sdk/models/v1/customers/invoice_retrieve_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/customers/named_schedule_retrieve_params.rb +0 -1
- data/lib/metronome_sdk/models/v1/customers/named_schedule_update_params.rb +0 -1
- data/lib/metronome_sdk/models/v1/customers/plan_add_params.rb +24 -30
- data/lib/metronome_sdk/models/v1/customers/plan_add_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/customers/plan_end_params.rb +0 -3
- data/lib/metronome_sdk/models/v1/customers/plan_list_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rb +24 -20
- data/lib/metronome_sdk/models/v1/plan_detail.rb +28 -28
- data/lib/metronome_sdk/models/v1/plan_get_details_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/plan_list_charges_response.rb +3 -6
- data/lib/metronome_sdk/models/v1/plan_list_customers_params.rb +3 -3
- data/lib/metronome_sdk/models/v1/plan_list_customers_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/rollover_amount_max_amount.rb +4 -4
- data/lib/metronome_sdk/models/v1/rollover_amount_max_percentage.rb +4 -4
- data/lib/metronome_sdk/models/v1/usage_ingest_params.rb +5 -3
- data/lib/metronome_sdk/models/v1/usage_list_params.rb +13 -16
- data/lib/metronome_sdk/models/v1/usage_list_response.rb +0 -1
- data/lib/metronome_sdk/models/v1/usage_list_with_groups_params.rb +7 -10
- data/lib/metronome_sdk/models/v2/contract_edit_commit_params.rb +36 -26
- data/lib/metronome_sdk/models/v2/contract_edit_commit_response.rb +3 -3
- data/lib/metronome_sdk/models/v2/contract_edit_credit_params.rb +18 -14
- data/lib/metronome_sdk/models/v2/contract_edit_credit_response.rb +3 -3
- data/lib/metronome_sdk/models/v2/contract_edit_params.rb +979 -460
- data/lib/metronome_sdk/models/v2/contract_edit_response.rb +3 -3
- data/lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb +24 -47
- data/lib/metronome_sdk/models/v2/contract_list_params.rb +0 -4
- data/lib/metronome_sdk/models/v2/contract_list_response.rb +273 -161
- data/lib/metronome_sdk/models/v2/contract_retrieve_params.rb +0 -3
- data/lib/metronome_sdk/models/v2/contract_retrieve_response.rb +273 -161
- data/lib/metronome_sdk/models.rb +66 -0
- data/lib/metronome_sdk/request_options.rb +4 -0
- data/lib/metronome_sdk/resources/v1/alerts.rb +5 -15
- data/lib/metronome_sdk/resources/v1/audit_logs.rb +2 -5
- data/lib/metronome_sdk/resources/v1/billable_metrics.rb +7 -11
- data/lib/metronome_sdk/resources/v1/contracts/named_schedules.rb +2 -4
- data/lib/metronome_sdk/resources/v1/contracts/products.rb +11 -29
- data/lib/metronome_sdk/resources/v1/contracts/rate_cards/named_schedules.rb +2 -5
- data/lib/metronome_sdk/resources/v1/contracts/rate_cards/product_orders.rb +3 -5
- data/lib/metronome_sdk/resources/v1/contracts/rate_cards/rates.rb +8 -16
- data/lib/metronome_sdk/resources/v1/contracts/rate_cards.rb +30 -15
- data/lib/metronome_sdk/resources/v1/contracts.rb +41 -60
- data/lib/metronome_sdk/resources/v1/credit_grants.rb +9 -21
- data/lib/metronome_sdk/resources/v1/custom_fields.rb +10 -10
- data/lib/metronome_sdk/resources/v1/customers/alerts.rb +10 -6
- data/lib/metronome_sdk/resources/v1/customers/billing_config.rb +8 -9
- data/lib/metronome_sdk/resources/v1/customers/commits.rb +7 -20
- data/lib/metronome_sdk/resources/v1/customers/credits.rb +5 -13
- data/lib/metronome_sdk/resources/v1/customers/invoices.rb +9 -21
- data/lib/metronome_sdk/resources/v1/customers/named_schedules.rb +2 -4
- data/lib/metronome_sdk/resources/v1/customers/plans.rb +7 -17
- data/lib/metronome_sdk/resources/v1/customers.rb +13 -20
- data/lib/metronome_sdk/resources/v1/dashboards.rb +5 -5
- data/lib/metronome_sdk/resources/v1/invoices.rb +2 -2
- data/lib/metronome_sdk/resources/v1/plans.rb +5 -5
- data/lib/metronome_sdk/resources/v1/pricing_units.rb +1 -1
- data/lib/metronome_sdk/resources/v1/usage.rb +8 -13
- data/lib/metronome_sdk/resources/v2/contracts.rb +39 -39
- data/lib/metronome_sdk/version.rb +1 -1
- data/lib/metronome_sdk.rb +5 -0
- data/rbi/metronome_sdk/client.rbi +5 -4
- data/rbi/metronome_sdk/errors.rbi +34 -15
- data/rbi/metronome_sdk/file_part.rbi +9 -6
- data/rbi/metronome_sdk/internal/cursor_page.rbi +2 -1
- data/rbi/metronome_sdk/internal/transport/base_client.rbi +165 -77
- data/rbi/metronome_sdk/internal/transport/pooled_net_requester.rbi +29 -13
- data/rbi/metronome_sdk/internal/type/array_of.rbi +34 -24
- data/rbi/metronome_sdk/internal/type/base_model.rbi +155 -70
- data/rbi/metronome_sdk/internal/type/base_page.rbi +13 -8
- data/rbi/metronome_sdk/internal/type/boolean.rbi +16 -14
- data/rbi/metronome_sdk/internal/type/converter.rbi +72 -28
- data/rbi/metronome_sdk/internal/type/enum.rbi +24 -13
- data/rbi/metronome_sdk/internal/type/file_input.rbi +8 -4
- data/rbi/metronome_sdk/internal/type/hash_of.rbi +34 -24
- data/rbi/metronome_sdk/internal/type/request_parameters.rbi +14 -4
- data/rbi/metronome_sdk/internal/type/union.rbi +53 -22
- data/rbi/metronome_sdk/internal/type/unknown.rbi +16 -6
- data/rbi/metronome_sdk/internal/util.rbi +238 -89
- data/rbi/metronome_sdk/internal.rbi +2 -0
- data/rbi/metronome_sdk/models/base_usage_filter.rbi +23 -4
- data/rbi/metronome_sdk/models/commit.rbi +792 -450
- data/rbi/metronome_sdk/models/contract_without_amendments.rbi +1303 -771
- data/rbi/metronome_sdk/models/credit.rbi +405 -223
- data/rbi/metronome_sdk/models/credit_type_data.rbi +10 -3
- data/rbi/metronome_sdk/models/discount.rbi +40 -24
- data/rbi/metronome_sdk/models/event_type_filter.rbi +21 -4
- data/rbi/metronome_sdk/models/id.rbi +10 -3
- data/rbi/metronome_sdk/models/override.rbi +243 -137
- data/rbi/metronome_sdk/models/pro_service.rbi +23 -17
- data/rbi/metronome_sdk/models/property_filter.rbi +24 -11
- data/rbi/metronome_sdk/models/rate.rbi +47 -35
- data/rbi/metronome_sdk/models/schedule_duration.rbi +51 -20
- data/rbi/metronome_sdk/models/schedule_point_in_time.rbi +63 -34
- data/rbi/metronome_sdk/models/scheduled_charge.rbi +41 -26
- data/rbi/metronome_sdk/models/tier.rbi +10 -3
- data/rbi/metronome_sdk/models/v1/alert_archive_params.rbi +22 -11
- data/rbi/metronome_sdk/models/v1/alert_archive_response.rbi +16 -6
- data/rbi/metronome_sdk/models/v1/alert_create_params.rbi +171 -77
- data/rbi/metronome_sdk/models/v1/alert_create_response.rbi +16 -6
- data/rbi/metronome_sdk/models/v1/audit_log_list_params.rbi +59 -26
- data/rbi/metronome_sdk/models/v1/audit_log_list_response.rbi +127 -45
- data/rbi/metronome_sdk/models/v1/billable_metric_archive_params.rbi +18 -5
- data/rbi/metronome_sdk/models/v1/billable_metric_archive_response.rbi +16 -6
- data/rbi/metronome_sdk/models/v1/billable_metric_create_params.rbi +84 -41
- data/rbi/metronome_sdk/models/v1/billable_metric_create_response.rbi +16 -6
- data/rbi/metronome_sdk/models/v1/billable_metric_list_params.rbi +23 -14
- data/rbi/metronome_sdk/models/v1/billable_metric_list_response.rbi +84 -41
- data/rbi/metronome_sdk/models/v1/billable_metric_retrieve_params.rbi +22 -6
- data/rbi/metronome_sdk/models/v1/billable_metric_retrieve_response.rbi +98 -51
- data/rbi/metronome_sdk/models/v1/contract_add_manual_balance_entry_params.rbi +27 -18
- data/rbi/metronome_sdk/models/v1/contract_amend_params.rbi +1469 -779
- data/rbi/metronome_sdk/models/v1/contract_amend_response.rbi +16 -6
- data/rbi/metronome_sdk/models/v1/contract_archive_params.rbi +23 -14
- data/rbi/metronome_sdk/models/v1/contract_archive_response.rbi +16 -6
- data/rbi/metronome_sdk/models/v1/contract_create_historical_invoices_params.rbi +178 -110
- data/rbi/metronome_sdk/models/v1/contract_create_historical_invoices_response.rbi +20 -7
- data/rbi/metronome_sdk/models/v1/contract_create_params.rbi +3311 -2108
- data/rbi/metronome_sdk/models/v1/contract_create_response.rbi +16 -6
- data/rbi/metronome_sdk/models/v1/contract_list_balances_params.rbi +30 -21
- data/rbi/metronome_sdk/models/v1/contract_list_balances_response.rbi +41 -15
- data/rbi/metronome_sdk/models/v1/contract_list_params.rbi +26 -17
- data/rbi/metronome_sdk/models/v1/contract_list_response.rbi +1167 -182
- data/rbi/metronome_sdk/models/v1/contract_retrieve_params.rbi +24 -15
- data/rbi/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rbi +72 -46
- data/rbi/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rbi +122 -78
- data/rbi/metronome_sdk/models/v1/contract_retrieve_response.rbi +1163 -190
- data/rbi/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_params.rbi +66 -41
- data/rbi/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_response.rbi +20 -7
- data/rbi/metronome_sdk/models/v1/contract_set_usage_filter_params.rbi +22 -15
- data/rbi/metronome_sdk/models/v1/contract_update_end_date_params.rbi +24 -15
- data/rbi/metronome_sdk/models/v1/contract_update_end_date_response.rbi +16 -6
- data/rbi/metronome_sdk/models/v1/contracts/named_schedule_retrieve_params.rbi +23 -14
- data/rbi/metronome_sdk/models/v1/contracts/named_schedule_retrieve_response.rbi +54 -17
- data/rbi/metronome_sdk/models/v1/contracts/named_schedule_update_params.rbi +25 -16
- data/rbi/metronome_sdk/models/v1/contracts/product_archive_params.rbi +23 -6
- data/rbi/metronome_sdk/models/v1/contracts/product_archive_response.rbi +18 -6
- data/rbi/metronome_sdk/models/v1/contracts/product_create_params.rbi +107 -46
- data/rbi/metronome_sdk/models/v1/contracts/product_create_response.rbi +18 -6
- data/rbi/metronome_sdk/models/v1/contracts/product_list_item_state.rbi +58 -35
- data/rbi/metronome_sdk/models/v1/contracts/product_list_params.rbi +63 -25
- data/rbi/metronome_sdk/models/v1/contracts/product_list_response.rbi +163 -73
- data/rbi/metronome_sdk/models/v1/contracts/product_retrieve_params.rbi +18 -5
- data/rbi/metronome_sdk/models/v1/contracts/product_retrieve_response.rbi +188 -87
- data/rbi/metronome_sdk/models/v1/contracts/product_update_params.rbi +59 -36
- data/rbi/metronome_sdk/models/v1/contracts/product_update_response.rbi +18 -6
- data/rbi/metronome_sdk/models/v1/contracts/quantity_conversion.rbi +51 -20
- data/rbi/metronome_sdk/models/v1/contracts/quantity_rounding.rbi +52 -20
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_archive_params.rbi +36 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_archive_response.rbi +35 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_create_params.rbi +109 -45
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_create_response.rbi +18 -6
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_list_params.rbi +23 -14
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_list_response.rbi +116 -55
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_params.rbi +18 -5
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rbi +67 -45
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rbi +111 -75
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rbi +147 -81
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_update_params.rbi +70 -25
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_update_response.rbi +18 -6
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_params.rbi +24 -15
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_response.rbi +54 -19
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_update_params.rbi +26 -17
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_params.rbi +22 -13
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_response.rbi +18 -6
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_params.rbi +55 -24
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_response.rbi +18 -6
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rbi +153 -100
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_response.rbi +19 -6
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbi +139 -79
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rbi +141 -82
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_list_params.rbi +73 -45
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rbi +84 -55
- data/rbi/metronome_sdk/models/v1/credit_grant_create_params.rbi +145 -80
- data/rbi/metronome_sdk/models/v1/credit_grant_create_response.rbi +16 -6
- data/rbi/metronome_sdk/models/v1/credit_grant_edit_params.rbi +24 -15
- data/rbi/metronome_sdk/models/v1/credit_grant_edit_response.rbi +16 -6
- data/rbi/metronome_sdk/models/v1/credit_grant_list_entries_params.rbi +25 -16
- data/rbi/metronome_sdk/models/v1/credit_grant_list_entries_response.rbi +162 -77
- data/rbi/metronome_sdk/models/v1/credit_grant_list_params.rbi +27 -18
- data/rbi/metronome_sdk/models/v1/credit_grant_list_response.rbi +169 -72
- data/rbi/metronome_sdk/models/v1/credit_grant_void_params.rbi +23 -14
- data/rbi/metronome_sdk/models/v1/credit_grant_void_response.rbi +16 -6
- data/rbi/metronome_sdk/models/v1/credit_ledger_entry.rbi +25 -16
- data/rbi/metronome_sdk/models/v1/custom_field_add_key_params.rbi +122 -37
- data/rbi/metronome_sdk/models/v1/custom_field_delete_values_params.rbi +120 -37
- data/rbi/metronome_sdk/models/v1/custom_field_list_keys_params.rbi +140 -37
- data/rbi/metronome_sdk/models/v1/custom_field_list_keys_response.rbi +136 -43
- data/rbi/metronome_sdk/models/v1/custom_field_remove_key_params.rbi +126 -36
- data/rbi/metronome_sdk/models/v1/custom_field_set_values_params.rbi +127 -37
- data/rbi/metronome_sdk/models/v1/customer.rbi +20 -14
- data/rbi/metronome_sdk/models/v1/customer_archive_params.rbi +18 -5
- data/rbi/metronome_sdk/models/v1/customer_archive_response.rbi +16 -6
- data/rbi/metronome_sdk/models/v1/customer_create_params.rbi +247 -158
- data/rbi/metronome_sdk/models/v1/customer_create_response.rbi +18 -7
- data/rbi/metronome_sdk/models/v1/customer_detail.rbi +111 -51
- data/rbi/metronome_sdk/models/v1/customer_list_billable_metrics_params.rbi +25 -16
- data/rbi/metronome_sdk/models/v1/customer_list_billable_metrics_response.rbi +69 -45
- data/rbi/metronome_sdk/models/v1/customer_list_costs_params.rbi +25 -16
- data/rbi/metronome_sdk/models/v1/customer_list_costs_response.rbi +100 -49
- data/rbi/metronome_sdk/models/v1/customer_list_params.rbi +26 -17
- data/rbi/metronome_sdk/models/v1/customer_retrieve_params.rbi +22 -6
- data/rbi/metronome_sdk/models/v1/customer_retrieve_response.rbi +18 -7
- data/rbi/metronome_sdk/models/v1/customer_set_ingest_aliases_params.rbi +21 -13
- data/rbi/metronome_sdk/models/v1/customer_set_name_params.rbi +22 -6
- data/rbi/metronome_sdk/models/v1/customer_set_name_response.rbi +18 -7
- data/rbi/metronome_sdk/models/v1/customer_update_config_params.rbi +23 -14
- data/rbi/metronome_sdk/models/v1/customers/alert_list_params.rbi +69 -25
- data/rbi/metronome_sdk/models/v1/customers/alert_list_response.rbi +22 -10
- data/rbi/metronome_sdk/models/v1/customers/alert_reset_params.rbi +15 -5
- data/rbi/metronome_sdk/models/v1/customers/alert_retrieve_params.rbi +77 -5
- data/rbi/metronome_sdk/models/v1/customers/alert_retrieve_response.rbi +24 -8
- data/rbi/metronome_sdk/models/v1/customers/billing_config_create_params.rbi +129 -79
- data/rbi/metronome_sdk/models/v1/customers/billing_config_delete_params.rbi +54 -29
- data/rbi/metronome_sdk/models/v1/customers/billing_config_retrieve_params.rbi +54 -29
- data/rbi/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbi +111 -68
- data/rbi/metronome_sdk/models/v1/customers/commit_create_params.rbi +320 -171
- data/rbi/metronome_sdk/models/v1/customers/commit_create_response.rbi +18 -6
- data/rbi/metronome_sdk/models/v1/customers/commit_list_params.rbi +30 -21
- data/rbi/metronome_sdk/models/v1/customers/commit_list_response.rbi +23 -7
- data/rbi/metronome_sdk/models/v1/customers/commit_update_end_date_params.rbi +24 -15
- data/rbi/metronome_sdk/models/v1/customers/commit_update_end_date_response.rbi +18 -6
- data/rbi/metronome_sdk/models/v1/customers/credit_create_params.rbi +141 -66
- data/rbi/metronome_sdk/models/v1/customers/credit_create_response.rbi +18 -6
- data/rbi/metronome_sdk/models/v1/customers/credit_list_params.rbi +30 -21
- data/rbi/metronome_sdk/models/v1/customers/credit_list_response.rbi +23 -7
- data/rbi/metronome_sdk/models/v1/customers/credit_update_end_date_params.rbi +23 -14
- data/rbi/metronome_sdk/models/v1/customers/credit_update_end_date_response.rbi +18 -6
- data/rbi/metronome_sdk/models/v1/customers/customer_alert.rbi +261 -134
- data/rbi/metronome_sdk/models/v1/customers/invoice.rbi +897 -473
- data/rbi/metronome_sdk/models/v1/customers/invoice_add_charge_params.rbi +27 -18
- data/rbi/metronome_sdk/models/v1/customers/invoice_add_charge_response.rbi +12 -2
- data/rbi/metronome_sdk/models/v1/customers/invoice_list_breakdowns_params.rbi +101 -43
- data/rbi/metronome_sdk/models/v1/customers/invoice_list_breakdowns_response.rbi +21 -4
- data/rbi/metronome_sdk/models/v1/customers/invoice_list_params.rbi +70 -28
- data/rbi/metronome_sdk/models/v1/customers/invoice_retrieve_params.rbi +23 -14
- data/rbi/metronome_sdk/models/v1/customers/invoice_retrieve_response.rbi +22 -7
- data/rbi/metronome_sdk/models/v1/customers/named_schedule_retrieve_params.rbi +23 -14
- data/rbi/metronome_sdk/models/v1/customers/named_schedule_retrieve_response.rbi +54 -17
- data/rbi/metronome_sdk/models/v1/customers/named_schedule_update_params.rbi +25 -16
- data/rbi/metronome_sdk/models/v1/customers/plan_add_params.rbi +205 -119
- data/rbi/metronome_sdk/models/v1/customers/plan_add_response.rbi +18 -6
- data/rbi/metronome_sdk/models/v1/customers/plan_end_params.rbi +25 -16
- data/rbi/metronome_sdk/models/v1/customers/plan_end_response.rbi +12 -2
- data/rbi/metronome_sdk/models/v1/customers/plan_list_params.rbi +23 -14
- data/rbi/metronome_sdk/models/v1/customers/plan_list_price_adjustments_params.rbi +24 -15
- data/rbi/metronome_sdk/models/v1/customers/plan_list_price_adjustments_response.rbi +98 -48
- data/rbi/metronome_sdk/models/v1/customers/plan_list_response.rbi +98 -50
- data/rbi/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rbi +215 -122
- data/rbi/metronome_sdk/models/v1/dashboard_get_embeddable_url_response.rbi +44 -13
- data/rbi/metronome_sdk/models/v1/invoice_regenerate_params.rbi +20 -9
- data/rbi/metronome_sdk/models/v1/invoice_regenerate_response.rbi +42 -13
- data/rbi/metronome_sdk/models/v1/invoice_void_params.rbi +20 -9
- data/rbi/metronome_sdk/models/v1/invoice_void_response.rbi +41 -11
- data/rbi/metronome_sdk/models/v1/plan_detail.rbi +136 -90
- data/rbi/metronome_sdk/models/v1/plan_get_details_params.rbi +19 -6
- data/rbi/metronome_sdk/models/v1/plan_get_details_response.rbi +18 -7
- data/rbi/metronome_sdk/models/v1/plan_list_charges_params.rbi +23 -14
- data/rbi/metronome_sdk/models/v1/plan_list_charges_response.rbi +167 -76
- data/rbi/metronome_sdk/models/v1/plan_list_customers_params.rbi +71 -25
- data/rbi/metronome_sdk/models/v1/plan_list_customers_response.rbi +59 -35
- data/rbi/metronome_sdk/models/v1/plan_list_params.rbi +22 -6
- data/rbi/metronome_sdk/models/v1/plan_list_response.rbi +18 -4
- data/rbi/metronome_sdk/models/v1/pricing_unit_list_params.rbi +22 -6
- data/rbi/metronome_sdk/models/v1/pricing_unit_list_response.rbi +23 -5
- data/rbi/metronome_sdk/models/v1/rollover_amount_max_amount.rbi +46 -10
- data/rbi/metronome_sdk/models/v1/rollover_amount_max_percentage.rbi +43 -11
- data/rbi/metronome_sdk/models/v1/service_list_params.rbi +18 -5
- data/rbi/metronome_sdk/models/v1/service_list_response.rbi +73 -24
- data/rbi/metronome_sdk/models/v1/usage_ingest_params.rbi +51 -31
- data/rbi/metronome_sdk/models/v1/usage_list_params.rbi +126 -45
- data/rbi/metronome_sdk/models/v1/usage_list_response.rbi +51 -24
- data/rbi/metronome_sdk/models/v1/usage_list_with_groups_params.rbi +96 -37
- data/rbi/metronome_sdk/models/v1/usage_list_with_groups_response.rbi +28 -14
- data/rbi/metronome_sdk/models/v2/contract_edit_commit_params.rbi +320 -169
- data/rbi/metronome_sdk/models/v2/contract_edit_commit_response.rbi +16 -6
- data/rbi/metronome_sdk/models/v2/contract_edit_credit_params.rbi +169 -89
- data/rbi/metronome_sdk/models/v2/contract_edit_credit_response.rbi +16 -6
- data/rbi/metronome_sdk/models/v2/contract_edit_params.rbi +4392 -1964
- data/rbi/metronome_sdk/models/v2/contract_edit_response.rbi +16 -6
- data/rbi/metronome_sdk/models/v2/contract_get_edit_history_params.rbi +14 -5
- data/rbi/metronome_sdk/models/v2/contract_get_edit_history_response.rbi +2147 -1376
- data/rbi/metronome_sdk/models/v2/contract_list_params.rbi +26 -17
- data/rbi/metronome_sdk/models/v2/contract_list_response.rbi +3138 -1686
- data/rbi/metronome_sdk/models/v2/contract_retrieve_params.rbi +25 -16
- data/rbi/metronome_sdk/models/v2/contract_retrieve_response.rbi +3092 -1728
- data/rbi/metronome_sdk/models.rbi +39 -0
- data/rbi/metronome_sdk/request_options.rbi +18 -7
- data/rbi/metronome_sdk/resources/v1/alerts.rbi +23 -11
- data/rbi/metronome_sdk/resources/v1/audit_logs.rbi +11 -5
- data/rbi/metronome_sdk/resources/v1/billable_metrics.rbi +31 -17
- data/rbi/metronome_sdk/resources/v1/contracts/named_schedules.rbi +13 -8
- data/rbi/metronome_sdk/resources/v1/contracts/products.rbi +59 -22
- data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/named_schedules.rbi +16 -9
- data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/product_orders.rbi +21 -14
- data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbi +37 -31
- data/rbi/metronome_sdk/resources/v1/contracts/rate_cards.rbi +77 -33
- data/rbi/metronome_sdk/resources/v1/contracts.rbi +141 -105
- data/rbi/metronome_sdk/resources/v1/credit_grants.rbi +36 -26
- data/rbi/metronome_sdk/resources/v1/custom_fields.rbi +34 -26
- data/rbi/metronome_sdk/resources/v1/customers/alerts.rbi +34 -11
- data/rbi/metronome_sdk/resources/v1/customers/billing_config.rbi +28 -17
- data/rbi/metronome_sdk/resources/v1/customers/commits.rbi +26 -22
- data/rbi/metronome_sdk/resources/v1/customers/credits.rbi +22 -17
- data/rbi/metronome_sdk/resources/v1/customers/invoices.rbi +36 -18
- data/rbi/metronome_sdk/resources/v1/customers/named_schedules.rbi +13 -8
- data/rbi/metronome_sdk/resources/v1/customers/plans.rbi +38 -30
- data/rbi/metronome_sdk/resources/v1/customers.rbi +65 -38
- data/rbi/metronome_sdk/resources/v1/dashboards.rbi +21 -24
- data/rbi/metronome_sdk/resources/v1/invoices.rbi +16 -7
- data/rbi/metronome_sdk/resources/v1/plans.rbi +37 -14
- data/rbi/metronome_sdk/resources/v1/pricing_units.rbi +14 -4
- data/rbi/metronome_sdk/resources/v1/services.rbi +9 -3
- data/rbi/metronome_sdk/resources/v1/usage.rbi +30 -17
- data/rbi/metronome_sdk/resources/v1.rbi +2 -1
- data/rbi/metronome_sdk/resources/v2/contracts.rbi +119 -69
- data/rbi/metronome_sdk/resources/v2.rbi +2 -1
- data/sig/metronome_sdk/internal/transport/base_client.rbs +16 -1
- data/sig/metronome_sdk/internal/transport/pooled_net_requester.rbs +2 -0
- data/sig/metronome_sdk/internal/type/base_model.rbs +11 -5
- data/sig/metronome_sdk/internal/type/base_page.rbs +1 -1
- data/sig/metronome_sdk/internal/type/converter.rbs +2 -0
- data/sig/metronome_sdk/internal/type/enum.rbs +1 -0
- data/sig/metronome_sdk/internal/type/request_parameters.rbs +5 -1
- data/sig/metronome_sdk/internal/type/union.rbs +1 -0
- data/sig/metronome_sdk/internal/util.rbs +15 -0
- data/sig/metronome_sdk/internal.rbs +2 -0
- data/sig/metronome_sdk/models/base_usage_filter.rbs +0 -2
- data/sig/metronome_sdk/models/commit.rbs +109 -145
- data/sig/metronome_sdk/models/contract_without_amendments.rbs +219 -269
- data/sig/metronome_sdk/models/credit.rbs +59 -77
- data/sig/metronome_sdk/models/credit_type_data.rbs +0 -2
- data/sig/metronome_sdk/models/discount.rbs +6 -10
- data/sig/metronome_sdk/models/event_type_filter.rbs +0 -2
- data/sig/metronome_sdk/models/id.rbs +0 -2
- data/sig/metronome_sdk/models/override.rbs +60 -74
- data/sig/metronome_sdk/models/pro_service.rbs +0 -2
- data/sig/metronome_sdk/models/property_filter.rbs +0 -2
- data/sig/metronome_sdk/models/rate.rbs +13 -17
- data/sig/metronome_sdk/models/schedule_duration.rbs +8 -12
- data/sig/metronome_sdk/models/schedule_point_in_time.rbs +10 -14
- data/sig/metronome_sdk/models/scheduled_charge.rbs +6 -10
- data/sig/metronome_sdk/models/tier.rbs +0 -2
- data/sig/metronome_sdk/models/v1/alert_archive_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/alert_archive_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/alert_create_params.rbs +14 -20
- data/sig/metronome_sdk/models/v1/alert_create_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/audit_log_list_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/audit_log_list_response.rbs +0 -6
- data/sig/metronome_sdk/models/v1/billable_metric_archive_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/billable_metric_archive_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/billable_metric_create_params.rbs +10 -12
- data/sig/metronome_sdk/models/v1/billable_metric_create_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/billable_metric_list_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/billable_metric_list_response.rbs +10 -12
- data/sig/metronome_sdk/models/v1/billable_metric_retrieve_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/billable_metric_retrieve_response.rbs +10 -14
- data/sig/metronome_sdk/models/v1/contract_add_manual_balance_entry_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/contract_amend_params.rbs +204 -260
- data/sig/metronome_sdk/models/v1/contract_amend_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/contract_archive_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/contract_archive_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/contract_create_historical_invoices_params.rbs +23 -31
- data/sig/metronome_sdk/models/v1/contract_create_historical_invoices_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/contract_create_params.rbs +510 -604
- data/sig/metronome_sdk/models/v1/contract_create_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/contract_list_balances_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/contract_list_balances_response.rbs +2 -4
- data/sig/metronome_sdk/models/v1/contract_list_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/contract_list_response.rbs +310 -40
- data/sig/metronome_sdk/models/v1/contract_retrieve_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rbs +5 -9
- data/sig/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rbs +12 -20
- data/sig/metronome_sdk/models/v1/contract_retrieve_response.rbs +310 -40
- data/sig/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_params.rbs +3 -7
- data/sig/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/contract_set_usage_filter_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/contract_update_end_date_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/contract_update_end_date_response.rbs +3 -6
- data/sig/metronome_sdk/models/v1/contracts/named_schedule_retrieve_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/contracts/named_schedule_retrieve_response.rbs +0 -4
- data/sig/metronome_sdk/models/v1/contracts/named_schedule_update_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/contracts/product_archive_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/contracts/product_archive_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/contracts/product_create_params.rbs +6 -8
- data/sig/metronome_sdk/models/v1/contracts/product_create_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/contracts/product_list_item_state.rbs +6 -8
- data/sig/metronome_sdk/models/v1/contracts/product_list_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/contracts/product_list_response.rbs +12 -16
- data/sig/metronome_sdk/models/v1/contracts/product_retrieve_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/contracts/product_retrieve_response.rbs +12 -18
- data/sig/metronome_sdk/models/v1/contracts/product_update_params.rbs +6 -8
- data/sig/metronome_sdk/models/v1/contracts/product_update_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/contracts/quantity_conversion.rbs +4 -6
- data/sig/metronome_sdk/models/v1/contracts/quantity_rounding.rbs +4 -6
- data/sig/metronome_sdk/models/v1/contracts/rate_card_archive_params.rbs +17 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_archive_response.rbs +15 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_create_params.rbs +10 -16
- data/sig/metronome_sdk/models/v1/contracts/rate_card_create_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/contracts/rate_card_list_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/contracts/rate_card_list_response.rbs +8 -14
- data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rbs +5 -9
- data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rbs +8 -14
- data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rbs +8 -16
- data/sig/metronome_sdk/models/v1/contracts/rate_card_update_params.rbs +5 -9
- data/sig/metronome_sdk/models/v1/contracts/rate_card_update_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_response.rbs +0 -4
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_update_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_params.rbs +3 -7
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_response.rbs +3 -6
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rbs +26 -32
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbs +19 -23
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rbs +15 -21
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_list_params.rbs +5 -9
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rbs +8 -12
- data/sig/metronome_sdk/models/v1/credit_grant_create_params.rbs +17 -25
- data/sig/metronome_sdk/models/v1/credit_grant_create_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/credit_grant_edit_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/credit_grant_edit_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/credit_grant_list_entries_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/credit_grant_list_entries_response.rbs +9 -19
- data/sig/metronome_sdk/models/v1/credit_grant_list_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/credit_grant_list_response.rbs +12 -22
- data/sig/metronome_sdk/models/v1/credit_grant_void_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/credit_grant_void_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/credit_ledger_entry.rbs +0 -2
- data/sig/metronome_sdk/models/v1/custom_field_add_key_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/custom_field_delete_values_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/custom_field_list_keys_params.rbs +6 -8
- data/sig/metronome_sdk/models/v1/custom_field_list_keys_response.rbs +0 -4
- data/sig/metronome_sdk/models/v1/custom_field_remove_key_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/custom_field_set_values_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customer.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customer_archive_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customer_archive_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/customer_create_params.rbs +36 -42
- data/sig/metronome_sdk/models/v1/customer_create_response.rbs +3 -6
- data/sig/metronome_sdk/models/v1/customer_detail.rbs +12 -18
- data/sig/metronome_sdk/models/v1/customer_list_billable_metrics_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customer_list_billable_metrics_response.rbs +10 -12
- data/sig/metronome_sdk/models/v1/customer_list_costs_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customer_list_costs_response.rbs +0 -6
- data/sig/metronome_sdk/models/v1/customer_list_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customer_retrieve_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customer_retrieve_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/customer_set_ingest_aliases_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customer_set_name_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customer_set_name_response.rbs +3 -6
- data/sig/metronome_sdk/models/v1/customer_update_config_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/alert_list_params.rbs +6 -8
- data/sig/metronome_sdk/models/v1/customers/alert_list_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/customers/alert_reset_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/alert_retrieve_params.rbs +22 -2
- data/sig/metronome_sdk/models/v1/customers/alert_retrieve_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/customers/billing_config_create_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/billing_config_delete_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/billing_config_retrieve_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbs +0 -4
- data/sig/metronome_sdk/models/v1/customers/commit_create_params.rbs +29 -41
- data/sig/metronome_sdk/models/v1/customers/commit_create_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/customers/commit_list_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/commit_list_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/customers/commit_update_end_date_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/commit_update_end_date_response.rbs +3 -6
- data/sig/metronome_sdk/models/v1/customers/credit_create_params.rbs +6 -12
- data/sig/metronome_sdk/models/v1/customers/credit_create_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/customers/credit_list_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/credit_list_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/customers/credit_update_end_date_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/credit_update_end_date_response.rbs +3 -6
- data/sig/metronome_sdk/models/v1/customers/customer_alert.rbs +32 -40
- data/sig/metronome_sdk/models/v1/customers/invoice.rbs +133 -151
- data/sig/metronome_sdk/models/v1/customers/invoice_add_charge_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/invoice_add_charge_response.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/invoice_list_breakdowns_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/invoice_list_breakdowns_response.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/invoice_list_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/invoice_retrieve_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/invoice_retrieve_response.rbs +3 -7
- data/sig/metronome_sdk/models/v1/customers/named_schedule_retrieve_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/named_schedule_retrieve_response.rbs +0 -4
- data/sig/metronome_sdk/models/v1/customers/named_schedule_update_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/plan_add_params.rbs +24 -34
- data/sig/metronome_sdk/models/v1/customers/plan_add_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/customers/plan_end_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/plan_end_response.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/plan_list_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/plan_list_price_adjustments_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/plan_list_price_adjustments_response.rbs +0 -4
- data/sig/metronome_sdk/models/v1/customers/plan_list_response.rbs +3 -9
- data/sig/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rbs +21 -29
- data/sig/metronome_sdk/models/v1/dashboard_get_embeddable_url_response.rbs +0 -4
- data/sig/metronome_sdk/models/v1/invoice_regenerate_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/invoice_regenerate_response.rbs +0 -4
- data/sig/metronome_sdk/models/v1/invoice_void_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/invoice_void_response.rbs +0 -4
- data/sig/metronome_sdk/models/v1/plan_detail.rbs +30 -38
- data/sig/metronome_sdk/models/v1/plan_get_details_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/plan_get_details_response.rbs +3 -6
- data/sig/metronome_sdk/models/v1/plan_list_charges_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/plan_list_charges_response.rbs +3 -9
- data/sig/metronome_sdk/models/v1/plan_list_customers_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/plan_list_customers_response.rbs +3 -7
- data/sig/metronome_sdk/models/v1/plan_list_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/plan_list_response.rbs +0 -2
- data/sig/metronome_sdk/models/v1/pricing_unit_list_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/pricing_unit_list_response.rbs +0 -2
- data/sig/metronome_sdk/models/v1/rollover_amount_max_amount.rbs +4 -9
- data/sig/metronome_sdk/models/v1/rollover_amount_max_percentage.rbs +4 -6
- data/sig/metronome_sdk/models/v1/service_list_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/service_list_response.rbs +0 -4
- data/sig/metronome_sdk/models/v1/usage_ingest_params.rbs +5 -9
- data/sig/metronome_sdk/models/v1/usage_list_params.rbs +10 -16
- data/sig/metronome_sdk/models/v1/usage_list_response.rbs +0 -4
- data/sig/metronome_sdk/models/v1/usage_list_with_groups_params.rbs +5 -9
- data/sig/metronome_sdk/models/v1/usage_list_with_groups_response.rbs +0 -2
- data/sig/metronome_sdk/models/v2/contract_edit_commit_params.rbs +40 -58
- data/sig/metronome_sdk/models/v2/contract_edit_commit_response.rbs +3 -5
- data/sig/metronome_sdk/models/v2/contract_edit_credit_params.rbs +20 -30
- data/sig/metronome_sdk/models/v2/contract_edit_credit_response.rbs +3 -5
- data/sig/metronome_sdk/models/v2/contract_edit_params.rbs +779 -585
- data/sig/metronome_sdk/models/v2/contract_edit_response.rbs +3 -5
- data/sig/metronome_sdk/models/v2/contract_get_edit_history_params.rbs +0 -2
- data/sig/metronome_sdk/models/v2/contract_get_edit_history_response.rbs +38 -146
- data/sig/metronome_sdk/models/v2/contract_list_params.rbs +0 -2
- data/sig/metronome_sdk/models/v2/contract_list_response.rbs +190 -224
- data/sig/metronome_sdk/models/v2/contract_retrieve_params.rbs +0 -2
- data/sig/metronome_sdk/models/v2/contract_retrieve_response.rbs +190 -224
- data/sig/metronome_sdk/models.rbs +37 -0
- data/sig/metronome_sdk/request_options.rbs +1 -1
- data/sig/metronome_sdk/resources/v1/alerts.rbs +2 -2
- data/sig/metronome_sdk/resources/v1/billable_metrics.rbs +2 -2
- data/sig/metronome_sdk/resources/v1/contracts/products.rbs +4 -4
- data/sig/metronome_sdk/resources/v1/contracts/rate_cards/product_orders.rbs +1 -1
- data/sig/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbs +4 -4
- data/sig/metronome_sdk/resources/v1/contracts/rate_cards.rbs +9 -4
- data/sig/metronome_sdk/resources/v1/contracts.rbs +25 -25
- data/sig/metronome_sdk/resources/v1/credit_grants.rbs +3 -3
- data/sig/metronome_sdk/resources/v1/custom_fields.rbs +1 -1
- data/sig/metronome_sdk/resources/v1/customers/alerts.rbs +2 -1
- data/sig/metronome_sdk/resources/v1/customers/commits.rbs +2 -2
- data/sig/metronome_sdk/resources/v1/customers/credits.rbs +1 -1
- data/sig/metronome_sdk/resources/v1/customers/invoices.rbs +1 -1
- data/sig/metronome_sdk/resources/v1/customers/plans.rbs +3 -3
- data/sig/metronome_sdk/resources/v1/customers.rbs +3 -3
- data/sig/metronome_sdk/resources/v1/dashboards.rbs +3 -3
- data/sig/metronome_sdk/resources/v1/usage.rbs +3 -3
- data/sig/metronome_sdk/resources/v2/contracts.rbs +25 -21
- metadata +13 -4
@@ -28,15 +28,15 @@ module MetronomeSDK
|
|
28
28
|
|
29
29
|
# @!attribute commits
|
30
30
|
#
|
31
|
-
# @return [Array<MetronomeSDK::
|
31
|
+
# @return [Array<MetronomeSDK::V1::ContractAmendParams::Commit>, nil]
|
32
32
|
optional :commits,
|
33
|
-
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::
|
33
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Commit] }
|
34
34
|
|
35
35
|
# @!attribute credits
|
36
36
|
#
|
37
|
-
# @return [Array<MetronomeSDK::
|
37
|
+
# @return [Array<MetronomeSDK::V1::ContractAmendParams::Credit>, nil]
|
38
38
|
optional :credits,
|
39
|
-
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::
|
39
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Credit] }
|
40
40
|
|
41
41
|
# @!attribute custom_fields
|
42
42
|
#
|
@@ -46,9 +46,9 @@ module MetronomeSDK
|
|
46
46
|
# @!attribute discounts
|
47
47
|
# This field's availability is dependent on your client's configuration.
|
48
48
|
#
|
49
|
-
# @return [Array<MetronomeSDK::
|
49
|
+
# @return [Array<MetronomeSDK::V1::ContractAmendParams::Discount>, nil]
|
50
50
|
optional :discounts,
|
51
|
-
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::
|
51
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Discount] }
|
52
52
|
|
53
53
|
# @!attribute netsuite_sales_order_id
|
54
54
|
# This field's availability is dependent on your client's configuration.
|
@@ -58,23 +58,27 @@ module MetronomeSDK
|
|
58
58
|
|
59
59
|
# @!attribute overrides
|
60
60
|
#
|
61
|
-
# @return [Array<MetronomeSDK::
|
61
|
+
# @return [Array<MetronomeSDK::V1::ContractAmendParams::Override>, nil]
|
62
62
|
optional :overrides,
|
63
|
-
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::
|
63
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Override] }
|
64
64
|
|
65
65
|
# @!attribute professional_services
|
66
66
|
# This field's availability is dependent on your client's configuration.
|
67
67
|
#
|
68
|
-
# @return [Array<MetronomeSDK::
|
68
|
+
# @return [Array<MetronomeSDK::V1::ContractAmendParams::ProfessionalService>, nil]
|
69
69
|
optional :professional_services,
|
70
|
-
-> {
|
70
|
+
-> {
|
71
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::ProfessionalService]
|
72
|
+
}
|
71
73
|
|
72
74
|
# @!attribute reseller_royalties
|
73
75
|
# This field's availability is dependent on your client's configuration.
|
74
76
|
#
|
75
|
-
# @return [Array<MetronomeSDK::
|
77
|
+
# @return [Array<MetronomeSDK::V1::ContractAmendParams::ResellerRoyalty>, nil]
|
76
78
|
optional :reseller_royalties,
|
77
|
-
-> {
|
79
|
+
-> {
|
80
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::ResellerRoyalty]
|
81
|
+
}
|
78
82
|
|
79
83
|
# @!attribute salesforce_opportunity_id
|
80
84
|
# This field's availability is dependent on your client's configuration.
|
@@ -84,9 +88,11 @@ module MetronomeSDK
|
|
84
88
|
|
85
89
|
# @!attribute scheduled_charges
|
86
90
|
#
|
87
|
-
# @return [Array<MetronomeSDK::
|
91
|
+
# @return [Array<MetronomeSDK::V1::ContractAmendParams::ScheduledCharge>, nil]
|
88
92
|
optional :scheduled_charges,
|
89
|
-
-> {
|
93
|
+
-> {
|
94
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::ScheduledCharge]
|
95
|
+
}
|
90
96
|
|
91
97
|
# @!attribute total_contract_value
|
92
98
|
# This field's availability is dependent on your client's configuration.
|
@@ -101,25 +107,25 @@ module MetronomeSDK
|
|
101
107
|
#
|
102
108
|
# @param starting_at [Time] inclusive start time for the amendment
|
103
109
|
#
|
104
|
-
# @param commits [Array<MetronomeSDK::
|
110
|
+
# @param commits [Array<MetronomeSDK::V1::ContractAmendParams::Commit>]
|
105
111
|
#
|
106
|
-
# @param credits [Array<MetronomeSDK::
|
112
|
+
# @param credits [Array<MetronomeSDK::V1::ContractAmendParams::Credit>]
|
107
113
|
#
|
108
114
|
# @param custom_fields [Hash{Symbol=>String}]
|
109
115
|
#
|
110
|
-
# @param discounts [Array<MetronomeSDK::
|
116
|
+
# @param discounts [Array<MetronomeSDK::V1::ContractAmendParams::Discount>] This field's availability is dependent on your client's configuration.
|
111
117
|
#
|
112
118
|
# @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
|
113
119
|
#
|
114
|
-
# @param overrides [Array<MetronomeSDK::
|
120
|
+
# @param overrides [Array<MetronomeSDK::V1::ContractAmendParams::Override>]
|
115
121
|
#
|
116
|
-
# @param professional_services [Array<MetronomeSDK::
|
122
|
+
# @param professional_services [Array<MetronomeSDK::V1::ContractAmendParams::ProfessionalService>] This field's availability is dependent on your client's configuration.
|
117
123
|
#
|
118
|
-
# @param reseller_royalties [Array<MetronomeSDK::
|
124
|
+
# @param reseller_royalties [Array<MetronomeSDK::V1::ContractAmendParams::ResellerRoyalty>] This field's availability is dependent on your client's configuration.
|
119
125
|
#
|
120
126
|
# @param salesforce_opportunity_id [String] This field's availability is dependent on your client's configuration.
|
121
127
|
#
|
122
|
-
# @param scheduled_charges [Array<MetronomeSDK::
|
128
|
+
# @param scheduled_charges [Array<MetronomeSDK::V1::ContractAmendParams::ScheduledCharge>]
|
123
129
|
#
|
124
130
|
# @param total_contract_value [Float] This field's availability is dependent on your client's configuration.
|
125
131
|
#
|
@@ -133,16 +139,16 @@ module MetronomeSDK
|
|
133
139
|
|
134
140
|
# @!attribute type
|
135
141
|
#
|
136
|
-
# @return [Symbol, MetronomeSDK::
|
137
|
-
required :type, enum: -> { MetronomeSDK::
|
142
|
+
# @return [Symbol, MetronomeSDK::V1::ContractAmendParams::Commit::Type]
|
143
|
+
required :type, enum: -> { MetronomeSDK::V1::ContractAmendParams::Commit::Type }
|
138
144
|
|
139
145
|
# @!attribute access_schedule
|
140
146
|
# Required: Schedule for distributing the commit to the customer. For "POSTPAID"
|
141
147
|
# commits only one schedule item is allowed and amount must match invoice_schedule
|
142
148
|
# total.
|
143
149
|
#
|
144
|
-
# @return [MetronomeSDK::
|
145
|
-
optional :access_schedule, -> { MetronomeSDK::
|
150
|
+
# @return [MetronomeSDK::V1::ContractAmendParams::Commit::AccessSchedule, nil]
|
151
|
+
optional :access_schedule, -> { MetronomeSDK::V1::ContractAmendParams::Commit::AccessSchedule }
|
146
152
|
|
147
153
|
# @!attribute amount
|
148
154
|
# (DEPRECATED) Use access_schedule and invoice_schedule instead.
|
@@ -181,8 +187,8 @@ module MetronomeSDK
|
|
181
187
|
# amount. Optional for "PREPAID" commits: if not provided, this will be a
|
182
188
|
# "complimentary" commit with no invoice.
|
183
189
|
#
|
184
|
-
# @return [MetronomeSDK::
|
185
|
-
optional :invoice_schedule, -> { MetronomeSDK::
|
190
|
+
# @return [MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule, nil]
|
191
|
+
optional :invoice_schedule, -> { MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule }
|
186
192
|
|
187
193
|
# @!attribute name
|
188
194
|
# displayed on invoices
|
@@ -199,9 +205,11 @@ module MetronomeSDK
|
|
199
205
|
# @!attribute payment_gate_config
|
200
206
|
# optionally payment gate this commit
|
201
207
|
#
|
202
|
-
# @return [MetronomeSDK::
|
208
|
+
# @return [MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig, nil]
|
203
209
|
optional :payment_gate_config,
|
204
|
-
-> {
|
210
|
+
-> {
|
211
|
+
MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig
|
212
|
+
}
|
205
213
|
|
206
214
|
# @!attribute priority
|
207
215
|
# If multiple commits are applicable, the one with the lower priority will apply
|
@@ -212,8 +220,8 @@ module MetronomeSDK
|
|
212
220
|
|
213
221
|
# @!attribute rate_type
|
214
222
|
#
|
215
|
-
# @return [Symbol, MetronomeSDK::
|
216
|
-
optional :rate_type, enum: -> { MetronomeSDK::
|
223
|
+
# @return [Symbol, MetronomeSDK::V1::ContractAmendParams::Commit::RateType, nil]
|
224
|
+
optional :rate_type, enum: -> { MetronomeSDK::V1::ContractAmendParams::Commit::RateType }
|
217
225
|
|
218
226
|
# @!attribute rollover_fraction
|
219
227
|
# Fraction of unused segments that will be rolled over. Must be between 0 and 1.
|
@@ -230,47 +238,41 @@ module MetronomeSDK
|
|
230
238
|
|
231
239
|
# @!method initialize(product_id:, type:, access_schedule: nil, amount: nil, applicable_product_ids: nil, applicable_product_tags: nil, custom_fields: nil, description: nil, invoice_schedule: nil, name: nil, netsuite_sales_order_id: nil, payment_gate_config: nil, priority: nil, rate_type: nil, rollover_fraction: nil, temporary_id: nil)
|
232
240
|
# Some parameter documentations has been truncated, see
|
233
|
-
# {MetronomeSDK::
|
241
|
+
# {MetronomeSDK::V1::ContractAmendParams::Commit} for more details.
|
234
242
|
#
|
235
243
|
# @param product_id [String]
|
236
244
|
#
|
237
|
-
# @param type [Symbol, MetronomeSDK::
|
245
|
+
# @param type [Symbol, MetronomeSDK::V1::ContractAmendParams::Commit::Type]
|
238
246
|
#
|
239
|
-
# @param access_schedule [MetronomeSDK::
|
240
|
-
# ...
|
247
|
+
# @param access_schedule [MetronomeSDK::V1::ContractAmendParams::Commit::AccessSchedule] Required: Schedule for distributing the commit to the customer. For "POSTPAID" c
|
241
248
|
#
|
242
249
|
# @param amount [Float] (DEPRECATED) Use access_schedule and invoice_schedule instead.
|
243
250
|
#
|
244
251
|
# @param applicable_product_ids [Array<String>] Which products the commit applies to. If both applicable_product_ids and applica
|
245
|
-
# ...
|
246
252
|
#
|
247
253
|
# @param applicable_product_tags [Array<String>] Which tags the commit applies to. If both applicable*product_ids and applicable*
|
248
|
-
# ...
|
249
254
|
#
|
250
255
|
# @param custom_fields [Hash{Symbol=>String}]
|
251
256
|
#
|
252
257
|
# @param description [String] Used only in UI/API. It is not exposed to end customers.
|
253
258
|
#
|
254
|
-
# @param invoice_schedule [MetronomeSDK::
|
255
|
-
# ...
|
259
|
+
# @param invoice_schedule [MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule] Required for "POSTPAID" commits: the true up invoice will be generated at this t
|
256
260
|
#
|
257
261
|
# @param name [String] displayed on invoices
|
258
262
|
#
|
259
263
|
# @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
|
260
264
|
#
|
261
|
-
# @param payment_gate_config [MetronomeSDK::
|
265
|
+
# @param payment_gate_config [MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig] optionally payment gate this commit
|
262
266
|
#
|
263
267
|
# @param priority [Float] If multiple commits are applicable, the one with the lower priority will apply f
|
264
|
-
# ...
|
265
268
|
#
|
266
|
-
# @param rate_type [Symbol, MetronomeSDK::
|
269
|
+
# @param rate_type [Symbol, MetronomeSDK::V1::ContractAmendParams::Commit::RateType]
|
267
270
|
#
|
268
271
|
# @param rollover_fraction [Float] Fraction of unused segments that will be rolled over. Must be between 0 and 1.
|
269
272
|
#
|
270
273
|
# @param temporary_id [String] A temporary ID for the commit that can be used to reference the commit for commi
|
271
|
-
# ...
|
272
274
|
|
273
|
-
# @see MetronomeSDK::
|
275
|
+
# @see MetronomeSDK::V1::ContractAmendParams::Commit#type
|
274
276
|
module Type
|
275
277
|
extend MetronomeSDK::Internal::Type::Enum
|
276
278
|
|
@@ -281,13 +283,15 @@ module MetronomeSDK
|
|
281
283
|
# @return [Array<Symbol>]
|
282
284
|
end
|
283
285
|
|
284
|
-
# @see MetronomeSDK::
|
286
|
+
# @see MetronomeSDK::V1::ContractAmendParams::Commit#access_schedule
|
285
287
|
class AccessSchedule < MetronomeSDK::Internal::Type::BaseModel
|
286
288
|
# @!attribute schedule_items
|
287
289
|
#
|
288
|
-
# @return [Array<MetronomeSDK::
|
290
|
+
# @return [Array<MetronomeSDK::V1::ContractAmendParams::Commit::AccessSchedule::ScheduleItem>]
|
289
291
|
required :schedule_items,
|
290
|
-
-> {
|
292
|
+
-> {
|
293
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Commit::AccessSchedule::ScheduleItem]
|
294
|
+
}
|
291
295
|
|
292
296
|
# @!attribute credit_type_id
|
293
297
|
# Defaults to USD (cents) if not passed
|
@@ -300,7 +304,7 @@ module MetronomeSDK
|
|
300
304
|
# commits only one schedule item is allowed and amount must match invoice_schedule
|
301
305
|
# total.
|
302
306
|
#
|
303
|
-
# @param schedule_items [Array<MetronomeSDK::
|
307
|
+
# @param schedule_items [Array<MetronomeSDK::V1::ContractAmendParams::Commit::AccessSchedule::ScheduleItem>]
|
304
308
|
#
|
305
309
|
# @param credit_type_id [String] Defaults to USD (cents) if not passed
|
306
310
|
|
@@ -331,7 +335,7 @@ module MetronomeSDK
|
|
331
335
|
end
|
332
336
|
end
|
333
337
|
|
334
|
-
# @see MetronomeSDK::
|
338
|
+
# @see MetronomeSDK::V1::ContractAmendParams::Commit#invoice_schedule
|
335
339
|
class InvoiceSchedule < MetronomeSDK::Internal::Type::BaseModel
|
336
340
|
# @!attribute credit_type_id
|
337
341
|
# Defaults to USD (cents) if not passed.
|
@@ -344,21 +348,23 @@ module MetronomeSDK
|
|
344
348
|
# amount. If amount is sent, the unit price is assumed to be the amount and
|
345
349
|
# quantity is inferred to be 1.
|
346
350
|
#
|
347
|
-
# @return [MetronomeSDK::
|
351
|
+
# @return [MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule::RecurringSchedule, nil]
|
348
352
|
optional :recurring_schedule,
|
349
|
-
-> { MetronomeSDK::
|
353
|
+
-> { MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule::RecurringSchedule }
|
350
354
|
|
351
355
|
# @!attribute schedule_items
|
352
356
|
# Either provide amount or provide both unit_price and quantity.
|
353
357
|
#
|
354
|
-
# @return [Array<MetronomeSDK::
|
358
|
+
# @return [Array<MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule::ScheduleItem>, nil]
|
355
359
|
optional :schedule_items,
|
356
|
-
-> {
|
360
|
+
-> {
|
361
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule::ScheduleItem]
|
362
|
+
}
|
357
363
|
|
358
364
|
# @!method initialize(credit_type_id: nil, recurring_schedule: nil, schedule_items: nil)
|
359
365
|
# Some parameter documentations has been truncated, see
|
360
|
-
# {MetronomeSDK::
|
361
|
-
#
|
366
|
+
# {MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule} for more
|
367
|
+
# details.
|
362
368
|
#
|
363
369
|
# Required for "POSTPAID" commits: the true up invoice will be generated at this
|
364
370
|
# time and only one schedule item is allowed; the total must match access_schedule
|
@@ -367,18 +373,19 @@ module MetronomeSDK
|
|
367
373
|
#
|
368
374
|
# @param credit_type_id [String] Defaults to USD (cents) if not passed.
|
369
375
|
#
|
370
|
-
# @param recurring_schedule [MetronomeSDK::
|
371
|
-
# ...
|
376
|
+
# @param recurring_schedule [MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule::RecurringSchedule] Enter the unit price and quantity for the charge or instead only send the amount
|
372
377
|
#
|
373
|
-
# @param schedule_items [Array<MetronomeSDK::
|
378
|
+
# @param schedule_items [Array<MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule::ScheduleItem>] Either provide amount or provide both unit_price and quantity.
|
374
379
|
|
375
|
-
# @see MetronomeSDK::
|
380
|
+
# @see MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule#recurring_schedule
|
376
381
|
class RecurringSchedule < MetronomeSDK::Internal::Type::BaseModel
|
377
382
|
# @!attribute amount_distribution
|
378
383
|
#
|
379
|
-
# @return [Symbol, MetronomeSDK::
|
384
|
+
# @return [Symbol, MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule::RecurringSchedule::AmountDistribution]
|
380
385
|
required :amount_distribution,
|
381
|
-
enum: -> {
|
386
|
+
enum: -> {
|
387
|
+
MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule::RecurringSchedule::AmountDistribution
|
388
|
+
}
|
382
389
|
|
383
390
|
# @!attribute ending_before
|
384
391
|
# RFC 3339 timestamp (exclusive).
|
@@ -388,9 +395,11 @@ module MetronomeSDK
|
|
388
395
|
|
389
396
|
# @!attribute frequency
|
390
397
|
#
|
391
|
-
# @return [Symbol, MetronomeSDK::
|
398
|
+
# @return [Symbol, MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule::RecurringSchedule::Frequency]
|
392
399
|
required :frequency,
|
393
|
-
enum: -> {
|
400
|
+
enum: -> {
|
401
|
+
MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule::RecurringSchedule::Frequency
|
402
|
+
}
|
394
403
|
|
395
404
|
# @!attribute starting_at
|
396
405
|
# RFC 3339 timestamp (inclusive).
|
@@ -424,31 +433,28 @@ module MetronomeSDK
|
|
424
433
|
|
425
434
|
# @!method initialize(amount_distribution:, ending_before:, frequency:, starting_at:, amount: nil, quantity: nil, unit_price: nil)
|
426
435
|
# Some parameter documentations has been truncated, see
|
427
|
-
# {MetronomeSDK::
|
436
|
+
# {MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule::RecurringSchedule}
|
428
437
|
# for more details.
|
429
438
|
#
|
430
439
|
# Enter the unit price and quantity for the charge or instead only send the
|
431
440
|
# amount. If amount is sent, the unit price is assumed to be the amount and
|
432
441
|
# quantity is inferred to be 1.
|
433
442
|
#
|
434
|
-
# @param amount_distribution [Symbol, MetronomeSDK::
|
443
|
+
# @param amount_distribution [Symbol, MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule::RecurringSchedule::AmountDistribution]
|
435
444
|
#
|
436
445
|
# @param ending_before [Time] RFC 3339 timestamp (exclusive).
|
437
446
|
#
|
438
|
-
# @param frequency [Symbol, MetronomeSDK::
|
447
|
+
# @param frequency [Symbol, MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule::RecurringSchedule::Frequency]
|
439
448
|
#
|
440
449
|
# @param starting_at [Time] RFC 3339 timestamp (inclusive).
|
441
450
|
#
|
442
451
|
# @param amount [Float] Amount for the charge. Can be provided instead of unit_price and quantity. If am
|
443
|
-
# ...
|
444
452
|
#
|
445
453
|
# @param quantity [Float] Quantity for the charge. Will be multiplied by unit_price to determine the amoun
|
446
|
-
# ...
|
447
454
|
#
|
448
455
|
# @param unit_price [Float] Unit price for the charge. Will be multiplied by quantity to determine the amoun
|
449
|
-
# ...
|
450
456
|
|
451
|
-
# @see MetronomeSDK::
|
457
|
+
# @see MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule::RecurringSchedule#amount_distribution
|
452
458
|
module AmountDistribution
|
453
459
|
extend MetronomeSDK::Internal::Type::Enum
|
454
460
|
|
@@ -460,7 +466,7 @@ module MetronomeSDK
|
|
460
466
|
# @return [Array<Symbol>]
|
461
467
|
end
|
462
468
|
|
463
|
-
# @see MetronomeSDK::
|
469
|
+
# @see MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule::RecurringSchedule#frequency
|
464
470
|
module Frequency
|
465
471
|
extend MetronomeSDK::Internal::Type::Enum
|
466
472
|
|
@@ -507,23 +513,20 @@ module MetronomeSDK
|
|
507
513
|
|
508
514
|
# @!method initialize(timestamp:, amount: nil, quantity: nil, unit_price: nil)
|
509
515
|
# Some parameter documentations has been truncated, see
|
510
|
-
# {MetronomeSDK::
|
516
|
+
# {MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule::ScheduleItem}
|
511
517
|
# for more details.
|
512
518
|
#
|
513
519
|
# @param timestamp [Time] timestamp of the scheduled event
|
514
520
|
#
|
515
521
|
# @param amount [Float] Amount for the charge. Can be provided instead of unit_price and quantity. If am
|
516
|
-
# ...
|
517
522
|
#
|
518
523
|
# @param quantity [Float] Quantity for the charge. Will be multiplied by unit_price to determine the amoun
|
519
|
-
# ...
|
520
524
|
#
|
521
525
|
# @param unit_price [Float] Unit price for the charge. Will be multiplied by quantity to determine the amoun
|
522
|
-
# ...
|
523
526
|
end
|
524
527
|
end
|
525
528
|
|
526
|
-
# @see MetronomeSDK::
|
529
|
+
# @see MetronomeSDK::V1::ContractAmendParams::Commit#payment_gate_config
|
527
530
|
class PaymentGateConfig < MetronomeSDK::Internal::Type::BaseModel
|
528
531
|
# @!attribute payment_gate_type
|
529
532
|
# Gate access to the commit balance based on successful collection of payment.
|
@@ -531,47 +534,49 @@ module MetronomeSDK
|
|
531
534
|
# facilitate payment using your own payment integration. Select NONE if you do not
|
532
535
|
# wish to payment gate the commit balance.
|
533
536
|
#
|
534
|
-
# @return [Symbol, MetronomeSDK::
|
537
|
+
# @return [Symbol, MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::PaymentGateType]
|
535
538
|
required :payment_gate_type,
|
536
|
-
enum: -> {
|
539
|
+
enum: -> {
|
540
|
+
MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::PaymentGateType
|
541
|
+
}
|
537
542
|
|
538
543
|
# @!attribute stripe_config
|
539
544
|
# Only applicable if using Stripe as your payment gateway through Metronome.
|
540
545
|
#
|
541
|
-
# @return [MetronomeSDK::
|
546
|
+
# @return [MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::StripeConfig, nil]
|
542
547
|
optional :stripe_config,
|
543
|
-
-> { MetronomeSDK::
|
548
|
+
-> { MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::StripeConfig }
|
544
549
|
|
545
550
|
# @!attribute tax_type
|
546
551
|
# Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
|
547
552
|
# not wish Metronome to calculate tax on your behalf. Leaving this field blank
|
548
553
|
# will default to NONE.
|
549
554
|
#
|
550
|
-
# @return [Symbol, MetronomeSDK::
|
555
|
+
# @return [Symbol, MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::TaxType, nil]
|
551
556
|
optional :tax_type,
|
552
|
-
enum: -> {
|
557
|
+
enum: -> {
|
558
|
+
MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::TaxType
|
559
|
+
}
|
553
560
|
|
554
561
|
# @!method initialize(payment_gate_type:, stripe_config: nil, tax_type: nil)
|
555
562
|
# Some parameter documentations has been truncated, see
|
556
|
-
# {MetronomeSDK::
|
557
|
-
#
|
563
|
+
# {MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig} for more
|
564
|
+
# details.
|
558
565
|
#
|
559
566
|
# optionally payment gate this commit
|
560
567
|
#
|
561
|
-
# @param payment_gate_type [Symbol, MetronomeSDK::
|
562
|
-
# ...
|
568
|
+
# @param payment_gate_type [Symbol, MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::PaymentGateType] Gate access to the commit balance based on successful collection of payment. Sel
|
563
569
|
#
|
564
|
-
# @param stripe_config [MetronomeSDK::
|
570
|
+
# @param stripe_config [MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::StripeConfig] Only applicable if using Stripe as your payment gateway through Metronome.
|
565
571
|
#
|
566
|
-
# @param tax_type [Symbol, MetronomeSDK::
|
567
|
-
# ...
|
572
|
+
# @param tax_type [Symbol, MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::TaxType] Stripe tax is only supported for Stripe payment gateway. Select NONE if you do n
|
568
573
|
|
569
574
|
# Gate access to the commit balance based on successful collection of payment.
|
570
575
|
# Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
|
571
576
|
# facilitate payment using your own payment integration. Select NONE if you do not
|
572
577
|
# wish to payment gate the commit balance.
|
573
578
|
#
|
574
|
-
# @see MetronomeSDK::
|
579
|
+
# @see MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig#payment_gate_type
|
575
580
|
module PaymentGateType
|
576
581
|
extend MetronomeSDK::Internal::Type::Enum
|
577
582
|
|
@@ -583,23 +588,25 @@ module MetronomeSDK
|
|
583
588
|
# @return [Array<Symbol>]
|
584
589
|
end
|
585
590
|
|
586
|
-
# @see MetronomeSDK::
|
591
|
+
# @see MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig#stripe_config
|
587
592
|
class StripeConfig < MetronomeSDK::Internal::Type::BaseModel
|
588
593
|
# @!attribute payment_type
|
589
594
|
# If left blank, will default to INVOICE
|
590
595
|
#
|
591
|
-
# @return [Symbol, MetronomeSDK::
|
596
|
+
# @return [Symbol, MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::StripeConfig::PaymentType]
|
592
597
|
required :payment_type,
|
593
|
-
enum: -> {
|
598
|
+
enum: -> {
|
599
|
+
MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::StripeConfig::PaymentType
|
600
|
+
}
|
594
601
|
|
595
602
|
# @!method initialize(payment_type:)
|
596
603
|
# Only applicable if using Stripe as your payment gateway through Metronome.
|
597
604
|
#
|
598
|
-
# @param payment_type [Symbol, MetronomeSDK::
|
605
|
+
# @param payment_type [Symbol, MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::StripeConfig::PaymentType] If left blank, will default to INVOICE
|
599
606
|
|
600
607
|
# If left blank, will default to INVOICE
|
601
608
|
#
|
602
|
-
# @see MetronomeSDK::
|
609
|
+
# @see MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::StripeConfig#payment_type
|
603
610
|
module PaymentType
|
604
611
|
extend MetronomeSDK::Internal::Type::Enum
|
605
612
|
|
@@ -615,7 +622,7 @@ module MetronomeSDK
|
|
615
622
|
# not wish Metronome to calculate tax on your behalf. Leaving this field blank
|
616
623
|
# will default to NONE.
|
617
624
|
#
|
618
|
-
# @see MetronomeSDK::
|
625
|
+
# @see MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig#tax_type
|
619
626
|
module TaxType
|
620
627
|
extend MetronomeSDK::Internal::Type::Enum
|
621
628
|
|
@@ -627,7 +634,7 @@ module MetronomeSDK
|
|
627
634
|
end
|
628
635
|
end
|
629
636
|
|
630
|
-
# @see MetronomeSDK::
|
637
|
+
# @see MetronomeSDK::V1::ContractAmendParams::Commit#rate_type
|
631
638
|
module RateType
|
632
639
|
extend MetronomeSDK::Internal::Type::Enum
|
633
640
|
|
@@ -643,8 +650,8 @@ module MetronomeSDK
|
|
643
650
|
# @!attribute access_schedule
|
644
651
|
# Schedule for distributing the credit to the customer.
|
645
652
|
#
|
646
|
-
# @return [MetronomeSDK::
|
647
|
-
required :access_schedule, -> { MetronomeSDK::
|
653
|
+
# @return [MetronomeSDK::V1::ContractAmendParams::Credit::AccessSchedule]
|
654
|
+
required :access_schedule, -> { MetronomeSDK::V1::ContractAmendParams::Credit::AccessSchedule }
|
648
655
|
|
649
656
|
# @!attribute product_id
|
650
657
|
#
|
@@ -697,22 +704,20 @@ module MetronomeSDK
|
|
697
704
|
|
698
705
|
# @!attribute rate_type
|
699
706
|
#
|
700
|
-
# @return [Symbol, MetronomeSDK::
|
701
|
-
optional :rate_type, enum: -> { MetronomeSDK::
|
707
|
+
# @return [Symbol, MetronomeSDK::V1::ContractAmendParams::Credit::RateType, nil]
|
708
|
+
optional :rate_type, enum: -> { MetronomeSDK::V1::ContractAmendParams::Credit::RateType }
|
702
709
|
|
703
710
|
# @!method initialize(access_schedule:, product_id:, applicable_product_ids: nil, applicable_product_tags: nil, custom_fields: nil, description: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, rate_type: nil)
|
704
711
|
# Some parameter documentations has been truncated, see
|
705
|
-
# {MetronomeSDK::
|
712
|
+
# {MetronomeSDK::V1::ContractAmendParams::Credit} for more details.
|
706
713
|
#
|
707
|
-
# @param access_schedule [MetronomeSDK::
|
714
|
+
# @param access_schedule [MetronomeSDK::V1::ContractAmendParams::Credit::AccessSchedule] Schedule for distributing the credit to the customer.
|
708
715
|
#
|
709
716
|
# @param product_id [String]
|
710
717
|
#
|
711
718
|
# @param applicable_product_ids [Array<String>] Which products the credit applies to. If both applicable_product_ids and applica
|
712
|
-
# ...
|
713
719
|
#
|
714
720
|
# @param applicable_product_tags [Array<String>] Which tags the credit applies to. If both applicable*product_ids and applicable*
|
715
|
-
# ...
|
716
721
|
#
|
717
722
|
# @param custom_fields [Hash{Symbol=>String}]
|
718
723
|
#
|
@@ -723,17 +728,18 @@ module MetronomeSDK
|
|
723
728
|
# @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
|
724
729
|
#
|
725
730
|
# @param priority [Float] If multiple credits are applicable, the one with the lower priority will apply f
|
726
|
-
# ...
|
727
731
|
#
|
728
|
-
# @param rate_type [Symbol, MetronomeSDK::
|
732
|
+
# @param rate_type [Symbol, MetronomeSDK::V1::ContractAmendParams::Credit::RateType]
|
729
733
|
|
730
|
-
# @see MetronomeSDK::
|
734
|
+
# @see MetronomeSDK::V1::ContractAmendParams::Credit#access_schedule
|
731
735
|
class AccessSchedule < MetronomeSDK::Internal::Type::BaseModel
|
732
736
|
# @!attribute schedule_items
|
733
737
|
#
|
734
|
-
# @return [Array<MetronomeSDK::
|
738
|
+
# @return [Array<MetronomeSDK::V1::ContractAmendParams::Credit::AccessSchedule::ScheduleItem>]
|
735
739
|
required :schedule_items,
|
736
|
-
-> {
|
740
|
+
-> {
|
741
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Credit::AccessSchedule::ScheduleItem]
|
742
|
+
}
|
737
743
|
|
738
744
|
# @!attribute credit_type_id
|
739
745
|
# Defaults to USD (cents) if not passed
|
@@ -744,7 +750,7 @@ module MetronomeSDK
|
|
744
750
|
# @!method initialize(schedule_items:, credit_type_id: nil)
|
745
751
|
# Schedule for distributing the credit to the customer.
|
746
752
|
#
|
747
|
-
# @param schedule_items [Array<MetronomeSDK::
|
753
|
+
# @param schedule_items [Array<MetronomeSDK::V1::ContractAmendParams::Credit::AccessSchedule::ScheduleItem>]
|
748
754
|
#
|
749
755
|
# @param credit_type_id [String] Defaults to USD (cents) if not passed
|
750
756
|
|
@@ -775,7 +781,7 @@ module MetronomeSDK
|
|
775
781
|
end
|
776
782
|
end
|
777
783
|
|
778
|
-
# @see MetronomeSDK::
|
784
|
+
# @see MetronomeSDK::V1::ContractAmendParams::Credit#rate_type
|
779
785
|
module RateType
|
780
786
|
extend MetronomeSDK::Internal::Type::Enum
|
781
787
|
|
@@ -796,8 +802,8 @@ module MetronomeSDK
|
|
796
802
|
# @!attribute schedule
|
797
803
|
# Must provide either schedule_items or recurring_schedule.
|
798
804
|
#
|
799
|
-
# @return [MetronomeSDK::
|
800
|
-
required :schedule, -> { MetronomeSDK::
|
805
|
+
# @return [MetronomeSDK::V1::ContractAmendParams::Discount::Schedule]
|
806
|
+
required :schedule, -> { MetronomeSDK::V1::ContractAmendParams::Discount::Schedule }
|
801
807
|
|
802
808
|
# @!attribute custom_fields
|
803
809
|
#
|
@@ -819,7 +825,7 @@ module MetronomeSDK
|
|
819
825
|
# @!method initialize(product_id:, schedule:, custom_fields: nil, name: nil, netsuite_sales_order_id: nil)
|
820
826
|
# @param product_id [String]
|
821
827
|
#
|
822
|
-
# @param schedule [MetronomeSDK::
|
828
|
+
# @param schedule [MetronomeSDK::V1::ContractAmendParams::Discount::Schedule] Must provide either schedule_items or recurring_schedule.
|
823
829
|
#
|
824
830
|
# @param custom_fields [Hash{Symbol=>String}]
|
825
831
|
#
|
@@ -827,7 +833,7 @@ module MetronomeSDK
|
|
827
833
|
#
|
828
834
|
# @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
|
829
835
|
|
830
|
-
# @see MetronomeSDK::
|
836
|
+
# @see MetronomeSDK::V1::ContractAmendParams::Discount#schedule
|
831
837
|
class Schedule < MetronomeSDK::Internal::Type::BaseModel
|
832
838
|
# @!attribute credit_type_id
|
833
839
|
# Defaults to USD (cents) if not passed.
|
@@ -840,38 +846,40 @@ module MetronomeSDK
|
|
840
846
|
# amount. If amount is sent, the unit price is assumed to be the amount and
|
841
847
|
# quantity is inferred to be 1.
|
842
848
|
#
|
843
|
-
# @return [MetronomeSDK::
|
849
|
+
# @return [MetronomeSDK::V1::ContractAmendParams::Discount::Schedule::RecurringSchedule, nil]
|
844
850
|
optional :recurring_schedule,
|
845
|
-
-> { MetronomeSDK::
|
851
|
+
-> { MetronomeSDK::V1::ContractAmendParams::Discount::Schedule::RecurringSchedule }
|
846
852
|
|
847
853
|
# @!attribute schedule_items
|
848
854
|
# Either provide amount or provide both unit_price and quantity.
|
849
855
|
#
|
850
|
-
# @return [Array<MetronomeSDK::
|
856
|
+
# @return [Array<MetronomeSDK::V1::ContractAmendParams::Discount::Schedule::ScheduleItem>, nil]
|
851
857
|
optional :schedule_items,
|
852
|
-
-> {
|
858
|
+
-> {
|
859
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Discount::Schedule::ScheduleItem]
|
860
|
+
}
|
853
861
|
|
854
862
|
# @!method initialize(credit_type_id: nil, recurring_schedule: nil, schedule_items: nil)
|
855
863
|
# Some parameter documentations has been truncated, see
|
856
|
-
# {MetronomeSDK::
|
857
|
-
# details.
|
864
|
+
# {MetronomeSDK::V1::ContractAmendParams::Discount::Schedule} for more details.
|
858
865
|
#
|
859
866
|
# Must provide either schedule_items or recurring_schedule.
|
860
867
|
#
|
861
868
|
# @param credit_type_id [String] Defaults to USD (cents) if not passed.
|
862
869
|
#
|
863
|
-
# @param recurring_schedule [MetronomeSDK::
|
864
|
-
# ...
|
870
|
+
# @param recurring_schedule [MetronomeSDK::V1::ContractAmendParams::Discount::Schedule::RecurringSchedule] Enter the unit price and quantity for the charge or instead only send the amount
|
865
871
|
#
|
866
|
-
# @param schedule_items [Array<MetronomeSDK::
|
872
|
+
# @param schedule_items [Array<MetronomeSDK::V1::ContractAmendParams::Discount::Schedule::ScheduleItem>] Either provide amount or provide both unit_price and quantity.
|
867
873
|
|
868
|
-
# @see MetronomeSDK::
|
874
|
+
# @see MetronomeSDK::V1::ContractAmendParams::Discount::Schedule#recurring_schedule
|
869
875
|
class RecurringSchedule < MetronomeSDK::Internal::Type::BaseModel
|
870
876
|
# @!attribute amount_distribution
|
871
877
|
#
|
872
|
-
# @return [Symbol, MetronomeSDK::
|
878
|
+
# @return [Symbol, MetronomeSDK::V1::ContractAmendParams::Discount::Schedule::RecurringSchedule::AmountDistribution]
|
873
879
|
required :amount_distribution,
|
874
|
-
enum: -> {
|
880
|
+
enum: -> {
|
881
|
+
MetronomeSDK::V1::ContractAmendParams::Discount::Schedule::RecurringSchedule::AmountDistribution
|
882
|
+
}
|
875
883
|
|
876
884
|
# @!attribute ending_before
|
877
885
|
# RFC 3339 timestamp (exclusive).
|
@@ -881,9 +889,11 @@ module MetronomeSDK
|
|
881
889
|
|
882
890
|
# @!attribute frequency
|
883
891
|
#
|
884
|
-
# @return [Symbol, MetronomeSDK::
|
892
|
+
# @return [Symbol, MetronomeSDK::V1::ContractAmendParams::Discount::Schedule::RecurringSchedule::Frequency]
|
885
893
|
required :frequency,
|
886
|
-
enum: -> {
|
894
|
+
enum: -> {
|
895
|
+
MetronomeSDK::V1::ContractAmendParams::Discount::Schedule::RecurringSchedule::Frequency
|
896
|
+
}
|
887
897
|
|
888
898
|
# @!attribute starting_at
|
889
899
|
# RFC 3339 timestamp (inclusive).
|
@@ -917,31 +927,28 @@ module MetronomeSDK
|
|
917
927
|
|
918
928
|
# @!method initialize(amount_distribution:, ending_before:, frequency:, starting_at:, amount: nil, quantity: nil, unit_price: nil)
|
919
929
|
# Some parameter documentations has been truncated, see
|
920
|
-
# {MetronomeSDK::
|
930
|
+
# {MetronomeSDK::V1::ContractAmendParams::Discount::Schedule::RecurringSchedule}
|
921
931
|
# for more details.
|
922
932
|
#
|
923
933
|
# Enter the unit price and quantity for the charge or instead only send the
|
924
934
|
# amount. If amount is sent, the unit price is assumed to be the amount and
|
925
935
|
# quantity is inferred to be 1.
|
926
936
|
#
|
927
|
-
# @param amount_distribution [Symbol, MetronomeSDK::
|
937
|
+
# @param amount_distribution [Symbol, MetronomeSDK::V1::ContractAmendParams::Discount::Schedule::RecurringSchedule::AmountDistribution]
|
928
938
|
#
|
929
939
|
# @param ending_before [Time] RFC 3339 timestamp (exclusive).
|
930
940
|
#
|
931
|
-
# @param frequency [Symbol, MetronomeSDK::
|
941
|
+
# @param frequency [Symbol, MetronomeSDK::V1::ContractAmendParams::Discount::Schedule::RecurringSchedule::Frequency]
|
932
942
|
#
|
933
943
|
# @param starting_at [Time] RFC 3339 timestamp (inclusive).
|
934
944
|
#
|
935
945
|
# @param amount [Float] Amount for the charge. Can be provided instead of unit_price and quantity. If am
|
936
|
-
# ...
|
937
946
|
#
|
938
947
|
# @param quantity [Float] Quantity for the charge. Will be multiplied by unit_price to determine the amoun
|
939
|
-
# ...
|
940
948
|
#
|
941
949
|
# @param unit_price [Float] Unit price for the charge. Will be multiplied by quantity to determine the amoun
|
942
|
-
# ...
|
943
950
|
|
944
|
-
# @see MetronomeSDK::
|
951
|
+
# @see MetronomeSDK::V1::ContractAmendParams::Discount::Schedule::RecurringSchedule#amount_distribution
|
945
952
|
module AmountDistribution
|
946
953
|
extend MetronomeSDK::Internal::Type::Enum
|
947
954
|
|
@@ -953,7 +960,7 @@ module MetronomeSDK
|
|
953
960
|
# @return [Array<Symbol>]
|
954
961
|
end
|
955
962
|
|
956
|
-
# @see MetronomeSDK::
|
963
|
+
# @see MetronomeSDK::V1::ContractAmendParams::Discount::Schedule::RecurringSchedule#frequency
|
957
964
|
module Frequency
|
958
965
|
extend MetronomeSDK::Internal::Type::Enum
|
959
966
|
|
@@ -1000,19 +1007,16 @@ module MetronomeSDK
|
|
1000
1007
|
|
1001
1008
|
# @!method initialize(timestamp:, amount: nil, quantity: nil, unit_price: nil)
|
1002
1009
|
# Some parameter documentations has been truncated, see
|
1003
|
-
# {MetronomeSDK::
|
1004
|
-
#
|
1010
|
+
# {MetronomeSDK::V1::ContractAmendParams::Discount::Schedule::ScheduleItem} for
|
1011
|
+
# more details.
|
1005
1012
|
#
|
1006
1013
|
# @param timestamp [Time] timestamp of the scheduled event
|
1007
1014
|
#
|
1008
1015
|
# @param amount [Float] Amount for the charge. Can be provided instead of unit_price and quantity. If am
|
1009
|
-
# ...
|
1010
1016
|
#
|
1011
1017
|
# @param quantity [Float] Quantity for the charge. Will be multiplied by unit_price to determine the amoun
|
1012
|
-
# ...
|
1013
1018
|
#
|
1014
1019
|
# @param unit_price [Float] Unit price for the charge. Will be multiplied by quantity to determine the amoun
|
1015
|
-
# ...
|
1016
1020
|
end
|
1017
1021
|
end
|
1018
1022
|
end
|
@@ -1061,15 +1065,17 @@ module MetronomeSDK
|
|
1061
1065
|
# Cannot be used in conjunction with product_id or applicable_product_tags. If
|
1062
1066
|
# provided, the override will apply to all products with the specified specifiers.
|
1063
1067
|
#
|
1064
|
-
# @return [Array<MetronomeSDK::
|
1068
|
+
# @return [Array<MetronomeSDK::V1::ContractAmendParams::Override::OverrideSpecifier>, nil]
|
1065
1069
|
optional :override_specifiers,
|
1066
|
-
-> {
|
1070
|
+
-> {
|
1071
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Override::OverrideSpecifier]
|
1072
|
+
}
|
1067
1073
|
|
1068
1074
|
# @!attribute overwrite_rate
|
1069
1075
|
# Required for OVERWRITE type.
|
1070
1076
|
#
|
1071
|
-
# @return [MetronomeSDK::
|
1072
|
-
optional :overwrite_rate, -> { MetronomeSDK::
|
1077
|
+
# @return [MetronomeSDK::V1::ContractAmendParams::Override::OverwriteRate, nil]
|
1078
|
+
optional :overwrite_rate, -> { MetronomeSDK::V1::ContractAmendParams::Override::OverwriteRate }
|
1073
1079
|
|
1074
1080
|
# @!attribute priority
|
1075
1081
|
# Required for EXPLICIT multiplier prioritization scheme and all TIERED overrides.
|
@@ -1092,57 +1098,53 @@ module MetronomeSDK
|
|
1092
1098
|
# be used for overrides that have `is_commit_specific` set to `true`. Defaults to
|
1093
1099
|
# `"LIST_RATE"`.
|
1094
1100
|
#
|
1095
|
-
# @return [Symbol, MetronomeSDK::
|
1096
|
-
optional :target, enum: -> { MetronomeSDK::
|
1101
|
+
# @return [Symbol, MetronomeSDK::V1::ContractAmendParams::Override::Target, nil]
|
1102
|
+
optional :target, enum: -> { MetronomeSDK::V1::ContractAmendParams::Override::Target }
|
1097
1103
|
|
1098
1104
|
# @!attribute tiers
|
1099
1105
|
# Required for TIERED type. Must have at least one tier.
|
1100
1106
|
#
|
1101
|
-
# @return [Array<MetronomeSDK::
|
1107
|
+
# @return [Array<MetronomeSDK::V1::ContractAmendParams::Override::Tier>, nil]
|
1102
1108
|
optional :tiers,
|
1103
|
-
-> {
|
1109
|
+
-> {
|
1110
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Override::Tier]
|
1111
|
+
}
|
1104
1112
|
|
1105
1113
|
# @!attribute type
|
1106
1114
|
# Overwrites are prioritized over multipliers and tiered overrides.
|
1107
1115
|
#
|
1108
|
-
# @return [Symbol, MetronomeSDK::
|
1109
|
-
optional :type, enum: -> { MetronomeSDK::
|
1116
|
+
# @return [Symbol, MetronomeSDK::V1::ContractAmendParams::Override::Type, nil]
|
1117
|
+
optional :type, enum: -> { MetronomeSDK::V1::ContractAmendParams::Override::Type }
|
1110
1118
|
|
1111
1119
|
# @!method initialize(starting_at:, applicable_product_tags: nil, ending_before: nil, entitled: nil, is_commit_specific: nil, multiplier: nil, override_specifiers: nil, overwrite_rate: nil, priority: nil, product_id: nil, target: nil, tiers: nil, type: nil)
|
1112
1120
|
# Some parameter documentations has been truncated, see
|
1113
|
-
# {MetronomeSDK::
|
1121
|
+
# {MetronomeSDK::V1::ContractAmendParams::Override} for more details.
|
1114
1122
|
#
|
1115
1123
|
# @param starting_at [Time] RFC 3339 timestamp indicating when the override will start applying (inclusive)
|
1116
1124
|
#
|
1117
1125
|
# @param applicable_product_tags [Array<String>] tags identifying products whose rates are being overridden. Cannot be used in co
|
1118
|
-
# ...
|
1119
1126
|
#
|
1120
1127
|
# @param ending_before [Time] RFC 3339 timestamp indicating when the override will stop applying (exclusive)
|
1121
1128
|
#
|
1122
1129
|
# @param entitled [Boolean]
|
1123
1130
|
#
|
1124
1131
|
# @param is_commit_specific [Boolean] Indicates whether the override should only apply to commits. Defaults to `false`
|
1125
|
-
# ...
|
1126
1132
|
#
|
1127
1133
|
# @param multiplier [Float] Required for MULTIPLIER type. Must be >=0.
|
1128
1134
|
#
|
1129
|
-
# @param override_specifiers [Array<MetronomeSDK::
|
1130
|
-
# ...
|
1135
|
+
# @param override_specifiers [Array<MetronomeSDK::V1::ContractAmendParams::Override::OverrideSpecifier>] Cannot be used in conjunction with product_id or applicable_product_tags. If pro
|
1131
1136
|
#
|
1132
|
-
# @param overwrite_rate [MetronomeSDK::
|
1137
|
+
# @param overwrite_rate [MetronomeSDK::V1::ContractAmendParams::Override::OverwriteRate] Required for OVERWRITE type.
|
1133
1138
|
#
|
1134
1139
|
# @param priority [Float] Required for EXPLICIT multiplier prioritization scheme and all TIERED overrides.
|
1135
|
-
# ...
|
1136
1140
|
#
|
1137
1141
|
# @param product_id [String] ID of the product whose rate is being overridden. Cannot be used in conjunction
|
1138
|
-
# ...
|
1139
1142
|
#
|
1140
|
-
# @param target [Symbol, MetronomeSDK::
|
1141
|
-
# ...
|
1143
|
+
# @param target [Symbol, MetronomeSDK::V1::ContractAmendParams::Override::Target] Indicates whether the override applies to commit rates or list rates. Can only b
|
1142
1144
|
#
|
1143
|
-
# @param tiers [Array<MetronomeSDK::
|
1145
|
+
# @param tiers [Array<MetronomeSDK::V1::ContractAmendParams::Override::Tier>] Required for TIERED type. Must have at least one tier.
|
1144
1146
|
#
|
1145
|
-
# @param type [Symbol, MetronomeSDK::
|
1147
|
+
# @param type [Symbol, MetronomeSDK::V1::ContractAmendParams::Override::Type] Overwrites are prioritized over multipliers and tiered overrides.
|
1146
1148
|
|
1147
1149
|
class OverrideSpecifier < MetronomeSDK::Internal::Type::BaseModel
|
1148
1150
|
# @!attribute commit_ids
|
@@ -1201,37 +1203,33 @@ module MetronomeSDK
|
|
1201
1203
|
|
1202
1204
|
# @!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)
|
1203
1205
|
# Some parameter documentations has been truncated, see
|
1204
|
-
# {MetronomeSDK::
|
1205
|
-
#
|
1206
|
+
# {MetronomeSDK::V1::ContractAmendParams::Override::OverrideSpecifier} for more
|
1207
|
+
# details.
|
1206
1208
|
#
|
1207
1209
|
# @param commit_ids [Array<String>] Can only be used for commit specific overrides. Must be used in conjunction with
|
1208
|
-
# ...
|
1209
1210
|
#
|
1210
1211
|
# @param presentation_group_values [Hash{Symbol=>String}] A map of group names to values. The override will only apply to line items with
|
1211
|
-
# ...
|
1212
1212
|
#
|
1213
1213
|
# @param pricing_group_values [Hash{Symbol=>String}] A map of pricing group names to values. The override will only apply to products
|
1214
|
-
# ...
|
1215
1214
|
#
|
1216
1215
|
# @param product_id [String] If provided, the override will only apply to the product with the specified ID.
|
1217
1216
|
#
|
1218
1217
|
# @param product_tags [Array<String>] If provided, the override will only apply to products with all the specified tag
|
1219
|
-
# ...
|
1220
1218
|
#
|
1221
1219
|
# @param recurring_commit_ids [Array<String>] Can only be used for commit specific overrides. Must be used in conjunction with
|
1222
|
-
# ...
|
1223
1220
|
#
|
1224
1221
|
# @param recurring_credit_ids [Array<String>] Can only be used for commit specific overrides. Must be used in conjunction with
|
1225
|
-
# ...
|
1226
1222
|
end
|
1227
1223
|
|
1228
|
-
# @see MetronomeSDK::
|
1224
|
+
# @see MetronomeSDK::V1::ContractAmendParams::Override#overwrite_rate
|
1229
1225
|
class OverwriteRate < MetronomeSDK::Internal::Type::BaseModel
|
1230
1226
|
# @!attribute rate_type
|
1231
1227
|
#
|
1232
|
-
# @return [Symbol, MetronomeSDK::
|
1228
|
+
# @return [Symbol, MetronomeSDK::V1::ContractAmendParams::Override::OverwriteRate::RateType]
|
1233
1229
|
required :rate_type,
|
1234
|
-
enum: -> {
|
1230
|
+
enum: -> {
|
1231
|
+
MetronomeSDK::V1::ContractAmendParams::Override::OverwriteRate::RateType
|
1232
|
+
}
|
1235
1233
|
|
1236
1234
|
# @!attribute credit_type_id
|
1237
1235
|
#
|
@@ -1268,34 +1266,31 @@ module MetronomeSDK
|
|
1268
1266
|
# @!attribute tiers
|
1269
1267
|
# Only set for TIERED rate_type.
|
1270
1268
|
#
|
1271
|
-
# @return [Array<MetronomeSDK::
|
1272
|
-
optional :tiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::
|
1269
|
+
# @return [Array<MetronomeSDK::Tier>, nil]
|
1270
|
+
optional :tiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Tier] }
|
1273
1271
|
|
1274
1272
|
# @!method initialize(rate_type:, credit_type_id: nil, custom_rate: nil, is_prorated: nil, price: nil, quantity: nil, tiers: nil)
|
1275
1273
|
# Some parameter documentations has been truncated, see
|
1276
|
-
# {MetronomeSDK::
|
1277
|
-
#
|
1274
|
+
# {MetronomeSDK::V1::ContractAmendParams::Override::OverwriteRate} for more
|
1275
|
+
# details.
|
1278
1276
|
#
|
1279
1277
|
# Required for OVERWRITE type.
|
1280
1278
|
#
|
1281
|
-
# @param rate_type [Symbol, MetronomeSDK::
|
1279
|
+
# @param rate_type [Symbol, MetronomeSDK::V1::ContractAmendParams::Override::OverwriteRate::RateType]
|
1282
1280
|
#
|
1283
1281
|
# @param credit_type_id [String]
|
1284
1282
|
#
|
1285
1283
|
# @param custom_rate [Hash{Symbol=>Object}] Only set for CUSTOM rate_type. This field is interpreted by custom rate processo
|
1286
|
-
# ...
|
1287
1284
|
#
|
1288
1285
|
# @param is_prorated [Boolean] Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
|
1289
|
-
# ...
|
1290
1286
|
#
|
1291
1287
|
# @param price [Float] Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type, t
|
1292
|
-
# ...
|
1293
1288
|
#
|
1294
1289
|
# @param quantity [Float] Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
|
1295
1290
|
#
|
1296
|
-
# @param tiers [Array<MetronomeSDK::
|
1291
|
+
# @param tiers [Array<MetronomeSDK::Tier>] Only set for TIERED rate_type.
|
1297
1292
|
|
1298
|
-
# @see MetronomeSDK::
|
1293
|
+
# @see MetronomeSDK::V1::ContractAmendParams::Override::OverwriteRate#rate_type
|
1299
1294
|
module RateType
|
1300
1295
|
extend MetronomeSDK::Internal::Type::Enum
|
1301
1296
|
|
@@ -1314,7 +1309,7 @@ module MetronomeSDK
|
|
1314
1309
|
# be used for overrides that have `is_commit_specific` set to `true`. Defaults to
|
1315
1310
|
# `"LIST_RATE"`.
|
1316
1311
|
#
|
1317
|
-
# @see MetronomeSDK::
|
1312
|
+
# @see MetronomeSDK::V1::ContractAmendParams::Override#target
|
1318
1313
|
module Target
|
1319
1314
|
extend MetronomeSDK::Internal::Type::Enum
|
1320
1315
|
|
@@ -1343,7 +1338,7 @@ module MetronomeSDK
|
|
1343
1338
|
|
1344
1339
|
# Overwrites are prioritized over multipliers and tiered overrides.
|
1345
1340
|
#
|
1346
|
-
# @see MetronomeSDK::
|
1341
|
+
# @see MetronomeSDK::V1::ContractAmendParams::Override#type
|
1347
1342
|
module Type
|
1348
1343
|
extend MetronomeSDK::Internal::Type::Enum
|
1349
1344
|
|
@@ -1400,18 +1395,15 @@ module MetronomeSDK
|
|
1400
1395
|
|
1401
1396
|
# @!method initialize(max_amount:, product_id:, quantity:, unit_price:, custom_fields: nil, description: nil, netsuite_sales_order_id: nil)
|
1402
1397
|
# Some parameter documentations has been truncated, see
|
1403
|
-
# {MetronomeSDK::
|
1404
|
-
# details.
|
1398
|
+
# {MetronomeSDK::V1::ContractAmendParams::ProfessionalService} for more details.
|
1405
1399
|
#
|
1406
1400
|
# @param max_amount [Float] Maximum amount for the term.
|
1407
1401
|
#
|
1408
1402
|
# @param product_id [String]
|
1409
1403
|
#
|
1410
1404
|
# @param quantity [Float] Quantity for the charge. Will be multiplied by unit_price to determine the amoun
|
1411
|
-
# ...
|
1412
1405
|
#
|
1413
1406
|
# @param unit_price [Float] Unit price for the charge. Will be multiplied by quantity to determine the amoun
|
1414
|
-
# ...
|
1415
1407
|
#
|
1416
1408
|
# @param custom_fields [Hash{Symbol=>String}]
|
1417
1409
|
#
|
@@ -1423,9 +1415,11 @@ module MetronomeSDK
|
|
1423
1415
|
class ResellerRoyalty < MetronomeSDK::Internal::Type::BaseModel
|
1424
1416
|
# @!attribute reseller_type
|
1425
1417
|
#
|
1426
|
-
# @return [Symbol, MetronomeSDK::
|
1418
|
+
# @return [Symbol, MetronomeSDK::V1::ContractAmendParams::ResellerRoyalty::ResellerType]
|
1427
1419
|
required :reseller_type,
|
1428
|
-
enum: -> {
|
1420
|
+
enum: -> {
|
1421
|
+
MetronomeSDK::V1::ContractAmendParams::ResellerRoyalty::ResellerType
|
1422
|
+
}
|
1429
1423
|
|
1430
1424
|
# @!attribute applicable_product_ids
|
1431
1425
|
# Must provide at least one of applicable_product_ids or applicable_product_tags.
|
@@ -1441,8 +1435,8 @@ module MetronomeSDK
|
|
1441
1435
|
|
1442
1436
|
# @!attribute aws_options
|
1443
1437
|
#
|
1444
|
-
# @return [MetronomeSDK::
|
1445
|
-
optional :aws_options, -> { MetronomeSDK::
|
1438
|
+
# @return [MetronomeSDK::V1::ContractAmendParams::ResellerRoyalty::AwsOptions, nil]
|
1439
|
+
optional :aws_options, -> { MetronomeSDK::V1::ContractAmendParams::ResellerRoyalty::AwsOptions }
|
1446
1440
|
|
1447
1441
|
# @!attribute ending_before
|
1448
1442
|
# Use null to indicate that the existing end timestamp should be removed.
|
@@ -1457,8 +1451,8 @@ module MetronomeSDK
|
|
1457
1451
|
|
1458
1452
|
# @!attribute gcp_options
|
1459
1453
|
#
|
1460
|
-
# @return [MetronomeSDK::
|
1461
|
-
optional :gcp_options, -> { MetronomeSDK::
|
1454
|
+
# @return [MetronomeSDK::V1::ContractAmendParams::ResellerRoyalty::GcpOptions, nil]
|
1455
|
+
optional :gcp_options, -> { MetronomeSDK::V1::ContractAmendParams::ResellerRoyalty::GcpOptions }
|
1462
1456
|
|
1463
1457
|
# @!attribute netsuite_reseller_id
|
1464
1458
|
#
|
@@ -1476,19 +1470,19 @@ module MetronomeSDK
|
|
1476
1470
|
optional :starting_at, Time
|
1477
1471
|
|
1478
1472
|
# @!method initialize(reseller_type:, applicable_product_ids: nil, applicable_product_tags: nil, aws_options: nil, ending_before: nil, fraction: nil, gcp_options: nil, netsuite_reseller_id: nil, reseller_contract_value: nil, starting_at: nil)
|
1479
|
-
# @param reseller_type [Symbol, MetronomeSDK::
|
1473
|
+
# @param reseller_type [Symbol, MetronomeSDK::V1::ContractAmendParams::ResellerRoyalty::ResellerType]
|
1480
1474
|
#
|
1481
1475
|
# @param applicable_product_ids [Array<String>] Must provide at least one of applicable_product_ids or applicable_product_tags.
|
1482
1476
|
#
|
1483
1477
|
# @param applicable_product_tags [Array<String>] Must provide at least one of applicable_product_ids or applicable_product_tags.
|
1484
1478
|
#
|
1485
|
-
# @param aws_options [MetronomeSDK::
|
1479
|
+
# @param aws_options [MetronomeSDK::V1::ContractAmendParams::ResellerRoyalty::AwsOptions]
|
1486
1480
|
#
|
1487
1481
|
# @param ending_before [Time, nil] Use null to indicate that the existing end timestamp should be removed.
|
1488
1482
|
#
|
1489
1483
|
# @param fraction [Float]
|
1490
1484
|
#
|
1491
|
-
# @param gcp_options [MetronomeSDK::
|
1485
|
+
# @param gcp_options [MetronomeSDK::V1::ContractAmendParams::ResellerRoyalty::GcpOptions]
|
1492
1486
|
#
|
1493
1487
|
# @param netsuite_reseller_id [String]
|
1494
1488
|
#
|
@@ -1496,7 +1490,7 @@ module MetronomeSDK
|
|
1496
1490
|
#
|
1497
1491
|
# @param starting_at [Time]
|
1498
1492
|
|
1499
|
-
# @see MetronomeSDK::
|
1493
|
+
# @see MetronomeSDK::V1::ContractAmendParams::ResellerRoyalty#reseller_type
|
1500
1494
|
module ResellerType
|
1501
1495
|
extend MetronomeSDK::Internal::Type::Enum
|
1502
1496
|
|
@@ -1509,7 +1503,7 @@ module MetronomeSDK
|
|
1509
1503
|
# @return [Array<Symbol>]
|
1510
1504
|
end
|
1511
1505
|
|
1512
|
-
# @see MetronomeSDK::
|
1506
|
+
# @see MetronomeSDK::V1::ContractAmendParams::ResellerRoyalty#aws_options
|
1513
1507
|
class AwsOptions < MetronomeSDK::Internal::Type::BaseModel
|
1514
1508
|
# @!attribute aws_account_number
|
1515
1509
|
#
|
@@ -1532,7 +1526,7 @@ module MetronomeSDK
|
|
1532
1526
|
# @param aws_payer_reference_id [String]
|
1533
1527
|
end
|
1534
1528
|
|
1535
|
-
# @see MetronomeSDK::
|
1529
|
+
# @see MetronomeSDK::V1::ContractAmendParams::ResellerRoyalty#gcp_options
|
1536
1530
|
class GcpOptions < MetronomeSDK::Internal::Type::BaseModel
|
1537
1531
|
# @!attribute gcp_account_id
|
1538
1532
|
#
|
@@ -1559,8 +1553,8 @@ module MetronomeSDK
|
|
1559
1553
|
# @!attribute schedule
|
1560
1554
|
# Must provide either schedule_items or recurring_schedule.
|
1561
1555
|
#
|
1562
|
-
# @return [MetronomeSDK::
|
1563
|
-
required :schedule, -> { MetronomeSDK::
|
1556
|
+
# @return [MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule]
|
1557
|
+
required :schedule, -> { MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule }
|
1564
1558
|
|
1565
1559
|
# @!attribute name
|
1566
1560
|
# displayed on invoices
|
@@ -1577,13 +1571,13 @@ module MetronomeSDK
|
|
1577
1571
|
# @!method initialize(product_id:, schedule:, name: nil, netsuite_sales_order_id: nil)
|
1578
1572
|
# @param product_id [String]
|
1579
1573
|
#
|
1580
|
-
# @param schedule [MetronomeSDK::
|
1574
|
+
# @param schedule [MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule] Must provide either schedule_items or recurring_schedule.
|
1581
1575
|
#
|
1582
1576
|
# @param name [String] displayed on invoices
|
1583
1577
|
#
|
1584
1578
|
# @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
|
1585
1579
|
|
1586
|
-
# @see MetronomeSDK::
|
1580
|
+
# @see MetronomeSDK::V1::ContractAmendParams::ScheduledCharge#schedule
|
1587
1581
|
class Schedule < MetronomeSDK::Internal::Type::BaseModel
|
1588
1582
|
# @!attribute credit_type_id
|
1589
1583
|
# Defaults to USD (cents) if not passed.
|
@@ -1596,38 +1590,43 @@ module MetronomeSDK
|
|
1596
1590
|
# amount. If amount is sent, the unit price is assumed to be the amount and
|
1597
1591
|
# quantity is inferred to be 1.
|
1598
1592
|
#
|
1599
|
-
# @return [MetronomeSDK::
|
1593
|
+
# @return [MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::RecurringSchedule, nil]
|
1600
1594
|
optional :recurring_schedule,
|
1601
|
-
-> {
|
1595
|
+
-> {
|
1596
|
+
MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::RecurringSchedule
|
1597
|
+
}
|
1602
1598
|
|
1603
1599
|
# @!attribute schedule_items
|
1604
1600
|
# Either provide amount or provide both unit_price and quantity.
|
1605
1601
|
#
|
1606
|
-
# @return [Array<MetronomeSDK::
|
1602
|
+
# @return [Array<MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::ScheduleItem>, nil]
|
1607
1603
|
optional :schedule_items,
|
1608
|
-
-> {
|
1604
|
+
-> {
|
1605
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::ScheduleItem]
|
1606
|
+
}
|
1609
1607
|
|
1610
1608
|
# @!method initialize(credit_type_id: nil, recurring_schedule: nil, schedule_items: nil)
|
1611
1609
|
# Some parameter documentations has been truncated, see
|
1612
|
-
# {MetronomeSDK::
|
1613
|
-
#
|
1610
|
+
# {MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule} for more
|
1611
|
+
# details.
|
1614
1612
|
#
|
1615
1613
|
# Must provide either schedule_items or recurring_schedule.
|
1616
1614
|
#
|
1617
1615
|
# @param credit_type_id [String] Defaults to USD (cents) if not passed.
|
1618
1616
|
#
|
1619
|
-
# @param recurring_schedule [MetronomeSDK::
|
1620
|
-
# ...
|
1617
|
+
# @param recurring_schedule [MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::RecurringSchedule] Enter the unit price and quantity for the charge or instead only send the amount
|
1621
1618
|
#
|
1622
|
-
# @param schedule_items [Array<MetronomeSDK::
|
1619
|
+
# @param schedule_items [Array<MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::ScheduleItem>] Either provide amount or provide both unit_price and quantity.
|
1623
1620
|
|
1624
|
-
# @see MetronomeSDK::
|
1621
|
+
# @see MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule#recurring_schedule
|
1625
1622
|
class RecurringSchedule < MetronomeSDK::Internal::Type::BaseModel
|
1626
1623
|
# @!attribute amount_distribution
|
1627
1624
|
#
|
1628
|
-
# @return [Symbol, MetronomeSDK::
|
1625
|
+
# @return [Symbol, MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::RecurringSchedule::AmountDistribution]
|
1629
1626
|
required :amount_distribution,
|
1630
|
-
enum: -> {
|
1627
|
+
enum: -> {
|
1628
|
+
MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::RecurringSchedule::AmountDistribution
|
1629
|
+
}
|
1631
1630
|
|
1632
1631
|
# @!attribute ending_before
|
1633
1632
|
# RFC 3339 timestamp (exclusive).
|
@@ -1637,9 +1636,11 @@ module MetronomeSDK
|
|
1637
1636
|
|
1638
1637
|
# @!attribute frequency
|
1639
1638
|
#
|
1640
|
-
# @return [Symbol, MetronomeSDK::
|
1639
|
+
# @return [Symbol, MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::RecurringSchedule::Frequency]
|
1641
1640
|
required :frequency,
|
1642
|
-
enum: -> {
|
1641
|
+
enum: -> {
|
1642
|
+
MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::RecurringSchedule::Frequency
|
1643
|
+
}
|
1643
1644
|
|
1644
1645
|
# @!attribute starting_at
|
1645
1646
|
# RFC 3339 timestamp (inclusive).
|
@@ -1673,31 +1674,28 @@ module MetronomeSDK
|
|
1673
1674
|
|
1674
1675
|
# @!method initialize(amount_distribution:, ending_before:, frequency:, starting_at:, amount: nil, quantity: nil, unit_price: nil)
|
1675
1676
|
# Some parameter documentations has been truncated, see
|
1676
|
-
# {MetronomeSDK::
|
1677
|
+
# {MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::RecurringSchedule}
|
1677
1678
|
# for more details.
|
1678
1679
|
#
|
1679
1680
|
# Enter the unit price and quantity for the charge or instead only send the
|
1680
1681
|
# amount. If amount is sent, the unit price is assumed to be the amount and
|
1681
1682
|
# quantity is inferred to be 1.
|
1682
1683
|
#
|
1683
|
-
# @param amount_distribution [Symbol, MetronomeSDK::
|
1684
|
+
# @param amount_distribution [Symbol, MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::RecurringSchedule::AmountDistribution]
|
1684
1685
|
#
|
1685
1686
|
# @param ending_before [Time] RFC 3339 timestamp (exclusive).
|
1686
1687
|
#
|
1687
|
-
# @param frequency [Symbol, MetronomeSDK::
|
1688
|
+
# @param frequency [Symbol, MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::RecurringSchedule::Frequency]
|
1688
1689
|
#
|
1689
1690
|
# @param starting_at [Time] RFC 3339 timestamp (inclusive).
|
1690
1691
|
#
|
1691
1692
|
# @param amount [Float] Amount for the charge. Can be provided instead of unit_price and quantity. If am
|
1692
|
-
# ...
|
1693
1693
|
#
|
1694
1694
|
# @param quantity [Float] Quantity for the charge. Will be multiplied by unit_price to determine the amoun
|
1695
|
-
# ...
|
1696
1695
|
#
|
1697
1696
|
# @param unit_price [Float] Unit price for the charge. Will be multiplied by quantity to determine the amoun
|
1698
|
-
# ...
|
1699
1697
|
|
1700
|
-
# @see MetronomeSDK::
|
1698
|
+
# @see MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::RecurringSchedule#amount_distribution
|
1701
1699
|
module AmountDistribution
|
1702
1700
|
extend MetronomeSDK::Internal::Type::Enum
|
1703
1701
|
|
@@ -1709,7 +1707,7 @@ module MetronomeSDK
|
|
1709
1707
|
# @return [Array<Symbol>]
|
1710
1708
|
end
|
1711
1709
|
|
1712
|
-
# @see MetronomeSDK::
|
1710
|
+
# @see MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::RecurringSchedule#frequency
|
1713
1711
|
module Frequency
|
1714
1712
|
extend MetronomeSDK::Internal::Type::Enum
|
1715
1713
|
|
@@ -1756,19 +1754,16 @@ module MetronomeSDK
|
|
1756
1754
|
|
1757
1755
|
# @!method initialize(timestamp:, amount: nil, quantity: nil, unit_price: nil)
|
1758
1756
|
# Some parameter documentations has been truncated, see
|
1759
|
-
# {MetronomeSDK::
|
1757
|
+
# {MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::ScheduleItem}
|
1760
1758
|
# for more details.
|
1761
1759
|
#
|
1762
1760
|
# @param timestamp [Time] timestamp of the scheduled event
|
1763
1761
|
#
|
1764
1762
|
# @param amount [Float] Amount for the charge. Can be provided instead of unit_price and quantity. If am
|
1765
|
-
# ...
|
1766
1763
|
#
|
1767
1764
|
# @param quantity [Float] Quantity for the charge. Will be multiplied by unit_price to determine the amoun
|
1768
|
-
# ...
|
1769
1765
|
#
|
1770
1766
|
# @param unit_price [Float] Unit price for the charge. Will be multiplied by quantity to determine the amoun
|
1771
|
-
# ...
|
1772
1767
|
end
|
1773
1768
|
end
|
1774
1769
|
end
|