Module: TiktokBusinessApi

Defined in:
lib/tiktok_business_api.rb,
lib/tiktok_business_api/auth.rb,
lib/tiktok_business_api/utils.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/ad.rb,
lib/tiktok_business_api/resources/image.rb,
lib/tiktok_business_api/resources/adgroup.rb,
lib/tiktok_business_api/resources/campaign.rb,
lib/tiktok_business_api/resources/identity.rb,
lib/tiktok_business_api/resources/base_resource.rb,
lib/tiktok_business_api/resources/crud_resource.rb

Defined Under Namespace

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

Constant Summary collapse

VERSION = 
"0.2.0"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.config ⇒ Object

Returns the value of attribute config.



27
28
29
 
# File 'lib/tiktok_business_api.rb', line 27

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:



43
44
45
 
# File 'lib/tiktok_business_api.rb', line 43

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:



33
34
35
36
37
 
# File 'lib/tiktok_business_api.rb', line 33

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