Class: BrightData::Client

Inherits:

Object

• Object
• BrightData::Client

Defined in:

lib/brightdata/client.rb

Overview

Top-level Bright Data API client.

Examples:

client = BrightData::Client.new(api_token: ENV.fetch("BRIGHTDATA_API_TOKEN"))
client.linkedin

Instance Attribute Summary

• #http ⇒ BrightData::HTTP readonly

  Underlying HTTP wrapper.

• #linkedin ⇒ BrightData::LinkedIn::Namespace readonly

  LinkedIn endpoint namespace.

Instance Method Summary

• #initialize(api_token:, base_url: BrightData::HTTP::BASE_URL, logger: nil) ⇒ Client constructor

  A new instance of Client.

Constructor Details

#initialize(api_token:, base_url: BrightData::HTTP::BASE_URL, logger: nil) ⇒ Client

Returns a new instance of Client.

Parameters:

• api_token (String) —

  Bright Data API token

• base_url (String) (defaults to: BrightData::HTTP::BASE_URL) —

  override Bright Data API base URL

• logger (Logger, nil) (defaults to: nil) —

  optional logger for request tracing

Raises:

• (BrightData::ConfigurationError) —

  if ‘api_token` is nil or empty

# File 'lib/brightdata/client.rb', line 20

def initialize(api_token:, base_url: BrightData::HTTP::BASE_URL, logger: nil)
  @http = HTTP.new(api_token:, base_url:, logger:)
  @linkedin = LinkedIn::Namespace.new(http: @http)
end

Instance Attribute Details

#http ⇒ BrightData::HTTP (readonly)

Returns underlying HTTP wrapper.

Returns:

• (BrightData::HTTP) —

  underlying HTTP wrapper

# File 'lib/brightdata/client.rb', line 11

def http
  @http
end

#linkedin ⇒ BrightData::LinkedIn::Namespace (readonly)

Returns LinkedIn endpoint namespace.

Returns:

• (BrightData::LinkedIn::Namespace) —

  LinkedIn endpoint namespace

# File 'lib/brightdata/client.rb', line 14

def linkedin
  @linkedin
end