metronome-sdk 3.7.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 +38 -0
- data/README.md +1 -1
- data/lib/metronome_sdk/internal/transport/base_client.rb +4 -1
- data/lib/metronome_sdk/models/commit.rb +10 -1
- data/lib/metronome_sdk/models/contract_v2.rb +290 -7
- data/lib/metronome_sdk/models/contract_without_amendments.rb +178 -4
- 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 +10 -2
- data/lib/metronome_sdk/models/prepaid_balance_threshold_configuration_v2.rb +3 -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 +17 -4
- data/lib/metronome_sdk/models/v1/contract_create_params.rb +290 -10
- data/lib/metronome_sdk/models/v1/contract_create_response.rb +178 -4
- 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 +279 -10
- data/lib/metronome_sdk/models/v1/package_list_response.rb +264 -7
- data/lib/metronome_sdk/models/v1/package_retrieve_response.rb +264 -7
- data/lib/metronome_sdk/models/v2/contract_edit_params.rb +515 -9
- data/lib/metronome_sdk/models/v2/contract_edit_response.rb +456 -8
- data/lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb +456 -8
- 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 +68 -1
- 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/version.rb +1 -1
- data/lib/metronome_sdk.rb +2 -0
- data/rbi/metronome_sdk/models/commit.rbi +13 -0
- data/rbi/metronome_sdk/models/contract_v2.rbi +715 -3
- data/rbi/metronome_sdk/models/contract_without_amendments.rbi +463 -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 +11 -1
- data/rbi/metronome_sdk/models/prepaid_balance_threshold_configuration_v2.rbi +4 -0
- 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 +27 -6
- data/rbi/metronome_sdk/models/v1/contract_create_params.rbi +719 -9
- data/rbi/metronome_sdk/models/v1/contract_create_response.rbi +463 -0
- 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 +706 -9
- data/rbi/metronome_sdk/models/v1/package_list_response.rbi +693 -3
- data/rbi/metronome_sdk/models/v1/package_retrieve_response.rbi +693 -3
- data/rbi/metronome_sdk/models/v2/contract_edit_params.rbi +1333 -40
- data/rbi/metronome_sdk/models/v2/contract_edit_response.rbi +1204 -67
- data/rbi/metronome_sdk/models/v2/contract_get_edit_history_response.rbi +1204 -67
- 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 +70 -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/sig/metronome_sdk/models/commit.rbs +7 -0
- data/sig/metronome_sdk/models/contract_v2.rbs +278 -5
- data/sig/metronome_sdk/models/contract_without_amendments.rbs +169 -2
- data/sig/metronome_sdk/models/credit.rbs +7 -0
- data/sig/metronome_sdk/models/override.rbs +7 -0
- 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 +7 -0
- data/sig/metronome_sdk/models/v1/contract_create_params.rbs +278 -5
- data/sig/metronome_sdk/models/v1/contract_create_response.rbs +167 -2
- 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 +271 -5
- data/sig/metronome_sdk/models/v1/package_list_response.rbs +265 -5
- data/sig/metronome_sdk/models/v1/package_retrieve_response.rbs +263 -5
- data/sig/metronome_sdk/models/v2/contract_edit_params.rbs +468 -5
- data/sig/metronome_sdk/models/v2/contract_edit_response.rbs +428 -5
- data/sig/metronome_sdk/models/v2/contract_get_edit_history_response.rbs +427 -5
- data/sig/metronome_sdk/resources/v1/alerts.rbs +1 -0
- data/sig/metronome_sdk/resources/v1/contracts.rbs +13 -0
- data/sig/metronome_sdk/resources/v1/customers/alerts.rbs +1 -0
- data/sig/metronome_sdk/resources/v1/customers/invoices.rbs +1 -0
- metadata +8 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 97f31a567a1ed13359a6db7517a0a31b47f7ab157d92e417fdfb60050869737a
|
|
4
|
+
data.tar.gz: b17e2f57bd7d2db609f95f5dcf5b165d6e050dd05eb717bab10148b450b19bb0
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 771169e3edf3cbd87d0ce517fa9999c1303af4ad003ad278c58ad7239545f7157224e52646b1db43fc7b17db0af0d038cdda41d66bc6115038cb39ba48123843
|
|
7
|
+
data.tar.gz: 8b0180525f48ed9bf872de4bf2f29c6b504f20eef0dd1acc013d526115dfb34b3839dca5c0e20d0a8ec2248ea6968678b919a2881c7ab801b637eb72f2abd17f
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,43 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 3.8.0 (2026-06-29)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v3.7.0...v3.8.0](https://github.com/Metronome-Industries/metronome-ruby/compare/v3.7.0...v3.8.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* [🪿] Remove `allow-subscriptions-custom-billing-anchor` feature flag ([4a67399](https://github.com/Metronome-Industries/metronome-ruby/commit/4a673991f9369fe744bc3a5a2f854c14c9b497ac))
|
|
10
|
+
* Add `Action` and `Action_hover` theme color options to embeddable dashboard ([ad6641d](https://github.com/Metronome-Industries/metronome-ruby/commit/ad6641d4ff8118e8acc920c143adb6e57bfd4201))
|
|
11
|
+
* Add alert specifiers to for `low_remaining_contract_credit_and_commit_balance_reached` threshold notification creation payload ([8dccadf](https://github.com/Metronome-Industries/metronome-ruby/commit/8dccadf1cc4077759e004a8802cb603971b6f978))
|
|
12
|
+
* Add any_commit_and_credit_ids to override specifier fields ([797cfca](https://github.com/Metronome-Industries/metronome-ruby/commit/797cfca1e8f5179b99887b99ccbf8391366cdb74))
|
|
13
|
+
* add getSubscriptionSeatsHistory to Node SDK ([d288a2a](https://github.com/Metronome-Industries/metronome-ruby/commit/d288a2a109b6f0d6e0c45cdd4d3a8ab64ec9732c))
|
|
14
|
+
* Add notification_metadata to four API endpoints (Anthropic-only) ([fb4e252](https://github.com/Metronome-Industries/metronome-ruby/commit/fb4e252118ebc3ce523e12074af87a90dadf712a))
|
|
15
|
+
* added created by to commits ([a11cb6f](https://github.com/Metronome-Industries/metronome-ruby/commit/a11cb6fe06264f5d348818e77c8b1b1bb560b339))
|
|
16
|
+
* **CONN-980:** add contract_id, invoice_type, show_unbillable_invoices to embeddable dashboard API ([cccf877](https://github.com/Metronome-Industries/metronome-ruby/commit/cccf877456c646c28569fbf9e4e86cec7b32faf6))
|
|
17
|
+
* createdBy description specifies excluding system created commits ([d492e50](https://github.com/Metronome-Industries/metronome-ruby/commit/d492e5019a404dd6cfd0606a7fa959e45e79d42c))
|
|
18
|
+
* daily recurrence frequency for recurring commits ([b143c69](https://github.com/Metronome-Industries/metronome-ruby/commit/b143c690a98329e91830210aebb56d9fd910b8d3))
|
|
19
|
+
* Docs: Update v1.yml ([2b13cb9](https://github.com/Metronome-Industries/metronome-ruby/commit/2b13cb9e673f4af7a8413c581e8b0722f98905c2))
|
|
20
|
+
* Revert "[pgs] Remove `allow-subscriptions-custom-billing-anchor` and proration rounding feature flags" ([804fc62](https://github.com/Metronome-Industries/metronome-ruby/commit/804fc62384bd67a65e9f022349d8af18e7faf3e8))
|
|
21
|
+
* Revert "Revert "[pgs] Remove `allow-subscriptions-custom-billing-anchor` and proration rounding feature flags"" ([b5532d9](https://github.com/Metronome-Industries/metronome-ruby/commit/b5532d9ec1866c08629b7f7616bdb7eb12a2f541))
|
|
22
|
+
* skip seat IDs from balances ([242fa91](https://github.com/Metronome-Industries/metronome-ruby/commit/242fa91291d812744c214497ee2f87e03c20e048))
|
|
23
|
+
* Update copy ([911d292](https://github.com/Metronome-Industries/metronome-ruby/commit/911d2924cef101ec49077fe8a859e7b9a9d3f083))
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
### Bug Fixes
|
|
27
|
+
|
|
28
|
+
* **client:** send content-type header for requests with an omitted optional body ([4d4e05a](https://github.com/Metronome-Industries/metronome-ruby/commit/4d4e05aa6c499bc6f51e60d134225cccc49767d0))
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
### Chores
|
|
32
|
+
|
|
33
|
+
* (internal) Add description for threshold balance specifiers fields ([bbc523a](https://github.com/Metronome-Industries/metronome-ruby/commit/bbc523aae016d1a9d907bdae0a656164ffd242de))
|
|
34
|
+
* **internal:** bound formatter parallelism to CPU count ([b497f47](https://github.com/Metronome-Industries/metronome-ruby/commit/b497f478f4d039c50d4cf2366bd2d492d0489002))
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
### Documentation
|
|
38
|
+
|
|
39
|
+
* add RPS limit and batch recommendation to addRate endpoint ([aad17f7](https://github.com/Metronome-Industries/metronome-ruby/commit/aad17f7960f3caad7db5c4e4d3d78e1308b92676))
|
|
40
|
+
|
|
3
41
|
## 3.7.0 (2026-05-29)
|
|
4
42
|
|
|
5
43
|
Full Changelog: [v3.6.0...v3.7.0](https://github.com/Metronome-Industries/metronome-ruby/compare/v3.6.0...v3.7.0)
|
data/README.md
CHANGED
|
@@ -306,7 +306,10 @@ module MetronomeSDK
|
|
|
306
306
|
MetronomeSDK::Internal::Util.deep_merge(*[req[:body], opts[:extra_body]].compact)
|
|
307
307
|
end
|
|
308
308
|
|
|
309
|
-
|
|
309
|
+
# Generated methods always pass `req[:body]` for operations that define a
|
|
310
|
+
# request body, so only elide the content-type header when the operation
|
|
311
|
+
# has no body at all, not when an optional body param was omitted.
|
|
312
|
+
headers.delete("content-type") if body.nil? && !req.key?(:body)
|
|
310
313
|
|
|
311
314
|
url = MetronomeSDK::Internal::Util.join_parsed_uri(
|
|
312
315
|
@base_url_components,
|
|
@@ -81,6 +81,13 @@ module MetronomeSDK
|
|
|
81
81
|
# @return [MetronomeSDK::Models::Commit::Contract, nil]
|
|
82
82
|
optional :contract, -> { MetronomeSDK::Commit::Contract }
|
|
83
83
|
|
|
84
|
+
# @!attribute created_by
|
|
85
|
+
# The actor who created this commit. Omitted for system-generated commits such as
|
|
86
|
+
# recurring commits, rollover commits, and threshold commits.
|
|
87
|
+
#
|
|
88
|
+
# @return [String, nil]
|
|
89
|
+
optional :created_by, String
|
|
90
|
+
|
|
84
91
|
# @!attribute custom_fields
|
|
85
92
|
# Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
86
93
|
#
|
|
@@ -193,7 +200,7 @@ module MetronomeSDK
|
|
|
193
200
|
# @return [String, nil]
|
|
194
201
|
optional :uniqueness_key, String
|
|
195
202
|
|
|
196
|
-
# @!method initialize(id:, created_at:, product:, type:, access_schedule: nil, amount: nil, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, archived_at: nil, balance: nil, contract: nil, custom_fields: nil, description: nil, hierarchy_configuration: nil, invoice_contract: nil, invoice_schedule: nil, ledger: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, rate_type: nil, recurring_commit_id: nil, rolled_over_from: nil, rollover_fraction: nil, salesforce_opportunity_id: nil, specifiers: nil, spend_tracker_attributes: nil, subscription_config: nil, uniqueness_key: nil)
|
|
203
|
+
# @!method initialize(id:, created_at:, product:, type:, access_schedule: nil, amount: nil, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, archived_at: nil, balance: nil, contract: nil, created_by: nil, custom_fields: nil, description: nil, hierarchy_configuration: nil, invoice_contract: nil, invoice_schedule: nil, ledger: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, rate_type: nil, recurring_commit_id: nil, rolled_over_from: nil, rollover_fraction: nil, salesforce_opportunity_id: nil, specifiers: nil, spend_tracker_attributes: nil, subscription_config: nil, uniqueness_key: nil)
|
|
197
204
|
# Some parameter documentations has been truncated, see
|
|
198
205
|
# {MetronomeSDK::Models::Commit} for more details.
|
|
199
206
|
#
|
|
@@ -221,6 +228,8 @@ module MetronomeSDK
|
|
|
221
228
|
#
|
|
222
229
|
# @param contract [MetronomeSDK::Models::Commit::Contract]
|
|
223
230
|
#
|
|
231
|
+
# @param created_by [String] The actor who created this commit. Omitted for system-generated commits such as
|
|
232
|
+
#
|
|
224
233
|
# @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
225
234
|
#
|
|
226
235
|
# @param description [String]
|
|
@@ -371,6 +371,13 @@ module MetronomeSDK
|
|
|
371
371
|
# @return [MetronomeSDK::Models::ContractV2::Commit::Contract, nil]
|
|
372
372
|
optional :contract, -> { MetronomeSDK::ContractV2::Commit::Contract }
|
|
373
373
|
|
|
374
|
+
# @!attribute created_by
|
|
375
|
+
# The actor who created this commit. Omitted for system-generated commits such as
|
|
376
|
+
# recurring commits, rollover commits, and threshold commits.
|
|
377
|
+
#
|
|
378
|
+
# @return [String, nil]
|
|
379
|
+
optional :created_by, String
|
|
380
|
+
|
|
374
381
|
# @!attribute custom_fields
|
|
375
382
|
# Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
376
383
|
#
|
|
@@ -473,7 +480,7 @@ module MetronomeSDK
|
|
|
473
480
|
# @return [MetronomeSDK::Models::RecurringCommitSubscriptionConfig, nil]
|
|
474
481
|
optional :subscription_config, -> { MetronomeSDK::RecurringCommitSubscriptionConfig }
|
|
475
482
|
|
|
476
|
-
# @!method initialize(id:, created_at:, product:, type:, access_schedule: nil, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, archived_at: nil, balance: nil, contract: nil, custom_fields: nil, description: nil, hierarchy_configuration: nil, invoice_contract: nil, invoice_schedule: nil, ledger: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, rate_type: nil, recurring_commit_id: nil, rolled_over_from: nil, rollover_fraction: nil, salesforce_opportunity_id: nil, specifiers: nil, spend_tracker_attributes: nil, subscription_config: nil)
|
|
483
|
+
# @!method initialize(id:, created_at:, product:, type:, access_schedule: nil, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, archived_at: nil, balance: nil, contract: nil, created_by: nil, custom_fields: nil, description: nil, hierarchy_configuration: nil, invoice_contract: nil, invoice_schedule: nil, ledger: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, rate_type: nil, recurring_commit_id: nil, rolled_over_from: nil, rollover_fraction: nil, salesforce_opportunity_id: nil, specifiers: nil, spend_tracker_attributes: nil, subscription_config: nil)
|
|
477
484
|
# Some parameter documentations has been truncated, see
|
|
478
485
|
# {MetronomeSDK::Models::ContractV2::Commit} for more details.
|
|
479
486
|
#
|
|
@@ -499,6 +506,8 @@ module MetronomeSDK
|
|
|
499
506
|
#
|
|
500
507
|
# @param contract [MetronomeSDK::Models::ContractV2::Commit::Contract]
|
|
501
508
|
#
|
|
509
|
+
# @param created_by [String] The actor who created this commit. Omitted for system-generated commits such as
|
|
510
|
+
#
|
|
502
511
|
# @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
503
512
|
#
|
|
504
513
|
# @param description [String]
|
|
@@ -1363,6 +1372,11 @@ module MetronomeSDK
|
|
|
1363
1372
|
# @param type [Symbol, MetronomeSDK::Models::ContractV2::Override::Type]
|
|
1364
1373
|
|
|
1365
1374
|
class OverrideSpecifier < MetronomeSDK::Internal::Type::BaseModel
|
|
1375
|
+
# @!attribute any_commit_or_credit_ids
|
|
1376
|
+
#
|
|
1377
|
+
# @return [Array<String>, nil]
|
|
1378
|
+
optional :any_commit_or_credit_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
|
|
1379
|
+
|
|
1366
1380
|
# @!attribute billing_frequency
|
|
1367
1381
|
#
|
|
1368
1382
|
# @return [Symbol, MetronomeSDK::Models::ContractV2::Override::OverrideSpecifier::BillingFrequency, nil]
|
|
@@ -1399,7 +1413,8 @@ module MetronomeSDK
|
|
|
1399
1413
|
# @return [Array<String>, nil]
|
|
1400
1414
|
optional :recurring_commit_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
|
|
1401
1415
|
|
|
1402
|
-
# @!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)
|
|
1416
|
+
# @!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)
|
|
1417
|
+
# @param any_commit_or_credit_ids [Array<String>]
|
|
1403
1418
|
# @param billing_frequency [Symbol, MetronomeSDK::Models::ContractV2::Override::OverrideSpecifier::BillingFrequency]
|
|
1404
1419
|
# @param commit_ids [Array<String>]
|
|
1405
1420
|
# @param presentation_group_values [Hash{Symbol=>String, nil}]
|
|
@@ -1714,6 +1729,13 @@ module MetronomeSDK
|
|
|
1714
1729
|
# @return [Time, nil]
|
|
1715
1730
|
optional :created_at, Time
|
|
1716
1731
|
|
|
1732
|
+
# @!attribute created_by
|
|
1733
|
+
# The actor who created this credit. Omitted for system-generated credits such as
|
|
1734
|
+
# recurring credits.
|
|
1735
|
+
#
|
|
1736
|
+
# @return [String, nil]
|
|
1737
|
+
optional :created_by, String
|
|
1738
|
+
|
|
1717
1739
|
# @!attribute custom_fields
|
|
1718
1740
|
# Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
1719
1741
|
#
|
|
@@ -1788,7 +1810,7 @@ module MetronomeSDK
|
|
|
1788
1810
|
# @return [MetronomeSDK::Models::RecurringCommitSubscriptionConfig, nil]
|
|
1789
1811
|
optional :subscription_config, -> { MetronomeSDK::RecurringCommitSubscriptionConfig }
|
|
1790
1812
|
|
|
1791
|
-
# @!method initialize(id:, product:, type:, access_schedule: nil, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, archived_at: nil, balance: nil, contract: nil, created_at: nil, custom_fields: nil, description: nil, hierarchy_configuration: nil, ledger: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, recurring_credit_id: nil, rolled_over_from: nil, salesforce_opportunity_id: nil, specifiers: nil, subscription_config: nil)
|
|
1813
|
+
# @!method initialize(id:, product:, type:, access_schedule: nil, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, archived_at: nil, balance: nil, contract: nil, created_at: nil, created_by: nil, custom_fields: nil, description: nil, hierarchy_configuration: nil, ledger: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, recurring_credit_id: nil, rolled_over_from: nil, salesforce_opportunity_id: nil, specifiers: nil, subscription_config: nil)
|
|
1792
1814
|
# Some parameter documentations has been truncated, see
|
|
1793
1815
|
# {MetronomeSDK::Models::ContractV2::Credit} for more details.
|
|
1794
1816
|
#
|
|
@@ -1814,6 +1836,8 @@ module MetronomeSDK
|
|
|
1814
1836
|
#
|
|
1815
1837
|
# @param created_at [Time] Timestamp of when the credit was created.
|
|
1816
1838
|
#
|
|
1839
|
+
# @param created_by [String] The actor who created this credit. Omitted for system-generated credits such as
|
|
1840
|
+
#
|
|
1817
1841
|
# @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
1818
1842
|
#
|
|
1819
1843
|
# @param description [String]
|
|
@@ -2663,6 +2687,14 @@ module MetronomeSDK
|
|
|
2663
2687
|
# @return [Symbol, MetronomeSDK::Models::ContractV2::RecurringCommit::Proration, nil]
|
|
2664
2688
|
optional :proration, enum: -> { MetronomeSDK::ContractV2::RecurringCommit::Proration }
|
|
2665
2689
|
|
|
2690
|
+
# @!attribute proration_rounding
|
|
2691
|
+
# Rounding configuration for prorated recurring commit amounts.
|
|
2692
|
+
#
|
|
2693
|
+
# @return [MetronomeSDK::Models::ContractV2::RecurringCommit::ProrationRounding, nil]
|
|
2694
|
+
optional :proration_rounding,
|
|
2695
|
+
-> { MetronomeSDK::ContractV2::RecurringCommit::ProrationRounding },
|
|
2696
|
+
nil?: true
|
|
2697
|
+
|
|
2666
2698
|
# @!attribute recurrence_frequency
|
|
2667
2699
|
# The frequency at which the recurring commits will be created. If not provided: -
|
|
2668
2700
|
# The commits will be created on the usage invoice frequency. If provided: - The
|
|
@@ -2696,7 +2728,7 @@ module MetronomeSDK
|
|
|
2696
2728
|
# @return [MetronomeSDK::Models::RecurringCommitSubscriptionConfig, nil]
|
|
2697
2729
|
optional :subscription_config, -> { MetronomeSDK::RecurringCommitSubscriptionConfig }
|
|
2698
2730
|
|
|
2699
|
-
# @!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)
|
|
2731
|
+
# @!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)
|
|
2700
2732
|
# Some parameter documentations has been truncated, see
|
|
2701
2733
|
# {MetronomeSDK::Models::ContractV2::RecurringCommit} for more details.
|
|
2702
2734
|
#
|
|
@@ -2734,6 +2766,8 @@ module MetronomeSDK
|
|
|
2734
2766
|
#
|
|
2735
2767
|
# @param proration [Symbol, MetronomeSDK::Models::ContractV2::RecurringCommit::Proration] Determines whether the first and last commit will be prorated. If not provided,
|
|
2736
2768
|
#
|
|
2769
|
+
# @param proration_rounding [MetronomeSDK::Models::ContractV2::RecurringCommit::ProrationRounding, nil] Rounding configuration for prorated recurring commit amounts.
|
|
2770
|
+
#
|
|
2737
2771
|
# @param recurrence_frequency [Symbol, MetronomeSDK::Models::ContractV2::RecurringCommit::RecurrenceFrequency] The frequency at which the recurring commits will be created. If not provided: -
|
|
2738
2772
|
#
|
|
2739
2773
|
# @param rollover_fraction [Float] Will be passed down to the individual commits. This controls how much of an indi
|
|
@@ -2878,6 +2912,101 @@ module MetronomeSDK
|
|
|
2878
2912
|
# @return [Array<Symbol>]
|
|
2879
2913
|
end
|
|
2880
2914
|
|
|
2915
|
+
# @see MetronomeSDK::Models::ContractV2::RecurringCommit#proration_rounding
|
|
2916
|
+
class ProrationRounding < MetronomeSDK::Internal::Type::BaseModel
|
|
2917
|
+
# @!attribute access
|
|
2918
|
+
#
|
|
2919
|
+
# @return [MetronomeSDK::Models::ContractV2::RecurringCommit::ProrationRounding::Access, nil]
|
|
2920
|
+
optional :access, -> { MetronomeSDK::ContractV2::RecurringCommit::ProrationRounding::Access }
|
|
2921
|
+
|
|
2922
|
+
# @!attribute invoice
|
|
2923
|
+
#
|
|
2924
|
+
# @return [MetronomeSDK::Models::ContractV2::RecurringCommit::ProrationRounding::Invoice, nil]
|
|
2925
|
+
optional :invoice, -> { MetronomeSDK::ContractV2::RecurringCommit::ProrationRounding::Invoice }
|
|
2926
|
+
|
|
2927
|
+
# @!method initialize(access: nil, invoice: nil)
|
|
2928
|
+
# Rounding configuration for prorated recurring commit amounts.
|
|
2929
|
+
#
|
|
2930
|
+
# @param access [MetronomeSDK::Models::ContractV2::RecurringCommit::ProrationRounding::Access]
|
|
2931
|
+
# @param invoice [MetronomeSDK::Models::ContractV2::RecurringCommit::ProrationRounding::Invoice]
|
|
2932
|
+
|
|
2933
|
+
# @see MetronomeSDK::Models::ContractV2::RecurringCommit::ProrationRounding#access
|
|
2934
|
+
class Access < MetronomeSDK::Internal::Type::BaseModel
|
|
2935
|
+
# @!attribute decimal_places
|
|
2936
|
+
# Number of decimal places to round to. Applied directly to the stored monetary
|
|
2937
|
+
# representation. Negative values round to powers of 10 (e.g., -2 rounds to
|
|
2938
|
+
# nearest 100 in the stored unit).
|
|
2939
|
+
#
|
|
2940
|
+
# @return [Float]
|
|
2941
|
+
required :decimal_places, Float
|
|
2942
|
+
|
|
2943
|
+
# @!attribute rounding_method
|
|
2944
|
+
#
|
|
2945
|
+
# @return [Symbol, MetronomeSDK::Models::ContractV2::RecurringCommit::ProrationRounding::Access::RoundingMethod]
|
|
2946
|
+
required :rounding_method,
|
|
2947
|
+
enum: -> { MetronomeSDK::ContractV2::RecurringCommit::ProrationRounding::Access::RoundingMethod }
|
|
2948
|
+
|
|
2949
|
+
# @!method initialize(decimal_places:, rounding_method:)
|
|
2950
|
+
# Some parameter documentations has been truncated, see
|
|
2951
|
+
# {MetronomeSDK::Models::ContractV2::RecurringCommit::ProrationRounding::Access}
|
|
2952
|
+
# for more details.
|
|
2953
|
+
#
|
|
2954
|
+
# @param decimal_places [Float] Number of decimal places to round to. Applied directly to the stored monetary re
|
|
2955
|
+
#
|
|
2956
|
+
# @param rounding_method [Symbol, MetronomeSDK::Models::ContractV2::RecurringCommit::ProrationRounding::Access::RoundingMethod]
|
|
2957
|
+
|
|
2958
|
+
# @see MetronomeSDK::Models::ContractV2::RecurringCommit::ProrationRounding::Access#rounding_method
|
|
2959
|
+
module RoundingMethod
|
|
2960
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
2961
|
+
|
|
2962
|
+
HALF_UP = :HALF_UP
|
|
2963
|
+
FLOOR = :FLOOR
|
|
2964
|
+
CEILING = :CEILING
|
|
2965
|
+
|
|
2966
|
+
# @!method self.values
|
|
2967
|
+
# @return [Array<Symbol>]
|
|
2968
|
+
end
|
|
2969
|
+
end
|
|
2970
|
+
|
|
2971
|
+
# @see MetronomeSDK::Models::ContractV2::RecurringCommit::ProrationRounding#invoice
|
|
2972
|
+
class Invoice < MetronomeSDK::Internal::Type::BaseModel
|
|
2973
|
+
# @!attribute decimal_places
|
|
2974
|
+
# Number of decimal places to round to. Applied directly to the stored monetary
|
|
2975
|
+
# representation. Negative values round to powers of 10 (e.g., -2 rounds to
|
|
2976
|
+
# nearest 100 in the stored unit).
|
|
2977
|
+
#
|
|
2978
|
+
# @return [Float]
|
|
2979
|
+
required :decimal_places, Float
|
|
2980
|
+
|
|
2981
|
+
# @!attribute rounding_method
|
|
2982
|
+
#
|
|
2983
|
+
# @return [Symbol, MetronomeSDK::Models::ContractV2::RecurringCommit::ProrationRounding::Invoice::RoundingMethod]
|
|
2984
|
+
required :rounding_method,
|
|
2985
|
+
enum: -> { MetronomeSDK::ContractV2::RecurringCommit::ProrationRounding::Invoice::RoundingMethod }
|
|
2986
|
+
|
|
2987
|
+
# @!method initialize(decimal_places:, rounding_method:)
|
|
2988
|
+
# Some parameter documentations has been truncated, see
|
|
2989
|
+
# {MetronomeSDK::Models::ContractV2::RecurringCommit::ProrationRounding::Invoice}
|
|
2990
|
+
# for more details.
|
|
2991
|
+
#
|
|
2992
|
+
# @param decimal_places [Float] Number of decimal places to round to. Applied directly to the stored monetary re
|
|
2993
|
+
#
|
|
2994
|
+
# @param rounding_method [Symbol, MetronomeSDK::Models::ContractV2::RecurringCommit::ProrationRounding::Invoice::RoundingMethod]
|
|
2995
|
+
|
|
2996
|
+
# @see MetronomeSDK::Models::ContractV2::RecurringCommit::ProrationRounding::Invoice#rounding_method
|
|
2997
|
+
module RoundingMethod
|
|
2998
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
2999
|
+
|
|
3000
|
+
HALF_UP = :HALF_UP
|
|
3001
|
+
FLOOR = :FLOOR
|
|
3002
|
+
CEILING = :CEILING
|
|
3003
|
+
|
|
3004
|
+
# @!method self.values
|
|
3005
|
+
# @return [Array<Symbol>]
|
|
3006
|
+
end
|
|
3007
|
+
end
|
|
3008
|
+
end
|
|
3009
|
+
|
|
2881
3010
|
# The frequency at which the recurring commits will be created. If not provided: -
|
|
2882
3011
|
# The commits will be created on the usage invoice frequency. If provided: - The
|
|
2883
3012
|
# period defined in the duration will correspond to this frequency. - Commits will
|
|
@@ -2892,6 +3021,7 @@ module MetronomeSDK
|
|
|
2892
3021
|
QUARTERLY = :QUARTERLY
|
|
2893
3022
|
ANNUAL = :ANNUAL
|
|
2894
3023
|
WEEKLY = :WEEKLY
|
|
3024
|
+
DAILY = :DAILY
|
|
2895
3025
|
|
|
2896
3026
|
# @!method self.values
|
|
2897
3027
|
# @return [Array<Symbol>]
|
|
@@ -2993,6 +3123,14 @@ module MetronomeSDK
|
|
|
2993
3123
|
# @return [Symbol, MetronomeSDK::Models::ContractV2::RecurringCredit::Proration, nil]
|
|
2994
3124
|
optional :proration, enum: -> { MetronomeSDK::ContractV2::RecurringCredit::Proration }
|
|
2995
3125
|
|
|
3126
|
+
# @!attribute proration_rounding
|
|
3127
|
+
# Rounding configuration for prorated recurring credit amounts.
|
|
3128
|
+
#
|
|
3129
|
+
# @return [MetronomeSDK::Models::ContractV2::RecurringCredit::ProrationRounding, nil]
|
|
3130
|
+
optional :proration_rounding,
|
|
3131
|
+
-> { MetronomeSDK::ContractV2::RecurringCredit::ProrationRounding },
|
|
3132
|
+
nil?: true
|
|
3133
|
+
|
|
2996
3134
|
# @!attribute recurrence_frequency
|
|
2997
3135
|
# The frequency at which the recurring commits will be created. If not provided: -
|
|
2998
3136
|
# The commits will be created on the usage invoice frequency. If provided: - The
|
|
@@ -3026,7 +3164,7 @@ module MetronomeSDK
|
|
|
3026
3164
|
# @return [MetronomeSDK::Models::RecurringCommitSubscriptionConfig, nil]
|
|
3027
3165
|
optional :subscription_config, -> { MetronomeSDK::RecurringCommitSubscriptionConfig }
|
|
3028
3166
|
|
|
3029
|
-
# @!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)
|
|
3167
|
+
# @!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)
|
|
3030
3168
|
# Some parameter documentations has been truncated, see
|
|
3031
3169
|
# {MetronomeSDK::Models::ContractV2::RecurringCredit} for more details.
|
|
3032
3170
|
#
|
|
@@ -3062,6 +3200,8 @@ module MetronomeSDK
|
|
|
3062
3200
|
#
|
|
3063
3201
|
# @param proration [Symbol, MetronomeSDK::Models::ContractV2::RecurringCredit::Proration] Determines whether the first and last commit will be prorated. If not provided,
|
|
3064
3202
|
#
|
|
3203
|
+
# @param proration_rounding [MetronomeSDK::Models::ContractV2::RecurringCredit::ProrationRounding, nil] Rounding configuration for prorated recurring credit amounts.
|
|
3204
|
+
#
|
|
3065
3205
|
# @param recurrence_frequency [Symbol, MetronomeSDK::Models::ContractV2::RecurringCredit::RecurrenceFrequency] The frequency at which the recurring commits will be created. If not provided: -
|
|
3066
3206
|
#
|
|
3067
3207
|
# @param rollover_fraction [Float] Will be passed down to the individual commits. This controls how much of an indi
|
|
@@ -3181,6 +3321,57 @@ module MetronomeSDK
|
|
|
3181
3321
|
# @return [Array<Symbol>]
|
|
3182
3322
|
end
|
|
3183
3323
|
|
|
3324
|
+
# @see MetronomeSDK::Models::ContractV2::RecurringCredit#proration_rounding
|
|
3325
|
+
class ProrationRounding < MetronomeSDK::Internal::Type::BaseModel
|
|
3326
|
+
# @!attribute access
|
|
3327
|
+
#
|
|
3328
|
+
# @return [MetronomeSDK::Models::ContractV2::RecurringCredit::ProrationRounding::Access, nil]
|
|
3329
|
+
optional :access, -> { MetronomeSDK::ContractV2::RecurringCredit::ProrationRounding::Access }
|
|
3330
|
+
|
|
3331
|
+
# @!method initialize(access: nil)
|
|
3332
|
+
# Rounding configuration for prorated recurring credit amounts.
|
|
3333
|
+
#
|
|
3334
|
+
# @param access [MetronomeSDK::Models::ContractV2::RecurringCredit::ProrationRounding::Access]
|
|
3335
|
+
|
|
3336
|
+
# @see MetronomeSDK::Models::ContractV2::RecurringCredit::ProrationRounding#access
|
|
3337
|
+
class Access < MetronomeSDK::Internal::Type::BaseModel
|
|
3338
|
+
# @!attribute decimal_places
|
|
3339
|
+
# Number of decimal places to round to. Applied directly to the stored monetary
|
|
3340
|
+
# representation. Negative values round to powers of 10 (e.g., -2 rounds to
|
|
3341
|
+
# nearest 100 in the stored unit).
|
|
3342
|
+
#
|
|
3343
|
+
# @return [Float]
|
|
3344
|
+
required :decimal_places, Float
|
|
3345
|
+
|
|
3346
|
+
# @!attribute rounding_method
|
|
3347
|
+
#
|
|
3348
|
+
# @return [Symbol, MetronomeSDK::Models::ContractV2::RecurringCredit::ProrationRounding::Access::RoundingMethod]
|
|
3349
|
+
required :rounding_method,
|
|
3350
|
+
enum: -> { MetronomeSDK::ContractV2::RecurringCredit::ProrationRounding::Access::RoundingMethod }
|
|
3351
|
+
|
|
3352
|
+
# @!method initialize(decimal_places:, rounding_method:)
|
|
3353
|
+
# Some parameter documentations has been truncated, see
|
|
3354
|
+
# {MetronomeSDK::Models::ContractV2::RecurringCredit::ProrationRounding::Access}
|
|
3355
|
+
# for more details.
|
|
3356
|
+
#
|
|
3357
|
+
# @param decimal_places [Float] Number of decimal places to round to. Applied directly to the stored monetary re
|
|
3358
|
+
#
|
|
3359
|
+
# @param rounding_method [Symbol, MetronomeSDK::Models::ContractV2::RecurringCredit::ProrationRounding::Access::RoundingMethod]
|
|
3360
|
+
|
|
3361
|
+
# @see MetronomeSDK::Models::ContractV2::RecurringCredit::ProrationRounding::Access#rounding_method
|
|
3362
|
+
module RoundingMethod
|
|
3363
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
3364
|
+
|
|
3365
|
+
HALF_UP = :HALF_UP
|
|
3366
|
+
FLOOR = :FLOOR
|
|
3367
|
+
CEILING = :CEILING
|
|
3368
|
+
|
|
3369
|
+
# @!method self.values
|
|
3370
|
+
# @return [Array<Symbol>]
|
|
3371
|
+
end
|
|
3372
|
+
end
|
|
3373
|
+
end
|
|
3374
|
+
|
|
3184
3375
|
# The frequency at which the recurring commits will be created. If not provided: -
|
|
3185
3376
|
# The commits will be created on the usage invoice frequency. If provided: - The
|
|
3186
3377
|
# period defined in the duration will correspond to this frequency. - Commits will
|
|
@@ -3195,6 +3386,7 @@ module MetronomeSDK
|
|
|
3195
3386
|
QUARTERLY = :QUARTERLY
|
|
3196
3387
|
ANNUAL = :ANNUAL
|
|
3197
3388
|
WEEKLY = :WEEKLY
|
|
3389
|
+
DAILY = :DAILY
|
|
3198
3390
|
|
|
3199
3391
|
# @!method self.values
|
|
3200
3392
|
# @return [Array<Symbol>]
|
|
@@ -3527,6 +3719,11 @@ module MetronomeSDK
|
|
|
3527
3719
|
# @return [String, nil]
|
|
3528
3720
|
optional :id, String
|
|
3529
3721
|
|
|
3722
|
+
# @!attribute billing_cycle_config
|
|
3723
|
+
#
|
|
3724
|
+
# @return [MetronomeSDK::Models::ContractV2::Subscription::BillingCycleConfig, nil]
|
|
3725
|
+
optional :billing_cycle_config, -> { MetronomeSDK::ContractV2::Subscription::BillingCycleConfig }
|
|
3726
|
+
|
|
3530
3727
|
# @!attribute custom_fields
|
|
3531
3728
|
# Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
3532
3729
|
#
|
|
@@ -3558,7 +3755,7 @@ module MetronomeSDK
|
|
|
3558
3755
|
# @return [MetronomeSDK::Models::ContractV2::Subscription::SeatConfig, nil]
|
|
3559
3756
|
optional :seat_config, -> { MetronomeSDK::ContractV2::Subscription::SeatConfig }
|
|
3560
3757
|
|
|
3561
|
-
# @!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)
|
|
3758
|
+
# @!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)
|
|
3562
3759
|
# Some parameter documentations has been truncated, see
|
|
3563
3760
|
# {MetronomeSDK::Models::ContractV2::Subscription} for more details.
|
|
3564
3761
|
#
|
|
@@ -3578,6 +3775,8 @@ module MetronomeSDK
|
|
|
3578
3775
|
#
|
|
3579
3776
|
# @param id [String]
|
|
3580
3777
|
#
|
|
3778
|
+
# @param billing_cycle_config [MetronomeSDK::Models::ContractV2::Subscription::BillingCycleConfig]
|
|
3779
|
+
#
|
|
3581
3780
|
# @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
3582
3781
|
#
|
|
3583
3782
|
# @param description [String]
|
|
@@ -3694,9 +3893,15 @@ module MetronomeSDK
|
|
|
3694
3893
|
# @return [Boolean]
|
|
3695
3894
|
required :is_prorated, MetronomeSDK::Internal::Type::Boolean
|
|
3696
3895
|
|
|
3697
|
-
# @!
|
|
3896
|
+
# @!attribute rounding
|
|
3897
|
+
#
|
|
3898
|
+
# @return [MetronomeSDK::Models::ContractV2::Subscription::Proration::Rounding, nil]
|
|
3899
|
+
optional :rounding, -> { MetronomeSDK::ContractV2::Subscription::Proration::Rounding }
|
|
3900
|
+
|
|
3901
|
+
# @!method initialize(invoice_behavior:, is_prorated:, rounding: nil)
|
|
3698
3902
|
# @param invoice_behavior [Symbol, MetronomeSDK::Models::ContractV2::Subscription::Proration::InvoiceBehavior]
|
|
3699
3903
|
# @param is_prorated [Boolean]
|
|
3904
|
+
# @param rounding [MetronomeSDK::Models::ContractV2::Subscription::Proration::Rounding]
|
|
3700
3905
|
|
|
3701
3906
|
# @see MetronomeSDK::Models::ContractV2::Subscription::Proration#invoice_behavior
|
|
3702
3907
|
module InvoiceBehavior
|
|
@@ -3708,6 +3913,44 @@ module MetronomeSDK
|
|
|
3708
3913
|
# @!method self.values
|
|
3709
3914
|
# @return [Array<Symbol>]
|
|
3710
3915
|
end
|
|
3916
|
+
|
|
3917
|
+
# @see MetronomeSDK::Models::ContractV2::Subscription::Proration#rounding
|
|
3918
|
+
class Rounding < MetronomeSDK::Internal::Type::BaseModel
|
|
3919
|
+
# @!attribute decimal_places
|
|
3920
|
+
# Number of decimal places to round to. Applied directly to the stored monetary
|
|
3921
|
+
# representation. Negative values round to powers of 10 (e.g., -2 rounds to
|
|
3922
|
+
# nearest 100 in the stored unit).
|
|
3923
|
+
#
|
|
3924
|
+
# @return [Float]
|
|
3925
|
+
required :decimal_places, Float
|
|
3926
|
+
|
|
3927
|
+
# @!attribute rounding_method
|
|
3928
|
+
#
|
|
3929
|
+
# @return [Symbol, MetronomeSDK::Models::ContractV2::Subscription::Proration::Rounding::RoundingMethod]
|
|
3930
|
+
required :rounding_method,
|
|
3931
|
+
enum: -> { MetronomeSDK::ContractV2::Subscription::Proration::Rounding::RoundingMethod }
|
|
3932
|
+
|
|
3933
|
+
# @!method initialize(decimal_places:, rounding_method:)
|
|
3934
|
+
# Some parameter documentations has been truncated, see
|
|
3935
|
+
# {MetronomeSDK::Models::ContractV2::Subscription::Proration::Rounding} for more
|
|
3936
|
+
# details.
|
|
3937
|
+
#
|
|
3938
|
+
# @param decimal_places [Float] Number of decimal places to round to. Applied directly to the stored monetary re
|
|
3939
|
+
#
|
|
3940
|
+
# @param rounding_method [Symbol, MetronomeSDK::Models::ContractV2::Subscription::Proration::Rounding::RoundingMethod]
|
|
3941
|
+
|
|
3942
|
+
# @see MetronomeSDK::Models::ContractV2::Subscription::Proration::Rounding#rounding_method
|
|
3943
|
+
module RoundingMethod
|
|
3944
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
3945
|
+
|
|
3946
|
+
HALF_UP = :HALF_UP
|
|
3947
|
+
FLOOR = :FLOOR
|
|
3948
|
+
CEILING = :CEILING
|
|
3949
|
+
|
|
3950
|
+
# @!method self.values
|
|
3951
|
+
# @return [Array<Symbol>]
|
|
3952
|
+
end
|
|
3953
|
+
end
|
|
3711
3954
|
end
|
|
3712
3955
|
|
|
3713
3956
|
# Determines how the subscription's quantity is controlled. Defaults to
|
|
@@ -3801,6 +4044,46 @@ module MetronomeSDK
|
|
|
3801
4044
|
end
|
|
3802
4045
|
end
|
|
3803
4046
|
|
|
4047
|
+
# @see MetronomeSDK::Models::ContractV2::Subscription#billing_cycle_config
|
|
4048
|
+
class BillingCycleConfig < MetronomeSDK::Internal::Type::BaseModel
|
|
4049
|
+
# @!attribute anchor_date
|
|
4050
|
+
# The date this subscription's billing cycle is anchored to.
|
|
4051
|
+
#
|
|
4052
|
+
# @return [Time]
|
|
4053
|
+
required :anchor_date, Time
|
|
4054
|
+
|
|
4055
|
+
# @!attribute invoice_placement
|
|
4056
|
+
# Controls whether this subscription consolidates onto usage invoices or gets its
|
|
4057
|
+
# own scheduled invoice.
|
|
4058
|
+
#
|
|
4059
|
+
# @return [Symbol, MetronomeSDK::Models::ContractV2::Subscription::BillingCycleConfig::InvoicePlacement]
|
|
4060
|
+
required :invoice_placement,
|
|
4061
|
+
enum: -> { MetronomeSDK::ContractV2::Subscription::BillingCycleConfig::InvoicePlacement }
|
|
4062
|
+
|
|
4063
|
+
# @!method initialize(anchor_date:, invoice_placement:)
|
|
4064
|
+
# Some parameter documentations has been truncated, see
|
|
4065
|
+
# {MetronomeSDK::Models::ContractV2::Subscription::BillingCycleConfig} for more
|
|
4066
|
+
# details.
|
|
4067
|
+
#
|
|
4068
|
+
# @param anchor_date [Time] The date this subscription's billing cycle is anchored to.
|
|
4069
|
+
#
|
|
4070
|
+
# @param invoice_placement [Symbol, MetronomeSDK::Models::ContractV2::Subscription::BillingCycleConfig::InvoicePlacement] Controls whether this subscription consolidates onto usage invoices or gets its
|
|
4071
|
+
|
|
4072
|
+
# Controls whether this subscription consolidates onto usage invoices or gets its
|
|
4073
|
+
# own scheduled invoice.
|
|
4074
|
+
#
|
|
4075
|
+
# @see MetronomeSDK::Models::ContractV2::Subscription::BillingCycleConfig#invoice_placement
|
|
4076
|
+
module InvoicePlacement
|
|
4077
|
+
extend MetronomeSDK::Internal::Type::Enum
|
|
4078
|
+
|
|
4079
|
+
ON_SCHEDULED_INVOICE = :ON_SCHEDULED_INVOICE
|
|
4080
|
+
ON_USAGE_INVOICE = :ON_USAGE_INVOICE
|
|
4081
|
+
|
|
4082
|
+
# @!method self.values
|
|
4083
|
+
# @return [Array<Symbol>]
|
|
4084
|
+
end
|
|
4085
|
+
end
|
|
4086
|
+
|
|
3804
4087
|
# @see MetronomeSDK::Models::ContractV2::Subscription#seat_config
|
|
3805
4088
|
class SeatConfig < MetronomeSDK::Internal::Type::BaseModel
|
|
3806
4089
|
# @!attribute seat_group_key
|