metronome-sdk 3.8.0 → 3.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97f31a567a1ed13359a6db7517a0a31b47f7ab157d92e417fdfb60050869737a
-  data.tar.gz: b17e2f57bd7d2db609f95f5dcf5b165d6e050dd05eb717bab10148b450b19bb0
+  metadata.gz: b696954210f4bfed05c1d32c78ae7c38101e515f542781ff37cc49ef5b8aa64e
+  data.tar.gz: 6645acf1a6a3b40d2515f909f591ea74837837c5fcea90af965a363eb4e67e40
 SHA512:
-  metadata.gz: 771169e3edf3cbd87d0ce517fa9999c1303af4ad003ad278c58ad7239545f7157224e52646b1db43fc7b17db0af0d038cdda41d66bc6115038cb39ba48123843
-  data.tar.gz: 8b0180525f48ed9bf872de4bf2f29c6b504f20eef0dd1acc013d526115dfb34b3839dca5c0e20d0a8ec2248ea6968678b919a2881c7ab801b637eb72f2abd17f
+  metadata.gz: aa99380e1a02c6e89b1633b002eecd1a3f20ae850141c302ed1dda4520eef09bf3de437944db64e381a0817afa963648a2b8d53d4d91e767621972015b274a94
+  data.tar.gz: 5ead08a83536b93ce7b43d66964e8f132632c4a6846059a08be8e3d2f2b6af6389988a0a709af4b19d9094d902a20bd4cc28384a8a815f465fb33314c1834dac

data/CHANGELOG.md

@@ -1,5 +1,39 @@
 # Changelog
 
+## 3.10.0 (2026-07-23)
+
+Full Changelog: [v3.9.0...v3.10.0](https://github.com/Metronome-Industries/metronome-ruby/compare/v3.9.0...v3.10.0)
+
+### Features
+
+* [ORCH-2018] fixes type issues created from breaking gql changes ([f21c903](https://github.com/Metronome-Industries/metronome-ruby/commit/f21c90353a4ad56440c447b713624df8b1583f3f))
+* Add add_credit_type_conversions field to update_rate_card ([f9d1ca5](https://github.com/Metronome-Industries/metronome-ruby/commit/f9d1ca5a365285e27b63f89a1720e98e2685f3e4))
+* Add cost_basis to commits ([276ba9b](https://github.com/Metronome-Industries/metronome-ruby/commit/276ba9b96f7784fa142a6ed5caf1fbe9edf32df5))
+* Add daily recurring commit description to docs ([22ce79a](https://github.com/Metronome-Industries/metronome-ruby/commit/22ce79af31f1e1585ee16d53ea8103e23b9141ee))
+* add stlc SDK generation workflow to api repo ([fe49163](https://github.com/Metronome-Industries/metronome-ruby/commit/fe49163f7be32e3eb9248c19b77d8d73a9c53687))
+* Docs: embeddable dashboard doc updates ([6cdc3fb](https://github.com/Metronome-Industries/metronome-ruby/commit/6cdc3fbb56a486febbcb27b6c40b2169b965df93))
+* Kmd/remove supersede from contract transition ([260c042](https://github.com/Metronome-Industries/metronome-ruby/commit/260c042cf1c63a78a9eb4687b78d11c07544af45))
+* Plumb applicable_contract_ids in edit customer commit ([b35217d](https://github.com/Metronome-Industries/metronome-ruby/commit/b35217d2002003b7bbe3432a3bc2bcff3599999f))
+* **stlc:** configurable CI runner and private-production-repo support in workflow templates ([702930f](https://github.com/Metronome-Industries/metronome-ruby/commit/702930fbea60e526f6bdbd68bc1d3fceb7c1355b))
+
+
+### Bug Fixes
+
+* remove webhook config that overwrites custom code ([d015d08](https://github.com/Metronome-Industries/metronome-ruby/commit/d015d08d5b3b8279626635a9e4136cce74fc5bbb))
+
+
+### Chores
+
+* update tracking files for promote workflow ([3b6573c](https://github.com/Metronome-Industries/metronome-ruby/commit/3b6573c4116bbe414677ac23afa186ad5f106b40))
+
+## 3.9.0 (2026-07-02)
+
+Full Changelog: [v3.8.0...v3.9.0](https://github.com/Metronome-Industries/metronome-ruby/compare/v3.8.0...v3.9.0)
+
+### Features
+
+* [ORCH-1875] add billing config schedule to api ([d99c67a](https://github.com/Metronome-Industries/metronome-ruby/commit/d99c67a326f711abccba75cac0d8bb840a79583d))
+
 ## 3.8.0 (2026-06-29)
 
 Full Changelog: [v3.7.0...v3.8.0](https://github.com/Metronome-Industries/metronome-ruby/compare/v3.7.0...v3.8.0)

data/README.md

@@ -26,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", "~> 3.8.0"
+gem "metronome-sdk", "~> 3.10.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/metronome_sdk/models/commit.rb

@@ -81,6 +81,12 @@ module MetronomeSDK
       #   @return [MetronomeSDK::Models::Commit::Contract, nil]
       optional :contract, -> { MetronomeSDK::Commit::Contract }
 
+      # @!attribute cost_basis
+      #   The ratio of the amount paid for the commit to the amount of credit granted.
+      #
+      #   @return [Float, nil]
+      optional :cost_basis, Float
+
       # @!attribute created_by
       #   The actor who created this commit. Omitted for system-generated commits such as
       #   recurring commits, rollover commits, and threshold commits.
@@ -200,7 +206,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, created_by: nil, custom_fields: nil, description: nil, hierarchy_configuration: nil, invoice_contract: nil, invoice_schedule: nil, ledger: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, rate_type: nil, recurring_commit_id: nil, rolled_over_from: nil, rollover_fraction: nil, salesforce_opportunity_id: nil, specifiers: nil, spend_tracker_attributes: nil, subscription_config: nil, uniqueness_key: nil)
+      # @!method initialize(id:, created_at:, product:, type:, access_schedule: nil, amount: nil, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, archived_at: nil, balance: nil, contract: nil, cost_basis: nil, created_by: nil, custom_fields: nil, description: nil, hierarchy_configuration: nil, invoice_contract: nil, invoice_schedule: nil, ledger: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, rate_type: nil, recurring_commit_id: nil, rolled_over_from: nil, rollover_fraction: nil, salesforce_opportunity_id: nil, specifiers: nil, spend_tracker_attributes: nil, subscription_config: nil, uniqueness_key: nil)
       #   Some parameter documentations has been truncated, see
       #   {MetronomeSDK::Models::Commit} for more details.
       #
@@ -228,6 +234,8 @@ module MetronomeSDK
       #
       #   @param contract [MetronomeSDK::Models::Commit::Contract]
       #
+      #   @param cost_basis [Float] The ratio of the amount paid for the commit to the amount of credit granted.
+      #
       #   @param created_by [String] The actor who created this commit. Omitted for system-generated commits such as
       #
       #   @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }

data/lib/metronome_sdk/models/contract.rb

@@ -42,7 +42,6 @@ module MetronomeSDK
       optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
 
       # @!attribute customer_billing_provider_configuration
-      #   The billing provider configuration associated with a contract.
       #
       #   @return [MetronomeSDK::Models::Contract::CustomerBillingProviderConfiguration, nil]
       optional :customer_billing_provider_configuration,
@@ -115,7 +114,7 @@ module MetronomeSDK
       #
       #   @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
       #
-      #   @param customer_billing_provider_configuration [MetronomeSDK::Models::Contract::CustomerBillingProviderConfiguration] The billing provider configuration associated with a contract.
+      #   @param customer_billing_provider_configuration [MetronomeSDK::Models::Contract::CustomerBillingProviderConfiguration]
       #
       #   @param package_id [String] ID of the package this contract was created from, if applicable.
       #
@@ -316,52 +315,81 @@ module MetronomeSDK
 
       # @see MetronomeSDK::Models::Contract#customer_billing_provider_configuration
       class CustomerBillingProviderConfiguration < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   ID of this configuration; can be provided as the
+        #   billing_provider_configuration_id when creating a contract.
+        #
+        #   @return [String]
+        required :id, String
+
         # @!attribute archived_at
         #
         #   @return [Time, nil]
         required :archived_at, Time, nil?: true
 
         # @!attribute billing_provider
+        #   The billing provider set for this configuration.
         #
         #   @return [Symbol, MetronomeSDK::Models::Contract::CustomerBillingProviderConfiguration::BillingProvider]
         required :billing_provider,
                  enum: -> { MetronomeSDK::Contract::CustomerBillingProviderConfiguration::BillingProvider }
 
+        # @!attribute configuration
+        #   Configuration for the billing provider. The structure of this object is specific
+        #   to the billing provider.
+        #
+        #   @return [Hash{Symbol=>Object}]
+        required :configuration, MetronomeSDK::Internal::Type::HashOf[MetronomeSDK::Internal::Type::Unknown]
+
+        # @!attribute customer_id
+        #
+        #   @return [String]
+        required :customer_id, String
+
         # @!attribute delivery_method
+        #   The method to use for delivering invoices to this customer.
         #
         #   @return [Symbol, MetronomeSDK::Models::Contract::CustomerBillingProviderConfiguration::DeliveryMethod]
         required :delivery_method,
                  enum: -> { MetronomeSDK::Contract::CustomerBillingProviderConfiguration::DeliveryMethod }
 
-        # @!attribute id
+        # @!attribute delivery_method_configuration
+        #   Configuration for the delivery method. The structure of this object is specific
+        #   to the delivery method.
         #
-        #   @return [String, nil]
-        optional :id, String
+        #   @return [Hash{Symbol=>Object}]
+        required :delivery_method_configuration,
+                 MetronomeSDK::Internal::Type::HashOf[MetronomeSDK::Internal::Type::Unknown]
 
-        # @!attribute configuration
-        #   Configuration for the billing provider. The structure of this object is specific
-        #   to the billing provider.
+        # @!attribute delivery_method_id
+        #   ID of the delivery method to use for this customer.
         #
-        #   @return [Hash{Symbol=>Object}, nil]
-        optional :configuration, MetronomeSDK::Internal::Type::HashOf[MetronomeSDK::Internal::Type::Unknown]
+        #   @return [String]
+        required :delivery_method_id, String
 
-        # @!method initialize(archived_at:, billing_provider:, delivery_method:, id: nil, configuration: nil)
+        # @!method initialize(id:, archived_at:, billing_provider:, configuration:, customer_id:, delivery_method:, delivery_method_configuration:, delivery_method_id:)
         #   Some parameter documentations has been truncated, see
         #   {MetronomeSDK::Models::Contract::CustomerBillingProviderConfiguration} for more
         #   details.
         #
-        #   The billing provider configuration associated with a contract.
+        #   @param id [String] ID of this configuration; can be provided as the billing*provider_configuration*
         #
         #   @param archived_at [Time, nil]
         #
-        #   @param billing_provider [Symbol, MetronomeSDK::Models::Contract::CustomerBillingProviderConfiguration::BillingProvider]
+        #   @param billing_provider [Symbol, MetronomeSDK::Models::Contract::CustomerBillingProviderConfiguration::BillingProvider] The billing provider set for this configuration.
         #
-        #   @param delivery_method [Symbol, MetronomeSDK::Models::Contract::CustomerBillingProviderConfiguration::DeliveryMethod]
+        #   @param configuration [Hash{Symbol=>Object}] Configuration for the billing provider. The structure of this object is specific
         #
-        #   @param id [String]
+        #   @param customer_id [String]
         #
-        #   @param configuration [Hash{Symbol=>Object}] Configuration for the billing provider. The structure of this object is specific
+        #   @param delivery_method [Symbol, MetronomeSDK::Models::Contract::CustomerBillingProviderConfiguration::DeliveryMethod] The method to use for delivering invoices to this customer.
+        #
+        #   @param delivery_method_configuration [Hash{Symbol=>Object}] Configuration for the delivery method. The structure of this object is specific
+        #
+        #   @param delivery_method_id [String] ID of the delivery method to use for this customer.
 
+        # The billing provider set for this configuration.
+        #
         # @see MetronomeSDK::Models::Contract::CustomerBillingProviderConfiguration#billing_provider
         module BillingProvider
           extend MetronomeSDK::Internal::Type::Enum
@@ -380,6 +408,8 @@ module MetronomeSDK
           #   @return [Array<Symbol>]
         end
 
+        # The method to use for delivering invoices to this customer.
+        #
         # @see MetronomeSDK::Models::Contract::CustomerBillingProviderConfiguration#delivery_method
         module DeliveryMethod
           extend MetronomeSDK::Internal::Type::Enum