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
@@ -8,22 +8,11 @@ module MetronomeSDK
|
|
8
8
|
class PlanAddResponse < 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::Customers::PlanAddResponse#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
|
@@ -102,31 +102,13 @@ module MetronomeSDK
|
|
102
102
|
|
103
103
|
# @!attribute credit_type
|
104
104
|
#
|
105
|
-
# @return [MetronomeSDK::Models::
|
106
|
-
required :credit_type,
|
107
|
-
-> { MetronomeSDK::Models::V1::Customers::PlanListResponse::TrialInfo::SpendingCap::CreditType }
|
105
|
+
# @return [MetronomeSDK::Models::CreditTypeData]
|
106
|
+
required :credit_type, -> { MetronomeSDK::CreditTypeData }
|
108
107
|
|
109
108
|
# @!method initialize(amount:, amount_remaining:, credit_type:)
|
110
109
|
# @param amount [Float]
|
111
110
|
# @param amount_remaining [Float]
|
112
|
-
# @param credit_type [MetronomeSDK::Models::
|
113
|
-
|
114
|
-
# @see MetronomeSDK::Models::V1::Customers::PlanListResponse::TrialInfo::SpendingCap#credit_type
|
115
|
-
class CreditType < MetronomeSDK::Internal::Type::BaseModel
|
116
|
-
# @!attribute id
|
117
|
-
#
|
118
|
-
# @return [String]
|
119
|
-
required :id, String
|
120
|
-
|
121
|
-
# @!attribute name
|
122
|
-
#
|
123
|
-
# @return [String]
|
124
|
-
required :name, String
|
125
|
-
|
126
|
-
# @!method initialize(id:, name:)
|
127
|
-
# @param id [String]
|
128
|
-
# @param name [String]
|
129
|
-
end
|
111
|
+
# @param credit_type [MetronomeSDK::Models::CreditTypeData]
|
130
112
|
end
|
131
113
|
end
|
132
114
|
end
|
@@ -0,0 +1,200 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module MetronomeSDK
|
4
|
+
module Models
|
5
|
+
module V1
|
6
|
+
class PlanDetail < MetronomeSDK::Internal::Type::BaseModel
|
7
|
+
# @!attribute id
|
8
|
+
#
|
9
|
+
# @return [String]
|
10
|
+
required :id, String
|
11
|
+
|
12
|
+
# @!attribute custom_fields
|
13
|
+
#
|
14
|
+
# @return [Hash{Symbol=>String}]
|
15
|
+
required :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
|
16
|
+
|
17
|
+
# @!attribute name
|
18
|
+
#
|
19
|
+
# @return [String]
|
20
|
+
required :name, String
|
21
|
+
|
22
|
+
# @!attribute credit_grants
|
23
|
+
#
|
24
|
+
# @return [Array<MetronomeSDK::Models::V1::PlanDetail::CreditGrant>, nil]
|
25
|
+
optional :credit_grants,
|
26
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::PlanDetail::CreditGrant] }
|
27
|
+
|
28
|
+
# @!attribute description
|
29
|
+
#
|
30
|
+
# @return [String, nil]
|
31
|
+
optional :description, String
|
32
|
+
|
33
|
+
# @!attribute minimums
|
34
|
+
#
|
35
|
+
# @return [Array<MetronomeSDK::Models::V1::PlanDetail::Minimum>, nil]
|
36
|
+
optional :minimums,
|
37
|
+
-> {
|
38
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::PlanDetail::Minimum]
|
39
|
+
}
|
40
|
+
|
41
|
+
# @!attribute overage_rates
|
42
|
+
#
|
43
|
+
# @return [Array<MetronomeSDK::Models::V1::PlanDetail::OverageRate>, nil]
|
44
|
+
optional :overage_rates,
|
45
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::PlanDetail::OverageRate] }
|
46
|
+
|
47
|
+
# @!method initialize(id:, custom_fields:, name:, credit_grants: nil, description: nil, minimums: nil, overage_rates: nil)
|
48
|
+
# @param id [String]
|
49
|
+
# @param custom_fields [Hash{Symbol=>String}]
|
50
|
+
# @param name [String]
|
51
|
+
# @param credit_grants [Array<MetronomeSDK::Models::V1::PlanDetail::CreditGrant>]
|
52
|
+
# @param description [String]
|
53
|
+
# @param minimums [Array<MetronomeSDK::Models::V1::PlanDetail::Minimum>]
|
54
|
+
# @param overage_rates [Array<MetronomeSDK::Models::V1::PlanDetail::OverageRate>]
|
55
|
+
|
56
|
+
class CreditGrant < MetronomeSDK::Internal::Type::BaseModel
|
57
|
+
# @!attribute amount_granted
|
58
|
+
#
|
59
|
+
# @return [Float]
|
60
|
+
required :amount_granted, Float
|
61
|
+
|
62
|
+
# @!attribute amount_granted_credit_type
|
63
|
+
#
|
64
|
+
# @return [MetronomeSDK::Models::CreditTypeData]
|
65
|
+
required :amount_granted_credit_type, -> { MetronomeSDK::CreditTypeData }
|
66
|
+
|
67
|
+
# @!attribute amount_paid
|
68
|
+
#
|
69
|
+
# @return [Float]
|
70
|
+
required :amount_paid, Float
|
71
|
+
|
72
|
+
# @!attribute amount_paid_credit_type
|
73
|
+
#
|
74
|
+
# @return [MetronomeSDK::Models::CreditTypeData]
|
75
|
+
required :amount_paid_credit_type, -> { MetronomeSDK::CreditTypeData }
|
76
|
+
|
77
|
+
# @!attribute effective_duration
|
78
|
+
#
|
79
|
+
# @return [Float]
|
80
|
+
required :effective_duration, Float
|
81
|
+
|
82
|
+
# @!attribute name
|
83
|
+
#
|
84
|
+
# @return [String]
|
85
|
+
required :name, String
|
86
|
+
|
87
|
+
# @!attribute priority
|
88
|
+
#
|
89
|
+
# @return [String]
|
90
|
+
required :priority, String
|
91
|
+
|
92
|
+
# @!attribute send_invoice
|
93
|
+
#
|
94
|
+
# @return [Boolean]
|
95
|
+
required :send_invoice, MetronomeSDK::Internal::Type::Boolean
|
96
|
+
|
97
|
+
# @!attribute reason
|
98
|
+
#
|
99
|
+
# @return [String, nil]
|
100
|
+
optional :reason, String
|
101
|
+
|
102
|
+
# @!attribute recurrence_duration
|
103
|
+
#
|
104
|
+
# @return [Float, nil]
|
105
|
+
optional :recurrence_duration, Float
|
106
|
+
|
107
|
+
# @!attribute recurrence_interval
|
108
|
+
#
|
109
|
+
# @return [Float, nil]
|
110
|
+
optional :recurrence_interval, Float
|
111
|
+
|
112
|
+
# @!method initialize(amount_granted:, amount_granted_credit_type:, amount_paid:, amount_paid_credit_type:, effective_duration:, name:, priority:, send_invoice:, reason: nil, recurrence_duration: nil, recurrence_interval: nil)
|
113
|
+
# @param amount_granted [Float]
|
114
|
+
# @param amount_granted_credit_type [MetronomeSDK::Models::CreditTypeData]
|
115
|
+
# @param amount_paid [Float]
|
116
|
+
# @param amount_paid_credit_type [MetronomeSDK::Models::CreditTypeData]
|
117
|
+
# @param effective_duration [Float]
|
118
|
+
# @param name [String]
|
119
|
+
# @param priority [String]
|
120
|
+
# @param send_invoice [Boolean]
|
121
|
+
# @param reason [String]
|
122
|
+
# @param recurrence_duration [Float]
|
123
|
+
# @param recurrence_interval [Float]
|
124
|
+
end
|
125
|
+
|
126
|
+
class Minimum < MetronomeSDK::Internal::Type::BaseModel
|
127
|
+
# @!attribute credit_type
|
128
|
+
#
|
129
|
+
# @return [MetronomeSDK::Models::CreditTypeData]
|
130
|
+
required :credit_type, -> { MetronomeSDK::CreditTypeData }
|
131
|
+
|
132
|
+
# @!attribute name
|
133
|
+
#
|
134
|
+
# @return [String]
|
135
|
+
required :name, String
|
136
|
+
|
137
|
+
# @!attribute start_period
|
138
|
+
# Used in price ramps. Indicates how many billing periods pass before the charge
|
139
|
+
# applies.
|
140
|
+
#
|
141
|
+
# @return [Float]
|
142
|
+
required :start_period, Float
|
143
|
+
|
144
|
+
# @!attribute value
|
145
|
+
#
|
146
|
+
# @return [Float]
|
147
|
+
required :value, Float
|
148
|
+
|
149
|
+
# @!method initialize(credit_type:, name:, start_period:, value:)
|
150
|
+
# Some parameter documentations has been truncated, see
|
151
|
+
# {MetronomeSDK::Models::V1::PlanDetail::Minimum} for more details.
|
152
|
+
#
|
153
|
+
# @param credit_type [MetronomeSDK::Models::CreditTypeData]
|
154
|
+
#
|
155
|
+
# @param name [String]
|
156
|
+
#
|
157
|
+
# @param start_period [Float] Used in price ramps. Indicates how many billing periods pass before the charge
|
158
|
+
#
|
159
|
+
# @param value [Float]
|
160
|
+
end
|
161
|
+
|
162
|
+
class OverageRate < MetronomeSDK::Internal::Type::BaseModel
|
163
|
+
# @!attribute credit_type
|
164
|
+
#
|
165
|
+
# @return [MetronomeSDK::Models::CreditTypeData]
|
166
|
+
required :credit_type, -> { MetronomeSDK::CreditTypeData }
|
167
|
+
|
168
|
+
# @!attribute fiat_credit_type
|
169
|
+
#
|
170
|
+
# @return [MetronomeSDK::Models::CreditTypeData]
|
171
|
+
required :fiat_credit_type, -> { MetronomeSDK::CreditTypeData }
|
172
|
+
|
173
|
+
# @!attribute start_period
|
174
|
+
# Used in price ramps. Indicates how many billing periods pass before the charge
|
175
|
+
# applies.
|
176
|
+
#
|
177
|
+
# @return [Float]
|
178
|
+
required :start_period, Float
|
179
|
+
|
180
|
+
# @!attribute to_fiat_conversion_factor
|
181
|
+
#
|
182
|
+
# @return [Float]
|
183
|
+
required :to_fiat_conversion_factor, Float
|
184
|
+
|
185
|
+
# @!method initialize(credit_type:, fiat_credit_type:, start_period:, to_fiat_conversion_factor:)
|
186
|
+
# Some parameter documentations has been truncated, see
|
187
|
+
# {MetronomeSDK::Models::V1::PlanDetail::OverageRate} for more details.
|
188
|
+
#
|
189
|
+
# @param credit_type [MetronomeSDK::Models::CreditTypeData]
|
190
|
+
#
|
191
|
+
# @param fiat_credit_type [MetronomeSDK::Models::CreditTypeData]
|
192
|
+
#
|
193
|
+
# @param start_period [Float] Used in price ramps. Indicates how many billing periods pass before the charge
|
194
|
+
#
|
195
|
+
# @param to_fiat_conversion_factor [Float]
|
196
|
+
end
|
197
|
+
end
|
198
|
+
end
|
199
|
+
end
|
200
|
+
end
|
@@ -7,294 +7,11 @@ module MetronomeSDK
|
|
7
7
|
class PlanGetDetailsResponse < MetronomeSDK::Internal::Type::BaseModel
|
8
8
|
# @!attribute data
|
9
9
|
#
|
10
|
-
# @return [MetronomeSDK::Models::V1::
|
11
|
-
required :data, -> { MetronomeSDK::
|
10
|
+
# @return [MetronomeSDK::Models::V1::PlanDetail]
|
11
|
+
required :data, -> { MetronomeSDK::V1::PlanDetail }
|
12
12
|
|
13
13
|
# @!method initialize(data:)
|
14
|
-
# @param data [MetronomeSDK::Models::V1::
|
15
|
-
|
16
|
-
# @see MetronomeSDK::Models::V1::PlanGetDetailsResponse#data
|
17
|
-
class Data < MetronomeSDK::Internal::Type::BaseModel
|
18
|
-
# @!attribute id
|
19
|
-
#
|
20
|
-
# @return [String]
|
21
|
-
required :id, String
|
22
|
-
|
23
|
-
# @!attribute custom_fields
|
24
|
-
#
|
25
|
-
# @return [Hash{Symbol=>String}]
|
26
|
-
required :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
|
27
|
-
|
28
|
-
# @!attribute name
|
29
|
-
#
|
30
|
-
# @return [String]
|
31
|
-
required :name, String
|
32
|
-
|
33
|
-
# @!attribute credit_grants
|
34
|
-
#
|
35
|
-
# @return [Array<MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::CreditGrant>, nil]
|
36
|
-
optional :credit_grants,
|
37
|
-
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::CreditGrant] }
|
38
|
-
|
39
|
-
# @!attribute description
|
40
|
-
#
|
41
|
-
# @return [String, nil]
|
42
|
-
optional :description, String
|
43
|
-
|
44
|
-
# @!attribute minimums
|
45
|
-
#
|
46
|
-
# @return [Array<MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::Minimum>, nil]
|
47
|
-
optional :minimums,
|
48
|
-
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::Minimum] }
|
49
|
-
|
50
|
-
# @!attribute overage_rates
|
51
|
-
#
|
52
|
-
# @return [Array<MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::OverageRate>, nil]
|
53
|
-
optional :overage_rates,
|
54
|
-
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::OverageRate] }
|
55
|
-
|
56
|
-
# @!method initialize(id:, custom_fields:, name:, credit_grants: nil, description: nil, minimums: nil, overage_rates: nil)
|
57
|
-
# @param id [String]
|
58
|
-
# @param custom_fields [Hash{Symbol=>String}]
|
59
|
-
# @param name [String]
|
60
|
-
# @param credit_grants [Array<MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::CreditGrant>]
|
61
|
-
# @param description [String]
|
62
|
-
# @param minimums [Array<MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::Minimum>]
|
63
|
-
# @param overage_rates [Array<MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::OverageRate>]
|
64
|
-
|
65
|
-
class CreditGrant < MetronomeSDK::Internal::Type::BaseModel
|
66
|
-
# @!attribute amount_granted
|
67
|
-
#
|
68
|
-
# @return [Float]
|
69
|
-
required :amount_granted, Float
|
70
|
-
|
71
|
-
# @!attribute amount_granted_credit_type
|
72
|
-
#
|
73
|
-
# @return [MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::CreditGrant::AmountGrantedCreditType]
|
74
|
-
required :amount_granted_credit_type,
|
75
|
-
-> { MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::CreditGrant::AmountGrantedCreditType }
|
76
|
-
|
77
|
-
# @!attribute amount_paid
|
78
|
-
#
|
79
|
-
# @return [Float]
|
80
|
-
required :amount_paid, Float
|
81
|
-
|
82
|
-
# @!attribute amount_paid_credit_type
|
83
|
-
#
|
84
|
-
# @return [MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::CreditGrant::AmountPaidCreditType]
|
85
|
-
required :amount_paid_credit_type,
|
86
|
-
-> { MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::CreditGrant::AmountPaidCreditType }
|
87
|
-
|
88
|
-
# @!attribute effective_duration
|
89
|
-
#
|
90
|
-
# @return [Float]
|
91
|
-
required :effective_duration, Float
|
92
|
-
|
93
|
-
# @!attribute name
|
94
|
-
#
|
95
|
-
# @return [String]
|
96
|
-
required :name, String
|
97
|
-
|
98
|
-
# @!attribute priority
|
99
|
-
#
|
100
|
-
# @return [String]
|
101
|
-
required :priority, String
|
102
|
-
|
103
|
-
# @!attribute send_invoice
|
104
|
-
#
|
105
|
-
# @return [Boolean]
|
106
|
-
required :send_invoice, MetronomeSDK::Internal::Type::Boolean
|
107
|
-
|
108
|
-
# @!attribute reason
|
109
|
-
#
|
110
|
-
# @return [String, nil]
|
111
|
-
optional :reason, String
|
112
|
-
|
113
|
-
# @!attribute recurrence_duration
|
114
|
-
#
|
115
|
-
# @return [Float, nil]
|
116
|
-
optional :recurrence_duration, Float
|
117
|
-
|
118
|
-
# @!attribute recurrence_interval
|
119
|
-
#
|
120
|
-
# @return [Float, nil]
|
121
|
-
optional :recurrence_interval, Float
|
122
|
-
|
123
|
-
# @!method initialize(amount_granted:, amount_granted_credit_type:, amount_paid:, amount_paid_credit_type:, effective_duration:, name:, priority:, send_invoice:, reason: nil, recurrence_duration: nil, recurrence_interval: nil)
|
124
|
-
# @param amount_granted [Float]
|
125
|
-
# @param amount_granted_credit_type [MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::CreditGrant::AmountGrantedCreditType]
|
126
|
-
# @param amount_paid [Float]
|
127
|
-
# @param amount_paid_credit_type [MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::CreditGrant::AmountPaidCreditType]
|
128
|
-
# @param effective_duration [Float]
|
129
|
-
# @param name [String]
|
130
|
-
# @param priority [String]
|
131
|
-
# @param send_invoice [Boolean]
|
132
|
-
# @param reason [String]
|
133
|
-
# @param recurrence_duration [Float]
|
134
|
-
# @param recurrence_interval [Float]
|
135
|
-
|
136
|
-
# @see MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::CreditGrant#amount_granted_credit_type
|
137
|
-
class AmountGrantedCreditType < MetronomeSDK::Internal::Type::BaseModel
|
138
|
-
# @!attribute id
|
139
|
-
#
|
140
|
-
# @return [String]
|
141
|
-
required :id, String
|
142
|
-
|
143
|
-
# @!attribute name
|
144
|
-
#
|
145
|
-
# @return [String]
|
146
|
-
required :name, String
|
147
|
-
|
148
|
-
# @!method initialize(id:, name:)
|
149
|
-
# @param id [String]
|
150
|
-
# @param name [String]
|
151
|
-
end
|
152
|
-
|
153
|
-
# @see MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::CreditGrant#amount_paid_credit_type
|
154
|
-
class AmountPaidCreditType < MetronomeSDK::Internal::Type::BaseModel
|
155
|
-
# @!attribute id
|
156
|
-
#
|
157
|
-
# @return [String]
|
158
|
-
required :id, String
|
159
|
-
|
160
|
-
# @!attribute name
|
161
|
-
#
|
162
|
-
# @return [String]
|
163
|
-
required :name, String
|
164
|
-
|
165
|
-
# @!method initialize(id:, name:)
|
166
|
-
# @param id [String]
|
167
|
-
# @param name [String]
|
168
|
-
end
|
169
|
-
end
|
170
|
-
|
171
|
-
class Minimum < MetronomeSDK::Internal::Type::BaseModel
|
172
|
-
# @!attribute credit_type
|
173
|
-
#
|
174
|
-
# @return [MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::Minimum::CreditType]
|
175
|
-
required :credit_type, -> { MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::Minimum::CreditType }
|
176
|
-
|
177
|
-
# @!attribute name
|
178
|
-
#
|
179
|
-
# @return [String]
|
180
|
-
required :name, String
|
181
|
-
|
182
|
-
# @!attribute start_period
|
183
|
-
# Used in price ramps. Indicates how many billing periods pass before the charge
|
184
|
-
# applies.
|
185
|
-
#
|
186
|
-
# @return [Float]
|
187
|
-
required :start_period, Float
|
188
|
-
|
189
|
-
# @!attribute value
|
190
|
-
#
|
191
|
-
# @return [Float]
|
192
|
-
required :value, Float
|
193
|
-
|
194
|
-
# @!method initialize(credit_type:, name:, start_period:, value:)
|
195
|
-
# Some parameter documentations has been truncated, see
|
196
|
-
# {MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::Minimum} for more
|
197
|
-
# details.
|
198
|
-
#
|
199
|
-
# @param credit_type [MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::Minimum::CreditType]
|
200
|
-
#
|
201
|
-
# @param name [String]
|
202
|
-
#
|
203
|
-
# @param start_period [Float] Used in price ramps. Indicates how many billing periods pass before the charge
|
204
|
-
#
|
205
|
-
# @param value [Float]
|
206
|
-
|
207
|
-
# @see MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::Minimum#credit_type
|
208
|
-
class CreditType < MetronomeSDK::Internal::Type::BaseModel
|
209
|
-
# @!attribute id
|
210
|
-
#
|
211
|
-
# @return [String]
|
212
|
-
required :id, String
|
213
|
-
|
214
|
-
# @!attribute name
|
215
|
-
#
|
216
|
-
# @return [String]
|
217
|
-
required :name, String
|
218
|
-
|
219
|
-
# @!method initialize(id:, name:)
|
220
|
-
# @param id [String]
|
221
|
-
# @param name [String]
|
222
|
-
end
|
223
|
-
end
|
224
|
-
|
225
|
-
class OverageRate < MetronomeSDK::Internal::Type::BaseModel
|
226
|
-
# @!attribute credit_type
|
227
|
-
#
|
228
|
-
# @return [MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::OverageRate::CreditType]
|
229
|
-
required :credit_type,
|
230
|
-
-> { MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::OverageRate::CreditType }
|
231
|
-
|
232
|
-
# @!attribute fiat_credit_type
|
233
|
-
#
|
234
|
-
# @return [MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::OverageRate::FiatCreditType]
|
235
|
-
required :fiat_credit_type,
|
236
|
-
-> { MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::OverageRate::FiatCreditType }
|
237
|
-
|
238
|
-
# @!attribute start_period
|
239
|
-
# Used in price ramps. Indicates how many billing periods pass before the charge
|
240
|
-
# applies.
|
241
|
-
#
|
242
|
-
# @return [Float]
|
243
|
-
required :start_period, Float
|
244
|
-
|
245
|
-
# @!attribute to_fiat_conversion_factor
|
246
|
-
#
|
247
|
-
# @return [Float]
|
248
|
-
required :to_fiat_conversion_factor, Float
|
249
|
-
|
250
|
-
# @!method initialize(credit_type:, fiat_credit_type:, start_period:, to_fiat_conversion_factor:)
|
251
|
-
# Some parameter documentations has been truncated, see
|
252
|
-
# {MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::OverageRate} for more
|
253
|
-
# details.
|
254
|
-
#
|
255
|
-
# @param credit_type [MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::OverageRate::CreditType]
|
256
|
-
#
|
257
|
-
# @param fiat_credit_type [MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::OverageRate::FiatCreditType]
|
258
|
-
#
|
259
|
-
# @param start_period [Float] Used in price ramps. Indicates how many billing periods pass before the charge
|
260
|
-
#
|
261
|
-
# @param to_fiat_conversion_factor [Float]
|
262
|
-
|
263
|
-
# @see MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::OverageRate#credit_type
|
264
|
-
class CreditType < MetronomeSDK::Internal::Type::BaseModel
|
265
|
-
# @!attribute id
|
266
|
-
#
|
267
|
-
# @return [String]
|
268
|
-
required :id, String
|
269
|
-
|
270
|
-
# @!attribute name
|
271
|
-
#
|
272
|
-
# @return [String]
|
273
|
-
required :name, String
|
274
|
-
|
275
|
-
# @!method initialize(id:, name:)
|
276
|
-
# @param id [String]
|
277
|
-
# @param name [String]
|
278
|
-
end
|
279
|
-
|
280
|
-
# @see MetronomeSDK::Models::V1::PlanGetDetailsResponse::Data::OverageRate#fiat_credit_type
|
281
|
-
class FiatCreditType < MetronomeSDK::Internal::Type::BaseModel
|
282
|
-
# @!attribute id
|
283
|
-
#
|
284
|
-
# @return [String]
|
285
|
-
required :id, String
|
286
|
-
|
287
|
-
# @!attribute name
|
288
|
-
#
|
289
|
-
# @return [String]
|
290
|
-
required :name, String
|
291
|
-
|
292
|
-
# @!method initialize(id:, name:)
|
293
|
-
# @param id [String]
|
294
|
-
# @param name [String]
|
295
|
-
end
|
296
|
-
end
|
297
|
-
end
|
14
|
+
# @param data [MetronomeSDK::Models::V1::PlanDetail]
|
298
15
|
end
|
299
16
|
end
|
300
17
|
end
|
@@ -17,8 +17,8 @@ module MetronomeSDK
|
|
17
17
|
|
18
18
|
# @!attribute credit_type
|
19
19
|
#
|
20
|
-
# @return [MetronomeSDK::Models::
|
21
|
-
required :credit_type, -> { MetronomeSDK::
|
20
|
+
# @return [MetronomeSDK::Models::CreditTypeData]
|
21
|
+
required :credit_type, -> { MetronomeSDK::CreditTypeData }
|
22
22
|
|
23
23
|
# @!attribute custom_fields
|
24
24
|
#
|
@@ -79,7 +79,7 @@ module MetronomeSDK
|
|
79
79
|
#
|
80
80
|
# @param charge_type [Symbol, MetronomeSDK::Models::V1::PlanListChargesResponse::ChargeType]
|
81
81
|
#
|
82
|
-
# @param credit_type [MetronomeSDK::Models::
|
82
|
+
# @param credit_type [MetronomeSDK::Models::CreditTypeData]
|
83
83
|
#
|
84
84
|
# @param custom_fields [Hash{Symbol=>String}]
|
85
85
|
#
|
@@ -113,23 +113,6 @@ module MetronomeSDK
|
|
113
113
|
# @return [Array<Symbol>]
|
114
114
|
end
|
115
115
|
|
116
|
-
# @see MetronomeSDK::Models::V1::PlanListChargesResponse#credit_type
|
117
|
-
class CreditType < MetronomeSDK::Internal::Type::BaseModel
|
118
|
-
# @!attribute id
|
119
|
-
#
|
120
|
-
# @return [String]
|
121
|
-
required :id, String
|
122
|
-
|
123
|
-
# @!attribute name
|
124
|
-
#
|
125
|
-
# @return [String]
|
126
|
-
required :name, String
|
127
|
-
|
128
|
-
# @!method initialize(id:, name:)
|
129
|
-
# @param id [String]
|
130
|
-
# @param name [String]
|
131
|
-
end
|
132
|
-
|
133
116
|
class Price < MetronomeSDK::Internal::Type::BaseModel
|
134
117
|
# @!attribute tier
|
135
118
|
# Used in pricing tiers. Indicates at what metric value the price applies.
|