@mentio-dev/sdk 0.15.1 → 0.16.1

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.
package/dist/index.d.ts CHANGED
@@ -400,6 +400,10 @@ type Keyword = {
400
400
  * The tracked text, as typed.
401
401
  */
402
402
  term: string;
403
+ /**
404
+ * The boolean query the keyword was written as, as sent; term and matching hold what it compiled to. Null for a keyword defined by its fields, or once its term or term rules changed by hand.
405
+ */
406
+ query: string | null;
403
407
  /**
404
408
  * brand (your own name), competitor, or topic.
405
409
  */
@@ -715,7 +719,7 @@ type ErrorResponse = {
715
719
  /**
716
720
  * Stable machine-readable code; branch on this, never on the message. Codes are additive: a client should treat one it does not know as a generic failure of the same status.
717
721
  */
718
- code: 'unauthorized' | 'forbidden' | 'read_only_key' | 'validation_error' | 'not_found' | 'invalid_cursor' | 'payload_too_large' | 'idempotency_key_in_use' | 'idempotency_key_reused' | 'rate_limited' | 'duplicate_keyword' | 'insufficient_balance' | 'keyword_limit_reached' | 'billing_not_configured' | 'order_not_credited' | 'schedule_required' | 'unknown_channel' | 'not_a_digest' | 'hourly_email_unsupported' | 'slack_not_connected' | 'slack_not_configured' | 'telegram_not_configured' | 'feed_unreadable' | 'feed_login_required' | 'feed_login_expired' | 'feed_limit_reached' | 'feed_auth_not_configured' | 'email_not_configured' | 'invalid_assignee' | 'classification_pending' | 'invalid_member' | 'already_member' | 'last_owner' | 'duplicate_segment' | 'filter_too_complex' | 'duplicate_view' | 'duplicate_group' | 'default_group' | 'default_group_context' | 'group_changed' | 'invalid_signature' | 'webhook_not_configured' | 'invalid_token' | 'protected_user' | 'upstream_unavailable' | 'internal_error';
722
+ code: 'unauthorized' | 'forbidden' | 'read_only_key' | 'validation_error' | 'not_found' | 'invalid_cursor' | 'payload_too_large' | 'idempotency_key_in_use' | 'idempotency_key_reused' | 'rate_limited' | 'duplicate_keyword' | 'invalid_query' | 'query_needs_one_term' | 'query_not_supported' | 'insufficient_balance' | 'keyword_limit_reached' | 'billing_not_configured' | 'order_not_credited' | 'schedule_required' | 'unknown_channel' | 'not_a_digest' | 'hourly_email_unsupported' | 'slack_not_connected' | 'slack_not_configured' | 'telegram_not_configured' | 'feed_unreadable' | 'feed_login_required' | 'feed_login_expired' | 'feed_limit_reached' | 'feed_auth_not_configured' | 'email_not_configured' | 'invalid_assignee' | 'classification_pending' | 'invalid_member' | 'already_member' | 'last_owner' | 'duplicate_segment' | 'filter_too_complex' | 'duplicate_view' | 'duplicate_automation' | 'automation_filter_unreadable' | 'automation_limit_reached' | 'duplicate_group' | 'default_group' | 'default_group_context' | 'group_changed' | 'invalid_signature' | 'webhook_not_configured' | 'invalid_token' | 'protected_user' | 'upstream_unavailable' | 'internal_error';
719
723
  /**
720
724
  * Human-readable detail; may change between releases.
721
725
  */
@@ -728,6 +732,12 @@ type ErrorResponse = {
728
732
  * For rate_limited and other retryable errors: how long to wait before retrying (mirrors the Retry-After header).
729
733
  */
730
734
  retryAfterSeconds?: number;
735
+ /**
736
+ * Machine-readable facts about this error, when the code has any: for a keyword query, `reason`, `position` (the character a syntax error was found at) or `terms` (one keyword each).
737
+ */
738
+ details?: {
739
+ [key: string]: unknown;
740
+ };
731
741
  };
732
742
  };
733
743
  type KeywordSuggestion = {
@@ -748,9 +758,13 @@ type KeywordSuggestion = {
748
758
  */
749
759
  patch: {
750
760
  /**
751
- * Renames the keyword: the new term is tracked from now on, with no look-back, keeping its id, settings and old mentions. Double quotes mean the exact phrase only. 409 when its group already tracks it.
761
+ * Renames the keyword: the new term is tracked from now on, with no look-back, keeping its id, settings and old mentions. Double quotes mean the exact phrase only. 409 when its group already tracks it. Clears query.
752
762
  */
753
763
  term?: string;
764
+ /**
765
+ * Rewrites the term (a rename) and the term rules from a boolean query; the other matching fields stay. Never with term or those rules (400). A later hand change of either clears it. See [Keywords](/guides/keywords#write-it-as-a-query).
766
+ */
767
+ query?: string;
754
768
  /**
755
769
  * Reclassify it as brand, competitor or topic.
756
770
  */
@@ -1316,6 +1330,20 @@ type WorkspaceFilters = {
1316
1330
  */
1317
1331
  updatedAt: string | null;
1318
1332
  };
1333
+ type MentionBatchResult = {
1334
+ /**
1335
+ * The ids changed, in the order sent. A pending mention given only a status is not changed: it is in pending alone.
1336
+ */
1337
+ updated: Array<string>;
1338
+ /**
1339
+ * The ids this workspace has no mention by, in the order sent; nothing was done to them.
1340
+ */
1341
+ notFound: Array<string>;
1342
+ /**
1343
+ * Of the updated ids, those still waiting for the classifier: they took the labels and the assignee, but their status stays until they are scored. Empty unless the update set a status.
1344
+ */
1345
+ pending: Array<string>;
1346
+ };
1319
1347
  type Mention = {
1320
1348
  /**
1321
1349
  * Mention id (mm_...): one post matched to one of your keywords. A post matching two keywords has two ids.
@@ -1509,6 +1537,10 @@ type Mention = {
1509
1537
  * Follower count as of their newest post; null where the platform has none.
1510
1538
  */
1511
1539
  followers: number | null;
1540
+ /**
1541
+ * How far their voice carries, 0 to 100 from followers on a log scale: round(20 * log10(followers + 1)), capped at 100 (1,000 followers is 60). Null when followers are unknown.
1542
+ */
1543
+ influence: number | null;
1512
1544
  /**
1513
1545
  * Your tags on this person: the workspace's, then those the mention's own keyword group gave them (set with groupId on /v1/people), each once.
1514
1546
  */
@@ -1580,6 +1612,21 @@ type Mention = {
1580
1612
  * positive, neutral or negative; null until classified.
1581
1613
  */
1582
1614
  sentiment: 'positive' | 'neutral' | 'negative';
1615
+ /**
1616
+ * The author's dominant emotion toward the keyword, apart from sentiment; null when not judged.
1617
+ *
1618
+ * - joy: delight or excitement about it.
1619
+ * - trust: relies on it, vouches for it.
1620
+ * - anticipation: looks forward to a launch or update.
1621
+ * - surprise: caught off guard by it.
1622
+ * - confusion: unsure how it works, stuck.
1623
+ * - frustration: annoyed it fails or gets in the way.
1624
+ * - anger: outraged, feels wronged by it.
1625
+ * - fear: worried: risk, security, lock-in, cost.
1626
+ * - sadness: disappointed, regrets a loss or shutdown.
1627
+ * - neutral: no emotion shown, or only named.
1628
+ */
1629
+ emotion: 'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral';
1583
1630
  /**
1584
1631
  * Intent and topic tags:
1585
1632
  *
@@ -1684,6 +1731,10 @@ type Mention = {
1684
1731
  */
1685
1732
  note: string | null;
1686
1733
  };
1734
+ /**
1735
+ * Your labels on this mention (hot-lead, replied...), alphabetical. Set them with PATCH, POST /v1/mentions/batch or an automation.
1736
+ */
1737
+ labels: Array<string>;
1687
1738
  /**
1688
1739
  * On a cross-post (same author, text and keyword within three days), the original's id. Billed like any mention, listed only under its original, never alerted alone. null for an original. See [Cross-posts](/how-it-works#cross-posts).
1689
1740
  */
@@ -1866,6 +1917,10 @@ type Person = {
1866
1917
  * Followers when last seen; null when unknown.
1867
1918
  */
1868
1919
  followers: number | null;
1920
+ /**
1921
+ * How far their voice carries, 0 to 100 from followers on a log scale: round(20 * log10(followers + 1)), capped at 100 (1,000 followers is 60). Null when followers are unknown.
1922
+ */
1923
+ influence: number | null;
1869
1924
  /**
1870
1925
  * Accounts they follow; null when unknown.
1871
1926
  */
@@ -2332,6 +2387,14 @@ type FilterGroup = {
2332
2387
  * Never these sentiments; an unscored mention still passes.
2333
2388
  */
2334
2389
  notSentiments?: Array<'positive' | 'neutral' | 'negative'>;
2390
+ /**
2391
+ * Only mentions showing any of these emotions toward the keyword. A mention whose emotion was not judged never passes.
2392
+ */
2393
+ emotions?: Array<'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral'>;
2394
+ /**
2395
+ * Never these emotions; a mention whose emotion was not judged still passes.
2396
+ */
2397
+ notEmotions?: Array<'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral'>;
2335
2398
  /**
2336
2399
  * Only mentions carrying any of these intent or topic tags.
2337
2400
  */
@@ -2372,6 +2435,14 @@ type FilterGroup = {
2372
2435
  * Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
2373
2436
  */
2374
2437
  notTags?: Array<string>;
2438
+ /**
2439
+ * Only mentions carrying any of these labels (exact, case-sensitive).
2440
+ */
2441
+ labels?: Array<string>;
2442
+ /**
2443
+ * Never mentions carrying any of these labels.
2444
+ */
2445
+ notLabels?: Array<string>;
2375
2446
  /**
2376
2447
  * Only posts linking to any of these hosts, the host itself or a subdomain of it.
2377
2448
  */
@@ -2522,6 +2593,233 @@ type View = {
2522
2593
  * Never these sentiments; an unscored mention still passes.
2523
2594
  */
2524
2595
  notSentiments?: Array<'positive' | 'neutral' | 'negative'>;
2596
+ /**
2597
+ * Only mentions showing any of these emotions toward the keyword. A mention whose emotion was not judged never passes.
2598
+ */
2599
+ emotions?: Array<'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral'>;
2600
+ /**
2601
+ * Never these emotions; a mention whose emotion was not judged still passes.
2602
+ */
2603
+ notEmotions?: Array<'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral'>;
2604
+ /**
2605
+ * Only mentions carrying any of these intent or topic tags.
2606
+ */
2607
+ intents?: Array<string>;
2608
+ /**
2609
+ * Never mentions carrying these tags.
2610
+ */
2611
+ notIntents?: Array<string>;
2612
+ /**
2613
+ * true: only posts that read as machine-made; false: only the rest.
2614
+ */
2615
+ automated?: boolean;
2616
+ /**
2617
+ * Only posts in any of these languages (ISO 639-1).
2618
+ */
2619
+ languages?: Array<string>;
2620
+ /**
2621
+ * Never posts in these languages; an unknown language still passes.
2622
+ */
2623
+ notLanguages?: Array<string>;
2624
+ /**
2625
+ * Only posts whose author is in any of these countries (ISO 3166-1 alpha-2: us, in, de). An unknown country never passes.
2626
+ */
2627
+ countries?: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
2628
+ /**
2629
+ * Never posts whose author is in these countries; an unknown country still passes.
2630
+ */
2631
+ notCountries?: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
2632
+ /**
2633
+ * true: only posts by companies, brands and organizations; false: only posts by people.
2634
+ */
2635
+ organization?: boolean;
2636
+ /**
2637
+ * Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
2638
+ */
2639
+ tags?: Array<string>;
2640
+ /**
2641
+ * Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
2642
+ */
2643
+ notTags?: Array<string>;
2644
+ /**
2645
+ * Only mentions carrying any of these labels (exact, case-sensitive).
2646
+ */
2647
+ labels?: Array<string>;
2648
+ /**
2649
+ * Never mentions carrying any of these labels.
2650
+ */
2651
+ notLabels?: Array<string>;
2652
+ /**
2653
+ * Only posts linking to any of these hosts, the host itself or a subdomain of it.
2654
+ */
2655
+ linkHosts?: Array<string>;
2656
+ /**
2657
+ * Never posts linking to these hosts.
2658
+ */
2659
+ notLinkHosts?: Array<string>;
2660
+ /**
2661
+ * Only Reddit posts from any of these subreddits (names without the r/, any case); every other post fails it.
2662
+ */
2663
+ subreddits?: Array<string>;
2664
+ /**
2665
+ * Never Reddit posts from these subreddits; posts from other platforms still pass.
2666
+ */
2667
+ notSubreddits?: Array<string>;
2668
+ /**
2669
+ * Only authors with at least this many followers; unknown reach never passes.
2670
+ */
2671
+ minFollowers?: number;
2672
+ /**
2673
+ * Only authors with at most this many followers; unknown reach never passes.
2674
+ */
2675
+ maxFollowers?: number;
2676
+ /**
2677
+ * true: only replies and comments; false: only top-level posts.
2678
+ */
2679
+ isReply?: boolean;
2680
+ /**
2681
+ * Only posts (post), only comments (comment) or only GitHub repository events (repository).
2682
+ */
2683
+ kind?: 'post' | 'comment' | 'repository';
2684
+ /**
2685
+ * Never these authors: display names, handles or profile URLs.
2686
+ */
2687
+ notAuthors?: Array<string>;
2688
+ /**
2689
+ * Deprecated: use notAuthors, the same filter. Both may be given; every author named in either is hidden.
2690
+ */
2691
+ excludeAuthors?: Array<string>;
2692
+ /**
2693
+ * Only app store reviews with any of these star ratings; every other post fails it.
2694
+ */
2695
+ ratings?: Array<number>;
2696
+ /**
2697
+ * Never reviews with these star ratings; posts that are not reviews still pass.
2698
+ */
2699
+ notRatings?: Array<number>;
2700
+ /**
2701
+ * Only posts with at least this many likes (upvotes, reactions), as the platform reported them when the post was found. A post without that count never passes.
2702
+ */
2703
+ minLikes?: number;
2704
+ /**
2705
+ * Only posts with at least this many reposts (shares, retweets), as the platform reported them when the post was found. A post without that count never passes.
2706
+ */
2707
+ minReposts?: number;
2708
+ /**
2709
+ * Only posts with at least this many replies (comments), as the platform reported them when the post was found. A post without that count never passes.
2710
+ */
2711
+ minReplies?: number;
2712
+ /**
2713
+ * Only posts with at least this many quotes, as the platform reported them when the post was found. A post without that count never passes.
2714
+ */
2715
+ minQuotes?: number;
2716
+ /**
2717
+ * Only posts with at least this many views (plays), as the platform reported them when the post was found. A post without that count never passes.
2718
+ */
2719
+ minViews?: number;
2720
+ /**
2721
+ * Only posts with at least this many bookmarks (saves), as the platform reported them when the post was found. A post without that count never passes.
2722
+ */
2723
+ minBookmarks?: number;
2724
+ /**
2725
+ * OR across groups: a mention passes when it meets every condition of at least one group, and the other conditions too. A group takes view-filter conditions, no anyOf of its own. See [anyOf](/conventions#or-across-groups-anyof).
2726
+ */
2727
+ anyOf?: Array<FilterGroup>;
2728
+ };
2729
+ /**
2730
+ * ISO 8601 timestamp, UTC.
2731
+ */
2732
+ createdAt: string;
2733
+ /**
2734
+ * ISO 8601 timestamp, UTC.
2735
+ */
2736
+ updatedAt: string;
2737
+ };
2738
+ type Automation = {
2739
+ /**
2740
+ * Automation id (atm_...).
2741
+ */
2742
+ id: string;
2743
+ /**
2744
+ * Automation name, unique in the workspace.
2745
+ */
2746
+ name: string;
2747
+ /**
2748
+ * false: kept but not run.
2749
+ */
2750
+ enabled: boolean;
2751
+ /**
2752
+ * Which mentions it acts on: the fields of GET /v1/mentions, like a view.
2753
+ */
2754
+ filter: {
2755
+ /**
2756
+ * Substring in the post text or the author's name.
2757
+ */
2758
+ q?: string;
2759
+ /**
2760
+ * Only matches of any of these keywords.
2761
+ */
2762
+ keywordIds?: Array<string>;
2763
+ /**
2764
+ * Never matches of these keywords.
2765
+ */
2766
+ notKeywordIds?: Array<string>;
2767
+ /**
2768
+ * Only matches of keywords of any of these kinds: brand, competitor, topic.
2769
+ */
2770
+ keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
2771
+ /**
2772
+ * Never matches of keywords of these kinds.
2773
+ */
2774
+ notKeywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
2775
+ /**
2776
+ * Only matches of keywords in any of these groups (grp_...).
2777
+ */
2778
+ groupIds?: Array<string>;
2779
+ /**
2780
+ * Never matches of keywords in these groups.
2781
+ */
2782
+ notGroupIds?: Array<string>;
2783
+ /**
2784
+ * Only posts from any of these platforms.
2785
+ */
2786
+ platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
2787
+ /**
2788
+ * Never posts from these platforms.
2789
+ */
2790
+ notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
2791
+ /**
2792
+ * Only mentions in this status: open, ignored, done.
2793
+ */
2794
+ status?: 'open' | 'ignored' | 'done';
2795
+ /**
2796
+ * true: only mentions the classifier scored relevant; false: only the rest.
2797
+ */
2798
+ relevant?: boolean;
2799
+ /**
2800
+ * Only mentions scored at least this.
2801
+ */
2802
+ minRelevance?: number;
2803
+ /**
2804
+ * Only mentions whose classifier confidence is at least this.
2805
+ */
2806
+ minConfidence?: number;
2807
+ /**
2808
+ * Only these sentiments.
2809
+ */
2810
+ sentiments?: Array<'positive' | 'neutral' | 'negative'>;
2811
+ /**
2812
+ * Never these sentiments; an unscored mention still passes.
2813
+ */
2814
+ notSentiments?: Array<'positive' | 'neutral' | 'negative'>;
2815
+ /**
2816
+ * Only mentions showing any of these emotions toward the keyword. A mention whose emotion was not judged never passes.
2817
+ */
2818
+ emotions?: Array<'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral'>;
2819
+ /**
2820
+ * Never these emotions; a mention whose emotion was not judged still passes.
2821
+ */
2822
+ notEmotions?: Array<'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral'>;
2525
2823
  /**
2526
2824
  * Only mentions carrying any of these intent or topic tags.
2527
2825
  */
@@ -2562,6 +2860,14 @@ type View = {
2562
2860
  * Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
2563
2861
  */
2564
2862
  notTags?: Array<string>;
2863
+ /**
2864
+ * Only mentions carrying any of these labels (exact, case-sensitive).
2865
+ */
2866
+ labels?: Array<string>;
2867
+ /**
2868
+ * Never mentions carrying any of these labels.
2869
+ */
2870
+ notLabels?: Array<string>;
2565
2871
  /**
2566
2872
  * Only posts linking to any of these hosts, the host itself or a subdomain of it.
2567
2873
  */
@@ -2639,6 +2945,19 @@ type View = {
2639
2945
  */
2640
2946
  anyOf?: Array<FilterGroup>;
2641
2947
  };
2948
+ /**
2949
+ * What it does to each mention the filter selects.
2950
+ */
2951
+ actions: {
2952
+ /**
2953
+ * Labels it adds.
2954
+ */
2955
+ addLabels: Array<string>;
2956
+ /**
2957
+ * The member it assigns, or null.
2958
+ */
2959
+ assigneeId: string | null;
2960
+ };
2642
2961
  /**
2643
2962
  * ISO 8601 timestamp, UTC.
2644
2963
  */
@@ -3684,6 +4003,14 @@ type Alert = {
3684
4003
  * Only these sentiments.
3685
4004
  */
3686
4005
  sentiments?: Array<'positive' | 'neutral' | 'negative'>;
4006
+ /**
4007
+ * Only mentions showing any of these emotions toward the keyword. A mention whose emotion was not judged never passes.
4008
+ */
4009
+ emotions?: Array<'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral'>;
4010
+ /**
4011
+ * Never these emotions: ["anger"]. A mention whose emotion was not judged still passes.
4012
+ */
4013
+ notEmotions?: Array<'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral'>;
3687
4014
  /**
3688
4015
  * At least one of these intent or topic tags.
3689
4016
  */
@@ -3701,7 +4028,15 @@ type Alert = {
3701
4028
  */
3702
4029
  tags?: Array<string>;
3703
4030
  /**
3704
- * Only posts linking to any of these hosts, the host itself or a subdomain of it (octolens.com also matches blog.octolens.com). A post with no links never passes.
4031
+ * Only mentions carrying any of these labels. An automation labels a mention before it is delivered, so a rule can route what an automation labelled.
4032
+ */
4033
+ labels?: Array<string>;
4034
+ /**
4035
+ * Never mentions carrying any of these labels.
4036
+ */
4037
+ notLabels?: Array<string>;
4038
+ /**
4039
+ * Only posts linking to any of these hosts, the host itself or a subdomain of it (octolens.com also matches blog.octolens.com). A post with no links never passes.
3705
4040
  */
3706
4041
  linkHosts?: Array<string>;
3707
4042
  /**
@@ -4211,13 +4546,13 @@ type AnalyticsBreakdown = {
4211
4546
  /**
4212
4547
  * The dimension the rows are grouped by.
4213
4548
  */
4214
- by: 'platform' | 'keyword' | 'sentiment' | 'intent' | 'status' | 'hour' | 'person' | 'language' | 'country' | 'subreddit';
4549
+ by: 'platform' | 'keyword' | 'sentiment' | 'emotion' | 'intent' | 'status' | 'hour' | 'person' | 'language' | 'country' | 'subreddit' | 'domain' | 'link' | 'hashtag';
4215
4550
  /**
4216
4551
  * Most matched first, at most 50 groups. by=hour is chronological and unlimited (168 cells at most).
4217
4552
  */
4218
4553
  data: Array<{
4219
4554
  /**
4220
- * The group: platform name, keyword id, sentiment, intent, status, "weekday-hour" for by=hour, an opaque person key, or the subreddit in lowercase.
4555
+ * The group: platform name, keyword id, sentiment, emotion, intent, status, "weekday-hour" for by=hour, an opaque person key, the subreddit in lowercase, the host (by=domain), the URL (by=link) or the hashtag without its #.
4221
4556
  */
4222
4557
  key: string;
4223
4558
  /**
@@ -4293,7 +4628,7 @@ type AnalyticsBreakdown = {
4293
4628
  */
4294
4629
  relevant: number;
4295
4630
  /**
4296
- * Percent of the window's matched mentions in this group, one decimal. Intents overlap, so their shares can add up past 100.
4631
+ * Percent of the window's matched mentions in this group, one decimal. Intents, domains, links and hashtags overlap, so their shares can add up past 100.
4297
4632
  */
4298
4633
  share: number;
4299
4634
  /**
@@ -5088,6 +5423,10 @@ type ListKeywordsResponses = {
5088
5423
  * The tracked text, as typed.
5089
5424
  */
5090
5425
  term: string;
5426
+ /**
5427
+ * The boolean query the keyword was written as, as sent; term and matching hold what it compiled to. Null for a keyword defined by its fields, or once its term or term rules changed by hand.
5428
+ */
5429
+ query: string | null;
5091
5430
  /**
5092
5431
  * brand (your own name), competitor, or topic.
5093
5432
  */
@@ -5405,9 +5744,17 @@ type ListKeywordsResponse = ListKeywordsResponses[keyof ListKeywordsResponses];
5405
5744
  type CreateKeywordData = {
5406
5745
  body: {
5407
5746
  /**
5408
- * The word or phrase to track, case-insensitive. A multi-word term matches as the phrase or as its words close together (see matching.exactPhrase); wrap it in double quotes for the exact phrase only.
5747
+ * The word or phrase to track, case-insensitive. Required unless `query` is sent. A multi-word term matches as the phrase or as its words close together (see matching.exactPhrase); wrap it in double quotes for the exact phrase only.
5409
5748
  */
5410
- term: string;
5749
+ term?: string;
5750
+ /**
5751
+ * The keyword as one boolean query instead of term and matching, like "acme cloud" AND (pricing OR price*) -jobs ([Keywords](/guides/keywords#write-it-as-a-query)):
5752
+ *
5753
+ * - Phrases, words, AND, OR, NOT or -word, parentheses, word-end *
5754
+ * - Compiled into term and the term rules; never sent with them (400).
5755
+ * - Each alternative starts with the term; else 400 query_needs_one_term.
5756
+ */
5757
+ query?: string;
5411
5758
  /**
5412
5759
  * brand: your own names. competitor: theirs. topic: the space. Drives share of voice and segments.
5413
5760
  */
@@ -5600,7 +5947,7 @@ type CreateKeywordData = {
5600
5947
  };
5601
5948
  type CreateKeywordErrors = {
5602
5949
  /**
5603
- * Invalid request: a parameter or the body failed validation (validation_error)
5950
+ * Invalid request: a parameter or the body failed validation (validation_error), or the query cannot be read (invalid_query), names more than one term (query_needs_one_term) or cannot be one keyword (query_not_supported)
5604
5951
  */
5605
5952
  400: ErrorResponse;
5606
5953
  /**
@@ -5688,9 +6035,13 @@ type UpdateKeywordData = {
5688
6035
  */
5689
6036
  body: {
5690
6037
  /**
5691
- * Renames the keyword: the new term is tracked from now on, with no look-back, keeping its id, settings and old mentions. Double quotes mean the exact phrase only. 409 when its group already tracks it.
6038
+ * Renames the keyword: the new term is tracked from now on, with no look-back, keeping its id, settings and old mentions. Double quotes mean the exact phrase only. 409 when its group already tracks it. Clears query.
5692
6039
  */
5693
6040
  term?: string;
6041
+ /**
6042
+ * Rewrites the term (a rename) and the term rules from a boolean query; the other matching fields stay. Never with term or those rules (400). A later hand change of either clears it. See [Keywords](/guides/keywords#write-it-as-a-query).
6043
+ */
6044
+ query?: string;
5694
6045
  /**
5695
6046
  * Reclassify it as brand, competitor or topic.
5696
6047
  */
@@ -5886,7 +6237,7 @@ type UpdateKeywordData = {
5886
6237
  };
5887
6238
  type UpdateKeywordErrors = {
5888
6239
  /**
5889
- * Invalid request: a parameter or the body failed validation (validation_error)
6240
+ * Invalid request: a parameter or the body failed validation (validation_error), or the query cannot be read (invalid_query), names more than one term (query_needs_one_term) or cannot be one keyword (query_not_supported)
5890
6241
  */
5891
6242
  400: ErrorResponse;
5892
6243
  /**
@@ -6575,6 +6926,62 @@ type UpdateFiltersResponses = {
6575
6926
  200: WorkspaceFilters;
6576
6927
  };
6577
6928
  type UpdateFiltersResponse = UpdateFiltersResponses[keyof UpdateFiltersResponses];
6929
+ type UpdateMentionsData = {
6930
+ body: {
6931
+ /**
6932
+ * Mention ids (mm_...), 1 to 100: a page of GET /v1/mentions.
6933
+ */
6934
+ ids: Array<string>;
6935
+ /**
6936
+ * Every field is optional, at least one is required; omitted fields are untouched.
6937
+ */
6938
+ update: {
6939
+ /**
6940
+ * ignored or done to handle them; open to put them back.
6941
+ */
6942
+ status?: 'open' | 'ignored' | 'done';
6943
+ /**
6944
+ * A workspace member (user id), or null to unassign.
6945
+ */
6946
+ assigneeId?: string | null;
6947
+ /**
6948
+ * Labels to add; a mention keeps at most 20, and labels past that are not added.
6949
+ */
6950
+ addLabels?: Array<string>;
6951
+ /**
6952
+ * Labels to remove; a label a mention does not carry is ignored.
6953
+ */
6954
+ removeLabels?: Array<string>;
6955
+ };
6956
+ };
6957
+ headers?: {
6958
+ /**
6959
+ * A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
6960
+ */
6961
+ 'idempotency-key'?: string;
6962
+ };
6963
+ path?: never;
6964
+ query?: never;
6965
+ url: '/v1/mentions/batch';
6966
+ };
6967
+ type UpdateMentionsErrors = {
6968
+ /**
6969
+ * Invalid request (an empty update, more than 100 ids), or invalid_assignee: the assignee is not a workspace member
6970
+ */
6971
+ 400: ErrorResponse;
6972
+ /**
6973
+ * Missing or invalid API key
6974
+ */
6975
+ 401: ErrorResponse;
6976
+ };
6977
+ type UpdateMentionsError = UpdateMentionsErrors[keyof UpdateMentionsErrors];
6978
+ type UpdateMentionsResponses = {
6979
+ /**
6980
+ * Which mentions changed, and which ids were not found
6981
+ */
6982
+ 200: MentionBatchResult;
6983
+ };
6984
+ type UpdateMentionsResponse = UpdateMentionsResponses[keyof UpdateMentionsResponses];
6578
6985
  type GetMentionData = {
6579
6986
  body?: never;
6580
6987
  path: {
@@ -6625,6 +7032,10 @@ type UpdateMentionData = {
6625
7032
  * Internal note; null or empty clears it.
6626
7033
  */
6627
7034
  note?: string | null;
7035
+ /**
7036
+ * Replaces the mention's whole list of labels (exact, case-sensitive, at most 20); [] removes every label. To add or remove a few without reading first, use POST /v1/mentions/batch.
7037
+ */
7038
+ labels?: Array<string>;
6628
7039
  /**
6629
7040
  * Your verdict: true sets relevance to 100 (a filtered mention becomes relevant), false to 0; null restores the classifier's score. Billing never changes. 409 classification_pending while it is still being classified.
6630
7041
  */
@@ -6827,6 +7238,14 @@ type SearchMentionsData = {
6827
7238
  * Never these sentiments. A mention the classifier has not scored yet still passes.
6828
7239
  */
6829
7240
  notSentiments?: Array<'positive' | 'neutral' | 'negative'>;
7241
+ /**
7242
+ * Only mentions showing any of these emotions toward the keyword (joy, trust, anticipation, surprise, confusion, frustration, anger, fear, sadness, neutral). A mention whose emotion was not judged never passes.
7243
+ */
7244
+ emotions?: Array<'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral'>;
7245
+ /**
7246
+ * Never these emotions. A mention whose emotion was not judged still passes.
7247
+ */
7248
+ notEmotions?: Array<'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral'>;
6830
7249
  /**
6831
7250
  * Only mentions carrying any of these intent or topic tags.
6832
7251
  */
@@ -6851,6 +7270,14 @@ type SearchMentionsData = {
6851
7270
  * Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
6852
7271
  */
6853
7272
  notTags?: Array<string> | null;
7273
+ /**
7274
+ * Only mentions carrying any of these labels (exact, case-sensitive). Repeatable, or comma-separated.
7275
+ */
7276
+ labels?: Array<string> | null;
7277
+ /**
7278
+ * Never mentions carrying any of these labels. Repeatable, or comma-separated.
7279
+ */
7280
+ notLabels?: Array<string> | null;
6854
7281
  /**
6855
7282
  * Only posts in any of these languages (ISO 639-1: en, es, de). A post whose language is unknown never passes.
6856
7283
  */
@@ -6936,9 +7363,15 @@ type SearchMentionsData = {
6936
7363
  */
6937
7364
  until?: string;
6938
7365
  /**
6939
- * newest: by match time, newest first. priority: by attention score, highest first; priority ranks the last 30 days of matches only, older ones stay reachable under newest. Cursors are specific to a sort.
7366
+ * How to order the list:
7367
+ *
7368
+ * - newest: by match time.
7369
+ * - priority: attention score, last 30 days of matches.
7370
+ * - reach: author followers, unknown last; counts update, so pages can shift.
7371
+ * - engagement: likes, reposts, replies and quotes; none last.
7372
+ * - reach and engagement: the last 30 days unless a window is set.
6940
7373
  */
6941
- sort?: 'newest' | 'priority';
7374
+ sort?: 'newest' | 'priority' | 'reach' | 'engagement';
6942
7375
  /**
6943
7376
  * nextCursor from the previous page; pass the same filters and sort.
6944
7377
  */
@@ -7135,6 +7568,14 @@ type ExportMentionsCsvData = {
7135
7568
  * Never these sentiments. A mention the classifier has not scored yet still passes.
7136
7569
  */
7137
7570
  notSentiments?: Array<'positive' | 'neutral' | 'negative'>;
7571
+ /**
7572
+ * Only mentions showing any of these emotions toward the keyword (joy, trust, anticipation, surprise, confusion, frustration, anger, fear, sadness, neutral). A mention whose emotion was not judged never passes.
7573
+ */
7574
+ emotions?: Array<'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral'>;
7575
+ /**
7576
+ * Never these emotions. A mention whose emotion was not judged still passes.
7577
+ */
7578
+ notEmotions?: Array<'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral'>;
7138
7579
  /**
7139
7580
  * Only mentions carrying any of these intent or topic tags.
7140
7581
  */
@@ -7159,6 +7600,14 @@ type ExportMentionsCsvData = {
7159
7600
  * Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
7160
7601
  */
7161
7602
  notTags?: Array<string> | null;
7603
+ /**
7604
+ * Only mentions carrying any of these labels (exact, case-sensitive). Repeatable, or comma-separated.
7605
+ */
7606
+ labels?: Array<string> | null;
7607
+ /**
7608
+ * Never mentions carrying any of these labels. Repeatable, or comma-separated.
7609
+ */
7610
+ notLabels?: Array<string> | null;
7162
7611
  /**
7163
7612
  * Only posts in any of these languages (ISO 639-1: en, es, de). A post whose language is unknown never passes.
7164
7613
  */
@@ -7477,6 +7926,14 @@ type ExportMentionsJsonData = {
7477
7926
  * Never these sentiments. A mention the classifier has not scored yet still passes.
7478
7927
  */
7479
7928
  notSentiments?: Array<'positive' | 'neutral' | 'negative'>;
7929
+ /**
7930
+ * Only mentions showing any of these emotions toward the keyword (joy, trust, anticipation, surprise, confusion, frustration, anger, fear, sadness, neutral). A mention whose emotion was not judged never passes.
7931
+ */
7932
+ emotions?: Array<'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral'>;
7933
+ /**
7934
+ * Never these emotions. A mention whose emotion was not judged still passes.
7935
+ */
7936
+ notEmotions?: Array<'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral'>;
7480
7937
  /**
7481
7938
  * Only mentions carrying any of these intent or topic tags.
7482
7939
  */
@@ -7501,6 +7958,14 @@ type ExportMentionsJsonData = {
7501
7958
  * Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
7502
7959
  */
7503
7960
  notTags?: Array<string> | null;
7961
+ /**
7962
+ * Only mentions carrying any of these labels (exact, case-sensitive). Repeatable, or comma-separated.
7963
+ */
7964
+ labels?: Array<string> | null;
7965
+ /**
7966
+ * Never mentions carrying any of these labels. Repeatable, or comma-separated.
7967
+ */
7968
+ notLabels?: Array<string> | null;
7504
7969
  /**
7505
7970
  * Only posts in any of these languages (ISO 639-1: en, es, de). A post whose language is unknown never passes.
7506
7971
  */
@@ -8024,6 +8489,10 @@ type ListPeopleResponses = {
8024
8489
  * Followers when last seen; null when unknown.
8025
8490
  */
8026
8491
  followers: number | null;
8492
+ /**
8493
+ * How far their voice carries, 0 to 100 from followers on a log scale: round(20 * log10(followers + 1)), capped at 100 (1,000 followers is 60). Null when followers are unknown.
8494
+ */
8495
+ influence: number | null;
8027
8496
  /**
8028
8497
  * Accounts they follow; null when unknown.
8029
8498
  */
@@ -9019,58 +9488,842 @@ type UpdateSegmentData = {
9019
9488
  */
9020
9489
  notIntents?: Array<string>;
9021
9490
  /**
9022
- * First seen within this many days.
9491
+ * First seen within this many days.
9492
+ */
9493
+ newSinceDays?: number;
9494
+ /**
9495
+ * At least one mention linking to any of these hosts, the host itself or a subdomain of it.
9496
+ */
9497
+ linkHosts?: Array<string>;
9498
+ /**
9499
+ * true: only muted people; false: only unmuted.
9500
+ */
9501
+ muted?: boolean;
9502
+ /**
9503
+ * People at any of these outreach stages.
9504
+ */
9505
+ stages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
9506
+ /**
9507
+ * Nobody at these outreach stages.
9508
+ */
9509
+ notStages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
9510
+ /**
9511
+ * Nobody with a mention linking to any of these hosts, the host itself or a subdomain of it.
9512
+ */
9513
+ notLinkHosts?: Array<string>;
9514
+ /**
9515
+ * Nobody owned by these members (user ids); "none" drops the people nobody owns.
9516
+ */
9517
+ notOwnerIds?: Array<string>;
9518
+ /**
9519
+ * true: only people whose matched posts are mostly machine-made (bot accounts); false: only the rest.
9520
+ */
9521
+ automated?: boolean;
9522
+ /**
9523
+ * People owned by any of these members (user ids); "none" matches people nobody owns.
9524
+ */
9525
+ ownerIds?: Array<string>;
9526
+ };
9527
+ };
9528
+ path: {
9529
+ /**
9530
+ * Segment id (seg_...).
9531
+ */
9532
+ id: string;
9533
+ };
9534
+ query?: {
9535
+ /**
9536
+ * Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, mute, merges, activities and segments. Omit for the whole workspace.
9537
+ */
9538
+ groupId?: string;
9539
+ };
9540
+ url: '/v1/segments/{id}';
9541
+ };
9542
+ type UpdateSegmentErrors = {
9543
+ /**
9544
+ * Invalid request: a parameter or the body failed validation (validation_error)
9545
+ */
9546
+ 400: ErrorResponse;
9547
+ /**
9548
+ * Missing or invalid API key
9549
+ */
9550
+ 401: ErrorResponse;
9551
+ /**
9552
+ * No such segment in this scope, or no such group
9553
+ */
9554
+ 404: ErrorResponse;
9555
+ /**
9556
+ * A segment with this name already exists in this scope
9557
+ */
9558
+ 409: ErrorResponse;
9559
+ };
9560
+ type UpdateSegmentError = UpdateSegmentErrors[keyof UpdateSegmentErrors];
9561
+ type UpdateSegmentResponses = {
9562
+ /**
9563
+ * The updated segment
9564
+ */
9565
+ 200: Segment;
9566
+ };
9567
+ type UpdateSegmentResponse = UpdateSegmentResponses[keyof UpdateSegmentResponses];
9568
+ type ListViewsData = {
9569
+ body?: never;
9570
+ path?: never;
9571
+ query?: never;
9572
+ url: '/v1/views';
9573
+ };
9574
+ type ListViewsErrors = {
9575
+ /**
9576
+ * Missing or invalid API key
9577
+ */
9578
+ 401: ErrorResponse;
9579
+ };
9580
+ type ListViewsError = ListViewsErrors[keyof ListViewsErrors];
9581
+ type ListViewsResponses = {
9582
+ /**
9583
+ * Saved views
9584
+ */
9585
+ 200: {
9586
+ /**
9587
+ * Saved views, oldest first.
9588
+ */
9589
+ data: Array<{
9590
+ /**
9591
+ * View id (vw_...).
9592
+ */
9593
+ id: string;
9594
+ /**
9595
+ * View name.
9596
+ */
9597
+ name: string;
9598
+ /**
9599
+ * What the view is for.
9600
+ */
9601
+ description: string;
9602
+ /**
9603
+ * The mentions filter it saves (the fields of GET /v1/mentions).
9604
+ */
9605
+ filter: {
9606
+ /**
9607
+ * Substring in the post text or the author's name.
9608
+ */
9609
+ q?: string;
9610
+ /**
9611
+ * Only matches of any of these keywords.
9612
+ */
9613
+ keywordIds?: Array<string>;
9614
+ /**
9615
+ * Never matches of these keywords.
9616
+ */
9617
+ notKeywordIds?: Array<string>;
9618
+ /**
9619
+ * Only matches of keywords of any of these kinds: brand, competitor, topic.
9620
+ */
9621
+ keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
9622
+ /**
9623
+ * Never matches of keywords of these kinds.
9624
+ */
9625
+ notKeywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
9626
+ /**
9627
+ * Only matches of keywords in any of these groups (grp_...).
9628
+ */
9629
+ groupIds?: Array<string>;
9630
+ /**
9631
+ * Never matches of keywords in these groups.
9632
+ */
9633
+ notGroupIds?: Array<string>;
9634
+ /**
9635
+ * Only posts from any of these platforms.
9636
+ */
9637
+ platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
9638
+ /**
9639
+ * Never posts from these platforms.
9640
+ */
9641
+ notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
9642
+ /**
9643
+ * Only mentions in this status: open, ignored, done.
9644
+ */
9645
+ status?: 'open' | 'ignored' | 'done';
9646
+ /**
9647
+ * true: only mentions the classifier scored relevant; false: only the rest.
9648
+ */
9649
+ relevant?: boolean;
9650
+ /**
9651
+ * Only mentions scored at least this.
9652
+ */
9653
+ minRelevance?: number;
9654
+ /**
9655
+ * Only mentions whose classifier confidence is at least this.
9656
+ */
9657
+ minConfidence?: number;
9658
+ /**
9659
+ * Only these sentiments.
9660
+ */
9661
+ sentiments?: Array<'positive' | 'neutral' | 'negative'>;
9662
+ /**
9663
+ * Never these sentiments; an unscored mention still passes.
9664
+ */
9665
+ notSentiments?: Array<'positive' | 'neutral' | 'negative'>;
9666
+ /**
9667
+ * Only mentions showing any of these emotions toward the keyword. A mention whose emotion was not judged never passes.
9668
+ */
9669
+ emotions?: Array<'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral'>;
9670
+ /**
9671
+ * Never these emotions; a mention whose emotion was not judged still passes.
9672
+ */
9673
+ notEmotions?: Array<'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral'>;
9674
+ /**
9675
+ * Only mentions carrying any of these intent or topic tags.
9676
+ */
9677
+ intents?: Array<string>;
9678
+ /**
9679
+ * Never mentions carrying these tags.
9680
+ */
9681
+ notIntents?: Array<string>;
9682
+ /**
9683
+ * true: only posts that read as machine-made; false: only the rest.
9684
+ */
9685
+ automated?: boolean;
9686
+ /**
9687
+ * Only posts in any of these languages (ISO 639-1).
9688
+ */
9689
+ languages?: Array<string>;
9690
+ /**
9691
+ * Never posts in these languages; an unknown language still passes.
9692
+ */
9693
+ notLanguages?: Array<string>;
9694
+ /**
9695
+ * Only posts whose author is in any of these countries (ISO 3166-1 alpha-2: us, in, de). An unknown country never passes.
9696
+ */
9697
+ countries?: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
9698
+ /**
9699
+ * Never posts whose author is in these countries; an unknown country still passes.
9700
+ */
9701
+ notCountries?: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
9702
+ /**
9703
+ * true: only posts by companies, brands and organizations; false: only posts by people.
9704
+ */
9705
+ organization?: boolean;
9706
+ /**
9707
+ * Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
9708
+ */
9709
+ tags?: Array<string>;
9710
+ /**
9711
+ * Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
9712
+ */
9713
+ notTags?: Array<string>;
9714
+ /**
9715
+ * Only mentions carrying any of these labels (exact, case-sensitive).
9716
+ */
9717
+ labels?: Array<string>;
9718
+ /**
9719
+ * Never mentions carrying any of these labels.
9720
+ */
9721
+ notLabels?: Array<string>;
9722
+ /**
9723
+ * Only posts linking to any of these hosts, the host itself or a subdomain of it.
9724
+ */
9725
+ linkHosts?: Array<string>;
9726
+ /**
9727
+ * Never posts linking to these hosts.
9728
+ */
9729
+ notLinkHosts?: Array<string>;
9730
+ /**
9731
+ * Only Reddit posts from any of these subreddits (names without the r/, any case); every other post fails it.
9732
+ */
9733
+ subreddits?: Array<string>;
9734
+ /**
9735
+ * Never Reddit posts from these subreddits; posts from other platforms still pass.
9736
+ */
9737
+ notSubreddits?: Array<string>;
9738
+ /**
9739
+ * Only authors with at least this many followers; unknown reach never passes.
9740
+ */
9741
+ minFollowers?: number;
9742
+ /**
9743
+ * Only authors with at most this many followers; unknown reach never passes.
9744
+ */
9745
+ maxFollowers?: number;
9746
+ /**
9747
+ * true: only replies and comments; false: only top-level posts.
9748
+ */
9749
+ isReply?: boolean;
9750
+ /**
9751
+ * Only posts (post), only comments (comment) or only GitHub repository events (repository).
9752
+ */
9753
+ kind?: 'post' | 'comment' | 'repository';
9754
+ /**
9755
+ * Never these authors: display names, handles or profile URLs.
9756
+ */
9757
+ notAuthors?: Array<string>;
9758
+ /**
9759
+ * Deprecated: use notAuthors, the same filter. Both may be given; every author named in either is hidden.
9760
+ */
9761
+ excludeAuthors?: Array<string>;
9762
+ /**
9763
+ * Only app store reviews with any of these star ratings; every other post fails it.
9764
+ */
9765
+ ratings?: Array<number>;
9766
+ /**
9767
+ * Never reviews with these star ratings; posts that are not reviews still pass.
9768
+ */
9769
+ notRatings?: Array<number>;
9770
+ /**
9771
+ * Only posts with at least this many likes (upvotes, reactions), as the platform reported them when the post was found. A post without that count never passes.
9772
+ */
9773
+ minLikes?: number;
9774
+ /**
9775
+ * Only posts with at least this many reposts (shares, retweets), as the platform reported them when the post was found. A post without that count never passes.
9776
+ */
9777
+ minReposts?: number;
9778
+ /**
9779
+ * Only posts with at least this many replies (comments), as the platform reported them when the post was found. A post without that count never passes.
9780
+ */
9781
+ minReplies?: number;
9782
+ /**
9783
+ * Only posts with at least this many quotes, as the platform reported them when the post was found. A post without that count never passes.
9784
+ */
9785
+ minQuotes?: number;
9786
+ /**
9787
+ * Only posts with at least this many views (plays), as the platform reported them when the post was found. A post without that count never passes.
9788
+ */
9789
+ minViews?: number;
9790
+ /**
9791
+ * Only posts with at least this many bookmarks (saves), as the platform reported them when the post was found. A post without that count never passes.
9792
+ */
9793
+ minBookmarks?: number;
9794
+ /**
9795
+ * OR across groups: a mention passes when it meets every condition of at least one group, and the other conditions too. A group takes view-filter conditions, no anyOf of its own. See [anyOf](/conventions#or-across-groups-anyof).
9796
+ */
9797
+ anyOf?: Array<FilterGroup>;
9798
+ };
9799
+ /**
9800
+ * ISO 8601 timestamp, UTC.
9801
+ */
9802
+ createdAt: string;
9803
+ /**
9804
+ * ISO 8601 timestamp, UTC.
9805
+ */
9806
+ updatedAt: string;
9807
+ }>;
9808
+ };
9809
+ };
9810
+ type ListViewsResponse = ListViewsResponses[keyof ListViewsResponses];
9811
+ type CreateViewData = {
9812
+ body: {
9813
+ /**
9814
+ * Unique per workspace, case-insensitive.
9815
+ */
9816
+ name: string;
9817
+ /**
9818
+ * What the view is for, shown under its name.
9819
+ */
9820
+ description?: string;
9821
+ /**
9822
+ * The filter; empty selects every mention.
9823
+ */
9824
+ filter?: {
9825
+ /**
9826
+ * Substring in the post text or the author's name.
9827
+ */
9828
+ q?: string;
9829
+ /**
9830
+ * Only matches of any of these keywords.
9831
+ */
9832
+ keywordIds?: Array<string>;
9833
+ /**
9834
+ * Never matches of these keywords.
9835
+ */
9836
+ notKeywordIds?: Array<string>;
9837
+ /**
9838
+ * Only matches of keywords of any of these kinds: brand, competitor, topic.
9839
+ */
9840
+ keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
9841
+ /**
9842
+ * Never matches of keywords of these kinds.
9843
+ */
9844
+ notKeywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
9845
+ /**
9846
+ * Only matches of keywords in any of these groups (grp_...).
9847
+ */
9848
+ groupIds?: Array<string>;
9849
+ /**
9850
+ * Never matches of keywords in these groups.
9851
+ */
9852
+ notGroupIds?: Array<string>;
9853
+ /**
9854
+ * Only posts from any of these platforms.
9855
+ */
9856
+ platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
9857
+ /**
9858
+ * Never posts from these platforms.
9859
+ */
9860
+ notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
9861
+ /**
9862
+ * Only mentions in this status: open, ignored, done.
9863
+ */
9864
+ status?: 'open' | 'ignored' | 'done';
9865
+ /**
9866
+ * true: only mentions the classifier scored relevant; false: only the rest.
9867
+ */
9868
+ relevant?: boolean;
9869
+ /**
9870
+ * Only mentions scored at least this.
9871
+ */
9872
+ minRelevance?: number;
9873
+ /**
9874
+ * Only mentions whose classifier confidence is at least this.
9875
+ */
9876
+ minConfidence?: number;
9877
+ /**
9878
+ * Only these sentiments.
9879
+ */
9880
+ sentiments?: Array<'positive' | 'neutral' | 'negative'>;
9881
+ /**
9882
+ * Never these sentiments; an unscored mention still passes.
9883
+ */
9884
+ notSentiments?: Array<'positive' | 'neutral' | 'negative'>;
9885
+ /**
9886
+ * Only mentions showing any of these emotions toward the keyword. A mention whose emotion was not judged never passes.
9887
+ */
9888
+ emotions?: Array<'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral'>;
9889
+ /**
9890
+ * Never these emotions; a mention whose emotion was not judged still passes.
9891
+ */
9892
+ notEmotions?: Array<'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral'>;
9893
+ /**
9894
+ * Only mentions carrying any of these intent or topic tags.
9895
+ */
9896
+ intents?: Array<string>;
9897
+ /**
9898
+ * Never mentions carrying these tags.
9899
+ */
9900
+ notIntents?: Array<string>;
9901
+ /**
9902
+ * true: only posts that read as machine-made; false: only the rest.
9903
+ */
9904
+ automated?: boolean;
9905
+ /**
9906
+ * Only posts in any of these languages (ISO 639-1).
9907
+ */
9908
+ languages?: Array<string>;
9909
+ /**
9910
+ * Never posts in these languages; an unknown language still passes.
9911
+ */
9912
+ notLanguages?: Array<string>;
9913
+ /**
9914
+ * Only posts whose author is in any of these countries (ISO 3166-1 alpha-2: us, in, de). An unknown country never passes.
9915
+ */
9916
+ countries?: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
9917
+ /**
9918
+ * Never posts whose author is in these countries; an unknown country still passes.
9919
+ */
9920
+ notCountries?: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
9921
+ /**
9922
+ * true: only posts by companies, brands and organizations; false: only posts by people.
9923
+ */
9924
+ organization?: boolean;
9925
+ /**
9926
+ * Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
9927
+ */
9928
+ tags?: Array<string>;
9929
+ /**
9930
+ * Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
9931
+ */
9932
+ notTags?: Array<string>;
9933
+ /**
9934
+ * Only mentions carrying any of these labels (exact, case-sensitive).
9935
+ */
9936
+ labels?: Array<string>;
9937
+ /**
9938
+ * Never mentions carrying any of these labels.
9939
+ */
9940
+ notLabels?: Array<string>;
9941
+ /**
9942
+ * Only posts linking to any of these hosts, the host itself or a subdomain of it.
9943
+ */
9944
+ linkHosts?: Array<string>;
9945
+ /**
9946
+ * Never posts linking to these hosts.
9947
+ */
9948
+ notLinkHosts?: Array<string>;
9949
+ /**
9950
+ * Only Reddit posts from any of these subreddits (names without the r/, any case); every other post fails it.
9951
+ */
9952
+ subreddits?: Array<string>;
9953
+ /**
9954
+ * Never Reddit posts from these subreddits; posts from other platforms still pass.
9955
+ */
9956
+ notSubreddits?: Array<string>;
9957
+ /**
9958
+ * Only authors with at least this many followers; unknown reach never passes.
9959
+ */
9960
+ minFollowers?: number;
9961
+ /**
9962
+ * Only authors with at most this many followers; unknown reach never passes.
9963
+ */
9964
+ maxFollowers?: number;
9965
+ /**
9966
+ * true: only replies and comments; false: only top-level posts.
9967
+ */
9968
+ isReply?: boolean;
9969
+ /**
9970
+ * Only posts (post), only comments (comment) or only GitHub repository events (repository).
9971
+ */
9972
+ kind?: 'post' | 'comment' | 'repository';
9973
+ /**
9974
+ * Never these authors: display names, handles or profile URLs.
9975
+ */
9976
+ notAuthors?: Array<string>;
9977
+ /**
9978
+ * Deprecated: use notAuthors, the same filter. Both may be given; every author named in either is hidden.
9979
+ */
9980
+ excludeAuthors?: Array<string>;
9981
+ /**
9982
+ * Only app store reviews with any of these star ratings; every other post fails it.
9983
+ */
9984
+ ratings?: Array<number>;
9985
+ /**
9986
+ * Never reviews with these star ratings; posts that are not reviews still pass.
9987
+ */
9988
+ notRatings?: Array<number>;
9989
+ /**
9990
+ * Only posts with at least this many likes (upvotes, reactions), as the platform reported them when the post was found. A post without that count never passes.
9991
+ */
9992
+ minLikes?: number;
9993
+ /**
9994
+ * Only posts with at least this many reposts (shares, retweets), as the platform reported them when the post was found. A post without that count never passes.
9995
+ */
9996
+ minReposts?: number;
9997
+ /**
9998
+ * Only posts with at least this many replies (comments), as the platform reported them when the post was found. A post without that count never passes.
9999
+ */
10000
+ minReplies?: number;
10001
+ /**
10002
+ * Only posts with at least this many quotes, as the platform reported them when the post was found. A post without that count never passes.
10003
+ */
10004
+ minQuotes?: number;
10005
+ /**
10006
+ * Only posts with at least this many views (plays), as the platform reported them when the post was found. A post without that count never passes.
10007
+ */
10008
+ minViews?: number;
10009
+ /**
10010
+ * Only posts with at least this many bookmarks (saves), as the platform reported them when the post was found. A post without that count never passes.
10011
+ */
10012
+ minBookmarks?: number;
10013
+ /**
10014
+ * OR across groups: a mention passes when it meets every condition of at least one group, and the other conditions too. A group takes view-filter conditions, no anyOf of its own. See [anyOf](/conventions#or-across-groups-anyof).
10015
+ */
10016
+ anyOf?: Array<FilterGroup>;
10017
+ };
10018
+ };
10019
+ headers?: {
10020
+ /**
10021
+ * A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
10022
+ */
10023
+ 'idempotency-key'?: string;
10024
+ };
10025
+ path?: never;
10026
+ query?: never;
10027
+ url: '/v1/views';
10028
+ };
10029
+ type CreateViewErrors = {
10030
+ /**
10031
+ * Invalid filter (an empty anyOf group, for one), or filter_too_complex: more values than one query can carry
10032
+ */
10033
+ 400: ErrorResponse;
10034
+ /**
10035
+ * Missing or invalid API key
10036
+ */
10037
+ 401: ErrorResponse;
10038
+ /**
10039
+ * A view with that name already exists (duplicate_view)
10040
+ */
10041
+ 409: ErrorResponse;
10042
+ };
10043
+ type CreateViewError = CreateViewErrors[keyof CreateViewErrors];
10044
+ type CreateViewResponses = {
10045
+ /**
10046
+ * The saved view
10047
+ */
10048
+ 201: View;
10049
+ };
10050
+ type CreateViewResponse = CreateViewResponses[keyof CreateViewResponses];
10051
+ type DeleteViewData = {
10052
+ body?: never;
10053
+ path: {
10054
+ /**
10055
+ * View id (vw_...).
10056
+ */
10057
+ id: string;
10058
+ };
10059
+ query?: never;
10060
+ url: '/v1/views/{id}';
10061
+ };
10062
+ type DeleteViewErrors = {
10063
+ /**
10064
+ * Missing or invalid API key
10065
+ */
10066
+ 401: ErrorResponse;
10067
+ /**
10068
+ * No such view in this workspace
10069
+ */
10070
+ 404: ErrorResponse;
10071
+ };
10072
+ type DeleteViewError = DeleteViewErrors[keyof DeleteViewErrors];
10073
+ type DeleteViewResponses = {
10074
+ /**
10075
+ * Deleted
10076
+ */
10077
+ 204: void;
10078
+ };
10079
+ type DeleteViewResponse = DeleteViewResponses[keyof DeleteViewResponses];
10080
+ type GetViewData = {
10081
+ body?: never;
10082
+ path: {
10083
+ /**
10084
+ * View id (vw_...).
10085
+ */
10086
+ id: string;
10087
+ };
10088
+ query?: never;
10089
+ url: '/v1/views/{id}';
10090
+ };
10091
+ type GetViewErrors = {
10092
+ /**
10093
+ * Missing or invalid API key
10094
+ */
10095
+ 401: ErrorResponse;
10096
+ /**
10097
+ * No such view in this workspace
10098
+ */
10099
+ 404: ErrorResponse;
10100
+ };
10101
+ type GetViewError = GetViewErrors[keyof GetViewErrors];
10102
+ type GetViewResponses = {
10103
+ /**
10104
+ * The view
10105
+ */
10106
+ 200: View;
10107
+ };
10108
+ type GetViewResponse = GetViewResponses[keyof GetViewResponses];
10109
+ type UpdateViewData = {
10110
+ body: {
10111
+ /**
10112
+ * View name, unique in the workspace.
10113
+ */
10114
+ name?: string;
10115
+ /**
10116
+ * What the view is for.
10117
+ */
10118
+ description?: string;
10119
+ /**
10120
+ * Replaces the whole filter.
10121
+ */
10122
+ filter?: {
10123
+ /**
10124
+ * Substring in the post text or the author's name.
10125
+ */
10126
+ q?: string;
10127
+ /**
10128
+ * Only matches of any of these keywords.
10129
+ */
10130
+ keywordIds?: Array<string>;
10131
+ /**
10132
+ * Never matches of these keywords.
10133
+ */
10134
+ notKeywordIds?: Array<string>;
10135
+ /**
10136
+ * Only matches of keywords of any of these kinds: brand, competitor, topic.
10137
+ */
10138
+ keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
10139
+ /**
10140
+ * Never matches of keywords of these kinds.
10141
+ */
10142
+ notKeywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
10143
+ /**
10144
+ * Only matches of keywords in any of these groups (grp_...).
10145
+ */
10146
+ groupIds?: Array<string>;
10147
+ /**
10148
+ * Never matches of keywords in these groups.
10149
+ */
10150
+ notGroupIds?: Array<string>;
10151
+ /**
10152
+ * Only posts from any of these platforms.
10153
+ */
10154
+ platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
10155
+ /**
10156
+ * Never posts from these platforms.
10157
+ */
10158
+ notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
10159
+ /**
10160
+ * Only mentions in this status: open, ignored, done.
10161
+ */
10162
+ status?: 'open' | 'ignored' | 'done';
10163
+ /**
10164
+ * true: only mentions the classifier scored relevant; false: only the rest.
10165
+ */
10166
+ relevant?: boolean;
10167
+ /**
10168
+ * Only mentions scored at least this.
10169
+ */
10170
+ minRelevance?: number;
10171
+ /**
10172
+ * Only mentions whose classifier confidence is at least this.
10173
+ */
10174
+ minConfidence?: number;
10175
+ /**
10176
+ * Only these sentiments.
10177
+ */
10178
+ sentiments?: Array<'positive' | 'neutral' | 'negative'>;
10179
+ /**
10180
+ * Never these sentiments; an unscored mention still passes.
10181
+ */
10182
+ notSentiments?: Array<'positive' | 'neutral' | 'negative'>;
10183
+ /**
10184
+ * Only mentions showing any of these emotions toward the keyword. A mention whose emotion was not judged never passes.
10185
+ */
10186
+ emotions?: Array<'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral'>;
10187
+ /**
10188
+ * Never these emotions; a mention whose emotion was not judged still passes.
10189
+ */
10190
+ notEmotions?: Array<'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral'>;
10191
+ /**
10192
+ * Only mentions carrying any of these intent or topic tags.
10193
+ */
10194
+ intents?: Array<string>;
10195
+ /**
10196
+ * Never mentions carrying these tags.
10197
+ */
10198
+ notIntents?: Array<string>;
10199
+ /**
10200
+ * true: only posts that read as machine-made; false: only the rest.
10201
+ */
10202
+ automated?: boolean;
10203
+ /**
10204
+ * Only posts in any of these languages (ISO 639-1).
10205
+ */
10206
+ languages?: Array<string>;
10207
+ /**
10208
+ * Never posts in these languages; an unknown language still passes.
10209
+ */
10210
+ notLanguages?: Array<string>;
10211
+ /**
10212
+ * Only posts whose author is in any of these countries (ISO 3166-1 alpha-2: us, in, de). An unknown country never passes.
10213
+ */
10214
+ countries?: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
10215
+ /**
10216
+ * Never posts whose author is in these countries; an unknown country still passes.
10217
+ */
10218
+ notCountries?: Array<'us' | 'ca' | 'mx' | 'br' | 'ar' | 'co' | 'cl' | 'pe' | 'gb' | 'ie' | 'fr' | 'de' | 'es' | 'pt' | 'it' | 'nl' | 'be' | 'ch' | 'at' | 'se' | 'no' | 'dk' | 'fi' | 'pl' | 'cz' | 'ro' | 'gr' | 'hu' | 'ua' | 'ru' | 'lt' | 'lv' | 'ee' | 'tr' | 'il' | 'ae' | 'sa' | 'eg' | 'ng' | 'ke' | 'za' | 'ma' | 'in' | 'pk' | 'bd' | 'lk' | 'np' | 'cn' | 'hk' | 'tw' | 'jp' | 'kr' | 'sg' | 'my' | 'id' | 'ph' | 'vn' | 'th' | 'au' | 'nz'>;
10219
+ /**
10220
+ * true: only posts by companies, brands and organizations; false: only posts by people.
10221
+ */
10222
+ organization?: boolean;
10223
+ /**
10224
+ * Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
10225
+ */
10226
+ tags?: Array<string>;
10227
+ /**
10228
+ * Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
10229
+ */
10230
+ notTags?: Array<string>;
10231
+ /**
10232
+ * Only mentions carrying any of these labels (exact, case-sensitive).
10233
+ */
10234
+ labels?: Array<string>;
10235
+ /**
10236
+ * Never mentions carrying any of these labels.
10237
+ */
10238
+ notLabels?: Array<string>;
10239
+ /**
10240
+ * Only posts linking to any of these hosts, the host itself or a subdomain of it.
10241
+ */
10242
+ linkHosts?: Array<string>;
10243
+ /**
10244
+ * Never posts linking to these hosts.
10245
+ */
10246
+ notLinkHosts?: Array<string>;
10247
+ /**
10248
+ * Only Reddit posts from any of these subreddits (names without the r/, any case); every other post fails it.
10249
+ */
10250
+ subreddits?: Array<string>;
10251
+ /**
10252
+ * Never Reddit posts from these subreddits; posts from other platforms still pass.
10253
+ */
10254
+ notSubreddits?: Array<string>;
10255
+ /**
10256
+ * Only authors with at least this many followers; unknown reach never passes.
10257
+ */
10258
+ minFollowers?: number;
10259
+ /**
10260
+ * Only authors with at most this many followers; unknown reach never passes.
10261
+ */
10262
+ maxFollowers?: number;
10263
+ /**
10264
+ * true: only replies and comments; false: only top-level posts.
10265
+ */
10266
+ isReply?: boolean;
10267
+ /**
10268
+ * Only posts (post), only comments (comment) or only GitHub repository events (repository).
10269
+ */
10270
+ kind?: 'post' | 'comment' | 'repository';
10271
+ /**
10272
+ * Never these authors: display names, handles or profile URLs.
10273
+ */
10274
+ notAuthors?: Array<string>;
10275
+ /**
10276
+ * Deprecated: use notAuthors, the same filter. Both may be given; every author named in either is hidden.
10277
+ */
10278
+ excludeAuthors?: Array<string>;
10279
+ /**
10280
+ * Only app store reviews with any of these star ratings; every other post fails it.
9023
10281
  */
9024
- newSinceDays?: number;
10282
+ ratings?: Array<number>;
9025
10283
  /**
9026
- * At least one mention linking to any of these hosts, the host itself or a subdomain of it.
10284
+ * Never reviews with these star ratings; posts that are not reviews still pass.
9027
10285
  */
9028
- linkHosts?: Array<string>;
10286
+ notRatings?: Array<number>;
9029
10287
  /**
9030
- * true: only muted people; false: only unmuted.
10288
+ * Only posts with at least this many likes (upvotes, reactions), as the platform reported them when the post was found. A post without that count never passes.
9031
10289
  */
9032
- muted?: boolean;
10290
+ minLikes?: number;
9033
10291
  /**
9034
- * People at any of these outreach stages.
10292
+ * Only posts with at least this many reposts (shares, retweets), as the platform reported them when the post was found. A post without that count never passes.
9035
10293
  */
9036
- stages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
10294
+ minReposts?: number;
9037
10295
  /**
9038
- * Nobody at these outreach stages.
10296
+ * Only posts with at least this many replies (comments), as the platform reported them when the post was found. A post without that count never passes.
9039
10297
  */
9040
- notStages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
10298
+ minReplies?: number;
9041
10299
  /**
9042
- * Nobody with a mention linking to any of these hosts, the host itself or a subdomain of it.
10300
+ * Only posts with at least this many quotes, as the platform reported them when the post was found. A post without that count never passes.
9043
10301
  */
9044
- notLinkHosts?: Array<string>;
10302
+ minQuotes?: number;
9045
10303
  /**
9046
- * Nobody owned by these members (user ids); "none" drops the people nobody owns.
10304
+ * Only posts with at least this many views (plays), as the platform reported them when the post was found. A post without that count never passes.
9047
10305
  */
9048
- notOwnerIds?: Array<string>;
10306
+ minViews?: number;
9049
10307
  /**
9050
- * true: only people whose matched posts are mostly machine-made (bot accounts); false: only the rest.
10308
+ * Only posts with at least this many bookmarks (saves), as the platform reported them when the post was found. A post without that count never passes.
9051
10309
  */
9052
- automated?: boolean;
10310
+ minBookmarks?: number;
9053
10311
  /**
9054
- * People owned by any of these members (user ids); "none" matches people nobody owns.
10312
+ * OR across groups: a mention passes when it meets every condition of at least one group, and the other conditions too. A group takes view-filter conditions, no anyOf of its own. See [anyOf](/conventions#or-across-groups-anyof).
9055
10313
  */
9056
- ownerIds?: Array<string>;
10314
+ anyOf?: Array<FilterGroup>;
9057
10315
  };
9058
10316
  };
9059
10317
  path: {
9060
10318
  /**
9061
- * Segment id (seg_...).
10319
+ * View id (vw_...).
9062
10320
  */
9063
10321
  id: string;
9064
10322
  };
9065
- query?: {
9066
- /**
9067
- * Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, mute, merges, activities and segments. Omit for the whole workspace.
9068
- */
9069
- groupId?: string;
9070
- };
9071
- url: '/v1/segments/{id}';
10323
+ query?: never;
10324
+ url: '/v1/views/{id}';
9072
10325
  };
9073
- type UpdateSegmentErrors = {
10326
+ type UpdateViewErrors = {
9074
10327
  /**
9075
10328
  * Invalid request: a parameter or the body failed validation (validation_error)
9076
10329
  */
@@ -9080,58 +10333,58 @@ type UpdateSegmentErrors = {
9080
10333
  */
9081
10334
  401: ErrorResponse;
9082
10335
  /**
9083
- * No such segment in this scope, or no such group
10336
+ * No such view in this workspace
9084
10337
  */
9085
10338
  404: ErrorResponse;
9086
10339
  /**
9087
- * A segment with this name already exists in this scope
10340
+ * A view with that name already exists (duplicate_view)
9088
10341
  */
9089
10342
  409: ErrorResponse;
9090
10343
  };
9091
- type UpdateSegmentError = UpdateSegmentErrors[keyof UpdateSegmentErrors];
9092
- type UpdateSegmentResponses = {
10344
+ type UpdateViewError = UpdateViewErrors[keyof UpdateViewErrors];
10345
+ type UpdateViewResponses = {
9093
10346
  /**
9094
- * The updated segment
10347
+ * The updated view
9095
10348
  */
9096
- 200: Segment;
10349
+ 200: View;
9097
10350
  };
9098
- type UpdateSegmentResponse = UpdateSegmentResponses[keyof UpdateSegmentResponses];
9099
- type ListViewsData = {
10351
+ type UpdateViewResponse = UpdateViewResponses[keyof UpdateViewResponses];
10352
+ type ListAutomationsData = {
9100
10353
  body?: never;
9101
10354
  path?: never;
9102
10355
  query?: never;
9103
- url: '/v1/views';
10356
+ url: '/v1/automations';
9104
10357
  };
9105
- type ListViewsErrors = {
10358
+ type ListAutomationsErrors = {
9106
10359
  /**
9107
10360
  * Missing or invalid API key
9108
10361
  */
9109
10362
  401: ErrorResponse;
9110
10363
  };
9111
- type ListViewsError = ListViewsErrors[keyof ListViewsErrors];
9112
- type ListViewsResponses = {
10364
+ type ListAutomationsError = ListAutomationsErrors[keyof ListAutomationsErrors];
10365
+ type ListAutomationsResponses = {
9113
10366
  /**
9114
- * Saved views
10367
+ * Automations
9115
10368
  */
9116
10369
  200: {
9117
10370
  /**
9118
- * Saved views, oldest first.
10371
+ * Automations in the order they run, oldest first.
9119
10372
  */
9120
10373
  data: Array<{
9121
10374
  /**
9122
- * View id (vw_...).
10375
+ * Automation id (atm_...).
9123
10376
  */
9124
10377
  id: string;
9125
10378
  /**
9126
- * View name.
10379
+ * Automation name, unique in the workspace.
9127
10380
  */
9128
10381
  name: string;
9129
10382
  /**
9130
- * What the view is for.
10383
+ * false: kept but not run.
9131
10384
  */
9132
- description: string;
10385
+ enabled: boolean;
9133
10386
  /**
9134
- * The mentions filter it saves (the fields of GET /v1/mentions).
10387
+ * Which mentions it acts on: the fields of GET /v1/mentions, like a view.
9135
10388
  */
9136
10389
  filter: {
9137
10390
  /**
@@ -9194,6 +10447,14 @@ type ListViewsResponses = {
9194
10447
  * Never these sentiments; an unscored mention still passes.
9195
10448
  */
9196
10449
  notSentiments?: Array<'positive' | 'neutral' | 'negative'>;
10450
+ /**
10451
+ * Only mentions showing any of these emotions toward the keyword. A mention whose emotion was not judged never passes.
10452
+ */
10453
+ emotions?: Array<'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral'>;
10454
+ /**
10455
+ * Never these emotions; a mention whose emotion was not judged still passes.
10456
+ */
10457
+ notEmotions?: Array<'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral'>;
9197
10458
  /**
9198
10459
  * Only mentions carrying any of these intent or topic tags.
9199
10460
  */
@@ -9234,6 +10495,14 @@ type ListViewsResponses = {
9234
10495
  * Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
9235
10496
  */
9236
10497
  notTags?: Array<string>;
10498
+ /**
10499
+ * Only mentions carrying any of these labels (exact, case-sensitive).
10500
+ */
10501
+ labels?: Array<string>;
10502
+ /**
10503
+ * Never mentions carrying any of these labels.
10504
+ */
10505
+ notLabels?: Array<string>;
9237
10506
  /**
9238
10507
  * Only posts linking to any of these hosts, the host itself or a subdomain of it.
9239
10508
  */
@@ -9311,6 +10580,19 @@ type ListViewsResponses = {
9311
10580
  */
9312
10581
  anyOf?: Array<FilterGroup>;
9313
10582
  };
10583
+ /**
10584
+ * What it does to each mention the filter selects.
10585
+ */
10586
+ actions: {
10587
+ /**
10588
+ * Labels it adds.
10589
+ */
10590
+ addLabels: Array<string>;
10591
+ /**
10592
+ * The member it assigns, or null.
10593
+ */
10594
+ assigneeId: string | null;
10595
+ };
9314
10596
  /**
9315
10597
  * ISO 8601 timestamp, UTC.
9316
10598
  */
@@ -9322,19 +10604,19 @@ type ListViewsResponses = {
9322
10604
  }>;
9323
10605
  };
9324
10606
  };
9325
- type ListViewsResponse = ListViewsResponses[keyof ListViewsResponses];
9326
- type CreateViewData = {
10607
+ type ListAutomationsResponse = ListAutomationsResponses[keyof ListAutomationsResponses];
10608
+ type CreateAutomationData = {
9327
10609
  body: {
9328
10610
  /**
9329
10611
  * Unique per workspace, case-insensitive.
9330
10612
  */
9331
10613
  name: string;
9332
10614
  /**
9333
- * What the view is for, shown under its name.
10615
+ * false saves it without running it.
9334
10616
  */
9335
- description?: string;
10617
+ enabled?: boolean;
9336
10618
  /**
9337
- * The filter; empty selects every mention.
10619
+ * Which new mentions it acts on; empty acts on every one.
9338
10620
  */
9339
10621
  filter?: {
9340
10622
  /**
@@ -9397,6 +10679,14 @@ type CreateViewData = {
9397
10679
  * Never these sentiments; an unscored mention still passes.
9398
10680
  */
9399
10681
  notSentiments?: Array<'positive' | 'neutral' | 'negative'>;
10682
+ /**
10683
+ * Only mentions showing any of these emotions toward the keyword. A mention whose emotion was not judged never passes.
10684
+ */
10685
+ emotions?: Array<'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral'>;
10686
+ /**
10687
+ * Never these emotions; a mention whose emotion was not judged still passes.
10688
+ */
10689
+ notEmotions?: Array<'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral'>;
9400
10690
  /**
9401
10691
  * Only mentions carrying any of these intent or topic tags.
9402
10692
  */
@@ -9437,6 +10727,14 @@ type CreateViewData = {
9437
10727
  * Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
9438
10728
  */
9439
10729
  notTags?: Array<string>;
10730
+ /**
10731
+ * Only mentions carrying any of these labels (exact, case-sensitive).
10732
+ */
10733
+ labels?: Array<string>;
10734
+ /**
10735
+ * Never mentions carrying any of these labels.
10736
+ */
10737
+ notLabels?: Array<string>;
9440
10738
  /**
9441
10739
  * Only posts linking to any of these hosts, the host itself or a subdomain of it.
9442
10740
  */
@@ -9514,6 +10812,19 @@ type CreateViewData = {
9514
10812
  */
9515
10813
  anyOf?: Array<FilterGroup>;
9516
10814
  };
10815
+ /**
10816
+ * What to do to each mention the filter selects; at least one action.
10817
+ */
10818
+ actions: {
10819
+ /**
10820
+ * Labels to add, at most 10. A mention keeps at most 20 labels.
10821
+ */
10822
+ addLabels?: Array<string>;
10823
+ /**
10824
+ * A workspace member (user id) to assign when the mention has nobody yet; someone already assigned is kept.
10825
+ */
10826
+ assigneeId?: string | null;
10827
+ };
9517
10828
  };
9518
10829
  headers?: {
9519
10830
  /**
@@ -9523,11 +10834,11 @@ type CreateViewData = {
9523
10834
  };
9524
10835
  path?: never;
9525
10836
  query?: never;
9526
- url: '/v1/views';
10837
+ url: '/v1/automations';
9527
10838
  };
9528
- type CreateViewErrors = {
10839
+ type CreateAutomationErrors = {
9529
10840
  /**
9530
- * Invalid filter (an empty anyOf group, for one), or filter_too_complex: more values than one query can carry
10841
+ * Invalid request (no action, a filter_too_complex filter), or invalid_assignee: the assignee is not a workspace member
9531
10842
  */
9532
10843
  400: ErrorResponse;
9533
10844
  /**
@@ -9535,86 +10846,86 @@ type CreateViewErrors = {
9535
10846
  */
9536
10847
  401: ErrorResponse;
9537
10848
  /**
9538
- * A view with that name already exists (duplicate_view)
10849
+ * duplicate_automation: the name is taken; automation_limit_reached: the workspace holds 25
9539
10850
  */
9540
10851
  409: ErrorResponse;
9541
10852
  };
9542
- type CreateViewError = CreateViewErrors[keyof CreateViewErrors];
9543
- type CreateViewResponses = {
10853
+ type CreateAutomationError = CreateAutomationErrors[keyof CreateAutomationErrors];
10854
+ type CreateAutomationResponses = {
9544
10855
  /**
9545
- * The saved view
10856
+ * The automation
9546
10857
  */
9547
- 201: View;
10858
+ 201: Automation;
9548
10859
  };
9549
- type CreateViewResponse = CreateViewResponses[keyof CreateViewResponses];
9550
- type DeleteViewData = {
10860
+ type CreateAutomationResponse = CreateAutomationResponses[keyof CreateAutomationResponses];
10861
+ type DeleteAutomationData = {
9551
10862
  body?: never;
9552
10863
  path: {
9553
10864
  /**
9554
- * View id (vw_...).
10865
+ * Automation id (atm_...).
9555
10866
  */
9556
10867
  id: string;
9557
10868
  };
9558
10869
  query?: never;
9559
- url: '/v1/views/{id}';
10870
+ url: '/v1/automations/{id}';
9560
10871
  };
9561
- type DeleteViewErrors = {
10872
+ type DeleteAutomationErrors = {
9562
10873
  /**
9563
10874
  * Missing or invalid API key
9564
10875
  */
9565
10876
  401: ErrorResponse;
9566
10877
  /**
9567
- * No such view in this workspace
10878
+ * No such automation in this workspace
9568
10879
  */
9569
10880
  404: ErrorResponse;
9570
10881
  };
9571
- type DeleteViewError = DeleteViewErrors[keyof DeleteViewErrors];
9572
- type DeleteViewResponses = {
10882
+ type DeleteAutomationError = DeleteAutomationErrors[keyof DeleteAutomationErrors];
10883
+ type DeleteAutomationResponses = {
9573
10884
  /**
9574
10885
  * Deleted
9575
10886
  */
9576
10887
  204: void;
9577
10888
  };
9578
- type DeleteViewResponse = DeleteViewResponses[keyof DeleteViewResponses];
9579
- type GetViewData = {
10889
+ type DeleteAutomationResponse = DeleteAutomationResponses[keyof DeleteAutomationResponses];
10890
+ type GetAutomationData = {
9580
10891
  body?: never;
9581
10892
  path: {
9582
10893
  /**
9583
- * View id (vw_...).
10894
+ * Automation id (atm_...).
9584
10895
  */
9585
10896
  id: string;
9586
10897
  };
9587
10898
  query?: never;
9588
- url: '/v1/views/{id}';
10899
+ url: '/v1/automations/{id}';
9589
10900
  };
9590
- type GetViewErrors = {
10901
+ type GetAutomationErrors = {
9591
10902
  /**
9592
10903
  * Missing or invalid API key
9593
10904
  */
9594
10905
  401: ErrorResponse;
9595
10906
  /**
9596
- * No such view in this workspace
10907
+ * No such automation in this workspace
9597
10908
  */
9598
10909
  404: ErrorResponse;
9599
10910
  };
9600
- type GetViewError = GetViewErrors[keyof GetViewErrors];
9601
- type GetViewResponses = {
10911
+ type GetAutomationError = GetAutomationErrors[keyof GetAutomationErrors];
10912
+ type GetAutomationResponses = {
9602
10913
  /**
9603
- * The view
10914
+ * The automation
9604
10915
  */
9605
- 200: View;
10916
+ 200: Automation;
9606
10917
  };
9607
- type GetViewResponse = GetViewResponses[keyof GetViewResponses];
9608
- type UpdateViewData = {
10918
+ type GetAutomationResponse = GetAutomationResponses[keyof GetAutomationResponses];
10919
+ type UpdateAutomationData = {
9609
10920
  body: {
9610
10921
  /**
9611
- * View name, unique in the workspace.
10922
+ * Automation name, unique in the workspace.
9612
10923
  */
9613
10924
  name?: string;
9614
10925
  /**
9615
- * What the view is for.
10926
+ * false stops it; true runs it again on new mentions.
9616
10927
  */
9617
- description?: string;
10928
+ enabled?: boolean;
9618
10929
  /**
9619
10930
  * Replaces the whole filter.
9620
10931
  */
@@ -9679,6 +10990,14 @@ type UpdateViewData = {
9679
10990
  * Never these sentiments; an unscored mention still passes.
9680
10991
  */
9681
10992
  notSentiments?: Array<'positive' | 'neutral' | 'negative'>;
10993
+ /**
10994
+ * Only mentions showing any of these emotions toward the keyword. A mention whose emotion was not judged never passes.
10995
+ */
10996
+ emotions?: Array<'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral'>;
10997
+ /**
10998
+ * Never these emotions; a mention whose emotion was not judged still passes.
10999
+ */
11000
+ notEmotions?: Array<'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral'>;
9682
11001
  /**
9683
11002
  * Only mentions carrying any of these intent or topic tags.
9684
11003
  */
@@ -9719,6 +11038,14 @@ type UpdateViewData = {
9719
11038
  * Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
9720
11039
  */
9721
11040
  notTags?: Array<string>;
11041
+ /**
11042
+ * Only mentions carrying any of these labels (exact, case-sensitive).
11043
+ */
11044
+ labels?: Array<string>;
11045
+ /**
11046
+ * Never mentions carrying any of these labels.
11047
+ */
11048
+ notLabels?: Array<string>;
9722
11049
  /**
9723
11050
  * Only posts linking to any of these hosts, the host itself or a subdomain of it.
9724
11051
  */
@@ -9796,19 +11123,32 @@ type UpdateViewData = {
9796
11123
  */
9797
11124
  anyOf?: Array<FilterGroup>;
9798
11125
  };
11126
+ /**
11127
+ * Replaces every action.
11128
+ */
11129
+ actions?: {
11130
+ /**
11131
+ * Labels to add, at most 10. A mention keeps at most 20 labels.
11132
+ */
11133
+ addLabels?: Array<string>;
11134
+ /**
11135
+ * A workspace member (user id) to assign when the mention has nobody yet; someone already assigned is kept.
11136
+ */
11137
+ assigneeId?: string | null;
11138
+ };
9799
11139
  };
9800
11140
  path: {
9801
11141
  /**
9802
- * View id (vw_...).
11142
+ * Automation id (atm_...).
9803
11143
  */
9804
11144
  id: string;
9805
11145
  };
9806
11146
  query?: never;
9807
- url: '/v1/views/{id}';
11147
+ url: '/v1/automations/{id}';
9808
11148
  };
9809
- type UpdateViewErrors = {
11149
+ type UpdateAutomationErrors = {
9810
11150
  /**
9811
- * Invalid request: a parameter or the body failed validation (validation_error)
11151
+ * Invalid request, or invalid_assignee: the assignee is not a workspace member
9812
11152
  */
9813
11153
  400: ErrorResponse;
9814
11154
  /**
@@ -9816,22 +11156,73 @@ type UpdateViewErrors = {
9816
11156
  */
9817
11157
  401: ErrorResponse;
9818
11158
  /**
9819
- * No such view in this workspace
11159
+ * No such automation in this workspace
9820
11160
  */
9821
11161
  404: ErrorResponse;
9822
11162
  /**
9823
- * A view with that name already exists (duplicate_view)
11163
+ * duplicate_automation: the name is taken
9824
11164
  */
9825
11165
  409: ErrorResponse;
9826
11166
  };
9827
- type UpdateViewError = UpdateViewErrors[keyof UpdateViewErrors];
9828
- type UpdateViewResponses = {
11167
+ type UpdateAutomationError = UpdateAutomationErrors[keyof UpdateAutomationErrors];
11168
+ type UpdateAutomationResponses = {
9829
11169
  /**
9830
- * The updated view
11170
+ * The updated automation
9831
11171
  */
9832
- 200: View;
11172
+ 200: Automation;
9833
11173
  };
9834
- type UpdateViewResponse = UpdateViewResponses[keyof UpdateViewResponses];
11174
+ type UpdateAutomationResponse = UpdateAutomationResponses[keyof UpdateAutomationResponses];
11175
+ type ListLabelsData = {
11176
+ body?: never;
11177
+ path?: never;
11178
+ query?: {
11179
+ /**
11180
+ * Page size, 1 to 100.
11181
+ */
11182
+ limit?: number;
11183
+ /**
11184
+ * Skip this many labels.
11185
+ */
11186
+ offset?: number | null;
11187
+ };
11188
+ url: '/v1/labels';
11189
+ };
11190
+ type ListLabelsErrors = {
11191
+ /**
11192
+ * Invalid limit or offset (validation_error)
11193
+ */
11194
+ 400: ErrorResponse;
11195
+ /**
11196
+ * Missing or invalid API key
11197
+ */
11198
+ 401: ErrorResponse;
11199
+ };
11200
+ type ListLabelsError = ListLabelsErrors[keyof ListLabelsErrors];
11201
+ type ListLabelsResponses = {
11202
+ /**
11203
+ * Labels
11204
+ */
11205
+ 200: {
11206
+ /**
11207
+ * Labels in the workspace, the most used first.
11208
+ */
11209
+ data: Array<{
11210
+ /**
11211
+ * The label, exactly as written.
11212
+ */
11213
+ name: string;
11214
+ /**
11215
+ * Mentions carrying it, hidden ones included (muted authors, cross-post copies).
11216
+ */
11217
+ mentions: number;
11218
+ }>;
11219
+ /**
11220
+ * Distinct labels in the workspace.
11221
+ */
11222
+ total: number;
11223
+ };
11224
+ };
11225
+ type ListLabelsResponse = ListLabelsResponses[keyof ListLabelsResponses];
9835
11226
  type ListAttentionData = {
9836
11227
  body?: never;
9837
11228
  path?: never;
@@ -10945,6 +12336,14 @@ type UpdateAlertData = {
10945
12336
  * Only these sentiments.
10946
12337
  */
10947
12338
  sentiments?: Array<'positive' | 'neutral' | 'negative'>;
12339
+ /**
12340
+ * Only mentions showing any of these emotions toward the keyword. A mention whose emotion was not judged never passes.
12341
+ */
12342
+ emotions?: Array<'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral'>;
12343
+ /**
12344
+ * Never these emotions: ["anger"]. A mention whose emotion was not judged still passes.
12345
+ */
12346
+ notEmotions?: Array<'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral'>;
10948
12347
  /**
10949
12348
  * At least one of these intent or topic tags.
10950
12349
  */
@@ -10961,6 +12360,14 @@ type UpdateAlertData = {
10961
12360
  * Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
10962
12361
  */
10963
12362
  tags?: Array<string>;
12363
+ /**
12364
+ * Only mentions carrying any of these labels. An automation labels a mention before it is delivered, so a rule can route what an automation labelled.
12365
+ */
12366
+ labels?: Array<string>;
12367
+ /**
12368
+ * Never mentions carrying any of these labels.
12369
+ */
12370
+ notLabels?: Array<string>;
10964
12371
  /**
10965
12372
  * Only posts linking to any of these hosts, the host itself or a subdomain of it (octolens.com also matches blog.octolens.com). A post with no links never passes.
10966
12373
  */
@@ -11155,6 +12562,14 @@ type ListAlertsResponses = {
11155
12562
  * Only these sentiments.
11156
12563
  */
11157
12564
  sentiments?: Array<'positive' | 'neutral' | 'negative'>;
12565
+ /**
12566
+ * Only mentions showing any of these emotions toward the keyword. A mention whose emotion was not judged never passes.
12567
+ */
12568
+ emotions?: Array<'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral'>;
12569
+ /**
12570
+ * Never these emotions: ["anger"]. A mention whose emotion was not judged still passes.
12571
+ */
12572
+ notEmotions?: Array<'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral'>;
11158
12573
  /**
11159
12574
  * At least one of these intent or topic tags.
11160
12575
  */
@@ -11171,6 +12586,14 @@ type ListAlertsResponses = {
11171
12586
  * Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
11172
12587
  */
11173
12588
  tags?: Array<string>;
12589
+ /**
12590
+ * Only mentions carrying any of these labels. An automation labels a mention before it is delivered, so a rule can route what an automation labelled.
12591
+ */
12592
+ labels?: Array<string>;
12593
+ /**
12594
+ * Never mentions carrying any of these labels.
12595
+ */
12596
+ notLabels?: Array<string>;
11174
12597
  /**
11175
12598
  * Only posts linking to any of these hosts, the host itself or a subdomain of it (octolens.com also matches blog.octolens.com). A post with no links never passes.
11176
12599
  */
@@ -11342,6 +12765,14 @@ type CreateAlertData = {
11342
12765
  * Only these sentiments.
11343
12766
  */
11344
12767
  sentiments?: Array<'positive' | 'neutral' | 'negative'>;
12768
+ /**
12769
+ * Only mentions showing any of these emotions toward the keyword. A mention whose emotion was not judged never passes.
12770
+ */
12771
+ emotions?: Array<'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral'>;
12772
+ /**
12773
+ * Never these emotions: ["anger"]. A mention whose emotion was not judged still passes.
12774
+ */
12775
+ notEmotions?: Array<'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral'>;
11345
12776
  /**
11346
12777
  * At least one of these intent or topic tags.
11347
12778
  */
@@ -11358,6 +12789,14 @@ type CreateAlertData = {
11358
12789
  * Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
11359
12790
  */
11360
12791
  tags?: Array<string>;
12792
+ /**
12793
+ * Only mentions carrying any of these labels. An automation labels a mention before it is delivered, so a rule can route what an automation labelled.
12794
+ */
12795
+ labels?: Array<string>;
12796
+ /**
12797
+ * Never mentions carrying any of these labels.
12798
+ */
12799
+ notLabels?: Array<string>;
11361
12800
  /**
11362
12801
  * Only posts linking to any of these hosts, the host itself or a subdomain of it (octolens.com also matches blog.octolens.com). A post with no links never passes.
11363
12802
  */
@@ -11872,6 +13311,7 @@ type GetAnalyticsBreakdownData = {
11872
13311
  *
11873
13312
  * - platform or keyword.
11874
13313
  * - sentiment: unclassified included.
13314
+ * - emotion: the emotion toward the keyword; "unclassified" if not judged.
11875
13315
  * - intent: a mention can carry several.
11876
13316
  * - status: open, ignored, done.
11877
13317
  * - hour: weekday and hour of day in `timezone`.
@@ -11879,8 +13319,11 @@ type GetAnalyticsBreakdownData = {
11879
13319
  * - language: ISO 639-1; "unknown" if none, "other" if unnamed.
11880
13320
  * - country: the author's, ISO 3166-1 alpha-2; "unknown", "other" likewise.
11881
13321
  * - subreddit: Reddit posts only; `share` stays of the whole window.
13322
+ * - domain: hosts posts link to; a post can carry several.
13323
+ * - link: URLs posts link to; a post can carry several.
13324
+ * - hashtag: lowercase, no #; a post can carry several.
11882
13325
  */
11883
- by: 'platform' | 'keyword' | 'sentiment' | 'intent' | 'status' | 'hour' | 'person' | 'language' | 'country' | 'subreddit';
13326
+ by: 'platform' | 'keyword' | 'sentiment' | 'emotion' | 'intent' | 'status' | 'hour' | 'person' | 'language' | 'country' | 'subreddit' | 'domain' | 'link' | 'hashtag';
11884
13327
  };
11885
13328
  url: '/v1/analytics/breakdown';
11886
13329
  };
@@ -12436,8 +13879,8 @@ declare const listKeywords: <ThrowOnError extends boolean = false>(options?: Opt
12436
13879
  * Start tracking a word or phrase; mentions arrive from the next poll.
12437
13880
  *
12438
13881
  * - $5 a month, charged daily; up to 500 per funded workspace.
12439
- * - `matching` filters posts before they are stored, so rejected posts never bill.
12440
- * - `cap` limits matched mentions per period.
13882
+ * - `matching` filters posts before storage, rejected posts never bill; `query` writes both as one query.
13883
+ * - `cap` limits mentions per period.
12441
13884
  *
12442
13885
  * See [Keywords](/guides/keywords).
12443
13886
  */
@@ -12455,7 +13898,7 @@ declare const getKeyword: <ThrowOnError extends boolean = false>(options: Option
12455
13898
  /**
12456
13899
  * Update a keyword
12457
13900
  *
12458
- * Change a keyword's term, mute, kind, platforms, context, matching rules or mention cap.
13901
+ * Change a keyword's term, query, mute, kind, platforms, context, matching rules or mention cap.
12459
13902
  *
12460
13903
  * - A new `term` is tracked from now on, no look-back; old mentions stay.
12461
13904
  * - An empty rule list clears it; `cap` null removes the cap.
@@ -12542,6 +13985,16 @@ declare const getFilters: <ThrowOnError extends boolean = false>(options?: Optio
12542
13985
  * Entries are stored canonically (lowercase terms, authors as profile links or names, owner/name repositories, subreddits without r/). Applies to new mentions within a minute.
12543
13986
  */
12544
13987
  declare const updateFilters: <ThrowOnError extends boolean = false>(options: Options<UpdateFiltersData, ThrowOnError>) => RequestResult<UpdateFiltersResponses, UpdateFiltersErrors, ThrowOnError>;
13988
+ /**
13989
+ * Update many mentions
13990
+ *
13991
+ * Change up to 100 mentions at once: status, assignee, labels to add or remove.
13992
+ *
13993
+ * - All of it lands, or none of it.
13994
+ * - Unknown ids come back in `notFound`.
13995
+ * - Removals run before additions. See [Labels and automations](/guides/labels).
13996
+ */
13997
+ declare const updateMentions: <ThrowOnError extends boolean = false>(options: Options<UpdateMentionsData, ThrowOnError>) => RequestResult<UpdateMentionsResponses, UpdateMentionsErrors, ThrowOnError>;
12545
13998
  /**
12546
13999
  * Get a mention
12547
14000
  *
@@ -12553,9 +14006,10 @@ declare const getMention: <ThrowOnError extends boolean = false>(options: Option
12553
14006
  /**
12554
14007
  * Update a mention
12555
14008
  *
12556
- * Triage, assign, snooze, annotate or correct the classification of a mention.
14009
+ * Triage, assign, snooze, label, annotate or correct the classification of a mention.
12557
14010
  *
12558
- * - `relevant` and `sentiment` are your verdict; every list, digest and report follows it. null restores the classifier's.
14011
+ * - `relevant` and `sentiment` are your verdict; null restores the classifier's.
14012
+ * - `labels` replaces the whole list.
12559
14013
  * - Omitted fields stay. Delivery and billing never change.
12560
14014
  */
12561
14015
  declare const updateMention: <ThrowOnError extends boolean = false>(options: Options<UpdateMentionData, ThrowOnError>) => RequestResult<UpdateMentionResponses, UpdateMentionErrors, ThrowOnError>;
@@ -12749,6 +14203,45 @@ declare const getView: <ThrowOnError extends boolean = false>(options: Options<G
12749
14203
  * Rename, describe or refilter a view. `filter` replaces the whole filter.
12750
14204
  */
12751
14205
  declare const updateView: <ThrowOnError extends boolean = false>(options: Options<UpdateViewData, ThrowOnError>) => RequestResult<UpdateViewResponses, UpdateViewErrors, ThrowOnError>;
14206
+ /**
14207
+ * List automations
14208
+ *
14209
+ * The workspace's automations, in the order they run, oldest first. See [Labels and automations](/guides/labels).
14210
+ */
14211
+ declare const listAutomations: <ThrowOnError extends boolean = false>(options?: Options<ListAutomationsData, ThrowOnError>) => RequestResult<ListAutomationsResponses, ListAutomationsErrors, ThrowOnError>;
14212
+ /**
14213
+ * Create an automation
14214
+ *
14215
+ * Act on every new mention a filter selects: add labels, assign a member.
14216
+ *
14217
+ * - Runs after scoring and before delivery, so alert rules see its labels.
14218
+ * - At most 25. Existing mentions are untouched; use POST /v1/mentions/batch. See [Labels and automations](/guides/labels).
14219
+ */
14220
+ declare const createAutomation: <ThrowOnError extends boolean = false>(options: Options<CreateAutomationData, ThrowOnError>) => RequestResult<CreateAutomationResponses, CreateAutomationErrors, ThrowOnError>;
14221
+ /**
14222
+ * Delete an automation
14223
+ *
14224
+ * Removes the automation. The labels it added stay on their mentions.
14225
+ */
14226
+ declare const deleteAutomation: <ThrowOnError extends boolean = false>(options: Options<DeleteAutomationData, ThrowOnError>) => RequestResult<DeleteAutomationResponses, DeleteAutomationErrors, ThrowOnError>;
14227
+ /**
14228
+ * Get an automation
14229
+ */
14230
+ declare const getAutomation: <ThrowOnError extends boolean = false>(options: Options<GetAutomationData, ThrowOnError>) => RequestResult<GetAutomationResponses, GetAutomationErrors, ThrowOnError>;
14231
+ /**
14232
+ * Update an automation
14233
+ *
14234
+ * Rename, pause or change an automation. `filter` and `actions` each replace the whole of themselves. A change applies to mentions scored from then on.
14235
+ */
14236
+ declare const updateAutomation: <ThrowOnError extends boolean = false>(options: Options<UpdateAutomationData, ThrowOnError>) => RequestResult<UpdateAutomationResponses, UpdateAutomationErrors, ThrowOnError>;
14237
+ /**
14238
+ * List labels
14239
+ *
14240
+ * Labels in the workspace and how many mentions carry each, the most used first.
14241
+ *
14242
+ * A label exists while a mention carries it. Filter mentions with `labels` / `notLabels`.
14243
+ */
14244
+ declare const listLabels: <ThrowOnError extends boolean = false>(options?: Options<ListLabelsData, ThrowOnError>) => RequestResult<ListLabelsResponses, ListLabelsErrors, ThrowOnError>;
12752
14245
  /**
12753
14246
  * List attention items
12754
14247
  *
@@ -13061,6 +14554,7 @@ declare const createChannel: <ThrowOnError extends boolean = false>(options: Opt
13061
14554
  type sdk_Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options<TData, ThrowOnError, TResponse>;
13062
14555
  declare const sdk_createAlert: typeof createAlert;
13063
14556
  declare const sdk_createApiKey: typeof createApiKey;
14557
+ declare const sdk_createAutomation: typeof createAutomation;
13064
14558
  declare const sdk_createChannel: typeof createChannel;
13065
14559
  declare const sdk_createFeed: typeof createFeed;
13066
14560
  declare const sdk_createGroup: typeof createGroup;
@@ -13070,6 +14564,7 @@ declare const sdk_createSegment: typeof createSegment;
13070
14564
  declare const sdk_createTopUp: typeof createTopUp;
13071
14565
  declare const sdk_createView: typeof createView;
13072
14566
  declare const sdk_deleteAlert: typeof deleteAlert;
14567
+ declare const sdk_deleteAutomation: typeof deleteAutomation;
13073
14568
  declare const sdk_deleteChannel: typeof deleteChannel;
13074
14569
  declare const sdk_deleteFeed: typeof deleteFeed;
13075
14570
  declare const sdk_deleteGroup: typeof deleteGroup;
@@ -13086,6 +14581,7 @@ declare const sdk_getAlert: typeof getAlert;
13086
14581
  declare const sdk_getAnalyticsBreakdown: typeof getAnalyticsBreakdown;
13087
14582
  declare const sdk_getAnalyticsSeries: typeof getAnalyticsSeries;
13088
14583
  declare const sdk_getAnalyticsSummary: typeof getAnalyticsSummary;
14584
+ declare const sdk_getAutomation: typeof getAutomation;
13089
14585
  declare const sdk_getChannel: typeof getChannel;
13090
14586
  declare const sdk_getCompany: typeof getCompany;
13091
14587
  declare const sdk_getFeed: typeof getFeed;
@@ -13108,6 +14604,7 @@ declare const sdk_importFeeds: typeof importFeeds;
13108
14604
  declare const sdk_listAlerts: typeof listAlerts;
13109
14605
  declare const sdk_listApiKeys: typeof listApiKeys;
13110
14606
  declare const sdk_listAttention: typeof listAttention;
14607
+ declare const sdk_listAutomations: typeof listAutomations;
13111
14608
  declare const sdk_listChannelDeliveries: typeof listChannelDeliveries;
13112
14609
  declare const sdk_listChannels: typeof listChannels;
13113
14610
  declare const sdk_listFeeds: typeof listFeeds;
@@ -13115,6 +14612,7 @@ declare const sdk_listGroups: typeof listGroups;
13115
14612
  declare const sdk_listInvitations: typeof listInvitations;
13116
14613
  declare const sdk_listInvoices: typeof listInvoices;
13117
14614
  declare const sdk_listKeywords: typeof listKeywords;
14615
+ declare const sdk_listLabels: typeof listLabels;
13118
14616
  declare const sdk_listLedger: typeof listLedger;
13119
14617
  declare const sdk_listMembers: typeof listMembers;
13120
14618
  declare const sdk_listMentionComments: typeof listMentionComments;
@@ -13137,6 +14635,7 @@ declare const sdk_testAlert: typeof testAlert;
13137
14635
  declare const sdk_testChannel: typeof testChannel;
13138
14636
  declare const sdk_unmuteAlertAuthors: typeof unmuteAlertAuthors;
13139
14637
  declare const sdk_updateAlert: typeof updateAlert;
14638
+ declare const sdk_updateAutomation: typeof updateAutomation;
13140
14639
  declare const sdk_updateChannel: typeof updateChannel;
13141
14640
  declare const sdk_updateCompany: typeof updateCompany;
13142
14641
  declare const sdk_updateFeed: typeof updateFeed;
@@ -13144,12 +14643,13 @@ declare const sdk_updateFilters: typeof updateFilters;
13144
14643
  declare const sdk_updateGroup: typeof updateGroup;
13145
14644
  declare const sdk_updateKeyword: typeof updateKeyword;
13146
14645
  declare const sdk_updateMention: typeof updateMention;
14646
+ declare const sdk_updateMentions: typeof updateMentions;
13147
14647
  declare const sdk_updatePerson: typeof updatePerson;
13148
14648
  declare const sdk_updateSegment: typeof updateSegment;
13149
14649
  declare const sdk_updateView: typeof updateView;
13150
14650
  declare const sdk_whoami: typeof whoami;
13151
14651
  declare namespace sdk {
13152
- export { type sdk_Options as Options, sdk_createAlert as createAlert, sdk_createApiKey as createApiKey, sdk_createChannel as createChannel, sdk_createFeed as createFeed, sdk_createGroup as createGroup, sdk_createInvitation as createInvitation, sdk_createKeyword as createKeyword, sdk_createSegment as createSegment, sdk_createTopUp as createTopUp, sdk_createView as createView, sdk_deleteAlert as deleteAlert, sdk_deleteChannel as deleteChannel, sdk_deleteFeed as deleteFeed, sdk_deleteGroup as deleteGroup, sdk_deleteKeyword as deleteKeyword, sdk_deletePersonActivity as deletePersonActivity, sdk_deleteSegment as deleteSegment, sdk_deleteView as deleteView, sdk_dismissAttention as dismissAttention, sdk_duplicateKeyword as duplicateKeyword, sdk_exportMentionsCsv as exportMentionsCsv, sdk_exportMentionsJson as exportMentionsJson, sdk_exportPeopleCsv as exportPeopleCsv, sdk_getAlert as getAlert, sdk_getAnalyticsBreakdown as getAnalyticsBreakdown, sdk_getAnalyticsSeries as getAnalyticsSeries, sdk_getAnalyticsSummary as getAnalyticsSummary, sdk_getChannel as getChannel, sdk_getCompany as getCompany, sdk_getFeed as getFeed, sdk_getFilters as getFilters, sdk_getGroup as getGroup, sdk_getHealth as getHealth, sdk_getInvoiceUrl as getInvoiceUrl, sdk_getKeyword as getKeyword, sdk_getKeywordHealth as getKeywordHealth, sdk_getMention as getMention, sdk_getPerson as getPerson, sdk_getReviewsReport as getReviewsReport, sdk_getSegment as getSegment, sdk_getShareOfVoice as getShareOfVoice, sdk_getUsage as getUsage, sdk_getUsageBreakdown as getUsageBreakdown, sdk_getView as getView, sdk_getWallet as getWallet, sdk_importFeeds as importFeeds, sdk_listAlerts as listAlerts, sdk_listApiKeys as listApiKeys, sdk_listAttention as listAttention, sdk_listChannelDeliveries as listChannelDeliveries, sdk_listChannels as listChannels, sdk_listFeeds as listFeeds, sdk_listGroups as listGroups, sdk_listInvitations as listInvitations, sdk_listInvoices as listInvoices, sdk_listKeywords as listKeywords, sdk_listLedger as listLedger, sdk_listMembers as listMembers, sdk_listMentionComments as listMentionComments, sdk_listPeople as listPeople, sdk_listPersonActivities as listPersonActivities, sdk_listSegmentPresets as listSegmentPresets, sdk_listSegments as listSegments, sdk_listViews as listViews, sdk_logPersonActivity as logPersonActivity, sdk_mergePeople as mergePeople, sdk_muteAlertAuthors as muteAlertAuthors, sdk_removeMember as removeMember, sdk_revokeApiKey as revokeApiKey, sdk_revokeInvitation as revokeInvitation, sdk_rotateWebhookSecret as rotateWebhookSecret, sdk_runAlertDigest as runAlertDigest, sdk_searchMentions as searchMentions, sdk_splitPerson as splitPerson, sdk_testAlert as testAlert, sdk_testChannel as testChannel, sdk_unmuteAlertAuthors as unmuteAlertAuthors, sdk_updateAlert as updateAlert, sdk_updateChannel as updateChannel, sdk_updateCompany as updateCompany, sdk_updateFeed as updateFeed, sdk_updateFilters as updateFilters, sdk_updateGroup as updateGroup, sdk_updateKeyword as updateKeyword, sdk_updateMention as updateMention, sdk_updatePerson as updatePerson, sdk_updateSegment as updateSegment, sdk_updateView as updateView, sdk_whoami as whoami };
14652
+ export { type sdk_Options as Options, sdk_createAlert as createAlert, sdk_createApiKey as createApiKey, sdk_createAutomation as createAutomation, sdk_createChannel as createChannel, sdk_createFeed as createFeed, sdk_createGroup as createGroup, sdk_createInvitation as createInvitation, sdk_createKeyword as createKeyword, sdk_createSegment as createSegment, sdk_createTopUp as createTopUp, sdk_createView as createView, sdk_deleteAlert as deleteAlert, sdk_deleteAutomation as deleteAutomation, sdk_deleteChannel as deleteChannel, sdk_deleteFeed as deleteFeed, sdk_deleteGroup as deleteGroup, sdk_deleteKeyword as deleteKeyword, sdk_deletePersonActivity as deletePersonActivity, sdk_deleteSegment as deleteSegment, sdk_deleteView as deleteView, sdk_dismissAttention as dismissAttention, sdk_duplicateKeyword as duplicateKeyword, sdk_exportMentionsCsv as exportMentionsCsv, sdk_exportMentionsJson as exportMentionsJson, sdk_exportPeopleCsv as exportPeopleCsv, sdk_getAlert as getAlert, sdk_getAnalyticsBreakdown as getAnalyticsBreakdown, sdk_getAnalyticsSeries as getAnalyticsSeries, sdk_getAnalyticsSummary as getAnalyticsSummary, sdk_getAutomation as getAutomation, sdk_getChannel as getChannel, sdk_getCompany as getCompany, sdk_getFeed as getFeed, sdk_getFilters as getFilters, sdk_getGroup as getGroup, sdk_getHealth as getHealth, sdk_getInvoiceUrl as getInvoiceUrl, sdk_getKeyword as getKeyword, sdk_getKeywordHealth as getKeywordHealth, sdk_getMention as getMention, sdk_getPerson as getPerson, sdk_getReviewsReport as getReviewsReport, sdk_getSegment as getSegment, sdk_getShareOfVoice as getShareOfVoice, sdk_getUsage as getUsage, sdk_getUsageBreakdown as getUsageBreakdown, sdk_getView as getView, sdk_getWallet as getWallet, sdk_importFeeds as importFeeds, sdk_listAlerts as listAlerts, sdk_listApiKeys as listApiKeys, sdk_listAttention as listAttention, sdk_listAutomations as listAutomations, sdk_listChannelDeliveries as listChannelDeliveries, sdk_listChannels as listChannels, sdk_listFeeds as listFeeds, sdk_listGroups as listGroups, sdk_listInvitations as listInvitations, sdk_listInvoices as listInvoices, sdk_listKeywords as listKeywords, sdk_listLabels as listLabels, sdk_listLedger as listLedger, sdk_listMembers as listMembers, sdk_listMentionComments as listMentionComments, sdk_listPeople as listPeople, sdk_listPersonActivities as listPersonActivities, sdk_listSegmentPresets as listSegmentPresets, sdk_listSegments as listSegments, sdk_listViews as listViews, sdk_logPersonActivity as logPersonActivity, sdk_mergePeople as mergePeople, sdk_muteAlertAuthors as muteAlertAuthors, sdk_removeMember as removeMember, sdk_revokeApiKey as revokeApiKey, sdk_revokeInvitation as revokeInvitation, sdk_rotateWebhookSecret as rotateWebhookSecret, sdk_runAlertDigest as runAlertDigest, sdk_searchMentions as searchMentions, sdk_splitPerson as splitPerson, sdk_testAlert as testAlert, sdk_testChannel as testChannel, sdk_unmuteAlertAuthors as unmuteAlertAuthors, sdk_updateAlert as updateAlert, sdk_updateAutomation as updateAutomation, sdk_updateChannel as updateChannel, sdk_updateCompany as updateCompany, sdk_updateFeed as updateFeed, sdk_updateFilters as updateFilters, sdk_updateGroup as updateGroup, sdk_updateKeyword as updateKeyword, sdk_updateMention as updateMention, sdk_updateMentions as updateMentions, sdk_updatePerson as updatePerson, sdk_updateSegment as updateSegment, sdk_updateView as updateView, sdk_whoami as whoami };
13153
14653
  }
13154
14654
 
13155
14655
  /**
@@ -13177,4 +14677,4 @@ type Mentio = typeof sdk & {
13177
14677
  };
13178
14678
  declare function createMentio(options: MentioOptions): Mentio;
13179
14679
 
13180
- export { type Alert, type AnalyticsBreakdown, type AnalyticsSeries, type AnalyticsSummary, type AttentionItem, type Channel, type ChannelFailingEventData, type Client, type ClientOptions, type Company, type Config, type CreateAlertData, type CreateAlertError, type CreateAlertErrors, type CreateAlertResponse, type CreateAlertResponses, type CreateApiKeyData, type CreateApiKeyError, type CreateApiKeyErrors, type CreateApiKeyResponse, type CreateApiKeyResponses, type CreateChannelData, type CreateChannelError, type CreateChannelErrors, type CreateChannelResponse, type CreateChannelResponses, type CreateEmailChannel, type CreateFeedData, type CreateFeedError, type CreateFeedErrors, type CreateFeedResponse, type CreateFeedResponses, type CreateGroupData, type CreateGroupError, type CreateGroupErrors, type CreateGroupResponse, type CreateGroupResponses, type CreateInvitationData, type CreateInvitationError, type CreateInvitationErrors, type CreateInvitationResponse, type CreateInvitationResponses, type CreateKeywordData, type CreateKeywordError, type CreateKeywordErrors, type CreateKeywordResponse, type CreateKeywordResponses, type CreateSegmentData, type CreateSegmentError, type CreateSegmentErrors, type CreateSegmentResponse, type CreateSegmentResponses, type CreateSlackChannel, type CreateTopUpData, type CreateTopUpError, type CreateTopUpErrors, type CreateTopUpResponse, type CreateTopUpResponses, type CreateViewData, type CreateViewError, type CreateViewErrors, type CreateViewResponse, type CreateViewResponses, type CreateWebhookChannel, DEFAULT_BASE_URL, type DeleteAlertData, type DeleteAlertError, type DeleteAlertErrors, type DeleteAlertResponse, type DeleteAlertResponses, type DeleteChannelData, type DeleteChannelError, type DeleteChannelErrors, type DeleteChannelResponse, type DeleteChannelResponses, type DeleteFeedData, type DeleteFeedError, type DeleteFeedErrors, type DeleteFeedResponse, type DeleteFeedResponses, type DeleteGroupData, type DeleteGroupError, type DeleteGroupErrors, type DeleteGroupResponse, type DeleteGroupResponses, type DeleteKeywordData, type DeleteKeywordError, type DeleteKeywordErrors, type DeleteKeywordResponse, type DeleteKeywordResponses, type DeletePersonActivityData, type DeletePersonActivityError, type DeletePersonActivityErrors, type DeletePersonActivityResponse, type DeletePersonActivityResponses, type DeleteSegmentData, type DeleteSegmentError, type DeleteSegmentErrors, type DeleteSegmentResponse, type DeleteSegmentResponses, type DeleteViewData, type DeleteViewError, type DeleteViewErrors, type DeleteViewResponse, type DeleteViewResponses, type DismissAttentionData, type DismissAttentionError, type DismissAttentionErrors, type DismissAttentionResponse, type DismissAttentionResponses, type DuplicateKeywordData, type DuplicateKeywordError, type DuplicateKeywordErrors, type DuplicateKeywordResponse, type DuplicateKeywordResponses, type EmailChannel, type ErrorResponse, type ExportMentionsCsvData, type ExportMentionsCsvError, type ExportMentionsCsvErrors, type ExportMentionsCsvResponse, type ExportMentionsCsvResponses, type ExportMentionsJsonData, type ExportMentionsJsonError, type ExportMentionsJsonErrors, type ExportMentionsJsonResponse, type ExportMentionsJsonResponses, type ExportPeopleCsvData, type ExportPeopleCsvError, type ExportPeopleCsvErrors, type ExportPeopleCsvResponse, type ExportPeopleCsvResponses, type Feed, type FeedFailingEventData, type FilterGroup, type GetAlertData, type GetAlertError, type GetAlertErrors, type GetAlertResponse, type GetAlertResponses, type GetAnalyticsBreakdownData, type GetAnalyticsBreakdownError, type GetAnalyticsBreakdownErrors, type GetAnalyticsBreakdownResponse, type GetAnalyticsBreakdownResponses, type GetAnalyticsSeriesData, type GetAnalyticsSeriesError, type GetAnalyticsSeriesErrors, type GetAnalyticsSeriesResponse, type GetAnalyticsSeriesResponses, type GetAnalyticsSummaryData, type GetAnalyticsSummaryError, type GetAnalyticsSummaryErrors, type GetAnalyticsSummaryResponse, type GetAnalyticsSummaryResponses, type GetChannelData, type GetChannelError, type GetChannelErrors, type GetChannelResponse, type GetChannelResponses, type GetCompanyData, type GetCompanyError, type GetCompanyErrors, type GetCompanyResponse, type GetCompanyResponses, type GetFeedData, type GetFeedError, type GetFeedErrors, type GetFeedResponse, type GetFeedResponses, type GetFiltersData, type GetFiltersError, type GetFiltersErrors, type GetFiltersResponse, type GetFiltersResponses, type GetGroupData, type GetGroupError, type GetGroupErrors, type GetGroupResponse, type GetGroupResponses, type GetHealthData, type GetHealthResponse, type GetHealthResponses, type GetInvoiceUrlData, type GetInvoiceUrlError, type GetInvoiceUrlErrors, type GetInvoiceUrlResponse, type GetInvoiceUrlResponses, type GetKeywordData, type GetKeywordError, type GetKeywordErrors, type GetKeywordHealthData, type GetKeywordHealthError, type GetKeywordHealthErrors, type GetKeywordHealthResponse, type GetKeywordHealthResponses, type GetKeywordResponse, type GetKeywordResponses, type GetMentionData, type GetMentionError, type GetMentionErrors, type GetMentionResponse, type GetMentionResponses, type GetPersonData, type GetPersonError, type GetPersonErrors, type GetPersonResponse, type GetPersonResponses, type GetReviewsReportData, type GetReviewsReportError, type GetReviewsReportErrors, type GetReviewsReportResponse, type GetReviewsReportResponses, type GetSegmentData, type GetSegmentError, type GetSegmentErrors, type GetSegmentResponse, type GetSegmentResponses, type GetShareOfVoiceData, type GetShareOfVoiceError, type GetShareOfVoiceErrors, type GetShareOfVoiceResponse, type GetShareOfVoiceResponses, type GetUsageBreakdownData, type GetUsageBreakdownError, type GetUsageBreakdownErrors, type GetUsageBreakdownResponse, type GetUsageBreakdownResponses, type GetUsageData, type GetUsageError, type GetUsageErrors, type GetUsageResponse, type GetUsageResponses, type GetViewData, type GetViewError, type GetViewErrors, type GetViewResponse, type GetViewResponses, type GetWalletData, type GetWalletError, type GetWalletErrors, type GetWalletResponse, type GetWalletResponses, type Group, type GroupRef, type ImportFeedsData, type ImportFeedsError, type ImportFeedsErrors, type ImportFeedsResponse, type ImportFeedsResponses, type Invitation, type InvoiceList, type Keyword, type KeywordFeed, type KeywordHealth, type KeywordNoisyEventData, type KeywordSuggestion, type LedgerList, type ListAlertsData, type ListAlertsError, type ListAlertsErrors, type ListAlertsResponse, type ListAlertsResponses, type ListApiKeysData, type ListApiKeysError, type ListApiKeysErrors, type ListApiKeysResponse, type ListApiKeysResponses, type ListAttentionData, type ListAttentionError, type ListAttentionErrors, type ListAttentionResponse, type ListAttentionResponses, type ListChannelDeliveriesData, type ListChannelDeliveriesError, type ListChannelDeliveriesErrors, type ListChannelDeliveriesResponse, type ListChannelDeliveriesResponses, type ListChannelsData, type ListChannelsError, type ListChannelsErrors, type ListChannelsResponse, type ListChannelsResponses, type ListFeedsData, type ListFeedsError, type ListFeedsErrors, type ListFeedsResponse, type ListFeedsResponses, type ListGroupsData, type ListGroupsError, type ListGroupsErrors, type ListGroupsResponse, type ListGroupsResponses, type ListInvitationsData, type ListInvitationsError, type ListInvitationsErrors, type ListInvitationsResponse, type ListInvitationsResponses, type ListInvoicesData, type ListInvoicesError, type ListInvoicesErrors, type ListInvoicesResponse, type ListInvoicesResponses, type ListKeywordsData, type ListKeywordsError, type ListKeywordsErrors, type ListKeywordsResponse, type ListKeywordsResponses, type ListLedgerData, type ListLedgerError, type ListLedgerErrors, type ListLedgerResponse, type ListLedgerResponses, type ListMembersData, type ListMembersError, type ListMembersErrors, type ListMembersResponse, type ListMembersResponses, type ListMentionCommentsData, type ListMentionCommentsError, type ListMentionCommentsErrors, type ListMentionCommentsResponse, type ListMentionCommentsResponses, type ListPeopleData, type ListPeopleError, type ListPeopleErrors, type ListPeopleResponse, type ListPeopleResponses, type ListPersonActivitiesData, type ListPersonActivitiesError, type ListPersonActivitiesErrors, type ListPersonActivitiesResponse, type ListPersonActivitiesResponses, type ListSegmentPresetsData, type ListSegmentPresetsError, type ListSegmentPresetsErrors, type ListSegmentPresetsResponse, type ListSegmentPresetsResponses, type ListSegmentsData, type ListSegmentsError, type ListSegmentsErrors, type ListSegmentsResponse, type ListSegmentsResponses, type ListViewsData, type ListViewsError, type ListViewsErrors, type ListViewsResponse, type ListViewsResponses, type LogPersonActivityData, type LogPersonActivityError, type LogPersonActivityErrors, type LogPersonActivityResponse, type LogPersonActivityResponses, type Member, type Mentio, type MentioOptions, type Mention, type MentionComment, type MentionSpikeEventData, type MergePeopleData, type MergePeopleError, type MergePeopleErrors, type MergePeopleResponse, type MergePeopleResponses, type MuteAlertAuthorsData, type MuteAlertAuthorsError, type MuteAlertAuthorsErrors, type MuteAlertAuthorsResponse, type MuteAlertAuthorsResponses, type NegativeSpikeEventData, type Options, type Person, type PersonActivity, type RemoveMemberData, type RemoveMemberError, type RemoveMemberErrors, type RemoveMemberResponse, type RemoveMemberResponses, type RequestResult, type ReviewSource, type ReviewsReport, type RevokeApiKeyData, type RevokeApiKeyError, type RevokeApiKeyErrors, type RevokeApiKeyResponse, type RevokeApiKeyResponses, type RevokeInvitationData, type RevokeInvitationError, type RevokeInvitationErrors, type RevokeInvitationResponse, type RevokeInvitationResponses, type RotateWebhookSecretData, type RotateWebhookSecretError, type RotateWebhookSecretErrors, type RotateWebhookSecretResponse, type RotateWebhookSecretResponses, type RunAlertDigestData, type RunAlertDigestError, type RunAlertDigestErrors, type RunAlertDigestResponse, type RunAlertDigestResponses, type SearchMentionsData, type SearchMentionsError, type SearchMentionsErrors, type SearchMentionsResponse, type SearchMentionsResponses, type Segment, type SegmentPreset, type ShareOfVoice, type SlackChannel, type SplitPersonData, type SplitPersonError, type SplitPersonErrors, type SplitPersonResponse, type SplitPersonResponses, type TelegramChannel, type TestAlertData, type TestAlertError, type TestAlertErrors, type TestAlertResponse, type TestAlertResponses, type TestChannelData, type TestChannelError, type TestChannelErrors, type TestChannelResponse, type TestChannelResponses, type UnmuteAlertAuthorsData, type UnmuteAlertAuthorsError, type UnmuteAlertAuthorsErrors, type UnmuteAlertAuthorsResponse, type UnmuteAlertAuthorsResponses, type UpdateAlertData, type UpdateAlertError, type UpdateAlertErrors, type UpdateAlertResponse, type UpdateAlertResponses, type UpdateChannelData, type UpdateChannelError, type UpdateChannelErrors, type UpdateChannelResponse, type UpdateChannelResponses, type UpdateCompanyData, type UpdateCompanyError, type UpdateCompanyErrors, type UpdateCompanyResponse, type UpdateCompanyResponses, type UpdateFeedData, type UpdateFeedError, type UpdateFeedErrors, type UpdateFeedResponse, type UpdateFeedResponses, type UpdateFiltersData, type UpdateFiltersError, type UpdateFiltersErrors, type UpdateFiltersResponse, type UpdateFiltersResponses, type UpdateGroupData, type UpdateGroupError, type UpdateGroupErrors, type UpdateGroupResponse, type UpdateGroupResponses, type UpdateKeywordData, type UpdateKeywordError, type UpdateKeywordErrors, type UpdateKeywordResponse, type UpdateKeywordResponses, type UpdateMentionData, type UpdateMentionError, type UpdateMentionErrors, type UpdateMentionResponse, type UpdateMentionResponses, type UpdatePersonData, type UpdatePersonError, type UpdatePersonErrors, type UpdatePersonResponse, type UpdatePersonResponses, type UpdateSegmentData, type UpdateSegmentError, type UpdateSegmentErrors, type UpdateSegmentResponse, type UpdateSegmentResponses, type UpdateViewData, type UpdateViewError, type UpdateViewErrors, type UpdateViewResponse, type UpdateViewResponses, type UsageBreakdown, type UsageSummary, type View, type Wallet, type WebhookChannel, type Whoami, type WhoamiData, type WhoamiError, type WhoamiErrors, type WhoamiResponse, type WhoamiResponses, type WorkspaceFilters, createAlert, createApiKey, createChannel, createClient, createConfig, createFeed, createGroup, createInvitation, createKeyword, createMentio, createSegment, createTopUp, createView, deleteAlert, deleteChannel, deleteFeed, deleteGroup, deleteKeyword, deletePersonActivity, deleteSegment, deleteView, dismissAttention, duplicateKeyword, exportMentionsCsv, exportMentionsJson, exportPeopleCsv, getAlert, getAnalyticsBreakdown, getAnalyticsSeries, getAnalyticsSummary, getChannel, getCompany, getFeed, getFilters, getGroup, getHealth, getInvoiceUrl, getKeyword, getKeywordHealth, getMention, getPerson, getReviewsReport, getSegment, getShareOfVoice, getUsage, getUsageBreakdown, getView, getWallet, importFeeds, listAlerts, listApiKeys, listAttention, listChannelDeliveries, listChannels, listFeeds, listGroups, listInvitations, listInvoices, listKeywords, listLedger, listMembers, listMentionComments, listPeople, listPersonActivities, listSegmentPresets, listSegments, listViews, logPersonActivity, mergePeople, muteAlertAuthors, removeMember, revokeApiKey, revokeInvitation, rotateWebhookSecret, runAlertDigest, searchMentions, splitPerson, testAlert, testChannel, unmuteAlertAuthors, updateAlert, updateChannel, updateCompany, updateFeed, updateFilters, updateGroup, updateKeyword, updateMention, updatePerson, updateSegment, updateView, whoami };
14680
+ export { type Alert, type AnalyticsBreakdown, type AnalyticsSeries, type AnalyticsSummary, type AttentionItem, type Automation, type Channel, type ChannelFailingEventData, type Client, type ClientOptions, type Company, type Config, type CreateAlertData, type CreateAlertError, type CreateAlertErrors, type CreateAlertResponse, type CreateAlertResponses, type CreateApiKeyData, type CreateApiKeyError, type CreateApiKeyErrors, type CreateApiKeyResponse, type CreateApiKeyResponses, type CreateAutomationData, type CreateAutomationError, type CreateAutomationErrors, type CreateAutomationResponse, type CreateAutomationResponses, type CreateChannelData, type CreateChannelError, type CreateChannelErrors, type CreateChannelResponse, type CreateChannelResponses, type CreateEmailChannel, type CreateFeedData, type CreateFeedError, type CreateFeedErrors, type CreateFeedResponse, type CreateFeedResponses, type CreateGroupData, type CreateGroupError, type CreateGroupErrors, type CreateGroupResponse, type CreateGroupResponses, type CreateInvitationData, type CreateInvitationError, type CreateInvitationErrors, type CreateInvitationResponse, type CreateInvitationResponses, type CreateKeywordData, type CreateKeywordError, type CreateKeywordErrors, type CreateKeywordResponse, type CreateKeywordResponses, type CreateSegmentData, type CreateSegmentError, type CreateSegmentErrors, type CreateSegmentResponse, type CreateSegmentResponses, type CreateSlackChannel, type CreateTopUpData, type CreateTopUpError, type CreateTopUpErrors, type CreateTopUpResponse, type CreateTopUpResponses, type CreateViewData, type CreateViewError, type CreateViewErrors, type CreateViewResponse, type CreateViewResponses, type CreateWebhookChannel, DEFAULT_BASE_URL, type DeleteAlertData, type DeleteAlertError, type DeleteAlertErrors, type DeleteAlertResponse, type DeleteAlertResponses, type DeleteAutomationData, type DeleteAutomationError, type DeleteAutomationErrors, type DeleteAutomationResponse, type DeleteAutomationResponses, type DeleteChannelData, type DeleteChannelError, type DeleteChannelErrors, type DeleteChannelResponse, type DeleteChannelResponses, type DeleteFeedData, type DeleteFeedError, type DeleteFeedErrors, type DeleteFeedResponse, type DeleteFeedResponses, type DeleteGroupData, type DeleteGroupError, type DeleteGroupErrors, type DeleteGroupResponse, type DeleteGroupResponses, type DeleteKeywordData, type DeleteKeywordError, type DeleteKeywordErrors, type DeleteKeywordResponse, type DeleteKeywordResponses, type DeletePersonActivityData, type DeletePersonActivityError, type DeletePersonActivityErrors, type DeletePersonActivityResponse, type DeletePersonActivityResponses, type DeleteSegmentData, type DeleteSegmentError, type DeleteSegmentErrors, type DeleteSegmentResponse, type DeleteSegmentResponses, type DeleteViewData, type DeleteViewError, type DeleteViewErrors, type DeleteViewResponse, type DeleteViewResponses, type DismissAttentionData, type DismissAttentionError, type DismissAttentionErrors, type DismissAttentionResponse, type DismissAttentionResponses, type DuplicateKeywordData, type DuplicateKeywordError, type DuplicateKeywordErrors, type DuplicateKeywordResponse, type DuplicateKeywordResponses, type EmailChannel, type ErrorResponse, type ExportMentionsCsvData, type ExportMentionsCsvError, type ExportMentionsCsvErrors, type ExportMentionsCsvResponse, type ExportMentionsCsvResponses, type ExportMentionsJsonData, type ExportMentionsJsonError, type ExportMentionsJsonErrors, type ExportMentionsJsonResponse, type ExportMentionsJsonResponses, type ExportPeopleCsvData, type ExportPeopleCsvError, type ExportPeopleCsvErrors, type ExportPeopleCsvResponse, type ExportPeopleCsvResponses, type Feed, type FeedFailingEventData, type FilterGroup, type GetAlertData, type GetAlertError, type GetAlertErrors, type GetAlertResponse, type GetAlertResponses, type GetAnalyticsBreakdownData, type GetAnalyticsBreakdownError, type GetAnalyticsBreakdownErrors, type GetAnalyticsBreakdownResponse, type GetAnalyticsBreakdownResponses, type GetAnalyticsSeriesData, type GetAnalyticsSeriesError, type GetAnalyticsSeriesErrors, type GetAnalyticsSeriesResponse, type GetAnalyticsSeriesResponses, type GetAnalyticsSummaryData, type GetAnalyticsSummaryError, type GetAnalyticsSummaryErrors, type GetAnalyticsSummaryResponse, type GetAnalyticsSummaryResponses, type GetAutomationData, type GetAutomationError, type GetAutomationErrors, type GetAutomationResponse, type GetAutomationResponses, type GetChannelData, type GetChannelError, type GetChannelErrors, type GetChannelResponse, type GetChannelResponses, type GetCompanyData, type GetCompanyError, type GetCompanyErrors, type GetCompanyResponse, type GetCompanyResponses, type GetFeedData, type GetFeedError, type GetFeedErrors, type GetFeedResponse, type GetFeedResponses, type GetFiltersData, type GetFiltersError, type GetFiltersErrors, type GetFiltersResponse, type GetFiltersResponses, type GetGroupData, type GetGroupError, type GetGroupErrors, type GetGroupResponse, type GetGroupResponses, type GetHealthData, type GetHealthResponse, type GetHealthResponses, type GetInvoiceUrlData, type GetInvoiceUrlError, type GetInvoiceUrlErrors, type GetInvoiceUrlResponse, type GetInvoiceUrlResponses, type GetKeywordData, type GetKeywordError, type GetKeywordErrors, type GetKeywordHealthData, type GetKeywordHealthError, type GetKeywordHealthErrors, type GetKeywordHealthResponse, type GetKeywordHealthResponses, type GetKeywordResponse, type GetKeywordResponses, type GetMentionData, type GetMentionError, type GetMentionErrors, type GetMentionResponse, type GetMentionResponses, type GetPersonData, type GetPersonError, type GetPersonErrors, type GetPersonResponse, type GetPersonResponses, type GetReviewsReportData, type GetReviewsReportError, type GetReviewsReportErrors, type GetReviewsReportResponse, type GetReviewsReportResponses, type GetSegmentData, type GetSegmentError, type GetSegmentErrors, type GetSegmentResponse, type GetSegmentResponses, type GetShareOfVoiceData, type GetShareOfVoiceError, type GetShareOfVoiceErrors, type GetShareOfVoiceResponse, type GetShareOfVoiceResponses, type GetUsageBreakdownData, type GetUsageBreakdownError, type GetUsageBreakdownErrors, type GetUsageBreakdownResponse, type GetUsageBreakdownResponses, type GetUsageData, type GetUsageError, type GetUsageErrors, type GetUsageResponse, type GetUsageResponses, type GetViewData, type GetViewError, type GetViewErrors, type GetViewResponse, type GetViewResponses, type GetWalletData, type GetWalletError, type GetWalletErrors, type GetWalletResponse, type GetWalletResponses, type Group, type GroupRef, type ImportFeedsData, type ImportFeedsError, type ImportFeedsErrors, type ImportFeedsResponse, type ImportFeedsResponses, type Invitation, type InvoiceList, type Keyword, type KeywordFeed, type KeywordHealth, type KeywordNoisyEventData, type KeywordSuggestion, type LedgerList, type ListAlertsData, type ListAlertsError, type ListAlertsErrors, type ListAlertsResponse, type ListAlertsResponses, type ListApiKeysData, type ListApiKeysError, type ListApiKeysErrors, type ListApiKeysResponse, type ListApiKeysResponses, type ListAttentionData, type ListAttentionError, type ListAttentionErrors, type ListAttentionResponse, type ListAttentionResponses, type ListAutomationsData, type ListAutomationsError, type ListAutomationsErrors, type ListAutomationsResponse, type ListAutomationsResponses, type ListChannelDeliveriesData, type ListChannelDeliveriesError, type ListChannelDeliveriesErrors, type ListChannelDeliveriesResponse, type ListChannelDeliveriesResponses, type ListChannelsData, type ListChannelsError, type ListChannelsErrors, type ListChannelsResponse, type ListChannelsResponses, type ListFeedsData, type ListFeedsError, type ListFeedsErrors, type ListFeedsResponse, type ListFeedsResponses, type ListGroupsData, type ListGroupsError, type ListGroupsErrors, type ListGroupsResponse, type ListGroupsResponses, type ListInvitationsData, type ListInvitationsError, type ListInvitationsErrors, type ListInvitationsResponse, type ListInvitationsResponses, type ListInvoicesData, type ListInvoicesError, type ListInvoicesErrors, type ListInvoicesResponse, type ListInvoicesResponses, type ListKeywordsData, type ListKeywordsError, type ListKeywordsErrors, type ListKeywordsResponse, type ListKeywordsResponses, type ListLabelsData, type ListLabelsError, type ListLabelsErrors, type ListLabelsResponse, type ListLabelsResponses, type ListLedgerData, type ListLedgerError, type ListLedgerErrors, type ListLedgerResponse, type ListLedgerResponses, type ListMembersData, type ListMembersError, type ListMembersErrors, type ListMembersResponse, type ListMembersResponses, type ListMentionCommentsData, type ListMentionCommentsError, type ListMentionCommentsErrors, type ListMentionCommentsResponse, type ListMentionCommentsResponses, type ListPeopleData, type ListPeopleError, type ListPeopleErrors, type ListPeopleResponse, type ListPeopleResponses, type ListPersonActivitiesData, type ListPersonActivitiesError, type ListPersonActivitiesErrors, type ListPersonActivitiesResponse, type ListPersonActivitiesResponses, type ListSegmentPresetsData, type ListSegmentPresetsError, type ListSegmentPresetsErrors, type ListSegmentPresetsResponse, type ListSegmentPresetsResponses, type ListSegmentsData, type ListSegmentsError, type ListSegmentsErrors, type ListSegmentsResponse, type ListSegmentsResponses, type ListViewsData, type ListViewsError, type ListViewsErrors, type ListViewsResponse, type ListViewsResponses, type LogPersonActivityData, type LogPersonActivityError, type LogPersonActivityErrors, type LogPersonActivityResponse, type LogPersonActivityResponses, type Member, type Mentio, type MentioOptions, type Mention, type MentionBatchResult, type MentionComment, type MentionSpikeEventData, type MergePeopleData, type MergePeopleError, type MergePeopleErrors, type MergePeopleResponse, type MergePeopleResponses, type MuteAlertAuthorsData, type MuteAlertAuthorsError, type MuteAlertAuthorsErrors, type MuteAlertAuthorsResponse, type MuteAlertAuthorsResponses, type NegativeSpikeEventData, type Options, type Person, type PersonActivity, type RemoveMemberData, type RemoveMemberError, type RemoveMemberErrors, type RemoveMemberResponse, type RemoveMemberResponses, type RequestResult, type ReviewSource, type ReviewsReport, type RevokeApiKeyData, type RevokeApiKeyError, type RevokeApiKeyErrors, type RevokeApiKeyResponse, type RevokeApiKeyResponses, type RevokeInvitationData, type RevokeInvitationError, type RevokeInvitationErrors, type RevokeInvitationResponse, type RevokeInvitationResponses, type RotateWebhookSecretData, type RotateWebhookSecretError, type RotateWebhookSecretErrors, type RotateWebhookSecretResponse, type RotateWebhookSecretResponses, type RunAlertDigestData, type RunAlertDigestError, type RunAlertDigestErrors, type RunAlertDigestResponse, type RunAlertDigestResponses, type SearchMentionsData, type SearchMentionsError, type SearchMentionsErrors, type SearchMentionsResponse, type SearchMentionsResponses, type Segment, type SegmentPreset, type ShareOfVoice, type SlackChannel, type SplitPersonData, type SplitPersonError, type SplitPersonErrors, type SplitPersonResponse, type SplitPersonResponses, type TelegramChannel, type TestAlertData, type TestAlertError, type TestAlertErrors, type TestAlertResponse, type TestAlertResponses, type TestChannelData, type TestChannelError, type TestChannelErrors, type TestChannelResponse, type TestChannelResponses, type UnmuteAlertAuthorsData, type UnmuteAlertAuthorsError, type UnmuteAlertAuthorsErrors, type UnmuteAlertAuthorsResponse, type UnmuteAlertAuthorsResponses, type UpdateAlertData, type UpdateAlertError, type UpdateAlertErrors, type UpdateAlertResponse, type UpdateAlertResponses, type UpdateAutomationData, type UpdateAutomationError, type UpdateAutomationErrors, type UpdateAutomationResponse, type UpdateAutomationResponses, type UpdateChannelData, type UpdateChannelError, type UpdateChannelErrors, type UpdateChannelResponse, type UpdateChannelResponses, type UpdateCompanyData, type UpdateCompanyError, type UpdateCompanyErrors, type UpdateCompanyResponse, type UpdateCompanyResponses, type UpdateFeedData, type UpdateFeedError, type UpdateFeedErrors, type UpdateFeedResponse, type UpdateFeedResponses, type UpdateFiltersData, type UpdateFiltersError, type UpdateFiltersErrors, type UpdateFiltersResponse, type UpdateFiltersResponses, type UpdateGroupData, type UpdateGroupError, type UpdateGroupErrors, type UpdateGroupResponse, type UpdateGroupResponses, type UpdateKeywordData, type UpdateKeywordError, type UpdateKeywordErrors, type UpdateKeywordResponse, type UpdateKeywordResponses, type UpdateMentionData, type UpdateMentionError, type UpdateMentionErrors, type UpdateMentionResponse, type UpdateMentionResponses, type UpdateMentionsData, type UpdateMentionsError, type UpdateMentionsErrors, type UpdateMentionsResponse, type UpdateMentionsResponses, type UpdatePersonData, type UpdatePersonError, type UpdatePersonErrors, type UpdatePersonResponse, type UpdatePersonResponses, type UpdateSegmentData, type UpdateSegmentError, type UpdateSegmentErrors, type UpdateSegmentResponse, type UpdateSegmentResponses, type UpdateViewData, type UpdateViewError, type UpdateViewErrors, type UpdateViewResponse, type UpdateViewResponses, type UsageBreakdown, type UsageSummary, type View, type Wallet, type WebhookChannel, type Whoami, type WhoamiData, type WhoamiError, type WhoamiErrors, type WhoamiResponse, type WhoamiResponses, type WorkspaceFilters, createAlert, createApiKey, createAutomation, createChannel, createClient, createConfig, createFeed, createGroup, createInvitation, createKeyword, createMentio, createSegment, createTopUp, createView, deleteAlert, deleteAutomation, deleteChannel, deleteFeed, deleteGroup, deleteKeyword, deletePersonActivity, deleteSegment, deleteView, dismissAttention, duplicateKeyword, exportMentionsCsv, exportMentionsJson, exportPeopleCsv, getAlert, getAnalyticsBreakdown, getAnalyticsSeries, getAnalyticsSummary, getAutomation, getChannel, getCompany, getFeed, getFilters, getGroup, getHealth, getInvoiceUrl, getKeyword, getKeywordHealth, getMention, getPerson, getReviewsReport, getSegment, getShareOfVoice, getUsage, getUsageBreakdown, getView, getWallet, importFeeds, listAlerts, listApiKeys, listAttention, listAutomations, listChannelDeliveries, listChannels, listFeeds, listGroups, listInvitations, listInvoices, listKeywords, listLabels, listLedger, listMembers, listMentionComments, listPeople, listPersonActivities, listSegmentPresets, listSegments, listViews, logPersonActivity, mergePeople, muteAlertAuthors, removeMember, revokeApiKey, revokeInvitation, rotateWebhookSecret, runAlertDigest, searchMentions, splitPerson, testAlert, testChannel, unmuteAlertAuthors, updateAlert, updateAutomation, updateChannel, updateCompany, updateFeed, updateFilters, updateGroup, updateKeyword, updateMention, updateMentions, updatePerson, updateSegment, updateView, whoami };