@mentio-dev/sdk 0.15.0 → 0.15.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.
Files changed (2) hide show
  1. package/dist/index.d.ts +921 -3
  2. package/package.json +1 -1
package/dist/index.d.ts CHANGED
@@ -396,7 +396,13 @@ type Keyword = {
396
396
  * Keyword id (kw_...).
397
397
  */
398
398
  id: string;
399
+ /**
400
+ * The tracked text, as typed.
401
+ */
399
402
  term: string;
403
+ /**
404
+ * brand (your own name), competitor, or topic.
405
+ */
400
406
  kind: 'brand' | 'competitor' | 'topic';
401
407
  /**
402
408
  * Not polled or matched. Paused by you, by the wallet (see pausedForBalance) or by the noise brake (see pausedForNoise). A keyword at its mention cap is not muted (see pausedForCap).
@@ -1353,6 +1359,9 @@ type Mention = {
1353
1359
  */
1354
1360
  matchedIn: 'text' | 'speech';
1355
1361
  };
1362
+ /**
1363
+ * The post: platform, text, link, publish time and engagement.
1364
+ */
1356
1365
  post: {
1357
1366
  /**
1358
1367
  * Platform: bluesky, hackernews, github, stackoverflow, devto, reddit, x, youtube, news, linkedin, tiktok, instagram, facebook, appstore (App Store reviews), googleplay (Google Play reviews), trustpilot (Trustpilot reviews), googlemaps (Google reviews of a place), rss (RSS and Atom feeds a keyword reads).
@@ -1425,11 +1434,29 @@ type Mention = {
1425
1434
  * Counts as the platform reported them at ingest, usually minutes after posting; a missing count is null. Null as a whole when a platform reports none, or before September 2026. X carries all six.
1426
1435
  */
1427
1436
  engagement: {
1437
+ /**
1438
+ * Likes or upvotes when the post was ingested; null when the platform does not report them.
1439
+ */
1428
1440
  likes: number | null;
1441
+ /**
1442
+ * Reposts or shares when ingested; null when not reported.
1443
+ */
1429
1444
  reposts: number | null;
1445
+ /**
1446
+ * Replies or comments when ingested; null when not reported.
1447
+ */
1430
1448
  replies: number | null;
1449
+ /**
1450
+ * Quotes when ingested; null when not reported.
1451
+ */
1431
1452
  quotes: number | null;
1453
+ /**
1454
+ * Views when ingested; null when not reported.
1455
+ */
1432
1456
  views: number | null;
1457
+ /**
1458
+ * Bookmarks or saves when ingested; null when not reported.
1459
+ */
1433
1460
  bookmarks: number | null;
1434
1461
  } | null;
1435
1462
  /**
@@ -1550,7 +1577,7 @@ type Mention = {
1550
1577
  */
1551
1578
  relevance: number | null;
1552
1579
  /**
1553
- * Classifier sentiment.
1580
+ * positive, neutral or negative; null until classified.
1554
1581
  */
1555
1582
  sentiment: 'positive' | 'neutral' | 'negative';
1556
1583
  /**
@@ -1627,13 +1654,25 @@ type Mention = {
1627
1654
  };
1628
1655
  } | null;
1629
1656
  } | null;
1657
+ /**
1658
+ * What your team did with it: status, assignee, snooze and notes.
1659
+ */
1630
1660
  triage: {
1631
1661
  /**
1632
1662
  * Workspace member this mention is assigned to; null when unassigned.
1633
1663
  */
1634
1664
  assignee: {
1665
+ /**
1666
+ * User id.
1667
+ */
1635
1668
  id: string;
1669
+ /**
1670
+ * Member name.
1671
+ */
1636
1672
  name: string | null;
1673
+ /**
1674
+ * Member email.
1675
+ */
1637
1676
  email: string | null;
1638
1677
  } | null;
1639
1678
  /**
@@ -1726,11 +1765,29 @@ type MentionComment = {
1726
1765
  * Counts as the platform reported them at ingest, usually minutes after posting; a missing count is null. Null as a whole when a platform reports none, or before September 2026. X carries all six.
1727
1766
  */
1728
1767
  engagement: {
1768
+ /**
1769
+ * Likes or upvotes when the post was ingested; null when the platform does not report them.
1770
+ */
1729
1771
  likes: number | null;
1772
+ /**
1773
+ * Reposts or shares when ingested; null when not reported.
1774
+ */
1730
1775
  reposts: number | null;
1776
+ /**
1777
+ * Replies or comments when ingested; null when not reported.
1778
+ */
1731
1779
  replies: number | null;
1780
+ /**
1781
+ * Quotes when ingested; null when not reported.
1782
+ */
1732
1783
  quotes: number | null;
1784
+ /**
1785
+ * Views when ingested; null when not reported.
1786
+ */
1733
1787
  views: number | null;
1788
+ /**
1789
+ * Bookmarks or saves when ingested; null when not reported.
1790
+ */
1734
1791
  bookmarks: number | null;
1735
1792
  } | null;
1736
1793
  /**
@@ -1738,7 +1795,7 @@ type MentionComment = {
1738
1795
  */
1739
1796
  classification: {
1740
1797
  /**
1741
- * Classifier sentiment.
1798
+ * positive, neutral or negative; null until classified.
1742
1799
  */
1743
1800
  sentiment: 'positive' | 'neutral' | 'negative';
1744
1801
  /**
@@ -1772,6 +1829,9 @@ type Person = {
1772
1829
  * Profile URL of the canonical account.
1773
1830
  */
1774
1831
  url: string | null;
1832
+ /**
1833
+ * Profile picture URL.
1834
+ */
1775
1835
  avatarUrl: string | null;
1776
1836
  /**
1777
1837
  * Every account this workspace treats as this person, the canonical one first.
@@ -1802,17 +1862,38 @@ type Person = {
1802
1862
  * Platform counts as of their newest post; null where the platform has no such number.
1803
1863
  */
1804
1864
  reach: {
1865
+ /**
1866
+ * Followers when last seen; null when unknown.
1867
+ */
1805
1868
  followers: number | null;
1869
+ /**
1870
+ * Accounts they follow; null when unknown.
1871
+ */
1806
1872
  following: number | null;
1873
+ /**
1874
+ * Posts on the platform; null when unknown.
1875
+ */
1807
1876
  posts: number | null;
1808
1877
  };
1809
1878
  /**
1810
1879
  * Public profile facts; null until looked up.
1811
1880
  */
1812
1881
  profile: {
1882
+ /**
1883
+ * The profile's bio, as the platform shows it.
1884
+ */
1813
1885
  bio: string | null;
1886
+ /**
1887
+ * Company named on the profile.
1888
+ */
1814
1889
  company: string | null;
1890
+ /**
1891
+ * Location named on the profile.
1892
+ */
1815
1893
  location: string | null;
1894
+ /**
1895
+ * Website linked from the profile.
1896
+ */
1816
1897
  website: string | null;
1817
1898
  /**
1818
1899
  * Only when the person made it public on the platform.
@@ -1822,7 +1903,13 @@ type Person = {
1822
1903
  * Other accounts the person lists on their profile.
1823
1904
  */
1824
1905
  links: Array<{
1906
+ /**
1907
+ * The platform or kind of the linked account (github, x, website, ...).
1908
+ */
1825
1909
  provider: string;
1910
+ /**
1911
+ * Link to the account.
1912
+ */
1826
1913
  url: string;
1827
1914
  }>;
1828
1915
  /**
@@ -1842,9 +1929,21 @@ type Person = {
1842
1929
  * Of those, scored relevant.
1843
1930
  */
1844
1931
  relevant: number;
1932
+ /**
1933
+ * Their matched mentions by sentiment.
1934
+ */
1845
1935
  sentiment: {
1936
+ /**
1937
+ * Scored positive.
1938
+ */
1846
1939
  positive: number;
1940
+ /**
1941
+ * Scored neutral.
1942
+ */
1847
1943
  neutral: number;
1944
+ /**
1945
+ * Scored negative.
1946
+ */
1848
1947
  negative: number;
1849
1948
  };
1850
1949
  /**
@@ -1860,7 +1959,13 @@ type Person = {
1860
1959
  * What this workspace wrote about the person.
1861
1960
  */
1862
1961
  annotations: {
1962
+ /**
1963
+ * Tags your team gave them.
1964
+ */
1863
1965
  tags: Array<string>;
1966
+ /**
1967
+ * Your team's notes.
1968
+ */
1864
1969
  notes: string;
1865
1970
  /**
1866
1971
  * Their posts stay out of the feed and every channel; ingest and billing are untouched. Read with groupId it is that group's own mute, which hides them from the mentions of that group's keywords only.
@@ -1879,7 +1984,13 @@ type Person = {
1879
1984
  * User id of the workspace member.
1880
1985
  */
1881
1986
  id: string;
1987
+ /**
1988
+ * The member's name.
1989
+ */
1882
1990
  name: string | null;
1991
+ /**
1992
+ * The member's email.
1993
+ */
1883
1994
  email: string | null;
1884
1995
  } | null;
1885
1996
  /**
@@ -1917,7 +2028,13 @@ type PersonActivity = {
1917
2028
  * User id of the workspace member.
1918
2029
  */
1919
2030
  id: string;
2031
+ /**
2032
+ * The member's name.
2033
+ */
1920
2034
  name: string | null;
2035
+ /**
2036
+ * The member's email.
2037
+ */
1921
2038
  email: string | null;
1922
2039
  } | null;
1923
2040
  /**
@@ -2010,6 +2127,18 @@ type SegmentPreset = {
2010
2127
  * People at any of these outreach stages.
2011
2128
  */
2012
2129
  stages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
2130
+ /**
2131
+ * Nobody at these outreach stages.
2132
+ */
2133
+ notStages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
2134
+ /**
2135
+ * Nobody with a mention linking to any of these hosts, the host itself or a subdomain of it.
2136
+ */
2137
+ notLinkHosts?: Array<string>;
2138
+ /**
2139
+ * Nobody owned by these members (user ids); "none" drops the people nobody owns.
2140
+ */
2141
+ notOwnerIds?: Array<string>;
2013
2142
  /**
2014
2143
  * true: only people whose matched posts are mostly machine-made (bot accounts); false: only the rest.
2015
2144
  */
@@ -2025,8 +2154,17 @@ type Segment = {
2025
2154
  * Segment id (seg_...).
2026
2155
  */
2027
2156
  id: string;
2157
+ /**
2158
+ * Segment name.
2159
+ */
2028
2160
  name: string;
2161
+ /**
2162
+ * What the segment is for.
2163
+ */
2029
2164
  description: string;
2165
+ /**
2166
+ * The people filter it saves (the fields of GET /v1/people).
2167
+ */
2030
2168
  filter: {
2031
2169
  /**
2032
2170
  * People with an account on any of these platforms.
@@ -2092,6 +2230,18 @@ type Segment = {
2092
2230
  * People at any of these outreach stages.
2093
2231
  */
2094
2232
  stages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
2233
+ /**
2234
+ * Nobody at these outreach stages.
2235
+ */
2236
+ notStages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
2237
+ /**
2238
+ * Nobody with a mention linking to any of these hosts, the host itself or a subdomain of it.
2239
+ */
2240
+ notLinkHosts?: Array<string>;
2241
+ /**
2242
+ * Nobody owned by these members (user ids); "none" drops the people nobody owns.
2243
+ */
2244
+ notOwnerIds?: Array<string>;
2095
2245
  /**
2096
2246
  * true: only people whose matched posts are mostly machine-made (bot accounts); false: only the rest.
2097
2247
  */
@@ -2138,6 +2288,10 @@ type FilterGroup = {
2138
2288
  * Only matches of keywords of any of these kinds: brand, competitor, topic.
2139
2289
  */
2140
2290
  keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
2291
+ /**
2292
+ * Never matches of keywords of these kinds.
2293
+ */
2294
+ notKeywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
2141
2295
  /**
2142
2296
  * Only matches of keywords in any of these groups (grp_...).
2143
2297
  */
@@ -2296,8 +2450,17 @@ type View = {
2296
2450
  * View id (vw_...).
2297
2451
  */
2298
2452
  id: string;
2453
+ /**
2454
+ * View name.
2455
+ */
2299
2456
  name: string;
2457
+ /**
2458
+ * What the view is for.
2459
+ */
2300
2460
  description: string;
2461
+ /**
2462
+ * The mentions filter it saves (the fields of GET /v1/mentions).
2463
+ */
2301
2464
  filter: {
2302
2465
  /**
2303
2466
  * Substring in the post text or the author's name.
@@ -2315,6 +2478,10 @@ type View = {
2315
2478
  * Only matches of keywords of any of these kinds: brand, competitor, topic.
2316
2479
  */
2317
2480
  keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
2481
+ /**
2482
+ * Never matches of keywords of these kinds.
2483
+ */
2484
+ notKeywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
2318
2485
  /**
2319
2486
  * Only matches of keywords in any of these groups (grp_...).
2320
2487
  */
@@ -2990,8 +3157,17 @@ type Invitation = {
2990
3157
  * Who sent it; an API key invites on behalf of the oldest owner.
2991
3158
  */
2992
3159
  invitedBy: {
3160
+ /**
3161
+ * User id.
3162
+ */
2993
3163
  id: string;
3164
+ /**
3165
+ * Their email.
3166
+ */
2994
3167
  email: string;
3168
+ /**
3169
+ * Their name.
3170
+ */
2995
3171
  name: string | null;
2996
3172
  } | null;
2997
3173
  /**
@@ -3020,6 +3196,9 @@ type UsageSummary = {
3020
3196
  * cents minus pendingCents: what the stop rule and the keyword gate look at.
3021
3197
  */
3022
3198
  effectiveCents: number;
3199
+ /**
3200
+ * Always USD.
3201
+ */
3023
3202
  currency: 'USD';
3024
3203
  };
3025
3204
  /**
@@ -3339,6 +3518,9 @@ type Wallet = {
3339
3518
  * Every amount on this page is in USD cents.
3340
3519
  */
3341
3520
  currency: 'USD';
3521
+ /**
3522
+ * Automatic top-up: off unless set in the dashboard.
3523
+ */
3342
3524
  autoRecharge: {
3343
3525
  /**
3344
3526
  * This deployment can charge saved cards; false hides the setting.
@@ -3457,7 +3639,13 @@ type Alert = {
3457
3639
  * Alert id (feed_...).
3458
3640
  */
3459
3641
  id: string;
3642
+ /**
3643
+ * Rule name.
3644
+ */
3460
3645
  name: string;
3646
+ /**
3647
+ * false: the rule sends nothing.
3648
+ */
3461
3649
  enabled: boolean;
3462
3650
  /**
3463
3651
  * When it sends; see [Alerts](/alerts).
@@ -3468,6 +3656,9 @@ type Alert = {
3468
3656
  * - weekly: one digest a week, on schedule.weekday.
3469
3657
  */
3470
3658
  mode: 'instant' | 'hourly' | 'daily' | 'weekly';
3659
+ /**
3660
+ * Which mentions the rule sends.
3661
+ */
3471
3662
  filter: {
3472
3663
  /**
3473
3664
  * Only these keywords.
@@ -3574,9 +3765,21 @@ type Alert = {
3574
3765
  * Daily and weekly alerts only; null for instant and hourly ones.
3575
3766
  */
3576
3767
  schedule: {
3768
+ /**
3769
+ * Hour of the day to send, 0 to 23, in timezone.
3770
+ */
3577
3771
  hour: number;
3772
+ /**
3773
+ * Minute past the hour, 0 to 59.
3774
+ */
3578
3775
  minute?: number;
3776
+ /**
3777
+ * IANA zone the schedule runs in (Europe/Madrid).
3778
+ */
3579
3779
  timezone: string;
3780
+ /**
3781
+ * true: send nothing when the window had no mention.
3782
+ */
3580
3783
  skipEmpty?: boolean;
3581
3784
  /**
3582
3785
  * Weekly rules: the day it sends, 0 Sunday to 6 Saturday. Required for mode weekly; ignored on daily rules.
@@ -3591,8 +3794,17 @@ type Alert = {
3591
3794
  * Where it sends.
3592
3795
  */
3593
3796
  channels: Array<{
3797
+ /**
3798
+ * Channel id (dest_...).
3799
+ */
3594
3800
  id: string;
3801
+ /**
3802
+ * Channel kind.
3803
+ */
3595
3804
  kind: 'slack' | 'email' | 'webhook' | 'telegram';
3805
+ /**
3806
+ * Channel name.
3807
+ */
3596
3808
  label: string;
3597
3809
  }>;
3598
3810
  /**
@@ -4221,6 +4433,9 @@ type ReviewsReport = {
4221
4433
  */
4222
4434
  bucket: 'day' | 'week';
4223
4435
  };
4436
+ /**
4437
+ * The window's review count and average rating.
4438
+ */
4224
4439
  totals: {
4225
4440
  /**
4226
4441
  * Reviews published in the window; a review matched by two keywords counts once.
@@ -4234,10 +4449,25 @@ type ReviewsReport = {
4234
4449
  * Reviews per star rating.
4235
4450
  */
4236
4451
  distribution: {
4452
+ /**
4453
+ * One star.
4454
+ */
4237
4455
  1: number;
4456
+ /**
4457
+ * Two stars.
4458
+ */
4238
4459
  2: number;
4460
+ /**
4461
+ * Three stars.
4462
+ */
4239
4463
  3: number;
4464
+ /**
4465
+ * Four stars.
4466
+ */
4240
4467
  4: number;
4468
+ /**
4469
+ * Five stars.
4470
+ */
4241
4471
  5: number;
4242
4472
  };
4243
4473
  /**
@@ -4253,7 +4483,13 @@ type ReviewsReport = {
4253
4483
  * Intent and topic tags on the 1 and 2 star reviews, most frequent first: what the unhappy ones are about.
4254
4484
  */
4255
4485
  tags: Array<{
4486
+ /**
4487
+ * The intent or topic tag.
4488
+ */
4256
4489
  tag: string;
4490
+ /**
4491
+ * Reviews carrying it.
4492
+ */
4257
4493
  count: number;
4258
4494
  }>;
4259
4495
  /**
@@ -4272,10 +4508,25 @@ type ReviewsReport = {
4272
4508
  * Reviews per star rating.
4273
4509
  */
4274
4510
  distribution: {
4511
+ /**
4512
+ * One star.
4513
+ */
4275
4514
  1: number;
4515
+ /**
4516
+ * Two stars.
4517
+ */
4276
4518
  2: number;
4519
+ /**
4520
+ * Three stars.
4521
+ */
4277
4522
  3: number;
4523
+ /**
4524
+ * Four stars.
4525
+ */
4278
4526
  4: number;
4527
+ /**
4528
+ * Five stars.
4529
+ */
4279
4530
  5: number;
4280
4531
  };
4281
4532
  /**
@@ -4306,6 +4557,9 @@ type ReviewsReport = {
4306
4557
  * Bucket start, YYYY-MM-DD.
4307
4558
  */
4308
4559
  date: string;
4560
+ /**
4561
+ * Reviews in the bucket.
4562
+ */
4309
4563
  reviews: number;
4310
4564
  /**
4311
4565
  * Average stars, one decimal; null with no reviews.
@@ -4316,6 +4570,9 @@ type ReviewsReport = {
4316
4570
  * The period of the same length right before the window, with compare=true; else null.
4317
4571
  */
4318
4572
  previous: {
4573
+ /**
4574
+ * Reviews in the window.
4575
+ */
4319
4576
  reviews: number;
4320
4577
  /**
4321
4578
  * Average stars, one decimal; null with no reviews.
@@ -4339,10 +4596,25 @@ type ReviewsReport = {
4339
4596
  * Reviews per star rating.
4340
4597
  */
4341
4598
  distribution: {
4599
+ /**
4600
+ * One star.
4601
+ */
4342
4602
  1: number;
4603
+ /**
4604
+ * Two stars.
4605
+ */
4343
4606
  2: number;
4607
+ /**
4608
+ * Three stars.
4609
+ */
4344
4610
  3: number;
4611
+ /**
4612
+ * Four stars.
4613
+ */
4345
4614
  4: number;
4615
+ /**
4616
+ * Five stars.
4617
+ */
4346
4618
  5: number;
4347
4619
  };
4348
4620
  /**
@@ -4360,6 +4632,9 @@ type SlackChannel = {
4360
4632
  * Channel id (dest_...).
4361
4633
  */
4362
4634
  id: string;
4635
+ /**
4636
+ * Your name for the channel.
4637
+ */
4363
4638
  label: string;
4364
4639
  /**
4365
4640
  * Computed over this workspace's deliveries.
@@ -4381,7 +4656,13 @@ type SlackChannel = {
4381
4656
  * Deliveries in the last 7 days.
4382
4657
  */
4383
4658
  last7d: {
4659
+ /**
4660
+ * Sends attempted.
4661
+ */
4384
4662
  total: number;
4663
+ /**
4664
+ * Sends that failed.
4665
+ */
4385
4666
  failed: number;
4386
4667
  };
4387
4668
  };
@@ -4389,7 +4670,13 @@ type SlackChannel = {
4389
4670
  * ISO 8601 timestamp, UTC.
4390
4671
  */
4391
4672
  createdAt: string;
4673
+ /**
4674
+ * Channel kind.
4675
+ */
4392
4676
  kind: 'slack';
4677
+ /**
4678
+ * The channel's settings for its kind; secrets are never returned.
4679
+ */
4393
4680
  config: {
4394
4681
  /**
4395
4682
  * Slack channel id.
@@ -4410,6 +4697,9 @@ type EmailChannel = {
4410
4697
  * Channel id (dest_...).
4411
4698
  */
4412
4699
  id: string;
4700
+ /**
4701
+ * Your name for the channel.
4702
+ */
4413
4703
  label: string;
4414
4704
  /**
4415
4705
  * Computed over this workspace's deliveries.
@@ -4431,7 +4721,13 @@ type EmailChannel = {
4431
4721
  * Deliveries in the last 7 days.
4432
4722
  */
4433
4723
  last7d: {
4724
+ /**
4725
+ * Sends attempted.
4726
+ */
4434
4727
  total: number;
4728
+ /**
4729
+ * Sends that failed.
4730
+ */
4435
4731
  failed: number;
4436
4732
  };
4437
4733
  };
@@ -4439,12 +4735,21 @@ type EmailChannel = {
4439
4735
  * ISO 8601 timestamp, UTC.
4440
4736
  */
4441
4737
  createdAt: string;
4738
+ /**
4739
+ * Channel kind.
4740
+ */
4442
4741
  kind: 'email';
4742
+ /**
4743
+ * The channel's settings for its kind; secrets are never returned.
4744
+ */
4443
4745
  config: {
4444
4746
  /**
4445
4747
  * Every address on the list and whether it confirmed.
4446
4748
  */
4447
4749
  recipients: Array<{
4750
+ /**
4751
+ * Recipient address.
4752
+ */
4448
4753
  email: string;
4449
4754
  /**
4450
4755
  * Null until the address confirmed through its link; unconfirmed addresses receive nothing.
@@ -4462,6 +4767,9 @@ type WebhookChannel = {
4462
4767
  * Channel id (dest_...).
4463
4768
  */
4464
4769
  id: string;
4770
+ /**
4771
+ * Your name for the channel.
4772
+ */
4465
4773
  label: string;
4466
4774
  /**
4467
4775
  * Computed over this workspace's deliveries.
@@ -4483,7 +4791,13 @@ type WebhookChannel = {
4483
4791
  * Deliveries in the last 7 days.
4484
4792
  */
4485
4793
  last7d: {
4794
+ /**
4795
+ * Sends attempted.
4796
+ */
4486
4797
  total: number;
4798
+ /**
4799
+ * Sends that failed.
4800
+ */
4487
4801
  failed: number;
4488
4802
  };
4489
4803
  };
@@ -4491,7 +4805,13 @@ type WebhookChannel = {
4491
4805
  * ISO 8601 timestamp, UTC.
4492
4806
  */
4493
4807
  createdAt: string;
4808
+ /**
4809
+ * Channel kind.
4810
+ */
4494
4811
  kind: 'webhook';
4812
+ /**
4813
+ * The channel's settings for its kind; secrets are never returned.
4814
+ */
4495
4815
  config: {
4496
4816
  /**
4497
4817
  * Where the signed POSTs go.
@@ -4518,6 +4838,9 @@ type TelegramChannel = {
4518
4838
  * Channel id (dest_...).
4519
4839
  */
4520
4840
  id: string;
4841
+ /**
4842
+ * Your name for the channel.
4843
+ */
4521
4844
  label: string;
4522
4845
  /**
4523
4846
  * Computed over this workspace's deliveries.
@@ -4539,7 +4862,13 @@ type TelegramChannel = {
4539
4862
  * Deliveries in the last 7 days.
4540
4863
  */
4541
4864
  last7d: {
4865
+ /**
4866
+ * Sends attempted.
4867
+ */
4542
4868
  total: number;
4869
+ /**
4870
+ * Sends that failed.
4871
+ */
4543
4872
  failed: number;
4544
4873
  };
4545
4874
  };
@@ -4547,12 +4876,21 @@ type TelegramChannel = {
4547
4876
  * ISO 8601 timestamp, UTC.
4548
4877
  */
4549
4878
  createdAt: string;
4879
+ /**
4880
+ * Channel kind.
4881
+ */
4550
4882
  kind: 'telegram';
4883
+ /**
4884
+ * The channel's settings for its kind; secrets are never returned.
4885
+ */
4551
4886
  config: {
4552
4887
  /**
4553
4888
  * Telegram chat id.
4554
4889
  */
4555
4890
  chatId: string;
4891
+ /**
4892
+ * private, group, supergroup or channel.
4893
+ */
4556
4894
  chatType: 'private' | 'group' | 'supergroup' | 'channel';
4557
4895
  /**
4558
4896
  * The attention events this channel receives on its own, no rule involved: one short message when an item opens (GET /v1/attention). Empty when it receives none.
@@ -4570,6 +4908,9 @@ type Channel = ({
4570
4908
  kind: 'telegram';
4571
4909
  } & TelegramChannel);
4572
4910
  type CreateSlackChannel = {
4911
+ /**
4912
+ * Channel kind.
4913
+ */
4573
4914
  kind: 'slack';
4574
4915
  /**
4575
4916
  * A Slack channel id from the connected workspace.
@@ -4585,6 +4926,9 @@ type CreateSlackChannel = {
4585
4926
  events?: Array<'mention.spike' | 'sentiment.negative_spike' | 'keyword.noisy' | 'channel.failing' | 'feed.failing' | 'feed.recovered'>;
4586
4927
  };
4587
4928
  type CreateEmailChannel = {
4929
+ /**
4930
+ * Channel kind.
4931
+ */
4588
4932
  kind: 'email';
4589
4933
  /**
4590
4934
  * Each address gets a confirmation link; workspace members are confirmed on sight.
@@ -4596,6 +4940,9 @@ type CreateEmailChannel = {
4596
4940
  events?: Array<'mention.spike' | 'sentiment.negative_spike' | 'keyword.noisy' | 'channel.failing' | 'feed.failing' | 'feed.recovered'>;
4597
4941
  };
4598
4942
  type CreateWebhookChannel = {
4943
+ /**
4944
+ * Channel kind.
4945
+ */
4599
4946
  kind: 'webhook';
4600
4947
  /**
4601
4948
  * Where the signed POSTs go. https in production.
@@ -4627,6 +4974,9 @@ type GetHealthResponses = {
4627
4974
  * API is up
4628
4975
  */
4629
4976
  200: {
4977
+ /**
4978
+ * Always true when the API answers.
4979
+ */
4630
4980
  ok: boolean;
4631
4981
  };
4632
4982
  };
@@ -4726,12 +5076,21 @@ type ListKeywordsResponses = {
4726
5076
  * The matching keywords and how many there are
4727
5077
  */
4728
5078
  200: {
5079
+ /**
5080
+ * The keywords.
5081
+ */
4729
5082
  data: Array<{
4730
5083
  /**
4731
5084
  * Keyword id (kw_...).
4732
5085
  */
4733
5086
  id: string;
5087
+ /**
5088
+ * The tracked text, as typed.
5089
+ */
4734
5090
  term: string;
5091
+ /**
5092
+ * brand (your own name), competitor, or topic.
5093
+ */
4735
5094
  kind: 'brand' | 'competitor' | 'topic';
4736
5095
  /**
4737
5096
  * Not polled or matched. Paused by you, by the wallet (see pausedForBalance) or by the noise brake (see pausedForNoise). A keyword at its mention cap is not muted (see pausedForCap).
@@ -5240,6 +5599,10 @@ type CreateKeywordData = {
5240
5599
  url: '/v1/keywords';
5241
5600
  };
5242
5601
  type CreateKeywordErrors = {
5602
+ /**
5603
+ * Invalid request: a parameter or the body failed validation (validation_error)
5604
+ */
5605
+ 400: ErrorResponse;
5243
5606
  /**
5244
5607
  * Missing or invalid API key
5245
5608
  */
@@ -5522,6 +5885,10 @@ type UpdateKeywordData = {
5522
5885
  url: '/v1/keywords/{id}';
5523
5886
  };
5524
5887
  type UpdateKeywordErrors = {
5888
+ /**
5889
+ * Invalid request: a parameter or the body failed validation (validation_error)
5890
+ */
5891
+ 400: ErrorResponse;
5525
5892
  /**
5526
5893
  * Missing or invalid API key
5527
5894
  */
@@ -5624,6 +5991,10 @@ type DuplicateKeywordData = {
5624
5991
  url: '/v1/keywords/{id}/duplicate';
5625
5992
  };
5626
5993
  type DuplicateKeywordErrors = {
5994
+ /**
5995
+ * Invalid request: a parameter or the body failed validation (validation_error)
5996
+ */
5997
+ 400: ErrorResponse;
5627
5998
  /**
5628
5999
  * Missing or invalid API key
5629
6000
  */
@@ -5669,6 +6040,10 @@ type ListFeedsData = {
5669
6040
  url: '/v1/feeds';
5670
6041
  };
5671
6042
  type ListFeedsErrors = {
6043
+ /**
6044
+ * Invalid request: a parameter or the body failed validation (validation_error)
6045
+ */
6046
+ 400: ErrorResponse;
5672
6047
  /**
5673
6048
  * Missing or invalid API key
5674
6049
  */
@@ -5865,13 +6240,23 @@ type ImportFeedsData = {
5865
6240
  };
5866
6241
  }>;
5867
6242
  };
6243
+ headers?: {
6244
+ /**
6245
+ * A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
6246
+ */
6247
+ 'idempotency-key'?: string;
6248
+ };
5868
6249
  path?: never;
5869
6250
  query?: never;
5870
6251
  url: '/v1/feeds/import';
5871
6252
  };
5872
6253
  type ImportFeedsErrors = {
5873
6254
  /**
5874
- * Missing or invalid API key
6255
+ * Invalid request: a parameter or the body failed validation (validation_error)
6256
+ */
6257
+ 400: ErrorResponse;
6258
+ /**
6259
+ * Missing or invalid API key
5875
6260
  */
5876
6261
  401: ErrorResponse;
5877
6262
  /**
@@ -6398,6 +6783,10 @@ type SearchMentionsData = {
6398
6783
  * Only matches of keywords of any of these kinds: brand, competitor, topic. Repeatable, or comma-separated.
6399
6784
  */
6400
6785
  keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
6786
+ /**
6787
+ * Never matches of keywords of these kinds. Repeatable, or comma-separated.
6788
+ */
6789
+ notKeywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
6401
6790
  /**
6402
6791
  * Only authors tagged with any of these (exact, case-sensitive), in the workspace's tags or those of the mention's own keyword group. Repeatable, or comma-separated.
6403
6792
  */
@@ -6577,6 +6966,9 @@ type SearchMentionsResponses = {
6577
6966
  * One page of mentions in the requested order
6578
6967
  */
6579
6968
  200: {
6969
+ /**
6970
+ * The page of mentions.
6971
+ */
6580
6972
  data: Array<Mention>;
6581
6973
  /**
6582
6974
  * Pass as cursor for the next page; null on the last page.
@@ -6699,6 +7091,10 @@ type ExportMentionsCsvData = {
6699
7091
  * Only matches of keywords of any of these kinds: brand, competitor, topic. Repeatable, or comma-separated.
6700
7092
  */
6701
7093
  keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
7094
+ /**
7095
+ * Never matches of keywords of these kinds. Repeatable, or comma-separated.
7096
+ */
7097
+ notKeywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
6702
7098
  /**
6703
7099
  * Only authors tagged with any of these (exact, case-sensitive), in the workspace's tags or those of the mention's own keyword group. Repeatable, or comma-separated.
6704
7100
  */
@@ -6912,6 +7308,9 @@ type ListMentionCommentsResponses = {
6912
7308
  * One page of the thread, newest first
6913
7309
  */
6914
7310
  200: {
7311
+ /**
7312
+ * The page of comments, newest first.
7313
+ */
6915
7314
  data: Array<MentionComment>;
6916
7315
  /**
6917
7316
  * Pass as cursor for the next page; null on the last page.
@@ -7034,6 +7433,10 @@ type ExportMentionsJsonData = {
7034
7433
  * Only matches of keywords of any of these kinds: brand, competitor, topic. Repeatable, or comma-separated.
7035
7434
  */
7036
7435
  keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
7436
+ /**
7437
+ * Never matches of keywords of these kinds. Repeatable, or comma-separated.
7438
+ */
7439
+ notKeywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
7037
7440
  /**
7038
7441
  * Only authors tagged with any of these (exact, case-sensitive), in the workspace's tags or those of the mention's own keyword group. Repeatable, or comma-separated.
7039
7442
  */
@@ -7334,6 +7737,18 @@ type ExportPeopleCsvData = {
7334
7737
  * People at any of these outreach stages. Repeatable, or comma-separated.
7335
7738
  */
7336
7739
  stages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
7740
+ /**
7741
+ * Nobody at these outreach stages. Repeatable, or comma-separated.
7742
+ */
7743
+ notStages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
7744
+ /**
7745
+ * Nobody with a mention linking to any of these hosts, the host itself or a subdomain of it. Repeatable, or comma-separated.
7746
+ */
7747
+ notLinkHosts?: Array<string> | null;
7748
+ /**
7749
+ * Nobody owned by these members (user ids); `none` drops the people nobody owns. Repeatable, or comma-separated.
7750
+ */
7751
+ notOwnerIds?: Array<string> | null;
7337
7752
  /**
7338
7753
  * true: only people whose matched posts are mostly machine-made (bot accounts); false: only the rest; omitted: everyone.
7339
7754
  */
@@ -7493,6 +7908,18 @@ type ListPeopleData = {
7493
7908
  * People at any of these outreach stages. Repeatable, or comma-separated.
7494
7909
  */
7495
7910
  stages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
7911
+ /**
7912
+ * Nobody at these outreach stages. Repeatable, or comma-separated.
7913
+ */
7914
+ notStages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
7915
+ /**
7916
+ * Nobody with a mention linking to any of these hosts, the host itself or a subdomain of it. Repeatable, or comma-separated.
7917
+ */
7918
+ notLinkHosts?: Array<string> | null;
7919
+ /**
7920
+ * Nobody owned by these members (user ids); `none` drops the people nobody owns. Repeatable, or comma-separated.
7921
+ */
7922
+ notOwnerIds?: Array<string> | null;
7496
7923
  /**
7497
7924
  * true: only people whose matched posts are mostly machine-made (bot accounts); false: only the rest; omitted: everyone.
7498
7925
  */
@@ -7536,6 +7963,9 @@ type ListPeopleResponses = {
7536
7963
  * One page of people
7537
7964
  */
7538
7965
  200: {
7966
+ /**
7967
+ * The page of people.
7968
+ */
7539
7969
  data: Array<{
7540
7970
  /**
7541
7971
  * Person id (aut_...): the canonical account. An account merged into someone resolves to that person.
@@ -7557,6 +7987,9 @@ type ListPeopleResponses = {
7557
7987
  * Profile URL of the canonical account.
7558
7988
  */
7559
7989
  url: string | null;
7990
+ /**
7991
+ * Profile picture URL.
7992
+ */
7560
7993
  avatarUrl: string | null;
7561
7994
  /**
7562
7995
  * Every account this workspace treats as this person, the canonical one first.
@@ -7587,17 +8020,38 @@ type ListPeopleResponses = {
7587
8020
  * Platform counts as of their newest post; null where the platform has no such number.
7588
8021
  */
7589
8022
  reach: {
8023
+ /**
8024
+ * Followers when last seen; null when unknown.
8025
+ */
7590
8026
  followers: number | null;
8027
+ /**
8028
+ * Accounts they follow; null when unknown.
8029
+ */
7591
8030
  following: number | null;
8031
+ /**
8032
+ * Posts on the platform; null when unknown.
8033
+ */
7592
8034
  posts: number | null;
7593
8035
  };
7594
8036
  /**
7595
8037
  * Public profile facts; null until looked up.
7596
8038
  */
7597
8039
  profile: {
8040
+ /**
8041
+ * The profile's bio, as the platform shows it.
8042
+ */
7598
8043
  bio: string | null;
8044
+ /**
8045
+ * Company named on the profile.
8046
+ */
7599
8047
  company: string | null;
8048
+ /**
8049
+ * Location named on the profile.
8050
+ */
7600
8051
  location: string | null;
8052
+ /**
8053
+ * Website linked from the profile.
8054
+ */
7601
8055
  website: string | null;
7602
8056
  /**
7603
8057
  * Only when the person made it public on the platform.
@@ -7607,7 +8061,13 @@ type ListPeopleResponses = {
7607
8061
  * Other accounts the person lists on their profile.
7608
8062
  */
7609
8063
  links: Array<{
8064
+ /**
8065
+ * The platform or kind of the linked account (github, x, website, ...).
8066
+ */
7610
8067
  provider: string;
8068
+ /**
8069
+ * Link to the account.
8070
+ */
7611
8071
  url: string;
7612
8072
  }>;
7613
8073
  /**
@@ -7627,9 +8087,21 @@ type ListPeopleResponses = {
7627
8087
  * Of those, scored relevant.
7628
8088
  */
7629
8089
  relevant: number;
8090
+ /**
8091
+ * Their matched mentions by sentiment.
8092
+ */
7630
8093
  sentiment: {
8094
+ /**
8095
+ * Scored positive.
8096
+ */
7631
8097
  positive: number;
8098
+ /**
8099
+ * Scored neutral.
8100
+ */
7632
8101
  neutral: number;
8102
+ /**
8103
+ * Scored negative.
8104
+ */
7633
8105
  negative: number;
7634
8106
  };
7635
8107
  /**
@@ -7645,7 +8117,13 @@ type ListPeopleResponses = {
7645
8117
  * What this workspace wrote about the person.
7646
8118
  */
7647
8119
  annotations: {
8120
+ /**
8121
+ * Tags your team gave them.
8122
+ */
7648
8123
  tags: Array<string>;
8124
+ /**
8125
+ * Your team's notes.
8126
+ */
7649
8127
  notes: string;
7650
8128
  /**
7651
8129
  * Their posts stay out of the feed and every channel; ingest and billing are untouched. Read with groupId it is that group's own mute, which hides them from the mentions of that group's keywords only.
@@ -7664,7 +8142,13 @@ type ListPeopleResponses = {
7664
8142
  * User id of the workspace member.
7665
8143
  */
7666
8144
  id: string;
8145
+ /**
8146
+ * The member's name.
8147
+ */
7667
8148
  name: string | null;
8149
+ /**
8150
+ * The member's email.
8151
+ */
7668
8152
  email: string | null;
7669
8153
  } | null;
7670
8154
  /**
@@ -7701,6 +8185,10 @@ type GetPersonData = {
7701
8185
  url: '/v1/people/{id}';
7702
8186
  };
7703
8187
  type GetPersonErrors = {
8188
+ /**
8189
+ * Invalid request: a parameter or the body failed validation (validation_error)
8190
+ */
8191
+ 400: ErrorResponse;
7704
8192
  /**
7705
8193
  * Missing or invalid API key
7706
8194
  */
@@ -7727,6 +8215,9 @@ type UpdatePersonData = {
7727
8215
  * Replaces the whole list.
7728
8216
  */
7729
8217
  tags?: Array<string>;
8218
+ /**
8219
+ * Notes, up to 2,000 characters; replaces the current notes.
8220
+ */
7730
8221
  notes?: string;
7731
8222
  /**
7732
8223
  * true hides their posts from the feed, alerts and digests; false shows them again. Without groupId for the whole workspace; with it, for that group's keywords only.
@@ -7784,6 +8275,12 @@ type MergePeopleData = {
7784
8275
  */
7785
8276
  into: string;
7786
8277
  };
8278
+ headers?: {
8279
+ /**
8280
+ * A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
8281
+ */
8282
+ 'idempotency-key'?: string;
8283
+ };
7787
8284
  path: {
7788
8285
  /**
7789
8286
  * Person id (aut_...).
@@ -7799,6 +8296,10 @@ type MergePeopleData = {
7799
8296
  url: '/v1/people/{id}/merge';
7800
8297
  };
7801
8298
  type MergePeopleErrors = {
8299
+ /**
8300
+ * Invalid request: a parameter or the body failed validation (validation_error)
8301
+ */
8302
+ 400: ErrorResponse;
7802
8303
  /**
7803
8304
  * Missing or invalid API key
7804
8305
  */
@@ -7818,6 +8319,12 @@ type MergePeopleResponses = {
7818
8319
  type MergePeopleResponse = MergePeopleResponses[keyof MergePeopleResponses];
7819
8320
  type SplitPersonData = {
7820
8321
  body?: never;
8322
+ headers?: {
8323
+ /**
8324
+ * A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
8325
+ */
8326
+ 'idempotency-key'?: string;
8327
+ };
7821
8328
  path: {
7822
8329
  /**
7823
8330
  * Person id (aut_...).
@@ -7833,6 +8340,10 @@ type SplitPersonData = {
7833
8340
  url: '/v1/people/{id}/split';
7834
8341
  };
7835
8342
  type SplitPersonErrors = {
8343
+ /**
8344
+ * Invalid request: a parameter or the body failed validation (validation_error)
8345
+ */
8346
+ 400: ErrorResponse;
7836
8347
  /**
7837
8348
  * Missing or invalid API key
7838
8349
  */
@@ -7867,6 +8378,10 @@ type ListPersonActivitiesData = {
7867
8378
  url: '/v1/people/{id}/activities';
7868
8379
  };
7869
8380
  type ListPersonActivitiesErrors = {
8381
+ /**
8382
+ * Invalid request: a parameter or the body failed validation (validation_error)
8383
+ */
8384
+ 400: ErrorResponse;
7870
8385
  /**
7871
8386
  * Missing or invalid API key
7872
8387
  */
@@ -7910,7 +8425,13 @@ type ListPersonActivitiesResponses = {
7910
8425
  * User id of the workspace member.
7911
8426
  */
7912
8427
  id: string;
8428
+ /**
8429
+ * The member's name.
8430
+ */
7913
8431
  name: string | null;
8432
+ /**
8433
+ * The member's email.
8434
+ */
7914
8435
  email: string | null;
7915
8436
  } | null;
7916
8437
  /**
@@ -8007,6 +8528,10 @@ type DeletePersonActivityData = {
8007
8528
  url: '/v1/people/{id}/activities/{activityId}';
8008
8529
  };
8009
8530
  type DeletePersonActivityErrors = {
8531
+ /**
8532
+ * Invalid request: a parameter or the body failed validation (validation_error)
8533
+ */
8534
+ 400: ErrorResponse;
8010
8535
  /**
8011
8536
  * Missing or invalid API key
8012
8537
  */
@@ -8061,6 +8586,10 @@ type ListSegmentsData = {
8061
8586
  url: '/v1/segments';
8062
8587
  };
8063
8588
  type ListSegmentsErrors = {
8589
+ /**
8590
+ * Invalid request: a parameter or the body failed validation (validation_error)
8591
+ */
8592
+ 400: ErrorResponse;
8064
8593
  /**
8065
8594
  * Missing or invalid API key
8066
8595
  */
@@ -8076,13 +8605,25 @@ type ListSegmentsResponses = {
8076
8605
  * Every segment
8077
8606
  */
8078
8607
  200: {
8608
+ /**
8609
+ * The segments.
8610
+ */
8079
8611
  data: Array<{
8080
8612
  /**
8081
8613
  * Segment id (seg_...).
8082
8614
  */
8083
8615
  id: string;
8616
+ /**
8617
+ * Segment name.
8618
+ */
8084
8619
  name: string;
8620
+ /**
8621
+ * What the segment is for.
8622
+ */
8085
8623
  description: string;
8624
+ /**
8625
+ * The people filter it saves (the fields of GET /v1/people).
8626
+ */
8086
8627
  filter: {
8087
8628
  /**
8088
8629
  * People with an account on any of these platforms.
@@ -8148,6 +8689,18 @@ type ListSegmentsResponses = {
8148
8689
  * People at any of these outreach stages.
8149
8690
  */
8150
8691
  stages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
8692
+ /**
8693
+ * Nobody at these outreach stages.
8694
+ */
8695
+ notStages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
8696
+ /**
8697
+ * Nobody with a mention linking to any of these hosts, the host itself or a subdomain of it.
8698
+ */
8699
+ notLinkHosts?: Array<string>;
8700
+ /**
8701
+ * Nobody owned by these members (user ids); "none" drops the people nobody owns.
8702
+ */
8703
+ notOwnerIds?: Array<string>;
8151
8704
  /**
8152
8705
  * true: only people whose matched posts are mostly machine-made (bot accounts); false: only the rest.
8153
8706
  */
@@ -8185,8 +8738,17 @@ type ListSegmentsResponses = {
8185
8738
  type ListSegmentsResponse = ListSegmentsResponses[keyof ListSegmentsResponses];
8186
8739
  type CreateSegmentData = {
8187
8740
  body: {
8741
+ /**
8742
+ * Segment name, unique in its scope.
8743
+ */
8188
8744
  name: string;
8745
+ /**
8746
+ * What the segment is for.
8747
+ */
8189
8748
  description?: string;
8749
+ /**
8750
+ * The people filter (the fields of GET /v1/people).
8751
+ */
8190
8752
  filter?: {
8191
8753
  /**
8192
8754
  * People with an account on any of these platforms.
@@ -8252,6 +8814,18 @@ type CreateSegmentData = {
8252
8814
  * People at any of these outreach stages.
8253
8815
  */
8254
8816
  stages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
8817
+ /**
8818
+ * Nobody at these outreach stages.
8819
+ */
8820
+ notStages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
8821
+ /**
8822
+ * Nobody with a mention linking to any of these hosts, the host itself or a subdomain of it.
8823
+ */
8824
+ notLinkHosts?: Array<string>;
8825
+ /**
8826
+ * Nobody owned by these members (user ids); "none" drops the people nobody owns.
8827
+ */
8828
+ notOwnerIds?: Array<string>;
8255
8829
  /**
8256
8830
  * true: only people whose matched posts are mostly machine-made (bot accounts); false: only the rest.
8257
8831
  */
@@ -8320,6 +8894,10 @@ type DeleteSegmentData = {
8320
8894
  url: '/v1/segments/{id}';
8321
8895
  };
8322
8896
  type DeleteSegmentErrors = {
8897
+ /**
8898
+ * Invalid request: a parameter or the body failed validation (validation_error)
8899
+ */
8900
+ 400: ErrorResponse;
8323
8901
  /**
8324
8902
  * Missing or invalid API key
8325
8903
  */
@@ -8354,6 +8932,10 @@ type GetSegmentData = {
8354
8932
  url: '/v1/segments/{id}';
8355
8933
  };
8356
8934
  type GetSegmentErrors = {
8935
+ /**
8936
+ * Invalid request: a parameter or the body failed validation (validation_error)
8937
+ */
8938
+ 400: ErrorResponse;
8357
8939
  /**
8358
8940
  * Missing or invalid API key
8359
8941
  */
@@ -8376,7 +8958,13 @@ type UpdateSegmentData = {
8376
8958
  * Omitted fields are untouched.
8377
8959
  */
8378
8960
  body: {
8961
+ /**
8962
+ * Segment name, unique in its scope.
8963
+ */
8379
8964
  name?: string;
8965
+ /**
8966
+ * What the segment is for.
8967
+ */
8380
8968
  description?: string;
8381
8969
  /**
8382
8970
  * Replaces the whole filter.
@@ -8446,6 +9034,18 @@ type UpdateSegmentData = {
8446
9034
  * People at any of these outreach stages.
8447
9035
  */
8448
9036
  stages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
9037
+ /**
9038
+ * Nobody at these outreach stages.
9039
+ */
9040
+ notStages?: Array<'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'>;
9041
+ /**
9042
+ * Nobody with a mention linking to any of these hosts, the host itself or a subdomain of it.
9043
+ */
9044
+ notLinkHosts?: Array<string>;
9045
+ /**
9046
+ * Nobody owned by these members (user ids); "none" drops the people nobody owns.
9047
+ */
9048
+ notOwnerIds?: Array<string>;
8449
9049
  /**
8450
9050
  * true: only people whose matched posts are mostly machine-made (bot accounts); false: only the rest.
8451
9051
  */
@@ -8471,6 +9071,10 @@ type UpdateSegmentData = {
8471
9071
  url: '/v1/segments/{id}';
8472
9072
  };
8473
9073
  type UpdateSegmentErrors = {
9074
+ /**
9075
+ * Invalid request: a parameter or the body failed validation (validation_error)
9076
+ */
9077
+ 400: ErrorResponse;
8474
9078
  /**
8475
9079
  * Missing or invalid API key
8476
9080
  */
@@ -8518,8 +9122,17 @@ type ListViewsResponses = {
8518
9122
  * View id (vw_...).
8519
9123
  */
8520
9124
  id: string;
9125
+ /**
9126
+ * View name.
9127
+ */
8521
9128
  name: string;
9129
+ /**
9130
+ * What the view is for.
9131
+ */
8522
9132
  description: string;
9133
+ /**
9134
+ * The mentions filter it saves (the fields of GET /v1/mentions).
9135
+ */
8523
9136
  filter: {
8524
9137
  /**
8525
9138
  * Substring in the post text or the author's name.
@@ -8537,6 +9150,10 @@ type ListViewsResponses = {
8537
9150
  * Only matches of keywords of any of these kinds: brand, competitor, topic.
8538
9151
  */
8539
9152
  keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
9153
+ /**
9154
+ * Never matches of keywords of these kinds.
9155
+ */
9156
+ notKeywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
8540
9157
  /**
8541
9158
  * Only matches of keywords in any of these groups (grp_...).
8542
9159
  */
@@ -8736,6 +9353,10 @@ type CreateViewData = {
8736
9353
  * Only matches of keywords of any of these kinds: brand, competitor, topic.
8737
9354
  */
8738
9355
  keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
9356
+ /**
9357
+ * Never matches of keywords of these kinds.
9358
+ */
9359
+ notKeywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
8739
9360
  /**
8740
9361
  * Only matches of keywords in any of these groups (grp_...).
8741
9362
  */
@@ -8986,7 +9607,13 @@ type GetViewResponses = {
8986
9607
  type GetViewResponse = GetViewResponses[keyof GetViewResponses];
8987
9608
  type UpdateViewData = {
8988
9609
  body: {
9610
+ /**
9611
+ * View name, unique in the workspace.
9612
+ */
8989
9613
  name?: string;
9614
+ /**
9615
+ * What the view is for.
9616
+ */
8990
9617
  description?: string;
8991
9618
  /**
8992
9619
  * Replaces the whole filter.
@@ -9008,6 +9635,10 @@ type UpdateViewData = {
9008
9635
  * Only matches of keywords of any of these kinds: brand, competitor, topic.
9009
9636
  */
9010
9637
  keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
9638
+ /**
9639
+ * Never matches of keywords of these kinds.
9640
+ */
9641
+ notKeywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
9011
9642
  /**
9012
9643
  * Only matches of keywords in any of these groups (grp_...).
9013
9644
  */
@@ -9176,6 +9807,10 @@ type UpdateViewData = {
9176
9807
  url: '/v1/views/{id}';
9177
9808
  };
9178
9809
  type UpdateViewErrors = {
9810
+ /**
9811
+ * Invalid request: a parameter or the body failed validation (validation_error)
9812
+ */
9813
+ 400: ErrorResponse;
9179
9814
  /**
9180
9815
  * Missing or invalid API key
9181
9816
  */
@@ -9236,6 +9871,9 @@ type ListAttentionResponses = {
9236
9871
  * Attention items
9237
9872
  */
9238
9873
  200: {
9874
+ /**
9875
+ * The attention items.
9876
+ */
9239
9877
  data: Array<AttentionItem>;
9240
9878
  /**
9241
9879
  * Pass as cursor for the next page; null on the last one.
@@ -9246,6 +9884,12 @@ type ListAttentionResponses = {
9246
9884
  type ListAttentionResponse = ListAttentionResponses[keyof ListAttentionResponses];
9247
9885
  type DismissAttentionData = {
9248
9886
  body?: never;
9887
+ headers?: {
9888
+ /**
9889
+ * A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
9890
+ */
9891
+ 'idempotency-key'?: string;
9892
+ };
9249
9893
  path: {
9250
9894
  /**
9251
9895
  * Attention item id (att_...).
@@ -9285,6 +9929,10 @@ type ListGroupsData = {
9285
9929
  url: '/v1/groups';
9286
9930
  };
9287
9931
  type ListGroupsErrors = {
9932
+ /**
9933
+ * Invalid request: a parameter or the body failed validation (validation_error)
9934
+ */
9935
+ 400: ErrorResponse;
9288
9936
  /**
9289
9937
  * Missing or invalid API key
9290
9938
  */
@@ -9355,6 +10003,10 @@ type CreateGroupData = {
9355
10003
  url: '/v1/groups';
9356
10004
  };
9357
10005
  type CreateGroupErrors = {
10006
+ /**
10007
+ * Invalid request: a parameter or the body failed validation (validation_error)
10008
+ */
10009
+ 400: ErrorResponse;
9358
10010
  /**
9359
10011
  * Missing or invalid API key
9360
10012
  */
@@ -9516,7 +10168,13 @@ type UpdateCompanyData = {
9516
10168
  * Omitted fields are untouched.
9517
10169
  */
9518
10170
  body: {
10171
+ /**
10172
+ * Company name.
10173
+ */
9519
10174
  name?: string;
10175
+ /**
10176
+ * What the company does; the classifier reads it.
10177
+ */
9520
10178
  description?: string;
9521
10179
  /**
9522
10180
  * Replaces the whole list.
@@ -9548,6 +10206,10 @@ type UpdateCompanyData = {
9548
10206
  url: '/v1/company';
9549
10207
  };
9550
10208
  type UpdateCompanyErrors = {
10209
+ /**
10210
+ * Invalid request: a parameter or the body failed validation (validation_error)
10211
+ */
10212
+ 400: ErrorResponse;
9551
10213
  /**
9552
10214
  * Missing or invalid API key
9553
10215
  */
@@ -9583,11 +10245,17 @@ type ListApiKeysResponses = {
9583
10245
  * Every key, newest first, without the secret part
9584
10246
  */
9585
10247
  200: {
10248
+ /**
10249
+ * Every API key of the workspace; the secret is never shown again.
10250
+ */
9586
10251
  data: Array<{
9587
10252
  /**
9588
10253
  * Key id (key_...).
9589
10254
  */
9590
10255
  id: string;
10256
+ /**
10257
+ * Your name for the key.
10258
+ */
9591
10259
  name: string;
9592
10260
  /**
9593
10261
  * The first characters of the key, to tell keys apart.
@@ -9658,6 +10326,9 @@ type CreateApiKeyResponses = {
9658
10326
  * Key id (key_...).
9659
10327
  */
9660
10328
  id: string;
10329
+ /**
10330
+ * Your name for the key.
10331
+ */
9661
10332
  name: string;
9662
10333
  /**
9663
10334
  * The first characters of the key, to tell keys apart.
@@ -9753,6 +10424,9 @@ type ListMembersResponses = {
9753
10424
  * The members
9754
10425
  */
9755
10426
  200: {
10427
+ /**
10428
+ * The members.
10429
+ */
9756
10430
  data: Array<Member>;
9757
10431
  };
9758
10432
  };
@@ -9775,6 +10449,9 @@ type ListInvitationsResponses = {
9775
10449
  * The open invitations
9776
10450
  */
9777
10451
  200: {
10452
+ /**
10453
+ * The open invitations.
10454
+ */
9778
10455
  data: Array<Invitation>;
9779
10456
  };
9780
10457
  };
@@ -9801,6 +10478,10 @@ type CreateInvitationData = {
9801
10478
  url: '/v1/members/invitations';
9802
10479
  };
9803
10480
  type CreateInvitationErrors = {
10481
+ /**
10482
+ * Invalid request: a parameter or the body failed validation (validation_error)
10483
+ */
10484
+ 400: ErrorResponse;
9804
10485
  /**
9805
10486
  * Missing or invalid API key
9806
10487
  */
@@ -9952,6 +10633,18 @@ type GetUsageBreakdownData = {
9952
10633
  * Only these platforms. A keyword-day belongs to no platform, so with this filter the keyword line reads 0 and only mentions and comments count. Repeatable, or comma-separated.
9953
10634
  */
9954
10635
  platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
10636
+ /**
10637
+ * Never these keywords (kw_...). Repeatable, or comma-separated.
10638
+ */
10639
+ notKeywordIds?: Array<string> | null;
10640
+ /**
10641
+ * Never keywords of these groups (grp_...). Repeatable, or comma-separated.
10642
+ */
10643
+ notGroupIds?: Array<string> | null;
10644
+ /**
10645
+ * Never mentions or comments from these platforms; keyword-days, which belong to no platform, still count. Repeatable, or comma-separated.
10646
+ */
10647
+ notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
9955
10648
  /**
9956
10649
  * Rows per page, 1 to 500 (default 100). Only by=keyword can outgrow a page; a window has at most 90 days and a dozen platforms.
9957
10650
  */
@@ -10215,7 +10908,13 @@ type UpdateAlertData = {
10215
10908
  * Omitted fields are untouched.
10216
10909
  */
10217
10910
  body: {
10911
+ /**
10912
+ * Rule name.
10913
+ */
10218
10914
  name?: string;
10915
+ /**
10916
+ * false: the rule sends nothing.
10917
+ */
10219
10918
  enabled?: boolean;
10220
10919
  mode?: 'instant' | 'hourly' | 'daily' | 'weekly';
10221
10920
  /**
@@ -10327,9 +11026,21 @@ type UpdateAlertData = {
10327
11026
  * Daily and weekly alerts. Ignored on an hourly one, except a weekday, which is refused.
10328
11027
  */
10329
11028
  schedule?: {
11029
+ /**
11030
+ * Hour of the day to send, 0 to 23, in timezone.
11031
+ */
10330
11032
  hour: number;
11033
+ /**
11034
+ * Minute past the hour, 0 to 59.
11035
+ */
10331
11036
  minute?: number;
11037
+ /**
11038
+ * IANA zone the schedule runs in (Europe/Madrid).
11039
+ */
10332
11040
  timezone: string;
11041
+ /**
11042
+ * true: send nothing when the window had no mention.
11043
+ */
10333
11044
  skipEmpty?: boolean;
10334
11045
  /**
10335
11046
  * Weekly rules: the day it sends, 0 Sunday to 6 Saturday. Required for mode weekly; ignored on daily rules.
@@ -10391,12 +11102,21 @@ type ListAlertsResponses = {
10391
11102
  * Every alert rule of the org, newest first
10392
11103
  */
10393
11104
  200: {
11105
+ /**
11106
+ * Every alert rule of the workspace.
11107
+ */
10394
11108
  data: Array<{
10395
11109
  /**
10396
11110
  * Alert id (feed_...).
10397
11111
  */
10398
11112
  id: string;
11113
+ /**
11114
+ * Rule name.
11115
+ */
10399
11116
  name: string;
11117
+ /**
11118
+ * false: the rule sends nothing.
11119
+ */
10400
11120
  enabled: boolean;
10401
11121
  /**
10402
11122
  * When it sends; see [Alerts](/alerts).
@@ -10407,6 +11127,9 @@ type ListAlertsResponses = {
10407
11127
  * - weekly: one digest a week, on schedule.weekday.
10408
11128
  */
10409
11129
  mode: 'instant' | 'hourly' | 'daily' | 'weekly';
11130
+ /**
11131
+ * Which mentions the rule sends.
11132
+ */
10410
11133
  filter: {
10411
11134
  /**
10412
11135
  * Only these keywords.
@@ -10513,9 +11236,21 @@ type ListAlertsResponses = {
10513
11236
  * Daily and weekly alerts only; null for instant and hourly ones.
10514
11237
  */
10515
11238
  schedule: {
11239
+ /**
11240
+ * Hour of the day to send, 0 to 23, in timezone.
11241
+ */
10516
11242
  hour: number;
11243
+ /**
11244
+ * Minute past the hour, 0 to 59.
11245
+ */
10517
11246
  minute?: number;
11247
+ /**
11248
+ * IANA zone the schedule runs in (Europe/Madrid).
11249
+ */
10518
11250
  timezone: string;
11251
+ /**
11252
+ * true: send nothing when the window had no mention.
11253
+ */
10519
11254
  skipEmpty?: boolean;
10520
11255
  /**
10521
11256
  * Weekly rules: the day it sends, 0 Sunday to 6 Saturday. Required for mode weekly; ignored on daily rules.
@@ -10530,8 +11265,17 @@ type ListAlertsResponses = {
10530
11265
  * Where it sends.
10531
11266
  */
10532
11267
  channels: Array<{
11268
+ /**
11269
+ * Channel id (dest_...).
11270
+ */
10533
11271
  id: string;
11272
+ /**
11273
+ * Channel kind.
11274
+ */
10534
11275
  kind: 'slack' | 'email' | 'webhook' | 'telegram';
11276
+ /**
11277
+ * Channel name.
11278
+ */
10535
11279
  label: string;
10536
11280
  }>;
10537
11281
  /**
@@ -10561,9 +11305,18 @@ type ListAlertsResponses = {
10561
11305
  type ListAlertsResponse = ListAlertsResponses[keyof ListAlertsResponses];
10562
11306
  type CreateAlertData = {
10563
11307
  body: {
11308
+ /**
11309
+ * Rule name.
11310
+ */
10564
11311
  name: string;
11312
+ /**
11313
+ * false: the rule sends nothing. Default true.
11314
+ */
10565
11315
  enabled?: boolean;
10566
11316
  mode?: 'instant' | 'hourly' | 'daily' | 'weekly';
11317
+ /**
11318
+ * Which mentions the rule sends. Default: every relevant mention.
11319
+ */
10567
11320
  filter?: {
10568
11321
  /**
10569
11322
  * Only these keywords.
@@ -10670,9 +11423,21 @@ type CreateAlertData = {
10670
11423
  * Required for daily and weekly alerts (weekly ones also need schedule.weekday). Hourly alerts take none: they send every UTC hour, so a time of day and a zone are ignored and a weekday is refused.
10671
11424
  */
10672
11425
  schedule?: {
11426
+ /**
11427
+ * Hour of the day to send, 0 to 23, in timezone.
11428
+ */
10673
11429
  hour: number;
11430
+ /**
11431
+ * Minute past the hour, 0 to 59.
11432
+ */
10674
11433
  minute?: number;
11434
+ /**
11435
+ * IANA zone the schedule runs in (Europe/Madrid).
11436
+ */
10675
11437
  timezone: string;
11438
+ /**
11439
+ * true: send nothing when the window had no mention.
11440
+ */
10676
11441
  skipEmpty?: boolean;
10677
11442
  /**
10678
11443
  * Weekly rules: the day it sends, 0 Sunday to 6 Saturday. Required for mode weekly; ignored on daily rules.
@@ -10718,6 +11483,12 @@ type CreateAlertResponses = {
10718
11483
  type CreateAlertResponse = CreateAlertResponses[keyof CreateAlertResponses];
10719
11484
  type TestAlertData = {
10720
11485
  body?: never;
11486
+ headers?: {
11487
+ /**
11488
+ * A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
11489
+ */
11490
+ 'idempotency-key'?: string;
11491
+ };
10721
11492
  path: {
10722
11493
  /**
10723
11494
  * Alert id (feed_...).
@@ -10743,9 +11514,21 @@ type TestAlertResponses = {
10743
11514
  * A test message was attempted on every channel of the rule
10744
11515
  */
10745
11516
  200: {
11517
+ /**
11518
+ * One result per channel of the rule.
11519
+ */
10746
11520
  outcomes: Array<{
11521
+ /**
11522
+ * The channel (dest_...).
11523
+ */
10747
11524
  channelId: string;
11525
+ /**
11526
+ * Whether the channel accepted it.
11527
+ */
10748
11528
  ok: boolean;
11529
+ /**
11530
+ * Why it failed; null when it did not.
11531
+ */
10749
11532
  error: string | null;
10750
11533
  }>;
10751
11534
  };
@@ -10753,6 +11536,12 @@ type TestAlertResponses = {
10753
11536
  type TestAlertResponse = TestAlertResponses[keyof TestAlertResponses];
10754
11537
  type RunAlertDigestData = {
10755
11538
  body?: never;
11539
+ headers?: {
11540
+ /**
11541
+ * A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
11542
+ */
11543
+ 'idempotency-key'?: string;
11544
+ };
10756
11545
  path: {
10757
11546
  /**
10758
11547
  * Alert id (feed_...).
@@ -10786,11 +11575,29 @@ type RunAlertDigestResponses = {
10786
11575
  * Why nothing was sent: the period already went out, nothing to show, an hourly retry window closed, or another run is sending it now.
10787
11576
  */
10788
11577
  skipped: 'already_sent' | 'empty' | 'expired' | 'in_flight';
11578
+ /**
11579
+ * Matches in the window.
11580
+ */
10789
11581
  matched: number;
11582
+ /**
11583
+ * Relevant matches in the window.
11584
+ */
10790
11585
  relevant: number;
11586
+ /**
11587
+ * One result per channel.
11588
+ */
10791
11589
  outcomes: Array<{
11590
+ /**
11591
+ * The channel (dest_...).
11592
+ */
10792
11593
  channelId: string;
11594
+ /**
11595
+ * Whether the channel accepted it.
11596
+ */
10793
11597
  ok: boolean;
11598
+ /**
11599
+ * Why it failed; null when it did not.
11600
+ */
10794
11601
  error: string | null;
10795
11602
  }>;
10796
11603
  };
@@ -10806,6 +11613,12 @@ type MuteAlertAuthorsData = {
10806
11613
  */
10807
11614
  authors: Array<string>;
10808
11615
  };
11616
+ headers?: {
11617
+ /**
11618
+ * A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
11619
+ */
11620
+ 'idempotency-key'?: string;
11621
+ };
10809
11622
  path: {
10810
11623
  /**
10811
11624
  * Alert id (feed_...).
@@ -10847,6 +11660,12 @@ type UnmuteAlertAuthorsData = {
10847
11660
  */
10848
11661
  authors: Array<string>;
10849
11662
  };
11663
+ headers?: {
11664
+ /**
11665
+ * A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
11666
+ */
11667
+ 'idempotency-key'?: string;
11668
+ };
10850
11669
  path: {
10851
11670
  /**
10852
11671
  * Alert id (feed_...).
@@ -10857,6 +11676,10 @@ type UnmuteAlertAuthorsData = {
10857
11676
  url: '/v1/alerts/{id}/unmute';
10858
11677
  };
10859
11678
  type UnmuteAlertAuthorsErrors = {
11679
+ /**
11680
+ * Invalid request: a parameter or the body failed validation (validation_error)
11681
+ */
11682
+ 400: ErrorResponse;
10860
11683
  /**
10861
11684
  * Missing or invalid API key
10862
11685
  */
@@ -10898,6 +11721,14 @@ type GetAnalyticsSummaryData = {
10898
11721
  * Only these platforms. Repeatable, or comma-separated; omit for every platform.
10899
11722
  */
10900
11723
  platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
11724
+ /**
11725
+ * Never these keyword ids. Repeatable, or comma-separated.
11726
+ */
11727
+ notKeywordIds?: Array<string> | null;
11728
+ /**
11729
+ * Never these platforms. Repeatable, or comma-separated.
11730
+ */
11731
+ notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
10901
11732
  /**
10902
11733
  * true adds the period of the same length right before the window as `previous`.
10903
11734
  */
@@ -10951,6 +11782,14 @@ type GetAnalyticsSeriesData = {
10951
11782
  * Only these platforms. Repeatable, or comma-separated; omit for every platform.
10952
11783
  */
10953
11784
  platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
11785
+ /**
11786
+ * Never these keyword ids. Repeatable, or comma-separated.
11787
+ */
11788
+ notKeywordIds?: Array<string> | null;
11789
+ /**
11790
+ * Never these platforms. Repeatable, or comma-separated.
11791
+ */
11792
+ notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
10954
11793
  /**
10955
11794
  * true adds the period of the same length right before the window as `previous`.
10956
11795
  */
@@ -11012,6 +11851,14 @@ type GetAnalyticsBreakdownData = {
11012
11851
  * Only these platforms. Repeatable, or comma-separated; omit for every platform.
11013
11852
  */
11014
11853
  platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
11854
+ /**
11855
+ * Never these keyword ids. Repeatable, or comma-separated.
11856
+ */
11857
+ notKeywordIds?: Array<string> | null;
11858
+ /**
11859
+ * Never these platforms. Repeatable, or comma-separated.
11860
+ */
11861
+ notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
11015
11862
  /**
11016
11863
  * true adds the period of the same length right before the window as `previous`.
11017
11864
  */
@@ -11079,6 +11926,14 @@ type GetShareOfVoiceData = {
11079
11926
  * Only these platforms. Repeatable, or comma-separated; omit for every platform.
11080
11927
  */
11081
11928
  platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
11929
+ /**
11930
+ * Never these keyword ids. Repeatable, or comma-separated.
11931
+ */
11932
+ notKeywordIds?: Array<string> | null;
11933
+ /**
11934
+ * Never these platforms. Repeatable, or comma-separated.
11935
+ */
11936
+ notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
11082
11937
  /**
11083
11938
  * true adds the period of the same length right before the window as `previous`.
11084
11939
  */
@@ -11132,6 +11987,14 @@ type GetReviewsReportData = {
11132
11987
  * Only these platforms. Repeatable, or comma-separated; omit for every platform.
11133
11988
  */
11134
11989
  platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
11990
+ /**
11991
+ * Never these keyword ids. Repeatable, or comma-separated.
11992
+ */
11993
+ notKeywordIds?: Array<string> | null;
11994
+ /**
11995
+ * Never these platforms. Repeatable, or comma-separated.
11996
+ */
11997
+ notPlatforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'facebook' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
11135
11998
  /**
11136
11999
  * true adds the period of the same length right before the window as `previous`.
11137
12000
  */
@@ -11228,6 +12091,9 @@ type UpdateChannelData = {
11228
12091
  * Omitted fields are untouched.
11229
12092
  */
11230
12093
  body: {
12094
+ /**
12095
+ * Your name for the channel.
12096
+ */
11231
12097
  label?: string;
11232
12098
  /**
11233
12099
  * Webhooks only.
@@ -11277,6 +12143,12 @@ type UpdateChannelResponses = {
11277
12143
  type UpdateChannelResponse = UpdateChannelResponses[keyof UpdateChannelResponses];
11278
12144
  type TestChannelData = {
11279
12145
  body?: never;
12146
+ headers?: {
12147
+ /**
12148
+ * A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
12149
+ */
12150
+ 'idempotency-key'?: string;
12151
+ };
11280
12152
  path: {
11281
12153
  /**
11282
12154
  * Channel id (dest_...).
@@ -11302,9 +12174,21 @@ type TestChannelResponses = {
11302
12174
  * A test message was attempted on the channel (webhooks receive event "test")
11303
12175
  */
11304
12176
  200: {
12177
+ /**
12178
+ * The test send's result.
12179
+ */
11305
12180
  outcomes: Array<{
12181
+ /**
12182
+ * The channel (dest_...).
12183
+ */
11306
12184
  channelId: string;
12185
+ /**
12186
+ * Whether the channel accepted it.
12187
+ */
11307
12188
  ok: boolean;
12189
+ /**
12190
+ * Why it failed; null when it did not.
12191
+ */
11308
12192
  error: string | null;
11309
12193
  }>;
11310
12194
  };
@@ -11312,6 +12196,12 @@ type TestChannelResponses = {
11312
12196
  type TestChannelResponse = TestChannelResponses[keyof TestChannelResponses];
11313
12197
  type RotateWebhookSecretData = {
11314
12198
  body?: never;
12199
+ headers?: {
12200
+ /**
12201
+ * A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.
12202
+ */
12203
+ 'idempotency-key'?: string;
12204
+ };
11315
12205
  path: {
11316
12206
  /**
11317
12207
  * Channel id (dest_...).
@@ -11360,6 +12250,10 @@ type ListChannelDeliveriesData = {
11360
12250
  url: '/v1/channels/{id}/deliveries';
11361
12251
  };
11362
12252
  type ListChannelDeliveriesErrors = {
12253
+ /**
12254
+ * Invalid request: a parameter or the body failed validation (validation_error)
12255
+ */
12256
+ 400: ErrorResponse;
11363
12257
  /**
11364
12258
  * Missing or invalid API key
11365
12259
  */
@@ -11375,6 +12269,9 @@ type ListChannelDeliveriesResponses = {
11375
12269
  * What the channel received, newest first: instant mentions and digest runs, with status and last error
11376
12270
  */
11377
12271
  200: {
12272
+ /**
12273
+ * Deliveries, newest first.
12274
+ */
11378
12275
  data: Array<{
11379
12276
  /**
11380
12277
  * Delivery id (dlv_...), also the webhook payload id.
@@ -11388,7 +12285,13 @@ type ListChannelDeliveriesResponses = {
11388
12285
  * The event name the payload carried: the rule's (mention.matched unless it set one, digest for a summary) or the account event's.
11389
12286
  */
11390
12287
  event: string;
12288
+ /**
12289
+ * pending, delivered or failed.
12290
+ */
11391
12291
  status: 'pending' | 'delivered' | 'failed';
12292
+ /**
12293
+ * Send attempts so far.
12294
+ */
11392
12295
  attempts: number;
11393
12296
  /**
11394
12297
  * The last failure, when there was one.
@@ -11406,14 +12309,26 @@ type ListChannelDeliveriesResponses = {
11406
12309
  * The alert that produced it; name only, since alerts can be deleted. name is null for an account event, which no rule produces.
11407
12310
  */
11408
12311
  alert: {
12312
+ /**
12313
+ * Alert name.
12314
+ */
11409
12315
  name: string | null;
11410
12316
  };
11411
12317
  /**
11412
12318
  * For mention deliveries: the post, text cut to 160 characters.
11413
12319
  */
11414
12320
  mention: {
12321
+ /**
12322
+ * Mention id.
12323
+ */
11415
12324
  id: string;
12325
+ /**
12326
+ * Link to the post.
12327
+ */
11416
12328
  url: string;
12329
+ /**
12330
+ * The post text, cut to 160 characters.
12331
+ */
11417
12332
  text: string;
11418
12333
  } | null;
11419
12334
  }>;
@@ -11442,6 +12357,9 @@ type ListChannelsResponses = {
11442
12357
  * Every channel of the org
11443
12358
  */
11444
12359
  200: {
12360
+ /**
12361
+ * Every channel of the workspace.
12362
+ */
11445
12363
  data: Array<SlackChannel | EmailChannel | WebhookChannel | TelegramChannel>;
11446
12364
  };
11447
12365
  };