@doist/todoist-api-typescript 4.0.0-alpha.1 → 4.0.0-alpha.2

package/dist/TodoistApi.d.ts

@@ -1,14 +1,11 @@
-import { Task, Project, Label, User, Section, Comment } from './types/entities';
-import { AddCommentArgs, AddLabelArgs, AddProjectArgs, AddSectionArgs, AddTaskArgs, GetProjectCommentsArgs, GetTaskCommentsArgs, GetTasksArgs, UpdateCommentArgs, UpdateLabelArgs, UpdateProjectArgs, UpdateSectionArgs, UpdateTaskArgs, QuickAddTaskArgs, GetSharedLabelsArgs, RenameSharedLabelArgs, RemoveSharedLabelArgs, GetProjectsArgs, GetProjectCollaboratorsArgs, GetSections, GetLabelsArgs } from './types/requests';
+import { Task, Project, Label, Section, Comment } from './types/entities';
+import { AddCommentArgs, AddLabelArgs, AddProjectArgs, AddSectionArgs, AddTaskArgs, GetProjectCommentsArgs, GetTaskCommentsArgs, GetTasksArgs, UpdateCommentArgs, UpdateLabelArgs, UpdateProjectArgs, UpdateSectionArgs, UpdateTaskArgs, QuickAddTaskArgs, GetSharedLabelsArgs, RenameSharedLabelArgs, RemoveSharedLabelArgs, GetProjectsArgs, GetProjectCollaboratorsArgs, GetLabelsArgs, GetLabelsResponse, GetTasksResponse, GetProjectsResponse, GetProjectCollaboratorsResponse, GetSectionsArgs, GetSectionsResponse, GetSharedLabelsResponse, GetCommentsResponse } from './types/requests';
 export declare class TodoistApi {
     authToken: string;
     constructor(authToken: string, baseUrl?: string);
     private syncApiBase;
     getTask(id: string): Promise<Task>;
-    getTasks(args?: GetTasksArgs): Promise<{
-        results: Task[];
-        nextCursor: string | null;
-    }>;
+    getTasks(args?: GetTasksArgs): Promise<GetTasksResponse>;
     addTask(args: AddTaskArgs, requestId?: string): Promise<Task>;
     quickAddTask(args: QuickAddTaskArgs): Promise<Task>;
     updateTask(id: string, args: UpdateTaskArgs, requestId?: string): Promise<Task>;
@@ -16,21 +13,12 @@ export declare class TodoistApi {
     reopenTask(id: string, requestId?: string): Promise<boolean>;
     deleteTask(id: string, requestId?: string): Promise<boolean>;
     getProject(id: string): Promise<Project>;
-    getProjects(args?: GetProjectsArgs): Promise<{
-        results: Project[];
-        nextCursor: string | null;
-    }>;
+    getProjects(args?: GetProjectsArgs): Promise<GetProjectsResponse>;
     addProject(args: AddProjectArgs, requestId?: string): Promise<Project>;
     updateProject(id: string, args: UpdateProjectArgs, requestId?: string): Promise<Project>;
     deleteProject(id: string, requestId?: string): Promise<boolean>;
-    getProjectCollaborators(projectId: string, args?: GetProjectCollaboratorsArgs): Promise<{
-        results: User[];
-        nextCursor: string | null;
-    }>;
-    getSections(args: GetSections): Promise<{
-        results: Section[];
-        nextCursor: string | null;
-    }>;
+    getProjectCollaborators(projectId: string, args?: GetProjectCollaboratorsArgs): Promise<GetProjectCollaboratorsResponse>;
+    getSections(args: GetSectionsArgs): Promise<GetSectionsResponse>;
     getSection(id: string): Promise<Section>;
     addSection(args: AddSectionArgs, requestId?: string): Promise<Section>;
     updateSection(id: string, args: UpdateSectionArgs, requestId?: string): Promise<Section>;
@@ -42,10 +30,7 @@ export declare class TodoistApi {
     /**
      * Fetches the personal labels
      */
-    getLabels(args?: GetLabelsArgs): Promise<{
-        results: Label[];
-        nextCursor: string | null;
-    }>;
+    getLabels(args?: GetLabelsArgs): Promise<GetLabelsResponse>;
     /**
      * Adds a personal label
      */
@@ -58,16 +43,10 @@ export declare class TodoistApi {
      * Deletes a personal label
      */
     deleteLabel(id: string, requestId?: string): Promise<boolean>;
-    getSharedLabels(args?: GetSharedLabelsArgs): Promise<{
-        results: string[];
-        nextCursor: string | null;
-    }>;
+    getSharedLabels(args?: GetSharedLabelsArgs): Promise<GetSharedLabelsResponse>;
     renameSharedLabel(args: RenameSharedLabelArgs): Promise<boolean>;
     removeSharedLabel(args: RemoveSharedLabelArgs): Promise<boolean>;
-    getComments(args: GetTaskCommentsArgs | GetProjectCommentsArgs): Promise<{
-        results: Comment[];
-        nextCursor: string | null;
-    }>;
+    getComments(args: GetTaskCommentsArgs | GetProjectCommentsArgs): Promise<GetCommentsResponse>;
     getComment(id: string): Promise<Comment>;
     addComment(args: AddCommentArgs, requestId?: string): Promise<Comment>;
     updateComment(id: string, args: UpdateCommentArgs, requestId?: string): Promise<Comment>;

package/dist/types/requests.d.ts

@@ -1,5 +1,5 @@
 import type { RequireAllOrNone, RequireOneOrNone, RequireExactlyOne } from 'type-fest';
-import type { Duration, ProjectViewStyle } from './entities';
+import type { Comment, Duration, Label, Project, ProjectViewStyle, Section, Task, User } from './entities';
 export type AddTaskArgs = {
     content: string;
     description?: string;
@@ -38,6 +38,10 @@ export type GetTasksArgs = {
     cursor?: string | null;
     limit?: number;
 };
+export type GetTasksResponse = {
+    results: Task[];
+    nextCursor: string | null;
+};
 export type UpdateTaskArgs = {
     content?: string;
     description?: string;
@@ -59,6 +63,10 @@ export type GetProjectsArgs = {
     cursor?: string | null;
     limit?: number;
 };
+export type GetProjectsResponse = {
+    results: Project[];
+    nextCursor: string | null;
+};
 export type AddProjectArgs = {
     name: string;
     parentId?: string;
@@ -76,11 +84,19 @@ export type GetProjectCollaboratorsArgs = {
     cursor?: string | null;
     limit?: number;
 };
-export type GetSections = {
+export type GetProjectCollaboratorsResponse = {
+    results: User[];
+    nextCursor: string | null;
+};
+export type GetSectionsArgs = {
     projectId: string | null;
     cursor?: string | null;
     limit?: number;
 };
+export type GetSectionsResponse = {
+    results: Section[];
+    nextCursor: string | null;
+};
 export type AddSectionArgs = {
     name: string;
     projectId: string;
@@ -93,6 +109,10 @@ export type GetLabelsArgs = {
     cursor?: string | null;
     limit?: number;
 };
+export type GetLabelsResponse = {
+    results: Label[];
+    nextCursor: string | null;
+};
 export type AddLabelArgs = {
     name: string;
     order?: number | null;
@@ -109,6 +129,10 @@ export type GetCommentsBaseArgs = {
     cursor?: string | null;
     limit?: number;
 };
+export type GetCommentsResponse = {
+    results: Comment[];
+    nextCursor: string | null;
+};
 export type GetTaskCommentsArgs = GetCommentsBaseArgs & {
     taskId: string;
     projectId?: never;
@@ -137,6 +161,10 @@ export type GetSharedLabelsArgs = {
     cursor?: string | null;
     limit?: number;
 };
+export type GetSharedLabelsResponse = {
+    results: string[];
+    nextCursor: string | null;
+};
 export type RenameSharedLabelArgs = {
     name: string;
     newName: string;

package/package.json

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