@mentio-dev/sdk 0.8.1 → 0.9.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 +411 -13
- package/dist/index.js +43 -0
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -330,6 +330,27 @@ declare const createClient: (config?: Config) => Client;
|
|
|
330
330
|
type ClientOptions = {
|
|
331
331
|
baseUrl: 'https://api.mentio.dev' | (string & {});
|
|
332
332
|
};
|
|
333
|
+
/**
|
|
334
|
+
* The group the keyword belongs to.
|
|
335
|
+
*/
|
|
336
|
+
type GroupRef = {
|
|
337
|
+
/**
|
|
338
|
+
* Group id (grp_...).
|
|
339
|
+
*/
|
|
340
|
+
id: string;
|
|
341
|
+
/**
|
|
342
|
+
* The group's name.
|
|
343
|
+
*/
|
|
344
|
+
name: string;
|
|
345
|
+
/**
|
|
346
|
+
* Your own id for the group, or null.
|
|
347
|
+
*/
|
|
348
|
+
externalId: string | null;
|
|
349
|
+
/**
|
|
350
|
+
* The workspace's default group, where a keyword lands when no group is named.
|
|
351
|
+
*/
|
|
352
|
+
isDefault: boolean;
|
|
353
|
+
};
|
|
333
354
|
type Keyword = {
|
|
334
355
|
/**
|
|
335
356
|
* Keyword id (kw_...).
|
|
@@ -358,12 +379,13 @@ type Keyword = {
|
|
|
358
379
|
*/
|
|
359
380
|
mentions: number;
|
|
360
381
|
} | null;
|
|
382
|
+
group: GroupRef;
|
|
361
383
|
/**
|
|
362
384
|
* Platforms this keyword is tracked on; null means every platform.
|
|
363
385
|
*/
|
|
364
386
|
platforms: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin'> | null;
|
|
365
387
|
/**
|
|
366
|
-
* A sentence the classifier reads for this keyword only, on top of the company profile (at most 300 characters): what the term means here, what to ignore. "Arc is our browser; ignore the geometry word." Null clears it.
|
|
388
|
+
* A sentence the classifier reads for this keyword only, on top of the company profile or the group's own description (at most 300 characters): what the term means here, what to ignore. "Arc is our browser; ignore the geometry word." Null clears it.
|
|
367
389
|
*/
|
|
368
390
|
context: string | null;
|
|
369
391
|
/**
|
|
@@ -501,7 +523,7 @@ type ErrorResponse = {
|
|
|
501
523
|
/**
|
|
502
524
|
* 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.
|
|
503
525
|
*/
|
|
504
|
-
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' | 'slack_not_connected' | 'slack_not_configured' | 'telegram_not_configured' | 'email_not_configured' | 'invalid_assignee' | 'classification_pending' | 'invalid_member' | 'already_member' | 'last_owner' | 'duplicate_segment' | 'duplicate_view' | 'invalid_signature' | 'webhook_not_configured' | 'invalid_token' | 'protected_user' | 'upstream_unavailable' | 'internal_error';
|
|
526
|
+
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' | 'slack_not_connected' | 'slack_not_configured' | 'telegram_not_configured' | 'email_not_configured' | 'invalid_assignee' | 'classification_pending' | 'invalid_member' | 'already_member' | 'last_owner' | 'duplicate_segment' | 'duplicate_view' | 'duplicate_group' | 'default_group' | 'default_group_context' | 'group_changed' | 'invalid_signature' | 'webhook_not_configured' | 'invalid_token' | 'protected_user' | 'upstream_unavailable' | 'internal_error';
|
|
505
527
|
/**
|
|
506
528
|
* Human-readable detail; may change between releases.
|
|
507
529
|
*/
|
|
@@ -572,11 +594,18 @@ type Mention = {
|
|
|
572
594
|
*/
|
|
573
595
|
priority: number;
|
|
574
596
|
/**
|
|
575
|
-
* The keyword this post matched.
|
|
597
|
+
* The keyword this post matched, and the group it is in.
|
|
576
598
|
*/
|
|
577
599
|
keyword: {
|
|
600
|
+
/**
|
|
601
|
+
* Keyword id (kw_...).
|
|
602
|
+
*/
|
|
578
603
|
id: string;
|
|
604
|
+
/**
|
|
605
|
+
* The tracked term.
|
|
606
|
+
*/
|
|
579
607
|
term: string;
|
|
608
|
+
group: GroupRef;
|
|
580
609
|
};
|
|
581
610
|
post: {
|
|
582
611
|
/**
|
|
@@ -1051,6 +1080,14 @@ type View = {
|
|
|
1051
1080
|
* Only matches of keywords of any of these kinds: brand, competitor, topic.
|
|
1052
1081
|
*/
|
|
1053
1082
|
keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
1083
|
+
/**
|
|
1084
|
+
* Only matches of keywords in any of these groups (grp_...).
|
|
1085
|
+
*/
|
|
1086
|
+
groupIds?: Array<string>;
|
|
1087
|
+
/**
|
|
1088
|
+
* Never matches of keywords in these groups.
|
|
1089
|
+
*/
|
|
1090
|
+
notGroupIds?: Array<string>;
|
|
1054
1091
|
/**
|
|
1055
1092
|
* Only posts from any of these platforms.
|
|
1056
1093
|
*/
|
|
@@ -1145,6 +1182,36 @@ type View = {
|
|
|
1145
1182
|
*/
|
|
1146
1183
|
updatedAt: string;
|
|
1147
1184
|
};
|
|
1185
|
+
/**
|
|
1186
|
+
* The group the keyword belongs to.
|
|
1187
|
+
*/
|
|
1188
|
+
type Group = GroupRef & {
|
|
1189
|
+
/**
|
|
1190
|
+
* The group's own company description for the classifier, or null for the workspace profile.
|
|
1191
|
+
*/
|
|
1192
|
+
context: string | null;
|
|
1193
|
+
/**
|
|
1194
|
+
* Computed over the group's keywords.
|
|
1195
|
+
*/
|
|
1196
|
+
stats: {
|
|
1197
|
+
/**
|
|
1198
|
+
* Keywords in the group, muted ones included.
|
|
1199
|
+
*/
|
|
1200
|
+
keywords: number;
|
|
1201
|
+
/**
|
|
1202
|
+
* Keywords in the group that are tracking (not muted).
|
|
1203
|
+
*/
|
|
1204
|
+
active: number;
|
|
1205
|
+
};
|
|
1206
|
+
/**
|
|
1207
|
+
* ISO 8601 timestamp, UTC.
|
|
1208
|
+
*/
|
|
1209
|
+
createdAt: string;
|
|
1210
|
+
/**
|
|
1211
|
+
* ISO 8601 timestamp, UTC.
|
|
1212
|
+
*/
|
|
1213
|
+
updatedAt: string;
|
|
1214
|
+
};
|
|
1148
1215
|
type Company = {
|
|
1149
1216
|
/**
|
|
1150
1217
|
* Brand or company name, as the classifier should call it.
|
|
@@ -1405,7 +1472,7 @@ type UsageBreakdown = {
|
|
|
1405
1472
|
/**
|
|
1406
1473
|
* The dimension the rows are grouped by.
|
|
1407
1474
|
*/
|
|
1408
|
-
by: 'day' | 'platform' | 'keyword';
|
|
1475
|
+
by: 'day' | 'platform' | 'keyword' | 'group';
|
|
1409
1476
|
/**
|
|
1410
1477
|
* Every amount is in USD cents.
|
|
1411
1478
|
*/
|
|
@@ -1456,11 +1523,11 @@ type UsageBreakdown = {
|
|
|
1456
1523
|
*/
|
|
1457
1524
|
data: Array<{
|
|
1458
1525
|
/**
|
|
1459
|
-
* The
|
|
1526
|
+
* The row's key: the UTC day (YYYY-MM-DD) for by=day, the platform for by=platform, the keyword id for by=keyword, the group id for by=group.
|
|
1460
1527
|
*/
|
|
1461
1528
|
key: string;
|
|
1462
1529
|
/**
|
|
1463
|
-
* Readable name: the keyword term, otherwise the key.
|
|
1530
|
+
* Readable name: the keyword term or the group name, otherwise the key.
|
|
1464
1531
|
*/
|
|
1465
1532
|
label: string;
|
|
1466
1533
|
/**
|
|
@@ -1480,6 +1547,23 @@ type UsageBreakdown = {
|
|
|
1480
1547
|
*/
|
|
1481
1548
|
removed: boolean;
|
|
1482
1549
|
} | null;
|
|
1550
|
+
/**
|
|
1551
|
+
* by=group only; null otherwise.
|
|
1552
|
+
*/
|
|
1553
|
+
group: {
|
|
1554
|
+
/**
|
|
1555
|
+
* Group id, or "none" for keyword-days metered before groups existed whose keyword is gone.
|
|
1556
|
+
*/
|
|
1557
|
+
id: string;
|
|
1558
|
+
/**
|
|
1559
|
+
* The group's name as it reads now, or "Deleted group" / "No group".
|
|
1560
|
+
*/
|
|
1561
|
+
name: string;
|
|
1562
|
+
/**
|
|
1563
|
+
* The group has since been deleted.
|
|
1564
|
+
*/
|
|
1565
|
+
removed: boolean;
|
|
1566
|
+
} | null;
|
|
1483
1567
|
/**
|
|
1484
1568
|
* Keyword-days metered in this group: the days the daily tick charged for. Null for by=platform (a keyword-day belongs to no platform) and for a day before the first recorded tick (unknown, not zero); a keyword row counts only the days on record, so before window.keywordDaysFrom it is a floor, not a zero.
|
|
1485
1569
|
*/
|
|
@@ -1713,6 +1797,10 @@ type Alert = {
|
|
|
1713
1797
|
* Only these keywords.
|
|
1714
1798
|
*/
|
|
1715
1799
|
keywordIds?: Array<string>;
|
|
1800
|
+
/**
|
|
1801
|
+
* Only keywords in these groups (grp_...): one rule per customer, say.
|
|
1802
|
+
*/
|
|
1803
|
+
groupIds?: Array<string>;
|
|
1716
1804
|
/**
|
|
1717
1805
|
* Only posts from these platforms.
|
|
1718
1806
|
*/
|
|
@@ -2061,6 +2149,7 @@ type AnalyticsSeries = {
|
|
|
2061
2149
|
* brand, competitor or topic.
|
|
2062
2150
|
*/
|
|
2063
2151
|
kind: 'brand' | 'competitor' | 'topic';
|
|
2152
|
+
group: GroupRef & unknown;
|
|
2064
2153
|
} | null;
|
|
2065
2154
|
/**
|
|
2066
2155
|
* One point per bucket across the window, oldest first, zero-filled.
|
|
@@ -2124,6 +2213,7 @@ type AnalyticsSeries = {
|
|
|
2124
2213
|
* brand, competitor or topic.
|
|
2125
2214
|
*/
|
|
2126
2215
|
kind: 'brand' | 'competitor' | 'topic';
|
|
2216
|
+
group: GroupRef & unknown;
|
|
2127
2217
|
} | null;
|
|
2128
2218
|
/**
|
|
2129
2219
|
* One point per bucket across the window, oldest first, zero-filled.
|
|
@@ -2214,6 +2304,7 @@ type AnalyticsBreakdown = {
|
|
|
2214
2304
|
* brand, competitor or topic.
|
|
2215
2305
|
*/
|
|
2216
2306
|
kind: 'brand' | 'competitor' | 'topic';
|
|
2307
|
+
group: GroupRef & unknown;
|
|
2217
2308
|
} | null;
|
|
2218
2309
|
/**
|
|
2219
2310
|
* by=person only; null otherwise.
|
|
@@ -2347,6 +2438,7 @@ type ShareOfVoice = {
|
|
|
2347
2438
|
* brand, competitor or topic.
|
|
2348
2439
|
*/
|
|
2349
2440
|
kind: 'brand' | 'competitor' | 'topic';
|
|
2441
|
+
group: GroupRef & unknown;
|
|
2350
2442
|
};
|
|
2351
2443
|
/**
|
|
2352
2444
|
* Matches of this keyword in the window.
|
|
@@ -2643,6 +2735,10 @@ type ListKeywordsData = {
|
|
|
2643
2735
|
* Text to find in the term or in the keyword's context, case-insensitive.
|
|
2644
2736
|
*/
|
|
2645
2737
|
q?: string;
|
|
2738
|
+
/**
|
|
2739
|
+
* Only keywords in any of these groups (grp_...). Repeatable, or comma-separated.
|
|
2740
|
+
*/
|
|
2741
|
+
groupId?: Array<string> | null;
|
|
2646
2742
|
/**
|
|
2647
2743
|
* Only these kinds: brand, competitor, topic. Repeatable, or comma-separated.
|
|
2648
2744
|
*/
|
|
@@ -2714,12 +2810,13 @@ type ListKeywordsResponses = {
|
|
|
2714
2810
|
*/
|
|
2715
2811
|
mentions: number;
|
|
2716
2812
|
} | null;
|
|
2813
|
+
group: GroupRef;
|
|
2717
2814
|
/**
|
|
2718
2815
|
* Platforms this keyword is tracked on; null means every platform.
|
|
2719
2816
|
*/
|
|
2720
2817
|
platforms: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin'> | null;
|
|
2721
2818
|
/**
|
|
2722
|
-
* A sentence the classifier reads for this keyword only, on top of the company profile (at most 300 characters): what the term means here, what to ignore. "Arc is our browser; ignore the geometry word." Null clears it.
|
|
2819
|
+
* A sentence the classifier reads for this keyword only, on top of the company profile or the group's own description (at most 300 characters): what the term means here, what to ignore. "Arc is our browser; ignore the geometry word." Null clears it.
|
|
2723
2820
|
*/
|
|
2724
2821
|
context: string | null;
|
|
2725
2822
|
/**
|
|
@@ -2871,7 +2968,7 @@ type CreateKeywordData = {
|
|
|
2871
2968
|
*/
|
|
2872
2969
|
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin'> | null;
|
|
2873
2970
|
/**
|
|
2874
|
-
* A sentence the classifier reads for this keyword only, on top of the company profile (at most 300 characters): what the term means here, what to ignore. "Arc is our browser; ignore the geometry word." Null clears it.
|
|
2971
|
+
* A sentence the classifier reads for this keyword only, on top of the company profile or the group's own description (at most 300 characters): what the term means here, what to ignore. "Arc is our browser; ignore the geometry word." Null clears it.
|
|
2875
2972
|
*/
|
|
2876
2973
|
context?: string | null;
|
|
2877
2974
|
/**
|
|
@@ -2908,6 +3005,10 @@ type CreateKeywordData = {
|
|
|
2908
3005
|
*/
|
|
2909
3006
|
mentions: number;
|
|
2910
3007
|
} | null;
|
|
3008
|
+
/**
|
|
3009
|
+
* The group to track it in (grp_...); omit for the workspace's default group. A term may be tracked once per group.
|
|
3010
|
+
*/
|
|
3011
|
+
groupId?: string;
|
|
2911
3012
|
};
|
|
2912
3013
|
path?: never;
|
|
2913
3014
|
query?: never;
|
|
@@ -3011,7 +3112,7 @@ type UpdateKeywordData = {
|
|
|
3011
3112
|
*/
|
|
3012
3113
|
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin'> | null;
|
|
3013
3114
|
/**
|
|
3014
|
-
* A sentence the classifier reads for this keyword only, on top of the company profile (at most 300 characters): what the term means here, what to ignore. "Arc is our browser; ignore the geometry word." Null clears it.
|
|
3115
|
+
* A sentence the classifier reads for this keyword only, on top of the company profile or the group's own description (at most 300 characters): what the term means here, what to ignore. "Arc is our browser; ignore the geometry word." Null clears it.
|
|
3015
3116
|
*/
|
|
3016
3117
|
context?: string | null;
|
|
3017
3118
|
/**
|
|
@@ -3048,6 +3149,10 @@ type UpdateKeywordData = {
|
|
|
3048
3149
|
*/
|
|
3049
3150
|
mentions: number;
|
|
3050
3151
|
} | null;
|
|
3152
|
+
/**
|
|
3153
|
+
* Moves the keyword to this group (grp_...). A 409 when that group already tracks the term.
|
|
3154
|
+
*/
|
|
3155
|
+
groupId?: string;
|
|
3051
3156
|
};
|
|
3052
3157
|
path: {
|
|
3053
3158
|
/**
|
|
@@ -3351,6 +3456,14 @@ type SearchMentionsData = {
|
|
|
3351
3456
|
* Only matches of any of these keywords.
|
|
3352
3457
|
*/
|
|
3353
3458
|
keywordIds?: Array<string> | null;
|
|
3459
|
+
/**
|
|
3460
|
+
* Only matches of keywords in any of these groups (grp_...). Repeatable, or comma-separated.
|
|
3461
|
+
*/
|
|
3462
|
+
groupIds?: Array<string> | null;
|
|
3463
|
+
/**
|
|
3464
|
+
* Never matches of keywords in these groups.
|
|
3465
|
+
*/
|
|
3466
|
+
notGroupIds?: Array<string> | null;
|
|
3354
3467
|
/**
|
|
3355
3468
|
* Never matches of these keywords.
|
|
3356
3469
|
*/
|
|
@@ -3542,6 +3655,14 @@ type ExportMentionsCsvData = {
|
|
|
3542
3655
|
* Only matches of any of these keywords.
|
|
3543
3656
|
*/
|
|
3544
3657
|
keywordIds?: Array<string> | null;
|
|
3658
|
+
/**
|
|
3659
|
+
* Only matches of keywords in any of these groups (grp_...). Repeatable, or comma-separated.
|
|
3660
|
+
*/
|
|
3661
|
+
groupIds?: Array<string> | null;
|
|
3662
|
+
/**
|
|
3663
|
+
* Never matches of keywords in these groups.
|
|
3664
|
+
*/
|
|
3665
|
+
notGroupIds?: Array<string> | null;
|
|
3545
3666
|
/**
|
|
3546
3667
|
* Never matches of these keywords.
|
|
3547
3668
|
*/
|
|
@@ -4840,6 +4961,14 @@ type ListViewsResponses = {
|
|
|
4840
4961
|
* Only matches of keywords of any of these kinds: brand, competitor, topic.
|
|
4841
4962
|
*/
|
|
4842
4963
|
keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
4964
|
+
/**
|
|
4965
|
+
* Only matches of keywords in any of these groups (grp_...).
|
|
4966
|
+
*/
|
|
4967
|
+
groupIds?: Array<string>;
|
|
4968
|
+
/**
|
|
4969
|
+
* Never matches of keywords in these groups.
|
|
4970
|
+
*/
|
|
4971
|
+
notGroupIds?: Array<string>;
|
|
4843
4972
|
/**
|
|
4844
4973
|
* Only posts from any of these platforms.
|
|
4845
4974
|
*/
|
|
@@ -4967,6 +5096,14 @@ type CreateViewData = {
|
|
|
4967
5096
|
* Only matches of keywords of any of these kinds: brand, competitor, topic.
|
|
4968
5097
|
*/
|
|
4969
5098
|
keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
5099
|
+
/**
|
|
5100
|
+
* Only matches of keywords in any of these groups (grp_...).
|
|
5101
|
+
*/
|
|
5102
|
+
groupIds?: Array<string>;
|
|
5103
|
+
/**
|
|
5104
|
+
* Never matches of keywords in these groups.
|
|
5105
|
+
*/
|
|
5106
|
+
notGroupIds?: Array<string>;
|
|
4970
5107
|
/**
|
|
4971
5108
|
* Only posts from any of these platforms.
|
|
4972
5109
|
*/
|
|
@@ -5157,6 +5294,14 @@ type UpdateViewData = {
|
|
|
5157
5294
|
* Only matches of keywords of any of these kinds: brand, competitor, topic.
|
|
5158
5295
|
*/
|
|
5159
5296
|
keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
|
|
5297
|
+
/**
|
|
5298
|
+
* Only matches of keywords in any of these groups (grp_...).
|
|
5299
|
+
*/
|
|
5300
|
+
groupIds?: Array<string>;
|
|
5301
|
+
/**
|
|
5302
|
+
* Never matches of keywords in these groups.
|
|
5303
|
+
*/
|
|
5304
|
+
notGroupIds?: Array<string>;
|
|
5160
5305
|
/**
|
|
5161
5306
|
* Only posts from any of these platforms.
|
|
5162
5307
|
*/
|
|
@@ -5274,6 +5419,214 @@ type UpdateViewResponses = {
|
|
|
5274
5419
|
200: View;
|
|
5275
5420
|
};
|
|
5276
5421
|
type UpdateViewResponse = UpdateViewResponses[keyof UpdateViewResponses];
|
|
5422
|
+
type ListGroupsData = {
|
|
5423
|
+
body?: never;
|
|
5424
|
+
path?: never;
|
|
5425
|
+
query?: {
|
|
5426
|
+
/**
|
|
5427
|
+
* Only the group carrying exactly this externalId.
|
|
5428
|
+
*/
|
|
5429
|
+
externalId?: string;
|
|
5430
|
+
};
|
|
5431
|
+
url: '/v1/groups';
|
|
5432
|
+
};
|
|
5433
|
+
type ListGroupsErrors = {
|
|
5434
|
+
/**
|
|
5435
|
+
* Missing or invalid API key
|
|
5436
|
+
*/
|
|
5437
|
+
401: ErrorResponse;
|
|
5438
|
+
};
|
|
5439
|
+
type ListGroupsError = ListGroupsErrors[keyof ListGroupsErrors];
|
|
5440
|
+
type ListGroupsResponses = {
|
|
5441
|
+
/**
|
|
5442
|
+
* The groups
|
|
5443
|
+
*/
|
|
5444
|
+
200: {
|
|
5445
|
+
/**
|
|
5446
|
+
* The group the keyword belongs to.
|
|
5447
|
+
*/
|
|
5448
|
+
data: Array<GroupRef & {
|
|
5449
|
+
/**
|
|
5450
|
+
* The group's own company description for the classifier, or null for the workspace profile.
|
|
5451
|
+
*/
|
|
5452
|
+
context: string | null;
|
|
5453
|
+
/**
|
|
5454
|
+
* Computed over the group's keywords.
|
|
5455
|
+
*/
|
|
5456
|
+
stats: {
|
|
5457
|
+
/**
|
|
5458
|
+
* Keywords in the group, muted ones included.
|
|
5459
|
+
*/
|
|
5460
|
+
keywords: number;
|
|
5461
|
+
/**
|
|
5462
|
+
* Keywords in the group that are tracking (not muted).
|
|
5463
|
+
*/
|
|
5464
|
+
active: number;
|
|
5465
|
+
};
|
|
5466
|
+
/**
|
|
5467
|
+
* ISO 8601 timestamp, UTC.
|
|
5468
|
+
*/
|
|
5469
|
+
createdAt: string;
|
|
5470
|
+
/**
|
|
5471
|
+
* ISO 8601 timestamp, UTC.
|
|
5472
|
+
*/
|
|
5473
|
+
updatedAt: string;
|
|
5474
|
+
}>;
|
|
5475
|
+
};
|
|
5476
|
+
};
|
|
5477
|
+
type ListGroupsResponse = ListGroupsResponses[keyof ListGroupsResponses];
|
|
5478
|
+
type CreateGroupData = {
|
|
5479
|
+
body: {
|
|
5480
|
+
/**
|
|
5481
|
+
* The group's name: a customer, a campaign, a product. Unique per workspace.
|
|
5482
|
+
*/
|
|
5483
|
+
name: string;
|
|
5484
|
+
/**
|
|
5485
|
+
* Your own id for the group (a customer id, say). Unique per workspace; find the group by it with GET /v1/groups?externalId=.
|
|
5486
|
+
*/
|
|
5487
|
+
externalId?: string | null;
|
|
5488
|
+
/**
|
|
5489
|
+
* What the classifier reads as "the company" for this group's keywords, in place of the WHOLE workspace profile, its relevance guidelines and competitor list included (at most 4000 characters): who the business is, what it sells, for whom, what is not it, and any rule that should apply to this group ("ignore job posts"). For a group per customer, the customer's description. Null: the workspace profile, as for every keyword before groups.
|
|
5490
|
+
*/
|
|
5491
|
+
context?: string | null;
|
|
5492
|
+
};
|
|
5493
|
+
path?: never;
|
|
5494
|
+
query?: never;
|
|
5495
|
+
url: '/v1/groups';
|
|
5496
|
+
};
|
|
5497
|
+
type CreateGroupErrors = {
|
|
5498
|
+
/**
|
|
5499
|
+
* Missing or invalid API key
|
|
5500
|
+
*/
|
|
5501
|
+
401: ErrorResponse;
|
|
5502
|
+
/**
|
|
5503
|
+
* A group with that name or externalId already exists (duplicate_group)
|
|
5504
|
+
*/
|
|
5505
|
+
409: ErrorResponse;
|
|
5506
|
+
};
|
|
5507
|
+
type CreateGroupError = CreateGroupErrors[keyof CreateGroupErrors];
|
|
5508
|
+
type CreateGroupResponses = {
|
|
5509
|
+
/**
|
|
5510
|
+
* The new group
|
|
5511
|
+
*/
|
|
5512
|
+
201: Group;
|
|
5513
|
+
};
|
|
5514
|
+
type CreateGroupResponse = CreateGroupResponses[keyof CreateGroupResponses];
|
|
5515
|
+
type DeleteGroupData = {
|
|
5516
|
+
body?: never;
|
|
5517
|
+
path: {
|
|
5518
|
+
/**
|
|
5519
|
+
* Group id (grp_...).
|
|
5520
|
+
*/
|
|
5521
|
+
id: string;
|
|
5522
|
+
};
|
|
5523
|
+
query?: never;
|
|
5524
|
+
url: '/v1/groups/{id}';
|
|
5525
|
+
};
|
|
5526
|
+
type DeleteGroupErrors = {
|
|
5527
|
+
/**
|
|
5528
|
+
* Missing or invalid API key
|
|
5529
|
+
*/
|
|
5530
|
+
401: ErrorResponse;
|
|
5531
|
+
/**
|
|
5532
|
+
* No such group in this workspace
|
|
5533
|
+
*/
|
|
5534
|
+
404: ErrorResponse;
|
|
5535
|
+
/**
|
|
5536
|
+
* The default group cannot be deleted (default_group)
|
|
5537
|
+
*/
|
|
5538
|
+
409: ErrorResponse;
|
|
5539
|
+
};
|
|
5540
|
+
type DeleteGroupError = DeleteGroupErrors[keyof DeleteGroupErrors];
|
|
5541
|
+
type DeleteGroupResponses = {
|
|
5542
|
+
/**
|
|
5543
|
+
* Deleted, with its keywords
|
|
5544
|
+
*/
|
|
5545
|
+
204: void;
|
|
5546
|
+
};
|
|
5547
|
+
type DeleteGroupResponse = DeleteGroupResponses[keyof DeleteGroupResponses];
|
|
5548
|
+
type GetGroupData = {
|
|
5549
|
+
body?: never;
|
|
5550
|
+
path: {
|
|
5551
|
+
/**
|
|
5552
|
+
* Group id (grp_...).
|
|
5553
|
+
*/
|
|
5554
|
+
id: string;
|
|
5555
|
+
};
|
|
5556
|
+
query?: never;
|
|
5557
|
+
url: '/v1/groups/{id}';
|
|
5558
|
+
};
|
|
5559
|
+
type GetGroupErrors = {
|
|
5560
|
+
/**
|
|
5561
|
+
* Missing or invalid API key
|
|
5562
|
+
*/
|
|
5563
|
+
401: ErrorResponse;
|
|
5564
|
+
/**
|
|
5565
|
+
* No such group in this workspace
|
|
5566
|
+
*/
|
|
5567
|
+
404: ErrorResponse;
|
|
5568
|
+
};
|
|
5569
|
+
type GetGroupError = GetGroupErrors[keyof GetGroupErrors];
|
|
5570
|
+
type GetGroupResponses = {
|
|
5571
|
+
/**
|
|
5572
|
+
* The group
|
|
5573
|
+
*/
|
|
5574
|
+
200: Group;
|
|
5575
|
+
};
|
|
5576
|
+
type GetGroupResponse = GetGroupResponses[keyof GetGroupResponses];
|
|
5577
|
+
type UpdateGroupData = {
|
|
5578
|
+
/**
|
|
5579
|
+
* Omitted fields are untouched.
|
|
5580
|
+
*/
|
|
5581
|
+
body: {
|
|
5582
|
+
/**
|
|
5583
|
+
* The group's name: a customer, a campaign, a product. Unique per workspace.
|
|
5584
|
+
*/
|
|
5585
|
+
name?: string;
|
|
5586
|
+
/**
|
|
5587
|
+
* Replaces your id for the group; null clears it.
|
|
5588
|
+
*/
|
|
5589
|
+
externalId?: string | null;
|
|
5590
|
+
/**
|
|
5591
|
+
* Replaces the group's company description; null clears it (the workspace profile applies again). New mentions are judged with it at once; old ones are not rescored. Not on the default group (400 default_group_context): that one is the workspace itself and reads the profile.
|
|
5592
|
+
*/
|
|
5593
|
+
context?: string | null;
|
|
5594
|
+
};
|
|
5595
|
+
path: {
|
|
5596
|
+
/**
|
|
5597
|
+
* Group id (grp_...).
|
|
5598
|
+
*/
|
|
5599
|
+
id: string;
|
|
5600
|
+
};
|
|
5601
|
+
query?: never;
|
|
5602
|
+
url: '/v1/groups/{id}';
|
|
5603
|
+
};
|
|
5604
|
+
type UpdateGroupErrors = {
|
|
5605
|
+
/**
|
|
5606
|
+
* A company description on the default group (default_group_context)
|
|
5607
|
+
*/
|
|
5608
|
+
400: ErrorResponse;
|
|
5609
|
+
/**
|
|
5610
|
+
* Missing or invalid API key
|
|
5611
|
+
*/
|
|
5612
|
+
401: ErrorResponse;
|
|
5613
|
+
/**
|
|
5614
|
+
* No such group in this workspace
|
|
5615
|
+
*/
|
|
5616
|
+
404: ErrorResponse;
|
|
5617
|
+
/**
|
|
5618
|
+
* A group with that name or externalId already exists (duplicate_group)
|
|
5619
|
+
*/
|
|
5620
|
+
409: ErrorResponse;
|
|
5621
|
+
};
|
|
5622
|
+
type UpdateGroupError = UpdateGroupErrors[keyof UpdateGroupErrors];
|
|
5623
|
+
type UpdateGroupResponses = {
|
|
5624
|
+
/**
|
|
5625
|
+
* The updated group
|
|
5626
|
+
*/
|
|
5627
|
+
200: Group;
|
|
5628
|
+
};
|
|
5629
|
+
type UpdateGroupResponse = UpdateGroupResponses[keyof UpdateGroupResponses];
|
|
5277
5630
|
type GetCompanyData = {
|
|
5278
5631
|
body?: never;
|
|
5279
5632
|
path?: never;
|
|
@@ -5696,9 +6049,9 @@ type GetUsageBreakdownData = {
|
|
|
5696
6049
|
path?: never;
|
|
5697
6050
|
query?: {
|
|
5698
6051
|
/**
|
|
5699
|
-
* The dimension to group by: day (one row per UTC day of the window), platform,
|
|
6052
|
+
* The dimension to group by: day (one row per UTC day of the window), platform, keyword (default: the row a margin is computed from), or group (what a customer or a campaign cost).
|
|
5700
6053
|
*/
|
|
5701
|
-
by?: 'day' | 'platform' | 'keyword';
|
|
6054
|
+
by?: 'day' | 'platform' | 'keyword' | 'group';
|
|
5702
6055
|
/**
|
|
5703
6056
|
* Trailing window of UTC days ending today: 7d, 30d, 90d (default 30d). Ignored when `month` is given.
|
|
5704
6057
|
*/
|
|
@@ -5975,6 +6328,10 @@ type UpdateAlertData = {
|
|
|
5975
6328
|
* Only these keywords.
|
|
5976
6329
|
*/
|
|
5977
6330
|
keywordIds?: Array<string>;
|
|
6331
|
+
/**
|
|
6332
|
+
* Only keywords in these groups (grp_...): one rule per customer, say.
|
|
6333
|
+
*/
|
|
6334
|
+
groupIds?: Array<string>;
|
|
5978
6335
|
/**
|
|
5979
6336
|
* Only posts from these platforms.
|
|
5980
6337
|
*/
|
|
@@ -6101,6 +6458,10 @@ type ListAlertsResponses = {
|
|
|
6101
6458
|
* Only these keywords.
|
|
6102
6459
|
*/
|
|
6103
6460
|
keywordIds?: Array<string>;
|
|
6461
|
+
/**
|
|
6462
|
+
* Only keywords in these groups (grp_...): one rule per customer, say.
|
|
6463
|
+
*/
|
|
6464
|
+
groupIds?: Array<string>;
|
|
6104
6465
|
/**
|
|
6105
6466
|
* Only posts from these platforms.
|
|
6106
6467
|
*/
|
|
@@ -6206,6 +6567,10 @@ type CreateAlertData = {
|
|
|
6206
6567
|
* Only these keywords.
|
|
6207
6568
|
*/
|
|
6208
6569
|
keywordIds?: Array<string>;
|
|
6570
|
+
/**
|
|
6571
|
+
* Only keywords in these groups (grp_...): one rule per customer, say.
|
|
6572
|
+
*/
|
|
6573
|
+
groupIds?: Array<string>;
|
|
6209
6574
|
/**
|
|
6210
6575
|
* Only posts from these platforms.
|
|
6211
6576
|
*/
|
|
@@ -7158,6 +7523,34 @@ declare const getView: <ThrowOnError extends boolean = false>(options: Options<G
|
|
|
7158
7523
|
* Rename, describe or refilter a view. `filter` replaces the whole filter.
|
|
7159
7524
|
*/
|
|
7160
7525
|
declare const updateView: <ThrowOnError extends boolean = false>(options: Options<UpdateViewData, ThrowOnError>) => RequestResult<UpdateViewResponses, UpdateViewErrors, ThrowOnError>;
|
|
7526
|
+
/**
|
|
7527
|
+
* List groups
|
|
7528
|
+
*
|
|
7529
|
+
* The keyword groups of the workspace, the default group first, then oldest first. A group is how keywords are grouped (a customer, a campaign, a product): a term may be tracked once per group, every keyword belongs to one, and GET /v1/usage/breakdown?by=group says what each group cost. Pass `externalId` to find the group carrying your own id.
|
|
7530
|
+
*/
|
|
7531
|
+
declare const listGroups: <ThrowOnError extends boolean = false>(options?: Options<ListGroupsData, ThrowOnError>) => RequestResult<ListGroupsResponses, ListGroupsErrors, ThrowOnError>;
|
|
7532
|
+
/**
|
|
7533
|
+
* Create a group
|
|
7534
|
+
*
|
|
7535
|
+
* Create a keyword group. `name` is unique per workspace; `externalId` (optional, unique too) is your own id for it, a customer id say, so you can find it again without storing ours; `context` (optional) is the group's own company description, which the classifier reads in place of the whole workspace profile for the group's keywords. Then pass the group id as `groupId` when creating a keyword.
|
|
7536
|
+
*/
|
|
7537
|
+
declare const createGroup: <ThrowOnError extends boolean = false>(options: Options<CreateGroupData, ThrowOnError>) => RequestResult<CreateGroupResponses, CreateGroupErrors, ThrowOnError>;
|
|
7538
|
+
/**
|
|
7539
|
+
* Delete a group and its keywords
|
|
7540
|
+
*
|
|
7541
|
+
* Deletes the group and EVERY keyword in it, each the way DELETE /v1/keywords/{id} does (its mentions go with it, alert rules that named it are adjusted; charges already made stay on the usage record). Read the group first: `stats.keywords` says how many go. The default group cannot be deleted: move or delete its keywords instead.
|
|
7542
|
+
*/
|
|
7543
|
+
declare const deleteGroup: <ThrowOnError extends boolean = false>(options: Options<DeleteGroupData, ThrowOnError>) => RequestResult<DeleteGroupResponses, DeleteGroupErrors, ThrowOnError>;
|
|
7544
|
+
/**
|
|
7545
|
+
* Get a group
|
|
7546
|
+
*/
|
|
7547
|
+
declare const getGroup: <ThrowOnError extends boolean = false>(options: Options<GetGroupData, ThrowOnError>) => RequestResult<GetGroupResponses, GetGroupErrors, ThrowOnError>;
|
|
7548
|
+
/**
|
|
7549
|
+
* Update a group
|
|
7550
|
+
*
|
|
7551
|
+
* Rename a group, change your id for it (`externalId`, null clears) or its company description (`context`, null clears: the workspace profile applies again; new mentions are judged with it at once, old ones are not rescored). The default group can be renamed like any other but takes no description: it is the workspace itself and reads the company profile.
|
|
7552
|
+
*/
|
|
7553
|
+
declare const updateGroup: <ThrowOnError extends boolean = false>(options: Options<UpdateGroupData, ThrowOnError>) => RequestResult<UpdateGroupResponses, UpdateGroupErrors, ThrowOnError>;
|
|
7161
7554
|
/**
|
|
7162
7555
|
* Get the company profile
|
|
7163
7556
|
*
|
|
@@ -7367,6 +7760,7 @@ type sdk_Options<TData extends TDataShape = TDataShape, ThrowOnError extends boo
|
|
|
7367
7760
|
declare const sdk_createAlert: typeof createAlert;
|
|
7368
7761
|
declare const sdk_createApiKey: typeof createApiKey;
|
|
7369
7762
|
declare const sdk_createChannel: typeof createChannel;
|
|
7763
|
+
declare const sdk_createGroup: typeof createGroup;
|
|
7370
7764
|
declare const sdk_createInvitation: typeof createInvitation;
|
|
7371
7765
|
declare const sdk_createKeyword: typeof createKeyword;
|
|
7372
7766
|
declare const sdk_createSegment: typeof createSegment;
|
|
@@ -7374,6 +7768,7 @@ declare const sdk_createTopUp: typeof createTopUp;
|
|
|
7374
7768
|
declare const sdk_createView: typeof createView;
|
|
7375
7769
|
declare const sdk_deleteAlert: typeof deleteAlert;
|
|
7376
7770
|
declare const sdk_deleteChannel: typeof deleteChannel;
|
|
7771
|
+
declare const sdk_deleteGroup: typeof deleteGroup;
|
|
7377
7772
|
declare const sdk_deleteKeyword: typeof deleteKeyword;
|
|
7378
7773
|
declare const sdk_deletePersonActivity: typeof deletePersonActivity;
|
|
7379
7774
|
declare const sdk_deleteSegment: typeof deleteSegment;
|
|
@@ -7387,6 +7782,7 @@ declare const sdk_getAnalyticsSummary: typeof getAnalyticsSummary;
|
|
|
7387
7782
|
declare const sdk_getChannel: typeof getChannel;
|
|
7388
7783
|
declare const sdk_getCompany: typeof getCompany;
|
|
7389
7784
|
declare const sdk_getFilters: typeof getFilters;
|
|
7785
|
+
declare const sdk_getGroup: typeof getGroup;
|
|
7390
7786
|
declare const sdk_getHealth: typeof getHealth;
|
|
7391
7787
|
declare const sdk_getInvoiceUrl: typeof getInvoiceUrl;
|
|
7392
7788
|
declare const sdk_getKeyword: typeof getKeyword;
|
|
@@ -7402,6 +7798,7 @@ declare const sdk_listAlerts: typeof listAlerts;
|
|
|
7402
7798
|
declare const sdk_listApiKeys: typeof listApiKeys;
|
|
7403
7799
|
declare const sdk_listChannelDeliveries: typeof listChannelDeliveries;
|
|
7404
7800
|
declare const sdk_listChannels: typeof listChannels;
|
|
7801
|
+
declare const sdk_listGroups: typeof listGroups;
|
|
7405
7802
|
declare const sdk_listInvitations: typeof listInvitations;
|
|
7406
7803
|
declare const sdk_listInvoices: typeof listInvoices;
|
|
7407
7804
|
declare const sdk_listKeywords: typeof listKeywords;
|
|
@@ -7428,6 +7825,7 @@ declare const sdk_updateAlert: typeof updateAlert;
|
|
|
7428
7825
|
declare const sdk_updateChannel: typeof updateChannel;
|
|
7429
7826
|
declare const sdk_updateCompany: typeof updateCompany;
|
|
7430
7827
|
declare const sdk_updateFilters: typeof updateFilters;
|
|
7828
|
+
declare const sdk_updateGroup: typeof updateGroup;
|
|
7431
7829
|
declare const sdk_updateKeyword: typeof updateKeyword;
|
|
7432
7830
|
declare const sdk_updateMention: typeof updateMention;
|
|
7433
7831
|
declare const sdk_updatePerson: typeof updatePerson;
|
|
@@ -7435,7 +7833,7 @@ declare const sdk_updateSegment: typeof updateSegment;
|
|
|
7435
7833
|
declare const sdk_updateView: typeof updateView;
|
|
7436
7834
|
declare const sdk_whoami: typeof whoami;
|
|
7437
7835
|
declare namespace sdk {
|
|
7438
|
-
export { type sdk_Options as Options, sdk_createAlert as createAlert, sdk_createApiKey as createApiKey, sdk_createChannel as createChannel, 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_deleteKeyword as deleteKeyword, sdk_deletePersonActivity as deletePersonActivity, sdk_deleteSegment as deleteSegment, sdk_deleteView as deleteView, sdk_exportMentionsCsv as exportMentionsCsv, 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_getHealth as getHealth, sdk_getInvoiceUrl as getInvoiceUrl, sdk_getKeyword as getKeyword, sdk_getMention as getMention, sdk_getPerson as getPerson, 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_listChannelDeliveries as listChannelDeliveries, sdk_listChannels as listChannels, sdk_listInvitations as listInvitations, sdk_listInvoices as listInvoices, sdk_listKeywords as listKeywords, sdk_listLedger as listLedger, sdk_listMembers as listMembers, 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_updateKeyword as updateKeyword, sdk_updateMention as updateMention, sdk_updatePerson as updatePerson, sdk_updateSegment as updateSegment, sdk_updateView as updateView, sdk_whoami as whoami };
|
|
7836
|
+
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_exportMentionsCsv as exportMentionsCsv, 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_getMention as getMention, sdk_getPerson as getPerson, 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_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_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 };
|
|
7439
7837
|
}
|
|
7440
7838
|
|
|
7441
7839
|
/**
|
|
@@ -7463,4 +7861,4 @@ type Mentio = typeof sdk & {
|
|
|
7463
7861
|
};
|
|
7464
7862
|
declare function createMentio(options: MentioOptions): Mentio;
|
|
7465
7863
|
|
|
7466
|
-
export { type Alert, type AnalyticsBreakdown, type AnalyticsSeries, type AnalyticsSummary, type Channel, 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 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 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 EmailChannel, type ErrorResponse, type ExportMentionsCsvData, type ExportMentionsCsvError, type ExportMentionsCsvErrors, type ExportMentionsCsvResponse, type ExportMentionsCsvResponses, type ExportPeopleCsvData, type ExportPeopleCsvError, type ExportPeopleCsvErrors, type ExportPeopleCsvResponse, type ExportPeopleCsvResponses, 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 GetHealthData, type GetHealthResponse, type GetHealthResponses, type GetInvoiceUrlData, type GetInvoiceUrlError, type GetInvoiceUrlErrors, type GetInvoiceUrlResponse, type GetInvoiceUrlResponses, type GetKeywordData, type GetKeywordError, type GetKeywordErrors, 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 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 Invitation, type InvoiceList, type Keyword, type LedgerList, type ListAlertsData, type ListAlertsError, type ListAlertsErrors, type ListAlertsResponse, type ListAlertsResponses, type ListApiKeysData, type ListApiKeysError, type ListApiKeysErrors, type ListApiKeysResponse, type ListApiKeysResponses, type ListChannelDeliveriesData, type ListChannelDeliveriesError, type ListChannelDeliveriesErrors, type ListChannelDeliveriesResponse, type ListChannelDeliveriesResponses, type ListChannelsData, type ListChannelsError, type ListChannelsErrors, type ListChannelsResponse, type ListChannelsResponses, 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 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 MergePeopleData, type MergePeopleError, type MergePeopleErrors, type MergePeopleResponse, type MergePeopleResponses, type MuteAlertAuthorsData, type MuteAlertAuthorsError, type MuteAlertAuthorsErrors, type MuteAlertAuthorsResponse, type MuteAlertAuthorsResponses, type Options, type Person, type PersonActivity, type RemoveMemberData, type RemoveMemberError, type RemoveMemberErrors, type RemoveMemberResponse, type RemoveMemberResponses, type RequestResult, 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 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, createInvitation, createKeyword, createMentio, createSegment, createTopUp, createView, deleteAlert, deleteChannel, deleteKeyword, deletePersonActivity, deleteSegment, deleteView, exportMentionsCsv, exportPeopleCsv, getAlert, getAnalyticsBreakdown, getAnalyticsSeries, getAnalyticsSummary, getChannel, getCompany, getFilters, getHealth, getInvoiceUrl, getKeyword, getMention, getPerson, getSegment, getShareOfVoice, getUsage, getUsageBreakdown, getView, getWallet, listAlerts, listApiKeys, listChannelDeliveries, listChannels, listInvitations, listInvoices, listKeywords, listLedger, listMembers, listPeople, listPersonActivities, listSegments, listViews, logPersonActivity, mergePeople, muteAlertAuthors, removeMember, revokeApiKey, revokeInvitation, rotateWebhookSecret, runAlertDigest, searchMentions, splitPerson, testAlert, testChannel, unmuteAlertAuthors, updateAlert, updateChannel, updateCompany, updateFilters, updateKeyword, updateMention, updatePerson, updateSegment, updateView, whoami };
|
|
7864
|
+
export { type Alert, type AnalyticsBreakdown, type AnalyticsSeries, type AnalyticsSummary, type Channel, 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 EmailChannel, type ErrorResponse, type ExportMentionsCsvData, type ExportMentionsCsvError, type ExportMentionsCsvErrors, type ExportMentionsCsvResponse, type ExportMentionsCsvResponses, type ExportPeopleCsvData, type ExportPeopleCsvError, type ExportPeopleCsvErrors, type ExportPeopleCsvResponse, type ExportPeopleCsvResponses, 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 GetKeywordResponse, type GetKeywordResponses, type GetMentionData, type GetMentionError, type GetMentionErrors, type GetMentionResponse, type GetMentionResponses, type GetPersonData, type GetPersonError, type GetPersonErrors, type GetPersonResponse, type GetPersonResponses, 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 LedgerList, type ListAlertsData, type ListAlertsError, type ListAlertsErrors, type ListAlertsResponse, type ListAlertsResponses, type ListApiKeysData, type ListApiKeysError, type ListApiKeysErrors, type ListApiKeysResponse, type ListApiKeysResponses, 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 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 MergePeopleData, type MergePeopleError, type MergePeopleErrors, type MergePeopleResponse, type MergePeopleResponses, type MuteAlertAuthorsData, type MuteAlertAuthorsError, type MuteAlertAuthorsErrors, type MuteAlertAuthorsResponse, type MuteAlertAuthorsResponses, type Options, type Person, type PersonActivity, type RemoveMemberData, type RemoveMemberError, type RemoveMemberErrors, type RemoveMemberResponse, type RemoveMemberResponses, type RequestResult, 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, exportMentionsCsv, exportPeopleCsv, getAlert, getAnalyticsBreakdown, getAnalyticsSeries, getAnalyticsSummary, getChannel, getCompany, getFilters, getGroup, getHealth, getInvoiceUrl, getKeyword, getMention, getPerson, getSegment, getShareOfVoice, getUsage, getUsageBreakdown, getView, getWallet, listAlerts, listApiKeys, listChannelDeliveries, listChannels, listGroups, listInvitations, listInvoices, listKeywords, listLedger, listMembers, 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 };
|