@privy-io/api-types 0.10.0 → 0.12.0

package/src/resources/transactions.ts

@@ -1,60 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
-import { APIPromise } from '../core/api-promise';
-import { RequestOptions } from '../internal/request-options';
-import { path } from '../internal/utils/path';
 
-/**
- * Operations related to transactions
- */
-export class Transactions extends APIResource {
-  /**
-   * Get a transaction by transaction ID.
-   *
-   * @example
-   * ```ts
-   * const transaction = await client.transactions.get(
-   *   'transaction_id',
-   * );
-   * ```
-   */
-  get(transactionID: string, options?: RequestOptions): APIPromise<Transaction> {
-    return this._client.get(path`/v1/transactions/${transactionID}`, options);
-  }
-}
-
-/**
- * The request body for scanning a transaction.
- */
-export interface TransactionScanningRequestBody {
-  chain_id: string;
-
-  /**
-   * Additional information for Blockaid to validate against.
-   */
-  metadata: TransactionScanningMetadata;
-
-  /**
-   * Raw RPC request to execute with the wallet.
-   */
-  request: TransactionScanningRpcRequest;
-}
-
-/**
- * The response from scanning a transaction.
- */
-export interface TransactionScanningResponseBody {
-  /**
-   * The simulation result from a transaction scan.
-   */
-  simulation: TransactionScanningSimulationResult;
-
-  /**
-   * The validation result from a transaction scan.
-   */
-  validation: TransactionScanningValidationResult;
-}
+export class Transactions extends APIResource {}
 
 /**
  * A transaction from a Privy wallet.
@@ -188,6 +136,38 @@ export interface TransactionScanningParams {
   value?: string;
 }
 
+/**
+ * The request body for scanning a transaction.
+ */
+export interface TransactionScanningRequestBody {
+  chain_id: string;
+
+  /**
+   * Additional information for Blockaid to validate against.
+   */
+  metadata: TransactionScanningMetadata;
+
+  /**
+   * Raw RPC request to execute with the wallet.
+   */
+  request: TransactionScanningRpcRequest;
+}
+
+/**
+ * The response from scanning a transaction.
+ */
+export interface TransactionScanningResponseBody {
+  /**
+   * The simulation result from a transaction scan.
+   */
+  simulation: TransactionScanningSimulationResult;
+
+  /**
+   * The validation result from a transaction scan.
+   */
+  validation: TransactionScanningValidationResult;
+}
+
 /**
  * Raw RPC request to execute with the wallet.
  */
@@ -256,8 +236,6 @@ export interface TransactionScanningValidationSuccessResult {
 
 export declare namespace Transactions {
   export {
-    type TransactionScanningRequestBody as TransactionScanningRequestBody,
-    type TransactionScanningResponseBody as TransactionScanningResponseBody,
     type Transaction as Transaction,
     type TransactionList as TransactionList,
     type TransactionScanningAssetDiff as TransactionScanningAssetDiff,
@@ -267,6 +245,8 @@ export declare namespace Transactions {
     type TransactionScanningExposure as TransactionScanningExposure,
     type TransactionScanningMetadata as TransactionScanningMetadata,
     type TransactionScanningParams as TransactionScanningParams,
+    type TransactionScanningRequestBody as TransactionScanningRequestBody,
+    type TransactionScanningResponseBody as TransactionScanningResponseBody,
     type TransactionScanningRpcRequest as TransactionScanningRpcRequest,
     type TransactionScanningSimulationErrorResult as TransactionScanningSimulationErrorResult,
     type TransactionScanningSimulationResult as TransactionScanningSimulationResult,

package/src/resources/users.ts

@@ -4,324 +4,9 @@ import { APIResource } from '../core/resource';
 import * as UsersAPI from './users';
 import * as ClientAuthAPI from './client-auth';
 import * as EmbeddedWalletsAPI from './embedded-wallets';
-import * as SharedAPI from './shared';
 import * as WalletsAPI from './wallets/wallets';
-import { APIPromise } from '../core/api-promise';
-import { Cursor, type CursorParams, PagePromise } from '../core/pagination';
-import { buildHeaders } from '../internal/headers';
-import { RequestOptions } from '../internal/request-options';
-import { path } from '../internal/utils/path';
 
-/**
- * Operations related to users
- */
-export class Users extends APIResource {
-  /**
-   * Create a new user with linked accounts. Optionally pre-generate embedded wallets
-   * for the user.
-   *
-   * @example
-   * ```ts
-   * const user = await client.users.create({
-   *   linked_accounts: [
-   *     { address: 'tom.bombadill@privy.io', type: 'email' },
-   *   ],
-   * });
-   * ```
-   */
-  create(body: UserCreateParams, options?: RequestOptions): APIPromise<User> {
-    return this._client.post('/v1/users', { body, ...options });
-  }
-
-  /**
-   * Get all users in your app.
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const user of client.users.list()) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    query: UserListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<UsersCursor, User> {
-    return this._client.getAPIList('/v1/users', Cursor<User>, { query, ...options });
-  }
-
-  /**
-   * Delete a user by user ID.
-   *
-   * @example
-   * ```ts
-   * await client.users.delete('user_id');
-   * ```
-   */
-  delete(userID: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/v1/users/${userID}`, {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
-  }
-
-  /**
-   * Get a user by user ID.
-   *
-   * @example
-   * ```ts
-   * const user = await client.users._get('user_id');
-   * ```
-   */
-  _get(userID: string, options?: RequestOptions): APIPromise<User> {
-    return this._client.get(path`/v1/users/${userID}`, options);
-  }
-
-  /**
-   * Looks up a user by their custom auth ID.
-   *
-   * @example
-   * ```ts
-   * const user = await client.users.getByCustomAuthID({
-   *   custom_user_id: 'custom_user_id',
-   * });
-   * ```
-   */
-  getByCustomAuthID(body: UserGetByCustomAuthIDParams, options?: RequestOptions): APIPromise<User> {
-    return this._client.post('/v1/users/custom_auth/id', { body, ...options });
-  }
-
-  /**
-   * Looks up a user by their Discord username.
-   *
-   * @example
-   * ```ts
-   * const user = await client.users.getByDiscordUsername({
-   *   username: 'username',
-   * });
-   * ```
-   */
-  getByDiscordUsername(body: UserGetByDiscordUsernameParams, options?: RequestOptions): APIPromise<User> {
-    return this._client.post('/v1/users/discord/username', { body, ...options });
-  }
-
-  /**
-   * Looks up a user by their email address.
-   *
-   * @example
-   * ```ts
-   * const user = await client.users.getByEmailAddress({
-   *   address: 'dev@stainless.com',
-   * });
-   * ```
-   */
-  getByEmailAddress(body: UserGetByEmailAddressParams, options?: RequestOptions): APIPromise<User> {
-    return this._client.post('/v1/users/email/address', { body, ...options });
-  }
-
-  /**
-   * Looks up a user by their Farcaster ID.
-   *
-   * @example
-   * ```ts
-   * const user = await client.users.getByFarcasterID({
-   *   fid: 0,
-   * });
-   * ```
-   */
-  getByFarcasterID(body: UserGetByFarcasterIDParams, options?: RequestOptions): APIPromise<User> {
-    return this._client.post('/v1/users/farcaster/fid', { body, ...options });
-  }
-
-  /**
-   * Looks up a user by their Github username.
-   *
-   * @example
-   * ```ts
-   * const user = await client.users.getByGitHubUsername({
-   *   username: 'username',
-   * });
-   * ```
-   */
-  getByGitHubUsername(body: UserGetByGitHubUsernameParams, options?: RequestOptions): APIPromise<User> {
-    return this._client.post('/v1/users/github/username', { body, ...options });
-  }
-
-  /**
-   * Looks up a user by their phone number.
-   *
-   * @example
-   * ```ts
-   * const user = await client.users.getByPhoneNumber({
-   *   number: 'number',
-   * });
-   * ```
-   */
-  getByPhoneNumber(body: UserGetByPhoneNumberParams, options?: RequestOptions): APIPromise<User> {
-    return this._client.post('/v1/users/phone/number', { body, ...options });
-  }
-
-  /**
-   * Looks up a user by their smart wallet address.
-   *
-   * @example
-   * ```ts
-   * const user = await client.users.getBySmartWalletAddress({
-   *   address: 'address',
-   * });
-   * ```
-   */
-  getBySmartWalletAddress(
-    body: UserGetBySmartWalletAddressParams,
-    options?: RequestOptions,
-  ): APIPromise<User> {
-    return this._client.post('/v1/users/smart_wallet/address', { body, ...options });
-  }
-
-  /**
-   * Looks up a user by their Telegram user ID.
-   *
-   * @example
-   * ```ts
-   * const user = await client.users.getByTelegramUserID({
-   *   telegram_user_id: 'telegram_user_id',
-   * });
-   * ```
-   */
-  getByTelegramUserID(body: UserGetByTelegramUserIDParams, options?: RequestOptions): APIPromise<User> {
-    return this._client.post('/v1/users/telegram/telegram_user_id', { body, ...options });
-  }
-
-  /**
-   * Looks up a user by their Telegram username.
-   *
-   * @example
-   * ```ts
-   * const user = await client.users.getByTelegramUsername({
-   *   username: 'username',
-   * });
-   * ```
-   */
-  getByTelegramUsername(body: UserGetByTelegramUsernameParams, options?: RequestOptions): APIPromise<User> {
-    return this._client.post('/v1/users/telegram/username', { body, ...options });
-  }
-
-  /**
-   * Looks up a user by their Twitter subject.
-   *
-   * @example
-   * ```ts
-   * const user = await client.users.getByTwitterSubject({
-   *   subject: 'subject',
-   * });
-   * ```
-   */
-  getByTwitterSubject(body: UserGetByTwitterSubjectParams, options?: RequestOptions): APIPromise<User> {
-    return this._client.post('/v1/users/twitter/subject', { body, ...options });
-  }
-
-  /**
-   * Looks up a user by their Twitter username.
-   *
-   * @example
-   * ```ts
-   * const user = await client.users.getByTwitterUsername({
-   *   username: 'username',
-   * });
-   * ```
-   */
-  getByTwitterUsername(body: UserGetByTwitterUsernameParams, options?: RequestOptions): APIPromise<User> {
-    return this._client.post('/v1/users/twitter/username', { body, ...options });
-  }
-
-  /**
-   * Looks up a user by their wallet address.
-   *
-   * @example
-   * ```ts
-   * const user = await client.users.getByWalletAddress({
-   *   address: 'address',
-   * });
-   * ```
-   */
-  getByWalletAddress(body: UserGetByWalletAddressParams, options?: RequestOptions): APIPromise<User> {
-    return this._client.post('/v1/users/wallet/address', { body, ...options });
-  }
-
-  /**
-   * Creates an embedded wallet for an existing user.
-   *
-   * @example
-   * ```ts
-   * const user = await client.users.pregenerateWallets(
-   *   'user_id',
-   *   { wallets: [{ chain_type: 'ethereum' }] },
-   * );
-   * ```
-   */
-  pregenerateWallets(
-    userID: string,
-    body: UserPregenerateWalletsParams,
-    options?: RequestOptions,
-  ): APIPromise<User> {
-    return this._client.post(path`/v1/users/${userID}/wallets`, { body, ...options });
-  }
-
-  /**
-   * Search users by search term, emails, phone numbers, or wallet addresses.
-   *
-   * @example
-   * ```ts
-   * const user = await client.users.search({
-   *   searchTerm: 'searchTerm',
-   * });
-   * ```
-   */
-  search(body: UserSearchParams, options?: RequestOptions): APIPromise<User> {
-    return this._client.post('/v1/users/search', { body, ...options });
-  }
-
-  /**
-   * Adds custom metadata to a user by user ID.
-   *
-   * @example
-   * ```ts
-   * const user = await client.users.setCustomMetadata(
-   *   'user_id',
-   *   { custom_metadata: { key: 'value' } },
-   * );
-   * ```
-   */
-  setCustomMetadata(
-    userID: string,
-    body: UserSetCustomMetadataParams,
-    options?: RequestOptions,
-  ): APIPromise<User> {
-    return this._client.post(path`/v1/users/${userID}/custom_metadata`, { body, ...options });
-  }
-
-  /**
-   * Unlinks a user linked account.
-   *
-   * @example
-   * ```ts
-   * const user = await client.users.unlinkLinkedAccount(
-   *   'user_id',
-   *   { handle: 'test@test.com', type: 'email' },
-   * );
-   * ```
-   */
-  unlinkLinkedAccount(
-    userID: string,
-    body: UserUnlinkLinkedAccountParams,
-    options?: RequestOptions,
-  ): APIPromise<User> {
-    return this._client.post(path`/v1/users/${userID}/accounts/unlink`, { body, ...options });
-  }
-}
-
-export type UsersCursor = Cursor<User>;
+export class Users extends APIResource {}
 
 /**
  * The authenticated user.
@@ -1592,150 +1277,6 @@ export interface UserWithIdentityToken {
   user: User;
 }
 
-export interface UserCreateParams {
-  linked_accounts: Array<LinkedAccountInput>;
-
-  /**
-   * Custom metadata associated with the user.
-   */
-  custom_metadata?: CustomMetadata;
-
-  /**
-   * Wallets to create for the user.
-   */
-  wallets?: Array<UserCreateParams.Wallet>;
-}
-
-export namespace UserCreateParams {
-  export interface Wallet {
-    /**
-     * The wallet chain types.
-     */
-    chain_type: WalletsAPI.WalletChainType;
-
-    /**
-     * Additional signers for the wallet.
-     */
-    additional_signers?: Array<Wallet.AdditionalSigner>;
-
-    /**
-     * Create a smart wallet with this wallet as the signer. Only supported for wallets
-     * with `chain_type: "ethereum"`.
-     */
-    create_smart_wallet?: boolean;
-
-    /**
-     * Policy IDs to enforce on the wallet. Currently, only one policy is supported per
-     * wallet.
-     */
-    policy_ids?: Array<string>;
-  }
-
-  export namespace Wallet {
-    export interface AdditionalSigner {
-      /**
-       * A unique identifier for a key quorum.
-       */
-      signer_id: SharedAPI.KeyQuorumID;
-
-      /**
-       * 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. Currently, only one
-       * policy is supported per signer.
-       */
-      override_policy_ids?: Array<string>;
-    }
-  }
-}
-
-export interface UserListParams extends CursorParams {}
-
-export interface UserGetByCustomAuthIDParams {
-  custom_user_id: string;
-}
-
-export interface UserGetByDiscordUsernameParams {
-  username: string;
-}
-
-export interface UserGetByEmailAddressParams {
-  address: string;
-}
-
-export interface UserGetByFarcasterIDParams {
-  fid: number;
-}
-
-export interface UserGetByGitHubUsernameParams {
-  username: string;
-}
-
-export interface UserGetByPhoneNumberParams {
-  number: string;
-}
-
-export interface UserGetBySmartWalletAddressParams {
-  address: string;
-}
-
-export interface UserGetByTelegramUserIDParams {
-  telegram_user_id: string;
-}
-
-export interface UserGetByTelegramUsernameParams {
-  username: string;
-}
-
-export interface UserGetByTwitterSubjectParams {
-  subject: string;
-}
-
-export interface UserGetByTwitterUsernameParams {
-  username: string;
-}
-
-export interface UserGetByWalletAddressParams {
-  address: string;
-}
-
-export interface UserPregenerateWalletsParams {
-  wallets: Array<EmbeddedWalletsAPI.WalletCreationInput>;
-}
-
-export type UserSearchParams = UserSearchParams.Variant0 | UserSearchParams.Variant1;
-
-export declare namespace UserSearchParams {
-  export interface Variant0 {
-    searchTerm: string;
-  }
-
-  export interface Variant1 {
-    emails: Array<string>;
-
-    phoneNumbers: Array<string>;
-
-    walletAddresses: Array<string>;
-  }
-}
-
-export interface UserSetCustomMetadataParams {
-  /**
-   * Custom metadata associated with the user.
-   */
-  custom_metadata: CustomMetadata;
-}
-
-export interface UserUnlinkLinkedAccountParams {
-  handle: string;
-
-  /**
-   * The possible types of linked accounts.
-   */
-  type: LinkedAccountType;
-
-  provider?: string;
-}
-
 export declare namespace Users {
   export {
     type AuthenticatedUser as AuthenticatedUser,
@@ -1804,24 +1345,5 @@ export declare namespace Users {
     type User as User,
     type UserBatchCreateInput as UserBatchCreateInput,
     type UserWithIdentityToken as UserWithIdentityToken,
-    type UsersCursor as UsersCursor,
-    type UserCreateParams as UserCreateParams,
-    type UserListParams as UserListParams,
-    type UserGetByCustomAuthIDParams as UserGetByCustomAuthIDParams,
-    type UserGetByDiscordUsernameParams as UserGetByDiscordUsernameParams,
-    type UserGetByEmailAddressParams as UserGetByEmailAddressParams,
-    type UserGetByFarcasterIDParams as UserGetByFarcasterIDParams,
-    type UserGetByGitHubUsernameParams as UserGetByGitHubUsernameParams,
-    type UserGetByPhoneNumberParams as UserGetByPhoneNumberParams,
-    type UserGetBySmartWalletAddressParams as UserGetBySmartWalletAddressParams,
-    type UserGetByTelegramUserIDParams as UserGetByTelegramUserIDParams,
-    type UserGetByTelegramUsernameParams as UserGetByTelegramUsernameParams,
-    type UserGetByTwitterSubjectParams as UserGetByTwitterSubjectParams,
-    type UserGetByTwitterUsernameParams as UserGetByTwitterUsernameParams,
-    type UserGetByWalletAddressParams as UserGetByWalletAddressParams,
-    type UserPregenerateWalletsParams as UserPregenerateWalletsParams,
-    type UserSearchParams as UserSearchParams,
-    type UserSetCustomMetadataParams as UserSetCustomMetadataParams,
-    type UserUnlinkLinkedAccountParams as UserUnlinkLinkedAccountParams,
   };
 }

package/src/resources/wallet-actions.ts

@@ -507,6 +507,35 @@ export interface EthereumEarnVaultDetailsResponse {
   vault_address: string;
 }
 
+/**
+ * A wallet action step representing a cross-chain/cross-asset fill by an external
+ * provider.
+ */
+export interface ExternalTransactionWalletActionStep {
+  /**
+   * Status of an external transaction step in a wallet action.
+   */
+  status: ExternalTransactionWalletActionStepStatus;
+
+  type: 'external_transaction';
+
+  /**
+   * A description of why a wallet action (or a step within a wallet action) failed.
+   */
+  failure_reason?: FailureReason;
+}
+
+/**
+ * Status of an external transaction step in a wallet action.
+ */
+export type ExternalTransactionWalletActionStepStatus =
+  | 'preparing'
+  | 'queued'
+  | 'pending'
+  | 'confirmed'
+  | 'rejected'
+  | 'failed';
+
 /**
  * A description of why a wallet action (or a step within a wallet action) failed.
  */
@@ -732,12 +761,17 @@ export type WalletActionStatus = 'pending' | 'succeeded' | 'rejected' | 'failed'
 export type WalletActionStep =
   | EvmTransactionWalletActionStep
   | EvmUserOperationWalletActionStep
-  | SvmTransactionWalletActionStep;
+  | SvmTransactionWalletActionStep
+  | ExternalTransactionWalletActionStep;
 
 /**
  * Type of a wallet action step.
  */
-export type WalletActionStepType = 'evm_transaction' | 'evm_user_operation' | 'svm_transaction';
+export type WalletActionStepType =
+  | 'evm_transaction'
+  | 'evm_user_operation'
+  | 'svm_transaction'
+  | 'external_transaction';
 
 /**
  * Type of wallet action
@@ -766,6 +800,8 @@ export declare namespace WalletActions {
     type EthereumEarnPositionResponse as EthereumEarnPositionResponse,
     type EthereumEarnProvider as EthereumEarnProvider,
     type EthereumEarnVaultDetailsResponse as EthereumEarnVaultDetailsResponse,
+    type ExternalTransactionWalletActionStep as ExternalTransactionWalletActionStep,
+    type ExternalTransactionWalletActionStepStatus as ExternalTransactionWalletActionStepStatus,
     type FailureReason as FailureReason,
     type SvmTransactionWalletActionStep as SvmTransactionWalletActionStep,
     type SvmWalletActionStepStatus as SvmWalletActionStepStatus,