metronome-sdk 0.3.0 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +91 -0
- data/README.md +9 -9
- data/lib/metronome_sdk/errors.rb +25 -11
- data/lib/metronome_sdk/file_part.rb +10 -7
- data/lib/metronome_sdk/internal/body_cursor_page.rb +86 -0
- data/lib/metronome_sdk/internal/cursor_page.rb +1 -1
- data/lib/metronome_sdk/internal/cursor_page_without_limit.rb +86 -0
- data/lib/metronome_sdk/internal/transport/base_client.rb +12 -11
- data/lib/metronome_sdk/internal/transport/pooled_net_requester.rb +8 -19
- data/lib/metronome_sdk/internal/type/base_model.rb +6 -13
- data/lib/metronome_sdk/internal/type/base_page.rb +1 -1
- data/lib/metronome_sdk/internal/type/enum.rb +25 -0
- data/lib/metronome_sdk/internal/type/file_input.rb +7 -4
- data/lib/metronome_sdk/internal/type/union.rb +11 -0
- data/lib/metronome_sdk/internal/util.rb +9 -8
- data/lib/metronome_sdk/models/base_threshold_commit.rb +36 -0
- data/lib/metronome_sdk/models/commit.rb +26 -170
- data/lib/metronome_sdk/models/commit_hierarchy_configuration.rb +98 -0
- data/lib/metronome_sdk/models/commit_rate.rb +48 -0
- data/lib/metronome_sdk/models/commit_specifier.rb +42 -0
- data/lib/metronome_sdk/models/commit_specifier_input.rb +42 -0
- data/lib/metronome_sdk/models/contract.rb +404 -0
- data/lib/metronome_sdk/models/contract_v2.rb +3169 -0
- data/lib/metronome_sdk/models/contract_without_amendments.rb +38 -1128
- data/lib/metronome_sdk/models/credit.rb +9 -156
- data/lib/metronome_sdk/models/discount.rb +2 -1
- data/lib/metronome_sdk/models/hierarchy_configuration.rb +173 -0
- data/lib/metronome_sdk/models/override.rb +6 -101
- data/lib/metronome_sdk/models/override_tier.rb +21 -0
- data/lib/metronome_sdk/models/overwrite_rate.rb +82 -0
- data/lib/metronome_sdk/models/payment_gate_config.rb +150 -0
- data/lib/metronome_sdk/models/payment_gate_config_v2.rb +150 -0
- data/lib/metronome_sdk/models/prepaid_balance_threshold_configuration.rb +100 -0
- data/lib/metronome_sdk/models/prepaid_balance_threshold_configuration_v2.rb +102 -0
- data/lib/metronome_sdk/models/pro_service.rb +2 -1
- data/lib/metronome_sdk/models/recurring_commit_subscription_config.rb +51 -0
- data/lib/metronome_sdk/models/scheduled_charge.rb +2 -1
- data/lib/metronome_sdk/models/spend_threshold_configuration.rb +44 -0
- data/lib/metronome_sdk/models/spend_threshold_configuration_v2.rb +44 -0
- data/lib/metronome_sdk/models/subscription.rb +311 -0
- data/lib/metronome_sdk/models/update_base_threshold_commit.rb +36 -0
- data/lib/metronome_sdk/models/v1/alert_archive_params.rb +8 -4
- data/lib/metronome_sdk/models/v1/alert_create_params.rb +42 -42
- data/lib/metronome_sdk/models/v1/billable_metric_create_params.rb +1 -2
- data/lib/metronome_sdk/models/v1/billable_metric_list_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/billable_metric_retrieve_response.rb +4 -7
- data/lib/metronome_sdk/models/v1/contract_amend_params.rb +58 -411
- data/lib/metronome_sdk/models/v1/contract_create_historical_invoices_params.rb +7 -16
- data/lib/metronome_sdk/models/v1/contract_create_params.rb +315 -1459
- data/lib/metronome_sdk/models/v1/contract_list_balances_response.rb +6 -23
- data/lib/metronome_sdk/models/v1/contract_list_response.rb +3 -1153
- data/lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rb +2 -6
- data/lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rb +5 -50
- data/lib/metronome_sdk/models/v1/contract_retrieve_response.rb +3 -1154
- data/lib/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_params.rb +1 -3
- data/lib/metronome_sdk/models/v1/contracts/product_create_params.rb +2 -1
- data/lib/metronome_sdk/models/v1/contracts/product_list_response.rb +8 -1
- data/lib/metronome_sdk/models/v1/contracts/product_retrieve_response.rb +8 -1
- data/lib/metronome_sdk/models/v1/contracts/quantity_rounding.rb +1 -4
- data/lib/metronome_sdk/models/v1/contracts/rate_card_create_params.rb +4 -7
- data/lib/metronome_sdk/models/v1/contracts/rate_card_list_response.rb +10 -1
- data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rb +2 -6
- data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rb +5 -50
- data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rb +10 -1
- data/lib/metronome_sdk/models/v1/contracts/rate_card_update_params.rb +1 -3
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_params.rb +1 -3
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rb +6 -61
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb +3 -49
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rb +4 -51
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_params.rb +2 -6
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rb +5 -49
- data/lib/metronome_sdk/models/v1/credit_grant_list_entries_response.rb +103 -123
- data/lib/metronome_sdk/models/v1/credit_grant_list_response.rb +3 -5
- data/lib/metronome_sdk/models/v1/custom_field_list_keys_params.rb +1 -3
- data/lib/metronome_sdk/models/v1/custom_field_list_keys_response.rb +41 -58
- data/lib/metronome_sdk/models/v1/custom_field_set_values_params.rb +5 -1
- data/lib/metronome_sdk/models/v1/customer.rb +2 -1
- data/lib/metronome_sdk/models/v1/customer_create_params.rb +37 -11
- data/lib/metronome_sdk/models/v1/customer_detail.rb +11 -2
- data/lib/metronome_sdk/models/v1/customer_list_billable_metrics_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/customer_preview_events_params.rb +6 -18
- data/lib/metronome_sdk/models/v1/customer_preview_events_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/customer_retrieve_billing_configurations_params.rb +28 -0
- data/lib/metronome_sdk/models/v1/customer_retrieve_billing_configurations_response.rb +128 -0
- data/lib/metronome_sdk/models/v1/customer_set_billing_configurations_params.rb +143 -0
- data/lib/metronome_sdk/models/v1/customers/alert_list_params.rb +4 -6
- data/lib/metronome_sdk/models/v1/customers/alert_reset_params.rb +2 -2
- data/lib/metronome_sdk/models/v1/customers/alert_retrieve_params.rb +37 -8
- data/lib/metronome_sdk/models/v1/customers/billing_config_create_params.rb +2 -0
- data/lib/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rb +2 -0
- data/lib/metronome_sdk/models/v1/customers/commit_create_params.rb +10 -60
- data/lib/metronome_sdk/models/v1/customers/credit_create_params.rb +6 -48
- data/lib/metronome_sdk/models/v1/customers/customer_alert.rb +48 -54
- data/lib/metronome_sdk/models/v1/customers/invoice.rb +197 -66
- data/lib/metronome_sdk/models/v1/customers/invoice_list_breakdowns_params.rb +1 -4
- data/lib/metronome_sdk/models/v1/customers/invoice_retrieve_pdf_params.rb +30 -0
- data/lib/metronome_sdk/models/v1/customers/plan_add_params.rb +2 -6
- data/lib/metronome_sdk/models/v1/customers/plan_list_response.rb +2 -1
- data/lib/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rb +4 -11
- data/lib/metronome_sdk/models/v1/payment.rb +151 -0
- data/lib/metronome_sdk/models/v1/payment_attempt_params.rb +28 -0
- data/lib/metronome_sdk/models/v1/payment_attempt_response.rb +18 -0
- data/lib/metronome_sdk/models/v1/payment_cancel_params.rb +28 -0
- data/lib/metronome_sdk/models/v1/payment_cancel_response.rb +18 -0
- data/lib/metronome_sdk/models/v1/payment_list_params.rb +53 -0
- data/lib/metronome_sdk/models/v1/payment_status.rb +19 -0
- data/lib/metronome_sdk/models/v1/plan_detail.rb +9 -5
- data/lib/metronome_sdk/models/v1/plan_list_charges_response.rb +2 -1
- data/lib/metronome_sdk/models/v1/plan_list_customers_response.rb +2 -1
- data/lib/metronome_sdk/models/v1/plan_list_response.rb +5 -1
- data/lib/metronome_sdk/models/v1/usage_ingest_params.rb +1 -4
- data/lib/metronome_sdk/models/v1/usage_list_params.rb +1 -3
- data/lib/metronome_sdk/models/v1/usage_list_response.rb +45 -62
- data/lib/metronome_sdk/models/v1/usage_search_response.rb +4 -7
- data/lib/metronome_sdk/models/v2/contract_edit_commit_params.rb +37 -58
- data/lib/metronome_sdk/models/v2/contract_edit_credit_params.rb +34 -49
- data/lib/metronome_sdk/models/v2/contract_edit_params.rb +552 -2265
- data/lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb +417 -2317
- data/lib/metronome_sdk/models/v2/contract_list_response.rb +3 -4520
- data/lib/metronome_sdk/models/v2/contract_retrieve_response.rb +3 -4528
- data/lib/metronome_sdk/models.rb +38 -0
- data/lib/metronome_sdk/resources/v1/alerts.rb +90 -16
- data/lib/metronome_sdk/resources/v1/audit_logs.rb +39 -4
- data/lib/metronome_sdk/resources/v1/billable_metrics.rb +54 -4
- data/lib/metronome_sdk/resources/v1/contracts/products.rb +25 -6
- data/lib/metronome_sdk/resources/v1/contracts/rate_cards/product_orders.rb +7 -2
- data/lib/metronome_sdk/resources/v1/contracts/rate_cards/rates.rb +10 -2
- data/lib/metronome_sdk/resources/v1/contracts/rate_cards.rb +109 -10
- data/lib/metronome_sdk/resources/v1/contracts.rb +255 -18
- data/lib/metronome_sdk/resources/v1/credit_grants.rb +2 -1
- data/lib/metronome_sdk/resources/v1/custom_fields.rb +51 -14
- data/lib/metronome_sdk/resources/v1/customers/alerts.rb +127 -13
- data/lib/metronome_sdk/resources/v1/customers/commits.rb +119 -9
- data/lib/metronome_sdk/resources/v1/customers/credits.rb +104 -8
- data/lib/metronome_sdk/resources/v1/customers/invoices.rb +179 -8
- data/lib/metronome_sdk/resources/v1/customers.rb +175 -15
- data/lib/metronome_sdk/resources/v1/dashboards.rb +29 -3
- data/lib/metronome_sdk/resources/v1/invoices.rb +23 -2
- data/lib/metronome_sdk/resources/v1/payments.rb +102 -0
- data/lib/metronome_sdk/resources/v1/pricing_units.rb +6 -1
- data/lib/metronome_sdk/resources/v1/services.rb +6 -4
- data/lib/metronome_sdk/resources/v1/usage.rb +188 -13
- data/lib/metronome_sdk/resources/v1.rb +4 -0
- data/lib/metronome_sdk/resources/v2/contracts.rb +120 -18
- data/lib/metronome_sdk/version.rb +1 -1
- data/lib/metronome_sdk.rb +33 -3
- data/rbi/metronome_sdk/errors.rbi +31 -4
- data/rbi/metronome_sdk/file_part.rbi +1 -1
- data/rbi/metronome_sdk/internal/body_cursor_page.rbi +22 -0
- data/rbi/metronome_sdk/internal/cursor_page_without_limit.rbi +22 -0
- data/rbi/metronome_sdk/internal/transport/base_client.rbi +4 -5
- data/rbi/metronome_sdk/internal/type/base_page.rbi +1 -1
- data/rbi/metronome_sdk/internal/util.rbi +1 -1
- data/rbi/metronome_sdk/models/base_threshold_commit.rbi +58 -0
- data/rbi/metronome_sdk/models/commit.rbi +26 -348
- data/rbi/metronome_sdk/models/commit_hierarchy_configuration.rbi +280 -0
- data/rbi/metronome_sdk/models/commit_rate.rbi +85 -0
- data/rbi/metronome_sdk/models/commit_specifier.rbi +71 -0
- data/rbi/metronome_sdk/models/commit_specifier_input.rbi +74 -0
- data/rbi/metronome_sdk/models/contract.rbi +768 -0
- data/rbi/metronome_sdk/models/contract_v2.rbi +6415 -0
- data/rbi/metronome_sdk/models/contract_without_amendments.rbi +186 -2509
- data/rbi/metronome_sdk/models/credit.rbi +10 -348
- data/rbi/metronome_sdk/models/discount.rbi +2 -0
- data/rbi/metronome_sdk/models/hierarchy_configuration.rbi +424 -0
- data/rbi/metronome_sdk/models/override.rbi +8 -193
- data/rbi/metronome_sdk/models/override_tier.rbi +29 -0
- data/rbi/metronome_sdk/models/overwrite_rate.rbi +137 -0
- data/rbi/metronome_sdk/models/payment_gate_config.rbi +317 -0
- data/rbi/metronome_sdk/models/payment_gate_config_v2.rbi +326 -0
- data/rbi/metronome_sdk/models/prepaid_balance_threshold_configuration.rbi +183 -0
- data/rbi/metronome_sdk/models/prepaid_balance_threshold_configuration_v2.rbi +188 -0
- data/rbi/metronome_sdk/models/pro_service.rbi +2 -0
- data/rbi/metronome_sdk/models/recurring_commit_subscription_config.rbi +125 -0
- data/rbi/metronome_sdk/models/scheduled_charge.rbi +2 -0
- data/rbi/metronome_sdk/models/spend_threshold_configuration.rbi +76 -0
- data/rbi/metronome_sdk/models/spend_threshold_configuration_v2.rbi +78 -0
- data/rbi/metronome_sdk/models/subscription.rbi +635 -0
- data/rbi/metronome_sdk/models/update_base_threshold_commit.rbi +61 -0
- data/rbi/metronome_sdk/models/v1/alert_archive_params.rbi +6 -4
- data/rbi/metronome_sdk/models/v1/alert_create_params.rbi +57 -50
- data/rbi/metronome_sdk/models/v1/billable_metric_list_response.rbi +2 -0
- data/rbi/metronome_sdk/models/v1/billable_metric_retrieve_response.rbi +2 -0
- data/rbi/metronome_sdk/models/v1/contract_amend_params.rbi +49 -768
- data/rbi/metronome_sdk/models/v1/contract_create_historical_invoices_params.rbi +2 -0
- data/rbi/metronome_sdk/models/v1/contract_create_params.rbi +1843 -4119
- data/rbi/metronome_sdk/models/v1/contract_list_balances_response.rbi +8 -59
- data/rbi/metronome_sdk/models/v1/contract_list_response.rbi +5 -2420
- data/rbi/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rbi +6 -129
- data/rbi/metronome_sdk/models/v1/contract_retrieve_response.rbi +4 -2419
- data/rbi/metronome_sdk/models/v1/contracts/product_create_params.rbi +2 -0
- data/rbi/metronome_sdk/models/v1/contracts/product_list_response.rbi +2 -0
- data/rbi/metronome_sdk/models/v1/contracts/product_retrieve_response.rbi +2 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_create_params.rbi +2 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_list_response.rbi +2 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rbi +6 -129
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rbi +2 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rbi +4 -129
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbi +4 -129
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rbi +4 -129
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rbi +6 -129
- data/rbi/metronome_sdk/models/v1/credit_grant_list_entries_response.rbi +147 -198
- data/rbi/metronome_sdk/models/v1/credit_grant_list_response.rbi +2 -0
- data/rbi/metronome_sdk/models/v1/custom_field_list_keys_response.rbi +117 -165
- data/rbi/metronome_sdk/models/v1/custom_field_set_values_params.rbi +8 -1
- data/rbi/metronome_sdk/models/v1/customer.rbi +2 -0
- data/rbi/metronome_sdk/models/v1/customer_create_params.rbi +88 -3
- data/rbi/metronome_sdk/models/v1/customer_detail.rbi +10 -0
- data/rbi/metronome_sdk/models/v1/customer_list_billable_metrics_response.rbi +2 -0
- data/rbi/metronome_sdk/models/v1/customer_preview_events_params.rbi +6 -21
- data/rbi/metronome_sdk/models/v1/customer_preview_events_response.rbi +10 -9
- data/rbi/metronome_sdk/models/v1/customer_retrieve_billing_configurations_params.rbi +51 -0
- data/rbi/metronome_sdk/models/v1/customer_retrieve_billing_configurations_response.rbi +265 -0
- data/rbi/metronome_sdk/models/v1/customer_set_billing_configurations_params.rbi +348 -0
- data/rbi/metronome_sdk/models/v1/customers/alert_list_params.rbi +4 -4
- data/rbi/metronome_sdk/models/v1/customers/alert_reset_params.rbi +2 -2
- data/rbi/metronome_sdk/models/v1/customers/alert_retrieve_params.rbi +68 -8
- data/rbi/metronome_sdk/models/v1/customers/billing_config_create_params.rbi +10 -0
- data/rbi/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbi +10 -0
- data/rbi/metronome_sdk/models/v1/customers/commit_create_params.rbi +6 -90
- data/rbi/metronome_sdk/models/v1/customers/credit_create_params.rbi +6 -90
- data/rbi/metronome_sdk/models/v1/customers/customer_alert.rbi +54 -47
- data/rbi/metronome_sdk/models/v1/customers/invoice.rbi +316 -68
- data/rbi/metronome_sdk/models/v1/customers/invoice_retrieve_pdf_params.rbi +50 -0
- data/rbi/metronome_sdk/models/v1/customers/plan_list_response.rbi +2 -0
- data/rbi/metronome_sdk/models/v1/payment.rbi +316 -0
- data/rbi/metronome_sdk/models/v1/payment_attempt_params.rbi +48 -0
- data/rbi/metronome_sdk/models/v1/payment_attempt_response.rbi +35 -0
- data/rbi/metronome_sdk/models/v1/payment_cancel_params.rbi +48 -0
- data/rbi/metronome_sdk/models/v1/payment_cancel_response.rbi +35 -0
- data/rbi/metronome_sdk/models/v1/payment_list_params.rbi +91 -0
- data/rbi/metronome_sdk/models/v1/payment_status.rbi +33 -0
- data/rbi/metronome_sdk/models/v1/plan_detail.rbi +2 -0
- data/rbi/metronome_sdk/models/v1/plan_list_charges_response.rbi +2 -0
- data/rbi/metronome_sdk/models/v1/plan_list_customers_response.rbi +2 -0
- data/rbi/metronome_sdk/models/v1/plan_list_response.rbi +8 -1
- data/rbi/metronome_sdk/models/v1/usage_list_response.rbi +45 -86
- data/rbi/metronome_sdk/models/v1/usage_search_response.rbi +2 -0
- data/rbi/metronome_sdk/models/v2/contract_edit_commit_params.rbi +74 -76
- data/rbi/metronome_sdk/models/v2/contract_edit_credit_params.rbi +74 -76
- data/rbi/metronome_sdk/models/v2/contract_edit_params.rbi +3875 -7234
- data/rbi/metronome_sdk/models/v2/contract_get_edit_history_response.rbi +1733 -6207
- data/rbi/metronome_sdk/models/v2/contract_list_response.rbi +5 -9867
- data/rbi/metronome_sdk/models/v2/contract_retrieve_response.rbi +6 -9866
- data/rbi/metronome_sdk/models.rbi +44 -0
- data/rbi/metronome_sdk/resources/v1/alerts.rbi +101 -27
- data/rbi/metronome_sdk/resources/v1/audit_logs.rbi +39 -4
- data/rbi/metronome_sdk/resources/v1/billable_metrics.rbi +54 -4
- data/rbi/metronome_sdk/resources/v1/contracts/products.rbi +25 -5
- data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/product_orders.rbi +7 -2
- data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbi +10 -3
- data/rbi/metronome_sdk/resources/v1/contracts/rate_cards.rbi +109 -9
- data/rbi/metronome_sdk/resources/v1/contracts.rbi +258 -16
- data/rbi/metronome_sdk/resources/v1/credit_grants.rbi +5 -1
- data/rbi/metronome_sdk/resources/v1/custom_fields.rbi +57 -14
- data/rbi/metronome_sdk/resources/v1/customers/alerts.rbi +133 -11
- data/rbi/metronome_sdk/resources/v1/customers/commits.rbi +119 -10
- data/rbi/metronome_sdk/resources/v1/customers/credits.rbi +104 -9
- data/rbi/metronome_sdk/resources/v1/customers/invoices.rbi +159 -7
- data/rbi/metronome_sdk/resources/v1/customers.rbi +162 -14
- data/rbi/metronome_sdk/resources/v1/dashboards.rbi +29 -3
- data/rbi/metronome_sdk/resources/v1/invoices.rbi +23 -2
- data/rbi/metronome_sdk/resources/v1/payments.rbi +72 -0
- data/rbi/metronome_sdk/resources/v1/pricing_units.rbi +6 -1
- data/rbi/metronome_sdk/resources/v1/services.rbi +6 -4
- data/rbi/metronome_sdk/resources/v1/usage.rbi +191 -13
- data/rbi/metronome_sdk/resources/v1.rbi +3 -0
- data/rbi/metronome_sdk/resources/v2/contracts.rbi +134 -23
- data/sig/metronome_sdk/errors.rbs +7 -0
- data/sig/metronome_sdk/file_part.rbs +1 -1
- data/sig/metronome_sdk/internal/body_cursor_page.rbs +13 -0
- data/sig/metronome_sdk/internal/cursor_page_without_limit.rbs +13 -0
- data/sig/metronome_sdk/models/base_threshold_commit.rbs +26 -0
- data/sig/metronome_sdk/models/commit.rbs +17 -170
- data/sig/metronome_sdk/models/commit_hierarchy_configuration.rbs +117 -0
- data/sig/metronome_sdk/models/commit_rate.rbs +48 -0
- data/sig/metronome_sdk/models/commit_specifier.rbs +47 -0
- data/sig/metronome_sdk/models/commit_specifier_input.rbs +47 -0
- data/sig/metronome_sdk/models/contract.rbs +398 -0
- data/sig/metronome_sdk/models/contract_v2.rbs +3108 -0
- data/sig/metronome_sdk/models/contract_without_amendments.rbs +54 -976
- data/sig/metronome_sdk/models/credit.rbs +12 -170
- data/sig/metronome_sdk/models/hierarchy_configuration.rbs +152 -0
- data/sig/metronome_sdk/models/override.rbs +12 -101
- data/sig/metronome_sdk/models/override_tier.rbs +17 -0
- data/sig/metronome_sdk/models/overwrite_rate.rbs +78 -0
- data/sig/metronome_sdk/models/payment_gate_config.rbs +124 -0
- data/sig/metronome_sdk/models/payment_gate_config_v2.rbs +124 -0
- data/sig/metronome_sdk/models/prepaid_balance_threshold_configuration.rbs +82 -0
- data/sig/metronome_sdk/models/prepaid_balance_threshold_configuration_v2.rbs +82 -0
- data/sig/metronome_sdk/models/recurring_commit_subscription_config.rbs +51 -0
- data/sig/metronome_sdk/models/spend_threshold_configuration.rbs +35 -0
- data/sig/metronome_sdk/models/spend_threshold_configuration_v2.rbs +35 -0
- data/sig/metronome_sdk/models/subscription.rbs +295 -0
- data/sig/metronome_sdk/models/update_base_threshold_commit.rbs +28 -0
- data/sig/metronome_sdk/models/v1/alert_create_params.rbs +4 -2
- data/sig/metronome_sdk/models/v1/contract_amend_params.rbs +26 -341
- data/sig/metronome_sdk/models/v1/contract_create_params.rbs +219 -1184
- data/sig/metronome_sdk/models/v1/contract_list_balances_response.rbs +4 -25
- data/sig/metronome_sdk/models/v1/contract_list_response.rbs +4 -1041
- data/sig/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rbs +6 -54
- data/sig/metronome_sdk/models/v1/contract_retrieve_response.rbs +4 -1041
- data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rbs +6 -54
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rbs +6 -54
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbs +6 -54
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rbs +6 -54
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rbs +6 -54
- data/sig/metronome_sdk/models/v1/credit_grant_list_entries_response.rbs +72 -94
- data/sig/metronome_sdk/models/v1/custom_field_list_keys_response.rbs +53 -75
- data/sig/metronome_sdk/models/v1/customer_create_params.rbs +31 -4
- data/sig/metronome_sdk/models/v1/customer_detail.rbs +5 -0
- data/sig/metronome_sdk/models/v1/customer_preview_events_params.rbs +0 -7
- data/sig/metronome_sdk/models/v1/customer_preview_events_response.rbs +6 -4
- data/sig/metronome_sdk/models/v1/customer_retrieve_billing_configurations_params.rbs +32 -0
- data/sig/metronome_sdk/models/v1/customer_retrieve_billing_configurations_response.rbs +113 -0
- data/sig/metronome_sdk/models/v1/customer_set_billing_configurations_params.rbs +133 -0
- data/sig/metronome_sdk/models/v1/customers/alert_retrieve_params.rbs +21 -0
- data/sig/metronome_sdk/models/v1/customers/billing_config_create_params.rbs +7 -1
- data/sig/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbs +6 -1
- data/sig/metronome_sdk/models/v1/customers/commit_create_params.rbs +6 -50
- data/sig/metronome_sdk/models/v1/customers/credit_create_params.rbs +6 -50
- data/sig/metronome_sdk/models/v1/customers/customer_alert.rbs +4 -2
- data/sig/metronome_sdk/models/v1/customers/invoice.rbs +137 -24
- data/sig/metronome_sdk/models/v1/customers/invoice_retrieve_pdf_params.rbs +32 -0
- data/sig/metronome_sdk/models/v1/payment.rbs +191 -0
- data/sig/metronome_sdk/models/v1/payment_attempt_params.rbs +30 -0
- data/sig/metronome_sdk/models/v1/payment_attempt_response.rbs +15 -0
- data/sig/metronome_sdk/models/v1/payment_cancel_params.rbs +30 -0
- data/sig/metronome_sdk/models/v1/payment_cancel_response.rbs +15 -0
- data/sig/metronome_sdk/models/v1/payment_list_params.rbs +56 -0
- data/sig/metronome_sdk/models/v1/payment_status.rbs +19 -0
- data/sig/metronome_sdk/models/v1/usage_list_response.rbs +33 -55
- data/sig/metronome_sdk/models/v2/contract_edit_commit_params.rbs +28 -43
- data/sig/metronome_sdk/models/v2/contract_edit_credit_params.rbs +28 -43
- data/sig/metronome_sdk/models/v2/contract_edit_params.rbs +412 -1793
- data/sig/metronome_sdk/models/v2/contract_get_edit_history_response.rbs +342 -2149
- data/sig/metronome_sdk/models/v2/contract_list_response.rbs +4 -4426
- data/sig/metronome_sdk/models/v2/contract_retrieve_response.rbs +4 -4426
- data/sig/metronome_sdk/models.rbs +38 -0
- data/sig/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbs +1 -1
- data/sig/metronome_sdk/resources/v1/contracts.rbs +3 -3
- data/sig/metronome_sdk/resources/v1/credit_grants.rbs +1 -1
- 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 +2 -2
- data/sig/metronome_sdk/resources/v1/customers/invoices.rbs +6 -0
- data/sig/metronome_sdk/resources/v1/customers.rbs +11 -0
- data/sig/metronome_sdk/resources/v1/payments.rbs +30 -0
- data/sig/metronome_sdk/resources/v1/usage.rbs +1 -1
- data/sig/metronome_sdk/resources/v1.rbs +2 -0
- data/sig/metronome_sdk/resources/v2/contracts.rbs +10 -4
- metadata +101 -11
- data/lib/metronome_sdk/models/v1/customers/alert_list_response.rb +0 -29
- data/lib/metronome_sdk/models/v1/customers/commit_list_response.rb +0 -26
- data/lib/metronome_sdk/models/v1/customers/credit_list_response.rb +0 -26
- data/rbi/metronome_sdk/models/v1/customers/alert_list_response.rbi +0 -46
- data/rbi/metronome_sdk/models/v1/customers/commit_list_response.rbi +0 -45
- data/rbi/metronome_sdk/models/v1/customers/credit_list_response.rbi +0 -45
- data/sig/metronome_sdk/models/v1/customers/alert_list_response.rbs +0 -29
- data/sig/metronome_sdk/models/v1/customers/commit_list_response.rbs +0 -26
- data/sig/metronome_sdk/models/v1/customers/credit_list_response.rbs +0 -26
|
@@ -39,6 +39,7 @@ module MetronomeSDK
|
|
|
39
39
|
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Credit] }
|
|
40
40
|
|
|
41
41
|
# @!attribute custom_fields
|
|
42
|
+
# Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
42
43
|
#
|
|
43
44
|
# @return [Hash{Symbol=>String}, nil]
|
|
44
45
|
optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
|
|
@@ -67,18 +68,14 @@ module MetronomeSDK
|
|
|
67
68
|
#
|
|
68
69
|
# @return [Array<MetronomeSDK::Models::V1::ContractAmendParams::ProfessionalService>, nil]
|
|
69
70
|
optional :professional_services,
|
|
70
|
-
-> {
|
|
71
|
-
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::ProfessionalService]
|
|
72
|
-
}
|
|
71
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::ProfessionalService] }
|
|
73
72
|
|
|
74
73
|
# @!attribute reseller_royalties
|
|
75
74
|
# This field's availability is dependent on your client's configuration.
|
|
76
75
|
#
|
|
77
76
|
# @return [Array<MetronomeSDK::Models::V1::ContractAmendParams::ResellerRoyalty>, nil]
|
|
78
77
|
optional :reseller_royalties,
|
|
79
|
-
-> {
|
|
80
|
-
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::ResellerRoyalty]
|
|
81
|
-
}
|
|
78
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::ResellerRoyalty] }
|
|
82
79
|
|
|
83
80
|
# @!attribute salesforce_opportunity_id
|
|
84
81
|
# This field's availability is dependent on your client's configuration.
|
|
@@ -90,9 +87,7 @@ module MetronomeSDK
|
|
|
90
87
|
#
|
|
91
88
|
# @return [Array<MetronomeSDK::Models::V1::ContractAmendParams::ScheduledCharge>, nil]
|
|
92
89
|
optional :scheduled_charges,
|
|
93
|
-
-> {
|
|
94
|
-
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::ScheduledCharge]
|
|
95
|
-
}
|
|
90
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::ScheduledCharge] }
|
|
96
91
|
|
|
97
92
|
# @!attribute total_contract_value
|
|
98
93
|
# This field's availability is dependent on your client's configuration.
|
|
@@ -111,7 +106,7 @@ module MetronomeSDK
|
|
|
111
106
|
#
|
|
112
107
|
# @param credits [Array<MetronomeSDK::Models::V1::ContractAmendParams::Credit>]
|
|
113
108
|
#
|
|
114
|
-
# @param custom_fields [Hash{Symbol=>String}]
|
|
109
|
+
# @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
115
110
|
#
|
|
116
111
|
# @param discounts [Array<MetronomeSDK::Models::V1::ContractAmendParams::Discount>] This field's availability is dependent on your client's configuration.
|
|
117
112
|
#
|
|
@@ -173,6 +168,7 @@ module MetronomeSDK
|
|
|
173
168
|
optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
|
|
174
169
|
|
|
175
170
|
# @!attribute custom_fields
|
|
171
|
+
# Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
176
172
|
#
|
|
177
173
|
# @return [Hash{Symbol=>String}, nil]
|
|
178
174
|
optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
|
|
@@ -186,9 +182,8 @@ module MetronomeSDK
|
|
|
186
182
|
# @!attribute hierarchy_configuration
|
|
187
183
|
# Optional configuration for commit hierarchy access control
|
|
188
184
|
#
|
|
189
|
-
# @return [MetronomeSDK::Models::
|
|
190
|
-
optional :hierarchy_configuration,
|
|
191
|
-
-> { MetronomeSDK::V1::ContractAmendParams::Commit::HierarchyConfiguration }
|
|
185
|
+
# @return [MetronomeSDK::Models::CommitHierarchyConfiguration, nil]
|
|
186
|
+
optional :hierarchy_configuration, -> { MetronomeSDK::CommitHierarchyConfiguration }
|
|
192
187
|
|
|
193
188
|
# @!attribute invoice_schedule
|
|
194
189
|
# Required for "POSTPAID" commits: the true up invoice will be generated at this
|
|
@@ -215,10 +210,7 @@ module MetronomeSDK
|
|
|
215
210
|
# optionally payment gate this commit
|
|
216
211
|
#
|
|
217
212
|
# @return [MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig, nil]
|
|
218
|
-
optional :payment_gate_config,
|
|
219
|
-
-> {
|
|
220
|
-
MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig
|
|
221
|
-
}
|
|
213
|
+
optional :payment_gate_config, -> { MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig }
|
|
222
214
|
|
|
223
215
|
# @!attribute priority
|
|
224
216
|
# If multiple commits are applicable, the one with the lower priority will apply
|
|
@@ -244,11 +236,8 @@ module MetronomeSDK
|
|
|
244
236
|
# specifiers to contribute to a commit's or credit's drawdown. This field cannot
|
|
245
237
|
# be used together with `applicable_product_ids` or `applicable_product_tags`.
|
|
246
238
|
#
|
|
247
|
-
# @return [Array<MetronomeSDK::Models::
|
|
248
|
-
optional :specifiers,
|
|
249
|
-
-> {
|
|
250
|
-
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Commit::Specifier]
|
|
251
|
-
}
|
|
239
|
+
# @return [Array<MetronomeSDK::Models::CommitSpecifierInput>, nil]
|
|
240
|
+
optional :specifiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifierInput] }
|
|
252
241
|
|
|
253
242
|
# @!attribute temporary_id
|
|
254
243
|
# A temporary ID for the commit that can be used to reference the commit for
|
|
@@ -273,11 +262,11 @@ module MetronomeSDK
|
|
|
273
262
|
#
|
|
274
263
|
# @param applicable_product_tags [Array<String>] Which tags the commit applies to. If applicable*product_ids, applicable_product*
|
|
275
264
|
#
|
|
276
|
-
# @param custom_fields [Hash{Symbol=>String}]
|
|
265
|
+
# @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
277
266
|
#
|
|
278
267
|
# @param description [String] Used only in UI/API. It is not exposed to end customers.
|
|
279
268
|
#
|
|
280
|
-
# @param hierarchy_configuration [MetronomeSDK::Models::
|
|
269
|
+
# @param hierarchy_configuration [MetronomeSDK::Models::CommitHierarchyConfiguration] Optional configuration for commit hierarchy access control
|
|
281
270
|
#
|
|
282
271
|
# @param invoice_schedule [MetronomeSDK::Models::V1::ContractAmendParams::Commit::InvoiceSchedule] Required for "POSTPAID" commits: the true up invoice will be generated at this t
|
|
283
272
|
#
|
|
@@ -293,7 +282,7 @@ module MetronomeSDK
|
|
|
293
282
|
#
|
|
294
283
|
# @param rollover_fraction [Float] Fraction of unused segments that will be rolled over. Must be between 0 and 1.
|
|
295
284
|
#
|
|
296
|
-
# @param specifiers [Array<MetronomeSDK::Models::
|
|
285
|
+
# @param specifiers [Array<MetronomeSDK::Models::CommitSpecifierInput>] List of filters that determine what kind of customer usage draws down a commit o
|
|
297
286
|
#
|
|
298
287
|
# @param temporary_id [String] A temporary ID for the commit that can be used to reference the commit for commi
|
|
299
288
|
|
|
@@ -314,9 +303,7 @@ module MetronomeSDK
|
|
|
314
303
|
#
|
|
315
304
|
# @return [Array<MetronomeSDK::Models::V1::ContractAmendParams::Commit::AccessSchedule::ScheduleItem>]
|
|
316
305
|
required :schedule_items,
|
|
317
|
-
-> {
|
|
318
|
-
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Commit::AccessSchedule::ScheduleItem]
|
|
319
|
-
}
|
|
306
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Commit::AccessSchedule::ScheduleItem] }
|
|
320
307
|
|
|
321
308
|
# @!attribute credit_type_id
|
|
322
309
|
# Defaults to USD (cents) if not passed
|
|
@@ -360,117 +347,6 @@ module MetronomeSDK
|
|
|
360
347
|
end
|
|
361
348
|
end
|
|
362
349
|
|
|
363
|
-
# @see MetronomeSDK::Models::V1::ContractAmendParams::Commit#hierarchy_configuration
|
|
364
|
-
class HierarchyConfiguration < MetronomeSDK::Internal::Type::BaseModel
|
|
365
|
-
# @!attribute child_access
|
|
366
|
-
#
|
|
367
|
-
# @return [MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs]
|
|
368
|
-
required :child_access,
|
|
369
|
-
union: -> {
|
|
370
|
-
MetronomeSDK::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess
|
|
371
|
-
}
|
|
372
|
-
|
|
373
|
-
# @!method initialize(child_access:)
|
|
374
|
-
# Optional configuration for commit hierarchy access control
|
|
375
|
-
#
|
|
376
|
-
# @param child_access [MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs]
|
|
377
|
-
|
|
378
|
-
# @see MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration#child_access
|
|
379
|
-
module ChildAccess
|
|
380
|
-
extend MetronomeSDK::Internal::Type::Union
|
|
381
|
-
|
|
382
|
-
variant -> {
|
|
383
|
-
MetronomeSDK::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll
|
|
384
|
-
}
|
|
385
|
-
|
|
386
|
-
variant -> {
|
|
387
|
-
MetronomeSDK::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone
|
|
388
|
-
}
|
|
389
|
-
|
|
390
|
-
variant -> {
|
|
391
|
-
MetronomeSDK::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs
|
|
392
|
-
}
|
|
393
|
-
|
|
394
|
-
class CommitHierarchyChildAccessAll < MetronomeSDK::Internal::Type::BaseModel
|
|
395
|
-
# @!attribute type
|
|
396
|
-
#
|
|
397
|
-
# @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type]
|
|
398
|
-
required :type,
|
|
399
|
-
enum: -> {
|
|
400
|
-
MetronomeSDK::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type
|
|
401
|
-
}
|
|
402
|
-
|
|
403
|
-
# @!method initialize(type:)
|
|
404
|
-
# @param type [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type]
|
|
405
|
-
|
|
406
|
-
# @see MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll#type
|
|
407
|
-
module Type
|
|
408
|
-
extend MetronomeSDK::Internal::Type::Enum
|
|
409
|
-
|
|
410
|
-
ALL = :ALL
|
|
411
|
-
|
|
412
|
-
# @!method self.values
|
|
413
|
-
# @return [Array<Symbol>]
|
|
414
|
-
end
|
|
415
|
-
end
|
|
416
|
-
|
|
417
|
-
class CommitHierarchyChildAccessNone < MetronomeSDK::Internal::Type::BaseModel
|
|
418
|
-
# @!attribute type
|
|
419
|
-
#
|
|
420
|
-
# @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type]
|
|
421
|
-
required :type,
|
|
422
|
-
enum: -> {
|
|
423
|
-
MetronomeSDK::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type
|
|
424
|
-
}
|
|
425
|
-
|
|
426
|
-
# @!method initialize(type:)
|
|
427
|
-
# @param type [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type]
|
|
428
|
-
|
|
429
|
-
# @see MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone#type
|
|
430
|
-
module Type
|
|
431
|
-
extend MetronomeSDK::Internal::Type::Enum
|
|
432
|
-
|
|
433
|
-
NONE = :NONE
|
|
434
|
-
|
|
435
|
-
# @!method self.values
|
|
436
|
-
# @return [Array<Symbol>]
|
|
437
|
-
end
|
|
438
|
-
end
|
|
439
|
-
|
|
440
|
-
class CommitHierarchyChildAccessContractIDs < MetronomeSDK::Internal::Type::BaseModel
|
|
441
|
-
# @!attribute contract_ids
|
|
442
|
-
#
|
|
443
|
-
# @return [Array<String>]
|
|
444
|
-
required :contract_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
|
|
445
|
-
|
|
446
|
-
# @!attribute type
|
|
447
|
-
#
|
|
448
|
-
# @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type]
|
|
449
|
-
required :type,
|
|
450
|
-
enum: -> {
|
|
451
|
-
MetronomeSDK::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type
|
|
452
|
-
}
|
|
453
|
-
|
|
454
|
-
# @!method initialize(contract_ids:, type:)
|
|
455
|
-
# @param contract_ids [Array<String>]
|
|
456
|
-
# @param type [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type]
|
|
457
|
-
|
|
458
|
-
# @see MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs#type
|
|
459
|
-
module Type
|
|
460
|
-
extend MetronomeSDK::Internal::Type::Enum
|
|
461
|
-
|
|
462
|
-
CONTRACT_IDS = :CONTRACT_IDS
|
|
463
|
-
|
|
464
|
-
# @!method self.values
|
|
465
|
-
# @return [Array<Symbol>]
|
|
466
|
-
end
|
|
467
|
-
end
|
|
468
|
-
|
|
469
|
-
# @!method self.variants
|
|
470
|
-
# @return [Array(MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs)]
|
|
471
|
-
end
|
|
472
|
-
end
|
|
473
|
-
|
|
474
350
|
# @see MetronomeSDK::Models::V1::ContractAmendParams::Commit#invoice_schedule
|
|
475
351
|
class InvoiceSchedule < MetronomeSDK::Internal::Type::BaseModel
|
|
476
352
|
# @!attribute credit_type_id
|
|
@@ -500,9 +376,7 @@ module MetronomeSDK
|
|
|
500
376
|
#
|
|
501
377
|
# @return [Array<MetronomeSDK::Models::V1::ContractAmendParams::Commit::InvoiceSchedule::ScheduleItem>, nil]
|
|
502
378
|
optional :schedule_items,
|
|
503
|
-
-> {
|
|
504
|
-
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule::ScheduleItem]
|
|
505
|
-
}
|
|
379
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule::ScheduleItem] }
|
|
506
380
|
|
|
507
381
|
# @!method initialize(credit_type_id: nil, do_not_invoice: nil, recurring_schedule: nil, schedule_items: nil)
|
|
508
382
|
# Some parameter documentations has been truncated, see
|
|
@@ -528,9 +402,7 @@ module MetronomeSDK
|
|
|
528
402
|
#
|
|
529
403
|
# @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::InvoiceSchedule::RecurringSchedule::AmountDistribution]
|
|
530
404
|
required :amount_distribution,
|
|
531
|
-
enum: -> {
|
|
532
|
-
MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule::RecurringSchedule::AmountDistribution
|
|
533
|
-
}
|
|
405
|
+
enum: -> { MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule::RecurringSchedule::AmountDistribution }
|
|
534
406
|
|
|
535
407
|
# @!attribute ending_before
|
|
536
408
|
# RFC 3339 timestamp (exclusive).
|
|
@@ -542,9 +414,7 @@ module MetronomeSDK
|
|
|
542
414
|
#
|
|
543
415
|
# @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::InvoiceSchedule::RecurringSchedule::Frequency]
|
|
544
416
|
required :frequency,
|
|
545
|
-
enum: -> {
|
|
546
|
-
MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule::RecurringSchedule::Frequency
|
|
547
|
-
}
|
|
417
|
+
enum: -> { MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule::RecurringSchedule::Frequency }
|
|
548
418
|
|
|
549
419
|
# @!attribute starting_at
|
|
550
420
|
# RFC 3339 timestamp (inclusive).
|
|
@@ -681,18 +551,14 @@ module MetronomeSDK
|
|
|
681
551
|
#
|
|
682
552
|
# @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig::PaymentGateType]
|
|
683
553
|
required :payment_gate_type,
|
|
684
|
-
enum: -> {
|
|
685
|
-
MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::PaymentGateType
|
|
686
|
-
}
|
|
554
|
+
enum: -> { MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::PaymentGateType }
|
|
687
555
|
|
|
688
556
|
# @!attribute precalculated_tax_config
|
|
689
557
|
# Only applicable if using PRECALCULATED as your tax type.
|
|
690
558
|
#
|
|
691
559
|
# @return [MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig::PrecalculatedTaxConfig, nil]
|
|
692
560
|
optional :precalculated_tax_config,
|
|
693
|
-
-> {
|
|
694
|
-
MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::PrecalculatedTaxConfig
|
|
695
|
-
}
|
|
561
|
+
-> { MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::PrecalculatedTaxConfig }
|
|
696
562
|
|
|
697
563
|
# @!attribute stripe_config
|
|
698
564
|
# Only applicable if using STRIPE as your payment gate type.
|
|
@@ -707,10 +573,7 @@ module MetronomeSDK
|
|
|
707
573
|
# will default to NONE.
|
|
708
574
|
#
|
|
709
575
|
# @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig::TaxType, nil]
|
|
710
|
-
optional :tax_type,
|
|
711
|
-
enum: -> {
|
|
712
|
-
MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::TaxType
|
|
713
|
-
}
|
|
576
|
+
optional :tax_type, enum: -> { MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::TaxType }
|
|
714
577
|
|
|
715
578
|
# @!method initialize(payment_gate_type:, precalculated_tax_config: nil, stripe_config: nil, tax_type: nil)
|
|
716
579
|
# Some parameter documentations has been truncated, see
|
|
@@ -779,9 +642,7 @@ module MetronomeSDK
|
|
|
779
642
|
#
|
|
780
643
|
# @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig::StripeConfig::PaymentType]
|
|
781
644
|
required :payment_type,
|
|
782
|
-
enum: -> {
|
|
783
|
-
MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::StripeConfig::PaymentType
|
|
784
|
-
}
|
|
645
|
+
enum: -> { MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::StripeConfig::PaymentType }
|
|
785
646
|
|
|
786
647
|
# @!attribute invoice_metadata
|
|
787
648
|
# Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
|
|
@@ -841,6 +702,7 @@ module MetronomeSDK
|
|
|
841
702
|
NONE = :NONE
|
|
842
703
|
STRIPE = :STRIPE
|
|
843
704
|
ANROK = :ANROK
|
|
705
|
+
AVALARA = :AVALARA
|
|
844
706
|
PRECALCULATED = :PRECALCULATED
|
|
845
707
|
|
|
846
708
|
# @!method self.values
|
|
@@ -858,44 +720,6 @@ module MetronomeSDK
|
|
|
858
720
|
# @!method self.values
|
|
859
721
|
# @return [Array<Symbol>]
|
|
860
722
|
end
|
|
861
|
-
|
|
862
|
-
class Specifier < MetronomeSDK::Internal::Type::BaseModel
|
|
863
|
-
# @!attribute presentation_group_values
|
|
864
|
-
#
|
|
865
|
-
# @return [Hash{Symbol=>String}, nil]
|
|
866
|
-
optional :presentation_group_values, MetronomeSDK::Internal::Type::HashOf[String]
|
|
867
|
-
|
|
868
|
-
# @!attribute pricing_group_values
|
|
869
|
-
#
|
|
870
|
-
# @return [Hash{Symbol=>String}, nil]
|
|
871
|
-
optional :pricing_group_values, MetronomeSDK::Internal::Type::HashOf[String]
|
|
872
|
-
|
|
873
|
-
# @!attribute product_id
|
|
874
|
-
# If provided, the specifier will only apply to the product with the specified ID.
|
|
875
|
-
#
|
|
876
|
-
# @return [String, nil]
|
|
877
|
-
optional :product_id, String
|
|
878
|
-
|
|
879
|
-
# @!attribute product_tags
|
|
880
|
-
# If provided, the specifier will only apply to products with all the specified
|
|
881
|
-
# tags.
|
|
882
|
-
#
|
|
883
|
-
# @return [Array<String>, nil]
|
|
884
|
-
optional :product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
|
|
885
|
-
|
|
886
|
-
# @!method initialize(presentation_group_values: nil, pricing_group_values: nil, product_id: nil, product_tags: nil)
|
|
887
|
-
# Some parameter documentations has been truncated, see
|
|
888
|
-
# {MetronomeSDK::Models::V1::ContractAmendParams::Commit::Specifier} for more
|
|
889
|
-
# details.
|
|
890
|
-
#
|
|
891
|
-
# @param presentation_group_values [Hash{Symbol=>String}]
|
|
892
|
-
#
|
|
893
|
-
# @param pricing_group_values [Hash{Symbol=>String}]
|
|
894
|
-
#
|
|
895
|
-
# @param product_id [String] If provided, the specifier will only apply to the product with the specified ID.
|
|
896
|
-
#
|
|
897
|
-
# @param product_tags [Array<String>] If provided, the specifier will only apply to products with all the specified ta
|
|
898
|
-
end
|
|
899
723
|
end
|
|
900
724
|
|
|
901
725
|
class Credit < MetronomeSDK::Internal::Type::BaseModel
|
|
@@ -925,6 +749,7 @@ module MetronomeSDK
|
|
|
925
749
|
optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
|
|
926
750
|
|
|
927
751
|
# @!attribute custom_fields
|
|
752
|
+
# Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
928
753
|
#
|
|
929
754
|
# @return [Hash{Symbol=>String}, nil]
|
|
930
755
|
optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
|
|
@@ -938,9 +763,8 @@ module MetronomeSDK
|
|
|
938
763
|
# @!attribute hierarchy_configuration
|
|
939
764
|
# Optional configuration for credit hierarchy access control
|
|
940
765
|
#
|
|
941
|
-
# @return [MetronomeSDK::Models::
|
|
942
|
-
optional :hierarchy_configuration,
|
|
943
|
-
-> { MetronomeSDK::V1::ContractAmendParams::Credit::HierarchyConfiguration }
|
|
766
|
+
# @return [MetronomeSDK::Models::CommitHierarchyConfiguration, nil]
|
|
767
|
+
optional :hierarchy_configuration, -> { MetronomeSDK::CommitHierarchyConfiguration }
|
|
944
768
|
|
|
945
769
|
# @!attribute name
|
|
946
770
|
# displayed on invoices
|
|
@@ -972,11 +796,8 @@ module MetronomeSDK
|
|
|
972
796
|
# specifiers to contribute to a commit's or credit's drawdown. This field cannot
|
|
973
797
|
# be used together with `applicable_product_ids` or `applicable_product_tags`.
|
|
974
798
|
#
|
|
975
|
-
# @return [Array<MetronomeSDK::Models::
|
|
976
|
-
optional :specifiers,
|
|
977
|
-
-> {
|
|
978
|
-
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Credit::Specifier]
|
|
979
|
-
}
|
|
799
|
+
# @return [Array<MetronomeSDK::Models::CommitSpecifierInput>, nil]
|
|
800
|
+
optional :specifiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifierInput] }
|
|
980
801
|
|
|
981
802
|
# @!method initialize(access_schedule:, product_id:, applicable_product_ids: nil, applicable_product_tags: nil, custom_fields: nil, description: nil, hierarchy_configuration: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, rate_type: nil, specifiers: nil)
|
|
982
803
|
# Some parameter documentations has been truncated, see
|
|
@@ -990,11 +811,11 @@ module MetronomeSDK
|
|
|
990
811
|
#
|
|
991
812
|
# @param applicable_product_tags [Array<String>] Which tags the credit applies to. If both applicable*product_ids and applicable*
|
|
992
813
|
#
|
|
993
|
-
# @param custom_fields [Hash{Symbol=>String}]
|
|
814
|
+
# @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
994
815
|
#
|
|
995
816
|
# @param description [String] Used only in UI/API. It is not exposed to end customers.
|
|
996
817
|
#
|
|
997
|
-
# @param hierarchy_configuration [MetronomeSDK::Models::
|
|
818
|
+
# @param hierarchy_configuration [MetronomeSDK::Models::CommitHierarchyConfiguration] Optional configuration for credit hierarchy access control
|
|
998
819
|
#
|
|
999
820
|
# @param name [String] displayed on invoices
|
|
1000
821
|
#
|
|
@@ -1004,7 +825,7 @@ module MetronomeSDK
|
|
|
1004
825
|
#
|
|
1005
826
|
# @param rate_type [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Credit::RateType]
|
|
1006
827
|
#
|
|
1007
|
-
# @param specifiers [Array<MetronomeSDK::Models::
|
|
828
|
+
# @param specifiers [Array<MetronomeSDK::Models::CommitSpecifierInput>] List of filters that determine what kind of customer usage draws down a commit o
|
|
1008
829
|
|
|
1009
830
|
# @see MetronomeSDK::Models::V1::ContractAmendParams::Credit#access_schedule
|
|
1010
831
|
class AccessSchedule < MetronomeSDK::Internal::Type::BaseModel
|
|
@@ -1012,9 +833,7 @@ module MetronomeSDK
|
|
|
1012
833
|
#
|
|
1013
834
|
# @return [Array<MetronomeSDK::Models::V1::ContractAmendParams::Credit::AccessSchedule::ScheduleItem>]
|
|
1014
835
|
required :schedule_items,
|
|
1015
|
-
-> {
|
|
1016
|
-
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Credit::AccessSchedule::ScheduleItem]
|
|
1017
|
-
}
|
|
836
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Credit::AccessSchedule::ScheduleItem] }
|
|
1018
837
|
|
|
1019
838
|
# @!attribute credit_type_id
|
|
1020
839
|
# Defaults to USD (cents) if not passed
|
|
@@ -1056,117 +875,6 @@ module MetronomeSDK
|
|
|
1056
875
|
end
|
|
1057
876
|
end
|
|
1058
877
|
|
|
1059
|
-
# @see MetronomeSDK::Models::V1::ContractAmendParams::Credit#hierarchy_configuration
|
|
1060
|
-
class HierarchyConfiguration < MetronomeSDK::Internal::Type::BaseModel
|
|
1061
|
-
# @!attribute child_access
|
|
1062
|
-
#
|
|
1063
|
-
# @return [MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs]
|
|
1064
|
-
required :child_access,
|
|
1065
|
-
union: -> {
|
|
1066
|
-
MetronomeSDK::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess
|
|
1067
|
-
}
|
|
1068
|
-
|
|
1069
|
-
# @!method initialize(child_access:)
|
|
1070
|
-
# Optional configuration for credit hierarchy access control
|
|
1071
|
-
#
|
|
1072
|
-
# @param child_access [MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs]
|
|
1073
|
-
|
|
1074
|
-
# @see MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration#child_access
|
|
1075
|
-
module ChildAccess
|
|
1076
|
-
extend MetronomeSDK::Internal::Type::Union
|
|
1077
|
-
|
|
1078
|
-
variant -> {
|
|
1079
|
-
MetronomeSDK::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll
|
|
1080
|
-
}
|
|
1081
|
-
|
|
1082
|
-
variant -> {
|
|
1083
|
-
MetronomeSDK::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone
|
|
1084
|
-
}
|
|
1085
|
-
|
|
1086
|
-
variant -> {
|
|
1087
|
-
MetronomeSDK::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs
|
|
1088
|
-
}
|
|
1089
|
-
|
|
1090
|
-
class CommitHierarchyChildAccessAll < MetronomeSDK::Internal::Type::BaseModel
|
|
1091
|
-
# @!attribute type
|
|
1092
|
-
#
|
|
1093
|
-
# @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type]
|
|
1094
|
-
required :type,
|
|
1095
|
-
enum: -> {
|
|
1096
|
-
MetronomeSDK::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type
|
|
1097
|
-
}
|
|
1098
|
-
|
|
1099
|
-
# @!method initialize(type:)
|
|
1100
|
-
# @param type [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type]
|
|
1101
|
-
|
|
1102
|
-
# @see MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll#type
|
|
1103
|
-
module Type
|
|
1104
|
-
extend MetronomeSDK::Internal::Type::Enum
|
|
1105
|
-
|
|
1106
|
-
ALL = :ALL
|
|
1107
|
-
|
|
1108
|
-
# @!method self.values
|
|
1109
|
-
# @return [Array<Symbol>]
|
|
1110
|
-
end
|
|
1111
|
-
end
|
|
1112
|
-
|
|
1113
|
-
class CommitHierarchyChildAccessNone < MetronomeSDK::Internal::Type::BaseModel
|
|
1114
|
-
# @!attribute type
|
|
1115
|
-
#
|
|
1116
|
-
# @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type]
|
|
1117
|
-
required :type,
|
|
1118
|
-
enum: -> {
|
|
1119
|
-
MetronomeSDK::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type
|
|
1120
|
-
}
|
|
1121
|
-
|
|
1122
|
-
# @!method initialize(type:)
|
|
1123
|
-
# @param type [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type]
|
|
1124
|
-
|
|
1125
|
-
# @see MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone#type
|
|
1126
|
-
module Type
|
|
1127
|
-
extend MetronomeSDK::Internal::Type::Enum
|
|
1128
|
-
|
|
1129
|
-
NONE = :NONE
|
|
1130
|
-
|
|
1131
|
-
# @!method self.values
|
|
1132
|
-
# @return [Array<Symbol>]
|
|
1133
|
-
end
|
|
1134
|
-
end
|
|
1135
|
-
|
|
1136
|
-
class CommitHierarchyChildAccessContractIDs < MetronomeSDK::Internal::Type::BaseModel
|
|
1137
|
-
# @!attribute contract_ids
|
|
1138
|
-
#
|
|
1139
|
-
# @return [Array<String>]
|
|
1140
|
-
required :contract_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
|
|
1141
|
-
|
|
1142
|
-
# @!attribute type
|
|
1143
|
-
#
|
|
1144
|
-
# @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type]
|
|
1145
|
-
required :type,
|
|
1146
|
-
enum: -> {
|
|
1147
|
-
MetronomeSDK::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type
|
|
1148
|
-
}
|
|
1149
|
-
|
|
1150
|
-
# @!method initialize(contract_ids:, type:)
|
|
1151
|
-
# @param contract_ids [Array<String>]
|
|
1152
|
-
# @param type [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type]
|
|
1153
|
-
|
|
1154
|
-
# @see MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs#type
|
|
1155
|
-
module Type
|
|
1156
|
-
extend MetronomeSDK::Internal::Type::Enum
|
|
1157
|
-
|
|
1158
|
-
CONTRACT_IDS = :CONTRACT_IDS
|
|
1159
|
-
|
|
1160
|
-
# @!method self.values
|
|
1161
|
-
# @return [Array<Symbol>]
|
|
1162
|
-
end
|
|
1163
|
-
end
|
|
1164
|
-
|
|
1165
|
-
# @!method self.variants
|
|
1166
|
-
# @return [Array(MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs)]
|
|
1167
|
-
end
|
|
1168
|
-
end
|
|
1169
|
-
|
|
1170
878
|
# @see MetronomeSDK::Models::V1::ContractAmendParams::Credit#rate_type
|
|
1171
879
|
module RateType
|
|
1172
880
|
extend MetronomeSDK::Internal::Type::Enum
|
|
@@ -1177,44 +885,6 @@ module MetronomeSDK
|
|
|
1177
885
|
# @!method self.values
|
|
1178
886
|
# @return [Array<Symbol>]
|
|
1179
887
|
end
|
|
1180
|
-
|
|
1181
|
-
class Specifier < MetronomeSDK::Internal::Type::BaseModel
|
|
1182
|
-
# @!attribute presentation_group_values
|
|
1183
|
-
#
|
|
1184
|
-
# @return [Hash{Symbol=>String}, nil]
|
|
1185
|
-
optional :presentation_group_values, MetronomeSDK::Internal::Type::HashOf[String]
|
|
1186
|
-
|
|
1187
|
-
# @!attribute pricing_group_values
|
|
1188
|
-
#
|
|
1189
|
-
# @return [Hash{Symbol=>String}, nil]
|
|
1190
|
-
optional :pricing_group_values, MetronomeSDK::Internal::Type::HashOf[String]
|
|
1191
|
-
|
|
1192
|
-
# @!attribute product_id
|
|
1193
|
-
# If provided, the specifier will only apply to the product with the specified ID.
|
|
1194
|
-
#
|
|
1195
|
-
# @return [String, nil]
|
|
1196
|
-
optional :product_id, String
|
|
1197
|
-
|
|
1198
|
-
# @!attribute product_tags
|
|
1199
|
-
# If provided, the specifier will only apply to products with all the specified
|
|
1200
|
-
# tags.
|
|
1201
|
-
#
|
|
1202
|
-
# @return [Array<String>, nil]
|
|
1203
|
-
optional :product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
|
|
1204
|
-
|
|
1205
|
-
# @!method initialize(presentation_group_values: nil, pricing_group_values: nil, product_id: nil, product_tags: nil)
|
|
1206
|
-
# Some parameter documentations has been truncated, see
|
|
1207
|
-
# {MetronomeSDK::Models::V1::ContractAmendParams::Credit::Specifier} for more
|
|
1208
|
-
# details.
|
|
1209
|
-
#
|
|
1210
|
-
# @param presentation_group_values [Hash{Symbol=>String}]
|
|
1211
|
-
#
|
|
1212
|
-
# @param pricing_group_values [Hash{Symbol=>String}]
|
|
1213
|
-
#
|
|
1214
|
-
# @param product_id [String] If provided, the specifier will only apply to the product with the specified ID.
|
|
1215
|
-
#
|
|
1216
|
-
# @param product_tags [Array<String>] If provided, the specifier will only apply to products with all the specified ta
|
|
1217
|
-
end
|
|
1218
888
|
end
|
|
1219
889
|
|
|
1220
890
|
class Discount < MetronomeSDK::Internal::Type::BaseModel
|
|
@@ -1230,6 +900,7 @@ module MetronomeSDK
|
|
|
1230
900
|
required :schedule, -> { MetronomeSDK::V1::ContractAmendParams::Discount::Schedule }
|
|
1231
901
|
|
|
1232
902
|
# @!attribute custom_fields
|
|
903
|
+
# Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
1233
904
|
#
|
|
1234
905
|
# @return [Hash{Symbol=>String}, nil]
|
|
1235
906
|
optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
|
|
@@ -1251,7 +922,7 @@ module MetronomeSDK
|
|
|
1251
922
|
#
|
|
1252
923
|
# @param schedule [MetronomeSDK::Models::V1::ContractAmendParams::Discount::Schedule] Must provide either schedule_items or recurring_schedule.
|
|
1253
924
|
#
|
|
1254
|
-
# @param custom_fields [Hash{Symbol=>String}]
|
|
925
|
+
# @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
1255
926
|
#
|
|
1256
927
|
# @param name [String] displayed on invoices
|
|
1257
928
|
#
|
|
@@ -1286,9 +957,7 @@ module MetronomeSDK
|
|
|
1286
957
|
#
|
|
1287
958
|
# @return [Array<MetronomeSDK::Models::V1::ContractAmendParams::Discount::Schedule::ScheduleItem>, nil]
|
|
1288
959
|
optional :schedule_items,
|
|
1289
|
-
-> {
|
|
1290
|
-
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Discount::Schedule::ScheduleItem]
|
|
1291
|
-
}
|
|
960
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Discount::Schedule::ScheduleItem] }
|
|
1292
961
|
|
|
1293
962
|
# @!method initialize(credit_type_id: nil, do_not_invoice: nil, recurring_schedule: nil, schedule_items: nil)
|
|
1294
963
|
# Some parameter documentations has been truncated, see
|
|
@@ -1311,9 +980,7 @@ module MetronomeSDK
|
|
|
1311
980
|
#
|
|
1312
981
|
# @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Discount::Schedule::RecurringSchedule::AmountDistribution]
|
|
1313
982
|
required :amount_distribution,
|
|
1314
|
-
enum: -> {
|
|
1315
|
-
MetronomeSDK::V1::ContractAmendParams::Discount::Schedule::RecurringSchedule::AmountDistribution
|
|
1316
|
-
}
|
|
983
|
+
enum: -> { MetronomeSDK::V1::ContractAmendParams::Discount::Schedule::RecurringSchedule::AmountDistribution }
|
|
1317
984
|
|
|
1318
985
|
# @!attribute ending_before
|
|
1319
986
|
# RFC 3339 timestamp (exclusive).
|
|
@@ -1325,9 +992,7 @@ module MetronomeSDK
|
|
|
1325
992
|
#
|
|
1326
993
|
# @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Discount::Schedule::RecurringSchedule::Frequency]
|
|
1327
994
|
required :frequency,
|
|
1328
|
-
enum: -> {
|
|
1329
|
-
MetronomeSDK::V1::ContractAmendParams::Discount::Schedule::RecurringSchedule::Frequency
|
|
1330
|
-
}
|
|
995
|
+
enum: -> { MetronomeSDK::V1::ContractAmendParams::Discount::Schedule::RecurringSchedule::Frequency }
|
|
1331
996
|
|
|
1332
997
|
# @!attribute starting_at
|
|
1333
998
|
# RFC 3339 timestamp (inclusive).
|
|
@@ -1501,9 +1166,7 @@ module MetronomeSDK
|
|
|
1501
1166
|
#
|
|
1502
1167
|
# @return [Array<MetronomeSDK::Models::V1::ContractAmendParams::Override::OverrideSpecifier>, nil]
|
|
1503
1168
|
optional :override_specifiers,
|
|
1504
|
-
-> {
|
|
1505
|
-
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Override::OverrideSpecifier]
|
|
1506
|
-
}
|
|
1169
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Override::OverrideSpecifier] }
|
|
1507
1170
|
|
|
1508
1171
|
# @!attribute overwrite_rate
|
|
1509
1172
|
# Required for OVERWRITE type.
|
|
@@ -1540,9 +1203,7 @@ module MetronomeSDK
|
|
|
1540
1203
|
#
|
|
1541
1204
|
# @return [Array<MetronomeSDK::Models::V1::ContractAmendParams::Override::Tier>, nil]
|
|
1542
1205
|
optional :tiers,
|
|
1543
|
-
-> {
|
|
1544
|
-
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Override::Tier]
|
|
1545
|
-
}
|
|
1206
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Override::Tier] }
|
|
1546
1207
|
|
|
1547
1208
|
# @!attribute type
|
|
1548
1209
|
# Overwrites are prioritized over multipliers and tiered overrides.
|
|
@@ -1585,14 +1246,12 @@ module MetronomeSDK
|
|
|
1585
1246
|
#
|
|
1586
1247
|
# @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Override::OverrideSpecifier::BillingFrequency, nil]
|
|
1587
1248
|
optional :billing_frequency,
|
|
1588
|
-
enum: -> {
|
|
1589
|
-
MetronomeSDK::V1::ContractAmendParams::Override::OverrideSpecifier::BillingFrequency
|
|
1590
|
-
}
|
|
1249
|
+
enum: -> { MetronomeSDK::V1::ContractAmendParams::Override::OverrideSpecifier::BillingFrequency }
|
|
1591
1250
|
|
|
1592
1251
|
# @!attribute commit_ids
|
|
1593
1252
|
# Can only be used for commit specific overrides. Must be used in conjunction with
|
|
1594
|
-
# one of product_id
|
|
1595
|
-
# presentation_group_values
|
|
1253
|
+
# one of `product_id`, `product_tags`, `pricing_group_values`, or
|
|
1254
|
+
# `presentation_group_values`. If provided, the override will only apply to the
|
|
1596
1255
|
# specified commits. If not provided, the override will apply to all commits.
|
|
1597
1256
|
#
|
|
1598
1257
|
# @return [Array<String>, nil]
|
|
@@ -1627,18 +1286,18 @@ module MetronomeSDK
|
|
|
1627
1286
|
|
|
1628
1287
|
# @!attribute recurring_commit_ids
|
|
1629
1288
|
# Can only be used for commit specific overrides. Must be used in conjunction with
|
|
1630
|
-
# one of product_id
|
|
1631
|
-
# presentation_group_values
|
|
1632
|
-
# created by the specified recurring commit ids.
|
|
1289
|
+
# one of `product_id`, `product_tags`, `pricing_group_values`, or
|
|
1290
|
+
# `presentation_group_values`. If provided, the override will only apply to
|
|
1291
|
+
# commits created by the specified recurring commit ids.
|
|
1633
1292
|
#
|
|
1634
1293
|
# @return [Array<String>, nil]
|
|
1635
1294
|
optional :recurring_commit_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
|
|
1636
1295
|
|
|
1637
1296
|
# @!attribute recurring_credit_ids
|
|
1638
1297
|
# Can only be used for commit specific overrides. Must be used in conjunction with
|
|
1639
|
-
# one of product_id
|
|
1640
|
-
# presentation_group_values
|
|
1641
|
-
# created by the specified recurring credit ids.
|
|
1298
|
+
# one of `product_id`, `product_tags`, `pricing_group_values`, or
|
|
1299
|
+
# `presentation_group_values`. If provided, the override will only apply to
|
|
1300
|
+
# credits created by the specified recurring credit ids.
|
|
1642
1301
|
#
|
|
1643
1302
|
# @return [Array<String>, nil]
|
|
1644
1303
|
optional :recurring_credit_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
|
|
@@ -1683,10 +1342,7 @@ module MetronomeSDK
|
|
|
1683
1342
|
# @!attribute rate_type
|
|
1684
1343
|
#
|
|
1685
1344
|
# @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Override::OverwriteRate::RateType]
|
|
1686
|
-
required :rate_type,
|
|
1687
|
-
enum: -> {
|
|
1688
|
-
MetronomeSDK::V1::ContractAmendParams::Override::OverwriteRate::RateType
|
|
1689
|
-
}
|
|
1345
|
+
required :rate_type, enum: -> { MetronomeSDK::V1::ContractAmendParams::Override::OverwriteRate::RateType }
|
|
1690
1346
|
|
|
1691
1347
|
# @!attribute credit_type_id
|
|
1692
1348
|
#
|
|
@@ -1835,6 +1491,7 @@ module MetronomeSDK
|
|
|
1835
1491
|
required :unit_price, Float
|
|
1836
1492
|
|
|
1837
1493
|
# @!attribute custom_fields
|
|
1494
|
+
# Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
1838
1495
|
#
|
|
1839
1496
|
# @return [Hash{Symbol=>String}, nil]
|
|
1840
1497
|
optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
|
|
@@ -1863,7 +1520,7 @@ module MetronomeSDK
|
|
|
1863
1520
|
#
|
|
1864
1521
|
# @param unit_price [Float] Unit price for the charge. Will be multiplied by quantity to determine the amoun
|
|
1865
1522
|
#
|
|
1866
|
-
# @param custom_fields [Hash{Symbol=>String}]
|
|
1523
|
+
# @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
1867
1524
|
#
|
|
1868
1525
|
# @param description [String]
|
|
1869
1526
|
#
|
|
@@ -1874,10 +1531,7 @@ module MetronomeSDK
|
|
|
1874
1531
|
# @!attribute reseller_type
|
|
1875
1532
|
#
|
|
1876
1533
|
# @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::ResellerRoyalty::ResellerType]
|
|
1877
|
-
required :reseller_type,
|
|
1878
|
-
enum: -> {
|
|
1879
|
-
MetronomeSDK::V1::ContractAmendParams::ResellerRoyalty::ResellerType
|
|
1880
|
-
}
|
|
1534
|
+
required :reseller_type, enum: -> { MetronomeSDK::V1::ContractAmendParams::ResellerRoyalty::ResellerType }
|
|
1881
1535
|
|
|
1882
1536
|
# @!attribute applicable_product_ids
|
|
1883
1537
|
# Must provide at least one of applicable_product_ids or applicable_product_tags.
|
|
@@ -2015,6 +1669,7 @@ module MetronomeSDK
|
|
|
2015
1669
|
required :schedule, -> { MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule }
|
|
2016
1670
|
|
|
2017
1671
|
# @!attribute custom_fields
|
|
1672
|
+
# Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
2018
1673
|
#
|
|
2019
1674
|
# @return [Hash{Symbol=>String}, nil]
|
|
2020
1675
|
optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
|
|
@@ -2036,7 +1691,7 @@ module MetronomeSDK
|
|
|
2036
1691
|
#
|
|
2037
1692
|
# @param schedule [MetronomeSDK::Models::V1::ContractAmendParams::ScheduledCharge::Schedule] Must provide either schedule_items or recurring_schedule.
|
|
2038
1693
|
#
|
|
2039
|
-
# @param custom_fields [Hash{Symbol=>String}]
|
|
1694
|
+
# @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
2040
1695
|
#
|
|
2041
1696
|
# @param name [String] displayed on invoices
|
|
2042
1697
|
#
|
|
@@ -2064,18 +1719,14 @@ module MetronomeSDK
|
|
|
2064
1719
|
#
|
|
2065
1720
|
# @return [MetronomeSDK::Models::V1::ContractAmendParams::ScheduledCharge::Schedule::RecurringSchedule, nil]
|
|
2066
1721
|
optional :recurring_schedule,
|
|
2067
|
-
-> {
|
|
2068
|
-
MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::RecurringSchedule
|
|
2069
|
-
}
|
|
1722
|
+
-> { MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::RecurringSchedule }
|
|
2070
1723
|
|
|
2071
1724
|
# @!attribute schedule_items
|
|
2072
1725
|
# Either provide amount or provide both unit_price and quantity.
|
|
2073
1726
|
#
|
|
2074
1727
|
# @return [Array<MetronomeSDK::Models::V1::ContractAmendParams::ScheduledCharge::Schedule::ScheduleItem>, nil]
|
|
2075
1728
|
optional :schedule_items,
|
|
2076
|
-
-> {
|
|
2077
|
-
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::ScheduleItem]
|
|
2078
|
-
}
|
|
1729
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::ScheduleItem] }
|
|
2079
1730
|
|
|
2080
1731
|
# @!method initialize(credit_type_id: nil, do_not_invoice: nil, recurring_schedule: nil, schedule_items: nil)
|
|
2081
1732
|
# Some parameter documentations has been truncated, see
|
|
@@ -2098,9 +1749,7 @@ module MetronomeSDK
|
|
|
2098
1749
|
#
|
|
2099
1750
|
# @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::ScheduledCharge::Schedule::RecurringSchedule::AmountDistribution]
|
|
2100
1751
|
required :amount_distribution,
|
|
2101
|
-
enum: -> {
|
|
2102
|
-
MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::RecurringSchedule::AmountDistribution
|
|
2103
|
-
}
|
|
1752
|
+
enum: -> { MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::RecurringSchedule::AmountDistribution }
|
|
2104
1753
|
|
|
2105
1754
|
# @!attribute ending_before
|
|
2106
1755
|
# RFC 3339 timestamp (exclusive).
|
|
@@ -2112,9 +1761,7 @@ module MetronomeSDK
|
|
|
2112
1761
|
#
|
|
2113
1762
|
# @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::ScheduledCharge::Schedule::RecurringSchedule::Frequency]
|
|
2114
1763
|
required :frequency,
|
|
2115
|
-
enum: -> {
|
|
2116
|
-
MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::RecurringSchedule::Frequency
|
|
2117
|
-
}
|
|
1764
|
+
enum: -> { MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::RecurringSchedule::Frequency }
|
|
2118
1765
|
|
|
2119
1766
|
# @!attribute starting_at
|
|
2120
1767
|
# RFC 3339 timestamp (inclusive).
|