@doist/todoist-api-typescript 5.5.0 → 5.6.0

package/dist/TodoistApi.d.ts

@@ -1,5 +1,5 @@
 import { PersonalProject, WorkspaceProject, Label, Section, Comment, Task, CurrentUser, ProductivityStats } from './types/entities';
-import { AddCommentArgs, AddLabelArgs, AddProjectArgs, AddSectionArgs, AddTaskArgs, GetProjectCommentsArgs, GetTaskCommentsArgs, GetTasksArgs, GetTasksByFilterArgs, UpdateCommentArgs, UpdateLabelArgs, UpdateProjectArgs, UpdateSectionArgs, UpdateTaskArgs, QuickAddTaskArgs, GetSharedLabelsArgs, RenameSharedLabelArgs, RemoveSharedLabelArgs, GetProjectsArgs, GetProjectCollaboratorsArgs, GetLabelsArgs, GetLabelsResponse, GetTasksResponse, GetProjectsResponse, GetProjectCollaboratorsResponse, GetSectionsArgs, GetSectionsResponse, GetSharedLabelsResponse, GetCommentsResponse, type MoveTaskArgs, GetCompletedTasksByCompletionDateArgs, GetCompletedTasksByDueDateArgs, GetCompletedTasksResponse, GetArchivedProjectsArgs, GetArchivedProjectsResponse } from './types/requests';
+import { AddCommentArgs, AddLabelArgs, AddProjectArgs, AddSectionArgs, AddTaskArgs, GetProjectCommentsArgs, GetTaskCommentsArgs, GetTasksArgs, GetTasksByFilterArgs, UpdateCommentArgs, UpdateLabelArgs, UpdateProjectArgs, UpdateSectionArgs, UpdateTaskArgs, QuickAddTaskArgs, GetSharedLabelsArgs, RenameSharedLabelArgs, RemoveSharedLabelArgs, GetProjectsArgs, GetProjectCollaboratorsArgs, GetLabelsArgs, GetLabelsResponse, GetTasksResponse, GetProjectsResponse, GetProjectCollaboratorsResponse, GetSectionsArgs, GetSectionsResponse, GetSharedLabelsResponse, GetCommentsResponse, type MoveTaskArgs, GetCompletedTasksByCompletionDateArgs, GetCompletedTasksByDueDateArgs, GetCompletedTasksResponse, GetArchivedProjectsArgs, GetArchivedProjectsResponse, SearchCompletedTasksArgs } from './types/requests';
 /**
  * A client for interacting with the Todoist API v1.
  * This class provides methods to manage tasks, projects, sections, labels, and comments in Todoist.
@@ -74,6 +74,13 @@ export declare class TodoistApi {
      * @returns A promise that resolves to a paginated response of completed tasks.
      */
     getCompletedTasksByDueDate(args: GetCompletedTasksByDueDateArgs): Promise<GetCompletedTasksResponse>;
+    /**
+     * Searches completed tasks by query string.
+     *
+     * @param args - Parameters for searching, including the query string.
+     * @returns A promise that resolves to a paginated response of completed tasks.
+     */
+    searchCompletedTasks(args: SearchCompletedTasksArgs): Promise<GetCompletedTasksResponse>;
     /**
      * Creates a new task with the provided parameters.
      *

package/dist/TodoistApi.js

@@ -229,6 +229,28 @@ var TodoistApi = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Searches completed tasks by query string.
+     *
+     * @param args - Parameters for searching, including the query string.
+     * @returns A promise that resolves to a paginated response of completed tasks.
+     */
+    TodoistApi.prototype.searchCompletedTasks = function (args) {
+        return __awaiter(this, void 0, void 0, function () {
+            var _a, items, nextCursor;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0: return [4 /*yield*/, (0, restClient_1.request)('GET', this.syncApiBase, endpoints_1.ENDPOINT_REST_TASKS_COMPLETED_SEARCH, this.authToken, args)];
+                    case 1:
+                        _a = (_b.sent()).data, items = _a.items, nextCursor = _a.nextCursor;
+                        return [2 /*return*/, {
+                                items: (0, validators_1.validateTaskArray)(items),
+                                nextCursor: nextCursor,
+                            }];
+                }
+            });
+        });
+    };
     /**
      * Creates a new task with the provided parameters.
      *

package/dist/consts/endpoints.d.ts

@@ -7,6 +7,7 @@ export declare const ENDPOINT_REST_TASKS = "tasks";
 export declare const ENDPOINT_REST_TASKS_FILTER: string;
 export declare const ENDPOINT_REST_TASKS_COMPLETED_BY_COMPLETION_DATE: string;
 export declare const ENDPOINT_REST_TASKS_COMPLETED_BY_DUE_DATE: string;
+export declare const ENDPOINT_REST_TASKS_COMPLETED_SEARCH = "completed/search";
 export declare const ENDPOINT_REST_SECTIONS = "sections";
 export declare const ENDPOINT_REST_LABELS = "labels";
 export declare const ENDPOINT_REST_LABELS_SHARED: string;

package/dist/consts/endpoints.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ENDPOINT_REVOKE_TOKEN = exports.ENDPOINT_GET_TOKEN = exports.ENDPOINT_AUTHORIZATION = exports.ENDPOINT_SYNC = exports.ENDPOINT_SYNC_QUICK_ADD = exports.PROJECT_UNARCHIVE = exports.PROJECT_ARCHIVE = exports.ENDPOINT_REST_PRODUCTIVITY = exports.ENDPOINT_REST_USER = exports.ENDPOINT_REST_PROJECT_COLLABORATORS = exports.ENDPOINT_REST_PROJECTS_ARCHIVED = exports.ENDPOINT_REST_PROJECTS = exports.ENDPOINT_REST_TASK_REOPEN = exports.ENDPOINT_REST_TASK_CLOSE = exports.ENDPOINT_REST_COMMENTS = exports.ENDPOINT_REST_LABELS_SHARED_REMOVE = exports.ENDPOINT_REST_LABELS_SHARED_RENAME = exports.ENDPOINT_REST_LABELS_SHARED = exports.ENDPOINT_REST_LABELS = exports.ENDPOINT_REST_SECTIONS = exports.ENDPOINT_REST_TASKS_COMPLETED_BY_DUE_DATE = exports.ENDPOINT_REST_TASKS_COMPLETED_BY_COMPLETION_DATE = exports.ENDPOINT_REST_TASKS_FILTER = exports.ENDPOINT_REST_TASKS = exports.API_BASE_URI = exports.API_VERSION = exports.TODOIST_WEB_URI = void 0;
+exports.ENDPOINT_REVOKE_TOKEN = exports.ENDPOINT_GET_TOKEN = exports.ENDPOINT_AUTHORIZATION = exports.ENDPOINT_SYNC = exports.ENDPOINT_SYNC_QUICK_ADD = exports.PROJECT_UNARCHIVE = exports.PROJECT_ARCHIVE = exports.ENDPOINT_REST_PRODUCTIVITY = exports.ENDPOINT_REST_USER = exports.ENDPOINT_REST_PROJECT_COLLABORATORS = exports.ENDPOINT_REST_PROJECTS_ARCHIVED = exports.ENDPOINT_REST_PROJECTS = exports.ENDPOINT_REST_TASK_REOPEN = exports.ENDPOINT_REST_TASK_CLOSE = exports.ENDPOINT_REST_COMMENTS = exports.ENDPOINT_REST_LABELS_SHARED_REMOVE = exports.ENDPOINT_REST_LABELS_SHARED_RENAME = exports.ENDPOINT_REST_LABELS_SHARED = exports.ENDPOINT_REST_LABELS = exports.ENDPOINT_REST_SECTIONS = exports.ENDPOINT_REST_TASKS_COMPLETED_SEARCH = exports.ENDPOINT_REST_TASKS_COMPLETED_BY_DUE_DATE = exports.ENDPOINT_REST_TASKS_COMPLETED_BY_COMPLETION_DATE = exports.ENDPOINT_REST_TASKS_FILTER = exports.ENDPOINT_REST_TASKS = exports.API_BASE_URI = exports.API_VERSION = exports.TODOIST_WEB_URI = void 0;
 exports.getSyncBaseUri = getSyncBaseUri;
 exports.getAuthBaseUri = getAuthBaseUri;
 var BASE_URI = 'https://api.todoist.com';
@@ -23,6 +23,7 @@ exports.ENDPOINT_REST_TASKS = 'tasks';
 exports.ENDPOINT_REST_TASKS_FILTER = exports.ENDPOINT_REST_TASKS + '/filter';
 exports.ENDPOINT_REST_TASKS_COMPLETED_BY_COMPLETION_DATE = exports.ENDPOINT_REST_TASKS + '/completed/by_completion_date';
 exports.ENDPOINT_REST_TASKS_COMPLETED_BY_DUE_DATE = exports.ENDPOINT_REST_TASKS + '/completed/by_due_date';
+exports.ENDPOINT_REST_TASKS_COMPLETED_SEARCH = 'completed/search';
 exports.ENDPOINT_REST_SECTIONS = 'sections';
 exports.ENDPOINT_REST_LABELS = 'labels';
 exports.ENDPOINT_REST_LABELS_SHARED = exports.ENDPOINT_REST_LABELS + '/shared';

package/dist/types/entities.d.ts

@@ -543,10 +543,10 @@ export declare const CurrentUserSchema: z.ZodObject<{
     id: z.ZodString;
     email: z.ZodString;
     fullName: z.ZodString;
-    avatarBig: z.ZodNullable<z.ZodString>;
-    avatarMedium: z.ZodNullable<z.ZodString>;
-    avatarS640: z.ZodNullable<z.ZodString>;
-    avatarSmall: z.ZodNullable<z.ZodString>;
+    avatarBig: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    avatarMedium: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    avatarS640: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    avatarSmall: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     businessAccountId: z.ZodNullable<z.ZodString>;
     isPremium: z.ZodBoolean;
     dateFormat: z.ZodNumber;

package/dist/types/entities.js

@@ -202,10 +202,10 @@ exports.CurrentUserSchema = zod_1.z.object({
     id: zod_1.z.string(),
     email: zod_1.z.string(),
     fullName: zod_1.z.string(),
-    avatarBig: zod_1.z.string().nullable(),
-    avatarMedium: zod_1.z.string().nullable(),
-    avatarS640: zod_1.z.string().nullable(),
-    avatarSmall: zod_1.z.string().nullable(),
+    avatarBig: zod_1.z.string().nullish(),
+    avatarMedium: zod_1.z.string().nullish(),
+    avatarS640: zod_1.z.string().nullish(),
+    avatarSmall: zod_1.z.string().nullish(),
     businessAccountId: zod_1.z.string().nullable(),
     isPremium: zod_1.z.boolean(),
     dateFormat: zod_1.z.number().int(),

package/dist/types/requests.d.ts

@@ -81,6 +81,14 @@ export type GetCompletedTasksByDueDateArgs = {
     cursor?: string | null;
     limit?: number;
 };
+/**
+ * Arguments for searching completed tasks.
+ */
+export type SearchCompletedTasksArgs = {
+    query: string;
+    cursor?: string | null;
+    limit?: number;
+};
 /**
  * @see https://todoist.com/api/v1/docs#tag/Tasks/operation/get_tasks_api_v1_tasks_get
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@doist/todoist-api-typescript",
-    "version": "5.5.0",
+    "version": "5.6.0",
     "description": "A typescript wrapper for the Todoist REST API.",
     "author": "Doist developers",
     "repository": "git@github.com:doist/todoist-api-typescript.git",