metronome-sdk 0.1.0.pre.alpha.1 → 0.1.0.pre.alpha.2
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 +52 -0
- data/README.md +22 -11
- data/lib/metronome_sdk/errors.rb +1 -1
- data/lib/metronome_sdk/file_part.rb +2 -2
- data/lib/metronome_sdk/internal/cursor_page.rb +3 -3
- data/lib/metronome_sdk/internal/transport/base_client.rb +80 -8
- data/lib/metronome_sdk/internal/transport/pooled_net_requester.rb +14 -0
- data/lib/metronome_sdk/internal/type/array_of.rb +1 -1
- data/lib/metronome_sdk/internal/type/base_model.rb +63 -39
- data/lib/metronome_sdk/internal/type/converter.rb +18 -0
- data/lib/metronome_sdk/internal/type/enum.rb +1 -0
- data/lib/metronome_sdk/internal/type/hash_of.rb +1 -1
- data/lib/metronome_sdk/internal/type/request_parameters.rb +6 -12
- data/lib/metronome_sdk/internal/type/union.rb +1 -0
- data/lib/metronome_sdk/internal/util.rb +77 -5
- data/lib/metronome_sdk/internal.rb +6 -0
- data/lib/metronome_sdk/models/commit.rb +129 -110
- data/lib/metronome_sdk/models/contract_without_amendments.rb +245 -239
- data/lib/metronome_sdk/models/credit.rb +68 -60
- data/lib/metronome_sdk/models/discount.rb +7 -7
- data/lib/metronome_sdk/models/event_type_filter.rb +1 -3
- data/lib/metronome_sdk/models/override.rb +45 -51
- data/lib/metronome_sdk/models/pro_service.rb +2 -4
- data/lib/metronome_sdk/models/property_filter.rb +1 -4
- data/lib/metronome_sdk/models/rate.rb +12 -17
- data/lib/metronome_sdk/models/schedule_duration.rb +6 -6
- data/lib/metronome_sdk/models/schedule_point_in_time.rb +6 -6
- data/lib/metronome_sdk/models/scheduled_charge.rb +7 -7
- data/lib/metronome_sdk/models/v1/alert_archive_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/alert_create_params.rb +15 -23
- data/lib/metronome_sdk/models/v1/alert_create_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/audit_log_list_params.rb +3 -6
- data/lib/metronome_sdk/models/v1/billable_metric_archive_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/billable_metric_create_params.rb +9 -15
- data/lib/metronome_sdk/models/v1/billable_metric_create_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/billable_metric_list_response.rb +6 -11
- data/lib/metronome_sdk/models/v1/billable_metric_retrieve_response.rb +8 -10
- data/lib/metronome_sdk/models/v1/contract_add_manual_balance_entry_params.rb +0 -2
- data/lib/metronome_sdk/models/v1/contract_amend_params.rb +229 -234
- data/lib/metronome_sdk/models/v1/contract_amend_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/contract_archive_params.rb +0 -1
- data/lib/metronome_sdk/models/v1/contract_archive_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/contract_create_historical_invoices_params.rb +27 -21
- data/lib/metronome_sdk/models/v1/contract_create_historical_invoices_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/contract_create_params.rb +625 -622
- data/lib/metronome_sdk/models/v1/contract_create_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/contract_list_balances_params.rb +0 -2
- data/lib/metronome_sdk/models/v1/contract_list_balances_response.rb +9 -5
- data/lib/metronome_sdk/models/v1/contract_list_params.rb +0 -4
- data/lib/metronome_sdk/models/v1/contract_list_response.rb +424 -29
- data/lib/metronome_sdk/models/v1/contract_retrieve_params.rb +0 -2
- data/lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rb +7 -10
- data/lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rb +9 -10
- data/lib/metronome_sdk/models/v1/contract_retrieve_response.rb +424 -29
- data/lib/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_params.rb +7 -7
- data/lib/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/contract_update_end_date_params.rb +0 -2
- data/lib/metronome_sdk/models/v1/contract_update_end_date_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/contracts/named_schedule_retrieve_params.rb +0 -1
- data/lib/metronome_sdk/models/v1/contracts/named_schedule_update_params.rb +0 -1
- data/lib/metronome_sdk/models/v1/contracts/product_archive_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/contracts/product_create_params.rb +9 -15
- data/lib/metronome_sdk/models/v1/contracts/product_create_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/contracts/product_list_item_state.rb +7 -11
- data/lib/metronome_sdk/models/v1/contracts/product_list_params.rb +3 -4
- data/lib/metronome_sdk/models/v1/contracts/product_list_response.rb +12 -16
- data/lib/metronome_sdk/models/v1/contracts/product_retrieve_response.rb +16 -16
- data/lib/metronome_sdk/models/v1/contracts/product_update_params.rb +6 -18
- data/lib/metronome_sdk/models/v1/contracts/product_update_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/contracts/quantity_conversion.rb +4 -4
- data/lib/metronome_sdk/models/v1/contracts/quantity_rounding.rb +6 -4
- data/lib/metronome_sdk/models/v1/contracts/rate_card_archive_params.rb +18 -0
- data/lib/metronome_sdk/models/v1/contracts/rate_card_archive_response.rb +20 -0
- data/lib/metronome_sdk/models/v1/contracts/rate_card_create_params.rb +10 -8
- data/lib/metronome_sdk/models/v1/contracts/rate_card_create_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/contracts/rate_card_list_response.rb +6 -6
- data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rb +7 -9
- data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rb +6 -7
- data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rb +6 -6
- data/lib/metronome_sdk/models/v1/contracts/rate_card_update_params.rb +5 -4
- data/lib/metronome_sdk/models/v1/contracts/rate_card_update_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_params.rb +0 -1
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_update_params.rb +0 -1
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_params.rb +5 -3
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rb +29 -30
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb +18 -23
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rb +9 -15
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_params.rb +7 -9
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rb +6 -7
- data/lib/metronome_sdk/models/v1/credit_grant_create_params.rb +26 -24
- data/lib/metronome_sdk/models/v1/credit_grant_create_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/credit_grant_edit_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/credit_grant_list_entries_params.rb +0 -4
- data/lib/metronome_sdk/models/v1/credit_grant_list_entries_response.rb +11 -15
- data/lib/metronome_sdk/models/v1/credit_grant_list_params.rb +0 -3
- data/lib/metronome_sdk/models/v1/credit_grant_list_response.rb +14 -18
- data/lib/metronome_sdk/models/v1/credit_grant_void_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/credit_ledger_entry.rb +1 -3
- data/lib/metronome_sdk/models/v1/custom_field_add_key_params.rb +3 -3
- data/lib/metronome_sdk/models/v1/custom_field_delete_values_params.rb +3 -3
- data/lib/metronome_sdk/models/v1/custom_field_list_keys_params.rb +5 -3
- data/lib/metronome_sdk/models/v1/custom_field_remove_key_params.rb +3 -3
- data/lib/metronome_sdk/models/v1/custom_field_set_values_params.rb +3 -3
- data/lib/metronome_sdk/models/v1/customer.rb +1 -3
- data/lib/metronome_sdk/models/v1/customer_archive_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/customer_create_params.rb +33 -32
- data/lib/metronome_sdk/models/v1/customer_create_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/customer_detail.rb +13 -16
- data/lib/metronome_sdk/models/v1/customer_list_billable_metrics_params.rb +0 -1
- data/lib/metronome_sdk/models/v1/customer_list_billable_metrics_response.rb +6 -11
- data/lib/metronome_sdk/models/v1/customer_list_params.rb +0 -2
- data/lib/metronome_sdk/models/v1/customer_retrieve_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/customer_set_name_params.rb +0 -1
- data/lib/metronome_sdk/models/v1/customer_set_name_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/customer_update_config_params.rb +0 -1
- data/lib/metronome_sdk/models/v1/customers/alert_list_params.rb +5 -4
- data/lib/metronome_sdk/models/v1/customers/alert_list_response.rb +5 -3
- data/lib/metronome_sdk/models/v1/customers/alert_retrieve_params.rb +26 -1
- data/lib/metronome_sdk/models/v1/customers/alert_retrieve_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/customers/billing_config_create_params.rb +9 -11
- data/lib/metronome_sdk/models/v1/customers/billing_config_delete_params.rb +3 -3
- data/lib/metronome_sdk/models/v1/customers/billing_config_retrieve_params.rb +3 -3
- data/lib/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rb +0 -3
- data/lib/metronome_sdk/models/v1/customers/commit_create_params.rb +44 -51
- data/lib/metronome_sdk/models/v1/customers/commit_create_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/customers/commit_list_params.rb +0 -2
- data/lib/metronome_sdk/models/v1/customers/commit_list_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/customers/commit_update_end_date_params.rb +0 -2
- data/lib/metronome_sdk/models/v1/customers/commit_update_end_date_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/customers/credit_create_params.rb +11 -14
- data/lib/metronome_sdk/models/v1/customers/credit_create_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/customers/credit_list_params.rb +0 -2
- data/lib/metronome_sdk/models/v1/customers/credit_list_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/customers/credit_update_end_date_params.rb +0 -1
- data/lib/metronome_sdk/models/v1/customers/credit_update_end_date_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/customers/customer_alert.rb +38 -37
- data/lib/metronome_sdk/models/v1/customers/invoice.rb +137 -118
- data/lib/metronome_sdk/models/v1/customers/invoice_add_charge_params.rb +0 -2
- data/lib/metronome_sdk/models/v1/customers/invoice_list_breakdowns_params.rb +8 -10
- data/lib/metronome_sdk/models/v1/customers/invoice_list_params.rb +3 -6
- data/lib/metronome_sdk/models/v1/customers/invoice_retrieve_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/customers/named_schedule_retrieve_params.rb +0 -1
- data/lib/metronome_sdk/models/v1/customers/named_schedule_update_params.rb +0 -1
- data/lib/metronome_sdk/models/v1/customers/plan_add_params.rb +24 -30
- data/lib/metronome_sdk/models/v1/customers/plan_add_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/customers/plan_end_params.rb +0 -3
- data/lib/metronome_sdk/models/v1/customers/plan_list_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rb +24 -20
- data/lib/metronome_sdk/models/v1/plan_detail.rb +28 -28
- data/lib/metronome_sdk/models/v1/plan_get_details_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/plan_list_charges_response.rb +3 -6
- data/lib/metronome_sdk/models/v1/plan_list_customers_params.rb +3 -3
- data/lib/metronome_sdk/models/v1/plan_list_customers_response.rb +3 -3
- data/lib/metronome_sdk/models/v1/rollover_amount_max_amount.rb +4 -4
- data/lib/metronome_sdk/models/v1/rollover_amount_max_percentage.rb +4 -4
- data/lib/metronome_sdk/models/v1/usage_ingest_params.rb +5 -3
- data/lib/metronome_sdk/models/v1/usage_list_params.rb +13 -16
- data/lib/metronome_sdk/models/v1/usage_list_response.rb +0 -1
- data/lib/metronome_sdk/models/v1/usage_list_with_groups_params.rb +7 -10
- data/lib/metronome_sdk/models/v2/contract_edit_commit_params.rb +36 -26
- data/lib/metronome_sdk/models/v2/contract_edit_commit_response.rb +3 -3
- data/lib/metronome_sdk/models/v2/contract_edit_credit_params.rb +18 -14
- data/lib/metronome_sdk/models/v2/contract_edit_credit_response.rb +3 -3
- data/lib/metronome_sdk/models/v2/contract_edit_params.rb +979 -460
- data/lib/metronome_sdk/models/v2/contract_edit_response.rb +3 -3
- data/lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb +24 -47
- data/lib/metronome_sdk/models/v2/contract_list_params.rb +0 -4
- data/lib/metronome_sdk/models/v2/contract_list_response.rb +273 -161
- data/lib/metronome_sdk/models/v2/contract_retrieve_params.rb +0 -3
- data/lib/metronome_sdk/models/v2/contract_retrieve_response.rb +273 -161
- data/lib/metronome_sdk/models.rb +66 -0
- data/lib/metronome_sdk/request_options.rb +4 -0
- data/lib/metronome_sdk/resources/v1/alerts.rb +5 -15
- data/lib/metronome_sdk/resources/v1/audit_logs.rb +2 -5
- data/lib/metronome_sdk/resources/v1/billable_metrics.rb +7 -11
- data/lib/metronome_sdk/resources/v1/contracts/named_schedules.rb +2 -4
- data/lib/metronome_sdk/resources/v1/contracts/products.rb +11 -29
- data/lib/metronome_sdk/resources/v1/contracts/rate_cards/named_schedules.rb +2 -5
- data/lib/metronome_sdk/resources/v1/contracts/rate_cards/product_orders.rb +3 -5
- data/lib/metronome_sdk/resources/v1/contracts/rate_cards/rates.rb +8 -16
- data/lib/metronome_sdk/resources/v1/contracts/rate_cards.rb +30 -15
- data/lib/metronome_sdk/resources/v1/contracts.rb +41 -60
- data/lib/metronome_sdk/resources/v1/credit_grants.rb +9 -21
- data/lib/metronome_sdk/resources/v1/custom_fields.rb +10 -10
- data/lib/metronome_sdk/resources/v1/customers/alerts.rb +10 -6
- data/lib/metronome_sdk/resources/v1/customers/billing_config.rb +8 -9
- data/lib/metronome_sdk/resources/v1/customers/commits.rb +7 -20
- data/lib/metronome_sdk/resources/v1/customers/credits.rb +5 -13
- data/lib/metronome_sdk/resources/v1/customers/invoices.rb +9 -21
- data/lib/metronome_sdk/resources/v1/customers/named_schedules.rb +2 -4
- data/lib/metronome_sdk/resources/v1/customers/plans.rb +7 -17
- data/lib/metronome_sdk/resources/v1/customers.rb +13 -20
- data/lib/metronome_sdk/resources/v1/dashboards.rb +5 -5
- data/lib/metronome_sdk/resources/v1/invoices.rb +2 -2
- data/lib/metronome_sdk/resources/v1/plans.rb +5 -5
- data/lib/metronome_sdk/resources/v1/pricing_units.rb +1 -1
- data/lib/metronome_sdk/resources/v1/usage.rb +8 -13
- data/lib/metronome_sdk/resources/v2/contracts.rb +39 -39
- data/lib/metronome_sdk/version.rb +1 -1
- data/lib/metronome_sdk.rb +5 -0
- data/rbi/metronome_sdk/client.rbi +5 -4
- data/rbi/metronome_sdk/errors.rbi +34 -15
- data/rbi/metronome_sdk/file_part.rbi +9 -6
- data/rbi/metronome_sdk/internal/cursor_page.rbi +2 -1
- data/rbi/metronome_sdk/internal/transport/base_client.rbi +165 -77
- data/rbi/metronome_sdk/internal/transport/pooled_net_requester.rbi +29 -13
- data/rbi/metronome_sdk/internal/type/array_of.rbi +34 -24
- data/rbi/metronome_sdk/internal/type/base_model.rbi +155 -70
- data/rbi/metronome_sdk/internal/type/base_page.rbi +13 -8
- data/rbi/metronome_sdk/internal/type/boolean.rbi +16 -14
- data/rbi/metronome_sdk/internal/type/converter.rbi +72 -28
- data/rbi/metronome_sdk/internal/type/enum.rbi +24 -13
- data/rbi/metronome_sdk/internal/type/file_input.rbi +8 -4
- data/rbi/metronome_sdk/internal/type/hash_of.rbi +34 -24
- data/rbi/metronome_sdk/internal/type/request_parameters.rbi +14 -4
- data/rbi/metronome_sdk/internal/type/union.rbi +53 -22
- data/rbi/metronome_sdk/internal/type/unknown.rbi +16 -6
- data/rbi/metronome_sdk/internal/util.rbi +238 -89
- data/rbi/metronome_sdk/internal.rbi +2 -0
- data/rbi/metronome_sdk/models/base_usage_filter.rbi +23 -4
- data/rbi/metronome_sdk/models/commit.rbi +792 -450
- data/rbi/metronome_sdk/models/contract_without_amendments.rbi +1303 -771
- data/rbi/metronome_sdk/models/credit.rbi +405 -223
- data/rbi/metronome_sdk/models/credit_type_data.rbi +10 -3
- data/rbi/metronome_sdk/models/discount.rbi +40 -24
- data/rbi/metronome_sdk/models/event_type_filter.rbi +21 -4
- data/rbi/metronome_sdk/models/id.rbi +10 -3
- data/rbi/metronome_sdk/models/override.rbi +243 -137
- data/rbi/metronome_sdk/models/pro_service.rbi +23 -17
- data/rbi/metronome_sdk/models/property_filter.rbi +24 -11
- data/rbi/metronome_sdk/models/rate.rbi +47 -35
- data/rbi/metronome_sdk/models/schedule_duration.rbi +51 -20
- data/rbi/metronome_sdk/models/schedule_point_in_time.rbi +63 -34
- data/rbi/metronome_sdk/models/scheduled_charge.rbi +41 -26
- data/rbi/metronome_sdk/models/tier.rbi +10 -3
- data/rbi/metronome_sdk/models/v1/alert_archive_params.rbi +22 -11
- data/rbi/metronome_sdk/models/v1/alert_archive_response.rbi +16 -6
- data/rbi/metronome_sdk/models/v1/alert_create_params.rbi +171 -77
- data/rbi/metronome_sdk/models/v1/alert_create_response.rbi +16 -6
- data/rbi/metronome_sdk/models/v1/audit_log_list_params.rbi +59 -26
- data/rbi/metronome_sdk/models/v1/audit_log_list_response.rbi +127 -45
- data/rbi/metronome_sdk/models/v1/billable_metric_archive_params.rbi +18 -5
- data/rbi/metronome_sdk/models/v1/billable_metric_archive_response.rbi +16 -6
- data/rbi/metronome_sdk/models/v1/billable_metric_create_params.rbi +84 -41
- data/rbi/metronome_sdk/models/v1/billable_metric_create_response.rbi +16 -6
- data/rbi/metronome_sdk/models/v1/billable_metric_list_params.rbi +23 -14
- data/rbi/metronome_sdk/models/v1/billable_metric_list_response.rbi +84 -41
- data/rbi/metronome_sdk/models/v1/billable_metric_retrieve_params.rbi +22 -6
- data/rbi/metronome_sdk/models/v1/billable_metric_retrieve_response.rbi +98 -51
- data/rbi/metronome_sdk/models/v1/contract_add_manual_balance_entry_params.rbi +27 -18
- data/rbi/metronome_sdk/models/v1/contract_amend_params.rbi +1469 -779
- data/rbi/metronome_sdk/models/v1/contract_amend_response.rbi +16 -6
- data/rbi/metronome_sdk/models/v1/contract_archive_params.rbi +23 -14
- data/rbi/metronome_sdk/models/v1/contract_archive_response.rbi +16 -6
- data/rbi/metronome_sdk/models/v1/contract_create_historical_invoices_params.rbi +178 -110
- data/rbi/metronome_sdk/models/v1/contract_create_historical_invoices_response.rbi +20 -7
- data/rbi/metronome_sdk/models/v1/contract_create_params.rbi +3311 -2108
- data/rbi/metronome_sdk/models/v1/contract_create_response.rbi +16 -6
- data/rbi/metronome_sdk/models/v1/contract_list_balances_params.rbi +30 -21
- data/rbi/metronome_sdk/models/v1/contract_list_balances_response.rbi +41 -15
- data/rbi/metronome_sdk/models/v1/contract_list_params.rbi +26 -17
- data/rbi/metronome_sdk/models/v1/contract_list_response.rbi +1167 -182
- data/rbi/metronome_sdk/models/v1/contract_retrieve_params.rbi +24 -15
- data/rbi/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rbi +72 -46
- data/rbi/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rbi +122 -78
- data/rbi/metronome_sdk/models/v1/contract_retrieve_response.rbi +1163 -190
- data/rbi/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_params.rbi +66 -41
- data/rbi/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_response.rbi +20 -7
- data/rbi/metronome_sdk/models/v1/contract_set_usage_filter_params.rbi +22 -15
- data/rbi/metronome_sdk/models/v1/contract_update_end_date_params.rbi +24 -15
- data/rbi/metronome_sdk/models/v1/contract_update_end_date_response.rbi +16 -6
- data/rbi/metronome_sdk/models/v1/contracts/named_schedule_retrieve_params.rbi +23 -14
- data/rbi/metronome_sdk/models/v1/contracts/named_schedule_retrieve_response.rbi +54 -17
- data/rbi/metronome_sdk/models/v1/contracts/named_schedule_update_params.rbi +25 -16
- data/rbi/metronome_sdk/models/v1/contracts/product_archive_params.rbi +23 -6
- data/rbi/metronome_sdk/models/v1/contracts/product_archive_response.rbi +18 -6
- data/rbi/metronome_sdk/models/v1/contracts/product_create_params.rbi +107 -46
- data/rbi/metronome_sdk/models/v1/contracts/product_create_response.rbi +18 -6
- data/rbi/metronome_sdk/models/v1/contracts/product_list_item_state.rbi +58 -35
- data/rbi/metronome_sdk/models/v1/contracts/product_list_params.rbi +63 -25
- data/rbi/metronome_sdk/models/v1/contracts/product_list_response.rbi +163 -73
- data/rbi/metronome_sdk/models/v1/contracts/product_retrieve_params.rbi +18 -5
- data/rbi/metronome_sdk/models/v1/contracts/product_retrieve_response.rbi +188 -87
- data/rbi/metronome_sdk/models/v1/contracts/product_update_params.rbi +59 -36
- data/rbi/metronome_sdk/models/v1/contracts/product_update_response.rbi +18 -6
- data/rbi/metronome_sdk/models/v1/contracts/quantity_conversion.rbi +51 -20
- data/rbi/metronome_sdk/models/v1/contracts/quantity_rounding.rbi +52 -20
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_archive_params.rbi +36 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_archive_response.rbi +35 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_create_params.rbi +109 -45
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_create_response.rbi +18 -6
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_list_params.rbi +23 -14
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_list_response.rbi +116 -55
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_params.rbi +18 -5
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rbi +67 -45
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rbi +111 -75
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rbi +147 -81
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_update_params.rbi +70 -25
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_update_response.rbi +18 -6
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_params.rbi +24 -15
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_response.rbi +54 -19
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_update_params.rbi +26 -17
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_params.rbi +22 -13
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_response.rbi +18 -6
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_params.rbi +55 -24
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_response.rbi +18 -6
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rbi +153 -100
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_response.rbi +19 -6
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbi +139 -79
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rbi +141 -82
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_list_params.rbi +73 -45
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rbi +84 -55
- data/rbi/metronome_sdk/models/v1/credit_grant_create_params.rbi +145 -80
- data/rbi/metronome_sdk/models/v1/credit_grant_create_response.rbi +16 -6
- data/rbi/metronome_sdk/models/v1/credit_grant_edit_params.rbi +24 -15
- data/rbi/metronome_sdk/models/v1/credit_grant_edit_response.rbi +16 -6
- data/rbi/metronome_sdk/models/v1/credit_grant_list_entries_params.rbi +25 -16
- data/rbi/metronome_sdk/models/v1/credit_grant_list_entries_response.rbi +162 -77
- data/rbi/metronome_sdk/models/v1/credit_grant_list_params.rbi +27 -18
- data/rbi/metronome_sdk/models/v1/credit_grant_list_response.rbi +169 -72
- data/rbi/metronome_sdk/models/v1/credit_grant_void_params.rbi +23 -14
- data/rbi/metronome_sdk/models/v1/credit_grant_void_response.rbi +16 -6
- data/rbi/metronome_sdk/models/v1/credit_ledger_entry.rbi +25 -16
- data/rbi/metronome_sdk/models/v1/custom_field_add_key_params.rbi +122 -37
- data/rbi/metronome_sdk/models/v1/custom_field_delete_values_params.rbi +120 -37
- data/rbi/metronome_sdk/models/v1/custom_field_list_keys_params.rbi +140 -37
- data/rbi/metronome_sdk/models/v1/custom_field_list_keys_response.rbi +136 -43
- data/rbi/metronome_sdk/models/v1/custom_field_remove_key_params.rbi +126 -36
- data/rbi/metronome_sdk/models/v1/custom_field_set_values_params.rbi +127 -37
- data/rbi/metronome_sdk/models/v1/customer.rbi +20 -14
- data/rbi/metronome_sdk/models/v1/customer_archive_params.rbi +18 -5
- data/rbi/metronome_sdk/models/v1/customer_archive_response.rbi +16 -6
- data/rbi/metronome_sdk/models/v1/customer_create_params.rbi +247 -158
- data/rbi/metronome_sdk/models/v1/customer_create_response.rbi +18 -7
- data/rbi/metronome_sdk/models/v1/customer_detail.rbi +111 -51
- data/rbi/metronome_sdk/models/v1/customer_list_billable_metrics_params.rbi +25 -16
- data/rbi/metronome_sdk/models/v1/customer_list_billable_metrics_response.rbi +69 -45
- data/rbi/metronome_sdk/models/v1/customer_list_costs_params.rbi +25 -16
- data/rbi/metronome_sdk/models/v1/customer_list_costs_response.rbi +100 -49
- data/rbi/metronome_sdk/models/v1/customer_list_params.rbi +26 -17
- data/rbi/metronome_sdk/models/v1/customer_retrieve_params.rbi +22 -6
- data/rbi/metronome_sdk/models/v1/customer_retrieve_response.rbi +18 -7
- data/rbi/metronome_sdk/models/v1/customer_set_ingest_aliases_params.rbi +21 -13
- data/rbi/metronome_sdk/models/v1/customer_set_name_params.rbi +22 -6
- data/rbi/metronome_sdk/models/v1/customer_set_name_response.rbi +18 -7
- data/rbi/metronome_sdk/models/v1/customer_update_config_params.rbi +23 -14
- data/rbi/metronome_sdk/models/v1/customers/alert_list_params.rbi +69 -25
- data/rbi/metronome_sdk/models/v1/customers/alert_list_response.rbi +22 -10
- data/rbi/metronome_sdk/models/v1/customers/alert_reset_params.rbi +15 -5
- data/rbi/metronome_sdk/models/v1/customers/alert_retrieve_params.rbi +77 -5
- data/rbi/metronome_sdk/models/v1/customers/alert_retrieve_response.rbi +24 -8
- data/rbi/metronome_sdk/models/v1/customers/billing_config_create_params.rbi +129 -79
- data/rbi/metronome_sdk/models/v1/customers/billing_config_delete_params.rbi +54 -29
- data/rbi/metronome_sdk/models/v1/customers/billing_config_retrieve_params.rbi +54 -29
- data/rbi/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbi +111 -68
- data/rbi/metronome_sdk/models/v1/customers/commit_create_params.rbi +320 -171
- data/rbi/metronome_sdk/models/v1/customers/commit_create_response.rbi +18 -6
- data/rbi/metronome_sdk/models/v1/customers/commit_list_params.rbi +30 -21
- data/rbi/metronome_sdk/models/v1/customers/commit_list_response.rbi +23 -7
- data/rbi/metronome_sdk/models/v1/customers/commit_update_end_date_params.rbi +24 -15
- data/rbi/metronome_sdk/models/v1/customers/commit_update_end_date_response.rbi +18 -6
- data/rbi/metronome_sdk/models/v1/customers/credit_create_params.rbi +141 -66
- data/rbi/metronome_sdk/models/v1/customers/credit_create_response.rbi +18 -6
- data/rbi/metronome_sdk/models/v1/customers/credit_list_params.rbi +30 -21
- data/rbi/metronome_sdk/models/v1/customers/credit_list_response.rbi +23 -7
- data/rbi/metronome_sdk/models/v1/customers/credit_update_end_date_params.rbi +23 -14
- data/rbi/metronome_sdk/models/v1/customers/credit_update_end_date_response.rbi +18 -6
- data/rbi/metronome_sdk/models/v1/customers/customer_alert.rbi +261 -134
- data/rbi/metronome_sdk/models/v1/customers/invoice.rbi +897 -473
- data/rbi/metronome_sdk/models/v1/customers/invoice_add_charge_params.rbi +27 -18
- data/rbi/metronome_sdk/models/v1/customers/invoice_add_charge_response.rbi +12 -2
- data/rbi/metronome_sdk/models/v1/customers/invoice_list_breakdowns_params.rbi +101 -43
- data/rbi/metronome_sdk/models/v1/customers/invoice_list_breakdowns_response.rbi +21 -4
- data/rbi/metronome_sdk/models/v1/customers/invoice_list_params.rbi +70 -28
- data/rbi/metronome_sdk/models/v1/customers/invoice_retrieve_params.rbi +23 -14
- data/rbi/metronome_sdk/models/v1/customers/invoice_retrieve_response.rbi +22 -7
- data/rbi/metronome_sdk/models/v1/customers/named_schedule_retrieve_params.rbi +23 -14
- data/rbi/metronome_sdk/models/v1/customers/named_schedule_retrieve_response.rbi +54 -17
- data/rbi/metronome_sdk/models/v1/customers/named_schedule_update_params.rbi +25 -16
- data/rbi/metronome_sdk/models/v1/customers/plan_add_params.rbi +205 -119
- data/rbi/metronome_sdk/models/v1/customers/plan_add_response.rbi +18 -6
- data/rbi/metronome_sdk/models/v1/customers/plan_end_params.rbi +25 -16
- data/rbi/metronome_sdk/models/v1/customers/plan_end_response.rbi +12 -2
- data/rbi/metronome_sdk/models/v1/customers/plan_list_params.rbi +23 -14
- data/rbi/metronome_sdk/models/v1/customers/plan_list_price_adjustments_params.rbi +24 -15
- data/rbi/metronome_sdk/models/v1/customers/plan_list_price_adjustments_response.rbi +98 -48
- data/rbi/metronome_sdk/models/v1/customers/plan_list_response.rbi +98 -50
- data/rbi/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rbi +215 -122
- data/rbi/metronome_sdk/models/v1/dashboard_get_embeddable_url_response.rbi +44 -13
- data/rbi/metronome_sdk/models/v1/invoice_regenerate_params.rbi +20 -9
- data/rbi/metronome_sdk/models/v1/invoice_regenerate_response.rbi +42 -13
- data/rbi/metronome_sdk/models/v1/invoice_void_params.rbi +20 -9
- data/rbi/metronome_sdk/models/v1/invoice_void_response.rbi +41 -11
- data/rbi/metronome_sdk/models/v1/plan_detail.rbi +136 -90
- data/rbi/metronome_sdk/models/v1/plan_get_details_params.rbi +19 -6
- data/rbi/metronome_sdk/models/v1/plan_get_details_response.rbi +18 -7
- data/rbi/metronome_sdk/models/v1/plan_list_charges_params.rbi +23 -14
- data/rbi/metronome_sdk/models/v1/plan_list_charges_response.rbi +167 -76
- data/rbi/metronome_sdk/models/v1/plan_list_customers_params.rbi +71 -25
- data/rbi/metronome_sdk/models/v1/plan_list_customers_response.rbi +59 -35
- data/rbi/metronome_sdk/models/v1/plan_list_params.rbi +22 -6
- data/rbi/metronome_sdk/models/v1/plan_list_response.rbi +18 -4
- data/rbi/metronome_sdk/models/v1/pricing_unit_list_params.rbi +22 -6
- data/rbi/metronome_sdk/models/v1/pricing_unit_list_response.rbi +23 -5
- data/rbi/metronome_sdk/models/v1/rollover_amount_max_amount.rbi +46 -10
- data/rbi/metronome_sdk/models/v1/rollover_amount_max_percentage.rbi +43 -11
- data/rbi/metronome_sdk/models/v1/service_list_params.rbi +18 -5
- data/rbi/metronome_sdk/models/v1/service_list_response.rbi +73 -24
- data/rbi/metronome_sdk/models/v1/usage_ingest_params.rbi +51 -31
- data/rbi/metronome_sdk/models/v1/usage_list_params.rbi +126 -45
- data/rbi/metronome_sdk/models/v1/usage_list_response.rbi +51 -24
- data/rbi/metronome_sdk/models/v1/usage_list_with_groups_params.rbi +96 -37
- data/rbi/metronome_sdk/models/v1/usage_list_with_groups_response.rbi +28 -14
- data/rbi/metronome_sdk/models/v2/contract_edit_commit_params.rbi +320 -169
- data/rbi/metronome_sdk/models/v2/contract_edit_commit_response.rbi +16 -6
- data/rbi/metronome_sdk/models/v2/contract_edit_credit_params.rbi +169 -89
- data/rbi/metronome_sdk/models/v2/contract_edit_credit_response.rbi +16 -6
- data/rbi/metronome_sdk/models/v2/contract_edit_params.rbi +4392 -1964
- data/rbi/metronome_sdk/models/v2/contract_edit_response.rbi +16 -6
- data/rbi/metronome_sdk/models/v2/contract_get_edit_history_params.rbi +14 -5
- data/rbi/metronome_sdk/models/v2/contract_get_edit_history_response.rbi +2147 -1376
- data/rbi/metronome_sdk/models/v2/contract_list_params.rbi +26 -17
- data/rbi/metronome_sdk/models/v2/contract_list_response.rbi +3138 -1686
- data/rbi/metronome_sdk/models/v2/contract_retrieve_params.rbi +25 -16
- data/rbi/metronome_sdk/models/v2/contract_retrieve_response.rbi +3092 -1728
- data/rbi/metronome_sdk/models.rbi +39 -0
- data/rbi/metronome_sdk/request_options.rbi +18 -7
- data/rbi/metronome_sdk/resources/v1/alerts.rbi +23 -11
- data/rbi/metronome_sdk/resources/v1/audit_logs.rbi +11 -5
- data/rbi/metronome_sdk/resources/v1/billable_metrics.rbi +31 -17
- data/rbi/metronome_sdk/resources/v1/contracts/named_schedules.rbi +13 -8
- data/rbi/metronome_sdk/resources/v1/contracts/products.rbi +59 -22
- data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/named_schedules.rbi +16 -9
- data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/product_orders.rbi +21 -14
- data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbi +37 -31
- data/rbi/metronome_sdk/resources/v1/contracts/rate_cards.rbi +77 -33
- data/rbi/metronome_sdk/resources/v1/contracts.rbi +141 -105
- data/rbi/metronome_sdk/resources/v1/credit_grants.rbi +36 -26
- data/rbi/metronome_sdk/resources/v1/custom_fields.rbi +34 -26
- data/rbi/metronome_sdk/resources/v1/customers/alerts.rbi +34 -11
- data/rbi/metronome_sdk/resources/v1/customers/billing_config.rbi +28 -17
- data/rbi/metronome_sdk/resources/v1/customers/commits.rbi +26 -22
- data/rbi/metronome_sdk/resources/v1/customers/credits.rbi +22 -17
- data/rbi/metronome_sdk/resources/v1/customers/invoices.rbi +36 -18
- data/rbi/metronome_sdk/resources/v1/customers/named_schedules.rbi +13 -8
- data/rbi/metronome_sdk/resources/v1/customers/plans.rbi +38 -30
- data/rbi/metronome_sdk/resources/v1/customers.rbi +65 -38
- data/rbi/metronome_sdk/resources/v1/dashboards.rbi +21 -24
- data/rbi/metronome_sdk/resources/v1/invoices.rbi +16 -7
- data/rbi/metronome_sdk/resources/v1/plans.rbi +37 -14
- data/rbi/metronome_sdk/resources/v1/pricing_units.rbi +14 -4
- data/rbi/metronome_sdk/resources/v1/services.rbi +9 -3
- data/rbi/metronome_sdk/resources/v1/usage.rbi +30 -17
- data/rbi/metronome_sdk/resources/v1.rbi +2 -1
- data/rbi/metronome_sdk/resources/v2/contracts.rbi +119 -69
- data/rbi/metronome_sdk/resources/v2.rbi +2 -1
- data/sig/metronome_sdk/internal/transport/base_client.rbs +16 -1
- data/sig/metronome_sdk/internal/transport/pooled_net_requester.rbs +2 -0
- data/sig/metronome_sdk/internal/type/base_model.rbs +11 -5
- data/sig/metronome_sdk/internal/type/base_page.rbs +1 -1
- data/sig/metronome_sdk/internal/type/converter.rbs +2 -0
- data/sig/metronome_sdk/internal/type/enum.rbs +1 -0
- data/sig/metronome_sdk/internal/type/request_parameters.rbs +5 -1
- data/sig/metronome_sdk/internal/type/union.rbs +1 -0
- data/sig/metronome_sdk/internal/util.rbs +15 -0
- data/sig/metronome_sdk/internal.rbs +2 -0
- data/sig/metronome_sdk/models/base_usage_filter.rbs +0 -2
- data/sig/metronome_sdk/models/commit.rbs +109 -145
- data/sig/metronome_sdk/models/contract_without_amendments.rbs +219 -269
- data/sig/metronome_sdk/models/credit.rbs +59 -77
- data/sig/metronome_sdk/models/credit_type_data.rbs +0 -2
- data/sig/metronome_sdk/models/discount.rbs +6 -10
- data/sig/metronome_sdk/models/event_type_filter.rbs +0 -2
- data/sig/metronome_sdk/models/id.rbs +0 -2
- data/sig/metronome_sdk/models/override.rbs +60 -74
- data/sig/metronome_sdk/models/pro_service.rbs +0 -2
- data/sig/metronome_sdk/models/property_filter.rbs +0 -2
- data/sig/metronome_sdk/models/rate.rbs +13 -17
- data/sig/metronome_sdk/models/schedule_duration.rbs +8 -12
- data/sig/metronome_sdk/models/schedule_point_in_time.rbs +10 -14
- data/sig/metronome_sdk/models/scheduled_charge.rbs +6 -10
- data/sig/metronome_sdk/models/tier.rbs +0 -2
- data/sig/metronome_sdk/models/v1/alert_archive_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/alert_archive_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/alert_create_params.rbs +14 -20
- data/sig/metronome_sdk/models/v1/alert_create_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/audit_log_list_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/audit_log_list_response.rbs +0 -6
- data/sig/metronome_sdk/models/v1/billable_metric_archive_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/billable_metric_archive_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/billable_metric_create_params.rbs +10 -12
- data/sig/metronome_sdk/models/v1/billable_metric_create_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/billable_metric_list_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/billable_metric_list_response.rbs +10 -12
- data/sig/metronome_sdk/models/v1/billable_metric_retrieve_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/billable_metric_retrieve_response.rbs +10 -14
- data/sig/metronome_sdk/models/v1/contract_add_manual_balance_entry_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/contract_amend_params.rbs +204 -260
- data/sig/metronome_sdk/models/v1/contract_amend_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/contract_archive_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/contract_archive_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/contract_create_historical_invoices_params.rbs +23 -31
- data/sig/metronome_sdk/models/v1/contract_create_historical_invoices_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/contract_create_params.rbs +510 -604
- data/sig/metronome_sdk/models/v1/contract_create_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/contract_list_balances_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/contract_list_balances_response.rbs +2 -4
- data/sig/metronome_sdk/models/v1/contract_list_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/contract_list_response.rbs +310 -40
- data/sig/metronome_sdk/models/v1/contract_retrieve_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rbs +5 -9
- data/sig/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rbs +12 -20
- data/sig/metronome_sdk/models/v1/contract_retrieve_response.rbs +310 -40
- data/sig/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_params.rbs +3 -7
- data/sig/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/contract_set_usage_filter_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/contract_update_end_date_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/contract_update_end_date_response.rbs +3 -6
- data/sig/metronome_sdk/models/v1/contracts/named_schedule_retrieve_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/contracts/named_schedule_retrieve_response.rbs +0 -4
- data/sig/metronome_sdk/models/v1/contracts/named_schedule_update_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/contracts/product_archive_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/contracts/product_archive_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/contracts/product_create_params.rbs +6 -8
- data/sig/metronome_sdk/models/v1/contracts/product_create_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/contracts/product_list_item_state.rbs +6 -8
- data/sig/metronome_sdk/models/v1/contracts/product_list_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/contracts/product_list_response.rbs +12 -16
- data/sig/metronome_sdk/models/v1/contracts/product_retrieve_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/contracts/product_retrieve_response.rbs +12 -18
- data/sig/metronome_sdk/models/v1/contracts/product_update_params.rbs +6 -8
- data/sig/metronome_sdk/models/v1/contracts/product_update_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/contracts/quantity_conversion.rbs +4 -6
- data/sig/metronome_sdk/models/v1/contracts/quantity_rounding.rbs +4 -6
- data/sig/metronome_sdk/models/v1/contracts/rate_card_archive_params.rbs +17 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_archive_response.rbs +15 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_create_params.rbs +10 -16
- data/sig/metronome_sdk/models/v1/contracts/rate_card_create_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/contracts/rate_card_list_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/contracts/rate_card_list_response.rbs +8 -14
- data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rbs +5 -9
- data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rbs +8 -14
- data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rbs +8 -16
- data/sig/metronome_sdk/models/v1/contracts/rate_card_update_params.rbs +5 -9
- data/sig/metronome_sdk/models/v1/contracts/rate_card_update_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_response.rbs +0 -4
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_update_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_params.rbs +3 -7
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_response.rbs +3 -6
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rbs +26 -32
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbs +19 -23
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rbs +15 -21
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_list_params.rbs +5 -9
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rbs +8 -12
- data/sig/metronome_sdk/models/v1/credit_grant_create_params.rbs +17 -25
- data/sig/metronome_sdk/models/v1/credit_grant_create_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/credit_grant_edit_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/credit_grant_edit_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/credit_grant_list_entries_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/credit_grant_list_entries_response.rbs +9 -19
- data/sig/metronome_sdk/models/v1/credit_grant_list_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/credit_grant_list_response.rbs +12 -22
- data/sig/metronome_sdk/models/v1/credit_grant_void_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/credit_grant_void_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/credit_ledger_entry.rbs +0 -2
- data/sig/metronome_sdk/models/v1/custom_field_add_key_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/custom_field_delete_values_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/custom_field_list_keys_params.rbs +6 -8
- data/sig/metronome_sdk/models/v1/custom_field_list_keys_response.rbs +0 -4
- data/sig/metronome_sdk/models/v1/custom_field_remove_key_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/custom_field_set_values_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customer.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customer_archive_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customer_archive_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/customer_create_params.rbs +36 -42
- data/sig/metronome_sdk/models/v1/customer_create_response.rbs +3 -6
- data/sig/metronome_sdk/models/v1/customer_detail.rbs +12 -18
- data/sig/metronome_sdk/models/v1/customer_list_billable_metrics_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customer_list_billable_metrics_response.rbs +10 -12
- data/sig/metronome_sdk/models/v1/customer_list_costs_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customer_list_costs_response.rbs +0 -6
- data/sig/metronome_sdk/models/v1/customer_list_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customer_retrieve_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customer_retrieve_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/customer_set_ingest_aliases_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customer_set_name_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customer_set_name_response.rbs +3 -6
- data/sig/metronome_sdk/models/v1/customer_update_config_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/alert_list_params.rbs +6 -8
- data/sig/metronome_sdk/models/v1/customers/alert_list_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/customers/alert_reset_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/alert_retrieve_params.rbs +22 -2
- data/sig/metronome_sdk/models/v1/customers/alert_retrieve_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/customers/billing_config_create_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/billing_config_delete_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/billing_config_retrieve_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbs +0 -4
- data/sig/metronome_sdk/models/v1/customers/commit_create_params.rbs +29 -41
- data/sig/metronome_sdk/models/v1/customers/commit_create_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/customers/commit_list_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/commit_list_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/customers/commit_update_end_date_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/commit_update_end_date_response.rbs +3 -6
- data/sig/metronome_sdk/models/v1/customers/credit_create_params.rbs +6 -12
- data/sig/metronome_sdk/models/v1/customers/credit_create_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/customers/credit_list_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/credit_list_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/customers/credit_update_end_date_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/credit_update_end_date_response.rbs +3 -6
- data/sig/metronome_sdk/models/v1/customers/customer_alert.rbs +32 -40
- data/sig/metronome_sdk/models/v1/customers/invoice.rbs +133 -151
- data/sig/metronome_sdk/models/v1/customers/invoice_add_charge_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/invoice_add_charge_response.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/invoice_list_breakdowns_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/invoice_list_breakdowns_response.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/invoice_list_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/invoice_retrieve_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/invoice_retrieve_response.rbs +3 -7
- data/sig/metronome_sdk/models/v1/customers/named_schedule_retrieve_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/named_schedule_retrieve_response.rbs +0 -4
- data/sig/metronome_sdk/models/v1/customers/named_schedule_update_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/plan_add_params.rbs +24 -34
- data/sig/metronome_sdk/models/v1/customers/plan_add_response.rbs +3 -5
- data/sig/metronome_sdk/models/v1/customers/plan_end_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/plan_end_response.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/plan_list_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/plan_list_price_adjustments_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/customers/plan_list_price_adjustments_response.rbs +0 -4
- data/sig/metronome_sdk/models/v1/customers/plan_list_response.rbs +3 -9
- data/sig/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rbs +21 -29
- data/sig/metronome_sdk/models/v1/dashboard_get_embeddable_url_response.rbs +0 -4
- data/sig/metronome_sdk/models/v1/invoice_regenerate_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/invoice_regenerate_response.rbs +0 -4
- data/sig/metronome_sdk/models/v1/invoice_void_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/invoice_void_response.rbs +0 -4
- data/sig/metronome_sdk/models/v1/plan_detail.rbs +30 -38
- data/sig/metronome_sdk/models/v1/plan_get_details_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/plan_get_details_response.rbs +3 -6
- data/sig/metronome_sdk/models/v1/plan_list_charges_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/plan_list_charges_response.rbs +3 -9
- data/sig/metronome_sdk/models/v1/plan_list_customers_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/plan_list_customers_response.rbs +3 -7
- data/sig/metronome_sdk/models/v1/plan_list_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/plan_list_response.rbs +0 -2
- data/sig/metronome_sdk/models/v1/pricing_unit_list_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/pricing_unit_list_response.rbs +0 -2
- data/sig/metronome_sdk/models/v1/rollover_amount_max_amount.rbs +4 -9
- data/sig/metronome_sdk/models/v1/rollover_amount_max_percentage.rbs +4 -6
- data/sig/metronome_sdk/models/v1/service_list_params.rbs +0 -2
- data/sig/metronome_sdk/models/v1/service_list_response.rbs +0 -4
- data/sig/metronome_sdk/models/v1/usage_ingest_params.rbs +5 -9
- data/sig/metronome_sdk/models/v1/usage_list_params.rbs +10 -16
- data/sig/metronome_sdk/models/v1/usage_list_response.rbs +0 -4
- data/sig/metronome_sdk/models/v1/usage_list_with_groups_params.rbs +5 -9
- data/sig/metronome_sdk/models/v1/usage_list_with_groups_response.rbs +0 -2
- data/sig/metronome_sdk/models/v2/contract_edit_commit_params.rbs +40 -58
- data/sig/metronome_sdk/models/v2/contract_edit_commit_response.rbs +3 -5
- data/sig/metronome_sdk/models/v2/contract_edit_credit_params.rbs +20 -30
- data/sig/metronome_sdk/models/v2/contract_edit_credit_response.rbs +3 -5
- data/sig/metronome_sdk/models/v2/contract_edit_params.rbs +779 -585
- data/sig/metronome_sdk/models/v2/contract_edit_response.rbs +3 -5
- data/sig/metronome_sdk/models/v2/contract_get_edit_history_params.rbs +0 -2
- data/sig/metronome_sdk/models/v2/contract_get_edit_history_response.rbs +38 -146
- data/sig/metronome_sdk/models/v2/contract_list_params.rbs +0 -2
- data/sig/metronome_sdk/models/v2/contract_list_response.rbs +190 -224
- data/sig/metronome_sdk/models/v2/contract_retrieve_params.rbs +0 -2
- data/sig/metronome_sdk/models/v2/contract_retrieve_response.rbs +190 -224
- data/sig/metronome_sdk/models.rbs +37 -0
- data/sig/metronome_sdk/request_options.rbs +1 -1
- data/sig/metronome_sdk/resources/v1/alerts.rbs +2 -2
- data/sig/metronome_sdk/resources/v1/billable_metrics.rbs +2 -2
- data/sig/metronome_sdk/resources/v1/contracts/products.rbs +4 -4
- data/sig/metronome_sdk/resources/v1/contracts/rate_cards/product_orders.rbs +1 -1
- data/sig/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbs +4 -4
- data/sig/metronome_sdk/resources/v1/contracts/rate_cards.rbs +9 -4
- data/sig/metronome_sdk/resources/v1/contracts.rbs +25 -25
- data/sig/metronome_sdk/resources/v1/credit_grants.rbs +3 -3
- 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 +1 -1
- data/sig/metronome_sdk/resources/v1/customers/invoices.rbs +1 -1
- data/sig/metronome_sdk/resources/v1/customers/plans.rbs +3 -3
- data/sig/metronome_sdk/resources/v1/customers.rbs +3 -3
- data/sig/metronome_sdk/resources/v1/dashboards.rbs +3 -3
- data/sig/metronome_sdk/resources/v1/usage.rbs +3 -3
- data/sig/metronome_sdk/resources/v2/contracts.rbs +25 -21
- metadata +13 -4
@@ -22,157 +22,223 @@ module MetronomeSDK
|
|
22
22
|
|
23
23
|
# @!attribute add_commits
|
24
24
|
#
|
25
|
-
# @return [Array<MetronomeSDK::
|
25
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::AddCommit>, nil]
|
26
26
|
optional :add_commits,
|
27
|
-
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::
|
27
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::AddCommit] }
|
28
28
|
|
29
29
|
# @!attribute add_credits
|
30
30
|
#
|
31
|
-
# @return [Array<MetronomeSDK::
|
31
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::AddCredit>, nil]
|
32
32
|
optional :add_credits,
|
33
|
-
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::
|
33
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::AddCredit] }
|
34
34
|
|
35
35
|
# @!attribute add_discounts
|
36
36
|
#
|
37
|
-
# @return [Array<MetronomeSDK::
|
37
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::AddDiscount>, nil]
|
38
38
|
optional :add_discounts,
|
39
|
-
-> {
|
39
|
+
-> {
|
40
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::AddDiscount]
|
41
|
+
}
|
40
42
|
|
41
43
|
# @!attribute add_overrides
|
42
44
|
#
|
43
|
-
# @return [Array<MetronomeSDK::
|
45
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::AddOverride>, nil]
|
44
46
|
optional :add_overrides,
|
45
|
-
-> {
|
47
|
+
-> {
|
48
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::AddOverride]
|
49
|
+
}
|
50
|
+
|
51
|
+
# @!attribute add_prepaid_balance_threshold_configuration
|
52
|
+
#
|
53
|
+
# @return [MetronomeSDK::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration, nil]
|
54
|
+
optional :add_prepaid_balance_threshold_configuration,
|
55
|
+
-> { MetronomeSDK::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration }
|
46
56
|
|
47
57
|
# @!attribute add_professional_services
|
48
58
|
# This field's availability is dependent on your client's configuration.
|
49
59
|
#
|
50
|
-
# @return [Array<MetronomeSDK::
|
60
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::AddProfessionalService>, nil]
|
51
61
|
optional :add_professional_services,
|
52
|
-
-> {
|
62
|
+
-> {
|
63
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::AddProfessionalService]
|
64
|
+
}
|
53
65
|
|
54
66
|
# @!attribute add_recurring_commits
|
55
67
|
#
|
56
|
-
# @return [Array<MetronomeSDK::
|
68
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::AddRecurringCommit>, nil]
|
57
69
|
optional :add_recurring_commits,
|
58
|
-
-> {
|
70
|
+
-> {
|
71
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::AddRecurringCommit]
|
72
|
+
}
|
59
73
|
|
60
74
|
# @!attribute add_recurring_credits
|
61
75
|
#
|
62
|
-
# @return [Array<MetronomeSDK::
|
76
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::AddRecurringCredit>, nil]
|
63
77
|
optional :add_recurring_credits,
|
64
|
-
-> {
|
78
|
+
-> {
|
79
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::AddRecurringCredit]
|
80
|
+
}
|
65
81
|
|
66
82
|
# @!attribute add_reseller_royalties
|
67
83
|
#
|
68
|
-
# @return [Array<MetronomeSDK::
|
84
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::AddResellerRoyalty>, nil]
|
69
85
|
optional :add_reseller_royalties,
|
70
|
-
-> {
|
86
|
+
-> {
|
87
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::AddResellerRoyalty]
|
88
|
+
}
|
71
89
|
|
72
90
|
# @!attribute add_scheduled_charges
|
73
91
|
#
|
74
|
-
# @return [Array<MetronomeSDK::
|
92
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::AddScheduledCharge>, nil]
|
75
93
|
optional :add_scheduled_charges,
|
76
|
-
-> {
|
94
|
+
-> {
|
95
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::AddScheduledCharge]
|
96
|
+
}
|
77
97
|
|
78
98
|
# @!attribute add_spend_threshold_configuration
|
79
99
|
#
|
80
|
-
# @return [MetronomeSDK::
|
100
|
+
# @return [MetronomeSDK::V2::ContractEditParams::AddSpendThresholdConfiguration, nil]
|
81
101
|
optional :add_spend_threshold_configuration,
|
82
|
-
-> { MetronomeSDK::
|
102
|
+
-> { MetronomeSDK::V2::ContractEditParams::AddSpendThresholdConfiguration }
|
103
|
+
|
104
|
+
# @!attribute allow_contract_ending_before_finalized_invoice
|
105
|
+
# If true, allows setting the contract end date earlier than the end_timestamp of
|
106
|
+
# existing finalized invoices. Finalized invoices will be unchanged; if you want
|
107
|
+
# to incorporate the new end date, you can void and regenerate finalized usage
|
108
|
+
# invoices. Defaults to true.
|
109
|
+
#
|
110
|
+
# @return [Boolean, nil]
|
111
|
+
optional :allow_contract_ending_before_finalized_invoice, MetronomeSDK::Internal::Type::Boolean
|
83
112
|
|
84
113
|
# @!attribute archive_commits
|
85
114
|
# IDs of commits to archive
|
86
115
|
#
|
87
|
-
# @return [Array<MetronomeSDK::
|
116
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::ArchiveCommit>, nil]
|
88
117
|
optional :archive_commits,
|
89
|
-
-> {
|
118
|
+
-> {
|
119
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::ArchiveCommit]
|
120
|
+
}
|
90
121
|
|
91
122
|
# @!attribute archive_credits
|
92
123
|
# IDs of credits to archive
|
93
124
|
#
|
94
|
-
# @return [Array<MetronomeSDK::
|
125
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::ArchiveCredit>, nil]
|
95
126
|
optional :archive_credits,
|
96
|
-
-> {
|
127
|
+
-> {
|
128
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::ArchiveCredit]
|
129
|
+
}
|
97
130
|
|
98
131
|
# @!attribute archive_scheduled_charges
|
99
132
|
# IDs of scheduled charges to archive
|
100
133
|
#
|
101
|
-
# @return [Array<MetronomeSDK::
|
134
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::ArchiveScheduledCharge>, nil]
|
102
135
|
optional :archive_scheduled_charges,
|
103
|
-
-> {
|
136
|
+
-> {
|
137
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::ArchiveScheduledCharge]
|
138
|
+
}
|
104
139
|
|
105
140
|
# @!attribute remove_overrides
|
106
141
|
# IDs of overrides to remove
|
107
142
|
#
|
108
|
-
# @return [Array<MetronomeSDK::
|
143
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::RemoveOverride>, nil]
|
109
144
|
optional :remove_overrides,
|
110
|
-
-> {
|
145
|
+
-> {
|
146
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::RemoveOverride]
|
147
|
+
}
|
111
148
|
|
112
149
|
# @!attribute update_commits
|
113
150
|
#
|
114
|
-
# @return [Array<MetronomeSDK::
|
151
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::UpdateCommit>, nil]
|
115
152
|
optional :update_commits,
|
116
|
-
-> {
|
153
|
+
-> {
|
154
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::UpdateCommit]
|
155
|
+
}
|
156
|
+
|
157
|
+
# @!attribute update_contract_end_date
|
158
|
+
# RFC 3339 timestamp indicating when the contract will end (exclusive).
|
159
|
+
#
|
160
|
+
# @return [Time, nil]
|
161
|
+
optional :update_contract_end_date, Time
|
117
162
|
|
118
163
|
# @!attribute update_credits
|
119
164
|
#
|
120
|
-
# @return [Array<MetronomeSDK::
|
165
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::UpdateCredit>, nil]
|
121
166
|
optional :update_credits,
|
122
|
-
-> {
|
167
|
+
-> {
|
168
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::UpdateCredit]
|
169
|
+
}
|
170
|
+
|
171
|
+
# @!attribute update_prepaid_balance_threshold_configuration
|
172
|
+
#
|
173
|
+
# @return [MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration, nil]
|
174
|
+
optional :update_prepaid_balance_threshold_configuration,
|
175
|
+
-> { MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration }
|
123
176
|
|
124
177
|
# @!attribute update_scheduled_charges
|
125
178
|
#
|
126
|
-
# @return [Array<MetronomeSDK::
|
179
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::UpdateScheduledCharge>, nil]
|
127
180
|
optional :update_scheduled_charges,
|
128
|
-
-> {
|
181
|
+
-> {
|
182
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::UpdateScheduledCharge]
|
183
|
+
}
|
129
184
|
|
130
185
|
# @!attribute update_spend_threshold_configuration
|
131
186
|
#
|
132
|
-
# @return [MetronomeSDK::
|
187
|
+
# @return [MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration, nil]
|
133
188
|
optional :update_spend_threshold_configuration,
|
134
|
-
-> { MetronomeSDK::
|
189
|
+
-> { MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration }
|
135
190
|
|
136
|
-
# @!method initialize(contract_id:, customer_id:, add_commits: nil, add_credits: nil, add_discounts: nil, add_overrides: nil, add_professional_services: nil, add_recurring_commits: nil, add_recurring_credits: nil, add_reseller_royalties: nil, add_scheduled_charges: nil, add_spend_threshold_configuration: nil, archive_commits: nil, archive_credits: nil, archive_scheduled_charges: nil, remove_overrides: nil, update_commits: nil, update_credits: nil, update_scheduled_charges: nil, update_spend_threshold_configuration: nil, request_options: {})
|
191
|
+
# @!method initialize(contract_id:, customer_id:, add_commits: nil, add_credits: nil, add_discounts: nil, add_overrides: nil, add_prepaid_balance_threshold_configuration: nil, add_professional_services: nil, add_recurring_commits: nil, add_recurring_credits: nil, add_reseller_royalties: nil, add_scheduled_charges: nil, add_spend_threshold_configuration: nil, allow_contract_ending_before_finalized_invoice: nil, archive_commits: nil, archive_credits: nil, archive_scheduled_charges: nil, remove_overrides: nil, update_commits: nil, update_contract_end_date: nil, update_credits: nil, update_prepaid_balance_threshold_configuration: nil, update_scheduled_charges: nil, update_spend_threshold_configuration: nil, request_options: {})
|
192
|
+
# Some parameter documentations has been truncated, see
|
193
|
+
# {MetronomeSDK::Models::V2::ContractEditParams} for more details.
|
194
|
+
#
|
137
195
|
# @param contract_id [String] ID of the contract being edited
|
138
196
|
#
|
139
197
|
# @param customer_id [String] ID of the customer whose contract is being edited
|
140
198
|
#
|
141
|
-
# @param add_commits [Array<MetronomeSDK::
|
199
|
+
# @param add_commits [Array<MetronomeSDK::V2::ContractEditParams::AddCommit>]
|
200
|
+
#
|
201
|
+
# @param add_credits [Array<MetronomeSDK::V2::ContractEditParams::AddCredit>]
|
202
|
+
#
|
203
|
+
# @param add_discounts [Array<MetronomeSDK::V2::ContractEditParams::AddDiscount>]
|
142
204
|
#
|
143
|
-
# @param
|
205
|
+
# @param add_overrides [Array<MetronomeSDK::V2::ContractEditParams::AddOverride>]
|
144
206
|
#
|
145
|
-
# @param
|
207
|
+
# @param add_prepaid_balance_threshold_configuration [MetronomeSDK::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration]
|
146
208
|
#
|
147
|
-
# @param
|
209
|
+
# @param add_professional_services [Array<MetronomeSDK::V2::ContractEditParams::AddProfessionalService>] This field's availability is dependent on your client's configuration.
|
148
210
|
#
|
149
|
-
# @param
|
211
|
+
# @param add_recurring_commits [Array<MetronomeSDK::V2::ContractEditParams::AddRecurringCommit>]
|
150
212
|
#
|
151
|
-
# @param
|
213
|
+
# @param add_recurring_credits [Array<MetronomeSDK::V2::ContractEditParams::AddRecurringCredit>]
|
152
214
|
#
|
153
|
-
# @param
|
215
|
+
# @param add_reseller_royalties [Array<MetronomeSDK::V2::ContractEditParams::AddResellerRoyalty>]
|
154
216
|
#
|
155
|
-
# @param
|
217
|
+
# @param add_scheduled_charges [Array<MetronomeSDK::V2::ContractEditParams::AddScheduledCharge>]
|
156
218
|
#
|
157
|
-
# @param
|
219
|
+
# @param add_spend_threshold_configuration [MetronomeSDK::V2::ContractEditParams::AddSpendThresholdConfiguration]
|
158
220
|
#
|
159
|
-
# @param
|
221
|
+
# @param allow_contract_ending_before_finalized_invoice [Boolean] If true, allows setting the contract end date earlier than the end_timestamp of
|
160
222
|
#
|
161
|
-
# @param archive_commits [Array<MetronomeSDK::
|
223
|
+
# @param archive_commits [Array<MetronomeSDK::V2::ContractEditParams::ArchiveCommit>] IDs of commits to archive
|
162
224
|
#
|
163
|
-
# @param archive_credits [Array<MetronomeSDK::
|
225
|
+
# @param archive_credits [Array<MetronomeSDK::V2::ContractEditParams::ArchiveCredit>] IDs of credits to archive
|
164
226
|
#
|
165
|
-
# @param archive_scheduled_charges [Array<MetronomeSDK::
|
227
|
+
# @param archive_scheduled_charges [Array<MetronomeSDK::V2::ContractEditParams::ArchiveScheduledCharge>] IDs of scheduled charges to archive
|
166
228
|
#
|
167
|
-
# @param remove_overrides [Array<MetronomeSDK::
|
229
|
+
# @param remove_overrides [Array<MetronomeSDK::V2::ContractEditParams::RemoveOverride>] IDs of overrides to remove
|
168
230
|
#
|
169
|
-
# @param update_commits [Array<MetronomeSDK::
|
231
|
+
# @param update_commits [Array<MetronomeSDK::V2::ContractEditParams::UpdateCommit>]
|
170
232
|
#
|
171
|
-
# @param
|
233
|
+
# @param update_contract_end_date [Time] RFC 3339 timestamp indicating when the contract will end (exclusive).
|
172
234
|
#
|
173
|
-
# @param
|
235
|
+
# @param update_credits [Array<MetronomeSDK::V2::ContractEditParams::UpdateCredit>]
|
174
236
|
#
|
175
|
-
# @param
|
237
|
+
# @param update_prepaid_balance_threshold_configuration [MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration]
|
238
|
+
#
|
239
|
+
# @param update_scheduled_charges [Array<MetronomeSDK::V2::ContractEditParams::UpdateScheduledCharge>]
|
240
|
+
#
|
241
|
+
# @param update_spend_threshold_configuration [MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration]
|
176
242
|
#
|
177
243
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
|
178
244
|
|
@@ -184,16 +250,16 @@ module MetronomeSDK
|
|
184
250
|
|
185
251
|
# @!attribute type
|
186
252
|
#
|
187
|
-
# @return [Symbol, MetronomeSDK::
|
188
|
-
required :type, enum: -> { MetronomeSDK::
|
253
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::AddCommit::Type]
|
254
|
+
required :type, enum: -> { MetronomeSDK::V2::ContractEditParams::AddCommit::Type }
|
189
255
|
|
190
256
|
# @!attribute access_schedule
|
191
257
|
# Required: Schedule for distributing the commit to the customer. For "POSTPAID"
|
192
258
|
# commits only one schedule item is allowed and amount must match invoice_schedule
|
193
259
|
# total.
|
194
260
|
#
|
195
|
-
# @return [MetronomeSDK::
|
196
|
-
optional :access_schedule, -> { MetronomeSDK::
|
261
|
+
# @return [MetronomeSDK::V2::ContractEditParams::AddCommit::AccessSchedule, nil]
|
262
|
+
optional :access_schedule, -> { MetronomeSDK::V2::ContractEditParams::AddCommit::AccessSchedule }
|
197
263
|
|
198
264
|
# @!attribute amount
|
199
265
|
# (DEPRECATED) Use access_schedule and invoice_schedule instead.
|
@@ -232,9 +298,8 @@ module MetronomeSDK
|
|
232
298
|
# amount. Optional for "PREPAID" commits: if not provided, this will be a
|
233
299
|
# "complimentary" commit with no invoice.
|
234
300
|
#
|
235
|
-
# @return [MetronomeSDK::
|
236
|
-
optional :invoice_schedule,
|
237
|
-
-> { MetronomeSDK::Models::V2::ContractEditParams::AddCommit::InvoiceSchedule }
|
301
|
+
# @return [MetronomeSDK::V2::ContractEditParams::AddCommit::InvoiceSchedule, nil]
|
302
|
+
optional :invoice_schedule, -> { MetronomeSDK::V2::ContractEditParams::AddCommit::InvoiceSchedule }
|
238
303
|
|
239
304
|
# @!attribute name
|
240
305
|
# displayed on invoices
|
@@ -251,9 +316,11 @@ module MetronomeSDK
|
|
251
316
|
# @!attribute payment_gate_config
|
252
317
|
# optionally payment gate this commit
|
253
318
|
#
|
254
|
-
# @return [MetronomeSDK::
|
319
|
+
# @return [MetronomeSDK::V2::ContractEditParams::AddCommit::PaymentGateConfig, nil]
|
255
320
|
optional :payment_gate_config,
|
256
|
-
-> {
|
321
|
+
-> {
|
322
|
+
MetronomeSDK::V2::ContractEditParams::AddCommit::PaymentGateConfig
|
323
|
+
}
|
257
324
|
|
258
325
|
# @!attribute priority
|
259
326
|
# If multiple commits are applicable, the one with the lower priority will apply
|
@@ -264,8 +331,8 @@ module MetronomeSDK
|
|
264
331
|
|
265
332
|
# @!attribute rate_type
|
266
333
|
#
|
267
|
-
# @return [Symbol, MetronomeSDK::
|
268
|
-
optional :rate_type, enum: -> { MetronomeSDK::
|
334
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::AddCommit::RateType, nil]
|
335
|
+
optional :rate_type, enum: -> { MetronomeSDK::V2::ContractEditParams::AddCommit::RateType }
|
269
336
|
|
270
337
|
# @!attribute rollover_fraction
|
271
338
|
# Fraction of unused segments that will be rolled over. Must be between 0 and 1.
|
@@ -282,47 +349,41 @@ module MetronomeSDK
|
|
282
349
|
|
283
350
|
# @!method initialize(product_id:, type:, access_schedule: nil, amount: nil, applicable_product_ids: nil, applicable_product_tags: nil, custom_fields: nil, description: nil, invoice_schedule: nil, name: nil, netsuite_sales_order_id: nil, payment_gate_config: nil, priority: nil, rate_type: nil, rollover_fraction: nil, temporary_id: nil)
|
284
351
|
# Some parameter documentations has been truncated, see
|
285
|
-
# {MetronomeSDK::
|
352
|
+
# {MetronomeSDK::V2::ContractEditParams::AddCommit} for more details.
|
286
353
|
#
|
287
354
|
# @param product_id [String]
|
288
355
|
#
|
289
|
-
# @param type [Symbol, MetronomeSDK::
|
356
|
+
# @param type [Symbol, MetronomeSDK::V2::ContractEditParams::AddCommit::Type]
|
290
357
|
#
|
291
|
-
# @param access_schedule [MetronomeSDK::
|
292
|
-
# ...
|
358
|
+
# @param access_schedule [MetronomeSDK::V2::ContractEditParams::AddCommit::AccessSchedule] Required: Schedule for distributing the commit to the customer. For "POSTPAID" c
|
293
359
|
#
|
294
360
|
# @param amount [Float] (DEPRECATED) Use access_schedule and invoice_schedule instead.
|
295
361
|
#
|
296
362
|
# @param applicable_product_ids [Array<String>] Which products the commit applies to. If both applicable_product_ids and applica
|
297
|
-
# ...
|
298
363
|
#
|
299
364
|
# @param applicable_product_tags [Array<String>] Which tags the commit applies to. If both applicable*product_ids and applicable*
|
300
|
-
# ...
|
301
365
|
#
|
302
366
|
# @param custom_fields [Hash{Symbol=>String}]
|
303
367
|
#
|
304
368
|
# @param description [String] Used only in UI/API. It is not exposed to end customers.
|
305
369
|
#
|
306
|
-
# @param invoice_schedule [MetronomeSDK::
|
307
|
-
# ...
|
370
|
+
# @param invoice_schedule [MetronomeSDK::V2::ContractEditParams::AddCommit::InvoiceSchedule] Required for "POSTPAID" commits: the true up invoice will be generated at this t
|
308
371
|
#
|
309
372
|
# @param name [String] displayed on invoices
|
310
373
|
#
|
311
374
|
# @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
|
312
375
|
#
|
313
|
-
# @param payment_gate_config [MetronomeSDK::
|
376
|
+
# @param payment_gate_config [MetronomeSDK::V2::ContractEditParams::AddCommit::PaymentGateConfig] optionally payment gate this commit
|
314
377
|
#
|
315
378
|
# @param priority [Float] If multiple commits are applicable, the one with the lower priority will apply f
|
316
|
-
# ...
|
317
379
|
#
|
318
|
-
# @param rate_type [Symbol, MetronomeSDK::
|
380
|
+
# @param rate_type [Symbol, MetronomeSDK::V2::ContractEditParams::AddCommit::RateType]
|
319
381
|
#
|
320
382
|
# @param rollover_fraction [Float] Fraction of unused segments that will be rolled over. Must be between 0 and 1.
|
321
383
|
#
|
322
384
|
# @param temporary_id [String] A temporary ID for the commit that can be used to reference the commit for commi
|
323
|
-
# ...
|
324
385
|
|
325
|
-
# @see MetronomeSDK::
|
386
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddCommit#type
|
326
387
|
module Type
|
327
388
|
extend MetronomeSDK::Internal::Type::Enum
|
328
389
|
|
@@ -333,13 +394,15 @@ module MetronomeSDK
|
|
333
394
|
# @return [Array<Symbol>]
|
334
395
|
end
|
335
396
|
|
336
|
-
# @see MetronomeSDK::
|
397
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddCommit#access_schedule
|
337
398
|
class AccessSchedule < MetronomeSDK::Internal::Type::BaseModel
|
338
399
|
# @!attribute schedule_items
|
339
400
|
#
|
340
|
-
# @return [Array<MetronomeSDK::
|
401
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::AddCommit::AccessSchedule::ScheduleItem>]
|
341
402
|
required :schedule_items,
|
342
|
-
-> {
|
403
|
+
-> {
|
404
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::AddCommit::AccessSchedule::ScheduleItem]
|
405
|
+
}
|
343
406
|
|
344
407
|
# @!attribute credit_type_id
|
345
408
|
#
|
@@ -351,7 +414,7 @@ module MetronomeSDK
|
|
351
414
|
# commits only one schedule item is allowed and amount must match invoice_schedule
|
352
415
|
# total.
|
353
416
|
#
|
354
|
-
# @param schedule_items [Array<MetronomeSDK::
|
417
|
+
# @param schedule_items [Array<MetronomeSDK::V2::ContractEditParams::AddCommit::AccessSchedule::ScheduleItem>]
|
355
418
|
# @param credit_type_id [String]
|
356
419
|
|
357
420
|
class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
|
@@ -381,7 +444,7 @@ module MetronomeSDK
|
|
381
444
|
end
|
382
445
|
end
|
383
446
|
|
384
|
-
# @see MetronomeSDK::
|
447
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddCommit#invoice_schedule
|
385
448
|
class InvoiceSchedule < MetronomeSDK::Internal::Type::BaseModel
|
386
449
|
# @!attribute credit_type_id
|
387
450
|
# Defaults to USD if not passed. Only USD is supported at this time.
|
@@ -394,21 +457,25 @@ module MetronomeSDK
|
|
394
457
|
# amount. If amount is sent, the unit price is assumed to be the amount and
|
395
458
|
# quantity is inferred to be 1.
|
396
459
|
#
|
397
|
-
# @return [MetronomeSDK::
|
460
|
+
# @return [MetronomeSDK::V2::ContractEditParams::AddCommit::InvoiceSchedule::RecurringSchedule, nil]
|
398
461
|
optional :recurring_schedule,
|
399
|
-
-> {
|
462
|
+
-> {
|
463
|
+
MetronomeSDK::V2::ContractEditParams::AddCommit::InvoiceSchedule::RecurringSchedule
|
464
|
+
}
|
400
465
|
|
401
466
|
# @!attribute schedule_items
|
402
467
|
# Either provide amount or provide both unit_price and quantity.
|
403
468
|
#
|
404
|
-
# @return [Array<MetronomeSDK::
|
469
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::AddCommit::InvoiceSchedule::ScheduleItem>, nil]
|
405
470
|
optional :schedule_items,
|
406
|
-
-> {
|
471
|
+
-> {
|
472
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::AddCommit::InvoiceSchedule::ScheduleItem]
|
473
|
+
}
|
407
474
|
|
408
475
|
# @!method initialize(credit_type_id: nil, recurring_schedule: nil, schedule_items: nil)
|
409
476
|
# Some parameter documentations has been truncated, see
|
410
|
-
# {MetronomeSDK::
|
411
|
-
#
|
477
|
+
# {MetronomeSDK::V2::ContractEditParams::AddCommit::InvoiceSchedule} for more
|
478
|
+
# details.
|
412
479
|
#
|
413
480
|
# Required for "POSTPAID" commits: the true up invoice will be generated at this
|
414
481
|
# time and only one schedule item is allowed; the total must match access_schedule
|
@@ -417,18 +484,19 @@ module MetronomeSDK
|
|
417
484
|
#
|
418
485
|
# @param credit_type_id [String] Defaults to USD if not passed. Only USD is supported at this time.
|
419
486
|
#
|
420
|
-
# @param recurring_schedule [MetronomeSDK::
|
421
|
-
# ...
|
487
|
+
# @param recurring_schedule [MetronomeSDK::V2::ContractEditParams::AddCommit::InvoiceSchedule::RecurringSchedule] Enter the unit price and quantity for the charge or instead only send the amount
|
422
488
|
#
|
423
|
-
# @param schedule_items [Array<MetronomeSDK::
|
489
|
+
# @param schedule_items [Array<MetronomeSDK::V2::ContractEditParams::AddCommit::InvoiceSchedule::ScheduleItem>] Either provide amount or provide both unit_price and quantity.
|
424
490
|
|
425
|
-
# @see MetronomeSDK::
|
491
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddCommit::InvoiceSchedule#recurring_schedule
|
426
492
|
class RecurringSchedule < MetronomeSDK::Internal::Type::BaseModel
|
427
493
|
# @!attribute amount_distribution
|
428
494
|
#
|
429
|
-
# @return [Symbol, MetronomeSDK::
|
495
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::AddCommit::InvoiceSchedule::RecurringSchedule::AmountDistribution]
|
430
496
|
required :amount_distribution,
|
431
|
-
enum: -> {
|
497
|
+
enum: -> {
|
498
|
+
MetronomeSDK::V2::ContractEditParams::AddCommit::InvoiceSchedule::RecurringSchedule::AmountDistribution
|
499
|
+
}
|
432
500
|
|
433
501
|
# @!attribute ending_before
|
434
502
|
# RFC 3339 timestamp (exclusive).
|
@@ -438,9 +506,11 @@ module MetronomeSDK
|
|
438
506
|
|
439
507
|
# @!attribute frequency
|
440
508
|
#
|
441
|
-
# @return [Symbol, MetronomeSDK::
|
509
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::AddCommit::InvoiceSchedule::RecurringSchedule::Frequency]
|
442
510
|
required :frequency,
|
443
|
-
enum: -> {
|
511
|
+
enum: -> {
|
512
|
+
MetronomeSDK::V2::ContractEditParams::AddCommit::InvoiceSchedule::RecurringSchedule::Frequency
|
513
|
+
}
|
444
514
|
|
445
515
|
# @!attribute starting_at
|
446
516
|
# RFC 3339 timestamp (inclusive).
|
@@ -474,31 +544,28 @@ module MetronomeSDK
|
|
474
544
|
|
475
545
|
# @!method initialize(amount_distribution:, ending_before:, frequency:, starting_at:, amount: nil, quantity: nil, unit_price: nil)
|
476
546
|
# Some parameter documentations has been truncated, see
|
477
|
-
# {MetronomeSDK::
|
547
|
+
# {MetronomeSDK::V2::ContractEditParams::AddCommit::InvoiceSchedule::RecurringSchedule}
|
478
548
|
# for more details.
|
479
549
|
#
|
480
550
|
# Enter the unit price and quantity for the charge or instead only send the
|
481
551
|
# amount. If amount is sent, the unit price is assumed to be the amount and
|
482
552
|
# quantity is inferred to be 1.
|
483
553
|
#
|
484
|
-
# @param amount_distribution [Symbol, MetronomeSDK::
|
554
|
+
# @param amount_distribution [Symbol, MetronomeSDK::V2::ContractEditParams::AddCommit::InvoiceSchedule::RecurringSchedule::AmountDistribution]
|
485
555
|
#
|
486
556
|
# @param ending_before [Time] RFC 3339 timestamp (exclusive).
|
487
557
|
#
|
488
|
-
# @param frequency [Symbol, MetronomeSDK::
|
558
|
+
# @param frequency [Symbol, MetronomeSDK::V2::ContractEditParams::AddCommit::InvoiceSchedule::RecurringSchedule::Frequency]
|
489
559
|
#
|
490
560
|
# @param starting_at [Time] RFC 3339 timestamp (inclusive).
|
491
561
|
#
|
492
562
|
# @param amount [Float] Amount for the charge. Can be provided instead of unit_price and quantity. If am
|
493
|
-
# ...
|
494
563
|
#
|
495
564
|
# @param quantity [Float] Quantity for the charge. Will be multiplied by unit_price to determine the amoun
|
496
|
-
# ...
|
497
565
|
#
|
498
566
|
# @param unit_price [Float] Unit price for the charge. Will be multiplied by quantity to determine the amoun
|
499
|
-
# ...
|
500
567
|
|
501
|
-
# @see MetronomeSDK::
|
568
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddCommit::InvoiceSchedule::RecurringSchedule#amount_distribution
|
502
569
|
module AmountDistribution
|
503
570
|
extend MetronomeSDK::Internal::Type::Enum
|
504
571
|
|
@@ -510,7 +577,7 @@ module MetronomeSDK
|
|
510
577
|
# @return [Array<Symbol>]
|
511
578
|
end
|
512
579
|
|
513
|
-
# @see MetronomeSDK::
|
580
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddCommit::InvoiceSchedule::RecurringSchedule#frequency
|
514
581
|
module Frequency
|
515
582
|
extend MetronomeSDK::Internal::Type::Enum
|
516
583
|
|
@@ -558,23 +625,20 @@ module MetronomeSDK
|
|
558
625
|
|
559
626
|
# @!method initialize(timestamp:, amount: nil, quantity: nil, unit_price: nil)
|
560
627
|
# Some parameter documentations has been truncated, see
|
561
|
-
# {MetronomeSDK::
|
628
|
+
# {MetronomeSDK::V2::ContractEditParams::AddCommit::InvoiceSchedule::ScheduleItem}
|
562
629
|
# for more details.
|
563
630
|
#
|
564
631
|
# @param timestamp [Time] timestamp of the scheduled event
|
565
632
|
#
|
566
633
|
# @param amount [Float] Amount for the charge. Can be provided instead of unit_price and quantity. If am
|
567
|
-
# ...
|
568
634
|
#
|
569
635
|
# @param quantity [Float] Quantity for the charge. Will be multiplied by unit_price to determine the amoun
|
570
|
-
# ...
|
571
636
|
#
|
572
637
|
# @param unit_price [Float] Unit price for the charge. Will be multiplied by quantity to determine the amoun
|
573
|
-
# ...
|
574
638
|
end
|
575
639
|
end
|
576
640
|
|
577
|
-
# @see MetronomeSDK::
|
641
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddCommit#payment_gate_config
|
578
642
|
class PaymentGateConfig < MetronomeSDK::Internal::Type::BaseModel
|
579
643
|
# @!attribute payment_gate_type
|
580
644
|
# Gate access to the commit balance based on successful collection of payment.
|
@@ -582,47 +646,47 @@ module MetronomeSDK
|
|
582
646
|
# facilitate payment using your own payment integration. Select NONE if you do not
|
583
647
|
# wish to payment gate the commit balance.
|
584
648
|
#
|
585
|
-
# @return [Symbol, MetronomeSDK::
|
649
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::AddCommit::PaymentGateConfig::PaymentGateType]
|
586
650
|
required :payment_gate_type,
|
587
|
-
enum: -> {
|
651
|
+
enum: -> {
|
652
|
+
MetronomeSDK::V2::ContractEditParams::AddCommit::PaymentGateConfig::PaymentGateType
|
653
|
+
}
|
588
654
|
|
589
655
|
# @!attribute stripe_config
|
590
656
|
# Only applicable if using Stripe as your payment gateway through Metronome.
|
591
657
|
#
|
592
|
-
# @return [MetronomeSDK::
|
658
|
+
# @return [MetronomeSDK::V2::ContractEditParams::AddCommit::PaymentGateConfig::StripeConfig, nil]
|
593
659
|
optional :stripe_config,
|
594
|
-
-> { MetronomeSDK::
|
660
|
+
-> { MetronomeSDK::V2::ContractEditParams::AddCommit::PaymentGateConfig::StripeConfig }
|
595
661
|
|
596
662
|
# @!attribute tax_type
|
597
663
|
# Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
|
598
664
|
# not wish Metronome to calculate tax on your behalf. Leaving this field blank
|
599
665
|
# will default to NONE.
|
600
666
|
#
|
601
|
-
# @return [Symbol, MetronomeSDK::
|
667
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::AddCommit::PaymentGateConfig::TaxType, nil]
|
602
668
|
optional :tax_type,
|
603
|
-
enum: -> { MetronomeSDK::
|
669
|
+
enum: -> { MetronomeSDK::V2::ContractEditParams::AddCommit::PaymentGateConfig::TaxType }
|
604
670
|
|
605
671
|
# @!method initialize(payment_gate_type:, stripe_config: nil, tax_type: nil)
|
606
672
|
# Some parameter documentations has been truncated, see
|
607
|
-
# {MetronomeSDK::
|
608
|
-
#
|
673
|
+
# {MetronomeSDK::V2::ContractEditParams::AddCommit::PaymentGateConfig} for more
|
674
|
+
# details.
|
609
675
|
#
|
610
676
|
# optionally payment gate this commit
|
611
677
|
#
|
612
|
-
# @param payment_gate_type [Symbol, MetronomeSDK::
|
613
|
-
# ...
|
678
|
+
# @param payment_gate_type [Symbol, MetronomeSDK::V2::ContractEditParams::AddCommit::PaymentGateConfig::PaymentGateType] Gate access to the commit balance based on successful collection of payment. Sel
|
614
679
|
#
|
615
|
-
# @param stripe_config [MetronomeSDK::
|
680
|
+
# @param stripe_config [MetronomeSDK::V2::ContractEditParams::AddCommit::PaymentGateConfig::StripeConfig] Only applicable if using Stripe as your payment gateway through Metronome.
|
616
681
|
#
|
617
|
-
# @param tax_type [Symbol, MetronomeSDK::
|
618
|
-
# ...
|
682
|
+
# @param tax_type [Symbol, MetronomeSDK::V2::ContractEditParams::AddCommit::PaymentGateConfig::TaxType] Stripe tax is only supported for Stripe payment gateway. Select NONE if you do n
|
619
683
|
|
620
684
|
# Gate access to the commit balance based on successful collection of payment.
|
621
685
|
# Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
|
622
686
|
# facilitate payment using your own payment integration. Select NONE if you do not
|
623
687
|
# wish to payment gate the commit balance.
|
624
688
|
#
|
625
|
-
# @see MetronomeSDK::
|
689
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddCommit::PaymentGateConfig#payment_gate_type
|
626
690
|
module PaymentGateType
|
627
691
|
extend MetronomeSDK::Internal::Type::Enum
|
628
692
|
|
@@ -634,23 +698,25 @@ module MetronomeSDK
|
|
634
698
|
# @return [Array<Symbol>]
|
635
699
|
end
|
636
700
|
|
637
|
-
# @see MetronomeSDK::
|
701
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddCommit::PaymentGateConfig#stripe_config
|
638
702
|
class StripeConfig < MetronomeSDK::Internal::Type::BaseModel
|
639
703
|
# @!attribute payment_type
|
640
704
|
# If left blank, will default to INVOICE
|
641
705
|
#
|
642
|
-
# @return [Symbol, MetronomeSDK::
|
706
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::AddCommit::PaymentGateConfig::StripeConfig::PaymentType]
|
643
707
|
required :payment_type,
|
644
|
-
enum: -> {
|
708
|
+
enum: -> {
|
709
|
+
MetronomeSDK::V2::ContractEditParams::AddCommit::PaymentGateConfig::StripeConfig::PaymentType
|
710
|
+
}
|
645
711
|
|
646
712
|
# @!method initialize(payment_type:)
|
647
713
|
# Only applicable if using Stripe as your payment gateway through Metronome.
|
648
714
|
#
|
649
|
-
# @param payment_type [Symbol, MetronomeSDK::
|
715
|
+
# @param payment_type [Symbol, MetronomeSDK::V2::ContractEditParams::AddCommit::PaymentGateConfig::StripeConfig::PaymentType] If left blank, will default to INVOICE
|
650
716
|
|
651
717
|
# If left blank, will default to INVOICE
|
652
718
|
#
|
653
|
-
# @see MetronomeSDK::
|
719
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddCommit::PaymentGateConfig::StripeConfig#payment_type
|
654
720
|
module PaymentType
|
655
721
|
extend MetronomeSDK::Internal::Type::Enum
|
656
722
|
|
@@ -666,7 +732,7 @@ module MetronomeSDK
|
|
666
732
|
# not wish Metronome to calculate tax on your behalf. Leaving this field blank
|
667
733
|
# will default to NONE.
|
668
734
|
#
|
669
|
-
# @see MetronomeSDK::
|
735
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddCommit::PaymentGateConfig#tax_type
|
670
736
|
module TaxType
|
671
737
|
extend MetronomeSDK::Internal::Type::Enum
|
672
738
|
|
@@ -678,7 +744,7 @@ module MetronomeSDK
|
|
678
744
|
end
|
679
745
|
end
|
680
746
|
|
681
|
-
# @see MetronomeSDK::
|
747
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddCommit#rate_type
|
682
748
|
module RateType
|
683
749
|
extend MetronomeSDK::Internal::Type::Enum
|
684
750
|
|
@@ -694,8 +760,8 @@ module MetronomeSDK
|
|
694
760
|
# @!attribute access_schedule
|
695
761
|
# Schedule for distributing the credit to the customer.
|
696
762
|
#
|
697
|
-
# @return [MetronomeSDK::
|
698
|
-
required :access_schedule, -> { MetronomeSDK::
|
763
|
+
# @return [MetronomeSDK::V2::ContractEditParams::AddCredit::AccessSchedule]
|
764
|
+
required :access_schedule, -> { MetronomeSDK::V2::ContractEditParams::AddCredit::AccessSchedule }
|
699
765
|
|
700
766
|
# @!attribute product_id
|
701
767
|
#
|
@@ -748,22 +814,20 @@ module MetronomeSDK
|
|
748
814
|
|
749
815
|
# @!attribute rate_type
|
750
816
|
#
|
751
|
-
# @return [Symbol, MetronomeSDK::
|
752
|
-
optional :rate_type, enum: -> { MetronomeSDK::
|
817
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::AddCredit::RateType, nil]
|
818
|
+
optional :rate_type, enum: -> { MetronomeSDK::V2::ContractEditParams::AddCredit::RateType }
|
753
819
|
|
754
820
|
# @!method initialize(access_schedule:, product_id:, applicable_product_ids: nil, applicable_product_tags: nil, custom_fields: nil, description: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, rate_type: nil)
|
755
821
|
# Some parameter documentations has been truncated, see
|
756
|
-
# {MetronomeSDK::
|
822
|
+
# {MetronomeSDK::V2::ContractEditParams::AddCredit} for more details.
|
757
823
|
#
|
758
|
-
# @param access_schedule [MetronomeSDK::
|
824
|
+
# @param access_schedule [MetronomeSDK::V2::ContractEditParams::AddCredit::AccessSchedule] Schedule for distributing the credit to the customer.
|
759
825
|
#
|
760
826
|
# @param product_id [String]
|
761
827
|
#
|
762
828
|
# @param applicable_product_ids [Array<String>] Which products the credit applies to. If both applicable_product_ids and applica
|
763
|
-
# ...
|
764
829
|
#
|
765
830
|
# @param applicable_product_tags [Array<String>] Which tags the credit applies to. If both applicable*product_ids and applicable*
|
766
|
-
# ...
|
767
831
|
#
|
768
832
|
# @param custom_fields [Hash{Symbol=>String}]
|
769
833
|
#
|
@@ -774,17 +838,18 @@ module MetronomeSDK
|
|
774
838
|
# @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
|
775
839
|
#
|
776
840
|
# @param priority [Float] If multiple credits are applicable, the one with the lower priority will apply f
|
777
|
-
# ...
|
778
841
|
#
|
779
|
-
# @param rate_type [Symbol, MetronomeSDK::
|
842
|
+
# @param rate_type [Symbol, MetronomeSDK::V2::ContractEditParams::AddCredit::RateType]
|
780
843
|
|
781
|
-
# @see MetronomeSDK::
|
844
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddCredit#access_schedule
|
782
845
|
class AccessSchedule < MetronomeSDK::Internal::Type::BaseModel
|
783
846
|
# @!attribute schedule_items
|
784
847
|
#
|
785
|
-
# @return [Array<MetronomeSDK::
|
848
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::AddCredit::AccessSchedule::ScheduleItem>]
|
786
849
|
required :schedule_items,
|
787
|
-
-> {
|
850
|
+
-> {
|
851
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::AddCredit::AccessSchedule::ScheduleItem]
|
852
|
+
}
|
788
853
|
|
789
854
|
# @!attribute credit_type_id
|
790
855
|
#
|
@@ -794,7 +859,7 @@ module MetronomeSDK
|
|
794
859
|
# @!method initialize(schedule_items:, credit_type_id: nil)
|
795
860
|
# Schedule for distributing the credit to the customer.
|
796
861
|
#
|
797
|
-
# @param schedule_items [Array<MetronomeSDK::
|
862
|
+
# @param schedule_items [Array<MetronomeSDK::V2::ContractEditParams::AddCredit::AccessSchedule::ScheduleItem>]
|
798
863
|
# @param credit_type_id [String]
|
799
864
|
|
800
865
|
class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
|
@@ -824,7 +889,7 @@ module MetronomeSDK
|
|
824
889
|
end
|
825
890
|
end
|
826
891
|
|
827
|
-
# @see MetronomeSDK::
|
892
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddCredit#rate_type
|
828
893
|
module RateType
|
829
894
|
extend MetronomeSDK::Internal::Type::Enum
|
830
895
|
|
@@ -845,8 +910,8 @@ module MetronomeSDK
|
|
845
910
|
# @!attribute schedule
|
846
911
|
# Must provide either schedule_items or recurring_schedule.
|
847
912
|
#
|
848
|
-
# @return [MetronomeSDK::
|
849
|
-
required :schedule, -> { MetronomeSDK::
|
913
|
+
# @return [MetronomeSDK::V2::ContractEditParams::AddDiscount::Schedule]
|
914
|
+
required :schedule, -> { MetronomeSDK::V2::ContractEditParams::AddDiscount::Schedule }
|
850
915
|
|
851
916
|
# @!attribute custom_fields
|
852
917
|
#
|
@@ -868,7 +933,7 @@ module MetronomeSDK
|
|
868
933
|
# @!method initialize(product_id:, schedule:, custom_fields: nil, name: nil, netsuite_sales_order_id: nil)
|
869
934
|
# @param product_id [String]
|
870
935
|
#
|
871
|
-
# @param schedule [MetronomeSDK::
|
936
|
+
# @param schedule [MetronomeSDK::V2::ContractEditParams::AddDiscount::Schedule] Must provide either schedule_items or recurring_schedule.
|
872
937
|
#
|
873
938
|
# @param custom_fields [Hash{Symbol=>String}]
|
874
939
|
#
|
@@ -876,7 +941,7 @@ module MetronomeSDK
|
|
876
941
|
#
|
877
942
|
# @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
|
878
943
|
|
879
|
-
# @see MetronomeSDK::
|
944
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddDiscount#schedule
|
880
945
|
class Schedule < MetronomeSDK::Internal::Type::BaseModel
|
881
946
|
# @!attribute credit_type_id
|
882
947
|
# Defaults to USD if not passed. Only USD is supported at this time.
|
@@ -889,38 +954,40 @@ module MetronomeSDK
|
|
889
954
|
# amount. If amount is sent, the unit price is assumed to be the amount and
|
890
955
|
# quantity is inferred to be 1.
|
891
956
|
#
|
892
|
-
# @return [MetronomeSDK::
|
957
|
+
# @return [MetronomeSDK::V2::ContractEditParams::AddDiscount::Schedule::RecurringSchedule, nil]
|
893
958
|
optional :recurring_schedule,
|
894
|
-
-> { MetronomeSDK::
|
959
|
+
-> { MetronomeSDK::V2::ContractEditParams::AddDiscount::Schedule::RecurringSchedule }
|
895
960
|
|
896
961
|
# @!attribute schedule_items
|
897
962
|
# Either provide amount or provide both unit_price and quantity.
|
898
963
|
#
|
899
|
-
# @return [Array<MetronomeSDK::
|
964
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::AddDiscount::Schedule::ScheduleItem>, nil]
|
900
965
|
optional :schedule_items,
|
901
|
-
-> {
|
966
|
+
-> {
|
967
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::AddDiscount::Schedule::ScheduleItem]
|
968
|
+
}
|
902
969
|
|
903
970
|
# @!method initialize(credit_type_id: nil, recurring_schedule: nil, schedule_items: nil)
|
904
971
|
# Some parameter documentations has been truncated, see
|
905
|
-
# {MetronomeSDK::
|
906
|
-
# details.
|
972
|
+
# {MetronomeSDK::V2::ContractEditParams::AddDiscount::Schedule} for more details.
|
907
973
|
#
|
908
974
|
# Must provide either schedule_items or recurring_schedule.
|
909
975
|
#
|
910
976
|
# @param credit_type_id [String] Defaults to USD if not passed. Only USD is supported at this time.
|
911
977
|
#
|
912
|
-
# @param recurring_schedule [MetronomeSDK::
|
913
|
-
# ...
|
978
|
+
# @param recurring_schedule [MetronomeSDK::V2::ContractEditParams::AddDiscount::Schedule::RecurringSchedule] Enter the unit price and quantity for the charge or instead only send the amount
|
914
979
|
#
|
915
|
-
# @param schedule_items [Array<MetronomeSDK::
|
980
|
+
# @param schedule_items [Array<MetronomeSDK::V2::ContractEditParams::AddDiscount::Schedule::ScheduleItem>] Either provide amount or provide both unit_price and quantity.
|
916
981
|
|
917
|
-
# @see MetronomeSDK::
|
982
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddDiscount::Schedule#recurring_schedule
|
918
983
|
class RecurringSchedule < MetronomeSDK::Internal::Type::BaseModel
|
919
984
|
# @!attribute amount_distribution
|
920
985
|
#
|
921
|
-
# @return [Symbol, MetronomeSDK::
|
986
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::AddDiscount::Schedule::RecurringSchedule::AmountDistribution]
|
922
987
|
required :amount_distribution,
|
923
|
-
enum: -> {
|
988
|
+
enum: -> {
|
989
|
+
MetronomeSDK::V2::ContractEditParams::AddDiscount::Schedule::RecurringSchedule::AmountDistribution
|
990
|
+
}
|
924
991
|
|
925
992
|
# @!attribute ending_before
|
926
993
|
# RFC 3339 timestamp (exclusive).
|
@@ -930,9 +997,11 @@ module MetronomeSDK
|
|
930
997
|
|
931
998
|
# @!attribute frequency
|
932
999
|
#
|
933
|
-
# @return [Symbol, MetronomeSDK::
|
1000
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::AddDiscount::Schedule::RecurringSchedule::Frequency]
|
934
1001
|
required :frequency,
|
935
|
-
enum: -> {
|
1002
|
+
enum: -> {
|
1003
|
+
MetronomeSDK::V2::ContractEditParams::AddDiscount::Schedule::RecurringSchedule::Frequency
|
1004
|
+
}
|
936
1005
|
|
937
1006
|
# @!attribute starting_at
|
938
1007
|
# RFC 3339 timestamp (inclusive).
|
@@ -966,31 +1035,28 @@ module MetronomeSDK
|
|
966
1035
|
|
967
1036
|
# @!method initialize(amount_distribution:, ending_before:, frequency:, starting_at:, amount: nil, quantity: nil, unit_price: nil)
|
968
1037
|
# Some parameter documentations has been truncated, see
|
969
|
-
# {MetronomeSDK::
|
1038
|
+
# {MetronomeSDK::V2::ContractEditParams::AddDiscount::Schedule::RecurringSchedule}
|
970
1039
|
# for more details.
|
971
1040
|
#
|
972
1041
|
# Enter the unit price and quantity for the charge or instead only send the
|
973
1042
|
# amount. If amount is sent, the unit price is assumed to be the amount and
|
974
1043
|
# quantity is inferred to be 1.
|
975
1044
|
#
|
976
|
-
# @param amount_distribution [Symbol, MetronomeSDK::
|
1045
|
+
# @param amount_distribution [Symbol, MetronomeSDK::V2::ContractEditParams::AddDiscount::Schedule::RecurringSchedule::AmountDistribution]
|
977
1046
|
#
|
978
1047
|
# @param ending_before [Time] RFC 3339 timestamp (exclusive).
|
979
1048
|
#
|
980
|
-
# @param frequency [Symbol, MetronomeSDK::
|
1049
|
+
# @param frequency [Symbol, MetronomeSDK::V2::ContractEditParams::AddDiscount::Schedule::RecurringSchedule::Frequency]
|
981
1050
|
#
|
982
1051
|
# @param starting_at [Time] RFC 3339 timestamp (inclusive).
|
983
1052
|
#
|
984
1053
|
# @param amount [Float] Amount for the charge. Can be provided instead of unit_price and quantity. If am
|
985
|
-
# ...
|
986
1054
|
#
|
987
1055
|
# @param quantity [Float] Quantity for the charge. Will be multiplied by unit_price to determine the amoun
|
988
|
-
# ...
|
989
1056
|
#
|
990
1057
|
# @param unit_price [Float] Unit price for the charge. Will be multiplied by quantity to determine the amoun
|
991
|
-
# ...
|
992
1058
|
|
993
|
-
# @see MetronomeSDK::
|
1059
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddDiscount::Schedule::RecurringSchedule#amount_distribution
|
994
1060
|
module AmountDistribution
|
995
1061
|
extend MetronomeSDK::Internal::Type::Enum
|
996
1062
|
|
@@ -1002,7 +1068,7 @@ module MetronomeSDK
|
|
1002
1068
|
# @return [Array<Symbol>]
|
1003
1069
|
end
|
1004
1070
|
|
1005
|
-
# @see MetronomeSDK::
|
1071
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddDiscount::Schedule::RecurringSchedule#frequency
|
1006
1072
|
module Frequency
|
1007
1073
|
extend MetronomeSDK::Internal::Type::Enum
|
1008
1074
|
|
@@ -1050,19 +1116,16 @@ module MetronomeSDK
|
|
1050
1116
|
|
1051
1117
|
# @!method initialize(timestamp:, amount: nil, quantity: nil, unit_price: nil)
|
1052
1118
|
# Some parameter documentations has been truncated, see
|
1053
|
-
# {MetronomeSDK::
|
1054
|
-
#
|
1119
|
+
# {MetronomeSDK::V2::ContractEditParams::AddDiscount::Schedule::ScheduleItem} for
|
1120
|
+
# more details.
|
1055
1121
|
#
|
1056
1122
|
# @param timestamp [Time] timestamp of the scheduled event
|
1057
1123
|
#
|
1058
1124
|
# @param amount [Float] Amount for the charge. Can be provided instead of unit_price and quantity. If am
|
1059
|
-
# ...
|
1060
1125
|
#
|
1061
1126
|
# @param quantity [Float] Quantity for the charge. Will be multiplied by unit_price to determine the amoun
|
1062
|
-
# ...
|
1063
1127
|
#
|
1064
1128
|
# @param unit_price [Float] Unit price for the charge. Will be multiplied by quantity to determine the amoun
|
1065
|
-
# ...
|
1066
1129
|
end
|
1067
1130
|
end
|
1068
1131
|
end
|
@@ -1109,15 +1172,17 @@ module MetronomeSDK
|
|
1109
1172
|
# Cannot be used in conjunction with product_id or applicable_product_tags. If
|
1110
1173
|
# provided, the override will apply to all products with the specified specifiers.
|
1111
1174
|
#
|
1112
|
-
# @return [Array<MetronomeSDK::
|
1175
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::AddOverride::OverrideSpecifier>, nil]
|
1113
1176
|
optional :override_specifiers,
|
1114
|
-
-> {
|
1177
|
+
-> {
|
1178
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::AddOverride::OverrideSpecifier]
|
1179
|
+
}
|
1115
1180
|
|
1116
1181
|
# @!attribute overwrite_rate
|
1117
1182
|
# Required for OVERWRITE type.
|
1118
1183
|
#
|
1119
|
-
# @return [MetronomeSDK::
|
1120
|
-
optional :overwrite_rate, -> { MetronomeSDK::
|
1184
|
+
# @return [MetronomeSDK::V2::ContractEditParams::AddOverride::OverwriteRate, nil]
|
1185
|
+
optional :overwrite_rate, -> { MetronomeSDK::V2::ContractEditParams::AddOverride::OverwriteRate }
|
1121
1186
|
|
1122
1187
|
# @!attribute priority
|
1123
1188
|
# Required for EXPLICIT multiplier prioritization scheme and all TIERED overrides.
|
@@ -1139,25 +1204,27 @@ module MetronomeSDK
|
|
1139
1204
|
# be used for overrides that have `is_commit_specific` set to `true`. Defaults to
|
1140
1205
|
# `"LIST_RATE"`.
|
1141
1206
|
#
|
1142
|
-
# @return [Symbol, MetronomeSDK::
|
1143
|
-
optional :target, enum: -> { MetronomeSDK::
|
1207
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::AddOverride::Target, nil]
|
1208
|
+
optional :target, enum: -> { MetronomeSDK::V2::ContractEditParams::AddOverride::Target }
|
1144
1209
|
|
1145
1210
|
# @!attribute tiers
|
1146
1211
|
# Required for TIERED type. Must have at least one tier.
|
1147
1212
|
#
|
1148
|
-
# @return [Array<MetronomeSDK::
|
1213
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::AddOverride::Tier>, nil]
|
1149
1214
|
optional :tiers,
|
1150
|
-
-> {
|
1215
|
+
-> {
|
1216
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::AddOverride::Tier]
|
1217
|
+
}
|
1151
1218
|
|
1152
1219
|
# @!attribute type
|
1153
1220
|
# Overwrites are prioritized over multipliers and tiered overrides.
|
1154
1221
|
#
|
1155
|
-
# @return [Symbol, MetronomeSDK::
|
1156
|
-
optional :type, enum: -> { MetronomeSDK::
|
1222
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::AddOverride::Type, nil]
|
1223
|
+
optional :type, enum: -> { MetronomeSDK::V2::ContractEditParams::AddOverride::Type }
|
1157
1224
|
|
1158
1225
|
# @!method initialize(starting_at:, applicable_product_tags: nil, ending_before: nil, entitled: nil, is_commit_specific: nil, multiplier: nil, override_specifiers: nil, overwrite_rate: nil, priority: nil, product_id: nil, target: nil, tiers: nil, type: nil)
|
1159
1226
|
# Some parameter documentations has been truncated, see
|
1160
|
-
# {MetronomeSDK::
|
1227
|
+
# {MetronomeSDK::V2::ContractEditParams::AddOverride} for more details.
|
1161
1228
|
#
|
1162
1229
|
# @param starting_at [Time] RFC 3339 timestamp indicating when the override will start applying (inclusive)
|
1163
1230
|
#
|
@@ -1168,26 +1235,22 @@ module MetronomeSDK
|
|
1168
1235
|
# @param entitled [Boolean]
|
1169
1236
|
#
|
1170
1237
|
# @param is_commit_specific [Boolean] Indicates whether the override should only apply to commits. Defaults to `false`
|
1171
|
-
# ...
|
1172
1238
|
#
|
1173
1239
|
# @param multiplier [Float] Required for MULTIPLIER type. Must be >=0.
|
1174
1240
|
#
|
1175
|
-
# @param override_specifiers [Array<MetronomeSDK::
|
1176
|
-
# ...
|
1241
|
+
# @param override_specifiers [Array<MetronomeSDK::V2::ContractEditParams::AddOverride::OverrideSpecifier>] Cannot be used in conjunction with product_id or applicable_product_tags. If pro
|
1177
1242
|
#
|
1178
|
-
# @param overwrite_rate [MetronomeSDK::
|
1243
|
+
# @param overwrite_rate [MetronomeSDK::V2::ContractEditParams::AddOverride::OverwriteRate] Required for OVERWRITE type.
|
1179
1244
|
#
|
1180
1245
|
# @param priority [Float] Required for EXPLICIT multiplier prioritization scheme and all TIERED overrides.
|
1181
|
-
# ...
|
1182
1246
|
#
|
1183
1247
|
# @param product_id [String] ID of the product whose rate is being overridden
|
1184
1248
|
#
|
1185
|
-
# @param target [Symbol, MetronomeSDK::
|
1186
|
-
# ...
|
1249
|
+
# @param target [Symbol, MetronomeSDK::V2::ContractEditParams::AddOverride::Target] Indicates whether the override applies to commit rates or list rates. Can only b
|
1187
1250
|
#
|
1188
|
-
# @param tiers [Array<MetronomeSDK::
|
1251
|
+
# @param tiers [Array<MetronomeSDK::V2::ContractEditParams::AddOverride::Tier>] Required for TIERED type. Must have at least one tier.
|
1189
1252
|
#
|
1190
|
-
# @param type [Symbol, MetronomeSDK::
|
1253
|
+
# @param type [Symbol, MetronomeSDK::V2::ContractEditParams::AddOverride::Type] Overwrites are prioritized over multipliers and tiered overrides.
|
1191
1254
|
|
1192
1255
|
class OverrideSpecifier < MetronomeSDK::Internal::Type::BaseModel
|
1193
1256
|
# @!attribute commit_ids
|
@@ -1246,37 +1309,31 @@ module MetronomeSDK
|
|
1246
1309
|
|
1247
1310
|
# @!method initialize(commit_ids: nil, presentation_group_values: nil, pricing_group_values: nil, product_id: nil, product_tags: nil, recurring_commit_ids: nil, recurring_credit_ids: nil)
|
1248
1311
|
# Some parameter documentations has been truncated, see
|
1249
|
-
# {MetronomeSDK::
|
1250
|
-
#
|
1312
|
+
# {MetronomeSDK::V2::ContractEditParams::AddOverride::OverrideSpecifier} for more
|
1313
|
+
# details.
|
1251
1314
|
#
|
1252
1315
|
# @param commit_ids [Array<String>] If provided, the override will only apply to the specified commits. Can only be
|
1253
|
-
# ...
|
1254
1316
|
#
|
1255
1317
|
# @param presentation_group_values [Hash{Symbol=>String}] A map of group names to values. The override will only apply to line items with
|
1256
|
-
# ...
|
1257
1318
|
#
|
1258
1319
|
# @param pricing_group_values [Hash{Symbol=>String}] A map of pricing group names to values. The override will only apply to products
|
1259
|
-
# ...
|
1260
1320
|
#
|
1261
1321
|
# @param product_id [String] If provided, the override will only apply to the product with the specified ID.
|
1262
1322
|
#
|
1263
1323
|
# @param product_tags [Array<String>] If provided, the override will only apply to products with all the specified tag
|
1264
|
-
# ...
|
1265
1324
|
#
|
1266
1325
|
# @param recurring_commit_ids [Array<String>] Can only be used for commit specific overrides. Must be used in conjunction with
|
1267
|
-
# ...
|
1268
1326
|
#
|
1269
1327
|
# @param recurring_credit_ids [Array<String>] Can only be used for commit specific overrides. Must be used in conjunction with
|
1270
|
-
# ...
|
1271
1328
|
end
|
1272
1329
|
|
1273
|
-
# @see MetronomeSDK::
|
1330
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddOverride#overwrite_rate
|
1274
1331
|
class OverwriteRate < MetronomeSDK::Internal::Type::BaseModel
|
1275
1332
|
# @!attribute rate_type
|
1276
1333
|
#
|
1277
|
-
# @return [Symbol, MetronomeSDK::
|
1334
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::AddOverride::OverwriteRate::RateType]
|
1278
1335
|
required :rate_type,
|
1279
|
-
enum: -> { MetronomeSDK::
|
1336
|
+
enum: -> { MetronomeSDK::V2::ContractEditParams::AddOverride::OverwriteRate::RateType }
|
1280
1337
|
|
1281
1338
|
# @!attribute credit_type_id
|
1282
1339
|
#
|
@@ -1313,34 +1370,31 @@ module MetronomeSDK
|
|
1313
1370
|
# @!attribute tiers
|
1314
1371
|
# Only set for TIERED rate_type.
|
1315
1372
|
#
|
1316
|
-
# @return [Array<MetronomeSDK::
|
1317
|
-
optional :tiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::
|
1373
|
+
# @return [Array<MetronomeSDK::Tier>, nil]
|
1374
|
+
optional :tiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Tier] }
|
1318
1375
|
|
1319
1376
|
# @!method initialize(rate_type:, credit_type_id: nil, custom_rate: nil, is_prorated: nil, price: nil, quantity: nil, tiers: nil)
|
1320
1377
|
# Some parameter documentations has been truncated, see
|
1321
|
-
# {MetronomeSDK::
|
1322
|
-
#
|
1378
|
+
# {MetronomeSDK::V2::ContractEditParams::AddOverride::OverwriteRate} for more
|
1379
|
+
# details.
|
1323
1380
|
#
|
1324
1381
|
# Required for OVERWRITE type.
|
1325
1382
|
#
|
1326
|
-
# @param rate_type [Symbol, MetronomeSDK::
|
1383
|
+
# @param rate_type [Symbol, MetronomeSDK::V2::ContractEditParams::AddOverride::OverwriteRate::RateType]
|
1327
1384
|
#
|
1328
1385
|
# @param credit_type_id [String]
|
1329
1386
|
#
|
1330
1387
|
# @param custom_rate [Hash{Symbol=>Object}] Only set for CUSTOM rate_type. This field is interpreted by custom rate processo
|
1331
|
-
# ...
|
1332
1388
|
#
|
1333
1389
|
# @param is_prorated [Boolean] Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
|
1334
|
-
# ...
|
1335
1390
|
#
|
1336
1391
|
# @param price [Float] Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type, t
|
1337
|
-
# ...
|
1338
1392
|
#
|
1339
1393
|
# @param quantity [Float] Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
|
1340
1394
|
#
|
1341
|
-
# @param tiers [Array<MetronomeSDK::
|
1395
|
+
# @param tiers [Array<MetronomeSDK::Tier>] Only set for TIERED rate_type.
|
1342
1396
|
|
1343
|
-
# @see MetronomeSDK::
|
1397
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddOverride::OverwriteRate#rate_type
|
1344
1398
|
module RateType
|
1345
1399
|
extend MetronomeSDK::Internal::Type::Enum
|
1346
1400
|
|
@@ -1359,7 +1413,7 @@ module MetronomeSDK
|
|
1359
1413
|
# be used for overrides that have `is_commit_specific` set to `true`. Defaults to
|
1360
1414
|
# `"LIST_RATE"`.
|
1361
1415
|
#
|
1362
|
-
# @see MetronomeSDK::
|
1416
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddOverride#target
|
1363
1417
|
module Target
|
1364
1418
|
extend MetronomeSDK::Internal::Type::Enum
|
1365
1419
|
|
@@ -1388,7 +1442,7 @@ module MetronomeSDK
|
|
1388
1442
|
|
1389
1443
|
# Overwrites are prioritized over multipliers and tiered overrides.
|
1390
1444
|
#
|
1391
|
-
# @see MetronomeSDK::
|
1445
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddOverride#type
|
1392
1446
|
module Type
|
1393
1447
|
extend MetronomeSDK::Internal::Type::Enum
|
1394
1448
|
|
@@ -1401,6 +1455,220 @@ module MetronomeSDK
|
|
1401
1455
|
end
|
1402
1456
|
end
|
1403
1457
|
|
1458
|
+
class AddPrepaidBalanceThresholdConfiguration < MetronomeSDK::Internal::Type::BaseModel
|
1459
|
+
# @!attribute commit
|
1460
|
+
#
|
1461
|
+
# @return [MetronomeSDK::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration::Commit]
|
1462
|
+
required :commit,
|
1463
|
+
-> {
|
1464
|
+
MetronomeSDK::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration::Commit
|
1465
|
+
}
|
1466
|
+
|
1467
|
+
# @!attribute is_enabled
|
1468
|
+
# When set to false, the contract will not be evaluated against the
|
1469
|
+
# threshold_amount. Toggling to true will result an immediate evaluation,
|
1470
|
+
# regardless of prior state.
|
1471
|
+
#
|
1472
|
+
# @return [Boolean]
|
1473
|
+
required :is_enabled, MetronomeSDK::Internal::Type::Boolean
|
1474
|
+
|
1475
|
+
# @!attribute payment_gate_config
|
1476
|
+
#
|
1477
|
+
# @return [MetronomeSDK::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig]
|
1478
|
+
required :payment_gate_config,
|
1479
|
+
-> {
|
1480
|
+
MetronomeSDK::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig
|
1481
|
+
}
|
1482
|
+
|
1483
|
+
# @!attribute recharge_to_amount
|
1484
|
+
# Specify the amount the balance should be recharged to.
|
1485
|
+
#
|
1486
|
+
# @return [Float]
|
1487
|
+
required :recharge_to_amount, Float
|
1488
|
+
|
1489
|
+
# @!attribute threshold_amount
|
1490
|
+
# Specify the threshold amount for the contract. Each time the contract's balance
|
1491
|
+
# lowers to this amount, a threshold charge will be initiated.
|
1492
|
+
#
|
1493
|
+
# @return [Float]
|
1494
|
+
required :threshold_amount, Float
|
1495
|
+
|
1496
|
+
# @!method initialize(commit:, is_enabled:, payment_gate_config:, recharge_to_amount:, threshold_amount:)
|
1497
|
+
# Some parameter documentations has been truncated, see
|
1498
|
+
# {MetronomeSDK::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration}
|
1499
|
+
# for more details.
|
1500
|
+
#
|
1501
|
+
# @param commit [MetronomeSDK::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration::Commit]
|
1502
|
+
#
|
1503
|
+
# @param is_enabled [Boolean] When set to false, the contract will not be evaluated against the threshold_amou
|
1504
|
+
#
|
1505
|
+
# @param payment_gate_config [MetronomeSDK::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig]
|
1506
|
+
#
|
1507
|
+
# @param recharge_to_amount [Float] Specify the amount the balance should be recharged to.
|
1508
|
+
#
|
1509
|
+
# @param threshold_amount [Float] Specify the threshold amount for the contract. Each time the contract's balance
|
1510
|
+
|
1511
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration#commit
|
1512
|
+
class Commit < MetronomeSDK::Internal::Type::BaseModel
|
1513
|
+
# @!attribute product_id
|
1514
|
+
# The commit product that will be used to generate the line item for commit
|
1515
|
+
# payment.
|
1516
|
+
#
|
1517
|
+
# @return [String]
|
1518
|
+
required :product_id, String
|
1519
|
+
|
1520
|
+
# @!attribute applicable_product_ids
|
1521
|
+
# Which products the threshold commit applies to. If both applicable_product_ids
|
1522
|
+
# and applicable_product_tags are not provided, the commit applies to all
|
1523
|
+
# products.
|
1524
|
+
#
|
1525
|
+
# @return [Array<String>, nil]
|
1526
|
+
optional :applicable_product_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
|
1527
|
+
|
1528
|
+
# @!attribute applicable_product_tags
|
1529
|
+
# Which tags the threshold commit applies to. If both applicable_product_ids and
|
1530
|
+
# applicable_product_tags are not provided, the commit applies to all products.
|
1531
|
+
#
|
1532
|
+
# @return [Array<String>, nil]
|
1533
|
+
optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
|
1534
|
+
|
1535
|
+
# @!attribute description
|
1536
|
+
#
|
1537
|
+
# @return [String, nil]
|
1538
|
+
optional :description, String
|
1539
|
+
|
1540
|
+
# @!attribute name
|
1541
|
+
# Specify the name of the line item for the threshold charge. If left blank, it
|
1542
|
+
# will default to the commit product name.
|
1543
|
+
#
|
1544
|
+
# @return [String, nil]
|
1545
|
+
optional :name, String
|
1546
|
+
|
1547
|
+
# @!method initialize(product_id:, applicable_product_ids: nil, applicable_product_tags: nil, description: nil, name: nil)
|
1548
|
+
# Some parameter documentations has been truncated, see
|
1549
|
+
# {MetronomeSDK::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration::Commit}
|
1550
|
+
# for more details.
|
1551
|
+
#
|
1552
|
+
# @param product_id [String] The commit product that will be used to generate the line item for commit paymen
|
1553
|
+
#
|
1554
|
+
# @param applicable_product_ids [Array<String>] Which products the threshold commit applies to. If both applicable_product_ids a
|
1555
|
+
#
|
1556
|
+
# @param applicable_product_tags [Array<String>] Which tags the threshold commit applies to. If both applicable_product_ids and a
|
1557
|
+
#
|
1558
|
+
# @param description [String]
|
1559
|
+
#
|
1560
|
+
# @param name [String] Specify the name of the line item for the threshold charge. If left blank, it wi
|
1561
|
+
end
|
1562
|
+
|
1563
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration#payment_gate_config
|
1564
|
+
class PaymentGateConfig < MetronomeSDK::Internal::Type::BaseModel
|
1565
|
+
# @!attribute payment_gate_type
|
1566
|
+
# Gate access to the commit balance based on successful collection of payment.
|
1567
|
+
# Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
|
1568
|
+
# facilitate payment using your own payment integration. Select NONE if you do not
|
1569
|
+
# wish to payment gate the commit balance.
|
1570
|
+
#
|
1571
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig::PaymentGateType]
|
1572
|
+
required :payment_gate_type,
|
1573
|
+
enum: -> {
|
1574
|
+
MetronomeSDK::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig::PaymentGateType
|
1575
|
+
}
|
1576
|
+
|
1577
|
+
# @!attribute stripe_config
|
1578
|
+
# Only applicable if using Stripe as your payment gateway through Metronome.
|
1579
|
+
#
|
1580
|
+
# @return [MetronomeSDK::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig, nil]
|
1581
|
+
optional :stripe_config,
|
1582
|
+
-> {
|
1583
|
+
MetronomeSDK::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig
|
1584
|
+
}
|
1585
|
+
|
1586
|
+
# @!attribute tax_type
|
1587
|
+
# Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
|
1588
|
+
# not wish Metronome to calculate tax on your behalf. Leaving this field blank
|
1589
|
+
# will default to NONE.
|
1590
|
+
#
|
1591
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig::TaxType, nil]
|
1592
|
+
optional :tax_type,
|
1593
|
+
enum: -> {
|
1594
|
+
MetronomeSDK::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig::TaxType
|
1595
|
+
}
|
1596
|
+
|
1597
|
+
# @!method initialize(payment_gate_type:, stripe_config: nil, tax_type: nil)
|
1598
|
+
# Some parameter documentations has been truncated, see
|
1599
|
+
# {MetronomeSDK::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig}
|
1600
|
+
# for more details.
|
1601
|
+
#
|
1602
|
+
# @param payment_gate_type [Symbol, MetronomeSDK::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig::PaymentGateType] Gate access to the commit balance based on successful collection of payment. Sel
|
1603
|
+
#
|
1604
|
+
# @param stripe_config [MetronomeSDK::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig] Only applicable if using Stripe as your payment gateway through Metronome.
|
1605
|
+
#
|
1606
|
+
# @param tax_type [Symbol, MetronomeSDK::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig::TaxType] Stripe tax is only supported for Stripe payment gateway. Select NONE if you do n
|
1607
|
+
|
1608
|
+
# Gate access to the commit balance based on successful collection of payment.
|
1609
|
+
# Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
|
1610
|
+
# facilitate payment using your own payment integration. Select NONE if you do not
|
1611
|
+
# wish to payment gate the commit balance.
|
1612
|
+
#
|
1613
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig#payment_gate_type
|
1614
|
+
module PaymentGateType
|
1615
|
+
extend MetronomeSDK::Internal::Type::Enum
|
1616
|
+
|
1617
|
+
NONE = :NONE
|
1618
|
+
STRIPE = :STRIPE
|
1619
|
+
EXTERNAL = :EXTERNAL
|
1620
|
+
|
1621
|
+
# @!method self.values
|
1622
|
+
# @return [Array<Symbol>]
|
1623
|
+
end
|
1624
|
+
|
1625
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig#stripe_config
|
1626
|
+
class StripeConfig < MetronomeSDK::Internal::Type::BaseModel
|
1627
|
+
# @!attribute payment_type
|
1628
|
+
# If left blank, will default to INVOICE
|
1629
|
+
#
|
1630
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType]
|
1631
|
+
required :payment_type,
|
1632
|
+
enum: -> {
|
1633
|
+
MetronomeSDK::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType
|
1634
|
+
}
|
1635
|
+
|
1636
|
+
# @!method initialize(payment_type:)
|
1637
|
+
# Only applicable if using Stripe as your payment gateway through Metronome.
|
1638
|
+
#
|
1639
|
+
# @param payment_type [Symbol, MetronomeSDK::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType] If left blank, will default to INVOICE
|
1640
|
+
|
1641
|
+
# If left blank, will default to INVOICE
|
1642
|
+
#
|
1643
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig#payment_type
|
1644
|
+
module PaymentType
|
1645
|
+
extend MetronomeSDK::Internal::Type::Enum
|
1646
|
+
|
1647
|
+
INVOICE = :INVOICE
|
1648
|
+
PAYMENT_INTENT = :PAYMENT_INTENT
|
1649
|
+
|
1650
|
+
# @!method self.values
|
1651
|
+
# @return [Array<Symbol>]
|
1652
|
+
end
|
1653
|
+
end
|
1654
|
+
|
1655
|
+
# Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
|
1656
|
+
# not wish Metronome to calculate tax on your behalf. Leaving this field blank
|
1657
|
+
# will default to NONE.
|
1658
|
+
#
|
1659
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig#tax_type
|
1660
|
+
module TaxType
|
1661
|
+
extend MetronomeSDK::Internal::Type::Enum
|
1662
|
+
|
1663
|
+
NONE = :NONE
|
1664
|
+
STRIPE = :STRIPE
|
1665
|
+
|
1666
|
+
# @!method self.values
|
1667
|
+
# @return [Array<Symbol>]
|
1668
|
+
end
|
1669
|
+
end
|
1670
|
+
end
|
1671
|
+
|
1404
1672
|
class AddProfessionalService < MetronomeSDK::Internal::Type::BaseModel
|
1405
1673
|
# @!attribute max_amount
|
1406
1674
|
# Maximum amount for the term.
|
@@ -1445,18 +1713,15 @@ module MetronomeSDK
|
|
1445
1713
|
|
1446
1714
|
# @!method initialize(max_amount:, product_id:, quantity:, unit_price:, custom_fields: nil, description: nil, netsuite_sales_order_id: nil)
|
1447
1715
|
# Some parameter documentations has been truncated, see
|
1448
|
-
# {MetronomeSDK::
|
1449
|
-
# details.
|
1716
|
+
# {MetronomeSDK::V2::ContractEditParams::AddProfessionalService} for more details.
|
1450
1717
|
#
|
1451
1718
|
# @param max_amount [Float] Maximum amount for the term.
|
1452
1719
|
#
|
1453
1720
|
# @param product_id [String]
|
1454
1721
|
#
|
1455
1722
|
# @param quantity [Float] Quantity for the charge. Will be multiplied by unit_price to determine the amoun
|
1456
|
-
# ...
|
1457
1723
|
#
|
1458
1724
|
# @param unit_price [Float] Unit price for the charge. Will be multiplied by quantity to determine the amoun
|
1459
|
-
# ...
|
1460
1725
|
#
|
1461
1726
|
# @param custom_fields [Hash{Symbol=>String}]
|
1462
1727
|
#
|
@@ -1469,16 +1734,20 @@ module MetronomeSDK
|
|
1469
1734
|
# @!attribute access_amount
|
1470
1735
|
# The amount of commit to grant.
|
1471
1736
|
#
|
1472
|
-
# @return [MetronomeSDK::
|
1737
|
+
# @return [MetronomeSDK::V2::ContractEditParams::AddRecurringCommit::AccessAmount]
|
1473
1738
|
required :access_amount,
|
1474
|
-
-> {
|
1739
|
+
-> {
|
1740
|
+
MetronomeSDK::V2::ContractEditParams::AddRecurringCommit::AccessAmount
|
1741
|
+
}
|
1475
1742
|
|
1476
1743
|
# @!attribute commit_duration
|
1477
1744
|
# The amount of time the created commits will be valid for.
|
1478
1745
|
#
|
1479
|
-
# @return [MetronomeSDK::
|
1746
|
+
# @return [MetronomeSDK::V2::ContractEditParams::AddRecurringCommit::CommitDuration]
|
1480
1747
|
required :commit_duration,
|
1481
|
-
-> {
|
1748
|
+
-> {
|
1749
|
+
MetronomeSDK::V2::ContractEditParams::AddRecurringCommit::CommitDuration
|
1750
|
+
}
|
1482
1751
|
|
1483
1752
|
# @!attribute priority
|
1484
1753
|
# Will be passed down to the individual commits
|
@@ -1524,9 +1793,11 @@ module MetronomeSDK
|
|
1524
1793
|
# @!attribute invoice_amount
|
1525
1794
|
# The amount the customer should be billed for the commit. Not required.
|
1526
1795
|
#
|
1527
|
-
# @return [MetronomeSDK::
|
1796
|
+
# @return [MetronomeSDK::V2::ContractEditParams::AddRecurringCommit::InvoiceAmount, nil]
|
1528
1797
|
optional :invoice_amount,
|
1529
|
-
-> {
|
1798
|
+
-> {
|
1799
|
+
MetronomeSDK::V2::ContractEditParams::AddRecurringCommit::InvoiceAmount
|
1800
|
+
}
|
1530
1801
|
|
1531
1802
|
# @!attribute name
|
1532
1803
|
# displayed on invoices. will be passed through to the individual commits
|
@@ -1544,16 +1815,17 @@ module MetronomeSDK
|
|
1544
1815
|
# Determines whether the first and last commit will be prorated. If not provided,
|
1545
1816
|
# the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).
|
1546
1817
|
#
|
1547
|
-
# @return [Symbol, MetronomeSDK::
|
1818
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::AddRecurringCommit::Proration, nil]
|
1548
1819
|
optional :proration,
|
1549
|
-
enum: -> {
|
1820
|
+
enum: -> {
|
1821
|
+
MetronomeSDK::V2::ContractEditParams::AddRecurringCommit::Proration
|
1822
|
+
}
|
1550
1823
|
|
1551
1824
|
# @!attribute rate_type
|
1552
1825
|
# Whether the created commits will use the commit rate or list rate
|
1553
1826
|
#
|
1554
|
-
# @return [Symbol, MetronomeSDK::
|
1555
|
-
optional :rate_type,
|
1556
|
-
enum: -> { MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCommit::RateType }
|
1827
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::AddRecurringCommit::RateType, nil]
|
1828
|
+
optional :rate_type, enum: -> { MetronomeSDK::V2::ContractEditParams::AddRecurringCommit::RateType }
|
1557
1829
|
|
1558
1830
|
# @!attribute recurrence_frequency
|
1559
1831
|
# The frequency at which the recurring commits will be created. If not provided: -
|
@@ -1562,9 +1834,9 @@ module MetronomeSDK
|
|
1562
1834
|
# be created aligned with the recurring commit's start_date rather than the usage
|
1563
1835
|
# invoice dates.
|
1564
1836
|
#
|
1565
|
-
# @return [Symbol, MetronomeSDK::
|
1837
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::AddRecurringCommit::RecurrenceFrequency, nil]
|
1566
1838
|
optional :recurrence_frequency,
|
1567
|
-
enum: -> { MetronomeSDK::
|
1839
|
+
enum: -> { MetronomeSDK::V2::ContractEditParams::AddRecurringCommit::RecurrenceFrequency }
|
1568
1840
|
|
1569
1841
|
# @!attribute rollover_fraction
|
1570
1842
|
# Will be passed down to the individual commits. This controls how much of an
|
@@ -1583,12 +1855,11 @@ module MetronomeSDK
|
|
1583
1855
|
|
1584
1856
|
# @!method initialize(access_amount:, commit_duration:, priority:, product_id:, starting_at:, applicable_product_ids: nil, applicable_product_tags: nil, description: nil, ending_before: nil, invoice_amount: nil, name: nil, netsuite_sales_order_id: nil, proration: nil, rate_type: nil, recurrence_frequency: nil, rollover_fraction: nil, temporary_id: nil)
|
1585
1857
|
# Some parameter documentations has been truncated, see
|
1586
|
-
# {MetronomeSDK::
|
1587
|
-
# details.
|
1858
|
+
# {MetronomeSDK::V2::ContractEditParams::AddRecurringCommit} for more details.
|
1588
1859
|
#
|
1589
|
-
# @param access_amount [MetronomeSDK::
|
1860
|
+
# @param access_amount [MetronomeSDK::V2::ContractEditParams::AddRecurringCommit::AccessAmount] The amount of commit to grant.
|
1590
1861
|
#
|
1591
|
-
# @param commit_duration [MetronomeSDK::
|
1862
|
+
# @param commit_duration [MetronomeSDK::V2::ContractEditParams::AddRecurringCommit::CommitDuration] The amount of time the created commits will be valid for.
|
1592
1863
|
#
|
1593
1864
|
# @param priority [Float] Will be passed down to the individual commits
|
1594
1865
|
#
|
@@ -1604,27 +1875,23 @@ module MetronomeSDK
|
|
1604
1875
|
#
|
1605
1876
|
# @param ending_before [Time] Determines when the contract will stop creating recurring commits. optional
|
1606
1877
|
#
|
1607
|
-
# @param invoice_amount [MetronomeSDK::
|
1878
|
+
# @param invoice_amount [MetronomeSDK::V2::ContractEditParams::AddRecurringCommit::InvoiceAmount] The amount the customer should be billed for the commit. Not required.
|
1608
1879
|
#
|
1609
1880
|
# @param name [String] displayed on invoices. will be passed through to the individual commits
|
1610
1881
|
#
|
1611
1882
|
# @param netsuite_sales_order_id [String] Will be passed down to the individual commits
|
1612
1883
|
#
|
1613
|
-
# @param proration [Symbol, MetronomeSDK::
|
1614
|
-
# ...
|
1884
|
+
# @param proration [Symbol, MetronomeSDK::V2::ContractEditParams::AddRecurringCommit::Proration] Determines whether the first and last commit will be prorated. If not provided,
|
1615
1885
|
#
|
1616
|
-
# @param rate_type [Symbol, MetronomeSDK::
|
1886
|
+
# @param rate_type [Symbol, MetronomeSDK::V2::ContractEditParams::AddRecurringCommit::RateType] Whether the created commits will use the commit rate or list rate
|
1617
1887
|
#
|
1618
|
-
# @param recurrence_frequency [Symbol, MetronomeSDK::
|
1619
|
-
# ...
|
1888
|
+
# @param recurrence_frequency [Symbol, MetronomeSDK::V2::ContractEditParams::AddRecurringCommit::RecurrenceFrequency] The frequency at which the recurring commits will be created. If not provided: -
|
1620
1889
|
#
|
1621
1890
|
# @param rollover_fraction [Float] Will be passed down to the individual commits. This controls how much of an indi
|
1622
|
-
# ...
|
1623
1891
|
#
|
1624
1892
|
# @param temporary_id [String] A temporary ID that can be used to reference the recurring commit for commit spe
|
1625
|
-
# ...
|
1626
1893
|
|
1627
|
-
# @see MetronomeSDK::
|
1894
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddRecurringCommit#access_amount
|
1628
1895
|
class AccessAmount < MetronomeSDK::Internal::Type::BaseModel
|
1629
1896
|
# @!attribute credit_type_id
|
1630
1897
|
#
|
@@ -1649,13 +1916,15 @@ module MetronomeSDK
|
|
1649
1916
|
# @param unit_price [Float]
|
1650
1917
|
end
|
1651
1918
|
|
1652
|
-
# @see MetronomeSDK::
|
1919
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddRecurringCommit#commit_duration
|
1653
1920
|
class CommitDuration < MetronomeSDK::Internal::Type::BaseModel
|
1654
1921
|
# @!attribute unit
|
1655
1922
|
#
|
1656
|
-
# @return [Symbol, MetronomeSDK::
|
1923
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::AddRecurringCommit::CommitDuration::Unit]
|
1657
1924
|
required :unit,
|
1658
|
-
enum: -> {
|
1925
|
+
enum: -> {
|
1926
|
+
MetronomeSDK::V2::ContractEditParams::AddRecurringCommit::CommitDuration::Unit
|
1927
|
+
}
|
1659
1928
|
|
1660
1929
|
# @!attribute value
|
1661
1930
|
#
|
@@ -1665,10 +1934,10 @@ module MetronomeSDK
|
|
1665
1934
|
# @!method initialize(unit:, value:)
|
1666
1935
|
# The amount of time the created commits will be valid for.
|
1667
1936
|
#
|
1668
|
-
# @param unit [Symbol, MetronomeSDK::
|
1937
|
+
# @param unit [Symbol, MetronomeSDK::V2::ContractEditParams::AddRecurringCommit::CommitDuration::Unit]
|
1669
1938
|
# @param value [Float]
|
1670
1939
|
|
1671
|
-
# @see MetronomeSDK::
|
1940
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddRecurringCommit::CommitDuration#unit
|
1672
1941
|
module Unit
|
1673
1942
|
extend MetronomeSDK::Internal::Type::Enum
|
1674
1943
|
|
@@ -1679,7 +1948,7 @@ module MetronomeSDK
|
|
1679
1948
|
end
|
1680
1949
|
end
|
1681
1950
|
|
1682
|
-
# @see MetronomeSDK::
|
1951
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddRecurringCommit#invoice_amount
|
1683
1952
|
class InvoiceAmount < MetronomeSDK::Internal::Type::BaseModel
|
1684
1953
|
# @!attribute credit_type_id
|
1685
1954
|
#
|
@@ -1707,7 +1976,7 @@ module MetronomeSDK
|
|
1707
1976
|
# Determines whether the first and last commit will be prorated. If not provided,
|
1708
1977
|
# the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).
|
1709
1978
|
#
|
1710
|
-
# @see MetronomeSDK::
|
1979
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddRecurringCommit#proration
|
1711
1980
|
module Proration
|
1712
1981
|
extend MetronomeSDK::Internal::Type::Enum
|
1713
1982
|
|
@@ -1722,7 +1991,7 @@ module MetronomeSDK
|
|
1722
1991
|
|
1723
1992
|
# Whether the created commits will use the commit rate or list rate
|
1724
1993
|
#
|
1725
|
-
# @see MetronomeSDK::
|
1994
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddRecurringCommit#rate_type
|
1726
1995
|
module RateType
|
1727
1996
|
extend MetronomeSDK::Internal::Type::Enum
|
1728
1997
|
|
@@ -1739,7 +2008,7 @@ module MetronomeSDK
|
|
1739
2008
|
# be created aligned with the recurring commit's start_date rather than the usage
|
1740
2009
|
# invoice dates.
|
1741
2010
|
#
|
1742
|
-
# @see MetronomeSDK::
|
2011
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddRecurringCommit#recurrence_frequency
|
1743
2012
|
module RecurrenceFrequency
|
1744
2013
|
extend MetronomeSDK::Internal::Type::Enum
|
1745
2014
|
|
@@ -1757,16 +2026,20 @@ module MetronomeSDK
|
|
1757
2026
|
# @!attribute access_amount
|
1758
2027
|
# The amount of commit to grant.
|
1759
2028
|
#
|
1760
|
-
# @return [MetronomeSDK::
|
2029
|
+
# @return [MetronomeSDK::V2::ContractEditParams::AddRecurringCredit::AccessAmount]
|
1761
2030
|
required :access_amount,
|
1762
|
-
-> {
|
2031
|
+
-> {
|
2032
|
+
MetronomeSDK::V2::ContractEditParams::AddRecurringCredit::AccessAmount
|
2033
|
+
}
|
1763
2034
|
|
1764
2035
|
# @!attribute commit_duration
|
1765
2036
|
# The amount of time the created commits will be valid for.
|
1766
2037
|
#
|
1767
|
-
# @return [MetronomeSDK::
|
2038
|
+
# @return [MetronomeSDK::V2::ContractEditParams::AddRecurringCredit::CommitDuration]
|
1768
2039
|
required :commit_duration,
|
1769
|
-
-> {
|
2040
|
+
-> {
|
2041
|
+
MetronomeSDK::V2::ContractEditParams::AddRecurringCredit::CommitDuration
|
2042
|
+
}
|
1770
2043
|
|
1771
2044
|
# @!attribute priority
|
1772
2045
|
# Will be passed down to the individual commits
|
@@ -1825,16 +2098,17 @@ module MetronomeSDK
|
|
1825
2098
|
# Determines whether the first and last commit will be prorated. If not provided,
|
1826
2099
|
# the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).
|
1827
2100
|
#
|
1828
|
-
# @return [Symbol, MetronomeSDK::
|
2101
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::AddRecurringCredit::Proration, nil]
|
1829
2102
|
optional :proration,
|
1830
|
-
enum: -> {
|
2103
|
+
enum: -> {
|
2104
|
+
MetronomeSDK::V2::ContractEditParams::AddRecurringCredit::Proration
|
2105
|
+
}
|
1831
2106
|
|
1832
2107
|
# @!attribute rate_type
|
1833
2108
|
# Whether the created commits will use the commit rate or list rate
|
1834
2109
|
#
|
1835
|
-
# @return [Symbol, MetronomeSDK::
|
1836
|
-
optional :rate_type,
|
1837
|
-
enum: -> { MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCredit::RateType }
|
2110
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::AddRecurringCredit::RateType, nil]
|
2111
|
+
optional :rate_type, enum: -> { MetronomeSDK::V2::ContractEditParams::AddRecurringCredit::RateType }
|
1838
2112
|
|
1839
2113
|
# @!attribute recurrence_frequency
|
1840
2114
|
# The frequency at which the recurring commits will be created. If not provided: -
|
@@ -1843,9 +2117,9 @@ module MetronomeSDK
|
|
1843
2117
|
# be created aligned with the recurring commit's start_date rather than the usage
|
1844
2118
|
# invoice dates.
|
1845
2119
|
#
|
1846
|
-
# @return [Symbol, MetronomeSDK::
|
2120
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::AddRecurringCredit::RecurrenceFrequency, nil]
|
1847
2121
|
optional :recurrence_frequency,
|
1848
|
-
enum: -> { MetronomeSDK::
|
2122
|
+
enum: -> { MetronomeSDK::V2::ContractEditParams::AddRecurringCredit::RecurrenceFrequency }
|
1849
2123
|
|
1850
2124
|
# @!attribute rollover_fraction
|
1851
2125
|
# Will be passed down to the individual commits. This controls how much of an
|
@@ -1864,12 +2138,11 @@ module MetronomeSDK
|
|
1864
2138
|
|
1865
2139
|
# @!method initialize(access_amount:, commit_duration:, priority:, product_id:, starting_at:, applicable_product_ids: nil, applicable_product_tags: nil, description: nil, ending_before: nil, name: nil, netsuite_sales_order_id: nil, proration: nil, rate_type: nil, recurrence_frequency: nil, rollover_fraction: nil, temporary_id: nil)
|
1866
2140
|
# Some parameter documentations has been truncated, see
|
1867
|
-
# {MetronomeSDK::
|
1868
|
-
# details.
|
2141
|
+
# {MetronomeSDK::V2::ContractEditParams::AddRecurringCredit} for more details.
|
1869
2142
|
#
|
1870
|
-
# @param access_amount [MetronomeSDK::
|
2143
|
+
# @param access_amount [MetronomeSDK::V2::ContractEditParams::AddRecurringCredit::AccessAmount] The amount of commit to grant.
|
1871
2144
|
#
|
1872
|
-
# @param commit_duration [MetronomeSDK::
|
2145
|
+
# @param commit_duration [MetronomeSDK::V2::ContractEditParams::AddRecurringCredit::CommitDuration] The amount of time the created commits will be valid for.
|
1873
2146
|
#
|
1874
2147
|
# @param priority [Float] Will be passed down to the individual commits
|
1875
2148
|
#
|
@@ -1889,21 +2162,17 @@ module MetronomeSDK
|
|
1889
2162
|
#
|
1890
2163
|
# @param netsuite_sales_order_id [String] Will be passed down to the individual commits
|
1891
2164
|
#
|
1892
|
-
# @param proration [Symbol, MetronomeSDK::
|
1893
|
-
# ...
|
2165
|
+
# @param proration [Symbol, MetronomeSDK::V2::ContractEditParams::AddRecurringCredit::Proration] Determines whether the first and last commit will be prorated. If not provided,
|
1894
2166
|
#
|
1895
|
-
# @param rate_type [Symbol, MetronomeSDK::
|
2167
|
+
# @param rate_type [Symbol, MetronomeSDK::V2::ContractEditParams::AddRecurringCredit::RateType] Whether the created commits will use the commit rate or list rate
|
1896
2168
|
#
|
1897
|
-
# @param recurrence_frequency [Symbol, MetronomeSDK::
|
1898
|
-
# ...
|
2169
|
+
# @param recurrence_frequency [Symbol, MetronomeSDK::V2::ContractEditParams::AddRecurringCredit::RecurrenceFrequency] The frequency at which the recurring commits will be created. If not provided: -
|
1899
2170
|
#
|
1900
2171
|
# @param rollover_fraction [Float] Will be passed down to the individual commits. This controls how much of an indi
|
1901
|
-
# ...
|
1902
2172
|
#
|
1903
2173
|
# @param temporary_id [String] A temporary ID that can be used to reference the recurring commit for commit spe
|
1904
|
-
# ...
|
1905
2174
|
|
1906
|
-
# @see MetronomeSDK::
|
2175
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddRecurringCredit#access_amount
|
1907
2176
|
class AccessAmount < MetronomeSDK::Internal::Type::BaseModel
|
1908
2177
|
# @!attribute credit_type_id
|
1909
2178
|
#
|
@@ -1928,13 +2197,15 @@ module MetronomeSDK
|
|
1928
2197
|
# @param unit_price [Float]
|
1929
2198
|
end
|
1930
2199
|
|
1931
|
-
# @see MetronomeSDK::
|
2200
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddRecurringCredit#commit_duration
|
1932
2201
|
class CommitDuration < MetronomeSDK::Internal::Type::BaseModel
|
1933
2202
|
# @!attribute unit
|
1934
2203
|
#
|
1935
|
-
# @return [Symbol, MetronomeSDK::
|
2204
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::AddRecurringCredit::CommitDuration::Unit]
|
1936
2205
|
required :unit,
|
1937
|
-
enum: -> {
|
2206
|
+
enum: -> {
|
2207
|
+
MetronomeSDK::V2::ContractEditParams::AddRecurringCredit::CommitDuration::Unit
|
2208
|
+
}
|
1938
2209
|
|
1939
2210
|
# @!attribute value
|
1940
2211
|
#
|
@@ -1944,10 +2215,10 @@ module MetronomeSDK
|
|
1944
2215
|
# @!method initialize(unit:, value:)
|
1945
2216
|
# The amount of time the created commits will be valid for.
|
1946
2217
|
#
|
1947
|
-
# @param unit [Symbol, MetronomeSDK::
|
2218
|
+
# @param unit [Symbol, MetronomeSDK::V2::ContractEditParams::AddRecurringCredit::CommitDuration::Unit]
|
1948
2219
|
# @param value [Float]
|
1949
2220
|
|
1950
|
-
# @see MetronomeSDK::
|
2221
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddRecurringCredit::CommitDuration#unit
|
1951
2222
|
module Unit
|
1952
2223
|
extend MetronomeSDK::Internal::Type::Enum
|
1953
2224
|
|
@@ -1961,7 +2232,7 @@ module MetronomeSDK
|
|
1961
2232
|
# Determines whether the first and last commit will be prorated. If not provided,
|
1962
2233
|
# the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).
|
1963
2234
|
#
|
1964
|
-
# @see MetronomeSDK::
|
2235
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddRecurringCredit#proration
|
1965
2236
|
module Proration
|
1966
2237
|
extend MetronomeSDK::Internal::Type::Enum
|
1967
2238
|
|
@@ -1976,7 +2247,7 @@ module MetronomeSDK
|
|
1976
2247
|
|
1977
2248
|
# Whether the created commits will use the commit rate or list rate
|
1978
2249
|
#
|
1979
|
-
# @see MetronomeSDK::
|
2250
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddRecurringCredit#rate_type
|
1980
2251
|
module RateType
|
1981
2252
|
extend MetronomeSDK::Internal::Type::Enum
|
1982
2253
|
|
@@ -1993,7 +2264,7 @@ module MetronomeSDK
|
|
1993
2264
|
# be created aligned with the recurring commit's start_date rather than the usage
|
1994
2265
|
# invoice dates.
|
1995
2266
|
#
|
1996
|
-
# @see MetronomeSDK::
|
2267
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddRecurringCredit#recurrence_frequency
|
1997
2268
|
module RecurrenceFrequency
|
1998
2269
|
extend MetronomeSDK::Internal::Type::Enum
|
1999
2270
|
|
@@ -2010,9 +2281,9 @@ module MetronomeSDK
|
|
2010
2281
|
class AddResellerRoyalty < MetronomeSDK::Internal::Type::BaseModel
|
2011
2282
|
# @!attribute reseller_type
|
2012
2283
|
#
|
2013
|
-
# @return [Symbol, MetronomeSDK::
|
2284
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::AddResellerRoyalty::ResellerType]
|
2014
2285
|
required :reseller_type,
|
2015
|
-
enum: -> { MetronomeSDK::
|
2286
|
+
enum: -> { MetronomeSDK::V2::ContractEditParams::AddResellerRoyalty::ResellerType }
|
2016
2287
|
|
2017
2288
|
# @!attribute applicable_product_ids
|
2018
2289
|
# Must provide at least one of applicable_product_ids or applicable_product_tags.
|
@@ -2028,8 +2299,8 @@ module MetronomeSDK
|
|
2028
2299
|
|
2029
2300
|
# @!attribute aws_options
|
2030
2301
|
#
|
2031
|
-
# @return [MetronomeSDK::
|
2032
|
-
optional :aws_options, -> { MetronomeSDK::
|
2302
|
+
# @return [MetronomeSDK::V2::ContractEditParams::AddResellerRoyalty::AwsOptions, nil]
|
2303
|
+
optional :aws_options, -> { MetronomeSDK::V2::ContractEditParams::AddResellerRoyalty::AwsOptions }
|
2033
2304
|
|
2034
2305
|
# @!attribute ending_before
|
2035
2306
|
# Use null to indicate that the existing end timestamp should be removed.
|
@@ -2044,8 +2315,8 @@ module MetronomeSDK
|
|
2044
2315
|
|
2045
2316
|
# @!attribute gcp_options
|
2046
2317
|
#
|
2047
|
-
# @return [MetronomeSDK::
|
2048
|
-
optional :gcp_options, -> { MetronomeSDK::
|
2318
|
+
# @return [MetronomeSDK::V2::ContractEditParams::AddResellerRoyalty::GcpOptions, nil]
|
2319
|
+
optional :gcp_options, -> { MetronomeSDK::V2::ContractEditParams::AddResellerRoyalty::GcpOptions }
|
2049
2320
|
|
2050
2321
|
# @!attribute netsuite_reseller_id
|
2051
2322
|
#
|
@@ -2063,19 +2334,19 @@ module MetronomeSDK
|
|
2063
2334
|
optional :starting_at, Time
|
2064
2335
|
|
2065
2336
|
# @!method initialize(reseller_type:, applicable_product_ids: nil, applicable_product_tags: nil, aws_options: nil, ending_before: nil, fraction: nil, gcp_options: nil, netsuite_reseller_id: nil, reseller_contract_value: nil, starting_at: nil)
|
2066
|
-
# @param reseller_type [Symbol, MetronomeSDK::
|
2337
|
+
# @param reseller_type [Symbol, MetronomeSDK::V2::ContractEditParams::AddResellerRoyalty::ResellerType]
|
2067
2338
|
#
|
2068
2339
|
# @param applicable_product_ids [Array<String>] Must provide at least one of applicable_product_ids or applicable_product_tags.
|
2069
2340
|
#
|
2070
2341
|
# @param applicable_product_tags [Array<String>] Must provide at least one of applicable_product_ids or applicable_product_tags.
|
2071
2342
|
#
|
2072
|
-
# @param aws_options [MetronomeSDK::
|
2343
|
+
# @param aws_options [MetronomeSDK::V2::ContractEditParams::AddResellerRoyalty::AwsOptions]
|
2073
2344
|
#
|
2074
2345
|
# @param ending_before [Time, nil] Use null to indicate that the existing end timestamp should be removed.
|
2075
2346
|
#
|
2076
2347
|
# @param fraction [Float]
|
2077
2348
|
#
|
2078
|
-
# @param gcp_options [MetronomeSDK::
|
2349
|
+
# @param gcp_options [MetronomeSDK::V2::ContractEditParams::AddResellerRoyalty::GcpOptions]
|
2079
2350
|
#
|
2080
2351
|
# @param netsuite_reseller_id [String]
|
2081
2352
|
#
|
@@ -2083,7 +2354,7 @@ module MetronomeSDK
|
|
2083
2354
|
#
|
2084
2355
|
# @param starting_at [Time]
|
2085
2356
|
|
2086
|
-
# @see MetronomeSDK::
|
2357
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddResellerRoyalty#reseller_type
|
2087
2358
|
module ResellerType
|
2088
2359
|
extend MetronomeSDK::Internal::Type::Enum
|
2089
2360
|
|
@@ -2096,7 +2367,7 @@ module MetronomeSDK
|
|
2096
2367
|
# @return [Array<Symbol>]
|
2097
2368
|
end
|
2098
2369
|
|
2099
|
-
# @see MetronomeSDK::
|
2370
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddResellerRoyalty#aws_options
|
2100
2371
|
class AwsOptions < MetronomeSDK::Internal::Type::BaseModel
|
2101
2372
|
# @!attribute aws_account_number
|
2102
2373
|
#
|
@@ -2119,7 +2390,7 @@ module MetronomeSDK
|
|
2119
2390
|
# @param aws_payer_reference_id [String]
|
2120
2391
|
end
|
2121
2392
|
|
2122
|
-
# @see MetronomeSDK::
|
2393
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddResellerRoyalty#gcp_options
|
2123
2394
|
class GcpOptions < MetronomeSDK::Internal::Type::BaseModel
|
2124
2395
|
# @!attribute gcp_account_id
|
2125
2396
|
#
|
@@ -2146,8 +2417,8 @@ module MetronomeSDK
|
|
2146
2417
|
# @!attribute schedule
|
2147
2418
|
# Must provide either schedule_items or recurring_schedule.
|
2148
2419
|
#
|
2149
|
-
# @return [MetronomeSDK::
|
2150
|
-
required :schedule, -> { MetronomeSDK::
|
2420
|
+
# @return [MetronomeSDK::V2::ContractEditParams::AddScheduledCharge::Schedule]
|
2421
|
+
required :schedule, -> { MetronomeSDK::V2::ContractEditParams::AddScheduledCharge::Schedule }
|
2151
2422
|
|
2152
2423
|
# @!attribute name
|
2153
2424
|
# displayed on invoices
|
@@ -2164,13 +2435,13 @@ module MetronomeSDK
|
|
2164
2435
|
# @!method initialize(product_id:, schedule:, name: nil, netsuite_sales_order_id: nil)
|
2165
2436
|
# @param product_id [String]
|
2166
2437
|
#
|
2167
|
-
# @param schedule [MetronomeSDK::
|
2438
|
+
# @param schedule [MetronomeSDK::V2::ContractEditParams::AddScheduledCharge::Schedule] Must provide either schedule_items or recurring_schedule.
|
2168
2439
|
#
|
2169
2440
|
# @param name [String] displayed on invoices
|
2170
2441
|
#
|
2171
2442
|
# @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
|
2172
2443
|
|
2173
|
-
# @see MetronomeSDK::
|
2444
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddScheduledCharge#schedule
|
2174
2445
|
class Schedule < MetronomeSDK::Internal::Type::BaseModel
|
2175
2446
|
# @!attribute credit_type_id
|
2176
2447
|
# Defaults to USD if not passed. Only USD is supported at this time.
|
@@ -2183,38 +2454,43 @@ module MetronomeSDK
|
|
2183
2454
|
# amount. If amount is sent, the unit price is assumed to be the amount and
|
2184
2455
|
# quantity is inferred to be 1.
|
2185
2456
|
#
|
2186
|
-
# @return [MetronomeSDK::
|
2457
|
+
# @return [MetronomeSDK::V2::ContractEditParams::AddScheduledCharge::Schedule::RecurringSchedule, nil]
|
2187
2458
|
optional :recurring_schedule,
|
2188
|
-
-> {
|
2459
|
+
-> {
|
2460
|
+
MetronomeSDK::V2::ContractEditParams::AddScheduledCharge::Schedule::RecurringSchedule
|
2461
|
+
}
|
2189
2462
|
|
2190
2463
|
# @!attribute schedule_items
|
2191
2464
|
# Either provide amount or provide both unit_price and quantity.
|
2192
2465
|
#
|
2193
|
-
# @return [Array<MetronomeSDK::
|
2466
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::AddScheduledCharge::Schedule::ScheduleItem>, nil]
|
2194
2467
|
optional :schedule_items,
|
2195
|
-
-> {
|
2468
|
+
-> {
|
2469
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::AddScheduledCharge::Schedule::ScheduleItem]
|
2470
|
+
}
|
2196
2471
|
|
2197
2472
|
# @!method initialize(credit_type_id: nil, recurring_schedule: nil, schedule_items: nil)
|
2198
2473
|
# Some parameter documentations has been truncated, see
|
2199
|
-
# {MetronomeSDK::
|
2200
|
-
#
|
2474
|
+
# {MetronomeSDK::V2::ContractEditParams::AddScheduledCharge::Schedule} for more
|
2475
|
+
# details.
|
2201
2476
|
#
|
2202
2477
|
# Must provide either schedule_items or recurring_schedule.
|
2203
2478
|
#
|
2204
2479
|
# @param credit_type_id [String] Defaults to USD if not passed. Only USD is supported at this time.
|
2205
2480
|
#
|
2206
|
-
# @param recurring_schedule [MetronomeSDK::
|
2207
|
-
# ...
|
2481
|
+
# @param recurring_schedule [MetronomeSDK::V2::ContractEditParams::AddScheduledCharge::Schedule::RecurringSchedule] Enter the unit price and quantity for the charge or instead only send the amount
|
2208
2482
|
#
|
2209
|
-
# @param schedule_items [Array<MetronomeSDK::
|
2483
|
+
# @param schedule_items [Array<MetronomeSDK::V2::ContractEditParams::AddScheduledCharge::Schedule::ScheduleItem>] Either provide amount or provide both unit_price and quantity.
|
2210
2484
|
|
2211
|
-
# @see MetronomeSDK::
|
2485
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddScheduledCharge::Schedule#recurring_schedule
|
2212
2486
|
class RecurringSchedule < MetronomeSDK::Internal::Type::BaseModel
|
2213
2487
|
# @!attribute amount_distribution
|
2214
2488
|
#
|
2215
|
-
# @return [Symbol, MetronomeSDK::
|
2489
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::AddScheduledCharge::Schedule::RecurringSchedule::AmountDistribution]
|
2216
2490
|
required :amount_distribution,
|
2217
|
-
enum: -> {
|
2491
|
+
enum: -> {
|
2492
|
+
MetronomeSDK::V2::ContractEditParams::AddScheduledCharge::Schedule::RecurringSchedule::AmountDistribution
|
2493
|
+
}
|
2218
2494
|
|
2219
2495
|
# @!attribute ending_before
|
2220
2496
|
# RFC 3339 timestamp (exclusive).
|
@@ -2224,9 +2500,11 @@ module MetronomeSDK
|
|
2224
2500
|
|
2225
2501
|
# @!attribute frequency
|
2226
2502
|
#
|
2227
|
-
# @return [Symbol, MetronomeSDK::
|
2503
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::AddScheduledCharge::Schedule::RecurringSchedule::Frequency]
|
2228
2504
|
required :frequency,
|
2229
|
-
enum: -> {
|
2505
|
+
enum: -> {
|
2506
|
+
MetronomeSDK::V2::ContractEditParams::AddScheduledCharge::Schedule::RecurringSchedule::Frequency
|
2507
|
+
}
|
2230
2508
|
|
2231
2509
|
# @!attribute starting_at
|
2232
2510
|
# RFC 3339 timestamp (inclusive).
|
@@ -2260,31 +2538,28 @@ module MetronomeSDK
|
|
2260
2538
|
|
2261
2539
|
# @!method initialize(amount_distribution:, ending_before:, frequency:, starting_at:, amount: nil, quantity: nil, unit_price: nil)
|
2262
2540
|
# Some parameter documentations has been truncated, see
|
2263
|
-
# {MetronomeSDK::
|
2541
|
+
# {MetronomeSDK::V2::ContractEditParams::AddScheduledCharge::Schedule::RecurringSchedule}
|
2264
2542
|
# for more details.
|
2265
2543
|
#
|
2266
2544
|
# Enter the unit price and quantity for the charge or instead only send the
|
2267
2545
|
# amount. If amount is sent, the unit price is assumed to be the amount and
|
2268
2546
|
# quantity is inferred to be 1.
|
2269
2547
|
#
|
2270
|
-
# @param amount_distribution [Symbol, MetronomeSDK::
|
2548
|
+
# @param amount_distribution [Symbol, MetronomeSDK::V2::ContractEditParams::AddScheduledCharge::Schedule::RecurringSchedule::AmountDistribution]
|
2271
2549
|
#
|
2272
2550
|
# @param ending_before [Time] RFC 3339 timestamp (exclusive).
|
2273
2551
|
#
|
2274
|
-
# @param frequency [Symbol, MetronomeSDK::
|
2552
|
+
# @param frequency [Symbol, MetronomeSDK::V2::ContractEditParams::AddScheduledCharge::Schedule::RecurringSchedule::Frequency]
|
2275
2553
|
#
|
2276
2554
|
# @param starting_at [Time] RFC 3339 timestamp (inclusive).
|
2277
2555
|
#
|
2278
2556
|
# @param amount [Float] Amount for the charge. Can be provided instead of unit_price and quantity. If am
|
2279
|
-
# ...
|
2280
2557
|
#
|
2281
2558
|
# @param quantity [Float] Quantity for the charge. Will be multiplied by unit_price to determine the amoun
|
2282
|
-
# ...
|
2283
2559
|
#
|
2284
2560
|
# @param unit_price [Float] Unit price for the charge. Will be multiplied by quantity to determine the amoun
|
2285
|
-
# ...
|
2286
2561
|
|
2287
|
-
# @see MetronomeSDK::
|
2562
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddScheduledCharge::Schedule::RecurringSchedule#amount_distribution
|
2288
2563
|
module AmountDistribution
|
2289
2564
|
extend MetronomeSDK::Internal::Type::Enum
|
2290
2565
|
|
@@ -2296,7 +2571,7 @@ module MetronomeSDK
|
|
2296
2571
|
# @return [Array<Symbol>]
|
2297
2572
|
end
|
2298
2573
|
|
2299
|
-
# @see MetronomeSDK::
|
2574
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddScheduledCharge::Schedule::RecurringSchedule#frequency
|
2300
2575
|
module Frequency
|
2301
2576
|
extend MetronomeSDK::Internal::Type::Enum
|
2302
2577
|
|
@@ -2344,19 +2619,16 @@ module MetronomeSDK
|
|
2344
2619
|
|
2345
2620
|
# @!method initialize(timestamp:, amount: nil, quantity: nil, unit_price: nil)
|
2346
2621
|
# Some parameter documentations has been truncated, see
|
2347
|
-
# {MetronomeSDK::
|
2622
|
+
# {MetronomeSDK::V2::ContractEditParams::AddScheduledCharge::Schedule::ScheduleItem}
|
2348
2623
|
# for more details.
|
2349
2624
|
#
|
2350
2625
|
# @param timestamp [Time] timestamp of the scheduled event
|
2351
2626
|
#
|
2352
2627
|
# @param amount [Float] Amount for the charge. Can be provided instead of unit_price and quantity. If am
|
2353
|
-
# ...
|
2354
2628
|
#
|
2355
2629
|
# @param quantity [Float] Quantity for the charge. Will be multiplied by unit_price to determine the amoun
|
2356
|
-
# ...
|
2357
2630
|
#
|
2358
2631
|
# @param unit_price [Float] Unit price for the charge. Will be multiplied by quantity to determine the amoun
|
2359
|
-
# ...
|
2360
2632
|
end
|
2361
2633
|
end
|
2362
2634
|
end
|
@@ -2364,9 +2636,11 @@ module MetronomeSDK
|
|
2364
2636
|
class AddSpendThresholdConfiguration < MetronomeSDK::Internal::Type::BaseModel
|
2365
2637
|
# @!attribute commit
|
2366
2638
|
#
|
2367
|
-
# @return [MetronomeSDK::
|
2639
|
+
# @return [MetronomeSDK::V2::ContractEditParams::AddSpendThresholdConfiguration::Commit]
|
2368
2640
|
required :commit,
|
2369
|
-
-> {
|
2641
|
+
-> {
|
2642
|
+
MetronomeSDK::V2::ContractEditParams::AddSpendThresholdConfiguration::Commit
|
2643
|
+
}
|
2370
2644
|
|
2371
2645
|
# @!attribute is_enabled
|
2372
2646
|
# When set to false, the contract will not be evaluated against the
|
@@ -2378,9 +2652,11 @@ module MetronomeSDK
|
|
2378
2652
|
|
2379
2653
|
# @!attribute payment_gate_config
|
2380
2654
|
#
|
2381
|
-
# @return [MetronomeSDK::
|
2655
|
+
# @return [MetronomeSDK::V2::ContractEditParams::AddSpendThresholdConfiguration::PaymentGateConfig]
|
2382
2656
|
required :payment_gate_config,
|
2383
|
-
-> {
|
2657
|
+
-> {
|
2658
|
+
MetronomeSDK::V2::ContractEditParams::AddSpendThresholdConfiguration::PaymentGateConfig
|
2659
|
+
}
|
2384
2660
|
|
2385
2661
|
# @!attribute threshold_amount
|
2386
2662
|
# Specify the threshold amount for the contract. Each time the contract's usage
|
@@ -2391,20 +2667,18 @@ module MetronomeSDK
|
|
2391
2667
|
|
2392
2668
|
# @!method initialize(commit:, is_enabled:, payment_gate_config:, threshold_amount:)
|
2393
2669
|
# Some parameter documentations has been truncated, see
|
2394
|
-
# {MetronomeSDK::
|
2395
|
-
#
|
2670
|
+
# {MetronomeSDK::V2::ContractEditParams::AddSpendThresholdConfiguration} for more
|
2671
|
+
# details.
|
2396
2672
|
#
|
2397
|
-
# @param commit [MetronomeSDK::
|
2673
|
+
# @param commit [MetronomeSDK::V2::ContractEditParams::AddSpendThresholdConfiguration::Commit]
|
2398
2674
|
#
|
2399
2675
|
# @param is_enabled [Boolean] When set to false, the contract will not be evaluated against the threshold_amou
|
2400
|
-
# ...
|
2401
2676
|
#
|
2402
|
-
# @param payment_gate_config [MetronomeSDK::
|
2677
|
+
# @param payment_gate_config [MetronomeSDK::V2::ContractEditParams::AddSpendThresholdConfiguration::PaymentGateConfig]
|
2403
2678
|
#
|
2404
2679
|
# @param threshold_amount [Float] Specify the threshold amount for the contract. Each time the contract's usage hi
|
2405
|
-
# ...
|
2406
2680
|
|
2407
|
-
# @see MetronomeSDK::
|
2681
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddSpendThresholdConfiguration#commit
|
2408
2682
|
class Commit < MetronomeSDK::Internal::Type::BaseModel
|
2409
2683
|
# @!attribute product_id
|
2410
2684
|
# The commit product that will be used to generate the line item for commit
|
@@ -2427,19 +2701,17 @@ module MetronomeSDK
|
|
2427
2701
|
|
2428
2702
|
# @!method initialize(product_id:, description: nil, name: nil)
|
2429
2703
|
# Some parameter documentations has been truncated, see
|
2430
|
-
# {MetronomeSDK::
|
2704
|
+
# {MetronomeSDK::V2::ContractEditParams::AddSpendThresholdConfiguration::Commit}
|
2431
2705
|
# for more details.
|
2432
2706
|
#
|
2433
2707
|
# @param product_id [String] The commit product that will be used to generate the line item for commit paymen
|
2434
|
-
# ...
|
2435
2708
|
#
|
2436
2709
|
# @param description [String]
|
2437
2710
|
#
|
2438
2711
|
# @param name [String] Specify the name of the line item for the threshold charge. If left blank, it wi
|
2439
|
-
# ...
|
2440
2712
|
end
|
2441
2713
|
|
2442
|
-
# @see MetronomeSDK::
|
2714
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddSpendThresholdConfiguration#payment_gate_config
|
2443
2715
|
class PaymentGateConfig < MetronomeSDK::Internal::Type::BaseModel
|
2444
2716
|
# @!attribute payment_gate_type
|
2445
2717
|
# Gate access to the commit balance based on successful collection of payment.
|
@@ -2447,45 +2719,49 @@ module MetronomeSDK
|
|
2447
2719
|
# facilitate payment using your own payment integration. Select NONE if you do not
|
2448
2720
|
# wish to payment gate the commit balance.
|
2449
2721
|
#
|
2450
|
-
# @return [Symbol, MetronomeSDK::
|
2722
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::AddSpendThresholdConfiguration::PaymentGateConfig::PaymentGateType]
|
2451
2723
|
required :payment_gate_type,
|
2452
|
-
enum: -> {
|
2724
|
+
enum: -> {
|
2725
|
+
MetronomeSDK::V2::ContractEditParams::AddSpendThresholdConfiguration::PaymentGateConfig::PaymentGateType
|
2726
|
+
}
|
2453
2727
|
|
2454
2728
|
# @!attribute stripe_config
|
2455
2729
|
# Only applicable if using Stripe as your payment gateway through Metronome.
|
2456
2730
|
#
|
2457
|
-
# @return [MetronomeSDK::
|
2731
|
+
# @return [MetronomeSDK::V2::ContractEditParams::AddSpendThresholdConfiguration::PaymentGateConfig::StripeConfig, nil]
|
2458
2732
|
optional :stripe_config,
|
2459
|
-
-> {
|
2733
|
+
-> {
|
2734
|
+
MetronomeSDK::V2::ContractEditParams::AddSpendThresholdConfiguration::PaymentGateConfig::StripeConfig
|
2735
|
+
}
|
2460
2736
|
|
2461
2737
|
# @!attribute tax_type
|
2462
2738
|
# Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
|
2463
2739
|
# not wish Metronome to calculate tax on your behalf. Leaving this field blank
|
2464
2740
|
# will default to NONE.
|
2465
2741
|
#
|
2466
|
-
# @return [Symbol, MetronomeSDK::
|
2742
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::AddSpendThresholdConfiguration::PaymentGateConfig::TaxType, nil]
|
2467
2743
|
optional :tax_type,
|
2468
|
-
enum: -> {
|
2744
|
+
enum: -> {
|
2745
|
+
MetronomeSDK::V2::ContractEditParams::AddSpendThresholdConfiguration::PaymentGateConfig::TaxType
|
2746
|
+
}
|
2469
2747
|
|
2470
2748
|
# @!method initialize(payment_gate_type:, stripe_config: nil, tax_type: nil)
|
2471
2749
|
# Some parameter documentations has been truncated, see
|
2472
|
-
# {MetronomeSDK::
|
2750
|
+
# {MetronomeSDK::V2::ContractEditParams::AddSpendThresholdConfiguration::PaymentGateConfig}
|
2473
2751
|
# for more details.
|
2474
2752
|
#
|
2475
|
-
# @param payment_gate_type [Symbol, MetronomeSDK::
|
2476
|
-
# ...
|
2753
|
+
# @param payment_gate_type [Symbol, MetronomeSDK::V2::ContractEditParams::AddSpendThresholdConfiguration::PaymentGateConfig::PaymentGateType] Gate access to the commit balance based on successful collection of payment. Sel
|
2477
2754
|
#
|
2478
|
-
# @param stripe_config [MetronomeSDK::
|
2755
|
+
# @param stripe_config [MetronomeSDK::V2::ContractEditParams::AddSpendThresholdConfiguration::PaymentGateConfig::StripeConfig] Only applicable if using Stripe as your payment gateway through Metronome.
|
2479
2756
|
#
|
2480
|
-
# @param tax_type [Symbol, MetronomeSDK::
|
2481
|
-
# ...
|
2757
|
+
# @param tax_type [Symbol, MetronomeSDK::V2::ContractEditParams::AddSpendThresholdConfiguration::PaymentGateConfig::TaxType] Stripe tax is only supported for Stripe payment gateway. Select NONE if you do n
|
2482
2758
|
|
2483
2759
|
# Gate access to the commit balance based on successful collection of payment.
|
2484
2760
|
# Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
|
2485
2761
|
# facilitate payment using your own payment integration. Select NONE if you do not
|
2486
2762
|
# wish to payment gate the commit balance.
|
2487
2763
|
#
|
2488
|
-
# @see MetronomeSDK::
|
2764
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddSpendThresholdConfiguration::PaymentGateConfig#payment_gate_type
|
2489
2765
|
module PaymentGateType
|
2490
2766
|
extend MetronomeSDK::Internal::Type::Enum
|
2491
2767
|
|
@@ -2497,23 +2773,25 @@ module MetronomeSDK
|
|
2497
2773
|
# @return [Array<Symbol>]
|
2498
2774
|
end
|
2499
2775
|
|
2500
|
-
# @see MetronomeSDK::
|
2776
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddSpendThresholdConfiguration::PaymentGateConfig#stripe_config
|
2501
2777
|
class StripeConfig < MetronomeSDK::Internal::Type::BaseModel
|
2502
2778
|
# @!attribute payment_type
|
2503
2779
|
# If left blank, will default to INVOICE
|
2504
2780
|
#
|
2505
|
-
# @return [Symbol, MetronomeSDK::
|
2781
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::AddSpendThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType]
|
2506
2782
|
required :payment_type,
|
2507
|
-
enum: -> {
|
2783
|
+
enum: -> {
|
2784
|
+
MetronomeSDK::V2::ContractEditParams::AddSpendThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType
|
2785
|
+
}
|
2508
2786
|
|
2509
2787
|
# @!method initialize(payment_type:)
|
2510
2788
|
# Only applicable if using Stripe as your payment gateway through Metronome.
|
2511
2789
|
#
|
2512
|
-
# @param payment_type [Symbol, MetronomeSDK::
|
2790
|
+
# @param payment_type [Symbol, MetronomeSDK::V2::ContractEditParams::AddSpendThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType] If left blank, will default to INVOICE
|
2513
2791
|
|
2514
2792
|
# If left blank, will default to INVOICE
|
2515
2793
|
#
|
2516
|
-
# @see MetronomeSDK::
|
2794
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddSpendThresholdConfiguration::PaymentGateConfig::StripeConfig#payment_type
|
2517
2795
|
module PaymentType
|
2518
2796
|
extend MetronomeSDK::Internal::Type::Enum
|
2519
2797
|
|
@@ -2529,7 +2807,7 @@ module MetronomeSDK
|
|
2529
2807
|
# not wish Metronome to calculate tax on your behalf. Leaving this field blank
|
2530
2808
|
# will default to NONE.
|
2531
2809
|
#
|
2532
|
-
# @see MetronomeSDK::
|
2810
|
+
# @see MetronomeSDK::V2::ContractEditParams::AddSpendThresholdConfiguration::PaymentGateConfig#tax_type
|
2533
2811
|
module TaxType
|
2534
2812
|
extend MetronomeSDK::Internal::Type::Enum
|
2535
2813
|
|
@@ -2590,9 +2868,8 @@ module MetronomeSDK
|
|
2590
2868
|
|
2591
2869
|
# @!attribute access_schedule
|
2592
2870
|
#
|
2593
|
-
# @return [MetronomeSDK::
|
2594
|
-
optional :access_schedule,
|
2595
|
-
-> { MetronomeSDK::Models::V2::ContractEditParams::UpdateCommit::AccessSchedule }
|
2871
|
+
# @return [MetronomeSDK::V2::ContractEditParams::UpdateCommit::AccessSchedule, nil]
|
2872
|
+
optional :access_schedule, -> { MetronomeSDK::V2::ContractEditParams::UpdateCommit::AccessSchedule }
|
2596
2873
|
|
2597
2874
|
# @!attribute applicable_product_ids
|
2598
2875
|
# Which products the commit applies to. If both applicable_product_ids and
|
@@ -2610,9 +2887,11 @@ module MetronomeSDK
|
|
2610
2887
|
|
2611
2888
|
# @!attribute invoice_schedule
|
2612
2889
|
#
|
2613
|
-
# @return [MetronomeSDK::
|
2890
|
+
# @return [MetronomeSDK::V2::ContractEditParams::UpdateCommit::InvoiceSchedule, nil]
|
2614
2891
|
optional :invoice_schedule,
|
2615
|
-
-> {
|
2892
|
+
-> {
|
2893
|
+
MetronomeSDK::V2::ContractEditParams::UpdateCommit::InvoiceSchedule
|
2894
|
+
}
|
2616
2895
|
|
2617
2896
|
# @!attribute netsuite_sales_order_id
|
2618
2897
|
#
|
@@ -2631,19 +2910,17 @@ module MetronomeSDK
|
|
2631
2910
|
|
2632
2911
|
# @!method initialize(commit_id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, invoice_schedule: nil, netsuite_sales_order_id: nil, product_id: nil, rollover_fraction: nil)
|
2633
2912
|
# Some parameter documentations has been truncated, see
|
2634
|
-
# {MetronomeSDK::
|
2913
|
+
# {MetronomeSDK::V2::ContractEditParams::UpdateCommit} for more details.
|
2635
2914
|
#
|
2636
2915
|
# @param commit_id [String]
|
2637
2916
|
#
|
2638
|
-
# @param access_schedule [MetronomeSDK::
|
2917
|
+
# @param access_schedule [MetronomeSDK::V2::ContractEditParams::UpdateCommit::AccessSchedule]
|
2639
2918
|
#
|
2640
2919
|
# @param applicable_product_ids [Array<String>, nil] Which products the commit applies to. If both applicable_product_ids and applica
|
2641
|
-
# ...
|
2642
2920
|
#
|
2643
2921
|
# @param applicable_product_tags [Array<String>, nil] Which tags the commit applies to. If both applicable*product_ids and applicable*
|
2644
|
-
# ...
|
2645
2922
|
#
|
2646
|
-
# @param invoice_schedule [MetronomeSDK::
|
2923
|
+
# @param invoice_schedule [MetronomeSDK::V2::ContractEditParams::UpdateCommit::InvoiceSchedule]
|
2647
2924
|
#
|
2648
2925
|
# @param netsuite_sales_order_id [String, nil]
|
2649
2926
|
#
|
@@ -2651,30 +2928,36 @@ module MetronomeSDK
|
|
2651
2928
|
#
|
2652
2929
|
# @param rollover_fraction [Float, nil]
|
2653
2930
|
|
2654
|
-
# @see MetronomeSDK::
|
2931
|
+
# @see MetronomeSDK::V2::ContractEditParams::UpdateCommit#access_schedule
|
2655
2932
|
class AccessSchedule < MetronomeSDK::Internal::Type::BaseModel
|
2656
2933
|
# @!attribute add_schedule_items
|
2657
2934
|
#
|
2658
|
-
# @return [Array<MetronomeSDK::
|
2935
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::UpdateCommit::AccessSchedule::AddScheduleItem>, nil]
|
2659
2936
|
optional :add_schedule_items,
|
2660
|
-
-> {
|
2937
|
+
-> {
|
2938
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::UpdateCommit::AccessSchedule::AddScheduleItem]
|
2939
|
+
}
|
2661
2940
|
|
2662
2941
|
# @!attribute remove_schedule_items
|
2663
2942
|
#
|
2664
|
-
# @return [Array<MetronomeSDK::
|
2943
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::UpdateCommit::AccessSchedule::RemoveScheduleItem>, nil]
|
2665
2944
|
optional :remove_schedule_items,
|
2666
|
-
-> {
|
2945
|
+
-> {
|
2946
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::UpdateCommit::AccessSchedule::RemoveScheduleItem]
|
2947
|
+
}
|
2667
2948
|
|
2668
2949
|
# @!attribute update_schedule_items
|
2669
2950
|
#
|
2670
|
-
# @return [Array<MetronomeSDK::
|
2951
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::UpdateCommit::AccessSchedule::UpdateScheduleItem>, nil]
|
2671
2952
|
optional :update_schedule_items,
|
2672
|
-
-> {
|
2953
|
+
-> {
|
2954
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::UpdateCommit::AccessSchedule::UpdateScheduleItem]
|
2955
|
+
}
|
2673
2956
|
|
2674
2957
|
# @!method initialize(add_schedule_items: nil, remove_schedule_items: nil, update_schedule_items: nil)
|
2675
|
-
# @param add_schedule_items [Array<MetronomeSDK::
|
2676
|
-
# @param remove_schedule_items [Array<MetronomeSDK::
|
2677
|
-
# @param update_schedule_items [Array<MetronomeSDK::
|
2958
|
+
# @param add_schedule_items [Array<MetronomeSDK::V2::ContractEditParams::UpdateCommit::AccessSchedule::AddScheduleItem>]
|
2959
|
+
# @param remove_schedule_items [Array<MetronomeSDK::V2::ContractEditParams::UpdateCommit::AccessSchedule::RemoveScheduleItem>]
|
2960
|
+
# @param update_schedule_items [Array<MetronomeSDK::V2::ContractEditParams::UpdateCommit::AccessSchedule::UpdateScheduleItem>]
|
2678
2961
|
|
2679
2962
|
class AddScheduleItem < MetronomeSDK::Internal::Type::BaseModel
|
2680
2963
|
# @!attribute amount
|
@@ -2737,30 +3020,36 @@ module MetronomeSDK
|
|
2737
3020
|
end
|
2738
3021
|
end
|
2739
3022
|
|
2740
|
-
# @see MetronomeSDK::
|
3023
|
+
# @see MetronomeSDK::V2::ContractEditParams::UpdateCommit#invoice_schedule
|
2741
3024
|
class InvoiceSchedule < MetronomeSDK::Internal::Type::BaseModel
|
2742
3025
|
# @!attribute add_schedule_items
|
2743
3026
|
#
|
2744
|
-
# @return [Array<MetronomeSDK::
|
3027
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::UpdateCommit::InvoiceSchedule::AddScheduleItem>, nil]
|
2745
3028
|
optional :add_schedule_items,
|
2746
|
-
-> {
|
3029
|
+
-> {
|
3030
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::UpdateCommit::InvoiceSchedule::AddScheduleItem]
|
3031
|
+
}
|
2747
3032
|
|
2748
3033
|
# @!attribute remove_schedule_items
|
2749
3034
|
#
|
2750
|
-
# @return [Array<MetronomeSDK::
|
3035
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::UpdateCommit::InvoiceSchedule::RemoveScheduleItem>, nil]
|
2751
3036
|
optional :remove_schedule_items,
|
2752
|
-
-> {
|
3037
|
+
-> {
|
3038
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::UpdateCommit::InvoiceSchedule::RemoveScheduleItem]
|
3039
|
+
}
|
2753
3040
|
|
2754
3041
|
# @!attribute update_schedule_items
|
2755
3042
|
#
|
2756
|
-
# @return [Array<MetronomeSDK::
|
3043
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::UpdateCommit::InvoiceSchedule::UpdateScheduleItem>, nil]
|
2757
3044
|
optional :update_schedule_items,
|
2758
|
-
-> {
|
3045
|
+
-> {
|
3046
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::UpdateCommit::InvoiceSchedule::UpdateScheduleItem]
|
3047
|
+
}
|
2759
3048
|
|
2760
3049
|
# @!method initialize(add_schedule_items: nil, remove_schedule_items: nil, update_schedule_items: nil)
|
2761
|
-
# @param add_schedule_items [Array<MetronomeSDK::
|
2762
|
-
# @param remove_schedule_items [Array<MetronomeSDK::
|
2763
|
-
# @param update_schedule_items [Array<MetronomeSDK::
|
3050
|
+
# @param add_schedule_items [Array<MetronomeSDK::V2::ContractEditParams::UpdateCommit::InvoiceSchedule::AddScheduleItem>]
|
3051
|
+
# @param remove_schedule_items [Array<MetronomeSDK::V2::ContractEditParams::UpdateCommit::InvoiceSchedule::RemoveScheduleItem>]
|
3052
|
+
# @param update_schedule_items [Array<MetronomeSDK::V2::ContractEditParams::UpdateCommit::InvoiceSchedule::UpdateScheduleItem>]
|
2764
3053
|
|
2765
3054
|
class AddScheduleItem < MetronomeSDK::Internal::Type::BaseModel
|
2766
3055
|
# @!attribute timestamp
|
@@ -2844,9 +3133,8 @@ module MetronomeSDK
|
|
2844
3133
|
|
2845
3134
|
# @!attribute access_schedule
|
2846
3135
|
#
|
2847
|
-
# @return [MetronomeSDK::
|
2848
|
-
optional :access_schedule,
|
2849
|
-
-> { MetronomeSDK::Models::V2::ContractEditParams::UpdateCredit::AccessSchedule }
|
3136
|
+
# @return [MetronomeSDK::V2::ContractEditParams::UpdateCredit::AccessSchedule, nil]
|
3137
|
+
optional :access_schedule, -> { MetronomeSDK::V2::ContractEditParams::UpdateCredit::AccessSchedule }
|
2850
3138
|
|
2851
3139
|
# @!attribute applicable_product_ids
|
2852
3140
|
# Which products the commit applies to. If both applicable_product_ids and
|
@@ -2874,46 +3162,50 @@ module MetronomeSDK
|
|
2874
3162
|
|
2875
3163
|
# @!method initialize(credit_id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, netsuite_sales_order_id: nil, product_id: nil)
|
2876
3164
|
# Some parameter documentations has been truncated, see
|
2877
|
-
# {MetronomeSDK::
|
3165
|
+
# {MetronomeSDK::V2::ContractEditParams::UpdateCredit} for more details.
|
2878
3166
|
#
|
2879
3167
|
# @param credit_id [String]
|
2880
3168
|
#
|
2881
|
-
# @param access_schedule [MetronomeSDK::
|
3169
|
+
# @param access_schedule [MetronomeSDK::V2::ContractEditParams::UpdateCredit::AccessSchedule]
|
2882
3170
|
#
|
2883
3171
|
# @param applicable_product_ids [Array<String>, nil] Which products the commit applies to. If both applicable_product_ids and applica
|
2884
|
-
# ...
|
2885
3172
|
#
|
2886
3173
|
# @param applicable_product_tags [Array<String>, nil] Which tags the commit applies to. If both applicable*product_ids and applicable*
|
2887
|
-
# ...
|
2888
3174
|
#
|
2889
3175
|
# @param netsuite_sales_order_id [String, nil]
|
2890
3176
|
#
|
2891
3177
|
# @param product_id [String]
|
2892
3178
|
|
2893
|
-
# @see MetronomeSDK::
|
3179
|
+
# @see MetronomeSDK::V2::ContractEditParams::UpdateCredit#access_schedule
|
2894
3180
|
class AccessSchedule < MetronomeSDK::Internal::Type::BaseModel
|
2895
3181
|
# @!attribute add_schedule_items
|
2896
3182
|
#
|
2897
|
-
# @return [Array<MetronomeSDK::
|
3183
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::UpdateCredit::AccessSchedule::AddScheduleItem>, nil]
|
2898
3184
|
optional :add_schedule_items,
|
2899
|
-
-> {
|
3185
|
+
-> {
|
3186
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::UpdateCredit::AccessSchedule::AddScheduleItem]
|
3187
|
+
}
|
2900
3188
|
|
2901
3189
|
# @!attribute remove_schedule_items
|
2902
3190
|
#
|
2903
|
-
# @return [Array<MetronomeSDK::
|
3191
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::UpdateCredit::AccessSchedule::RemoveScheduleItem>, nil]
|
2904
3192
|
optional :remove_schedule_items,
|
2905
|
-
-> {
|
3193
|
+
-> {
|
3194
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::UpdateCredit::AccessSchedule::RemoveScheduleItem]
|
3195
|
+
}
|
2906
3196
|
|
2907
3197
|
# @!attribute update_schedule_items
|
2908
3198
|
#
|
2909
|
-
# @return [Array<MetronomeSDK::
|
3199
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::UpdateCredit::AccessSchedule::UpdateScheduleItem>, nil]
|
2910
3200
|
optional :update_schedule_items,
|
2911
|
-
-> {
|
3201
|
+
-> {
|
3202
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::UpdateCredit::AccessSchedule::UpdateScheduleItem]
|
3203
|
+
}
|
2912
3204
|
|
2913
3205
|
# @!method initialize(add_schedule_items: nil, remove_schedule_items: nil, update_schedule_items: nil)
|
2914
|
-
# @param add_schedule_items [Array<MetronomeSDK::
|
2915
|
-
# @param remove_schedule_items [Array<MetronomeSDK::
|
2916
|
-
# @param update_schedule_items [Array<MetronomeSDK::
|
3206
|
+
# @param add_schedule_items [Array<MetronomeSDK::V2::ContractEditParams::UpdateCredit::AccessSchedule::AddScheduleItem>]
|
3207
|
+
# @param remove_schedule_items [Array<MetronomeSDK::V2::ContractEditParams::UpdateCredit::AccessSchedule::RemoveScheduleItem>]
|
3208
|
+
# @param update_schedule_items [Array<MetronomeSDK::V2::ContractEditParams::UpdateCredit::AccessSchedule::UpdateScheduleItem>]
|
2917
3209
|
|
2918
3210
|
class AddScheduleItem < MetronomeSDK::Internal::Type::BaseModel
|
2919
3211
|
# @!attribute amount
|
@@ -2977,6 +3269,220 @@ module MetronomeSDK
|
|
2977
3269
|
end
|
2978
3270
|
end
|
2979
3271
|
|
3272
|
+
class UpdatePrepaidBalanceThresholdConfiguration < MetronomeSDK::Internal::Type::BaseModel
|
3273
|
+
# @!attribute commit
|
3274
|
+
#
|
3275
|
+
# @return [MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::Commit, nil]
|
3276
|
+
optional :commit,
|
3277
|
+
-> {
|
3278
|
+
MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::Commit
|
3279
|
+
}
|
3280
|
+
|
3281
|
+
# @!attribute is_enabled
|
3282
|
+
# When set to false, the contract will not be evaluated against the
|
3283
|
+
# threshold_amount. Toggling to true will result an immediate evaluation,
|
3284
|
+
# regardless of prior state.
|
3285
|
+
#
|
3286
|
+
# @return [Boolean, nil]
|
3287
|
+
optional :is_enabled, MetronomeSDK::Internal::Type::Boolean
|
3288
|
+
|
3289
|
+
# @!attribute payment_gate_config
|
3290
|
+
#
|
3291
|
+
# @return [MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig, nil]
|
3292
|
+
optional :payment_gate_config,
|
3293
|
+
-> {
|
3294
|
+
MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig
|
3295
|
+
}
|
3296
|
+
|
3297
|
+
# @!attribute recharge_to_amount
|
3298
|
+
# Specify the amount the balance should be recharged to.
|
3299
|
+
#
|
3300
|
+
# @return [Float, nil]
|
3301
|
+
optional :recharge_to_amount, Float
|
3302
|
+
|
3303
|
+
# @!attribute threshold_amount
|
3304
|
+
# Specify the threshold amount for the contract. Each time the contract's balance
|
3305
|
+
# lowers to this amount, a threshold charge will be initiated.
|
3306
|
+
#
|
3307
|
+
# @return [Float, nil]
|
3308
|
+
optional :threshold_amount, Float
|
3309
|
+
|
3310
|
+
# @!method initialize(commit: nil, is_enabled: nil, payment_gate_config: nil, recharge_to_amount: nil, threshold_amount: nil)
|
3311
|
+
# Some parameter documentations has been truncated, see
|
3312
|
+
# {MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration}
|
3313
|
+
# for more details.
|
3314
|
+
#
|
3315
|
+
# @param commit [MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::Commit]
|
3316
|
+
#
|
3317
|
+
# @param is_enabled [Boolean] When set to false, the contract will not be evaluated against the threshold_amou
|
3318
|
+
#
|
3319
|
+
# @param payment_gate_config [MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig]
|
3320
|
+
#
|
3321
|
+
# @param recharge_to_amount [Float] Specify the amount the balance should be recharged to.
|
3322
|
+
#
|
3323
|
+
# @param threshold_amount [Float] Specify the threshold amount for the contract. Each time the contract's balance
|
3324
|
+
|
3325
|
+
# @see MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration#commit
|
3326
|
+
class Commit < MetronomeSDK::Internal::Type::BaseModel
|
3327
|
+
# @!attribute product_id
|
3328
|
+
# The commit product that will be used to generate the line item for commit
|
3329
|
+
# payment.
|
3330
|
+
#
|
3331
|
+
# @return [String]
|
3332
|
+
required :product_id, String
|
3333
|
+
|
3334
|
+
# @!attribute applicable_product_ids
|
3335
|
+
# Which products the threshold commit applies to. If both applicable_product_ids
|
3336
|
+
# and applicable_product_tags are not provided, the commit applies to all
|
3337
|
+
# products.
|
3338
|
+
#
|
3339
|
+
# @return [Array<String>, nil]
|
3340
|
+
optional :applicable_product_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
|
3341
|
+
|
3342
|
+
# @!attribute applicable_product_tags
|
3343
|
+
# Which tags the threshold commit applies to. If both applicable_product_ids and
|
3344
|
+
# applicable_product_tags are not provided, the commit applies to all products.
|
3345
|
+
#
|
3346
|
+
# @return [Array<String>, nil]
|
3347
|
+
optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
|
3348
|
+
|
3349
|
+
# @!attribute description
|
3350
|
+
#
|
3351
|
+
# @return [String, nil]
|
3352
|
+
optional :description, String
|
3353
|
+
|
3354
|
+
# @!attribute name
|
3355
|
+
# Specify the name of the line item for the threshold charge. If left blank, it
|
3356
|
+
# will default to the commit product name.
|
3357
|
+
#
|
3358
|
+
# @return [String, nil]
|
3359
|
+
optional :name, String
|
3360
|
+
|
3361
|
+
# @!method initialize(product_id:, applicable_product_ids: nil, applicable_product_tags: nil, description: nil, name: nil)
|
3362
|
+
# Some parameter documentations has been truncated, see
|
3363
|
+
# {MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::Commit}
|
3364
|
+
# for more details.
|
3365
|
+
#
|
3366
|
+
# @param product_id [String] The commit product that will be used to generate the line item for commit paymen
|
3367
|
+
#
|
3368
|
+
# @param applicable_product_ids [Array<String>] Which products the threshold commit applies to. If both applicable_product_ids a
|
3369
|
+
#
|
3370
|
+
# @param applicable_product_tags [Array<String>] Which tags the threshold commit applies to. If both applicable_product_ids and a
|
3371
|
+
#
|
3372
|
+
# @param description [String]
|
3373
|
+
#
|
3374
|
+
# @param name [String] Specify the name of the line item for the threshold charge. If left blank, it wi
|
3375
|
+
end
|
3376
|
+
|
3377
|
+
# @see MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration#payment_gate_config
|
3378
|
+
class PaymentGateConfig < MetronomeSDK::Internal::Type::BaseModel
|
3379
|
+
# @!attribute payment_gate_type
|
3380
|
+
# Gate access to the commit balance based on successful collection of payment.
|
3381
|
+
# Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
|
3382
|
+
# facilitate payment using your own payment integration. Select NONE if you do not
|
3383
|
+
# wish to payment gate the commit balance.
|
3384
|
+
#
|
3385
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig::PaymentGateType]
|
3386
|
+
required :payment_gate_type,
|
3387
|
+
enum: -> {
|
3388
|
+
MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig::PaymentGateType
|
3389
|
+
}
|
3390
|
+
|
3391
|
+
# @!attribute stripe_config
|
3392
|
+
# Only applicable if using Stripe as your payment gateway through Metronome.
|
3393
|
+
#
|
3394
|
+
# @return [MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig, nil]
|
3395
|
+
optional :stripe_config,
|
3396
|
+
-> {
|
3397
|
+
MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig
|
3398
|
+
}
|
3399
|
+
|
3400
|
+
# @!attribute tax_type
|
3401
|
+
# Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
|
3402
|
+
# not wish Metronome to calculate tax on your behalf. Leaving this field blank
|
3403
|
+
# will default to NONE.
|
3404
|
+
#
|
3405
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig::TaxType, nil]
|
3406
|
+
optional :tax_type,
|
3407
|
+
enum: -> {
|
3408
|
+
MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig::TaxType
|
3409
|
+
}
|
3410
|
+
|
3411
|
+
# @!method initialize(payment_gate_type:, stripe_config: nil, tax_type: nil)
|
3412
|
+
# Some parameter documentations has been truncated, see
|
3413
|
+
# {MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig}
|
3414
|
+
# for more details.
|
3415
|
+
#
|
3416
|
+
# @param payment_gate_type [Symbol, MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig::PaymentGateType] Gate access to the commit balance based on successful collection of payment. Sel
|
3417
|
+
#
|
3418
|
+
# @param stripe_config [MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig] Only applicable if using Stripe as your payment gateway through Metronome.
|
3419
|
+
#
|
3420
|
+
# @param tax_type [Symbol, MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig::TaxType] Stripe tax is only supported for Stripe payment gateway. Select NONE if you do n
|
3421
|
+
|
3422
|
+
# Gate access to the commit balance based on successful collection of payment.
|
3423
|
+
# Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
|
3424
|
+
# facilitate payment using your own payment integration. Select NONE if you do not
|
3425
|
+
# wish to payment gate the commit balance.
|
3426
|
+
#
|
3427
|
+
# @see MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig#payment_gate_type
|
3428
|
+
module PaymentGateType
|
3429
|
+
extend MetronomeSDK::Internal::Type::Enum
|
3430
|
+
|
3431
|
+
NONE = :NONE
|
3432
|
+
STRIPE = :STRIPE
|
3433
|
+
EXTERNAL = :EXTERNAL
|
3434
|
+
|
3435
|
+
# @!method self.values
|
3436
|
+
# @return [Array<Symbol>]
|
3437
|
+
end
|
3438
|
+
|
3439
|
+
# @see MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig#stripe_config
|
3440
|
+
class StripeConfig < MetronomeSDK::Internal::Type::BaseModel
|
3441
|
+
# @!attribute payment_type
|
3442
|
+
# If left blank, will default to INVOICE
|
3443
|
+
#
|
3444
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType]
|
3445
|
+
required :payment_type,
|
3446
|
+
enum: -> {
|
3447
|
+
MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType
|
3448
|
+
}
|
3449
|
+
|
3450
|
+
# @!method initialize(payment_type:)
|
3451
|
+
# Only applicable if using Stripe as your payment gateway through Metronome.
|
3452
|
+
#
|
3453
|
+
# @param payment_type [Symbol, MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType] If left blank, will default to INVOICE
|
3454
|
+
|
3455
|
+
# If left blank, will default to INVOICE
|
3456
|
+
#
|
3457
|
+
# @see MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig#payment_type
|
3458
|
+
module PaymentType
|
3459
|
+
extend MetronomeSDK::Internal::Type::Enum
|
3460
|
+
|
3461
|
+
INVOICE = :INVOICE
|
3462
|
+
PAYMENT_INTENT = :PAYMENT_INTENT
|
3463
|
+
|
3464
|
+
# @!method self.values
|
3465
|
+
# @return [Array<Symbol>]
|
3466
|
+
end
|
3467
|
+
end
|
3468
|
+
|
3469
|
+
# Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
|
3470
|
+
# not wish Metronome to calculate tax on your behalf. Leaving this field blank
|
3471
|
+
# will default to NONE.
|
3472
|
+
#
|
3473
|
+
# @see MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig#tax_type
|
3474
|
+
module TaxType
|
3475
|
+
extend MetronomeSDK::Internal::Type::Enum
|
3476
|
+
|
3477
|
+
NONE = :NONE
|
3478
|
+
STRIPE = :STRIPE
|
3479
|
+
|
3480
|
+
# @!method self.values
|
3481
|
+
# @return [Array<Symbol>]
|
3482
|
+
end
|
3483
|
+
end
|
3484
|
+
end
|
3485
|
+
|
2980
3486
|
class UpdateScheduledCharge < MetronomeSDK::Internal::Type::BaseModel
|
2981
3487
|
# @!attribute scheduled_charge_id
|
2982
3488
|
#
|
@@ -2985,9 +3491,9 @@ module MetronomeSDK
|
|
2985
3491
|
|
2986
3492
|
# @!attribute invoice_schedule
|
2987
3493
|
#
|
2988
|
-
# @return [MetronomeSDK::
|
3494
|
+
# @return [MetronomeSDK::V2::ContractEditParams::UpdateScheduledCharge::InvoiceSchedule, nil]
|
2989
3495
|
optional :invoice_schedule,
|
2990
|
-
-> { MetronomeSDK::
|
3496
|
+
-> { MetronomeSDK::V2::ContractEditParams::UpdateScheduledCharge::InvoiceSchedule }
|
2991
3497
|
|
2992
3498
|
# @!attribute netsuite_sales_order_id
|
2993
3499
|
#
|
@@ -2996,33 +3502,39 @@ module MetronomeSDK
|
|
2996
3502
|
|
2997
3503
|
# @!method initialize(scheduled_charge_id:, invoice_schedule: nil, netsuite_sales_order_id: nil)
|
2998
3504
|
# @param scheduled_charge_id [String]
|
2999
|
-
# @param invoice_schedule [MetronomeSDK::
|
3505
|
+
# @param invoice_schedule [MetronomeSDK::V2::ContractEditParams::UpdateScheduledCharge::InvoiceSchedule]
|
3000
3506
|
# @param netsuite_sales_order_id [String, nil]
|
3001
3507
|
|
3002
|
-
# @see MetronomeSDK::
|
3508
|
+
# @see MetronomeSDK::V2::ContractEditParams::UpdateScheduledCharge#invoice_schedule
|
3003
3509
|
class InvoiceSchedule < MetronomeSDK::Internal::Type::BaseModel
|
3004
3510
|
# @!attribute add_schedule_items
|
3005
3511
|
#
|
3006
|
-
# @return [Array<MetronomeSDK::
|
3512
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::UpdateScheduledCharge::InvoiceSchedule::AddScheduleItem>, nil]
|
3007
3513
|
optional :add_schedule_items,
|
3008
|
-
-> {
|
3514
|
+
-> {
|
3515
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::UpdateScheduledCharge::InvoiceSchedule::AddScheduleItem]
|
3516
|
+
}
|
3009
3517
|
|
3010
3518
|
# @!attribute remove_schedule_items
|
3011
3519
|
#
|
3012
|
-
# @return [Array<MetronomeSDK::
|
3520
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::UpdateScheduledCharge::InvoiceSchedule::RemoveScheduleItem>, nil]
|
3013
3521
|
optional :remove_schedule_items,
|
3014
|
-
-> {
|
3522
|
+
-> {
|
3523
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::UpdateScheduledCharge::InvoiceSchedule::RemoveScheduleItem]
|
3524
|
+
}
|
3015
3525
|
|
3016
3526
|
# @!attribute update_schedule_items
|
3017
3527
|
#
|
3018
|
-
# @return [Array<MetronomeSDK::
|
3528
|
+
# @return [Array<MetronomeSDK::V2::ContractEditParams::UpdateScheduledCharge::InvoiceSchedule::UpdateScheduleItem>, nil]
|
3019
3529
|
optional :update_schedule_items,
|
3020
|
-
-> {
|
3530
|
+
-> {
|
3531
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::UpdateScheduledCharge::InvoiceSchedule::UpdateScheduleItem]
|
3532
|
+
}
|
3021
3533
|
|
3022
3534
|
# @!method initialize(add_schedule_items: nil, remove_schedule_items: nil, update_schedule_items: nil)
|
3023
|
-
# @param add_schedule_items [Array<MetronomeSDK::
|
3024
|
-
# @param remove_schedule_items [Array<MetronomeSDK::
|
3025
|
-
# @param update_schedule_items [Array<MetronomeSDK::
|
3535
|
+
# @param add_schedule_items [Array<MetronomeSDK::V2::ContractEditParams::UpdateScheduledCharge::InvoiceSchedule::AddScheduleItem>]
|
3536
|
+
# @param remove_schedule_items [Array<MetronomeSDK::V2::ContractEditParams::UpdateScheduledCharge::InvoiceSchedule::RemoveScheduleItem>]
|
3537
|
+
# @param update_schedule_items [Array<MetronomeSDK::V2::ContractEditParams::UpdateScheduledCharge::InvoiceSchedule::UpdateScheduleItem>]
|
3026
3538
|
|
3027
3539
|
class AddScheduleItem < MetronomeSDK::Internal::Type::BaseModel
|
3028
3540
|
# @!attribute timestamp
|
@@ -3101,9 +3613,11 @@ module MetronomeSDK
|
|
3101
3613
|
class UpdateSpendThresholdConfiguration < MetronomeSDK::Internal::Type::BaseModel
|
3102
3614
|
# @!attribute commit
|
3103
3615
|
#
|
3104
|
-
# @return [MetronomeSDK::
|
3616
|
+
# @return [MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration::Commit, nil]
|
3105
3617
|
optional :commit,
|
3106
|
-
-> {
|
3618
|
+
-> {
|
3619
|
+
MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration::Commit
|
3620
|
+
}
|
3107
3621
|
|
3108
3622
|
# @!attribute is_enabled
|
3109
3623
|
# When set to false, the contract will not be evaluated against the
|
@@ -3115,9 +3629,11 @@ module MetronomeSDK
|
|
3115
3629
|
|
3116
3630
|
# @!attribute payment_gate_config
|
3117
3631
|
#
|
3118
|
-
# @return [MetronomeSDK::
|
3632
|
+
# @return [MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration::PaymentGateConfig, nil]
|
3119
3633
|
optional :payment_gate_config,
|
3120
|
-
-> {
|
3634
|
+
-> {
|
3635
|
+
MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration::PaymentGateConfig
|
3636
|
+
}
|
3121
3637
|
|
3122
3638
|
# @!attribute threshold_amount
|
3123
3639
|
# Specify the threshold amount for the contract. Each time the contract's usage
|
@@ -3128,20 +3644,18 @@ module MetronomeSDK
|
|
3128
3644
|
|
3129
3645
|
# @!method initialize(commit: nil, is_enabled: nil, payment_gate_config: nil, threshold_amount: nil)
|
3130
3646
|
# Some parameter documentations has been truncated, see
|
3131
|
-
# {MetronomeSDK::
|
3132
|
-
#
|
3647
|
+
# {MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration} for
|
3648
|
+
# more details.
|
3133
3649
|
#
|
3134
|
-
# @param commit [MetronomeSDK::
|
3650
|
+
# @param commit [MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration::Commit]
|
3135
3651
|
#
|
3136
3652
|
# @param is_enabled [Boolean] When set to false, the contract will not be evaluated against the threshold_amou
|
3137
|
-
# ...
|
3138
3653
|
#
|
3139
|
-
# @param payment_gate_config [MetronomeSDK::
|
3654
|
+
# @param payment_gate_config [MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration::PaymentGateConfig]
|
3140
3655
|
#
|
3141
3656
|
# @param threshold_amount [Float] Specify the threshold amount for the contract. Each time the contract's usage hi
|
3142
|
-
# ...
|
3143
3657
|
|
3144
|
-
# @see MetronomeSDK::
|
3658
|
+
# @see MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration#commit
|
3145
3659
|
class Commit < MetronomeSDK::Internal::Type::BaseModel
|
3146
3660
|
# @!attribute description
|
3147
3661
|
#
|
@@ -3162,18 +3676,17 @@ module MetronomeSDK
|
|
3162
3676
|
|
3163
3677
|
# @!method initialize(description: nil, name: nil, product_id: nil)
|
3164
3678
|
# Some parameter documentations has been truncated, see
|
3165
|
-
# {MetronomeSDK::
|
3679
|
+
# {MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration::Commit}
|
3166
3680
|
# for more details.
|
3167
3681
|
#
|
3168
3682
|
# @param description [String, nil]
|
3169
3683
|
#
|
3170
3684
|
# @param name [String, nil] Specify the name of the line item for the threshold charge. If left blank, it wi
|
3171
|
-
# ...
|
3172
3685
|
#
|
3173
3686
|
# @param product_id [String]
|
3174
3687
|
end
|
3175
3688
|
|
3176
|
-
# @see MetronomeSDK::
|
3689
|
+
# @see MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration#payment_gate_config
|
3177
3690
|
class PaymentGateConfig < MetronomeSDK::Internal::Type::BaseModel
|
3178
3691
|
# @!attribute payment_gate_type
|
3179
3692
|
# Gate access to the commit balance based on successful collection of payment.
|
@@ -3181,45 +3694,49 @@ module MetronomeSDK
|
|
3181
3694
|
# facilitate payment using your own payment integration. Select NONE if you do not
|
3182
3695
|
# wish to payment gate the commit balance.
|
3183
3696
|
#
|
3184
|
-
# @return [Symbol, MetronomeSDK::
|
3697
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration::PaymentGateConfig::PaymentGateType]
|
3185
3698
|
required :payment_gate_type,
|
3186
|
-
enum: -> {
|
3699
|
+
enum: -> {
|
3700
|
+
MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration::PaymentGateConfig::PaymentGateType
|
3701
|
+
}
|
3187
3702
|
|
3188
3703
|
# @!attribute stripe_config
|
3189
3704
|
# Only applicable if using Stripe as your payment gateway through Metronome.
|
3190
3705
|
#
|
3191
|
-
# @return [MetronomeSDK::
|
3706
|
+
# @return [MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration::PaymentGateConfig::StripeConfig, nil]
|
3192
3707
|
optional :stripe_config,
|
3193
|
-
-> {
|
3708
|
+
-> {
|
3709
|
+
MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration::PaymentGateConfig::StripeConfig
|
3710
|
+
}
|
3194
3711
|
|
3195
3712
|
# @!attribute tax_type
|
3196
3713
|
# Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
|
3197
3714
|
# not wish Metronome to calculate tax on your behalf. Leaving this field blank
|
3198
3715
|
# will default to NONE.
|
3199
3716
|
#
|
3200
|
-
# @return [Symbol, MetronomeSDK::
|
3717
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration::PaymentGateConfig::TaxType, nil]
|
3201
3718
|
optional :tax_type,
|
3202
|
-
enum: -> {
|
3719
|
+
enum: -> {
|
3720
|
+
MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration::PaymentGateConfig::TaxType
|
3721
|
+
}
|
3203
3722
|
|
3204
3723
|
# @!method initialize(payment_gate_type:, stripe_config: nil, tax_type: nil)
|
3205
3724
|
# Some parameter documentations has been truncated, see
|
3206
|
-
# {MetronomeSDK::
|
3725
|
+
# {MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration::PaymentGateConfig}
|
3207
3726
|
# for more details.
|
3208
3727
|
#
|
3209
|
-
# @param payment_gate_type [Symbol, MetronomeSDK::
|
3210
|
-
# ...
|
3728
|
+
# @param payment_gate_type [Symbol, MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration::PaymentGateConfig::PaymentGateType] Gate access to the commit balance based on successful collection of payment. Sel
|
3211
3729
|
#
|
3212
|
-
# @param stripe_config [MetronomeSDK::
|
3730
|
+
# @param stripe_config [MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration::PaymentGateConfig::StripeConfig] Only applicable if using Stripe as your payment gateway through Metronome.
|
3213
3731
|
#
|
3214
|
-
# @param tax_type [Symbol, MetronomeSDK::
|
3215
|
-
# ...
|
3732
|
+
# @param tax_type [Symbol, MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration::PaymentGateConfig::TaxType] Stripe tax is only supported for Stripe payment gateway. Select NONE if you do n
|
3216
3733
|
|
3217
3734
|
# Gate access to the commit balance based on successful collection of payment.
|
3218
3735
|
# Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
|
3219
3736
|
# facilitate payment using your own payment integration. Select NONE if you do not
|
3220
3737
|
# wish to payment gate the commit balance.
|
3221
3738
|
#
|
3222
|
-
# @see MetronomeSDK::
|
3739
|
+
# @see MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration::PaymentGateConfig#payment_gate_type
|
3223
3740
|
module PaymentGateType
|
3224
3741
|
extend MetronomeSDK::Internal::Type::Enum
|
3225
3742
|
|
@@ -3231,23 +3748,25 @@ module MetronomeSDK
|
|
3231
3748
|
# @return [Array<Symbol>]
|
3232
3749
|
end
|
3233
3750
|
|
3234
|
-
# @see MetronomeSDK::
|
3751
|
+
# @see MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration::PaymentGateConfig#stripe_config
|
3235
3752
|
class StripeConfig < MetronomeSDK::Internal::Type::BaseModel
|
3236
3753
|
# @!attribute payment_type
|
3237
3754
|
# If left blank, will default to INVOICE
|
3238
3755
|
#
|
3239
|
-
# @return [Symbol, MetronomeSDK::
|
3756
|
+
# @return [Symbol, MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType]
|
3240
3757
|
required :payment_type,
|
3241
|
-
enum: -> {
|
3758
|
+
enum: -> {
|
3759
|
+
MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType
|
3760
|
+
}
|
3242
3761
|
|
3243
3762
|
# @!method initialize(payment_type:)
|
3244
3763
|
# Only applicable if using Stripe as your payment gateway through Metronome.
|
3245
3764
|
#
|
3246
|
-
# @param payment_type [Symbol, MetronomeSDK::
|
3765
|
+
# @param payment_type [Symbol, MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType] If left blank, will default to INVOICE
|
3247
3766
|
|
3248
3767
|
# If left blank, will default to INVOICE
|
3249
3768
|
#
|
3250
|
-
# @see MetronomeSDK::
|
3769
|
+
# @see MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration::PaymentGateConfig::StripeConfig#payment_type
|
3251
3770
|
module PaymentType
|
3252
3771
|
extend MetronomeSDK::Internal::Type::Enum
|
3253
3772
|
|
@@ -3263,7 +3782,7 @@ module MetronomeSDK
|
|
3263
3782
|
# not wish Metronome to calculate tax on your behalf. Leaving this field blank
|
3264
3783
|
# will default to NONE.
|
3265
3784
|
#
|
3266
|
-
# @see MetronomeSDK::
|
3785
|
+
# @see MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration::PaymentGateConfig#tax_type
|
3267
3786
|
module TaxType
|
3268
3787
|
extend MetronomeSDK::Internal::Type::Enum
|
3269
3788
|
|