Module: Truework

Defined in:
lib/truework.rb,
lib/truework/types.rb,
lib/truework/version.rb,
lib/truework/exceptions.rb,
lib/truework/environment.rb,
lib/truework/api_resource.rb,
lib/truework/api_response.rb,
lib/truework/http_request.rb,
lib/truework/list_response.rb,
lib/truework/resources/price.rb,
lib/truework/resources/report.rb,
lib/truework/resources/salary.rb,
lib/truework/resources/target.rb,
lib/truework/resources/address.rb,
lib/truework/resources/company.rb,
lib/truework/resources/document.rb,
lib/truework/resources/earnings.rb,
lib/truework/resources/employee.rb,
lib/truework/resources/employer.rb,
lib/truework/resources/position.rb,
lib/truework/api_operations/list.rb,
lib/truework/api_operations/cancel.rb,
lib/truework/api_operations/create.rb,
lib/truework/api_operations/retrieve.rb,
lib/truework/resources/turnaround_time.rb,
lib/truework/resources/verification_request.rb

Defined Under Namespace

Modules: APIOperations, Environment, HTTPRequest, Types Classes: APIResource, APIResponse, Address, BadGateway, BadRequest, ClientException, Company, Document, Earnings, Employee, Employer, Forbidden, GatewayTimeout, InternalServerError, InvalidCredentials, ListResponse, NonExistentRecord, Position, Price, RecordAlreadyExists, Report, Salary, ServerException, ServiceUnavailable, Target, TurnaroundTime, UnexpectedHTTPException, VerificationRequest

Constant Summary collapse

PRODUCTION_URL = 
'https://api.truework.com'
SANDBOX_URL = 
'https://api.truework-sandbox.com'
VERSION = 
'2.0.0'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.api_base ⇒ Object (readonly)

Returns the value of attribute api_base.



22
23
24
 
# File 'lib/truework.rb', line 22

def api_base
  @api_base
end

.api_key ⇒ Object (readonly)

Returns the value of attribute api_key.



23
24
25
 
# File 'lib/truework.rb', line 23

def api_key
  @api_key
end

.api_version ⇒ Object (readonly)

Returns the value of attribute api_version.



24
25
26
 
# File 'lib/truework.rb', line 24

def api_version
  @api_version
end

Class Method Details

.configure(api_key, api_version: nil, environment: nil, api_base: nil) ⇒ Object 



26
27
28
29
30
 
# File 'lib/truework.rb', line 26

def configure(api_key, api_version: nil, environment: nil, api_base: nil)
  @api_key = api_key
  @api_version = api_version
  @api_base = get_api_base(api_base, environment)
end