@mentio-dev/sdk 0.16.1 → 0.17.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
@@ -719,7 +719,7 @@ type ErrorResponse = {
719
719
  /**
720
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.
721
721
  */
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';
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' | 'funding_required' | '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';
723
723
  /**
724
724
  * Human-readable detail; may change between releases.
725
725
  */
@@ -1332,17 +1332,21 @@ type WorkspaceFilters = {
1332
1332
  };
1333
1333
  type MentionBatchResult = {
1334
1334
  /**
1335
- * The ids changed, in the order sent. A pending mention given only a status is not changed: it is in pending alone.
1335
+ * The ids changed, in the order sent (with filter: newest first). A pending mention given only a status is not changed: it is in pending alone.
1336
1336
  */
1337
1337
  updated: Array<string>;
1338
1338
  /**
1339
- * The ids this workspace has no mention by, in the order sent; nothing was done to them.
1339
+ * The ids this workspace has no mention by, in the order sent; nothing was done to them. Always empty with filter.
1340
1340
  */
1341
1341
  notFound: Array<string>;
1342
1342
  /**
1343
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
1344
  */
1345
1345
  pending: Array<string>;
1346
+ /**
1347
+ * With filter: more mentions match, so call again with the same filter and this cursor. null when every one has been covered, and always null with ids.
1348
+ */
1349
+ nextCursor: string | null;
1346
1350
  };
1347
1351
  type Mention = {
1348
1352
  /**
@@ -2735,6 +2739,311 @@ type View = {
2735
2739
  */
2736
2740
  updatedAt: string;
2737
2741
  };
2742
+ type Search = {
2743
+ /**
2744
+ * Search id (srch_...).
2745
+ */
2746
+ id: string;
2747
+ /**
2748
+ * The term searched, as typed.
2749
+ */
2750
+ term: string;
2751
+ /**
2752
+ * How far back the search reads, ending now: 24h, 7d or 30d. Instagram reads at most its last 7 days whatever the range.
2753
+ */
2754
+ range: '24h' | '7d' | '30d';
2755
+ /**
2756
+ * brand, competitor or topic: what the classifier was told the term is.
2757
+ */
2758
+ kind: 'brand' | 'competitor' | 'topic';
2759
+ /**
2760
+ * The hint the classifier read, or null.
2761
+ */
2762
+ context: string | null;
2763
+ /**
2764
+ * queued: accepted, nothing read yet. running: platforms being read or results scored. done: every platform reported and every result scored. failed: no platform could be read.
2765
+ */
2766
+ status: 'queued' | 'running' | 'done' | 'failed';
2767
+ /**
2768
+ * The start of the window read (the end is createdAt).
2769
+ */
2770
+ from: string;
2771
+ /**
2772
+ * One entry per platform asked for, in the order asked.
2773
+ */
2774
+ platforms: Array<{
2775
+ /**
2776
+ * Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, facebook, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place), rss (RSS and Atom feeds a keyword reads).
2777
+ */
2778
+ platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
2779
+ /**
2780
+ * queued: not read yet. running: being read or scored. done: read and scored. skipped: not read (see reason). failed: the read failed (see reason).
2781
+ */
2782
+ status: 'queued' | 'running' | 'done' | 'skipped' | 'failed';
2783
+ /**
2784
+ * Why a platform was skipped or failed: unsupported (no term search on it), credentials (not connected on this deployment), budget (its monthly vendor budget is spent), rate_limited, error, timeout. null otherwise.
2785
+ */
2786
+ reason: 'unsupported' | 'credentials' | 'budget' | 'rate_limited' | 'error' | 'timeout';
2787
+ /**
2788
+ * Results stored for this platform, at most 25.
2789
+ */
2790
+ results: number;
2791
+ /**
2792
+ * Of them, scored relevant (40 or more).
2793
+ */
2794
+ relevant: number;
2795
+ }>;
2796
+ /**
2797
+ * Counts across platforms.
2798
+ */
2799
+ stats: {
2800
+ /**
2801
+ * Results stored.
2802
+ */
2803
+ results: number;
2804
+ /**
2805
+ * Results scored (the rest wait or failed).
2806
+ */
2807
+ scored: number;
2808
+ /**
2809
+ * Results scored relevant (40 or more).
2810
+ */
2811
+ relevant: number;
2812
+ };
2813
+ /**
2814
+ * What the search has cost so far: $0.008 per scored result, rounded to the cent. A result the classifier could not score costs nothing.
2815
+ */
2816
+ costCents: number;
2817
+ /**
2818
+ * The most it can cost: 25 results for each platform read, at $0.008 each. The wallet had to cover it when the search started.
2819
+ */
2820
+ maxCostCents: number;
2821
+ /**
2822
+ * When the search was started.
2823
+ */
2824
+ createdAt: string;
2825
+ /**
2826
+ * When it reached done or failed; null while it runs.
2827
+ */
2828
+ completedAt: string | null;
2829
+ };
2830
+ type SearchResult = {
2831
+ /**
2832
+ * Result id (sres_...).
2833
+ */
2834
+ id: string;
2835
+ /**
2836
+ * The search it belongs to (srch_...).
2837
+ */
2838
+ searchId: string;
2839
+ /**
2840
+ * The post: platform, text, link, publish time and engagement.
2841
+ */
2842
+ post: {
2843
+ /**
2844
+ * Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, facebook, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place), rss (RSS and Atom feeds a keyword reads).
2845
+ */
2846
+ platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
2847
+ /**
2848
+ * post: a top-level post. comment: answers a post or comment (Reddit, Hacker News or YouTube comments, X or Bluesky replies, Stack Overflow answers). repository: a GitHub repository event (see post.repository).
2849
+ */
2850
+ kind: 'post' | 'comment' | 'repository';
2851
+ /**
2852
+ * Permalink of the post.
2853
+ */
2854
+ url: string;
2855
+ /**
2856
+ * Title and body, truncated to 8 KB at ingest.
2857
+ */
2858
+ text: string;
2859
+ /**
2860
+ * The post's own title where the platform has one (a story, thread, issue, question, article, video or titled review). Null on X, Bluesky and LinkedIn, and for posts ingested before October 2026.
2861
+ */
2862
+ title: string | null;
2863
+ /**
2864
+ * A preview image of the post, when the platform sent one with it: a YouTube thumbnail, a DEV cover, a news article's sharing image, a Bluesky link card or image. Null otherwise.
2865
+ */
2866
+ imageUrl: string | null;
2867
+ /**
2868
+ * The subreddit a Reddit post was written in, without the r/ (SaaS). Null on every other platform.
2869
+ */
2870
+ subreddit: string | null;
2871
+ /**
2872
+ * A Reddit post's flair, when its subreddit uses them (Question, Show and Tell). Null otherwise.
2873
+ */
2874
+ flair: string | null;
2875
+ /**
2876
+ * A GitHub repository event's facts, on a mention whose kind is repository; null on every other mention. The sentence is post.title.
2877
+ */
2878
+ repository: {
2879
+ /**
2880
+ * The repository, owner/name.
2881
+ */
2882
+ name: string;
2883
+ /**
2884
+ * What happened:
2885
+ *
2886
+ * - new: it was created.
2887
+ * - traction: under 30 days old, it reached 10 stars.
2888
+ * - stars: it passed a star milestone.
2889
+ * - growth: it gained stars fast in a week.
2890
+ * - top: among the most starred naming the keyword, from a look-back.
2891
+ */
2892
+ event: 'new' | 'traction' | 'stars' | 'growth' | 'top';
2893
+ /**
2894
+ * Its stars when the event was found.
2895
+ */
2896
+ stars: number;
2897
+ /**
2898
+ * Stars gained in the 7 days before the event; null when that week is not known yet.
2899
+ */
2900
+ weeklyStars: number | null;
2901
+ } | null;
2902
+ /**
2903
+ * Links the post carries, in the order written, at most 20. Empty for a post with none, and for posts ingested before September 2026.
2904
+ */
2905
+ links: Array<string>;
2906
+ /**
2907
+ * When the post was published.
2908
+ */
2909
+ publishedAt: string;
2910
+ /**
2911
+ * Counts as the platform reported them at ingest, usually minutes after posting; a missing count is null. Null as a whole when a platform reports none, or before September 2026. X carries all six.
2912
+ */
2913
+ engagement: {
2914
+ /**
2915
+ * Likes or upvotes when the post was ingested; null when the platform does not report them.
2916
+ */
2917
+ likes: number | null;
2918
+ /**
2919
+ * Reposts or shares when ingested; null when not reported.
2920
+ */
2921
+ reposts: number | null;
2922
+ /**
2923
+ * Replies or comments when ingested; null when not reported.
2924
+ */
2925
+ replies: number | null;
2926
+ /**
2927
+ * Quotes when ingested; null when not reported.
2928
+ */
2929
+ quotes: number | null;
2930
+ /**
2931
+ * Views when ingested; null when not reported.
2932
+ */
2933
+ views: number | null;
2934
+ /**
2935
+ * Bookmarks or saves when ingested; null when not reported.
2936
+ */
2937
+ bookmarks: number | null;
2938
+ } | null;
2939
+ /**
2940
+ * The post or comment this one answers; null for top-level posts.
2941
+ */
2942
+ replyTo: {
2943
+ /**
2944
+ * Parent post author as the platform names them.
2945
+ */
2946
+ author: string | null;
2947
+ /**
2948
+ * Parent post URL.
2949
+ */
2950
+ url: string | null;
2951
+ /**
2952
+ * Parent post text, when the platform gave it.
2953
+ */
2954
+ text: string | null;
2955
+ } | null;
2956
+ };
2957
+ /**
2958
+ * Who posted it; null when the platform gave no author at all.
2959
+ */
2960
+ author: {
2961
+ /**
2962
+ * Person id (aut_...) for GET /v1/people/{id}; null when the account is not in the audience yet.
2963
+ */
2964
+ id: string | null;
2965
+ /**
2966
+ * Display name as the platform reports it.
2967
+ */
2968
+ name: string | null;
2969
+ /**
2970
+ * Platform handle derived from the profile URL, formatted as the platform shows it (@name, u/name); null where the platform has none.
2971
+ */
2972
+ handle: string | null;
2973
+ /**
2974
+ * Profile URL.
2975
+ */
2976
+ url: string | null;
2977
+ /**
2978
+ * Profile picture; null where the platform has none.
2979
+ */
2980
+ avatarUrl: string | null;
2981
+ /**
2982
+ * Follower count as of their newest post; null where the platform has none.
2983
+ */
2984
+ followers: number | null;
2985
+ /**
2986
+ * 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.
2987
+ */
2988
+ influence: number | null;
2989
+ } | null;
2990
+ /**
2991
+ * The verdict, judged against your company profile; null while the result waits for the classifier.
2992
+ */
2993
+ classification: {
2994
+ /**
2995
+ * 0 to 100; null only when classification failed.
2996
+ */
2997
+ relevance: number | null;
2998
+ /**
2999
+ * positive, neutral or negative; null when classification failed.
3000
+ */
3001
+ sentiment: 'positive' | 'neutral' | 'negative';
3002
+ /**
3003
+ * Intent and topic tags:
3004
+ *
3005
+ * - buy_intent, question, complaint, praise, comparison, bug_report, pricing, hiring, event, promotional.
3006
+ * - churn_intent: leaving or replacing the keyword.
3007
+ * - testimonial: a customer vouching for it from their own use.
3008
+ * - industry_insight: analysis or data about the field.
3009
+ * - launch: a product or feature launch announcement.
3010
+ * - feedback: a suggestion or request about it.
3011
+ */
3012
+ intents: Array<string>;
3013
+ /**
3014
+ * The post reads as machine-made (a bot or app account, a scheduled or templated post, an AI-written summary). A label only: it stays in the feed, delivered and billed as usual. false while unjudged.
3015
+ */
3016
+ automated: boolean;
3017
+ /**
3018
+ * The language the post is written in, as an ISO 639-1 code (en, es, de); null when unknown, not one of the 20 the classifier names, or classified before languages were recorded.
3019
+ */
3020
+ language: string | null;
3021
+ /**
3022
+ * How sure the classifier is of its relevance verdict, 0 to 1. null when the verdict came without one: the fallback model judged, or the row was scored before confidence was recorded.
3023
+ */
3024
+ confidence: number | null;
3025
+ /**
3026
+ * One sentence from the classifier explaining the score.
3027
+ */
3028
+ note: string | null;
3029
+ /**
3030
+ * true when the model could not score this post; it is not billed.
3031
+ */
3032
+ failed: boolean;
3033
+ } | null;
3034
+ /**
3035
+ * Scored at or above the relevance line (40).
3036
+ */
3037
+ relevant: boolean;
3038
+ /**
3039
+ * The same post is already one of your mentions (a keyword of yours matched it).
3040
+ */
3041
+ alreadyInWorkspace: boolean;
3042
+ /**
3043
+ * When the search stored it.
3044
+ */
3045
+ createdAt: string;
3046
+ };
2738
3047
  type Automation = {
2739
3048
  /**
2740
3049
  * Automation id (atm_...).
@@ -3655,13 +3964,21 @@ type UsageBreakdown = {
3655
3964
  */
3656
3965
  commentCents: number;
3657
3966
  /**
3658
- * keywordCents plus mentionCents plus commentCents.
3967
+ * keywordCents, mentionCents and commentCents, plus searchCents when the report is not filtered: then the window's whole list price. The rows carry keyword spend only.
3659
3968
  */
3660
3969
  totalCents: number;
3661
3970
  /**
3662
- * What the ledger has debited for the window's days, by the day each debit settled, for the whole workspace whatever the filters. Lags totalCents by unsettled mentions; see [The ledger](/billing#the-ledger).
3971
+ * What the ledger has debited for the window's days, by the day each debit settled, for the whole workspace whatever the filters, on-demand searches included. Lags totalCents by unsettled mentions; see [The ledger](/billing#the-ledger).
3663
3972
  */
3664
3973
  ledgerDebitCents: number;
3974
+ /**
3975
+ * On-demand search results billed in the window (scored then), for the whole workspace whatever the filters.
3976
+ */
3977
+ searchResults: number;
3978
+ /**
3979
+ * searchResults at $0.008 each, in totals.totalCents when the report is not filtered (never in a row: rows are keyword spend).
3980
+ */
3981
+ searchCents: number;
3665
3982
  /**
3666
3983
  * Billed mentions whose match row is gone (deleted keyword), so no platform or keyword row claims them; charged all the same. Comments never are (by=group puts a deleted keyword's comments on the no-group row).
3667
3984
  */
@@ -3885,9 +4202,9 @@ type LedgerList = {
3885
4202
  */
3886
4203
  id: string;
3887
4204
  /**
3888
- * signup_credit, topup, refund, debit_keyword_days, debit_mentions, debit_comments or adjustment.
4205
+ * signup_credit, topup, refund, debit_keyword_days, debit_mentions, debit_comments, debit_searches (on-demand search results) or adjustment.
3889
4206
  */
3890
- kind: 'signup_credit' | 'topup' | 'refund' | 'debit_keyword_days' | 'debit_mentions' | 'debit_comments' | 'adjustment';
4207
+ kind: 'signup_credit' | 'topup' | 'refund' | 'debit_keyword_days' | 'debit_mentions' | 'debit_comments' | 'debit_searches' | 'adjustment';
3891
4208
  /**
3892
4209
  * Integer USD cents; credits positive, debits negative.
3893
4210
  */
@@ -6895,43 +7212,330 @@ type UpdateFiltersData = {
6895
7212
  */
6896
7213
  subreddits?: {
6897
7214
  /**
6898
- * Replaces the allowlist; [] clears it.
7215
+ * Replaces the allowlist; [] clears it.
7216
+ */
7217
+ only?: Array<string>;
7218
+ /**
7219
+ * Replaces the deny list; [] clears it.
7220
+ */
7221
+ excluded?: Array<string>;
7222
+ };
7223
+ };
7224
+ path?: never;
7225
+ query?: never;
7226
+ url: '/v1/filters';
7227
+ };
7228
+ type UpdateFiltersErrors = {
7229
+ /**
7230
+ * An entry is not a term, an author, a repository or a subreddit
7231
+ */
7232
+ 400: ErrorResponse;
7233
+ /**
7234
+ * Missing or invalid API key
7235
+ */
7236
+ 401: ErrorResponse;
7237
+ };
7238
+ type UpdateFiltersError = UpdateFiltersErrors[keyof UpdateFiltersErrors];
7239
+ type UpdateFiltersResponses = {
7240
+ /**
7241
+ * The updated filters
7242
+ */
7243
+ 200: WorkspaceFilters;
7244
+ };
7245
+ type UpdateFiltersResponse = UpdateFiltersResponses[keyof UpdateFiltersResponses];
7246
+ type UpdateMentionsData = {
7247
+ body: {
7248
+ /**
7249
+ * Mention ids (mm_...), 1 to 100: a page of GET /v1/mentions. Send ids or filter, never both.
7250
+ */
7251
+ ids?: Array<string>;
7252
+ /**
7253
+ * Instead of ids: act on every mention these filters select, up to 1000 a call, newest first. While nextCursor comes back, call again with the same filter and that cursor; the set is fixed when the first call runs, so mentions arriving meanwhile are left alone.
7254
+ */
7255
+ filter?: {
7256
+ /**
7257
+ * Deprecated: use keywordIds. Only matches of this keyword; combines with keywordIds as either.
7258
+ *
7259
+ * @deprecated
7260
+ */
7261
+ keywordId?: string;
7262
+ /**
7263
+ * Deprecated: use platforms. Only posts from this platform; combines with platforms as either.
7264
+ *
7265
+ * @deprecated
7266
+ */
7267
+ platform?: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
7268
+ /**
7269
+ * Only mentions in this status. Omit for every status.
7270
+ */
7271
+ status?: 'open' | 'ignored' | 'done';
7272
+ /**
7273
+ * true: only mentions the classifier scored relevant; false: only the rest (unclassified included).
7274
+ */
7275
+ relevant?: boolean;
7276
+ /**
7277
+ * Deprecated: use sentiments. Only this sentiment; combines with sentiments as either.
7278
+ *
7279
+ * @deprecated
7280
+ */
7281
+ sentiment?: 'positive' | 'neutral' | 'negative';
7282
+ /**
7283
+ * Deprecated: use intents. Only mentions carrying this intent or topic tag, combined with intents as either (buy_intent, question, complaint, praise, comparison, churn_intent, bug_report, pricing, hiring, event, promotional, testimonial, industry_insight, launch, feedback).
7284
+ *
7285
+ * @deprecated
7286
+ */
7287
+ intent?: string;
7288
+ /**
7289
+ * true: only mentions that read as machine-made (a bot account, a scheduled or templated post, AI-written text); false: only the rest, mentions judged before this existed included. Omitted: everything.
7290
+ */
7291
+ automated?: boolean;
7292
+ /**
7293
+ * true: only posts by companies, brands and organizations (a LinkedIn company page, a GitHub organization, a business account); false: only posts by people, mentions judged before this existed included. Omitted: everything.
7294
+ */
7295
+ organization?: boolean;
7296
+ /**
7297
+ * Only this person (an id from /v1/people), merged accounts included. Implies includeMuted.
7298
+ */
7299
+ personId?: string;
7300
+ /**
7301
+ * true: include mentions by people you muted, hidden by default: muted for the workspace, or for the mention's own keyword group.
7302
+ */
7303
+ includeMuted?: boolean;
7304
+ /**
7305
+ * true: include mentions their keyword's display lists hide (a language or country it does not show), hidden by default.
7306
+ */
7307
+ includeHidden?: boolean;
7308
+ /**
7309
+ * true: list cross-posts (a mention whose duplicateOf is set) as mentions of their own. By default each is listed only in its original's duplicates.
7310
+ */
7311
+ includeDuplicates?: boolean;
7312
+ /**
7313
+ * Only mentions assigned to this workspace member (user id).
7314
+ */
7315
+ assigneeId?: string;
7316
+ /**
7317
+ * true: only mentions currently snoozed. Otherwise snoozed mentions stay out until they wake.
7318
+ */
7319
+ snoozed?: boolean;
7320
+ /**
7321
+ * Hide these authors: display names, handles or profile URLs. Repeatable, or one comma-separated value.
7322
+ */
7323
+ notAuthors?: Array<string> | null;
7324
+ /**
7325
+ * Deprecated: use notAuthors, the same filter. Both may be sent; every author named in either is hidden.
7326
+ *
7327
+ * @deprecated
7328
+ */
7329
+ excludeAuthors?: Array<string> | null;
7330
+ /**
7331
+ * Only mentions scored at least this; unclassified ones are excluded.
7332
+ */
7333
+ minRelevance?: number | null;
7334
+ /**
7335
+ * Only mentions whose classifier confidence is at least this, 0 to 1. Mentions without a confidence are excluded.
7336
+ */
7337
+ minConfidence?: number | null;
7338
+ /**
7339
+ * Only authors with at least this many followers. Unknown reach never passes.
7340
+ */
7341
+ minFollowers?: number | null;
7342
+ /**
7343
+ * Only authors with at most this many followers. Unknown reach never passes.
7344
+ */
7345
+ maxFollowers?: number | null;
7346
+ /**
7347
+ * Only posts (post), only comments (comment) or only GitHub repository events (repository). Omitted: all.
7348
+ */
7349
+ kind?: 'post' | 'comment' | 'repository';
7350
+ /**
7351
+ * true: only replies and comments (posts answering another post); false: only top-level posts. Omitted: both.
7352
+ */
7353
+ isReply?: boolean;
7354
+ /**
7355
+ * Apply an alert rule's filter (an id from GET /v1/alerts) on top of the other filters: the same mentions the rule would send, for a feed-shaped export or a preview. Unknown ids are a 404.
7356
+ */
7357
+ alertId?: string;
7358
+ /**
7359
+ * Apply a saved view's filter (an id from GET /v1/views) on top of the other filters, every condition ANDed: exactly what the view selects. Unknown ids are a 404.
7360
+ */
7361
+ viewId?: string;
7362
+ /**
7363
+ * Only matches of keywords of any of these kinds: brand, competitor, topic. Repeatable, or comma-separated.
7364
+ */
7365
+ keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
7366
+ /**
7367
+ * Never matches of keywords of these kinds. Repeatable, or comma-separated.
7368
+ */
7369
+ notKeywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
7370
+ /**
7371
+ * Only authors tagged with any of these (exact, case-sensitive), in the workspace's tags or those of the mention's own keyword group. Repeatable, or comma-separated.
7372
+ */
7373
+ tags?: Array<string> | null;
7374
+ /**
7375
+ * Only posts linking to any of these hosts, the host itself or a subdomain of it (octolens.com also matches blog.octolens.com). Repeatable, or comma-separated.
7376
+ */
7377
+ linkHosts?: Array<string> | null;
7378
+ /**
7379
+ * Only posts from any of these platforms.
7380
+ */
7381
+ platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
7382
+ /**
7383
+ * Never posts from these platforms.
7384
+ */
7385
+ notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
7386
+ /**
7387
+ * Only matches of any of these keywords.
7388
+ */
7389
+ keywordIds?: Array<string> | null;
7390
+ /**
7391
+ * Only matches of keywords in any of these groups (grp_...). Repeatable, or comma-separated.
7392
+ */
7393
+ groupIds?: Array<string> | null;
7394
+ /**
7395
+ * Never matches of keywords in these groups.
7396
+ */
7397
+ notGroupIds?: Array<string> | null;
7398
+ /**
7399
+ * Never matches of these keywords.
7400
+ */
7401
+ notKeywordIds?: Array<string> | null;
7402
+ /**
7403
+ * Only these sentiments.
7404
+ */
7405
+ sentiments?: Array<'positive' | 'neutral' | 'negative'>;
7406
+ /**
7407
+ * Never these sentiments. A mention the classifier has not scored yet still passes.
7408
+ */
7409
+ notSentiments?: Array<'positive' | 'neutral' | 'negative'>;
7410
+ /**
7411
+ * 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.
7412
+ */
7413
+ emotions?: Array<'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral'>;
7414
+ /**
7415
+ * Never these emotions. A mention whose emotion was not judged still passes.
7416
+ */
7417
+ notEmotions?: Array<'joy' | 'trust' | 'anticipation' | 'surprise' | 'confusion' | 'frustration' | 'anger' | 'fear' | 'sadness' | 'neutral'>;
7418
+ /**
7419
+ * Only mentions carrying any of these intent or topic tags.
7420
+ */
7421
+ intents?: Array<string> | null;
7422
+ /**
7423
+ * Never mentions carrying these intent or topic tags.
7424
+ */
7425
+ notIntents?: Array<string> | null;
7426
+ /**
7427
+ * Never posts linking to these hosts, the host itself or a subdomain of it.
7428
+ */
7429
+ notLinkHosts?: Array<string> | null;
7430
+ /**
7431
+ * Only Reddit posts from any of these subreddits: subreddits=SaaS,startups (names without the r/, any case). Every other post fails it. Repeatable, or comma-separated.
7432
+ */
7433
+ subreddits?: Array<string> | null;
7434
+ /**
7435
+ * Never Reddit posts from these subreddits; posts from other platforms still pass.
7436
+ */
7437
+ notSubreddits?: Array<string> | null;
7438
+ /**
7439
+ * Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
7440
+ */
7441
+ notTags?: Array<string> | null;
7442
+ /**
7443
+ * Only mentions carrying any of these labels (exact, case-sensitive). Repeatable, or comma-separated.
7444
+ */
7445
+ labels?: Array<string> | null;
7446
+ /**
7447
+ * Never mentions carrying any of these labels. Repeatable, or comma-separated.
7448
+ */
7449
+ notLabels?: Array<string> | null;
7450
+ /**
7451
+ * Only posts in any of these languages (ISO 639-1: en, es, de). A post whose language is unknown never passes.
7452
+ */
7453
+ languages?: Array<string>;
7454
+ /**
7455
+ * Never posts in these languages. A post whose language is unknown still passes.
7456
+ */
7457
+ notLanguages?: Array<string>;
7458
+ /**
7459
+ * Only posts whose author is in any of these countries (ISO 3166-1 alpha-2: us, in, de), as the classifier read the author's profile and the post. A post whose country is unknown never passes.
7460
+ */
7461
+ 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'>;
7462
+ /**
7463
+ * Never posts whose author is in these countries: notCountries=in. A post whose country is unknown still passes.
7464
+ */
7465
+ 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'>;
7466
+ /**
7467
+ * Only app store reviews with any of these star ratings (1 to 5): ratings=1,2 is the unhappy ones. Every other post fails it.
7468
+ */
7469
+ ratings?: Array<number>;
7470
+ /**
7471
+ * Never reviews with these star ratings (1 to 5): notRatings=5 hides the five star reviews. Posts that are not reviews still pass.
7472
+ */
7473
+ notRatings?: Array<number>;
7474
+ /**
7475
+ * 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.
7476
+ */
7477
+ minLikes?: number | null;
7478
+ /**
7479
+ * 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.
7480
+ */
7481
+ minReposts?: number | null;
7482
+ /**
7483
+ * 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.
7484
+ */
7485
+ minReplies?: number | null;
7486
+ /**
7487
+ * 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.
7488
+ */
7489
+ minQuotes?: number | null;
7490
+ /**
7491
+ * 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.
7492
+ */
7493
+ minViews?: number | null;
7494
+ /**
7495
+ * 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.
6899
7496
  */
6900
- only?: Array<string>;
7497
+ minBookmarks?: number | null;
6901
7498
  /**
6902
- * Replaces the deny list; [] clears it.
7499
+ * OR across groups of conditions, as URL-encoded JSON: a mention passes when one group holds, on top of every other filter. Each group holds view-filter conditions, no nesting. See [anyOf](/conventions#or-across-groups-anyof).
6903
7500
  */
6904
- excluded?: Array<string>;
7501
+ anyOf?: string;
7502
+ /**
7503
+ * Substring search in the post text or the author's name.
7504
+ */
7505
+ q?: string;
7506
+ /**
7507
+ * A preset window ending now: 7d is today and the six days before, in `timezone`, as in the analytics reports. Ignored when from or to is given. Omit range, from and to for no window.
7508
+ */
7509
+ range?: '7d' | '30d' | '90d' | '365d';
7510
+ /**
7511
+ * Start, inclusive: a day (YYYY-MM-DD, from its first moment in `timezone`) or an instant (ISO 8601 with its offset, or epoch ms).
7512
+ */
7513
+ from?: string;
7514
+ /**
7515
+ * End, inclusive: a day (YYYY-MM-DD, to its last moment in `timezone`) or an instant (ISO 8601 with its offset, or epoch ms).
7516
+ */
7517
+ to?: string;
7518
+ /**
7519
+ * IANA zone that days in range, from and to are cut in (Europe/Madrid). Default UTC.
7520
+ */
7521
+ timezone?: string;
7522
+ /**
7523
+ * Deprecated: use from. Only posts published at or after this instant (ISO 8601, or epoch ms).
7524
+ *
7525
+ * @deprecated
7526
+ */
7527
+ since?: string;
7528
+ /**
7529
+ * Deprecated: use to. Only posts published at or before this instant (ISO 8601, or epoch ms).
7530
+ *
7531
+ * @deprecated
7532
+ */
7533
+ until?: string;
6905
7534
  };
6906
- };
6907
- path?: never;
6908
- query?: never;
6909
- url: '/v1/filters';
6910
- };
6911
- type UpdateFiltersErrors = {
6912
- /**
6913
- * An entry is not a term, an author, a repository or a subreddit
6914
- */
6915
- 400: ErrorResponse;
6916
- /**
6917
- * Missing or invalid API key
6918
- */
6919
- 401: ErrorResponse;
6920
- };
6921
- type UpdateFiltersError = UpdateFiltersErrors[keyof UpdateFiltersErrors];
6922
- type UpdateFiltersResponses = {
6923
- /**
6924
- * The updated filters
6925
- */
6926
- 200: WorkspaceFilters;
6927
- };
6928
- type UpdateFiltersResponse = UpdateFiltersResponses[keyof UpdateFiltersResponses];
6929
- type UpdateMentionsData = {
6930
- body: {
6931
7535
  /**
6932
- * Mention ids (mm_...), 1 to 100: a page of GET /v1/mentions.
7536
+ * With filter only: nextCursor from the previous call, to carry on where it stopped.
6933
7537
  */
6934
- ids: Array<string>;
7538
+ cursor?: string;
6935
7539
  /**
6936
7540
  * Every field is optional, at least one is required; omitted fields are untouched.
6937
7541
  */
@@ -6966,13 +7570,17 @@ type UpdateMentionsData = {
6966
7570
  };
6967
7571
  type UpdateMentionsErrors = {
6968
7572
  /**
6969
- * Invalid request (an empty update, more than 100 ids), or invalid_assignee: the assignee is not a workspace member
7573
+ * Invalid request (an empty update, more than 100 ids, both or neither of ids and filter, a filter too complex, an invalid cursor), or invalid_assignee: the assignee is not a workspace member
6970
7574
  */
6971
7575
  400: ErrorResponse;
6972
7576
  /**
6973
7577
  * Missing or invalid API key
6974
7578
  */
6975
7579
  401: ErrorResponse;
7580
+ /**
7581
+ * The filter names an alert rule or view that does not exist
7582
+ */
7583
+ 404: ErrorResponse;
6976
7584
  };
6977
7585
  type UpdateMentionsError = UpdateMentionsErrors[keyof UpdateMentionsErrors];
6978
7586
  type UpdateMentionsResponses = {
@@ -10349,6 +10957,278 @@ type UpdateViewResponses = {
10349
10957
  200: View;
10350
10958
  };
10351
10959
  type UpdateViewResponse = UpdateViewResponses[keyof UpdateViewResponses];
10960
+ type ListSearchesData = {
10961
+ body?: never;
10962
+ path?: never;
10963
+ query?: {
10964
+ /**
10965
+ * Page size, 1 to 100.
10966
+ */
10967
+ limit?: number;
10968
+ /**
10969
+ * nextCursor from the previous page.
10970
+ */
10971
+ cursor?: string;
10972
+ };
10973
+ url: '/v1/searches';
10974
+ };
10975
+ type ListSearchesErrors = {
10976
+ /**
10977
+ * Invalid query or pagination cursor
10978
+ */
10979
+ 400: ErrorResponse;
10980
+ /**
10981
+ * Missing or invalid API key
10982
+ */
10983
+ 401: ErrorResponse;
10984
+ };
10985
+ type ListSearchesError = ListSearchesErrors[keyof ListSearchesErrors];
10986
+ type ListSearchesResponses = {
10987
+ /**
10988
+ * Searches
10989
+ */
10990
+ 200: {
10991
+ /**
10992
+ * Searches, newest first.
10993
+ */
10994
+ data: Array<{
10995
+ /**
10996
+ * Search id (srch_...).
10997
+ */
10998
+ id: string;
10999
+ /**
11000
+ * The term searched, as typed.
11001
+ */
11002
+ term: string;
11003
+ /**
11004
+ * How far back the search reads, ending now: 24h, 7d or 30d. Instagram reads at most its last 7 days whatever the range.
11005
+ */
11006
+ range: '24h' | '7d' | '30d';
11007
+ /**
11008
+ * brand, competitor or topic: what the classifier was told the term is.
11009
+ */
11010
+ kind: 'brand' | 'competitor' | 'topic';
11011
+ /**
11012
+ * The hint the classifier read, or null.
11013
+ */
11014
+ context: string | null;
11015
+ /**
11016
+ * queued: accepted, nothing read yet. running: platforms being read or results scored. done: every platform reported and every result scored. failed: no platform could be read.
11017
+ */
11018
+ status: 'queued' | 'running' | 'done' | 'failed';
11019
+ /**
11020
+ * The start of the window read (the end is createdAt).
11021
+ */
11022
+ from: string;
11023
+ /**
11024
+ * One entry per platform asked for, in the order asked.
11025
+ */
11026
+ platforms: Array<{
11027
+ /**
11028
+ * Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, facebook, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place), rss (RSS and Atom feeds a keyword reads).
11029
+ */
11030
+ platform: 'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss';
11031
+ /**
11032
+ * queued: not read yet. running: being read or scored. done: read and scored. skipped: not read (see reason). failed: the read failed (see reason).
11033
+ */
11034
+ status: 'queued' | 'running' | 'done' | 'skipped' | 'failed';
11035
+ /**
11036
+ * Why a platform was skipped or failed: unsupported (no term search on it), credentials (not connected on this deployment), budget (its monthly vendor budget is spent), rate_limited, error, timeout. null otherwise.
11037
+ */
11038
+ reason: 'unsupported' | 'credentials' | 'budget' | 'rate_limited' | 'error' | 'timeout';
11039
+ /**
11040
+ * Results stored for this platform, at most 25.
11041
+ */
11042
+ results: number;
11043
+ /**
11044
+ * Of them, scored relevant (40 or more).
11045
+ */
11046
+ relevant: number;
11047
+ }>;
11048
+ /**
11049
+ * Counts across platforms.
11050
+ */
11051
+ stats: {
11052
+ /**
11053
+ * Results stored.
11054
+ */
11055
+ results: number;
11056
+ /**
11057
+ * Results scored (the rest wait or failed).
11058
+ */
11059
+ scored: number;
11060
+ /**
11061
+ * Results scored relevant (40 or more).
11062
+ */
11063
+ relevant: number;
11064
+ };
11065
+ /**
11066
+ * What the search has cost so far: $0.008 per scored result, rounded to the cent. A result the classifier could not score costs nothing.
11067
+ */
11068
+ costCents: number;
11069
+ /**
11070
+ * The most it can cost: 25 results for each platform read, at $0.008 each. The wallet had to cover it when the search started.
11071
+ */
11072
+ maxCostCents: number;
11073
+ /**
11074
+ * When the search was started.
11075
+ */
11076
+ createdAt: string;
11077
+ /**
11078
+ * When it reached done or failed; null while it runs.
11079
+ */
11080
+ completedAt: string | null;
11081
+ }>;
11082
+ /**
11083
+ * Pass as cursor for the next page; null on the last page.
11084
+ */
11085
+ nextCursor: string | null;
11086
+ };
11087
+ };
11088
+ type ListSearchesResponse = ListSearchesResponses[keyof ListSearchesResponses];
11089
+ type CreateSearchData = {
11090
+ body: {
11091
+ /**
11092
+ * The word or phrase to search, case-insensitive, matched as the phrase (written joined or as a hashtag counts). Quotes are not needed.
11093
+ */
11094
+ term: string;
11095
+ /**
11096
+ * How far back the search reads, ending now: 24h, 7d or 30d. Instagram reads at most its last 7 days whatever the range.
11097
+ */
11098
+ range?: '24h' | '7d' | '30d';
11099
+ /**
11100
+ * The platforms to read; omit for every platform that can search a term back in time (bluesky, hackernews, github, stackoverflow, reddit, x, youtube, linkedin, tiktok, instagram, facebook). devto and news have no search and are reported as skipped.
11101
+ */
11102
+ platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook'>;
11103
+ /**
11104
+ * What the term is to you, as on a keyword: brand (your company or product), competitor, or topic (the default). The classifier judges relevance with it.
11105
+ */
11106
+ kind?: 'brand' | 'competitor' | 'topic';
11107
+ /**
11108
+ * A sentence the classifier reads for this search only, on top of the company profile: what the term means here, what to ignore.
11109
+ */
11110
+ context?: string;
11111
+ };
11112
+ headers?: {
11113
+ /**
11114
+ * A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
11115
+ */
11116
+ 'idempotency-key'?: string;
11117
+ };
11118
+ path?: never;
11119
+ query?: never;
11120
+ url: '/v1/searches';
11121
+ };
11122
+ type CreateSearchErrors = {
11123
+ /**
11124
+ * Invalid body, or no platform asked for can be searched back in time (validation_error)
11125
+ */
11126
+ 400: ErrorResponse;
11127
+ /**
11128
+ * Missing or invalid API key
11129
+ */
11130
+ 401: ErrorResponse;
11131
+ /**
11132
+ * The workspace never topped up (funding_required), or the balance does not cover the most this search can cost (insufficient_balance)
11133
+ */
11134
+ 402: ErrorResponse;
11135
+ /**
11136
+ * More than 10 searches in the last hour (rate_limited); Retry-After says when
11137
+ */
11138
+ 429: ErrorResponse;
11139
+ };
11140
+ type CreateSearchError = CreateSearchErrors[keyof CreateSearchErrors];
11141
+ type CreateSearchResponses = {
11142
+ /**
11143
+ * The search, queued
11144
+ */
11145
+ 201: Search;
11146
+ };
11147
+ type CreateSearchResponse = CreateSearchResponses[keyof CreateSearchResponses];
11148
+ type GetSearchData = {
11149
+ body?: never;
11150
+ path: {
11151
+ /**
11152
+ * Search id (srch_...).
11153
+ */
11154
+ id: string;
11155
+ };
11156
+ query?: never;
11157
+ url: '/v1/searches/{id}';
11158
+ };
11159
+ type GetSearchErrors = {
11160
+ /**
11161
+ * Missing or invalid API key
11162
+ */
11163
+ 401: ErrorResponse;
11164
+ /**
11165
+ * No such search in this workspace
11166
+ */
11167
+ 404: ErrorResponse;
11168
+ };
11169
+ type GetSearchError = GetSearchErrors[keyof GetSearchErrors];
11170
+ type GetSearchResponses = {
11171
+ /**
11172
+ * The search
11173
+ */
11174
+ 200: Search;
11175
+ };
11176
+ type GetSearchResponse = GetSearchResponses[keyof GetSearchResponses];
11177
+ type ListSearchResultsData = {
11178
+ body?: never;
11179
+ path: {
11180
+ /**
11181
+ * Search id (srch_...).
11182
+ */
11183
+ id: string;
11184
+ };
11185
+ query?: {
11186
+ /**
11187
+ * Page size, 1 to 100.
11188
+ */
11189
+ limit?: number;
11190
+ /**
11191
+ * nextCursor from the previous page.
11192
+ */
11193
+ cursor?: string;
11194
+ /**
11195
+ * Only results scored at least this relevant (0 to 100); unscored results are left out when set.
11196
+ */
11197
+ minRelevance?: number | null;
11198
+ };
11199
+ url: '/v1/searches/{id}/results';
11200
+ };
11201
+ type ListSearchResultsErrors = {
11202
+ /**
11203
+ * Invalid query or pagination cursor
11204
+ */
11205
+ 400: ErrorResponse;
11206
+ /**
11207
+ * Missing or invalid API key
11208
+ */
11209
+ 401: ErrorResponse;
11210
+ /**
11211
+ * No such search in this workspace
11212
+ */
11213
+ 404: ErrorResponse;
11214
+ };
11215
+ type ListSearchResultsError = ListSearchResultsErrors[keyof ListSearchResultsErrors];
11216
+ type ListSearchResultsResponses = {
11217
+ /**
11218
+ * Results
11219
+ */
11220
+ 200: {
11221
+ /**
11222
+ * Results, newest post first.
11223
+ */
11224
+ data: Array<SearchResult>;
11225
+ /**
11226
+ * Pass as cursor for the next page; null on the last page.
11227
+ */
11228
+ nextCursor: string | null;
11229
+ };
11230
+ };
11231
+ type ListSearchResultsResponse = ListSearchResultsResponses[keyof ListSearchResultsResponses];
10352
11232
  type ListAutomationsData = {
10353
11233
  body?: never;
10354
11234
  path?: never;
@@ -13988,10 +14868,10 @@ declare const updateFilters: <ThrowOnError extends boolean = false>(options: Opt
13988
14868
  /**
13989
14869
  * Update many mentions
13990
14870
  *
13991
- * Change up to 100 mentions at once: status, assignee, labels to add or remove.
14871
+ * Change many mentions at once: status, assignee, labels to add or remove. Name them by `ids` (up to 100), or by `filter` to act on everything the mentions list would show (Mark all as done).
13992
14872
  *
13993
- * - All of it lands, or none of it.
13994
- * - Unknown ids come back in `notFound`.
14873
+ * - By ids, all of it lands or none of it; unknown ids come back in `notFound`.
14874
+ * - By filter, up to 1,000 a call, newest first: while `nextCursor` comes back, call again with the same filter and that cursor. Mentions matched after the first call are left alone.
13995
14875
  * - Removals run before additions. See [Labels and automations](/guides/labels).
13996
14876
  */
13997
14877
  declare const updateMentions: <ThrowOnError extends boolean = false>(options: Options<UpdateMentionsData, ThrowOnError>) => RequestResult<UpdateMentionsResponses, UpdateMentionsErrors, ThrowOnError>;
@@ -14203,6 +15083,36 @@ declare const getView: <ThrowOnError extends boolean = false>(options: Options<G
14203
15083
  * Rename, describe or refilter a view. `filter` replaces the whole filter.
14204
15084
  */
14205
15085
  declare const updateView: <ThrowOnError extends boolean = false>(options: Options<UpdateViewData, ThrowOnError>) => RequestResult<UpdateViewResponses, UpdateViewErrors, ThrowOnError>;
15086
+ /**
15087
+ * List searches
15088
+ *
15089
+ * The workspace's searches, newest first, kept for 30 days.
15090
+ */
15091
+ declare const listSearches: <ThrowOnError extends boolean = false>(options?: Options<ListSearchesData, ThrowOnError>) => RequestResult<ListSearchesResponses, ListSearchesErrors, ThrowOnError>;
15092
+ /**
15093
+ * Start a search
15094
+ *
15095
+ * Search a term over the last 24 hours, 7 or 30 days, without a keyword.
15096
+ *
15097
+ * - Results are scored and kept apart from your mentions.
15098
+ * - $0.008 per scored result; the balance must cover `maxCostCents`.
15099
+ * - See [Search](/guides/search).
15100
+ */
15101
+ declare const createSearch: <ThrowOnError extends boolean = false>(options: Options<CreateSearchData, ThrowOnError>) => RequestResult<CreateSearchResponses, CreateSearchErrors, ThrowOnError>;
15102
+ /**
15103
+ * Get a search
15104
+ *
15105
+ * Its status, each platform's progress and counts, and what it cost so far.
15106
+ */
15107
+ declare const getSearch: <ThrowOnError extends boolean = false>(options: Options<GetSearchData, ThrowOnError>) => RequestResult<GetSearchResponses, GetSearchErrors, ThrowOnError>;
15108
+ /**
15109
+ * List a search's results
15110
+ *
15111
+ * The posts the search found, newest first, with their verdicts.
15112
+ *
15113
+ * A verdict is null while it waits; `alreadyInWorkspace` says the post is already one of your mentions. Readable while the search runs.
15114
+ */
15115
+ declare const listSearchResults: <ThrowOnError extends boolean = false>(options: Options<ListSearchResultsData, ThrowOnError>) => RequestResult<ListSearchResultsResponses, ListSearchResultsErrors, ThrowOnError>;
14206
15116
  /**
14207
15117
  * List automations
14208
15118
  *
@@ -14560,6 +15470,7 @@ declare const sdk_createFeed: typeof createFeed;
14560
15470
  declare const sdk_createGroup: typeof createGroup;
14561
15471
  declare const sdk_createInvitation: typeof createInvitation;
14562
15472
  declare const sdk_createKeyword: typeof createKeyword;
15473
+ declare const sdk_createSearch: typeof createSearch;
14563
15474
  declare const sdk_createSegment: typeof createSegment;
14564
15475
  declare const sdk_createTopUp: typeof createTopUp;
14565
15476
  declare const sdk_createView: typeof createView;
@@ -14594,6 +15505,7 @@ declare const sdk_getKeywordHealth: typeof getKeywordHealth;
14594
15505
  declare const sdk_getMention: typeof getMention;
14595
15506
  declare const sdk_getPerson: typeof getPerson;
14596
15507
  declare const sdk_getReviewsReport: typeof getReviewsReport;
15508
+ declare const sdk_getSearch: typeof getSearch;
14597
15509
  declare const sdk_getSegment: typeof getSegment;
14598
15510
  declare const sdk_getShareOfVoice: typeof getShareOfVoice;
14599
15511
  declare const sdk_getUsage: typeof getUsage;
@@ -14618,6 +15530,8 @@ declare const sdk_listMembers: typeof listMembers;
14618
15530
  declare const sdk_listMentionComments: typeof listMentionComments;
14619
15531
  declare const sdk_listPeople: typeof listPeople;
14620
15532
  declare const sdk_listPersonActivities: typeof listPersonActivities;
15533
+ declare const sdk_listSearchResults: typeof listSearchResults;
15534
+ declare const sdk_listSearches: typeof listSearches;
14621
15535
  declare const sdk_listSegmentPresets: typeof listSegmentPresets;
14622
15536
  declare const sdk_listSegments: typeof listSegments;
14623
15537
  declare const sdk_listViews: typeof listViews;
@@ -14649,7 +15563,7 @@ declare const sdk_updateSegment: typeof updateSegment;
14649
15563
  declare const sdk_updateView: typeof updateView;
14650
15564
  declare const sdk_whoami: typeof whoami;
14651
15565
  declare namespace sdk {
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 };
15566
+ 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_createSearch as createSearch, 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_getSearch as getSearch, 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_listSearchResults as listSearchResults, sdk_listSearches as listSearches, 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 };
14653
15567
  }
14654
15568
 
14655
15569
  /**
@@ -14677,4 +15591,4 @@ type Mentio = typeof sdk & {
14677
15591
  };
14678
15592
  declare function createMentio(options: MentioOptions): Mentio;
14679
15593
 
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 };
15594
+ 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 CreateSearchData, type CreateSearchError, type CreateSearchErrors, type CreateSearchResponse, type CreateSearchResponses, 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 GetSearchData, type GetSearchError, type GetSearchErrors, type GetSearchResponse, type GetSearchResponses, 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 ListSearchResultsData, type ListSearchResultsError, type ListSearchResultsErrors, type ListSearchResultsResponse, type ListSearchResultsResponses, type ListSearchesData, type ListSearchesError, type ListSearchesErrors, type ListSearchesResponse, type ListSearchesResponses, 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 Search, type SearchMentionsData, type SearchMentionsError, type SearchMentionsErrors, type SearchMentionsResponse, type SearchMentionsResponses, type SearchResult, 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, createSearch, 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, getSearch, getSegment, getShareOfVoice, getUsage, getUsageBreakdown, getView, getWallet, importFeeds, listAlerts, listApiKeys, listAttention, listAutomations, listChannelDeliveries, listChannels, listFeeds, listGroups, listInvitations, listInvoices, listKeywords, listLabels, listLedger, listMembers, listMentionComments, listPeople, listPersonActivities, listSearchResults, listSearches, 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 };