reportify-sdk 0.3.9 → 0.3.11

package/dist/index.d.mts

@@ -62,6 +62,8 @@ interface EarningsSearchOptions {
     endDatetime?: string;
     fiscalYear?: string;
     fiscalQuarter?: string;
+    /** Sort order: 'date_desc' (newest first, default when no query), 'relevance' (recommended when query is provided), 'date_asc' (oldest first) */
+    sortBy?: 'relevance' | 'date_desc' | 'date_asc';
 }
 interface CompanyOverview {
     symbol: string;
@@ -1390,6 +1392,35 @@ declare class UserModule {
      * ```
      */
     followedCompanies(): Promise<FollowedCompany[]>;
+    /**
+     * Follow a company (add to stock watchlist)
+     *
+     * @param symbol - Stock symbol in market:ticker format (e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
+     * @returns The followed company information
+     *
+     * @example
+     * ```typescript
+     * const result = await client.user.followCompany('US:AAPL');
+     * console.log(`Followed: ${result.symbol} - ${result.name}`);
+     * ```
+     */
+    followCompany(symbol: string): Promise<FollowedCompany>;
+    /**
+     * Unfollow a company (remove from stock watchlist)
+     *
+     * @param symbol - Stock symbol in market:ticker format (e.g., US:AAPL, HK:00700)
+     * @returns Status of the unfollow operation
+     *
+     * @example
+     * ```typescript
+     * const result = await client.user.unfollowCompany('US:AAPL');
+     * console.log(`Unfollowed: ${result.symbol}, success: ${result.success}`);
+     * ```
+     */
+    unfollowCompany(symbol: string): Promise<{
+        symbol: string;
+        success: boolean;
+    }>;
 }
 
 /**
@@ -1435,21 +1466,27 @@ declare class SearchModule {
      */
     filings(query: string, symbols: string[], options?: Omit<SearchOptions, 'symbols' | 'categories' | 'industries' | 'channelIds'>): Promise<Document[]>;
     /**
-     * Search earnings call transcripts and slides
+     * Search for earnings-related conference call transcripts and presentation slides.
+     * Query is optional - if not provided, returns documents in reverse chronological order;
+     * if provided, results are sorted by relevance by default.
      *
-     * @param query - Search query string
      * @param symbols - Stock symbols in market:ticker format (required, e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
-     * @param options - Search options including fiscal year/quarter filters
+     * @param options - Search options including query, fiscal year/quarter filters, and sort order
      */
-    conferenceCalls(query: string, symbols: string[], options?: EarningsSearchOptions): Promise<Document[]>;
+    conferenceCalls(symbols: string[], options?: EarningsSearchOptions & {
+        query?: string;
+    }): Promise<Document[]>;
     /**
-     * Search earnings financial reports
+     * Search for earnings-related documents submitted to exchanges, including quarterly reports,
+     * semi-annual reports, and annual reports. Query is optional - if not provided, returns
+     * documents in reverse chronological order; if provided, results are sorted by relevance by default.
      *
-     * @param query - Search query string
      * @param symbols - Stock symbols in market:ticker format (required, e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
-     * @param options - Search options including fiscal year/quarter filters
+     * @param options - Search options including query, fiscal year/quarter filters, and sort order
      */
-    earningsPack(query: string, symbols: string[], options?: EarningsSearchOptions): Promise<Document[]>;
+    earningsPack(symbols: string[], options?: EarningsSearchOptions & {
+        query?: string;
+    }): Promise<Document[]>;
     /**
      * Search conference calls and IR (Investor Relations) meetings
      */

package/dist/index.d.ts

@@ -62,6 +62,8 @@ interface EarningsSearchOptions {
     endDatetime?: string;
     fiscalYear?: string;
     fiscalQuarter?: string;
+    /** Sort order: 'date_desc' (newest first, default when no query), 'relevance' (recommended when query is provided), 'date_asc' (oldest first) */
+    sortBy?: 'relevance' | 'date_desc' | 'date_asc';
 }
 interface CompanyOverview {
     symbol: string;
@@ -1390,6 +1392,35 @@ declare class UserModule {
      * ```
      */
     followedCompanies(): Promise<FollowedCompany[]>;
+    /**
+     * Follow a company (add to stock watchlist)
+     *
+     * @param symbol - Stock symbol in market:ticker format (e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
+     * @returns The followed company information
+     *
+     * @example
+     * ```typescript
+     * const result = await client.user.followCompany('US:AAPL');
+     * console.log(`Followed: ${result.symbol} - ${result.name}`);
+     * ```
+     */
+    followCompany(symbol: string): Promise<FollowedCompany>;
+    /**
+     * Unfollow a company (remove from stock watchlist)
+     *
+     * @param symbol - Stock symbol in market:ticker format (e.g., US:AAPL, HK:00700)
+     * @returns Status of the unfollow operation
+     *
+     * @example
+     * ```typescript
+     * const result = await client.user.unfollowCompany('US:AAPL');
+     * console.log(`Unfollowed: ${result.symbol}, success: ${result.success}`);
+     * ```
+     */
+    unfollowCompany(symbol: string): Promise<{
+        symbol: string;
+        success: boolean;
+    }>;
 }
 
 /**
@@ -1435,21 +1466,27 @@ declare class SearchModule {
      */
     filings(query: string, symbols: string[], options?: Omit<SearchOptions, 'symbols' | 'categories' | 'industries' | 'channelIds'>): Promise<Document[]>;
     /**
-     * Search earnings call transcripts and slides
+     * Search for earnings-related conference call transcripts and presentation slides.
+     * Query is optional - if not provided, returns documents in reverse chronological order;
+     * if provided, results are sorted by relevance by default.
      *
-     * @param query - Search query string
      * @param symbols - Stock symbols in market:ticker format (required, e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
-     * @param options - Search options including fiscal year/quarter filters
+     * @param options - Search options including query, fiscal year/quarter filters, and sort order
      */
-    conferenceCalls(query: string, symbols: string[], options?: EarningsSearchOptions): Promise<Document[]>;
+    conferenceCalls(symbols: string[], options?: EarningsSearchOptions & {
+        query?: string;
+    }): Promise<Document[]>;
     /**
-     * Search earnings financial reports
+     * Search for earnings-related documents submitted to exchanges, including quarterly reports,
+     * semi-annual reports, and annual reports. Query is optional - if not provided, returns
+     * documents in reverse chronological order; if provided, results are sorted by relevance by default.
      *
-     * @param query - Search query string
      * @param symbols - Stock symbols in market:ticker format (required, e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
-     * @param options - Search options including fiscal year/quarter filters
+     * @param options - Search options including query, fiscal year/quarter filters, and sort order
      */
-    earningsPack(query: string, symbols: string[], options?: EarningsSearchOptions): Promise<Document[]>;
+    earningsPack(symbols: string[], options?: EarningsSearchOptions & {
+        query?: string;
+    }): Promise<Document[]>;
     /**
      * Search conference calls and IR (Investor Relations) meetings
      */

package/dist/index.js

@@ -1417,6 +1417,49 @@ var UserModule = class {
       followedAt: company.followed_at
     }));
   }
+  /**
+   * Follow a company (add to stock watchlist)
+   *
+   * @param symbol - Stock symbol in market:ticker format (e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
+   * @returns The followed company information
+   *
+   * @example
+   * ```typescript
+   * const result = await client.user.followCompany('US:AAPL');
+   * console.log(`Followed: ${result.symbol} - ${result.name}`);
+   * ```
+   */
+  async followCompany(symbol) {
+    const response = await this.client.post("/v1/tools/user/follow-company", { symbol });
+    return {
+      symbol: response.symbol,
+      ticker: response.ticker,
+      market: response.market,
+      name: response.name,
+      chineseName: response.chinese_name,
+      englishName: response.english_name,
+      logo: response.logo,
+      followedAt: response.followed_at
+    };
+  }
+  /**
+   * Unfollow a company (remove from stock watchlist)
+   *
+   * @param symbol - Stock symbol in market:ticker format (e.g., US:AAPL, HK:00700)
+   * @returns Status of the unfollow operation
+   *
+   * @example
+   * ```typescript
+   * const result = await client.user.unfollowCompany('US:AAPL');
+   * console.log(`Unfollowed: ${result.symbol}, success: ${result.success}`);
+   * ```
+   */
+  async unfollowCompany(symbol) {
+    return this.client.post(
+      "/v1/tools/user/unfollow-company",
+      { symbol }
+    );
+  }
 };
 
 // src/search.ts
@@ -1495,18 +1538,20 @@ var SearchModule = class {
     return response.docs || [];
   }
   /**
-   * Search earnings call transcripts and slides
+   * Search for earnings-related conference call transcripts and presentation slides.
+   * Query is optional - if not provided, returns documents in reverse chronological order;
+   * if provided, results are sorted by relevance by default.
    *
-   * @param query - Search query string
    * @param symbols - Stock symbols in market:ticker format (required, e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
-   * @param options - Search options including fiscal year/quarter filters
+   * @param options - Search options including query, fiscal year/quarter filters, and sort order
    */
-  async conferenceCalls(query, symbols, options = {}) {
+  async conferenceCalls(symbols, options = {}) {
     const body = {
-      query,
       symbols,
-      num: options.num || 10
+      num: options.num || 10,
+      sort_by: options.sortBy || "date_desc"
     };
+    if (options.query) body.query = options.query;
     if (options.startDatetime) body.start_datetime = options.startDatetime;
     if (options.endDatetime) body.end_datetime = options.endDatetime;
     if (options.fiscalYear) body.fiscal_year = options.fiscalYear;
@@ -1515,18 +1560,20 @@ var SearchModule = class {
     return response.docs || [];
   }
   /**
-   * Search earnings financial reports
+   * Search for earnings-related documents submitted to exchanges, including quarterly reports,
+   * semi-annual reports, and annual reports. Query is optional - if not provided, returns
+   * documents in reverse chronological order; if provided, results are sorted by relevance by default.
    *
-   * @param query - Search query string
    * @param symbols - Stock symbols in market:ticker format (required, e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
-   * @param options - Search options including fiscal year/quarter filters
+   * @param options - Search options including query, fiscal year/quarter filters, and sort order
    */
-  async earningsPack(query, symbols, options = {}) {
+  async earningsPack(symbols, options = {}) {
     const body = {
-      query,
       symbols,
-      num: options.num || 10
+      num: options.num || 10,
+      sort_by: options.sortBy || "date_desc"
     };
+    if (options.query) body.query = options.query;
     if (options.startDatetime) body.start_datetime = options.startDatetime;
     if (options.endDatetime) body.end_datetime = options.endDatetime;
     if (options.fiscalYear) body.fiscal_year = options.fiscalYear;
@@ -1670,7 +1717,7 @@ var Reportify = class {
         headers: {
           Authorization: `Bearer ${this.apiKey}`,
           "Content-Type": "application/json",
-          "User-Agent": "reportify-sdk-js/0.3.9"
+          "User-Agent": "reportify-sdk-js/0.3.10"
         },
         body: options.body ? JSON.stringify(options.body) : void 0,
         signal: controller.signal
@@ -1731,7 +1778,7 @@ var Reportify = class {
       headers: {
         Authorization: `Bearer ${this.apiKey}`,
         "Content-Type": "application/json",
-        "User-Agent": "reportify-sdk-typescript/0.3.9"
+        "User-Agent": "reportify-sdk-typescript/0.3.10"
       }
     });
     if (!response.ok) {

package/dist/index.mjs

@@ -1375,6 +1375,49 @@ var UserModule = class {
       followedAt: company.followed_at
     }));
   }
+  /**
+   * Follow a company (add to stock watchlist)
+   *
+   * @param symbol - Stock symbol in market:ticker format (e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
+   * @returns The followed company information
+   *
+   * @example
+   * ```typescript
+   * const result = await client.user.followCompany('US:AAPL');
+   * console.log(`Followed: ${result.symbol} - ${result.name}`);
+   * ```
+   */
+  async followCompany(symbol) {
+    const response = await this.client.post("/v1/tools/user/follow-company", { symbol });
+    return {
+      symbol: response.symbol,
+      ticker: response.ticker,
+      market: response.market,
+      name: response.name,
+      chineseName: response.chinese_name,
+      englishName: response.english_name,
+      logo: response.logo,
+      followedAt: response.followed_at
+    };
+  }
+  /**
+   * Unfollow a company (remove from stock watchlist)
+   *
+   * @param symbol - Stock symbol in market:ticker format (e.g., US:AAPL, HK:00700)
+   * @returns Status of the unfollow operation
+   *
+   * @example
+   * ```typescript
+   * const result = await client.user.unfollowCompany('US:AAPL');
+   * console.log(`Unfollowed: ${result.symbol}, success: ${result.success}`);
+   * ```
+   */
+  async unfollowCompany(symbol) {
+    return this.client.post(
+      "/v1/tools/user/unfollow-company",
+      { symbol }
+    );
+  }
 };
 
 // src/search.ts
@@ -1453,18 +1496,20 @@ var SearchModule = class {
     return response.docs || [];
   }
   /**
-   * Search earnings call transcripts and slides
+   * Search for earnings-related conference call transcripts and presentation slides.
+   * Query is optional - if not provided, returns documents in reverse chronological order;
+   * if provided, results are sorted by relevance by default.
    *
-   * @param query - Search query string
    * @param symbols - Stock symbols in market:ticker format (required, e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
-   * @param options - Search options including fiscal year/quarter filters
+   * @param options - Search options including query, fiscal year/quarter filters, and sort order
    */
-  async conferenceCalls(query, symbols, options = {}) {
+  async conferenceCalls(symbols, options = {}) {
     const body = {
-      query,
       symbols,
-      num: options.num || 10
+      num: options.num || 10,
+      sort_by: options.sortBy || "date_desc"
     };
+    if (options.query) body.query = options.query;
     if (options.startDatetime) body.start_datetime = options.startDatetime;
     if (options.endDatetime) body.end_datetime = options.endDatetime;
     if (options.fiscalYear) body.fiscal_year = options.fiscalYear;
@@ -1473,18 +1518,20 @@ var SearchModule = class {
     return response.docs || [];
   }
   /**
-   * Search earnings financial reports
+   * Search for earnings-related documents submitted to exchanges, including quarterly reports,
+   * semi-annual reports, and annual reports. Query is optional - if not provided, returns
+   * documents in reverse chronological order; if provided, results are sorted by relevance by default.
    *
-   * @param query - Search query string
    * @param symbols - Stock symbols in market:ticker format (required, e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
-   * @param options - Search options including fiscal year/quarter filters
+   * @param options - Search options including query, fiscal year/quarter filters, and sort order
    */
-  async earningsPack(query, symbols, options = {}) {
+  async earningsPack(symbols, options = {}) {
     const body = {
-      query,
       symbols,
-      num: options.num || 10
+      num: options.num || 10,
+      sort_by: options.sortBy || "date_desc"
     };
+    if (options.query) body.query = options.query;
     if (options.startDatetime) body.start_datetime = options.startDatetime;
     if (options.endDatetime) body.end_datetime = options.endDatetime;
     if (options.fiscalYear) body.fiscal_year = options.fiscalYear;
@@ -1628,7 +1675,7 @@ var Reportify = class {
         headers: {
           Authorization: `Bearer ${this.apiKey}`,
           "Content-Type": "application/json",
-          "User-Agent": "reportify-sdk-js/0.3.9"
+          "User-Agent": "reportify-sdk-js/0.3.10"
         },
         body: options.body ? JSON.stringify(options.body) : void 0,
         signal: controller.signal
@@ -1689,7 +1736,7 @@ var Reportify = class {
       headers: {
         Authorization: `Bearer ${this.apiKey}`,
         "Content-Type": "application/json",
-        "User-Agent": "reportify-sdk-typescript/0.3.9"
+        "User-Agent": "reportify-sdk-typescript/0.3.10"
       }
     });
     if (!response.ok) {

package/package.json

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