SDK

openemail.chats

كل دالّة في مساحة الأسماء هذه: توقيعها ومعلماتها وما تُرجعه ومثال عليها.

الدوالّ

The conversations held with the assistant in the app: list and search them, read one, rename it and delete it. Only the workspace owner reaches them.

`chats.list()`

List the assistant chats

threads:readيتصفح النتائج صفحةً صفحة

التوقيع

list(options?: ChatListOptions): Promise<Page<ChatResource>>

Resolves one page of the conversations held with the assistant in the app, newest first, as its Chats page lists them, each with its title, how many messages it holds and when it last changed.

Only the workspace owner reaches the chats: an API key, or an access token the owner connected with every address. A token acting for a member is 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.

المعلمات

options.qstring: Searches the titles.
options.sortChatSort: newest (the default) or oldest by the last change, or title. A cursor carries on in the order it was handed out in.
options.limitnumber: Page size, from 1 to 100. The server defaults to 25.
options.cursorstring: The nextCursor of the previous page. Leave it out for the first page.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

يُرجع

Page<ChatResource> with items, hasMore and nextCursor. Each item has id, title, kind, messageCount and updatedAt.

مثال

const page = await openemail.chats.list({ q: 'invoices' }) for (const chat of page.items) console.log(chat.title, chat.messageCount)

ملاحظات

A cursor that names nothing in this list is 400 invalid_cursor.

متاح أيضًا في

API: GET /chats
CLI: openemail chats list

`chats.listAll()`

Collect every chat into one array

threads:readيتصفح النتائج صفحةً صفحة

التوقيع

listAll(options?: ChatListOptions): Promise<Array<ChatResource>>

Walks every page of list and resolves with every chat, in the order sort names. One request per page, with the same filters on each.

المعلمات

options.qstring: Searches the titles.
options.sortChatSort: newest (the default) or oldest by the last change, or title. A cursor carries on in the order it was handed out in.
options.limitnumber: Page size for each request, from 1 to 100. The server defaults to 25.
options.cursorstring: Starts the walk after this cursor instead of the first page.
options.signalAbortSignal: Cancels the request in flight and the walk with it.
options.apiKeystring: Overrides the client API key for every page of this walk.

يُرجع

Array<ChatResource> holding every chat.

مثال

const chats = await openemail.chats.listAll() console.log(chats.length)

ملاحظات

If any page fails the promise rejects and the rows already fetched are discarded.

متاح أيضًا في

API: GET /chats

`chats.iterate()`

Stream the chats one at a time

threads:readيتصفح النتائج صفحةً صفحة

التوقيع

iterate(options?: ChatListOptions): AsyncGenerator<ChatResource, void, undefined>

Returns an async generator that yields one chat at a time, in the order sort names, and requests the next page only once the current one is drained. Nothing is fetched until you consume it, and breaking out of the loop stops the requests.

المعلمات

options.qstring: Searches the titles.
options.sortChatSort: newest (the default) or oldest by the last change, or title. A cursor carries on in the order it was handed out in.
options.limitnumber: Page size for each request, from 1 to 100. The server defaults to 25.
options.cursorstring: Starts the walk after this cursor instead of the first page.
options.signalAbortSignal: Cancels the request in flight and the walk with it.
options.apiKeystring: Overrides the client API key for every page of this walk.

يُرجع

AsyncGenerator<ChatResource, void, undefined> yielding one chat per step.

مثال

for await (const chat of openemail.chats.iterate({ sort: 'title' })) console.log(chat.title)

ملاحظات

Each page is one request, so a long walk makes many.

متاح أيضًا في

API: GET /chats

`chats.get()`

Retrieve a chat

threads:read

التوقيع

get(id: string, options?: RequestScope): Promise<ChatResource>

Resolves one chat with the assistant by its id: its title, how many messages it holds and when it last changed.

المعلمات

idstringمطلوب: The chat id from list.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

يُرجع

ChatResource with id, title, kind, messageCount and updatedAt.

مثال

const chat = await openemail.chats.get('8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65') console.log(chat.title)

ملاحظات

An unknown id is a 404.

متاح أيضًا في

API: GET /chats/{id}
CLI: openemail chats get

`chats.rename()`

Rename a chat

threads:write

التوقيع

rename(id: string, title: string, options?: RequestScope): Promise<ChatResource>

Gives a chat with the assistant a new title, up to 120 characters, and resolves with the chat as it is now.

المعلمات

idstringمطلوب: The chat id from list.
titlestringمطلوب: The new title, from 1 to 120 characters.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

يُرجع

ChatResource with the new title.

مثال

await openemail.chats.rename('8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65', 'Quarterly invoices')

ملاحظات

An unknown id is a 404.

متاح أيضًا في

API: PATCH /chats/{id}
CLI: openemail chats rename

`chats.delete()`

Delete a chat

threads:write

التوقيع

delete(id: string, options?: RequestScope): Promise<DeletedChatResource>

Deletes a chat with the assistant and every message in it, for good. Nothing the assistant did in the mailbox is undone.

المعلمات

idstringمطلوب: The chat id from list.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

يُرجع

DeletedChatResource with object: 'chat', the id and deleted: true.

مثال

await openemail.chats.delete('8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65')

ملاحظات

An unknown id is a 404, and so is a second call for the same chat.
The SDK does not retry it.

متاح أيضًا في

API: DELETE /chats/{id}
CLI: openemail chats delete

openemail.chats

الدوالّ

المعلمات

يُرجع

مثال

ملاحظات

متاح أيضًا في

المعلمات

يُرجع

مثال

ملاحظات

متاح أيضًا في

المعلمات

يُرجع

مثال

ملاحظات

متاح أيضًا في

المعلمات

يُرجع

مثال

ملاحظات

متاح أيضًا في

المعلمات

يُرجع

مثال

ملاحظات

متاح أيضًا في

المعلمات

يُرجع

مثال

ملاحظات

متاح أيضًا في

صندوق بريدك،بشروطك أنت.

صندوق بريدك،
بشروطك أنت.