scavio 0.9.0 → 0.10.0

package/dist/index.d.cts

@@ -1150,150 +1150,125 @@ declare class XNamespace {
     trending(options?: XTrendingOptions): Promise<Record<string, unknown>>;
 }
 
+/** A member reference: a vanity handle, or a full profile URL. */
 interface LinkedInPersonOptions {
-    /** Public identifier (vanity handle). */
-    username: string;
-    /** Include the experiences section (default true server-side). */
-    include_experiences?: boolean;
-    /** Include the educations section (default true server-side). */
-    include_educations?: boolean;
-    /** Include the skills section (default true server-side). */
-    include_skills?: boolean;
-    /** Include the certifications section (default true server-side). */
-    include_certifications?: boolean;
-    /** Include follower and connection counts (default true server-side). */
-    include_follower_and_connection?: boolean;
-    [key: string]: unknown;
-}
-interface LinkedInPersonRefOptions {
-    /** Member urn. */
-    urn?: string;
-    /** Public identifier; resolved to a urn if urn is omitted. */
+    /** Public identifier (vanity handle), e.g. "williamhgates". */
     username?: string;
+    /** Full LinkedIn profile URL, as an alternative to username. */
+    url?: string;
     [key: string]: unknown;
 }
-interface LinkedInPersonPostsOptions {
-    /** Member urn. */
-    urn?: string;
-    /** Public identifier; resolved to a urn if urn is omitted. */
-    username?: string;
-    /** Pagination cursor from a prior response. */
-    cursor?: string;
+/** A company reference: a universal name (slug), or a full company URL. */
+interface LinkedInCompanyOptions {
+    /** Company universal name (slug), e.g. "microsoft". */
+    company?: string;
+    /** Full LinkedIn company URL, as an alternative to company. */
+    url?: string;
     [key: string]: unknown;
 }
-interface LinkedInPersonContactOptions {
-    /** Public identifier (vanity handle). */
-    username: string;
+/** @deprecated Use {@link LinkedInPersonOptions}. */
+type LinkedInPersonRefOptions = LinkedInPersonOptions;
+/** @deprecated Use {@link LinkedInPersonOptions}. */
+type LinkedInPersonPostsOptions = LinkedInPersonOptions;
+/** @deprecated Use {@link LinkedInCompanyOptions}. */
+type LinkedInCompanyPostsOptions = LinkedInCompanyOptions;
+interface LinkedInSearchJobsOptions {
+    /** Search keyword. */
+    search: string;
+    /** Geographic filter; omit to search everywhere. */
+    location?: string;
     [key: string]: unknown;
 }
-interface LinkedInCompanyOptions {
-    /** Company universal name (slug) or LinkedIn company URL. */
-    company: string;
+interface LinkedInJobOptions {
+    /** Job listing id. */
+    job_id?: string;
+    /** Full LinkedIn job URL, as an alternative to job_id. */
+    url?: string;
     [key: string]: unknown;
 }
-interface LinkedInCompanyPostsOptions {
-    /** Company universal name (slug) or LinkedIn company URL. */
-    company: string;
-    /** Pagination cursor from a prior response. */
-    cursor?: string;
-    /** Results per page (1-100). */
-    count?: number;
+interface LinkedInPostOptions {
+    /** Post id or activity urn. */
+    post_id?: string;
+    /** Full LinkedIn post URL, as an alternative to post_id. */
+    url?: string;
+    [key: string]: unknown;
+}
+interface LinkedInPostCommentsOptions extends LinkedInPostOptions {
+    /** 1-based page number, 10 comments per page. */
+    page?: number;
+}
+/** @deprecated Retired upstream; always returns HTTP 410. */
+interface LinkedInPersonContactOptions {
+    username?: string;
     [key: string]: unknown;
 }
+/** @deprecated Retired upstream; always returns HTTP 410. */
 interface LinkedInCompanyRefOptions {
-    /** Numeric company id. */
     company_id?: string;
-    /** Company slug/url; resolved to a company_id if company_id is omitted. */
     company?: string;
-    /** Pagination cursor from a prior response. */
-    cursor?: string;
     [key: string]: unknown;
 }
+/** @deprecated Retired upstream; always returns HTTP 410. */
 interface LinkedInSearchPeopleOptions {
-    /** Name to search for. */
     search?: string;
-    /** Job title filter. */
     title?: string;
-    /** Company filter. */
     company?: string;
-    /** School filter. */
     school?: string;
-    /** A geo name or id to filter by. */
     location?: string;
-    /** Page cursor (page number). */
-    cursor?: string;
-    [key: string]: unknown;
-}
-interface LinkedInSearchJobsOptions {
-    /** Search query (1-500 characters). */
-    search: string;
-    /** Page cursor (page number). */
-    cursor?: string;
-    /** Date-posted filter. */
-    date_posted?: string;
-    /** Geo code to filter by. */
-    geocode?: string;
-    /** Experience level filter. */
-    experience_level?: string;
-    /** Remote filter. */
-    remote?: string;
-    /** Job type filter. */
-    job_type?: string;
     [key: string]: unknown;
 }
+/** @deprecated Retired upstream; always returns HTTP 410. */
 interface LinkedInSearchPostsOptions {
-    /** Search query (1-500 characters). */
-    search: string;
-    /** Page cursor (page number). */
-    cursor?: string;
-    /** Date-posted filter. */
-    date_posted?: string;
-    /** Sort order. */
-    sort_by?: string;
-    /** Content type filter. */
-    content_type?: string;
-    [key: string]: unknown;
-}
-interface LinkedInJobOptions {
-    /** Job listing id. */
-    job_id: string;
-    /** Include the required-skills section. */
-    include_skills?: boolean;
-    [key: string]: unknown;
-}
-interface LinkedInPostOptions {
-    /** Post id or activity urn. */
-    post_id: string;
-    [key: string]: unknown;
-}
-interface LinkedInPostCommentsOptions {
-    /** Post id or activity urn. */
-    post_id: string;
-    /** Pagination cursor from a prior response. */
-    cursor?: string;
-    /** Comment sort order. */
-    sort_order?: "relevance" | "recent";
-    /** Post type. */
-    post_type?: "activity" | "ugc";
+    search?: string;
     [key: string]: unknown;
 }
 declare class LinkedInNamespace {
     private client;
     constructor(client: Scavio);
+    /** Full profile: about text, experience, education, honours and links. */
     person(options: LinkedInPersonOptions): Promise<Record<string, unknown>>;
-    personAbout(options: LinkedInPersonRefOptions): Promise<Record<string, unknown>>;
-    personPosts(options: LinkedInPersonPostsOptions): Promise<Record<string, unknown>>;
-    personContact(options: LinkedInPersonContactOptions): Promise<Record<string, unknown>>;
+    /** The about-only slice of the profile payload. */
+    personAbout(options: LinkedInPersonOptions): Promise<Record<string, unknown>>;
+    /** Recent posts, up to 50. Upstream exposes no further pages. */
+    personPosts(options: LinkedInPersonOptions): Promise<Record<string, unknown>>;
+    /** Company profile, including locations and featured employees. */
     company(options: LinkedInCompanyOptions): Promise<Record<string, unknown>>;
-    companyPosts(options: LinkedInCompanyPostsOptions): Promise<Record<string, unknown>>;
-    companyPeople(options: LinkedInCompanyRefOptions): Promise<Record<string, unknown>>;
-    companyJobs(options: LinkedInCompanyRefOptions): Promise<Record<string, unknown>>;
-    searchPeople(options: LinkedInSearchPeopleOptions): Promise<Record<string, unknown>>;
+    /** Recent company posts, up to 50. Upstream exposes no further pages. */
+    companyPosts(options: LinkedInCompanyOptions): Promise<Record<string, unknown>>;
+    /** Job search. Upstream rotates its result set, so repeat calls differ. */
     searchJobs(options: LinkedInSearchJobsOptions): Promise<Record<string, unknown>>;
-    searchPosts(options: LinkedInSearchPostsOptions): Promise<Record<string, unknown>>;
+    /** Full detail for one job listing, including the hiring company. */
     job(options: LinkedInJobOptions): Promise<Record<string, unknown>>;
+    /** Full detail for one post, including its top visible comments. */
     post(options: LinkedInPostOptions): Promise<Record<string, unknown>>;
+    /** Comments with their replies, 10 per page. */
     postComments(options: LinkedInPostCommentsOptions): Promise<Record<string, unknown>>;
+    /**
+     * @deprecated Retired by the upstream provider. Always returns HTTP 410 and is
+     * never billed.
+     */
+    personContact(options: LinkedInPersonContactOptions): Promise<Record<string, unknown>>;
+    /**
+     * @deprecated Retired by the upstream provider. Always returns HTTP 410 and is
+     * never billed. `company()` returns `featured_employees`, a small sample of
+     * staff profiles.
+     */
+    companyPeople(options: LinkedInCompanyRefOptions): Promise<Record<string, unknown>>;
+    /**
+     * @deprecated Retired by the upstream provider. Always returns HTTP 410 and is
+     * never billed. Use `searchJobs()` with the company name as the search term.
+     */
+    companyJobs(options: LinkedInCompanyRefOptions): Promise<Record<string, unknown>>;
+    /**
+     * @deprecated Retired by the upstream provider. Always returns HTTP 410 and is
+     * never billed.
+     */
+    searchPeople(options: LinkedInSearchPeopleOptions): Promise<Record<string, unknown>>;
+    /**
+     * @deprecated Retired by the upstream provider. Always returns HTTP 410 and is
+     * never billed.
+     */
+    searchPosts(options: LinkedInSearchPostsOptions): Promise<Record<string, unknown>>;
 }
 
 interface ScavioConfig {

package/dist/index.d.ts

@@ -1150,150 +1150,125 @@ declare class XNamespace {
     trending(options?: XTrendingOptions): Promise<Record<string, unknown>>;
 }
 
+/** A member reference: a vanity handle, or a full profile URL. */
 interface LinkedInPersonOptions {
-    /** Public identifier (vanity handle). */
-    username: string;
-    /** Include the experiences section (default true server-side). */
-    include_experiences?: boolean;
-    /** Include the educations section (default true server-side). */
-    include_educations?: boolean;
-    /** Include the skills section (default true server-side). */
-    include_skills?: boolean;
-    /** Include the certifications section (default true server-side). */
-    include_certifications?: boolean;
-    /** Include follower and connection counts (default true server-side). */
-    include_follower_and_connection?: boolean;
-    [key: string]: unknown;
-}
-interface LinkedInPersonRefOptions {
-    /** Member urn. */
-    urn?: string;
-    /** Public identifier; resolved to a urn if urn is omitted. */
+    /** Public identifier (vanity handle), e.g. "williamhgates". */
     username?: string;
+    /** Full LinkedIn profile URL, as an alternative to username. */
+    url?: string;
     [key: string]: unknown;
 }
-interface LinkedInPersonPostsOptions {
-    /** Member urn. */
-    urn?: string;
-    /** Public identifier; resolved to a urn if urn is omitted. */
-    username?: string;
-    /** Pagination cursor from a prior response. */
-    cursor?: string;
+/** A company reference: a universal name (slug), or a full company URL. */
+interface LinkedInCompanyOptions {
+    /** Company universal name (slug), e.g. "microsoft". */
+    company?: string;
+    /** Full LinkedIn company URL, as an alternative to company. */
+    url?: string;
     [key: string]: unknown;
 }
-interface LinkedInPersonContactOptions {
-    /** Public identifier (vanity handle). */
-    username: string;
+/** @deprecated Use {@link LinkedInPersonOptions}. */
+type LinkedInPersonRefOptions = LinkedInPersonOptions;
+/** @deprecated Use {@link LinkedInPersonOptions}. */
+type LinkedInPersonPostsOptions = LinkedInPersonOptions;
+/** @deprecated Use {@link LinkedInCompanyOptions}. */
+type LinkedInCompanyPostsOptions = LinkedInCompanyOptions;
+interface LinkedInSearchJobsOptions {
+    /** Search keyword. */
+    search: string;
+    /** Geographic filter; omit to search everywhere. */
+    location?: string;
     [key: string]: unknown;
 }
-interface LinkedInCompanyOptions {
-    /** Company universal name (slug) or LinkedIn company URL. */
-    company: string;
+interface LinkedInJobOptions {
+    /** Job listing id. */
+    job_id?: string;
+    /** Full LinkedIn job URL, as an alternative to job_id. */
+    url?: string;
     [key: string]: unknown;
 }
-interface LinkedInCompanyPostsOptions {
-    /** Company universal name (slug) or LinkedIn company URL. */
-    company: string;
-    /** Pagination cursor from a prior response. */
-    cursor?: string;
-    /** Results per page (1-100). */
-    count?: number;
+interface LinkedInPostOptions {
+    /** Post id or activity urn. */
+    post_id?: string;
+    /** Full LinkedIn post URL, as an alternative to post_id. */
+    url?: string;
+    [key: string]: unknown;
+}
+interface LinkedInPostCommentsOptions extends LinkedInPostOptions {
+    /** 1-based page number, 10 comments per page. */
+    page?: number;
+}
+/** @deprecated Retired upstream; always returns HTTP 410. */
+interface LinkedInPersonContactOptions {
+    username?: string;
     [key: string]: unknown;
 }
+/** @deprecated Retired upstream; always returns HTTP 410. */
 interface LinkedInCompanyRefOptions {
-    /** Numeric company id. */
     company_id?: string;
-    /** Company slug/url; resolved to a company_id if company_id is omitted. */
     company?: string;
-    /** Pagination cursor from a prior response. */
-    cursor?: string;
     [key: string]: unknown;
 }
+/** @deprecated Retired upstream; always returns HTTP 410. */
 interface LinkedInSearchPeopleOptions {
-    /** Name to search for. */
     search?: string;
-    /** Job title filter. */
     title?: string;
-    /** Company filter. */
     company?: string;
-    /** School filter. */
     school?: string;
-    /** A geo name or id to filter by. */
     location?: string;
-    /** Page cursor (page number). */
-    cursor?: string;
-    [key: string]: unknown;
-}
-interface LinkedInSearchJobsOptions {
-    /** Search query (1-500 characters). */
-    search: string;
-    /** Page cursor (page number). */
-    cursor?: string;
-    /** Date-posted filter. */
-    date_posted?: string;
-    /** Geo code to filter by. */
-    geocode?: string;
-    /** Experience level filter. */
-    experience_level?: string;
-    /** Remote filter. */
-    remote?: string;
-    /** Job type filter. */
-    job_type?: string;
     [key: string]: unknown;
 }
+/** @deprecated Retired upstream; always returns HTTP 410. */
 interface LinkedInSearchPostsOptions {
-    /** Search query (1-500 characters). */
-    search: string;
-    /** Page cursor (page number). */
-    cursor?: string;
-    /** Date-posted filter. */
-    date_posted?: string;
-    /** Sort order. */
-    sort_by?: string;
-    /** Content type filter. */
-    content_type?: string;
-    [key: string]: unknown;
-}
-interface LinkedInJobOptions {
-    /** Job listing id. */
-    job_id: string;
-    /** Include the required-skills section. */
-    include_skills?: boolean;
-    [key: string]: unknown;
-}
-interface LinkedInPostOptions {
-    /** Post id or activity urn. */
-    post_id: string;
-    [key: string]: unknown;
-}
-interface LinkedInPostCommentsOptions {
-    /** Post id or activity urn. */
-    post_id: string;
-    /** Pagination cursor from a prior response. */
-    cursor?: string;
-    /** Comment sort order. */
-    sort_order?: "relevance" | "recent";
-    /** Post type. */
-    post_type?: "activity" | "ugc";
+    search?: string;
     [key: string]: unknown;
 }
 declare class LinkedInNamespace {
     private client;
     constructor(client: Scavio);
+    /** Full profile: about text, experience, education, honours and links. */
     person(options: LinkedInPersonOptions): Promise<Record<string, unknown>>;
-    personAbout(options: LinkedInPersonRefOptions): Promise<Record<string, unknown>>;
-    personPosts(options: LinkedInPersonPostsOptions): Promise<Record<string, unknown>>;
-    personContact(options: LinkedInPersonContactOptions): Promise<Record<string, unknown>>;
+    /** The about-only slice of the profile payload. */
+    personAbout(options: LinkedInPersonOptions): Promise<Record<string, unknown>>;
+    /** Recent posts, up to 50. Upstream exposes no further pages. */
+    personPosts(options: LinkedInPersonOptions): Promise<Record<string, unknown>>;
+    /** Company profile, including locations and featured employees. */
     company(options: LinkedInCompanyOptions): Promise<Record<string, unknown>>;
-    companyPosts(options: LinkedInCompanyPostsOptions): Promise<Record<string, unknown>>;
-    companyPeople(options: LinkedInCompanyRefOptions): Promise<Record<string, unknown>>;
-    companyJobs(options: LinkedInCompanyRefOptions): Promise<Record<string, unknown>>;
-    searchPeople(options: LinkedInSearchPeopleOptions): Promise<Record<string, unknown>>;
+    /** Recent company posts, up to 50. Upstream exposes no further pages. */
+    companyPosts(options: LinkedInCompanyOptions): Promise<Record<string, unknown>>;
+    /** Job search. Upstream rotates its result set, so repeat calls differ. */
     searchJobs(options: LinkedInSearchJobsOptions): Promise<Record<string, unknown>>;
-    searchPosts(options: LinkedInSearchPostsOptions): Promise<Record<string, unknown>>;
+    /** Full detail for one job listing, including the hiring company. */
     job(options: LinkedInJobOptions): Promise<Record<string, unknown>>;
+    /** Full detail for one post, including its top visible comments. */
     post(options: LinkedInPostOptions): Promise<Record<string, unknown>>;
+    /** Comments with their replies, 10 per page. */
     postComments(options: LinkedInPostCommentsOptions): Promise<Record<string, unknown>>;
+    /**
+     * @deprecated Retired by the upstream provider. Always returns HTTP 410 and is
+     * never billed.
+     */
+    personContact(options: LinkedInPersonContactOptions): Promise<Record<string, unknown>>;
+    /**
+     * @deprecated Retired by the upstream provider. Always returns HTTP 410 and is
+     * never billed. `company()` returns `featured_employees`, a small sample of
+     * staff profiles.
+     */
+    companyPeople(options: LinkedInCompanyRefOptions): Promise<Record<string, unknown>>;
+    /**
+     * @deprecated Retired by the upstream provider. Always returns HTTP 410 and is
+     * never billed. Use `searchJobs()` with the company name as the search term.
+     */
+    companyJobs(options: LinkedInCompanyRefOptions): Promise<Record<string, unknown>>;
+    /**
+     * @deprecated Retired by the upstream provider. Always returns HTTP 410 and is
+     * never billed.
+     */
+    searchPeople(options: LinkedInSearchPeopleOptions): Promise<Record<string, unknown>>;
+    /**
+     * @deprecated Retired by the upstream provider. Always returns HTTP 410 and is
+     * never billed.
+     */
+    searchPosts(options: LinkedInSearchPostsOptions): Promise<Record<string, unknown>>;
 }
 
 interface ScavioConfig {

package/dist/index.js

@@ -720,48 +720,78 @@ var LinkedInNamespace = class {
     this.client = client;
   }
   client;
+  /** Full profile: about text, experience, education, honours and links. */
   async person(options) {
     return this.client._post("/api/v1/linkedin/person", options);
   }
+  /** The about-only slice of the profile payload. */
   async personAbout(options) {
     return this.client._post("/api/v1/linkedin/person/about", options);
   }
+  /** Recent posts, up to 50. Upstream exposes no further pages. */
   async personPosts(options) {
     return this.client._post("/api/v1/linkedin/person/posts", options);
   }
-  async personContact(options) {
-    return this.client._post("/api/v1/linkedin/person/contact", options);
-  }
+  /** Company profile, including locations and featured employees. */
   async company(options) {
     return this.client._post("/api/v1/linkedin/company", options);
   }
+  /** Recent company posts, up to 50. Upstream exposes no further pages. */
   async companyPosts(options) {
     return this.client._post("/api/v1/linkedin/company/posts", options);
   }
-  async companyPeople(options) {
-    return this.client._post("/api/v1/linkedin/company/people", options);
-  }
-  async companyJobs(options) {
-    return this.client._post("/api/v1/linkedin/company/jobs", options);
-  }
-  async searchPeople(options) {
-    return this.client._post("/api/v1/linkedin/search/people", options);
-  }
+  /** Job search. Upstream rotates its result set, so repeat calls differ. */
   async searchJobs(options) {
     return this.client._post("/api/v1/linkedin/search/jobs", options);
   }
-  async searchPosts(options) {
-    return this.client._post("/api/v1/linkedin/search/posts", options);
-  }
+  /** Full detail for one job listing, including the hiring company. */
   async job(options) {
     return this.client._post("/api/v1/linkedin/job", options);
   }
+  /** Full detail for one post, including its top visible comments. */
   async post(options) {
     return this.client._post("/api/v1/linkedin/post", options);
   }
+  /** Comments with their replies, 10 per page. */
   async postComments(options) {
     return this.client._post("/api/v1/linkedin/post/comments", options);
   }
+  /**
+   * @deprecated Retired by the upstream provider. Always returns HTTP 410 and is
+   * never billed.
+   */
+  async personContact(options) {
+    return this.client._post("/api/v1/linkedin/person/contact", options);
+  }
+  /**
+   * @deprecated Retired by the upstream provider. Always returns HTTP 410 and is
+   * never billed. `company()` returns `featured_employees`, a small sample of
+   * staff profiles.
+   */
+  async companyPeople(options) {
+    return this.client._post("/api/v1/linkedin/company/people", options);
+  }
+  /**
+   * @deprecated Retired by the upstream provider. Always returns HTTP 410 and is
+   * never billed. Use `searchJobs()` with the company name as the search term.
+   */
+  async companyJobs(options) {
+    return this.client._post("/api/v1/linkedin/company/jobs", options);
+  }
+  /**
+   * @deprecated Retired by the upstream provider. Always returns HTTP 410 and is
+   * never billed.
+   */
+  async searchPeople(options) {
+    return this.client._post("/api/v1/linkedin/search/people", options);
+  }
+  /**
+   * @deprecated Retired by the upstream provider. Always returns HTTP 410 and is
+   * never billed.
+   */
+  async searchPosts(options) {
+    return this.client._post("/api/v1/linkedin/search/posts", options);
+  }
 };
 
 // src/client.ts