@privy-io/api-types 0.3.4 → 0.4.0

package/src/resources/aggregations.ts

@@ -0,0 +1,497 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as WalletsAPI from './wallets/wallets';
+
+export class Aggregations extends APIResource {}
+
+/**
+ * The RPC method this aggregation applies to.
+ */
+export type AggregationMethod =
+  | 'eth_signTransaction'
+  | 'eth_signUserOperation'
+  | 'signTransaction'
+  | 'signTransactionBytes';
+
+/**
+ * The metric configuration for an aggregation, defining what field/field_source to
+ * measure and the aggregation function to apply.
+ */
+export interface AggregationMetric {
+  field: string;
+
+  field_source: string;
+
+  /**
+   * The aggregation function to apply.
+   */
+  function: 'sum';
+
+  abi?: Array<AggregationMetric.Abi>;
+}
+
+export namespace AggregationMetric {
+  export interface Abi {
+    type: 'function' | 'constructor' | 'event' | 'fallback' | 'receive';
+
+    anonymous?: boolean;
+
+    inputs?: Array<Abi.Input>;
+
+    name?: string;
+
+    outputs?: Array<Abi.Output>;
+
+    stateMutability?: 'pure' | 'view' | 'nonpayable' | 'payable';
+  }
+
+  export namespace Abi {
+    export interface Input {
+      type: string;
+
+      components?: Array<unknown>;
+
+      indexed?: boolean;
+
+      internalType?: string;
+
+      name?: string;
+    }
+
+    export interface Output {
+      type: string;
+
+      components?: Array<unknown>;
+
+      indexed?: boolean;
+
+      internalType?: string;
+
+      name?: string;
+    }
+  }
+}
+
+/**
+ * The time window configuration for an aggregation.
+ */
+export interface AggregationWindow {
+  /**
+   * Duration of the rolling window in seconds (1-72 hours).
+   */
+  seconds: number;
+
+  type: 'rolling';
+}
+
+/**
+ * A grouping configuration for an aggregation. Maximum of 2 group_by fields
+ * allowed.
+ */
+export interface AggregationGroupBy {
+  field: string;
+
+  field_source: string;
+
+  abi?: Array<AggregationGroupBy.Abi>;
+}
+
+export namespace AggregationGroupBy {
+  export interface Abi {
+    type: 'function' | 'constructor' | 'event' | 'fallback' | 'receive';
+
+    anonymous?: boolean;
+
+    inputs?: Array<Abi.Input>;
+
+    name?: string;
+
+    outputs?: Array<Abi.Output>;
+
+    stateMutability?: 'pure' | 'view' | 'nonpayable' | 'payable';
+  }
+
+  export namespace Abi {
+    export interface Input {
+      type: string;
+
+      components?: Array<unknown>;
+
+      indexed?: boolean;
+
+      internalType?: string;
+
+      name?: string;
+    }
+
+    export interface Output {
+      type: string;
+
+      components?: Array<unknown>;
+
+      indexed?: boolean;
+
+      internalType?: string;
+
+      name?: string;
+    }
+  }
+}
+
+/**
+ * An aggregation that measures and tracks metrics over a period of time.
+ */
+export interface Aggregation {
+  /**
+   * Unique ID of the aggregation.
+   */
+  id: string;
+
+  /**
+   * Unix timestamp of when the aggregation was created in milliseconds.
+   */
+  created_at: number;
+
+  /**
+   * The RPC method this aggregation applies to.
+   */
+  method: AggregationMethod;
+
+  /**
+   * The metric configuration for an aggregation, defining what field/field_source to
+   * measure and the aggregation function to apply.
+   */
+  metric: AggregationMetric;
+
+  /**
+   * The name of the aggregation.
+   */
+  name: string;
+
+  /**
+   * The key quorum ID of the owner of the aggregation.
+   */
+  owner_id: string | null;
+
+  /**
+   * The time window configuration for an aggregation.
+   */
+  window: AggregationWindow;
+
+  /**
+   * Optional conditions to filter events before aggregation.
+   */
+  conditions?: Array<
+    | Aggregation.UnionMember0
+    | Aggregation.UnionMember1
+    | Aggregation.UnionMember2
+    | Aggregation.UnionMember3
+    | Aggregation.UnionMember4
+    | Aggregation.UnionMember5
+    | Aggregation.UnionMember6
+    | Aggregation.UnionMember7
+    | Aggregation.UnionMember8
+    | Aggregation.UnionMember9
+    | Aggregation.UnionMember10
+    | Aggregation.UnionMember11
+    | Aggregation.UnionMember12
+    | Aggregation.UnionMember13
+  >;
+
+  /**
+   * Optional grouping configuration for bucketing metrics.
+   */
+  group_by?: Array<AggregationGroupBy>;
+}
+
+export namespace Aggregation {
+  export interface UnionMember0 {
+    field: 'to' | 'value' | 'chain_id';
+
+    field_source: 'ethereum_transaction';
+
+    operator: 'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'in_condition_set';
+
+    value: string | Array<string>;
+  }
+
+  export interface UnionMember1 {
+    abi: Array<UnionMember1.Abi>;
+
+    field: string;
+
+    field_source: 'ethereum_calldata';
+
+    operator: 'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'in_condition_set';
+
+    value: string | Array<string>;
+  }
+
+  export namespace UnionMember1 {
+    export interface Abi {
+      type: 'function' | 'constructor' | 'event' | 'fallback' | 'receive';
+
+      anonymous?: boolean;
+
+      inputs?: Array<Abi.Input>;
+
+      name?: string;
+
+      outputs?: Array<Abi.Output>;
+
+      stateMutability?: 'pure' | 'view' | 'nonpayable' | 'payable';
+    }
+
+    export namespace Abi {
+      export interface Input {
+        type: string;
+
+        components?: Array<unknown>;
+
+        indexed?: boolean;
+
+        internalType?: string;
+
+        name?: string;
+      }
+
+      export interface Output {
+        type: string;
+
+        components?: Array<unknown>;
+
+        indexed?: boolean;
+
+        internalType?: string;
+
+        name?: string;
+      }
+    }
+  }
+
+  export interface UnionMember2 {
+    field: 'chainId' | 'verifyingContract' | 'chain_id' | 'verifying_contract';
+
+    field_source: 'ethereum_typed_data_domain';
+
+    operator: 'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'in_condition_set';
+
+    value: string | Array<string>;
+  }
+
+  export interface UnionMember3 {
+    field: string;
+
+    field_source: 'ethereum_typed_data_message';
+
+    operator: 'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'in_condition_set';
+
+    typed_data: UnionMember3.TypedData;
+
+    value: string | Array<string>;
+  }
+
+  export namespace UnionMember3 {
+    export interface TypedData {
+      primary_type: string;
+
+      types: { [key: string]: Array<TypedData.Type> };
+    }
+
+    export namespace TypedData {
+      export interface Type {
+        name: string;
+
+        type: string;
+      }
+    }
+  }
+
+  export interface UnionMember4 {
+    field: 'contract';
+
+    field_source: 'ethereum_7702_authorization';
+
+    operator: 'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'in_condition_set';
+
+    value: string | Array<string>;
+  }
+
+  export interface UnionMember5 {
+    field: 'programId';
+
+    field_source: 'solana_program_instruction';
+
+    operator: 'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'in_condition_set';
+
+    value: string | Array<string>;
+  }
+
+  export interface UnionMember6 {
+    field: 'instructionName' | 'Transfer.from' | 'Transfer.to' | 'Transfer.lamports';
+
+    field_source: 'solana_system_program_instruction';
+
+    operator: 'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'in_condition_set';
+
+    value: string | Array<string>;
+  }
+
+  export interface UnionMember7 {
+    field:
+      | 'instructionName'
+      | 'Transfer.source'
+      | 'Transfer.destination'
+      | 'Transfer.authority'
+      | 'Transfer.amount'
+      | 'TransferChecked.source'
+      | 'TransferChecked.destination'
+      | 'TransferChecked.authority'
+      | 'TransferChecked.amount'
+      | 'TransferChecked.mint'
+      | 'Burn.account'
+      | 'Burn.mint'
+      | 'Burn.authority'
+      | 'Burn.amount'
+      | 'MintTo.mint'
+      | 'MintTo.account'
+      | 'MintTo.authority'
+      | 'MintTo.amount'
+      | 'CloseAccount.account'
+      | 'CloseAccount.destination'
+      | 'CloseAccount.authority'
+      | 'InitializeAccount3.account'
+      | 'InitializeAccount3.mint'
+      | 'InitializeAccount3.owner';
+
+    field_source: 'solana_token_program_instruction';
+
+    operator: 'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'in_condition_set';
+
+    value: string | Array<string>;
+  }
+
+  export interface UnionMember8 {
+    field:
+      | 'TransferContract.to_address'
+      | 'TransferContract.amount'
+      | 'TriggerSmartContract.contract_address'
+      | 'TriggerSmartContract.call_value'
+      | 'TriggerSmartContract.token_id'
+      | 'TriggerSmartContract.call_token_value';
+
+    field_source: 'tron_transaction';
+
+    operator: 'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'in_condition_set';
+
+    value: string | Array<string>;
+  }
+
+  export interface UnionMember9 {
+    field: 'current_unix_timestamp';
+
+    field_source: 'system';
+
+    operator: 'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'in_condition_set';
+
+    value: string | Array<string>;
+  }
+
+  export interface UnionMember10 {
+    field: string;
+
+    field_source: 'reference';
+
+    operator: 'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'in_condition_set';
+
+    value: string | Array<string>;
+  }
+
+  export interface UnionMember11 {
+    abi: Array<UnionMember11.Abi>;
+
+    field: string;
+
+    field_source: 'tron_trigger_smart_contract_data';
+
+    operator: 'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'in_condition_set';
+
+    value: string | Array<string>;
+  }
+
+  export namespace UnionMember11 {
+    export interface Abi {
+      type: 'function' | 'constructor' | 'event' | 'fallback' | 'receive';
+
+      anonymous?: boolean;
+
+      inputs?: Array<Abi.Input>;
+
+      name?: string;
+
+      outputs?: Array<Abi.Output>;
+
+      stateMutability?: 'pure' | 'view' | 'nonpayable' | 'payable';
+    }
+
+    export namespace Abi {
+      export interface Input {
+        type: string;
+
+        components?: Array<unknown>;
+
+        indexed?: boolean;
+
+        internalType?: string;
+
+        name?: string;
+      }
+
+      export interface Output {
+        type: string;
+
+        components?: Array<unknown>;
+
+        indexed?: boolean;
+
+        internalType?: string;
+
+        name?: string;
+      }
+    }
+  }
+
+  export interface UnionMember12 {
+    field: 'commandName';
+
+    field_source: 'sui_transaction_command';
+
+    operator: 'eq' | 'in';
+
+    /**
+     * SUI transaction commands allowlist for raw_sign endpoint policy evaluation
+     */
+    value: WalletsAPI.SuiCommandName | Array<WalletsAPI.SuiCommandName>;
+  }
+
+  export interface UnionMember13 {
+    field: 'recipient' | 'amount';
+
+    field_source: 'sui_transfer_objects_command';
+
+    operator: 'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'in_condition_set';
+
+    value: string | Array<string>;
+  }
+}
+
+export declare namespace Aggregations {
+  export {
+    type AggregationMethod as AggregationMethod,
+    type AggregationMetric as AggregationMetric,
+    type AggregationWindow as AggregationWindow,
+    type AggregationGroupBy as AggregationGroupBy,
+    type Aggregation as Aggregation,
+  };
+}

package/src/resources/client-auth.ts

@@ -213,7 +213,7 @@ export interface GuestAuthenticateRequestBody {
 export interface MfaPasskeyEnrollmentRequestBody {
   credential_ids: Array<string>;
 
-  remove_for_login: boolean;
+  remove_for_login?: boolean;
 }
 
 /**
@@ -441,23 +441,10 @@ export interface OAuthLinkRequestBody {
  * The response for linking an OAuth account.
  */
 export interface OAuthLinkResponseBody extends UsersAPI.User {
-  oauth_tokens?: OAuthLinkResponseBody.OAuthTokens;
-}
-
-export namespace OAuthLinkResponseBody {
-  export interface OAuthTokens {
-    access_token: string;
-
-    provider: string;
-
-    access_token_expires_in_seconds?: number;
-
-    refresh_token?: string;
-
-    refresh_token_expires_in_seconds?: number;
-
-    scopes?: Array<string>;
-  }
+  /**
+   * OAuth tokens associated with the user.
+   */
+  oauth_tokens?: UsersAPI.OAuthTokens;
 }
 
 /**
@@ -884,7 +871,7 @@ export namespace PasskeyRegisterRequestBody {
 export interface PasskeyUnlinkRequestBody {
   credential_id: string;
 
-  remove_as_mfa: boolean;
+  remove_as_mfa?: boolean;
 }
 
 /**
@@ -985,17 +972,17 @@ export interface PasswordlessUpdateRequestBody {
  * The request body for authenticating a SIWE ceremony.
  */
 export interface SiweAuthenticateRequestBody {
-  chainId: string | null;
-
-  connectorType: string | null;
-
   message: string;
 
   signature: string;
 
-  walletClientType: string | null;
+  chainId?: string | null;
+
+  connectorType?: string | null;
 
   mode?: 'no-signup' | 'login-or-sign-up';
+
+  walletClientType?: string | null;
 }
 
 /**
@@ -1020,15 +1007,15 @@ export interface SiweInitResponseBody {
  * The request body for linking a SIWE ceremony.
  */
 export interface SiweLinkRequestBody {
-  chainId: string | null;
-
-  connectorType: string | null;
-
   message: string;
 
   signature: string;
 
-  walletClientType: string | null;
+  chainId?: string | null;
+
+  connectorType?: string | null;
+
+  walletClientType?: string | null;
 }
 
 /**
@@ -1055,17 +1042,17 @@ export interface SiweUnlinkRequestBody {
  * The request body for authenticating a SIWS ceremony.
  */
 export interface SiwsAuthenticateRequestBody {
-  connectorType: string | null;
-
   message: string;
 
   signature: string;
 
-  walletClientType: string | null;
+  connectorType?: string | null;
 
   message_type?: 'transaction' | 'plain';
 
   mode?: 'no-signup' | 'login-or-sign-up';
+
+  walletClientType?: string | null;
 }
 
 /**
@@ -1090,15 +1077,15 @@ export interface SiwsInitResponseBody {
  * The request body for linking a SIWS ceremony.
  */
 export interface SiwsLinkRequestBody {
-  connectorType: string | null;
-
   message: string;
 
   signature: string;
 
-  walletClientType: string | null;
+  connectorType?: string | null;
 
   message_type?: 'transaction' | 'plain';
+
+  walletClientType?: string | null;
 }
 
 /**