Class: TripletexApi::TimesheettimeClockApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TimesheettimeClockApi

Returns a new instance of TimesheettimeClockApi.



19
20
21
 
# File 'lib/tripletex_api/api/timesheettime_clock_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/timesheettime_clock_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

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

Find time clock entry 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/timesheettime_clock_api.rb', line 29

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

#get_present(opts = {}) ⇒ ResponseWrapperTimeClock

Find a user’s present running time clock.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :employee_id (Integer) —

    Employee ID. Defaults to ID of token owner.

  • :fields (String) —

    Fields filter pattern

Returns:



83
84
85
86
 
# File 'lib/tripletex_api/api/timesheettime_clock_api.rb', line 83

def get_present(opts = {})
  data, _status_code, _headers = get_present_with_http_info(opts)
  return data
end

#get_present_with_http_info(opts = {}) ⇒ Array<(ResponseWrapperTimeClock, Fixnum, Hash)>

Find a user’s present running time clock.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :employee_id (Integer) —

    Employee ID. Defaults to ID of token owner.

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ResponseWrapperTimeClock data, response status code and response headers



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
125
126
 
# File 'lib/tripletex_api/api/timesheettime_clock_api.rb', line 94

def get_present_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TimesheettimeClockApi.get_present ..."
  end
  # resource path
  local_var_path = "/timesheet/timeClock/present"

  # query parameters
  query_params = {}
  query_params[:'employeeId'] = opts[:'employee_id'] if !opts[:'employee_id'].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 => 'ResponseWrapperTimeClock')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TimesheettimeClockApi#get_present\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Find time clock entry by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ResponseWrapperTimeClock 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/timesheettime_clock_api.rb', line 40

def get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TimesheettimeClockApi.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 TimesheettimeClockApi.get"
  end
  # resource path
  local_var_path = "/timesheet/timeClock/{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 => 'ResponseWrapperTimeClock')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TimesheettimeClockApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update time clock by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :body (TimeClock) —

    Partial object describing what should be updated

Returns:



134
135
136
137
 
# File 'lib/tripletex_api/api/timesheettime_clock_api.rb', line 134

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

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

Update time clock by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :body (TimeClock) —

    Partial object describing what should be updated

Returns:

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

    ResponseWrapperTimeClock data, response status code and response headers



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
174
175
176
177
178
179
180
181
 
# File 'lib/tripletex_api/api/timesheettime_clock_api.rb', line 145

def put_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TimesheettimeClockApi.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 TimesheettimeClockApi.put"
  end
  # resource path
  local_var_path = "/timesheet/timeClock/{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 => 'ResponseWrapperTimeClock')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TimesheettimeClockApi#put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search(opts = {}) ⇒ ListResponseTimeClock

Find time clock entries corresponding with sent data.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    List of IDs

  • :employee_id (String) —

    List of IDs

  • :project_id (String) —

    List of IDs

  • :activity_id (String) —

    List of IDs

  • :date_from (String) —

    From and including

  • :date_to (String) —

    To and excluding

  • :hour_id (String) —

    List of IDs

  • :is_running (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:



199
200
201
202
 
# File 'lib/tripletex_api/api/timesheettime_clock_api.rb', line 199

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

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

Find time clock entries corresponding with sent data.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    List of IDs

  • :employee_id (String) —

    List of IDs

  • :project_id (String) —

    List of IDs

  • :activity_id (String) —

    List of IDs

  • :date_from (String) —

    From and including

  • :date_to (String) —

    To and excluding

  • :hour_id (String) —

    List of IDs

  • :is_running (BOOLEAN) —

    Equals

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ListResponseTimeClock data, response status code and response headers



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/tripletex_api/api/timesheettime_clock_api.rb', line 220

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

  # query parameters
  query_params = {}
  query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
  query_params[:'employeeId'] = opts[:'employee_id'] if !opts[:'employee_id'].nil?
  query_params[:'projectId'] = opts[:'project_id'] if !opts[:'project_id'].nil?
  query_params[:'activityId'] = opts[:'activity_id'] if !opts[:'activity_id'].nil?
  query_params[:'dateFrom'] = opts[:'date_from'] if !opts[:'date_from'].nil?
  query_params[:'dateTo'] = opts[:'date_to'] if !opts[:'date_to'].nil?
  query_params[:'hourId'] = opts[:'hour_id'] if !opts[:'hour_id'].nil?
  query_params[:'isRunning'] = opts[:'is_running'] if !opts[:'is_running'].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 => 'ListResponseTimeClock')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TimesheettimeClockApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#start(activity_id, opts = {}) ⇒ ResponseWrapperTimeClock

Start time clock.

Parameters:

  • activity_id —

    Activity ID

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

    the optional parameters

Options Hash (opts):

  • :employee_id (Integer) —

    Employee ID. Defaults to ID of token owner.

  • :project_id (Integer) —

    Project ID (default to 0)

  • :date (String) —

    Optional. Default is today’s date

Returns:



272
273
274
275
 
# File 'lib/tripletex_api/api/timesheettime_clock_api.rb', line 272

def start(activity_id, opts = {})
  data, _status_code, _headers = start_with_http_info(activity_id, opts)
  return data
end

#start_with_http_info(activity_id, opts = {}) ⇒ Array<(ResponseWrapperTimeClock, Fixnum, Hash)>

Start time clock.

Parameters:

  • activity_id —

    Activity ID

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

    the optional parameters

Options Hash (opts):

  • :employee_id (Integer) —

    Employee ID. Defaults to ID of token owner.

  • :project_id (Integer) —

    Project ID

  • :date (String) —

    Optional. Default is today’s date

Returns:

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

    ResponseWrapperTimeClock data, response status code and response headers



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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/tripletex_api/api/timesheettime_clock_api.rb', line 285

def start_with_http_info(activity_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TimesheettimeClockApi.start ..."
  end
  # verify the required parameter 'activity_id' is set
  if @api_client.config.client_side_validation && activity_id.nil?
    fail ArgumentError, "Missing the required parameter 'activity_id' when calling TimesheettimeClockApi.start"
  end
  # resource path
  local_var_path = "/timesheet/timeClock/:start"

  # query parameters
  query_params = {}
  query_params[:'activityId'] = activity_id
  query_params[:'employeeId'] = opts[:'employee_id'] if !opts[:'employee_id'].nil?
  query_params[:'projectId'] = opts[:'project_id'] if !opts[:'project_id'].nil?
  query_params[:'date'] = opts[:'date'] if !opts[:'date'].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(: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 => 'ResponseWrapperTimeClock')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TimesheettimeClockApi#start\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#stop(id, opts = {}) ⇒ nil

Stop time clock.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :version (Integer) —

    Number of current version (default to 0)

Returns:

  • (nil) 


331
332
333
334
 
# File 'lib/tripletex_api/api/timesheettime_clock_api.rb', line 331

def stop(id, opts = {})
  stop_with_http_info(id, opts)
  return nil
end

#stop_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Stop time clock.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :version (Integer) —

    Number of current version

Returns:

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

    nil, response status code and response headers



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/tripletex_api/api/timesheettime_clock_api.rb', line 342

def stop_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TimesheettimeClockApi.stop ..."
  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 TimesheettimeClockApi.stop"
  end
  # resource path
  local_var_path = "/timesheet/timeClock/{id}/:stop".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'version'] = opts[:'version'] if !opts[:'version'].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(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TimesheettimeClockApi#stop\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end