Class: TripletexApi::EmployeeApi

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_api/api/employee_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EmployeeApi

Returns a new instance of EmployeeApi.



19
20
21
 
# File 'lib/tripletex_api/api/employee_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/tripletex_api/api/employee_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get(id, opts = {}) ⇒ ResponseWrapperEmployee

Get employee by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:



29
30
31
32
 
# File 'lib/tripletex_api/api/employee_api.rb', line 29

def get(id, opts = {})
  data, _status_code, _headers = get_with_http_info(id, opts)
  return data
end

#get_with_http_info(id, opts = {}) ⇒ Array<(ResponseWrapperEmployee, Fixnum, Hash)>

Get employee by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ResponseWrapperEmployee data, response status code and response headers



40
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
 
# File 'lib/tripletex_api/api/employee_api.rb', line 40

def get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EmployeeApi.get ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling EmployeeApi.get"
  end
  # resource path
  local_var_path = "/employee/{id}".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  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 => 'ResponseWrapperEmployee')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmployeeApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post(opts = {}) ⇒ ResponseWrapperEmployee

BETA

Create one employee.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Employee) —

    JSON representing the new object to be created. Should not have ID and version set.

Returns:



82
83
84
85
 
# File 'lib/tripletex_api/api/employee_api.rb', line 82

def post(opts = {})
  data, _status_code, _headers = post_with_http_info(opts)
  return data
end

#post_list(opts = {}) ⇒ ListResponseEmployee

BETA

Create several employees.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Array<Employee>) —

    JSON representing a list of new object to be created. Should not have ID and version set.

Returns:



131
132
133
134
 
# File 'lib/tripletex_api/api/employee_api.rb', line 131

def post_list(opts = {})
  data, _status_code, _headers = post_list_with_http_info(opts)
  return data
end

#post_list_with_http_info(opts = {}) ⇒ Array<(ListResponseEmployee, Fixnum, Hash)>

BETA

Create several employees.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Array<Employee>) —

    JSON representing a list of new object to be created. Should not have ID and version set.

Returns:

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

    ListResponseEmployee data, response status code and response headers



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/tripletex_api/api/employee_api.rb', line 141

def post_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EmployeeApi.post_list ..."
  end
  # resource path
  local_var_path = "/employee/list"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['tokenAuthScheme']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ListResponseEmployee')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmployeeApi#post_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_with_http_info(opts = {}) ⇒ Array<(ResponseWrapperEmployee, Fixnum, Hash)>

BETA

Create one employee.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Employee) —

    JSON representing the new object to be created. Should not have ID and version set.

Returns:

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

    ResponseWrapperEmployee data, response status code and response headers



92
93
94
95
96
97
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
 
# File 'lib/tripletex_api/api/employee_api.rb', line 92

def post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EmployeeApi.post ..."
  end
  # resource path
  local_var_path = "/employee"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['tokenAuthScheme']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResponseWrapperEmployee')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmployeeApi#post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put(id, opts = {}) ⇒ ResponseWrapperEmployee

Update employee.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :body (Employee) —

    Partial object describing what should be updated

Returns:



181
182
183
184
 
# File 'lib/tripletex_api/api/employee_api.rb', line 181

def put(id, opts = {})
  data, _status_code, _headers = put_with_http_info(id, opts)
  return data
end

#put_with_http_info(id, opts = {}) ⇒ Array<(ResponseWrapperEmployee, Fixnum, Hash)>

Update employee.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :body (Employee) —

    Partial object describing what should be updated

Returns:

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

    ResponseWrapperEmployee data, response status code and response headers



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/tripletex_api/api/employee_api.rb', line 192

def put_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EmployeeApi.put ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling EmployeeApi.put"
  end
  # resource path
  local_var_path = "/employee/{id}".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['tokenAuthScheme']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResponseWrapperEmployee')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmployeeApi#put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search(opts = {}) ⇒ ListResponseEmployee

Find employees corresponding with sent data.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    List of IDs

  • :first_name (String) —

    Containing

  • :last_name (String) —

    Containing

  • :employee_number (String) —

    Containing

  • :allow_information_registration (BOOLEAN) —

    Equals

  • :include_contacts (BOOLEAN) —

    Equals (default to false)

  • :department_id (String) —

    List of IDs

  • :only_project_managers (BOOLEAN) —

    Equals

  • :from (Integer) —

    From index (default to 0)

  • :count (Integer) —

    Number of elements to return (default to 1000)

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



246
247
248
249
 
# File 'lib/tripletex_api/api/employee_api.rb', line 246

def search(opts = {})
  data, _status_code, _headers = search_with_http_info(opts)
  return data
end

#search_with_http_info(opts = {}) ⇒ Array<(ListResponseEmployee, Fixnum, Hash)>

Find employees corresponding with sent data.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    List of IDs

  • :first_name (String) —

    Containing

  • :last_name (String) —

    Containing

  • :employee_number (String) —

    Containing

  • :allow_information_registration (BOOLEAN) —

    Equals

  • :include_contacts (BOOLEAN) —

    Equals

  • :department_id (String) —

    List of IDs

  • :only_project_managers (BOOLEAN) —

    Equals

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ListResponseEmployee data, response status code and response headers



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/tripletex_api/api/employee_api.rb', line 267

def search_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EmployeeApi.search ..."
  end
  # resource path
  local_var_path = "/employee"

  # query parameters
  query_params = {}
  query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
  query_params[:'firstName'] = opts[:'first_name'] if !opts[:'first_name'].nil?
  query_params[:'lastName'] = opts[:'last_name'] if !opts[:'last_name'].nil?
  query_params[:'employeeNumber'] = opts[:'employee_number'] if !opts[:'employee_number'].nil?
  query_params[:'allowInformationRegistration'] = opts[:'allow_information_registration'] if !opts[:'allow_information_registration'].nil?
  query_params[:'includeContacts'] = opts[:'include_contacts'] if !opts[:'include_contacts'].nil?
  query_params[:'departmentId'] = opts[:'department_id'] if !opts[:'department_id'].nil?
  query_params[:'onlyProjectManagers'] = opts[:'only_project_managers'] if !opts[:'only_project_managers'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'sorting'] = opts[:'sorting'] if !opts[:'sorting'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  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 => 'ListResponseEmployee')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmployeeApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end