metronome-sdk 0.1.0.pre.alpha.3 → 0.1.0.pre.alpha.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +40 -0
- data/README.md +1 -1
- data/lib/metronome_sdk/errors.rb +22 -0
- data/lib/metronome_sdk/internal/transport/base_client.rb +10 -2
- data/lib/metronome_sdk/internal/type/array_of.rb +6 -1
- data/lib/metronome_sdk/internal/type/base_model.rb +82 -26
- data/lib/metronome_sdk/internal/type/boolean.rb +7 -1
- data/lib/metronome_sdk/internal/type/converter.rb +42 -34
- data/lib/metronome_sdk/internal/type/enum.rb +16 -5
- data/lib/metronome_sdk/internal/type/file_input.rb +6 -1
- data/lib/metronome_sdk/internal/type/hash_of.rb +6 -1
- data/lib/metronome_sdk/internal/type/union.rb +17 -9
- data/lib/metronome_sdk/internal/type/unknown.rb +7 -1
- data/lib/metronome_sdk/internal/util.rb +8 -9
- data/lib/metronome_sdk/models/base_usage_filter.rb +27 -0
- data/lib/metronome_sdk/models/commit.rb +1010 -0
- data/lib/metronome_sdk/models/contract_without_amendments.rb +1803 -0
- data/lib/metronome_sdk/models/credit.rb +634 -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 +33 -0
- data/lib/metronome_sdk/models/id.rb +15 -0
- data/lib/metronome_sdk/models/override.rb +381 -0
- data/lib/metronome_sdk/models/pro_service.rb +73 -0
- data/lib/metronome_sdk/models/property_filter.rb +52 -0
- data/lib/metronome_sdk/models/rate.rb +101 -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_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/alert_create_params.rb +4 -1
- data/lib/metronome_sdk/models/v1/alert_create_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/billable_metric_archive_params.rb +2 -8
- data/lib/metronome_sdk/models/v1/billable_metric_archive_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/billable_metric_create_params.rb +6 -86
- data/lib/metronome_sdk/models/v1/billable_metric_create_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/billable_metric_list_response.rb +6 -85
- data/lib/metronome_sdk/models/v1/billable_metric_retrieve_response.rb +8 -85
- data/lib/metronome_sdk/models/v1/contract_amend_params.rb +312 -35
- data/lib/metronome_sdk/models/v1/contract_amend_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contract_archive_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contract_create_historical_invoices_response.rb +3 -1276
- data/lib/metronome_sdk/models/v1/contract_create_params.rb +550 -102
- data/lib/metronome_sdk/models/v1/contract_create_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contract_list_balances_response.rb +5 -1645
- data/lib/metronome_sdk/models/v1/contract_list_response.rb +253 -10692
- data/lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rb +9 -295
- data/lib/metronome_sdk/models/v1/contract_retrieve_response.rb +254 -10721
- data/lib/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_response.rb +3 -1276
- data/lib/metronome_sdk/models/v1/contract_update_end_date_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contracts/product_archive_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contracts/product_create_params.rb +6 -97
- data/lib/metronome_sdk/models/v1/contracts/product_create_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contracts/product_list_item_state.rb +148 -0
- data/lib/metronome_sdk/models/v1/contracts/product_list_response.rb +12 -561
- data/lib/metronome_sdk/models/v1/contracts/product_retrieve_params.rb +2 -8
- data/lib/metronome_sdk/models/v1/contracts/product_retrieve_response.rb +14 -559
- data/lib/metronome_sdk/models/v1/contracts/product_update_params.rb +6 -97
- data/lib/metronome_sdk/models/v1/contracts/product_update_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contracts/quantity_conversion.rb +57 -0
- data/lib/metronome_sdk/models/v1/contracts/quantity_rounding.rb +45 -0
- data/lib/metronome_sdk/models/v1/contracts/rate_card_archive_params.rb +2 -8
- data/lib/metronome_sdk/models/v1/contracts/rate_card_archive_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contracts/rate_card_create_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contracts/rate_card_list_response.rb +6 -42
- data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_params.rb +2 -8
- data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rb +6 -159
- data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rb +6 -42
- data/lib/metronome_sdk/models/v1/contracts/rate_card_update_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rb +6 -44
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_response.rb +3 -16
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb +6 -44
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rb +9 -61
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rb +6 -158
- data/lib/metronome_sdk/models/v1/credit_grant_create_params.rb +5 -77
- data/lib/metronome_sdk/models/v1/credit_grant_create_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/credit_grant_edit_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/credit_grant_list_entries_params.rb +20 -1
- data/lib/metronome_sdk/models/v1/credit_grant_list_entries_response.rb +11 -153
- data/lib/metronome_sdk/models/v1/credit_grant_list_response.rb +14 -175
- data/lib/metronome_sdk/models/v1/credit_grant_void_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/credit_ledger_entry.rb +69 -0
- data/lib/metronome_sdk/models/v1/customer.rb +53 -0
- data/lib/metronome_sdk/models/v1/customer_archive_params.rb +2 -8
- data/lib/metronome_sdk/models/v1/customer_archive_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/customer_create_response.rb +3 -50
- data/lib/metronome_sdk/models/v1/{customer_list_response.rb → customer_detail.rb} +14 -15
- data/lib/metronome_sdk/models/v1/customer_list_billable_metrics_response.rb +6 -86
- data/lib/metronome_sdk/models/v1/customer_preview_events_params.rb +115 -0
- data/lib/metronome_sdk/models/v1/customer_preview_events_response.rb +18 -0
- data/lib/metronome_sdk/models/v1/customer_retrieve_response.rb +3 -126
- data/lib/metronome_sdk/models/v1/customer_set_name_response.rb +3 -50
- data/lib/metronome_sdk/models/v1/customers/alert_list_response.rb +5 -276
- data/lib/metronome_sdk/models/v1/customers/alert_retrieve_response.rb +3 -279
- data/lib/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rb +9 -1
- data/lib/metronome_sdk/models/v1/customers/commit_create_params.rb +8 -6
- data/lib/metronome_sdk/models/v1/customers/commit_create_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/customers/commit_list_response.rb +3 -1047
- data/lib/metronome_sdk/models/v1/customers/commit_update_end_date_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/customers/credit_create_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/customers/credit_list_response.rb +3 -593
- data/lib/metronome_sdk/models/v1/customers/credit_update_end_date_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/customers/customer_alert.rb +270 -0
- data/lib/metronome_sdk/models/v1/customers/{invoice_list_response.rb → invoice.rb} +119 -303
- data/lib/metronome_sdk/models/v1/customers/invoice_list_breakdowns_response.rb +2 -1271
- data/lib/metronome_sdk/models/v1/customers/invoice_retrieve_response.rb +3 -1276
- data/lib/metronome_sdk/models/v1/customers/plan_add_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/customers/plan_list_response.rb +3 -21
- data/lib/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rb +1 -0
- data/lib/metronome_sdk/models/v1/plan_detail.rb +200 -0
- data/lib/metronome_sdk/models/v1/plan_get_details_response.rb +3 -286
- data/lib/metronome_sdk/models/v1/plan_list_charges_response.rb +3 -20
- data/lib/metronome_sdk/models/v1/plan_list_customers_response.rb +3 -128
- 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/usage_search_params.rb +24 -0
- data/lib/metronome_sdk/models/v1/usage_search_response.rb +249 -0
- data/lib/metronome_sdk/models/v2/contract_edit_commit_params.rb +11 -8
- data/lib/metronome_sdk/models/v2/contract_edit_commit_response.rb +3 -14
- data/lib/metronome_sdk/models/v2/contract_edit_credit_params.rb +3 -2
- data/lib/metronome_sdk/models/v2/contract_edit_credit_response.rb +3 -14
- data/lib/metronome_sdk/models/v2/contract_edit_params.rb +885 -103
- data/lib/metronome_sdk/models/v2/contract_edit_response.rb +3 -14
- data/lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb +351 -625
- data/lib/metronome_sdk/models/v2/contract_list_response.rb +590 -749
- data/lib/metronome_sdk/models/v2/contract_retrieve_response.rb +590 -751
- data/lib/metronome_sdk/models.rb +36 -4
- data/lib/metronome_sdk/resources/v1/alerts.rb +1 -1
- data/lib/metronome_sdk/resources/v1/billable_metrics.rb +2 -2
- data/lib/metronome_sdk/resources/v1/contracts/products.rb +4 -4
- data/lib/metronome_sdk/resources/v1/contracts/rate_cards/rates.rb +1 -1
- data/lib/metronome_sdk/resources/v1/contracts.rb +8 -4
- data/lib/metronome_sdk/resources/v1/credit_grants.rb +4 -2
- data/lib/metronome_sdk/resources/v1/customers/commits.rb +2 -2
- data/lib/metronome_sdk/resources/v1/customers/invoices.rb +2 -2
- data/lib/metronome_sdk/resources/v1/customers.rb +40 -2
- data/lib/metronome_sdk/resources/v1/usage.rb +25 -0
- data/lib/metronome_sdk/resources/v2/contracts.rb +11 -9
- data/lib/metronome_sdk/version.rb +1 -1
- data/lib/metronome_sdk.rb +31 -2
- data/rbi/metronome_sdk/errors.rbi +16 -0
- data/rbi/metronome_sdk/internal/type/boolean.rbi +2 -0
- data/rbi/metronome_sdk/internal/type/converter.rbi +15 -15
- data/rbi/metronome_sdk/internal/type/union.rbi +5 -0
- data/rbi/metronome_sdk/internal/type/unknown.rbi +2 -0
- data/rbi/metronome_sdk/internal/util.rbi +2 -0
- data/rbi/metronome_sdk/models/base_usage_filter.rbi +46 -0
- data/rbi/metronome_sdk/models/commit.rbi +1962 -0
- data/rbi/metronome_sdk/models/contract_without_amendments.rbi +3676 -0
- data/rbi/metronome_sdk/models/credit.rbi +1230 -0
- data/rbi/metronome_sdk/models/credit_type_data.rbi +26 -0
- data/rbi/metronome_sdk/models/discount.rbi +106 -0
- data/rbi/metronome_sdk/models/event_type_filter.rbi +57 -0
- data/rbi/metronome_sdk/models/id.rbi +23 -0
- data/rbi/metronome_sdk/models/override.rbi +675 -0
- data/rbi/metronome_sdk/models/pro_service.rbi +98 -0
- data/rbi/metronome_sdk/models/property_filter.rbi +88 -0
- data/rbi/metronome_sdk/models/rate.rbi +155 -0
- data/rbi/metronome_sdk/models/schedule_duration.rbi +89 -0
- data/rbi/metronome_sdk/models/schedule_point_in_time.rbi +121 -0
- data/rbi/metronome_sdk/models/scheduled_charge.rbi +119 -0
- data/rbi/metronome_sdk/models/tier.rbi +29 -0
- data/rbi/metronome_sdk/models/v1/alert_archive_response.rbi +4 -37
- data/rbi/metronome_sdk/models/v1/alert_create_params.rbi +6 -0
- data/rbi/metronome_sdk/models/v1/alert_create_response.rbi +4 -37
- data/rbi/metronome_sdk/models/v1/billable_metric_archive_params.rbi +6 -12
- data/rbi/metronome_sdk/models/v1/billable_metric_archive_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/billable_metric_create_params.rbi +8 -177
- data/rbi/metronome_sdk/models/v1/billable_metric_create_response.rbi +4 -43
- data/rbi/metronome_sdk/models/v1/billable_metric_list_response.rbi +8 -177
- data/rbi/metronome_sdk/models/v1/billable_metric_retrieve_response.rbi +8 -175
- data/rbi/metronome_sdk/models/v1/contract_amend_params.rbi +712 -68
- data/rbi/metronome_sdk/models/v1/contract_amend_response.rbi +4 -37
- data/rbi/metronome_sdk/models/v1/contract_archive_response.rbi +4 -39
- data/rbi/metronome_sdk/models/v1/contract_create_historical_invoices_response.rbi +3 -2595
- data/rbi/metronome_sdk/models/v1/contract_create_params.rbi +1100 -172
- data/rbi/metronome_sdk/models/v1/contract_create_response.rbi +4 -37
- data/rbi/metronome_sdk/models/v1/contract_list_balances_response.rbi +3 -3366
- data/rbi/metronome_sdk/models/v1/contract_list_response.rbi +375 -22523
- data/rbi/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rbi +12 -632
- data/rbi/metronome_sdk/models/v1/contract_retrieve_response.rbi +375 -22523
- data/rbi/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_response.rbi +3 -2595
- data/rbi/metronome_sdk/models/v1/contract_update_end_date_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/contracts/product_archive_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/contracts/product_create_params.rbi +8 -209
- data/rbi/metronome_sdk/models/v1/contracts/product_create_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/contracts/product_list_item_state.rbi +237 -0
- data/rbi/metronome_sdk/models/v1/contracts/product_list_response.rbi +76 -1143
- data/rbi/metronome_sdk/models/v1/contracts/product_retrieve_params.rbi +3 -9
- data/rbi/metronome_sdk/models/v1/contracts/product_retrieve_response.rbi +76 -1137
- data/rbi/metronome_sdk/models/v1/contracts/product_update_params.rbi +8 -209
- data/rbi/metronome_sdk/models/v1/contracts/product_update_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/contracts/quantity_conversion.rbi +111 -0
- data/rbi/metronome_sdk/models/v1/contracts/quantity_rounding.rbi +94 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_archive_params.rbi +3 -9
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_archive_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_create_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_list_response.rbi +8 -74
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_params.rbi +3 -9
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rbi +8 -344
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rbi +8 -74
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_update_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rbi +8 -108
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_response.rbi +4 -45
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbi +8 -108
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rbi +12 -149
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rbi +8 -344
- data/rbi/metronome_sdk/models/v1/credit_grant_create_params.rbi +8 -166
- data/rbi/metronome_sdk/models/v1/credit_grant_create_response.rbi +4 -41
- data/rbi/metronome_sdk/models/v1/credit_grant_edit_response.rbi +4 -39
- data/rbi/metronome_sdk/models/v1/credit_grant_list_entries_params.rbi +58 -0
- data/rbi/metronome_sdk/models/v1/credit_grant_list_entries_response.rbi +10 -231
- data/rbi/metronome_sdk/models/v1/credit_grant_list_response.rbi +14 -281
- data/rbi/metronome_sdk/models/v1/credit_grant_void_response.rbi +4 -39
- data/rbi/metronome_sdk/models/v1/credit_ledger_entry.rbi +90 -0
- data/rbi/metronome_sdk/models/v1/customer.rbi +74 -0
- data/rbi/metronome_sdk/models/v1/customer_archive_params.rbi +6 -12
- data/rbi/metronome_sdk/models/v1/customer_archive_response.rbi +4 -39
- data/rbi/metronome_sdk/models/v1/customer_create_response.rbi +6 -84
- data/rbi/metronome_sdk/models/v1/{customer_list_response.rbi → customer_detail.rbi} +19 -26
- data/rbi/metronome_sdk/models/v1/customer_list_billable_metrics_response.rbi +8 -177
- data/rbi/metronome_sdk/models/v1/customer_preview_events_params.rbi +214 -0
- data/rbi/metronome_sdk/models/v1/customer_preview_events_response.rbi +35 -0
- data/rbi/metronome_sdk/models/v1/customer_retrieve_response.rbi +6 -255
- data/rbi/metronome_sdk/models/v1/customer_set_name_response.rbi +6 -86
- data/rbi/metronome_sdk/models/v1/customers/alert_list_response.rbi +3 -623
- data/rbi/metronome_sdk/models/v1/customers/alert_retrieve_response.rbi +4 -622
- data/rbi/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbi +11 -0
- data/rbi/metronome_sdk/models/v1/customers/commit_create_params.rbi +12 -8
- data/rbi/metronome_sdk/models/v1/customers/commit_create_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/customers/commit_list_response.rbi +3 -2164
- data/rbi/metronome_sdk/models/v1/customers/commit_update_end_date_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/customers/credit_create_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/customers/credit_list_response.rbi +3 -1224
- data/rbi/metronome_sdk/models/v1/customers/credit_update_end_date_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/customers/customer_alert.rbi +572 -0
- data/rbi/metronome_sdk/models/v1/customers/{invoice_list_response.rbi → invoice.rbi} +182 -589
- data/rbi/metronome_sdk/models/v1/customers/invoice_list_breakdowns_response.rbi +4 -2561
- data/rbi/metronome_sdk/models/v1/customers/invoice_retrieve_response.rbi +6 -2612
- data/rbi/metronome_sdk/models/v1/customers/plan_add_response.rbi +4 -41
- data/rbi/metronome_sdk/models/v1/customers/plan_list_response.rbi +4 -39
- data/rbi/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rbi +5 -0
- data/rbi/metronome_sdk/models/v1/plan_detail.rbi +349 -0
- data/rbi/metronome_sdk/models/v1/plan_get_details_response.rbi +6 -560
- data/rbi/metronome_sdk/models/v1/plan_list_charges_response.rbi +4 -37
- data/rbi/metronome_sdk/models/v1/plan_list_customers_response.rbi +4 -248
- data/rbi/metronome_sdk/models/v1/rollover_amount_max_amount.rbi +79 -0
- data/rbi/metronome_sdk/models/v1/rollover_amount_max_percentage.rbi +80 -0
- data/rbi/metronome_sdk/models/v1/usage_search_params.rbi +48 -0
- data/rbi/metronome_sdk/models/v1/usage_search_response.rbi +438 -0
- data/rbi/metronome_sdk/models/v2/contract_edit_commit_params.rbi +23 -23
- data/rbi/metronome_sdk/models/v2/contract_edit_commit_response.rbi +4 -41
- data/rbi/metronome_sdk/models/v2/contract_edit_credit_params.rbi +11 -15
- data/rbi/metronome_sdk/models/v2/contract_edit_credit_response.rbi +4 -41
- data/rbi/metronome_sdk/models/v2/contract_edit_params.rbi +1859 -202
- data/rbi/metronome_sdk/models/v2/contract_edit_response.rbi +4 -37
- data/rbi/metronome_sdk/models/v2/contract_get_edit_history_response.rbi +700 -1447
- data/rbi/metronome_sdk/models/v2/contract_list_response.rbi +1204 -1472
- data/rbi/metronome_sdk/models/v2/contract_retrieve_response.rbi +1204 -1472
- data/rbi/metronome_sdk/models.rbi +32 -0
- data/rbi/metronome_sdk/resources/v1/alerts.rbi +3 -0
- data/rbi/metronome_sdk/resources/v1/billable_metrics.rbi +2 -6
- data/rbi/metronome_sdk/resources/v1/contracts/products.rbi +4 -4
- data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbi +1 -4
- data/rbi/metronome_sdk/resources/v1/contracts.rbi +10 -4
- data/rbi/metronome_sdk/resources/v1/credit_grants.rbi +4 -0
- data/rbi/metronome_sdk/resources/v1/customers/commits.rbi +6 -4
- data/rbi/metronome_sdk/resources/v1/customers/invoices.rbi +1 -1
- data/rbi/metronome_sdk/resources/v1/customers.rbi +34 -3
- data/rbi/metronome_sdk/resources/v1/usage.rbi +17 -0
- data/rbi/metronome_sdk/resources/v2/contracts.rbi +24 -14
- data/sig/metronome_sdk/errors.rbs +9 -0
- data/sig/metronome_sdk/internal/type/converter.rbs +7 -1
- data/sig/metronome_sdk/models/base_usage_filter.rbs +28 -0
- data/sig/metronome_sdk/models/commit.rbs +1020 -0
- data/sig/metronome_sdk/models/contract_without_amendments.rbs +1582 -0
- data/sig/metronome_sdk/models/credit.rbs +643 -0
- data/sig/metronome_sdk/models/credit_type_data.rbs +15 -0
- data/sig/metronome_sdk/models/discount.rbs +63 -0
- data/sig/metronome_sdk/models/event_type_filter.rbs +26 -0
- data/sig/metronome_sdk/models/id.rbs +13 -0
- data/sig/metronome_sdk/models/override.rbs +399 -0
- data/sig/metronome_sdk/models/pro_service.rbs +61 -0
- data/sig/metronome_sdk/models/property_filter.rbs +41 -0
- data/sig/metronome_sdk/models/rate.rbs +94 -0
- data/sig/metronome_sdk/models/schedule_duration.rbs +56 -0
- data/sig/metronome_sdk/models/schedule_point_in_time.rbs +75 -0
- data/sig/metronome_sdk/models/scheduled_charge.rbs +70 -0
- data/sig/metronome_sdk/models/tier.rbs +17 -0
- data/sig/metronome_sdk/models/v1/alert_archive_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/alert_create_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/billable_metric_archive_params.rbs +4 -12
- data/sig/metronome_sdk/models/v1/billable_metric_archive_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/billable_metric_create_params.rbs +12 -73
- data/sig/metronome_sdk/models/v1/billable_metric_create_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/billable_metric_list_response.rbs +12 -73
- data/sig/metronome_sdk/models/v1/billable_metric_retrieve_response.rbs +12 -73
- data/sig/metronome_sdk/models/v1/contract_amend_params.rbs +291 -24
- data/sig/metronome_sdk/models/v1/contract_amend_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/contract_archive_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/contract_create_historical_invoices_response.rbs +4 -1291
- data/sig/metronome_sdk/models/v1/contract_create_params.rbs +448 -84
- data/sig/metronome_sdk/models/v1/contract_create_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/contract_list_balances_response.rbs +1 -1642
- data/sig/metronome_sdk/models/v1/contract_list_response.rbs +188 -10437
- data/sig/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rbs +15 -271
- data/sig/metronome_sdk/models/v1/contract_retrieve_response.rbs +188 -10437
- data/sig/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_response.rbs +4 -1291
- data/sig/metronome_sdk/models/v1/contract_update_end_date_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/contracts/product_archive_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/contracts/product_create_params.rbs +8 -82
- data/sig/metronome_sdk/models/v1/contracts/product_create_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/contracts/product_list_item_state.rbs +121 -0
- data/sig/metronome_sdk/models/v1/contracts/product_list_response.rbs +16 -466
- data/sig/metronome_sdk/models/v1/contracts/product_retrieve_params.rbs +4 -12
- data/sig/metronome_sdk/models/v1/contracts/product_retrieve_response.rbs +16 -466
- data/sig/metronome_sdk/models/v1/contracts/product_update_params.rbs +8 -82
- data/sig/metronome_sdk/models/v1/contracts/product_update_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/contracts/quantity_conversion.rbs +47 -0
- data/sig/metronome_sdk/models/v1/contracts/quantity_rounding.rbs +41 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_archive_params.rbs +4 -12
- data/sig/metronome_sdk/models/v1/contracts/rate_card_archive_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/contracts/rate_card_create_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/contracts/rate_card_list_response.rbs +10 -34
- data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_params.rbs +4 -12
- data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rbs +10 -144
- data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rbs +10 -34
- data/sig/metronome_sdk/models/v1/contracts/rate_card_update_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rbs +12 -40
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbs +12 -40
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rbs +18 -58
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rbs +10 -144
- data/sig/metronome_sdk/models/v1/credit_grant_create_params.rbs +2 -66
- data/sig/metronome_sdk/models/v1/credit_grant_create_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/credit_grant_edit_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/credit_grant_list_entries_params.rbs +20 -0
- data/sig/metronome_sdk/models/v1/credit_grant_list_entries_response.rbs +12 -118
- data/sig/metronome_sdk/models/v1/credit_grant_list_response.rbs +16 -140
- data/sig/metronome_sdk/models/v1/credit_grant_void_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/credit_ledger_entry.rbs +52 -0
- data/sig/metronome_sdk/models/v1/customer.rbs +44 -0
- data/sig/metronome_sdk/models/v1/customer_archive_params.rbs +4 -12
- data/sig/metronome_sdk/models/v1/customer_archive_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/customer_create_response.rbs +4 -48
- data/sig/metronome_sdk/models/v1/{customer_list_response.rbs → customer_detail.rbs} +17 -17
- data/sig/metronome_sdk/models/v1/customer_list_billable_metrics_response.rbs +12 -73
- data/sig/metronome_sdk/models/v1/customer_preview_events_params.rbs +105 -0
- data/sig/metronome_sdk/models/v1/customer_preview_events_response.rbs +16 -0
- data/sig/metronome_sdk/models/v1/customer_retrieve_response.rbs +4 -112
- data/sig/metronome_sdk/models/v1/customer_set_name_response.rbs +4 -48
- data/sig/metronome_sdk/models/v1/customers/alert_list_response.rbs +4 -243
- data/sig/metronome_sdk/models/v1/customers/alert_retrieve_response.rbs +4 -247
- data/sig/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbs +7 -0
- data/sig/metronome_sdk/models/v1/customers/commit_create_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/customers/commit_list_response.rbs +4 -1057
- data/sig/metronome_sdk/models/v1/customers/commit_update_end_date_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/customers/credit_create_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/customers/credit_list_response.rbs +4 -596
- data/sig/metronome_sdk/models/v1/customers/credit_update_end_date_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/customers/customer_alert.rbs +234 -0
- data/sig/metronome_sdk/models/v1/customers/{invoice_list_response.rbs → invoice.rbs} +147 -305
- data/sig/metronome_sdk/models/v1/customers/invoice_list_breakdowns_response.rbs +8 -1278
- data/sig/metronome_sdk/models/v1/customers/invoice_retrieve_response.rbs +4 -1294
- data/sig/metronome_sdk/models/v1/customers/plan_add_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/customers/plan_list_response.rbs +4 -16
- data/sig/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rbs +2 -1
- data/sig/metronome_sdk/models/v1/plan_detail.rbs +203 -0
- data/sig/metronome_sdk/models/v1/plan_get_details_response.rbs +4 -267
- data/sig/metronome_sdk/models/v1/plan_list_charges_response.rbs +4 -16
- data/sig/metronome_sdk/models/v1/plan_list_customers_response.rbs +4 -108
- data/sig/metronome_sdk/models/v1/rollover_amount_max_amount.rbs +37 -0
- data/sig/metronome_sdk/models/v1/rollover_amount_max_percentage.rbs +37 -0
- data/sig/metronome_sdk/models/v1/usage_search_params.rbs +26 -0
- data/sig/metronome_sdk/models/v1/usage_search_response.rbs +230 -0
- data/sig/metronome_sdk/models/v2/contract_edit_commit_params.rbs +4 -8
- data/sig/metronome_sdk/models/v2/contract_edit_commit_response.rbs +4 -19
- data/sig/metronome_sdk/models/v2/contract_edit_credit_params.rbs +4 -8
- data/sig/metronome_sdk/models/v2/contract_edit_credit_response.rbs +4 -19
- data/sig/metronome_sdk/models/v2/contract_edit_params.rbs +743 -77
- data/sig/metronome_sdk/models/v2/contract_edit_response.rbs +4 -19
- data/sig/metronome_sdk/models/v2/contract_get_edit_history_response.rbs +274 -665
- data/sig/metronome_sdk/models/v2/contract_list_response.rbs +567 -759
- data/sig/metronome_sdk/models/v2/contract_retrieve_response.rbs +567 -759
- data/sig/metronome_sdk/models.rbs +32 -0
- data/sig/metronome_sdk/resources/v1/billable_metrics.rbs +2 -2
- data/sig/metronome_sdk/resources/v1/contracts/products.rbs +4 -4
- data/sig/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbs +1 -1
- data/sig/metronome_sdk/resources/v1/contracts.rbs +3 -1
- data/sig/metronome_sdk/resources/v1/credit_grants.rbs +1 -0
- data/sig/metronome_sdk/resources/v1/customers/invoices.rbs +1 -1
- data/sig/metronome_sdk/resources/v1/customers.rbs +9 -1
- data/sig/metronome_sdk/resources/v1/usage.rbs +5 -0
- data/sig/metronome_sdk/resources/v2/contracts.rbs +3 -2
- metadata +95 -8
@@ -7,22 +7,11 @@ module MetronomeSDK
|
|
7
7
|
class ContractUpdateEndDateResponse < MetronomeSDK::Internal::Type::BaseModel
|
8
8
|
# @!attribute data
|
9
9
|
#
|
10
|
-
# @return [MetronomeSDK::Models::
|
11
|
-
required :data, -> { MetronomeSDK::
|
10
|
+
# @return [MetronomeSDK::Models::ID]
|
11
|
+
required :data, -> { MetronomeSDK::ID }
|
12
12
|
|
13
13
|
# @!method initialize(data:)
|
14
|
-
# @param data [MetronomeSDK::Models::
|
15
|
-
|
16
|
-
# @see MetronomeSDK::Models::V1::ContractUpdateEndDateResponse#data
|
17
|
-
class Data < MetronomeSDK::Internal::Type::BaseModel
|
18
|
-
# @!attribute id
|
19
|
-
#
|
20
|
-
# @return [String]
|
21
|
-
required :id, String
|
22
|
-
|
23
|
-
# @!method initialize(id:)
|
24
|
-
# @param id [String]
|
25
|
-
end
|
14
|
+
# @param data [MetronomeSDK::Models::ID]
|
26
15
|
end
|
27
16
|
end
|
28
17
|
end
|
@@ -8,22 +8,11 @@ module MetronomeSDK
|
|
8
8
|
class ProductArchiveResponse < MetronomeSDK::Internal::Type::BaseModel
|
9
9
|
# @!attribute data
|
10
10
|
#
|
11
|
-
# @return [MetronomeSDK::Models::
|
12
|
-
required :data, -> { MetronomeSDK::
|
11
|
+
# @return [MetronomeSDK::Models::ID]
|
12
|
+
required :data, -> { MetronomeSDK::ID }
|
13
13
|
|
14
14
|
# @!method initialize(data:)
|
15
|
-
# @param data [MetronomeSDK::Models::
|
16
|
-
|
17
|
-
# @see MetronomeSDK::Models::V1::Contracts::ProductArchiveResponse#data
|
18
|
-
class Data < MetronomeSDK::Internal::Type::BaseModel
|
19
|
-
# @!attribute id
|
20
|
-
#
|
21
|
-
# @return [String]
|
22
|
-
required :id, String
|
23
|
-
|
24
|
-
# @!method initialize(id:)
|
25
|
-
# @param id [String]
|
26
|
-
end
|
15
|
+
# @param data [MetronomeSDK::Models::ID]
|
27
16
|
end
|
28
17
|
end
|
29
18
|
end
|
@@ -90,10 +90,8 @@ module MetronomeSDK
|
|
90
90
|
# GB. In this case, the conversion factor would be 1024 and the operation would be
|
91
91
|
# "divide".
|
92
92
|
#
|
93
|
-
# @return [MetronomeSDK::Models::V1::Contracts::
|
94
|
-
optional :quantity_conversion,
|
95
|
-
-> { MetronomeSDK::V1::Contracts::ProductCreateParams::QuantityConversion },
|
96
|
-
nil?: true
|
93
|
+
# @return [MetronomeSDK::Models::V1::Contracts::QuantityConversion, nil]
|
94
|
+
optional :quantity_conversion, -> { MetronomeSDK::V1::Contracts::QuantityConversion }, nil?: true
|
97
95
|
|
98
96
|
# @!attribute quantity_rounding
|
99
97
|
# Optional. Only valid for USAGE products. If provided, the quantity will be
|
@@ -101,10 +99,8 @@ module MetronomeSDK
|
|
101
99
|
# the method is "round up" and the decimal places is 0, then the quantity will be
|
102
100
|
# rounded up to the nearest integer.
|
103
101
|
#
|
104
|
-
# @return [MetronomeSDK::Models::V1::Contracts::
|
105
|
-
optional :quantity_rounding,
|
106
|
-
-> { MetronomeSDK::V1::Contracts::ProductCreateParams::QuantityRounding },
|
107
|
-
nil?: true
|
102
|
+
# @return [MetronomeSDK::Models::V1::Contracts::QuantityRounding, nil]
|
103
|
+
optional :quantity_rounding, -> { MetronomeSDK::V1::Contracts::QuantityRounding }, nil?: true
|
108
104
|
|
109
105
|
# @!attribute tags
|
110
106
|
#
|
@@ -137,9 +133,9 @@ module MetronomeSDK
|
|
137
133
|
#
|
138
134
|
# @param pricing_group_key [Array<String>] For USAGE products only. If set, pricing for this product will be determined for
|
139
135
|
#
|
140
|
-
# @param quantity_conversion [MetronomeSDK::Models::V1::Contracts::
|
136
|
+
# @param quantity_conversion [MetronomeSDK::Models::V1::Contracts::QuantityConversion, nil] Optional. Only valid for USAGE products. If provided, the quantity will be conve
|
141
137
|
#
|
142
|
-
# @param quantity_rounding [MetronomeSDK::Models::V1::Contracts::
|
138
|
+
# @param quantity_rounding [MetronomeSDK::Models::V1::Contracts::QuantityRounding, nil] Optional. Only valid for USAGE products. If provided, the quantity will be round
|
143
139
|
#
|
144
140
|
# @param tags [Array<String>]
|
145
141
|
#
|
@@ -158,93 +154,6 @@ module MetronomeSDK
|
|
158
154
|
# @!method self.values
|
159
155
|
# @return [Array<Symbol>]
|
160
156
|
end
|
161
|
-
|
162
|
-
class QuantityConversion < MetronomeSDK::Internal::Type::BaseModel
|
163
|
-
# @!attribute conversion_factor
|
164
|
-
# The factor to multiply or divide the quantity by.
|
165
|
-
#
|
166
|
-
# @return [Float]
|
167
|
-
required :conversion_factor, Float
|
168
|
-
|
169
|
-
# @!attribute operation
|
170
|
-
# The operation to perform on the quantity
|
171
|
-
#
|
172
|
-
# @return [Symbol, MetronomeSDK::Models::V1::Contracts::ProductCreateParams::QuantityConversion::Operation]
|
173
|
-
required :operation,
|
174
|
-
enum: -> {
|
175
|
-
MetronomeSDK::V1::Contracts::ProductCreateParams::QuantityConversion::Operation
|
176
|
-
}
|
177
|
-
|
178
|
-
# @!attribute name
|
179
|
-
# Optional name for this conversion.
|
180
|
-
#
|
181
|
-
# @return [String, nil]
|
182
|
-
optional :name, String
|
183
|
-
|
184
|
-
# @!method initialize(conversion_factor:, operation:, name: nil)
|
185
|
-
# Optional. Only valid for USAGE products. If provided, the quantity will be
|
186
|
-
# converted using the provided conversion factor and operation. For example, if
|
187
|
-
# the operation is "multiply" and the conversion factor is 100, then the quantity
|
188
|
-
# will be multiplied by 100. This can be used in cases where data is sent in one
|
189
|
-
# unit and priced in another. For example, data could be sent in MB and priced in
|
190
|
-
# GB. In this case, the conversion factor would be 1024 and the operation would be
|
191
|
-
# "divide".
|
192
|
-
#
|
193
|
-
# @param conversion_factor [Float] The factor to multiply or divide the quantity by.
|
194
|
-
#
|
195
|
-
# @param operation [Symbol, MetronomeSDK::Models::V1::Contracts::ProductCreateParams::QuantityConversion::Operation] The operation to perform on the quantity
|
196
|
-
#
|
197
|
-
# @param name [String] Optional name for this conversion.
|
198
|
-
|
199
|
-
# The operation to perform on the quantity
|
200
|
-
#
|
201
|
-
# @see MetronomeSDK::Models::V1::Contracts::ProductCreateParams::QuantityConversion#operation
|
202
|
-
module Operation
|
203
|
-
extend MetronomeSDK::Internal::Type::Enum
|
204
|
-
|
205
|
-
MULTIPLY = :MULTIPLY
|
206
|
-
DIVIDE = :DIVIDE
|
207
|
-
|
208
|
-
# @!method self.values
|
209
|
-
# @return [Array<Symbol>]
|
210
|
-
end
|
211
|
-
end
|
212
|
-
|
213
|
-
class QuantityRounding < MetronomeSDK::Internal::Type::BaseModel
|
214
|
-
# @!attribute decimal_places
|
215
|
-
#
|
216
|
-
# @return [Float]
|
217
|
-
required :decimal_places, Float
|
218
|
-
|
219
|
-
# @!attribute rounding_method
|
220
|
-
#
|
221
|
-
# @return [Symbol, MetronomeSDK::Models::V1::Contracts::ProductCreateParams::QuantityRounding::RoundingMethod]
|
222
|
-
required :rounding_method,
|
223
|
-
enum: -> {
|
224
|
-
MetronomeSDK::V1::Contracts::ProductCreateParams::QuantityRounding::RoundingMethod
|
225
|
-
}
|
226
|
-
|
227
|
-
# @!method initialize(decimal_places:, rounding_method:)
|
228
|
-
# Optional. Only valid for USAGE products. If provided, the quantity will be
|
229
|
-
# rounded using the provided rounding method and decimal places. For example, if
|
230
|
-
# the method is "round up" and the decimal places is 0, then the quantity will be
|
231
|
-
# rounded up to the nearest integer.
|
232
|
-
#
|
233
|
-
# @param decimal_places [Float]
|
234
|
-
# @param rounding_method [Symbol, MetronomeSDK::Models::V1::Contracts::ProductCreateParams::QuantityRounding::RoundingMethod]
|
235
|
-
|
236
|
-
# @see MetronomeSDK::Models::V1::Contracts::ProductCreateParams::QuantityRounding#rounding_method
|
237
|
-
module RoundingMethod
|
238
|
-
extend MetronomeSDK::Internal::Type::Enum
|
239
|
-
|
240
|
-
ROUND_UP = :ROUND_UP
|
241
|
-
ROUND_DOWN = :ROUND_DOWN
|
242
|
-
ROUND_HALF_UP = :ROUND_HALF_UP
|
243
|
-
|
244
|
-
# @!method self.values
|
245
|
-
# @return [Array<Symbol>]
|
246
|
-
end
|
247
|
-
end
|
248
157
|
end
|
249
158
|
end
|
250
159
|
end
|
@@ -8,22 +8,11 @@ module MetronomeSDK
|
|
8
8
|
class ProductCreateResponse < MetronomeSDK::Internal::Type::BaseModel
|
9
9
|
# @!attribute data
|
10
10
|
#
|
11
|
-
# @return [MetronomeSDK::Models::
|
12
|
-
required :data, -> { MetronomeSDK::
|
11
|
+
# @return [MetronomeSDK::Models::ID]
|
12
|
+
required :data, -> { MetronomeSDK::ID }
|
13
13
|
|
14
14
|
# @!method initialize(data:)
|
15
|
-
# @param data [MetronomeSDK::Models::
|
16
|
-
|
17
|
-
# @see MetronomeSDK::Models::V1::Contracts::ProductCreateResponse#data
|
18
|
-
class Data < MetronomeSDK::Internal::Type::BaseModel
|
19
|
-
# @!attribute id
|
20
|
-
#
|
21
|
-
# @return [String]
|
22
|
-
required :id, String
|
23
|
-
|
24
|
-
# @!method initialize(id:)
|
25
|
-
# @param id [String]
|
26
|
-
end
|
15
|
+
# @param data [MetronomeSDK::Models::ID]
|
27
16
|
end
|
28
17
|
end
|
29
18
|
end
|
@@ -0,0 +1,148 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module MetronomeSDK
|
4
|
+
module Models
|
5
|
+
module V1
|
6
|
+
module Contracts
|
7
|
+
class ProductListItemState < MetronomeSDK::Internal::Type::BaseModel
|
8
|
+
# @!attribute created_at
|
9
|
+
#
|
10
|
+
# @return [Time]
|
11
|
+
required :created_at, Time
|
12
|
+
|
13
|
+
# @!attribute created_by
|
14
|
+
#
|
15
|
+
# @return [String]
|
16
|
+
required :created_by, String
|
17
|
+
|
18
|
+
# @!attribute name
|
19
|
+
#
|
20
|
+
# @return [String]
|
21
|
+
required :name, String
|
22
|
+
|
23
|
+
# @!attribute billable_metric_id
|
24
|
+
#
|
25
|
+
# @return [String, nil]
|
26
|
+
optional :billable_metric_id, String
|
27
|
+
|
28
|
+
# @!attribute composite_product_ids
|
29
|
+
#
|
30
|
+
# @return [Array<String>, nil]
|
31
|
+
optional :composite_product_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
|
32
|
+
|
33
|
+
# @!attribute composite_tags
|
34
|
+
#
|
35
|
+
# @return [Array<String>, nil]
|
36
|
+
optional :composite_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
|
37
|
+
|
38
|
+
# @!attribute exclude_free_usage
|
39
|
+
#
|
40
|
+
# @return [Boolean, nil]
|
41
|
+
optional :exclude_free_usage, MetronomeSDK::Internal::Type::Boolean
|
42
|
+
|
43
|
+
# @!attribute is_refundable
|
44
|
+
# This field's availability is dependent on your client's configuration.
|
45
|
+
#
|
46
|
+
# @return [Boolean, nil]
|
47
|
+
optional :is_refundable, MetronomeSDK::Internal::Type::Boolean
|
48
|
+
|
49
|
+
# @!attribute netsuite_internal_item_id
|
50
|
+
# This field's availability is dependent on your client's configuration.
|
51
|
+
#
|
52
|
+
# @return [String, nil]
|
53
|
+
optional :netsuite_internal_item_id, String
|
54
|
+
|
55
|
+
# @!attribute netsuite_overage_item_id
|
56
|
+
# This field's availability is dependent on your client's configuration.
|
57
|
+
#
|
58
|
+
# @return [String, nil]
|
59
|
+
optional :netsuite_overage_item_id, String
|
60
|
+
|
61
|
+
# @!attribute presentation_group_key
|
62
|
+
# For USAGE products only. Groups usage line items on invoices. The superset of
|
63
|
+
# values in the pricing group key and presentation group key must be set as one
|
64
|
+
# compound group key on the billable metric.
|
65
|
+
#
|
66
|
+
# @return [Array<String>, nil]
|
67
|
+
optional :presentation_group_key, MetronomeSDK::Internal::Type::ArrayOf[String]
|
68
|
+
|
69
|
+
# @!attribute pricing_group_key
|
70
|
+
# For USAGE products only. If set, pricing for this product will be determined for
|
71
|
+
# each pricing_group_key value, as opposed to the product as a whole. The superset
|
72
|
+
# of values in the pricing group key and presentation group key must be set as one
|
73
|
+
# compound group key on the billable metric.
|
74
|
+
#
|
75
|
+
# @return [Array<String>, nil]
|
76
|
+
optional :pricing_group_key, MetronomeSDK::Internal::Type::ArrayOf[String]
|
77
|
+
|
78
|
+
# @!attribute quantity_conversion
|
79
|
+
# Optional. Only valid for USAGE products. If provided, the quantity will be
|
80
|
+
# converted using the provided conversion factor and operation. For example, if
|
81
|
+
# the operation is "multiply" and the conversion factor is 100, then the quantity
|
82
|
+
# will be multiplied by 100. This can be used in cases where data is sent in one
|
83
|
+
# unit and priced in another. For example, data could be sent in MB and priced in
|
84
|
+
# GB. In this case, the conversion factor would be 1024 and the operation would be
|
85
|
+
# "divide".
|
86
|
+
#
|
87
|
+
# @return [MetronomeSDK::Models::V1::Contracts::QuantityConversion, nil]
|
88
|
+
optional :quantity_conversion, -> { MetronomeSDK::V1::Contracts::QuantityConversion }, nil?: true
|
89
|
+
|
90
|
+
# @!attribute quantity_rounding
|
91
|
+
# Optional. Only valid for USAGE products. If provided, the quantity will be
|
92
|
+
# rounded using the provided rounding method and decimal places. For example, if
|
93
|
+
# the method is "round up" and the decimal places is 0, then the quantity will be
|
94
|
+
# rounded up to the nearest integer.
|
95
|
+
#
|
96
|
+
# @return [MetronomeSDK::Models::V1::Contracts::QuantityRounding, nil]
|
97
|
+
optional :quantity_rounding, -> { MetronomeSDK::V1::Contracts::QuantityRounding }, nil?: true
|
98
|
+
|
99
|
+
# @!attribute starting_at
|
100
|
+
#
|
101
|
+
# @return [Time, nil]
|
102
|
+
optional :starting_at, Time
|
103
|
+
|
104
|
+
# @!attribute tags
|
105
|
+
#
|
106
|
+
# @return [Array<String>, nil]
|
107
|
+
optional :tags, MetronomeSDK::Internal::Type::ArrayOf[String]
|
108
|
+
|
109
|
+
# @!method initialize(created_at:, created_by:, name:, billable_metric_id: nil, composite_product_ids: nil, composite_tags: nil, exclude_free_usage: nil, is_refundable: nil, netsuite_internal_item_id: nil, netsuite_overage_item_id: nil, presentation_group_key: nil, pricing_group_key: nil, quantity_conversion: nil, quantity_rounding: nil, starting_at: nil, tags: nil)
|
110
|
+
# Some parameter documentations has been truncated, see
|
111
|
+
# {MetronomeSDK::Models::V1::Contracts::ProductListItemState} for more details.
|
112
|
+
#
|
113
|
+
# @param created_at [Time]
|
114
|
+
#
|
115
|
+
# @param created_by [String]
|
116
|
+
#
|
117
|
+
# @param name [String]
|
118
|
+
#
|
119
|
+
# @param billable_metric_id [String]
|
120
|
+
#
|
121
|
+
# @param composite_product_ids [Array<String>]
|
122
|
+
#
|
123
|
+
# @param composite_tags [Array<String>]
|
124
|
+
#
|
125
|
+
# @param exclude_free_usage [Boolean]
|
126
|
+
#
|
127
|
+
# @param is_refundable [Boolean] This field's availability is dependent on your client's configuration.
|
128
|
+
#
|
129
|
+
# @param netsuite_internal_item_id [String] This field's availability is dependent on your client's configuration.
|
130
|
+
#
|
131
|
+
# @param netsuite_overage_item_id [String] This field's availability is dependent on your client's configuration.
|
132
|
+
#
|
133
|
+
# @param presentation_group_key [Array<String>] For USAGE products only. Groups usage line items on invoices. The superset of va
|
134
|
+
#
|
135
|
+
# @param pricing_group_key [Array<String>] For USAGE products only. If set, pricing for this product will be determined for
|
136
|
+
#
|
137
|
+
# @param quantity_conversion [MetronomeSDK::Models::V1::Contracts::QuantityConversion, nil] Optional. Only valid for USAGE products. If provided, the quantity will be conve
|
138
|
+
#
|
139
|
+
# @param quantity_rounding [MetronomeSDK::Models::V1::Contracts::QuantityRounding, nil] Optional. Only valid for USAGE products. If provided, the quantity will be round
|
140
|
+
#
|
141
|
+
# @param starting_at [Time]
|
142
|
+
#
|
143
|
+
# @param tags [Array<String>]
|
144
|
+
end
|
145
|
+
end
|
146
|
+
end
|
147
|
+
end
|
148
|
+
end
|