@mentio-dev/sdk 0.4.1 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -349,6 +349,35 @@ type Keyword = {
349
349
  * Platforms this keyword is tracked on; null means every platform.
350
350
  */
351
351
  platforms: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin'> | null;
352
+ /**
353
+ * 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.
354
+ */
355
+ context: string | null;
356
+ /**
357
+ * Matching rules applied before a mention is stored; a rejected post is never billed.
358
+ */
359
+ matching: {
360
+ /**
361
+ * The post must ALSO contain these terms, any one of them or all of them per requiredMode. Empty: no requirement.
362
+ */
363
+ requiredTerms: Array<string>;
364
+ /**
365
+ * any: at least one required term must appear. all: every one must.
366
+ */
367
+ requiredMode: 'any' | 'all';
368
+ /**
369
+ * A post containing any of these is dropped. A `*` at the start or the end of an entry is a wildcard (beta.* matches beta.0.1; *bot matches nightlybot).
370
+ */
371
+ excludedTerms: Array<string>;
372
+ /**
373
+ * Posts by these authors are dropped: profile or post links, @handles, u/names, Bluesky DIDs or display names, stored in canonical form like an alert's muted list.
374
+ */
375
+ excludedAuthors: Array<string>;
376
+ /**
377
+ * true: the term must appear in the case it was typed (RAG, never rag). Default false.
378
+ */
379
+ caseSensitive: boolean;
380
+ };
352
381
  /**
353
382
  * Computed over this workspace's matches.
354
383
  */
@@ -369,6 +398,19 @@ type Keyword = {
369
398
  * Newest matched post; null until the first one.
370
399
  */
371
400
  lastMentionAt: string | null;
401
+ /**
402
+ * Your verdicts on this keyword's mentions (PATCH /v1/mentions/{id} relevant).
403
+ */
404
+ feedback: {
405
+ /**
406
+ * Mentions a person marked relevant.
407
+ */
408
+ relevant: number;
409
+ /**
410
+ * Mentions a person marked not relevant: the noise the classifier let through.
411
+ */
412
+ notRelevant: number;
413
+ };
372
414
  };
373
415
  /**
374
416
  * Poll health per platform polled on a schedule. Live feeds (Bluesky) have no entry.
@@ -400,7 +442,7 @@ type ErrorResponse = {
400
442
  /**
401
443
  * 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.
402
444
  */
403
- 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' | 'invalid_member' | 'duplicate_segment' | 'invalid_signature' | 'webhook_not_configured' | 'invalid_token' | 'protected_user' | 'upstream_unavailable' | 'internal_error';
445
+ 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' | 'invalid_signature' | 'webhook_not_configured' | 'invalid_token' | 'protected_user' | 'upstream_unavailable' | 'internal_error';
404
446
  /**
405
447
  * Human-readable detail; may change between releases.
406
448
  */
@@ -415,6 +457,40 @@ type ErrorResponse = {
415
457
  retryAfterSeconds?: number;
416
458
  };
417
459
  };
460
+ /**
461
+ * Workspace-wide matching rules; a rejected post is never billed.
462
+ */
463
+ type WorkspaceFilters = {
464
+ /**
465
+ * A post containing any of these is dropped, whatever keyword matched it. Same phrase rule as a keyword; a `*` at an end is a wildcard. "hiring, job, careers" is the classic list.
466
+ */
467
+ excludedTerms: Array<string>;
468
+ /**
469
+ * Posts by these authors are dropped everywhere: your own accounts, employees, known spammers. Profile or post links, @handles, u/names, Bluesky DIDs or display names, stored in canonical form.
470
+ */
471
+ excludedAuthors: Array<string>;
472
+ /**
473
+ * GitHub repositories whose issues, pull requests and comments are dropped, as owner/name or a github.com link (facebook/react, https://github.com/facebook/react).
474
+ */
475
+ excludedRepos: Array<string>;
476
+ /**
477
+ * Reddit only.
478
+ */
479
+ subreddits: {
480
+ /**
481
+ * When non-empty, ONLY Reddit posts from these subreddits pass and `excluded` is ignored. r/name or name.
482
+ */
483
+ only: Array<string>;
484
+ /**
485
+ * Reddit posts from these subreddits are dropped. r/name or name.
486
+ */
487
+ excluded: Array<string>;
488
+ };
489
+ /**
490
+ * Last edit; null until the first.
491
+ */
492
+ updatedAt: string | null;
493
+ };
418
494
  type Mention = {
419
495
  /**
420
496
  * Mention id (mm_...): one post matched to one of your keywords. A post matching two keywords has two ids.
@@ -516,7 +592,7 @@ type Mention = {
516
592
  tags: Array<string>;
517
593
  } | null;
518
594
  /**
519
- * The classifier verdict; null while the post is still queued for classification.
595
+ * The classifier verdict, as corrected by your feedback; null while the post is still queued for classification.
520
596
  */
521
597
  classification: {
522
598
  /**
@@ -531,6 +607,14 @@ type Mention = {
531
607
  * Detected intents: buy_intent, question, complaint, praise, comparison.
532
608
  */
533
609
  intents: Array<string>;
610
+ /**
611
+ * The post reads as machine-made: a bot or app account, a scheduled or templated post, an obvious AI-written summary. A label only: automated mentions stay in the feed, are delivered as usual and are billed like any other match. false while unjudged.
612
+ */
613
+ automated: boolean;
614
+ /**
615
+ * 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.
616
+ */
617
+ language: string | null;
534
618
  /**
535
619
  * One sentence from the classifier explaining the score.
536
620
  */
@@ -539,6 +623,36 @@ type Mention = {
539
623
  * true when the model could not score this post; it stays in the feed and is not billed.
540
624
  */
541
625
  failed: boolean;
626
+ /**
627
+ * A person's correction of the verdict, or null. A relevance verdict sets `relevance` to 100 or 0 and `relevant` with it; a corrected sentiment replaces `sentiment`. Every list, filter, digest and report reads the corrected values.
628
+ */
629
+ feedback: {
630
+ /**
631
+ * Your verdict on relevance, or null when you only corrected the sentiment.
632
+ */
633
+ relevant: boolean | null;
634
+ /**
635
+ * Your corrected sentiment, or null when you only judged relevance.
636
+ */
637
+ sentiment: 'positive' | 'neutral' | 'negative';
638
+ /**
639
+ * When the last verdict was given.
640
+ */
641
+ at: string;
642
+ /**
643
+ * The classifier values your feedback replaced.
644
+ */
645
+ original: {
646
+ /**
647
+ * What the classifier scored before your verdict; null if it had not scored it.
648
+ */
649
+ relevance: number | null;
650
+ /**
651
+ * The sentiment the classifier gave before your correction.
652
+ */
653
+ sentiment: 'positive' | 'neutral' | 'negative';
654
+ };
655
+ } | null;
542
656
  } | null;
543
657
  triage: {
544
658
  /**
@@ -813,6 +927,10 @@ type Segment = {
813
927
  * People at any of these outreach stages.
814
928
  */
815
929
  stages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
930
+ /**
931
+ * true: only people whose matched posts are mostly machine-made (bot accounts); false: only the rest.
932
+ */
933
+ automated?: boolean;
816
934
  /**
817
935
  * People owned by any of these members (user ids); "none" matches people nobody owns.
818
936
  */
@@ -857,11 +975,211 @@ type Company = {
857
975
  */
858
976
  linkedin: string | null;
859
977
  };
978
+ /**
979
+ * The company website, as set up during onboarding.
980
+ */
981
+ website: string | null;
982
+ /**
983
+ * Competitors by name, so the classifier reads a rival's mention as such; usually the same names as your competitor keywords.
984
+ */
985
+ competitors: Array<string>;
986
+ /**
987
+ * Free-text rules for the classifier: what counts as relevant for you and what never does ("posts about our API, never job listings"). The second biggest lever after the description.
988
+ */
989
+ guidelines: string | null;
860
990
  /**
861
991
  * The text the classifier reads. Composed from the fields above unless you override it.
862
992
  */
863
993
  context: string;
864
994
  };
995
+ type Whoami = {
996
+ /**
997
+ * The workspace this credential acts on.
998
+ */
999
+ workspace: {
1000
+ /**
1001
+ * Workspace id (org_...).
1002
+ */
1003
+ id: string;
1004
+ /**
1005
+ * The workspace name, as the dashboard shows it.
1006
+ */
1007
+ name: string;
1008
+ };
1009
+ /**
1010
+ * The credential.
1011
+ */
1012
+ auth: {
1013
+ /**
1014
+ * How the request authenticated: an API key, an OAuth access token (MCP sign-in), or the dashboard session.
1015
+ */
1016
+ kind: 'api_key' | 'oauth' | 'session';
1017
+ /**
1018
+ * What the credential may do: read (GET only) or write.
1019
+ */
1020
+ scope: 'read' | 'write';
1021
+ /**
1022
+ * The key id (key_...) when authenticated with an API key; null otherwise.
1023
+ */
1024
+ apiKeyId: string | null;
1025
+ /**
1026
+ * When an API key stops working; null for a key that never expires, an OAuth token or a session.
1027
+ */
1028
+ expiresAt: string | null;
1029
+ };
1030
+ /**
1031
+ * The person behind an OAuth token or a session; null for an API key, which has no person behind it.
1032
+ */
1033
+ user: {
1034
+ /**
1035
+ * User id, what assigneeId and ownerId take.
1036
+ */
1037
+ id: string;
1038
+ /**
1039
+ * The account's email address.
1040
+ */
1041
+ email: string;
1042
+ /**
1043
+ * The name on the account; null when they never set one.
1044
+ */
1045
+ name: string | null;
1046
+ } | null;
1047
+ };
1048
+ type Member = {
1049
+ /**
1050
+ * Membership id (mem_...), what DELETE /v1/members/{id} takes.
1051
+ */
1052
+ id: string;
1053
+ /**
1054
+ * The person's user id, what assigneeId and ownerId take.
1055
+ */
1056
+ userId: string;
1057
+ /**
1058
+ * The account's email address.
1059
+ */
1060
+ email: string;
1061
+ /**
1062
+ * The name on the account; null when they never set one.
1063
+ */
1064
+ name: string | null;
1065
+ /**
1066
+ * owner: everything, billing included. admin: manages the team. member: works the feed.
1067
+ */
1068
+ role: 'owner' | 'admin' | 'member';
1069
+ /**
1070
+ * When the membership was created.
1071
+ */
1072
+ joinedAt: string;
1073
+ };
1074
+ type Invitation = {
1075
+ /**
1076
+ * Invitation id (inv_...).
1077
+ */
1078
+ id: string;
1079
+ /**
1080
+ * The invited address, lowercased.
1081
+ */
1082
+ email: string;
1083
+ /**
1084
+ * The role they join with.
1085
+ */
1086
+ role: 'owner' | 'admin' | 'member';
1087
+ /**
1088
+ * Who sent it; an API key invites on behalf of the oldest owner.
1089
+ */
1090
+ invitedBy: {
1091
+ id: string;
1092
+ email: string;
1093
+ name: string | null;
1094
+ } | null;
1095
+ /**
1096
+ * Invitations last 48 hours; an expired one is no longer listed.
1097
+ */
1098
+ expiresAt: string;
1099
+ /**
1100
+ * When the invitation was sent.
1101
+ */
1102
+ createdAt: string;
1103
+ };
1104
+ type UsageSummary = {
1105
+ /**
1106
+ * The prepaid wallet.
1107
+ */
1108
+ balance: {
1109
+ /**
1110
+ * Ledger balance: every credit minus every settled debit.
1111
+ */
1112
+ cents: number;
1113
+ /**
1114
+ * Mentions matched since the last daily settlement, priced but not yet debited.
1115
+ */
1116
+ pendingCents: number;
1117
+ /**
1118
+ * cents minus pendingCents: what the stop rule and the keyword gate look at.
1119
+ */
1120
+ effectiveCents: number;
1121
+ currency: 'USD';
1122
+ };
1123
+ /**
1124
+ * How fast the balance goes.
1125
+ */
1126
+ burn: {
1127
+ /**
1128
+ * Average daily debit over the last 7 days (or since the workspace was created).
1129
+ */
1130
+ perDayCents: number;
1131
+ /**
1132
+ * effectiveCents divided by perDayCents; null when nothing is burning.
1133
+ */
1134
+ daysLeft: number | null;
1135
+ };
1136
+ /**
1137
+ * Keywords against the wallet.
1138
+ */
1139
+ keywords: {
1140
+ /**
1141
+ * Unmuted keywords, the ones charged daily.
1142
+ */
1143
+ active: number;
1144
+ /**
1145
+ * Keywords the wallet paused for lack of balance; a top-up resumes them.
1146
+ */
1147
+ paused: number;
1148
+ /**
1149
+ * How many keywords the workspace may run right now: the self-serve ceiling when the balance covers one more keyword-day, else 0.
1150
+ */
1151
+ limit: number;
1152
+ /**
1153
+ * What one more day of the active keywords costs.
1154
+ */
1155
+ dayCents: number;
1156
+ };
1157
+ /**
1158
+ * Matched mentions, the other thing that bills.
1159
+ */
1160
+ mentions: {
1161
+ /**
1162
+ * Matches recorded today (UTC), relevant or not: every one bills.
1163
+ */
1164
+ today: number;
1165
+ /**
1166
+ * Matches recorded in the last 30 days.
1167
+ */
1168
+ last30d: number;
1169
+ };
1170
+ /**
1171
+ * The wallet paused tracking; a top-up that covers a day of every keyword resumes it.
1172
+ */
1173
+ stopped: boolean;
1174
+ /**
1175
+ * Running, and the effective balance is at or under 20 percent of the last credit.
1176
+ */
1177
+ lowBalance: boolean;
1178
+ /**
1179
+ * Newest paid top-up; null before the first.
1180
+ */
1181
+ lastTopUpAt: string | null;
1182
+ };
865
1183
  type Alert = {
866
1184
  /**
867
1185
  * Alert id (feed_...).
@@ -870,9 +1188,9 @@ type Alert = {
870
1188
  name: string;
871
1189
  enabled: boolean;
872
1190
  /**
873
- * instant: each matching mention as it happens. daily: one digest at the scheduled local time.
1191
+ * instant: each matching mention as it happens. daily: one digest at the scheduled local time. weekly: one digest a week, on schedule.weekday.
874
1192
  */
875
- mode: 'instant' | 'daily';
1193
+ mode: 'instant' | 'daily' | 'weekly';
876
1194
  filter: {
877
1195
  /**
878
1196
  * Only these keywords.
@@ -910,15 +1228,27 @@ type Alert = {
910
1228
  * Only posts linking to any of these hosts, the host itself or a subdomain of it (octolens.com also matches blog.octolens.com). A post with no links never passes.
911
1229
  */
912
1230
  linkHosts?: Array<string>;
1231
+ /**
1232
+ * Only posts in any of these languages (ISO 639-1: en, es, de). A post whose language is unknown never passes.
1233
+ */
1234
+ languages?: Array<string>;
1235
+ /**
1236
+ * true: only posts that read as machine-made (bots, templated posts); false: only the rest. Omit for both.
1237
+ */
1238
+ automated?: boolean;
913
1239
  };
914
1240
  /**
915
- * Daily alerts only.
1241
+ * Daily and weekly alerts only.
916
1242
  */
917
1243
  schedule: {
918
1244
  hour: number;
919
1245
  minute?: number;
920
1246
  timezone: string;
921
1247
  skipEmpty?: boolean;
1248
+ /**
1249
+ * Weekly rules: the day it sends, 0 Sunday to 6 Saturday. Required for mode weekly; ignored on daily rules.
1250
+ */
1251
+ weekday?: number;
922
1252
  } | null;
923
1253
  /**
924
1254
  * Event name carried in webhook payloads; the mode default unless you set one.
@@ -945,7 +1275,7 @@ type Alert = {
945
1275
  */
946
1276
  lastSentAt: string | null;
947
1277
  /**
948
- * Daily alerts: the next digest; null when disabled or instant.
1278
+ * Daily and weekly alerts: the next digest; null when disabled or instant.
949
1279
  */
950
1280
  nextRunAt: string | null;
951
1281
  };
@@ -1178,20 +1508,20 @@ type AnalyticsSeries = {
1178
1508
  */
1179
1509
  timezone: string;
1180
1510
  /**
1181
- * Point granularity: day, or week (Monday to Sunday).
1511
+ * Point granularity used: hour, day, week (Monday to Sunday) or month.
1182
1512
  */
1183
- bucket: 'day' | 'week';
1513
+ bucket: 'hour' | 'day' | 'week' | 'month';
1184
1514
  };
1185
1515
  /**
1186
1516
  * One item per series, most matched first; a single "total" item when not split.
1187
1517
  */
1188
1518
  data: Array<{
1189
1519
  /**
1190
- * Platform name, keyword id, "total" for the unsplit series, or "other" for the keys beyond the top 20.
1520
+ * Platform name, keyword id, sentiment (positive, neutral, negative, unclassified), "total" for the unsplit series, or "other" for the keys beyond the top 20.
1191
1521
  */
1192
1522
  key: string;
1193
1523
  /**
1194
- * Readable name: the platform, the keyword term, "Total" or "Other".
1524
+ * Readable name: the platform, the keyword term, the sentiment, "Total" or "Other".
1195
1525
  */
1196
1526
  label: string;
1197
1527
  /**
@@ -1216,7 +1546,7 @@ type AnalyticsSeries = {
1216
1546
  */
1217
1547
  points: Array<{
1218
1548
  /**
1219
- * The day, or the Monday of the week.
1549
+ * The bucket start in `timezone`: the day (YYYY-MM-DD), the Monday of the week, the first of the month, or the hour as YYYY-MM-DDTHH:00.
1220
1550
  */
1221
1551
  date: string;
1222
1552
  /**
@@ -1250,11 +1580,11 @@ type AnalyticsSeries = {
1250
1580
  */
1251
1581
  previous: Array<{
1252
1582
  /**
1253
- * Platform name, keyword id, "total" for the unsplit series, or "other" for the keys beyond the top 20.
1583
+ * Platform name, keyword id, sentiment (positive, neutral, negative, unclassified), "total" for the unsplit series, or "other" for the keys beyond the top 20.
1254
1584
  */
1255
1585
  key: string;
1256
1586
  /**
1257
- * Readable name: the platform, the keyword term, "Total" or "Other".
1587
+ * Readable name: the platform, the keyword term, the sentiment, "Total" or "Other".
1258
1588
  */
1259
1589
  label: string;
1260
1590
  /**
@@ -1279,7 +1609,7 @@ type AnalyticsSeries = {
1279
1609
  */
1280
1610
  points: Array<{
1281
1611
  /**
1282
- * The day, or the Monday of the week.
1612
+ * The bucket start in `timezone`: the day (YYYY-MM-DD), the Monday of the week, the first of the month, or the hour as YYYY-MM-DDTHH:00.
1283
1613
  */
1284
1614
  date: string;
1285
1615
  /**
@@ -1334,7 +1664,7 @@ type AnalyticsBreakdown = {
1334
1664
  /**
1335
1665
  * The dimension the rows are grouped by.
1336
1666
  */
1337
- by: 'platform' | 'keyword' | 'sentiment' | 'intent' | 'status' | 'hour' | 'person';
1667
+ by: 'platform' | 'keyword' | 'sentiment' | 'intent' | 'status' | 'hour' | 'person' | 'language';
1338
1668
  /**
1339
1669
  * Most matched first, at most 50 groups. by=hour is chronological and unlimited (168 cells at most).
1340
1670
  */
@@ -1813,6 +2143,35 @@ type ListKeywordsResponses = {
1813
2143
  * Platforms this keyword is tracked on; null means every platform.
1814
2144
  */
1815
2145
  platforms: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin'> | null;
2146
+ /**
2147
+ * 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.
2148
+ */
2149
+ context: string | null;
2150
+ /**
2151
+ * Matching rules applied before a mention is stored; a rejected post is never billed.
2152
+ */
2153
+ matching: {
2154
+ /**
2155
+ * The post must ALSO contain these terms, any one of them or all of them per requiredMode. Empty: no requirement.
2156
+ */
2157
+ requiredTerms: Array<string>;
2158
+ /**
2159
+ * any: at least one required term must appear. all: every one must.
2160
+ */
2161
+ requiredMode: 'any' | 'all';
2162
+ /**
2163
+ * A post containing any of these is dropped. A `*` at the start or the end of an entry is a wildcard (beta.* matches beta.0.1; *bot matches nightlybot).
2164
+ */
2165
+ excludedTerms: Array<string>;
2166
+ /**
2167
+ * Posts by these authors are dropped: profile or post links, @handles, u/names, Bluesky DIDs or display names, stored in canonical form like an alert's muted list.
2168
+ */
2169
+ excludedAuthors: Array<string>;
2170
+ /**
2171
+ * true: the term must appear in the case it was typed (RAG, never rag). Default false.
2172
+ */
2173
+ caseSensitive: boolean;
2174
+ };
1816
2175
  /**
1817
2176
  * Computed over this workspace's matches.
1818
2177
  */
@@ -1833,6 +2192,19 @@ type ListKeywordsResponses = {
1833
2192
  * Newest matched post; null until the first one.
1834
2193
  */
1835
2194
  lastMentionAt: string | null;
2195
+ /**
2196
+ * Your verdicts on this keyword's mentions (PATCH /v1/mentions/{id} relevant).
2197
+ */
2198
+ feedback: {
2199
+ /**
2200
+ * Mentions a person marked relevant.
2201
+ */
2202
+ relevant: number;
2203
+ /**
2204
+ * Mentions a person marked not relevant: the noise the classifier let through.
2205
+ */
2206
+ notRelevant: number;
2207
+ };
1836
2208
  };
1837
2209
  /**
1838
2210
  * Poll health per platform polled on a schedule. Live feeds (Bluesky) have no entry.
@@ -1873,6 +2245,35 @@ type CreateKeywordData = {
1873
2245
  * Platforms to track it on; omit or null for every platform.
1874
2246
  */
1875
2247
  platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin'> | null;
2248
+ /**
2249
+ * 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.
2250
+ */
2251
+ context?: string | null;
2252
+ /**
2253
+ * Omitted fields are untouched; an empty list clears one.
2254
+ */
2255
+ matching?: {
2256
+ /**
2257
+ * The post must ALSO contain these terms, any one of them or all of them per requiredMode. Empty: no requirement.
2258
+ */
2259
+ requiredTerms?: Array<string>;
2260
+ /**
2261
+ * any: at least one required term must appear. all: every one must.
2262
+ */
2263
+ requiredMode?: 'any' | 'all';
2264
+ /**
2265
+ * A post containing any of these is dropped. A `*` at the start or the end of an entry is a wildcard (beta.* matches beta.0.1; *bot matches nightlybot).
2266
+ */
2267
+ excludedTerms?: Array<string>;
2268
+ /**
2269
+ * Posts by these authors are dropped: profile or post links, @handles, u/names, Bluesky DIDs or display names, stored in canonical form like an alert's muted list.
2270
+ */
2271
+ excludedAuthors?: Array<string>;
2272
+ /**
2273
+ * true: the term must appear in the case it was typed (RAG, never rag). Default false.
2274
+ */
2275
+ caseSensitive?: boolean;
2276
+ };
1876
2277
  };
1877
2278
  path?: never;
1878
2279
  query?: never;
@@ -1963,6 +2364,10 @@ type UpdateKeywordData = {
1963
2364
  * Omitted fields are untouched.
1964
2365
  */
1965
2366
  body: {
2367
+ /**
2368
+ * Reclassify it as brand, competitor or topic.
2369
+ */
2370
+ kind?: 'brand' | 'competitor' | 'topic';
1966
2371
  /**
1967
2372
  * A muted keyword stops polling and matching; its mentions stay.
1968
2373
  */
@@ -1971,6 +2376,35 @@ type UpdateKeywordData = {
1971
2376
  * Replaces the platform list; null means every platform.
1972
2377
  */
1973
2378
  platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin'> | null;
2379
+ /**
2380
+ * 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.
2381
+ */
2382
+ context?: string | null;
2383
+ /**
2384
+ * Omitted fields are untouched; an empty list clears one.
2385
+ */
2386
+ matching?: {
2387
+ /**
2388
+ * The post must ALSO contain these terms, any one of them or all of them per requiredMode. Empty: no requirement.
2389
+ */
2390
+ requiredTerms?: Array<string>;
2391
+ /**
2392
+ * any: at least one required term must appear. all: every one must.
2393
+ */
2394
+ requiredMode?: 'any' | 'all';
2395
+ /**
2396
+ * A post containing any of these is dropped. A `*` at the start or the end of an entry is a wildcard (beta.* matches beta.0.1; *bot matches nightlybot).
2397
+ */
2398
+ excludedTerms?: Array<string>;
2399
+ /**
2400
+ * Posts by these authors are dropped: profile or post links, @handles, u/names, Bluesky DIDs or display names, stored in canonical form like an alert's muted list.
2401
+ */
2402
+ excludedAuthors?: Array<string>;
2403
+ /**
2404
+ * true: the term must appear in the case it was typed (RAG, never rag). Default false.
2405
+ */
2406
+ caseSensitive?: boolean;
2407
+ };
1974
2408
  };
1975
2409
  path: {
1976
2410
  /**
@@ -2003,6 +2437,79 @@ type UpdateKeywordResponses = {
2003
2437
  200: Keyword;
2004
2438
  };
2005
2439
  type UpdateKeywordResponse = UpdateKeywordResponses[keyof UpdateKeywordResponses];
2440
+ type GetFiltersData = {
2441
+ body?: never;
2442
+ path?: never;
2443
+ query?: never;
2444
+ url: '/v1/filters';
2445
+ };
2446
+ type GetFiltersErrors = {
2447
+ /**
2448
+ * Missing or invalid API key
2449
+ */
2450
+ 401: ErrorResponse;
2451
+ };
2452
+ type GetFiltersError = GetFiltersErrors[keyof GetFiltersErrors];
2453
+ type GetFiltersResponses = {
2454
+ /**
2455
+ * The workspace filters
2456
+ */
2457
+ 200: WorkspaceFilters;
2458
+ };
2459
+ type GetFiltersResponse = GetFiltersResponses[keyof GetFiltersResponses];
2460
+ type UpdateFiltersData = {
2461
+ /**
2462
+ * Omitted fields are untouched; an empty list clears one.
2463
+ */
2464
+ body: {
2465
+ /**
2466
+ * Replaces the list; [] clears it.
2467
+ */
2468
+ excludedTerms?: Array<string>;
2469
+ /**
2470
+ * Replaces the list; [] clears it.
2471
+ */
2472
+ excludedAuthors?: Array<string>;
2473
+ /**
2474
+ * Replaces the list; [] clears it.
2475
+ */
2476
+ excludedRepos?: Array<string>;
2477
+ /**
2478
+ * Reddit only; an omitted list is untouched.
2479
+ */
2480
+ subreddits?: {
2481
+ /**
2482
+ * Replaces the allowlist; [] clears it.
2483
+ */
2484
+ only?: Array<string>;
2485
+ /**
2486
+ * Replaces the deny list; [] clears it.
2487
+ */
2488
+ excluded?: Array<string>;
2489
+ };
2490
+ };
2491
+ path?: never;
2492
+ query?: never;
2493
+ url: '/v1/filters';
2494
+ };
2495
+ type UpdateFiltersErrors = {
2496
+ /**
2497
+ * An entry is not a term, an author, a repository or a subreddit
2498
+ */
2499
+ 400: ErrorResponse;
2500
+ /**
2501
+ * Missing or invalid API key
2502
+ */
2503
+ 401: ErrorResponse;
2504
+ };
2505
+ type UpdateFiltersError = UpdateFiltersErrors[keyof UpdateFiltersErrors];
2506
+ type UpdateFiltersResponses = {
2507
+ /**
2508
+ * The updated filters
2509
+ */
2510
+ 200: WorkspaceFilters;
2511
+ };
2512
+ type UpdateFiltersResponse = UpdateFiltersResponses[keyof UpdateFiltersResponses];
2006
2513
  type GetMentionData = {
2007
2514
  body?: never;
2008
2515
  path: {
@@ -2053,6 +2560,14 @@ type UpdateMentionData = {
2053
2560
  * Internal note; null or empty clears it.
2054
2561
  */
2055
2562
  note?: string | null;
2563
+ /**
2564
+ * Your verdict on relevance, correcting the classifier: true sets relevance to 100 and puts a filtered mention back in the relevant feed, false sets it to 0 and takes it out; null withdraws the verdict and restores the classifier's score. Never billed or unbilled. A mention still being classified answers 409 classification_pending.
2565
+ */
2566
+ relevant?: boolean | null;
2567
+ /**
2568
+ * Your corrected sentiment; null withdraws the correction and restores the classifier's.
2569
+ */
2570
+ sentiment?: 'positive' | 'neutral' | 'negative';
2056
2571
  };
2057
2572
  path: {
2058
2573
  /**
@@ -2076,6 +2591,10 @@ type UpdateMentionErrors = {
2076
2591
  * Mention not found
2077
2592
  */
2078
2593
  404: ErrorResponse;
2594
+ /**
2595
+ * A verdict on a mention the classifier has not scored yet (classification_pending)
2596
+ */
2597
+ 409: ErrorResponse;
2079
2598
  };
2080
2599
  type UpdateMentionError = UpdateMentionErrors[keyof UpdateMentionErrors];
2081
2600
  type UpdateMentionResponses = {
@@ -2113,6 +2632,10 @@ type SearchMentionsData = {
2113
2632
  * Only mentions carrying this intent (buy_intent, question, complaint, praise, comparison).
2114
2633
  */
2115
2634
  intent?: string;
2635
+ /**
2636
+ * true: only mentions that read as machine-made (a bot account, a scheduled or templated post, AI-written text); false: only the rest, mentions judged before this existed included. Omitted: everything.
2637
+ */
2638
+ automated?: boolean;
2116
2639
  /**
2117
2640
  * Only this person (an id from /v1/people), merged accounts included. Implies includeMuted.
2118
2641
  */
@@ -2141,6 +2664,18 @@ type SearchMentionsData = {
2141
2664
  * Only authors with at least this many followers. Unknown reach never passes.
2142
2665
  */
2143
2666
  minFollowers?: number | null;
2667
+ /**
2668
+ * Only authors with at most this many followers. Unknown reach never passes.
2669
+ */
2670
+ maxFollowers?: number | null;
2671
+ /**
2672
+ * true: only replies and comments (posts answering another post); false: only top-level posts. Omitted: both.
2673
+ */
2674
+ isReply?: boolean;
2675
+ /**
2676
+ * Apply an alert rule's filter (an id from GET /v1/alerts) on top of the other filters: the same mentions the rule would send, for a feed-shaped export or a preview. Unknown ids are a 404.
2677
+ */
2678
+ alertId?: string;
2144
2679
  /**
2145
2680
  * Only authors your workspace tagged with any of these (exact, case-sensitive). Repeatable, or comma-separated.
2146
2681
  */
@@ -2190,7 +2725,15 @@ type SearchMentionsData = {
2190
2725
  */
2191
2726
  notTags?: Array<string> | null;
2192
2727
  /**
2193
- * Substring search in the post text.
2728
+ * Only posts in any of these languages (ISO 639-1: en, es, de). A post whose language is unknown never passes.
2729
+ */
2730
+ languages?: Array<string>;
2731
+ /**
2732
+ * Never posts in these languages. A post whose language is unknown still passes.
2733
+ */
2734
+ notLanguages?: Array<string>;
2735
+ /**
2736
+ * Substring search in the post text or the author's name.
2194
2737
  */
2195
2738
  q?: string;
2196
2739
  /**
@@ -2268,6 +2811,10 @@ type ExportMentionsCsvData = {
2268
2811
  * Only mentions carrying this intent (buy_intent, question, complaint, praise, comparison).
2269
2812
  */
2270
2813
  intent?: string;
2814
+ /**
2815
+ * true: only mentions that read as machine-made (a bot account, a scheduled or templated post, AI-written text); false: only the rest, mentions judged before this existed included. Omitted: everything.
2816
+ */
2817
+ automated?: boolean;
2271
2818
  /**
2272
2819
  * Only this person (an id from /v1/people), merged accounts included. Implies includeMuted.
2273
2820
  */
@@ -2296,6 +2843,18 @@ type ExportMentionsCsvData = {
2296
2843
  * Only authors with at least this many followers. Unknown reach never passes.
2297
2844
  */
2298
2845
  minFollowers?: number | null;
2846
+ /**
2847
+ * Only authors with at most this many followers. Unknown reach never passes.
2848
+ */
2849
+ maxFollowers?: number | null;
2850
+ /**
2851
+ * true: only replies and comments (posts answering another post); false: only top-level posts. Omitted: both.
2852
+ */
2853
+ isReply?: boolean;
2854
+ /**
2855
+ * Apply an alert rule's filter (an id from GET /v1/alerts) on top of the other filters: the same mentions the rule would send, for a feed-shaped export or a preview. Unknown ids are a 404.
2856
+ */
2857
+ alertId?: string;
2299
2858
  /**
2300
2859
  * Only authors your workspace tagged with any of these (exact, case-sensitive). Repeatable, or comma-separated.
2301
2860
  */
@@ -2345,7 +2904,15 @@ type ExportMentionsCsvData = {
2345
2904
  */
2346
2905
  notTags?: Array<string> | null;
2347
2906
  /**
2348
- * Substring search in the post text.
2907
+ * Only posts in any of these languages (ISO 639-1: en, es, de). A post whose language is unknown never passes.
2908
+ */
2909
+ languages?: Array<string>;
2910
+ /**
2911
+ * Never posts in these languages. A post whose language is unknown still passes.
2912
+ */
2913
+ notLanguages?: Array<string>;
2914
+ /**
2915
+ * Substring search in the post text or the author's name.
2349
2916
  */
2350
2917
  q?: string;
2351
2918
  /**
@@ -2469,6 +3036,10 @@ type ExportPeopleCsvData = {
2469
3036
  * People at any of these outreach stages. Repeatable, or comma-separated.
2470
3037
  */
2471
3038
  stages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
3039
+ /**
3040
+ * true: only people whose matched posts are mostly machine-made (bot accounts); false: only the rest; omitted: everyone.
3041
+ */
3042
+ automated?: boolean;
2472
3043
  /**
2473
3044
  * People owned by any of these members (user ids); `none` matches people nobody owns. Repeatable, or comma-separated.
2474
3045
  */
@@ -2594,6 +3165,10 @@ type ListPeopleData = {
2594
3165
  * People at any of these outreach stages. Repeatable, or comma-separated.
2595
3166
  */
2596
3167
  stages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
3168
+ /**
3169
+ * true: only people whose matched posts are mostly machine-made (bot accounts); false: only the rest; omitted: everyone.
3170
+ */
3171
+ automated?: boolean;
2597
3172
  /**
2598
3173
  * People owned by any of these members (user ids); `none` matches people nobody owns. Repeatable, or comma-separated.
2599
3174
  */
@@ -3167,6 +3742,10 @@ type ListSegmentsResponses = {
3167
3742
  * People at any of these outreach stages.
3168
3743
  */
3169
3744
  stages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
3745
+ /**
3746
+ * true: only people whose matched posts are mostly machine-made (bot accounts); false: only the rest.
3747
+ */
3748
+ automated?: boolean;
3170
3749
  /**
3171
3750
  * People owned by any of these members (user ids); "none" matches people nobody owns.
3172
3751
  */
@@ -3257,6 +3836,10 @@ type ListSegmentsResponses = {
3257
3836
  * People at any of these outreach stages.
3258
3837
  */
3259
3838
  stages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
3839
+ /**
3840
+ * true: only people whose matched posts are mostly machine-made (bot accounts); false: only the rest.
3841
+ */
3842
+ automated?: boolean;
3260
3843
  /**
3261
3844
  * People owned by any of these members (user ids); "none" matches people nobody owns.
3262
3845
  */
@@ -3335,6 +3918,10 @@ type CreateSegmentData = {
3335
3918
  * People at any of these outreach stages.
3336
3919
  */
3337
3920
  stages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
3921
+ /**
3922
+ * true: only people whose matched posts are mostly machine-made (bot accounts); false: only the rest.
3923
+ */
3924
+ automated?: boolean;
3338
3925
  /**
3339
3926
  * People owned by any of these members (user ids); "none" matches people nobody owns.
3340
3927
  */
@@ -3500,6 +4087,10 @@ type UpdateSegmentData = {
3500
4087
  * People at any of these outreach stages.
3501
4088
  */
3502
4089
  stages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
4090
+ /**
4091
+ * true: only people whose matched posts are mostly machine-made (bot accounts); false: only the rest.
4092
+ */
4093
+ automated?: boolean;
3503
4094
  /**
3504
4095
  * People owned by any of these members (user ids); "none" matches people nobody owns.
3505
4096
  */
@@ -3576,6 +4167,18 @@ type UpdateCompanyData = {
3576
4167
  x?: string | null;
3577
4168
  linkedin?: string | null;
3578
4169
  };
4170
+ /**
4171
+ * The company website; null clears it.
4172
+ */
4173
+ website?: string | null;
4174
+ /**
4175
+ * Replaces the whole list; [] clears it.
4176
+ */
4177
+ competitors?: Array<string>;
4178
+ /**
4179
+ * Free-text rules for the classifier; null clears them.
4180
+ */
4181
+ guidelines?: string | null;
3579
4182
  /**
3580
4183
  * Overrides the composed context until the next profile edit.
3581
4184
  */
@@ -3643,6 +4246,10 @@ type ListApiKeysResponses = {
3643
4246
  * ISO 8601 timestamp, UTC.
3644
4247
  */
3645
4248
  lastUsedAt: string | null;
4249
+ /**
4250
+ * When the key stops working; null for a key that never expires. An expired key stays listed until revoked.
4251
+ */
4252
+ expiresAt: string | null;
3646
4253
  }>;
3647
4254
  };
3648
4255
  };
@@ -3657,12 +4264,20 @@ type CreateApiKeyData = {
3657
4264
  * read: GET only. write: everything.
3658
4265
  */
3659
4266
  scope?: 'read' | 'write';
4267
+ /**
4268
+ * When the key stops working (ISO 8601, or epoch ms), for a key handed to a script or a contractor. Must be in the future. Omit or null for a key that never expires.
4269
+ */
4270
+ expiresAt?: string;
3660
4271
  };
3661
4272
  path?: never;
3662
4273
  query?: never;
3663
4274
  url: '/v1/api-keys';
3664
4275
  };
3665
4276
  type CreateApiKeyErrors = {
4277
+ /**
4278
+ * expiresAt is not in the future
4279
+ */
4280
+ 400: ErrorResponse;
3666
4281
  /**
3667
4282
  * Missing or invalid API key
3668
4283
  */
@@ -3695,6 +4310,10 @@ type CreateApiKeyResponses = {
3695
4310
  * ISO 8601 timestamp, UTC.
3696
4311
  */
3697
4312
  lastUsedAt: string | null;
4313
+ /**
4314
+ * When the key stops working; null for a key that never expires. An expired key stays listed until revoked.
4315
+ */
4316
+ expiresAt: string | null;
3698
4317
  /**
3699
4318
  * The full key. Shown once; store it now.
3700
4319
  */
@@ -3731,6 +4350,201 @@ type RevokeApiKeyResponses = {
3731
4350
  204: void;
3732
4351
  };
3733
4352
  type RevokeApiKeyResponse = RevokeApiKeyResponses[keyof RevokeApiKeyResponses];
4353
+ type WhoamiData = {
4354
+ body?: never;
4355
+ path?: never;
4356
+ query?: never;
4357
+ url: '/v1/whoami';
4358
+ };
4359
+ type WhoamiErrors = {
4360
+ /**
4361
+ * Missing or invalid API key
4362
+ */
4363
+ 401: ErrorResponse;
4364
+ };
4365
+ type WhoamiError = WhoamiErrors[keyof WhoamiErrors];
4366
+ type WhoamiResponses = {
4367
+ /**
4368
+ * The credential
4369
+ */
4370
+ 200: Whoami;
4371
+ };
4372
+ type WhoamiResponse = WhoamiResponses[keyof WhoamiResponses];
4373
+ type ListMembersData = {
4374
+ body?: never;
4375
+ path?: never;
4376
+ query?: never;
4377
+ url: '/v1/members';
4378
+ };
4379
+ type ListMembersErrors = {
4380
+ /**
4381
+ * Missing or invalid API key
4382
+ */
4383
+ 401: ErrorResponse;
4384
+ };
4385
+ type ListMembersError = ListMembersErrors[keyof ListMembersErrors];
4386
+ type ListMembersResponses = {
4387
+ /**
4388
+ * The members
4389
+ */
4390
+ 200: {
4391
+ data: Array<Member>;
4392
+ };
4393
+ };
4394
+ type ListMembersResponse = ListMembersResponses[keyof ListMembersResponses];
4395
+ type ListInvitationsData = {
4396
+ body?: never;
4397
+ path?: never;
4398
+ query?: never;
4399
+ url: '/v1/members/invitations';
4400
+ };
4401
+ type ListInvitationsErrors = {
4402
+ /**
4403
+ * Missing or invalid API key
4404
+ */
4405
+ 401: ErrorResponse;
4406
+ };
4407
+ type ListInvitationsError = ListInvitationsErrors[keyof ListInvitationsErrors];
4408
+ type ListInvitationsResponses = {
4409
+ /**
4410
+ * The open invitations
4411
+ */
4412
+ 200: {
4413
+ data: Array<Invitation>;
4414
+ };
4415
+ };
4416
+ type ListInvitationsResponse = ListInvitationsResponses[keyof ListInvitationsResponses];
4417
+ type CreateInvitationData = {
4418
+ body: {
4419
+ /**
4420
+ * The address to invite; it receives an email with a link to join.
4421
+ */
4422
+ email: string;
4423
+ /**
4424
+ * The role they join with. Ownership is only handed over in the dashboard.
4425
+ */
4426
+ role?: 'admin' | 'member';
4427
+ };
4428
+ path?: never;
4429
+ query?: never;
4430
+ url: '/v1/members/invitations';
4431
+ };
4432
+ type CreateInvitationErrors = {
4433
+ /**
4434
+ * Missing or invalid API key
4435
+ */
4436
+ 401: ErrorResponse;
4437
+ /**
4438
+ * The credential is an API key, or its person is not an owner or admin
4439
+ */
4440
+ 403: ErrorResponse;
4441
+ /**
4442
+ * The address is already a member (already_member)
4443
+ */
4444
+ 409: ErrorResponse;
4445
+ };
4446
+ type CreateInvitationError = CreateInvitationErrors[keyof CreateInvitationErrors];
4447
+ type CreateInvitationResponses = {
4448
+ /**
4449
+ * The open invitation this address already had
4450
+ */
4451
+ 200: Invitation;
4452
+ /**
4453
+ * The invitation, emailed
4454
+ */
4455
+ 201: Invitation;
4456
+ };
4457
+ type CreateInvitationResponse = CreateInvitationResponses[keyof CreateInvitationResponses];
4458
+ type RevokeInvitationData = {
4459
+ body?: never;
4460
+ path: {
4461
+ /**
4462
+ * Invitation id (inv_...).
4463
+ */
4464
+ id: string;
4465
+ };
4466
+ query?: never;
4467
+ url: '/v1/members/invitations/{id}';
4468
+ };
4469
+ type RevokeInvitationErrors = {
4470
+ /**
4471
+ * Missing or invalid API key
4472
+ */
4473
+ 401: ErrorResponse;
4474
+ /**
4475
+ * The credential is an API key, or its person is not an owner or admin
4476
+ */
4477
+ 403: ErrorResponse;
4478
+ /**
4479
+ * No open invitation with that id
4480
+ */
4481
+ 404: ErrorResponse;
4482
+ };
4483
+ type RevokeInvitationError = RevokeInvitationErrors[keyof RevokeInvitationErrors];
4484
+ type RevokeInvitationResponses = {
4485
+ /**
4486
+ * Revoked
4487
+ */
4488
+ 204: void;
4489
+ };
4490
+ type RevokeInvitationResponse = RevokeInvitationResponses[keyof RevokeInvitationResponses];
4491
+ type RemoveMemberData = {
4492
+ body?: never;
4493
+ path: {
4494
+ /**
4495
+ * Membership id (mem_...).
4496
+ */
4497
+ id: string;
4498
+ };
4499
+ query?: never;
4500
+ url: '/v1/members/{id}';
4501
+ };
4502
+ type RemoveMemberErrors = {
4503
+ /**
4504
+ * Missing or invalid API key
4505
+ */
4506
+ 401: ErrorResponse;
4507
+ /**
4508
+ * The credential is an API key, its person is not an owner or admin, or an admin tried to remove an owner
4509
+ */
4510
+ 403: ErrorResponse;
4511
+ /**
4512
+ * Member not found
4513
+ */
4514
+ 404: ErrorResponse;
4515
+ /**
4516
+ * The last owner cannot be removed (last_owner)
4517
+ */
4518
+ 409: ErrorResponse;
4519
+ };
4520
+ type RemoveMemberError = RemoveMemberErrors[keyof RemoveMemberErrors];
4521
+ type RemoveMemberResponses = {
4522
+ /**
4523
+ * Removed
4524
+ */
4525
+ 204: void;
4526
+ };
4527
+ type RemoveMemberResponse = RemoveMemberResponses[keyof RemoveMemberResponses];
4528
+ type GetUsageData = {
4529
+ body?: never;
4530
+ path?: never;
4531
+ query?: never;
4532
+ url: '/v1/usage';
4533
+ };
4534
+ type GetUsageErrors = {
4535
+ /**
4536
+ * Missing or invalid API key
4537
+ */
4538
+ 401: ErrorResponse;
4539
+ };
4540
+ type GetUsageError = GetUsageErrors[keyof GetUsageErrors];
4541
+ type GetUsageResponses = {
4542
+ /**
4543
+ * The usage summary
4544
+ */
4545
+ 200: UsageSummary;
4546
+ };
4547
+ type GetUsageResponse = GetUsageResponses[keyof GetUsageResponses];
3734
4548
  type DeleteAlertData = {
3735
4549
  body?: never;
3736
4550
  path: {
@@ -3796,7 +4610,7 @@ type UpdateAlertData = {
3796
4610
  body: {
3797
4611
  name?: string;
3798
4612
  enabled?: boolean;
3799
- mode?: 'instant' | 'daily';
4613
+ mode?: 'instant' | 'daily' | 'weekly';
3800
4614
  /**
3801
4615
  * Replaces the whole filter.
3802
4616
  */
@@ -3837,12 +4651,24 @@ type UpdateAlertData = {
3837
4651
  * Only posts linking to any of these hosts, the host itself or a subdomain of it (octolens.com also matches blog.octolens.com). A post with no links never passes.
3838
4652
  */
3839
4653
  linkHosts?: Array<string>;
4654
+ /**
4655
+ * Only posts in any of these languages (ISO 639-1: en, es, de). A post whose language is unknown never passes.
4656
+ */
4657
+ languages?: Array<string>;
4658
+ /**
4659
+ * true: only posts that read as machine-made (bots, templated posts); false: only the rest. Omit for both.
4660
+ */
4661
+ automated?: boolean;
3840
4662
  };
3841
4663
  schedule?: {
3842
4664
  hour: number;
3843
4665
  minute?: number;
3844
4666
  timezone: string;
3845
4667
  skipEmpty?: boolean;
4668
+ /**
4669
+ * Weekly rules: the day it sends, 0 Sunday to 6 Saturday. Required for mode weekly; ignored on daily rules.
4670
+ */
4671
+ weekday?: number;
3846
4672
  } | null;
3847
4673
  event?: string | null;
3848
4674
  /**
@@ -3861,7 +4687,7 @@ type UpdateAlertData = {
3861
4687
  };
3862
4688
  type UpdateAlertErrors = {
3863
4689
  /**
3864
- * A daily rule without a schedule, or an unknown channel
4690
+ * A daily or weekly rule without a schedule (or a weekly one without a weekday), or an unknown channel
3865
4691
  */
3866
4692
  400: ErrorResponse;
3867
4693
  /**
@@ -3907,9 +4733,9 @@ type ListAlertsResponses = {
3907
4733
  name: string;
3908
4734
  enabled: boolean;
3909
4735
  /**
3910
- * instant: each matching mention as it happens. daily: one digest at the scheduled local time.
4736
+ * instant: each matching mention as it happens. daily: one digest at the scheduled local time. weekly: one digest a week, on schedule.weekday.
3911
4737
  */
3912
- mode: 'instant' | 'daily';
4738
+ mode: 'instant' | 'daily' | 'weekly';
3913
4739
  filter: {
3914
4740
  /**
3915
4741
  * Only these keywords.
@@ -3947,15 +4773,27 @@ type ListAlertsResponses = {
3947
4773
  * Only posts linking to any of these hosts, the host itself or a subdomain of it (octolens.com also matches blog.octolens.com). A post with no links never passes.
3948
4774
  */
3949
4775
  linkHosts?: Array<string>;
4776
+ /**
4777
+ * Only posts in any of these languages (ISO 639-1: en, es, de). A post whose language is unknown never passes.
4778
+ */
4779
+ languages?: Array<string>;
4780
+ /**
4781
+ * true: only posts that read as machine-made (bots, templated posts); false: only the rest. Omit for both.
4782
+ */
4783
+ automated?: boolean;
3950
4784
  };
3951
4785
  /**
3952
- * Daily alerts only.
4786
+ * Daily and weekly alerts only.
3953
4787
  */
3954
4788
  schedule: {
3955
4789
  hour: number;
3956
4790
  minute?: number;
3957
4791
  timezone: string;
3958
4792
  skipEmpty?: boolean;
4793
+ /**
4794
+ * Weekly rules: the day it sends, 0 Sunday to 6 Saturday. Required for mode weekly; ignored on daily rules.
4795
+ */
4796
+ weekday?: number;
3959
4797
  } | null;
3960
4798
  /**
3961
4799
  * Event name carried in webhook payloads; the mode default unless you set one.
@@ -3982,7 +4820,7 @@ type ListAlertsResponses = {
3982
4820
  */
3983
4821
  lastSentAt: string | null;
3984
4822
  /**
3985
- * Daily alerts: the next digest; null when disabled or instant.
4823
+ * Daily and weekly alerts: the next digest; null when disabled or instant.
3986
4824
  */
3987
4825
  nextRunAt: string | null;
3988
4826
  };
@@ -3998,7 +4836,7 @@ type CreateAlertData = {
3998
4836
  body: {
3999
4837
  name: string;
4000
4838
  enabled?: boolean;
4001
- mode?: 'instant' | 'daily';
4839
+ mode?: 'instant' | 'daily' | 'weekly';
4002
4840
  filter?: {
4003
4841
  /**
4004
4842
  * Only these keywords.
@@ -4036,15 +4874,27 @@ type CreateAlertData = {
4036
4874
  * Only posts linking to any of these hosts, the host itself or a subdomain of it (octolens.com also matches blog.octolens.com). A post with no links never passes.
4037
4875
  */
4038
4876
  linkHosts?: Array<string>;
4877
+ /**
4878
+ * Only posts in any of these languages (ISO 639-1: en, es, de). A post whose language is unknown never passes.
4879
+ */
4880
+ languages?: Array<string>;
4881
+ /**
4882
+ * true: only posts that read as machine-made (bots, templated posts); false: only the rest. Omit for both.
4883
+ */
4884
+ automated?: boolean;
4039
4885
  };
4040
4886
  /**
4041
- * Required for daily alerts.
4887
+ * Required for daily and weekly alerts (weekly ones also need schedule.weekday).
4042
4888
  */
4043
4889
  schedule?: {
4044
4890
  hour: number;
4045
4891
  minute?: number;
4046
4892
  timezone: string;
4047
4893
  skipEmpty?: boolean;
4894
+ /**
4895
+ * Weekly rules: the day it sends, 0 Sunday to 6 Saturday. Required for mode weekly; ignored on daily rules.
4896
+ */
4897
+ weekday?: number;
4048
4898
  };
4049
4899
  /**
4050
4900
  * Custom event name for webhook payloads; null for the mode default.
@@ -4061,7 +4911,7 @@ type CreateAlertData = {
4061
4911
  };
4062
4912
  type CreateAlertErrors = {
4063
4913
  /**
4064
- * A daily rule without a schedule, or an unknown channel
4914
+ * A daily or weekly rule without a schedule (or a weekly one without a weekday), or an unknown channel
4065
4915
  */
4066
4916
  400: ErrorResponse;
4067
4917
  /**
@@ -4125,7 +4975,7 @@ type RunAlertDigestData = {
4125
4975
  };
4126
4976
  type RunAlertDigestErrors = {
4127
4977
  /**
4128
- * Only daily rules have a digest
4978
+ * Only daily and weekly rules have a digest
4129
4979
  */
4130
4980
  400: ErrorResponse;
4131
4981
  /**
@@ -4140,7 +4990,7 @@ type RunAlertDigestErrors = {
4140
4990
  type RunAlertDigestError = RunAlertDigestErrors[keyof RunAlertDigestErrors];
4141
4991
  type RunAlertDigestResponses = {
4142
4992
  /**
4143
- * The digest for the last 24 hours was sent now (the scheduled one still runs)
4993
+ * The digest for the rule's own period (the last day, or the last week) was sent now (the scheduled one still runs)
4144
4994
  */
4145
4995
  200: {
4146
4996
  /**
@@ -4321,13 +5171,13 @@ type GetAnalyticsSeriesData = {
4321
5171
  */
4322
5172
  timezone?: string;
4323
5173
  /**
4324
- * Point granularity. Default: day up to 90 days, week beyond. Weeks start on Monday.
5174
+ * Point granularity: hour (windows of at most 14 days), day, week (Monday start) or month. Default: day up to 90 days, week beyond.
4325
5175
  */
4326
- bucket?: 'day' | 'week';
5176
+ bucket?: 'hour' | 'day' | 'week' | 'month';
4327
5177
  /**
4328
- * Split into one series per platform or per keyword (the top 20 by matched, the rest folded into "other"). Omit for one total series.
5178
+ * Split into one series per platform, per keyword (the top 20 by matched, the rest folded into "other") or per sentiment (positive, neutral, negative, unclassified). Omit for one total series.
4329
5179
  */
4330
- by?: 'platform' | 'keyword';
5180
+ by?: 'platform' | 'keyword' | 'sentiment';
4331
5181
  };
4332
5182
  url: '/v1/analytics/series';
4333
5183
  };
@@ -4382,9 +5232,9 @@ type GetAnalyticsBreakdownData = {
4382
5232
  */
4383
5233
  timezone?: string;
4384
5234
  /**
4385
- * 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).
5235
+ * 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).
4386
5236
  */
4387
- by: 'platform' | 'keyword' | 'sentiment' | 'intent' | 'status' | 'hour' | 'person';
5237
+ by: 'platform' | 'keyword' | 'sentiment' | 'intent' | 'status' | 'hour' | 'person' | 'language';
4388
5238
  };
4389
5239
  url: '/v1/analytics/breakdown';
4390
5240
  };
@@ -4768,7 +5618,7 @@ declare const listKeywords: <ThrowOnError extends boolean = false>(options?: Opt
4768
5618
  /**
4769
5619
  * Track a keyword
4770
5620
  *
4771
- * Start tracking a word or phrase. Matching, classification and delivery begin on the next poll. A funded workspace tracks up to 500 keywords; each costs $5 per month, deducted daily from the balance.
5621
+ * Start tracking a word or phrase. Matching, classification and delivery begin on the next poll. A funded workspace tracks up to 500 keywords; each costs $5 per month, deducted daily from the balance. `matching` narrows what the term matches (required and excluded terms, excluded authors, case) before a mention is stored, so a rejected post is never billed; `context` is a sentence the classifier reads for this keyword only.
4772
5622
  */
4773
5623
  declare const createKeyword: <ThrowOnError extends boolean = false>(options: Options<CreateKeywordData, ThrowOnError>) => RequestResult<CreateKeywordResponses, CreateKeywordErrors, ThrowOnError>;
4774
5624
  /**
@@ -4784,9 +5634,21 @@ declare const getKeyword: <ThrowOnError extends boolean = false>(options: Option
4784
5634
  /**
4785
5635
  * Update a keyword
4786
5636
  *
4787
- * Mute or unmute it, or change the platforms it is tracked on.
5637
+ * Mute or unmute it, reclassify it (`kind`), change the platforms it is tracked on, its classifier `context`, or its `matching` rules (each rule field optional; an empty list clears one). Rules apply to new mentions from the next poll; stored mentions are untouched.
4788
5638
  */
4789
5639
  declare const updateKeyword: <ThrowOnError extends boolean = false>(options: Options<UpdateKeywordData, ThrowOnError>) => RequestResult<UpdateKeywordResponses, UpdateKeywordErrors, ThrowOnError>;
5640
+ /**
5641
+ * Get the workspace filters
5642
+ *
5643
+ * The noise rules applied to every keyword before a mention is stored: excluded terms and authors, excluded GitHub repositories, and the subreddits Reddit posts may (or may not) come from. A post they reject is never classified, delivered or billed. Keyword-level rules live on each keyword (`matching`); both apply.
5644
+ */
5645
+ declare const getFilters: <ThrowOnError extends boolean = false>(options?: Options<GetFiltersData, ThrowOnError>) => RequestResult<GetFiltersResponses, GetFiltersErrors, ThrowOnError>;
5646
+ /**
5647
+ * Update the workspace filters
5648
+ *
5649
+ * Replace any of the lists; an omitted list is untouched and an empty one clears it. Entries are stored in canonical form (terms lowercased, authors as profile links or bare names, repositories as owner/name, subreddits without r/). Takes effect on new mentions within a minute; stored mentions are untouched.
5650
+ */
5651
+ declare const updateFilters: <ThrowOnError extends boolean = false>(options: Options<UpdateFiltersData, ThrowOnError>) => RequestResult<UpdateFiltersResponses, UpdateFiltersErrors, ThrowOnError>;
4790
5652
  /**
4791
5653
  * Get a mention
4792
5654
  *
@@ -4796,13 +5658,13 @@ declare const getMention: <ThrowOnError extends boolean = false>(options: Option
4796
5658
  /**
4797
5659
  * Update a mention
4798
5660
  *
4799
- * The one write on a mention. Set status to ignored or done to handle it (open puts it back), assign it to a workspace member, snooze it out of the feed, or leave an internal note. Null clears a field; omitted fields are untouched. Delivery and billing never change.
5661
+ * The one write on a mention. Set status to ignored or done to handle it (open puts it back), assign it to a workspace member, snooze it out of the feed, leave an internal note, or correct the classifier: `relevant` true or false is your verdict (relevance becomes 100 or 0, and every list, filter, digest and report follows it), `sentiment` replaces the label; null withdraws a verdict and restores the classifier's value. Omitted fields are untouched. Delivery and billing never change.
4800
5662
  */
4801
5663
  declare const updateMention: <ThrowOnError extends boolean = false>(options: Options<UpdateMentionData, ThrowOnError>) => RequestResult<UpdateMentionResponses, UpdateMentionErrors, ThrowOnError>;
4802
5664
  /**
4803
5665
  * List mentions
4804
5666
  *
4805
- * Mentions matched to your keywords, filtered and paginated. Default order is newest match first; sort=priority ranks the last 30 days of matches by attention score. Page with nextCursor, passing the same filters and sort. A mention is one post matched to one keyword.
5667
+ * Mentions matched to your keywords, filtered and paginated. Default order is newest match first; sort=priority ranks the last 30 days of matches by attention score. Page with nextCursor, passing the same filters and sort. A mention is one post matched to one keyword. alertId applies an alert rule's filter on top of the others: the same mentions that rule would send.
4806
5668
  */
4807
5669
  declare const searchMentions: <ThrowOnError extends boolean = false>(options?: Options<SearchMentionsData, ThrowOnError>) => RequestResult<SearchMentionsResponses, SearchMentionsErrors, ThrowOnError>;
4808
5670
  /**
@@ -4820,7 +5682,7 @@ declare const exportPeopleCsv: <ThrowOnError extends boolean = false>(options?:
4820
5682
  /**
4821
5683
  * List people
4822
5684
  *
4823
- * The people behind your mentions: one row per person, with their accounts, reach, public profile, per-workspace stats, your annotations and where your outreach stands. Filter by platform, tag, follower range, mention counts, intents seen, keyword kinds mentioned or never mentioned, outreach stage, owner, or a saved segment. Offset-paginated with a total.
5685
+ * The people behind your mentions: one row per person, with their accounts, reach, public profile, per-workspace stats, your annotations and where your outreach stands. Filter by platform, tag, follower range, mention counts, intents seen, keyword kinds mentioned or never mentioned, outreach stage, owner, automated (bot accounts, whose matched posts are mostly machine-made), or a saved segment. Offset-paginated with a total.
4824
5686
  */
4825
5687
  declare const listPeople: <ThrowOnError extends boolean = false>(options?: Options<ListPeopleData, ThrowOnError>) => RequestResult<ListPeopleResponses, ListPeopleErrors, ThrowOnError>;
4826
5688
  /**
@@ -4908,7 +5770,7 @@ declare const listApiKeys: <ThrowOnError extends boolean = false>(options?: Opti
4908
5770
  /**
4909
5771
  * Create an API key
4910
5772
  *
4911
- * Mint a key for this workspace. The key itself is returned once; only its hash is stored.
5773
+ * Mint a key for this workspace. The key itself is returned once; only its hash is stored. `expiresAt` makes it stop working at an instant (a key for a contractor or a one-off script); it stays listed until revoked.
4912
5774
  */
4913
5775
  declare const createApiKey: <ThrowOnError extends boolean = false>(options: Options<CreateApiKeyData, ThrowOnError>) => RequestResult<CreateApiKeyResponses, CreateApiKeyErrors, ThrowOnError>;
4914
5776
  /**
@@ -4917,6 +5779,48 @@ declare const createApiKey: <ThrowOnError extends boolean = false>(options: Opti
4917
5779
  * Takes effect at once on the API and within a few minutes on cached verifications.
4918
5780
  */
4919
5781
  declare const revokeApiKey: <ThrowOnError extends boolean = false>(options: Options<RevokeApiKeyData, ThrowOnError>) => RequestResult<RevokeApiKeyResponses, RevokeApiKeyErrors, ThrowOnError>;
5782
+ /**
5783
+ * Introspect the credential
5784
+ *
5785
+ * The workspace this credential acts on, how the request authenticated (an API key, an OAuth access token from an MCP sign-in, or the dashboard session), whether it may write, and for a key its id and expiry. Run it first: a read key answers 403 read_only_key on every write, and a wrong workspace is the classic scripting mistake.
5786
+ */
5787
+ declare const whoami: <ThrowOnError extends boolean = false>(options?: Options<WhoamiData, ThrowOnError>) => RequestResult<WhoamiResponses, WhoamiErrors, ThrowOnError>;
5788
+ /**
5789
+ * List members
5790
+ *
5791
+ * Everyone in the workspace, owners first. `userId` is what a mention's assigneeId and a person's ownerId take.
5792
+ */
5793
+ declare const listMembers: <ThrowOnError extends boolean = false>(options?: Options<ListMembersData, ThrowOnError>) => RequestResult<ListMembersResponses, ListMembersErrors, ThrowOnError>;
5794
+ /**
5795
+ * List pending invitations
5796
+ *
5797
+ * Invitations sent and not yet accepted, declined or expired. An accepted one appears in GET /v1/members instead.
5798
+ */
5799
+ declare const listInvitations: <ThrowOnError extends boolean = false>(options?: Options<ListInvitationsData, ThrowOnError>) => RequestResult<ListInvitationsResponses, ListInvitationsErrors, ThrowOnError>;
5800
+ /**
5801
+ * Invite a member
5802
+ *
5803
+ * Send an email invitation to join the workspace as admin or member; it expires after 48 hours. Idempotent: an address that already holds an open invitation gets it back with 200 and no second email. An address that is already a member is a 409 already_member. Team changes need a signed-in owner or admin (an OAuth token from an MCP sign-in, or the dashboard session): an API key answers 403.
5804
+ */
5805
+ declare const createInvitation: <ThrowOnError extends boolean = false>(options: Options<CreateInvitationData, ThrowOnError>) => RequestResult<CreateInvitationResponses, CreateInvitationErrors, ThrowOnError>;
5806
+ /**
5807
+ * Revoke an invitation
5808
+ *
5809
+ * The link in the email stops working at once. Needs a signed-in owner or admin; an API key answers 403.
5810
+ */
5811
+ declare const revokeInvitation: <ThrowOnError extends boolean = false>(options: Options<RevokeInvitationData, ThrowOnError>) => RequestResult<RevokeInvitationResponses, RevokeInvitationErrors, ThrowOnError>;
5812
+ /**
5813
+ * Remove a member
5814
+ *
5815
+ * The person loses the workspace within a minute (their dashboard session on the next request, an OAuth token when its short cache lapses). Their mentions, notes and outreach stay. Needs a signed-in owner or admin; only an owner removes another owner, and the last owner cannot be removed (409 last_owner).
5816
+ */
5817
+ declare const removeMember: <ThrowOnError extends boolean = false>(options: Options<RemoveMemberData, ThrowOnError>) => RequestResult<RemoveMemberResponses, RemoveMemberErrors, ThrowOnError>;
5818
+ /**
5819
+ * Get usage and balance
5820
+ *
5821
+ * The prepaid balance (ledger, pending mention charges, and the effective balance the stop rule reads), the daily burn and the days it buys, the keywords the wallet runs and pauses, the matches recorded today and over 30 days, and whether tracking is stopped or the balance is low. Every matched mention bills ($0.008), relevant or not; every active keyword bills $5 a month, charged daily.
5822
+ */
5823
+ declare const getUsage: <ThrowOnError extends boolean = false>(options?: Options<GetUsageData, ThrowOnError>) => RequestResult<GetUsageResponses, GetUsageErrors, ThrowOnError>;
4920
5824
  /**
4921
5825
  * Delete an alert
4922
5826
  */
@@ -4935,6 +5839,8 @@ declare const updateAlert: <ThrowOnError extends boolean = false>(options: Optio
4935
5839
  declare const listAlerts: <ThrowOnError extends boolean = false>(options?: Options<ListAlertsData, ThrowOnError>) => RequestResult<ListAlertsResponses, ListAlertsErrors, ThrowOnError>;
4936
5840
  /**
4937
5841
  * Create an alert
5842
+ *
5843
+ * A rule (what to watch, the filter) times channels. mode instant sends each matching mention as it happens; daily sends one digest at schedule.hour in schedule.timezone; weekly sends one a week on schedule.weekday (0 Sunday to 6 Saturday).
4938
5844
  */
4939
5845
  declare const createAlert: <ThrowOnError extends boolean = false>(options: Options<CreateAlertData, ThrowOnError>) => RequestResult<CreateAlertResponses, CreateAlertErrors, ThrowOnError>;
4940
5846
  /**
@@ -5018,6 +5924,7 @@ type sdk_Options<TData extends TDataShape = TDataShape, ThrowOnError extends boo
5018
5924
  declare const sdk_createAlert: typeof createAlert;
5019
5925
  declare const sdk_createApiKey: typeof createApiKey;
5020
5926
  declare const sdk_createChannel: typeof createChannel;
5927
+ declare const sdk_createInvitation: typeof createInvitation;
5021
5928
  declare const sdk_createKeyword: typeof createKeyword;
5022
5929
  declare const sdk_createSegment: typeof createSegment;
5023
5930
  declare const sdk_deleteAlert: typeof deleteAlert;
@@ -5033,24 +5940,30 @@ declare const sdk_getAnalyticsSeries: typeof getAnalyticsSeries;
5033
5940
  declare const sdk_getAnalyticsSummary: typeof getAnalyticsSummary;
5034
5941
  declare const sdk_getChannel: typeof getChannel;
5035
5942
  declare const sdk_getCompany: typeof getCompany;
5943
+ declare const sdk_getFilters: typeof getFilters;
5036
5944
  declare const sdk_getHealth: typeof getHealth;
5037
5945
  declare const sdk_getKeyword: typeof getKeyword;
5038
5946
  declare const sdk_getMention: typeof getMention;
5039
5947
  declare const sdk_getPerson: typeof getPerson;
5040
5948
  declare const sdk_getSegment: typeof getSegment;
5041
5949
  declare const sdk_getShareOfVoice: typeof getShareOfVoice;
5950
+ declare const sdk_getUsage: typeof getUsage;
5042
5951
  declare const sdk_listAlerts: typeof listAlerts;
5043
5952
  declare const sdk_listApiKeys: typeof listApiKeys;
5044
5953
  declare const sdk_listChannelDeliveries: typeof listChannelDeliveries;
5045
5954
  declare const sdk_listChannels: typeof listChannels;
5955
+ declare const sdk_listInvitations: typeof listInvitations;
5046
5956
  declare const sdk_listKeywords: typeof listKeywords;
5957
+ declare const sdk_listMembers: typeof listMembers;
5047
5958
  declare const sdk_listPeople: typeof listPeople;
5048
5959
  declare const sdk_listPersonActivities: typeof listPersonActivities;
5049
5960
  declare const sdk_listSegments: typeof listSegments;
5050
5961
  declare const sdk_logPersonActivity: typeof logPersonActivity;
5051
5962
  declare const sdk_mergePeople: typeof mergePeople;
5052
5963
  declare const sdk_muteAlertAuthors: typeof muteAlertAuthors;
5964
+ declare const sdk_removeMember: typeof removeMember;
5053
5965
  declare const sdk_revokeApiKey: typeof revokeApiKey;
5966
+ declare const sdk_revokeInvitation: typeof revokeInvitation;
5054
5967
  declare const sdk_rotateWebhookSecret: typeof rotateWebhookSecret;
5055
5968
  declare const sdk_runAlertDigest: typeof runAlertDigest;
5056
5969
  declare const sdk_searchMentions: typeof searchMentions;
@@ -5061,12 +5974,14 @@ declare const sdk_unmuteAlertAuthors: typeof unmuteAlertAuthors;
5061
5974
  declare const sdk_updateAlert: typeof updateAlert;
5062
5975
  declare const sdk_updateChannel: typeof updateChannel;
5063
5976
  declare const sdk_updateCompany: typeof updateCompany;
5977
+ declare const sdk_updateFilters: typeof updateFilters;
5064
5978
  declare const sdk_updateKeyword: typeof updateKeyword;
5065
5979
  declare const sdk_updateMention: typeof updateMention;
5066
5980
  declare const sdk_updatePerson: typeof updatePerson;
5067
5981
  declare const sdk_updateSegment: typeof updateSegment;
5982
+ declare const sdk_whoami: typeof whoami;
5068
5983
  declare namespace sdk {
5069
- export { type sdk_Options as Options, sdk_createAlert as createAlert, sdk_createApiKey as createApiKey, sdk_createChannel as createChannel, sdk_createKeyword as createKeyword, sdk_createSegment as createSegment, sdk_deleteAlert as deleteAlert, sdk_deleteChannel as deleteChannel, sdk_deleteKeyword as deleteKeyword, sdk_deletePersonActivity as deletePersonActivity, sdk_deleteSegment as deleteSegment, 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_getHealth as getHealth, sdk_getKeyword as getKeyword, sdk_getMention as getMention, sdk_getPerson as getPerson, sdk_getSegment as getSegment, sdk_getShareOfVoice as getShareOfVoice, sdk_listAlerts as listAlerts, sdk_listApiKeys as listApiKeys, sdk_listChannelDeliveries as listChannelDeliveries, sdk_listChannels as listChannels, sdk_listKeywords as listKeywords, sdk_listPeople as listPeople, sdk_listPersonActivities as listPersonActivities, sdk_listSegments as listSegments, sdk_logPersonActivity as logPersonActivity, sdk_mergePeople as mergePeople, sdk_muteAlertAuthors as muteAlertAuthors, sdk_revokeApiKey as revokeApiKey, 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_updateKeyword as updateKeyword, sdk_updateMention as updateMention, sdk_updatePerson as updatePerson, sdk_updateSegment as updateSegment };
5984
+ 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_deleteAlert as deleteAlert, sdk_deleteChannel as deleteChannel, sdk_deleteKeyword as deleteKeyword, sdk_deletePersonActivity as deletePersonActivity, sdk_deleteSegment as deleteSegment, 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_getKeyword as getKeyword, sdk_getMention as getMention, sdk_getPerson as getPerson, sdk_getSegment as getSegment, sdk_getShareOfVoice as getShareOfVoice, sdk_getUsage as getUsage, sdk_listAlerts as listAlerts, sdk_listApiKeys as listApiKeys, sdk_listChannelDeliveries as listChannelDeliveries, sdk_listChannels as listChannels, sdk_listInvitations as listInvitations, sdk_listKeywords as listKeywords, sdk_listMembers as listMembers, sdk_listPeople as listPeople, sdk_listPersonActivities as listPersonActivities, sdk_listSegments as listSegments, 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_whoami as whoami };
5070
5985
  }
5071
5986
 
5072
5987
  /**
@@ -5094,4 +6009,4 @@ type Mentio = typeof sdk & {
5094
6009
  };
5095
6010
  declare function createMentio(options: MentioOptions): Mentio;
5096
6011
 
5097
- 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 CreateKeywordData, type CreateKeywordError, type CreateKeywordErrors, type CreateKeywordResponse, type CreateKeywordResponses, type CreateSegmentData, type CreateSegmentError, type CreateSegmentErrors, type CreateSegmentResponse, type CreateSegmentResponses, type CreateSlackChannel, 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 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 GetHealthData, type GetHealthResponse, type GetHealthResponses, 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 Keyword, 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 ListKeywordsData, type ListKeywordsError, type ListKeywordsErrors, type ListKeywordsResponse, type ListKeywordsResponses, 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 LogPersonActivityData, type LogPersonActivityError, type LogPersonActivityErrors, type LogPersonActivityResponse, type LogPersonActivityResponses, 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 RequestResult, type RevokeApiKeyData, type RevokeApiKeyError, type RevokeApiKeyErrors, type RevokeApiKeyResponse, type RevokeApiKeyResponses, 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 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 WebhookChannel, createAlert, createApiKey, createChannel, createClient, createConfig, createKeyword, createMentio, createSegment, deleteAlert, deleteChannel, deleteKeyword, deletePersonActivity, deleteSegment, exportMentionsCsv, exportPeopleCsv, getAlert, getAnalyticsBreakdown, getAnalyticsSeries, getAnalyticsSummary, getChannel, getCompany, getHealth, getKeyword, getMention, getPerson, getSegment, getShareOfVoice, listAlerts, listApiKeys, listChannelDeliveries, listChannels, listKeywords, listPeople, listPersonActivities, listSegments, logPersonActivity, mergePeople, muteAlertAuthors, revokeApiKey, rotateWebhookSecret, runAlertDigest, searchMentions, splitPerson, testAlert, testChannel, unmuteAlertAuthors, updateAlert, updateChannel, updateCompany, updateKeyword, updateMention, updatePerson, updateSegment };
6012
+ 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 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 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 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 GetUsageData, type GetUsageError, type GetUsageErrors, type GetUsageResponse, type GetUsageResponses, type Invitation, type Keyword, 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 ListKeywordsData, type ListKeywordsError, type ListKeywordsErrors, type ListKeywordsResponse, type ListKeywordsResponses, 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 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 UsageSummary, 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, deleteAlert, deleteChannel, deleteKeyword, deletePersonActivity, deleteSegment, exportMentionsCsv, exportPeopleCsv, getAlert, getAnalyticsBreakdown, getAnalyticsSeries, getAnalyticsSummary, getChannel, getCompany, getFilters, getHealth, getKeyword, getMention, getPerson, getSegment, getShareOfVoice, getUsage, listAlerts, listApiKeys, listChannelDeliveries, listChannels, listInvitations, listKeywords, listMembers, listPeople, listPersonActivities, listSegments, logPersonActivity, mergePeople, muteAlertAuthors, removeMember, revokeApiKey, revokeInvitation, rotateWebhookSecret, runAlertDigest, searchMentions, splitPerson, testAlert, testChannel, unmuteAlertAuthors, updateAlert, updateChannel, updateCompany, updateFilters, updateKeyword, updateMention, updatePerson, updateSegment, whoami };