@curviate/sdk 0.34.0 → 0.36.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 +67 -0
- package/dist/index.d.ts +47 -27
- package/dist/index.js +18 -0
- package/package.json +1 -1
- package/src/generated/types.ts +29 -27
package/CHANGELOG.md
CHANGED
|
@@ -7,6 +7,73 @@ Versioning: semantic. Minor for additive changes, patch for bug fixes; no stabil
|
|
|
7
7
|
|
|
8
8
|
---
|
|
9
9
|
|
|
10
|
+
## [Unreleased]
|
|
11
|
+
|
|
12
|
+
## [0.36.0] - 2026-09-20
|
|
13
|
+
|
|
14
|
+
Fixture and types regenerated against the deployed production document
|
|
15
|
+
(`https://api.curviate.com`, 127 paths, server
|
|
16
|
+
`41d48ed451280c29b0fb6b4b15c44ca70b76af98`). One additive shape change.
|
|
17
|
+
|
|
18
|
+
### Added
|
|
19
|
+
|
|
20
|
+
- **`search.getParameters()` accepts `cursor`.** The filter-ID resolver
|
|
21
|
+
paginates: `SearchParametersQuery` gains an optional `cursor`, and the
|
|
22
|
+
response's `cursor` field is the token to send back for the next page. Walk
|
|
23
|
+
until it comes back `null`. `offset` still works and is now described as the
|
|
24
|
+
numeric fallback for `cursor`. A malformed cursor is a `400`. Additive and
|
|
25
|
+
backward compatible: a call that passes no `cursor` behaves exactly as
|
|
26
|
+
before.
|
|
27
|
+
|
|
28
|
+
### Changed
|
|
29
|
+
|
|
30
|
+
- Regenerated descriptions on `GET /v1/{account_id}/search/parameters`: the
|
|
31
|
+
operation description now states how the pages are walked, `offset` names
|
|
32
|
+
itself the numeric fallback, and the `400` description names a malformed
|
|
33
|
+
cursor among its causes.
|
|
34
|
+
- `search.getParameters()` carries a paging `@example` in its JSDoc.
|
|
35
|
+
|
|
36
|
+
## [0.35.0] - 2026-09-19
|
|
37
|
+
|
|
38
|
+
Fixture and types regenerated a second time against the deployed production
|
|
39
|
+
document, now at server `40e112c409a65334a48d8d1ab78ca40e464d3de1` (127
|
|
40
|
+
paths). No type shape change: one further description string changed,
|
|
41
|
+
nothing added, removed or retyped.
|
|
42
|
+
|
|
43
|
+
### Fixed
|
|
44
|
+
|
|
45
|
+
- **Sales Navigator profile `description` relabelled**
|
|
46
|
+
(`salesNavigator.profile()`), a correction that had already shipped to
|
|
47
|
+
staging: was
|
|
48
|
+
"About/summary text. Present when populated.", now "Professional headline.
|
|
49
|
+
Present when populated. Reading it back through Curviate stores it in your
|
|
50
|
+
tenant's entity records, with no expiry."
|
|
51
|
+
|
|
52
|
+
First refresh in this release, against production server
|
|
53
|
+
`00a1388d42b09db54424de12ecf1c7cbebe2ec12`: 23 description strings and 3
|
|
54
|
+
example values changed, nothing added, removed or retyped.
|
|
55
|
+
|
|
56
|
+
### Fixed
|
|
57
|
+
|
|
58
|
+
- **Content-retention copy corrected on the paths that do store content.** The
|
|
59
|
+
company-page admin list, the company-page follower list and several Recruiter
|
|
60
|
+
person fields described names and headlines as "content pass-through, never
|
|
61
|
+
stored". Reading those responses back through Curviate does store them, in
|
|
62
|
+
your tenant's entity records, with no expiry, so the claim was false. The
|
|
63
|
+
descriptions now say what is kept. The Recruiter person shape is shared by
|
|
64
|
+
routes that disagree, so its `display_name` and `headline` carry the
|
|
65
|
+
conditional form: a people search or a talent-pool search stores them, a
|
|
66
|
+
pipeline read, an applicant read and a pasted-URL search store nothing.
|
|
67
|
+
Claims that were checked and found true are unchanged, including the
|
|
68
|
+
company-page inbox family and every post, comment and job body.
|
|
69
|
+
- **A Recruiter profile field was mislabelled.** The top-level `description` on
|
|
70
|
+
`recruiter.profile()` was documented as the profile summary or About section.
|
|
71
|
+
It carries the member's professional headline. Relabelled.
|
|
72
|
+
|
|
73
|
+
### Changed
|
|
74
|
+
|
|
75
|
+
- **Neutral company name in the messaging examples**, replacing a real one.
|
|
76
|
+
|
|
10
77
|
## [0.34.0] - 2026-09-18
|
|
11
78
|
|
|
12
79
|
Fixture and types regenerated against the deployed production document
|
package/dist/index.d.ts
CHANGED
|
@@ -661,7 +661,7 @@ interface paths {
|
|
|
661
661
|
};
|
|
662
662
|
/**
|
|
663
663
|
* Resolve search filter IDs
|
|
664
|
-
* @description Resolves human-readable terms (e.g. 'software development') to opaque filter IDs for use in structured search filters. The type parameter selects the filter category; keywords is required for every type, including EMPLOYMENT_TYPE.
|
|
664
|
+
* @description Resolves human-readable terms (e.g. 'software development') to opaque filter IDs for use in structured search filters. The type parameter selects the filter category; keywords is required for every type, including EMPLOYMENT_TYPE. Results paginate: send the cursor from the previous response to get the next page, and stop when it comes back null.
|
|
665
665
|
*/
|
|
666
666
|
get: operations["getV1AccountIdSearchParameters"];
|
|
667
667
|
put?: never;
|
|
@@ -4210,7 +4210,7 @@ interface operations {
|
|
|
4210
4210
|
};
|
|
4211
4211
|
requestBody?: never;
|
|
4212
4212
|
responses: {
|
|
4213
|
-
/** @description The company pages the account administers, each with its per-page admin capability matrix. An account that administers no pages returns an empty list; never a 403. Page names are returned verbatim and are
|
|
4213
|
+
/** @description The company pages the account administers, each with its per-page admin capability matrix. An account that administers no pages returns an empty list; never a 403. Page names are returned verbatim and are stored in your tenant's entity records, with no expiry. */
|
|
4214
4214
|
200: {
|
|
4215
4215
|
headers: {
|
|
4216
4216
|
"RateLimit-Policy": components["headers"]["RateLimit-Policy"];
|
|
@@ -4240,7 +4240,7 @@ interface operations {
|
|
|
4240
4240
|
id: string | null;
|
|
4241
4241
|
/** @description Native company urn. */
|
|
4242
4242
|
entity_urn?: string | null;
|
|
4243
|
-
/** @description Page display name
|
|
4243
|
+
/** @description Page display name. Reading it back through Curviate stores it in your tenant's entity records, with no expiry. */
|
|
4244
4244
|
name?: string | null;
|
|
4245
4245
|
/** @description Vanity slug (the `/company/<slug>/` segment). */
|
|
4246
4246
|
universal_name?: string | null;
|
|
@@ -6500,7 +6500,7 @@ interface operations {
|
|
|
6500
6500
|
};
|
|
6501
6501
|
requestBody?: never;
|
|
6502
6502
|
responses: {
|
|
6503
|
-
/** @description A page of the company page's followers; the admin analytics follower list. Follower names and headlines are returned verbatim and are
|
|
6503
|
+
/** @description A page of the company page's followers; the admin analytics follower list. Follower names and headlines are returned verbatim and are stored in your tenant's entity records, with no expiry. Page until cursor is null. */
|
|
6504
6504
|
200: {
|
|
6505
6505
|
headers: {
|
|
6506
6506
|
"RateLimit-Policy": components["headers"]["RateLimit-Policy"];
|
|
@@ -6523,9 +6523,9 @@ interface operations {
|
|
|
6523
6523
|
object: "company_follower";
|
|
6524
6524
|
/** @description The follower's member id. */
|
|
6525
6525
|
id: string;
|
|
6526
|
-
/** @description Follower display name
|
|
6526
|
+
/** @description Follower display name. Reading it back through Curviate stores it in your tenant's entity records, with no expiry. */
|
|
6527
6527
|
name?: string | null;
|
|
6528
|
-
/** @description Follower headline
|
|
6528
|
+
/** @description Follower headline. Reading it back through Curviate stores it in your tenant's entity records, with no expiry. */
|
|
6529
6529
|
headline?: string | null;
|
|
6530
6530
|
/** @description Vanity slug. */
|
|
6531
6531
|
public_identifier?: string | null;
|
|
@@ -8420,10 +8420,12 @@ interface operations {
|
|
|
8420
8420
|
type: "LOCATION" | "PEOPLE" | "RELATION" | "COMPANY" | "SCHOOL" | "INDUSTRY" | "SERVICE" | "JOB_FUNCTION" | "JOB_TITLE" | "EMPLOYMENT_TYPE" | "SKILL";
|
|
8421
8421
|
/** @description Human term to resolve to opaque filter IDs (e.g. 'software development'). Required for every type, including EMPLOYMENT_TYPE. */
|
|
8422
8422
|
keywords: string;
|
|
8423
|
-
/** @description Zero-based pagination offset (default 0). */
|
|
8423
|
+
/** @description Zero-based pagination offset; a numeric fallback for cursor (default 0). */
|
|
8424
8424
|
offset?: number;
|
|
8425
8425
|
/** @description Number of parameters to return (1-100, default 10). */
|
|
8426
8426
|
limit?: number;
|
|
8427
|
+
/** @description Opaque pagination cursor returned from a previous response. */
|
|
8428
|
+
cursor?: string;
|
|
8427
8429
|
};
|
|
8428
8430
|
header?: never;
|
|
8429
8431
|
path: {
|
|
@@ -8461,7 +8463,7 @@ interface operations {
|
|
|
8461
8463
|
};
|
|
8462
8464
|
};
|
|
8463
8465
|
};
|
|
8464
|
-
/** @description Missing or empty account_id, missing or empty type, missing keywords,
|
|
8466
|
+
/** @description Missing or empty account_id, missing or empty type, missing keywords, type not in the classic allowlist, or malformed cursor. */
|
|
8465
8467
|
400: {
|
|
8466
8468
|
headers: {
|
|
8467
8469
|
[name: string]: unknown;
|
|
@@ -19781,7 +19783,7 @@ interface operations {
|
|
|
19781
19783
|
public_picture_url?: string;
|
|
19782
19784
|
/** @description Large profile picture URL. */
|
|
19783
19785
|
public_picture_url_large?: string;
|
|
19784
|
-
/** @description
|
|
19786
|
+
/** @description The member's professional headline. Reading it back through Curviate stores it in your tenant's entity records, with no expiry. */
|
|
19785
19787
|
description?: string;
|
|
19786
19788
|
/** @description Geographic location string. */
|
|
19787
19789
|
location?: string;
|
|
@@ -20063,7 +20065,7 @@ interface operations {
|
|
|
20063
20065
|
/** @description Section names that were requested but throttled by LinkedIn. */
|
|
20064
20066
|
throttled_sections?: string[];
|
|
20065
20067
|
};
|
|
20066
|
-
/** @description Recruiter-only enrichment: notes, tags, and message-activity events.
|
|
20068
|
+
/** @description Recruiter-only enrichment: notes, tags, and message-activity events. The notes, the tags and each event's message text are removed before anything is written, on every path. The rest of this object is stored in your tenant's entity records, with no expiry. */
|
|
20067
20069
|
recruiting_profile: {
|
|
20068
20070
|
/** @description Recruiter notes on this candidate. Passes through, never stored. */
|
|
20069
20071
|
notes?: string | null;
|
|
@@ -20565,7 +20567,7 @@ interface operations {
|
|
|
20565
20567
|
id: string;
|
|
20566
20568
|
/** @description SCREAMING_CASE network-distance enum. */
|
|
20567
20569
|
network_distance: string;
|
|
20568
|
-
/** @description
|
|
20570
|
+
/** @description The member's headline. A people search or a talent-pool search stores it in your tenant's entity records, with no expiry. A pipeline read, an applicant read and a pasted-URL search store nothing. */
|
|
20569
20571
|
headline?: string;
|
|
20570
20572
|
location?: string;
|
|
20571
20573
|
can_send_inmail?: boolean;
|
|
@@ -20587,7 +20589,7 @@ interface operations {
|
|
|
20587
20589
|
employment_type?: string;
|
|
20588
20590
|
workplace_type?: string;
|
|
20589
20591
|
}[];
|
|
20590
|
-
/** @description
|
|
20592
|
+
/** @description The member's display name. A people search or a talent-pool search stores it in your tenant's entity records, with no expiry. A pipeline read, an applicant read and a pasted-URL search store nothing. */
|
|
20591
20593
|
display_name?: string;
|
|
20592
20594
|
public_identifier?: string;
|
|
20593
20595
|
profile_url?: string;
|
|
@@ -21607,7 +21609,7 @@ interface operations {
|
|
|
21607
21609
|
id: string;
|
|
21608
21610
|
/** @description SCREAMING_CASE network-distance enum. */
|
|
21609
21611
|
network_distance: string;
|
|
21610
|
-
/** @description
|
|
21612
|
+
/** @description The member's headline. A people search or a talent-pool search stores it in your tenant's entity records, with no expiry. A pipeline read, an applicant read and a pasted-URL search store nothing. */
|
|
21611
21613
|
headline?: string;
|
|
21612
21614
|
location?: string;
|
|
21613
21615
|
can_send_inmail?: boolean;
|
|
@@ -21629,7 +21631,7 @@ interface operations {
|
|
|
21629
21631
|
employment_type?: string;
|
|
21630
21632
|
workplace_type?: string;
|
|
21631
21633
|
}[];
|
|
21632
|
-
/** @description
|
|
21634
|
+
/** @description The member's display name. A people search or a talent-pool search stores it in your tenant's entity records, with no expiry. A pipeline read, an applicant read and a pasted-URL search store nothing. */
|
|
21633
21635
|
display_name?: string;
|
|
21634
21636
|
public_identifier?: string;
|
|
21635
21637
|
profile_url?: string;
|
|
@@ -21916,7 +21918,7 @@ interface operations {
|
|
|
21916
21918
|
id: string;
|
|
21917
21919
|
/** @description SCREAMING_CASE network-distance enum. */
|
|
21918
21920
|
network_distance: string;
|
|
21919
|
-
/** @description
|
|
21921
|
+
/** @description The member's headline. A people search or a talent-pool search stores it in your tenant's entity records, with no expiry. A pipeline read, an applicant read and a pasted-URL search store nothing. */
|
|
21920
21922
|
headline?: string;
|
|
21921
21923
|
location?: string;
|
|
21922
21924
|
can_send_inmail?: boolean;
|
|
@@ -21938,7 +21940,7 @@ interface operations {
|
|
|
21938
21940
|
employment_type?: string;
|
|
21939
21941
|
workplace_type?: string;
|
|
21940
21942
|
}[];
|
|
21941
|
-
/** @description
|
|
21943
|
+
/** @description The member's display name. A people search or a talent-pool search stores it in your tenant's entity records, with no expiry. A pipeline read, an applicant read and a pasted-URL search store nothing. */
|
|
21942
21944
|
display_name?: string;
|
|
21943
21945
|
public_identifier?: string;
|
|
21944
21946
|
profile_url?: string;
|
|
@@ -22116,7 +22118,7 @@ interface operations {
|
|
|
22116
22118
|
id: string;
|
|
22117
22119
|
/** @description SCREAMING_CASE network-distance enum. */
|
|
22118
22120
|
network_distance: string;
|
|
22119
|
-
/** @description
|
|
22121
|
+
/** @description The member's headline. A people search or a talent-pool search stores it in your tenant's entity records, with no expiry. A pipeline read, an applicant read and a pasted-URL search store nothing. */
|
|
22120
22122
|
headline?: string;
|
|
22121
22123
|
location?: string;
|
|
22122
22124
|
can_send_inmail?: boolean;
|
|
@@ -22138,7 +22140,7 @@ interface operations {
|
|
|
22138
22140
|
employment_type?: string;
|
|
22139
22141
|
workplace_type?: string;
|
|
22140
22142
|
}[];
|
|
22141
|
-
/** @description
|
|
22143
|
+
/** @description The member's display name. A people search or a talent-pool search stores it in your tenant's entity records, with no expiry. A pipeline read, an applicant read and a pasted-URL search store nothing. */
|
|
22142
22144
|
display_name?: string;
|
|
22143
22145
|
public_identifier?: string;
|
|
22144
22146
|
profile_url?: string;
|
|
@@ -22188,7 +22190,7 @@ interface operations {
|
|
|
22188
22190
|
id: string;
|
|
22189
22191
|
/** @description SCREAMING_CASE network-distance enum. */
|
|
22190
22192
|
network_distance: string;
|
|
22191
|
-
/** @description
|
|
22193
|
+
/** @description The member's headline. A people search or a talent-pool search stores it in your tenant's entity records, with no expiry. A pipeline read, an applicant read and a pasted-URL search store nothing. */
|
|
22192
22194
|
headline?: string;
|
|
22193
22195
|
location?: string;
|
|
22194
22196
|
can_send_inmail?: boolean;
|
|
@@ -22210,7 +22212,7 @@ interface operations {
|
|
|
22210
22212
|
employment_type?: string;
|
|
22211
22213
|
workplace_type?: string;
|
|
22212
22214
|
}[];
|
|
22213
|
-
/** @description
|
|
22215
|
+
/** @description The member's display name. A people search or a talent-pool search stores it in your tenant's entity records, with no expiry. A pipeline read, an applicant read and a pasted-URL search store nothing. */
|
|
22214
22216
|
display_name?: string;
|
|
22215
22217
|
public_identifier?: string;
|
|
22216
22218
|
profile_url?: string;
|
|
@@ -22261,7 +22263,7 @@ interface operations {
|
|
|
22261
22263
|
id: string;
|
|
22262
22264
|
/** @description SCREAMING_CASE network-distance enum. */
|
|
22263
22265
|
network_distance: string;
|
|
22264
|
-
/** @description
|
|
22266
|
+
/** @description The member's headline. A people search or a talent-pool search stores it in your tenant's entity records, with no expiry. A pipeline read, an applicant read and a pasted-URL search store nothing. */
|
|
22265
22267
|
headline?: string;
|
|
22266
22268
|
location?: string;
|
|
22267
22269
|
can_send_inmail?: boolean;
|
|
@@ -22283,7 +22285,7 @@ interface operations {
|
|
|
22283
22285
|
employment_type?: string;
|
|
22284
22286
|
workplace_type?: string;
|
|
22285
22287
|
}[];
|
|
22286
|
-
/** @description
|
|
22288
|
+
/** @description The member's display name. A people search or a talent-pool search stores it in your tenant's entity records, with no expiry. A pipeline read, an applicant read and a pasted-URL search store nothing. */
|
|
22287
22289
|
display_name?: string;
|
|
22288
22290
|
public_identifier?: string;
|
|
22289
22291
|
profile_url?: string;
|
|
@@ -24373,7 +24375,7 @@ interface operations {
|
|
|
24373
24375
|
id: string;
|
|
24374
24376
|
/** @description SCREAMING_CASE network-distance enum. */
|
|
24375
24377
|
network_distance: string;
|
|
24376
|
-
/** @description
|
|
24378
|
+
/** @description The member's headline. A people search or a talent-pool search stores it in your tenant's entity records, with no expiry. A pipeline read, an applicant read and a pasted-URL search store nothing. */
|
|
24377
24379
|
headline?: string;
|
|
24378
24380
|
location?: string;
|
|
24379
24381
|
can_send_inmail?: boolean;
|
|
@@ -24395,7 +24397,7 @@ interface operations {
|
|
|
24395
24397
|
employment_type?: string;
|
|
24396
24398
|
workplace_type?: string;
|
|
24397
24399
|
}[];
|
|
24398
|
-
/** @description
|
|
24400
|
+
/** @description The member's display name. A people search or a talent-pool search stores it in your tenant's entity records, with no expiry. A pipeline read, an applicant read and a pasted-URL search store nothing. */
|
|
24399
24401
|
display_name?: string;
|
|
24400
24402
|
public_identifier?: string;
|
|
24401
24403
|
profile_url?: string;
|
|
@@ -24586,7 +24588,7 @@ interface operations {
|
|
|
24586
24588
|
id: string;
|
|
24587
24589
|
/** @description SCREAMING_CASE network-distance enum. */
|
|
24588
24590
|
network_distance: string;
|
|
24589
|
-
/** @description
|
|
24591
|
+
/** @description The member's headline. A people search or a talent-pool search stores it in your tenant's entity records, with no expiry. A pipeline read, an applicant read and a pasted-URL search store nothing. */
|
|
24590
24592
|
headline?: string;
|
|
24591
24593
|
location?: string;
|
|
24592
24594
|
can_send_inmail?: boolean;
|
|
@@ -24608,7 +24610,7 @@ interface operations {
|
|
|
24608
24610
|
employment_type?: string;
|
|
24609
24611
|
workplace_type?: string;
|
|
24610
24612
|
}[];
|
|
24611
|
-
/** @description
|
|
24613
|
+
/** @description The member's display name. A people search or a talent-pool search stores it in your tenant's entity records, with no expiry. A pipeline read, an applicant read and a pasted-URL search store nothing. */
|
|
24612
24614
|
display_name?: string;
|
|
24613
24615
|
public_identifier?: string;
|
|
24614
24616
|
profile_url?: string;
|
|
@@ -25085,7 +25087,7 @@ interface operations {
|
|
|
25085
25087
|
public_picture_url?: string;
|
|
25086
25088
|
/** @description Large variant of the profile picture URL. Present when available. */
|
|
25087
25089
|
public_picture_url_large?: string;
|
|
25088
|
-
/** @description
|
|
25090
|
+
/** @description Professional headline. Present when populated. Reading it back through Curviate stores it in your tenant's entity records, with no expiry. */
|
|
25089
25091
|
description?: string;
|
|
25090
25092
|
/** @description Location as set on the profile. Present when available. */
|
|
25091
25093
|
location?: string;
|
|
@@ -32138,6 +32140,24 @@ declare class SearchResource {
|
|
|
32138
32140
|
/**
|
|
32139
32141
|
* Resolve human-readable terms to opaque filter IDs for structured search.
|
|
32140
32142
|
* `GET /v1/{account_id}/search/parameters`
|
|
32143
|
+
*
|
|
32144
|
+
* Paginated: the response carries a `cursor`, and sending it back as
|
|
32145
|
+
* `cursor` returns the next page. Stop when it comes back `null`. `offset`
|
|
32146
|
+
* stays available as the numeric fallback. A malformed cursor is a `400`.
|
|
32147
|
+
*
|
|
32148
|
+
* @example
|
|
32149
|
+
* ```ts
|
|
32150
|
+
* let cursor: string | null | undefined;
|
|
32151
|
+
* do {
|
|
32152
|
+
* const page = await acc.search.getParameters({
|
|
32153
|
+
* type: "SKILL",
|
|
32154
|
+
* keywords: "software development",
|
|
32155
|
+
* ...(cursor ? { cursor } : {}),
|
|
32156
|
+
* });
|
|
32157
|
+
* for (const item of page.items) console.log(item.id, item.name);
|
|
32158
|
+
* cursor = page.cursor;
|
|
32159
|
+
* } while (cursor);
|
|
32160
|
+
* ```
|
|
32141
32161
|
*/
|
|
32142
32162
|
getParameters(query: SearchParametersQuery): Promise<SearchParametersResult>;
|
|
32143
32163
|
/**
|
package/dist/index.js
CHANGED
|
@@ -1132,6 +1132,24 @@ var SearchResource = class {
|
|
|
1132
1132
|
/**
|
|
1133
1133
|
* Resolve human-readable terms to opaque filter IDs for structured search.
|
|
1134
1134
|
* `GET /v1/{account_id}/search/parameters`
|
|
1135
|
+
*
|
|
1136
|
+
* Paginated: the response carries a `cursor`, and sending it back as
|
|
1137
|
+
* `cursor` returns the next page. Stop when it comes back `null`. `offset`
|
|
1138
|
+
* stays available as the numeric fallback. A malformed cursor is a `400`.
|
|
1139
|
+
*
|
|
1140
|
+
* @example
|
|
1141
|
+
* ```ts
|
|
1142
|
+
* let cursor: string | null | undefined;
|
|
1143
|
+
* do {
|
|
1144
|
+
* const page = await acc.search.getParameters({
|
|
1145
|
+
* type: "SKILL",
|
|
1146
|
+
* keywords: "software development",
|
|
1147
|
+
* ...(cursor ? { cursor } : {}),
|
|
1148
|
+
* });
|
|
1149
|
+
* for (const item of page.items) console.log(item.id, item.name);
|
|
1150
|
+
* cursor = page.cursor;
|
|
1151
|
+
* } while (cursor);
|
|
1152
|
+
* ```
|
|
1135
1153
|
*/
|
|
1136
1154
|
getParameters(query) {
|
|
1137
1155
|
return this.ctx.request({
|
package/package.json
CHANGED
package/src/generated/types.ts
CHANGED
|
@@ -563,7 +563,7 @@ export interface paths {
|
|
|
563
563
|
};
|
|
564
564
|
/**
|
|
565
565
|
* Resolve search filter IDs
|
|
566
|
-
* @description Resolves human-readable terms (e.g. 'software development') to opaque filter IDs for use in structured search filters. The type parameter selects the filter category; keywords is required for every type, including EMPLOYMENT_TYPE.
|
|
566
|
+
* @description Resolves human-readable terms (e.g. 'software development') to opaque filter IDs for use in structured search filters. The type parameter selects the filter category; keywords is required for every type, including EMPLOYMENT_TYPE. Results paginate: send the cursor from the previous response to get the next page, and stop when it comes back null.
|
|
567
567
|
*/
|
|
568
568
|
get: operations["getV1AccountIdSearchParameters"];
|
|
569
569
|
put?: never;
|
|
@@ -4114,7 +4114,7 @@ export interface operations {
|
|
|
4114
4114
|
};
|
|
4115
4115
|
requestBody?: never;
|
|
4116
4116
|
responses: {
|
|
4117
|
-
/** @description The company pages the account administers, each with its per-page admin capability matrix. An account that administers no pages returns an empty list; never a 403. Page names are returned verbatim and are
|
|
4117
|
+
/** @description The company pages the account administers, each with its per-page admin capability matrix. An account that administers no pages returns an empty list; never a 403. Page names are returned verbatim and are stored in your tenant's entity records, with no expiry. */
|
|
4118
4118
|
200: {
|
|
4119
4119
|
headers: {
|
|
4120
4120
|
"RateLimit-Policy": components["headers"]["RateLimit-Policy"];
|
|
@@ -4144,7 +4144,7 @@ export interface operations {
|
|
|
4144
4144
|
id: string | null;
|
|
4145
4145
|
/** @description Native company urn. */
|
|
4146
4146
|
entity_urn?: string | null;
|
|
4147
|
-
/** @description Page display name
|
|
4147
|
+
/** @description Page display name. Reading it back through Curviate stores it in your tenant's entity records, with no expiry. */
|
|
4148
4148
|
name?: string | null;
|
|
4149
4149
|
/** @description Vanity slug (the `/company/<slug>/` segment). */
|
|
4150
4150
|
universal_name?: string | null;
|
|
@@ -6404,7 +6404,7 @@ export interface operations {
|
|
|
6404
6404
|
};
|
|
6405
6405
|
requestBody?: never;
|
|
6406
6406
|
responses: {
|
|
6407
|
-
/** @description A page of the company page's followers; the admin analytics follower list. Follower names and headlines are returned verbatim and are
|
|
6407
|
+
/** @description A page of the company page's followers; the admin analytics follower list. Follower names and headlines are returned verbatim and are stored in your tenant's entity records, with no expiry. Page until cursor is null. */
|
|
6408
6408
|
200: {
|
|
6409
6409
|
headers: {
|
|
6410
6410
|
"RateLimit-Policy": components["headers"]["RateLimit-Policy"];
|
|
@@ -6427,9 +6427,9 @@ export interface operations {
|
|
|
6427
6427
|
object: "company_follower";
|
|
6428
6428
|
/** @description The follower's member id. */
|
|
6429
6429
|
id: string;
|
|
6430
|
-
/** @description Follower display name
|
|
6430
|
+
/** @description Follower display name. Reading it back through Curviate stores it in your tenant's entity records, with no expiry. */
|
|
6431
6431
|
name?: string | null;
|
|
6432
|
-
/** @description Follower headline
|
|
6432
|
+
/** @description Follower headline. Reading it back through Curviate stores it in your tenant's entity records, with no expiry. */
|
|
6433
6433
|
headline?: string | null;
|
|
6434
6434
|
/** @description Vanity slug. */
|
|
6435
6435
|
public_identifier?: string | null;
|
|
@@ -8324,10 +8324,12 @@ export interface operations {
|
|
|
8324
8324
|
type: "LOCATION" | "PEOPLE" | "RELATION" | "COMPANY" | "SCHOOL" | "INDUSTRY" | "SERVICE" | "JOB_FUNCTION" | "JOB_TITLE" | "EMPLOYMENT_TYPE" | "SKILL";
|
|
8325
8325
|
/** @description Human term to resolve to opaque filter IDs (e.g. 'software development'). Required for every type, including EMPLOYMENT_TYPE. */
|
|
8326
8326
|
keywords: string;
|
|
8327
|
-
/** @description Zero-based pagination offset (default 0). */
|
|
8327
|
+
/** @description Zero-based pagination offset; a numeric fallback for cursor (default 0). */
|
|
8328
8328
|
offset?: number;
|
|
8329
8329
|
/** @description Number of parameters to return (1-100, default 10). */
|
|
8330
8330
|
limit?: number;
|
|
8331
|
+
/** @description Opaque pagination cursor returned from a previous response. */
|
|
8332
|
+
cursor?: string;
|
|
8331
8333
|
};
|
|
8332
8334
|
header?: never;
|
|
8333
8335
|
path: {
|
|
@@ -8365,7 +8367,7 @@ export interface operations {
|
|
|
8365
8367
|
};
|
|
8366
8368
|
};
|
|
8367
8369
|
};
|
|
8368
|
-
/** @description Missing or empty account_id, missing or empty type, missing keywords,
|
|
8370
|
+
/** @description Missing or empty account_id, missing or empty type, missing keywords, type not in the classic allowlist, or malformed cursor. */
|
|
8369
8371
|
400: {
|
|
8370
8372
|
headers: {
|
|
8371
8373
|
[name: string]: unknown;
|
|
@@ -19685,7 +19687,7 @@ export interface operations {
|
|
|
19685
19687
|
public_picture_url?: string;
|
|
19686
19688
|
/** @description Large profile picture URL. */
|
|
19687
19689
|
public_picture_url_large?: string;
|
|
19688
|
-
/** @description
|
|
19690
|
+
/** @description The member's professional headline. Reading it back through Curviate stores it in your tenant's entity records, with no expiry. */
|
|
19689
19691
|
description?: string;
|
|
19690
19692
|
/** @description Geographic location string. */
|
|
19691
19693
|
location?: string;
|
|
@@ -19967,7 +19969,7 @@ export interface operations {
|
|
|
19967
19969
|
/** @description Section names that were requested but throttled by LinkedIn. */
|
|
19968
19970
|
throttled_sections?: string[];
|
|
19969
19971
|
};
|
|
19970
|
-
/** @description Recruiter-only enrichment: notes, tags, and message-activity events.
|
|
19972
|
+
/** @description Recruiter-only enrichment: notes, tags, and message-activity events. The notes, the tags and each event's message text are removed before anything is written, on every path. The rest of this object is stored in your tenant's entity records, with no expiry. */
|
|
19971
19973
|
recruiting_profile: {
|
|
19972
19974
|
/** @description Recruiter notes on this candidate. Passes through, never stored. */
|
|
19973
19975
|
notes?: string | null;
|
|
@@ -20469,7 +20471,7 @@ export interface operations {
|
|
|
20469
20471
|
id: string;
|
|
20470
20472
|
/** @description SCREAMING_CASE network-distance enum. */
|
|
20471
20473
|
network_distance: string;
|
|
20472
|
-
/** @description
|
|
20474
|
+
/** @description The member's headline. A people search or a talent-pool search stores it in your tenant's entity records, with no expiry. A pipeline read, an applicant read and a pasted-URL search store nothing. */
|
|
20473
20475
|
headline?: string;
|
|
20474
20476
|
location?: string;
|
|
20475
20477
|
can_send_inmail?: boolean;
|
|
@@ -20491,7 +20493,7 @@ export interface operations {
|
|
|
20491
20493
|
employment_type?: string;
|
|
20492
20494
|
workplace_type?: string;
|
|
20493
20495
|
}[];
|
|
20494
|
-
/** @description
|
|
20496
|
+
/** @description The member's display name. A people search or a talent-pool search stores it in your tenant's entity records, with no expiry. A pipeline read, an applicant read and a pasted-URL search store nothing. */
|
|
20495
20497
|
display_name?: string;
|
|
20496
20498
|
public_identifier?: string;
|
|
20497
20499
|
profile_url?: string;
|
|
@@ -21511,7 +21513,7 @@ export interface operations {
|
|
|
21511
21513
|
id: string;
|
|
21512
21514
|
/** @description SCREAMING_CASE network-distance enum. */
|
|
21513
21515
|
network_distance: string;
|
|
21514
|
-
/** @description
|
|
21516
|
+
/** @description The member's headline. A people search or a talent-pool search stores it in your tenant's entity records, with no expiry. A pipeline read, an applicant read and a pasted-URL search store nothing. */
|
|
21515
21517
|
headline?: string;
|
|
21516
21518
|
location?: string;
|
|
21517
21519
|
can_send_inmail?: boolean;
|
|
@@ -21533,7 +21535,7 @@ export interface operations {
|
|
|
21533
21535
|
employment_type?: string;
|
|
21534
21536
|
workplace_type?: string;
|
|
21535
21537
|
}[];
|
|
21536
|
-
/** @description
|
|
21538
|
+
/** @description The member's display name. A people search or a talent-pool search stores it in your tenant's entity records, with no expiry. A pipeline read, an applicant read and a pasted-URL search store nothing. */
|
|
21537
21539
|
display_name?: string;
|
|
21538
21540
|
public_identifier?: string;
|
|
21539
21541
|
profile_url?: string;
|
|
@@ -21820,7 +21822,7 @@ export interface operations {
|
|
|
21820
21822
|
id: string;
|
|
21821
21823
|
/** @description SCREAMING_CASE network-distance enum. */
|
|
21822
21824
|
network_distance: string;
|
|
21823
|
-
/** @description
|
|
21825
|
+
/** @description The member's headline. A people search or a talent-pool search stores it in your tenant's entity records, with no expiry. A pipeline read, an applicant read and a pasted-URL search store nothing. */
|
|
21824
21826
|
headline?: string;
|
|
21825
21827
|
location?: string;
|
|
21826
21828
|
can_send_inmail?: boolean;
|
|
@@ -21842,7 +21844,7 @@ export interface operations {
|
|
|
21842
21844
|
employment_type?: string;
|
|
21843
21845
|
workplace_type?: string;
|
|
21844
21846
|
}[];
|
|
21845
|
-
/** @description
|
|
21847
|
+
/** @description The member's display name. A people search or a talent-pool search stores it in your tenant's entity records, with no expiry. A pipeline read, an applicant read and a pasted-URL search store nothing. */
|
|
21846
21848
|
display_name?: string;
|
|
21847
21849
|
public_identifier?: string;
|
|
21848
21850
|
profile_url?: string;
|
|
@@ -22020,7 +22022,7 @@ export interface operations {
|
|
|
22020
22022
|
id: string;
|
|
22021
22023
|
/** @description SCREAMING_CASE network-distance enum. */
|
|
22022
22024
|
network_distance: string;
|
|
22023
|
-
/** @description
|
|
22025
|
+
/** @description The member's headline. A people search or a talent-pool search stores it in your tenant's entity records, with no expiry. A pipeline read, an applicant read and a pasted-URL search store nothing. */
|
|
22024
22026
|
headline?: string;
|
|
22025
22027
|
location?: string;
|
|
22026
22028
|
can_send_inmail?: boolean;
|
|
@@ -22042,7 +22044,7 @@ export interface operations {
|
|
|
22042
22044
|
employment_type?: string;
|
|
22043
22045
|
workplace_type?: string;
|
|
22044
22046
|
}[];
|
|
22045
|
-
/** @description
|
|
22047
|
+
/** @description The member's display name. A people search or a talent-pool search stores it in your tenant's entity records, with no expiry. A pipeline read, an applicant read and a pasted-URL search store nothing. */
|
|
22046
22048
|
display_name?: string;
|
|
22047
22049
|
public_identifier?: string;
|
|
22048
22050
|
profile_url?: string;
|
|
@@ -22092,7 +22094,7 @@ export interface operations {
|
|
|
22092
22094
|
id: string;
|
|
22093
22095
|
/** @description SCREAMING_CASE network-distance enum. */
|
|
22094
22096
|
network_distance: string;
|
|
22095
|
-
/** @description
|
|
22097
|
+
/** @description The member's headline. A people search or a talent-pool search stores it in your tenant's entity records, with no expiry. A pipeline read, an applicant read and a pasted-URL search store nothing. */
|
|
22096
22098
|
headline?: string;
|
|
22097
22099
|
location?: string;
|
|
22098
22100
|
can_send_inmail?: boolean;
|
|
@@ -22114,7 +22116,7 @@ export interface operations {
|
|
|
22114
22116
|
employment_type?: string;
|
|
22115
22117
|
workplace_type?: string;
|
|
22116
22118
|
}[];
|
|
22117
|
-
/** @description
|
|
22119
|
+
/** @description The member's display name. A people search or a talent-pool search stores it in your tenant's entity records, with no expiry. A pipeline read, an applicant read and a pasted-URL search store nothing. */
|
|
22118
22120
|
display_name?: string;
|
|
22119
22121
|
public_identifier?: string;
|
|
22120
22122
|
profile_url?: string;
|
|
@@ -22165,7 +22167,7 @@ export interface operations {
|
|
|
22165
22167
|
id: string;
|
|
22166
22168
|
/** @description SCREAMING_CASE network-distance enum. */
|
|
22167
22169
|
network_distance: string;
|
|
22168
|
-
/** @description
|
|
22170
|
+
/** @description The member's headline. A people search or a talent-pool search stores it in your tenant's entity records, with no expiry. A pipeline read, an applicant read and a pasted-URL search store nothing. */
|
|
22169
22171
|
headline?: string;
|
|
22170
22172
|
location?: string;
|
|
22171
22173
|
can_send_inmail?: boolean;
|
|
@@ -22187,7 +22189,7 @@ export interface operations {
|
|
|
22187
22189
|
employment_type?: string;
|
|
22188
22190
|
workplace_type?: string;
|
|
22189
22191
|
}[];
|
|
22190
|
-
/** @description
|
|
22192
|
+
/** @description The member's display name. A people search or a talent-pool search stores it in your tenant's entity records, with no expiry. A pipeline read, an applicant read and a pasted-URL search store nothing. */
|
|
22191
22193
|
display_name?: string;
|
|
22192
22194
|
public_identifier?: string;
|
|
22193
22195
|
profile_url?: string;
|
|
@@ -24277,7 +24279,7 @@ export interface operations {
|
|
|
24277
24279
|
id: string;
|
|
24278
24280
|
/** @description SCREAMING_CASE network-distance enum. */
|
|
24279
24281
|
network_distance: string;
|
|
24280
|
-
/** @description
|
|
24282
|
+
/** @description The member's headline. A people search or a talent-pool search stores it in your tenant's entity records, with no expiry. A pipeline read, an applicant read and a pasted-URL search store nothing. */
|
|
24281
24283
|
headline?: string;
|
|
24282
24284
|
location?: string;
|
|
24283
24285
|
can_send_inmail?: boolean;
|
|
@@ -24299,7 +24301,7 @@ export interface operations {
|
|
|
24299
24301
|
employment_type?: string;
|
|
24300
24302
|
workplace_type?: string;
|
|
24301
24303
|
}[];
|
|
24302
|
-
/** @description
|
|
24304
|
+
/** @description The member's display name. A people search or a talent-pool search stores it in your tenant's entity records, with no expiry. A pipeline read, an applicant read and a pasted-URL search store nothing. */
|
|
24303
24305
|
display_name?: string;
|
|
24304
24306
|
public_identifier?: string;
|
|
24305
24307
|
profile_url?: string;
|
|
@@ -24490,7 +24492,7 @@ export interface operations {
|
|
|
24490
24492
|
id: string;
|
|
24491
24493
|
/** @description SCREAMING_CASE network-distance enum. */
|
|
24492
24494
|
network_distance: string;
|
|
24493
|
-
/** @description
|
|
24495
|
+
/** @description The member's headline. A people search or a talent-pool search stores it in your tenant's entity records, with no expiry. A pipeline read, an applicant read and a pasted-URL search store nothing. */
|
|
24494
24496
|
headline?: string;
|
|
24495
24497
|
location?: string;
|
|
24496
24498
|
can_send_inmail?: boolean;
|
|
@@ -24512,7 +24514,7 @@ export interface operations {
|
|
|
24512
24514
|
employment_type?: string;
|
|
24513
24515
|
workplace_type?: string;
|
|
24514
24516
|
}[];
|
|
24515
|
-
/** @description
|
|
24517
|
+
/** @description The member's display name. A people search or a talent-pool search stores it in your tenant's entity records, with no expiry. A pipeline read, an applicant read and a pasted-URL search store nothing. */
|
|
24516
24518
|
display_name?: string;
|
|
24517
24519
|
public_identifier?: string;
|
|
24518
24520
|
profile_url?: string;
|
|
@@ -24989,7 +24991,7 @@ export interface operations {
|
|
|
24989
24991
|
public_picture_url?: string;
|
|
24990
24992
|
/** @description Large variant of the profile picture URL. Present when available. */
|
|
24991
24993
|
public_picture_url_large?: string;
|
|
24992
|
-
/** @description
|
|
24994
|
+
/** @description Professional headline. Present when populated. Reading it back through Curviate stores it in your tenant's entity records, with no expiry. */
|
|
24993
24995
|
description?: string;
|
|
24994
24996
|
/** @description Location as set on the profile. Present when available. */
|
|
24995
24997
|
location?: string;
|