@doist/twist-sdk 2.1.4 → 2.2.0

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

@@ -0,0 +1,35 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addCommentRequest = addCommentRequest;
+var endpoints_1 = require("../consts/endpoints");
+var http_client_1 = require("../transport/http-client");
+var entities_1 = require("../types/entities");
+function addCommentRequest(context, params, options) {
+    var method = 'POST';
+    var url = "".concat(endpoints_1.ENDPOINT_COMMENTS, "/add");
+    var payload = (options === null || options === void 0 ? void 0 : options.threadAction)
+        ? __assign(__assign({}, params), { threadAction: options.threadAction }) : params;
+    var schema = entities_1.CommentSchema;
+    if (options === null || options === void 0 ? void 0 : options.batch) {
+        return { method: method, url: url, params: payload, schema: schema };
+    }
+    return (0, http_client_1.request)({
+        httpMethod: method,
+        baseUri: context.baseUri,
+        relativePath: url,
+        apiToken: context.apiToken,
+        payload: payload,
+        customFetch: context.customFetch,
+    }).then(function (response) { return schema.parse(response.data); });
+}

package/dist/cjs/clients/comments-client.js

@@ -20,6 +20,7 @@ var zod_1 = require("zod");
 var endpoints_1 = require("../consts/endpoints");
 var http_client_1 = require("../transport/http-client");
 var entities_1 = require("../types/entities");
+var add_comment_helper_1 = require("./add-comment-helper");
 var base_client_1 = require("./base-client");
 /**
  * Client for interacting with Twist comment endpoints.
@@ -70,21 +71,7 @@ var CommentsClient = /** @class */ (function (_super) {
         }).then(function (response) { return wrappedSchema.parse(response.data); });
     };
     CommentsClient.prototype.createComment = function (args, options) {
-        var method = 'POST';
-        var url = "".concat(endpoints_1.ENDPOINT_COMMENTS, "/add");
-        var params = args;
-        var schema = entities_1.CommentSchema;
-        if (options === null || options === void 0 ? void 0 : options.batch) {
-            return { method: method, url: url, params: params, schema: schema };
-        }
-        return (0, http_client_1.request)({
-            httpMethod: method,
-            baseUri: this.getBaseUri(),
-            relativePath: url,
-            apiToken: this.apiToken,
-            payload: params,
-            customFetch: this.customFetch,
-        }).then(function (response) { return schema.parse(response.data); });
+        return (0, add_comment_helper_1.addCommentRequest)({ baseUri: this.getBaseUri(), apiToken: this.apiToken, customFetch: this.customFetch }, args, options);
     };
     CommentsClient.prototype.updateComment = function (args, options) {
         var method = 'POST';

package/dist/cjs/clients/threads-client.js

@@ -14,12 +14,35 @@ var __extends = (this && this.__extends) || (function () {
         d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
     };
 })();
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ThreadsClient = void 0;
 var zod_1 = require("zod");
 var endpoints_1 = require("../consts/endpoints");
 var http_client_1 = require("../transport/http-client");
 var entities_1 = require("../types/entities");
+var add_comment_helper_1 = require("./add-comment-helper");
 var base_client_1 = require("./base-client");
 /**
  * Client for interacting with Twist thread endpoints.
@@ -361,6 +384,16 @@ var ThreadsClient = /** @class */ (function (_super) {
             customFetch: this.customFetch,
         }).then(function (response) { return schema.parse(response.data); });
     };
+    ThreadsClient.prototype.closeThread = function (args, options) {
+        return this.addCommentWithAction(args, 'close', options);
+    };
+    ThreadsClient.prototype.reopenThread = function (args, options) {
+        return this.addCommentWithAction(args, 'reopen', options);
+    };
+    ThreadsClient.prototype.addCommentWithAction = function (args, threadAction, options) {
+        var id = args.id, rest = __rest(args, ["id"]);
+        return (0, add_comment_helper_1.addCommentRequest)({ baseUri: this.getBaseUri(), apiToken: this.apiToken, customFetch: this.customFetch }, __assign({ threadId: id }, rest), __assign(__assign({}, options), { threadAction: threadAction }));
+    };
     return ThreadsClient;
 }(base_client_1.BaseClient));
 exports.ThreadsClient = ThreadsClient;

package/dist/cjs/types/requests.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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;
+exports.THREAD_ACTIONS = 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(),
@@ -91,3 +91,5 @@ exports.GetOrCreateConversationArgsSchema = zod_1.z.object({
     userIds: zod_1.z.array(zod_1.z.number()),
 });
 exports.AWAY_MODE_TYPES = ['parental', 'vacation', 'sickleave', 'other'];
+// Threads
+exports.THREAD_ACTIONS = ['close', 'reopen'];

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

@@ -0,0 +1,32 @@
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+import { ENDPOINT_COMMENTS } from '../consts/endpoints.js';
+import { request } from '../transport/http-client.js';
+import { CommentSchema } from '../types/entities.js';
+export function addCommentRequest(context, params, options) {
+    var method = 'POST';
+    var url = "".concat(ENDPOINT_COMMENTS, "/add");
+    var payload = (options === null || options === void 0 ? void 0 : options.threadAction)
+        ? __assign(__assign({}, params), { threadAction: options.threadAction }) : params;
+    var schema = CommentSchema;
+    if (options === null || options === void 0 ? void 0 : options.batch) {
+        return { method: method, url: url, params: payload, schema: schema };
+    }
+    return request({
+        httpMethod: method,
+        baseUri: context.baseUri,
+        relativePath: url,
+        apiToken: context.apiToken,
+        payload: payload,
+        customFetch: context.customFetch,
+    }).then(function (response) { return schema.parse(response.data); });
+}

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

@@ -17,6 +17,7 @@ import { z } from 'zod';
 import { ENDPOINT_COMMENTS } from '../consts/endpoints.js';
 import { request } from '../transport/http-client.js';
 import { CommentSchema } from '../types/entities.js';
+import { addCommentRequest } from './add-comment-helper.js';
 import { BaseClient } from './base-client.js';
 /**
  * Client for interacting with Twist comment endpoints.
@@ -67,21 +68,7 @@ var CommentsClient = /** @class */ (function (_super) {
         }).then(function (response) { return wrappedSchema.parse(response.data); });
     };
     CommentsClient.prototype.createComment = function (args, options) {
-        var method = 'POST';
-        var url = "".concat(ENDPOINT_COMMENTS, "/add");
-        var params = args;
-        var schema = CommentSchema;
-        if (options === null || options === void 0 ? void 0 : options.batch) {
-            return { method: method, url: url, params: params, schema: schema };
-        }
-        return request({
-            httpMethod: method,
-            baseUri: this.getBaseUri(),
-            relativePath: url,
-            apiToken: this.apiToken,
-            payload: params,
-            customFetch: this.customFetch,
-        }).then(function (response) { return schema.parse(response.data); });
+        return addCommentRequest({ baseUri: this.getBaseUri(), apiToken: this.apiToken, customFetch: this.customFetch }, args, options);
     };
     CommentsClient.prototype.updateComment = function (args, options) {
         var method = 'POST';

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

@@ -13,10 +13,33 @@ var __extends = (this && this.__extends) || (function () {
         d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
     };
 })();
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 import { z } from 'zod';
 import { ENDPOINT_THREADS } from '../consts/endpoints.js';
 import { request } from '../transport/http-client.js';
-import { ThreadSchema, UnreadThreadSchema } from '../types/entities.js';
+import { ThreadSchema, UnreadThreadSchema, } from '../types/entities.js';
+import { addCommentRequest } from './add-comment-helper.js';
 import { BaseClient } from './base-client.js';
 /**
  * Client for interacting with Twist thread endpoints.
@@ -358,6 +381,16 @@ var ThreadsClient = /** @class */ (function (_super) {
             customFetch: this.customFetch,
         }).then(function (response) { return schema.parse(response.data); });
     };
+    ThreadsClient.prototype.closeThread = function (args, options) {
+        return this.addCommentWithAction(args, 'close', options);
+    };
+    ThreadsClient.prototype.reopenThread = function (args, options) {
+        return this.addCommentWithAction(args, 'reopen', options);
+    };
+    ThreadsClient.prototype.addCommentWithAction = function (args, threadAction, options) {
+        var id = args.id, rest = __rest(args, ["id"]);
+        return addCommentRequest({ baseUri: this.getBaseUri(), apiToken: this.apiToken, customFetch: this.customFetch }, __assign({ threadId: id }, rest), __assign(__assign({}, options), { threadAction: threadAction }));
+    };
     return ThreadsClient;
 }(BaseClient));
 export { ThreadsClient };

package/dist/esm/types/requests.js

@@ -88,3 +88,5 @@ export var GetOrCreateConversationArgsSchema = z.object({
     userIds: z.array(z.number()),
 });
 export var AWAY_MODE_TYPES = ['parental', 'vacation', 'sickleave', 'other'];
+// Threads
+export var THREAD_ACTIONS = ['close', 'reopen'];

package/dist/types/clients/add-comment-helper.d.ts

@@ -0,0 +1,14 @@
+import type { BatchRequestDescriptor } from '../types/batch.js';
+import { type Comment } from '../types/entities.js';
+import type { CustomFetch } from '../types/http.js';
+import type { ThreadAction } from '../types/requests.js';
+type ClientContext = {
+    baseUri: string;
+    apiToken: string;
+    customFetch?: CustomFetch;
+};
+export declare function addCommentRequest(context: ClientContext, params: Record<string, unknown>, options?: {
+    batch?: boolean;
+    threadAction?: ThreadAction;
+}): Promise<Comment> | BatchRequestDescriptor<Comment>;
+export {};

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

@@ -1,6 +1,6 @@
 import type { BatchRequestDescriptor } from '../types/batch.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 { type Comment, type Thread, type UnreadThread } from '../types/entities.js';
+import { type CloseThreadArgs, type CreateThreadArgs, type GetThreadsArgs, type MarkThreadReadArgs, type MarkThreadUnreadArgs, type MarkThreadUnreadForOthersArgs, type MoveThreadToChannelArgs, type MuteThreadArgs, type ReopenThreadArgs, type UpdateThreadArgs } from '../types/requests.js';
 import { BaseClient } from './base-client.js';
 /**
  * Client for interacting with Twist thread endpoints.
@@ -319,4 +319,59 @@ export declare class ThreadsClient extends BaseClient {
     unmuteThread(id: number, options?: {
         batch?: false;
     }): Promise<Thread>;
+    /**
+     * Closes a thread by adding a comment with a close action.
+     *
+     * @param args - The arguments for closing a thread.
+     * @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.actions - Optional array of action objects.
+     * @param args.recipients - Optional array of user IDs to notify.
+     * @param options - Optional configuration. Set `batch: true` to return a descriptor for batch requests.
+     * @returns The created comment object.
+     *
+     * @example
+     * ```typescript
+     * const comment = await api.threads.closeThread({
+     *   id: 789,
+     *   content: 'Closing this thread — resolved.'
+     * })
+     * ```
+     */
+    closeThread(args: CloseThreadArgs, options: {
+        batch: true;
+    }): BatchRequestDescriptor<Comment>;
+    closeThread(args: CloseThreadArgs, options?: {
+        batch?: false;
+    }): Promise<Comment>;
+    /**
+     * Reopens a thread by adding a comment with a reopen action.
+     *
+     * @param args - The arguments for reopening a thread.
+     * @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.actions - Optional array of action objects.
+     * @param args.recipients - Optional array of user IDs to notify.
+     * @param options - Optional configuration. Set `batch: true` to return a descriptor for batch requests.
+     * @returns The created comment object.
+     *
+     * @example
+     * ```typescript
+     * const comment = await api.threads.reopenThread({
+     *   id: 789,
+     *   content: 'Reopening — need further discussion.'
+     * })
+     * ```
+     */
+    reopenThread(args: ReopenThreadArgs, options: {
+        batch: true;
+    }): BatchRequestDescriptor<Comment>;
+    reopenThread(args: ReopenThreadArgs, options?: {
+        batch?: false;
+    }): Promise<Comment>;
+    private addCommentWithAction;
 }

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

@@ -202,6 +202,24 @@ export type RemoveChannelUsersArgs = {
     id: number;
     userIds: number[];
 };
+export declare const THREAD_ACTIONS: readonly ["close", "reopen"];
+export type ThreadAction = (typeof THREAD_ACTIONS)[number];
+export type CloseThreadArgs = {
+    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 MoveThreadToChannelArgs = {
     id: number;
     toChannel: number;

package/package.json

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