@doist/comms-sdk 0.1.0-alpha.1 → 0.2.1

package/dist/cjs/types/entities.js

@@ -1,6 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SearchResultSchema = exports.SEARCH_RESULT_TYPES = exports.UnreadConversationSchema = exports.UnreadThreadSchema = exports.InboxThreadSchema = exports.ConversationMessageSchema = exports.WorkspaceUserSchema = exports.CommentSchema = exports.ConversationSchema = exports.GroupSchema = exports.ThreadSchema = exports.ChannelSchema = exports.WorkspaceSchema = exports.UserSchema = exports.BaseUserSchema = exports.AttachmentSchema = exports.StatusOkSchema = exports.SystemMessageSchema = void 0;
+exports.SearchResultSchema = exports.SEARCH_RESULT_TYPES = exports.UnreadConversationSchema = exports.UnreadThreadSchema = exports.InboxThreadSchema = exports.ConversationMessageSchema = exports.ConversationMessageObjectSchema = exports.WorkspaceUserSchema = exports.CommentSchema = exports.CommentObjectSchema = exports.ConversationSchema = exports.ConversationObjectSchema = exports.GroupSchema = exports.ThreadSchema = exports.ThreadObjectSchema = exports.ChannelSchema = exports.ChannelObjectSchema = exports.WorkspaceSchema = exports.UserSchema = exports.BaseUserSchema = exports.AttachmentSchema = exports.StatusOkSchema = exports.SystemMessageSchema = void 0;
+exports.createChannelSchema = createChannelSchema;
+exports.createThreadSchema = createThreadSchema;
+exports.createConversationSchema = createConversationSchema;
+exports.createCommentSchema = createCommentSchema;
+exports.createConversationMessageSchema = createConversationMessageSchema;
+exports.createInboxThreadObjectSchema = createInboxThreadObjectSchema;
+exports.createInboxThreadSchema = createInboxThreadSchema;
 const zod_1 = require("zod");
 const url_helpers_1 = require("../utils/url-helpers");
 const enums_1 = require("./enums");
@@ -100,8 +107,7 @@ exports.WorkspaceSchema = zod_1.z.object({
         .optional(),
     plan: zod_1.z.string().nullable().optional(),
 });
-exports.ChannelSchema = zod_1.z
-    .object({
+exports.ChannelObjectSchema = zod_1.z.object({
     id: zod_1.z.string(),
     name: zod_1.z.string(),
     description: zod_1.z.string().nullable().optional(),
@@ -119,15 +125,17 @@ exports.ChannelSchema = zod_1.z
     icon: zod_1.z.number().nullable().optional(),
     version: zod_1.z.number(),
     filters: zod_1.z.record(zod_1.z.string(), zod_1.z.string()).nullable().optional(),
-})
-    .transform((data) => ({
-    ...data,
-    url: (0, url_helpers_1.getFullCommsURL)({ workspaceId: data.workspaceId, channelId: data.id }),
-}));
+});
+function createChannelSchema(linkBaseUrl) {
+    return exports.ChannelObjectSchema.transform((data) => ({
+        ...data,
+        url: (0, url_helpers_1.getFullCommsURL)({ workspaceId: data.workspaceId, channelId: data.id }, linkBaseUrl),
+    }));
+}
+exports.ChannelSchema = createChannelSchema();
 // Thread entity from API. `pinned` (boolean) and `pinnedTs` (epoch ms or
 // null) are both surfaced — `pinned` is kept for Zapier/webhook clients.
-exports.ThreadSchema = zod_1.z
-    .object({
+exports.ThreadObjectSchema = zod_1.z.object({
     id: zod_1.z.string(),
     title: zod_1.z.string(),
     content: zod_1.z.string(),
@@ -191,15 +199,18 @@ exports.ThreadSchema = zod_1.z
     })
         .nullable()
         .optional(),
-})
-    .transform((data) => ({
-    ...data,
-    url: (0, url_helpers_1.getFullCommsURL)({
-        workspaceId: data.workspaceId,
-        channelId: data.channelId,
-        threadId: data.id,
-    }),
-}));
+});
+function createThreadSchema(linkBaseUrl) {
+    return exports.ThreadObjectSchema.transform((data) => ({
+        ...data,
+        url: (0, url_helpers_1.getFullCommsURL)({
+            workspaceId: data.workspaceId,
+            channelId: data.channelId,
+            threadId: data.id,
+        }, linkBaseUrl),
+    }));
+}
+exports.ThreadSchema = createThreadSchema();
 // Group entity from API. The broadcast markers `EVERYONE` and
 // `EVERYONE_IN_THREAD` can appear in place of a real `id` in group-bearing
 // fields on threads/comments/channels.
@@ -212,8 +223,7 @@ exports.GroupSchema = zod_1.z.object({
     version: zod_1.z.number(),
 });
 // Conversation entity from API.
-exports.ConversationSchema = zod_1.z
-    .object({
+exports.ConversationObjectSchema = zod_1.z.object({
     id: zod_1.z.string(),
     workspaceId: zod_1.z.number(),
     userIds: zod_1.z.array(zod_1.z.number()),
@@ -250,13 +260,15 @@ exports.ConversationSchema = zod_1.z
     })
         .nullable()
         .optional(),
-})
-    .transform((data) => ({
-    ...data,
-    url: (0, url_helpers_1.getFullCommsURL)({ workspaceId: data.workspaceId, conversationId: data.id }),
-}));
-exports.CommentSchema = zod_1.z
-    .object({
+});
+function createConversationSchema(linkBaseUrl) {
+    return exports.ConversationObjectSchema.transform((data) => ({
+        ...data,
+        url: (0, url_helpers_1.getFullCommsURL)({ workspaceId: data.workspaceId, conversationId: data.id }, linkBaseUrl),
+    }));
+}
+exports.ConversationSchema = createConversationSchema();
+exports.CommentObjectSchema = zod_1.z.object({
     id: zod_1.z.string(),
     content: zod_1.z.string(),
     creator: zod_1.z.number(),
@@ -280,16 +292,19 @@ exports.CommentSchema = zod_1.z
     deletedBy: zod_1.z.number().nullable().optional(),
     version: zod_1.z.number().nullable().optional(),
     actions: zod_1.z.array(zod_1.z.unknown()).nullable().optional(),
-})
-    .transform((data) => ({
-    ...data,
-    url: (0, url_helpers_1.getFullCommsURL)({
-        workspaceId: data.workspaceId,
-        channelId: data.channelId,
-        threadId: data.threadId,
-        commentId: data.id,
-    }),
-}));
+});
+function createCommentSchema(linkBaseUrl) {
+    return exports.CommentObjectSchema.transform((data) => ({
+        ...data,
+        url: (0, url_helpers_1.getFullCommsURL)({
+            workspaceId: data.workspaceId,
+            channelId: data.channelId,
+            threadId: data.threadId,
+            commentId: data.id,
+        }, linkBaseUrl),
+    }));
+}
+exports.CommentSchema = createCommentSchema();
 exports.WorkspaceUserSchema = exports.BaseUserSchema.extend({
     email: zod_1.z.string().nullable().optional(),
     userType: zod_1.z.enum(enums_1.USER_TYPES),
@@ -302,8 +317,7 @@ exports.WorkspaceUserSchema = exports.BaseUserSchema.extend({
 // (coerced to a string post-parse) because the backend currently emits
 // either shape depending on the endpoint; the URL/reaction helpers accept
 // both.
-exports.ConversationMessageSchema = zod_1.z
-    .object({
+exports.ConversationMessageObjectSchema = zod_1.z.object({
     id: zod_1.z.union([zod_1.z.string(), zod_1.z.number()]).transform(String),
     content: zod_1.z.string(),
     creator: zod_1.z.number(),
@@ -320,65 +334,72 @@ exports.ConversationMessageSchema = zod_1.z
     directMentions: zod_1.z.array(zod_1.z.number()).nullable().optional(),
     version: zod_1.z.number().nullable().optional(),
     workspaceId: zod_1.z.number(),
-})
-    .transform((data) => ({
-    ...data,
-    url: (0, url_helpers_1.getFullCommsURL)({
-        workspaceId: data.workspaceId,
-        conversationId: data.conversationId,
-        messageId: data.id,
-    }),
-}));
+});
+function createConversationMessageSchema(linkBaseUrl) {
+    return exports.ConversationMessageObjectSchema.transform((data) => ({
+        ...data,
+        url: (0, url_helpers_1.getFullCommsURL)({
+            workspaceId: data.workspaceId,
+            conversationId: data.conversationId,
+            messageId: data.id,
+        }, linkBaseUrl),
+    }));
+}
+exports.ConversationMessageSchema = createConversationMessageSchema();
 // InboxThread entity from API - returns full Thread objects with additional inbox metadata.
-exports.InboxThreadSchema = zod_1.z
-    .object({
-    id: zod_1.z.string(),
-    title: zod_1.z.string(),
-    content: zod_1.z.string(),
-    creator: zod_1.z.number(),
-    creatorName: zod_1.z.string().nullable().optional(),
-    channelId: zod_1.z.string(),
-    workspaceId: zod_1.z.number(),
-    actions: zod_1.z.array(zod_1.z.unknown()).nullable().optional(),
-    attachments: zod_1.z.array(exports.AttachmentSchema).nullable().optional(),
-    commentCount: zod_1.z.number(),
-    directGroupMentions: zod_1.z.array(zod_1.z.string()).nullable().optional(),
-    directMentions: zod_1.z.array(zod_1.z.number()).nullable().optional(),
-    groups: zod_1.z.array(zod_1.z.string()).nullable().optional(),
-    lastEdited: zod_1.z.date().nullable().optional(),
-    lastObjIndex: zod_1.z.number().nullable().optional(),
-    lastUpdated: zod_1.z.date(),
-    mutedUntil: zod_1.z.date().nullable().optional(),
-    participants: zod_1.z.array(zod_1.z.number()).nullable().optional(),
-    // Backend wire shape only includes `pinned_ts` (epoch ms or null);
-    // derive `pinned` from `pinnedTs != null` if you need a bool.
-    pinned: zod_1.z.boolean().optional(),
-    pinnedTs: zod_1.z.number().int().nullable().optional(),
-    posted: zod_1.z.date(),
-    reactions: zod_1.z.record(zod_1.z.string(), zod_1.z.array(zod_1.z.number())).nullable().optional(),
-    recipients: zod_1.z.array(zod_1.z.number()).nullable().optional(),
-    snippet: zod_1.z.string(),
-    snippetCreator: zod_1.z.number(),
-    snippetMaskAvatarUrl: zod_1.z.string().nullable().optional(),
-    snippetMaskPoster: zod_1.z.string().nullable().optional(),
-    systemMessage: exports.SystemMessageSchema,
-    isArchived: zod_1.z.boolean(),
-    inInbox: zod_1.z.boolean(),
-    isSaved: zod_1.z.boolean().nullable().optional(),
-    closed: zod_1.z.boolean(),
-    responders: zod_1.z.array(zod_1.z.number()).nullable().optional(),
-    lastComment: exports.CommentSchema.nullable().optional(),
-    toEmails: zod_1.z.array(zod_1.z.string()).nullable().optional(),
-    version: zod_1.z.number().nullable().optional(),
-})
-    .transform((data) => ({
-    ...data,
-    url: (0, url_helpers_1.getFullCommsURL)({
-        workspaceId: data.workspaceId,
-        channelId: data.channelId,
-        threadId: data.id,
-    }),
-}));
+function createInboxThreadObjectSchema(linkBaseUrl) {
+    return zod_1.z.object({
+        id: zod_1.z.string(),
+        title: zod_1.z.string(),
+        content: zod_1.z.string(),
+        creator: zod_1.z.number(),
+        creatorName: zod_1.z.string().nullable().optional(),
+        channelId: zod_1.z.string(),
+        workspaceId: zod_1.z.number(),
+        actions: zod_1.z.array(zod_1.z.unknown()).nullable().optional(),
+        attachments: zod_1.z.array(exports.AttachmentSchema).nullable().optional(),
+        commentCount: zod_1.z.number(),
+        directGroupMentions: zod_1.z.array(zod_1.z.string()).nullable().optional(),
+        directMentions: zod_1.z.array(zod_1.z.number()).nullable().optional(),
+        groups: zod_1.z.array(zod_1.z.string()).nullable().optional(),
+        lastEdited: zod_1.z.date().nullable().optional(),
+        lastObjIndex: zod_1.z.number().nullable().optional(),
+        lastUpdated: zod_1.z.date(),
+        mutedUntil: zod_1.z.date().nullable().optional(),
+        participants: zod_1.z.array(zod_1.z.number()).nullable().optional(),
+        // Backend wire shape only includes `pinned_ts` (epoch ms or null);
+        // derive `pinned` from `pinnedTs != null` if you need a bool.
+        pinned: zod_1.z.boolean().optional(),
+        pinnedTs: zod_1.z.number().int().nullable().optional(),
+        posted: zod_1.z.date(),
+        reactions: zod_1.z.record(zod_1.z.string(), zod_1.z.array(zod_1.z.number())).nullable().optional(),
+        recipients: zod_1.z.array(zod_1.z.number()).nullable().optional(),
+        snippet: zod_1.z.string(),
+        snippetCreator: zod_1.z.number(),
+        snippetMaskAvatarUrl: zod_1.z.string().nullable().optional(),
+        snippetMaskPoster: zod_1.z.string().nullable().optional(),
+        systemMessage: exports.SystemMessageSchema,
+        isArchived: zod_1.z.boolean(),
+        inInbox: zod_1.z.boolean(),
+        isSaved: zod_1.z.boolean().nullable().optional(),
+        closed: zod_1.z.boolean(),
+        responders: zod_1.z.array(zod_1.z.number()).nullable().optional(),
+        lastComment: createCommentSchema(linkBaseUrl).nullable().optional(),
+        toEmails: zod_1.z.array(zod_1.z.string()).nullable().optional(),
+        version: zod_1.z.number().nullable().optional(),
+    });
+}
+function createInboxThreadSchema(linkBaseUrl) {
+    return createInboxThreadObjectSchema(linkBaseUrl).transform((data) => ({
+        ...data,
+        url: (0, url_helpers_1.getFullCommsURL)({
+            workspaceId: data.workspaceId,
+            channelId: data.channelId,
+            threadId: data.id,
+        }, linkBaseUrl),
+    }));
+}
+exports.InboxThreadSchema = createInboxThreadSchema();
 // UnreadThread entity from API - simplified thread reference.
 exports.UnreadThreadSchema = zod_1.z.object({
     threadId: zod_1.z.string(),

package/dist/cjs/types/index.js

@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./api-version"), exports);
 __exportStar(require("./entities"), exports);
 __exportStar(require("./enums"), exports);
 __exportStar(require("./errors"), exports);

package/dist/cjs/types/requests.js

@@ -97,7 +97,6 @@ exports.GetThreadsArgsSchema = zod_1.z.object({
 });
 exports.GetCommentsArgsSchema = zod_1.z.object({
     threadId: zod_1.z.string(),
-    from: zod_1.z.date().nullable().optional(),
     newerThan: zod_1.z.date().nullable().optional(),
     olderThan: zod_1.z.date().nullable().optional(),
     limit: zod_1.z.number().nullable().optional(),

package/dist/cjs/utils/url-helpers.js

@@ -64,7 +64,9 @@ function getCommsURL(params) {
  * @param baseUrl - Optional base URL (defaults to 'https://comms.todoist.com')
  */
 function getFullCommsURL(params, baseUrl = COMMS_BASE_URL) {
-    return `${baseUrl}${getCommsURL(params)}`;
+    // Strip a trailing slash so links don't double up — `getCommsURL` paths start with '/'.
+    const normalizedBase = baseUrl.endsWith('/') ? baseUrl.slice(0, -1) : baseUrl;
+    return `${normalizedBase}${getCommsURL(params)}`;
 }
 /** Returns the URL for a thread in a channel. */
 function getThreadURL(params) {

package/dist/esm/clients/add-comment-helper.js

@@ -1,6 +1,5 @@
 import { ENDPOINT_COMMENTS } from '../consts/endpoints.js';
 import { request } from '../transport/http-client.js';
-import { CommentSchema } from '../types/entities.js';
 import { NOTIFY_AUDIENCE_GROUP_IDS, NOTIFY_AUDIENCES } from '../types/enums.js';
 import { resolveCreateId } from '../utils/uuidv7.js';
 const SENTINEL_GROUP_IDS = new Set(Object.values(NOTIFY_AUDIENCE_GROUP_IDS));
@@ -33,6 +32,23 @@ function applyNotifyAudience(params) {
     const { notifyAudience: _stripped, groups, ...rest } = params;
     return { ...rest, groups: [...(groups ?? []), sentinel] };
 }
+/**
+ * Internal helper that powers `comments.createComment`,
+ * `threads.closeThread`, and `threads.reopenThread`.
+ *
+ * Normalizes the `notifyAudience` flag into a sentinel `groups` entry,
+ * rejects sentinel IDs passed via `groups` / `directGroupMentions`, mints a
+ * UUIDv7 `id` when the caller omits one, and posts to `/comments/add`. When
+ * `threadAction` is set (`'close'` / `'reopen'`), it is forwarded on the
+ * wire so the same request both adds the comment and transitions the
+ * parent thread.
+ *
+ * @param context - Per-call client context (base URI, API token, optional `customFetch`).
+ * @param params - The comment payload (`{@link CreateCommentArgs}`).
+ * @param options - Optional configuration.
+ * @param options.threadAction - When set, also transitions the parent thread (`'close'` or `'reopen'`).
+ * @returns The parsed {@link Comment} returned by the API.
+ */
 export function addCommentRequest(context, params, options) {
     const normalized = applyNotifyAudience(params);
     const withId = { ...normalized, id: resolveCreateId(normalized.id) };
@@ -46,5 +62,5 @@ export function addCommentRequest(context, params, options) {
         apiToken: context.apiToken,
         payload,
         customFetch: context.customFetch,
-    }).then((response) => CommentSchema.parse(response.data));
+    }).then((response) => context.schema.parse(response.data));
 }

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

@@ -1,4 +1,5 @@
 import { getCommsBaseUri } from '../consts/endpoints.js';
+import { DEFAULT_API_VERSION } from '../types/api-version.js';
 /**
  * Base class for every Comms API client. Centralizes URL handling and
  * config so individual clients stay focused on their endpoints.
@@ -7,6 +8,7 @@ export class BaseClient {
     constructor(config) {
         this.apiToken = config.apiToken;
         this.baseUrl = config.baseUrl;
+        this.defaultVersion = config.version || DEFAULT_API_VERSION;
         this.customFetch = config.customFetch;
     }
     /**
@@ -14,10 +16,14 @@ export class BaseClient {
      * slash so relative paths resolve cleanly through `URL`.
      */
     getBaseUri() {
-        if (this.baseUrl) {
-            const normalizedBaseUrl = this.baseUrl.endsWith('/') ? this.baseUrl : `${this.baseUrl}/`;
-            return `${normalizedBaseUrl}api/v1/`;
-        }
-        return getCommsBaseUri();
+        return getCommsBaseUri(this.defaultVersion, this.baseUrl);
+    }
+    /**
+     * Base URL for entity web links, or `undefined` to use getFullCommsURL's
+     * default web app. Trailing-slash normalization happens in
+     * `getFullCommsURL`, so the configured value is returned verbatim.
+     */
+    getLinkBaseUrl() {
+        return this.baseUrl;
     }
 }

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

@@ -1,7 +1,7 @@
 import { z } from 'zod';
 import { ENDPOINT_CHANNELS } from '../consts/endpoints.js';
 import { request } from '../transport/http-client.js';
-import { ChannelSchema, StatusOkSchema } from '../types/entities.js';
+import { ChannelSchema, createChannelSchema, StatusOkSchema, } from '../types/entities.js';
 import { resolveCreateId } from '../utils/uuidv7.js';
 import { BaseClient } from './base-client.js';
 export const ChannelListSchema = z.array(ChannelSchema);
@@ -11,7 +11,31 @@ export const ChannelListSchema = z.array(ChannelSchema);
  * to keep an optimistic-UI ID stable through the round-trip.
  */
 export class ChannelsClient extends BaseClient {
-    /** Lists channels in a workspace. */
+    constructor() {
+        super(...arguments);
+        this.linkBaseUrl = this.getLinkBaseUrl();
+        // Reuse the shared singletons when no custom base is configured.
+        this.channelSchema = this.linkBaseUrl
+            ? createChannelSchema(this.linkBaseUrl)
+            : ChannelSchema;
+        this.channelListSchema = this.linkBaseUrl
+            ? z.array(this.channelSchema)
+            : ChannelListSchema;
+    }
+    /**
+     * Gets all channels for a given workspace.
+     *
+     * @param args - The arguments for getting channels.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.archived - Optional flag to include archived channels.
+     * @returns An array of channel objects.
+     *
+     * @example
+     * ```typescript
+     * const channels = await api.channels.getChannels({ workspaceId: 123 })
+     * channels.forEach(ch => console.log(ch.name))
+     * ```
+     */
     getChannels(args) {
         return request({
             httpMethod: 'GET',
@@ -20,51 +44,155 @@ export class ChannelsClient extends BaseClient {
             apiToken: this.apiToken,
             payload: args,
             customFetch: this.customFetch,
-        }).then((response) => ChannelListSchema.parse(response.data));
+        }).then((response) => this.channelListSchema.parse(response.data));
     }
-    /** Fetches a single channel by ID. */
+    /**
+     * Gets a single channel object by id.
+     *
+     * @param id - The channel ID.
+     * @returns The channel object.
+     */
     getChannel(id) {
-        return this.simple('GET', 'getone', { id }, ChannelSchema);
+        return this.simple('GET', 'getone', { id }, this.channelSchema);
     }
-    /** Creates a new channel. `id` is auto-generated if not supplied. */
+    /**
+     * Creates a new channel. `id` is auto-generated if not supplied — pass your
+     * own `id` to keep an optimistic-UI ID stable through the round-trip.
+     *
+     * @param args - The arguments for creating a channel.
+     * @param args.workspaceId - The workspace ID.
+     * @param args.name - The channel name.
+     * @param args.description - Optional channel description.
+     * @param args.color - Optional channel color.
+     * @param args.userIds - Optional array of user IDs to add to the channel.
+     * @param args.public - Optional flag to make the channel public.
+     * @returns The created channel object.
+     *
+     * @example
+     * ```typescript
+     * const channel = await api.channels.createChannel({
+     *   workspaceId: 123,
+     *   name: 'Engineering',
+     *   description: 'Engineering team channel',
+     * })
+     * ```
+     */
     createChannel(args) {
-        return this.simple('POST', 'add', { ...args, id: resolveCreateId(args.id) }, ChannelSchema);
+        return this.simple('POST', 'add', { ...args, id: resolveCreateId(args.id) }, this.channelSchema);
     }
-    /** Partial update of an existing channel. */
+    /**
+     * Partial update of an existing channel.
+     *
+     * @param args - The arguments for updating a channel.
+     * @param args.id - The channel ID.
+     * @param args.name - Optional new channel name.
+     * @param args.description - Optional new channel description.
+     * @param args.color - Optional new channel color.
+     * @param args.public - Optional flag to change channel visibility.
+     * @returns The updated channel object.
+     */
     updateChannel(args) {
-        return this.simple('POST', 'update', { ...args }, ChannelSchema);
+        return this.simple('POST', 'update', { ...args }, this.channelSchema);
     }
-    /** Updates the channel's view filter (`only_open` / `all` / `only_closed`). */
+    /**
+     * Updates the channel's view filter (`only_open` / `all` / `only_closed`).
+     *
+     * @param args - The arguments for updating the channel filter.
+     * @param args.id - The channel ID.
+     * @param args.filterClosed - The new filter value.
+     */
     updateFilters(args) {
         return this.simple('POST', 'update_filters', { ...args }, StatusOkSchema);
     }
-    /** Permanently deletes a channel. */
+    /**
+     * Permanently deletes a channel.
+     *
+     * @param id - The channel ID.
+     */
     deleteChannel(id) {
         return this.simple('POST', 'remove', { id }, StatusOkSchema);
     }
+    /**
+     * Archives a channel.
+     *
+     * @param id - The channel ID.
+     */
     archiveChannel(id) {
         return this.simple('POST', 'archive', { id }, StatusOkSchema);
     }
+    /**
+     * Unarchives a channel.
+     *
+     * @param id - The channel ID.
+     */
     unarchiveChannel(id) {
         return this.simple('POST', 'unarchive', { id }, StatusOkSchema);
     }
+    /**
+     * Favorites a channel.
+     *
+     * @param id - The channel ID.
+     */
     favoriteChannel(id) {
         return this.simple('POST', 'favorite', { id }, StatusOkSchema);
     }
+    /**
+     * Unfavorites a channel.
+     *
+     * @param id - The channel ID.
+     */
     unfavoriteChannel(id) {
         return this.simple('POST', 'unfavorite', { id }, StatusOkSchema);
     }
+    /**
+     * Adds a user to a channel.
+     *
+     * @param args - The arguments for adding a user.
+     * @param args.id - The channel ID.
+     * @param args.userId - The user ID to add.
+     *
+     * @example
+     * ```typescript
+     * await api.channels.addUser({ id: '7YpL3oZ4kZ9vP7Q1tR2sX44', userId: 101 })
+     * ```
+     */
     addUser(args) {
-        return this.simple('POST', 'add_user', { ...args }, ChannelSchema);
+        return this.simple('POST', 'add_user', { ...args }, this.channelSchema);
     }
+    /**
+     * Adds multiple users to a channel.
+     *
+     * @param args - The arguments for adding users.
+     * @param args.id - The channel ID.
+     * @param args.userIds - Array of user IDs to add.
+     *
+     * @example
+     * ```typescript
+     * await api.channels.addUsers({ id: '7YpL3oZ4kZ9vP7Q1tR2sX44', userIds: [101, 202] })
+     * ```
+     */
     addUsers(args) {
-        return this.simple('POST', 'add_users', { ...args }, ChannelSchema);
+        return this.simple('POST', 'add_users', { ...args }, this.channelSchema);
     }
+    /**
+     * Removes a user from a channel.
+     *
+     * @param args - The arguments for removing a user.
+     * @param args.id - The channel ID.
+     * @param args.userId - The user ID to remove.
+     */
     removeUser(args) {
-        return this.simple('POST', 'remove_user', { ...args }, ChannelSchema);
+        return this.simple('POST', 'remove_user', { ...args }, this.channelSchema);
     }
+    /**
+     * Removes multiple users from a channel.
+     *
+     * @param args - The arguments for removing users.
+     * @param args.id - The channel ID.
+     * @param args.userIds - Array of user IDs to remove.
+     */
     removeUsers(args) {
-        return this.simple('POST', 'remove_users', { ...args }, ChannelSchema);
+        return this.simple('POST', 'remove_users', { ...args }, this.channelSchema);
     }
     simple(httpMethod, suffix, params, schema) {
         return request({