orangeslice 2.0.0 → 2.0.2

package/docs/services/index.md

@@ -9,4 +9,5 @@
 - **scrape**: website scraper, sitemap scraper
 - **web**: SERP
 - **healthcare**: Query the NPI (National Provider Identifier) database for healthcare organizations by specialty, location, or name. Contains 1.8M+ providers.
+- **predictLeads**: company intelligence datasets (financing events, technologies, products, job openings, news, and related company data).
 - **guides**: agent notes & operational docs (see [Error Handling Cheatsheet](../error-handling-cheatsheet.md))

package/docs/services/person/linkedin/findUrl.md

@@ -1,4 +1,4 @@
-/\*_ Credits: 2 (standard). Charged only if a valid URL is returned. _/
+/\*_ Credits: 2 standard, or 50 when `email` is provided. Charged only if a valid URL is returned. _/
 
 /\*\*
 
@@ -15,4 +15,6 @@
   keyword?: string;
   /\*_ Location string (e.g., city, state, country) to narrow search results _/
   location?: string;
+  /\*_ Email address. If provided, reverse-email lookup runs first, then falls back to search. _/
+  email?: string;
   }) => Promise<string | undefined>;

package/docs/services/predictLeads/apiSubscription.ts

@@ -0,0 +1,19 @@
+/**
+ * Retrieve API subscription information
+ * Returns the current subscription status along with monthly credit limits and usage details.
+ * HTTP GET /api_subscription
+ */
+type apiSubscription = (params: {}) => Promise<{
+  data: Array<{
+  id: string;
+  type: "api_subscription";
+  attributes: {
+  status: "disabled" | "active" | "disabled_due_to_error";
+  monthly_credits_quota: number;
+  monthly_credits_used: number;
+};
+}>;
+  meta?: {
+  schema_version: string;
+};
+}>;

package/docs/services/predictLeads/companies.ts

@@ -0,0 +1,84 @@
+/**
+ * Retrieve Companies
+ * Returns a list of companies filtered by their location and size, ordered by last updated date. Note: This endpoint returns an estimated count of all results.
+ * HTTP GET /discover/companies
+ */
+type companies = (params: {
+  /** The response will include only companies located in the given country name or state name/abbreviation. */
+  location: string;
+  /** An array of one or more valid company sizes. */
+  sizes: Array<"1" | "2-10" | "11-50" | "51-200" | "201-500" | "501-1000" | "1001-5000" | "5001-10000" | "10001+">;
+  /** Page number of shown items. **NOTE**: If the parameter is not provided, the meta property `count` will be omitted from response for performance reasons. */
+  page?: number;
+  /** Limit the number of shown items per page. */
+  limit?: number;
+}) => Promise<{
+  data: Array<{
+  id: string;
+  type: "company";
+  attributes: {
+  domain: string;
+  company_name: string | null;
+  ticker: string | null;
+  friendly_company_name: string;
+  meta_title: string;
+  meta_description: string;
+  description: string | null;
+  description_short: string | null;
+  language: string;
+  location: string;
+  location_data: Array<{
+  city: unknown;
+  state: unknown;
+  zip_code: unknown;
+  country: unknown;
+  region: unknown;
+  continent: unknown;
+  fuzzy_match: unknown;
+}>;
+};
+  relationships: {
+  redirects_to: {
+  data: {
+  id: unknown;
+  type: unknown;
+} | null;
+  meta: {
+  reason: "acquisition_merger" | "locality" | "rebranding";
+};
+};
+  parent_company: {
+  data: {
+  id: unknown;
+  type: unknown;
+} | null;
+};
+  subsidiary_companies: {
+  data: Array<{
+  id: unknown;
+  type: unknown;
+}>;
+};
+  lookalike_companies: {
+  data: Array<{
+  id: unknown;
+  type: unknown;
+}>;
+};
+};
+}>;
+  included: Array<{
+  id: string;
+  type: "company";
+  attributes: {
+  domain: string;
+  company_name: string | null;
+  ticker: string | null;
+};
+}>;
+  meta?: {
+  schema_version: string;
+  record_state: "active";
+  count?: number;
+};
+}>;

package/docs/services/predictLeads/company.ts

@@ -0,0 +1,78 @@
+/**
+ * Retrieve Company
+ * Returns Company.
+ * HTTP GET /companies/{id_or_domain}
+ */
+type company = (params: {
+  /** Company's ID or domain. */
+  id_or_domain: string;
+}) => Promise<{
+  data: Array<{
+  id: string;
+  type: "company";
+  attributes: {
+  domain: string;
+  company_name: string | null;
+  ticker: string | null;
+  friendly_company_name: string;
+  meta_title: string;
+  meta_description: string;
+  description: string | null;
+  description_short: string | null;
+  language: string;
+  location: string;
+  location_data: Array<{
+  city: unknown;
+  state: unknown;
+  zip_code: unknown;
+  country: unknown;
+  region: unknown;
+  continent: unknown;
+  fuzzy_match: unknown;
+}>;
+};
+  relationships: {
+  redirects_to: {
+  data: {
+  id: unknown;
+  type: unknown;
+} | null;
+  meta: {
+  reason: "acquisition_merger" | "locality" | "rebranding";
+};
+};
+  parent_company: {
+  data: {
+  id: unknown;
+  type: unknown;
+} | null;
+};
+  subsidiary_companies: {
+  data: Array<{
+  id: unknown;
+  type: unknown;
+}>;
+};
+  lookalike_companies: {
+  data: Array<{
+  id: unknown;
+  type: unknown;
+}>;
+};
+};
+}>;
+  included: Array<{
+  id: string;
+  type: "company";
+  attributes: {
+  domain: string;
+  company_name: string | null;
+  ticker: string | null;
+};
+}>;
+  meta?: {
+  schema_version: string;
+  record_state: "active";
+  count?: number;
+};
+}>;

package/docs/services/predictLeads/companyConnections.ts

@@ -0,0 +1,59 @@
+/**
+ * Retrieve company's Connections
+ * Returns a list of company's Connections.
+ * HTTP GET /companies/{company_id_or_domain}/connections
+ */
+type companyConnections = (params: {
+  /** Company's ID or domain. */
+  company_id_or_domain: string;
+  /** Only return `Connections` first seen after given date (ISO 8601). */
+  first_seen_at_from?: string;
+  /** Only return `Connections` first seen before given date (ISO 8601). */
+  first_seen_at_until?: string;
+  /** Comma-separated (,) `Connection` categories. */
+  categories?: Array<"partner" | "vendor" | "integration" | "investor" | "parent" | "rebranding" | "published_in" | "badge" | "other">;
+  /** Page number of shown items. **NOTE**: If the parameter is not provided, the meta property `count` will be omitted from response for performance reasons. */
+  page?: number;
+  /** Limit the number of shown items per page. */
+  limit?: number;
+}) => Promise<{
+  data: Array<{
+  id: string;
+  type: "connection";
+  attributes: {
+  category: "partner" | "vendor" | "integration" | "investor" | "parent" | "rebranding" | "published_in" | "badge" | "other";
+  source_category: "undefined" | "partner_page" | "vendor_page" | "integration_page" | "investor_page" | "about_page" | "parent_page" | "case_study_page" | "testimonial_page" | "manual_input" | "domain_redirect" | "same_subpage" | "partner_section" | "vendor_section" | "integration_section" | "investor_section" | "parent_section" | "case_study_section" | "testimonial_section" | "social_section" | "published_in_section" | "vendor_inverse_section" | "investor_inverse_section" | "parent_inverse_section" | "footer" | "header" | "vendor_inverse_page" | "cookie_section" | "badge_section";
+  source_url: string | null;
+  individual_source_url: string | null;
+  context: string | null;
+  first_seen_at: string;
+  last_seen_at: string;
+};
+  relationships: {
+  company1: {
+  data: {
+  id: string;
+  type: "company";
+};
+};
+  company2: {
+  data: {
+  id: string;
+  type: "company";
+};
+};
+  technology: {
+  data: {
+  id: unknown;
+  type: unknown;
+} | null;
+};
+};
+}>;
+  included: Array<Record<string, unknown>>;
+  meta?: {
+  schema_version: string;
+  record_state: "active";
+  count?: number;
+};
+}>;

package/docs/services/predictLeads/companyFinancingEvents.ts

@@ -0,0 +1,60 @@
+/**
+ * Retrieve company's Financing Events
+ * Returns a list of company's Financing Events.
+ * HTTP GET /companies/{company_id_or_domain}/financing_events
+ */
+type companyFinancingEvents = (params: {
+  /** Company's ID or domain. */
+  company_id_or_domain: string;
+  /** Only return `FinancingEvents` first seen after given date (ISO 8601). */
+  first_seen_at_from?: string;
+  /** Only return `FinancingEvents` first seen before given date (ISO 8601). */
+  first_seen_at_until?: string;
+  /** Page number of shown items. **NOTE**: If the parameter is not provided, the meta property `count` will be omitted from response for performance reasons. */
+  page?: number;
+  /** Limit the number of shown items per page. */
+  limit?: number;
+}) => Promise<{
+  data: Array<{
+  id: string;
+  type: "financing_event";
+  attributes: {
+  effective_date: string | null;
+  found_at: string;
+  categories: Array<"series" | "pre_angel" | "angel_plus" | "angel_plus_plus" | "angel" | "angel_1" | "angel_2" | "angel_3" | "pre_seed" | "seed_plus" | "seed_plus_plus" | "seed" | "seed_1" | "seed_2" | "seed_3" | "pre_series_a" | "series_a_plus" | "series_a_plus_plus" | "series_a" | "series_a1" | "series_a2" | "series_a3" | "pre_series_b" | "series_b_plus" | "series_b_plus_plus" | "series_b" | "series_b1" | "series_b2" | "series_b3" | "pre_series_c" | "series_c_plus" | "series_c_plus_plus" | "series_c" | "series_c1" | "series_c2" | "series_c3" | "pre_series_d" | "series_d_plus" | "series_d_plus_plus" | "series_d" | "series_d1" | "series_d2" | "series_d3" | "pre_series_e" | "series_e_plus" | "series_e_plus_plus" | "series_e" | "series_e1" | "series_e2" | "series_e3" | "pre_series_f" | "series_f_plus" | "series_f_plus_plus" | "series_f" | "series_f1" | "series_f2" | "series_f3" | "pre_series_g" | "series_g_plus" | "series_g_plus_plus" | "series_g" | "series_g1" | "series_g2" | "series_g3" | "pre_series_h" | "series_h_plus" | "series_h_plus_plus" | "series_h" | "series_h1" | "series_h2" | "series_h3" | "pre_series_i" | "series_i_plus" | "series_i_plus_plus" | "series_i" | "series_i1" | "series_i2" | "series_i3" | "pre_series_j" | "series_j_plus" | "series_j_plus_plus" | "series_j" | "series_j1" | "series_j2" | "series_j3" | "pre_angel_bridge" | "angel_plus_bridge" | "angel_plus_plus_bridge" | "angel_bridge" | "angel_1_bridge" | "angel_2_bridge" | "angel_3_bridge" | "pre_seed_bridge" | "seed_plus_bridge" | "seed_plus_plus_bridge" | "seed_bridge" | "seed_1_bridge" | "seed_2_bridge" | "seed_3_bridge" | "pre_series_a_bridge" | "series_a_plus_bridge" | "series_a_plus_plus_bridge" | "series_a_bridge" | "series_a1_bridge" | "series_a2_bridge" | "series_a3_bridge" | "pre_series_b_bridge" | "series_b_plus_bridge" | "series_b_plus_plus_bridge" | "series_b_bridge" | "series_b1_bridge" | "series_b2_bridge" | "series_b3_bridge" | "pre_series_c_bridge" | "series_c_plus_bridge" | "series_c_plus_plus_bridge" | "series_c_bridge" | "series_c1_bridge" | "series_c2_bridge" | "series_c3_bridge" | "pre_series_d_bridge" | "series_d_plus_bridge" | "series_d_plus_plus_bridge" | "series_d_bridge" | "series_d1_bridge" | "series_d2_bridge" | "series_d3_bridge" | "pre_series_e_bridge" | "series_e_plus_bridge" | "series_e_plus_plus_bridge" | "series_e_bridge" | "series_e1_bridge" | "series_e2_bridge" | "series_e3_bridge" | "corporate_round" | "venture" | "venture_debt" | "product_crowdfunding" | "equity_crowdfunding" | "debt" | "convertible_note" | "safe" | "pipe" | "ipo" | "ico" | "ido" | "post_ipo_debt" | "post_ipo_equity" | "post_ipo_secondary" | "private_equity" | "secondary_transaction" | "donation" | "grant" | "subsidy" | "public_funding" | "government_assistance" | "other">;
+  financing_type: string | null;
+  financing_type_normalized: "pre_angel" | "angel_plus" | "angel_plus_plus" | "angel" | "angel_1" | "angel_2" | "angel_3" | "pre_seed" | "seed_plus" | "seed_plus_plus" | "seed" | "seed_1" | "seed_2" | "seed_3" | "pre_series_a" | "series_a_plus" | "series_a_plus_plus" | "series_a" | "series_a1" | "series_a2" | "series_a3" | "pre_series_b" | "series_b_plus" | "series_b_plus_plus" | "series_b" | "series_b1" | "series_b2" | "series_b3" | "pre_series_c" | "series_c_plus" | "series_c_plus_plus" | "series_c" | "series_c1" | "series_c2" | "series_c3" | "pre_series_d" | "series_d_plus" | "series_d_plus_plus" | "series_d" | "series_d1" | "series_d2" | "series_d3" | "pre_series_e" | "series_e_plus" | "series_e_plus_plus" | "series_e" | "series_e1" | "series_e2" | "series_e3" | "pre_series_f" | "series_f_plus" | "series_f_plus_plus" | "series_f" | "series_f1" | "series_f2" | "series_f3" | "pre_series_g" | "series_g_plus" | "series_g_plus_plus" | "series_g" | "series_g1" | "series_g2" | "series_g3" | "pre_series_h" | "series_h_plus" | "series_h_plus_plus" | "series_h" | "series_h1" | "series_h2" | "series_h3" | "pre_series_i" | "series_i_plus" | "series_i_plus_plus" | "series_i" | "series_i1" | "series_i2" | "series_i3" | "pre_series_j" | "series_j_plus" | "series_j_plus_plus" | "series_j" | "series_j1" | "series_j2" | "series_j3" | "pre_angel_bridge" | "angel_plus_bridge" | "angel_plus_plus_bridge" | "angel_bridge" | "angel_1_bridge" | "angel_2_bridge" | "angel_3_bridge" | "pre_seed_bridge" | "seed_plus_bridge" | "seed_plus_plus_bridge" | "seed_bridge" | "seed_1_bridge" | "seed_2_bridge" | "seed_3_bridge" | "pre_series_a_bridge" | "series_a_plus_bridge" | "series_a_plus_plus_bridge" | "series_a_bridge" | "series_a1_bridge" | "series_a2_bridge" | "series_a3_bridge" | "pre_series_b_bridge" | "series_b_plus_bridge" | "series_b_plus_plus_bridge" | "series_b_bridge" | "series_b1_bridge" | "series_b2_bridge" | "series_b3_bridge" | "pre_series_c_bridge" | "series_c_plus_bridge" | "series_c_plus_plus_bridge" | "series_c_bridge" | "series_c1_bridge" | "series_c2_bridge" | "series_c3_bridge" | "pre_series_d_bridge" | "series_d_plus_bridge" | "series_d_plus_plus_bridge" | "series_d_bridge" | "series_d1_bridge" | "series_d2_bridge" | "series_d3_bridge" | "pre_series_e_bridge" | "series_e_plus_bridge" | "series_e_plus_plus_bridge" | "series_e_bridge" | "series_e1_bridge" | "series_e2_bridge" | "series_e3_bridge" | null;
+  amount: string | null;
+  amount_normalized: number | null;
+  source_urls: Array<string>;
+};
+  relationships: {
+  company: {
+  data: {
+  id: string;
+  type: "company";
+};
+};
+  investors: {
+  data: Array<{
+  id: unknown;
+  type: unknown;
+}>;
+};
+};
+}>;
+  included: Array<{
+  id: string;
+  type: "company";
+  attributes: {
+  domain: string;
+  company_name: string | null;
+  ticker: string | null;
+};
+}>;
+  meta?: {
+  schema_version: string;
+  record_state: "active";
+  count?: number;
+};
+}>;

package/docs/services/predictLeads/companyGithubRepositories.ts

@@ -0,0 +1,64 @@
+/**
+ * Retrieve company's Github Repositories
+ * Returns a list of company's Github Repositories.
+ * HTTP GET /companies/{company_id_or_domain}/github_repositories
+ */
+type companyGithubRepositories = (params: {
+  /** Company's ID or domain. */
+  company_id_or_domain: string;
+  /** Only return `GithubRepositories` first seen after given date (ISO 8601). */
+  first_seen_at_from?: string;
+  /** Only return `GithubRepositories` first seen before given date (ISO 8601). */
+  first_seen_at_until?: string;
+  /** Page number of shown items. **NOTE**: If the parameter is not provided, the meta property `count` will be omitted from response for performance reasons. */
+  page?: number;
+  /** Limit the number of shown items per page. */
+  limit?: number;
+}) => Promise<{
+  data: Array<{
+  id: string;
+  type: "github_repository";
+  attributes: {
+  url: string;
+  description: string | null;
+  first_seen_at: string;
+};
+  relationships: {
+  company: {
+  data: {
+  id: string;
+  type: "company";
+};
+};
+  timeseries_datapoints: {
+  data: Array<{
+  id: unknown;
+  type: unknown;
+}>;
+};
+};
+}>;
+  included: Array<{
+  id: string;
+  type: "company";
+  attributes: {
+  domain: string;
+  company_name: string | null;
+  ticker: string | null;
+};
+} | {
+  attributes?: {
+  data?: {
+  forks: number;
+  stars: number;
+  watches: number;
+  last_update_at: string;
+};
+};
+}>;
+  meta?: {
+  schema_version: string;
+  record_state: "active";
+  count?: number;
+};
+}>;

package/docs/services/predictLeads/companyJobOpenings.ts

@@ -0,0 +1,102 @@
+/**
+ * Retrieve company's Job Openings
+ * Returns a list of company's Job Openings.
+ * HTTP GET /companies/{company_id_or_domain}/job_openings
+ */
+type companyJobOpenings = (params: {
+  /** Company's ID or domain. */
+  company_id_or_domain: string;
+  /** Set to true if you'd like to receive JobOpenings that are not closed, have last_seen_at more recent than 5 days and were found in the last year. */
+  active_only?: boolean;
+  /** Similar to `active_only`, but without considering `last_seen_at` timestamp. */
+  not_closed?: boolean;
+  /** Only return `JobOpenings` first seen after given date (ISO 8601). */
+  first_seen_at_from?: string;
+  /** Only return `JobOpenings` first seen before given date (ISO 8601). */
+  first_seen_at_until?: string;
+  /** Only return `JobOpenings` last seen after given date (ISO 8601). */
+  last_seen_at_from?: string;
+  /** Only return `JobOpenings` last seen before given date (ISO 8601). */
+  last_seen_at_until?: string;
+  /** Only return JobOpenings that have description. */
+  with_description_only?: boolean;
+  /** Only return JobOpenings that have location. */
+  with_location_only?: boolean;
+  /** Comma-separated (,) `JobOpening` categories. */
+  categories?: Array<"administration" | "consulting" | "data_analysis" | "design" | "directors" | "education" | "engineering" | "finance" | "healthcare_services" | "human_resources" | "information_technology" | "internship" | "legal" | "management" | "marketing" | "military_and_protective_services" | "operations" | "purchasing" | "product_management" | "quality_assurance" | "real_estate" | "research" | "sales" | "software_development" | "support" | "manual_work" | "food">;
+  /** Page number of shown items. **NOTE**: If the parameter is not provided, the meta property `count` will be omitted from response for performance reasons. */
+  page?: number;
+  /** Limit the number of shown items per page. */
+  limit?: number;
+}) => Promise<{
+  data: Array<{
+  id: string;
+  type: "job_opening";
+  attributes: {
+  title: string;
+  description: string | null;
+  url: string;
+  first_seen_at: string;
+  last_seen_at: string;
+  last_processed_at: string;
+  contract_types: Array<Record<string, unknown>>;
+  categories: Array<"administration" | "consulting" | "data_analysis" | "design" | "directors" | "education" | "engineering" | "finance" | "healthcare_services" | "human_resources" | "information_technology" | "internship" | "legal" | "management" | "marketing" | "military_and_protective_services" | "operations" | "purchasing" | "product_management" | "quality_assurance" | "real_estate" | "research" | "sales" | "software_development" | "support" | "manual_work" | "food">;
+  onet_data: {
+  code: string | null;
+  family: string | null;
+  occupation_name: string | null;
+};
+  posted_at: string | null;
+  recruiter_data: {
+  name: string | null;
+  title: string | null;
+  contact: string | null;
+};
+  salary: string | null;
+  salary_data: {
+  salary_low: number | null;
+  salary_high: number | null;
+  salary_currency: string | null;
+  salary_low_usd: number | null;
+  salary_high_usd: number | null;
+  salary_time_unit: "hour" | "day" | "week" | "month" | "year" | null;
+};
+  seniority: "not_set" | "founder" | "c_level" | "partner" | "president" | "vice_president" | "head" | "director" | "manager" | "mid_senior" | "junior" | "non_manager";
+  status: "closed" | null;
+  language: string | null;
+  location: string | null;
+  location_data: Array<{
+  city: unknown;
+  state: unknown;
+  zip_code: unknown;
+  country: unknown;
+  region: unknown;
+  continent: unknown;
+  fuzzy_match: unknown;
+}>;
+  tags: Array<Record<string, unknown>>;
+};
+  relationships: {
+  company: {
+  data: {
+  id: string;
+  type: "company";
+};
+};
+};
+}>;
+  included: Array<{
+  id: string;
+  type: "company";
+  attributes: {
+  domain: string;
+  company_name: string | null;
+  ticker: string | null;
+};
+}>;
+  meta?: {
+  schema_version: string;
+  record_state: "active";
+  count?: number;
+};
+}>;

package/docs/services/predictLeads/companyNewsEvents.ts

@@ -0,0 +1,113 @@
+/**
+ * Retrieve company's News Events
+ * Returns a list of company's News Events.
+ * HTTP GET /companies/{company_id_or_domain}/news_events
+ */
+type companyNewsEvents = (params: {
+  /** Company's ID or domain. */
+  company_id_or_domain: string;
+  /** Only return `NewsEvents` found after given date (ISO 8601). */
+  found_at_from?: string;
+  /** Only return `NewsEvents` found before given date (ISO 8601). */
+  found_at_until?: string;
+  /** Comma-separated (,) `NewsEvent` categories. */
+  categories?: Array<"acquires" | "merges_with" | "sells_assets_to" | "signs_new_client" | "files_suit_against" | "has_issues_with" | "closes_offices_in" | "decreases_headcount_by" | "attends_event" | "expands_facilities" | "expands_offices_in" | "expands_offices_to" | "increases_headcount_by" | "opens_new_location" | "goes_public" | "invests_into" | "invests_into_assets" | "receives_financing" | "hires" | "leaves" | "promotes" | "retires_from" | "integrates_with" | "is_developing" | "launches" | "partners_with" | "receives_award" | "recognized_as" | "identified_as_competitor_of">;
+  /** Page number of shown items. **NOTE**: If the parameter is not provided, the meta property `count` will be omitted from response for performance reasons. */
+  page?: number;
+  /** Limit the number of shown items per page. */
+  limit?: number;
+}) => Promise<{
+  data: Array<{
+  id: string;
+  type: "news_event";
+  attributes: {
+  summary: string;
+  category: "acquires" | "merges_with" | "sells_assets_to" | "signs_new_client" | "files_suit_against" | "has_issues_with" | "closes_offices_in" | "decreases_headcount_by" | "attends_event" | "expands_facilities" | "expands_offices_in" | "expands_offices_to" | "increases_headcount_by" | "opens_new_location" | "goes_public" | "invests_into" | "invests_into_assets" | "receives_financing" | "hires" | "leaves" | "promotes" | "retires_from" | "integrates_with" | "is_developing" | "launches" | "partners_with" | "receives_award" | "recognized_as" | "identified_as_competitor_of";
+  found_at: string;
+  confidence: number;
+  article_sentence: string;
+  planning: boolean;
+  amount: string | null;
+  amount_normalized: number | null;
+  assets: string | null;
+  assets_tags: Array<string>;
+  award: string | null;
+  contact: string | null;
+  event: string | null;
+  effective_date: string | null;
+  division: string | null;
+  financing_type: string | null;
+  financing_type_normalized: "pre_angel" | "angel_plus" | "angel_plus_plus" | "angel" | "angel_1" | "angel_2" | "angel_3" | "pre_seed" | "seed_plus" | "seed_plus_plus" | "seed" | "seed_1" | "seed_2" | "seed_3" | "pre_series_a" | "series_a_plus" | "series_a_plus_plus" | "series_a" | "series_a1" | "series_a2" | "series_a3" | "pre_series_b" | "series_b_plus" | "series_b_plus_plus" | "series_b" | "series_b1" | "series_b2" | "series_b3" | "pre_series_c" | "series_c_plus" | "series_c_plus_plus" | "series_c" | "series_c1" | "series_c2" | "series_c3" | "pre_series_d" | "series_d_plus" | "series_d_plus_plus" | "series_d" | "series_d1" | "series_d2" | "series_d3" | "pre_series_e" | "series_e_plus" | "series_e_plus_plus" | "series_e" | "series_e1" | "series_e2" | "series_e3" | "pre_series_f" | "series_f_plus" | "series_f_plus_plus" | "series_f" | "series_f1" | "series_f2" | "series_f3" | "pre_series_g" | "series_g_plus" | "series_g_plus_plus" | "series_g" | "series_g1" | "series_g2" | "series_g3" | "pre_series_h" | "series_h_plus" | "series_h_plus_plus" | "series_h" | "series_h1" | "series_h2" | "series_h3" | "pre_series_i" | "series_i_plus" | "series_i_plus_plus" | "series_i" | "series_i1" | "series_i2" | "series_i3" | "pre_series_j" | "series_j_plus" | "series_j_plus_plus" | "series_j" | "series_j1" | "series_j2" | "series_j3" | "pre_angel_bridge" | "angel_plus_bridge" | "angel_plus_plus_bridge" | "angel_bridge" | "angel_1_bridge" | "angel_2_bridge" | "angel_3_bridge" | "pre_seed_bridge" | "seed_plus_bridge" | "seed_plus_plus_bridge" | "seed_bridge" | "seed_1_bridge" | "seed_2_bridge" | "seed_3_bridge" | "pre_series_a_bridge" | "series_a_plus_bridge" | "series_a_plus_plus_bridge" | "series_a_bridge" | "series_a1_bridge" | "series_a2_bridge" | "series_a3_bridge" | "pre_series_b_bridge" | "series_b_plus_bridge" | "series_b_plus_plus_bridge" | "series_b_bridge" | "series_b1_bridge" | "series_b2_bridge" | "series_b3_bridge" | "pre_series_c_bridge" | "series_c_plus_bridge" | "series_c_plus_plus_bridge" | "series_c_bridge" | "series_c1_bridge" | "series_c2_bridge" | "series_c3_bridge" | "pre_series_d_bridge" | "series_d_plus_bridge" | "series_d_plus_plus_bridge" | "series_d_bridge" | "series_d1_bridge" | "series_d2_bridge" | "series_d3_bridge" | "pre_series_e_bridge" | "series_e_plus_bridge" | "series_e_plus_plus_bridge" | "series_e_bridge" | "series_e1_bridge" | "series_e2_bridge" | "series_e3_bridge" | null;
+  financing_type_tags: Array<string>;
+  headcount: number | null;
+  job_title: string | null;
+  job_title_tags: Array<string>;
+  location: string | null;
+  location_data: Array<{
+  city: unknown;
+  state: unknown;
+  zip_code: unknown;
+  country: unknown;
+  region: unknown;
+  continent: unknown;
+  fuzzy_match: unknown;
+}>;
+  product: string | null;
+  product_data: {
+  full_text: string | null;
+  name: string | null;
+  release_type: string | null;
+  release_version: string | null;
+  fuzzy_match: boolean | null;
+};
+  product_tags: Array<string>;
+  recognition: string | null;
+  vulnerability: string | null;
+};
+  relationships: {
+  company1?: {
+  data: {
+  id: string;
+  type: "company";
+};
+};
+  company2?: {
+  data: {
+  id: string;
+  type: "company";
+};
+};
+  most_relevant_source: {
+  data: {
+  id: string;
+  type: "news_article";
+};
+};
+};
+}>;
+  included: Array<{
+  id: string;
+  type: "company";
+  attributes: {
+  domain: string;
+  company_name: string | null;
+  ticker: string | null;
+};
+} | {
+  id: string;
+  type: "news_article";
+  attributes: {
+  url: string;
+  title: string;
+  author: string | null;
+  image_url: string | null;
+  published_at: string;
+  body: string;
+};
+}>;
+  meta?: {
+  schema_version: string;
+  record_state: "active";
+  count?: number;
+};
+}>;

package/docs/services/predictLeads/companyProducts.ts

@@ -0,0 +1,51 @@
+/**
+ * Retrieve company's Products
+ * Returns a list of company's Products.
+ * HTTP GET /companies/{company_id_or_domain}/products
+ */
+type companyProducts = (params: {
+  /** Company's ID or domain. */
+  company_id_or_domain: string;
+  /** Only return `Products` first seen after given date (ISO 8601). */
+  first_seen_at_from?: string;
+  /** Only return `Products` first seen before given date (ISO 8601). */
+  first_seen_at_until?: string;
+  /** Page number of shown items. **NOTE**: If the parameter is not provided, the meta property `count` will be omitted from response for performance reasons. */
+  page?: number;
+  /** Limit the number of shown items per page. */
+  limit?: number;
+}) => Promise<{
+  data: Array<{
+  id: string;
+  type: "product";
+  attributes: {
+  name: string;
+  sources: "menu" | "pricing";
+  source_url: string;
+  first_seen_at: string;
+  last_seen_at: string;
+};
+  relationships: {
+  company: {
+  data: {
+  id: string;
+  type: "company";
+};
+};
+};
+}>;
+  included: Array<{
+  id: string;
+  type: "company";
+  attributes: {
+  domain: string;
+  company_name: string | null;
+  ticker: string | null;
+};
+}>;
+  meta?: {
+  schema_version: string;
+  record_state: "active";
+  count?: number;
+};
+}>;