@doist/todoist-api-typescript 5.0.1 → 5.1.0

package/dist/TodoistApi.d.ts

@@ -1,5 +1,5 @@
 import { PersonalProject, WorkspaceProject, Label, Section, Comment, Task } 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 } 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 } 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.
@@ -54,6 +54,20 @@ export declare class TodoistApi {
      * @returns A promise that resolves to a paginated response of tasks.
      */
     getTasksByFilter(args: GetTasksByFilterArgs): Promise<GetTasksResponse>;
+    /**
+     * Retrieves completed tasks by completion date.
+     *
+     * @param args - Parameters for filtering, including required since, until.
+     * @returns A promise that resolves to a paginated response of completed tasks.
+     */
+    getCompletedTasksByCompletionDate(args: GetCompletedTasksByCompletionDateArgs): Promise<GetCompletedTasksResponse>;
+    /**
+     * Retrieves completed tasks by due date.
+     *
+     * @param args - Parameters for filtering, including required since, until.
+     * @returns A promise that resolves to a paginated response of completed tasks.
+     */
+    getCompletedTasksByDueDate(args: GetCompletedTasksByDueDateArgs): Promise<GetCompletedTasksResponse>;
     /**
      * Creates a new task with the provided parameters.
      *

package/dist/TodoistApi.js

@@ -167,6 +167,50 @@ var TodoistApi = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Retrieves completed tasks by completion date.
+     *
+     * @param args - Parameters for filtering, including required since, until.
+     * @returns A promise that resolves to a paginated response of completed tasks.
+     */
+    TodoistApi.prototype.getCompletedTasksByCompletionDate = 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_BY_COMPLETION_DATE, 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,
+                            }];
+                }
+            });
+        });
+    };
+    /**
+     * Retrieves completed tasks by due date.
+     *
+     * @param args - Parameters for filtering, including required since, until.
+     * @returns A promise that resolves to a paginated response of completed tasks.
+     */
+    TodoistApi.prototype.getCompletedTasksByDueDate = 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_BY_DUE_DATE, 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

@@ -5,6 +5,8 @@ export declare function getSyncBaseUri(domainBase?: string): string;
 export declare function getAuthBaseUri(domainBase?: string): string;
 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_PROJECTS = "projects";
 export declare const ENDPOINT_REST_SECTIONS = "sections";
 export declare const ENDPOINT_REST_LABELS = "labels";

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.ENDPOINT_REST_PROJECT_COLLABORATORS = 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_PROJECTS = exports.ENDPOINT_REST_TASKS_FILTER = exports.ENDPOINT_REST_TASKS = exports.getAuthBaseUri = exports.getSyncBaseUri = 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.ENDPOINT_REST_PROJECT_COLLABORATORS = 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_PROJECTS = 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.getAuthBaseUri = exports.getSyncBaseUri = exports.API_BASE_URI = exports.API_VERSION = exports.TODOIST_WEB_URI = void 0;
 var BASE_URI = 'https://api.todoist.com';
 var TODOIST_URI = 'https://todoist.com';
 exports.TODOIST_WEB_URI = 'https://app.todoist.com/app';
@@ -21,6 +21,8 @@ function getAuthBaseUri(domainBase) {
 exports.getAuthBaseUri = getAuthBaseUri;
 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_PROJECTS = 'projects';
 exports.ENDPOINT_REST_SECTIONS = 'sections';
 exports.ENDPOINT_REST_LABELS = 'labels';

package/dist/types/entities.d.ts

@@ -463,7 +463,7 @@ export declare const WorkspaceProjectSchema: z.ZodEffects<z.ZodObject<z.objectUt
     isShared: z.ZodBoolean;
 }, {
     collaboratorRoleDefault: z.ZodString;
-    folderId: z.ZodNullable<z.ZodBoolean>;
+    folderId: z.ZodNullable<z.ZodString>;
     isInviteOnly: z.ZodNullable<z.ZodBoolean>;
     isLinkSharingEnabled: z.ZodBoolean;
     role: z.ZodNullable<z.ZodString>;
@@ -488,7 +488,7 @@ export declare const WorkspaceProjectSchema: z.ZodEffects<z.ZodObject<z.objectUt
     defaultOrder: number;
     isShared: boolean;
     collaboratorRoleDefault: string;
-    folderId: boolean | null;
+    folderId: string | null;
     isInviteOnly: boolean | null;
     isLinkSharingEnabled: boolean;
     role: string | null;
@@ -512,7 +512,7 @@ export declare const WorkspaceProjectSchema: z.ZodEffects<z.ZodObject<z.objectUt
     defaultOrder: number;
     isShared: boolean;
     collaboratorRoleDefault: string;
-    folderId: boolean | null;
+    folderId: string | null;
     isInviteOnly: boolean | null;
     isLinkSharingEnabled: boolean;
     role: string | null;
@@ -537,7 +537,7 @@ export declare const WorkspaceProjectSchema: z.ZodEffects<z.ZodObject<z.objectUt
     defaultOrder: number;
     isShared: boolean;
     collaboratorRoleDefault: string;
-    folderId: boolean | null;
+    folderId: string | null;
     isInviteOnly: boolean | null;
     isLinkSharingEnabled: boolean;
     role: string | null;
@@ -561,7 +561,7 @@ export declare const WorkspaceProjectSchema: z.ZodEffects<z.ZodObject<z.objectUt
     defaultOrder: number;
     isShared: boolean;
     collaboratorRoleDefault: string;
-    folderId: boolean | null;
+    folderId: string | null;
     isInviteOnly: boolean | null;
     isLinkSharingEnabled: boolean;
     role: string | null;

package/dist/types/entities.js

@@ -110,7 +110,7 @@ exports.PersonalProjectSchema = exports.BaseProjectSchema.extend({
  */
 exports.WorkspaceProjectSchema = exports.BaseProjectSchema.extend({
     collaboratorRoleDefault: zod_1.z.string(),
-    folderId: zod_1.z.boolean().nullable(),
+    folderId: zod_1.z.string().nullable(),
     isInviteOnly: zod_1.z.boolean().nullable(),
     isLinkSharingEnabled: zod_1.z.boolean(),
     role: zod_1.z.string().nullable(),

package/dist/types/requests.d.ts

@@ -48,6 +48,39 @@ export type GetTasksByFilterArgs = {
     cursor?: string | null;
     limit?: number;
 };
+/**
+ * Arguments for retrieving completed tasks by completion date.
+ * @see https://todoist.com/api/v1/docs#tag/Tasks/operation/tasks_completed_by_completion_date_api_v1_tasks_completed_by_completion_date_get
+ */
+export type GetCompletedTasksByCompletionDateArgs = {
+    since: string;
+    until: string;
+    workspaceId?: string | null;
+    projectId?: string | null;
+    sectionId?: string | null;
+    parentId?: string | null;
+    filterQuery?: string | null;
+    filterLang?: string | null;
+    cursor?: string | null;
+    limit?: number;
+    publicKey?: string | null;
+};
+/**
+ * Arguments for retrieving completed tasks by due date.
+ * @see https://todoist.com/api/v1/docs#tag/Tasks/operation/tasks_completed_by_due_date_api_v1_tasks_completed_by_due_date_get
+ */
+export type GetCompletedTasksByDueDateArgs = {
+    since: string;
+    until: string;
+    workspaceId?: string | null;
+    projectId?: string | null;
+    sectionId?: string | null;
+    parentId?: string | null;
+    filterQuery?: string | null;
+    filterLang?: string | null;
+    cursor?: string | null;
+    limit?: number;
+};
 /**
  * @see https://todoist.com/api/v1/docs#tag/Tasks/operation/get_tasks_api_v1_tasks_get
  */
@@ -55,6 +88,14 @@ export type GetTasksResponse = {
     results: Task[];
     nextCursor: string | null;
 };
+/**
+ * @see https://todoist.com/api/v1/docs#tag/Tasks/operation/tasks_completed_by_due_date_api_v1_tasks_completed_by_due_date_get
+ * @see https://todoist.com/api/v1/docs#tag/Tasks/operation/tasks_completed_by_completion_date_api_v1_tasks_completed_by_completion_date_get
+ */
+export type GetCompletedTasksResponse = {
+    items: Task[];
+    nextCursor: string | null;
+};
 /**
  * Arguments for updating a task.
  * @see https://todoist.com/api/v1/docs#tag/Tasks/operation/update_task_api_v1_tasks__task_id__post

package/package.json

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