@privy-io/api-types 0.8.0 → 0.10.0

package/src/resources/intents.ts

@@ -10,125 +10,118 @@ 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.
+ * Common fields for intent action execution results.
  */
-export interface RpcIntentRequestDetails {
+export interface BaseActionResult {
   /**
-   * Request body for wallet RPC operations, discriminated by method.
+   * Unix timestamp when the action was executed
    */
-  body: WalletsAPI.WalletRpcRequestBody;
-
-  method: 'POST';
-
-  url: string;
-}
+  executed_at: number;
 
-/**
- * Request details for a transfer intent.
- */
-export interface TransferIntentRequestDetails {
   /**
-   * Request body for initiating a sponsored token transfer from an embedded wallet.
+   * HTTP status code from the action execution
    */
-  body: WalletsAPI.CreateTokenTransferRequest;
+  status_code: number;
 
-  method: 'POST';
+  /**
+   * Display name of the key quorum that authorized execution
+   */
+  authorized_by_display_name?: string;
 
-  url: string;
+  /**
+   * ID of the key quorum that authorized execution
+   */
+  authorized_by_id?: string;
 }
 
 /**
- * Request details for a policy intent.
+ * Common fields shared by all intent response types.
  */
-export interface PolicyIntentRequestDetails {
-  body: PolicyIntentRequestDetails.Body;
-
-  method: 'PATCH';
+export interface BaseIntentResponse {
+  /**
+   * Detailed authorization information including key quorum members, thresholds, and
+   * signature status
+   */
+  authorization_details: Array<IntentAuthorization>;
 
-  url: string;
-}
+  /**
+   * Unix timestamp when the intent was created
+   */
+  created_at: number;
 
-export namespace PolicyIntentRequestDetails {
-  export interface Body {
-    /**
-     * Name to assign to policy.
-     */
-    name?: string;
+  /**
+   * Display name of the user who created the intent
+   */
+  created_by_display_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;
+  /**
+   * Whether this intent has a custom expiry time set by the client. If false, the
+   * intent expires after a default duration.
+   */
+  custom_expiry: boolean;
 
-    /**
-     * 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;
+  /**
+   * Unix timestamp when the intent expires
+   */
+  expires_at: number;
 
-    rules?: Array<PoliciesAPI.PolicyRuleRequestBody>;
-  }
-}
+  /**
+   * Unique ID for the intent
+   */
+  intent_id: string;
 
-/**
- * Request details for creating a rule via intent.
- */
-export interface RuleIntentCreateRequestDetails {
   /**
-   * The rules that apply to each method the policy covers.
+   * ID of the resource being modified (wallet_id, policy_id, etc)
    */
-  body: PoliciesAPI.PolicyRuleRequestBody;
+  resource_id: string;
 
-  method: 'POST';
+  /**
+   * Current status of an intent.
+   */
+  status: IntentStatus;
 
-  url: string;
-}
+  /**
+   * ID of the user who created the intent. If undefined, the intent was created
+   * using the app secret
+   */
+  created_by_id?: string;
 
-/**
- * Request details for updating a rule via intent.
- */
-export interface RuleIntentUpdateRequestDetails {
   /**
-   * The rules that apply to each method the policy covers.
+   * Human-readable reason for dismissal, present when status is 'dismissed'
    */
-  body: PoliciesAPI.PolicyRuleRequestBody;
+  dismissal_reason?: string;
 
-  method: 'PATCH';
+  /**
+   * Unix timestamp when the intent was dismissed, present when status is 'dismissed'
+   */
+  dismissed_at?: number;
 
-  url: string;
+  /**
+   * Unix timestamp when the intent was rejected, present when status is 'rejected'
+   */
+  rejected_at?: number;
 }
 
 /**
- * Request details for deleting a rule via intent.
+ * Authorization quorum for an intent
  */
-export interface RuleIntentDeleteRequestDetails {
-  method: 'DELETE';
+export interface IntentAuthorization {
+  /**
+   * Members in this authorization quorum
+   */
+  members: Array<IntentAuthorizationMember>;
 
-  url: string;
+  /**
+   * Number of signatures required to satisfy this quorum
+   */
+  threshold: number;
 
-  body?: unknown;
+  /**
+   * Display name of the key quorum
+   */
+  display_name?: string;
 }
 
-/**
- * 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.
  */
@@ -235,116 +228,188 @@ export namespace IntentAuthorizationMember {
 }
 
 /**
- * Authorization quorum for an intent
+ * Headers required to create an intent.
  */
-export interface IntentAuthorization {
-  /**
-   * Members in this authorization quorum
-   */
-  members: Array<IntentAuthorizationMember>;
-
+export interface IntentCreationHeaders {
   /**
-   * Number of signatures required to satisfy this quorum
+   * ID of your Privy app.
    */
-  threshold: number;
+  'privy-app-id': string;
 
   /**
-   * Display name of the key quorum
+   * Request expiry. Value is a Unix timestamp in milliseconds representing the
+   * deadline by which the request must be processed.
    */
-  display_name?: string;
+  'privy-request-expiry'?: string;
 }
 
 /**
- * Common fields shared by all intent response types.
+ * Response for an intent object
  */
-export interface BaseIntentResponse {
-  /**
-   * Detailed authorization information including key quorum members, thresholds, and
-   * signature status
-   */
-  authorization_details: Array<IntentAuthorization>;
+export type IntentResponse =
+  | RpcIntentResponse
+  | TransferIntentResponse
+  | WalletIntentResponse
+  | PolicyIntentResponse
+  | RuleIntentResponse
+  | KeyQuorumIntentResponse;
 
-  /**
-   * Unix timestamp when the intent was created
-   */
-  created_at: number;
+/**
+ * Current status of an intent.
+ */
+export type IntentStatus = 'pending' | 'executed' | 'failed' | 'expired' | 'rejected' | 'dismissed';
 
-  /**
-   * Display name of the user who created the intent
-   */
-  created_by_display_name: string;
+/**
+ * Type of intent.
+ */
+export type IntentType = 'KEY_QUORUM' | 'POLICY' | 'RULE' | 'RPC' | 'TRANSFER' | 'WALLET';
 
-  /**
-   * Whether this intent has a custom expiry time set by the client. If false, the
-   * intent expires after a default duration.
-   */
-  custom_expiry: boolean;
+/**
+ * Response for a key quorum intent
+ */
+export interface KeyQuorumIntentResponse extends BaseIntentResponse {
+  intent_type: 'KEY_QUORUM';
 
   /**
-   * Unix timestamp when the intent expires
+   * The original key quorum update request that would be sent to the key quorum
+   * endpoint
    */
-  expires_at: number;
+  request_details: KeyQuorumIntentResponse.RequestDetails;
 
   /**
-   * Unique ID for the intent
+   * Result of key quorum update execution (only present if status is 'executed' or
+   * 'failed')
    */
-  intent_id: string;
+  action_result?: BaseActionResult;
 
   /**
-   * ID of the resource being modified (wallet_id, policy_id, etc)
+   * A key quorum for authorizing wallet operations.
    */
-  resource_id: string;
+  current_resource_data?: KeyQuorumsAPI.KeyQuorum;
+}
 
+export namespace KeyQuorumIntentResponse {
   /**
-   * Current status of an intent.
+   * The original key quorum update request that would be sent to the key quorum
+   * endpoint
    */
-  status: IntentStatus;
+  export interface RequestDetails {
+    /**
+     * Request input for updating an existing key quorum.
+     */
+    body: KeyQuorumsAPI.KeyQuorumUpdateRequestBody;
 
-  /**
-   * ID of the user who created the intent. If undefined, the intent was created
-   * using the app secret
-   */
-  created_by_id?: string;
+    method: 'PATCH';
 
-  /**
-   * Human-readable reason for dismissal, present when status is 'dismissed'
-   */
-  dismissal_reason?: string;
+    url: string;
+  }
+}
 
-  /**
-   * Unix timestamp when the intent was dismissed, present when status is 'dismissed'
-   */
-  dismissed_at?: number;
+/**
+ * Request details for a policy intent.
+ */
+export interface PolicyIntentRequestDetails {
+  body: PolicyIntentRequestDetails.Body;
 
-  /**
-   * Unix timestamp when the intent was rejected, present when status is 'rejected'
-   */
-  rejected_at?: number;
+  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>;
+  }
 }
 
 /**
- * Common fields for intent action execution results.
+ * Response for a policy intent
  */
-export interface BaseActionResult {
+export interface PolicyIntentResponse extends BaseIntentResponse {
+  intent_type: 'POLICY';
+
   /**
-   * Unix timestamp when the action was executed
+   * The original policy update request that would be sent to the policy endpoint
    */
-  executed_at: number;
+  request_details: PolicyIntentResponse.RequestDetails;
 
   /**
-   * HTTP status code from the action execution
+   * Result of policy update execution (only present if status is 'executed' or
+   * 'failed')
    */
-  status_code: number;
+  action_result?: BaseActionResult;
 
   /**
-   * Display name of the key quorum that authorized execution
+   * A policy for controlling wallet operations.
    */
-  authorized_by_display_name?: string;
+  current_resource_data?: PoliciesAPI.Policy;
+}
 
+export namespace PolicyIntentResponse {
   /**
-   * ID of the key quorum that authorized execution
+   * The original policy update request that would be sent to the policy endpoint
    */
-  authorized_by_id?: string;
+  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>;
+    }
+  }
+}
+
+/**
+ * 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;
 }
 
 /**
@@ -385,6 +450,101 @@ export namespace RpcIntentResponse {
   }
 }
 
+/**
+ * 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 deleting a rule via intent.
+ */
+export interface RuleIntentDeleteRequestDetails {
+  method: 'DELETE';
+
+  url: string;
+
+  body?: RuleIntentDeleteRequestDetails.Body;
+}
+
+export namespace RuleIntentDeleteRequestDetails {
+  export interface Body {}
+}
+
+/**
+ * The original rule request. Method is POST (create), PATCH (update), or DELETE
+ * (delete)
+ */
+export type RuleIntentRequestDetails =
+  | RuleIntentCreateRequestDetails
+  | RuleIntentUpdateRequestDetails
+  | RuleIntentDeleteRequestDetails;
+
+/**
+ * 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;
+}
+
+/**
+ * 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 a transfer intent.
+ */
+export interface TransferIntentRequestDetails {
+  /**
+   * Request body for initiating a sponsored token transfer from an embedded wallet.
+   */
+  body: WalletsAPI.TransferRequestBody;
+
+  method: 'POST';
+
+  url: string;
+}
+
 /**
  * Response for a transfer intent
  */
@@ -416,7 +576,7 @@ export namespace TransferIntentResponse {
     /**
      * Request body for initiating a sponsored token transfer from an embedded wallet.
      */
-    body: WalletsAPI.CreateTokenTransferRequest;
+    body: WalletsAPI.TransferRequestBody;
 
     method: 'POST';
 
@@ -492,185 +652,29 @@ export namespace WalletIntentResponse {
   }
 }
 
-/**
- * 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 BaseActionResult as BaseActionResult,
+    type BaseIntentResponse as BaseIntentResponse,
+    type IntentAuthorization as IntentAuthorization,
+    type IntentAuthorizationKeyQuorumMember as IntentAuthorizationKeyQuorumMember,
+    type IntentAuthorizationMember as IntentAuthorizationMember,
+    type IntentCreationHeaders as IntentCreationHeaders,
+    type IntentResponse as IntentResponse,
     type IntentStatus as IntentStatus,
-    type RpcIntentRequestDetails as RpcIntentRequestDetails,
-    type TransferIntentRequestDetails as TransferIntentRequestDetails,
+    type IntentType as IntentType,
+    type KeyQuorumIntentResponse as KeyQuorumIntentResponse,
     type PolicyIntentRequestDetails as PolicyIntentRequestDetails,
+    type PolicyIntentResponse as PolicyIntentResponse,
+    type RpcIntentRequestDetails as RpcIntentRequestDetails,
+    type RpcIntentResponse as RpcIntentResponse,
     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 RuleIntentResponse as RuleIntentResponse,
+    type RuleIntentUpdateRequestDetails as RuleIntentUpdateRequestDetails,
+    type TransferIntentRequestDetails as TransferIntentRequestDetails,
     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,
   };
 }