@unipile/sdk 2.32.0 → 2.37.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -19,7 +19,7 @@ export type GetChatsListData = {
19
19
  */
20
20
  cursor?: string;
21
21
  /**
22
- * The limit of items to be returned. The maximum allowed value depends on the provider.
22
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
23
23
  */
24
24
  limit?: number;
25
25
  /**
@@ -245,9 +245,10 @@ export type GetChatsListResponses = {
245
245
  * 14 : Scheduled Call Cancelled
246
246
  * 15 : Scheduled Call Started
247
247
  * 16 : Announcement
248
+ * 17 : Content mention
248
249
  *
249
250
  */
250
- event_type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16;
251
+ event_type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17;
251
252
  event_metadata?: {
252
253
  /**
253
254
  * The updated title.
@@ -463,6 +464,19 @@ export type GetChatsListResponses = {
463
464
  */
464
465
  message_id: string;
465
466
  };
467
+ /**
468
+ * Content Relation
469
+ */
470
+ content_relation?: {
471
+ /**
472
+ * How this message relates to a piece of shared content: a normal reply to it, or a provider-generated notice that the current user was mentioned in it.
473
+ */
474
+ type: 'reply_to' | 'mentioned_in';
475
+ /**
476
+ * The id of this message's shared-content attachment describing the related content, when the provider still makes it available. Absent once the content is no longer retrievable (e.g. an expired story) but the relation is still known.
477
+ */
478
+ attachment_id?: string;
479
+ };
466
480
  /**
467
481
  * A list of reactions to the element.
468
482
  */
@@ -1703,7 +1717,7 @@ export type GetInboxChatsListData = {
1703
1717
  */
1704
1718
  cursor?: string;
1705
1719
  /**
1706
- * The limit of items to be returned. The maximum allowed value depends on the provider.
1720
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
1707
1721
  */
1708
1722
  limit?: number;
1709
1723
  /**
@@ -1929,9 +1943,10 @@ export type GetInboxChatsListResponses = {
1929
1943
  * 14 : Scheduled Call Cancelled
1930
1944
  * 15 : Scheduled Call Started
1931
1945
  * 16 : Announcement
1946
+ * 17 : Content mention
1932
1947
  *
1933
1948
  */
1934
- event_type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16;
1949
+ event_type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17;
1935
1950
  event_metadata?: {
1936
1951
  /**
1937
1952
  * The updated title.
@@ -2147,6 +2162,19 @@ export type GetInboxChatsListResponses = {
2147
2162
  */
2148
2163
  message_id: string;
2149
2164
  };
2165
+ /**
2166
+ * Content Relation
2167
+ */
2168
+ content_relation?: {
2169
+ /**
2170
+ * How this message relates to a piece of shared content: a normal reply to it, or a provider-generated notice that the current user was mentioned in it.
2171
+ */
2172
+ type: 'reply_to' | 'mentioned_in';
2173
+ /**
2174
+ * The id of this message's shared-content attachment describing the related content, when the provider still makes it available. Absent once the content is no longer retrievable (e.g. an expired story) but the relation is still known.
2175
+ */
2176
+ attachment_id?: string;
2177
+ };
2150
2178
  /**
2151
2179
  * A list of reactions to the element.
2152
2180
  */
@@ -3556,9 +3584,10 @@ export type GetChatResponses = {
3556
3584
  * 14 : Scheduled Call Cancelled
3557
3585
  * 15 : Scheduled Call Started
3558
3586
  * 16 : Announcement
3587
+ * 17 : Content mention
3559
3588
  *
3560
3589
  */
3561
- event_type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16;
3590
+ event_type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17;
3562
3591
  event_metadata?: {
3563
3592
  /**
3564
3593
  * The updated title.
@@ -3774,6 +3803,19 @@ export type GetChatResponses = {
3774
3803
  */
3775
3804
  message_id: string;
3776
3805
  };
3806
+ /**
3807
+ * Content Relation
3808
+ */
3809
+ content_relation?: {
3810
+ /**
3811
+ * How this message relates to a piece of shared content: a normal reply to it, or a provider-generated notice that the current user was mentioned in it.
3812
+ */
3813
+ type: 'reply_to' | 'mentioned_in';
3814
+ /**
3815
+ * The id of this message's shared-content attachment describing the related content, when the provider still makes it available. Absent once the content is no longer retrievable (e.g. an expired story) but the relation is still known.
3816
+ */
3817
+ attachment_id?: string;
3818
+ };
3777
3819
  /**
3778
3820
  * A list of reactions to the element.
3779
3821
  */
@@ -5244,9 +5286,10 @@ export type UpdateChatResponses = {
5244
5286
  * 14 : Scheduled Call Cancelled
5245
5287
  * 15 : Scheduled Call Started
5246
5288
  * 16 : Announcement
5289
+ * 17 : Content mention
5247
5290
  *
5248
5291
  */
5249
- event_type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16;
5292
+ event_type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17;
5250
5293
  event_metadata?: {
5251
5294
  /**
5252
5295
  * The updated title.
@@ -5462,6 +5505,19 @@ export type UpdateChatResponses = {
5462
5505
  */
5463
5506
  message_id: string;
5464
5507
  };
5508
+ /**
5509
+ * Content Relation
5510
+ */
5511
+ content_relation?: {
5512
+ /**
5513
+ * How this message relates to a piece of shared content: a normal reply to it, or a provider-generated notice that the current user was mentioned in it.
5514
+ */
5515
+ type: 'reply_to' | 'mentioned_in';
5516
+ /**
5517
+ * The id of this message's shared-content attachment describing the related content, when the provider still makes it available. Absent once the content is no longer retrievable (e.g. an expired story) but the relation is still known.
5518
+ */
5519
+ attachment_id?: string;
5520
+ };
5465
5521
  /**
5466
5522
  * A list of reactions to the element.
5467
5523
  */
@@ -6978,7 +7034,7 @@ export type GetMessagesListData = {
6978
7034
  */
6979
7035
  cursor?: string;
6980
7036
  /**
6981
- * The limit of items to be returned. The maximum allowed value depends on the provider.
7037
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
6982
7038
  */
6983
7039
  limit?: number;
6984
7040
  };
@@ -7066,9 +7122,10 @@ export type GetMessagesListResponses = {
7066
7122
  * 14 : Scheduled Call Cancelled
7067
7123
  * 15 : Scheduled Call Started
7068
7124
  * 16 : Announcement
7125
+ * 17 : Content mention
7069
7126
  *
7070
7127
  */
7071
- event_type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16;
7128
+ event_type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17;
7072
7129
  event_metadata?: {
7073
7130
  /**
7074
7131
  * The updated title.
@@ -7284,6 +7341,19 @@ export type GetMessagesListResponses = {
7284
7341
  */
7285
7342
  message_id: string;
7286
7343
  };
7344
+ /**
7345
+ * Content Relation
7346
+ */
7347
+ content_relation?: {
7348
+ /**
7349
+ * How this message relates to a piece of shared content: a normal reply to it, or a provider-generated notice that the current user was mentioned in it.
7350
+ */
7351
+ type: 'reply_to' | 'mentioned_in';
7352
+ /**
7353
+ * The id of this message's shared-content attachment describing the related content, when the provider still makes it available. Absent once the content is no longer retrievable (e.g. an expired story) but the relation is still known.
7354
+ */
7355
+ attachment_id?: string;
7356
+ };
7287
7357
  /**
7288
7358
  * A list of reactions to the element.
7289
7359
  */
@@ -8519,9 +8589,10 @@ export type GetMessageResponses = {
8519
8589
  * 14 : Scheduled Call Cancelled
8520
8590
  * 15 : Scheduled Call Started
8521
8591
  * 16 : Announcement
8592
+ * 17 : Content mention
8522
8593
  *
8523
8594
  */
8524
- event_type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16;
8595
+ event_type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17;
8525
8596
  event_metadata?: {
8526
8597
  /**
8527
8598
  * The updated title.
@@ -8737,6 +8808,19 @@ export type GetMessageResponses = {
8737
8808
  */
8738
8809
  message_id: string;
8739
8810
  };
8811
+ /**
8812
+ * Content Relation
8813
+ */
8814
+ content_relation?: {
8815
+ /**
8816
+ * How this message relates to a piece of shared content: a normal reply to it, or a provider-generated notice that the current user was mentioned in it.
8817
+ */
8818
+ type: 'reply_to' | 'mentioned_in';
8819
+ /**
8820
+ * The id of this message's shared-content attachment describing the related content, when the provider still makes it available. Absent once the content is no longer retrievable (e.g. an expired story) but the relation is still known.
8821
+ */
8822
+ attachment_id?: string;
8823
+ };
8740
8824
  /**
8741
8825
  * A list of reactions to the element.
8742
8826
  */
@@ -10057,9 +10141,10 @@ export type ModifyMessageResponses = {
10057
10141
  * 14 : Scheduled Call Cancelled
10058
10142
  * 15 : Scheduled Call Started
10059
10143
  * 16 : Announcement
10144
+ * 17 : Content mention
10060
10145
  *
10061
10146
  */
10062
- event_type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16;
10147
+ event_type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17;
10063
10148
  event_metadata?: {
10064
10149
  /**
10065
10150
  * The updated title.
@@ -10275,6 +10360,19 @@ export type ModifyMessageResponses = {
10275
10360
  */
10276
10361
  message_id: string;
10277
10362
  };
10363
+ /**
10364
+ * Content Relation
10365
+ */
10366
+ content_relation?: {
10367
+ /**
10368
+ * How this message relates to a piece of shared content: a normal reply to it, or a provider-generated notice that the current user was mentioned in it.
10369
+ */
10370
+ type: 'reply_to' | 'mentioned_in';
10371
+ /**
10372
+ * The id of this message's shared-content attachment describing the related content, when the provider still makes it available. Absent once the content is no longer retrievable (e.g. an expired story) but the relation is still known.
10373
+ */
10374
+ attachment_id?: string;
10375
+ };
10278
10376
  /**
10279
10377
  * A list of reactions to the element.
10280
10378
  */
@@ -11243,7 +11341,7 @@ export type GetParticipantsListData = {
11243
11341
  */
11244
11342
  cursor?: string;
11245
11343
  /**
11246
- * The limit of items to be returned. The maximum allowed value depends on the provider.
11344
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
11247
11345
  */
11248
11346
  limit?: number;
11249
11347
  };
@@ -11501,7 +11599,7 @@ export type GetMessageReactionsListData = {
11501
11599
  */
11502
11600
  cursor?: string;
11503
11601
  /**
11504
- * The limit of items to be returned. The maximum allowed value depends on the provider.
11602
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
11505
11603
  */
11506
11604
  limit?: number;
11507
11605
  };
@@ -11824,7 +11922,7 @@ export type GetEmailsListData = {
11824
11922
  */
11825
11923
  cursor?: string;
11826
11924
  /**
11827
- * The limit of items to be returned. The maximum allowed value depends on the provider.
11925
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
11828
11926
  */
11829
11927
  limit?: number;
11830
11928
  };
@@ -12262,7 +12360,7 @@ export type GetFolderEmailsListData = {
12262
12360
  */
12263
12361
  cursor?: string;
12264
12362
  /**
12265
- * The limit of items to be returned. The maximum allowed value depends on the provider.
12363
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
12266
12364
  */
12267
12365
  limit?: number;
12268
12366
  };
@@ -14068,7 +14166,7 @@ export type GetDraftsListData = {
14068
14166
  */
14069
14167
  cursor?: string;
14070
14168
  /**
14071
- * The limit of items to be returned. The maximum allowed value depends on the provider.
14169
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
14072
14170
  */
14073
14171
  limit?: number;
14074
14172
  };
@@ -15775,7 +15873,7 @@ export type GetFoldersListData = {
15775
15873
  */
15776
15874
  cursor?: string;
15777
15875
  /**
15778
- * The limit of items to be returned. The maximum allowed value depends on the provider.
15876
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
15779
15877
  */
15780
15878
  limit?: number;
15781
15879
  };
@@ -16140,7 +16238,7 @@ export type GetContactsListData = {
16140
16238
  */
16141
16239
  cursor?: string;
16142
16240
  /**
16143
- * The limit of items to be returned. The maximum allowed value depends on the provider.
16241
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
16144
16242
  */
16145
16243
  limit?: number;
16146
16244
  };
@@ -16600,6 +16698,10 @@ export type GetUserProfileResponses = {
16600
16698
  * LinkedIn internal member ID of the user.
16601
16699
  */
16602
16700
  member_id?: string;
16701
+ /**
16702
+ * The industry of the user's current company.
16703
+ */
16704
+ industry?: string;
16603
16705
  /**
16604
16706
  * Whether the user can be reached with inmails.
16605
16707
  */
@@ -18739,23 +18841,23 @@ export type GetUserProfileResponse = GetUserProfileResponses[keyof GetUserProfil
18739
18841
  export type UpdateUserProfileData = {
18740
18842
  body?: {
18741
18843
  /**
18742
- * The first name of the User.
18844
+ * The first name of the User. Updating this field is not supported by LinkedIn.
18743
18845
  */
18744
18846
  first_name?: string;
18745
18847
  /**
18746
- * The last name of the User.
18848
+ * The last name of the User. Updating this field is not supported by LinkedIn.
18747
18849
  */
18748
18850
  last_name?: string;
18749
18851
  /**
18750
- * Description of the User.
18852
+ * Description of the User. Updating this field is not supported by LinkedIn.
18751
18853
  */
18752
18854
  description?: string;
18753
18855
  /**
18754
- * Location of the User.
18856
+ * Location of the User. Omit it to leave it unchanged.
18755
18857
  */
18756
18858
  location?: string;
18757
18859
  /**
18758
- * Bio / About section of the profile.
18860
+ * Bio / About section. Omit it to leave it unchanged or use an empty string to clear it.
18759
18861
  */
18760
18862
  bio?: string;
18761
18863
  /**
@@ -18812,11 +18914,11 @@ export type UpdateUserProfileData = {
18812
18914
  };
18813
18915
  specifics?: unknown & {
18814
18916
  /**
18815
- * Specific options to apply if the provider of the targeted account is Linkedin
18917
+ * LinkedIn profile mutations. Omitted properties remain unchanged; values replace existing values; empty strings clear supported text fields; null deletes nullable singleton resources.
18816
18918
  */
18817
18919
  linkedin?: {
18818
18920
  /**
18819
- * List of skills to add to the profile.
18921
+ * Skills to add directly to the profile. This field is independent from `experience.skills` and `education.skills`; only send the field that matches the intended target. Existing skills remain untouched and removing skills is not supported by the provider.
18820
18922
  */
18821
18923
  skills?: Array<{
18822
18924
  name: string;
@@ -18826,7 +18928,7 @@ export type UpdateUserProfileData = {
18826
18928
  id?: string;
18827
18929
  }>;
18828
18930
  /**
18829
- * Check "Follow this skill to keep up with relevant content."
18931
+ * Whether to follow the profile-level skills supplied in `skills`. It does not apply to experience or education skills.
18830
18932
  */
18831
18933
  skills_follow?: boolean;
18832
18934
  /**
@@ -18834,7 +18936,7 @@ export type UpdateUserProfileData = {
18834
18936
  */
18835
18937
  postal_code?: string;
18836
18938
  /**
18837
- * Headline of the profile.
18939
+ * Headline. Omit it to leave it unchanged or use an empty string to clear it.
18838
18940
  */
18839
18941
  headline?: string;
18840
18942
  experience?: {
@@ -18915,7 +19017,7 @@ export type UpdateUserProfileData = {
18915
19017
  */
18916
19018
  source_of_hire?: 'INDEED' | 'LINKEDIN' | 'COMPANY_WEBSITE' | 'OTHER_JOB_SITES' | 'REFERRAL' | 'CONTACTED_BY_RECRUITER' | 'STAFFING_AGENCY' | 'OTHER';
18917
19019
  /**
18918
- * List of skills. We recommend adding your top 5 used in this role. They’ll also appear in your profile Skills section.
19020
+ * Skills to associate with this experience. Use this field only inside `experience`; it is independent from the profile-level and education `skills` fields. These skills also appear in the profile Skills section.
18919
19021
  */
18920
19022
  skills?: Array<{
18921
19023
  name: string;
@@ -19080,7 +19182,7 @@ export type UpdateUserProfileData = {
19080
19182
  */
19081
19183
  source_of_hire?: 'INDEED' | 'LINKEDIN' | 'COMPANY_WEBSITE' | 'OTHER_JOB_SITES' | 'REFERRAL' | 'CONTACTED_BY_RECRUITER' | 'STAFFING_AGENCY' | 'OTHER';
19082
19184
  /**
19083
- * List of skills. We recommend adding your top 5 used in this role. They’ll also appear in your profile Skills section.
19185
+ * Skills to associate with this experience. Use this field only inside `experience`; it is independent from the profile-level and education `skills` fields. These skills also appear in the profile Skills section.
19084
19186
  */
19085
19187
  skills?: Array<{
19086
19188
  name: string;
@@ -19171,6 +19273,12 @@ export type UpdateUserProfileData = {
19171
19273
  * ID of the experience to edit.
19172
19274
  */
19173
19275
  id: string;
19276
+ } | {
19277
+ operation: 'delete';
19278
+ /**
19279
+ * ID of the experience to delete.
19280
+ */
19281
+ id: string;
19174
19282
  };
19175
19283
  education?: {
19176
19284
  /**
@@ -19246,7 +19354,7 @@ export type UpdateUserProfileData = {
19246
19354
  */
19247
19355
  description?: string;
19248
19356
  /**
19249
- * List of skills. We recommend adding your top 5 used in this training. They’ll also appear in your profile Skills section.
19357
+ * Skills to associate with this education entry. Use this field only inside `education`; it is independent from the profile-level and experience `skills` fields. These skills also appear in the profile Skills section.
19250
19358
  */
19251
19359
  skills?: Array<{
19252
19360
  name: string;
@@ -19407,7 +19515,7 @@ export type UpdateUserProfileData = {
19407
19515
  */
19408
19516
  description?: string;
19409
19517
  /**
19410
- * List of skills. We recommend adding your top 5 used in this training. They’ll also appear in your profile Skills section.
19518
+ * Skills to associate with this education entry. Use this field only inside `education`; it is independent from the profile-level and experience `skills` fields. These skills also appear in the profile Skills section.
19411
19519
  */
19412
19520
  skills?: Array<{
19413
19521
  name: string;
@@ -19498,6 +19606,12 @@ export type UpdateUserProfileData = {
19498
19606
  * ID of the education to edit.
19499
19607
  */
19500
19608
  id: string;
19609
+ } | {
19610
+ operation: 'delete';
19611
+ /**
19612
+ * ID of the education to delete.
19613
+ */
19614
+ id: string;
19501
19615
  };
19502
19616
  picture_options?: {
19503
19617
  /**
@@ -19646,7 +19760,7 @@ export type UpdateUserProfileData = {
19646
19760
  * Whether the link should be displayed everywhere or only on the profile.
19647
19761
  */
19648
19762
  display_on?: 'PROFILE_ONLY' | 'EVERYWHERE';
19649
- };
19763
+ } | null;
19650
19764
  open_to_work?: {
19651
19765
  /**
19652
19766
  * A list of job titles you would like to hold.
@@ -19686,7 +19800,7 @@ export type UpdateUserProfileData = {
19686
19800
  * Who can view that you are open to work.
19687
19801
  */
19688
19802
  visibility: 'ALL' | 'RECRUITERS_ONLY';
19689
- };
19803
+ } | null;
19690
19804
  };
19691
19805
  };
19692
19806
  };
@@ -19760,7 +19874,7 @@ export type GetUserRelationsData = {
19760
19874
  */
19761
19875
  cursor?: string;
19762
19876
  /**
19763
- * The limit of items to be returned. The maximum allowed value depends on the provider.
19877
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
19764
19878
  */
19765
19879
  limit?: number;
19766
19880
  };
@@ -19951,7 +20065,7 @@ export type GetRelationRequestsListData = {
19951
20065
  */
19952
20066
  cursor?: string;
19953
20067
  /**
19954
- * The limit of items to be returned. The maximum allowed value depends on the provider.
20068
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
19955
20069
  */
19956
20070
  limit?: number;
19957
20071
  };
@@ -20332,7 +20446,7 @@ export type ListUserFollowersData = {
20332
20446
  */
20333
20447
  cursor?: string;
20334
20448
  /**
20335
- * The limit of items to be returned. The maximum allowed value depends on the provider.
20449
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
20336
20450
  */
20337
20451
  limit?: number;
20338
20452
  };
@@ -20485,7 +20599,7 @@ export type ListUserFollowingData = {
20485
20599
  */
20486
20600
  cursor?: string;
20487
20601
  /**
20488
- * The limit of items to be returned. The maximum allowed value depends on the provider.
20602
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
20489
20603
  */
20490
20604
  limit?: number;
20491
20605
  };
@@ -20818,7 +20932,7 @@ export type GetPostsListData = {
20818
20932
  */
20819
20933
  cursor?: string;
20820
20934
  /**
20821
- * The limit of items to be returned. The maximum allowed value depends on the provider.
20935
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
20822
20936
  */
20823
20937
  limit?: number;
20824
20938
  };
@@ -21996,6 +22110,20 @@ export type GetPostsListResponses = {
21996
22110
  * Object containing provider-specific post data.
21997
22111
  */
21998
22112
  specifics?: {
22113
+ mentions?: Array<{
22114
+ /**
22115
+ * Public URL targeted by the mention.
22116
+ */
22117
+ url: string;
22118
+ /**
22119
+ * Start index of the mention in the post text.
22120
+ */
22121
+ start: number;
22122
+ /**
22123
+ * Length of the mention in the post text.
22124
+ */
22125
+ length: number;
22126
+ }>;
21999
22127
  /**
22000
22128
  * A job posting that can be included as an insert in the post.
22001
22129
  */
@@ -22069,6 +22197,20 @@ export type GetPostsListResponses = {
22069
22197
  * Object containing provider-specific post data.
22070
22198
  */
22071
22199
  specifics?: {
22200
+ mentions?: Array<{
22201
+ /**
22202
+ * Public URL targeted by the mention.
22203
+ */
22204
+ url: string;
22205
+ /**
22206
+ * Start index of the mention in the post text.
22207
+ */
22208
+ start: number;
22209
+ /**
22210
+ * Length of the mention in the post text.
22211
+ */
22212
+ length: number;
22213
+ }>;
22072
22214
  /**
22073
22215
  * A job posting that can be included as an insert in the post.
22074
22216
  */
@@ -23357,6 +23499,20 @@ export type GetPostResponses = {
23357
23499
  * Object containing provider-specific post data.
23358
23500
  */
23359
23501
  specifics?: {
23502
+ mentions?: Array<{
23503
+ /**
23504
+ * Public URL targeted by the mention.
23505
+ */
23506
+ url: string;
23507
+ /**
23508
+ * Start index of the mention in the post text.
23509
+ */
23510
+ start: number;
23511
+ /**
23512
+ * Length of the mention in the post text.
23513
+ */
23514
+ length: number;
23515
+ }>;
23360
23516
  /**
23361
23517
  * A job posting that can be included as an insert in the post.
23362
23518
  */
@@ -23430,6 +23586,20 @@ export type GetPostResponses = {
23430
23586
  * Object containing provider-specific post data.
23431
23587
  */
23432
23588
  specifics?: {
23589
+ mentions?: Array<{
23590
+ /**
23591
+ * Public URL targeted by the mention.
23592
+ */
23593
+ url: string;
23594
+ /**
23595
+ * Start index of the mention in the post text.
23596
+ */
23597
+ start: number;
23598
+ /**
23599
+ * Length of the mention in the post text.
23600
+ */
23601
+ length: number;
23602
+ }>;
23433
23603
  /**
23434
23604
  * A job posting that can be included as an insert in the post.
23435
23605
  */
@@ -25654,7 +25824,7 @@ export type GetPostReactionsListData = {
25654
25824
  */
25655
25825
  cursor?: string;
25656
25826
  /**
25657
- * The limit of items to be returned. The maximum allowed value depends on the provider.
25827
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
25658
25828
  */
25659
25829
  limit?: number;
25660
25830
  };
@@ -25848,7 +26018,7 @@ export type GetPostCommentsListData = {
25848
26018
  */
25849
26019
  cursor?: string;
25850
26020
  /**
25851
- * The limit of items to be returned. The maximum allowed value depends on the provider.
26021
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
25852
26022
  */
25853
26023
  limit?: number;
25854
26024
  /**
@@ -27467,7 +27637,7 @@ export type GetPostCommentRepliesListData = {
27467
27637
  */
27468
27638
  cursor?: string;
27469
27639
  /**
27470
- * The limit of items to be returned. The maximum allowed value depends on the provider.
27640
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
27471
27641
  */
27472
27642
  limit?: number;
27473
27643
  };
@@ -27938,7 +28108,7 @@ export type GetPostCommentReactionsListData = {
27938
28108
  */
27939
28109
  cursor?: string;
27940
28110
  /**
27941
- * The limit of items to be returned. The maximum allowed value depends on the provider.
28111
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
27942
28112
  */
27943
28113
  limit?: number;
27944
28114
  };
@@ -28136,7 +28306,7 @@ export type GetUserCommentsListData = {
28136
28306
  */
28137
28307
  cursor?: string;
28138
28308
  /**
28139
- * The limit of items to be returned. The maximum allowed value depends on the provider.
28309
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
28140
28310
  */
28141
28311
  limit?: number;
28142
28312
  };
@@ -29843,6 +30013,20 @@ export type GetUserCommentsListResponses = {
29843
30013
  * Object containing provider-specific post data.
29844
30014
  */
29845
30015
  specifics?: {
30016
+ mentions?: Array<{
30017
+ /**
30018
+ * Public URL targeted by the mention.
30019
+ */
30020
+ url: string;
30021
+ /**
30022
+ * Start index of the mention in the post text.
30023
+ */
30024
+ start: number;
30025
+ /**
30026
+ * Length of the mention in the post text.
30027
+ */
30028
+ length: number;
30029
+ }>;
29846
30030
  /**
29847
30031
  * A job posting that can be included as an insert in the post.
29848
30032
  */
@@ -29916,6 +30100,20 @@ export type GetUserCommentsListResponses = {
29916
30100
  * Object containing provider-specific post data.
29917
30101
  */
29918
30102
  specifics?: {
30103
+ mentions?: Array<{
30104
+ /**
30105
+ * Public URL targeted by the mention.
30106
+ */
30107
+ url: string;
30108
+ /**
30109
+ * Start index of the mention in the post text.
30110
+ */
30111
+ start: number;
30112
+ /**
30113
+ * Length of the mention in the post text.
30114
+ */
30115
+ length: number;
30116
+ }>;
29919
30117
  /**
29920
30118
  * A job posting that can be included as an insert in the post.
29921
30119
  */
@@ -30019,7 +30217,7 @@ export type GetUserReactionsListData = {
30019
30217
  */
30020
30218
  cursor?: string;
30021
30219
  /**
30022
- * The limit of items to be returned. The maximum allowed value depends on the provider.
30220
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
30023
30221
  */
30024
30222
  limit?: number;
30025
30223
  };
@@ -31453,6 +31651,20 @@ export type GetUserReactionsListResponses = {
31453
31651
  * Object containing provider-specific post data.
31454
31652
  */
31455
31653
  specifics?: {
31654
+ mentions?: Array<{
31655
+ /**
31656
+ * Public URL targeted by the mention.
31657
+ */
31658
+ url: string;
31659
+ /**
31660
+ * Start index of the mention in the post text.
31661
+ */
31662
+ start: number;
31663
+ /**
31664
+ * Length of the mention in the post text.
31665
+ */
31666
+ length: number;
31667
+ }>;
31456
31668
  /**
31457
31669
  * A job posting that can be included as an insert in the post.
31458
31670
  */
@@ -31526,6 +31738,20 @@ export type GetUserReactionsListResponses = {
31526
31738
  * Object containing provider-specific post data.
31527
31739
  */
31528
31740
  specifics?: {
31741
+ mentions?: Array<{
31742
+ /**
31743
+ * Public URL targeted by the mention.
31744
+ */
31745
+ url: string;
31746
+ /**
31747
+ * Start index of the mention in the post text.
31748
+ */
31749
+ start: number;
31750
+ /**
31751
+ * Length of the mention in the post text.
31752
+ */
31753
+ length: number;
31754
+ }>;
31529
31755
  /**
31530
31756
  * A job posting that can be included as an insert in the post.
31531
31757
  */
@@ -31625,7 +31851,7 @@ export type GetCalendarsListData = {
31625
31851
  */
31626
31852
  cursor?: string;
31627
31853
  /**
31628
- * The limit of items to be returned. The maximum allowed value depends on the provider.
31854
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
31629
31855
  */
31630
31856
  limit?: number;
31631
31857
  };
@@ -32008,7 +32234,7 @@ export type GetCalendarEventListData = {
32008
32234
  */
32009
32235
  cursor?: string;
32010
32236
  /**
32011
- * The limit of items to be returned. The maximum allowed value depends on the provider.
32237
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
32012
32238
  */
32013
32239
  limit?: number;
32014
32240
  };
@@ -32194,7 +32420,18 @@ export type GetCalendarEventListResponses = {
32194
32420
  */
32195
32421
  provider: 'google_meet' | 'zoom' | 'skype' | 'teams' | 'unknown';
32196
32422
  /**
32197
- * The conference URL.
32423
+ * How the conference is attached to the event.
32424
+ * - `native`: hosted by the calendar provider (Microsoft Teams or Skype on Outlook, Google Meet on Google). The
32425
+ * provider owns the meeting and `url` is its join link.
32426
+ * - `description`: an existing conference attached by URL, whose join link is published in the event body.
32427
+ */
32428
+ hosting: 'native' | 'description';
32429
+ /**
32430
+ * The conference identifier assigned by its provider.
32431
+ */
32432
+ conference_id?: string;
32433
+ /**
32434
+ * The URL used to join the conference.
32198
32435
  */
32199
32436
  url: string;
32200
32437
  };
@@ -32272,20 +32509,28 @@ export type CreateCalendarEventData = {
32272
32509
  * - `private` is visible only to the calendar owner.
32273
32510
  */
32274
32511
  visibility?: 'public' | 'private';
32512
+ /**
32513
+ * A conference to generate or attach to the event.
32514
+ * The way the conference is associated with the event may vary depending on the calendar and the selected provider:
32515
+ * it can be generated and hosted natively by the provider (e.g. Google Meet on Google, Microsoft Teams or Skype on
32516
+ * Outlook), or, when a "url" is provided, attached as an existing conference whose join link is published in the
32517
+ * event body.
32518
+ */
32275
32519
  conference?: {
32276
32520
  /**
32277
- * The conference provider.
32278
- * - `google_meet` is a Google Meet conference.
32279
- * - `zoom` is a Zoom conference.
32280
- * - `skype` is a Skype conference.
32281
- * - `teams` is a Microsoft Teams conference.
32282
- * - `unknown` is an unknown conference provider.
32521
+ * The conference provider to generate or attach.
32283
32522
  */
32284
32523
  provider: 'google_meet' | 'zoom' | 'skype' | 'teams' | 'unknown';
32285
32524
  /**
32286
- * The conference URL.
32525
+ * The conference identifier assigned by its provider.
32287
32526
  */
32288
- url: string;
32527
+ conference_id?: string;
32528
+ /**
32529
+ * The URL of an existing conference to attach to the event. Must be an absolute credential-free HTTPS URL.
32530
+ * When omitted, conference generation is requested. Availability depends on the calendar and the selected provider;
32531
+ * when generation is not supported, provide the URL of an existing conference.
32532
+ */
32533
+ url?: string;
32289
32534
  };
32290
32535
  /**
32291
32536
  * Is the attendees list hidden for attendees.
@@ -32361,6 +32606,13 @@ export type CreateCalendarEventData = {
32361
32606
  */
32362
32607
  timezone?: string;
32363
32608
  };
32609
+ /**
32610
+ * Only available for google, guests to send updates to:
32611
+ * - `all`: Notify all guests.
32612
+ * - `externalOnly`: Notify only guests not on the calendar's domain.
32613
+ * - `none`: Do not notify any guests.
32614
+ */
32615
+ notify?: 'all' | 'externalOnly' | 'none';
32364
32616
  /**
32365
32617
  * The IANA timezone the event is expressed in (e.g. `Europe/Paris`). Defaults to UTC when omitted.
32366
32618
  */
@@ -32558,7 +32810,18 @@ export type CreateCalendarEventResponses = {
32558
32810
  */
32559
32811
  provider: 'google_meet' | 'zoom' | 'skype' | 'teams' | 'unknown';
32560
32812
  /**
32561
- * The conference URL.
32813
+ * How the conference is attached to the event.
32814
+ * - `native`: hosted by the calendar provider (Microsoft Teams or Skype on Outlook, Google Meet on Google). The
32815
+ * provider owns the meeting and `url` is its join link.
32816
+ * - `description`: an existing conference attached by URL, whose join link is published in the event body.
32817
+ */
32818
+ hosting: 'native' | 'description';
32819
+ /**
32820
+ * The conference identifier assigned by its provider.
32821
+ */
32822
+ conference_id?: string;
32823
+ /**
32824
+ * The URL used to join the conference.
32562
32825
  */
32563
32826
  url: string;
32564
32827
  };
@@ -32821,7 +33084,18 @@ export type GetCalendarEventResponses = {
32821
33084
  */
32822
33085
  provider: 'google_meet' | 'zoom' | 'skype' | 'teams' | 'unknown';
32823
33086
  /**
32824
- * The conference URL.
33087
+ * How the conference is attached to the event.
33088
+ * - `native`: hosted by the calendar provider (Microsoft Teams or Skype on Outlook, Google Meet on Google). The
33089
+ * provider owns the meeting and `url` is its join link.
33090
+ * - `description`: an existing conference attached by URL, whose join link is published in the event body.
33091
+ */
33092
+ hosting: 'native' | 'description';
33093
+ /**
33094
+ * The conference identifier assigned by its provider.
33095
+ */
33096
+ conference_id?: string;
33097
+ /**
33098
+ * The URL used to join the conference.
32825
33099
  */
32826
33100
  url: string;
32827
33101
  };
@@ -32890,21 +33164,25 @@ export type UpdateCalendarEventData = {
32890
33164
  * - `private` is visible only to the calendar owner.
32891
33165
  */
32892
33166
  visibility?: 'public' | 'private';
33167
+ /**
33168
+ * A conference to generate or attach, or `null` to remove the conference currently on the event.
33169
+ */
32893
33170
  conference?: {
32894
33171
  /**
32895
- * The conference provider.
32896
- * - `google_meet` is a Google Meet conference.
32897
- * - `zoom` is a Zoom conference.
32898
- * - `skype` is a Skype conference.
32899
- * - `teams` is a Microsoft Teams conference.
32900
- * - `unknown` is an unknown conference provider.
33172
+ * The conference provider to generate or attach.
32901
33173
  */
32902
33174
  provider: 'google_meet' | 'zoom' | 'skype' | 'teams' | 'unknown';
32903
33175
  /**
32904
- * The conference URL.
33176
+ * The conference identifier assigned by its provider.
32905
33177
  */
32906
- url: string;
32907
- };
33178
+ conference_id?: string;
33179
+ /**
33180
+ * The URL of an existing conference to attach to the event. Must be an absolute credential-free HTTPS URL.
33181
+ * When omitted, conference generation is requested. Availability depends on the calendar and the selected provider;
33182
+ * when generation is not supported, provide the URL of an existing conference.
33183
+ */
33184
+ url?: string;
33185
+ } | null;
32908
33186
  /**
32909
33187
  * Is the attendees list hidden for attendees.
32910
33188
  */
@@ -33187,7 +33465,18 @@ export type UpdateCalendarEventResponses = {
33187
33465
  */
33188
33466
  provider: 'google_meet' | 'zoom' | 'skype' | 'teams' | 'unknown';
33189
33467
  /**
33190
- * The conference URL.
33468
+ * How the conference is attached to the event.
33469
+ * - `native`: hosted by the calendar provider (Microsoft Teams or Skype on Outlook, Google Meet on Google). The
33470
+ * provider owns the meeting and `url` is its join link.
33471
+ * - `description`: an existing conference attached by URL, whose join link is published in the event body.
33472
+ */
33473
+ hosting: 'native' | 'description';
33474
+ /**
33475
+ * The conference identifier assigned by its provider.
33476
+ */
33477
+ conference_id?: string;
33478
+ /**
33479
+ * The URL used to join the conference.
33191
33480
  */
33192
33481
  url: string;
33193
33482
  };
@@ -33903,7 +34192,7 @@ export type GetClassicSearchParametersData = {
33903
34192
  */
33904
34193
  offset?: number;
33905
34194
  /**
33906
- * The limit of items to be returned. The maximum allowed value depends on the provider.
34195
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
33907
34196
  */
33908
34197
  limit?: number;
33909
34198
  };
@@ -33975,7 +34264,7 @@ export type PerformClassicSearchFromUrlData = {
33975
34264
  */
33976
34265
  offset?: number;
33977
34266
  /**
33978
- * The limit of items to be returned. The maximum allowed value depends on the provider.
34267
+ * The maximum number of items to return. Sales Navigator and Recruiter support up to 100 results. For Classic searches, People and Companies are limited to 10 results per page, while Jobs are limited to 50. Post searches default to 3 results, matching LinkedIn's UI, but the limit can technically be increased up to 49.
33979
34268
  */
33980
34269
  limit?: number;
33981
34270
  /**
@@ -35551,13 +35840,9 @@ export type PerformClassicCompaniesSearchData = {
35551
35840
  };
35552
35841
  query?: {
35553
35842
  /**
35554
- * An offset used for pagination.
35555
- */
35556
- offset?: number;
35557
- /**
35558
- * The limit of items to be returned. The maximum allowed value depends on the provider.
35843
+ * A cursor used for pagination. Use `next_cursor` given by the previous page of the list.
35559
35844
  */
35560
- limit?: number;
35845
+ cursor?: string;
35561
35846
  };
35562
35847
  url: '/v2/{account_id}/linkedin/search/companies';
35563
35848
  };
@@ -35752,11 +36037,11 @@ export type PerformClassicPostsSearchData = {
35752
36037
  };
35753
36038
  query?: {
35754
36039
  /**
35755
- * An offset used for pagination.
36040
+ * A cursor used for pagination. Use `next_cursor` given by the previous page of the list.
35756
36041
  */
35757
- offset?: number;
36042
+ cursor?: string;
35758
36043
  /**
35759
- * The limit of items to be returned. The maximum allowed value depends on the provider.
36044
+ * The maximum number of posts to return. Post searches default to 3 results, matching LinkedIn's UI, but the limit can technically be increased up to 49.
35760
36045
  */
35761
36046
  limit?: number;
35762
36047
  };
@@ -36947,7 +37232,7 @@ export type PerformClassicJobsSearchData = {
36947
37232
  */
36948
37233
  offset?: number;
36949
37234
  /**
36950
- * The limit of items to be returned. The maximum allowed value depends on the provider.
37235
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
36951
37236
  */
36952
37237
  limit?: number;
36953
37238
  };
@@ -37061,7 +37346,7 @@ export type ListClassicUserJobPostingsData = {
37061
37346
  */
37062
37347
  offset?: number;
37063
37348
  /**
37064
- * The limit of items to be returned. The maximum allowed value depends on the provider.
37349
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
37065
37350
  */
37066
37351
  limit?: number;
37067
37352
  };
@@ -37855,7 +38140,7 @@ export type GetClassicApplicantsData = {
37855
38140
  */
37856
38141
  offset?: number;
37857
38142
  /**
37858
- * The limit of items to be returned. The maximum allowed value depends on the provider.
38143
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
37859
38144
  */
37860
38145
  limit?: number;
37861
38146
  };
@@ -38349,7 +38634,7 @@ export type GetRecruiterHiringProjectListData = {
38349
38634
  */
38350
38635
  offset?: number;
38351
38636
  /**
38352
- * The limit of items to be returned. The maximum allowed value depends on the provider.
38637
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
38353
38638
  */
38354
38639
  limit?: number;
38355
38640
  };
@@ -38409,7 +38694,7 @@ export type GetRecruiterHiringProjectListResponses = {
38409
38694
  /**
38410
38695
  * The name of the Project owner.
38411
38696
  */
38412
- name: string;
38697
+ name?: string;
38413
38698
  /**
38414
38699
  * The email address of the Project owner.
38415
38700
  */
@@ -38417,11 +38702,11 @@ export type GetRecruiterHiringProjectListResponses = {
38417
38702
  /**
38418
38703
  * The profile URL of the Project owner.
38419
38704
  */
38420
- profile_url: string;
38705
+ profile_url?: string;
38421
38706
  /**
38422
38707
  * The profile headline of the Project owner.
38423
38708
  */
38424
- profile_headline: string;
38709
+ profile_headline?: string;
38425
38710
  /**
38426
38711
  * The profile picture URL of the Project owner.
38427
38712
  */
@@ -38741,7 +39026,7 @@ export type GetRecruiterHiringProjectResponses = {
38741
39026
  /**
38742
39027
  * The name of the Project owner.
38743
39028
  */
38744
- name: string;
39029
+ name?: string;
38745
39030
  /**
38746
39031
  * The email address of the Project owner.
38747
39032
  */
@@ -38749,11 +39034,11 @@ export type GetRecruiterHiringProjectResponses = {
38749
39034
  /**
38750
39035
  * The profile URL of the Project owner.
38751
39036
  */
38752
- profile_url: string;
39037
+ profile_url?: string;
38753
39038
  /**
38754
39039
  * The profile headline of the Project owner.
38755
39040
  */
38756
- profile_headline: string;
39041
+ profile_headline?: string;
38757
39042
  /**
38758
39043
  * The profile picture URL of the Project owner.
38759
39044
  */
@@ -39235,7 +39520,7 @@ export type GetRecruiterTalentPoolApplicantsData = {
39235
39520
  */
39236
39521
  cursor?: string;
39237
39522
  /**
39238
- * The limit of items to be returned. The maximum allowed value depends on the provider.
39523
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
39239
39524
  */
39240
39525
  limit?: number;
39241
39526
  };
@@ -39559,7 +39844,7 @@ export type GetRecruiterTalentPoolApplicantsResponses = {
39559
39844
  skills_preview?: string;
39560
39845
  }>;
39561
39846
  /**
39562
- * The industry to which the User belongs.
39847
+ * The industry in which the User works.
39563
39848
  */
39564
39849
  industry?: string;
39565
39850
  /**
@@ -40240,7 +40525,7 @@ export type GetRecruiterApplicantByIdResponses = {
40240
40525
  skills_preview?: string;
40241
40526
  }>;
40242
40527
  /**
40243
- * The industry to which the User belongs.
40528
+ * The industry in which the User works.
40244
40529
  */
40245
40530
  industry?: string;
40246
40531
  /**
@@ -40714,7 +40999,7 @@ export type GetRecruiterPipelineCandidatesData = {
40714
40999
  */
40715
41000
  cursor?: string;
40716
41001
  /**
40717
- * The limit of items to be returned. The maximum allowed value depends on the provider.
41002
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
40718
41003
  */
40719
41004
  limit?: number;
40720
41005
  };
@@ -41004,7 +41289,7 @@ export type GetRecruiterPipelineCandidatesResponses = {
41004
41289
  skills_preview?: string;
41005
41290
  }>;
41006
41291
  /**
41007
- * The industry to which the User belongs.
41292
+ * The industry in which the User works.
41008
41293
  */
41009
41294
  industry?: string;
41010
41295
  /**
@@ -41932,7 +42217,7 @@ export type PerformRecruiterPeopleSearchFromTalentPoolData = {
41932
42217
  */
41933
42218
  cursor?: string;
41934
42219
  /**
41935
- * The limit of items to be returned. The maximum allowed value depends on the provider.
42220
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
41936
42221
  */
41937
42222
  limit?: number;
41938
42223
  };
@@ -42224,7 +42509,7 @@ export type PerformRecruiterPeopleSearchFromTalentPoolResponses = {
42224
42509
  skills_preview?: string;
42225
42510
  }>;
42226
42511
  /**
42227
- * The industry to which the User belongs.
42512
+ * The industry in which the User works.
42228
42513
  */
42229
42514
  industry?: string;
42230
42515
  /**
@@ -42636,7 +42921,7 @@ export type GetRecruiterJobPostingByProjectIdResponses = {
42636
42921
  /**
42637
42922
  * The budget allocated to the Job posting.
42638
42923
  */
42639
- workplace_type: 'ON_SITE' | 'HYBRID' | 'REMOTE';
42924
+ workplace_type?: 'ON_SITE' | 'HYBRID' | 'REMOTE';
42640
42925
  /**
42641
42926
  * The budget allocated to the Job posting.
42642
42927
  */
@@ -43079,7 +43364,7 @@ export type GetRecruiterJobPostingListData = {
43079
43364
  */
43080
43365
  offset?: number;
43081
43366
  /**
43082
- * The limit of items to be returned. The maximum allowed value depends on the provider.
43367
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
43083
43368
  */
43084
43369
  limit?: number;
43085
43370
  };
@@ -43744,7 +44029,7 @@ export type GetRecruiterJobPostingByIdResponses = {
43744
44029
  /**
43745
44030
  * The budget allocated to the Job posting.
43746
44031
  */
43747
- workplace_type: 'ON_SITE' | 'HYBRID' | 'REMOTE';
44032
+ workplace_type?: 'ON_SITE' | 'HYBRID' | 'REMOTE';
43748
44033
  /**
43749
44034
  * The budget allocated to the Job posting.
43750
44035
  */
@@ -44141,7 +44426,7 @@ export type PerformRecruiterSearchFromUrlResponses = {
44141
44426
  skills_preview?: string;
44142
44427
  }>;
44143
44428
  /**
44144
- * The industry to which the User belongs.
44429
+ * The industry in which the User works.
44145
44430
  */
44146
44431
  industry?: string;
44147
44432
  /**
@@ -44796,7 +45081,7 @@ export type PerformRecruiterSearchFromUrlResponses = {
44796
45081
  skills_preview?: string;
44797
45082
  }>;
44798
45083
  /**
44799
- * The industry to which the User belongs.
45084
+ * The industry in which the User works.
44800
45085
  */
44801
45086
  industry?: string;
44802
45087
  /**
@@ -45418,7 +45703,7 @@ export type PerformRecruiterSearchFromUrlResponses = {
45418
45703
  skills_preview?: string;
45419
45704
  }>;
45420
45705
  /**
45421
- * The industry to which the User belongs.
45706
+ * The industry in which the User works.
45422
45707
  */
45423
45708
  industry?: string;
45424
45709
  /**
@@ -45831,7 +46116,7 @@ export type GetRecruiterSearchParametersData = {
45831
46116
  */
45832
46117
  offset?: number;
45833
46118
  /**
45834
- * The limit of items to be returned. The maximum allowed value depends on the provider.
46119
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
45835
46120
  */
45836
46121
  limit?: number;
45837
46122
  };
@@ -46424,7 +46709,7 @@ export type PerformRecruiterPeopleSearchData = {
46424
46709
  */
46425
46710
  cursor?: string;
46426
46711
  /**
46427
- * The limit of items to be returned. The maximum allowed value depends on the provider.
46712
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
46428
46713
  */
46429
46714
  limit?: number;
46430
46715
  };
@@ -46716,7 +47001,7 @@ export type PerformRecruiterPeopleSearchResponses = {
46716
47001
  skills_preview?: string;
46717
47002
  }>;
46718
47003
  /**
46719
- * The industry to which the User belongs.
47004
+ * The industry in which the User works.
46720
47005
  */
46721
47006
  industry?: string;
46722
47007
  /**
@@ -47151,7 +47436,7 @@ export type PerformSalesSearchFromUrlData = {
47151
47436
  */
47152
47437
  offset?: number;
47153
47438
  /**
47154
- * The limit of items to be returned. The maximum allowed value depends on the provider.
47439
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
47155
47440
  */
47156
47441
  limit?: number;
47157
47442
  };
@@ -47307,6 +47592,10 @@ export type PerformSalesSearchFromUrlResponses = {
47307
47592
  social_handles?: {
47308
47593
  twitter?: string;
47309
47594
  };
47595
+ /**
47596
+ * The industry in which the User works.
47597
+ */
47598
+ industry?: string;
47310
47599
  education: Array<{
47311
47600
  /**
47312
47601
  * Id of the education entry.
@@ -47732,6 +48021,10 @@ export type PerformSalesSearchFromUrlResponses = {
47732
48021
  social_handles?: {
47733
48022
  twitter?: string;
47734
48023
  };
48024
+ /**
48025
+ * The industry in which the User works.
48026
+ */
48027
+ industry?: string;
47735
48028
  education: Array<{
47736
48029
  /**
47737
48030
  * Id of the education entry.
@@ -48186,6 +48479,10 @@ export type PerformSalesSearchFromUrlResponses = {
48186
48479
  social_handles?: {
48187
48480
  twitter?: string;
48188
48481
  };
48482
+ /**
48483
+ * The industry in which the User works.
48484
+ */
48485
+ industry?: string;
48189
48486
  education: Array<{
48190
48487
  /**
48191
48488
  * Id of the education entry.
@@ -48409,7 +48706,7 @@ export type GetSalesSearchParametersData = {
48409
48706
  */
48410
48707
  offset?: number;
48411
48708
  /**
48412
- * The limit of items to be returned. The maximum allowed value depends on the provider.
48709
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
48413
48710
  */
48414
48711
  limit?: number;
48415
48712
  };
@@ -48898,7 +49195,7 @@ export type PerformSalesPeopleSearchData = {
48898
49195
  */
48899
49196
  offset?: number;
48900
49197
  /**
48901
- * The limit of items to be returned. The maximum allowed value depends on the provider.
49198
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
48902
49199
  */
48903
49200
  limit?: number;
48904
49201
  };
@@ -49056,6 +49353,10 @@ export type PerformSalesPeopleSearchResponses = {
49056
49353
  social_handles?: {
49057
49354
  twitter?: string;
49058
49355
  };
49356
+ /**
49357
+ * The industry in which the User works.
49358
+ */
49359
+ industry?: string;
49059
49360
  education: Array<{
49060
49361
  /**
49061
49362
  * Id of the education entry.
@@ -49456,7 +49757,7 @@ export type PerformSalesCompaniesSearchData = {
49456
49757
  */
49457
49758
  offset?: number;
49458
49759
  /**
49459
- * The limit of items to be returned. The maximum allowed value depends on the provider.
49760
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
49460
49761
  */
49461
49762
  limit?: number;
49462
49763
  };
@@ -49578,7 +49879,7 @@ export type GetSalesLeadListsData = {
49578
49879
  */
49579
49880
  offset?: number;
49580
49881
  /**
49581
- * The limit of items to be returned. The maximum allowed value depends on the provider.
49882
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
49582
49883
  */
49583
49884
  limit?: number;
49584
49885
  };
@@ -49658,7 +49959,7 @@ export type BrowseSalesLeadListData = {
49658
49959
  */
49659
49960
  offset?: number;
49660
49961
  /**
49661
- * The limit of items to be returned. The maximum allowed value depends on the provider.
49962
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
49662
49963
  */
49663
49964
  limit?: number;
49664
49965
  };
@@ -49806,6 +50107,10 @@ export type BrowseSalesLeadListResponses = {
49806
50107
  social_handles?: {
49807
50108
  twitter?: string;
49808
50109
  };
50110
+ /**
50111
+ * The industry in which the User works.
50112
+ */
50113
+ industry?: string;
49809
50114
  education: Array<{
49810
50115
  /**
49811
50116
  * Id of the education entry.
@@ -50089,7 +50394,7 @@ export type GetSalesAccountListsData = {
50089
50394
  */
50090
50395
  offset?: number;
50091
50396
  /**
50092
- * The limit of items to be returned. The maximum allowed value depends on the provider.
50397
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
50093
50398
  */
50094
50399
  limit?: number;
50095
50400
  };
@@ -50179,7 +50484,7 @@ export type BrowseSalesAccountListData = {
50179
50484
  */
50180
50485
  offset?: number;
50181
50486
  /**
50182
- * The limit of items to be returned. The maximum allowed value depends on the provider.
50487
+ * The limit of items to be returned. The maximum allowed value depends on the provider. This is a ceiling, not a guarantee: some providers can return fewer items than requested for a given page.
50183
50488
  */
50184
50489
  limit?: number;
50185
50490
  };
@@ -50408,6 +50713,10 @@ export type BrowseSalesAccountListResponses = {
50408
50713
  social_handles?: {
50409
50714
  twitter?: string;
50410
50715
  };
50716
+ /**
50717
+ * The industry in which the User works.
50718
+ */
50719
+ industry?: string;
50411
50720
  education: Array<{
50412
50721
  /**
50413
50722
  * Id of the education entry.
@@ -50824,6 +51133,9 @@ export type SolveCheckpointResponses = {
50824
51133
  */
50825
51134
  url: string;
50826
51135
  } | {
51136
+ /**
51137
+ * The type of the returned object.
51138
+ */
50827
51139
  object: 'Account';
50828
51140
  /**
50829
51141
  * The ID of the user that owns the account for the provider.
@@ -50845,6 +51157,10 @@ export type SolveCheckpointResponses = {
50845
51157
  * ID of the parent application.
50846
51158
  */
50847
51159
  application_id: string;
51160
+ /**
51161
+ * ID of the Scope assigned to the Account. Once assigned, the Scope cannot be removed or replaced.
51162
+ */
51163
+ account_scope_id?: string | null;
50848
51164
  /**
50849
51165
  * The current status of the account.
50850
51166
  * - `running` is Operational.
@@ -50875,6 +51191,9 @@ export type SolveCheckpointResponses = {
50875
51191
  * If the provider is OAuth, this is the scope of comma-separated permissions granted to the account.
50876
51192
  */
50877
51193
  oauth_scope?: string;
51194
+ /**
51195
+ * Metadata associated with the Account.
51196
+ */
50878
51197
  metadata: {
50879
51198
  /**
50880
51199
  * The chosen country for the automatic proxy selection.
@@ -51744,6 +52063,10 @@ export type StartAuthIntentData = {
51744
52063
  } | Array<'credentials' | 'cookies'> | undefined;
51745
52064
  };
51746
52065
  }) & {
52066
+ /**
52067
+ * The Scope the account will be assigned to once authentication is complete.
52068
+ */
52069
+ account_scope_id?: string;
51747
52070
  /**
51748
52071
  * State data sent in the `account.add` / `account.reconnect` webhook payload after the authentication process.
51749
52072
  */
@@ -51859,6 +52182,9 @@ export type StartAuthIntentResponses = {
51859
52182
  */
51860
52183
  url: string;
51861
52184
  } | {
52185
+ /**
52186
+ * The type of the returned object.
52187
+ */
51862
52188
  object: 'Account';
51863
52189
  /**
51864
52190
  * The ID of the user that owns the account for the provider.
@@ -51880,6 +52206,10 @@ export type StartAuthIntentResponses = {
51880
52206
  * ID of the parent application.
51881
52207
  */
51882
52208
  application_id: string;
52209
+ /**
52210
+ * ID of the Scope assigned to the Account. Once assigned, the Scope cannot be removed or replaced.
52211
+ */
52212
+ account_scope_id?: string | null;
51883
52213
  /**
51884
52214
  * The current status of the account.
51885
52215
  * - `running` is Operational.
@@ -51910,6 +52240,9 @@ export type StartAuthIntentResponses = {
51910
52240
  * If the provider is OAuth, this is the scope of comma-separated permissions granted to the account.
51911
52241
  */
51912
52242
  oauth_scope?: string;
52243
+ /**
52244
+ * Metadata associated with the Account.
52245
+ */
51913
52246
  metadata: {
51914
52247
  /**
51915
52248
  * The chosen country for the automatic proxy selection.
@@ -51984,6 +52317,10 @@ export type StartAuthIntentResponses = {
51984
52317
  export type StartAuthIntentResponse = StartAuthIntentResponses[keyof StartAuthIntentResponses];
51985
52318
  export type CreateAuthLinkData = {
51986
52319
  body?: {
52320
+ /**
52321
+ * The Scope the account will be assigned to once authentication is complete.
52322
+ */
52323
+ account_scope_id?: string;
51987
52324
  /**
51988
52325
  * The expiration date of the link. Use ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ).
51989
52326
  */
@@ -52544,6 +52881,10 @@ export type CreateAuthLinkData = {
52544
52881
  */
52545
52882
  providers: '*' | '*:MESSAGING' | '*:EMAILS' | '*:CALENDAR' | '*:SOCIAL' | 'linkedin' | 'mock' | 'whatsapp' | 'google' | 'outlook' | 'imap' | 'telegram' | 'instagram' | Array<'linkedin' | 'mock' | 'whatsapp' | 'google' | 'outlook' | 'imap' | 'telegram' | 'instagram'>;
52546
52883
  } | {
52884
+ /**
52885
+ * The Scope the account will be assigned to once authentication is complete.
52886
+ */
52887
+ account_scope_id?: string;
52547
52888
  /**
52548
52889
  * The expiration date of the link. Use ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ).
52549
52890
  */
@@ -53149,6 +53490,9 @@ export type GetAccountResponses = {
53149
53490
  * Default Response
53150
53491
  */
53151
53492
  200: {
53493
+ /**
53494
+ * The type of the returned object.
53495
+ */
53152
53496
  object: 'Account';
53153
53497
  /**
53154
53498
  * The ID of the user that owns the account for the provider.
@@ -53170,6 +53514,10 @@ export type GetAccountResponses = {
53170
53514
  * ID of the parent application.
53171
53515
  */
53172
53516
  application_id: string;
53517
+ /**
53518
+ * ID of the Scope assigned to the Account. Once assigned, the Scope cannot be removed or replaced.
53519
+ */
53520
+ account_scope_id?: string | null;
53173
53521
  /**
53174
53522
  * The current status of the account.
53175
53523
  * - `running` is Operational.
@@ -53200,6 +53548,9 @@ export type GetAccountResponses = {
53200
53548
  * If the provider is OAuth, this is the scope of comma-separated permissions granted to the account.
53201
53549
  */
53202
53550
  oauth_scope?: string;
53551
+ /**
53552
+ * Metadata associated with the Account.
53553
+ */
53203
53554
  metadata: {
53204
53555
  /**
53205
53556
  * The chosen country for the automatic proxy selection.
@@ -53274,6 +53625,10 @@ export type GetAccountResponses = {
53274
53625
  export type GetAccountResponse = GetAccountResponses[keyof GetAccountResponses];
53275
53626
  export type UpdateAccountData = {
53276
53627
  body?: {
53628
+ /**
53629
+ * The Scope to permanently assign to an unscoped Account. This field requires a Service API Key, and the Scope cannot be removed or replaced after assignment.
53630
+ */
53631
+ account_scope_id?: string;
53277
53632
  /**
53278
53633
  * Custom key-value data for the account. Replaces the account `metadata.custom_data` field; other metadata fields are not modified. Any fields not provided will be removed.
53279
53634
  */
@@ -53330,6 +53685,9 @@ export type UpdateAccountResponses = {
53330
53685
  * Default Response
53331
53686
  */
53332
53687
  200: {
53688
+ /**
53689
+ * The type of the returned object.
53690
+ */
53333
53691
  object: 'Account';
53334
53692
  /**
53335
53693
  * The ID of the user that owns the account for the provider.
@@ -53351,6 +53709,10 @@ export type UpdateAccountResponses = {
53351
53709
  * ID of the parent application.
53352
53710
  */
53353
53711
  application_id: string;
53712
+ /**
53713
+ * ID of the Scope assigned to the Account. Once assigned, the Scope cannot be removed or replaced.
53714
+ */
53715
+ account_scope_id?: string | null;
53354
53716
  /**
53355
53717
  * The current status of the account.
53356
53718
  * - `running` is Operational.
@@ -53381,6 +53743,9 @@ export type UpdateAccountResponses = {
53381
53743
  * If the provider is OAuth, this is the scope of comma-separated permissions granted to the account.
53382
53744
  */
53383
53745
  oauth_scope?: string;
53746
+ /**
53747
+ * Metadata associated with the Account.
53748
+ */
53384
53749
  metadata: {
53385
53750
  /**
53386
53751
  * The chosen country for the automatic proxy selection.
@@ -53457,6 +53822,10 @@ export type ListAccountsData = {
53457
53822
  body?: never;
53458
53823
  path?: never;
53459
53824
  query?: {
53825
+ /**
53826
+ * Filter Accounts by Scope ID, or use `none` to return Accounts without a Scope.
53827
+ */
53828
+ account_scope_id?: string | 'none';
53460
53829
  /**
53461
53830
  * Filter to return only accounts of the given status.
53462
53831
  */
@@ -53495,6 +53864,9 @@ export type ListAccountsResponses = {
53495
53864
  200: {
53496
53865
  object: 'Accounts';
53497
53866
  data: Array<{
53867
+ /**
53868
+ * The type of the returned object.
53869
+ */
53498
53870
  object: 'Account';
53499
53871
  /**
53500
53872
  * The ID of the user that owns the account for the provider.
@@ -53516,6 +53888,10 @@ export type ListAccountsResponses = {
53516
53888
  * ID of the parent application.
53517
53889
  */
53518
53890
  application_id: string;
53891
+ /**
53892
+ * ID of the Scope assigned to the Account. Once assigned, the Scope cannot be removed or replaced.
53893
+ */
53894
+ account_scope_id?: string | null;
53519
53895
  /**
53520
53896
  * The current status of the account.
53521
53897
  * - `running` is Operational.
@@ -53546,6 +53922,9 @@ export type ListAccountsResponses = {
53546
53922
  * If the provider is OAuth, this is the scope of comma-separated permissions granted to the account.
53547
53923
  */
53548
53924
  oauth_scope?: string;
53925
+ /**
53926
+ * Metadata associated with the Account.
53927
+ */
53549
53928
  metadata: {
53550
53929
  /**
53551
53930
  * The chosen country for the automatic proxy selection.
@@ -53623,6 +54002,457 @@ export type ListAccountsResponses = {
53623
54002
  };
53624
54003
  };
53625
54004
  export type ListAccountsResponse = ListAccountsResponses[keyof ListAccountsResponses];
54005
+ export type ListApiKeysData = {
54006
+ body?: never;
54007
+ path?: never;
54008
+ query?: {
54009
+ /**
54010
+ * Filter Account API Keys by global or Scope access.
54011
+ */
54012
+ access?: 'global' | 'scope';
54013
+ /**
54014
+ * Filter API Keys assigned to this Scope.
54015
+ */
54016
+ account_scope_id?: string;
54017
+ /**
54018
+ * The number of API Keys to skip for pagination.
54019
+ */
54020
+ offset?: string;
54021
+ /**
54022
+ * The maximum number of API Keys to return.
54023
+ */
54024
+ limit?: string;
54025
+ };
54026
+ url: '/v2/api-keys/';
54027
+ };
54028
+ export type ListApiKeysResponses = {
54029
+ /**
54030
+ * Default Response
54031
+ */
54032
+ 200: {
54033
+ /**
54034
+ * The type of the returned collection.
54035
+ */
54036
+ object: 'ApiKeys';
54037
+ /**
54038
+ * The Account API Keys in the current page.
54039
+ */
54040
+ data: Array<{
54041
+ /**
54042
+ * The type of the returned object.
54043
+ */
54044
+ object: 'ApiKey';
54045
+ /**
54046
+ * The unique public ID of the API Key.
54047
+ */
54048
+ id: string;
54049
+ /**
54050
+ * The ID of the Application that owns the API Key.
54051
+ */
54052
+ application_id: string;
54053
+ /**
54054
+ * The non-secret prefix used to identify the API Key.
54055
+ */
54056
+ prefix: string;
54057
+ /**
54058
+ * The date and time when the API Key was created.
54059
+ */
54060
+ issued_at: string;
54061
+ /**
54062
+ * The date and time when the API Key expires.
54063
+ */
54064
+ expires_at: string;
54065
+ /**
54066
+ * The internal name of the API Key.
54067
+ */
54068
+ name: string;
54069
+ /**
54070
+ * The effective access role: `service` manages the Application, `account` accesses every Account, and `scoped` accesses one Scope.
54071
+ */
54072
+ role: 'service' | 'account' | 'scoped';
54073
+ /**
54074
+ * The Scope accessible to the API Key, or `null` for service and global Account API Keys.
54075
+ */
54076
+ account_scope_id: string | null;
54077
+ }>;
54078
+ /**
54079
+ * Whether more API Keys are available after the current page.
54080
+ */
54081
+ has_more: boolean;
54082
+ };
54083
+ };
54084
+ export type ListApiKeysResponse = ListApiKeysResponses[keyof ListApiKeysResponses];
54085
+ export type CreateApiKeyData = {
54086
+ body?: {
54087
+ /**
54088
+ * An internal name used to identify the API Key.
54089
+ */
54090
+ name: string;
54091
+ /**
54092
+ * The date and time when the API Key expires, in ISO 8601 format.
54093
+ */
54094
+ expires_at: string;
54095
+ /**
54096
+ * The Account access boundary of the API Key.
54097
+ */
54098
+ access: {
54099
+ /**
54100
+ * Grants access to every Account in the Application without management permissions.
54101
+ */
54102
+ type: 'global';
54103
+ };
54104
+ } | {
54105
+ /**
54106
+ * An internal name used to identify the API Key.
54107
+ */
54108
+ name: string;
54109
+ /**
54110
+ * The date and time when the API Key expires, in ISO 8601 format.
54111
+ */
54112
+ expires_at: string;
54113
+ /**
54114
+ * The Account access boundary of the API Key.
54115
+ */
54116
+ access: {
54117
+ /**
54118
+ * Restricts access to Accounts permanently assigned to one Scope.
54119
+ */
54120
+ type: 'scope';
54121
+ /**
54122
+ * The ID of the active Scope that the API Key can access.
54123
+ */
54124
+ scope_id: string;
54125
+ };
54126
+ };
54127
+ path?: never;
54128
+ query?: never;
54129
+ url: '/v2/api-keys/';
54130
+ };
54131
+ export type CreateApiKeyResponses = {
54132
+ /**
54133
+ * Default Response
54134
+ */
54135
+ 200: {
54136
+ /**
54137
+ * The type of the created object.
54138
+ */
54139
+ object: 'ApiKey';
54140
+ /**
54141
+ * The unique public ID of the created API Key.
54142
+ */
54143
+ id: string;
54144
+ /**
54145
+ * The secret API Key token. It is returned only once and must be stored securely.
54146
+ */
54147
+ api_key: string;
54148
+ };
54149
+ };
54150
+ export type CreateApiKeyResponse = CreateApiKeyResponses[keyof CreateApiKeyResponses];
54151
+ export type DeleteApiKeyData = {
54152
+ body?: never;
54153
+ path: {
54154
+ /**
54155
+ * The ID of the Account API Key to delete.
54156
+ */
54157
+ api_key_id: string;
54158
+ };
54159
+ query?: never;
54160
+ url: '/v2/api-keys/{api_key_id}';
54161
+ };
54162
+ export type DeleteApiKeyResponses = {
54163
+ /**
54164
+ * Default Response
54165
+ */
54166
+ 200: {
54167
+ object: 'ApiKeyDeleted';
54168
+ };
54169
+ };
54170
+ export type DeleteApiKeyResponse = DeleteApiKeyResponses[keyof DeleteApiKeyResponses];
54171
+ export type ListScopesData = {
54172
+ body?: never;
54173
+ path?: never;
54174
+ query?: {
54175
+ /**
54176
+ * The number of Scopes to skip for pagination.
54177
+ */
54178
+ offset?: string;
54179
+ /**
54180
+ * The maximum number of Scopes to return.
54181
+ */
54182
+ limit?: string;
54183
+ /**
54184
+ * The status of the Scope. A disabled scope blocks its scoped API keys and authentication flows until it is enabled again.
54185
+ */
54186
+ status?: 'active' | 'disabled';
54187
+ /**
54188
+ * Filter scopes by name or reference.
54189
+ */
54190
+ search?: string;
54191
+ };
54192
+ url: '/v2/scopes/';
54193
+ };
54194
+ export type ListScopesResponses = {
54195
+ /**
54196
+ * Default Response
54197
+ */
54198
+ 200: {
54199
+ /**
54200
+ * The type of the returned collection.
54201
+ */
54202
+ object: 'Scopes';
54203
+ /**
54204
+ * The scopes in the current page.
54205
+ */
54206
+ data: Array<{
54207
+ /**
54208
+ * The type of the returned object.
54209
+ */
54210
+ object: 'Scope';
54211
+ /**
54212
+ * The unique public ID of the Scope.
54213
+ */
54214
+ id: string;
54215
+ /**
54216
+ * The ID of the Application that owns the Scope.
54217
+ */
54218
+ application_id: string;
54219
+ /**
54220
+ * The internal name of the Scope.
54221
+ */
54222
+ name: string;
54223
+ /**
54224
+ * External metadata used to map the Scope to another resource, or `null` when none is defined.
54225
+ */
54226
+ reference: string | null;
54227
+ /**
54228
+ * The status of the Scope. A disabled scope blocks its scoped API keys and authentication flows until it is enabled again.
54229
+ */
54230
+ status: 'active' | 'disabled';
54231
+ /**
54232
+ * The date and time when the Scope was created.
54233
+ */
54234
+ created_at: string;
54235
+ /**
54236
+ * The number of Accounts permanently assigned to the Scope.
54237
+ */
54238
+ accounts_count: number;
54239
+ /**
54240
+ * The number of API Keys assigned to the Scope.
54241
+ */
54242
+ api_keys_count: number;
54243
+ }>;
54244
+ /**
54245
+ * Whether more scopes are available after the current page.
54246
+ */
54247
+ has_more: boolean;
54248
+ };
54249
+ };
54250
+ export type ListScopesResponse = ListScopesResponses[keyof ListScopesResponses];
54251
+ export type CreateScopeData = {
54252
+ body: {
54253
+ /**
54254
+ * An internal name used to identify the Scope.
54255
+ */
54256
+ name: string;
54257
+ /**
54258
+ * Optional metadata used to map the Scope to an external resource. Must be unique in the Application.
54259
+ */
54260
+ reference?: string;
54261
+ };
54262
+ path?: never;
54263
+ query?: never;
54264
+ url: '/v2/scopes/';
54265
+ };
54266
+ export type CreateScopeResponses = {
54267
+ /**
54268
+ * Default Response
54269
+ */
54270
+ 200: {
54271
+ /**
54272
+ * The type of the returned object.
54273
+ */
54274
+ object: 'Scope';
54275
+ /**
54276
+ * The unique public ID of the Scope.
54277
+ */
54278
+ id: string;
54279
+ /**
54280
+ * The ID of the Application that owns the Scope.
54281
+ */
54282
+ application_id: string;
54283
+ /**
54284
+ * The internal name of the Scope.
54285
+ */
54286
+ name: string;
54287
+ /**
54288
+ * External metadata used to map the Scope to another resource, or `null` when none is defined.
54289
+ */
54290
+ reference: string | null;
54291
+ /**
54292
+ * The status of the Scope. A disabled scope blocks its scoped API keys and authentication flows until it is enabled again.
54293
+ */
54294
+ status: 'active' | 'disabled';
54295
+ /**
54296
+ * The date and time when the Scope was created.
54297
+ */
54298
+ created_at: string;
54299
+ /**
54300
+ * The number of Accounts permanently assigned to the Scope.
54301
+ */
54302
+ accounts_count: number;
54303
+ /**
54304
+ * The number of API Keys assigned to the Scope.
54305
+ */
54306
+ api_keys_count: number;
54307
+ };
54308
+ };
54309
+ export type CreateScopeResponse = CreateScopeResponses[keyof CreateScopeResponses];
54310
+ export type DeleteScopeData = {
54311
+ body?: never;
54312
+ path: {
54313
+ /**
54314
+ * The ID of the Scope to delete.
54315
+ */
54316
+ scope_id: string;
54317
+ };
54318
+ query?: never;
54319
+ url: '/v2/scopes/{scope_id}';
54320
+ };
54321
+ export type DeleteScopeResponses = {
54322
+ /**
54323
+ * Default Response
54324
+ */
54325
+ 200: {
54326
+ /**
54327
+ * Indicates that the Scope was successfully deleted.
54328
+ */
54329
+ object: 'ScopeDeleted';
54330
+ };
54331
+ };
54332
+ export type DeleteScopeResponse = DeleteScopeResponses[keyof DeleteScopeResponses];
54333
+ export type GetScopeData = {
54334
+ body?: never;
54335
+ path: {
54336
+ /**
54337
+ * The ID of the Scope to retrieve.
54338
+ */
54339
+ scope_id: string;
54340
+ };
54341
+ query?: never;
54342
+ url: '/v2/scopes/{scope_id}';
54343
+ };
54344
+ export type GetScopeResponses = {
54345
+ /**
54346
+ * Default Response
54347
+ */
54348
+ 200: {
54349
+ /**
54350
+ * The type of the returned object.
54351
+ */
54352
+ object: 'Scope';
54353
+ /**
54354
+ * The unique public ID of the Scope.
54355
+ */
54356
+ id: string;
54357
+ /**
54358
+ * The ID of the Application that owns the Scope.
54359
+ */
54360
+ application_id: string;
54361
+ /**
54362
+ * The internal name of the Scope.
54363
+ */
54364
+ name: string;
54365
+ /**
54366
+ * External metadata used to map the Scope to another resource, or `null` when none is defined.
54367
+ */
54368
+ reference: string | null;
54369
+ /**
54370
+ * The status of the Scope. A disabled scope blocks its scoped API keys and authentication flows until it is enabled again.
54371
+ */
54372
+ status: 'active' | 'disabled';
54373
+ /**
54374
+ * The date and time when the Scope was created.
54375
+ */
54376
+ created_at: string;
54377
+ /**
54378
+ * The number of Accounts permanently assigned to the Scope.
54379
+ */
54380
+ accounts_count: number;
54381
+ /**
54382
+ * The number of API Keys assigned to the Scope.
54383
+ */
54384
+ api_keys_count: number;
54385
+ };
54386
+ };
54387
+ export type GetScopeResponse = GetScopeResponses[keyof GetScopeResponses];
54388
+ export type UpdateScopeData = {
54389
+ body?: {
54390
+ /**
54391
+ * The new internal name of the Scope.
54392
+ */
54393
+ name?: string;
54394
+ /**
54395
+ * The new external reference of the Scope. Must be unique in the Application. Set to `null` to remove it.
54396
+ */
54397
+ reference?: string | null;
54398
+ /**
54399
+ * The status of the Scope. A disabled scope blocks its scoped API keys and authentication flows until it is enabled again.
54400
+ */
54401
+ status?: 'active' | 'disabled';
54402
+ };
54403
+ path: {
54404
+ /**
54405
+ * The ID of the Scope to update.
54406
+ */
54407
+ scope_id: string;
54408
+ };
54409
+ query?: never;
54410
+ url: '/v2/scopes/{scope_id}';
54411
+ };
54412
+ export type UpdateScopeResponses = {
54413
+ /**
54414
+ * Default Response
54415
+ */
54416
+ 200: {
54417
+ /**
54418
+ * The type of the returned object.
54419
+ */
54420
+ object: 'Scope';
54421
+ /**
54422
+ * The unique public ID of the Scope.
54423
+ */
54424
+ id: string;
54425
+ /**
54426
+ * The ID of the Application that owns the Scope.
54427
+ */
54428
+ application_id: string;
54429
+ /**
54430
+ * The internal name of the Scope.
54431
+ */
54432
+ name: string;
54433
+ /**
54434
+ * External metadata used to map the Scope to another resource, or `null` when none is defined.
54435
+ */
54436
+ reference: string | null;
54437
+ /**
54438
+ * The status of the Scope. A disabled scope blocks its scoped API keys and authentication flows until it is enabled again.
54439
+ */
54440
+ status: 'active' | 'disabled';
54441
+ /**
54442
+ * The date and time when the Scope was created.
54443
+ */
54444
+ created_at: string;
54445
+ /**
54446
+ * The number of Accounts permanently assigned to the Scope.
54447
+ */
54448
+ accounts_count: number;
54449
+ /**
54450
+ * The number of API Keys assigned to the Scope.
54451
+ */
54452
+ api_keys_count: number;
54453
+ };
54454
+ };
54455
+ export type UpdateScopeResponse = UpdateScopeResponses[keyof UpdateScopeResponses];
53626
54456
  export type ListWebhookConversationsData = {
53627
54457
  body?: never;
53628
54458
  path?: never;
@@ -53653,15 +54483,45 @@ export type ListWebhookConversationsResponses = {
53653
54483
  200: {
53654
54484
  object: 'WebhookConversations';
53655
54485
  data: Array<{
54486
+ /**
54487
+ * Whether this delivery was the first attempt to send the webhook. `false` indicates a retry.
54488
+ */
53656
54489
  first_attempt: boolean;
53657
- event_type: string;
54490
+ /**
54491
+ * The type of the event that was delivered.
54492
+ */
54493
+ event_type: 'account.status.disconnected' | 'account.status.running' | 'account.status.errored' | 'account.status.degraded' | 'account.status.partial' | 'account.locked' | 'account.unlocked' | 'account.add' | 'account.reconnect' | 'account.remove' | 'account.initial_sync.running' | 'account.initial_sync.failed' | 'account.initial_sync.completed' | 'message.new' | 'message.update' | 'message.delete' | 'message.receipt.read' | 'message.receipt.delivery' | 'message.reaction.new' | 'message.reaction.delete' | 'chat.delete' | 'chat.update' | 'email.new' | 'email.new.bounce' | 'email.delete' | 'email.draft.new' | 'email.draft.delete' | 'email.folder.create' | 'email.folder.update' | 'email.folder.delete' | 'calendar.create' | 'calendar.update' | 'calendar.delete' | 'calendar.event.new' | 'calendar.event.update' | 'calendar.event.delete' | 'tracking.open' | 'tracking.click' | 'relation.new';
54494
+ /**
54495
+ * The date and time at which the delivery attempt was made, in ISO 8601 format.
54496
+ */
53658
54497
  created_at: string;
54498
+ /**
54499
+ * The HTTP status code returned by the endpoint.
54500
+ */
53659
54501
  http_status: number | null;
54502
+ /**
54503
+ * The URL the webhook was delivered to.
54504
+ */
53660
54505
  endpoint_url: string;
54506
+ /**
54507
+ * The body of the HTTP response returned by the endpoint.
54508
+ */
53661
54509
  response_body: string | null;
54510
+ /**
54511
+ * The type of the returned object.
54512
+ */
53662
54513
  object: 'WebhookConversation';
54514
+ /**
54515
+ * Unique identifier of the webhook conversation.
54516
+ */
53663
54517
  id: string;
54518
+ /**
54519
+ * Unique identifier of the webhook endpoint the event was delivered to.
54520
+ */
53664
54521
  endpoint_id: string;
54522
+ /**
54523
+ * Unique identifier of the event that was delivered.
54524
+ */
53665
54525
  event_id: string;
53666
54526
  }>;
53667
54527
  has_more: boolean;