ArchAstro. V1. Users. Threads
(archastro v0.2.0)
Copy Markdown
UserThread API resource.
Summary
Functions
@spec create( ArchAstro.Client.t(), String.t(), ArchAstro.Types.Operations.PostApiV1UsersUserThreads.Input.t() ) :: {:ok, ArchAstro.Types.Thread.t()} | {:error, ArchAstro.Error.reason()}
Create a thread for a user
Creates a new thread owned by the specified user. The authenticated caller must have access to the target user's account; a 403 is returned otherwise.
An automatic welcome message is sent into the thread upon creation unless
skip_welcome_message is set to true. The thread is immediately visible to
the owning user and any members added at creation time.
The newly created thread object.
@spec list( ArchAstro.Client.t(), String.t(), ArchAstro.Types.Operations.GetApiV1UsersUserThreads.Params.t() ) :: {:ok, ArchAstro.Types.Operations.GetApiV1UsersUserThreads.Response.t()} | {:error, ArchAstro.Error.reason()}
List threads for a user
Returns all threads visible to the specified user. The authenticated caller must have access to the target user's account; a 403 is returned otherwise.
Pass one or more agent IDs to narrow results to threads where at least one of
the listed agents is also a member — useful for displaying every thread a user
shares with a particular agent. Pass one or more filter objects to narrow
results by thread metadata key/value pairs. Both narrowings may be combined in
a single request.
Results are returned as a flat array; no cursor-based pagination is applied.
Threads are ordered with default threads first, then by most recent activity
(newest first), each carrying a last_activity timestamp.
Successful response