Class: BrightData::LinkedIn::Companies

Inherits:

Object

• Object
• BrightData::LinkedIn::Companies

Includes:

Endpoint

Defined in:

lib/brightdata/linkedin/companies.rb

Overview

‘client.linkedin.companies` endpoint family for LinkedIn companies by URL.

Examples:

Trigger an async collection

snapshot = client.linkedin.companies.trigger(urls: ["https://www.linkedin.com/company/example/"])

Scrape synchronously

companies = client.linkedin.companies.scrape(urls: ["https://www.linkedin.com/company/example/"])

Constant Summary

Constants included from Endpoint

Endpoint::SCRAPE_PATH, Endpoint::TRIGGER_PATH

Instance Method Summary

• #scrape(urls:) ⇒ Array<BrightData::LinkedIn::Types::Company>
• #trigger(urls:) ⇒ BrightData::Snapshot

Methods included from Endpoint

included

Instance Method Details

#scrape(urls:) ⇒ Array<BrightData::LinkedIn::Types::Company>

Parameters:

• urls (Array<String>) —

  LinkedIn company URLs

Returns:

• (Array<BrightData::LinkedIn::Types::Company>)

Raises:

• (BrightData::ArgumentError) —

  if ‘urls` is not an Array

• (BrightData::ScrapeTimeoutError) —

  when results exceed Bright Data’s synchronous cap

# File 'lib/brightdata/linkedin/companies.rb', line 21

class Companies
  include Endpoint

  endpoint(
    dataset_key: :companies_collect_by_url,
    input: Types::CompanyUrlInput,
    result: Types::Company,
    param: :urls
  )
end

#trigger(urls:) ⇒ BrightData::Snapshot

Parameters:

• urls (Array<String>) —

  LinkedIn company URLs

Returns:

• (BrightData::Snapshot)

Raises:

• (BrightData::ArgumentError) —

  if ‘urls` is not an Array

# File 'lib/brightdata/linkedin/companies.rb', line 21

class Companies
  include Endpoint

  endpoint(
    dataset_key: :companies_collect_by_url,
    input: Types::CompanyUrlInput,
    result: Types::Company,
    param: :urls
  )
end