metronome-sdk 0.1.0.pre.alpha.3 → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +56 -0
- data/README.md +1 -1
- data/lib/metronome_sdk/errors.rb +22 -0
- data/lib/metronome_sdk/internal/cursor_page.rb +1 -1
- 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 +1053 -0
- data/lib/metronome_sdk/models/contract_without_amendments.rb +2043 -0
- data/lib/metronome_sdk/models/credit.rb +677 -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 +792 -104
- data/lib/metronome_sdk/models/v1/contract_create_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contract_list_balances_params.rb +9 -1
- 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_params.rb +9 -1
- 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_params.rb +9 -1
- 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 +1127 -105
- data/lib/metronome_sdk/models/v2/contract_edit_response.rb +3 -14
- data/lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb +577 -643
- data/lib/metronome_sdk/models/v2/contract_list_response.rb +917 -746
- data/lib/metronome_sdk/models/v2/contract_retrieve_response.rb +917 -748
- 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 +11 -5
- data/lib/metronome_sdk/resources/v1/credit_grants.rb +4 -2
- data/lib/metronome_sdk/resources/v1/customers/commits.rb +5 -3
- data/lib/metronome_sdk/resources/v1/customers/credits.rb +3 -1
- 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 +2046 -0
- data/rbi/metronome_sdk/models/contract_without_amendments.rbi +4260 -0
- data/rbi/metronome_sdk/models/credit.rbi +1314 -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 +1738 -210
- data/rbi/metronome_sdk/models/v1/contract_create_response.rbi +4 -37
- data/rbi/metronome_sdk/models/v1/contract_list_balances_params.rbi +11 -0
- 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_params.rbi +11 -0
- 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_params.rbi +11 -0
- 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 +2463 -206
- data/rbi/metronome_sdk/models/v2/contract_edit_response.rbi +4 -37
- data/rbi/metronome_sdk/models/v2/contract_get_edit_history_response.rbi +1381 -1550
- data/rbi/metronome_sdk/models/v2/contract_list_response.rbi +2017 -1466
- data/rbi/metronome_sdk/models/v2/contract_retrieve_response.rbi +2017 -1466
- 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 +13 -4
- data/rbi/metronome_sdk/resources/v1/credit_grants.rbi +4 -0
- data/rbi/metronome_sdk/resources/v1/customers/commits.rbi +9 -4
- data/rbi/metronome_sdk/resources/v1/customers/credits.rbi +3 -0
- 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 +1063 -0
- data/sig/metronome_sdk/models/contract_without_amendments.rbs +1828 -0
- data/sig/metronome_sdk/models/credit.rbs +686 -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 +694 -84
- data/sig/metronome_sdk/models/v1/contract_create_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/contract_list_balances_params.rbs +7 -0
- 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_params.rbs +7 -0
- 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_params.rbs +7 -0
- 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 +989 -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 +510 -655
- data/sig/metronome_sdk/models/v2/contract_list_response.rbs +970 -809
- data/sig/metronome_sdk/models/v2/contract_retrieve_response.rbs +970 -809
- 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 +4 -1
- data/sig/metronome_sdk/resources/v1/credit_grants.rbs +1 -0
- data/sig/metronome_sdk/resources/v1/customers/commits.rbs +1 -0
- data/sig/metronome_sdk/resources/v1/customers/credits.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 +97 -10
@@ -157,15 +157,17 @@ module MetronomeSDK
|
|
157
157
|
optional :amount, Float
|
158
158
|
|
159
159
|
# @!attribute applicable_product_ids
|
160
|
-
# Which products the commit applies to. If
|
161
|
-
# applicable_product_tags are not provided, the commit applies to
|
160
|
+
# Which products the commit applies to. If applicable_product_ids,
|
161
|
+
# applicable_product_tags or specifiers are not provided, the commit applies to
|
162
|
+
# all products.
|
162
163
|
#
|
163
164
|
# @return [Array<String>, nil]
|
164
165
|
optional :applicable_product_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
|
165
166
|
|
166
167
|
# @!attribute applicable_product_tags
|
167
|
-
# Which tags the commit applies to. If
|
168
|
-
# applicable_product_tags are not provided, the commit applies to
|
168
|
+
# Which tags the commit applies to. If applicable_product_ids,
|
169
|
+
# applicable_product_tags or specifiers are not provided, the commit applies to
|
170
|
+
# all products.
|
169
171
|
#
|
170
172
|
# @return [Array<String>, nil]
|
171
173
|
optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
|
@@ -181,6 +183,13 @@ module MetronomeSDK
|
|
181
183
|
# @return [String, nil]
|
182
184
|
optional :description, String
|
183
185
|
|
186
|
+
# @!attribute hierarchy_configuration
|
187
|
+
# Optional configuration for commit hierarchy access control
|
188
|
+
#
|
189
|
+
# @return [MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration, nil]
|
190
|
+
optional :hierarchy_configuration,
|
191
|
+
-> { MetronomeSDK::V1::ContractAmendParams::Commit::HierarchyConfiguration }
|
192
|
+
|
184
193
|
# @!attribute invoice_schedule
|
185
194
|
# Required for "POSTPAID" commits: the true up invoice will be generated at this
|
186
195
|
# time and only one schedule item is allowed; the total must match access_schedule
|
@@ -248,7 +257,7 @@ module MetronomeSDK
|
|
248
257
|
# @return [String, nil]
|
249
258
|
optional :temporary_id, String
|
250
259
|
|
251
|
-
# @!method initialize(product_id:, type:, access_schedule: nil, amount: nil, applicable_product_ids: nil, applicable_product_tags: nil, custom_fields: nil, description: nil, invoice_schedule: nil, name: nil, netsuite_sales_order_id: nil, payment_gate_config: nil, priority: nil, rate_type: nil, rollover_fraction: nil, specifiers: nil, temporary_id: nil)
|
260
|
+
# @!method initialize(product_id:, type:, access_schedule: nil, amount: nil, applicable_product_ids: nil, applicable_product_tags: nil, custom_fields: nil, description: nil, hierarchy_configuration: nil, invoice_schedule: nil, name: nil, netsuite_sales_order_id: nil, payment_gate_config: nil, priority: nil, rate_type: nil, rollover_fraction: nil, specifiers: nil, temporary_id: nil)
|
252
261
|
# Some parameter documentations has been truncated, see
|
253
262
|
# {MetronomeSDK::Models::V1::ContractAmendParams::Commit} for more details.
|
254
263
|
#
|
@@ -260,14 +269,16 @@ module MetronomeSDK
|
|
260
269
|
#
|
261
270
|
# @param amount [Float] (DEPRECATED) Use access_schedule and invoice_schedule instead.
|
262
271
|
#
|
263
|
-
# @param applicable_product_ids [Array<String>] Which products the commit applies to. If
|
272
|
+
# @param applicable_product_ids [Array<String>] Which products the commit applies to. If applicable_product_ids, applicable_prod
|
264
273
|
#
|
265
|
-
# @param applicable_product_tags [Array<String>] Which tags the commit applies to. If
|
274
|
+
# @param applicable_product_tags [Array<String>] Which tags the commit applies to. If applicable*product_ids, applicable_product*
|
266
275
|
#
|
267
276
|
# @param custom_fields [Hash{Symbol=>String}]
|
268
277
|
#
|
269
278
|
# @param description [String] Used only in UI/API. It is not exposed to end customers.
|
270
279
|
#
|
280
|
+
# @param hierarchy_configuration [MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration] Optional configuration for commit hierarchy access control
|
281
|
+
#
|
271
282
|
# @param invoice_schedule [MetronomeSDK::Models::V1::ContractAmendParams::Commit::InvoiceSchedule] Required for "POSTPAID" commits: the true up invoice will be generated at this t
|
272
283
|
#
|
273
284
|
# @param name [String] displayed on invoices
|
@@ -349,6 +360,117 @@ module MetronomeSDK
|
|
349
360
|
end
|
350
361
|
end
|
351
362
|
|
363
|
+
# @see MetronomeSDK::Models::V1::ContractAmendParams::Commit#hierarchy_configuration
|
364
|
+
class HierarchyConfiguration < MetronomeSDK::Internal::Type::BaseModel
|
365
|
+
# @!attribute child_access
|
366
|
+
#
|
367
|
+
# @return [MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs]
|
368
|
+
required :child_access,
|
369
|
+
union: -> {
|
370
|
+
MetronomeSDK::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess
|
371
|
+
}
|
372
|
+
|
373
|
+
# @!method initialize(child_access:)
|
374
|
+
# Optional configuration for commit hierarchy access control
|
375
|
+
#
|
376
|
+
# @param child_access [MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs]
|
377
|
+
|
378
|
+
# @see MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration#child_access
|
379
|
+
module ChildAccess
|
380
|
+
extend MetronomeSDK::Internal::Type::Union
|
381
|
+
|
382
|
+
variant -> {
|
383
|
+
MetronomeSDK::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll
|
384
|
+
}
|
385
|
+
|
386
|
+
variant -> {
|
387
|
+
MetronomeSDK::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone
|
388
|
+
}
|
389
|
+
|
390
|
+
variant -> {
|
391
|
+
MetronomeSDK::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs
|
392
|
+
}
|
393
|
+
|
394
|
+
class CommitHierarchyChildAccessAll < MetronomeSDK::Internal::Type::BaseModel
|
395
|
+
# @!attribute type
|
396
|
+
#
|
397
|
+
# @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type]
|
398
|
+
required :type,
|
399
|
+
enum: -> {
|
400
|
+
MetronomeSDK::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type
|
401
|
+
}
|
402
|
+
|
403
|
+
# @!method initialize(type:)
|
404
|
+
# @param type [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type]
|
405
|
+
|
406
|
+
# @see MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll#type
|
407
|
+
module Type
|
408
|
+
extend MetronomeSDK::Internal::Type::Enum
|
409
|
+
|
410
|
+
ALL = :ALL
|
411
|
+
|
412
|
+
# @!method self.values
|
413
|
+
# @return [Array<Symbol>]
|
414
|
+
end
|
415
|
+
end
|
416
|
+
|
417
|
+
class CommitHierarchyChildAccessNone < MetronomeSDK::Internal::Type::BaseModel
|
418
|
+
# @!attribute type
|
419
|
+
#
|
420
|
+
# @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type]
|
421
|
+
required :type,
|
422
|
+
enum: -> {
|
423
|
+
MetronomeSDK::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type
|
424
|
+
}
|
425
|
+
|
426
|
+
# @!method initialize(type:)
|
427
|
+
# @param type [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type]
|
428
|
+
|
429
|
+
# @see MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone#type
|
430
|
+
module Type
|
431
|
+
extend MetronomeSDK::Internal::Type::Enum
|
432
|
+
|
433
|
+
NONE = :NONE
|
434
|
+
|
435
|
+
# @!method self.values
|
436
|
+
# @return [Array<Symbol>]
|
437
|
+
end
|
438
|
+
end
|
439
|
+
|
440
|
+
class CommitHierarchyChildAccessContractIDs < MetronomeSDK::Internal::Type::BaseModel
|
441
|
+
# @!attribute contract_ids
|
442
|
+
#
|
443
|
+
# @return [Array<String>]
|
444
|
+
required :contract_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
|
445
|
+
|
446
|
+
# @!attribute type
|
447
|
+
#
|
448
|
+
# @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type]
|
449
|
+
required :type,
|
450
|
+
enum: -> {
|
451
|
+
MetronomeSDK::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type
|
452
|
+
}
|
453
|
+
|
454
|
+
# @!method initialize(contract_ids:, type:)
|
455
|
+
# @param contract_ids [Array<String>]
|
456
|
+
# @param type [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type]
|
457
|
+
|
458
|
+
# @see MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs#type
|
459
|
+
module Type
|
460
|
+
extend MetronomeSDK::Internal::Type::Enum
|
461
|
+
|
462
|
+
CONTRACT_IDS = :CONTRACT_IDS
|
463
|
+
|
464
|
+
# @!method self.values
|
465
|
+
# @return [Array<Symbol>]
|
466
|
+
end
|
467
|
+
end
|
468
|
+
|
469
|
+
# @!method self.variants
|
470
|
+
# @return [Array(MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs)]
|
471
|
+
end
|
472
|
+
end
|
473
|
+
|
352
474
|
# @see MetronomeSDK::Models::V1::ContractAmendParams::Commit#invoice_schedule
|
353
475
|
class InvoiceSchedule < MetronomeSDK::Internal::Type::BaseModel
|
354
476
|
# @!attribute credit_type_id
|
@@ -554,8 +676,17 @@ module MetronomeSDK
|
|
554
676
|
MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::PaymentGateType
|
555
677
|
}
|
556
678
|
|
679
|
+
# @!attribute precalculated_tax_config
|
680
|
+
# Only applicable if using PRECALCULATED as your tax type.
|
681
|
+
#
|
682
|
+
# @return [MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig::PrecalculatedTaxConfig, nil]
|
683
|
+
optional :precalculated_tax_config,
|
684
|
+
-> {
|
685
|
+
MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::PrecalculatedTaxConfig
|
686
|
+
}
|
687
|
+
|
557
688
|
# @!attribute stripe_config
|
558
|
-
# Only applicable if using
|
689
|
+
# Only applicable if using STRIPE as your payment gate type.
|
559
690
|
#
|
560
691
|
# @return [MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig::StripeConfig, nil]
|
561
692
|
optional :stripe_config,
|
@@ -572,7 +703,7 @@ module MetronomeSDK
|
|
572
703
|
MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::TaxType
|
573
704
|
}
|
574
705
|
|
575
|
-
# @!method initialize(payment_gate_type:, stripe_config: nil, tax_type: nil)
|
706
|
+
# @!method initialize(payment_gate_type:, precalculated_tax_config: nil, stripe_config: nil, tax_type: nil)
|
576
707
|
# Some parameter documentations has been truncated, see
|
577
708
|
# {MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig} for
|
578
709
|
# more details.
|
@@ -581,7 +712,9 @@ module MetronomeSDK
|
|
581
712
|
#
|
582
713
|
# @param payment_gate_type [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig::PaymentGateType] Gate access to the commit balance based on successful collection of payment. Sel
|
583
714
|
#
|
584
|
-
# @param
|
715
|
+
# @param precalculated_tax_config [MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig::PrecalculatedTaxConfig] Only applicable if using PRECALCULATED as your tax type.
|
716
|
+
#
|
717
|
+
# @param stripe_config [MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig::StripeConfig] Only applicable if using STRIPE as your payment gate type.
|
585
718
|
#
|
586
719
|
# @param tax_type [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig::TaxType] Stripe tax is only supported for Stripe payment gateway. Select NONE if you do n
|
587
720
|
|
@@ -602,6 +735,34 @@ module MetronomeSDK
|
|
602
735
|
# @return [Array<Symbol>]
|
603
736
|
end
|
604
737
|
|
738
|
+
# @see MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig#precalculated_tax_config
|
739
|
+
class PrecalculatedTaxConfig < MetronomeSDK::Internal::Type::BaseModel
|
740
|
+
# @!attribute tax_amount
|
741
|
+
# Amount of tax to be applied. This should be in the same currency and
|
742
|
+
# denomination as the commit's invoice schedule
|
743
|
+
#
|
744
|
+
# @return [Float]
|
745
|
+
required :tax_amount, Float
|
746
|
+
|
747
|
+
# @!attribute tax_name
|
748
|
+
# Name of the tax to be applied. This may be used in an invoice line item
|
749
|
+
# description.
|
750
|
+
#
|
751
|
+
# @return [String, nil]
|
752
|
+
optional :tax_name, String
|
753
|
+
|
754
|
+
# @!method initialize(tax_amount:, tax_name: nil)
|
755
|
+
# Some parameter documentations has been truncated, see
|
756
|
+
# {MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig::PrecalculatedTaxConfig}
|
757
|
+
# for more details.
|
758
|
+
#
|
759
|
+
# Only applicable if using PRECALCULATED as your tax type.
|
760
|
+
#
|
761
|
+
# @param tax_amount [Float] Amount of tax to be applied. This should be in the same currency and denominatio
|
762
|
+
#
|
763
|
+
# @param tax_name [String] Name of the tax to be applied. This may be used in an invoice line item descript
|
764
|
+
end
|
765
|
+
|
605
766
|
# @see MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig#stripe_config
|
606
767
|
class StripeConfig < MetronomeSDK::Internal::Type::BaseModel
|
607
768
|
# @!attribute payment_type
|
@@ -613,10 +774,23 @@ module MetronomeSDK
|
|
613
774
|
MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::StripeConfig::PaymentType
|
614
775
|
}
|
615
776
|
|
616
|
-
# @!
|
617
|
-
#
|
777
|
+
# @!attribute invoice_metadata
|
778
|
+
# Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
|
779
|
+
# your payment type.
|
780
|
+
#
|
781
|
+
# @return [Hash{Symbol=>String}, nil]
|
782
|
+
optional :invoice_metadata, MetronomeSDK::Internal::Type::HashOf[String]
|
783
|
+
|
784
|
+
# @!method initialize(payment_type:, invoice_metadata: nil)
|
785
|
+
# Some parameter documentations has been truncated, see
|
786
|
+
# {MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig::StripeConfig}
|
787
|
+
# for more details.
|
788
|
+
#
|
789
|
+
# Only applicable if using STRIPE as your payment gate type.
|
618
790
|
#
|
619
791
|
# @param payment_type [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig::StripeConfig::PaymentType] If left blank, will default to INVOICE
|
792
|
+
#
|
793
|
+
# @param invoice_metadata [Hash{Symbol=>String}] Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
|
620
794
|
|
621
795
|
# If left blank, will default to INVOICE
|
622
796
|
#
|
@@ -642,6 +816,8 @@ module MetronomeSDK
|
|
642
816
|
|
643
817
|
NONE = :NONE
|
644
818
|
STRIPE = :STRIPE
|
819
|
+
ANROK = :ANROK
|
820
|
+
PRECALCULATED = :PRECALCULATED
|
645
821
|
|
646
822
|
# @!method self.values
|
647
823
|
# @return [Array<Symbol>]
|
@@ -735,6 +911,13 @@ module MetronomeSDK
|
|
735
911
|
# @return [String, nil]
|
736
912
|
optional :description, String
|
737
913
|
|
914
|
+
# @!attribute hierarchy_configuration
|
915
|
+
# Optional configuration for credit hierarchy access control
|
916
|
+
#
|
917
|
+
# @return [MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration, nil]
|
918
|
+
optional :hierarchy_configuration,
|
919
|
+
-> { MetronomeSDK::V1::ContractAmendParams::Credit::HierarchyConfiguration }
|
920
|
+
|
738
921
|
# @!attribute name
|
739
922
|
# displayed on invoices
|
740
923
|
#
|
@@ -771,7 +954,7 @@ module MetronomeSDK
|
|
771
954
|
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Credit::Specifier]
|
772
955
|
}
|
773
956
|
|
774
|
-
# @!method initialize(access_schedule:, product_id:, applicable_product_ids: nil, applicable_product_tags: nil, custom_fields: nil, description: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, rate_type: nil, specifiers: nil)
|
957
|
+
# @!method initialize(access_schedule:, product_id:, applicable_product_ids: nil, applicable_product_tags: nil, custom_fields: nil, description: nil, hierarchy_configuration: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, rate_type: nil, specifiers: nil)
|
775
958
|
# Some parameter documentations has been truncated, see
|
776
959
|
# {MetronomeSDK::Models::V1::ContractAmendParams::Credit} for more details.
|
777
960
|
#
|
@@ -787,6 +970,8 @@ module MetronomeSDK
|
|
787
970
|
#
|
788
971
|
# @param description [String] Used only in UI/API. It is not exposed to end customers.
|
789
972
|
#
|
973
|
+
# @param hierarchy_configuration [MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration] Optional configuration for credit hierarchy access control
|
974
|
+
#
|
790
975
|
# @param name [String] displayed on invoices
|
791
976
|
#
|
792
977
|
# @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
|
@@ -847,6 +1032,117 @@ module MetronomeSDK
|
|
847
1032
|
end
|
848
1033
|
end
|
849
1034
|
|
1035
|
+
# @see MetronomeSDK::Models::V1::ContractAmendParams::Credit#hierarchy_configuration
|
1036
|
+
class HierarchyConfiguration < MetronomeSDK::Internal::Type::BaseModel
|
1037
|
+
# @!attribute child_access
|
1038
|
+
#
|
1039
|
+
# @return [MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs]
|
1040
|
+
required :child_access,
|
1041
|
+
union: -> {
|
1042
|
+
MetronomeSDK::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess
|
1043
|
+
}
|
1044
|
+
|
1045
|
+
# @!method initialize(child_access:)
|
1046
|
+
# Optional configuration for credit hierarchy access control
|
1047
|
+
#
|
1048
|
+
# @param child_access [MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs]
|
1049
|
+
|
1050
|
+
# @see MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration#child_access
|
1051
|
+
module ChildAccess
|
1052
|
+
extend MetronomeSDK::Internal::Type::Union
|
1053
|
+
|
1054
|
+
variant -> {
|
1055
|
+
MetronomeSDK::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll
|
1056
|
+
}
|
1057
|
+
|
1058
|
+
variant -> {
|
1059
|
+
MetronomeSDK::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone
|
1060
|
+
}
|
1061
|
+
|
1062
|
+
variant -> {
|
1063
|
+
MetronomeSDK::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs
|
1064
|
+
}
|
1065
|
+
|
1066
|
+
class CommitHierarchyChildAccessAll < MetronomeSDK::Internal::Type::BaseModel
|
1067
|
+
# @!attribute type
|
1068
|
+
#
|
1069
|
+
# @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type]
|
1070
|
+
required :type,
|
1071
|
+
enum: -> {
|
1072
|
+
MetronomeSDK::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type
|
1073
|
+
}
|
1074
|
+
|
1075
|
+
# @!method initialize(type:)
|
1076
|
+
# @param type [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type]
|
1077
|
+
|
1078
|
+
# @see MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll#type
|
1079
|
+
module Type
|
1080
|
+
extend MetronomeSDK::Internal::Type::Enum
|
1081
|
+
|
1082
|
+
ALL = :ALL
|
1083
|
+
|
1084
|
+
# @!method self.values
|
1085
|
+
# @return [Array<Symbol>]
|
1086
|
+
end
|
1087
|
+
end
|
1088
|
+
|
1089
|
+
class CommitHierarchyChildAccessNone < MetronomeSDK::Internal::Type::BaseModel
|
1090
|
+
# @!attribute type
|
1091
|
+
#
|
1092
|
+
# @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type]
|
1093
|
+
required :type,
|
1094
|
+
enum: -> {
|
1095
|
+
MetronomeSDK::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type
|
1096
|
+
}
|
1097
|
+
|
1098
|
+
# @!method initialize(type:)
|
1099
|
+
# @param type [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type]
|
1100
|
+
|
1101
|
+
# @see MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone#type
|
1102
|
+
module Type
|
1103
|
+
extend MetronomeSDK::Internal::Type::Enum
|
1104
|
+
|
1105
|
+
NONE = :NONE
|
1106
|
+
|
1107
|
+
# @!method self.values
|
1108
|
+
# @return [Array<Symbol>]
|
1109
|
+
end
|
1110
|
+
end
|
1111
|
+
|
1112
|
+
class CommitHierarchyChildAccessContractIDs < MetronomeSDK::Internal::Type::BaseModel
|
1113
|
+
# @!attribute contract_ids
|
1114
|
+
#
|
1115
|
+
# @return [Array<String>]
|
1116
|
+
required :contract_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
|
1117
|
+
|
1118
|
+
# @!attribute type
|
1119
|
+
#
|
1120
|
+
# @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type]
|
1121
|
+
required :type,
|
1122
|
+
enum: -> {
|
1123
|
+
MetronomeSDK::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type
|
1124
|
+
}
|
1125
|
+
|
1126
|
+
# @!method initialize(contract_ids:, type:)
|
1127
|
+
# @param contract_ids [Array<String>]
|
1128
|
+
# @param type [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type]
|
1129
|
+
|
1130
|
+
# @see MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs#type
|
1131
|
+
module Type
|
1132
|
+
extend MetronomeSDK::Internal::Type::Enum
|
1133
|
+
|
1134
|
+
CONTRACT_IDS = :CONTRACT_IDS
|
1135
|
+
|
1136
|
+
# @!method self.values
|
1137
|
+
# @return [Array<Symbol>]
|
1138
|
+
end
|
1139
|
+
end
|
1140
|
+
|
1141
|
+
# @!method self.variants
|
1142
|
+
# @return [Array(MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs)]
|
1143
|
+
end
|
1144
|
+
end
|
1145
|
+
|
850
1146
|
# @see MetronomeSDK::Models::V1::ContractAmendParams::Credit#rate_type
|
851
1147
|
module RateType
|
852
1148
|
extend MetronomeSDK::Internal::Type::Enum
|
@@ -1394,11 +1690,8 @@ module MetronomeSDK
|
|
1394
1690
|
# @!attribute tiers
|
1395
1691
|
# Only set for TIERED rate_type.
|
1396
1692
|
#
|
1397
|
-
# @return [Array<MetronomeSDK::Models::
|
1398
|
-
optional :tiers,
|
1399
|
-
-> {
|
1400
|
-
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Override::OverwriteRate::Tier]
|
1401
|
-
}
|
1693
|
+
# @return [Array<MetronomeSDK::Models::Tier>, nil]
|
1694
|
+
optional :tiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Tier] }
|
1402
1695
|
|
1403
1696
|
# @!method initialize(rate_type:, credit_type_id: nil, custom_rate: nil, is_prorated: nil, price: nil, quantity: nil, tiers: nil)
|
1404
1697
|
# Some parameter documentations has been truncated, see
|
@@ -1419,7 +1712,7 @@ module MetronomeSDK
|
|
1419
1712
|
#
|
1420
1713
|
# @param quantity [Float] Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
|
1421
1714
|
#
|
1422
|
-
# @param tiers [Array<MetronomeSDK::Models::
|
1715
|
+
# @param tiers [Array<MetronomeSDK::Models::Tier>] Only set for TIERED rate_type.
|
1423
1716
|
|
1424
1717
|
# @see MetronomeSDK::Models::V1::ContractAmendParams::Override::OverwriteRate#rate_type
|
1425
1718
|
module RateType
|
@@ -1434,22 +1727,6 @@ module MetronomeSDK
|
|
1434
1727
|
# @!method self.values
|
1435
1728
|
# @return [Array<Symbol>]
|
1436
1729
|
end
|
1437
|
-
|
1438
|
-
class Tier < MetronomeSDK::Internal::Type::BaseModel
|
1439
|
-
# @!attribute price
|
1440
|
-
#
|
1441
|
-
# @return [Float]
|
1442
|
-
required :price, Float
|
1443
|
-
|
1444
|
-
# @!attribute size
|
1445
|
-
#
|
1446
|
-
# @return [Float, nil]
|
1447
|
-
optional :size, Float
|
1448
|
-
|
1449
|
-
# @!method initialize(price:, size: nil)
|
1450
|
-
# @param price [Float]
|
1451
|
-
# @param size [Float]
|
1452
|
-
end
|
1453
1730
|
end
|
1454
1731
|
|
1455
1732
|
# Indicates whether the override applies to commit rates or list rates. Can only
|
@@ -7,22 +7,11 @@ module MetronomeSDK
|
|
7
7
|
class ContractAmendResponse < 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::ContractAmendResponse#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
|
@@ -7,22 +7,11 @@ module MetronomeSDK
|
|
7
7
|
class ContractArchiveResponse < 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::ContractArchiveResponse#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
|