From 5bc6d07b3c7ab0d75b00550666c91a38d3404713 Mon Sep 17 00:00:00 2001 From: Pedro Alves Date: Thu, 1 May 2025 10:40:10 +0200 Subject: [PATCH] docs: change API methods description --- src/TodoistApi.ts | 36 ++++++++++----------- website/docs/api/classes/TodoistApi.md | 36 ++++++++++----------- website/docs/api/type-aliases/Permission.md | 3 +- 3 files changed, 38 insertions(+), 37 deletions(-) diff --git a/src/TodoistApi.ts b/src/TodoistApi.ts index 33e4452..b4ce8fc 100644 --- a/src/TodoistApi.ts +++ b/src/TodoistApi.ts @@ -186,7 +186,7 @@ export class TodoistApi { * Creates a new task with the provided parameters. * * @param args - Task creation parameters such as content, due date, or priority. - * @param requestId - Optional unique identifier for idempotency. + * @param requestId - Optional custom identifier for the request. * @returns A promise that resolves to the created task. */ async addTask(args: AddTaskArgs, requestId?: string): Promise { @@ -225,7 +225,7 @@ export class TodoistApi { * * @param id - The unique identifier of the task to update. * @param args - Update parameters such as content, priority, or due date. - * @param requestId - Optional unique identifier for idempotency. + * @param requestId - Optional custom identifier for the request. * @returns A promise that resolves to the updated task. */ async updateTask(id: string, args: UpdateTaskArgs, requestId?: string): Promise { @@ -247,7 +247,7 @@ export class TodoistApi { * * @param ids - The unique identifier of the tasks to be moved. * @param args - The paramets that should contain only one of projectId, sectionId, or parentId - * @param requestId - Optional unique identifier for idempotency. + * @param requestId - Optional custom identifier for the request. * @returns - A promise that resolves to an array of the updated tasks. */ async moveTasks(ids: string[], args: MoveTaskArgs, requestId?: string): Promise { @@ -305,7 +305,7 @@ export class TodoistApi { * Closes (completes) a task by its ID. * * @param id - The unique identifier of the task to close. - * @param requestId - Optional unique identifier for idempotency. + * @param requestId - Optional custom identifier for the request. * @returns A promise that resolves to `true` if successful. */ async closeTask(id: string, requestId?: string): Promise { @@ -325,7 +325,7 @@ export class TodoistApi { * Reopens a previously closed (completed) task by its ID. * * @param id - The unique identifier of the task to reopen. - * @param requestId - Optional unique identifier for idempotency. + * @param requestId - Optional custom identifier for the request. * @returns A promise that resolves to `true` if successful. */ async reopenTask(id: string, requestId?: string): Promise { @@ -345,7 +345,7 @@ export class TodoistApi { * Deletes a task by its ID. * * @param id - The unique identifier of the task to delete. - * @param requestId - Optional unique identifier for idempotency. + * @param requestId - Optional custom identifier for the request. * @returns A promise that resolves to `true` if successful. */ async deleteTask(id: string, requestId?: string): Promise { @@ -406,7 +406,7 @@ export class TodoistApi { * Creates a new project with the provided parameters. * * @param args - Project creation parameters such as name or color. - * @param requestId - Optional unique identifier for idempotency. + * @param requestId - Optional custom identifier for the request. * @returns A promise that resolves to the created project. */ async addProject( @@ -430,7 +430,7 @@ export class TodoistApi { * * @param id - The unique identifier of the project to update. * @param args - Update parameters such as name or color. - * @param requestId - Optional unique identifier for idempotency. + * @param requestId - Optional custom identifier for the request. * @returns A promise that resolves to the updated project. */ async updateProject( @@ -455,7 +455,7 @@ export class TodoistApi { * Deletes a project by its ID. * * @param id - The unique identifier of the project to delete. - * @param requestId - Optional unique identifier for idempotency. + * @param requestId - Optional custom identifier for the request. * @returns A promise that resolves to `true` if successful. */ async deleteProject(id: string, requestId?: string): Promise { @@ -544,7 +544,7 @@ export class TodoistApi { * Creates a new section within a project. * * @param args - Section creation parameters such as name or project ID. - * @param requestId - Optional unique identifier for idempotency. + * @param requestId - Optional custom identifier for the request. * @returns A promise that resolves to the created section. */ async addSection(args: AddSectionArgs, requestId?: string): Promise
{ @@ -565,7 +565,7 @@ export class TodoistApi { * * @param id - The unique identifier of the section to update. * @param args - Update parameters such as name or project ID. - * @param requestId - Optional unique identifier for idempotency. + * @param requestId - Optional custom identifier for the request. * @returns A promise that resolves to the updated section. */ async updateSection(id: string, args: UpdateSectionArgs, requestId?: string): Promise
{ @@ -585,7 +585,7 @@ export class TodoistApi { * Deletes a section by its ID. * * @param id - The unique identifier of the section to delete. - * @param requestId - Optional unique identifier for idempotency. + * @param requestId - Optional custom identifier for the request. * @returns A promise that resolves to `true` if successful. */ async deleteSection(id: string, requestId?: string): Promise { @@ -646,7 +646,7 @@ export class TodoistApi { * Adds a new label. * * @param args - Label creation parameters such as name. - * @param requestId - Optional unique identifier for idempotency. + * @param requestId - Optional custom identifier for the request. * @returns A promise that resolves to the created label. */ async addLabel(args: AddLabelArgs, requestId?: string): Promise