@doist/twist-sdk 2.4.1 → 2.5.0

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

@@ -41,9 +41,10 @@ var SearchClient = /** @class */ (function (_super) {
     }
     SearchClient.prototype.search = function (args, options) {
         var params = {
-            query: args.query,
             workspace_id: args.workspaceId,
         };
+        if (args.query !== undefined)
+            params.query = args.query;
         if (args.channelIds)
             params.channel_ids = args.channelIds;
         if (args.authorIds)

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

@@ -38,9 +38,10 @@ var SearchClient = /** @class */ (function (_super) {
     }
     SearchClient.prototype.search = function (args, options) {
         var params = {
-            query: args.query,
             workspace_id: args.workspaceId,
         };
+        if (args.query !== undefined)
+            params.query = args.query;
         if (args.channelIds)
             params.channel_ids = args.channelIds;
         if (args.authorIds)

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

@@ -10,11 +10,11 @@ export declare class SearchClient extends BaseClient {
      * Searches across all threads and conversations in a workspace.
      *
      * @param args - The arguments for searching.
-     * @param args.query - The search query string.
+     * @param args.query - The search query string. Optional when `mentionSelf: true` is set; required otherwise.
      * @param args.workspaceId - The workspace ID to search in.
      * @param args.channelIds - Optional array of channel IDs to filter by.
      * @param args.authorIds - Optional array of author user IDs to filter by.
-     * @param args.mentionSelf - Optional flag to filter by mentions of the current user.
+     * @param args.mentionSelf - Optional flag to filter by mentions of the current user. When true, `query` may be omitted.
      * @param args.dateFrom - Optional start date for filtering (YYYY-MM-DD).
      * @param args.dateTo - Optional end date for filtering (YYYY-MM-DD).
      * @param args.limit - Optional limit on number of results returned.

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

@@ -130,17 +130,22 @@ export type UpdateUserArgs = {
     awayMode?: AwayMode;
     offDays?: number[];
 };
-export type SearchArgs = {
-    query: string;
+type SearchArgsCommon = {
     workspaceId: number;
     channelIds?: number[];
     authorIds?: number[];
-    mentionSelf?: boolean;
     dateFrom?: string;
     dateTo?: string;
     limit?: number;
     cursor?: string;
 };
+export type SearchArgs = (SearchArgsCommon & {
+    query: string;
+    mentionSelf?: boolean;
+}) | (SearchArgsCommon & {
+    query?: string;
+    mentionSelf: true;
+});
 export type SearchThreadArgs = {
     query: string;
     threadId: number;
@@ -330,3 +335,4 @@ export type GetUserLocalTimeArgs = {
     workspaceId: number;
     userId: number;
 };
+export {};

package/package.json

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