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,462 @@
|
|
1
|
+
# typed: strong
|
2
|
+
|
3
|
+
module MetronomeSDK
|
4
|
+
module Resources
|
5
|
+
class V1
|
6
|
+
class Contracts
|
7
|
+
sig { returns(MetronomeSDK::Resources::V1::Contracts::Products) }
|
8
|
+
attr_reader :products
|
9
|
+
|
10
|
+
sig { returns(MetronomeSDK::Resources::V1::Contracts::RateCards) }
|
11
|
+
attr_reader :rate_cards
|
12
|
+
|
13
|
+
sig { returns(MetronomeSDK::Resources::V1::Contracts::NamedSchedules) }
|
14
|
+
attr_reader :named_schedules
|
15
|
+
|
16
|
+
# Create a new contract
|
17
|
+
sig do
|
18
|
+
params(
|
19
|
+
customer_id: String,
|
20
|
+
starting_at: Time,
|
21
|
+
billing_provider_configuration: T.any(
|
22
|
+
MetronomeSDK::Models::V1::ContractCreateParams::BillingProviderConfiguration,
|
23
|
+
MetronomeSDK::Internal::AnyHash
|
24
|
+
),
|
25
|
+
commits: T::Array[T.any(MetronomeSDK::Models::V1::ContractCreateParams::Commit, MetronomeSDK::Internal::AnyHash)],
|
26
|
+
credit_balance_threshold_configuration: T.any(
|
27
|
+
MetronomeSDK::Models::V1::ContractCreateParams::CreditBalanceThresholdConfiguration,
|
28
|
+
MetronomeSDK::Internal::AnyHash
|
29
|
+
),
|
30
|
+
credits: T::Array[T.any(MetronomeSDK::Models::V1::ContractCreateParams::Credit, MetronomeSDK::Internal::AnyHash)],
|
31
|
+
custom_fields: T::Hash[Symbol, String],
|
32
|
+
discounts: T::Array[T.any(MetronomeSDK::Models::V1::ContractCreateParams::Discount, MetronomeSDK::Internal::AnyHash)],
|
33
|
+
ending_before: Time,
|
34
|
+
multiplier_override_prioritization: MetronomeSDK::Models::V1::ContractCreateParams::MultiplierOverridePrioritization::OrSymbol,
|
35
|
+
name: String,
|
36
|
+
net_payment_terms_days: Float,
|
37
|
+
netsuite_sales_order_id: String,
|
38
|
+
overrides: T::Array[T.any(MetronomeSDK::Models::V1::ContractCreateParams::Override, MetronomeSDK::Internal::AnyHash)],
|
39
|
+
professional_services: T::Array[
|
40
|
+
T.any(
|
41
|
+
MetronomeSDK::Models::V1::ContractCreateParams::ProfessionalService,
|
42
|
+
MetronomeSDK::Internal::AnyHash
|
43
|
+
)
|
44
|
+
],
|
45
|
+
rate_card_alias: String,
|
46
|
+
rate_card_id: String,
|
47
|
+
recurring_commits: T::Array[T.any(MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit, MetronomeSDK::Internal::AnyHash)],
|
48
|
+
recurring_credits: T::Array[T.any(MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit, MetronomeSDK::Internal::AnyHash)],
|
49
|
+
reseller_royalties: T::Array[T.any(MetronomeSDK::Models::V1::ContractCreateParams::ResellerRoyalty, MetronomeSDK::Internal::AnyHash)],
|
50
|
+
salesforce_opportunity_id: String,
|
51
|
+
scheduled_charges: T::Array[T.any(MetronomeSDK::Models::V1::ContractCreateParams::ScheduledCharge, MetronomeSDK::Internal::AnyHash)],
|
52
|
+
scheduled_charges_on_usage_invoices: MetronomeSDK::Models::V1::ContractCreateParams::ScheduledChargesOnUsageInvoices::OrSymbol,
|
53
|
+
spend_threshold_configuration: T.any(
|
54
|
+
MetronomeSDK::Models::V1::ContractCreateParams::SpendThresholdConfiguration,
|
55
|
+
MetronomeSDK::Internal::AnyHash
|
56
|
+
),
|
57
|
+
total_contract_value: Float,
|
58
|
+
transition: T.any(MetronomeSDK::Models::V1::ContractCreateParams::Transition, MetronomeSDK::Internal::AnyHash),
|
59
|
+
uniqueness_key: String,
|
60
|
+
usage_filter: T.any(MetronomeSDK::Models::BaseUsageFilter, MetronomeSDK::Internal::AnyHash),
|
61
|
+
usage_statement_schedule: T.any(
|
62
|
+
MetronomeSDK::Models::V1::ContractCreateParams::UsageStatementSchedule,
|
63
|
+
MetronomeSDK::Internal::AnyHash
|
64
|
+
),
|
65
|
+
request_options: MetronomeSDK::RequestOpts
|
66
|
+
)
|
67
|
+
.returns(MetronomeSDK::Models::V1::ContractCreateResponse)
|
68
|
+
end
|
69
|
+
def create(
|
70
|
+
customer_id:,
|
71
|
+
# inclusive contract start time
|
72
|
+
starting_at:,
|
73
|
+
# The billing provider configuration associated with a contract.
|
74
|
+
billing_provider_configuration: nil,
|
75
|
+
commits: nil,
|
76
|
+
credit_balance_threshold_configuration: nil,
|
77
|
+
credits: nil,
|
78
|
+
custom_fields: nil,
|
79
|
+
# This field's availability is dependent on your client's configuration.
|
80
|
+
discounts: nil,
|
81
|
+
# exclusive contract end time
|
82
|
+
ending_before: nil,
|
83
|
+
# Defaults to LOWEST_MULTIPLIER, which applies the greatest discount to list
|
84
|
+
# prices automatically. EXPLICIT prioritization requires specifying priorities for
|
85
|
+
# each multiplier; the one with the lowest priority value will be prioritized
|
86
|
+
# first. If tiered overrides are used, prioritization must be explicit.
|
87
|
+
multiplier_override_prioritization: nil,
|
88
|
+
name: nil,
|
89
|
+
net_payment_terms_days: nil,
|
90
|
+
# This field's availability is dependent on your client's configuration.
|
91
|
+
netsuite_sales_order_id: nil,
|
92
|
+
overrides: nil,
|
93
|
+
# This field's availability is dependent on your client's configuration.
|
94
|
+
professional_services: nil,
|
95
|
+
# Selects the rate card linked to the specified alias as of the contract's start
|
96
|
+
# date.
|
97
|
+
rate_card_alias: nil,
|
98
|
+
rate_card_id: nil,
|
99
|
+
recurring_commits: nil,
|
100
|
+
recurring_credits: nil,
|
101
|
+
# This field's availability is dependent on your client's configuration.
|
102
|
+
reseller_royalties: nil,
|
103
|
+
# This field's availability is dependent on your client's configuration.
|
104
|
+
salesforce_opportunity_id: nil,
|
105
|
+
scheduled_charges: nil,
|
106
|
+
# Determines which scheduled and commit charges to consolidate onto the Contract's
|
107
|
+
# usage invoice. The charge's `timestamp` must match the usage invoice's
|
108
|
+
# `ending_before` date for consolidation to occur. This field cannot be modified
|
109
|
+
# after a Contract has been created. If this field is omitted, charges will appear
|
110
|
+
# on a separate invoice from usage charges.
|
111
|
+
scheduled_charges_on_usage_invoices: nil,
|
112
|
+
spend_threshold_configuration: nil,
|
113
|
+
# This field's availability is dependent on your client's configuration.
|
114
|
+
total_contract_value: nil,
|
115
|
+
transition: nil,
|
116
|
+
# Prevents the creation of duplicates. If a request to create a record is made
|
117
|
+
# with a previously used uniqueness key, a new record will not be created and the
|
118
|
+
# request will fail with a 409 error.
|
119
|
+
uniqueness_key: nil,
|
120
|
+
usage_filter: nil,
|
121
|
+
usage_statement_schedule: nil,
|
122
|
+
request_options: {}
|
123
|
+
); end
|
124
|
+
# This is the v1 endpoint to get a contract. New clients should implement using
|
125
|
+
# the v2 endpoint.
|
126
|
+
sig do
|
127
|
+
params(
|
128
|
+
contract_id: String,
|
129
|
+
customer_id: String,
|
130
|
+
include_balance: T::Boolean,
|
131
|
+
include_ledgers: T::Boolean,
|
132
|
+
request_options: MetronomeSDK::RequestOpts
|
133
|
+
)
|
134
|
+
.returns(MetronomeSDK::Models::V1::ContractRetrieveResponse)
|
135
|
+
end
|
136
|
+
def retrieve(
|
137
|
+
contract_id:,
|
138
|
+
customer_id:,
|
139
|
+
# Include the balance of credits and commits in the response. Setting this flag
|
140
|
+
# may cause the query to be slower.
|
141
|
+
include_balance: nil,
|
142
|
+
# Include commit ledgers in the response. Setting this flag may cause the query to
|
143
|
+
# be slower.
|
144
|
+
include_ledgers: nil,
|
145
|
+
request_options: {}
|
146
|
+
); end
|
147
|
+
# This is the v1 endpoint to list all contracts for a customer. New clients should
|
148
|
+
# implement using the v2 endpoint.
|
149
|
+
sig do
|
150
|
+
params(
|
151
|
+
customer_id: String,
|
152
|
+
covering_date: Time,
|
153
|
+
include_archived: T::Boolean,
|
154
|
+
include_balance: T::Boolean,
|
155
|
+
include_ledgers: T::Boolean,
|
156
|
+
starting_at: Time,
|
157
|
+
request_options: MetronomeSDK::RequestOpts
|
158
|
+
)
|
159
|
+
.returns(MetronomeSDK::Models::V1::ContractListResponse)
|
160
|
+
end
|
161
|
+
def list(
|
162
|
+
customer_id:,
|
163
|
+
# Optional RFC 3339 timestamp. If provided, the response will include only
|
164
|
+
# contracts effective on the provided date. This cannot be provided if the
|
165
|
+
# starting_at filter is provided.
|
166
|
+
covering_date: nil,
|
167
|
+
# Include archived contracts in the response
|
168
|
+
include_archived: nil,
|
169
|
+
# Include the balance of credits and commits in the response. Setting this flag
|
170
|
+
# may cause the query to be slower.
|
171
|
+
include_balance: nil,
|
172
|
+
# Include commit ledgers in the response. Setting this flag may cause the query to
|
173
|
+
# be slower.
|
174
|
+
include_ledgers: nil,
|
175
|
+
# Optional RFC 3339 timestamp. If provided, the response will include only
|
176
|
+
# contracts where effective_at is on or after the provided date. This cannot be
|
177
|
+
# provided if the covering_date filter is provided.
|
178
|
+
starting_at: nil,
|
179
|
+
request_options: {}
|
180
|
+
); end
|
181
|
+
# Add a manual balance entry
|
182
|
+
sig do
|
183
|
+
params(
|
184
|
+
id: String,
|
185
|
+
amount: Float,
|
186
|
+
customer_id: String,
|
187
|
+
reason: String,
|
188
|
+
segment_id: String,
|
189
|
+
contract_id: String,
|
190
|
+
timestamp: Time,
|
191
|
+
request_options: MetronomeSDK::RequestOpts
|
192
|
+
)
|
193
|
+
.void
|
194
|
+
end
|
195
|
+
def add_manual_balance_entry(
|
196
|
+
# ID of the balance (commit or credit) to update.
|
197
|
+
id:,
|
198
|
+
# Amount to add to the segment. A negative number will draw down from the balance.
|
199
|
+
amount:,
|
200
|
+
# ID of the customer whose balance is to be updated.
|
201
|
+
customer_id:,
|
202
|
+
# Reason for the manual adjustment. This will be displayed in the ledger.
|
203
|
+
reason:,
|
204
|
+
# ID of the segment to update.
|
205
|
+
segment_id:,
|
206
|
+
# ID of the contract to update. Leave blank to update a customer level balance.
|
207
|
+
contract_id: nil,
|
208
|
+
# RFC 3339 timestamp indicating when the manual adjustment takes place. If not
|
209
|
+
# provided, it will default to the start of the segment.
|
210
|
+
timestamp: nil,
|
211
|
+
request_options: {}
|
212
|
+
); end
|
213
|
+
# Amendments will be replaced by Contract editing. New clients should implement
|
214
|
+
# using the editContract endpoint. Read more about the migration to contract
|
215
|
+
# editing [here](https://docs.metronome.com/migrate-amendments-to-edits/) and
|
216
|
+
# reach out to your Metronome representative for more details. Once contract
|
217
|
+
# editing is enabled, access to this endpoint will be removed.
|
218
|
+
sig do
|
219
|
+
params(
|
220
|
+
contract_id: String,
|
221
|
+
customer_id: String,
|
222
|
+
starting_at: Time,
|
223
|
+
commits: T::Array[T.any(MetronomeSDK::Models::V1::ContractAmendParams::Commit, MetronomeSDK::Internal::AnyHash)],
|
224
|
+
credits: T::Array[T.any(MetronomeSDK::Models::V1::ContractAmendParams::Credit, MetronomeSDK::Internal::AnyHash)],
|
225
|
+
custom_fields: T::Hash[Symbol, String],
|
226
|
+
discounts: T::Array[T.any(MetronomeSDK::Models::V1::ContractAmendParams::Discount, MetronomeSDK::Internal::AnyHash)],
|
227
|
+
netsuite_sales_order_id: String,
|
228
|
+
overrides: T::Array[T.any(MetronomeSDK::Models::V1::ContractAmendParams::Override, MetronomeSDK::Internal::AnyHash)],
|
229
|
+
professional_services: T::Array[T.any(MetronomeSDK::Models::V1::ContractAmendParams::ProfessionalService, MetronomeSDK::Internal::AnyHash)],
|
230
|
+
reseller_royalties: T::Array[T.any(MetronomeSDK::Models::V1::ContractAmendParams::ResellerRoyalty, MetronomeSDK::Internal::AnyHash)],
|
231
|
+
salesforce_opportunity_id: String,
|
232
|
+
scheduled_charges: T::Array[T.any(MetronomeSDK::Models::V1::ContractAmendParams::ScheduledCharge, MetronomeSDK::Internal::AnyHash)],
|
233
|
+
total_contract_value: Float,
|
234
|
+
request_options: MetronomeSDK::RequestOpts
|
235
|
+
)
|
236
|
+
.returns(MetronomeSDK::Models::V1::ContractAmendResponse)
|
237
|
+
end
|
238
|
+
def amend(
|
239
|
+
# ID of the contract to amend
|
240
|
+
contract_id:,
|
241
|
+
# ID of the customer whose contract is to be amended
|
242
|
+
customer_id:,
|
243
|
+
# inclusive start time for the amendment
|
244
|
+
starting_at:,
|
245
|
+
commits: nil,
|
246
|
+
credits: nil,
|
247
|
+
custom_fields: nil,
|
248
|
+
# This field's availability is dependent on your client's configuration.
|
249
|
+
discounts: nil,
|
250
|
+
# This field's availability is dependent on your client's configuration.
|
251
|
+
netsuite_sales_order_id: nil,
|
252
|
+
overrides: nil,
|
253
|
+
# This field's availability is dependent on your client's configuration.
|
254
|
+
professional_services: nil,
|
255
|
+
# This field's availability is dependent on your client's configuration.
|
256
|
+
reseller_royalties: nil,
|
257
|
+
# This field's availability is dependent on your client's configuration.
|
258
|
+
salesforce_opportunity_id: nil,
|
259
|
+
scheduled_charges: nil,
|
260
|
+
# This field's availability is dependent on your client's configuration.
|
261
|
+
total_contract_value: nil,
|
262
|
+
request_options: {}
|
263
|
+
); end
|
264
|
+
# Archive a contract
|
265
|
+
sig do
|
266
|
+
params(
|
267
|
+
contract_id: String,
|
268
|
+
customer_id: String,
|
269
|
+
void_invoices: T::Boolean,
|
270
|
+
request_options: MetronomeSDK::RequestOpts
|
271
|
+
)
|
272
|
+
.returns(MetronomeSDK::Models::V1::ContractArchiveResponse)
|
273
|
+
end
|
274
|
+
def archive(
|
275
|
+
# ID of the contract to archive
|
276
|
+
contract_id:,
|
277
|
+
# ID of the customer whose contract is to be archived
|
278
|
+
customer_id:,
|
279
|
+
# If false, the existing finalized invoices will remain after the contract is
|
280
|
+
# archived.
|
281
|
+
void_invoices:,
|
282
|
+
request_options: {}
|
283
|
+
); end
|
284
|
+
# Creates historical usage invoices for a contract
|
285
|
+
sig do
|
286
|
+
params(
|
287
|
+
invoices: T::Array[
|
288
|
+
T.any(
|
289
|
+
MetronomeSDK::Models::V1::ContractCreateHistoricalInvoicesParams::Invoice,
|
290
|
+
MetronomeSDK::Internal::AnyHash
|
291
|
+
)
|
292
|
+
],
|
293
|
+
preview: T::Boolean,
|
294
|
+
request_options: MetronomeSDK::RequestOpts
|
295
|
+
)
|
296
|
+
.returns(MetronomeSDK::Models::V1::ContractCreateHistoricalInvoicesResponse)
|
297
|
+
end
|
298
|
+
def create_historical_invoices(invoices:, preview:, request_options: {}); end
|
299
|
+
|
300
|
+
# List balances (commits and credits).
|
301
|
+
sig do
|
302
|
+
params(
|
303
|
+
customer_id: String,
|
304
|
+
id: String,
|
305
|
+
covering_date: Time,
|
306
|
+
effective_before: Time,
|
307
|
+
include_archived: T::Boolean,
|
308
|
+
include_balance: T::Boolean,
|
309
|
+
include_contract_balances: T::Boolean,
|
310
|
+
include_ledgers: T::Boolean,
|
311
|
+
next_page: String,
|
312
|
+
starting_at: Time,
|
313
|
+
request_options: MetronomeSDK::RequestOpts
|
314
|
+
)
|
315
|
+
.returns(MetronomeSDK::Models::V1::ContractListBalancesResponse)
|
316
|
+
end
|
317
|
+
def list_balances(
|
318
|
+
customer_id:,
|
319
|
+
id: nil,
|
320
|
+
# Return only balances that have access schedules that "cover" the provided date
|
321
|
+
covering_date: nil,
|
322
|
+
# Include only balances that have any access before the provided date (exclusive)
|
323
|
+
effective_before: nil,
|
324
|
+
# Include archived credits and credits from archived contracts.
|
325
|
+
include_archived: nil,
|
326
|
+
# Include the balance of credits and commits in the response. Setting this flag
|
327
|
+
# may cause the query to be slower.
|
328
|
+
include_balance: nil,
|
329
|
+
# Include balances on the contract level.
|
330
|
+
include_contract_balances: nil,
|
331
|
+
# Include ledgers in the response. Setting this flag may cause the query to be
|
332
|
+
# slower.
|
333
|
+
include_ledgers: nil,
|
334
|
+
# The next page token from a previous response.
|
335
|
+
next_page: nil,
|
336
|
+
# Include only balances that have any access on or after the provided date
|
337
|
+
starting_at: nil,
|
338
|
+
request_options: {}
|
339
|
+
); end
|
340
|
+
# Get the rate schedule for the rate card on a given contract.
|
341
|
+
sig do
|
342
|
+
params(
|
343
|
+
contract_id: String,
|
344
|
+
customer_id: String,
|
345
|
+
limit: Integer,
|
346
|
+
next_page: String,
|
347
|
+
at: Time,
|
348
|
+
selectors: T::Array[
|
349
|
+
T.any(
|
350
|
+
MetronomeSDK::Models::V1::ContractRetrieveRateScheduleParams::Selector,
|
351
|
+
MetronomeSDK::Internal::AnyHash
|
352
|
+
)
|
353
|
+
],
|
354
|
+
request_options: MetronomeSDK::RequestOpts
|
355
|
+
)
|
356
|
+
.returns(MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse)
|
357
|
+
end
|
358
|
+
def retrieve_rate_schedule(
|
359
|
+
# Body param: ID of the contract to get the rate schedule for.
|
360
|
+
contract_id:,
|
361
|
+
# Body param: ID of the customer for whose contract to get the rate schedule for.
|
362
|
+
customer_id:,
|
363
|
+
# Query param: Max number of results that should be returned
|
364
|
+
limit: nil,
|
365
|
+
# Query param: Cursor that indicates where the next page of results should start.
|
366
|
+
next_page: nil,
|
367
|
+
# Body param: optional timestamp which overlaps with the returned rate schedule
|
368
|
+
# segments. When not specified, the current timestamp will be used.
|
369
|
+
at: nil,
|
370
|
+
# Body param: List of rate selectors, rates matching ANY of the selectors will be
|
371
|
+
# included in the response. Passing no selectors will result in all rates being
|
372
|
+
# returned.
|
373
|
+
selectors: nil,
|
374
|
+
request_options: {}
|
375
|
+
); end
|
376
|
+
# Create a new scheduled invoice for Professional Services terms on a contract.
|
377
|
+
# This endpoint's availability is dependent on your client's configuration.
|
378
|
+
sig do
|
379
|
+
params(
|
380
|
+
contract_id: String,
|
381
|
+
customer_id: String,
|
382
|
+
issued_at: Time,
|
383
|
+
line_items: T::Array[
|
384
|
+
T.any(
|
385
|
+
MetronomeSDK::Models::V1::ContractScheduleProServicesInvoiceParams::LineItem,
|
386
|
+
MetronomeSDK::Internal::AnyHash
|
387
|
+
)
|
388
|
+
],
|
389
|
+
netsuite_invoice_header_end: Time,
|
390
|
+
netsuite_invoice_header_start: Time,
|
391
|
+
request_options: MetronomeSDK::RequestOpts
|
392
|
+
)
|
393
|
+
.returns(MetronomeSDK::Models::V1::ContractScheduleProServicesInvoiceResponse)
|
394
|
+
end
|
395
|
+
def schedule_pro_services_invoice(
|
396
|
+
contract_id:,
|
397
|
+
customer_id:,
|
398
|
+
# The date the invoice is issued
|
399
|
+
issued_at:,
|
400
|
+
# Each line requires an amount or both unit_price and quantity.
|
401
|
+
line_items:,
|
402
|
+
# The end date of the invoice header in Netsuite
|
403
|
+
netsuite_invoice_header_end: nil,
|
404
|
+
# The start date of the invoice header in Netsuite
|
405
|
+
netsuite_invoice_header_start: nil,
|
406
|
+
request_options: {}
|
407
|
+
); end
|
408
|
+
# Set usage filter for a contract
|
409
|
+
sig do
|
410
|
+
params(
|
411
|
+
contract_id: String,
|
412
|
+
customer_id: String,
|
413
|
+
group_key: String,
|
414
|
+
group_values: T::Array[String],
|
415
|
+
starting_at: Time,
|
416
|
+
request_options: MetronomeSDK::RequestOpts
|
417
|
+
)
|
418
|
+
.void
|
419
|
+
end
|
420
|
+
def set_usage_filter(
|
421
|
+
contract_id:,
|
422
|
+
customer_id:,
|
423
|
+
group_key:,
|
424
|
+
group_values:,
|
425
|
+
starting_at:,
|
426
|
+
request_options: {}
|
427
|
+
)
|
428
|
+
end
|
429
|
+
|
430
|
+
# Update the end date of a contract
|
431
|
+
sig do
|
432
|
+
params(
|
433
|
+
contract_id: String,
|
434
|
+
customer_id: String,
|
435
|
+
allow_ending_before_finalized_invoice: T::Boolean,
|
436
|
+
ending_before: Time,
|
437
|
+
request_options: MetronomeSDK::RequestOpts
|
438
|
+
)
|
439
|
+
.returns(MetronomeSDK::Models::V1::ContractUpdateEndDateResponse)
|
440
|
+
end
|
441
|
+
def update_end_date(
|
442
|
+
# ID of the contract to update
|
443
|
+
contract_id:,
|
444
|
+
# ID of the customer whose contract is to be updated
|
445
|
+
customer_id:,
|
446
|
+
# If true, allows setting the contract end date earlier than the end_timestamp of
|
447
|
+
# existing finalized invoices. Finalized invoices will be unchanged; if you want
|
448
|
+
# to incorporate the new end date, you can void and regenerate finalized usage
|
449
|
+
# invoices. Defaults to true.
|
450
|
+
allow_ending_before_finalized_invoice: nil,
|
451
|
+
# RFC 3339 timestamp indicating when the contract will end (exclusive). If not
|
452
|
+
# provided, the contract will be updated to be open-ended.
|
453
|
+
ending_before: nil,
|
454
|
+
request_options: {}
|
455
|
+
); end
|
456
|
+
# @api private
|
457
|
+
sig { params(client: MetronomeSDK::Client).returns(T.attached_class) }
|
458
|
+
def self.new(client:); end
|
459
|
+
end
|
460
|
+
end
|
461
|
+
end
|
462
|
+
end
|
@@ -0,0 +1,181 @@
|
|
1
|
+
# typed: strong
|
2
|
+
|
3
|
+
module MetronomeSDK
|
4
|
+
module Resources
|
5
|
+
class V1
|
6
|
+
class CreditGrants
|
7
|
+
# Create a new credit grant
|
8
|
+
sig do
|
9
|
+
params(
|
10
|
+
customer_id: String,
|
11
|
+
expires_at: Time,
|
12
|
+
grant_amount: T.any(MetronomeSDK::Models::V1::CreditGrantCreateParams::GrantAmount, MetronomeSDK::Internal::AnyHash),
|
13
|
+
name: String,
|
14
|
+
paid_amount: T.any(MetronomeSDK::Models::V1::CreditGrantCreateParams::PaidAmount, MetronomeSDK::Internal::AnyHash),
|
15
|
+
priority: Float,
|
16
|
+
credit_grant_type: String,
|
17
|
+
custom_fields: T::Hash[Symbol, String],
|
18
|
+
effective_at: Time,
|
19
|
+
invoice_date: Time,
|
20
|
+
product_ids: T::Array[String],
|
21
|
+
reason: String,
|
22
|
+
rollover_settings: T.any(
|
23
|
+
MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings,
|
24
|
+
MetronomeSDK::Internal::AnyHash
|
25
|
+
),
|
26
|
+
uniqueness_key: String,
|
27
|
+
request_options: MetronomeSDK::RequestOpts
|
28
|
+
)
|
29
|
+
.returns(MetronomeSDK::Models::V1::CreditGrantCreateResponse)
|
30
|
+
end
|
31
|
+
def create(
|
32
|
+
# the Metronome ID of the customer
|
33
|
+
customer_id:,
|
34
|
+
# The credit grant will only apply to usage or charges dated before this timestamp
|
35
|
+
expires_at:,
|
36
|
+
# the amount of credits granted
|
37
|
+
grant_amount:,
|
38
|
+
# the name of the credit grant as it will appear on invoices
|
39
|
+
name:,
|
40
|
+
# the amount paid for this credit grant
|
41
|
+
paid_amount:,
|
42
|
+
priority:,
|
43
|
+
credit_grant_type: nil,
|
44
|
+
# Custom fields to attach to the credit grant.
|
45
|
+
custom_fields: nil,
|
46
|
+
# The credit grant will only apply to usage or charges dated on or after this
|
47
|
+
# timestamp
|
48
|
+
effective_at: nil,
|
49
|
+
# The date to issue an invoice for the paid_amount.
|
50
|
+
invoice_date: nil,
|
51
|
+
# The product(s) which these credits will be applied to. (If unspecified, the
|
52
|
+
# credits will be applied to charges for all products.). The array ordering
|
53
|
+
# specified here will be used to determine the order in which credits will be
|
54
|
+
# applied to invoice line items
|
55
|
+
product_ids: nil,
|
56
|
+
reason: nil,
|
57
|
+
# Configure a rollover for this credit grant so if it expires it rolls over a
|
58
|
+
# configured amount to a new credit grant. This feature is currently opt-in only.
|
59
|
+
# Contact Metronome to be added to the beta.
|
60
|
+
rollover_settings: nil,
|
61
|
+
# Prevents the creation of duplicates. If a request to create a record is made
|
62
|
+
# with a previously used uniqueness key, a new record will not be created and the
|
63
|
+
# request will fail with a 409 error.
|
64
|
+
uniqueness_key: nil,
|
65
|
+
request_options: {}
|
66
|
+
); end
|
67
|
+
# List credit grants. This list does not included voided grants.
|
68
|
+
sig do
|
69
|
+
params(
|
70
|
+
limit: Integer,
|
71
|
+
next_page: String,
|
72
|
+
credit_grant_ids: T::Array[String],
|
73
|
+
credit_type_ids: T::Array[String],
|
74
|
+
customer_ids: T::Array[String],
|
75
|
+
effective_before: Time,
|
76
|
+
not_expiring_before: Time,
|
77
|
+
request_options: MetronomeSDK::RequestOpts
|
78
|
+
)
|
79
|
+
.returns(MetronomeSDK::Internal::CursorPage[MetronomeSDK::Models::V1::CreditGrantListResponse])
|
80
|
+
end
|
81
|
+
def list(
|
82
|
+
# Query param: Max number of results that should be returned
|
83
|
+
limit: nil,
|
84
|
+
# Query param: Cursor that indicates where the next page of results should start.
|
85
|
+
next_page: nil,
|
86
|
+
# Body param: An array of credit grant IDs. If this is specified, neither
|
87
|
+
# credit_type_ids nor customer_ids may be specified.
|
88
|
+
credit_grant_ids: nil,
|
89
|
+
# Body param: An array of credit type IDs. This must not be specified if
|
90
|
+
# credit_grant_ids is specified.
|
91
|
+
credit_type_ids: nil,
|
92
|
+
# Body param: An array of Metronome customer IDs. This must not be specified if
|
93
|
+
# credit_grant_ids is specified.
|
94
|
+
customer_ids: nil,
|
95
|
+
# Body param: Only return credit grants that are effective before this timestamp
|
96
|
+
# (exclusive).
|
97
|
+
effective_before: nil,
|
98
|
+
# Body param: Only return credit grants that expire at or after this timestamp.
|
99
|
+
not_expiring_before: nil,
|
100
|
+
request_options: {}
|
101
|
+
); end
|
102
|
+
# Edit an existing credit grant
|
103
|
+
sig do
|
104
|
+
params(
|
105
|
+
id: String,
|
106
|
+
credit_grant_type: String,
|
107
|
+
expires_at: Time,
|
108
|
+
name: String,
|
109
|
+
request_options: MetronomeSDK::RequestOpts
|
110
|
+
)
|
111
|
+
.returns(MetronomeSDK::Models::V1::CreditGrantEditResponse)
|
112
|
+
end
|
113
|
+
def edit(
|
114
|
+
# the ID of the credit grant
|
115
|
+
id:,
|
116
|
+
# the updated credit grant type
|
117
|
+
credit_grant_type: nil,
|
118
|
+
# the updated expiration date for the credit grant
|
119
|
+
expires_at: nil,
|
120
|
+
# the updated name for the credit grant
|
121
|
+
name: nil,
|
122
|
+
request_options: {}
|
123
|
+
); end
|
124
|
+
# Fetches a list of credit ledger entries. Returns lists of ledgers per customer.
|
125
|
+
# Ledger entries are returned in chronological order. Ledger entries associated
|
126
|
+
# with voided credit grants are not included.
|
127
|
+
sig do
|
128
|
+
params(
|
129
|
+
next_page: String,
|
130
|
+
credit_type_ids: T::Array[String],
|
131
|
+
customer_ids: T::Array[String],
|
132
|
+
ending_before: Time,
|
133
|
+
starting_on: Time,
|
134
|
+
request_options: MetronomeSDK::RequestOpts
|
135
|
+
)
|
136
|
+
.returns(MetronomeSDK::Models::V1::CreditGrantListEntriesResponse)
|
137
|
+
end
|
138
|
+
def list_entries(
|
139
|
+
# Query param: Cursor that indicates where the next page of results should start.
|
140
|
+
next_page: nil,
|
141
|
+
# Body param: A list of Metronome credit type IDs to fetch ledger entries for. If
|
142
|
+
# absent, ledger entries for all credit types will be returned.
|
143
|
+
credit_type_ids: nil,
|
144
|
+
# Body param: A list of Metronome customer IDs to fetch ledger entries for. If
|
145
|
+
# absent, ledger entries for all customers will be returned.
|
146
|
+
customer_ids: nil,
|
147
|
+
# Body param: If supplied, ledger entries will only be returned with an
|
148
|
+
# effective_at before this time. This timestamp must not be in the future. If no
|
149
|
+
# timestamp is supplied, all entries up to the start of the customer's next
|
150
|
+
# billing period will be returned.
|
151
|
+
ending_before: nil,
|
152
|
+
# Body param: If supplied, only ledger entries effective at or after this time
|
153
|
+
# will be returned.
|
154
|
+
starting_on: nil,
|
155
|
+
request_options: {}
|
156
|
+
); end
|
157
|
+
# Void a credit grant
|
158
|
+
sig do
|
159
|
+
params(
|
160
|
+
id: String,
|
161
|
+
release_uniqueness_key: T::Boolean,
|
162
|
+
void_credit_purchase_invoice: T::Boolean,
|
163
|
+
request_options: MetronomeSDK::RequestOpts
|
164
|
+
)
|
165
|
+
.returns(MetronomeSDK::Models::V1::CreditGrantVoidResponse)
|
166
|
+
end
|
167
|
+
def void(
|
168
|
+
id:,
|
169
|
+
# If true, resets the uniqueness key on this grant so it can be re-used
|
170
|
+
release_uniqueness_key: nil,
|
171
|
+
# If true, void the purchase invoice associated with the grant
|
172
|
+
void_credit_purchase_invoice: nil,
|
173
|
+
request_options: {}
|
174
|
+
); end
|
175
|
+
# @api private
|
176
|
+
sig { params(client: MetronomeSDK::Client).returns(T.attached_class) }
|
177
|
+
def self.new(client:); end
|
178
|
+
end
|
179
|
+
end
|
180
|
+
end
|
181
|
+
end
|