metronome-sdk 0.1.0.pre.alpha.1
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 +7 -0
- data/.ignore +2 -0
- data/CHANGELOG.md +290 -0
- data/README.md +258 -0
- data/SECURITY.md +27 -0
- data/lib/metronome_sdk/client.rb +78 -0
- data/lib/metronome_sdk/errors.rb +192 -0
- data/lib/metronome_sdk/file_part.rb +55 -0
- data/lib/metronome_sdk/internal/cursor_page.rb +86 -0
- data/lib/metronome_sdk/internal/transport/base_client.rb +486 -0
- data/lib/metronome_sdk/internal/transport/pooled_net_requester.rb +193 -0
- data/lib/metronome_sdk/internal/type/array_of.rb +154 -0
- data/lib/metronome_sdk/internal/type/base_model.rb +443 -0
- data/lib/metronome_sdk/internal/type/base_page.rb +55 -0
- data/lib/metronome_sdk/internal/type/boolean.rb +63 -0
- data/lib/metronome_sdk/internal/type/converter.rb +274 -0
- data/lib/metronome_sdk/internal/type/enum.rb +107 -0
- data/lib/metronome_sdk/internal/type/file_input.rb +96 -0
- data/lib/metronome_sdk/internal/type/hash_of.rb +174 -0
- data/lib/metronome_sdk/internal/type/request_parameters.rb +48 -0
- data/lib/metronome_sdk/internal/type/union.rb +220 -0
- data/lib/metronome_sdk/internal/type/unknown.rb +67 -0
- data/lib/metronome_sdk/internal/util.rb +790 -0
- data/lib/metronome_sdk/internal.rb +11 -0
- data/lib/metronome_sdk/models/base_usage_filter.rb +27 -0
- data/lib/metronome_sdk/models/commit.rb +848 -0
- data/lib/metronome_sdk/models/contract_without_amendments.rb +1431 -0
- data/lib/metronome_sdk/models/credit.rb +476 -0
- data/lib/metronome_sdk/models/credit_type_data.rb +21 -0
- data/lib/metronome_sdk/models/discount.rb +68 -0
- data/lib/metronome_sdk/models/event_type_filter.rb +35 -0
- data/lib/metronome_sdk/models/id.rb +15 -0
- data/lib/metronome_sdk/models/override.rb +368 -0
- data/lib/metronome_sdk/models/pro_service.rb +75 -0
- data/lib/metronome_sdk/models/property_filter.rb +55 -0
- data/lib/metronome_sdk/models/rate.rb +106 -0
- data/lib/metronome_sdk/models/schedule_duration.rb +50 -0
- data/lib/metronome_sdk/models/schedule_point_in_time.rb +62 -0
- data/lib/metronome_sdk/models/scheduled_charge.rb +76 -0
- data/lib/metronome_sdk/models/tier.rb +21 -0
- data/lib/metronome_sdk/models/v1/alert_archive_params.rb +32 -0
- data/lib/metronome_sdk/models/v1/alert_archive_response.rb +18 -0
- data/lib/metronome_sdk/models/v1/alert_create_params.rb +224 -0
- data/lib/metronome_sdk/models/v1/alert_create_response.rb +18 -0
- data/lib/metronome_sdk/models/v1/audit_log_list_params.rb +92 -0
- data/lib/metronome_sdk/models/v1/audit_log_list_response.rb +124 -0
- data/lib/metronome_sdk/models/v1/billable_metric_archive_params.rb +16 -0
- data/lib/metronome_sdk/models/v1/billable_metric_archive_response.rb +18 -0
- data/lib/metronome_sdk/models/v1/billable_metric_create_params.rb +111 -0
- data/lib/metronome_sdk/models/v1/billable_metric_create_response.rb +18 -0
- data/lib/metronome_sdk/models/v1/billable_metric_list_params.rb +40 -0
- data/lib/metronome_sdk/models/v1/billable_metric_list_response.rb +122 -0
- data/lib/metronome_sdk/models/v1/billable_metric_retrieve_params.rb +22 -0
- data/lib/metronome_sdk/models/v1/billable_metric_retrieve_response.rb +134 -0
- data/lib/metronome_sdk/models/v1/contract_add_manual_balance_entry_params.rb +79 -0
- data/lib/metronome_sdk/models/v1/contract_amend_params.rb +1778 -0
- data/lib/metronome_sdk/models/v1/contract_amend_response.rb +18 -0
- data/lib/metronome_sdk/models/v1/contract_archive_params.rb +45 -0
- data/lib/metronome_sdk/models/v1/contract_archive_response.rb +18 -0
- data/lib/metronome_sdk/models/v1/contract_create_historical_invoices_params.rb +203 -0
- data/lib/metronome_sdk/models/v1/contract_create_historical_invoices_response.rb +18 -0
- data/lib/metronome_sdk/models/v1/contract_create_params.rb +3076 -0
- data/lib/metronome_sdk/models/v1/contract_create_response.rb +18 -0
- data/lib/metronome_sdk/models/v1/contract_list_balances_params.rb +101 -0
- data/lib/metronome_sdk/models/v1/contract_list_balances_response.rb +36 -0
- data/lib/metronome_sdk/models/v1/contract_list_params.rb +76 -0
- data/lib/metronome_sdk/models/v1/contract_list_response.rb +388 -0
- data/lib/metronome_sdk/models/v1/contract_retrieve_params.rb +53 -0
- data/lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rb +117 -0
- data/lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rb +165 -0
- data/lib/metronome_sdk/models/v1/contract_retrieve_response.rb +388 -0
- data/lib/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_params.rb +139 -0
- data/lib/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_response.rb +18 -0
- data/lib/metronome_sdk/models/v1/contract_set_usage_filter_params.rb +46 -0
- data/lib/metronome_sdk/models/v1/contract_update_end_date_params.rb +57 -0
- data/lib/metronome_sdk/models/v1/contract_update_end_date_response.rb +18 -0
- data/lib/metronome_sdk/models/v1/contracts/named_schedule_retrieve_params.rb +48 -0
- data/lib/metronome_sdk/models/v1/contracts/named_schedule_retrieve_response.rb +43 -0
- data/lib/metronome_sdk/models/v1/contracts/named_schedule_update_params.rb +62 -0
- data/lib/metronome_sdk/models/v1/contracts/product_archive_params.rb +26 -0
- data/lib/metronome_sdk/models/v1/contracts/product_archive_response.rb +20 -0
- data/lib/metronome_sdk/models/v1/contracts/product_create_params.rb +167 -0
- data/lib/metronome_sdk/models/v1/contracts/product_create_response.rb +20 -0
- data/lib/metronome_sdk/models/v1/contracts/product_list_item_state.rb +152 -0
- data/lib/metronome_sdk/models/v1/contracts/product_list_params.rb +55 -0
- data/lib/metronome_sdk/models/v1/contracts/product_list_response.rb +214 -0
- data/lib/metronome_sdk/models/v1/contracts/product_retrieve_params.rb +18 -0
- data/lib/metronome_sdk/models/v1/contracts/product_retrieve_response.rb +225 -0
- data/lib/metronome_sdk/models/v1/contracts/product_update_params.rb +176 -0
- data/lib/metronome_sdk/models/v1/contracts/product_update_response.rb +20 -0
- data/lib/metronome_sdk/models/v1/contracts/quantity_conversion.rb +57 -0
- data/lib/metronome_sdk/models/v1/contracts/quantity_rounding.rb +43 -0
- data/lib/metronome_sdk/models/v1/contracts/rate_card_create_params.rb +112 -0
- data/lib/metronome_sdk/models/v1/contracts/rate_card_create_response.rb +20 -0
- data/lib/metronome_sdk/models/v1/contracts/rate_card_list_params.rb +41 -0
- data/lib/metronome_sdk/models/v1/contracts/rate_card_list_response.rb +108 -0
- data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_params.rb +18 -0
- data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rb +110 -0
- data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rb +153 -0
- data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rb +119 -0
- data/lib/metronome_sdk/models/v1/contracts/rate_card_update_params.rb +78 -0
- data/lib/metronome_sdk/models/v1/contracts/rate_card_update_response.rb +20 -0
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_params.rb +58 -0
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_response.rb +45 -0
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_update_params.rb +72 -0
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_params.rb +35 -0
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_response.rb +22 -0
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_params.rb +55 -0
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_response.rb +22 -0
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rb +229 -0
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_response.rb +23 -0
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb +216 -0
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rb +183 -0
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_params.rb +112 -0
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rb +137 -0
- data/lib/metronome_sdk/models/v1/credit_grant_create_params.rb +233 -0
- data/lib/metronome_sdk/models/v1/credit_grant_create_response.rb +18 -0
- data/lib/metronome_sdk/models/v1/credit_grant_edit_params.rb +48 -0
- data/lib/metronome_sdk/models/v1/credit_grant_edit_response.rb +18 -0
- data/lib/metronome_sdk/models/v1/credit_grant_list_entries_params.rb +69 -0
- data/lib/metronome_sdk/models/v1/credit_grant_list_entries_response.rb +164 -0
- data/lib/metronome_sdk/models/v1/credit_grant_list_params.rb +81 -0
- data/lib/metronome_sdk/models/v1/credit_grant_list_response.rb +252 -0
- data/lib/metronome_sdk/models/v1/credit_grant_void_params.rb +39 -0
- data/lib/metronome_sdk/models/v1/credit_grant_void_response.rb +18 -0
- data/lib/metronome_sdk/models/v1/credit_ledger_entry.rb +71 -0
- data/lib/metronome_sdk/models/v1/custom_field_add_key_params.rb +60 -0
- data/lib/metronome_sdk/models/v1/custom_field_delete_values_params.rb +60 -0
- data/lib/metronome_sdk/models/v1/custom_field_list_keys_params.rb +59 -0
- data/lib/metronome_sdk/models/v1/custom_field_list_keys_response.rb +74 -0
- data/lib/metronome_sdk/models/v1/custom_field_remove_key_params.rb +54 -0
- data/lib/metronome_sdk/models/v1/custom_field_set_values_params.rb +60 -0
- data/lib/metronome_sdk/models/v1/customer.rb +55 -0
- data/lib/metronome_sdk/models/v1/customer_archive_params.rb +16 -0
- data/lib/metronome_sdk/models/v1/customer_archive_response.rb +18 -0
- data/lib/metronome_sdk/models/v1/customer_create_params.rb +259 -0
- data/lib/metronome_sdk/models/v1/customer_create_response.rb +18 -0
- data/lib/metronome_sdk/models/v1/customer_detail.rb +131 -0
- data/lib/metronome_sdk/models/v1/customer_list_billable_metrics_params.rb +60 -0
- data/lib/metronome_sdk/models/v1/customer_list_billable_metrics_response.rb +153 -0
- data/lib/metronome_sdk/models/v1/customer_list_costs_params.rb +55 -0
- data/lib/metronome_sdk/models/v1/customer_list_costs_response.rb +82 -0
- data/lib/metronome_sdk/models/v1/customer_list_params.rb +71 -0
- data/lib/metronome_sdk/models/v1/customer_retrieve_params.rb +22 -0
- data/lib/metronome_sdk/models/v1/customer_retrieve_response.rb +18 -0
- data/lib/metronome_sdk/models/v1/customer_set_ingest_aliases_params.rb +28 -0
- data/lib/metronome_sdk/models/v1/customer_set_name_params.rb +36 -0
- data/lib/metronome_sdk/models/v1/customer_set_name_response.rb +18 -0
- data/lib/metronome_sdk/models/v1/customer_update_config_params.rb +44 -0
- data/lib/metronome_sdk/models/v1/customers/alert_list_params.rb +59 -0
- data/lib/metronome_sdk/models/v1/customers/alert_list_response.rb +27 -0
- data/lib/metronome_sdk/models/v1/customers/alert_reset_params.rb +34 -0
- data/lib/metronome_sdk/models/v1/customers/alert_retrieve_params.rb +34 -0
- data/lib/metronome_sdk/models/v1/customers/alert_retrieve_response.rb +20 -0
- data/lib/metronome_sdk/models/v1/customers/billing_config_create_params.rb +129 -0
- data/lib/metronome_sdk/models/v1/customers/billing_config_delete_params.rb +47 -0
- data/lib/metronome_sdk/models/v1/customers/billing_config_retrieve_params.rb +47 -0
- data/lib/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rb +164 -0
- data/lib/metronome_sdk/models/v1/customers/commit_create_params.rb +436 -0
- data/lib/metronome_sdk/models/v1/customers/commit_create_response.rb +20 -0
- data/lib/metronome_sdk/models/v1/customers/commit_list_params.rb +103 -0
- data/lib/metronome_sdk/models/v1/customers/commit_list_response.rb +26 -0
- data/lib/metronome_sdk/models/v1/customers/commit_update_end_date_params.rb +59 -0
- data/lib/metronome_sdk/models/v1/customers/commit_update_end_date_response.rb +20 -0
- data/lib/metronome_sdk/models/v1/customers/credit_create_params.rb +198 -0
- data/lib/metronome_sdk/models/v1/customers/credit_create_response.rb +20 -0
- data/lib/metronome_sdk/models/v1/customers/credit_list_params.rb +103 -0
- data/lib/metronome_sdk/models/v1/customers/credit_list_response.rb +26 -0
- data/lib/metronome_sdk/models/v1/customers/credit_update_end_date_params.rb +48 -0
- data/lib/metronome_sdk/models/v1/customers/credit_update_end_date_response.rb +20 -0
- data/lib/metronome_sdk/models/v1/customers/customer_alert.rb +269 -0
- data/lib/metronome_sdk/models/v1/customers/invoice.rb +1074 -0
- data/lib/metronome_sdk/models/v1/customers/invoice_add_charge_params.rb +79 -0
- data/lib/metronome_sdk/models/v1/customers/invoice_add_charge_response.rb +14 -0
- data/lib/metronome_sdk/models/v1/customers/invoice_list_breakdowns_params.rb +135 -0
- data/lib/metronome_sdk/models/v1/customers/invoice_list_breakdowns_response.rb +26 -0
- data/lib/metronome_sdk/models/v1/customers/invoice_list_params.rb +110 -0
- data/lib/metronome_sdk/models/v1/customers/invoice_retrieve_params.rb +40 -0
- data/lib/metronome_sdk/models/v1/customers/invoice_retrieve_response.rb +20 -0
- data/lib/metronome_sdk/models/v1/customers/named_schedule_retrieve_params.rb +48 -0
- data/lib/metronome_sdk/models/v1/customers/named_schedule_retrieve_response.rb +43 -0
- data/lib/metronome_sdk/models/v1/customers/named_schedule_update_params.rb +62 -0
- data/lib/metronome_sdk/models/v1/customers/plan_add_params.rb +245 -0
- data/lib/metronome_sdk/models/v1/customers/plan_add_response.rb +20 -0
- data/lib/metronome_sdk/models/v1/customers/plan_end_params.rb +66 -0
- data/lib/metronome_sdk/models/v1/customers/plan_end_response.rb +14 -0
- data/lib/metronome_sdk/models/v1/customers/plan_list_params.rb +41 -0
- data/lib/metronome_sdk/models/v1/customers/plan_list_price_adjustments_params.rb +48 -0
- data/lib/metronome_sdk/models/v1/customers/plan_list_price_adjustments_response.rb +102 -0
- data/lib/metronome_sdk/models/v1/customers/plan_list_response.rb +118 -0
- data/lib/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rb +173 -0
- data/lib/metronome_sdk/models/v1/dashboard_get_embeddable_url_response.rb +29 -0
- data/lib/metronome_sdk/models/v1/invoice_regenerate_params.rb +24 -0
- data/lib/metronome_sdk/models/v1/invoice_regenerate_response.rb +30 -0
- data/lib/metronome_sdk/models/v1/invoice_void_params.rb +24 -0
- data/lib/metronome_sdk/models/v1/invoice_void_response.rb +29 -0
- data/lib/metronome_sdk/models/v1/plan_detail.rb +200 -0
- data/lib/metronome_sdk/models/v1/plan_get_details_params.rb +22 -0
- data/lib/metronome_sdk/models/v1/plan_get_details_response.rb +18 -0
- data/lib/metronome_sdk/models/v1/plan_list_charges_params.rb +39 -0
- data/lib/metronome_sdk/models/v1/plan_list_charges_response.rb +202 -0
- data/lib/metronome_sdk/models/v1/plan_list_customers_params.rb +79 -0
- data/lib/metronome_sdk/models/v1/plan_list_customers_response.rb +72 -0
- data/lib/metronome_sdk/models/v1/plan_list_params.rb +32 -0
- data/lib/metronome_sdk/models/v1/plan_list_response.rb +36 -0
- data/lib/metronome_sdk/models/v1/pricing_unit_list_params.rb +32 -0
- data/lib/metronome_sdk/models/v1/pricing_unit_list_response.rb +30 -0
- data/lib/metronome_sdk/models/v1/rollover_amount_max_amount.rb +38 -0
- data/lib/metronome_sdk/models/v1/rollover_amount_max_percentage.rb +38 -0
- data/lib/metronome_sdk/models/v1/service_list_params.rb +16 -0
- data/lib/metronome_sdk/models/v1/service_list_response.rb +52 -0
- data/lib/metronome_sdk/models/v1/usage_ingest_params.rb +62 -0
- data/lib/metronome_sdk/models/v1/usage_list_params.rb +129 -0
- data/lib/metronome_sdk/models/v1/usage_list_response.rb +83 -0
- data/lib/metronome_sdk/models/v1/usage_list_with_groups_params.rb +130 -0
- data/lib/metronome_sdk/models/v1/usage_list_with_groups_response.rb +42 -0
- data/lib/metronome_sdk/models/v2/contract_edit_commit_params.rb +266 -0
- data/lib/metronome_sdk/models/v2/contract_edit_commit_response.rb +18 -0
- data/lib/metronome_sdk/models/v2/contract_edit_credit_params.rb +154 -0
- data/lib/metronome_sdk/models/v2/contract_edit_credit_response.rb +18 -0
- data/lib/metronome_sdk/models/v2/contract_edit_params.rb +3281 -0
- data/lib/metronome_sdk/models/v2/contract_edit_response.rb +18 -0
- data/lib/metronome_sdk/models/v2/contract_get_edit_history_params.rb +28 -0
- data/lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb +2394 -0
- data/lib/metronome_sdk/models/v2/contract_list_params.rb +74 -0
- data/lib/metronome_sdk/models/v2/contract_list_response.rb +3044 -0
- data/lib/metronome_sdk/models/v2/contract_retrieve_params.rb +63 -0
- data/lib/metronome_sdk/models/v2/contract_retrieve_response.rb +3051 -0
- data/lib/metronome_sdk/request_options.rb +73 -0
- data/lib/metronome_sdk/resources/v1/alerts.rb +99 -0
- data/lib/metronome_sdk/resources/v1/audit_logs.rb +60 -0
- data/lib/metronome_sdk/resources/v1/billable_metrics.rb +131 -0
- data/lib/metronome_sdk/resources/v1/contracts/named_schedules.rb +86 -0
- data/lib/metronome_sdk/resources/v1/contracts/products.rb +212 -0
- data/lib/metronome_sdk/resources/v1/contracts/rate_cards/named_schedules.rb +94 -0
- data/lib/metronome_sdk/resources/v1/contracts/rate_cards/product_orders.rb +70 -0
- data/lib/metronome_sdk/resources/v1/contracts/rate_cards/rates.rb +141 -0
- data/lib/metronome_sdk/resources/v1/contracts/rate_cards.rb +192 -0
- data/lib/metronome_sdk/resources/v1/contracts.rb +506 -0
- data/lib/metronome_sdk/resources/v1/credit_grants.rb +211 -0
- data/lib/metronome_sdk/resources/v1/custom_fields.rb +140 -0
- data/lib/metronome_sdk/resources/v1/customers/alerts.rb +99 -0
- data/lib/metronome_sdk/resources/v1/customers/billing_config.rb +126 -0
- data/lib/metronome_sdk/resources/v1/customers/commits.rb +165 -0
- data/lib/metronome_sdk/resources/v1/customers/credits.rb +151 -0
- data/lib/metronome_sdk/resources/v1/customers/invoices.rb +208 -0
- data/lib/metronome_sdk/resources/v1/customers/named_schedules.rb +86 -0
- data/lib/metronome_sdk/resources/v1/customers/plans.rb +184 -0
- data/lib/metronome_sdk/resources/v1/customers.rb +336 -0
- data/lib/metronome_sdk/resources/v1/dashboards.rb +48 -0
- data/lib/metronome_sdk/resources/v1/invoices.rb +60 -0
- data/lib/metronome_sdk/resources/v1/plans.rb +133 -0
- data/lib/metronome_sdk/resources/v1/pricing_units.rb +41 -0
- data/lib/metronome_sdk/resources/v1/services.rb +37 -0
- data/lib/metronome_sdk/resources/v1/usage.rb +129 -0
- data/lib/metronome_sdk/resources/v1.rb +66 -0
- data/lib/metronome_sdk/resources/v2/contracts.rb +256 -0
- data/lib/metronome_sdk/resources/v2.rb +18 -0
- data/lib/metronome_sdk/version.rb +5 -0
- data/lib/metronome_sdk.rb +282 -0
- data/manifest.yaml +15 -0
- data/rbi/metronome_sdk/client.rbi +51 -0
- data/rbi/metronome_sdk/errors.rbi +143 -0
- data/rbi/metronome_sdk/file_part.rbi +34 -0
- data/rbi/metronome_sdk/internal/cursor_page.rbi +21 -0
- data/rbi/metronome_sdk/internal/transport/base_client.rbi +213 -0
- data/rbi/metronome_sdk/internal/transport/pooled_net_requester.rbi +60 -0
- data/rbi/metronome_sdk/internal/type/array_of.rbi +88 -0
- data/rbi/metronome_sdk/internal/type/base_model.rbi +220 -0
- data/rbi/metronome_sdk/internal/type/base_page.rbi +38 -0
- data/rbi/metronome_sdk/internal/type/boolean.rbi +48 -0
- data/rbi/metronome_sdk/internal/type/converter.rbi +120 -0
- data/rbi/metronome_sdk/internal/type/enum.rbi +66 -0
- data/rbi/metronome_sdk/internal/type/file_input.rbi +50 -0
- data/rbi/metronome_sdk/internal/type/hash_of.rbi +88 -0
- data/rbi/metronome_sdk/internal/type/request_parameters.rbi +21 -0
- data/rbi/metronome_sdk/internal/type/union.rbi +80 -0
- data/rbi/metronome_sdk/internal/type/unknown.rbi +40 -0
- data/rbi/metronome_sdk/internal/util.rbi +302 -0
- data/rbi/metronome_sdk/internal.rbi +11 -0
- data/rbi/metronome_sdk/models/base_usage_filter.rbi +27 -0
- data/rbi/metronome_sdk/models/commit.rbi +1283 -0
- data/rbi/metronome_sdk/models/contract_without_amendments.rbi +2407 -0
- data/rbi/metronome_sdk/models/credit.rbi +697 -0
- data/rbi/metronome_sdk/models/credit_type_data.rbi +19 -0
- data/rbi/metronome_sdk/models/discount.rbi +90 -0
- data/rbi/metronome_sdk/models/event_type_filter.rbi +40 -0
- data/rbi/metronome_sdk/models/id.rbi +16 -0
- data/rbi/metronome_sdk/models/override.rbi +503 -0
- data/rbi/metronome_sdk/models/pro_service.rbi +92 -0
- data/rbi/metronome_sdk/models/property_filter.rbi +75 -0
- data/rbi/metronome_sdk/models/rate.rbi +143 -0
- data/rbi/metronome_sdk/models/schedule_duration.rbi +58 -0
- data/rbi/metronome_sdk/models/schedule_point_in_time.rbi +92 -0
- data/rbi/metronome_sdk/models/scheduled_charge.rbi +104 -0
- data/rbi/metronome_sdk/models/tier.rbi +22 -0
- data/rbi/metronome_sdk/models/v1/alert_archive_params.rbi +48 -0
- data/rbi/metronome_sdk/models/v1/alert_archive_response.rbi +21 -0
- data/rbi/metronome_sdk/models/v1/alert_create_params.rbi +342 -0
- data/rbi/metronome_sdk/models/v1/alert_create_response.rbi +21 -0
- data/rbi/metronome_sdk/models/v1/audit_log_list_params.rbi +128 -0
- data/rbi/metronome_sdk/models/v1/audit_log_list_response.rbi +167 -0
- data/rbi/metronome_sdk/models/v1/billable_metric_archive_params.rbi +21 -0
- data/rbi/metronome_sdk/models/v1/billable_metric_archive_response.rbi +21 -0
- data/rbi/metronome_sdk/models/v1/billable_metric_create_params.rbi +165 -0
- data/rbi/metronome_sdk/models/v1/billable_metric_create_response.rbi +21 -0
- data/rbi/metronome_sdk/models/v1/billable_metric_list_params.rbi +64 -0
- data/rbi/metronome_sdk/models/v1/billable_metric_list_response.rbi +174 -0
- data/rbi/metronome_sdk/models/v1/billable_metric_retrieve_params.rbi +27 -0
- data/rbi/metronome_sdk/models/v1/billable_metric_retrieve_response.rbi +217 -0
- data/rbi/metronome_sdk/models/v1/contract_add_manual_balance_entry_params.rbi +95 -0
- data/rbi/metronome_sdk/models/v1/contract_amend_params.rbi +2903 -0
- data/rbi/metronome_sdk/models/v1/contract_amend_response.rbi +21 -0
- data/rbi/metronome_sdk/models/v1/contract_archive_params.rbi +57 -0
- data/rbi/metronome_sdk/models/v1/contract_archive_response.rbi +21 -0
- data/rbi/metronome_sdk/models/v1/contract_create_historical_invoices_params.rbi +346 -0
- data/rbi/metronome_sdk/models/v1/contract_create_historical_invoices_response.rbi +23 -0
- data/rbi/metronome_sdk/models/v1/contract_create_params.rbi +5220 -0
- data/rbi/metronome_sdk/models/v1/contract_create_response.rbi +21 -0
- data/rbi/metronome_sdk/models/v1/contract_list_balances_params.rbi +138 -0
- data/rbi/metronome_sdk/models/v1/contract_list_balances_response.rbi +42 -0
- data/rbi/metronome_sdk/models/v1/contract_list_params.rbi +104 -0
- data/rbi/metronome_sdk/models/v1/contract_list_response.rbi +670 -0
- data/rbi/metronome_sdk/models/v1/contract_retrieve_params.rbi +69 -0
- data/rbi/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rbi +178 -0
- data/rbi/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rbi +254 -0
- data/rbi/metronome_sdk/models/v1/contract_retrieve_response.rbi +683 -0
- data/rbi/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_params.rbi +192 -0
- data/rbi/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_response.rbi +23 -0
- data/rbi/metronome_sdk/models/v1/contract_set_usage_filter_params.rbi +63 -0
- data/rbi/metronome_sdk/models/v1/contract_update_end_date_params.rbi +77 -0
- data/rbi/metronome_sdk/models/v1/contract_update_end_date_response.rbi +21 -0
- data/rbi/metronome_sdk/models/v1/contracts/named_schedule_retrieve_params.rbi +62 -0
- data/rbi/metronome_sdk/models/v1/contracts/named_schedule_retrieve_response.rbi +55 -0
- data/rbi/metronome_sdk/models/v1/contracts/named_schedule_update_params.rbi +74 -0
- data/rbi/metronome_sdk/models/v1/contracts/product_archive_params.rbi +33 -0
- data/rbi/metronome_sdk/models/v1/contracts/product_archive_response.rbi +23 -0
- data/rbi/metronome_sdk/models/v1/contracts/product_create_params.rbi +241 -0
- data/rbi/metronome_sdk/models/v1/contracts/product_create_response.rbi +23 -0
- data/rbi/metronome_sdk/models/v1/contracts/product_list_item_state.rbi +214 -0
- data/rbi/metronome_sdk/models/v1/contracts/product_list_params.rbi +90 -0
- data/rbi/metronome_sdk/models/v1/contracts/product_list_response.rbi +307 -0
- data/rbi/metronome_sdk/models/v1/contracts/product_retrieve_params.rbi +23 -0
- data/rbi/metronome_sdk/models/v1/contracts/product_retrieve_response.rbi +347 -0
- data/rbi/metronome_sdk/models/v1/contracts/product_update_params.rbi +248 -0
- data/rbi/metronome_sdk/models/v1/contracts/product_update_response.rbi +23 -0
- data/rbi/metronome_sdk/models/v1/contracts/quantity_conversion.rbi +80 -0
- data/rbi/metronome_sdk/models/v1/contracts/quantity_rounding.rbi +62 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_create_params.rbi +161 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_create_response.rbi +23 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_list_params.rbi +64 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_list_response.rbi +174 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_params.rbi +23 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rbi +171 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rbi +249 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rbi +216 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_update_params.rbi +104 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_update_response.rbi +23 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_params.rbi +72 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_response.rbi +59 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_update_params.rbi +84 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_params.rbi +49 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_response.rbi +25 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_params.rbi +74 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_response.rbi +25 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rbi +376 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_response.rbi +28 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbi +330 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rbi +323 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_list_params.rbi +169 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rbi +210 -0
- data/rbi/metronome_sdk/models/v1/credit_grant_create_params.rbi +316 -0
- data/rbi/metronome_sdk/models/v1/credit_grant_create_response.rbi +21 -0
- data/rbi/metronome_sdk/models/v1/credit_grant_edit_params.rbi +72 -0
- data/rbi/metronome_sdk/models/v1/credit_grant_edit_response.rbi +21 -0
- data/rbi/metronome_sdk/models/v1/credit_grant_list_entries_params.rbi +98 -0
- data/rbi/metronome_sdk/models/v1/credit_grant_list_entries_response.rbi +229 -0
- data/rbi/metronome_sdk/models/v1/credit_grant_list_params.rbi +114 -0
- data/rbi/metronome_sdk/models/v1/credit_grant_list_response.rbi +298 -0
- data/rbi/metronome_sdk/models/v1/credit_grant_void_params.rbi +59 -0
- data/rbi/metronome_sdk/models/v1/credit_grant_void_response.rbi +21 -0
- data/rbi/metronome_sdk/models/v1/credit_ledger_entry.rbi +81 -0
- data/rbi/metronome_sdk/models/v1/custom_field_add_key_params.rbi +82 -0
- data/rbi/metronome_sdk/models/v1/custom_field_delete_values_params.rbi +90 -0
- data/rbi/metronome_sdk/models/v1/custom_field_list_keys_params.rbi +91 -0
- data/rbi/metronome_sdk/models/v1/custom_field_list_keys_response.rbi +123 -0
- data/rbi/metronome_sdk/models/v1/custom_field_remove_key_params.rbi +78 -0
- data/rbi/metronome_sdk/models/v1/custom_field_set_values_params.rbi +83 -0
- data/rbi/metronome_sdk/models/v1/customer.rbi +68 -0
- data/rbi/metronome_sdk/models/v1/customer_archive_params.rbi +21 -0
- data/rbi/metronome_sdk/models/v1/customer_archive_response.rbi +21 -0
- data/rbi/metronome_sdk/models/v1/customer_create_params.rbi +591 -0
- data/rbi/metronome_sdk/models/v1/customer_create_response.rbi +24 -0
- data/rbi/metronome_sdk/models/v1/customer_detail.rbi +175 -0
- data/rbi/metronome_sdk/models/v1/customer_list_billable_metrics_params.rbi +83 -0
- data/rbi/metronome_sdk/models/v1/customer_list_billable_metrics_response.rbi +233 -0
- data/rbi/metronome_sdk/models/v1/customer_list_costs_params.rbi +75 -0
- data/rbi/metronome_sdk/models/v1/customer_list_costs_response.rbi +132 -0
- data/rbi/metronome_sdk/models/v1/customer_list_params.rbi +101 -0
- data/rbi/metronome_sdk/models/v1/customer_retrieve_params.rbi +27 -0
- data/rbi/metronome_sdk/models/v1/customer_retrieve_response.rbi +24 -0
- data/rbi/metronome_sdk/models/v1/customer_set_ingest_aliases_params.rbi +40 -0
- data/rbi/metronome_sdk/models/v1/customer_set_name_params.rbi +40 -0
- data/rbi/metronome_sdk/models/v1/customer_set_name_response.rbi +24 -0
- data/rbi/metronome_sdk/models/v1/customer_update_config_params.rbi +55 -0
- data/rbi/metronome_sdk/models/v1/customers/alert_list_params.rbi +90 -0
- data/rbi/metronome_sdk/models/v1/customers/alert_list_response.rbi +34 -0
- data/rbi/metronome_sdk/models/v1/customers/alert_reset_params.rbi +48 -0
- data/rbi/metronome_sdk/models/v1/customers/alert_retrieve_params.rbi +48 -0
- data/rbi/metronome_sdk/models/v1/customers/alert_retrieve_response.rbi +29 -0
- data/rbi/metronome_sdk/models/v1/customers/billing_config_create_params.rbi +320 -0
- data/rbi/metronome_sdk/models/v1/customers/billing_config_delete_params.rbi +99 -0
- data/rbi/metronome_sdk/models/v1/customers/billing_config_retrieve_params.rbi +99 -0
- data/rbi/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbi +403 -0
- data/rbi/metronome_sdk/models/v1/customers/commit_create_params.rbi +682 -0
- data/rbi/metronome_sdk/models/v1/customers/commit_create_response.rbi +23 -0
- data/rbi/metronome_sdk/models/v1/customers/commit_list_params.rbi +140 -0
- data/rbi/metronome_sdk/models/v1/customers/commit_list_response.rbi +29 -0
- data/rbi/metronome_sdk/models/v1/customers/commit_update_end_date_params.rbi +77 -0
- data/rbi/metronome_sdk/models/v1/customers/commit_update_end_date_response.rbi +23 -0
- data/rbi/metronome_sdk/models/v1/customers/credit_create_params.rbi +278 -0
- data/rbi/metronome_sdk/models/v1/customers/credit_create_response.rbi +23 -0
- data/rbi/metronome_sdk/models/v1/customers/credit_list_params.rbi +140 -0
- data/rbi/metronome_sdk/models/v1/customers/credit_list_response.rbi +29 -0
- data/rbi/metronome_sdk/models/v1/customers/credit_update_end_date_params.rbi +59 -0
- data/rbi/metronome_sdk/models/v1/customers/credit_update_end_date_response.rbi +23 -0
- data/rbi/metronome_sdk/models/v1/customers/customer_alert.rbi +445 -0
- data/rbi/metronome_sdk/models/v1/customers/invoice.rbi +1756 -0
- data/rbi/metronome_sdk/models/v1/customers/invoice_add_charge_params.rbi +89 -0
- data/rbi/metronome_sdk/models/v1/customers/invoice_add_charge_response.rbi +17 -0
- data/rbi/metronome_sdk/models/v1/customers/invoice_list_breakdowns_params.rbi +192 -0
- data/rbi/metronome_sdk/models/v1/customers/invoice_list_breakdowns_response.rbi +25 -0
- data/rbi/metronome_sdk/models/v1/customers/invoice_list_params.rbi +149 -0
- data/rbi/metronome_sdk/models/v1/customers/invoice_retrieve_params.rbi +56 -0
- data/rbi/metronome_sdk/models/v1/customers/invoice_retrieve_response.rbi +26 -0
- data/rbi/metronome_sdk/models/v1/customers/named_schedule_retrieve_params.rbi +62 -0
- data/rbi/metronome_sdk/models/v1/customers/named_schedule_retrieve_response.rbi +55 -0
- data/rbi/metronome_sdk/models/v1/customers/named_schedule_update_params.rbi +74 -0
- data/rbi/metronome_sdk/models/v1/customers/plan_add_params.rbi +384 -0
- data/rbi/metronome_sdk/models/v1/customers/plan_add_response.rbi +23 -0
- data/rbi/metronome_sdk/models/v1/customers/plan_end_params.rbi +86 -0
- data/rbi/metronome_sdk/models/v1/customers/plan_end_response.rbi +17 -0
- data/rbi/metronome_sdk/models/v1/customers/plan_list_params.rbi +61 -0
- data/rbi/metronome_sdk/models/v1/customers/plan_list_price_adjustments_params.rbi +67 -0
- data/rbi/metronome_sdk/models/v1/customers/plan_list_price_adjustments_response.rbi +192 -0
- data/rbi/metronome_sdk/models/v1/customers/plan_list_response.rbi +162 -0
- data/rbi/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rbi +375 -0
- data/rbi/metronome_sdk/models/v1/dashboard_get_embeddable_url_response.rbi +45 -0
- data/rbi/metronome_sdk/models/v1/invoice_regenerate_params.rbi +34 -0
- data/rbi/metronome_sdk/models/v1/invoice_regenerate_response.rbi +45 -0
- data/rbi/metronome_sdk/models/v1/invoice_void_params.rbi +34 -0
- data/rbi/metronome_sdk/models/v1/invoice_void_response.rbi +38 -0
- data/rbi/metronome_sdk/models/v1/plan_detail.rbi +303 -0
- data/rbi/metronome_sdk/models/v1/plan_get_details_params.rbi +27 -0
- data/rbi/metronome_sdk/models/v1/plan_get_details_response.rbi +24 -0
- data/rbi/metronome_sdk/models/v1/plan_list_charges_params.rbi +59 -0
- data/rbi/metronome_sdk/models/v1/plan_list_charges_response.rbi +284 -0
- data/rbi/metronome_sdk/models/v1/plan_list_customers_params.rbi +110 -0
- data/rbi/metronome_sdk/models/v1/plan_list_customers_response.rbi +107 -0
- data/rbi/metronome_sdk/models/v1/plan_list_params.rbi +46 -0
- data/rbi/metronome_sdk/models/v1/plan_list_response.rbi +42 -0
- data/rbi/metronome_sdk/models/v1/pricing_unit_list_params.rbi +46 -0
- data/rbi/metronome_sdk/models/v1/pricing_unit_list_response.rbi +33 -0
- data/rbi/metronome_sdk/models/v1/rollover_amount_max_amount.rbi +43 -0
- data/rbi/metronome_sdk/models/v1/rollover_amount_max_percentage.rbi +48 -0
- data/rbi/metronome_sdk/models/v1/service_list_params.rbi +21 -0
- data/rbi/metronome_sdk/models/v1/service_list_response.rbi +78 -0
- data/rbi/metronome_sdk/models/v1/usage_ingest_params.rbi +96 -0
- data/rbi/metronome_sdk/models/v1/usage_list_params.rbi +170 -0
- data/rbi/metronome_sdk/models/v1/usage_list_response.rbi +97 -0
- data/rbi/metronome_sdk/models/v1/usage_list_with_groups_params.rbi +167 -0
- data/rbi/metronome_sdk/models/v1/usage_list_with_groups_response.rbi +50 -0
- data/rbi/metronome_sdk/models/v2/contract_edit_commit_params.rbi +486 -0
- data/rbi/metronome_sdk/models/v2/contract_edit_commit_response.rbi +21 -0
- data/rbi/metronome_sdk/models/v2/contract_edit_credit_params.rbi +257 -0
- data/rbi/metronome_sdk/models/v2/contract_edit_credit_response.rbi +21 -0
- data/rbi/metronome_sdk/models/v2/contract_edit_params.rbi +5637 -0
- data/rbi/metronome_sdk/models/v2/contract_edit_response.rbi +21 -0
- data/rbi/metronome_sdk/models/v2/contract_get_edit_history_params.rbi +39 -0
- data/rbi/metronome_sdk/models/v2/contract_get_edit_history_response.rbi +4446 -0
- data/rbi/metronome_sdk/models/v2/contract_list_params.rbi +100 -0
- data/rbi/metronome_sdk/models/v2/contract_list_response.rbi +5176 -0
- data/rbi/metronome_sdk/models/v2/contract_retrieve_params.rbi +82 -0
- data/rbi/metronome_sdk/models/v2/contract_retrieve_response.rbi +5265 -0
- data/rbi/metronome_sdk/request_options.rbi +48 -0
- data/rbi/metronome_sdk/resources/v1/alerts.rbi +86 -0
- data/rbi/metronome_sdk/resources/v1/audit_logs.rbi +50 -0
- data/rbi/metronome_sdk/resources/v1/billable_metrics.rbi +87 -0
- data/rbi/metronome_sdk/resources/v1/contracts/named_schedules.rbi +61 -0
- data/rbi/metronome_sdk/resources/v1/contracts/products.rbi +195 -0
- data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/named_schedules.rbi +69 -0
- data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/product_orders.rbi +52 -0
- data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbi +133 -0
- data/rbi/metronome_sdk/resources/v1/contracts/rate_cards.rbi +146 -0
- data/rbi/metronome_sdk/resources/v1/contracts.rbi +462 -0
- data/rbi/metronome_sdk/resources/v1/credit_grants.rbi +181 -0
- data/rbi/metronome_sdk/resources/v1/custom_fields.rbi +83 -0
- data/rbi/metronome_sdk/resources/v1/customers/alerts.rbi +59 -0
- data/rbi/metronome_sdk/resources/v1/customers/billing_config.rbi +75 -0
- data/rbi/metronome_sdk/resources/v1/customers/commits.rbi +159 -0
- data/rbi/metronome_sdk/resources/v1/customers/credits.rbi +134 -0
- data/rbi/metronome_sdk/resources/v1/customers/invoices.rbi +164 -0
- data/rbi/metronome_sdk/resources/v1/customers/named_schedules.rbi +61 -0
- data/rbi/metronome_sdk/resources/v1/customers/plans.rbi +146 -0
- data/rbi/metronome_sdk/resources/v1/customers.rbi +213 -0
- data/rbi/metronome_sdk/resources/v1/dashboards.rbi +54 -0
- data/rbi/metronome_sdk/resources/v1/invoices.rbi +33 -0
- data/rbi/metronome_sdk/resources/v1/plans.rbi +82 -0
- data/rbi/metronome_sdk/resources/v1/pricing_units.rbi +25 -0
- data/rbi/metronome_sdk/resources/v1/services.rbi +20 -0
- data/rbi/metronome_sdk/resources/v1/usage.rbi +104 -0
- data/rbi/metronome_sdk/resources/v1.rbi +50 -0
- data/rbi/metronome_sdk/resources/v2/contracts.rbi +224 -0
- data/rbi/metronome_sdk/resources/v2.rbi +14 -0
- data/rbi/metronome_sdk/version.rbi +5 -0
- data/sig/metronome_sdk/client.rbs +28 -0
- data/sig/metronome_sdk/errors.rbs +101 -0
- data/sig/metronome_sdk/file_part.rbs +21 -0
- data/sig/metronome_sdk/internal/cursor_page.rbs +13 -0
- data/sig/metronome_sdk/internal/transport/base_client.rbs +116 -0
- data/sig/metronome_sdk/internal/transport/pooled_net_requester.rbs +41 -0
- data/sig/metronome_sdk/internal/type/array_of.rbs +45 -0
- data/sig/metronome_sdk/internal/type/base_model.rbs +96 -0
- data/sig/metronome_sdk/internal/type/base_page.rbs +24 -0
- data/sig/metronome_sdk/internal/type/boolean.rbs +23 -0
- data/sig/metronome_sdk/internal/type/converter.rbs +54 -0
- data/sig/metronome_sdk/internal/type/enum.rbs +29 -0
- data/sig/metronome_sdk/internal/type/file_input.rbs +23 -0
- data/sig/metronome_sdk/internal/type/hash_of.rbs +45 -0
- data/sig/metronome_sdk/internal/type/request_parameters.rbs +15 -0
- data/sig/metronome_sdk/internal/type/union.rbs +49 -0
- data/sig/metronome_sdk/internal/type/unknown.rbs +23 -0
- data/sig/metronome_sdk/internal/util.rbs +158 -0
- data/sig/metronome_sdk/internal.rbs +5 -0
- data/sig/metronome_sdk/models/base_usage_filter.rbs +24 -0
- data/sig/metronome_sdk/models/commit.rbs +750 -0
- data/sig/metronome_sdk/models/contract_without_amendments.rbs +1122 -0
- data/sig/metronome_sdk/models/credit.rbs +415 -0
- data/sig/metronome_sdk/models/credit_type_data.rbs +15 -0
- data/sig/metronome_sdk/models/discount.rbs +56 -0
- data/sig/metronome_sdk/models/event_type_filter.rbs +23 -0
- data/sig/metronome_sdk/models/id.rbs +13 -0
- data/sig/metronome_sdk/models/override.rbs +343 -0
- data/sig/metronome_sdk/models/pro_service.rbs +52 -0
- data/sig/metronome_sdk/models/property_filter.rbs +36 -0
- data/sig/metronome_sdk/models/rate.rbs +86 -0
- data/sig/metronome_sdk/models/schedule_duration.rbs +48 -0
- data/sig/metronome_sdk/models/schedule_point_in_time.rbs +65 -0
- data/sig/metronome_sdk/models/scheduled_charge.rbs +62 -0
- data/sig/metronome_sdk/models/tier.rbs +17 -0
- data/sig/metronome_sdk/models/v1/alert_archive_params.rbs +28 -0
- data/sig/metronome_sdk/models/v1/alert_archive_response.rbs +15 -0
- data/sig/metronome_sdk/models/v1/alert_create_params.rbs +181 -0
- data/sig/metronome_sdk/models/v1/alert_create_response.rbs +15 -0
- data/sig/metronome_sdk/models/v1/audit_log_list_params.rbs +76 -0
- data/sig/metronome_sdk/models/v1/audit_log_list_response.rbs +114 -0
- data/sig/metronome_sdk/models/v1/billable_metric_archive_params.rbs +17 -0
- data/sig/metronome_sdk/models/v1/billable_metric_archive_response.rbs +15 -0
- data/sig/metronome_sdk/models/v1/billable_metric_create_params.rbs +87 -0
- data/sig/metronome_sdk/models/v1/billable_metric_create_response.rbs +15 -0
- data/sig/metronome_sdk/models/v1/billable_metric_list_params.rbs +35 -0
- data/sig/metronome_sdk/models/v1/billable_metric_list_response.rbs +92 -0
- data/sig/metronome_sdk/models/v1/billable_metric_retrieve_params.rbs +23 -0
- data/sig/metronome_sdk/models/v1/billable_metric_retrieve_response.rbs +107 -0
- data/sig/metronome_sdk/models/v1/contract_add_manual_balance_entry_params.rbs +53 -0
- data/sig/metronome_sdk/models/v1/contract_amend_params.rbs +1398 -0
- data/sig/metronome_sdk/models/v1/contract_amend_response.rbs +15 -0
- data/sig/metronome_sdk/models/v1/contract_archive_params.rbs +29 -0
- data/sig/metronome_sdk/models/v1/contract_archive_response.rbs +15 -0
- data/sig/metronome_sdk/models/v1/contract_create_historical_invoices_params.rbs +188 -0
- data/sig/metronome_sdk/models/v1/contract_create_historical_invoices_response.rbs +18 -0
- data/sig/metronome_sdk/models/v1/contract_create_params.rbs +2400 -0
- data/sig/metronome_sdk/models/v1/contract_create_response.rbs +15 -0
- data/sig/metronome_sdk/models/v1/contract_list_balances_params.rbs +79 -0
- data/sig/metronome_sdk/models/v1/contract_list_balances_response.rbs +32 -0
- data/sig/metronome_sdk/models/v1/contract_list_params.rbs +55 -0
- data/sig/metronome_sdk/models/v1/contract_list_response.rbs +333 -0
- data/sig/metronome_sdk/models/v1/contract_retrieve_params.rbs +41 -0
- data/sig/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rbs +94 -0
- data/sig/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rbs +141 -0
- data/sig/metronome_sdk/models/v1/contract_retrieve_response.rbs +333 -0
- data/sig/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_params.rbs +106 -0
- data/sig/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_response.rbs +18 -0
- data/sig/metronome_sdk/models/v1/contract_set_usage_filter_params.rbs +41 -0
- data/sig/metronome_sdk/models/v1/contract_update_end_date_params.rbs +41 -0
- data/sig/metronome_sdk/models/v1/contract_update_end_date_response.rbs +16 -0
- data/sig/metronome_sdk/models/v1/contracts/named_schedule_retrieve_params.rbs +33 -0
- data/sig/metronome_sdk/models/v1/contracts/named_schedule_retrieve_response.rbs +42 -0
- data/sig/metronome_sdk/models/v1/contracts/named_schedule_update_params.rbs +45 -0
- data/sig/metronome_sdk/models/v1/contracts/product_archive_params.rbs +25 -0
- data/sig/metronome_sdk/models/v1/contracts/product_archive_response.rbs +17 -0
- data/sig/metronome_sdk/models/v1/contracts/product_create_params.rbs +120 -0
- data/sig/metronome_sdk/models/v1/contracts/product_create_response.rbs +17 -0
- data/sig/metronome_sdk/models/v1/contracts/product_list_item_state.rbs +104 -0
- data/sig/metronome_sdk/models/v1/contracts/product_list_params.rbs +55 -0
- data/sig/metronome_sdk/models/v1/contracts/product_list_response.rbs +162 -0
- data/sig/metronome_sdk/models/v1/contracts/product_retrieve_params.rbs +19 -0
- data/sig/metronome_sdk/models/v1/contracts/product_retrieve_response.rbs +179 -0
- data/sig/metronome_sdk/models/v1/contracts/product_update_params.rbs +105 -0
- data/sig/metronome_sdk/models/v1/contracts/product_update_response.rbs +17 -0
- data/sig/metronome_sdk/models/v1/contracts/quantity_conversion.rbs +43 -0
- data/sig/metronome_sdk/models/v1/contracts/quantity_rounding.rbs +38 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_create_params.rbs +99 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_create_response.rbs +17 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_list_params.rbs +37 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_list_response.rbs +111 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_params.rbs +19 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rbs +90 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rbs +131 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rbs +129 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_update_params.rbs +69 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_update_response.rbs +17 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_params.rbs +43 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_response.rbs +44 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_update_params.rbs +51 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_params.rbs +30 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_response.rbs +19 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_params.rbs +45 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_response.rbs +20 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rbs +185 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_response.rbs +19 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbs +170 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rbs +160 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_list_params.rbs +92 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rbs +114 -0
- data/sig/metronome_sdk/models/v1/credit_grant_create_params.rbs +152 -0
- data/sig/metronome_sdk/models/v1/credit_grant_create_response.rbs +15 -0
- data/sig/metronome_sdk/models/v1/credit_grant_edit_params.rbs +43 -0
- data/sig/metronome_sdk/models/v1/credit_grant_edit_response.rbs +15 -0
- data/sig/metronome_sdk/models/v1/credit_grant_list_entries_params.rbs +51 -0
- data/sig/metronome_sdk/models/v1/credit_grant_list_entries_response.rbs +120 -0
- data/sig/metronome_sdk/models/v1/credit_grant_list_params.rbs +63 -0
- data/sig/metronome_sdk/models/v1/credit_grant_list_response.rbs +155 -0
- data/sig/metronome_sdk/models/v1/credit_grant_void_params.rbs +37 -0
- data/sig/metronome_sdk/models/v1/credit_grant_void_response.rbs +15 -0
- data/sig/metronome_sdk/models/v1/credit_ledger_entry.rbs +44 -0
- data/sig/metronome_sdk/models/v1/custom_field_add_key_params.rbs +78 -0
- data/sig/metronome_sdk/models/v1/custom_field_delete_values_params.rbs +78 -0
- data/sig/metronome_sdk/models/v1/custom_field_list_keys_params.rbs +80 -0
- data/sig/metronome_sdk/models/v1/custom_field_list_keys_response.rbs +92 -0
- data/sig/metronome_sdk/models/v1/custom_field_remove_key_params.rbs +74 -0
- data/sig/metronome_sdk/models/v1/custom_field_set_values_params.rbs +78 -0
- data/sig/metronome_sdk/models/v1/customer.rbs +38 -0
- data/sig/metronome_sdk/models/v1/customer_archive_params.rbs +17 -0
- data/sig/metronome_sdk/models/v1/customer_archive_response.rbs +15 -0
- data/sig/metronome_sdk/models/v1/customer_create_params.rbs +269 -0
- data/sig/metronome_sdk/models/v1/customer_create_response.rbs +16 -0
- data/sig/metronome_sdk/models/v1/customer_detail.rbs +96 -0
- data/sig/metronome_sdk/models/v1/customer_list_billable_metrics_params.rbs +49 -0
- data/sig/metronome_sdk/models/v1/customer_list_billable_metrics_response.rbs +116 -0
- data/sig/metronome_sdk/models/v1/customer_list_costs_params.rbs +45 -0
- data/sig/metronome_sdk/models/v1/customer_list_costs_response.rbs +88 -0
- data/sig/metronome_sdk/models/v1/customer_list_params.rbs +57 -0
- data/sig/metronome_sdk/models/v1/customer_retrieve_params.rbs +23 -0
- data/sig/metronome_sdk/models/v1/customer_retrieve_response.rbs +16 -0
- data/sig/metronome_sdk/models/v1/customer_set_ingest_aliases_params.rbs +26 -0
- data/sig/metronome_sdk/models/v1/customer_set_name_params.rbs +26 -0
- data/sig/metronome_sdk/models/v1/customer_set_name_response.rbs +16 -0
- data/sig/metronome_sdk/models/v1/customer_update_config_params.rbs +33 -0
- data/sig/metronome_sdk/models/v1/customers/alert_list_params.rbs +53 -0
- data/sig/metronome_sdk/models/v1/customers/alert_list_response.rbs +26 -0
- data/sig/metronome_sdk/models/v1/customers/alert_reset_params.rbs +28 -0
- data/sig/metronome_sdk/models/v1/customers/alert_retrieve_params.rbs +28 -0
- data/sig/metronome_sdk/models/v1/customers/alert_retrieve_response.rbs +20 -0
- data/sig/metronome_sdk/models/v1/customers/billing_config_create_params.rbs +152 -0
- data/sig/metronome_sdk/models/v1/customers/billing_config_delete_params.rbs +56 -0
- data/sig/metronome_sdk/models/v1/customers/billing_config_retrieve_params.rbs +56 -0
- data/sig/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbs +181 -0
- data/sig/metronome_sdk/models/v1/customers/commit_create_params.rbs +317 -0
- data/sig/metronome_sdk/models/v1/customers/commit_create_response.rbs +17 -0
- data/sig/metronome_sdk/models/v1/customers/commit_list_params.rbs +81 -0
- data/sig/metronome_sdk/models/v1/customers/commit_list_response.rbs +23 -0
- data/sig/metronome_sdk/models/v1/customers/commit_update_end_date_params.rbs +43 -0
- data/sig/metronome_sdk/models/v1/customers/commit_update_end_date_response.rbs +18 -0
- data/sig/metronome_sdk/models/v1/customers/credit_create_params.rbs +152 -0
- data/sig/metronome_sdk/models/v1/customers/credit_create_response.rbs +17 -0
- data/sig/metronome_sdk/models/v1/customers/credit_list_params.rbs +81 -0
- data/sig/metronome_sdk/models/v1/customers/credit_list_response.rbs +23 -0
- data/sig/metronome_sdk/models/v1/customers/credit_update_end_date_params.rbs +31 -0
- data/sig/metronome_sdk/models/v1/customers/credit_update_end_date_response.rbs +18 -0
- data/sig/metronome_sdk/models/v1/customers/customer_alert.rbs +213 -0
- data/sig/metronome_sdk/models/v1/customers/invoice.rbs +995 -0
- data/sig/metronome_sdk/models/v1/customers/invoice_add_charge_params.rbs +51 -0
- data/sig/metronome_sdk/models/v1/customers/invoice_add_charge_response.rbs +15 -0
- data/sig/metronome_sdk/models/v1/customers/invoice_list_breakdowns_params.rbs +103 -0
- data/sig/metronome_sdk/models/v1/customers/invoice_list_breakdowns_response.rbs +27 -0
- data/sig/metronome_sdk/models/v1/customers/invoice_list_params.rbs +88 -0
- data/sig/metronome_sdk/models/v1/customers/invoice_retrieve_params.rbs +37 -0
- data/sig/metronome_sdk/models/v1/customers/invoice_retrieve_response.rbs +20 -0
- data/sig/metronome_sdk/models/v1/customers/named_schedule_retrieve_params.rbs +33 -0
- data/sig/metronome_sdk/models/v1/customers/named_schedule_retrieve_response.rbs +42 -0
- data/sig/metronome_sdk/models/v1/customers/named_schedule_update_params.rbs +45 -0
- data/sig/metronome_sdk/models/v1/customers/plan_add_params.rbs +183 -0
- data/sig/metronome_sdk/models/v1/customers/plan_add_response.rbs +17 -0
- data/sig/metronome_sdk/models/v1/customers/plan_end_params.rbs +49 -0
- data/sig/metronome_sdk/models/v1/customers/plan_end_response.rbs +15 -0
- data/sig/metronome_sdk/models/v1/customers/plan_list_params.rbs +35 -0
- data/sig/metronome_sdk/models/v1/customers/plan_list_price_adjustments_params.rbs +43 -0
- data/sig/metronome_sdk/models/v1/customers/plan_list_price_adjustments_response.rbs +94 -0
- data/sig/metronome_sdk/models/v1/customers/plan_list_response.rbs +104 -0
- data/sig/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rbs +176 -0
- data/sig/metronome_sdk/models/v1/dashboard_get_embeddable_url_response.rbs +32 -0
- data/sig/metronome_sdk/models/v1/invoice_regenerate_params.rbs +22 -0
- data/sig/metronome_sdk/models/v1/invoice_regenerate_response.rbs +32 -0
- data/sig/metronome_sdk/models/v1/invoice_void_params.rbs +22 -0
- data/sig/metronome_sdk/models/v1/invoice_void_response.rbs +32 -0
- data/sig/metronome_sdk/models/v1/plan_detail.rbs +173 -0
- data/sig/metronome_sdk/models/v1/plan_get_details_params.rbs +22 -0
- data/sig/metronome_sdk/models/v1/plan_get_details_response.rbs +16 -0
- data/sig/metronome_sdk/models/v1/plan_list_charges_params.rbs +33 -0
- data/sig/metronome_sdk/models/v1/plan_list_charges_response.rbs +159 -0
- data/sig/metronome_sdk/models/v1/plan_list_customers_params.rbs +58 -0
- data/sig/metronome_sdk/models/v1/plan_list_customers_response.rbs +59 -0
- data/sig/metronome_sdk/models/v1/plan_list_params.rbs +30 -0
- data/sig/metronome_sdk/models/v1/plan_list_response.rbs +34 -0
- data/sig/metronome_sdk/models/v1/pricing_unit_list_params.rbs +30 -0
- data/sig/metronome_sdk/models/v1/pricing_unit_list_response.rbs +26 -0
- data/sig/metronome_sdk/models/v1/rollover_amount_max_amount.rbs +34 -0
- data/sig/metronome_sdk/models/v1/rollover_amount_max_percentage.rbs +34 -0
- data/sig/metronome_sdk/models/v1/service_list_params.rbs +17 -0
- data/sig/metronome_sdk/models/v1/service_list_response.rbs +54 -0
- data/sig/metronome_sdk/models/v1/usage_ingest_params.rbs +60 -0
- data/sig/metronome_sdk/models/v1/usage_list_params.rbs +102 -0
- data/sig/metronome_sdk/models/v1/usage_list_response.rbs +65 -0
- data/sig/metronome_sdk/models/v1/usage_list_with_groups_params.rbs +97 -0
- data/sig/metronome_sdk/models/v1/usage_list_with_groups_response.rbs +36 -0
- data/sig/metronome_sdk/models/v2/contract_edit_commit_params.rbs +279 -0
- data/sig/metronome_sdk/models/v2/contract_edit_commit_response.rbs +15 -0
- data/sig/metronome_sdk/models/v2/contract_edit_credit_params.rbs +148 -0
- data/sig/metronome_sdk/models/v2/contract_edit_credit_response.rbs +15 -0
- data/sig/metronome_sdk/models/v2/contract_edit_params.rbs +2726 -0
- data/sig/metronome_sdk/models/v2/contract_edit_response.rbs +15 -0
- data/sig/metronome_sdk/models/v2/contract_get_edit_history_params.rbs +26 -0
- data/sig/metronome_sdk/models/v2/contract_get_edit_history_response.rbs +2128 -0
- data/sig/metronome_sdk/models/v2/contract_list_params.rbs +55 -0
- data/sig/metronome_sdk/models/v2/contract_list_response.rbs +2586 -0
- data/sig/metronome_sdk/models/v2/contract_retrieve_params.rbs +47 -0
- data/sig/metronome_sdk/models/v2/contract_retrieve_response.rbs +2586 -0
- data/sig/metronome_sdk/request_options.rbs +36 -0
- data/sig/metronome_sdk/resources/v1/alerts.rbs +32 -0
- data/sig/metronome_sdk/resources/v1/audit_logs.rbs +20 -0
- data/sig/metronome_sdk/resources/v1/billable_metrics.rbs +38 -0
- data/sig/metronome_sdk/resources/v1/contracts/named_schedules.rbs +27 -0
- data/sig/metronome_sdk/resources/v1/contracts/products.rbs +65 -0
- data/sig/metronome_sdk/resources/v1/contracts/rate_cards/named_schedules.rbs +31 -0
- data/sig/metronome_sdk/resources/v1/contracts/rate_cards/product_orders.rbs +25 -0
- data/sig/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbs +47 -0
- data/sig/metronome_sdk/resources/v1/contracts/rate_cards.rbs +57 -0
- data/sig/metronome_sdk/resources/v1/contracts.rbs +159 -0
- data/sig/metronome_sdk/resources/v1/credit_grants.rbs +62 -0
- data/sig/metronome_sdk/resources/v1/custom_fields.rbs +42 -0
- data/sig/metronome_sdk/resources/v1/customers/alerts.rbs +30 -0
- data/sig/metronome_sdk/resources/v1/customers/billing_config.rbs +33 -0
- data/sig/metronome_sdk/resources/v1/customers/commits.rbs +54 -0
- data/sig/metronome_sdk/resources/v1/customers/credits.rbs +50 -0
- data/sig/metronome_sdk/resources/v1/customers/invoices.rbs +56 -0
- data/sig/metronome_sdk/resources/v1/customers/named_schedules.rbs +27 -0
- data/sig/metronome_sdk/resources/v1/customers/plans.rbs +47 -0
- data/sig/metronome_sdk/resources/v1/customers.rbs +90 -0
- data/sig/metronome_sdk/resources/v1/dashboards.rbs +18 -0
- data/sig/metronome_sdk/resources/v1/invoices.rbs +19 -0
- data/sig/metronome_sdk/resources/v1/plans.rbs +35 -0
- data/sig/metronome_sdk/resources/v1/pricing_units.rbs +15 -0
- data/sig/metronome_sdk/resources/v1/services.rbs +13 -0
- data/sig/metronome_sdk/resources/v1/usage.rbs +37 -0
- data/sig/metronome_sdk/resources/v1.rbs +33 -0
- data/sig/metronome_sdk/resources/v2/contracts.rbs +80 -0
- data/sig/metronome_sdk/resources/v2.rbs +9 -0
- data/sig/metronome_sdk/version.rbs +3 -0
- metadata +827 -0
@@ -0,0 +1,245 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module MetronomeSDK
|
4
|
+
module Models
|
5
|
+
module V1
|
6
|
+
module Customers
|
7
|
+
# @see MetronomeSDK::Resources::V1::Customers::Plans#add
|
8
|
+
class PlanAddParams < MetronomeSDK::Internal::Type::BaseModel
|
9
|
+
extend MetronomeSDK::Internal::Type::RequestParameters::Converter
|
10
|
+
include MetronomeSDK::Internal::Type::RequestParameters
|
11
|
+
|
12
|
+
# @!attribute customer_id
|
13
|
+
#
|
14
|
+
# @return [String]
|
15
|
+
required :customer_id, String
|
16
|
+
|
17
|
+
# @!attribute plan_id
|
18
|
+
#
|
19
|
+
# @return [String]
|
20
|
+
required :plan_id, String
|
21
|
+
|
22
|
+
# @!attribute starting_on
|
23
|
+
# RFC 3339 timestamp for when the plan becomes active for this customer. Must be
|
24
|
+
# at 0:00 UTC (midnight).
|
25
|
+
#
|
26
|
+
# @return [Time]
|
27
|
+
required :starting_on, Time
|
28
|
+
|
29
|
+
# @!attribute ending_before
|
30
|
+
# RFC 3339 timestamp for when the plan ends (exclusive) for this customer. Must be
|
31
|
+
# at 0:00 UTC (midnight).
|
32
|
+
#
|
33
|
+
# @return [Time, nil]
|
34
|
+
optional :ending_before, Time
|
35
|
+
|
36
|
+
# @!attribute net_payment_terms_days
|
37
|
+
# Number of days after issuance of invoice after which the invoice is due (e.g.
|
38
|
+
# Net 30).
|
39
|
+
#
|
40
|
+
# @return [Float, nil]
|
41
|
+
optional :net_payment_terms_days, Float
|
42
|
+
|
43
|
+
# @!attribute overage_rate_adjustments
|
44
|
+
# An optional list of overage rates that override the rates of the original plan
|
45
|
+
# configuration. These new rates will apply to all pricing ramps.
|
46
|
+
#
|
47
|
+
# @return [Array<MetronomeSDK::Models::V1::Customers::PlanAddParams::OverageRateAdjustment>, nil]
|
48
|
+
optional :overage_rate_adjustments,
|
49
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::Customers::PlanAddParams::OverageRateAdjustment] }
|
50
|
+
|
51
|
+
# @!attribute price_adjustments
|
52
|
+
# A list of price adjustments can be applied on top of the pricing in the plans.
|
53
|
+
# See the
|
54
|
+
# [price adjustments documentation](https://plans-docs.metronome.com/pricing/managing-plans/#price-adjustments)
|
55
|
+
# for details.
|
56
|
+
#
|
57
|
+
# @return [Array<MetronomeSDK::Models::V1::Customers::PlanAddParams::PriceAdjustment>, nil]
|
58
|
+
optional :price_adjustments,
|
59
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::Customers::PlanAddParams::PriceAdjustment] }
|
60
|
+
|
61
|
+
# @!attribute trial_spec
|
62
|
+
# A custom trial can be set for the customer's plan. See the
|
63
|
+
# [trial configuration documentation](https://docs.metronome.com/provisioning/configure-trials/)
|
64
|
+
# for details.
|
65
|
+
#
|
66
|
+
# @return [MetronomeSDK::Models::V1::Customers::PlanAddParams::TrialSpec, nil]
|
67
|
+
optional :trial_spec, -> { MetronomeSDK::Models::V1::Customers::PlanAddParams::TrialSpec }
|
68
|
+
|
69
|
+
# @!method initialize(customer_id:, plan_id:, starting_on:, ending_before: nil, net_payment_terms_days: nil, overage_rate_adjustments: nil, price_adjustments: nil, trial_spec: nil, request_options: {})
|
70
|
+
# Some parameter documentations has been truncated, see
|
71
|
+
# {MetronomeSDK::Models::V1::Customers::PlanAddParams} for more details.
|
72
|
+
#
|
73
|
+
# @param customer_id [String]
|
74
|
+
#
|
75
|
+
# @param plan_id [String]
|
76
|
+
#
|
77
|
+
# @param starting_on [Time] RFC 3339 timestamp for when the plan becomes active for this customer. Must be a
|
78
|
+
# ...
|
79
|
+
#
|
80
|
+
# @param ending_before [Time] RFC 3339 timestamp for when the plan ends (exclusive) for this customer. Must be
|
81
|
+
# ...
|
82
|
+
#
|
83
|
+
# @param net_payment_terms_days [Float] Number of days after issuance of invoice after which the invoice is due (e.g. Ne
|
84
|
+
# ...
|
85
|
+
#
|
86
|
+
# @param overage_rate_adjustments [Array<MetronomeSDK::Models::V1::Customers::PlanAddParams::OverageRateAdjustment>] An optional list of overage rates that override the rates of the original plan c
|
87
|
+
# ...
|
88
|
+
#
|
89
|
+
# @param price_adjustments [Array<MetronomeSDK::Models::V1::Customers::PlanAddParams::PriceAdjustment>] A list of price adjustments can be applied on top of the pricing in the plans. S
|
90
|
+
# ...
|
91
|
+
#
|
92
|
+
# @param trial_spec [MetronomeSDK::Models::V1::Customers::PlanAddParams::TrialSpec] A custom trial can be set for the customer's plan. See the [trial configuration
|
93
|
+
# ...
|
94
|
+
#
|
95
|
+
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
|
96
|
+
|
97
|
+
class OverageRateAdjustment < MetronomeSDK::Internal::Type::BaseModel
|
98
|
+
# @!attribute custom_credit_type_id
|
99
|
+
#
|
100
|
+
# @return [String]
|
101
|
+
required :custom_credit_type_id, String
|
102
|
+
|
103
|
+
# @!attribute fiat_currency_credit_type_id
|
104
|
+
#
|
105
|
+
# @return [String]
|
106
|
+
required :fiat_currency_credit_type_id, String
|
107
|
+
|
108
|
+
# @!attribute to_fiat_conversion_factor
|
109
|
+
# The overage cost in fiat currency for each credit of the custom credit type.
|
110
|
+
#
|
111
|
+
# @return [Float]
|
112
|
+
required :to_fiat_conversion_factor, Float
|
113
|
+
|
114
|
+
# @!method initialize(custom_credit_type_id:, fiat_currency_credit_type_id:, to_fiat_conversion_factor:)
|
115
|
+
# @param custom_credit_type_id [String]
|
116
|
+
#
|
117
|
+
# @param fiat_currency_credit_type_id [String]
|
118
|
+
#
|
119
|
+
# @param to_fiat_conversion_factor [Float] The overage cost in fiat currency for each credit of the custom credit type.
|
120
|
+
end
|
121
|
+
|
122
|
+
class PriceAdjustment < MetronomeSDK::Internal::Type::BaseModel
|
123
|
+
# @!attribute adjustment_type
|
124
|
+
#
|
125
|
+
# @return [Symbol, MetronomeSDK::Models::V1::Customers::PlanAddParams::PriceAdjustment::AdjustmentType]
|
126
|
+
required :adjustment_type,
|
127
|
+
enum: -> { MetronomeSDK::Models::V1::Customers::PlanAddParams::PriceAdjustment::AdjustmentType }
|
128
|
+
|
129
|
+
# @!attribute charge_id
|
130
|
+
#
|
131
|
+
# @return [String]
|
132
|
+
required :charge_id, String
|
133
|
+
|
134
|
+
# @!attribute start_period
|
135
|
+
# Used in price ramps. Indicates how many billing periods pass before the charge
|
136
|
+
# applies.
|
137
|
+
#
|
138
|
+
# @return [Float]
|
139
|
+
required :start_period, Float
|
140
|
+
|
141
|
+
# @!attribute quantity
|
142
|
+
# the overridden quantity for a fixed charge
|
143
|
+
#
|
144
|
+
# @return [Float, nil]
|
145
|
+
optional :quantity, Float
|
146
|
+
|
147
|
+
# @!attribute tier
|
148
|
+
# Used in pricing tiers. Indicates at what metric value the price applies.
|
149
|
+
#
|
150
|
+
# @return [Float, nil]
|
151
|
+
optional :tier, Float
|
152
|
+
|
153
|
+
# @!attribute value
|
154
|
+
# The amount of change to a price. Percentage and fixed adjustments can be
|
155
|
+
# positive or negative. Percentage-based adjustments should be decimals, e.g.
|
156
|
+
# -0.05 for a 5% discount.
|
157
|
+
#
|
158
|
+
# @return [Float, nil]
|
159
|
+
optional :value, Float
|
160
|
+
|
161
|
+
# @!method initialize(adjustment_type:, charge_id:, start_period:, quantity: nil, tier: nil, value: nil)
|
162
|
+
# Some parameter documentations has been truncated, see
|
163
|
+
# {MetronomeSDK::Models::V1::Customers::PlanAddParams::PriceAdjustment} for more
|
164
|
+
# details.
|
165
|
+
#
|
166
|
+
# @param adjustment_type [Symbol, MetronomeSDK::Models::V1::Customers::PlanAddParams::PriceAdjustment::AdjustmentType]
|
167
|
+
#
|
168
|
+
# @param charge_id [String]
|
169
|
+
#
|
170
|
+
# @param start_period [Float] Used in price ramps. Indicates how many billing periods pass before the charge
|
171
|
+
# ...
|
172
|
+
#
|
173
|
+
# @param quantity [Float] the overridden quantity for a fixed charge
|
174
|
+
#
|
175
|
+
# @param tier [Float] Used in pricing tiers. Indicates at what metric value the price applies.
|
176
|
+
#
|
177
|
+
# @param value [Float] The amount of change to a price. Percentage and fixed adjustments can be positiv
|
178
|
+
# ...
|
179
|
+
|
180
|
+
# @see MetronomeSDK::Models::V1::Customers::PlanAddParams::PriceAdjustment#adjustment_type
|
181
|
+
module AdjustmentType
|
182
|
+
extend MetronomeSDK::Internal::Type::Enum
|
183
|
+
|
184
|
+
PERCENTAGE = :percentage
|
185
|
+
FIXED = :fixed
|
186
|
+
OVERRIDE = :override
|
187
|
+
QUANTITY = :quantity
|
188
|
+
|
189
|
+
# @!method self.values
|
190
|
+
# @return [Array<Symbol>]
|
191
|
+
end
|
192
|
+
end
|
193
|
+
|
194
|
+
class TrialSpec < MetronomeSDK::Internal::Type::BaseModel
|
195
|
+
# @!attribute length_in_days
|
196
|
+
# Length of the trial period in days.
|
197
|
+
#
|
198
|
+
# @return [Float]
|
199
|
+
required :length_in_days, Float
|
200
|
+
|
201
|
+
# @!attribute spending_cap
|
202
|
+
#
|
203
|
+
# @return [MetronomeSDK::Models::V1::Customers::PlanAddParams::TrialSpec::SpendingCap, nil]
|
204
|
+
optional :spending_cap, -> { MetronomeSDK::Models::V1::Customers::PlanAddParams::TrialSpec::SpendingCap }
|
205
|
+
|
206
|
+
# @!method initialize(length_in_days:, spending_cap: nil)
|
207
|
+
# A custom trial can be set for the customer's plan. See the
|
208
|
+
# [trial configuration documentation](https://docs.metronome.com/provisioning/configure-trials/)
|
209
|
+
# for details.
|
210
|
+
#
|
211
|
+
# @param length_in_days [Float] Length of the trial period in days.
|
212
|
+
#
|
213
|
+
# @param spending_cap [MetronomeSDK::Models::V1::Customers::PlanAddParams::TrialSpec::SpendingCap]
|
214
|
+
|
215
|
+
# @see MetronomeSDK::Models::V1::Customers::PlanAddParams::TrialSpec#spending_cap
|
216
|
+
class SpendingCap < MetronomeSDK::Internal::Type::BaseModel
|
217
|
+
# @!attribute amount
|
218
|
+
# The credit amount in the given denomination based on the credit type, e.g. US
|
219
|
+
# cents.
|
220
|
+
#
|
221
|
+
# @return [Float]
|
222
|
+
required :amount, Float
|
223
|
+
|
224
|
+
# @!attribute credit_type_id
|
225
|
+
# The credit type ID for the spending cap.
|
226
|
+
#
|
227
|
+
# @return [String]
|
228
|
+
required :credit_type_id, String
|
229
|
+
|
230
|
+
# @!method initialize(amount:, credit_type_id:)
|
231
|
+
# Some parameter documentations has been truncated, see
|
232
|
+
# {MetronomeSDK::Models::V1::Customers::PlanAddParams::TrialSpec::SpendingCap} for
|
233
|
+
# more details.
|
234
|
+
#
|
235
|
+
# @param amount [Float] The credit amount in the given denomination based on the credit type, e.g. US ce
|
236
|
+
# ...
|
237
|
+
#
|
238
|
+
# @param credit_type_id [String] The credit type ID for the spending cap.
|
239
|
+
end
|
240
|
+
end
|
241
|
+
end
|
242
|
+
end
|
243
|
+
end
|
244
|
+
end
|
245
|
+
end
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module MetronomeSDK
|
4
|
+
module Models
|
5
|
+
module V1
|
6
|
+
module Customers
|
7
|
+
# @see MetronomeSDK::Resources::V1::Customers::Plans#add
|
8
|
+
class PlanAddResponse < MetronomeSDK::Internal::Type::BaseModel
|
9
|
+
# @!attribute data
|
10
|
+
#
|
11
|
+
# @return [MetronomeSDK::Models::ID]
|
12
|
+
required :data, -> { MetronomeSDK::Models::ID }
|
13
|
+
|
14
|
+
# @!method initialize(data:)
|
15
|
+
# @param data [MetronomeSDK::Models::ID]
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
@@ -0,0 +1,66 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module MetronomeSDK
|
4
|
+
module Models
|
5
|
+
module V1
|
6
|
+
module Customers
|
7
|
+
# @see MetronomeSDK::Resources::V1::Customers::Plans#end_
|
8
|
+
class PlanEndParams < MetronomeSDK::Internal::Type::BaseModel
|
9
|
+
extend MetronomeSDK::Internal::Type::RequestParameters::Converter
|
10
|
+
include MetronomeSDK::Internal::Type::RequestParameters
|
11
|
+
|
12
|
+
# @!attribute customer_id
|
13
|
+
#
|
14
|
+
# @return [String]
|
15
|
+
required :customer_id, String
|
16
|
+
|
17
|
+
# @!attribute customer_plan_id
|
18
|
+
#
|
19
|
+
# @return [String]
|
20
|
+
required :customer_plan_id, String
|
21
|
+
|
22
|
+
# @!attribute ending_before
|
23
|
+
# RFC 3339 timestamp for when the plan ends (exclusive) for this customer. Must be
|
24
|
+
# at 0:00 UTC (midnight). If not provided, the plan end date will be cleared.
|
25
|
+
#
|
26
|
+
# @return [Time, nil]
|
27
|
+
optional :ending_before, Time
|
28
|
+
|
29
|
+
# @!attribute void_invoices
|
30
|
+
# If true, plan end date can be before the last finalized invoice date. Any
|
31
|
+
# invoices generated after the plan end date will be voided.
|
32
|
+
#
|
33
|
+
# @return [Boolean, nil]
|
34
|
+
optional :void_invoices, MetronomeSDK::Internal::Type::Boolean
|
35
|
+
|
36
|
+
# @!attribute void_stripe_invoices
|
37
|
+
# Only applicable when void_invoices is set to true. If true, for every invoice
|
38
|
+
# that is voided we will also attempt to void/delete the stripe invoice (if any).
|
39
|
+
# Stripe invoices will be voided if finalized or deleted if still in draft state.
|
40
|
+
#
|
41
|
+
# @return [Boolean, nil]
|
42
|
+
optional :void_stripe_invoices, MetronomeSDK::Internal::Type::Boolean
|
43
|
+
|
44
|
+
# @!method initialize(customer_id:, customer_plan_id:, ending_before: nil, void_invoices: nil, void_stripe_invoices: nil, request_options: {})
|
45
|
+
# Some parameter documentations has been truncated, see
|
46
|
+
# {MetronomeSDK::Models::V1::Customers::PlanEndParams} for more details.
|
47
|
+
#
|
48
|
+
# @param customer_id [String]
|
49
|
+
#
|
50
|
+
# @param customer_plan_id [String]
|
51
|
+
#
|
52
|
+
# @param ending_before [Time] RFC 3339 timestamp for when the plan ends (exclusive) for this customer. Must be
|
53
|
+
# ...
|
54
|
+
#
|
55
|
+
# @param void_invoices [Boolean] If true, plan end date can be before the last finalized invoice date. Any invoic
|
56
|
+
# ...
|
57
|
+
#
|
58
|
+
# @param void_stripe_invoices [Boolean] Only applicable when void_invoices is set to true. If true, for every invoice th
|
59
|
+
# ...
|
60
|
+
#
|
61
|
+
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
|
62
|
+
end
|
63
|
+
end
|
64
|
+
end
|
65
|
+
end
|
66
|
+
end
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module MetronomeSDK
|
4
|
+
module Models
|
5
|
+
module V1
|
6
|
+
module Customers
|
7
|
+
# @see MetronomeSDK::Resources::V1::Customers::Plans#end_
|
8
|
+
class PlanEndResponse < MetronomeSDK::Internal::Type::BaseModel
|
9
|
+
# @!method initialize
|
10
|
+
end
|
11
|
+
end
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
@@ -0,0 +1,41 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module MetronomeSDK
|
4
|
+
module Models
|
5
|
+
module V1
|
6
|
+
module Customers
|
7
|
+
# @see MetronomeSDK::Resources::V1::Customers::Plans#list
|
8
|
+
class PlanListParams < MetronomeSDK::Internal::Type::BaseModel
|
9
|
+
extend MetronomeSDK::Internal::Type::RequestParameters::Converter
|
10
|
+
include MetronomeSDK::Internal::Type::RequestParameters
|
11
|
+
|
12
|
+
# @!attribute customer_id
|
13
|
+
#
|
14
|
+
# @return [String]
|
15
|
+
required :customer_id, String
|
16
|
+
|
17
|
+
# @!attribute limit
|
18
|
+
# Max number of results that should be returned
|
19
|
+
#
|
20
|
+
# @return [Integer, nil]
|
21
|
+
optional :limit, Integer
|
22
|
+
|
23
|
+
# @!attribute next_page
|
24
|
+
# Cursor that indicates where the next page of results should start.
|
25
|
+
#
|
26
|
+
# @return [String, nil]
|
27
|
+
optional :next_page, String
|
28
|
+
|
29
|
+
# @!method initialize(customer_id:, limit: nil, next_page: nil, request_options: {})
|
30
|
+
# @param customer_id [String]
|
31
|
+
#
|
32
|
+
# @param limit [Integer] Max number of results that should be returned
|
33
|
+
#
|
34
|
+
# @param next_page [String] Cursor that indicates where the next page of results should start.
|
35
|
+
#
|
36
|
+
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
40
|
+
end
|
41
|
+
end
|
@@ -0,0 +1,48 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module MetronomeSDK
|
4
|
+
module Models
|
5
|
+
module V1
|
6
|
+
module Customers
|
7
|
+
# @see MetronomeSDK::Resources::V1::Customers::Plans#list_price_adjustments
|
8
|
+
class PlanListPriceAdjustmentsParams < MetronomeSDK::Internal::Type::BaseModel
|
9
|
+
extend MetronomeSDK::Internal::Type::RequestParameters::Converter
|
10
|
+
include MetronomeSDK::Internal::Type::RequestParameters
|
11
|
+
|
12
|
+
# @!attribute customer_id
|
13
|
+
#
|
14
|
+
# @return [String]
|
15
|
+
required :customer_id, String
|
16
|
+
|
17
|
+
# @!attribute customer_plan_id
|
18
|
+
#
|
19
|
+
# @return [String]
|
20
|
+
required :customer_plan_id, String
|
21
|
+
|
22
|
+
# @!attribute limit
|
23
|
+
# Max number of results that should be returned
|
24
|
+
#
|
25
|
+
# @return [Integer, nil]
|
26
|
+
optional :limit, Integer
|
27
|
+
|
28
|
+
# @!attribute next_page
|
29
|
+
# Cursor that indicates where the next page of results should start.
|
30
|
+
#
|
31
|
+
# @return [String, nil]
|
32
|
+
optional :next_page, String
|
33
|
+
|
34
|
+
# @!method initialize(customer_id:, customer_plan_id:, limit: nil, next_page: nil, request_options: {})
|
35
|
+
# @param customer_id [String]
|
36
|
+
#
|
37
|
+
# @param customer_plan_id [String]
|
38
|
+
#
|
39
|
+
# @param limit [Integer] Max number of results that should be returned
|
40
|
+
#
|
41
|
+
# @param next_page [String] Cursor that indicates where the next page of results should start.
|
42
|
+
#
|
43
|
+
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
@@ -0,0 +1,102 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module MetronomeSDK
|
4
|
+
module Models
|
5
|
+
module V1
|
6
|
+
module Customers
|
7
|
+
# @see MetronomeSDK::Resources::V1::Customers::Plans#list_price_adjustments
|
8
|
+
class PlanListPriceAdjustmentsResponse < MetronomeSDK::Internal::Type::BaseModel
|
9
|
+
# @!attribute charge_id
|
10
|
+
#
|
11
|
+
# @return [String]
|
12
|
+
required :charge_id, String
|
13
|
+
|
14
|
+
# @!attribute charge_type
|
15
|
+
#
|
16
|
+
# @return [Symbol, MetronomeSDK::Models::V1::Customers::PlanListPriceAdjustmentsResponse::ChargeType]
|
17
|
+
required :charge_type,
|
18
|
+
enum: -> { MetronomeSDK::Models::V1::Customers::PlanListPriceAdjustmentsResponse::ChargeType }
|
19
|
+
|
20
|
+
# @!attribute prices
|
21
|
+
#
|
22
|
+
# @return [Array<MetronomeSDK::Models::V1::Customers::PlanListPriceAdjustmentsResponse::Price>]
|
23
|
+
required :prices,
|
24
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::Customers::PlanListPriceAdjustmentsResponse::Price] }
|
25
|
+
|
26
|
+
# @!attribute start_period
|
27
|
+
#
|
28
|
+
# @return [Float]
|
29
|
+
required :start_period, Float
|
30
|
+
|
31
|
+
# @!attribute quantity
|
32
|
+
#
|
33
|
+
# @return [Float, nil]
|
34
|
+
optional :quantity, Float
|
35
|
+
|
36
|
+
# @!method initialize(charge_id:, charge_type:, prices:, start_period:, quantity: nil)
|
37
|
+
# @param charge_id [String]
|
38
|
+
# @param charge_type [Symbol, MetronomeSDK::Models::V1::Customers::PlanListPriceAdjustmentsResponse::ChargeType]
|
39
|
+
# @param prices [Array<MetronomeSDK::Models::V1::Customers::PlanListPriceAdjustmentsResponse::Price>]
|
40
|
+
# @param start_period [Float]
|
41
|
+
# @param quantity [Float]
|
42
|
+
|
43
|
+
# @see MetronomeSDK::Models::V1::Customers::PlanListPriceAdjustmentsResponse#charge_type
|
44
|
+
module ChargeType
|
45
|
+
extend MetronomeSDK::Internal::Type::Enum
|
46
|
+
|
47
|
+
USAGE = :usage
|
48
|
+
FIXED = :fixed
|
49
|
+
COMPOSITE = :composite
|
50
|
+
MINIMUM = :minimum
|
51
|
+
SEAT = :seat
|
52
|
+
|
53
|
+
# @!method self.values
|
54
|
+
# @return [Array<Symbol>]
|
55
|
+
end
|
56
|
+
|
57
|
+
class Price < MetronomeSDK::Internal::Type::BaseModel
|
58
|
+
# @!attribute adjustment_type
|
59
|
+
# Determines how the value will be applied.
|
60
|
+
#
|
61
|
+
# @return [Symbol, MetronomeSDK::Models::V1::Customers::PlanListPriceAdjustmentsResponse::Price::AdjustmentType]
|
62
|
+
required :adjustment_type,
|
63
|
+
enum: -> { MetronomeSDK::Models::V1::Customers::PlanListPriceAdjustmentsResponse::Price::AdjustmentType }
|
64
|
+
|
65
|
+
# @!attribute tier
|
66
|
+
# Used in pricing tiers. Indicates at what metric value the price applies.
|
67
|
+
#
|
68
|
+
# @return [Float, nil]
|
69
|
+
optional :tier, Float
|
70
|
+
|
71
|
+
# @!attribute value
|
72
|
+
#
|
73
|
+
# @return [Float, nil]
|
74
|
+
optional :value, Float
|
75
|
+
|
76
|
+
# @!method initialize(adjustment_type:, tier: nil, value: nil)
|
77
|
+
# @param adjustment_type [Symbol, MetronomeSDK::Models::V1::Customers::PlanListPriceAdjustmentsResponse::Price::AdjustmentType] Determines how the value will be applied.
|
78
|
+
#
|
79
|
+
# @param tier [Float] Used in pricing tiers. Indicates at what metric value the price applies.
|
80
|
+
#
|
81
|
+
# @param value [Float]
|
82
|
+
|
83
|
+
# Determines how the value will be applied.
|
84
|
+
#
|
85
|
+
# @see MetronomeSDK::Models::V1::Customers::PlanListPriceAdjustmentsResponse::Price#adjustment_type
|
86
|
+
module AdjustmentType
|
87
|
+
extend MetronomeSDK::Internal::Type::Enum
|
88
|
+
|
89
|
+
FIXED = :fixed
|
90
|
+
QUANTITY = :quantity
|
91
|
+
PERCENTAGE = :percentage
|
92
|
+
OVERRIDE = :override
|
93
|
+
|
94
|
+
# @!method self.values
|
95
|
+
# @return [Array<Symbol>]
|
96
|
+
end
|
97
|
+
end
|
98
|
+
end
|
99
|
+
end
|
100
|
+
end
|
101
|
+
end
|
102
|
+
end
|
@@ -0,0 +1,118 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module MetronomeSDK
|
4
|
+
module Models
|
5
|
+
module V1
|
6
|
+
module Customers
|
7
|
+
# @see MetronomeSDK::Resources::V1::Customers::Plans#list
|
8
|
+
class PlanListResponse < MetronomeSDK::Internal::Type::BaseModel
|
9
|
+
# @!attribute id
|
10
|
+
# the ID of the customer plan
|
11
|
+
#
|
12
|
+
# @return [String]
|
13
|
+
required :id, String
|
14
|
+
|
15
|
+
# @!attribute custom_fields
|
16
|
+
#
|
17
|
+
# @return [Hash{Symbol=>String}]
|
18
|
+
required :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
|
19
|
+
|
20
|
+
# @!attribute plan_description
|
21
|
+
#
|
22
|
+
# @return [String]
|
23
|
+
required :plan_description, String
|
24
|
+
|
25
|
+
# @!attribute plan_id
|
26
|
+
# the ID of the plan
|
27
|
+
#
|
28
|
+
# @return [String]
|
29
|
+
required :plan_id, String
|
30
|
+
|
31
|
+
# @!attribute plan_name
|
32
|
+
#
|
33
|
+
# @return [String]
|
34
|
+
required :plan_name, String
|
35
|
+
|
36
|
+
# @!attribute starting_on
|
37
|
+
#
|
38
|
+
# @return [Time]
|
39
|
+
required :starting_on, Time
|
40
|
+
|
41
|
+
# @!attribute ending_before
|
42
|
+
#
|
43
|
+
# @return [Time, nil]
|
44
|
+
optional :ending_before, Time
|
45
|
+
|
46
|
+
# @!attribute net_payment_terms_days
|
47
|
+
#
|
48
|
+
# @return [Float, nil]
|
49
|
+
optional :net_payment_terms_days, Float
|
50
|
+
|
51
|
+
# @!attribute trial_info
|
52
|
+
#
|
53
|
+
# @return [MetronomeSDK::Models::V1::Customers::PlanListResponse::TrialInfo, nil]
|
54
|
+
optional :trial_info, -> { MetronomeSDK::Models::V1::Customers::PlanListResponse::TrialInfo }
|
55
|
+
|
56
|
+
# @!method initialize(id:, custom_fields:, plan_description:, plan_id:, plan_name:, starting_on:, ending_before: nil, net_payment_terms_days: nil, trial_info: nil)
|
57
|
+
# @param id [String] the ID of the customer plan
|
58
|
+
#
|
59
|
+
# @param custom_fields [Hash{Symbol=>String}]
|
60
|
+
#
|
61
|
+
# @param plan_description [String]
|
62
|
+
#
|
63
|
+
# @param plan_id [String] the ID of the plan
|
64
|
+
#
|
65
|
+
# @param plan_name [String]
|
66
|
+
#
|
67
|
+
# @param starting_on [Time]
|
68
|
+
#
|
69
|
+
# @param ending_before [Time]
|
70
|
+
#
|
71
|
+
# @param net_payment_terms_days [Float]
|
72
|
+
#
|
73
|
+
# @param trial_info [MetronomeSDK::Models::V1::Customers::PlanListResponse::TrialInfo]
|
74
|
+
|
75
|
+
# @see MetronomeSDK::Models::V1::Customers::PlanListResponse#trial_info
|
76
|
+
class TrialInfo < MetronomeSDK::Internal::Type::BaseModel
|
77
|
+
# @!attribute ending_before
|
78
|
+
#
|
79
|
+
# @return [Time]
|
80
|
+
required :ending_before, Time
|
81
|
+
|
82
|
+
# @!attribute spending_caps
|
83
|
+
#
|
84
|
+
# @return [Array<MetronomeSDK::Models::V1::Customers::PlanListResponse::TrialInfo::SpendingCap>]
|
85
|
+
required :spending_caps,
|
86
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::Customers::PlanListResponse::TrialInfo::SpendingCap] }
|
87
|
+
|
88
|
+
# @!method initialize(ending_before:, spending_caps:)
|
89
|
+
# @param ending_before [Time]
|
90
|
+
# @param spending_caps [Array<MetronomeSDK::Models::V1::Customers::PlanListResponse::TrialInfo::SpendingCap>]
|
91
|
+
|
92
|
+
class SpendingCap < MetronomeSDK::Internal::Type::BaseModel
|
93
|
+
# @!attribute amount
|
94
|
+
#
|
95
|
+
# @return [Float]
|
96
|
+
required :amount, Float
|
97
|
+
|
98
|
+
# @!attribute amount_remaining
|
99
|
+
#
|
100
|
+
# @return [Float]
|
101
|
+
required :amount_remaining, Float
|
102
|
+
|
103
|
+
# @!attribute credit_type
|
104
|
+
#
|
105
|
+
# @return [MetronomeSDK::Models::CreditTypeData]
|
106
|
+
required :credit_type, -> { MetronomeSDK::Models::CreditTypeData }
|
107
|
+
|
108
|
+
# @!method initialize(amount:, amount_remaining:, credit_type:)
|
109
|
+
# @param amount [Float]
|
110
|
+
# @param amount_remaining [Float]
|
111
|
+
# @param credit_type [MetronomeSDK::Models::CreditTypeData]
|
112
|
+
end
|
113
|
+
end
|
114
|
+
end
|
115
|
+
end
|
116
|
+
end
|
117
|
+
end
|
118
|
+
end
|