Ruby

client.chats

Every method in this namespace: its signature, its parameters, what it returns and an example.

Methods

The conversations held with the assistant in the app: list and search them, read one, rename it and delete it. Each person reaches only their own.

`chats.list`

List the assistant chats

threads:readPages through results

Signature

list(q: nil, sort: nil, limit: nil, cursor: nil, api_key: nil) -> Nextmail::Page

Returns 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.

Each person reaches only their own chats: an API key reaches the chats of the workspace owner, and an access token reaches the chats of the person who connected it. A key or token limited to particular addresses or domains is 422 capability_unsupported.

Parameters

qString: Searches the titles.
sortString: newest (the default) or oldest by the last change, or title. A cursor carries on in the order it was handed out in.
limitInteger: Page size, from 1 to 100. The server defaults to 25.
cursorString: The next_cursor of the previous page. Leave it out for the first page.
api_keyString: Overrides the client's API key for this call only.

Returns

The Nextmail::Page of Hashes with items, has_more? and next_cursor. Each item has id, title, kind, messageCount and updatedAt.

Example

page = client.chats.list(q: "invoices") page.items.each { |chat| puts "#{chat[:title]} #{chat[:messageCount]}" }

Notes

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

Also available in

API: GET /chats
TypeScript: nextmail.chats.list()
Python: chats.list()
PHP: chats->list
Go: Chats.List
Java: chats().list
C#: Chats.ListAsync
CLI: nextmail chats list

`chats.list_all`

Collect every chat into one Array

threads:readPages through results

Signature

list_all(q: nil, sort: nil, limit: nil, cursor: nil, api_key: nil) -> Array<Hash>

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

Parameters

qString: Searches the titles.
sortString: newest (the default) or oldest by the last change, or title. A cursor carries on in the order it was handed out in.
limitInteger: Page size for each request, from 1 to 100. The server defaults to 25.
cursorString: Starts the walk after this cursor instead of the first page.
api_keyString: Overrides the client API key for every page of this walk.

Returns

An Array of Hashes holding every chat.

Example

chats = client.chats.list_all puts chats.length

Notes

If any page fails, the error is raised and the rows already fetched are discarded.

Also available in

API: GET /chats
TypeScript: nextmail.chats.listAll()
Python: chats.list_all()
PHP: chats->listAll
Go: Chats.ListAll
Java: chats().listAll
C#: Chats.ListAllAsync

`chats.iterate`

Stream the chats one at a time

threads:readPages through results

Signature

iterate(q: nil, sort: nil, limit: nil, cursor: nil, api_key: nil, &block) -> Enumerator<Hash>

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

Parameters

qString: Searches the titles.
sortString: newest (the default) or oldest by the last change, or title. A cursor carries on in the order it was handed out in.
limitInteger: Page size for each request, from 1 to 100. The server defaults to 25.
cursorString: Starts the walk after this cursor instead of the first page.
api_keyString: Overrides the client API key for every page of this walk.

Returns

An Enumerator of Hashes, one chat per step (or yields each one to a block).

Example

client.chats.iterate(sort: "title") { |chat| puts chat[:title] }

Notes

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

Also available in

API: GET /chats
TypeScript: nextmail.chats.iterate()
Python: chats.iterate()
PHP: chats->iterate
Go: Chats.Iterate
Java: chats().iterate
C#: Chats.IterateAsync

`chats.get`

Retrieve a chat

threads:read

Signature

get(id, api_key: nil) -> Hash

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

Parameters

idStringRequired: The chat id from list.
api_keyString: Overrides the client's API key for this call only.

Returns

A Hash with id, title, kind, messageCount and updatedAt.

Example

chat = client.chats.get("8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65") puts chat[:title]

Notes

An unknown id is a 404.

Also available in

API: GET /chats/{id}
TypeScript: nextmail.chats.get()
Python: chats.get()
PHP: chats->get
Go: Chats.Get
Java: chats().get
C#: Chats.GetAsync
CLI: nextmail chats get

`chats.rename`

Rename a chat

threads:write

Signature

rename(id, title, api_key: nil) -> Hash

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

Parameters

idStringRequired: The chat id from list.
titleStringRequired: The new title, from 1 to 120 characters.
api_keyString: Overrides the client's API key for this call only.

Returns

The same Hash as chats.get, with the new title.

Example

client.chats.rename("8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65", "Quarterly invoices")

Notes

An unknown id is a 404.

Also available in

API: PATCH /chats/{id}
TypeScript: nextmail.chats.rename()
Python: chats.rename()
PHP: chats->rename
Go: Chats.Rename
Java: chats().rename
C#: Chats.RenameAsync
CLI: nextmail chats rename

`chats.delete`

Delete a chat

threads:write

Signature

delete(id, api_key: nil) -> Hash

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

Parameters

idStringRequired: The chat id from list.
api_keyString: Overrides the client's API key for this call only.

Returns

A Hash with object set to chat, the id and deleted set to true.

Example

client.chats.delete("8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65")

Notes

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

Also available in

API: DELETE /chats/{id}
TypeScript: nextmail.chats.delete()
Python: chats.delete()
PHP: chats->delete
Go: Chats.Delete
Java: chats().delete
C#: Chats.DeleteAsync
CLI: nextmail chats delete

client.chats

Methods

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Your inbox,on your own terms.

Your inbox,
on your own terms.