metronome-sdk 3.9.0 → 3.10.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.
Files changed (53) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +26 -0
  3. data/README.md +1 -1
  4. data/lib/metronome_sdk/models/commit.rb +9 -1
  5. data/lib/metronome_sdk/models/contract_v2.rb +29 -12
  6. data/lib/metronome_sdk/models/contract_without_amendments.rb +8 -5
  7. data/lib/metronome_sdk/models/v1/contract_create_params.rb +8 -5
  8. data/lib/metronome_sdk/models/v1/contract_create_response.rb +8 -5
  9. data/lib/metronome_sdk/models/v1/contracts/rate_card_update_params.rb +27 -1
  10. data/lib/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rb +32 -5
  11. data/lib/metronome_sdk/models/v1/package_create_params.rb +8 -4
  12. data/lib/metronome_sdk/models/v1/package_list_response.rb +8 -4
  13. data/lib/metronome_sdk/models/v1/package_retrieve_response.rb +8 -4
  14. data/lib/metronome_sdk/models/v2/contract_edit_commit_params.rb +11 -1
  15. data/lib/metronome_sdk/models/v2/contract_edit_credit_params.rb +11 -1
  16. data/lib/metronome_sdk/models/v2/contract_edit_params.rb +12 -8
  17. data/lib/metronome_sdk/models/v2/contract_edit_response.rb +8 -4
  18. data/lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb +8 -4
  19. data/lib/metronome_sdk/resources/v1/contracts/rate_cards.rb +11 -14
  20. data/lib/metronome_sdk/resources/v1/dashboards.rb +6 -9
  21. data/lib/metronome_sdk/resources/v2/contracts.rb +6 -2
  22. data/lib/metronome_sdk/version.rb +1 -1
  23. data/rbi/metronome_sdk/models/commit.rbi +11 -0
  24. data/rbi/metronome_sdk/models/contract_v2.rbi +47 -19
  25. data/rbi/metronome_sdk/models/contract_without_amendments.rbi +12 -11
  26. data/rbi/metronome_sdk/models/v1/contract_create_params.rbi +12 -11
  27. data/rbi/metronome_sdk/models/v1/contract_create_response.rbi +12 -11
  28. data/rbi/metronome_sdk/models/v1/contracts/rate_card_update_params.rbi +67 -0
  29. data/rbi/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rbi +96 -5
  30. data/rbi/metronome_sdk/models/v1/package_create_params.rbi +12 -6
  31. data/rbi/metronome_sdk/models/v1/package_list_response.rbi +12 -6
  32. data/rbi/metronome_sdk/models/v1/package_retrieve_response.rbi +12 -6
  33. data/rbi/metronome_sdk/models/v2/contract_edit_commit_params.rbi +12 -0
  34. data/rbi/metronome_sdk/models/v2/contract_edit_credit_params.rbi +12 -0
  35. data/rbi/metronome_sdk/models/v2/contract_edit_params.rbi +18 -18
  36. data/rbi/metronome_sdk/models/v2/contract_edit_response.rbi +12 -6
  37. data/rbi/metronome_sdk/models/v2/contract_get_edit_history_response.rbi +12 -6
  38. data/rbi/metronome_sdk/resources/v1/contracts/rate_cards.rbi +15 -13
  39. data/rbi/metronome_sdk/resources/v1/dashboards.rbi +6 -9
  40. data/rbi/metronome_sdk/resources/v2/contracts.rbi +10 -0
  41. data/sig/metronome_sdk/models/commit.rbs +7 -0
  42. data/sig/metronome_sdk/models/contract_v2.rbs +16 -10
  43. data/sig/metronome_sdk/models/contract_without_amendments.rbs +1 -2
  44. data/sig/metronome_sdk/models/v1/contract_create_params.rbs +1 -2
  45. data/sig/metronome_sdk/models/v1/contract_create_response.rbs +1 -2
  46. data/sig/metronome_sdk/models/v1/contracts/rate_card_update_params.rbs +28 -0
  47. data/sig/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rbs +39 -4
  48. data/sig/metronome_sdk/models/v2/contract_edit_commit_params.rbs +5 -0
  49. data/sig/metronome_sdk/models/v2/contract_edit_credit_params.rbs +5 -0
  50. data/sig/metronome_sdk/models/v2/contract_edit_params.rbs +8 -12
  51. data/sig/metronome_sdk/resources/v1/contracts/rate_cards.rbs +1 -0
  52. data/sig/metronome_sdk/resources/v2/contracts.rbs +2 -0
  53. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 39c119482a744489b3c1edefcd46d4324302803e58581157b12915d2b8a315d6
4
- data.tar.gz: d00eb3315de54f1e47310c4fc99620c5fc6e19af7093ed61a7031ee28aeb8b3b
3
+ metadata.gz: b696954210f4bfed05c1d32c78ae7c38101e515f542781ff37cc49ef5b8aa64e
4
+ data.tar.gz: 6645acf1a6a3b40d2515f909f591ea74837837c5fcea90af965a363eb4e67e40
5
5
  SHA512:
6
- metadata.gz: f464cb8c2394d2cdf5c185c7a600f6a65e1cf9f3ec9ce5c167f47cd95cbd919a19a91e710010d612e63279f7aa83d6f1b0b5c2dfbccd3b124821510d9e10aa4b
7
- data.tar.gz: 0c8710196396104eb8b77478f95b2470f78d47b33dc722380705a926bf9f6938448cf53789464fe387804908da2f76d7b1f6ffd5097477e714ec5bb591796d07
6
+ metadata.gz: aa99380e1a02c6e89b1633b002eecd1a3f20ae850141c302ed1dda4520eef09bf3de437944db64e381a0817afa963648a2b8d53d4d91e767621972015b274a94
7
+ data.tar.gz: 5ead08a83536b93ce7b43d66964e8f132632c4a6846059a08be8e3d2f2b6af6389988a0a709af4b19d9094d902a20bd4cc28384a8a815f465fb33314c1834dac
data/CHANGELOG.md CHANGED
@@ -1,5 +1,31 @@
1
1
  # Changelog
2
2
 
3
+ ## 3.10.0 (2026-07-23)
4
+
5
+ Full Changelog: [v3.9.0...v3.10.0](https://github.com/Metronome-Industries/metronome-ruby/compare/v3.9.0...v3.10.0)
6
+
7
+ ### Features
8
+
9
+ * [ORCH-2018] fixes type issues created from breaking gql changes ([f21c903](https://github.com/Metronome-Industries/metronome-ruby/commit/f21c90353a4ad56440c447b713624df8b1583f3f))
10
+ * Add add_credit_type_conversions field to update_rate_card ([f9d1ca5](https://github.com/Metronome-Industries/metronome-ruby/commit/f9d1ca5a365285e27b63f89a1720e98e2685f3e4))
11
+ * Add cost_basis to commits ([276ba9b](https://github.com/Metronome-Industries/metronome-ruby/commit/276ba9b96f7784fa142a6ed5caf1fbe9edf32df5))
12
+ * Add daily recurring commit description to docs ([22ce79a](https://github.com/Metronome-Industries/metronome-ruby/commit/22ce79af31f1e1585ee16d53ea8103e23b9141ee))
13
+ * add stlc SDK generation workflow to api repo ([fe49163](https://github.com/Metronome-Industries/metronome-ruby/commit/fe49163f7be32e3eb9248c19b77d8d73a9c53687))
14
+ * Docs: embeddable dashboard doc updates ([6cdc3fb](https://github.com/Metronome-Industries/metronome-ruby/commit/6cdc3fbb56a486febbcb27b6c40b2169b965df93))
15
+ * Kmd/remove supersede from contract transition ([260c042](https://github.com/Metronome-Industries/metronome-ruby/commit/260c042cf1c63a78a9eb4687b78d11c07544af45))
16
+ * Plumb applicable_contract_ids in edit customer commit ([b35217d](https://github.com/Metronome-Industries/metronome-ruby/commit/b35217d2002003b7bbe3432a3bc2bcff3599999f))
17
+ * **stlc:** configurable CI runner and private-production-repo support in workflow templates ([702930f](https://github.com/Metronome-Industries/metronome-ruby/commit/702930fbea60e526f6bdbd68bc1d3fceb7c1355b))
18
+
19
+
20
+ ### Bug Fixes
21
+
22
+ * remove webhook config that overwrites custom code ([d015d08](https://github.com/Metronome-Industries/metronome-ruby/commit/d015d08d5b3b8279626635a9e4136cce74fc5bbb))
23
+
24
+
25
+ ### Chores
26
+
27
+ * update tracking files for promote workflow ([3b6573c](https://github.com/Metronome-Industries/metronome-ruby/commit/3b6573c4116bbe414677ac23afa186ad5f106b40))
28
+
3
29
  ## 3.9.0 (2026-07-02)
4
30
 
5
31
  Full Changelog: [v3.8.0...v3.9.0](https://github.com/Metronome-Industries/metronome-ruby/compare/v3.8.0...v3.9.0)
data/README.md CHANGED
@@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application
26
26
  <!-- x-release-please-start-version -->
27
27
 
28
28
  ```ruby
29
- gem "metronome-sdk", "~> 3.9.0"
29
+ gem "metronome-sdk", "~> 3.10.0"
30
30
  ```
31
31
 
32
32
  <!-- x-release-please-end -->
@@ -81,6 +81,12 @@ module MetronomeSDK
81
81
  # @return [MetronomeSDK::Models::Commit::Contract, nil]
82
82
  optional :contract, -> { MetronomeSDK::Commit::Contract }
83
83
 
84
+ # @!attribute cost_basis
85
+ # The ratio of the amount paid for the commit to the amount of credit granted.
86
+ #
87
+ # @return [Float, nil]
88
+ optional :cost_basis, Float
89
+
84
90
  # @!attribute created_by
85
91
  # The actor who created this commit. Omitted for system-generated commits such as
86
92
  # recurring commits, rollover commits, and threshold commits.
@@ -200,7 +206,7 @@ module MetronomeSDK
200
206
  # @return [String, nil]
201
207
  optional :uniqueness_key, String
202
208
 
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)
209
+ # @!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, cost_basis: 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)
204
210
  # Some parameter documentations has been truncated, see
205
211
  # {MetronomeSDK::Models::Commit} for more details.
206
212
  #
@@ -228,6 +234,8 @@ module MetronomeSDK
228
234
  #
229
235
  # @param contract [MetronomeSDK::Models::Commit::Contract]
230
236
  #
237
+ # @param cost_basis [Float] The ratio of the amount paid for the commit to the amount of credit granted.
238
+ #
231
239
  # @param created_by [String] The actor who created this commit. Omitted for system-generated commits such as
232
240
  #
233
241
  # @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
@@ -390,6 +390,12 @@ module MetronomeSDK
390
390
  # @return [MetronomeSDK::Models::ContractV2::Commit::Contract, nil]
391
391
  optional :contract, -> { MetronomeSDK::ContractV2::Commit::Contract }
392
392
 
393
+ # @!attribute cost_basis
394
+ # The ratio of the amount paid for the commit to the amount of credit granted.
395
+ #
396
+ # @return [Float, nil]
397
+ optional :cost_basis, Float
398
+
393
399
  # @!attribute created_by
394
400
  # The actor who created this commit. Omitted for system-generated commits such as
395
401
  # recurring commits, rollover commits, and threshold commits.
@@ -499,7 +505,7 @@ module MetronomeSDK
499
505
  # @return [MetronomeSDK::Models::RecurringCommitSubscriptionConfig, nil]
500
506
  optional :subscription_config, -> { MetronomeSDK::RecurringCommitSubscriptionConfig }
501
507
 
502
- # @!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)
508
+ # @!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, cost_basis: 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)
503
509
  # Some parameter documentations has been truncated, see
504
510
  # {MetronomeSDK::Models::ContractV2::Commit} for more details.
505
511
  #
@@ -525,6 +531,8 @@ module MetronomeSDK
525
531
  #
526
532
  # @param contract [MetronomeSDK::Models::ContractV2::Commit::Contract]
527
533
  #
534
+ # @param cost_basis [Float] The ratio of the amount paid for the commit to the amount of credit granted.
535
+ #
528
536
  # @param created_by [String] The actor who created this commit. Omitted for system-generated commits such as
529
537
  #
530
538
  # @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
@@ -1601,7 +1609,6 @@ module MetronomeSDK
1601
1609
  module Type
1602
1610
  extend MetronomeSDK::Internal::Type::Enum
1603
1611
 
1604
- SUPERSEDE = :SUPERSEDE
1605
1612
  RENEWAL = :RENEWAL
1606
1613
 
1607
1614
  # @!method self.values
@@ -1682,9 +1689,12 @@ module MetronomeSDK
1682
1689
  class BillingProviderConfigurationSchedule < MetronomeSDK::Internal::Type::BaseModel
1683
1690
  # @!attribute billing_provider_configuration
1684
1691
  #
1685
- # @return [MetronomeSDK::Models::ContractV2::BillingProviderConfigurationSchedule::BillingProviderConfiguration]
1692
+ # @return [MetronomeSDK::Models::ContractV2::BillingProviderConfigurationSchedule::BillingProviderConfiguration, nil]
1686
1693
  required :billing_provider_configuration,
1687
- -> { MetronomeSDK::ContractV2::BillingProviderConfigurationSchedule::BillingProviderConfiguration }
1694
+ -> {
1695
+ MetronomeSDK::ContractV2::BillingProviderConfigurationSchedule::BillingProviderConfiguration
1696
+ },
1697
+ nil?: true
1688
1698
 
1689
1699
  # @!attribute effective_at
1690
1700
  # The date this billing provider configuration became or becomes active.
@@ -1704,7 +1714,7 @@ module MetronomeSDK
1704
1714
  # {MetronomeSDK::Models::ContractV2::BillingProviderConfigurationSchedule} for
1705
1715
  # more details.
1706
1716
  #
1707
- # @param billing_provider_configuration [MetronomeSDK::Models::ContractV2::BillingProviderConfigurationSchedule::BillingProviderConfiguration]
1717
+ # @param billing_provider_configuration [MetronomeSDK::Models::ContractV2::BillingProviderConfigurationSchedule::BillingProviderConfiguration, nil]
1708
1718
  #
1709
1719
  # @param effective_at [Time] The date this billing provider configuration became or becomes active.
1710
1720
  #
@@ -2912,7 +2922,8 @@ module MetronomeSDK
2912
2922
  # The commits will be created on the usage invoice frequency. If provided: - The
2913
2923
  # period defined in the duration will correspond to this frequency. - Commits will
2914
2924
  # be created aligned with the recurring commit's starting_at rather than the usage
2915
- # invoice dates.
2925
+ # invoice dates. - Daily recurring commits have a limit of one per contract, and
2926
+ # are unable to be created with seat-based subscriptions
2916
2927
  #
2917
2928
  # @return [Symbol, MetronomeSDK::Models::ContractV2::RecurringCommit::RecurrenceFrequency, nil]
2918
2929
  optional :recurrence_frequency,
@@ -3223,7 +3234,8 @@ module MetronomeSDK
3223
3234
  # The commits will be created on the usage invoice frequency. If provided: - The
3224
3235
  # period defined in the duration will correspond to this frequency. - Commits will
3225
3236
  # be created aligned with the recurring commit's starting_at rather than the usage
3226
- # invoice dates.
3237
+ # invoice dates. - Daily recurring commits have a limit of one per contract, and
3238
+ # are unable to be created with seat-based subscriptions
3227
3239
  #
3228
3240
  # @see MetronomeSDK::Models::ContractV2::RecurringCommit#recurrence_frequency
3229
3241
  module RecurrenceFrequency
@@ -3348,7 +3360,8 @@ module MetronomeSDK
3348
3360
  # The commits will be created on the usage invoice frequency. If provided: - The
3349
3361
  # period defined in the duration will correspond to this frequency. - Commits will
3350
3362
  # be created aligned with the recurring commit's starting_at rather than the usage
3351
- # invoice dates.
3363
+ # invoice dates. - Daily recurring commits have a limit of one per contract, and
3364
+ # are unable to be created with seat-based subscriptions
3352
3365
  #
3353
3366
  # @return [Symbol, MetronomeSDK::Models::ContractV2::RecurringCredit::RecurrenceFrequency, nil]
3354
3367
  optional :recurrence_frequency,
@@ -3588,7 +3601,8 @@ module MetronomeSDK
3588
3601
  # The commits will be created on the usage invoice frequency. If provided: - The
3589
3602
  # period defined in the duration will correspond to this frequency. - Commits will
3590
3603
  # be created aligned with the recurring commit's starting_at rather than the usage
3591
- # invoice dates.
3604
+ # invoice dates. - Daily recurring commits have a limit of one per contract, and
3605
+ # are unable to be created with seat-based subscriptions
3592
3606
  #
3593
3607
  # @see MetronomeSDK::Models::ContractV2::RecurringCredit#recurrence_frequency
3594
3608
  module RecurrenceFrequency
@@ -3739,9 +3753,12 @@ module MetronomeSDK
3739
3753
 
3740
3754
  # @!attribute revenue_system_configuration
3741
3755
  #
3742
- # @return [MetronomeSDK::Models::ContractV2::RevenueSystemConfigurationSchedule::RevenueSystemConfiguration]
3756
+ # @return [MetronomeSDK::Models::ContractV2::RevenueSystemConfigurationSchedule::RevenueSystemConfiguration, nil]
3743
3757
  required :revenue_system_configuration,
3744
- -> { MetronomeSDK::ContractV2::RevenueSystemConfigurationSchedule::RevenueSystemConfiguration }
3758
+ -> {
3759
+ MetronomeSDK::ContractV2::RevenueSystemConfigurationSchedule::RevenueSystemConfiguration
3760
+ },
3761
+ nil?: true
3745
3762
 
3746
3763
  # @!attribute effective_until
3747
3764
  # The date this revenue system configuration is superseded by the next entry. Null
@@ -3757,7 +3774,7 @@ module MetronomeSDK
3757
3774
  #
3758
3775
  # @param effective_at [Time] The date this revenue system configuration became or becomes active.
3759
3776
  #
3760
- # @param revenue_system_configuration [MetronomeSDK::Models::ContractV2::RevenueSystemConfigurationSchedule::RevenueSystemConfiguration]
3777
+ # @param revenue_system_configuration [MetronomeSDK::Models::ContractV2::RevenueSystemConfigurationSchedule::RevenueSystemConfiguration, nil]
3761
3778
  #
3762
3779
  # @param effective_until [Time] The date this revenue system configuration is superseded by the next entry. Null
3763
3780
 
@@ -242,7 +242,6 @@ module MetronomeSDK
242
242
  module Type
243
243
  extend MetronomeSDK::Internal::Type::Enum
244
244
 
245
- SUPERSEDE = :SUPERSEDE
246
245
  RENEWAL = :RENEWAL
247
246
 
248
247
  # @!method self.values
@@ -397,7 +396,8 @@ module MetronomeSDK
397
396
  # The commits will be created on the usage invoice frequency. If provided: - The
398
397
  # period defined in the duration will correspond to this frequency. - Commits will
399
398
  # be created aligned with the recurring commit's starting_at rather than the usage
400
- # invoice dates.
399
+ # invoice dates. - Daily recurring commits have a limit of one per contract, and
400
+ # are unable to be created with seat-based subscriptions
401
401
  #
402
402
  # @return [Symbol, MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::RecurrenceFrequency, nil]
403
403
  optional :recurrence_frequency,
@@ -714,7 +714,8 @@ module MetronomeSDK
714
714
  # The commits will be created on the usage invoice frequency. If provided: - The
715
715
  # period defined in the duration will correspond to this frequency. - Commits will
716
716
  # be created aligned with the recurring commit's starting_at rather than the usage
717
- # invoice dates.
717
+ # invoice dates. - Daily recurring commits have a limit of one per contract, and
718
+ # are unable to be created with seat-based subscriptions
718
719
  #
719
720
  # @see MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit#recurrence_frequency
720
721
  module RecurrenceFrequency
@@ -839,7 +840,8 @@ module MetronomeSDK
839
840
  # The commits will be created on the usage invoice frequency. If provided: - The
840
841
  # period defined in the duration will correspond to this frequency. - Commits will
841
842
  # be created aligned with the recurring commit's starting_at rather than the usage
842
- # invoice dates.
843
+ # invoice dates. - Daily recurring commits have a limit of one per contract, and
844
+ # are unable to be created with seat-based subscriptions
843
845
  #
844
846
  # @return [Symbol, MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::RecurrenceFrequency, nil]
845
847
  optional :recurrence_frequency,
@@ -1083,7 +1085,8 @@ module MetronomeSDK
1083
1085
  # The commits will be created on the usage invoice frequency. If provided: - The
1084
1086
  # period defined in the duration will correspond to this frequency. - Commits will
1085
1087
  # be created aligned with the recurring commit's starting_at rather than the usage
1086
- # invoice dates.
1088
+ # invoice dates. - Daily recurring commits have a limit of one per contract, and
1089
+ # are unable to be created with seat-based subscriptions
1087
1090
  #
1088
1091
  # @see MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit#recurrence_frequency
1089
1092
  module RecurrenceFrequency
@@ -1910,7 +1910,8 @@ module MetronomeSDK
1910
1910
  # The commits will be created on the usage invoice frequency. If provided: - The
1911
1911
  # period defined in the duration will correspond to this frequency. - Commits will
1912
1912
  # be created aligned with the recurring commit's starting_at rather than the usage
1913
- # invoice dates.
1913
+ # invoice dates. - Daily recurring commits have a limit of one per contract, and
1914
+ # are unable to be created with seat-based subscriptions
1914
1915
  #
1915
1916
  # @return [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit::RecurrenceFrequency, nil]
1916
1917
  optional :recurrence_frequency,
@@ -2215,7 +2216,8 @@ module MetronomeSDK
2215
2216
  # The commits will be created on the usage invoice frequency. If provided: - The
2216
2217
  # period defined in the duration will correspond to this frequency. - Commits will
2217
2218
  # be created aligned with the recurring commit's starting_at rather than the usage
2218
- # invoice dates.
2219
+ # invoice dates. - Daily recurring commits have a limit of one per contract, and
2220
+ # are unable to be created with seat-based subscriptions
2219
2221
  #
2220
2222
  # @see MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit#recurrence_frequency
2221
2223
  module RecurrenceFrequency
@@ -2393,7 +2395,8 @@ module MetronomeSDK
2393
2395
  # The commits will be created on the usage invoice frequency. If provided: - The
2394
2396
  # period defined in the duration will correspond to this frequency. - Commits will
2395
2397
  # be created aligned with the recurring commit's starting_at rather than the usage
2396
- # invoice dates.
2398
+ # invoice dates. - Daily recurring commits have a limit of one per contract, and
2399
+ # are unable to be created with seat-based subscriptions
2397
2400
  #
2398
2401
  # @return [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit::RecurrenceFrequency, nil]
2399
2402
  optional :recurrence_frequency,
@@ -2625,7 +2628,8 @@ module MetronomeSDK
2625
2628
  # The commits will be created on the usage invoice frequency. If provided: - The
2626
2629
  # period defined in the duration will correspond to this frequency. - Commits will
2627
2630
  # be created aligned with the recurring commit's starting_at rather than the usage
2628
- # invoice dates.
2631
+ # invoice dates. - Daily recurring commits have a limit of one per contract, and
2632
+ # are unable to be created with seat-based subscriptions
2629
2633
  #
2630
2634
  # @see MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit#recurrence_frequency
2631
2635
  module RecurrenceFrequency
@@ -3645,7 +3649,6 @@ module MetronomeSDK
3645
3649
  module Type
3646
3650
  extend MetronomeSDK::Internal::Type::Enum
3647
3651
 
3648
- SUPERSEDE = :SUPERSEDE
3649
3652
  RENEWAL = :RENEWAL
3650
3653
 
3651
3654
  # @!method self.values
@@ -295,7 +295,6 @@ module MetronomeSDK
295
295
  module Type
296
296
  extend MetronomeSDK::Internal::Type::Enum
297
297
 
298
- SUPERSEDE = :SUPERSEDE
299
298
  RENEWAL = :RENEWAL
300
299
 
301
300
  # @!method self.values
@@ -643,7 +642,8 @@ module MetronomeSDK
643
642
  # The commits will be created on the usage invoice frequency. If provided: - The
644
643
  # period defined in the duration will correspond to this frequency. - Commits will
645
644
  # be created aligned with the recurring commit's starting_at rather than the usage
646
- # invoice dates.
645
+ # invoice dates. - Daily recurring commits have a limit of one per contract, and
646
+ # are unable to be created with seat-based subscriptions
647
647
  #
648
648
  # @return [Symbol, MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::RecurringCommit::RecurrenceFrequency, nil]
649
649
  optional :recurrence_frequency,
@@ -960,7 +960,8 @@ module MetronomeSDK
960
960
  # The commits will be created on the usage invoice frequency. If provided: - The
961
961
  # period defined in the duration will correspond to this frequency. - Commits will
962
962
  # be created aligned with the recurring commit's starting_at rather than the usage
963
- # invoice dates.
963
+ # invoice dates. - Daily recurring commits have a limit of one per contract, and
964
+ # are unable to be created with seat-based subscriptions
964
965
  #
965
966
  # @see MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::RecurringCommit#recurrence_frequency
966
967
  module RecurrenceFrequency
@@ -1091,7 +1092,8 @@ module MetronomeSDK
1091
1092
  # The commits will be created on the usage invoice frequency. If provided: - The
1092
1093
  # period defined in the duration will correspond to this frequency. - Commits will
1093
1094
  # be created aligned with the recurring commit's starting_at rather than the usage
1094
- # invoice dates.
1095
+ # invoice dates. - Daily recurring commits have a limit of one per contract, and
1096
+ # are unable to be created with seat-based subscriptions
1095
1097
  #
1096
1098
  # @return [Symbol, MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::RecurringCredit::RecurrenceFrequency, nil]
1097
1099
  optional :recurrence_frequency,
@@ -1335,7 +1337,8 @@ module MetronomeSDK
1335
1337
  # The commits will be created on the usage invoice frequency. If provided: - The
1336
1338
  # period defined in the duration will correspond to this frequency. - Commits will
1337
1339
  # be created aligned with the recurring commit's starting_at rather than the usage
1338
- # invoice dates.
1340
+ # invoice dates. - Daily recurring commits have a limit of one per contract, and
1341
+ # are unable to be created with seat-based subscriptions
1339
1342
  #
1340
1343
  # @see MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::RecurringCredit#recurrence_frequency
1341
1344
  module RecurrenceFrequency
@@ -15,6 +15,14 @@ module MetronomeSDK
15
15
  # @return [String]
16
16
  required :rate_card_id, String
17
17
 
18
+ # @!attribute add_credit_type_conversions
19
+ # Add credit type conversions for using custom pricing units in rates. Existing
20
+ # conversions cannot be modified.
21
+ #
22
+ # @return [Array<MetronomeSDK::Models::V1::Contracts::RateCardUpdateParams::AddCreditTypeConversion>, nil]
23
+ optional :add_credit_type_conversions,
24
+ -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Contracts::RateCardUpdateParams::AddCreditTypeConversion] }
25
+
18
26
  # @!attribute aliases
19
27
  # Reference this alias when creating a contract. If the same alias is assigned to
20
28
  # multiple rate cards, it will reference the rate card to which it was most
@@ -35,12 +43,14 @@ module MetronomeSDK
35
43
  # @return [String, nil]
36
44
  optional :name, String
37
45
 
38
- # @!method initialize(rate_card_id:, aliases: nil, description: nil, name: nil, request_options: {})
46
+ # @!method initialize(rate_card_id:, add_credit_type_conversions: nil, aliases: nil, description: nil, name: nil, request_options: {})
39
47
  # Some parameter documentations has been truncated, see
40
48
  # {MetronomeSDK::Models::V1::Contracts::RateCardUpdateParams} for more details.
41
49
  #
42
50
  # @param rate_card_id [String] ID of the rate card to update
43
51
  #
52
+ # @param add_credit_type_conversions [Array<MetronomeSDK::Models::V1::Contracts::RateCardUpdateParams::AddCreditTypeConversion>] Add credit type conversions for using custom pricing units in rates. Existing co
53
+ #
44
54
  # @param aliases [Array<MetronomeSDK::Models::V1::Contracts::RateCardUpdateParams::Alias>] Reference this alias when creating a contract. If the same alias is assigned to
45
55
  #
46
56
  # @param description [String]
@@ -49,6 +59,22 @@ module MetronomeSDK
49
59
  #
50
60
  # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
51
61
 
62
+ class AddCreditTypeConversion < MetronomeSDK::Internal::Type::BaseModel
63
+ # @!attribute custom_credit_type_id
64
+ #
65
+ # @return [String]
66
+ required :custom_credit_type_id, String
67
+
68
+ # @!attribute fiat_per_custom_credit
69
+ #
70
+ # @return [Float]
71
+ required :fiat_per_custom_credit, Float
72
+
73
+ # @!method initialize(custom_credit_type_id:, fiat_per_custom_credit:)
74
+ # @param custom_credit_type_id [String]
75
+ # @param fiat_per_custom_credit [Float]
76
+ end
77
+
52
78
  class Alias < MetronomeSDK::Internal::Type::BaseModel
53
79
  # @!attribute name
54
80
  #
@@ -155,19 +155,46 @@ module MetronomeSDK
155
155
  # @!attribute key
156
156
  # The option key name
157
157
  #
158
- # @return [String]
159
- required :key, String
158
+ # @return [Symbol, MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::DashboardOption::Key]
159
+ required :key, enum: -> { MetronomeSDK::V1::DashboardGetEmbeddableURLParams::DashboardOption::Key }
160
160
 
161
161
  # @!attribute value
162
- # The option value
162
+ # The option value. For show_zero_usage_line_items: "true" or "false" (default
163
+ # "false"). For contract_id: a UUID filtering invoices to a specific contract. For
164
+ # invoice_type: "USAGE" or "SCHEDULED". For invoice_status_filter: "VOID",
165
+ # "FINALIZED", "DRAFT", "FINALIZED_AND_DRAFT", or "ALL". For hide_voided_invoices
166
+ # (deprecated): "true" or "false".
163
167
  #
164
168
  # @return [String]
165
169
  required :value, String
166
170
 
167
171
  # @!method initialize(key:, value:)
168
- # @param key [String] The option key name
172
+ # Some parameter documentations has been truncated, see
173
+ # {MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::DashboardOption} for
174
+ # more details.
175
+ #
176
+ # @param key [Symbol, MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::DashboardOption::Key] The option key name
169
177
  #
170
- # @param value [String] The option value
178
+ # @param value [String] The option value. For show_zero_usage_line_items: "true" or "false" (default "fa
179
+
180
+ # The option key name
181
+ #
182
+ # @see MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::DashboardOption#key
183
+ module Key
184
+ extend MetronomeSDK::Internal::Type::Enum
185
+
186
+ SHOW_ZERO_USAGE_LINE_ITEMS = :show_zero_usage_line_items
187
+ CONTRACT_ID = :contract_id
188
+ INVOICE_TYPE = :invoice_type
189
+ INVOICE_STATUS_FILTER = :invoice_status_filter
190
+ HIDE_VOIDED_INVOICES = :hide_voided_invoices
191
+ BILLABLE_STATUS_FILTER = :billable_status_filter
192
+ HIDE_GRANT_NAME = :hide_grant_name
193
+ CREDIT_LEDGER_CREDIT_TYPE_ID = :credit_ledger_credit_type_id
194
+
195
+ # @!method self.values
196
+ # @return [Array<Symbol>]
197
+ end
171
198
  end
172
199
  end
173
200
  end
@@ -1385,7 +1385,8 @@ module MetronomeSDK
1385
1385
  # The commits will be created on the usage invoice frequency. If provided: - The
1386
1386
  # period defined in the duration will correspond to this frequency. - Commits will
1387
1387
  # be created aligned with the recurring commit's starting_at rather than the usage
1388
- # invoice dates.
1388
+ # invoice dates. - Daily recurring commits have a limit of one per contract, and
1389
+ # are unable to be created with seat-based subscriptions
1389
1390
  #
1390
1391
  # @return [Symbol, MetronomeSDK::Models::V1::PackageCreateParams::RecurringCommit::RecurrenceFrequency, nil]
1391
1392
  optional :recurrence_frequency,
@@ -1752,7 +1753,8 @@ module MetronomeSDK
1752
1753
  # The commits will be created on the usage invoice frequency. If provided: - The
1753
1754
  # period defined in the duration will correspond to this frequency. - Commits will
1754
1755
  # be created aligned with the recurring commit's starting_at rather than the usage
1755
- # invoice dates.
1756
+ # invoice dates. - Daily recurring commits have a limit of one per contract, and
1757
+ # are unable to be created with seat-based subscriptions
1756
1758
  #
1757
1759
  # @see MetronomeSDK::Models::V1::PackageCreateParams::RecurringCommit#recurrence_frequency
1758
1760
  module RecurrenceFrequency
@@ -1921,7 +1923,8 @@ module MetronomeSDK
1921
1923
  # The commits will be created on the usage invoice frequency. If provided: - The
1922
1924
  # period defined in the duration will correspond to this frequency. - Commits will
1923
1925
  # be created aligned with the recurring commit's starting_at rather than the usage
1924
- # invoice dates.
1926
+ # invoice dates. - Daily recurring commits have a limit of one per contract, and
1927
+ # are unable to be created with seat-based subscriptions
1925
1928
  #
1926
1929
  # @return [Symbol, MetronomeSDK::Models::V1::PackageCreateParams::RecurringCredit::RecurrenceFrequency, nil]
1927
1930
  optional :recurrence_frequency,
@@ -2215,7 +2218,8 @@ module MetronomeSDK
2215
2218
  # The commits will be created on the usage invoice frequency. If provided: - The
2216
2219
  # period defined in the duration will correspond to this frequency. - Commits will
2217
2220
  # be created aligned with the recurring commit's starting_at rather than the usage
2218
- # invoice dates.
2221
+ # invoice dates. - Daily recurring commits have a limit of one per contract, and
2222
+ # are unable to be created with seat-based subscriptions
2219
2223
  #
2220
2224
  # @see MetronomeSDK::Models::V1::PackageCreateParams::RecurringCredit#recurrence_frequency
2221
2225
  module RecurrenceFrequency
@@ -1436,7 +1436,8 @@ module MetronomeSDK
1436
1436
  # The commits will be created on the usage invoice frequency. If provided: - The
1437
1437
  # period defined in the duration will correspond to this frequency. - Commits will
1438
1438
  # be created aligned with the recurring commit's starting_at rather than the usage
1439
- # invoice dates.
1439
+ # invoice dates. - Daily recurring commits have a limit of one per contract, and
1440
+ # are unable to be created with seat-based subscriptions
1440
1441
  #
1441
1442
  # @return [Symbol, MetronomeSDK::Models::V1::PackageListResponse::RecurringCommit::RecurrenceFrequency, nil]
1442
1443
  optional :recurrence_frequency,
@@ -1805,7 +1806,8 @@ module MetronomeSDK
1805
1806
  # The commits will be created on the usage invoice frequency. If provided: - The
1806
1807
  # period defined in the duration will correspond to this frequency. - Commits will
1807
1808
  # be created aligned with the recurring commit's starting_at rather than the usage
1808
- # invoice dates.
1809
+ # invoice dates. - Daily recurring commits have a limit of one per contract, and
1810
+ # are unable to be created with seat-based subscriptions
1809
1811
  #
1810
1812
  # @see MetronomeSDK::Models::V1::PackageListResponse::RecurringCommit#recurrence_frequency
1811
1813
  module RecurrenceFrequency
@@ -1966,7 +1968,8 @@ module MetronomeSDK
1966
1968
  # The commits will be created on the usage invoice frequency. If provided: - The
1967
1969
  # period defined in the duration will correspond to this frequency. - Commits will
1968
1970
  # be created aligned with the recurring commit's starting_at rather than the usage
1969
- # invoice dates.
1971
+ # invoice dates. - Daily recurring commits have a limit of one per contract, and
1972
+ # are unable to be created with seat-based subscriptions
1970
1973
  #
1971
1974
  # @return [Symbol, MetronomeSDK::Models::V1::PackageListResponse::RecurringCredit::RecurrenceFrequency, nil]
1972
1975
  optional :recurrence_frequency,
@@ -2262,7 +2265,8 @@ module MetronomeSDK
2262
2265
  # The commits will be created on the usage invoice frequency. If provided: - The
2263
2266
  # period defined in the duration will correspond to this frequency. - Commits will
2264
2267
  # be created aligned with the recurring commit's starting_at rather than the usage
2265
- # invoice dates.
2268
+ # invoice dates. - Daily recurring commits have a limit of one per contract, and
2269
+ # are unable to be created with seat-based subscriptions
2266
2270
  #
2267
2271
  # @see MetronomeSDK::Models::V1::PackageListResponse::RecurringCredit#recurrence_frequency
2268
2272
  module RecurrenceFrequency
@@ -1462,7 +1462,8 @@ module MetronomeSDK
1462
1462
  # The commits will be created on the usage invoice frequency. If provided: - The
1463
1463
  # period defined in the duration will correspond to this frequency. - Commits will
1464
1464
  # be created aligned with the recurring commit's starting_at rather than the usage
1465
- # invoice dates.
1465
+ # invoice dates. - Daily recurring commits have a limit of one per contract, and
1466
+ # are unable to be created with seat-based subscriptions
1466
1467
  #
1467
1468
  # @return [Symbol, MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCommit::RecurrenceFrequency, nil]
1468
1469
  optional :recurrence_frequency,
@@ -1831,7 +1832,8 @@ module MetronomeSDK
1831
1832
  # The commits will be created on the usage invoice frequency. If provided: - The
1832
1833
  # period defined in the duration will correspond to this frequency. - Commits will
1833
1834
  # be created aligned with the recurring commit's starting_at rather than the usage
1834
- # invoice dates.
1835
+ # invoice dates. - Daily recurring commits have a limit of one per contract, and
1836
+ # are unable to be created with seat-based subscriptions
1835
1837
  #
1836
1838
  # @see MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCommit#recurrence_frequency
1837
1839
  module RecurrenceFrequency
@@ -1995,7 +1997,8 @@ module MetronomeSDK
1995
1997
  # The commits will be created on the usage invoice frequency. If provided: - The
1996
1998
  # period defined in the duration will correspond to this frequency. - Commits will
1997
1999
  # be created aligned with the recurring commit's starting_at rather than the usage
1998
- # invoice dates.
2000
+ # invoice dates. - Daily recurring commits have a limit of one per contract, and
2001
+ # are unable to be created with seat-based subscriptions
1999
2002
  #
2000
2003
  # @return [Symbol, MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::RecurrenceFrequency, nil]
2001
2004
  optional :recurrence_frequency,
@@ -2291,7 +2294,8 @@ module MetronomeSDK
2291
2294
  # The commits will be created on the usage invoice frequency. If provided: - The
2292
2295
  # period defined in the duration will correspond to this frequency. - Commits will
2293
2296
  # be created aligned with the recurring commit's starting_at rather than the usage
2294
- # invoice dates.
2297
+ # invoice dates. - Daily recurring commits have a limit of one per contract, and
2298
+ # are unable to be created with seat-based subscriptions
2295
2299
  #
2296
2300
  # @see MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit#recurrence_frequency
2297
2301
  module RecurrenceFrequency
@@ -25,6 +25,14 @@ module MetronomeSDK
25
25
  # @return [MetronomeSDK::Models::V2::ContractEditCommitParams::AccessSchedule, nil]
26
26
  optional :access_schedule, -> { MetronomeSDK::V2::ContractEditCommitParams::AccessSchedule }
27
27
 
28
+ # @!attribute applicable_contract_ids
29
+ # Which contracts the customer-level commit applies to. If set to null, the commit
30
+ # applies to all of the customer's contracts. This field cannot be edited for
31
+ # POSTPAID commits or contract-level commits.
32
+ #
33
+ # @return [Array<String>, nil]
34
+ optional :applicable_contract_ids, MetronomeSDK::Internal::Type::ArrayOf[String], nil?: true
35
+
28
36
  # @!attribute applicable_product_ids
29
37
  # Which products the commit applies to. If applicable_product_ids,
30
38
  # applicable_product_tags or specifiers are not provided, the commit applies to
@@ -103,7 +111,7 @@ module MetronomeSDK
103
111
  -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifierInput] },
104
112
  nil?: true
105
113
 
106
- # @!method initialize(commit_id:, customer_id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, description: nil, hierarchy_configuration: nil, invoice_contract_id: nil, invoice_schedule: nil, name: nil, priority: nil, product_id: nil, rate_type: nil, specifiers: nil, request_options: {})
114
+ # @!method initialize(commit_id:, customer_id:, access_schedule: nil, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, description: nil, hierarchy_configuration: nil, invoice_contract_id: nil, invoice_schedule: nil, name: nil, priority: nil, product_id: nil, rate_type: nil, specifiers: nil, request_options: {})
107
115
  # Some parameter documentations has been truncated, see
108
116
  # {MetronomeSDK::Models::V2::ContractEditCommitParams} for more details.
109
117
  #
@@ -113,6 +121,8 @@ module MetronomeSDK
113
121
  #
114
122
  # @param access_schedule [MetronomeSDK::Models::V2::ContractEditCommitParams::AccessSchedule]
115
123
  #
124
+ # @param applicable_contract_ids [Array<String>, nil] Which contracts the customer-level commit applies to. If set to null, the commit
125
+ #
116
126
  # @param applicable_product_ids [Array<String>, nil] Which products the commit applies to. If applicable_product_ids, applicable_prod
117
127
  #
118
128
  # @param applicable_product_tags [Array<String>, nil] Which tags the commit applies to. If applicable*product_ids, applicable_product*