metronome-sdk 0.3.0 → 1.0.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 +36 -0
- data/README.md +9 -9
- data/lib/metronome_sdk/internal/body_cursor_page.rb +86 -0
- data/lib/metronome_sdk/internal/cursor_page_without_limit.rb +86 -0
- data/lib/metronome_sdk/internal/transport/base_client.rb +1 -4
- data/lib/metronome_sdk/internal/transport/pooled_net_requester.rb +1 -9
- data/lib/metronome_sdk/internal/type/base_model.rb +6 -13
- data/lib/metronome_sdk/internal/type/union.rb +11 -0
- data/lib/metronome_sdk/internal/util.rb +1 -1
- data/lib/metronome_sdk/models/base_threshold_commit.rb +36 -0
- data/lib/metronome_sdk/models/commit.rb +26 -170
- data/lib/metronome_sdk/models/commit_hierarchy_configuration.rb +98 -0
- data/lib/metronome_sdk/models/commit_rate.rb +48 -0
- data/lib/metronome_sdk/models/commit_specifier.rb +42 -0
- data/lib/metronome_sdk/models/commit_specifier_input.rb +42 -0
- data/lib/metronome_sdk/models/contract.rb +404 -0
- data/lib/metronome_sdk/models/contract_v2.rb +2919 -0
- data/lib/metronome_sdk/models/contract_without_amendments.rb +36 -1126
- data/lib/metronome_sdk/models/credit.rb +9 -156
- data/lib/metronome_sdk/models/discount.rb +2 -1
- data/lib/metronome_sdk/models/hierarchy_configuration.rb +76 -0
- data/lib/metronome_sdk/models/override.rb +6 -101
- data/lib/metronome_sdk/models/override_tier.rb +21 -0
- data/lib/metronome_sdk/models/overwrite_rate.rb +82 -0
- data/lib/metronome_sdk/models/payment_gate_config.rb +149 -0
- data/lib/metronome_sdk/models/payment_gate_config_v2.rb +149 -0
- data/lib/metronome_sdk/models/prepaid_balance_threshold_configuration.rb +100 -0
- data/lib/metronome_sdk/models/prepaid_balance_threshold_configuration_v2.rb +102 -0
- data/lib/metronome_sdk/models/pro_service.rb +2 -1
- data/lib/metronome_sdk/models/recurring_commit_subscription_config.rb +51 -0
- data/lib/metronome_sdk/models/scheduled_charge.rb +2 -1
- data/lib/metronome_sdk/models/spend_threshold_configuration.rb +44 -0
- data/lib/metronome_sdk/models/spend_threshold_configuration_v2.rb +44 -0
- data/lib/metronome_sdk/models/subscription.rb +227 -0
- data/lib/metronome_sdk/models/update_base_threshold_commit.rb +36 -0
- data/lib/metronome_sdk/models/v1/alert_create_params.rb +4 -6
- data/lib/metronome_sdk/models/v1/billable_metric_create_params.rb +1 -2
- data/lib/metronome_sdk/models/v1/billable_metric_list_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/billable_metric_retrieve_response.rb +4 -7
- data/lib/metronome_sdk/models/v1/contract_amend_params.rb +57 -411
- data/lib/metronome_sdk/models/v1/contract_create_historical_invoices_params.rb +7 -16
- data/lib/metronome_sdk/models/v1/contract_create_params.rb +236 -1478
- data/lib/metronome_sdk/models/v1/contract_list_balances_response.rb +6 -23
- data/lib/metronome_sdk/models/v1/contract_list_response.rb +3 -1153
- data/lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rb +2 -6
- data/lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rb +5 -50
- data/lib/metronome_sdk/models/v1/contract_retrieve_response.rb +3 -1154
- data/lib/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_params.rb +1 -3
- data/lib/metronome_sdk/models/v1/contracts/product_create_params.rb +2 -1
- data/lib/metronome_sdk/models/v1/contracts/product_list_response.rb +8 -1
- data/lib/metronome_sdk/models/v1/contracts/product_retrieve_response.rb +8 -1
- data/lib/metronome_sdk/models/v1/contracts/quantity_rounding.rb +1 -4
- data/lib/metronome_sdk/models/v1/contracts/rate_card_create_params.rb +4 -7
- data/lib/metronome_sdk/models/v1/contracts/rate_card_list_response.rb +10 -1
- data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rb +2 -6
- data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rb +5 -50
- data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rb +10 -1
- data/lib/metronome_sdk/models/v1/contracts/rate_card_update_params.rb +1 -3
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_params.rb +1 -3
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rb +6 -61
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb +3 -49
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rb +4 -51
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_params.rb +2 -6
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rb +5 -49
- data/lib/metronome_sdk/models/v1/credit_grant_list_entries_response.rb +103 -123
- data/lib/metronome_sdk/models/v1/credit_grant_list_response.rb +3 -5
- data/lib/metronome_sdk/models/v1/custom_field_list_keys_params.rb +1 -3
- data/lib/metronome_sdk/models/v1/custom_field_list_keys_response.rb +41 -58
- data/lib/metronome_sdk/models/v1/custom_field_set_values_params.rb +5 -1
- data/lib/metronome_sdk/models/v1/customer.rb +2 -1
- data/lib/metronome_sdk/models/v1/customer_create_params.rb +37 -11
- data/lib/metronome_sdk/models/v1/customer_detail.rb +2 -1
- data/lib/metronome_sdk/models/v1/customer_list_billable_metrics_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/customer_preview_events_params.rb +1 -3
- data/lib/metronome_sdk/models/v1/customer_retrieve_billing_configurations_params.rb +28 -0
- data/lib/metronome_sdk/models/v1/customer_retrieve_billing_configurations_response.rb +128 -0
- data/lib/metronome_sdk/models/v1/customer_set_billing_configurations_params.rb +143 -0
- data/lib/metronome_sdk/models/v1/customers/alert_list_params.rb +1 -3
- data/lib/metronome_sdk/models/v1/customers/alert_retrieve_params.rb +30 -1
- data/lib/metronome_sdk/models/v1/customers/billing_config_create_params.rb +2 -0
- data/lib/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rb +2 -0
- data/lib/metronome_sdk/models/v1/customers/commit_create_params.rb +10 -60
- data/lib/metronome_sdk/models/v1/customers/credit_create_params.rb +6 -48
- data/lib/metronome_sdk/models/v1/customers/customer_alert.rb +8 -16
- data/lib/metronome_sdk/models/v1/customers/invoice.rb +61 -48
- data/lib/metronome_sdk/models/v1/customers/invoice_list_breakdowns_params.rb +1 -4
- data/lib/metronome_sdk/models/v1/customers/plan_add_params.rb +2 -6
- data/lib/metronome_sdk/models/v1/customers/plan_list_response.rb +2 -1
- data/lib/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rb +4 -11
- data/lib/metronome_sdk/models/v1/plan_detail.rb +9 -5
- data/lib/metronome_sdk/models/v1/plan_list_charges_response.rb +2 -1
- data/lib/metronome_sdk/models/v1/plan_list_customers_response.rb +2 -1
- data/lib/metronome_sdk/models/v1/plan_list_response.rb +5 -1
- data/lib/metronome_sdk/models/v1/usage_ingest_params.rb +1 -4
- data/lib/metronome_sdk/models/v1/usage_list_params.rb +1 -3
- data/lib/metronome_sdk/models/v1/usage_list_response.rb +45 -62
- data/lib/metronome_sdk/models/v1/usage_search_response.rb +4 -7
- data/lib/metronome_sdk/models/v2/contract_edit_commit_params.rb +29 -58
- data/lib/metronome_sdk/models/v2/contract_edit_credit_params.rb +26 -49
- data/lib/metronome_sdk/models/v2/contract_edit_params.rb +414 -2310
- data/lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb +337 -2424
- data/lib/metronome_sdk/models/v2/contract_list_response.rb +3 -4520
- data/lib/metronome_sdk/models/v2/contract_retrieve_response.rb +3 -4528
- data/lib/metronome_sdk/models.rb +38 -0
- data/lib/metronome_sdk/resources/v1/alerts.rb +72 -2
- data/lib/metronome_sdk/resources/v1/audit_logs.rb +39 -4
- data/lib/metronome_sdk/resources/v1/billable_metrics.rb +54 -4
- data/lib/metronome_sdk/resources/v1/contracts/products.rb +25 -6
- data/lib/metronome_sdk/resources/v1/contracts/rate_cards/product_orders.rb +7 -2
- data/lib/metronome_sdk/resources/v1/contracts/rate_cards/rates.rb +10 -2
- data/lib/metronome_sdk/resources/v1/contracts/rate_cards.rb +109 -10
- data/lib/metronome_sdk/resources/v1/contracts.rb +254 -18
- data/lib/metronome_sdk/resources/v1/credit_grants.rb +2 -1
- data/lib/metronome_sdk/resources/v1/custom_fields.rb +51 -14
- data/lib/metronome_sdk/resources/v1/customers/alerts.rb +103 -8
- data/lib/metronome_sdk/resources/v1/customers/commits.rb +119 -9
- data/lib/metronome_sdk/resources/v1/customers/credits.rb +104 -8
- data/lib/metronome_sdk/resources/v1/customers/invoices.rb +124 -8
- data/lib/metronome_sdk/resources/v1/customers.rb +169 -12
- data/lib/metronome_sdk/resources/v1/dashboards.rb +29 -3
- data/lib/metronome_sdk/resources/v1/invoices.rb +23 -2
- data/lib/metronome_sdk/resources/v1/pricing_units.rb +6 -1
- data/lib/metronome_sdk/resources/v1/services.rb +6 -4
- data/lib/metronome_sdk/resources/v1/usage.rb +185 -12
- data/lib/metronome_sdk/resources/v2/contracts.rb +114 -18
- data/lib/metronome_sdk/version.rb +1 -1
- data/lib/metronome_sdk.rb +24 -3
- data/rbi/metronome_sdk/errors.rbi +2 -2
- data/rbi/metronome_sdk/internal/body_cursor_page.rbi +22 -0
- data/rbi/metronome_sdk/internal/cursor_page_without_limit.rbi +22 -0
- data/rbi/metronome_sdk/models/base_threshold_commit.rbi +58 -0
- data/rbi/metronome_sdk/models/commit.rbi +26 -348
- data/rbi/metronome_sdk/models/commit_hierarchy_configuration.rbi +280 -0
- data/rbi/metronome_sdk/models/commit_rate.rbi +85 -0
- data/rbi/metronome_sdk/models/commit_specifier.rbi +71 -0
- data/rbi/metronome_sdk/models/commit_specifier_input.rbi +74 -0
- data/rbi/metronome_sdk/models/contract.rbi +768 -0
- data/rbi/metronome_sdk/models/contract_v2.rbi +5822 -0
- data/rbi/metronome_sdk/models/contract_without_amendments.rbi +184 -2507
- data/rbi/metronome_sdk/models/credit.rbi +10 -348
- data/rbi/metronome_sdk/models/discount.rbi +2 -0
- data/rbi/metronome_sdk/models/hierarchy_configuration.rbi +180 -0
- data/rbi/metronome_sdk/models/override.rbi +8 -193
- data/rbi/metronome_sdk/models/override_tier.rbi +29 -0
- data/rbi/metronome_sdk/models/overwrite_rate.rbi +137 -0
- data/rbi/metronome_sdk/models/payment_gate_config.rbi +312 -0
- data/rbi/metronome_sdk/models/payment_gate_config_v2.rbi +321 -0
- data/rbi/metronome_sdk/models/prepaid_balance_threshold_configuration.rbi +183 -0
- data/rbi/metronome_sdk/models/prepaid_balance_threshold_configuration_v2.rbi +188 -0
- data/rbi/metronome_sdk/models/pro_service.rbi +2 -0
- data/rbi/metronome_sdk/models/recurring_commit_subscription_config.rbi +125 -0
- data/rbi/metronome_sdk/models/scheduled_charge.rbi +2 -0
- data/rbi/metronome_sdk/models/spend_threshold_configuration.rbi +76 -0
- data/rbi/metronome_sdk/models/spend_threshold_configuration_v2.rbi +78 -0
- data/rbi/metronome_sdk/models/subscription.rbi +460 -0
- data/rbi/metronome_sdk/models/update_base_threshold_commit.rbi +61 -0
- data/rbi/metronome_sdk/models/v1/alert_create_params.rbi +6 -3
- data/rbi/metronome_sdk/models/v1/billable_metric_list_response.rbi +2 -0
- data/rbi/metronome_sdk/models/v1/billable_metric_retrieve_response.rbi +2 -0
- data/rbi/metronome_sdk/models/v1/contract_amend_params.rbi +44 -768
- data/rbi/metronome_sdk/models/v1/contract_create_historical_invoices_params.rbi +2 -0
- data/rbi/metronome_sdk/models/v1/contract_create_params.rbi +1550 -4079
- data/rbi/metronome_sdk/models/v1/contract_list_balances_response.rbi +8 -59
- data/rbi/metronome_sdk/models/v1/contract_list_response.rbi +5 -2420
- data/rbi/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rbi +6 -129
- data/rbi/metronome_sdk/models/v1/contract_retrieve_response.rbi +4 -2419
- data/rbi/metronome_sdk/models/v1/contracts/product_create_params.rbi +2 -0
- data/rbi/metronome_sdk/models/v1/contracts/product_list_response.rbi +2 -0
- data/rbi/metronome_sdk/models/v1/contracts/product_retrieve_response.rbi +2 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_create_params.rbi +2 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_list_response.rbi +2 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rbi +6 -129
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rbi +2 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rbi +4 -129
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbi +4 -129
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rbi +4 -129
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rbi +6 -129
- data/rbi/metronome_sdk/models/v1/credit_grant_list_entries_response.rbi +147 -198
- data/rbi/metronome_sdk/models/v1/credit_grant_list_response.rbi +2 -0
- data/rbi/metronome_sdk/models/v1/custom_field_list_keys_response.rbi +117 -165
- data/rbi/metronome_sdk/models/v1/custom_field_set_values_params.rbi +8 -1
- data/rbi/metronome_sdk/models/v1/customer.rbi +2 -0
- data/rbi/metronome_sdk/models/v1/customer_create_params.rbi +88 -3
- data/rbi/metronome_sdk/models/v1/customer_detail.rbi +2 -0
- data/rbi/metronome_sdk/models/v1/customer_list_billable_metrics_response.rbi +2 -0
- data/rbi/metronome_sdk/models/v1/customer_retrieve_billing_configurations_params.rbi +51 -0
- data/rbi/metronome_sdk/models/v1/customer_retrieve_billing_configurations_response.rbi +265 -0
- data/rbi/metronome_sdk/models/v1/customer_set_billing_configurations_params.rbi +348 -0
- data/rbi/metronome_sdk/models/v1/customers/alert_retrieve_params.rbi +60 -0
- data/rbi/metronome_sdk/models/v1/customers/billing_config_create_params.rbi +10 -0
- data/rbi/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbi +10 -0
- data/rbi/metronome_sdk/models/v1/customers/commit_create_params.rbi +6 -90
- data/rbi/metronome_sdk/models/v1/customers/credit_create_params.rbi +6 -90
- data/rbi/metronome_sdk/models/v1/customers/customer_alert.rbi +6 -3
- data/rbi/metronome_sdk/models/v1/customers/invoice.rbi +70 -10
- data/rbi/metronome_sdk/models/v1/customers/plan_list_response.rbi +2 -0
- data/rbi/metronome_sdk/models/v1/plan_detail.rbi +2 -0
- data/rbi/metronome_sdk/models/v1/plan_list_charges_response.rbi +2 -0
- data/rbi/metronome_sdk/models/v1/plan_list_customers_response.rbi +2 -0
- data/rbi/metronome_sdk/models/v1/plan_list_response.rbi +8 -1
- data/rbi/metronome_sdk/models/v1/usage_list_response.rbi +45 -86
- data/rbi/metronome_sdk/models/v1/usage_search_response.rbi +2 -0
- data/rbi/metronome_sdk/models/v2/contract_edit_commit_params.rbi +56 -76
- data/rbi/metronome_sdk/models/v2/contract_edit_credit_params.rbi +56 -76
- data/rbi/metronome_sdk/models/v2/contract_edit_params.rbi +3419 -7270
- data/rbi/metronome_sdk/models/v2/contract_get_edit_history_response.rbi +1140 -6062
- data/rbi/metronome_sdk/models/v2/contract_list_response.rbi +5 -9867
- data/rbi/metronome_sdk/models/v2/contract_retrieve_response.rbi +6 -9866
- data/rbi/metronome_sdk/models.rbi +44 -0
- data/rbi/metronome_sdk/resources/v1/alerts.rbi +72 -2
- data/rbi/metronome_sdk/resources/v1/audit_logs.rbi +39 -4
- data/rbi/metronome_sdk/resources/v1/billable_metrics.rbi +54 -4
- data/rbi/metronome_sdk/resources/v1/contracts/products.rbi +25 -5
- data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/product_orders.rbi +7 -2
- data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbi +10 -3
- data/rbi/metronome_sdk/resources/v1/contracts/rate_cards.rbi +109 -9
- data/rbi/metronome_sdk/resources/v1/contracts.rbi +257 -16
- data/rbi/metronome_sdk/resources/v1/credit_grants.rbi +5 -1
- data/rbi/metronome_sdk/resources/v1/custom_fields.rbi +57 -14
- data/rbi/metronome_sdk/resources/v1/customers/alerts.rbi +108 -5
- data/rbi/metronome_sdk/resources/v1/customers/commits.rbi +119 -10
- data/rbi/metronome_sdk/resources/v1/customers/credits.rbi +104 -9
- data/rbi/metronome_sdk/resources/v1/customers/invoices.rbi +123 -7
- data/rbi/metronome_sdk/resources/v1/customers.rbi +156 -11
- data/rbi/metronome_sdk/resources/v1/dashboards.rbi +29 -3
- data/rbi/metronome_sdk/resources/v1/invoices.rbi +23 -2
- data/rbi/metronome_sdk/resources/v1/pricing_units.rbi +6 -1
- data/rbi/metronome_sdk/resources/v1/services.rbi +6 -4
- data/rbi/metronome_sdk/resources/v1/usage.rbi +188 -12
- data/rbi/metronome_sdk/resources/v2/contracts.rbi +120 -23
- data/sig/metronome_sdk/internal/body_cursor_page.rbs +13 -0
- data/sig/metronome_sdk/internal/cursor_page_without_limit.rbs +13 -0
- data/sig/metronome_sdk/models/base_threshold_commit.rbs +26 -0
- data/sig/metronome_sdk/models/commit.rbs +17 -170
- data/sig/metronome_sdk/models/commit_hierarchy_configuration.rbs +117 -0
- data/sig/metronome_sdk/models/commit_rate.rbs +48 -0
- data/sig/metronome_sdk/models/commit_specifier.rbs +47 -0
- data/sig/metronome_sdk/models/commit_specifier_input.rbs +47 -0
- data/sig/metronome_sdk/models/contract.rbs +398 -0
- data/sig/metronome_sdk/models/contract_v2.rbs +2881 -0
- data/sig/metronome_sdk/models/contract_without_amendments.rbs +54 -976
- data/sig/metronome_sdk/models/credit.rbs +12 -170
- data/sig/metronome_sdk/models/hierarchy_configuration.rbs +71 -0
- data/sig/metronome_sdk/models/override.rbs +12 -101
- data/sig/metronome_sdk/models/override_tier.rbs +17 -0
- data/sig/metronome_sdk/models/overwrite_rate.rbs +78 -0
- data/sig/metronome_sdk/models/payment_gate_config.rbs +123 -0
- data/sig/metronome_sdk/models/payment_gate_config_v2.rbs +123 -0
- data/sig/metronome_sdk/models/prepaid_balance_threshold_configuration.rbs +82 -0
- data/sig/metronome_sdk/models/prepaid_balance_threshold_configuration_v2.rbs +82 -0
- data/sig/metronome_sdk/models/recurring_commit_subscription_config.rbs +51 -0
- data/sig/metronome_sdk/models/spend_threshold_configuration.rbs +35 -0
- data/sig/metronome_sdk/models/spend_threshold_configuration_v2.rbs +35 -0
- data/sig/metronome_sdk/models/subscription.rbs +215 -0
- data/sig/metronome_sdk/models/update_base_threshold_commit.rbs +28 -0
- data/sig/metronome_sdk/models/v1/alert_create_params.rbs +4 -2
- data/sig/metronome_sdk/models/v1/contract_amend_params.rbs +24 -340
- data/sig/metronome_sdk/models/v1/contract_create_params.rbs +168 -1219
- data/sig/metronome_sdk/models/v1/contract_list_balances_response.rbs +4 -25
- data/sig/metronome_sdk/models/v1/contract_list_response.rbs +4 -1041
- data/sig/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rbs +6 -54
- data/sig/metronome_sdk/models/v1/contract_retrieve_response.rbs +4 -1041
- data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rbs +6 -54
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rbs +6 -54
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbs +6 -54
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rbs +6 -54
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rbs +6 -54
- data/sig/metronome_sdk/models/v1/credit_grant_list_entries_response.rbs +72 -94
- data/sig/metronome_sdk/models/v1/custom_field_list_keys_response.rbs +53 -75
- data/sig/metronome_sdk/models/v1/customer_create_params.rbs +31 -4
- data/sig/metronome_sdk/models/v1/customer_retrieve_billing_configurations_params.rbs +32 -0
- data/sig/metronome_sdk/models/v1/customer_retrieve_billing_configurations_response.rbs +113 -0
- data/sig/metronome_sdk/models/v1/customer_set_billing_configurations_params.rbs +133 -0
- data/sig/metronome_sdk/models/v1/customers/alert_retrieve_params.rbs +21 -0
- data/sig/metronome_sdk/models/v1/customers/billing_config_create_params.rbs +7 -1
- data/sig/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbs +6 -1
- data/sig/metronome_sdk/models/v1/customers/commit_create_params.rbs +6 -50
- data/sig/metronome_sdk/models/v1/customers/credit_create_params.rbs +6 -50
- data/sig/metronome_sdk/models/v1/customers/customer_alert.rbs +4 -2
- data/sig/metronome_sdk/models/v1/usage_list_response.rbs +33 -55
- data/sig/metronome_sdk/models/v2/contract_edit_commit_params.rbs +19 -43
- data/sig/metronome_sdk/models/v2/contract_edit_credit_params.rbs +19 -43
- data/sig/metronome_sdk/models/v2/contract_edit_params.rbs +361 -1917
- data/sig/metronome_sdk/models/v2/contract_get_edit_history_response.rbs +242 -2252
- data/sig/metronome_sdk/models/v2/contract_list_response.rbs +4 -4426
- data/sig/metronome_sdk/models/v2/contract_retrieve_response.rbs +4 -4426
- data/sig/metronome_sdk/models.rbs +38 -0
- data/sig/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbs +1 -1
- data/sig/metronome_sdk/resources/v1/contracts.rbs +3 -3
- data/sig/metronome_sdk/resources/v1/credit_grants.rbs +1 -1
- data/sig/metronome_sdk/resources/v1/custom_fields.rbs +1 -1
- data/sig/metronome_sdk/resources/v1/customers/alerts.rbs +2 -1
- data/sig/metronome_sdk/resources/v1/customers/commits.rbs +2 -2
- data/sig/metronome_sdk/resources/v1/customers/credits.rbs +2 -2
- data/sig/metronome_sdk/resources/v1/customers.rbs +11 -0
- data/sig/metronome_sdk/resources/v1/usage.rbs +1 -1
- data/sig/metronome_sdk/resources/v2/contracts.rbs +7 -4
- metadata +74 -11
- data/lib/metronome_sdk/models/v1/customers/alert_list_response.rb +0 -29
- data/lib/metronome_sdk/models/v1/customers/commit_list_response.rb +0 -26
- data/lib/metronome_sdk/models/v1/customers/credit_list_response.rb +0 -26
- data/rbi/metronome_sdk/models/v1/customers/alert_list_response.rbi +0 -46
- data/rbi/metronome_sdk/models/v1/customers/commit_list_response.rbi +0 -45
- data/rbi/metronome_sdk/models/v1/customers/credit_list_response.rbi +0 -45
- data/sig/metronome_sdk/models/v1/customers/alert_list_response.rbs +0 -29
- data/sig/metronome_sdk/models/v1/customers/commit_list_response.rbs +0 -26
- data/sig/metronome_sdk/models/v1/customers/credit_list_response.rbs +0 -26
@@ -13,6 +13,7 @@ module MetronomeSDK
|
|
13
13
|
required :entitled, MetronomeSDK::Internal::Type::Boolean
|
14
14
|
|
15
15
|
# @!attribute product_custom_fields
|
16
|
+
# Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
16
17
|
#
|
17
18
|
# @return [Hash{Symbol=>String}]
|
18
19
|
required :product_custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
|
@@ -52,8 +53,8 @@ module MetronomeSDK
|
|
52
53
|
# A distinct rate on the rate card. You can choose to use this rate rather than
|
53
54
|
# list rate when consuming a credit or commit.
|
54
55
|
#
|
55
|
-
# @return [MetronomeSDK::Models::
|
56
|
-
optional :commit_rate, -> { MetronomeSDK::
|
56
|
+
# @return [MetronomeSDK::Models::CommitRate, nil]
|
57
|
+
optional :commit_rate, -> { MetronomeSDK::CommitRate }
|
57
58
|
|
58
59
|
# @!attribute ending_before
|
59
60
|
#
|
@@ -72,7 +73,7 @@ module MetronomeSDK
|
|
72
73
|
#
|
73
74
|
# @param entitled [Boolean]
|
74
75
|
#
|
75
|
-
# @param product_custom_fields [Hash{Symbol=>String}]
|
76
|
+
# @param product_custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
76
77
|
#
|
77
78
|
# @param product_id [String]
|
78
79
|
#
|
@@ -86,7 +87,7 @@ module MetronomeSDK
|
|
86
87
|
#
|
87
88
|
# @param billing_frequency [Symbol, MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse::BillingFrequency]
|
88
89
|
#
|
89
|
-
# @param commit_rate [MetronomeSDK::Models::
|
90
|
+
# @param commit_rate [MetronomeSDK::Models::CommitRate] A distinct rate on the rate card. You can choose to use this rate rather than li
|
90
91
|
#
|
91
92
|
# @param ending_before [Time]
|
92
93
|
#
|
@@ -104,51 +105,6 @@ module MetronomeSDK
|
|
104
105
|
# @!method self.values
|
105
106
|
# @return [Array<Symbol>]
|
106
107
|
end
|
107
|
-
|
108
|
-
# @see MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse#commit_rate
|
109
|
-
class CommitRate < MetronomeSDK::Internal::Type::BaseModel
|
110
|
-
# @!attribute rate_type
|
111
|
-
#
|
112
|
-
# @return [Symbol, MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse::CommitRate::RateType]
|
113
|
-
required :rate_type,
|
114
|
-
enum: -> { MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse::CommitRate::RateType }
|
115
|
-
|
116
|
-
# @!attribute price
|
117
|
-
# Commit rate price. For FLAT rate_type, this must be >=0.
|
118
|
-
#
|
119
|
-
# @return [Float, nil]
|
120
|
-
optional :price, Float
|
121
|
-
|
122
|
-
# @!attribute tiers
|
123
|
-
# Only set for TIERED rate_type.
|
124
|
-
#
|
125
|
-
# @return [Array<MetronomeSDK::Models::Tier>, nil]
|
126
|
-
optional :tiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Tier] }
|
127
|
-
|
128
|
-
# @!method initialize(rate_type:, price: nil, tiers: nil)
|
129
|
-
# A distinct rate on the rate card. You can choose to use this rate rather than
|
130
|
-
# list rate when consuming a credit or commit.
|
131
|
-
#
|
132
|
-
# @param rate_type [Symbol, MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse::CommitRate::RateType]
|
133
|
-
#
|
134
|
-
# @param price [Float] Commit rate price. For FLAT rate_type, this must be >=0.
|
135
|
-
#
|
136
|
-
# @param tiers [Array<MetronomeSDK::Models::Tier>] Only set for TIERED rate_type.
|
137
|
-
|
138
|
-
# @see MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse::CommitRate#rate_type
|
139
|
-
module RateType
|
140
|
-
extend MetronomeSDK::Internal::Type::Enum
|
141
|
-
|
142
|
-
FLAT = :FLAT
|
143
|
-
PERCENTAGE = :PERCENTAGE
|
144
|
-
SUBSCRIPTION = :SUBSCRIPTION
|
145
|
-
TIERED = :TIERED
|
146
|
-
CUSTOM = :CUSTOM
|
147
|
-
|
148
|
-
# @!method self.values
|
149
|
-
# @return [Array<Symbol>]
|
150
|
-
end
|
151
|
-
end
|
152
108
|
end
|
153
109
|
end
|
154
110
|
end
|
@@ -5,153 +5,133 @@ module MetronomeSDK
|
|
5
5
|
module V1
|
6
6
|
# @see MetronomeSDK::Resources::V1::CreditGrants#list_entries
|
7
7
|
class CreditGrantListEntriesResponse < MetronomeSDK::Internal::Type::BaseModel
|
8
|
-
# @!attribute
|
8
|
+
# @!attribute customer_id
|
9
9
|
#
|
10
|
-
# @return [
|
11
|
-
required :
|
12
|
-
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data] }
|
10
|
+
# @return [String]
|
11
|
+
required :customer_id, String
|
13
12
|
|
14
|
-
# @!attribute
|
13
|
+
# @!attribute ledgers
|
15
14
|
#
|
16
|
-
# @return [
|
17
|
-
required :
|
15
|
+
# @return [Array<MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger>]
|
16
|
+
required :ledgers,
|
17
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger] }
|
18
18
|
|
19
|
-
# @!method initialize(
|
20
|
-
# @param
|
21
|
-
# @param
|
19
|
+
# @!method initialize(customer_id:, ledgers:)
|
20
|
+
# @param customer_id [String]
|
21
|
+
# @param ledgers [Array<MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger>]
|
22
22
|
|
23
|
-
class
|
24
|
-
# @!attribute
|
23
|
+
class Ledger < MetronomeSDK::Internal::Type::BaseModel
|
24
|
+
# @!attribute credit_type
|
25
25
|
#
|
26
|
-
# @return [
|
27
|
-
required :
|
26
|
+
# @return [MetronomeSDK::Models::CreditTypeData]
|
27
|
+
required :credit_type, -> { MetronomeSDK::CreditTypeData }
|
28
28
|
|
29
|
-
# @!attribute
|
29
|
+
# @!attribute ending_balance
|
30
|
+
# the effective balances at the end of the specified time window
|
30
31
|
#
|
31
|
-
# @return [
|
32
|
-
required :
|
33
|
-
-> { MetronomeSDK::
|
32
|
+
# @return [MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger::EndingBalance]
|
33
|
+
required :ending_balance,
|
34
|
+
-> { MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger::EndingBalance }
|
34
35
|
|
35
|
-
# @!
|
36
|
-
#
|
37
|
-
# @
|
36
|
+
# @!attribute entries
|
37
|
+
#
|
38
|
+
# @return [Array<MetronomeSDK::Models::V1::CreditLedgerEntry>]
|
39
|
+
required :entries, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::CreditLedgerEntry] }
|
40
|
+
|
41
|
+
# @!attribute pending_entries
|
42
|
+
#
|
43
|
+
# @return [Array<MetronomeSDK::Models::V1::CreditLedgerEntry>]
|
44
|
+
required :pending_entries,
|
45
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::CreditLedgerEntry] }
|
46
|
+
|
47
|
+
# @!attribute starting_balance
|
48
|
+
#
|
49
|
+
# @return [MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger::StartingBalance]
|
50
|
+
required :starting_balance,
|
51
|
+
-> { MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger::StartingBalance }
|
52
|
+
|
53
|
+
# @!method initialize(credit_type:, ending_balance:, entries:, pending_entries:, starting_balance:)
|
54
|
+
# @param credit_type [MetronomeSDK::Models::CreditTypeData]
|
55
|
+
#
|
56
|
+
# @param ending_balance [MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger::EndingBalance] the effective balances at the end of the specified time window
|
57
|
+
#
|
58
|
+
# @param entries [Array<MetronomeSDK::Models::V1::CreditLedgerEntry>]
|
59
|
+
#
|
60
|
+
# @param pending_entries [Array<MetronomeSDK::Models::V1::CreditLedgerEntry>]
|
61
|
+
#
|
62
|
+
# @param starting_balance [MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger::StartingBalance]
|
38
63
|
|
39
|
-
|
40
|
-
|
64
|
+
# @see MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger#ending_balance
|
65
|
+
class EndingBalance < MetronomeSDK::Internal::Type::BaseModel
|
66
|
+
# @!attribute effective_at
|
67
|
+
# the ending_before request parameter (if supplied) or the current billing
|
68
|
+
# period's end date
|
41
69
|
#
|
42
|
-
# @return [
|
43
|
-
required :
|
70
|
+
# @return [Time]
|
71
|
+
required :effective_at, Time
|
44
72
|
|
45
|
-
# @!attribute
|
46
|
-
# the
|
73
|
+
# @!attribute excluding_pending
|
74
|
+
# the ending balance, including the balance of all grants that have not expired
|
75
|
+
# before the effective_at date and deductions that happened before the
|
76
|
+
# effective_at date
|
47
77
|
#
|
48
|
-
# @return [
|
49
|
-
required :
|
50
|
-
-> { MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::EndingBalance }
|
78
|
+
# @return [Float]
|
79
|
+
required :excluding_pending, Float
|
51
80
|
|
52
|
-
# @!attribute
|
81
|
+
# @!attribute including_pending
|
82
|
+
# the excluding_pending balance plus any pending invoice deductions and
|
83
|
+
# expirations that will happen by the effective_at date
|
53
84
|
#
|
54
|
-
# @return [
|
55
|
-
required :
|
56
|
-
-> {
|
57
|
-
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::CreditLedgerEntry]
|
58
|
-
}
|
85
|
+
# @return [Float]
|
86
|
+
required :including_pending, Float
|
59
87
|
|
60
|
-
# @!
|
88
|
+
# @!method initialize(effective_at:, excluding_pending:, including_pending:)
|
89
|
+
# Some parameter documentations has been truncated, see
|
90
|
+
# {MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger::EndingBalance}
|
91
|
+
# for more details.
|
92
|
+
#
|
93
|
+
# the effective balances at the end of the specified time window
|
94
|
+
#
|
95
|
+
# @param effective_at [Time] the ending_before request parameter (if supplied) or the current billing period'
|
96
|
+
#
|
97
|
+
# @param excluding_pending [Float] the ending balance, including the balance of all grants that have not expired be
|
61
98
|
#
|
62
|
-
# @
|
63
|
-
|
64
|
-
|
99
|
+
# @param including_pending [Float] the excluding_pending balance plus any pending invoice deductions and expiration
|
100
|
+
end
|
101
|
+
|
102
|
+
# @see MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger#starting_balance
|
103
|
+
class StartingBalance < MetronomeSDK::Internal::Type::BaseModel
|
104
|
+
# @!attribute effective_at
|
105
|
+
# the starting_on request parameter (if supplied) or the first credit grant's
|
106
|
+
# effective_at date
|
107
|
+
#
|
108
|
+
# @return [Time]
|
109
|
+
required :effective_at, Time
|
65
110
|
|
66
|
-
# @!attribute
|
111
|
+
# @!attribute excluding_pending
|
112
|
+
# the starting balance, including all posted grants, deductions, and expirations
|
113
|
+
# that happened at or before the effective_at timestamp
|
67
114
|
#
|
68
|
-
# @return [
|
69
|
-
required :
|
70
|
-
-> { MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::StartingBalance }
|
115
|
+
# @return [Float]
|
116
|
+
required :excluding_pending, Float
|
71
117
|
|
72
|
-
# @!
|
73
|
-
#
|
118
|
+
# @!attribute including_pending
|
119
|
+
# the excluding_pending balance plus any pending activity that has not been posted
|
120
|
+
# at the time of the query
|
74
121
|
#
|
75
|
-
# @
|
122
|
+
# @return [Float]
|
123
|
+
required :including_pending, Float
|
124
|
+
|
125
|
+
# @!method initialize(effective_at:, excluding_pending:, including_pending:)
|
126
|
+
# Some parameter documentations has been truncated, see
|
127
|
+
# {MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger::StartingBalance}
|
128
|
+
# for more details.
|
76
129
|
#
|
77
|
-
# @param
|
130
|
+
# @param effective_at [Time] the starting_on request parameter (if supplied) or the first credit grant's effe
|
78
131
|
#
|
79
|
-
# @param
|
132
|
+
# @param excluding_pending [Float] the starting balance, including all posted grants, deductions, and expirations t
|
80
133
|
#
|
81
|
-
# @param
|
82
|
-
|
83
|
-
# @see MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger#ending_balance
|
84
|
-
class EndingBalance < MetronomeSDK::Internal::Type::BaseModel
|
85
|
-
# @!attribute effective_at
|
86
|
-
# the ending_before request parameter (if supplied) or the current billing
|
87
|
-
# period's end date
|
88
|
-
#
|
89
|
-
# @return [Time]
|
90
|
-
required :effective_at, Time
|
91
|
-
|
92
|
-
# @!attribute excluding_pending
|
93
|
-
# the ending balance, including the balance of all grants that have not expired
|
94
|
-
# before the effective_at date and deductions that happened before the
|
95
|
-
# effective_at date
|
96
|
-
#
|
97
|
-
# @return [Float]
|
98
|
-
required :excluding_pending, Float
|
99
|
-
|
100
|
-
# @!attribute including_pending
|
101
|
-
# the excluding_pending balance plus any pending invoice deductions and
|
102
|
-
# expirations that will happen by the effective_at date
|
103
|
-
#
|
104
|
-
# @return [Float]
|
105
|
-
required :including_pending, Float
|
106
|
-
|
107
|
-
# @!method initialize(effective_at:, excluding_pending:, including_pending:)
|
108
|
-
# Some parameter documentations has been truncated, see
|
109
|
-
# {MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::EndingBalance}
|
110
|
-
# for more details.
|
111
|
-
#
|
112
|
-
# the effective balances at the end of the specified time window
|
113
|
-
#
|
114
|
-
# @param effective_at [Time] the ending_before request parameter (if supplied) or the current billing period'
|
115
|
-
#
|
116
|
-
# @param excluding_pending [Float] the ending balance, including the balance of all grants that have not expired be
|
117
|
-
#
|
118
|
-
# @param including_pending [Float] the excluding_pending balance plus any pending invoice deductions and expiration
|
119
|
-
end
|
120
|
-
|
121
|
-
# @see MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger#starting_balance
|
122
|
-
class StartingBalance < MetronomeSDK::Internal::Type::BaseModel
|
123
|
-
# @!attribute effective_at
|
124
|
-
# the starting_on request parameter (if supplied) or the first credit grant's
|
125
|
-
# effective_at date
|
126
|
-
#
|
127
|
-
# @return [Time]
|
128
|
-
required :effective_at, Time
|
129
|
-
|
130
|
-
# @!attribute excluding_pending
|
131
|
-
# the starting balance, including all posted grants, deductions, and expirations
|
132
|
-
# that happened at or before the effective_at timestamp
|
133
|
-
#
|
134
|
-
# @return [Float]
|
135
|
-
required :excluding_pending, Float
|
136
|
-
|
137
|
-
# @!attribute including_pending
|
138
|
-
# the excluding_pending balance plus any pending activity that has not been posted
|
139
|
-
# at the time of the query
|
140
|
-
#
|
141
|
-
# @return [Float]
|
142
|
-
required :including_pending, Float
|
143
|
-
|
144
|
-
# @!method initialize(effective_at:, excluding_pending:, including_pending:)
|
145
|
-
# Some parameter documentations has been truncated, see
|
146
|
-
# {MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::StartingBalance}
|
147
|
-
# for more details.
|
148
|
-
#
|
149
|
-
# @param effective_at [Time] the starting_on request parameter (if supplied) or the first credit grant's effe
|
150
|
-
#
|
151
|
-
# @param excluding_pending [Float] the starting balance, including all posted grants, deductions, and expirations t
|
152
|
-
#
|
153
|
-
# @param including_pending [Float] the excluding_pending balance plus any pending activity that has not been posted
|
154
|
-
end
|
134
|
+
# @param including_pending [Float] the excluding_pending balance plus any pending activity that has not been posted
|
155
135
|
end
|
156
136
|
end
|
157
137
|
end
|
@@ -20,6 +20,7 @@ module MetronomeSDK
|
|
20
20
|
required :balance, -> { MetronomeSDK::Models::V1::CreditGrantListResponse::Balance }
|
21
21
|
|
22
22
|
# @!attribute custom_fields
|
23
|
+
# Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
23
24
|
#
|
24
25
|
# @return [Hash{Symbol=>String}]
|
25
26
|
required :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
|
@@ -33,10 +34,7 @@ module MetronomeSDK
|
|
33
34
|
# @!attribute deductions
|
34
35
|
#
|
35
36
|
# @return [Array<MetronomeSDK::Models::V1::CreditLedgerEntry>]
|
36
|
-
required :deductions,
|
37
|
-
-> {
|
38
|
-
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::CreditLedgerEntry]
|
39
|
-
}
|
37
|
+
required :deductions, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::CreditLedgerEntry] }
|
40
38
|
|
41
39
|
# @!attribute effective_at
|
42
40
|
#
|
@@ -117,7 +115,7 @@ module MetronomeSDK
|
|
117
115
|
#
|
118
116
|
# @param balance [MetronomeSDK::Models::V1::CreditGrantListResponse::Balance] The effective balance of the grant as of the end of the customer's current billi
|
119
117
|
#
|
120
|
-
# @param custom_fields [Hash{Symbol=>String}]
|
118
|
+
# @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
121
119
|
#
|
122
120
|
# @param customer_id [String] the Metronome ID of the customer
|
123
121
|
#
|
@@ -19,9 +19,7 @@ module MetronomeSDK
|
|
19
19
|
#
|
20
20
|
# @return [Array<Symbol, MetronomeSDK::Models::V1::CustomFieldListKeysParams::Entity>, nil]
|
21
21
|
optional :entities,
|
22
|
-
-> {
|
23
|
-
MetronomeSDK::Internal::Type::ArrayOf[enum: MetronomeSDK::V1::CustomFieldListKeysParams::Entity]
|
24
|
-
}
|
22
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[enum: MetronomeSDK::V1::CustomFieldListKeysParams::Entity] }
|
25
23
|
|
26
24
|
# @!method initialize(next_page: nil, entities: nil, request_options: {})
|
27
25
|
# @param next_page [String] Cursor that indicates where the next page of results should start.
|
@@ -5,68 +5,51 @@ module MetronomeSDK
|
|
5
5
|
module V1
|
6
6
|
# @see MetronomeSDK::Resources::V1::CustomFields#list_keys
|
7
7
|
class CustomFieldListKeysResponse < MetronomeSDK::Internal::Type::BaseModel
|
8
|
-
# @!attribute
|
8
|
+
# @!attribute enforce_uniqueness
|
9
9
|
#
|
10
|
-
# @return [
|
11
|
-
required :
|
12
|
-
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data] }
|
10
|
+
# @return [Boolean]
|
11
|
+
required :enforce_uniqueness, MetronomeSDK::Internal::Type::Boolean
|
13
12
|
|
14
|
-
# @!attribute
|
13
|
+
# @!attribute entity
|
15
14
|
#
|
16
|
-
# @return [
|
17
|
-
required :
|
15
|
+
# @return [Symbol, MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Entity]
|
16
|
+
required :entity, enum: -> { MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Entity }
|
18
17
|
|
19
|
-
# @!
|
20
|
-
#
|
21
|
-
# @
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
|
54
|
-
CONTRACT = :contract
|
55
|
-
CREDIT_GRANT = :credit_grant
|
56
|
-
CUSTOMER_PLAN = :customer_plan
|
57
|
-
CUSTOMER = :customer
|
58
|
-
DISCOUNT = :discount
|
59
|
-
INVOICE = :invoice
|
60
|
-
PLAN = :plan
|
61
|
-
PROFESSIONAL_SERVICE = :professional_service
|
62
|
-
PRODUCT = :product
|
63
|
-
RATE_CARD = :rate_card
|
64
|
-
SCHEDULED_CHARGE = :scheduled_charge
|
65
|
-
SUBSCRIPTION = :subscription
|
66
|
-
|
67
|
-
# @!method self.values
|
68
|
-
# @return [Array<Symbol>]
|
69
|
-
end
|
18
|
+
# @!attribute key
|
19
|
+
#
|
20
|
+
# @return [String]
|
21
|
+
required :key, String
|
22
|
+
|
23
|
+
# @!method initialize(enforce_uniqueness:, entity:, key:)
|
24
|
+
# @param enforce_uniqueness [Boolean]
|
25
|
+
# @param entity [Symbol, MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Entity]
|
26
|
+
# @param key [String]
|
27
|
+
|
28
|
+
# @see MetronomeSDK::Models::V1::CustomFieldListKeysResponse#entity
|
29
|
+
module Entity
|
30
|
+
extend MetronomeSDK::Internal::Type::Enum
|
31
|
+
|
32
|
+
ALERT = :alert
|
33
|
+
BILLABLE_METRIC = :billable_metric
|
34
|
+
CHARGE = :charge
|
35
|
+
COMMIT = :commit
|
36
|
+
CONTRACT_CREDIT = :contract_credit
|
37
|
+
CONTRACT_PRODUCT = :contract_product
|
38
|
+
CONTRACT = :contract
|
39
|
+
CREDIT_GRANT = :credit_grant
|
40
|
+
CUSTOMER_PLAN = :customer_plan
|
41
|
+
CUSTOMER = :customer
|
42
|
+
DISCOUNT = :discount
|
43
|
+
INVOICE = :invoice
|
44
|
+
PLAN = :plan
|
45
|
+
PROFESSIONAL_SERVICE = :professional_service
|
46
|
+
PRODUCT = :product
|
47
|
+
RATE_CARD = :rate_card
|
48
|
+
SCHEDULED_CHARGE = :scheduled_charge
|
49
|
+
SUBSCRIPTION = :subscription
|
50
|
+
|
51
|
+
# @!method self.values
|
52
|
+
# @return [Array<Symbol>]
|
70
53
|
end
|
71
54
|
end
|
72
55
|
end
|
@@ -9,6 +9,7 @@ module MetronomeSDK
|
|
9
9
|
include MetronomeSDK::Internal::Type::RequestParameters
|
10
10
|
|
11
11
|
# @!attribute custom_fields
|
12
|
+
# Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
12
13
|
#
|
13
14
|
# @return [Hash{Symbol=>String}]
|
14
15
|
required :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
|
@@ -24,9 +25,12 @@ module MetronomeSDK
|
|
24
25
|
required :entity_id, String
|
25
26
|
|
26
27
|
# @!method initialize(custom_fields:, entity:, entity_id:, request_options: {})
|
27
|
-
# @param custom_fields [Hash{Symbol=>String}]
|
28
|
+
# @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
29
|
+
#
|
28
30
|
# @param entity [Symbol, MetronomeSDK::Models::V1::CustomFieldSetValuesParams::Entity]
|
31
|
+
#
|
29
32
|
# @param entity_id [String]
|
33
|
+
#
|
30
34
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
|
31
35
|
|
32
36
|
module Entity
|
@@ -30,6 +30,7 @@ module MetronomeSDK
|
|
30
30
|
required :name, String
|
31
31
|
|
32
32
|
# @!attribute custom_fields
|
33
|
+
# Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
33
34
|
#
|
34
35
|
# @return [Hash{Symbol=>String}, nil]
|
35
36
|
optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
|
@@ -46,7 +47,7 @@ module MetronomeSDK
|
|
46
47
|
#
|
47
48
|
# @param name [String]
|
48
49
|
#
|
49
|
-
# @param custom_fields [Hash{Symbol=>String}]
|
50
|
+
# @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
50
51
|
end
|
51
52
|
end
|
52
53
|
end
|
@@ -20,6 +20,7 @@ module MetronomeSDK
|
|
20
20
|
optional :billing_config, -> { MetronomeSDK::V1::CustomerCreateParams::BillingConfig }
|
21
21
|
|
22
22
|
# @!attribute custom_fields
|
23
|
+
# Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
23
24
|
#
|
24
25
|
# @return [Hash{Symbol=>String}, nil]
|
25
26
|
optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
|
@@ -28,9 +29,7 @@ module MetronomeSDK
|
|
28
29
|
#
|
29
30
|
# @return [Array<MetronomeSDK::Models::V1::CustomerCreateParams::CustomerBillingProviderConfiguration>, nil]
|
30
31
|
optional :customer_billing_provider_configurations,
|
31
|
-
-> {
|
32
|
-
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::CustomerCreateParams::CustomerBillingProviderConfiguration]
|
33
|
-
}
|
32
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::CustomerCreateParams::CustomerBillingProviderConfiguration] }
|
34
33
|
|
35
34
|
# @!attribute external_id
|
36
35
|
# (deprecated, use ingest_aliases instead) an alias that can be used to refer to
|
@@ -53,7 +52,7 @@ module MetronomeSDK
|
|
53
52
|
#
|
54
53
|
# @param billing_config [MetronomeSDK::Models::V1::CustomerCreateParams::BillingConfig]
|
55
54
|
#
|
56
|
-
# @param custom_fields [Hash{Symbol=>String}]
|
55
|
+
# @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
57
56
|
#
|
58
57
|
# @param customer_billing_provider_configurations [Array<MetronomeSDK::Models::V1::CustomerCreateParams::CustomerBillingProviderConfiguration>]
|
59
58
|
#
|
@@ -167,6 +166,8 @@ module MetronomeSDK
|
|
167
166
|
|
168
167
|
CHARGE_AUTOMATICALLY = :charge_automatically
|
169
168
|
SEND_INVOICE = :send_invoice
|
169
|
+
AUTO_CHARGE_PAYMENT_INTENT = :auto_charge_payment_intent
|
170
|
+
MANUALLY_CHARGE_PAYMENT_INTENT = :manually_charge_payment_intent
|
170
171
|
|
171
172
|
# @!method self.values
|
172
173
|
# @return [Array<Symbol>]
|
@@ -179,9 +180,7 @@ module MetronomeSDK
|
|
179
180
|
#
|
180
181
|
# @return [Symbol, MetronomeSDK::Models::V1::CustomerCreateParams::CustomerBillingProviderConfiguration::BillingProvider]
|
181
182
|
required :billing_provider,
|
182
|
-
enum: -> {
|
183
|
-
MetronomeSDK::V1::CustomerCreateParams::CustomerBillingProviderConfiguration::BillingProvider
|
184
|
-
}
|
183
|
+
enum: -> { MetronomeSDK::V1::CustomerCreateParams::CustomerBillingProviderConfiguration::BillingProvider }
|
185
184
|
|
186
185
|
# @!attribute configuration
|
187
186
|
# Configuration for the billing provider. The structure of this object is specific
|
@@ -198,9 +197,7 @@ module MetronomeSDK
|
|
198
197
|
#
|
199
198
|
# @return [Symbol, MetronomeSDK::Models::V1::CustomerCreateParams::CustomerBillingProviderConfiguration::DeliveryMethod, nil]
|
200
199
|
optional :delivery_method,
|
201
|
-
enum: -> {
|
202
|
-
MetronomeSDK::V1::CustomerCreateParams::CustomerBillingProviderConfiguration::DeliveryMethod
|
203
|
-
}
|
200
|
+
enum: -> { MetronomeSDK::V1::CustomerCreateParams::CustomerBillingProviderConfiguration::DeliveryMethod }
|
204
201
|
|
205
202
|
# @!attribute delivery_method_id
|
206
203
|
# ID of the delivery method to use for this customer. If not provided, the
|
@@ -209,7 +206,17 @@ module MetronomeSDK
|
|
209
206
|
# @return [String, nil]
|
210
207
|
optional :delivery_method_id, String
|
211
208
|
|
212
|
-
# @!
|
209
|
+
# @!attribute tax_provider
|
210
|
+
# Specifies which tax provider Metronome should use for tax calculation when
|
211
|
+
# billing through Stripe. This is only supported for Stripe billing provider
|
212
|
+
# configurations with auto_charge_payment_intent or manual_charge_payment_intent
|
213
|
+
# collection methods.
|
214
|
+
#
|
215
|
+
# @return [Symbol, MetronomeSDK::Models::V1::CustomerCreateParams::CustomerBillingProviderConfiguration::TaxProvider, nil]
|
216
|
+
optional :tax_provider,
|
217
|
+
enum: -> { MetronomeSDK::V1::CustomerCreateParams::CustomerBillingProviderConfiguration::TaxProvider }
|
218
|
+
|
219
|
+
# @!method initialize(billing_provider:, configuration: nil, delivery_method: nil, delivery_method_id: nil, tax_provider: nil)
|
213
220
|
# Some parameter documentations has been truncated, see
|
214
221
|
# {MetronomeSDK::Models::V1::CustomerCreateParams::CustomerBillingProviderConfiguration}
|
215
222
|
# for more details.
|
@@ -221,6 +228,8 @@ module MetronomeSDK
|
|
221
228
|
# @param delivery_method [Symbol, MetronomeSDK::Models::V1::CustomerCreateParams::CustomerBillingProviderConfiguration::DeliveryMethod] The method to use for delivering invoices to this customer. If not provided, the
|
222
229
|
#
|
223
230
|
# @param delivery_method_id [String] ID of the delivery method to use for this customer. If not provided, the `delive
|
231
|
+
#
|
232
|
+
# @param tax_provider [Symbol, MetronomeSDK::Models::V1::CustomerCreateParams::CustomerBillingProviderConfiguration::TaxProvider] Specifies which tax provider Metronome should use for tax calculation when billi
|
224
233
|
|
225
234
|
# The billing provider set for this configuration.
|
226
235
|
#
|
@@ -253,6 +262,23 @@ module MetronomeSDK
|
|
253
262
|
# @!method self.values
|
254
263
|
# @return [Array<Symbol>]
|
255
264
|
end
|
265
|
+
|
266
|
+
# Specifies which tax provider Metronome should use for tax calculation when
|
267
|
+
# billing through Stripe. This is only supported for Stripe billing provider
|
268
|
+
# configurations with auto_charge_payment_intent or manual_charge_payment_intent
|
269
|
+
# collection methods.
|
270
|
+
#
|
271
|
+
# @see MetronomeSDK::Models::V1::CustomerCreateParams::CustomerBillingProviderConfiguration#tax_provider
|
272
|
+
module TaxProvider
|
273
|
+
extend MetronomeSDK::Internal::Type::Enum
|
274
|
+
|
275
|
+
ANROK = :anrok
|
276
|
+
AVALARA = :avalara
|
277
|
+
STRIPE = :stripe
|
278
|
+
|
279
|
+
# @!method self.values
|
280
|
+
# @return [Array<Symbol>]
|
281
|
+
end
|
256
282
|
end
|
257
283
|
end
|
258
284
|
end
|