metronome-sdk 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0915b00a0f26162aace25f837292b0a4397ebd7e62179d9b8b3605a322ecfa1d'
-  data.tar.gz: 8d0580f9ba5e72ca8eb0729c8664aff99b00bee910368df5a692e4b2fab6740b
+  metadata.gz: f70b65323a25a4de65861565a092a6aa70f43d28e5e910acca44d883efe9cf86
+  data.tar.gz: 4d89458274f95fb69ca5d6bccad455a6ecaf92a3d1a93b8843290166f724e01d
 SHA512:
-  metadata.gz: 51ff71fc9926d302ef837596298dfa6eea80c52200b0861e51b4d6f399be2d276f04987ae40c0346eef2f3f5cdc18cce603b44bfb4c99fb123b20e5c3c7b5983
-  data.tar.gz: 6a93ca533bf883619baecd64f06f6b51811676a2f8872cb5205d5ac64b52136a3f27f392671eb7deae4784e7af780cec40df66d3fa1f9b53c6162087a3dc893f
+  metadata.gz: '010907bdf574da3664f42af09be522e41a87dfc4ae1280ee4307326c8d62751c1fdc11bfec4214ec22176cbaf0002a2f1a7b6ed3668da3fb3347ab2bdb3b5494'
+  data.tar.gz: d9be0ec4d10b760064dc84412f78c074258613af6b2ba7e33432ddade4c39d6356ed9d4fc59fb7a89eadc1ce4cd99f893e7c329bbedc27b4dc8e3ac8f76d1c5d

data/CHANGELOG.md

@@ -1,5 +1,41 @@
 # Changelog
 
+## 2.1.0 (2025-10-31)
+
+Full Changelog: [v2.0.0...v2.1.0](https://github.com/Metronome-Industries/metronome-ruby/compare/v2.0.0...v2.1.0)
+
+### Features
+
+* [ORCH-282] plumb `payment_method_id` to the payment gateway object ([bba092f](https://github.com/Metronome-Industries/metronome-ruby/commit/bba092fbe0b66d2f2df6187c579bdc0458375a65))
+* [ORCH-797] add billing_provider_error to invoice.external_invoice ([7f77e42](https://github.com/Metronome-Industries/metronome-ruby/commit/7f77e42d219f720783d480096248bf153e771336))
+* Add avalara creds + billing provider APIs to SDK. Add avalara creds API to docs. ([9808e39](https://github.com/Metronome-Industries/metronome-ruby/commit/9808e39003df39e50183c64e806ef4589819353d))
+* add beta tag to stripe auto charge items ([652727e](https://github.com/Metronome-Industries/metronome-ruby/commit/652727e1f6df7269a3b6db00f401460aab32ce6d))
+* add exclude_zero_balances field behind a FF for anthropic ([9e7b1a4](https://github.com/Metronome-Industries/metronome-ruby/commit/9e7b1a461fe7eb13fd846f18f0ea329f6b1083b7))
+* add METRONOME to BillingProvider type ([2f7e988](https://github.com/Metronome-Industries/metronome-ruby/commit/2f7e9882bf53acae0356e748be68e37067ef9bd9))
+* docs(api) Documentation for seat-based subscription linked recurring commits beta release ([2e53b04](https://github.com/Metronome-Industries/metronome-ruby/commit/2e53b04d23b9e49184bd91d32c712a4c59a73f0a))
+* handle thread interrupts in the core HTTP client ([db696fe](https://github.com/Metronome-Industries/metronome-ruby/commit/db696fe074207b842d076aaafa549c5695c87dd5))
+* ignore_duplicates ([cd50ce6](https://github.com/Metronome-Industries/metronome-ruby/commit/cd50ce63586d55d98557e050024cad863be60b99))
+* internal: moving plans docs to deprecated section of new docs site ([f5f12b4](https://github.com/Metronome-Industries/metronome-ruby/commit/f5f12b4af2bbc39d892b885b6b6f768128330806))
+* not ready for review ([efabbf6](https://github.com/Metronome-Industries/metronome-ruby/commit/efabbf64195a0575e5136ba7de0a0552a11a7592))
+* not ready for review ([624dd4f](https://github.com/Metronome-Industries/metronome-ruby/commit/624dd4f2c827279317bb7ac53cb9c8ab9aa4dde8))
+* Relax requirement on customer level commits for invoice_contract_id if do_not_invoice is set to true ([af4a8a7](https://github.com/Metronome-Industries/metronome-ruby/commit/af4a8a72d376d709a69b9cd248e54ef12eaa8124))
+* update get customer alerts api to include low seat balance type ([1e08e6d](https://github.com/Metronome-Industries/metronome-ruby/commit/1e08e6d2f1186dd47e17a6bf986d8732ec9801b3))
+
+
+### Bug Fixes
+
+* **api:** Make id field required in /v2/notifications/edit ([34c16c6](https://github.com/Metronome-Industries/metronome-ruby/commit/34c16c6bcebdfc18765883b017708225cf6d312c))
+
+
+### Chores
+
+* **api:** Note SQL BM is not supported in previewCustomerEvents description ([1bb482c](https://github.com/Metronome-Industries/metronome-ruby/commit/1bb482c536bc70849b425b45a073431cf4dff009))
+
+
+### Documentation
+
+* add migrate amendments to edits page ([6b10754](https://github.com/Metronome-Industries/metronome-ruby/commit/6b1075422730cb9b1b254ac7549c76b8f5f8d475))
+
 ## 2.0.0 (2025-10-16)
 
 Full Changelog: [v1.0.0...v2.0.0](https://github.com/Metronome-Industries/metronome-ruby/compare/v1.0.0...v2.0.0)

data/README.md

@@ -17,7 +17,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.0.0"
+gem "metronome-sdk", "~> 2.1.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/metronome_sdk/internal/transport/pooled_net_requester.rb

@@ -128,40 +128,48 @@ module MetronomeSDK
           url, deadline = request.fetch_values(:url, :deadline)
 
           req = nil
-          eof = false
           finished = false
-          closing = nil
 
           # rubocop:disable Metrics/BlockLength
           enum = Enumerator.new do |y|
             next if finished
 
             with_pool(url, deadline: deadline) do |conn|
-              req, closing = self.class.build_request(request) do
-                self.class.calibrate_socket_timeout(conn, deadline)
-              end
-
-              self.class.calibrate_socket_timeout(conn, deadline)
-              unless conn.started?
-                conn.keep_alive_timeout = self.class::KEEP_ALIVE_TIMEOUT
-                conn.start
-              end
+              eof = false
+              closing = nil
+              ::Thread.handle_interrupt(Object => :never) do
+                ::Thread.handle_interrupt(Object => :immediate) do
+                  req, closing = self.class.build_request(request) do
+                    self.class.calibrate_socket_timeout(conn, deadline)
+                  end
 
-              self.class.calibrate_socket_timeout(conn, deadline)
-              conn.request(req) do |rsp|
-                y << [req, rsp]
-                break if finished
-
-                rsp.read_body do |bytes|
-                  y << bytes.force_encoding(Encoding::BINARY)
-                  break if finished
+                  self.class.calibrate_socket_timeout(conn, deadline)
+                  unless conn.started?
+                    conn.keep_alive_timeout = self.class::KEEP_ALIVE_TIMEOUT
+                    conn.start
+                  end
 
                   self.class.calibrate_socket_timeout(conn, deadline)
+                  conn.request(req) do |rsp|
+                    y << [req, rsp]
+                    break if finished
+
+                    rsp.read_body do |bytes|
+                      y << bytes.force_encoding(Encoding::BINARY)
+                      break if finished
+
+                      self.class.calibrate_socket_timeout(conn, deadline)
+                    end
+                    eof = true
+                  end
+                end
+              ensure
+                begin
+                  conn.finish if !eof && conn&.started?
+                ensure
+                  closing&.call
                 end
-                eof = true
               end
-            ensure
-              conn.finish if !eof && conn&.started?
             end
           rescue Timeout::Error
             raise MetronomeSDK::Errors::APITimeoutError.new(url: url, request: req)
@@ -174,8 +182,6 @@ module MetronomeSDK
           body = MetronomeSDK::Internal::Util.fused_enum(enum, external: true) do
             finished = true
             loop { enum.next }
-          ensure
-            closing&.call
           end
           [Integer(response.code), response, body]
         end

data/lib/metronome_sdk/models/contract.rb

@@ -365,6 +365,7 @@ module MetronomeSDK
           QUICKBOOKS_ONLINE = :quickbooks_online
           WORKDAY = :workday
           GCP_MARKETPLACE = :gcp_marketplace
+          METRONOME = :metronome
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/metronome_sdk/models/contract_v2.rb

@@ -2148,6 +2148,7 @@ module MetronomeSDK
           QUICKBOOKS_ONLINE = :quickbooks_online
           WORKDAY = :workday
           GCP_MARKETPLACE = :gcp_marketplace
+          METRONOME = :metronome
 
           # @!method self.values
           #   @return [Array<Symbol>]
@@ -2246,10 +2247,13 @@ module MetronomeSDK
           # @see MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ParentHierarchyConfiguration#parent_behavior
           class ParentBehavior < MetronomeSDK::Internal::Type::BaseModel
             # @!attribute invoice_consolidation_type
-            #   Indicates the desired behavior of consolidated invoices generated by the parent
-            #   in a customer hierarchy **CONCATENATE**: Statements on the invoices of child
-            #   customers will be appended to the consolidated invoice **NONE**: Do not generate
-            #   consolidated invoices
+            #   Account hierarchy M3 - Indicates the desired behavior of consolidated invoices
+            #   generated by the parent in a customer hierarchy
+            #
+            #   **CONCATENATE**: Statements on the invoices of child customers will be appended
+            #   to the consolidated invoice
+            #
+            #   **NONE**: Do not generate consolidated invoices
             #
             #   @return [Symbol, MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior::InvoiceConsolidationType, nil]
             optional :invoice_consolidation_type,
@@ -2260,12 +2264,15 @@ module MetronomeSDK
             #   {MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior}
             #   for more details.
             #
-            #   @param invoice_consolidation_type [Symbol, MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior::InvoiceConsolidationType] Indicates the desired behavior of consolidated invoices generated by the parent
+            #   @param invoice_consolidation_type [Symbol, MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior::InvoiceConsolidationType] Account hierarchy M3 - Indicates the desired behavior of consolidated invoices g
 
-            # Indicates the desired behavior of consolidated invoices generated by the parent
-            # in a customer hierarchy **CONCATENATE**: Statements on the invoices of child
-            # customers will be appended to the consolidated invoice **NONE**: Do not generate
-            # consolidated invoices
+            # Account hierarchy M3 - Indicates the desired behavior of consolidated invoices
+            # generated by the parent in a customer hierarchy
+            #
+            # **CONCATENATE**: Statements on the invoices of child customers will be appended
+            # to the consolidated invoice
+            #
+            # **NONE**: Do not generate consolidated invoices
             #
             # @see MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior#invoice_consolidation_type
             module InvoiceConsolidationType
@@ -2289,17 +2296,23 @@ module MetronomeSDK
                    -> { MetronomeSDK::ContractV2::HierarchyConfiguration::ChildHierarchyConfigurationV2::Parent }
 
           # @!attribute payer
-          #   Indicates whether the child or parent should pay for the child's invoice charges
+          #   Account hierarchy M3 - Indicates which customer should pay for the child's
+          #   invoice charges **SELF**: The child pays for its own invoice charges **PARENT**:
+          #   The parent pays for the child's invoice charges
           #
           #   @return [Symbol, MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ChildHierarchyConfigurationV2::Payer, nil]
           optional :payer,
                    enum: -> { MetronomeSDK::ContractV2::HierarchyConfiguration::ChildHierarchyConfigurationV2::Payer }
 
           # @!attribute usage_statement_behavior
-          #   Indicates the behavior of the child's invoice statements on the parent's
-          #   invoices **CONSOLIDATE**: Child's invoice statements will be added to parent's
-          #   consolidated invoices **SEPARATE**: Child's invoice statements will appear not
-          #   appear on parent's consolidated invoices
+          #   Account hierarchy M3 - Indicates the behavior of the child's invoice statements
+          #   on the parent's invoices.
+          #
+          #   **CONSOLIDATE**: Child's invoice statements will be added to parent's
+          #   consolidated invoices
+          #
+          #   **SEPARATE**: Child's invoice statements will appear not appear on parent's
+          #   consolidated invoices
           #
           #   @return [Symbol, MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ChildHierarchyConfigurationV2::UsageStatementBehavior, nil]
           optional :usage_statement_behavior,
@@ -2312,9 +2325,9 @@ module MetronomeSDK
           #
           #   @param parent [MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ChildHierarchyConfigurationV2::Parent] The single parent contract/customer for this child.
           #
-          #   @param payer [Symbol, MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ChildHierarchyConfigurationV2::Payer] Indicates whether the child or parent should pay for the child's invoice charges
+          #   @param payer [Symbol, MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ChildHierarchyConfigurationV2::Payer] Account hierarchy M3 - Indicates which customer should pay for the child's invoi
           #
-          #   @param usage_statement_behavior [Symbol, MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ChildHierarchyConfigurationV2::UsageStatementBehavior] Indicates the behavior of the child's invoice statements on the parent's invoice
+          #   @param usage_statement_behavior [Symbol, MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ChildHierarchyConfigurationV2::UsageStatementBehavior] Account hierarchy M3 - Indicates the behavior of the child's invoice statements
 
           # @see MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ChildHierarchyConfigurationV2#parent
           class Parent < MetronomeSDK::Internal::Type::BaseModel
@@ -2335,7 +2348,9 @@ module MetronomeSDK
             #   @param customer_id [String]
           end
 
-          # Indicates whether the child or parent should pay for the child's invoice charges
+          # Account hierarchy M3 - Indicates which customer should pay for the child's
+          # invoice charges **SELF**: The child pays for its own invoice charges **PARENT**:
+          # The parent pays for the child's invoice charges
           #
           # @see MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ChildHierarchyConfigurationV2#payer
           module Payer
@@ -2348,10 +2363,14 @@ module MetronomeSDK
             #   @return [Array<Symbol>]
           end
 
-          # Indicates the behavior of the child's invoice statements on the parent's
-          # invoices **CONSOLIDATE**: Child's invoice statements will be added to parent's
-          # consolidated invoices **SEPARATE**: Child's invoice statements will appear not
-          # appear on parent's consolidated invoices
+          # Account hierarchy M3 - Indicates the behavior of the child's invoice statements
+          # on the parent's invoices.
+          #
+          # **CONSOLIDATE**: Child's invoice statements will be added to parent's
+          # consolidated invoices
+          #
+          # **SEPARATE**: Child's invoice statements will appear not appear on parent's
+          # consolidated invoices
           #
           # @see MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ChildHierarchyConfigurationV2#usage_statement_behavior
           module UsageStatementBehavior

data/lib/metronome_sdk/models/hierarchy_configuration.rb

@@ -49,10 +49,13 @@ module MetronomeSDK
         # @see MetronomeSDK::Models::HierarchyConfiguration::ParentHierarchyConfiguration#parent_behavior
         class ParentBehavior < MetronomeSDK::Internal::Type::BaseModel
           # @!attribute invoice_consolidation_type
-          #   Indicates the desired behavior of consolidated invoices generated by the parent
-          #   in a customer hierarchy **CONCATENATE**: Statements on the invoices of child
-          #   customers will be appended to the consolidated invoice **NONE**: Do not generate
-          #   consolidated invoices
+          #   Account hierarchy M3 - Indicates the desired behavior of consolidated invoices
+          #   generated by the parent in a customer hierarchy
+          #
+          #   **CONCATENATE**: Statements on the invoices of child customers will be appended
+          #   to the consolidated invoice
+          #
+          #   **NONE**: Do not generate consolidated invoices
           #
           #   @return [Symbol, MetronomeSDK::Models::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior::InvoiceConsolidationType, nil]
           optional :invoice_consolidation_type,
@@ -63,12 +66,15 @@ module MetronomeSDK
           #   {MetronomeSDK::Models::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior}
           #   for more details.
           #
-          #   @param invoice_consolidation_type [Symbol, MetronomeSDK::Models::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior::InvoiceConsolidationType] Indicates the desired behavior of consolidated invoices generated by the parent
+          #   @param invoice_consolidation_type [Symbol, MetronomeSDK::Models::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior::InvoiceConsolidationType] Account hierarchy M3 - Indicates the desired behavior of consolidated invoices g
 
-          # Indicates the desired behavior of consolidated invoices generated by the parent
-          # in a customer hierarchy **CONCATENATE**: Statements on the invoices of child
-          # customers will be appended to the consolidated invoice **NONE**: Do not generate
-          # consolidated invoices
+          # Account hierarchy M3 - Indicates the desired behavior of consolidated invoices
+          # generated by the parent in a customer hierarchy
+          #
+          # **CONCATENATE**: Statements on the invoices of child customers will be appended
+          # to the consolidated invoice
+          #
+          # **NONE**: Do not generate consolidated invoices
           #
           # @see MetronomeSDK::Models::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior#invoice_consolidation_type
           module InvoiceConsolidationType
@@ -91,16 +97,25 @@ module MetronomeSDK
         required :parent, -> { MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::Parent }
 
         # @!attribute payer
-        #   Indicates whether the parent should pay for the child's invoice charges
+        #   Account hierarchy M3 - Indicates which customer should pay for the child's
+        #   invoice charges
+        #
+        #   **SELF**: The child pays for its own invoice charges
+        #
+        #   **PARENT**: The parent pays for the child's invoice charges
         #
         #   @return [Symbol, MetronomeSDK::Models::HierarchyConfiguration::ChildHierarchyConfiguration::Payer, nil]
         optional :payer, enum: -> { MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::Payer }
 
         # @!attribute usage_statement_behavior
-        #   Indicates the behavior of the child's invoice statements on the parent's
-        #   invoices **CONSOLIDATE**: Child's invoice statements will be added to parent's
-        #   consolidated invoices **SEPARATE**: Child's invoice statements will appear not
-        #   appear on parent's consolidated invoices
+        #   Account hierarchy M3 - Indicates the behavior of the child's invoice statements
+        #   on the parent's invoices.
+        #
+        #   **CONSOLIDATE**: Child's invoice statements will be added to parent's
+        #   consolidated invoices
+        #
+        #   **SEPARATE**: Child's invoice statements will appear not appear on parent's
+        #   consolidated invoices
         #
         #   @return [Symbol, MetronomeSDK::Models::HierarchyConfiguration::ChildHierarchyConfiguration::UsageStatementBehavior, nil]
         optional :usage_statement_behavior,
@@ -113,9 +128,9 @@ module MetronomeSDK
         #
         #   @param parent [MetronomeSDK::Models::HierarchyConfiguration::ChildHierarchyConfiguration::Parent] The single parent contract/customer for this child.
         #
-        #   @param payer [Symbol, MetronomeSDK::Models::HierarchyConfiguration::ChildHierarchyConfiguration::Payer] Indicates whether the parent should pay for the child's invoice charges
+        #   @param payer [Symbol, MetronomeSDK::Models::HierarchyConfiguration::ChildHierarchyConfiguration::Payer] Account hierarchy M3 - Indicates which customer should pay for the child's invoi
         #
-        #   @param usage_statement_behavior [Symbol, MetronomeSDK::Models::HierarchyConfiguration::ChildHierarchyConfiguration::UsageStatementBehavior] Indicates the behavior of the child's invoice statements on the parent's invoice
+        #   @param usage_statement_behavior [Symbol, MetronomeSDK::Models::HierarchyConfiguration::ChildHierarchyConfiguration::UsageStatementBehavior] Account hierarchy M3 - Indicates the behavior of the child's invoice statements
 
         # @see MetronomeSDK::Models::HierarchyConfiguration::ChildHierarchyConfiguration#parent
         class Parent < MetronomeSDK::Internal::Type::BaseModel
@@ -136,7 +151,12 @@ module MetronomeSDK
           #   @param customer_id [String]
         end
 
-        # Indicates whether the parent should pay for the child's invoice charges
+        # Account hierarchy M3 - Indicates which customer should pay for the child's
+        # invoice charges
+        #
+        # **SELF**: The child pays for its own invoice charges
+        #
+        # **PARENT**: The parent pays for the child's invoice charges
         #
         # @see MetronomeSDK::Models::HierarchyConfiguration::ChildHierarchyConfiguration#payer
         module Payer
@@ -149,10 +169,14 @@ module MetronomeSDK
           #   @return [Array<Symbol>]
         end
 
-        # Indicates the behavior of the child's invoice statements on the parent's
-        # invoices **CONSOLIDATE**: Child's invoice statements will be added to parent's
-        # consolidated invoices **SEPARATE**: Child's invoice statements will appear not
-        # appear on parent's consolidated invoices
+        # Account hierarchy M3 - Indicates the behavior of the child's invoice statements
+        # on the parent's invoices.
+        #
+        # **CONSOLIDATE**: Child's invoice statements will be added to parent's
+        # consolidated invoices
+        #
+        # **SEPARATE**: Child's invoice statements will appear not appear on parent's
+        # consolidated invoices
         #
         # @see MetronomeSDK::Models::HierarchyConfiguration::ChildHierarchyConfiguration#usage_statement_behavior
         module UsageStatementBehavior

data/lib/metronome_sdk/models/subscription.rb

@@ -24,6 +24,11 @@ module MetronomeSDK
       #   QUANTITY_ONLY. **QUANTITY_ONLY**: The subscription quantity is specified
       #   directly on the subscription. `initial_quantity` must be provided with this
       #   option. Compatible with recurring commits/credits that use POOLED allocation.
+      #   **SEAT_BASED**: (BETA) Use when you want to pass specific seat identifiers (e.g.
+      #   add user_123) to increment and decrement a subscription quantity, rather than
+      #   directly providing the quantity. You must use a **SEAT_BASED** subscription to
+      #   use a linked recurring credit with an allocation per seat. `seat_config` must be
+      #   provided with this option.
       #
       #   @return [Symbol, MetronomeSDK::Models::Subscription::QuantityManagementMode]
       required :quantity_management_mode, enum: -> { MetronomeSDK::Subscription::QuantityManagementMode }
@@ -226,6 +231,11 @@ module MetronomeSDK
       # QUANTITY_ONLY. **QUANTITY_ONLY**: The subscription quantity is specified
       # directly on the subscription. `initial_quantity` must be provided with this
       # option. Compatible with recurring commits/credits that use POOLED allocation.
+      # **SEAT_BASED**: (BETA) Use when you want to pass specific seat identifiers (e.g.
+      # add user_123) to increment and decrement a subscription quantity, rather than
+      # directly providing the quantity. You must use a **SEAT_BASED** subscription to
+      # use a linked recurring credit with an allocation per seat. `seat_config` must be
+      # provided with this option.
       #
       # @see MetronomeSDK::Models::Subscription#quantity_management_mode
       module QuantityManagementMode

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

@@ -1358,16 +1358,25 @@ module MetronomeSDK
                    -> { MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior }
 
           # @!attribute payer
-          #   Indicates whether the parent should pay for the child's invoice charges
+          #   Account hierarchy M3 - Indicates which customer should pay for the child's
+          #   invoice charges
+          #
+          #   **SELF**: The child pays for its own invoice charges
+          #
+          #   **PARENT**: The parent pays for the child's invoice charges
           #
           #   @return [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::Payer, nil]
           optional :payer, enum: -> { MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::Payer }
 
           # @!attribute usage_statement_behavior
-          #   Indicates the behavior of the child's invoice statements on the parent's
-          #   invoices **CONSOLIDATE**: Child's invoice statements will be added to parent's
-          #   consolidated invoices **SEPARATE**: Child's invoice statements will appear not
-          #   appear on parent's consolidated invoices
+          #   Account hierarchy M3 - Indicates the behavior of the child's invoice statements
+          #   on the parent's invoices.
+          #
+          #   **CONSOLIDATE**: Child's invoice statements will be added to parent's
+          #   consolidated invoices
+          #
+          #   **SEPARATE**: Child's invoice statements will appear not appear on parent's
+          #   consolidated invoices
           #
           #   @return [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::UsageStatementBehavior, nil]
           optional :usage_statement_behavior,
@@ -1382,9 +1391,9 @@ module MetronomeSDK
           #
           #   @param parent_behavior [MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior]
           #
-          #   @param payer [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::Payer] Indicates whether the parent should pay for the child's invoice charges
+          #   @param payer [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::Payer] Account hierarchy M3 - Indicates which customer should pay for the child's invoi
           #
-          #   @param usage_statement_behavior [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::UsageStatementBehavior] Indicates the behavior of the child's invoice statements on the parent's invoice
+          #   @param usage_statement_behavior [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::UsageStatementBehavior] Account hierarchy M3 - Indicates the behavior of the child's invoice statements
 
           # @see MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration#parent
           class Parent < MetronomeSDK::Internal::Type::BaseModel
@@ -1406,10 +1415,13 @@ module MetronomeSDK
           # @see MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration#parent_behavior
           class ParentBehavior < MetronomeSDK::Internal::Type::BaseModel
             # @!attribute invoice_consolidation_type
-            #   Indicates the desired behavior of consolidated invoices generated by the parent
-            #   in a customer hierarchy **CONCATENATE**: Statements on the invoices of child
-            #   customers will be appended to the consolidated invoice **NONE**: Do not generate
-            #   consolidated invoices
+            #   Account hierarchy M3 - Indicates the desired behavior of consolidated invoices
+            #   generated by the parent in a customer hierarchy
+            #
+            #   **CONCATENATE**: Statements on the invoices of child customers will be appended
+            #   to the consolidated invoice
+            #
+            #   **NONE**: Do not generate consolidated invoices
             #
             #   @return [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior::InvoiceConsolidationType, nil]
             optional :invoice_consolidation_type,
@@ -1420,12 +1432,15 @@ module MetronomeSDK
             #   {MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior}
             #   for more details.
             #
-            #   @param invoice_consolidation_type [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior::InvoiceConsolidationType] Indicates the desired behavior of consolidated invoices generated by the parent
+            #   @param invoice_consolidation_type [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior::InvoiceConsolidationType] Account hierarchy M3 - Indicates the desired behavior of consolidated invoices g
 
-            # Indicates the desired behavior of consolidated invoices generated by the parent
-            # in a customer hierarchy **CONCATENATE**: Statements on the invoices of child
-            # customers will be appended to the consolidated invoice **NONE**: Do not generate
-            # consolidated invoices
+            # Account hierarchy M3 - Indicates the desired behavior of consolidated invoices
+            # generated by the parent in a customer hierarchy
+            #
+            # **CONCATENATE**: Statements on the invoices of child customers will be appended
+            # to the consolidated invoice
+            #
+            # **NONE**: Do not generate consolidated invoices
             #
             # @see MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior#invoice_consolidation_type
             module InvoiceConsolidationType
@@ -1439,7 +1454,12 @@ module MetronomeSDK
             end
           end
 
-          # Indicates whether the parent should pay for the child's invoice charges
+          # Account hierarchy M3 - Indicates which customer should pay for the child's
+          # invoice charges
+          #
+          # **SELF**: The child pays for its own invoice charges
+          #
+          # **PARENT**: The parent pays for the child's invoice charges
           #
           # @see MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration#payer
           module Payer
@@ -1452,10 +1472,14 @@ module MetronomeSDK
             #   @return [Array<Symbol>]
           end
 
-          # Indicates the behavior of the child's invoice statements on the parent's
-          # invoices **CONSOLIDATE**: Child's invoice statements will be added to parent's
-          # consolidated invoices **SEPARATE**: Child's invoice statements will appear not
-          # appear on parent's consolidated invoices
+          # Account hierarchy M3 - Indicates the behavior of the child's invoice statements
+          # on the parent's invoices.
+          #
+          # **CONSOLIDATE**: Child's invoice statements will be added to parent's
+          # consolidated invoices
+          #
+          # **SEPARATE**: Child's invoice statements will appear not appear on parent's
+          # consolidated invoices
           #
           # @see MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration#usage_statement_behavior
           module UsageStatementBehavior
@@ -2223,20 +2247,26 @@ module MetronomeSDK
             required :subscription_id, String
 
             # @!attribute allocation
-            #   If set to POOLED, allocation added per seat is pooled across the account.
+            #   If set to POOLED, allocation added per seat is pooled across the account. (BETA)
+            #   If set to INDIVIDUAL, each seat in the subscription will have its own
+            #   allocation.
             #
             #   @return [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::Allocation, nil]
             optional :allocation,
                      enum: -> { MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::Allocation }
 
             # @!method initialize(apply_seat_increase_config:, subscription_id:, allocation: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig}
+            #   for more details.
+            #
             #   Attach a subscription to the recurring commit/credit.
             #
             #   @param apply_seat_increase_config [MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::ApplySeatIncreaseConfig]
             #
             #   @param subscription_id [String] ID of the subscription to configure on the recurring commit/credit.
             #
-            #   @param allocation [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::Allocation] If set to POOLED, allocation added per seat is pooled across the account.
+            #   @param allocation [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::Allocation] If set to POOLED, allocation added per seat is pooled across the account. (BETA)
 
             # @see MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig#apply_seat_increase_config
             class ApplySeatIncreaseConfig < MetronomeSDK::Internal::Type::BaseModel
@@ -2250,7 +2280,9 @@ module MetronomeSDK
               #   @param is_prorated [Boolean] Indicates whether a mid-period seat increase should be prorated.
             end
 
-            # If set to POOLED, allocation added per seat is pooled across the account.
+            # If set to POOLED, allocation added per seat is pooled across the account. (BETA)
+            # If set to INDIVIDUAL, each seat in the subscription will have its own
+            # allocation.
             #
             # @see MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig#allocation
             module Allocation
@@ -2564,20 +2596,26 @@ module MetronomeSDK
             required :subscription_id, String
 
             # @!attribute allocation
-            #   If set to POOLED, allocation added per seat is pooled across the account.
+            #   If set to POOLED, allocation added per seat is pooled across the account. (BETA)
+            #   If set to INDIVIDUAL, each seat in the subscription will have its own
+            #   allocation.
             #
             #   @return [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::Allocation, nil]
             optional :allocation,
                      enum: -> { MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::Allocation }
 
             # @!method initialize(apply_seat_increase_config:, subscription_id:, allocation: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig}
+            #   for more details.
+            #
             #   Attach a subscription to the recurring commit/credit.
             #
             #   @param apply_seat_increase_config [MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::ApplySeatIncreaseConfig]
             #
             #   @param subscription_id [String] ID of the subscription to configure on the recurring commit/credit.
             #
-            #   @param allocation [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::Allocation] If set to POOLED, allocation added per seat is pooled across the account.
+            #   @param allocation [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::Allocation] If set to POOLED, allocation added per seat is pooled across the account. (BETA)
 
             # @see MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig#apply_seat_increase_config
             class ApplySeatIncreaseConfig < MetronomeSDK::Internal::Type::BaseModel
@@ -2591,7 +2629,9 @@ module MetronomeSDK
               #   @param is_prorated [Boolean] Indicates whether a mid-period seat increase should be prorated.
             end
 
-            # If set to POOLED, allocation added per seat is pooled across the account.
+            # If set to POOLED, allocation added per seat is pooled across the account. (BETA)
+            # If set to INDIVIDUAL, each seat in the subscription will have its own
+            # allocation.
             #
             # @see MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig#allocation
             module Allocation
@@ -3034,6 +3074,11 @@ module MetronomeSDK
           #   QUANTITY_ONLY. **QUANTITY_ONLY**: The subscription quantity is specified
           #   directly on the subscription. `initial_quantity` must be provided with this
           #   option. Compatible with recurring commits/credits that use POOLED allocation.
+          #   **SEAT_BASED**: (BETA) Use when you want to pass specific seat identifiers (e.g.
+          #   add user_123) to increment and decrement a subscription quantity, rather than
+          #   directly providing the quantity. You must use a **SEAT_BASED** subscription to
+          #   use a linked recurring credit with an allocation per seat. `seat_config` must be
+          #   provided with this option.
           #
           #   @return [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::Subscription::QuantityManagementMode, nil]
           optional :quantity_management_mode,
@@ -3182,6 +3227,11 @@ module MetronomeSDK
           # QUANTITY_ONLY. **QUANTITY_ONLY**: The subscription quantity is specified
           # directly on the subscription. `initial_quantity` must be provided with this
           # option. Compatible with recurring commits/credits that use POOLED allocation.
+          # **SEAT_BASED**: (BETA) Use when you want to pass specific seat identifiers (e.g.
+          # add user_123) to increment and decrement a subscription quantity, rather than
+          # directly providing the quantity. You must use a **SEAT_BASED** subscription to
+          # use a linked recurring credit with an allocation per seat. `seat_config` must be
+          # provided with this option.
           #
           # @see MetronomeSDK::Models::V1::ContractCreateParams::Subscription#quantity_management_mode
           module QuantityManagementMode