@doist/todoist-api-typescript 7.6.0 → 7.6.1

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.6.1",
     "description": "A typescript wrapper for the Todoist REST API.",
     "author": "Doist developers",
     "repository": "https://github.com/Doist/todoist-api-typescript",