@curviate/sdk 0.20.2 → 0.21.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 +58 -0
- package/dist/index.d.ts +796 -60
- package/package.json +1 -1
- package/src/generated/types.ts +796 -60
package/dist/index.d.ts
CHANGED
|
@@ -2540,6 +2540,26 @@ interface paths {
|
|
|
2540
2540
|
patch?: never;
|
|
2541
2541
|
trace?: never;
|
|
2542
2542
|
};
|
|
2543
|
+
"/v1/webhooks/{id}/test": {
|
|
2544
|
+
parameters: {
|
|
2545
|
+
query?: never;
|
|
2546
|
+
header?: never;
|
|
2547
|
+
path?: never;
|
|
2548
|
+
cookie?: never;
|
|
2549
|
+
};
|
|
2550
|
+
get?: never;
|
|
2551
|
+
put?: never;
|
|
2552
|
+
/**
|
|
2553
|
+
* Send a test delivery
|
|
2554
|
+
* @description Queues a synthetic delivery to this webhook so you can confirm your endpoint really receives and verifies deliveries, without waiting for a real event. It travels the normal path: the same signature construction, the same custom headers, the same delivery record, the same retry schedule. The event name is always webhook.test, which is not in the event catalogue and cannot be subscribed to, so it can never be mistaken for a real event. The payload carries no LinkedIn content. Match data.test_id in what arrives against the test_id in this response.
|
|
2555
|
+
*/
|
|
2556
|
+
post: operations["postV1WebhooksIdTest"];
|
|
2557
|
+
delete?: never;
|
|
2558
|
+
options?: never;
|
|
2559
|
+
head?: never;
|
|
2560
|
+
patch?: never;
|
|
2561
|
+
trace?: never;
|
|
2562
|
+
};
|
|
2543
2563
|
"/v1/webhooks/{id}": {
|
|
2544
2564
|
parameters: {
|
|
2545
2565
|
query?: never;
|
|
@@ -2620,10 +2640,10 @@ interface components {
|
|
|
2620
2640
|
/** @description Present when something about this response is true but not visible in it. On a search, an entry names a filter value we could not check before sending it, or reports that some of the people on the page were not disclosed to the connected account, so an unexpected result count is explicable rather than silent. Branch on each entry's code, never on its message. */
|
|
2621
2641
|
notices?: {
|
|
2622
2642
|
/**
|
|
2623
|
-
* @description FILTER_VALUE_UNRESOLVED: the value matched no known filter option, so it was sent on as an id we could not check. FILTER_VALUE_UNCHECKED: the value already looked like an id, so it was never looked up, and this page came back empty. SOME_RESULTS_HIDDEN: some people on this page were not disclosed to the connected account, so those entries cannot be read back. ALL_RESULTS_HIDDEN: none of the people on this page were disclosed, so the page yielded nothing you can act on
|
|
2643
|
+
* @description FILTER_VALUE_UNRESOLVED: the value matched no known filter option, so it was sent on as an id we could not check. FILTER_VALUE_UNCHECKED: the value already looked like an id, so it was never looked up, and this page came back empty. SOME_RESULTS_HIDDEN: some people on this page were not disclosed to the connected account, so those entries cannot be read back. ALL_RESULTS_HIDDEN: none of the people on this page were disclosed, so the page yielded nothing you can act on, even when more pages follow. PAGE_TRUNCATED: this page is short because the search stopped fetching upstream pages, not because the results ran out; follow cursor, and treat only a null cursor as the end.
|
|
2624
2644
|
* @enum {string}
|
|
2625
2645
|
*/
|
|
2626
|
-
code: "FILTER_VALUE_UNRESOLVED" | "FILTER_VALUE_UNCHECKED" | "SOME_RESULTS_HIDDEN" | "ALL_RESULTS_HIDDEN";
|
|
2646
|
+
code: "FILTER_VALUE_UNRESOLVED" | "FILTER_VALUE_UNCHECKED" | "SOME_RESULTS_HIDDEN" | "ALL_RESULTS_HIDDEN" | "PAGE_TRUNCATED";
|
|
2627
2647
|
/** @description One sentence explaining the condition and how to resolve it. */
|
|
2628
2648
|
message: string;
|
|
2629
2649
|
/** @description The request field the notice is about, dotted for nested filters. */
|
|
@@ -2765,38 +2785,397 @@ interface operations {
|
|
|
2765
2785
|
} & {
|
|
2766
2786
|
[key: string]: unknown;
|
|
2767
2787
|
})[];
|
|
2768
|
-
/** @description Work experience entries. Present only when requested via linkedin_sections. */
|
|
2769
|
-
experience?: {
|
|
2788
|
+
/** @description Work experience entries, most recent first. Present only when linkedin_experience is requested via linkedin_sections. An entry with no ended_on is the member's current role. */
|
|
2789
|
+
experience?: ({
|
|
2790
|
+
/** @description Identifier of this work-experience entry. Not a company identifier. */
|
|
2791
|
+
id?: string;
|
|
2792
|
+
/** @description The employer. An object, not a name string. */
|
|
2793
|
+
company?: {
|
|
2794
|
+
/** @description The organization's platform identifier, when known. */
|
|
2795
|
+
id?: string | null;
|
|
2796
|
+
/** @description The organization's name. */
|
|
2797
|
+
name?: string;
|
|
2798
|
+
/** @description The organization's public URL slug, when known. */
|
|
2799
|
+
public_identifier?: string;
|
|
2800
|
+
/** @description The organization's logo URL. */
|
|
2801
|
+
picture_url?: string;
|
|
2802
|
+
/** @description Full LinkedIn URL for the organization. */
|
|
2803
|
+
profile_url?: string;
|
|
2804
|
+
/** @description The organization's industry labels. */
|
|
2805
|
+
industries?: string[];
|
|
2806
|
+
} & {
|
|
2807
|
+
[key: string]: unknown;
|
|
2808
|
+
};
|
|
2809
|
+
/** @description Job title held. This is the title field; there is no 'position' or 'title' key. */
|
|
2810
|
+
job_title?: string;
|
|
2811
|
+
/** @description Date the role started. Formatted MM/DD/YYYY, month first. The platform records month and year only. Every observed value uses day 01, so read the month and year and ignore the day. */
|
|
2812
|
+
started_on?: string;
|
|
2813
|
+
/** @description Date the role ended. Absent while the role is ongoing, so an absent value means current, not unknown. Formatted MM/DD/YYYY, month first, and the day is a derived offset rather than a real date: observed values are the first of the end month plus 29 days, which stays inside the end month for a 30 or 31 day month but pushes a February end into the following March. Subtract 29 days before reading the month and year, otherwise a February end reads as March and overstates the tenure by a month. */
|
|
2814
|
+
ended_on?: string;
|
|
2815
|
+
/** @description Where the role was based, as written on the profile. */
|
|
2816
|
+
location?: string;
|
|
2817
|
+
/** @description The member's own description of the role. Passes through verbatim, never stored. */
|
|
2818
|
+
description?: string;
|
|
2819
|
+
/** @description Employment arrangement, e.g. PERMANENT, PERMANENT_PART_TIME, CONTRACT, CONTRACT_PART_TIME, FREELANCE, SELF_EMPLOYED, INTERNSHIP, APPRENTICESHIP, TEMPORARY, VOLUNTEERING. Not present on every entry. */
|
|
2820
|
+
employment_type?: string;
|
|
2821
|
+
/** @description Working arrangement: ON_SITE, HYBRID, or REMOTE. Not present on every entry. */
|
|
2822
|
+
workplace_type?: string;
|
|
2823
|
+
/** @description Skills the member associated with this role. */
|
|
2824
|
+
skills?: string[];
|
|
2825
|
+
/** @description A short summary line of the associated skills. */
|
|
2826
|
+
skills_preview?: string;
|
|
2827
|
+
} & {
|
|
2770
2828
|
[key: string]: unknown;
|
|
2771
|
-
}[];
|
|
2772
|
-
/** @description Education entries. Present only when requested via linkedin_sections. */
|
|
2773
|
-
education?: {
|
|
2829
|
+
})[];
|
|
2830
|
+
/** @description Education entries. Present only when linkedin_education is requested via linkedin_sections. */
|
|
2831
|
+
education?: ({
|
|
2832
|
+
/** @description Identifier of this education entry. */
|
|
2833
|
+
id?: string;
|
|
2834
|
+
/** @description The institution. An object, not a name string. */
|
|
2835
|
+
school?: {
|
|
2836
|
+
/** @description The organization's platform identifier, when known. */
|
|
2837
|
+
id?: string | null;
|
|
2838
|
+
/** @description The organization's name. */
|
|
2839
|
+
name?: string;
|
|
2840
|
+
/** @description The organization's public URL slug, when known. */
|
|
2841
|
+
public_identifier?: string;
|
|
2842
|
+
/** @description The organization's logo URL. */
|
|
2843
|
+
picture_url?: string;
|
|
2844
|
+
/** @description Full LinkedIn URL for the organization. */
|
|
2845
|
+
profile_url?: string;
|
|
2846
|
+
/** @description The organization's industry labels. */
|
|
2847
|
+
industries?: string[];
|
|
2848
|
+
} & {
|
|
2849
|
+
[key: string]: unknown;
|
|
2850
|
+
};
|
|
2851
|
+
/** @description Name of the degree or qualification. */
|
|
2852
|
+
degree?: string;
|
|
2853
|
+
/** @description Subjects studied. Plural and always an array, even for a single subject. */
|
|
2854
|
+
fields_of_study?: string[];
|
|
2855
|
+
/** @description Grade or academic level reached. */
|
|
2856
|
+
grade?: string;
|
|
2857
|
+
/** @description Activities carried out during the studies. */
|
|
2858
|
+
activities?: string;
|
|
2859
|
+
/** @description The member's own description of the studies. Passes through verbatim, never stored. */
|
|
2860
|
+
description?: string;
|
|
2861
|
+
/** @description Date the studies started. Formatted MM/DD/YYYY, month first. The platform records month and year only. Every observed value uses day 01, so read the month and year and ignore the day. */
|
|
2862
|
+
started_on?: string;
|
|
2863
|
+
/** @description Date the studies ended. Absent while the entry is ongoing, so an absent value means current, not unknown. Formatted MM/DD/YYYY, month first. The platform records month and year only. The day component differs by field on this response: a work-experience end date carries a 29 day offset that can push the value into the following month, while a certification's expiry date uses day 01. Confirm against an entry whose real dates you know before deriving a month from the day here. */
|
|
2864
|
+
ended_on?: string;
|
|
2865
|
+
/** @description Skills the member associated with the studies. */
|
|
2866
|
+
skills?: string[];
|
|
2867
|
+
/** @description A short summary line of the associated skills. */
|
|
2868
|
+
skills_preview?: string;
|
|
2869
|
+
} & {
|
|
2774
2870
|
[key: string]: unknown;
|
|
2775
|
-
}[];
|
|
2776
|
-
/** @description
|
|
2777
|
-
languages?: {
|
|
2871
|
+
})[];
|
|
2872
|
+
/** @description Language entries. Present only when linkedin_languages is requested via linkedin_sections. */
|
|
2873
|
+
languages?: ({
|
|
2874
|
+
/** @description Name of the language. */
|
|
2875
|
+
language?: string;
|
|
2876
|
+
/** @description Stated fluency: ELEMENTARY, LIMITED_WORKING, PROFESSIONAL_WORKING, FULL_PROFESSIONAL, or NATIVE_OR_BILINGUAL. */
|
|
2877
|
+
proficiency?: string;
|
|
2878
|
+
} & {
|
|
2778
2879
|
[key: string]: unknown;
|
|
2779
|
-
}[];
|
|
2780
|
-
/** @description Certification entries. Present only when requested via linkedin_sections. */
|
|
2781
|
-
certifications?: {
|
|
2880
|
+
})[];
|
|
2881
|
+
/** @description Certification entries. Present only when linkedin_certifications is requested via linkedin_sections. */
|
|
2882
|
+
certifications?: ({
|
|
2883
|
+
/** @description Name of the certification. This is the name field; there is no 'name' key. */
|
|
2884
|
+
title?: string;
|
|
2885
|
+
/** @description The issuing body. An object, not a name string. */
|
|
2886
|
+
organization?: {
|
|
2887
|
+
/** @description The organization's platform identifier, when known. */
|
|
2888
|
+
id?: string | null;
|
|
2889
|
+
/** @description The organization's name. */
|
|
2890
|
+
name?: string;
|
|
2891
|
+
/** @description The organization's public URL slug, when known. */
|
|
2892
|
+
public_identifier?: string;
|
|
2893
|
+
/** @description The organization's logo URL. */
|
|
2894
|
+
picture_url?: string;
|
|
2895
|
+
/** @description Full LinkedIn URL for the organization. */
|
|
2896
|
+
profile_url?: string;
|
|
2897
|
+
/** @description The organization's industry labels. */
|
|
2898
|
+
industries?: string[];
|
|
2899
|
+
} & {
|
|
2900
|
+
[key: string]: unknown;
|
|
2901
|
+
};
|
|
2902
|
+
/** @description Date the certification was issued. Formatted MM/DD/YYYY, month first. The platform records month and year only. */
|
|
2903
|
+
issued_on?: string;
|
|
2904
|
+
/** @description Date the certification expires. Absent when it does not expire. Formatted MM/DD/YYYY, month first. The platform records month and year only. */
|
|
2905
|
+
expires_on?: string;
|
|
2906
|
+
/** @description License or credential identifier. */
|
|
2907
|
+
license?: string;
|
|
2908
|
+
/** @description Public URL for the certification. */
|
|
2909
|
+
url?: string;
|
|
2910
|
+
/** @description Skills the member associated with the certification. */
|
|
2911
|
+
skills?: string[];
|
|
2912
|
+
/** @description A short summary line of the associated skills. */
|
|
2913
|
+
skills_preview?: string;
|
|
2914
|
+
} & {
|
|
2782
2915
|
[key: string]: unknown;
|
|
2783
|
-
}[];
|
|
2784
|
-
/** @description Volunteering entries. Present only when requested via linkedin_sections. */
|
|
2785
|
-
volunteer_experience?: {
|
|
2916
|
+
})[];
|
|
2917
|
+
/** @description Volunteering entries. Present only when linkedin_volunteer_experience is requested via linkedin_sections. */
|
|
2918
|
+
volunteer_experience?: ({
|
|
2919
|
+
/** @description The organization volunteered for. An object, not a name string. */
|
|
2920
|
+
organization?: {
|
|
2921
|
+
/** @description The organization's platform identifier, when known. */
|
|
2922
|
+
id?: string | null;
|
|
2923
|
+
/** @description The organization's name. */
|
|
2924
|
+
name?: string;
|
|
2925
|
+
/** @description The organization's public URL slug, when known. */
|
|
2926
|
+
public_identifier?: string;
|
|
2927
|
+
/** @description The organization's logo URL. */
|
|
2928
|
+
picture_url?: string;
|
|
2929
|
+
/** @description Full LinkedIn URL for the organization. */
|
|
2930
|
+
profile_url?: string;
|
|
2931
|
+
/** @description The organization's industry labels. */
|
|
2932
|
+
industries?: string[];
|
|
2933
|
+
} & {
|
|
2934
|
+
[key: string]: unknown;
|
|
2935
|
+
};
|
|
2936
|
+
/** @description Role held while volunteering. */
|
|
2937
|
+
role?: string;
|
|
2938
|
+
/** @description The cause supported, as categorised by the platform. */
|
|
2939
|
+
cause?: string;
|
|
2940
|
+
/** @description The member's own description of the work. Passes through verbatim, never stored. */
|
|
2941
|
+
description?: string;
|
|
2942
|
+
/** @description Date the work started. Formatted MM/DD/YYYY, month first. The platform records month and year only. Every observed value uses day 01, so read the month and year and ignore the day. */
|
|
2943
|
+
started_on?: string;
|
|
2944
|
+
/** @description Date the work ended. Absent while the entry is ongoing, so an absent value means current, not unknown. Formatted MM/DD/YYYY, month first. The platform records month and year only. The day component differs by field on this response: a work-experience end date carries a 29 day offset that can push the value into the following month, while a certification's expiry date uses day 01. Confirm against an entry whose real dates you know before deriving a month from the day here. */
|
|
2945
|
+
ended_on?: string;
|
|
2946
|
+
} & {
|
|
2786
2947
|
[key: string]: unknown;
|
|
2787
|
-
}[];
|
|
2788
|
-
/** @description Project entries. Present only when requested via linkedin_sections. */
|
|
2789
|
-
projects?: {
|
|
2948
|
+
})[];
|
|
2949
|
+
/** @description Project entries. Present only when linkedin_projects is requested via linkedin_sections. */
|
|
2950
|
+
projects?: ({
|
|
2951
|
+
/** @description Name of the project. */
|
|
2952
|
+
name?: string;
|
|
2953
|
+
/** @description The member's own description of the project. Passes through verbatim, never stored. */
|
|
2954
|
+
description?: string;
|
|
2955
|
+
/** @description Other members credited on the project. */
|
|
2956
|
+
contributors?: ({
|
|
2957
|
+
/** @description The member's opaque identifier. */
|
|
2958
|
+
id?: string;
|
|
2959
|
+
/** @description Object discriminator for the embedded member. */
|
|
2960
|
+
object?: string;
|
|
2961
|
+
/** @description Profile type (e.g. individual). */
|
|
2962
|
+
type?: string;
|
|
2963
|
+
/** @description The member's display name. */
|
|
2964
|
+
display_name?: string;
|
|
2965
|
+
/** @description First name. */
|
|
2966
|
+
first_name?: string;
|
|
2967
|
+
/** @description Last name. */
|
|
2968
|
+
last_name?: string;
|
|
2969
|
+
/** @description LinkedIn public URL slug (e.g. 'jane-doe'). */
|
|
2970
|
+
public_identifier?: string;
|
|
2971
|
+
/** @description Full LinkedIn profile URL. */
|
|
2972
|
+
profile_url?: string;
|
|
2973
|
+
/** @description Profile picture URL. */
|
|
2974
|
+
public_picture_url?: string;
|
|
2975
|
+
/** @description The member's professional headline. */
|
|
2976
|
+
description?: string;
|
|
2977
|
+
} & {
|
|
2978
|
+
[key: string]: unknown;
|
|
2979
|
+
})[];
|
|
2980
|
+
/** @description Skills the member associated with the project. */
|
|
2981
|
+
skills?: string[];
|
|
2982
|
+
/** @description A short summary line of the associated skills. */
|
|
2983
|
+
skills_preview?: string;
|
|
2984
|
+
/** @description Date the project started. Formatted MM/DD/YYYY, month first. The platform records month and year only. Every observed value uses day 01, so read the month and year and ignore the day. */
|
|
2985
|
+
started_on?: string;
|
|
2986
|
+
/** @description Date the project ended. Absent while the entry is ongoing, so an absent value means current, not unknown. Formatted MM/DD/YYYY, month first. The platform records month and year only. The day component differs by field on this response: a work-experience end date carries a 29 day offset that can push the value into the following month, while a certification's expiry date uses day 01. Confirm against an entry whose real dates you know before deriving a month from the day here. */
|
|
2987
|
+
ended_on?: string;
|
|
2988
|
+
} & {
|
|
2790
2989
|
[key: string]: unknown;
|
|
2791
|
-
}[];
|
|
2792
|
-
/** @description Recommendations
|
|
2990
|
+
})[];
|
|
2991
|
+
/** @description Recommendations written about and by this member. An object with two arrays, not an array. Present only when linkedin_recommendations is requested via linkedin_sections. */
|
|
2793
2992
|
recommendations?: {
|
|
2993
|
+
/** @description Recommendations written about this member. */
|
|
2994
|
+
received?: ({
|
|
2995
|
+
/** @description The recommendation text. Passes through verbatim, never stored. */
|
|
2996
|
+
text?: string;
|
|
2997
|
+
/** @description How the two members worked together, as shown on the profile. */
|
|
2998
|
+
caption?: string;
|
|
2999
|
+
/** @description When the recommendation was written. */
|
|
3000
|
+
created_on?: string;
|
|
3001
|
+
/** @description The other member involved. May be null when the platform withholds the identity. */
|
|
3002
|
+
user?: {
|
|
3003
|
+
/** @description The member's opaque identifier. */
|
|
3004
|
+
id?: string;
|
|
3005
|
+
/** @description Object discriminator for the embedded member. */
|
|
3006
|
+
object?: string;
|
|
3007
|
+
/** @description Profile type (e.g. individual). */
|
|
3008
|
+
type?: string;
|
|
3009
|
+
/** @description The member's display name. */
|
|
3010
|
+
display_name?: string;
|
|
3011
|
+
/** @description First name. */
|
|
3012
|
+
first_name?: string;
|
|
3013
|
+
/** @description Last name. */
|
|
3014
|
+
last_name?: string;
|
|
3015
|
+
/** @description LinkedIn public URL slug (e.g. 'jane-doe'). */
|
|
3016
|
+
public_identifier?: string;
|
|
3017
|
+
/** @description Full LinkedIn profile URL. */
|
|
3018
|
+
profile_url?: string;
|
|
3019
|
+
/** @description Profile picture URL. */
|
|
3020
|
+
public_picture_url?: string;
|
|
3021
|
+
/** @description The member's professional headline. */
|
|
3022
|
+
description?: string;
|
|
3023
|
+
} & {
|
|
3024
|
+
[key: string]: unknown;
|
|
3025
|
+
};
|
|
3026
|
+
} & {
|
|
3027
|
+
[key: string]: unknown;
|
|
3028
|
+
})[];
|
|
3029
|
+
/** @description Recommendations this member wrote for others. */
|
|
3030
|
+
given?: ({
|
|
3031
|
+
/** @description The recommendation text. Passes through verbatim, never stored. */
|
|
3032
|
+
text?: string;
|
|
3033
|
+
/** @description How the two members worked together, as shown on the profile. */
|
|
3034
|
+
caption?: string;
|
|
3035
|
+
/** @description When the recommendation was written. */
|
|
3036
|
+
created_on?: string;
|
|
3037
|
+
/** @description The other member involved. May be null when the platform withholds the identity. */
|
|
3038
|
+
user?: {
|
|
3039
|
+
/** @description The member's opaque identifier. */
|
|
3040
|
+
id?: string;
|
|
3041
|
+
/** @description Object discriminator for the embedded member. */
|
|
3042
|
+
object?: string;
|
|
3043
|
+
/** @description Profile type (e.g. individual). */
|
|
3044
|
+
type?: string;
|
|
3045
|
+
/** @description The member's display name. */
|
|
3046
|
+
display_name?: string;
|
|
3047
|
+
/** @description First name. */
|
|
3048
|
+
first_name?: string;
|
|
3049
|
+
/** @description Last name. */
|
|
3050
|
+
last_name?: string;
|
|
3051
|
+
/** @description LinkedIn public URL slug (e.g. 'jane-doe'). */
|
|
3052
|
+
public_identifier?: string;
|
|
3053
|
+
/** @description Full LinkedIn profile URL. */
|
|
3054
|
+
profile_url?: string;
|
|
3055
|
+
/** @description Profile picture URL. */
|
|
3056
|
+
public_picture_url?: string;
|
|
3057
|
+
/** @description The member's professional headline. */
|
|
3058
|
+
description?: string;
|
|
3059
|
+
} & {
|
|
3060
|
+
[key: string]: unknown;
|
|
3061
|
+
};
|
|
3062
|
+
} & {
|
|
3063
|
+
[key: string]: unknown;
|
|
3064
|
+
})[];
|
|
3065
|
+
} & {
|
|
2794
3066
|
[key: string]: unknown;
|
|
2795
3067
|
};
|
|
2796
|
-
/** @description
|
|
3068
|
+
/** @description What this member follows, grouped by kind. An object, not an array. Present only when linkedin_interests is requested via linkedin_sections. */
|
|
2797
3069
|
interests?: {
|
|
3070
|
+
/** @description Followed LinkedIn Top Voices. */
|
|
3071
|
+
top_voices?: ({
|
|
3072
|
+
/** @description The member's opaque identifier. */
|
|
3073
|
+
id?: string;
|
|
3074
|
+
/** @description Object discriminator for the embedded member. */
|
|
3075
|
+
object?: string;
|
|
3076
|
+
/** @description Profile type (e.g. individual). */
|
|
3077
|
+
type?: string;
|
|
3078
|
+
/** @description The member's display name. */
|
|
3079
|
+
display_name?: string;
|
|
3080
|
+
/** @description First name. */
|
|
3081
|
+
first_name?: string;
|
|
3082
|
+
/** @description Last name. */
|
|
3083
|
+
last_name?: string;
|
|
3084
|
+
/** @description LinkedIn public URL slug (e.g. 'jane-doe'). */
|
|
3085
|
+
public_identifier?: string;
|
|
3086
|
+
/** @description Full LinkedIn profile URL. */
|
|
3087
|
+
profile_url?: string;
|
|
3088
|
+
/** @description Profile picture URL. */
|
|
3089
|
+
public_picture_url?: string;
|
|
3090
|
+
/** @description The member's professional headline. */
|
|
3091
|
+
description?: string;
|
|
3092
|
+
/** @description Follow-relationship detail for this member. */
|
|
3093
|
+
specifics?: {
|
|
3094
|
+
/** @description Whether this member is followed. */
|
|
3095
|
+
is_following?: boolean;
|
|
3096
|
+
/** @description How many members follow them. */
|
|
3097
|
+
followers_count?: number;
|
|
3098
|
+
} & {
|
|
3099
|
+
[key: string]: unknown;
|
|
3100
|
+
};
|
|
3101
|
+
} & {
|
|
3102
|
+
[key: string]: unknown;
|
|
3103
|
+
})[];
|
|
3104
|
+
/** @description Followed companies. */
|
|
3105
|
+
companies?: ({
|
|
3106
|
+
/** @description Object discriminator for the followed company. */
|
|
3107
|
+
object?: string;
|
|
3108
|
+
/** @description The company's platform identifier. */
|
|
3109
|
+
id?: string;
|
|
3110
|
+
/** @description The company's name. */
|
|
3111
|
+
name?: string;
|
|
3112
|
+
/** @description Full LinkedIn URL for the company. */
|
|
3113
|
+
profile_url?: string;
|
|
3114
|
+
/** @description The company's logo URL. */
|
|
3115
|
+
public_picture_url?: string;
|
|
3116
|
+
/** @description How many members follow the company. */
|
|
3117
|
+
followers_count?: number;
|
|
3118
|
+
/** @description Whether this member follows the company. */
|
|
3119
|
+
is_following?: boolean;
|
|
3120
|
+
} & {
|
|
3121
|
+
[key: string]: unknown;
|
|
3122
|
+
})[];
|
|
3123
|
+
/** @description Followed schools. */
|
|
3124
|
+
schools?: ({
|
|
3125
|
+
/** @description The school's platform identifier. */
|
|
3126
|
+
id?: string;
|
|
3127
|
+
/** @description The school's name. */
|
|
3128
|
+
name?: string;
|
|
3129
|
+
/** @description Object discriminator for the followed school. */
|
|
3130
|
+
object?: string;
|
|
3131
|
+
/** @description Full LinkedIn URL for the school. */
|
|
3132
|
+
profile_url?: string;
|
|
3133
|
+
/** @description The school's logo URL. */
|
|
3134
|
+
public_picture_url?: string;
|
|
3135
|
+
/** @description How many members follow the school. */
|
|
3136
|
+
followers_count?: number;
|
|
3137
|
+
/** @description Whether this member follows the school. */
|
|
3138
|
+
is_following?: boolean;
|
|
3139
|
+
} & {
|
|
3140
|
+
[key: string]: unknown;
|
|
3141
|
+
})[];
|
|
3142
|
+
/** @description Followed newsletters. */
|
|
3143
|
+
newsletters?: ({
|
|
3144
|
+
/** @description The newsletter's platform identifier. */
|
|
3145
|
+
id?: string;
|
|
3146
|
+
/** @description The newsletter's title. */
|
|
3147
|
+
title?: string;
|
|
3148
|
+
/** @description The newsletter's description. Passes through verbatim, never stored. */
|
|
3149
|
+
description?: string;
|
|
3150
|
+
/** @description Full LinkedIn URL for the newsletter. */
|
|
3151
|
+
url?: string;
|
|
3152
|
+
/** @description How often the newsletter publishes. */
|
|
3153
|
+
posting_frequency?: string;
|
|
3154
|
+
/** @description The newsletter's cover image URL. */
|
|
3155
|
+
public_picture_url?: string;
|
|
3156
|
+
/** @description Whether this member subscribes to the newsletter. */
|
|
3157
|
+
is_subscribed?: boolean;
|
|
3158
|
+
} & {
|
|
3159
|
+
[key: string]: unknown;
|
|
3160
|
+
})[];
|
|
3161
|
+
/** @description Groups joined. */
|
|
3162
|
+
groups?: ({
|
|
3163
|
+
/** @description The group's platform identifier. */
|
|
3164
|
+
id?: string;
|
|
3165
|
+
/** @description The group's name. */
|
|
3166
|
+
name?: string;
|
|
3167
|
+
/** @description Full LinkedIn URL for the group. */
|
|
3168
|
+
url?: string;
|
|
3169
|
+
/** @description The group's picture URL. */
|
|
3170
|
+
public_picture_url?: string;
|
|
3171
|
+
/** @description Whether this member belongs to the group. */
|
|
3172
|
+
is_member?: boolean;
|
|
3173
|
+
} & {
|
|
3174
|
+
[key: string]: unknown;
|
|
3175
|
+
})[];
|
|
3176
|
+
} & {
|
|
2798
3177
|
[key: string]: unknown;
|
|
2799
|
-
}
|
|
3178
|
+
};
|
|
2800
3179
|
/** @description Section names that were requested but throttled by LinkedIn. */
|
|
2801
3180
|
throttled_sections?: string[];
|
|
2802
3181
|
};
|
|
@@ -5077,24 +5456,24 @@ interface operations {
|
|
|
5077
5456
|
/** @description true if the account is verified. Present when available. */
|
|
5078
5457
|
is_verified?: boolean;
|
|
5079
5458
|
/**
|
|
5080
|
-
* @description Whether this result names someone you can act on. Always present, on both values. full: the result carries a resolvable identity, so you can read the profile and reach the person. hidden: LinkedIn did not disclose this person to the connected account, so the result carries no public_identifier and no member_id, its name is a placeholder rather than a real one, and reading it back returns 403. The cause is the connected LinkedIn account's own subscription level, which decides which profiles it is allowed to identify; it is not an error in your request. A page can be entirely hidden
|
|
5459
|
+
* @description Whether this result names someone you can act on. Always present, on both values. full: the result carries a resolvable identity, so you can read the profile and reach the person. hidden: LinkedIn did not disclose this person to the connected account, so the result carries no public_identifier and no member_id, its name is a placeholder rather than a real one, and reading it back returns 403. The cause is the connected LinkedIn account's own subscription level, which decides which profiles it is allowed to identify; it is not an error in your request. A page can be entirely hidden, so count the full results rather than the size of the page, and see notices[] for a page-level summary.
|
|
5081
5460
|
* @enum {string}
|
|
5082
5461
|
*/
|
|
5083
5462
|
visibility: "full" | "hidden";
|
|
5084
5463
|
}[];
|
|
5085
5464
|
paging: {
|
|
5086
|
-
/** @description Total number of matching employees across all pages. */
|
|
5087
|
-
total_count: number;
|
|
5465
|
+
/** @description Total number of matching employees across all pages, or null when the platform does not report one. Count the items rather than relying on this. */
|
|
5466
|
+
total_count: number | null;
|
|
5088
5467
|
};
|
|
5089
5468
|
/** @description Opaque cursor for the next page, or null when there are no more results. */
|
|
5090
5469
|
cursor: string | null;
|
|
5091
5470
|
/** @description Present only when there is something to report about this page, for example that some of these employees were not disclosed to the connected account and cannot be read back. Absent when there is nothing to report. */
|
|
5092
5471
|
notices?: {
|
|
5093
5472
|
/**
|
|
5094
|
-
* @description FILTER_VALUE_UNRESOLVED: the value matched no known filter option, so it was sent on as an id we could not check. FILTER_VALUE_UNCHECKED: the value already looked like an id, so it was never looked up, and this page came back empty. SOME_RESULTS_HIDDEN: some people on this page were not disclosed to the connected account, so those entries cannot be read back. ALL_RESULTS_HIDDEN: none of the people on this page were disclosed, so the page yielded nothing you can act on
|
|
5473
|
+
* @description FILTER_VALUE_UNRESOLVED: the value matched no known filter option, so it was sent on as an id we could not check. FILTER_VALUE_UNCHECKED: the value already looked like an id, so it was never looked up, and this page came back empty. SOME_RESULTS_HIDDEN: some people on this page were not disclosed to the connected account, so those entries cannot be read back. ALL_RESULTS_HIDDEN: none of the people on this page were disclosed, so the page yielded nothing you can act on, even when more pages follow. PAGE_TRUNCATED: this page is short because the search stopped fetching upstream pages, not because the results ran out; follow cursor, and treat only a null cursor as the end. Branch on this rather than on message.
|
|
5095
5474
|
* @enum {string}
|
|
5096
5475
|
*/
|
|
5097
|
-
code: "FILTER_VALUE_UNRESOLVED" | "FILTER_VALUE_UNCHECKED" | "SOME_RESULTS_HIDDEN" | "ALL_RESULTS_HIDDEN";
|
|
5476
|
+
code: "FILTER_VALUE_UNRESOLVED" | "FILTER_VALUE_UNCHECKED" | "SOME_RESULTS_HIDDEN" | "ALL_RESULTS_HIDDEN" | "PAGE_TRUNCATED";
|
|
5098
5477
|
/** @description One sentence explaining the condition and how to resolve it. */
|
|
5099
5478
|
message: string;
|
|
5100
5479
|
/** @description The request field the notice is about, dotted for nested filters. */
|
|
@@ -5276,8 +5655,8 @@ interface operations {
|
|
|
5276
5655
|
repost_count: number;
|
|
5277
5656
|
}[];
|
|
5278
5657
|
paging: {
|
|
5279
|
-
/** @description Total number of matching posts across all pages. */
|
|
5280
|
-
total_count: number;
|
|
5658
|
+
/** @description Total number of matching posts across all pages, or null when the platform does not report one. Count the items rather than relying on this. */
|
|
5659
|
+
total_count: number | null;
|
|
5281
5660
|
};
|
|
5282
5661
|
/** @description Opaque cursor for the next page, or null when there are no more results. */
|
|
5283
5662
|
cursor: string | null;
|
|
@@ -5455,8 +5834,8 @@ interface operations {
|
|
|
5455
5834
|
};
|
|
5456
5835
|
}[];
|
|
5457
5836
|
paging: {
|
|
5458
|
-
/** @description Total number of matching job postings across all pages. */
|
|
5459
|
-
total_count: number;
|
|
5837
|
+
/** @description Total number of matching job postings across all pages, or null when the platform does not report one. Count the items rather than relying on this. */
|
|
5838
|
+
total_count: number | null;
|
|
5460
5839
|
};
|
|
5461
5840
|
/** @description Opaque cursor for the next page, or null when there are no more results. */
|
|
5462
5841
|
cursor: string | null;
|
|
@@ -6026,6 +6405,8 @@ interface operations {
|
|
|
6026
6405
|
limit?: number;
|
|
6027
6406
|
/** @description Opaque pagination cursor from a prior response's cursor. Omit for the first page. */
|
|
6028
6407
|
cursor?: string;
|
|
6408
|
+
/** @description Additional response fields to resolve, comma-separated in a single value (for example expand=public_identifier). Accepted values: public_identifier. When requested, the field is present on every user object in the response, carrying either a value or null. Omit for the base fields only. Pass the parameter once; repeating it drops values. At most 25 people per request need an extra lookup to resolve; anyone beyond that carries null, so ask for a smaller page to resolve them all. */
|
|
6409
|
+
expand?: string;
|
|
6029
6410
|
};
|
|
6030
6411
|
header?: never;
|
|
6031
6412
|
path: {
|
|
@@ -6078,8 +6459,10 @@ interface operations {
|
|
|
6078
6459
|
kind: "member";
|
|
6079
6460
|
/** @description Member headline (content pass-through, never stored). */
|
|
6080
6461
|
headline?: string | null;
|
|
6081
|
-
/** @description Canonical member profile URL. */
|
|
6082
|
-
profile_url: string;
|
|
6462
|
+
/** @description Canonical member profile URL, or null when the platform surfaces no public profile for this person. */
|
|
6463
|
+
profile_url: string | null;
|
|
6464
|
+
/** @description The vanity slug from the profile URL, for example jane-smith. Present only when the request asks for it with expand=public_identifier, and then always present, carrying the slug or null when the platform surfaces none for this person. */
|
|
6465
|
+
public_identifier?: string | null;
|
|
6083
6466
|
}[];
|
|
6084
6467
|
/** @description Unread message count (0 = read). */
|
|
6085
6468
|
unread_count: number;
|
|
@@ -6097,6 +6480,20 @@ interface operations {
|
|
|
6097
6480
|
}[];
|
|
6098
6481
|
/** @description Opaque cursor for the next page, or null at end-of-list. */
|
|
6099
6482
|
cursor: string | null;
|
|
6483
|
+
/** @description Present only when expand=public_identifier was asked for and this page held more people needing a profile lookup than one request performs. Absent whenever there is nothing to report, so a response that resolved everyone carries no such key. Branch on each entry's code, never on its message. */
|
|
6484
|
+
notices?: {
|
|
6485
|
+
/**
|
|
6486
|
+
* @description EXPANSION_LIMIT_REACHED: more people on this page needed a profile lookup than one request performs, so the ones past the budget carry public_identifier null without ever having been looked up. Their null therefore does not mean the person has no public profile. Ask for a smaller page to resolve everyone.
|
|
6487
|
+
* @enum {string}
|
|
6488
|
+
*/
|
|
6489
|
+
code: "EXPANSION_LIMIT_REACHED";
|
|
6490
|
+
/** @description One sentence explaining the condition and how to resolve it. */
|
|
6491
|
+
message: string;
|
|
6492
|
+
/** @description The request field the notice is about, here expand. */
|
|
6493
|
+
field?: string;
|
|
6494
|
+
/** @description The expansion the notice is about, here public_identifier. */
|
|
6495
|
+
value?: string;
|
|
6496
|
+
}[];
|
|
6100
6497
|
};
|
|
6101
6498
|
};
|
|
6102
6499
|
};
|
|
@@ -6197,7 +6594,10 @@ interface operations {
|
|
|
6197
6594
|
};
|
|
6198
6595
|
getV1AccountIdCompaniesIdentifierChatsChatId: {
|
|
6199
6596
|
parameters: {
|
|
6200
|
-
query?:
|
|
6597
|
+
query?: {
|
|
6598
|
+
/** @description Additional response fields to resolve, comma-separated in a single value (for example expand=public_identifier). Accepted values: public_identifier. When requested, the field is present on every user object in the response, carrying either a value or null. Omit for the base fields only. Pass the parameter once; repeating it drops values. At most 25 people per request need an extra lookup to resolve; anyone beyond that carries null, so ask for a smaller page to resolve them all. */
|
|
6599
|
+
expand?: string;
|
|
6600
|
+
};
|
|
6201
6601
|
header?: never;
|
|
6202
6602
|
path: {
|
|
6203
6603
|
/** @description The connected LinkedIn account, which must administer the page. */
|
|
@@ -6244,8 +6644,10 @@ interface operations {
|
|
|
6244
6644
|
kind: "member";
|
|
6245
6645
|
/** @description Member headline (content pass-through, never stored). */
|
|
6246
6646
|
headline?: string | null;
|
|
6247
|
-
/** @description Canonical member profile URL. */
|
|
6248
|
-
profile_url: string;
|
|
6647
|
+
/** @description Canonical member profile URL, or null when the platform surfaces no public profile for this person. */
|
|
6648
|
+
profile_url: string | null;
|
|
6649
|
+
/** @description The vanity slug from the profile URL, for example jane-smith. Present only when the request asks for it with expand=public_identifier, and then always present, carrying the slug or null when the platform surfaces none for this person. */
|
|
6650
|
+
public_identifier?: string | null;
|
|
6249
6651
|
}[];
|
|
6250
6652
|
/** @description Unread message count (0 = read). */
|
|
6251
6653
|
unread_count: number;
|
|
@@ -6260,6 +6662,20 @@ interface operations {
|
|
|
6260
6662
|
/** @description Message body (content pass-through, never stored). */
|
|
6261
6663
|
text?: string | null;
|
|
6262
6664
|
} | null;
|
|
6665
|
+
/** @description Present only when expand=public_identifier was asked for and this page held more people needing a profile lookup than one request performs. Absent whenever there is nothing to report, so a response that resolved everyone carries no such key. Branch on each entry's code, never on its message. */
|
|
6666
|
+
notices?: {
|
|
6667
|
+
/**
|
|
6668
|
+
* @description EXPANSION_LIMIT_REACHED: more people on this page needed a profile lookup than one request performs, so the ones past the budget carry public_identifier null without ever having been looked up. Their null therefore does not mean the person has no public profile. Ask for a smaller page to resolve everyone.
|
|
6669
|
+
* @enum {string}
|
|
6670
|
+
*/
|
|
6671
|
+
code: "EXPANSION_LIMIT_REACHED";
|
|
6672
|
+
/** @description One sentence explaining the condition and how to resolve it. */
|
|
6673
|
+
message: string;
|
|
6674
|
+
/** @description The request field the notice is about, here expand. */
|
|
6675
|
+
field?: string;
|
|
6676
|
+
/** @description The expansion the notice is about, here public_identifier. */
|
|
6677
|
+
value?: string;
|
|
6678
|
+
}[];
|
|
6263
6679
|
};
|
|
6264
6680
|
};
|
|
6265
6681
|
};
|
|
@@ -6365,6 +6781,8 @@ interface operations {
|
|
|
6365
6781
|
limit?: number;
|
|
6366
6782
|
/** @description Opaque pagination cursor from a prior response's cursor. Omit for the first page. */
|
|
6367
6783
|
cursor?: string;
|
|
6784
|
+
/** @description Additional response fields to resolve, comma-separated in a single value (for example expand=public_identifier). Accepted values: public_identifier. When requested, the field is present on every user object in the response, carrying either a value or null. Omit for the base fields only. Pass the parameter once; repeating it drops values. At most 25 people per request need an extra lookup to resolve; anyone beyond that carries null, so ask for a smaller page to resolve them all. */
|
|
6785
|
+
expand?: string;
|
|
6368
6786
|
};
|
|
6369
6787
|
header?: never;
|
|
6370
6788
|
path: {
|
|
@@ -6409,6 +6827,8 @@ interface operations {
|
|
|
6409
6827
|
id: string;
|
|
6410
6828
|
/** @description Sender display name (content pass-through, never stored). */
|
|
6411
6829
|
name: string | null;
|
|
6830
|
+
/** @description The vanity slug from the profile URL, for example jane-smith. Present only when the request asks for it with expand=public_identifier, and then always present, carrying the slug or null when the platform surfaces none for this person. */
|
|
6831
|
+
public_identifier?: string | null;
|
|
6412
6832
|
};
|
|
6413
6833
|
/** @description Epoch-ms delivery time; also the newest-first pagination anchor. */
|
|
6414
6834
|
sent_at: number;
|
|
@@ -6417,6 +6837,20 @@ interface operations {
|
|
|
6417
6837
|
}[];
|
|
6418
6838
|
/** @description Opaque cursor for the next page, or null at end-of-list. */
|
|
6419
6839
|
cursor: string | null;
|
|
6840
|
+
/** @description Present only when expand=public_identifier was asked for and this page held more people needing a profile lookup than one request performs. Absent whenever there is nothing to report, so a response that resolved everyone carries no such key. Branch on each entry's code, never on its message. */
|
|
6841
|
+
notices?: {
|
|
6842
|
+
/**
|
|
6843
|
+
* @description EXPANSION_LIMIT_REACHED: more people on this page needed a profile lookup than one request performs, so the ones past the budget carry public_identifier null without ever having been looked up. Their null therefore does not mean the person has no public profile. Ask for a smaller page to resolve everyone.
|
|
6844
|
+
* @enum {string}
|
|
6845
|
+
*/
|
|
6846
|
+
code: "EXPANSION_LIMIT_REACHED";
|
|
6847
|
+
/** @description One sentence explaining the condition and how to resolve it. */
|
|
6848
|
+
message: string;
|
|
6849
|
+
/** @description The request field the notice is about, here expand. */
|
|
6850
|
+
field?: string;
|
|
6851
|
+
/** @description The expansion the notice is about, here public_identifier. */
|
|
6852
|
+
value?: string;
|
|
6853
|
+
}[];
|
|
6420
6854
|
};
|
|
6421
6855
|
};
|
|
6422
6856
|
};
|
|
@@ -6695,7 +7129,10 @@ interface operations {
|
|
|
6695
7129
|
};
|
|
6696
7130
|
getV1AccountIdCompaniesIdentifierChatsChatIdMessagesMessageId: {
|
|
6697
7131
|
parameters: {
|
|
6698
|
-
query?:
|
|
7132
|
+
query?: {
|
|
7133
|
+
/** @description Additional response fields to resolve, comma-separated in a single value (for example expand=public_identifier). Accepted values: public_identifier. When requested, the field is present on every user object in the response, carrying either a value or null. Omit for the base fields only. Pass the parameter once; repeating it drops values. At most 25 people per request need an extra lookup to resolve; anyone beyond that carries null, so ask for a smaller page to resolve them all. */
|
|
7134
|
+
expand?: string;
|
|
7135
|
+
};
|
|
6699
7136
|
header?: never;
|
|
6700
7137
|
path: {
|
|
6701
7138
|
/** @description The connected LinkedIn account, which must administer the page. */
|
|
@@ -6734,11 +7171,27 @@ interface operations {
|
|
|
6734
7171
|
id: string;
|
|
6735
7172
|
/** @description Sender display name (content pass-through, never stored). */
|
|
6736
7173
|
name: string | null;
|
|
7174
|
+
/** @description The vanity slug from the profile URL, for example jane-smith. Present only when the request asks for it with expand=public_identifier, and then always present, carrying the slug or null when the platform surfaces none for this person. */
|
|
7175
|
+
public_identifier?: string | null;
|
|
6737
7176
|
};
|
|
6738
7177
|
/** @description Epoch-ms delivery time; also the newest-first pagination anchor. */
|
|
6739
7178
|
sent_at: number;
|
|
6740
7179
|
/** @description Message body (content pass-through, never stored). */
|
|
6741
7180
|
text?: string | null;
|
|
7181
|
+
/** @description Present only when expand=public_identifier was asked for and this page held more people needing a profile lookup than one request performs. Absent whenever there is nothing to report, so a response that resolved everyone carries no such key. Branch on each entry's code, never on its message. */
|
|
7182
|
+
notices?: {
|
|
7183
|
+
/**
|
|
7184
|
+
* @description EXPANSION_LIMIT_REACHED: more people on this page needed a profile lookup than one request performs, so the ones past the budget carry public_identifier null without ever having been looked up. Their null therefore does not mean the person has no public profile. Ask for a smaller page to resolve everyone.
|
|
7185
|
+
* @enum {string}
|
|
7186
|
+
*/
|
|
7187
|
+
code: "EXPANSION_LIMIT_REACHED";
|
|
7188
|
+
/** @description One sentence explaining the condition and how to resolve it. */
|
|
7189
|
+
message: string;
|
|
7190
|
+
/** @description The request field the notice is about, here expand. */
|
|
7191
|
+
field?: string;
|
|
7192
|
+
/** @description The expansion the notice is about, here public_identifier. */
|
|
7193
|
+
value?: string;
|
|
7194
|
+
}[];
|
|
6742
7195
|
};
|
|
6743
7196
|
};
|
|
6744
7197
|
};
|
|
@@ -6850,6 +7303,8 @@ interface operations {
|
|
|
6850
7303
|
limit?: number;
|
|
6851
7304
|
/** @description Opaque pagination cursor from a prior response's cursor. Omit for the first page. */
|
|
6852
7305
|
cursor?: string;
|
|
7306
|
+
/** @description Additional response fields to resolve, comma-separated in a single value (for example expand=public_identifier). Accepted values: public_identifier. When requested, the field is present on every user object in the response, carrying either a value or null. Omit for the base fields only. Pass the parameter once; repeating it drops values. At most 25 people per request need an extra lookup to resolve; anyone beyond that carries null, so ask for a smaller page to resolve them all. */
|
|
7307
|
+
expand?: string;
|
|
6853
7308
|
};
|
|
6854
7309
|
header?: never;
|
|
6855
7310
|
path: {
|
|
@@ -6902,8 +7357,10 @@ interface operations {
|
|
|
6902
7357
|
kind: "member";
|
|
6903
7358
|
/** @description Member headline (content pass-through, never stored). */
|
|
6904
7359
|
headline?: string | null;
|
|
6905
|
-
/** @description Canonical member profile URL. */
|
|
6906
|
-
profile_url: string;
|
|
7360
|
+
/** @description Canonical member profile URL, or null when the platform surfaces no public profile for this person. */
|
|
7361
|
+
profile_url: string | null;
|
|
7362
|
+
/** @description The vanity slug from the profile URL, for example jane-smith. Present only when the request asks for it with expand=public_identifier, and then always present, carrying the slug or null when the platform surfaces none for this person. */
|
|
7363
|
+
public_identifier?: string | null;
|
|
6907
7364
|
}[];
|
|
6908
7365
|
/** @description Unread message count (0 = read). */
|
|
6909
7366
|
unread_count: number;
|
|
@@ -6926,6 +7383,20 @@ interface operations {
|
|
|
6926
7383
|
* @enum {boolean}
|
|
6927
7384
|
*/
|
|
6928
7385
|
filter_effective?: true;
|
|
7386
|
+
/** @description Present only when expand=public_identifier was asked for and this page held more people needing a profile lookup than one request performs. Absent whenever there is nothing to report, so a response that resolved everyone carries no such key. Branch on each entry's code, never on its message. */
|
|
7387
|
+
notices?: {
|
|
7388
|
+
/**
|
|
7389
|
+
* @description EXPANSION_LIMIT_REACHED: more people on this page needed a profile lookup than one request performs, so the ones past the budget carry public_identifier null without ever having been looked up. Their null therefore does not mean the person has no public profile. Ask for a smaller page to resolve everyone.
|
|
7390
|
+
* @enum {string}
|
|
7391
|
+
*/
|
|
7392
|
+
code: "EXPANSION_LIMIT_REACHED";
|
|
7393
|
+
/** @description One sentence explaining the condition and how to resolve it. */
|
|
7394
|
+
message: string;
|
|
7395
|
+
/** @description The request field the notice is about, here expand. */
|
|
7396
|
+
field?: string;
|
|
7397
|
+
/** @description The expansion the notice is about, here public_identifier. */
|
|
7398
|
+
value?: string;
|
|
7399
|
+
}[];
|
|
6929
7400
|
};
|
|
6930
7401
|
};
|
|
6931
7402
|
};
|
|
@@ -7771,14 +8242,14 @@ interface operations {
|
|
|
7771
8242
|
/** @description true if the account is verified. Present when available. */
|
|
7772
8243
|
is_verified?: boolean;
|
|
7773
8244
|
/**
|
|
7774
|
-
* @description Whether this result names someone you can act on. Always present, on both values. full: the result carries a resolvable identity, so you can read the profile and reach the person. hidden: LinkedIn did not disclose this person to the connected account, so the result carries no public_identifier and no member_id, its name is a placeholder rather than a real one, and reading it back returns 403. The cause is the connected LinkedIn account's own subscription level, which decides which profiles it is allowed to identify; it is not an error in your request. A page can be entirely hidden
|
|
8245
|
+
* @description Whether this result names someone you can act on. Always present, on both values. full: the result carries a resolvable identity, so you can read the profile and reach the person. hidden: LinkedIn did not disclose this person to the connected account, so the result carries no public_identifier and no member_id, its name is a placeholder rather than a real one, and reading it back returns 403. The cause is the connected LinkedIn account's own subscription level, which decides which profiles it is allowed to identify; it is not an error in your request. A page can be entirely hidden, so count the full results rather than the size of the page, and see notices[] for a page-level summary.
|
|
7775
8246
|
* @enum {string}
|
|
7776
8247
|
*/
|
|
7777
8248
|
visibility: "full" | "hidden";
|
|
7778
8249
|
}[];
|
|
7779
8250
|
/** @description Paging metadata. */
|
|
7780
8251
|
paging: {
|
|
7781
|
-
/** @description
|
|
8252
|
+
/** @description Always null on people search. LinkedIn does not report how many people match, so there is no total to page toward; walk the pages with cursor until it comes back null. A short or empty page is not the end: only a null cursor is. */
|
|
7782
8253
|
total_count: number | null;
|
|
7783
8254
|
};
|
|
7784
8255
|
/** @description Opaque next-page cursor; null on the last page. */
|
|
@@ -7786,10 +8257,10 @@ interface operations {
|
|
|
7786
8257
|
/** @description Present only when there is something to report about this page. Each entry names a condition that is true of the response but not visible in it, so a result set is never misleading by omission. Absent when there is nothing to report. */
|
|
7787
8258
|
notices?: {
|
|
7788
8259
|
/**
|
|
7789
|
-
* @description FILTER_VALUE_UNRESOLVED: the value matched no known filter option, so it was sent on as an id we could not check. FILTER_VALUE_UNCHECKED: the value already looked like an id, so it was never looked up, and this page came back empty. SOME_RESULTS_HIDDEN: some people on this page were not disclosed to the connected account, so those entries cannot be read back. ALL_RESULTS_HIDDEN: none of the people on this page were disclosed, so the page yielded nothing you can act on
|
|
8260
|
+
* @description FILTER_VALUE_UNRESOLVED: the value matched no known filter option, so it was sent on as an id we could not check. FILTER_VALUE_UNCHECKED: the value already looked like an id, so it was never looked up, and this page came back empty. SOME_RESULTS_HIDDEN: some people on this page were not disclosed to the connected account, so those entries cannot be read back. ALL_RESULTS_HIDDEN: none of the people on this page were disclosed, so the page yielded nothing you can act on, even when more pages follow. PAGE_TRUNCATED: this page is short because the search stopped fetching upstream pages, not because the results ran out; follow cursor, and treat only a null cursor as the end. Branch on this rather than on message.
|
|
7790
8261
|
* @enum {string}
|
|
7791
8262
|
*/
|
|
7792
|
-
code: "FILTER_VALUE_UNRESOLVED" | "FILTER_VALUE_UNCHECKED" | "SOME_RESULTS_HIDDEN" | "ALL_RESULTS_HIDDEN";
|
|
8263
|
+
code: "FILTER_VALUE_UNRESOLVED" | "FILTER_VALUE_UNCHECKED" | "SOME_RESULTS_HIDDEN" | "ALL_RESULTS_HIDDEN" | "PAGE_TRUNCATED";
|
|
7793
8264
|
/** @description One sentence explaining the condition and how to resolve it. */
|
|
7794
8265
|
message: string;
|
|
7795
8266
|
/** @description The request field the notice is about, dotted for nested filters. */
|
|
@@ -7976,10 +8447,10 @@ interface operations {
|
|
|
7976
8447
|
/** @description Present only when there is something to report about this page. Each entry names a condition that is true of the response but not visible in it, so a result set is never misleading by omission. Absent when there is nothing to report. */
|
|
7977
8448
|
notices?: {
|
|
7978
8449
|
/**
|
|
7979
|
-
* @description FILTER_VALUE_UNRESOLVED: the value matched no known filter option, so it was sent on as an id we could not check. FILTER_VALUE_UNCHECKED: the value already looked like an id, so it was never looked up, and this page came back empty. SOME_RESULTS_HIDDEN: some people on this page were not disclosed to the connected account, so those entries cannot be read back. ALL_RESULTS_HIDDEN: none of the people on this page were disclosed, so the page yielded nothing you can act on
|
|
8450
|
+
* @description FILTER_VALUE_UNRESOLVED: the value matched no known filter option, so it was sent on as an id we could not check. FILTER_VALUE_UNCHECKED: the value already looked like an id, so it was never looked up, and this page came back empty. SOME_RESULTS_HIDDEN: some people on this page were not disclosed to the connected account, so those entries cannot be read back. ALL_RESULTS_HIDDEN: none of the people on this page were disclosed, so the page yielded nothing you can act on, even when more pages follow. PAGE_TRUNCATED: this page is short because the search stopped fetching upstream pages, not because the results ran out; follow cursor, and treat only a null cursor as the end. Branch on this rather than on message.
|
|
7980
8451
|
* @enum {string}
|
|
7981
8452
|
*/
|
|
7982
|
-
code: "FILTER_VALUE_UNRESOLVED" | "FILTER_VALUE_UNCHECKED" | "SOME_RESULTS_HIDDEN" | "ALL_RESULTS_HIDDEN";
|
|
8453
|
+
code: "FILTER_VALUE_UNRESOLVED" | "FILTER_VALUE_UNCHECKED" | "SOME_RESULTS_HIDDEN" | "ALL_RESULTS_HIDDEN" | "PAGE_TRUNCATED";
|
|
7983
8454
|
/** @description One sentence explaining the condition and how to resolve it. */
|
|
7984
8455
|
message: string;
|
|
7985
8456
|
/** @description The request field the notice is about, dotted for nested filters. */
|
|
@@ -8212,10 +8683,10 @@ interface operations {
|
|
|
8212
8683
|
/** @description Present only when there is something to report about this page. Each entry names a condition that is true of the response but not visible in it, so a result set is never misleading by omission. Absent when there is nothing to report. */
|
|
8213
8684
|
notices?: {
|
|
8214
8685
|
/**
|
|
8215
|
-
* @description FILTER_VALUE_UNRESOLVED: the value matched no known filter option, so it was sent on as an id we could not check. FILTER_VALUE_UNCHECKED: the value already looked like an id, so it was never looked up, and this page came back empty. SOME_RESULTS_HIDDEN: some people on this page were not disclosed to the connected account, so those entries cannot be read back. ALL_RESULTS_HIDDEN: none of the people on this page were disclosed, so the page yielded nothing you can act on
|
|
8686
|
+
* @description FILTER_VALUE_UNRESOLVED: the value matched no known filter option, so it was sent on as an id we could not check. FILTER_VALUE_UNCHECKED: the value already looked like an id, so it was never looked up, and this page came back empty. SOME_RESULTS_HIDDEN: some people on this page were not disclosed to the connected account, so those entries cannot be read back. ALL_RESULTS_HIDDEN: none of the people on this page were disclosed, so the page yielded nothing you can act on, even when more pages follow. PAGE_TRUNCATED: this page is short because the search stopped fetching upstream pages, not because the results ran out; follow cursor, and treat only a null cursor as the end. Branch on this rather than on message.
|
|
8216
8687
|
* @enum {string}
|
|
8217
8688
|
*/
|
|
8218
|
-
code: "FILTER_VALUE_UNRESOLVED" | "FILTER_VALUE_UNCHECKED" | "SOME_RESULTS_HIDDEN" | "ALL_RESULTS_HIDDEN";
|
|
8689
|
+
code: "FILTER_VALUE_UNRESOLVED" | "FILTER_VALUE_UNCHECKED" | "SOME_RESULTS_HIDDEN" | "ALL_RESULTS_HIDDEN" | "PAGE_TRUNCATED";
|
|
8219
8690
|
/** @description One sentence explaining the condition and how to resolve it. */
|
|
8220
8691
|
message: string;
|
|
8221
8692
|
/** @description The request field the notice is about, dotted for nested filters. */
|
|
@@ -8467,10 +8938,10 @@ interface operations {
|
|
|
8467
8938
|
/** @description Present only when there is something to report about this page. Each entry names a condition that is true of the response but not visible in it, so a result set is never misleading by omission. Absent when there is nothing to report. */
|
|
8468
8939
|
notices?: {
|
|
8469
8940
|
/**
|
|
8470
|
-
* @description FILTER_VALUE_UNRESOLVED: the value matched no known filter option, so it was sent on as an id we could not check. FILTER_VALUE_UNCHECKED: the value already looked like an id, so it was never looked up, and this page came back empty. SOME_RESULTS_HIDDEN: some people on this page were not disclosed to the connected account, so those entries cannot be read back. ALL_RESULTS_HIDDEN: none of the people on this page were disclosed, so the page yielded nothing you can act on
|
|
8941
|
+
* @description FILTER_VALUE_UNRESOLVED: the value matched no known filter option, so it was sent on as an id we could not check. FILTER_VALUE_UNCHECKED: the value already looked like an id, so it was never looked up, and this page came back empty. SOME_RESULTS_HIDDEN: some people on this page were not disclosed to the connected account, so those entries cannot be read back. ALL_RESULTS_HIDDEN: none of the people on this page were disclosed, so the page yielded nothing you can act on, even when more pages follow. PAGE_TRUNCATED: this page is short because the search stopped fetching upstream pages, not because the results ran out; follow cursor, and treat only a null cursor as the end. Branch on this rather than on message.
|
|
8471
8942
|
* @enum {string}
|
|
8472
8943
|
*/
|
|
8473
|
-
code: "FILTER_VALUE_UNRESOLVED" | "FILTER_VALUE_UNCHECKED" | "SOME_RESULTS_HIDDEN" | "ALL_RESULTS_HIDDEN";
|
|
8944
|
+
code: "FILTER_VALUE_UNRESOLVED" | "FILTER_VALUE_UNCHECKED" | "SOME_RESULTS_HIDDEN" | "ALL_RESULTS_HIDDEN" | "PAGE_TRUNCATED";
|
|
8474
8945
|
/** @description One sentence explaining the condition and how to resolve it. */
|
|
8475
8946
|
message: string;
|
|
8476
8947
|
/** @description The request field the notice is about, dotted for nested filters. */
|
|
@@ -8639,7 +9110,7 @@ interface operations {
|
|
|
8639
9110
|
/** @description true if the account is verified. Present when available. */
|
|
8640
9111
|
is_verified?: boolean;
|
|
8641
9112
|
/**
|
|
8642
|
-
* @description Whether this result names someone you can act on. Always present, on both values. full: the result carries a resolvable identity, so you can read the profile and reach the person. hidden: LinkedIn did not disclose this person to the connected account, so the result carries no public_identifier and no member_id, its name is a placeholder rather than a real one, and reading it back returns 403. The cause is the connected LinkedIn account's own subscription level, which decides which profiles it is allowed to identify; it is not an error in your request. A page can be entirely hidden
|
|
9113
|
+
* @description Whether this result names someone you can act on. Always present, on both values. full: the result carries a resolvable identity, so you can read the profile and reach the person. hidden: LinkedIn did not disclose this person to the connected account, so the result carries no public_identifier and no member_id, its name is a placeholder rather than a real one, and reading it back returns 403. The cause is the connected LinkedIn account's own subscription level, which decides which profiles it is allowed to identify; it is not an error in your request. A page can be entirely hidden, so count the full results rather than the size of the page, and see notices[] for a page-level summary.
|
|
8643
9114
|
* @enum {string}
|
|
8644
9115
|
*/
|
|
8645
9116
|
visibility: "full" | "hidden";
|
|
@@ -8753,7 +9224,7 @@ interface operations {
|
|
|
8753
9224
|
})[];
|
|
8754
9225
|
/** @description Paging metadata. */
|
|
8755
9226
|
paging: {
|
|
8756
|
-
/** @description Total matching result count.
|
|
9227
|
+
/** @description Total matching result count. Always null when the pasted URL is a people search, because LinkedIn does not report a total for those; page with cursor instead. For company, post, and job URLs a large count is a >=1000 ceiling, not an exact total. */
|
|
8757
9228
|
total_count: number | null;
|
|
8758
9229
|
};
|
|
8759
9230
|
/** @description Opaque next-page cursor; null on the last page. */
|
|
@@ -9071,7 +9542,7 @@ interface operations {
|
|
|
9071
9542
|
}[];
|
|
9072
9543
|
/** @description Paging metadata. */
|
|
9073
9544
|
paging: {
|
|
9074
|
-
/** @description
|
|
9545
|
+
/** @description Always null. Service-provider search runs on the people index, and LinkedIn does not report how many people match, so walk the pages with cursor until it comes back null. */
|
|
9075
9546
|
total_count: number | null;
|
|
9076
9547
|
};
|
|
9077
9548
|
/** @description Opaque next-page cursor; null on the last page. */
|
|
@@ -9079,10 +9550,10 @@ interface operations {
|
|
|
9079
9550
|
/** @description Present only when there is something to report about this page. Each entry names a condition that is true of the response but not visible in it, so a result set is never misleading by omission. Absent when there is nothing to report. */
|
|
9080
9551
|
notices?: {
|
|
9081
9552
|
/**
|
|
9082
|
-
* @description FILTER_VALUE_UNRESOLVED: the value matched no known filter option, so it was sent on as an id we could not check. FILTER_VALUE_UNCHECKED: the value already looked like an id, so it was never looked up, and this page came back empty. SOME_RESULTS_HIDDEN: some people on this page were not disclosed to the connected account, so those entries cannot be read back. ALL_RESULTS_HIDDEN: none of the people on this page were disclosed, so the page yielded nothing you can act on
|
|
9553
|
+
* @description FILTER_VALUE_UNRESOLVED: the value matched no known filter option, so it was sent on as an id we could not check. FILTER_VALUE_UNCHECKED: the value already looked like an id, so it was never looked up, and this page came back empty. SOME_RESULTS_HIDDEN: some people on this page were not disclosed to the connected account, so those entries cannot be read back. ALL_RESULTS_HIDDEN: none of the people on this page were disclosed, so the page yielded nothing you can act on, even when more pages follow. PAGE_TRUNCATED: this page is short because the search stopped fetching upstream pages, not because the results ran out; follow cursor, and treat only a null cursor as the end. Branch on this rather than on message.
|
|
9083
9554
|
* @enum {string}
|
|
9084
9555
|
*/
|
|
9085
|
-
code: "FILTER_VALUE_UNRESOLVED" | "FILTER_VALUE_UNCHECKED" | "SOME_RESULTS_HIDDEN" | "ALL_RESULTS_HIDDEN";
|
|
9556
|
+
code: "FILTER_VALUE_UNRESOLVED" | "FILTER_VALUE_UNCHECKED" | "SOME_RESULTS_HIDDEN" | "ALL_RESULTS_HIDDEN" | "PAGE_TRUNCATED";
|
|
9086
9557
|
/** @description One sentence explaining the condition and how to resolve it. */
|
|
9087
9558
|
message: string;
|
|
9088
9559
|
/** @description The request field the notice is about, dotted for nested filters. */
|
|
@@ -9336,6 +9807,8 @@ interface operations {
|
|
|
9336
9807
|
limit?: number;
|
|
9337
9808
|
/** @description An opaque cursor for pagination. Pass the `cursor` from the preceding response to fetch the next page. */
|
|
9338
9809
|
cursor?: string;
|
|
9810
|
+
/** @description Additional response fields to resolve, comma-separated in a single value (for example expand=public_identifier). Accepted values: public_identifier. When requested, the field is present on every user object in the response, carrying either a value or null. Omit for the base fields only. Pass the parameter once; repeating it drops values. At most 25 people per request need an extra lookup to resolve; anyone beyond that carries null, so ask for a smaller page to resolve them all. */
|
|
9811
|
+
expand?: string;
|
|
9339
9812
|
};
|
|
9340
9813
|
header?: never;
|
|
9341
9814
|
path: {
|
|
@@ -9448,6 +9921,22 @@ interface operations {
|
|
|
9448
9921
|
reaction_count?: number;
|
|
9449
9922
|
/** @description The platform this message originates from. */
|
|
9450
9923
|
provider?: string;
|
|
9924
|
+
/** @description The sender's profile, when the platform returned one alongside the message. sender_id always carries the identifier; this object carries the rest of what is known about that person. */
|
|
9925
|
+
sender?: {
|
|
9926
|
+
/** @description Identifier of the counterpart. */
|
|
9927
|
+
id?: string;
|
|
9928
|
+
/** @description individual | organization. */
|
|
9929
|
+
type?: string;
|
|
9930
|
+
display_name?: string;
|
|
9931
|
+
profile_url?: string;
|
|
9932
|
+
public_picture_url?: string;
|
|
9933
|
+
/** @description The vanity slug from the profile URL, for example jane-smith. Present only when the request asks for it with expand=public_identifier, and then always present, carrying the slug or null when the platform surfaces none for this person. */
|
|
9934
|
+
public_identifier?: string | null;
|
|
9935
|
+
/** @description Provider-enriched detail about the sender (for example connection distance, premium or verified status), when the platform returns it. */
|
|
9936
|
+
specifics?: {
|
|
9937
|
+
[key: string]: unknown;
|
|
9938
|
+
};
|
|
9939
|
+
};
|
|
9451
9940
|
};
|
|
9452
9941
|
/** @description The 1:1 counterpart's profile. */
|
|
9453
9942
|
user?: {
|
|
@@ -9458,10 +9947,26 @@ interface operations {
|
|
|
9458
9947
|
display_name?: string;
|
|
9459
9948
|
profile_url?: string;
|
|
9460
9949
|
public_picture_url?: string;
|
|
9950
|
+
/** @description The vanity slug from the profile URL, for example jane-smith. Present only when the request asks for it with expand=public_identifier, and then always present, carrying the slug or null when the platform surfaces none for this person. */
|
|
9951
|
+
public_identifier?: string | null;
|
|
9461
9952
|
};
|
|
9462
9953
|
}[];
|
|
9463
9954
|
/** @description Next-page cursor; follow until items is empty (presence is not a has-more guarantee). */
|
|
9464
9955
|
cursor?: string | null;
|
|
9956
|
+
/** @description Present only when expand=public_identifier was asked for and this page held more people needing a profile lookup than one request performs. Absent whenever there is nothing to report, so a response that resolved everyone carries no such key. Branch on each entry's code, never on its message. */
|
|
9957
|
+
notices?: {
|
|
9958
|
+
/**
|
|
9959
|
+
* @description EXPANSION_LIMIT_REACHED: more people on this page needed a profile lookup than one request performs, so the ones past the budget carry public_identifier null without ever having been looked up. Their null therefore does not mean the person has no public profile. Ask for a smaller page to resolve everyone.
|
|
9960
|
+
* @enum {string}
|
|
9961
|
+
*/
|
|
9962
|
+
code: "EXPANSION_LIMIT_REACHED";
|
|
9963
|
+
/** @description One sentence explaining the condition and how to resolve it. */
|
|
9964
|
+
message: string;
|
|
9965
|
+
/** @description The request field the notice is about, here expand. */
|
|
9966
|
+
field?: string;
|
|
9967
|
+
/** @description The expansion the notice is about, here public_identifier. */
|
|
9968
|
+
value?: string;
|
|
9969
|
+
}[];
|
|
9465
9970
|
};
|
|
9466
9971
|
};
|
|
9467
9972
|
};
|
|
@@ -9721,7 +10226,10 @@ interface operations {
|
|
|
9721
10226
|
};
|
|
9722
10227
|
getV1AccountIdChatsChatId: {
|
|
9723
10228
|
parameters: {
|
|
9724
|
-
query?:
|
|
10229
|
+
query?: {
|
|
10230
|
+
/** @description Additional response fields to resolve, comma-separated in a single value (for example expand=public_identifier). Accepted values: public_identifier. When requested, the field is present on every user object in the response, carrying either a value or null. Omit for the base fields only. Pass the parameter once; repeating it drops values. At most 25 people per request need an extra lookup to resolve; anyone beyond that carries null, so ask for a smaller page to resolve them all. */
|
|
10231
|
+
expand?: string;
|
|
10232
|
+
};
|
|
9725
10233
|
header?: never;
|
|
9726
10234
|
path: {
|
|
9727
10235
|
/** @description The account ID (`acc_...`) that owns the chat. */
|
|
@@ -9829,6 +10337,22 @@ interface operations {
|
|
|
9829
10337
|
reaction_count?: number;
|
|
9830
10338
|
/** @description The platform this message originates from. */
|
|
9831
10339
|
provider?: string;
|
|
10340
|
+
/** @description The sender's profile, when the platform returned one alongside the message. sender_id always carries the identifier; this object carries the rest of what is known about that person. */
|
|
10341
|
+
sender?: {
|
|
10342
|
+
/** @description Identifier of the counterpart. */
|
|
10343
|
+
id?: string;
|
|
10344
|
+
/** @description individual | organization. */
|
|
10345
|
+
type?: string;
|
|
10346
|
+
display_name?: string;
|
|
10347
|
+
profile_url?: string;
|
|
10348
|
+
public_picture_url?: string;
|
|
10349
|
+
/** @description The vanity slug from the profile URL, for example jane-smith. Present only when the request asks for it with expand=public_identifier, and then always present, carrying the slug or null when the platform surfaces none for this person. */
|
|
10350
|
+
public_identifier?: string | null;
|
|
10351
|
+
/** @description Provider-enriched detail about the sender (for example connection distance, premium or verified status), when the platform returns it. */
|
|
10352
|
+
specifics?: {
|
|
10353
|
+
[key: string]: unknown;
|
|
10354
|
+
};
|
|
10355
|
+
};
|
|
9832
10356
|
};
|
|
9833
10357
|
/** @description The 1:1 counterpart's profile. */
|
|
9834
10358
|
user?: {
|
|
@@ -9839,7 +10363,23 @@ interface operations {
|
|
|
9839
10363
|
display_name?: string;
|
|
9840
10364
|
profile_url?: string;
|
|
9841
10365
|
public_picture_url?: string;
|
|
10366
|
+
/** @description The vanity slug from the profile URL, for example jane-smith. Present only when the request asks for it with expand=public_identifier, and then always present, carrying the slug or null when the platform surfaces none for this person. */
|
|
10367
|
+
public_identifier?: string | null;
|
|
9842
10368
|
};
|
|
10369
|
+
/** @description Present only when expand=public_identifier was asked for and this page held more people needing a profile lookup than one request performs. Absent whenever there is nothing to report, so a response that resolved everyone carries no such key. Branch on each entry's code, never on its message. */
|
|
10370
|
+
notices?: {
|
|
10371
|
+
/**
|
|
10372
|
+
* @description EXPANSION_LIMIT_REACHED: more people on this page needed a profile lookup than one request performs, so the ones past the budget carry public_identifier null without ever having been looked up. Their null therefore does not mean the person has no public profile. Ask for a smaller page to resolve everyone.
|
|
10373
|
+
* @enum {string}
|
|
10374
|
+
*/
|
|
10375
|
+
code: "EXPANSION_LIMIT_REACHED";
|
|
10376
|
+
/** @description One sentence explaining the condition and how to resolve it. */
|
|
10377
|
+
message: string;
|
|
10378
|
+
/** @description The request field the notice is about, here expand. */
|
|
10379
|
+
field?: string;
|
|
10380
|
+
/** @description The expansion the notice is about, here public_identifier. */
|
|
10381
|
+
value?: string;
|
|
10382
|
+
}[];
|
|
9843
10383
|
};
|
|
9844
10384
|
};
|
|
9845
10385
|
};
|
|
@@ -10043,6 +10583,8 @@ interface operations {
|
|
|
10043
10583
|
limit?: number;
|
|
10044
10584
|
/** @description An opaque cursor for pagination. Pass the `cursor` from the preceding response to fetch the next page. */
|
|
10045
10585
|
cursor?: string;
|
|
10586
|
+
/** @description Additional response fields to resolve, comma-separated in a single value (for example expand=public_identifier). Accepted values: public_identifier. When requested, the field is present on every user object in the response, carrying either a value or null. Omit for the base fields only. Pass the parameter once; repeating it drops values. At most 25 people per request need an extra lookup to resolve; anyone beyond that carries null, so ask for a smaller page to resolve them all. */
|
|
10587
|
+
expand?: string;
|
|
10046
10588
|
};
|
|
10047
10589
|
header?: never;
|
|
10048
10590
|
path: {
|
|
@@ -10118,9 +10660,39 @@ interface operations {
|
|
|
10118
10660
|
reaction_count?: number;
|
|
10119
10661
|
/** @description The platform this message originates from. */
|
|
10120
10662
|
provider?: string;
|
|
10663
|
+
/** @description The sender's profile, when the platform returned one alongside the message. sender_id always carries the identifier; this object carries the rest of what is known about that person. */
|
|
10664
|
+
sender?: {
|
|
10665
|
+
/** @description Identifier of the counterpart. */
|
|
10666
|
+
id?: string;
|
|
10667
|
+
/** @description individual | organization. */
|
|
10668
|
+
type?: string;
|
|
10669
|
+
display_name?: string;
|
|
10670
|
+
profile_url?: string;
|
|
10671
|
+
public_picture_url?: string;
|
|
10672
|
+
/** @description The vanity slug from the profile URL, for example jane-smith. Present only when the request asks for it with expand=public_identifier, and then always present, carrying the slug or null when the platform surfaces none for this person. */
|
|
10673
|
+
public_identifier?: string | null;
|
|
10674
|
+
/** @description Provider-enriched detail about the sender (for example connection distance, premium or verified status), when the platform returns it. */
|
|
10675
|
+
specifics?: {
|
|
10676
|
+
[key: string]: unknown;
|
|
10677
|
+
};
|
|
10678
|
+
};
|
|
10121
10679
|
}[];
|
|
10122
10680
|
/** @description Next-page cursor; follow until items is empty. */
|
|
10123
10681
|
cursor?: string | null;
|
|
10682
|
+
/** @description Present only when expand=public_identifier was asked for and this page held more people needing a profile lookup than one request performs. Absent whenever there is nothing to report, so a response that resolved everyone carries no such key. Branch on each entry's code, never on its message. */
|
|
10683
|
+
notices?: {
|
|
10684
|
+
/**
|
|
10685
|
+
* @description EXPANSION_LIMIT_REACHED: more people on this page needed a profile lookup than one request performs, so the ones past the budget carry public_identifier null without ever having been looked up. Their null therefore does not mean the person has no public profile. Ask for a smaller page to resolve everyone.
|
|
10686
|
+
* @enum {string}
|
|
10687
|
+
*/
|
|
10688
|
+
code: "EXPANSION_LIMIT_REACHED";
|
|
10689
|
+
/** @description One sentence explaining the condition and how to resolve it. */
|
|
10690
|
+
message: string;
|
|
10691
|
+
/** @description The request field the notice is about, here expand. */
|
|
10692
|
+
field?: string;
|
|
10693
|
+
/** @description The expansion the notice is about, here public_identifier. */
|
|
10694
|
+
value?: string;
|
|
10695
|
+
}[];
|
|
10124
10696
|
};
|
|
10125
10697
|
};
|
|
10126
10698
|
};
|
|
@@ -10370,7 +10942,10 @@ interface operations {
|
|
|
10370
10942
|
};
|
|
10371
10943
|
getV1AccountIdChatsChatIdMessagesMessageId: {
|
|
10372
10944
|
parameters: {
|
|
10373
|
-
query?:
|
|
10945
|
+
query?: {
|
|
10946
|
+
/** @description Additional response fields to resolve, comma-separated in a single value (for example expand=public_identifier). Accepted values: public_identifier. When requested, the field is present on every user object in the response, carrying either a value or null. Omit for the base fields only. Pass the parameter once; repeating it drops values. At most 25 people per request need an extra lookup to resolve; anyone beyond that carries null, so ask for a smaller page to resolve them all. */
|
|
10947
|
+
expand?: string;
|
|
10948
|
+
};
|
|
10374
10949
|
header?: never;
|
|
10375
10950
|
path: {
|
|
10376
10951
|
/** @description The account ID (`acc_...`) that owns the chat. */
|
|
@@ -10441,6 +11016,36 @@ interface operations {
|
|
|
10441
11016
|
reaction_count?: number;
|
|
10442
11017
|
/** @description The platform this message originates from. */
|
|
10443
11018
|
provider?: string;
|
|
11019
|
+
/** @description The sender's profile, when the platform returned one alongside the message. sender_id always carries the identifier; this object carries the rest of what is known about that person. */
|
|
11020
|
+
sender?: {
|
|
11021
|
+
/** @description Identifier of the counterpart. */
|
|
11022
|
+
id?: string;
|
|
11023
|
+
/** @description individual | organization. */
|
|
11024
|
+
type?: string;
|
|
11025
|
+
display_name?: string;
|
|
11026
|
+
profile_url?: string;
|
|
11027
|
+
public_picture_url?: string;
|
|
11028
|
+
/** @description The vanity slug from the profile URL, for example jane-smith. Present only when the request asks for it with expand=public_identifier, and then always present, carrying the slug or null when the platform surfaces none for this person. */
|
|
11029
|
+
public_identifier?: string | null;
|
|
11030
|
+
/** @description Provider-enriched detail about the sender (for example connection distance, premium or verified status), when the platform returns it. */
|
|
11031
|
+
specifics?: {
|
|
11032
|
+
[key: string]: unknown;
|
|
11033
|
+
};
|
|
11034
|
+
};
|
|
11035
|
+
/** @description Present only when expand=public_identifier was asked for and this page held more people needing a profile lookup than one request performs. Absent whenever there is nothing to report, so a response that resolved everyone carries no such key. Branch on each entry's code, never on its message. */
|
|
11036
|
+
notices?: {
|
|
11037
|
+
/**
|
|
11038
|
+
* @description EXPANSION_LIMIT_REACHED: more people on this page needed a profile lookup than one request performs, so the ones past the budget carry public_identifier null without ever having been looked up. Their null therefore does not mean the person has no public profile. Ask for a smaller page to resolve everyone.
|
|
11039
|
+
* @enum {string}
|
|
11040
|
+
*/
|
|
11041
|
+
code: "EXPANSION_LIMIT_REACHED";
|
|
11042
|
+
/** @description One sentence explaining the condition and how to resolve it. */
|
|
11043
|
+
message: string;
|
|
11044
|
+
/** @description The request field the notice is about, here expand. */
|
|
11045
|
+
field?: string;
|
|
11046
|
+
/** @description The expansion the notice is about, here public_identifier. */
|
|
11047
|
+
value?: string;
|
|
11048
|
+
}[];
|
|
10444
11049
|
};
|
|
10445
11050
|
};
|
|
10446
11051
|
};
|
|
@@ -10988,6 +11593,8 @@ interface operations {
|
|
|
10988
11593
|
limit?: number;
|
|
10989
11594
|
/** @description Opaque pagination cursor returned from a previous response; wraps a zero-based item offset. */
|
|
10990
11595
|
cursor?: string;
|
|
11596
|
+
/** @description Additional response fields to resolve, comma-separated in a single value (for example expand=public_identifier). Accepted values: public_identifier. When requested, the field is present on every user object in the response, carrying either a value or null. Omit for the base fields only. Pass the parameter once; repeating it drops values. At most 25 people per request need an extra lookup to resolve; anyone beyond that carries null, so ask for a smaller page to resolve them all. */
|
|
11597
|
+
expand?: string;
|
|
10991
11598
|
};
|
|
10992
11599
|
header?: never;
|
|
10993
11600
|
path: {
|
|
@@ -11069,6 +11676,20 @@ interface operations {
|
|
|
11069
11676
|
}[];
|
|
11070
11677
|
/** @description Opaque next-page cursor; null on the last page. */
|
|
11071
11678
|
cursor?: string | null;
|
|
11679
|
+
/** @description Present only when expand=public_identifier was asked for and this page held more people needing a profile lookup than one request performs. Absent whenever there is nothing to report, so a response that resolved everyone carries no such key. Branch on each entry's code, never on its message. */
|
|
11680
|
+
notices?: {
|
|
11681
|
+
/**
|
|
11682
|
+
* @description EXPANSION_LIMIT_REACHED: more people on this page needed a profile lookup than one request performs, so the ones past the budget carry public_identifier null without ever having been looked up. Their null therefore does not mean the person has no public profile. Ask for a smaller page to resolve everyone.
|
|
11683
|
+
* @enum {string}
|
|
11684
|
+
*/
|
|
11685
|
+
code: "EXPANSION_LIMIT_REACHED";
|
|
11686
|
+
/** @description One sentence explaining the condition and how to resolve it. */
|
|
11687
|
+
message: string;
|
|
11688
|
+
/** @description The request field the notice is about, here expand. */
|
|
11689
|
+
field?: string;
|
|
11690
|
+
/** @description The expansion the notice is about, here public_identifier. */
|
|
11691
|
+
value?: string;
|
|
11692
|
+
}[];
|
|
11072
11693
|
};
|
|
11073
11694
|
};
|
|
11074
11695
|
};
|
|
@@ -11432,6 +12053,8 @@ interface operations {
|
|
|
11432
12053
|
limit?: number;
|
|
11433
12054
|
/** @description An opaque cursor for pagination. Pass the `cursor` from the preceding response to fetch the next page. */
|
|
11434
12055
|
cursor?: string;
|
|
12056
|
+
/** @description Additional response fields to resolve, comma-separated in a single value (for example expand=public_identifier). Accepted values: public_identifier. When requested, the field is present on every user object in the response, carrying either a value or null. Omit for the base fields only. Pass the parameter once; repeating it drops values. At most 25 people per request need an extra lookup to resolve; anyone beyond that carries null, so ask for a smaller page to resolve them all. */
|
|
12057
|
+
expand?: string;
|
|
11435
12058
|
};
|
|
11436
12059
|
header?: never;
|
|
11437
12060
|
path: {
|
|
@@ -11546,6 +12169,22 @@ interface operations {
|
|
|
11546
12169
|
reaction_count?: number;
|
|
11547
12170
|
/** @description The platform this message originates from. */
|
|
11548
12171
|
provider?: string;
|
|
12172
|
+
/** @description The sender's profile, when the platform returned one alongside the message. sender_id always carries the identifier; this object carries the rest of what is known about that person. */
|
|
12173
|
+
sender?: {
|
|
12174
|
+
/** @description Identifier of the counterpart. */
|
|
12175
|
+
id?: string;
|
|
12176
|
+
/** @description individual | organization. */
|
|
12177
|
+
type?: string;
|
|
12178
|
+
display_name?: string;
|
|
12179
|
+
profile_url?: string;
|
|
12180
|
+
public_picture_url?: string;
|
|
12181
|
+
/** @description The vanity slug from the profile URL, for example jane-smith. Present only when the request asks for it with expand=public_identifier, and then always present, carrying the slug or null when the platform surfaces none for this person. */
|
|
12182
|
+
public_identifier?: string | null;
|
|
12183
|
+
/** @description Provider-enriched detail about the sender (for example connection distance, premium or verified status), when the platform returns it. */
|
|
12184
|
+
specifics?: {
|
|
12185
|
+
[key: string]: unknown;
|
|
12186
|
+
};
|
|
12187
|
+
};
|
|
11549
12188
|
};
|
|
11550
12189
|
/** @description The 1:1 counterpart's profile. */
|
|
11551
12190
|
user?: {
|
|
@@ -11556,10 +12195,26 @@ interface operations {
|
|
|
11556
12195
|
display_name?: string;
|
|
11557
12196
|
profile_url?: string;
|
|
11558
12197
|
public_picture_url?: string;
|
|
12198
|
+
/** @description The vanity slug from the profile URL, for example jane-smith. Present only when the request asks for it with expand=public_identifier, and then always present, carrying the slug or null when the platform surfaces none for this person. */
|
|
12199
|
+
public_identifier?: string | null;
|
|
11559
12200
|
};
|
|
11560
12201
|
}[];
|
|
11561
12202
|
/** @description Next-page cursor. Follow until items is empty. */
|
|
11562
12203
|
cursor?: string | null;
|
|
12204
|
+
/** @description Present only when expand=public_identifier was asked for and this page held more people needing a profile lookup than one request performs. Absent whenever there is nothing to report, so a response that resolved everyone carries no such key. Branch on each entry's code, never on its message. */
|
|
12205
|
+
notices?: {
|
|
12206
|
+
/**
|
|
12207
|
+
* @description EXPANSION_LIMIT_REACHED: more people on this page needed a profile lookup than one request performs, so the ones past the budget carry public_identifier null without ever having been looked up. Their null therefore does not mean the person has no public profile. Ask for a smaller page to resolve everyone.
|
|
12208
|
+
* @enum {string}
|
|
12209
|
+
*/
|
|
12210
|
+
code: "EXPANSION_LIMIT_REACHED";
|
|
12211
|
+
/** @description One sentence explaining the condition and how to resolve it. */
|
|
12212
|
+
message: string;
|
|
12213
|
+
/** @description The request field the notice is about, here expand. */
|
|
12214
|
+
field?: string;
|
|
12215
|
+
/** @description The expansion the notice is about, here public_identifier. */
|
|
12216
|
+
value?: string;
|
|
12217
|
+
}[];
|
|
11563
12218
|
};
|
|
11564
12219
|
};
|
|
11565
12220
|
};
|
|
@@ -25464,13 +26119,13 @@ interface operations {
|
|
|
25464
26119
|
requested_products?: ("classic" | "company" | "sales_navigator" | "recruiter")[] | null;
|
|
25465
26120
|
/** @description ISO-8601 UTC creation timestamp of the underlying LinkedIn account, distinct from connected_at. Null until the first background enrichment lands. */
|
|
25466
26121
|
substrate_created_at?: string | null;
|
|
25467
|
-
/** @description
|
|
26122
|
+
/** @description Capacity figures for this account, one entry per tracked family (messages.daily, connection_requests.daily, profile_views.daily, inmail.daily, profile.endorse, account.per_minute). These are advisory only: Curviate never rejects a request because a daily figure is exceeded; only account.per_minute is a binding limit enforced with HTTP 429. Every figure describes what the underlying platform will accept, not a safe sustained rate; pacing is the caller's responsibility. */
|
|
25468
26123
|
quotas?: {
|
|
25469
26124
|
/** @description Quota family (e.g. messages.daily, account.per_minute). */
|
|
25470
26125
|
quota_name?: string;
|
|
25471
26126
|
/** @description Remaining units in the current window. */
|
|
25472
26127
|
remaining?: number;
|
|
25473
|
-
/** @description Window capacity for this family. */
|
|
26128
|
+
/** @description Window capacity for this family. This is a substrate capacity ceiling, not a safe sustained rate; the caller owns its own pacing. */
|
|
25474
26129
|
total?: number;
|
|
25475
26130
|
/** @description ISO-8601 UTC time the current window resets. */
|
|
25476
26131
|
reset_time?: string;
|
|
@@ -26889,7 +27544,7 @@ interface operations {
|
|
|
26889
27544
|
*/
|
|
26890
27545
|
tier?: "recruiter" | "sales_nav";
|
|
26891
27546
|
/**
|
|
26892
|
-
* @description Delivery timing. Omitted (equivalent to 'realtime') on every live-pushed event. 'no_longer_realtime' means no push exists for this event; 'not_realtime' means
|
|
27547
|
+
* @description Delivery timing. Omitted (equivalent to 'realtime') on every live-pushed event. 'no_longer_realtime' means no push exists for this event; 'not_realtime' means delivery is not guaranteed sub-second and may lag the underlying LinkedIn event, typically because it is detected by a poll rather than pushed, though a given event's own reference article may document an additional immediate path.
|
|
26893
27548
|
* @enum {string}
|
|
26894
27549
|
*/
|
|
26895
27550
|
availability?: "realtime" | "no_longer_realtime" | "not_realtime";
|
|
@@ -26921,6 +27576,87 @@ interface operations {
|
|
|
26921
27576
|
};
|
|
26922
27577
|
};
|
|
26923
27578
|
};
|
|
27579
|
+
postV1WebhooksIdTest: {
|
|
27580
|
+
parameters: {
|
|
27581
|
+
query?: never;
|
|
27582
|
+
header?: never;
|
|
27583
|
+
path: {
|
|
27584
|
+
/** @description Webhook id (wh_-prefixed ULID). */
|
|
27585
|
+
id: string;
|
|
27586
|
+
};
|
|
27587
|
+
cookie?: never;
|
|
27588
|
+
};
|
|
27589
|
+
requestBody?: never;
|
|
27590
|
+
responses: {
|
|
27591
|
+
/** @description The test delivery is queued. It travels the same path as a real delivery: the same signature, the same custom headers, the same delivery record, the same retry schedule. Wait for it to arrive at your endpoint, verify the signature, and match data.test_id to the test_id below. */
|
|
27592
|
+
202: {
|
|
27593
|
+
headers: {
|
|
27594
|
+
"RateLimit-Policy": components["headers"]["RateLimit-Policy"];
|
|
27595
|
+
RateLimit: components["headers"]["RateLimit"];
|
|
27596
|
+
[name: string]: unknown;
|
|
27597
|
+
};
|
|
27598
|
+
content: {
|
|
27599
|
+
"application/json": {
|
|
27600
|
+
/**
|
|
27601
|
+
* @description Response type discriminator.
|
|
27602
|
+
* @enum {string}
|
|
27603
|
+
*/
|
|
27604
|
+
object?: "webhook_test";
|
|
27605
|
+
/** @description The webhook the test delivery was queued for. */
|
|
27606
|
+
webhook_id?: string;
|
|
27607
|
+
/** @description Correlation id for this test delivery, echoed as data.test_id in the delivered payload. Match it to confirm that the delivery your receiver observed is the one you asked for. */
|
|
27608
|
+
test_id?: string;
|
|
27609
|
+
/**
|
|
27610
|
+
* @description Always webhook.test. This name is not part of the event catalogue and can never be subscribed to, so it can never be confused with a real event.
|
|
27611
|
+
* @enum {string}
|
|
27612
|
+
*/
|
|
27613
|
+
event?: "webhook.test";
|
|
27614
|
+
/** @description When the test delivery was queued (ISO 8601). */
|
|
27615
|
+
queued_at?: string;
|
|
27616
|
+
};
|
|
27617
|
+
};
|
|
27618
|
+
};
|
|
27619
|
+
/** @description Malformed webhook id, or the webhook is disabled or targets no account, in which case nothing could be delivered. */
|
|
27620
|
+
400: {
|
|
27621
|
+
headers: {
|
|
27622
|
+
[name: string]: unknown;
|
|
27623
|
+
};
|
|
27624
|
+
content: {
|
|
27625
|
+
"application/json": components["schemas"]["Error"];
|
|
27626
|
+
};
|
|
27627
|
+
};
|
|
27628
|
+
/** @description Missing or invalid API key. */
|
|
27629
|
+
401: {
|
|
27630
|
+
headers: {
|
|
27631
|
+
[name: string]: unknown;
|
|
27632
|
+
};
|
|
27633
|
+
content: {
|
|
27634
|
+
"application/json": components["schemas"]["Error"];
|
|
27635
|
+
};
|
|
27636
|
+
};
|
|
27637
|
+
/** @description Webhook not found or not owned by this tenant. */
|
|
27638
|
+
404: {
|
|
27639
|
+
headers: {
|
|
27640
|
+
[name: string]: unknown;
|
|
27641
|
+
};
|
|
27642
|
+
content: {
|
|
27643
|
+
"application/json": components["schemas"]["Error"];
|
|
27644
|
+
};
|
|
27645
|
+
};
|
|
27646
|
+
/** @description Too many test deliveries, either for this webhook or across your tenant's webhooks. Wait for the window to reset; the Retry-After header gives the number of seconds. */
|
|
27647
|
+
429: {
|
|
27648
|
+
headers: {
|
|
27649
|
+
"RateLimit-Policy": components["headers"]["RateLimit-Policy"];
|
|
27650
|
+
RateLimit: components["headers"]["RateLimit"];
|
|
27651
|
+
"Retry-After": components["headers"]["Retry-After"];
|
|
27652
|
+
[name: string]: unknown;
|
|
27653
|
+
};
|
|
27654
|
+
content: {
|
|
27655
|
+
"application/json": components["schemas"]["Error"];
|
|
27656
|
+
};
|
|
27657
|
+
};
|
|
27658
|
+
};
|
|
27659
|
+
};
|
|
26924
27660
|
getV1WebhooksId: {
|
|
26925
27661
|
parameters: {
|
|
26926
27662
|
query?: never;
|