@privy-io/api-types 0.3.4 → 0.5.0

package/src/resources/policies.ts

@@ -1,6 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
+import * as PoliciesAPI from './policies';
+import * as WalletsAPI from './wallets/wallets';
 import { APIPromise } from '../core/api-promise';
 import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
@@ -253,6 +255,84 @@ export class Policies extends APIResource {
   }
 }
 
+/**
+ * Operator to use for SUI transaction command conditions. Only 'eq' and 'in' are
+ * supported for command names.
+ */
+export type SuiTransactionCommandOperator = 'eq' | 'in';
+
+/**
+ * Supported fields for SUI TransferObjects command conditions. Only 'recipient'
+ * and 'amount' are supported.
+ */
+export type SuiTransferObjectsCommandField = 'recipient' | 'amount';
+
+/**
+ * TRON transaction fields for TransferContract and TriggerSmartContract
+ * transaction types.
+ */
+export interface TronTransactionCondition {
+  /**
+   * Supported TRON transaction fields in format "TransactionType.field_name"
+   */
+  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>;
+}
+
+/**
+ * SUI transaction command attributes, enables allowlisting specific command types.
+ * Allowed commands: 'TransferObjects', 'SplitCoins', 'MergeCoins'. Only 'eq' and
+ * 'in' operators are supported.
+ */
+export interface SuiTransactionCommandCondition {
+  field: 'commandName';
+
+  field_source: 'sui_transaction_command';
+
+  /**
+   * Operator to use for SUI transaction command conditions. Only 'eq' and 'in' are
+   * supported for command names.
+   */
+  operator: SuiTransactionCommandOperator;
+
+  /**
+   * Command name(s) to match. Must be one of: 'TransferObjects', 'SplitCoins',
+   * 'MergeCoins'
+   */
+  value: WalletsAPI.SuiCommandName | Array<WalletsAPI.SuiCommandName>;
+}
+
+/**
+ * SUI TransferObjects command attributes, including recipient and amount fields.
+ */
+export interface SuiTransferObjectsCommandCondition {
+  /**
+   * Supported fields for SUI TransferObjects command conditions. Only 'recipient'
+   * and 'amount' are supported.
+   */
+  field: SuiTransferObjectsCommandField;
+
+  field_source: 'sui_transfer_objects_command';
+
+  operator: 'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'in_condition_set';
+
+  value: string | Array<string>;
+}
+
+/**
+ * A policy for controlling wallet operations.
+ */
 export interface Policy {
   /**
    * Unique ID of the created policy. This will be the primary identifier when using
@@ -263,7 +343,7 @@ export interface Policy {
   /**
    * The chain type the policy applies to.
    */
-  chain_type: 'ethereum' | 'solana' | 'tron';
+  chain_type: 'ethereum' | 'solana' | 'tron' | 'sui';
 
   /**
    * Unix timestamp of when the policy was created in milliseconds.
@@ -311,7 +391,9 @@ export namespace Policy {
       | Rule.SolanaSystemProgramInstructionCondition
       | Rule.SolanaTokenProgramInstructionCondition
       | Rule.SystemCondition
-      | Rule.TronTransactionCondition
+      | PoliciesAPI.TronTransactionCondition
+      | PoliciesAPI.SuiTransactionCommandCondition
+      | PoliciesAPI.SuiTransferObjectsCommandCondition
     >;
 
     /**
@@ -338,7 +420,7 @@ export namespace Policy {
      * eth_sendTransaction request.
      */
     export interface EthereumTransactionCondition {
-      field: 'to' | 'value';
+      field: 'to' | 'value' | 'chain_id';
 
       field_source: 'ethereum_transaction';
 
@@ -481,29 +563,6 @@ export namespace Policy {
 
       value: string | Array<string>;
     }
-
-    /**
-     * TRON transaction fields for TransferContract and TriggerSmartContract
-     * transaction types.
-     */
-    export interface TronTransactionCondition {
-      /**
-       * Supported TRON transaction fields in format "TransactionType.field_name"
-       */
-      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>;
-    }
   }
 }
 
@@ -529,7 +588,9 @@ export interface PolicyCreateRuleResponse {
     | PolicyCreateRuleResponse.SolanaSystemProgramInstructionCondition
     | PolicyCreateRuleResponse.SolanaTokenProgramInstructionCondition
     | PolicyCreateRuleResponse.SystemCondition
-    | PolicyCreateRuleResponse.TronTransactionCondition
+    | TronTransactionCondition
+    | SuiTransactionCommandCondition
+    | SuiTransferObjectsCommandCondition
   >;
 
   /**
@@ -556,7 +617,7 @@ export namespace PolicyCreateRuleResponse {
    * eth_sendTransaction request.
    */
   export interface EthereumTransactionCondition {
-    field: 'to' | 'value';
+    field: 'to' | 'value' | 'chain_id';
 
     field_source: 'ethereum_transaction';
 
@@ -699,29 +760,6 @@ export namespace PolicyCreateRuleResponse {
 
     value: string | Array<string>;
   }
-
-  /**
-   * TRON transaction fields for TransferContract and TriggerSmartContract
-   * transaction types.
-   */
-  export interface TronTransactionCondition {
-    /**
-     * Supported TRON transaction fields in format "TransactionType.field_name"
-     */
-    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 PolicyDeleteResponse {
@@ -756,7 +794,9 @@ export interface PolicyUpdateRuleResponse {
     | PolicyUpdateRuleResponse.SolanaSystemProgramInstructionCondition
     | PolicyUpdateRuleResponse.SolanaTokenProgramInstructionCondition
     | PolicyUpdateRuleResponse.SystemCondition
-    | PolicyUpdateRuleResponse.TronTransactionCondition
+    | TronTransactionCondition
+    | SuiTransactionCommandCondition
+    | SuiTransferObjectsCommandCondition
   >;
 
   /**
@@ -783,7 +823,7 @@ export namespace PolicyUpdateRuleResponse {
    * eth_sendTransaction request.
    */
   export interface EthereumTransactionCondition {
-    field: 'to' | 'value';
+    field: 'to' | 'value' | 'chain_id';
 
     field_source: 'ethereum_transaction';
 
@@ -926,29 +966,6 @@ export namespace PolicyUpdateRuleResponse {
 
     value: string | Array<string>;
   }
-
-  /**
-   * TRON transaction fields for TransferContract and TriggerSmartContract
-   * transaction types.
-   */
-  export interface TronTransactionCondition {
-    /**
-     * Supported TRON transaction fields in format "TransactionType.field_name"
-     */
-    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>;
-  }
 }
 
 /**
@@ -973,7 +990,9 @@ export interface PolicyGetRuleResponse {
     | PolicyGetRuleResponse.SolanaSystemProgramInstructionCondition
     | PolicyGetRuleResponse.SolanaTokenProgramInstructionCondition
     | PolicyGetRuleResponse.SystemCondition
-    | PolicyGetRuleResponse.TronTransactionCondition
+    | TronTransactionCondition
+    | SuiTransactionCommandCondition
+    | SuiTransferObjectsCommandCondition
   >;
 
   /**
@@ -1000,7 +1019,7 @@ export namespace PolicyGetRuleResponse {
    * eth_sendTransaction request.
    */
   export interface EthereumTransactionCondition {
-    field: 'to' | 'value';
+    field: 'to' | 'value' | 'chain_id';
 
     field_source: 'ethereum_transaction';
 
@@ -1143,36 +1162,13 @@ export namespace PolicyGetRuleResponse {
 
     value: string | Array<string>;
   }
-
-  /**
-   * TRON transaction fields for TransferContract and TriggerSmartContract
-   * transaction types.
-   */
-  export interface TronTransactionCondition {
-    /**
-     * Supported TRON transaction fields in format "TransactionType.field_name"
-     */
-    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 PolicyCreateParams {
   /**
    * Body param: The chain type the policy applies to.
    */
-  chain_type: 'ethereum' | 'solana' | 'tron';
+  chain_type: 'ethereum' | 'solana' | 'tron' | 'sui';
 
   /**
    * Body param: Name to assign to policy.
@@ -1180,7 +1176,7 @@ export interface PolicyCreateParams {
   name: string;
 
   /**
-   * Body param:
+   * Body param
    */
   rules: Array<PolicyCreateParams.Rule>;
 
@@ -1197,8 +1193,7 @@ export interface PolicyCreateParams {
   owner?: PolicyCreateParams.PublicKeyOwner | PolicyCreateParams.UserOwner | null;
 
   /**
-   * Body param: The key quorum ID to set as the owner of the resource. If you
-   * provide this, do not specify an owner.
+   * Body param
    */
   owner_id?: string | null;
 
@@ -1229,7 +1224,9 @@ export namespace PolicyCreateParams {
       | Rule.SolanaSystemProgramInstructionCondition
       | Rule.SolanaTokenProgramInstructionCondition
       | Rule.SystemCondition
-      | Rule.TronTransactionCondition
+      | PoliciesAPI.TronTransactionCondition
+      | PoliciesAPI.SuiTransactionCommandCondition
+      | PoliciesAPI.SuiTransferObjectsCommandCondition
     >;
 
     /**
@@ -1256,7 +1253,7 @@ export namespace PolicyCreateParams {
      * eth_sendTransaction request.
      */
     export interface EthereumTransactionCondition {
-      field: 'to' | 'value';
+      field: 'to' | 'value' | 'chain_id';
 
       field_source: 'ethereum_transaction';
 
@@ -1399,29 +1396,6 @@ export namespace PolicyCreateParams {
 
       value: string | Array<string>;
     }
-
-    /**
-     * TRON transaction fields for TransferContract and TriggerSmartContract
-     * transaction types.
-     */
-    export interface TronTransactionCondition {
-      /**
-       * Supported TRON transaction fields in format "TransactionType.field_name"
-       */
-      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>;
-    }
   }
 
   /**
@@ -1450,7 +1424,7 @@ export interface PolicyCreateRuleParams {
   action: 'ALLOW' | 'DENY';
 
   /**
-   * Body param:
+   * Body param
    */
   conditions: Array<
     | PolicyCreateRuleParams.EthereumTransactionCondition
@@ -1462,7 +1436,9 @@ export interface PolicyCreateRuleParams {
     | PolicyCreateRuleParams.SolanaSystemProgramInstructionCondition
     | PolicyCreateRuleParams.SolanaTokenProgramInstructionCondition
     | PolicyCreateRuleParams.SystemCondition
-    | PolicyCreateRuleParams.TronTransactionCondition
+    | TronTransactionCondition
+    | SuiTransactionCommandCondition
+    | SuiTransferObjectsCommandCondition
   >;
 
   /**
@@ -1481,7 +1457,7 @@ export interface PolicyCreateRuleParams {
     | '*';
 
   /**
-   * Body param:
+   * Body param
    */
   name: string;
 
@@ -1498,7 +1474,7 @@ export namespace PolicyCreateRuleParams {
    * eth_sendTransaction request.
    */
   export interface EthereumTransactionCondition {
-    field: 'to' | 'value';
+    field: 'to' | 'value' | 'chain_id';
 
     field_source: 'ethereum_transaction';
 
@@ -1641,29 +1617,6 @@ export namespace PolicyCreateRuleParams {
 
     value: string | Array<string>;
   }
-
-  /**
-   * TRON transaction fields for TransferContract and TriggerSmartContract
-   * transaction types.
-   */
-  export interface TronTransactionCondition {
-    /**
-     * Supported TRON transaction fields in format "TransactionType.field_name"
-     */
-    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 PolicyDeleteParams {
@@ -1676,7 +1629,7 @@ export interface PolicyDeleteParams {
 
 export interface PolicyDeleteRuleParams {
   /**
-   * Path param:
+   * Path param
    */
   policy_id: string;
 
@@ -1701,13 +1654,12 @@ export interface PolicyUpdateParams {
   owner?: PolicyUpdateParams.PublicKeyOwner | PolicyUpdateParams.UserOwner | null;
 
   /**
-   * Body param: The key quorum ID to set as the owner of the resource. If you
-   * provide this, do not specify an owner.
+   * Body param
    */
   owner_id?: string | null;
 
   /**
-   * Body param:
+   * Body param
    */
   rules?: Array<PolicyUpdateParams.Rule>;
 
@@ -1756,7 +1708,9 @@ export namespace PolicyUpdateParams {
       | Rule.SolanaSystemProgramInstructionCondition
       | Rule.SolanaTokenProgramInstructionCondition
       | Rule.SystemCondition
-      | Rule.TronTransactionCondition
+      | PoliciesAPI.TronTransactionCondition
+      | PoliciesAPI.SuiTransactionCommandCondition
+      | PoliciesAPI.SuiTransferObjectsCommandCondition
     >;
 
     /**
@@ -1783,7 +1737,7 @@ export namespace PolicyUpdateParams {
      * eth_sendTransaction request.
      */
     export interface EthereumTransactionCondition {
-      field: 'to' | 'value';
+      field: 'to' | 'value' | 'chain_id';
 
       field_source: 'ethereum_transaction';
 
@@ -1926,35 +1880,12 @@ export namespace PolicyUpdateParams {
 
       value: string | Array<string>;
     }
-
-    /**
-     * TRON transaction fields for TransferContract and TriggerSmartContract
-     * transaction types.
-     */
-    export interface TronTransactionCondition {
-      /**
-       * Supported TRON transaction fields in format "TransactionType.field_name"
-       */
-      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 PolicyUpdateRuleParams {
   /**
-   * Path param:
+   * Path param
    */
   policy_id: string;
 
@@ -1964,7 +1895,7 @@ export interface PolicyUpdateRuleParams {
   action: 'ALLOW' | 'DENY';
 
   /**
-   * Body param:
+   * Body param
    */
   conditions: Array<
     | PolicyUpdateRuleParams.EthereumTransactionCondition
@@ -1976,7 +1907,9 @@ export interface PolicyUpdateRuleParams {
     | PolicyUpdateRuleParams.SolanaSystemProgramInstructionCondition
     | PolicyUpdateRuleParams.SolanaTokenProgramInstructionCondition
     | PolicyUpdateRuleParams.SystemCondition
-    | PolicyUpdateRuleParams.TronTransactionCondition
+    | TronTransactionCondition
+    | SuiTransactionCommandCondition
+    | SuiTransferObjectsCommandCondition
   >;
 
   /**
@@ -1995,7 +1928,7 @@ export interface PolicyUpdateRuleParams {
     | '*';
 
   /**
-   * Body param:
+   * Body param
    */
   name: string;
 
@@ -2012,7 +1945,7 @@ export namespace PolicyUpdateRuleParams {
    * eth_sendTransaction request.
    */
   export interface EthereumTransactionCondition {
-    field: 'to' | 'value';
+    field: 'to' | 'value' | 'chain_id';
 
     field_source: 'ethereum_transaction';
 
@@ -2155,29 +2088,6 @@ export namespace PolicyUpdateRuleParams {
 
     value: string | Array<string>;
   }
-
-  /**
-   * TRON transaction fields for TransferContract and TriggerSmartContract
-   * transaction types.
-   */
-  export interface TronTransactionCondition {
-    /**
-     * Supported TRON transaction fields in format "TransactionType.field_name"
-     */
-    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 PolicyGetRuleParams {
@@ -2186,6 +2096,11 @@ export interface PolicyGetRuleParams {
 
 export declare namespace Policies {
   export {
+    type SuiTransactionCommandOperator as SuiTransactionCommandOperator,
+    type SuiTransferObjectsCommandField as SuiTransferObjectsCommandField,
+    type TronTransactionCondition as TronTransactionCondition,
+    type SuiTransactionCommandCondition as SuiTransactionCommandCondition,
+    type SuiTransferObjectsCommandCondition as SuiTransferObjectsCommandCondition,
     type Policy as Policy,
     type PolicyCreateRuleResponse as PolicyCreateRuleResponse,
     type PolicyDeleteResponse as PolicyDeleteResponse,