Class: KoronaClient::TimeTrackingApi

Inherits:
Object
  • Object
show all
Defined in:
lib/korona_client/api/time_tracking_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TimeTrackingApi

Returns a new instance of TimeTrackingApi.



19
20
21
 
# File 'lib/korona_client/api/time_tracking_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/korona_client/api/time_tracking_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_entities(korona_account_id, body, opts = {}) ⇒ Array<AddOrUpdateResult>

adds a batch of new time tracking entities

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    array of new time tracking entities

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

    the optional parameters

Options Hash (opts):

  • :upsert (BOOLEAN) —

    when set to true, updates the object instead of generating a already-exists-error

Returns:



29
30
31
32
 
# File 'lib/korona_client/api/time_tracking_api.rb', line 29

def add_entities(, body, opts = {})
  data, _status_code, _headers = add_entities_with_http_info(, body, opts)
  data
end

#add_entities_with_http_info(korona_account_id, body, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Fixnum, Hash)>

adds a batch of new time tracking entities

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    array of new time tracking entities

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

    the optional parameters

Options Hash (opts):

  • :upsert (BOOLEAN) —

    when set to true, updates the object instead of generating a already-exists-error

Returns:

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

    Array<AddOrUpdateResult> 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
82
83
84
 
# File 'lib/korona_client/api/time_tracking_api.rb', line 41

def add_entities_with_http_info(, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TimeTrackingApi.add_entities ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TimeTrackingApi.add_entities"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TimeTrackingApi.add_entities"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/timeTrackingEntities'.sub('{' + 'koronaAccountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'upsert'] = opts[:'upsert'] if !opts[:'upsert'].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'])

  # form parameters
  form_params = {}

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

#add_entries(korona_account_id, body, opts = {}) ⇒ Array<AddOrUpdateResult>

adds a batch of new time tracking entries

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    array of new time tracking entries

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

    the optional parameters

Options Hash (opts):

  • :upsert (BOOLEAN) —

    when set to true, updates the object instead of generating a already-exists-error

Returns:



92
93
94
95
 
# File 'lib/korona_client/api/time_tracking_api.rb', line 92

def add_entries(, body, opts = {})
  data, _status_code, _headers = add_entries_with_http_info(, body, opts)
  data
end

#add_entries_with_http_info(korona_account_id, body, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Fixnum, Hash)>

adds a batch of new time tracking entries

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    array of new time tracking entries

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

    the optional parameters

Options Hash (opts):

  • :upsert (BOOLEAN) —

    when set to true, updates the object instead of generating a already-exists-error

Returns:

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

    Array<AddOrUpdateResult> data, response status code and response headers



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
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/korona_client/api/time_tracking_api.rb', line 104

def add_entries_with_http_info(, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TimeTrackingApi.add_entries ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TimeTrackingApi.add_entries"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TimeTrackingApi.add_entries"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/timeTrackingEntries'.sub('{' + 'koronaAccountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'upsert'] = opts[:'upsert'] if !opts[:'upsert'].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'])

  # form parameters
  form_params = {}

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

#get_entities(korona_account_id, opts = {}) ⇒ ResultListTimeTrackingEntity

lists time tracking entities

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    number of the page to fetch

  • :size (Integer) —

    amount of objects to return per page

  • :sort (String) —

    attribute to sort by (multiple separated by comma; max. 5)

  • :revision (Integer) —

    last revision number, objects with a greater revision than this will be returned

  • :include_deleted (BOOLEAN) —

    indicates deleted objects should be loaded or not (default: false)

  • :number (String) —

    number of the related object

Returns:



159
160
161
162
 
# File 'lib/korona_client/api/time_tracking_api.rb', line 159

def get_entities(, opts = {})
  data, _status_code, _headers = get_entities_with_http_info(, opts)
  data
end

#get_entities_with_http_info(korona_account_id, opts = {}) ⇒ Array<(ResultListTimeTrackingEntity, Fixnum, Hash)>

lists time tracking entities

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    number of the page to fetch

  • :size (Integer) —

    amount of objects to return per page

  • :sort (String) —

    attribute to sort by (multiple separated by comma; max. 5)

  • :revision (Integer) —

    last revision number, objects with a greater revision than this will be returned

  • :include_deleted (BOOLEAN) —

    indicates deleted objects should be loaded or not (default: false)

  • :number (String) —

    number of the related object

Returns:



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
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
 
# File 'lib/korona_client/api/time_tracking_api.rb', line 175

def get_entities_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TimeTrackingApi.get_entities ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TimeTrackingApi.get_entities"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/timeTrackingEntities'.sub('{' + 'koronaAccountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'revision'] = opts[:'revision'] if !opts[:'revision'].nil?
  query_params[:'includeDeleted'] = opts[:'include_deleted'] if !opts[:'include_deleted'].nil?
  query_params[:'number'] = opts[:'number'] if !opts[:'number'].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'])

  # form parameters
  form_params = {}

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

#get_entries(korona_account_id, opts = {}) ⇒ ResultListTimeTrackingEntry

lists time tracking entries

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    number of the page to fetch

  • :size (Integer) —

    amount of objects to return per page

  • :sort (String) —

    attribute to sort by (multiple separated by comma; max. 5)

  • :revision (Integer) —

    last revision number, objects with a greater revision than this will be returned

  • :time_tracking_entity (String) —

    time tracking entity id to filter by

  • :cashier (String) —

    cashier id to filter by

  • :organizational_unit (String) —

    organizational unit

  • :min_timestamp (DateTime) —

    min (inclusive) timestamp (ISO 8601; date, time and timezone)

  • :max_timestamp (DateTime) —

    max (inclusive) timestamp (ISO 8601; date, time and timezone)

  • :include_deleted (BOOLEAN) —

    indicates deleted objects should be loaded or not (default: false)

Returns:



235
236
237
238
 
# File 'lib/korona_client/api/time_tracking_api.rb', line 235

def get_entries(, opts = {})
  data, _status_code, _headers = get_entries_with_http_info(, opts)
  data
end

#get_entries_with_http_info(korona_account_id, opts = {}) ⇒ Array<(ResultListTimeTrackingEntry, Fixnum, Hash)>

lists time tracking entries

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    number of the page to fetch

  • :size (Integer) —

    amount of objects to return per page

  • :sort (String) —

    attribute to sort by (multiple separated by comma; max. 5)

  • :revision (Integer) —

    last revision number, objects with a greater revision than this will be returned

  • :time_tracking_entity (String) —

    time tracking entity id to filter by

  • :cashier (String) —

    cashier id to filter by

  • :organizational_unit (String) —

    organizational unit

  • :min_timestamp (DateTime) —

    min (inclusive) timestamp (ISO 8601; date, time and timezone)

  • :max_timestamp (DateTime) —

    max (inclusive) timestamp (ISO 8601; date, time and timezone)

  • :include_deleted (BOOLEAN) —

    indicates deleted objects should be loaded or not (default: false)

Returns:



255
256
257
258
259
260
261
262
263
264
265
266
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
 
# File 'lib/korona_client/api/time_tracking_api.rb', line 255

def get_entries_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TimeTrackingApi.get_entries ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TimeTrackingApi.get_entries"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/timeTrackingEntries'.sub('{' + 'koronaAccountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'revision'] = opts[:'revision'] if !opts[:'revision'].nil?
  query_params[:'timeTrackingEntity'] = opts[:'time_tracking_entity'] if !opts[:'time_tracking_entity'].nil?
  query_params[:'cashier'] = opts[:'cashier'] if !opts[:'cashier'].nil?
  query_params[:'organizationalUnit'] = opts[:'organizational_unit'] if !opts[:'organizational_unit'].nil?
  query_params[:'minTimestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil?
  query_params[:'maxTimestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil?
  query_params[:'includeDeleted'] = opts[:'include_deleted'] if !opts[:'include_deleted'].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'])

  # form parameters
  form_params = {}

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

#get_time_tracking_entity(korona_account_id, time_tracking_entity_id, opts = {}) ⇒ TimeTrackingEntity

returns a single time tracking entity

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • time_tracking_entity_id —

    id of the related object (important: id should match the uuid-format)

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

    the optional parameters

Returns:



310
311
312
313
 
# File 'lib/korona_client/api/time_tracking_api.rb', line 310

def get_time_tracking_entity(, time_tracking_entity_id, opts = {})
  data, _status_code, _headers = get_time_tracking_entity_with_http_info(, time_tracking_entity_id, opts)
  data
end

#get_time_tracking_entity_with_http_info(korona_account_id, time_tracking_entity_id, opts = {}) ⇒ Array<(TimeTrackingEntity, Fixnum, Hash)>

returns a single time tracking entity

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • time_tracking_entity_id —

    id of the related object (important: id should match the uuid-format)

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

    the optional parameters

Returns:

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

    TimeTrackingEntity data, response status code and response headers



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/korona_client/api/time_tracking_api.rb', line 321

def get_time_tracking_entity_with_http_info(, time_tracking_entity_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TimeTrackingApi.get_time_tracking_entity ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TimeTrackingApi.get_time_tracking_entity"
  end
  # verify the required parameter 'time_tracking_entity_id' is set
  if @api_client.config.client_side_validation && time_tracking_entity_id.nil?
    fail ArgumentError, "Missing the required parameter 'time_tracking_entity_id' when calling TimeTrackingApi.get_time_tracking_entity"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/timeTrackingEntities/{timeTrackingEntityId}'.sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'timeTrackingEntityId' + '}', time_tracking_entity_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'])

  # form parameters
  form_params = {}

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

#get_time_tracking_entry(korona_account_id, time_tracking_entry_id, opts = {}) ⇒ TimeTrackingEntry

returns a single time tracking entry

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • time_tracking_entry_id —

    id of the related object (important: id should match the uuid-format)

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

    the optional parameters

Returns:



370
371
372
373
 
# File 'lib/korona_client/api/time_tracking_api.rb', line 370

def get_time_tracking_entry(, time_tracking_entry_id, opts = {})
  data, _status_code, _headers = get_time_tracking_entry_with_http_info(, time_tracking_entry_id, opts)
  data
end

#get_time_tracking_entry_with_http_info(korona_account_id, time_tracking_entry_id, opts = {}) ⇒ Array<(TimeTrackingEntry, Fixnum, Hash)>

returns a single time tracking entry

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • time_tracking_entry_id —

    id of the related object (important: id should match the uuid-format)

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

    the optional parameters

Returns:

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

    TimeTrackingEntry data, response status code and response headers



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/korona_client/api/time_tracking_api.rb', line 381

def get_time_tracking_entry_with_http_info(, time_tracking_entry_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TimeTrackingApi.get_time_tracking_entry ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TimeTrackingApi.get_time_tracking_entry"
  end
  # verify the required parameter 'time_tracking_entry_id' is set
  if @api_client.config.client_side_validation && time_tracking_entry_id.nil?
    fail ArgumentError, "Missing the required parameter 'time_tracking_entry_id' when calling TimeTrackingApi.get_time_tracking_entry"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/timeTrackingEntries/{timeTrackingEntryId}'.sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'timeTrackingEntryId' + '}', time_tracking_entry_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'])

  # form parameters
  form_params = {}

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