@mentio-dev/sdk 0.13.2 → 0.13.4

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
@@ -1303,7 +1303,7 @@ type Mention = {
1303
1303
  */
1304
1304
  followers: number | null;
1305
1305
  /**
1306
- * Your workspace tags on this person.
1306
+ * Your tags on this person: the workspace's, then those the mention's own keyword group gave them (set with groupId on /v1/people), each once.
1307
1307
  */
1308
1308
  tags: Array<string>;
1309
1309
  } | null;
@@ -1668,7 +1668,7 @@ type Person = {
1668
1668
  tags: Array<string>;
1669
1669
  notes: string;
1670
1670
  /**
1671
- * Their posts stay out of the feed and every channel; ingest and billing are untouched.
1671
+ * 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.
1672
1672
  */
1673
1673
  muted: boolean;
1674
1674
  };
@@ -1815,6 +1815,10 @@ type Segment = {
1815
1815
  */
1816
1816
  ownerIds?: Array<string>;
1817
1817
  };
1818
+ /**
1819
+ * The group this segment belongs to, or null for a workspace segment.
1820
+ */
1821
+ groupId: string | null;
1818
1822
  /**
1819
1823
  * People in the segment right now; it is evaluated on every read.
1820
1824
  */
@@ -1909,11 +1913,11 @@ type FilterGroup = {
1909
1913
  */
1910
1914
  notLanguages?: Array<string>;
1911
1915
  /**
1912
- * Only authors your workspace tagged with any of these.
1916
+ * Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
1913
1917
  */
1914
1918
  tags?: Array<string>;
1915
1919
  /**
1916
- * Never authors tagged with any of these.
1920
+ * Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
1917
1921
  */
1918
1922
  notTags?: Array<string>;
1919
1923
  /**
@@ -2070,11 +2074,11 @@ type View = {
2070
2074
  */
2071
2075
  notLanguages?: Array<string>;
2072
2076
  /**
2073
- * Only authors your workspace tagged with any of these.
2077
+ * Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
2074
2078
  */
2075
2079
  tags?: Array<string>;
2076
2080
  /**
2077
- * Never authors tagged with any of these.
2081
+ * Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
2078
2082
  */
2079
2083
  notTags?: Array<string>;
2080
2084
  /**
@@ -3126,7 +3130,7 @@ type Alert = {
3126
3130
  */
3127
3131
  minFollowers?: number;
3128
3132
  /**
3129
- * Only authors your workspace tagged with any of these.
3133
+ * Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
3130
3134
  */
3131
3135
  tags?: Array<string>;
3132
3136
  /**
@@ -5270,7 +5274,7 @@ type SearchMentionsData = {
5270
5274
  */
5271
5275
  personId?: string;
5272
5276
  /**
5273
- * true: include mentions by people you muted, hidden by default.
5277
+ * true: include mentions by people you muted, hidden by default: muted for the workspace, or for the mention's own keyword group.
5274
5278
  */
5275
5279
  includeMuted?: boolean;
5276
5280
  /**
@@ -5326,7 +5330,7 @@ type SearchMentionsData = {
5326
5330
  */
5327
5331
  keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
5328
5332
  /**
5329
- * Only authors your workspace tagged with any of these (exact, case-sensitive). Repeatable, or comma-separated.
5333
+ * 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.
5330
5334
  */
5331
5335
  tags?: Array<string> | null;
5332
5336
  /**
@@ -5386,7 +5390,7 @@ type SearchMentionsData = {
5386
5390
  */
5387
5391
  notSubreddits?: Array<string> | null;
5388
5392
  /**
5389
- * Never authors your workspace tagged with any of these.
5393
+ * Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
5390
5394
  */
5391
5395
  notTags?: Array<string> | null;
5392
5396
  /**
@@ -5521,7 +5525,7 @@ type ExportMentionsCsvData = {
5521
5525
  */
5522
5526
  personId?: string;
5523
5527
  /**
5524
- * true: include mentions by people you muted, hidden by default.
5528
+ * true: include mentions by people you muted, hidden by default: muted for the workspace, or for the mention's own keyword group.
5525
5529
  */
5526
5530
  includeMuted?: boolean;
5527
5531
  /**
@@ -5577,7 +5581,7 @@ type ExportMentionsCsvData = {
5577
5581
  */
5578
5582
  keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
5579
5583
  /**
5580
- * Only authors your workspace tagged with any of these (exact, case-sensitive). Repeatable, or comma-separated.
5584
+ * 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.
5581
5585
  */
5582
5586
  tags?: Array<string> | null;
5583
5587
  /**
@@ -5637,7 +5641,7 @@ type ExportMentionsCsvData = {
5637
5641
  */
5638
5642
  notSubreddits?: Array<string> | null;
5639
5643
  /**
5640
- * Never authors your workspace tagged with any of these.
5644
+ * Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
5641
5645
  */
5642
5646
  notTags?: Array<string> | null;
5643
5647
  /**
@@ -5806,7 +5810,7 @@ type ExportMentionsJsonData = {
5806
5810
  */
5807
5811
  personId?: string;
5808
5812
  /**
5809
- * true: include mentions by people you muted, hidden by default.
5813
+ * true: include mentions by people you muted, hidden by default: muted for the workspace, or for the mention's own keyword group.
5810
5814
  */
5811
5815
  includeMuted?: boolean;
5812
5816
  /**
@@ -5862,7 +5866,7 @@ type ExportMentionsJsonData = {
5862
5866
  */
5863
5867
  keywordKinds?: Array<'brand' | 'competitor' | 'topic'>;
5864
5868
  /**
5865
- * Only authors your workspace tagged with any of these (exact, case-sensitive). Repeatable, or comma-separated.
5869
+ * 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.
5866
5870
  */
5867
5871
  tags?: Array<string> | null;
5868
5872
  /**
@@ -5922,7 +5926,7 @@ type ExportMentionsJsonData = {
5922
5926
  */
5923
5927
  notSubreddits?: Array<string> | null;
5924
5928
  /**
5925
- * Never authors your workspace tagged with any of these.
5929
+ * Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
5926
5930
  */
5927
5931
  notTags?: Array<string> | null;
5928
5932
  /**
@@ -6019,6 +6023,10 @@ type ExportPeopleCsvData = {
6019
6023
  body?: never;
6020
6024
  path?: never;
6021
6025
  query?: {
6026
+ /**
6027
+ * Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, mute, merges, activities and segments. Omit for the whole workspace.
6028
+ */
6029
+ groupId?: string;
6022
6030
  /**
6023
6031
  * People with an account on this platform.
6024
6032
  */
@@ -6132,7 +6140,7 @@ type ExportPeopleCsvErrors = {
6132
6140
  */
6133
6141
  401: ErrorResponse;
6134
6142
  /**
6135
- * No such segment for your workspace
6143
+ * No such segment in this scope, or no such group
6136
6144
  */
6137
6145
  404: ErrorResponse;
6138
6146
  /**
@@ -6152,6 +6160,10 @@ type ListPeopleData = {
6152
6160
  body?: never;
6153
6161
  path?: never;
6154
6162
  query?: {
6163
+ /**
6164
+ * Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, mute, merges, activities and segments. Omit for the whole workspace.
6165
+ */
6166
+ groupId?: string;
6155
6167
  /**
6156
6168
  * People with an account on this platform.
6157
6169
  */
@@ -6273,7 +6285,7 @@ type ListPeopleErrors = {
6273
6285
  */
6274
6286
  401: ErrorResponse;
6275
6287
  /**
6276
- * No such segment for your workspace
6288
+ * No such segment in this scope, or no such group
6277
6289
  */
6278
6290
  404: ErrorResponse;
6279
6291
  };
@@ -6395,7 +6407,7 @@ type ListPeopleResponses = {
6395
6407
  tags: Array<string>;
6396
6408
  notes: string;
6397
6409
  /**
6398
- * Their posts stay out of the feed and every channel; ingest and billing are untouched.
6410
+ * 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.
6399
6411
  */
6400
6412
  muted: boolean;
6401
6413
  };
@@ -6439,7 +6451,12 @@ type GetPersonData = {
6439
6451
  */
6440
6452
  id: string;
6441
6453
  };
6442
- query?: never;
6454
+ query?: {
6455
+ /**
6456
+ * Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, mute, merges, activities and segments. Omit for the whole workspace.
6457
+ */
6458
+ groupId?: string;
6459
+ };
6443
6460
  url: '/v1/people/{id}';
6444
6461
  };
6445
6462
  type GetPersonErrors = {
@@ -6448,7 +6465,7 @@ type GetPersonErrors = {
6448
6465
  */
6449
6466
  401: ErrorResponse;
6450
6467
  /**
6451
- * No mention by this person for your workspace
6468
+ * No mention by this person in this scope, or no such group
6452
6469
  */
6453
6470
  404: ErrorResponse;
6454
6471
  };
@@ -6470,6 +6487,9 @@ type UpdatePersonData = {
6470
6487
  */
6471
6488
  tags?: Array<string>;
6472
6489
  notes?: string;
6490
+ /**
6491
+ * true hides their posts from the feed, the alerts and the digests; false shows them again. Without groupId, for every keyword of the workspace; with groupId, for the mentions of that group's keywords only, leaving the workspace's mute as it is.
6492
+ */
6473
6493
  muted?: boolean;
6474
6494
  /**
6475
6495
  * The member who owns the contact (user id); null clears.
@@ -6486,7 +6506,12 @@ type UpdatePersonData = {
6486
6506
  */
6487
6507
  id: string;
6488
6508
  };
6489
- query?: never;
6509
+ query?: {
6510
+ /**
6511
+ * Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, mute, merges, activities and segments. Omit for the whole workspace.
6512
+ */
6513
+ groupId?: string;
6514
+ };
6490
6515
  url: '/v1/people/{id}';
6491
6516
  };
6492
6517
  type UpdatePersonErrors = {
@@ -6499,7 +6524,7 @@ type UpdatePersonErrors = {
6499
6524
  */
6500
6525
  401: ErrorResponse;
6501
6526
  /**
6502
- * No mention by this person for your workspace
6527
+ * No mention by this person in this scope, or no such group
6503
6528
  */
6504
6529
  404: ErrorResponse;
6505
6530
  };
@@ -6524,7 +6549,12 @@ type MergePeopleData = {
6524
6549
  */
6525
6550
  id: string;
6526
6551
  };
6527
- query?: never;
6552
+ query?: {
6553
+ /**
6554
+ * Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, mute, merges, activities and segments. Omit for the whole workspace.
6555
+ */
6556
+ groupId?: string;
6557
+ };
6528
6558
  url: '/v1/people/{id}/merge';
6529
6559
  };
6530
6560
  type MergePeopleErrors = {
@@ -6533,7 +6563,7 @@ type MergePeopleErrors = {
6533
6563
  */
6534
6564
  401: ErrorResponse;
6535
6565
  /**
6536
- * Either side is unknown to your workspace
6566
+ * Either side is unknown in this scope, or no such group
6537
6567
  */
6538
6568
  404: ErrorResponse;
6539
6569
  };
@@ -6553,7 +6583,12 @@ type SplitPersonData = {
6553
6583
  */
6554
6584
  id: string;
6555
6585
  };
6556
- query?: never;
6586
+ query?: {
6587
+ /**
6588
+ * Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, mute, merges, activities and segments. Omit for the whole workspace.
6589
+ */
6590
+ groupId?: string;
6591
+ };
6557
6592
  url: '/v1/people/{id}/split';
6558
6593
  };
6559
6594
  type SplitPersonErrors = {
@@ -6562,7 +6597,7 @@ type SplitPersonErrors = {
6562
6597
  */
6563
6598
  401: ErrorResponse;
6564
6599
  /**
6565
- * This account was not merged into anyone
6600
+ * This account was not merged into anyone in this scope, or no such group
6566
6601
  */
6567
6602
  404: ErrorResponse;
6568
6603
  };
@@ -6582,7 +6617,12 @@ type ListPersonActivitiesData = {
6582
6617
  */
6583
6618
  id: string;
6584
6619
  };
6585
- query?: never;
6620
+ query?: {
6621
+ /**
6622
+ * Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, mute, merges, activities and segments. Omit for the whole workspace.
6623
+ */
6624
+ groupId?: string;
6625
+ };
6586
6626
  url: '/v1/people/{id}/activities';
6587
6627
  };
6588
6628
  type ListPersonActivitiesErrors = {
@@ -6591,7 +6631,7 @@ type ListPersonActivitiesErrors = {
6591
6631
  */
6592
6632
  401: ErrorResponse;
6593
6633
  /**
6594
- * No mention by this person for your workspace
6634
+ * No mention by this person in this scope, or no such group
6595
6635
  */
6596
6636
  404: ErrorResponse;
6597
6637
  };
@@ -6669,7 +6709,12 @@ type LogPersonActivityData = {
6669
6709
  */
6670
6710
  id: string;
6671
6711
  };
6672
- query?: never;
6712
+ query?: {
6713
+ /**
6714
+ * Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, mute, merges, activities and segments. Omit for the whole workspace.
6715
+ */
6716
+ groupId?: string;
6717
+ };
6673
6718
  url: '/v1/people/{id}/activities';
6674
6719
  };
6675
6720
  type LogPersonActivityErrors = {
@@ -6682,7 +6727,7 @@ type LogPersonActivityErrors = {
6682
6727
  */
6683
6728
  401: ErrorResponse;
6684
6729
  /**
6685
- * No mention by this person for your workspace
6730
+ * No mention by this person in this scope, or no such group
6686
6731
  */
6687
6732
  404: ErrorResponse;
6688
6733
  };
@@ -6706,7 +6751,12 @@ type DeletePersonActivityData = {
6706
6751
  */
6707
6752
  activityId: string;
6708
6753
  };
6709
- query?: never;
6754
+ query?: {
6755
+ /**
6756
+ * Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, mute, merges, activities and segments. Omit for the whole workspace.
6757
+ */
6758
+ groupId?: string;
6759
+ };
6710
6760
  url: '/v1/people/{id}/activities/{activityId}';
6711
6761
  };
6712
6762
  type DeletePersonActivityErrors = {
@@ -6715,7 +6765,7 @@ type DeletePersonActivityErrors = {
6715
6765
  */
6716
6766
  401: ErrorResponse;
6717
6767
  /**
6718
- * No such activity on this person for your workspace
6768
+ * No such activity on this person in this scope, or no such group
6719
6769
  */
6720
6770
  404: ErrorResponse;
6721
6771
  };
@@ -6730,7 +6780,12 @@ type DeletePersonActivityResponse = DeletePersonActivityResponses[keyof DeletePe
6730
6780
  type ListSegmentsData = {
6731
6781
  body?: never;
6732
6782
  path?: never;
6733
- query?: never;
6783
+ query?: {
6784
+ /**
6785
+ * Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, mute, merges, activities and segments. Omit for the whole workspace.
6786
+ */
6787
+ groupId?: string;
6788
+ };
6734
6789
  url: '/v1/segments';
6735
6790
  };
6736
6791
  type ListSegmentsErrors = {
@@ -6738,6 +6793,10 @@ type ListSegmentsErrors = {
6738
6793
  * Missing or invalid API key
6739
6794
  */
6740
6795
  401: ErrorResponse;
6796
+ /**
6797
+ * No such group
6798
+ */
6799
+ 404: ErrorResponse;
6741
6800
  };
6742
6801
  type ListSegmentsError = ListSegmentsErrors[keyof ListSegmentsErrors];
6743
6802
  type ListSegmentsResponses = {
@@ -6826,6 +6885,10 @@ type ListSegmentsResponses = {
6826
6885
  */
6827
6886
  ownerIds?: Array<string>;
6828
6887
  };
6888
+ /**
6889
+ * The group this segment belongs to, or null for a workspace segment.
6890
+ */
6891
+ groupId: string | null;
6829
6892
  /**
6830
6893
  * People in the segment right now; it is evaluated on every read.
6831
6894
  */
@@ -7004,7 +7067,12 @@ type CreateSegmentData = {
7004
7067
  };
7005
7068
  };
7006
7069
  path?: never;
7007
- query?: never;
7070
+ query?: {
7071
+ /**
7072
+ * Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, mute, merges, activities and segments. Omit for the whole workspace.
7073
+ */
7074
+ groupId?: string;
7075
+ };
7008
7076
  url: '/v1/segments';
7009
7077
  };
7010
7078
  type CreateSegmentErrors = {
@@ -7017,7 +7085,11 @@ type CreateSegmentErrors = {
7017
7085
  */
7018
7086
  401: ErrorResponse;
7019
7087
  /**
7020
- * A segment with this name already exists
7088
+ * No such group
7089
+ */
7090
+ 404: ErrorResponse;
7091
+ /**
7092
+ * A segment with this name already exists in this scope
7021
7093
  */
7022
7094
  409: ErrorResponse;
7023
7095
  };
@@ -7037,7 +7109,12 @@ type DeleteSegmentData = {
7037
7109
  */
7038
7110
  id: string;
7039
7111
  };
7040
- query?: never;
7112
+ query?: {
7113
+ /**
7114
+ * Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, mute, merges, activities and segments. Omit for the whole workspace.
7115
+ */
7116
+ groupId?: string;
7117
+ };
7041
7118
  url: '/v1/segments/{id}';
7042
7119
  };
7043
7120
  type DeleteSegmentErrors = {
@@ -7046,7 +7123,7 @@ type DeleteSegmentErrors = {
7046
7123
  */
7047
7124
  401: ErrorResponse;
7048
7125
  /**
7049
- * No such segment for your workspace
7126
+ * No such segment in this scope, or no such group
7050
7127
  */
7051
7128
  404: ErrorResponse;
7052
7129
  };
@@ -7066,7 +7143,12 @@ type GetSegmentData = {
7066
7143
  */
7067
7144
  id: string;
7068
7145
  };
7069
- query?: never;
7146
+ query?: {
7147
+ /**
7148
+ * Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, mute, merges, activities and segments. Omit for the whole workspace.
7149
+ */
7150
+ groupId?: string;
7151
+ };
7070
7152
  url: '/v1/segments/{id}';
7071
7153
  };
7072
7154
  type GetSegmentErrors = {
@@ -7075,7 +7157,7 @@ type GetSegmentErrors = {
7075
7157
  */
7076
7158
  401: ErrorResponse;
7077
7159
  /**
7078
- * No such segment for your workspace
7160
+ * No such segment in this scope, or no such group
7079
7161
  */
7080
7162
  404: ErrorResponse;
7081
7163
  };
@@ -7178,7 +7260,12 @@ type UpdateSegmentData = {
7178
7260
  */
7179
7261
  id: string;
7180
7262
  };
7181
- query?: never;
7263
+ query?: {
7264
+ /**
7265
+ * Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, mute, merges, activities and segments. Omit for the whole workspace.
7266
+ */
7267
+ groupId?: string;
7268
+ };
7182
7269
  url: '/v1/segments/{id}';
7183
7270
  };
7184
7271
  type UpdateSegmentErrors = {
@@ -7187,11 +7274,11 @@ type UpdateSegmentErrors = {
7187
7274
  */
7188
7275
  401: ErrorResponse;
7189
7276
  /**
7190
- * No such segment for your workspace
7277
+ * No such segment in this scope, or no such group
7191
7278
  */
7192
7279
  404: ErrorResponse;
7193
7280
  /**
7194
- * A segment with this name already exists
7281
+ * A segment with this name already exists in this scope
7195
7282
  */
7196
7283
  409: ErrorResponse;
7197
7284
  };
@@ -7309,11 +7396,11 @@ type ListViewsResponses = {
7309
7396
  */
7310
7397
  notLanguages?: Array<string>;
7311
7398
  /**
7312
- * Only authors your workspace tagged with any of these.
7399
+ * Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
7313
7400
  */
7314
7401
  tags?: Array<string>;
7315
7402
  /**
7316
- * Never authors tagged with any of these.
7403
+ * Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
7317
7404
  */
7318
7405
  notTags?: Array<string>;
7319
7406
  /**
@@ -7492,11 +7579,11 @@ type CreateViewData = {
7492
7579
  */
7493
7580
  notLanguages?: Array<string>;
7494
7581
  /**
7495
- * Only authors your workspace tagged with any of these.
7582
+ * Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
7496
7583
  */
7497
7584
  tags?: Array<string>;
7498
7585
  /**
7499
- * Never authors tagged with any of these.
7586
+ * Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
7500
7587
  */
7501
7588
  notTags?: Array<string>;
7502
7589
  /**
@@ -7742,11 +7829,11 @@ type UpdateViewData = {
7742
7829
  */
7743
7830
  notLanguages?: Array<string>;
7744
7831
  /**
7745
- * Only authors your workspace tagged with any of these.
7832
+ * Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
7746
7833
  */
7747
7834
  tags?: Array<string>;
7748
7835
  /**
7749
- * Never authors tagged with any of these.
7836
+ * Never authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
7750
7837
  */
7751
7838
  notTags?: Array<string>;
7752
7839
  /**
@@ -8892,7 +8979,7 @@ type UpdateAlertData = {
8892
8979
  */
8893
8980
  minFollowers?: number;
8894
8981
  /**
8895
- * Only authors your workspace tagged with any of these.
8982
+ * Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
8896
8983
  */
8897
8984
  tags?: Array<string>;
8898
8985
  /**
@@ -9061,7 +9148,7 @@ type ListAlertsResponses = {
9061
9148
  */
9062
9149
  minFollowers?: number;
9063
9150
  /**
9064
- * Only authors your workspace tagged with any of these.
9151
+ * Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
9065
9152
  */
9066
9153
  tags?: Array<string>;
9067
9154
  /**
@@ -9206,7 +9293,7 @@ type CreateAlertData = {
9206
9293
  */
9207
9294
  minFollowers?: number;
9208
9295
  /**
9209
- * Only authors your workspace tagged with any of these.
9296
+ * Only authors tagged with any of these, in the workspace's tags or those of the mention's own keyword group.
9210
9297
  */
9211
9298
  tags?: Array<string>;
9212
9299
  /**
@@ -10151,79 +10238,85 @@ declare const exportMentionsJson: <ThrowOnError extends boolean = false>(options
10151
10238
  /**
10152
10239
  * Export people as CSV
10153
10240
  *
10154
- * The same list as GET /v1/people (segmentId included) as CSV, one row per person with their contact columns: handle, followers, email, website, company, location, tags, then outreach stage, owner and last contacted. Capped at 5,000 people. At most 6 exports per minute per workspace; a 429 carries Retry-After.
10241
+ * The same list as GET /v1/people (segmentId included) as CSV, one row per person with their contact columns: handle, followers, email, website, company, location, tags, then outreach stage, owner and last contacted. Capped at 5,000 people. `groupId` scopes the export like the list. At most 6 exports per minute per workspace; a 429 carries Retry-After.
10155
10242
  */
10156
10243
  declare const exportPeopleCsv: <ThrowOnError extends boolean = false>(options?: Options<ExportPeopleCsvData, ThrowOnError>) => RequestResult<ExportPeopleCsvResponses, ExportPeopleCsvErrors, ThrowOnError>;
10157
10244
  /**
10158
10245
  * List people
10159
10246
  *
10160
- * 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.
10247
+ * 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. With `groupId`, only the people who mentioned that keyword group's keywords, counted over those mentions, with that group's own annotations, merges, outreach and segments.
10161
10248
  */
10162
10249
  declare const listPeople: <ThrowOnError extends boolean = false>(options?: Options<ListPeopleData, ThrowOnError>) => RequestResult<ListPeopleResponses, ListPeopleErrors, ThrowOnError>;
10163
10250
  /**
10164
10251
  * Get a person
10165
10252
  *
10166
- * One person as your workspace sees them. An account merged into someone resolves to that person.
10253
+ * One person as your workspace sees them. An account merged into someone resolves to that person. With `groupId`, the call works inside that keyword group: its people, and its own tags, notes, mute, merges and activities, apart from the workspace's and from every other group's.
10167
10254
  */
10168
10255
  declare const getPerson: <ThrowOnError extends boolean = false>(options: Options<GetPersonData, ThrowOnError>) => RequestResult<GetPersonResponses, GetPersonErrors, ThrowOnError>;
10169
10256
  /**
10170
10257
  * Update your annotations on a person
10171
10258
  *
10172
- * Tags, notes, mute, and the outreach owner (a workspace member; null clears) and stage, for your workspace only. Mute hides their posts from your feed and every channel; ingest and billing never change.
10259
+ * Tags, notes, mute, and the outreach owner (a workspace member; null clears) and stage, for your workspace only. Mute hides their posts from your feed and every channel; ingest and billing never change. With `groupId` the annotations are that keyword group's own: `muted` hides the person, and the accounts that group merged into them, from the mentions of that group's keywords only (feed, alerts and digests), and the group's tags show on those mentions next to the workspace's. A mute set without `groupId` hides them everywhere.
10173
10260
  */
10174
10261
  declare const updatePerson: <ThrowOnError extends boolean = false>(options: Options<UpdatePersonData, ThrowOnError>) => RequestResult<UpdatePersonResponses, UpdatePersonErrors, ThrowOnError>;
10175
10262
  /**
10176
10263
  * Merge an account into a person
10177
10264
  *
10178
- * Declare that this account and another person are the same human, for your workspace only. Their mentions, tags, notes and outreach activities combine under the person named by `into`, which keeps its owner and stage unless it had none.
10265
+ * Declare that this account and another person are the same human, for your workspace only. Their mentions, tags, notes and outreach activities combine under the person named by `into`, which keeps its owner and stage unless it had none. With `groupId`, the call works inside that keyword group: its people, and its own tags, notes, mute, merges and activities, apart from the workspace's and from every other group's.
10179
10266
  */
10180
10267
  declare const mergePeople: <ThrowOnError extends boolean = false>(options: Options<MergePeopleData, ThrowOnError>) => RequestResult<MergePeopleResponses, MergePeopleErrors, ThrowOnError>;
10181
10268
  /**
10182
10269
  * Undo a merge
10183
10270
  *
10184
- * The account becomes its own person again.
10271
+ * The account becomes its own person again. With `groupId`, the call works inside that keyword group: its people, and its own tags, notes, mute, merges and activities, apart from the workspace's and from every other group's.
10185
10272
  */
10186
10273
  declare const splitPerson: <ThrowOnError extends boolean = false>(options: Options<SplitPersonData, ThrowOnError>) => RequestResult<SplitPersonResponses, SplitPersonErrors, ThrowOnError>;
10187
10274
  /**
10188
10275
  * List outreach activities
10189
10276
  *
10190
- * Every logged contact with this person across all their accounts, newest first (at most 200): who reached out, the channel, when, and a short note. Read it before reaching out so two teammates never contact the same person without knowing.
10277
+ * Every logged contact with this person across all their accounts, newest first (at most 200): who reached out, the channel, when, and a short note. Read it before reaching out so two teammates never contact the same person without knowing. With `groupId`, the call works inside that keyword group: its people, and its own tags, notes, mute, merges and activities, apart from the workspace's and from every other group's.
10191
10278
  */
10192
10279
  declare const listPersonActivities: <ThrowOnError extends boolean = false>(options: Options<ListPersonActivitiesData, ThrowOnError>) => RequestResult<ListPersonActivitiesResponses, ListPersonActivitiesErrors, ThrowOnError>;
10193
10280
  /**
10194
10281
  * Log an outreach activity
10195
10282
  *
10196
- * Record that a teammate reached out to this person: an email, a DM, a call. The first activity claims an unowned person for whoever reached out and moves not_contacted to contacted; an existing owner and a later stage are kept. `memberId` defaults to the signed-in member; an API key that omits it logs an unattributed activity, which claims nobody.
10283
+ * Record that a teammate reached out to this person: an email, a DM, a call. The first activity claims an unowned person for whoever reached out and moves not_contacted to contacted; an existing owner and a later stage are kept. `memberId` defaults to the signed-in member; an API key that omits it logs an unattributed activity, which claims nobody. With `groupId`, the call works inside that keyword group: its people, and its own tags, notes, mute, merges and activities, apart from the workspace's and from every other group's.
10197
10284
  */
10198
10285
  declare const logPersonActivity: <ThrowOnError extends boolean = false>(options: Options<LogPersonActivityData, ThrowOnError>) => RequestResult<LogPersonActivityResponses, LogPersonActivityErrors, ThrowOnError>;
10199
10286
  /**
10200
10287
  * Delete an outreach activity
10201
10288
  *
10202
- * Remove a contact logged by mistake. The person's owner and stage stay as they are.
10289
+ * Remove a contact logged by mistake. The person's owner and stage stay as they are. With `groupId`, the call works inside that keyword group: its people, and its own tags, notes, mute, merges and activities, apart from the workspace's and from every other group's.
10203
10290
  */
10204
10291
  declare const deletePersonActivity: <ThrowOnError extends boolean = false>(options: Options<DeletePersonActivityData, ThrowOnError>) => RequestResult<DeletePersonActivityResponses, DeletePersonActivityErrors, ThrowOnError>;
10205
10292
  /**
10206
10293
  * List segments
10207
10294
  *
10208
- * Your saved segments, each with the number of people in it right now (segments are evaluated on every read, never materialized), plus presets you can save as a starting point. Pass a segment id to GET /v1/people to list its members.
10295
+ * Your saved segments, each with the number of people in it right now (segments are evaluated on every read, never materialized), plus presets you can save as a starting point. Pass a segment id to GET /v1/people to list its members. With `groupId`, that keyword group's own segments, counted over its own people; without it, the workspace's. A segment belongs to one scope and is not visible from another.
10209
10296
  */
10210
10297
  declare const listSegments: <ThrowOnError extends boolean = false>(options?: Options<ListSegmentsData, ThrowOnError>) => RequestResult<ListSegmentsResponses, ListSegmentsErrors, ThrowOnError>;
10211
10298
  /**
10212
10299
  * Create a segment
10300
+ *
10301
+ * Save a named filter over your people. With `groupId` the segment belongs to that keyword group: it is listed, counted and changed only there, and its name only has to be unique in the group.
10213
10302
  */
10214
10303
  declare const createSegment: <ThrowOnError extends boolean = false>(options: Options<CreateSegmentData, ThrowOnError>) => RequestResult<CreateSegmentResponses, CreateSegmentErrors, ThrowOnError>;
10215
10304
  /**
10216
10305
  * Delete a segment
10217
10306
  *
10218
- * Nobody in it is affected.
10307
+ * Nobody in it is affected. Pass the `groupId` the segment was saved in.
10219
10308
  */
10220
10309
  declare const deleteSegment: <ThrowOnError extends boolean = false>(options: Options<DeleteSegmentData, ThrowOnError>) => RequestResult<DeleteSegmentResponses, DeleteSegmentErrors, ThrowOnError>;
10221
10310
  /**
10222
10311
  * Get a segment
10312
+ *
10313
+ * One segment of the scope the call names: the workspace, or the keyword group in `groupId`. A segment saved in another scope is a 404.
10223
10314
  */
10224
10315
  declare const getSegment: <ThrowOnError extends boolean = false>(options: Options<GetSegmentData, ThrowOnError>) => RequestResult<GetSegmentResponses, GetSegmentErrors, ThrowOnError>;
10225
10316
  /**
10226
10317
  * Update a segment
10318
+ *
10319
+ * Only the fields sent change. Pass the `groupId` the segment was saved in; a segment cannot move between scopes.
10227
10320
  */
10228
10321
  declare const updateSegment: <ThrowOnError extends boolean = false>(options: Options<UpdateSegmentData, ThrowOnError>) => RequestResult<UpdateSegmentResponses, UpdateSegmentErrors, ThrowOnError>;
10229
10322
  /**