@doist/twist-sdk 2.6.0 → 2.8.1

package/dist/types/clients/channels-client.d.ts

@@ -6,6 +6,7 @@ import { BaseClient } from './base-client.js';
  * Client for interacting with Twist channel endpoints.
  */
 export declare class ChannelsClient extends BaseClient {
+    private readonly channelSchema;
     /**
      * Gets all channels for a given workspace.
      *

package/dist/types/clients/comments-client.d.ts

@@ -6,6 +6,7 @@ import { BaseClient } from './base-client.js';
  * Client for interacting with Twist comment endpoints.
  */
 export declare class CommentsClient extends BaseClient {
+    private readonly commentSchema;
     /**
      * Gets all comments for a thread.
      *
@@ -59,7 +60,7 @@ export declare class CommentsClient extends BaseClient {
      * @param args.notifyAudience - Optional broader audience to notify in addition to
      *   `recipients` and `groups`. `'channel'` notifies everyone in the channel;
      *   `'thread'` notifies everyone who has interacted with the thread.
-     * @param args.attachments - Optional array of attachment objects.
+     * @param args.attachments - Optional array of {@link Attachment} objects.
      * @param args.sendAsIntegration - Optional flag to send as integration.
      * @param options - Optional configuration. Set `batch: true` to return a descriptor for batch requests.
      * @returns The created comment object.
@@ -88,7 +89,6 @@ export declare class CommentsClient extends BaseClient {
      * @param args.id - The comment ID.
      * @param args.content - Optional new comment content.
      * @param args.recipients - Optional array of user IDs to notify.
-     * @param args.attachments - Optional array of attachment objects.
      * @param options - Optional configuration. Set `batch: true` to return a descriptor for batch requests.
      * @returns The updated comment object.
      */

package/dist/types/clients/conversation-messages-client.d.ts

@@ -6,6 +6,7 @@ import { BaseClient } from './base-client.js';
  * Client for interacting with Twist conversation message endpoints.
  */
 export declare class ConversationMessagesClient extends BaseClient {
+    private readonly messageSchema;
     /**
      * Gets all messages in a conversation.
      *
@@ -56,7 +57,7 @@ export declare class ConversationMessagesClient extends BaseClient {
      * @param args - The arguments for creating a message.
      * @param args.conversationId - The conversation ID.
      * @param args.content - The message content.
-     * @param args.attachments - Optional array of attachment objects.
+     * @param args.attachments - Optional array of {@link Attachment} objects.
      * @param args.actions - Optional array of action objects.
      * @param options - Optional configuration. Set `batch: true` to return a descriptor for batch requests.
      * @returns The created message object.
@@ -81,7 +82,7 @@ export declare class ConversationMessagesClient extends BaseClient {
      * @param args - The arguments for updating a message.
      * @param args.id - The message ID.
      * @param args.content - The new message content.
-     * @param args.attachments - Optional array of attachment objects.
+     * @param args.attachments - Optional array of {@link Attachment} objects.
      * @param options - Optional configuration. Set `batch: true` to return a descriptor for batch requests.
      * @returns The updated message object.
      *

package/dist/types/clients/conversations-client.d.ts

@@ -6,6 +6,7 @@ import { BaseClient } from './base-client.js';
  * Client for interacting with Twist conversation endpoints.
  */
 export declare class ConversationsClient extends BaseClient {
+    private readonly conversationSchema;
     /**
      * Gets all conversations for a workspace.
      *

package/dist/types/clients/inbox-client.d.ts

@@ -6,6 +6,7 @@ import { BaseClient } from './base-client.js';
  * Client for interacting with Twist inbox endpoints.
  */
 export declare class InboxClient extends BaseClient {
+    private readonly inboxThreadSchema;
     /**
      * Gets inbox items (threads).
      *

package/dist/types/clients/threads-client.d.ts

@@ -6,6 +6,8 @@ import { BaseClient } from './base-client.js';
  * Client for interacting with Twist thread endpoints.
  */
 export declare class ThreadsClient extends BaseClient {
+    private readonly threadSchema;
+    private readonly commentSchema;
     /**
      * Gets all threads in a channel.
      *
@@ -54,7 +56,6 @@ export declare class ThreadsClient extends BaseClient {
      * @param args.title - The thread title.
      * @param args.content - The thread content.
      * @param args.recipients - Optional array of user IDs to notify.
-     * @param args.attachments - Optional array of attachment objects.
      * @param args.sendAsIntegration - Optional flag to send as integration.
      * @param options - Optional configuration. Set `batch: true` to return a descriptor for batch requests.
      * @returns The created thread object.
@@ -82,7 +83,6 @@ export declare class ThreadsClient extends BaseClient {
      * @param args.title - Optional new thread title.
      * @param args.content - Optional new thread content.
      * @param args.recipients - Optional array of user IDs to notify.
-     * @param args.attachments - Optional array of attachment objects.
      * @param options - Optional configuration. Set `batch: true` to return a descriptor for batch requests.
      * @returns The updated thread object.
      */
@@ -328,7 +328,7 @@ export declare class ThreadsClient extends BaseClient {
      * @param args.id - The thread ID.
      * @param args.content - The comment content.
      * @param args.tempId - Optional temporary identifier.
-     * @param args.attachments - Optional array of attachment objects.
+     * @param args.attachments - Optional array of {@link Attachment} objects.
      * @param args.actions - Optional array of action objects.
      * @param args.recipients - Optional array of user IDs to notify directly.
      * @param args.groups - Optional array of custom group IDs to notify.
@@ -361,7 +361,7 @@ export declare class ThreadsClient extends BaseClient {
      * @param args.id - The thread ID.
      * @param args.content - The comment content.
      * @param args.tempId - Optional temporary identifier.
-     * @param args.attachments - Optional array of attachment objects.
+     * @param args.attachments - Optional array of {@link Attachment} objects.
      * @param args.actions - Optional array of action objects.
      * @param args.recipients - Optional array of user IDs to notify directly.
      * @param args.groups - Optional array of custom group IDs to notify.

package/dist/types/clients/workspace-users-client.d.ts

@@ -10,9 +10,14 @@ export declare class WorkspaceUsersClient extends BaseClient {
     /**
      * Returns a list of workspace user objects for the given workspace id.
      *
+     * Removed users are excluded by default; set `args.includeRemoved` to `true` to include them.
+     * The Twist API always returns removed users, so the filtering happens client-side (in both the
+     * awaited and batch modes).
+     *
      * @param args - The arguments for getting workspace users.
      * @param args.workspaceId - The workspace ID.
      * @param args.archived - Optional flag to filter archived users.
+     * @param args.includeRemoved - Include users removed from the workspace. Defaults to `false`.
      * @param options - Optional configuration. Set `batch: true` to return a descriptor for batch requests.
      * @returns An array of workspace user objects.
      *

package/dist/types/clients/workspaces-client.d.ts

@@ -5,6 +5,7 @@ import { BaseClient } from './base-client.js';
  * Client for interacting with Twist workspace endpoints.
  */
 export declare class WorkspacesClient extends BaseClient {
+    private readonly channelSchema;
     /**
      * Gets all the user's workspaces.
      *