@avaprotocol/sdk-js 1.3.4 → 1.3.5-dev.2

package/dist/index.d.mts

@@ -1723,16 +1723,12 @@ type SmartWallet = SmartWallet$1.AsObject & {
 declare const ExecutionStatus: typeof ExecutionStatus$1;
 interface ListSecretResponse {
     name: string;
-    workflowId: string;
-    orgId: string;
-}
-interface ListSecretRequest {
     workflowId?: string;
+    orgId?: string;
 }
-interface DeleteSecretRequest {
-    name: string;
-    workflowId: string;
-    orgId: string;
+interface SecretRequestOptions extends RequestOptions {
+    workflowId?: string;
+    orgId?: string;
 }
 
 type TriggerData = FixedTimeCondition.AsObject | CronCondition.AsObject | BlockCondition.AsObject | EventCondition.AsObject | null;
@@ -2009,16 +2005,6 @@ declare class TriggerFactory {
     static fromResponse(raw: TaskTrigger): Trigger;
 }
 
-type SecretProps = CreateOrUpdateSecretReq.AsObject;
-declare class Secret implements SecretProps {
-    name: string;
-    secret: string;
-    workflowId: string;
-    orgId: string;
-    constructor(props: SecretProps);
-    toRequest(): CreateOrUpdateSecretReq;
-}
-
 declare class BaseClient {
     readonly endpoint: string;
     readonly rpcClient: AggregatorClient;
@@ -2033,7 +2019,7 @@ declare class BaseClient {
      */
     isAuthKeyValid(key: string): boolean;
     /**
-     * The API key could retrieve a wallet’s authKey by skipping its signature verification
+     * The API key could retrieve a wallet's authKey by skipping its signature verification
      * @param chainId - The chain id
      * @param address - The address of the EOA wallet
      * @param issuedAt - The issued at timestamp
@@ -2059,7 +2045,7 @@ declare class BaseClient {
      */
     setAuthKey(authKey: string | undefined): void;
     /**
-     * Get the auth key if it’s set in the client
+     * Get the auth key if it's set in the client
      * @returns {string | undefined} - The auth key
      */
     getAuthKey(): string | undefined;
@@ -2069,7 +2055,7 @@ declare class BaseClient {
      */
     setFactoryAddress(address: string): void;
     /**
-     * Get the factory address if it’s set in the client
+     * Get the factory address if it's set in the client
      * @returns {string | undefined} - The factory address
      */
     getFactoryAddress(): string | undefined;
@@ -2186,10 +2172,30 @@ declare class Client extends BaseClient {
      * @returns {Promise<boolean>} - Whether the workflow was successfully deleted
      */
     deleteWorkflow(id: string, options?: RequestOptions): Promise<boolean>;
-    createSecret(secret: Secret, options?: RequestOptions): Promise<boolean>;
-    listSecrets(params: ListSecretRequest, options?: RequestOptions): Promise<ListSecretResponse[]>;
-    deleteSecret(params: DeleteSecretRequest, options?: RequestOptions): Promise<boolean>;
-    updateSecret(secret: Secret, options?: RequestOptions): Promise<boolean>;
+    createSecret(name: string, value: string, options?: SecretRequestOptions): Promise<boolean>;
+    /**
+     * Update an existing secret; the secret is updated in the user scope by default, derived from the auth key.
+     * @param secret - The secret object containing updated information
+     * @param options - Request options, including workflowId and orgId for scoping
+     * @returns {Promise<boolean>} - Whether the secret was successfully updated
+     */
+    updateSecret(name: string, value: string, options?: SecretRequestOptions): Promise<boolean>;
+    /**
+     * Retrieve a list of secrets; secrets can be filtered by workflowId or orgId.
+     * @param params - Parameters for listing secrets
+     * @param options - Request options, including workflowId and orgId for filtering
+     * @returns {Promise<ListSecretResponse[]>} - The list of secrets
+     */
+    listSecrets(options?: SecretRequestOptions): Promise<ListSecretResponse[]>;
+    /**
+     * Delete a secret by its name; by default, the secret is deleted from the user scope, derived from the auth key
+     * @param name - The name of the secret
+     * @param options - Request options
+     * @param options.workflowId - The workflow id; if specified, the secret will be deleted from the workflow scope
+     * @param options.orgId - The organization id; if specified, the secret will be deleted from the organization scope
+     * @returns {Promise<boolean>} - Whether the secret was successfully deleted
+     */
+    deleteSecret(name: string, options?: SecretRequestOptions): Promise<boolean>;
 }
 
-export { AUTH_KEY_HEADER, BlockTrigger, type BlockTriggerDataType, type BlockTriggerProps, BranchNode, type BranchNodeData, type BranchNodeProps, type ClientOption, ContractReadNode, type ContractReadNodeData, type ContractReadNodeProps, ContractWriteNode, type ContractWriteNodeData, type ContractWriteNodeProps, CronTrigger, type CronTriggerDataType, type CronTriggerProps, CustomCodeLangs, CustomCodeNode, type CustomCodeNodeData, type CustomCodeNodeProps, DEFAULT_LIMIT, type DeleteSecretRequest, ETHTransferNode, type ETHTransferNodeData, type ETHTransferNodeProps, Edge, type EdgeProps, type Environment, EventTrigger, type EventTriggerDataType, type EventTriggerProps, Execution, ExecutionStatus, FilterNode, type FilterNodeData, type FilterNodeProps, FixedTimeTrigger, type FixedTimeTriggerDataType, type FixedTimeTriggerProps, type GetExecutionsRequest, type GetWalletRequest, type GetWorkflowsRequest, GraphQLQueryNode, type GraphQLQueryNodeData, type GraphQLQueryNodeProps, type ListSecretRequest, type ListSecretResponse, Node, NodeFactory, type NodeProps, type RequestOptions, RestAPINode, type RestAPINodeData, type RestAPINodeProps, Secret, type SmartWallet, Trigger, TriggerFactory, type TriggerProps, TriggerType, Workflow, type WorkflowProps, WorkflowStatus, Client as default };
+export { AUTH_KEY_HEADER, BlockTrigger, type BlockTriggerDataType, type BlockTriggerProps, BranchNode, type BranchNodeData, type BranchNodeProps, type ClientOption, ContractReadNode, type ContractReadNodeData, type ContractReadNodeProps, ContractWriteNode, type ContractWriteNodeData, type ContractWriteNodeProps, CronTrigger, type CronTriggerDataType, type CronTriggerProps, CustomCodeLangs, CustomCodeNode, type CustomCodeNodeData, type CustomCodeNodeProps, DEFAULT_LIMIT, ETHTransferNode, type ETHTransferNodeData, type ETHTransferNodeProps, Edge, type EdgeProps, type Environment, EventTrigger, type EventTriggerDataType, type EventTriggerProps, Execution, type ExecutionProps, ExecutionStatus, FilterNode, type FilterNodeData, type FilterNodeProps, FixedTimeTrigger, type FixedTimeTriggerDataType, type FixedTimeTriggerProps, type GetExecutionsRequest, type GetWalletRequest, type GetWorkflowsRequest, GraphQLQueryNode, type GraphQLQueryNodeData, type GraphQLQueryNodeProps, type ListSecretResponse, Node, NodeFactory, type NodeProps, type RequestOptions, RestAPINode, type RestAPINodeData, type RestAPINodeProps, type SecretRequestOptions, type SmartWallet, Step, type StepProps, Trigger, TriggerFactory, type TriggerProps, TriggerType, Workflow, type WorkflowProps, WorkflowStatus, Client as default };

package/dist/index.d.ts

@@ -1723,16 +1723,12 @@ type SmartWallet = SmartWallet$1.AsObject & {
 declare const ExecutionStatus: typeof ExecutionStatus$1;
 interface ListSecretResponse {
     name: string;
-    workflowId: string;
-    orgId: string;
-}
-interface ListSecretRequest {
     workflowId?: string;
+    orgId?: string;
 }
-interface DeleteSecretRequest {
-    name: string;
-    workflowId: string;
-    orgId: string;
+interface SecretRequestOptions extends RequestOptions {
+    workflowId?: string;
+    orgId?: string;
 }
 
 type TriggerData = FixedTimeCondition.AsObject | CronCondition.AsObject | BlockCondition.AsObject | EventCondition.AsObject | null;
@@ -2009,16 +2005,6 @@ declare class TriggerFactory {
     static fromResponse(raw: TaskTrigger): Trigger;
 }
 
-type SecretProps = CreateOrUpdateSecretReq.AsObject;
-declare class Secret implements SecretProps {
-    name: string;
-    secret: string;
-    workflowId: string;
-    orgId: string;
-    constructor(props: SecretProps);
-    toRequest(): CreateOrUpdateSecretReq;
-}
-
 declare class BaseClient {
     readonly endpoint: string;
     readonly rpcClient: AggregatorClient;
@@ -2033,7 +2019,7 @@ declare class BaseClient {
      */
     isAuthKeyValid(key: string): boolean;
     /**
-     * The API key could retrieve a wallet’s authKey by skipping its signature verification
+     * The API key could retrieve a wallet's authKey by skipping its signature verification
      * @param chainId - The chain id
      * @param address - The address of the EOA wallet
      * @param issuedAt - The issued at timestamp
@@ -2059,7 +2045,7 @@ declare class BaseClient {
      */
     setAuthKey(authKey: string | undefined): void;
     /**
-     * Get the auth key if it’s set in the client
+     * Get the auth key if it's set in the client
      * @returns {string | undefined} - The auth key
      */
     getAuthKey(): string | undefined;
@@ -2069,7 +2055,7 @@ declare class BaseClient {
      */
     setFactoryAddress(address: string): void;
     /**
-     * Get the factory address if it’s set in the client
+     * Get the factory address if it's set in the client
      * @returns {string | undefined} - The factory address
      */
     getFactoryAddress(): string | undefined;
@@ -2186,10 +2172,30 @@ declare class Client extends BaseClient {
      * @returns {Promise<boolean>} - Whether the workflow was successfully deleted
      */
     deleteWorkflow(id: string, options?: RequestOptions): Promise<boolean>;
-    createSecret(secret: Secret, options?: RequestOptions): Promise<boolean>;
-    listSecrets(params: ListSecretRequest, options?: RequestOptions): Promise<ListSecretResponse[]>;
-    deleteSecret(params: DeleteSecretRequest, options?: RequestOptions): Promise<boolean>;
-    updateSecret(secret: Secret, options?: RequestOptions): Promise<boolean>;
+    createSecret(name: string, value: string, options?: SecretRequestOptions): Promise<boolean>;
+    /**
+     * Update an existing secret; the secret is updated in the user scope by default, derived from the auth key.
+     * @param secret - The secret object containing updated information
+     * @param options - Request options, including workflowId and orgId for scoping
+     * @returns {Promise<boolean>} - Whether the secret was successfully updated
+     */
+    updateSecret(name: string, value: string, options?: SecretRequestOptions): Promise<boolean>;
+    /**
+     * Retrieve a list of secrets; secrets can be filtered by workflowId or orgId.
+     * @param params - Parameters for listing secrets
+     * @param options - Request options, including workflowId and orgId for filtering
+     * @returns {Promise<ListSecretResponse[]>} - The list of secrets
+     */
+    listSecrets(options?: SecretRequestOptions): Promise<ListSecretResponse[]>;
+    /**
+     * Delete a secret by its name; by default, the secret is deleted from the user scope, derived from the auth key
+     * @param name - The name of the secret
+     * @param options - Request options
+     * @param options.workflowId - The workflow id; if specified, the secret will be deleted from the workflow scope
+     * @param options.orgId - The organization id; if specified, the secret will be deleted from the organization scope
+     * @returns {Promise<boolean>} - Whether the secret was successfully deleted
+     */
+    deleteSecret(name: string, options?: SecretRequestOptions): Promise<boolean>;
 }
 
-export { AUTH_KEY_HEADER, BlockTrigger, type BlockTriggerDataType, type BlockTriggerProps, BranchNode, type BranchNodeData, type BranchNodeProps, type ClientOption, ContractReadNode, type ContractReadNodeData, type ContractReadNodeProps, ContractWriteNode, type ContractWriteNodeData, type ContractWriteNodeProps, CronTrigger, type CronTriggerDataType, type CronTriggerProps, CustomCodeLangs, CustomCodeNode, type CustomCodeNodeData, type CustomCodeNodeProps, DEFAULT_LIMIT, type DeleteSecretRequest, ETHTransferNode, type ETHTransferNodeData, type ETHTransferNodeProps, Edge, type EdgeProps, type Environment, EventTrigger, type EventTriggerDataType, type EventTriggerProps, Execution, ExecutionStatus, FilterNode, type FilterNodeData, type FilterNodeProps, FixedTimeTrigger, type FixedTimeTriggerDataType, type FixedTimeTriggerProps, type GetExecutionsRequest, type GetWalletRequest, type GetWorkflowsRequest, GraphQLQueryNode, type GraphQLQueryNodeData, type GraphQLQueryNodeProps, type ListSecretRequest, type ListSecretResponse, Node, NodeFactory, type NodeProps, type RequestOptions, RestAPINode, type RestAPINodeData, type RestAPINodeProps, Secret, type SmartWallet, Trigger, TriggerFactory, type TriggerProps, TriggerType, Workflow, type WorkflowProps, WorkflowStatus, Client as default };
+export { AUTH_KEY_HEADER, BlockTrigger, type BlockTriggerDataType, type BlockTriggerProps, BranchNode, type BranchNodeData, type BranchNodeProps, type ClientOption, ContractReadNode, type ContractReadNodeData, type ContractReadNodeProps, ContractWriteNode, type ContractWriteNodeData, type ContractWriteNodeProps, CronTrigger, type CronTriggerDataType, type CronTriggerProps, CustomCodeLangs, CustomCodeNode, type CustomCodeNodeData, type CustomCodeNodeProps, DEFAULT_LIMIT, ETHTransferNode, type ETHTransferNodeData, type ETHTransferNodeProps, Edge, type EdgeProps, type Environment, EventTrigger, type EventTriggerDataType, type EventTriggerProps, Execution, type ExecutionProps, ExecutionStatus, FilterNode, type FilterNodeData, type FilterNodeProps, FixedTimeTrigger, type FixedTimeTriggerDataType, type FixedTimeTriggerProps, type GetExecutionsRequest, type GetWalletRequest, type GetWorkflowsRequest, GraphQLQueryNode, type GraphQLQueryNodeData, type GraphQLQueryNodeProps, type ListSecretResponse, Node, NodeFactory, type NodeProps, type RequestOptions, RestAPINode, type RestAPINodeData, type RestAPINodeProps, type SecretRequestOptions, type SmartWallet, Step, type StepProps, Trigger, TriggerFactory, type TriggerProps, TriggerType, Workflow, type WorkflowProps, WorkflowStatus, Client as default };