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

data/rbi/metronome_sdk/models/contract_without_amendments.rbi

@@ -1536,6 +1536,24 @@ module MetronomeSDK
         sig { params(ending_before: Time).void }
         attr_writer :ending_before
 
+        # Optional configuration for recurring commit/credit hierarchy access control
+        sig do
+          returns(
+            T.nilable(
+              MetronomeSDK::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration
+            )
+          )
+        end
+        attr_reader :hierarchy_configuration
+
+        sig do
+          params(
+            hierarchy_configuration:
+              MetronomeSDK::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::OrHash
+          ).void
+        end
+        attr_writer :hierarchy_configuration
+
         # The amount the customer should be billed for the commit. Not required.
         sig do
           returns(
@@ -1661,6 +1679,8 @@ module MetronomeSDK
               MetronomeSDK::ContractWithoutAmendments::RecurringCommit::Contract::OrHash,
             description: String,
             ending_before: Time,
+            hierarchy_configuration:
+              MetronomeSDK::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::OrHash,
             invoice_amount:
               MetronomeSDK::ContractWithoutAmendments::RecurringCommit::InvoiceAmount::OrHash,
             name: String,
@@ -1698,6 +1718,8 @@ module MetronomeSDK
           description: nil,
           # Determines when the contract will stop creating recurring commits. Optional
           ending_before: nil,
+          # Optional configuration for recurring commit/credit hierarchy access control
+          hierarchy_configuration: nil,
           # The amount the customer should be billed for the commit. Not required.
           invoice_amount: nil,
           # Displayed on invoices. Will be passed through to the individual commits
@@ -1744,6 +1766,8 @@ module MetronomeSDK
                 MetronomeSDK::ContractWithoutAmendments::RecurringCommit::Contract,
               description: String,
               ending_before: Time,
+              hierarchy_configuration:
+                MetronomeSDK::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration,
               invoice_amount:
                 MetronomeSDK::ContractWithoutAmendments::RecurringCommit::InvoiceAmount,
               name: String,
@@ -1966,6 +1990,274 @@ module MetronomeSDK
           end
         end
 
+        class HierarchyConfiguration < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          sig do
+            returns(
+              MetronomeSDK::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::Variants
+            )
+          end
+          attr_accessor :child_access
+
+          # Optional configuration for recurring commit/credit hierarchy access control
+          sig do
+            params(
+              child_access:
+                T.any(
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::OrHash,
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::OrHash,
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::OrHash
+                )
+            ).returns(T.attached_class)
+          end
+          def self.new(child_access:)
+          end
+
+          sig do
+            override.returns(
+              {
+                child_access:
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::Variants
+              }
+            )
+          end
+          def to_hash
+          end
+
+          module ChildAccess
+            extend MetronomeSDK::Internal::Type::Union
+
+            Variants =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll,
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone,
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs
+                )
+              end
+
+            class CommitHierarchyChildAccessAll < MetronomeSDK::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    MetronomeSDK::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll,
+                    MetronomeSDK::Internal::AnyHash
+                  )
+                end
+
+              sig do
+                returns(
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type::TaggedSymbol
+                )
+              end
+              attr_accessor :type
+
+              sig do
+                params(
+                  type:
+                    MetronomeSDK::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type::OrSymbol
+                ).returns(T.attached_class)
+              end
+              def self.new(type:)
+              end
+
+              sig do
+                override.returns(
+                  {
+                    type:
+                      MetronomeSDK::ContractWithoutAmendments::RecurringCommit::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::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type
+                    )
+                  end
+                OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                ALL =
+                  T.let(
+                    :ALL,
+                    MetronomeSDK::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type::TaggedSymbol
+                  )
+
+                sig do
+                  override.returns(
+                    T::Array[
+                      MetronomeSDK::ContractWithoutAmendments::RecurringCommit::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::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone,
+                    MetronomeSDK::Internal::AnyHash
+                  )
+                end
+
+              sig do
+                returns(
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type::TaggedSymbol
+                )
+              end
+              attr_accessor :type
+
+              sig do
+                params(
+                  type:
+                    MetronomeSDK::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type::OrSymbol
+                ).returns(T.attached_class)
+              end
+              def self.new(type:)
+              end
+
+              sig do
+                override.returns(
+                  {
+                    type:
+                      MetronomeSDK::ContractWithoutAmendments::RecurringCommit::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::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type
+                    )
+                  end
+                OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                NONE =
+                  T.let(
+                    :NONE,
+                    MetronomeSDK::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type::TaggedSymbol
+                  )
+
+                sig do
+                  override.returns(
+                    T::Array[
+                      MetronomeSDK::ContractWithoutAmendments::RecurringCommit::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::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs,
+                    MetronomeSDK::Internal::AnyHash
+                  )
+                end
+
+              sig { returns(T::Array[String]) }
+              attr_accessor :contract_ids
+
+              sig do
+                returns(
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type::TaggedSymbol
+                )
+              end
+              attr_accessor :type
+
+              sig do
+                params(
+                  contract_ids: T::Array[String],
+                  type:
+                    MetronomeSDK::ContractWithoutAmendments::RecurringCommit::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::ContractWithoutAmendments::RecurringCommit::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::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type
+                    )
+                  end
+                OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                CONTRACT_IDS =
+                  T.let(
+                    :CONTRACT_IDS,
+                    MetronomeSDK::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type::TaggedSymbol
+                  )
+
+                sig do
+                  override.returns(
+                    T::Array[
+                      MetronomeSDK::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type::TaggedSymbol
+                    ]
+                  )
+                end
+                def self.values
+                end
+              end
+            end
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::Variants
+                ]
+              )
+            end
+            def self.variants
+            end
+          end
+        end
+
         class InvoiceAmount < MetronomeSDK::Internal::Type::BaseModel
           OrHash =
             T.type_alias do
@@ -2291,6 +2583,24 @@ module MetronomeSDK
         sig { params(ending_before: Time).void }
         attr_writer :ending_before
 
+        # Optional configuration for recurring commit/credit hierarchy access control
+        sig do
+          returns(
+            T.nilable(
+              MetronomeSDK::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration
+            )
+          )
+        end
+        attr_reader :hierarchy_configuration
+
+        sig do
+          params(
+            hierarchy_configuration:
+              MetronomeSDK::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::OrHash
+          ).void
+        end
+        attr_writer :hierarchy_configuration
+
         # Displayed on invoices. Will be passed through to the individual commits
         sig { returns(T.nilable(String)) }
         attr_reader :name
@@ -2398,6 +2708,8 @@ module MetronomeSDK
               MetronomeSDK::ContractWithoutAmendments::RecurringCredit::Contract::OrHash,
             description: String,
             ending_before: Time,
+            hierarchy_configuration:
+              MetronomeSDK::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::OrHash,
             name: String,
             netsuite_sales_order_id: String,
             proration:
@@ -2433,6 +2745,8 @@ module MetronomeSDK
           description: nil,
           # Determines when the contract will stop creating recurring commits. Optional
           ending_before: nil,
+          # Optional configuration for recurring commit/credit hierarchy access control
+          hierarchy_configuration: nil,
           # Displayed on invoices. Will be passed through to the individual commits
           name: nil,
           # Will be passed down to the individual commits
@@ -2477,6 +2791,8 @@ module MetronomeSDK
                 MetronomeSDK::ContractWithoutAmendments::RecurringCredit::Contract,
               description: String,
               ending_before: Time,
+              hierarchy_configuration:
+                MetronomeSDK::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration,
               name: String,
               netsuite_sales_order_id: String,
               proration:
@@ -2697,6 +3013,274 @@ module MetronomeSDK
           end
         end
 
+        class HierarchyConfiguration < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          sig do
+            returns(
+              MetronomeSDK::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::Variants
+            )
+          end
+          attr_accessor :child_access
+
+          # Optional configuration for recurring commit/credit hierarchy access control
+          sig do
+            params(
+              child_access:
+                T.any(
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::OrHash,
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::OrHash,
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::OrHash
+                )
+            ).returns(T.attached_class)
+          end
+          def self.new(child_access:)
+          end
+
+          sig do
+            override.returns(
+              {
+                child_access:
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::Variants
+              }
+            )
+          end
+          def to_hash
+          end
+
+          module ChildAccess
+            extend MetronomeSDK::Internal::Type::Union
+
+            Variants =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll,
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone,
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs
+                )
+              end
+
+            class CommitHierarchyChildAccessAll < MetronomeSDK::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    MetronomeSDK::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll,
+                    MetronomeSDK::Internal::AnyHash
+                  )
+                end
+
+              sig do
+                returns(
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type::TaggedSymbol
+                )
+              end
+              attr_accessor :type
+
+              sig do
+                params(
+                  type:
+                    MetronomeSDK::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type::OrSymbol
+                ).returns(T.attached_class)
+              end
+              def self.new(type:)
+              end
+
+              sig do
+                override.returns(
+                  {
+                    type:
+                      MetronomeSDK::ContractWithoutAmendments::RecurringCredit::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::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type
+                    )
+                  end
+                OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                ALL =
+                  T.let(
+                    :ALL,
+                    MetronomeSDK::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type::TaggedSymbol
+                  )
+
+                sig do
+                  override.returns(
+                    T::Array[
+                      MetronomeSDK::ContractWithoutAmendments::RecurringCredit::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::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone,
+                    MetronomeSDK::Internal::AnyHash
+                  )
+                end
+
+              sig do
+                returns(
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type::TaggedSymbol
+                )
+              end
+              attr_accessor :type
+
+              sig do
+                params(
+                  type:
+                    MetronomeSDK::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type::OrSymbol
+                ).returns(T.attached_class)
+              end
+              def self.new(type:)
+              end
+
+              sig do
+                override.returns(
+                  {
+                    type:
+                      MetronomeSDK::ContractWithoutAmendments::RecurringCredit::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::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type
+                    )
+                  end
+                OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                NONE =
+                  T.let(
+                    :NONE,
+                    MetronomeSDK::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type::TaggedSymbol
+                  )
+
+                sig do
+                  override.returns(
+                    T::Array[
+                      MetronomeSDK::ContractWithoutAmendments::RecurringCredit::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::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs,
+                    MetronomeSDK::Internal::AnyHash
+                  )
+                end
+
+              sig { returns(T::Array[String]) }
+              attr_accessor :contract_ids
+
+              sig do
+                returns(
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type::TaggedSymbol
+                )
+              end
+              attr_accessor :type
+
+              sig do
+                params(
+                  contract_ids: T::Array[String],
+                  type:
+                    MetronomeSDK::ContractWithoutAmendments::RecurringCredit::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::ContractWithoutAmendments::RecurringCredit::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::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type
+                    )
+                  end
+                OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                CONTRACT_IDS =
+                  T.let(
+                    :CONTRACT_IDS,
+                    MetronomeSDK::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type::TaggedSymbol
+                  )
+
+                sig do
+                  override.returns(
+                    T::Array[
+                      MetronomeSDK::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type::TaggedSymbol
+                    ]
+                  )
+                end
+                def self.values
+                end
+              end
+            end
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::Variants
+                ]
+              )
+            end
+            def self.variants
+            end
+          end
+        end
+
         # Determines whether the first and last commit will be prorated. If not provided,
         # the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).
         module Proration