@privy-io/api-types 0.7.0 → 0.8.0

package/src/resources/key-quorums.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
+import * as SharedAPI from './shared';
 import { APIPromise } from '../core/api-promise';
 import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
@@ -34,17 +35,20 @@ export class KeyQuorums extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.keyQuorums._delete(
-   *   'key_quorum_id',
+   * const successResponse = await client.keyQuorums._delete(
+   *   'string',
    * );
    * ```
    */
   _delete(
-    keyQuorumID: string,
+    keyQuorumID: SharedAPI.KeyQuorumID,
     params: KeyQuorumDeleteParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<KeyQuorumDeleteResponse> {
-    const { 'privy-authorization-signature': privyAuthorizationSignature } = params ?? {};
+  ): APIPromise<SharedAPI.SuccessResponse> {
+    const {
+      'privy-authorization-signature': privyAuthorizationSignature,
+      'privy-request-expiry': privyRequestExpiry,
+    } = params ?? {};
     return this._client.delete(path`/v1/key_quorums/${keyQuorumID}`, {
       ...options,
       headers: buildHeaders([
@@ -52,6 +56,7 @@ export class KeyQuorums extends APIResource {
           ...(privyAuthorizationSignature != null ?
             { 'privy-authorization-signature': privyAuthorizationSignature }
           : undefined),
+          ...(privyRequestExpiry != null ? { 'privy-request-expiry': privyRequestExpiry } : undefined),
         },
         options?.headers,
       ]),
@@ -64,7 +69,7 @@ export class KeyQuorums extends APIResource {
    * @example
    * ```ts
    * const keyQuorum = await client.keyQuorums._update(
-   *   'key_quorum_id',
+   *   'string',
    *   {
    *     authorization_threshold: 1,
    *     display_name: 'Prod key quorum',
@@ -76,11 +81,15 @@ export class KeyQuorums extends APIResource {
    * ```
    */
   _update(
-    keyQuorumID: string,
+    keyQuorumID: SharedAPI.KeyQuorumID,
     params: KeyQuorumUpdateParams,
     options?: RequestOptions,
   ): APIPromise<KeyQuorum> {
-    const { 'privy-authorization-signature': privyAuthorizationSignature, ...body } = params;
+    const {
+      'privy-authorization-signature': privyAuthorizationSignature,
+      'privy-request-expiry': privyRequestExpiry,
+      ...body
+    } = params;
     return this._client.patch(path`/v1/key_quorums/${keyQuorumID}`, {
       body,
       ...options,
@@ -89,6 +98,7 @@ export class KeyQuorums extends APIResource {
           ...(privyAuthorizationSignature != null ?
             { 'privy-authorization-signature': privyAuthorizationSignature }
           : undefined),
+          ...(privyRequestExpiry != null ? { 'privy-request-expiry': privyRequestExpiry } : undefined),
         },
         options?.headers,
       ]),
@@ -100,20 +110,46 @@ export class KeyQuorums extends APIResource {
    *
    * @example
    * ```ts
-   * const keyQuorum = await client.keyQuorums.get(
-   *   'key_quorum_id',
-   * );
+   * const keyQuorum = await client.keyQuorums.get('string');
    * ```
    */
-  get(keyQuorumID: string, options?: RequestOptions): APIPromise<KeyQuorum> {
+  get(keyQuorumID: SharedAPI.KeyQuorumID, options?: RequestOptions): APIPromise<KeyQuorum> {
     return this._client.get(path`/v1/key_quorums/${keyQuorumID}`, options);
   }
 }
 
 /**
- * Request input for creating or updating a key quorum.
+ * A key quorum for authorizing wallet operations.
  */
-export interface KeyQuorumCreateParams {
+export interface KeyQuorum {
+  id: string;
+
+  authorization_keys: Array<KeyQuorum.AuthorizationKey>;
+
+  authorization_threshold: number | null;
+
+  display_name: string | null;
+
+  user_ids: Array<string> | null;
+
+  /**
+   * List of nested key quorum IDs that are members of this key quorum.
+   */
+  key_quorum_ids?: Array<string>;
+}
+
+export namespace KeyQuorum {
+  export interface AuthorizationKey {
+    display_name: string | null;
+
+    public_key: string;
+  }
+}
+
+/**
+ * Request input for creating a key quorum.
+ */
+export interface KeyQuorumCreateRequestBody {
   /**
    * 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.
@@ -142,38 +178,56 @@ export interface KeyQuorumCreateParams {
 }
 
 /**
- * A key quorum for authorizing wallet operations.
+ * Request input for updating an existing key quorum.
  */
-export interface KeyQuorum {
-  id: string;
-
-  authorization_keys: Array<KeyQuorum.AuthorizationKey>;
-
+export interface KeyQuorumUpdateRequestBody {
+  /**
+   * 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 nested key quorum IDs that are members of this key quorum.
+   * 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>;
 }
 
-export namespace KeyQuorum {
-  export interface AuthorizationKey {
-    display_name: string | null;
+/**
+ * Headers required to authorize modifications to key quorums.
+ */
+export interface KeyQuorumAuthorizationHeaders {
+  /**
+   * ID of your Privy app.
+   */
+  'privy-app-id': string;
 
-    public_key: string;
-  }
-}
+  /**
+   * Request authorization signature. If multiple signatures are required, they
+   * should be comma separated.
+   */
+  'privy-authorization-signature'?: string;
 
-export interface KeyQuorumDeleteResponse {
   /**
-   * Whether the key quorum was deleted successfully.
+   * Request expiry. Value is a Unix timestamp in milliseconds representing the
+   * deadline by which the request must be processed.
    */
-  success: boolean;
+  'privy-request-expiry'?: string;
 }
 
 export interface KeyQuorumCreateParams {
@@ -210,6 +264,12 @@ export interface KeyQuorumDeleteParams {
    * should be comma separated.
    */
   'privy-authorization-signature'?: 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 interface KeyQuorumUpdateParams {
@@ -247,13 +307,21 @@ export interface KeyQuorumUpdateParams {
    * required, they should be comma separated.
    */
   'privy-authorization-signature'?: string;
+
+  /**
+   * Header param: 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 KeyQuorums {
   export {
-    type KeyQuorumCreateParams as KeyQuorumCreateParams,
     type KeyQuorum as KeyQuorum,
-    type KeyQuorumDeleteResponse as KeyQuorumDeleteResponse,
+    type KeyQuorumCreateRequestBody as KeyQuorumCreateRequestBody,
+    type KeyQuorumUpdateRequestBody as KeyQuorumUpdateRequestBody,
+    type KeyQuorumAuthorizationHeaders as KeyQuorumAuthorizationHeaders,
+    type KeyQuorumCreateParams as KeyQuorumCreateParams,
     type KeyQuorumDeleteParams as KeyQuorumDeleteParams,
     type KeyQuorumUpdateParams as KeyQuorumUpdateParams,
   };