orangeslice 2.0.0 → 2.0.2

package/docs/services/predictLeads/companySimilarCompanies.ts

@@ -0,0 +1,50 @@
+/**
+ * Retrieve company's Similar Companies
+ * Returns a list of company's Similar Companies.
+ * HTTP GET /companies/{company_id_or_domain}/similar_companies
+ */
+type companySimilarCompanies = (params: {
+  /** Company's ID or domain. */
+  company_id_or_domain: string;
+  /** Limit the number of shown items per page. */
+  limit?: number;
+}) => Promise<{
+  data: Array<{
+  id: string;
+  type: "company_similarity";
+  attributes: {
+  score: number;
+  position: number | null;
+  reason: string | null;
+  refreshed_at: string;
+};
+  relationships: {
+  company: {
+  data: {
+  id: string;
+  type: "company";
+};
+};
+  similar_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/companyTechnologyDetections.ts

@@ -0,0 +1,122 @@
+/**
+ * Retrieve Technologies used by specific Company
+ * Returns Technologies used by a specific Company as a list of Technology Detections.
+ * HTTP GET /companies/{company_id_or_domain}/technology_detections
+ */
+type companyTechnologyDetections = (params: {
+  /** Company's ID or domain. */
+  company_id_or_domain: string;
+  /** Only return `TechnologyDetections` first seen after given date (ISO 8601). */
+  first_seen_at_from?: string;
+  /** Only return `TechnologyDetections` first seen before given date (ISO 8601). */
+  first_seen_at_until?: string;
+  /** Only return `TechnologyDetections` last seen after given date (ISO 8601). */
+  last_seen_at_from?: string;
+  /** Only return `TechnologyDetections` last seen before given date (ISO 8601). */
+  last_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: "technology_detection";
+  attributes: {
+  first_seen_at: string;
+  last_seen_at: string;
+  behind_firewall: boolean;
+  score: number;
+};
+  relationships: {
+  company: {
+  data: {
+  id: string;
+  type: "company";
+};
+};
+  seen_on_job_openings: {
+  data: Array<{
+  id: unknown;
+  type: unknown;
+}>;
+};
+  seen_on_subpages: {
+  data: Array<{
+  id: unknown;
+  type: unknown;
+}>;
+};
+  seen_on_dns_records: {
+  data: Array<{
+  id: unknown;
+  type: unknown;
+}>;
+};
+  seen_on_connection: {
+  data: {
+  id: string;
+  type: "connection";
+};
+};
+  technology: {
+  data: {
+  id: string;
+  type: "technology";
+};
+};
+};
+}>;
+  included: Array<{
+  id: string;
+  type: "company";
+  attributes: {
+  domain: string;
+  company_name: string | null;
+  ticker: string | null;
+};
+} | {
+  id: string;
+  type: "technology";
+  attributes: {
+  name: string;
+};
+} | {
+  id: string;
+  type: "detection_on_subpage";
+  attributes: {
+  first_seen_at: string;
+  last_seen_at: string;
+  subpage_url: string;
+};
+} | {
+  id: string;
+  type: "job_opening";
+  attributes: {
+  first_seen_at: string;
+  last_seen_at: string;
+  url: string;
+};
+} | {
+  id: string;
+  type: "dns_record";
+  attributes: {
+  first_seen_at: string;
+  last_seen_at: string;
+  record_type: "TXT" | "MX" | "NS" | "CNAME" | "SOA_MNAME" | "SOA_RNAME";
+};
+} | {
+  id: string;
+  type: "connection";
+  attributes: {
+  first_seen_at: string;
+  last_seen_at: string;
+  source_url: string | null;
+};
+}>;
+  meta?: {
+  schema_version: string;
+  record_state: "active";
+  count?: number;
+};
+}>;

package/docs/services/predictLeads/companyWebsiteEvolution.ts

@@ -0,0 +1,54 @@
+/**
+ * Retrieve company's Website Evolution
+ * Returns a list of company's Website Evolution.
+ * HTTP GET /companies/{company_id_or_domain}/website_evolution
+ */
+type companyWebsiteEvolution = (params: {
+  /** Company's ID or domain. */
+  company_id_or_domain: string;
+  /** Only return `Subpages` first seen after given date (ISO 8601). */
+  first_seen_at_from?: string;
+  /** Only return `Subpages` 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: "subpage";
+  attributes: {
+  category: string;
+  url: string;
+  text_content: string | null;
+  first_seen_at: string;
+  last_seen_at: string;
+  last_extraction_states: Array<{
+  attributes: 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/discoverConnectionInvestors.ts

@@ -0,0 +1,59 @@
+/**
+ * Retrieve Portfolio Companies
+ * Returns the Portfolio Companies found on the portfolio pages of thousands of VCs, accelerators, and incubators, as a list of Connections categorized as `investor`, ordered by the `first_seen_at`, descending.
+ * HTTP GET /discover/portfolio_companies/connections
+ */
+type discoverConnectionInvestors = (params: {
+  /** Only return `TechnologyDetections` first seen after given date (ISO 8601). */
+  first_seen_at_from?: string;
+  /** Only return `TechnologyDetections` first seen before given date (ISO 8601). */
+  first_seen_at_until?: string;
+  /** Only return `TechnologyDetections` last seen after given date (ISO 8601). */
+  last_seen_at_from?: string;
+  /** Only return `TechnologyDetections` last seen before given date (ISO 8601). */
+  last_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: "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/discoverJobOpenings.ts

@@ -0,0 +1,86 @@
+/**
+ * Retrieve a list of Job Openings
+ * Returns a list of Job Openings filtered by a given profession (e.g. "Sales Engineers" or "Marketing Managers") using O*NET occupation codes and/or location of the company. Note: This endpoint returns an estimated count of all results.
+ * HTTP GET /discover/job_openings
+ */
+type discoverJobOpenings = (params: {
+  /** Comma-separated O\*NET codes to filter by, such as "17-2071.00" for "Electrical Engineers" or "15-1254.00" for "Web Developers". For full list of possible codes see: https://www.onetonline.org/find/all */
+  onet_codes?: string;
+  /** The response will include only companies located in the given country name or state name/abbreviation. */
+  location?: 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: "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/discoverProducts.ts

@@ -0,0 +1,51 @@
+/**
+ * Retrieve a list of Products
+ * Returns a list of Products filtered by a source on a website (e.g. "pricing" for "Pricing Page" and/or "menu" for "Menu") and/or date when the Product was discovered.
+ * HTTP GET /discover/products/latest
+ */
+type discoverProducts = (params: {
+  /** Comma-separated (,) `Product` sources. */
+  sources?: Array<"menu" | "pricing">;
+  /** 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;
+};
+}>;

package/docs/services/predictLeads/discoverTechnologyTechnologyDetections.ts

@@ -0,0 +1,122 @@
+/**
+ * Retrieve Companies using specific Technology ID or fuzzy name
+ * Returns Companies using a specific Technology as a list of Technology Detections, ordered by the `first_seen_at`, descending. E.g. using this endpoint one can get a list of all companies using HubSpot or any other of the 30,000 technologies PredictLeads tracks. The specific Technology ID can be obtained by querying the ** Retrieve all tracked Technologies ** endpoint.
+ * HTTP GET /discover/technologies/{technology_id_or_fuzzy_name}/technology_detections
+ */
+type discoverTechnologyTechnologyDetections = (params: {
+  /** Technology's ID or fuzzy name. */
+  technology_id_or_fuzzy_name: string;
+  /** Only return `TechnologyDetections` first seen after given date (ISO 8601). */
+  first_seen_at_from?: string;
+  /** Only return `TechnologyDetections` first seen before given date (ISO 8601). */
+  first_seen_at_until?: string;
+  /** Only return `TechnologyDetections` last seen after given date (ISO 8601). */
+  last_seen_at_from?: string;
+  /** Only return `TechnologyDetections` last seen before given date (ISO 8601). */
+  last_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: "technology_detection";
+  attributes: {
+  first_seen_at: string;
+  last_seen_at: string;
+  behind_firewall: boolean;
+  score: number;
+};
+  relationships: {
+  company: {
+  data: {
+  id: string;
+  type: "company";
+};
+};
+  seen_on_job_openings: {
+  data: Array<{
+  id: unknown;
+  type: unknown;
+}>;
+};
+  seen_on_subpages: {
+  data: Array<{
+  id: unknown;
+  type: unknown;
+}>;
+};
+  seen_on_dns_records: {
+  data: Array<{
+  id: unknown;
+  type: unknown;
+}>;
+};
+  seen_on_connection: {
+  data: {
+  id: string;
+  type: "connection";
+};
+};
+  technology: {
+  data: {
+  id: string;
+  type: "technology";
+};
+};
+};
+}>;
+  included: Array<{
+  id: string;
+  type: "company";
+  attributes: {
+  domain: string;
+  company_name: string | null;
+  ticker: string | null;
+};
+} | {
+  id: string;
+  type: "technology";
+  attributes: {
+  name: string;
+};
+} | {
+  id: string;
+  type: "detection_on_subpage";
+  attributes: {
+  first_seen_at: string;
+  last_seen_at: string;
+  subpage_url: string;
+};
+} | {
+  id: string;
+  type: "job_opening";
+  attributes: {
+  first_seen_at: string;
+  last_seen_at: string;
+  url: string;
+};
+} | {
+  id: string;
+  type: "dns_record";
+  attributes: {
+  first_seen_at: string;
+  last_seen_at: string;
+  record_type: "TXT" | "MX" | "NS" | "CNAME" | "SOA_MNAME" | "SOA_RNAME";
+};
+} | {
+  id: string;
+  type: "connection";
+  attributes: {
+  first_seen_at: string;
+  last_seen_at: string;
+  source_url: string | null;
+};
+}>;
+  meta?: {
+  schema_version: string;
+  record_state: "active";
+  count?: number;
+};
+}>;

package/docs/services/predictLeads/financingEvents.ts

@@ -0,0 +1,58 @@
+/**
+ * Retrieve Financing Events
+ * Returns a list of Financing Events, optionally filtered by normalized financing type and company's location, ordered by updated date.
+ * HTTP GET /discover/financing_events
+ */
+type financingEvents = (params: {
+  /** Comma-separated (,) `FinancingEvent` normalized financing types. */
+  financing_types_normalized?: Array<"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">;
+  /** The response will include only companies located in the given country name or state name/abbreviation. */
+  company_location?: 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/followCompany.ts

@@ -0,0 +1,16 @@
+/**
+ * Follow the company
+ * Follow the company.
+ * HTTP POST /companies/{company_id_or_domain}/follow
+ */
+type followCompany = (params: {
+  /** Company's ID or domain. */
+  company_id_or_domain: string;
+  /** Provide, if you want to use your custom company identifier. */
+  custom_company_identifier?: string;
+}) => Promise<{
+  success: {
+  type: "follow_successful";
+  message: string;
+};
+}>;

package/docs/services/predictLeads/followedCompanies.ts

@@ -0,0 +1,16 @@
+/**
+ * Retrieve followed companies
+ * Returns followed companies.
+ * HTTP GET /followings
+ */
+type followedCompanies = (params: {
+  /** 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<{
+  domain: string;
+  custom_company_identifier?: string;
+}>;
+}>;