Module: PeopleDoc::V2

Defined in:
lib/people_doc.rb

Defined Under Namespace

Classes: Client, EncodedCredentials

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.application_id ⇒ Object

Returns the value of attribute application_id.



164
165
166
 
# File 'lib/people_doc.rb', line 164

def application_id
  @application_id
end

.application_secret ⇒ Object

Returns the value of attribute application_secret.



164
165
166
 
# File 'lib/people_doc.rb', line 164

def application_secret
  @application_secret
end

.base_url ⇒ Object

Returns the value of attribute base_url.



164
165
166
 
# File 'lib/people_doc.rb', line 164

def base_url
  @base_url
end

.client_id ⇒ Object

Returns the value of attribute client_id.



164
165
166
 
# File 'lib/people_doc.rb', line 164

def client_id
  @client_id
end

.logger ⇒ Object

Returns the value of attribute logger.



164
165
166
 
# File 'lib/people_doc.rb', line 164

def logger
  @logger
end

Class Method Details

.configure {|_self| ... } ⇒ Object

Configures default PeopleDoc REST APIv1 settings.

Examples:

configuring the client defaults

PeopleDoc::V2.configure do |config|
  config.application_id = 'application_id'
  config.application_secret = 'application_secret'
  config.base_url = 'https://apis.staging.us.people-doc.com'
  config.client_id = 'client_id'
  config.logger = Logger.new(STDOUT)
end

using the client

client = PeopleDoc::V2::Client.new

Yields:

  • (_self)

Yield Parameters:

  • _self (PeopleDoc::V2) —

    the object that the method was called on



184
185
186
187
 
# File 'lib/people_doc.rb', line 184

def configure
  yield self
  true
end