@bluecopa/react 0.1.79 → 0.1.81

package/README.md

@@ -26,6 +26,7 @@ A React library providing opinionated custom hooks for TanStack React Query inte
     - [`useInputTable(inputTableId, options?)`](#useinputtableinputtableid-options)
     - [`useRows(tableId, options?)`](#userowstableid-options)
     - [`useGetFileUrlByFileId(fileId, options?)`](#usegetfileurlbyfileidfileid-options)
+    - [`useGetFileByFolderIdAndName(folderId, name, options?)`](#usegetfilebyfolderidandnamefolderid-name-options)
     - [`useGetPublishedWorkbookById(workbookId, options?)`](#usegetpublishedworkbookbyidworkbookid-options)
     - [`useGetTableById(tableId, options?)`](#usegettablebyidtableid-options)
     - [`useGetWorkbooksByType(workbookType, options?)`](#usegetworkbooksbytypeworkbooktype-options)
@@ -40,6 +41,7 @@ A React library providing opinionated custom hooks for TanStack React Query inte
     - [`useWorkbook(workbookId, options?)`](#useworkbookworkbookid-options)
     - [`useWorkflow(workflowId, options?)`](#useworkflowworkflowid-options)
     - [`useWorksheet(worksheetId, options?)`](#useworksheetworksheetid-options)
+    - _Plus domain-grouped hooks for Audit, Chat, Email Engine, Files, Forms, Inbox Items, Input Table mutations, Permissions, Process, Recon, Statement, Task, Templated Pipelines, Templates, TCN, Users (extras), Webcron (webhooks/schedules/executions/tasks/inspection), Workbook (mutations), and Workflow (extras) — see sections after `useWorksheet`._
   - [Configuration](#configuration)
     - [Default Query Configuration](#default-query-configuration)
     - [Customizable Parameters](#customizable-parameters)
@@ -263,6 +265,38 @@ function TableRows({ tableId }) {
 
 📖 **For detailed documentation on `useRows` including filtering, pagination, and advanced usage, see [docs/useRows.md](./docs/useRows.md)**
 
+#### `useGetFileByFolderIdAndName` - Look up a filebox file by folder + name
+
+```tsx
+import { useGetFileByFolderIdAndName } from "@bluecopa/react";
+
+function FileBadge({ folderId, fileName }) {
+  const { data, isLoading, error } = useGetFileByFolderIdAndName(
+    folderId,
+    fileName,
+    {
+      staleTime: 60 * 1000, // 1 minute
+      retry: 1,
+    },
+  );
+
+  if (!folderId || !fileName) return <div>Pick a folder and a file.</div>;
+  if (isLoading) return <div>Resolving file…</div>;
+  if (error) return <div>Could not find “{fileName}”: {error.message}</div>;
+  if (!data) return null;
+
+  return (
+    <div>
+      <strong>{data.name}</strong> · {data.type} ·{" "}
+      <code>{data.blobFileId}</code>
+      {data.status === "PUBLISHED" ? " (published)" : " (draft)"}
+    </div>
+  );
+}
+```
+
+The query is auto-disabled until both `folderId` and `name` are truthy, so you can safely pass `null`/`undefined` while the user is still picking inputs.
+
 ## API Documentation
 
 ### `useUser(options?)`
@@ -403,6 +437,23 @@ Fetches the URL for a file by its ID.
 - `error`: Error object if request failed
 - `refetch`: Function to manually trigger refetch
 
+### `useGetFileByFolderIdAndName(folderId, name, options?)`
+
+Fetches a filebox file by its parent folder id and exact name. The query is disabled until both `folderId` and `name` are truthy.
+
+**Parameters:**
+
+- `folderId`: Parent folder id (null/undefined disables the query)
+- `name`: Exact file name to look up (null/undefined disables the query)
+- `options` (optional): Query options extending TanStack React Query's `UseQueryOptions`
+
+**Returns:**
+
+- `data`: `FileboxFile` — file metadata (id, name, type, parentId, blobFileId, status, …)
+- `isLoading`: Boolean indicating loading state
+- `error`: Error object if request failed
+- `refetch`: Function to manually trigger refetch
+
 ### `useGetPublishedWorkbookById(workbookId, options?)`
 
 Fetches published workbook details by ID.
@@ -627,6 +678,1023 @@ Fetches worksheet details by ID.
 - `error`: Error object if request failed
 - `refetch`: Function to manually trigger refetch
 
+> **Mutation hooks** below follow TanStack Query's `useMutation` shape. Their returns include `mutate(variables)` and `mutateAsync(variables)` to trigger the action, `isPending` (loading), `data` (on success), `error`, `isError`, `isSuccess`, and `reset()`. The `options` parameter accepts the standard `UseMutationOptions` (including `onSuccess`, `onError`, `onSettled`, `retry`, etc.).
+
+_— Audit hooks_
+
+### `useCreateAuditLog(options?)`
+
+Records an audit log entry.
+
+**Parameters:**
+
+- `options` (optional): Mutation options. `mutate(request: CreateAuditLogRequest)` triggers the action.
+
+**Returns:** Mutation result with `data: CreateAuditLogResponse`.
+
+### `useGetAuditLogs(options?)`
+
+Fetches audit log entries on demand. Implemented as a mutation so the request payload can be passed at call time.
+
+**Parameters:**
+
+- `options` (optional): Mutation options. `mutate(request: GetAuditLogsRequest)` triggers the fetch.
+
+**Returns:** Mutation result with `data: AuditLogResponse`.
+
+_— Chat hooks_
+
+### `useCreateThread(options?)`
+
+Creates a new chat thread.
+
+**Parameters:**
+
+- `options` (optional): Mutation options including `onSuccess`, `onError`, `retry`, `retryDelay`.
+
+**Returns:** Mutation result with `data: copaApi.chat.CreateThreadResponse`.
+
+### `useGetCommentsByThreadId(threadId, options?)`
+
+Fetches comments for a chat thread. Disabled until `threadId` is set.
+
+**Parameters:**
+
+- `threadId`: Thread id (null/undefined disables the query)
+- `options` (optional): Query options
+
+**Returns:** Query result with `data: copaApi.chat.GetCommentsByThreadIdResponse`.
+
+### `usePostComment(options?)`
+
+Posts a new comment to a thread.
+
+**Parameters:**
+
+- `options` (optional): Mutation options. `mutate(request: PostCommentRequest)` triggers the post.
+
+**Returns:** Mutation result with `data: copaApi.chat.PostCommentResponse`.
+
+### `useUpdateComment(options?)`
+
+Updates an existing comment.
+
+**Parameters:**
+
+- `options` (optional): Mutation options. `mutate(request: UpdateCommentRequest)` triggers the update.
+
+**Returns:** Mutation result with `data: copaApi.chat.UpdateCommentResponse`.
+
+### `useDeleteComment(options?)`
+
+Deletes a comment by id.
+
+**Parameters:**
+
+- `options` (optional): Mutation options. `mutate(commentId: string)` triggers the delete.
+
+**Returns:** Mutation result with `data: copaApi.chat.DeleteCommentResponse`.
+
+### `useSubscribeUser(options?)`
+
+Subscribes a user to chat updates.
+
+**Parameters:**
+
+- `options` (optional): Mutation options. `mutate(request: SubscribeUserRequest)` triggers the action.
+
+**Returns:** Mutation result with `data: copaApi.chat.SubscribeUserResponse`.
+
+### `useUnsubscribeUser(options?)`
+
+Unsubscribes a user from chat updates.
+
+**Parameters:**
+
+- `options` (optional): Mutation options. `mutate(request: UnsubscribeUserRequest)` triggers the action.
+
+**Returns:** Mutation result with `data: copaApi.chat.UnsubscribeUserResponse`.
+
+### `useCheckSubscriptionStatus(userId, threadId, options?)`
+
+Checks whether a user is subscribed to a thread.
+
+**Parameters:**
+
+- `userId`: User id (null/undefined disables the query)
+- `threadId`: Thread id (null/undefined disables the query)
+- `options` (optional): Query options
+
+**Returns:** Query result with `data: copaApi.chat.CheckSubscriptionStatusResponse`.
+
+_— Email Engine hooks_
+
+### `useGetAllConversations(params?, options?)`
+
+Lists email conversations (paginated).
+
+**Parameters:**
+
+- `params` (optional): `GetAllConversationsParams` filters
+- `options` (optional): Query options
+
+**Returns:** Query result with `data: PageChunkEmailConversation`.
+
+### `useGetConversation(conversationId, options?)`
+
+Fetches a single email conversation by id.
+
+**Parameters:**
+
+- `conversationId`: Conversation id (null/undefined disables the query)
+- `options` (optional): Query options
+
+**Returns:** Query result with `data: EmailConversation`.
+
+### `useCreateConversation(options?)`
+
+Creates a new email conversation.
+
+**Parameters:**
+
+- `options` (optional): Mutation options. `mutate(request: CreateConversationRequest)` triggers the create.
+
+**Returns:** Mutation result with `data: EmailConversation`.
+
+### `useReplyToConversation(options?)`
+
+Sends a reply on an email conversation.
+
+**Parameters:**
+
+- `options` (optional): Mutation options. `mutate(request: ReplyToConversationRequest)` triggers the reply.
+
+**Returns:** Mutation result.
+
+### `useFilterMessagesBySenderId(params, options?)`
+
+Fetches messages filtered by sender id.
+
+**Parameters:**
+
+- `params`: `FilterOnSenderId` — sender id and paging
+- `options` (optional): Query options
+
+**Returns:** Query result with `data: PageChunkEmailMessage`.
+
+_— File hooks (mutations & download)_
+
+### `useFileUpload(options?)`
+
+Uploads file data to storage and returns the resulting file id/path.
+
+**Parameters:**
+
+- `options` (optional): Mutation options. `mutate(request: FileUploadRequest)` triggers the upload.
+
+**Returns:** Mutation result with `data: FileUploadResponse`.
+
+### `useFileDownload(params, options?)`
+
+Downloads a file by id. Implemented as a query (auto-fetches when params are valid).
+
+**Parameters:**
+
+- `params`: `{ fileId: string; contentType: string; method: 'GET' | 'PUT' }`
+- `options` (optional): Query options
+
+**Returns:** Query result with the downloaded data.
+
+_— Form hooks_
+
+### `useGetFormById(formId, options?)`
+
+Fetches a form by id.
+
+**Parameters:**
+
+- `formId`: Form id (null/undefined disables the query)
+- `options` (optional): Query options
+
+**Returns:** Query result with the form definition.
+
+### `useGetFormSchema(formInstanceId, formRevision, options?)`
+
+Fetches a form's schema for a given instance + revision.
+
+**Parameters:**
+
+- `formInstanceId`: Form instance id (null/undefined disables the query)
+- `formRevision`: Schema revision (string or number, null/undefined disables the query)
+- `options` (optional): Query options
+
+**Returns:** Query result with the form schema.
+
+### `useGetFormData(formId, options?)`
+
+Fetches submitted form data.
+
+**Parameters:**
+
+- `formId`: Form id (null/undefined disables the query)
+- `options` (optional): Query options
+
+**Returns:** Query result with the form data.
+
+### `useCreateOrUpdateForm(options?)`
+
+Creates or updates a form definition.
+
+**Parameters:**
+
+- `options` (optional): Mutation options. `mutate(request: CreateOrUpdateFormRequest)` triggers the save.
+
+**Returns:** Mutation result.
+
+_— Inbox Items hooks_
+
+### `useGetAllInboxItems(params?, options?)`
+
+Lists inbox items.
+
+**Parameters:**
+
+- `params` (optional): `GetAllInboxItemsRequest` filters
+- `options` (optional): Query options
+
+**Returns:** Query result with the items array.
+
+### `useCreateInboxItemPerUser(options?)`
+
+Creates an inbox item for a specific user.
+
+**Parameters:**
+
+- `options` (optional): Mutation options. `mutate(request)` triggers the create.
+
+**Returns:** Mutation result with the created inbox items.
+
+### `useMarkItemAsRead(options?)`
+
+Marks an inbox item as read.
+
+**Parameters:**
+
+- `options` (optional): Mutation options. `mutate(request: MarkItemAsReadRequest)` triggers the action.
+
+**Returns:** Mutation result.
+
+### `useMarkItemAsUnread(options?)`
+
+Marks an inbox item as unread.
+
+**Parameters:**
+
+- `options` (optional): Mutation options. `mutate(request: MarkItemAsUnreadRequest)` triggers the action.
+
+**Returns:** Mutation result.
+
+_— Input Table mutation hooks_
+
+### `useInsertRow(options?)`
+
+Inserts a new row into an input table.
+
+**Parameters:**
+
+- `options` (optional): Mutation options. `mutate(request: InsertRowRequest)` triggers the insert.
+
+**Returns:** Mutation result.
+
+### `useUpdateRow(options?)`
+
+Updates an existing row in an input table.
+
+**Parameters:**
+
+- `options` (optional): Mutation options. `mutate(request: UpdateRowRequest)` triggers the update.
+
+**Returns:** Mutation result.
+
+### `useDeleteRow(options?)`
+
+Deletes a row by id from an input table.
+
+**Parameters:**
+
+- `options` (optional): Mutation options. `mutate(request: DeleteRowRequest)` triggers the delete.
+
+**Returns:** Mutation result.
+
+_— Permissions hooks_
+
+### `useDocumentPermissions(objectId, objectType, options?)`
+
+Fetches permissions for a given document/object.
+
+**Parameters:**
+
+- `objectId`: Object id (undefined disables the query)
+- `objectType`: Object type (e.g. `Workbook`, `Dashboard`)
+- `options` (optional): Query options
+
+**Returns:** Query result with `data: PermissionsResponse`.
+
+_— Process hooks_
+
+### `useGetTriggersBySheet(sheetId, options?)`
+
+Lists process triggers attached to a sheet.
+
+**Parameters:**
+
+- `sheetId`: Sheet id
+- `options` (optional): TanStack `UseQueryOptions` (omit `queryKey`/`queryFn`/`enabled`)
+
+**Returns:** Query result with `data: ProcessTrigger[]`.
+
+### `useRegisterProcessTrigger(options?)`
+
+Registers a new process trigger.
+
+**Parameters:**
+
+- `options` (optional): Mutation options. `mutate(trigger: ProcessTrigger)` triggers the register.
+
+**Returns:** Mutation result with `data: ProcessTrigger`.
+
+### `useDeleteProcessTrigger(options?)`
+
+Deletes a process trigger by id. Invalidates the corresponding trigger list query.
+
+**Parameters:**
+
+- `options` (optional): Mutation options. `mutate({ id, sheetId? })` triggers the delete.
+
+**Returns:** Mutation result with `data: DeleteProcessTriggerResponse`.
+
+### `useMarkTaskDone(options?)`
+
+Marks a process task as done.
+
+**Parameters:**
+
+- `options` (optional): Mutation options. `mutate(request: MarkTaskDoneRequest)` triggers the action.
+
+**Returns:** Mutation result.
+
+### `useReassignTask(options?)`
+
+Reassigns a process task to a different user.
+
+**Parameters:**
+
+- `options` (optional): Mutation options. `mutate(request: ReassignTaskRequest)` triggers the action.
+
+**Returns:** Mutation result.
+
+_— Recon hooks_
+
+### `useGetAllRecon(options?)`
+
+Lists all recon workflows.
+
+**Parameters:**
+
+- `options` (optional): Query options
+
+**Returns:** Query result with `data: ReconWorkflow[]`.
+
+### `useRunRecon(options?)`
+
+Triggers a recon workflow run.
+
+**Parameters:**
+
+- `options` (optional): Mutation options. `mutate(request: RunReconRequest)` triggers the run.
+
+**Returns:** Mutation result with `data: RunReconResponse`.
+
+_— Statement hooks_
+
+### `useGetStatementData(statementId, viewId?, runId?, options?)`
+
+Fetches statement data for a given statement/view/run.
+
+**Parameters:**
+
+- `statementId`: Statement id (null/undefined disables the query)
+- `viewId` (optional): View id
+- `runId` (optional): Run id
+- `options` (optional): Query options
+
+**Returns:** Query result with the statement data.
+
+### `useGetViewsBySheetId(sheetId, options?)`
+
+Lists statement views for a sheet.
+
+**Parameters:**
+
+- `sheetId`: Sheet id (null/undefined disables the query)
+- `options` (optional): Query options
+
+**Returns:** Query result with the array of views.
+
+### `useGetViewById(viewId, options?)`
+
+Fetches a single statement view by id.
+
+**Parameters:**
+
+- `viewId`: View id (null/undefined disables the query)
+- `options` (optional): Query options
+
+**Returns:** Query result with the view.
+
+### `useGetRunsByViewId(viewId, options?)`
+
+Lists statement runs for a given view.
+
+**Parameters:**
+
+- `viewId`: View id (null/undefined disables the query)
+- `options` (optional): Query options
+
+**Returns:** Query result with the runs array.
+
+### `useGetRunResultById(runId, options?)`
+
+Fetches the result of a statement run.
+
+**Parameters:**
+
+- `runId`: Run id (null/undefined disables the query)
+- `options` (optional): Query options
+
+**Returns:** Query result with the run result.
+
+### `useCreateStatementRun(options?)`
+
+Creates a new statement run.
+
+**Parameters:**
+
+- `options` (optional): Mutation options. `mutate(params: CreateStatementRunParams)` triggers the create.
+
+**Returns:** Mutation result with `data: CreateStatementRunResult`.
+
+_— Task hook_
+
+### `useGetTaskDetails(taskId, options?)`
+
+Fetches detailed information about a task.
+
+**Parameters:**
+
+- `taskId`: Task id (null/undefined disables the query)
+- `options` (optional): Query options
+
+**Returns:** Query result with the task details.
+
+_— Templated Pipeline hooks_
+
+### `useGetAllTemplatedPipelines(options?)`
+
+Lists all templated pipelines.
+
+**Parameters:**
+
+- `options` (optional): Query options
+
+**Returns:** Query result with `data: TemplatedPipelineWorkflow[]`.
+
+_— Template hooks_
+
+### `useRenderTemplate(options?)`
+
+Renders a template with the provided variables.
+
+**Parameters:**
+
+- `options` (optional): Mutation options. `mutate(request: RenderTemplateRequest)` triggers the render.
+
+**Returns:** Mutation result with `data: RenderTemplateResponse`.
+
+_— TCN hooks_
+
+> All TCN mutation hooks take their TCN `token` (and other identifiers) as part of `mutate(variables)`. The `options` parameter is standard `UseMutationOptions`.
+
+### `useTcnAuthUrl(options?)`
+
+Returns the TCN OAuth authorization URL.
+
+**Parameters:**
+
+- `options` (optional): Query options
+
+**Returns:** Query result with `data: { url: string }`.
+
+### `useTcnExchangeCode(options?)`
+
+Exchanges an OAuth code for TCN tokens.
+
+**Parameters:** `mutate({ code })` triggers the exchange.
+
+**Returns:** Mutation result with `data: TcnTokenData`.
+
+### `useTcnRefreshToken(options?)`
+
+Refreshes a TCN access token.
+
+**Parameters:** `mutate({ refresh_token })`.
+
+**Returns:** Mutation result with `data: TcnTokenData`.
+
+### `useTcnCurrentAgent(options?)`
+
+Fetches the currently signed-in TCN agent.
+
+**Parameters:** `mutate({ token })`.
+
+**Returns:** Mutation result with `data: TcnAgentData`.
+
+### `useTcnAgentSkills(options?)`
+
+Lists skills available to the agent in a hunt group.
+
+**Parameters:** `mutate({ token, huntGroupSid })`.
+
+**Returns:** Mutation result with `data: TcnSkillsData`.
+
+### `useTcnCreateSession(options?)`
+
+Creates a new TCN agent session.
+
+**Parameters:** `mutate({ token, huntGroupSid, skills })`.
+
+**Returns:** Mutation result with `data: TcnSessionData`.
+
+### `useTcnKeepAlive(options?)`
+
+Pings the TCN session to keep it alive.
+
+**Parameters:** `mutate({ token, sessionSid })`.
+
+**Returns:** Mutation result.
+
+### `useTcnAgentGetStatus(options?)`
+
+Returns the current agent status.
+
+**Parameters:** `mutate({ token })`.
+
+**Returns:** Mutation result with `data: TcnStatusData`.
+
+### `useTcnAgentSetReady(options?)`
+
+Marks the agent as ready.
+
+**Parameters:** `mutate({ token, sessionSid })`.
+
+**Returns:** Mutation result.
+
+### `useTcnAgentPause(options?)`
+
+Pauses the agent.
+
+**Parameters:** `mutate({ token, sessionSid })`.
+
+**Returns:** Mutation result.
+
+### `useTcnAgentDisconnect(options?)`
+
+Disconnects the agent.
+
+**Parameters:** `mutate({ token, sessionSid, reason? })`.
+
+**Returns:** Mutation result.
+
+### `useTcnConnectedParty(options?)`
+
+Returns the currently connected party for the agent.
+
+**Parameters:** `mutate({ token, sessionSid })`.
+
+**Returns:** Mutation result with `data: TcnConnectedParty`.
+
+### `useTcnAgentPutCallOnHold(options?)`
+
+Puts the agent's current call on hold.
+
+**Parameters:** `mutate({ token, sessionSid, holdType? })`.
+
+**Returns:** Mutation result.
+
+### `useTcnAgentGetCallFromHold(options?)`
+
+Resumes the agent's held call.
+
+**Parameters:** `mutate({ token, sessionSid, holdType? })`.
+
+**Returns:** Mutation result.
+
+### `useTcnHuntGroupSettings(options?)`
+
+Fetches hunt-group settings for the agent.
+
+**Parameters:** `mutate({ token, huntGroupSid })`.
+
+**Returns:** Mutation result with `data: TcnDialSettings`.
+
+### `useTcnCallData(options?)`
+
+Retrieves data for an active call.
+
+**Parameters:** `mutate({ token, callSid })`.
+
+**Returns:** Mutation result with `data: TcnCallData`.
+
+### `useTcnDialManualPrepare(options?)`
+
+Prepares a manual dial.
+
+**Parameters:** `mutate({ token, sessionSid })`.
+
+**Returns:** Mutation result.
+
+### `useTcnManualDialStart(options?)`
+
+Starts a prepared manual dial.
+
+**Parameters:** `mutate({ token, agentSessionSid, huntGroupSid, simpleCallData })`.
+
+**Returns:** Mutation result.
+
+### `useTcnProcessManualDial(options?)`
+
+Processes the result of a manual dial.
+
+**Parameters:** `mutate({ token, call })`.
+
+**Returns:** Mutation result.
+
+_— User hooks (extras)_
+
+### `useGetAllUsers(options?)`
+
+Lists all users in the workspace.
+
+**Parameters:**
+
+- `options` (optional): Query options
+
+**Returns:** Query result with `data: User[]`.
+
+_— Webcron: Webhooks_
+
+### `useListWebhooks(options?)`
+
+Lists all webhooks.
+
+**Parameters:**
+
+- `options` (optional): Query options
+
+**Returns:** Query result with the webhooks array.
+
+### `useGetWebhook(id, options?)`
+
+Fetches a single webhook by id.
+
+**Parameters:**
+
+- `id`: Webhook id
+- `options` (optional): Query options
+
+**Returns:** Query result with the webhook.
+
+### `useCreateWebhook(options?)`
+
+Creates a new webhook. Invalidates the webhooks list query on success.
+
+**Parameters:** `mutate(data)` triggers the create.
+
+**Returns:** Mutation result.
+
+### `useUpdateWebhook(options?)`
+
+Updates an existing webhook.
+
+**Parameters:** `mutate({ id, data })` triggers the update.
+
+**Returns:** Mutation result.
+
+### `useDeleteWebhook(options?)`
+
+Deletes a webhook.
+
+**Parameters:** `mutate(id: string)` triggers the delete.
+
+**Returns:** Mutation result.
+
+### `useTestWebhook(options?)`
+
+Sends a test invocation through a webhook.
+
+**Parameters:** `mutate(id: string)` triggers the test.
+
+**Returns:** Mutation result.
+
+### `useGetWebhookExecutions(id, params?, options?)`
+
+Lists executions for a webhook.
+
+**Parameters:**
+
+- `id`: Webhook id
+- `params` (optional): `{ limit?: number; offset?: number }`
+- `options` (optional): Query options
+
+**Returns:** Query result with executions.
+
+### `useGetWebhookSchedules(id, options?)`
+
+Lists schedules for a webhook.
+
+**Parameters:**
+
+- `id`: Webhook id
+- `options` (optional): Query options
+
+**Returns:** Query result with schedules.
+
+### `useCreateWebhookSchedule(options?)`
+
+Creates a schedule attached to a webhook.
+
+**Parameters:** `mutate({ webhookId, data })` triggers the create.
+
+**Returns:** Mutation result.
+
+_— Webcron: Schedules_
+
+### `useGetSchedule(id, options?)`
+
+Fetches a single schedule by id.
+
+**Parameters:**
+
+- `id`: Schedule id
+- `options` (optional): Query options
+
+**Returns:** Query result with the schedule.
+
+### `useUpdateSchedule(options?)`
+
+Updates an existing schedule.
+
+**Parameters:** `mutate({ id, data })`.
+
+**Returns:** Mutation result.
+
+### `useDeleteSchedule(options?)`
+
+Deletes a schedule.
+
+**Parameters:** `mutate(id: string)`.
+
+**Returns:** Mutation result.
+
+### `usePauseSchedule(options?)`
+
+Pauses a schedule.
+
+**Parameters:** `mutate(id: string)`.
+
+**Returns:** Mutation result.
+
+### `useResumeSchedule(options?)`
+
+Resumes a paused schedule.
+
+**Parameters:** `mutate(id: string)`.
+
+**Returns:** Mutation result.
+
+### `useTriggerSchedule(options?)`
+
+Triggers a schedule immediately.
+
+**Parameters:** `mutate(id: string)`.
+
+**Returns:** Mutation result.
+
+_— Webcron: Executions_
+
+### `useListExecutions(params?, options?)`
+
+Lists webcron executions with optional filtering.
+
+**Parameters:**
+
+- `params` (optional): `{ status?: string; webhookId?: string; limit?: number; offset?: number }`
+- `options` (optional): Query options
+
+**Returns:** Query result with executions.
+
+### `useGetExecution(id, options?)`
+
+Fetches a single execution by id.
+
+**Parameters:**
+
+- `id`: Execution id
+- `options` (optional): Query options
+
+**Returns:** Query result with the execution.
+
+### `useRetryExecution(options?)`
+
+Retries a failed execution.
+
+**Parameters:** `mutate(id: string)`.
+
+**Returns:** Mutation result.
+
+_— Webcron: Tasks_
+
+### `useListTasks(options?)`
+
+Lists webcron tasks.
+
+**Parameters:**
+
+- `options` (optional): Query options
+
+**Returns:** Query result with the tasks array.
+
+### `useCreateTask(options?)`
+
+Creates a new webcron task.
+
+**Parameters:** `mutate(data)`.
+
+**Returns:** Mutation result.
+
+### `useGetTask(id, options?)`
+
+Fetches a single task by id.
+
+**Parameters:**
+
+- `id`: Task id
+- `options` (optional): Query options
+
+**Returns:** Query result with the task.
+
+### `useCancelTask(options?)`
+
+Cancels a task. Invalidates the task and tasks-list queries.
+
+**Parameters:** `mutate(id: string)`.
+
+**Returns:** Mutation result.
+
+### `useRetryTask(options?)`
+
+Retries a task.
+
+**Parameters:** `mutate(id: string)`.
+
+**Returns:** Mutation result.
+
+### `useTaskProgress(options?)`
+
+Reports progress on a running task.
+
+**Parameters:** `mutate({ id, data })`.
+
+**Returns:** Mutation result.
+
+### `useTaskSignal(options?)`
+
+Sends a signal to a running task.
+
+**Parameters:** `mutate({ id, data, branchId? })`.
+
+**Returns:** Mutation result.
+
+_— Webcron: Inspection bins_
+
+### `useListInspectionBins(options?)`
+
+Lists inspection bins.
+
+**Parameters:**
+
+- `options` (optional): Query options
+
+**Returns:** Query result with the bins array.
+
+### `useCreateInspectionBin(options?)`
+
+Creates a new inspection bin.
+
+**Parameters:** `mutate(data)`.
+
+**Returns:** Mutation result.
+
+### `useGetInspectionBin(id, options?)`
+
+Fetches a single inspection bin by id.
+
+**Parameters:**
+
+- `id`: Bin id
+- `options` (optional): Query options
+
+**Returns:** Query result with the bin.
+
+### `useDeleteInspectionBin(options?)`
+
+Deletes an inspection bin.
+
+**Parameters:** `mutate(id: string)`.
+
+**Returns:** Mutation result.
+
+### `useGetBinRequests(id, params?, options?)`
+
+Lists requests captured by an inspection bin.
+
+**Parameters:**
+
+- `id`: Bin id
+- `params` (optional): `{ limit?: number; offset?: number }`
+- `options` (optional): Query options
+
+**Returns:** Query result with the requests.
+
+### `useClearBinRequests(options?)`
+
+Clears all requests stored in an inspection bin.
+
+**Parameters:** `mutate(id: string)`.
+
+**Returns:** Mutation result.
+
+_— Webcron: Workflow trigger_
+
+### `useTriggerWorkflowById(options?)`
+
+Triggers a workflow run via webcron.
+
+**Parameters:** `mutate(params: TriggerWorkflowByIdParams)`.
+
+**Returns:** Mutation result with `data: TriggerWorkflowResponse[]`.
+
+_— Workbook hooks (mutations)_
+
+### `useGetWorkbookDetails(workbookId, options?)`
+
+Fetches workbook metadata/details.
+
+**Parameters:**
+
+- `workbookId`: Workbook id (null/undefined disables the query)
+- `options` (optional): Query options
+
+**Returns:** Query result with the workbook details.
+
+### `useSaveWorkbook(options?)`
+
+Saves a workbook draft.
+
+**Parameters:** `mutate(request: SaveWorkbookRequest)`.
+
+**Returns:** Mutation result.
+
+### `usePublishWorkbook(options?)`
+
+Publishes a workbook.
+
+**Parameters:** `mutate(request: PublishWorkbookRequest)`.
+
+**Returns:** Mutation result.
+
+_— Workflow hooks (extras)_
+
+### `useGetAllHttpTriggers(options?)`
+
+Lists all HTTP triggers.
+
+**Parameters:**
+
+- `options` (optional): Query options
+
+**Returns:** Query result with `data: HttpTrigger[]`.
+
 ## Configuration
 
 ### Default Query Configuration