@privy-io/api-types 0.6.1 → 0.8.0

package/src/resources/intents.ts

@@ -2,9 +2,133 @@
 
 import { APIResource } from '../core/resource';
 import * as IntentsAPI from './intents';
+import * as KeyQuorumsAPI from './key-quorums';
+import * as PoliciesAPI from './policies';
+import * as SharedAPI from './shared';
+import * as WalletsAPI from './wallets/wallets';
 
 export class Intents extends APIResource {}
 
+/**
+ * Type of intent.
+ */
+export type IntentType = 'KEY_QUORUM' | 'POLICY' | 'RULE' | 'RPC' | 'TRANSFER' | 'WALLET';
+
+/**
+ * Current status of an intent.
+ */
+export type IntentStatus = 'pending' | 'executed' | 'failed' | 'expired' | 'rejected' | 'dismissed';
+
+/**
+ * Request details for an RPC intent.
+ */
+export interface RpcIntentRequestDetails {
+  /**
+   * Request body for wallet RPC operations, discriminated by method.
+   */
+  body: WalletsAPI.WalletRpcRequestBody;
+
+  method: 'POST';
+
+  url: string;
+}
+
+/**
+ * Request details for a transfer intent.
+ */
+export interface TransferIntentRequestDetails {
+  /**
+   * Request body for initiating a sponsored token transfer from an embedded wallet.
+   */
+  body: WalletsAPI.CreateTokenTransferRequest;
+
+  method: 'POST';
+
+  url: string;
+}
+
+/**
+ * Request details for a policy intent.
+ */
+export interface PolicyIntentRequestDetails {
+  body: PolicyIntentRequestDetails.Body;
+
+  method: 'PATCH';
+
+  url: string;
+}
+
+export namespace PolicyIntentRequestDetails {
+  export interface Body {
+    /**
+     * Name to assign to policy.
+     */
+    name?: string;
+
+    /**
+     * The owner of the resource, specified as a Privy user ID, a P-256 public key, or
+     * null to remove the current owner.
+     */
+    owner?: SharedAPI.OwnerInput | null;
+
+    /**
+     * The key quorum ID to set as the owner of the resource. If you provide this, do
+     * not specify an owner.
+     */
+    owner_id?: SharedAPI.OwnerIDInput | null;
+
+    rules?: Array<PoliciesAPI.PolicyRuleRequestBody>;
+  }
+}
+
+/**
+ * Request details for creating a rule via intent.
+ */
+export interface RuleIntentCreateRequestDetails {
+  /**
+   * The rules that apply to each method the policy covers.
+   */
+  body: PoliciesAPI.PolicyRuleRequestBody;
+
+  method: 'POST';
+
+  url: string;
+}
+
+/**
+ * Request details for updating a rule via intent.
+ */
+export interface RuleIntentUpdateRequestDetails {
+  /**
+   * The rules that apply to each method the policy covers.
+   */
+  body: PoliciesAPI.PolicyRuleRequestBody;
+
+  method: 'PATCH';
+
+  url: string;
+}
+
+/**
+ * Request details for deleting a rule via intent.
+ */
+export interface RuleIntentDeleteRequestDetails {
+  method: 'DELETE';
+
+  url: string;
+
+  body?: unknown;
+}
+
+/**
+ * The original rule request. Method is POST (create), PATCH (update), or DELETE
+ * (delete)
+ */
+export type RuleIntentRequestDetails =
+  | RuleIntentCreateRequestDetails
+  | RuleIntentUpdateRequestDetails
+  | RuleIntentDeleteRequestDetails;
+
 /**
  * A leaf member (user or key) of a nested key quorum in an intent authorization.
  */
@@ -15,9 +139,9 @@ export type IntentAuthorizationKeyQuorumMember =
 export namespace IntentAuthorizationKeyQuorumMember {
   export interface UserMember {
     /**
-     * Whether this member has signed the intent
+     * Unix timestamp when this member signed, or null if not yet signed.
      */
-    has_signed: boolean;
+    signed_at: number | null;
 
     type: 'user';
 
@@ -25,30 +149,20 @@ export namespace IntentAuthorizationKeyQuorumMember {
      * 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)
+     * Unix timestamp when this member signed, or null if not yet signed.
      */
-    display_name?: string;
+    signed_at: number | null;
+
+    type: 'key';
   }
 }
 
@@ -64,9 +178,9 @@ export type IntentAuthorizationMember =
 export namespace IntentAuthorizationMember {
   export interface UserMember {
     /**
-     * Whether this member has signed the intent
+     * Unix timestamp when this member signed, or null if not yet signed.
      */
-    has_signed: boolean;
+    signed_at: number | null;
 
     type: 'user';
 
@@ -74,38 +188,23 @@ export namespace IntentAuthorizationMember {
      * 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)
+     * Unix timestamp when this member signed, or null if not yet signed.
      */
-    display_name?: string;
+    signed_at: number | null;
+
+    type: 'key';
   }
 
   export interface KeyQuorumMember {
-    /**
-     * Whether this child key quorum has fulfilled its threshold
-     */
-    has_signed: boolean;
-
     /**
      * ID of the child key quorum member
      */
@@ -121,6 +220,11 @@ export namespace IntentAuthorizationMember {
      */
     threshold: number;
 
+    /**
+     * Whether this child key quorum has met its signature threshold
+     */
+    threshold_met: boolean;
+
     type: 'key_quorum';
 
     /**
@@ -130,9 +234,443 @@ export namespace IntentAuthorizationMember {
   }
 }
 
+/**
+ * Authorization quorum for an intent
+ */
+export interface IntentAuthorization {
+  /**
+   * Members in this authorization quorum
+   */
+  members: Array<IntentAuthorizationMember>;
+
+  /**
+   * Number of signatures required to satisfy this quorum
+   */
+  threshold: number;
+
+  /**
+   * Display name of the key quorum
+   */
+  display_name?: string;
+}
+
+/**
+ * Common fields shared by all intent response types.
+ */
+export interface BaseIntentResponse {
+  /**
+   * Detailed authorization information including key quorum members, thresholds, and
+   * signature status
+   */
+  authorization_details: Array<IntentAuthorization>;
+
+  /**
+   * Unix timestamp when the intent was created
+   */
+  created_at: number;
+
+  /**
+   * Display name of the user who created the intent
+   */
+  created_by_display_name: string;
+
+  /**
+   * Whether this intent has a custom expiry time set by the client. If false, the
+   * intent expires after a default duration.
+   */
+  custom_expiry: boolean;
+
+  /**
+   * Unix timestamp when the intent expires
+   */
+  expires_at: number;
+
+  /**
+   * Unique ID for the intent
+   */
+  intent_id: string;
+
+  /**
+   * ID of the resource being modified (wallet_id, policy_id, etc)
+   */
+  resource_id: string;
+
+  /**
+   * Current status of an intent.
+   */
+  status: IntentStatus;
+
+  /**
+   * ID of the user who created the intent. If undefined, the intent was created
+   * using the app secret
+   */
+  created_by_id?: string;
+
+  /**
+   * Human-readable reason for dismissal, present when status is 'dismissed'
+   */
+  dismissal_reason?: string;
+
+  /**
+   * Unix timestamp when the intent was dismissed, present when status is 'dismissed'
+   */
+  dismissed_at?: number;
+
+  /**
+   * Unix timestamp when the intent was rejected, present when status is 'rejected'
+   */
+  rejected_at?: number;
+}
+
+/**
+ * Common fields for intent action execution results.
+ */
+export interface BaseActionResult {
+  /**
+   * Unix timestamp when the action was executed
+   */
+  executed_at: number;
+
+  /**
+   * HTTP status code from the action execution
+   */
+  status_code: number;
+
+  /**
+   * Display name of the key quorum that authorized execution
+   */
+  authorized_by_display_name?: string;
+
+  /**
+   * ID of the key quorum that authorized execution
+   */
+  authorized_by_id?: string;
+}
+
+/**
+ * Response for an RPC intent
+ */
+export interface RpcIntentResponse extends BaseIntentResponse {
+  intent_type: 'RPC';
+
+  /**
+   * The original RPC request that would be sent to the wallet endpoint
+   */
+  request_details: RpcIntentResponse.RequestDetails;
+
+  /**
+   * Result of RPC execution (only present if status is 'executed' or 'failed')
+   */
+  action_result?: BaseActionResult;
+
+  /**
+   * A wallet managed by Privy's wallet infrastructure.
+   */
+  current_resource_data?: WalletsAPI.Wallet;
+}
+
+export namespace RpcIntentResponse {
+  /**
+   * The original RPC request that would be sent to the wallet endpoint
+   */
+  export interface RequestDetails {
+    /**
+     * Request body for wallet RPC operations, discriminated by method.
+     */
+    body: WalletsAPI.WalletRpcRequestBody;
+
+    method: 'POST';
+
+    url: string;
+  }
+}
+
+/**
+ * Response for a transfer intent
+ */
+export interface TransferIntentResponse extends BaseIntentResponse {
+  intent_type: 'TRANSFER';
+
+  /**
+   * The original transfer request that would be sent to the wallet transfer endpoint
+   */
+  request_details: TransferIntentResponse.RequestDetails;
+
+  /**
+   * Result of transfer execution (only present if intent status is 'executed' or
+   * 'failed')
+   */
+  action_result?: BaseActionResult;
+
+  /**
+   * A wallet managed by Privy's wallet infrastructure.
+   */
+  current_resource_data?: WalletsAPI.Wallet;
+}
+
+export namespace TransferIntentResponse {
+  /**
+   * The original transfer request that would be sent to the wallet transfer endpoint
+   */
+  export interface RequestDetails {
+    /**
+     * Request body for initiating a sponsored token transfer from an embedded wallet.
+     */
+    body: WalletsAPI.CreateTokenTransferRequest;
+
+    method: 'POST';
+
+    url: string;
+  }
+}
+
+/**
+ * Response for a wallet intent
+ */
+export interface WalletIntentResponse extends BaseIntentResponse {
+  intent_type: 'WALLET';
+
+  /**
+   * The original wallet update request that would be sent to the wallet endpoint
+   */
+  request_details: WalletIntentResponse.RequestDetails;
+
+  /**
+   * Result of wallet update execution (only present if status is 'executed' or
+   * 'failed')
+   */
+  action_result?: BaseActionResult;
+
+  /**
+   * A wallet managed by Privy's wallet infrastructure.
+   */
+  current_resource_data?: WalletsAPI.Wallet;
+}
+
+export namespace WalletIntentResponse {
+  /**
+   * The original wallet update request that would be sent to the wallet endpoint
+   */
+  export interface RequestDetails {
+    body: RequestDetails.Body;
+
+    method: 'PATCH';
+
+    url: string;
+  }
+
+  export namespace RequestDetails {
+    export interface Body {
+      /**
+       * Additional signers for the wallet.
+       */
+      additional_signers?: WalletsAPI.AdditionalSignerInput;
+
+      authorization_key_ids?: Array<string>;
+
+      authorization_threshold?: number;
+
+      display_name?: string | null;
+
+      /**
+       * The owner of the resource, specified as a Privy user ID, a P-256 public key, or
+       * null to remove the current owner.
+       */
+      owner?: SharedAPI.OwnerInput | null;
+
+      /**
+       * The key quorum ID to set as the owner of the resource. If you provide this, do
+       * not specify an owner.
+       */
+      owner_id?: SharedAPI.OwnerIDInput | null;
+
+      /**
+       * An optional list of up to one policy ID to enforce on the wallet.
+       */
+      policy_ids?: WalletsAPI.PolicyInput;
+    }
+  }
+}
+
+/**
+ * Response for a policy intent
+ */
+export interface PolicyIntentResponse extends BaseIntentResponse {
+  intent_type: 'POLICY';
+
+  /**
+   * The original policy update request that would be sent to the policy endpoint
+   */
+  request_details: PolicyIntentResponse.RequestDetails;
+
+  /**
+   * Result of policy update execution (only present if status is 'executed' or
+   * 'failed')
+   */
+  action_result?: BaseActionResult;
+
+  /**
+   * A policy for controlling wallet operations.
+   */
+  current_resource_data?: PoliciesAPI.Policy;
+}
+
+export namespace PolicyIntentResponse {
+  /**
+   * The original policy update request that would be sent to the policy endpoint
+   */
+  export interface RequestDetails {
+    body: RequestDetails.Body;
+
+    method: 'PATCH';
+
+    url: string;
+  }
+
+  export namespace RequestDetails {
+    export interface Body {
+      /**
+       * Name to assign to policy.
+       */
+      name?: string;
+
+      /**
+       * The owner of the resource, specified as a Privy user ID, a P-256 public key, or
+       * null to remove the current owner.
+       */
+      owner?: SharedAPI.OwnerInput | null;
+
+      /**
+       * The key quorum ID to set as the owner of the resource. If you provide this, do
+       * not specify an owner.
+       */
+      owner_id?: SharedAPI.OwnerIDInput | null;
+
+      rules?: Array<PoliciesAPI.PolicyRuleRequestBody>;
+    }
+  }
+}
+
+/**
+ * Response for a key quorum intent
+ */
+export interface KeyQuorumIntentResponse extends BaseIntentResponse {
+  intent_type: 'KEY_QUORUM';
+
+  /**
+   * The original key quorum update request that would be sent to the key quorum
+   * endpoint
+   */
+  request_details: KeyQuorumIntentResponse.RequestDetails;
+
+  /**
+   * Result of key quorum update execution (only present if status is 'executed' or
+   * 'failed')
+   */
+  action_result?: BaseActionResult;
+
+  /**
+   * A key quorum for authorizing wallet operations.
+   */
+  current_resource_data?: KeyQuorumsAPI.KeyQuorum;
+}
+
+export namespace KeyQuorumIntentResponse {
+  /**
+   * The original key quorum update request that would be sent to the key quorum
+   * endpoint
+   */
+  export interface RequestDetails {
+    /**
+     * Request input for updating an existing key quorum.
+     */
+    body: KeyQuorumsAPI.KeyQuorumUpdateRequestBody;
+
+    method: 'PATCH';
+
+    url: string;
+  }
+}
+
+/**
+ * Response for a rule intent
+ */
+export interface RuleIntentResponse extends BaseIntentResponse {
+  intent_type: 'RULE';
+
+  /**
+   * The original rule request. Method is POST (create), PATCH (update), or DELETE
+   * (delete)
+   */
+  request_details: RuleIntentRequestDetails;
+
+  /**
+   * Result of rule execution (only present if status is 'executed' or 'failed')
+   */
+  action_result?: BaseActionResult;
+
+  /**
+   * A rule that defines the conditions and action to take if the conditions are
+   * true.
+   */
+  current_resource_data?: PoliciesAPI.PolicyRuleResponse;
+
+  /**
+   * A policy for controlling wallet operations.
+   */
+  policy?: PoliciesAPI.Policy;
+}
+
+/**
+ * Response for an intent object
+ */
+export type IntentResponse =
+  | RpcIntentResponse
+  | TransferIntentResponse
+  | WalletIntentResponse
+  | PolicyIntentResponse
+  | RuleIntentResponse
+  | KeyQuorumIntentResponse;
+
+/**
+ * Headers required to create an intent.
+ */
+export interface IntentCreationHeaders {
+  /**
+   * ID of your Privy app.
+   */
+  'privy-app-id': string;
+
+  /**
+   * Request expiry. Value is a Unix timestamp in milliseconds representing the
+   * deadline by which the request must be processed.
+   */
+  'privy-request-expiry'?: string;
+}
+
 export declare namespace Intents {
   export {
+    type IntentType as IntentType,
+    type IntentStatus as IntentStatus,
+    type RpcIntentRequestDetails as RpcIntentRequestDetails,
+    type TransferIntentRequestDetails as TransferIntentRequestDetails,
+    type PolicyIntentRequestDetails as PolicyIntentRequestDetails,
+    type RuleIntentCreateRequestDetails as RuleIntentCreateRequestDetails,
+    type RuleIntentUpdateRequestDetails as RuleIntentUpdateRequestDetails,
+    type RuleIntentDeleteRequestDetails as RuleIntentDeleteRequestDetails,
+    type RuleIntentRequestDetails as RuleIntentRequestDetails,
     type IntentAuthorizationKeyQuorumMember as IntentAuthorizationKeyQuorumMember,
     type IntentAuthorizationMember as IntentAuthorizationMember,
+    type IntentAuthorization as IntentAuthorization,
+    type BaseIntentResponse as BaseIntentResponse,
+    type BaseActionResult as BaseActionResult,
+    type RpcIntentResponse as RpcIntentResponse,
+    type TransferIntentResponse as TransferIntentResponse,
+    type WalletIntentResponse as WalletIntentResponse,
+    type PolicyIntentResponse as PolicyIntentResponse,
+    type KeyQuorumIntentResponse as KeyQuorumIntentResponse,
+    type RuleIntentResponse as RuleIntentResponse,
+    type IntentResponse as IntentResponse,
+    type IntentCreationHeaders as IntentCreationHeaders,
   };
 }