@doist/todoist-api-typescript 4.0.3 → 5.0.0

package/dist/types/entities.d.ts

@@ -59,13 +59,13 @@ export declare const DeadlineSchema: z.ZodObject<{
  */
 export interface Deadline extends z.infer<typeof DeadlineSchema> {
 }
-export declare const RawTaskSchema: z.ZodObject<{
-    userId: z.ZodString;
+export declare const TaskSchema: z.ZodEffects<z.ZodObject<{
     id: z.ZodString;
+    userId: z.ZodString;
     projectId: z.ZodString;
     sectionId: z.ZodNullable<z.ZodString>;
     parentId: z.ZodNullable<z.ZodString>;
-    addedByUid: z.ZodString;
+    addedByUid: z.ZodNullable<z.ZodString>;
     assignedByUid: z.ZodNullable<z.ZodString>;
     responsibleUid: z.ZodNullable<z.ZodString>;
     labels: z.ZodArray<z.ZodString, "many">;
@@ -91,9 +91,9 @@ export declare const RawTaskSchema: z.ZodObject<{
     }>>;
     checked: z.ZodBoolean;
     isDeleted: z.ZodBoolean;
-    addedAt: z.ZodString;
+    addedAt: z.ZodNullable<z.ZodString>;
     completedAt: z.ZodNullable<z.ZodString>;
-    updatedAt: z.ZodString;
+    updatedAt: z.ZodNullable<z.ZodString>;
     due: z.ZodNullable<z.ZodObject<z.objectUtil.extendShape<{
         isRecurring: z.ZodBoolean;
         string: z.ZodString;
@@ -121,18 +121,19 @@ export declare const RawTaskSchema: z.ZodObject<{
     childOrder: z.ZodNumber;
     content: z.ZodString;
     description: z.ZodString;
+    noteCount: z.ZodNumber;
     dayOrder: z.ZodNumber;
     isCollapsed: z.ZodBoolean;
 }, "strip", z.ZodTypeAny, {
-    userId: string;
+    labels: string[];
     id: string;
+    userId: string;
     projectId: string;
     sectionId: string | null;
     parentId: string | null;
-    addedByUid: string;
+    addedByUid: string | null;
     assignedByUid: string | null;
     responsibleUid: string | null;
-    labels: string[];
     deadline: {
         date: string;
         lang: string;
@@ -143,9 +144,9 @@ export declare const RawTaskSchema: z.ZodObject<{
     } | null;
     checked: boolean;
     isDeleted: boolean;
-    addedAt: string;
+    addedAt: string | null;
     completedAt: string | null;
-    updatedAt: string;
+    updatedAt: string | null;
     due: {
         string: string;
         isRecurring: boolean;
@@ -158,18 +159,19 @@ export declare const RawTaskSchema: z.ZodObject<{
     childOrder: number;
     content: string;
     description: string;
+    noteCount: number;
     dayOrder: number;
     isCollapsed: boolean;
 }, {
-    userId: string;
+    labels: string[];
     id: string;
+    userId: string;
     projectId: string;
     sectionId: string | null;
     parentId: string | null;
-    addedByUid: string;
+    addedByUid: string | null;
     assignedByUid: string | null;
     responsibleUid: string | null;
-    labels: string[];
     deadline: {
         date: string;
         lang: string;
@@ -180,9 +182,9 @@ export declare const RawTaskSchema: z.ZodObject<{
     } | null;
     checked: boolean;
     isDeleted: boolean;
-    addedAt: string;
+    addedAt: string | null;
     completedAt: string | null;
-    updatedAt: string;
+    updatedAt: string | null;
     due: {
         string: string;
         isRecurring: boolean;
@@ -195,76 +197,20 @@ export declare const RawTaskSchema: z.ZodObject<{
     childOrder: number;
     content: string;
     description: string;
+    noteCount: number;
     dayOrder: number;
     isCollapsed: boolean;
-}>;
-export interface RawTask extends z.infer<typeof RawTaskSchema> {
-}
-export declare const TaskSchema: z.ZodObject<{
-    id: z.ZodString;
-    assignerId: z.ZodNullable<z.ZodString>;
-    assigneeId: z.ZodNullable<z.ZodString>;
-    projectId: z.ZodString;
-    sectionId: z.ZodNullable<z.ZodString>;
-    parentId: z.ZodNullable<z.ZodString>;
-    order: z.ZodNumber;
-    content: z.ZodString;
-    description: z.ZodString;
-    isCompleted: z.ZodBoolean;
-    labels: z.ZodArray<z.ZodString, "many">;
-    priority: z.ZodNumber;
-    creatorId: z.ZodString;
-    createdAt: z.ZodString;
-    due: z.ZodNullable<z.ZodObject<z.objectUtil.extendShape<{
-        isRecurring: z.ZodBoolean;
-        string: z.ZodString;
-        date: z.ZodString;
-    }, {
-        datetime: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-        timezone: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-        lang: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    }>, "strip", z.ZodTypeAny, {
-        string: string;
-        isRecurring: boolean;
-        date: string;
-        datetime?: string | null | undefined;
-        timezone?: string | null | undefined;
-        lang?: string | null | undefined;
-    }, {
-        string: string;
-        isRecurring: boolean;
-        date: string;
-        datetime?: string | null | undefined;
-        timezone?: string | null | undefined;
-        lang?: string | null | undefined;
-    }>>;
-    url: z.ZodString;
-    duration: z.ZodNullable<z.ZodObject<{
-        amount: z.ZodNumber;
-        unit: z.ZodEnum<["minute", "day"]>;
-    }, "strip", z.ZodTypeAny, {
-        amount: number;
-        unit: "minute" | "day";
-    }, {
-        amount: number;
-        unit: "minute" | "day";
-    }>>;
-    deadline: z.ZodNullable<z.ZodObject<{
-        date: z.ZodString;
-        lang: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        date: string;
-        lang: string;
-    }, {
-        date: string;
-        lang: string;
-    }>>;
-}, "strip", z.ZodTypeAny, {
+}>, {
+    url: string;
+    labels: string[];
     id: string;
+    userId: string;
     projectId: string;
     sectionId: string | null;
     parentId: string | null;
-    labels: string[];
+    addedByUid: string | null;
+    assignedByUid: string | null;
+    responsibleUid: string | null;
     deadline: {
         date: string;
         lang: string;
@@ -273,6 +219,11 @@ export declare const TaskSchema: z.ZodObject<{
         amount: number;
         unit: "minute" | "day";
     } | null;
+    checked: boolean;
+    isDeleted: boolean;
+    addedAt: string | null;
+    completedAt: string | null;
+    updatedAt: string | null;
     due: {
         string: string;
         isRecurring: boolean;
@@ -282,21 +233,22 @@ export declare const TaskSchema: z.ZodObject<{
         lang?: string | null | undefined;
     } | null;
     priority: number;
+    childOrder: number;
     content: string;
     description: string;
-    assignerId: string | null;
-    assigneeId: string | null;
-    order: number;
-    isCompleted: boolean;
-    creatorId: string;
-    createdAt: string;
-    url: string;
+    noteCount: number;
+    dayOrder: number;
+    isCollapsed: boolean;
 }, {
+    labels: string[];
     id: string;
+    userId: string;
     projectId: string;
     sectionId: string | null;
     parentId: string | null;
-    labels: string[];
+    addedByUid: string | null;
+    assignedByUid: string | null;
+    responsibleUid: string | null;
     deadline: {
         date: string;
         lang: string;
@@ -305,6 +257,11 @@ export declare const TaskSchema: z.ZodObject<{
         amount: number;
         unit: "minute" | "day";
     } | null;
+    checked: boolean;
+    isDeleted: boolean;
+    addedAt: string | null;
+    completedAt: string | null;
+    updatedAt: string | null;
     due: {
         string: string;
         isRecurring: boolean;
@@ -314,15 +271,12 @@ export declare const TaskSchema: z.ZodObject<{
         lang?: string | null | undefined;
     } | null;
     priority: number;
+    childOrder: number;
     content: string;
     description: string;
-    assignerId: string | null;
-    assigneeId: string | null;
-    order: number;
-    isCompleted: boolean;
-    creatorId: string;
-    createdAt: string;
-    url: string;
+    noteCount: number;
+    dayOrder: number;
+    isCollapsed: boolean;
 }>;
 /**
  * Represents a task in Todoist.
@@ -330,111 +284,300 @@ export declare const TaskSchema: z.ZodObject<{
  */
 export interface Task extends z.infer<typeof TaskSchema> {
 }
-export declare const RawProjectSchema: z.ZodObject<{
+/**
+ * Base schema for all project types in Todoist.
+ * Contains common fields shared between personal and workspace projects.
+ */
+export declare const BaseProjectSchema: z.ZodObject<{
     id: z.ZodString;
     canAssignTasks: z.ZodBoolean;
-    childOrder: z.ZodNullable<z.ZodNumber>;
+    childOrder: z.ZodNumber;
     color: z.ZodString;
-    createdAt: z.ZodString;
+    createdAt: z.ZodNullable<z.ZodString>;
     isArchived: z.ZodBoolean;
     isDeleted: z.ZodBoolean;
     isFavorite: z.ZodBoolean;
     isFrozen: z.ZodBoolean;
     name: z.ZodString;
-    updatedAt: z.ZodString;
+    updatedAt: z.ZodNullable<z.ZodString>;
     viewStyle: z.ZodString;
-    defaultOrder: z.ZodNullable<z.ZodNumber>;
+    defaultOrder: z.ZodNumber;
     description: z.ZodString;
-    publicAccess: z.ZodBoolean;
-    parentId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    inboxProject: z.ZodOptional<z.ZodBoolean>;
     isCollapsed: z.ZodBoolean;
     isShared: z.ZodBoolean;
 }, "strip", z.ZodTypeAny, {
     id: string;
     isDeleted: boolean;
-    updatedAt: string;
-    childOrder: number | null;
+    updatedAt: string | null;
+    childOrder: number;
     description: string;
     isCollapsed: boolean;
-    createdAt: string;
     canAssignTasks: boolean;
     color: string;
+    createdAt: string | null;
     isArchived: boolean;
     isFavorite: boolean;
     isFrozen: boolean;
     name: string;
     viewStyle: string;
-    defaultOrder: number | null;
-    publicAccess: boolean;
+    defaultOrder: number;
     isShared: boolean;
-    parentId?: string | null | undefined;
-    inboxProject?: boolean | undefined;
 }, {
     id: string;
     isDeleted: boolean;
-    updatedAt: string;
-    childOrder: number | null;
+    updatedAt: string | null;
+    childOrder: number;
     description: string;
     isCollapsed: boolean;
-    createdAt: string;
     canAssignTasks: boolean;
     color: string;
+    createdAt: string | null;
     isArchived: boolean;
     isFavorite: boolean;
     isFrozen: boolean;
     name: string;
     viewStyle: string;
-    defaultOrder: number | null;
-    publicAccess: boolean;
+    defaultOrder: number;
     isShared: boolean;
-    parentId?: string | null | undefined;
-    inboxProject?: boolean | undefined;
 }>;
-export interface RawProject extends z.infer<typeof RawProjectSchema> {
-}
-export declare const ProjectSchema: z.ZodObject<{
+/**
+ * Schema for personal projects in Todoist.
+ */
+export declare const PersonalProjectSchema: z.ZodEffects<z.ZodObject<z.objectUtil.extendShape<{
     id: z.ZodString;
-    parentId: z.ZodNullable<z.ZodString>;
-    order: z.ZodNullable<z.ZodNumber>;
+    canAssignTasks: z.ZodBoolean;
+    childOrder: z.ZodNumber;
     color: z.ZodString;
-    name: z.ZodString;
-    isShared: z.ZodBoolean;
+    createdAt: z.ZodNullable<z.ZodString>;
+    isArchived: z.ZodBoolean;
+    isDeleted: z.ZodBoolean;
     isFavorite: z.ZodBoolean;
-    isInboxProject: z.ZodBoolean;
-    isTeamInbox: z.ZodBoolean;
-    url: z.ZodString;
+    isFrozen: z.ZodBoolean;
+    name: z.ZodString;
+    updatedAt: z.ZodNullable<z.ZodString>;
     viewStyle: z.ZodString;
-}, "strip", z.ZodTypeAny, {
+    defaultOrder: z.ZodNumber;
+    description: z.ZodString;
+    isCollapsed: z.ZodBoolean;
+    isShared: z.ZodBoolean;
+}, {
+    parentId: z.ZodNullable<z.ZodString>;
+    inboxProject: z.ZodBoolean;
+}>, "strip", z.ZodTypeAny, {
     id: string;
     parentId: string | null;
-    order: number | null;
+    isDeleted: boolean;
+    updatedAt: string | null;
+    childOrder: number;
+    description: string;
+    isCollapsed: boolean;
+    canAssignTasks: boolean;
+    color: string;
+    createdAt: string | null;
+    isArchived: boolean;
+    isFavorite: boolean;
+    isFrozen: boolean;
+    name: string;
+    viewStyle: string;
+    defaultOrder: number;
+    isShared: boolean;
+    inboxProject: boolean;
+}, {
+    id: string;
+    parentId: string | null;
+    isDeleted: boolean;
+    updatedAt: string | null;
+    childOrder: number;
+    description: string;
+    isCollapsed: boolean;
+    canAssignTasks: boolean;
+    color: string;
+    createdAt: string | null;
+    isArchived: boolean;
+    isFavorite: boolean;
+    isFrozen: boolean;
+    name: string;
+    viewStyle: string;
+    defaultOrder: number;
+    isShared: boolean;
+    inboxProject: boolean;
+}>, {
     url: string;
+    id: string;
+    parentId: string | null;
+    isDeleted: boolean;
+    updatedAt: string | null;
+    childOrder: number;
+    description: string;
+    isCollapsed: boolean;
+    canAssignTasks: boolean;
     color: string;
+    createdAt: string | null;
+    isArchived: boolean;
     isFavorite: boolean;
+    isFrozen: boolean;
     name: string;
     viewStyle: string;
+    defaultOrder: number;
     isShared: boolean;
-    isInboxProject: boolean;
-    isTeamInbox: boolean;
+    inboxProject: boolean;
 }, {
     id: string;
     parentId: string | null;
-    order: number | null;
+    isDeleted: boolean;
+    updatedAt: string | null;
+    childOrder: number;
+    description: string;
+    isCollapsed: boolean;
+    canAssignTasks: boolean;
+    color: string;
+    createdAt: string | null;
+    isArchived: boolean;
+    isFavorite: boolean;
+    isFrozen: boolean;
+    name: string;
+    viewStyle: string;
+    defaultOrder: number;
+    isShared: boolean;
+    inboxProject: boolean;
+}>;
+/**
+ * Schema for workspace projects in Todoist.
+ */
+export declare const WorkspaceProjectSchema: z.ZodEffects<z.ZodObject<z.objectUtil.extendShape<{
+    id: z.ZodString;
+    canAssignTasks: z.ZodBoolean;
+    childOrder: z.ZodNumber;
+    color: z.ZodString;
+    createdAt: z.ZodNullable<z.ZodString>;
+    isArchived: z.ZodBoolean;
+    isDeleted: z.ZodBoolean;
+    isFavorite: z.ZodBoolean;
+    isFrozen: z.ZodBoolean;
+    name: z.ZodString;
+    updatedAt: z.ZodNullable<z.ZodString>;
+    viewStyle: z.ZodString;
+    defaultOrder: z.ZodNumber;
+    description: z.ZodString;
+    isCollapsed: z.ZodBoolean;
+    isShared: z.ZodBoolean;
+}, {
+    collaboratorRoleDefault: z.ZodString;
+    folderId: z.ZodNullable<z.ZodBoolean>;
+    isInviteOnly: z.ZodNullable<z.ZodBoolean>;
+    isLinkSharingEnabled: z.ZodBoolean;
+    role: z.ZodNullable<z.ZodString>;
+    status: z.ZodString;
+    workspaceId: z.ZodString;
+}>, "strip", z.ZodTypeAny, {
+    status: string;
+    id: string;
+    isDeleted: boolean;
+    updatedAt: string | null;
+    childOrder: number;
+    description: string;
+    isCollapsed: boolean;
+    canAssignTasks: boolean;
+    color: string;
+    createdAt: string | null;
+    isArchived: boolean;
+    isFavorite: boolean;
+    isFrozen: boolean;
+    name: string;
+    viewStyle: string;
+    defaultOrder: number;
+    isShared: boolean;
+    collaboratorRoleDefault: string;
+    folderId: boolean | null;
+    isInviteOnly: boolean | null;
+    isLinkSharingEnabled: boolean;
+    role: string | null;
+    workspaceId: string;
+}, {
+    status: string;
+    id: string;
+    isDeleted: boolean;
+    updatedAt: string | null;
+    childOrder: number;
+    description: string;
+    isCollapsed: boolean;
+    canAssignTasks: boolean;
+    color: string;
+    createdAt: string | null;
+    isArchived: boolean;
+    isFavorite: boolean;
+    isFrozen: boolean;
+    name: string;
+    viewStyle: string;
+    defaultOrder: number;
+    isShared: boolean;
+    collaboratorRoleDefault: string;
+    folderId: boolean | null;
+    isInviteOnly: boolean | null;
+    isLinkSharingEnabled: boolean;
+    role: string | null;
+    workspaceId: string;
+}>, {
     url: string;
+    status: string;
+    id: string;
+    isDeleted: boolean;
+    updatedAt: string | null;
+    childOrder: number;
+    description: string;
+    isCollapsed: boolean;
+    canAssignTasks: boolean;
     color: string;
+    createdAt: string | null;
+    isArchived: boolean;
     isFavorite: boolean;
+    isFrozen: boolean;
     name: string;
     viewStyle: string;
+    defaultOrder: number;
     isShared: boolean;
-    isInboxProject: boolean;
-    isTeamInbox: boolean;
+    collaboratorRoleDefault: string;
+    folderId: boolean | null;
+    isInviteOnly: boolean | null;
+    isLinkSharingEnabled: boolean;
+    role: string | null;
+    workspaceId: string;
+}, {
+    status: string;
+    id: string;
+    isDeleted: boolean;
+    updatedAt: string | null;
+    childOrder: number;
+    description: string;
+    isCollapsed: boolean;
+    canAssignTasks: boolean;
+    color: string;
+    createdAt: string | null;
+    isArchived: boolean;
+    isFavorite: boolean;
+    isFrozen: boolean;
+    name: string;
+    viewStyle: string;
+    defaultOrder: number;
+    isShared: boolean;
+    collaboratorRoleDefault: string;
+    folderId: boolean | null;
+    isInviteOnly: boolean | null;
+    isLinkSharingEnabled: boolean;
+    role: string | null;
+    workspaceId: string;
 }>;
 /**
- * Represents a project in Todoist.
+ * Represents a personal project in Todoist.
+ * @see https://todoist.com/api/v1/docs#tag/Projects
+ */
+export interface PersonalProject extends z.infer<typeof PersonalProjectSchema> {
+}
+/**
+ * Represents a workspace project in Todoist.
  * @see https://todoist.com/api/v1/docs#tag/Projects
  */
-export interface Project extends z.infer<typeof ProjectSchema> {
+export interface WorkspaceProject extends z.infer<typeof WorkspaceProjectSchema> {
 }
 /**
  * @see https://todoist.com/api/v1/docs#tag/Projects
@@ -453,8 +596,8 @@ export declare const SectionSchema: z.ZodObject<{
     isDeleted: z.ZodBoolean;
     isCollapsed: z.ZodBoolean;
 }, "strip", z.ZodTypeAny, {
-    userId: string;
     id: string;
+    userId: string;
     projectId: string;
     isDeleted: boolean;
     addedAt: string;
@@ -465,8 +608,8 @@ export declare const SectionSchema: z.ZodObject<{
     archivedAt: string | null;
     sectionOrder: number;
 }, {
-    userId: string;
     id: string;
+    userId: string;
     projectId: string;
     isDeleted: boolean;
     addedAt: string;
@@ -491,16 +634,16 @@ export declare const LabelSchema: z.ZodObject<{
     isFavorite: z.ZodBoolean;
 }, "strip", z.ZodTypeAny, {
     id: string;
-    order: number | null;
     color: string;
     isFavorite: boolean;
     name: string;
+    order: number | null;
 }, {
     id: string;
-    order: number | null;
     color: string;
     isFavorite: boolean;
     name: string;
+    order: number | null;
 }>;
 /**
  * Represents a label in Todoist.