@doist/twist-sdk 2.3.0 → 2.4.0

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

@@ -31,11 +31,15 @@ var CommentsClient = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     CommentsClient.prototype.getComments = function (args, options) {
+        var _a;
         var params = {
             thread_id: args.threadId,
         };
-        if (args.from)
-            params.from = Math.floor(args.from.getTime() / 1000);
+        var newerThan = (_a = args.newerThan) !== null && _a !== void 0 ? _a : args.from;
+        if (newerThan)
+            params.newer_than_ts = Math.floor(newerThan.getTime() / 1000);
+        if (args.olderThan)
+            params.older_than_ts = Math.floor(args.olderThan.getTime() / 1000);
         if (args.limit)
             params.limit = args.limit;
         var method = 'GET';

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

@@ -41,6 +41,8 @@ var InboxClient = /** @class */ (function (_super) {
             params.limit = args.limit;
         if (args.cursor)
             params.cursor = args.cursor;
+        if (args.archiveFilter)
+            params.archive_filter = args.archiveFilter;
         var method = 'GET';
         var url = "".concat(endpoints_1.ENDPOINT_INBOX, "/get");
         if (options === null || options === void 0 ? void 0 : options.batch) {

package/dist/cjs/types/requests.js

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

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

@@ -28,11 +28,15 @@ var CommentsClient = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     CommentsClient.prototype.getComments = function (args, options) {
+        var _a;
         var params = {
             thread_id: args.threadId,
         };
-        if (args.from)
-            params.from = Math.floor(args.from.getTime() / 1000);
+        var newerThan = (_a = args.newerThan) !== null && _a !== void 0 ? _a : args.from;
+        if (newerThan)
+            params.newer_than_ts = Math.floor(newerThan.getTime() / 1000);
+        if (args.olderThan)
+            params.older_than_ts = Math.floor(args.olderThan.getTime() / 1000);
         if (args.limit)
             params.limit = args.limit;
         var method = 'GET';

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

@@ -38,6 +38,8 @@ var InboxClient = /** @class */ (function (_super) {
             params.limit = args.limit;
         if (args.cursor)
             params.cursor = args.cursor;
+        if (args.archiveFilter)
+            params.archive_filter = args.archiveFilter;
         var method = 'GET';
         var url = "".concat(ENDPOINT_INBOX, "/get");
         if (options === null || options === void 0 ? void 0 : options.batch) {

package/dist/esm/types/requests.js

@@ -77,6 +77,8 @@ export var GetThreadsArgsSchema = z.object({
 export var GetCommentsArgsSchema = z.object({
     threadId: z.number(),
     from: z.date().nullable().optional(),
+    newerThan: z.date().nullable().optional(),
+    olderThan: z.date().nullable().optional(),
     limit: z.number().nullable().optional(),
 });
 export var GetConversationsArgsSchema = z.object({
@@ -88,5 +90,7 @@ export var GetOrCreateConversationArgsSchema = z.object({
     userIds: z.array(z.number()),
 });
 export var AWAY_MODE_TYPES = ['parental', 'vacation', 'sickleave', 'other'];
+// Inbox
+export var ARCHIVE_FILTER_VALUES = ['active', 'archived', 'all'];
 // Threads
 export var THREAD_ACTIONS = ['close', 'reopen'];

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

@@ -11,7 +11,9 @@ export declare class CommentsClient extends BaseClient {
      *
      * @param args - The arguments for getting comments.
      * @param args.threadId - The thread ID.
-     * @param args.from - Optional date to get comments from.
+     * @param args.from - @deprecated Use `newerThan` instead.
+     * @param args.newerThan - Optional date to get comments newer than.
+     * @param args.olderThan - Optional date to get comments older than.
      * @param args.limit - Optional limit on number of comments returned.
      * @param options - Optional configuration. Set `batch: true` to return a descriptor for batch requests.
      * @returns An array of comment objects.
@@ -20,7 +22,7 @@ export declare class CommentsClient extends BaseClient {
      * ```typescript
      * const comments = await api.comments.getComments({
      *   threadId: 789,
-     *   from: new Date('2024-01-01')
+     *   newerThan: new Date('2024-01-01')
      * })
      * comments.forEach(c => console.log(c.content))
      * ```

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

@@ -15,6 +15,7 @@ export declare class InboxClient extends BaseClient {
      * @param args.until - Optional date to get items until.
      * @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'.
      * @param options - Optional configuration. Set `batch: true` to return a descriptor for batch requests.
      * @returns Inbox threads.
      *
@@ -24,6 +25,12 @@ export declare class InboxClient extends BaseClient {
      *   workspaceId: 123,
      *   since: new Date('2024-01-01')
      * })
+     *
+     * // Include archived (done) items alongside active ones
+     * const allInbox = await api.inbox.getInbox({
+     *   workspaceId: 123,
+     *   archiveFilter: 'all'
+     * })
      * ```
      */
     getInbox(args: GetInboxArgs, options: {

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

@@ -81,9 +81,14 @@ export type GetThreadsArgs = z.infer<typeof GetThreadsArgsSchema>;
 export declare const GetCommentsArgsSchema: z.ZodObject<{
     threadId: z.ZodNumber;
     from: z.ZodOptional<z.ZodNullable<z.ZodDate>>;
+    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 GetCommentsArgs = z.infer<typeof GetCommentsArgsSchema>;
+export type GetCommentsArgs = Omit<z.infer<typeof GetCommentsArgsSchema>, 'from'> & {
+    /** @deprecated Use `newerThan` instead. */
+    from?: Date | null;
+};
 export declare const GetConversationsArgsSchema: z.ZodObject<{
     workspaceId: z.ZodNumber;
     archived: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
@@ -156,12 +161,15 @@ export type UpdateConversationMessageArgs = {
     content: string;
     attachments?: unknown[];
 };
+export declare const ARCHIVE_FILTER_VALUES: readonly ["active", "archived", "all"];
+export type ArchiveFilter = (typeof ARCHIVE_FILTER_VALUES)[number];
 export type GetInboxArgs = {
     workspaceId: number;
     since?: Date;
     until?: Date;
     limit?: number;
     cursor?: string;
+    archiveFilter?: ArchiveFilter;
 };
 export type ArchiveAllArgs = {
     workspaceId: number;

package/package.json

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