Module: TiktokBusinessApi

Defined in:

lib/tiktok_business_api.rb,
lib/tiktok_business_api/auth.rb,
lib/tiktok_business_api/client.rb,
lib/tiktok_business_api/config.rb,
lib/tiktok_business_api/errors.rb,
lib/tiktok_business_api/version.rb,
lib/tiktok_business_api/resources/campaign.rb,
lib/tiktok_business_api/resources/base_resource.rb

Defined Under Namespace

Modules: Resources Classes: ApiError, Auth, AuthenticationError, AuthorizationError, Client, Config, Error, ErrorFactory, InvalidRequestError, RateLimitError

Constant Summary

VERSION =

"0.1.1"

Class Attribute Summary

• .config ⇒ Object

  Returns the value of attribute config.

Class Method Summary

• .client(options = {}) ⇒ TiktokBusinessApi::Client

  Create a new client instance.

• .configure {|config| ... } ⇒ TiktokBusinessApi::Config

  Configure the TikTok Business API client.

Class Attribute Details

.config ⇒ Object

Returns the value of attribute config.

# File 'lib/tiktok_business_api.rb', line 20

def config
  @config
end

Class Method Details

.client(options = {}) ⇒ TiktokBusinessApi::Client

Create a new client instance

Parameters:

• options (Hash) (defaults to: {}) —

  Optional configuration overrides

Returns:

• (TiktokBusinessApi::Client) —

  A new client instance

# File 'lib/tiktok_business_api.rb', line 36

def client(options = {})
  TiktokBusinessApi::Client.new(options)
end

.configure {|config| ... } ⇒ TiktokBusinessApi::Config

Configure the TikTok Business API client

Yields:

• (config) —

  Configuration object that can be modified

Returns:

• (TiktokBusinessApi::Config) —

  The configuration object

# File 'lib/tiktok_business_api.rb', line 26

def configure
  self.config ||= Config.new
  yield(config) if block_given?
  config
end