@privy-io/api-types 0.6.1 → 0.7.0

package/src/resources/key-quorums.ts

@@ -6,13 +6,23 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Operations related to key quorums
+ */
 export class KeyQuorums extends APIResource {
   /**
    * Create a new key quorum.
    *
    * @example
    * ```ts
-   * const keyQuorum = await client.keyQuorums.create();
+   * const keyQuorum = await client.keyQuorums.create({
+   *   authorization_threshold: 1,
+   *   display_name: 'Prod key quorum',
+   *   public_keys: [
+   *     'MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEx4aoeD72yykviK+f/ckqE2CItVIG\n1rCnvC3/XZ1HgpOcMEMialRmTrqIK4oZlYd1RfxU3za/C9yjhboIuoPD3g==',
+   *     'MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAErzZtQr/bMIh3Y8f9ZqseB9i/AfjQ\nhu+agbNqXcJy/TfoNqvc/Y3Mh7gIZ8ZLXQEykycx4mYSpqrxp1lBKqsZDQ==',
+   *   ],
+   * });
    * ```
    */
   create(body: KeyQuorumCreateParams, options?: RequestOptions): APIPromise<KeyQuorum> {
@@ -55,6 +65,13 @@ export class KeyQuorums extends APIResource {
    * ```ts
    * const keyQuorum = await client.keyQuorums._update(
    *   'key_quorum_id',
+   *   {
+   *     authorization_threshold: 1,
+   *     display_name: 'Prod key quorum',
+   *     public_keys: [
+   *       'MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEx4aoeD72yykviK+f/ckqE2CItVIG\n1rCnvC3/XZ1HgpOcMEMialRmTrqIK4oZlYd1RfxU3za/C9yjhboIuoPD3g==',
+   *     ],
+   *   },
    * );
    * ```
    */
@@ -93,6 +110,37 @@ export class KeyQuorums extends APIResource {
   }
 }
 
+/**
+ * Request input for creating or updating a key quorum.
+ */
+export interface KeyQuorumCreateParams {
+  /**
+   * The number of keys that must sign for an action to be valid. Must be less than
+   * or equal to total number of key quorum members.
+   */
+  authorization_threshold?: number;
+
+  display_name?: string;
+
+  /**
+   * List of key quorum IDs that should be members of this key quorum. Key quorums
+   * can only be nested 1 level deep.
+   */
+  key_quorum_ids?: Array<string>;
+
+  /**
+   * List of P-256 public keys of the keys that should be authorized to sign on the
+   * key quorum, in base64-encoded DER format.
+   */
+  public_keys?: Array<string>;
+
+  /**
+   * List of user IDs of the users that should be authorized to sign on the key
+   * quorum.
+   */
+  user_ids?: Array<string>;
+}
+
 /**
  * A key quorum for authorizing wallet operations.
  */
@@ -203,9 +251,9 @@ export interface KeyQuorumUpdateParams {
 
 export declare namespace KeyQuorums {
   export {
+    type KeyQuorumCreateParams as KeyQuorumCreateParams,
     type KeyQuorum as KeyQuorum,
     type KeyQuorumDeleteResponse as KeyQuorumDeleteResponse,
-    type KeyQuorumCreateParams as KeyQuorumCreateParams,
     type KeyQuorumDeleteParams as KeyQuorumDeleteParams,
     type KeyQuorumUpdateParams as KeyQuorumUpdateParams,
   };

package/src/resources/kraken-embed.ts

@@ -0,0 +1,85 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as KrakenEmbedAPI from './kraken-embed';
+
+export class KrakenEmbed extends APIResource {}
+
+/**
+ * Query parameters for getting a portfolio summary.
+ */
+export interface KrakenEmbedGetPortfolioSummaryQueryParams {
+  'include[current_day_pnl]'?: 'true' | 'false';
+
+  quote?: string;
+}
+
+/**
+ * Current day profit and loss for a portfolio, calculated from the most recent
+ * available balance.
+ */
+export interface KrakenEmbedCurrentDayPnl {
+  pnl: string;
+
+  since: string;
+}
+
+/**
+ * High-level summary of a user's portfolio including total value, available
+ * balance, and unrealized P&L.
+ */
+export interface KrakenEmbedGetPortfolioSummaryResponse {
+  data: KrakenEmbedGetPortfolioSummaryResponse.Data;
+}
+
+export namespace KrakenEmbedGetPortfolioSummaryResponse {
+  export interface Data {
+    result: Data.Result | null;
+
+    error?: Array<unknown>;
+
+    errors?: Array<unknown>;
+  }
+
+  export namespace Data {
+    export interface Result {
+      available_balance: string;
+
+      currency: string;
+
+      open_orders: string;
+
+      portfolio_value: string;
+
+      timestamp: string;
+
+      withheld_value: string;
+
+      cost_basis?: string | null;
+
+      /**
+       * Current day profit and loss for a portfolio, calculated from the most recent
+       * available balance.
+       */
+      current_day_pnl?: Result.CurrentDayPnl;
+
+      lots_upnl?: string | null;
+    }
+
+    export namespace Result {
+      /**
+       * Current day profit and loss for a portfolio, calculated from the most recent
+       * available balance.
+       */
+      export interface CurrentDayPnl extends KrakenEmbedAPI.KrakenEmbedCurrentDayPnl {}
+    }
+  }
+}
+
+export declare namespace KrakenEmbed {
+  export {
+    type KrakenEmbedGetPortfolioSummaryQueryParams as KrakenEmbedGetPortfolioSummaryQueryParams,
+    type KrakenEmbedCurrentDayPnl as KrakenEmbedCurrentDayPnl,
+    type KrakenEmbedGetPortfolioSummaryResponse as KrakenEmbedGetPortfolioSummaryResponse,
+  };
+}

package/src/resources/policies.ts

@@ -8,6 +8,9 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Operations related to policies
+ */
 export class Policies extends APIResource {
   /**
    * Create a new policy.
@@ -776,6 +779,10 @@ export interface PolicyDeleteRuleResponse {
   success: boolean;
 }
 
+/**
+ * A rule that defines the conditions and action to take if the conditions are
+ * true.
+ */
 export interface PolicyUpdateRuleResponse {
   id: string;
 

package/src/resources/transactions.ts

@@ -5,6 +5,9 @@ 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.

package/src/resources/users.ts

@@ -10,6 +10,9 @@ 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

package/src/resources/wallets/balance.ts

@@ -5,6 +5,9 @@ import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Operations related to wallets
+ */
 export class Balance extends APIResource {
   /**
    * Get the balance of a wallet by wallet ID.
@@ -31,12 +34,13 @@ export interface BalanceGetResponse {
 
 export namespace BalanceGetResponse {
   export interface Balance {
-    asset: 'usdc' | 'eth' | 'pol' | 'usdt' | 'eurc' | 'usdb' | 'sol' | (string & {});
+    asset: 'usdc' | 'usdc.e' | 'eth' | 'pol' | 'usdt' | 'eurc' | 'usdb' | 'sol' | (string & {});
 
     chain:
       | 'ethereum'
       | 'arbitrum'
       | 'base'
+      | 'tempo'
       | 'linea'
       | 'optimism'
       | 'polygon'
@@ -69,18 +73,20 @@ export interface BalanceGetParams {
 
   asset?:
     | 'usdc'
+    | 'usdc.e'
     | 'eth'
     | 'pol'
     | 'usdt'
     | 'eurc'
     | 'usdb'
     | 'sol'
-    | Array<'usdc' | 'eth' | 'pol' | 'usdt' | 'eurc' | 'usdb' | 'sol'>;
+    | Array<'usdc' | 'usdc.e' | 'eth' | 'pol' | 'usdt' | 'eurc' | 'usdb' | 'sol'>;
 
   chain?:
     | 'ethereum'
     | 'arbitrum'
     | 'base'
+    | 'tempo'
     | 'linea'
     | 'optimism'
     | 'polygon'
@@ -98,6 +104,7 @@ export interface BalanceGetParams {
         | 'ethereum'
         | 'arbitrum'
         | 'base'
+        | 'tempo'
         | 'linea'
         | 'optimism'
         | 'polygon'

package/src/resources/wallets/index.ts

@@ -17,6 +17,7 @@ export {
   type HpkeImportConfig,
   type SuiCommandName,
   type Wallet,
+  type WalletUpdateRequestBody,
   type WalletBatchItemInput,
   type WalletBatchCreateInput,
   type WalletBatchCreateResult,
@@ -41,10 +42,11 @@ export {
   type SolanaSignTransactionRpcResponse,
   type SolanaSignAndSendTransactionRpcResponse,
   type SolanaSignMessageRpcResponse,
+  type WalletRpcRequestBody,
+  type WalletRpcResponse,
   type WalletExportResponse,
   type WalletInitImportResponse,
   type WalletRawSignResponse,
-  type WalletRpcResponse,
   type WalletAuthenticateWithJwtResponse,
   type WalletCreateWalletsWithRecoveryResponse,
   type WalletCreateParams,

package/src/resources/wallets/transactions.ts

@@ -5,6 +5,9 @@ import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Operations related to wallets
+ */
 export class Transactions extends APIResource {
   /**
    * Get incoming and outgoing transactions of a wallet by wallet ID.
@@ -61,12 +64,13 @@ export namespace TransactionGetResponse {
 
   export namespace Transaction {
     export interface UnionMember0 {
-      asset: 'usdc' | 'eth' | 'pol' | 'usdt' | 'eurc' | 'usdb' | 'sol' | (string & {});
+      asset: 'usdc' | 'usdc.e' | 'eth' | 'pol' | 'usdt' | 'eurc' | 'usdb' | 'sol' | (string & {});
 
       chain:
         | 'ethereum'
         | 'arbitrum'
         | 'base'
+        | 'tempo'
         | 'linea'
         | 'optimism'
         | 'polygon'
@@ -99,12 +103,13 @@ export namespace TransactionGetResponse {
     }
 
     export interface UnionMember1 {
-      asset: 'usdc' | 'eth' | 'pol' | 'usdt' | 'eurc' | 'usdb' | 'sol' | (string & {});
+      asset: 'usdc' | 'usdc.e' | 'eth' | 'pol' | 'usdt' | 'eurc' | 'usdb' | 'sol' | (string & {});
 
       chain:
         | 'ethereum'
         | 'arbitrum'
         | 'base'
+        | 'tempo'
         | 'linea'
         | 'optimism'
         | 'polygon'
@@ -141,15 +146,16 @@ export namespace TransactionGetResponse {
 export interface TransactionGetParams {
   asset:
     | 'usdc'
+    | 'usdc.e'
     | 'eth'
     | 'pol'
     | 'usdt'
     | 'eurc'
     | 'usdb'
     | 'sol'
-    | Array<'usdc' | 'eth' | 'pol' | 'usdt' | 'eurc' | 'usdb' | 'sol'>;
+    | Array<'usdc' | 'usdc.e' | 'eth' | 'pol' | 'usdt' | 'eurc' | 'usdb' | 'sol'>;
 
-  chain: 'ethereum' | 'arbitrum' | 'base' | 'linea' | 'optimism' | 'polygon' | 'solana' | 'sepolia';
+  chain: 'ethereum' | 'arbitrum' | 'base' | 'tempo' | 'linea' | 'optimism' | 'polygon' | 'solana' | 'sepolia';
 
   cursor?: string;
 

package/src/resources/wallets/wallets.ts

@@ -151,10 +151,14 @@ export class Wallets extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.wallets._rpc('wallet_id', {
-   *   method: 'personal_sign',
-   *   params: { encoding: 'utf-8', message: 'message' },
-   * });
+   * const walletRpcResponse = await client.wallets._rpc(
+   *   'wallet_id',
+   *   {
+   *     method: 'eth_sendTransaction',
+   *     params: {},
+   *     chain_type: 'ethereum',
+   *   },
+   * );
    * ```
    */
   _rpc(walletID: string, params: WalletRpcParams, options?: RequestOptions): APIPromise<WalletRpcResponse> {
@@ -206,7 +210,9 @@ export class Wallets extends APIResource {
    *
    * @example
    * ```ts
-   * const wallet = await client.wallets._update('wallet_id');
+   * const wallet = await client.wallets._update('wallet_id', {
+   *   policy_ids: ['tb54eps4z44ed0jepousxi4n'],
+   * });
    * ```
    */
   _update(walletID: string, params: WalletUpdateParams, options?: RequestOptions): APIPromise<Wallet> {
@@ -533,6 +539,61 @@ export namespace Wallet {
   }
 }
 
+/**
+ * Request body for updating a wallet.
+ */
+export interface WalletUpdateRequestBody {
+  /**
+   * Additional signers for the wallet.
+   */
+  additional_signers?: Array<WalletUpdateRequestBody.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?: WalletUpdateRequestBody.PublicKeyOwner | WalletUpdateRequestBody.UserOwner | null;
+
+  owner_id?: string | null;
+
+  /**
+   * New policy IDs to enforce on the wallet. Currently, only one policy is supported
+   * per wallet.
+   */
+  policy_ids?: Array<string>;
+}
+
+export namespace WalletUpdateRequestBody {
+  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;
+  }
+}
+
 /**
  * Input for a single wallet in a batch creation request.
  */
@@ -1254,6 +1315,36 @@ export namespace SolanaSignMessageRpcResponse {
   }
 }
 
+/**
+ * Request body for wallet RPC operations, discriminated by method.
+ */
+export type WalletRpcRequestBody =
+  | EthereumPersonalSignRpcInput
+  | EthereumSignTypedDataRpcInput
+  | EthereumSignTransactionRpcInput
+  | EthereumSignUserOperationRpcInput
+  | EthereumSendTransactionRpcInput
+  | EthereumSign7702AuthorizationRpcInput
+  | EthereumSecp256k1SignRpcInput
+  | SolanaSignMessageRpcInput
+  | SolanaSignTransactionRpcInput
+  | SolanaSignAndSendTransactionRpcInput;
+
+/**
+ * Response body for wallet RPC operations, discriminated by method.
+ */
+export type WalletRpcResponse =
+  | EthereumPersonalSignRpcResponse
+  | EthereumSignTypedDataRpcResponse
+  | EthereumSignTransactionRpcResponse
+  | EthereumSendTransactionRpcResponse
+  | EthereumSignUserOperationRpcResponse
+  | EthereumSign7702AuthorizationRpcResponse
+  | EthereumSecp256k1SignRpcResponse
+  | SolanaSignMessageRpcResponse
+  | SolanaSignTransactionRpcResponse
+  | SolanaSignAndSendTransactionRpcResponse;
+
 export interface WalletExportResponse {
   /**
    * The encrypted private key.
@@ -1298,21 +1389,6 @@ export namespace WalletRawSignResponse {
   }
 }
 
-/**
- * Response to the EVM `personal_sign` RPC.
- */
-export type WalletRpcResponse =
-  | EthereumPersonalSignRpcResponse
-  | EthereumSignTypedDataRpcResponse
-  | EthereumSignTransactionRpcResponse
-  | EthereumSendTransactionRpcResponse
-  | EthereumSignUserOperationRpcResponse
-  | EthereumSign7702AuthorizationRpcResponse
-  | EthereumSecp256k1SignRpcResponse
-  | SolanaSignMessageRpcResponse
-  | SolanaSignTransactionRpcResponse
-  | SolanaSignAndSendTransactionRpcResponse;
-
 export type WalletAuthenticateWithJwtResponse =
   | WalletAuthenticateWithJwtResponse.WithEncryption
   | WalletAuthenticateWithJwtResponse.WithoutEncryption;
@@ -2444,6 +2520,7 @@ export declare namespace Wallets {
     type HpkeImportConfig as HpkeImportConfig,
     type SuiCommandName as SuiCommandName,
     type Wallet as Wallet,
+    type WalletUpdateRequestBody as WalletUpdateRequestBody,
     type WalletBatchItemInput as WalletBatchItemInput,
     type WalletBatchCreateInput as WalletBatchCreateInput,
     type WalletBatchCreateResult as WalletBatchCreateResult,
@@ -2468,10 +2545,11 @@ export declare namespace Wallets {
     type SolanaSignTransactionRpcResponse as SolanaSignTransactionRpcResponse,
     type SolanaSignAndSendTransactionRpcResponse as SolanaSignAndSendTransactionRpcResponse,
     type SolanaSignMessageRpcResponse as SolanaSignMessageRpcResponse,
+    type WalletRpcRequestBody as WalletRpcRequestBody,
+    type WalletRpcResponse as WalletRpcResponse,
     type WalletExportResponse as WalletExportResponse,
     type WalletInitImportResponse as WalletInitImportResponse,
     type WalletRawSignResponse as WalletRawSignResponse,
-    type WalletRpcResponse as WalletRpcResponse,
     type WalletAuthenticateWithJwtResponse as WalletAuthenticateWithJwtResponse,
     type WalletCreateWalletsWithRecoveryResponse as WalletCreateWalletsWithRecoveryResponse,
     type WalletsCursor as WalletsCursor,