@privy-io/api-types 0.14.0 → 0.16.0

package/src/resources/client-auth.ts

@@ -2,7 +2,6 @@
 
 import { APIResource } from '../core/resource';
 import * as EmbeddedWalletsAPI from './embedded-wallets';
-import * as FiatAPI from './fiat';
 import * as UsersAPI from './users';
 
 export class ClientAuth extends APIResource {}
@@ -64,7 +63,10 @@ export interface AuthenticateSiwsInput {
 
   connectorType?: string | null;
 
-  message_type?: 'transaction' | 'plain';
+  /**
+   * The type of SIWS message being signed.
+   */
+  message_type?: SiwsMessageType;
 
   /**
    * Whether to allow sign-up during authentication.
@@ -91,6 +93,9 @@ export interface BridgeBrlFiatVirtualAccountDepositInstructions {
   payment_rails: Array<'pix'>;
 }
 
+/**
+ * Supported destination stablecoin assets for fiat-to-crypto transfers.
+ */
 export type BridgeDestinationAsset = 'usdb' | 'usdc' | 'usdt' | 'dai' | 'pyusd' | 'eurc';
 
 /**
@@ -112,31 +117,6 @@ export interface BridgeEurFiatVirtualAccountDepositInstructions {
   payment_rails: Array<'sepa'>;
 }
 
-/**
- * The response for getting a native onramp provider customer.
- */
-export interface BridgeFiatCustomerResponse {
-  has_accepted_terms: boolean;
-
-  provider: 'bridge';
-
-  /**
-   * Status of the KYC verification process.
-   */
-  status: FiatAPI.OnrampKYCStatus;
-
-  kyc_url?: string;
-
-  rejection_reasons?: Array<BridgeFiatRejectionReason>;
-}
-
-/**
- * A rejection reason for a customer KYC verification.
- */
-export interface BridgeFiatRejectionReason {
-  reason: string;
-}
-
 /**
  * The deposit instructions for a virtual account.
  */
@@ -147,9 +127,15 @@ export type BridgeFiatVirtualAccountDepositInstructions =
   | BridgeBrlFiatVirtualAccountDepositInstructions
   | BridgeGbpFiatVirtualAccountDepositInstructions;
 
+/**
+ * The destination chain, asset, and address for a virtual account transfer.
+ */
 export interface BridgeFiatVirtualAccountDestination {
   address: string;
 
+  /**
+   * Supported destination stablecoin assets for fiat-to-crypto transfers.
+   */
   asset: BridgeDestinationAsset;
 
   chain: string;
@@ -159,10 +145,16 @@ export interface BridgeFiatVirtualAccountDestination {
  * The request input for creating virtual account.
  */
 export interface BridgeFiatVirtualAccountRequest {
+  /**
+   * The destination chain, asset, and address for a virtual account transfer.
+   */
   destination: BridgeFiatVirtualAccountDestination;
 
   provider: 'bridge';
 
+  /**
+   * The source fiat currency configuration for a virtual account.
+   */
   source: BridgeFiatVirtualAccountSource;
 }
 
@@ -175,6 +167,9 @@ export interface BridgeFiatVirtualAccountResponse {
    */
   deposit_instructions: BridgeFiatVirtualAccountDepositInstructions;
 
+  /**
+   * The destination chain, asset, and address for a virtual account transfer.
+   */
   destination: BridgeFiatVirtualAccountDestination;
 
   provider: 'bridge';
@@ -182,7 +177,13 @@ export interface BridgeFiatVirtualAccountResponse {
   status: string;
 }
 
+/**
+ * The source fiat currency configuration for a virtual account.
+ */
 export interface BridgeFiatVirtualAccountSource {
+  /**
+   * Supported source fiat currencies for virtual account deposits.
+   */
   asset: BridgeSourceAsset;
 }
 
@@ -227,32 +228,20 @@ export interface BridgeMxnFiatVirtualAccountDepositInstructions {
  */
 export type BridgeOnrampProvider = 'bridge' | 'bridge-sandbox';
 
-/**
- * The response for getting a native onramp provider customer.
- */
-export interface BridgeSandboxFiatCustomerResponse {
-  has_accepted_terms: boolean;
-
-  provider: 'bridge-sandbox';
-
-  /**
-   * Status of the KYC verification process.
-   */
-  status: FiatAPI.OnrampKYCStatus;
-
-  kyc_url?: string;
-
-  rejection_reasons?: Array<BridgeFiatRejectionReason>;
-}
-
 /**
  * The request input for creating virtual account.
  */
 export interface BridgeSandboxFiatVirtualAccountRequest {
+  /**
+   * The destination chain, asset, and address for a virtual account transfer.
+   */
   destination: BridgeFiatVirtualAccountDestination;
 
   provider: 'bridge-sandbox';
 
+  /**
+   * The source fiat currency configuration for a virtual account.
+   */
   source: BridgeFiatVirtualAccountSource;
 }
 
@@ -265,6 +254,9 @@ export interface BridgeSandboxFiatVirtualAccountResponse {
    */
   deposit_instructions: BridgeFiatVirtualAccountDepositInstructions;
 
+  /**
+   * The destination chain, asset, and address for a virtual account transfer.
+   */
   destination: BridgeFiatVirtualAccountDestination;
 
   provider: 'bridge-sandbox';
@@ -272,6 +264,9 @@ export interface BridgeSandboxFiatVirtualAccountResponse {
   status: string;
 }
 
+/**
+ * Supported source fiat currencies for virtual account deposits.
+ */
 export type BridgeSourceAsset = 'usd' | 'eur' | 'mxn' | 'brl' | 'gbp';
 
 /**
@@ -295,31 +290,6 @@ export interface BridgeUsdFiatVirtualAccountDepositInstructions {
   payment_rails: Array<'ach_push' | 'wire'>;
 }
 
-/**
- * A CAIP-2 chain identifier in namespace:reference format (e.g. "eip155:1" for
- * Ethereum mainnet, "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp" for Solana mainnet).
- */
-export type Caip2ChainID = string;
-
-/**
- * The request input for creating (or updating) a native onramp provider customer.
- */
-export interface CreateOrUpdateFiatCustomerRequestInput {
-  has_accepted_terms: boolean;
-
-  /**
-   * Valid set of onramp providers
-   */
-  provider: OnrampProvider;
-
-  kyc_redirect_url?: string;
-}
-
-/**
- * Cryptocurrency symbol. Uppercase alphanumeric, 2-10 characters.
- */
-export type CryptoCurrencyCode = string;
-
 /**
  * The request body for authenticating with a custom JWT.
  */
@@ -345,6 +315,37 @@ export interface CustomJwtLinkRequestBody {
  */
 export type CustomOAuthProviderID = `custom:${string}`;
 
+/**
+ * The action to take on the device authorization request.
+ */
+export type DeviceVerifyAction = 'approve' | 'deny';
+
+/**
+ * Request body for approving or denying a device authorization request. The user
+ * must be authenticated and belong to the target app.
+ */
+export interface DeviceVerifyRequestBody {
+  /**
+   * The action to take on the device authorization request.
+   */
+  action: DeviceVerifyAction;
+
+  /**
+   * The user code displayed on the CLI device.
+   */
+  user_code: string;
+}
+
+/**
+ * Response indicating the device authorization action was processed.
+ */
+export interface DeviceVerifyResponse {
+  /**
+   * Whether the action was processed successfully.
+   */
+  success: boolean;
+}
+
 /**
  * The ID of an external OAuth provider.
  */
@@ -669,114 +670,6 @@ export interface FarcasterV2InitResponseBody {
   nonce: string;
 }
 
-/**
- * A positive decimal amount as a string (e.g. "100", "50.25", "0.001").
- */
-export type FiatAmount = string;
-
-/**
- * ISO 4217 fiat currency code. Three uppercase ASCII letters.
- */
-export type FiatCurrencyCode = string;
-
-/**
- * The response for getting a native onramp provider customer.
- */
-export type FiatCustomerResponse = BridgeFiatCustomerResponse | BridgeSandboxFiatCustomerResponse;
-
-/**
- * Destination cryptocurrency details for a fiat onramp quote request.
- */
-export interface FiatOnrampDestination {
-  address: string;
-
-  /**
-   * Cryptocurrency symbol. Uppercase alphanumeric, 2-10 characters.
-   */
-  asset: CryptoCurrencyCode;
-
-  /**
-   * A CAIP-2 chain identifier in namespace:reference format (e.g. "eip155:1" for
-   * Ethereum mainnet, "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp" for Solana mainnet).
-   */
-  chain: Caip2ChainID;
-}
-
-/**
- * Whether to use the sandbox or production environment for fiat onramp.
- */
-export type FiatOnrampEnvironment = 'sandbox' | 'production';
-
-/**
- * The fiat onramp provider to use.
- */
-export type FiatOnrampProvider =
-  | 'meld'
-  | 'meld-sandbox'
-  | 'moonpay'
-  | 'moonpay-sandbox'
-  | 'coinbase'
-  | 'coinbase-sandbox';
-
-/**
- * An error from a specific fiat onramp provider when fetching quotes.
- */
-export interface FiatOnrampProviderError {
-  error: string;
-
-  /**
-   * The fiat onramp provider to use.
-   */
-  provider: FiatOnrampProvider;
-}
-
-/**
- * A single fiat onramp quote from a provider.
- */
-export interface FiatOnrampQuote {
-  payment_method: string;
-
-  /**
-   * The fiat onramp provider to use.
-   */
-  provider: FiatOnrampProvider;
-
-  destination_currency_code?: string | null;
-
-  source_amount?: number | null;
-
-  source_currency_code?: string | null;
-
-  sub_provider?: string | null;
-}
-
-/**
- * Source currency details for a fiat onramp quote request.
- */
-export interface FiatOnrampSource {
-  /**
-   * A positive decimal amount as a string (e.g. "100", "50.25", "0.001").
-   */
-  amount: FiatAmount;
-
-  /**
-   * ISO 4217 fiat currency code. Three uppercase ASCII letters.
-   */
-  asset: FiatCurrencyCode;
-}
-
-/**
- * Normalized fiat onramp transaction status.
- */
-export type FiatOnrampTransactionStatus =
-  | 'pending'
-  | 'processing'
-  | 'completed'
-  | 'failed'
-  | 'cancelled'
-  | 'refunded'
-  | 'unknown';
-
 /**
  * The request input for creating virtual account.
  */
@@ -791,110 +684,6 @@ export type FiatVirtualAccountResponse =
   | BridgeFiatVirtualAccountResponse
   | BridgeSandboxFiatVirtualAccountResponse;
 
-/**
- * The request input for getting a native onramp provider customer.
- */
-export interface GetFiatCustomerRequestInput {
-  /**
-   * Valid set of onramp providers
-   */
-  provider: OnrampProvider;
-
-  kyc_redirect_url?: string;
-}
-
-/**
- * The request input for getting fiat onramp quotes.
- */
-export interface GetFiatOnrampQuotesInput {
-  /**
-   * Destination cryptocurrency details for a fiat onramp quote request.
-   */
-  destination: FiatOnrampDestination;
-
-  /**
-   * Whether to use the sandbox or production environment for fiat onramp.
-   */
-  environment: FiatOnrampEnvironment;
-
-  /**
-   * Source currency details for a fiat onramp quote request.
-   */
-  source: FiatOnrampSource;
-}
-
-/**
- * The response containing fiat onramp quotes.
- */
-export interface GetFiatOnrampQuotesResponse {
-  quotes: Array<FiatOnrampQuote>;
-
-  provider_errors?: Array<FiatOnrampProviderError>;
-}
-
-/**
- * The request input for checking a fiat onramp session status.
- */
-export interface GetFiatOnrampTransactionStatusInput {
-  /**
-   * The fiat onramp provider to use.
-   */
-  provider: FiatOnrampProvider;
-
-  session_id: string;
-}
-
-/**
- * The response containing the fiat onramp session status.
- */
-export interface GetFiatOnrampTransactionStatusResponse {
-  raw_status: string;
-
-  session_id: string;
-
-  /**
-   * Normalized fiat onramp transaction status.
-   */
-  status: FiatOnrampTransactionStatus;
-
-  transaction_id?: string;
-}
-
-/**
- * The request input for getting a fiat onramp provider session URL.
- */
-export interface GetFiatOnrampURLInput {
-  /**
-   * Destination cryptocurrency details for a fiat onramp quote request.
-   */
-  destination: FiatOnrampDestination;
-
-  payment_method: string;
-
-  /**
-   * The fiat onramp provider to use.
-   */
-  provider: FiatOnrampProvider;
-
-  /**
-   * Source currency details for a fiat onramp quote request.
-   */
-  source: FiatOnrampSource;
-
-  redirect_url?: string;
-
-  sub_provider?: string;
-}
-
-/**
- * The response containing a fiat onramp provider session URL.
- */
-export interface GetFiatOnrampURLResponse {
-  session_id: string;
-
-  url: string;
-}
-
 /**
  * The request body for authenticating a guest.
  */
@@ -1104,6 +893,122 @@ export interface OAuthLinkResponseBody extends UsersAPI.User {
  */
 export type OAuthProviderID = ExternalOAuthProviderID | PrivyOAuthProviderID | CustomOAuthProviderID;
 
+/**
+ * Request body for the authorization_code grant type.
+ */
+export interface OAuthTokenAuthorizationCodeRequestBody {
+  /**
+   * The authorization code received from the authorization endpoint.
+   */
+  code: string;
+
+  grant_type: 'authorization_code';
+
+  /**
+   * The client ID. Alternative to Basic auth header.
+   */
+  client_id?: string;
+
+  /**
+   * The client secret. Alternative to Basic auth header.
+   */
+  client_secret?: string;
+
+  /**
+   * The redirect URI used in the authorization request.
+   */
+  redirect_uri?: string;
+}
+
+/**
+ * Error response returned while the device authorization is still pending (RFC
+ * 8628 Section 3.5).
+ */
+export interface OAuthTokenDeviceCodePendingError {
+  /**
+   * The error code indicating why the token request failed.
+   */
+  error: 'authorization_pending' | 'slow_down' | 'access_denied' | 'expired_token';
+
+  /**
+   * Human-readable description of the error.
+   */
+  error_description?: string;
+
+  /**
+   * The minimum polling interval in seconds.
+   */
+  interval?: number;
+}
+
+/**
+ * Request body for the urn:ietf:params:oauth:grant-type:device_code grant type
+ * (RFC 8628). Used by CLI clients to poll for authorization.
+ */
+export interface OAuthTokenDeviceCodeRequestBody {
+  /**
+   * The device code received from the device authorization endpoint.
+   */
+  device_code: string;
+
+  grant_type: 'urn:ietf:params:oauth:grant-type:device_code';
+}
+
+/**
+ * The OAuth grant type for the token request.
+ */
+export type OAuthTokenGrantType =
+  | 'authorization_code'
+  | 'urn:ietf:params:oauth:grant-type:device_code'
+  | 'refresh_token';
+
+/**
+ * Request body for the refresh_token grant type. Rotates the refresh token and
+ * issues a new access token.
+ */
+export interface OAuthTokenRefreshTokenRequestBody {
+  grant_type: 'refresh_token';
+
+  /**
+   * The refresh token to exchange for a new access token.
+   */
+  refresh_token: string;
+}
+
+/**
+ * Request body for the OAuth token endpoint, discriminated by grant_type.
+ */
+export type OAuthTokenRequestBody =
+  | OAuthTokenAuthorizationCodeRequestBody
+  | OAuthTokenDeviceCodeRequestBody
+  | OAuthTokenRefreshTokenRequestBody;
+
+/**
+ * Successful token response per RFC 6749 Section 5.1.
+ */
+export interface OAuthTokenSuccessResponse {
+  /**
+   * The issued access token.
+   */
+  access_token: string;
+
+  /**
+   * The type of token issued.
+   */
+  token_type: 'Bearer';
+
+  /**
+   * The lifetime in seconds of the access token.
+   */
+  expires_in?: number;
+
+  /**
+   * A refresh token for obtaining new access tokens. Issued for device_code and
+   * refresh_token grants.
+   */
+  refresh_token?: string;
+}
+
 /**
  * The request body for transferring an OAuth account.
  */
@@ -1768,7 +1673,10 @@ export interface SiwsAuthenticateRequestBody {
 
   connectorType?: string | null;
 
-  message_type?: 'transaction' | 'plain';
+  /**
+   * The type of SIWS message being signed.
+   */
+  message_type?: SiwsMessageType;
 
   /**
    * Whether to allow sign-up during authentication.
@@ -1815,7 +1723,10 @@ export interface SiwsInput {
 
   connectorType?: string | null;
 
-  message_type?: 'transaction' | 'plain';
+  /**
+   * The type of SIWS message being signed.
+   */
+  message_type?: SiwsMessageType;
 
   walletClientType?: string | null;
 }
@@ -1830,11 +1741,19 @@ export interface SiwsLinkRequestBody {
 
   connectorType?: string | null;
 
-  message_type?: 'transaction' | 'plain';
+  /**
+   * The type of SIWS message being signed.
+   */
+  message_type?: SiwsMessageType;
 
   walletClientType?: string | null;
 }
 
+/**
+ * The type of SIWS message being signed.
+ */
+export type SiwsMessageType = 'transaction' | 'plain' | 'offchain-message';
+
 /**
  * A SIWS nonce response.
  */
@@ -2074,8 +1993,6 @@ export declare namespace ClientAuth {
     type BridgeBrlFiatVirtualAccountDepositInstructions as BridgeBrlFiatVirtualAccountDepositInstructions,
     type BridgeDestinationAsset as BridgeDestinationAsset,
     type BridgeEurFiatVirtualAccountDepositInstructions as BridgeEurFiatVirtualAccountDepositInstructions,
-    type BridgeFiatCustomerResponse as BridgeFiatCustomerResponse,
-    type BridgeFiatRejectionReason as BridgeFiatRejectionReason,
     type BridgeFiatVirtualAccountDepositInstructions as BridgeFiatVirtualAccountDepositInstructions,
     type BridgeFiatVirtualAccountDestination as BridgeFiatVirtualAccountDestination,
     type BridgeFiatVirtualAccountRequest as BridgeFiatVirtualAccountRequest,
@@ -2084,17 +2001,16 @@ export declare namespace ClientAuth {
     type BridgeGbpFiatVirtualAccountDepositInstructions as BridgeGbpFiatVirtualAccountDepositInstructions,
     type BridgeMxnFiatVirtualAccountDepositInstructions as BridgeMxnFiatVirtualAccountDepositInstructions,
     type BridgeOnrampProvider as BridgeOnrampProvider,
-    type BridgeSandboxFiatCustomerResponse as BridgeSandboxFiatCustomerResponse,
     type BridgeSandboxFiatVirtualAccountRequest as BridgeSandboxFiatVirtualAccountRequest,
     type BridgeSandboxFiatVirtualAccountResponse as BridgeSandboxFiatVirtualAccountResponse,
     type BridgeSourceAsset as BridgeSourceAsset,
     type BridgeUsdFiatVirtualAccountDepositInstructions as BridgeUsdFiatVirtualAccountDepositInstructions,
-    type Caip2ChainID as Caip2ChainID,
-    type CreateOrUpdateFiatCustomerRequestInput as CreateOrUpdateFiatCustomerRequestInput,
-    type CryptoCurrencyCode as CryptoCurrencyCode,
     type CustomJwtAuthenticateRequestBody as CustomJwtAuthenticateRequestBody,
     type CustomJwtLinkRequestBody as CustomJwtLinkRequestBody,
     type CustomOAuthProviderID as CustomOAuthProviderID,
+    type DeviceVerifyAction as DeviceVerifyAction,
+    type DeviceVerifyRequestBody as DeviceVerifyRequestBody,
+    type DeviceVerifyResponse as DeviceVerifyResponse,
     type ExternalOAuthProviderID as ExternalOAuthProviderID,
     type FarcasterAuthenticateInput as FarcasterAuthenticateInput,
     type FarcasterAuthenticateRequestBody as FarcasterAuthenticateRequestBody,
@@ -2123,25 +2039,8 @@ export declare namespace ClientAuth {
     type FarcasterV2InitRequestBody as FarcasterV2InitRequestBody,
     type FarcasterV2InitResponse as FarcasterV2InitResponse,
     type FarcasterV2InitResponseBody as FarcasterV2InitResponseBody,
-    type FiatAmount as FiatAmount,
-    type FiatCurrencyCode as FiatCurrencyCode,
-    type FiatCustomerResponse as FiatCustomerResponse,
-    type FiatOnrampDestination as FiatOnrampDestination,
-    type FiatOnrampEnvironment as FiatOnrampEnvironment,
-    type FiatOnrampProvider as FiatOnrampProvider,
-    type FiatOnrampProviderError as FiatOnrampProviderError,
-    type FiatOnrampQuote as FiatOnrampQuote,
-    type FiatOnrampSource as FiatOnrampSource,
-    type FiatOnrampTransactionStatus as FiatOnrampTransactionStatus,
     type FiatVirtualAccountRequest as FiatVirtualAccountRequest,
     type FiatVirtualAccountResponse as FiatVirtualAccountResponse,
-    type GetFiatCustomerRequestInput as GetFiatCustomerRequestInput,
-    type GetFiatOnrampQuotesInput as GetFiatOnrampQuotesInput,
-    type GetFiatOnrampQuotesResponse as GetFiatOnrampQuotesResponse,
-    type GetFiatOnrampTransactionStatusInput as GetFiatOnrampTransactionStatusInput,
-    type GetFiatOnrampTransactionStatusResponse as GetFiatOnrampTransactionStatusResponse,
-    type GetFiatOnrampURLInput as GetFiatOnrampURLInput,
-    type GetFiatOnrampURLResponse as GetFiatOnrampURLResponse,
     type GuestAuthenticateRequestBody as GuestAuthenticateRequestBody,
     type LinkJwtInput as LinkJwtInput,
     type MfaPasskeyEnrollmentRequestBody as MfaPasskeyEnrollmentRequestBody,
@@ -2164,6 +2063,13 @@ export declare namespace ClientAuth {
     type OAuthLinkRequestBody as OAuthLinkRequestBody,
     type OAuthLinkResponseBody as OAuthLinkResponseBody,
     type OAuthProviderID as OAuthProviderID,
+    type OAuthTokenAuthorizationCodeRequestBody as OAuthTokenAuthorizationCodeRequestBody,
+    type OAuthTokenDeviceCodePendingError as OAuthTokenDeviceCodePendingError,
+    type OAuthTokenDeviceCodeRequestBody as OAuthTokenDeviceCodeRequestBody,
+    type OAuthTokenGrantType as OAuthTokenGrantType,
+    type OAuthTokenRefreshTokenRequestBody as OAuthTokenRefreshTokenRequestBody,
+    type OAuthTokenRequestBody as OAuthTokenRequestBody,
+    type OAuthTokenSuccessResponse as OAuthTokenSuccessResponse,
     type OAuthTransferRequestBody as OAuthTransferRequestBody,
     type OAuthTransferUserInfo as OAuthTransferUserInfo,
     type OAuthTransferUserInfoMeta as OAuthTransferUserInfoMeta,
@@ -2224,6 +2130,7 @@ export declare namespace ClientAuth {
     type SiwsInitResponseBody as SiwsInitResponseBody,
     type SiwsInput as SiwsInput,
     type SiwsLinkRequestBody as SiwsLinkRequestBody,
+    type SiwsMessageType as SiwsMessageType,
     type SiwsNonce as SiwsNonce,
     type SiwsUnlinkRequestBody as SiwsUnlinkRequestBody,
     type SmartWalletSiweInput as SmartWalletSiweInput,