@privy-io/api-types 0.4.0 → 0.5.0

package/src/client.ts

@@ -22,6 +22,7 @@ import { APIPromise } from './core/api-promise';
 import {
   Aggregation,
   AggregationGroupBy,
+  AggregationInput,
   AggregationMethod,
   AggregationMetric,
   AggregationWindow,
@@ -30,7 +31,24 @@ import {
 import { Analytics, AnalyticsEventInput } from './resources/analytics';
 import { AppResponse, Apps } from './resources/apps';
 import {
+  BridgeBrlFiatVirtualAccountDepositInstructions,
+  BridgeDestinationAsset,
+  BridgeEurFiatVirtualAccountDepositInstructions,
+  BridgeFiatCustomerResponse,
+  BridgeFiatVirtualAccountDepositInstructions,
+  BridgeFiatVirtualAccountDestination,
+  BridgeFiatVirtualAccountRequest,
+  BridgeFiatVirtualAccountResponse,
+  BridgeFiatVirtualAccountSource,
+  BridgeGbpFiatVirtualAccountDepositInstructions,
+  BridgeMxnFiatVirtualAccountDepositInstructions,
+  BridgeSandboxFiatCustomerResponse,
+  BridgeSandboxFiatVirtualAccountRequest,
+  BridgeSandboxFiatVirtualAccountResponse,
+  BridgeSourceAsset,
+  BridgeUsdFiatVirtualAccountDepositInstructions,
   ClientAuth,
+  CreateOrUpdateFiatCustomerRequestInput,
   CustomJwtAuthenticateRequestBody,
   CustomJwtLinkRequestBody,
   CustomOAuthProviderID,
@@ -48,6 +66,10 @@ import {
   FarcasterV2AuthenticateRequestBody,
   FarcasterV2InitRequestBody,
   FarcasterV2InitResponseBody,
+  FiatCustomerResponse,
+  FiatVirtualAccountRequest,
+  FiatVirtualAccountResponse,
+  GetFiatCustomerRequestInput,
   GuestAuthenticateRequestBody,
   MfaPasskeyEnrollmentRequestBody,
   MfaPasskeyInitRequestBody,
@@ -69,6 +91,7 @@ import {
   OAuthUnlinkRequestBody,
   OAuthVerifyRequestBody,
   OAuthVerifyResponseBody,
+  OnrampProvider,
   OptionalRefreshTokenInput,
   PasskeyAuthenticateRequestBody,
   PasskeyInitAuthenticateResponseBody,
@@ -201,6 +224,7 @@ import {
   LinkedAccountLinkedInInput,
   LinkedAccountLinkedInOAuth,
   LinkedAccountPasskey,
+  LinkedAccountPasskeyInput,
   LinkedAccountPhone,
   LinkedAccountPhoneInput,
   LinkedAccountSmartWallet,
@@ -248,6 +272,54 @@ import {
   Users,
   UsersCursor,
 } from './resources/users';
+import {
+  FundsDepositedWebhookPayload,
+  FundsWithdrawnWebhookPayload,
+  KrakenEmbedQuoteCancelledWebhookPayload,
+  KrakenEmbedQuoteExecutedWebhookPayload,
+  KrakenEmbedQuoteExecutionFailedWebhookPayload,
+  KrakenEmbedUserClosedWebhookPayload,
+  KrakenEmbedUserDisabledWebhookPayload,
+  KrakenEmbedUserVerifiedWebhookPayload,
+  KrakenEmbedVerificationCompletedWebhookPayload,
+  KrakenEmbedVerificationFailedWebhookPayload,
+  MfaDisabledWebhookPayload,
+  MfaEnabledWebhookPayload,
+  PrivateKeyExportWebhookPayload,
+  TransactionBroadcastedWebhookPayload,
+  TransactionConfirmedWebhookPayload,
+  TransactionExecutionRevertedWebhookPayload,
+  TransactionFailedWebhookPayload,
+  TransactionProviderErrorWebhookPayload,
+  TransactionReplacedWebhookPayload,
+  TransactionStillPendingWebhookPayload,
+  UserAuthenticatedWebhookPayload,
+  UserCreatedWebhookPayload,
+  UserLinkedAccountWebhookPayload,
+  UserTransferredAccountWebhookPayload,
+  UserUnlinkedAccountWebhookPayload,
+  UserUpdatedAccountWebhookPayload,
+  UserWalletCreatedWebhookPayload,
+  WalletRecoveredWebhookPayload,
+  WalletRecoverySetupWebhookPayload,
+  Webhooks,
+} from './resources/webhooks';
+import {
+  EthereumVaultDetailsInput,
+  EthereumVaultDetailsResponse,
+  EthereumVaultPosition,
+  EthereumVaultResponse,
+  EthereumYieldDepositInput,
+  EthereumYieldPositionResponse,
+  EthereumYieldPositionsInput,
+  EthereumYieldProvider,
+  EthereumYieldSweepIDInput,
+  EthereumYieldSweepResponse,
+  EthereumYieldSweepStatus,
+  EthereumYieldSweepType,
+  EthereumYieldWithdrawInput,
+  Yield,
+} from './resources/yield';
 import {
   CurveSigningChainType,
   CustodialWallet,
@@ -281,6 +353,10 @@ import {
   Wallet,
   WalletAuthenticateWithJwtParams,
   WalletAuthenticateWithJwtResponse,
+  WalletBatchCreateInput,
+  WalletBatchCreateResponse,
+  WalletBatchCreateResult,
+  WalletBatchItemInput,
   WalletChainType,
   WalletCreateParams,
   WalletCreateWalletsWithRecoveryParams,
@@ -774,7 +850,7 @@ export class Privy {
       loggerFor(this).info(`${responseInfo} - ${retryMessage}`);
 
       const errText = await response.text().catch((err: any) => castToError(err).message);
-      const errJSON = safeJSON(errText);
+      const errJSON = safeJSON(errText) as any;
       const errMessage = errJSON ? undefined : errText;
 
       loggerFor(this).debug(
@@ -811,9 +887,14 @@ export class Privy {
   getAPIList<Item, PageClass extends Pagination.AbstractPage<Item> = Pagination.AbstractPage<Item>>(
     path: string,
     Page: new (...args: any[]) => PageClass,
-    opts?: RequestOptions,
+    opts?: PromiseOrValue<RequestOptions>,
   ): Pagination.PagePromise<PageClass, Item> {
-    return this.requestAPIList(Page, { method: 'get', path, ...opts });
+    return this.requestAPIList(
+      Page,
+      opts && 'then' in opts ?
+        opts.then((opts) => ({ method: 'get', path, ...opts }))
+      : { method: 'get', path, ...opts },
+    );
   }
 
   requestAPIList<
@@ -821,7 +902,7 @@ export class Privy {
     PageClass extends Pagination.AbstractPage<Item> = Pagination.AbstractPage<Item>,
   >(
     Page: new (...args: ConstructorParameters<typeof Pagination.AbstractPage>) => PageClass,
-    options: FinalRequestOptions,
+    options: PromiseOrValue<FinalRequestOptions>,
   ): Pagination.PagePromise<PageClass, Item> {
     const request = this.makeRequest(options, null, undefined);
     return new Pagination.PagePromise<PageClass, Item>(this as any as Privy, request, Page);
@@ -834,9 +915,10 @@ export class Privy {
     controller: AbortController,
   ): Promise<Response> {
     const { signal, method, ...options } = init || {};
-    if (signal) signal.addEventListener('abort', () => controller.abort());
+    const abort = this._makeAbort(controller);
+    if (signal) signal.addEventListener('abort', abort, { once: true });
 
-    const timeout = setTimeout(() => controller.abort(), ms);
+    const timeout = setTimeout(abort, ms);
 
     const isReadableBody =
       ((globalThis as any).ReadableStream && options.body instanceof (globalThis as any).ReadableStream) ||
@@ -1004,6 +1086,12 @@ export class Privy {
     return headers.values;
   }
 
+  private _makeAbort(controller: AbortController) {
+    // note: we can't just inline this method inside `fetchWithTimeout()` because then the closure
+    //       would capture all request options, and cause a memory leak.
+    return () => controller.abort();
+  }
+
   private buildBody({ options: { body, headers: rawHeaders } }: { options: FinalRequestOptions }): {
     bodyHeaders: HeadersLike;
     body: BodyInit | undefined;
@@ -1072,6 +1160,8 @@ export class Privy {
   transactions: API.Transactions = new API.Transactions(this);
   keyQuorums: API.KeyQuorums = new API.KeyQuorums(this);
   aggregations: API.Aggregations = new API.Aggregations(this);
+  webhooks: API.Webhooks = new API.Webhooks(this);
+  yield: API.Yield = new API.Yield(this);
 }
 
 Privy.Wallets = Wallets;
@@ -1086,6 +1176,8 @@ Privy.Policies = Policies;
 Privy.Transactions = Transactions;
 Privy.KeyQuorums = KeyQuorums;
 Privy.Aggregations = Aggregations;
+Privy.Webhooks = Webhooks;
+Privy.Yield = Yield;
 
 export declare namespace Privy {
   export type RequestOptions = Opts.RequestOptions;
@@ -1095,12 +1187,11 @@ export declare namespace Privy {
 
   export {
     Wallets as Wallets,
+    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,
@@ -1108,6 +1199,11 @@ export declare namespace Privy {
     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,
@@ -1237,6 +1333,28 @@ export declare namespace Privy {
     type PrivyOAuthProviderID as PrivyOAuthProviderID,
     type CustomOAuthProviderID as CustomOAuthProviderID,
     type OAuthProviderID as OAuthProviderID,
+    type OnrampProvider as OnrampProvider,
+    type GetFiatCustomerRequestInput as GetFiatCustomerRequestInput,
+    type CreateOrUpdateFiatCustomerRequestInput as CreateOrUpdateFiatCustomerRequestInput,
+    type BridgeFiatCustomerResponse as BridgeFiatCustomerResponse,
+    type BridgeSandboxFiatCustomerResponse as BridgeSandboxFiatCustomerResponse,
+    type FiatCustomerResponse as FiatCustomerResponse,
+    type BridgeDestinationAsset as BridgeDestinationAsset,
+    type BridgeSourceAsset as BridgeSourceAsset,
+    type BridgeFiatVirtualAccountSource as BridgeFiatVirtualAccountSource,
+    type BridgeFiatVirtualAccountDestination as BridgeFiatVirtualAccountDestination,
+    type BridgeFiatVirtualAccountRequest as BridgeFiatVirtualAccountRequest,
+    type BridgeSandboxFiatVirtualAccountRequest as BridgeSandboxFiatVirtualAccountRequest,
+    type FiatVirtualAccountRequest as FiatVirtualAccountRequest,
+    type BridgeUsdFiatVirtualAccountDepositInstructions as BridgeUsdFiatVirtualAccountDepositInstructions,
+    type BridgeEurFiatVirtualAccountDepositInstructions as BridgeEurFiatVirtualAccountDepositInstructions,
+    type BridgeMxnFiatVirtualAccountDepositInstructions as BridgeMxnFiatVirtualAccountDepositInstructions,
+    type BridgeBrlFiatVirtualAccountDepositInstructions as BridgeBrlFiatVirtualAccountDepositInstructions,
+    type BridgeGbpFiatVirtualAccountDepositInstructions as BridgeGbpFiatVirtualAccountDepositInstructions,
+    type BridgeFiatVirtualAccountDepositInstructions as BridgeFiatVirtualAccountDepositInstructions,
+    type BridgeFiatVirtualAccountResponse as BridgeFiatVirtualAccountResponse,
+    type BridgeSandboxFiatVirtualAccountResponse as BridgeSandboxFiatVirtualAccountResponse,
+    type FiatVirtualAccountResponse as FiatVirtualAccountResponse,
   };
 
   export { CrossApp as CrossApp, type CrossAppConnectionsResponse as CrossAppConnectionsResponse };
@@ -1252,10 +1370,6 @@ export declare namespace Privy {
 
   export {
     Users as Users,
-    type AuthenticatedUser as AuthenticatedUser,
-    type LinkedAccount as LinkedAccount,
-    type User as User,
-    type UserWithIdentityToken as UserWithIdentityToken,
     type LinkedAccountEmail as LinkedAccountEmail,
     type LinkedAccountPhone as LinkedAccountPhone,
     type LinkedAccountBaseWallet as LinkedAccountBaseWallet,
@@ -1291,6 +1405,7 @@ export declare namespace Privy {
     type CrossAppSmartWallet as CrossAppSmartWallet,
     type LinkedAccountCrossApp as LinkedAccountCrossApp,
     type LinkedAccountAuthorizationKey as LinkedAccountAuthorizationKey,
+    type LinkedAccount as LinkedAccount,
     type LinkedAccountType as LinkedAccountType,
     type CustomMetadata as CustomMetadata,
     type LinkedAccountWalletInput as LinkedAccountWalletInput,
@@ -1310,13 +1425,17 @@ export declare namespace Privy {
     type LinkedAccountFarcasterInput as LinkedAccountFarcasterInput,
     type LinkedAccountTelegramInput as LinkedAccountTelegramInput,
     type LinkedAccountCustomJwtInput as LinkedAccountCustomJwtInput,
+    type LinkedAccountPasskeyInput as LinkedAccountPasskeyInput,
     type LinkedAccountInput as LinkedAccountInput,
     type UserBatchCreateInput as UserBatchCreateInput,
     type SMSMfaMethod as SMSMfaMethod,
     type TotpMfaMethod as TotpMfaMethod,
     type PasskeyMfaMethod as PasskeyMfaMethod,
     type LinkedMfaMethod as LinkedMfaMethod,
+    type User as User,
     type OAuthTokens as OAuthTokens,
+    type UserWithIdentityToken as UserWithIdentityToken,
+    type AuthenticatedUser as AuthenticatedUser,
     type UsersCursor as UsersCursor,
     type UserCreateParams as UserCreateParams,
     type UserListParams as UserListParams,
@@ -1342,12 +1461,12 @@ export declare namespace Privy {
 
   export {
     Policies as Policies,
-    type Policy as Policy,
     type SuiTransactionCommandOperator as SuiTransactionCommandOperator,
     type SuiTransferObjectsCommandField as SuiTransferObjectsCommandField,
     type TronTransactionCondition as TronTransactionCondition,
     type SuiTransactionCommandCondition as SuiTransactionCommandCondition,
     type SuiTransferObjectsCommandCondition as SuiTransferObjectsCommandCondition,
+    type Policy as Policy,
     type PolicyCreateRuleResponse as PolicyCreateRuleResponse,
     type PolicyDeleteResponse as PolicyDeleteResponse,
     type PolicyDeleteRuleResponse as PolicyDeleteRuleResponse,
@@ -1385,5 +1504,56 @@ export declare namespace Privy {
     type AggregationWindow as AggregationWindow,
     type AggregationGroupBy as AggregationGroupBy,
     type Aggregation as Aggregation,
+    type AggregationInput as AggregationInput,
+  };
+
+  export {
+    Webhooks as Webhooks,
+    type UserCreatedWebhookPayload as UserCreatedWebhookPayload,
+    type UserAuthenticatedWebhookPayload as UserAuthenticatedWebhookPayload,
+    type UserLinkedAccountWebhookPayload as UserLinkedAccountWebhookPayload,
+    type UserUnlinkedAccountWebhookPayload as UserUnlinkedAccountWebhookPayload,
+    type UserUpdatedAccountWebhookPayload as UserUpdatedAccountWebhookPayload,
+    type UserTransferredAccountWebhookPayload as UserTransferredAccountWebhookPayload,
+    type UserWalletCreatedWebhookPayload as UserWalletCreatedWebhookPayload,
+    type TransactionBroadcastedWebhookPayload as TransactionBroadcastedWebhookPayload,
+    type TransactionConfirmedWebhookPayload as TransactionConfirmedWebhookPayload,
+    type TransactionExecutionRevertedWebhookPayload as TransactionExecutionRevertedWebhookPayload,
+    type TransactionStillPendingWebhookPayload as TransactionStillPendingWebhookPayload,
+    type TransactionFailedWebhookPayload as TransactionFailedWebhookPayload,
+    type TransactionReplacedWebhookPayload as TransactionReplacedWebhookPayload,
+    type TransactionProviderErrorWebhookPayload as TransactionProviderErrorWebhookPayload,
+    type FundsDepositedWebhookPayload as FundsDepositedWebhookPayload,
+    type FundsWithdrawnWebhookPayload as FundsWithdrawnWebhookPayload,
+    type PrivateKeyExportWebhookPayload as PrivateKeyExportWebhookPayload,
+    type WalletRecoverySetupWebhookPayload as WalletRecoverySetupWebhookPayload,
+    type WalletRecoveredWebhookPayload as WalletRecoveredWebhookPayload,
+    type MfaEnabledWebhookPayload as MfaEnabledWebhookPayload,
+    type MfaDisabledWebhookPayload as MfaDisabledWebhookPayload,
+    type KrakenEmbedVerificationCompletedWebhookPayload as KrakenEmbedVerificationCompletedWebhookPayload,
+    type KrakenEmbedVerificationFailedWebhookPayload as KrakenEmbedVerificationFailedWebhookPayload,
+    type KrakenEmbedQuoteExecutedWebhookPayload as KrakenEmbedQuoteExecutedWebhookPayload,
+    type KrakenEmbedQuoteExecutionFailedWebhookPayload as KrakenEmbedQuoteExecutionFailedWebhookPayload,
+    type KrakenEmbedQuoteCancelledWebhookPayload as KrakenEmbedQuoteCancelledWebhookPayload,
+    type KrakenEmbedUserVerifiedWebhookPayload as KrakenEmbedUserVerifiedWebhookPayload,
+    type KrakenEmbedUserDisabledWebhookPayload as KrakenEmbedUserDisabledWebhookPayload,
+    type KrakenEmbedUserClosedWebhookPayload as KrakenEmbedUserClosedWebhookPayload,
+  };
+
+  export {
+    Yield as Yield,
+    type EthereumYieldProvider as EthereumYieldProvider,
+    type EthereumYieldSweepType as EthereumYieldSweepType,
+    type EthereumYieldSweepStatus as EthereumYieldSweepStatus,
+    type EthereumYieldDepositInput as EthereumYieldDepositInput,
+    type EthereumYieldWithdrawInput as EthereumYieldWithdrawInput,
+    type EthereumYieldSweepResponse as EthereumYieldSweepResponse,
+    type EthereumVaultDetailsInput as EthereumVaultDetailsInput,
+    type EthereumYieldSweepIDInput as EthereumYieldSweepIDInput,
+    type EthereumVaultResponse as EthereumVaultResponse,
+    type EthereumVaultDetailsResponse as EthereumVaultDetailsResponse,
+    type EthereumYieldPositionsInput as EthereumYieldPositionsInput,
+    type EthereumVaultPosition as EthereumVaultPosition,
+    type EthereumYieldPositionResponse as EthereumYieldPositionResponse,
   };
 }

package/src/internal/parse.ts

@@ -29,6 +29,12 @@ export async function defaultParseResponse<T>(client: Privy, props: APIResponseP
     const mediaType = contentType?.split(';')[0]?.trim();
     const isJSON = mediaType?.includes('application/json') || mediaType?.endsWith('+json');
     if (isJSON) {
+      const contentLength = response.headers.get('content-length');
+      if (contentLength === '0') {
+        // if there is no content we can't do anything
+        return undefined as T;
+      }
+
       const json = await response.json();
       return json as T;
     }