metronome-sdk 0.1.0.pre.alpha.3 → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +56 -0
- data/README.md +1 -1
- data/lib/metronome_sdk/errors.rb +22 -0
- data/lib/metronome_sdk/internal/cursor_page.rb +1 -1
- data/lib/metronome_sdk/internal/transport/base_client.rb +10 -2
- data/lib/metronome_sdk/internal/type/array_of.rb +6 -1
- data/lib/metronome_sdk/internal/type/base_model.rb +82 -26
- data/lib/metronome_sdk/internal/type/boolean.rb +7 -1
- data/lib/metronome_sdk/internal/type/converter.rb +42 -34
- data/lib/metronome_sdk/internal/type/enum.rb +16 -5
- data/lib/metronome_sdk/internal/type/file_input.rb +6 -1
- data/lib/metronome_sdk/internal/type/hash_of.rb +6 -1
- data/lib/metronome_sdk/internal/type/union.rb +17 -9
- data/lib/metronome_sdk/internal/type/unknown.rb +7 -1
- data/lib/metronome_sdk/internal/util.rb +8 -9
- data/lib/metronome_sdk/models/base_usage_filter.rb +27 -0
- data/lib/metronome_sdk/models/commit.rb +1053 -0
- data/lib/metronome_sdk/models/contract_without_amendments.rb +2043 -0
- data/lib/metronome_sdk/models/credit.rb +677 -0
- data/lib/metronome_sdk/models/credit_type_data.rb +21 -0
- data/lib/metronome_sdk/models/discount.rb +68 -0
- data/lib/metronome_sdk/models/event_type_filter.rb +33 -0
- data/lib/metronome_sdk/models/id.rb +15 -0
- data/lib/metronome_sdk/models/override.rb +381 -0
- data/lib/metronome_sdk/models/pro_service.rb +73 -0
- data/lib/metronome_sdk/models/property_filter.rb +52 -0
- data/lib/metronome_sdk/models/rate.rb +101 -0
- data/lib/metronome_sdk/models/schedule_duration.rb +50 -0
- data/lib/metronome_sdk/models/schedule_point_in_time.rb +62 -0
- data/lib/metronome_sdk/models/scheduled_charge.rb +76 -0
- data/lib/metronome_sdk/models/tier.rb +21 -0
- data/lib/metronome_sdk/models/v1/alert_archive_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/alert_create_params.rb +4 -1
- data/lib/metronome_sdk/models/v1/alert_create_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/billable_metric_archive_params.rb +2 -8
- data/lib/metronome_sdk/models/v1/billable_metric_archive_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/billable_metric_create_params.rb +6 -86
- data/lib/metronome_sdk/models/v1/billable_metric_create_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/billable_metric_list_response.rb +6 -85
- data/lib/metronome_sdk/models/v1/billable_metric_retrieve_response.rb +8 -85
- data/lib/metronome_sdk/models/v1/contract_amend_params.rb +312 -35
- data/lib/metronome_sdk/models/v1/contract_amend_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contract_archive_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contract_create_historical_invoices_response.rb +3 -1276
- data/lib/metronome_sdk/models/v1/contract_create_params.rb +792 -104
- data/lib/metronome_sdk/models/v1/contract_create_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contract_list_balances_params.rb +9 -1
- data/lib/metronome_sdk/models/v1/contract_list_balances_response.rb +5 -1645
- data/lib/metronome_sdk/models/v1/contract_list_response.rb +253 -10692
- data/lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rb +9 -295
- data/lib/metronome_sdk/models/v1/contract_retrieve_response.rb +254 -10721
- data/lib/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_response.rb +3 -1276
- data/lib/metronome_sdk/models/v1/contract_update_end_date_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contracts/product_archive_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contracts/product_create_params.rb +6 -97
- data/lib/metronome_sdk/models/v1/contracts/product_create_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contracts/product_list_item_state.rb +148 -0
- data/lib/metronome_sdk/models/v1/contracts/product_list_response.rb +12 -561
- data/lib/metronome_sdk/models/v1/contracts/product_retrieve_params.rb +2 -8
- data/lib/metronome_sdk/models/v1/contracts/product_retrieve_response.rb +14 -559
- data/lib/metronome_sdk/models/v1/contracts/product_update_params.rb +6 -97
- data/lib/metronome_sdk/models/v1/contracts/product_update_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contracts/quantity_conversion.rb +57 -0
- data/lib/metronome_sdk/models/v1/contracts/quantity_rounding.rb +45 -0
- data/lib/metronome_sdk/models/v1/contracts/rate_card_archive_params.rb +2 -8
- data/lib/metronome_sdk/models/v1/contracts/rate_card_archive_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contracts/rate_card_create_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contracts/rate_card_list_response.rb +6 -42
- data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_params.rb +2 -8
- data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rb +6 -159
- data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rb +6 -42
- data/lib/metronome_sdk/models/v1/contracts/rate_card_update_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rb +6 -44
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_response.rb +3 -16
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb +6 -44
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rb +9 -61
- data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rb +6 -158
- data/lib/metronome_sdk/models/v1/credit_grant_create_params.rb +5 -77
- data/lib/metronome_sdk/models/v1/credit_grant_create_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/credit_grant_edit_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/credit_grant_list_entries_params.rb +20 -1
- data/lib/metronome_sdk/models/v1/credit_grant_list_entries_response.rb +11 -153
- data/lib/metronome_sdk/models/v1/credit_grant_list_response.rb +14 -175
- data/lib/metronome_sdk/models/v1/credit_grant_void_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/credit_ledger_entry.rb +69 -0
- data/lib/metronome_sdk/models/v1/customer.rb +53 -0
- data/lib/metronome_sdk/models/v1/customer_archive_params.rb +2 -8
- data/lib/metronome_sdk/models/v1/customer_archive_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/customer_create_response.rb +3 -50
- data/lib/metronome_sdk/models/v1/{customer_list_response.rb → customer_detail.rb} +14 -15
- data/lib/metronome_sdk/models/v1/customer_list_billable_metrics_response.rb +6 -86
- data/lib/metronome_sdk/models/v1/customer_preview_events_params.rb +115 -0
- data/lib/metronome_sdk/models/v1/customer_preview_events_response.rb +18 -0
- data/lib/metronome_sdk/models/v1/customer_retrieve_response.rb +3 -126
- data/lib/metronome_sdk/models/v1/customer_set_name_response.rb +3 -50
- data/lib/metronome_sdk/models/v1/customers/alert_list_response.rb +5 -276
- data/lib/metronome_sdk/models/v1/customers/alert_retrieve_response.rb +3 -279
- data/lib/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rb +9 -1
- data/lib/metronome_sdk/models/v1/customers/commit_create_params.rb +8 -6
- data/lib/metronome_sdk/models/v1/customers/commit_create_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/customers/commit_list_params.rb +9 -1
- data/lib/metronome_sdk/models/v1/customers/commit_list_response.rb +3 -1047
- data/lib/metronome_sdk/models/v1/customers/commit_update_end_date_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/customers/credit_create_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/customers/credit_list_params.rb +9 -1
- data/lib/metronome_sdk/models/v1/customers/credit_list_response.rb +3 -593
- data/lib/metronome_sdk/models/v1/customers/credit_update_end_date_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/customers/customer_alert.rb +270 -0
- data/lib/metronome_sdk/models/v1/customers/{invoice_list_response.rb → invoice.rb} +119 -303
- data/lib/metronome_sdk/models/v1/customers/invoice_list_breakdowns_response.rb +2 -1271
- data/lib/metronome_sdk/models/v1/customers/invoice_retrieve_response.rb +3 -1276
- data/lib/metronome_sdk/models/v1/customers/plan_add_response.rb +3 -14
- data/lib/metronome_sdk/models/v1/customers/plan_list_response.rb +3 -21
- data/lib/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rb +1 -0
- data/lib/metronome_sdk/models/v1/plan_detail.rb +200 -0
- data/lib/metronome_sdk/models/v1/plan_get_details_response.rb +3 -286
- data/lib/metronome_sdk/models/v1/plan_list_charges_response.rb +3 -20
- data/lib/metronome_sdk/models/v1/plan_list_customers_response.rb +3 -128
- data/lib/metronome_sdk/models/v1/rollover_amount_max_amount.rb +38 -0
- data/lib/metronome_sdk/models/v1/rollover_amount_max_percentage.rb +38 -0
- data/lib/metronome_sdk/models/v1/usage_search_params.rb +24 -0
- data/lib/metronome_sdk/models/v1/usage_search_response.rb +249 -0
- data/lib/metronome_sdk/models/v2/contract_edit_commit_params.rb +11 -8
- data/lib/metronome_sdk/models/v2/contract_edit_commit_response.rb +3 -14
- data/lib/metronome_sdk/models/v2/contract_edit_credit_params.rb +3 -2
- data/lib/metronome_sdk/models/v2/contract_edit_credit_response.rb +3 -14
- data/lib/metronome_sdk/models/v2/contract_edit_params.rb +1127 -105
- data/lib/metronome_sdk/models/v2/contract_edit_response.rb +3 -14
- data/lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb +577 -643
- data/lib/metronome_sdk/models/v2/contract_list_response.rb +917 -746
- data/lib/metronome_sdk/models/v2/contract_retrieve_response.rb +917 -748
- data/lib/metronome_sdk/models.rb +36 -4
- data/lib/metronome_sdk/resources/v1/alerts.rb +1 -1
- data/lib/metronome_sdk/resources/v1/billable_metrics.rb +2 -2
- data/lib/metronome_sdk/resources/v1/contracts/products.rb +4 -4
- data/lib/metronome_sdk/resources/v1/contracts/rate_cards/rates.rb +1 -1
- data/lib/metronome_sdk/resources/v1/contracts.rb +11 -5
- data/lib/metronome_sdk/resources/v1/credit_grants.rb +4 -2
- data/lib/metronome_sdk/resources/v1/customers/commits.rb +5 -3
- data/lib/metronome_sdk/resources/v1/customers/credits.rb +3 -1
- data/lib/metronome_sdk/resources/v1/customers/invoices.rb +2 -2
- data/lib/metronome_sdk/resources/v1/customers.rb +40 -2
- data/lib/metronome_sdk/resources/v1/usage.rb +25 -0
- data/lib/metronome_sdk/resources/v2/contracts.rb +11 -9
- data/lib/metronome_sdk/version.rb +1 -1
- data/lib/metronome_sdk.rb +31 -2
- data/rbi/metronome_sdk/errors.rbi +16 -0
- data/rbi/metronome_sdk/internal/type/boolean.rbi +2 -0
- data/rbi/metronome_sdk/internal/type/converter.rbi +15 -15
- data/rbi/metronome_sdk/internal/type/union.rbi +5 -0
- data/rbi/metronome_sdk/internal/type/unknown.rbi +2 -0
- data/rbi/metronome_sdk/internal/util.rbi +2 -0
- data/rbi/metronome_sdk/models/base_usage_filter.rbi +46 -0
- data/rbi/metronome_sdk/models/commit.rbi +2046 -0
- data/rbi/metronome_sdk/models/contract_without_amendments.rbi +4260 -0
- data/rbi/metronome_sdk/models/credit.rbi +1314 -0
- data/rbi/metronome_sdk/models/credit_type_data.rbi +26 -0
- data/rbi/metronome_sdk/models/discount.rbi +106 -0
- data/rbi/metronome_sdk/models/event_type_filter.rbi +57 -0
- data/rbi/metronome_sdk/models/id.rbi +23 -0
- data/rbi/metronome_sdk/models/override.rbi +675 -0
- data/rbi/metronome_sdk/models/pro_service.rbi +98 -0
- data/rbi/metronome_sdk/models/property_filter.rbi +88 -0
- data/rbi/metronome_sdk/models/rate.rbi +155 -0
- data/rbi/metronome_sdk/models/schedule_duration.rbi +89 -0
- data/rbi/metronome_sdk/models/schedule_point_in_time.rbi +121 -0
- data/rbi/metronome_sdk/models/scheduled_charge.rbi +119 -0
- data/rbi/metronome_sdk/models/tier.rbi +29 -0
- data/rbi/metronome_sdk/models/v1/alert_archive_response.rbi +4 -37
- data/rbi/metronome_sdk/models/v1/alert_create_params.rbi +6 -0
- data/rbi/metronome_sdk/models/v1/alert_create_response.rbi +4 -37
- data/rbi/metronome_sdk/models/v1/billable_metric_archive_params.rbi +6 -12
- data/rbi/metronome_sdk/models/v1/billable_metric_archive_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/billable_metric_create_params.rbi +8 -177
- data/rbi/metronome_sdk/models/v1/billable_metric_create_response.rbi +4 -43
- data/rbi/metronome_sdk/models/v1/billable_metric_list_response.rbi +8 -177
- data/rbi/metronome_sdk/models/v1/billable_metric_retrieve_response.rbi +8 -175
- data/rbi/metronome_sdk/models/v1/contract_amend_params.rbi +712 -68
- data/rbi/metronome_sdk/models/v1/contract_amend_response.rbi +4 -37
- data/rbi/metronome_sdk/models/v1/contract_archive_response.rbi +4 -39
- data/rbi/metronome_sdk/models/v1/contract_create_historical_invoices_response.rbi +3 -2595
- data/rbi/metronome_sdk/models/v1/contract_create_params.rbi +1738 -210
- data/rbi/metronome_sdk/models/v1/contract_create_response.rbi +4 -37
- data/rbi/metronome_sdk/models/v1/contract_list_balances_params.rbi +11 -0
- data/rbi/metronome_sdk/models/v1/contract_list_balances_response.rbi +3 -3366
- data/rbi/metronome_sdk/models/v1/contract_list_response.rbi +375 -22523
- data/rbi/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rbi +12 -632
- data/rbi/metronome_sdk/models/v1/contract_retrieve_response.rbi +375 -22523
- data/rbi/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_response.rbi +3 -2595
- data/rbi/metronome_sdk/models/v1/contract_update_end_date_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/contracts/product_archive_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/contracts/product_create_params.rbi +8 -209
- data/rbi/metronome_sdk/models/v1/contracts/product_create_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/contracts/product_list_item_state.rbi +237 -0
- data/rbi/metronome_sdk/models/v1/contracts/product_list_response.rbi +76 -1143
- data/rbi/metronome_sdk/models/v1/contracts/product_retrieve_params.rbi +3 -9
- data/rbi/metronome_sdk/models/v1/contracts/product_retrieve_response.rbi +76 -1137
- data/rbi/metronome_sdk/models/v1/contracts/product_update_params.rbi +8 -209
- data/rbi/metronome_sdk/models/v1/contracts/product_update_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/contracts/quantity_conversion.rbi +111 -0
- data/rbi/metronome_sdk/models/v1/contracts/quantity_rounding.rbi +94 -0
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_archive_params.rbi +3 -9
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_archive_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_create_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_list_response.rbi +8 -74
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_params.rbi +3 -9
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rbi +8 -344
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rbi +8 -74
- data/rbi/metronome_sdk/models/v1/contracts/rate_card_update_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rbi +8 -108
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_response.rbi +4 -45
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbi +8 -108
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rbi +12 -149
- data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rbi +8 -344
- data/rbi/metronome_sdk/models/v1/credit_grant_create_params.rbi +8 -166
- data/rbi/metronome_sdk/models/v1/credit_grant_create_response.rbi +4 -41
- data/rbi/metronome_sdk/models/v1/credit_grant_edit_response.rbi +4 -39
- data/rbi/metronome_sdk/models/v1/credit_grant_list_entries_params.rbi +58 -0
- data/rbi/metronome_sdk/models/v1/credit_grant_list_entries_response.rbi +10 -231
- data/rbi/metronome_sdk/models/v1/credit_grant_list_response.rbi +14 -281
- data/rbi/metronome_sdk/models/v1/credit_grant_void_response.rbi +4 -39
- data/rbi/metronome_sdk/models/v1/credit_ledger_entry.rbi +90 -0
- data/rbi/metronome_sdk/models/v1/customer.rbi +74 -0
- data/rbi/metronome_sdk/models/v1/customer_archive_params.rbi +6 -12
- data/rbi/metronome_sdk/models/v1/customer_archive_response.rbi +4 -39
- data/rbi/metronome_sdk/models/v1/customer_create_response.rbi +6 -84
- data/rbi/metronome_sdk/models/v1/{customer_list_response.rbi → customer_detail.rbi} +19 -26
- data/rbi/metronome_sdk/models/v1/customer_list_billable_metrics_response.rbi +8 -177
- data/rbi/metronome_sdk/models/v1/customer_preview_events_params.rbi +214 -0
- data/rbi/metronome_sdk/models/v1/customer_preview_events_response.rbi +35 -0
- data/rbi/metronome_sdk/models/v1/customer_retrieve_response.rbi +6 -255
- data/rbi/metronome_sdk/models/v1/customer_set_name_response.rbi +6 -86
- data/rbi/metronome_sdk/models/v1/customers/alert_list_response.rbi +3 -623
- data/rbi/metronome_sdk/models/v1/customers/alert_retrieve_response.rbi +4 -622
- data/rbi/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbi +11 -0
- data/rbi/metronome_sdk/models/v1/customers/commit_create_params.rbi +12 -8
- data/rbi/metronome_sdk/models/v1/customers/commit_create_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/customers/commit_list_params.rbi +11 -0
- data/rbi/metronome_sdk/models/v1/customers/commit_list_response.rbi +3 -2164
- data/rbi/metronome_sdk/models/v1/customers/commit_update_end_date_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/customers/credit_create_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/customers/credit_list_params.rbi +11 -0
- data/rbi/metronome_sdk/models/v1/customers/credit_list_response.rbi +3 -1224
- data/rbi/metronome_sdk/models/v1/customers/credit_update_end_date_response.rbi +4 -44
- data/rbi/metronome_sdk/models/v1/customers/customer_alert.rbi +572 -0
- data/rbi/metronome_sdk/models/v1/customers/{invoice_list_response.rbi → invoice.rbi} +182 -589
- data/rbi/metronome_sdk/models/v1/customers/invoice_list_breakdowns_response.rbi +4 -2561
- data/rbi/metronome_sdk/models/v1/customers/invoice_retrieve_response.rbi +6 -2612
- data/rbi/metronome_sdk/models/v1/customers/plan_add_response.rbi +4 -41
- data/rbi/metronome_sdk/models/v1/customers/plan_list_response.rbi +4 -39
- data/rbi/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rbi +5 -0
- data/rbi/metronome_sdk/models/v1/plan_detail.rbi +349 -0
- data/rbi/metronome_sdk/models/v1/plan_get_details_response.rbi +6 -560
- data/rbi/metronome_sdk/models/v1/plan_list_charges_response.rbi +4 -37
- data/rbi/metronome_sdk/models/v1/plan_list_customers_response.rbi +4 -248
- data/rbi/metronome_sdk/models/v1/rollover_amount_max_amount.rbi +79 -0
- data/rbi/metronome_sdk/models/v1/rollover_amount_max_percentage.rbi +80 -0
- data/rbi/metronome_sdk/models/v1/usage_search_params.rbi +48 -0
- data/rbi/metronome_sdk/models/v1/usage_search_response.rbi +438 -0
- data/rbi/metronome_sdk/models/v2/contract_edit_commit_params.rbi +23 -23
- data/rbi/metronome_sdk/models/v2/contract_edit_commit_response.rbi +4 -41
- data/rbi/metronome_sdk/models/v2/contract_edit_credit_params.rbi +11 -15
- data/rbi/metronome_sdk/models/v2/contract_edit_credit_response.rbi +4 -41
- data/rbi/metronome_sdk/models/v2/contract_edit_params.rbi +2463 -206
- data/rbi/metronome_sdk/models/v2/contract_edit_response.rbi +4 -37
- data/rbi/metronome_sdk/models/v2/contract_get_edit_history_response.rbi +1381 -1550
- data/rbi/metronome_sdk/models/v2/contract_list_response.rbi +2017 -1466
- data/rbi/metronome_sdk/models/v2/contract_retrieve_response.rbi +2017 -1466
- data/rbi/metronome_sdk/models.rbi +32 -0
- data/rbi/metronome_sdk/resources/v1/alerts.rbi +3 -0
- data/rbi/metronome_sdk/resources/v1/billable_metrics.rbi +2 -6
- data/rbi/metronome_sdk/resources/v1/contracts/products.rbi +4 -4
- data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbi +1 -4
- data/rbi/metronome_sdk/resources/v1/contracts.rbi +13 -4
- data/rbi/metronome_sdk/resources/v1/credit_grants.rbi +4 -0
- data/rbi/metronome_sdk/resources/v1/customers/commits.rbi +9 -4
- data/rbi/metronome_sdk/resources/v1/customers/credits.rbi +3 -0
- data/rbi/metronome_sdk/resources/v1/customers/invoices.rbi +1 -1
- data/rbi/metronome_sdk/resources/v1/customers.rbi +34 -3
- data/rbi/metronome_sdk/resources/v1/usage.rbi +17 -0
- data/rbi/metronome_sdk/resources/v2/contracts.rbi +24 -14
- data/sig/metronome_sdk/errors.rbs +9 -0
- data/sig/metronome_sdk/internal/type/converter.rbs +7 -1
- data/sig/metronome_sdk/models/base_usage_filter.rbs +28 -0
- data/sig/metronome_sdk/models/commit.rbs +1063 -0
- data/sig/metronome_sdk/models/contract_without_amendments.rbs +1828 -0
- data/sig/metronome_sdk/models/credit.rbs +686 -0
- data/sig/metronome_sdk/models/credit_type_data.rbs +15 -0
- data/sig/metronome_sdk/models/discount.rbs +63 -0
- data/sig/metronome_sdk/models/event_type_filter.rbs +26 -0
- data/sig/metronome_sdk/models/id.rbs +13 -0
- data/sig/metronome_sdk/models/override.rbs +399 -0
- data/sig/metronome_sdk/models/pro_service.rbs +61 -0
- data/sig/metronome_sdk/models/property_filter.rbs +41 -0
- data/sig/metronome_sdk/models/rate.rbs +94 -0
- data/sig/metronome_sdk/models/schedule_duration.rbs +56 -0
- data/sig/metronome_sdk/models/schedule_point_in_time.rbs +75 -0
- data/sig/metronome_sdk/models/scheduled_charge.rbs +70 -0
- data/sig/metronome_sdk/models/tier.rbs +17 -0
- data/sig/metronome_sdk/models/v1/alert_archive_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/alert_create_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/billable_metric_archive_params.rbs +4 -12
- data/sig/metronome_sdk/models/v1/billable_metric_archive_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/billable_metric_create_params.rbs +12 -73
- data/sig/metronome_sdk/models/v1/billable_metric_create_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/billable_metric_list_response.rbs +12 -73
- data/sig/metronome_sdk/models/v1/billable_metric_retrieve_response.rbs +12 -73
- data/sig/metronome_sdk/models/v1/contract_amend_params.rbs +291 -24
- data/sig/metronome_sdk/models/v1/contract_amend_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/contract_archive_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/contract_create_historical_invoices_response.rbs +4 -1291
- data/sig/metronome_sdk/models/v1/contract_create_params.rbs +694 -84
- data/sig/metronome_sdk/models/v1/contract_create_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/contract_list_balances_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/contract_list_balances_response.rbs +1 -1642
- data/sig/metronome_sdk/models/v1/contract_list_response.rbs +188 -10437
- data/sig/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rbs +15 -271
- data/sig/metronome_sdk/models/v1/contract_retrieve_response.rbs +188 -10437
- data/sig/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_response.rbs +4 -1291
- data/sig/metronome_sdk/models/v1/contract_update_end_date_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/contracts/product_archive_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/contracts/product_create_params.rbs +8 -82
- data/sig/metronome_sdk/models/v1/contracts/product_create_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/contracts/product_list_item_state.rbs +121 -0
- data/sig/metronome_sdk/models/v1/contracts/product_list_response.rbs +16 -466
- data/sig/metronome_sdk/models/v1/contracts/product_retrieve_params.rbs +4 -12
- data/sig/metronome_sdk/models/v1/contracts/product_retrieve_response.rbs +16 -466
- data/sig/metronome_sdk/models/v1/contracts/product_update_params.rbs +8 -82
- data/sig/metronome_sdk/models/v1/contracts/product_update_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/contracts/quantity_conversion.rbs +47 -0
- data/sig/metronome_sdk/models/v1/contracts/quantity_rounding.rbs +41 -0
- data/sig/metronome_sdk/models/v1/contracts/rate_card_archive_params.rbs +4 -12
- data/sig/metronome_sdk/models/v1/contracts/rate_card_archive_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/contracts/rate_card_create_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/contracts/rate_card_list_response.rbs +10 -34
- data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_params.rbs +4 -12
- data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rbs +10 -144
- data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rbs +10 -34
- data/sig/metronome_sdk/models/v1/contracts/rate_card_update_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rbs +12 -40
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbs +12 -40
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rbs +18 -58
- data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rbs +10 -144
- data/sig/metronome_sdk/models/v1/credit_grant_create_params.rbs +2 -66
- data/sig/metronome_sdk/models/v1/credit_grant_create_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/credit_grant_edit_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/credit_grant_list_entries_params.rbs +20 -0
- data/sig/metronome_sdk/models/v1/credit_grant_list_entries_response.rbs +12 -118
- data/sig/metronome_sdk/models/v1/credit_grant_list_response.rbs +16 -140
- data/sig/metronome_sdk/models/v1/credit_grant_void_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/credit_ledger_entry.rbs +52 -0
- data/sig/metronome_sdk/models/v1/customer.rbs +44 -0
- data/sig/metronome_sdk/models/v1/customer_archive_params.rbs +4 -12
- data/sig/metronome_sdk/models/v1/customer_archive_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/customer_create_response.rbs +4 -48
- data/sig/metronome_sdk/models/v1/{customer_list_response.rbs → customer_detail.rbs} +17 -17
- data/sig/metronome_sdk/models/v1/customer_list_billable_metrics_response.rbs +12 -73
- data/sig/metronome_sdk/models/v1/customer_preview_events_params.rbs +105 -0
- data/sig/metronome_sdk/models/v1/customer_preview_events_response.rbs +16 -0
- data/sig/metronome_sdk/models/v1/customer_retrieve_response.rbs +4 -112
- data/sig/metronome_sdk/models/v1/customer_set_name_response.rbs +4 -48
- data/sig/metronome_sdk/models/v1/customers/alert_list_response.rbs +4 -243
- data/sig/metronome_sdk/models/v1/customers/alert_retrieve_response.rbs +4 -247
- data/sig/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbs +7 -0
- data/sig/metronome_sdk/models/v1/customers/commit_create_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/customers/commit_list_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/customers/commit_list_response.rbs +4 -1057
- data/sig/metronome_sdk/models/v1/customers/commit_update_end_date_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/customers/credit_create_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/customers/credit_list_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/customers/credit_list_response.rbs +4 -596
- data/sig/metronome_sdk/models/v1/customers/credit_update_end_date_response.rbs +4 -21
- data/sig/metronome_sdk/models/v1/customers/customer_alert.rbs +234 -0
- data/sig/metronome_sdk/models/v1/customers/{invoice_list_response.rbs → invoice.rbs} +147 -305
- data/sig/metronome_sdk/models/v1/customers/invoice_list_breakdowns_response.rbs +8 -1278
- data/sig/metronome_sdk/models/v1/customers/invoice_retrieve_response.rbs +4 -1294
- data/sig/metronome_sdk/models/v1/customers/plan_add_response.rbs +4 -19
- data/sig/metronome_sdk/models/v1/customers/plan_list_response.rbs +4 -16
- data/sig/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rbs +2 -1
- data/sig/metronome_sdk/models/v1/plan_detail.rbs +203 -0
- data/sig/metronome_sdk/models/v1/plan_get_details_response.rbs +4 -267
- data/sig/metronome_sdk/models/v1/plan_list_charges_response.rbs +4 -16
- data/sig/metronome_sdk/models/v1/plan_list_customers_response.rbs +4 -108
- data/sig/metronome_sdk/models/v1/rollover_amount_max_amount.rbs +37 -0
- data/sig/metronome_sdk/models/v1/rollover_amount_max_percentage.rbs +37 -0
- data/sig/metronome_sdk/models/v1/usage_search_params.rbs +26 -0
- data/sig/metronome_sdk/models/v1/usage_search_response.rbs +230 -0
- data/sig/metronome_sdk/models/v2/contract_edit_commit_params.rbs +4 -8
- data/sig/metronome_sdk/models/v2/contract_edit_commit_response.rbs +4 -19
- data/sig/metronome_sdk/models/v2/contract_edit_credit_params.rbs +4 -8
- data/sig/metronome_sdk/models/v2/contract_edit_credit_response.rbs +4 -19
- data/sig/metronome_sdk/models/v2/contract_edit_params.rbs +989 -77
- data/sig/metronome_sdk/models/v2/contract_edit_response.rbs +4 -19
- data/sig/metronome_sdk/models/v2/contract_get_edit_history_response.rbs +510 -655
- data/sig/metronome_sdk/models/v2/contract_list_response.rbs +970 -809
- data/sig/metronome_sdk/models/v2/contract_retrieve_response.rbs +970 -809
- data/sig/metronome_sdk/models.rbs +32 -0
- data/sig/metronome_sdk/resources/v1/billable_metrics.rbs +2 -2
- data/sig/metronome_sdk/resources/v1/contracts/products.rbs +4 -4
- data/sig/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbs +1 -1
- data/sig/metronome_sdk/resources/v1/contracts.rbs +4 -1
- data/sig/metronome_sdk/resources/v1/credit_grants.rbs +1 -0
- data/sig/metronome_sdk/resources/v1/customers/commits.rbs +1 -0
- data/sig/metronome_sdk/resources/v1/customers/credits.rbs +1 -0
- data/sig/metronome_sdk/resources/v1/customers/invoices.rbs +1 -1
- data/sig/metronome_sdk/resources/v1/customers.rbs +9 -1
- data/sig/metronome_sdk/resources/v1/usage.rbs +5 -0
- data/sig/metronome_sdk/resources/v2/contracts.rbs +3 -2
- metadata +97 -10
@@ -34,9 +34,8 @@ module MetronomeSDK
|
|
34
34
|
|
35
35
|
# @!attribute add_discounts
|
36
36
|
#
|
37
|
-
# @return [Array<MetronomeSDK::Models::
|
38
|
-
optional :add_discounts,
|
39
|
-
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddDiscount] }
|
37
|
+
# @return [Array<MetronomeSDK::Models::Discount>, nil]
|
38
|
+
optional :add_discounts, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Discount] }
|
40
39
|
|
41
40
|
# @!attribute add_overrides
|
42
41
|
#
|
@@ -52,9 +51,8 @@ module MetronomeSDK
|
|
52
51
|
|
53
52
|
# @!attribute add_pro_services
|
54
53
|
#
|
55
|
-
# @return [Array<MetronomeSDK::Models::
|
56
|
-
optional :add_pro_services,
|
57
|
-
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddProService] }
|
54
|
+
# @return [Array<MetronomeSDK::Models::ProService>, nil]
|
55
|
+
optional :add_pro_services, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ProService] }
|
58
56
|
|
59
57
|
# @!attribute add_recurring_commits
|
60
58
|
#
|
@@ -87,7 +85,7 @@ module MetronomeSDK
|
|
87
85
|
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSpendThresholdConfiguration }
|
88
86
|
|
89
87
|
# @!attribute add_subscriptions
|
90
|
-
#
|
88
|
+
# List of subscriptions on the contract.
|
91
89
|
#
|
92
90
|
# @return [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription>, nil]
|
93
91
|
optional :add_subscriptions,
|
@@ -139,6 +137,13 @@ module MetronomeSDK
|
|
139
137
|
# @return [Time, nil]
|
140
138
|
optional :update_contract_end_date, Time
|
141
139
|
|
140
|
+
# @!attribute update_contract_name
|
141
|
+
# Value to update the contract name to. If not provided, the contract name will
|
142
|
+
# remain unchanged.
|
143
|
+
#
|
144
|
+
# @return [String, nil]
|
145
|
+
optional :update_contract_name, String, nil?: true
|
146
|
+
|
142
147
|
# @!attribute update_credits
|
143
148
|
#
|
144
149
|
# @return [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateCredit>, nil]
|
@@ -188,26 +193,30 @@ module MetronomeSDK
|
|
188
193
|
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSpendThresholdConfiguration }
|
189
194
|
|
190
195
|
# @!attribute update_subscriptions
|
191
|
-
#
|
196
|
+
# Optional list of subscriptions to update.
|
192
197
|
#
|
193
198
|
# @return [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription>, nil]
|
194
199
|
optional :update_subscriptions,
|
195
200
|
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription] }
|
196
201
|
|
197
|
-
# @!method initialize(id:, add_commits: nil, add_credits: nil, add_discounts: nil, add_overrides: nil, add_prepaid_balance_threshold_configuration: nil, add_pro_services: nil, add_recurring_commits: nil, add_recurring_credits: nil, add_reseller_royalties: nil, add_scheduled_charges: nil, add_spend_threshold_configuration: nil, add_subscriptions: nil, add_usage_filters: nil, archive_commits: nil, archive_credits: nil, archive_scheduled_charges: nil, remove_overrides: nil, timestamp: nil, update_commits: nil, update_contract_end_date: nil, update_credits: nil, update_discounts: nil, update_prepaid_balance_threshold_configuration: nil, update_recurring_commits: nil, update_recurring_credits: nil, update_refund_invoices: nil, update_scheduled_charges: nil, update_spend_threshold_configuration: nil, update_subscriptions: nil)
|
202
|
+
# @!method initialize(id:, add_commits: nil, add_credits: nil, add_discounts: nil, add_overrides: nil, add_prepaid_balance_threshold_configuration: nil, add_pro_services: nil, add_recurring_commits: nil, add_recurring_credits: nil, add_reseller_royalties: nil, add_scheduled_charges: nil, add_spend_threshold_configuration: nil, add_subscriptions: nil, add_usage_filters: nil, archive_commits: nil, archive_credits: nil, archive_scheduled_charges: nil, remove_overrides: nil, timestamp: nil, update_commits: nil, update_contract_end_date: nil, update_contract_name: nil, update_credits: nil, update_discounts: nil, update_prepaid_balance_threshold_configuration: nil, update_recurring_commits: nil, update_recurring_credits: nil, update_refund_invoices: nil, update_scheduled_charges: nil, update_spend_threshold_configuration: nil, update_subscriptions: nil)
|
203
|
+
# Some parameter documentations has been truncated, see
|
204
|
+
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data} for more
|
205
|
+
# details.
|
206
|
+
#
|
198
207
|
# @param id [String]
|
199
208
|
#
|
200
209
|
# @param add_commits [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCommit>]
|
201
210
|
#
|
202
211
|
# @param add_credits [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCredit>]
|
203
212
|
#
|
204
|
-
# @param add_discounts [Array<MetronomeSDK::Models::
|
213
|
+
# @param add_discounts [Array<MetronomeSDK::Models::Discount>]
|
205
214
|
#
|
206
215
|
# @param add_overrides [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride>]
|
207
216
|
#
|
208
217
|
# @param add_prepaid_balance_threshold_configuration [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddPrepaidBalanceThresholdConfiguration]
|
209
218
|
#
|
210
|
-
# @param add_pro_services [Array<MetronomeSDK::Models::
|
219
|
+
# @param add_pro_services [Array<MetronomeSDK::Models::ProService>]
|
211
220
|
#
|
212
221
|
# @param add_recurring_commits [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit>]
|
213
222
|
#
|
@@ -219,7 +228,7 @@ module MetronomeSDK
|
|
219
228
|
#
|
220
229
|
# @param add_spend_threshold_configuration [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSpendThresholdConfiguration]
|
221
230
|
#
|
222
|
-
# @param add_subscriptions [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription>]
|
231
|
+
# @param add_subscriptions [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription>] List of subscriptions on the contract.
|
223
232
|
#
|
224
233
|
# @param add_usage_filters [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddUsageFilter>]
|
225
234
|
#
|
@@ -237,6 +246,8 @@ module MetronomeSDK
|
|
237
246
|
#
|
238
247
|
# @param update_contract_end_date [Time]
|
239
248
|
#
|
249
|
+
# @param update_contract_name [String, nil] Value to update the contract name to. If not provided, the contract name will re
|
250
|
+
#
|
240
251
|
# @param update_credits [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateCredit>]
|
241
252
|
#
|
242
253
|
# @param update_discounts [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateDiscount>]
|
@@ -253,7 +264,7 @@ module MetronomeSDK
|
|
253
264
|
#
|
254
265
|
# @param update_spend_threshold_configuration [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSpendThresholdConfiguration]
|
255
266
|
#
|
256
|
-
# @param update_subscriptions [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription>]
|
267
|
+
# @param update_subscriptions [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription>] Optional list of subscriptions to update.
|
257
268
|
|
258
269
|
class AddCommit < MetronomeSDK::Internal::Type::BaseModel
|
259
270
|
# @!attribute id
|
@@ -277,9 +288,8 @@ module MetronomeSDK
|
|
277
288
|
# The schedule that the customer will gain access to the credits purposed with
|
278
289
|
# this commit.
|
279
290
|
#
|
280
|
-
# @return [MetronomeSDK::Models::
|
281
|
-
optional :access_schedule,
|
282
|
-
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCommit::AccessSchedule }
|
291
|
+
# @return [MetronomeSDK::Models::ScheduleDuration, nil]
|
292
|
+
optional :access_schedule, -> { MetronomeSDK::ScheduleDuration }
|
283
293
|
|
284
294
|
# @!attribute applicable_product_ids
|
285
295
|
#
|
@@ -299,9 +309,8 @@ module MetronomeSDK
|
|
299
309
|
# @!attribute invoice_schedule
|
300
310
|
# The schedule that the customer will be invoiced for this commit.
|
301
311
|
#
|
302
|
-
# @return [MetronomeSDK::Models::
|
303
|
-
optional :invoice_schedule,
|
304
|
-
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCommit::InvoiceSchedule }
|
312
|
+
# @return [MetronomeSDK::Models::SchedulePointInTime, nil]
|
313
|
+
optional :invoice_schedule, -> { MetronomeSDK::SchedulePointInTime }
|
305
314
|
|
306
315
|
# @!attribute name
|
307
316
|
#
|
@@ -359,7 +368,7 @@ module MetronomeSDK
|
|
359
368
|
#
|
360
369
|
# @param type [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCommit::Type]
|
361
370
|
#
|
362
|
-
# @param access_schedule [MetronomeSDK::Models::
|
371
|
+
# @param access_schedule [MetronomeSDK::Models::ScheduleDuration] The schedule that the customer will gain access to the credits purposed with thi
|
363
372
|
#
|
364
373
|
# @param applicable_product_ids [Array<String>]
|
365
374
|
#
|
@@ -367,7 +376,7 @@ module MetronomeSDK
|
|
367
376
|
#
|
368
377
|
# @param description [String]
|
369
378
|
#
|
370
|
-
# @param invoice_schedule [MetronomeSDK::Models::
|
379
|
+
# @param invoice_schedule [MetronomeSDK::Models::SchedulePointInTime] The schedule that the customer will be invoiced for this commit.
|
371
380
|
#
|
372
381
|
# @param name [String]
|
373
382
|
#
|
@@ -411,151 +420,6 @@ module MetronomeSDK
|
|
411
420
|
# @return [Array<Symbol>]
|
412
421
|
end
|
413
422
|
|
414
|
-
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCommit#access_schedule
|
415
|
-
class AccessSchedule < MetronomeSDK::Internal::Type::BaseModel
|
416
|
-
# @!attribute schedule_items
|
417
|
-
#
|
418
|
-
# @return [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCommit::AccessSchedule::ScheduleItem>]
|
419
|
-
required :schedule_items,
|
420
|
-
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCommit::AccessSchedule::ScheduleItem] }
|
421
|
-
|
422
|
-
# @!attribute credit_type
|
423
|
-
#
|
424
|
-
# @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCommit::AccessSchedule::CreditType, nil]
|
425
|
-
optional :credit_type,
|
426
|
-
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCommit::AccessSchedule::CreditType }
|
427
|
-
|
428
|
-
# @!method initialize(schedule_items:, credit_type: nil)
|
429
|
-
# The schedule that the customer will gain access to the credits purposed with
|
430
|
-
# this commit.
|
431
|
-
#
|
432
|
-
# @param schedule_items [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCommit::AccessSchedule::ScheduleItem>]
|
433
|
-
# @param credit_type [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCommit::AccessSchedule::CreditType]
|
434
|
-
|
435
|
-
class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
|
436
|
-
# @!attribute id
|
437
|
-
#
|
438
|
-
# @return [String]
|
439
|
-
required :id, String
|
440
|
-
|
441
|
-
# @!attribute amount
|
442
|
-
#
|
443
|
-
# @return [Float]
|
444
|
-
required :amount, Float
|
445
|
-
|
446
|
-
# @!attribute ending_before
|
447
|
-
#
|
448
|
-
# @return [Time]
|
449
|
-
required :ending_before, Time
|
450
|
-
|
451
|
-
# @!attribute starting_at
|
452
|
-
#
|
453
|
-
# @return [Time]
|
454
|
-
required :starting_at, Time
|
455
|
-
|
456
|
-
# @!method initialize(id:, amount:, ending_before:, starting_at:)
|
457
|
-
# @param id [String]
|
458
|
-
# @param amount [Float]
|
459
|
-
# @param ending_before [Time]
|
460
|
-
# @param starting_at [Time]
|
461
|
-
end
|
462
|
-
|
463
|
-
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCommit::AccessSchedule#credit_type
|
464
|
-
class CreditType < MetronomeSDK::Internal::Type::BaseModel
|
465
|
-
# @!attribute id
|
466
|
-
#
|
467
|
-
# @return [String]
|
468
|
-
required :id, String
|
469
|
-
|
470
|
-
# @!attribute name
|
471
|
-
#
|
472
|
-
# @return [String]
|
473
|
-
required :name, String
|
474
|
-
|
475
|
-
# @!method initialize(id:, name:)
|
476
|
-
# @param id [String]
|
477
|
-
# @param name [String]
|
478
|
-
end
|
479
|
-
end
|
480
|
-
|
481
|
-
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCommit#invoice_schedule
|
482
|
-
class InvoiceSchedule < MetronomeSDK::Internal::Type::BaseModel
|
483
|
-
# @!attribute credit_type
|
484
|
-
#
|
485
|
-
# @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCommit::InvoiceSchedule::CreditType, nil]
|
486
|
-
optional :credit_type,
|
487
|
-
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCommit::InvoiceSchedule::CreditType }
|
488
|
-
|
489
|
-
# @!attribute schedule_items
|
490
|
-
#
|
491
|
-
# @return [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCommit::InvoiceSchedule::ScheduleItem>, nil]
|
492
|
-
optional :schedule_items,
|
493
|
-
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCommit::InvoiceSchedule::ScheduleItem] }
|
494
|
-
|
495
|
-
# @!method initialize(credit_type: nil, schedule_items: nil)
|
496
|
-
# The schedule that the customer will be invoiced for this commit.
|
497
|
-
#
|
498
|
-
# @param credit_type [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCommit::InvoiceSchedule::CreditType]
|
499
|
-
# @param schedule_items [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCommit::InvoiceSchedule::ScheduleItem>]
|
500
|
-
|
501
|
-
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCommit::InvoiceSchedule#credit_type
|
502
|
-
class CreditType < MetronomeSDK::Internal::Type::BaseModel
|
503
|
-
# @!attribute id
|
504
|
-
#
|
505
|
-
# @return [String]
|
506
|
-
required :id, String
|
507
|
-
|
508
|
-
# @!attribute name
|
509
|
-
#
|
510
|
-
# @return [String]
|
511
|
-
required :name, String
|
512
|
-
|
513
|
-
# @!method initialize(id:, name:)
|
514
|
-
# @param id [String]
|
515
|
-
# @param name [String]
|
516
|
-
end
|
517
|
-
|
518
|
-
class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
|
519
|
-
# @!attribute id
|
520
|
-
#
|
521
|
-
# @return [String]
|
522
|
-
required :id, String
|
523
|
-
|
524
|
-
# @!attribute amount
|
525
|
-
#
|
526
|
-
# @return [Float]
|
527
|
-
required :amount, Float
|
528
|
-
|
529
|
-
# @!attribute invoice_id
|
530
|
-
#
|
531
|
-
# @return [String]
|
532
|
-
required :invoice_id, String
|
533
|
-
|
534
|
-
# @!attribute quantity
|
535
|
-
#
|
536
|
-
# @return [Float]
|
537
|
-
required :quantity, Float
|
538
|
-
|
539
|
-
# @!attribute timestamp
|
540
|
-
#
|
541
|
-
# @return [Time]
|
542
|
-
required :timestamp, Time
|
543
|
-
|
544
|
-
# @!attribute unit_price
|
545
|
-
#
|
546
|
-
# @return [Float]
|
547
|
-
required :unit_price, Float
|
548
|
-
|
549
|
-
# @!method initialize(id:, amount:, invoice_id:, quantity:, timestamp:, unit_price:)
|
550
|
-
# @param id [String]
|
551
|
-
# @param amount [Float]
|
552
|
-
# @param invoice_id [String]
|
553
|
-
# @param quantity [Float]
|
554
|
-
# @param timestamp [Time]
|
555
|
-
# @param unit_price [Float]
|
556
|
-
end
|
557
|
-
end
|
558
|
-
|
559
423
|
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCommit#rate_type
|
560
424
|
module RateType
|
561
425
|
extend MetronomeSDK::Internal::Type::Enum
|
@@ -627,9 +491,8 @@ module MetronomeSDK
|
|
627
491
|
# @!attribute access_schedule
|
628
492
|
# The schedule that the customer will gain access to the credits.
|
629
493
|
#
|
630
|
-
# @return [MetronomeSDK::Models::
|
631
|
-
optional :access_schedule,
|
632
|
-
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCredit::AccessSchedule }
|
494
|
+
# @return [MetronomeSDK::Models::ScheduleDuration, nil]
|
495
|
+
optional :access_schedule, -> { MetronomeSDK::ScheduleDuration }
|
633
496
|
|
634
497
|
# @!attribute applicable_product_ids
|
635
498
|
#
|
@@ -691,7 +554,7 @@ module MetronomeSDK
|
|
691
554
|
#
|
692
555
|
# @param type [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCredit::Type]
|
693
556
|
#
|
694
|
-
# @param access_schedule [MetronomeSDK::Models::
|
557
|
+
# @param access_schedule [MetronomeSDK::Models::ScheduleDuration] The schedule that the customer will gain access to the credits.
|
695
558
|
#
|
696
559
|
# @param applicable_product_ids [Array<String>]
|
697
560
|
#
|
@@ -736,72 +599,6 @@ module MetronomeSDK
|
|
736
599
|
# @return [Array<Symbol>]
|
737
600
|
end
|
738
601
|
|
739
|
-
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCredit#access_schedule
|
740
|
-
class AccessSchedule < MetronomeSDK::Internal::Type::BaseModel
|
741
|
-
# @!attribute schedule_items
|
742
|
-
#
|
743
|
-
# @return [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCredit::AccessSchedule::ScheduleItem>]
|
744
|
-
required :schedule_items,
|
745
|
-
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCredit::AccessSchedule::ScheduleItem] }
|
746
|
-
|
747
|
-
# @!attribute credit_type
|
748
|
-
#
|
749
|
-
# @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCredit::AccessSchedule::CreditType, nil]
|
750
|
-
optional :credit_type,
|
751
|
-
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCredit::AccessSchedule::CreditType }
|
752
|
-
|
753
|
-
# @!method initialize(schedule_items:, credit_type: nil)
|
754
|
-
# The schedule that the customer will gain access to the credits.
|
755
|
-
#
|
756
|
-
# @param schedule_items [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCredit::AccessSchedule::ScheduleItem>]
|
757
|
-
# @param credit_type [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCredit::AccessSchedule::CreditType]
|
758
|
-
|
759
|
-
class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
|
760
|
-
# @!attribute id
|
761
|
-
#
|
762
|
-
# @return [String]
|
763
|
-
required :id, String
|
764
|
-
|
765
|
-
# @!attribute amount
|
766
|
-
#
|
767
|
-
# @return [Float]
|
768
|
-
required :amount, Float
|
769
|
-
|
770
|
-
# @!attribute ending_before
|
771
|
-
#
|
772
|
-
# @return [Time]
|
773
|
-
required :ending_before, Time
|
774
|
-
|
775
|
-
# @!attribute starting_at
|
776
|
-
#
|
777
|
-
# @return [Time]
|
778
|
-
required :starting_at, Time
|
779
|
-
|
780
|
-
# @!method initialize(id:, amount:, ending_before:, starting_at:)
|
781
|
-
# @param id [String]
|
782
|
-
# @param amount [Float]
|
783
|
-
# @param ending_before [Time]
|
784
|
-
# @param starting_at [Time]
|
785
|
-
end
|
786
|
-
|
787
|
-
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCredit::AccessSchedule#credit_type
|
788
|
-
class CreditType < MetronomeSDK::Internal::Type::BaseModel
|
789
|
-
# @!attribute id
|
790
|
-
#
|
791
|
-
# @return [String]
|
792
|
-
required :id, String
|
793
|
-
|
794
|
-
# @!attribute name
|
795
|
-
#
|
796
|
-
# @return [String]
|
797
|
-
required :name, String
|
798
|
-
|
799
|
-
# @!method initialize(id:, name:)
|
800
|
-
# @param id [String]
|
801
|
-
# @param name [String]
|
802
|
-
end
|
803
|
-
end
|
804
|
-
|
805
602
|
class Specifier < MetronomeSDK::Internal::Type::BaseModel
|
806
603
|
# @!attribute presentation_group_values
|
807
604
|
#
|
@@ -841,147 +638,6 @@ module MetronomeSDK
|
|
841
638
|
end
|
842
639
|
end
|
843
640
|
|
844
|
-
class AddDiscount < MetronomeSDK::Internal::Type::BaseModel
|
845
|
-
# @!attribute id
|
846
|
-
#
|
847
|
-
# @return [String]
|
848
|
-
required :id, String
|
849
|
-
|
850
|
-
# @!attribute product
|
851
|
-
#
|
852
|
-
# @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddDiscount::Product]
|
853
|
-
required :product,
|
854
|
-
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddDiscount::Product }
|
855
|
-
|
856
|
-
# @!attribute schedule
|
857
|
-
#
|
858
|
-
# @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddDiscount::Schedule]
|
859
|
-
required :schedule,
|
860
|
-
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddDiscount::Schedule }
|
861
|
-
|
862
|
-
# @!attribute custom_fields
|
863
|
-
#
|
864
|
-
# @return [Hash{Symbol=>String}, nil]
|
865
|
-
optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
|
866
|
-
|
867
|
-
# @!attribute name
|
868
|
-
#
|
869
|
-
# @return [String, nil]
|
870
|
-
optional :name, String
|
871
|
-
|
872
|
-
# @!attribute netsuite_sales_order_id
|
873
|
-
# This field's availability is dependent on your client's configuration.
|
874
|
-
#
|
875
|
-
# @return [String, nil]
|
876
|
-
optional :netsuite_sales_order_id, String
|
877
|
-
|
878
|
-
# @!method initialize(id:, product:, schedule:, custom_fields: nil, name: nil, netsuite_sales_order_id: nil)
|
879
|
-
# @param id [String]
|
880
|
-
#
|
881
|
-
# @param product [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddDiscount::Product]
|
882
|
-
#
|
883
|
-
# @param schedule [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddDiscount::Schedule]
|
884
|
-
#
|
885
|
-
# @param custom_fields [Hash{Symbol=>String}]
|
886
|
-
#
|
887
|
-
# @param name [String]
|
888
|
-
#
|
889
|
-
# @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
|
890
|
-
|
891
|
-
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddDiscount#product
|
892
|
-
class Product < MetronomeSDK::Internal::Type::BaseModel
|
893
|
-
# @!attribute id
|
894
|
-
#
|
895
|
-
# @return [String]
|
896
|
-
required :id, String
|
897
|
-
|
898
|
-
# @!attribute name
|
899
|
-
#
|
900
|
-
# @return [String]
|
901
|
-
required :name, String
|
902
|
-
|
903
|
-
# @!method initialize(id:, name:)
|
904
|
-
# @param id [String]
|
905
|
-
# @param name [String]
|
906
|
-
end
|
907
|
-
|
908
|
-
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddDiscount#schedule
|
909
|
-
class Schedule < MetronomeSDK::Internal::Type::BaseModel
|
910
|
-
# @!attribute credit_type
|
911
|
-
#
|
912
|
-
# @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddDiscount::Schedule::CreditType, nil]
|
913
|
-
optional :credit_type,
|
914
|
-
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddDiscount::Schedule::CreditType }
|
915
|
-
|
916
|
-
# @!attribute schedule_items
|
917
|
-
#
|
918
|
-
# @return [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddDiscount::Schedule::ScheduleItem>, nil]
|
919
|
-
optional :schedule_items,
|
920
|
-
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddDiscount::Schedule::ScheduleItem] }
|
921
|
-
|
922
|
-
# @!method initialize(credit_type: nil, schedule_items: nil)
|
923
|
-
# @param credit_type [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddDiscount::Schedule::CreditType]
|
924
|
-
# @param schedule_items [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddDiscount::Schedule::ScheduleItem>]
|
925
|
-
|
926
|
-
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddDiscount::Schedule#credit_type
|
927
|
-
class CreditType < MetronomeSDK::Internal::Type::BaseModel
|
928
|
-
# @!attribute id
|
929
|
-
#
|
930
|
-
# @return [String]
|
931
|
-
required :id, String
|
932
|
-
|
933
|
-
# @!attribute name
|
934
|
-
#
|
935
|
-
# @return [String]
|
936
|
-
required :name, String
|
937
|
-
|
938
|
-
# @!method initialize(id:, name:)
|
939
|
-
# @param id [String]
|
940
|
-
# @param name [String]
|
941
|
-
end
|
942
|
-
|
943
|
-
class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
|
944
|
-
# @!attribute id
|
945
|
-
#
|
946
|
-
# @return [String]
|
947
|
-
required :id, String
|
948
|
-
|
949
|
-
# @!attribute amount
|
950
|
-
#
|
951
|
-
# @return [Float]
|
952
|
-
required :amount, Float
|
953
|
-
|
954
|
-
# @!attribute invoice_id
|
955
|
-
#
|
956
|
-
# @return [String]
|
957
|
-
required :invoice_id, String
|
958
|
-
|
959
|
-
# @!attribute quantity
|
960
|
-
#
|
961
|
-
# @return [Float]
|
962
|
-
required :quantity, Float
|
963
|
-
|
964
|
-
# @!attribute timestamp
|
965
|
-
#
|
966
|
-
# @return [Time]
|
967
|
-
required :timestamp, Time
|
968
|
-
|
969
|
-
# @!attribute unit_price
|
970
|
-
#
|
971
|
-
# @return [Float]
|
972
|
-
required :unit_price, Float
|
973
|
-
|
974
|
-
# @!method initialize(id:, amount:, invoice_id:, quantity:, timestamp:, unit_price:)
|
975
|
-
# @param id [String]
|
976
|
-
# @param amount [Float]
|
977
|
-
# @param invoice_id [String]
|
978
|
-
# @param quantity [Float]
|
979
|
-
# @param timestamp [Time]
|
980
|
-
# @param unit_price [Float]
|
981
|
-
end
|
982
|
-
end
|
983
|
-
end
|
984
|
-
|
985
641
|
class AddOverride < MetronomeSDK::Internal::Type::BaseModel
|
986
642
|
# @!attribute id
|
987
643
|
#
|
@@ -1167,9 +823,8 @@ module MetronomeSDK
|
|
1167
823
|
|
1168
824
|
# @!attribute credit_type
|
1169
825
|
#
|
1170
|
-
# @return [MetronomeSDK::Models::
|
1171
|
-
optional :credit_type,
|
1172
|
-
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride::OverwriteRate::CreditType }
|
826
|
+
# @return [MetronomeSDK::Models::CreditTypeData, nil]
|
827
|
+
optional :credit_type, -> { MetronomeSDK::CreditTypeData }
|
1173
828
|
|
1174
829
|
# @!attribute custom_rate
|
1175
830
|
# Only set for CUSTOM rate_type. This field is interpreted by custom rate
|
@@ -1202,9 +857,8 @@ module MetronomeSDK
|
|
1202
857
|
# @!attribute tiers
|
1203
858
|
# Only set for TIERED rate_type.
|
1204
859
|
#
|
1205
|
-
# @return [Array<MetronomeSDK::Models::
|
1206
|
-
optional :tiers,
|
1207
|
-
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride::OverwriteRate::Tier] }
|
860
|
+
# @return [Array<MetronomeSDK::Models::Tier>, nil]
|
861
|
+
optional :tiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Tier] }
|
1208
862
|
|
1209
863
|
# @!method initialize(rate_type:, credit_type: nil, custom_rate: nil, is_prorated: nil, price: nil, quantity: nil, tiers: nil)
|
1210
864
|
# Some parameter documentations has been truncated, see
|
@@ -1213,7 +867,7 @@ module MetronomeSDK
|
|
1213
867
|
#
|
1214
868
|
# @param rate_type [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride::OverwriteRate::RateType]
|
1215
869
|
#
|
1216
|
-
# @param credit_type [MetronomeSDK::Models::
|
870
|
+
# @param credit_type [MetronomeSDK::Models::CreditTypeData]
|
1217
871
|
#
|
1218
872
|
# @param custom_rate [Hash{Symbol=>Object}] Only set for CUSTOM rate_type. This field is interpreted by custom rate processo
|
1219
873
|
#
|
@@ -1223,7 +877,7 @@ module MetronomeSDK
|
|
1223
877
|
#
|
1224
878
|
# @param quantity [Float] Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
|
1225
879
|
#
|
1226
|
-
# @param tiers [Array<MetronomeSDK::Models::
|
880
|
+
# @param tiers [Array<MetronomeSDK::Models::Tier>] Only set for TIERED rate_type.
|
1227
881
|
|
1228
882
|
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride::OverwriteRate#rate_type
|
1229
883
|
module RateType
|
@@ -1238,39 +892,6 @@ module MetronomeSDK
|
|
1238
892
|
# @!method self.values
|
1239
893
|
# @return [Array<Symbol>]
|
1240
894
|
end
|
1241
|
-
|
1242
|
-
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride::OverwriteRate#credit_type
|
1243
|
-
class CreditType < MetronomeSDK::Internal::Type::BaseModel
|
1244
|
-
# @!attribute id
|
1245
|
-
#
|
1246
|
-
# @return [String]
|
1247
|
-
required :id, String
|
1248
|
-
|
1249
|
-
# @!attribute name
|
1250
|
-
#
|
1251
|
-
# @return [String]
|
1252
|
-
required :name, String
|
1253
|
-
|
1254
|
-
# @!method initialize(id:, name:)
|
1255
|
-
# @param id [String]
|
1256
|
-
# @param name [String]
|
1257
|
-
end
|
1258
|
-
|
1259
|
-
class Tier < MetronomeSDK::Internal::Type::BaseModel
|
1260
|
-
# @!attribute price
|
1261
|
-
#
|
1262
|
-
# @return [Float]
|
1263
|
-
required :price, Float
|
1264
|
-
|
1265
|
-
# @!attribute size
|
1266
|
-
#
|
1267
|
-
# @return [Float, nil]
|
1268
|
-
optional :size, Float
|
1269
|
-
|
1270
|
-
# @!method initialize(price:, size: nil)
|
1271
|
-
# @param price [Float]
|
1272
|
-
# @param size [Float]
|
1273
|
-
end
|
1274
895
|
end
|
1275
896
|
|
1276
897
|
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride#product
|
@@ -1349,7 +970,14 @@ module MetronomeSDK
|
|
1349
970
|
# @return [Float]
|
1350
971
|
required :threshold_amount, Float
|
1351
972
|
|
1352
|
-
# @!
|
973
|
+
# @!attribute custom_credit_type_id
|
974
|
+
# If provided, the threshold, recharge-to amount, and the resulting threshold
|
975
|
+
# commit amount will be in terms of this credit type instead of the fiat currency.
|
976
|
+
#
|
977
|
+
# @return [String, nil]
|
978
|
+
optional :custom_credit_type_id, String
|
979
|
+
|
980
|
+
# @!method initialize(commit:, is_enabled:, payment_gate_config:, recharge_to_amount:, threshold_amount:, custom_credit_type_id: nil)
|
1353
981
|
# Some parameter documentations has been truncated, see
|
1354
982
|
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddPrepaidBalanceThresholdConfiguration}
|
1355
983
|
# for more details.
|
@@ -1363,6 +991,8 @@ module MetronomeSDK
|
|
1363
991
|
# @param recharge_to_amount [Float] Specify the amount the balance should be recharged to.
|
1364
992
|
#
|
1365
993
|
# @param threshold_amount [Float] Specify the threshold amount for the contract. Each time the contract's balance
|
994
|
+
#
|
995
|
+
# @param custom_credit_type_id [String] If provided, the threshold, recharge-to amount, and the resulting threshold comm
|
1366
996
|
|
1367
997
|
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddPrepaidBalanceThresholdConfiguration#commit
|
1368
998
|
class Commit < MetronomeSDK::Internal::Type::BaseModel
|
@@ -1374,16 +1004,17 @@ module MetronomeSDK
|
|
1374
1004
|
required :product_id, String
|
1375
1005
|
|
1376
1006
|
# @!attribute applicable_product_ids
|
1377
|
-
# Which products the threshold commit applies to. If
|
1378
|
-
#
|
1379
|
-
# products.
|
1007
|
+
# Which products the threshold commit applies to. If applicable_product_ids,
|
1008
|
+
# applicable_product_tags or specifiers are not provided, the commit applies to
|
1009
|
+
# all products.
|
1380
1010
|
#
|
1381
1011
|
# @return [Array<String>, nil]
|
1382
1012
|
optional :applicable_product_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
|
1383
1013
|
|
1384
1014
|
# @!attribute applicable_product_tags
|
1385
|
-
# Which tags the threshold commit applies to. If
|
1386
|
-
# applicable_product_tags are not provided, the commit applies to
|
1015
|
+
# Which tags the threshold commit applies to. If applicable_product_ids,
|
1016
|
+
# applicable_product_tags or specifiers are not provided, the commit applies to
|
1017
|
+
# all products.
|
1387
1018
|
#
|
1388
1019
|
# @return [Array<String>, nil]
|
1389
1020
|
optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
|
@@ -1421,9 +1052,9 @@ module MetronomeSDK
|
|
1421
1052
|
#
|
1422
1053
|
# @param product_id [String] The commit product that will be used to generate the line item for commit paymen
|
1423
1054
|
#
|
1424
|
-
# @param applicable_product_ids [Array<String>] Which products the threshold commit applies to. If
|
1055
|
+
# @param applicable_product_ids [Array<String>] Which products the threshold commit applies to. If applicable_product_ids, appli
|
1425
1056
|
#
|
1426
|
-
# @param applicable_product_tags [Array<String>] Which tags the threshold commit applies to. If
|
1057
|
+
# @param applicable_product_tags [Array<String>] Which tags the threshold commit applies to. If applicable_product_ids, applicabl
|
1427
1058
|
#
|
1428
1059
|
# @param description [String]
|
1429
1060
|
#
|
@@ -1482,8 +1113,15 @@ module MetronomeSDK
|
|
1482
1113
|
required :payment_gate_type,
|
1483
1114
|
enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig::PaymentGateType }
|
1484
1115
|
|
1116
|
+
# @!attribute precalculated_tax_config
|
1117
|
+
# Only applicable if using PRECALCULATED as your tax type.
|
1118
|
+
#
|
1119
|
+
# @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig::PrecalculatedTaxConfig, nil]
|
1120
|
+
optional :precalculated_tax_config,
|
1121
|
+
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig::PrecalculatedTaxConfig }
|
1122
|
+
|
1485
1123
|
# @!attribute stripe_config
|
1486
|
-
# Only applicable if using
|
1124
|
+
# Only applicable if using STRIPE as your payment gateway type.
|
1487
1125
|
#
|
1488
1126
|
# @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig, nil]
|
1489
1127
|
optional :stripe_config,
|
@@ -1498,14 +1136,16 @@ module MetronomeSDK
|
|
1498
1136
|
optional :tax_type,
|
1499
1137
|
enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig::TaxType }
|
1500
1138
|
|
1501
|
-
# @!method initialize(payment_gate_type:, stripe_config: nil, tax_type: nil)
|
1139
|
+
# @!method initialize(payment_gate_type:, precalculated_tax_config: nil, stripe_config: nil, tax_type: nil)
|
1502
1140
|
# Some parameter documentations has been truncated, see
|
1503
1141
|
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig}
|
1504
1142
|
# for more details.
|
1505
1143
|
#
|
1506
1144
|
# @param payment_gate_type [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig::PaymentGateType] Gate access to the commit balance based on successful collection of payment. Sel
|
1507
1145
|
#
|
1508
|
-
# @param
|
1146
|
+
# @param precalculated_tax_config [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig::PrecalculatedTaxConfig] Only applicable if using PRECALCULATED as your tax type.
|
1147
|
+
#
|
1148
|
+
# @param stripe_config [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig] Only applicable if using STRIPE as your payment gateway type.
|
1509
1149
|
#
|
1510
1150
|
# @param tax_type [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig::TaxType] Stripe tax is only supported for Stripe payment gateway. Select NONE if you do n
|
1511
1151
|
|
@@ -1526,6 +1166,34 @@ module MetronomeSDK
|
|
1526
1166
|
# @return [Array<Symbol>]
|
1527
1167
|
end
|
1528
1168
|
|
1169
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig#precalculated_tax_config
|
1170
|
+
class PrecalculatedTaxConfig < MetronomeSDK::Internal::Type::BaseModel
|
1171
|
+
# @!attribute tax_amount
|
1172
|
+
# Amount of tax to be applied. This should be in the same currency and
|
1173
|
+
# denomination as the commit's invoice schedule
|
1174
|
+
#
|
1175
|
+
# @return [Float]
|
1176
|
+
required :tax_amount, Float
|
1177
|
+
|
1178
|
+
# @!attribute tax_name
|
1179
|
+
# Name of the tax to be applied. This may be used in an invoice line item
|
1180
|
+
# description.
|
1181
|
+
#
|
1182
|
+
# @return [String, nil]
|
1183
|
+
optional :tax_name, String
|
1184
|
+
|
1185
|
+
# @!method initialize(tax_amount:, tax_name: nil)
|
1186
|
+
# Some parameter documentations has been truncated, see
|
1187
|
+
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig::PrecalculatedTaxConfig}
|
1188
|
+
# for more details.
|
1189
|
+
#
|
1190
|
+
# Only applicable if using PRECALCULATED as your tax type.
|
1191
|
+
#
|
1192
|
+
# @param tax_amount [Float] Amount of tax to be applied. This should be in the same currency and denominatio
|
1193
|
+
#
|
1194
|
+
# @param tax_name [String] Name of the tax to be applied. This may be used in an invoice line item descript
|
1195
|
+
end
|
1196
|
+
|
1529
1197
|
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig#stripe_config
|
1530
1198
|
class StripeConfig < MetronomeSDK::Internal::Type::BaseModel
|
1531
1199
|
# @!attribute payment_type
|
@@ -1535,10 +1203,23 @@ module MetronomeSDK
|
|
1535
1203
|
required :payment_type,
|
1536
1204
|
enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType }
|
1537
1205
|
|
1538
|
-
# @!
|
1539
|
-
#
|
1206
|
+
# @!attribute invoice_metadata
|
1207
|
+
# Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
|
1208
|
+
# your payment type.
|
1209
|
+
#
|
1210
|
+
# @return [Hash{Symbol=>String}, nil]
|
1211
|
+
optional :invoice_metadata, MetronomeSDK::Internal::Type::HashOf[String]
|
1212
|
+
|
1213
|
+
# @!method initialize(payment_type:, invoice_metadata: nil)
|
1214
|
+
# Some parameter documentations has been truncated, see
|
1215
|
+
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig}
|
1216
|
+
# for more details.
|
1217
|
+
#
|
1218
|
+
# Only applicable if using STRIPE as your payment gateway type.
|
1540
1219
|
#
|
1541
1220
|
# @param payment_type [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType] If left blank, will default to INVOICE
|
1221
|
+
#
|
1222
|
+
# @param invoice_metadata [Hash{Symbol=>String}] Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
|
1542
1223
|
|
1543
1224
|
# If left blank, will default to INVOICE
|
1544
1225
|
#
|
@@ -1553,91 +1234,24 @@ module MetronomeSDK
|
|
1553
1234
|
# @return [Array<Symbol>]
|
1554
1235
|
end
|
1555
1236
|
end
|
1556
|
-
|
1557
|
-
# Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
|
1558
|
-
# not wish Metronome to calculate tax on your behalf. Leaving this field blank
|
1559
|
-
# will default to NONE.
|
1560
|
-
#
|
1561
|
-
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig#tax_type
|
1562
|
-
module TaxType
|
1563
|
-
extend MetronomeSDK::Internal::Type::Enum
|
1564
|
-
|
1565
|
-
NONE = :NONE
|
1566
|
-
STRIPE = :STRIPE
|
1567
|
-
|
1568
|
-
|
1569
|
-
|
1570
|
-
|
1571
|
-
|
1572
|
-
|
1573
|
-
|
1574
|
-
class AddProService < MetronomeSDK::Internal::Type::BaseModel
|
1575
|
-
# @!attribute id
|
1576
|
-
#
|
1577
|
-
# @return [String]
|
1578
|
-
required :id, String
|
1579
|
-
|
1580
|
-
# @!attribute max_amount
|
1581
|
-
# Maximum amount for the term.
|
1582
|
-
#
|
1583
|
-
# @return [Float]
|
1584
|
-
required :max_amount, Float
|
1585
|
-
|
1586
|
-
# @!attribute product_id
|
1587
|
-
#
|
1588
|
-
# @return [String]
|
1589
|
-
required :product_id, String
|
1590
|
-
|
1591
|
-
# @!attribute quantity
|
1592
|
-
# Quantity for the charge. Will be multiplied by unit_price to determine the
|
1593
|
-
# amount.
|
1594
|
-
#
|
1595
|
-
# @return [Float]
|
1596
|
-
required :quantity, Float
|
1597
|
-
|
1598
|
-
# @!attribute unit_price
|
1599
|
-
# Unit price for the charge. Will be multiplied by quantity to determine the
|
1600
|
-
# amount and must be specified.
|
1601
|
-
#
|
1602
|
-
# @return [Float]
|
1603
|
-
required :unit_price, Float
|
1604
|
-
|
1605
|
-
# @!attribute custom_fields
|
1606
|
-
#
|
1607
|
-
# @return [Hash{Symbol=>String}, nil]
|
1608
|
-
optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
|
1609
|
-
|
1610
|
-
# @!attribute description
|
1611
|
-
#
|
1612
|
-
# @return [String, nil]
|
1613
|
-
optional :description, String
|
1614
|
-
|
1615
|
-
# @!attribute netsuite_sales_order_id
|
1616
|
-
# This field's availability is dependent on your client's configuration.
|
1617
|
-
#
|
1618
|
-
# @return [String, nil]
|
1619
|
-
optional :netsuite_sales_order_id, String
|
1620
|
-
|
1621
|
-
# @!method initialize(id:, max_amount:, product_id:, quantity:, unit_price:, custom_fields: nil, description: nil, netsuite_sales_order_id: nil)
|
1622
|
-
# Some parameter documentations has been truncated, see
|
1623
|
-
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddProService}
|
1624
|
-
# for more details.
|
1625
|
-
#
|
1626
|
-
# @param id [String]
|
1627
|
-
#
|
1628
|
-
# @param max_amount [Float] Maximum amount for the term.
|
1629
|
-
#
|
1630
|
-
# @param product_id [String]
|
1631
|
-
#
|
1632
|
-
# @param quantity [Float] Quantity for the charge. Will be multiplied by unit_price to determine the amoun
|
1633
|
-
#
|
1634
|
-
# @param unit_price [Float] Unit price for the charge. Will be multiplied by quantity to determine the amoun
|
1635
|
-
#
|
1636
|
-
# @param custom_fields [Hash{Symbol=>String}]
|
1637
|
-
#
|
1638
|
-
# @param description [String]
|
1639
|
-
#
|
1640
|
-
# @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
|
1237
|
+
|
1238
|
+
# Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
|
1239
|
+
# not wish Metronome to calculate tax on your behalf. Leaving this field blank
|
1240
|
+
# will default to NONE.
|
1241
|
+
#
|
1242
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddPrepaidBalanceThresholdConfiguration::PaymentGateConfig#tax_type
|
1243
|
+
module TaxType
|
1244
|
+
extend MetronomeSDK::Internal::Type::Enum
|
1245
|
+
|
1246
|
+
NONE = :NONE
|
1247
|
+
STRIPE = :STRIPE
|
1248
|
+
ANROK = :ANROK
|
1249
|
+
PRECALCULATED = :PRECALCULATED
|
1250
|
+
|
1251
|
+
# @!method self.values
|
1252
|
+
# @return [Array<Symbol>]
|
1253
|
+
end
|
1254
|
+
end
|
1641
1255
|
end
|
1642
1256
|
|
1643
1257
|
class AddRecurringCommit < MetronomeSDK::Internal::Type::BaseModel
|
@@ -1715,6 +1329,13 @@ module MetronomeSDK
|
|
1715
1329
|
# @return [Time, nil]
|
1716
1330
|
optional :ending_before, Time
|
1717
1331
|
|
1332
|
+
# @!attribute hierarchy_configuration
|
1333
|
+
# Optional configuration for recurring commit/credit hierarchy access control
|
1334
|
+
#
|
1335
|
+
# @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::HierarchyConfiguration, nil]
|
1336
|
+
optional :hierarchy_configuration,
|
1337
|
+
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::HierarchyConfiguration }
|
1338
|
+
|
1718
1339
|
# @!attribute invoice_amount
|
1719
1340
|
# The amount the customer should be billed for the commit. Not required.
|
1720
1341
|
#
|
@@ -1770,7 +1391,7 @@ module MetronomeSDK
|
|
1770
1391
|
optional :specifiers,
|
1771
1392
|
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::Specifier] }
|
1772
1393
|
|
1773
|
-
# @!method initialize(id:, access_amount:, commit_duration:, priority:, product:, rate_type:, starting_at:, applicable_product_ids: nil, applicable_product_tags: nil, contract: nil, description: nil, ending_before: nil, invoice_amount: nil, name: nil, netsuite_sales_order_id: nil, proration: nil, recurrence_frequency: nil, rollover_fraction: nil, specifiers: nil)
|
1394
|
+
# @!method initialize(id:, access_amount:, commit_duration:, priority:, product:, rate_type:, starting_at:, applicable_product_ids: nil, applicable_product_tags: nil, contract: nil, description: nil, ending_before: nil, hierarchy_configuration: nil, invoice_amount: nil, name: nil, netsuite_sales_order_id: nil, proration: nil, recurrence_frequency: nil, rollover_fraction: nil, specifiers: nil)
|
1774
1395
|
# Some parameter documentations has been truncated, see
|
1775
1396
|
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit}
|
1776
1397
|
# for more details.
|
@@ -1799,6 +1420,8 @@ module MetronomeSDK
|
|
1799
1420
|
#
|
1800
1421
|
# @param ending_before [Time] Determines when the contract will stop creating recurring commits. Optional
|
1801
1422
|
#
|
1423
|
+
# @param hierarchy_configuration [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::HierarchyConfiguration] Optional configuration for recurring commit/credit hierarchy access control
|
1424
|
+
#
|
1802
1425
|
# @param invoice_amount [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::InvoiceAmount] The amount the customer should be billed for the commit. Not required.
|
1803
1426
|
#
|
1804
1427
|
# @param name [String] Displayed on invoices. Will be passed through to the individual commits
|
@@ -1820,22 +1443,22 @@ module MetronomeSDK
|
|
1820
1443
|
# @return [String]
|
1821
1444
|
required :credit_type_id, String
|
1822
1445
|
|
1823
|
-
# @!attribute quantity
|
1824
|
-
#
|
1825
|
-
# @return [Float]
|
1826
|
-
required :quantity, Float
|
1827
|
-
|
1828
1446
|
# @!attribute unit_price
|
1829
1447
|
#
|
1830
1448
|
# @return [Float]
|
1831
1449
|
required :unit_price, Float
|
1832
1450
|
|
1833
|
-
# @!
|
1451
|
+
# @!attribute quantity
|
1452
|
+
#
|
1453
|
+
# @return [Float, nil]
|
1454
|
+
optional :quantity, Float
|
1455
|
+
|
1456
|
+
# @!method initialize(credit_type_id:, unit_price:, quantity: nil)
|
1834
1457
|
# The amount of commit to grant.
|
1835
1458
|
#
|
1836
1459
|
# @param credit_type_id [String]
|
1837
|
-
# @param quantity [Float]
|
1838
1460
|
# @param unit_price [Float]
|
1461
|
+
# @param quantity [Float]
|
1839
1462
|
end
|
1840
1463
|
|
1841
1464
|
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit#commit_duration
|
@@ -1909,6 +1532,103 @@ module MetronomeSDK
|
|
1909
1532
|
# @param id [String]
|
1910
1533
|
end
|
1911
1534
|
|
1535
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit#hierarchy_configuration
|
1536
|
+
class HierarchyConfiguration < MetronomeSDK::Internal::Type::BaseModel
|
1537
|
+
# @!attribute child_access
|
1538
|
+
#
|
1539
|
+
# @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs]
|
1540
|
+
required :child_access,
|
1541
|
+
union: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::HierarchyConfiguration::ChildAccess }
|
1542
|
+
|
1543
|
+
# @!method initialize(child_access:)
|
1544
|
+
# Optional configuration for recurring commit/credit hierarchy access control
|
1545
|
+
#
|
1546
|
+
# @param child_access [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs]
|
1547
|
+
|
1548
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::HierarchyConfiguration#child_access
|
1549
|
+
module ChildAccess
|
1550
|
+
extend MetronomeSDK::Internal::Type::Union
|
1551
|
+
|
1552
|
+
variant -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll }
|
1553
|
+
|
1554
|
+
variant -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone }
|
1555
|
+
|
1556
|
+
variant -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs }
|
1557
|
+
|
1558
|
+
class CommitHierarchyChildAccessAll < MetronomeSDK::Internal::Type::BaseModel
|
1559
|
+
# @!attribute type
|
1560
|
+
#
|
1561
|
+
# @return [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type]
|
1562
|
+
required :type,
|
1563
|
+
enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type }
|
1564
|
+
|
1565
|
+
# @!method initialize(type:)
|
1566
|
+
# @param type [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type]
|
1567
|
+
|
1568
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll#type
|
1569
|
+
module Type
|
1570
|
+
extend MetronomeSDK::Internal::Type::Enum
|
1571
|
+
|
1572
|
+
ALL = :ALL
|
1573
|
+
|
1574
|
+
# @!method self.values
|
1575
|
+
# @return [Array<Symbol>]
|
1576
|
+
end
|
1577
|
+
end
|
1578
|
+
|
1579
|
+
class CommitHierarchyChildAccessNone < MetronomeSDK::Internal::Type::BaseModel
|
1580
|
+
# @!attribute type
|
1581
|
+
#
|
1582
|
+
# @return [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type]
|
1583
|
+
required :type,
|
1584
|
+
enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type }
|
1585
|
+
|
1586
|
+
# @!method initialize(type:)
|
1587
|
+
# @param type [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type]
|
1588
|
+
|
1589
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone#type
|
1590
|
+
module Type
|
1591
|
+
extend MetronomeSDK::Internal::Type::Enum
|
1592
|
+
|
1593
|
+
NONE = :NONE
|
1594
|
+
|
1595
|
+
# @!method self.values
|
1596
|
+
# @return [Array<Symbol>]
|
1597
|
+
end
|
1598
|
+
end
|
1599
|
+
|
1600
|
+
class CommitHierarchyChildAccessContractIDs < MetronomeSDK::Internal::Type::BaseModel
|
1601
|
+
# @!attribute contract_ids
|
1602
|
+
#
|
1603
|
+
# @return [Array<String>]
|
1604
|
+
required :contract_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
|
1605
|
+
|
1606
|
+
# @!attribute type
|
1607
|
+
#
|
1608
|
+
# @return [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type]
|
1609
|
+
required :type,
|
1610
|
+
enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type }
|
1611
|
+
|
1612
|
+
# @!method initialize(contract_ids:, type:)
|
1613
|
+
# @param contract_ids [Array<String>]
|
1614
|
+
# @param type [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type]
|
1615
|
+
|
1616
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs#type
|
1617
|
+
module Type
|
1618
|
+
extend MetronomeSDK::Internal::Type::Enum
|
1619
|
+
|
1620
|
+
CONTRACT_IDS = :CONTRACT_IDS
|
1621
|
+
|
1622
|
+
# @!method self.values
|
1623
|
+
# @return [Array<Symbol>]
|
1624
|
+
end
|
1625
|
+
end
|
1626
|
+
|
1627
|
+
# @!method self.variants
|
1628
|
+
# @return [Array(MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs)]
|
1629
|
+
end
|
1630
|
+
end
|
1631
|
+
|
1912
1632
|
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit#invoice_amount
|
1913
1633
|
class InvoiceAmount < MetronomeSDK::Internal::Type::BaseModel
|
1914
1634
|
# @!attribute credit_type_id
|
@@ -2083,6 +1803,13 @@ module MetronomeSDK
|
|
2083
1803
|
# @return [Time, nil]
|
2084
1804
|
optional :ending_before, Time
|
2085
1805
|
|
1806
|
+
# @!attribute hierarchy_configuration
|
1807
|
+
# Optional configuration for recurring commit/credit hierarchy access control
|
1808
|
+
#
|
1809
|
+
# @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::HierarchyConfiguration, nil]
|
1810
|
+
optional :hierarchy_configuration,
|
1811
|
+
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::HierarchyConfiguration }
|
1812
|
+
|
2086
1813
|
# @!attribute name
|
2087
1814
|
# Displayed on invoices. Will be passed through to the individual commits
|
2088
1815
|
#
|
@@ -2131,7 +1858,7 @@ module MetronomeSDK
|
|
2131
1858
|
optional :specifiers,
|
2132
1859
|
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::Specifier] }
|
2133
1860
|
|
2134
|
-
# @!method initialize(id:, access_amount:, commit_duration:, priority:, product:, rate_type:, starting_at:, applicable_product_ids: nil, applicable_product_tags: nil, contract: nil, description: nil, ending_before: nil, name: nil, netsuite_sales_order_id: nil, proration: nil, recurrence_frequency: nil, rollover_fraction: nil, specifiers: nil)
|
1861
|
+
# @!method initialize(id:, access_amount:, commit_duration:, priority:, product:, rate_type:, starting_at:, applicable_product_ids: nil, applicable_product_tags: nil, contract: nil, description: nil, ending_before: nil, hierarchy_configuration: nil, name: nil, netsuite_sales_order_id: nil, proration: nil, recurrence_frequency: nil, rollover_fraction: nil, specifiers: nil)
|
2135
1862
|
# Some parameter documentations has been truncated, see
|
2136
1863
|
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit}
|
2137
1864
|
# for more details.
|
@@ -2160,6 +1887,8 @@ module MetronomeSDK
|
|
2160
1887
|
#
|
2161
1888
|
# @param ending_before [Time] Determines when the contract will stop creating recurring commits. Optional
|
2162
1889
|
#
|
1890
|
+
# @param hierarchy_configuration [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::HierarchyConfiguration] Optional configuration for recurring commit/credit hierarchy access control
|
1891
|
+
#
|
2163
1892
|
# @param name [String] Displayed on invoices. Will be passed through to the individual commits
|
2164
1893
|
#
|
2165
1894
|
# @param netsuite_sales_order_id [String] Will be passed down to the individual commits
|
@@ -2179,22 +1908,22 @@ module MetronomeSDK
|
|
2179
1908
|
# @return [String]
|
2180
1909
|
required :credit_type_id, String
|
2181
1910
|
|
2182
|
-
# @!attribute quantity
|
2183
|
-
#
|
2184
|
-
# @return [Float]
|
2185
|
-
required :quantity, Float
|
2186
|
-
|
2187
1911
|
# @!attribute unit_price
|
2188
1912
|
#
|
2189
1913
|
# @return [Float]
|
2190
1914
|
required :unit_price, Float
|
2191
1915
|
|
2192
|
-
# @!
|
1916
|
+
# @!attribute quantity
|
1917
|
+
#
|
1918
|
+
# @return [Float, nil]
|
1919
|
+
optional :quantity, Float
|
1920
|
+
|
1921
|
+
# @!method initialize(credit_type_id:, unit_price:, quantity: nil)
|
2193
1922
|
# The amount of commit to grant.
|
2194
1923
|
#
|
2195
1924
|
# @param credit_type_id [String]
|
2196
|
-
# @param quantity [Float]
|
2197
1925
|
# @param unit_price [Float]
|
1926
|
+
# @param quantity [Float]
|
2198
1927
|
end
|
2199
1928
|
|
2200
1929
|
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit#commit_duration
|
@@ -2268,6 +1997,103 @@ module MetronomeSDK
|
|
2268
1997
|
# @param id [String]
|
2269
1998
|
end
|
2270
1999
|
|
2000
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit#hierarchy_configuration
|
2001
|
+
class HierarchyConfiguration < MetronomeSDK::Internal::Type::BaseModel
|
2002
|
+
# @!attribute child_access
|
2003
|
+
#
|
2004
|
+
# @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs]
|
2005
|
+
required :child_access,
|
2006
|
+
union: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::HierarchyConfiguration::ChildAccess }
|
2007
|
+
|
2008
|
+
# @!method initialize(child_access:)
|
2009
|
+
# Optional configuration for recurring commit/credit hierarchy access control
|
2010
|
+
#
|
2011
|
+
# @param child_access [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs]
|
2012
|
+
|
2013
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::HierarchyConfiguration#child_access
|
2014
|
+
module ChildAccess
|
2015
|
+
extend MetronomeSDK::Internal::Type::Union
|
2016
|
+
|
2017
|
+
variant -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll }
|
2018
|
+
|
2019
|
+
variant -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone }
|
2020
|
+
|
2021
|
+
variant -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs }
|
2022
|
+
|
2023
|
+
class CommitHierarchyChildAccessAll < MetronomeSDK::Internal::Type::BaseModel
|
2024
|
+
# @!attribute type
|
2025
|
+
#
|
2026
|
+
# @return [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type]
|
2027
|
+
required :type,
|
2028
|
+
enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type }
|
2029
|
+
|
2030
|
+
# @!method initialize(type:)
|
2031
|
+
# @param type [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type]
|
2032
|
+
|
2033
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll#type
|
2034
|
+
module Type
|
2035
|
+
extend MetronomeSDK::Internal::Type::Enum
|
2036
|
+
|
2037
|
+
ALL = :ALL
|
2038
|
+
|
2039
|
+
# @!method self.values
|
2040
|
+
# @return [Array<Symbol>]
|
2041
|
+
end
|
2042
|
+
end
|
2043
|
+
|
2044
|
+
class CommitHierarchyChildAccessNone < MetronomeSDK::Internal::Type::BaseModel
|
2045
|
+
# @!attribute type
|
2046
|
+
#
|
2047
|
+
# @return [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type]
|
2048
|
+
required :type,
|
2049
|
+
enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type }
|
2050
|
+
|
2051
|
+
# @!method initialize(type:)
|
2052
|
+
# @param type [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type]
|
2053
|
+
|
2054
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone#type
|
2055
|
+
module Type
|
2056
|
+
extend MetronomeSDK::Internal::Type::Enum
|
2057
|
+
|
2058
|
+
NONE = :NONE
|
2059
|
+
|
2060
|
+
# @!method self.values
|
2061
|
+
# @return [Array<Symbol>]
|
2062
|
+
end
|
2063
|
+
end
|
2064
|
+
|
2065
|
+
class CommitHierarchyChildAccessContractIDs < MetronomeSDK::Internal::Type::BaseModel
|
2066
|
+
# @!attribute contract_ids
|
2067
|
+
#
|
2068
|
+
# @return [Array<String>]
|
2069
|
+
required :contract_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
|
2070
|
+
|
2071
|
+
# @!attribute type
|
2072
|
+
#
|
2073
|
+
# @return [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type]
|
2074
|
+
required :type,
|
2075
|
+
enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type }
|
2076
|
+
|
2077
|
+
# @!method initialize(contract_ids:, type:)
|
2078
|
+
# @param contract_ids [Array<String>]
|
2079
|
+
# @param type [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type]
|
2080
|
+
|
2081
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs#type
|
2082
|
+
module Type
|
2083
|
+
extend MetronomeSDK::Internal::Type::Enum
|
2084
|
+
|
2085
|
+
CONTRACT_IDS = :CONTRACT_IDS
|
2086
|
+
|
2087
|
+
# @!method self.values
|
2088
|
+
# @return [Array<Symbol>]
|
2089
|
+
end
|
2090
|
+
end
|
2091
|
+
|
2092
|
+
# @!method self.variants
|
2093
|
+
# @return [Array(MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs)]
|
2094
|
+
end
|
2095
|
+
end
|
2096
|
+
|
2271
2097
|
# Determines whether the first and last commit will be prorated. If not provided,
|
2272
2098
|
# the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).
|
2273
2099
|
#
|
@@ -2452,9 +2278,8 @@ module MetronomeSDK
|
|
2452
2278
|
|
2453
2279
|
# @!attribute schedule
|
2454
2280
|
#
|
2455
|
-
# @return [MetronomeSDK::Models::
|
2456
|
-
required :schedule,
|
2457
|
-
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddScheduledCharge::Schedule }
|
2281
|
+
# @return [MetronomeSDK::Models::SchedulePointInTime]
|
2282
|
+
required :schedule, -> { MetronomeSDK::SchedulePointInTime }
|
2458
2283
|
|
2459
2284
|
# @!attribute name
|
2460
2285
|
# displayed on invoices
|
@@ -2473,7 +2298,7 @@ module MetronomeSDK
|
|
2473
2298
|
#
|
2474
2299
|
# @param product [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddScheduledCharge::Product]
|
2475
2300
|
#
|
2476
|
-
# @param schedule [MetronomeSDK::Models::
|
2301
|
+
# @param schedule [MetronomeSDK::Models::SchedulePointInTime]
|
2477
2302
|
#
|
2478
2303
|
# @param name [String] displayed on invoices
|
2479
2304
|
#
|
@@ -2495,82 +2320,6 @@ module MetronomeSDK
|
|
2495
2320
|
# @param id [String]
|
2496
2321
|
# @param name [String]
|
2497
2322
|
end
|
2498
|
-
|
2499
|
-
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddScheduledCharge#schedule
|
2500
|
-
class Schedule < MetronomeSDK::Internal::Type::BaseModel
|
2501
|
-
# @!attribute credit_type
|
2502
|
-
#
|
2503
|
-
# @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddScheduledCharge::Schedule::CreditType, nil]
|
2504
|
-
optional :credit_type,
|
2505
|
-
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddScheduledCharge::Schedule::CreditType }
|
2506
|
-
|
2507
|
-
# @!attribute schedule_items
|
2508
|
-
#
|
2509
|
-
# @return [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddScheduledCharge::Schedule::ScheduleItem>, nil]
|
2510
|
-
optional :schedule_items,
|
2511
|
-
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddScheduledCharge::Schedule::ScheduleItem] }
|
2512
|
-
|
2513
|
-
# @!method initialize(credit_type: nil, schedule_items: nil)
|
2514
|
-
# @param credit_type [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddScheduledCharge::Schedule::CreditType]
|
2515
|
-
# @param schedule_items [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddScheduledCharge::Schedule::ScheduleItem>]
|
2516
|
-
|
2517
|
-
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddScheduledCharge::Schedule#credit_type
|
2518
|
-
class CreditType < MetronomeSDK::Internal::Type::BaseModel
|
2519
|
-
# @!attribute id
|
2520
|
-
#
|
2521
|
-
# @return [String]
|
2522
|
-
required :id, String
|
2523
|
-
|
2524
|
-
# @!attribute name
|
2525
|
-
#
|
2526
|
-
# @return [String]
|
2527
|
-
required :name, String
|
2528
|
-
|
2529
|
-
# @!method initialize(id:, name:)
|
2530
|
-
# @param id [String]
|
2531
|
-
# @param name [String]
|
2532
|
-
end
|
2533
|
-
|
2534
|
-
class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
|
2535
|
-
# @!attribute id
|
2536
|
-
#
|
2537
|
-
# @return [String]
|
2538
|
-
required :id, String
|
2539
|
-
|
2540
|
-
# @!attribute amount
|
2541
|
-
#
|
2542
|
-
# @return [Float]
|
2543
|
-
required :amount, Float
|
2544
|
-
|
2545
|
-
# @!attribute invoice_id
|
2546
|
-
#
|
2547
|
-
# @return [String]
|
2548
|
-
required :invoice_id, String
|
2549
|
-
|
2550
|
-
# @!attribute quantity
|
2551
|
-
#
|
2552
|
-
# @return [Float]
|
2553
|
-
required :quantity, Float
|
2554
|
-
|
2555
|
-
# @!attribute timestamp
|
2556
|
-
#
|
2557
|
-
# @return [Time]
|
2558
|
-
required :timestamp, Time
|
2559
|
-
|
2560
|
-
# @!attribute unit_price
|
2561
|
-
#
|
2562
|
-
# @return [Float]
|
2563
|
-
required :unit_price, Float
|
2564
|
-
|
2565
|
-
# @!method initialize(id:, amount:, invoice_id:, quantity:, timestamp:, unit_price:)
|
2566
|
-
# @param id [String]
|
2567
|
-
# @param amount [Float]
|
2568
|
-
# @param invoice_id [String]
|
2569
|
-
# @param quantity [Float]
|
2570
|
-
# @param timestamp [Time]
|
2571
|
-
# @param unit_price [Float]
|
2572
|
-
end
|
2573
|
-
end
|
2574
2323
|
end
|
2575
2324
|
|
2576
2325
|
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data#add_spend_threshold_configuration
|
@@ -2660,8 +2409,15 @@ module MetronomeSDK
|
|
2660
2409
|
required :payment_gate_type,
|
2661
2410
|
enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSpendThresholdConfiguration::PaymentGateConfig::PaymentGateType }
|
2662
2411
|
|
2412
|
+
# @!attribute precalculated_tax_config
|
2413
|
+
# Only applicable if using PRECALCULATED as your tax type.
|
2414
|
+
#
|
2415
|
+
# @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSpendThresholdConfiguration::PaymentGateConfig::PrecalculatedTaxConfig, nil]
|
2416
|
+
optional :precalculated_tax_config,
|
2417
|
+
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSpendThresholdConfiguration::PaymentGateConfig::PrecalculatedTaxConfig }
|
2418
|
+
|
2663
2419
|
# @!attribute stripe_config
|
2664
|
-
# Only applicable if using
|
2420
|
+
# Only applicable if using STRIPE as your payment gateway type.
|
2665
2421
|
#
|
2666
2422
|
# @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSpendThresholdConfiguration::PaymentGateConfig::StripeConfig, nil]
|
2667
2423
|
optional :stripe_config,
|
@@ -2676,14 +2432,16 @@ module MetronomeSDK
|
|
2676
2432
|
optional :tax_type,
|
2677
2433
|
enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSpendThresholdConfiguration::PaymentGateConfig::TaxType }
|
2678
2434
|
|
2679
|
-
# @!method initialize(payment_gate_type:, stripe_config: nil, tax_type: nil)
|
2435
|
+
# @!method initialize(payment_gate_type:, precalculated_tax_config: nil, stripe_config: nil, tax_type: nil)
|
2680
2436
|
# Some parameter documentations has been truncated, see
|
2681
2437
|
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSpendThresholdConfiguration::PaymentGateConfig}
|
2682
2438
|
# for more details.
|
2683
2439
|
#
|
2684
2440
|
# @param payment_gate_type [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSpendThresholdConfiguration::PaymentGateConfig::PaymentGateType] Gate access to the commit balance based on successful collection of payment. Sel
|
2685
2441
|
#
|
2686
|
-
# @param
|
2442
|
+
# @param precalculated_tax_config [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSpendThresholdConfiguration::PaymentGateConfig::PrecalculatedTaxConfig] Only applicable if using PRECALCULATED as your tax type.
|
2443
|
+
#
|
2444
|
+
# @param stripe_config [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSpendThresholdConfiguration::PaymentGateConfig::StripeConfig] Only applicable if using STRIPE as your payment gateway type.
|
2687
2445
|
#
|
2688
2446
|
# @param tax_type [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSpendThresholdConfiguration::PaymentGateConfig::TaxType] Stripe tax is only supported for Stripe payment gateway. Select NONE if you do n
|
2689
2447
|
|
@@ -2704,6 +2462,34 @@ module MetronomeSDK
|
|
2704
2462
|
# @return [Array<Symbol>]
|
2705
2463
|
end
|
2706
2464
|
|
2465
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSpendThresholdConfiguration::PaymentGateConfig#precalculated_tax_config
|
2466
|
+
class PrecalculatedTaxConfig < MetronomeSDK::Internal::Type::BaseModel
|
2467
|
+
# @!attribute tax_amount
|
2468
|
+
# Amount of tax to be applied. This should be in the same currency and
|
2469
|
+
# denomination as the commit's invoice schedule
|
2470
|
+
#
|
2471
|
+
# @return [Float]
|
2472
|
+
required :tax_amount, Float
|
2473
|
+
|
2474
|
+
# @!attribute tax_name
|
2475
|
+
# Name of the tax to be applied. This may be used in an invoice line item
|
2476
|
+
# description.
|
2477
|
+
#
|
2478
|
+
# @return [String, nil]
|
2479
|
+
optional :tax_name, String
|
2480
|
+
|
2481
|
+
# @!method initialize(tax_amount:, tax_name: nil)
|
2482
|
+
# Some parameter documentations has been truncated, see
|
2483
|
+
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSpendThresholdConfiguration::PaymentGateConfig::PrecalculatedTaxConfig}
|
2484
|
+
# for more details.
|
2485
|
+
#
|
2486
|
+
# Only applicable if using PRECALCULATED as your tax type.
|
2487
|
+
#
|
2488
|
+
# @param tax_amount [Float] Amount of tax to be applied. This should be in the same currency and denominatio
|
2489
|
+
#
|
2490
|
+
# @param tax_name [String] Name of the tax to be applied. This may be used in an invoice line item descript
|
2491
|
+
end
|
2492
|
+
|
2707
2493
|
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSpendThresholdConfiguration::PaymentGateConfig#stripe_config
|
2708
2494
|
class StripeConfig < MetronomeSDK::Internal::Type::BaseModel
|
2709
2495
|
# @!attribute payment_type
|
@@ -2713,10 +2499,23 @@ module MetronomeSDK
|
|
2713
2499
|
required :payment_type,
|
2714
2500
|
enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSpendThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType }
|
2715
2501
|
|
2716
|
-
# @!
|
2717
|
-
#
|
2502
|
+
# @!attribute invoice_metadata
|
2503
|
+
# Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
|
2504
|
+
# your payment type.
|
2505
|
+
#
|
2506
|
+
# @return [Hash{Symbol=>String}, nil]
|
2507
|
+
optional :invoice_metadata, MetronomeSDK::Internal::Type::HashOf[String]
|
2508
|
+
|
2509
|
+
# @!method initialize(payment_type:, invoice_metadata: nil)
|
2510
|
+
# Some parameter documentations has been truncated, see
|
2511
|
+
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSpendThresholdConfiguration::PaymentGateConfig::StripeConfig}
|
2512
|
+
# for more details.
|
2513
|
+
#
|
2514
|
+
# Only applicable if using STRIPE as your payment gateway type.
|
2718
2515
|
#
|
2719
2516
|
# @param payment_type [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSpendThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType] If left blank, will default to INVOICE
|
2517
|
+
#
|
2518
|
+
# @param invoice_metadata [Hash{Symbol=>String}] Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
|
2720
2519
|
|
2721
2520
|
# If left blank, will default to INVOICE
|
2722
2521
|
#
|
@@ -2742,6 +2541,8 @@ module MetronomeSDK
|
|
2742
2541
|
|
2743
2542
|
NONE = :NONE
|
2744
2543
|
STRIPE = :STRIPE
|
2544
|
+
ANROK = :ANROK
|
2545
|
+
PRECALCULATED = :PRECALCULATED
|
2745
2546
|
|
2746
2547
|
# @!method self.values
|
2747
2548
|
# @return [Array<Symbol>]
|
@@ -2763,6 +2564,8 @@ module MetronomeSDK
|
|
2763
2564
|
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::Proration }
|
2764
2565
|
|
2765
2566
|
# @!attribute quantity_schedule
|
2567
|
+
# List of quantity schedule items for the subscription. Only includes the current
|
2568
|
+
# quantity and future quantity changes.
|
2766
2569
|
#
|
2767
2570
|
# @return [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::QuantitySchedule>]
|
2768
2571
|
required :quantity_schedule,
|
@@ -2810,16 +2613,30 @@ module MetronomeSDK
|
|
2810
2613
|
optional :name, String
|
2811
2614
|
|
2812
2615
|
# @!method initialize(collection_schedule:, proration:, quantity_schedule:, starting_at:, subscription_rate:, id: nil, custom_fields: nil, description: nil, ending_before: nil, fiat_credit_type_id: nil, name: nil)
|
2616
|
+
# Some parameter documentations has been truncated, see
|
2617
|
+
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription}
|
2618
|
+
# for more details.
|
2619
|
+
#
|
2813
2620
|
# @param collection_schedule [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::CollectionSchedule]
|
2621
|
+
#
|
2814
2622
|
# @param proration [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::Proration]
|
2815
|
-
#
|
2623
|
+
#
|
2624
|
+
# @param quantity_schedule [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::QuantitySchedule>] List of quantity schedule items for the subscription. Only includes the current
|
2625
|
+
#
|
2816
2626
|
# @param starting_at [Time]
|
2627
|
+
#
|
2817
2628
|
# @param subscription_rate [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::SubscriptionRate]
|
2629
|
+
#
|
2818
2630
|
# @param id [String]
|
2631
|
+
#
|
2819
2632
|
# @param custom_fields [Hash{Symbol=>String}]
|
2633
|
+
#
|
2820
2634
|
# @param description [String]
|
2635
|
+
#
|
2821
2636
|
# @param ending_before [Time]
|
2637
|
+
#
|
2822
2638
|
# @param fiat_credit_type_id [String]
|
2639
|
+
#
|
2823
2640
|
# @param name [String]
|
2824
2641
|
|
2825
2642
|
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription#collection_schedule
|
@@ -3026,15 +2843,17 @@ module MetronomeSDK
|
|
3026
2843
|
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateCommit::AccessSchedule }
|
3027
2844
|
|
3028
2845
|
# @!attribute applicable_product_ids
|
3029
|
-
# Which products the commit applies to. If
|
3030
|
-
# applicable_product_tags are not provided, the commit applies to
|
2846
|
+
# Which products the commit applies to. If applicable_product_ids,
|
2847
|
+
# applicable_product_tags or specifiers are not provided, the commit applies to
|
2848
|
+
# all products.
|
3031
2849
|
#
|
3032
2850
|
# @return [Array<String>, nil]
|
3033
2851
|
optional :applicable_product_ids, MetronomeSDK::Internal::Type::ArrayOf[String], nil?: true
|
3034
2852
|
|
3035
2853
|
# @!attribute applicable_product_tags
|
3036
|
-
# Which tags the commit applies to. If
|
3037
|
-
# applicable_product_tags are not provided, the commit applies to
|
2854
|
+
# Which tags the commit applies to. If applicable_product_ids,
|
2855
|
+
# applicable_product_tags or specifiers are not provided, the commit applies to
|
2856
|
+
# all products.
|
3038
2857
|
#
|
3039
2858
|
# @return [Array<String>, nil]
|
3040
2859
|
optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String], nil?: true
|
@@ -3073,7 +2892,8 @@ module MetronomeSDK
|
|
3073
2892
|
#
|
3074
2893
|
# @return [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateCommit::Specifier>, nil]
|
3075
2894
|
optional :specifiers,
|
3076
|
-
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateCommit::Specifier] }
|
2895
|
+
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateCommit::Specifier] },
|
2896
|
+
nil?: true
|
3077
2897
|
|
3078
2898
|
# @!method initialize(id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, invoice_schedule: nil, name: nil, netsuite_sales_order_id: nil, product_id: nil, rollover_fraction: nil, specifiers: nil)
|
3079
2899
|
# Some parameter documentations has been truncated, see
|
@@ -3084,9 +2904,9 @@ module MetronomeSDK
|
|
3084
2904
|
#
|
3085
2905
|
# @param access_schedule [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateCommit::AccessSchedule]
|
3086
2906
|
#
|
3087
|
-
# @param applicable_product_ids [Array<String>, nil] Which products the commit applies to. If
|
2907
|
+
# @param applicable_product_ids [Array<String>, nil] Which products the commit applies to. If applicable_product_ids, applicable_prod
|
3088
2908
|
#
|
3089
|
-
# @param applicable_product_tags [Array<String>, nil] Which tags the commit applies to. If
|
2909
|
+
# @param applicable_product_tags [Array<String>, nil] Which tags the commit applies to. If applicable*product_ids, applicable_product*
|
3090
2910
|
#
|
3091
2911
|
# @param invoice_schedule [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateCommit::InvoiceSchedule]
|
3092
2912
|
#
|
@@ -3098,7 +2918,7 @@ module MetronomeSDK
|
|
3098
2918
|
#
|
3099
2919
|
# @param rollover_fraction [Float, nil]
|
3100
2920
|
#
|
3101
|
-
# @param specifiers [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateCommit::Specifier
|
2921
|
+
# @param specifiers [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateCommit::Specifier>, nil] List of filters that determine what kind of customer usage draws down a commit o
|
3102
2922
|
|
3103
2923
|
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateCommit#access_schedule
|
3104
2924
|
class AccessSchedule < MetronomeSDK::Internal::Type::BaseModel
|
@@ -3729,6 +3549,13 @@ module MetronomeSDK
|
|
3729
3549
|
optional :commit,
|
3730
3550
|
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::Commit }
|
3731
3551
|
|
3552
|
+
# @!attribute custom_credit_type_id
|
3553
|
+
# If provided, the threshold, recharge-to amount, and the resulting threshold
|
3554
|
+
# commit amount will be in terms of this credit type instead of the fiat currency.
|
3555
|
+
#
|
3556
|
+
# @return [String, nil]
|
3557
|
+
optional :custom_credit_type_id, String, nil?: true
|
3558
|
+
|
3732
3559
|
# @!attribute is_enabled
|
3733
3560
|
# When set to false, the contract will not be evaluated against the
|
3734
3561
|
# threshold_amount. Toggling to true will result an immediate evaluation,
|
@@ -3756,13 +3583,15 @@ module MetronomeSDK
|
|
3756
3583
|
# @return [Float, nil]
|
3757
3584
|
optional :threshold_amount, Float
|
3758
3585
|
|
3759
|
-
# @!method initialize(commit: nil, is_enabled: nil, payment_gate_config: nil, recharge_to_amount: nil, threshold_amount: nil)
|
3586
|
+
# @!method initialize(commit: nil, custom_credit_type_id: nil, is_enabled: nil, payment_gate_config: nil, recharge_to_amount: nil, threshold_amount: nil)
|
3760
3587
|
# Some parameter documentations has been truncated, see
|
3761
3588
|
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration}
|
3762
3589
|
# for more details.
|
3763
3590
|
#
|
3764
3591
|
# @param commit [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::Commit]
|
3765
3592
|
#
|
3593
|
+
# @param custom_credit_type_id [String, nil] If provided, the threshold, recharge-to amount, and the resulting threshold comm
|
3594
|
+
#
|
3766
3595
|
# @param is_enabled [Boolean] When set to false, the contract will not be evaluated against the threshold_amou
|
3767
3596
|
#
|
3768
3597
|
# @param payment_gate_config [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig]
|
@@ -3779,14 +3608,14 @@ module MetronomeSDK
|
|
3779
3608
|
# products.
|
3780
3609
|
#
|
3781
3610
|
# @return [Array<String>, nil]
|
3782
|
-
optional :applicable_product_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
|
3611
|
+
optional :applicable_product_ids, MetronomeSDK::Internal::Type::ArrayOf[String], nil?: true
|
3783
3612
|
|
3784
3613
|
# @!attribute applicable_product_tags
|
3785
3614
|
# Which tags the threshold commit applies to. If both applicable_product_ids and
|
3786
3615
|
# applicable_product_tags are not provided, the commit applies to all products.
|
3787
3616
|
#
|
3788
3617
|
# @return [Array<String>, nil]
|
3789
|
-
optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
|
3618
|
+
optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String], nil?: true
|
3790
3619
|
|
3791
3620
|
# @!attribute description
|
3792
3621
|
#
|
@@ -3819,16 +3648,17 @@ module MetronomeSDK
|
|
3819
3648
|
MetronomeSDK::Internal::Type::ArrayOf[
|
3820
3649
|
MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::Commit::Specifier
|
3821
3650
|
]
|
3822
|
-
end
|
3651
|
+
end,
|
3652
|
+
nil?: true
|
3823
3653
|
|
3824
3654
|
# @!method initialize(applicable_product_ids: nil, applicable_product_tags: nil, description: nil, name: nil, product_id: nil, specifiers: nil)
|
3825
3655
|
# Some parameter documentations has been truncated, see
|
3826
3656
|
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::Commit}
|
3827
3657
|
# for more details.
|
3828
3658
|
#
|
3829
|
-
# @param applicable_product_ids [Array<String
|
3659
|
+
# @param applicable_product_ids [Array<String>, nil] Which products the threshold commit applies to. If both applicable_product_ids a
|
3830
3660
|
#
|
3831
|
-
# @param applicable_product_tags [Array<String
|
3661
|
+
# @param applicable_product_tags [Array<String>, nil] Which tags the threshold commit applies to. If both applicable_product_ids and a
|
3832
3662
|
#
|
3833
3663
|
# @param description [String]
|
3834
3664
|
#
|
@@ -3836,7 +3666,7 @@ module MetronomeSDK
|
|
3836
3666
|
#
|
3837
3667
|
# @param product_id [String] The commit product that will be used to generate the line item for commit paymen
|
3838
3668
|
#
|
3839
|
-
# @param specifiers [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::Commit::Specifier
|
3669
|
+
# @param specifiers [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::Commit::Specifier>, nil] List of filters that determine what kind of customer usage draws down a commit o
|
3840
3670
|
|
3841
3671
|
class Specifier < MetronomeSDK::Internal::Type::BaseModel
|
3842
3672
|
# @!attribute presentation_group_values
|
@@ -3889,8 +3719,15 @@ module MetronomeSDK
|
|
3889
3719
|
required :payment_gate_type,
|
3890
3720
|
enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig::PaymentGateType }
|
3891
3721
|
|
3722
|
+
# @!attribute precalculated_tax_config
|
3723
|
+
# Only applicable if using PRECALCULATED as your tax type.
|
3724
|
+
#
|
3725
|
+
# @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig::PrecalculatedTaxConfig, nil]
|
3726
|
+
optional :precalculated_tax_config,
|
3727
|
+
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig::PrecalculatedTaxConfig }
|
3728
|
+
|
3892
3729
|
# @!attribute stripe_config
|
3893
|
-
# Only applicable if using
|
3730
|
+
# Only applicable if using STRIPE as your payment gateway type.
|
3894
3731
|
#
|
3895
3732
|
# @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig, nil]
|
3896
3733
|
optional :stripe_config,
|
@@ -3905,14 +3742,16 @@ module MetronomeSDK
|
|
3905
3742
|
optional :tax_type,
|
3906
3743
|
enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig::TaxType }
|
3907
3744
|
|
3908
|
-
# @!method initialize(payment_gate_type:, stripe_config: nil, tax_type: nil)
|
3745
|
+
# @!method initialize(payment_gate_type:, precalculated_tax_config: nil, stripe_config: nil, tax_type: nil)
|
3909
3746
|
# Some parameter documentations has been truncated, see
|
3910
3747
|
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig}
|
3911
3748
|
# for more details.
|
3912
3749
|
#
|
3913
3750
|
# @param payment_gate_type [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig::PaymentGateType] Gate access to the commit balance based on successful collection of payment. Sel
|
3914
3751
|
#
|
3915
|
-
# @param
|
3752
|
+
# @param precalculated_tax_config [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig::PrecalculatedTaxConfig] Only applicable if using PRECALCULATED as your tax type.
|
3753
|
+
#
|
3754
|
+
# @param stripe_config [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig] Only applicable if using STRIPE as your payment gateway type.
|
3916
3755
|
#
|
3917
3756
|
# @param tax_type [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig::TaxType] Stripe tax is only supported for Stripe payment gateway. Select NONE if you do n
|
3918
3757
|
|
@@ -3933,6 +3772,34 @@ module MetronomeSDK
|
|
3933
3772
|
# @return [Array<Symbol>]
|
3934
3773
|
end
|
3935
3774
|
|
3775
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig#precalculated_tax_config
|
3776
|
+
class PrecalculatedTaxConfig < MetronomeSDK::Internal::Type::BaseModel
|
3777
|
+
# @!attribute tax_amount
|
3778
|
+
# Amount of tax to be applied. This should be in the same currency and
|
3779
|
+
# denomination as the commit's invoice schedule
|
3780
|
+
#
|
3781
|
+
# @return [Float]
|
3782
|
+
required :tax_amount, Float
|
3783
|
+
|
3784
|
+
# @!attribute tax_name
|
3785
|
+
# Name of the tax to be applied. This may be used in an invoice line item
|
3786
|
+
# description.
|
3787
|
+
#
|
3788
|
+
# @return [String, nil]
|
3789
|
+
optional :tax_name, String
|
3790
|
+
|
3791
|
+
# @!method initialize(tax_amount:, tax_name: nil)
|
3792
|
+
# Some parameter documentations has been truncated, see
|
3793
|
+
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig::PrecalculatedTaxConfig}
|
3794
|
+
# for more details.
|
3795
|
+
#
|
3796
|
+
# Only applicable if using PRECALCULATED as your tax type.
|
3797
|
+
#
|
3798
|
+
# @param tax_amount [Float] Amount of tax to be applied. This should be in the same currency and denominatio
|
3799
|
+
#
|
3800
|
+
# @param tax_name [String] Name of the tax to be applied. This may be used in an invoice line item descript
|
3801
|
+
end
|
3802
|
+
|
3936
3803
|
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig#stripe_config
|
3937
3804
|
class StripeConfig < MetronomeSDK::Internal::Type::BaseModel
|
3938
3805
|
# @!attribute payment_type
|
@@ -3942,10 +3809,23 @@ module MetronomeSDK
|
|
3942
3809
|
required :payment_type,
|
3943
3810
|
enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType }
|
3944
3811
|
|
3945
|
-
# @!
|
3946
|
-
#
|
3812
|
+
# @!attribute invoice_metadata
|
3813
|
+
# Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
|
3814
|
+
# your payment type.
|
3815
|
+
#
|
3816
|
+
# @return [Hash{Symbol=>String}, nil]
|
3817
|
+
optional :invoice_metadata, MetronomeSDK::Internal::Type::HashOf[String]
|
3818
|
+
|
3819
|
+
# @!method initialize(payment_type:, invoice_metadata: nil)
|
3820
|
+
# Some parameter documentations has been truncated, see
|
3821
|
+
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig}
|
3822
|
+
# for more details.
|
3823
|
+
#
|
3824
|
+
# Only applicable if using STRIPE as your payment gateway type.
|
3947
3825
|
#
|
3948
3826
|
# @param payment_type [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType] If left blank, will default to INVOICE
|
3827
|
+
#
|
3828
|
+
# @param invoice_metadata [Hash{Symbol=>String}] Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
|
3949
3829
|
|
3950
3830
|
# If left blank, will default to INVOICE
|
3951
3831
|
#
|
@@ -3971,6 +3851,8 @@ module MetronomeSDK
|
|
3971
3851
|
|
3972
3852
|
NONE = :NONE
|
3973
3853
|
STRIPE = :STRIPE
|
3854
|
+
ANROK = :ANROK
|
3855
|
+
PRECALCULATED = :PRECALCULATED
|
3974
3856
|
|
3975
3857
|
# @!method self.values
|
3976
3858
|
# @return [Array<Symbol>]
|
@@ -4324,8 +4206,15 @@ module MetronomeSDK
|
|
4324
4206
|
required :payment_gate_type,
|
4325
4207
|
enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSpendThresholdConfiguration::PaymentGateConfig::PaymentGateType }
|
4326
4208
|
|
4209
|
+
# @!attribute precalculated_tax_config
|
4210
|
+
# Only applicable if using PRECALCULATED as your tax type.
|
4211
|
+
#
|
4212
|
+
# @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSpendThresholdConfiguration::PaymentGateConfig::PrecalculatedTaxConfig, nil]
|
4213
|
+
optional :precalculated_tax_config,
|
4214
|
+
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSpendThresholdConfiguration::PaymentGateConfig::PrecalculatedTaxConfig }
|
4215
|
+
|
4327
4216
|
# @!attribute stripe_config
|
4328
|
-
# Only applicable if using
|
4217
|
+
# Only applicable if using STRIPE as your payment gateway type.
|
4329
4218
|
#
|
4330
4219
|
# @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSpendThresholdConfiguration::PaymentGateConfig::StripeConfig, nil]
|
4331
4220
|
optional :stripe_config,
|
@@ -4340,14 +4229,16 @@ module MetronomeSDK
|
|
4340
4229
|
optional :tax_type,
|
4341
4230
|
enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSpendThresholdConfiguration::PaymentGateConfig::TaxType }
|
4342
4231
|
|
4343
|
-
# @!method initialize(payment_gate_type:, stripe_config: nil, tax_type: nil)
|
4232
|
+
# @!method initialize(payment_gate_type:, precalculated_tax_config: nil, stripe_config: nil, tax_type: nil)
|
4344
4233
|
# Some parameter documentations has been truncated, see
|
4345
4234
|
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSpendThresholdConfiguration::PaymentGateConfig}
|
4346
4235
|
# for more details.
|
4347
4236
|
#
|
4348
4237
|
# @param payment_gate_type [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSpendThresholdConfiguration::PaymentGateConfig::PaymentGateType] Gate access to the commit balance based on successful collection of payment. Sel
|
4349
4238
|
#
|
4350
|
-
# @param
|
4239
|
+
# @param precalculated_tax_config [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSpendThresholdConfiguration::PaymentGateConfig::PrecalculatedTaxConfig] Only applicable if using PRECALCULATED as your tax type.
|
4240
|
+
#
|
4241
|
+
# @param stripe_config [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSpendThresholdConfiguration::PaymentGateConfig::StripeConfig] Only applicable if using STRIPE as your payment gateway type.
|
4351
4242
|
#
|
4352
4243
|
# @param tax_type [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSpendThresholdConfiguration::PaymentGateConfig::TaxType] Stripe tax is only supported for Stripe payment gateway. Select NONE if you do n
|
4353
4244
|
|
@@ -4368,6 +4259,34 @@ module MetronomeSDK
|
|
4368
4259
|
# @return [Array<Symbol>]
|
4369
4260
|
end
|
4370
4261
|
|
4262
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSpendThresholdConfiguration::PaymentGateConfig#precalculated_tax_config
|
4263
|
+
class PrecalculatedTaxConfig < MetronomeSDK::Internal::Type::BaseModel
|
4264
|
+
# @!attribute tax_amount
|
4265
|
+
# Amount of tax to be applied. This should be in the same currency and
|
4266
|
+
# denomination as the commit's invoice schedule
|
4267
|
+
#
|
4268
|
+
# @return [Float]
|
4269
|
+
required :tax_amount, Float
|
4270
|
+
|
4271
|
+
# @!attribute tax_name
|
4272
|
+
# Name of the tax to be applied. This may be used in an invoice line item
|
4273
|
+
# description.
|
4274
|
+
#
|
4275
|
+
# @return [String, nil]
|
4276
|
+
optional :tax_name, String
|
4277
|
+
|
4278
|
+
# @!method initialize(tax_amount:, tax_name: nil)
|
4279
|
+
# Some parameter documentations has been truncated, see
|
4280
|
+
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSpendThresholdConfiguration::PaymentGateConfig::PrecalculatedTaxConfig}
|
4281
|
+
# for more details.
|
4282
|
+
#
|
4283
|
+
# Only applicable if using PRECALCULATED as your tax type.
|
4284
|
+
#
|
4285
|
+
# @param tax_amount [Float] Amount of tax to be applied. This should be in the same currency and denominatio
|
4286
|
+
#
|
4287
|
+
# @param tax_name [String] Name of the tax to be applied. This may be used in an invoice line item descript
|
4288
|
+
end
|
4289
|
+
|
4371
4290
|
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSpendThresholdConfiguration::PaymentGateConfig#stripe_config
|
4372
4291
|
class StripeConfig < MetronomeSDK::Internal::Type::BaseModel
|
4373
4292
|
# @!attribute payment_type
|
@@ -4377,10 +4296,23 @@ module MetronomeSDK
|
|
4377
4296
|
required :payment_type,
|
4378
4297
|
enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSpendThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType }
|
4379
4298
|
|
4380
|
-
# @!
|
4381
|
-
#
|
4299
|
+
# @!attribute invoice_metadata
|
4300
|
+
# Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
|
4301
|
+
# your payment type.
|
4302
|
+
#
|
4303
|
+
# @return [Hash{Symbol=>String}, nil]
|
4304
|
+
optional :invoice_metadata, MetronomeSDK::Internal::Type::HashOf[String]
|
4305
|
+
|
4306
|
+
# @!method initialize(payment_type:, invoice_metadata: nil)
|
4307
|
+
# Some parameter documentations has been truncated, see
|
4308
|
+
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSpendThresholdConfiguration::PaymentGateConfig::StripeConfig}
|
4309
|
+
# for more details.
|
4310
|
+
#
|
4311
|
+
# Only applicable if using STRIPE as your payment gateway type.
|
4382
4312
|
#
|
4383
4313
|
# @param payment_type [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSpendThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType] If left blank, will default to INVOICE
|
4314
|
+
#
|
4315
|
+
# @param invoice_metadata [Hash{Symbol=>String}] Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
|
4384
4316
|
|
4385
4317
|
# If left blank, will default to INVOICE
|
4386
4318
|
#
|
@@ -4406,6 +4338,8 @@ module MetronomeSDK
|
|
4406
4338
|
|
4407
4339
|
NONE = :NONE
|
4408
4340
|
STRIPE = :STRIPE
|
4341
|
+
ANROK = :ANROK
|
4342
|
+
PRECALCULATED = :PRECALCULATED
|
4409
4343
|
|
4410
4344
|
# @!method self.values
|
4411
4345
|
# @return [Array<Symbol>]
|