@privy-io/api-types 0.5.0 → 0.6.0

package/src/resources/intents.ts

@@ -0,0 +1,138 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as IntentsAPI from './intents';
+
+export class Intents extends APIResource {}
+
+/**
+ * A leaf member (user or key) of a nested key quorum in an intent authorization.
+ */
+export type IntentAuthorizationKeyQuorumMember =
+  | IntentAuthorizationKeyQuorumMember.UserMember
+  | IntentAuthorizationKeyQuorumMember.KeyMember;
+
+export namespace IntentAuthorizationKeyQuorumMember {
+  export interface UserMember {
+    /**
+     * Whether this member has signed the intent
+     */
+    has_signed: boolean;
+
+    type: 'user';
+
+    /**
+     * User ID of the key quorum member
+     */
+    user_id: string;
+
+    /**
+     * Display name for the user (email, etc)
+     */
+    display_name?: string;
+  }
+
+  export interface KeyMember {
+    /**
+     * Whether this key has signed the intent
+     */
+    has_signed: boolean;
+
+    /**
+     * Public key of the key quorum member
+     */
+    public_key: string;
+
+    type: 'key';
+
+    /**
+     * Display name for the key (if any)
+     */
+    display_name?: string;
+  }
+}
+
+/**
+ * A member of an intent authorization quorum. Can be a user, key, or nested key
+ * quorum.
+ */
+export type IntentAuthorizationMember =
+  | IntentAuthorizationMember.UserMember
+  | IntentAuthorizationMember.KeyMember
+  | IntentAuthorizationMember.KeyQuorumMember;
+
+export namespace IntentAuthorizationMember {
+  export interface UserMember {
+    /**
+     * Whether this member has signed the intent
+     */
+    has_signed: boolean;
+
+    type: 'user';
+
+    /**
+     * User ID of the key quorum member
+     */
+    user_id: string;
+
+    /**
+     * Display name for the user (email, etc)
+     */
+    display_name?: string;
+  }
+
+  export interface KeyMember {
+    /**
+     * Whether this key has signed the intent
+     */
+    has_signed: boolean;
+
+    /**
+     * Public key of the key quorum member
+     */
+    public_key: string;
+
+    type: 'key';
+
+    /**
+     * Display name for the key (if any)
+     */
+    display_name?: string;
+  }
+
+  export interface KeyQuorumMember {
+    /**
+     * Whether this child key quorum has fulfilled its threshold
+     */
+    has_signed: boolean;
+
+    /**
+     * ID of the child key quorum member
+     */
+    key_quorum_id: string;
+
+    /**
+     * Members of this child quorum
+     */
+    members: Array<IntentsAPI.IntentAuthorizationKeyQuorumMember>;
+
+    /**
+     * Number of signatures required from this child quorum
+     */
+    threshold: number;
+
+    type: 'key_quorum';
+
+    /**
+     * Display name for the child key quorum (if any)
+     */
+    display_name?: string;
+  }
+}
+
+export declare namespace Intents {
+  export {
+    type IntentAuthorizationKeyQuorumMember as IntentAuthorizationKeyQuorumMember,
+    type IntentAuthorizationMember as IntentAuthorizationMember,
+  };
+}

package/src/resources/key-quorums.ts

@@ -105,6 +105,11 @@ export interface KeyQuorum {
 
   display_name?: string;
 
+  /**
+   * List of nested key quorum IDs that are members of this key quorum.
+   */
+  key_quorum_ids?: Array<string>;
+
   user_ids?: Array<string>;
 }
 
@@ -132,6 +137,12 @@ export interface KeyQuorumCreateParams {
 
   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.
@@ -165,6 +176,12 @@ export interface KeyQuorumUpdateParams {
    */
   display_name?: string;
 
+  /**
+   * Body param: 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>;
+
   /**
    * Body param: List of P-256 public keys of the keys that should be authorized to
    * sign on the key quorum, in base64-encoded DER format.

package/src/resources/policies.ts

@@ -492,7 +492,7 @@ export namespace Policy {
     }
 
     /**
-     * Allowed contract addresses for eth_signAuthorization requests.
+     * Allowed contract addresses for eth_sign7702Authorization requests.
      */
     export interface Ethereum7702AuthorizationCondition {
       field: 'contract';
@@ -689,7 +689,7 @@ export namespace PolicyCreateRuleResponse {
   }
 
   /**
-   * Allowed contract addresses for eth_signAuthorization requests.
+   * Allowed contract addresses for eth_sign7702Authorization requests.
    */
   export interface Ethereum7702AuthorizationCondition {
     field: 'contract';
@@ -895,7 +895,7 @@ export namespace PolicyUpdateRuleResponse {
   }
 
   /**
-   * Allowed contract addresses for eth_signAuthorization requests.
+   * Allowed contract addresses for eth_sign7702Authorization requests.
    */
   export interface Ethereum7702AuthorizationCondition {
     field: 'contract';
@@ -1091,7 +1091,7 @@ export namespace PolicyGetRuleResponse {
   }
 
   /**
-   * Allowed contract addresses for eth_signAuthorization requests.
+   * Allowed contract addresses for eth_sign7702Authorization requests.
    */
   export interface Ethereum7702AuthorizationCondition {
     field: 'contract';
@@ -1325,7 +1325,7 @@ export namespace PolicyCreateParams {
     }
 
     /**
-     * Allowed contract addresses for eth_signAuthorization requests.
+     * Allowed contract addresses for eth_sign7702Authorization requests.
      */
     export interface Ethereum7702AuthorizationCondition {
       field: 'contract';
@@ -1546,7 +1546,7 @@ export namespace PolicyCreateRuleParams {
   }
 
   /**
-   * Allowed contract addresses for eth_signAuthorization requests.
+   * Allowed contract addresses for eth_sign7702Authorization requests.
    */
   export interface Ethereum7702AuthorizationCondition {
     field: 'contract';
@@ -1809,7 +1809,7 @@ export namespace PolicyUpdateParams {
     }
 
     /**
-     * Allowed contract addresses for eth_signAuthorization requests.
+     * Allowed contract addresses for eth_sign7702Authorization requests.
      */
     export interface Ethereum7702AuthorizationCondition {
       field: 'contract';
@@ -2017,7 +2017,7 @@ export namespace PolicyUpdateRuleParams {
   }
 
   /**
-   * Allowed contract addresses for eth_signAuthorization requests.
+   * Allowed contract addresses for eth_sign7702Authorization requests.
    */
   export interface Ethereum7702AuthorizationCondition {
     field: 'contract';

package/src/resources/wallets/wallets.ts

@@ -335,7 +335,15 @@ export type WalletChainType =
  * 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;
 }
 
 /**
@@ -404,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>;
 

package/src/resources/webhooks.ts

@@ -1252,6 +1252,64 @@ export interface KrakenEmbedUserClosedWebhookPayload {
   user_id: string;
 }
 
+/**
+ * Payload for the yield.deposit.confirmed webhook event.
+ */
+export interface YieldDepositConfirmedWebhookPayload {
+  assets: string;
+
+  block_number: number;
+
+  caip2: string;
+
+  log_index: number;
+
+  owner: string;
+
+  sender: string;
+
+  shares: string;
+
+  transaction_hash: string;
+
+  /**
+   * The type of webhook event.
+   */
+  type: 'yield.deposit.confirmed';
+
+  vault_address: string;
+}
+
+/**
+ * Payload for the yield.withdraw.confirmed webhook event.
+ */
+export interface YieldWithdrawConfirmedWebhookPayload {
+  assets: string;
+
+  block_number: number;
+
+  caip2: string;
+
+  log_index: number;
+
+  owner: string;
+
+  receiver: string;
+
+  sender: string;
+
+  shares: string;
+
+  transaction_hash: string;
+
+  /**
+   * The type of webhook event.
+   */
+  type: 'yield.withdraw.confirmed';
+
+  vault_address: string;
+}
+
 export declare namespace Webhooks {
   export {
     type UserCreatedWebhookPayload as UserCreatedWebhookPayload,
@@ -1283,5 +1341,7 @@ export declare namespace Webhooks {
     type KrakenEmbedUserVerifiedWebhookPayload as KrakenEmbedUserVerifiedWebhookPayload,
     type KrakenEmbedUserDisabledWebhookPayload as KrakenEmbedUserDisabledWebhookPayload,
     type KrakenEmbedUserClosedWebhookPayload as KrakenEmbedUserClosedWebhookPayload,
+    type YieldDepositConfirmedWebhookPayload as YieldDepositConfirmedWebhookPayload,
+    type YieldWithdrawConfirmedWebhookPayload as YieldWithdrawConfirmedWebhookPayload,
   };
 }

package/src/resources/yield.ts

@@ -4,6 +4,11 @@ import { APIResource } from '../core/resource';
 
 export class Yield extends APIResource {}
 
+/**
+ * An EVM CAIP-2 chain identifier (e.g., "eip155:8453" for Base).
+ */
+export type EvmCaip2ChainID = string;
+
 /**
  * Supported yield/lending protocol providers.
  */
@@ -311,8 +316,59 @@ export namespace EthereumYieldPositionResponse {
   }
 }
 
+/**
+ * Input for claiming incentive rewards from vault participation.
+ */
+export interface EthereumYieldClaimInput {
+  /**
+   * An EVM CAIP-2 chain identifier (e.g., "eip155:8453" for Base).
+   */
+  caip2: EvmCaip2ChainID;
+}
+
+/**
+ * A single reward token claimed from vault participation.
+ */
+export interface EthereumYieldClaimReward {
+  /**
+   * Amount claimed in the smallest unit.
+   */
+  amount: string;
+
+  /**
+   * Reward token contract address.
+   */
+  token_address: string;
+
+  /**
+   * Reward token symbol (e.g., "MORPHO").
+   */
+  token_symbol: string;
+}
+
+/**
+ * Response from a yield reward claim operation.
+ */
+export interface EthereumYieldClaimResponse {
+  /**
+   * Privy transaction record ID for the claim operation.
+   */
+  id: string;
+
+  /**
+   * An EVM CAIP-2 chain identifier (e.g., "eip155:8453" for Base).
+   */
+  caip2: EvmCaip2ChainID;
+
+  /**
+   * List of reward tokens claimed.
+   */
+  rewards: Array<EthereumYieldClaimReward>;
+}
+
 export declare namespace Yield {
   export {
+    type EvmCaip2ChainID as EvmCaip2ChainID,
     type EthereumYieldProvider as EthereumYieldProvider,
     type EthereumYieldSweepType as EthereumYieldSweepType,
     type EthereumYieldSweepStatus as EthereumYieldSweepStatus,
@@ -326,5 +382,8 @@ export declare namespace Yield {
     type EthereumYieldPositionsInput as EthereumYieldPositionsInput,
     type EthereumVaultPosition as EthereumVaultPosition,
     type EthereumYieldPositionResponse as EthereumYieldPositionResponse,
+    type EthereumYieldClaimInput as EthereumYieldClaimInput,
+    type EthereumYieldClaimReward as EthereumYieldClaimReward,
+    type EthereumYieldClaimResponse as EthereumYieldClaimResponse,
   };
 }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.5.0'; // x-release-please-version
+export const VERSION = '0.6.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.5.0";
+export declare const VERSION = "0.6.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.5.0";
+export declare const VERSION = "0.6.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.5.0'; // x-release-please-version
+exports.VERSION = '0.6.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.5.0'; // x-release-please-version
+export const VERSION = '0.6.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map