@privy-io/api-types 0.6.1 → 0.8.0

package/src/resources/key-quorums.ts

@@ -1,18 +1,29 @@
 // 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';
 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> {
@@ -24,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([
@@ -42,6 +56,7 @@ export class KeyQuorums extends APIResource {
           ...(privyAuthorizationSignature != null ?
             { 'privy-authorization-signature': privyAuthorizationSignature }
           : undefined),
+          ...(privyRequestExpiry != null ? { 'privy-request-expiry': privyRequestExpiry } : undefined),
         },
         options?.headers,
       ]),
@@ -54,16 +69,27 @@ 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',
+   *     public_keys: [
+   *       'MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEx4aoeD72yykviK+f/ckqE2CItVIG\n1rCnvC3/XZ1HgpOcMEMialRmTrqIK4oZlYd1RfxU3za/C9yjhboIuoPD3g==',
+   *     ],
+   *   },
    * );
    * ```
    */
   _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,
@@ -72,6 +98,7 @@ export class KeyQuorums extends APIResource {
           ...(privyAuthorizationSignature != null ?
             { 'privy-authorization-signature': privyAuthorizationSignature }
           : undefined),
+          ...(privyRequestExpiry != null ? { 'privy-request-expiry': privyRequestExpiry } : undefined),
         },
         options?.headers,
       ]),
@@ -83,12 +110,10 @@ 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);
   }
 }
@@ -101,16 +126,16 @@ export interface KeyQuorum {
 
   authorization_keys: Array<KeyQuorum.AuthorizationKey>;
 
-  authorization_threshold?: number;
+  authorization_threshold: number | null;
 
-  display_name?: string;
+  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>;
-
-  user_ids?: Array<string>;
 }
 
 export namespace KeyQuorum {
@@ -121,11 +146,88 @@ export namespace KeyQuorum {
   }
 }
 
-export interface KeyQuorumDeleteResponse {
+/**
+ * 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.
+   */
+  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>;
+
   /**
-   * Whether the key quorum was deleted successfully.
+   * 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.
    */
-  success: boolean;
+  user_ids?: Array<string>;
+}
+
+/**
+ * Request input for updating an existing key quorum.
+ */
+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 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>;
+}
+
+/**
+ * Headers required to authorize modifications to key quorums.
+ */
+export interface KeyQuorumAuthorizationHeaders {
+  /**
+   * ID of your Privy app.
+   */
+  'privy-app-id': string;
+
+  /**
+   * Request authorization signature. If multiple signatures are required, they
+   * 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 KeyQuorumCreateParams {
@@ -162,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 {
@@ -199,12 +307,20 @@ 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 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,

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,
+  };
+}