Namespaces
folder
Methods and types of the `folder` namespace (`client.folder` / `bot.folder`).
Interfaces
GetFoldersAssetsParams
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
chats? | boolean | - |
limit? | number | PaginationParams.limit |
messages? | number | - |
page? | number | PaginationParams.page |
replies? | number | - |
sort? | Record<string, -1 | 1> | SortParams.sort |
visibility? | "creator" | "reviewer" | - |
PaginationParams
Extended by
Properties
SortParams
Extended by
Properties
TagFolderData
Properties
UntagFolderData
Properties
UpdateFolderData
Properties
UpdateFolderIconData
Properties
Type Aliases
AssetResponse
type AssetResponse = Asset;FolderResponse
type FolderResponse = Folder;PaginatedResponse
type PaginatedResponse<T> = PaginatedResult | CursorPaginatedResult & {
results?: T[];
};Type Declaration
| Name | Type |
|---|---|
results? | T[] |
Type Parameters
| Type Parameter |
|---|
T |
Functions
default()
function default(client): {
getFolder: Promise<Folder>;
getFoldersAssets: Promise<PaginatedResponse<Asset>>;
tagFolder: Promise<Folder>;
untagFolder: Promise<Folder>;
updateFolder: Promise<Folder>;
updateFolderIcon: Promise<any>;
};Defines folder-related methods for the NuramaClient.
Parameters
| Parameter | Type | Description |
|---|---|---|
client | default | The NuramaClient instance. |
Returns
An object containing the folder-related methods.
| Name | Type | Description |
|---|---|---|
getFolder() | (folderId) => Promise<Folder> | Fetch a single folder by id. |
getFoldersAssets() | (folderId, params?) => Promise<PaginatedResponse<Asset>> | List the assets that live directly inside a folder (does not recurse). |
tagFolder() | (folderId, tagData) => Promise<Folder> | Tags a folder with a specific tag. |
untagFolder() | (folderId, untagData) => Promise<Folder> | Untags a folder by removing a specific tag. |
updateFolder() | (folderId, data) => Promise<Folder> | Updates a folder's name and/or color. |
updateFolderIcon() | (folderId, data) => Promise<any> | Updates a folder's icon. |