@doist/comms-sdk 0.10.0 → 0.11.0

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

@@ -31,26 +31,55 @@ class ConversationsClient extends base_client_1.BaseClient {
             : exports.ConversationListSchema;
     }
     /**
-     * Gets all conversations for a workspace.
+     * Gets a page of conversations for a workspace, newest activity first.
+     * The server returns at most 500 rows per request (20 by default); pass
+     * the last row's `lastActive`/`id` as `olderThan`/`beforeId` to fetch
+     * the next page. Paired, they form a strict compound boundary, so pages
+     * never repeat rows. Omitting `archived` returns active and archived
+     * conversations mixed.
      *
      * @param args - The arguments for getting conversations.
      * @param args.workspaceId - The workspace ID.
-     * @param args.archived - Optional flag to include archived conversations.
+     * @param args.archived - Optional flag to filter archived (true) or active (false) conversations.
+     * @param args.olderThan - Optional date to get conversations last active before.
+     * @param args.beforeId - Optional conversation id. Paired with olderThan it forms the
+     *   strict compound cursor; alone it pages by conversation id order instead.
+     * @param args.limit - Optional page size (server default 20, max 500).
      * @returns An array of conversation objects.
      *
      * @example
      * ```typescript
-     * const conversations = await api.conversations.getConversations({ workspaceId: 123 })
-     * conversations.forEach(c => console.log(c.title))
+     * const page = await api.conversations.getConversations({ workspaceId: 123, limit: 500 })
+     * const last = page.at(-1)
+     * const nextPage = last
+     *     ? await api.conversations.getConversations({
+     *           workspaceId: 123,
+     *           limit: 500,
+     *           olderThan: last.lastActive,
+     *           beforeId: last.id,
+     *       })
+     *     : []
      * ```
      */
     getConversations(args) {
+        // Fields are picked explicitly (matching getThreads/getComments) so a
+        // future Date field can't silently reach the generic snake-casing,
+        // which would turn it into an empty object on the wire.
+        const params = { workspaceId: args.workspaceId };
+        if (args.archived != null)
+            params.archived = args.archived;
+        if (args.olderThan)
+            params.olderThanTs = Math.floor(args.olderThan.getTime() / 1000);
+        if (args.beforeId != null)
+            params.beforeId = args.beforeId;
+        if (args.limit != null)
+            params.limit = args.limit;
         return (0, http_client_1.request)({
             httpMethod: 'GET',
             baseUri: this.getBaseUri(),
             relativePath: `${endpoints_1.ENDPOINT_CONVERSATIONS}/get`,
             apiToken: this.apiToken,
-            payload: args,
+            payload: params,
             customFetch: this.customFetch,
         }).then((response) => this.conversationListSchema.parse(response.data));
     }

package/dist/cjs/types/requests.js

@@ -106,6 +106,9 @@ exports.GetCommentsArgsSchema = zod_1.z.object({
 exports.GetConversationsArgsSchema = zod_1.z.object({
     workspaceId: zod_1.z.number(),
     archived: zod_1.z.boolean().nullable().optional(),
+    olderThan: zod_1.z.date().nullable().optional(),
+    beforeId: zod_1.z.string().nullable().optional(),
+    limit: zod_1.z.number().nullable().optional(),
 });
 exports.GetOrCreateConversationArgsSchema = zod_1.z.object({
     workspaceId: zod_1.z.number(),

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

@@ -28,26 +28,55 @@ export class ConversationsClient extends BaseClient {
             : ConversationListSchema;
     }
     /**
-     * Gets all conversations for a workspace.
+     * Gets a page of conversations for a workspace, newest activity first.
+     * The server returns at most 500 rows per request (20 by default); pass
+     * the last row's `lastActive`/`id` as `olderThan`/`beforeId` to fetch
+     * the next page. Paired, they form a strict compound boundary, so pages
+     * never repeat rows. Omitting `archived` returns active and archived
+     * conversations mixed.
      *
      * @param args - The arguments for getting conversations.
      * @param args.workspaceId - The workspace ID.
-     * @param args.archived - Optional flag to include archived conversations.
+     * @param args.archived - Optional flag to filter archived (true) or active (false) conversations.
+     * @param args.olderThan - Optional date to get conversations last active before.
+     * @param args.beforeId - Optional conversation id. Paired with olderThan it forms the
+     *   strict compound cursor; alone it pages by conversation id order instead.
+     * @param args.limit - Optional page size (server default 20, max 500).
      * @returns An array of conversation objects.
      *
      * @example
      * ```typescript
-     * const conversations = await api.conversations.getConversations({ workspaceId: 123 })
-     * conversations.forEach(c => console.log(c.title))
+     * const page = await api.conversations.getConversations({ workspaceId: 123, limit: 500 })
+     * const last = page.at(-1)
+     * const nextPage = last
+     *     ? await api.conversations.getConversations({
+     *           workspaceId: 123,
+     *           limit: 500,
+     *           olderThan: last.lastActive,
+     *           beforeId: last.id,
+     *       })
+     *     : []
      * ```
      */
     getConversations(args) {
+        // Fields are picked explicitly (matching getThreads/getComments) so a
+        // future Date field can't silently reach the generic snake-casing,
+        // which would turn it into an empty object on the wire.
+        const params = { workspaceId: args.workspaceId };
+        if (args.archived != null)
+            params.archived = args.archived;
+        if (args.olderThan)
+            params.olderThanTs = Math.floor(args.olderThan.getTime() / 1000);
+        if (args.beforeId != null)
+            params.beforeId = args.beforeId;
+        if (args.limit != null)
+            params.limit = args.limit;
         return request({
             httpMethod: 'GET',
             baseUri: this.getBaseUri(),
             relativePath: `${ENDPOINT_CONVERSATIONS}/get`,
             apiToken: this.apiToken,
-            payload: args,
+            payload: params,
             customFetch: this.customFetch,
         }).then((response) => this.conversationListSchema.parse(response.data));
     }

package/dist/esm/types/requests.js

@@ -103,6 +103,9 @@ export const GetCommentsArgsSchema = z.object({
 export const GetConversationsArgsSchema = z.object({
     workspaceId: z.number(),
     archived: z.boolean().nullable().optional(),
+    olderThan: z.date().nullable().optional(),
+    beforeId: z.string().nullable().optional(),
+    limit: z.number().nullable().optional(),
 });
 export const GetOrCreateConversationArgsSchema = z.object({
     workspaceId: z.number(),

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

@@ -167,17 +167,34 @@ export declare class ConversationsClient extends BaseClient {
     private readonly conversationSchema;
     private readonly conversationListSchema;
     /**
-     * Gets all conversations for a workspace.
+     * Gets a page of conversations for a workspace, newest activity first.
+     * The server returns at most 500 rows per request (20 by default); pass
+     * the last row's `lastActive`/`id` as `olderThan`/`beforeId` to fetch
+     * the next page. Paired, they form a strict compound boundary, so pages
+     * never repeat rows. Omitting `archived` returns active and archived
+     * conversations mixed.
      *
      * @param args - The arguments for getting conversations.
      * @param args.workspaceId - The workspace ID.
-     * @param args.archived - Optional flag to include archived conversations.
+     * @param args.archived - Optional flag to filter archived (true) or active (false) conversations.
+     * @param args.olderThan - Optional date to get conversations last active before.
+     * @param args.beforeId - Optional conversation id. Paired with olderThan it forms the
+     *   strict compound cursor; alone it pages by conversation id order instead.
+     * @param args.limit - Optional page size (server default 20, max 500).
      * @returns An array of conversation objects.
      *
      * @example
      * ```typescript
-     * const conversations = await api.conversations.getConversations({ workspaceId: 123 })
-     * conversations.forEach(c => console.log(c.title))
+     * const page = await api.conversations.getConversations({ workspaceId: 123, limit: 500 })
+     * const last = page.at(-1)
+     * const nextPage = last
+     *     ? await api.conversations.getConversations({
+     *           workspaceId: 123,
+     *           limit: 500,
+     *           olderThan: last.lastActive,
+     *           beforeId: last.id,
+     *       })
+     *     : []
      * ```
      */
     getConversations(args: GetConversationsArgs): Promise<Conversation[]>;

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

@@ -164,6 +164,9 @@ export type GetCommentsArgs = z.infer<typeof GetCommentsArgsSchema>;
 export declare const GetConversationsArgsSchema: z.ZodObject<{
     workspaceId: z.ZodNumber;
     archived: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    olderThan: z.ZodOptional<z.ZodNullable<z.ZodDate>>;
+    beforeId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    limit: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
 }, z.core.$strip>;
 export type GetConversationsArgs = z.infer<typeof GetConversationsArgsSchema>;
 export declare const GetOrCreateConversationArgsSchema: z.ZodObject<{

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@doist/comms-sdk",
-    "version": "0.10.0",
+    "version": "0.11.0",
     "description": "A TypeScript wrapper for the Comms REST API.",
     "author": "Doist developers",
     "homepage": "https://doist.github.io/comms-sdk-typescript/",