Module: Direct::API::V5

Defined in:
lib/direct/api/v5/version.rb,
lib/direct/api/v5/response.rb,
lib/direct/api/v5/settings.rb,
lib/direct/api/v5/params_builder.rb,
lib/direct/api/v5/response/error.rb,
lib/direct/api/v5/response/units.rb,
lib/direct/api/v5/default_settings.rb,
lib/direct/api/v5/refinements/camelize.rb,
lib/direct/api/v5/service.rb,
lib/direct/api/v5/request.rb,
lib/direct/api/v5/errors.rb,
lib/direct/api/v5/client.rb,
lib/direct/api/v5.rb

Defined Under Namespace

Modules: Refinements Classes: Client, DefaultSettings, Error, InvalidResponseError, ParamsBuilder, Request, RequestError, Response, Service, Settings

Constant Summary collapse

VERSION = 
'0.1.2'.freeze

Class Method Summary collapse

Class Method Details

.client(settings = {}) ⇒ Direct::API::V5::Client

Create API client

Examples:

Without settings

client = Direct::API::V5.client

With settings

client = Direct::API::V5.client(host: 'api.direct.yandex.com',
                                auth_token: 'token',
                                client_login: 'login')

Parameters:

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

    API settings (:host, :auth_token, :client_login)

Returns:



30
31
32
 
# File 'lib/direct/api/v5.rb', line 30

def client(settings = {})
  Client.new(settings)
end

.configure(&block) ⇒ Object

Set default settings from block

Examples:

Direct::API::V5.configure do |config|
  config.host = 'api.direct.yandex.com'
  config.auth_token = 'token'
  config. = 'login'
end



41
42
43
 
# File 'lib/direct/api/v5.rb', line 41

def configure(&block)
  DefaultSettings.configure(&block)
end

.load_settings(yml_file) ⇒ Object

Set default settings from .yml file

Examples:

Direct::API::V5.load_settings('config/yandex_direct_api.yml')

Parameters:

  • yml_file (String) —

    path to .yml file



49
50
51
 
# File 'lib/direct/api/v5.rb', line 49

def load_settings(yml_file)
  DefaultSettings.load_from_yml(yml_file)
end