metronome-sdk 0.1.0.pre.alpha.2 → 0.1.0.pre.alpha.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +85 -0
- data/README.md +120 -74
- data/SECURITY.md +2 -2
- data/lib/metronome_sdk/client.rb +4 -4
- data/lib/metronome_sdk/errors.rb +22 -0
- data/lib/metronome_sdk/internal/transport/base_client.rb +10 -2
- data/lib/metronome_sdk/internal/transport/pooled_net_requester.rb +3 -1
- data/lib/metronome_sdk/internal/type/array_of.rb +14 -1
- data/lib/metronome_sdk/internal/type/base_model.rb +92 -23
- data/lib/metronome_sdk/internal/type/boolean.rb +15 -1
- data/lib/metronome_sdk/internal/type/converter.rb +42 -34
- data/lib/metronome_sdk/internal/type/enum.rb +25 -2
- data/lib/metronome_sdk/internal/type/file_input.rb +13 -1
- data/lib/metronome_sdk/internal/type/hash_of.rb +14 -1
- data/lib/metronome_sdk/internal/type/union.rb +27 -7
- data/lib/metronome_sdk/internal/type/unknown.rb +15 -1
- data/lib/metronome_sdk/internal/util.rb +62 -10
- data/lib/metronome_sdk/internal.rb +3 -0
- data/lib/metronome_sdk/models/commit.rb +230 -87
- data/lib/metronome_sdk/models/contract_without_amendments.rb +551 -185
- data/lib/metronome_sdk/models/credit.rb +201 -51
- data/lib/metronome_sdk/models/discount.rb +5 -5
- data/lib/metronome_sdk/models/event_type_filter.rb +1 -1
- data/lib/metronome_sdk/models/override.rb +53 -34
- data/lib/metronome_sdk/models/pro_service.rb +2 -2
- data/lib/metronome_sdk/models/property_filter.rb +1 -1
- data/lib/metronome_sdk/models/rate.rb +9 -9
- data/lib/metronome_sdk/models/schedule_duration.rb +4 -4
- data/lib/metronome_sdk/models/schedule_point_in_time.rb +11 -11
- data/lib/metronome_sdk/models/scheduled_charge.rb +5 -5
- data/lib/metronome_sdk/models/v1/alert_archive_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/alert_create_params.rb +15 -12
- data/lib/metronome_sdk/models/v1/alert_create_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/audit_log_list_params.rb +2 -2
- data/lib/metronome_sdk/models/v1/billable_metric_archive_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/billable_metric_create_params.rb +6 -6
- data/lib/metronome_sdk/models/v1/billable_metric_create_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/billable_metric_list_response.rb +4 -4
- data/lib/metronome_sdk/models/v1/billable_metric_retrieve_response.rb +4 -4
- data/lib/metronome_sdk/models/v1/contract_amend_params.rb +577 -152
- data/lib/metronome_sdk/models/v1/contract_amend_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/contract_archive_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/contract_create_historical_invoices_params.rb +12 -12
- data/lib/metronome_sdk/models/v1/contract_create_historical_invoices_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/contract_create_params.rb +1317 -341
- data/lib/metronome_sdk/models/v1/contract_create_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/contract_list_balances_response.rb +3 -7
- data/lib/metronome_sdk/models/v1/contract_list_response.rb +421 -36
- data/lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rb +33 -5
- data/lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rb +28 -7
- data/lib/metronome_sdk/models/v1/contract_retrieve_response.rb +422 -36
- data/lib/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_params.rb +34 -0
- data/lib/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_response.rb +81 -0
- data/lib/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_params.rb +4 -4
- data/lib/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/contract_update_end_date_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/contracts/product_archive_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/contracts/product_create_params.rb +6 -6
- data/lib/metronome_sdk/models/v1/contracts/product_create_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/contracts/product_list_item_state.rb +5 -5
- data/lib/metronome_sdk/models/v1/contracts/product_list_params.rb +4 -4
- data/lib/metronome_sdk/models/v1/contracts/product_list_response.rb +8 -8
- data/lib/metronome_sdk/models/v1/contracts/product_retrieve_response.rb +8 -8
- data/lib/metronome_sdk/models/v1/contracts/product_update_params.rb +4 -4
- data/lib/metronome_sdk/models/v1/contracts/product_update_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/contracts/quantity_conversion.rb +3 -3
- data/lib/metronome_sdk/models/v1/contracts/quantity_rounding.rb +3 -3
- data/lib/metronome_sdk/models/v1/contracts/rate_card_archive_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/contracts/rate_card_create_params.rb +4 -4
- data/lib/metronome_sdk/models/v1/contracts/rate_card_create_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/contracts/rate_card_list_response.rb +4 -4
- data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rb +33 -5
- data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rb +26 -5
- data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rb +4 -4
- data/lib/metronome_sdk/models/v1/contracts/rate_card_update_params.rb +2 -2
- data/lib/metronome_sdk/models/v1/contracts/rate_card_update_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_params.rb +2 -2
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rb +46 -18
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb +36 -12
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rb +6 -6
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_params.rb +33 -5
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rb +26 -5
- data/lib/metronome_sdk/models/v1/credit_grant_create_params.rb +12 -20
- data/lib/metronome_sdk/models/v1/credit_grant_create_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/credit_grant_edit_response.rb +2 -2
- 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 +6 -6
- data/lib/metronome_sdk/models/v1/credit_grant_list_response.rb +8 -8
- data/lib/metronome_sdk/models/v1/credit_grant_void_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/credit_ledger_entry.rb +1 -1
- data/lib/metronome_sdk/models/v1/custom_field_add_key_params.rb +2 -2
- data/lib/metronome_sdk/models/v1/custom_field_delete_values_params.rb +2 -2
- data/lib/metronome_sdk/models/v1/custom_field_list_keys_params.rb +2 -2
- data/lib/metronome_sdk/models/v1/custom_field_remove_key_params.rb +2 -2
- data/lib/metronome_sdk/models/v1/custom_field_set_values_params.rb +2 -2
- data/lib/metronome_sdk/models/v1/customer.rb +1 -1
- data/lib/metronome_sdk/models/v1/customer_archive_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/customer_create_params.rb +20 -20
- data/lib/metronome_sdk/models/v1/customer_create_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/customer_detail.rb +10 -10
- data/lib/metronome_sdk/models/v1/customer_list_billable_metrics_response.rb +4 -4
- 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 +2 -2
- data/lib/metronome_sdk/models/v1/customer_set_name_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/customers/alert_list_params.rb +2 -2
- data/lib/metronome_sdk/models/v1/customers/alert_list_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/customers/alert_retrieve_params.rb +2 -2
- data/lib/metronome_sdk/models/v1/customers/alert_retrieve_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/customers/billing_config_create_params.rb +6 -6
- data/lib/metronome_sdk/models/v1/customers/billing_config_delete_params.rb +2 -2
- data/lib/metronome_sdk/models/v1/customers/billing_config_retrieve_params.rb +2 -2
- 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 +86 -32
- data/lib/metronome_sdk/models/v1/customers/commit_create_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/customers/commit_list_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/customers/commit_update_end_date_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/customers/credit_create_params.rb +59 -7
- data/lib/metronome_sdk/models/v1/customers/credit_create_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/customers/credit_list_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/customers/credit_update_end_date_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/customers/customer_alert.rb +24 -24
- data/lib/metronome_sdk/models/v1/customers/invoice.rb +74 -73
- data/lib/metronome_sdk/models/v1/customers/invoice_list_breakdowns_params.rb +4 -4
- data/lib/metronome_sdk/models/v1/customers/invoice_list_params.rb +2 -2
- data/lib/metronome_sdk/models/v1/customers/invoice_retrieve_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/customers/plan_add_params.rb +16 -15
- data/lib/metronome_sdk/models/v1/customers/plan_add_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/customers/plan_list_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rb +14 -13
- data/lib/metronome_sdk/models/v1/plan_detail.rb +18 -18
- data/lib/metronome_sdk/models/v1/plan_get_details_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/plan_list_charges_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/plan_list_customers_params.rb +2 -2
- data/lib/metronome_sdk/models/v1/plan_list_customers_response.rb +2 -2
- data/lib/metronome_sdk/models/v1/rollover_amount_max_amount.rb +3 -3
- data/lib/metronome_sdk/models/v1/rollover_amount_max_percentage.rb +3 -3
- data/lib/metronome_sdk/models/v1/usage_ingest_params.rb +2 -2
- data/lib/metronome_sdk/models/v1/usage_list_params.rb +9 -8
- data/lib/metronome_sdk/models/v1/usage_list_with_groups_params.rb +5 -5
- 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 +78 -23
- data/lib/metronome_sdk/models/v2/contract_edit_commit_response.rb +2 -2
- data/lib/metronome_sdk/models/v2/contract_edit_credit_params.rb +62 -9
- data/lib/metronome_sdk/models/v2/contract_edit_credit_response.rb +2 -2
- data/lib/metronome_sdk/models/v2/contract_edit_params.rb +1995 -443
- data/lib/metronome_sdk/models/v2/contract_edit_response.rb +2 -2
- data/lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb +1959 -140
- data/lib/metronome_sdk/models/v2/contract_list_response.rb +963 -91
- data/lib/metronome_sdk/models/v2/contract_retrieve_response.rb +964 -91
- data/lib/metronome_sdk/models.rb +30 -19
- data/lib/metronome_sdk/resources/v1/alerts.rb +4 -4
- data/lib/metronome_sdk/resources/v1/audit_logs.rb +1 -1
- data/lib/metronome_sdk/resources/v1/billable_metrics.rb +3 -3
- data/lib/metronome_sdk/resources/v1/contracts/products.rb +9 -6
- data/lib/metronome_sdk/resources/v1/contracts/rate_cards/product_orders.rb +1 -1
- data/lib/metronome_sdk/resources/v1/contracts/rate_cards/rates.rb +8 -6
- data/lib/metronome_sdk/resources/v1/contracts/rate_cards.rb +4 -4
- data/lib/metronome_sdk/resources/v1/contracts.rb +59 -28
- data/lib/metronome_sdk/resources/v1/credit_grants.rb +7 -5
- data/lib/metronome_sdk/resources/v1/custom_fields.rb +5 -5
- data/lib/metronome_sdk/resources/v1/customers/alerts.rb +2 -2
- data/lib/metronome_sdk/resources/v1/customers/billing_config.rb +5 -5
- data/lib/metronome_sdk/resources/v1/customers/commits.rb +9 -7
- data/lib/metronome_sdk/resources/v1/customers/credits.rb +5 -3
- data/lib/metronome_sdk/resources/v1/customers/invoices.rb +4 -4
- data/lib/metronome_sdk/resources/v1/customers/plans.rb +3 -3
- data/lib/metronome_sdk/resources/v1/customers.rb +43 -4
- data/lib/metronome_sdk/resources/v1/dashboards.rb +4 -4
- data/lib/metronome_sdk/resources/v1/plans.rb +1 -1
- data/lib/metronome_sdk/resources/v1/usage.rb +30 -5
- data/lib/metronome_sdk/resources/v2/contracts.rb +45 -31
- data/lib/metronome_sdk/version.rb +1 -1
- data/lib/metronome_sdk.rb +9 -1
- data/rbi/metronome_sdk/errors.rbi +16 -0
- data/rbi/metronome_sdk/internal/transport/pooled_net_requester.rbi +5 -1
- data/rbi/metronome_sdk/internal/type/array_of.rbi +6 -0
- data/rbi/metronome_sdk/internal/type/base_model.rbi +5 -0
- data/rbi/metronome_sdk/internal/type/boolean.rbi +8 -0
- data/rbi/metronome_sdk/internal/type/converter.rbi +15 -15
- data/rbi/metronome_sdk/internal/type/enum.rbi +5 -0
- data/rbi/metronome_sdk/internal/type/file_input.rbi +5 -0
- data/rbi/metronome_sdk/internal/type/hash_of.rbi +6 -0
- data/rbi/metronome_sdk/internal/type/union.rbi +10 -0
- data/rbi/metronome_sdk/internal/type/unknown.rbi +8 -0
- data/rbi/metronome_sdk/internal/util.rbi +36 -0
- data/rbi/metronome_sdk/internal.rbi +5 -0
- data/rbi/metronome_sdk/models/commit.rbi +376 -39
- data/rbi/metronome_sdk/models/contract_without_amendments.rbi +791 -54
- data/rbi/metronome_sdk/models/credit.rbi +376 -25
- data/rbi/metronome_sdk/models/override.rbi +66 -0
- data/rbi/metronome_sdk/models/schedule_point_in_time.rbi +9 -9
- data/rbi/metronome_sdk/models/v1/alert_create_params.rbi +10 -4
- data/rbi/metronome_sdk/models/v1/contract_amend_params.rbi +995 -17
- data/rbi/metronome_sdk/models/v1/contract_create_params.rbi +2220 -136
- data/rbi/metronome_sdk/models/v1/contract_list_balances_response.rbi +9 -2
- data/rbi/metronome_sdk/models/v1/contract_list_response.rbi +820 -28
- data/rbi/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rbi +72 -0
- data/rbi/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rbi +66 -0
- data/rbi/metronome_sdk/models/v1/contract_retrieve_response.rbi +820 -28
- data/rbi/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_params.rbi +58 -0
- data/rbi/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_response.rbi +212 -0
- data/rbi/metronome_sdk/models/v1/contracts/product_list_params.rbi +3 -3
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rbi +72 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rbi +66 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rbi +72 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbi +72 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_list_params.rbi +72 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rbi +66 -0
- data/rbi/metronome_sdk/models/v1/credit_grant_list_entries_params.rbi +58 -0
- 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/customers/billing_config_retrieve_response.rbi +11 -0
- data/rbi/metronome_sdk/models/v1/customers/commit_create_params.rbi +121 -8
- data/rbi/metronome_sdk/models/v1/customers/credit_create_params.rbi +109 -0
- data/rbi/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rbi +5 -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 +113 -8
- data/rbi/metronome_sdk/models/v2/contract_edit_credit_params.rbi +101 -0
- data/rbi/metronome_sdk/models/v2/contract_edit_params.rbi +3667 -315
- data/rbi/metronome_sdk/models/v2/contract_get_edit_history_response.rbi +5965 -2014
- data/rbi/metronome_sdk/models/v2/contract_list_response.rbi +2279 -226
- data/rbi/metronome_sdk/models/v2/contract_retrieve_response.rbi +2279 -226
- data/rbi/metronome_sdk/resources/v1/alerts.rbi +5 -2
- data/rbi/metronome_sdk/resources/v1/contracts/products.rbi +2 -1
- data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbi +5 -0
- data/rbi/metronome_sdk/resources/v1/contracts.rbi +36 -1
- data/rbi/metronome_sdk/resources/v1/credit_grants.rbi +4 -0
- data/rbi/metronome_sdk/resources/v1/customers/commits.rbi +15 -4
- data/rbi/metronome_sdk/resources/v1/customers/credits.rbi +9 -0
- data/rbi/metronome_sdk/resources/v1/customers.rbi +35 -1
- data/rbi/metronome_sdk/resources/v1/usage.rbi +17 -0
- data/rbi/metronome_sdk/resources/v2/contracts.rbi +65 -7
- data/sig/metronome_sdk/errors.rbs +9 -0
- data/sig/metronome_sdk/internal/transport/pooled_net_requester.rbs +2 -0
- data/sig/metronome_sdk/internal/type/array_of.rbs +3 -0
- data/sig/metronome_sdk/internal/type/base_model.rbs +2 -0
- data/sig/metronome_sdk/internal/type/boolean.rbs +3 -0
- data/sig/metronome_sdk/internal/type/converter.rbs +7 -1
- data/sig/metronome_sdk/internal/type/enum.rbs +2 -0
- data/sig/metronome_sdk/internal/type/file_input.rbs +2 -0
- data/sig/metronome_sdk/internal/type/hash_of.rbs +3 -0
- data/sig/metronome_sdk/internal/type/union.rbs +2 -0
- data/sig/metronome_sdk/internal/type/unknown.rbs +3 -0
- data/sig/metronome_sdk/internal/util.rbs +12 -0
- data/sig/metronome_sdk/internal.rbs +2 -0
- data/sig/metronome_sdk/models/base_usage_filter.rbs +6 -0
- data/sig/metronome_sdk/models/commit.rbs +374 -68
- data/sig/metronome_sdk/models/contract_without_amendments.rbs +620 -110
- data/sig/metronome_sdk/models/credit.rbs +286 -40
- data/sig/metronome_sdk/models/credit_type_data.rbs +2 -0
- data/sig/metronome_sdk/models/discount.rbs +11 -0
- data/sig/metronome_sdk/models/event_type_filter.rbs +5 -0
- data/sig/metronome_sdk/models/id.rbs +2 -0
- data/sig/metronome_sdk/models/override.rbs +92 -22
- data/sig/metronome_sdk/models/pro_service.rbs +11 -0
- data/sig/metronome_sdk/models/property_filter.rbs +7 -0
- data/sig/metronome_sdk/models/rate.rbs +16 -4
- data/sig/metronome_sdk/models/schedule_duration.rbs +12 -0
- data/sig/metronome_sdk/models/schedule_point_in_time.rbs +20 -6
- data/sig/metronome_sdk/models/scheduled_charge.rbs +12 -0
- data/sig/metronome_sdk/models/tier.rbs +2 -0
- data/sig/metronome_sdk/models/v1/alert_archive_params.rbs +6 -0
- data/sig/metronome_sdk/models/v1/alert_archive_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/alert_create_params.rbs +29 -4
- data/sig/metronome_sdk/models/v1/alert_create_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/audit_log_list_params.rbs +11 -0
- data/sig/metronome_sdk/models/v1/audit_log_list_response.rbs +16 -0
- data/sig/metronome_sdk/models/v1/billable_metric_archive_params.rbs +2 -0
- data/sig/metronome_sdk/models/v1/billable_metric_archive_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/billable_metric_create_params.rbs +12 -0
- data/sig/metronome_sdk/models/v1/billable_metric_create_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/billable_metric_list_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/billable_metric_list_response.rbs +13 -0
- data/sig/metronome_sdk/models/v1/billable_metric_retrieve_params.rbs +5 -0
- data/sig/metronome_sdk/models/v1/billable_metric_retrieve_response.rbs +17 -0
- data/sig/metronome_sdk/models/v1/contract_add_manual_balance_entry_params.rbs +11 -0
- data/sig/metronome_sdk/models/v1/contract_amend_params.rbs +719 -75
- data/sig/metronome_sdk/models/v1/contract_amend_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contract_archive_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/contract_archive_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contract_create_historical_invoices_params.rbs +47 -12
- data/sig/metronome_sdk/models/v1/contract_create_historical_invoices_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contract_create_params.rbs +1503 -250
- data/sig/metronome_sdk/models/v1/contract_create_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contract_list_balances_params.rbs +14 -0
- data/sig/metronome_sdk/models/v1/contract_list_balances_response.rbs +5 -0
- data/sig/metronome_sdk/models/v1/contract_list_params.rbs +10 -0
- data/sig/metronome_sdk/models/v1/contract_list_response.rbs +459 -10
- data/sig/metronome_sdk/models/v1/contract_retrieve_params.rbs +8 -0
- data/sig/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rbs +39 -0
- data/sig/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rbs +48 -0
- data/sig/metronome_sdk/models/v1/contract_retrieve_response.rbs +459 -10
- data/sig/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_params.rbs +34 -0
- data/sig/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_response.rbs +101 -0
- data/sig/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_params.rbs +21 -0
- data/sig/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contract_set_usage_filter_params.rbs +9 -0
- data/sig/metronome_sdk/models/v1/contract_update_end_date_params.rbs +8 -0
- data/sig/metronome_sdk/models/v1/contract_update_end_date_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contracts/named_schedule_retrieve_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/contracts/named_schedule_retrieve_response.rbs +10 -0
- data/sig/metronome_sdk/models/v1/contracts/named_schedule_update_params.rbs +9 -0
- data/sig/metronome_sdk/models/v1/contracts/product_archive_params.rbs +5 -0
- data/sig/metronome_sdk/models/v1/contracts/product_archive_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contracts/product_create_params.rbs +18 -0
- data/sig/metronome_sdk/models/v1/contracts/product_create_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contracts/product_list_item_state.rbs +19 -0
- data/sig/metronome_sdk/models/v1/contracts/product_list_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/contracts/product_list_response.rbs +29 -0
- data/sig/metronome_sdk/models/v1/contracts/product_retrieve_params.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contracts/product_retrieve_response.rbs +33 -0
- data/sig/metronome_sdk/models/v1/contracts/product_update_params.rbs +19 -0
- data/sig/metronome_sdk/models/v1/contracts/product_update_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contracts/quantity_conversion.rbs +10 -4
- data/sig/metronome_sdk/models/v1/contracts/quantity_rounding.rbs +9 -4
- data/sig/metronome_sdk/models/v1/contracts/rate_card_archive_params.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_archive_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_create_params.rbs +21 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_create_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_list_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_list_response.rbs +23 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_params.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rbs +38 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rbs +46 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rbs +27 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_update_params.rbs +14 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_update_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_params.rbs +8 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_response.rbs +10 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_update_params.rbs +10 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_params.rbs +6 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_params.rbs +8 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rbs +59 -8
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbs +51 -4
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rbs +23 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_list_params.rbs +38 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rbs +41 -0
- data/sig/metronome_sdk/models/v1/credit_grant_create_params.rbs +32 -4
- data/sig/metronome_sdk/models/v1/credit_grant_create_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/credit_grant_edit_params.rbs +8 -0
- data/sig/metronome_sdk/models/v1/credit_grant_edit_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/credit_grant_list_entries_params.rbs +29 -0
- data/sig/metronome_sdk/models/v1/credit_grant_list_entries_response.rbs +30 -0
- data/sig/metronome_sdk/models/v1/credit_grant_list_params.rbs +11 -0
- data/sig/metronome_sdk/models/v1/credit_grant_list_response.rbs +38 -0
- data/sig/metronome_sdk/models/v1/credit_grant_void_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/credit_grant_void_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/credit_ledger_entry.rbs +10 -0
- data/sig/metronome_sdk/models/v1/custom_field_add_key_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/custom_field_delete_values_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/custom_field_list_keys_params.rbs +12 -6
- data/sig/metronome_sdk/models/v1/custom_field_list_keys_response.rbs +11 -0
- data/sig/metronome_sdk/models/v1/custom_field_remove_key_params.rbs +6 -0
- data/sig/metronome_sdk/models/v1/custom_field_set_values_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/customer.rbs +8 -0
- data/sig/metronome_sdk/models/v1/customer_archive_params.rbs +2 -0
- data/sig/metronome_sdk/models/v1/customer_archive_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/customer_create_params.rbs +52 -26
- data/sig/metronome_sdk/models/v1/customer_create_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/customer_detail.rbs +23 -4
- data/sig/metronome_sdk/models/v1/customer_list_billable_metrics_params.rbs +9 -0
- data/sig/metronome_sdk/models/v1/customer_list_billable_metrics_response.rbs +17 -0
- data/sig/metronome_sdk/models/v1/customer_list_costs_params.rbs +9 -0
- data/sig/metronome_sdk/models/v1/customer_list_costs_response.rbs +19 -0
- data/sig/metronome_sdk/models/v1/customer_list_params.rbs +10 -0
- 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_params.rbs +5 -0
- data/sig/metronome_sdk/models/v1/customer_retrieve_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/customer_set_ingest_aliases_params.rbs +6 -0
- data/sig/metronome_sdk/models/v1/customer_set_name_params.rbs +6 -0
- data/sig/metronome_sdk/models/v1/customer_set_name_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/customer_update_config_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/customers/alert_list_params.rbs +13 -6
- data/sig/metronome_sdk/models/v1/customers/alert_list_response.rbs +5 -0
- data/sig/metronome_sdk/models/v1/customers/alert_reset_params.rbs +6 -0
- data/sig/metronome_sdk/models/v1/customers/alert_retrieve_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/customers/alert_retrieve_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/customers/billing_config_create_params.rbs +10 -0
- data/sig/metronome_sdk/models/v1/customers/billing_config_delete_params.rbs +6 -0
- data/sig/metronome_sdk/models/v1/customers/billing_config_retrieve_params.rbs +6 -0
- data/sig/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbs +23 -0
- data/sig/metronome_sdk/models/v1/customers/commit_create_params.rbs +116 -8
- data/sig/metronome_sdk/models/v1/customers/commit_create_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/customers/commit_list_params.rbs +14 -0
- data/sig/metronome_sdk/models/v1/customers/commit_list_response.rbs +5 -0
- data/sig/metronome_sdk/models/v1/customers/commit_update_end_date_params.rbs +8 -0
- data/sig/metronome_sdk/models/v1/customers/commit_update_end_date_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/customers/credit_create_params.rbs +82 -0
- data/sig/metronome_sdk/models/v1/customers/credit_create_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/customers/credit_list_params.rbs +14 -0
- data/sig/metronome_sdk/models/v1/customers/credit_list_response.rbs +5 -0
- data/sig/metronome_sdk/models/v1/customers/credit_update_end_date_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/customers/credit_update_end_date_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/customers/customer_alert.rbs +45 -16
- data/sig/metronome_sdk/models/v1/customers/invoice.rbs +195 -40
- data/sig/metronome_sdk/models/v1/customers/invoice_add_charge_params.rbs +11 -0
- data/sig/metronome_sdk/models/v1/customers/invoice_add_charge_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/customers/invoice_list_breakdowns_params.rbs +14 -0
- data/sig/metronome_sdk/models/v1/customers/invoice_list_breakdowns_response.rbs +5 -0
- data/sig/metronome_sdk/models/v1/customers/invoice_list_params.rbs +13 -0
- data/sig/metronome_sdk/models/v1/customers/invoice_retrieve_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/customers/invoice_retrieve_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/customers/named_schedule_retrieve_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/customers/named_schedule_retrieve_response.rbs +10 -0
- data/sig/metronome_sdk/models/v1/customers/named_schedule_update_params.rbs +9 -0
- data/sig/metronome_sdk/models/v1/customers/plan_add_params.rbs +38 -4
- data/sig/metronome_sdk/models/v1/customers/plan_add_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/customers/plan_end_params.rbs +9 -0
- data/sig/metronome_sdk/models/v1/customers/plan_end_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/customers/plan_list_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/customers/plan_list_price_adjustments_params.rbs +8 -0
- data/sig/metronome_sdk/models/v1/customers/plan_list_price_adjustments_response.rbs +14 -0
- data/sig/metronome_sdk/models/v1/customers/plan_list_response.rbs +23 -0
- data/sig/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rbs +30 -7
- data/sig/metronome_sdk/models/v1/dashboard_get_embeddable_url_response.rbs +6 -0
- data/sig/metronome_sdk/models/v1/invoice_regenerate_params.rbs +5 -0
- data/sig/metronome_sdk/models/v1/invoice_regenerate_response.rbs +6 -0
- data/sig/metronome_sdk/models/v1/invoice_void_params.rbs +5 -0
- data/sig/metronome_sdk/models/v1/invoice_void_response.rbs +6 -0
- data/sig/metronome_sdk/models/v1/plan_detail.rbs +38 -0
- data/sig/metronome_sdk/models/v1/plan_get_details_params.rbs +5 -0
- data/sig/metronome_sdk/models/v1/plan_get_details_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/plan_list_charges_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/plan_list_charges_response.rbs +28 -0
- data/sig/metronome_sdk/models/v1/plan_list_customers_params.rbs +8 -0
- data/sig/metronome_sdk/models/v1/plan_list_customers_response.rbs +14 -0
- data/sig/metronome_sdk/models/v1/plan_list_params.rbs +6 -0
- data/sig/metronome_sdk/models/v1/plan_list_response.rbs +7 -0
- data/sig/metronome_sdk/models/v1/pricing_unit_list_params.rbs +6 -0
- data/sig/metronome_sdk/models/v1/pricing_unit_list_response.rbs +2 -0
- data/sig/metronome_sdk/models/v1/rollover_amount_max_amount.rbs +12 -4
- data/sig/metronome_sdk/models/v1/rollover_amount_max_percentage.rbs +9 -4
- data/sig/metronome_sdk/models/v1/service_list_params.rbs +2 -0
- data/sig/metronome_sdk/models/v1/service_list_response.rbs +10 -0
- data/sig/metronome_sdk/models/v1/usage_ingest_params.rbs +13 -0
- data/sig/metronome_sdk/models/v1/usage_list_params.rbs +17 -0
- data/sig/metronome_sdk/models/v1/usage_list_response.rbs +15 -0
- data/sig/metronome_sdk/models/v1/usage_list_with_groups_params.rbs +15 -0
- data/sig/metronome_sdk/models/v1/usage_list_with_groups_response.rbs +8 -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 +106 -1
- data/sig/metronome_sdk/models/v2/contract_edit_commit_response.rbs +2 -0
- data/sig/metronome_sdk/models/v2/contract_edit_credit_params.rbs +81 -1
- data/sig/metronome_sdk/models/v2/contract_edit_credit_response.rbs +2 -0
- data/sig/metronome_sdk/models/v2/contract_edit_params.rbs +2233 -303
- data/sig/metronome_sdk/models/v2/contract_edit_response.rbs +2 -0
- data/sig/metronome_sdk/models/v2/contract_get_edit_history_params.rbs +6 -0
- data/sig/metronome_sdk/models/v2/contract_get_edit_history_response.rbs +2475 -453
- data/sig/metronome_sdk/models/v2/contract_list_params.rbs +10 -0
- data/sig/metronome_sdk/models/v2/contract_list_response.rbs +1400 -43
- data/sig/metronome_sdk/models/v2/contract_retrieve_params.rbs +9 -0
- data/sig/metronome_sdk/models/v2/contract_retrieve_response.rbs +1400 -43
- data/sig/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbs +1 -0
- data/sig/metronome_sdk/resources/v1/contracts.rbs +10 -0
- data/sig/metronome_sdk/resources/v1/credit_grants.rbs +1 -0
- data/sig/metronome_sdk/resources/v1/custom_fields.rbs +1 -1
- data/sig/metronome_sdk/resources/v1/customers/alerts.rbs +1 -1
- 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.rbs +8 -0
- data/sig/metronome_sdk/resources/v1/usage.rbs +5 -0
- data/sig/metronome_sdk/resources/v2/contracts.rbs +8 -1
- metadata +20 -2
@@ -38,7 +38,7 @@ module MetronomeSDK
|
|
38
38
|
# List of rate selectors, rates matching ANY of the selector will be included in
|
39
39
|
# the response Passing no selectors will result in all rates being returned.
|
40
40
|
#
|
41
|
-
# @return [Array<MetronomeSDK::V1::Contracts::RateCards::RateListParams::Selector>, nil]
|
41
|
+
# @return [Array<MetronomeSDK::Models::V1::Contracts::RateCards::RateListParams::Selector>, nil]
|
42
42
|
optional :selectors,
|
43
43
|
-> {
|
44
44
|
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Contracts::RateCards::RateListParams::Selector]
|
@@ -57,11 +57,21 @@ module MetronomeSDK
|
|
57
57
|
#
|
58
58
|
# @param next_page [String] Cursor that indicates where the next page of results should start.
|
59
59
|
#
|
60
|
-
# @param selectors [Array<MetronomeSDK::V1::Contracts::RateCards::RateListParams::Selector>] List of rate selectors, rates matching ANY of the selector will be included in t
|
60
|
+
# @param selectors [Array<MetronomeSDK::Models::V1::Contracts::RateCards::RateListParams::Selector>] List of rate selectors, rates matching ANY of the selector will be included in t
|
61
61
|
#
|
62
62
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
|
63
63
|
|
64
64
|
class Selector < MetronomeSDK::Internal::Type::BaseModel
|
65
|
+
# @!attribute billing_frequency
|
66
|
+
# Subscription rates matching the billing frequency will be included in the
|
67
|
+
# response.
|
68
|
+
#
|
69
|
+
# @return [Symbol, MetronomeSDK::Models::V1::Contracts::RateCards::RateListParams::Selector::BillingFrequency, nil]
|
70
|
+
optional :billing_frequency,
|
71
|
+
enum: -> {
|
72
|
+
MetronomeSDK::V1::Contracts::RateCards::RateListParams::Selector::BillingFrequency
|
73
|
+
}
|
74
|
+
|
65
75
|
# @!attribute partial_pricing_group_values
|
66
76
|
# List of pricing group key value pairs, rates containing the matching key / value
|
67
77
|
# pairs will be included in the response.
|
@@ -89,10 +99,12 @@ module MetronomeSDK
|
|
89
99
|
# @return [Array<String>, nil]
|
90
100
|
optional :product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
|
91
101
|
|
92
|
-
# @!method initialize(partial_pricing_group_values: nil, pricing_group_values: nil, product_id: nil, product_tags: nil)
|
102
|
+
# @!method initialize(billing_frequency: nil, partial_pricing_group_values: nil, pricing_group_values: nil, product_id: nil, product_tags: nil)
|
93
103
|
# Some parameter documentations has been truncated, see
|
94
|
-
# {MetronomeSDK::V1::Contracts::RateCards::RateListParams::Selector} for
|
95
|
-
# details.
|
104
|
+
# {MetronomeSDK::Models::V1::Contracts::RateCards::RateListParams::Selector} for
|
105
|
+
# more details.
|
106
|
+
#
|
107
|
+
# @param billing_frequency [Symbol, MetronomeSDK::Models::V1::Contracts::RateCards::RateListParams::Selector::BillingFrequency] Subscription rates matching the billing frequency will be included in the respon
|
96
108
|
#
|
97
109
|
# @param partial_pricing_group_values [Hash{Symbol=>String}] List of pricing group key value pairs, rates containing the matching key / value
|
98
110
|
#
|
@@ -101,6 +113,22 @@ module MetronomeSDK
|
|
101
113
|
# @param product_id [String] Rates matching the product id will be included in the response.
|
102
114
|
#
|
103
115
|
# @param product_tags [Array<String>] List of product tags, rates matching any of the tags will be included in the res
|
116
|
+
|
117
|
+
# Subscription rates matching the billing frequency will be included in the
|
118
|
+
# response.
|
119
|
+
#
|
120
|
+
# @see MetronomeSDK::Models::V1::Contracts::RateCards::RateListParams::Selector#billing_frequency
|
121
|
+
module BillingFrequency
|
122
|
+
extend MetronomeSDK::Internal::Type::Enum
|
123
|
+
|
124
|
+
MONTHLY = :MONTHLY
|
125
|
+
QUARTERLY = :QUARTERLY
|
126
|
+
ANNUAL = :ANNUAL
|
127
|
+
WEEKLY = :WEEKLY
|
128
|
+
|
129
|
+
# @!method self.values
|
130
|
+
# @return [Array<Symbol>]
|
131
|
+
end
|
104
132
|
end
|
105
133
|
end
|
106
134
|
end
|
@@ -34,7 +34,7 @@ module MetronomeSDK
|
|
34
34
|
|
35
35
|
# @!attribute rate
|
36
36
|
#
|
37
|
-
# @return [MetronomeSDK::Rate]
|
37
|
+
# @return [MetronomeSDK::Models::Rate]
|
38
38
|
required :rate, -> { MetronomeSDK::Rate }
|
39
39
|
|
40
40
|
# @!attribute starting_at
|
@@ -42,6 +42,12 @@ module MetronomeSDK
|
|
42
42
|
# @return [Time]
|
43
43
|
required :starting_at, Time
|
44
44
|
|
45
|
+
# @!attribute billing_frequency
|
46
|
+
#
|
47
|
+
# @return [Symbol, MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse::BillingFrequency, nil]
|
48
|
+
optional :billing_frequency,
|
49
|
+
enum: -> { MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse::BillingFrequency }
|
50
|
+
|
45
51
|
# @!attribute commit_rate
|
46
52
|
# A distinct rate on the rate card. You can choose to use this rate rather than
|
47
53
|
# list rate when consuming a credit or commit.
|
@@ -59,7 +65,7 @@ module MetronomeSDK
|
|
59
65
|
# @return [Hash{Symbol=>String}, nil]
|
60
66
|
optional :pricing_group_values, MetronomeSDK::Internal::Type::HashOf[String]
|
61
67
|
|
62
|
-
# @!method initialize(entitled:, product_custom_fields:, product_id:, product_name:, product_tags:, rate:, starting_at:, commit_rate: nil, ending_before: nil, pricing_group_values: nil)
|
68
|
+
# @!method initialize(entitled:, product_custom_fields:, product_id:, product_name:, product_tags:, rate:, starting_at:, billing_frequency: nil, commit_rate: nil, ending_before: nil, pricing_group_values: nil)
|
63
69
|
# Some parameter documentations has been truncated, see
|
64
70
|
# {MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse} for more
|
65
71
|
# details.
|
@@ -74,16 +80,31 @@ module MetronomeSDK
|
|
74
80
|
#
|
75
81
|
# @param product_tags [Array<String>]
|
76
82
|
#
|
77
|
-
# @param rate [MetronomeSDK::Rate]
|
83
|
+
# @param rate [MetronomeSDK::Models::Rate]
|
78
84
|
#
|
79
85
|
# @param starting_at [Time]
|
80
86
|
#
|
87
|
+
# @param billing_frequency [Symbol, MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse::BillingFrequency]
|
88
|
+
#
|
81
89
|
# @param commit_rate [MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse::CommitRate] A distinct rate on the rate card. You can choose to use this rate rather than li
|
82
90
|
#
|
83
91
|
# @param ending_before [Time]
|
84
92
|
#
|
85
93
|
# @param pricing_group_values [Hash{Symbol=>String}]
|
86
94
|
|
95
|
+
# @see MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse#billing_frequency
|
96
|
+
module BillingFrequency
|
97
|
+
extend MetronomeSDK::Internal::Type::Enum
|
98
|
+
|
99
|
+
MONTHLY = :MONTHLY
|
100
|
+
QUARTERLY = :QUARTERLY
|
101
|
+
ANNUAL = :ANNUAL
|
102
|
+
WEEKLY = :WEEKLY
|
103
|
+
|
104
|
+
# @!method self.values
|
105
|
+
# @return [Array<Symbol>]
|
106
|
+
end
|
107
|
+
|
87
108
|
# @see MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse#commit_rate
|
88
109
|
class CommitRate < MetronomeSDK::Internal::Type::BaseModel
|
89
110
|
# @!attribute rate_type
|
@@ -101,7 +122,7 @@ module MetronomeSDK
|
|
101
122
|
# @!attribute tiers
|
102
123
|
# Only set for TIERED rate_type.
|
103
124
|
#
|
104
|
-
# @return [Array<MetronomeSDK::Tier>, nil]
|
125
|
+
# @return [Array<MetronomeSDK::Models::Tier>, nil]
|
105
126
|
optional :tiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Tier] }
|
106
127
|
|
107
128
|
# @!method initialize(rate_type:, price: nil, tiers: nil)
|
@@ -112,7 +133,7 @@ module MetronomeSDK
|
|
112
133
|
#
|
113
134
|
# @param price [Float] Commit rate price. For FLAT rate_type, this must be >=0.
|
114
135
|
#
|
115
|
-
# @param tiers [Array<MetronomeSDK::Tier>] Only set for TIERED rate_type.
|
136
|
+
# @param tiers [Array<MetronomeSDK::Models::Tier>] Only set for TIERED rate_type.
|
116
137
|
|
117
138
|
# @see MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse::CommitRate#rate_type
|
118
139
|
module RateType
|
@@ -23,7 +23,7 @@ module MetronomeSDK
|
|
23
23
|
# @!attribute grant_amount
|
24
24
|
# the amount of credits granted
|
25
25
|
#
|
26
|
-
# @return [MetronomeSDK::V1::CreditGrantCreateParams::GrantAmount]
|
26
|
+
# @return [MetronomeSDK::Models::V1::CreditGrantCreateParams::GrantAmount]
|
27
27
|
required :grant_amount, -> { MetronomeSDK::V1::CreditGrantCreateParams::GrantAmount }
|
28
28
|
|
29
29
|
# @!attribute name
|
@@ -35,7 +35,7 @@ module MetronomeSDK
|
|
35
35
|
# @!attribute paid_amount
|
36
36
|
# the amount paid for this credit grant
|
37
37
|
#
|
38
|
-
# @return [MetronomeSDK::V1::CreditGrantCreateParams::PaidAmount]
|
38
|
+
# @return [MetronomeSDK::Models::V1::CreditGrantCreateParams::PaidAmount]
|
39
39
|
required :paid_amount, -> { MetronomeSDK::V1::CreditGrantCreateParams::PaidAmount }
|
40
40
|
|
41
41
|
# @!attribute priority
|
@@ -86,7 +86,7 @@ module MetronomeSDK
|
|
86
86
|
# configured amount to a new credit grant. This feature is currently opt-in only.
|
87
87
|
# Contact Metronome to be added to the beta.
|
88
88
|
#
|
89
|
-
# @return [MetronomeSDK::V1::CreditGrantCreateParams::RolloverSettings, nil]
|
89
|
+
# @return [MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings, nil]
|
90
90
|
optional :rollover_settings, -> { MetronomeSDK::V1::CreditGrantCreateParams::RolloverSettings }
|
91
91
|
|
92
92
|
# @!attribute uniqueness_key
|
@@ -105,11 +105,11 @@ module MetronomeSDK
|
|
105
105
|
#
|
106
106
|
# @param expires_at [Time] The credit grant will only apply to usage or charges dated before this timestamp
|
107
107
|
#
|
108
|
-
# @param grant_amount [MetronomeSDK::V1::CreditGrantCreateParams::GrantAmount] the amount of credits granted
|
108
|
+
# @param grant_amount [MetronomeSDK::Models::V1::CreditGrantCreateParams::GrantAmount] the amount of credits granted
|
109
109
|
#
|
110
110
|
# @param name [String] the name of the credit grant as it will appear on invoices
|
111
111
|
#
|
112
|
-
# @param paid_amount [MetronomeSDK::V1::CreditGrantCreateParams::PaidAmount] the amount paid for this credit grant
|
112
|
+
# @param paid_amount [MetronomeSDK::Models::V1::CreditGrantCreateParams::PaidAmount] the amount paid for this credit grant
|
113
113
|
#
|
114
114
|
# @param priority [Float]
|
115
115
|
#
|
@@ -125,7 +125,7 @@ module MetronomeSDK
|
|
125
125
|
#
|
126
126
|
# @param reason [String]
|
127
127
|
#
|
128
|
-
# @param rollover_settings [MetronomeSDK::V1::CreditGrantCreateParams::RolloverSettings] Configure a rollover for this credit grant so if it expires it rolls over a conf
|
128
|
+
# @param rollover_settings [MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings] Configure a rollover for this credit grant so if it expires it rolls over a conf
|
129
129
|
#
|
130
130
|
# @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a record is made wit
|
131
131
|
#
|
@@ -188,13 +188,14 @@ module MetronomeSDK
|
|
188
188
|
# @!attribute rollover_amount
|
189
189
|
# Specify how much to rollover to the rollover credit grant
|
190
190
|
#
|
191
|
-
# @return [MetronomeSDK::V1::RolloverAmountMaxPercentage, MetronomeSDK::V1::RolloverAmountMaxAmount]
|
191
|
+
# @return [MetronomeSDK::Models::V1::RolloverAmountMaxPercentage, MetronomeSDK::Models::V1::RolloverAmountMaxAmount]
|
192
192
|
required :rollover_amount,
|
193
193
|
union: -> { MetronomeSDK::V1::CreditGrantCreateParams::RolloverSettings::RolloverAmount }
|
194
194
|
|
195
195
|
# @!method initialize(expires_at:, priority:, rollover_amount:)
|
196
196
|
# Some parameter documentations has been truncated, see
|
197
|
-
# {MetronomeSDK::V1::CreditGrantCreateParams::RolloverSettings} for more
|
197
|
+
# {MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings} for more
|
198
|
+
# details.
|
198
199
|
#
|
199
200
|
# Configure a rollover for this credit grant so if it expires it rolls over a
|
200
201
|
# configured amount to a new credit grant. This feature is currently opt-in only.
|
@@ -204,11 +205,11 @@ module MetronomeSDK
|
|
204
205
|
#
|
205
206
|
# @param priority [Float] The priority to give the rollover credit grant that gets created when a rollover
|
206
207
|
#
|
207
|
-
# @param rollover_amount [MetronomeSDK::V1::RolloverAmountMaxPercentage, MetronomeSDK::V1::RolloverAmountMaxAmount] Specify how much to rollover to the rollover credit grant
|
208
|
+
# @param rollover_amount [MetronomeSDK::Models::V1::RolloverAmountMaxPercentage, MetronomeSDK::Models::V1::RolloverAmountMaxAmount] Specify how much to rollover to the rollover credit grant
|
208
209
|
|
209
210
|
# Specify how much to rollover to the rollover credit grant
|
210
211
|
#
|
211
|
-
# @see MetronomeSDK::V1::CreditGrantCreateParams::RolloverSettings#rollover_amount
|
212
|
+
# @see MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings#rollover_amount
|
212
213
|
module RolloverAmount
|
213
214
|
extend MetronomeSDK::Internal::Type::Union
|
214
215
|
|
@@ -217,16 +218,7 @@ module MetronomeSDK
|
|
217
218
|
variant -> { MetronomeSDK::V1::RolloverAmountMaxAmount }
|
218
219
|
|
219
220
|
# @!method self.variants
|
220
|
-
# @return [Array(MetronomeSDK::V1::RolloverAmountMaxPercentage, MetronomeSDK::V1::RolloverAmountMaxAmount)]
|
221
|
-
|
222
|
-
define_sorbet_constant!(:Variants) do
|
223
|
-
T.type_alias do
|
224
|
-
T.any(
|
225
|
-
MetronomeSDK::V1::RolloverAmountMaxPercentage,
|
226
|
-
MetronomeSDK::V1::RolloverAmountMaxAmount
|
227
|
-
)
|
228
|
-
end
|
229
|
-
end
|
221
|
+
# @return [Array(MetronomeSDK::Models::V1::RolloverAmountMaxPercentage, MetronomeSDK::Models::V1::RolloverAmountMaxAmount)]
|
230
222
|
end
|
231
223
|
end
|
232
224
|
end
|
@@ -7,11 +7,11 @@ module MetronomeSDK
|
|
7
7
|
class CreditGrantCreateResponse < MetronomeSDK::Internal::Type::BaseModel
|
8
8
|
# @!attribute data
|
9
9
|
#
|
10
|
-
# @return [MetronomeSDK::ID]
|
10
|
+
# @return [MetronomeSDK::Models::ID]
|
11
11
|
required :data, -> { MetronomeSDK::ID }
|
12
12
|
|
13
13
|
# @!method initialize(data:)
|
14
|
-
# @param data [MetronomeSDK::ID]
|
14
|
+
# @param data [MetronomeSDK::Models::ID]
|
15
15
|
end
|
16
16
|
end
|
17
17
|
end
|
@@ -7,11 +7,11 @@ module MetronomeSDK
|
|
7
7
|
class CreditGrantEditResponse < MetronomeSDK::Internal::Type::BaseModel
|
8
8
|
# @!attribute data
|
9
9
|
#
|
10
|
-
# @return [MetronomeSDK::ID]
|
10
|
+
# @return [MetronomeSDK::Models::ID]
|
11
11
|
required :data, -> { MetronomeSDK::ID }
|
12
12
|
|
13
13
|
# @!method initialize(data:)
|
14
|
-
# @param data [MetronomeSDK::ID]
|
14
|
+
# @param data [MetronomeSDK::Models::ID]
|
15
15
|
end
|
16
16
|
end
|
17
17
|
end
|
@@ -14,6 +14,12 @@ module MetronomeSDK
|
|
14
14
|
# @return [String, nil]
|
15
15
|
optional :next_page, String
|
16
16
|
|
17
|
+
# @!attribute sort
|
18
|
+
# Ledgers sort order by date, asc or desc. Defaults to asc.
|
19
|
+
#
|
20
|
+
# @return [Symbol, MetronomeSDK::Models::V1::CreditGrantListEntriesParams::Sort, nil]
|
21
|
+
optional :sort, enum: -> { MetronomeSDK::V1::CreditGrantListEntriesParams::Sort }
|
22
|
+
|
17
23
|
# @!attribute credit_type_ids
|
18
24
|
# A list of Metronome credit type IDs to fetch ledger entries for. If absent,
|
19
25
|
# ledger entries for all credit types will be returned.
|
@@ -44,12 +50,14 @@ module MetronomeSDK
|
|
44
50
|
# @return [Time, nil]
|
45
51
|
optional :starting_on, Time
|
46
52
|
|
47
|
-
# @!method initialize(next_page: nil, credit_type_ids: nil, customer_ids: nil, ending_before: nil, starting_on: nil, request_options: {})
|
53
|
+
# @!method initialize(next_page: nil, sort: nil, credit_type_ids: nil, customer_ids: nil, ending_before: nil, starting_on: nil, request_options: {})
|
48
54
|
# Some parameter documentations has been truncated, see
|
49
55
|
# {MetronomeSDK::Models::V1::CreditGrantListEntriesParams} for more details.
|
50
56
|
#
|
51
57
|
# @param next_page [String] Cursor that indicates where the next page of results should start.
|
52
58
|
#
|
59
|
+
# @param sort [Symbol, MetronomeSDK::Models::V1::CreditGrantListEntriesParams::Sort] Ledgers sort order by date, asc or desc. Defaults to asc.
|
60
|
+
#
|
53
61
|
# @param credit_type_ids [Array<String>] A list of Metronome credit type IDs to fetch ledger entries for. If absent, ledg
|
54
62
|
#
|
55
63
|
# @param customer_ids [Array<String>] A list of Metronome customer IDs to fetch ledger entries for. If absent, ledger
|
@@ -59,6 +67,17 @@ module MetronomeSDK
|
|
59
67
|
# @param starting_on [Time] If supplied, only ledger entries effective at or after this time will be returne
|
60
68
|
#
|
61
69
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
|
70
|
+
|
71
|
+
# Ledgers sort order by date, asc or desc. Defaults to asc.
|
72
|
+
module Sort
|
73
|
+
extend MetronomeSDK::Internal::Type::Enum
|
74
|
+
|
75
|
+
ASC = :asc
|
76
|
+
DESC = :desc
|
77
|
+
|
78
|
+
# @!method self.values
|
79
|
+
# @return [Array<Symbol>]
|
80
|
+
end
|
62
81
|
end
|
63
82
|
end
|
64
83
|
end
|
@@ -39,7 +39,7 @@ module MetronomeSDK
|
|
39
39
|
class Ledger < MetronomeSDK::Internal::Type::BaseModel
|
40
40
|
# @!attribute credit_type
|
41
41
|
#
|
42
|
-
# @return [MetronomeSDK::CreditTypeData]
|
42
|
+
# @return [MetronomeSDK::Models::CreditTypeData]
|
43
43
|
required :credit_type, -> { MetronomeSDK::CreditTypeData }
|
44
44
|
|
45
45
|
# @!attribute ending_balance
|
@@ -51,7 +51,7 @@ module MetronomeSDK
|
|
51
51
|
|
52
52
|
# @!attribute entries
|
53
53
|
#
|
54
|
-
# @return [Array<MetronomeSDK::V1::CreditLedgerEntry>]
|
54
|
+
# @return [Array<MetronomeSDK::Models::V1::CreditLedgerEntry>]
|
55
55
|
required :entries,
|
56
56
|
-> {
|
57
57
|
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::CreditLedgerEntry]
|
@@ -59,7 +59,7 @@ module MetronomeSDK
|
|
59
59
|
|
60
60
|
# @!attribute pending_entries
|
61
61
|
#
|
62
|
-
# @return [Array<MetronomeSDK::V1::CreditLedgerEntry>]
|
62
|
+
# @return [Array<MetronomeSDK::Models::V1::CreditLedgerEntry>]
|
63
63
|
required :pending_entries,
|
64
64
|
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::CreditLedgerEntry] }
|
65
65
|
|
@@ -70,13 +70,13 @@ module MetronomeSDK
|
|
70
70
|
-> { MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::StartingBalance }
|
71
71
|
|
72
72
|
# @!method initialize(credit_type:, ending_balance:, entries:, pending_entries:, starting_balance:)
|
73
|
-
# @param credit_type [MetronomeSDK::CreditTypeData]
|
73
|
+
# @param credit_type [MetronomeSDK::Models::CreditTypeData]
|
74
74
|
#
|
75
75
|
# @param ending_balance [MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::EndingBalance] the effective balances at the end of the specified time window
|
76
76
|
#
|
77
|
-
# @param entries [Array<MetronomeSDK::V1::CreditLedgerEntry>]
|
77
|
+
# @param entries [Array<MetronomeSDK::Models::V1::CreditLedgerEntry>]
|
78
78
|
#
|
79
|
-
# @param pending_entries [Array<MetronomeSDK::V1::CreditLedgerEntry>]
|
79
|
+
# @param pending_entries [Array<MetronomeSDK::Models::V1::CreditLedgerEntry>]
|
80
80
|
#
|
81
81
|
# @param starting_balance [MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::StartingBalance]
|
82
82
|
|
@@ -32,7 +32,7 @@ module MetronomeSDK
|
|
32
32
|
|
33
33
|
# @!attribute deductions
|
34
34
|
#
|
35
|
-
# @return [Array<MetronomeSDK::V1::CreditLedgerEntry>]
|
35
|
+
# @return [Array<MetronomeSDK::Models::V1::CreditLedgerEntry>]
|
36
36
|
required :deductions,
|
37
37
|
-> {
|
38
38
|
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::CreditLedgerEntry]
|
@@ -67,7 +67,7 @@ module MetronomeSDK
|
|
67
67
|
|
68
68
|
# @!attribute pending_deductions
|
69
69
|
#
|
70
|
-
# @return [Array<MetronomeSDK::V1::CreditLedgerEntry>]
|
70
|
+
# @return [Array<MetronomeSDK::Models::V1::CreditLedgerEntry>]
|
71
71
|
required :pending_deductions,
|
72
72
|
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::CreditLedgerEntry] }
|
73
73
|
|
@@ -121,7 +121,7 @@ module MetronomeSDK
|
|
121
121
|
#
|
122
122
|
# @param customer_id [String] the Metronome ID of the customer
|
123
123
|
#
|
124
|
-
# @param deductions [Array<MetronomeSDK::V1::CreditLedgerEntry>]
|
124
|
+
# @param deductions [Array<MetronomeSDK::Models::V1::CreditLedgerEntry>]
|
125
125
|
#
|
126
126
|
# @param effective_at [Time]
|
127
127
|
#
|
@@ -133,7 +133,7 @@ module MetronomeSDK
|
|
133
133
|
#
|
134
134
|
# @param paid_amount [MetronomeSDK::Models::V1::CreditGrantListResponse::PaidAmount] the amount paid for this credit grant
|
135
135
|
#
|
136
|
-
# @param pending_deductions [Array<MetronomeSDK::V1::CreditLedgerEntry>]
|
136
|
+
# @param pending_deductions [Array<MetronomeSDK::Models::V1::CreditLedgerEntry>]
|
137
137
|
#
|
138
138
|
# @param priority [Float]
|
139
139
|
#
|
@@ -195,7 +195,7 @@ module MetronomeSDK
|
|
195
195
|
# @!attribute credit_type
|
196
196
|
# the credit type for the amount granted
|
197
197
|
#
|
198
|
-
# @return [MetronomeSDK::CreditTypeData]
|
198
|
+
# @return [MetronomeSDK::Models::CreditTypeData]
|
199
199
|
required :credit_type, -> { MetronomeSDK::CreditTypeData }
|
200
200
|
|
201
201
|
# @!method initialize(amount:, credit_type:)
|
@@ -203,7 +203,7 @@ module MetronomeSDK
|
|
203
203
|
#
|
204
204
|
# @param amount [Float]
|
205
205
|
#
|
206
|
-
# @param credit_type [MetronomeSDK::CreditTypeData] the credit type for the amount granted
|
206
|
+
# @param credit_type [MetronomeSDK::Models::CreditTypeData] the credit type for the amount granted
|
207
207
|
end
|
208
208
|
|
209
209
|
# @see MetronomeSDK::Models::V1::CreditGrantListResponse#paid_amount
|
@@ -216,7 +216,7 @@ module MetronomeSDK
|
|
216
216
|
# @!attribute credit_type
|
217
217
|
# the credit type for the amount paid
|
218
218
|
#
|
219
|
-
# @return [MetronomeSDK::CreditTypeData]
|
219
|
+
# @return [MetronomeSDK::Models::CreditTypeData]
|
220
220
|
required :credit_type, -> { MetronomeSDK::CreditTypeData }
|
221
221
|
|
222
222
|
# @!method initialize(amount:, credit_type:)
|
@@ -224,7 +224,7 @@ module MetronomeSDK
|
|
224
224
|
#
|
225
225
|
# @param amount [Float]
|
226
226
|
#
|
227
|
-
# @param credit_type [MetronomeSDK::CreditTypeData] the credit type for the amount paid
|
227
|
+
# @param credit_type [MetronomeSDK::Models::CreditTypeData] the credit type for the amount paid
|
228
228
|
end
|
229
229
|
|
230
230
|
class Product < MetronomeSDK::Internal::Type::BaseModel
|
@@ -7,11 +7,11 @@ module MetronomeSDK
|
|
7
7
|
class CreditGrantVoidResponse < MetronomeSDK::Internal::Type::BaseModel
|
8
8
|
# @!attribute data
|
9
9
|
#
|
10
|
-
# @return [MetronomeSDK::ID]
|
10
|
+
# @return [MetronomeSDK::Models::ID]
|
11
11
|
required :data, -> { MetronomeSDK::ID }
|
12
12
|
|
13
13
|
# @!method initialize(data:)
|
14
|
-
# @param data [MetronomeSDK::ID]
|
14
|
+
# @param data [MetronomeSDK::Models::ID]
|
15
15
|
end
|
16
16
|
end
|
17
17
|
end
|
@@ -48,7 +48,7 @@ module MetronomeSDK
|
|
48
48
|
|
49
49
|
# @!method initialize(amount:, created_by:, credit_grant_id:, effective_at:, reason:, running_balance:, invoice_id: nil)
|
50
50
|
# Some parameter documentations has been truncated, see
|
51
|
-
# {MetronomeSDK::V1::CreditLedgerEntry} for more details.
|
51
|
+
# {MetronomeSDK::Models::V1::CreditLedgerEntry} for more details.
|
52
52
|
#
|
53
53
|
# @param amount [Float] an amount representing the change to the customer's credit balance
|
54
54
|
#
|
@@ -15,7 +15,7 @@ module MetronomeSDK
|
|
15
15
|
|
16
16
|
# @!attribute entity
|
17
17
|
#
|
18
|
-
# @return [Symbol, MetronomeSDK::V1::CustomFieldAddKeyParams::Entity]
|
18
|
+
# @return [Symbol, MetronomeSDK::Models::V1::CustomFieldAddKeyParams::Entity]
|
19
19
|
required :entity, enum: -> { MetronomeSDK::V1::CustomFieldAddKeyParams::Entity }
|
20
20
|
|
21
21
|
# @!attribute key
|
@@ -25,7 +25,7 @@ module MetronomeSDK
|
|
25
25
|
|
26
26
|
# @!method initialize(enforce_uniqueness:, entity:, key:, request_options: {})
|
27
27
|
# @param enforce_uniqueness [Boolean]
|
28
|
-
# @param entity [Symbol, MetronomeSDK::V1::CustomFieldAddKeyParams::Entity]
|
28
|
+
# @param entity [Symbol, MetronomeSDK::Models::V1::CustomFieldAddKeyParams::Entity]
|
29
29
|
# @param key [String]
|
30
30
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
|
31
31
|
|
@@ -10,7 +10,7 @@ module MetronomeSDK
|
|
10
10
|
|
11
11
|
# @!attribute entity
|
12
12
|
#
|
13
|
-
# @return [Symbol, MetronomeSDK::V1::CustomFieldDeleteValuesParams::Entity]
|
13
|
+
# @return [Symbol, MetronomeSDK::Models::V1::CustomFieldDeleteValuesParams::Entity]
|
14
14
|
required :entity, enum: -> { MetronomeSDK::V1::CustomFieldDeleteValuesParams::Entity }
|
15
15
|
|
16
16
|
# @!attribute entity_id
|
@@ -24,7 +24,7 @@ module MetronomeSDK
|
|
24
24
|
required :keys, MetronomeSDK::Internal::Type::ArrayOf[String]
|
25
25
|
|
26
26
|
# @!method initialize(entity:, entity_id:, keys:, request_options: {})
|
27
|
-
# @param entity [Symbol, MetronomeSDK::V1::CustomFieldDeleteValuesParams::Entity]
|
27
|
+
# @param entity [Symbol, MetronomeSDK::Models::V1::CustomFieldDeleteValuesParams::Entity]
|
28
28
|
# @param entity_id [String]
|
29
29
|
# @param keys [Array<String>]
|
30
30
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
|
@@ -17,7 +17,7 @@ module MetronomeSDK
|
|
17
17
|
# @!attribute entities
|
18
18
|
# Optional list of entity types to return keys for
|
19
19
|
#
|
20
|
-
# @return [Array<Symbol, MetronomeSDK::V1::CustomFieldListKeysParams::Entity>, nil]
|
20
|
+
# @return [Array<Symbol, MetronomeSDK::Models::V1::CustomFieldListKeysParams::Entity>, nil]
|
21
21
|
optional :entities,
|
22
22
|
-> {
|
23
23
|
MetronomeSDK::Internal::Type::ArrayOf[enum: MetronomeSDK::V1::CustomFieldListKeysParams::Entity]
|
@@ -26,7 +26,7 @@ module MetronomeSDK
|
|
26
26
|
# @!method initialize(next_page: nil, entities: nil, request_options: {})
|
27
27
|
# @param next_page [String] Cursor that indicates where the next page of results should start.
|
28
28
|
#
|
29
|
-
# @param entities [Array<Symbol, MetronomeSDK::V1::CustomFieldListKeysParams::Entity>] Optional list of entity types to return keys for
|
29
|
+
# @param entities [Array<Symbol, MetronomeSDK::Models::V1::CustomFieldListKeysParams::Entity>] Optional list of entity types to return keys for
|
30
30
|
#
|
31
31
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
|
32
32
|
|
@@ -10,7 +10,7 @@ module MetronomeSDK
|
|
10
10
|
|
11
11
|
# @!attribute entity
|
12
12
|
#
|
13
|
-
# @return [Symbol, MetronomeSDK::V1::CustomFieldRemoveKeyParams::Entity]
|
13
|
+
# @return [Symbol, MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams::Entity]
|
14
14
|
required :entity, enum: -> { MetronomeSDK::V1::CustomFieldRemoveKeyParams::Entity }
|
15
15
|
|
16
16
|
# @!attribute key
|
@@ -19,7 +19,7 @@ module MetronomeSDK
|
|
19
19
|
required :key, String
|
20
20
|
|
21
21
|
# @!method initialize(entity:, key:, request_options: {})
|
22
|
-
# @param entity [Symbol, MetronomeSDK::V1::CustomFieldRemoveKeyParams::Entity]
|
22
|
+
# @param entity [Symbol, MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams::Entity]
|
23
23
|
# @param key [String]
|
24
24
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
|
25
25
|
|
@@ -15,7 +15,7 @@ module MetronomeSDK
|
|
15
15
|
|
16
16
|
# @!attribute entity
|
17
17
|
#
|
18
|
-
# @return [Symbol, MetronomeSDK::V1::CustomFieldSetValuesParams::Entity]
|
18
|
+
# @return [Symbol, MetronomeSDK::Models::V1::CustomFieldSetValuesParams::Entity]
|
19
19
|
required :entity, enum: -> { MetronomeSDK::V1::CustomFieldSetValuesParams::Entity }
|
20
20
|
|
21
21
|
# @!attribute entity_id
|
@@ -25,7 +25,7 @@ module MetronomeSDK
|
|
25
25
|
|
26
26
|
# @!method initialize(custom_fields:, entity:, entity_id:, request_options: {})
|
27
27
|
# @param custom_fields [Hash{Symbol=>String}]
|
28
|
-
# @param entity [Symbol, MetronomeSDK::V1::CustomFieldSetValuesParams::Entity]
|
28
|
+
# @param entity [Symbol, MetronomeSDK::Models::V1::CustomFieldSetValuesParams::Entity]
|
29
29
|
# @param entity_id [String]
|
30
30
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
|
31
31
|
|
@@ -36,7 +36,7 @@ module MetronomeSDK
|
|
36
36
|
|
37
37
|
# @!method initialize(id:, external_id:, ingest_aliases:, name:, custom_fields: nil)
|
38
38
|
# Some parameter documentations has been truncated, see
|
39
|
-
# {MetronomeSDK::V1::Customer} for more details.
|
39
|
+
# {MetronomeSDK::Models::V1::Customer} for more details.
|
40
40
|
#
|
41
41
|
# @param id [String] the Metronome ID of the customer
|
42
42
|
#
|
@@ -7,11 +7,11 @@ module MetronomeSDK
|
|
7
7
|
class CustomerArchiveResponse < MetronomeSDK::Internal::Type::BaseModel
|
8
8
|
# @!attribute data
|
9
9
|
#
|
10
|
-
# @return [MetronomeSDK::ID]
|
10
|
+
# @return [MetronomeSDK::Models::ID]
|
11
11
|
required :data, -> { MetronomeSDK::ID }
|
12
12
|
|
13
13
|
# @!method initialize(data:)
|
14
|
-
# @param data [MetronomeSDK::ID]
|
14
|
+
# @param data [MetronomeSDK::Models::ID]
|
15
15
|
end
|
16
16
|
end
|
17
17
|
end
|