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,27 +22,21 @@ module MetronomeSDK
|
|
22
22
|
# @!attribute billing_provider_configuration
|
23
23
|
# The billing provider configuration associated with a contract.
|
24
24
|
#
|
25
|
-
# @return [MetronomeSDK::
|
25
|
+
# @return [MetronomeSDK::V1::ContractCreateParams::BillingProviderConfiguration, nil]
|
26
26
|
optional :billing_provider_configuration,
|
27
|
-
-> { MetronomeSDK::
|
27
|
+
-> { MetronomeSDK::V1::ContractCreateParams::BillingProviderConfiguration }
|
28
28
|
|
29
29
|
# @!attribute commits
|
30
30
|
#
|
31
|
-
# @return [Array<MetronomeSDK::
|
31
|
+
# @return [Array<MetronomeSDK::V1::ContractCreateParams::Commit>, nil]
|
32
32
|
optional :commits,
|
33
|
-
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::
|
34
|
-
|
35
|
-
# @!attribute credit_balance_threshold_configuration
|
36
|
-
#
|
37
|
-
# @return [MetronomeSDK::Models::V1::ContractCreateParams::CreditBalanceThresholdConfiguration, nil]
|
38
|
-
optional :credit_balance_threshold_configuration,
|
39
|
-
-> { MetronomeSDK::Models::V1::ContractCreateParams::CreditBalanceThresholdConfiguration }
|
33
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractCreateParams::Commit] }
|
40
34
|
|
41
35
|
# @!attribute credits
|
42
36
|
#
|
43
|
-
# @return [Array<MetronomeSDK::
|
37
|
+
# @return [Array<MetronomeSDK::V1::ContractCreateParams::Credit>, nil]
|
44
38
|
optional :credits,
|
45
|
-
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::
|
39
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractCreateParams::Credit] }
|
46
40
|
|
47
41
|
# @!attribute custom_fields
|
48
42
|
#
|
@@ -52,9 +46,11 @@ module MetronomeSDK
|
|
52
46
|
# @!attribute discounts
|
53
47
|
# This field's availability is dependent on your client's configuration.
|
54
48
|
#
|
55
|
-
# @return [Array<MetronomeSDK::
|
49
|
+
# @return [Array<MetronomeSDK::V1::ContractCreateParams::Discount>, nil]
|
56
50
|
optional :discounts,
|
57
|
-
-> {
|
51
|
+
-> {
|
52
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractCreateParams::Discount]
|
53
|
+
}
|
58
54
|
|
59
55
|
# @!attribute ending_before
|
60
56
|
# exclusive contract end time
|
@@ -68,9 +64,9 @@ module MetronomeSDK
|
|
68
64
|
# each multiplier; the one with the lowest priority value will be prioritized
|
69
65
|
# first. If tiered overrides are used, prioritization must be explicit.
|
70
66
|
#
|
71
|
-
# @return [Symbol, MetronomeSDK::
|
67
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::MultiplierOverridePrioritization, nil]
|
72
68
|
optional :multiplier_override_prioritization,
|
73
|
-
enum: -> { MetronomeSDK::
|
69
|
+
enum: -> { MetronomeSDK::V1::ContractCreateParams::MultiplierOverridePrioritization }
|
74
70
|
|
75
71
|
# @!attribute name
|
76
72
|
#
|
@@ -90,16 +86,26 @@ module MetronomeSDK
|
|
90
86
|
|
91
87
|
# @!attribute overrides
|
92
88
|
#
|
93
|
-
# @return [Array<MetronomeSDK::
|
89
|
+
# @return [Array<MetronomeSDK::V1::ContractCreateParams::Override>, nil]
|
94
90
|
optional :overrides,
|
95
|
-
-> {
|
91
|
+
-> {
|
92
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractCreateParams::Override]
|
93
|
+
}
|
94
|
+
|
95
|
+
# @!attribute prepaid_balance_threshold_configuration
|
96
|
+
#
|
97
|
+
# @return [MetronomeSDK::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration, nil]
|
98
|
+
optional :prepaid_balance_threshold_configuration,
|
99
|
+
-> { MetronomeSDK::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration }
|
96
100
|
|
97
101
|
# @!attribute professional_services
|
98
102
|
# This field's availability is dependent on your client's configuration.
|
99
103
|
#
|
100
|
-
# @return [Array<MetronomeSDK::
|
104
|
+
# @return [Array<MetronomeSDK::V1::ContractCreateParams::ProfessionalService>, nil]
|
101
105
|
optional :professional_services,
|
102
|
-
-> {
|
106
|
+
-> {
|
107
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractCreateParams::ProfessionalService]
|
108
|
+
}
|
103
109
|
|
104
110
|
# @!attribute rate_card_alias
|
105
111
|
# Selects the rate card linked to the specified alias as of the contract's start
|
@@ -115,22 +121,28 @@ module MetronomeSDK
|
|
115
121
|
|
116
122
|
# @!attribute recurring_commits
|
117
123
|
#
|
118
|
-
# @return [Array<MetronomeSDK::
|
124
|
+
# @return [Array<MetronomeSDK::V1::ContractCreateParams::RecurringCommit>, nil]
|
119
125
|
optional :recurring_commits,
|
120
|
-
-> {
|
126
|
+
-> {
|
127
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractCreateParams::RecurringCommit]
|
128
|
+
}
|
121
129
|
|
122
130
|
# @!attribute recurring_credits
|
123
131
|
#
|
124
|
-
# @return [Array<MetronomeSDK::
|
132
|
+
# @return [Array<MetronomeSDK::V1::ContractCreateParams::RecurringCredit>, nil]
|
125
133
|
optional :recurring_credits,
|
126
|
-
-> {
|
134
|
+
-> {
|
135
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractCreateParams::RecurringCredit]
|
136
|
+
}
|
127
137
|
|
128
138
|
# @!attribute reseller_royalties
|
129
139
|
# This field's availability is dependent on your client's configuration.
|
130
140
|
#
|
131
|
-
# @return [Array<MetronomeSDK::
|
141
|
+
# @return [Array<MetronomeSDK::V1::ContractCreateParams::ResellerRoyalty>, nil]
|
132
142
|
optional :reseller_royalties,
|
133
|
-
-> {
|
143
|
+
-> {
|
144
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractCreateParams::ResellerRoyalty]
|
145
|
+
}
|
134
146
|
|
135
147
|
# @!attribute salesforce_opportunity_id
|
136
148
|
# This field's availability is dependent on your client's configuration.
|
@@ -140,9 +152,11 @@ module MetronomeSDK
|
|
140
152
|
|
141
153
|
# @!attribute scheduled_charges
|
142
154
|
#
|
143
|
-
# @return [Array<MetronomeSDK::
|
155
|
+
# @return [Array<MetronomeSDK::V1::ContractCreateParams::ScheduledCharge>, nil]
|
144
156
|
optional :scheduled_charges,
|
145
|
-
-> {
|
157
|
+
-> {
|
158
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractCreateParams::ScheduledCharge]
|
159
|
+
}
|
146
160
|
|
147
161
|
# @!attribute scheduled_charges_on_usage_invoices
|
148
162
|
# Determines which scheduled and commit charges to consolidate onto the Contract's
|
@@ -151,15 +165,15 @@ module MetronomeSDK
|
|
151
165
|
# after a Contract has been created. If this field is omitted, charges will appear
|
152
166
|
# on a separate invoice from usage charges.
|
153
167
|
#
|
154
|
-
# @return [Symbol, MetronomeSDK::
|
168
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::ScheduledChargesOnUsageInvoices, nil]
|
155
169
|
optional :scheduled_charges_on_usage_invoices,
|
156
|
-
enum: -> { MetronomeSDK::
|
170
|
+
enum: -> { MetronomeSDK::V1::ContractCreateParams::ScheduledChargesOnUsageInvoices }
|
157
171
|
|
158
172
|
# @!attribute spend_threshold_configuration
|
159
173
|
#
|
160
|
-
# @return [MetronomeSDK::
|
174
|
+
# @return [MetronomeSDK::V1::ContractCreateParams::SpendThresholdConfiguration, nil]
|
161
175
|
optional :spend_threshold_configuration,
|
162
|
-
-> { MetronomeSDK::
|
176
|
+
-> { MetronomeSDK::V1::ContractCreateParams::SpendThresholdConfiguration }
|
163
177
|
|
164
178
|
# @!attribute total_contract_value
|
165
179
|
# This field's availability is dependent on your client's configuration.
|
@@ -169,8 +183,8 @@ module MetronomeSDK
|
|
169
183
|
|
170
184
|
# @!attribute transition
|
171
185
|
#
|
172
|
-
# @return [MetronomeSDK::
|
173
|
-
optional :transition, -> { MetronomeSDK::
|
186
|
+
# @return [MetronomeSDK::V1::ContractCreateParams::Transition, nil]
|
187
|
+
optional :transition, -> { MetronomeSDK::V1::ContractCreateParams::Transition }
|
174
188
|
|
175
189
|
# @!attribute uniqueness_key
|
176
190
|
# Prevents the creation of duplicates. If a request to create a record is made
|
@@ -182,16 +196,18 @@ module MetronomeSDK
|
|
182
196
|
|
183
197
|
# @!attribute usage_filter
|
184
198
|
#
|
185
|
-
# @return [MetronomeSDK::
|
186
|
-
optional :usage_filter, -> { MetronomeSDK::
|
199
|
+
# @return [MetronomeSDK::BaseUsageFilter, nil]
|
200
|
+
optional :usage_filter, -> { MetronomeSDK::BaseUsageFilter }
|
187
201
|
|
188
202
|
# @!attribute usage_statement_schedule
|
189
203
|
#
|
190
|
-
# @return [MetronomeSDK::
|
204
|
+
# @return [MetronomeSDK::V1::ContractCreateParams::UsageStatementSchedule, nil]
|
191
205
|
optional :usage_statement_schedule,
|
192
|
-
-> {
|
206
|
+
-> {
|
207
|
+
MetronomeSDK::V1::ContractCreateParams::UsageStatementSchedule
|
208
|
+
}
|
193
209
|
|
194
|
-
# @!method initialize(customer_id:, starting_at:, billing_provider_configuration: nil, commits: nil,
|
210
|
+
# @!method initialize(customer_id:, starting_at:, billing_provider_configuration: nil, commits: nil, credits: nil, custom_fields: nil, discounts: nil, ending_before: nil, multiplier_override_prioritization: nil, name: nil, net_payment_terms_days: nil, netsuite_sales_order_id: nil, overrides: nil, prepaid_balance_threshold_configuration: nil, professional_services: nil, rate_card_alias: nil, rate_card_id: nil, recurring_commits: nil, recurring_credits: nil, reseller_royalties: nil, salesforce_opportunity_id: nil, scheduled_charges: nil, scheduled_charges_on_usage_invoices: nil, spend_threshold_configuration: nil, total_contract_value: nil, transition: nil, uniqueness_key: nil, usage_filter: nil, usage_statement_schedule: nil, request_options: {})
|
195
211
|
# Some parameter documentations has been truncated, see
|
196
212
|
# {MetronomeSDK::Models::V1::ContractCreateParams} for more details.
|
197
213
|
#
|
@@ -199,22 +215,19 @@ module MetronomeSDK
|
|
199
215
|
#
|
200
216
|
# @param starting_at [Time] inclusive contract start time
|
201
217
|
#
|
202
|
-
# @param billing_provider_configuration [MetronomeSDK::
|
203
|
-
#
|
204
|
-
# @param commits [Array<MetronomeSDK::Models::V1::ContractCreateParams::Commit>]
|
218
|
+
# @param billing_provider_configuration [MetronomeSDK::V1::ContractCreateParams::BillingProviderConfiguration] The billing provider configuration associated with a contract.
|
205
219
|
#
|
206
|
-
# @param
|
220
|
+
# @param commits [Array<MetronomeSDK::V1::ContractCreateParams::Commit>]
|
207
221
|
#
|
208
|
-
# @param credits [Array<MetronomeSDK::
|
222
|
+
# @param credits [Array<MetronomeSDK::V1::ContractCreateParams::Credit>]
|
209
223
|
#
|
210
224
|
# @param custom_fields [Hash{Symbol=>String}]
|
211
225
|
#
|
212
|
-
# @param discounts [Array<MetronomeSDK::
|
226
|
+
# @param discounts [Array<MetronomeSDK::V1::ContractCreateParams::Discount>] This field's availability is dependent on your client's configuration.
|
213
227
|
#
|
214
228
|
# @param ending_before [Time] exclusive contract end time
|
215
229
|
#
|
216
|
-
# @param multiplier_override_prioritization [Symbol, MetronomeSDK::
|
217
|
-
# ...
|
230
|
+
# @param multiplier_override_prioritization [Symbol, MetronomeSDK::V1::ContractCreateParams::MultiplierOverridePrioritization] Defaults to LOWEST_MULTIPLIER, which applies the greatest discount to list price
|
218
231
|
#
|
219
232
|
# @param name [String]
|
220
233
|
#
|
@@ -222,49 +235,50 @@ module MetronomeSDK
|
|
222
235
|
#
|
223
236
|
# @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
|
224
237
|
#
|
225
|
-
# @param overrides [Array<MetronomeSDK::
|
238
|
+
# @param overrides [Array<MetronomeSDK::V1::ContractCreateParams::Override>]
|
239
|
+
#
|
240
|
+
# @param prepaid_balance_threshold_configuration [MetronomeSDK::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration]
|
226
241
|
#
|
227
|
-
# @param professional_services [Array<MetronomeSDK::
|
242
|
+
# @param professional_services [Array<MetronomeSDK::V1::ContractCreateParams::ProfessionalService>] This field's availability is dependent on your client's configuration.
|
228
243
|
#
|
229
244
|
# @param rate_card_alias [String] Selects the rate card linked to the specified alias as of the contract's start d
|
230
|
-
# ...
|
231
245
|
#
|
232
246
|
# @param rate_card_id [String]
|
233
247
|
#
|
234
|
-
# @param recurring_commits [Array<MetronomeSDK::
|
248
|
+
# @param recurring_commits [Array<MetronomeSDK::V1::ContractCreateParams::RecurringCommit>]
|
235
249
|
#
|
236
|
-
# @param recurring_credits [Array<MetronomeSDK::
|
250
|
+
# @param recurring_credits [Array<MetronomeSDK::V1::ContractCreateParams::RecurringCredit>]
|
237
251
|
#
|
238
|
-
# @param reseller_royalties [Array<MetronomeSDK::
|
252
|
+
# @param reseller_royalties [Array<MetronomeSDK::V1::ContractCreateParams::ResellerRoyalty>] This field's availability is dependent on your client's configuration.
|
239
253
|
#
|
240
254
|
# @param salesforce_opportunity_id [String] This field's availability is dependent on your client's configuration.
|
241
255
|
#
|
242
|
-
# @param scheduled_charges [Array<MetronomeSDK::
|
256
|
+
# @param scheduled_charges [Array<MetronomeSDK::V1::ContractCreateParams::ScheduledCharge>]
|
243
257
|
#
|
244
|
-
# @param scheduled_charges_on_usage_invoices [Symbol, MetronomeSDK::
|
245
|
-
# ...
|
258
|
+
# @param scheduled_charges_on_usage_invoices [Symbol, MetronomeSDK::V1::ContractCreateParams::ScheduledChargesOnUsageInvoices] Determines which scheduled and commit charges to consolidate onto the Contract's
|
246
259
|
#
|
247
|
-
# @param spend_threshold_configuration [MetronomeSDK::
|
260
|
+
# @param spend_threshold_configuration [MetronomeSDK::V1::ContractCreateParams::SpendThresholdConfiguration]
|
248
261
|
#
|
249
262
|
# @param total_contract_value [Float] This field's availability is dependent on your client's configuration.
|
250
263
|
#
|
251
|
-
# @param transition [MetronomeSDK::
|
264
|
+
# @param transition [MetronomeSDK::V1::ContractCreateParams::Transition]
|
252
265
|
#
|
253
266
|
# @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a record is made wit
|
254
|
-
# ...
|
255
267
|
#
|
256
|
-
# @param usage_filter [MetronomeSDK::
|
268
|
+
# @param usage_filter [MetronomeSDK::BaseUsageFilter]
|
257
269
|
#
|
258
|
-
# @param usage_statement_schedule [MetronomeSDK::
|
270
|
+
# @param usage_statement_schedule [MetronomeSDK::V1::ContractCreateParams::UsageStatementSchedule]
|
259
271
|
#
|
260
272
|
# @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
|
261
273
|
|
262
274
|
class BillingProviderConfiguration < MetronomeSDK::Internal::Type::BaseModel
|
263
275
|
# @!attribute billing_provider
|
264
276
|
#
|
265
|
-
# @return [Symbol, MetronomeSDK::
|
277
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::BillingProviderConfiguration::BillingProvider, nil]
|
266
278
|
optional :billing_provider,
|
267
|
-
enum: -> {
|
279
|
+
enum: -> {
|
280
|
+
MetronomeSDK::V1::ContractCreateParams::BillingProviderConfiguration::BillingProvider
|
281
|
+
}
|
268
282
|
|
269
283
|
# @!attribute billing_provider_configuration_id
|
270
284
|
# The Metronome ID of the billing provider configuration
|
@@ -274,20 +288,22 @@ module MetronomeSDK
|
|
274
288
|
|
275
289
|
# @!attribute delivery_method
|
276
290
|
#
|
277
|
-
# @return [Symbol, MetronomeSDK::
|
291
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::BillingProviderConfiguration::DeliveryMethod, nil]
|
278
292
|
optional :delivery_method,
|
279
|
-
enum: -> {
|
293
|
+
enum: -> {
|
294
|
+
MetronomeSDK::V1::ContractCreateParams::BillingProviderConfiguration::DeliveryMethod
|
295
|
+
}
|
280
296
|
|
281
297
|
# @!method initialize(billing_provider: nil, billing_provider_configuration_id: nil, delivery_method: nil)
|
282
298
|
# The billing provider configuration associated with a contract.
|
283
299
|
#
|
284
|
-
# @param billing_provider [Symbol, MetronomeSDK::
|
300
|
+
# @param billing_provider [Symbol, MetronomeSDK::V1::ContractCreateParams::BillingProviderConfiguration::BillingProvider]
|
285
301
|
#
|
286
302
|
# @param billing_provider_configuration_id [String] The Metronome ID of the billing provider configuration
|
287
303
|
#
|
288
|
-
# @param delivery_method [Symbol, MetronomeSDK::
|
304
|
+
# @param delivery_method [Symbol, MetronomeSDK::V1::ContractCreateParams::BillingProviderConfiguration::DeliveryMethod]
|
289
305
|
|
290
|
-
# @see MetronomeSDK::
|
306
|
+
# @see MetronomeSDK::V1::ContractCreateParams::BillingProviderConfiguration#billing_provider
|
291
307
|
module BillingProvider
|
292
308
|
extend MetronomeSDK::Internal::Type::Enum
|
293
309
|
|
@@ -301,7 +317,7 @@ module MetronomeSDK
|
|
301
317
|
# @return [Array<Symbol>]
|
302
318
|
end
|
303
319
|
|
304
|
-
# @see MetronomeSDK::
|
320
|
+
# @see MetronomeSDK::V1::ContractCreateParams::BillingProviderConfiguration#delivery_method
|
305
321
|
module DeliveryMethod
|
306
322
|
extend MetronomeSDK::Internal::Type::Enum
|
307
323
|
|
@@ -323,16 +339,16 @@ module MetronomeSDK
|
|
323
339
|
|
324
340
|
# @!attribute type
|
325
341
|
#
|
326
|
-
# @return [Symbol, MetronomeSDK::
|
327
|
-
required :type, enum: -> { MetronomeSDK::
|
342
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::Commit::Type]
|
343
|
+
required :type, enum: -> { MetronomeSDK::V1::ContractCreateParams::Commit::Type }
|
328
344
|
|
329
345
|
# @!attribute access_schedule
|
330
346
|
# Required: Schedule for distributing the commit to the customer. For "POSTPAID"
|
331
347
|
# commits only one schedule item is allowed and amount must match invoice_schedule
|
332
348
|
# total.
|
333
349
|
#
|
334
|
-
# @return [MetronomeSDK::
|
335
|
-
optional :access_schedule, -> { MetronomeSDK::
|
350
|
+
# @return [MetronomeSDK::V1::ContractCreateParams::Commit::AccessSchedule, nil]
|
351
|
+
optional :access_schedule, -> { MetronomeSDK::V1::ContractCreateParams::Commit::AccessSchedule }
|
336
352
|
|
337
353
|
# @!attribute amount
|
338
354
|
# (DEPRECATED) Use access_schedule and invoice_schedule instead.
|
@@ -371,8 +387,8 @@ module MetronomeSDK
|
|
371
387
|
# amount. Optional for "PREPAID" commits: if not provided, this will be a
|
372
388
|
# "complimentary" commit with no invoice.
|
373
389
|
#
|
374
|
-
# @return [MetronomeSDK::
|
375
|
-
optional :invoice_schedule, -> { MetronomeSDK::
|
390
|
+
# @return [MetronomeSDK::V1::ContractCreateParams::Commit::InvoiceSchedule, nil]
|
391
|
+
optional :invoice_schedule, -> { MetronomeSDK::V1::ContractCreateParams::Commit::InvoiceSchedule }
|
376
392
|
|
377
393
|
# @!attribute name
|
378
394
|
# displayed on invoices
|
@@ -389,9 +405,11 @@ module MetronomeSDK
|
|
389
405
|
# @!attribute payment_gate_config
|
390
406
|
# optionally payment gate this commit
|
391
407
|
#
|
392
|
-
# @return [MetronomeSDK::
|
408
|
+
# @return [MetronomeSDK::V1::ContractCreateParams::Commit::PaymentGateConfig, nil]
|
393
409
|
optional :payment_gate_config,
|
394
|
-
-> {
|
410
|
+
-> {
|
411
|
+
MetronomeSDK::V1::ContractCreateParams::Commit::PaymentGateConfig
|
412
|
+
}
|
395
413
|
|
396
414
|
# @!attribute priority
|
397
415
|
# If multiple commits are applicable, the one with the lower priority will apply
|
@@ -402,8 +420,8 @@ module MetronomeSDK
|
|
402
420
|
|
403
421
|
# @!attribute rate_type
|
404
422
|
#
|
405
|
-
# @return [Symbol, MetronomeSDK::
|
406
|
-
optional :rate_type, enum: -> { MetronomeSDK::
|
423
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::Commit::RateType, nil]
|
424
|
+
optional :rate_type, enum: -> { MetronomeSDK::V1::ContractCreateParams::Commit::RateType }
|
407
425
|
|
408
426
|
# @!attribute rollover_fraction
|
409
427
|
# Fraction of unused segments that will be rolled over. Must be between 0 and 1.
|
@@ -420,47 +438,41 @@ module MetronomeSDK
|
|
420
438
|
|
421
439
|
# @!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)
|
422
440
|
# Some parameter documentations has been truncated, see
|
423
|
-
# {MetronomeSDK::
|
441
|
+
# {MetronomeSDK::V1::ContractCreateParams::Commit} for more details.
|
424
442
|
#
|
425
443
|
# @param product_id [String]
|
426
444
|
#
|
427
|
-
# @param type [Symbol, MetronomeSDK::
|
445
|
+
# @param type [Symbol, MetronomeSDK::V1::ContractCreateParams::Commit::Type]
|
428
446
|
#
|
429
|
-
# @param access_schedule [MetronomeSDK::
|
430
|
-
# ...
|
447
|
+
# @param access_schedule [MetronomeSDK::V1::ContractCreateParams::Commit::AccessSchedule] Required: Schedule for distributing the commit to the customer. For "POSTPAID" c
|
431
448
|
#
|
432
449
|
# @param amount [Float] (DEPRECATED) Use access_schedule and invoice_schedule instead.
|
433
450
|
#
|
434
451
|
# @param applicable_product_ids [Array<String>] Which products the commit applies to. If both applicable_product_ids and applica
|
435
|
-
# ...
|
436
452
|
#
|
437
453
|
# @param applicable_product_tags [Array<String>] Which tags the commit applies to. If both applicable*product_ids and applicable*
|
438
|
-
# ...
|
439
454
|
#
|
440
455
|
# @param custom_fields [Hash{Symbol=>String}]
|
441
456
|
#
|
442
457
|
# @param description [String] Used only in UI/API. It is not exposed to end customers.
|
443
458
|
#
|
444
|
-
# @param invoice_schedule [MetronomeSDK::
|
445
|
-
# ...
|
459
|
+
# @param invoice_schedule [MetronomeSDK::V1::ContractCreateParams::Commit::InvoiceSchedule] Required for "POSTPAID" commits: the true up invoice will be generated at this t
|
446
460
|
#
|
447
461
|
# @param name [String] displayed on invoices
|
448
462
|
#
|
449
463
|
# @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
|
450
464
|
#
|
451
|
-
# @param payment_gate_config [MetronomeSDK::
|
465
|
+
# @param payment_gate_config [MetronomeSDK::V1::ContractCreateParams::Commit::PaymentGateConfig] optionally payment gate this commit
|
452
466
|
#
|
453
467
|
# @param priority [Float] If multiple commits are applicable, the one with the lower priority will apply f
|
454
|
-
# ...
|
455
468
|
#
|
456
|
-
# @param rate_type [Symbol, MetronomeSDK::
|
469
|
+
# @param rate_type [Symbol, MetronomeSDK::V1::ContractCreateParams::Commit::RateType]
|
457
470
|
#
|
458
471
|
# @param rollover_fraction [Float] Fraction of unused segments that will be rolled over. Must be between 0 and 1.
|
459
472
|
#
|
460
473
|
# @param temporary_id [String] A temporary ID for the commit that can be used to reference the commit for commi
|
461
|
-
# ...
|
462
474
|
|
463
|
-
# @see MetronomeSDK::
|
475
|
+
# @see MetronomeSDK::V1::ContractCreateParams::Commit#type
|
464
476
|
module Type
|
465
477
|
extend MetronomeSDK::Internal::Type::Enum
|
466
478
|
|
@@ -471,13 +483,15 @@ module MetronomeSDK
|
|
471
483
|
# @return [Array<Symbol>]
|
472
484
|
end
|
473
485
|
|
474
|
-
# @see MetronomeSDK::
|
486
|
+
# @see MetronomeSDK::V1::ContractCreateParams::Commit#access_schedule
|
475
487
|
class AccessSchedule < MetronomeSDK::Internal::Type::BaseModel
|
476
488
|
# @!attribute schedule_items
|
477
489
|
#
|
478
|
-
# @return [Array<MetronomeSDK::
|
490
|
+
# @return [Array<MetronomeSDK::V1::ContractCreateParams::Commit::AccessSchedule::ScheduleItem>]
|
479
491
|
required :schedule_items,
|
480
|
-
-> {
|
492
|
+
-> {
|
493
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractCreateParams::Commit::AccessSchedule::ScheduleItem]
|
494
|
+
}
|
481
495
|
|
482
496
|
# @!attribute credit_type_id
|
483
497
|
# Defaults to USD (cents) if not passed
|
@@ -490,7 +504,7 @@ module MetronomeSDK
|
|
490
504
|
# commits only one schedule item is allowed and amount must match invoice_schedule
|
491
505
|
# total.
|
492
506
|
#
|
493
|
-
# @param schedule_items [Array<MetronomeSDK::
|
507
|
+
# @param schedule_items [Array<MetronomeSDK::V1::ContractCreateParams::Commit::AccessSchedule::ScheduleItem>]
|
494
508
|
#
|
495
509
|
# @param credit_type_id [String] Defaults to USD (cents) if not passed
|
496
510
|
|
@@ -521,7 +535,7 @@ module MetronomeSDK
|
|
521
535
|
end
|
522
536
|
end
|
523
537
|
|
524
|
-
# @see MetronomeSDK::
|
538
|
+
# @see MetronomeSDK::V1::ContractCreateParams::Commit#invoice_schedule
|
525
539
|
class InvoiceSchedule < MetronomeSDK::Internal::Type::BaseModel
|
526
540
|
# @!attribute credit_type_id
|
527
541
|
# Defaults to USD (cents) if not passed.
|
@@ -534,21 +548,23 @@ module MetronomeSDK
|
|
534
548
|
# amount. If amount is sent, the unit price is assumed to be the amount and
|
535
549
|
# quantity is inferred to be 1.
|
536
550
|
#
|
537
|
-
# @return [MetronomeSDK::
|
551
|
+
# @return [MetronomeSDK::V1::ContractCreateParams::Commit::InvoiceSchedule::RecurringSchedule, nil]
|
538
552
|
optional :recurring_schedule,
|
539
|
-
-> { MetronomeSDK::
|
553
|
+
-> { MetronomeSDK::V1::ContractCreateParams::Commit::InvoiceSchedule::RecurringSchedule }
|
540
554
|
|
541
555
|
# @!attribute schedule_items
|
542
556
|
# Either provide amount or provide both unit_price and quantity.
|
543
557
|
#
|
544
|
-
# @return [Array<MetronomeSDK::
|
558
|
+
# @return [Array<MetronomeSDK::V1::ContractCreateParams::Commit::InvoiceSchedule::ScheduleItem>, nil]
|
545
559
|
optional :schedule_items,
|
546
|
-
-> {
|
560
|
+
-> {
|
561
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractCreateParams::Commit::InvoiceSchedule::ScheduleItem]
|
562
|
+
}
|
547
563
|
|
548
564
|
# @!method initialize(credit_type_id: nil, recurring_schedule: nil, schedule_items: nil)
|
549
565
|
# Some parameter documentations has been truncated, see
|
550
|
-
# {MetronomeSDK::
|
551
|
-
#
|
566
|
+
# {MetronomeSDK::V1::ContractCreateParams::Commit::InvoiceSchedule} for more
|
567
|
+
# details.
|
552
568
|
#
|
553
569
|
# Required for "POSTPAID" commits: the true up invoice will be generated at this
|
554
570
|
# time and only one schedule item is allowed; the total must match access_schedule
|
@@ -557,18 +573,19 @@ module MetronomeSDK
|
|
557
573
|
#
|
558
574
|
# @param credit_type_id [String] Defaults to USD (cents) if not passed.
|
559
575
|
#
|
560
|
-
# @param recurring_schedule [MetronomeSDK::
|
561
|
-
# ...
|
576
|
+
# @param recurring_schedule [MetronomeSDK::V1::ContractCreateParams::Commit::InvoiceSchedule::RecurringSchedule] Enter the unit price and quantity for the charge or instead only send the amount
|
562
577
|
#
|
563
|
-
# @param schedule_items [Array<MetronomeSDK::
|
578
|
+
# @param schedule_items [Array<MetronomeSDK::V1::ContractCreateParams::Commit::InvoiceSchedule::ScheduleItem>] Either provide amount or provide both unit_price and quantity.
|
564
579
|
|
565
|
-
# @see MetronomeSDK::
|
580
|
+
# @see MetronomeSDK::V1::ContractCreateParams::Commit::InvoiceSchedule#recurring_schedule
|
566
581
|
class RecurringSchedule < MetronomeSDK::Internal::Type::BaseModel
|
567
582
|
# @!attribute amount_distribution
|
568
583
|
#
|
569
|
-
# @return [Symbol, MetronomeSDK::
|
584
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::Commit::InvoiceSchedule::RecurringSchedule::AmountDistribution]
|
570
585
|
required :amount_distribution,
|
571
|
-
enum: -> {
|
586
|
+
enum: -> {
|
587
|
+
MetronomeSDK::V1::ContractCreateParams::Commit::InvoiceSchedule::RecurringSchedule::AmountDistribution
|
588
|
+
}
|
572
589
|
|
573
590
|
# @!attribute ending_before
|
574
591
|
# RFC 3339 timestamp (exclusive).
|
@@ -578,9 +595,11 @@ module MetronomeSDK
|
|
578
595
|
|
579
596
|
# @!attribute frequency
|
580
597
|
#
|
581
|
-
# @return [Symbol, MetronomeSDK::
|
598
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::Commit::InvoiceSchedule::RecurringSchedule::Frequency]
|
582
599
|
required :frequency,
|
583
|
-
enum: -> {
|
600
|
+
enum: -> {
|
601
|
+
MetronomeSDK::V1::ContractCreateParams::Commit::InvoiceSchedule::RecurringSchedule::Frequency
|
602
|
+
}
|
584
603
|
|
585
604
|
# @!attribute starting_at
|
586
605
|
# RFC 3339 timestamp (inclusive).
|
@@ -614,31 +633,28 @@ module MetronomeSDK
|
|
614
633
|
|
615
634
|
# @!method initialize(amount_distribution:, ending_before:, frequency:, starting_at:, amount: nil, quantity: nil, unit_price: nil)
|
616
635
|
# Some parameter documentations has been truncated, see
|
617
|
-
# {MetronomeSDK::
|
636
|
+
# {MetronomeSDK::V1::ContractCreateParams::Commit::InvoiceSchedule::RecurringSchedule}
|
618
637
|
# for more details.
|
619
638
|
#
|
620
639
|
# Enter the unit price and quantity for the charge or instead only send the
|
621
640
|
# amount. If amount is sent, the unit price is assumed to be the amount and
|
622
641
|
# quantity is inferred to be 1.
|
623
642
|
#
|
624
|
-
# @param amount_distribution [Symbol, MetronomeSDK::
|
643
|
+
# @param amount_distribution [Symbol, MetronomeSDK::V1::ContractCreateParams::Commit::InvoiceSchedule::RecurringSchedule::AmountDistribution]
|
625
644
|
#
|
626
645
|
# @param ending_before [Time] RFC 3339 timestamp (exclusive).
|
627
646
|
#
|
628
|
-
# @param frequency [Symbol, MetronomeSDK::
|
647
|
+
# @param frequency [Symbol, MetronomeSDK::V1::ContractCreateParams::Commit::InvoiceSchedule::RecurringSchedule::Frequency]
|
629
648
|
#
|
630
649
|
# @param starting_at [Time] RFC 3339 timestamp (inclusive).
|
631
650
|
#
|
632
651
|
# @param amount [Float] Amount for the charge. Can be provided instead of unit_price and quantity. If am
|
633
|
-
# ...
|
634
652
|
#
|
635
653
|
# @param quantity [Float] Quantity for the charge. Will be multiplied by unit_price to determine the amoun
|
636
|
-
# ...
|
637
654
|
#
|
638
655
|
# @param unit_price [Float] Unit price for the charge. Will be multiplied by quantity to determine the amoun
|
639
|
-
# ...
|
640
656
|
|
641
|
-
# @see MetronomeSDK::
|
657
|
+
# @see MetronomeSDK::V1::ContractCreateParams::Commit::InvoiceSchedule::RecurringSchedule#amount_distribution
|
642
658
|
module AmountDistribution
|
643
659
|
extend MetronomeSDK::Internal::Type::Enum
|
644
660
|
|
@@ -650,7 +666,7 @@ module MetronomeSDK
|
|
650
666
|
# @return [Array<Symbol>]
|
651
667
|
end
|
652
668
|
|
653
|
-
# @see MetronomeSDK::
|
669
|
+
# @see MetronomeSDK::V1::ContractCreateParams::Commit::InvoiceSchedule::RecurringSchedule#frequency
|
654
670
|
module Frequency
|
655
671
|
extend MetronomeSDK::Internal::Type::Enum
|
656
672
|
|
@@ -697,23 +713,20 @@ module MetronomeSDK
|
|
697
713
|
|
698
714
|
# @!method initialize(timestamp:, amount: nil, quantity: nil, unit_price: nil)
|
699
715
|
# Some parameter documentations has been truncated, see
|
700
|
-
# {MetronomeSDK::
|
716
|
+
# {MetronomeSDK::V1::ContractCreateParams::Commit::InvoiceSchedule::ScheduleItem}
|
701
717
|
# for more details.
|
702
718
|
#
|
703
719
|
# @param timestamp [Time] timestamp of the scheduled event
|
704
720
|
#
|
705
721
|
# @param amount [Float] Amount for the charge. Can be provided instead of unit_price and quantity. If am
|
706
|
-
# ...
|
707
722
|
#
|
708
723
|
# @param quantity [Float] Quantity for the charge. Will be multiplied by unit_price to determine the amoun
|
709
|
-
# ...
|
710
724
|
#
|
711
725
|
# @param unit_price [Float] Unit price for the charge. Will be multiplied by quantity to determine the amoun
|
712
|
-
# ...
|
713
726
|
end
|
714
727
|
end
|
715
728
|
|
716
|
-
# @see MetronomeSDK::
|
729
|
+
# @see MetronomeSDK::V1::ContractCreateParams::Commit#payment_gate_config
|
717
730
|
class PaymentGateConfig < MetronomeSDK::Internal::Type::BaseModel
|
718
731
|
# @!attribute payment_gate_type
|
719
732
|
# Gate access to the commit balance based on successful collection of payment.
|
@@ -721,47 +734,47 @@ module MetronomeSDK
|
|
721
734
|
# facilitate payment using your own payment integration. Select NONE if you do not
|
722
735
|
# wish to payment gate the commit balance.
|
723
736
|
#
|
724
|
-
# @return [Symbol, MetronomeSDK::
|
737
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::Commit::PaymentGateConfig::PaymentGateType]
|
725
738
|
required :payment_gate_type,
|
726
|
-
enum: -> {
|
739
|
+
enum: -> {
|
740
|
+
MetronomeSDK::V1::ContractCreateParams::Commit::PaymentGateConfig::PaymentGateType
|
741
|
+
}
|
727
742
|
|
728
743
|
# @!attribute stripe_config
|
729
744
|
# Only applicable if using Stripe as your payment gateway through Metronome.
|
730
745
|
#
|
731
|
-
# @return [MetronomeSDK::
|
746
|
+
# @return [MetronomeSDK::V1::ContractCreateParams::Commit::PaymentGateConfig::StripeConfig, nil]
|
732
747
|
optional :stripe_config,
|
733
|
-
-> { MetronomeSDK::
|
748
|
+
-> { MetronomeSDK::V1::ContractCreateParams::Commit::PaymentGateConfig::StripeConfig }
|
734
749
|
|
735
750
|
# @!attribute tax_type
|
736
751
|
# Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
|
737
752
|
# not wish Metronome to calculate tax on your behalf. Leaving this field blank
|
738
753
|
# will default to NONE.
|
739
754
|
#
|
740
|
-
# @return [Symbol, MetronomeSDK::
|
755
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::Commit::PaymentGateConfig::TaxType, nil]
|
741
756
|
optional :tax_type,
|
742
|
-
enum: -> { MetronomeSDK::
|
757
|
+
enum: -> { MetronomeSDK::V1::ContractCreateParams::Commit::PaymentGateConfig::TaxType }
|
743
758
|
|
744
759
|
# @!method initialize(payment_gate_type:, stripe_config: nil, tax_type: nil)
|
745
760
|
# Some parameter documentations has been truncated, see
|
746
|
-
# {MetronomeSDK::
|
747
|
-
#
|
761
|
+
# {MetronomeSDK::V1::ContractCreateParams::Commit::PaymentGateConfig} for more
|
762
|
+
# details.
|
748
763
|
#
|
749
764
|
# optionally payment gate this commit
|
750
765
|
#
|
751
|
-
# @param payment_gate_type [Symbol, MetronomeSDK::
|
752
|
-
# ...
|
766
|
+
# @param payment_gate_type [Symbol, MetronomeSDK::V1::ContractCreateParams::Commit::PaymentGateConfig::PaymentGateType] Gate access to the commit balance based on successful collection of payment. Sel
|
753
767
|
#
|
754
|
-
# @param stripe_config [MetronomeSDK::
|
768
|
+
# @param stripe_config [MetronomeSDK::V1::ContractCreateParams::Commit::PaymentGateConfig::StripeConfig] Only applicable if using Stripe as your payment gateway through Metronome.
|
755
769
|
#
|
756
|
-
# @param tax_type [Symbol, MetronomeSDK::
|
757
|
-
# ...
|
770
|
+
# @param tax_type [Symbol, MetronomeSDK::V1::ContractCreateParams::Commit::PaymentGateConfig::TaxType] Stripe tax is only supported for Stripe payment gateway. Select NONE if you do n
|
758
771
|
|
759
772
|
# Gate access to the commit balance based on successful collection of payment.
|
760
773
|
# Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
|
761
774
|
# facilitate payment using your own payment integration. Select NONE if you do not
|
762
775
|
# wish to payment gate the commit balance.
|
763
776
|
#
|
764
|
-
# @see MetronomeSDK::
|
777
|
+
# @see MetronomeSDK::V1::ContractCreateParams::Commit::PaymentGateConfig#payment_gate_type
|
765
778
|
module PaymentGateType
|
766
779
|
extend MetronomeSDK::Internal::Type::Enum
|
767
780
|
|
@@ -773,23 +786,25 @@ module MetronomeSDK
|
|
773
786
|
# @return [Array<Symbol>]
|
774
787
|
end
|
775
788
|
|
776
|
-
# @see MetronomeSDK::
|
789
|
+
# @see MetronomeSDK::V1::ContractCreateParams::Commit::PaymentGateConfig#stripe_config
|
777
790
|
class StripeConfig < MetronomeSDK::Internal::Type::BaseModel
|
778
791
|
# @!attribute payment_type
|
779
792
|
# If left blank, will default to INVOICE
|
780
793
|
#
|
781
|
-
# @return [Symbol, MetronomeSDK::
|
794
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::Commit::PaymentGateConfig::StripeConfig::PaymentType]
|
782
795
|
required :payment_type,
|
783
|
-
enum: -> {
|
796
|
+
enum: -> {
|
797
|
+
MetronomeSDK::V1::ContractCreateParams::Commit::PaymentGateConfig::StripeConfig::PaymentType
|
798
|
+
}
|
784
799
|
|
785
800
|
# @!method initialize(payment_type:)
|
786
801
|
# Only applicable if using Stripe as your payment gateway through Metronome.
|
787
802
|
#
|
788
|
-
# @param payment_type [Symbol, MetronomeSDK::
|
803
|
+
# @param payment_type [Symbol, MetronomeSDK::V1::ContractCreateParams::Commit::PaymentGateConfig::StripeConfig::PaymentType] If left blank, will default to INVOICE
|
789
804
|
|
790
805
|
# If left blank, will default to INVOICE
|
791
806
|
#
|
792
|
-
# @see MetronomeSDK::
|
807
|
+
# @see MetronomeSDK::V1::ContractCreateParams::Commit::PaymentGateConfig::StripeConfig#payment_type
|
793
808
|
module PaymentType
|
794
809
|
extend MetronomeSDK::Internal::Type::Enum
|
795
810
|
|
@@ -805,7 +820,7 @@ module MetronomeSDK
|
|
805
820
|
# not wish Metronome to calculate tax on your behalf. Leaving this field blank
|
806
821
|
# will default to NONE.
|
807
822
|
#
|
808
|
-
# @see MetronomeSDK::
|
823
|
+
# @see MetronomeSDK::V1::ContractCreateParams::Commit::PaymentGateConfig#tax_type
|
809
824
|
module TaxType
|
810
825
|
extend MetronomeSDK::Internal::Type::Enum
|
811
826
|
|
@@ -817,7 +832,7 @@ module MetronomeSDK
|
|
817
832
|
end
|
818
833
|
end
|
819
834
|
|
820
|
-
# @see MetronomeSDK::
|
835
|
+
# @see MetronomeSDK::V1::ContractCreateParams::Commit#rate_type
|
821
836
|
module RateType
|
822
837
|
extend MetronomeSDK::Internal::Type::Enum
|
823
838
|
|
@@ -829,222 +844,12 @@ module MetronomeSDK
|
|
829
844
|
end
|
830
845
|
end
|
831
846
|
|
832
|
-
class CreditBalanceThresholdConfiguration < MetronomeSDK::Internal::Type::BaseModel
|
833
|
-
# @!attribute commit
|
834
|
-
#
|
835
|
-
# @return [MetronomeSDK::Models::V1::ContractCreateParams::CreditBalanceThresholdConfiguration::Commit]
|
836
|
-
required :commit,
|
837
|
-
-> { MetronomeSDK::Models::V1::ContractCreateParams::CreditBalanceThresholdConfiguration::Commit }
|
838
|
-
|
839
|
-
# @!attribute is_enabled
|
840
|
-
# When set to false, the contract will not be evaluated against the
|
841
|
-
# threshold_amount. Toggling to true will result an immediate evaluation,
|
842
|
-
# regardless of prior state.
|
843
|
-
#
|
844
|
-
# @return [Boolean]
|
845
|
-
required :is_enabled, MetronomeSDK::Internal::Type::Boolean
|
846
|
-
|
847
|
-
# @!attribute payment_gate_config
|
848
|
-
#
|
849
|
-
# @return [MetronomeSDK::Models::V1::ContractCreateParams::CreditBalanceThresholdConfiguration::PaymentGateConfig]
|
850
|
-
required :payment_gate_config,
|
851
|
-
-> { MetronomeSDK::Models::V1::ContractCreateParams::CreditBalanceThresholdConfiguration::PaymentGateConfig }
|
852
|
-
|
853
|
-
# @!attribute recharge_to_amount
|
854
|
-
# Specify the amount the balance should be recharged to.
|
855
|
-
#
|
856
|
-
# @return [Float]
|
857
|
-
required :recharge_to_amount, Float
|
858
|
-
|
859
|
-
# @!attribute threshold_amount
|
860
|
-
# Specify the threshold amount for the contract. Each time the contract's balance
|
861
|
-
# lowers to this amount, a threshold charge will be initiated.
|
862
|
-
#
|
863
|
-
# @return [Float]
|
864
|
-
required :threshold_amount, Float
|
865
|
-
|
866
|
-
# @!method initialize(commit:, is_enabled:, payment_gate_config:, recharge_to_amount:, threshold_amount:)
|
867
|
-
# Some parameter documentations has been truncated, see
|
868
|
-
# {MetronomeSDK::Models::V1::ContractCreateParams::CreditBalanceThresholdConfiguration}
|
869
|
-
# for more details.
|
870
|
-
#
|
871
|
-
# @param commit [MetronomeSDK::Models::V1::ContractCreateParams::CreditBalanceThresholdConfiguration::Commit]
|
872
|
-
#
|
873
|
-
# @param is_enabled [Boolean] When set to false, the contract will not be evaluated against the threshold_amou
|
874
|
-
# ...
|
875
|
-
#
|
876
|
-
# @param payment_gate_config [MetronomeSDK::Models::V1::ContractCreateParams::CreditBalanceThresholdConfiguration::PaymentGateConfig]
|
877
|
-
#
|
878
|
-
# @param recharge_to_amount [Float] Specify the amount the balance should be recharged to.
|
879
|
-
#
|
880
|
-
# @param threshold_amount [Float] Specify the threshold amount for the contract. Each time the contract's balance
|
881
|
-
# ...
|
882
|
-
|
883
|
-
# @see MetronomeSDK::Models::V1::ContractCreateParams::CreditBalanceThresholdConfiguration#commit
|
884
|
-
class Commit < MetronomeSDK::Internal::Type::BaseModel
|
885
|
-
# @!attribute product_id
|
886
|
-
# The commit product that will be used to generate the line item for commit
|
887
|
-
# payment.
|
888
|
-
#
|
889
|
-
# @return [String]
|
890
|
-
required :product_id, String
|
891
|
-
|
892
|
-
# @!attribute applicable_product_ids
|
893
|
-
# Which products the threshold commit applies to. If both applicable_product_ids
|
894
|
-
# and applicable_product_tags are not provided, the commit applies to all
|
895
|
-
# products.
|
896
|
-
#
|
897
|
-
# @return [Array<String>, nil]
|
898
|
-
optional :applicable_product_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
|
899
|
-
|
900
|
-
# @!attribute applicable_product_tags
|
901
|
-
# Which tags the threshold commit applies to. If both applicable_product_ids and
|
902
|
-
# applicable_product_tags are not provided, the commit applies to all products.
|
903
|
-
#
|
904
|
-
# @return [Array<String>, nil]
|
905
|
-
optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
|
906
|
-
|
907
|
-
# @!attribute description
|
908
|
-
#
|
909
|
-
# @return [String, nil]
|
910
|
-
optional :description, String
|
911
|
-
|
912
|
-
# @!attribute name
|
913
|
-
# Specify the name of the line item for the threshold charge. If left blank, it
|
914
|
-
# will default to the commit product name.
|
915
|
-
#
|
916
|
-
# @return [String, nil]
|
917
|
-
optional :name, String
|
918
|
-
|
919
|
-
# @!method initialize(product_id:, applicable_product_ids: nil, applicable_product_tags: nil, description: nil, name: nil)
|
920
|
-
# Some parameter documentations has been truncated, see
|
921
|
-
# {MetronomeSDK::Models::V1::ContractCreateParams::CreditBalanceThresholdConfiguration::Commit}
|
922
|
-
# for more details.
|
923
|
-
#
|
924
|
-
# @param product_id [String] The commit product that will be used to generate the line item for commit paymen
|
925
|
-
# ...
|
926
|
-
#
|
927
|
-
# @param applicable_product_ids [Array<String>] Which products the threshold commit applies to. If both applicable_product_ids a
|
928
|
-
# ...
|
929
|
-
#
|
930
|
-
# @param applicable_product_tags [Array<String>] Which tags the threshold commit applies to. If both applicable_product_ids and a
|
931
|
-
# ...
|
932
|
-
#
|
933
|
-
# @param description [String]
|
934
|
-
#
|
935
|
-
# @param name [String] Specify the name of the line item for the threshold charge. If left blank, it wi
|
936
|
-
# ...
|
937
|
-
end
|
938
|
-
|
939
|
-
# @see MetronomeSDK::Models::V1::ContractCreateParams::CreditBalanceThresholdConfiguration#payment_gate_config
|
940
|
-
class PaymentGateConfig < MetronomeSDK::Internal::Type::BaseModel
|
941
|
-
# @!attribute payment_gate_type
|
942
|
-
# Gate access to the commit balance based on successful collection of payment.
|
943
|
-
# Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
|
944
|
-
# facilitate payment using your own payment integration. Select NONE if you do not
|
945
|
-
# wish to payment gate the commit balance.
|
946
|
-
#
|
947
|
-
# @return [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::CreditBalanceThresholdConfiguration::PaymentGateConfig::PaymentGateType]
|
948
|
-
required :payment_gate_type,
|
949
|
-
enum: -> { MetronomeSDK::Models::V1::ContractCreateParams::CreditBalanceThresholdConfiguration::PaymentGateConfig::PaymentGateType }
|
950
|
-
|
951
|
-
# @!attribute stripe_config
|
952
|
-
# Only applicable if using Stripe as your payment gateway through Metronome.
|
953
|
-
#
|
954
|
-
# @return [MetronomeSDK::Models::V1::ContractCreateParams::CreditBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig, nil]
|
955
|
-
optional :stripe_config,
|
956
|
-
-> { MetronomeSDK::Models::V1::ContractCreateParams::CreditBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig }
|
957
|
-
|
958
|
-
# @!attribute tax_type
|
959
|
-
# Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
|
960
|
-
# not wish Metronome to calculate tax on your behalf. Leaving this field blank
|
961
|
-
# will default to NONE.
|
962
|
-
#
|
963
|
-
# @return [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::CreditBalanceThresholdConfiguration::PaymentGateConfig::TaxType, nil]
|
964
|
-
optional :tax_type,
|
965
|
-
enum: -> { MetronomeSDK::Models::V1::ContractCreateParams::CreditBalanceThresholdConfiguration::PaymentGateConfig::TaxType }
|
966
|
-
|
967
|
-
# @!method initialize(payment_gate_type:, stripe_config: nil, tax_type: nil)
|
968
|
-
# Some parameter documentations has been truncated, see
|
969
|
-
# {MetronomeSDK::Models::V1::ContractCreateParams::CreditBalanceThresholdConfiguration::PaymentGateConfig}
|
970
|
-
# for more details.
|
971
|
-
#
|
972
|
-
# @param payment_gate_type [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::CreditBalanceThresholdConfiguration::PaymentGateConfig::PaymentGateType] Gate access to the commit balance based on successful collection of payment. Sel
|
973
|
-
# ...
|
974
|
-
#
|
975
|
-
# @param stripe_config [MetronomeSDK::Models::V1::ContractCreateParams::CreditBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig] Only applicable if using Stripe as your payment gateway through Metronome.
|
976
|
-
#
|
977
|
-
# @param tax_type [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::CreditBalanceThresholdConfiguration::PaymentGateConfig::TaxType] Stripe tax is only supported for Stripe payment gateway. Select NONE if you do n
|
978
|
-
# ...
|
979
|
-
|
980
|
-
# Gate access to the commit balance based on successful collection of payment.
|
981
|
-
# Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
|
982
|
-
# facilitate payment using your own payment integration. Select NONE if you do not
|
983
|
-
# wish to payment gate the commit balance.
|
984
|
-
#
|
985
|
-
# @see MetronomeSDK::Models::V1::ContractCreateParams::CreditBalanceThresholdConfiguration::PaymentGateConfig#payment_gate_type
|
986
|
-
module PaymentGateType
|
987
|
-
extend MetronomeSDK::Internal::Type::Enum
|
988
|
-
|
989
|
-
NONE = :NONE
|
990
|
-
STRIPE = :STRIPE
|
991
|
-
EXTERNAL = :EXTERNAL
|
992
|
-
|
993
|
-
# @!method self.values
|
994
|
-
# @return [Array<Symbol>]
|
995
|
-
end
|
996
|
-
|
997
|
-
# @see MetronomeSDK::Models::V1::ContractCreateParams::CreditBalanceThresholdConfiguration::PaymentGateConfig#stripe_config
|
998
|
-
class StripeConfig < MetronomeSDK::Internal::Type::BaseModel
|
999
|
-
# @!attribute payment_type
|
1000
|
-
# If left blank, will default to INVOICE
|
1001
|
-
#
|
1002
|
-
# @return [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::CreditBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType]
|
1003
|
-
required :payment_type,
|
1004
|
-
enum: -> { MetronomeSDK::Models::V1::ContractCreateParams::CreditBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType }
|
1005
|
-
|
1006
|
-
# @!method initialize(payment_type:)
|
1007
|
-
# Only applicable if using Stripe as your payment gateway through Metronome.
|
1008
|
-
#
|
1009
|
-
# @param payment_type [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::CreditBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType] If left blank, will default to INVOICE
|
1010
|
-
|
1011
|
-
# If left blank, will default to INVOICE
|
1012
|
-
#
|
1013
|
-
# @see MetronomeSDK::Models::V1::ContractCreateParams::CreditBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig#payment_type
|
1014
|
-
module PaymentType
|
1015
|
-
extend MetronomeSDK::Internal::Type::Enum
|
1016
|
-
|
1017
|
-
INVOICE = :INVOICE
|
1018
|
-
PAYMENT_INTENT = :PAYMENT_INTENT
|
1019
|
-
|
1020
|
-
# @!method self.values
|
1021
|
-
# @return [Array<Symbol>]
|
1022
|
-
end
|
1023
|
-
end
|
1024
|
-
|
1025
|
-
# Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
|
1026
|
-
# not wish Metronome to calculate tax on your behalf. Leaving this field blank
|
1027
|
-
# will default to NONE.
|
1028
|
-
#
|
1029
|
-
# @see MetronomeSDK::Models::V1::ContractCreateParams::CreditBalanceThresholdConfiguration::PaymentGateConfig#tax_type
|
1030
|
-
module TaxType
|
1031
|
-
extend MetronomeSDK::Internal::Type::Enum
|
1032
|
-
|
1033
|
-
NONE = :NONE
|
1034
|
-
STRIPE = :STRIPE
|
1035
|
-
|
1036
|
-
# @!method self.values
|
1037
|
-
# @return [Array<Symbol>]
|
1038
|
-
end
|
1039
|
-
end
|
1040
|
-
end
|
1041
|
-
|
1042
847
|
class Credit < MetronomeSDK::Internal::Type::BaseModel
|
1043
848
|
# @!attribute access_schedule
|
1044
849
|
# Schedule for distributing the credit to the customer.
|
1045
850
|
#
|
1046
|
-
# @return [MetronomeSDK::
|
1047
|
-
required :access_schedule, -> { MetronomeSDK::
|
851
|
+
# @return [MetronomeSDK::V1::ContractCreateParams::Credit::AccessSchedule]
|
852
|
+
required :access_schedule, -> { MetronomeSDK::V1::ContractCreateParams::Credit::AccessSchedule }
|
1048
853
|
|
1049
854
|
# @!attribute product_id
|
1050
855
|
#
|
@@ -1097,22 +902,20 @@ module MetronomeSDK
|
|
1097
902
|
|
1098
903
|
# @!attribute rate_type
|
1099
904
|
#
|
1100
|
-
# @return [Symbol, MetronomeSDK::
|
1101
|
-
optional :rate_type, enum: -> { MetronomeSDK::
|
905
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::Credit::RateType, nil]
|
906
|
+
optional :rate_type, enum: -> { MetronomeSDK::V1::ContractCreateParams::Credit::RateType }
|
1102
907
|
|
1103
908
|
# @!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)
|
1104
909
|
# Some parameter documentations has been truncated, see
|
1105
|
-
# {MetronomeSDK::
|
910
|
+
# {MetronomeSDK::V1::ContractCreateParams::Credit} for more details.
|
1106
911
|
#
|
1107
|
-
# @param access_schedule [MetronomeSDK::
|
912
|
+
# @param access_schedule [MetronomeSDK::V1::ContractCreateParams::Credit::AccessSchedule] Schedule for distributing the credit to the customer.
|
1108
913
|
#
|
1109
914
|
# @param product_id [String]
|
1110
915
|
#
|
1111
916
|
# @param applicable_product_ids [Array<String>] Which products the credit applies to. If both applicable_product_ids and applica
|
1112
|
-
# ...
|
1113
917
|
#
|
1114
918
|
# @param applicable_product_tags [Array<String>] Which tags the credit applies to. If both applicable*product_ids and applicable*
|
1115
|
-
# ...
|
1116
919
|
#
|
1117
920
|
# @param custom_fields [Hash{Symbol=>String}]
|
1118
921
|
#
|
@@ -1123,17 +926,18 @@ module MetronomeSDK
|
|
1123
926
|
# @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
|
1124
927
|
#
|
1125
928
|
# @param priority [Float] If multiple credits are applicable, the one with the lower priority will apply f
|
1126
|
-
# ...
|
1127
929
|
#
|
1128
|
-
# @param rate_type [Symbol, MetronomeSDK::
|
930
|
+
# @param rate_type [Symbol, MetronomeSDK::V1::ContractCreateParams::Credit::RateType]
|
1129
931
|
|
1130
|
-
# @see MetronomeSDK::
|
932
|
+
# @see MetronomeSDK::V1::ContractCreateParams::Credit#access_schedule
|
1131
933
|
class AccessSchedule < MetronomeSDK::Internal::Type::BaseModel
|
1132
934
|
# @!attribute schedule_items
|
1133
935
|
#
|
1134
|
-
# @return [Array<MetronomeSDK::
|
936
|
+
# @return [Array<MetronomeSDK::V1::ContractCreateParams::Credit::AccessSchedule::ScheduleItem>]
|
1135
937
|
required :schedule_items,
|
1136
|
-
-> {
|
938
|
+
-> {
|
939
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractCreateParams::Credit::AccessSchedule::ScheduleItem]
|
940
|
+
}
|
1137
941
|
|
1138
942
|
# @!attribute credit_type_id
|
1139
943
|
# Defaults to USD (cents) if not passed
|
@@ -1144,7 +948,7 @@ module MetronomeSDK
|
|
1144
948
|
# @!method initialize(schedule_items:, credit_type_id: nil)
|
1145
949
|
# Schedule for distributing the credit to the customer.
|
1146
950
|
#
|
1147
|
-
# @param schedule_items [Array<MetronomeSDK::
|
951
|
+
# @param schedule_items [Array<MetronomeSDK::V1::ContractCreateParams::Credit::AccessSchedule::ScheduleItem>]
|
1148
952
|
#
|
1149
953
|
# @param credit_type_id [String] Defaults to USD (cents) if not passed
|
1150
954
|
|
@@ -1175,7 +979,7 @@ module MetronomeSDK
|
|
1175
979
|
end
|
1176
980
|
end
|
1177
981
|
|
1178
|
-
# @see MetronomeSDK::
|
982
|
+
# @see MetronomeSDK::V1::ContractCreateParams::Credit#rate_type
|
1179
983
|
module RateType
|
1180
984
|
extend MetronomeSDK::Internal::Type::Enum
|
1181
985
|
|
@@ -1196,8 +1000,8 @@ module MetronomeSDK
|
|
1196
1000
|
# @!attribute schedule
|
1197
1001
|
# Must provide either schedule_items or recurring_schedule.
|
1198
1002
|
#
|
1199
|
-
# @return [MetronomeSDK::
|
1200
|
-
required :schedule, -> { MetronomeSDK::
|
1003
|
+
# @return [MetronomeSDK::V1::ContractCreateParams::Discount::Schedule]
|
1004
|
+
required :schedule, -> { MetronomeSDK::V1::ContractCreateParams::Discount::Schedule }
|
1201
1005
|
|
1202
1006
|
# @!attribute custom_fields
|
1203
1007
|
#
|
@@ -1219,7 +1023,7 @@ module MetronomeSDK
|
|
1219
1023
|
# @!method initialize(product_id:, schedule:, custom_fields: nil, name: nil, netsuite_sales_order_id: nil)
|
1220
1024
|
# @param product_id [String]
|
1221
1025
|
#
|
1222
|
-
# @param schedule [MetronomeSDK::
|
1026
|
+
# @param schedule [MetronomeSDK::V1::ContractCreateParams::Discount::Schedule] Must provide either schedule_items or recurring_schedule.
|
1223
1027
|
#
|
1224
1028
|
# @param custom_fields [Hash{Symbol=>String}]
|
1225
1029
|
#
|
@@ -1227,7 +1031,7 @@ module MetronomeSDK
|
|
1227
1031
|
#
|
1228
1032
|
# @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
|
1229
1033
|
|
1230
|
-
# @see MetronomeSDK::
|
1034
|
+
# @see MetronomeSDK::V1::ContractCreateParams::Discount#schedule
|
1231
1035
|
class Schedule < MetronomeSDK::Internal::Type::BaseModel
|
1232
1036
|
# @!attribute credit_type_id
|
1233
1037
|
# Defaults to USD (cents) if not passed.
|
@@ -1240,38 +1044,40 @@ module MetronomeSDK
|
|
1240
1044
|
# amount. If amount is sent, the unit price is assumed to be the amount and
|
1241
1045
|
# quantity is inferred to be 1.
|
1242
1046
|
#
|
1243
|
-
# @return [MetronomeSDK::
|
1047
|
+
# @return [MetronomeSDK::V1::ContractCreateParams::Discount::Schedule::RecurringSchedule, nil]
|
1244
1048
|
optional :recurring_schedule,
|
1245
|
-
-> { MetronomeSDK::
|
1049
|
+
-> { MetronomeSDK::V1::ContractCreateParams::Discount::Schedule::RecurringSchedule }
|
1246
1050
|
|
1247
1051
|
# @!attribute schedule_items
|
1248
1052
|
# Either provide amount or provide both unit_price and quantity.
|
1249
1053
|
#
|
1250
|
-
# @return [Array<MetronomeSDK::
|
1054
|
+
# @return [Array<MetronomeSDK::V1::ContractCreateParams::Discount::Schedule::ScheduleItem>, nil]
|
1251
1055
|
optional :schedule_items,
|
1252
|
-
-> {
|
1056
|
+
-> {
|
1057
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractCreateParams::Discount::Schedule::ScheduleItem]
|
1058
|
+
}
|
1253
1059
|
|
1254
1060
|
# @!method initialize(credit_type_id: nil, recurring_schedule: nil, schedule_items: nil)
|
1255
1061
|
# Some parameter documentations has been truncated, see
|
1256
|
-
# {MetronomeSDK::
|
1257
|
-
# details.
|
1062
|
+
# {MetronomeSDK::V1::ContractCreateParams::Discount::Schedule} for more details.
|
1258
1063
|
#
|
1259
1064
|
# Must provide either schedule_items or recurring_schedule.
|
1260
1065
|
#
|
1261
1066
|
# @param credit_type_id [String] Defaults to USD (cents) if not passed.
|
1262
1067
|
#
|
1263
|
-
# @param recurring_schedule [MetronomeSDK::
|
1264
|
-
# ...
|
1068
|
+
# @param recurring_schedule [MetronomeSDK::V1::ContractCreateParams::Discount::Schedule::RecurringSchedule] Enter the unit price and quantity for the charge or instead only send the amount
|
1265
1069
|
#
|
1266
|
-
# @param schedule_items [Array<MetronomeSDK::
|
1070
|
+
# @param schedule_items [Array<MetronomeSDK::V1::ContractCreateParams::Discount::Schedule::ScheduleItem>] Either provide amount or provide both unit_price and quantity.
|
1267
1071
|
|
1268
|
-
# @see MetronomeSDK::
|
1072
|
+
# @see MetronomeSDK::V1::ContractCreateParams::Discount::Schedule#recurring_schedule
|
1269
1073
|
class RecurringSchedule < MetronomeSDK::Internal::Type::BaseModel
|
1270
1074
|
# @!attribute amount_distribution
|
1271
1075
|
#
|
1272
|
-
# @return [Symbol, MetronomeSDK::
|
1076
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::Discount::Schedule::RecurringSchedule::AmountDistribution]
|
1273
1077
|
required :amount_distribution,
|
1274
|
-
enum: -> {
|
1078
|
+
enum: -> {
|
1079
|
+
MetronomeSDK::V1::ContractCreateParams::Discount::Schedule::RecurringSchedule::AmountDistribution
|
1080
|
+
}
|
1275
1081
|
|
1276
1082
|
# @!attribute ending_before
|
1277
1083
|
# RFC 3339 timestamp (exclusive).
|
@@ -1281,9 +1087,11 @@ module MetronomeSDK
|
|
1281
1087
|
|
1282
1088
|
# @!attribute frequency
|
1283
1089
|
#
|
1284
|
-
# @return [Symbol, MetronomeSDK::
|
1090
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::Discount::Schedule::RecurringSchedule::Frequency]
|
1285
1091
|
required :frequency,
|
1286
|
-
enum: -> {
|
1092
|
+
enum: -> {
|
1093
|
+
MetronomeSDK::V1::ContractCreateParams::Discount::Schedule::RecurringSchedule::Frequency
|
1094
|
+
}
|
1287
1095
|
|
1288
1096
|
# @!attribute starting_at
|
1289
1097
|
# RFC 3339 timestamp (inclusive).
|
@@ -1317,31 +1125,28 @@ module MetronomeSDK
|
|
1317
1125
|
|
1318
1126
|
# @!method initialize(amount_distribution:, ending_before:, frequency:, starting_at:, amount: nil, quantity: nil, unit_price: nil)
|
1319
1127
|
# Some parameter documentations has been truncated, see
|
1320
|
-
# {MetronomeSDK::
|
1128
|
+
# {MetronomeSDK::V1::ContractCreateParams::Discount::Schedule::RecurringSchedule}
|
1321
1129
|
# for more details.
|
1322
1130
|
#
|
1323
1131
|
# Enter the unit price and quantity for the charge or instead only send the
|
1324
1132
|
# amount. If amount is sent, the unit price is assumed to be the amount and
|
1325
1133
|
# quantity is inferred to be 1.
|
1326
1134
|
#
|
1327
|
-
# @param amount_distribution [Symbol, MetronomeSDK::
|
1135
|
+
# @param amount_distribution [Symbol, MetronomeSDK::V1::ContractCreateParams::Discount::Schedule::RecurringSchedule::AmountDistribution]
|
1328
1136
|
#
|
1329
1137
|
# @param ending_before [Time] RFC 3339 timestamp (exclusive).
|
1330
1138
|
#
|
1331
|
-
# @param frequency [Symbol, MetronomeSDK::
|
1139
|
+
# @param frequency [Symbol, MetronomeSDK::V1::ContractCreateParams::Discount::Schedule::RecurringSchedule::Frequency]
|
1332
1140
|
#
|
1333
1141
|
# @param starting_at [Time] RFC 3339 timestamp (inclusive).
|
1334
1142
|
#
|
1335
1143
|
# @param amount [Float] Amount for the charge. Can be provided instead of unit_price and quantity. If am
|
1336
|
-
# ...
|
1337
1144
|
#
|
1338
1145
|
# @param quantity [Float] Quantity for the charge. Will be multiplied by unit_price to determine the amoun
|
1339
|
-
# ...
|
1340
1146
|
#
|
1341
1147
|
# @param unit_price [Float] Unit price for the charge. Will be multiplied by quantity to determine the amoun
|
1342
|
-
# ...
|
1343
1148
|
|
1344
|
-
# @see MetronomeSDK::
|
1149
|
+
# @see MetronomeSDK::V1::ContractCreateParams::Discount::Schedule::RecurringSchedule#amount_distribution
|
1345
1150
|
module AmountDistribution
|
1346
1151
|
extend MetronomeSDK::Internal::Type::Enum
|
1347
1152
|
|
@@ -1353,7 +1158,7 @@ module MetronomeSDK
|
|
1353
1158
|
# @return [Array<Symbol>]
|
1354
1159
|
end
|
1355
1160
|
|
1356
|
-
# @see MetronomeSDK::
|
1161
|
+
# @see MetronomeSDK::V1::ContractCreateParams::Discount::Schedule::RecurringSchedule#frequency
|
1357
1162
|
module Frequency
|
1358
1163
|
extend MetronomeSDK::Internal::Type::Enum
|
1359
1164
|
|
@@ -1400,19 +1205,16 @@ module MetronomeSDK
|
|
1400
1205
|
|
1401
1206
|
# @!method initialize(timestamp:, amount: nil, quantity: nil, unit_price: nil)
|
1402
1207
|
# Some parameter documentations has been truncated, see
|
1403
|
-
# {MetronomeSDK::
|
1404
|
-
#
|
1208
|
+
# {MetronomeSDK::V1::ContractCreateParams::Discount::Schedule::ScheduleItem} for
|
1209
|
+
# more details.
|
1405
1210
|
#
|
1406
1211
|
# @param timestamp [Time] timestamp of the scheduled event
|
1407
1212
|
#
|
1408
1213
|
# @param amount [Float] Amount for the charge. Can be provided instead of unit_price and quantity. If am
|
1409
|
-
# ...
|
1410
1214
|
#
|
1411
1215
|
# @param quantity [Float] Quantity for the charge. Will be multiplied by unit_price to determine the amoun
|
1412
|
-
# ...
|
1413
1216
|
#
|
1414
1217
|
# @param unit_price [Float] Unit price for the charge. Will be multiplied by quantity to determine the amoun
|
1415
|
-
# ...
|
1416
1218
|
end
|
1417
1219
|
end
|
1418
1220
|
end
|
@@ -1475,15 +1277,17 @@ module MetronomeSDK
|
|
1475
1277
|
# Cannot be used in conjunction with product_id or applicable_product_tags. If
|
1476
1278
|
# provided, the override will apply to all products with the specified specifiers.
|
1477
1279
|
#
|
1478
|
-
# @return [Array<MetronomeSDK::
|
1280
|
+
# @return [Array<MetronomeSDK::V1::ContractCreateParams::Override::OverrideSpecifier>, nil]
|
1479
1281
|
optional :override_specifiers,
|
1480
|
-
-> {
|
1282
|
+
-> {
|
1283
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractCreateParams::Override::OverrideSpecifier]
|
1284
|
+
}
|
1481
1285
|
|
1482
1286
|
# @!attribute overwrite_rate
|
1483
1287
|
# Required for OVERWRITE type.
|
1484
1288
|
#
|
1485
|
-
# @return [MetronomeSDK::
|
1486
|
-
optional :overwrite_rate, -> { MetronomeSDK::
|
1289
|
+
# @return [MetronomeSDK::V1::ContractCreateParams::Override::OverwriteRate, nil]
|
1290
|
+
optional :overwrite_rate, -> { MetronomeSDK::V1::ContractCreateParams::Override::OverwriteRate }
|
1487
1291
|
|
1488
1292
|
# @!attribute priority
|
1489
1293
|
# Required for EXPLICIT multiplier prioritization scheme and all TIERED overrides.
|
@@ -1506,57 +1310,53 @@ module MetronomeSDK
|
|
1506
1310
|
# be used for overrides that have `is_commit_specific` set to `true`. Defaults to
|
1507
1311
|
# `"LIST_RATE"`.
|
1508
1312
|
#
|
1509
|
-
# @return [Symbol, MetronomeSDK::
|
1510
|
-
optional :target, enum: -> { MetronomeSDK::
|
1313
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::Override::Target, nil]
|
1314
|
+
optional :target, enum: -> { MetronomeSDK::V1::ContractCreateParams::Override::Target }
|
1511
1315
|
|
1512
1316
|
# @!attribute tiers
|
1513
1317
|
# Required for TIERED type. Must have at least one tier.
|
1514
1318
|
#
|
1515
|
-
# @return [Array<MetronomeSDK::
|
1319
|
+
# @return [Array<MetronomeSDK::V1::ContractCreateParams::Override::Tier>, nil]
|
1516
1320
|
optional :tiers,
|
1517
|
-
-> {
|
1321
|
+
-> {
|
1322
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractCreateParams::Override::Tier]
|
1323
|
+
}
|
1518
1324
|
|
1519
1325
|
# @!attribute type
|
1520
1326
|
# Overwrites are prioritized over multipliers and tiered overrides.
|
1521
1327
|
#
|
1522
|
-
# @return [Symbol, MetronomeSDK::
|
1523
|
-
optional :type, enum: -> { MetronomeSDK::
|
1328
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::Override::Type, nil]
|
1329
|
+
optional :type, enum: -> { MetronomeSDK::V1::ContractCreateParams::Override::Type }
|
1524
1330
|
|
1525
1331
|
# @!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)
|
1526
1332
|
# Some parameter documentations has been truncated, see
|
1527
|
-
# {MetronomeSDK::
|
1333
|
+
# {MetronomeSDK::V1::ContractCreateParams::Override} for more details.
|
1528
1334
|
#
|
1529
1335
|
# @param starting_at [Time] RFC 3339 timestamp indicating when the override will start applying (inclusive)
|
1530
1336
|
#
|
1531
1337
|
# @param applicable_product_tags [Array<String>] tags identifying products whose rates are being overridden. Cannot be used in co
|
1532
|
-
# ...
|
1533
1338
|
#
|
1534
1339
|
# @param ending_before [Time] RFC 3339 timestamp indicating when the override will stop applying (exclusive)
|
1535
1340
|
#
|
1536
1341
|
# @param entitled [Boolean]
|
1537
1342
|
#
|
1538
1343
|
# @param is_commit_specific [Boolean] Indicates whether the override should only apply to commits. Defaults to `false`
|
1539
|
-
# ...
|
1540
1344
|
#
|
1541
1345
|
# @param multiplier [Float] Required for MULTIPLIER type. Must be >=0.
|
1542
1346
|
#
|
1543
|
-
# @param override_specifiers [Array<MetronomeSDK::
|
1544
|
-
# ...
|
1347
|
+
# @param override_specifiers [Array<MetronomeSDK::V1::ContractCreateParams::Override::OverrideSpecifier>] Cannot be used in conjunction with product_id or applicable_product_tags. If pro
|
1545
1348
|
#
|
1546
|
-
# @param overwrite_rate [MetronomeSDK::
|
1349
|
+
# @param overwrite_rate [MetronomeSDK::V1::ContractCreateParams::Override::OverwriteRate] Required for OVERWRITE type.
|
1547
1350
|
#
|
1548
1351
|
# @param priority [Float] Required for EXPLICIT multiplier prioritization scheme and all TIERED overrides.
|
1549
|
-
# ...
|
1550
1352
|
#
|
1551
1353
|
# @param product_id [String] ID of the product whose rate is being overridden. Cannot be used in conjunction
|
1552
|
-
# ...
|
1553
1354
|
#
|
1554
|
-
# @param target [Symbol, MetronomeSDK::
|
1555
|
-
# ...
|
1355
|
+
# @param target [Symbol, MetronomeSDK::V1::ContractCreateParams::Override::Target] Indicates whether the override applies to commit rates or list rates. Can only b
|
1556
1356
|
#
|
1557
|
-
# @param tiers [Array<MetronomeSDK::
|
1357
|
+
# @param tiers [Array<MetronomeSDK::V1::ContractCreateParams::Override::Tier>] Required for TIERED type. Must have at least one tier.
|
1558
1358
|
#
|
1559
|
-
# @param type [Symbol, MetronomeSDK::
|
1359
|
+
# @param type [Symbol, MetronomeSDK::V1::ContractCreateParams::Override::Type] Overwrites are prioritized over multipliers and tiered overrides.
|
1560
1360
|
|
1561
1361
|
class OverrideSpecifier < MetronomeSDK::Internal::Type::BaseModel
|
1562
1362
|
# @!attribute commit_ids
|
@@ -1615,37 +1415,31 @@ module MetronomeSDK
|
|
1615
1415
|
|
1616
1416
|
# @!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)
|
1617
1417
|
# Some parameter documentations has been truncated, see
|
1618
|
-
# {MetronomeSDK::
|
1619
|
-
#
|
1418
|
+
# {MetronomeSDK::V1::ContractCreateParams::Override::OverrideSpecifier} for more
|
1419
|
+
# details.
|
1620
1420
|
#
|
1621
1421
|
# @param commit_ids [Array<String>] Can only be used for commit specific overrides. Must be used in conjunction with
|
1622
|
-
# ...
|
1623
1422
|
#
|
1624
1423
|
# @param presentation_group_values [Hash{Symbol=>String}] A map of group names to values. The override will only apply to line items with
|
1625
|
-
# ...
|
1626
1424
|
#
|
1627
1425
|
# @param pricing_group_values [Hash{Symbol=>String}] A map of pricing group names to values. The override will only apply to products
|
1628
|
-
# ...
|
1629
1426
|
#
|
1630
1427
|
# @param product_id [String] If provided, the override will only apply to the product with the specified ID.
|
1631
1428
|
#
|
1632
1429
|
# @param product_tags [Array<String>] If provided, the override will only apply to products with all the specified tag
|
1633
|
-
# ...
|
1634
1430
|
#
|
1635
1431
|
# @param recurring_commit_ids [Array<String>] Can only be used for commit specific overrides. Must be used in conjunction with
|
1636
|
-
# ...
|
1637
1432
|
#
|
1638
1433
|
# @param recurring_credit_ids [Array<String>] Can only be used for commit specific overrides. Must be used in conjunction with
|
1639
|
-
# ...
|
1640
1434
|
end
|
1641
1435
|
|
1642
|
-
# @see MetronomeSDK::
|
1436
|
+
# @see MetronomeSDK::V1::ContractCreateParams::Override#overwrite_rate
|
1643
1437
|
class OverwriteRate < MetronomeSDK::Internal::Type::BaseModel
|
1644
1438
|
# @!attribute rate_type
|
1645
1439
|
#
|
1646
|
-
# @return [Symbol, MetronomeSDK::
|
1440
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::Override::OverwriteRate::RateType]
|
1647
1441
|
required :rate_type,
|
1648
|
-
enum: -> { MetronomeSDK::
|
1442
|
+
enum: -> { MetronomeSDK::V1::ContractCreateParams::Override::OverwriteRate::RateType }
|
1649
1443
|
|
1650
1444
|
# @!attribute credit_type_id
|
1651
1445
|
#
|
@@ -1682,34 +1476,31 @@ module MetronomeSDK
|
|
1682
1476
|
# @!attribute tiers
|
1683
1477
|
# Only set for TIERED rate_type.
|
1684
1478
|
#
|
1685
|
-
# @return [Array<MetronomeSDK::
|
1686
|
-
optional :tiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::
|
1479
|
+
# @return [Array<MetronomeSDK::Tier>, nil]
|
1480
|
+
optional :tiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Tier] }
|
1687
1481
|
|
1688
1482
|
# @!method initialize(rate_type:, credit_type_id: nil, custom_rate: nil, is_prorated: nil, price: nil, quantity: nil, tiers: nil)
|
1689
1483
|
# Some parameter documentations has been truncated, see
|
1690
|
-
# {MetronomeSDK::
|
1691
|
-
#
|
1484
|
+
# {MetronomeSDK::V1::ContractCreateParams::Override::OverwriteRate} for more
|
1485
|
+
# details.
|
1692
1486
|
#
|
1693
1487
|
# Required for OVERWRITE type.
|
1694
1488
|
#
|
1695
|
-
# @param rate_type [Symbol, MetronomeSDK::
|
1489
|
+
# @param rate_type [Symbol, MetronomeSDK::V1::ContractCreateParams::Override::OverwriteRate::RateType]
|
1696
1490
|
#
|
1697
1491
|
# @param credit_type_id [String]
|
1698
1492
|
#
|
1699
1493
|
# @param custom_rate [Hash{Symbol=>Object}] Only set for CUSTOM rate_type. This field is interpreted by custom rate processo
|
1700
|
-
# ...
|
1701
1494
|
#
|
1702
1495
|
# @param is_prorated [Boolean] Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
|
1703
|
-
# ...
|
1704
1496
|
#
|
1705
1497
|
# @param price [Float] Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type, t
|
1706
|
-
# ...
|
1707
1498
|
#
|
1708
1499
|
# @param quantity [Float] Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
|
1709
1500
|
#
|
1710
|
-
# @param tiers [Array<MetronomeSDK::
|
1501
|
+
# @param tiers [Array<MetronomeSDK::Tier>] Only set for TIERED rate_type.
|
1711
1502
|
|
1712
|
-
# @see MetronomeSDK::
|
1503
|
+
# @see MetronomeSDK::V1::ContractCreateParams::Override::OverwriteRate#rate_type
|
1713
1504
|
module RateType
|
1714
1505
|
extend MetronomeSDK::Internal::Type::Enum
|
1715
1506
|
|
@@ -1728,7 +1519,7 @@ module MetronomeSDK
|
|
1728
1519
|
# be used for overrides that have `is_commit_specific` set to `true`. Defaults to
|
1729
1520
|
# `"LIST_RATE"`.
|
1730
1521
|
#
|
1731
|
-
# @see MetronomeSDK::
|
1522
|
+
# @see MetronomeSDK::V1::ContractCreateParams::Override#target
|
1732
1523
|
module Target
|
1733
1524
|
extend MetronomeSDK::Internal::Type::Enum
|
1734
1525
|
|
@@ -1757,7 +1548,7 @@ module MetronomeSDK
|
|
1757
1548
|
|
1758
1549
|
# Overwrites are prioritized over multipliers and tiered overrides.
|
1759
1550
|
#
|
1760
|
-
# @see MetronomeSDK::
|
1551
|
+
# @see MetronomeSDK::V1::ContractCreateParams::Override#type
|
1761
1552
|
module Type
|
1762
1553
|
extend MetronomeSDK::Internal::Type::Enum
|
1763
1554
|
|
@@ -1770,6 +1561,218 @@ module MetronomeSDK
|
|
1770
1561
|
end
|
1771
1562
|
end
|
1772
1563
|
|
1564
|
+
class PrepaidBalanceThresholdConfiguration < MetronomeSDK::Internal::Type::BaseModel
|
1565
|
+
# @!attribute commit
|
1566
|
+
#
|
1567
|
+
# @return [MetronomeSDK::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration::Commit]
|
1568
|
+
required :commit,
|
1569
|
+
-> { MetronomeSDK::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration::Commit }
|
1570
|
+
|
1571
|
+
# @!attribute is_enabled
|
1572
|
+
# When set to false, the contract will not be evaluated against the
|
1573
|
+
# threshold_amount. Toggling to true will result an immediate evaluation,
|
1574
|
+
# regardless of prior state.
|
1575
|
+
#
|
1576
|
+
# @return [Boolean]
|
1577
|
+
required :is_enabled, MetronomeSDK::Internal::Type::Boolean
|
1578
|
+
|
1579
|
+
# @!attribute payment_gate_config
|
1580
|
+
#
|
1581
|
+
# @return [MetronomeSDK::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration::PaymentGateConfig]
|
1582
|
+
required :payment_gate_config,
|
1583
|
+
-> {
|
1584
|
+
MetronomeSDK::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration::PaymentGateConfig
|
1585
|
+
}
|
1586
|
+
|
1587
|
+
# @!attribute recharge_to_amount
|
1588
|
+
# Specify the amount the balance should be recharged to.
|
1589
|
+
#
|
1590
|
+
# @return [Float]
|
1591
|
+
required :recharge_to_amount, Float
|
1592
|
+
|
1593
|
+
# @!attribute threshold_amount
|
1594
|
+
# Specify the threshold amount for the contract. Each time the contract's prepaid
|
1595
|
+
# balance lowers to this amount, a threshold charge will be initiated.
|
1596
|
+
#
|
1597
|
+
# @return [Float]
|
1598
|
+
required :threshold_amount, Float
|
1599
|
+
|
1600
|
+
# @!method initialize(commit:, is_enabled:, payment_gate_config:, recharge_to_amount:, threshold_amount:)
|
1601
|
+
# Some parameter documentations has been truncated, see
|
1602
|
+
# {MetronomeSDK::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration}
|
1603
|
+
# for more details.
|
1604
|
+
#
|
1605
|
+
# @param commit [MetronomeSDK::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration::Commit]
|
1606
|
+
#
|
1607
|
+
# @param is_enabled [Boolean] When set to false, the contract will not be evaluated against the threshold_amou
|
1608
|
+
#
|
1609
|
+
# @param payment_gate_config [MetronomeSDK::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration::PaymentGateConfig]
|
1610
|
+
#
|
1611
|
+
# @param recharge_to_amount [Float] Specify the amount the balance should be recharged to.
|
1612
|
+
#
|
1613
|
+
# @param threshold_amount [Float] Specify the threshold amount for the contract. Each time the contract's prepaid
|
1614
|
+
|
1615
|
+
# @see MetronomeSDK::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration#commit
|
1616
|
+
class Commit < MetronomeSDK::Internal::Type::BaseModel
|
1617
|
+
# @!attribute product_id
|
1618
|
+
# The commit product that will be used to generate the line item for commit
|
1619
|
+
# payment.
|
1620
|
+
#
|
1621
|
+
# @return [String]
|
1622
|
+
required :product_id, String
|
1623
|
+
|
1624
|
+
# @!attribute applicable_product_ids
|
1625
|
+
# Which products the threshold commit applies to. If both applicable_product_ids
|
1626
|
+
# and applicable_product_tags are not provided, the commit applies to all
|
1627
|
+
# products.
|
1628
|
+
#
|
1629
|
+
# @return [Array<String>, nil]
|
1630
|
+
optional :applicable_product_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
|
1631
|
+
|
1632
|
+
# @!attribute applicable_product_tags
|
1633
|
+
# Which tags the threshold commit applies to. If both applicable_product_ids and
|
1634
|
+
# applicable_product_tags are not provided, the commit applies to all products.
|
1635
|
+
#
|
1636
|
+
# @return [Array<String>, nil]
|
1637
|
+
optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
|
1638
|
+
|
1639
|
+
# @!attribute description
|
1640
|
+
#
|
1641
|
+
# @return [String, nil]
|
1642
|
+
optional :description, String
|
1643
|
+
|
1644
|
+
# @!attribute name
|
1645
|
+
# Specify the name of the line item for the threshold charge. If left blank, it
|
1646
|
+
# will default to the commit product name.
|
1647
|
+
#
|
1648
|
+
# @return [String, nil]
|
1649
|
+
optional :name, String
|
1650
|
+
|
1651
|
+
# @!method initialize(product_id:, applicable_product_ids: nil, applicable_product_tags: nil, description: nil, name: nil)
|
1652
|
+
# Some parameter documentations has been truncated, see
|
1653
|
+
# {MetronomeSDK::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration::Commit}
|
1654
|
+
# for more details.
|
1655
|
+
#
|
1656
|
+
# @param product_id [String] The commit product that will be used to generate the line item for commit paymen
|
1657
|
+
#
|
1658
|
+
# @param applicable_product_ids [Array<String>] Which products the threshold commit applies to. If both applicable_product_ids a
|
1659
|
+
#
|
1660
|
+
# @param applicable_product_tags [Array<String>] Which tags the threshold commit applies to. If both applicable_product_ids and a
|
1661
|
+
#
|
1662
|
+
# @param description [String]
|
1663
|
+
#
|
1664
|
+
# @param name [String] Specify the name of the line item for the threshold charge. If left blank, it wi
|
1665
|
+
end
|
1666
|
+
|
1667
|
+
# @see MetronomeSDK::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration#payment_gate_config
|
1668
|
+
class PaymentGateConfig < MetronomeSDK::Internal::Type::BaseModel
|
1669
|
+
# @!attribute payment_gate_type
|
1670
|
+
# Gate access to the commit balance based on successful collection of payment.
|
1671
|
+
# Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
|
1672
|
+
# facilitate payment using your own payment integration. Select NONE if you do not
|
1673
|
+
# wish to payment gate the commit balance.
|
1674
|
+
#
|
1675
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::PaymentGateType]
|
1676
|
+
required :payment_gate_type,
|
1677
|
+
enum: -> {
|
1678
|
+
MetronomeSDK::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::PaymentGateType
|
1679
|
+
}
|
1680
|
+
|
1681
|
+
# @!attribute stripe_config
|
1682
|
+
# Only applicable if using Stripe as your payment gateway through Metronome.
|
1683
|
+
#
|
1684
|
+
# @return [MetronomeSDK::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig, nil]
|
1685
|
+
optional :stripe_config,
|
1686
|
+
-> {
|
1687
|
+
MetronomeSDK::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig
|
1688
|
+
}
|
1689
|
+
|
1690
|
+
# @!attribute tax_type
|
1691
|
+
# Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
|
1692
|
+
# not wish Metronome to calculate tax on your behalf. Leaving this field blank
|
1693
|
+
# will default to NONE.
|
1694
|
+
#
|
1695
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::TaxType, nil]
|
1696
|
+
optional :tax_type,
|
1697
|
+
enum: -> {
|
1698
|
+
MetronomeSDK::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::TaxType
|
1699
|
+
}
|
1700
|
+
|
1701
|
+
# @!method initialize(payment_gate_type:, stripe_config: nil, tax_type: nil)
|
1702
|
+
# Some parameter documentations has been truncated, see
|
1703
|
+
# {MetronomeSDK::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration::PaymentGateConfig}
|
1704
|
+
# for more details.
|
1705
|
+
#
|
1706
|
+
# @param payment_gate_type [Symbol, MetronomeSDK::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::PaymentGateType] Gate access to the commit balance based on successful collection of payment. Sel
|
1707
|
+
#
|
1708
|
+
# @param stripe_config [MetronomeSDK::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig] Only applicable if using Stripe as your payment gateway through Metronome.
|
1709
|
+
#
|
1710
|
+
# @param tax_type [Symbol, MetronomeSDK::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::TaxType] Stripe tax is only supported for Stripe payment gateway. Select NONE if you do n
|
1711
|
+
|
1712
|
+
# Gate access to the commit balance based on successful collection of payment.
|
1713
|
+
# Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
|
1714
|
+
# facilitate payment using your own payment integration. Select NONE if you do not
|
1715
|
+
# wish to payment gate the commit balance.
|
1716
|
+
#
|
1717
|
+
# @see MetronomeSDK::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration::PaymentGateConfig#payment_gate_type
|
1718
|
+
module PaymentGateType
|
1719
|
+
extend MetronomeSDK::Internal::Type::Enum
|
1720
|
+
|
1721
|
+
NONE = :NONE
|
1722
|
+
STRIPE = :STRIPE
|
1723
|
+
EXTERNAL = :EXTERNAL
|
1724
|
+
|
1725
|
+
# @!method self.values
|
1726
|
+
# @return [Array<Symbol>]
|
1727
|
+
end
|
1728
|
+
|
1729
|
+
# @see MetronomeSDK::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration::PaymentGateConfig#stripe_config
|
1730
|
+
class StripeConfig < MetronomeSDK::Internal::Type::BaseModel
|
1731
|
+
# @!attribute payment_type
|
1732
|
+
# If left blank, will default to INVOICE
|
1733
|
+
#
|
1734
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType]
|
1735
|
+
required :payment_type,
|
1736
|
+
enum: -> {
|
1737
|
+
MetronomeSDK::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType
|
1738
|
+
}
|
1739
|
+
|
1740
|
+
# @!method initialize(payment_type:)
|
1741
|
+
# Only applicable if using Stripe as your payment gateway through Metronome.
|
1742
|
+
#
|
1743
|
+
# @param payment_type [Symbol, MetronomeSDK::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType] If left blank, will default to INVOICE
|
1744
|
+
|
1745
|
+
# If left blank, will default to INVOICE
|
1746
|
+
#
|
1747
|
+
# @see MetronomeSDK::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig#payment_type
|
1748
|
+
module PaymentType
|
1749
|
+
extend MetronomeSDK::Internal::Type::Enum
|
1750
|
+
|
1751
|
+
INVOICE = :INVOICE
|
1752
|
+
PAYMENT_INTENT = :PAYMENT_INTENT
|
1753
|
+
|
1754
|
+
# @!method self.values
|
1755
|
+
# @return [Array<Symbol>]
|
1756
|
+
end
|
1757
|
+
end
|
1758
|
+
|
1759
|
+
# Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
|
1760
|
+
# not wish Metronome to calculate tax on your behalf. Leaving this field blank
|
1761
|
+
# will default to NONE.
|
1762
|
+
#
|
1763
|
+
# @see MetronomeSDK::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration::PaymentGateConfig#tax_type
|
1764
|
+
module TaxType
|
1765
|
+
extend MetronomeSDK::Internal::Type::Enum
|
1766
|
+
|
1767
|
+
NONE = :NONE
|
1768
|
+
STRIPE = :STRIPE
|
1769
|
+
|
1770
|
+
# @!method self.values
|
1771
|
+
# @return [Array<Symbol>]
|
1772
|
+
end
|
1773
|
+
end
|
1774
|
+
end
|
1775
|
+
|
1773
1776
|
class ProfessionalService < MetronomeSDK::Internal::Type::BaseModel
|
1774
1777
|
# @!attribute max_amount
|
1775
1778
|
# Maximum amount for the term.
|
@@ -1814,18 +1817,15 @@ module MetronomeSDK
|
|
1814
1817
|
|
1815
1818
|
# @!method initialize(max_amount:, product_id:, quantity:, unit_price:, custom_fields: nil, description: nil, netsuite_sales_order_id: nil)
|
1816
1819
|
# Some parameter documentations has been truncated, see
|
1817
|
-
# {MetronomeSDK::
|
1818
|
-
# details.
|
1820
|
+
# {MetronomeSDK::V1::ContractCreateParams::ProfessionalService} for more details.
|
1819
1821
|
#
|
1820
1822
|
# @param max_amount [Float] Maximum amount for the term.
|
1821
1823
|
#
|
1822
1824
|
# @param product_id [String]
|
1823
1825
|
#
|
1824
1826
|
# @param quantity [Float] Quantity for the charge. Will be multiplied by unit_price to determine the amoun
|
1825
|
-
# ...
|
1826
1827
|
#
|
1827
1828
|
# @param unit_price [Float] Unit price for the charge. Will be multiplied by quantity to determine the amoun
|
1828
|
-
# ...
|
1829
1829
|
#
|
1830
1830
|
# @param custom_fields [Hash{Symbol=>String}]
|
1831
1831
|
#
|
@@ -1838,16 +1838,20 @@ module MetronomeSDK
|
|
1838
1838
|
# @!attribute access_amount
|
1839
1839
|
# The amount of commit to grant.
|
1840
1840
|
#
|
1841
|
-
# @return [MetronomeSDK::
|
1841
|
+
# @return [MetronomeSDK::V1::ContractCreateParams::RecurringCommit::AccessAmount]
|
1842
1842
|
required :access_amount,
|
1843
|
-
-> {
|
1843
|
+
-> {
|
1844
|
+
MetronomeSDK::V1::ContractCreateParams::RecurringCommit::AccessAmount
|
1845
|
+
}
|
1844
1846
|
|
1845
1847
|
# @!attribute commit_duration
|
1846
1848
|
# The amount of time the created commits will be valid for.
|
1847
1849
|
#
|
1848
|
-
# @return [MetronomeSDK::
|
1850
|
+
# @return [MetronomeSDK::V1::ContractCreateParams::RecurringCommit::CommitDuration]
|
1849
1851
|
required :commit_duration,
|
1850
|
-
-> {
|
1852
|
+
-> {
|
1853
|
+
MetronomeSDK::V1::ContractCreateParams::RecurringCommit::CommitDuration
|
1854
|
+
}
|
1851
1855
|
|
1852
1856
|
# @!attribute priority
|
1853
1857
|
# Will be passed down to the individual commits
|
@@ -1893,9 +1897,11 @@ module MetronomeSDK
|
|
1893
1897
|
# @!attribute invoice_amount
|
1894
1898
|
# The amount the customer should be billed for the commit. Not required.
|
1895
1899
|
#
|
1896
|
-
# @return [MetronomeSDK::
|
1900
|
+
# @return [MetronomeSDK::V1::ContractCreateParams::RecurringCommit::InvoiceAmount, nil]
|
1897
1901
|
optional :invoice_amount,
|
1898
|
-
-> {
|
1902
|
+
-> {
|
1903
|
+
MetronomeSDK::V1::ContractCreateParams::RecurringCommit::InvoiceAmount
|
1904
|
+
}
|
1899
1905
|
|
1900
1906
|
# @!attribute name
|
1901
1907
|
# displayed on invoices. will be passed through to the individual commits
|
@@ -1913,16 +1919,14 @@ module MetronomeSDK
|
|
1913
1919
|
# Determines whether the first and last commit will be prorated. If not provided,
|
1914
1920
|
# the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).
|
1915
1921
|
#
|
1916
|
-
# @return [Symbol, MetronomeSDK::
|
1917
|
-
optional :proration,
|
1918
|
-
enum: -> { MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit::Proration }
|
1922
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::RecurringCommit::Proration, nil]
|
1923
|
+
optional :proration, enum: -> { MetronomeSDK::V1::ContractCreateParams::RecurringCommit::Proration }
|
1919
1924
|
|
1920
1925
|
# @!attribute rate_type
|
1921
1926
|
# Whether the created commits will use the commit rate or list rate
|
1922
1927
|
#
|
1923
|
-
# @return [Symbol, MetronomeSDK::
|
1924
|
-
optional :rate_type,
|
1925
|
-
enum: -> { MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit::RateType }
|
1928
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::RecurringCommit::RateType, nil]
|
1929
|
+
optional :rate_type, enum: -> { MetronomeSDK::V1::ContractCreateParams::RecurringCommit::RateType }
|
1926
1930
|
|
1927
1931
|
# @!attribute recurrence_frequency
|
1928
1932
|
# The frequency at which the recurring commits will be created. If not provided: -
|
@@ -1931,9 +1935,9 @@ module MetronomeSDK
|
|
1931
1935
|
# be created aligned with the recurring commit's start_date rather than the usage
|
1932
1936
|
# invoice dates.
|
1933
1937
|
#
|
1934
|
-
# @return [Symbol, MetronomeSDK::
|
1938
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::RecurringCommit::RecurrenceFrequency, nil]
|
1935
1939
|
optional :recurrence_frequency,
|
1936
|
-
enum: -> { MetronomeSDK::
|
1940
|
+
enum: -> { MetronomeSDK::V1::ContractCreateParams::RecurringCommit::RecurrenceFrequency }
|
1937
1941
|
|
1938
1942
|
# @!attribute rollover_fraction
|
1939
1943
|
# Will be passed down to the individual commits. This controls how much of an
|
@@ -1952,12 +1956,11 @@ module MetronomeSDK
|
|
1952
1956
|
|
1953
1957
|
# @!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)
|
1954
1958
|
# Some parameter documentations has been truncated, see
|
1955
|
-
# {MetronomeSDK::
|
1956
|
-
# details.
|
1959
|
+
# {MetronomeSDK::V1::ContractCreateParams::RecurringCommit} for more details.
|
1957
1960
|
#
|
1958
|
-
# @param access_amount [MetronomeSDK::
|
1961
|
+
# @param access_amount [MetronomeSDK::V1::ContractCreateParams::RecurringCommit::AccessAmount] The amount of commit to grant.
|
1959
1962
|
#
|
1960
|
-
# @param commit_duration [MetronomeSDK::
|
1963
|
+
# @param commit_duration [MetronomeSDK::V1::ContractCreateParams::RecurringCommit::CommitDuration] The amount of time the created commits will be valid for.
|
1961
1964
|
#
|
1962
1965
|
# @param priority [Float] Will be passed down to the individual commits
|
1963
1966
|
#
|
@@ -1973,27 +1976,23 @@ module MetronomeSDK
|
|
1973
1976
|
#
|
1974
1977
|
# @param ending_before [Time] Determines when the contract will stop creating recurring commits. optional
|
1975
1978
|
#
|
1976
|
-
# @param invoice_amount [MetronomeSDK::
|
1979
|
+
# @param invoice_amount [MetronomeSDK::V1::ContractCreateParams::RecurringCommit::InvoiceAmount] The amount the customer should be billed for the commit. Not required.
|
1977
1980
|
#
|
1978
1981
|
# @param name [String] displayed on invoices. will be passed through to the individual commits
|
1979
1982
|
#
|
1980
1983
|
# @param netsuite_sales_order_id [String] Will be passed down to the individual commits
|
1981
1984
|
#
|
1982
|
-
# @param proration [Symbol, MetronomeSDK::
|
1983
|
-
# ...
|
1985
|
+
# @param proration [Symbol, MetronomeSDK::V1::ContractCreateParams::RecurringCommit::Proration] Determines whether the first and last commit will be prorated. If not provided,
|
1984
1986
|
#
|
1985
|
-
# @param rate_type [Symbol, MetronomeSDK::
|
1987
|
+
# @param rate_type [Symbol, MetronomeSDK::V1::ContractCreateParams::RecurringCommit::RateType] Whether the created commits will use the commit rate or list rate
|
1986
1988
|
#
|
1987
|
-
# @param recurrence_frequency [Symbol, MetronomeSDK::
|
1988
|
-
# ...
|
1989
|
+
# @param recurrence_frequency [Symbol, MetronomeSDK::V1::ContractCreateParams::RecurringCommit::RecurrenceFrequency] The frequency at which the recurring commits will be created. If not provided:
|
1989
1990
|
#
|
1990
1991
|
# @param rollover_fraction [Float] Will be passed down to the individual commits. This controls how much of an indi
|
1991
|
-
# ...
|
1992
1992
|
#
|
1993
1993
|
# @param temporary_id [String] A temporary ID that can be used to reference the recurring commit for commit spe
|
1994
|
-
# ...
|
1995
1994
|
|
1996
|
-
# @see MetronomeSDK::
|
1995
|
+
# @see MetronomeSDK::V1::ContractCreateParams::RecurringCommit#access_amount
|
1997
1996
|
class AccessAmount < MetronomeSDK::Internal::Type::BaseModel
|
1998
1997
|
# @!attribute credit_type_id
|
1999
1998
|
#
|
@@ -2018,13 +2017,15 @@ module MetronomeSDK
|
|
2018
2017
|
# @param unit_price [Float]
|
2019
2018
|
end
|
2020
2019
|
|
2021
|
-
# @see MetronomeSDK::
|
2020
|
+
# @see MetronomeSDK::V1::ContractCreateParams::RecurringCommit#commit_duration
|
2022
2021
|
class CommitDuration < MetronomeSDK::Internal::Type::BaseModel
|
2023
2022
|
# @!attribute unit
|
2024
2023
|
#
|
2025
|
-
# @return [Symbol, MetronomeSDK::
|
2024
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::RecurringCommit::CommitDuration::Unit]
|
2026
2025
|
required :unit,
|
2027
|
-
enum: -> {
|
2026
|
+
enum: -> {
|
2027
|
+
MetronomeSDK::V1::ContractCreateParams::RecurringCommit::CommitDuration::Unit
|
2028
|
+
}
|
2028
2029
|
|
2029
2030
|
# @!attribute value
|
2030
2031
|
#
|
@@ -2034,10 +2035,10 @@ module MetronomeSDK
|
|
2034
2035
|
# @!method initialize(unit:, value:)
|
2035
2036
|
# The amount of time the created commits will be valid for.
|
2036
2037
|
#
|
2037
|
-
# @param unit [Symbol, MetronomeSDK::
|
2038
|
+
# @param unit [Symbol, MetronomeSDK::V1::ContractCreateParams::RecurringCommit::CommitDuration::Unit]
|
2038
2039
|
# @param value [Float]
|
2039
2040
|
|
2040
|
-
# @see MetronomeSDK::
|
2041
|
+
# @see MetronomeSDK::V1::ContractCreateParams::RecurringCommit::CommitDuration#unit
|
2041
2042
|
module Unit
|
2042
2043
|
extend MetronomeSDK::Internal::Type::Enum
|
2043
2044
|
|
@@ -2048,7 +2049,7 @@ module MetronomeSDK
|
|
2048
2049
|
end
|
2049
2050
|
end
|
2050
2051
|
|
2051
|
-
# @see MetronomeSDK::
|
2052
|
+
# @see MetronomeSDK::V1::ContractCreateParams::RecurringCommit#invoice_amount
|
2052
2053
|
class InvoiceAmount < MetronomeSDK::Internal::Type::BaseModel
|
2053
2054
|
# @!attribute credit_type_id
|
2054
2055
|
#
|
@@ -2076,7 +2077,7 @@ module MetronomeSDK
|
|
2076
2077
|
# Determines whether the first and last commit will be prorated. If not provided,
|
2077
2078
|
# the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).
|
2078
2079
|
#
|
2079
|
-
# @see MetronomeSDK::
|
2080
|
+
# @see MetronomeSDK::V1::ContractCreateParams::RecurringCommit#proration
|
2080
2081
|
module Proration
|
2081
2082
|
extend MetronomeSDK::Internal::Type::Enum
|
2082
2083
|
|
@@ -2091,7 +2092,7 @@ module MetronomeSDK
|
|
2091
2092
|
|
2092
2093
|
# Whether the created commits will use the commit rate or list rate
|
2093
2094
|
#
|
2094
|
-
# @see MetronomeSDK::
|
2095
|
+
# @see MetronomeSDK::V1::ContractCreateParams::RecurringCommit#rate_type
|
2095
2096
|
module RateType
|
2096
2097
|
extend MetronomeSDK::Internal::Type::Enum
|
2097
2098
|
|
@@ -2108,7 +2109,7 @@ module MetronomeSDK
|
|
2108
2109
|
# be created aligned with the recurring commit's start_date rather than the usage
|
2109
2110
|
# invoice dates.
|
2110
2111
|
#
|
2111
|
-
# @see MetronomeSDK::
|
2112
|
+
# @see MetronomeSDK::V1::ContractCreateParams::RecurringCommit#recurrence_frequency
|
2112
2113
|
module RecurrenceFrequency
|
2113
2114
|
extend MetronomeSDK::Internal::Type::Enum
|
2114
2115
|
|
@@ -2126,16 +2127,20 @@ module MetronomeSDK
|
|
2126
2127
|
# @!attribute access_amount
|
2127
2128
|
# The amount of commit to grant.
|
2128
2129
|
#
|
2129
|
-
# @return [MetronomeSDK::
|
2130
|
+
# @return [MetronomeSDK::V1::ContractCreateParams::RecurringCredit::AccessAmount]
|
2130
2131
|
required :access_amount,
|
2131
|
-
-> {
|
2132
|
+
-> {
|
2133
|
+
MetronomeSDK::V1::ContractCreateParams::RecurringCredit::AccessAmount
|
2134
|
+
}
|
2132
2135
|
|
2133
2136
|
# @!attribute commit_duration
|
2134
2137
|
# The amount of time the created commits will be valid for.
|
2135
2138
|
#
|
2136
|
-
# @return [MetronomeSDK::
|
2139
|
+
# @return [MetronomeSDK::V1::ContractCreateParams::RecurringCredit::CommitDuration]
|
2137
2140
|
required :commit_duration,
|
2138
|
-
-> {
|
2141
|
+
-> {
|
2142
|
+
MetronomeSDK::V1::ContractCreateParams::RecurringCredit::CommitDuration
|
2143
|
+
}
|
2139
2144
|
|
2140
2145
|
# @!attribute priority
|
2141
2146
|
# Will be passed down to the individual commits
|
@@ -2194,16 +2199,14 @@ module MetronomeSDK
|
|
2194
2199
|
# Determines whether the first and last commit will be prorated. If not provided,
|
2195
2200
|
# the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).
|
2196
2201
|
#
|
2197
|
-
# @return [Symbol, MetronomeSDK::
|
2198
|
-
optional :proration,
|
2199
|
-
enum: -> { MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit::Proration }
|
2202
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::RecurringCredit::Proration, nil]
|
2203
|
+
optional :proration, enum: -> { MetronomeSDK::V1::ContractCreateParams::RecurringCredit::Proration }
|
2200
2204
|
|
2201
2205
|
# @!attribute rate_type
|
2202
2206
|
# Whether the created commits will use the commit rate or list rate
|
2203
2207
|
#
|
2204
|
-
# @return [Symbol, MetronomeSDK::
|
2205
|
-
optional :rate_type,
|
2206
|
-
enum: -> { MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit::RateType }
|
2208
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::RecurringCredit::RateType, nil]
|
2209
|
+
optional :rate_type, enum: -> { MetronomeSDK::V1::ContractCreateParams::RecurringCredit::RateType }
|
2207
2210
|
|
2208
2211
|
# @!attribute recurrence_frequency
|
2209
2212
|
# The frequency at which the recurring commits will be created. If not provided: -
|
@@ -2212,9 +2215,9 @@ module MetronomeSDK
|
|
2212
2215
|
# be created aligned with the recurring commit's start_date rather than the usage
|
2213
2216
|
# invoice dates.
|
2214
2217
|
#
|
2215
|
-
# @return [Symbol, MetronomeSDK::
|
2218
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::RecurringCredit::RecurrenceFrequency, nil]
|
2216
2219
|
optional :recurrence_frequency,
|
2217
|
-
enum: -> { MetronomeSDK::
|
2220
|
+
enum: -> { MetronomeSDK::V1::ContractCreateParams::RecurringCredit::RecurrenceFrequency }
|
2218
2221
|
|
2219
2222
|
# @!attribute rollover_fraction
|
2220
2223
|
# Will be passed down to the individual commits. This controls how much of an
|
@@ -2233,12 +2236,11 @@ module MetronomeSDK
|
|
2233
2236
|
|
2234
2237
|
# @!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)
|
2235
2238
|
# Some parameter documentations has been truncated, see
|
2236
|
-
# {MetronomeSDK::
|
2237
|
-
# details.
|
2239
|
+
# {MetronomeSDK::V1::ContractCreateParams::RecurringCredit} for more details.
|
2238
2240
|
#
|
2239
|
-
# @param access_amount [MetronomeSDK::
|
2241
|
+
# @param access_amount [MetronomeSDK::V1::ContractCreateParams::RecurringCredit::AccessAmount] The amount of commit to grant.
|
2240
2242
|
#
|
2241
|
-
# @param commit_duration [MetronomeSDK::
|
2243
|
+
# @param commit_duration [MetronomeSDK::V1::ContractCreateParams::RecurringCredit::CommitDuration] The amount of time the created commits will be valid for.
|
2242
2244
|
#
|
2243
2245
|
# @param priority [Float] Will be passed down to the individual commits
|
2244
2246
|
#
|
@@ -2258,21 +2260,17 @@ module MetronomeSDK
|
|
2258
2260
|
#
|
2259
2261
|
# @param netsuite_sales_order_id [String] Will be passed down to the individual commits
|
2260
2262
|
#
|
2261
|
-
# @param proration [Symbol, MetronomeSDK::
|
2262
|
-
# ...
|
2263
|
+
# @param proration [Symbol, MetronomeSDK::V1::ContractCreateParams::RecurringCredit::Proration] Determines whether the first and last commit will be prorated. If not provided,
|
2263
2264
|
#
|
2264
|
-
# @param rate_type [Symbol, MetronomeSDK::
|
2265
|
+
# @param rate_type [Symbol, MetronomeSDK::V1::ContractCreateParams::RecurringCredit::RateType] Whether the created commits will use the commit rate or list rate
|
2265
2266
|
#
|
2266
|
-
# @param recurrence_frequency [Symbol, MetronomeSDK::
|
2267
|
-
# ...
|
2267
|
+
# @param recurrence_frequency [Symbol, MetronomeSDK::V1::ContractCreateParams::RecurringCredit::RecurrenceFrequency] The frequency at which the recurring commits will be created. If not provided:
|
2268
2268
|
#
|
2269
2269
|
# @param rollover_fraction [Float] Will be passed down to the individual commits. This controls how much of an indi
|
2270
|
-
# ...
|
2271
2270
|
#
|
2272
2271
|
# @param temporary_id [String] A temporary ID that can be used to reference the recurring commit for commit spe
|
2273
|
-
# ...
|
2274
2272
|
|
2275
|
-
# @see MetronomeSDK::
|
2273
|
+
# @see MetronomeSDK::V1::ContractCreateParams::RecurringCredit#access_amount
|
2276
2274
|
class AccessAmount < MetronomeSDK::Internal::Type::BaseModel
|
2277
2275
|
# @!attribute credit_type_id
|
2278
2276
|
#
|
@@ -2297,13 +2295,15 @@ module MetronomeSDK
|
|
2297
2295
|
# @param unit_price [Float]
|
2298
2296
|
end
|
2299
2297
|
|
2300
|
-
# @see MetronomeSDK::
|
2298
|
+
# @see MetronomeSDK::V1::ContractCreateParams::RecurringCredit#commit_duration
|
2301
2299
|
class CommitDuration < MetronomeSDK::Internal::Type::BaseModel
|
2302
2300
|
# @!attribute unit
|
2303
2301
|
#
|
2304
|
-
# @return [Symbol, MetronomeSDK::
|
2302
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::RecurringCredit::CommitDuration::Unit]
|
2305
2303
|
required :unit,
|
2306
|
-
enum: -> {
|
2304
|
+
enum: -> {
|
2305
|
+
MetronomeSDK::V1::ContractCreateParams::RecurringCredit::CommitDuration::Unit
|
2306
|
+
}
|
2307
2307
|
|
2308
2308
|
# @!attribute value
|
2309
2309
|
#
|
@@ -2313,10 +2313,10 @@ module MetronomeSDK
|
|
2313
2313
|
# @!method initialize(unit:, value:)
|
2314
2314
|
# The amount of time the created commits will be valid for.
|
2315
2315
|
#
|
2316
|
-
# @param unit [Symbol, MetronomeSDK::
|
2316
|
+
# @param unit [Symbol, MetronomeSDK::V1::ContractCreateParams::RecurringCredit::CommitDuration::Unit]
|
2317
2317
|
# @param value [Float]
|
2318
2318
|
|
2319
|
-
# @see MetronomeSDK::
|
2319
|
+
# @see MetronomeSDK::V1::ContractCreateParams::RecurringCredit::CommitDuration#unit
|
2320
2320
|
module Unit
|
2321
2321
|
extend MetronomeSDK::Internal::Type::Enum
|
2322
2322
|
|
@@ -2330,7 +2330,7 @@ module MetronomeSDK
|
|
2330
2330
|
# Determines whether the first and last commit will be prorated. If not provided,
|
2331
2331
|
# the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).
|
2332
2332
|
#
|
2333
|
-
# @see MetronomeSDK::
|
2333
|
+
# @see MetronomeSDK::V1::ContractCreateParams::RecurringCredit#proration
|
2334
2334
|
module Proration
|
2335
2335
|
extend MetronomeSDK::Internal::Type::Enum
|
2336
2336
|
|
@@ -2345,7 +2345,7 @@ module MetronomeSDK
|
|
2345
2345
|
|
2346
2346
|
# Whether the created commits will use the commit rate or list rate
|
2347
2347
|
#
|
2348
|
-
# @see MetronomeSDK::
|
2348
|
+
# @see MetronomeSDK::V1::ContractCreateParams::RecurringCredit#rate_type
|
2349
2349
|
module RateType
|
2350
2350
|
extend MetronomeSDK::Internal::Type::Enum
|
2351
2351
|
|
@@ -2362,7 +2362,7 @@ module MetronomeSDK
|
|
2362
2362
|
# be created aligned with the recurring commit's start_date rather than the usage
|
2363
2363
|
# invoice dates.
|
2364
2364
|
#
|
2365
|
-
# @see MetronomeSDK::
|
2365
|
+
# @see MetronomeSDK::V1::ContractCreateParams::RecurringCredit#recurrence_frequency
|
2366
2366
|
module RecurrenceFrequency
|
2367
2367
|
extend MetronomeSDK::Internal::Type::Enum
|
2368
2368
|
|
@@ -2389,9 +2389,9 @@ module MetronomeSDK
|
|
2389
2389
|
|
2390
2390
|
# @!attribute reseller_type
|
2391
2391
|
#
|
2392
|
-
# @return [Symbol, MetronomeSDK::
|
2392
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::ResellerRoyalty::ResellerType]
|
2393
2393
|
required :reseller_type,
|
2394
|
-
enum: -> { MetronomeSDK::
|
2394
|
+
enum: -> { MetronomeSDK::V1::ContractCreateParams::ResellerRoyalty::ResellerType }
|
2395
2395
|
|
2396
2396
|
# @!attribute starting_at
|
2397
2397
|
#
|
@@ -2412,8 +2412,8 @@ module MetronomeSDK
|
|
2412
2412
|
|
2413
2413
|
# @!attribute aws_options
|
2414
2414
|
#
|
2415
|
-
# @return [MetronomeSDK::
|
2416
|
-
optional :aws_options, -> { MetronomeSDK::
|
2415
|
+
# @return [MetronomeSDK::V1::ContractCreateParams::ResellerRoyalty::AwsOptions, nil]
|
2416
|
+
optional :aws_options, -> { MetronomeSDK::V1::ContractCreateParams::ResellerRoyalty::AwsOptions }
|
2417
2417
|
|
2418
2418
|
# @!attribute ending_before
|
2419
2419
|
#
|
@@ -2422,8 +2422,8 @@ module MetronomeSDK
|
|
2422
2422
|
|
2423
2423
|
# @!attribute gcp_options
|
2424
2424
|
#
|
2425
|
-
# @return [MetronomeSDK::
|
2426
|
-
optional :gcp_options, -> { MetronomeSDK::
|
2425
|
+
# @return [MetronomeSDK::V1::ContractCreateParams::ResellerRoyalty::GcpOptions, nil]
|
2426
|
+
optional :gcp_options, -> { MetronomeSDK::V1::ContractCreateParams::ResellerRoyalty::GcpOptions }
|
2427
2427
|
|
2428
2428
|
# @!attribute reseller_contract_value
|
2429
2429
|
#
|
@@ -2435,7 +2435,7 @@ module MetronomeSDK
|
|
2435
2435
|
#
|
2436
2436
|
# @param netsuite_reseller_id [String]
|
2437
2437
|
#
|
2438
|
-
# @param reseller_type [Symbol, MetronomeSDK::
|
2438
|
+
# @param reseller_type [Symbol, MetronomeSDK::V1::ContractCreateParams::ResellerRoyalty::ResellerType]
|
2439
2439
|
#
|
2440
2440
|
# @param starting_at [Time]
|
2441
2441
|
#
|
@@ -2443,15 +2443,15 @@ module MetronomeSDK
|
|
2443
2443
|
#
|
2444
2444
|
# @param applicable_product_tags [Array<String>] Must provide at least one of applicable_product_ids or applicable_product_tags.
|
2445
2445
|
#
|
2446
|
-
# @param aws_options [MetronomeSDK::
|
2446
|
+
# @param aws_options [MetronomeSDK::V1::ContractCreateParams::ResellerRoyalty::AwsOptions]
|
2447
2447
|
#
|
2448
2448
|
# @param ending_before [Time]
|
2449
2449
|
#
|
2450
|
-
# @param gcp_options [MetronomeSDK::
|
2450
|
+
# @param gcp_options [MetronomeSDK::V1::ContractCreateParams::ResellerRoyalty::GcpOptions]
|
2451
2451
|
#
|
2452
2452
|
# @param reseller_contract_value [Float]
|
2453
2453
|
|
2454
|
-
# @see MetronomeSDK::
|
2454
|
+
# @see MetronomeSDK::V1::ContractCreateParams::ResellerRoyalty#reseller_type
|
2455
2455
|
module ResellerType
|
2456
2456
|
extend MetronomeSDK::Internal::Type::Enum
|
2457
2457
|
|
@@ -2464,7 +2464,7 @@ module MetronomeSDK
|
|
2464
2464
|
# @return [Array<Symbol>]
|
2465
2465
|
end
|
2466
2466
|
|
2467
|
-
# @see MetronomeSDK::
|
2467
|
+
# @see MetronomeSDK::V1::ContractCreateParams::ResellerRoyalty#aws_options
|
2468
2468
|
class AwsOptions < MetronomeSDK::Internal::Type::BaseModel
|
2469
2469
|
# @!attribute aws_account_number
|
2470
2470
|
#
|
@@ -2487,7 +2487,7 @@ module MetronomeSDK
|
|
2487
2487
|
# @param aws_payer_reference_id [String]
|
2488
2488
|
end
|
2489
2489
|
|
2490
|
-
# @see MetronomeSDK::
|
2490
|
+
# @see MetronomeSDK::V1::ContractCreateParams::ResellerRoyalty#gcp_options
|
2491
2491
|
class GcpOptions < MetronomeSDK::Internal::Type::BaseModel
|
2492
2492
|
# @!attribute gcp_account_id
|
2493
2493
|
#
|
@@ -2514,8 +2514,8 @@ module MetronomeSDK
|
|
2514
2514
|
# @!attribute schedule
|
2515
2515
|
# Must provide either schedule_items or recurring_schedule.
|
2516
2516
|
#
|
2517
|
-
# @return [MetronomeSDK::
|
2518
|
-
required :schedule, -> { MetronomeSDK::
|
2517
|
+
# @return [MetronomeSDK::V1::ContractCreateParams::ScheduledCharge::Schedule]
|
2518
|
+
required :schedule, -> { MetronomeSDK::V1::ContractCreateParams::ScheduledCharge::Schedule }
|
2519
2519
|
|
2520
2520
|
# @!attribute name
|
2521
2521
|
# displayed on invoices
|
@@ -2532,13 +2532,13 @@ module MetronomeSDK
|
|
2532
2532
|
# @!method initialize(product_id:, schedule:, name: nil, netsuite_sales_order_id: nil)
|
2533
2533
|
# @param product_id [String]
|
2534
2534
|
#
|
2535
|
-
# @param schedule [MetronomeSDK::
|
2535
|
+
# @param schedule [MetronomeSDK::V1::ContractCreateParams::ScheduledCharge::Schedule] Must provide either schedule_items or recurring_schedule.
|
2536
2536
|
#
|
2537
2537
|
# @param name [String] displayed on invoices
|
2538
2538
|
#
|
2539
2539
|
# @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
|
2540
2540
|
|
2541
|
-
# @see MetronomeSDK::
|
2541
|
+
# @see MetronomeSDK::V1::ContractCreateParams::ScheduledCharge#schedule
|
2542
2542
|
class Schedule < MetronomeSDK::Internal::Type::BaseModel
|
2543
2543
|
# @!attribute credit_type_id
|
2544
2544
|
# Defaults to USD (cents) if not passed.
|
@@ -2551,38 +2551,43 @@ module MetronomeSDK
|
|
2551
2551
|
# amount. If amount is sent, the unit price is assumed to be the amount and
|
2552
2552
|
# quantity is inferred to be 1.
|
2553
2553
|
#
|
2554
|
-
# @return [MetronomeSDK::
|
2554
|
+
# @return [MetronomeSDK::V1::ContractCreateParams::ScheduledCharge::Schedule::RecurringSchedule, nil]
|
2555
2555
|
optional :recurring_schedule,
|
2556
|
-
-> {
|
2556
|
+
-> {
|
2557
|
+
MetronomeSDK::V1::ContractCreateParams::ScheduledCharge::Schedule::RecurringSchedule
|
2558
|
+
}
|
2557
2559
|
|
2558
2560
|
# @!attribute schedule_items
|
2559
2561
|
# Either provide amount or provide both unit_price and quantity.
|
2560
2562
|
#
|
2561
|
-
# @return [Array<MetronomeSDK::
|
2563
|
+
# @return [Array<MetronomeSDK::V1::ContractCreateParams::ScheduledCharge::Schedule::ScheduleItem>, nil]
|
2562
2564
|
optional :schedule_items,
|
2563
|
-
-> {
|
2565
|
+
-> {
|
2566
|
+
MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractCreateParams::ScheduledCharge::Schedule::ScheduleItem]
|
2567
|
+
}
|
2564
2568
|
|
2565
2569
|
# @!method initialize(credit_type_id: nil, recurring_schedule: nil, schedule_items: nil)
|
2566
2570
|
# Some parameter documentations has been truncated, see
|
2567
|
-
# {MetronomeSDK::
|
2568
|
-
#
|
2571
|
+
# {MetronomeSDK::V1::ContractCreateParams::ScheduledCharge::Schedule} for more
|
2572
|
+
# details.
|
2569
2573
|
#
|
2570
2574
|
# Must provide either schedule_items or recurring_schedule.
|
2571
2575
|
#
|
2572
2576
|
# @param credit_type_id [String] Defaults to USD (cents) if not passed.
|
2573
2577
|
#
|
2574
|
-
# @param recurring_schedule [MetronomeSDK::
|
2575
|
-
# ...
|
2578
|
+
# @param recurring_schedule [MetronomeSDK::V1::ContractCreateParams::ScheduledCharge::Schedule::RecurringSchedule] Enter the unit price and quantity for the charge or instead only send the amount
|
2576
2579
|
#
|
2577
|
-
# @param schedule_items [Array<MetronomeSDK::
|
2580
|
+
# @param schedule_items [Array<MetronomeSDK::V1::ContractCreateParams::ScheduledCharge::Schedule::ScheduleItem>] Either provide amount or provide both unit_price and quantity.
|
2578
2581
|
|
2579
|
-
# @see MetronomeSDK::
|
2582
|
+
# @see MetronomeSDK::V1::ContractCreateParams::ScheduledCharge::Schedule#recurring_schedule
|
2580
2583
|
class RecurringSchedule < MetronomeSDK::Internal::Type::BaseModel
|
2581
2584
|
# @!attribute amount_distribution
|
2582
2585
|
#
|
2583
|
-
# @return [Symbol, MetronomeSDK::
|
2586
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::ScheduledCharge::Schedule::RecurringSchedule::AmountDistribution]
|
2584
2587
|
required :amount_distribution,
|
2585
|
-
enum: -> {
|
2588
|
+
enum: -> {
|
2589
|
+
MetronomeSDK::V1::ContractCreateParams::ScheduledCharge::Schedule::RecurringSchedule::AmountDistribution
|
2590
|
+
}
|
2586
2591
|
|
2587
2592
|
# @!attribute ending_before
|
2588
2593
|
# RFC 3339 timestamp (exclusive).
|
@@ -2592,9 +2597,11 @@ module MetronomeSDK
|
|
2592
2597
|
|
2593
2598
|
# @!attribute frequency
|
2594
2599
|
#
|
2595
|
-
# @return [Symbol, MetronomeSDK::
|
2600
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::ScheduledCharge::Schedule::RecurringSchedule::Frequency]
|
2596
2601
|
required :frequency,
|
2597
|
-
enum: -> {
|
2602
|
+
enum: -> {
|
2603
|
+
MetronomeSDK::V1::ContractCreateParams::ScheduledCharge::Schedule::RecurringSchedule::Frequency
|
2604
|
+
}
|
2598
2605
|
|
2599
2606
|
# @!attribute starting_at
|
2600
2607
|
# RFC 3339 timestamp (inclusive).
|
@@ -2628,31 +2635,28 @@ module MetronomeSDK
|
|
2628
2635
|
|
2629
2636
|
# @!method initialize(amount_distribution:, ending_before:, frequency:, starting_at:, amount: nil, quantity: nil, unit_price: nil)
|
2630
2637
|
# Some parameter documentations has been truncated, see
|
2631
|
-
# {MetronomeSDK::
|
2638
|
+
# {MetronomeSDK::V1::ContractCreateParams::ScheduledCharge::Schedule::RecurringSchedule}
|
2632
2639
|
# for more details.
|
2633
2640
|
#
|
2634
2641
|
# Enter the unit price and quantity for the charge or instead only send the
|
2635
2642
|
# amount. If amount is sent, the unit price is assumed to be the amount and
|
2636
2643
|
# quantity is inferred to be 1.
|
2637
2644
|
#
|
2638
|
-
# @param amount_distribution [Symbol, MetronomeSDK::
|
2645
|
+
# @param amount_distribution [Symbol, MetronomeSDK::V1::ContractCreateParams::ScheduledCharge::Schedule::RecurringSchedule::AmountDistribution]
|
2639
2646
|
#
|
2640
2647
|
# @param ending_before [Time] RFC 3339 timestamp (exclusive).
|
2641
2648
|
#
|
2642
|
-
# @param frequency [Symbol, MetronomeSDK::
|
2649
|
+
# @param frequency [Symbol, MetronomeSDK::V1::ContractCreateParams::ScheduledCharge::Schedule::RecurringSchedule::Frequency]
|
2643
2650
|
#
|
2644
2651
|
# @param starting_at [Time] RFC 3339 timestamp (inclusive).
|
2645
2652
|
#
|
2646
2653
|
# @param amount [Float] Amount for the charge. Can be provided instead of unit_price and quantity. If am
|
2647
|
-
# ...
|
2648
2654
|
#
|
2649
2655
|
# @param quantity [Float] Quantity for the charge. Will be multiplied by unit_price to determine the amoun
|
2650
|
-
# ...
|
2651
2656
|
#
|
2652
2657
|
# @param unit_price [Float] Unit price for the charge. Will be multiplied by quantity to determine the amoun
|
2653
|
-
# ...
|
2654
2658
|
|
2655
|
-
# @see MetronomeSDK::
|
2659
|
+
# @see MetronomeSDK::V1::ContractCreateParams::ScheduledCharge::Schedule::RecurringSchedule#amount_distribution
|
2656
2660
|
module AmountDistribution
|
2657
2661
|
extend MetronomeSDK::Internal::Type::Enum
|
2658
2662
|
|
@@ -2664,7 +2668,7 @@ module MetronomeSDK
|
|
2664
2668
|
# @return [Array<Symbol>]
|
2665
2669
|
end
|
2666
2670
|
|
2667
|
-
# @see MetronomeSDK::
|
2671
|
+
# @see MetronomeSDK::V1::ContractCreateParams::ScheduledCharge::Schedule::RecurringSchedule#frequency
|
2668
2672
|
module Frequency
|
2669
2673
|
extend MetronomeSDK::Internal::Type::Enum
|
2670
2674
|
|
@@ -2711,19 +2715,16 @@ module MetronomeSDK
|
|
2711
2715
|
|
2712
2716
|
# @!method initialize(timestamp:, amount: nil, quantity: nil, unit_price: nil)
|
2713
2717
|
# Some parameter documentations has been truncated, see
|
2714
|
-
# {MetronomeSDK::
|
2718
|
+
# {MetronomeSDK::V1::ContractCreateParams::ScheduledCharge::Schedule::ScheduleItem}
|
2715
2719
|
# for more details.
|
2716
2720
|
#
|
2717
2721
|
# @param timestamp [Time] timestamp of the scheduled event
|
2718
2722
|
#
|
2719
2723
|
# @param amount [Float] Amount for the charge. Can be provided instead of unit_price and quantity. If am
|
2720
|
-
# ...
|
2721
2724
|
#
|
2722
2725
|
# @param quantity [Float] Quantity for the charge. Will be multiplied by unit_price to determine the amoun
|
2723
|
-
# ...
|
2724
2726
|
#
|
2725
2727
|
# @param unit_price [Float] Unit price for the charge. Will be multiplied by quantity to determine the amoun
|
2726
|
-
# ...
|
2727
2728
|
end
|
2728
2729
|
end
|
2729
2730
|
end
|
@@ -2745,9 +2746,8 @@ module MetronomeSDK
|
|
2745
2746
|
class SpendThresholdConfiguration < MetronomeSDK::Internal::Type::BaseModel
|
2746
2747
|
# @!attribute commit
|
2747
2748
|
#
|
2748
|
-
# @return [MetronomeSDK::
|
2749
|
-
required :commit,
|
2750
|
-
-> { MetronomeSDK::Models::V1::ContractCreateParams::SpendThresholdConfiguration::Commit }
|
2749
|
+
# @return [MetronomeSDK::V1::ContractCreateParams::SpendThresholdConfiguration::Commit]
|
2750
|
+
required :commit, -> { MetronomeSDK::V1::ContractCreateParams::SpendThresholdConfiguration::Commit }
|
2751
2751
|
|
2752
2752
|
# @!attribute is_enabled
|
2753
2753
|
# When set to false, the contract will not be evaluated against the
|
@@ -2759,9 +2759,11 @@ module MetronomeSDK
|
|
2759
2759
|
|
2760
2760
|
# @!attribute payment_gate_config
|
2761
2761
|
#
|
2762
|
-
# @return [MetronomeSDK::
|
2762
|
+
# @return [MetronomeSDK::V1::ContractCreateParams::SpendThresholdConfiguration::PaymentGateConfig]
|
2763
2763
|
required :payment_gate_config,
|
2764
|
-
-> {
|
2764
|
+
-> {
|
2765
|
+
MetronomeSDK::V1::ContractCreateParams::SpendThresholdConfiguration::PaymentGateConfig
|
2766
|
+
}
|
2765
2767
|
|
2766
2768
|
# @!attribute threshold_amount
|
2767
2769
|
# Specify the threshold amount for the contract. Each time the contract's usage
|
@@ -2772,20 +2774,18 @@ module MetronomeSDK
|
|
2772
2774
|
|
2773
2775
|
# @!method initialize(commit:, is_enabled:, payment_gate_config:, threshold_amount:)
|
2774
2776
|
# Some parameter documentations has been truncated, see
|
2775
|
-
# {MetronomeSDK::
|
2776
|
-
#
|
2777
|
+
# {MetronomeSDK::V1::ContractCreateParams::SpendThresholdConfiguration} for more
|
2778
|
+
# details.
|
2777
2779
|
#
|
2778
|
-
# @param commit [MetronomeSDK::
|
2780
|
+
# @param commit [MetronomeSDK::V1::ContractCreateParams::SpendThresholdConfiguration::Commit]
|
2779
2781
|
#
|
2780
2782
|
# @param is_enabled [Boolean] When set to false, the contract will not be evaluated against the threshold_amou
|
2781
|
-
# ...
|
2782
2783
|
#
|
2783
|
-
# @param payment_gate_config [MetronomeSDK::
|
2784
|
+
# @param payment_gate_config [MetronomeSDK::V1::ContractCreateParams::SpendThresholdConfiguration::PaymentGateConfig]
|
2784
2785
|
#
|
2785
2786
|
# @param threshold_amount [Float] Specify the threshold amount for the contract. Each time the contract's usage hi
|
2786
|
-
# ...
|
2787
2787
|
|
2788
|
-
# @see MetronomeSDK::
|
2788
|
+
# @see MetronomeSDK::V1::ContractCreateParams::SpendThresholdConfiguration#commit
|
2789
2789
|
class Commit < MetronomeSDK::Internal::Type::BaseModel
|
2790
2790
|
# @!attribute product_id
|
2791
2791
|
# The commit product that will be used to generate the line item for commit
|
@@ -2808,19 +2808,17 @@ module MetronomeSDK
|
|
2808
2808
|
|
2809
2809
|
# @!method initialize(product_id:, description: nil, name: nil)
|
2810
2810
|
# Some parameter documentations has been truncated, see
|
2811
|
-
# {MetronomeSDK::
|
2811
|
+
# {MetronomeSDK::V1::ContractCreateParams::SpendThresholdConfiguration::Commit}
|
2812
2812
|
# for more details.
|
2813
2813
|
#
|
2814
2814
|
# @param product_id [String] The commit product that will be used to generate the line item for commit paymen
|
2815
|
-
# ...
|
2816
2815
|
#
|
2817
2816
|
# @param description [String]
|
2818
2817
|
#
|
2819
2818
|
# @param name [String] Specify the name of the line item for the threshold charge. If left blank, it wi
|
2820
|
-
# ...
|
2821
2819
|
end
|
2822
2820
|
|
2823
|
-
# @see MetronomeSDK::
|
2821
|
+
# @see MetronomeSDK::V1::ContractCreateParams::SpendThresholdConfiguration#payment_gate_config
|
2824
2822
|
class PaymentGateConfig < MetronomeSDK::Internal::Type::BaseModel
|
2825
2823
|
# @!attribute payment_gate_type
|
2826
2824
|
# Gate access to the commit balance based on successful collection of payment.
|
@@ -2828,45 +2826,49 @@ module MetronomeSDK
|
|
2828
2826
|
# facilitate payment using your own payment integration. Select NONE if you do not
|
2829
2827
|
# wish to payment gate the commit balance.
|
2830
2828
|
#
|
2831
|
-
# @return [Symbol, MetronomeSDK::
|
2829
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::SpendThresholdConfiguration::PaymentGateConfig::PaymentGateType]
|
2832
2830
|
required :payment_gate_type,
|
2833
|
-
enum: -> {
|
2831
|
+
enum: -> {
|
2832
|
+
MetronomeSDK::V1::ContractCreateParams::SpendThresholdConfiguration::PaymentGateConfig::PaymentGateType
|
2833
|
+
}
|
2834
2834
|
|
2835
2835
|
# @!attribute stripe_config
|
2836
2836
|
# Only applicable if using Stripe as your payment gateway through Metronome.
|
2837
2837
|
#
|
2838
|
-
# @return [MetronomeSDK::
|
2838
|
+
# @return [MetronomeSDK::V1::ContractCreateParams::SpendThresholdConfiguration::PaymentGateConfig::StripeConfig, nil]
|
2839
2839
|
optional :stripe_config,
|
2840
|
-
-> {
|
2840
|
+
-> {
|
2841
|
+
MetronomeSDK::V1::ContractCreateParams::SpendThresholdConfiguration::PaymentGateConfig::StripeConfig
|
2842
|
+
}
|
2841
2843
|
|
2842
2844
|
# @!attribute tax_type
|
2843
2845
|
# Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
|
2844
2846
|
# not wish Metronome to calculate tax on your behalf. Leaving this field blank
|
2845
2847
|
# will default to NONE.
|
2846
2848
|
#
|
2847
|
-
# @return [Symbol, MetronomeSDK::
|
2849
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::SpendThresholdConfiguration::PaymentGateConfig::TaxType, nil]
|
2848
2850
|
optional :tax_type,
|
2849
|
-
enum: -> {
|
2851
|
+
enum: -> {
|
2852
|
+
MetronomeSDK::V1::ContractCreateParams::SpendThresholdConfiguration::PaymentGateConfig::TaxType
|
2853
|
+
}
|
2850
2854
|
|
2851
2855
|
# @!method initialize(payment_gate_type:, stripe_config: nil, tax_type: nil)
|
2852
2856
|
# Some parameter documentations has been truncated, see
|
2853
|
-
# {MetronomeSDK::
|
2857
|
+
# {MetronomeSDK::V1::ContractCreateParams::SpendThresholdConfiguration::PaymentGateConfig}
|
2854
2858
|
# for more details.
|
2855
2859
|
#
|
2856
|
-
# @param payment_gate_type [Symbol, MetronomeSDK::
|
2857
|
-
# ...
|
2860
|
+
# @param payment_gate_type [Symbol, MetronomeSDK::V1::ContractCreateParams::SpendThresholdConfiguration::PaymentGateConfig::PaymentGateType] Gate access to the commit balance based on successful collection of payment. Sel
|
2858
2861
|
#
|
2859
|
-
# @param stripe_config [MetronomeSDK::
|
2862
|
+
# @param stripe_config [MetronomeSDK::V1::ContractCreateParams::SpendThresholdConfiguration::PaymentGateConfig::StripeConfig] Only applicable if using Stripe as your payment gateway through Metronome.
|
2860
2863
|
#
|
2861
|
-
# @param tax_type [Symbol, MetronomeSDK::
|
2862
|
-
# ...
|
2864
|
+
# @param tax_type [Symbol, MetronomeSDK::V1::ContractCreateParams::SpendThresholdConfiguration::PaymentGateConfig::TaxType] Stripe tax is only supported for Stripe payment gateway. Select NONE if you do n
|
2863
2865
|
|
2864
2866
|
# Gate access to the commit balance based on successful collection of payment.
|
2865
2867
|
# Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
|
2866
2868
|
# facilitate payment using your own payment integration. Select NONE if you do not
|
2867
2869
|
# wish to payment gate the commit balance.
|
2868
2870
|
#
|
2869
|
-
# @see MetronomeSDK::
|
2871
|
+
# @see MetronomeSDK::V1::ContractCreateParams::SpendThresholdConfiguration::PaymentGateConfig#payment_gate_type
|
2870
2872
|
module PaymentGateType
|
2871
2873
|
extend MetronomeSDK::Internal::Type::Enum
|
2872
2874
|
|
@@ -2878,23 +2880,25 @@ module MetronomeSDK
|
|
2878
2880
|
# @return [Array<Symbol>]
|
2879
2881
|
end
|
2880
2882
|
|
2881
|
-
# @see MetronomeSDK::
|
2883
|
+
# @see MetronomeSDK::V1::ContractCreateParams::SpendThresholdConfiguration::PaymentGateConfig#stripe_config
|
2882
2884
|
class StripeConfig < MetronomeSDK::Internal::Type::BaseModel
|
2883
2885
|
# @!attribute payment_type
|
2884
2886
|
# If left blank, will default to INVOICE
|
2885
2887
|
#
|
2886
|
-
# @return [Symbol, MetronomeSDK::
|
2888
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::SpendThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType]
|
2887
2889
|
required :payment_type,
|
2888
|
-
enum: -> {
|
2890
|
+
enum: -> {
|
2891
|
+
MetronomeSDK::V1::ContractCreateParams::SpendThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType
|
2892
|
+
}
|
2889
2893
|
|
2890
2894
|
# @!method initialize(payment_type:)
|
2891
2895
|
# Only applicable if using Stripe as your payment gateway through Metronome.
|
2892
2896
|
#
|
2893
|
-
# @param payment_type [Symbol, MetronomeSDK::
|
2897
|
+
# @param payment_type [Symbol, MetronomeSDK::V1::ContractCreateParams::SpendThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType] If left blank, will default to INVOICE
|
2894
2898
|
|
2895
2899
|
# If left blank, will default to INVOICE
|
2896
2900
|
#
|
2897
|
-
# @see MetronomeSDK::
|
2901
|
+
# @see MetronomeSDK::V1::ContractCreateParams::SpendThresholdConfiguration::PaymentGateConfig::StripeConfig#payment_type
|
2898
2902
|
module PaymentType
|
2899
2903
|
extend MetronomeSDK::Internal::Type::Enum
|
2900
2904
|
|
@@ -2910,7 +2914,7 @@ module MetronomeSDK
|
|
2910
2914
|
# not wish Metronome to calculate tax on your behalf. Leaving this field blank
|
2911
2915
|
# will default to NONE.
|
2912
2916
|
#
|
2913
|
-
# @see MetronomeSDK::
|
2917
|
+
# @see MetronomeSDK::V1::ContractCreateParams::SpendThresholdConfiguration::PaymentGateConfig#tax_type
|
2914
2918
|
module TaxType
|
2915
2919
|
extend MetronomeSDK::Internal::Type::Enum
|
2916
2920
|
|
@@ -2932,25 +2936,25 @@ module MetronomeSDK
|
|
2932
2936
|
# @!attribute type
|
2933
2937
|
# This field's available values may vary based on your client's configuration.
|
2934
2938
|
#
|
2935
|
-
# @return [Symbol, MetronomeSDK::
|
2936
|
-
required :type, enum: -> { MetronomeSDK::
|
2939
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::Transition::Type]
|
2940
|
+
required :type, enum: -> { MetronomeSDK::V1::ContractCreateParams::Transition::Type }
|
2937
2941
|
|
2938
2942
|
# @!attribute future_invoice_behavior
|
2939
2943
|
#
|
2940
|
-
# @return [MetronomeSDK::
|
2944
|
+
# @return [MetronomeSDK::V1::ContractCreateParams::Transition::FutureInvoiceBehavior, nil]
|
2941
2945
|
optional :future_invoice_behavior,
|
2942
|
-
-> { MetronomeSDK::
|
2946
|
+
-> { MetronomeSDK::V1::ContractCreateParams::Transition::FutureInvoiceBehavior }
|
2943
2947
|
|
2944
2948
|
# @!method initialize(from_contract_id:, type:, future_invoice_behavior: nil)
|
2945
2949
|
# @param from_contract_id [String]
|
2946
2950
|
#
|
2947
|
-
# @param type [Symbol, MetronomeSDK::
|
2951
|
+
# @param type [Symbol, MetronomeSDK::V1::ContractCreateParams::Transition::Type] This field's available values may vary based on your client's configuration.
|
2948
2952
|
#
|
2949
|
-
# @param future_invoice_behavior [MetronomeSDK::
|
2953
|
+
# @param future_invoice_behavior [MetronomeSDK::V1::ContractCreateParams::Transition::FutureInvoiceBehavior]
|
2950
2954
|
|
2951
2955
|
# This field's available values may vary based on your client's configuration.
|
2952
2956
|
#
|
2953
|
-
# @see MetronomeSDK::
|
2957
|
+
# @see MetronomeSDK::V1::ContractCreateParams::Transition#type
|
2954
2958
|
module Type
|
2955
2959
|
extend MetronomeSDK::Internal::Type::Enum
|
2956
2960
|
|
@@ -2961,29 +2965,30 @@ module MetronomeSDK
|
|
2961
2965
|
# @return [Array<Symbol>]
|
2962
2966
|
end
|
2963
2967
|
|
2964
|
-
# @see MetronomeSDK::
|
2968
|
+
# @see MetronomeSDK::V1::ContractCreateParams::Transition#future_invoice_behavior
|
2965
2969
|
class FutureInvoiceBehavior < MetronomeSDK::Internal::Type::BaseModel
|
2966
2970
|
# @!attribute trueup
|
2967
2971
|
# Controls whether future trueup invoices are billed or removed. Default behavior
|
2968
2972
|
# is AS_IS if not specified.
|
2969
2973
|
#
|
2970
|
-
# @return [Symbol, MetronomeSDK::
|
2974
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::Transition::FutureInvoiceBehavior::Trueup, nil]
|
2971
2975
|
optional :trueup,
|
2972
|
-
enum: -> {
|
2976
|
+
enum: -> {
|
2977
|
+
MetronomeSDK::V1::ContractCreateParams::Transition::FutureInvoiceBehavior::Trueup
|
2978
|
+
},
|
2973
2979
|
nil?: true
|
2974
2980
|
|
2975
2981
|
# @!method initialize(trueup: nil)
|
2976
2982
|
# Some parameter documentations has been truncated, see
|
2977
|
-
# {MetronomeSDK::
|
2978
|
-
#
|
2983
|
+
# {MetronomeSDK::V1::ContractCreateParams::Transition::FutureInvoiceBehavior} for
|
2984
|
+
# more details.
|
2979
2985
|
#
|
2980
|
-
# @param trueup [Symbol, MetronomeSDK::
|
2981
|
-
# ...
|
2986
|
+
# @param trueup [Symbol, MetronomeSDK::V1::ContractCreateParams::Transition::FutureInvoiceBehavior::Trueup, nil] Controls whether future trueup invoices are billed or removed. Default behavior
|
2982
2987
|
|
2983
2988
|
# Controls whether future trueup invoices are billed or removed. Default behavior
|
2984
2989
|
# is AS_IS if not specified.
|
2985
2990
|
#
|
2986
|
-
# @see MetronomeSDK::
|
2991
|
+
# @see MetronomeSDK::V1::ContractCreateParams::Transition::FutureInvoiceBehavior#trueup
|
2987
2992
|
module Trueup
|
2988
2993
|
extend MetronomeSDK::Internal::Type::Enum
|
2989
2994
|
|
@@ -2999,9 +3004,9 @@ module MetronomeSDK
|
|
2999
3004
|
class UsageStatementSchedule < MetronomeSDK::Internal::Type::BaseModel
|
3000
3005
|
# @!attribute frequency
|
3001
3006
|
#
|
3002
|
-
# @return [Symbol, MetronomeSDK::
|
3007
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::UsageStatementSchedule::Frequency]
|
3003
3008
|
required :frequency,
|
3004
|
-
enum: -> { MetronomeSDK::
|
3009
|
+
enum: -> { MetronomeSDK::V1::ContractCreateParams::UsageStatementSchedule::Frequency }
|
3005
3010
|
|
3006
3011
|
# @!attribute billing_anchor_date
|
3007
3012
|
# Required when using CUSTOM_DATE. This option lets you set a historical billing
|
@@ -3016,8 +3021,8 @@ module MetronomeSDK
|
|
3016
3021
|
# @!attribute day
|
3017
3022
|
# If not provided, defaults to the first day of the month.
|
3018
3023
|
#
|
3019
|
-
# @return [Symbol, MetronomeSDK::
|
3020
|
-
optional :day, enum: -> { MetronomeSDK::
|
3024
|
+
# @return [Symbol, MetronomeSDK::V1::ContractCreateParams::UsageStatementSchedule::Day, nil]
|
3025
|
+
optional :day, enum: -> { MetronomeSDK::V1::ContractCreateParams::UsageStatementSchedule::Day }
|
3021
3026
|
|
3022
3027
|
# @!attribute invoice_generation_starting_at
|
3023
3028
|
# The date Metronome should start generating usage invoices. If unspecified,
|
@@ -3030,20 +3035,18 @@ module MetronomeSDK
|
|
3030
3035
|
|
3031
3036
|
# @!method initialize(frequency:, billing_anchor_date: nil, day: nil, invoice_generation_starting_at: nil)
|
3032
3037
|
# Some parameter documentations has been truncated, see
|
3033
|
-
# {MetronomeSDK::
|
3034
|
-
#
|
3038
|
+
# {MetronomeSDK::V1::ContractCreateParams::UsageStatementSchedule} for more
|
3039
|
+
# details.
|
3035
3040
|
#
|
3036
|
-
# @param frequency [Symbol, MetronomeSDK::
|
3041
|
+
# @param frequency [Symbol, MetronomeSDK::V1::ContractCreateParams::UsageStatementSchedule::Frequency]
|
3037
3042
|
#
|
3038
3043
|
# @param billing_anchor_date [Time] Required when using CUSTOM_DATE. This option lets you set a historical billing a
|
3039
|
-
# ...
|
3040
3044
|
#
|
3041
|
-
# @param day [Symbol, MetronomeSDK::
|
3045
|
+
# @param day [Symbol, MetronomeSDK::V1::ContractCreateParams::UsageStatementSchedule::Day] If not provided, defaults to the first day of the month.
|
3042
3046
|
#
|
3043
3047
|
# @param invoice_generation_starting_at [Time] The date Metronome should start generating usage invoices. If unspecified, contr
|
3044
|
-
# ...
|
3045
3048
|
|
3046
|
-
# @see MetronomeSDK::
|
3049
|
+
# @see MetronomeSDK::V1::ContractCreateParams::UsageStatementSchedule#frequency
|
3047
3050
|
module Frequency
|
3048
3051
|
extend MetronomeSDK::Internal::Type::Enum
|
3049
3052
|
|
@@ -3058,7 +3061,7 @@ module MetronomeSDK
|
|
3058
3061
|
|
3059
3062
|
# If not provided, defaults to the first day of the month.
|
3060
3063
|
#
|
3061
|
-
# @see MetronomeSDK::
|
3064
|
+
# @see MetronomeSDK::V1::ContractCreateParams::UsageStatementSchedule#day
|
3062
3065
|
module Day
|
3063
3066
|
extend MetronomeSDK::Internal::Type::Enum
|
3064
3067
|
|