@mentio-dev/sdk 0.13.6 → 0.14.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 +827 -23
- package/dist/index.js +54 -0
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -460,6 +460,37 @@ type Keyword = {
|
|
|
460
460
|
*/
|
|
461
461
|
maxPerPost: number;
|
|
462
462
|
};
|
|
463
|
+
/**
|
|
464
|
+
* Which of this keyword's mentions you see, by language and country. Both are read by the classifier, so a hidden post is still matched, classified and billed like any other; it is kept out of the mentions list, the exports, MCP search, alerts and digests (includeHidden=true on GET /v1/mentions shows it). Read when the mentions are read, so changing a list applies to older mentions too.
|
|
465
|
+
*/
|
|
466
|
+
display: {
|
|
467
|
+
/**
|
|
468
|
+
* By the language the post is written in.
|
|
469
|
+
*/
|
|
470
|
+
languages: {
|
|
471
|
+
/**
|
|
472
|
+
* When non-empty, a post whose language (ISO 639-1) is known and not listed is hidden, a language (ISO 639-1) the classifier recognises but does not name included. A post whose language (ISO 639-1) nobody could tell is always shown.
|
|
473
|
+
*/
|
|
474
|
+
only: Array<'en' | 'es' | 'de' | 'fr' | 'pt' | 'it' | 'nl' | 'ca' | 'pl' | 'tr' | 'sv' | 'da' | 'ru' | 'uk' | 'ar' | 'hi' | 'id' | 'ja' | 'zh' | 'ko'>;
|
|
475
|
+
/**
|
|
476
|
+
* A post whose language (ISO 639-1) is listed is hidden.
|
|
477
|
+
*/
|
|
478
|
+
excluded: Array<'en' | 'es' | 'de' | 'fr' | 'pt' | 'it' | 'nl' | 'ca' | 'pl' | 'tr' | 'sv' | 'da' | 'ru' | 'uk' | 'ar' | 'hi' | 'id' | 'ja' | 'zh' | 'ko'>;
|
|
479
|
+
};
|
|
480
|
+
/**
|
|
481
|
+
* By where the author is, as the classifier read their profile and the post.
|
|
482
|
+
*/
|
|
483
|
+
countries: {
|
|
484
|
+
/**
|
|
485
|
+
* When non-empty, a post whose author's country (ISO 3166-1 alpha-2) is known and not listed is hidden, a author's country (ISO 3166-1 alpha-2) the classifier recognises but does not name included. A post whose author's country (ISO 3166-1 alpha-2) nobody could tell is always shown.
|
|
486
|
+
*/
|
|
487
|
+
only: 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'>;
|
|
488
|
+
/**
|
|
489
|
+
* A post whose author's country (ISO 3166-1 alpha-2) is listed is hidden.
|
|
490
|
+
*/
|
|
491
|
+
excluded: 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'>;
|
|
492
|
+
};
|
|
493
|
+
};
|
|
463
494
|
group: GroupRef;
|
|
464
495
|
/**
|
|
465
496
|
* Platforms the term is searched on; null means every platform, [] none (the keyword only collects reviews).
|
|
@@ -469,6 +500,10 @@ type Keyword = {
|
|
|
469
500
|
* RSS and Atom feeds this keyword reads; empty for none.
|
|
470
501
|
*/
|
|
471
502
|
feeds: Array<KeywordFeed>;
|
|
503
|
+
/**
|
|
504
|
+
* true (the default): the keyword also reads every feed of the workspace (GET /v1/feeds), on top of its own `feeds`. false: its own feeds alone.
|
|
505
|
+
*/
|
|
506
|
+
readsWorkspaceFeeds: boolean;
|
|
472
507
|
/**
|
|
473
508
|
* Where this keyword collects reviews from (App Store and Google Play apps, Trustpilot pages, Google Maps places); empty for none.
|
|
474
509
|
*/
|
|
@@ -662,7 +697,7 @@ type ErrorResponse = {
|
|
|
662
697
|
/**
|
|
663
698
|
* 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.
|
|
664
699
|
*/
|
|
665
|
-
code: 'unauthorized' | 'forbidden' | 'read_only_key' | 'validation_error' | 'not_found' | 'invalid_cursor' | 'payload_too_large' | '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' | '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';
|
|
700
|
+
code: 'unauthorized' | 'forbidden' | 'read_only_key' | 'validation_error' | 'not_found' | 'invalid_cursor' | 'payload_too_large' | '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';
|
|
666
701
|
/**
|
|
667
702
|
* Human-readable detail; may change between releases.
|
|
668
703
|
*/
|
|
@@ -803,6 +838,37 @@ type KeywordSuggestion = {
|
|
|
803
838
|
*/
|
|
804
839
|
maxPerPost?: number;
|
|
805
840
|
};
|
|
841
|
+
/**
|
|
842
|
+
* Which of this keyword's mentions you see, by language and country; each list is replaced when sent, kept when omitted. Hidden mentions are still billed.
|
|
843
|
+
*/
|
|
844
|
+
display?: {
|
|
845
|
+
/**
|
|
846
|
+
* By the language of the post (ISO 639-1); omitted: untouched.
|
|
847
|
+
*/
|
|
848
|
+
languages?: {
|
|
849
|
+
/**
|
|
850
|
+
* Replaces the list; [] clears it.
|
|
851
|
+
*/
|
|
852
|
+
only?: Array<'en' | 'es' | 'de' | 'fr' | 'pt' | 'it' | 'nl' | 'ca' | 'pl' | 'tr' | 'sv' | 'da' | 'ru' | 'uk' | 'ar' | 'hi' | 'id' | 'ja' | 'zh' | 'ko'>;
|
|
853
|
+
/**
|
|
854
|
+
* Replaces the list; [] clears it.
|
|
855
|
+
*/
|
|
856
|
+
excluded?: Array<'en' | 'es' | 'de' | 'fr' | 'pt' | 'it' | 'nl' | 'ca' | 'pl' | 'tr' | 'sv' | 'da' | 'ru' | 'uk' | 'ar' | 'hi' | 'id' | 'ja' | 'zh' | 'ko'>;
|
|
857
|
+
};
|
|
858
|
+
/**
|
|
859
|
+
* By where the author is (ISO 3166-1 alpha-2); omitted: untouched.
|
|
860
|
+
*/
|
|
861
|
+
countries?: {
|
|
862
|
+
/**
|
|
863
|
+
* Replaces the list; [] clears it.
|
|
864
|
+
*/
|
|
865
|
+
only?: 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'>;
|
|
866
|
+
/**
|
|
867
|
+
* Replaces the list; [] clears it.
|
|
868
|
+
*/
|
|
869
|
+
excluded?: 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'>;
|
|
870
|
+
};
|
|
871
|
+
};
|
|
806
872
|
/**
|
|
807
873
|
* Moves the keyword to this group (grp_...). A 409 when that group already tracks the term.
|
|
808
874
|
*/
|
|
@@ -841,6 +907,10 @@ type KeywordSuggestion = {
|
|
|
841
907
|
*/
|
|
842
908
|
url: string;
|
|
843
909
|
}>;
|
|
910
|
+
/**
|
|
911
|
+
* true: the keyword also reads the workspace's feeds (GET /v1/feeds), live from now on. false: its own feeds alone.
|
|
912
|
+
*/
|
|
913
|
+
readsWorkspaceFeeds?: boolean;
|
|
844
914
|
};
|
|
845
915
|
/**
|
|
846
916
|
* What the change would have done over the window, measured with the matcher's own rules. Null for a context, which changes scores, not matches.
|
|
@@ -1110,6 +1180,78 @@ type KeywordHealth = {
|
|
|
1110
1180
|
*/
|
|
1111
1181
|
generatedAt: string;
|
|
1112
1182
|
};
|
|
1183
|
+
/**
|
|
1184
|
+
* An RSS or Atom feed every keyword of the workspace reads.
|
|
1185
|
+
*/
|
|
1186
|
+
type Feed = {
|
|
1187
|
+
/**
|
|
1188
|
+
* Feed id (fd_...).
|
|
1189
|
+
*/
|
|
1190
|
+
id: string;
|
|
1191
|
+
/**
|
|
1192
|
+
* The feed itself (after redirects, or the one the page advertised): what is polled.
|
|
1193
|
+
*/
|
|
1194
|
+
url: string;
|
|
1195
|
+
/**
|
|
1196
|
+
* The feed's own title, when it has one.
|
|
1197
|
+
*/
|
|
1198
|
+
title: string | null;
|
|
1199
|
+
/**
|
|
1200
|
+
* When the workspace connected it.
|
|
1201
|
+
*/
|
|
1202
|
+
connectedAt: string;
|
|
1203
|
+
/**
|
|
1204
|
+
* Nothing published before this is a live mention: the connection, or the last time its sign-in was added or removed (signed in and signed out, a post is read as two different posts, so the switch starts over rather than bill one twice).
|
|
1205
|
+
*/
|
|
1206
|
+
readingSince: string;
|
|
1207
|
+
/**
|
|
1208
|
+
* The sign-in the feed is read with, or null for a public feed. PATCH { auth } replaces it, { auth: null } removes it.
|
|
1209
|
+
*/
|
|
1210
|
+
auth: {
|
|
1211
|
+
/**
|
|
1212
|
+
* cookie or header. The value is never shown.
|
|
1213
|
+
*/
|
|
1214
|
+
type: 'cookie' | 'header';
|
|
1215
|
+
} | null;
|
|
1216
|
+
/**
|
|
1217
|
+
* Whether the hourly read works.
|
|
1218
|
+
*/
|
|
1219
|
+
health: {
|
|
1220
|
+
/**
|
|
1221
|
+
* failing: the last 3 hourly reads or more failed (a feed.failing event went out); ok otherwise.
|
|
1222
|
+
*/
|
|
1223
|
+
status: 'ok' | 'failing';
|
|
1224
|
+
/**
|
|
1225
|
+
* Why the last read failed; null when it read well.
|
|
1226
|
+
*/
|
|
1227
|
+
reason: 'login_required' | 'login_expired' | 'blocked' | 'not_found' | 'not_a_feed' | 'unreachable';
|
|
1228
|
+
/**
|
|
1229
|
+
* What the last failed read saw.
|
|
1230
|
+
*/
|
|
1231
|
+
detail: string | null;
|
|
1232
|
+
/**
|
|
1233
|
+
* Failed hourly reads in a row.
|
|
1234
|
+
*/
|
|
1235
|
+
failures: number;
|
|
1236
|
+
/**
|
|
1237
|
+
* While failing: since when.
|
|
1238
|
+
*/
|
|
1239
|
+
since: string | null;
|
|
1240
|
+
};
|
|
1241
|
+
/**
|
|
1242
|
+
* How the hourly poll of this feed is going.
|
|
1243
|
+
*/
|
|
1244
|
+
stats: {
|
|
1245
|
+
/**
|
|
1246
|
+
* When the feed was last read; null until its first poll (within the hour).
|
|
1247
|
+
*/
|
|
1248
|
+
lastPolledAt: string | null;
|
|
1249
|
+
/**
|
|
1250
|
+
* Polls in a row that brought nothing new; a feed that keeps reading empty may have moved.
|
|
1251
|
+
*/
|
|
1252
|
+
emptyPolls: number;
|
|
1253
|
+
};
|
|
1254
|
+
};
|
|
1113
1255
|
/**
|
|
1114
1256
|
* Workspace-wide matching rules; a rejected post is never billed.
|
|
1115
1257
|
*/
|
|
@@ -1390,11 +1532,11 @@ type Mention = {
|
|
|
1390
1532
|
*/
|
|
1391
1533
|
automated: boolean;
|
|
1392
1534
|
/**
|
|
1393
|
-
* The language the post is written in, as an ISO 639-1 code (en, es, de); null when unknown or classified before languages were recorded.
|
|
1535
|
+
* 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.
|
|
1394
1536
|
*/
|
|
1395
1537
|
language: string | null;
|
|
1396
1538
|
/**
|
|
1397
|
-
* Where the author is, as a lowercase ISO 3166-1 alpha-2 code (us, in, de): the classifier's reading of the author's profile location and the post. A best guess, not a fact the platform gave; null when nothing tells, or classified before countries were recorded.
|
|
1539
|
+
* Where the author is, as a lowercase ISO 3166-1 alpha-2 code (us, in, de): the classifier's reading of the author's profile location and the post. A best guess, not a fact the platform gave; null when nothing tells, when it is not one of the 60 the classifier names, or when classified before countries were recorded.
|
|
1398
1540
|
*/
|
|
1399
1541
|
country: string | null;
|
|
1400
1542
|
/**
|
|
@@ -2443,15 +2585,58 @@ type ChannelFailingEventData = {
|
|
|
2443
2585
|
*/
|
|
2444
2586
|
since: string;
|
|
2445
2587
|
};
|
|
2588
|
+
type FeedFailingEventData = {
|
|
2589
|
+
/**
|
|
2590
|
+
* The attention item (att_...): GET /v1/attention lists it, POST /v1/attention/{id}/dismiss puts it away.
|
|
2591
|
+
*/
|
|
2592
|
+
attentionId: string;
|
|
2593
|
+
/**
|
|
2594
|
+
* Where to look in the dashboard.
|
|
2595
|
+
*/
|
|
2596
|
+
url: string;
|
|
2597
|
+
/**
|
|
2598
|
+
* The workspace feed (GET /v1/feeds/{id}).
|
|
2599
|
+
*/
|
|
2600
|
+
feed: {
|
|
2601
|
+
/**
|
|
2602
|
+
* Feed id (fd_...).
|
|
2603
|
+
*/
|
|
2604
|
+
id: string;
|
|
2605
|
+
/**
|
|
2606
|
+
* The feed address.
|
|
2607
|
+
*/
|
|
2608
|
+
url: string;
|
|
2609
|
+
/**
|
|
2610
|
+
* The feed's own title, when it has one.
|
|
2611
|
+
*/
|
|
2612
|
+
title: string | null;
|
|
2613
|
+
};
|
|
2614
|
+
/**
|
|
2615
|
+
* login_required: the feed answers a sign-in or access-denied page (connect it with the forum's sign-in, auth). login_expired: the same on a feed that has a sign-in: copy a fresh cookie. blocked: a 403, a 429 or a bot check. not_found: the feed is gone. not_a_feed: the address answers a page, not RSS or Atom. unreachable: no answer or a server error.
|
|
2616
|
+
*/
|
|
2617
|
+
reason: 'login_required' | 'login_expired' | 'blocked' | 'not_found' | 'not_a_feed' | 'unreachable';
|
|
2618
|
+
/**
|
|
2619
|
+
* What the last failed read saw, in a few words.
|
|
2620
|
+
*/
|
|
2621
|
+
detail: string | null;
|
|
2622
|
+
/**
|
|
2623
|
+
* When it started failing: the third failed read in a row.
|
|
2624
|
+
*/
|
|
2625
|
+
failingSince: string;
|
|
2626
|
+
/**
|
|
2627
|
+
* Live keywords of the workspace that read workspace feeds: what misses its posts while it fails.
|
|
2628
|
+
*/
|
|
2629
|
+
keywordsAffected: number;
|
|
2630
|
+
};
|
|
2446
2631
|
type AttentionItem = {
|
|
2447
2632
|
/**
|
|
2448
2633
|
* Attention item id (att_...).
|
|
2449
2634
|
*/
|
|
2450
2635
|
id: string;
|
|
2451
2636
|
/**
|
|
2452
|
-
* mention.spike: far more mentions in the last hour than the keyword usually gets. sentiment.negative_spike: the negative share of the last 24 hours jumped. keyword.noisy: most scored matches are noise. channel.failing: the channel's last sends all failed.
|
|
2637
|
+
* mention.spike: far more mentions in the last hour than the keyword usually gets. sentiment.negative_spike: the negative share of the last 24 hours jumped. keyword.noisy: most scored matches are noise. channel.failing: the channel's last sends all failed. feed.failing: a workspace feed failed its last 3 hourly reads. feed.recovered: it read again after failing.
|
|
2453
2638
|
*/
|
|
2454
|
-
kind: 'mention.spike' | 'sentiment.negative_spike' | 'keyword.noisy' | 'channel.failing';
|
|
2639
|
+
kind: 'mention.spike' | 'sentiment.negative_spike' | 'keyword.noisy' | 'channel.failing' | 'feed.failing' | 'feed.recovered';
|
|
2455
2640
|
/**
|
|
2456
2641
|
* open: the condition holds. resolved: it no longer does. dismissed: a person put it away; it does not come back for the same episode.
|
|
2457
2642
|
*/
|
|
@@ -2461,11 +2646,11 @@ type AttentionItem = {
|
|
|
2461
2646
|
*/
|
|
2462
2647
|
subject: {
|
|
2463
2648
|
/**
|
|
2464
|
-
* keyword or
|
|
2649
|
+
* keyword, channel or feed.
|
|
2465
2650
|
*/
|
|
2466
|
-
type: 'keyword' | 'channel';
|
|
2651
|
+
type: 'keyword' | 'channel' | 'feed';
|
|
2467
2652
|
/**
|
|
2468
|
-
* The keyword (kw_...)
|
|
2653
|
+
* The keyword (kw_...), the channel (dest_...) or the feed (fd_...).
|
|
2469
2654
|
*/
|
|
2470
2655
|
id: string;
|
|
2471
2656
|
};
|
|
@@ -2488,7 +2673,7 @@ type AttentionItem = {
|
|
|
2488
2673
|
/**
|
|
2489
2674
|
* The facts as they stood when it opened: the same object the account event of the same name carries as `data`.
|
|
2490
2675
|
*/
|
|
2491
|
-
data: MentionSpikeEventData | NegativeSpikeEventData | KeywordNoisyEventData | ChannelFailingEventData;
|
|
2676
|
+
data: MentionSpikeEventData | NegativeSpikeEventData | KeywordNoisyEventData | ChannelFailingEventData | FeedFailingEventData;
|
|
2492
2677
|
};
|
|
2493
2678
|
/**
|
|
2494
2679
|
* The group the keyword belongs to.
|
|
@@ -4066,7 +4251,7 @@ type SlackChannel = {
|
|
|
4066
4251
|
/**
|
|
4067
4252
|
* The attention events this channel receives on its own, no rule involved: one short message when an item opens (GET /v1/attention). Empty when it receives none.
|
|
4068
4253
|
*/
|
|
4069
|
-
events: Array<'mention.spike' | 'sentiment.negative_spike' | 'keyword.noisy' | 'channel.failing'>;
|
|
4254
|
+
events: Array<'mention.spike' | 'sentiment.negative_spike' | 'keyword.noisy' | 'channel.failing' | 'feed.failing' | 'feed.recovered'>;
|
|
4070
4255
|
};
|
|
4071
4256
|
};
|
|
4072
4257
|
type EmailChannel = {
|
|
@@ -4118,7 +4303,7 @@ type EmailChannel = {
|
|
|
4118
4303
|
/**
|
|
4119
4304
|
* The attention events this channel receives on its own, no rule involved: one short message when an item opens (GET /v1/attention). Empty when it receives none.
|
|
4120
4305
|
*/
|
|
4121
|
-
events: Array<'mention.spike' | 'sentiment.negative_spike' | 'keyword.noisy' | 'channel.failing'>;
|
|
4306
|
+
events: Array<'mention.spike' | 'sentiment.negative_spike' | 'keyword.noisy' | 'channel.failing' | 'feed.failing' | 'feed.recovered'>;
|
|
4122
4307
|
};
|
|
4123
4308
|
};
|
|
4124
4309
|
type WebhookChannel = {
|
|
@@ -4170,7 +4355,7 @@ type WebhookChannel = {
|
|
|
4170
4355
|
/**
|
|
4171
4356
|
* The account events this endpoint receives on its own, no rule involved: keyword and wallet state changes and the attention events. Empty when it receives none; mention and digest deliveries come through rules as before.
|
|
4172
4357
|
*/
|
|
4173
|
-
events: Array<'keyword.capped' | 'keyword.paused_for_balance' | 'keyword.resumed' | 'wallet.low' | 'wallet.paused' | 'wallet.resumed' | 'mention.spike' | 'sentiment.negative_spike' | 'keyword.noisy' | 'channel.failing'>;
|
|
4358
|
+
events: Array<'keyword.capped' | 'keyword.paused_for_balance' | 'keyword.resumed' | 'wallet.low' | 'wallet.paused' | 'wallet.resumed' | 'mention.spike' | 'sentiment.negative_spike' | 'keyword.noisy' | 'channel.failing' | 'feed.failing' | 'feed.recovered'>;
|
|
4174
4359
|
/**
|
|
4175
4360
|
* Only on creation and rotation. Signs every request: X-Mentions-Signature-V2 is v2= plus the hex HMAC-SHA256 of "<X-Mentions-Timestamp>.<raw body>" (reject a timestamp older than a few minutes); X-Mentions-Signature, the hex HMAC-SHA256 of the raw body alone, stays for older verifiers.
|
|
4176
4361
|
*/
|
|
@@ -4221,7 +4406,7 @@ type TelegramChannel = {
|
|
|
4221
4406
|
/**
|
|
4222
4407
|
* The attention events this channel receives on its own, no rule involved: one short message when an item opens (GET /v1/attention). Empty when it receives none.
|
|
4223
4408
|
*/
|
|
4224
|
-
events: Array<'mention.spike' | 'sentiment.negative_spike' | 'keyword.noisy' | 'channel.failing'>;
|
|
4409
|
+
events: Array<'mention.spike' | 'sentiment.negative_spike' | 'keyword.noisy' | 'channel.failing' | 'feed.failing' | 'feed.recovered'>;
|
|
4225
4410
|
};
|
|
4226
4411
|
};
|
|
4227
4412
|
type Channel = ({
|
|
@@ -4246,7 +4431,7 @@ type CreateSlackChannel = {
|
|
|
4246
4431
|
/**
|
|
4247
4432
|
* Attention events to receive here, on top of whatever rules send. Omit for none.
|
|
4248
4433
|
*/
|
|
4249
|
-
events?: Array<'mention.spike' | 'sentiment.negative_spike' | 'keyword.noisy' | 'channel.failing'>;
|
|
4434
|
+
events?: Array<'mention.spike' | 'sentiment.negative_spike' | 'keyword.noisy' | 'channel.failing' | 'feed.failing' | 'feed.recovered'>;
|
|
4250
4435
|
};
|
|
4251
4436
|
type CreateEmailChannel = {
|
|
4252
4437
|
kind: 'email';
|
|
@@ -4257,7 +4442,7 @@ type CreateEmailChannel = {
|
|
|
4257
4442
|
/**
|
|
4258
4443
|
* Attention events to receive here, on top of whatever rules send. Omit for none.
|
|
4259
4444
|
*/
|
|
4260
|
-
events?: Array<'mention.spike' | 'sentiment.negative_spike' | 'keyword.noisy' | 'channel.failing'>;
|
|
4445
|
+
events?: Array<'mention.spike' | 'sentiment.negative_spike' | 'keyword.noisy' | 'channel.failing' | 'feed.failing' | 'feed.recovered'>;
|
|
4261
4446
|
};
|
|
4262
4447
|
type CreateWebhookChannel = {
|
|
4263
4448
|
kind: 'webhook';
|
|
@@ -4278,7 +4463,7 @@ type CreateWebhookChannel = {
|
|
|
4278
4463
|
/**
|
|
4279
4464
|
* Account events to receive at this endpoint (keyword and wallet state changes, attention events), on top of whatever rules send here. Omit for none.
|
|
4280
4465
|
*/
|
|
4281
|
-
events?: Array<'keyword.capped' | 'keyword.paused_for_balance' | 'keyword.resumed' | 'wallet.low' | 'wallet.paused' | 'wallet.resumed' | 'mention.spike' | 'sentiment.negative_spike' | 'keyword.noisy' | 'channel.failing'>;
|
|
4466
|
+
events?: Array<'keyword.capped' | 'keyword.paused_for_balance' | 'keyword.resumed' | 'wallet.low' | 'wallet.paused' | 'wallet.resumed' | 'mention.spike' | 'sentiment.negative_spike' | 'keyword.noisy' | 'channel.failing' | 'feed.failing' | 'feed.recovered'>;
|
|
4282
4467
|
};
|
|
4283
4468
|
type GetHealthData = {
|
|
4284
4469
|
body?: never;
|
|
@@ -4419,6 +4604,37 @@ type ListKeywordsResponses = {
|
|
|
4419
4604
|
*/
|
|
4420
4605
|
maxPerPost: number;
|
|
4421
4606
|
};
|
|
4607
|
+
/**
|
|
4608
|
+
* Which of this keyword's mentions you see, by language and country. Both are read by the classifier, so a hidden post is still matched, classified and billed like any other; it is kept out of the mentions list, the exports, MCP search, alerts and digests (includeHidden=true on GET /v1/mentions shows it). Read when the mentions are read, so changing a list applies to older mentions too.
|
|
4609
|
+
*/
|
|
4610
|
+
display: {
|
|
4611
|
+
/**
|
|
4612
|
+
* By the language the post is written in.
|
|
4613
|
+
*/
|
|
4614
|
+
languages: {
|
|
4615
|
+
/**
|
|
4616
|
+
* When non-empty, a post whose language (ISO 639-1) is known and not listed is hidden, a language (ISO 639-1) the classifier recognises but does not name included. A post whose language (ISO 639-1) nobody could tell is always shown.
|
|
4617
|
+
*/
|
|
4618
|
+
only: Array<'en' | 'es' | 'de' | 'fr' | 'pt' | 'it' | 'nl' | 'ca' | 'pl' | 'tr' | 'sv' | 'da' | 'ru' | 'uk' | 'ar' | 'hi' | 'id' | 'ja' | 'zh' | 'ko'>;
|
|
4619
|
+
/**
|
|
4620
|
+
* A post whose language (ISO 639-1) is listed is hidden.
|
|
4621
|
+
*/
|
|
4622
|
+
excluded: Array<'en' | 'es' | 'de' | 'fr' | 'pt' | 'it' | 'nl' | 'ca' | 'pl' | 'tr' | 'sv' | 'da' | 'ru' | 'uk' | 'ar' | 'hi' | 'id' | 'ja' | 'zh' | 'ko'>;
|
|
4623
|
+
};
|
|
4624
|
+
/**
|
|
4625
|
+
* By where the author is, as the classifier read their profile and the post.
|
|
4626
|
+
*/
|
|
4627
|
+
countries: {
|
|
4628
|
+
/**
|
|
4629
|
+
* When non-empty, a post whose author's country (ISO 3166-1 alpha-2) is known and not listed is hidden, a author's country (ISO 3166-1 alpha-2) the classifier recognises but does not name included. A post whose author's country (ISO 3166-1 alpha-2) nobody could tell is always shown.
|
|
4630
|
+
*/
|
|
4631
|
+
only: 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'>;
|
|
4632
|
+
/**
|
|
4633
|
+
* A post whose author's country (ISO 3166-1 alpha-2) is listed is hidden.
|
|
4634
|
+
*/
|
|
4635
|
+
excluded: 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'>;
|
|
4636
|
+
};
|
|
4637
|
+
};
|
|
4422
4638
|
group: GroupRef;
|
|
4423
4639
|
/**
|
|
4424
4640
|
* Platforms the term is searched on; null means every platform, [] none (the keyword only collects reviews).
|
|
@@ -4428,6 +4644,10 @@ type ListKeywordsResponses = {
|
|
|
4428
4644
|
* RSS and Atom feeds this keyword reads; empty for none.
|
|
4429
4645
|
*/
|
|
4430
4646
|
feeds: Array<KeywordFeed>;
|
|
4647
|
+
/**
|
|
4648
|
+
* true (the default): the keyword also reads every feed of the workspace (GET /v1/feeds), on top of its own `feeds`. false: its own feeds alone.
|
|
4649
|
+
*/
|
|
4650
|
+
readsWorkspaceFeeds: boolean;
|
|
4431
4651
|
/**
|
|
4432
4652
|
* Where this keyword collects reviews from (App Store and Google Play apps, Trustpilot pages, Google Maps places); empty for none.
|
|
4433
4653
|
*/
|
|
@@ -4727,6 +4947,37 @@ type CreateKeywordData = {
|
|
|
4727
4947
|
*/
|
|
4728
4948
|
maxPerPost?: number;
|
|
4729
4949
|
};
|
|
4950
|
+
/**
|
|
4951
|
+
* Which of this keyword's mentions you see, by language and country; each list is replaced when sent, kept when omitted. Hidden mentions are still billed.
|
|
4952
|
+
*/
|
|
4953
|
+
display?: {
|
|
4954
|
+
/**
|
|
4955
|
+
* By the language of the post (ISO 639-1); omitted: untouched.
|
|
4956
|
+
*/
|
|
4957
|
+
languages?: {
|
|
4958
|
+
/**
|
|
4959
|
+
* Replaces the list; [] clears it.
|
|
4960
|
+
*/
|
|
4961
|
+
only?: Array<'en' | 'es' | 'de' | 'fr' | 'pt' | 'it' | 'nl' | 'ca' | 'pl' | 'tr' | 'sv' | 'da' | 'ru' | 'uk' | 'ar' | 'hi' | 'id' | 'ja' | 'zh' | 'ko'>;
|
|
4962
|
+
/**
|
|
4963
|
+
* Replaces the list; [] clears it.
|
|
4964
|
+
*/
|
|
4965
|
+
excluded?: Array<'en' | 'es' | 'de' | 'fr' | 'pt' | 'it' | 'nl' | 'ca' | 'pl' | 'tr' | 'sv' | 'da' | 'ru' | 'uk' | 'ar' | 'hi' | 'id' | 'ja' | 'zh' | 'ko'>;
|
|
4966
|
+
};
|
|
4967
|
+
/**
|
|
4968
|
+
* By where the author is (ISO 3166-1 alpha-2); omitted: untouched.
|
|
4969
|
+
*/
|
|
4970
|
+
countries?: {
|
|
4971
|
+
/**
|
|
4972
|
+
* Replaces the list; [] clears it.
|
|
4973
|
+
*/
|
|
4974
|
+
only?: 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'>;
|
|
4975
|
+
/**
|
|
4976
|
+
* Replaces the list; [] clears it.
|
|
4977
|
+
*/
|
|
4978
|
+
excluded?: 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'>;
|
|
4979
|
+
};
|
|
4980
|
+
};
|
|
4730
4981
|
/**
|
|
4731
4982
|
* The group to track it in (grp_...); omit for the workspace's default group. A term may be tracked once per group.
|
|
4732
4983
|
*/
|
|
@@ -4765,6 +5016,10 @@ type CreateKeywordData = {
|
|
|
4765
5016
|
*/
|
|
4766
5017
|
url: string;
|
|
4767
5018
|
}>;
|
|
5019
|
+
/**
|
|
5020
|
+
* Whether the keyword also reads the workspace's feeds (GET /v1/feeds); default true. A new keyword reading them gets the look-back of the 8 most recently connected.
|
|
5021
|
+
*/
|
|
5022
|
+
readsWorkspaceFeeds?: boolean;
|
|
4768
5023
|
};
|
|
4769
5024
|
path?: never;
|
|
4770
5025
|
query?: never;
|
|
@@ -4964,6 +5219,37 @@ type UpdateKeywordData = {
|
|
|
4964
5219
|
*/
|
|
4965
5220
|
maxPerPost?: number;
|
|
4966
5221
|
};
|
|
5222
|
+
/**
|
|
5223
|
+
* Which of this keyword's mentions you see, by language and country; each list is replaced when sent, kept when omitted. Hidden mentions are still billed.
|
|
5224
|
+
*/
|
|
5225
|
+
display?: {
|
|
5226
|
+
/**
|
|
5227
|
+
* By the language of the post (ISO 639-1); omitted: untouched.
|
|
5228
|
+
*/
|
|
5229
|
+
languages?: {
|
|
5230
|
+
/**
|
|
5231
|
+
* Replaces the list; [] clears it.
|
|
5232
|
+
*/
|
|
5233
|
+
only?: Array<'en' | 'es' | 'de' | 'fr' | 'pt' | 'it' | 'nl' | 'ca' | 'pl' | 'tr' | 'sv' | 'da' | 'ru' | 'uk' | 'ar' | 'hi' | 'id' | 'ja' | 'zh' | 'ko'>;
|
|
5234
|
+
/**
|
|
5235
|
+
* Replaces the list; [] clears it.
|
|
5236
|
+
*/
|
|
5237
|
+
excluded?: Array<'en' | 'es' | 'de' | 'fr' | 'pt' | 'it' | 'nl' | 'ca' | 'pl' | 'tr' | 'sv' | 'da' | 'ru' | 'uk' | 'ar' | 'hi' | 'id' | 'ja' | 'zh' | 'ko'>;
|
|
5238
|
+
};
|
|
5239
|
+
/**
|
|
5240
|
+
* By where the author is (ISO 3166-1 alpha-2); omitted: untouched.
|
|
5241
|
+
*/
|
|
5242
|
+
countries?: {
|
|
5243
|
+
/**
|
|
5244
|
+
* Replaces the list; [] clears it.
|
|
5245
|
+
*/
|
|
5246
|
+
only?: 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'>;
|
|
5247
|
+
/**
|
|
5248
|
+
* Replaces the list; [] clears it.
|
|
5249
|
+
*/
|
|
5250
|
+
excluded?: 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'>;
|
|
5251
|
+
};
|
|
5252
|
+
};
|
|
4967
5253
|
/**
|
|
4968
5254
|
* Moves the keyword to this group (grp_...). A 409 when that group already tracks the term.
|
|
4969
5255
|
*/
|
|
@@ -5002,6 +5288,10 @@ type UpdateKeywordData = {
|
|
|
5002
5288
|
*/
|
|
5003
5289
|
url: string;
|
|
5004
5290
|
}>;
|
|
5291
|
+
/**
|
|
5292
|
+
* true: the keyword also reads the workspace's feeds (GET /v1/feeds), live from now on. false: its own feeds alone.
|
|
5293
|
+
*/
|
|
5294
|
+
readsWorkspaceFeeds?: boolean;
|
|
5005
5295
|
};
|
|
5006
5296
|
path: {
|
|
5007
5297
|
/**
|
|
@@ -5134,6 +5424,468 @@ type DuplicateKeywordResponses = {
|
|
|
5134
5424
|
201: Keyword;
|
|
5135
5425
|
};
|
|
5136
5426
|
type DuplicateKeywordResponse = DuplicateKeywordResponses[keyof DuplicateKeywordResponses];
|
|
5427
|
+
type ListFeedsData = {
|
|
5428
|
+
body?: never;
|
|
5429
|
+
path?: never;
|
|
5430
|
+
query?: {
|
|
5431
|
+
/**
|
|
5432
|
+
* Only feeds whose address or title contains this text, case-insensitive.
|
|
5433
|
+
*/
|
|
5434
|
+
q?: string;
|
|
5435
|
+
/**
|
|
5436
|
+
* Feeds per page, at most 500; default 100.
|
|
5437
|
+
*/
|
|
5438
|
+
limit?: number;
|
|
5439
|
+
/**
|
|
5440
|
+
* Feeds to skip, for the next page.
|
|
5441
|
+
*/
|
|
5442
|
+
offset?: number | null;
|
|
5443
|
+
};
|
|
5444
|
+
url: '/v1/feeds';
|
|
5445
|
+
};
|
|
5446
|
+
type ListFeedsErrors = {
|
|
5447
|
+
/**
|
|
5448
|
+
* Missing or invalid API key
|
|
5449
|
+
*/
|
|
5450
|
+
401: ErrorResponse;
|
|
5451
|
+
};
|
|
5452
|
+
type ListFeedsError = ListFeedsErrors[keyof ListFeedsErrors];
|
|
5453
|
+
type ListFeedsResponses = {
|
|
5454
|
+
/**
|
|
5455
|
+
* A page of feeds
|
|
5456
|
+
*/
|
|
5457
|
+
200: {
|
|
5458
|
+
/**
|
|
5459
|
+
* The page, newest connection first.
|
|
5460
|
+
*/
|
|
5461
|
+
data: Array<{
|
|
5462
|
+
/**
|
|
5463
|
+
* Feed id (fd_...).
|
|
5464
|
+
*/
|
|
5465
|
+
id: string;
|
|
5466
|
+
/**
|
|
5467
|
+
* The feed itself (after redirects, or the one the page advertised): what is polled.
|
|
5468
|
+
*/
|
|
5469
|
+
url: string;
|
|
5470
|
+
/**
|
|
5471
|
+
* The feed's own title, when it has one.
|
|
5472
|
+
*/
|
|
5473
|
+
title: string | null;
|
|
5474
|
+
/**
|
|
5475
|
+
* When the workspace connected it.
|
|
5476
|
+
*/
|
|
5477
|
+
connectedAt: string;
|
|
5478
|
+
/**
|
|
5479
|
+
* Nothing published before this is a live mention: the connection, or the last time its sign-in was added or removed (signed in and signed out, a post is read as two different posts, so the switch starts over rather than bill one twice).
|
|
5480
|
+
*/
|
|
5481
|
+
readingSince: string;
|
|
5482
|
+
/**
|
|
5483
|
+
* The sign-in the feed is read with, or null for a public feed. PATCH { auth } replaces it, { auth: null } removes it.
|
|
5484
|
+
*/
|
|
5485
|
+
auth: {
|
|
5486
|
+
/**
|
|
5487
|
+
* cookie or header. The value is never shown.
|
|
5488
|
+
*/
|
|
5489
|
+
type: 'cookie' | 'header';
|
|
5490
|
+
} | null;
|
|
5491
|
+
/**
|
|
5492
|
+
* Whether the hourly read works.
|
|
5493
|
+
*/
|
|
5494
|
+
health: {
|
|
5495
|
+
/**
|
|
5496
|
+
* failing: the last 3 hourly reads or more failed (a feed.failing event went out); ok otherwise.
|
|
5497
|
+
*/
|
|
5498
|
+
status: 'ok' | 'failing';
|
|
5499
|
+
/**
|
|
5500
|
+
* Why the last read failed; null when it read well.
|
|
5501
|
+
*/
|
|
5502
|
+
reason: 'login_required' | 'login_expired' | 'blocked' | 'not_found' | 'not_a_feed' | 'unreachable';
|
|
5503
|
+
/**
|
|
5504
|
+
* What the last failed read saw.
|
|
5505
|
+
*/
|
|
5506
|
+
detail: string | null;
|
|
5507
|
+
/**
|
|
5508
|
+
* Failed hourly reads in a row.
|
|
5509
|
+
*/
|
|
5510
|
+
failures: number;
|
|
5511
|
+
/**
|
|
5512
|
+
* While failing: since when.
|
|
5513
|
+
*/
|
|
5514
|
+
since: string | null;
|
|
5515
|
+
};
|
|
5516
|
+
/**
|
|
5517
|
+
* How the hourly poll of this feed is going.
|
|
5518
|
+
*/
|
|
5519
|
+
stats: {
|
|
5520
|
+
/**
|
|
5521
|
+
* When the feed was last read; null until its first poll (within the hour).
|
|
5522
|
+
*/
|
|
5523
|
+
lastPolledAt: string | null;
|
|
5524
|
+
/**
|
|
5525
|
+
* Polls in a row that brought nothing new; a feed that keeps reading empty may have moved.
|
|
5526
|
+
*/
|
|
5527
|
+
emptyPolls: number;
|
|
5528
|
+
};
|
|
5529
|
+
}>;
|
|
5530
|
+
/**
|
|
5531
|
+
* Feeds matching the query, across pages.
|
|
5532
|
+
*/
|
|
5533
|
+
total: number;
|
|
5534
|
+
};
|
|
5535
|
+
};
|
|
5536
|
+
type ListFeedsResponse = ListFeedsResponses[keyof ListFeedsResponses];
|
|
5537
|
+
type CreateFeedData = {
|
|
5538
|
+
/**
|
|
5539
|
+
* One feed to connect, with a sign-in when it is members-only.
|
|
5540
|
+
*/
|
|
5541
|
+
body: {
|
|
5542
|
+
/**
|
|
5543
|
+
* A feed's address (https://forum.example.com/posts.rss), or a page's (https://forum.example.com): the feed the page advertises is used.
|
|
5544
|
+
*/
|
|
5545
|
+
url: string;
|
|
5546
|
+
/**
|
|
5547
|
+
* A sign-in for a members-only feed: a cookie, or one header. Write-only: stored encrypted, sent to the feed's own site alone, never shown again. A feed with a sign-in is read for this workspace alone.
|
|
5548
|
+
*/
|
|
5549
|
+
auth?: {
|
|
5550
|
+
type: 'cookie';
|
|
5551
|
+
/**
|
|
5552
|
+
* The Cookie header your browser sends to the forum (devtools, Network, the feed's request, Request Headers, cookie).
|
|
5553
|
+
*/
|
|
5554
|
+
value: string;
|
|
5555
|
+
} | {
|
|
5556
|
+
type: 'header';
|
|
5557
|
+
/**
|
|
5558
|
+
* The header name, e.g. Api-Key (Discourse) or Authorization.
|
|
5559
|
+
*/
|
|
5560
|
+
name: string;
|
|
5561
|
+
/**
|
|
5562
|
+
* Its value.
|
|
5563
|
+
*/
|
|
5564
|
+
value: string;
|
|
5565
|
+
};
|
|
5566
|
+
};
|
|
5567
|
+
path?: never;
|
|
5568
|
+
query?: never;
|
|
5569
|
+
url: '/v1/feeds';
|
|
5570
|
+
};
|
|
5571
|
+
type CreateFeedErrors = {
|
|
5572
|
+
/**
|
|
5573
|
+
* feed_login_required: a sign-in wall, send auth. feed_login_expired: the auth sent does not read it. feed_unreadable: no feed there, or the site blocks readers (the message says which).
|
|
5574
|
+
*/
|
|
5575
|
+
400: ErrorResponse;
|
|
5576
|
+
/**
|
|
5577
|
+
* Missing or invalid API key
|
|
5578
|
+
*/
|
|
5579
|
+
401: ErrorResponse;
|
|
5580
|
+
/**
|
|
5581
|
+
* feed_limit_reached: the workspace reads 500 feeds already
|
|
5582
|
+
*/
|
|
5583
|
+
409: ErrorResponse;
|
|
5584
|
+
/**
|
|
5585
|
+
* More than 30 feeds checked in a minute
|
|
5586
|
+
*/
|
|
5587
|
+
429: ErrorResponse;
|
|
5588
|
+
/**
|
|
5589
|
+
* feed_auth_not_configured: a sign-in was sent and this deployment cannot store one
|
|
5590
|
+
*/
|
|
5591
|
+
503: ErrorResponse;
|
|
5592
|
+
};
|
|
5593
|
+
type CreateFeedError = CreateFeedErrors[keyof CreateFeedErrors];
|
|
5594
|
+
type CreateFeedResponses = {
|
|
5595
|
+
/**
|
|
5596
|
+
* The workspace reads this feed already
|
|
5597
|
+
*/
|
|
5598
|
+
200: Feed;
|
|
5599
|
+
/**
|
|
5600
|
+
* The feed, connected now
|
|
5601
|
+
*/
|
|
5602
|
+
201: Feed;
|
|
5603
|
+
};
|
|
5604
|
+
type CreateFeedResponse = CreateFeedResponses[keyof CreateFeedResponses];
|
|
5605
|
+
type ImportFeedsData = {
|
|
5606
|
+
body: {
|
|
5607
|
+
/**
|
|
5608
|
+
* Up to 100 feeds, each { url } or { url, auth } for a members-only one. Each is checked on its own: one that fails never stops the others.
|
|
5609
|
+
*/
|
|
5610
|
+
feeds: Array<{
|
|
5611
|
+
/**
|
|
5612
|
+
* A feed's address (https://forum.example.com/posts.rss), or a page's (https://forum.example.com): the feed the page advertises is used.
|
|
5613
|
+
*/
|
|
5614
|
+
url: string;
|
|
5615
|
+
/**
|
|
5616
|
+
* A sign-in for a members-only feed: a cookie, or one header. Write-only: stored encrypted, sent to the feed's own site alone, never shown again. A feed with a sign-in is read for this workspace alone.
|
|
5617
|
+
*/
|
|
5618
|
+
auth?: {
|
|
5619
|
+
type: 'cookie';
|
|
5620
|
+
/**
|
|
5621
|
+
* The Cookie header your browser sends to the forum (devtools, Network, the feed's request, Request Headers, cookie).
|
|
5622
|
+
*/
|
|
5623
|
+
value: string;
|
|
5624
|
+
} | {
|
|
5625
|
+
type: 'header';
|
|
5626
|
+
/**
|
|
5627
|
+
* The header name, e.g. Api-Key (Discourse) or Authorization.
|
|
5628
|
+
*/
|
|
5629
|
+
name: string;
|
|
5630
|
+
/**
|
|
5631
|
+
* Its value.
|
|
5632
|
+
*/
|
|
5633
|
+
value: string;
|
|
5634
|
+
};
|
|
5635
|
+
}>;
|
|
5636
|
+
};
|
|
5637
|
+
path?: never;
|
|
5638
|
+
query?: never;
|
|
5639
|
+
url: '/v1/feeds/import';
|
|
5640
|
+
};
|
|
5641
|
+
type ImportFeedsErrors = {
|
|
5642
|
+
/**
|
|
5643
|
+
* Missing or invalid API key
|
|
5644
|
+
*/
|
|
5645
|
+
401: ErrorResponse;
|
|
5646
|
+
/**
|
|
5647
|
+
* More than 5 imports in a minute
|
|
5648
|
+
*/
|
|
5649
|
+
429: ErrorResponse;
|
|
5650
|
+
};
|
|
5651
|
+
type ImportFeedsError = ImportFeedsErrors[keyof ImportFeedsErrors];
|
|
5652
|
+
type ImportFeedsResponses = {
|
|
5653
|
+
/**
|
|
5654
|
+
* One result per address
|
|
5655
|
+
*/
|
|
5656
|
+
200: {
|
|
5657
|
+
/**
|
|
5658
|
+
* One result per address sent, in order.
|
|
5659
|
+
*/
|
|
5660
|
+
data: Array<{
|
|
5661
|
+
/**
|
|
5662
|
+
* The address as it was sent.
|
|
5663
|
+
*/
|
|
5664
|
+
url: string;
|
|
5665
|
+
/**
|
|
5666
|
+
* added: connected now. already: the workspace reads this feed already. failed: not connected, see error.
|
|
5667
|
+
*/
|
|
5668
|
+
status: 'added' | 'already' | 'failed';
|
|
5669
|
+
/**
|
|
5670
|
+
* The feed, when added or already there; null when failed.
|
|
5671
|
+
*/
|
|
5672
|
+
feed: {
|
|
5673
|
+
/**
|
|
5674
|
+
* Feed id (fd_...).
|
|
5675
|
+
*/
|
|
5676
|
+
id: string;
|
|
5677
|
+
/**
|
|
5678
|
+
* The feed itself (after redirects, or the one the page advertised): what is polled.
|
|
5679
|
+
*/
|
|
5680
|
+
url: string;
|
|
5681
|
+
/**
|
|
5682
|
+
* The feed's own title, when it has one.
|
|
5683
|
+
*/
|
|
5684
|
+
title: string | null;
|
|
5685
|
+
/**
|
|
5686
|
+
* When the workspace connected it.
|
|
5687
|
+
*/
|
|
5688
|
+
connectedAt: string;
|
|
5689
|
+
/**
|
|
5690
|
+
* Nothing published before this is a live mention: the connection, or the last time its sign-in was added or removed (signed in and signed out, a post is read as two different posts, so the switch starts over rather than bill one twice).
|
|
5691
|
+
*/
|
|
5692
|
+
readingSince: string;
|
|
5693
|
+
/**
|
|
5694
|
+
* The sign-in the feed is read with, or null for a public feed. PATCH { auth } replaces it, { auth: null } removes it.
|
|
5695
|
+
*/
|
|
5696
|
+
auth: {
|
|
5697
|
+
/**
|
|
5698
|
+
* cookie or header. The value is never shown.
|
|
5699
|
+
*/
|
|
5700
|
+
type: 'cookie' | 'header';
|
|
5701
|
+
} | null;
|
|
5702
|
+
/**
|
|
5703
|
+
* Whether the hourly read works.
|
|
5704
|
+
*/
|
|
5705
|
+
health: {
|
|
5706
|
+
/**
|
|
5707
|
+
* failing: the last 3 hourly reads or more failed (a feed.failing event went out); ok otherwise.
|
|
5708
|
+
*/
|
|
5709
|
+
status: 'ok' | 'failing';
|
|
5710
|
+
/**
|
|
5711
|
+
* Why the last read failed; null when it read well.
|
|
5712
|
+
*/
|
|
5713
|
+
reason: 'login_required' | 'login_expired' | 'blocked' | 'not_found' | 'not_a_feed' | 'unreachable';
|
|
5714
|
+
/**
|
|
5715
|
+
* What the last failed read saw.
|
|
5716
|
+
*/
|
|
5717
|
+
detail: string | null;
|
|
5718
|
+
/**
|
|
5719
|
+
* Failed hourly reads in a row.
|
|
5720
|
+
*/
|
|
5721
|
+
failures: number;
|
|
5722
|
+
/**
|
|
5723
|
+
* While failing: since when.
|
|
5724
|
+
*/
|
|
5725
|
+
since: string | null;
|
|
5726
|
+
};
|
|
5727
|
+
/**
|
|
5728
|
+
* How the hourly poll of this feed is going.
|
|
5729
|
+
*/
|
|
5730
|
+
stats: {
|
|
5731
|
+
/**
|
|
5732
|
+
* When the feed was last read; null until its first poll (within the hour).
|
|
5733
|
+
*/
|
|
5734
|
+
lastPolledAt: string | null;
|
|
5735
|
+
/**
|
|
5736
|
+
* Polls in a row that brought nothing new; a feed that keeps reading empty may have moved.
|
|
5737
|
+
*/
|
|
5738
|
+
emptyPolls: number;
|
|
5739
|
+
};
|
|
5740
|
+
} | null;
|
|
5741
|
+
/**
|
|
5742
|
+
* Why it was not connected; null unless failed.
|
|
5743
|
+
*/
|
|
5744
|
+
error: {
|
|
5745
|
+
/**
|
|
5746
|
+
* The same code POST /v1/feeds answers for this address: feed_login_required (send it again with auth), feed_login_expired (a fresh cookie), feed_unreadable (no feed, or the site blocks readers), feed_limit_reached, feed_auth_not_configured, validation_error (an address that is not one), internal_error (ours: send it again).
|
|
5747
|
+
*/
|
|
5748
|
+
code: 'feed_login_required' | 'feed_login_expired' | 'feed_unreadable' | 'feed_limit_reached' | 'feed_auth_not_configured' | 'validation_error' | 'internal_error';
|
|
5749
|
+
/**
|
|
5750
|
+
* What was seen, for a person.
|
|
5751
|
+
*/
|
|
5752
|
+
message: string;
|
|
5753
|
+
} | null;
|
|
5754
|
+
}>;
|
|
5755
|
+
};
|
|
5756
|
+
};
|
|
5757
|
+
type ImportFeedsResponse = ImportFeedsResponses[keyof ImportFeedsResponses];
|
|
5758
|
+
type DeleteFeedData = {
|
|
5759
|
+
body?: never;
|
|
5760
|
+
path: {
|
|
5761
|
+
/**
|
|
5762
|
+
* Feed id (fd_...).
|
|
5763
|
+
*/
|
|
5764
|
+
id: string;
|
|
5765
|
+
};
|
|
5766
|
+
query?: never;
|
|
5767
|
+
url: '/v1/feeds/{id}';
|
|
5768
|
+
};
|
|
5769
|
+
type DeleteFeedErrors = {
|
|
5770
|
+
/**
|
|
5771
|
+
* It is the last feed and a keyword reads nothing else (validation_error, naming the keyword): give it a platform first
|
|
5772
|
+
*/
|
|
5773
|
+
400: ErrorResponse;
|
|
5774
|
+
/**
|
|
5775
|
+
* Missing or invalid API key
|
|
5776
|
+
*/
|
|
5777
|
+
401: ErrorResponse;
|
|
5778
|
+
/**
|
|
5779
|
+
* No such feed in this workspace
|
|
5780
|
+
*/
|
|
5781
|
+
404: ErrorResponse;
|
|
5782
|
+
};
|
|
5783
|
+
type DeleteFeedError = DeleteFeedErrors[keyof DeleteFeedErrors];
|
|
5784
|
+
type DeleteFeedResponses = {
|
|
5785
|
+
/**
|
|
5786
|
+
* Disconnected
|
|
5787
|
+
*/
|
|
5788
|
+
204: void;
|
|
5789
|
+
};
|
|
5790
|
+
type DeleteFeedResponse = DeleteFeedResponses[keyof DeleteFeedResponses];
|
|
5791
|
+
type GetFeedData = {
|
|
5792
|
+
body?: never;
|
|
5793
|
+
path: {
|
|
5794
|
+
/**
|
|
5795
|
+
* Feed id (fd_...).
|
|
5796
|
+
*/
|
|
5797
|
+
id: string;
|
|
5798
|
+
};
|
|
5799
|
+
query?: never;
|
|
5800
|
+
url: '/v1/feeds/{id}';
|
|
5801
|
+
};
|
|
5802
|
+
type GetFeedErrors = {
|
|
5803
|
+
/**
|
|
5804
|
+
* Missing or invalid API key
|
|
5805
|
+
*/
|
|
5806
|
+
401: ErrorResponse;
|
|
5807
|
+
/**
|
|
5808
|
+
* No such feed in this workspace
|
|
5809
|
+
*/
|
|
5810
|
+
404: ErrorResponse;
|
|
5811
|
+
};
|
|
5812
|
+
type GetFeedError = GetFeedErrors[keyof GetFeedErrors];
|
|
5813
|
+
type GetFeedResponses = {
|
|
5814
|
+
/**
|
|
5815
|
+
* The feed
|
|
5816
|
+
*/
|
|
5817
|
+
200: Feed;
|
|
5818
|
+
};
|
|
5819
|
+
type GetFeedResponse = GetFeedResponses[keyof GetFeedResponses];
|
|
5820
|
+
type UpdateFeedData = {
|
|
5821
|
+
/**
|
|
5822
|
+
* Omitted fields are untouched.
|
|
5823
|
+
*/
|
|
5824
|
+
body: {
|
|
5825
|
+
/**
|
|
5826
|
+
* Your name for the feed; null clears it.
|
|
5827
|
+
*/
|
|
5828
|
+
title?: string | null;
|
|
5829
|
+
/**
|
|
5830
|
+
* Replaces the sign-in (checked by reading the feed with it first); null removes it and the feed is read signed out again.
|
|
5831
|
+
*/
|
|
5832
|
+
auth?: {
|
|
5833
|
+
type: 'cookie';
|
|
5834
|
+
/**
|
|
5835
|
+
* The Cookie header your browser sends to the forum (devtools, Network, the feed's request, Request Headers, cookie).
|
|
5836
|
+
*/
|
|
5837
|
+
value: string;
|
|
5838
|
+
} | {
|
|
5839
|
+
type: 'header';
|
|
5840
|
+
/**
|
|
5841
|
+
* The header name, e.g. Api-Key (Discourse) or Authorization.
|
|
5842
|
+
*/
|
|
5843
|
+
name: string;
|
|
5844
|
+
/**
|
|
5845
|
+
* Its value.
|
|
5846
|
+
*/
|
|
5847
|
+
value: string;
|
|
5848
|
+
} | unknown;
|
|
5849
|
+
};
|
|
5850
|
+
path: {
|
|
5851
|
+
/**
|
|
5852
|
+
* Feed id (fd_...).
|
|
5853
|
+
*/
|
|
5854
|
+
id: string;
|
|
5855
|
+
};
|
|
5856
|
+
query?: never;
|
|
5857
|
+
url: '/v1/feeds/{id}';
|
|
5858
|
+
};
|
|
5859
|
+
type UpdateFeedErrors = {
|
|
5860
|
+
/**
|
|
5861
|
+
* feed_login_expired or feed_login_required: the sign-in does not read the feed; feed_unreadable: the feed cannot be read at all
|
|
5862
|
+
*/
|
|
5863
|
+
400: ErrorResponse;
|
|
5864
|
+
/**
|
|
5865
|
+
* Missing or invalid API key
|
|
5866
|
+
*/
|
|
5867
|
+
401: ErrorResponse;
|
|
5868
|
+
/**
|
|
5869
|
+
* No such feed in this workspace
|
|
5870
|
+
*/
|
|
5871
|
+
404: ErrorResponse;
|
|
5872
|
+
/**
|
|
5873
|
+
* More than 30 feeds checked in a minute
|
|
5874
|
+
*/
|
|
5875
|
+
429: ErrorResponse;
|
|
5876
|
+
/**
|
|
5877
|
+
* feed_auth_not_configured: this deployment cannot store a sign-in
|
|
5878
|
+
*/
|
|
5879
|
+
503: ErrorResponse;
|
|
5880
|
+
};
|
|
5881
|
+
type UpdateFeedError = UpdateFeedErrors[keyof UpdateFeedErrors];
|
|
5882
|
+
type UpdateFeedResponses = {
|
|
5883
|
+
/**
|
|
5884
|
+
* The updated feed
|
|
5885
|
+
*/
|
|
5886
|
+
200: Feed;
|
|
5887
|
+
};
|
|
5888
|
+
type UpdateFeedResponse = UpdateFeedResponses[keyof UpdateFeedResponses];
|
|
5137
5889
|
type GetFiltersData = {
|
|
5138
5890
|
body?: never;
|
|
5139
5891
|
path?: never;
|
|
@@ -5345,6 +6097,10 @@ type SearchMentionsData = {
|
|
|
5345
6097
|
* true: include mentions by people you muted, hidden by default: muted for the workspace, or for the mention's own keyword group.
|
|
5346
6098
|
*/
|
|
5347
6099
|
includeMuted?: boolean;
|
|
6100
|
+
/**
|
|
6101
|
+
* true: include mentions their keyword's display lists hide (a language or country it does not show), hidden by default.
|
|
6102
|
+
*/
|
|
6103
|
+
includeHidden?: boolean;
|
|
5348
6104
|
/**
|
|
5349
6105
|
* 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.
|
|
5350
6106
|
*/
|
|
@@ -5608,6 +6364,10 @@ type ExportMentionsCsvData = {
|
|
|
5608
6364
|
* true: include mentions by people you muted, hidden by default: muted for the workspace, or for the mention's own keyword group.
|
|
5609
6365
|
*/
|
|
5610
6366
|
includeMuted?: boolean;
|
|
6367
|
+
/**
|
|
6368
|
+
* true: include mentions their keyword's display lists hide (a language or country it does not show), hidden by default.
|
|
6369
|
+
*/
|
|
6370
|
+
includeHidden?: boolean;
|
|
5611
6371
|
/**
|
|
5612
6372
|
* 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.
|
|
5613
6373
|
*/
|
|
@@ -5905,6 +6665,10 @@ type ExportMentionsJsonData = {
|
|
|
5905
6665
|
* true: include mentions by people you muted, hidden by default: muted for the workspace, or for the mention's own keyword group.
|
|
5906
6666
|
*/
|
|
5907
6667
|
includeMuted?: boolean;
|
|
6668
|
+
/**
|
|
6669
|
+
* true: include mentions their keyword's display lists hide (a language or country it does not show), hidden by default.
|
|
6670
|
+
*/
|
|
6671
|
+
includeHidden?: boolean;
|
|
5908
6672
|
/**
|
|
5909
6673
|
* 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.
|
|
5910
6674
|
*/
|
|
@@ -8086,7 +8850,7 @@ type ListAttentionData = {
|
|
|
8086
8850
|
*/
|
|
8087
8851
|
status?: 'open' | 'resolved' | 'dismissed' | 'all';
|
|
8088
8852
|
/**
|
|
8089
|
-
* Only these kinds, comma separated: mention.spike, sentiment.negative_spike, keyword.noisy, channel.failing.
|
|
8853
|
+
* Only these kinds, comma separated: mention.spike, sentiment.negative_spike, keyword.noisy, channel.failing, feed.failing (feed.recovered never opens an item).
|
|
8090
8854
|
*/
|
|
8091
8855
|
kind?: string;
|
|
8092
8856
|
/**
|
|
@@ -9866,7 +10630,7 @@ type GetAnalyticsBreakdownData = {
|
|
|
9866
10630
|
*/
|
|
9867
10631
|
timezone?: string;
|
|
9868
10632
|
/**
|
|
9869
|
-
* The dimension to group by: platform, keyword, sentiment (unclassified included), intent (a mention can carry several), status (open, ignored, done), hour (weekday and hour of day in `timezone`), person (who posted; anonymous posts are left out), language (ISO 639-1; "unknown" for posts without one), country (where the author is, ISO 3166-1 alpha-2; "unknown" for posts
|
|
10633
|
+
* The dimension to group by: platform, keyword, sentiment (unclassified included), intent (a mention can carry several), status (open, ignored, done), hour (weekday and hour of day in `timezone`), person (who posted; anonymous posts are left out), language (ISO 639-1; "unknown" for posts without one, "other" for a language the classifier recognised but does not name), country (where the author is, ISO 3166-1 alpha-2; "unknown" for posts nobody could place, "other" for a place it does not name), subreddit (Reddit posts only, most active first; `share` stays a percent of the whole window, every platform included).
|
|
9870
10634
|
*/
|
|
9871
10635
|
by: 'platform' | 'keyword' | 'sentiment' | 'intent' | 'status' | 'hour' | 'person' | 'language' | 'country' | 'subreddit';
|
|
9872
10636
|
};
|
|
@@ -10075,9 +10839,9 @@ type UpdateChannelData = {
|
|
|
10075
10839
|
[key: string]: string;
|
|
10076
10840
|
};
|
|
10077
10841
|
/**
|
|
10078
|
-
* Replaces the whole set of account events the channel receives. A webhook takes any of them; a Slack, email or Telegram channel the attention events only (mention.spike, sentiment.negative_spike, keyword.noisy, channel.failing). An empty list unsubscribes it from all of them.
|
|
10842
|
+
* Replaces the whole set of account events the channel receives. A webhook takes any of them; a Slack, email or Telegram channel the attention events only (mention.spike, sentiment.negative_spike, keyword.noisy, channel.failing, feed.failing, feed.recovered). An empty list unsubscribes it from all of them.
|
|
10079
10843
|
*/
|
|
10080
|
-
events?: Array<'keyword.capped' | 'keyword.paused_for_balance' | 'keyword.resumed' | 'wallet.low' | 'wallet.paused' | 'wallet.resumed' | 'mention.spike' | 'sentiment.negative_spike' | 'keyword.noisy' | 'channel.failing'>;
|
|
10844
|
+
events?: Array<'keyword.capped' | 'keyword.paused_for_balance' | 'keyword.resumed' | 'wallet.low' | 'wallet.paused' | 'wallet.resumed' | 'mention.spike' | 'sentiment.negative_spike' | 'keyword.noisy' | 'channel.failing' | 'feed.failing' | 'feed.recovered'>;
|
|
10081
10845
|
};
|
|
10082
10846
|
path: {
|
|
10083
10847
|
/**
|
|
@@ -10359,6 +11123,40 @@ declare const getKeywordHealth: <ThrowOnError extends boolean = false>(options:
|
|
|
10359
11123
|
* A new keyword with this one's settings and a new `term` (or the same term in another group): its kind, platforms, context, every matching rule, its monthly mention cap and its comments setting. Review apps and feeds are copied only when listed in `include`. It is a new keyword: $5 per month, and the newest posts of the last 30 days come in at once, as with any new keyword.
|
|
10360
11124
|
*/
|
|
10361
11125
|
declare const duplicateKeyword: <ThrowOnError extends boolean = false>(options: Options<DuplicateKeywordData, ThrowOnError>) => RequestResult<DuplicateKeywordResponses, DuplicateKeywordErrors, ThrowOnError>;
|
|
11126
|
+
/**
|
|
11127
|
+
* List feeds
|
|
11128
|
+
*
|
|
11129
|
+
* The RSS and Atom feeds the workspace reads (forums, communities, blogs), newest connection first, each with how its hourly poll goes. Every keyword of the workspace with readsWorkspaceFeeds (the default) reads these feeds: an item holding its term is one of its mentions, with its matching rules, billed like any mention. Each feed is read every hour; reading it is free. At most 500 a workspace.
|
|
11130
|
+
*/
|
|
11131
|
+
declare const listFeeds: <ThrowOnError extends boolean = false>(options?: Options<ListFeedsData, ThrowOnError>) => RequestResult<ListFeedsResponses, ListFeedsErrors, ThrowOnError>;
|
|
11132
|
+
/**
|
|
11133
|
+
* Connect a feed
|
|
11134
|
+
*
|
|
11135
|
+
* Connect an RSS or Atom feed: a feed's address, or a page's (a forum, a community, a blog), in which case the feed the page advertises is used, else a usual address such as /feed or /rss. Every keyword of the workspace with readsWorkspaceFeeds (the default) reads these feeds: an item holding its term is one of its mentions, with its matching rules, billed like any mention. Each feed is read every hour; reading it is free. At most 500 a workspace. A new feed brings each reading keyword the newest 10 items of the last 30 days that hold its term, never as instant alerts. A feed the workspace reads already comes back with 200 (connecting is idempotent). A members-only forum answers `feed_login_required`: send it again with `auth` (a cookie or a header), stored encrypted and read for this workspace alone.
|
|
11136
|
+
*/
|
|
11137
|
+
declare const createFeed: <ThrowOnError extends boolean = false>(options: Options<CreateFeedData, ThrowOnError>) => RequestResult<CreateFeedResponses, CreateFeedErrors, ThrowOnError>;
|
|
11138
|
+
/**
|
|
11139
|
+
* Connect many feeds
|
|
11140
|
+
*
|
|
11141
|
+
* Connect up to 100 feeds in one call, each { url } or { url, auth } for a members-only one, checked on its own and reported added, already or failed, in the order sent: one that fails never stops the others. A failure carries the error code POST /v1/feeds would answer for that address (feed_login_required: send it again with auth). Every keyword of the workspace with readsWorkspaceFeeds (the default) reads these feeds: an item holding its term is one of its mentions, with its matching rules, billed like any mention. Each feed is read every hour; reading it is free. At most 500 a workspace. The first 8 added bring each reading keyword the newest 10 matching items of the last 30 days; the rest start from now.
|
|
11142
|
+
*/
|
|
11143
|
+
declare const importFeeds: <ThrowOnError extends boolean = false>(options: Options<ImportFeedsData, ThrowOnError>) => RequestResult<ImportFeedsResponses, ImportFeedsErrors, ThrowOnError>;
|
|
11144
|
+
/**
|
|
11145
|
+
* Disconnect a feed
|
|
11146
|
+
*
|
|
11147
|
+
* The workspace stops reading the feed. Its mentions stay; a keyword naming the same feed in its own `feeds` keeps reading it.
|
|
11148
|
+
*/
|
|
11149
|
+
declare const deleteFeed: <ThrowOnError extends boolean = false>(options: Options<DeleteFeedData, ThrowOnError>) => RequestResult<DeleteFeedResponses, DeleteFeedErrors, ThrowOnError>;
|
|
11150
|
+
/**
|
|
11151
|
+
* Get a feed
|
|
11152
|
+
*/
|
|
11153
|
+
declare const getFeed: <ThrowOnError extends boolean = false>(options: Options<GetFeedData, ThrowOnError>) => RequestResult<GetFeedResponses, GetFeedErrors, ThrowOnError>;
|
|
11154
|
+
/**
|
|
11155
|
+
* Update a feed
|
|
11156
|
+
*
|
|
11157
|
+
* Rename a feed (title, null clears it), or set its sign-in for a members-only forum (auth: a cookie copied from your browser, or one header such as Discourse's Api-Key). A sign-in is checked by reading the feed with it, stored encrypted, sent to the feed's own site alone and never shown again; the feed is then read for this workspace alone. auth: null removes it.
|
|
11158
|
+
*/
|
|
11159
|
+
declare const updateFeed: <ThrowOnError extends boolean = false>(options: Options<UpdateFeedData, ThrowOnError>) => RequestResult<UpdateFeedResponses, UpdateFeedErrors, ThrowOnError>;
|
|
10362
11160
|
/**
|
|
10363
11161
|
* Get the workspace filters
|
|
10364
11162
|
*
|
|
@@ -10392,7 +11190,7 @@ declare const searchMentions: <ThrowOnError extends boolean = false>(options?: O
|
|
|
10392
11190
|
/**
|
|
10393
11191
|
* Export mentions as CSV
|
|
10394
11192
|
*
|
|
10395
|
-
* The same mentions GET /v1/mentions would list for these filters, as CSV, newest matched first (the order they entered your feed, which can differ from the post date): id, published_at, platform, keyword, author, author_url, author_followers, relevance, sentiment, intents (pipe-separated), language, confidence, status, relevant, delivered, url, links (pipe-separated), text (first 1,000 characters), group, group_external_id, rating and app_id (app store reviews only), title and image_url (where the platform has them), duplicate_of (the mention a cross-post copies; the CSV keeps one row per mention, copies included,
|
|
11193
|
+
* The same mentions GET /v1/mentions would list for these filters, as CSV, newest matched first (the order they entered your feed, which can differ from the post date): id, published_at, platform, keyword, author, author_url, author_followers, relevance, sentiment, intents (pipe-separated), language, confidence, status, relevant, delivered, url, links (pipe-separated), text (first 1,000 characters), group, group_external_id, rating and app_id (app store reviews only), title and image_url (where the platform has them), duplicate_of (the mention a cross-post copies; the CSV keeps one row per mention, copies included; with includeHidden=true, the mentions a keyword hides by language or country too, it adds up to the bill), kind (post, comment or repository), parent_url (the post a comment answers), comments (comments of it delivered to you), subreddit and flair (Reddit only), country (where the author is, ISO 3166-1 alpha-2, empty when unknown) and organization (true when a company or organization posted). Capped at 10,000 rows; the X-Mentions-Truncated header says when the cap cut the list. At most 6 exports per minute per workspace; a 429 carries Retry-After.
|
|
10396
11194
|
*/
|
|
10397
11195
|
declare const exportMentionsCsv: <ThrowOnError extends boolean = false>(options?: Options<ExportMentionsCsvData, ThrowOnError>) => RequestResult<ExportMentionsCsvResponses, ExportMentionsCsvErrors, ThrowOnError>;
|
|
10398
11196
|
/**
|
|
@@ -10774,6 +11572,7 @@ type sdk_Options<TData extends TDataShape = TDataShape, ThrowOnError extends boo
|
|
|
10774
11572
|
declare const sdk_createAlert: typeof createAlert;
|
|
10775
11573
|
declare const sdk_createApiKey: typeof createApiKey;
|
|
10776
11574
|
declare const sdk_createChannel: typeof createChannel;
|
|
11575
|
+
declare const sdk_createFeed: typeof createFeed;
|
|
10777
11576
|
declare const sdk_createGroup: typeof createGroup;
|
|
10778
11577
|
declare const sdk_createInvitation: typeof createInvitation;
|
|
10779
11578
|
declare const sdk_createKeyword: typeof createKeyword;
|
|
@@ -10782,6 +11581,7 @@ declare const sdk_createTopUp: typeof createTopUp;
|
|
|
10782
11581
|
declare const sdk_createView: typeof createView;
|
|
10783
11582
|
declare const sdk_deleteAlert: typeof deleteAlert;
|
|
10784
11583
|
declare const sdk_deleteChannel: typeof deleteChannel;
|
|
11584
|
+
declare const sdk_deleteFeed: typeof deleteFeed;
|
|
10785
11585
|
declare const sdk_deleteGroup: typeof deleteGroup;
|
|
10786
11586
|
declare const sdk_deleteKeyword: typeof deleteKeyword;
|
|
10787
11587
|
declare const sdk_deletePersonActivity: typeof deletePersonActivity;
|
|
@@ -10798,6 +11598,7 @@ declare const sdk_getAnalyticsSeries: typeof getAnalyticsSeries;
|
|
|
10798
11598
|
declare const sdk_getAnalyticsSummary: typeof getAnalyticsSummary;
|
|
10799
11599
|
declare const sdk_getChannel: typeof getChannel;
|
|
10800
11600
|
declare const sdk_getCompany: typeof getCompany;
|
|
11601
|
+
declare const sdk_getFeed: typeof getFeed;
|
|
10801
11602
|
declare const sdk_getFilters: typeof getFilters;
|
|
10802
11603
|
declare const sdk_getGroup: typeof getGroup;
|
|
10803
11604
|
declare const sdk_getHealth: typeof getHealth;
|
|
@@ -10813,11 +11614,13 @@ declare const sdk_getUsage: typeof getUsage;
|
|
|
10813
11614
|
declare const sdk_getUsageBreakdown: typeof getUsageBreakdown;
|
|
10814
11615
|
declare const sdk_getView: typeof getView;
|
|
10815
11616
|
declare const sdk_getWallet: typeof getWallet;
|
|
11617
|
+
declare const sdk_importFeeds: typeof importFeeds;
|
|
10816
11618
|
declare const sdk_listAlerts: typeof listAlerts;
|
|
10817
11619
|
declare const sdk_listApiKeys: typeof listApiKeys;
|
|
10818
11620
|
declare const sdk_listAttention: typeof listAttention;
|
|
10819
11621
|
declare const sdk_listChannelDeliveries: typeof listChannelDeliveries;
|
|
10820
11622
|
declare const sdk_listChannels: typeof listChannels;
|
|
11623
|
+
declare const sdk_listFeeds: typeof listFeeds;
|
|
10821
11624
|
declare const sdk_listGroups: typeof listGroups;
|
|
10822
11625
|
declare const sdk_listInvitations: typeof listInvitations;
|
|
10823
11626
|
declare const sdk_listInvoices: typeof listInvoices;
|
|
@@ -10845,6 +11648,7 @@ declare const sdk_unmuteAlertAuthors: typeof unmuteAlertAuthors;
|
|
|
10845
11648
|
declare const sdk_updateAlert: typeof updateAlert;
|
|
10846
11649
|
declare const sdk_updateChannel: typeof updateChannel;
|
|
10847
11650
|
declare const sdk_updateCompany: typeof updateCompany;
|
|
11651
|
+
declare const sdk_updateFeed: typeof updateFeed;
|
|
10848
11652
|
declare const sdk_updateFilters: typeof updateFilters;
|
|
10849
11653
|
declare const sdk_updateGroup: typeof updateGroup;
|
|
10850
11654
|
declare const sdk_updateKeyword: typeof updateKeyword;
|
|
@@ -10854,7 +11658,7 @@ declare const sdk_updateSegment: typeof updateSegment;
|
|
|
10854
11658
|
declare const sdk_updateView: typeof updateView;
|
|
10855
11659
|
declare const sdk_whoami: typeof whoami;
|
|
10856
11660
|
declare namespace sdk {
|
|
10857
|
-
export { type sdk_Options as Options, sdk_createAlert as createAlert, sdk_createApiKey as createApiKey, sdk_createChannel as createChannel, 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_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_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_listAlerts as listAlerts, sdk_listApiKeys as listApiKeys, sdk_listAttention as listAttention, sdk_listChannelDeliveries as listChannelDeliveries, sdk_listChannels as listChannels, 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_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_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 };
|
|
11661
|
+
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_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 };
|
|
10858
11662
|
}
|
|
10859
11663
|
|
|
10860
11664
|
/**
|
|
@@ -10882,4 +11686,4 @@ type Mentio = typeof sdk & {
|
|
|
10882
11686
|
};
|
|
10883
11687
|
declare function createMentio(options: MentioOptions): Mentio;
|
|
10884
11688
|
|
|
10885
|
-
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 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 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 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 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 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 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 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 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 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, createGroup, createInvitation, createKeyword, createMentio, createSegment, createTopUp, createView, deleteAlert, deleteChannel, deleteGroup, deleteKeyword, deletePersonActivity, deleteSegment, deleteView, dismissAttention, duplicateKeyword, exportMentionsCsv, exportMentionsJson, exportPeopleCsv, getAlert, getAnalyticsBreakdown, getAnalyticsSeries, getAnalyticsSummary, getChannel, getCompany, getFilters, getGroup, getHealth, getInvoiceUrl, getKeyword, getKeywordHealth, getMention, getPerson, getReviewsReport, getSegment, getShareOfVoice, getUsage, getUsageBreakdown, getView, getWallet, listAlerts, listApiKeys, listAttention, listChannelDeliveries, listChannels, listGroups, listInvitations, listInvoices, listKeywords, listLedger, listMembers, listMentionComments, listPeople, listPersonActivities, listSegments, listViews, logPersonActivity, mergePeople, muteAlertAuthors, removeMember, revokeApiKey, revokeInvitation, rotateWebhookSecret, runAlertDigest, searchMentions, splitPerson, testAlert, testChannel, unmuteAlertAuthors, updateAlert, updateChannel, updateCompany, updateFilters, updateGroup, updateKeyword, updateMention, updatePerson, updateSegment, updateView, whoami };
|
|
11689
|
+
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 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 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, 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 };
|