reportify-sdk 0.3.22 → 0.3.24

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/dist/index.d.mts +20 -27
  2. package/dist/index.d.ts +20 -27
  3. package/dist/index.js +13 -13
  4. package/dist/index.mjs +13 -13
  5. package/package.json +1 -1
package/dist/index.d.mts CHANGED
@@ -1637,6 +1637,11 @@ declare class SearchModule {
1637
1637
  * Provides access to follow group management functionality.
1638
1638
  */
1639
1639
 
1640
+ type FollowType = 'company' | 'channel';
1641
+ interface FollowValue {
1642
+ follow_type: FollowType;
1643
+ follow_value: string;
1644
+ }
1640
1645
  declare class FollowingModule {
1641
1646
  private client;
1642
1647
  constructor(client: Reportify);
@@ -1644,23 +1649,20 @@ declare class FollowingModule {
1644
1649
  * Create a new follow group
1645
1650
  *
1646
1651
  * @param name - Group name
1647
- * @param followValues - List of follow values (each with 'follow_type' as int and 'follow_value' as string)
1648
- * follow_type: 1=company, 3=channel
1652
+ * @param followValues - List of follow values (each with 'follow_type' and 'follow_value')
1653
+ * follow_type: "company", "channel"
1649
1654
  * @returns Created group information including group_id, name, and count
1650
1655
  *
1651
1656
  * @example
1652
1657
  * ```typescript
1653
1658
  * const result = await client.following.createFollowGroup('My Stocks', [
1654
- * { follow_type: 1, follow_value: 'US:AAPL' },
1655
- * { follow_type: 1, follow_value: 'HK:00700' }
1659
+ * { follow_type: 'company', follow_value: 'US:AAPL' },
1660
+ * { follow_type: 'company', follow_value: 'HK:00700' }
1656
1661
  * ]);
1657
1662
  * console.log(`Created group: ${result.group_id}`);
1658
1663
  * ```
1659
1664
  */
1660
- createFollowGroup(name: string, followValues?: Array<{
1661
- follow_type: number;
1662
- follow_value: string;
1663
- }>): Promise<{
1665
+ createFollowGroup(name: string, followValues?: FollowValue[]): Promise<{
1664
1666
  group_id: string;
1665
1667
  name: string;
1666
1668
  count: number;
@@ -1699,10 +1701,7 @@ declare class FollowingModule {
1699
1701
  group_id: string;
1700
1702
  name: string;
1701
1703
  count: number;
1702
- follow_values: Array<{
1703
- follow_type: number;
1704
- follow_value: string;
1705
- }>;
1704
+ follow_values?: FollowValue[];
1706
1705
  }>;
1707
1706
  /**
1708
1707
  * Update a follow group
@@ -1738,21 +1737,18 @@ declare class FollowingModule {
1738
1737
  * Add follows to a group
1739
1738
  *
1740
1739
  * @param groupId - Group ID
1741
- * @param followValues - List of follow values (each with 'follow_type' as int and 'follow_value' as string)
1742
- * follow_type: 1=company, 3=channel
1740
+ * @param followValues - List of follow values (each with 'follow_type' and 'follow_value')
1741
+ * follow_type: "company", "channel"
1743
1742
  * @returns Status message
1744
1743
  *
1745
1744
  * @example
1746
1745
  * ```typescript
1747
1746
  * await client.following.addFollowsToGroup('group_123', [
1748
- * { follow_type: 1, follow_value: 'US:TSLA' }
1747
+ * { follow_type: 'company', follow_value: 'US:TSLA' }
1749
1748
  * ]);
1750
1749
  * ```
1751
1750
  */
1752
- addFollowsToGroup(groupId: string, followValues: Array<{
1753
- follow_type: number;
1754
- follow_value: string;
1755
- }>): Promise<void>;
1751
+ addFollowsToGroup(groupId: string, followValues: FollowValue[]): Promise<void>;
1756
1752
  /**
1757
1753
  * Remove follows from a group
1758
1754
  *
@@ -1770,22 +1766,19 @@ declare class FollowingModule {
1770
1766
  * Set follows for a group (replace all existing follows)
1771
1767
  *
1772
1768
  * @param groupId - Group ID
1773
- * @param followValues - List of follow values (each with 'follow_type' as int and 'follow_value' as string)
1774
- * follow_type: 1=company, 3=channel
1769
+ * @param followValues - List of follow values (each with 'follow_type' and 'follow_value')
1770
+ * follow_type: "company", "channel"
1775
1771
  * @returns Status message
1776
1772
  *
1777
1773
  * @example
1778
1774
  * ```typescript
1779
1775
  * await client.following.setGroupFollows('group_123', [
1780
- * { follow_type: 1, follow_value: 'US:AAPL' },
1781
- * { follow_type: 1, follow_value: 'HK:00700' }
1776
+ * { follow_type: 'company', follow_value: 'US:AAPL' },
1777
+ * { follow_type: 'company', follow_value: 'HK:00700' }
1782
1778
  * ]);
1783
1779
  * ```
1784
1780
  */
1785
- setGroupFollows(groupId: string, followValues: Array<{
1786
- follow_type: number;
1787
- follow_value: string;
1788
- }>): Promise<void>;
1781
+ setGroupFollows(groupId: string, followValues: FollowValue[]): Promise<void>;
1789
1782
  /**
1790
1783
  * Get docs for a follow group
1791
1784
  *
package/dist/index.d.ts CHANGED
@@ -1637,6 +1637,11 @@ declare class SearchModule {
1637
1637
  * Provides access to follow group management functionality.
1638
1638
  */
1639
1639
 
1640
+ type FollowType = 'company' | 'channel';
1641
+ interface FollowValue {
1642
+ follow_type: FollowType;
1643
+ follow_value: string;
1644
+ }
1640
1645
  declare class FollowingModule {
1641
1646
  private client;
1642
1647
  constructor(client: Reportify);
@@ -1644,23 +1649,20 @@ declare class FollowingModule {
1644
1649
  * Create a new follow group
1645
1650
  *
1646
1651
  * @param name - Group name
1647
- * @param followValues - List of follow values (each with 'follow_type' as int and 'follow_value' as string)
1648
- * follow_type: 1=company, 3=channel
1652
+ * @param followValues - List of follow values (each with 'follow_type' and 'follow_value')
1653
+ * follow_type: "company", "channel"
1649
1654
  * @returns Created group information including group_id, name, and count
1650
1655
  *
1651
1656
  * @example
1652
1657
  * ```typescript
1653
1658
  * const result = await client.following.createFollowGroup('My Stocks', [
1654
- * { follow_type: 1, follow_value: 'US:AAPL' },
1655
- * { follow_type: 1, follow_value: 'HK:00700' }
1659
+ * { follow_type: 'company', follow_value: 'US:AAPL' },
1660
+ * { follow_type: 'company', follow_value: 'HK:00700' }
1656
1661
  * ]);
1657
1662
  * console.log(`Created group: ${result.group_id}`);
1658
1663
  * ```
1659
1664
  */
1660
- createFollowGroup(name: string, followValues?: Array<{
1661
- follow_type: number;
1662
- follow_value: string;
1663
- }>): Promise<{
1665
+ createFollowGroup(name: string, followValues?: FollowValue[]): Promise<{
1664
1666
  group_id: string;
1665
1667
  name: string;
1666
1668
  count: number;
@@ -1699,10 +1701,7 @@ declare class FollowingModule {
1699
1701
  group_id: string;
1700
1702
  name: string;
1701
1703
  count: number;
1702
- follow_values: Array<{
1703
- follow_type: number;
1704
- follow_value: string;
1705
- }>;
1704
+ follow_values?: FollowValue[];
1706
1705
  }>;
1707
1706
  /**
1708
1707
  * Update a follow group
@@ -1738,21 +1737,18 @@ declare class FollowingModule {
1738
1737
  * Add follows to a group
1739
1738
  *
1740
1739
  * @param groupId - Group ID
1741
- * @param followValues - List of follow values (each with 'follow_type' as int and 'follow_value' as string)
1742
- * follow_type: 1=company, 3=channel
1740
+ * @param followValues - List of follow values (each with 'follow_type' and 'follow_value')
1741
+ * follow_type: "company", "channel"
1743
1742
  * @returns Status message
1744
1743
  *
1745
1744
  * @example
1746
1745
  * ```typescript
1747
1746
  * await client.following.addFollowsToGroup('group_123', [
1748
- * { follow_type: 1, follow_value: 'US:TSLA' }
1747
+ * { follow_type: 'company', follow_value: 'US:TSLA' }
1749
1748
  * ]);
1750
1749
  * ```
1751
1750
  */
1752
- addFollowsToGroup(groupId: string, followValues: Array<{
1753
- follow_type: number;
1754
- follow_value: string;
1755
- }>): Promise<void>;
1751
+ addFollowsToGroup(groupId: string, followValues: FollowValue[]): Promise<void>;
1756
1752
  /**
1757
1753
  * Remove follows from a group
1758
1754
  *
@@ -1770,22 +1766,19 @@ declare class FollowingModule {
1770
1766
  * Set follows for a group (replace all existing follows)
1771
1767
  *
1772
1768
  * @param groupId - Group ID
1773
- * @param followValues - List of follow values (each with 'follow_type' as int and 'follow_value' as string)
1774
- * follow_type: 1=company, 3=channel
1769
+ * @param followValues - List of follow values (each with 'follow_type' and 'follow_value')
1770
+ * follow_type: "company", "channel"
1775
1771
  * @returns Status message
1776
1772
  *
1777
1773
  * @example
1778
1774
  * ```typescript
1779
1775
  * await client.following.setGroupFollows('group_123', [
1780
- * { follow_type: 1, follow_value: 'US:AAPL' },
1781
- * { follow_type: 1, follow_value: 'HK:00700' }
1776
+ * { follow_type: 'company', follow_value: 'US:AAPL' },
1777
+ * { follow_type: 'company', follow_value: 'HK:00700' }
1782
1778
  * ]);
1783
1779
  * ```
1784
1780
  */
1785
- setGroupFollows(groupId: string, followValues: Array<{
1786
- follow_type: number;
1787
- follow_value: string;
1788
- }>): Promise<void>;
1781
+ setGroupFollows(groupId: string, followValues: FollowValue[]): Promise<void>;
1789
1782
  /**
1790
1783
  * Get docs for a follow group
1791
1784
  *
package/dist/index.js CHANGED
@@ -853,7 +853,7 @@ var QuantModule = class {
853
853
  * ```
854
854
  */
855
855
  async kline1m(params) {
856
- const response = await this.client.post("/v1/quant/quotes/1mkline", {
856
+ const response = await this.client.get("/v1/quant/quotes/1mkline", {
857
857
  symbol: params.symbol,
858
858
  start_datetime: params.startDateTime,
859
859
  end_datetime: params.endDateTime,
@@ -903,7 +903,7 @@ var QuantModule = class {
903
903
  * ```
904
904
  */
905
905
  async minute(params) {
906
- const response = await this.client.post("/v1/quant/quotes/minute", {
906
+ const response = await this.client.get("/v1/quant/quotes/minute", {
907
907
  symbol: params.symbol,
908
908
  start_datetime: params.startDateTime,
909
909
  end_datetime: params.endDateTime,
@@ -1763,15 +1763,15 @@ var FollowingModule = class {
1763
1763
  * Create a new follow group
1764
1764
  *
1765
1765
  * @param name - Group name
1766
- * @param followValues - List of follow values (each with 'follow_type' as int and 'follow_value' as string)
1767
- * follow_type: 1=company, 3=channel
1766
+ * @param followValues - List of follow values (each with 'follow_type' and 'follow_value')
1767
+ * follow_type: "company", "channel"
1768
1768
  * @returns Created group information including group_id, name, and count
1769
1769
  *
1770
1770
  * @example
1771
1771
  * ```typescript
1772
1772
  * const result = await client.following.createFollowGroup('My Stocks', [
1773
- * { follow_type: 1, follow_value: 'US:AAPL' },
1774
- * { follow_type: 1, follow_value: 'HK:00700' }
1773
+ * { follow_type: 'company', follow_value: 'US:AAPL' },
1774
+ * { follow_type: 'company', follow_value: 'HK:00700' }
1775
1775
  * ]);
1776
1776
  * console.log(`Created group: ${result.group_id}`);
1777
1777
  * ```
@@ -1861,14 +1861,14 @@ var FollowingModule = class {
1861
1861
  * Add follows to a group
1862
1862
  *
1863
1863
  * @param groupId - Group ID
1864
- * @param followValues - List of follow values (each with 'follow_type' as int and 'follow_value' as string)
1865
- * follow_type: 1=company, 3=channel
1864
+ * @param followValues - List of follow values (each with 'follow_type' and 'follow_value')
1865
+ * follow_type: "company", "channel"
1866
1866
  * @returns Status message
1867
1867
  *
1868
1868
  * @example
1869
1869
  * ```typescript
1870
1870
  * await client.following.addFollowsToGroup('group_123', [
1871
- * { follow_type: 1, follow_value: 'US:TSLA' }
1871
+ * { follow_type: 'company', follow_value: 'US:TSLA' }
1872
1872
  * ]);
1873
1873
  * ```
1874
1874
  */
@@ -1899,15 +1899,15 @@ var FollowingModule = class {
1899
1899
  * Set follows for a group (replace all existing follows)
1900
1900
  *
1901
1901
  * @param groupId - Group ID
1902
- * @param followValues - List of follow values (each with 'follow_type' as int and 'follow_value' as string)
1903
- * follow_type: 1=company, 3=channel
1902
+ * @param followValues - List of follow values (each with 'follow_type' and 'follow_value')
1903
+ * follow_type: "company", "channel"
1904
1904
  * @returns Status message
1905
1905
  *
1906
1906
  * @example
1907
1907
  * ```typescript
1908
1908
  * await client.following.setGroupFollows('group_123', [
1909
- * { follow_type: 1, follow_value: 'US:AAPL' },
1910
- * { follow_type: 1, follow_value: 'HK:00700' }
1909
+ * { follow_type: 'company', follow_value: 'US:AAPL' },
1910
+ * { follow_type: 'company', follow_value: 'HK:00700' }
1911
1911
  * ]);
1912
1912
  * ```
1913
1913
  */
package/dist/index.mjs CHANGED
@@ -809,7 +809,7 @@ var QuantModule = class {
809
809
  * ```
810
810
  */
811
811
  async kline1m(params) {
812
- const response = await this.client.post("/v1/quant/quotes/1mkline", {
812
+ const response = await this.client.get("/v1/quant/quotes/1mkline", {
813
813
  symbol: params.symbol,
814
814
  start_datetime: params.startDateTime,
815
815
  end_datetime: params.endDateTime,
@@ -859,7 +859,7 @@ var QuantModule = class {
859
859
  * ```
860
860
  */
861
861
  async minute(params) {
862
- const response = await this.client.post("/v1/quant/quotes/minute", {
862
+ const response = await this.client.get("/v1/quant/quotes/minute", {
863
863
  symbol: params.symbol,
864
864
  start_datetime: params.startDateTime,
865
865
  end_datetime: params.endDateTime,
@@ -1719,15 +1719,15 @@ var FollowingModule = class {
1719
1719
  * Create a new follow group
1720
1720
  *
1721
1721
  * @param name - Group name
1722
- * @param followValues - List of follow values (each with 'follow_type' as int and 'follow_value' as string)
1723
- * follow_type: 1=company, 3=channel
1722
+ * @param followValues - List of follow values (each with 'follow_type' and 'follow_value')
1723
+ * follow_type: "company", "channel"
1724
1724
  * @returns Created group information including group_id, name, and count
1725
1725
  *
1726
1726
  * @example
1727
1727
  * ```typescript
1728
1728
  * const result = await client.following.createFollowGroup('My Stocks', [
1729
- * { follow_type: 1, follow_value: 'US:AAPL' },
1730
- * { follow_type: 1, follow_value: 'HK:00700' }
1729
+ * { follow_type: 'company', follow_value: 'US:AAPL' },
1730
+ * { follow_type: 'company', follow_value: 'HK:00700' }
1731
1731
  * ]);
1732
1732
  * console.log(`Created group: ${result.group_id}`);
1733
1733
  * ```
@@ -1817,14 +1817,14 @@ var FollowingModule = class {
1817
1817
  * Add follows to a group
1818
1818
  *
1819
1819
  * @param groupId - Group ID
1820
- * @param followValues - List of follow values (each with 'follow_type' as int and 'follow_value' as string)
1821
- * follow_type: 1=company, 3=channel
1820
+ * @param followValues - List of follow values (each with 'follow_type' and 'follow_value')
1821
+ * follow_type: "company", "channel"
1822
1822
  * @returns Status message
1823
1823
  *
1824
1824
  * @example
1825
1825
  * ```typescript
1826
1826
  * await client.following.addFollowsToGroup('group_123', [
1827
- * { follow_type: 1, follow_value: 'US:TSLA' }
1827
+ * { follow_type: 'company', follow_value: 'US:TSLA' }
1828
1828
  * ]);
1829
1829
  * ```
1830
1830
  */
@@ -1855,15 +1855,15 @@ var FollowingModule = class {
1855
1855
  * Set follows for a group (replace all existing follows)
1856
1856
  *
1857
1857
  * @param groupId - Group ID
1858
- * @param followValues - List of follow values (each with 'follow_type' as int and 'follow_value' as string)
1859
- * follow_type: 1=company, 3=channel
1858
+ * @param followValues - List of follow values (each with 'follow_type' and 'follow_value')
1859
+ * follow_type: "company", "channel"
1860
1860
  * @returns Status message
1861
1861
  *
1862
1862
  * @example
1863
1863
  * ```typescript
1864
1864
  * await client.following.setGroupFollows('group_123', [
1865
- * { follow_type: 1, follow_value: 'US:AAPL' },
1866
- * { follow_type: 1, follow_value: 'HK:00700' }
1865
+ * { follow_type: 'company', follow_value: 'US:AAPL' },
1866
+ * { follow_type: 'company', follow_value: 'HK:00700' }
1867
1867
  * ]);
1868
1868
  * ```
1869
1869
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "reportify-sdk",
3
- "version": "0.3.22",
3
+ "version": "0.3.24",
4
4
  "description": "TypeScript SDK for Reportify API - Financial data and document search",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",