metronome-sdk 2.1.0 → 3.0.0

data/lib/metronome_sdk/resources/v2/contracts.rb

@@ -228,7 +228,7 @@ module MetronomeSDK
         #   finalized invoice. You can void the invoice beforehand and then remove the
         #   access schedule segment.
         #
-        # @overload edit_commit(commit_id:, customer_id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, hierarchy_configuration: nil, invoice_contract_id: nil, invoice_schedule: nil, priority: nil, product_id: nil, rate_type: nil, specifiers: nil, request_options: {})
+        # @overload edit_commit(commit_id:, customer_id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, description: nil, hierarchy_configuration: nil, invoice_contract_id: nil, invoice_schedule: nil, name: nil, priority: nil, product_id: nil, rate_type: nil, specifiers: nil, request_options: {})
         #
         # @param commit_id [String] ID of the commit to edit
         #
@@ -240,12 +240,16 @@ module MetronomeSDK
         #
         # @param applicable_product_tags [Array<String>, nil] Which tags the commit applies to. If applicable*product_ids, applicable_product*
         #
+        # @param description [String] Updated description for the commit
+        #
         # @param hierarchy_configuration [MetronomeSDK::Models::CommitHierarchyConfiguration] Optional configuration for commit hierarchy access control
         #
         # @param invoice_contract_id [String] ID of contract to use for invoicing
         #
         # @param invoice_schedule [MetronomeSDK::Models::V2::ContractEditCommitParams::InvoiceSchedule]
         #
+        # @param name [String] Updated name for the commit
+        #
         # @param priority [Float, nil] If multiple commits are applicable, the one with the lower priority will apply f
         #
         # @param product_id [String]
@@ -290,7 +294,7 @@ module MetronomeSDK
         #   invoice. You can void the invoice beforehand and then remove the access
         #   schedule segment.
         #
-        # @overload edit_credit(credit_id:, customer_id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, hierarchy_configuration: nil, priority: nil, product_id: nil, rate_type: nil, specifiers: nil, request_options: {})
+        # @overload edit_credit(credit_id:, customer_id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, description: nil, hierarchy_configuration: nil, name: nil, priority: nil, product_id: nil, rate_type: nil, specifiers: nil, request_options: {})
         #
         # @param credit_id [String] ID of the credit to edit
         #
@@ -302,8 +306,12 @@ module MetronomeSDK
         #
         # @param applicable_product_tags [Array<String>, nil] Which tags the credit applies to. If both applicable*product_ids and applicable*
         #
+        # @param description [String] Updated description for the credit
+        #
         # @param hierarchy_configuration [MetronomeSDK::Models::CommitHierarchyConfiguration] Optional configuration for credit hierarchy access control
         #
+        # @param name [String] Updated name for the credit
+        #
         # @param priority [Float, nil] If multiple commits are applicable, the one with the lower priority will apply f
         #
         # @param product_id [String]

data/lib/metronome_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MetronomeSDK
-  VERSION = "2.1.0"
+  VERSION = "3.0.0"
 end

data/lib/metronome_sdk.rb

@@ -3,12 +3,14 @@
 # Standard libraries.
 # rubocop:disable Lint/RedundantRequireStatement
 require "English"
+require "base64"
 require "cgi"
 require "date"
 require "erb"
 require "etc"
 require "json"
 require "net/http"
+require "openssl"
 require "pathname"
 require "rbconfig"
 require "securerandom"
@@ -235,6 +237,7 @@ require_relative "metronome_sdk/models/v1/customers/plan_list_price_adjustments_
 require_relative "metronome_sdk/models/v1/customers/plan_list_price_adjustments_response"
 require_relative "metronome_sdk/models/v1/customers/plan_list_response"
 require_relative "metronome_sdk/models/v1/customer_set_billing_configurations_params"
+require_relative "metronome_sdk/models/v1/customer_set_billing_configurations_response"
 require_relative "metronome_sdk/models/v1/customer_set_ingest_aliases_params"
 require_relative "metronome_sdk/models/v1/customer_set_name_params"
 require_relative "metronome_sdk/models/v1/customer_set_name_response"

data/manifest.yaml

@@ -1,11 +1,13 @@
 dependencies:
   - English
+  - base64
   - cgi
   - date
   - erb
   - etc
   - json
   - net/http
+  - openssl
   - pathname
   - rbconfig
   - securerandom

data/rbi/metronome_sdk/internal/transport/base_client.rbi

@@ -180,6 +180,11 @@ module MetronomeSDK
         private def auth_headers
         end
 
+        # @api private
+        sig { returns(String) }
+        private def user_agent
+        end
+
         # @api private
         sig { returns(String) }
         private def generate_idempotency_key

data/rbi/metronome_sdk/internal/transport/pooled_net_requester.rbi

@@ -26,8 +26,12 @@ module MetronomeSDK
 
         class << self
           # @api private
-          sig { params(url: URI::Generic).returns(Net::HTTP) }
-          def connect(url)
+          sig do
+            params(cert_store: OpenSSL::X509::Store, url: URI::Generic).returns(
+              Net::HTTP
+            )
+          end
+          def connect(cert_store:, url:)
           end
 
           # @api private

data/rbi/metronome_sdk/internal/type/base_model.rbi

@@ -31,7 +31,7 @@ module MetronomeSDK
           #
           # Assumes superclass fields are totally defined before fields are accessed /
           # defined on subclasses.
-          sig { params(child: T.self_type).void }
+          sig { params(child: MetronomeSDK::Internal::Type::BaseModel).void }
           def inherited(child)
           end
 
@@ -282,9 +282,13 @@ module MetronomeSDK
 
         # Create a new instance of a model.
         sig do
-          params(data: T.any(T::Hash[Symbol, T.anything], T.self_type)).returns(
-            T.attached_class
-          )
+          params(
+            data:
+              T.any(
+                T::Hash[Symbol, T.anything],
+                MetronomeSDK::Internal::Type::BaseModel
+              )
+          ).returns(T.attached_class)
         end
         def self.new(data = {})
         end

data/rbi/metronome_sdk/models/commit.rbi

@@ -195,6 +195,14 @@ module MetronomeSDK
       sig { params(rate_type: MetronomeSDK::Commit::RateType::OrSymbol).void }
       attr_writer :rate_type
 
+      # The ID of the recurring commit that this commit was generated from, if
+      # applicable.
+      sig { returns(T.nilable(String)) }
+      attr_reader :recurring_commit_id
+
+      sig { params(recurring_commit_id: String).void }
+      attr_writer :recurring_commit_id
+
       sig { returns(T.nilable(MetronomeSDK::Commit::RolledOverFrom)) }
       attr_reader :rolled_over_from
 
@@ -229,6 +237,18 @@ module MetronomeSDK
       end
       attr_writer :specifiers
 
+      # The subscription configuration for this commit, if it was generated from a
+      # recurring commit with a subscription attached.
+      sig { returns(T.nilable(MetronomeSDK::Commit::SubscriptionConfig)) }
+      attr_reader :subscription_config
+
+      sig do
+        params(
+          subscription_config: MetronomeSDK::Commit::SubscriptionConfig::OrHash
+        ).void
+      end
+      attr_writer :subscription_config
+
       # 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
       # credit, a new record will not be created and the request will fail with a 409
@@ -282,10 +302,12 @@ module MetronomeSDK
           netsuite_sales_order_id: String,
           priority: Float,
           rate_type: MetronomeSDK::Commit::RateType::OrSymbol,
+          recurring_commit_id: String,
           rolled_over_from: MetronomeSDK::Commit::RolledOverFrom::OrHash,
           rollover_fraction: Float,
           salesforce_opportunity_id: String,
           specifiers: T::Array[MetronomeSDK::CommitSpecifier::OrHash],
+          subscription_config: MetronomeSDK::Commit::SubscriptionConfig::OrHash,
           uniqueness_key: String
         ).returns(T.attached_class)
       end
@@ -339,6 +361,9 @@ module MetronomeSDK
         # will apply first.
         priority: nil,
         rate_type: nil,
+        # The ID of the recurring commit that this commit was generated from, if
+        # applicable.
+        recurring_commit_id: nil,
         rolled_over_from: nil,
         rollover_fraction: nil,
         # This field's availability is dependent on your client's configuration.
@@ -347,6 +372,9 @@ module MetronomeSDK
         # or credit. A customer's usage needs to meet the condition of at least one of the
         # specifiers to contribute to a commit's or credit's drawdown.
         specifiers: nil,
+        # The subscription configuration for this commit, if it was generated from a
+        # recurring commit with a subscription attached.
+        subscription_config: nil,
         # 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
         # credit, a new record will not be created and the request will fail with a 409
@@ -380,10 +408,12 @@ module MetronomeSDK
             netsuite_sales_order_id: String,
             priority: Float,
             rate_type: MetronomeSDK::Commit::RateType::TaggedSymbol,
+            recurring_commit_id: String,
             rolled_over_from: MetronomeSDK::Commit::RolledOverFrom,
             rollover_fraction: Float,
             salesforce_opportunity_id: String,
             specifiers: T::Array[MetronomeSDK::CommitSpecifier],
+            subscription_config: MetronomeSDK::Commit::SubscriptionConfig,
             uniqueness_key: String
           }
         )
@@ -1793,6 +1823,147 @@ module MetronomeSDK
         def to_hash
         end
       end
+
+      class SubscriptionConfig < MetronomeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::Commit::SubscriptionConfig,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T.nilable(
+              MetronomeSDK::Commit::SubscriptionConfig::Allocation::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :allocation
+
+        sig do
+          params(
+            allocation:
+              MetronomeSDK::Commit::SubscriptionConfig::Allocation::OrSymbol
+          ).void
+        end
+        attr_writer :allocation
+
+        sig do
+          returns(
+            T.nilable(
+              MetronomeSDK::Commit::SubscriptionConfig::ApplySeatIncreaseConfig
+            )
+          )
+        end
+        attr_reader :apply_seat_increase_config
+
+        sig do
+          params(
+            apply_seat_increase_config:
+              MetronomeSDK::Commit::SubscriptionConfig::ApplySeatIncreaseConfig::OrHash
+          ).void
+        end
+        attr_writer :apply_seat_increase_config
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :subscription_id
+
+        sig { params(subscription_id: String).void }
+        attr_writer :subscription_id
+
+        # The subscription configuration for this commit, if it was generated from a
+        # recurring commit with a subscription attached.
+        sig do
+          params(
+            allocation:
+              MetronomeSDK::Commit::SubscriptionConfig::Allocation::OrSymbol,
+            apply_seat_increase_config:
+              MetronomeSDK::Commit::SubscriptionConfig::ApplySeatIncreaseConfig::OrHash,
+            subscription_id: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          allocation: nil,
+          apply_seat_increase_config: nil,
+          subscription_id: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              allocation:
+                MetronomeSDK::Commit::SubscriptionConfig::Allocation::TaggedSymbol,
+              apply_seat_increase_config:
+                MetronomeSDK::Commit::SubscriptionConfig::ApplySeatIncreaseConfig,
+              subscription_id: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Allocation
+          extend MetronomeSDK::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                MetronomeSDK::Commit::SubscriptionConfig::Allocation
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          INDIVIDUAL =
+            T.let(
+              :INDIVIDUAL,
+              MetronomeSDK::Commit::SubscriptionConfig::Allocation::TaggedSymbol
+            )
+          POOLED =
+            T.let(
+              :POOLED,
+              MetronomeSDK::Commit::SubscriptionConfig::Allocation::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                MetronomeSDK::Commit::SubscriptionConfig::Allocation::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class ApplySeatIncreaseConfig < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::Commit::SubscriptionConfig::ApplySeatIncreaseConfig,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          # Indicates whether a mid-period seat increase should be prorated.
+          sig { returns(T::Boolean) }
+          attr_accessor :is_prorated
+
+          sig { params(is_prorated: T::Boolean).returns(T.attached_class) }
+          def self.new(
+            # Indicates whether a mid-period seat increase should be prorated.
+            is_prorated:
+          )
+          end
+
+          sig { override.returns({ is_prorated: T::Boolean }) }
+          def to_hash
+          end
+        end
+      end
     end
   end
 end

data/rbi/metronome_sdk/models/contract_v2.rbi

@@ -691,6 +691,13 @@ module MetronomeSDK
         end
         attr_writer :rate_type
 
+        # The ID of the recurring commit that created this commit
+        sig { returns(T.nilable(String)) }
+        attr_reader :recurring_commit_id
+
+        sig { params(recurring_commit_id: String).void }
+        attr_writer :recurring_commit_id
+
         sig do
           returns(T.nilable(MetronomeSDK::ContractV2::Commit::RolledOverFrom))
         end
@@ -730,6 +737,20 @@ module MetronomeSDK
         end
         attr_writer :specifiers
 
+        # Attach a subscription to the recurring commit/credit.
+        sig do
+          returns(T.nilable(MetronomeSDK::RecurringCommitSubscriptionConfig))
+        end
+        attr_reader :subscription_config
+
+        sig do
+          params(
+            subscription_config:
+              MetronomeSDK::RecurringCommitSubscriptionConfig::OrHash
+          ).void
+        end
+        attr_writer :subscription_config
+
         sig do
           params(
             id: String,
@@ -773,11 +794,14 @@ module MetronomeSDK
             netsuite_sales_order_id: String,
             priority: Float,
             rate_type: MetronomeSDK::ContractV2::Commit::RateType::OrSymbol,
+            recurring_commit_id: String,
             rolled_over_from:
               MetronomeSDK::ContractV2::Commit::RolledOverFrom::OrHash,
             rollover_fraction: Float,
             salesforce_opportunity_id: String,
-            specifiers: T::Array[MetronomeSDK::CommitSpecifier::OrHash]
+            specifiers: T::Array[MetronomeSDK::CommitSpecifier::OrHash],
+            subscription_config:
+              MetronomeSDK::RecurringCommitSubscriptionConfig::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
@@ -826,6 +850,8 @@ module MetronomeSDK
           # will apply first.
           priority: nil,
           rate_type: nil,
+          # The ID of the recurring commit that created this commit
+          recurring_commit_id: nil,
           rolled_over_from: nil,
           rollover_fraction: nil,
           # This field's availability is dependent on your client's configuration.
@@ -833,7 +859,9 @@ module MetronomeSDK
           # List of filters that determine what kind of customer usage draws down a commit
           # or credit. A customer's usage needs to meet the condition of at least one of the
           # specifiers to contribute to a commit's or credit's drawdown.
-          specifiers: nil
+          specifiers: nil,
+          # Attach a subscription to the recurring commit/credit.
+          subscription_config: nil
         )
         end
 
@@ -865,11 +893,14 @@ module MetronomeSDK
               priority: Float,
               rate_type:
                 MetronomeSDK::ContractV2::Commit::RateType::TaggedSymbol,
+              recurring_commit_id: String,
               rolled_over_from:
                 MetronomeSDK::ContractV2::Commit::RolledOverFrom,
               rollover_fraction: Float,
               salesforce_opportunity_id: String,
-              specifiers: T::Array[MetronomeSDK::CommitSpecifier]
+              specifiers: T::Array[MetronomeSDK::CommitSpecifier],
+              subscription_config:
+                MetronomeSDK::RecurringCommitSubscriptionConfig
             }
           )
         end
@@ -3202,6 +3233,16 @@ module MetronomeSDK
         end
         attr_writer :contract
 
+        # Timestamp of when the credit was created.
+        #
+        # - Recurring credits: latter of credit service period date and parent credit
+        #   start date
+        sig { returns(T.nilable(Time)) }
+        attr_reader :created_at
+
+        sig { params(created_at: Time).void }
+        attr_writer :created_at
+
         # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
         sig { returns(T.nilable(T::Hash[Symbol, String])) }
         attr_reader :custom_fields
@@ -3277,6 +3318,13 @@ module MetronomeSDK
         sig { params(priority: Float).void }
         attr_writer :priority
 
+        # The ID of the recurring credit that created this credit
+        sig { returns(T.nilable(String)) }
+        attr_reader :recurring_credit_id
+
+        sig { params(recurring_credit_id: String).void }
+        attr_writer :recurring_credit_id
+
         # This field's availability is dependent on your client's configuration.
         sig { returns(T.nilable(String)) }
         attr_reader :salesforce_opportunity_id
@@ -3297,6 +3345,20 @@ module MetronomeSDK
         end
         attr_writer :specifiers
 
+        # Attach a subscription to the recurring commit/credit.
+        sig do
+          returns(T.nilable(MetronomeSDK::RecurringCommitSubscriptionConfig))
+        end
+        attr_reader :subscription_config
+
+        sig do
+          params(
+            subscription_config:
+              MetronomeSDK::RecurringCommitSubscriptionConfig::OrHash
+          ).void
+        end
+        attr_writer :subscription_config
+
         sig do
           params(
             id: String,
@@ -3308,6 +3370,7 @@ module MetronomeSDK
             applicable_product_tags: T::Array[String],
             balance: Float,
             contract: MetronomeSDK::ContractV2::Credit::Contract::OrHash,
+            created_at: Time,
             custom_fields: T::Hash[Symbol, String],
             description: String,
             hierarchy_configuration:
@@ -3327,8 +3390,11 @@ module MetronomeSDK
             name: String,
             netsuite_sales_order_id: String,
             priority: Float,
+            recurring_credit_id: String,
             salesforce_opportunity_id: String,
-            specifiers: T::Array[MetronomeSDK::CommitSpecifier::OrHash]
+            specifiers: T::Array[MetronomeSDK::CommitSpecifier::OrHash],
+            subscription_config:
+              MetronomeSDK::RecurringCommitSubscriptionConfig::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
@@ -3350,6 +3416,11 @@ module MetronomeSDK
           # included in the balance, including future-dated manual ledger entries.
           balance: nil,
           contract: nil,
+          # Timestamp of when the credit was created.
+          #
+          # - Recurring credits: latter of credit service period date and parent credit
+          #   start date
+          created_at: nil,
           # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           custom_fields: nil,
           description: nil,
@@ -3364,12 +3435,16 @@ module MetronomeSDK
           # If multiple credits or commits are applicable, the one with the lower priority
           # will apply first.
           priority: nil,
+          # The ID of the recurring credit that created this credit
+          recurring_credit_id: nil,
           # This field's availability is dependent on your client's configuration.
           salesforce_opportunity_id: nil,
           # List of filters that determine what kind of customer usage draws down a commit
           # or credit. A customer's usage needs to meet the condition of at least one of the
           # specifiers to contribute to a commit's or credit's drawdown.
-          specifiers: nil
+          specifiers: nil,
+          # Attach a subscription to the recurring commit/credit.
+          subscription_config: nil
         )
         end
 
@@ -3385,6 +3460,7 @@ module MetronomeSDK
               applicable_product_tags: T::Array[String],
               balance: Float,
               contract: MetronomeSDK::ContractV2::Credit::Contract,
+              created_at: Time,
               custom_fields: T::Hash[Symbol, String],
               description: String,
               hierarchy_configuration:
@@ -3394,8 +3470,11 @@ module MetronomeSDK
               name: String,
               netsuite_sales_order_id: String,
               priority: Float,
+              recurring_credit_id: String,
               salesforce_opportunity_id: String,
-              specifiers: T::Array[MetronomeSDK::CommitSpecifier]
+              specifiers: T::Array[MetronomeSDK::CommitSpecifier],
+              subscription_config:
+                MetronomeSDK::RecurringCommitSubscriptionConfig
             }
           )
         end