Skip to main content

​
ProjectsClient

adaline.projects lists and manages the projects in your workspace.

​
Access

import { Adaline } from '@adaline/client';

const adaline = new Adaline();
const projects = adaline.projects; // ProjectsClient
The class is also exported directly: 
import { ProjectsClient } from '@adaline/client';
Types from @adaline/api: 
import type {
  Project,
  UpdateProjectRequest,
  ListProjectsResponse,
} from '@adaline/api';

​
list()

List all projects the API key has access to. 
list(): Promise<ListProjectsResponse>

​
Parameters

None.

​
Returns

Promise<ListProjectsResponse> with { data: Project[] }. Each Project has id, title, icon, and timestamps.

​
Example

const { data } = await adaline.projects.list();

for (const project of data) {
  console.log(project.id, project.title);
}

​
get()

Get a single project by ID. 
get(options: { projectId: string }): Promise<Project>

​
Parameters

NameTypeRequiredDescription
projectIdstringYesProject identifier.

​
Returns

Promise<Project> — the project record with id, title, icon, and timestamps.

​
Example

const project = await adaline.projects.get({ projectId: 'project_abc123' });
console.log(project.title, project.icon);

​
update()

Update a project’s title and/or icon. At least one field must be provided. 
update(options: {
  projectId: string;
  project: UpdateProjectRequest;
}): Promise<Project>

​
Parameters

NameTypeRequiredDescription
projectIdstringYesProject identifier.
projectUpdateProjectRequestYesFields to update (title?, icon?).

​
Returns

Promise<Project> — the updated project.

​
Example

const updated = await adaline.projects.update({
  projectId: 'project_abc123',
  project: {
    title: 'Renamed project',
    icon: { type: 'emoji', value: '✨' },
  },
});

​
See Also