@doist/todoist-api-typescript 7.6.0 → 7.7.0

package/dist/types/types/workspaces/requests.d.ts

@@ -0,0 +1,260 @@
+import type { MemberActivityInfo, WorkspaceInvitation, WorkspaceRole, WorkspaceUser, WorkspaceUserTask } from './types.js';
+/**
+ * Arguments for creating a new workspace.
+ * @see https://developer.todoist.com/api/v1/#tag/Workspace/operation/create_workspace_api_v1_workspaces_post
+ */
+export type AddWorkspaceArgs = {
+    /** Name of the workspace. */
+    name: string;
+    /** Description of the workspace. */
+    description?: string | null;
+    /** Whether link sharing is enabled for the workspace. */
+    isLinkSharingEnabled?: boolean;
+    /** Whether guests are allowed in the workspace. */
+    isGuestAllowed?: boolean;
+    /** Workspace email domain. */
+    domainName?: string | null;
+    /** Whether users with matching email domains can discover this workspace. */
+    domainDiscovery?: boolean;
+    /** Whether workspace invites are restricted to workspace domain. */
+    restrictEmailDomains?: boolean;
+    /** Workspace properties. */
+    properties?: Record<string, unknown> | null;
+};
+/**
+ * Arguments for updating an existing workspace.
+ * @see https://developer.todoist.com/api/v1/#tag/Workspace/operation/update_workspace_api_v1_workspaces__workspace_id__post
+ */
+export type UpdateWorkspaceArgs = {
+    /** Updated workspace name. */
+    name?: string;
+    /** Updated workspace description. */
+    description?: string | null;
+    /** Updated link sharing status. */
+    isLinkSharingEnabled?: boolean;
+    /** Updated guest access status. */
+    isGuestAllowed?: boolean | null;
+    /** Updated workspace email domain. */
+    domainName?: string | null;
+    /** Updated domain discovery setting. */
+    domainDiscovery?: boolean;
+    /** Updated email domain restriction setting. */
+    restrictEmailDomains?: boolean;
+    /** Updated workspace properties. */
+    properties?: Record<string, unknown> | null;
+    /** Updated collapse state for current user. */
+    isCollapsed?: boolean;
+};
+/**
+ * Arguments for getting workspace members activity.
+ * @see https://developer.todoist.com/api/v1/#tag/Workspace/operation/get_workspace_members_activity_api_v1_workspaces_members_get
+ */
+export type GetWorkspaceMembersActivityArgs = {
+    /** The workspace ID. */
+    workspaceId: string;
+    /** Comma-separated list of user IDs to filter by. */
+    userIds?: string | null;
+    /** Comma-separated list of project IDs to filter by. */
+    projectIds?: string | null;
+};
+/**
+ * Response from getting workspace members activity.
+ */
+export type GetWorkspaceMembersActivityResponse = {
+    members: MemberActivityInfo[];
+};
+/**
+ * Arguments for getting tasks assigned to a workspace user.
+ * @see https://developer.todoist.com/api/v1/#tag/Workspace/operation/get_workspace_user_tasks_api_v1_workspaces__workspace_id__users__user_id__tasks_get
+ */
+export type GetWorkspaceUserTasksArgs = {
+    /** The workspace ID. */
+    workspaceId: string;
+    /** The user ID. */
+    userId: string;
+    /** Comma-separated list of project IDs to filter by. */
+    projectIds?: string | null;
+};
+/**
+ * Response from getting workspace user tasks.
+ */
+export type GetWorkspaceUserTasksResponse = {
+    tasks: WorkspaceUserTask[];
+};
+/**
+ * Arguments for inviting users to a workspace.
+ * @see https://developer.todoist.com/api/v1/#tag/Workspace/operation/invite_workspace_users_api_v1_workspaces__workspace_id__users_invite_post
+ */
+export type InviteWorkspaceUsersArgs = {
+    /** The workspace ID. */
+    workspaceId: string;
+    /** List of user emails to invite. */
+    emailList: string[];
+    /** Role assigned to invited users. */
+    role?: WorkspaceRole;
+};
+/**
+ * Response from inviting workspace users.
+ */
+export type InviteWorkspaceUsersResponse = {
+    invitedEmails: string[];
+};
+/**
+ * Arguments for updating a workspace user's role.
+ * @see https://developer.todoist.com/api/v1/#tag/Workspace/operation/update_workspace_user_api_v1_workspaces__workspace_id__users__user_id__post
+ */
+export type UpdateWorkspaceUserArgs = {
+    /** The workspace ID. */
+    workspaceId: string;
+    /** The user ID. */
+    userId: string;
+    /** Updated role for the user. */
+    role: WorkspaceRole;
+};
+/**
+ * Arguments for removing a user from a workspace.
+ * @see https://developer.todoist.com/api/v1/#tag/Workspace/operation/remove_workspace_user_api_v1_workspaces__workspace_id__users__user_id__delete
+ */
+export type RemoveWorkspaceUserArgs = {
+    /** The workspace ID. */
+    workspaceId: string;
+    /** The user ID. */
+    userId: string;
+};
+/**
+ * Arguments for getting workspace invitations.
+ */
+export type GetWorkspaceInvitationsArgs = {
+    /**
+     * The workspace ID to get invitations for.
+     */
+    workspaceId: number;
+};
+/**
+ * Arguments for deleting a workspace invitation.
+ */
+export type DeleteWorkspaceInvitationArgs = {
+    /**
+     * The workspace ID.
+     */
+    workspaceId: number;
+    /**
+     * The email address of the invitation to delete.
+     */
+    userEmail: string;
+};
+/**
+ * Arguments for accepting/rejecting a workspace invitation.
+ */
+export type WorkspaceInvitationActionArgs = {
+    /**
+     * The invitation code from the email.
+     */
+    inviteCode: string;
+};
+/**
+ * Arguments for joining a workspace.
+ */
+export type JoinWorkspaceArgs = {
+    /**
+     * Optional invitation code/link to join via.
+     */
+    inviteCode?: string | null;
+    /**
+     * Optional workspace ID to join via domain auto-join.
+     */
+    workspaceId?: number | null;
+};
+/**
+ * Arguments for uploading/updating workspace logo.
+ */
+export type WorkspaceLogoArgs = {
+    /**
+     * The workspace ID.
+     */
+    workspaceId: number;
+    /**
+     * The image file to upload (Buffer, Stream, or file path).
+     */
+    file?: Buffer | NodeJS.ReadableStream | string | Blob;
+    /**
+     * The file name (required for Buffer/Stream uploads).
+     */
+    fileName?: string;
+    /**
+     * Whether to delete the logo instead of updating it.
+     */
+    delete?: boolean;
+};
+/**
+ * Arguments for getting workspace plan details.
+ */
+export type GetWorkspacePlanDetailsArgs = {
+    /**
+     * The workspace ID.
+     */
+    workspaceId: number;
+};
+/**
+ * Arguments for getting workspace users (paginated).
+ */
+export type GetWorkspaceUsersArgs = {
+    /**
+     * Optional workspace ID. If not provided, returns users for all workspaces.
+     */
+    workspaceId?: number | null;
+    /**
+     * Cursor for pagination.
+     */
+    cursor?: string | null;
+    /**
+     * Maximum number of users to return (default: 100).
+     */
+    limit?: number;
+};
+/**
+ * Arguments for getting workspace projects (paginated).
+ */
+export type GetWorkspaceProjectsArgs = {
+    /**
+     * The workspace ID.
+     */
+    workspaceId: number;
+    /**
+     * Cursor for pagination.
+     */
+    cursor?: string | null;
+    /**
+     * Maximum number of projects to return (default: 100).
+     */
+    limit?: number;
+};
+/**
+ * Paginated response for workspace users.
+ */
+export type GetWorkspaceUsersResponse = {
+    /**
+     * Whether there are more users available.
+     */
+    hasMore: boolean;
+    /**
+     * Cursor for the next page of results.
+     */
+    nextCursor?: string;
+    /**
+     * Array of workspace users.
+     */
+    workspaceUsers: WorkspaceUser[];
+};
+/**
+ * Response type for workspace invitations endpoint (simple email list).
+ */
+export type WorkspaceInvitationsResponse = string[];
+/**
+ * Response type for all workspace invitations endpoint (detailed objects).
+ */
+export type AllWorkspaceInvitationsResponse = WorkspaceInvitation[];
+/**
+ * Response type for workspace logo upload.
+ */
+export type WorkspaceLogoResponse = Record<string, unknown> | null;

package/dist/types/types/workspaces/types.d.ts

@@ -0,0 +1,225 @@
+import { z } from 'zod';
+/** Available project collaborator roles. */
+export declare const COLLABORATOR_ROLES: readonly ["CREATOR", "ADMIN", "READ_WRITE", "EDIT_ONLY", "COMPLETE_ONLY"];
+/** Role of a collaborator in a project. */
+export type CollaboratorRole = (typeof COLLABORATOR_ROLES)[number];
+/**
+ * Available workspace roles.
+ */
+export declare const WORKSPACE_ROLES: readonly ["ADMIN", "MEMBER", "GUEST"];
+/**
+ * Role of a user within a workspace.
+ */
+export type WorkspaceRole = (typeof WORKSPACE_ROLES)[number];
+export declare const WorkspaceRoleSchema: z.ZodEnum<{
+    ADMIN: "ADMIN";
+    MEMBER: "MEMBER";
+    GUEST: "GUEST";
+}>;
+export declare const WorkspaceUserSchema: z.ZodObject<{
+    userId: z.ZodString;
+    workspaceId: z.ZodString;
+    userEmail: z.ZodString;
+    fullName: z.ZodString;
+    timezone: z.ZodString;
+    role: z.ZodEnum<{
+        ADMIN: "ADMIN";
+        MEMBER: "MEMBER";
+        GUEST: "GUEST";
+    }>;
+    imageId: z.ZodNullable<z.ZodString>;
+    isDeleted: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>;
+/**
+ * Represents a user within a workspace (MemberView from API).
+ */
+export type WorkspaceUser = z.infer<typeof WorkspaceUserSchema>;
+export declare const WorkspaceInvitationSchema: z.ZodObject<{
+    id: z.ZodDefault<z.ZodString>;
+    inviterId: z.ZodString;
+    userEmail: z.ZodString;
+    workspaceId: z.ZodString;
+    role: z.ZodEnum<{
+        ADMIN: "ADMIN";
+        MEMBER: "MEMBER";
+        GUEST: "GUEST";
+    }>;
+    isExistingUser: z.ZodBoolean;
+}, z.core.$strip>;
+/**
+ * Represents a workspace invitation.
+ */
+export type WorkspaceInvitation = z.infer<typeof WorkspaceInvitationSchema>;
+export declare const PlanPriceSchema: z.ZodObject<{
+    currency: z.ZodString;
+    amount: z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>;
+    interval: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * Plan pricing information.
+ */
+export type PlanPrice = z.infer<typeof PlanPriceSchema>;
+export declare const FormattedPriceListingSchema: z.ZodObject<{
+    currency: z.ZodOptional<z.ZodString>;
+    amount: z.ZodOptional<z.ZodNumber>;
+    interval: z.ZodOptional<z.ZodString>;
+    formatted: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * Formatted price listing for workspace plans.
+ */
+export type FormattedPriceListing = z.infer<typeof FormattedPriceListingSchema>;
+/** Available workspace plan names. */
+export declare const WORKSPACE_CURRENT_PLANS: readonly ["Business", "Starter"];
+/** Display name of a workspace plan. */
+export type WorkspaceCurrentPlan = (typeof WORKSPACE_CURRENT_PLANS)[number];
+/** Available workspace plan statuses. */
+export declare const WORKSPACE_PLAN_STATUSES: readonly ["Active", "Downgraded", "Cancelled", "NeverSubscribed"];
+/** Subscription status of a workspace plan. */
+export type WorkspacePlanStatus = (typeof WORKSPACE_PLAN_STATUSES)[number];
+export declare const WorkspacePlanDetailsSchema: z.ZodObject<{
+    currentMemberCount: z.ZodNumber;
+    currentPlan: z.ZodEnum<{
+        Business: "Business";
+        Starter: "Starter";
+    }>;
+    currentPlanStatus: z.ZodEnum<{
+        Active: "Active";
+        Downgraded: "Downgraded";
+        Cancelled: "Cancelled";
+        NeverSubscribed: "NeverSubscribed";
+    }>;
+    downgradeAt: z.ZodNullable<z.ZodString>;
+    currentActiveProjects: z.ZodNumber;
+    maximumActiveProjects: z.ZodNumber;
+    priceList: z.ZodArray<z.ZodObject<{
+        currency: z.ZodOptional<z.ZodString>;
+        amount: z.ZodOptional<z.ZodNumber>;
+        interval: z.ZodOptional<z.ZodString>;
+        formatted: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    workspaceId: z.ZodNumber;
+    isTrialing: z.ZodBoolean;
+    trialEndsAt: z.ZodNullable<z.ZodString>;
+    cancelAtPeriodEnd: z.ZodBoolean;
+    hasTrialed: z.ZodBoolean;
+    planPrice: z.ZodNullable<z.ZodObject<{
+        currency: z.ZodString;
+        amount: z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>;
+        interval: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    hasBillingPortal: z.ZodBoolean;
+    hasBillingPortalSwitchToAnnual: z.ZodBoolean;
+}, z.core.$strip>;
+/**
+ * Represents workspace plan and billing details.
+ */
+export type WorkspacePlanDetails = z.infer<typeof WorkspacePlanDetailsSchema>;
+export declare const JoinWorkspaceResultSchema: z.ZodObject<{
+    customSortingApplied: z.ZodBoolean;
+    projectSortPreference: z.ZodString;
+    role: z.ZodEnum<{
+        ADMIN: "ADMIN";
+        MEMBER: "MEMBER";
+        GUEST: "GUEST";
+    }>;
+    userId: z.ZodString;
+    workspaceId: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Result returned when successfully joining a workspace.
+ */
+export type JoinWorkspaceResult = z.infer<typeof JoinWorkspaceResultSchema>;
+/**
+ * Available workspace plans.
+ */
+export declare const WORKSPACE_PLANS: readonly ["STARTER", "BUSINESS"];
+/**
+ * Workspace plan type.
+ */
+export type WorkspacePlan = (typeof WORKSPACE_PLANS)[number];
+export declare const WorkspacePlanSchema: z.ZodEnum<{
+    STARTER: "STARTER";
+    BUSINESS: "BUSINESS";
+}>;
+/**
+ * Workspace resource limits.
+ */
+export declare const WorkspaceLimitsSchema: z.ZodObject<{
+    current: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    next: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>;
+}, z.core.$catchall<z.ZodAny>>;
+export type WorkspaceLimits = z.infer<typeof WorkspaceLimitsSchema>;
+/**
+ * Workspace properties (flexible object for unknown fields).
+ */
+export declare const WorkspacePropertiesSchema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+export type WorkspaceProperties = z.infer<typeof WorkspacePropertiesSchema>;
+/**
+ * Represents a workspace in Todoist.
+ */
+export declare const WorkspaceSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    plan: z.ZodEnum<{
+        STARTER: "STARTER";
+        BUSINESS: "BUSINESS";
+    }>;
+    role: z.ZodEnum<{
+        ADMIN: "ADMIN";
+        MEMBER: "MEMBER";
+        GUEST: "GUEST";
+    }>;
+    inviteCode: z.ZodString;
+    isLinkSharingEnabled: z.ZodBoolean;
+    isGuestAllowed: z.ZodBoolean;
+    limits: z.ZodObject<{
+        current: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>;
+        next: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    }, z.core.$catchall<z.ZodAny>>;
+    logoBig: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    logoMedium: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    logoSmall: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    logoS640: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    createdAt: z.ZodString;
+    creatorId: z.ZodString;
+    properties: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+}, z.core.$strip>;
+export type Workspace = z.infer<typeof WorkspaceSchema>;
+export declare const MemberActivityInfoSchema: z.ZodObject<{
+    userId: z.ZodString;
+    tasksAssigned: z.ZodNumber;
+    tasksOverdue: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * Represents activity information for a workspace member.
+ */
+export type MemberActivityInfo = z.infer<typeof MemberActivityInfoSchema>;
+export declare const WorkspaceUserTaskSchema: z.ZodObject<{
+    id: z.ZodString;
+    content: z.ZodString;
+    responsibleUid: z.ZodNullable<z.ZodString>;
+    due: z.ZodNullable<z.ZodObject<{
+        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>>;
+    }, z.core.$strip>>;
+    deadline: z.ZodNullable<z.ZodObject<{
+        date: z.ZodString;
+        lang: z.ZodString;
+    }, z.core.$strip>>;
+    labels: z.ZodArray<z.ZodString>;
+    notesCount: z.ZodNumber;
+    projectId: z.ZodString;
+    projectName: z.ZodString;
+    priority: z.ZodNumber;
+    description: z.ZodString;
+    isOverdue: z.ZodBoolean;
+}, z.core.$strip>;
+/**
+ * Represents a task assigned to a workspace user.
+ */
+export type WorkspaceUserTask = z.infer<typeof WorkspaceUserTaskSchema>;

package/dist/types/utils/colors.d.ts

@@ -1,4 +1,4 @@
-import type { Color } from '../types/entities.js';
+import type { Color } from '../types/productivity/types.js';
 export declare const berryRed: {
     readonly key: "berry_red";
     readonly displayName: "Berry Red";

package/dist/types/utils/validators.d.ts

@@ -1,4 +1,5 @@
-import { type WorkspaceProject, type PersonalProject, type WorkspaceUser } from '../types/entities.js';
+import { type WorkspaceProject, type PersonalProject } from '../types/projects/types.js';
+import { type WorkspaceUser } from '../types/workspaces/types.js';
 export declare const validateTask: (input: unknown) => {
     isUncompletable: boolean;
     url: string;
@@ -152,7 +153,7 @@ export declare const validateComment: (input: unknown) => {
         fileType?: string | null | undefined;
         fileUrl?: string | null | undefined;
         fileDuration?: number | null | undefined;
-        uploadState?: "pending" | "completed" | null | undefined;
+        uploadState?: "completed" | "pending" | null | undefined;
         image?: string | null | undefined;
         imageWidth?: number | null | undefined;
         imageHeight?: number | null | undefined;
@@ -177,7 +178,7 @@ export declare const validateCommentArray: (input: unknown[]) => {
         fileType?: string | null | undefined;
         fileUrl?: string | null | undefined;
         fileDuration?: number | null | undefined;
-        uploadState?: "pending" | "completed" | null | undefined;
+        uploadState?: "completed" | "pending" | null | undefined;
         image?: string | null | undefined;
         imageWidth?: number | null | undefined;
         imageHeight?: number | null | undefined;
@@ -340,7 +341,7 @@ export declare const validateAttachment: (input: unknown) => {
     fileType?: string | null | undefined;
     fileUrl?: string | null | undefined;
     fileDuration?: number | null | undefined;
-    uploadState?: "pending" | "completed" | null | undefined;
+    uploadState?: "completed" | "pending" | null | undefined;
     image?: string | null | undefined;
     imageWidth?: number | null | undefined;
     imageHeight?: number | null | undefined;
@@ -697,7 +698,7 @@ export declare const validateNote: (input: unknown) => {
         fileType?: string | null | undefined;
         fileUrl?: string | null | undefined;
         fileDuration?: number | null | undefined;
-        uploadState?: "pending" | "completed" | null | undefined;
+        uploadState?: "completed" | "pending" | null | undefined;
         image?: string | null | undefined;
         imageWidth?: number | null | undefined;
         imageHeight?: number | null | undefined;
@@ -723,7 +724,7 @@ export declare const validateNoteArray: (input: unknown[]) => {
         fileType?: string | null | undefined;
         fileUrl?: string | null | undefined;
         fileDuration?: number | null | undefined;
-        uploadState?: "pending" | "completed" | null | undefined;
+        uploadState?: "completed" | "pending" | null | undefined;
         image?: string | null | undefined;
         imageWidth?: number | null | undefined;
         imageHeight?: number | null | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@doist/todoist-api-typescript",
-    "version": "7.6.0",
+    "version": "7.7.0",
     "description": "A typescript wrapper for the Todoist REST API.",
     "author": "Doist developers",
     "repository": "https://github.com/Doist/todoist-api-typescript",
@@ -12,9 +12,9 @@
     "types": "dist/types/index.d.ts",
     "exports": {
         ".": {
+            "types": "./dist/types/index.d.ts",
             "import": "./dist/esm/index.js",
-            "require": "./dist/cjs/index.js",
-            "types": "./dist/types/index.d.ts"
+            "require": "./dist/cjs/index.js"
         }
     },
     "sideEffects": false,