Module: PaylocityWebService::Connection

Includes:
Authentication
Included in:
Client
Defined in:
lib/paylocity_web_service/connection.rb

Overview

Network layer for API clients.

Instance Method Summary collapse

Methods included from Authentication

#access_token, #access_token_cache_key, #basic_auth_token, #cache_store, #refresh_token

Instance Method Details

#delete(url, options = {}) ⇒ Sawyer::Resource

Make a HTTP DELETE request

Parameters:

  • url (String) —

    The path, relative to #api_endpoint

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

    Query and header params for request

Returns:

  • (Sawyer::Resource) 


53
54
55
 
# File 'lib/paylocity_web_service/connection.rb', line 53

def delete(url, options = {})
  request :delete, url, options
end

#get(url) ⇒ Sawyer::Resource

Make a HTTP GET request

Parameters:

  • url (String) —

    The path, relative to #api_endpoint

Returns:

  • (Sawyer::Resource) 


17
18
19
 
# File 'lib/paylocity_web_service/connection.rb', line 17

def get(url)
  request :get, url
end

#head(url, options = {}) ⇒ Sawyer::Resource

Make a HTTP HEAD request

Parameters:

  • url (String) —

    The path, relative to #api_endpoint

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

    Query and header params for request

Returns:

  • (Sawyer::Resource) 


62
63
64
 
# File 'lib/paylocity_web_service/connection.rb', line 62

def head(url, options = {})
  request :head, url, options
end

#patch(url, options = {}) ⇒ Sawyer::Resource

Make a HTTP PATCH request

Parameters:

  • url (String) —

    The path, relative to #api_endpoint

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

    Body and header params for request

Returns:

  • (Sawyer::Resource) 


44
45
46
 
# File 'lib/paylocity_web_service/connection.rb', line 44

def patch(url, options = {})
  request :patch, url, options
end

#post(url, options = {}) ⇒ Sawyer::Resource

Make a HTTP POST request

Parameters:

  • url (String) —

    The path, relative to #api_endpoint

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

    Body and header params for request

Returns:

  • (Sawyer::Resource) 


26
27
28
 
# File 'lib/paylocity_web_service/connection.rb', line 26

def post(url, options = {})
  request :post, url, options
end

#put(url, options = {}) ⇒ Sawyer::Resource

Make a HTTP PUT request

Parameters:

  • url (String) —

    The path, relative to #api_endpoint

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

    Body and header params for request

Returns:

  • (Sawyer::Resource) 


35
36
37
 
# File 'lib/paylocity_web_service/connection.rb', line 35

def put(url, options = {})
  request :put, url, options
end