Class: SquareConnect::EmployeesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EmployeesApi

Returns a new instance of EmployeesApi.



16
17
18
 
# File 'lib/square_connect/api/employees_api.rb', line 16

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/square_connect/api/employees_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#list_employees(opts = {}) ⇒ ListEmployeesResponse

ListEmployees Gets a list of ‘Employee` objects for a business.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :location_id (String) —

    Filter employees returned to only those that are associated with the specified location.

  • :status (String) —

    Specifies the EmployeeStatus to filter the employee by.

  • :limit (Integer) —

    The number of employees to be returned on each page.

  • :cursor (String) —

    The token required to retrieve the specified page of results.

Returns:



28
29
30
31
 
# File 'lib/square_connect/api/employees_api.rb', line 28

def list_employees(opts = {})
  data, _status_code, _headers = list_employees_with_http_info(opts)
  return data
end

#list_employees_with_http_info(opts = {}) ⇒ Array<(ListEmployeesResponse, Fixnum, Hash)>

ListEmployees Gets a list of &#x60;Employee&#x60; objects for a business.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :location_id (String) —

    Filter employees returned to only those that are associated with the specified location.

  • :status (String) —

    Specifies the EmployeeStatus to filter the employee by.

  • :limit (Integer) —

    The number of employees to be returned on each page.

  • :cursor (String) —

    The token required to retrieve the specified page of results.

Returns:

  • (Array<(ListEmployeesResponse, Fixnum, Hash)>) —

    ListEmployeesResponse data, response status code and response headers



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/square_connect/api/employees_api.rb', line 41

def list_employees_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EmployeesApi.list_employees ..."
  end
  # resource path
  local_var_path = "/v2/employees".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'location_id'] = opts[:'location_id'] if !opts[:'location_id'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  
  header_params['Square-Version'] = "2019-06-12"

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ListEmployeesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmployeesApi#list_employees\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#retrieve_employee(id, opts = {}) ⇒ RetrieveEmployeeResponse

RetrieveEmployee Gets an ‘Employee` by Square-assigned employee `ID` (UUID)

Parameters:

  • id —

    UUID for the employee that was requested.

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

    the optional parameters

Returns:



88
89
90
91
 
# File 'lib/square_connect/api/employees_api.rb', line 88

def retrieve_employee(id, opts = {})
  data, _status_code, _headers = retrieve_employee_with_http_info(id, opts)
  return data
end

#retrieve_employee_with_http_info(id, opts = {}) ⇒ Array<(RetrieveEmployeeResponse, Fixnum, Hash)>

RetrieveEmployee Gets an &#x60;Employee&#x60; by Square-assigned employee &#x60;ID&#x60; (UUID)

Parameters:

  • id —

    UUID for the employee that was requested.

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

    the optional parameters

Returns:

  • (Array<(RetrieveEmployeeResponse, Fixnum, Hash)>) —

    RetrieveEmployeeResponse data, response status code and response headers



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/square_connect/api/employees_api.rb', line 98

def retrieve_employee_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EmployeesApi.retrieve_employee ..."
  end
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling EmployeesApi.retrieve_employee" if id.nil?
  # resource path
  local_var_path = "/v2/employees/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  
  header_params['Square-Version'] = "2019-06-12"

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RetrieveEmployeeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmployeesApi#retrieve_employee\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end