metronome-sdk 0.1.0.pre.alpha.2 → 0.1.0.pre.alpha.4

data/rbi/metronome_sdk/models/credit.rbi

@@ -79,23 +79,22 @@ module MetronomeSDK
       sig { params(description: String).void }
       attr_writer :description
 
+      # Optional configuration for credit hierarchy access control
+      sig { returns(T.nilable(MetronomeSDK::Credit::HierarchyConfiguration)) }
+      attr_reader :hierarchy_configuration
+
+      sig do
+        params(
+          hierarchy_configuration:
+            MetronomeSDK::Credit::HierarchyConfiguration::OrHash
+        ).void
+      end
+      attr_writer :hierarchy_configuration
+
       # A list of ordered events that impact the balance of a credit. For example, an
       # invoice deduction or an expiration.
       sig do
-        returns(
-          T.nilable(
-            T::Array[
-              T.any(
-                MetronomeSDK::Credit::Ledger::CreditSegmentStartLedgerEntry,
-                MetronomeSDK::Credit::Ledger::CreditAutomatedInvoiceDeductionLedgerEntry,
-                MetronomeSDK::Credit::Ledger::CreditExpirationLedgerEntry,
-                MetronomeSDK::Credit::Ledger::CreditCanceledLedgerEntry,
-                MetronomeSDK::Credit::Ledger::CreditCreditedLedgerEntry,
-                MetronomeSDK::Credit::Ledger::CreditManualLedgerEntry
-              )
-            ]
-          )
-        )
+        returns(T.nilable(T::Array[MetronomeSDK::Credit::Ledger::Variants]))
       end
       attr_reader :ledger
 
@@ -150,6 +149,19 @@ module MetronomeSDK
       sig { params(salesforce_opportunity_id: String).void }
       attr_writer :salesforce_opportunity_id
 
+      # 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.
+      sig { returns(T.nilable(T::Array[MetronomeSDK::Credit::Specifier])) }
+      attr_reader :specifiers
+
+      sig do
+        params(
+          specifiers: T::Array[MetronomeSDK::Credit::Specifier::OrHash]
+        ).void
+      end
+      attr_writer :specifiers
+
       # 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
@@ -173,6 +185,8 @@ module MetronomeSDK
           contract: MetronomeSDK::Credit::Contract::OrHash,
           custom_fields: T::Hash[Symbol, String],
           description: String,
+          hierarchy_configuration:
+            MetronomeSDK::Credit::HierarchyConfiguration::OrHash,
           ledger:
             T::Array[
               T.any(
@@ -189,6 +203,7 @@ module MetronomeSDK
           priority: Float,
           rate_type: MetronomeSDK::Credit::RateType::OrSymbol,
           salesforce_opportunity_id: String,
+          specifiers: T::Array[MetronomeSDK::Credit::Specifier::OrHash],
           uniqueness_key: String
         ).returns(T.attached_class)
       end
@@ -213,6 +228,8 @@ module MetronomeSDK
         contract: nil,
         custom_fields: nil,
         description: nil,
+        # Optional configuration for credit hierarchy access control
+        hierarchy_configuration: nil,
         # A list of ordered events that impact the balance of a credit. For example, an
         # invoice deduction or an expiration.
         ledger: nil,
@@ -225,6 +242,10 @@ module MetronomeSDK
         rate_type: 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,
         # 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
@@ -247,22 +268,15 @@ module MetronomeSDK
             contract: MetronomeSDK::Credit::Contract,
             custom_fields: T::Hash[Symbol, String],
             description: String,
-            ledger:
-              T::Array[
-                T.any(
-                  MetronomeSDK::Credit::Ledger::CreditSegmentStartLedgerEntry,
-                  MetronomeSDK::Credit::Ledger::CreditAutomatedInvoiceDeductionLedgerEntry,
-                  MetronomeSDK::Credit::Ledger::CreditExpirationLedgerEntry,
-                  MetronomeSDK::Credit::Ledger::CreditCanceledLedgerEntry,
-                  MetronomeSDK::Credit::Ledger::CreditCreditedLedgerEntry,
-                  MetronomeSDK::Credit::Ledger::CreditManualLedgerEntry
-                )
-              ],
+            hierarchy_configuration:
+              MetronomeSDK::Credit::HierarchyConfiguration,
+            ledger: T::Array[MetronomeSDK::Credit::Ledger::Variants],
             name: String,
             netsuite_sales_order_id: String,
             priority: Float,
             rate_type: MetronomeSDK::Credit::RateType::TaggedSymbol,
             salesforce_opportunity_id: String,
+            specifiers: T::Array[MetronomeSDK::Credit::Specifier],
             uniqueness_key: String
           }
         )
@@ -331,6 +345,274 @@ module MetronomeSDK
         end
       end
 
+      class HierarchyConfiguration < MetronomeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::Credit::HierarchyConfiguration,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::Variants
+          )
+        end
+        attr_accessor :child_access
+
+        # Optional configuration for credit hierarchy access control
+        sig do
+          params(
+            child_access:
+              T.any(
+                MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::OrHash,
+                MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::OrHash,
+                MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::OrHash
+              )
+          ).returns(T.attached_class)
+        end
+        def self.new(child_access:)
+        end
+
+        sig do
+          override.returns(
+            {
+              child_access:
+                MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::Variants
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module ChildAccess
+          extend MetronomeSDK::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll,
+                MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone,
+                MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs
+              )
+            end
+
+          class CommitHierarchyChildAccessAll < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            sig do
+              returns(
+                MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type::TaggedSymbol
+              )
+            end
+            attr_accessor :type
+
+            sig do
+              params(
+                type:
+                  MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type::OrSymbol
+              ).returns(T.attached_class)
+            end
+            def self.new(type:)
+            end
+
+            sig do
+              override.returns(
+                {
+                  type:
+                    MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type::TaggedSymbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            module Type
+              extend MetronomeSDK::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              ALL =
+                T.let(
+                  :ALL,
+                  MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+
+          class CommitHierarchyChildAccessNone < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            sig do
+              returns(
+                MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type::TaggedSymbol
+              )
+            end
+            attr_accessor :type
+
+            sig do
+              params(
+                type:
+                  MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type::OrSymbol
+              ).returns(T.attached_class)
+            end
+            def self.new(type:)
+            end
+
+            sig do
+              override.returns(
+                {
+                  type:
+                    MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type::TaggedSymbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            module Type
+              extend MetronomeSDK::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              NONE =
+                T.let(
+                  :NONE,
+                  MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+
+          class CommitHierarchyChildAccessContractIDs < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            sig { returns(T::Array[String]) }
+            attr_accessor :contract_ids
+
+            sig do
+              returns(
+                MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type::TaggedSymbol
+              )
+            end
+            attr_accessor :type
+
+            sig do
+              params(
+                contract_ids: T::Array[String],
+                type:
+                  MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type::OrSymbol
+              ).returns(T.attached_class)
+            end
+            def self.new(contract_ids:, type:)
+            end
+
+            sig do
+              override.returns(
+                {
+                  contract_ids: T::Array[String],
+                  type:
+                    MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type::TaggedSymbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            module Type
+              extend MetronomeSDK::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              CONTRACT_IDS =
+                T.let(
+                  :CONTRACT_IDS,
+                  MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+
+          sig do
+            override.returns(
+              T::Array[
+                MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+      end
+
       module Ledger
         extend MetronomeSDK::Internal::Type::Union
 
@@ -874,6 +1156,75 @@ module MetronomeSDK
         def self.values
         end
       end
+
+      class Specifier < MetronomeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::Credit::Specifier,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(T::Hash[Symbol, String])) }
+        attr_reader :presentation_group_values
+
+        sig { params(presentation_group_values: T::Hash[Symbol, String]).void }
+        attr_writer :presentation_group_values
+
+        sig { returns(T.nilable(T::Hash[Symbol, String])) }
+        attr_reader :pricing_group_values
+
+        sig { params(pricing_group_values: T::Hash[Symbol, String]).void }
+        attr_writer :pricing_group_values
+
+        # If provided, the specifier will only apply to the product with the specified ID.
+        sig { returns(T.nilable(String)) }
+        attr_reader :product_id
+
+        sig { params(product_id: String).void }
+        attr_writer :product_id
+
+        # If provided, the specifier will only apply to products with all the specified
+        # tags.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :product_tags
+
+        sig { params(product_tags: T::Array[String]).void }
+        attr_writer :product_tags
+
+        sig do
+          params(
+            presentation_group_values: T::Hash[Symbol, String],
+            pricing_group_values: T::Hash[Symbol, String],
+            product_id: String,
+            product_tags: T::Array[String]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          presentation_group_values: nil,
+          pricing_group_values: nil,
+          # If provided, the specifier will only apply to the product with the specified ID.
+          product_id: nil,
+          # If provided, the specifier will only apply to products with all the specified
+          # tags.
+          product_tags: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              presentation_group_values: T::Hash[Symbol, String],
+              pricing_group_values: T::Hash[Symbol, String],
+              product_id: String,
+              product_tags: T::Array[String]
+            }
+          )
+        end
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/metronome_sdk/models/override.rbi

@@ -251,6 +251,23 @@ module MetronomeSDK
             )
           end
 
+        sig do
+          returns(
+            T.nilable(
+              MetronomeSDK::Override::OverrideSpecifier::BillingFrequency::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :billing_frequency
+
+        sig do
+          params(
+            billing_frequency:
+              MetronomeSDK::Override::OverrideSpecifier::BillingFrequency::OrSymbol
+          ).void
+        end
+        attr_writer :billing_frequency
+
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :commit_ids
 
@@ -299,6 +316,8 @@ module MetronomeSDK
 
         sig do
           params(
+            billing_frequency:
+              MetronomeSDK::Override::OverrideSpecifier::BillingFrequency::OrSymbol,
             commit_ids: T::Array[String],
             presentation_group_values: T::Hash[Symbol, T.nilable(String)],
             pricing_group_values: T::Hash[Symbol, String],
@@ -309,6 +328,7 @@ module MetronomeSDK
           ).returns(T.attached_class)
         end
         def self.new(
+          billing_frequency: nil,
           commit_ids: nil,
           presentation_group_values: nil,
           pricing_group_values: nil,
@@ -322,6 +342,8 @@ module MetronomeSDK
         sig do
           override.returns(
             {
+              billing_frequency:
+                MetronomeSDK::Override::OverrideSpecifier::BillingFrequency::TaggedSymbol,
               commit_ids: T::Array[String],
               presentation_group_values: T::Hash[Symbol, T.nilable(String)],
               pricing_group_values: T::Hash[Symbol, String],
@@ -334,6 +356,50 @@ module MetronomeSDK
         end
         def to_hash
         end
+
+        module BillingFrequency
+          extend MetronomeSDK::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                MetronomeSDK::Override::OverrideSpecifier::BillingFrequency
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          MONTHLY =
+            T.let(
+              :MONTHLY,
+              MetronomeSDK::Override::OverrideSpecifier::BillingFrequency::TaggedSymbol
+            )
+          QUARTERLY =
+            T.let(
+              :QUARTERLY,
+              MetronomeSDK::Override::OverrideSpecifier::BillingFrequency::TaggedSymbol
+            )
+          ANNUAL =
+            T.let(
+              :ANNUAL,
+              MetronomeSDK::Override::OverrideSpecifier::BillingFrequency::TaggedSymbol
+            )
+          WEEKLY =
+            T.let(
+              :WEEKLY,
+              MetronomeSDK::Override::OverrideSpecifier::BillingFrequency::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                MetronomeSDK::Override::OverrideSpecifier::BillingFrequency::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
       end
 
       class OverrideTier < MetronomeSDK::Internal::Type::BaseModel

data/rbi/metronome_sdk/models/schedule_point_in_time.rbi

@@ -69,9 +69,6 @@ module MetronomeSDK
         sig { returns(Float) }
         attr_accessor :amount
 
-        sig { returns(String) }
-        attr_accessor :invoice_id
-
         sig { returns(Float) }
         attr_accessor :quantity
 
@@ -81,23 +78,26 @@ module MetronomeSDK
         sig { returns(Float) }
         attr_accessor :unit_price
 
+        sig { returns(T.nilable(String)) }
+        attr_accessor :invoice_id
+
         sig do
           params(
             id: String,
             amount: Float,
-            invoice_id: String,
             quantity: Float,
             timestamp: Time,
-            unit_price: Float
+            unit_price: Float,
+            invoice_id: T.nilable(String)
           ).returns(T.attached_class)
         end
         def self.new(
           id:,
           amount:,
-          invoice_id:,
           quantity:,
           timestamp:,
-          unit_price:
+          unit_price:,
+          invoice_id: nil
         )
         end
 
@@ -106,10 +106,10 @@ module MetronomeSDK
             {
               id: String,
               amount: Float,
-              invoice_id: String,
               quantity: Float,
               timestamp: Time,
-              unit_price: Float
+              unit_price: Float,
+              invoice_id: T.nilable(String)
             }
           )
         end

data/rbi/metronome_sdk/models/v1/alert_create_params.rbi

@@ -47,6 +47,9 @@ module MetronomeSDK
         sig { params(credit_grant_type_filters: T::Array[String]).void }
         attr_writer :credit_grant_type_filters
 
+        # ID of the credit's currency, defaults to USD. If the specific alert type
+        # requires a pricing unit/currency, find the ID in the
+        # [Metronome app](https://app.metronome.com/offering/pricing-units).
         sig { returns(T.nilable(String)) }
         attr_reader :credit_type_id
 
@@ -75,7 +78,7 @@ module MetronomeSDK
         attr_writer :custom_field_filters
 
         # If provided, will create this alert for this specific customer. To create an
-        # alert for all customers, do not specify `customer_id` or `plan_id`.
+        # alert for all customers, do not specify a `customer_id`.
         sig { returns(T.nilable(String)) }
         attr_reader :customer_id
 
@@ -117,7 +120,7 @@ module MetronomeSDK
         attr_writer :invoice_types_filter
 
         # If provided, will create this alert for this specific plan. To create an alert
-        # for all customers, do not specify `customer_id` or `plan_id`.
+        # for all customers, do not specify a `plan_id`.
         sig { returns(T.nilable(String)) }
         attr_reader :plan_id
 
@@ -171,12 +174,15 @@ module MetronomeSDK
           # applies to, by looking at the credit_grant_type field on the credit grant. This
           # field is only defined for CreditPercentage and CreditBalance alerts
           credit_grant_type_filters: nil,
+          # ID of the credit's currency, defaults to USD. If the specific alert type
+          # requires a pricing unit/currency, find the ID in the
+          # [Metronome app](https://app.metronome.com/offering/pricing-units).
           credit_type_id: nil,
           # A list of custom field filters for alert types that support advanced filtering.
           # Only present for contract invoices.
           custom_field_filters: nil,
           # If provided, will create this alert for this specific customer. To create an
-          # alert for all customers, do not specify `customer_id` or `plan_id`.
+          # alert for all customers, do not specify a `customer_id`.
           customer_id: nil,
           # If true, the alert will evaluate immediately on customers that already meet the
           # alert threshold. If false, it will only evaluate on future customers that
@@ -189,7 +195,7 @@ module MetronomeSDK
           # evaluate.
           invoice_types_filter: nil,
           # If provided, will create this alert for this specific plan. To create an alert
-          # for all customers, do not specify `customer_id` or `plan_id`.
+          # for all customers, do not specify a `plan_id`.
           plan_id: nil,
           # Prevents the creation of duplicates. If a request to create a record is made
           # with a previously used uniqueness key, a new record will not be created and the