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

Returns:

  • (Project) 


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

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



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

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'

  # 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

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

Returns:

  • (TimeEntry) 


102
103
104
105
 
# File 'lib/xero-ruby/api/project_api.rb', line 102

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

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

Returns:

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

    TimeEntry data, response status code and response headers



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
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/xero-ruby/api/project_api.rb', line 114

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)

  # 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

  # 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_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) 


186
187
188
189
 
# File 'lib/xero-ruby/api/project_api.rb', line 186

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

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:

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

    nil, response status code and response headers



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
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/xero-ruby/api/project_api.rb', line 198

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)

  # 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] || {}
  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) 


265
266
267
268
 
# File 'lib/xero-ruby/api/project_api.rb', line 265

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) 


342
343
344
345
 
# File 'lib/xero-ruby/api/project_api.rb', line 342

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

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.

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



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

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'

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

    the optional parameters

Returns:

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

    Project data, response status code and response headers



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/xero-ruby/api/project_api.rb', line 276

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)

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



429
430
431
432
 
# File 'lib/xero-ruby/api/project_api.rb', line 429

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

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.

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



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

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'

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


519
520
521
522
 
# File 'lib/xero-ruby/api/project_api.rb', line 519

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

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:

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

    Task data, response status code and response headers



531
532
533
534
535
536
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
 
# File 'lib/xero-ruby/api/project_api.rb', line 531

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)

  # 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) —

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

  • :charge_type (ChargeType)

Returns:

  • (Tasks) 


604
605
606
607
 
# File 'lib/xero-ruby/api/project_api.rb', line 604

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

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

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

  • :charge_type (ChargeType)

Returns:

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

    Tasks data, response status code and response headers



619
620
621
622
623
624
625
626
627
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
 
# File 'lib/xero-ruby/api/project_api.rb', line 619

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)

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


698
699
700
701
 
# File 'lib/xero-ruby/api/project_api.rb', line 698

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

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:

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

    TimeEntries data, response status code and response headers



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
779
780
781
782
783
784
785
786
 
# File 'lib/xero-ruby/api/project_api.rb', line 719

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)

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


795
796
797
798
 
# File 'lib/xero-ruby/api/project_api.rb', line 795

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

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:

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

    TimeEntry data, response status code and response headers



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

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)

  # 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

Returns:

  • (nil) 


877
878
879
880
 
# File 'lib/xero-ruby/api/project_api.rb', line 877

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



889
890
891
892
893
894
895
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 889

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)

  # 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

  # 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

Returns:

  • (nil) 


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

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

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

Returns:

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

    nil, response status code and response headers



973
974
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
1034
1035
1036
 
# File 'lib/xero-ruby/api/project_api.rb', line 973

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)

  # 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

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

Returns:

  • (nil) 


1046
1047
1048
1049
 
# File 'lib/xero-ruby/api/project_api.rb', line 1046

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

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

Returns:

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

    nil, response status code and response headers



1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
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
 
# File 'lib/xero-ruby/api/project_api.rb', line 1059

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)

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