metronome-sdk 3.6.0 → 3.8.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 +54 -0
- data/README.md +1 -1
- data/lib/metronome_sdk/internal/transport/base_client.rb +4 -1
- data/lib/metronome_sdk/internal/type/enum.rb +0 -25
- data/lib/metronome_sdk/models/commit.rb +36 -1
- data/lib/metronome_sdk/models/contract.rb +140 -1
- data/lib/metronome_sdk/models/contract_v2.rb +457 -8
- data/lib/metronome_sdk/models/contract_without_amendments.rb +320 -5
- data/lib/metronome_sdk/models/credit.rb +10 -1
- data/lib/metronome_sdk/models/override.rb +7 -1
- data/lib/metronome_sdk/models/prepaid_balance_threshold_configuration.rb +113 -2
- data/lib/metronome_sdk/models/prepaid_balance_threshold_configuration_v2.rb +105 -2
- data/lib/metronome_sdk/models/spend_threshold_configuration.rb +33 -1
- data/lib/metronome_sdk/models/spend_threshold_configuration_v2.rb +33 -1
- data/lib/metronome_sdk/models/subscription.rb +90 -2
- data/lib/metronome_sdk/models/v1/alert_create_params.rb +127 -1
- data/lib/metronome_sdk/models/v1/contract_amend_params.rb +46 -5
- data/lib/metronome_sdk/models/v1/contract_create_params.rb +436 -12
- data/lib/metronome_sdk/models/v1/contract_create_response.rb +1308 -3
- data/lib/metronome_sdk/models/v1/contract_get_subscription_seats_history_params.rb +88 -0
- data/lib/metronome_sdk/models/v1/contract_get_subscription_seats_history_response.rb +62 -0
- data/lib/metronome_sdk/models/v1/contract_list_seat_balances_params.rb +10 -1
- data/lib/metronome_sdk/models/v1/customers/alert_retrieve_params.rb +127 -1
- data/lib/metronome_sdk/models/v1/customers/customer_alert.rb +130 -3
- data/lib/metronome_sdk/models/v1/customers/invoice_list_params.rb +10 -1
- data/lib/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rb +2 -0
- data/lib/metronome_sdk/models/v1/package_create_params.rb +394 -11
- data/lib/metronome_sdk/models/v1/package_list_response.rb +374 -8
- data/lib/metronome_sdk/models/v1/package_retrieve_response.rb +378 -8
- data/lib/metronome_sdk/models/v2/contract_edit_params.rb +817 -13
- data/lib/metronome_sdk/models/v2/contract_edit_response.rb +4310 -3
- data/lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb +600 -10
- data/lib/metronome_sdk/resources/v1/alerts.rb +3 -1
- data/lib/metronome_sdk/resources/v1/contracts/rate_cards/rates.rb +4 -0
- data/lib/metronome_sdk/resources/v1/contracts.rb +71 -2
- data/lib/metronome_sdk/resources/v1/customers/alerts.rb +4 -2
- data/lib/metronome_sdk/resources/v1/customers/invoices.rb +3 -1
- data/lib/metronome_sdk/resources/v1/dashboards.rb +7 -2
- data/lib/metronome_sdk/resources/v1/packages.rb +6 -5
- data/lib/metronome_sdk/resources/v1.rb +0 -4
- data/lib/metronome_sdk/resources/v2/contracts.rb +5 -1
- data/lib/metronome_sdk/version.rb +1 -1
- data/lib/metronome_sdk.rb +2 -8
- data/rbi/metronome_sdk/models/commit.rbi +61 -0
- data/rbi/metronome_sdk/models/contract.rbi +354 -0
- data/rbi/metronome_sdk/models/contract_v2.rbi +1132 -11
- data/rbi/metronome_sdk/models/contract_without_amendments.rbi +831 -0
- data/rbi/metronome_sdk/models/credit.rbi +13 -0
- data/rbi/metronome_sdk/models/override.rbi +9 -0
- data/rbi/metronome_sdk/models/prepaid_balance_threshold_configuration.rbi +299 -6
- data/rbi/metronome_sdk/models/prepaid_balance_threshold_configuration_v2.rbi +287 -6
- data/rbi/metronome_sdk/models/spend_threshold_configuration.rbi +78 -3
- data/rbi/metronome_sdk/models/spend_threshold_configuration_v2.rbi +78 -3
- data/rbi/metronome_sdk/models/subscription.rbi +212 -3
- data/rbi/metronome_sdk/models/v1/alert_create_params.rbi +373 -0
- data/rbi/metronome_sdk/models/v1/contract_amend_params.rbi +81 -6
- data/rbi/metronome_sdk/models/v1/contract_create_params.rbi +1095 -17
- data/rbi/metronome_sdk/models/v1/contract_create_response.rbi +2911 -4
- data/rbi/metronome_sdk/models/v1/contract_get_subscription_seats_history_params.rbi +112 -0
- data/rbi/metronome_sdk/models/v1/contract_get_subscription_seats_history_response.rbi +119 -0
- data/rbi/metronome_sdk/models/v1/contract_list_seat_balances_params.rbi +13 -0
- data/rbi/metronome_sdk/models/v1/customers/alert_retrieve_params.rbi +360 -0
- data/rbi/metronome_sdk/models/v1/customers/customer_alert.rbi +379 -2
- data/rbi/metronome_sdk/models/v1/customers/invoice_list_params.rbi +13 -0
- data/rbi/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rbi +10 -0
- data/rbi/metronome_sdk/models/v1/package_create_params.rbi +1049 -42
- data/rbi/metronome_sdk/models/v1/package_list_response.rbi +1051 -54
- data/rbi/metronome_sdk/models/v1/package_retrieve_response.rbi +1051 -54
- data/rbi/metronome_sdk/models/v2/contract_edit_params.rbi +2130 -114
- data/rbi/metronome_sdk/models/v2/contract_edit_response.rbi +9749 -4
- data/rbi/metronome_sdk/models/v2/contract_get_edit_history_response.rbi +1567 -82
- data/rbi/metronome_sdk/resources/v1/alerts.rbi +8 -0
- data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbi +4 -0
- data/rbi/metronome_sdk/resources/v1/contracts.rbi +77 -0
- data/rbi/metronome_sdk/resources/v1/customers/alerts.rbi +8 -1
- data/rbi/metronome_sdk/resources/v1/customers/invoices.rbi +4 -0
- data/rbi/metronome_sdk/resources/v1/dashboards.rbi +7 -2
- data/rbi/metronome_sdk/resources/v1/packages.rbi +8 -4
- data/rbi/metronome_sdk/resources/v1.rbi +0 -3
- data/rbi/metronome_sdk/resources/v2/contracts.rbi +10 -0
- data/sig/metronome_sdk/models/commit.rbs +26 -0
- data/sig/metronome_sdk/models/contract.rbs +151 -0
- data/sig/metronome_sdk/models/contract_v2.rbs +448 -5
- data/sig/metronome_sdk/models/contract_without_amendments.rbs +320 -2
- data/sig/metronome_sdk/models/credit.rbs +7 -0
- data/sig/metronome_sdk/models/override.rbs +7 -0
- data/sig/metronome_sdk/models/prepaid_balance_threshold_configuration.rbs +116 -6
- data/sig/metronome_sdk/models/prepaid_balance_threshold_configuration_v2.rbs +116 -6
- data/sig/metronome_sdk/models/spend_threshold_configuration.rbs +31 -3
- data/sig/metronome_sdk/models/spend_threshold_configuration_v2.rbs +31 -3
- data/sig/metronome_sdk/models/subscription.rbs +88 -3
- data/sig/metronome_sdk/models/v1/alert_create_params.rbs +144 -0
- data/sig/metronome_sdk/models/v1/contract_amend_params.rbs +26 -0
- data/sig/metronome_sdk/models/v1/contract_create_params.rbs +412 -5
- data/sig/metronome_sdk/models/v1/contract_create_response.rbs +1210 -4
- data/sig/metronome_sdk/models/v1/contract_get_subscription_seats_history_params.rbs +63 -0
- data/sig/metronome_sdk/models/v1/contract_get_subscription_seats_history_response.rbs +59 -0
- data/sig/metronome_sdk/models/v1/contract_list_seat_balances_params.rbs +7 -0
- data/sig/metronome_sdk/models/v1/customers/alert_retrieve_params.rbs +141 -0
- data/sig/metronome_sdk/models/v1/customers/customer_alert.rbs +150 -0
- data/sig/metronome_sdk/models/v1/customers/invoice_list_params.rbs +8 -1
- data/sig/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rbs +4 -0
- data/sig/metronome_sdk/models/v1/package_create_params.rbs +386 -5
- data/sig/metronome_sdk/models/v1/package_list_response.rbs +380 -5
- data/sig/metronome_sdk/models/v1/package_retrieve_response.rbs +378 -5
- data/sig/metronome_sdk/models/v2/contract_edit_params.rbs +751 -14
- data/sig/metronome_sdk/models/v2/contract_edit_response.rbs +4215 -4
- data/sig/metronome_sdk/models/v2/contract_get_edit_history_response.rbs +569 -14
- data/sig/metronome_sdk/resources/v1/alerts.rbs +1 -0
- data/sig/metronome_sdk/resources/v1/contracts.rbs +14 -0
- data/sig/metronome_sdk/resources/v1/customers/alerts.rbs +1 -0
- data/sig/metronome_sdk/resources/v1/customers/invoices.rbs +1 -0
- data/sig/metronome_sdk/resources/v1/packages.rbs +1 -0
- data/sig/metronome_sdk/resources/v1.rbs +0 -2
- data/sig/metronome_sdk/resources/v2/contracts.rbs +2 -0
- metadata +8 -26
- data/lib/metronome_sdk/models/v1/payment.rb +0 -196
- data/lib/metronome_sdk/models/v1/payment_attempt_params.rb +0 -28
- data/lib/metronome_sdk/models/v1/payment_attempt_response.rb +0 -18
- data/lib/metronome_sdk/models/v1/payment_cancel_params.rb +0 -28
- data/lib/metronome_sdk/models/v1/payment_cancel_response.rb +0 -18
- data/lib/metronome_sdk/models/v1/payment_list_params.rb +0 -53
- data/lib/metronome_sdk/models/v1/payment_status.rb +0 -19
- data/lib/metronome_sdk/resources/v1/payments.rb +0 -102
- data/rbi/metronome_sdk/models/v1/payment.rbi +0 -403
- data/rbi/metronome_sdk/models/v1/payment_attempt_params.rbi +0 -48
- data/rbi/metronome_sdk/models/v1/payment_attempt_response.rbi +0 -35
- data/rbi/metronome_sdk/models/v1/payment_cancel_params.rbi +0 -48
- data/rbi/metronome_sdk/models/v1/payment_cancel_response.rbi +0 -35
- data/rbi/metronome_sdk/models/v1/payment_list_params.rbi +0 -91
- data/rbi/metronome_sdk/models/v1/payment_status.rbi +0 -33
- data/rbi/metronome_sdk/resources/v1/payments.rbi +0 -72
- data/sig/metronome_sdk/models/v1/payment.rbs +0 -243
- data/sig/metronome_sdk/models/v1/payment_attempt_params.rbs +0 -30
- data/sig/metronome_sdk/models/v1/payment_attempt_response.rbs +0 -15
- data/sig/metronome_sdk/models/v1/payment_cancel_params.rbs +0 -30
- data/sig/metronome_sdk/models/v1/payment_cancel_response.rbs +0 -15
- data/sig/metronome_sdk/models/v1/payment_list_params.rbs +0 -56
- data/sig/metronome_sdk/models/v1/payment_status.rbs +0 -19
- data/sig/metronome_sdk/resources/v1/payments.rbs +0 -30
|
@@ -784,6 +784,11 @@ module MetronomeSDK
|
|
|
784
784
|
# @param type [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride::Type]
|
|
785
785
|
|
|
786
786
|
class OverrideSpecifier < MetronomeSDK::Internal::Type::BaseModel
|
|
787
|
+
# @!attribute any_commit_or_credit_ids
|
|
788
|
+
#
|
|
789
|
+
# @return [Array<String>, nil]
|
|
790
|
+
optional :any_commit_or_credit_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
|
|
791
|
+
|
|
787
792
|
# @!attribute billing_frequency
|
|
788
793
|
#
|
|
789
794
|
# @return [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride::OverrideSpecifier::BillingFrequency, nil]
|
|
@@ -820,7 +825,8 @@ module MetronomeSDK
|
|
|
820
825
|
# @return [Array<String>, nil]
|
|
821
826
|
optional :recurring_commit_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
|
|
822
827
|
|
|
823
|
-
# @!method initialize(billing_frequency: nil, commit_ids: nil, presentation_group_values: nil, pricing_group_values: nil, product_id: nil, product_tags: nil, recurring_commit_ids: nil)
|
|
828
|
+
# @!method initialize(any_commit_or_credit_ids: nil, billing_frequency: nil, commit_ids: nil, presentation_group_values: nil, pricing_group_values: nil, product_id: nil, product_tags: nil, recurring_commit_ids: nil)
|
|
829
|
+
# @param any_commit_or_credit_ids [Array<String>]
|
|
824
830
|
# @param billing_frequency [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride::OverrideSpecifier::BillingFrequency]
|
|
825
831
|
# @param commit_ids [Array<String>]
|
|
826
832
|
# @param presentation_group_values [Hash{Symbol=>String, nil}]
|
|
@@ -1073,6 +1079,14 @@ module MetronomeSDK
|
|
|
1073
1079
|
optional :proration,
|
|
1074
1080
|
enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::Proration }
|
|
1075
1081
|
|
|
1082
|
+
# @!attribute proration_rounding
|
|
1083
|
+
# Rounding configuration for prorated recurring commit amounts.
|
|
1084
|
+
#
|
|
1085
|
+
# @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::ProrationRounding, nil]
|
|
1086
|
+
optional :proration_rounding,
|
|
1087
|
+
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::ProrationRounding },
|
|
1088
|
+
nil?: true
|
|
1089
|
+
|
|
1076
1090
|
# @!attribute recurrence_frequency
|
|
1077
1091
|
# The frequency at which the recurring commits will be created. If not provided: -
|
|
1078
1092
|
# The commits will be created on the usage invoice frequency. If provided: - The
|
|
@@ -1106,7 +1120,7 @@ module MetronomeSDK
|
|
|
1106
1120
|
# @return [MetronomeSDK::Models::RecurringCommitSubscriptionConfig, nil]
|
|
1107
1121
|
optional :subscription_config, -> { MetronomeSDK::RecurringCommitSubscriptionConfig }
|
|
1108
1122
|
|
|
1109
|
-
# @!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, subscription_config: nil)
|
|
1123
|
+
# @!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, proration_rounding: nil, recurrence_frequency: nil, rollover_fraction: nil, specifiers: nil, subscription_config: nil)
|
|
1110
1124
|
# Some parameter documentations has been truncated, see
|
|
1111
1125
|
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit}
|
|
1112
1126
|
# for more details.
|
|
@@ -1145,6 +1159,8 @@ module MetronomeSDK
|
|
|
1145
1159
|
#
|
|
1146
1160
|
# @param proration [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::Proration] Determines whether the first and last commit will be prorated. If not provided,
|
|
1147
1161
|
#
|
|
1162
|
+
# @param proration_rounding [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::ProrationRounding, nil] Rounding configuration for prorated recurring commit amounts.
|
|
1163
|
+
#
|
|
1148
1164
|
# @param recurrence_frequency [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::RecurrenceFrequency] The frequency at which the recurring commits will be created. If not provided: -
|
|
1149
1165
|
#
|
|
1150
1166
|
# @param rollover_fraction [Float] Will be passed down to the individual commits. This controls how much of an indi
|
|
@@ -1290,6 +1306,103 @@ module MetronomeSDK
|
|
|
1290
1306
|
# @return [Array<Symbol>]
|
|
1291
1307
|
end
|
|
1292
1308
|
|
|
1309
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit#proration_rounding
|
|
1310
|
+
class ProrationRounding < MetronomeSDK::Internal::Type::BaseModel
|
|
1311
|
+
# @!attribute access
|
|
1312
|
+
#
|
|
1313
|
+
# @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::ProrationRounding::Access, nil]
|
|
1314
|
+
optional :access,
|
|
1315
|
+
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::ProrationRounding::Access }
|
|
1316
|
+
|
|
1317
|
+
# @!attribute invoice
|
|
1318
|
+
#
|
|
1319
|
+
# @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::ProrationRounding::Invoice, nil]
|
|
1320
|
+
optional :invoice,
|
|
1321
|
+
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::ProrationRounding::Invoice }
|
|
1322
|
+
|
|
1323
|
+
# @!method initialize(access: nil, invoice: nil)
|
|
1324
|
+
# Rounding configuration for prorated recurring commit amounts.
|
|
1325
|
+
#
|
|
1326
|
+
# @param access [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::ProrationRounding::Access]
|
|
1327
|
+
# @param invoice [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::ProrationRounding::Invoice]
|
|
1328
|
+
|
|
1329
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::ProrationRounding#access
|
|
1330
|
+
class Access < MetronomeSDK::Internal::Type::BaseModel
|
|
1331
|
+
# @!attribute decimal_places
|
|
1332
|
+
# Number of decimal places to round to. Applied directly to the stored monetary
|
|
1333
|
+
# representation. Negative values round to powers of 10 (e.g., -2 rounds to
|
|
1334
|
+
# nearest 100 in the stored unit).
|
|
1335
|
+
#
|
|
1336
|
+
# @return [Float]
|
|
1337
|
+
required :decimal_places, Float
|
|
1338
|
+
|
|
1339
|
+
# @!attribute rounding_method
|
|
1340
|
+
#
|
|
1341
|
+
# @return [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::ProrationRounding::Access::RoundingMethod]
|
|
1342
|
+
required :rounding_method,
|
|
1343
|
+
enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::ProrationRounding::Access::RoundingMethod }
|
|
1344
|
+
|
|
1345
|
+
# @!method initialize(decimal_places:, rounding_method:)
|
|
1346
|
+
# Some parameter documentations has been truncated, see
|
|
1347
|
+
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::ProrationRounding::Access}
|
|
1348
|
+
# for more details.
|
|
1349
|
+
#
|
|
1350
|
+
# @param decimal_places [Float] Number of decimal places to round to. Applied directly to the stored monetary re
|
|
1351
|
+
#
|
|
1352
|
+
# @param rounding_method [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::ProrationRounding::Access::RoundingMethod]
|
|
1353
|
+
|
|
1354
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::ProrationRounding::Access#rounding_method
|
|
1355
|
+
module RoundingMethod
|
|
1356
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
1357
|
+
|
|
1358
|
+
HALF_UP = :HALF_UP
|
|
1359
|
+
FLOOR = :FLOOR
|
|
1360
|
+
CEILING = :CEILING
|
|
1361
|
+
|
|
1362
|
+
# @!method self.values
|
|
1363
|
+
# @return [Array<Symbol>]
|
|
1364
|
+
end
|
|
1365
|
+
end
|
|
1366
|
+
|
|
1367
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::ProrationRounding#invoice
|
|
1368
|
+
class Invoice < MetronomeSDK::Internal::Type::BaseModel
|
|
1369
|
+
# @!attribute decimal_places
|
|
1370
|
+
# Number of decimal places to round to. Applied directly to the stored monetary
|
|
1371
|
+
# representation. Negative values round to powers of 10 (e.g., -2 rounds to
|
|
1372
|
+
# nearest 100 in the stored unit).
|
|
1373
|
+
#
|
|
1374
|
+
# @return [Float]
|
|
1375
|
+
required :decimal_places, Float
|
|
1376
|
+
|
|
1377
|
+
# @!attribute rounding_method
|
|
1378
|
+
#
|
|
1379
|
+
# @return [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::ProrationRounding::Invoice::RoundingMethod]
|
|
1380
|
+
required :rounding_method,
|
|
1381
|
+
enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::ProrationRounding::Invoice::RoundingMethod }
|
|
1382
|
+
|
|
1383
|
+
# @!method initialize(decimal_places:, rounding_method:)
|
|
1384
|
+
# Some parameter documentations has been truncated, see
|
|
1385
|
+
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::ProrationRounding::Invoice}
|
|
1386
|
+
# for more details.
|
|
1387
|
+
#
|
|
1388
|
+
# @param decimal_places [Float] Number of decimal places to round to. Applied directly to the stored monetary re
|
|
1389
|
+
#
|
|
1390
|
+
# @param rounding_method [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::ProrationRounding::Invoice::RoundingMethod]
|
|
1391
|
+
|
|
1392
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::ProrationRounding::Invoice#rounding_method
|
|
1393
|
+
module RoundingMethod
|
|
1394
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
1395
|
+
|
|
1396
|
+
HALF_UP = :HALF_UP
|
|
1397
|
+
FLOOR = :FLOOR
|
|
1398
|
+
CEILING = :CEILING
|
|
1399
|
+
|
|
1400
|
+
# @!method self.values
|
|
1401
|
+
# @return [Array<Symbol>]
|
|
1402
|
+
end
|
|
1403
|
+
end
|
|
1404
|
+
end
|
|
1405
|
+
|
|
1293
1406
|
# The frequency at which the recurring commits will be created. If not provided: -
|
|
1294
1407
|
# The commits will be created on the usage invoice frequency. If provided: - The
|
|
1295
1408
|
# period defined in the duration will correspond to this frequency. - Commits will
|
|
@@ -1304,6 +1417,7 @@ module MetronomeSDK
|
|
|
1304
1417
|
QUARTERLY = :QUARTERLY
|
|
1305
1418
|
ANNUAL = :ANNUAL
|
|
1306
1419
|
WEEKLY = :WEEKLY
|
|
1420
|
+
DAILY = :DAILY
|
|
1307
1421
|
|
|
1308
1422
|
# @!method self.values
|
|
1309
1423
|
# @return [Array<Symbol>]
|
|
@@ -1411,6 +1525,14 @@ module MetronomeSDK
|
|
|
1411
1525
|
optional :proration,
|
|
1412
1526
|
enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::Proration }
|
|
1413
1527
|
|
|
1528
|
+
# @!attribute proration_rounding
|
|
1529
|
+
# Rounding configuration for prorated recurring credit amounts.
|
|
1530
|
+
#
|
|
1531
|
+
# @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::ProrationRounding, nil]
|
|
1532
|
+
optional :proration_rounding,
|
|
1533
|
+
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::ProrationRounding },
|
|
1534
|
+
nil?: true
|
|
1535
|
+
|
|
1414
1536
|
# @!attribute recurrence_frequency
|
|
1415
1537
|
# The frequency at which the recurring commits will be created. If not provided: -
|
|
1416
1538
|
# The commits will be created on the usage invoice frequency. If provided: - The
|
|
@@ -1444,7 +1566,7 @@ module MetronomeSDK
|
|
|
1444
1566
|
# @return [MetronomeSDK::Models::RecurringCommitSubscriptionConfig, nil]
|
|
1445
1567
|
optional :subscription_config, -> { MetronomeSDK::RecurringCommitSubscriptionConfig }
|
|
1446
1568
|
|
|
1447
|
-
# @!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, subscription_config: nil)
|
|
1569
|
+
# @!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, proration_rounding: nil, recurrence_frequency: nil, rollover_fraction: nil, specifiers: nil, subscription_config: nil)
|
|
1448
1570
|
# Some parameter documentations has been truncated, see
|
|
1449
1571
|
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit}
|
|
1450
1572
|
# for more details.
|
|
@@ -1481,6 +1603,8 @@ module MetronomeSDK
|
|
|
1481
1603
|
#
|
|
1482
1604
|
# @param proration [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::Proration] Determines whether the first and last commit will be prorated. If not provided,
|
|
1483
1605
|
#
|
|
1606
|
+
# @param proration_rounding [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::ProrationRounding, nil] Rounding configuration for prorated recurring credit amounts.
|
|
1607
|
+
#
|
|
1484
1608
|
# @param recurrence_frequency [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::RecurrenceFrequency] The frequency at which the recurring commits will be created. If not provided: -
|
|
1485
1609
|
#
|
|
1486
1610
|
# @param rollover_fraction [Float] Will be passed down to the individual commits. This controls how much of an indi
|
|
@@ -1601,6 +1725,58 @@ module MetronomeSDK
|
|
|
1601
1725
|
# @return [Array<Symbol>]
|
|
1602
1726
|
end
|
|
1603
1727
|
|
|
1728
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit#proration_rounding
|
|
1729
|
+
class ProrationRounding < MetronomeSDK::Internal::Type::BaseModel
|
|
1730
|
+
# @!attribute access
|
|
1731
|
+
#
|
|
1732
|
+
# @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::ProrationRounding::Access, nil]
|
|
1733
|
+
optional :access,
|
|
1734
|
+
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::ProrationRounding::Access }
|
|
1735
|
+
|
|
1736
|
+
# @!method initialize(access: nil)
|
|
1737
|
+
# Rounding configuration for prorated recurring credit amounts.
|
|
1738
|
+
#
|
|
1739
|
+
# @param access [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::ProrationRounding::Access]
|
|
1740
|
+
|
|
1741
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::ProrationRounding#access
|
|
1742
|
+
class Access < MetronomeSDK::Internal::Type::BaseModel
|
|
1743
|
+
# @!attribute decimal_places
|
|
1744
|
+
# Number of decimal places to round to. Applied directly to the stored monetary
|
|
1745
|
+
# representation. Negative values round to powers of 10 (e.g., -2 rounds to
|
|
1746
|
+
# nearest 100 in the stored unit).
|
|
1747
|
+
#
|
|
1748
|
+
# @return [Float]
|
|
1749
|
+
required :decimal_places, Float
|
|
1750
|
+
|
|
1751
|
+
# @!attribute rounding_method
|
|
1752
|
+
#
|
|
1753
|
+
# @return [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::ProrationRounding::Access::RoundingMethod]
|
|
1754
|
+
required :rounding_method,
|
|
1755
|
+
enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::ProrationRounding::Access::RoundingMethod }
|
|
1756
|
+
|
|
1757
|
+
# @!method initialize(decimal_places:, rounding_method:)
|
|
1758
|
+
# Some parameter documentations has been truncated, see
|
|
1759
|
+
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::ProrationRounding::Access}
|
|
1760
|
+
# for more details.
|
|
1761
|
+
#
|
|
1762
|
+
# @param decimal_places [Float] Number of decimal places to round to. Applied directly to the stored monetary re
|
|
1763
|
+
#
|
|
1764
|
+
# @param rounding_method [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::ProrationRounding::Access::RoundingMethod]
|
|
1765
|
+
|
|
1766
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::ProrationRounding::Access#rounding_method
|
|
1767
|
+
module RoundingMethod
|
|
1768
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
1769
|
+
|
|
1770
|
+
HALF_UP = :HALF_UP
|
|
1771
|
+
FLOOR = :FLOOR
|
|
1772
|
+
CEILING = :CEILING
|
|
1773
|
+
|
|
1774
|
+
# @!method self.values
|
|
1775
|
+
# @return [Array<Symbol>]
|
|
1776
|
+
end
|
|
1777
|
+
end
|
|
1778
|
+
end
|
|
1779
|
+
|
|
1604
1780
|
# The frequency at which the recurring commits will be created. If not provided: -
|
|
1605
1781
|
# The commits will be created on the usage invoice frequency. If provided: - The
|
|
1606
1782
|
# period defined in the duration will correspond to this frequency. - Commits will
|
|
@@ -1615,6 +1791,7 @@ module MetronomeSDK
|
|
|
1615
1791
|
QUARTERLY = :QUARTERLY
|
|
1616
1792
|
ANNUAL = :ANNUAL
|
|
1617
1793
|
WEEKLY = :WEEKLY
|
|
1794
|
+
DAILY = :DAILY
|
|
1618
1795
|
|
|
1619
1796
|
# @!method self.values
|
|
1620
1797
|
# @return [Array<Symbol>]
|
|
@@ -1834,6 +2011,12 @@ module MetronomeSDK
|
|
|
1834
2011
|
# @return [String, nil]
|
|
1835
2012
|
optional :id, String
|
|
1836
2013
|
|
|
2014
|
+
# @!attribute billing_cycle_config
|
|
2015
|
+
#
|
|
2016
|
+
# @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::BillingCycleConfig, nil]
|
|
2017
|
+
optional :billing_cycle_config,
|
|
2018
|
+
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::BillingCycleConfig }
|
|
2019
|
+
|
|
1837
2020
|
# @!attribute custom_fields
|
|
1838
2021
|
# Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
1839
2022
|
#
|
|
@@ -1866,7 +2049,7 @@ module MetronomeSDK
|
|
|
1866
2049
|
optional :seat_config,
|
|
1867
2050
|
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::SeatConfig }
|
|
1868
2051
|
|
|
1869
|
-
# @!method initialize(billing_periods:, collection_schedule:, proration:, quantity_management_mode:, quantity_schedule:, starting_at:, subscription_rate:, id: nil, custom_fields: nil, description: nil, ending_before: nil, fiat_credit_type_id: nil, name: nil, seat_config: nil)
|
|
2052
|
+
# @!method initialize(billing_periods:, collection_schedule:, proration:, quantity_management_mode:, quantity_schedule:, starting_at:, subscription_rate:, id: nil, billing_cycle_config: nil, custom_fields: nil, description: nil, ending_before: nil, fiat_credit_type_id: nil, name: nil, seat_config: nil)
|
|
1870
2053
|
# Some parameter documentations has been truncated, see
|
|
1871
2054
|
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription}
|
|
1872
2055
|
# for more details.
|
|
@@ -1887,6 +2070,8 @@ module MetronomeSDK
|
|
|
1887
2070
|
#
|
|
1888
2071
|
# @param id [String]
|
|
1889
2072
|
#
|
|
2073
|
+
# @param billing_cycle_config [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::BillingCycleConfig]
|
|
2074
|
+
#
|
|
1890
2075
|
# @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
1891
2076
|
#
|
|
1892
2077
|
# @param description [String]
|
|
@@ -2003,9 +2188,16 @@ module MetronomeSDK
|
|
|
2003
2188
|
# @return [Boolean]
|
|
2004
2189
|
required :is_prorated, MetronomeSDK::Internal::Type::Boolean
|
|
2005
2190
|
|
|
2006
|
-
# @!
|
|
2191
|
+
# @!attribute rounding
|
|
2192
|
+
#
|
|
2193
|
+
# @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::Proration::Rounding, nil]
|
|
2194
|
+
optional :rounding,
|
|
2195
|
+
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::Proration::Rounding }
|
|
2196
|
+
|
|
2197
|
+
# @!method initialize(invoice_behavior:, is_prorated:, rounding: nil)
|
|
2007
2198
|
# @param invoice_behavior [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::Proration::InvoiceBehavior]
|
|
2008
2199
|
# @param is_prorated [Boolean]
|
|
2200
|
+
# @param rounding [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::Proration::Rounding]
|
|
2009
2201
|
|
|
2010
2202
|
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::Proration#invoice_behavior
|
|
2011
2203
|
module InvoiceBehavior
|
|
@@ -2017,6 +2209,44 @@ module MetronomeSDK
|
|
|
2017
2209
|
# @!method self.values
|
|
2018
2210
|
# @return [Array<Symbol>]
|
|
2019
2211
|
end
|
|
2212
|
+
|
|
2213
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::Proration#rounding
|
|
2214
|
+
class Rounding < MetronomeSDK::Internal::Type::BaseModel
|
|
2215
|
+
# @!attribute decimal_places
|
|
2216
|
+
# Number of decimal places to round to. Applied directly to the stored monetary
|
|
2217
|
+
# representation. Negative values round to powers of 10 (e.g., -2 rounds to
|
|
2218
|
+
# nearest 100 in the stored unit).
|
|
2219
|
+
#
|
|
2220
|
+
# @return [Float]
|
|
2221
|
+
required :decimal_places, Float
|
|
2222
|
+
|
|
2223
|
+
# @!attribute rounding_method
|
|
2224
|
+
#
|
|
2225
|
+
# @return [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::Proration::Rounding::RoundingMethod]
|
|
2226
|
+
required :rounding_method,
|
|
2227
|
+
enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::Proration::Rounding::RoundingMethod }
|
|
2228
|
+
|
|
2229
|
+
# @!method initialize(decimal_places:, rounding_method:)
|
|
2230
|
+
# Some parameter documentations has been truncated, see
|
|
2231
|
+
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::Proration::Rounding}
|
|
2232
|
+
# for more details.
|
|
2233
|
+
#
|
|
2234
|
+
# @param decimal_places [Float] Number of decimal places to round to. Applied directly to the stored monetary re
|
|
2235
|
+
#
|
|
2236
|
+
# @param rounding_method [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::Proration::Rounding::RoundingMethod]
|
|
2237
|
+
|
|
2238
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::Proration::Rounding#rounding_method
|
|
2239
|
+
module RoundingMethod
|
|
2240
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
2241
|
+
|
|
2242
|
+
HALF_UP = :HALF_UP
|
|
2243
|
+
FLOOR = :FLOOR
|
|
2244
|
+
CEILING = :CEILING
|
|
2245
|
+
|
|
2246
|
+
# @!method self.values
|
|
2247
|
+
# @return [Array<Symbol>]
|
|
2248
|
+
end
|
|
2249
|
+
end
|
|
2020
2250
|
end
|
|
2021
2251
|
|
|
2022
2252
|
# Determines how the subscription's quantity is controlled. Defaults to
|
|
@@ -2111,6 +2341,46 @@ module MetronomeSDK
|
|
|
2111
2341
|
end
|
|
2112
2342
|
end
|
|
2113
2343
|
|
|
2344
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription#billing_cycle_config
|
|
2345
|
+
class BillingCycleConfig < MetronomeSDK::Internal::Type::BaseModel
|
|
2346
|
+
# @!attribute anchor_date
|
|
2347
|
+
# The date this subscription's billing cycle is anchored to.
|
|
2348
|
+
#
|
|
2349
|
+
# @return [Time]
|
|
2350
|
+
required :anchor_date, Time
|
|
2351
|
+
|
|
2352
|
+
# @!attribute invoice_placement
|
|
2353
|
+
# Controls whether this subscription consolidates onto usage invoices or gets its
|
|
2354
|
+
# own scheduled invoice.
|
|
2355
|
+
#
|
|
2356
|
+
# @return [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::BillingCycleConfig::InvoicePlacement]
|
|
2357
|
+
required :invoice_placement,
|
|
2358
|
+
enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::BillingCycleConfig::InvoicePlacement }
|
|
2359
|
+
|
|
2360
|
+
# @!method initialize(anchor_date:, invoice_placement:)
|
|
2361
|
+
# Some parameter documentations has been truncated, see
|
|
2362
|
+
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::BillingCycleConfig}
|
|
2363
|
+
# for more details.
|
|
2364
|
+
#
|
|
2365
|
+
# @param anchor_date [Time] The date this subscription's billing cycle is anchored to.
|
|
2366
|
+
#
|
|
2367
|
+
# @param invoice_placement [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::BillingCycleConfig::InvoicePlacement] Controls whether this subscription consolidates onto usage invoices or gets its
|
|
2368
|
+
|
|
2369
|
+
# Controls whether this subscription consolidates onto usage invoices or gets its
|
|
2370
|
+
# own scheduled invoice.
|
|
2371
|
+
#
|
|
2372
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::BillingCycleConfig#invoice_placement
|
|
2373
|
+
module InvoicePlacement
|
|
2374
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
2375
|
+
|
|
2376
|
+
ON_SCHEDULED_INVOICE = :ON_SCHEDULED_INVOICE
|
|
2377
|
+
ON_USAGE_INVOICE = :ON_USAGE_INVOICE
|
|
2378
|
+
|
|
2379
|
+
# @!method self.values
|
|
2380
|
+
# @return [Array<Symbol>]
|
|
2381
|
+
end
|
|
2382
|
+
end
|
|
2383
|
+
|
|
2114
2384
|
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription#seat_config
|
|
2115
2385
|
class SeatConfig < MetronomeSDK::Internal::Type::BaseModel
|
|
2116
2386
|
# @!attribute seat_group_key
|
|
@@ -3087,7 +3357,20 @@ module MetronomeSDK
|
|
|
3087
3357
|
# @return [Float, nil]
|
|
3088
3358
|
optional :threshold_amount, Float
|
|
3089
3359
|
|
|
3090
|
-
# @!
|
|
3360
|
+
# @!attribute threshold_balance_specifiers
|
|
3361
|
+
# Determines which balances are excluded from remaining balance calculation for
|
|
3362
|
+
# threshold billing.
|
|
3363
|
+
#
|
|
3364
|
+
# @return [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier>, nil]
|
|
3365
|
+
optional :threshold_balance_specifiers,
|
|
3366
|
+
-> do
|
|
3367
|
+
MetronomeSDK::Internal::Type::ArrayOf[
|
|
3368
|
+
MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier
|
|
3369
|
+
]
|
|
3370
|
+
end,
|
|
3371
|
+
nil?: true
|
|
3372
|
+
|
|
3373
|
+
# @!method initialize(commit: nil, custom_credit_type_id: nil, discount_configuration: nil, is_enabled: nil, payment_gate_config: nil, recharge_to_amount: nil, threshold_amount: nil, threshold_balance_specifiers: nil)
|
|
3091
3374
|
# Some parameter documentations has been truncated, see
|
|
3092
3375
|
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration}
|
|
3093
3376
|
# for more details.
|
|
@@ -3105,6 +3388,8 @@ module MetronomeSDK
|
|
|
3105
3388
|
# @param recharge_to_amount [Float] Specify the amount the balance should be recharged to.
|
|
3106
3389
|
#
|
|
3107
3390
|
# @param threshold_amount [Float] Specify the threshold amount for the contract. Each time the contract's balance
|
|
3391
|
+
#
|
|
3392
|
+
# @param threshold_balance_specifiers [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier>, nil] Determines which balances are excluded from remaining balance calculation for th
|
|
3108
3393
|
|
|
3109
3394
|
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration#commit
|
|
3110
3395
|
class Commit < MetronomeSDK::Models::UpdateBaseThresholdCommit
|
|
@@ -3150,6 +3435,14 @@ module MetronomeSDK
|
|
|
3150
3435
|
|
|
3151
3436
|
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration#discount_configuration
|
|
3152
3437
|
class DiscountConfiguration < MetronomeSDK::Internal::Type::BaseModel
|
|
3438
|
+
# @!attribute cap
|
|
3439
|
+
# Update the discount cap. Set to null to remove an existing cap.
|
|
3440
|
+
#
|
|
3441
|
+
# @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::DiscountConfiguration::Cap, nil]
|
|
3442
|
+
optional :cap,
|
|
3443
|
+
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::DiscountConfiguration::Cap },
|
|
3444
|
+
nil?: true
|
|
3445
|
+
|
|
3153
3446
|
# @!attribute payment_fraction
|
|
3154
3447
|
# The fraction of the original amount that the customer pays after applying the
|
|
3155
3448
|
# discount. Set to null to remove the discount fraction. For example, 0.85 means
|
|
@@ -3158,12 +3451,101 @@ module MetronomeSDK
|
|
|
3158
3451
|
# @return [Float, nil]
|
|
3159
3452
|
optional :payment_fraction, Float, nil?: true
|
|
3160
3453
|
|
|
3161
|
-
# @!method initialize(payment_fraction: nil)
|
|
3454
|
+
# @!method initialize(cap: nil, payment_fraction: nil)
|
|
3162
3455
|
# Some parameter documentations has been truncated, see
|
|
3163
3456
|
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::DiscountConfiguration}
|
|
3164
3457
|
# for more details.
|
|
3165
3458
|
#
|
|
3459
|
+
# @param cap [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::DiscountConfiguration::Cap, nil] Update the discount cap. Set to null to remove an existing cap.
|
|
3460
|
+
#
|
|
3166
3461
|
# @param payment_fraction [Float, nil] The fraction of the original amount that the customer pays after applying the di
|
|
3462
|
+
|
|
3463
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::DiscountConfiguration#cap
|
|
3464
|
+
class Cap < MetronomeSDK::Internal::Type::BaseModel
|
|
3465
|
+
# @!attribute amount
|
|
3466
|
+
# Accumulated spend ceiling above which the discount stops applying.
|
|
3467
|
+
#
|
|
3468
|
+
# @return [Float]
|
|
3469
|
+
required :amount, Float
|
|
3470
|
+
|
|
3471
|
+
# @!attribute spend_tracker_alias
|
|
3472
|
+
# Alias of the spend tracker this cap is measured against.
|
|
3473
|
+
#
|
|
3474
|
+
# @return [String]
|
|
3475
|
+
required :spend_tracker_alias, String
|
|
3476
|
+
|
|
3477
|
+
# @!method initialize(amount:, spend_tracker_alias:)
|
|
3478
|
+
# Update the discount cap. Set to null to remove an existing cap.
|
|
3479
|
+
#
|
|
3480
|
+
# @param amount [Float] Accumulated spend ceiling above which the discount stops applying.
|
|
3481
|
+
#
|
|
3482
|
+
# @param spend_tracker_alias [String] Alias of the spend tracker this cap is measured against.
|
|
3483
|
+
end
|
|
3484
|
+
end
|
|
3485
|
+
|
|
3486
|
+
class ThresholdBalanceSpecifier < MetronomeSDK::Internal::Type::BaseModel
|
|
3487
|
+
# @!attribute exclude
|
|
3488
|
+
#
|
|
3489
|
+
# @return [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude>]
|
|
3490
|
+
required :exclude,
|
|
3491
|
+
-> do
|
|
3492
|
+
MetronomeSDK::Internal::Type::ArrayOf[
|
|
3493
|
+
MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude
|
|
3494
|
+
]
|
|
3495
|
+
end
|
|
3496
|
+
|
|
3497
|
+
# @!method initialize(exclude:)
|
|
3498
|
+
# @param exclude [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude>]
|
|
3499
|
+
|
|
3500
|
+
class Exclude < MetronomeSDK::Internal::Type::BaseModel
|
|
3501
|
+
# @!attribute custom_field_filters
|
|
3502
|
+
#
|
|
3503
|
+
# @return [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude::CustomFieldFilter>]
|
|
3504
|
+
required :custom_field_filters,
|
|
3505
|
+
-> do
|
|
3506
|
+
MetronomeSDK::Internal::Type::ArrayOf[
|
|
3507
|
+
MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude::CustomFieldFilter
|
|
3508
|
+
]
|
|
3509
|
+
end
|
|
3510
|
+
|
|
3511
|
+
# @!method initialize(custom_field_filters:)
|
|
3512
|
+
# @param custom_field_filters [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude::CustomFieldFilter>]
|
|
3513
|
+
|
|
3514
|
+
class CustomFieldFilter < MetronomeSDK::Internal::Type::BaseModel
|
|
3515
|
+
# @!attribute entity
|
|
3516
|
+
#
|
|
3517
|
+
# @return [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude::CustomFieldFilter::Entity]
|
|
3518
|
+
required :entity,
|
|
3519
|
+
enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude::CustomFieldFilter::Entity }
|
|
3520
|
+
|
|
3521
|
+
# @!attribute key
|
|
3522
|
+
#
|
|
3523
|
+
# @return [String]
|
|
3524
|
+
required :key, String
|
|
3525
|
+
|
|
3526
|
+
# @!attribute value
|
|
3527
|
+
#
|
|
3528
|
+
# @return [String]
|
|
3529
|
+
required :value, String
|
|
3530
|
+
|
|
3531
|
+
# @!method initialize(entity:, key:, value:)
|
|
3532
|
+
# @param entity [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude::CustomFieldFilter::Entity]
|
|
3533
|
+
# @param key [String]
|
|
3534
|
+
# @param value [String]
|
|
3535
|
+
|
|
3536
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude::CustomFieldFilter#entity
|
|
3537
|
+
module Entity
|
|
3538
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
3539
|
+
|
|
3540
|
+
COMMIT = :Commit
|
|
3541
|
+
CONTRACT_CREDIT = :ContractCredit
|
|
3542
|
+
CONTRACT_CREDIT_OR_COMMIT = :ContractCreditOrCommit
|
|
3543
|
+
|
|
3544
|
+
# @!method self.values
|
|
3545
|
+
# @return [Array<Symbol>]
|
|
3546
|
+
end
|
|
3547
|
+
end
|
|
3548
|
+
end
|
|
3167
3549
|
end
|
|
3168
3550
|
end
|
|
3169
3551
|
|
|
@@ -3190,17 +3572,31 @@ module MetronomeSDK
|
|
|
3190
3572
|
optional :invoice_amount,
|
|
3191
3573
|
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit::InvoiceAmount }
|
|
3192
3574
|
|
|
3575
|
+
# @!attribute proration_rounding
|
|
3576
|
+
# Rounding configuration for prorated recurring commit amounts.
|
|
3577
|
+
#
|
|
3578
|
+
# @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit::ProrationRounding, nil]
|
|
3579
|
+
optional :proration_rounding,
|
|
3580
|
+
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit::ProrationRounding },
|
|
3581
|
+
nil?: true
|
|
3582
|
+
|
|
3193
3583
|
# @!attribute rate_type
|
|
3194
3584
|
#
|
|
3195
3585
|
# @return [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit::RateType, nil]
|
|
3196
3586
|
optional :rate_type,
|
|
3197
3587
|
enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit::RateType }
|
|
3198
3588
|
|
|
3199
|
-
# @!method initialize(id:, access_amount: nil, ending_before: nil, invoice_amount: nil, rate_type: nil)
|
|
3589
|
+
# @!method initialize(id:, access_amount: nil, ending_before: nil, invoice_amount: nil, proration_rounding: nil, rate_type: nil)
|
|
3200
3590
|
# @param id [String]
|
|
3591
|
+
#
|
|
3201
3592
|
# @param access_amount [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit::AccessAmount]
|
|
3593
|
+
#
|
|
3202
3594
|
# @param ending_before [Time]
|
|
3595
|
+
#
|
|
3203
3596
|
# @param invoice_amount [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit::InvoiceAmount]
|
|
3597
|
+
#
|
|
3598
|
+
# @param proration_rounding [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit::ProrationRounding, nil] Rounding configuration for prorated recurring commit amounts.
|
|
3599
|
+
#
|
|
3204
3600
|
# @param rate_type [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit::RateType]
|
|
3205
3601
|
|
|
3206
3602
|
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit#access_amount
|
|
@@ -3237,6 +3633,103 @@ module MetronomeSDK
|
|
|
3237
3633
|
# @param unit_price [Float]
|
|
3238
3634
|
end
|
|
3239
3635
|
|
|
3636
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit#proration_rounding
|
|
3637
|
+
class ProrationRounding < MetronomeSDK::Internal::Type::BaseModel
|
|
3638
|
+
# @!attribute access
|
|
3639
|
+
#
|
|
3640
|
+
# @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit::ProrationRounding::Access, nil]
|
|
3641
|
+
optional :access,
|
|
3642
|
+
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit::ProrationRounding::Access }
|
|
3643
|
+
|
|
3644
|
+
# @!attribute invoice
|
|
3645
|
+
#
|
|
3646
|
+
# @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit::ProrationRounding::Invoice, nil]
|
|
3647
|
+
optional :invoice,
|
|
3648
|
+
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit::ProrationRounding::Invoice }
|
|
3649
|
+
|
|
3650
|
+
# @!method initialize(access: nil, invoice: nil)
|
|
3651
|
+
# Rounding configuration for prorated recurring commit amounts.
|
|
3652
|
+
#
|
|
3653
|
+
# @param access [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit::ProrationRounding::Access]
|
|
3654
|
+
# @param invoice [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit::ProrationRounding::Invoice]
|
|
3655
|
+
|
|
3656
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit::ProrationRounding#access
|
|
3657
|
+
class Access < MetronomeSDK::Internal::Type::BaseModel
|
|
3658
|
+
# @!attribute decimal_places
|
|
3659
|
+
# Number of decimal places to round to. Applied directly to the stored monetary
|
|
3660
|
+
# representation. Negative values round to powers of 10 (e.g., -2 rounds to
|
|
3661
|
+
# nearest 100 in the stored unit).
|
|
3662
|
+
#
|
|
3663
|
+
# @return [Float]
|
|
3664
|
+
required :decimal_places, Float
|
|
3665
|
+
|
|
3666
|
+
# @!attribute rounding_method
|
|
3667
|
+
#
|
|
3668
|
+
# @return [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit::ProrationRounding::Access::RoundingMethod]
|
|
3669
|
+
required :rounding_method,
|
|
3670
|
+
enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit::ProrationRounding::Access::RoundingMethod }
|
|
3671
|
+
|
|
3672
|
+
# @!method initialize(decimal_places:, rounding_method:)
|
|
3673
|
+
# Some parameter documentations has been truncated, see
|
|
3674
|
+
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit::ProrationRounding::Access}
|
|
3675
|
+
# for more details.
|
|
3676
|
+
#
|
|
3677
|
+
# @param decimal_places [Float] Number of decimal places to round to. Applied directly to the stored monetary re
|
|
3678
|
+
#
|
|
3679
|
+
# @param rounding_method [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit::ProrationRounding::Access::RoundingMethod]
|
|
3680
|
+
|
|
3681
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit::ProrationRounding::Access#rounding_method
|
|
3682
|
+
module RoundingMethod
|
|
3683
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
3684
|
+
|
|
3685
|
+
HALF_UP = :HALF_UP
|
|
3686
|
+
FLOOR = :FLOOR
|
|
3687
|
+
CEILING = :CEILING
|
|
3688
|
+
|
|
3689
|
+
# @!method self.values
|
|
3690
|
+
# @return [Array<Symbol>]
|
|
3691
|
+
end
|
|
3692
|
+
end
|
|
3693
|
+
|
|
3694
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit::ProrationRounding#invoice
|
|
3695
|
+
class Invoice < MetronomeSDK::Internal::Type::BaseModel
|
|
3696
|
+
# @!attribute decimal_places
|
|
3697
|
+
# Number of decimal places to round to. Applied directly to the stored monetary
|
|
3698
|
+
# representation. Negative values round to powers of 10 (e.g., -2 rounds to
|
|
3699
|
+
# nearest 100 in the stored unit).
|
|
3700
|
+
#
|
|
3701
|
+
# @return [Float]
|
|
3702
|
+
required :decimal_places, Float
|
|
3703
|
+
|
|
3704
|
+
# @!attribute rounding_method
|
|
3705
|
+
#
|
|
3706
|
+
# @return [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit::ProrationRounding::Invoice::RoundingMethod]
|
|
3707
|
+
required :rounding_method,
|
|
3708
|
+
enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit::ProrationRounding::Invoice::RoundingMethod }
|
|
3709
|
+
|
|
3710
|
+
# @!method initialize(decimal_places:, rounding_method:)
|
|
3711
|
+
# Some parameter documentations has been truncated, see
|
|
3712
|
+
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit::ProrationRounding::Invoice}
|
|
3713
|
+
# for more details.
|
|
3714
|
+
#
|
|
3715
|
+
# @param decimal_places [Float] Number of decimal places to round to. Applied directly to the stored monetary re
|
|
3716
|
+
#
|
|
3717
|
+
# @param rounding_method [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit::ProrationRounding::Invoice::RoundingMethod]
|
|
3718
|
+
|
|
3719
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit::ProrationRounding::Invoice#rounding_method
|
|
3720
|
+
module RoundingMethod
|
|
3721
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
3722
|
+
|
|
3723
|
+
HALF_UP = :HALF_UP
|
|
3724
|
+
FLOOR = :FLOOR
|
|
3725
|
+
CEILING = :CEILING
|
|
3726
|
+
|
|
3727
|
+
# @!method self.values
|
|
3728
|
+
# @return [Array<Symbol>]
|
|
3729
|
+
end
|
|
3730
|
+
end
|
|
3731
|
+
end
|
|
3732
|
+
|
|
3240
3733
|
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit#rate_type
|
|
3241
3734
|
module RateType
|
|
3242
3735
|
extend MetronomeSDK::Internal::Type::Enum
|
|
@@ -3266,16 +3759,29 @@ module MetronomeSDK
|
|
|
3266
3759
|
# @return [Time, nil]
|
|
3267
3760
|
optional :ending_before, Time
|
|
3268
3761
|
|
|
3762
|
+
# @!attribute proration_rounding
|
|
3763
|
+
# Rounding configuration for prorated recurring credit amounts.
|
|
3764
|
+
#
|
|
3765
|
+
# @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCredit::ProrationRounding, nil]
|
|
3766
|
+
optional :proration_rounding,
|
|
3767
|
+
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCredit::ProrationRounding },
|
|
3768
|
+
nil?: true
|
|
3769
|
+
|
|
3269
3770
|
# @!attribute rate_type
|
|
3270
3771
|
#
|
|
3271
3772
|
# @return [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCredit::RateType, nil]
|
|
3272
3773
|
optional :rate_type,
|
|
3273
3774
|
enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCredit::RateType }
|
|
3274
3775
|
|
|
3275
|
-
# @!method initialize(id:, access_amount: nil, ending_before: nil, rate_type: nil)
|
|
3776
|
+
# @!method initialize(id:, access_amount: nil, ending_before: nil, proration_rounding: nil, rate_type: nil)
|
|
3276
3777
|
# @param id [String]
|
|
3778
|
+
#
|
|
3277
3779
|
# @param access_amount [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCredit::AccessAmount]
|
|
3780
|
+
#
|
|
3278
3781
|
# @param ending_before [Time]
|
|
3782
|
+
#
|
|
3783
|
+
# @param proration_rounding [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCredit::ProrationRounding, nil] Rounding configuration for prorated recurring credit amounts.
|
|
3784
|
+
#
|
|
3279
3785
|
# @param rate_type [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCredit::RateType]
|
|
3280
3786
|
|
|
3281
3787
|
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCredit#access_amount
|
|
@@ -3295,6 +3801,58 @@ module MetronomeSDK
|
|
|
3295
3801
|
# @param unit_price [Float]
|
|
3296
3802
|
end
|
|
3297
3803
|
|
|
3804
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCredit#proration_rounding
|
|
3805
|
+
class ProrationRounding < MetronomeSDK::Internal::Type::BaseModel
|
|
3806
|
+
# @!attribute access
|
|
3807
|
+
#
|
|
3808
|
+
# @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCredit::ProrationRounding::Access, nil]
|
|
3809
|
+
optional :access,
|
|
3810
|
+
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCredit::ProrationRounding::Access }
|
|
3811
|
+
|
|
3812
|
+
# @!method initialize(access: nil)
|
|
3813
|
+
# Rounding configuration for prorated recurring credit amounts.
|
|
3814
|
+
#
|
|
3815
|
+
# @param access [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCredit::ProrationRounding::Access]
|
|
3816
|
+
|
|
3817
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCredit::ProrationRounding#access
|
|
3818
|
+
class Access < MetronomeSDK::Internal::Type::BaseModel
|
|
3819
|
+
# @!attribute decimal_places
|
|
3820
|
+
# Number of decimal places to round to. Applied directly to the stored monetary
|
|
3821
|
+
# representation. Negative values round to powers of 10 (e.g., -2 rounds to
|
|
3822
|
+
# nearest 100 in the stored unit).
|
|
3823
|
+
#
|
|
3824
|
+
# @return [Float]
|
|
3825
|
+
required :decimal_places, Float
|
|
3826
|
+
|
|
3827
|
+
# @!attribute rounding_method
|
|
3828
|
+
#
|
|
3829
|
+
# @return [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCredit::ProrationRounding::Access::RoundingMethod]
|
|
3830
|
+
required :rounding_method,
|
|
3831
|
+
enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCredit::ProrationRounding::Access::RoundingMethod }
|
|
3832
|
+
|
|
3833
|
+
# @!method initialize(decimal_places:, rounding_method:)
|
|
3834
|
+
# Some parameter documentations has been truncated, see
|
|
3835
|
+
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCredit::ProrationRounding::Access}
|
|
3836
|
+
# for more details.
|
|
3837
|
+
#
|
|
3838
|
+
# @param decimal_places [Float] Number of decimal places to round to. Applied directly to the stored monetary re
|
|
3839
|
+
#
|
|
3840
|
+
# @param rounding_method [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCredit::ProrationRounding::Access::RoundingMethod]
|
|
3841
|
+
|
|
3842
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCredit::ProrationRounding::Access#rounding_method
|
|
3843
|
+
module RoundingMethod
|
|
3844
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
3845
|
+
|
|
3846
|
+
HALF_UP = :HALF_UP
|
|
3847
|
+
FLOOR = :FLOOR
|
|
3848
|
+
CEILING = :CEILING
|
|
3849
|
+
|
|
3850
|
+
# @!method self.values
|
|
3851
|
+
# @return [Array<Symbol>]
|
|
3852
|
+
end
|
|
3853
|
+
end
|
|
3854
|
+
end
|
|
3855
|
+
|
|
3298
3856
|
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCredit#rate_type
|
|
3299
3857
|
module RateType
|
|
3300
3858
|
extend MetronomeSDK::Internal::Type::Enum
|
|
@@ -3513,6 +4071,14 @@ module MetronomeSDK
|
|
|
3513
4071
|
|
|
3514
4072
|
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSpendThresholdConfiguration#discount_configuration
|
|
3515
4073
|
class DiscountConfiguration < MetronomeSDK::Internal::Type::BaseModel
|
|
4074
|
+
# @!attribute cap
|
|
4075
|
+
# Update the discount cap. Set to null to remove an existing cap.
|
|
4076
|
+
#
|
|
4077
|
+
# @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSpendThresholdConfiguration::DiscountConfiguration::Cap, nil]
|
|
4078
|
+
optional :cap,
|
|
4079
|
+
-> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSpendThresholdConfiguration::DiscountConfiguration::Cap },
|
|
4080
|
+
nil?: true
|
|
4081
|
+
|
|
3516
4082
|
# @!attribute payment_fraction
|
|
3517
4083
|
# The fraction of the original amount that the customer pays after applying the
|
|
3518
4084
|
# discount. Set to null to remove the discount fraction. For example, 0.85 means
|
|
@@ -3521,12 +4087,36 @@ module MetronomeSDK
|
|
|
3521
4087
|
# @return [Float, nil]
|
|
3522
4088
|
optional :payment_fraction, Float, nil?: true
|
|
3523
4089
|
|
|
3524
|
-
# @!method initialize(payment_fraction: nil)
|
|
4090
|
+
# @!method initialize(cap: nil, payment_fraction: nil)
|
|
3525
4091
|
# Some parameter documentations has been truncated, see
|
|
3526
4092
|
# {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSpendThresholdConfiguration::DiscountConfiguration}
|
|
3527
4093
|
# for more details.
|
|
3528
4094
|
#
|
|
4095
|
+
# @param cap [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSpendThresholdConfiguration::DiscountConfiguration::Cap, nil] Update the discount cap. Set to null to remove an existing cap.
|
|
4096
|
+
#
|
|
3529
4097
|
# @param payment_fraction [Float, nil] The fraction of the original amount that the customer pays after applying the di
|
|
4098
|
+
|
|
4099
|
+
# @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSpendThresholdConfiguration::DiscountConfiguration#cap
|
|
4100
|
+
class Cap < MetronomeSDK::Internal::Type::BaseModel
|
|
4101
|
+
# @!attribute amount
|
|
4102
|
+
# Accumulated spend ceiling above which the discount stops applying.
|
|
4103
|
+
#
|
|
4104
|
+
# @return [Float]
|
|
4105
|
+
required :amount, Float
|
|
4106
|
+
|
|
4107
|
+
# @!attribute spend_tracker_alias
|
|
4108
|
+
# Alias of the spend tracker this cap is measured against.
|
|
4109
|
+
#
|
|
4110
|
+
# @return [String]
|
|
4111
|
+
required :spend_tracker_alias, String
|
|
4112
|
+
|
|
4113
|
+
# @!method initialize(amount:, spend_tracker_alias:)
|
|
4114
|
+
# Update the discount cap. Set to null to remove an existing cap.
|
|
4115
|
+
#
|
|
4116
|
+
# @param amount [Float] Accumulated spend ceiling above which the discount stops applying.
|
|
4117
|
+
#
|
|
4118
|
+
# @param spend_tracker_alias [String] Alias of the spend tracker this cap is measured against.
|
|
4119
|
+
end
|
|
3530
4120
|
end
|
|
3531
4121
|
end
|
|
3532
4122
|
|