reportify-sdk 0.3.19 → 0.3.21

package/dist/index.d.ts

@@ -1284,10 +1284,12 @@ declare class AgentModule {
      * @param options - Optional parameters
      * @param options.title - Conversation title
      * @param options.conversationType - Conversation type: "agent_chat", "task_chat", "debug_chat", "bot_chat"
+     * @param options.meta - Metadata dict (optional)
      */
     createConversation(agentId: number, options?: {
         title?: string;
         conversationType?: string;
+        meta?: Record<string, unknown>;
     }): Promise<AgentConversation>;
     /**
      * Chat with agent in a conversation
@@ -1522,6 +1524,122 @@ declare class UserModule {
         symbol: string;
         success: boolean;
     }>;
+}
+
+/**
+ * Search Module
+ *
+ * Provides document search functionality across various categories.
+ */
+
+/**
+ * Search module for document search functionality.
+ *
+ * @example
+ * ```typescript
+ * const results = await client.search.all('Tesla earnings');
+ * const news = await client.search.news('Apple iPhone');
+ * ```
+ */
+declare class SearchModule {
+    private client;
+    constructor(client: Reportify);
+    /**
+     * Search documents across all categories
+     *
+     * @param query - Search query string
+     * @param options - Search options
+     * @returns List of matching documents
+     */
+    all(query: string, options?: SearchOptions): Promise<Document[]>;
+    /**
+     * Search news articles
+     */
+    news(query: string, options?: SearchOptions): Promise<Document[]>;
+    /**
+     * Search research reports
+     */
+    reports(query: string, options?: SearchOptions): Promise<Document[]>;
+    /**
+     * Search company filings
+     *
+     * @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
+     */
+    filings(query: string, symbols: string[], options?: Omit<SearchOptions, 'symbols' | 'categories' | 'industries' | 'channelIds'>): Promise<Document[]>;
+    /**
+     * 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 symbols - Stock symbols in market:ticker format (required, e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
+     * @param options - Search options including query, fiscal year/quarter filters, and sort order
+     */
+    conferenceCalls(symbols: string[], options?: EarningsSearchOptions & {
+        query?: string;
+    }): Promise<Document[]>;
+    /**
+     * 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 symbols - Stock symbols in market:ticker format (required, e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
+     * @param options - Search options including query, fiscal year/quarter filters, and sort order
+     */
+    earningsPack(symbols: string[], options?: EarningsSearchOptions & {
+        query?: string;
+    }): Promise<Document[]>;
+    /**
+     * Search conference calls and IR (Investor Relations) meetings
+     */
+    minutes(query: string, options?: SearchOptions): Promise<Document[]>;
+    /**
+     * Search social media content
+     */
+    socials(query: string, options?: SearchOptions): Promise<Document[]>;
+    /**
+     * Search webpage content
+     */
+    webpages(query: string, options?: Omit<SearchOptions, 'symbols' | 'categories' | 'industries' | 'channelIds'>): Promise<Document[]>;
+    /**
+     * Crawl web content from given URLs.
+     *
+     * @param urls Array of URLs to get contents for
+     * @param options Options for text, highlights, summary, subpages, etc.
+     * @returns CrawlResponse Promise with extracted results and statuses
+     */
+    crawl(urls: string[], options?: {
+        text?: boolean | {
+            max_characters?: number;
+            include_html_tags?: boolean;
+            verbosity?: 'compact' | 'full';
+        };
+        highlights?: {
+            query?: string;
+            max_characters?: number;
+            num_sentences?: number;
+            highlights_per_url?: number;
+        };
+        summary?: {
+            query?: string;
+        };
+        subpages?: number;
+        subpage_target?: string[];
+        max_age_hours?: number;
+        livecrawl_timeout?: number;
+    }): Promise<any>;
+}
+
+/**
+ * Following Module
+ *
+ * Provides access to follow group management functionality.
+ */
+
+declare class FollowingModule {
+    private client;
+    constructor(client: Reportify);
     /**
      * Create a new follow group
      *
@@ -1532,7 +1650,7 @@ declare class UserModule {
      *
      * @example
      * ```typescript
-     * const result = await client.user.createFollowGroup('My Stocks', [
+     * const result = await client.following.createFollowGroup('My Stocks', [
      *   { follow_type: 1, follow_value: 'US:AAPL' },
      *   { follow_type: 1, follow_value: 'HK:00700' }
      * ]);
@@ -1554,7 +1672,7 @@ declare class UserModule {
      *
      * @example
      * ```typescript
-     * const groups = await client.user.getFollowGroups();
+     * const groups = await client.following.getFollowGroups();
      * groups.forEach(group => {
      *   console.log(`${group.name}: ${group.count} items`);
      * });
@@ -1573,7 +1691,7 @@ declare class UserModule {
      *
      * @example
      * ```typescript
-     * const group = await client.user.getFollowGroup('group_123');
+     * const group = await client.following.getFollowGroup('group_123');
      * console.log(`${group.name}: ${group.count} items`);
      * ```
      */
@@ -1595,7 +1713,7 @@ declare class UserModule {
      *
      * @example
      * ```typescript
-     * const result = await client.user.updateFollowGroup('group_123', 'New Name');
+     * const result = await client.following.updateFollowGroup('group_123', 'New Name');
      * console.log(`Updated: ${result.name}`);
      * ```
      */
@@ -1612,7 +1730,7 @@ declare class UserModule {
      *
      * @example
      * ```typescript
-     * await client.user.deleteFollowGroup('group_123');
+     * await client.following.deleteFollowGroup('group_123');
      * ```
      */
     deleteFollowGroup(groupId: string): Promise<void>;
@@ -1626,7 +1744,7 @@ declare class UserModule {
      *
      * @example
      * ```typescript
-     * await client.user.addFollowsToGroup('group_123', [
+     * await client.following.addFollowsToGroup('group_123', [
      *   { follow_type: 1, follow_value: 'US:TSLA' }
      * ]);
      * ```
@@ -1644,7 +1762,7 @@ declare class UserModule {
      *
      * @example
      * ```typescript
-     * await client.user.removeFollowsFromGroup('group_123', ['AAPL', 'MSFT']);
+     * await client.following.removeFollowsFromGroup('group_123', ['AAPL', 'MSFT']);
      * ```
      */
     removeFollowsFromGroup(groupId: string, followValues: string[]): Promise<void>;
@@ -1658,7 +1776,7 @@ declare class UserModule {
      *
      * @example
      * ```typescript
-     * await client.user.setGroupFollows('group_123', [
+     * await client.following.setGroupFollows('group_123', [
      *   { follow_type: 1, follow_value: 'US:AAPL' },
      *   { follow_type: 1, follow_value: 'HK:00700' }
      * ]);
@@ -1669,23 +1787,23 @@ declare class UserModule {
         follow_value: string;
     }>): Promise<void>;
     /**
-     * Get reports for a follow group
+     * 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 Report data including items list, total_count, page_num, and page_size
+     * @returns docs data including items list, total_count, page_num, and page_size
      *
      * @example
      * ```typescript
-     * const result = await client.user.getGroupReports('group_123', 1, 20);
+     * const result = await client.following.getFollowGroupDocs('group_123', 1, 20);
      * console.log(`Total: ${result.total_count}`);
-     * result.items.forEach(report => {
-     *   console.log(report.title || 'Untitled');
+     * result.items.forEach(doc => {
+     *   console.log(doc.title || 'Untitled');
      * });
      * ```
      */
-    getGroupReports(groupId: string, pageNum?: number, pageSize?: number): Promise<{
+    getFollowGroupDocs(groupId: string, pageNum?: number, pageSize?: number): Promise<{
         items: any[];
         total_count: number;
         page_num: number;
@@ -1693,111 +1811,6 @@ declare class UserModule {
     }>;
 }
 
-/**
- * Search Module
- *
- * Provides document search functionality across various categories.
- */
-
-/**
- * Search module for document search functionality.
- *
- * @example
- * ```typescript
- * const results = await client.search.all('Tesla earnings');
- * const news = await client.search.news('Apple iPhone');
- * ```
- */
-declare class SearchModule {
-    private client;
-    constructor(client: Reportify);
-    /**
-     * Search documents across all categories
-     *
-     * @param query - Search query string
-     * @param options - Search options
-     * @returns List of matching documents
-     */
-    all(query: string, options?: SearchOptions): Promise<Document[]>;
-    /**
-     * Search news articles
-     */
-    news(query: string, options?: SearchOptions): Promise<Document[]>;
-    /**
-     * Search research reports
-     */
-    reports(query: string, options?: SearchOptions): Promise<Document[]>;
-    /**
-     * Search company filings
-     *
-     * @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
-     */
-    filings(query: string, symbols: string[], options?: Omit<SearchOptions, 'symbols' | 'categories' | 'industries' | 'channelIds'>): Promise<Document[]>;
-    /**
-     * 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 symbols - Stock symbols in market:ticker format (required, e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
-     * @param options - Search options including query, fiscal year/quarter filters, and sort order
-     */
-    conferenceCalls(symbols: string[], options?: EarningsSearchOptions & {
-        query?: string;
-    }): Promise<Document[]>;
-    /**
-     * 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 symbols - Stock symbols in market:ticker format (required, e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
-     * @param options - Search options including query, fiscal year/quarter filters, and sort order
-     */
-    earningsPack(symbols: string[], options?: EarningsSearchOptions & {
-        query?: string;
-    }): Promise<Document[]>;
-    /**
-     * Search conference calls and IR (Investor Relations) meetings
-     */
-    minutes(query: string, options?: SearchOptions): Promise<Document[]>;
-    /**
-     * Search social media content
-     */
-    socials(query: string, options?: SearchOptions): Promise<Document[]>;
-    /**
-     * Search webpage content
-     */
-    webpages(query: string, options?: Omit<SearchOptions, 'symbols' | 'categories' | 'industries' | 'channelIds'>): Promise<Document[]>;
-    /**
-     * Crawl web content from given URLs.
-     *
-     * @param urls Array of URLs to get contents for
-     * @param options Options for text, highlights, summary, subpages, etc.
-     * @returns CrawlResponse Promise with extracted results and statuses
-     */
-    crawl(urls: string[], options?: {
-        text?: boolean | {
-            max_characters?: number;
-            include_html_tags?: boolean;
-            verbosity?: 'compact' | 'full';
-        };
-        highlights?: {
-            query?: string;
-            max_characters?: number;
-            num_sentences?: number;
-            highlights_per_url?: number;
-        };
-        summary?: {
-            query?: string;
-        };
-        subpages?: number;
-        subpage_target?: string[];
-        max_age_hours?: number;
-        livecrawl_timeout?: number;
-    }): Promise<any>;
-}
-
 /**
  * Reportify Client
  *
@@ -1833,6 +1846,7 @@ declare class Reportify {
     readonly kb: KBModule;
     readonly timeline: TimelineModule;
     readonly user: UserModule;
+    readonly following: FollowingModule;
     constructor(config: ReportifyConfig);
     /**
      * Make an HTTP request to the API
@@ -1863,4 +1877,4 @@ declare class Reportify {
     getBytes(path: string): Promise<ArrayBuffer>;
 }
 
-export { APIError, type AgentConversation, type AgentMessage, AgentModule, AuthenticationError, type BacktestParams, type BacktestResult, type BatchKline1mParams, type BatchMinuteParams, type BatchOHLCVParams, type Calendar, type Channel, ChannelsModule, type ChatCompletionOptions, type ChatCompletionResponse, type ChatMode, ChatModule, type Chunk, type ChunkSearchOptions, type CompanyInfo, type CompanyOverview, type Concept, type ConceptDoc, type ConceptEvent, type ConceptFeed, type ConceptStock, ConceptsModule, type DocsListOptions, DocsModule, type Document, type DocumentInput, type EarningsEvent, type EarningsSearchOptions, type FactorComputeParams, type FactorMeta, type FinancialStatement, type FollowedCompany, type IPOEvent, type IPOStatus, type IndexConstituent, type IndexFund, type IndicatorComputeParams, type IndicatorData, type IndicatorMeta, type IndustryConstituent, KBModule, type KBSearchOptions, type Kline1mParams, type Market, type MinuteParams, NotFoundError, type OHLCVData, type OHLCVParams, type PaginatedResponse, type Period, type PriceData, QuantModule, type Quote, RateLimitError, Reportify, type ReportifyConfig, ReportifyError, type ScreenParams, type ScreenedStock, SearchModule, type SearchOptions, type Shareholder, type ShareholderType, type StockInfo, type StockMarket, StockModule, TimelineModule, type TimelineOptions, type UploadDocRequest, UserModule };
+export { APIError, type AgentConversation, type AgentMessage, AgentModule, AuthenticationError, type BacktestParams, type BacktestResult, type BatchKline1mParams, type BatchMinuteParams, type BatchOHLCVParams, type Calendar, type Channel, ChannelsModule, type ChatCompletionOptions, type ChatCompletionResponse, type ChatMode, ChatModule, type Chunk, type ChunkSearchOptions, type CompanyInfo, type CompanyOverview, type Concept, type ConceptDoc, type ConceptEvent, type ConceptFeed, type ConceptStock, ConceptsModule, type DocsListOptions, DocsModule, type Document, type DocumentInput, type EarningsEvent, type EarningsSearchOptions, type FactorComputeParams, type FactorMeta, type FinancialStatement, type FollowedCompany, FollowingModule, type IPOEvent, type IPOStatus, type IndexConstituent, type IndexFund, type IndicatorComputeParams, type IndicatorData, type IndicatorMeta, type IndustryConstituent, KBModule, type KBSearchOptions, type Kline1mParams, type Market, type MinuteParams, NotFoundError, type OHLCVData, type OHLCVParams, type PaginatedResponse, type Period, type PriceData, QuantModule, type Quote, RateLimitError, Reportify, type ReportifyConfig, ReportifyError, type ScreenParams, type ScreenedStock, SearchModule, type SearchOptions, type Shareholder, type ShareholderType, type StockInfo, type StockMarket, StockModule, TimelineModule, type TimelineOptions, type UploadDocRequest, UserModule };