Class: TripletexRubyClient::DocumentArchiveApi

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_ruby_client/api/document_archive_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DocumentArchiveApi

Returns a new instance of DocumentArchiveApi.



19
20
21
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#account_post(file, id, opts = {}) ⇒ ResponseWrapperDocumentArchive

BETA

Upload file to Account Document Archive.

Parameters:

  • file —

    The file

  • id —

    Element ID

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 28

def (file, id, opts = {})
  data, _status_code, _headers = (file, id, opts)
  data
end

#account_post_with_http_info(file, id, opts = {}) ⇒ Array<(ResponseWrapperDocumentArchive, Fixnum, Hash)>

BETA

Upload file to Account Document Archive.

Parameters:

  • file —

    The file

  • id —

    Element ID

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

    the optional parameters

Returns:



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
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 39

def (file, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentArchiveApi.account_post ...'
  end
  # verify the required parameter 'file' is set
  if @api_client.config.client_side_validation && file.nil?
    fail ArgumentError, "Missing the required parameter 'file' when calling DocumentArchiveApi.account_post"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling DocumentArchiveApi.account_post"
  end
  # resource path
  local_var_path = '/documentArchive/account/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['file'] = file

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResponseWrapperDocumentArchive')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DocumentArchiveApi#account_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#customer_post(file, id, opts = {}) ⇒ ResponseWrapperDocumentArchive

BETA

Upload file to Customer Document Archive.

Parameters:

  • file —

    The file

  • id —

    Element ID

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

    the optional parameters

Returns:



87
88
89
90
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 87

def customer_post(file, id, opts = {})
  data, _status_code, _headers = customer_post_with_http_info(file, id, opts)
  data
end

#customer_post_with_http_info(file, id, opts = {}) ⇒ Array<(ResponseWrapperDocumentArchive, Fixnum, Hash)>

BETA

Upload file to Customer Document Archive.

Parameters:

  • file —

    The file

  • id —

    Element ID

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

    the optional parameters

Returns:



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 98

def customer_post_with_http_info(file, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentArchiveApi.customer_post ...'
  end
  # verify the required parameter 'file' is set
  if @api_client.config.client_side_validation && file.nil?
    fail ArgumentError, "Missing the required parameter 'file' when calling DocumentArchiveApi.customer_post"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling DocumentArchiveApi.customer_post"
  end
  # resource path
  local_var_path = '/documentArchive/customer/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['file'] = file

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResponseWrapperDocumentArchive')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DocumentArchiveApi#customer_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete(id, opts = {}) ⇒ nil

BETA

Delete document archive.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Returns:

  • (nil) 


145
146
147
148
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 145

def delete(id, opts = {})
  delete_with_http_info(id, opts)
  nil
end

#delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

BETA

Delete document archive.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
188
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 155

def delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentArchiveApi.delete ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling DocumentArchiveApi.delete"
  end
  # resource path
  local_var_path = '/documentArchive/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DocumentArchiveApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#employee_post(file, id, opts = {}) ⇒ ResponseWrapperDocumentArchive

BETA

Upload file to Employee Document Archive.

Parameters:

  • file —

    The file

  • id —

    Element ID

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

    the optional parameters

Returns:



195
196
197
198
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 195

def employee_post(file, id, opts = {})
  data, _status_code, _headers = employee_post_with_http_info(file, id, opts)
  data
end

#employee_post_with_http_info(file, id, opts = {}) ⇒ Array<(ResponseWrapperDocumentArchive, Fixnum, Hash)>

BETA

Upload file to Employee Document Archive.

Parameters:

  • file —

    The file

  • id —

    Element ID

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

    the optional parameters

Returns:



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/tripletex_ruby_client/api/document_archive_api.rb', line 206

def employee_post_with_http_info(file, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentArchiveApi.employee_post ...'
  end
  # verify the required parameter 'file' is set
  if @api_client.config.client_side_validation && file.nil?
    fail ArgumentError, "Missing the required parameter 'file' when calling DocumentArchiveApi.employee_post"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling DocumentArchiveApi.employee_post"
  end
  # resource path
  local_var_path = '/documentArchive/employee/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['file'] = file

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResponseWrapperDocumentArchive')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DocumentArchiveApi#employee_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_account(id, opts = {}) ⇒ ListResponseDocumentArchive

BETA

Find documents archived associated with account object type.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :period_date_from (String) —

    From and including

  • :period_date_to (String) —

    To and excluding

  • :from (Integer) —

    From index (default to 0)

  • :count (Integer) —

    Number of elements to return (default to 1000)

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



259
260
261
262
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 259

def (id, opts = {})
  data, _status_code, _headers = (id, opts)
  data
end

#get_account_with_http_info(id, opts = {}) ⇒ Array<(ListResponseDocumentArchive, Fixnum, Hash)>

BETA

Find documents archived associated with account object type.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :period_date_from (String) —

    From and including

  • :period_date_to (String) —

    To and excluding

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



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
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 275

def (id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentArchiveApi.get_account ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling DocumentArchiveApi.get_account"
  end
  # resource path
  local_var_path = '/documentArchive/account/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'periodDateFrom'] = opts[:'period_date_from'] if !opts[:'period_date_from'].nil?
  query_params[:'periodDateTo'] = opts[:'period_date_to'] if !opts[:'period_date_to'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'sorting'] = opts[:'sorting'] if !opts[:'sorting'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ListResponseDocumentArchive')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DocumentArchiveApi#get_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_customer(id, opts = {}) ⇒ ListResponseDocumentArchive

BETA

Find documents archived associated with customer object type.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :period_date_from (String) —

    From and including

  • :period_date_to (String) —

    To and excluding

  • :from (Integer) —

    From index (default to 0)

  • :count (Integer) —

    Number of elements to return (default to 1000)

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



327
328
329
330
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 327

def get_customer(id, opts = {})
  data, _status_code, _headers = get_customer_with_http_info(id, opts)
  data
end

#get_customer_with_http_info(id, opts = {}) ⇒ Array<(ListResponseDocumentArchive, Fixnum, Hash)>

BETA

Find documents archived associated with customer object type.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :period_date_from (String) —

    From and including

  • :period_date_to (String) —

    To and excluding

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 343

def get_customer_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentArchiveApi.get_customer ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling DocumentArchiveApi.get_customer"
  end
  # resource path
  local_var_path = '/documentArchive/customer/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'periodDateFrom'] = opts[:'period_date_from'] if !opts[:'period_date_from'].nil?
  query_params[:'periodDateTo'] = opts[:'period_date_to'] if !opts[:'period_date_to'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'sorting'] = opts[:'sorting'] if !opts[:'sorting'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ListResponseDocumentArchive')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DocumentArchiveApi#get_customer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_employee(id, opts = {}) ⇒ ListResponseDocumentArchive

BETA

Find documents archived associated with employee object type.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :period_date_from (String) —

    From and including

  • :period_date_to (String) —

    To and excluding

  • :from (Integer) —

    From index (default to 0)

  • :count (Integer) —

    Number of elements to return (default to 1000)

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



395
396
397
398
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 395

def get_employee(id, opts = {})
  data, _status_code, _headers = get_employee_with_http_info(id, opts)
  data
end

#get_employee_with_http_info(id, opts = {}) ⇒ Array<(ListResponseDocumentArchive, Fixnum, Hash)>

BETA

Find documents archived associated with employee object type.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :period_date_from (String) —

    From and including

  • :period_date_to (String) —

    To and excluding

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 411

def get_employee_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentArchiveApi.get_employee ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling DocumentArchiveApi.get_employee"
  end
  # resource path
  local_var_path = '/documentArchive/employee/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'periodDateFrom'] = opts[:'period_date_from'] if !opts[:'period_date_from'].nil?
  query_params[:'periodDateTo'] = opts[:'period_date_to'] if !opts[:'period_date_to'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'sorting'] = opts[:'sorting'] if !opts[:'sorting'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ListResponseDocumentArchive')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DocumentArchiveApi#get_employee\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_product(id, opts = {}) ⇒ ListResponseDocumentArchive

BETA

Find documents archived associated with product object type.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :period_date_from (String) —

    From and including

  • :period_date_to (String) —

    To and excluding

  • :from (Integer) —

    From index (default to 0)

  • :count (Integer) —

    Number of elements to return (default to 1000)

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



463
464
465
466
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 463

def get_product(id, opts = {})
  data, _status_code, _headers = get_product_with_http_info(id, opts)
  data
end

#get_product_with_http_info(id, opts = {}) ⇒ Array<(ListResponseDocumentArchive, Fixnum, Hash)>

BETA

Find documents archived associated with product object type.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :period_date_from (String) —

    From and including

  • :period_date_to (String) —

    To and excluding

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



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
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 479

def get_product_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentArchiveApi.get_product ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling DocumentArchiveApi.get_product"
  end
  # resource path
  local_var_path = '/documentArchive/product/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'periodDateFrom'] = opts[:'period_date_from'] if !opts[:'period_date_from'].nil?
  query_params[:'periodDateTo'] = opts[:'period_date_to'] if !opts[:'period_date_to'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'sorting'] = opts[:'sorting'] if !opts[:'sorting'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ListResponseDocumentArchive')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DocumentArchiveApi#get_product\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_project(id, opts = {}) ⇒ ListResponseDocumentArchive

BETA

Find documents archived associated with project object type.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :period_date_from (String) —

    From and including

  • :period_date_to (String) —

    To and excluding

  • :from (Integer) —

    From index (default to 0)

  • :count (Integer) —

    Number of elements to return (default to 1000)

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



531
532
533
534
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 531

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

#get_project_with_http_info(id, opts = {}) ⇒ Array<(ListResponseDocumentArchive, Fixnum, Hash)>

BETA

Find documents archived associated with project object type.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :period_date_from (String) —

    From and including

  • :period_date_to (String) —

    To and excluding

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



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
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 547

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

  # query parameters
  query_params = {}
  query_params[:'periodDateFrom'] = opts[:'period_date_from'] if !opts[:'period_date_from'].nil?
  query_params[:'periodDateTo'] = opts[:'period_date_to'] if !opts[:'period_date_to'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'sorting'] = opts[:'sorting'] if !opts[:'sorting'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ListResponseDocumentArchive')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DocumentArchiveApi#get_project\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_prospect(id, opts = {}) ⇒ ListResponseDocumentArchive

BETA

Find documents archived associated with prospect object type.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :period_date_from (String) —

    From and including

  • :period_date_to (String) —

    To and excluding

  • :from (Integer) —

    From index (default to 0)

  • :count (Integer) —

    Number of elements to return (default to 1000)

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



599
600
601
602
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 599

def get_prospect(id, opts = {})
  data, _status_code, _headers = get_prospect_with_http_info(id, opts)
  data
end

#get_prospect_with_http_info(id, opts = {}) ⇒ Array<(ListResponseDocumentArchive, Fixnum, Hash)>

BETA

Find documents archived associated with prospect object type.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :period_date_from (String) —

    From and including

  • :period_date_to (String) —

    To and excluding

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



615
616
617
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
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 615

def get_prospect_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentArchiveApi.get_prospect ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling DocumentArchiveApi.get_prospect"
  end
  # resource path
  local_var_path = '/documentArchive/prospect/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'periodDateFrom'] = opts[:'period_date_from'] if !opts[:'period_date_from'].nil?
  query_params[:'periodDateTo'] = opts[:'period_date_to'] if !opts[:'period_date_to'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'sorting'] = opts[:'sorting'] if !opts[:'sorting'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ListResponseDocumentArchive')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DocumentArchiveApi#get_prospect\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_supplier(id, opts = {}) ⇒ ListResponseDocumentArchive

BETA

Find documents archived associated with supplier object type.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :period_date_from (String) —

    From and including

  • :period_date_to (String) —

    To and excluding

  • :from (Integer) —

    From index (default to 0)

  • :count (Integer) —

    Number of elements to return (default to 1000)

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



667
668
669
670
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 667

def get_supplier(id, opts = {})
  data, _status_code, _headers = get_supplier_with_http_info(id, opts)
  data
end

#get_supplier_with_http_info(id, opts = {}) ⇒ Array<(ListResponseDocumentArchive, Fixnum, Hash)>

BETA

Find documents archived associated with supplier object type.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :period_date_from (String) —

    From and including

  • :period_date_to (String) —

    To and excluding

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 683

def get_supplier_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentArchiveApi.get_supplier ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling DocumentArchiveApi.get_supplier"
  end
  # resource path
  local_var_path = '/documentArchive/supplier/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'periodDateFrom'] = opts[:'period_date_from'] if !opts[:'period_date_from'].nil?
  query_params[:'periodDateTo'] = opts[:'period_date_to'] if !opts[:'period_date_to'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'sorting'] = opts[:'sorting'] if !opts[:'sorting'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ListResponseDocumentArchive')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DocumentArchiveApi#get_supplier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#product_post(file, id, opts = {}) ⇒ ResponseWrapperDocumentArchive

BETA

Upload file to Product Document Archive.

Parameters:

  • file —

    The file

  • id —

    Element ID

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

    the optional parameters

Returns:



730
731
732
733
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 730

def product_post(file, id, opts = {})
  data, _status_code, _headers = product_post_with_http_info(file, id, opts)
  data
end

#product_post_with_http_info(file, id, opts = {}) ⇒ Array<(ResponseWrapperDocumentArchive, Fixnum, Hash)>

BETA

Upload file to Product Document Archive.

Parameters:

  • file —

    The file

  • id —

    Element ID

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

    the optional parameters

Returns:



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
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 741

def product_post_with_http_info(file, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentArchiveApi.product_post ...'
  end
  # verify the required parameter 'file' is set
  if @api_client.config.client_side_validation && file.nil?
    fail ArgumentError, "Missing the required parameter 'file' when calling DocumentArchiveApi.product_post"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling DocumentArchiveApi.product_post"
  end
  # resource path
  local_var_path = '/documentArchive/product/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['file'] = file

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResponseWrapperDocumentArchive')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DocumentArchiveApi#product_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#project_post(file, id, opts = {}) ⇒ ResponseWrapperDocumentArchive

BETA

Upload file to Project Document Archive.

Parameters:

  • file —

    The file

  • id —

    Element ID

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

    the optional parameters

Returns:



789
790
791
792
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 789

def project_post(file, id, opts = {})
  data, _status_code, _headers = project_post_with_http_info(file, id, opts)
  data
end

#project_post_with_http_info(file, id, opts = {}) ⇒ Array<(ResponseWrapperDocumentArchive, Fixnum, Hash)>

BETA

Upload file to Project Document Archive.

Parameters:

  • file —

    The file

  • id —

    Element ID

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

    the optional parameters

Returns:



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
831
832
833
834
835
836
837
838
839
840
841
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 800

def project_post_with_http_info(file, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentArchiveApi.project_post ...'
  end
  # verify the required parameter 'file' is set
  if @api_client.config.client_side_validation && file.nil?
    fail ArgumentError, "Missing the required parameter 'file' when calling DocumentArchiveApi.project_post"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling DocumentArchiveApi.project_post"
  end
  # resource path
  local_var_path = '/documentArchive/project/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['file'] = file

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResponseWrapperDocumentArchive')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DocumentArchiveApi#project_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#prospect_post(file, id, opts = {}) ⇒ ResponseWrapperDocumentArchive

BETA

Upload file to Prospect Document Archive.

Parameters:

  • file —

    The file

  • id —

    Element ID

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

    the optional parameters

Returns:



848
849
850
851
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 848

def prospect_post(file, id, opts = {})
  data, _status_code, _headers = prospect_post_with_http_info(file, id, opts)
  data
end

#prospect_post_with_http_info(file, id, opts = {}) ⇒ Array<(ResponseWrapperDocumentArchive, Fixnum, Hash)>

BETA

Upload file to Prospect Document Archive.

Parameters:

  • file —

    The file

  • id —

    Element ID

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

    the optional parameters

Returns:



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
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 859

def prospect_post_with_http_info(file, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentArchiveApi.prospect_post ...'
  end
  # verify the required parameter 'file' is set
  if @api_client.config.client_side_validation && file.nil?
    fail ArgumentError, "Missing the required parameter 'file' when calling DocumentArchiveApi.prospect_post"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling DocumentArchiveApi.prospect_post"
  end
  # resource path
  local_var_path = '/documentArchive/prospect/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['file'] = file

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResponseWrapperDocumentArchive')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DocumentArchiveApi#prospect_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put(id, opts = {}) ⇒ ResponseWrapperDocumentArchive

BETA

Update document archive.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :body (DocumentArchive) —

    Partial object describing what should be updated

Returns:



907
908
909
910
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 907

def put(id, opts = {})
  data, _status_code, _headers = put_with_http_info(id, opts)
  data
end

#put_with_http_info(id, opts = {}) ⇒ Array<(ResponseWrapperDocumentArchive, Fixnum, Hash)>

BETA

Update document archive.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :body (DocumentArchive) —

    Partial object describing what should be updated

Returns:



918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 918

def put_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentArchiveApi.put ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling DocumentArchiveApi.put"
  end
  # resource path
  local_var_path = '/documentArchive/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['tokenAuthScheme']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResponseWrapperDocumentArchive')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DocumentArchiveApi#put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#reception_post(file, opts = {}) ⇒ ResponseWrapperDocumentArchive

BETA

Upload a file to the document archive reception. Send as multipart form.

Parameters:

  • file —

    The file

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

    the optional parameters

Returns:



960
961
962
963
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 960

def reception_post(file, opts = {})
  data, _status_code, _headers = reception_post_with_http_info(file, opts)
  data
end

#reception_post_with_http_info(file, opts = {}) ⇒ Array<(ResponseWrapperDocumentArchive, Fixnum, Hash)>

BETA

Upload a file to the document archive reception. Send as multipart form.

Parameters:

  • file —

    The file

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

    the optional parameters

Returns:



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
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 970

def reception_post_with_http_info(file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentArchiveApi.reception_post ...'
  end
  # verify the required parameter 'file' is set
  if @api_client.config.client_side_validation && file.nil?
    fail ArgumentError, "Missing the required parameter 'file' when calling DocumentArchiveApi.reception_post"
  end
  # resource path
  local_var_path = '/documentArchive/reception'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['file'] = file

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResponseWrapperDocumentArchive')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DocumentArchiveApi#reception_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#supplier_post(file, id, opts = {}) ⇒ ResponseWrapperDocumentArchive

BETA

Upload file to Supplier Document Archive.

Parameters:

  • file —

    The file

  • id —

    Element ID

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

    the optional parameters

Returns:



1014
1015
1016
1017
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 1014

def supplier_post(file, id, opts = {})
  data, _status_code, _headers = supplier_post_with_http_info(file, id, opts)
  data
end

#supplier_post_with_http_info(file, id, opts = {}) ⇒ Array<(ResponseWrapperDocumentArchive, Fixnum, Hash)>

BETA

Upload file to Supplier Document Archive.

Parameters:

  • file —

    The file

  • id —

    Element ID

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

    the optional parameters

Returns:



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
 
# File 'lib/tripletex_ruby_client/api/document_archive_api.rb', line 1025

def supplier_post_with_http_info(file, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocumentArchiveApi.supplier_post ...'
  end
  # verify the required parameter 'file' is set
  if @api_client.config.client_side_validation && file.nil?
    fail ArgumentError, "Missing the required parameter 'file' when calling DocumentArchiveApi.supplier_post"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling DocumentArchiveApi.supplier_post"
  end
  # resource path
  local_var_path = '/documentArchive/supplier/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['file'] = file

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResponseWrapperDocumentArchive')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DocumentArchiveApi#supplier_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end