metronome-sdk 1.0.0 → 2.1.0

data/rbi/metronome_sdk/models/contract_without_amendments.rbi

@@ -53,7 +53,7 @@ module MetronomeSDK
       sig { params(credits: T::Array[MetronomeSDK::Credit::OrHash]).void }
       attr_writer :credits
 
-      # This field's availability is dependent on your client's configuration.
+      # This field's availability is dependent on your client's
       sig { returns(T.nilable(T::Array[MetronomeSDK::Discount])) }
       attr_reader :discounts
 
@@ -310,7 +310,7 @@ module MetronomeSDK
         transitions:,
         usage_statement_schedule:,
         credits: nil,
-        # This field's availability is dependent on your client's configuration.
+        # This field's availability is dependent on your client's
         discounts: nil,
         ending_before: nil,
         # Either a **parent** configuration with a list of children or a **child**

data/rbi/metronome_sdk/models/hierarchy_configuration.rbi

@@ -34,17 +34,37 @@ module MetronomeSDK
         end
         attr_accessor :children
 
+        sig do
+          returns(
+            T.nilable(
+              MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior
+            )
+          )
+        end
+        attr_reader :parent_behavior
+
+        sig do
+          params(
+            parent_behavior:
+              MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior::OrHash
+          ).void
+        end
+        attr_writer :parent_behavior
+
         sig do
           params(
             children:
               T::Array[
                 MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::Child::OrHash
-              ]
+              ],
+            parent_behavior:
+              MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
           # List of contracts that belong to this parent.
-          children:
+          children:,
+          parent_behavior: nil
         )
         end
 
@@ -54,7 +74,9 @@ module MetronomeSDK
               children:
                 T::Array[
                   MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::Child
-                ]
+                ],
+              parent_behavior:
+                MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior
             }
           )
         end
@@ -88,6 +110,110 @@ module MetronomeSDK
           def to_hash
           end
         end
+
+        class ParentBehavior < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          # 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
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior::InvoiceConsolidationType::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :invoice_consolidation_type
+
+          sig do
+            params(
+              invoice_consolidation_type:
+                MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior::InvoiceConsolidationType::OrSymbol
+            ).void
+          end
+          attr_writer :invoice_consolidation_type
+
+          sig do
+            params(
+              invoice_consolidation_type:
+                MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior::InvoiceConsolidationType::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # 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
+            invoice_consolidation_type: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                invoice_consolidation_type:
+                  MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior::InvoiceConsolidationType::TaggedSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # 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
+          module InvoiceConsolidationType
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior::InvoiceConsolidationType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            CONCATENATE =
+              T.let(
+                :CONCATENATE,
+                MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior::InvoiceConsolidationType::TaggedSymbol
+              )
+            NONE =
+              T.let(
+                :NONE,
+                MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior::InvoiceConsolidationType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior::InvoiceConsolidationType::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
       end
 
       class ChildHierarchyConfiguration < MetronomeSDK::Internal::Type::BaseModel
@@ -115,15 +241,83 @@ module MetronomeSDK
         end
         attr_writer :parent
 
+        # 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
+        sig do
+          returns(
+            T.nilable(
+              MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::Payer::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :payer
+
+        sig do
+          params(
+            payer:
+              MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::Payer::OrSymbol
+          ).void
+        end
+        attr_writer :payer
+
+        # 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
+        sig do
+          returns(
+            T.nilable(
+              MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::UsageStatementBehavior::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :usage_statement_behavior
+
+        sig do
+          params(
+            usage_statement_behavior:
+              MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::UsageStatementBehavior::OrSymbol
+          ).void
+        end
+        attr_writer :usage_statement_behavior
+
         sig do
           params(
             parent:
-              MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::Parent::OrHash
+              MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::Parent::OrHash,
+            payer:
+              MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::Payer::OrSymbol,
+            usage_statement_behavior:
+              MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::UsageStatementBehavior::OrSymbol
           ).returns(T.attached_class)
         end
         def self.new(
           # The single parent contract/customer for this child.
-          parent:
+          parent:,
+          # 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
+          payer: nil,
+          # 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
+          usage_statement_behavior: nil
         )
         end
 
@@ -131,7 +325,11 @@ module MetronomeSDK
           override.returns(
             {
               parent:
-                MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::Parent
+                MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::Parent,
+              payer:
+                MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::Payer::TaggedSymbol,
+              usage_statement_behavior:
+                MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::UsageStatementBehavior::TaggedSymbol
             }
           )
         end
@@ -166,6 +364,88 @@ module MetronomeSDK
           def to_hash
           end
         end
+
+        # 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
+        module Payer
+          extend MetronomeSDK::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::Payer
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          SELF =
+            T.let(
+              :SELF,
+              MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::Payer::TaggedSymbol
+            )
+          PARENT =
+            T.let(
+              :PARENT,
+              MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::Payer::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::Payer::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # 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
+        module UsageStatementBehavior
+          extend MetronomeSDK::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::UsageStatementBehavior
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          CONSOLIDATE =
+            T.let(
+              :CONSOLIDATE,
+              MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::UsageStatementBehavior::TaggedSymbol
+            )
+          SEPARATE =
+            T.let(
+              :SEPARATE,
+              MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::UsageStatementBehavior::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::UsageStatementBehavior::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
       end
 
       sig do

data/rbi/metronome_sdk/models/payment_gate_config.rbi

@@ -293,6 +293,11 @@ module MetronomeSDK
           T.let(:STRIPE, MetronomeSDK::PaymentGateConfig::TaxType::TaggedSymbol)
         ANROK =
           T.let(:ANROK, MetronomeSDK::PaymentGateConfig::TaxType::TaggedSymbol)
+        AVALARA =
+          T.let(
+            :AVALARA,
+            MetronomeSDK::PaymentGateConfig::TaxType::TaggedSymbol
+          )
         PRECALCULATED =
           T.let(
             :PRECALCULATED,

data/rbi/metronome_sdk/models/payment_gate_config_v2.rbi

@@ -302,6 +302,11 @@ module MetronomeSDK
             :ANROK,
             MetronomeSDK::PaymentGateConfigV2::TaxType::TaggedSymbol
           )
+        AVALARA =
+          T.let(
+            :AVALARA,
+            MetronomeSDK::PaymentGateConfigV2::TaxType::TaggedSymbol
+          )
         PRECALCULATED =
           T.let(
             :PRECALCULATED,

data/rbi/metronome_sdk/models/subscription.rbi

@@ -8,6 +8,17 @@ module MetronomeSDK
           T.any(MetronomeSDK::Subscription, MetronomeSDK::Internal::AnyHash)
         end
 
+      # Previous, current, and next billing periods for the subscription.
+      sig { returns(MetronomeSDK::Subscription::BillingPeriods) }
+      attr_reader :billing_periods
+
+      sig do
+        params(
+          billing_periods: MetronomeSDK::Subscription::BillingPeriods::OrHash
+        ).void
+      end
+      attr_writer :billing_periods
+
       sig do
         returns(MetronomeSDK::Subscription::CollectionSchedule::TaggedSymbol)
       end
@@ -25,6 +36,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.
       sig do
         returns(
           MetronomeSDK::Subscription::QuantityManagementMode::TaggedSymbol
@@ -90,6 +106,7 @@ module MetronomeSDK
 
       sig do
         params(
+          billing_periods: MetronomeSDK::Subscription::BillingPeriods::OrHash,
           collection_schedule:
             MetronomeSDK::Subscription::CollectionSchedule::OrSymbol,
           proration: MetronomeSDK::Subscription::Proration::OrHash,
@@ -109,12 +126,19 @@ module MetronomeSDK
         ).returns(T.attached_class)
       end
       def self.new(
+        # Previous, current, and next billing periods for the subscription.
+        billing_periods:,
         collection_schedule:,
         proration:,
         # Determines how the subscription's quantity is controlled. Defaults to
         # 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.
         quantity_management_mode:,
         # List of quantity schedule items for the subscription. Only includes the current
         # quantity and future quantity changes.
@@ -134,6 +158,7 @@ module MetronomeSDK
       sig do
         override.returns(
           {
+            billing_periods: MetronomeSDK::Subscription::BillingPeriods,
             collection_schedule:
               MetronomeSDK::Subscription::CollectionSchedule::TaggedSymbol,
             proration: MetronomeSDK::Subscription::Proration,
@@ -155,6 +180,166 @@ module MetronomeSDK
       def to_hash
       end
 
+      class BillingPeriods < MetronomeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::Subscription::BillingPeriods,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T.nilable(MetronomeSDK::Subscription::BillingPeriods::Current)
+          )
+        end
+        attr_reader :current
+
+        sig do
+          params(
+            current: MetronomeSDK::Subscription::BillingPeriods::Current::OrHash
+          ).void
+        end
+        attr_writer :current
+
+        sig do
+          returns(T.nilable(MetronomeSDK::Subscription::BillingPeriods::Next))
+        end
+        attr_reader :next_
+
+        sig do
+          params(
+            next_: MetronomeSDK::Subscription::BillingPeriods::Next::OrHash
+          ).void
+        end
+        attr_writer :next_
+
+        sig do
+          returns(
+            T.nilable(MetronomeSDK::Subscription::BillingPeriods::Previous)
+          )
+        end
+        attr_reader :previous
+
+        sig do
+          params(
+            previous:
+              MetronomeSDK::Subscription::BillingPeriods::Previous::OrHash
+          ).void
+        end
+        attr_writer :previous
+
+        # Previous, current, and next billing periods for the subscription.
+        sig do
+          params(
+            current:
+              MetronomeSDK::Subscription::BillingPeriods::Current::OrHash,
+            next_: MetronomeSDK::Subscription::BillingPeriods::Next::OrHash,
+            previous:
+              MetronomeSDK::Subscription::BillingPeriods::Previous::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(current: nil, next_: nil, previous: nil)
+        end
+
+        sig do
+          override.returns(
+            {
+              current: MetronomeSDK::Subscription::BillingPeriods::Current,
+              next_: MetronomeSDK::Subscription::BillingPeriods::Next,
+              previous: MetronomeSDK::Subscription::BillingPeriods::Previous
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Current < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::Subscription::BillingPeriods::Current,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          sig { returns(Time) }
+          attr_accessor :ending_before
+
+          sig { returns(Time) }
+          attr_accessor :starting_at
+
+          sig do
+            params(ending_before: Time, starting_at: Time).returns(
+              T.attached_class
+            )
+          end
+          def self.new(ending_before:, starting_at:)
+          end
+
+          sig { override.returns({ ending_before: Time, starting_at: Time }) }
+          def to_hash
+          end
+        end
+
+        class Next < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::Subscription::BillingPeriods::Next,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          sig { returns(Time) }
+          attr_accessor :ending_before
+
+          sig { returns(Time) }
+          attr_accessor :starting_at
+
+          sig do
+            params(ending_before: Time, starting_at: Time).returns(
+              T.attached_class
+            )
+          end
+          def self.new(ending_before:, starting_at:)
+          end
+
+          sig { override.returns({ ending_before: Time, starting_at: Time }) }
+          def to_hash
+          end
+        end
+
+        class Previous < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::Subscription::BillingPeriods::Previous,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          sig { returns(Time) }
+          attr_accessor :ending_before
+
+          sig { returns(Time) }
+          attr_accessor :starting_at
+
+          sig do
+            params(ending_before: Time, starting_at: Time).returns(
+              T.attached_class
+            )
+          end
+          def self.new(ending_before:, starting_at:)
+          end
+
+          sig { override.returns({ ending_before: Time, starting_at: Time }) }
+          def to_hash
+          end
+        end
+      end
+
       module CollectionSchedule
         extend MetronomeSDK::Internal::Type::Enum
 
@@ -266,6 +451,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.
       module QuantityManagementMode
         extend MetronomeSDK::Internal::Type::Enum
 

data/rbi/metronome_sdk/models/v1/alert_archive_params.rbi

@@ -15,11 +15,12 @@ module MetronomeSDK
             )
           end
 
-        # The Metronome ID of the alert
+        # The Metronome ID of the threshold notification
         sig { returns(String) }
         attr_accessor :id
 
-        # If true, resets the uniqueness key on this alert so it can be re-used
+        # If true, resets the uniqueness key on this threshold notification so it can be
+        # re-used
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :release_uniqueness_key
 
@@ -34,9 +35,10 @@ module MetronomeSDK
           ).returns(T.attached_class)
         end
         def self.new(
-          # The Metronome ID of the alert
+          # The Metronome ID of the threshold notification
           id:,
-          # If true, resets the uniqueness key on this alert so it can be re-used
+          # If true, resets the uniqueness key on this threshold notification so it can be
+          # re-used
           release_uniqueness_key: nil,
           request_options: {}
         )