@doist/twist-sdk 2.5.1 → 2.7.0

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

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+import { type Attachment } from './entities.js';
 export declare const CreateChannelArgsSchema: z.ZodObject<{
     workspaceId: z.ZodNumber;
     name: z.ZodString;
@@ -44,9 +45,32 @@ export declare const CreateCommentArgsSchema: z.ZodObject<{
     threadId: z.ZodNumber;
     content: z.ZodString;
     tempId: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
-    attachments: z.ZodOptional<z.ZodNullable<z.ZodUnknown>>;
+    attachments: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
+        attachmentId: z.ZodString;
+        urlType: z.ZodString;
+        title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        fileName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        fileSize: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        underlyingType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        image: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        imageWidth: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        imageHeight: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        duration: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        uploadState: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        video: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        videoType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        videoAutoPlay: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    }, z.core.$loose>>>>;
     actions: z.ZodOptional<z.ZodNullable<z.ZodUnknown>>;
     recipients: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+    groups: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+    directMentions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+    notifyAudience: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+        channel: "channel";
+        thread: "thread";
+    }>>>;
 }, z.core.$strip>;
 export type CreateCommentArgs = z.infer<typeof CreateCommentArgsSchema>;
 export declare const UpdateCommentArgsSchema: z.ZodObject<{
@@ -64,7 +88,24 @@ export declare const CreateMessageArgsSchema: z.ZodObject<{
     conversationId: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
     threadId: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
     content: z.ZodString;
-    attachments: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+    attachments: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
+        attachmentId: z.ZodString;
+        urlType: z.ZodString;
+        title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        fileName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        fileSize: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        underlyingType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        image: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        imageWidth: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        imageHeight: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        duration: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        uploadState: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        video: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        videoType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        videoAutoPlay: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    }, z.core.$loose>>>>;
 }, z.core.$strip>;
 export type CreateMessageArgs = z.infer<typeof CreateMessageArgsSchema>;
 export declare const GetChannelsArgsSchema: z.ZodObject<{
@@ -168,13 +209,13 @@ export type GetConversationMessagesArgs = {
 export type CreateConversationMessageArgs = {
     conversationId: number;
     content: string;
-    attachments?: unknown[];
+    attachments?: Attachment[];
     actions?: unknown[];
 };
 export type UpdateConversationMessageArgs = {
     id: number;
     content: string;
-    attachments?: unknown[];
+    attachments?: Attachment[];
 };
 export declare const ARCHIVE_FILTER_VALUES: readonly ["active", "archived", "all"];
 export type ArchiveFilter = (typeof ARCHIVE_FILTER_VALUES)[number];
@@ -234,22 +275,16 @@ export type RemoveChannelUsersArgs = {
 };
 export declare const THREAD_ACTIONS: readonly ["close", "reopen"];
 export type ThreadAction = (typeof THREAD_ACTIONS)[number];
-export type CloseThreadArgs = {
+/**
+ * Shared shape for endpoints that post a comment as part of a thread action
+ * (close, reopen). Identical to {@link CreateCommentArgs} except the target
+ * is identified by `id` (the thread ID) instead of `threadId`.
+ */
+type ThreadActionCommentArgs = Omit<CreateCommentArgs, 'threadId'> & {
     id: number;
-    content: string;
-    tempId?: number | null;
-    attachments?: unknown | null;
-    actions?: unknown | null;
-    recipients?: number[] | null;
-};
-export type ReopenThreadArgs = {
-    id: number;
-    content: string;
-    tempId?: number | null;
-    attachments?: unknown | null;
-    actions?: unknown | null;
-    recipients?: number[] | null;
 };
+export type CloseThreadArgs = ThreadActionCommentArgs;
+export type ReopenThreadArgs = ThreadActionCommentArgs;
 export type MoveThreadToChannelArgs = {
     id: number;
     toChannel: number;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@doist/twist-sdk",
-    "version": "2.5.1",
+    "version": "2.7.0",
     "description": "A TypeScript wrapper for the Twist REST API.",
     "author": "Doist developers",
     "homepage": "https://doist.github.io/twist-sdk-typescript/",