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, association, opts = {}) ⇒ Association

Creates a new file 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

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

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

Returns:

  • (Association) 


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

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

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

Creates a new file 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

  • association (Association)
  • opts (Hash) —

    the optional parameters

Returns:

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

    Association data, response status code and response headers



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
98
99
100
101
102
103
104
105
 
# File 'lib/xero-ruby/api/files_api.rb', line 40

def create_file_association_with_http_info(xero_tenant_id, file_id, association, options = {})
  opts = options.dup
  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
  # verify the required parameter 'association' is set
  if @api_client.config.client_side_validation && association.nil?
    fail ArgumentError, "Missing the required parameter 'association' 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
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(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, folder, opts = {}) ⇒ Folder

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

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

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

Returns:

  • (Folder) 


114
115
116
117
 
# File 'lib/xero-ruby/api/files_api.rb', line 114

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

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

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

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • folder (Folder)
  • opts (Hash) —

    the optional parameters

Returns:

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

    Folder data, response status code and response headers



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/xero-ruby/api/files_api.rb', line 126

def create_folder_with_http_info(xero_tenant_id, folder, options = {})
  opts = options.dup
  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
  # 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.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
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(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 = {}) ⇒ nil

Deletes a specific 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:

  • (nil) 


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

def delete_file(xero_tenant_id, file_id, opts = {})
  delete_file_with_http_info(xero_tenant_id, file_id, opts)
  nil
end

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

Deletes an existing file 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:

  • (nil) 


271
272
273
274
 
# File 'lib/xero-ruby/api/files_api.rb', line 271

def delete_file_association(xero_tenant_id, file_id, object_id, opts = {})
  delete_file_association_with_http_info(xero_tenant_id, file_id, object_id, opts)
  nil
end

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

Deletes an existing file 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) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/xero-ruby/api/files_api.rb', line 283

def delete_file_association_with_http_info(xero_tenant_id, file_id, object_id, options = {})
  opts = options.dup
  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] || {}
  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, "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, options = {}) ⇒ Array<(nil, Integer, Hash)>

Deletes a specific file Delete a specific file

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • file_id (String) —

    File id for single object

  • opts (Hash) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
258
259
260
261
262
 
# File 'lib/xero-ruby/api/files_api.rb', line 206

def delete_file_with_http_info(xero_tenant_id, file_id, options = {})
  opts = options.dup
  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] || {}
  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, "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 = {}) ⇒ nil

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

  • (nil) 


351
352
353
354
 
# File 'lib/xero-ruby/api/files_api.rb', line 351

def delete_folder(xero_tenant_id, folder_id, opts = {})
  delete_folder_with_http_info(xero_tenant_id, folder_id, opts)
  nil
end

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

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def delete_folder_with_http_info(xero_tenant_id, folder_id, options = {})
  opts = options.dup
  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] || {}
  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, "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>

Retrieves an association object using a unique object ID By passing in the appropriate options, you can retrieve an association

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • object_id (String) —

    Object id for single object

  • 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

  • :direction (String) —

    direction to sort by

Returns:

  • (Array<Association>) 


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

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

Retrieves an association object using a unique object ID By passing in the appropriate options, you can retrieve an association

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • object_id (String) —

    Object id for single object

  • opts (Hash) —

    the optional parameters

Returns:

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

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



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
511
512
513
514
515
516
517
518
519
520
521
522
523
 
# File 'lib/xero-ruby/api/files_api.rb', line 445

def get_associations_by_object_with_http_info(xero_tenant_id, object_id, options = {})
  opts = options.dup
  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
  if @api_client.config.client_side_validation && !opts[:'pagesize'].nil? && opts[:'pagesize'] > 100
    fail ArgumentError, 'invalid value for "opts[:"pagesize"]" when calling FilesApi.get_associations_by_object, 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_associations_by_object, must be greater than or equal to 1.'
  end

  allowable_values = ["Name", "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
  allowable_values = ["ASC", "DESC"]
  if @api_client.config.client_side_validation && opts[:'direction'] && !allowable_values.include?(opts[:'direction'])
    fail ArgumentError, "invalid value for \"direction\", must be one of #{allowable_values}"
  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] || {}
  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?
  query_params[:'direction'] = opts[:'direction'] if !opts[:'direction'].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<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_associations_count(xero_tenant_id, object_ids, opts = {}) ⇒ Object

Retrieves a count of associations for a list of objects. By passing in the appropriate options, you can retrieve the association count for objects

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • object_ids (Array<String>) —

    A comma-separated list of object ids

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

    the optional parameters

Returns:

  • (Object) 


531
532
533
534
 
# File 'lib/xero-ruby/api/files_api.rb', line 531

def get_associations_count(xero_tenant_id, object_ids, opts = {})
  data, _status_code, _headers = get_associations_count_with_http_info(xero_tenant_id, object_ids, opts)
  data
end

#get_associations_count_with_http_info(xero_tenant_id, object_ids, options = {}) ⇒ Array<(Object, Integer, Hash)>

Retrieves a count of associations for a list of objects. By passing in the appropriate options, you can retrieve the association count for objects

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • object_ids (Array<String>) —

    A comma-separated list of object ids

  • opts (Hash) —

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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

def get_associations_count_with_http_info(xero_tenant_id, object_ids, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.get_associations_count ...'
  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_count"
  end
  # verify the required parameter 'object_ids' is set
  if @api_client.config.client_side_validation && object_ids.nil?
    fail ArgumentError, "Missing the required parameter 'object_ids' when calling FilesApi.get_associations_count"
  end
  # resource path
  local_var_path = '/Associations/Count'

  # 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[:'ObjectIds'] = @api_client.build_collection_param(object_ids, :multi)
  
  # 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] || 'Object' 

  # 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_count\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

Retrieves a file by a unique file 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) 


608
609
610
611
 
# File 'lib/xero-ruby/api/files_api.rb', line 608

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>

Retrieves a specific file associations 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>) 


684
685
686
687
 
# File 'lib/xero-ruby/api/files_api.rb', line 684

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

Retrieves a specific file associations 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) —

    the optional parameters

Returns:

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

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



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

def get_file_associations_with_http_info(xero_tenant_id, file_id, options = {})
  opts = options.dup
  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

Retrieves the content of a specific file 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) 


761
762
763
764
 
# File 'lib/xero-ruby/api/files_api.rb', line 761

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

Retrieves the content of a specific file 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) —

    the optional parameters

Returns:

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

    File data, response status code and response headers



772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
 
# File 'lib/xero-ruby/api/files_api.rb', line 772

def get_file_content_with_http_info(xero_tenant_id, file_id, options = {})
  opts = options.dup
  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, options = {}) ⇒ Array<(FileObject, Integer, Hash)>

Retrieves a file by a unique file ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • file_id (String) —

    File id for single object

  • opts (Hash) —

    the optional parameters

Returns:

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

    FileObject data, response status code and response headers



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

def get_file_with_http_info(xero_tenant_id, file_id, options = {})
  opts = options.dup
  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

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



839
840
841
842
 
# File 'lib/xero-ruby/api/files_api.rb', line 839

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

Retrieves files

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) —

    the optional parameters

Returns:

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

    Files data, response status code and response headers



851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
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
 
# File 'lib/xero-ruby/api/files_api.rb', line 851

def get_files_with_http_info(xero_tenant_id, options = {})
  opts = options.dup
  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

Retrieves specific folder by using a unique folder 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) 


928
929
930
931
 
# File 'lib/xero-ruby/api/files_api.rb', line 928

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

Retrieves specific folder by using a unique folder 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) —

    the optional parameters

Returns:

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

    Folder data, response status code and response headers



939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
 
# File 'lib/xero-ruby/api/files_api.rb', line 939

def get_folder_with_http_info(xero_tenant_id, folder_id, options = {})
  opts = options.dup
  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>

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


1005
1006
1007
1008
 
# File 'lib/xero-ruby/api/files_api.rb', line 1005

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

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

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) —

    the optional parameters

Returns:

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

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



1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
 
# File 'lib/xero-ruby/api/files_api.rb', line 1016

def get_folders_with_http_info(xero_tenant_id, options = {})
  opts = options.dup
  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

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


1082
1083
1084
1085
 
# File 'lib/xero-ruby/api/files_api.rb', line 1082

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

Retrieves inbox folder Search for the user inbox

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) —

    the optional parameters

Returns:

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

    Folder data, response status code and response headers



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

def get_inbox_with_http_info(xero_tenant_id, options = {})
  opts = options.dup
  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, file_object, opts = {}) ⇒ FileObject

Update a file Updates file properties of a single file

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • file_id (String) —

    File id for single object

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

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

Returns:

  • (FileObject) 


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

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

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

Update a file Updates file properties of a single file

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • file_id (String) —

    File id for single object

  • file_object (FileObject)
  • opts (Hash) —

    the optional parameters

Returns:

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

    FileObject data, response status code and response headers



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

def update_file_with_http_info(xero_tenant_id, file_id, file_object, options = {})
  opts = options.dup
  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
  # verify the required parameter 'file_object' is set
  if @api_client.config.client_side_validation && file_object.nil?
    fail ArgumentError, "Missing the required parameter 'file_object' 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
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(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

Updates an existing 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

Options Hash (opts):

  • :idempotency_key (String) —

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

Returns:

  • (Folder) 


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

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

Updates an existing 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) —

    the optional parameters

Returns:

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

    Folder data, response status code and response headers



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

def update_folder_with_http_info(xero_tenant_id, folder_id, folder, options = {})
  opts = options.dup
  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
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(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, body, name, filename, opts = {}) ⇒ FileObject

Uploads a File to the inbox

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • body (String)
  • name (String) —

    exact name of the file you are uploading

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

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

  • :mime_type (String)

Returns:

  • (FileObject) 


1333
1334
1335
1336
 
# File 'lib/xero-ruby/api/files_api.rb', line 1333

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

#upload_file_to_folder(xero_tenant_id, folder_id, body, name, filename, opts = {}) ⇒ FileObject

Uploads a File to a specific folder

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • folder_id (String) —

    pass required folder id to save file to specific folder

  • body (String)
  • name (String) —

    exact name of the file you are uploading

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

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

  • :mime_type (String)

Returns:

  • (FileObject) 


1432
1433
1434
1435
 
# File 'lib/xero-ruby/api/files_api.rb', line 1432

def upload_file_to_folder(xero_tenant_id, folder_id, body, name, filename, opts = {})
  data, _status_code, _headers = upload_file_to_folder_with_http_info(xero_tenant_id, folder_id, body, name, filename, opts)
  data
end

#upload_file_to_folder_with_http_info(xero_tenant_id, folder_id, body, name, filename, options = {}) ⇒ Array<(FileObject, Integer, Hash)>

Uploads a File to a specific folder

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • folder_id (String) —

    pass required folder id to save file to specific folder

  • body (String)
  • name (String) —

    exact name of the file you are uploading

  • filename (String)
  • opts (Hash) —

    the optional parameters

Returns:

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

    FileObject data, response status code and response headers



1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
 
# File 'lib/xero-ruby/api/files_api.rb', line 1447

def upload_file_to_folder_with_http_info(xero_tenant_id, folder_id, body, name, filename, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.upload_file_to_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.upload_file_to_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.upload_file_to_folder"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling FilesApi.upload_file_to_folder"
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling FilesApi.upload_file_to_folder"
  end
  # verify the required parameter 'filename' is set
  if @api_client.config.client_side_validation && filename.nil?
    fail ArgumentError, "Missing the required parameter 'filename' when calling FilesApi.upload_file_to_folder"
  end
  # resource path
  local_var_path = '/Files/{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(['multipart/form-data'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['body'] = body
  form_params['name'] = name
  form_params['filename'] = filename
  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_to_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#upload_file_with_http_info(xero_tenant_id, body, name, filename, options = {}) ⇒ Array<(FileObject, Integer, Hash)>

Uploads a File to the inbox

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • body (String)
  • name (String) —

    exact name of the file you are uploading

  • filename (String)
  • opts (Hash) —

    the optional parameters

Returns:

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

    FileObject data, response status code and response headers



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

def upload_file_with_http_info(xero_tenant_id, body, name, filename, options = {})
  opts = options.dup
  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
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling FilesApi.upload_file"
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling FilesApi.upload_file"
  end
  # verify the required parameter 'filename' is set
  if @api_client.config.client_side_validation && filename.nil?
    fail ArgumentError, "Missing the required parameter 'filename' 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] || {}
  
  # 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
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['body'] = body
  form_params['name'] = name
  form_params['filename'] = filename
  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