Class: Square::EmployeesApi

Inherits:
BaseApi
  • Object
show all
Defined in:
lib/square/api/employees_api.rb

Overview

EmployeesApi

Instance Attribute Summary

Attributes inherited from BaseApi

#config, #http_call_back

Instance Method Summary collapse

Methods inherited from BaseApi

#execute_request, #get_user_agent, #validate_parameters

Constructor Details

#initialize(config, http_call_back: nil) ⇒ EmployeesApi

Returns a new instance of EmployeesApi.



4
5
6
 
# File 'lib/square/api/employees_api.rb', line 4

def initialize(config, http_call_back: nil)
  super(config, http_call_back: http_call_back)
end

Instance Method Details

#list_employees(location_id: nil, status: nil, limit: nil, cursor: nil) ⇒ ListEmployeesResponse Hash

ListEmployees EmployeeStatus to filter the employee by. returned on each page. the specified page of results.

Parameters:

  • location_id (String) (defaults to: nil) —

    Optional parameter: Example:

  • status (EmployeeStatus) (defaults to: nil) —

    Optional parameter: Specifies the

  • limit (Integer) (defaults to: nil) —

    Optional parameter: The number of employees to be

  • cursor (String) (defaults to: nil) —

    Optional parameter: The token required to retrieve

Returns:

  • (ListEmployeesResponse Hash) —

    response from the API call



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/square/api/employees_api.rb', line 17

def list_employees(location_id: nil,
                   status: nil,
                   limit: nil,
                   cursor: nil)
  warn 'Endpoint list_employees in EmployeesApi is deprecated'
  # Prepare query url.
  _query_builder = config.get_base_uri
  _query_builder << '/v2/employees'
  _query_builder = APIHelper.append_url_with_query_parameters(
    _query_builder,
    'location_id' => location_id,
    'status' => status,
    'limit' => limit,
    'cursor' => cursor
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'accept' => 'application/json'
  }

  # Prepare and execute HttpRequest.
  _request = config.http_client.get(
    _query_url,
    headers: _headers
  )
  OAuth2.apply(config, _request)
  _response = execute_request(_request)

  # Return appropriate response type.
  decoded = APIHelper.json_deserialize(_response.raw_body)
  _errors = APIHelper.map_response(decoded, ['errors'])
  ApiResponse.new(
    _response, data: decoded, errors: _errors
  )
end

#retrieve_employee(id:) ⇒ RetrieveEmployeeResponse Hash

RetrieveEmployee requested.

Parameters:

  • id (String) —

    Required parameter: UUID for the employee that was

Returns:

  • (RetrieveEmployeeResponse Hash) —

    response from the API call



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/square/api/employees_api.rb', line 59

def retrieve_employee(id:)
  warn 'Endpoint retrieve_employee in EmployeesApi is deprecated'
  # Prepare query url.
  _query_builder = config.get_base_uri
  _query_builder << '/v2/employees/{id}'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'id' => { 'value' => id, 'encode' => true }
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'accept' => 'application/json'
  }

  # Prepare and execute HttpRequest.
  _request = config.http_client.get(
    _query_url,
    headers: _headers
  )
  OAuth2.apply(config, _request)
  _response = execute_request(_request)

  # Return appropriate response type.
  decoded = APIHelper.json_deserialize(_response.raw_body)
  _errors = APIHelper.map_response(decoded, ['errors'])
  ApiResponse.new(
    _response, data: decoded, errors: _errors
  )
end