@curviate/sdk 0.6.0 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +27 -0
- package/dist/index.d.ts +74 -77
- package/package.json +1 -1
- package/src/generated/types.ts +74 -77
package/CHANGELOG.md
CHANGED
|
@@ -7,6 +7,33 @@ Versioning: semantic — minor for additive changes, patch for bug fixes; no sta
|
|
|
7
7
|
|
|
8
8
|
---
|
|
9
9
|
|
|
10
|
+
## [0.8.0] — 2026-07-02
|
|
11
|
+
|
|
12
|
+
### Added
|
|
13
|
+
|
|
14
|
+
- **Recruiter job-lifecycle endpoints are now fully implemented server-side.** The following operations no longer return `501` and are safe to call in production: getting/rejecting an applicant, downloading an applicant's resume, listing a job's applicants, solving a job's publish checkpoint, publishing a job, and fetching a Recruiter profile. Their generated response types no longer include a `501` variant — if your code branched on it, that branch is now dead and can be removed.
|
|
15
|
+
- Richer parameter documentation across the Recruiter and search surfaces: job/applicant/hiring-project IDs now describe where to obtain them (e.g. `job_id` from `GET /v1/recruiter/jobs`, `user_id` from a people-search result), and several previously-terse descriptions were corrected (e.g. the saved-search `industry` filter's cross-reference).
|
|
16
|
+
- Server-side parameter defaults are now surfaced in the generated JSDoc (`@default`) wherever the API applies one when a param is omitted — link-expiry seconds, chat visibility, hiring-project list `limit`, webhook delivery `format`/`enabled`/`headers`/`data`, and more.
|
|
17
|
+
- **Breaking (typed consumers):** the Sales Navigator company-search `annual_revenue.min`/`max` filter is now a bucketed numeric enum (`0 | 0.2 | 1 | 2.5 | 5 | 10 | 20 | 50 | 100 | 500 | 1000 | 1001`) instead of a free-form `number`, matching what the API actually accepts. Code passing arbitrary numbers no longer typechecks — pick the nearest bucket value. Runtime behavior is unchanged (the API already only accepted these buckets).
|
|
18
|
+
|
|
19
|
+
### Changed
|
|
20
|
+
|
|
21
|
+
- **Search filter guard-rails are now documented.** `search.companies` `limit` requires a minimum of 2 (was 1) — the API rejects single-result company searches. `search.jobs` `benefits` and `commitments` filters now document their accepted values. `search.people` `open_to` now documents its accepted values (`proBono`, `boardMember`). The `search.posts` request examples were corrected to use the actual `member`/`company` array filter shape instead of a `member_urn` string.
|
|
22
|
+
- Regenerated types from the current API surface. No resource method signatures changed.
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
## [0.7.0] — 2026-07-01
|
|
27
|
+
|
|
28
|
+
### Changed
|
|
29
|
+
|
|
30
|
+
- **Breaking (typed consumers):** `recruiter.startChat` 201 response — the `attendee_ids` field is removed and replaced by `message_id` (the opening message identifier). Final shape: `{ object: "chat_started", chat_id, message_id }`, matching `messaging.startChat` and `salesNavigator.startChat`. `chat_id` is now non-nullable on a 201. Type: `RecruiterStartChatResult`. Migration: read `res.message_id`.
|
|
31
|
+
- *Why:* product-API + core / Sales Navigator parity — the underlying LinkedIn start-chat operation returns an identical `{ object, chat_id, message_id }` for every product; the prior `attendee_ids` echo had no product-API basis.
|
|
32
|
+
- The `recruiter.startChat` request body is unchanged (`attendees_ids` plus all recruiter-specific params).
|
|
33
|
+
- Regenerated types from the updated API surface.
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
10
37
|
## [0.6.0] — 2026-07-01
|
|
11
38
|
|
|
12
39
|
### Added
|
package/dist/index.d.ts
CHANGED
|
@@ -854,10 +854,14 @@ interface paths {
|
|
|
854
854
|
account_id?: string;
|
|
855
855
|
/**
|
|
856
856
|
* @description 'create' = new account onboarding; 'reconnect' = re-auth of existing account
|
|
857
|
+
* @default create
|
|
857
858
|
* @enum {string}
|
|
858
859
|
*/
|
|
859
860
|
purpose?: "create" | "reconnect";
|
|
860
|
-
/**
|
|
861
|
+
/**
|
|
862
|
+
* @description Seconds until the link expires (60–3600, default 900)
|
|
863
|
+
* @default 900
|
|
864
|
+
*/
|
|
861
865
|
expires_in_seconds?: number;
|
|
862
866
|
/** @description Optional browser return URL after the hosted flow. No credential material. */
|
|
863
867
|
redirect_url?: string;
|
|
@@ -7622,6 +7626,7 @@ interface paths {
|
|
|
7622
7626
|
};
|
|
7623
7627
|
header?: never;
|
|
7624
7628
|
path: {
|
|
7629
|
+
/** @description The target profile's public identifier (vanity slug), member ID, or URN. */
|
|
7625
7630
|
identifier: string;
|
|
7626
7631
|
};
|
|
7627
7632
|
cookie?: never;
|
|
@@ -7782,15 +7787,6 @@ interface paths {
|
|
|
7782
7787
|
"application/json": components["schemas"]["Error"];
|
|
7783
7788
|
};
|
|
7784
7789
|
};
|
|
7785
|
-
/** @description Not implemented — the Recruiter profile endpoint is not available on this account configuration. */
|
|
7786
|
-
501: {
|
|
7787
|
-
headers: {
|
|
7788
|
-
[name: string]: unknown;
|
|
7789
|
-
};
|
|
7790
|
-
content: {
|
|
7791
|
-
"application/json": components["schemas"]["Error"];
|
|
7792
|
-
};
|
|
7793
|
-
};
|
|
7794
7790
|
/** @description PLATFORM_ERROR — A temporary error occurred. Please try again. */
|
|
7795
7791
|
502: {
|
|
7796
7792
|
headers: {
|
|
@@ -7872,12 +7868,12 @@ interface paths {
|
|
|
7872
7868
|
saved_search?: {
|
|
7873
7869
|
/** @description Saved search ID. Resolve via search/parameters?type=SAVED_SEARCHES. */
|
|
7874
7870
|
id: string;
|
|
7875
|
-
/** @description Project ID the saved search belongs to. Resolve via search/parameters?type=
|
|
7871
|
+
/** @description Project ID the saved search belongs to. Resolve via search/parameters?type=SAVED_SEARCHES. */
|
|
7876
7872
|
project_id: string;
|
|
7877
7873
|
/** @description When true, returns only results new since the search was last run. */
|
|
7878
7874
|
newest_results_only?: boolean;
|
|
7879
7875
|
};
|
|
7880
|
-
/** @description INDUSTRY IDs to include or exclude. Resolve via search/parameters?type=
|
|
7876
|
+
/** @description INDUSTRY IDs to include or exclude. Resolve via search/parameters?type=INDUSTRY. */
|
|
7881
7877
|
industry?: {
|
|
7882
7878
|
/** @description Filter IDs to include. */
|
|
7883
7879
|
include?: string[];
|
|
@@ -8516,10 +8512,15 @@ interface paths {
|
|
|
8516
8512
|
get: {
|
|
8517
8513
|
parameters: {
|
|
8518
8514
|
query: {
|
|
8515
|
+
/** @description The Curviate account ID whose Recruiter session lists hiring projects. */
|
|
8519
8516
|
account_id: string;
|
|
8517
|
+
/** @description Maximum number of hiring projects to return (1–100). Defaults to 10. */
|
|
8520
8518
|
limit?: number;
|
|
8519
|
+
/** @description Opaque pagination cursor from a previous response. Omit for the first page. */
|
|
8521
8520
|
cursor?: string;
|
|
8521
|
+
/** @description Field to sort hiring projects by. Defaults to ACCESSED_TIME. */
|
|
8522
8522
|
sort_by?: "NAME" | "FAVORITE" | "CREATED_TIME" | "ACCESSED_TIME" | "ENGAGED_TIME" | "ENGAGEMENT_COUNT";
|
|
8523
|
+
/** @description Sort direction. Defaults to DESCENDING. */
|
|
8523
8524
|
sort_order?: "ASCENDING" | "DESCENDING";
|
|
8524
8525
|
};
|
|
8525
8526
|
header?: never;
|
|
@@ -8750,10 +8751,12 @@ interface paths {
|
|
|
8750
8751
|
get: {
|
|
8751
8752
|
parameters: {
|
|
8752
8753
|
query: {
|
|
8754
|
+
/** @description The Curviate account ID whose Recruiter session performs this call. */
|
|
8753
8755
|
account_id: string;
|
|
8754
8756
|
};
|
|
8755
8757
|
header?: never;
|
|
8756
8758
|
path: {
|
|
8759
|
+
/** @description The hiring project ID. Obtain it from the items[].id of GET /v1/recruiter/projects. */
|
|
8757
8760
|
project_id: string;
|
|
8758
8761
|
};
|
|
8759
8762
|
cookie?: never;
|
|
@@ -8970,6 +8973,7 @@ interface paths {
|
|
|
8970
8973
|
get: {
|
|
8971
8974
|
parameters: {
|
|
8972
8975
|
query: {
|
|
8976
|
+
/** @description The Curviate account ID whose Recruiter session performs this call. */
|
|
8973
8977
|
account_id: string;
|
|
8974
8978
|
/** @description Filter by job posting status. One of: active, draft, closed. Defaults to active. */
|
|
8975
8979
|
category?: "active" | "draft" | "closed";
|
|
@@ -9693,6 +9697,7 @@ interface paths {
|
|
|
9693
9697
|
email_address?: string;
|
|
9694
9698
|
/**
|
|
9695
9699
|
* @description Visibility of the recruiter chat. Defaults to PRIVATE.
|
|
9700
|
+
* @default PRIVATE
|
|
9696
9701
|
* @enum {string}
|
|
9697
9702
|
*/
|
|
9698
9703
|
visibility?: "PUBLIC" | "PRIVATE" | "PROJECT";
|
|
@@ -9736,7 +9741,7 @@ interface paths {
|
|
|
9736
9741
|
};
|
|
9737
9742
|
};
|
|
9738
9743
|
responses: {
|
|
9739
|
-
/** @description Recruiter chat started. Returns the object discriminator, the chat_id, and the
|
|
9744
|
+
/** @description Recruiter chat started. Returns the object discriminator, the chat_id, and the message_id of the opening message. Message content is never echoed back. The InMail daily quota is consumed; remaining capacity is read from GET /v1/accounts/{account_id}, never echoed here. Requires a Recruiter seat. */
|
|
9740
9745
|
201: {
|
|
9741
9746
|
headers: {
|
|
9742
9747
|
"RateLimit-Policy": components["headers"]["RateLimit-Policy"];
|
|
@@ -9751,9 +9756,9 @@ interface paths {
|
|
|
9751
9756
|
*/
|
|
9752
9757
|
object: "chat_started";
|
|
9753
9758
|
/** @description The newly created chat's identifier. */
|
|
9754
|
-
chat_id: string
|
|
9755
|
-
/** @description The
|
|
9756
|
-
|
|
9759
|
+
chat_id: string;
|
|
9760
|
+
/** @description The opening message identifier. */
|
|
9761
|
+
message_id: string;
|
|
9757
9762
|
};
|
|
9758
9763
|
};
|
|
9759
9764
|
};
|
|
@@ -10230,6 +10235,7 @@ interface paths {
|
|
|
10230
10235
|
query?: never;
|
|
10231
10236
|
header?: never;
|
|
10232
10237
|
path: {
|
|
10238
|
+
/** @description The member id in AEM… format. Obtain it from the `id` field of a POST /v1/recruiter/search/people result item. */
|
|
10233
10239
|
user_id: string;
|
|
10234
10240
|
};
|
|
10235
10241
|
cookie?: never;
|
|
@@ -10404,6 +10410,7 @@ interface paths {
|
|
|
10404
10410
|
query?: never;
|
|
10405
10411
|
header?: never;
|
|
10406
10412
|
path: {
|
|
10413
|
+
/** @description The job posting draft ID, returned as job_id in the POST /v1/recruiter/jobs response. */
|
|
10407
10414
|
job_id: string;
|
|
10408
10415
|
};
|
|
10409
10416
|
cookie?: never;
|
|
@@ -10589,15 +10596,6 @@ interface paths {
|
|
|
10589
10596
|
"application/json": components["schemas"]["Error"];
|
|
10590
10597
|
};
|
|
10591
10598
|
};
|
|
10592
|
-
/** @description PLATFORM_NOT_IMPLEMENTED — this operation is not available on the current platform tier. */
|
|
10593
|
-
501: {
|
|
10594
|
-
headers: {
|
|
10595
|
-
[name: string]: unknown;
|
|
10596
|
-
};
|
|
10597
|
-
content: {
|
|
10598
|
-
"application/json": components["schemas"]["Error"];
|
|
10599
|
-
};
|
|
10600
|
-
};
|
|
10601
10599
|
/** @description PLATFORM_ERROR — A temporary error occurred. Please try again. */
|
|
10602
10600
|
502: {
|
|
10603
10601
|
headers: {
|
|
@@ -10651,6 +10649,7 @@ interface paths {
|
|
|
10651
10649
|
query?: never;
|
|
10652
10650
|
header?: never;
|
|
10653
10651
|
path: {
|
|
10652
|
+
/** @description The job posting ID whose pending publish checkpoint is being solved. */
|
|
10654
10653
|
job_id: string;
|
|
10655
10654
|
};
|
|
10656
10655
|
cookie?: never;
|
|
@@ -10769,15 +10768,6 @@ interface paths {
|
|
|
10769
10768
|
"application/json": components["schemas"]["Error"];
|
|
10770
10769
|
};
|
|
10771
10770
|
};
|
|
10772
|
-
/** @description PLATFORM_NOT_IMPLEMENTED — this operation is not available on the current platform tier. */
|
|
10773
|
-
501: {
|
|
10774
|
-
headers: {
|
|
10775
|
-
[name: string]: unknown;
|
|
10776
|
-
};
|
|
10777
|
-
content: {
|
|
10778
|
-
"application/json": components["schemas"]["Error"];
|
|
10779
|
-
};
|
|
10780
|
-
};
|
|
10781
10771
|
/** @description PLATFORM_ERROR — A temporary error occurred. Please try again. */
|
|
10782
10772
|
502: {
|
|
10783
10773
|
headers: {
|
|
@@ -10916,15 +10906,6 @@ interface paths {
|
|
|
10916
10906
|
"application/json": components["schemas"]["Error"];
|
|
10917
10907
|
};
|
|
10918
10908
|
};
|
|
10919
|
-
/** @description The real adapter for this endpoint is not yet wired. */
|
|
10920
|
-
501: {
|
|
10921
|
-
headers: {
|
|
10922
|
-
[name: string]: unknown;
|
|
10923
|
-
};
|
|
10924
|
-
content: {
|
|
10925
|
-
"application/json": components["schemas"]["Error"];
|
|
10926
|
-
};
|
|
10927
|
-
};
|
|
10928
10909
|
/** @description The platform returned an error. */
|
|
10929
10910
|
502: {
|
|
10930
10911
|
headers: {
|
|
@@ -11160,15 +11141,6 @@ interface paths {
|
|
|
11160
11141
|
"application/json": components["schemas"]["Error"];
|
|
11161
11142
|
};
|
|
11162
11143
|
};
|
|
11163
|
-
/** @description The real adapter for this endpoint is not yet wired. */
|
|
11164
|
-
501: {
|
|
11165
|
-
headers: {
|
|
11166
|
-
[name: string]: unknown;
|
|
11167
|
-
};
|
|
11168
|
-
content: {
|
|
11169
|
-
"application/json": components["schemas"]["Error"];
|
|
11170
|
-
};
|
|
11171
|
-
};
|
|
11172
11144
|
/** @description The platform returned an error. */
|
|
11173
11145
|
502: {
|
|
11174
11146
|
headers: {
|
|
@@ -11251,6 +11223,7 @@ interface paths {
|
|
|
11251
11223
|
};
|
|
11252
11224
|
header?: never;
|
|
11253
11225
|
path: {
|
|
11226
|
+
/** @description The job posting ID whose applicants to list. Obtain it from GET /v1/recruiter/jobs. */
|
|
11254
11227
|
job_id: string;
|
|
11255
11228
|
};
|
|
11256
11229
|
cookie?: never;
|
|
@@ -11421,15 +11394,6 @@ interface paths {
|
|
|
11421
11394
|
"application/json": components["schemas"]["Error"];
|
|
11422
11395
|
};
|
|
11423
11396
|
};
|
|
11424
|
-
/** @description The real adapter for this endpoint is not yet wired. */
|
|
11425
|
-
501: {
|
|
11426
|
-
headers: {
|
|
11427
|
-
[name: string]: unknown;
|
|
11428
|
-
};
|
|
11429
|
-
content: {
|
|
11430
|
-
"application/json": components["schemas"]["Error"];
|
|
11431
|
-
};
|
|
11432
|
-
};
|
|
11433
11397
|
/** @description The platform returned an error. */
|
|
11434
11398
|
502: {
|
|
11435
11399
|
headers: {
|
|
@@ -12121,10 +12085,16 @@ interface paths {
|
|
|
12121
12085
|
annual_revenue?: {
|
|
12122
12086
|
/** @description ISO 4217 three-character currency code (e.g. 'USD'). */
|
|
12123
12087
|
currency: string;
|
|
12124
|
-
/**
|
|
12125
|
-
|
|
12126
|
-
|
|
12127
|
-
|
|
12088
|
+
/**
|
|
12089
|
+
* @description Minimum revenue bucket. One of the enumerated values; 1001 means '1000+'.
|
|
12090
|
+
* @enum {number}
|
|
12091
|
+
*/
|
|
12092
|
+
min: 0 | 0.2 | 1 | 2.5 | 5 | 10 | 20 | 50 | 100 | 500 | 1000 | 1001;
|
|
12093
|
+
/**
|
|
12094
|
+
* @description Maximum revenue bucket. Use 1001 for '1000+' (open-ended upper bound).
|
|
12095
|
+
* @enum {number}
|
|
12096
|
+
*/
|
|
12097
|
+
max: 0 | 0.2 | 1 | 2.5 | 5 | 10 | 20 | 50 | 100 | 500 | 1000 | 1001;
|
|
12128
12098
|
};
|
|
12129
12099
|
/** @description Connection distance: 1 (1st), 2 (2nd), 3 (3rd+). No GROUP value for companies. */
|
|
12130
12100
|
network_distance?: (1 | 2 | 3)[];
|
|
@@ -13244,7 +13214,7 @@ interface paths {
|
|
|
13244
13214
|
network_distance?: (1 | 2 | 3)[];
|
|
13245
13215
|
/** @description Filter by profile language codes. */
|
|
13246
13216
|
profile_language?: string[];
|
|
13247
|
-
/** @description Filter by open-to opportunity types. */
|
|
13217
|
+
/** @description Filter by open-to opportunity types. Valid values: proBono, boardMember. */
|
|
13248
13218
|
open_to?: string[];
|
|
13249
13219
|
};
|
|
13250
13220
|
};
|
|
@@ -13473,7 +13443,7 @@ interface paths {
|
|
|
13473
13443
|
query: {
|
|
13474
13444
|
/** @description The linked LinkedIn account to search on behalf of. */
|
|
13475
13445
|
account_id: string;
|
|
13476
|
-
/** @description Maximum results per page (
|
|
13446
|
+
/** @description Maximum results per page (2–50, default 10). Company search requires a minimum of 2. */
|
|
13477
13447
|
limit?: number;
|
|
13478
13448
|
/** @description Opaque pagination cursor returned from a previous response. */
|
|
13479
13449
|
cursor?: string;
|
|
@@ -14030,9 +14000,9 @@ interface paths {
|
|
|
14030
14000
|
*/
|
|
14031
14001
|
value: 20 | 30 | 40 | 50 | 60 | 70 | 80 | 90 | 100;
|
|
14032
14002
|
};
|
|
14033
|
-
/** @description Filter by offered benefits. */
|
|
14003
|
+
/** @description Filter by offered benefits. Valid values: medical_insurance, vision_insurance, dental_insurance, 401(k), pension_plan, commuter_benefits. */
|
|
14034
14004
|
benefits?: string[];
|
|
14035
|
-
/** @description Filter by company commitments. */
|
|
14005
|
+
/** @description Filter by company commitments. Valid values: career_growth_and_learning, diversity_equity_and_inclusion, environmental_sustainability, social_impact, work_life_balance. */
|
|
14036
14006
|
commitments?: string[];
|
|
14037
14007
|
/** @description Filter to jobs with LinkedIn verification badges. */
|
|
14038
14008
|
has_verifications?: boolean;
|
|
@@ -14334,21 +14304,31 @@ interface paths {
|
|
|
14334
14304
|
name?: string;
|
|
14335
14305
|
/**
|
|
14336
14306
|
* @description Delivery body encoding (default: json)
|
|
14307
|
+
* @default json
|
|
14337
14308
|
* @enum {string}
|
|
14338
14309
|
*/
|
|
14339
14310
|
format?: "json" | "form";
|
|
14340
14311
|
/** @description Per-account targeting. Required and non-empty — each id must be an acc_-prefixed id owned by the tenant. */
|
|
14341
14312
|
account_ids: string[];
|
|
14342
|
-
/**
|
|
14313
|
+
/**
|
|
14314
|
+
* @description A disabled webhook is created but delivers nothing
|
|
14315
|
+
* @default true
|
|
14316
|
+
*/
|
|
14343
14317
|
enabled?: boolean;
|
|
14344
|
-
/**
|
|
14318
|
+
/**
|
|
14319
|
+
* @description Custom headers added to each delivery POST
|
|
14320
|
+
* @default []
|
|
14321
|
+
*/
|
|
14345
14322
|
headers?: {
|
|
14346
14323
|
key: string;
|
|
14347
14324
|
value: string;
|
|
14348
14325
|
}[];
|
|
14349
14326
|
/** @description Messaging events to subscribe to (default: [message.received]) */
|
|
14350
14327
|
events?: ("message.received" | "message.delivered" | "message.read" | "message.reaction" | "message.edited" | "message.deleted")[];
|
|
14351
|
-
/**
|
|
14328
|
+
/**
|
|
14329
|
+
* @description Field-remapping keys for the messaging delivery payload
|
|
14330
|
+
* @default []
|
|
14331
|
+
*/
|
|
14352
14332
|
data?: string[];
|
|
14353
14333
|
} | {
|
|
14354
14334
|
/** @constant */
|
|
@@ -14359,21 +14339,31 @@ interface paths {
|
|
|
14359
14339
|
name?: string;
|
|
14360
14340
|
/**
|
|
14361
14341
|
* @description Delivery body encoding (default: json)
|
|
14342
|
+
* @default json
|
|
14362
14343
|
* @enum {string}
|
|
14363
14344
|
*/
|
|
14364
14345
|
format?: "json" | "form";
|
|
14365
14346
|
/** @description Per-account targeting. Required and non-empty — each id must be an acc_-prefixed id owned by the tenant. */
|
|
14366
14347
|
account_ids: string[];
|
|
14367
|
-
/**
|
|
14348
|
+
/**
|
|
14349
|
+
* @description A disabled webhook is created but delivers nothing
|
|
14350
|
+
* @default true
|
|
14351
|
+
*/
|
|
14368
14352
|
enabled?: boolean;
|
|
14369
|
-
/**
|
|
14353
|
+
/**
|
|
14354
|
+
* @description Custom headers added to each delivery POST
|
|
14355
|
+
* @default []
|
|
14356
|
+
*/
|
|
14370
14357
|
headers?: {
|
|
14371
14358
|
key: string;
|
|
14372
14359
|
value: string;
|
|
14373
14360
|
}[];
|
|
14374
14361
|
/** @description User/relation events to subscribe to (default: [connection.accepted]) */
|
|
14375
14362
|
events?: "connection.accepted"[];
|
|
14376
|
-
/**
|
|
14363
|
+
/**
|
|
14364
|
+
* @description Field-remapping keys for the user/relation delivery payload
|
|
14365
|
+
* @default []
|
|
14366
|
+
*/
|
|
14377
14367
|
data?: ("user_provider_id" | "user_full_name" | "user_public_identifier" | "user_profile_url" | "user_picture_url")[];
|
|
14378
14368
|
} | {
|
|
14379
14369
|
/** @constant */
|
|
@@ -14384,14 +14374,21 @@ interface paths {
|
|
|
14384
14374
|
name?: string;
|
|
14385
14375
|
/**
|
|
14386
14376
|
* @description Delivery body encoding (default: json)
|
|
14377
|
+
* @default json
|
|
14387
14378
|
* @enum {string}
|
|
14388
14379
|
*/
|
|
14389
14380
|
format?: "json" | "form";
|
|
14390
14381
|
/** @description Per-account targeting. Required and non-empty — each id must be an acc_-prefixed id owned by the tenant. */
|
|
14391
14382
|
account_ids: string[];
|
|
14392
|
-
/**
|
|
14383
|
+
/**
|
|
14384
|
+
* @description A disabled webhook is created but delivers nothing
|
|
14385
|
+
* @default true
|
|
14386
|
+
*/
|
|
14393
14387
|
enabled?: boolean;
|
|
14394
|
-
/**
|
|
14388
|
+
/**
|
|
14389
|
+
* @description Custom headers added to each delivery POST
|
|
14390
|
+
* @default []
|
|
14391
|
+
*/
|
|
14395
14392
|
headers?: {
|
|
14396
14393
|
key: string;
|
|
14397
14394
|
value: string;
|
package/package.json
CHANGED
package/src/generated/types.ts
CHANGED
|
@@ -745,10 +745,14 @@ export interface paths {
|
|
|
745
745
|
account_id?: string;
|
|
746
746
|
/**
|
|
747
747
|
* @description 'create' = new account onboarding; 'reconnect' = re-auth of existing account
|
|
748
|
+
* @default create
|
|
748
749
|
* @enum {string}
|
|
749
750
|
*/
|
|
750
751
|
purpose?: "create" | "reconnect";
|
|
751
|
-
/**
|
|
752
|
+
/**
|
|
753
|
+
* @description Seconds until the link expires (60–3600, default 900)
|
|
754
|
+
* @default 900
|
|
755
|
+
*/
|
|
752
756
|
expires_in_seconds?: number;
|
|
753
757
|
/** @description Optional browser return URL after the hosted flow. No credential material. */
|
|
754
758
|
redirect_url?: string;
|
|
@@ -7513,6 +7517,7 @@ export interface paths {
|
|
|
7513
7517
|
};
|
|
7514
7518
|
header?: never;
|
|
7515
7519
|
path: {
|
|
7520
|
+
/** @description The target profile's public identifier (vanity slug), member ID, or URN. */
|
|
7516
7521
|
identifier: string;
|
|
7517
7522
|
};
|
|
7518
7523
|
cookie?: never;
|
|
@@ -7673,15 +7678,6 @@ export interface paths {
|
|
|
7673
7678
|
"application/json": components["schemas"]["Error"];
|
|
7674
7679
|
};
|
|
7675
7680
|
};
|
|
7676
|
-
/** @description Not implemented — the Recruiter profile endpoint is not available on this account configuration. */
|
|
7677
|
-
501: {
|
|
7678
|
-
headers: {
|
|
7679
|
-
[name: string]: unknown;
|
|
7680
|
-
};
|
|
7681
|
-
content: {
|
|
7682
|
-
"application/json": components["schemas"]["Error"];
|
|
7683
|
-
};
|
|
7684
|
-
};
|
|
7685
7681
|
/** @description PLATFORM_ERROR — A temporary error occurred. Please try again. */
|
|
7686
7682
|
502: {
|
|
7687
7683
|
headers: {
|
|
@@ -7763,12 +7759,12 @@ export interface paths {
|
|
|
7763
7759
|
saved_search?: {
|
|
7764
7760
|
/** @description Saved search ID. Resolve via search/parameters?type=SAVED_SEARCHES. */
|
|
7765
7761
|
id: string;
|
|
7766
|
-
/** @description Project ID the saved search belongs to. Resolve via search/parameters?type=
|
|
7762
|
+
/** @description Project ID the saved search belongs to. Resolve via search/parameters?type=SAVED_SEARCHES. */
|
|
7767
7763
|
project_id: string;
|
|
7768
7764
|
/** @description When true, returns only results new since the search was last run. */
|
|
7769
7765
|
newest_results_only?: boolean;
|
|
7770
7766
|
};
|
|
7771
|
-
/** @description INDUSTRY IDs to include or exclude. Resolve via search/parameters?type=
|
|
7767
|
+
/** @description INDUSTRY IDs to include or exclude. Resolve via search/parameters?type=INDUSTRY. */
|
|
7772
7768
|
industry?: {
|
|
7773
7769
|
/** @description Filter IDs to include. */
|
|
7774
7770
|
include?: string[];
|
|
@@ -8407,10 +8403,15 @@ export interface paths {
|
|
|
8407
8403
|
get: {
|
|
8408
8404
|
parameters: {
|
|
8409
8405
|
query: {
|
|
8406
|
+
/** @description The Curviate account ID whose Recruiter session lists hiring projects. */
|
|
8410
8407
|
account_id: string;
|
|
8408
|
+
/** @description Maximum number of hiring projects to return (1–100). Defaults to 10. */
|
|
8411
8409
|
limit?: number;
|
|
8410
|
+
/** @description Opaque pagination cursor from a previous response. Omit for the first page. */
|
|
8412
8411
|
cursor?: string;
|
|
8412
|
+
/** @description Field to sort hiring projects by. Defaults to ACCESSED_TIME. */
|
|
8413
8413
|
sort_by?: "NAME" | "FAVORITE" | "CREATED_TIME" | "ACCESSED_TIME" | "ENGAGED_TIME" | "ENGAGEMENT_COUNT";
|
|
8414
|
+
/** @description Sort direction. Defaults to DESCENDING. */
|
|
8414
8415
|
sort_order?: "ASCENDING" | "DESCENDING";
|
|
8415
8416
|
};
|
|
8416
8417
|
header?: never;
|
|
@@ -8641,10 +8642,12 @@ export interface paths {
|
|
|
8641
8642
|
get: {
|
|
8642
8643
|
parameters: {
|
|
8643
8644
|
query: {
|
|
8645
|
+
/** @description The Curviate account ID whose Recruiter session performs this call. */
|
|
8644
8646
|
account_id: string;
|
|
8645
8647
|
};
|
|
8646
8648
|
header?: never;
|
|
8647
8649
|
path: {
|
|
8650
|
+
/** @description The hiring project ID. Obtain it from the items[].id of GET /v1/recruiter/projects. */
|
|
8648
8651
|
project_id: string;
|
|
8649
8652
|
};
|
|
8650
8653
|
cookie?: never;
|
|
@@ -8861,6 +8864,7 @@ export interface paths {
|
|
|
8861
8864
|
get: {
|
|
8862
8865
|
parameters: {
|
|
8863
8866
|
query: {
|
|
8867
|
+
/** @description The Curviate account ID whose Recruiter session performs this call. */
|
|
8864
8868
|
account_id: string;
|
|
8865
8869
|
/** @description Filter by job posting status. One of: active, draft, closed. Defaults to active. */
|
|
8866
8870
|
category?: "active" | "draft" | "closed";
|
|
@@ -9584,6 +9588,7 @@ export interface paths {
|
|
|
9584
9588
|
email_address?: string;
|
|
9585
9589
|
/**
|
|
9586
9590
|
* @description Visibility of the recruiter chat. Defaults to PRIVATE.
|
|
9591
|
+
* @default PRIVATE
|
|
9587
9592
|
* @enum {string}
|
|
9588
9593
|
*/
|
|
9589
9594
|
visibility?: "PUBLIC" | "PRIVATE" | "PROJECT";
|
|
@@ -9627,7 +9632,7 @@ export interface paths {
|
|
|
9627
9632
|
};
|
|
9628
9633
|
};
|
|
9629
9634
|
responses: {
|
|
9630
|
-
/** @description Recruiter chat started. Returns the object discriminator, the chat_id, and the
|
|
9635
|
+
/** @description Recruiter chat started. Returns the object discriminator, the chat_id, and the message_id of the opening message. Message content is never echoed back. The InMail daily quota is consumed; remaining capacity is read from GET /v1/accounts/{account_id}, never echoed here. Requires a Recruiter seat. */
|
|
9631
9636
|
201: {
|
|
9632
9637
|
headers: {
|
|
9633
9638
|
"RateLimit-Policy": components["headers"]["RateLimit-Policy"];
|
|
@@ -9642,9 +9647,9 @@ export interface paths {
|
|
|
9642
9647
|
*/
|
|
9643
9648
|
object: "chat_started";
|
|
9644
9649
|
/** @description The newly created chat's identifier. */
|
|
9645
|
-
chat_id: string
|
|
9646
|
-
/** @description The
|
|
9647
|
-
|
|
9650
|
+
chat_id: string;
|
|
9651
|
+
/** @description The opening message identifier. */
|
|
9652
|
+
message_id: string;
|
|
9648
9653
|
};
|
|
9649
9654
|
};
|
|
9650
9655
|
};
|
|
@@ -10121,6 +10126,7 @@ export interface paths {
|
|
|
10121
10126
|
query?: never;
|
|
10122
10127
|
header?: never;
|
|
10123
10128
|
path: {
|
|
10129
|
+
/** @description The member id in AEM… format. Obtain it from the `id` field of a POST /v1/recruiter/search/people result item. */
|
|
10124
10130
|
user_id: string;
|
|
10125
10131
|
};
|
|
10126
10132
|
cookie?: never;
|
|
@@ -10295,6 +10301,7 @@ export interface paths {
|
|
|
10295
10301
|
query?: never;
|
|
10296
10302
|
header?: never;
|
|
10297
10303
|
path: {
|
|
10304
|
+
/** @description The job posting draft ID, returned as job_id in the POST /v1/recruiter/jobs response. */
|
|
10298
10305
|
job_id: string;
|
|
10299
10306
|
};
|
|
10300
10307
|
cookie?: never;
|
|
@@ -10480,15 +10487,6 @@ export interface paths {
|
|
|
10480
10487
|
"application/json": components["schemas"]["Error"];
|
|
10481
10488
|
};
|
|
10482
10489
|
};
|
|
10483
|
-
/** @description PLATFORM_NOT_IMPLEMENTED — this operation is not available on the current platform tier. */
|
|
10484
|
-
501: {
|
|
10485
|
-
headers: {
|
|
10486
|
-
[name: string]: unknown;
|
|
10487
|
-
};
|
|
10488
|
-
content: {
|
|
10489
|
-
"application/json": components["schemas"]["Error"];
|
|
10490
|
-
};
|
|
10491
|
-
};
|
|
10492
10490
|
/** @description PLATFORM_ERROR — A temporary error occurred. Please try again. */
|
|
10493
10491
|
502: {
|
|
10494
10492
|
headers: {
|
|
@@ -10542,6 +10540,7 @@ export interface paths {
|
|
|
10542
10540
|
query?: never;
|
|
10543
10541
|
header?: never;
|
|
10544
10542
|
path: {
|
|
10543
|
+
/** @description The job posting ID whose pending publish checkpoint is being solved. */
|
|
10545
10544
|
job_id: string;
|
|
10546
10545
|
};
|
|
10547
10546
|
cookie?: never;
|
|
@@ -10660,15 +10659,6 @@ export interface paths {
|
|
|
10660
10659
|
"application/json": components["schemas"]["Error"];
|
|
10661
10660
|
};
|
|
10662
10661
|
};
|
|
10663
|
-
/** @description PLATFORM_NOT_IMPLEMENTED — this operation is not available on the current platform tier. */
|
|
10664
|
-
501: {
|
|
10665
|
-
headers: {
|
|
10666
|
-
[name: string]: unknown;
|
|
10667
|
-
};
|
|
10668
|
-
content: {
|
|
10669
|
-
"application/json": components["schemas"]["Error"];
|
|
10670
|
-
};
|
|
10671
|
-
};
|
|
10672
10662
|
/** @description PLATFORM_ERROR — A temporary error occurred. Please try again. */
|
|
10673
10663
|
502: {
|
|
10674
10664
|
headers: {
|
|
@@ -10807,15 +10797,6 @@ export interface paths {
|
|
|
10807
10797
|
"application/json": components["schemas"]["Error"];
|
|
10808
10798
|
};
|
|
10809
10799
|
};
|
|
10810
|
-
/** @description The real adapter for this endpoint is not yet wired. */
|
|
10811
|
-
501: {
|
|
10812
|
-
headers: {
|
|
10813
|
-
[name: string]: unknown;
|
|
10814
|
-
};
|
|
10815
|
-
content: {
|
|
10816
|
-
"application/json": components["schemas"]["Error"];
|
|
10817
|
-
};
|
|
10818
|
-
};
|
|
10819
10800
|
/** @description The platform returned an error. */
|
|
10820
10801
|
502: {
|
|
10821
10802
|
headers: {
|
|
@@ -11051,15 +11032,6 @@ export interface paths {
|
|
|
11051
11032
|
"application/json": components["schemas"]["Error"];
|
|
11052
11033
|
};
|
|
11053
11034
|
};
|
|
11054
|
-
/** @description The real adapter for this endpoint is not yet wired. */
|
|
11055
|
-
501: {
|
|
11056
|
-
headers: {
|
|
11057
|
-
[name: string]: unknown;
|
|
11058
|
-
};
|
|
11059
|
-
content: {
|
|
11060
|
-
"application/json": components["schemas"]["Error"];
|
|
11061
|
-
};
|
|
11062
|
-
};
|
|
11063
11035
|
/** @description The platform returned an error. */
|
|
11064
11036
|
502: {
|
|
11065
11037
|
headers: {
|
|
@@ -11142,6 +11114,7 @@ export interface paths {
|
|
|
11142
11114
|
};
|
|
11143
11115
|
header?: never;
|
|
11144
11116
|
path: {
|
|
11117
|
+
/** @description The job posting ID whose applicants to list. Obtain it from GET /v1/recruiter/jobs. */
|
|
11145
11118
|
job_id: string;
|
|
11146
11119
|
};
|
|
11147
11120
|
cookie?: never;
|
|
@@ -11312,15 +11285,6 @@ export interface paths {
|
|
|
11312
11285
|
"application/json": components["schemas"]["Error"];
|
|
11313
11286
|
};
|
|
11314
11287
|
};
|
|
11315
|
-
/** @description The real adapter for this endpoint is not yet wired. */
|
|
11316
|
-
501: {
|
|
11317
|
-
headers: {
|
|
11318
|
-
[name: string]: unknown;
|
|
11319
|
-
};
|
|
11320
|
-
content: {
|
|
11321
|
-
"application/json": components["schemas"]["Error"];
|
|
11322
|
-
};
|
|
11323
|
-
};
|
|
11324
11288
|
/** @description The platform returned an error. */
|
|
11325
11289
|
502: {
|
|
11326
11290
|
headers: {
|
|
@@ -12012,10 +11976,16 @@ export interface paths {
|
|
|
12012
11976
|
annual_revenue?: {
|
|
12013
11977
|
/** @description ISO 4217 three-character currency code (e.g. 'USD'). */
|
|
12014
11978
|
currency: string;
|
|
12015
|
-
/**
|
|
12016
|
-
|
|
12017
|
-
|
|
12018
|
-
|
|
11979
|
+
/**
|
|
11980
|
+
* @description Minimum revenue bucket. One of the enumerated values; 1001 means '1000+'.
|
|
11981
|
+
* @enum {number}
|
|
11982
|
+
*/
|
|
11983
|
+
min: 0 | 0.2 | 1 | 2.5 | 5 | 10 | 20 | 50 | 100 | 500 | 1000 | 1001;
|
|
11984
|
+
/**
|
|
11985
|
+
* @description Maximum revenue bucket. Use 1001 for '1000+' (open-ended upper bound).
|
|
11986
|
+
* @enum {number}
|
|
11987
|
+
*/
|
|
11988
|
+
max: 0 | 0.2 | 1 | 2.5 | 5 | 10 | 20 | 50 | 100 | 500 | 1000 | 1001;
|
|
12019
11989
|
};
|
|
12020
11990
|
/** @description Connection distance: 1 (1st), 2 (2nd), 3 (3rd+). No GROUP value for companies. */
|
|
12021
11991
|
network_distance?: (1 | 2 | 3)[];
|
|
@@ -13135,7 +13105,7 @@ export interface paths {
|
|
|
13135
13105
|
network_distance?: (1 | 2 | 3)[];
|
|
13136
13106
|
/** @description Filter by profile language codes. */
|
|
13137
13107
|
profile_language?: string[];
|
|
13138
|
-
/** @description Filter by open-to opportunity types. */
|
|
13108
|
+
/** @description Filter by open-to opportunity types. Valid values: proBono, boardMember. */
|
|
13139
13109
|
open_to?: string[];
|
|
13140
13110
|
};
|
|
13141
13111
|
};
|
|
@@ -13364,7 +13334,7 @@ export interface paths {
|
|
|
13364
13334
|
query: {
|
|
13365
13335
|
/** @description The linked LinkedIn account to search on behalf of. */
|
|
13366
13336
|
account_id: string;
|
|
13367
|
-
/** @description Maximum results per page (
|
|
13337
|
+
/** @description Maximum results per page (2–50, default 10). Company search requires a minimum of 2. */
|
|
13368
13338
|
limit?: number;
|
|
13369
13339
|
/** @description Opaque pagination cursor returned from a previous response. */
|
|
13370
13340
|
cursor?: string;
|
|
@@ -13921,9 +13891,9 @@ export interface paths {
|
|
|
13921
13891
|
*/
|
|
13922
13892
|
value: 20 | 30 | 40 | 50 | 60 | 70 | 80 | 90 | 100;
|
|
13923
13893
|
};
|
|
13924
|
-
/** @description Filter by offered benefits. */
|
|
13894
|
+
/** @description Filter by offered benefits. Valid values: medical_insurance, vision_insurance, dental_insurance, 401(k), pension_plan, commuter_benefits. */
|
|
13925
13895
|
benefits?: string[];
|
|
13926
|
-
/** @description Filter by company commitments. */
|
|
13896
|
+
/** @description Filter by company commitments. Valid values: career_growth_and_learning, diversity_equity_and_inclusion, environmental_sustainability, social_impact, work_life_balance. */
|
|
13927
13897
|
commitments?: string[];
|
|
13928
13898
|
/** @description Filter to jobs with LinkedIn verification badges. */
|
|
13929
13899
|
has_verifications?: boolean;
|
|
@@ -14225,21 +14195,31 @@ export interface paths {
|
|
|
14225
14195
|
name?: string;
|
|
14226
14196
|
/**
|
|
14227
14197
|
* @description Delivery body encoding (default: json)
|
|
14198
|
+
* @default json
|
|
14228
14199
|
* @enum {string}
|
|
14229
14200
|
*/
|
|
14230
14201
|
format?: "json" | "form";
|
|
14231
14202
|
/** @description Per-account targeting. Required and non-empty — each id must be an acc_-prefixed id owned by the tenant. */
|
|
14232
14203
|
account_ids: string[];
|
|
14233
|
-
/**
|
|
14204
|
+
/**
|
|
14205
|
+
* @description A disabled webhook is created but delivers nothing
|
|
14206
|
+
* @default true
|
|
14207
|
+
*/
|
|
14234
14208
|
enabled?: boolean;
|
|
14235
|
-
/**
|
|
14209
|
+
/**
|
|
14210
|
+
* @description Custom headers added to each delivery POST
|
|
14211
|
+
* @default []
|
|
14212
|
+
*/
|
|
14236
14213
|
headers?: {
|
|
14237
14214
|
key: string;
|
|
14238
14215
|
value: string;
|
|
14239
14216
|
}[];
|
|
14240
14217
|
/** @description Messaging events to subscribe to (default: [message.received]) */
|
|
14241
14218
|
events?: ("message.received" | "message.delivered" | "message.read" | "message.reaction" | "message.edited" | "message.deleted")[];
|
|
14242
|
-
/**
|
|
14219
|
+
/**
|
|
14220
|
+
* @description Field-remapping keys for the messaging delivery payload
|
|
14221
|
+
* @default []
|
|
14222
|
+
*/
|
|
14243
14223
|
data?: string[];
|
|
14244
14224
|
} | {
|
|
14245
14225
|
/** @constant */
|
|
@@ -14250,21 +14230,31 @@ export interface paths {
|
|
|
14250
14230
|
name?: string;
|
|
14251
14231
|
/**
|
|
14252
14232
|
* @description Delivery body encoding (default: json)
|
|
14233
|
+
* @default json
|
|
14253
14234
|
* @enum {string}
|
|
14254
14235
|
*/
|
|
14255
14236
|
format?: "json" | "form";
|
|
14256
14237
|
/** @description Per-account targeting. Required and non-empty — each id must be an acc_-prefixed id owned by the tenant. */
|
|
14257
14238
|
account_ids: string[];
|
|
14258
|
-
/**
|
|
14239
|
+
/**
|
|
14240
|
+
* @description A disabled webhook is created but delivers nothing
|
|
14241
|
+
* @default true
|
|
14242
|
+
*/
|
|
14259
14243
|
enabled?: boolean;
|
|
14260
|
-
/**
|
|
14244
|
+
/**
|
|
14245
|
+
* @description Custom headers added to each delivery POST
|
|
14246
|
+
* @default []
|
|
14247
|
+
*/
|
|
14261
14248
|
headers?: {
|
|
14262
14249
|
key: string;
|
|
14263
14250
|
value: string;
|
|
14264
14251
|
}[];
|
|
14265
14252
|
/** @description User/relation events to subscribe to (default: [connection.accepted]) */
|
|
14266
14253
|
events?: "connection.accepted"[];
|
|
14267
|
-
/**
|
|
14254
|
+
/**
|
|
14255
|
+
* @description Field-remapping keys for the user/relation delivery payload
|
|
14256
|
+
* @default []
|
|
14257
|
+
*/
|
|
14268
14258
|
data?: ("user_provider_id" | "user_full_name" | "user_public_identifier" | "user_profile_url" | "user_picture_url")[];
|
|
14269
14259
|
} | {
|
|
14270
14260
|
/** @constant */
|
|
@@ -14275,14 +14265,21 @@ export interface paths {
|
|
|
14275
14265
|
name?: string;
|
|
14276
14266
|
/**
|
|
14277
14267
|
* @description Delivery body encoding (default: json)
|
|
14268
|
+
* @default json
|
|
14278
14269
|
* @enum {string}
|
|
14279
14270
|
*/
|
|
14280
14271
|
format?: "json" | "form";
|
|
14281
14272
|
/** @description Per-account targeting. Required and non-empty — each id must be an acc_-prefixed id owned by the tenant. */
|
|
14282
14273
|
account_ids: string[];
|
|
14283
|
-
/**
|
|
14274
|
+
/**
|
|
14275
|
+
* @description A disabled webhook is created but delivers nothing
|
|
14276
|
+
* @default true
|
|
14277
|
+
*/
|
|
14284
14278
|
enabled?: boolean;
|
|
14285
|
-
/**
|
|
14279
|
+
/**
|
|
14280
|
+
* @description Custom headers added to each delivery POST
|
|
14281
|
+
* @default []
|
|
14282
|
+
*/
|
|
14286
14283
|
headers?: {
|
|
14287
14284
|
key: string;
|
|
14288
14285
|
value: string;
|