@privy-io/api-types 0.4.0 → 0.6.0

package/src/resources/wallets/wallets.ts

@@ -270,6 +270,13 @@ export class Wallets extends APIResource {
 
 export type WalletsCursor = Cursor<Wallet>;
 
+/**
+ * The response body from revoking a wallet delegation.
+ */
+export interface WalletRevokeResponse {
+  message: string;
+}
+
 /**
  * The wallet chain types that support curve-based signing.
  */
@@ -286,87 +293,9 @@ export type CurveSigningChainType =
   | 'starknet';
 
 /**
- * The wallet chain types that offer first class support.
- */
-export type FirstClassChainType = 'ethereum' | 'solana';
-
-/**
- * A wallet managed by Privy's wallet infrastructure.
- */
-export interface Wallet {
-  /**
-   * Unique ID of the wallet. This will be the primary identifier when using the
-   * wallet in the future.
-   */
-  id: string;
-
-  /**
-   * Additional signers for the wallet.
-   */
-  additional_signers: Array<Wallet.AdditionalSigner>;
-
-  /**
-   * Address of the wallet.
-   */
-  address: string;
-
-  /**
-   * The wallet chain types.
-   */
-  chain_type: WalletChainType;
-
-  /**
-   * Unix timestamp of when the wallet was created in milliseconds.
-   */
-  created_at: number;
-
-  /**
-   * Unix timestamp of when the wallet was exported in milliseconds, if the wallet
-   * was exported.
-   */
-  exported_at: number | null;
-
-  /**
-   * Unix timestamp of when the wallet was imported in milliseconds, if the wallet
-   * was imported.
-   */
-  imported_at: number | null;
-
-  /**
-   * The key quorum ID of the owner of the wallet.
-   */
-  owner_id: string | null;
-
-  /**
-   * List of policy IDs for policies that are enforced on the wallet.
-   */
-  policy_ids: Array<string>;
-
-  /**
-   * The compressed, raw public key for the wallet along the chain cryptographic
-   * curve.
-   */
-  public_key?: string;
-}
-
-export namespace Wallet {
-  export interface AdditionalSigner {
-    signer_id: string;
-
-    /**
-     * The array of policy IDs that will be applied to wallet requests. If specified,
-     * this will override the base policy IDs set on the wallet.
-     */
-    override_policy_ids?: Array<string>;
-  }
-}
-
-/**
- * The wallet chain types.
+ * The wallet chain types that are not first class chains.
  */
-export type WalletChainType =
-  | 'ethereum'
-  | 'solana'
+export type ExtendedChainType =
   | 'cosmos'
   | 'stellar'
   | 'sui'
@@ -380,16 +309,16 @@ export type WalletChainType =
   | 'spark';
 
 /**
- * The response body from revoking a wallet delegation.
+ * The wallet chain types that offer first class support.
  */
-export interface WalletRevokeResponse {
-  message: string;
-}
+export type FirstClassChainType = 'ethereum' | 'solana';
 
 /**
- * The wallet chain types that are not first class chains.
+ * The wallet chain types.
  */
-export type ExtendedChainType =
+export type WalletChainType =
+  | 'ethereum'
+  | 'solana'
   | 'cosmos'
   | 'stellar'
   | 'sui'
@@ -406,7 +335,15 @@ export type ExtendedChainType =
  * Information about the custodian managing this wallet.
  */
 export interface WalletCustodian {
-  name: string;
+  /**
+   * The custodian responsible for the wallet.
+   */
+  provider: string;
+
+  /**
+   * The resource ID of the beneficiary of the custodial wallet.
+   */
+  provider_user_id: string;
 }
 
 /**
@@ -475,12 +412,12 @@ export interface CustodialWallet {
    */
   chain_type: CustodialWalletChainType;
 
-  owner_id: string | null;
-
   /**
-   * The provider of the custodial wallet.
+   * Information about the custodian managing this wallet.
    */
-  provider: CustodialWalletProvider;
+  custody: WalletCustodian;
+
+  owner_id: string | null;
 
   additional_signers?: Array<CustodialWallet.AdditionalSigner>;
 
@@ -525,6 +462,210 @@ export interface HpkeImportConfig {
  */
 export type SuiCommandName = 'TransferObjects' | 'SplitCoins' | 'MergeCoins';
 
+/**
+ * A wallet managed by Privy's wallet infrastructure.
+ */
+export interface Wallet {
+  /**
+   * Unique ID of the wallet. This will be the primary identifier when using the
+   * wallet in the future.
+   */
+  id: string;
+
+  /**
+   * Additional signers for the wallet.
+   */
+  additional_signers: Array<Wallet.AdditionalSigner>;
+
+  /**
+   * Address of the wallet.
+   */
+  address: string;
+
+  /**
+   * The wallet chain types.
+   */
+  chain_type: WalletChainType;
+
+  /**
+   * Unix timestamp of when the wallet was created in milliseconds.
+   */
+  created_at: number;
+
+  /**
+   * Unix timestamp of when the wallet was exported in milliseconds, if the wallet
+   * was exported.
+   */
+  exported_at: number | null;
+
+  /**
+   * Unix timestamp of when the wallet was imported in milliseconds, if the wallet
+   * was imported.
+   */
+  imported_at: number | null;
+
+  /**
+   * The key quorum ID of the owner of the wallet.
+   */
+  owner_id: string | null;
+
+  /**
+   * List of policy IDs for policies that are enforced on the wallet.
+   */
+  policy_ids: Array<string>;
+
+  /**
+   * The compressed, raw public key for the wallet along the chain cryptographic
+   * curve.
+   */
+  public_key?: string;
+}
+
+export namespace Wallet {
+  export interface AdditionalSigner {
+    signer_id: string;
+
+    /**
+     * The array of policy IDs that will be applied to wallet requests. If specified,
+     * this will override the base policy IDs set on the wallet.
+     */
+    override_policy_ids?: Array<string>;
+  }
+}
+
+/**
+ * Input for a single wallet in a batch creation request.
+ */
+export interface WalletBatchItemInput {
+  /**
+   * The wallet chain types.
+   */
+  chain_type: WalletChainType;
+
+  /**
+   * Additional signers for the wallet.
+   */
+  additional_signers?: Array<WalletBatchItemInput.AdditionalSigner>;
+
+  /**
+   * The owner of the resource. If you provide this, do not specify an owner_id as it
+   * will be generated automatically. When updating a wallet, you can set the owner
+   * to null to remove the owner.
+   */
+  owner?: WalletBatchItemInput.PublicKeyOwner | WalletBatchItemInput.UserOwner | null;
+
+  /**
+   * The key quorum ID to set as the owner of the resource. If you provide this, do
+   * not specify an owner.
+   */
+  owner_id?: string;
+
+  /**
+   * List of policy IDs for policies that should be enforced on the wallet.
+   * Currently, only one policy is supported per wallet.
+   */
+  policy_ids?: Array<string>;
+}
+
+export namespace WalletBatchItemInput {
+  export interface AdditionalSigner {
+    signer_id: string;
+
+    /**
+     * The array of policy IDs that will be applied to wallet requests. If specified,
+     * this will override the base policy IDs set on the wallet.
+     */
+    override_policy_ids?: Array<string>;
+  }
+
+  /**
+   * The P-256 public key of the owner of the resource, in base64-encoded DER format.
+   * If you provide this, do not specify an owner_id as it will be generated
+   * automatically.
+   */
+  export interface PublicKeyOwner {
+    public_key: string;
+  }
+
+  /**
+   * The user ID of the owner of the resource. The user must already exist, and this
+   * value must start with "did:privy:". If you provide this, do not specify an
+   * owner_id as it will be generated automatically.
+   */
+  export interface UserOwner {
+    user_id: string;
+  }
+}
+
+/**
+ * Request body for batch wallet creation.
+ */
+export interface WalletBatchCreateInput {
+  /**
+   * Array of wallet creation requests. Minimum 1, maximum 100.
+   */
+  wallets: Array<WalletBatchItemInput>;
+}
+
+/**
+ * A single result from a batch wallet creation operation.
+ */
+export type WalletBatchCreateResult =
+  | WalletBatchCreateResult.WalletBatchCreateSuccess
+  | WalletBatchCreateResult.WalletBatchCreateFailure;
+
+export namespace WalletBatchCreateResult {
+  /**
+   * A successful wallet creation result within a batch operation.
+   */
+  export interface WalletBatchCreateSuccess {
+    /**
+     * The index of the wallet in the original request array.
+     */
+    index: number;
+
+    success: true;
+
+    /**
+     * A wallet managed by Privy's wallet infrastructure.
+     */
+    wallet: WalletsAPI.Wallet;
+  }
+
+  /**
+   * A failed wallet creation result within a batch operation.
+   */
+  export interface WalletBatchCreateFailure {
+    /**
+     * A PrivyErrorCode string identifying the error type (e.g., "invalid_data",
+     * "resource_conflict").
+     */
+    code: string;
+
+    /**
+     * A human-readable error message with details about what went wrong.
+     */
+    error: string;
+
+    /**
+     * The index of the wallet in the original request array.
+     */
+    index: number;
+
+    success: false;
+  }
+}
+
+/**
+ * Response for a batch wallet creation request.
+ */
+export interface WalletBatchCreateResponse {
+  /**
+   * Array of results for each wallet creation request, in the same order as input.
+   */
+  results: Array<WalletBatchCreateResult>;
+}
+
 /**
  * Executes the EVM `personal_sign` RPC (EIP-191) to sign a message.
  */
@@ -1310,11 +1451,21 @@ export namespace WalletCreateParams {
 }
 
 export interface WalletListParams extends CursorParams {
+  /**
+   * Filter wallets by authorization public key. Returns wallets owned by key quorums
+   * that include the specified P-256 public key (base64-encoded DER format). Cannot
+   * be used together with user_id.
+   */
+  authorization_key?: string;
+
   /**
    * The wallet chain types.
    */
   chain_type?: WalletChainType;
 
+  /**
+   * Filter wallets by user ID. Cannot be used together with authorization_key.
+   */
   user_id?: string;
 }
 
@@ -2155,8 +2306,7 @@ export interface WalletUpdateParams {
   owner?: WalletUpdateParams.PublicKeyOwner | WalletUpdateParams.UserOwner | null;
 
   /**
-   * Body param: The key quorum ID to set as the owner of the resource. If you
-   * provide this, do not specify an owner.
+   * Body param
    */
   owner_id?: string | null;
 
@@ -2281,12 +2431,11 @@ Wallets.Balance = Balance;
 
 export declare namespace Wallets {
   export {
+    type WalletRevokeResponse as WalletRevokeResponse,
     type CurveSigningChainType as CurveSigningChainType,
+    type ExtendedChainType as ExtendedChainType,
     type FirstClassChainType as FirstClassChainType,
-    type Wallet as Wallet,
     type WalletChainType as WalletChainType,
-    type WalletRevokeResponse as WalletRevokeResponse,
-    type ExtendedChainType as ExtendedChainType,
     type WalletCustodian as WalletCustodian,
     type CustodialWalletProvider as CustodialWalletProvider,
     type CustodialWalletChainType as CustodialWalletChainType,
@@ -2294,6 +2443,11 @@ export declare namespace Wallets {
     type CustodialWallet as CustodialWallet,
     type HpkeImportConfig as HpkeImportConfig,
     type SuiCommandName as SuiCommandName,
+    type Wallet as Wallet,
+    type WalletBatchItemInput as WalletBatchItemInput,
+    type WalletBatchCreateInput as WalletBatchCreateInput,
+    type WalletBatchCreateResult as WalletBatchCreateResult,
+    type WalletBatchCreateResponse as WalletBatchCreateResponse,
     type EthereumPersonalSignRpcInput as EthereumPersonalSignRpcInput,
     type EthereumSignTransactionRpcInput as EthereumSignTransactionRpcInput,
     type EthereumSendTransactionRpcInput as EthereumSendTransactionRpcInput,