@privy-io/api-types 0.8.0 → 0.9.0

package/src/resources/policies.ts

@@ -471,6 +471,17 @@ export namespace AbiSchema {
   }
 }
 
+/**
+ * Operator to use for policy conditions.
+ */
+export type ConditionOperator = 'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'in_condition_set';
+
+/**
+ * Value to compare against in a policy condition. Can be a single string or an
+ * array of strings.
+ */
+export type ConditionValue = string | Array<string>;
+
 /**
  * Operator to use for SUI transaction command conditions. Only 'eq' and 'in' are
  * supported for command names.
@@ -484,32 +495,32 @@ export type SuiTransactionCommandOperator = 'eq' | 'in';
 export type SuiTransferObjectsCommandField = 'recipient' | 'amount';
 
 /**
- * TRON transaction fields for TransferContract and TriggerSmartContract
- * transaction types.
+ * The verbatim Ethereum transaction object in an eth_signTransaction or
+ * eth_sendTransaction request.
  */
-export interface TronTransactionCondition {
-  /**
-   * Supported TRON transaction fields in format "TransactionType.field_name"
-   */
-  field:
-    | 'TransferContract.to_address'
-    | 'TransferContract.amount'
-    | 'TriggerSmartContract.contract_address'
-    | 'TriggerSmartContract.call_value'
-    | 'TriggerSmartContract.token_id'
-    | 'TriggerSmartContract.call_token_value';
+export interface EthereumTransactionCondition {
+  field: 'to' | 'value' | 'chain_id';
 
-  field_source: 'tron_transaction';
+  field_source: 'ethereum_transaction';
 
-  operator: 'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'in_condition_set';
+  /**
+   * Operator to use for policy conditions.
+   */
+  operator: ConditionOperator;
 
-  value: string | Array<string>;
+  /**
+   * Value to compare against in a policy condition. Can be a single string or an
+   * array of strings.
+   */
+  value: ConditionValue;
 }
 
 /**
- * Decoded calldata from a TRON TriggerSmartContract interaction.
+ * The decoded calldata in a smart contract interaction as the smart contract
+ * method's parameters. Note that that 'ethereum_calldata' conditions must contain
+ * an abi parameter with the JSON ABI of the smart contract.
  */
-export interface TronCalldataCondition {
+export interface EthereumCalldataCondition {
   /**
    * A Solidity ABI definition for decoding smart contract calldata.
    */
@@ -517,253 +528,342 @@ export interface TronCalldataCondition {
 
   field: string;
 
-  field_source: 'tron_trigger_smart_contract_data';
+  field_source: 'ethereum_calldata';
 
-  operator: 'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'in_condition_set';
+  /**
+   * Operator to use for policy conditions.
+   */
+  operator: ConditionOperator;
 
-  value: string | Array<string>;
+  /**
+   * Value to compare against in a policy condition. Can be a single string or an
+   * array of strings.
+   */
+  value: ConditionValue;
 }
 
 /**
- * SUI transaction command attributes, enables allowlisting specific command types.
- * Allowed commands: 'TransferObjects', 'SplitCoins', 'MergeCoins'. Only 'eq' and
- * 'in' operators are supported.
+ * Attributes from the signing domain that will verify the signature.
  */
-export interface SuiTransactionCommandCondition {
-  field: 'commandName';
+export interface EthereumTypedDataDomainCondition {
+  field: 'chainId' | 'verifyingContract' | 'chain_id' | 'verifying_contract';
 
-  field_source: 'sui_transaction_command';
+  field_source: 'ethereum_typed_data_domain';
 
   /**
-   * Operator to use for SUI transaction command conditions. Only 'eq' and 'in' are
-   * supported for command names.
+   * Operator to use for policy conditions.
    */
-  operator: SuiTransactionCommandOperator;
+  operator: ConditionOperator;
 
   /**
-   * Command name(s) to match. Must be one of: 'TransferObjects', 'SplitCoins',
-   * 'MergeCoins'
+   * Value to compare against in a policy condition. Can be a single string or an
+   * array of strings.
    */
-  value: WalletsAPI.SuiCommandName | Array<WalletsAPI.SuiCommandName>;
+  value: ConditionValue;
 }
 
 /**
- * SUI TransferObjects command attributes, including recipient and amount fields.
+ * 'types' and 'primary_type' attributes of the TypedData JSON object defined in
+ * EIP-712.
  */
-export interface SuiTransferObjectsCommandCondition {
+export interface EthereumTypedDataMessageCondition {
+  field: string;
+
+  field_source: 'ethereum_typed_data_message';
+
   /**
-   * Supported fields for SUI TransferObjects command conditions. Only 'recipient'
-   * and 'amount' are supported.
+   * Operator to use for policy conditions.
    */
-  field: SuiTransferObjectsCommandField;
+  operator: ConditionOperator;
 
-  field_source: 'sui_transfer_objects_command';
+  typed_data: EthereumTypedDataMessageCondition.TypedData;
 
-  operator: 'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'in_condition_set';
+  /**
+   * Value to compare against in a policy condition. Can be a single string or an
+   * array of strings.
+   */
+  value: ConditionValue;
+}
 
-  value: string | Array<string>;
+export namespace EthereumTypedDataMessageCondition {
+  export interface TypedData {
+    primary_type: string;
+
+    /**
+     * The type definitions for EIP-712 typed data signing.
+     */
+    types: WalletsAPI.TypedDataTypesInputParams;
+  }
 }
 
 /**
- * Condition referencing an aggregation value. The field must start with
- * "aggregation." followed by the aggregation ID.
+ * Allowed contract addresses for eth_sign7702Authorization requests.
  */
-export interface AggregationCondition {
-  field: string;
+export interface Ethereum7702AuthorizationCondition {
+  field: 'contract';
 
-  field_source: 'reference';
+  field_source: 'ethereum_7702_authorization';
 
-  operator: 'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'in_condition_set';
+  /**
+   * Operator to use for policy conditions.
+   */
+  operator: ConditionOperator;
 
-  value: string | Array<string>;
+  /**
+   * Value to compare against in a policy condition. Can be a single string or an
+   * array of strings.
+   */
+  value: ConditionValue;
 }
 
 /**
- * A condition that must be true for the rule action to be applied.
+ * Solana Program attributes, enables allowlisting Solana Programs.
  */
-export type PolicyCondition =
-  | PolicyCondition.EthereumTransactionCondition
-  | PolicyCondition.EthereumCalldataCondition
-  | PolicyCondition.EthereumTypedDataDomainCondition
-  | PolicyCondition.EthereumTypedDataMessageCondition
-  | PolicyCondition.Ethereum7702AuthorizationCondition
-  | PolicyCondition.SolanaProgramInstructionCondition
-  | PolicyCondition.SolanaSystemProgramInstructionCondition
-  | PolicyCondition.SolanaTokenProgramInstructionCondition
-  | PolicyCondition.SystemCondition
-  | TronTransactionCondition
-  | TronCalldataCondition
-  | SuiTransactionCommandCondition
-  | SuiTransferObjectsCommandCondition
-  | AggregationCondition;
+export interface SolanaProgramInstructionCondition {
+  field: 'programId';
+
+  field_source: 'solana_program_instruction';
 
-export namespace PolicyCondition {
   /**
-   * The verbatim Ethereum transaction object in an eth_signTransaction or
-   * eth_sendTransaction request.
+   * Operator to use for policy conditions.
    */
-  export interface EthereumTransactionCondition {
-    field: 'to' | 'value' | 'chain_id';
+  operator: ConditionOperator;
 
-    field_source: 'ethereum_transaction';
+  /**
+   * Value to compare against in a policy condition. Can be a single string or an
+   * array of strings.
+   */
+  value: ConditionValue;
+}
 
-    operator: 'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'in_condition_set';
+/**
+ * Solana System Program attributes, including more granular Transfer instruction
+ * fields.
+ */
+export interface SolanaSystemProgramInstructionCondition {
+  field: 'instructionName' | 'Transfer.from' | 'Transfer.to' | 'Transfer.lamports';
 
-    value: string | Array<string>;
-  }
+  field_source: 'solana_system_program_instruction';
 
   /**
-   * The decoded calldata in a smart contract interaction as the smart contract
-   * method's parameters. Note that that 'ethereum_calldata' conditions must contain
-   * an abi parameter with the JSON ABI of the smart contract.
+   * Operator to use for policy conditions.
    */
-  export interface EthereumCalldataCondition {
-    /**
-     * A Solidity ABI definition for decoding smart contract calldata.
-     */
-    abi: PoliciesAPI.AbiSchema;
+  operator: ConditionOperator;
 
-    field: string;
+  /**
+   * Value to compare against in a policy condition. Can be a single string or an
+   * array of strings.
+   */
+  value: ConditionValue;
+}
 
-    field_source: 'ethereum_calldata';
+/**
+ * Solana Token Program attributes, including more granular TransferChecked
+ * instruction fields.
+ */
+export interface SolanaTokenProgramInstructionCondition {
+  field:
+    | 'instructionName'
+    | 'Transfer.source'
+    | 'Transfer.destination'
+    | 'Transfer.authority'
+    | 'Transfer.amount'
+    | 'TransferChecked.source'
+    | 'TransferChecked.destination'
+    | 'TransferChecked.authority'
+    | 'TransferChecked.amount'
+    | 'TransferChecked.mint'
+    | 'Burn.account'
+    | 'Burn.mint'
+    | 'Burn.authority'
+    | 'Burn.amount'
+    | 'MintTo.mint'
+    | 'MintTo.account'
+    | 'MintTo.authority'
+    | 'MintTo.amount'
+    | 'CloseAccount.account'
+    | 'CloseAccount.destination'
+    | 'CloseAccount.authority'
+    | 'InitializeAccount3.account'
+    | 'InitializeAccount3.mint'
+    | 'InitializeAccount3.owner';
+
+  field_source: 'solana_token_program_instruction';
+
+  /**
+   * Operator to use for policy conditions.
+   */
+  operator: ConditionOperator;
+
+  /**
+   * Value to compare against in a policy condition. Can be a single string or an
+   * array of strings.
+   */
+  value: ConditionValue;
+}
 
-    operator: 'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'in_condition_set';
+/**
+ * System attributes, including current unix timestamp (in seconds).
+ */
+export interface SystemCondition {
+  field: 'current_unix_timestamp';
 
-    value: string | Array<string>;
-  }
+  field_source: 'system';
 
   /**
-   * Attributes from the signing domain that will verify the signature.
+   * Operator to use for policy conditions.
    */
-  export interface EthereumTypedDataDomainCondition {
-    field: 'chainId' | 'verifyingContract' | 'chain_id' | 'verifying_contract';
-
-    field_source: 'ethereum_typed_data_domain';
+  operator: ConditionOperator;
 
-    operator: 'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'in_condition_set';
-
-    value: string | Array<string>;
-  }
+  /**
+   * Value to compare against in a policy condition. Can be a single string or an
+   * array of strings.
+   */
+  value: ConditionValue;
+}
 
+/**
+ * TRON transaction fields for TransferContract and TriggerSmartContract
+ * transaction types.
+ */
+export interface TronTransactionCondition {
   /**
-   * 'types' and 'primary_type' attributes of the TypedData JSON object defined in
-   * EIP-712.
+   * Supported TRON transaction fields in format "TransactionType.field_name"
    */
-  export interface EthereumTypedDataMessageCondition {
-    field: string;
+  field:
+    | 'TransferContract.to_address'
+    | 'TransferContract.amount'
+    | 'TriggerSmartContract.contract_address'
+    | 'TriggerSmartContract.call_value'
+    | 'TriggerSmartContract.token_id'
+    | 'TriggerSmartContract.call_token_value';
 
-    field_source: 'ethereum_typed_data_message';
+  field_source: 'tron_transaction';
 
-    operator: 'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'in_condition_set';
+  /**
+   * Operator to use for policy conditions.
+   */
+  operator: ConditionOperator;
 
-    typed_data: EthereumTypedDataMessageCondition.TypedData;
+  /**
+   * Value to compare against in a policy condition. Can be a single string or an
+   * array of strings.
+   */
+  value: ConditionValue;
+}
 
-    value: string | Array<string>;
-  }
+/**
+ * Decoded calldata from a TRON TriggerSmartContract interaction.
+ */
+export interface TronCalldataCondition {
+  /**
+   * A Solidity ABI definition for decoding smart contract calldata.
+   */
+  abi: AbiSchema;
 
-  export namespace EthereumTypedDataMessageCondition {
-    export interface TypedData {
-      primary_type: string;
+  field: string;
 
-      /**
-       * The type definitions for EIP-712 typed data signing.
-       */
-      types: WalletsAPI.TypedDataTypesInputParams;
-    }
-  }
+  field_source: 'tron_trigger_smart_contract_data';
 
   /**
-   * Allowed contract addresses for eth_sign7702Authorization requests.
+   * Operator to use for policy conditions.
    */
-  export interface Ethereum7702AuthorizationCondition {
-    field: 'contract';
+  operator: ConditionOperator;
 
-    field_source: 'ethereum_7702_authorization';
+  /**
+   * Value to compare against in a policy condition. Can be a single string or an
+   * array of strings.
+   */
+  value: ConditionValue;
+}
 
-    operator: 'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'in_condition_set';
+/**
+ * SUI transaction command attributes, enables allowlisting specific command types.
+ * Allowed commands: 'TransferObjects', 'SplitCoins', 'MergeCoins'. Only 'eq' and
+ * 'in' operators are supported.
+ */
+export interface SuiTransactionCommandCondition {
+  field: 'commandName';
 
-    value: string | Array<string>;
-  }
+  field_source: 'sui_transaction_command';
 
   /**
-   * Solana Program attributes, enables allowlisting Solana Programs.
+   * Operator to use for SUI transaction command conditions. Only 'eq' and 'in' are
+   * supported for command names.
    */
-  export interface SolanaProgramInstructionCondition {
-    field: 'programId';
+  operator: SuiTransactionCommandOperator;
 
-    field_source: 'solana_program_instruction';
+  /**
+   * Command name(s) to match. Must be one of: 'TransferObjects', 'SplitCoins',
+   * 'MergeCoins'
+   */
+  value: WalletsAPI.SuiCommandName | Array<WalletsAPI.SuiCommandName>;
+}
 
-    operator: 'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'in_condition_set';
+/**
+ * SUI TransferObjects command attributes, including recipient and amount fields.
+ */
+export interface SuiTransferObjectsCommandCondition {
+  /**
+   * Supported fields for SUI TransferObjects command conditions. Only 'recipient'
+   * and 'amount' are supported.
+   */
+  field: SuiTransferObjectsCommandField;
 
-    value: string | Array<string>;
-  }
+  field_source: 'sui_transfer_objects_command';
 
   /**
-   * Solana System Program attributes, including more granular Transfer instruction
-   * fields.
+   * Operator to use for policy conditions.
    */
-  export interface SolanaSystemProgramInstructionCondition {
-    field: 'instructionName' | 'Transfer.from' | 'Transfer.to' | 'Transfer.lamports';
+  operator: ConditionOperator;
 
-    field_source: 'solana_system_program_instruction';
+  /**
+   * Value to compare against in a policy condition. Can be a single string or an
+   * array of strings.
+   */
+  value: ConditionValue;
+}
 
-    operator: 'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'in_condition_set';
+/**
+ * Condition referencing an aggregation value. The field must start with
+ * "aggregation." followed by the aggregation ID.
+ */
+export interface AggregationCondition {
+  field: string;
 
-    value: string | Array<string>;
-  }
+  field_source: 'reference';
 
   /**
-   * Solana Token Program attributes, including more granular TransferChecked
-   * instruction fields.
-   */
-  export interface SolanaTokenProgramInstructionCondition {
-    field:
-      | 'instructionName'
-      | 'Transfer.source'
-      | 'Transfer.destination'
-      | 'Transfer.authority'
-      | 'Transfer.amount'
-      | 'TransferChecked.source'
-      | 'TransferChecked.destination'
-      | 'TransferChecked.authority'
-      | 'TransferChecked.amount'
-      | 'TransferChecked.mint'
-      | 'Burn.account'
-      | 'Burn.mint'
-      | 'Burn.authority'
-      | 'Burn.amount'
-      | 'MintTo.mint'
-      | 'MintTo.account'
-      | 'MintTo.authority'
-      | 'MintTo.amount'
-      | 'CloseAccount.account'
-      | 'CloseAccount.destination'
-      | 'CloseAccount.authority'
-      | 'InitializeAccount3.account'
-      | 'InitializeAccount3.mint'
-      | 'InitializeAccount3.owner';
-
-    field_source: 'solana_token_program_instruction';
-
-    operator: 'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'in_condition_set';
-
-    value: string | Array<string>;
-  }
+   * Operator to use for policy conditions.
+   */
+  operator: ConditionOperator;
 
   /**
-   * System attributes, including current unix timestamp (in seconds).
+   * Value to compare against in a policy condition. Can be a single string or an
+   * array of strings.
    */
-  export interface SystemCondition {
-    field: 'current_unix_timestamp';
-
-    field_source: 'system';
-
-    operator: 'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'in_condition_set';
-
-    value: string | Array<string>;
-  }
+  value: ConditionValue;
 }
 
+/**
+ * A condition that must be true for the rule action to be applied.
+ */
+export type PolicyCondition =
+  | EthereumTransactionCondition
+  | EthereumCalldataCondition
+  | EthereumTypedDataDomainCondition
+  | EthereumTypedDataMessageCondition
+  | Ethereum7702AuthorizationCondition
+  | SolanaProgramInstructionCondition
+  | SolanaSystemProgramInstructionCondition
+  | SolanaTokenProgramInstructionCondition
+  | SystemCondition
+  | TronTransactionCondition
+  | TronCalldataCondition
+  | SuiTransactionCommandCondition
+  | SuiTransferObjectsCommandCondition
+  | AggregationCondition;
+
 /**
  * Method the rule applies to.
  */
@@ -860,6 +960,22 @@ export interface Policy {
   version: '1.0';
 }
 
+/**
+ * Unique ID of the policy to take actions on.
+ */
+export interface PolicyRequestBody {
+  policy_id: string;
+}
+
+/**
+ * Unique IDs of the policy and the rule within the policy to take actions on.
+ */
+export interface PolicyRuleRequestParams {
+  policy_id: string;
+
+  rule_id: string;
+}
+
 /**
  * Headers required to authorize modifications to policies.
  */
@@ -1125,8 +1241,19 @@ export declare namespace Policies {
     type PolicyAction as PolicyAction,
     type AbiParameter as AbiParameter,
     type AbiSchema as AbiSchema,
+    type ConditionOperator as ConditionOperator,
+    type ConditionValue as ConditionValue,
     type SuiTransactionCommandOperator as SuiTransactionCommandOperator,
     type SuiTransferObjectsCommandField as SuiTransferObjectsCommandField,
+    type EthereumTransactionCondition as EthereumTransactionCondition,
+    type EthereumCalldataCondition as EthereumCalldataCondition,
+    type EthereumTypedDataDomainCondition as EthereumTypedDataDomainCondition,
+    type EthereumTypedDataMessageCondition as EthereumTypedDataMessageCondition,
+    type Ethereum7702AuthorizationCondition as Ethereum7702AuthorizationCondition,
+    type SolanaProgramInstructionCondition as SolanaProgramInstructionCondition,
+    type SolanaSystemProgramInstructionCondition as SolanaSystemProgramInstructionCondition,
+    type SolanaTokenProgramInstructionCondition as SolanaTokenProgramInstructionCondition,
+    type SystemCondition as SystemCondition,
     type TronTransactionCondition as TronTransactionCondition,
     type TronCalldataCondition as TronCalldataCondition,
     type SuiTransactionCommandCondition as SuiTransactionCommandCondition,
@@ -1137,6 +1264,8 @@ export declare namespace Policies {
     type PolicyRuleRequestBody as PolicyRuleRequestBody,
     type PolicyRuleResponse as PolicyRuleResponse,
     type Policy as Policy,
+    type PolicyRequestBody as PolicyRequestBody,
+    type PolicyRuleRequestParams as PolicyRuleRequestParams,
     type PolicyAuthorizationHeaders as PolicyAuthorizationHeaders,
     type ConditionSetAuthorizationHeaders as ConditionSetAuthorizationHeaders,
     type PolicyCreateParams as PolicyCreateParams,

package/src/resources/swaps.ts

@@ -12,7 +12,7 @@ export type SwapAmountType = 'exact_input' | 'exact_output';
 /**
  * Input for requesting a token swap quote.
  */
-export interface SwapQuoteRequest {
+export interface SwapQuoteRequestBody {
   /**
    * Amount in base units (e.g., wei for ETH).
    */
@@ -88,7 +88,7 @@ export interface SwapQuoteResponse {
 /**
  * Input for executing a token swap.
  */
-export interface SwapRequest {
+export interface SwapRequestBody {
   /**
    * Amount in base units (e.g., wei for ETH).
    */
@@ -129,8 +129,8 @@ export interface SwapRequest {
 export declare namespace Swaps {
   export {
     type SwapAmountType as SwapAmountType,
-    type SwapQuoteRequest as SwapQuoteRequest,
+    type SwapQuoteRequestBody as SwapQuoteRequestBody,
     type SwapQuoteResponse as SwapQuoteResponse,
-    type SwapRequest as SwapRequest,
+    type SwapRequestBody as SwapRequestBody,
   };
 }