@doist/twist-sdk 2.4.0 → 2.5.0

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

@@ -30,13 +30,16 @@ var InboxClient = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     InboxClient.prototype.getInbox = function (args, options) {
+        var _a, _b;
         var params = {
             workspace_id: args.workspaceId,
         };
-        if (args.since)
-            params.newer_than_ts = Math.floor(args.since.getTime() / 1000);
-        if (args.until)
-            params.older_than_ts = Math.floor(args.until.getTime() / 1000);
+        var newerThan = (_a = args.newerThan) !== null && _a !== void 0 ? _a : args.since;
+        if (newerThan)
+            params.newer_than_ts = Math.floor(newerThan.getTime() / 1000);
+        var olderThan = (_b = args.olderThan) !== null && _b !== void 0 ? _b : args.until;
+        if (olderThan)
+            params.older_than_ts = Math.floor(olderThan.getTime() / 1000);
         if (args.limit)
             params.limit = args.limit;
         if (args.cursor)
@@ -122,15 +125,15 @@ var InboxClient = /** @class */ (function (_super) {
         }).then(function () { return undefined; });
     };
     InboxClient.prototype.archiveAll = function (args, options) {
+        var _a;
         var params = {
             workspace_id: args.workspaceId,
         };
         if (args.channelIds)
             params.channel_ids = args.channelIds;
-        if (args.since)
-            params.since_ts_or_obj_idx = Math.floor(args.since.getTime() / 1000);
-        if (args.until)
-            params.until_ts_or_obj_idx = Math.floor(args.until.getTime() / 1000);
+        var olderThan = (_a = args.olderThan) !== null && _a !== void 0 ? _a : args.until;
+        if (olderThan)
+            params.older_than_ts = Math.floor(olderThan.getTime() / 1000);
         var method = 'POST';
         var url = "".concat(endpoints_1.ENDPOINT_INBOX, "/archive_all");
         if (options === null || options === void 0 ? void 0 : options.batch) {

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/cjs/clients/threads-client.js

@@ -55,7 +55,10 @@ var ThreadsClient = /** @class */ (function (_super) {
     ThreadsClient.prototype.getThreads = function (args, options) {
         var method = 'GET';
         var url = "".concat(endpoints_1.ENDPOINT_THREADS, "/get");
-        var params = args;
+        var newerThan = args.newerThan, olderThan = args.olderThan, newer_than_ts = args.newer_than_ts, older_than_ts = args.older_than_ts, rest = __rest(args, ["newerThan", "olderThan", "newer_than_ts", "older_than_ts"]);
+        var resolvedNewerThan = newerThan ? Math.floor(newerThan.getTime() / 1000) : newer_than_ts;
+        var resolvedOlderThan = olderThan ? Math.floor(olderThan.getTime() / 1000) : older_than_ts;
+        var params = __assign(__assign(__assign({}, rest), (resolvedNewerThan != null ? { newer_than_ts: resolvedNewerThan } : {})), (resolvedOlderThan != null ? { older_than_ts: resolvedOlderThan } : {}));
         if (options === null || options === void 0 ? void 0 : options.batch) {
             return { method: method, url: url, params: params, schema: zod_1.z.array(entities_1.ThreadSchema) };
         }

package/dist/cjs/types/requests.js

@@ -76,6 +76,9 @@ exports.GetThreadsArgsSchema = zod_1.z.object({
     workspaceId: zod_1.z.number(),
     channelId: zod_1.z.number().nullable().optional(),
     archived: zod_1.z.boolean().nullable().optional(),
+    newerThan: zod_1.z.date().nullable().optional(),
+    olderThan: zod_1.z.date().nullable().optional(),
+    limit: zod_1.z.number().nullable().optional(),
 });
 exports.GetCommentsArgsSchema = zod_1.z.object({
     threadId: zod_1.z.number(),

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

@@ -27,13 +27,16 @@ var InboxClient = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     InboxClient.prototype.getInbox = function (args, options) {
+        var _a, _b;
         var params = {
             workspace_id: args.workspaceId,
         };
-        if (args.since)
-            params.newer_than_ts = Math.floor(args.since.getTime() / 1000);
-        if (args.until)
-            params.older_than_ts = Math.floor(args.until.getTime() / 1000);
+        var newerThan = (_a = args.newerThan) !== null && _a !== void 0 ? _a : args.since;
+        if (newerThan)
+            params.newer_than_ts = Math.floor(newerThan.getTime() / 1000);
+        var olderThan = (_b = args.olderThan) !== null && _b !== void 0 ? _b : args.until;
+        if (olderThan)
+            params.older_than_ts = Math.floor(olderThan.getTime() / 1000);
         if (args.limit)
             params.limit = args.limit;
         if (args.cursor)
@@ -119,15 +122,15 @@ var InboxClient = /** @class */ (function (_super) {
         }).then(function () { return undefined; });
     };
     InboxClient.prototype.archiveAll = function (args, options) {
+        var _a;
         var params = {
             workspace_id: args.workspaceId,
         };
         if (args.channelIds)
             params.channel_ids = args.channelIds;
-        if (args.since)
-            params.since_ts_or_obj_idx = Math.floor(args.since.getTime() / 1000);
-        if (args.until)
-            params.until_ts_or_obj_idx = Math.floor(args.until.getTime() / 1000);
+        var olderThan = (_a = args.olderThan) !== null && _a !== void 0 ? _a : args.until;
+        if (olderThan)
+            params.older_than_ts = Math.floor(olderThan.getTime() / 1000);
         var method = 'POST';
         var url = "".concat(ENDPOINT_INBOX, "/archive_all");
         if (options === null || options === void 0 ? void 0 : options.batch) {

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/esm/clients/threads-client.js

@@ -52,7 +52,10 @@ var ThreadsClient = /** @class */ (function (_super) {
     ThreadsClient.prototype.getThreads = function (args, options) {
         var method = 'GET';
         var url = "".concat(ENDPOINT_THREADS, "/get");
-        var params = args;
+        var newerThan = args.newerThan, olderThan = args.olderThan, newer_than_ts = args.newer_than_ts, older_than_ts = args.older_than_ts, rest = __rest(args, ["newerThan", "olderThan", "newer_than_ts", "older_than_ts"]);
+        var resolvedNewerThan = newerThan ? Math.floor(newerThan.getTime() / 1000) : newer_than_ts;
+        var resolvedOlderThan = olderThan ? Math.floor(olderThan.getTime() / 1000) : older_than_ts;
+        var params = __assign(__assign(__assign({}, rest), (resolvedNewerThan != null ? { newer_than_ts: resolvedNewerThan } : {})), (resolvedOlderThan != null ? { older_than_ts: resolvedOlderThan } : {}));
         if (options === null || options === void 0 ? void 0 : options.batch) {
             return { method: method, url: url, params: params, schema: z.array(ThreadSchema) };
         }

package/dist/esm/types/requests.js

@@ -73,6 +73,9 @@ export var GetThreadsArgsSchema = z.object({
     workspaceId: z.number(),
     channelId: z.number().nullable().optional(),
     archived: z.boolean().nullable().optional(),
+    newerThan: z.date().nullable().optional(),
+    olderThan: z.date().nullable().optional(),
+    limit: z.number().nullable().optional(),
 });
 export var GetCommentsArgsSchema = z.object({
     threadId: z.number(),

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

@@ -11,8 +11,10 @@ export declare class InboxClient extends BaseClient {
      *
      * @param args - The arguments for getting inbox.
      * @param args.workspaceId - The workspace ID.
-     * @param args.since - Optional date to get items since.
-     * @param args.until - Optional date to get items until.
+     * @param args.newerThan - Optional date to get items newer than.
+     * @param args.olderThan - Optional date to get items older than.
+     * @param args.since - @deprecated Use `newerThan` instead.
+     * @param args.until - @deprecated Use `olderThan` instead.
      * @param args.limit - Optional limit on number of items returned.
      * @param args.cursor - Optional cursor for pagination.
      * @param args.archiveFilter - Optional filter: 'active' (default), 'archived', or 'all'.
@@ -23,7 +25,7 @@ export declare class InboxClient extends BaseClient {
      * ```typescript
      * const inbox = await api.inbox.getInbox({
      *   workspaceId: 123,
-     *   since: new Date('2024-01-01')
+     *   newerThan: new Date('2024-01-01')
      * })
      *
      * // Include archived (done) items alongside active ones
@@ -115,15 +117,16 @@ export declare class InboxClient extends BaseClient {
      * @param args - The arguments for archiving all.
      * @param args.workspaceId - The workspace ID.
      * @param args.channelIds - Optional array of channel IDs to filter by.
-     * @param args.since - Optional date to filter items since.
-     * @param args.until - Optional date to filter items until.
+     * @param args.olderThan - Optional date to filter items older than.
+     * @param args.until - @deprecated Use `olderThan` instead.
+     * @param args.since - @deprecated Not supported by the archive_all endpoint — this value is ignored.
      * @param options - Optional configuration. Set `batch: true` to return a descriptor for batch requests.
      *
      * @example
      * ```typescript
      * await api.inbox.archiveAll({
      *   workspaceId: 123,
-     *   since: new Date('2024-01-01')
+     *   olderThan: new Date('2024-01-01')
      * })
      * ```
      */

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/clients/threads-client.d.ts

@@ -13,8 +13,10 @@ export declare class ThreadsClient extends BaseClient {
      * @param args.channelId - The channel ID.
      * @param args.workspaceId - Optional workspace ID.
      * @param args.archived - Optional flag to include archived threads.
-     * @param args.newer_than_ts - Optional timestamp to get threads newer than.
-     * @param args.older_than_ts - Optional timestamp to get threads older than.
+     * @param args.newerThan - Optional date to get threads newer than.
+     * @param args.olderThan - Optional date to get threads older than.
+     * @param args.newer_than_ts - @deprecated Use `newerThan` instead.
+     * @param args.older_than_ts - @deprecated Use `olderThan` instead.
      * @param args.limit - Optional limit on number of threads returned.
      * @param options - Optional configuration. Set `batch: true` to return a descriptor for batch requests.
      * @returns An array of thread objects.

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

@@ -76,8 +76,18 @@ export declare const GetThreadsArgsSchema: z.ZodObject<{
     workspaceId: z.ZodNumber;
     channelId: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
     archived: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    newerThan: z.ZodOptional<z.ZodNullable<z.ZodDate>>;
+    olderThan: z.ZodOptional<z.ZodNullable<z.ZodDate>>;
+    limit: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
 }, z.core.$strip>;
-export type GetThreadsArgs = z.infer<typeof GetThreadsArgsSchema>;
+export type GetThreadsArgs = Omit<z.infer<typeof GetThreadsArgsSchema>, 'newerThan' | 'olderThan'> & {
+    newerThan?: Date | null;
+    olderThan?: Date | null;
+    /** @deprecated Use `newerThan` instead. */
+    newer_than_ts?: number | null;
+    /** @deprecated Use `olderThan` instead. */
+    older_than_ts?: number | null;
+};
 export declare const GetCommentsArgsSchema: z.ZodObject<{
     threadId: z.ZodNumber;
     from: z.ZodOptional<z.ZodNullable<z.ZodDate>>;
@@ -120,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;
@@ -165,7 +180,11 @@ export declare const ARCHIVE_FILTER_VALUES: readonly ["active", "archived", "all
 export type ArchiveFilter = (typeof ARCHIVE_FILTER_VALUES)[number];
 export type GetInboxArgs = {
     workspaceId: number;
+    newerThan?: Date;
+    olderThan?: Date;
+    /** @deprecated Use `newerThan` instead. */
     since?: Date;
+    /** @deprecated Use `olderThan` instead. */
     until?: Date;
     limit?: number;
     cursor?: string;
@@ -174,8 +193,11 @@ export type GetInboxArgs = {
 export type ArchiveAllArgs = {
     workspaceId: number;
     channelIds?: number[];
-    since?: Date;
+    olderThan?: Date;
+    /** @deprecated Use `olderThan` instead. */
     until?: Date;
+    /** @deprecated Not supported by the archive_all endpoint — this value is ignored. */
+    since?: Date;
 };
 export type AddReactionArgs = {
     threadId?: number;
@@ -313,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.0",
+    "version": "2.5.0",
     "description": "A TypeScript wrapper for the Twist REST API.",
     "author": "Doist developers",
     "homepage": "https://doist.github.io/twist-sdk-typescript/",