Class: CloudmersiveConvertApiClient::MergeDocumentApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudmersive-convert-api-client/api/merge_document_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MergeDocumentApi

Returns a new instance of MergeDocumentApi.



19
20
21
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_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/cloudmersive-convert-api-client/api/merge_document_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#merge_document_batch_job_create(input, opts = {}) ⇒ MergeBatchJobCreateResult

Merge an array of Documents into a Single Document by Page as a Batch Job Merge an array of Documents (PDF supported), into a single document. This API is designed for large jobs that could take a long time to create and so runs as a batch job that returns a Job ID that you can use with the GetAsyncJobStatus API to check on the status of the Job and ultimately get the output result. This API automatically detects the document type and then performs the split by using the document type-specific API needed to perform the split. This API is only available for Cloudmersive Managed Instance and Private Cloud deployments.

Parameters:

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 27

def merge_document_batch_job_create(input, opts = {})
  data, _status_code, _headers = merge_document_batch_job_create_with_http_info(input, opts)
  data
end

#merge_document_batch_job_create_with_http_info(input, opts = {}) ⇒ Array<(MergeBatchJobCreateResult, Fixnum, Hash)>

Merge an array of Documents into a Single Document by Page as a Batch Job Merge an array of Documents (PDF supported), into a single document. This API is designed for large jobs that could take a long time to create and so runs as a batch job that returns a Job ID that you can use with the GetAsyncJobStatus API to check on the status of the Job and ultimately get the output result. This API automatically detects the document type and then performs the split by using the document type-specific API needed to perform the split. This API is only available for Cloudmersive Managed Instance and Private Cloud deployments.

Parameters:

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

    the optional parameters

Returns:

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

    MergeBatchJobCreateResult data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 37

def merge_document_batch_job_create_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MergeDocumentApi.merge_document_batch_job_create ...'
  end
  # verify the required parameter 'input' is set
  if @api_client.config.client_side_validation && input.nil?
    fail ArgumentError, "Missing the required parameter 'input' when calling MergeDocumentApi.merge_document_batch_job_create"
  end
  # resource path
  local_var_path = '/convert/merge/batch-job/create'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(input)
  auth_names = ['Apikey']
  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 => 'MergeBatchJobCreateResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MergeDocumentApi#merge_document_batch_job_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#merge_document_docx(input_file1, input_file2, opts = {}) ⇒ String

Merge Two Word DOCX Together Combine two Office Word Documents (docx) into one single Office Word document

Parameters:

  • input_file1 —

    First input file to perform the operation on.

  • input_file2 —

    Second input file to perform the operation on (more than 2 can be supplied).

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

    the optional parameters

Returns:

  • (String) 


82
83
84
85
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 82

def merge_document_docx(input_file1, input_file2, opts = {})
  data, _status_code, _headers = merge_document_docx_with_http_info(input_file1, input_file2, opts)
  data
end

#merge_document_docx_multi(input_file1, input_file2, opts = {}) ⇒ String

Merge Multple Word DOCX Together Combine multiple Office Word Documents (docx) into one single Office Word document

Parameters:

  • input_file1 —

    First input file to perform the operation on.

  • input_file2 —

    Second input file to perform the operation on.

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

    the optional parameters

Options Hash (opts):

  • :input_file3 (File) —

    Third input file to perform the operation on.

  • :input_file4 (File) —

    Fourth input file to perform the operation on.

  • :input_file5 (File) —

    Fifth input file to perform the operation on.

  • :input_file6 (File) —

    Sixth input file to perform the operation on.

  • :input_file7 (File) —

    Seventh input file to perform the operation on.

  • :input_file8 (File) —

    Eighth input file to perform the operation on.

  • :input_file9 (File) —

    Ninth input file to perform the operation on.

  • :input_file10 (File) —

    Tenth input file to perform the operation on.

Returns:

  • (String) 


152
153
154
155
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 152

def merge_document_docx_multi(input_file1, input_file2, opts = {})
  data, _status_code, _headers = merge_document_docx_multi_with_http_info(input_file1, input_file2, opts)
  data
end

#merge_document_docx_multi_array(input, opts = {}) ⇒ Object

Merge Multple Word DOCX Together from an array Combine multiple Office Word Documents (docx), stored in an array, into one single Office Word document

Parameters:

  • input —

    Array of input files

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

    the optional parameters

Returns:

  • (Object) 


229
230
231
232
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 229

def merge_document_docx_multi_array(input, opts = {})
  data, _status_code, _headers = merge_document_docx_multi_array_with_http_info(input, opts)
  data
end

#merge_document_docx_multi_array_with_http_info(input, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Merge Multple Word DOCX Together from an array Combine multiple Office Word Documents (docx), stored in an array, into one single Office Word document

Parameters:

  • input —

    Array of input files

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 239

def merge_document_docx_multi_array_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MergeDocumentApi.merge_document_docx_multi_array ...'
  end
  # verify the required parameter 'input' is set
  if @api_client.config.client_side_validation && input.nil?
    fail ArgumentError, "Missing the required parameter 'input' when calling MergeDocumentApi.merge_document_docx_multi_array"
  end
  # resource path
  local_var_path = '/convert/merge/docx/multi/array'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(input)
  auth_names = ['Apikey']
  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 => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MergeDocumentApi#merge_document_docx_multi_array\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#merge_document_docx_multi_with_http_info(input_file1, input_file2, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Merge Multple Word DOCX Together Combine multiple Office Word Documents (docx) into one single Office Word document

Parameters:

  • input_file1 —

    First input file to perform the operation on.

  • input_file2 —

    Second input file to perform the operation on.

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

    the optional parameters

Options Hash (opts):

  • :input_file3 (File) —

    Third input file to perform the operation on.

  • :input_file4 (File) —

    Fourth input file to perform the operation on.

  • :input_file5 (File) —

    Fifth input file to perform the operation on.

  • :input_file6 (File) —

    Sixth input file to perform the operation on.

  • :input_file7 (File) —

    Seventh input file to perform the operation on.

  • :input_file8 (File) —

    Eighth input file to perform the operation on.

  • :input_file9 (File) —

    Ninth input file to perform the operation on.

  • :input_file10 (File) —

    Tenth input file to perform the operation on.

Returns:

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

    String data, response status code and response headers



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 171

def merge_document_docx_multi_with_http_info(input_file1, input_file2, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MergeDocumentApi.merge_document_docx_multi ...'
  end
  # verify the required parameter 'input_file1' is set
  if @api_client.config.client_side_validation && input_file1.nil?
    fail ArgumentError, "Missing the required parameter 'input_file1' when calling MergeDocumentApi.merge_document_docx_multi"
  end
  # verify the required parameter 'input_file2' is set
  if @api_client.config.client_side_validation && input_file2.nil?
    fail ArgumentError, "Missing the required parameter 'input_file2' when calling MergeDocumentApi.merge_document_docx_multi"
  end
  # resource path
  local_var_path = '/convert/merge/docx/multi'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['inputFile1'] = input_file1
  form_params['inputFile2'] = input_file2
  form_params['inputFile3'] = opts[:'input_file3'] if !opts[:'input_file3'].nil?
  form_params['inputFile4'] = opts[:'input_file4'] if !opts[:'input_file4'].nil?
  form_params['inputFile5'] = opts[:'input_file5'] if !opts[:'input_file5'].nil?
  form_params['inputFile6'] = opts[:'input_file6'] if !opts[:'input_file6'].nil?
  form_params['inputFile7'] = opts[:'input_file7'] if !opts[:'input_file7'].nil?
  form_params['inputFile8'] = opts[:'input_file8'] if !opts[:'input_file8'].nil?
  form_params['inputFile9'] = opts[:'input_file9'] if !opts[:'input_file9'].nil?
  form_params['inputFile10'] = opts[:'input_file10'] if !opts[:'input_file10'].nil?

  # http body (model)
  post_body = nil
  auth_names = ['Apikey']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MergeDocumentApi#merge_document_docx_multi\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#merge_document_docx_with_http_info(input_file1, input_file2, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Merge Two Word DOCX Together Combine two Office Word Documents (docx) into one single Office Word document

Parameters:

  • input_file1 —

    First input file to perform the operation on.

  • input_file2 —

    Second input file to perform the operation on (more than 2 can be supplied).

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



93
94
95
96
97
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
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 93

def merge_document_docx_with_http_info(input_file1, input_file2, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MergeDocumentApi.merge_document_docx ...'
  end
  # verify the required parameter 'input_file1' is set
  if @api_client.config.client_side_validation && input_file1.nil?
    fail ArgumentError, "Missing the required parameter 'input_file1' when calling MergeDocumentApi.merge_document_docx"
  end
  # verify the required parameter 'input_file2' is set
  if @api_client.config.client_side_validation && input_file2.nil?
    fail ArgumentError, "Missing the required parameter 'input_file2' when calling MergeDocumentApi.merge_document_docx"
  end
  # resource path
  local_var_path = '/convert/merge/docx'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['inputFile1'] = input_file1
  form_params['inputFile2'] = input_file2

  # http body (model)
  post_body = nil
  auth_names = ['Apikey']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MergeDocumentApi#merge_document_docx\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#merge_document_get_async_job_status(async_job_id, opts = {}) ⇒ MergeJobStatusResult

Get the status and result of a Merge Document Batch Job Returns the result of the Async Job - possible states can be STARTED or COMPLETED. This API is only available for Cloudmersive Managed Instance and Private Cloud deployments.

Parameters:

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

    the optional parameters

Returns:



283
284
285
286
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 283

def merge_document_get_async_job_status(async_job_id, opts = {})
  data, _status_code, _headers = merge_document_get_async_job_status_with_http_info(async_job_id, opts)
  data
end

#merge_document_get_async_job_status_with_http_info(async_job_id, opts = {}) ⇒ Array<(MergeJobStatusResult, Fixnum, Hash)>

Get the status and result of a Merge Document Batch Job Returns the result of the Async Job - possible states can be STARTED or COMPLETED. This API is only available for Cloudmersive Managed Instance and Private Cloud deployments.

Parameters:

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

    the optional parameters

Returns:

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

    MergeJobStatusResult data, response status code and response headers



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
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 293

def merge_document_get_async_job_status_with_http_info(async_job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MergeDocumentApi.merge_document_get_async_job_status ...'
  end
  # verify the required parameter 'async_job_id' is set
  if @api_client.config.client_side_validation && async_job_id.nil?
    fail ArgumentError, "Missing the required parameter 'async_job_id' when calling MergeDocumentApi.merge_document_get_async_job_status"
  end
  # resource path
  local_var_path = '/convert/merge/batch-job/status'

  # query parameters
  query_params = {}
  query_params[:'AsyncJobID'] = async_job_id

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['Apikey']
  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 => 'MergeJobStatusResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MergeDocumentApi#merge_document_get_async_job_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#merge_document_html(input_file1, input_file2, opts = {}) ⇒ String

Merge Two HTML (HTM) Files Together Combine two HTML (.HTM) files into a single text document, preserving the order of the input documents in the combined document by stacking them vertically. The title will be taken from the first document.

Parameters:

  • input_file1 —

    First input file to perform the operation on.

  • input_file2 —

    Second input file to perform the operation on (more than 2 can be supplied).

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

    the optional parameters

Returns:

  • (String) 


337
338
339
340
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 337

def merge_document_html(input_file1, input_file2, opts = {})
  data, _status_code, _headers = merge_document_html_with_http_info(input_file1, input_file2, opts)
  data
end

#merge_document_html_multi(input_file1, input_file2, opts = {}) ⇒ String

Merge Multple HTML (HTM) Files Together Combine multiple HTML (.HTM) files into a single text document, preserving the order of the input documents in the combined document by stacking them vertically. The title will be taken from the first document.

Parameters:

  • input_file1 —

    First input file to perform the operation on.

  • input_file2 —

    Second input file to perform the operation on.

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

    the optional parameters

Options Hash (opts):

  • :input_file3 (File) —

    Third input file to perform the operation on.

  • :input_file4 (File) —

    Fourth input file to perform the operation on.

  • :input_file5 (File) —

    Fifth input file to perform the operation on.

  • :input_file6 (File) —

    Sixth input file to perform the operation on.

  • :input_file7 (File) —

    Seventh input file to perform the operation on.

  • :input_file8 (File) —

    Eighth input file to perform the operation on.

  • :input_file9 (File) —

    Ninth input file to perform the operation on.

  • :input_file10 (File) —

    Tenth input file to perform the operation on.

Returns:

  • (String) 


407
408
409
410
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 407

def merge_document_html_multi(input_file1, input_file2, opts = {})
  data, _status_code, _headers = merge_document_html_multi_with_http_info(input_file1, input_file2, opts)
  data
end

#merge_document_html_multi_array(input, opts = {}) ⇒ Object

Merge Multple HTML (HTM) Files Together from an array Combine multiple HTML (.HTM) files, from an array, into a single text document, preserving the order of the input documents in the combined document by stacking them vertically. The title will be taken from the first document.

Parameters:

  • input —

    Array of input files

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

    the optional parameters

Returns:

  • (Object) 


484
485
486
487
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 484

def merge_document_html_multi_array(input, opts = {})
  data, _status_code, _headers = merge_document_html_multi_array_with_http_info(input, opts)
  data
end

#merge_document_html_multi_array_with_http_info(input, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Merge Multple HTML (HTM) Files Together from an array Combine multiple HTML (.HTM) files, from an array, into a single text document, preserving the order of the input documents in the combined document by stacking them vertically. The title will be taken from the first document.

Parameters:

  • input —

    Array of input files

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 494

def merge_document_html_multi_array_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MergeDocumentApi.merge_document_html_multi_array ...'
  end
  # verify the required parameter 'input' is set
  if @api_client.config.client_side_validation && input.nil?
    fail ArgumentError, "Missing the required parameter 'input' when calling MergeDocumentApi.merge_document_html_multi_array"
  end
  # resource path
  local_var_path = '/convert/merge/html/multi/array'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(input)
  auth_names = ['Apikey']
  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 => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MergeDocumentApi#merge_document_html_multi_array\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#merge_document_html_multi_with_http_info(input_file1, input_file2, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Merge Multple HTML (HTM) Files Together Combine multiple HTML (.HTM) files into a single text document, preserving the order of the input documents in the combined document by stacking them vertically. The title will be taken from the first document.

Parameters:

  • input_file1 —

    First input file to perform the operation on.

  • input_file2 —

    Second input file to perform the operation on.

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

    the optional parameters

Options Hash (opts):

  • :input_file3 (File) —

    Third input file to perform the operation on.

  • :input_file4 (File) —

    Fourth input file to perform the operation on.

  • :input_file5 (File) —

    Fifth input file to perform the operation on.

  • :input_file6 (File) —

    Sixth input file to perform the operation on.

  • :input_file7 (File) —

    Seventh input file to perform the operation on.

  • :input_file8 (File) —

    Eighth input file to perform the operation on.

  • :input_file9 (File) —

    Ninth input file to perform the operation on.

  • :input_file10 (File) —

    Tenth input file to perform the operation on.

Returns:

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

    String data, response status code and response headers



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 426

def merge_document_html_multi_with_http_info(input_file1, input_file2, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MergeDocumentApi.merge_document_html_multi ...'
  end
  # verify the required parameter 'input_file1' is set
  if @api_client.config.client_side_validation && input_file1.nil?
    fail ArgumentError, "Missing the required parameter 'input_file1' when calling MergeDocumentApi.merge_document_html_multi"
  end
  # verify the required parameter 'input_file2' is set
  if @api_client.config.client_side_validation && input_file2.nil?
    fail ArgumentError, "Missing the required parameter 'input_file2' when calling MergeDocumentApi.merge_document_html_multi"
  end
  # resource path
  local_var_path = '/convert/merge/html/multi'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['inputFile1'] = input_file1
  form_params['inputFile2'] = input_file2
  form_params['inputFile3'] = opts[:'input_file3'] if !opts[:'input_file3'].nil?
  form_params['inputFile4'] = opts[:'input_file4'] if !opts[:'input_file4'].nil?
  form_params['inputFile5'] = opts[:'input_file5'] if !opts[:'input_file5'].nil?
  form_params['inputFile6'] = opts[:'input_file6'] if !opts[:'input_file6'].nil?
  form_params['inputFile7'] = opts[:'input_file7'] if !opts[:'input_file7'].nil?
  form_params['inputFile8'] = opts[:'input_file8'] if !opts[:'input_file8'].nil?
  form_params['inputFile9'] = opts[:'input_file9'] if !opts[:'input_file9'].nil?
  form_params['inputFile10'] = opts[:'input_file10'] if !opts[:'input_file10'].nil?

  # http body (model)
  post_body = nil
  auth_names = ['Apikey']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MergeDocumentApi#merge_document_html_multi\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#merge_document_html_with_http_info(input_file1, input_file2, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Merge Two HTML (HTM) Files Together Combine two HTML (.HTM) files into a single text document, preserving the order of the input documents in the combined document by stacking them vertically. The title will be taken from the first document.

Parameters:

  • input_file1 —

    First input file to perform the operation on.

  • input_file2 —

    Second input file to perform the operation on (more than 2 can be supplied).

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 348

def merge_document_html_with_http_info(input_file1, input_file2, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MergeDocumentApi.merge_document_html ...'
  end
  # verify the required parameter 'input_file1' is set
  if @api_client.config.client_side_validation && input_file1.nil?
    fail ArgumentError, "Missing the required parameter 'input_file1' when calling MergeDocumentApi.merge_document_html"
  end
  # verify the required parameter 'input_file2' is set
  if @api_client.config.client_side_validation && input_file2.nil?
    fail ArgumentError, "Missing the required parameter 'input_file2' when calling MergeDocumentApi.merge_document_html"
  end
  # resource path
  local_var_path = '/convert/merge/html'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['inputFile1'] = input_file1
  form_params['inputFile2'] = input_file2

  # http body (model)
  post_body = nil
  auth_names = ['Apikey']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MergeDocumentApi#merge_document_html\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#merge_document_pdf(input_file1, input_file2, opts = {}) ⇒ String

Merge Two PDF Files Together Combine two PDF files (pdf) into a single PDF document, preserving the order of the input documents in the combined document

Parameters:

  • input_file1 —

    First input file to perform the operation on.

  • input_file2 —

    Second input file to perform the operation on (more than 2 can be supplied).

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

    the optional parameters

Returns:

  • (String) 


539
540
541
542
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 539

def merge_document_pdf(input_file1, input_file2, opts = {})
  data, _status_code, _headers = merge_document_pdf_with_http_info(input_file1, input_file2, opts)
  data
end

#merge_document_pdf_multi(input_file1, input_file2, opts = {}) ⇒ String

Merge Multple PDF Files Together Combine multiple PDF files (pdf) into a single PDF document, preserving the order of the input documents in the combined document

Parameters:

  • input_file1 —

    First input file to perform the operation on.

  • input_file2 —

    Second input file to perform the operation on.

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

    the optional parameters

Options Hash (opts):

  • :input_file3 (File) —

    Third input file to perform the operation on.

  • :input_file4 (File) —

    Fourth input file to perform the operation on.

  • :input_file5 (File) —

    Fifth input file to perform the operation on.

  • :input_file6 (File) —

    Sixth input file to perform the operation on.

  • :input_file7 (File) —

    Seventh input file to perform the operation on.

  • :input_file8 (File) —

    Eighth input file to perform the operation on.

  • :input_file9 (File) —

    Ninth input file to perform the operation on.

  • :input_file10 (File) —

    Tenth input file to perform the operation on.

Returns:

  • (String) 


609
610
611
612
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 609

def merge_document_pdf_multi(input_file1, input_file2, opts = {})
  data, _status_code, _headers = merge_document_pdf_multi_with_http_info(input_file1, input_file2, opts)
  data
end

#merge_document_pdf_multi_array(input, opts = {}) ⇒ Object

Merge Multple PDF Files Together from an array Combine multiple PDF files (pdf), as an array, into a single PDF document, preserving the order of the input documents in the combined document

Parameters:

  • input —

    Array of input files

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

    the optional parameters

Returns:

  • (Object) 


686
687
688
689
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 686

def merge_document_pdf_multi_array(input, opts = {})
  data, _status_code, _headers = merge_document_pdf_multi_array_with_http_info(input, opts)
  data
end

#merge_document_pdf_multi_array_with_http_info(input, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Merge Multple PDF Files Together from an array Combine multiple PDF files (pdf), as an array, into a single PDF document, preserving the order of the input documents in the combined document

Parameters:

  • input —

    Array of input files

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 696

def merge_document_pdf_multi_array_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MergeDocumentApi.merge_document_pdf_multi_array ...'
  end
  # verify the required parameter 'input' is set
  if @api_client.config.client_side_validation && input.nil?
    fail ArgumentError, "Missing the required parameter 'input' when calling MergeDocumentApi.merge_document_pdf_multi_array"
  end
  # resource path
  local_var_path = '/convert/merge/pdf/multi/array'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(input)
  auth_names = ['Apikey']
  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 => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MergeDocumentApi#merge_document_pdf_multi_array\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#merge_document_pdf_multi_with_http_info(input_file1, input_file2, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Merge Multple PDF Files Together Combine multiple PDF files (pdf) into a single PDF document, preserving the order of the input documents in the combined document

Parameters:

  • input_file1 —

    First input file to perform the operation on.

  • input_file2 —

    Second input file to perform the operation on.

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

    the optional parameters

Options Hash (opts):

  • :input_file3 (File) —

    Third input file to perform the operation on.

  • :input_file4 (File) —

    Fourth input file to perform the operation on.

  • :input_file5 (File) —

    Fifth input file to perform the operation on.

  • :input_file6 (File) —

    Sixth input file to perform the operation on.

  • :input_file7 (File) —

    Seventh input file to perform the operation on.

  • :input_file8 (File) —

    Eighth input file to perform the operation on.

  • :input_file9 (File) —

    Ninth input file to perform the operation on.

  • :input_file10 (File) —

    Tenth input file to perform the operation on.

Returns:

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

    String data, response status code and response headers



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 628

def merge_document_pdf_multi_with_http_info(input_file1, input_file2, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MergeDocumentApi.merge_document_pdf_multi ...'
  end
  # verify the required parameter 'input_file1' is set
  if @api_client.config.client_side_validation && input_file1.nil?
    fail ArgumentError, "Missing the required parameter 'input_file1' when calling MergeDocumentApi.merge_document_pdf_multi"
  end
  # verify the required parameter 'input_file2' is set
  if @api_client.config.client_side_validation && input_file2.nil?
    fail ArgumentError, "Missing the required parameter 'input_file2' when calling MergeDocumentApi.merge_document_pdf_multi"
  end
  # resource path
  local_var_path = '/convert/merge/pdf/multi'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['inputFile1'] = input_file1
  form_params['inputFile2'] = input_file2
  form_params['inputFile3'] = opts[:'input_file3'] if !opts[:'input_file3'].nil?
  form_params['inputFile4'] = opts[:'input_file4'] if !opts[:'input_file4'].nil?
  form_params['inputFile5'] = opts[:'input_file5'] if !opts[:'input_file5'].nil?
  form_params['inputFile6'] = opts[:'input_file6'] if !opts[:'input_file6'].nil?
  form_params['inputFile7'] = opts[:'input_file7'] if !opts[:'input_file7'].nil?
  form_params['inputFile8'] = opts[:'input_file8'] if !opts[:'input_file8'].nil?
  form_params['inputFile9'] = opts[:'input_file9'] if !opts[:'input_file9'].nil?
  form_params['inputFile10'] = opts[:'input_file10'] if !opts[:'input_file10'].nil?

  # http body (model)
  post_body = nil
  auth_names = ['Apikey']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MergeDocumentApi#merge_document_pdf_multi\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#merge_document_pdf_with_http_info(input_file1, input_file2, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Merge Two PDF Files Together Combine two PDF files (pdf) into a single PDF document, preserving the order of the input documents in the combined document

Parameters:

  • input_file1 —

    First input file to perform the operation on.

  • input_file2 —

    Second input file to perform the operation on (more than 2 can be supplied).

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 550

def merge_document_pdf_with_http_info(input_file1, input_file2, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MergeDocumentApi.merge_document_pdf ...'
  end
  # verify the required parameter 'input_file1' is set
  if @api_client.config.client_side_validation && input_file1.nil?
    fail ArgumentError, "Missing the required parameter 'input_file1' when calling MergeDocumentApi.merge_document_pdf"
  end
  # verify the required parameter 'input_file2' is set
  if @api_client.config.client_side_validation && input_file2.nil?
    fail ArgumentError, "Missing the required parameter 'input_file2' when calling MergeDocumentApi.merge_document_pdf"
  end
  # resource path
  local_var_path = '/convert/merge/pdf'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['inputFile1'] = input_file1
  form_params['inputFile2'] = input_file2

  # http body (model)
  post_body = nil
  auth_names = ['Apikey']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MergeDocumentApi#merge_document_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#merge_document_png(input_file1, input_file2, opts = {}) ⇒ String

Merge Two PNG Files Together Combine two PNG files into a single PNG document, preserving the order of the input documents in the combined document by stacking them vertically

Parameters:

  • input_file1 —

    First input file to perform the operation on.

  • input_file2 —

    Second input file to perform the operation on (more than 2 can be supplied).

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

    the optional parameters

Returns:

  • (String) 


741
742
743
744
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 741

def merge_document_png(input_file1, input_file2, opts = {})
  data, _status_code, _headers = merge_document_png_with_http_info(input_file1, input_file2, opts)
  data
end

#merge_document_png_multi(input_file1, input_file2, opts = {}) ⇒ String

Merge Multple PNG Files Together Combine multiple PNG files into a single PNG document, preserving the order of the input documents in the combined document by stacking them vertically

Parameters:

  • input_file1 —

    First input file to perform the operation on.

  • input_file2 —

    Second input file to perform the operation on.

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

    the optional parameters

Options Hash (opts):

  • :input_file3 (File) —

    Third input file to perform the operation on.

  • :input_file4 (File) —

    Fourth input file to perform the operation on.

  • :input_file5 (File) —

    Fifth input file to perform the operation on.

  • :input_file6 (File) —

    Sixth input file to perform the operation on.

  • :input_file7 (File) —

    Seventh input file to perform the operation on.

  • :input_file8 (File) —

    Eighth input file to perform the operation on.

  • :input_file9 (File) —

    Ninth input file to perform the operation on.

  • :input_file10 (File) —

    Tenth input file to perform the operation on.

Returns:

  • (String) 


811
812
813
814
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 811

def merge_document_png_multi(input_file1, input_file2, opts = {})
  data, _status_code, _headers = merge_document_png_multi_with_http_info(input_file1, input_file2, opts)
  data
end

#merge_document_png_multi_array(input, opts = {}) ⇒ Object

Merge Multple PNG Files Together from an array Combine multiple PNG files, from an array, into a single PNG document, preserving the order of the input documents in the combined document by stacking them vertically

Parameters:

  • input —

    Array of input files

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

    the optional parameters

Returns:

  • (Object) 


888
889
890
891
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 888

def merge_document_png_multi_array(input, opts = {})
  data, _status_code, _headers = merge_document_png_multi_array_with_http_info(input, opts)
  data
end

#merge_document_png_multi_array_with_http_info(input, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Merge Multple PNG Files Together from an array Combine multiple PNG files, from an array, into a single PNG document, preserving the order of the input documents in the combined document by stacking them vertically

Parameters:

  • input —

    Array of input files

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 898

def merge_document_png_multi_array_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MergeDocumentApi.merge_document_png_multi_array ...'
  end
  # verify the required parameter 'input' is set
  if @api_client.config.client_side_validation && input.nil?
    fail ArgumentError, "Missing the required parameter 'input' when calling MergeDocumentApi.merge_document_png_multi_array"
  end
  # resource path
  local_var_path = '/convert/merge/png/vertical/multi/array'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(input)
  auth_names = ['Apikey']
  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 => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MergeDocumentApi#merge_document_png_multi_array\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#merge_document_png_multi_with_http_info(input_file1, input_file2, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Merge Multple PNG Files Together Combine multiple PNG files into a single PNG document, preserving the order of the input documents in the combined document by stacking them vertically

Parameters:

  • input_file1 —

    First input file to perform the operation on.

  • input_file2 —

    Second input file to perform the operation on.

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

    the optional parameters

Options Hash (opts):

  • :input_file3 (File) —

    Third input file to perform the operation on.

  • :input_file4 (File) —

    Fourth input file to perform the operation on.

  • :input_file5 (File) —

    Fifth input file to perform the operation on.

  • :input_file6 (File) —

    Sixth input file to perform the operation on.

  • :input_file7 (File) —

    Seventh input file to perform the operation on.

  • :input_file8 (File) —

    Eighth input file to perform the operation on.

  • :input_file9 (File) —

    Ninth input file to perform the operation on.

  • :input_file10 (File) —

    Tenth input file to perform the operation on.

Returns:

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

    String data, response status code and response headers



830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 830

def merge_document_png_multi_with_http_info(input_file1, input_file2, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MergeDocumentApi.merge_document_png_multi ...'
  end
  # verify the required parameter 'input_file1' is set
  if @api_client.config.client_side_validation && input_file1.nil?
    fail ArgumentError, "Missing the required parameter 'input_file1' when calling MergeDocumentApi.merge_document_png_multi"
  end
  # verify the required parameter 'input_file2' is set
  if @api_client.config.client_side_validation && input_file2.nil?
    fail ArgumentError, "Missing the required parameter 'input_file2' when calling MergeDocumentApi.merge_document_png_multi"
  end
  # resource path
  local_var_path = '/convert/merge/png/vertical/multi'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['inputFile1'] = input_file1
  form_params['inputFile2'] = input_file2
  form_params['inputFile3'] = opts[:'input_file3'] if !opts[:'input_file3'].nil?
  form_params['inputFile4'] = opts[:'input_file4'] if !opts[:'input_file4'].nil?
  form_params['inputFile5'] = opts[:'input_file5'] if !opts[:'input_file5'].nil?
  form_params['inputFile6'] = opts[:'input_file6'] if !opts[:'input_file6'].nil?
  form_params['inputFile7'] = opts[:'input_file7'] if !opts[:'input_file7'].nil?
  form_params['inputFile8'] = opts[:'input_file8'] if !opts[:'input_file8'].nil?
  form_params['inputFile9'] = opts[:'input_file9'] if !opts[:'input_file9'].nil?
  form_params['inputFile10'] = opts[:'input_file10'] if !opts[:'input_file10'].nil?

  # http body (model)
  post_body = nil
  auth_names = ['Apikey']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MergeDocumentApi#merge_document_png_multi\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#merge_document_png_with_http_info(input_file1, input_file2, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Merge Two PNG Files Together Combine two PNG files into a single PNG document, preserving the order of the input documents in the combined document by stacking them vertically

Parameters:

  • input_file1 —

    First input file to perform the operation on.

  • input_file2 —

    Second input file to perform the operation on (more than 2 can be supplied).

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 752

def merge_document_png_with_http_info(input_file1, input_file2, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MergeDocumentApi.merge_document_png ...'
  end
  # verify the required parameter 'input_file1' is set
  if @api_client.config.client_side_validation && input_file1.nil?
    fail ArgumentError, "Missing the required parameter 'input_file1' when calling MergeDocumentApi.merge_document_png"
  end
  # verify the required parameter 'input_file2' is set
  if @api_client.config.client_side_validation && input_file2.nil?
    fail ArgumentError, "Missing the required parameter 'input_file2' when calling MergeDocumentApi.merge_document_png"
  end
  # resource path
  local_var_path = '/convert/merge/png/vertical'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['inputFile1'] = input_file1
  form_params['inputFile2'] = input_file2

  # http body (model)
  post_body = nil
  auth_names = ['Apikey']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MergeDocumentApi#merge_document_png\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#merge_document_pptx(input_file1, input_file2, opts = {}) ⇒ String

Merge Two PowerPoint PPTX Together Combine two Office PowerPoint presentations (pptx) into one single Office PowerPoint presentation

Parameters:

  • input_file1 —

    First input file to perform the operation on.

  • input_file2 —

    Second input file to perform the operation on (more than 2 can be supplied).

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

    the optional parameters

Returns:

  • (String) 


943
944
945
946
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 943

def merge_document_pptx(input_file1, input_file2, opts = {})
  data, _status_code, _headers = merge_document_pptx_with_http_info(input_file1, input_file2, opts)
  data
end

#merge_document_pptx_multi(input_file1, input_file2, opts = {}) ⇒ String

Merge Multple PowerPoint PPTX Together Combine multiple Office PowerPoint presentations (pptx) into one single Office PowerPoint presentation

Parameters:

  • input_file1 —

    First input file to perform the operation on.

  • input_file2 —

    Second input file to perform the operation on.

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

    the optional parameters

Options Hash (opts):

  • :input_file3 (File) —

    Third input file to perform the operation on.

  • :input_file4 (File) —

    Fourth input file to perform the operation on.

  • :input_file5 (File) —

    Fifth input file to perform the operation on.

  • :input_file6 (File) —

    Sixth input file to perform the operation on.

  • :input_file7 (File) —

    Seventh input file to perform the operation on.

  • :input_file8 (File) —

    Eighth input file to perform the operation on.

  • :input_file9 (File) —

    Ninth input file to perform the operation on.

  • :input_file10 (File) —

    Tenth input file to perform the operation on.

Returns:

  • (String) 


1013
1014
1015
1016
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 1013

def merge_document_pptx_multi(input_file1, input_file2, opts = {})
  data, _status_code, _headers = merge_document_pptx_multi_with_http_info(input_file1, input_file2, opts)
  data
end

#merge_document_pptx_multi_array(input, opts = {}) ⇒ Object

Merge Multple PowerPoint PPTX Together from an array Combine multiple Office PowerPoint presentations (pptx), from an array, into one single Office PowerPoint presentation

Parameters:

  • input —

    Array of input files

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

    the optional parameters

Returns:

  • (Object) 


1090
1091
1092
1093
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 1090

def merge_document_pptx_multi_array(input, opts = {})
  data, _status_code, _headers = merge_document_pptx_multi_array_with_http_info(input, opts)
  data
end

#merge_document_pptx_multi_array_with_http_info(input, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Merge Multple PowerPoint PPTX Together from an array Combine multiple Office PowerPoint presentations (pptx), from an array, into one single Office PowerPoint presentation

Parameters:

  • input —

    Array of input files

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 1100

def merge_document_pptx_multi_array_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MergeDocumentApi.merge_document_pptx_multi_array ...'
  end
  # verify the required parameter 'input' is set
  if @api_client.config.client_side_validation && input.nil?
    fail ArgumentError, "Missing the required parameter 'input' when calling MergeDocumentApi.merge_document_pptx_multi_array"
  end
  # resource path
  local_var_path = '/convert/merge/pptx/multi/array'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(input)
  auth_names = ['Apikey']
  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 => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MergeDocumentApi#merge_document_pptx_multi_array\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#merge_document_pptx_multi_with_http_info(input_file1, input_file2, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Merge Multple PowerPoint PPTX Together Combine multiple Office PowerPoint presentations (pptx) into one single Office PowerPoint presentation

Parameters:

  • input_file1 —

    First input file to perform the operation on.

  • input_file2 —

    Second input file to perform the operation on.

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

    the optional parameters

Options Hash (opts):

  • :input_file3 (File) —

    Third input file to perform the operation on.

  • :input_file4 (File) —

    Fourth input file to perform the operation on.

  • :input_file5 (File) —

    Fifth input file to perform the operation on.

  • :input_file6 (File) —

    Sixth input file to perform the operation on.

  • :input_file7 (File) —

    Seventh input file to perform the operation on.

  • :input_file8 (File) —

    Eighth input file to perform the operation on.

  • :input_file9 (File) —

    Ninth input file to perform the operation on.

  • :input_file10 (File) —

    Tenth input file to perform the operation on.

Returns:

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

    String data, response status code and response headers



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
1076
1077
1078
1079
1080
1081
1082
1083
1084
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 1032

def merge_document_pptx_multi_with_http_info(input_file1, input_file2, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MergeDocumentApi.merge_document_pptx_multi ...'
  end
  # verify the required parameter 'input_file1' is set
  if @api_client.config.client_side_validation && input_file1.nil?
    fail ArgumentError, "Missing the required parameter 'input_file1' when calling MergeDocumentApi.merge_document_pptx_multi"
  end
  # verify the required parameter 'input_file2' is set
  if @api_client.config.client_side_validation && input_file2.nil?
    fail ArgumentError, "Missing the required parameter 'input_file2' when calling MergeDocumentApi.merge_document_pptx_multi"
  end
  # resource path
  local_var_path = '/convert/merge/pptx/multi'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['inputFile1'] = input_file1
  form_params['inputFile2'] = input_file2
  form_params['inputFile3'] = opts[:'input_file3'] if !opts[:'input_file3'].nil?
  form_params['inputFile4'] = opts[:'input_file4'] if !opts[:'input_file4'].nil?
  form_params['inputFile5'] = opts[:'input_file5'] if !opts[:'input_file5'].nil?
  form_params['inputFile6'] = opts[:'input_file6'] if !opts[:'input_file6'].nil?
  form_params['inputFile7'] = opts[:'input_file7'] if !opts[:'input_file7'].nil?
  form_params['inputFile8'] = opts[:'input_file8'] if !opts[:'input_file8'].nil?
  form_params['inputFile9'] = opts[:'input_file9'] if !opts[:'input_file9'].nil?
  form_params['inputFile10'] = opts[:'input_file10'] if !opts[:'input_file10'].nil?

  # http body (model)
  post_body = nil
  auth_names = ['Apikey']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MergeDocumentApi#merge_document_pptx_multi\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#merge_document_pptx_with_http_info(input_file1, input_file2, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Merge Two PowerPoint PPTX Together Combine two Office PowerPoint presentations (pptx) into one single Office PowerPoint presentation

Parameters:

  • input_file1 —

    First input file to perform the operation on.

  • input_file2 —

    Second input file to perform the operation on (more than 2 can be supplied).

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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
998
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 954

def merge_document_pptx_with_http_info(input_file1, input_file2, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MergeDocumentApi.merge_document_pptx ...'
  end
  # verify the required parameter 'input_file1' is set
  if @api_client.config.client_side_validation && input_file1.nil?
    fail ArgumentError, "Missing the required parameter 'input_file1' when calling MergeDocumentApi.merge_document_pptx"
  end
  # verify the required parameter 'input_file2' is set
  if @api_client.config.client_side_validation && input_file2.nil?
    fail ArgumentError, "Missing the required parameter 'input_file2' when calling MergeDocumentApi.merge_document_pptx"
  end
  # resource path
  local_var_path = '/convert/merge/pptx'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['inputFile1'] = input_file1
  form_params['inputFile2'] = input_file2

  # http body (model)
  post_body = nil
  auth_names = ['Apikey']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MergeDocumentApi#merge_document_pptx\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#merge_document_txt(input_file1, input_file2, opts = {}) ⇒ Object

Merge Two Text (TXT) Files Together Combine two Text (.TXT) files into a single text document, preserving the order of the input documents in the combined document by stacking them vertically.

Parameters:

  • input_file1 —

    First input file to perform the operation on.

  • input_file2 —

    Second input file to perform the operation on (more than 2 can be supplied).

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

    the optional parameters

Returns:

  • (Object) 


1145
1146
1147
1148
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 1145

def merge_document_txt(input_file1, input_file2, opts = {})
  data, _status_code, _headers = merge_document_txt_with_http_info(input_file1, input_file2, opts)
  data
end

#merge_document_txt_multi(input_file1, input_file2, opts = {}) ⇒ String

Merge Multple Text (TXT) Files Together Combine multiple Text (.TXT) files into a single text document, preserving the order of the input documents in the combined document by stacking them vertically.

Parameters:

  • input_file1 —

    First input file to perform the operation on.

  • input_file2 —

    Second input file to perform the operation on.

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

    the optional parameters

Options Hash (opts):

  • :input_file3 (File) —

    Third input file to perform the operation on.

  • :input_file4 (File) —

    Fourth input file to perform the operation on.

  • :input_file5 (File) —

    Fifth input file to perform the operation on.

  • :input_file6 (File) —

    Sixth input file to perform the operation on.

  • :input_file7 (File) —

    Seventh input file to perform the operation on.

  • :input_file8 (File) —

    Eighth input file to perform the operation on.

  • :input_file9 (File) —

    Ninth input file to perform the operation on.

  • :input_file10 (File) —

    Tenth input file to perform the operation on.

Returns:

  • (String) 


1215
1216
1217
1218
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 1215

def merge_document_txt_multi(input_file1, input_file2, opts = {})
  data, _status_code, _headers = merge_document_txt_multi_with_http_info(input_file1, input_file2, opts)
  data
end

#merge_document_txt_multi_with_http_info(input_file1, input_file2, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Merge Multple Text (TXT) Files Together Combine multiple Text (.TXT) files into a single text document, preserving the order of the input documents in the combined document by stacking them vertically.

Parameters:

  • input_file1 —

    First input file to perform the operation on.

  • input_file2 —

    Second input file to perform the operation on.

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

    the optional parameters

Options Hash (opts):

  • :input_file3 (File) —

    Third input file to perform the operation on.

  • :input_file4 (File) —

    Fourth input file to perform the operation on.

  • :input_file5 (File) —

    Fifth input file to perform the operation on.

  • :input_file6 (File) —

    Sixth input file to perform the operation on.

  • :input_file7 (File) —

    Seventh input file to perform the operation on.

  • :input_file8 (File) —

    Eighth input file to perform the operation on.

  • :input_file9 (File) —

    Ninth input file to perform the operation on.

  • :input_file10 (File) —

    Tenth input file to perform the operation on.

Returns:

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

    String data, response status code and response headers



1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 1234

def merge_document_txt_multi_with_http_info(input_file1, input_file2, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MergeDocumentApi.merge_document_txt_multi ...'
  end
  # verify the required parameter 'input_file1' is set
  if @api_client.config.client_side_validation && input_file1.nil?
    fail ArgumentError, "Missing the required parameter 'input_file1' when calling MergeDocumentApi.merge_document_txt_multi"
  end
  # verify the required parameter 'input_file2' is set
  if @api_client.config.client_side_validation && input_file2.nil?
    fail ArgumentError, "Missing the required parameter 'input_file2' when calling MergeDocumentApi.merge_document_txt_multi"
  end
  # resource path
  local_var_path = '/convert/merge/txt/multi'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['inputFile1'] = input_file1
  form_params['inputFile2'] = input_file2
  form_params['inputFile3'] = opts[:'input_file3'] if !opts[:'input_file3'].nil?
  form_params['inputFile4'] = opts[:'input_file4'] if !opts[:'input_file4'].nil?
  form_params['inputFile5'] = opts[:'input_file5'] if !opts[:'input_file5'].nil?
  form_params['inputFile6'] = opts[:'input_file6'] if !opts[:'input_file6'].nil?
  form_params['inputFile7'] = opts[:'input_file7'] if !opts[:'input_file7'].nil?
  form_params['inputFile8'] = opts[:'input_file8'] if !opts[:'input_file8'].nil?
  form_params['inputFile9'] = opts[:'input_file9'] if !opts[:'input_file9'].nil?
  form_params['inputFile10'] = opts[:'input_file10'] if !opts[:'input_file10'].nil?

  # http body (model)
  post_body = nil
  auth_names = ['Apikey']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MergeDocumentApi#merge_document_txt_multi\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#merge_document_txt_with_http_info(input_file1, input_file2, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Merge Two Text (TXT) Files Together Combine two Text (.TXT) files into a single text document, preserving the order of the input documents in the combined document by stacking them vertically.

Parameters:

  • input_file1 —

    First input file to perform the operation on.

  • input_file2 —

    Second input file to perform the operation on (more than 2 can be supplied).

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 1156

def merge_document_txt_with_http_info(input_file1, input_file2, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MergeDocumentApi.merge_document_txt ...'
  end
  # verify the required parameter 'input_file1' is set
  if @api_client.config.client_side_validation && input_file1.nil?
    fail ArgumentError, "Missing the required parameter 'input_file1' when calling MergeDocumentApi.merge_document_txt"
  end
  # verify the required parameter 'input_file2' is set
  if @api_client.config.client_side_validation && input_file2.nil?
    fail ArgumentError, "Missing the required parameter 'input_file2' when calling MergeDocumentApi.merge_document_txt"
  end
  # resource path
  local_var_path = '/convert/merge/txt'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['inputFile1'] = input_file1
  form_params['inputFile2'] = input_file2

  # http body (model)
  post_body = nil
  auth_names = ['Apikey']
  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 => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MergeDocumentApi#merge_document_txt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#merge_document_xlsx(input_file1, input_file2, opts = {}) ⇒ String

Merge Two Excel XLSX Together Combine two Office Excel spreadsheets (xlsx) into a single Office Excel spreadsheet

Parameters:

  • input_file1 —

    First input file to perform the operation on.

  • input_file2 —

    Second input file to perform the operation on (more than 2 can be supplied).

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

    the optional parameters

Returns:

  • (String) 


1293
1294
1295
1296
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 1293

def merge_document_xlsx(input_file1, input_file2, opts = {})
  data, _status_code, _headers = merge_document_xlsx_with_http_info(input_file1, input_file2, opts)
  data
end

#merge_document_xlsx_multi(input_file1, input_file2, opts = {}) ⇒ String

Merge Multple Excel XLSX Together Combine multiple Office Excel spreadsheets (xlsx) into a single Office Excel spreadsheet

Parameters:

  • input_file1 —

    First input file to perform the operation on.

  • input_file2 —

    Second input file to perform the operation on.

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

    the optional parameters

Options Hash (opts):

  • :input_file3 (File) —

    Third input file to perform the operation on.

  • :input_file4 (File) —

    Fourth input file to perform the operation on.

  • :input_file5 (File) —

    Fifth input file to perform the operation on.

  • :input_file6 (File) —

    Sixth input file to perform the operation on.

  • :input_file7 (File) —

    Seventh input file to perform the operation on.

  • :input_file8 (File) —

    Eighth input file to perform the operation on.

  • :input_file9 (File) —

    Ninth input file to perform the operation on.

  • :input_file10 (File) —

    Tenth input file to perform the operation on.

Returns:

  • (String) 


1363
1364
1365
1366
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 1363

def merge_document_xlsx_multi(input_file1, input_file2, opts = {})
  data, _status_code, _headers = merge_document_xlsx_multi_with_http_info(input_file1, input_file2, opts)
  data
end

#merge_document_xlsx_multi_array(input, opts = {}) ⇒ Object

Merge Multple Excel XLSX Together from an Array Combine multiple Office Excel spreadsheets (xlsx), as an array, into a single Office Excel spreadsheet

Parameters:

  • input —

    Array of input files

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

    the optional parameters

Returns:

  • (Object) 


1440
1441
1442
1443
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 1440

def merge_document_xlsx_multi_array(input, opts = {})
  data, _status_code, _headers = merge_document_xlsx_multi_array_with_http_info(input, opts)
  data
end

#merge_document_xlsx_multi_array_with_http_info(input, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Merge Multple Excel XLSX Together from an Array Combine multiple Office Excel spreadsheets (xlsx), as an array, into a single Office Excel spreadsheet

Parameters:

  • input —

    Array of input files

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 1450

def merge_document_xlsx_multi_array_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MergeDocumentApi.merge_document_xlsx_multi_array ...'
  end
  # verify the required parameter 'input' is set
  if @api_client.config.client_side_validation && input.nil?
    fail ArgumentError, "Missing the required parameter 'input' when calling MergeDocumentApi.merge_document_xlsx_multi_array"
  end
  # resource path
  local_var_path = '/convert/merge/xlsx/multi/array'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(input)
  auth_names = ['Apikey']
  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 => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MergeDocumentApi#merge_document_xlsx_multi_array\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#merge_document_xlsx_multi_with_http_info(input_file1, input_file2, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Merge Multple Excel XLSX Together Combine multiple Office Excel spreadsheets (xlsx) into a single Office Excel spreadsheet

Parameters:

  • input_file1 —

    First input file to perform the operation on.

  • input_file2 —

    Second input file to perform the operation on.

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

    the optional parameters

Options Hash (opts):

  • :input_file3 (File) —

    Third input file to perform the operation on.

  • :input_file4 (File) —

    Fourth input file to perform the operation on.

  • :input_file5 (File) —

    Fifth input file to perform the operation on.

  • :input_file6 (File) —

    Sixth input file to perform the operation on.

  • :input_file7 (File) —

    Seventh input file to perform the operation on.

  • :input_file8 (File) —

    Eighth input file to perform the operation on.

  • :input_file9 (File) —

    Ninth input file to perform the operation on.

  • :input_file10 (File) —

    Tenth input file to perform the operation on.

Returns:

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

    String data, response status code and response headers



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
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 1382

def merge_document_xlsx_multi_with_http_info(input_file1, input_file2, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MergeDocumentApi.merge_document_xlsx_multi ...'
  end
  # verify the required parameter 'input_file1' is set
  if @api_client.config.client_side_validation && input_file1.nil?
    fail ArgumentError, "Missing the required parameter 'input_file1' when calling MergeDocumentApi.merge_document_xlsx_multi"
  end
  # verify the required parameter 'input_file2' is set
  if @api_client.config.client_side_validation && input_file2.nil?
    fail ArgumentError, "Missing the required parameter 'input_file2' when calling MergeDocumentApi.merge_document_xlsx_multi"
  end
  # resource path
  local_var_path = '/convert/merge/xlsx/multi'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['inputFile1'] = input_file1
  form_params['inputFile2'] = input_file2
  form_params['inputFile3'] = opts[:'input_file3'] if !opts[:'input_file3'].nil?
  form_params['inputFile4'] = opts[:'input_file4'] if !opts[:'input_file4'].nil?
  form_params['inputFile5'] = opts[:'input_file5'] if !opts[:'input_file5'].nil?
  form_params['inputFile6'] = opts[:'input_file6'] if !opts[:'input_file6'].nil?
  form_params['inputFile7'] = opts[:'input_file7'] if !opts[:'input_file7'].nil?
  form_params['inputFile8'] = opts[:'input_file8'] if !opts[:'input_file8'].nil?
  form_params['inputFile9'] = opts[:'input_file9'] if !opts[:'input_file9'].nil?
  form_params['inputFile10'] = opts[:'input_file10'] if !opts[:'input_file10'].nil?

  # http body (model)
  post_body = nil
  auth_names = ['Apikey']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MergeDocumentApi#merge_document_xlsx_multi\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#merge_document_xlsx_with_http_info(input_file1, input_file2, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Merge Two Excel XLSX Together Combine two Office Excel spreadsheets (xlsx) into a single Office Excel spreadsheet

Parameters:

  • input_file1 —

    First input file to perform the operation on.

  • input_file2 —

    Second input file to perform the operation on (more than 2 can be supplied).

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
 
# File 'lib/cloudmersive-convert-api-client/api/merge_document_api.rb', line 1304

def merge_document_xlsx_with_http_info(input_file1, input_file2, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MergeDocumentApi.merge_document_xlsx ...'
  end
  # verify the required parameter 'input_file1' is set
  if @api_client.config.client_side_validation && input_file1.nil?
    fail ArgumentError, "Missing the required parameter 'input_file1' when calling MergeDocumentApi.merge_document_xlsx"
  end
  # verify the required parameter 'input_file2' is set
  if @api_client.config.client_side_validation && input_file2.nil?
    fail ArgumentError, "Missing the required parameter 'input_file2' when calling MergeDocumentApi.merge_document_xlsx"
  end
  # resource path
  local_var_path = '/convert/merge/xlsx'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['inputFile1'] = input_file1
  form_params['inputFile2'] = input_file2

  # http body (model)
  post_body = nil
  auth_names = ['Apikey']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MergeDocumentApi#merge_document_xlsx\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end