@doist/twist-sdk 0.1.0-alpha.1 → 0.1.0-alpha.3

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

@@ -1,6 +1,26 @@
 import type { BatchRequestDescriptor } from '../types/batch';
 import { Thread, UnreadThread } from '../types/entities';
 import { CreateThreadArgs, GetThreadsArgs, UpdateThreadArgs } from '../types/requests';
+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.
  */
@@ -180,53 +200,57 @@ export declare class ThreadsClient {
     /**
      * Moves a thread to a different channel.
      *
-     * @param id - The thread ID.
-     * @param toChannel - The target channel ID.
+     * @param args - The arguments for moving a thread.
+     * @param args.id - The thread ID.
+     * @param args.toChannel - The target channel ID.
      * @param options - Optional configuration. Set `batch: true` to return a descriptor for batch requests.
      */
-    moveToChannel(id: number, toChannel: number, options: {
+    moveToChannel(args: MoveThreadToChannelArgs, options: {
         batch: true;
     }): BatchRequestDescriptor<void>;
-    moveToChannel(id: number, toChannel: number, options?: {
+    moveToChannel(args: MoveThreadToChannelArgs, options?: {
         batch?: false;
     }): Promise<void>;
     /**
      * Marks a thread as read.
      *
-     * @param id - The thread ID.
-     * @param objIndex - The index of the last known read message.
+     * @param args - The arguments for marking a thread as read.
+     * @param args.id - The thread ID.
+     * @param args.objIndex - The index of the last known read message.
      * @param options - Optional configuration. Set `batch: true` to return a descriptor for batch requests.
      */
-    markRead(id: number, objIndex: number, options: {
+    markRead(args: MarkThreadReadArgs, options: {
         batch: true;
     }): BatchRequestDescriptor<void>;
-    markRead(id: number, objIndex: number, options?: {
+    markRead(args: MarkThreadReadArgs, options?: {
         batch?: false;
     }): Promise<void>;
     /**
      * Marks a thread as unread.
      *
-     * @param id - The thread ID.
-     * @param objIndex - The index of the last unread message. Use -1 to mark the whole thread as unread.
+     * @param args - The arguments for marking a thread as unread.
+     * @param args.id - The thread ID.
+     * @param args.objIndex - The index of the last unread message. Use -1 to mark the whole thread as unread.
      * @param options - Optional configuration. Set `batch: true` to return a descriptor for batch requests.
      */
-    markUnread(id: number, objIndex: number, options: {
+    markUnread(args: MarkThreadUnreadArgs, options: {
         batch: true;
     }): BatchRequestDescriptor<void>;
-    markUnread(id: number, objIndex: number, options?: {
+    markUnread(args: MarkThreadUnreadArgs, options?: {
         batch?: false;
     }): Promise<void>;
     /**
      * Marks a thread as unread for others. Useful to notify others about thread changes.
      *
-     * @param id - The thread ID.
-     * @param objIndex - The index of the last unread message. Use -1 to mark the whole thread as unread.
+     * @param args - The arguments for marking a thread as unread for others.
+     * @param args.id - The thread ID.
+     * @param args.objIndex - The index of the last unread message. Use -1 to mark the whole thread as unread.
      * @param options - Optional configuration. Set `batch: true` to return a descriptor for batch requests.
      */
-    markUnreadForOthers(id: number, objIndex: number, options: {
+    markUnreadForOthers(args: MarkThreadUnreadForOthersArgs, options: {
         batch: true;
     }): BatchRequestDescriptor<void>;
-    markUnreadForOthers(id: number, objIndex: number, options?: {
+    markUnreadForOthers(args: MarkThreadUnreadForOthersArgs, options?: {
         batch?: false;
     }): Promise<void>;
     /**
@@ -287,20 +311,21 @@ export declare class ThreadsClient {
      * Mutes a thread for a specified number of minutes.
      * When muted, you will not get notified in your inbox about new comments.
      *
-     * @param id - The thread ID.
-     * @param minutes - Number of minutes to mute the thread.
+     * @param args - The arguments for muting a thread.
+     * @param args.id - The thread ID.
+     * @param args.minutes - Number of minutes to mute the thread.
      * @param options - Optional configuration. Set `batch: true` to return a descriptor for batch requests.
      * @returns The updated thread object.
      *
      * @example
      * ```typescript
-     * const thread = await api.threads.muteThread(789, 30)
+     * const thread = await api.threads.muteThread({ id: 789, minutes: 30 })
      * ```
      */
-    muteThread(id: number, minutes: number, options: {
+    muteThread(args: MuteThreadArgs, options: {
         batch: true;
     }): BatchRequestDescriptor<Thread>;
-    muteThread(id: number, minutes: number, options?: {
+    muteThread(args: MuteThreadArgs, options?: {
         batch?: false;
     }): Promise<Thread>;
     /**
@@ -318,4 +343,3 @@ export declare class ThreadsClient {
         batch?: false;
     }): Promise<Thread>;
 }
-//# sourceMappingURL=threads-client.d.ts.map

package/dist/clients/threads-client.js

@@ -117,37 +117,37 @@ var ThreadsClient = /** @class */ (function () {
         }
         return (0, rest_client_1.request)(method, this.getBaseUri(), url, this.apiToken, params).then(function () { return undefined; });
     };
-    ThreadsClient.prototype.moveToChannel = function (id, toChannel, options) {
+    ThreadsClient.prototype.moveToChannel = function (args, options) {
         var method = 'POST';
         var url = "".concat(endpoints_1.ENDPOINT_THREADS, "/move_to_channel");
-        var params = { id: id, toChannel: toChannel };
+        var params = { id: args.id, toChannel: args.toChannel };
         if (options === null || options === void 0 ? void 0 : options.batch) {
             return { method: method, url: url, params: params };
         }
         return (0, rest_client_1.request)(method, this.getBaseUri(), url, this.apiToken, params).then(function () { return undefined; });
     };
-    ThreadsClient.prototype.markRead = function (id, objIndex, options) {
+    ThreadsClient.prototype.markRead = function (args, options) {
         var method = 'POST';
         var url = "".concat(endpoints_1.ENDPOINT_THREADS, "/mark_read");
-        var params = { id: id, obj_index: objIndex };
+        var params = { id: args.id, obj_index: args.objIndex };
         if (options === null || options === void 0 ? void 0 : options.batch) {
             return { method: method, url: url, params: params };
         }
         return (0, rest_client_1.request)(method, this.getBaseUri(), url, this.apiToken, params).then(function () { return undefined; });
     };
-    ThreadsClient.prototype.markUnread = function (id, objIndex, options) {
+    ThreadsClient.prototype.markUnread = function (args, options) {
         var method = 'POST';
         var url = "".concat(endpoints_1.ENDPOINT_THREADS, "/mark_unread");
-        var params = { id: id, obj_index: objIndex };
+        var params = { id: args.id, obj_index: args.objIndex };
         if (options === null || options === void 0 ? void 0 : options.batch) {
             return { method: method, url: url, params: params };
         }
         return (0, rest_client_1.request)(method, this.getBaseUri(), url, this.apiToken, params).then(function () { return undefined; });
     };
-    ThreadsClient.prototype.markUnreadForOthers = function (id, objIndex, options) {
+    ThreadsClient.prototype.markUnreadForOthers = function (args, options) {
         var method = 'POST';
         var url = "".concat(endpoints_1.ENDPOINT_THREADS, "/mark_unread_for_others");
-        var params = { id: id, obj_index: objIndex };
+        var params = { id: args.id, obj_index: args.objIndex };
         if (options === null || options === void 0 ? void 0 : options.batch) {
             return { method: method, url: url, params: params };
         }
@@ -187,10 +187,10 @@ var ThreadsClient = /** @class */ (function () {
         }
         return (0, rest_client_1.request)(method, this.getBaseUri(), url, this.apiToken, params).then(function (response) { return response.data.map(function (thread) { return entities_1.UnreadThreadSchema.parse(thread); }); });
     };
-    ThreadsClient.prototype.muteThread = function (id, minutes, options) {
+    ThreadsClient.prototype.muteThread = function (args, options) {
         var method = 'POST';
         var url = "".concat(endpoints_1.ENDPOINT_THREADS, "/mute");
-        var params = { id: id, minutes: minutes };
+        var params = { id: args.id, minutes: args.minutes };
         var schema = entities_1.ThreadSchema;
         if (options === null || options === void 0 ? void 0 : options.batch) {
             return { method: method, url: url, params: params, schema: schema };

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

@@ -251,4 +251,3 @@ export declare class UsersClient {
     }>;
 }
 export {};
-//# sourceMappingURL=users-client.d.ts.map

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

@@ -1,6 +1,26 @@
 import { BatchRequestDescriptor } from '../types/batch';
 import { WorkspaceUser } from '../types/entities';
 import { UserType } from '../types/enums';
+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).
  */
@@ -12,21 +32,22 @@ export declare class WorkspaceUsersClient {
     /**
      * Returns a list of workspace user objects for the given workspace id.
      *
-     * @param workspaceId - The workspace ID.
-     * @param archived - Optional flag to filter archived users.
+     * @param args - The arguments for getting workspace users.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.archived - Optional flag to filter archived users.
      * @param options - Optional configuration. Set `batch: true` to return a descriptor for batch requests.
      * @returns An array of workspace user objects.
      *
      * @example
      * ```typescript
-     * const users = await api.workspaceUsers.getWorkspaceUsers(123)
+     * const users = await api.workspaceUsers.getWorkspaceUsers({ workspaceId: 123 })
      * users.forEach(u => console.log(u.name, u.userType))
      * ```
      */
-    getWorkspaceUsers(workspaceId: number, archived: boolean | undefined, options: {
+    getWorkspaceUsers(args: GetWorkspaceUsersArgs, options: {
         batch: true;
     }): BatchRequestDescriptor<WorkspaceUser[]>;
-    getWorkspaceUsers(workspaceId: number, archived?: boolean, options?: {
+    getWorkspaceUsers(args: GetWorkspaceUsersArgs, options?: {
         batch?: false;
     }): Promise<WorkspaceUser[]>;
     /**
@@ -45,80 +66,84 @@ export declare class WorkspaceUsersClient {
     /**
      * Gets a user by id.
      *
-     * @param workspaceId - The workspace ID.
-     * @param userId - The user's ID.
+     * @param args - The arguments for getting a user by ID.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.userId - The user's ID.
      * @param options - Optional configuration. Set `batch: true` to return a descriptor for batch requests.
      * @returns The workspace user object or a batch request descriptor.
      *
      * @example
      * ```typescript
      * // Normal usage
-     * const user = await api.workspaceUsers.getUserById(123, 456)
+     * const user = await api.workspaceUsers.getUserById({ workspaceId: 123, userId: 456 })
      * console.log(user.name, user.email)
      *
      * // Batch usage
      * const batch = api.createBatch()
-     * batch.add((api) => api.workspaceUsers.getUserById(123, 456))
+     * batch.add((api) => api.workspaceUsers.getUserById({ workspaceId: 123, userId: 456 }))
      * const results = await batch.execute()
      * ```
      */
-    getUserById(workspaceId: number, userId: number, options: {
+    getUserById(args: GetUserByIdArgs, options: {
         batch: true;
     }): BatchRequestDescriptor<WorkspaceUser>;
-    getUserById(workspaceId: number, userId: number, options?: {
+    getUserById(args: GetUserByIdArgs, options?: {
         batch?: false;
     }): Promise<WorkspaceUser>;
     /**
      * Gets a user by email.
      *
-     * @param workspaceId - The workspace ID.
-     * @param email - The user's email.
+     * @param args - The arguments for getting a user by email.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.email - The user's email.
      * @param options - Optional configuration. Set `batch: true` to return a descriptor for batch requests.
      * @returns The workspace user object.
      *
      * @example
      * ```typescript
-     * const user = await api.workspaceUsers.getUserByEmail(123, 'user@example.com')
+     * const user = await api.workspaceUsers.getUserByEmail({ workspaceId: 123, email: 'user@example.com' })
      * ```
      */
-    getUserByEmail(workspaceId: number, email: string, options: {
+    getUserByEmail(args: GetUserByEmailArgs, options: {
         batch: true;
     }): BatchRequestDescriptor<WorkspaceUser>;
-    getUserByEmail(workspaceId: number, email: string, options?: {
+    getUserByEmail(args: GetUserByEmailArgs, options?: {
         batch?: false;
     }): Promise<WorkspaceUser>;
     /**
      * Gets the user's info in the context of the workspace.
      *
-     * @param workspaceId - The workspace ID.
-     * @param userId - The user's ID.
+     * @param args - The arguments for getting user info.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.userId - The user's ID.
      * @param options - Optional configuration. Set `batch: true` to return a descriptor for batch requests.
      * @returns Information about the user in the workspace context.
      */
-    getUserInfo(workspaceId: number, userId: number, options: {
+    getUserInfo(args: GetUserInfoArgs, options: {
         batch: true;
     }): BatchRequestDescriptor<Record<string, unknown>>;
-    getUserInfo(workspaceId: number, userId: number, options?: {
+    getUserInfo(args: GetUserInfoArgs, options?: {
         batch?: false;
     }): Promise<Record<string, unknown>>;
     /**
      * Gets the user's local time.
      *
-     * @param workspaceId - The workspace ID.
-     * @param userId - The user's ID.
+     * @param args - The arguments for getting user local time.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.userId - The user's ID.
      * @param options - Optional configuration. Set `batch: true` to return a descriptor for batch requests.
      * @returns The user's local time as a string (e.g., "2017-05-10 07:55:40").
      *
      * @example
      * ```typescript
-     * const localTime = await api.workspaceUsers.getUserLocalTime(123, 456)
+     * const localTime = await api.workspaceUsers.getUserLocalTime({ workspaceId: 123, userId: 456 })
      * console.log('User local time:', localTime)
      * ```
      */
-    getUserLocalTime(workspaceId: number, userId: number, options: {
+    getUserLocalTime(args: GetUserLocalTimeArgs, options: {
         batch: true;
     }): BatchRequestDescriptor<string>;
-    getUserLocalTime(workspaceId: number, userId: number, options?: {
+    getUserLocalTime(args: GetUserLocalTimeArgs, options?: {
         batch?: false;
     }): Promise<string>;
     /**
@@ -217,4 +242,3 @@ export declare class WorkspaceUsersClient {
         userId?: number;
     }): Promise<void>;
 }
-//# sourceMappingURL=workspace-users-client.d.ts.map

package/dist/clients/workspace-users-client.js

@@ -14,10 +14,10 @@ var WorkspaceUsersClient = /** @class */ (function () {
     WorkspaceUsersClient.prototype.getBaseUri = function () {
         return this.baseUrl ? "".concat(this.baseUrl, "/api/v4") : 'https://api.twist.com/api/v4/';
     };
-    WorkspaceUsersClient.prototype.getWorkspaceUsers = function (workspaceId, archived, options) {
+    WorkspaceUsersClient.prototype.getWorkspaceUsers = function (args, options) {
         var method = 'GET';
         var url = 'workspace_users/get';
-        var params = { id: workspaceId, archived: archived };
+        var params = { id: args.workspaceId, archived: args.archived };
         if (options === null || options === void 0 ? void 0 : options.batch) {
             return { method: method, url: url, params: params };
         }
@@ -32,39 +32,39 @@ var WorkspaceUsersClient = /** @class */ (function () {
         }
         return (0, rest_client_1.request)(method, this.getBaseUri(), url, this.apiToken, params).then(function (response) { return response.data; });
     };
-    WorkspaceUsersClient.prototype.getUserById = function (workspaceId, userId, options) {
+    WorkspaceUsersClient.prototype.getUserById = function (args, options) {
         var method = 'GET';
         var url = 'workspace_users/getone';
-        var params = { id: workspaceId, user_id: userId };
+        var params = { id: args.workspaceId, user_id: args.userId };
         var schema = entities_1.WorkspaceUserSchema;
         if (options === null || options === void 0 ? void 0 : options.batch) {
             return { method: method, url: url, params: params, schema: schema };
         }
         return (0, rest_client_1.request)(method, this.getBaseUri(), url, this.apiToken, params).then(function (response) { return schema.parse(response.data); });
     };
-    WorkspaceUsersClient.prototype.getUserByEmail = function (workspaceId, email, options) {
+    WorkspaceUsersClient.prototype.getUserByEmail = function (args, options) {
         var method = 'GET';
         var url = 'workspace_users/get_by_email';
-        var params = { id: workspaceId, email: email };
+        var params = { id: args.workspaceId, email: args.email };
         var schema = entities_1.WorkspaceUserSchema;
         if (options === null || options === void 0 ? void 0 : options.batch) {
             return { method: method, url: url, params: params, schema: schema };
         }
         return (0, rest_client_1.request)(method, this.getBaseUri(), url, this.apiToken, params).then(function (response) { return schema.parse(response.data); });
     };
-    WorkspaceUsersClient.prototype.getUserInfo = function (workspaceId, userId, options) {
+    WorkspaceUsersClient.prototype.getUserInfo = function (args, options) {
         var method = 'GET';
         var url = 'workspace_users/get_info';
-        var params = { id: workspaceId, user_id: userId };
+        var params = { id: args.workspaceId, user_id: args.userId };
         if (options === null || options === void 0 ? void 0 : options.batch) {
             return { method: method, url: url, params: params };
         }
         return (0, rest_client_1.request)(method, this.getBaseUri(), url, this.apiToken, params).then(function (response) { return response.data; });
     };
-    WorkspaceUsersClient.prototype.getUserLocalTime = function (workspaceId, userId, options) {
+    WorkspaceUsersClient.prototype.getUserLocalTime = function (args, options) {
         var method = 'GET';
         var url = 'workspace_users/get_local_time';
-        var params = { id: workspaceId, user_id: userId };
+        var params = { id: args.workspaceId, user_id: args.userId };
         if (options === null || options === void 0 ? void 0 : options.batch) {
             return { method: method, url: url, params: params };
         }

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

@@ -140,4 +140,3 @@ export declare class WorkspacesClient {
         batch?: false;
     }): Promise<Channel[]>;
 }
-//# sourceMappingURL=workspaces-client.d.ts.map

package/dist/consts/endpoints.d.ts

@@ -13,4 +13,3 @@ export declare const ENDPOINT_INBOX = "inbox";
 export declare const ENDPOINT_REACTIONS = "reactions";
 export declare const ENDPOINT_SEARCH = "search";
 export declare const ENDPOINT_CONVERSATION_MESSAGES = "conversation_messages";
-//# sourceMappingURL=endpoints.d.ts.map

package/dist/index.d.ts

@@ -7,4 +7,3 @@ export { SearchClient } from './clients/search-client';
 export { TwistApi } from './twist-api';
 export * from './types/index';
 export * from './utils/index';
-//# sourceMappingURL=index.d.ts.map

package/dist/rest-client.d.ts

@@ -2,4 +2,3 @@ import { HttpMethod, HttpResponse } from './types/http';
 export declare function paramsSerializer(params: Record<string, unknown>): string;
 export declare function request<T>(httpMethod: HttpMethod, baseUri: string, relativePath: string, apiToken?: string, payload?: Record<string, unknown>, requestId?: string): Promise<HttpResponse<T>>;
 export declare function isSuccess(response: HttpResponse): boolean;
-//# sourceMappingURL=rest-client.d.ts.map

package/dist/twist-api.d.ts

@@ -61,4 +61,3 @@ export declare class TwistApi {
      */
     batch<T extends readonly BatchRequestDescriptor<unknown>[]>(...requests: T): Promise<BatchResponseArray<T>>;
 }
-//# sourceMappingURL=twist-api.d.ts.map

package/dist/types/batch.d.ts

@@ -33,4 +33,3 @@ export type BatchApiResponse = {
     headers: string;
     body: string;
 };
-//# sourceMappingURL=batch.d.ts.map

package/dist/types/entities.d.ts

@@ -2,15 +2,12 @@ import { z } from 'zod';
 export declare const SystemMessageSchema: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodUnknown]>>>;
 export declare const UserSchema: z.ZodObject<{
     id: z.ZodNumber;
-    email: z.ZodString;
     name: z.ZodString;
     shortName: z.ZodString;
     firstName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     contactInfo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     bot: z.ZodBoolean;
     profession: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    snoozeDndStart: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    clientId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     timezone: z.ZodString;
     removed: z.ZodBoolean;
     avatarId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -20,21 +17,24 @@ export declare const UserSchema: z.ZodObject<{
         s195: z.ZodString;
         s640: z.ZodString;
     }, z.core.$strip>>>;
-    cometChannel: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    lang: z.ZodString;
     awayMode: z.ZodOptional<z.ZodNullable<z.ZodObject<{
         dateFrom: z.ZodString;
         type: z.ZodString;
         dateTo: z.ZodString;
     }, z.core.$strip>>>;
+    restricted: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    setupPending: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodBoolean, z.ZodNumber]>>>;
+    email: z.ZodEmail;
+    snoozeDndStart: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    clientId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    cometChannel: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    lang: z.ZodString;
     cometServer: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     offDays: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
-    restricted: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
     defaultWorkspace: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
     token: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     snoozeDndEnd: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     snoozed: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
-    setupPending: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodBoolean, z.ZodNumber]>>>;
     snoozeUntil: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
     scheduledBanners: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
 }, z.core.$strip>;
@@ -214,14 +214,13 @@ export type Comment = z.infer<typeof CommentSchema>;
 export declare const WorkspaceUserSchema: z.ZodObject<{
     id: z.ZodNumber;
     name: z.ZodString;
-    email: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    userType: z.ZodEnum<{
-        USER: "USER";
-        GUEST: "GUEST";
-        ADMIN: "ADMIN";
-    }>;
     shortName: z.ZodString;
     firstName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    contactInfo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    bot: z.ZodBoolean;
+    profession: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    timezone: z.ZodString;
+    removed: z.ZodBoolean;
     avatarId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     avatarUrls: z.ZodOptional<z.ZodNullable<z.ZodObject<{
         s35: z.ZodString;
@@ -234,17 +233,18 @@ export declare const WorkspaceUserSchema: z.ZodObject<{
         type: z.ZodString;
         dateTo: z.ZodString;
     }, z.core.$strip>>>;
-    bot: z.ZodBoolean;
-    contactInfo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    dateFormat: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    featureFlags: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
-    profession: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    removed: z.ZodBoolean;
     restricted: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
     setupPending: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodBoolean, z.ZodNumber]>>>;
+    email: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    userType: z.ZodEnum<{
+        USER: "USER";
+        GUEST: "GUEST";
+        ADMIN: "ADMIN";
+    }>;
+    dateFormat: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    featureFlags: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
     theme: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     timeFormat: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    timezone: z.ZodString;
     version: z.ZodNumber;
 }, z.core.$strip>;
 export type WorkspaceUser = z.infer<typeof WorkspaceUserSchema>;
@@ -364,4 +364,3 @@ export declare const SearchResultSchema: z.ZodObject<{
     closed: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
 }, z.core.$strip>;
 export type SearchResult = z.infer<typeof SearchResultSchema>;
-//# sourceMappingURL=entities.d.ts.map

package/dist/types/entities.js

@@ -5,18 +5,15 @@ var zod_1 = require("zod");
 var enums_1 = require("./enums");
 // Reusable schema for system messages that can be either a string or an object
 exports.SystemMessageSchema = zod_1.z.union([zod_1.z.string(), zod_1.z.unknown()]).nullable().optional();
-// User entity from API
-exports.UserSchema = zod_1.z.object({
+// Base user schema with common fields shared between User and WorkspaceUser
+var BaseUserSchema = zod_1.z.object({
     id: zod_1.z.number(),
-    email: zod_1.z.string().email(),
     name: zod_1.z.string(),
     shortName: zod_1.z.string(),
     firstName: zod_1.z.string().nullable().optional(),
     contactInfo: zod_1.z.string().nullable().optional(),
     bot: zod_1.z.boolean(),
     profession: zod_1.z.string().nullable().optional(),
-    snoozeDndStart: zod_1.z.string().nullable().optional(),
-    clientId: zod_1.z.string().nullable().optional(),
     timezone: zod_1.z.string(),
     removed: zod_1.z.boolean(),
     avatarId: zod_1.z.string().nullable().optional(),
@@ -29,8 +26,6 @@ exports.UserSchema = zod_1.z.object({
     })
         .nullable()
         .optional(),
-    cometChannel: zod_1.z.string().nullable().optional(),
-    lang: zod_1.z.string(),
     awayMode: zod_1.z
         .object({
         dateFrom: zod_1.z.string(),
@@ -39,14 +34,22 @@ exports.UserSchema = zod_1.z.object({
     })
         .nullable()
         .optional(),
+    restricted: zod_1.z.boolean().nullable().optional(),
+    setupPending: zod_1.z.union([zod_1.z.boolean(), zod_1.z.number()]).nullable().optional(),
+});
+// User entity from API
+exports.UserSchema = BaseUserSchema.extend({
+    email: zod_1.z.email(),
+    snoozeDndStart: zod_1.z.string().nullable().optional(),
+    clientId: zod_1.z.string().nullable().optional(),
+    cometChannel: zod_1.z.string().nullable().optional(),
+    lang: zod_1.z.string(),
     cometServer: zod_1.z.string().nullable().optional(),
     offDays: zod_1.z.array(zod_1.z.number()).nullable().optional(),
-    restricted: zod_1.z.boolean().nullable().optional(),
     defaultWorkspace: zod_1.z.number().nullable().optional(),
     token: zod_1.z.string().nullable().optional(),
     snoozeDndEnd: zod_1.z.string().nullable().optional(),
     snoozed: zod_1.z.boolean().nullable().optional(),
-    setupPending: zod_1.z.union([zod_1.z.boolean(), zod_1.z.number()]).nullable().optional(),
     snoozeUntil: zod_1.z.number().nullable().optional(),
     scheduledBanners: zod_1.z.array(zod_1.z.string()).nullable().optional(),
 });
@@ -230,42 +233,13 @@ exports.CommentSchema = zod_1.z.object({
     actions: zod_1.z.array(zod_1.z.unknown()).nullable().optional(),
 });
 // WorkspaceUser entity from v4 API
-exports.WorkspaceUserSchema = zod_1.z.object({
-    id: zod_1.z.number(),
-    name: zod_1.z.string(),
+exports.WorkspaceUserSchema = BaseUserSchema.extend({
     email: zod_1.z.string().nullable().optional(),
     userType: zod_1.z.enum(enums_1.USER_TYPES),
-    shortName: zod_1.z.string(),
-    firstName: zod_1.z.string().nullable().optional(),
-    avatarId: zod_1.z.string().nullable().optional(),
-    avatarUrls: zod_1.z
-        .object({
-        s35: zod_1.z.string(),
-        s60: zod_1.z.string(),
-        s195: zod_1.z.string(),
-        s640: zod_1.z.string(),
-    })
-        .nullable()
-        .optional(),
-    awayMode: zod_1.z
-        .object({
-        dateFrom: zod_1.z.string(),
-        type: zod_1.z.string(),
-        dateTo: zod_1.z.string(),
-    })
-        .nullable()
-        .optional(),
-    bot: zod_1.z.boolean(),
-    contactInfo: zod_1.z.string().nullable().optional(),
     dateFormat: zod_1.z.string().nullable().optional(),
     featureFlags: zod_1.z.array(zod_1.z.string()).nullable().optional(),
-    profession: zod_1.z.string().nullable().optional(),
-    removed: zod_1.z.boolean(),
-    restricted: zod_1.z.boolean().nullable().optional(),
-    setupPending: zod_1.z.union([zod_1.z.boolean(), zod_1.z.number()]).nullable().optional(),
     theme: zod_1.z.string().nullable().optional(),
     timeFormat: zod_1.z.string().nullable().optional(),
-    timezone: zod_1.z.string(),
     version: zod_1.z.number(),
 });
 // ConversationMessage entity from API