ArchAstro. V1. Users. Tasks
(archastro v0.2.0)
Copy Markdown
UserTask API resource.
Summary
Functions
blocker_cycles(client, user, params \\ %ArchAstro.Types.Operations.GetApiV1UsersUserTasksBlockerCycles.Params{})
@spec blocker_cycles( ArchAstro.Client.t(), String.t(), ArchAstro.Types.Operations.GetApiV1UsersUserTasksBlockerCycles.Params.t() ) :: {:ok, ArchAstro.Types.Operations.GetApiV1UsersUserTasksBlockerCycles.Response.t()} | {:error, ArchAstro.Error.reason()}
List task blocker cycles
Runs an on-demand diagnostic over unfinished tasks owned by the specified team or user and returns a forward cursor-paginated page of complete cyclic blocker components. Detection is bounded to owners with at most 100 unfinished tasks. This endpoint is read-only: cycles do not prevent task updates, lease acquisition, or completion.
Successful response
@spec create( ArchAstro.Client.t(), String.t(), ArchAstro.Types.Operations.PostApiV1UsersUserTasks.Input.t() ) :: {:ok, ArchAstro.Types.Task.t()} | {:error, ArchAstro.Error.reason()}
Create a task for an owner
Creates a new task owned by the specified user or team and returns the full
task object. User-authenticated calls are attributed to the authenticated
user or agent. App-scoped developer and server-to-server callers must provide
the task's explicit org scope and an explicit user or agent actor for
team tasks; a user-owned task reuses the user in the route unless an explicit
agent is supplied. Every referenced principal is validated against the app,
owner, and team membership before creation.
The newly created task.
@spec list( ArchAstro.Client.t(), String.t(), ArchAstro.Types.Operations.GetApiV1UsersUserTasks.Params.t() ) :: {:ok, ArchAstro.Types.Operations.GetApiV1UsersUserTasks.Response.t()} | {:error, ArchAstro.Error.reason()}
List an owner's tasks
Returns tasks owned by the specified user or team. You can narrow results using the
optional filters below. By default results are returned in reverse chronological
order (most recently created first); use sort and order to sort by due date or
priority instead.
User-authenticated callers may list their personal tasks or tasks for teams they
have joined. Privileged callers provide the owner in the route; the owner's
organization is implied by that principal. An explicit org is optional and,
when set, must match the owner's organization.
Successful response
@spec search( ArchAstro.Client.t(), String.t(), ArchAstro.Types.Operations.GetApiV1UsersUserTasksSearch.Params.t() ) :: {:ok, ArchAstro.Types.Operations.GetApiV1UsersUserTasksSearch.Response.t()} | {:error, ArchAstro.Error.reason()}
Search an owner's tasks
Performs a full-text search over tasks owned by the specified user or team and returns
matching results. Combine q with the optional filters to narrow the result set
further. When no query is provided, the endpoint behaves like a filtered list.
The query field in the response echoes the effective search query.
User-authenticated callers may search their personal tasks or tasks for teams
they have joined. Privileged callers provide the owner in the route; the owner's
organization is implied by that principal. An explicit org is optional and,
when set, must match the owner's organization.
Successful response