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

package/dist/types/entities.d.ts

@@ -1,188 +1,487 @@
-import { Boolean, Number as NumberRunType, String, Array, Record, Static, Partial, Literal, Union } from 'runtypes';
-export declare const Int: import("runtypes").Constraint<NumberRunType, number, unknown>;
-export type TodoistEntity = {
+import { z } from 'zod';
+export declare const DueDateSchema: 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;
+}>;
+/**
+ * Represents a due date for a task.
+ * @see https://developer.todoist.com/sync/v9/#due-dates
+ */
+export interface DueDate extends z.infer<typeof DueDateSchema> {
+}
+export declare const DurationSchema: z.ZodObject<{
+    amount: z.ZodNumber;
+    unit: z.ZodEnum<["minute", "day"]>;
+}, "strip", z.ZodTypeAny, {
+    amount: number;
+    unit: "minute" | "day";
+}, {
+    amount: number;
+    unit: "minute" | "day";
+}>;
+/**
+ * Represents the duration of a task.
+ * @see https://developer.todoist.com/sync/v9/#deadlines
+ */
+export interface Duration extends z.infer<typeof DurationSchema> {
+}
+export declare const DeadlineSchema: z.ZodObject<{
+    date: z.ZodString;
+    lang: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    date: string;
+    lang: string;
+}, {
+    date: string;
+    lang: string;
+}>;
+/**
+ * Represents a task deadline.
+ */
+export interface Deadline extends z.infer<typeof DeadlineSchema> {
+}
+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;
+    commentCount: 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, {
     id: string;
-};
-export type OrderedEntity = TodoistEntity & {
+    assignerId: string | null;
+    assigneeId: string | null;
+    projectId: string;
+    sectionId: string | null;
+    parentId: string | null;
+    order: number;
+    content: string;
+    description: string;
+    isCompleted: boolean;
+    labels: string[];
+    priority: number;
+    commentCount: number;
+    creatorId: string;
+    createdAt: string;
+    due: {
+        string: string;
+        isRecurring: boolean;
+        date: string;
+        datetime?: string | null | undefined;
+        timezone?: string | null | undefined;
+        lang?: string | null | undefined;
+    } | null;
+    url: string;
+    duration: {
+        amount: number;
+        unit: "minute" | "day";
+    } | null;
+    deadline: {
+        date: string;
+        lang: string;
+    } | null;
+}, {
+    id: string;
+    assignerId: string | null;
+    assigneeId: string | null;
+    projectId: string;
+    sectionId: string | null;
+    parentId: string | null;
     order: number;
-};
-export type EntityInHierarchy = OrderedEntity & {
-    parentId?: string | null;
-};
-export declare const DueDate: import("runtypes").Intersect<[Record<{
-    isRecurring: Boolean;
-    string: String;
-    date: String;
-}, false>, Partial<{
-    datetime: Union<[String, Literal<null>]>;
-    timezone: Union<[String, Literal<null>]>;
-    lang: Union<[String, Literal<null>]>;
-}, false>]>;
-export type DueDate = Static<typeof DueDate>;
-export declare const Duration: Record<{
-    amount: import("runtypes").Constraint<NumberRunType, number, unknown>;
-    unit: Union<[Literal<"minute">, Literal<"day">]>;
-}, false>;
-export type Duration = Static<typeof Duration>;
-export declare const Deadline: Record<{
-    date: String;
-    lang: String;
-}, false>;
-export type Deadline = Static<typeof Deadline>;
-export declare const Task: Record<{
-    id: String;
-    assignerId: Union<[String, Literal<null>]>;
-    assigneeId: Union<[String, Literal<null>]>;
-    projectId: String;
-    sectionId: Union<[String, Literal<null>]>;
-    parentId: Union<[String, Literal<null>]>;
-    order: import("runtypes").Constraint<NumberRunType, number, unknown>;
-    content: String;
-    description: String;
-    isCompleted: Boolean;
-    labels: Array<String, false>;
-    priority: import("runtypes").Constraint<NumberRunType, number, unknown>;
-    commentCount: import("runtypes").Constraint<NumberRunType, number, unknown>;
-    creatorId: String;
-    createdAt: String;
-    due: Union<[import("runtypes").Intersect<[Record<{
-        isRecurring: Boolean;
-        string: String;
-        date: String;
-    }, false>, Partial<{
-        datetime: Union<[String, Literal<null>]>;
-        timezone: Union<[String, Literal<null>]>;
-        lang: Union<[String, Literal<null>]>;
-    }, false>]>, Literal<null>]>;
-    url: String;
-    duration: Union<[Record<{
-        amount: import("runtypes").Constraint<NumberRunType, number, unknown>;
-        unit: Union<[Literal<"minute">, Literal<"day">]>;
-    }, false>, Literal<null>]>;
-    deadline: Union<[Record<{
-        date: String;
-        lang: String;
-    }, false>, Literal<null>]>;
-}, false>;
-export type Task = Static<typeof Task>;
-export declare const Project: Record<{
-    id: String;
-    parentId: Union<[String, Literal<null>]>;
-    order: Union<[import("runtypes").Constraint<NumberRunType, number, unknown>, Literal<null>]>;
-    color: String;
-    name: String;
-    commentCount: import("runtypes").Constraint<NumberRunType, number, unknown>;
-    isShared: Boolean;
-    isFavorite: Boolean;
-    isInboxProject: Boolean;
-    isTeamInbox: Boolean;
-    url: String;
-    viewStyle: String;
-}, false>;
-export type Project = Static<typeof Project>;
+    content: string;
+    description: string;
+    isCompleted: boolean;
+    labels: string[];
+    priority: number;
+    commentCount: number;
+    creatorId: string;
+    createdAt: string;
+    due: {
+        string: string;
+        isRecurring: boolean;
+        date: string;
+        datetime?: string | null | undefined;
+        timezone?: string | null | undefined;
+        lang?: string | null | undefined;
+    } | null;
+    url: string;
+    duration: {
+        amount: number;
+        unit: "minute" | "day";
+    } | null;
+    deadline: {
+        date: string;
+        lang: string;
+    } | null;
+}>;
+/**
+ * A task is a unit of work. It can be a simple to-do item or a more complex task with subtasks, comments, and attachments.
+ * @see https://developer.todoist.com/sync/v9/#items
+ */
+export interface Task extends z.infer<typeof TaskSchema> {
+}
+export declare const ProjectSchema: z.ZodObject<{
+    id: z.ZodString;
+    parentId: z.ZodNullable<z.ZodString>;
+    order: z.ZodNullable<z.ZodNumber>;
+    color: z.ZodString;
+    name: z.ZodString;
+    commentCount: z.ZodNumber;
+    isShared: z.ZodBoolean;
+    isFavorite: z.ZodBoolean;
+    isInboxProject: z.ZodBoolean;
+    isTeamInbox: z.ZodBoolean;
+    url: z.ZodString;
+    viewStyle: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    parentId: string | null;
+    order: number | null;
+    commentCount: number;
+    url: string;
+    color: string;
+    name: string;
+    isShared: boolean;
+    isFavorite: boolean;
+    isInboxProject: boolean;
+    isTeamInbox: boolean;
+    viewStyle: string;
+}, {
+    id: string;
+    parentId: string | null;
+    order: number | null;
+    commentCount: number;
+    url: string;
+    color: string;
+    name: string;
+    isShared: boolean;
+    isFavorite: boolean;
+    isInboxProject: boolean;
+    isTeamInbox: boolean;
+    viewStyle: string;
+}>;
+/**
+ * Represents a project in Todoist, which can contain multiple tasks.
+ * @see https://developer.todoist.com/sync/v9/#projects
+ */
+export interface Project extends z.infer<typeof ProjectSchema> {
+}
+/**
+ * @see https://developer.todoist.com/sync/v9/#projects
+ */
 export type ProjectViewStyle = 'list' | 'board' | 'calendar';
-export declare const Section: Record<{
-    id: String;
-    order: import("runtypes").Constraint<NumberRunType, number, unknown>;
-    name: String;
-    projectId: String;
-}, false>;
-export type Section = Static<typeof Section>;
-export declare const Label: Record<{
-    id: String;
-    order: Union<[import("runtypes").Constraint<NumberRunType, number, unknown>, Literal<null>]>;
-    name: String;
-    color: String;
-    isFavorite: Boolean;
-}, false>;
-export type Label = Static<typeof Label>;
-export declare const Attachment: import("runtypes").Intersect<[Record<{
-    resourceType: String;
-}, false>, Partial<{
-    fileName: Union<[String, Literal<null>]>;
-    fileSize: Union<[import("runtypes").Constraint<NumberRunType, number, unknown>, Literal<null>]>;
-    fileType: Union<[String, Literal<null>]>;
-    fileUrl: Union<[String, Literal<null>]>;
-    fileDuration: Union<[import("runtypes").Constraint<NumberRunType, number, unknown>, Literal<null>]>;
-    uploadState: Union<[Union<[Literal<"pending">, Literal<"completed">]>, Literal<null>]>;
-    image: Union<[String, Literal<null>]>;
-    imageWidth: Union<[import("runtypes").Constraint<NumberRunType, number, unknown>, Literal<null>]>;
-    imageHeight: Union<[import("runtypes").Constraint<NumberRunType, number, unknown>, Literal<null>]>;
-    url: Union<[String, Literal<null>]>;
-    title: Union<[String, Literal<null>]>;
-}, false>]>;
-export type Attachment = Static<typeof Attachment>;
-export declare const Comment: Record<{
-    id: String;
-    taskId: Union<[String, Literal<null>]>;
-    projectId: Union<[String, Literal<null>]>;
-    content: String;
-    postedAt: String;
-    attachment: Union<[import("runtypes").Intersect<[Record<{
-        resourceType: String;
-    }, false>, Partial<{
-        fileName: Union<[String, Literal<null>]>;
-        fileSize: Union<[import("runtypes").Constraint<NumberRunType, number, unknown>, Literal<null>]>;
-        fileType: Union<[String, Literal<null>]>;
-        fileUrl: Union<[String, Literal<null>]>;
-        fileDuration: Union<[import("runtypes").Constraint<NumberRunType, number, unknown>, Literal<null>]>;
-        uploadState: Union<[Union<[Literal<"pending">, Literal<"completed">]>, Literal<null>]>;
-        image: Union<[String, Literal<null>]>;
-        imageWidth: Union<[import("runtypes").Constraint<NumberRunType, number, unknown>, Literal<null>]>;
-        imageHeight: Union<[import("runtypes").Constraint<NumberRunType, number, unknown>, Literal<null>]>;
-        url: Union<[String, Literal<null>]>;
-        title: Union<[String, Literal<null>]>;
-    }, false>]>, Literal<null>]>;
-}, false>;
-export type Comment = Static<typeof Comment>;
-export declare const User: Record<{
-    id: String;
-    name: String;
-    email: String;
-}, false>;
-export type User = Static<typeof User>;
-export type Color = {
+export declare const SectionSchema: z.ZodObject<{
+    id: z.ZodString;
+    order: z.ZodNumber;
+    name: z.ZodString;
+    projectId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    projectId: string;
+    order: number;
+    name: string;
+}, {
+    id: string;
+    projectId: string;
+    order: number;
+    name: string;
+}>;
+/**
+ * Represents a section within a project, used to group tasks.
+ * @see https://developer.todoist.com/sync/v9/#sections
+ */
+export interface Section extends z.infer<typeof SectionSchema> {
+}
+export declare const LabelSchema: z.ZodObject<{
+    id: z.ZodString;
+    order: z.ZodNullable<z.ZodNumber>;
+    name: z.ZodString;
+    color: z.ZodString;
+    isFavorite: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    order: number | null;
+    color: string;
+    name: string;
+    isFavorite: boolean;
+}, {
+    id: string;
+    order: number | null;
+    color: string;
+    name: string;
+    isFavorite: boolean;
+}>;
+/**
+ * Represents a label in Todoist, which is used to categorize tasks.
+ * @see https://developer.todoist.com/sync/v9/#labels
+ */
+export interface Label extends z.infer<typeof LabelSchema> {
+}
+export declare const AttachmentSchema: z.ZodObject<z.objectUtil.extendShape<{
+    resourceType: z.ZodString;
+}, {
+    fileName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    fileSize: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    fileType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    fileUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    fileDuration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    uploadState: z.ZodOptional<z.ZodNullable<z.ZodEnum<["pending", "completed"]>>>;
+    image: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    imageWidth: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    imageHeight: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}>, "strip", z.ZodTypeAny, {
+    resourceType: string;
+    url?: string | null | undefined;
+    fileName?: string | null | undefined;
+    fileSize?: number | null | undefined;
+    fileType?: string | null | undefined;
+    fileUrl?: string | null | undefined;
+    fileDuration?: number | null | undefined;
+    uploadState?: "pending" | "completed" | null | undefined;
+    image?: string | null | undefined;
+    imageWidth?: number | null | undefined;
+    imageHeight?: number | null | undefined;
+    title?: string | null | undefined;
+}, {
+    resourceType: string;
+    url?: string | null | undefined;
+    fileName?: string | null | undefined;
+    fileSize?: number | null | undefined;
+    fileType?: string | null | undefined;
+    fileUrl?: string | null | undefined;
+    fileDuration?: number | null | undefined;
+    uploadState?: "pending" | "completed" | null | undefined;
+    image?: string | null | undefined;
+    imageWidth?: number | null | undefined;
+    imageHeight?: number | null | undefined;
+    title?: string | null | undefined;
+}>;
+/**
+ * Represents an attachment associated with a comment in Todoist.
+ * @see https://developer.todoist.com/sync/v9/#file-attachments
+ */
+export interface Attachment extends z.infer<typeof AttachmentSchema> {
+}
+export declare const CommentSchema: z.ZodObject<{
+    id: z.ZodString;
+    taskId: z.ZodNullable<z.ZodString>;
+    projectId: z.ZodNullable<z.ZodString>;
+    content: z.ZodString;
+    postedAt: z.ZodString;
+    attachment: z.ZodNullable<z.ZodObject<z.objectUtil.extendShape<{
+        resourceType: z.ZodString;
+    }, {
+        fileName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        fileSize: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        fileType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        fileUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        fileDuration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        uploadState: z.ZodOptional<z.ZodNullable<z.ZodEnum<["pending", "completed"]>>>;
+        image: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        imageWidth: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        imageHeight: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }>, "strip", z.ZodTypeAny, {
+        resourceType: string;
+        url?: string | null | undefined;
+        fileName?: string | null | undefined;
+        fileSize?: number | null | undefined;
+        fileType?: string | null | undefined;
+        fileUrl?: string | null | undefined;
+        fileDuration?: number | null | undefined;
+        uploadState?: "pending" | "completed" | null | undefined;
+        image?: string | null | undefined;
+        imageWidth?: number | null | undefined;
+        imageHeight?: number | null | undefined;
+        title?: string | null | undefined;
+    }, {
+        resourceType: string;
+        url?: string | null | undefined;
+        fileName?: string | null | undefined;
+        fileSize?: number | null | undefined;
+        fileType?: string | null | undefined;
+        fileUrl?: string | null | undefined;
+        fileDuration?: number | null | undefined;
+        uploadState?: "pending" | "completed" | null | undefined;
+        image?: string | null | undefined;
+        imageWidth?: number | null | undefined;
+        imageHeight?: number | null | undefined;
+        title?: string | null | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    projectId: string | null;
+    content: string;
+    taskId: string | null;
+    postedAt: string;
+    attachment: {
+        resourceType: string;
+        url?: string | null | undefined;
+        fileName?: string | null | undefined;
+        fileSize?: number | null | undefined;
+        fileType?: string | null | undefined;
+        fileUrl?: string | null | undefined;
+        fileDuration?: number | null | undefined;
+        uploadState?: "pending" | "completed" | null | undefined;
+        image?: string | null | undefined;
+        imageWidth?: number | null | undefined;
+        imageHeight?: number | null | undefined;
+        title?: string | null | undefined;
+    } | null;
+}, {
+    id: string;
+    projectId: string | null;
+    content: string;
+    taskId: string | null;
+    postedAt: string;
+    attachment: {
+        resourceType: string;
+        url?: string | null | undefined;
+        fileName?: string | null | undefined;
+        fileSize?: number | null | undefined;
+        fileType?: string | null | undefined;
+        fileUrl?: string | null | undefined;
+        fileDuration?: number | null | undefined;
+        uploadState?: "pending" | "completed" | null | undefined;
+        image?: string | null | undefined;
+        imageWidth?: number | null | undefined;
+        imageHeight?: number | null | undefined;
+        title?: string | null | undefined;
+    } | null;
+}>;
+/**
+ * Represents a comment on a task or project in Todoist.
+ * @see https://developer.todoist.com/sync/v9/#notes
+ */
+export interface Comment extends z.infer<typeof CommentSchema> {
+}
+export declare const UserSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    email: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    name: string;
+    email: string;
+}, {
+    id: string;
+    name: string;
+    email: string;
+}>;
+/**
+ * Represents a user in Todoist.
+ * @see https://developer.todoist.com/sync/v9/#user
+ */
+export interface User extends z.infer<typeof UserSchema> {
+}
+export declare const ColorSchema: z.ZodObject<{
+    /** @deprecated No longer used */
+    id: z.ZodNumber;
+    /** The key of the color (i.e. 'berry_red') */
+    key: z.ZodString;
+    /** The display name of the color (i.e. 'Berry Red') */
+    displayName: z.ZodString;
+    /** @deprecated Use {@link Color.displayName} instead */
+    name: z.ZodString;
+    /** The hex value of the color (i.e. '#b8255f') */
+    hexValue: z.ZodString;
     /**
-     * @deprecated No longer used
+     * @deprecated Use {@link Color.hexValue} instead
      */
+    value: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    value: string;
     id: number;
-    /**
-     * The key of the color (i.e. 'berry_red')
-     */
+    name: string;
     key: string;
-    /**
-     * The display name of the color (i.e. 'Berry Red')
-     */
     displayName: string;
-    /**
-     * @deprecated Use {@link Color.displayName} instead
-     */
-    name: string;
-    /**
-     * The hex value of the color (i.e. '#b8255f')
-     */
     hexValue: string;
-    /**
-     * @deprecated Use {@link Color.hexValue} instead
-     */
+}, {
     value: string;
-};
-export type QuickAddTaskResponse = {
-    id: string;
-    projectId: string;
-    content: string;
-    description: string;
-    priority: number;
-    sectionId: string | null;
-    parentId: string | null;
-    childOrder: number;
-    labels: string[];
-    assignedByUid: string | null;
-    responsibleUid: string | null;
-    checked: boolean;
-    addedAt: string;
-    addedByUid: string | null;
-    duration: Duration | null;
-    due: DueDate | null;
-    deadline: Deadline | null;
-};
+    id: number;
+    name: string;
+    key: string;
+    displayName: string;
+    hexValue: string;
+}>;
+/**
+ * Represents a color in Todoist, used for projects, labels, or other visual elements.
+ * @see https://developer.todoist.com/guides/#colors
+ */
+export interface Color extends z.infer<typeof ColorSchema> {
+}