Tools hooks

@aeontel-generated by packages/react/scripts/gen.ts DO NOT EDIT BY HAND. Run `pnpm gen` to regenerate. Source: packages/shared/src/manifest/tool.ts

Hooks

useCreateTool mutation

Create a tool.

TypeScript
useCreateTool(options?: MutationOpts<Tool, CreateToolParams>)

Types: Tool · CreateToolParams

useDeleteTool mutation

Soft-delete a tool.

TypeScript
useDeleteTool(options?: MutationOpts<SuccessResponse, string>)

Types: SuccessResponse

useListTools query

List tools.

TypeScript
useListTools(params?: Omit<ListToolsParams, | > & { filter?: ToolFilter; orderBy?: ToolOrderBy[]; } & ToolShorthands, options?: QueryOpts<Page<Tool>>)

Types: ListToolsParams · ToolFilter · ToolOrderBy · ToolShorthands · Page · Tool

usePurgeTool composite

Permanently delete a soft-deleted tool.

TypeScript
usePurgeTool(options?: MutationOpts<SuccessResponse, PurgeToolParams>)

Types: SuccessResponse · PurgeToolParams

useRestoreTool composite

Restore a soft-deleted tool.

TypeScript
useRestoreTool(options?: MutationOpts<Tool, string>)

Types: Tool

useRetrieveTool query

Get a tool by ID.

TypeScript
useRetrieveTool(id: string, options?: QueryOpts<Tool>)

Types: Tool

useUpdateTool mutation

Update a tool.

TypeScript
useUpdateTool(options?: MutationOpts<Tool, UpdateToolParams>)

Types: Tool · UpdateToolParams