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.



19
20
21
 
# File 'lib/xero-ruby/api/project_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



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

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

Returns:

  • (Project) 


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

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, opts = {}) ⇒ 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) (defaults to: {}) —

    the optional parameters

Returns:

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

    Project data, response status code and response headers



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

def create_project_with_http_info(xero_tenant_id, project_create_or_update, opts = {})
  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'

  # query parameters
  query_params = opts[:query_params] || {}

  # 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

  # 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, 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_time_entry(xero_tenant_id, project_id, time_entry_create_or_update, opts = {}) ⇒ TimeEntry

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 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

Returns:

  • (TimeEntry) 


98
99
100
101
 
# File 'lib/xero-ruby/api/project_api.rb', line 98

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, opts = {}) ⇒ Array<(TimeEntry, 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 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

Returns:

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

    TimeEntry data, response status code and response headers



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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/xero-ruby/api/project_api.rb', line 110

def create_time_entry_with_http_info(xero_tenant_id, project_id, time_entry_create_or_update, opts = {})
  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)

  # query parameters
  query_params = opts[:query_params] || {}

  # 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

  # 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, 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_time_entry(xero_tenant_id, project_id, time_entry_id, opts = {}) ⇒ nil

Allows you to delete a time entry 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) 


175
176
177
178
 
# File 'lib/xero-ruby/api/project_api.rb', line 175

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, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Allows you to delete a time entry 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:

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

    nil, response status code and response headers



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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/xero-ruby/api/project_api.rb', line 187

def delete_time_entry_with_http_info(xero_tenant_id, project_id, time_entry_id, opts = {})
  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)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  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, 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

Allows you to retrieve a single project 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

Returns:

  • (Project) 


247
248
249
250
 
# File 'lib/xero-ruby/api/project_api.rb', line 247

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

list 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) 


317
318
319
320
 
# File 'lib/xero-ruby/api/project_api.rb', line 317

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, opts = {}) ⇒ Array<(ProjectUsers, Integer, Hash)>

list 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.

  • :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.

Returns:

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

    ProjectUsers data, response status code and response headers



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
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/xero-ruby/api/project_api.rb', line 329

def get_project_users_with_http_info(xero_tenant_id, opts = {})
  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'

  # 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?

  # 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, 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, opts = {}) ⇒ Array<(Project, Integer, Hash)>

Allows you to retrieve a single project 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

Returns:

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

    Project data, response status code and response headers



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
304
305
306
307
308
 
# File 'lib/xero-ruby/api/project_api.rb', line 258

def get_project_with_http_info(xero_tenant_id, project_id, opts = {})
  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)

  # query parameters
  query_params = opts[:query_params] || {}

  # 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, 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

list 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:



397
398
399
400
 
# File 'lib/xero-ruby/api/project_api.rb', line 397

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, opts = {}) ⇒ Array<(Projects, Integer, Hash)>

list 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.

  • :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.

Returns:

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

    Projects data, response status code and response headers



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
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/xero-ruby/api/project_api.rb', line 412

def get_projects_with_http_info(xero_tenant_id, opts = {})
  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'

  # 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?

  # 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, 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

Allows you to retrieve a single project 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) 


480
481
482
483
 
# File 'lib/xero-ruby/api/project_api.rb', line 480

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, opts = {}) ⇒ Array<(Task, Integer, Hash)>

Allows you to retrieve a single project 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:

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

    Task data, response status code and response headers



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
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'lib/xero-ruby/api/project_api.rb', line 492

def get_task_with_http_info(xero_tenant_id, project_id, task_id, opts = {})
  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)

  # query parameters
  query_params = opts[:query_params] || {}

  # 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, 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

Allows you to retrieve a single project 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) —

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

Returns:

  • (Tasks) 


557
558
559
560
 
# File 'lib/xero-ruby/api/project_api.rb', line 557

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, opts = {}) ⇒ Array<(Tasks, Integer, Hash)>

Allows you to retrieve a single project 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) —

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

Returns:

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

    Tasks data, response status code and response headers



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
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
 
# File 'lib/xero-ruby/api/project_api.rb', line 571

def get_tasks_with_http_info(xero_tenant_id, project_id, opts = {})
  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)

  # 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?

  # 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, 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

Allows you to retrieve the 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’s 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) 


642
643
644
645
 
# File 'lib/xero-ruby/api/project_api.rb', line 642

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, opts = {}) ⇒ Array<(TimeEntries, Integer, Hash)>

Allows you to retrieve the 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’s 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:

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

    TimeEntries data, response status code and response headers



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
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
 
# File 'lib/xero-ruby/api/project_api.rb', line 663

def get_time_entries_with_http_info(xero_tenant_id, project_id, opts = {})
  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)

  # 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?

  # 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, 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

Allows you to get a single time entry in a project Allows you to upget 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) 


732
733
734
735
 
# File 'lib/xero-ruby/api/project_api.rb', line 732

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, opts = {}) ⇒ Array<(TimeEntry, Integer, Hash)>

Allows you to get a single time entry in a project Allows you to upget 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:

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

    TimeEntry data, response status code and response headers



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
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
 
# File 'lib/xero-ruby/api/project_api.rb', line 744

def get_time_entry_with_http_info(xero_tenant_id, project_id, time_entry_id, opts = {})
  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)

  # query parameters
  query_params = opts[:query_params] || {}

  # 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, 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

Returns:

  • (nil) 


807
808
809
810
 
# File 'lib/xero-ruby/api/project_api.rb', line 807

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, opts = {}) ⇒ 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) (defaults to: {}) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
868
869
870
871
872
873
874
875
 
# File 'lib/xero-ruby/api/project_api.rb', line 819

def patch_project_with_http_info(xero_tenant_id, project_id, project_patch, opts = {})
  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)

  # query parameters
  query_params = opts[:query_params] || {}

  # 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

  # 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, 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

update 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

Returns:

  • (nil) 


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

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, opts = {}) ⇒ Array<(nil, Integer, Hash)>

update 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

Returns:

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

    nil, response status code and response headers



896
897
898
899
900
901
902
903
904
905
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
 
# File 'lib/xero-ruby/api/project_api.rb', line 896

def update_project_with_http_info(xero_tenant_id, project_id, project_create_or_update, opts = {})
  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)

  # query parameters
  query_params = opts[:query_params] || {}

  # 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

  # 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, 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_time_entry(xero_tenant_id, project_id, time_entry_id, time_entry_create_or_update, opts = {}) ⇒ nil

Allows you to update time entry in a 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

Returns:

  • (nil) 


962
963
964
965
 
# File 'lib/xero-ruby/api/project_api.rb', line 962

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, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Allows you to update time entry in a 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

Returns:

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

    nil, response status code and response headers



975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
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
 
# File 'lib/xero-ruby/api/project_api.rb', line 975

def update_time_entry_with_http_info(xero_tenant_id, project_id, time_entry_id, time_entry_create_or_update, opts = {})
  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)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'Xero-Tenant-Id'] = xero_tenant_id

  # 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, 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