Class: Privy::Models::PolicyCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Privy::Models::PolicyCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/privy/models/policy_create_params.rb

Overview

See Also:

• Resources::Policies#create

Defined Under Namespace

Modules: Version Classes: Rule

Instance Attribute Summary

• #chain_type ⇒ Symbol, Privy::Models::WalletChainType

  The wallet chain types.

• #name ⇒ String

  Name to assign to policy.

• #owner ⇒ Privy::Models::OwnerInputUser, ...

  The owner of the resource, specified as a Privy user ID, a P-256 public key, or null to remove the current owner.

• #owner_id ⇒ String^?

  The key quorum ID to set as the owner of the resource.

• #privy_idempotency_key ⇒ String^?

  Idempotency keys ensure API requests are executed only once within a 24-hour window.

• #rules ⇒ Array<Privy::Models::PolicyCreateParams::Rule>
• #version ⇒ Symbol, Privy::Models::PolicyCreateParams::Version

  Version of the policy.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(action:, conditions:, method_:, name:, id: nil) ⇒ Object constructor

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(action:, conditions:, method_:, name:, id: nil) ⇒ Object

Parameters:

• action (Symbol, Privy::Models::PolicyAction) —

  The action to take when a policy rule matches.

• conditions (Array<Privy::Models::EthereumTransactionCondition, Privy::Models::EthereumCalldataCondition, Privy::Models::EthereumTypedDataDomainCondition, Privy::Models::EthereumTypedDataMessageCondition, Privy::Models::Ethereum7702AuthorizationCondition, Privy::Models::TempoTransactionCondition, Privy::Models::SolanaProgramInstructionCondition, Privy::Models::SolanaSystemProgramInstructionCondition, Privy::Models::SolanaTokenProgramInstructionCondition, Privy::Models::SystemCondition, Privy::Models::TronTransactionCondition, Privy::Models::TronCalldataCondition, Privy::Models::SuiTransactionCommandCondition, Privy::Models::SuiTransferObjectsCommandCondition, Privy::Models::ActionRequestBodyCondition, Privy::Models::AggregationCondition>)
• method_ (Symbol, Privy::Models::PolicyMethod) —

  Method the rule applies to.

• name (String)
• id (String) (defaults to: nil)

# File 'lib/privy/models/policy_create_params.rb', line 102

Instance Attribute Details

#chain_type ⇒ Symbol, Privy::Models::WalletChainType

The wallet chain types.

Returns:

• (Symbol, Privy::Models::WalletChainType)

# File 'lib/privy/models/policy_create_params.rb', line 14

required :chain_type, enum: -> { Privy::WalletChainType }

#name ⇒ String

Name to assign to policy.

Returns:

• (String)

# File 'lib/privy/models/policy_create_params.rb', line 20

required :name, String

#owner ⇒ Privy::Models::OwnerInputUser, ...

The owner of the resource, specified as a Privy user ID, a P-256 public key, or null to remove the current owner.

Returns:

• (Privy::Models::OwnerInputUser, Privy::Models::OwnerInputPublicKey, nil)

# File 'lib/privy/models/policy_create_params.rb', line 38

optional :owner, union: -> { Privy::OwnerInput }, nil?: true

#owner_id ⇒ String^?

The key quorum ID to set as the owner of the resource. If you provide this, do not specify an owner.

Returns:

• (String, nil)

# File 'lib/privy/models/policy_create_params.rb', line 45

optional :owner_id, String, nil?: true

#privy_idempotency_key ⇒ String^?

Idempotency keys ensure API requests are executed only once within a 24-hour window.

Returns:

• (String, nil)

# File 'lib/privy/models/policy_create_params.rb', line 52

optional :privy_idempotency_key, String

#rules ⇒ Array<Privy::Models::PolicyCreateParams::Rule>

Returns:

• (Array<Privy::Models::PolicyCreateParams::Rule>)

# File 'lib/privy/models/policy_create_params.rb', line 25

required :rules, -> { Privy::Internal::Type::ArrayOf[Privy::PolicyCreateParams::Rule] }

#version ⇒ Symbol, Privy::Models::PolicyCreateParams::Version

Version of the policy. Currently, 1.0 is the only version.

Returns:

• (Symbol, Privy::Models::PolicyCreateParams::Version)

# File 'lib/privy/models/policy_create_params.rb', line 31

required :version, enum: -> { Privy::PolicyCreateParams::Version }