metronome-sdk 2.2.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24c53b426a786c58cd7f8d4ae93526596c3a4fa93b6b662e5de17309317f36e5
-  data.tar.gz: 1409a92e54deccc0ae37945c293b208cf27149114eae2509af99fe87a4584ece
+  metadata.gz: a988182a5b3f8a91e63e06cc9ed209042ea94b2b5d93b70767ea7b1af2509e65
+  data.tar.gz: 54b423b7428e7994d37133d36b0357032f84db951abe9bb5bb5f424c40247241
 SHA512:
-  metadata.gz: 7472b69ef8d4e84138a0b0818d3cf770268065044819e86804727fc00dc92c66b4f1e36ffac58131da73983ab124d3872aae8054bbc4731581aab51168eb08b3
-  data.tar.gz: 5cffe8618d7460adf817768b5a91d0d478c1ed1103211571def61d3e76c5fa31adf91847158d62e188fd170edc88d718f1501c5966249314acd45f92dfa1a716
+  metadata.gz: 3ea8e0edd4dc7010d06dd66b20834d5673d79fbfb2c76211bf6c9891f5e836858ad3e8a640e21774e0da7cd9cb9276e1029f8b76b0d867a1d5a95ab195a8773e
+  data.tar.gz: 8a585909ec60973a81a8daeed7a6c6bb0a3f11cb88c03be03903f173c5a501a88a07ec42ff4e344abd9151291724e88e55156f0b137ec9640dcb1b0a43e9d2b3

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+## 3.0.0 (2026-01-17)
+
+Full Changelog: [v2.2.0...v3.0.0](https://github.com/Metronome-Industries/metronome-ruby/compare/v2.2.0...v3.0.0)
+
+### Features
+
+* [ORCH-739] expose rev rec data in api ([1e5912a](https://github.com/Metronome-Industries/metronome-ruby/commit/1e5912a60dd3bbfb37740057beac9055f96911e4))
+* [ORCH-739] expose rev rec data in api ([ea99ea2](https://github.com/Metronome-Industries/metronome-ruby/commit/ea99ea27275244d1854395b0906bf1402f09308f))
+* add recurring commit ID and subscription config to commit/credit response schema ([87a38ed](https://github.com/Metronome-Industries/metronome-ruby/commit/87a38ed2828cac15073a4650347ff2b6d3c14935))
+* Add support for custom fields on package terms ([e6ca46b](https://github.com/Metronome-Industries/metronome-ruby/commit/e6ca46b3d30e047799c76d5b6e9407622c94f027))
+* remove use list prices config in requests and responses ([44e02d3](https://github.com/Metronome-Industries/metronome-ruby/commit/44e02d367bedd33dca17c34d45006d21ef630abd))
+* Revert [ORCH-739] expose rev rec data in api ([656d322](https://github.com/Metronome-Industries/metronome-ruby/commit/656d322008021add127b8b6a76e70f3576090e2b))
+
+
+### Chores
+
+* fix typo in descriptions ([fdce90d](https://github.com/Metronome-Industries/metronome-ruby/commit/fdce90df6ae0e1223005482011560ba7eb53821c))
+* **internal:** codegen related update ([64bba19](https://github.com/Metronome-Industries/metronome-ruby/commit/64bba1958c92d4d260271fffc212a7ac904fe881))
+* **internal:** codegen related update ([3237dc8](https://github.com/Metronome-Industries/metronome-ruby/commit/3237dc894931f5a4a4504f545f46be1a0d9b8841))
+* **internal:** update `actions/checkout` version ([5aa0985](https://github.com/Metronome-Industries/metronome-ruby/commit/5aa09854840915a76d003d2e94ea7b25478ca198))
+
+
+### Documentation
+
+* prominently feature MCP server setup in root SDK readmes ([353dc18](https://github.com/Metronome-Industries/metronome-ruby/commit/353dc181c9ce9b55c3e588849391c257ca6e79d8))
+
 ## 2.2.0 (2025-12-18)
 
 Full Changelog: [v2.1.0...v2.2.0](https://github.com/Metronome-Industries/metronome-ruby/compare/v2.1.0...v2.2.0)

data/README.md

@@ -4,6 +4,15 @@ The Metronome Ruby library provides convenient access to the Metronome REST API
 
 It is generated with [Stainless](https://www.stainless.com/).
 
+## MCP Server
+
+Use the Metronome MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.
+
+[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40metronome%2Fmcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBtZXRyb25vbWUvbWNwIl19)
+[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40metronome%2Fmcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40metronome%2Fmcp%22%5D%7D)
+
+> Note: You may need to set environment variables in your MCP client.
+
 ## Documentation
 
 Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/metronome-sdk).
@@ -17,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "metronome-sdk", "~> 2.2.0"
+gem "metronome-sdk", "~> 3.0.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/metronome_sdk/models/commit.rb

@@ -140,6 +140,13 @@ module MetronomeSDK
       #   @return [Symbol, MetronomeSDK::Models::Commit::RateType, nil]
       optional :rate_type, enum: -> { MetronomeSDK::Commit::RateType }
 
+      # @!attribute recurring_commit_id
+      #   The ID of the recurring commit that this commit was generated from, if
+      #   applicable.
+      #
+      #   @return [String, nil]
+      optional :recurring_commit_id, String
+
       # @!attribute rolled_over_from
       #
       #   @return [MetronomeSDK::Models::Commit::RolledOverFrom, nil]
@@ -164,6 +171,13 @@ module MetronomeSDK
       #   @return [Array<MetronomeSDK::Models::CommitSpecifier>, nil]
       optional :specifiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifier] }
 
+      # @!attribute subscription_config
+      #   The subscription configuration for this commit, if it was generated from a
+      #   recurring commit with a subscription attached.
+      #
+      #   @return [MetronomeSDK::Models::Commit::SubscriptionConfig, nil]
+      optional :subscription_config, -> { MetronomeSDK::Commit::SubscriptionConfig }
+
       # @!attribute uniqueness_key
       #   Prevents the creation of duplicates. If a request to create a commit or credit
       #   is made with a uniqueness key that was previously used to create a commit or
@@ -173,7 +187,7 @@ module MetronomeSDK
       #   @return [String, nil]
       optional :uniqueness_key, String
 
-      # @!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, rolled_over_from: nil, rollover_fraction: nil, salesforce_opportunity_id: nil, specifiers: nil, uniqueness_key: nil)
+      # @!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, subscription_config: nil, uniqueness_key: nil)
       #   Some parameter documentations has been truncated, see
       #   {MetronomeSDK::Models::Commit} for more details.
       #
@@ -221,6 +235,8 @@ module MetronomeSDK
       #
       #   @param rate_type [Symbol, MetronomeSDK::Models::Commit::RateType]
       #
+      #   @param recurring_commit_id [String] The ID of the recurring commit that this commit was generated from, if applicabl
+      #
       #   @param rolled_over_from [MetronomeSDK::Models::Commit::RolledOverFrom]
       #
       #   @param rollover_fraction [Float]
@@ -229,6 +245,8 @@ module MetronomeSDK
       #
       #   @param specifiers [Array<MetronomeSDK::Models::CommitSpecifier>] List of filters that determine what kind of customer usage draws down a commit o
       #
+      #   @param subscription_config [MetronomeSDK::Models::Commit::SubscriptionConfig] The subscription configuration for this commit, if it was generated from a recur
+      #
       #   @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a commit or credit i
 
       # @see MetronomeSDK::Models::Commit#product
@@ -934,6 +952,56 @@ module MetronomeSDK
         #   @param commit_id [String]
         #   @param contract_id [String]
       end
+
+      # @see MetronomeSDK::Models::Commit#subscription_config
+      class SubscriptionConfig < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute allocation
+        #
+        #   @return [Symbol, MetronomeSDK::Models::Commit::SubscriptionConfig::Allocation, nil]
+        optional :allocation, enum: -> { MetronomeSDK::Commit::SubscriptionConfig::Allocation }
+
+        # @!attribute apply_seat_increase_config
+        #
+        #   @return [MetronomeSDK::Models::Commit::SubscriptionConfig::ApplySeatIncreaseConfig, nil]
+        optional :apply_seat_increase_config,
+                 -> { MetronomeSDK::Commit::SubscriptionConfig::ApplySeatIncreaseConfig }
+
+        # @!attribute subscription_id
+        #
+        #   @return [String, nil]
+        optional :subscription_id, String
+
+        # @!method initialize(allocation: nil, apply_seat_increase_config: nil, subscription_id: nil)
+        #   The subscription configuration for this commit, if it was generated from a
+        #   recurring commit with a subscription attached.
+        #
+        #   @param allocation [Symbol, MetronomeSDK::Models::Commit::SubscriptionConfig::Allocation]
+        #   @param apply_seat_increase_config [MetronomeSDK::Models::Commit::SubscriptionConfig::ApplySeatIncreaseConfig]
+        #   @param subscription_id [String]
+
+        # @see MetronomeSDK::Models::Commit::SubscriptionConfig#allocation
+        module Allocation
+          extend MetronomeSDK::Internal::Type::Enum
+
+          INDIVIDUAL = :INDIVIDUAL
+          POOLED = :POOLED
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see MetronomeSDK::Models::Commit::SubscriptionConfig#apply_seat_increase_config
+        class ApplySeatIncreaseConfig < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute is_prorated
+          #   Indicates whether a mid-period seat increase should be prorated.
+          #
+          #   @return [Boolean]
+          required :is_prorated, MetronomeSDK::Internal::Type::Boolean
+
+          # @!method initialize(is_prorated:)
+          #   @param is_prorated [Boolean] Indicates whether a mid-period seat increase should be prorated.
+        end
+      end
     end
   end
 end

data/lib/metronome_sdk/models/contract_v2.rb

@@ -421,6 +421,12 @@ module MetronomeSDK
         #   @return [Symbol, MetronomeSDK::Models::ContractV2::Commit::RateType, nil]
         optional :rate_type, enum: -> { MetronomeSDK::ContractV2::Commit::RateType }
 
+        # @!attribute recurring_commit_id
+        #   The ID of the recurring commit that created this commit
+        #
+        #   @return [String, nil]
+        optional :recurring_commit_id, String
+
         # @!attribute rolled_over_from
         #
         #   @return [MetronomeSDK::Models::ContractV2::Commit::RolledOverFrom, nil]
@@ -451,7 +457,7 @@ module MetronomeSDK
         #   @return [MetronomeSDK::Models::RecurringCommitSubscriptionConfig, nil]
         optional :subscription_config, -> { MetronomeSDK::RecurringCommitSubscriptionConfig }
 
-        # @!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, rolled_over_from: nil, rollover_fraction: nil, salesforce_opportunity_id: nil, specifiers: nil, subscription_config: nil)
+        # @!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, subscription_config: nil)
         #   Some parameter documentations has been truncated, see
         #   {MetronomeSDK::Models::ContractV2::Commit} for more details.
         #
@@ -497,6 +503,8 @@ module MetronomeSDK
         #
         #   @param rate_type [Symbol, MetronomeSDK::Models::ContractV2::Commit::RateType]
         #
+        #   @param recurring_commit_id [String] The ID of the recurring commit that created this commit
+        #
         #   @param rolled_over_from [MetronomeSDK::Models::ContractV2::Commit::RolledOverFrom]
         #
         #   @param rollover_fraction [Float]
@@ -1706,6 +1714,12 @@ module MetronomeSDK
         #   @return [Float, nil]
         optional :priority, Float
 
+        # @!attribute recurring_credit_id
+        #   The ID of the recurring credit that created this credit
+        #
+        #   @return [String, nil]
+        optional :recurring_credit_id, String
+
         # @!attribute salesforce_opportunity_id
         #   This field's availability is dependent on your client's configuration.
         #
@@ -1726,7 +1740,7 @@ module MetronomeSDK
         #   @return [MetronomeSDK::Models::RecurringCommitSubscriptionConfig, nil]
         optional :subscription_config, -> { MetronomeSDK::RecurringCommitSubscriptionConfig }
 
-        # @!method initialize(id:, product:, type:, access_schedule: nil, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: 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, salesforce_opportunity_id: nil, specifiers: nil, subscription_config: nil)
+        # @!method initialize(id:, product:, type:, access_schedule: nil, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: 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, salesforce_opportunity_id: nil, specifiers: nil, subscription_config: nil)
         #   Some parameter documentations has been truncated, see
         #   {MetronomeSDK::Models::ContractV2::Credit} for more details.
         #
@@ -1764,6 +1778,8 @@ module MetronomeSDK
         #
         #   @param priority [Float] If multiple credits or commits are applicable, the one with the lower priority w
         #
+        #   @param recurring_credit_id [String] The ID of the recurring credit that created this credit
+        #
         #   @param salesforce_opportunity_id [String] This field's availability is dependent on your client's configuration.
         #
         #   @param specifiers [Array<MetronomeSDK::Models::CommitSpecifier>] List of filters that determine what kind of customer usage draws down a commit o

data/lib/metronome_sdk/models/credit.rb

@@ -104,6 +104,13 @@ module MetronomeSDK
       #   @return [Symbol, MetronomeSDK::Models::Credit::RateType, nil]
       optional :rate_type, enum: -> { MetronomeSDK::Credit::RateType }
 
+      # @!attribute recurring_credit_id
+      #   The ID of the recurring credit that this credit was generated from, if
+      #   applicable.
+      #
+      #   @return [String, nil]
+      optional :recurring_credit_id, String
+
       # @!attribute salesforce_opportunity_id
       #   This field's availability is dependent on your client's configuration.
       #
@@ -118,6 +125,13 @@ module MetronomeSDK
       #   @return [Array<MetronomeSDK::Models::CommitSpecifier>, nil]
       optional :specifiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifier] }
 
+      # @!attribute subscription_config
+      #   The subscription configuration for this credit, if it was generated from a
+      #   recurring credit with a subscription attached.
+      #
+      #   @return [MetronomeSDK::Models::Credit::SubscriptionConfig, nil]
+      optional :subscription_config, -> { MetronomeSDK::Credit::SubscriptionConfig }
+
       # @!attribute uniqueness_key
       #   Prevents the creation of duplicates. If a request to create a commit or credit
       #   is made with a uniqueness key that was previously used to create a commit or
@@ -127,7 +141,7 @@ module MetronomeSDK
       #   @return [String, nil]
       optional :uniqueness_key, String
 
-      # @!method initialize(id:, product:, type:, access_schedule: nil, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, balance: nil, contract: nil, custom_fields: nil, description: nil, hierarchy_configuration: nil, ledger: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, rate_type: nil, salesforce_opportunity_id: nil, specifiers: nil, uniqueness_key: nil)
+      # @!method initialize(id:, product:, type:, access_schedule: nil, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, balance: nil, contract: nil, custom_fields: nil, description: nil, hierarchy_configuration: nil, ledger: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, rate_type: nil, recurring_credit_id: nil, salesforce_opportunity_id: nil, specifiers: nil, subscription_config: nil, uniqueness_key: nil)
       #   Some parameter documentations has been truncated, see
       #   {MetronomeSDK::Models::Credit} for more details.
       #
@@ -165,10 +179,14 @@ module MetronomeSDK
       #
       #   @param rate_type [Symbol, MetronomeSDK::Models::Credit::RateType]
       #
+      #   @param recurring_credit_id [String] The ID of the recurring credit that this credit was generated from, if applicabl
+      #
       #   @param salesforce_opportunity_id [String] This field's availability is dependent on your client's configuration.
       #
       #   @param specifiers [Array<MetronomeSDK::Models::CommitSpecifier>] List of filters that determine what kind of customer usage draws down a commit o
       #
+      #   @param subscription_config [MetronomeSDK::Models::Credit::SubscriptionConfig] The subscription configuration for this credit, if it was generated from a recur
+      #
       #   @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a commit or credit i
 
       # @see MetronomeSDK::Models::Credit#product
@@ -543,6 +561,56 @@ module MetronomeSDK
         # @!method self.values
         #   @return [Array<Symbol>]
       end
+
+      # @see MetronomeSDK::Models::Credit#subscription_config
+      class SubscriptionConfig < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute allocation
+        #
+        #   @return [Symbol, MetronomeSDK::Models::Credit::SubscriptionConfig::Allocation, nil]
+        optional :allocation, enum: -> { MetronomeSDK::Credit::SubscriptionConfig::Allocation }
+
+        # @!attribute apply_seat_increase_config
+        #
+        #   @return [MetronomeSDK::Models::Credit::SubscriptionConfig::ApplySeatIncreaseConfig, nil]
+        optional :apply_seat_increase_config,
+                 -> { MetronomeSDK::Credit::SubscriptionConfig::ApplySeatIncreaseConfig }
+
+        # @!attribute subscription_id
+        #
+        #   @return [String, nil]
+        optional :subscription_id, String
+
+        # @!method initialize(allocation: nil, apply_seat_increase_config: nil, subscription_id: nil)
+        #   The subscription configuration for this credit, if it was generated from a
+        #   recurring credit with a subscription attached.
+        #
+        #   @param allocation [Symbol, MetronomeSDK::Models::Credit::SubscriptionConfig::Allocation]
+        #   @param apply_seat_increase_config [MetronomeSDK::Models::Credit::SubscriptionConfig::ApplySeatIncreaseConfig]
+        #   @param subscription_id [String]
+
+        # @see MetronomeSDK::Models::Credit::SubscriptionConfig#allocation
+        module Allocation
+          extend MetronomeSDK::Internal::Type::Enum
+
+          INDIVIDUAL = :INDIVIDUAL
+          POOLED = :POOLED
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see MetronomeSDK::Models::Credit::SubscriptionConfig#apply_seat_increase_config
+        class ApplySeatIncreaseConfig < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute is_prorated
+          #   Indicates whether a mid-period seat increase should be prorated.
+          #
+          #   @return [Boolean]
+          required :is_prorated, MetronomeSDK::Internal::Type::Boolean
+
+          # @!method initialize(is_prorated:)
+          #   @param is_prorated [Boolean] Indicates whether a mid-period seat increase should be prorated.
+        end
+      end
     end
   end
 end

data/lib/metronome_sdk/models/rate.rb

@@ -53,15 +53,7 @@ module MetronomeSDK
       #   @return [Array<MetronomeSDK::Models::Tier>, nil]
       optional :tiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Tier] }
 
-      # @!attribute use_list_prices
-      #   Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
-      #   using list prices rather than the standard rates for this product on the
-      #   contract.
-      #
-      #   @return [Boolean, nil]
-      optional :use_list_prices, MetronomeSDK::Internal::Type::Boolean
-
-      # @!method initialize(rate_type:, credit_type: nil, custom_rate: nil, is_prorated: nil, price: nil, pricing_group_values: nil, quantity: nil, tiers: nil, use_list_prices: nil)
+      # @!method initialize(rate_type:, credit_type: nil, custom_rate: nil, is_prorated: nil, price: nil, pricing_group_values: nil, quantity: nil, tiers: nil)
       #   Some parameter documentations has been truncated, see
       #   {MetronomeSDK::Models::Rate} for more details.
       #
@@ -80,8 +72,6 @@ module MetronomeSDK
       #   @param quantity [Float] Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
       #
       #   @param tiers [Array<MetronomeSDK::Models::Tier>] Only set for TIERED rate_type.
-      #
-      #   @param use_list_prices [Boolean] Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
 
       # @see MetronomeSDK::Models::Rate#rate_type
       module RateType

data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rb

@@ -120,15 +120,7 @@ module MetronomeSDK
               #   @return [Array<MetronomeSDK::Models::Tier>, nil]
               optional :tiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Tier] }
 
-              # @!attribute use_list_prices
-              #   Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
-              #   using list prices rather than the standard rates for this product on the
-              #   contract.
-              #
-              #   @return [Boolean, nil]
-              optional :use_list_prices, MetronomeSDK::Internal::Type::Boolean
-
-              # @!method initialize(entitled:, product_id:, rate_type:, starting_at:, billing_frequency: nil, commit_rate: nil, credit_type_id: nil, custom_rate: nil, ending_before: nil, is_prorated: nil, price: nil, pricing_group_values: nil, quantity: nil, tiers: nil, use_list_prices: nil)
+              # @!method initialize(entitled:, product_id:, rate_type:, starting_at:, billing_frequency: nil, commit_rate: nil, credit_type_id: nil, custom_rate: nil, ending_before: nil, is_prorated: nil, price: nil, pricing_group_values: nil, quantity: nil, tiers: nil)
               #   Some parameter documentations has been truncated, see
               #   {MetronomeSDK::Models::V1::Contracts::RateCards::RateAddManyParams::Rate} for
               #   more details.
@@ -160,8 +152,6 @@ module MetronomeSDK
               #   @param quantity [Float] Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
               #
               #   @param tiers [Array<MetronomeSDK::Models::Tier>] Only set for TIERED rate_type.
-              #
-              #   @param use_list_prices [Boolean] Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
 
               # @see MetronomeSDK::Models::V1::Contracts::RateCards::RateAddManyParams::Rate#rate_type
               module RateType

data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb

@@ -108,15 +108,7 @@ module MetronomeSDK
             #   @return [Array<MetronomeSDK::Models::Tier>, nil]
             optional :tiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Tier] }
 
-            # @!attribute use_list_prices
-            #   Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
-            #   using list prices rather than the standard rates for this product on the
-            #   contract.
-            #
-            #   @return [Boolean, nil]
-            optional :use_list_prices, MetronomeSDK::Internal::Type::Boolean
-
-            # @!method initialize(entitled:, product_id:, rate_card_id:, rate_type:, starting_at:, billing_frequency: nil, commit_rate: nil, credit_type_id: nil, custom_rate: nil, ending_before: nil, is_prorated: nil, price: nil, pricing_group_values: nil, quantity: nil, tiers: nil, use_list_prices: nil, request_options: {})
+            # @!method initialize(entitled:, product_id:, rate_card_id:, rate_type:, starting_at:, billing_frequency: nil, commit_rate: nil, credit_type_id: nil, custom_rate: nil, ending_before: nil, is_prorated: nil, price: nil, pricing_group_values: nil, quantity: nil, tiers: nil, request_options: {})
             #   Some parameter documentations has been truncated, see
             #   {MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams} for more
             #   details.
@@ -151,8 +143,6 @@ module MetronomeSDK
             #
             #   @param tiers [Array<MetronomeSDK::Models::Tier>] Only set for TIERED rate_type.
             #
-            #   @param use_list_prices [Boolean] Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
-            #
             #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
 
             module RateType

data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rb

@@ -75,15 +75,7 @@ module MetronomeSDK
               #   @return [Array<MetronomeSDK::Models::Tier>, nil]
               optional :tiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Tier] }
 
-              # @!attribute use_list_prices
-              #   Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
-              #   using list prices rather than the standard rates for this product on the
-              #   contract.
-              #
-              #   @return [Boolean, nil]
-              optional :use_list_prices, MetronomeSDK::Internal::Type::Boolean
-
-              # @!method initialize(rate_type:, commit_rate: nil, credit_type: nil, custom_rate: nil, is_prorated: nil, price: nil, pricing_group_values: nil, quantity: nil, tiers: nil, use_list_prices: nil)
+              # @!method initialize(rate_type:, commit_rate: nil, credit_type: nil, custom_rate: nil, is_prorated: nil, price: nil, pricing_group_values: nil, quantity: nil, tiers: nil)
               #   Some parameter documentations has been truncated, see
               #   {MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data} for more
               #   details.
@@ -105,8 +97,6 @@ module MetronomeSDK
               #   @param quantity [Float] Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
               #
               #   @param tiers [Array<MetronomeSDK::Models::Tier>] Only set for TIERED rate_type.
-              #
-              #   @param use_list_prices [Boolean] Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
 
               # @see MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data#rate_type
               module RateType

data/lib/metronome_sdk/models/v1/custom_field_add_key_params.rb

@@ -50,6 +50,10 @@ module MetronomeSDK
           RATE_CARD = :rate_card
           SCHEDULED_CHARGE = :scheduled_charge
           SUBSCRIPTION = :subscription
+          PACKAGE_COMMIT = :package_commit
+          PACKAGE_CREDIT = :package_credit
+          PACKAGE_SUBSCRIPTION = :package_subscription
+          PACKAGE_SCHEDULED_CHARGE = :package_scheduled_charge
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/metronome_sdk/models/v1/custom_field_delete_values_params.rb

@@ -50,6 +50,10 @@ module MetronomeSDK
           RATE_CARD = :rate_card
           SCHEDULED_CHARGE = :scheduled_charge
           SUBSCRIPTION = :subscription
+          PACKAGE_COMMIT = :package_commit
+          PACKAGE_CREDIT = :package_credit
+          PACKAGE_SUBSCRIPTION = :package_subscription
+          PACKAGE_SCHEDULED_CHARGE = :package_scheduled_charge
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/metronome_sdk/models/v1/custom_field_list_keys_params.rb

@@ -49,6 +49,10 @@ module MetronomeSDK
           RATE_CARD = :rate_card
           SCHEDULED_CHARGE = :scheduled_charge
           SUBSCRIPTION = :subscription
+          PACKAGE_COMMIT = :package_commit
+          PACKAGE_CREDIT = :package_credit
+          PACKAGE_SUBSCRIPTION = :package_subscription
+          PACKAGE_SCHEDULED_CHARGE = :package_scheduled_charge
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/metronome_sdk/models/v1/custom_field_list_keys_response.rb

@@ -47,6 +47,10 @@ module MetronomeSDK
           RATE_CARD = :rate_card
           SCHEDULED_CHARGE = :scheduled_charge
           SUBSCRIPTION = :subscription
+          PACKAGE_COMMIT = :package_commit
+          PACKAGE_CREDIT = :package_credit
+          PACKAGE_SUBSCRIPTION = :package_subscription
+          PACKAGE_SCHEDULED_CHARGE = :package_scheduled_charge
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/metronome_sdk/models/v1/custom_field_remove_key_params.rb

@@ -44,6 +44,10 @@ module MetronomeSDK
           RATE_CARD = :rate_card
           SCHEDULED_CHARGE = :scheduled_charge
           SUBSCRIPTION = :subscription
+          PACKAGE_COMMIT = :package_commit
+          PACKAGE_CREDIT = :package_credit
+          PACKAGE_SUBSCRIPTION = :package_subscription
+          PACKAGE_SCHEDULED_CHARGE = :package_scheduled_charge
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/metronome_sdk/models/v1/custom_field_set_values_params.rb

@@ -54,6 +54,10 @@ module MetronomeSDK
           RATE_CARD = :rate_card
           SCHEDULED_CHARGE = :scheduled_charge
           SUBSCRIPTION = :subscription
+          PACKAGE_COMMIT = :package_commit
+          PACKAGE_CREDIT = :package_credit
+          PACKAGE_SUBSCRIPTION = :package_subscription
+          PACKAGE_SCHEDULED_CHARGE = :package_scheduled_charge
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/metronome_sdk/models/v1/customers/invoice.rb

@@ -158,6 +158,15 @@ module MetronomeSDK
           #   @return [MetronomeSDK::Models::V1::Customers::Invoice::ResellerRoyalty, nil]
           optional :reseller_royalty, -> { MetronomeSDK::V1::Customers::Invoice::ResellerRoyalty }
 
+          # @!attribute revenue_system_invoices
+          #
+          #   @return [Array<MetronomeSDK::Models::V1::Customers::Invoice::RevenueSystemInvoice>, nil]
+          optional :revenue_system_invoices,
+                   -> {
+                     MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::Invoice::RevenueSystemInvoice]
+                   },
+                   nil?: true
+
           # @!attribute salesforce_opportunity_id
           #   This field's availability is dependent on your client's configuration.
           #
@@ -175,7 +184,7 @@ module MetronomeSDK
           #   @return [Float, nil]
           optional :subtotal, Float
 
-          # @!method initialize(id:, credit_type:, customer_id:, line_items:, status:, total:, type:, amendment_id: nil, billable_status: nil, constituent_invoices: nil, contract_custom_fields: nil, contract_id: nil, correction_record: nil, created_at: nil, custom_fields: nil, customer_custom_fields: nil, end_timestamp: nil, external_invoice: nil, invoice_adjustments: nil, issued_at: nil, net_payment_terms_days: nil, netsuite_sales_order_id: nil, payer: nil, plan_custom_fields: nil, plan_id: nil, plan_name: nil, reseller_royalty: nil, salesforce_opportunity_id: nil, start_timestamp: nil, subtotal: nil)
+          # @!method initialize(id:, credit_type:, customer_id:, line_items:, status:, total:, type:, amendment_id: nil, billable_status: nil, constituent_invoices: nil, contract_custom_fields: nil, contract_id: nil, correction_record: nil, created_at: nil, custom_fields: nil, customer_custom_fields: nil, end_timestamp: nil, external_invoice: nil, invoice_adjustments: nil, issued_at: nil, net_payment_terms_days: nil, netsuite_sales_order_id: nil, payer: nil, plan_custom_fields: nil, plan_id: nil, plan_name: nil, reseller_royalty: nil, revenue_system_invoices: nil, salesforce_opportunity_id: nil, start_timestamp: nil, subtotal: nil)
           #   Some parameter documentations has been truncated, see
           #   {MetronomeSDK::Models::V1::Customers::Invoice} for more details.
           #
@@ -233,6 +242,8 @@ module MetronomeSDK
           #
           #   @param reseller_royalty [MetronomeSDK::Models::V1::Customers::Invoice::ResellerRoyalty] Only present for contract invoices with reseller royalties.
           #
+          #   @param revenue_system_invoices [Array<MetronomeSDK::Models::V1::Customers::Invoice::RevenueSystemInvoice>, nil]
+          #
           #   @param salesforce_opportunity_id [String] This field's availability is dependent on your client's configuration.
           #
           #   @param start_timestamp [Time] Beginning of the usage period this invoice covers (UTC)
@@ -1370,6 +1381,45 @@ module MetronomeSDK
               #   @param gcp_offer_id [String]
             end
           end
+
+          class RevenueSystemInvoice < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute revenue_system_external_entity_type
+            #
+            #   @return [String]
+            required :revenue_system_external_entity_type, String
+
+            # @!attribute revenue_system_provider
+            #
+            #   @return [String]
+            required :revenue_system_provider, String
+
+            # @!attribute sync_status
+            #
+            #   @return [String]
+            required :sync_status, String
+
+            # @!attribute error_message
+            #   The error message from the revenue system, if available.
+            #
+            #   @return [String, nil]
+            optional :error_message, String
+
+            # @!attribute revenue_system_external_entity_id
+            #
+            #   @return [String, nil]
+            optional :revenue_system_external_entity_id, String
+
+            # @!method initialize(revenue_system_external_entity_type:, revenue_system_provider:, sync_status:, error_message: nil, revenue_system_external_entity_id: nil)
+            #   @param revenue_system_external_entity_type [String]
+            #
+            #   @param revenue_system_provider [String]
+            #
+            #   @param sync_status [String]
+            #
+            #   @param error_message [String] The error message from the revenue system, if available.
+            #
+            #   @param revenue_system_external_entity_id [String]
+          end
         end
       end
     end