@doist/twist-sdk 2.0.2 → 2.1.0

package/dist/cjs/types/requests.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GetOrCreateConversationArgsSchema = exports.GetConversationsArgsSchema = exports.GetCommentsArgsSchema = exports.GetThreadsArgsSchema = exports.GetChannelsArgsSchema = exports.CreateMessageArgsSchema = exports.CreateConversationArgsSchema = exports.UpdateCommentArgsSchema = exports.CreateCommentArgsSchema = exports.UpdateThreadArgsSchema = exports.CreateThreadArgsSchema = exports.UpdateChannelArgsSchema = exports.CreateChannelArgsSchema = void 0;
+exports.AWAY_MODE_TYPES = exports.GetOrCreateConversationArgsSchema = exports.GetConversationsArgsSchema = exports.GetCommentsArgsSchema = exports.GetThreadsArgsSchema = exports.GetChannelsArgsSchema = exports.CreateMessageArgsSchema = exports.CreateConversationArgsSchema = exports.UpdateCommentArgsSchema = exports.CreateCommentArgsSchema = exports.UpdateThreadArgsSchema = exports.CreateThreadArgsSchema = exports.UpdateChannelArgsSchema = exports.CreateChannelArgsSchema = void 0;
 var zod_1 = require("zod");
 exports.CreateChannelArgsSchema = zod_1.z.object({
     workspaceId: zod_1.z.number(),
@@ -90,3 +90,4 @@ exports.GetOrCreateConversationArgsSchema = zod_1.z.object({
     workspaceId: zod_1.z.number(),
     userIds: zod_1.z.array(zod_1.z.number()),
 });
+exports.AWAY_MODE_TYPES = ['parental', 'vacation', 'sickleave', 'other'];

package/dist/esm/clients/search-client.js

@@ -26,7 +26,7 @@ var __assign = (this && this.__assign) || function () {
 };
 import { ENDPOINT_SEARCH } from '../consts/endpoints.js';
 import { request } from '../rest-client.js';
-import { SearchResultSchema } from '../types/entities.js';
+import { SearchResultSchema, } from '../types/entities.js';
 import { BaseClient } from './base-client.js';
 /**
  * Client for interacting with Twist search endpoints.

package/dist/esm/types/requests.js

@@ -87,3 +87,4 @@ export var GetOrCreateConversationArgsSchema = z.object({
     workspaceId: z.number(),
     userIds: z.array(z.number()),
 });
+export var AWAY_MODE_TYPES = ['parental', 'vacation', 'sickleave', 'other'];

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

@@ -1,23 +1,7 @@
 import type { BatchRequestDescriptor } from '../types/batch.js';
-import { Channel } from '../types/entities.js';
-import { CreateChannelArgs, GetChannelsArgs, UpdateChannelArgs } from '../types/requests.js';
+import { type Channel } from '../types/entities.js';
+import { type AddChannelUserArgs, type AddChannelUsersArgs, type CreateChannelArgs, type GetChannelsArgs, type RemoveChannelUserArgs, type RemoveChannelUsersArgs, type UpdateChannelArgs } from '../types/requests.js';
 import { BaseClient } from './base-client.js';
-export type AddChannelUserArgs = {
-    id: number;
-    userId: number;
-};
-export type AddChannelUsersArgs = {
-    id: number;
-    userIds: number[];
-};
-export type RemoveChannelUserArgs = {
-    id: number;
-    userId: number;
-};
-export type RemoveChannelUsersArgs = {
-    id: number;
-    userIds: number[];
-};
 /**
  * Client for interacting with Twist channel endpoints.
  */

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

@@ -1,11 +1,7 @@
 import type { BatchRequestDescriptor } from '../types/batch.js';
-import { Comment } from '../types/entities.js';
-import { CreateCommentArgs, GetCommentsArgs, UpdateCommentArgs } from '../types/requests.js';
+import { type Comment } from '../types/entities.js';
+import { type CreateCommentArgs, type GetCommentsArgs, type MarkCommentPositionArgs, type UpdateCommentArgs } from '../types/requests.js';
 import { BaseClient } from './base-client.js';
-export type MarkCommentPositionArgs = {
-    threadId: number;
-    commentId: number;
-};
 /**
  * Client for interacting with Twist comment endpoints.
  */

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

@@ -1,24 +1,7 @@
 import type { BatchRequestDescriptor } from '../types/batch.js';
-import { ConversationMessage } from '../types/entities.js';
+import { type ConversationMessage } from '../types/entities.js';
+import type { CreateConversationMessageArgs, GetConversationMessagesArgs, UpdateConversationMessageArgs } from '../types/requests.js';
 import { BaseClient } from './base-client.js';
-type GetConversationMessagesArgs = {
-    conversationId: number;
-    newerThan?: Date;
-    olderThan?: Date;
-    limit?: number;
-    cursor?: string;
-};
-type CreateConversationMessageArgs = {
-    conversationId: number;
-    content: string;
-    attachments?: unknown[];
-    actions?: unknown[];
-};
-type UpdateConversationMessageArgs = {
-    id: number;
-    content: string;
-    attachments?: unknown[];
-};
 /**
  * Client for interacting with Twist conversation message endpoints.
  */
@@ -134,4 +117,3 @@ export declare class ConversationMessagesClient extends BaseClient {
         batch?: false;
     }): Promise<void>;
 }
-export {};

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

@@ -1,32 +1,7 @@
 import type { BatchRequestDescriptor } from '../types/batch.js';
-import { Conversation, UnreadConversation } from '../types/entities.js';
-import { GetConversationsArgs, GetOrCreateConversationArgs } from '../types/requests.js';
+import { type Conversation, type UnreadConversation } from '../types/entities.js';
+import { type AddConversationUserArgs, type AddConversationUsersArgs, type GetConversationsArgs, type GetOrCreateConversationArgs, type MuteConversationArgs, type RemoveConversationUserArgs, type RemoveConversationUsersArgs, type UpdateConversationArgs } from '../types/requests.js';
 import { BaseClient } from './base-client.js';
-export type UpdateConversationArgs = {
-    id: number;
-    title: string;
-    archived?: boolean;
-};
-export type AddConversationUserArgs = {
-    id: number;
-    userId: number;
-};
-export type AddConversationUsersArgs = {
-    id: number;
-    userIds: number[];
-};
-export type RemoveConversationUserArgs = {
-    id: number;
-    userId: number;
-};
-export type RemoveConversationUsersArgs = {
-    id: number;
-    userIds: number[];
-};
-export type MuteConversationArgs = {
-    id: number;
-    minutes: number;
-};
 /**
  * Client for interacting with Twist conversation endpoints.
  */

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

@@ -1,22 +1,7 @@
 import type { BatchRequestDescriptor } from '../types/batch.js';
-import { Group } from '../types/entities.js';
+import { type Group } from '../types/entities.js';
+import type { AddGroupUserArgs, AddGroupUsersArgs, RemoveGroupUserArgs, RemoveGroupUsersArgs } from '../types/requests.js';
 import { BaseClient } from './base-client.js';
-export type AddGroupUserArgs = {
-    id: number;
-    userId: number;
-};
-export type AddGroupUsersArgs = {
-    id: number;
-    userIds: number[];
-};
-export type RemoveGroupUserArgs = {
-    id: number;
-    userId: number;
-};
-export type RemoveGroupUsersArgs = {
-    id: number;
-    userIds: number[];
-};
 /**
  * Client for interacting with Twist group endpoints.
  */

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

@@ -1,19 +1,7 @@
 import type { BatchRequestDescriptor } from '../types/batch.js';
-import { InboxThread } from '../types/entities.js';
+import { type InboxThread } from '../types/entities.js';
+import type { ArchiveAllArgs, GetInboxArgs } from '../types/requests.js';
 import { BaseClient } from './base-client.js';
-type GetInboxArgs = {
-    workspaceId: number;
-    since?: Date;
-    until?: Date;
-    limit?: number;
-    cursor?: string;
-};
-type ArchiveAllArgs = {
-    workspaceId: number;
-    channelIds?: number[];
-    since?: Date;
-    until?: Date;
-};
 /**
  * Client for interacting with Twist inbox endpoints.
  */
@@ -139,4 +127,3 @@ export declare class InboxClient extends BaseClient {
         batch?: false;
     }): Promise<void>;
 }
-export {};

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

@@ -1,23 +1,7 @@
 import type { BatchRequestDescriptor } from '../types/batch.js';
+import type { ReactionObject } from '../types/entities.js';
+import type { AddReactionArgs, GetReactionsArgs, RemoveReactionArgs } from '../types/requests.js';
 import { BaseClient } from './base-client.js';
-type AddReactionArgs = {
-    threadId?: number;
-    commentId?: number;
-    messageId?: number;
-    reaction: string;
-};
-type RemoveReactionArgs = {
-    threadId?: number;
-    commentId?: number;
-    messageId?: number;
-    reaction: string;
-};
-type GetReactionsArgs = {
-    threadId?: number;
-    commentId?: number;
-    messageId?: number;
-};
-type ReactionObject = Record<string, number[]> | null;
 /**
  * Client for interacting with Twist reaction endpoints.
  */
@@ -91,4 +75,3 @@ export declare class ReactionsClient extends BaseClient {
         batch?: false;
     }): Promise<void>;
 }
-export {};

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

@@ -1,41 +1,7 @@
 import type { BatchRequestDescriptor } from '../types/batch.js';
-import { SearchResult } from '../types/entities.js';
+import { type SearchConversationResponse, type SearchResponse, type SearchThreadResponse } from '../types/entities.js';
+import type { SearchArgs, SearchConversationArgs, SearchThreadArgs } from '../types/requests.js';
 import { BaseClient } from './base-client.js';
-type SearchArgs = {
-    query: string;
-    workspaceId: number;
-    channelIds?: number[];
-    authorIds?: number[];
-    mentionSelf?: boolean;
-    dateFrom?: string;
-    dateTo?: string;
-    limit?: number;
-    cursor?: string;
-};
-type SearchThreadArgs = {
-    query: string;
-    threadId: number;
-    limit?: number;
-    cursor?: string;
-};
-type SearchConversationArgs = {
-    query: string;
-    conversationId: number;
-    limit?: number;
-    cursor?: string;
-};
-type SearchResponse = {
-    items: SearchResult[];
-    nextCursorMark?: string;
-    hasMore: boolean;
-    isPlanRestricted: boolean;
-};
-type SearchThreadResponse = {
-    commentIds: number[];
-};
-type SearchConversationResponse = {
-    messageIds: number[];
-};
 /**
  * Client for interacting with Twist search endpoints.
  */
@@ -122,4 +88,3 @@ import { BaseClient, type ClientConfig } from './base-client.js'
         batch?: false;
     }): Promise<SearchConversationResponse>;
 }
-export {};

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

@@ -1,27 +1,7 @@
 import type { BatchRequestDescriptor } from '../types/batch.js';
-import { Thread, UnreadThread } from '../types/entities.js';
-import { CreateThreadArgs, GetThreadsArgs, UpdateThreadArgs } from '../types/requests.js';
+import { type Thread, type UnreadThread } from '../types/entities.js';
+import { type CreateThreadArgs, type GetThreadsArgs, type MarkThreadReadArgs, type MarkThreadUnreadArgs, type MarkThreadUnreadForOthersArgs, type MoveThreadToChannelArgs, type MuteThreadArgs, type UpdateThreadArgs } from '../types/requests.js';
 import { BaseClient } from './base-client.js';
-export type MoveThreadToChannelArgs = {
-    id: number;
-    toChannel: number;
-};
-export type MarkThreadReadArgs = {
-    id: number;
-    objIndex: number;
-};
-export type MarkThreadUnreadArgs = {
-    id: number;
-    objIndex: number;
-};
-export type MarkThreadUnreadForOthersArgs = {
-    id: number;
-    objIndex: number;
-};
-export type MuteThreadArgs = {
-    id: number;
-    minutes: number;
-};
 /**
  * Client for interacting with Twist thread endpoints.
  */

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

@@ -1,29 +1,7 @@
 import type { BatchRequestDescriptor } from '../types/batch.js';
-import { User } from '../types/entities.js';
+import { type GoogleConnectionStatus, type User } from '../types/entities.js';
+import type { UpdateUserArgs } from '../types/requests.js';
 import { BaseClient } from './base-client.js';
-type AwayMode = {
-    type: 'parental' | 'vacation' | 'sickleave' | 'other';
-    dateFrom?: string;
-    dateTo: string;
-};
-type UpdateUserArgs = {
-    name?: string;
-    email?: string;
-    password?: string;
-    defaultWorkspace?: number;
-    profession?: string;
-    contactInfo?: string;
-    timezone?: string;
-    snoozeUntil?: number;
-    snoozeDndStart?: string;
-    snoozeDndEnd?: string;
-    awayMode?: AwayMode;
-    offDays?: number[];
-};
-type GoogleConnectionStatus = {
-    googleConnection: boolean;
-    googleEmail?: string;
-};
 /**
  * Client for interacting with Twist user endpoints.
  */
@@ -247,4 +225,3 @@ export declare class UsersClient extends BaseClient {
         status: string;
     }>;
 }
-export {};

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

@@ -1,27 +1,8 @@
 import { BatchRequestDescriptor } from '../types/batch.js';
-import { WorkspaceUser } from '../types/entities.js';
+import { type WorkspaceUser } from '../types/entities.js';
 import { UserType } from '../types/enums.js';
+import type { GetUserByEmailArgs, GetUserByIdArgs, GetUserInfoArgs, GetUserLocalTimeArgs, GetWorkspaceUsersArgs } from '../types/requests.js';
 import { BaseClient } from './base-client.js';
-export type GetWorkspaceUsersArgs = {
-    workspaceId: number;
-    archived?: boolean;
-};
-export type GetUserByIdArgs = {
-    workspaceId: number;
-    userId: number;
-};
-export type GetUserByEmailArgs = {
-    workspaceId: number;
-    email: string;
-};
-export type GetUserInfoArgs = {
-    workspaceId: number;
-    userId: number;
-};
-export type GetUserLocalTimeArgs = {
-    workspaceId: number;
-    userId: number;
-};
 /**
  * Client for interacting with Twist workspace users endpoints (v4 API).
  */

package/dist/types/types/entities.d.ts

@@ -849,3 +849,20 @@ export declare const SearchResultSchema: z.ZodObject<{
     closed: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
 }, z.core.$strip>;
 export type SearchResult = z.infer<typeof SearchResultSchema>;
+export type GoogleConnectionStatus = {
+    googleConnection: boolean;
+    googleEmail?: string;
+};
+export type SearchResponse = {
+    items: SearchResult[];
+    nextCursorMark?: string;
+    hasMore: boolean;
+    isPlanRestricted: boolean;
+};
+export type SearchThreadResponse = {
+    commentIds: number[];
+};
+export type SearchConversationResponse = {
+    messageIds: number[];
+};
+export type ReactionObject = Record<string, number[]> | null;

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

@@ -94,3 +94,196 @@ export declare const GetOrCreateConversationArgsSchema: z.ZodObject<{
     userIds: z.ZodArray<z.ZodNumber>;
 }, z.core.$strip>;
 export type GetOrCreateConversationArgs = z.infer<typeof GetOrCreateConversationArgsSchema>;
+export declare const AWAY_MODE_TYPES: readonly ["parental", "vacation", "sickleave", "other"];
+export type AwayModeType = (typeof AWAY_MODE_TYPES)[number];
+export type AwayMode = {
+    type: AwayModeType;
+    dateFrom?: string;
+    dateTo: string;
+};
+export type UpdateUserArgs = {
+    name?: string;
+    email?: string;
+    password?: string;
+    defaultWorkspace?: number;
+    profession?: string;
+    contactInfo?: string;
+    timezone?: string;
+    snoozeUntil?: number;
+    snoozeDndStart?: string;
+    snoozeDndEnd?: string;
+    awayMode?: AwayMode;
+    offDays?: number[];
+};
+export type SearchArgs = {
+    query: string;
+    workspaceId: number;
+    channelIds?: number[];
+    authorIds?: number[];
+    mentionSelf?: boolean;
+    dateFrom?: string;
+    dateTo?: string;
+    limit?: number;
+    cursor?: string;
+};
+export type SearchThreadArgs = {
+    query: string;
+    threadId: number;
+    limit?: number;
+    cursor?: string;
+};
+export type SearchConversationArgs = {
+    query: string;
+    conversationId: number;
+    limit?: number;
+    cursor?: string;
+};
+export type GetConversationMessagesArgs = {
+    conversationId: number;
+    newerThan?: Date;
+    olderThan?: Date;
+    limit?: number;
+    cursor?: string;
+};
+export type CreateConversationMessageArgs = {
+    conversationId: number;
+    content: string;
+    attachments?: unknown[];
+    actions?: unknown[];
+};
+export type UpdateConversationMessageArgs = {
+    id: number;
+    content: string;
+    attachments?: unknown[];
+};
+export type GetInboxArgs = {
+    workspaceId: number;
+    since?: Date;
+    until?: Date;
+    limit?: number;
+    cursor?: string;
+};
+export type ArchiveAllArgs = {
+    workspaceId: number;
+    channelIds?: number[];
+    since?: Date;
+    until?: Date;
+};
+export type AddReactionArgs = {
+    threadId?: number;
+    commentId?: number;
+    messageId?: number;
+    reaction: string;
+};
+export type RemoveReactionArgs = {
+    threadId?: number;
+    commentId?: number;
+    messageId?: number;
+    reaction: string;
+};
+export type GetReactionsArgs = {
+    threadId?: number;
+    commentId?: number;
+    messageId?: number;
+};
+export type AddChannelUserArgs = {
+    id: number;
+    userId: number;
+};
+export type AddChannelUsersArgs = {
+    id: number;
+    userIds: number[];
+};
+export type RemoveChannelUserArgs = {
+    id: number;
+    userId: number;
+};
+export type RemoveChannelUsersArgs = {
+    id: number;
+    userIds: number[];
+};
+export type MoveThreadToChannelArgs = {
+    id: number;
+    toChannel: number;
+};
+export type MarkThreadReadArgs = {
+    id: number;
+    objIndex: number;
+};
+export type MarkThreadUnreadArgs = {
+    id: number;
+    objIndex: number;
+};
+export type MarkThreadUnreadForOthersArgs = {
+    id: number;
+    objIndex: number;
+};
+export type MuteThreadArgs = {
+    id: number;
+    minutes: number;
+};
+export type MarkCommentPositionArgs = {
+    threadId: number;
+    commentId: number;
+};
+export type UpdateConversationArgs = {
+    id: number;
+    title: string;
+    archived?: boolean;
+};
+export type AddConversationUserArgs = {
+    id: number;
+    userId: number;
+};
+export type AddConversationUsersArgs = {
+    id: number;
+    userIds: number[];
+};
+export type RemoveConversationUserArgs = {
+    id: number;
+    userId: number;
+};
+export type RemoveConversationUsersArgs = {
+    id: number;
+    userIds: number[];
+};
+export type MuteConversationArgs = {
+    id: number;
+    minutes: number;
+};
+export type AddGroupUserArgs = {
+    id: number;
+    userId: number;
+};
+export type AddGroupUsersArgs = {
+    id: number;
+    userIds: number[];
+};
+export type RemoveGroupUserArgs = {
+    id: number;
+    userId: number;
+};
+export type RemoveGroupUsersArgs = {
+    id: number;
+    userIds: number[];
+};
+export type GetWorkspaceUsersArgs = {
+    workspaceId: number;
+    archived?: boolean;
+};
+export type GetUserByIdArgs = {
+    workspaceId: number;
+    userId: number;
+};
+export type GetUserByEmailArgs = {
+    workspaceId: number;
+    email: string;
+};
+export type GetUserInfoArgs = {
+    workspaceId: number;
+    userId: number;
+};
+export type GetUserLocalTimeArgs = {
+    workspaceId: number;
+    userId: number;
+};

package/package.json

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