Class: XeroRuby::ProjectApi

Inherits:
Object
  • Object
show all
Defined in:
lib/xero-ruby/api/project_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.new) ⇒ ProjectApi

Returns a new instance of ProjectApi.



16
17
18
 
# File 'lib/xero-ruby/api/project_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/xero-ruby/api/project_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#create_project(xero_tenant_id, project_create_or_update, opts = {}) ⇒ Project

Create one or more new projects

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • project_create_or_update (ProjectCreateOrUpdate) —

    Create a new project with ProjectCreateOrUpdate object

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

  • (Project) 


25
26
27
28
 
# File 'lib/xero-ruby/api/project_api.rb', line 25

def create_project(xero_tenant_id, project_create_or_update, opts = {})
  data, _status_code, _headers = create_project_with_http_info(xero_tenant_id, project_create_or_update, opts)
  data
end

#create_project_with_http_info(xero_tenant_id, project_create_or_update, options = {}) ⇒ Array<(Project, Integer, Hash)>

Create one or more new projects

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • project_create_or_update (ProjectCreateOrUpdate) —

    Create a new project with ProjectCreateOrUpdate object

  • opts (Hash) —

    the optional parameters

Returns:

  • (Array<(Project, Integer, Hash)>) —

    Project data, response status code and response headers



36
37
38
39
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/xero-ruby/api/project_api.rb', line 36

def create_project_with_http_info(xero_tenant_id, project_create_or_update, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProjectApi.create_project ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling ProjectApi.create_project"
  end
  # verify the required parameter 'project_create_or_update' is set
  if @api_client.config.client_side_validation && project_create_or_update.nil?
    fail ArgumentError, "Missing the required parameter 'project_create_or_update' when calling ProjectApi.create_project"
  end
  # resource path
  local_var_path = '/Projects'

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?

  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[: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[:'Xero-Tenant-Id'] = xero_tenant_id
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(project_create_or_update) 

  # return_type
  return_type = opts[:return_type] || 'Project' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, "ProjectApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProjectApi#create_project\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_task(xero_tenant_id, project_id, task_create_or_update, opts = {}) ⇒ Task

Allows you to create a task Allows you to create a specific task

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • project_id (String) —

    You can create a task on a specified projectId

  • task_create_or_update (TaskCreateOrUpdate) —

    The task object you are creating

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

  • (Task) 


107
108
109
110
 
# File 'lib/xero-ruby/api/project_api.rb', line 107

def create_task(xero_tenant_id, project_id, task_create_or_update, opts = {})
  data, _status_code, _headers = create_task_with_http_info(xero_tenant_id, project_id, task_create_or_update, opts)
  data
end

#create_task_with_http_info(xero_tenant_id, project_id, task_create_or_update, options = {}) ⇒ Array<(Task, Integer, Hash)>

Allows you to create a task Allows you to create a specific task

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • project_id (String) —

    You can create a task on a specified projectId

  • task_create_or_update (TaskCreateOrUpdate) —

    The task object you are creating

  • opts (Hash) —

    the optional parameters

Returns:

  • (Array<(Task, Integer, Hash)>) —

    Task data, response status code and response headers



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
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
182
183
184
185
 
# File 'lib/xero-ruby/api/project_api.rb', line 120

def create_task_with_http_info(xero_tenant_id, project_id, task_create_or_update, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProjectApi.create_task ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling ProjectApi.create_task"
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProjectApi.create_task"
  end
  # verify the required parameter 'task_create_or_update' is set
  if @api_client.config.client_side_validation && task_create_or_update.nil?
    fail ArgumentError, "Missing the required parameter 'task_create_or_update' when calling ProjectApi.create_task"
  end
  # resource path
  local_var_path = '/Projects/{projectId}/Tasks'.sub('{' + 'projectId' + '}', project_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?

  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[: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[:'Xero-Tenant-Id'] = xero_tenant_id
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(task_create_or_update) 

  # return_type
  return_type = opts[:return_type] || 'Task' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, "ProjectApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProjectApi#create_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_time_entry(xero_tenant_id, project_id, time_entry_create_or_update, opts = {}) ⇒ TimeEntry

Creates a time entry for a specific project Allows you to create a specific task

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • project_id (String) —

    You can specify an individual project by appending the projectId to the endpoint

  • time_entry_create_or_update (TimeEntryCreateOrUpdate) —

    The time entry object you are creating

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

  • (TimeEntry) 


195
196
197
198
 
# File 'lib/xero-ruby/api/project_api.rb', line 195

def create_time_entry(xero_tenant_id, project_id, time_entry_create_or_update, opts = {})
  data, _status_code, _headers = create_time_entry_with_http_info(xero_tenant_id, project_id, time_entry_create_or_update, opts)
  data
end

#create_time_entry_with_http_info(xero_tenant_id, project_id, time_entry_create_or_update, options = {}) ⇒ Array<(TimeEntry, Integer, Hash)>

Creates a time entry for a specific project Allows you to create a specific task

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • project_id (String) —

    You can specify an individual project by appending the projectId to the endpoint

  • time_entry_create_or_update (TimeEntryCreateOrUpdate) —

    The time entry object you are creating

  • opts (Hash) —

    the optional parameters

Returns:

  • (Array<(TimeEntry, Integer, Hash)>) —

    TimeEntry data, response status code and response headers



208
209
210
211
212
213
214
215
216
217
218
219
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
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/xero-ruby/api/project_api.rb', line 208

def create_time_entry_with_http_info(xero_tenant_id, project_id, time_entry_create_or_update, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProjectApi.create_time_entry ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling ProjectApi.create_time_entry"
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProjectApi.create_time_entry"
  end
  # verify the required parameter 'time_entry_create_or_update' is set
  if @api_client.config.client_side_validation && time_entry_create_or_update.nil?
    fail ArgumentError, "Missing the required parameter 'time_entry_create_or_update' when calling ProjectApi.create_time_entry"
  end
  # resource path
  local_var_path = '/Projects/{projectId}/Time'.sub('{' + 'projectId' + '}', project_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?

  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[: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[:'Xero-Tenant-Id'] = xero_tenant_id
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(time_entry_create_or_update) 

  # return_type
  return_type = opts[:return_type] || 'TimeEntry' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, "ProjectApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProjectApi#create_time_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_task(xero_tenant_id, project_id, task_id, opts = {}) ⇒ nil

Allows you to delete a task Allows you to delete a specific task

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • project_id (String) —

    You can specify an individual project by appending the projectId to the endpoint

  • task_id (String) —

    You can specify an individual task by appending the id to the endpoint

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

    the optional parameters

Returns:

  • (nil) 


282
283
284
285
 
# File 'lib/xero-ruby/api/project_api.rb', line 282

def delete_task(xero_tenant_id, project_id, task_id, opts = {})
  delete_task_with_http_info(xero_tenant_id, project_id, task_id, opts)
  nil
end

#delete_task_with_http_info(xero_tenant_id, project_id, task_id, options = {}) ⇒ Array<(nil, Integer, Hash)>

Allows you to delete a task Allows you to delete a specific task

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • project_id (String) —

    You can specify an individual project by appending the projectId to the endpoint

  • task_id (String) —

    You can specify an individual task by appending the id to the endpoint

  • opts (Hash) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
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
 
# File 'lib/xero-ruby/api/project_api.rb', line 294

def delete_task_with_http_info(xero_tenant_id, project_id, task_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProjectApi.delete_task ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling ProjectApi.delete_task"
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProjectApi.delete_task"
  end
  # verify the required parameter 'task_id' is set
  if @api_client.config.client_side_validation && task_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_id' when calling ProjectApi.delete_task"
  end
  # resource path
  local_var_path = '/Projects/{projectId}/Tasks/{taskId}'.sub('{' + 'projectId' + '}', project_id.to_s).sub('{' + 'taskId' + '}', task_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?

  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, "ProjectApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProjectApi#delete_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_time_entry(xero_tenant_id, project_id, time_entry_id, opts = {}) ⇒ nil

Deletes a time entry for a specific project Allows you to delete a specific time entry

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • project_id (String) —

    You can specify an individual project by appending the projectId to the endpoint

  • time_entry_id (String) —

    You can specify an individual task by appending the id to the endpoint

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

    the optional parameters

Returns:

  • (nil) 


365
366
367
368
 
# File 'lib/xero-ruby/api/project_api.rb', line 365

def delete_time_entry(xero_tenant_id, project_id, time_entry_id, opts = {})
  delete_time_entry_with_http_info(xero_tenant_id, project_id, time_entry_id, opts)
  nil
end

#delete_time_entry_with_http_info(xero_tenant_id, project_id, time_entry_id, options = {}) ⇒ Array<(nil, Integer, Hash)>

Deletes a time entry for a specific project Allows you to delete a specific time entry

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • project_id (String) —

    You can specify an individual project by appending the projectId to the endpoint

  • time_entry_id (String) —

    You can specify an individual task by appending the id to the endpoint

  • opts (Hash) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



377
378
379
380
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
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'lib/xero-ruby/api/project_api.rb', line 377

def delete_time_entry_with_http_info(xero_tenant_id, project_id, time_entry_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProjectApi.delete_time_entry ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling ProjectApi.delete_time_entry"
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProjectApi.delete_time_entry"
  end
  # verify the required parameter 'time_entry_id' is set
  if @api_client.config.client_side_validation && time_entry_id.nil?
    fail ArgumentError, "Missing the required parameter 'time_entry_id' when calling ProjectApi.delete_time_entry"
  end
  # resource path
  local_var_path = '/Projects/{projectId}/Time/{timeEntryId}'.sub('{' + 'projectId' + '}', project_id.to_s).sub('{' + 'timeEntryId' + '}', time_entry_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?

  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, "ProjectApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProjectApi#delete_time_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_project(xero_tenant_id, project_id, opts = {}) ⇒ Project

Retrieves a single project Allows you to retrieve a specific project using the projectId

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • project_id (String) —

    You can specify an individual project by appending the projectId to the endpoint

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

    the optional parameters

Returns:

  • (Project) 


447
448
449
450
 
# File 'lib/xero-ruby/api/project_api.rb', line 447

def get_project(xero_tenant_id, project_id, opts = {})
  data, _status_code, _headers = get_project_with_http_info(xero_tenant_id, project_id, opts)
  data
end

#get_project_users(xero_tenant_id, opts = {}) ⇒ ProjectUsers

Retrieves a list of all project users Allows you to retrieve the users on a projects.

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. (default to 1)

  • :page_size (Integer) —

    Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. (default to 50)

Returns:

  • (ProjectUsers) 


525
526
527
528
 
# File 'lib/xero-ruby/api/project_api.rb', line 525

def get_project_users(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_project_users_with_http_info(xero_tenant_id, opts)
  data
end

#get_project_users_with_http_info(xero_tenant_id, options = {}) ⇒ Array<(ProjectUsers, Integer, Hash)>

Retrieves a list of all project users Allows you to retrieve the users on a projects.

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) —

    the optional parameters

Returns:

  • (Array<(ProjectUsers, Integer, Hash)>) —

    ProjectUsers data, response status code and response headers



537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
 
# File 'lib/xero-ruby/api/project_api.rb', line 537

def get_project_users_with_http_info(xero_tenant_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProjectApi.get_project_users ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling ProjectApi.get_project_users"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 500
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProjectApi.get_project_users, must be smaller than or equal to 500.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProjectApi.get_project_users, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/ProjectsUsers'

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'ProjectUsers' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, "ProjectApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProjectApi#get_project_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_project_with_http_info(xero_tenant_id, project_id, options = {}) ⇒ Array<(Project, Integer, Hash)>

Retrieves a single project Allows you to retrieve a specific project using the projectId

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • project_id (String) —

    You can specify an individual project by appending the projectId to the endpoint

  • opts (Hash) —

    the optional parameters

Returns:

  • (Array<(Project, Integer, Hash)>) —

    Project data, response status code and response headers



458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
 
# File 'lib/xero-ruby/api/project_api.rb', line 458

def get_project_with_http_info(xero_tenant_id, project_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProjectApi.get_project ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling ProjectApi.get_project"
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProjectApi.get_project"
  end
  # resource path
  local_var_path = '/Projects/{projectId}'.sub('{' + 'projectId' + '}', project_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?

  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Project' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, "ProjectApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProjectApi#get_project\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_projects(xero_tenant_id, opts = {}) ⇒ Projects

Retrieves all projects Allows you to retrieve, create and update projects.

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

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

    the optional parameters

Options Hash (opts):

  • :project_ids (Array<String>) —

    Search for all projects that match a comma separated list of projectIds

  • :contact_id (String) —

    Filter for projects for a specific contact

  • :states (String) —

    Filter for projects in a particular state (INPROGRESS or CLOSED)

  • :page (Integer) —

    set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. (default to 1)

  • :page_size (Integer) —

    Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. (default to 50)

Returns:



613
614
615
616
 
# File 'lib/xero-ruby/api/project_api.rb', line 613

def get_projects(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_projects_with_http_info(xero_tenant_id, opts)
  data
end

#get_projects_with_http_info(xero_tenant_id, options = {}) ⇒ Array<(Projects, Integer, Hash)>

Retrieves all projects Allows you to retrieve, create and update projects.

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) —

    the optional parameters

Returns:

  • (Array<(Projects, Integer, Hash)>) —

    Projects data, response status code and response headers



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
 
# File 'lib/xero-ruby/api/project_api.rb', line 628

def get_projects_with_http_info(xero_tenant_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProjectApi.get_projects ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling ProjectApi.get_projects"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 500
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProjectApi.get_projects, must be smaller than or equal to 500.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProjectApi.get_projects, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/Projects'

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'projectIds'] = @api_client.build_collection_param(opts[:'project_ids'], :multi) if !opts[:'project_ids'].nil?
  query_params[:'contactID'] = opts[:'contact_id'] if !opts[:'contact_id'].nil?
  query_params[:'states'] = opts[:'states'] if !opts[:'states'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Projects' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, "ProjectApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProjectApi#get_projects\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_task(xero_tenant_id, project_id, task_id, opts = {}) ⇒ Task

Retrieves a single project task Allows you to retrieve a specific project

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • project_id (String) —

    You can specify an individual project by appending the projectId to the endpoint

  • task_id (String) —

    You can specify an individual task by appending the taskId to the endpoint, i.e. GET …/tasks/taskID

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

    the optional parameters

Returns:

  • (Task) 


704
705
706
707
 
# File 'lib/xero-ruby/api/project_api.rb', line 704

def get_task(xero_tenant_id, project_id, task_id, opts = {})
  data, _status_code, _headers = get_task_with_http_info(xero_tenant_id, project_id, task_id, opts)
  data
end

#get_task_with_http_info(xero_tenant_id, project_id, task_id, options = {}) ⇒ Array<(Task, Integer, Hash)>

Retrieves a single project task Allows you to retrieve a specific project

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • project_id (String) —

    You can specify an individual project by appending the projectId to the endpoint

  • task_id (String) —

    You can specify an individual task by appending the taskId to the endpoint, i.e. GET …/tasks/taskID

  • opts (Hash) —

    the optional parameters

Returns:

  • (Array<(Task, Integer, Hash)>) —

    Task data, response status code and response headers



716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
 
# File 'lib/xero-ruby/api/project_api.rb', line 716

def get_task_with_http_info(xero_tenant_id, project_id, task_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProjectApi.get_task ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling ProjectApi.get_task"
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProjectApi.get_task"
  end
  # verify the required parameter 'task_id' is set
  if @api_client.config.client_side_validation && task_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_id' when calling ProjectApi.get_task"
  end
  # resource path
  local_var_path = '/Projects/{projectId}/Tasks/{taskId}'.sub('{' + 'projectId' + '}', project_id.to_s).sub('{' + 'taskId' + '}', task_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?

  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Task' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, "ProjectApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProjectApi#get_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tasks(xero_tenant_id, project_id, opts = {}) ⇒ Tasks

Retrieves all project tasks Allows you to retrieve a specific project

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • project_id (String) —

    You can specify an individual project by appending the projectId to the endpoint

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0.

  • :page_size (Integer) —

    Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500.

  • :task_ids (String) —

    Search for all tasks that match a comma separated list of taskIds, i.e. GET …/tasks?taskIds&#x3D;taskID,taskID

  • :charge_type (ChargeType)

Returns:

  • (Tasks) 


790
791
792
793
 
# File 'lib/xero-ruby/api/project_api.rb', line 790

def get_tasks(xero_tenant_id, project_id, opts = {})
  data, _status_code, _headers = get_tasks_with_http_info(xero_tenant_id, project_id, opts)
  data
end

#get_tasks_with_http_info(xero_tenant_id, project_id, options = {}) ⇒ Array<(Tasks, Integer, Hash)>

Retrieves all project tasks Allows you to retrieve a specific project

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • project_id (String) —

    You can specify an individual project by appending the projectId to the endpoint

  • opts (Hash) —

    the optional parameters

Returns:

  • (Array<(Tasks, Integer, Hash)>) —

    Tasks data, response status code and response headers



805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
 
# File 'lib/xero-ruby/api/project_api.rb', line 805

def get_tasks_with_http_info(xero_tenant_id, project_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProjectApi.get_tasks ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling ProjectApi.get_tasks"
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProjectApi.get_tasks"
  end
  # resource path
  local_var_path = '/Projects/{projectId}/Tasks'.sub('{' + 'projectId' + '}', project_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'taskIds'] = opts[:'task_ids'] if !opts[:'task_ids'].nil?
  query_params[:'chargeType'] = opts[:'charge_type'] if !opts[:'charge_type'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Tasks' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, "ProjectApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProjectApi#get_tasks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_time_entries(xero_tenant_id, project_id, opts = {}) ⇒ TimeEntries

Retrieves all time entries associated with a specific project Allows you to retrieve the time entries associated with a specific project

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • project_id (String) —

    Identifier of the project, that the task (which the time entry is logged against) belongs to.

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

    the optional parameters

Options Hash (opts):

  • :user_id (String) —

    The xero user identifier of the person who logged time.

  • :task_id (String) —

    Identifier of the task that time entry is logged against.

  • :invoice_id (String) —

    Finds all time entries for this invoice.

  • :contact_id (String) —

    Finds all time entries for this contact identifier.

  • :page (Integer) —

    Set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0.

  • :page_size (Integer) —

    Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500.

  • :states (Array<String>) —

    Comma-separated list of states to find. Will find all time entries that are in the status of whatever is specified.

  • :is_chargeable (Boolean) —

    Finds all time entries which relate to tasks with the charge type &#x60;TIME&#x60; or &#x60;FIXED&#x60;.

  • :date_after_utc (DateTime) —

    ISO 8601 UTC date. Finds all time entries on or after this date filtered on the &#x60;dateUtc&#x60; field.

  • :date_before_utc (DateTime) —

    ISO 8601 UTC date. Finds all time entries on or before this date filtered on the &#x60;dateUtc&#x60; field.

Returns:

  • (TimeEntries) 


885
886
887
888
 
# File 'lib/xero-ruby/api/project_api.rb', line 885

def get_time_entries(xero_tenant_id, project_id, opts = {})
  data, _status_code, _headers = get_time_entries_with_http_info(xero_tenant_id, project_id, opts)
  data
end

#get_time_entries_with_http_info(xero_tenant_id, project_id, options = {}) ⇒ Array<(TimeEntries, Integer, Hash)>

Retrieves all time entries associated with a specific project Allows you to retrieve the time entries associated with a specific project

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • project_id (String) —

    Identifier of the project, that the task (which the time entry is logged against) belongs to.

  • opts (Hash) —

    the optional parameters

Returns:

  • (Array<(TimeEntries, Integer, Hash)>) —

    TimeEntries data, response status code and response headers



906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
 
# File 'lib/xero-ruby/api/project_api.rb', line 906

def get_time_entries_with_http_info(xero_tenant_id, project_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProjectApi.get_time_entries ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling ProjectApi.get_time_entries"
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProjectApi.get_time_entries"
  end
  # resource path
  local_var_path = '/Projects/{projectId}/Time'.sub('{' + 'projectId' + '}', project_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'userId'] = opts[:'user_id'] if !opts[:'user_id'].nil?
  query_params[:'taskId'] = opts[:'task_id'] if !opts[:'task_id'].nil?
  query_params[:'invoiceId'] = opts[:'invoice_id'] if !opts[:'invoice_id'].nil?
  query_params[:'contactId'] = opts[:'contact_id'] if !opts[:'contact_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'states'] = @api_client.build_collection_param(opts[:'states'], :multi) if !opts[:'states'].nil?
  query_params[:'isChargeable'] = opts[:'is_chargeable'] if !opts[:'is_chargeable'].nil?
  query_params[:'dateAfterUtc'] = opts[:'date_after_utc'] if !opts[:'date_after_utc'].nil?
  query_params[:'dateBeforeUtc'] = opts[:'date_before_utc'] if !opts[:'date_before_utc'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'TimeEntries' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, "ProjectApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProjectApi#get_time_entries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_time_entry(xero_tenant_id, project_id, time_entry_id, opts = {}) ⇒ TimeEntry

Retrieves a single time entry for a specific project Allows you to get a single time entry in a project

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • project_id (String) —

    You can specify an individual project by appending the projectId to the endpoint

  • time_entry_id (String) —

    You can specify an individual time entry by appending the id to the endpoint

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

    the optional parameters

Returns:

  • (TimeEntry) 


983
984
985
986
 
# File 'lib/xero-ruby/api/project_api.rb', line 983

def get_time_entry(xero_tenant_id, project_id, time_entry_id, opts = {})
  data, _status_code, _headers = get_time_entry_with_http_info(xero_tenant_id, project_id, time_entry_id, opts)
  data
end

#get_time_entry_with_http_info(xero_tenant_id, project_id, time_entry_id, options = {}) ⇒ Array<(TimeEntry, Integer, Hash)>

Retrieves a single time entry for a specific project Allows you to get a single time entry in a project

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • project_id (String) —

    You can specify an individual project by appending the projectId to the endpoint

  • time_entry_id (String) —

    You can specify an individual time entry by appending the id to the endpoint

  • opts (Hash) —

    the optional parameters

Returns:

  • (Array<(TimeEntry, Integer, Hash)>) —

    TimeEntry data, response status code and response headers



995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
 
# File 'lib/xero-ruby/api/project_api.rb', line 995

def get_time_entry_with_http_info(xero_tenant_id, project_id, time_entry_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProjectApi.get_time_entry ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling ProjectApi.get_time_entry"
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProjectApi.get_time_entry"
  end
  # verify the required parameter 'time_entry_id' is set
  if @api_client.config.client_side_validation && time_entry_id.nil?
    fail ArgumentError, "Missing the required parameter 'time_entry_id' when calling ProjectApi.get_time_entry"
  end
  # resource path
  local_var_path = '/Projects/{projectId}/Time/{timeEntryId}'.sub('{' + 'projectId' + '}', project_id.to_s).sub('{' + 'timeEntryId' + '}', time_entry_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?

  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'TimeEntry' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, "ProjectApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProjectApi#get_time_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_project(xero_tenant_id, project_id, project_patch, opts = {}) ⇒ nil

creates a project for the specified contact Allows you to update a specific projects.

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • project_id (String) —

    You can specify an individual project by appending the projectId to the endpoint

  • project_patch (ProjectPatch) —

    Update the status of an existing Project

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

  • (nil) 


1067
1068
1069
1070
 
# File 'lib/xero-ruby/api/project_api.rb', line 1067

def patch_project(xero_tenant_id, project_id, project_patch, opts = {})
  patch_project_with_http_info(xero_tenant_id, project_id, project_patch, opts)
  nil
end

#patch_project_with_http_info(xero_tenant_id, project_id, project_patch, options = {}) ⇒ Array<(nil, Integer, Hash)>

creates a project for the specified contact Allows you to update a specific projects.

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • project_id (String) —

    You can specify an individual project by appending the projectId to the endpoint

  • project_patch (ProjectPatch) —

    Update the status of an existing Project

  • opts (Hash) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
 
# File 'lib/xero-ruby/api/project_api.rb', line 1080

def patch_project_with_http_info(xero_tenant_id, project_id, project_patch, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProjectApi.patch_project ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling ProjectApi.patch_project"
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProjectApi.patch_project"
  end
  # verify the required parameter 'project_patch' is set
  if @api_client.config.client_side_validation && project_patch.nil?
    fail ArgumentError, "Missing the required parameter 'project_patch' when calling ProjectApi.patch_project"
  end
  # resource path
  local_var_path = '/Projects/{projectId}'.sub('{' + 'projectId' + '}', project_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?

  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[: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[:'Xero-Tenant-Id'] = xero_tenant_id
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(project_patch) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, "ProjectApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProjectApi#patch_project\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_project(xero_tenant_id, project_id, project_create_or_update, opts = {}) ⇒ nil

Updates a specific project Allows you to update a specific projects.

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • project_id (String) —

    You can specify an individual project by appending the projectId to the endpoint

  • project_create_or_update (ProjectCreateOrUpdate) —

    Request of type ProjectCreateOrUpdate

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

  • (nil) 


1155
1156
1157
1158
 
# File 'lib/xero-ruby/api/project_api.rb', line 1155

def update_project(xero_tenant_id, project_id, project_create_or_update, opts = {})
  update_project_with_http_info(xero_tenant_id, project_id, project_create_or_update, opts)
  nil
end

#update_project_with_http_info(xero_tenant_id, project_id, project_create_or_update, options = {}) ⇒ Array<(nil, Integer, Hash)>

Updates a specific project Allows you to update a specific projects.

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • project_id (String) —

    You can specify an individual project by appending the projectId to the endpoint

  • project_create_or_update (ProjectCreateOrUpdate) —

    Request of type ProjectCreateOrUpdate

  • opts (Hash) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
 
# File 'lib/xero-ruby/api/project_api.rb', line 1168

def update_project_with_http_info(xero_tenant_id, project_id, project_create_or_update, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProjectApi.update_project ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling ProjectApi.update_project"
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProjectApi.update_project"
  end
  # verify the required parameter 'project_create_or_update' is set
  if @api_client.config.client_side_validation && project_create_or_update.nil?
    fail ArgumentError, "Missing the required parameter 'project_create_or_update' when calling ProjectApi.update_project"
  end
  # resource path
  local_var_path = '/Projects/{projectId}'.sub('{' + 'projectId' + '}', project_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?

  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[: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[:'Xero-Tenant-Id'] = xero_tenant_id
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(project_create_or_update) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, "ProjectApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProjectApi#update_project\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_task(xero_tenant_id, project_id, task_id, task_create_or_update, opts = {}) ⇒ nil

Allows you to update a task Allows you to update a specific task

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • project_id (String) —

    You can specify an individual project by appending the projectId to the endpoint

  • task_id (String) —

    You can specify an individual task by appending the id to the endpoint

  • task_create_or_update (TaskCreateOrUpdate) —

    The task object you are updating

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

  • (nil) 


1244
1245
1246
1247
 
# File 'lib/xero-ruby/api/project_api.rb', line 1244

def update_task(xero_tenant_id, project_id, task_id, task_create_or_update, opts = {})
  update_task_with_http_info(xero_tenant_id, project_id, task_id, task_create_or_update, opts)
  nil
end

#update_task_with_http_info(xero_tenant_id, project_id, task_id, task_create_or_update, options = {}) ⇒ Array<(nil, Integer, Hash)>

Allows you to update a task Allows you to update a specific task

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • project_id (String) —

    You can specify an individual project by appending the projectId to the endpoint

  • task_id (String) —

    You can specify an individual task by appending the id to the endpoint

  • task_create_or_update (TaskCreateOrUpdate) —

    The task object you are updating

  • opts (Hash) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
 
# File 'lib/xero-ruby/api/project_api.rb', line 1258

def update_task_with_http_info(xero_tenant_id, project_id, task_id, task_create_or_update, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProjectApi.update_task ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling ProjectApi.update_task"
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProjectApi.update_task"
  end
  # verify the required parameter 'task_id' is set
  if @api_client.config.client_side_validation && task_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_id' when calling ProjectApi.update_task"
  end
  # verify the required parameter 'task_create_or_update' is set
  if @api_client.config.client_side_validation && task_create_or_update.nil?
    fail ArgumentError, "Missing the required parameter 'task_create_or_update' when calling ProjectApi.update_task"
  end
  # resource path
  local_var_path = '/Projects/{projectId}/Tasks/{taskId}'.sub('{' + 'projectId' + '}', project_id.to_s).sub('{' + 'taskId' + '}', task_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?

  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[: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[:'Xero-Tenant-Id'] = xero_tenant_id
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(task_create_or_update) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, "ProjectApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProjectApi#update_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_time_entry(xero_tenant_id, project_id, time_entry_id, time_entry_create_or_update, opts = {}) ⇒ nil

Updates a time entry for a specific project Allows you to update time entry in a project

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • project_id (String) —

    You can specify an individual project by appending the projectId to the endpoint

  • time_entry_id (String) —

    You can specify an individual time entry by appending the id to the endpoint

  • time_entry_create_or_update (TimeEntryCreateOrUpdate) —

    The time entry object you are updating

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

  • (nil) 


1338
1339
1340
1341
 
# File 'lib/xero-ruby/api/project_api.rb', line 1338

def update_time_entry(xero_tenant_id, project_id, time_entry_id, time_entry_create_or_update, opts = {})
  update_time_entry_with_http_info(xero_tenant_id, project_id, time_entry_id, time_entry_create_or_update, opts)
  nil
end

#update_time_entry_with_http_info(xero_tenant_id, project_id, time_entry_id, time_entry_create_or_update, options = {}) ⇒ Array<(nil, Integer, Hash)>

Updates a time entry for a specific project Allows you to update time entry in a project

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • project_id (String) —

    You can specify an individual project by appending the projectId to the endpoint

  • time_entry_id (String) —

    You can specify an individual time entry by appending the id to the endpoint

  • time_entry_create_or_update (TimeEntryCreateOrUpdate) —

    The time entry object you are updating

  • opts (Hash) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
 
# File 'lib/xero-ruby/api/project_api.rb', line 1352

def update_time_entry_with_http_info(xero_tenant_id, project_id, time_entry_id, time_entry_create_or_update, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProjectApi.update_time_entry ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling ProjectApi.update_time_entry"
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProjectApi.update_time_entry"
  end
  # verify the required parameter 'time_entry_id' is set
  if @api_client.config.client_side_validation && time_entry_id.nil?
    fail ArgumentError, "Missing the required parameter 'time_entry_id' when calling ProjectApi.update_time_entry"
  end
  # verify the required parameter 'time_entry_create_or_update' is set
  if @api_client.config.client_side_validation && time_entry_create_or_update.nil?
    fail ArgumentError, "Missing the required parameter 'time_entry_create_or_update' when calling ProjectApi.update_time_entry"
  end
  # resource path
  local_var_path = '/Projects/{projectId}/Time/{timeEntryId}'.sub('{' + 'projectId' + '}', project_id.to_s).sub('{' + 'timeEntryId' + '}', time_entry_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?

  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[: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[:'Xero-Tenant-Id'] = xero_tenant_id
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(time_entry_create_or_update) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, "ProjectApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProjectApi#update_time_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end