metronome-sdk 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0915b00a0f26162aace25f837292b0a4397ebd7e62179d9b8b3605a322ecfa1d'
-  data.tar.gz: 8d0580f9ba5e72ca8eb0729c8664aff99b00bee910368df5a692e4b2fab6740b
+  metadata.gz: 24c53b426a786c58cd7f8d4ae93526596c3a4fa93b6b662e5de17309317f36e5
+  data.tar.gz: 1409a92e54deccc0ae37945c293b208cf27149114eae2509af99fe87a4584ece
 SHA512:
-  metadata.gz: 51ff71fc9926d302ef837596298dfa6eea80c52200b0861e51b4d6f399be2d276f04987ae40c0346eef2f3f5cdc18cce603b44bfb4c99fb123b20e5c3c7b5983
-  data.tar.gz: 6a93ca533bf883619baecd64f06f6b51811676a2f8872cb5205d5ac64b52136a3f27f392671eb7deae4784e7af780cec40df66d3fa1f9b53c6162087a3dc893f
+  metadata.gz: 7472b69ef8d4e84138a0b0818d3cf770268065044819e86804727fc00dc92c66b4f1e36ffac58131da73983ab124d3872aae8054bbc4731581aab51168eb08b3
+  data.tar.gz: 5cffe8618d7460adf817768b5a91d0d478c1ed1103211571def61d3e76c5fa31adf91847158d62e188fd170edc88d718f1501c5966249314acd45f92dfa1a716

data/CHANGELOG.md

@@ -1,5 +1,80 @@
 # Changelog
 
+## 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)
+
+### Features
+
+* [ORCH-605] uses x-mint groups to enable conditional rendering of gated revenue system config apis ([22ceee8](https://github.com/Metronome-Industries/metronome-ruby/commit/22ceee870bf6b1642ff4283b37485be599658e47))
+* [ORCH-752] Update contract creation endpoints to allow setting revenue system configuration ([c2ca4f7](https://github.com/Metronome-Industries/metronome-ruby/commit/c2ca4f7ef46b0ead89b74a6e75a37a2ba55d9dc8))
+* Add `commit_transactions` to the body of `/upsertAvalaraCredentials` endpoint ([d99cab3](https://github.com/Metronome-Industries/metronome-ruby/commit/d99cab3cda4f2da4f80ec925c76583e31ea1763a))
+* Add `seat_filter` field to creation request and response parameters of the alert object ([165e3f0](https://github.com/Metronome-Industries/metronome-ruby/commit/165e3f0deab903b00fb7b4b235179b52a4f8093f))
+* add quantity to plan pricing adjustment response ([cbf2539](https://github.com/Metronome-Industries/metronome-ruby/commit/cbf2539bbab6fac9f0d4984cd0f88c9f6b0ceea2))
+* adds external_payment_id to ExternalInvoice ([ff5f18f](https://github.com/Metronome-Industries/metronome-ruby/commit/ff5f18f6b14e08b4c499689ca329b357a03177a9))
+* everything ([6188141](https://github.com/Metronome-Industries/metronome-ruby/commit/618814115adbe126a1b0b5a330244034a14c98f7))
+* GET-6845 get openapi specs ready for GA ([dc48f09](https://github.com/Metronome-Industries/metronome-ruby/commit/dc48f094c3283251a7f452aa4cc3db917ee7eba6))
+* include aggregation BM info from searchEvents ([ea0dfc0](https://github.com/Metronome-Industries/metronome-ruby/commit/ea0dfc021a244b0e0d3ebfbcdacfc053f5194b61))
+* ORCH-833/948/946/947 - updated the API to accept aws_customer_account_id all gated behind a feature flag ([4c2e292](https://github.com/Metronome-Industries/metronome-ruby/commit/4c2e2926ed8b6d0844b3670312f9780f14df2beb))
+* remove beta language, FF, stainless skip ([b504def](https://github.com/Metronome-Industries/metronome-ruby/commit/b504defa5b97aa3f622bbc746e76ac12691d1e90))
+* Return values for set customer billing configuration endpoint ([1641a74](https://github.com/Metronome-Industries/metronome-ruby/commit/1641a74439ebf507fb85f0478bbd056f6047c173))
+* update create alert api to allow LowRemainingSeatBalanceReached alert ([54a60e6](https://github.com/Metronome-Industries/metronome-ruby/commit/54a60e6027b889e61554b7a006c780e3a9fc4815))
+
+
+### Bug Fixes
+
+* better thread safety via early initializing SSL store during HTTP client creation ([341992d](https://github.com/Metronome-Industries/metronome-ruby/commit/341992d633b9191d24209713f5f6a734d2229601))
+* calling `break` out of streams should be instantaneous ([0db918b](https://github.com/Metronome-Industries/metronome-ruby/commit/0db918bb075b3420715faf0e73ef96cc01d58697))
+* issue where json.parse errors when receiving HTTP 204 with nobody ([7a27bb6](https://github.com/Metronome-Industries/metronome-ruby/commit/7a27bb648e886deaf33358cde8f5c3c5d80ccf42))
+
+
+### Chores
+
+* **client:** send user-agent header ([379e4e4](https://github.com/Metronome-Industries/metronome-ruby/commit/379e4e46eb858bce94633dd193fbc1526ea1c42c))
+* explicitly require "base64" gem ([5d4a7dc](https://github.com/Metronome-Industries/metronome-ruby/commit/5d4a7dc568346f2fc33ab39cf1517582923d98d5))
+* **internal:** codegen related update ([9878983](https://github.com/Metronome-Industries/metronome-ruby/commit/9878983e4d67b0d04d543d7a49afdd14e9eb4f73))
+
+
+### Documentation
+
+* document missing fields for schemas related to recurring credits and commits ([d848e15](https://github.com/Metronome-Industries/metronome-ruby/commit/d848e159b2046aebccea5d2b3915779adf891791))
+
+## 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.2.0"
 ```
 
 <!-- x-release-please-end -->

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

@@ -201,7 +201,8 @@ module MetronomeSDK
             self.class::PLATFORM_HEADERS,
             {
               "accept" => "application/json",
-              "content-type" => "application/json"
+              "content-type" => "application/json",
+              "user-agent" => user_agent
             },
             headers
           )
@@ -219,6 +220,11 @@ module MetronomeSDK
         # @return [Hash{String=>String}]
         private def auth_headers = {}
 
+        # @api private
+        #
+        # @return [String]
+        private def user_agent = "#{self.class.name}/Ruby #{MetronomeSDK::VERSION}"
+
         # @api private
         #
         # @return [String]

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

@@ -16,10 +16,11 @@ module MetronomeSDK
         class << self
           # @api private
           #
+          # @param cert_store [OpenSSL::X509::Store]
           # @param url [URI::Generic]
           #
           # @return [Net::HTTP]
-          def connect(url)
+          def connect(cert_store:, url:)
             port =
               case [url.port, url.scheme]
               in [Integer, _]
@@ -33,6 +34,8 @@ module MetronomeSDK
             Net::HTTP.new(url.host, port).tap do
               _1.use_ssl = %w[https wss].include?(url.scheme)
               _1.max_retries = 0
+
+              (_1.cert_store = cert_store) if _1.use_ssl?
             end
           end
 
@@ -102,7 +105,7 @@ module MetronomeSDK
           pool =
             @mutex.synchronize do
               @pools[origin] ||= ConnectionPool.new(size: @size) do
-                self.class.connect(url)
+                self.class.connect(cert_store: @cert_store, url: url)
               end
             end
 
@@ -128,40 +131,50 @@ 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)
+                  ::Kernel.catch(:jump) do
+                    conn.request(req) do |rsp|
+                      y << [req, rsp]
+                      ::Kernel.throw(:jump) if finished
+
+                      rsp.read_body do |bytes|
+                        y << bytes.force_encoding(Encoding::BINARY)
+                        ::Kernel.throw(:jump) if finished
+
+                        self.class.calibrate_socket_timeout(conn, deadline)
+                      end
+                      eof = true
+                    end
+                  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 +187,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
@@ -186,6 +197,7 @@ module MetronomeSDK
         def initialize(size: self.class::DEFAULT_MAX_CONNECTIONS)
           @mutex = Mutex.new
           @size = size
+          @cert_store = OpenSSL::X509::Store.new.tap(&:set_default_paths)
           @pools = {}
         end
 

data/lib/metronome_sdk/internal/util.rb

@@ -657,7 +657,8 @@ module MetronomeSDK
         def decode_content(headers, stream:, suppress_error: false)
           case (content_type = headers["content-type"])
           in MetronomeSDK::Internal::Util::JSON_CONTENT
-            json = stream.to_a.join
+            return nil if (json = stream.to_a.join).empty?
+
             begin
               JSON.parse(json, symbolize_names: true)
             rescue JSON::ParserError => e
@@ -667,7 +668,11 @@ module MetronomeSDK
           in MetronomeSDK::Internal::Util::JSONL_CONTENT
             lines = decode_lines(stream)
             chain_fused(lines) do |y|
-              lines.each { y << JSON.parse(_1, symbolize_names: true) }
+              lines.each do
+                next if _1.empty?
+
+                y << JSON.parse(_1, symbolize_names: true)
+              end
             end
           in %r{^text/event-stream}
             lines = decode_lines(stream)

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

@@ -445,7 +445,13 @@ module MetronomeSDK
         #   @return [Array<MetronomeSDK::Models::CommitSpecifier>, nil]
         optional :specifiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifier] }
 
-        # @!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)
+        # @!attribute subscription_config
+        #   Attach a subscription to the recurring commit/credit.
+        #
+        #   @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)
         #   Some parameter documentations has been truncated, see
         #   {MetronomeSDK::Models::ContractV2::Commit} for more details.
         #
@@ -498,6 +504,8 @@ module MetronomeSDK
         #   @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::RecurringCommitSubscriptionConfig] Attach a subscription to the recurring commit/credit.
 
         # @see MetronomeSDK::Models::ContractV2::Commit#product
         class Product < MetronomeSDK::Internal::Type::BaseModel
@@ -1646,6 +1654,15 @@ module MetronomeSDK
         #   @return [MetronomeSDK::Models::ContractV2::Credit::Contract, nil]
         optional :contract, -> { MetronomeSDK::ContractV2::Credit::Contract }
 
+        # @!attribute created_at
+        #   Timestamp of when the credit was created.
+        #
+        #   - Recurring credits: latter of credit service period date and parent credit
+        #     start date
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time
+
         # @!attribute custom_fields
         #   Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
         #
@@ -1703,7 +1720,13 @@ module MetronomeSDK
         #   @return [Array<MetronomeSDK::Models::CommitSpecifier>, nil]
         optional :specifiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifier] }
 
-        # @!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, salesforce_opportunity_id: nil, specifiers: nil)
+        # @!attribute subscription_config
+        #   Attach a subscription to the recurring commit/credit.
+        #
+        #   @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)
         #   Some parameter documentations has been truncated, see
         #   {MetronomeSDK::Models::ContractV2::Credit} for more details.
         #
@@ -1725,6 +1748,8 @@ module MetronomeSDK
         #
         #   @param contract [MetronomeSDK::Models::ContractV2::Credit::Contract]
         #
+        #   @param created_at [Time] Timestamp of when the credit was created.
+        #
         #   @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
         #
         #   @param description [String]
@@ -1742,6 +1767,8 @@ module MetronomeSDK
         #   @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::RecurringCommitSubscriptionConfig] Attach a subscription to the recurring commit/credit.
 
         # @see MetronomeSDK::Models::ContractV2::Credit#product
         class Product < MetronomeSDK::Internal::Type::BaseModel
@@ -2148,6 +2175,7 @@ module MetronomeSDK
           QUICKBOOKS_ONLINE = :quickbooks_online
           WORKDAY = :workday
           GCP_MARKETPLACE = :gcp_marketplace
+          METRONOME = :metronome
 
           # @!method self.values
           #   @return [Array<Symbol>]
@@ -2246,10 +2274,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 +2291,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 +2323,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 +2352,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 +2375,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 +2390,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