reportify-sdk 0.3.19 → 0.3.20

package/dist/index.mjs

@@ -1525,186 +1525,6 @@ var UserModule = class {
       { symbol }
     );
   }
-  /**
-   * Create a new follow group
-   *
-   * @param name - Group name
-   * @param followValues - List of follow values (each with 'follow_type' as int and 'follow_value' as string)
-   *                      follow_type: 1=company, 3=channel
-   * @returns Created group information including group_id, name, and count
-   *
-   * @example
-   * ```typescript
-   * const result = await client.user.createFollowGroup('My Stocks', [
-   *   { follow_type: 1, follow_value: 'US:AAPL' },
-   *   { follow_type: 1, follow_value: 'HK:00700' }
-   * ]);
-   * console.log(`Created group: ${result.group_id}`);
-   * ```
-   */
-  async createFollowGroup(name, followValues) {
-    const json = { name };
-    if (followValues !== void 0) {
-      json.follow_values = followValues;
-    }
-    return this.client.post(
-      "/v1/tools/user/follow-groups",
-      json
-    );
-  }
-  /**
-   * Get all follow groups for authenticated user
-   *
-   * @returns List of follow groups with group_id, name, and count
-   *
-   * @example
-   * ```typescript
-   * const groups = await client.user.getFollowGroups();
-   * groups.forEach(group => {
-   *   console.log(`${group.name}: ${group.count} items`);
-   * });
-   * ```
-   */
-  async getFollowGroups() {
-    const response = await this.client.get("/v1/tools/user/follow-groups");
-    return response.groups || [];
-  }
-  /**
-   * Get a follow group by ID
-   *
-   * @param groupId - Group ID
-   * @returns Group information including group_id, name, and count
-   *
-   * @example
-   * ```typescript
-   * const group = await client.user.getFollowGroup('group_123');
-   * console.log(`${group.name}: ${group.count} items`);
-   * ```
-   */
-  async getFollowGroup(groupId) {
-    return this.client.get(
-      `/v1/tools/user/follow-groups/${groupId}`
-    );
-  }
-  /**
-   * Update a follow group
-   *
-   * @param groupId - Group ID
-   * @param name - New group name
-   * @returns Updated group information
-   *
-   * @example
-   * ```typescript
-   * const result = await client.user.updateFollowGroup('group_123', 'New Name');
-   * console.log(`Updated: ${result.name}`);
-   * ```
-   */
-  async updateFollowGroup(groupId, name) {
-    const json = {};
-    if (name !== void 0) {
-      json.name = name;
-    }
-    return this.client.post(
-      `/v1/tools/user/follow-groups/${groupId}`,
-      json
-    );
-  }
-  /**
-   * Delete a follow group
-   *
-   * @param groupId - Group ID
-   * @returns Status message
-   *
-   * @example
-   * ```typescript
-   * await client.user.deleteFollowGroup('group_123');
-   * ```
-   */
-  async deleteFollowGroup(groupId) {
-    return this.client.delete(`/v1/tools/user/follow-groups/${groupId}`);
-  }
-  /**
-   * Add follows to a group
-   *
-   * @param groupId - Group ID
-   * @param followValues - List of follow values (each with 'follow_type' as int and 'follow_value' as string)
-   *                      follow_type: 1=company, 3=channel
-   * @returns Status message
-   *
-   * @example
-   * ```typescript
-   * await client.user.addFollowsToGroup('group_123', [
-   *   { follow_type: 1, follow_value: 'US:TSLA' }
-   * ]);
-   * ```
-   */
-  async addFollowsToGroup(groupId, followValues) {
-    return this.client.post(`/v1/tools/user/follow-groups/${groupId}/follows`, {
-      follow_values: followValues
-    });
-  }
-  /**
-   * Remove follows from a group
-   *
-   * @param groupId - Group ID
-   * @param followValues - List of follow values to remove (e.g., stock symbols, channel IDs)
-   * @returns Status message
-   *
-   * @example
-   * ```typescript
-   * await client.user.removeFollowsFromGroup('group_123', ['AAPL', 'MSFT']);
-   * ```
-   */
-  async removeFollowsFromGroup(groupId, followValues) {
-    return this.client.delete(
-      `/v1/tools/user/follow-groups/${groupId}/follows`,
-      { follow_values: followValues }
-    );
-  }
-  /**
-   * Set follows for a group (replace all existing follows)
-   *
-   * @param groupId - Group ID
-   * @param followValues - List of follow values (each with 'follow_type' as int and 'follow_value' as string)
-   *                      follow_type: 1=company, 3=channel
-   * @returns Status message
-   *
-   * @example
-   * ```typescript
-   * await client.user.setGroupFollows('group_123', [
-   *   { follow_type: 1, follow_value: 'US:AAPL' },
-   *   { follow_type: 1, follow_value: 'HK:00700' }
-   * ]);
-   * ```
-   */
-  async setGroupFollows(groupId, followValues) {
-    return this.client.put(`/v1/tools/user/follow-groups/${groupId}/follows`, {
-      follow_values: followValues
-    });
-  }
-  /**
-   * Get reports for a follow group
-   *
-   * @param groupId - Group ID
-   * @param pageNum - Page number (default: 1)
-   * @param pageSize - Page size (default: 10, max: 100)
-   * @returns Report data including items list, total_count, page_num, and page_size
-   *
-   * @example
-   * ```typescript
-   * const result = await client.user.getGroupReports('group_123', 1, 20);
-   * console.log(`Total: ${result.total_count}`);
-   * result.items.forEach(report => {
-   *   console.log(report.title || 'Untitled');
-   * });
-   * ```
-   */
-  async getGroupReports(groupId, pageNum = 1, pageSize = 10) {
-    return this.client.get(`/v1/tools/user/follow-groups/${groupId}/reports`, {
-      page_num: pageNum,
-      page_size: pageSize
-    });
-  }
 };
 
 // src/search.ts
@@ -1888,6 +1708,193 @@ var SearchModule = class {
   }
 };
 
+// src/following.ts
+var FollowingModule = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Create a new follow group
+   *
+   * @param name - Group name
+   * @param followValues - List of follow values (each with 'follow_type' as int and 'follow_value' as string)
+   *                      follow_type: 1=company, 3=channel
+   * @returns Created group information including group_id, name, and count
+   *
+   * @example
+   * ```typescript
+   * const result = await client.following.createFollowGroup('My Stocks', [
+   *   { follow_type: 1, follow_value: 'US:AAPL' },
+   *   { follow_type: 1, follow_value: 'HK:00700' }
+   * ]);
+   * console.log(`Created group: ${result.group_id}`);
+   * ```
+   */
+  async createFollowGroup(name, followValues) {
+    const json = { name };
+    if (followValues !== void 0) {
+      json.follow_values = followValues;
+    }
+    return this.client.post(
+      "/v1/following/groups",
+      json
+    );
+  }
+  /**
+   * Get all follow groups for authenticated user
+   *
+   * @returns List of follow groups with group_id, name, and count
+   *
+   * @example
+   * ```typescript
+   * const groups = await client.following.getFollowGroups();
+   * groups.forEach(group => {
+   *   console.log(`${group.name}: ${group.count} items`);
+   * });
+   * ```
+   */
+  async getFollowGroups() {
+    const response = await this.client.get("/v1/following/groups");
+    return response.groups || [];
+  }
+  /**
+   * Get a follow group by ID
+   *
+   * @param groupId - Group ID
+   * @returns Group information including group_id, name, and count
+   *
+   * @example
+   * ```typescript
+   * const group = await client.following.getFollowGroup('group_123');
+   * console.log(`${group.name}: ${group.count} items`);
+   * ```
+   */
+  async getFollowGroup(groupId) {
+    return this.client.get(
+      `/v1/following/groups/${groupId}`
+    );
+  }
+  /**
+   * Update a follow group
+   *
+   * @param groupId - Group ID
+   * @param name - New group name
+   * @returns Updated group information
+   *
+   * @example
+   * ```typescript
+   * const result = await client.following.updateFollowGroup('group_123', 'New Name');
+   * console.log(`Updated: ${result.name}`);
+   * ```
+   */
+  async updateFollowGroup(groupId, name) {
+    const json = {};
+    if (name !== void 0) {
+      json.name = name;
+    }
+    return this.client.post(
+      `/v1/following/groups/${groupId}`,
+      json
+    );
+  }
+  /**
+   * Delete a follow group
+   *
+   * @param groupId - Group ID
+   * @returns Status message
+   *
+   * @example
+   * ```typescript
+   * await client.following.deleteFollowGroup('group_123');
+   * ```
+   */
+  async deleteFollowGroup(groupId) {
+    return this.client.delete(`/v1/following/groups/${groupId}`);
+  }
+  /**
+   * Add follows to a group
+   *
+   * @param groupId - Group ID
+   * @param followValues - List of follow values (each with 'follow_type' as int and 'follow_value' as string)
+   *                      follow_type: 1=company, 3=channel
+   * @returns Status message
+   *
+   * @example
+   * ```typescript
+   * await client.following.addFollowsToGroup('group_123', [
+   *   { follow_type: 1, follow_value: 'US:TSLA' }
+   * ]);
+   * ```
+   */
+  async addFollowsToGroup(groupId, followValues) {
+    return this.client.post(`/v1/following/groups/${groupId}/follows`, {
+      follow_values: followValues
+    });
+  }
+  /**
+   * Remove follows from a group
+   *
+   * @param groupId - Group ID
+   * @param followValues - List of follow values to remove (e.g., stock symbols, channel IDs)
+   * @returns Status message
+   *
+   * @example
+   * ```typescript
+   * await client.following.removeFollowsFromGroup('group_123', ['AAPL', 'MSFT']);
+   * ```
+   */
+  async removeFollowsFromGroup(groupId, followValues) {
+    return this.client.delete(
+      `/v1/following/groups/${groupId}/follows`,
+      { follow_values: followValues }
+    );
+  }
+  /**
+   * Set follows for a group (replace all existing follows)
+   *
+   * @param groupId - Group ID
+   * @param followValues - List of follow values (each with 'follow_type' as int and 'follow_value' as string)
+   *                      follow_type: 1=company, 3=channel
+   * @returns Status message
+   *
+   * @example
+   * ```typescript
+   * await client.following.setGroupFollows('group_123', [
+   *   { follow_type: 1, follow_value: 'US:AAPL' },
+   *   { follow_type: 1, follow_value: 'HK:00700' }
+   * ]);
+   * ```
+   */
+  async setGroupFollows(groupId, followValues) {
+    return this.client.put(`/v1/following/groups/${groupId}/follows`, {
+      follow_values: followValues
+    });
+  }
+  /**
+   * Get docs for a follow group
+   *
+   * @param groupId - Group ID
+   * @param pageNum - Page number (default: 1)
+   * @param pageSize - Page size (default: 10, max: 100)
+   * @returns docs data including items list, total_count, page_num, and page_size
+   *
+   * @example
+   * ```typescript
+   * const result = await client.following.getFollowGroupDocs('group_123', 1, 20);
+   * console.log(`Total: ${result.total_count}`);
+   * result.items.forEach(doc => {
+   *   console.log(doc.title || 'Untitled');  
+   * });
+   * ```
+   */
+  async getFollowGroupDocs(groupId, pageNum = 1, pageSize = 10) {
+    return this.client.get(`/v1/following/groups/${groupId}/docs`, {
+      page_num: pageNum,
+      page_size: pageSize
+    });
+  }
+};
+
 // src/types.ts
 var ReportifyError = class extends Error {
   statusCode;
@@ -1941,6 +1948,7 @@ var Reportify = class {
   kb;
   timeline;
   user;
+  following;
   constructor(config) {
     if (!config.apiKey) {
       throw new AuthenticationError("API key is required");
@@ -1959,6 +1967,7 @@ var Reportify = class {
     this.kb = new KBModule(this);
     this.timeline = new TimelineModule(this);
     this.user = new UserModule(this);
+    this.following = new FollowingModule(this);
   }
   /**
    * Make an HTTP request to the API
@@ -2072,6 +2081,7 @@ export {
   ChatModule,
   ConceptsModule,
   DocsModule,
+  FollowingModule,
   KBModule,
   NotFoundError,
   QuantModule,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "reportify-sdk",
-  "version": "0.3.19",
+  "version": "0.3.20",
   "description": "TypeScript SDK for Reportify API - Financial data and document search",
   "main": "dist/index.js",
   "module": "dist/index.mjs",