Class: XeroRuby::FilesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.new) ⇒ FilesApi

Returns a new instance of FilesApi.



16
17
18
 
# File 'lib/xero-ruby/api/files_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/files_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#create_file_association(xero_tenant_id, file_id, opts = {}) ⇒ Association

create a new association By passing in the appropriate options, you can create a new folder

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • file_id (String) —

    File id for single object

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

    the optional parameters

Options Hash (opts):

  • :association (Association)

Returns:

  • (Association) 


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

def create_file_association(xero_tenant_id, file_id, opts = {})
  data, _status_code, _headers = create_file_association_with_http_info(xero_tenant_id, file_id, opts)
  data
end

#create_file_association_with_http_info(xero_tenant_id, file_id, opts = {}) ⇒ Array<(Association, Integer, Hash)>

create a new association By passing in the appropriate options, you can create a new folder

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • file_id (String) —

    File id for single object

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

    the optional parameters

Options Hash (opts):

  • :association (Association)

Returns:

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

    Association data, response status code and response headers



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/xero-ruby/api/files_api.rb', line 38

def create_file_association_with_http_info(xero_tenant_id, file_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.create_file_association ...'
  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 FilesApi.create_file_association"
  end
  # verify the required parameter 'file_id' is set
  if @api_client.config.client_side_validation && file_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_id' when calling FilesApi.create_file_association"
  end
  # resource path
  local_var_path = '/Files/{FileId}/Associations'.sub('{' + 'FileId' + '}', file_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(opts[:'association']) 

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

  # 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, "FilesApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FilesApi#create_file_association\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_folder(xero_tenant_id, opts = {}) ⇒ Folder

create a new folder By passing in the appropriate properties, you can create a new folder

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

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

    the optional parameters

Options Hash (opts):

  • :folder (Folder)

Returns:

  • (Folder) 


105
106
107
108
 
# File 'lib/xero-ruby/api/files_api.rb', line 105

def create_folder(xero_tenant_id, opts = {})
  data, _status_code, _headers = create_folder_with_http_info(xero_tenant_id, opts)
  data
end

#create_folder_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(Folder, Integer, Hash)>

create a new folder By passing in the appropriate properties, you can create a new folder

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

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

    the optional parameters

Options Hash (opts):

  • :folder (Folder)

Returns:

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

    Folder data, response status code and response headers



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

def create_folder_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.create_folder ...'
  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 FilesApi.create_folder"
  end
  # resource path
  local_var_path = '/Folders'

  # 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(opts[:'folder']) 

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

  # 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, "FilesApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FilesApi#create_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_file(xero_tenant_id, file_id, opts = {}) ⇒ FileResponse204

delete a file Delete a specific file

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • file_id (String) —

    File id for single object

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

    the optional parameters

Returns:

  • (FileResponse204) 


179
180
181
182
 
# File 'lib/xero-ruby/api/files_api.rb', line 179

def delete_file(xero_tenant_id, file_id, opts = {})
  data, _status_code, _headers = delete_file_with_http_info(xero_tenant_id, file_id, opts)
  data
end

#delete_file_association(xero_tenant_id, file_id, object_id, opts = {}) ⇒ FileResponse204

create a new association By passing in the appropriate options, you can create a new folder

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • file_id (String) —

    File id for single object

  • object_id (String) —

    Object id for single object

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

    the optional parameters

Returns:

  • (FileResponse204) 


256
257
258
259
 
# File 'lib/xero-ruby/api/files_api.rb', line 256

def delete_file_association(xero_tenant_id, file_id, object_id, opts = {})
  data, _status_code, _headers = delete_file_association_with_http_info(xero_tenant_id, file_id, object_id, opts)
  data
end

#delete_file_association_with_http_info(xero_tenant_id, file_id, object_id, opts = {}) ⇒ Array<(FileResponse204, Integer, Hash)>

create a new association By passing in the appropriate options, you can create a new folder

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • file_id (String) —

    File id for single object

  • object_id (String) —

    Object id for single object

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

    the optional parameters

Returns:

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

    FileResponse204 data, response status code and response headers



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
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/xero-ruby/api/files_api.rb', line 268

def delete_file_association_with_http_info(xero_tenant_id, file_id, object_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.delete_file_association ...'
  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 FilesApi.delete_file_association"
  end
  # verify the required parameter 'file_id' is set
  if @api_client.config.client_side_validation && file_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_id' when calling FilesApi.delete_file_association"
  end
  # verify the required parameter 'object_id' is set
  if @api_client.config.client_side_validation && object_id.nil?
    fail ArgumentError, "Missing the required parameter 'object_id' when calling FilesApi.delete_file_association"
  end
  # resource path
  local_var_path = '/Files/{FileId}/Associations/{ObjectId}'.sub('{' + 'FileId' + '}', file_id.to_s).sub('{' + 'ObjectId' + '}', object_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] || 'FileResponse204' 

  # 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, "FilesApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FilesApi#delete_file_association\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_file_with_http_info(xero_tenant_id, file_id, opts = {}) ⇒ Array<(FileResponse204, Integer, Hash)>

delete a file Delete a specific file

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • file_id (String) —

    File id for single object

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

    the optional parameters

Returns:

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

    FileResponse204 data, response status code and response headers



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
240
241
242
243
244
245
246
247
 
# File 'lib/xero-ruby/api/files_api.rb', line 190

def delete_file_with_http_info(xero_tenant_id, file_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.delete_file ...'
  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 FilesApi.delete_file"
  end
  # verify the required parameter 'file_id' is set
  if @api_client.config.client_side_validation && file_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_id' when calling FilesApi.delete_file"
  end
  # resource path
  local_var_path = '/Files/{FileId}'.sub('{' + 'FileId' + '}', file_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] || 'FileResponse204' 

  # 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, "FilesApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FilesApi#delete_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_folder(xero_tenant_id, folder_id, opts = {}) ⇒ FileResponse204

delete a folder By passing in the appropriate ID, you can delete a folder

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • folder_id (String) —

    Folder id for single object

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

    the optional parameters

Returns:

  • (FileResponse204) 


337
338
339
340
 
# File 'lib/xero-ruby/api/files_api.rb', line 337

def delete_folder(xero_tenant_id, folder_id, opts = {})
  data, _status_code, _headers = delete_folder_with_http_info(xero_tenant_id, folder_id, opts)
  data
end

#delete_folder_with_http_info(xero_tenant_id, folder_id, opts = {}) ⇒ Array<(FileResponse204, Integer, Hash)>

delete a folder By passing in the appropriate ID, you can delete a folder

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • folder_id (String) —

    Folder id for single object

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

    the optional parameters

Returns:

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

    FileResponse204 data, response status code and response headers



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
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/xero-ruby/api/files_api.rb', line 348

def delete_folder_with_http_info(xero_tenant_id, folder_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.delete_folder ...'
  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 FilesApi.delete_folder"
  end
  # verify the required parameter 'folder_id' is set
  if @api_client.config.client_side_validation && folder_id.nil?
    fail ArgumentError, "Missing the required parameter 'folder_id' when calling FilesApi.delete_folder"
  end
  # resource path
  local_var_path = '/Folders/{FolderId}'.sub('{' + 'FolderId' + '}', folder_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] || 'FileResponse204' 

  # 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, "FilesApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FilesApi#delete_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_associations_by_object(xero_tenant_id, object_id, opts = {}) ⇒ Array<Association>

searches files By passing in the appropriate options,

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • object_id (String) —

    Object id for single object

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

    the optional parameters

Returns:

  • (Array<Association>) 


413
414
415
416
 
# File 'lib/xero-ruby/api/files_api.rb', line 413

def get_associations_by_object(xero_tenant_id, object_id, opts = {})
  data, _status_code, _headers = get_associations_by_object_with_http_info(xero_tenant_id, object_id, opts)
  data
end

#get_associations_by_object_with_http_info(xero_tenant_id, object_id, opts = {}) ⇒ Array<(Array<Association>, Integer, Hash)>

searches files By passing in the appropriate options,

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • object_id (String) —

    Object id for single object

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

    the optional parameters

Returns:

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

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



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
472
473
474
475
476
477
478
479
480
481
 
# File 'lib/xero-ruby/api/files_api.rb', line 424

def get_associations_by_object_with_http_info(xero_tenant_id, object_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.get_associations_by_object ...'
  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 FilesApi.get_associations_by_object"
  end
  # verify the required parameter 'object_id' is set
  if @api_client.config.client_side_validation && object_id.nil?
    fail ArgumentError, "Missing the required parameter 'object_id' when calling FilesApi.get_associations_by_object"
  end
  # resource path
  local_var_path = '/Associations/{ObjectId}'.sub('{' + 'ObjectId' + '}', object_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] || 'Array<Association>' 

  # 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, "FilesApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FilesApi#get_associations_by_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_file(xero_tenant_id, file_id, opts = {}) ⇒ FileObject

searches for file by unique id

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • file_id (String) —

    File id for single object

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

    the optional parameters

Returns:

  • (FileObject) 


488
489
490
491
 
# File 'lib/xero-ruby/api/files_api.rb', line 488

def get_file(xero_tenant_id, file_id, opts = {})
  data, _status_code, _headers = get_file_with_http_info(xero_tenant_id, file_id, opts)
  data
end

#get_file_associations(xero_tenant_id, file_id, opts = {}) ⇒ Array<Association>

searches files By passing in the appropriate options,

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • file_id (String) —

    File id for single object

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

    the optional parameters

Returns:

  • (Array<Association>) 


563
564
565
566
 
# File 'lib/xero-ruby/api/files_api.rb', line 563

def get_file_associations(xero_tenant_id, file_id, opts = {})
  data, _status_code, _headers = get_file_associations_with_http_info(xero_tenant_id, file_id, opts)
  data
end

#get_file_associations_with_http_info(xero_tenant_id, file_id, opts = {}) ⇒ Array<(Array<Association>, Integer, Hash)>

searches files By passing in the appropriate options,

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • file_id (String) —

    File id for single object

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

    the optional parameters

Returns:

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

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



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
625
626
627
628
629
630
631
 
# File 'lib/xero-ruby/api/files_api.rb', line 574

def get_file_associations_with_http_info(xero_tenant_id, file_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.get_file_associations ...'
  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 FilesApi.get_file_associations"
  end
  # verify the required parameter 'file_id' is set
  if @api_client.config.client_side_validation && file_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_id' when calling FilesApi.get_file_associations"
  end
  # resource path
  local_var_path = '/Files/{FileId}/Associations'.sub('{' + 'FileId' + '}', file_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] || 'Array<Association>' 

  # 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, "FilesApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FilesApi#get_file_associations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_file_content(xero_tenant_id, file_id, opts = {}) ⇒ File

searches files to retrieve the data By passing in the appropriate options, retrieve data for specific file

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • file_id (String) —

    File id for single object

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

    the optional parameters

Returns:

  • (File) 


639
640
641
642
 
# File 'lib/xero-ruby/api/files_api.rb', line 639

def get_file_content(xero_tenant_id, file_id, opts = {})
  data, _status_code, _headers = get_file_content_with_http_info(xero_tenant_id, file_id, opts)
  data
end

#get_file_content_with_http_info(xero_tenant_id, file_id, opts = {}) ⇒ Array<(File, Integer, Hash)>

searches files to retrieve the data By passing in the appropriate options, retrieve data for specific file

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • file_id (String) —

    File id for single object

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

    the optional parameters

Returns:

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

    File data, response status code and response headers



650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
 
# File 'lib/xero-ruby/api/files_api.rb', line 650

def get_file_content_with_http_info(xero_tenant_id, file_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.get_file_content ...'
  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 FilesApi.get_file_content"
  end
  # verify the required parameter 'file_id' is set
  if @api_client.config.client_side_validation && file_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_id' when calling FilesApi.get_file_content"
  end
  # resource path
  local_var_path = '/Files/{FileId}/Content'.sub('{' + 'FileId' + '}', file_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/octet-stream'])
  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] || 'File' 

  # 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, "FilesApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FilesApi#get_file_content\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_file_with_http_info(xero_tenant_id, file_id, opts = {}) ⇒ Array<(FileObject, Integer, Hash)>

searches for file by unique id

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • file_id (String) —

    File id for single object

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

    the optional parameters

Returns:

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

    FileObject data, response status code and response headers



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
547
548
549
550
551
552
553
554
555
 
# File 'lib/xero-ruby/api/files_api.rb', line 498

def get_file_with_http_info(xero_tenant_id, file_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.get_file ...'
  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 FilesApi.get_file"
  end
  # verify the required parameter 'file_id' is set
  if @api_client.config.client_side_validation && file_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_id' when calling FilesApi.get_file"
  end
  # resource path
  local_var_path = '/Files/{FileId}'.sub('{' + 'FileId' + '}', file_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] || 'FileObject' 

  # 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, "FilesApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FilesApi#get_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_files(xero_tenant_id, opts = {}) ⇒ Files

searches files

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

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

    the optional parameters

Options Hash (opts):

  • :pagesize (Integer) —

    pass an optional page size value

  • :page (Integer) —

    number of records to skip for pagination

  • :sort (String) —

    values to sort by

Returns:



716
717
718
719
 
# File 'lib/xero-ruby/api/files_api.rb', line 716

def get_files(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_files_with_http_info(xero_tenant_id, opts)
  data
end

#get_files_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(Files, Integer, Hash)>

searches files

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

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

    the optional parameters

Options Hash (opts):

  • :pagesize (Integer) —

    pass an optional page size value

  • :page (Integer) —

    number of records to skip for pagination

  • :sort (String) —

    values to sort by

Returns:

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

    Files data, response status code and response headers



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
787
788
789
790
791
792
793
794
795
796
 
# File 'lib/xero-ruby/api/files_api.rb', line 728

def get_files_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.get_files ...'
  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 FilesApi.get_files"
  end
  if @api_client.config.client_side_validation && !opts[:'pagesize'].nil? && opts[:'pagesize'] > 100
    fail ArgumentError, 'invalid value for "opts[:"pagesize"]" when calling FilesApi.get_files, must be smaller than or equal to 100.'
  end

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

  allowable_values = ["Name", "Size", "CreatedDateUTC"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/Files'

  # 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[:'pagesize'] = opts[:'pagesize'] if !opts[:'pagesize'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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] || 'Files' 

  # 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, "FilesApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FilesApi#get_files\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_folder(xero_tenant_id, folder_id, opts = {}) ⇒ Folder

searches specific folder by id By passing in the appropriate ID, you can search for specific folder

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • folder_id (String) —

    Folder id for single object

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

    the optional parameters

Returns:

  • (Folder) 


804
805
806
807
 
# File 'lib/xero-ruby/api/files_api.rb', line 804

def get_folder(xero_tenant_id, folder_id, opts = {})
  data, _status_code, _headers = get_folder_with_http_info(xero_tenant_id, folder_id, opts)
  data
end

#get_folder_with_http_info(xero_tenant_id, folder_id, opts = {}) ⇒ Array<(Folder, Integer, Hash)>

searches specific folder by id By passing in the appropriate ID, you can search for specific folder

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • folder_id (String) —

    Folder id for single object

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

    the optional parameters

Returns:

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

    Folder data, response status code and response headers



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
869
870
871
872
 
# File 'lib/xero-ruby/api/files_api.rb', line 815

def get_folder_with_http_info(xero_tenant_id, folder_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.get_folder ...'
  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 FilesApi.get_folder"
  end
  # verify the required parameter 'folder_id' is set
  if @api_client.config.client_side_validation && folder_id.nil?
    fail ArgumentError, "Missing the required parameter 'folder_id' when calling FilesApi.get_folder"
  end
  # resource path
  local_var_path = '/Folders/{FolderId}'.sub('{' + 'FolderId' + '}', folder_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] || 'Folder' 

  # 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, "FilesApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FilesApi#get_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_folders(xero_tenant_id, opts = {}) ⇒ Array<Folder>

searches folder By passing in the appropriate options, you can search for available folders

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

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

    the optional parameters

Options Hash (opts):

  • :sort (String) —

    values to sort by

Returns:

  • (Array<Folder>) 


880
881
882
883
 
# File 'lib/xero-ruby/api/files_api.rb', line 880

def get_folders(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_folders_with_http_info(xero_tenant_id, opts)
  data
end

#get_folders_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(Array<Folder>, Integer, Hash)>

searches folder By passing in the appropriate options, you can search for available folders

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

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

    the optional parameters

Options Hash (opts):

  • :sort (String) —

    values to sort by

Returns:

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

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



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

def get_folders_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.get_folders ...'
  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 FilesApi.get_folders"
  end
  allowable_values = ["Name", "Size", "CreatedDateUTC"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/Folders'

  # 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[:'sort'] = opts[:'sort'] if !opts[:'sort'].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] || 'Array<Folder>' 

  # 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, "FilesApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FilesApi#get_folders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_inbox(xero_tenant_id, opts = {}) ⇒ Folder

searches inbox folder Search for the user inbox

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

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

    the optional parameters

Returns:

  • (Folder) 


956
957
958
959
 
# File 'lib/xero-ruby/api/files_api.rb', line 956

def get_inbox(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_inbox_with_http_info(xero_tenant_id, opts)
  data
end

#get_inbox_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(Folder, Integer, Hash)>

searches inbox folder Search for the user inbox

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

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

    the optional parameters

Returns:

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

    Folder data, response status code and response headers



966
967
968
969
970
971
972
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
 
# File 'lib/xero-ruby/api/files_api.rb', line 966

def get_inbox_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.get_inbox ...'
  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 FilesApi.get_inbox"
  end
  # resource path
  local_var_path = '/Inbox'

  # 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] || 'Folder' 

  # 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, "FilesApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FilesApi#get_inbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_file(xero_tenant_id, file_id, opts = {}) ⇒ FileObject

Update a file Update properties on a single file

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • file_id (String) —

    File id for single object

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

    the optional parameters

Options Hash (opts):

  • :file_object (FileObject)

Returns:

  • (FileObject) 


1028
1029
1030
1031
 
# File 'lib/xero-ruby/api/files_api.rb', line 1028

def update_file(xero_tenant_id, file_id, opts = {})
  data, _status_code, _headers = update_file_with_http_info(xero_tenant_id, file_id, opts)
  data
end

#update_file_with_http_info(xero_tenant_id, file_id, opts = {}) ⇒ Array<(FileObject, Integer, Hash)>

Update a file Update properties on a single file

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • file_id (String) —

    File id for single object

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

    the optional parameters

Options Hash (opts):

  • :file_object (FileObject)

Returns:

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

    FileObject data, response status code and response headers



1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
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
 
# File 'lib/xero-ruby/api/files_api.rb', line 1040

def update_file_with_http_info(xero_tenant_id, file_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.update_file ...'
  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 FilesApi.update_file"
  end
  # verify the required parameter 'file_id' is set
  if @api_client.config.client_side_validation && file_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_id' when calling FilesApi.update_file"
  end
  # resource path
  local_var_path = '/Files/{FileId}'.sub('{' + 'FileId' + '}', file_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(opts[:'file_object']) 

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

  # 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, "FilesApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FilesApi#update_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_folder(xero_tenant_id, folder_id, folder, opts = {}) ⇒ Folder

update folder By passing in the appropriate ID and properties, you can update a folder

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • folder_id (String) —

    Folder id for single object

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

    the optional parameters

Returns:

  • (Folder) 


1108
1109
1110
1111
 
# File 'lib/xero-ruby/api/files_api.rb', line 1108

def update_folder(xero_tenant_id, folder_id, folder, opts = {})
  data, _status_code, _headers = update_folder_with_http_info(xero_tenant_id, folder_id, folder, opts)
  data
end

#update_folder_with_http_info(xero_tenant_id, folder_id, folder, opts = {}) ⇒ Array<(Folder, Integer, Hash)>

update folder By passing in the appropriate ID and properties, you can update a folder

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • folder_id (String) —

    Folder id for single object

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

    the optional parameters

Returns:

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

    Folder data, response status code and response headers



1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
 
# File 'lib/xero-ruby/api/files_api.rb', line 1120

def update_folder_with_http_info(xero_tenant_id, folder_id, folder, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.update_folder ...'
  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 FilesApi.update_folder"
  end
  # verify the required parameter 'folder_id' is set
  if @api_client.config.client_side_validation && folder_id.nil?
    fail ArgumentError, "Missing the required parameter 'folder_id' when calling FilesApi.update_folder"
  end
  # verify the required parameter 'folder' is set
  if @api_client.config.client_side_validation && folder.nil?
    fail ArgumentError, "Missing the required parameter 'folder' when calling FilesApi.update_folder"
  end
  # resource path
  local_var_path = '/Folders/{FolderId}'.sub('{' + 'FolderId' + '}', folder_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(folder) 

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

  # 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, "FilesApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FilesApi#update_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#upload_file(xero_tenant_id, opts = {}) ⇒ FileObject

upload an File

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

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

    the optional parameters

Options Hash (opts):

  • :folder_id (String) —

    pass an optional folder id to save file to specific folder

  • :body (String)
  • :name (String) —

    exact name of the file you are uploading

  • :filename (String)
  • :mime_type (String)

Returns:

  • (FileObject) 


1194
1195
1196
1197
 
# File 'lib/xero-ruby/api/files_api.rb', line 1194

def upload_file(xero_tenant_id, opts = {})
  data, _status_code, _headers = upload_file_with_http_info(xero_tenant_id, opts)
  data
end

#upload_file_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(FileObject, Integer, Hash)>

upload an File

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

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

    the optional parameters

Options Hash (opts):

  • :folder_id (String) —

    pass an optional folder id to save file to specific folder

  • :body (String)
  • :name (String) —

    exact name of the file you are uploading

  • :filename (String)
  • :mime_type (String)

Returns:

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

    FileObject data, response status code and response headers



1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
 
# File 'lib/xero-ruby/api/files_api.rb', line 1208

def upload_file_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.upload_file ...'
  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 FilesApi.upload_file"
  end
  # resource path
  local_var_path = '/Files'

  # 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[:'folderId'] = opts[:'folder_id'] if !opts[:'folder_id'].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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['body'] = opts[:'body'] if !opts[:'body'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
  form_params['filename'] = opts[:'filename'] if !opts[:'filename'].nil?
  form_params['mimeType'] = opts[:'mime_type'] if !opts[:'mime_type'].nil?

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

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

  # 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, "FilesApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FilesApi#upload_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end