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

data/rbi/metronome_sdk/models/commit.rbi

@@ -95,6 +95,18 @@ module MetronomeSDK
       sig { params(description: String).void }
       attr_writer :description
 
+      # Optional configuration for commit hierarchy access control
+      sig { returns(T.nilable(MetronomeSDK::Commit::HierarchyConfiguration)) }
+      attr_reader :hierarchy_configuration
+
+      sig do
+        params(
+          hierarchy_configuration:
+            MetronomeSDK::Commit::HierarchyConfiguration::OrHash
+        ).void
+      end
+      attr_writer :hierarchy_configuration
+
       # The contract that this commit will be billed on.
       sig { returns(T.nilable(MetronomeSDK::Commit::InvoiceContract)) }
       attr_reader :invoice_contract
@@ -118,27 +130,7 @@ module MetronomeSDK
       # A list of ordered events that impact the balance of a commit. For example, an
       # invoice deduction or a rollover.
       sig do
-        returns(
-          T.nilable(
-            T::Array[
-              T.any(
-                MetronomeSDK::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry,
-                MetronomeSDK::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry,
-                MetronomeSDK::Commit::Ledger::PrepaidCommitRolloverLedgerEntry,
-                MetronomeSDK::Commit::Ledger::PrepaidCommitExpirationLedgerEntry,
-                MetronomeSDK::Commit::Ledger::PrepaidCommitCanceledLedgerEntry,
-                MetronomeSDK::Commit::Ledger::PrepaidCommitCreditedLedgerEntry,
-                MetronomeSDK::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry,
-                MetronomeSDK::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry,
-                MetronomeSDK::Commit::Ledger::PostpaidCommitRolloverLedgerEntry,
-                MetronomeSDK::Commit::Ledger::PostpaidCommitTrueupLedgerEntry,
-                MetronomeSDK::Commit::Ledger::PrepaidCommitManualLedgerEntry,
-                MetronomeSDK::Commit::Ledger::PostpaidCommitManualLedgerEntry,
-                MetronomeSDK::Commit::Ledger::PostpaidCommitExpirationLedgerEntry
-              )
-            ]
-          )
-        )
+        returns(T.nilable(T::Array[MetronomeSDK::Commit::Ledger::Variants]))
       end
       attr_reader :ledger
 
@@ -216,6 +208,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::Commit::Specifier])) }
+      attr_reader :specifiers
+
+      sig do
+        params(
+          specifiers: T::Array[MetronomeSDK::Commit::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
@@ -241,6 +246,8 @@ module MetronomeSDK
           contract: MetronomeSDK::Commit::Contract::OrHash,
           custom_fields: T::Hash[Symbol, String],
           description: String,
+          hierarchy_configuration:
+            MetronomeSDK::Commit::HierarchyConfiguration::OrHash,
           invoice_contract: MetronomeSDK::Commit::InvoiceContract::OrHash,
           invoice_schedule: MetronomeSDK::SchedulePointInTime::OrHash,
           ledger:
@@ -268,6 +275,7 @@ module MetronomeSDK
           rolled_over_from: MetronomeSDK::Commit::RolledOverFrom::OrHash,
           rollover_fraction: Float,
           salesforce_opportunity_id: String,
+          specifiers: T::Array[MetronomeSDK::Commit::Specifier::OrHash],
           uniqueness_key: String
         ).returns(T.attached_class)
       end
@@ -298,6 +306,8 @@ module MetronomeSDK
         contract: nil,
         custom_fields: nil,
         description: nil,
+        # Optional configuration for commit hierarchy access control
+        hierarchy_configuration: nil,
         # The contract that this commit will be billed on.
         invoice_contract: nil,
         # The schedule that the customer will be invoiced for this commit.
@@ -316,6 +326,10 @@ module MetronomeSDK
         rollover_fraction: 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
@@ -340,26 +354,11 @@ module MetronomeSDK
             contract: MetronomeSDK::Commit::Contract,
             custom_fields: T::Hash[Symbol, String],
             description: String,
+            hierarchy_configuration:
+              MetronomeSDK::Commit::HierarchyConfiguration,
             invoice_contract: MetronomeSDK::Commit::InvoiceContract,
             invoice_schedule: MetronomeSDK::SchedulePointInTime,
-            ledger:
-              T::Array[
-                T.any(
-                  MetronomeSDK::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry,
-                  MetronomeSDK::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry,
-                  MetronomeSDK::Commit::Ledger::PrepaidCommitRolloverLedgerEntry,
-                  MetronomeSDK::Commit::Ledger::PrepaidCommitExpirationLedgerEntry,
-                  MetronomeSDK::Commit::Ledger::PrepaidCommitCanceledLedgerEntry,
-                  MetronomeSDK::Commit::Ledger::PrepaidCommitCreditedLedgerEntry,
-                  MetronomeSDK::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry,
-                  MetronomeSDK::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry,
-                  MetronomeSDK::Commit::Ledger::PostpaidCommitRolloverLedgerEntry,
-                  MetronomeSDK::Commit::Ledger::PostpaidCommitTrueupLedgerEntry,
-                  MetronomeSDK::Commit::Ledger::PrepaidCommitManualLedgerEntry,
-                  MetronomeSDK::Commit::Ledger::PostpaidCommitManualLedgerEntry,
-                  MetronomeSDK::Commit::Ledger::PostpaidCommitExpirationLedgerEntry
-                )
-              ],
+            ledger: T::Array[MetronomeSDK::Commit::Ledger::Variants],
             name: String,
             netsuite_sales_order_id: String,
             priority: Float,
@@ -367,6 +366,7 @@ module MetronomeSDK
             rolled_over_from: MetronomeSDK::Commit::RolledOverFrom,
             rollover_fraction: Float,
             salesforce_opportunity_id: String,
+            specifiers: T::Array[MetronomeSDK::Commit::Specifier],
             uniqueness_key: String
           }
         )
@@ -436,6 +436,274 @@ module MetronomeSDK
         end
       end
 
+      class HierarchyConfiguration < MetronomeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::Commit::HierarchyConfiguration,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            MetronomeSDK::Commit::HierarchyConfiguration::ChildAccess::Variants
+          )
+        end
+        attr_accessor :child_access
+
+        # Optional configuration for commit hierarchy access control
+        sig do
+          params(
+            child_access:
+              T.any(
+                MetronomeSDK::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::OrHash,
+                MetronomeSDK::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::OrHash,
+                MetronomeSDK::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::OrHash
+              )
+          ).returns(T.attached_class)
+        end
+        def self.new(child_access:)
+        end
+
+        sig do
+          override.returns(
+            {
+              child_access:
+                MetronomeSDK::Commit::HierarchyConfiguration::ChildAccess::Variants
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module ChildAccess
+          extend MetronomeSDK::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll,
+                MetronomeSDK::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone,
+                MetronomeSDK::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs
+              )
+            end
+
+          class CommitHierarchyChildAccessAll < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            sig do
+              returns(
+                MetronomeSDK::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type::TaggedSymbol
+              )
+            end
+            attr_accessor :type
+
+            sig do
+              params(
+                type:
+                  MetronomeSDK::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type::OrSymbol
+              ).returns(T.attached_class)
+            end
+            def self.new(type:)
+            end
+
+            sig do
+              override.returns(
+                {
+                  type:
+                    MetronomeSDK::Commit::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::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              ALL =
+                T.let(
+                  :ALL,
+                  MetronomeSDK::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    MetronomeSDK::Commit::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::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            sig do
+              returns(
+                MetronomeSDK::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type::TaggedSymbol
+              )
+            end
+            attr_accessor :type
+
+            sig do
+              params(
+                type:
+                  MetronomeSDK::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type::OrSymbol
+              ).returns(T.attached_class)
+            end
+            def self.new(type:)
+            end
+
+            sig do
+              override.returns(
+                {
+                  type:
+                    MetronomeSDK::Commit::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::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              NONE =
+                T.let(
+                  :NONE,
+                  MetronomeSDK::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    MetronomeSDK::Commit::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::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            sig { returns(T::Array[String]) }
+            attr_accessor :contract_ids
+
+            sig do
+              returns(
+                MetronomeSDK::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type::TaggedSymbol
+              )
+            end
+            attr_accessor :type
+
+            sig do
+              params(
+                contract_ids: T::Array[String],
+                type:
+                  MetronomeSDK::Commit::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::Commit::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::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              CONTRACT_IDS =
+                T.let(
+                  :CONTRACT_IDS,
+                  MetronomeSDK::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    MetronomeSDK::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+
+          sig do
+            override.returns(
+              T::Array[
+                MetronomeSDK::Commit::HierarchyConfiguration::ChildAccess::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+      end
+
       class InvoiceContract < MetronomeSDK::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
@@ -1620,6 +1888,75 @@ module MetronomeSDK
         def to_hash
         end
       end
+
+      class Specifier < MetronomeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::Commit::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