Class: CloudmersiveConvertApiClient::EditDocumentApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EditDocumentApi 



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

def api_client
  @api_client
end

Instance Method Details

#edit_document_begin_editing(input_file, opts = {}) ⇒ String

Begin editing a document Uploads a document to Cloudmersive to begin a series of one or more editing operations. To edit a document, first call Begin Editing on the document. Then perform operations on the document using the secure URL returned from BeginEditing, such as Word DOCX Delete Pages and Insert Table. Finally, perform finish editing on the URL to return the resulting edited document. The editing URL is temporary and only stored in-memory cache, and will automatically expire from the cache after 30 minutes, and cannot be directly accessed.



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

def edit_document_begin_editing(input_file, opts = {})
  data, _status_code, _headers = edit_document_begin_editing_with_http_info(input_file, opts)
  data
end

#edit_document_begin_editing_with_http_info(input_file, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Begin editing a document Uploads a document to Cloudmersive to begin a series of one or more editing operations. To edit a document, first call Begin Editing on the document. Then perform operations on the document using the secure URL returned from BeginEditing, such as Word DOCX Delete Pages and Insert Table. Finally, perform finish editing on the URL to return the resulting edited document. The editing URL is temporary and only stored in-memory cache, and will automatically expire from the cache after 30 minutes, and cannot be directly accessed.



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

def edit_document_begin_editing_with_http_info(input_file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_begin_editing ...'
  end
  # verify the required parameter 'input_file' is set
  if @api_client.config.client_side_validation && input_file.nil?
    fail ArgumentError, "Missing the required parameter 'input_file' when calling EditDocumentApi.edit_document_begin_editing"
  end
  # resource path
  local_var_path = '/convert/edit/begin-editing'

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['inputFile'] = input_file

  # 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: EditDocumentApi#edit_document_begin_editing\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_docx_accept_all_track_changes(input_file, opts = {}) ⇒ String

Accept all tracked changes, revisions in a Word DOCX document Accepts all tracked changes and revisions in a Word DOCX document. This will accept all pending changes in the document when tracked changes is turned on. Track changes will remain on (if it is on) after this oepration is completed.



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

def edit_document_docx_accept_all_track_changes(input_file, opts = {})
  data, _status_code, _headers = edit_document_docx_accept_all_track_changes_with_http_info(input_file, opts)
  data
end

#edit_document_docx_accept_all_track_changes_with_http_info(input_file, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Accept all tracked changes, revisions in a Word DOCX document Accepts all tracked changes and revisions in a Word DOCX document. This will accept all pending changes in the document when tracked changes is turned on. Track changes will remain on (if it is on) after this oepration is completed.



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

def edit_document_docx_accept_all_track_changes_with_http_info(input_file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_accept_all_track_changes ...'
  end
  # verify the required parameter 'input_file' is set
  if @api_client.config.client_side_validation && input_file.nil?
    fail ArgumentError, "Missing the required parameter 'input_file' when calling EditDocumentApi.edit_document_docx_accept_all_track_changes"
  end
  # resource path
  local_var_path = '/convert/edit/docx/track-changes/accept-all'

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['inputFile'] = input_file

  # 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: EditDocumentApi#edit_document_docx_accept_all_track_changes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_docx_body(req_config, opts = {}) ⇒ GetDocxBodyResponse

Get body from a Word DOCX document Returns the body defined in the Word Document (DOCX) format file; this is the main content part of a DOCX document



137
138
139
140
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 137

def edit_document_docx_body(req_config, opts = {})
  data, _status_code, _headers = edit_document_docx_body_with_http_info(req_config, opts)
  data
end

#edit_document_docx_body_with_http_info(req_config, opts = {}) ⇒ Array<(GetDocxBodyResponse, Fixnum, Hash)>

Get body from a Word DOCX document Returns the body defined in the Word Document (DOCX) format file; this is the main content part of a DOCX document



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 147

def edit_document_docx_body_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_body ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_body"
  end
  # resource path
  local_var_path = '/convert/edit/docx/get-body'

  # 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(req_config)
  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 => 'GetDocxBodyResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_body\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_docx_create_blank_document(input, opts = {}) ⇒ CreateBlankDocxResponse

Create a blank Word DOCX document Returns a blank Word DOCX Document format file. The file is blank, with no contents. Use additional editing commands such as Insert Paragraph or Insert Table or Insert Image to populate the document.



191
192
193
194
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 191

def edit_document_docx_create_blank_document(input, opts = {})
  data, _status_code, _headers = edit_document_docx_create_blank_document_with_http_info(input, opts)
  data
end

#edit_document_docx_create_blank_document_with_http_info(input, opts = {}) ⇒ Array<(CreateBlankDocxResponse, Fixnum, Hash)>

Create a blank Word DOCX document Returns a blank Word DOCX Document format file. The file is blank, with no contents. Use additional editing commands such as Insert Paragraph or Insert Table or Insert Image to populate the document.



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 201

def edit_document_docx_create_blank_document_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_create_blank_document ...'
  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 EditDocumentApi.edit_document_docx_create_blank_document"
  end
  # resource path
  local_var_path = '/convert/edit/docx/create/blank'

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

#edit_document_docx_delete_pages(req_config, opts = {}) ⇒ String

Delete, remove pages from a Word DOCX document Returns the edited Word Document in the Word Document (DOCX) format file with the specified pages removed



245
246
247
248
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 245

def edit_document_docx_delete_pages(req_config, opts = {})
  data, _status_code, _headers = edit_document_docx_delete_pages_with_http_info(req_config, opts)
  data
end

#edit_document_docx_delete_pages_with_http_info(req_config, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete, remove pages from a Word DOCX document Returns the edited Word Document in the Word Document (DOCX) format file with the specified pages removed



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 255

def edit_document_docx_delete_pages_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_delete_pages ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_delete_pages"
  end
  # resource path
  local_var_path = '/convert/edit/docx/delete-pages'

  # 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(req_config)
  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: EditDocumentApi#edit_document_docx_delete_pages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_docx_delete_table_row(req_config, opts = {}) ⇒ DeleteDocxTableRowResponse

Deletes a table row in an existing table in a Word DOCX document Deletes an existing table row in a Word DOCX Document and returns the result.



299
300
301
302
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 299

def edit_document_docx_delete_table_row(req_config, opts = {})
  data, _status_code, _headers = edit_document_docx_delete_table_row_with_http_info(req_config, opts)
  data
end

#edit_document_docx_delete_table_row_range(req_config, opts = {}) ⇒ DeleteDocxTableRowRangeResponse

Deletes a range of multiple table rows in an existing table in a Word DOCX document Deletes a range of 1 or more existing table rows in a Word DOCX Document and returns the result.



353
354
355
356
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 353

def edit_document_docx_delete_table_row_range(req_config, opts = {})
  data, _status_code, _headers = edit_document_docx_delete_table_row_range_with_http_info(req_config, opts)
  data
end

#edit_document_docx_delete_table_row_range_with_http_info(req_config, opts = {}) ⇒ Array<(DeleteDocxTableRowRangeResponse, Fixnum, Hash)>

Deletes a range of multiple table rows in an existing table in a Word DOCX document Deletes a range of 1 or more existing table rows in a Word DOCX Document and returns the result.



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 363

def edit_document_docx_delete_table_row_range_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_delete_table_row_range ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_delete_table_row_range"
  end
  # resource path
  local_var_path = '/convert/edit/docx/delete-table-row/range'

  # 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(req_config)
  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 => 'DeleteDocxTableRowRangeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_delete_table_row_range\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_docx_delete_table_row_with_http_info(req_config, opts = {}) ⇒ Array<(DeleteDocxTableRowResponse, Fixnum, Hash)>

Deletes a table row in an existing table in a Word DOCX document Deletes an existing table row in a Word DOCX Document and returns the result.



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 309

def edit_document_docx_delete_table_row_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_delete_table_row ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_delete_table_row"
  end
  # resource path
  local_var_path = '/convert/edit/docx/delete-table-row'

  # 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(req_config)
  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 => 'DeleteDocxTableRowResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_delete_table_row\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_docx_disable_track_changes(input_file, opts = {}) ⇒ String

Disable track changes, revisions in a Word DOCX document Diables tracking of changes and revisions in a Word DOCX document, and accepts any pending changes. Users editing the document will no longer see changes tracked automatically.



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

def edit_document_docx_disable_track_changes(input_file, opts = {})
  data, _status_code, _headers = edit_document_docx_disable_track_changes_with_http_info(input_file, opts)
  data
end

#edit_document_docx_disable_track_changes_with_http_info(input_file, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Disable track changes, revisions in a Word DOCX document Diables tracking of changes and revisions in a Word DOCX document, and accepts any pending changes. Users editing the document will no longer see changes tracked automatically.



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
452
453
454
455
456
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 417

def edit_document_docx_disable_track_changes_with_http_info(input_file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_disable_track_changes ...'
  end
  # verify the required parameter 'input_file' is set
  if @api_client.config.client_side_validation && input_file.nil?
    fail ArgumentError, "Missing the required parameter 'input_file' when calling EditDocumentApi.edit_document_docx_disable_track_changes"
  end
  # resource path
  local_var_path = '/convert/edit/docx/track-changes/disable'

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['inputFile'] = input_file

  # 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: EditDocumentApi#edit_document_docx_disable_track_changes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_docx_enable_track_changes(input_file, opts = {}) ⇒ String

Enable track changes, revisions in a Word DOCX document Enables tracking of changes and revisions in a Word DOCX document. Users editing the document will see changes tracked automatically, with edits highlighted, and the ability to accept or reject changes made to the document.



462
463
464
465
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 462

def edit_document_docx_enable_track_changes(input_file, opts = {})
  data, _status_code, _headers = edit_document_docx_enable_track_changes_with_http_info(input_file, opts)
  data
end

#edit_document_docx_enable_track_changes_with_http_info(input_file, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Enable track changes, revisions in a Word DOCX document Enables tracking of changes and revisions in a Word DOCX document. Users editing the document will see changes tracked automatically, with edits highlighted, and the ability to accept or reject changes made to the document.



472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 472

def edit_document_docx_enable_track_changes_with_http_info(input_file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_enable_track_changes ...'
  end
  # verify the required parameter 'input_file' is set
  if @api_client.config.client_side_validation && input_file.nil?
    fail ArgumentError, "Missing the required parameter 'input_file' when calling EditDocumentApi.edit_document_docx_enable_track_changes"
  end
  # resource path
  local_var_path = '/convert/edit/docx/track-changes/enable'

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['inputFile'] = input_file

  # 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: EditDocumentApi#edit_document_docx_enable_track_changes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_docx_find_paragraph(req_config, opts = {}) ⇒ FindDocxParagraphResponse

Find matching paragraphs in a Word DOCX document Returns the paragraphs defined in the Word Document (DOCX) format file that match the input criteria



517
518
519
520
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 517

def edit_document_docx_find_paragraph(req_config, opts = {})
  data, _status_code, _headers = edit_document_docx_find_paragraph_with_http_info(req_config, opts)
  data
end

#edit_document_docx_find_paragraph_with_http_info(req_config, opts = {}) ⇒ Array<(FindDocxParagraphResponse, Fixnum, Hash)>

Find matching paragraphs in a Word DOCX document Returns the paragraphs defined in the Word Document (DOCX) format file that match the input criteria



527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 527

def edit_document_docx_find_paragraph_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_find_paragraph ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_find_paragraph"
  end
  # resource path
  local_var_path = '/convert/edit/docx/find/paragraph'

  # 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(req_config)
  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 => 'FindDocxParagraphResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_find_paragraph\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_docx_get_comments(req_config, opts = {}) ⇒ GetDocxCommentsResponse

Get comments from a Word DOCX document as a flat list Returns the comments and review annotations stored in the Word Document (DOCX) format file as a flattened list (not as a hierarchy of comments and replies).



571
572
573
574
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 571

def edit_document_docx_get_comments(req_config, opts = {})
  data, _status_code, _headers = edit_document_docx_get_comments_with_http_info(req_config, opts)
  data
end

#edit_document_docx_get_comments_hierarchical(req_config, opts = {}) ⇒ GetDocxCommentsHierarchicalResponse

Get comments from a Word DOCX document hierarchically Returns the comments and review annotations stored in the Word Document (DOCX) format file hierarchically, where reply comments are nested as children under top-level comments in the results returned.



625
626
627
628
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 625

def edit_document_docx_get_comments_hierarchical(req_config, opts = {})
  data, _status_code, _headers = edit_document_docx_get_comments_hierarchical_with_http_info(req_config, opts)
  data
end

#edit_document_docx_get_comments_hierarchical_with_http_info(req_config, opts = {}) ⇒ Array<(GetDocxCommentsHierarchicalResponse, Fixnum, Hash)>

Get comments from a Word DOCX document hierarchically Returns the comments and review annotations stored in the Word Document (DOCX) format file hierarchically, where reply comments are nested as children under top-level comments in the results returned.



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

def edit_document_docx_get_comments_hierarchical_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_get_comments_hierarchical ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_get_comments_hierarchical"
  end
  # resource path
  local_var_path = '/convert/edit/docx/get-comments/hierarchical'

  # 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(req_config)
  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 => 'GetDocxCommentsHierarchicalResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_get_comments_hierarchical\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_docx_get_comments_with_http_info(req_config, opts = {}) ⇒ Array<(GetDocxCommentsResponse, Fixnum, Hash)>

Get comments from a Word DOCX document as a flat list Returns the comments and review annotations stored in the Word Document (DOCX) format file as a flattened list (not as a hierarchy of comments and replies).



581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 581

def edit_document_docx_get_comments_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_get_comments ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_get_comments"
  end
  # resource path
  local_var_path = '/convert/edit/docx/get-comments/flat-list'

  # 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(req_config)
  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 => 'GetDocxCommentsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_get_comments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_docx_get_headers_and_footers(req_config, opts = {}) ⇒ GetDocxHeadersAndFootersResponse

Get content of a footer from a Word DOCX document Returns the footer content from a Word Document (DOCX) format file



679
680
681
682
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 679

def edit_document_docx_get_headers_and_footers(req_config, opts = {})
  data, _status_code, _headers = edit_document_docx_get_headers_and_footers_with_http_info(req_config, opts)
  data
end

#edit_document_docx_get_headers_and_footers_with_http_info(req_config, opts = {}) ⇒ Array<(GetDocxHeadersAndFootersResponse, Fixnum, Hash)>

Get content of a footer from a Word DOCX document Returns the footer content from a Word Document (DOCX) format file



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
724
725
726
727
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 689

def edit_document_docx_get_headers_and_footers_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_get_headers_and_footers ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_get_headers_and_footers"
  end
  # resource path
  local_var_path = '/convert/edit/docx/get-headers-and-footers'

  # 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(req_config)
  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 => 'GetDocxHeadersAndFootersResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_get_headers_and_footers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_docx_get_images(req_config, opts = {}) ⇒ GetDocxImagesResponse

Get images from a Word DOCX document Returns the images defined in the Word Document (DOCX) format file



733
734
735
736
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 733

def edit_document_docx_get_images(req_config, opts = {})
  data, _status_code, _headers = edit_document_docx_get_images_with_http_info(req_config, opts)
  data
end

#edit_document_docx_get_images_with_http_info(req_config, opts = {}) ⇒ Array<(GetDocxImagesResponse, Fixnum, Hash)>

Get images from a Word DOCX document Returns the images defined in the Word Document (DOCX) format file



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

def edit_document_docx_get_images_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_get_images ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_get_images"
  end
  # resource path
  local_var_path = '/convert/edit/docx/get-images'

  # 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(req_config)
  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 => 'GetDocxImagesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_get_images\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_docx_get_macro_information(input_file, opts = {}) ⇒ GetMacrosResponse

Get macro information from a Word DOCX/DOCM document Returns information about the Macros (e.g. VBA) defined in the Word Document



787
788
789
790
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 787

def edit_document_docx_get_macro_information(input_file, opts = {})
  data, _status_code, _headers = edit_document_docx_get_macro_information_with_http_info(input_file, opts)
  data
end

#edit_document_docx_get_macro_information_with_http_info(input_file, opts = {}) ⇒ Array<(GetMacrosResponse, Fixnum, Hash)>

Get macro information from a Word DOCX/DOCM document Returns information about the Macros (e.g. VBA) defined in the Word Document



797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 797

def edit_document_docx_get_macro_information_with_http_info(input_file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_get_macro_information ...'
  end
  # verify the required parameter 'input_file' is set
  if @api_client.config.client_side_validation && input_file.nil?
    fail ArgumentError, "Missing the required parameter 'input_file' when calling EditDocumentApi.edit_document_docx_get_macro_information"
  end
  # resource path
  local_var_path = '/convert/edit/docx/get-macros'

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['inputFile'] = input_file

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

#edit_document_docx_get_metadata_properties(input_file, opts = {}) ⇒ GetDocxMetadataPropertiesResponse

Get all metadata properties in Word DOCX document Returns all the metadata properties in an Office Word Document (docx)



842
843
844
845
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 842

def edit_document_docx_get_metadata_properties(input_file, opts = {})
  data, _status_code, _headers = edit_document_docx_get_metadata_properties_with_http_info(input_file, opts)
  data
end

#edit_document_docx_get_metadata_properties_with_http_info(input_file, opts = {}) ⇒ Array<(GetDocxMetadataPropertiesResponse, Fixnum, Hash)>

Get all metadata properties in Word DOCX document Returns all the metadata properties in an Office Word Document (docx)



852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 852

def edit_document_docx_get_metadata_properties_with_http_info(input_file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_get_metadata_properties ...'
  end
  # verify the required parameter 'input_file' is set
  if @api_client.config.client_side_validation && input_file.nil?
    fail ArgumentError, "Missing the required parameter 'input_file' when calling EditDocumentApi.edit_document_docx_get_metadata_properties"
  end
  # resource path
  local_var_path = '/convert/edit/docx/get-metadata'

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['inputFile'] = input_file

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

#edit_document_docx_get_sections(req_config, opts = {}) ⇒ GetDocxSectionsResponse

Get sections from a Word DOCX document Returns the sections defined in the Word Document (DOCX) format file



897
898
899
900
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 897

def edit_document_docx_get_sections(req_config, opts = {})
  data, _status_code, _headers = edit_document_docx_get_sections_with_http_info(req_config, opts)
  data
end

#edit_document_docx_get_sections_with_http_info(req_config, opts = {}) ⇒ Array<(GetDocxSectionsResponse, Fixnum, Hash)>

Get sections from a Word DOCX document Returns the sections defined in the Word Document (DOCX) format file



907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 907

def edit_document_docx_get_sections_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_get_sections ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_get_sections"
  end
  # resource path
  local_var_path = '/convert/edit/docx/get-sections'

  # 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(req_config)
  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 => 'GetDocxSectionsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_get_sections\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_docx_get_styles(req_config, opts = {}) ⇒ GetDocxStylesResponse

Get styles from a Word DOCX document Returns the styles defined in the Word Document (DOCX) format file



951
952
953
954
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 951

def edit_document_docx_get_styles(req_config, opts = {})
  data, _status_code, _headers = edit_document_docx_get_styles_with_http_info(req_config, opts)
  data
end

#edit_document_docx_get_styles_with_http_info(req_config, opts = {}) ⇒ Array<(GetDocxStylesResponse, Fixnum, Hash)>

Get styles from a Word DOCX document Returns the styles defined in the Word Document (DOCX) format file



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

def edit_document_docx_get_styles_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_get_styles ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_get_styles"
  end
  # resource path
  local_var_path = '/convert/edit/docx/get-styles'

  # 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(req_config)
  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 => 'GetDocxStylesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_get_styles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_docx_get_table_by_index(req_config, opts = {}) ⇒ GetDocxTableByIndexResponse

Get a specific table by index in a Word DOCX document Returns the specific table object by its 0-based index in an Office Word Document (DOCX)



1005
1006
1007
1008
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1005

def edit_document_docx_get_table_by_index(req_config, opts = {})
  data, _status_code, _headers = edit_document_docx_get_table_by_index_with_http_info(req_config, opts)
  data
end

#edit_document_docx_get_table_by_index_with_http_info(req_config, opts = {}) ⇒ Array<(GetDocxTableByIndexResponse, Fixnum, Hash)>

Get a specific table by index in a Word DOCX document Returns the specific table object by its 0-based index in an Office Word Document (DOCX)



1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1015

def edit_document_docx_get_table_by_index_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_get_table_by_index ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_get_table_by_index"
  end
  # resource path
  local_var_path = '/convert/edit/docx/get-table/by-index'

  # 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(req_config)
  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 => 'GetDocxTableByIndexResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_get_table_by_index\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_docx_get_table_row(req_config, opts = {}) ⇒ GetDocxTableRowResponse

Gets the contents of an existing table row in an existing table in a Word DOCX document Gets the contents of an existing table row in a Word DOCX Document and returns the result.



1059
1060
1061
1062
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1059

def edit_document_docx_get_table_row(req_config, opts = {})
  data, _status_code, _headers = edit_document_docx_get_table_row_with_http_info(req_config, opts)
  data
end

#edit_document_docx_get_table_row_with_http_info(req_config, opts = {}) ⇒ Array<(GetDocxTableRowResponse, Fixnum, Hash)>

Gets the contents of an existing table row in an existing table in a Word DOCX document Gets the contents of an existing table row in a Word DOCX Document and returns the result.



1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1069

def edit_document_docx_get_table_row_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_get_table_row ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_get_table_row"
  end
  # resource path
  local_var_path = '/convert/edit/docx/get-table-row'

  # 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(req_config)
  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 => 'GetDocxTableRowResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_get_table_row\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_docx_get_tables(req_config, opts = {}) ⇒ GetDocxTablesResponse

Get all tables in Word DOCX document Returns all the table objects in an Office Word Document (docx)



1113
1114
1115
1116
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1113

def edit_document_docx_get_tables(req_config, opts = {})
  data, _status_code, _headers = edit_document_docx_get_tables_with_http_info(req_config, opts)
  data
end

#edit_document_docx_get_tables_with_http_info(req_config, opts = {}) ⇒ Array<(GetDocxTablesResponse, Fixnum, Hash)>

Get all tables in Word DOCX document Returns all the table objects in an Office Word Document (docx)



1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1123

def edit_document_docx_get_tables_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_get_tables ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_get_tables"
  end
  # resource path
  local_var_path = '/convert/edit/docx/get-tables'

  # 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(req_config)
  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 => 'GetDocxTablesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_get_tables\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_docx_insert_comment_on_paragraph(req_config, opts = {}) ⇒ InsertDocxCommentOnParagraphResponse

Insert a new comment into a Word DOCX document attached to a paragraph Adds a new comment into a Word DOCX document attached to a paragraph and returns the result. Call Finish Editing on the output URL to complete the operation.



1167
1168
1169
1170
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1167

def edit_document_docx_insert_comment_on_paragraph(req_config, opts = {})
  data, _status_code, _headers = edit_document_docx_insert_comment_on_paragraph_with_http_info(req_config, opts)
  data
end

#edit_document_docx_insert_comment_on_paragraph_with_http_info(req_config, opts = {}) ⇒ Array<(InsertDocxCommentOnParagraphResponse, Fixnum, Hash)>

Insert a new comment into a Word DOCX document attached to a paragraph Adds a new comment into a Word DOCX document attached to a paragraph and returns the result. Call Finish Editing on the output URL to complete the operation.



1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1177

def edit_document_docx_insert_comment_on_paragraph_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_insert_comment_on_paragraph ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_insert_comment_on_paragraph"
  end
  # resource path
  local_var_path = '/convert/edit/docx/insert-comment/on/paragraph'

  # 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(req_config)
  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 => 'InsertDocxCommentOnParagraphResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_insert_comment_on_paragraph\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_docx_insert_image(req_config, opts = {}) ⇒ DocxInsertImageResponse

Insert image into a Word DOCX document Set the footer in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.



1221
1222
1223
1224
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1221

def edit_document_docx_insert_image(req_config, opts = {})
  data, _status_code, _headers = edit_document_docx_insert_image_with_http_info(req_config, opts)
  data
end

#edit_document_docx_insert_image_with_http_info(req_config, opts = {}) ⇒ Array<(DocxInsertImageResponse, Fixnum, Hash)>

Insert image into a Word DOCX document Set the footer in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.



1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1231

def edit_document_docx_insert_image_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_insert_image ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_insert_image"
  end
  # resource path
  local_var_path = '/convert/edit/docx/insert-image'

  # 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(req_config)
  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 => 'DocxInsertImageResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_insert_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_docx_insert_paragraph(req_config, opts = {}) ⇒ InsertDocxInsertParagraphResponse

Insert a new paragraph into a Word DOCX document Adds a new paragraph into a DOCX and returns the result. You can insert at the beginning/end of a document, or before/after an existing object using its Path (location within the document). Call Finish Editing on the output URL to complete the operation.



1275
1276
1277
1278
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1275

def edit_document_docx_insert_paragraph(req_config, opts = {})
  data, _status_code, _headers = edit_document_docx_insert_paragraph_with_http_info(req_config, opts)
  data
end

#edit_document_docx_insert_paragraph_with_http_info(req_config, opts = {}) ⇒ Array<(InsertDocxInsertParagraphResponse, Fixnum, Hash)>

Insert a new paragraph into a Word DOCX document Adds a new paragraph into a DOCX and returns the result. You can insert at the beginning/end of a document, or before/after an existing object using its Path (location within the document). Call Finish Editing on the output URL to complete the operation.



1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1285

def edit_document_docx_insert_paragraph_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_insert_paragraph ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_insert_paragraph"
  end
  # resource path
  local_var_path = '/convert/edit/docx/insert-paragraph'

  # 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(req_config)
  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 => 'InsertDocxInsertParagraphResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_insert_paragraph\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_docx_insert_table(req_config, opts = {}) ⇒ InsertDocxTablesResponse

Insert a new table into a Word DOCX document Adds a new table into a DOCX and returns the result. Call Finish Editing on the output URL to complete the operation.



1329
1330
1331
1332
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1329

def edit_document_docx_insert_table(req_config, opts = {})
  data, _status_code, _headers = edit_document_docx_insert_table_with_http_info(req_config, opts)
  data
end

#edit_document_docx_insert_table_row(req_config, opts = {}) ⇒ InsertDocxTableRowResponse

Insert a new row into an existing table in a Word DOCX document Adds a new table row into a DOCX Document and returns the result. Call Finish Editing on the output URL to complete the operation.



1383
1384
1385
1386
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1383

def edit_document_docx_insert_table_row(req_config, opts = {})
  data, _status_code, _headers = edit_document_docx_insert_table_row_with_http_info(req_config, opts)
  data
end

#edit_document_docx_insert_table_row_with_http_info(req_config, opts = {}) ⇒ Array<(InsertDocxTableRowResponse, Fixnum, Hash)>

Insert a new row into an existing table in a Word DOCX document Adds a new table row into a DOCX Document and returns the result. Call Finish Editing on the output URL to complete the operation.



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

def edit_document_docx_insert_table_row_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_insert_table_row ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_insert_table_row"
  end
  # resource path
  local_var_path = '/convert/edit/docx/insert-table-row'

  # 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(req_config)
  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 => 'InsertDocxTableRowResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_insert_table_row\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_docx_insert_table_with_http_info(req_config, opts = {}) ⇒ Array<(InsertDocxTablesResponse, Fixnum, Hash)>

Insert a new table into a Word DOCX document Adds a new table into a DOCX and returns the result. Call Finish Editing on the output URL to complete the operation.



1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1339

def edit_document_docx_insert_table_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_insert_table ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_insert_table"
  end
  # resource path
  local_var_path = '/convert/edit/docx/insert-table'

  # 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(req_config)
  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 => 'InsertDocxTablesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_insert_table\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_docx_pages(req_config, opts = {}) ⇒ GetDocxPagesResponse

Get pages and content from a Word DOCX document Returns the pages and contents of each page defined in the Word Document (DOCX) format file



1437
1438
1439
1440
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1437

def edit_document_docx_pages(req_config, opts = {})
  data, _status_code, _headers = edit_document_docx_pages_with_http_info(req_config, opts)
  data
end

#edit_document_docx_pages_with_http_info(req_config, opts = {}) ⇒ Array<(GetDocxPagesResponse, Fixnum, Hash)>

Get pages and content from a Word DOCX document Returns the pages and contents of each page defined in the Word Document (DOCX) format file



1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1447

def edit_document_docx_pages_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_pages ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_pages"
  end
  # resource path
  local_var_path = '/convert/edit/docx/get-pages'

  # 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(req_config)
  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 => 'GetDocxPagesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_pages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_docx_remove_all_comments(input_file, opts = {}) ⇒ String

Remove all comments from a Word DOCX document Removes all of the comments from a Word Document.



1491
1492
1493
1494
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1491

def edit_document_docx_remove_all_comments(input_file, opts = {})
  data, _status_code, _headers = edit_document_docx_remove_all_comments_with_http_info(input_file, opts)
  data
end

#edit_document_docx_remove_all_comments_with_http_info(input_file, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Remove all comments from a Word DOCX document Removes all of the comments from a Word Document.



1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1501

def edit_document_docx_remove_all_comments_with_http_info(input_file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_remove_all_comments ...'
  end
  # verify the required parameter 'input_file' is set
  if @api_client.config.client_side_validation && input_file.nil?
    fail ArgumentError, "Missing the required parameter 'input_file' when calling EditDocumentApi.edit_document_docx_remove_all_comments"
  end
  # resource path
  local_var_path = '/convert/edit/docx/comments/remove-all'

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['inputFile'] = input_file

  # 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: EditDocumentApi#edit_document_docx_remove_all_comments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_docx_remove_headers_and_footers(req_config, opts = {}) ⇒ RemoveDocxHeadersAndFootersResponse

Remove headers and footers from Word DOCX document Remove all headers, or footers, or both from a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.



1546
1547
1548
1549
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1546

def edit_document_docx_remove_headers_and_footers(req_config, opts = {})
  data, _status_code, _headers = edit_document_docx_remove_headers_and_footers_with_http_info(req_config, opts)
  data
end

#edit_document_docx_remove_headers_and_footers_with_http_info(req_config, opts = {}) ⇒ Array<(RemoveDocxHeadersAndFootersResponse, Fixnum, Hash)>

Remove headers and footers from Word DOCX document Remove all headers, or footers, or both from a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.



1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1556

def edit_document_docx_remove_headers_and_footers_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_remove_headers_and_footers ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_remove_headers_and_footers"
  end
  # resource path
  local_var_path = '/convert/edit/docx/remove-headers-and-footers'

  # 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(req_config)
  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 => 'RemoveDocxHeadersAndFootersResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_remove_headers_and_footers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_docx_remove_object(req_config, opts = {}) ⇒ DocxRemoveObjectResponse

Delete any object in a Word DOCX document Delete any object, such as a paragraph, table, image, etc. from a Word Document (DOCX). Pass in the Path of the object you would like to delete. You can call other functions such as Get-Tables, Get-Images, Get-Body, etc. to get the paths of the objects in the document. Call Finish Editing on the output URL to complete the operation.



1600
1601
1602
1603
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1600

def edit_document_docx_remove_object(req_config, opts = {})
  data, _status_code, _headers = edit_document_docx_remove_object_with_http_info(req_config, opts)
  data
end

#edit_document_docx_remove_object_with_http_info(req_config, opts = {}) ⇒ Array<(DocxRemoveObjectResponse, Fixnum, Hash)>

Delete any object in a Word DOCX document Delete any object, such as a paragraph, table, image, etc. from a Word Document (DOCX). Pass in the Path of the object you would like to delete. You can call other functions such as Get-Tables, Get-Images, Get-Body, etc. to get the paths of the objects in the document. Call Finish Editing on the output URL to complete the operation.



1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1610

def edit_document_docx_remove_object_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_remove_object ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_remove_object"
  end
  # resource path
  local_var_path = '/convert/edit/docx/remove-object'

  # 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(req_config)
  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 => 'DocxRemoveObjectResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_remove_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_docx_replace(req_config, opts = {}) ⇒ String

Replace string in Word DOCX document Replace all instances of a string in an Office Word Document (docx)



1654
1655
1656
1657
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1654

def edit_document_docx_replace(req_config, opts = {})
  data, _status_code, _headers = edit_document_docx_replace_with_http_info(req_config, opts)
  data
end

#edit_document_docx_replace_multi(req_config, opts = {}) ⇒ String

Replace multiple strings in Word DOCX document Replace all instances of multiple strings in an Office Word Document (docx)



1708
1709
1710
1711
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1708

def edit_document_docx_replace_multi(req_config, opts = {})
  data, _status_code, _headers = edit_document_docx_replace_multi_with_http_info(req_config, opts)
  data
end

#edit_document_docx_replace_multi_with_http_info(req_config, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Replace multiple strings in Word DOCX document Replace all instances of multiple strings in an Office Word Document (docx)



1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1718

def edit_document_docx_replace_multi_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_replace_multi ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_replace_multi"
  end
  # resource path
  local_var_path = '/convert/edit/docx/replace-all/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(['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(req_config)
  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: EditDocumentApi#edit_document_docx_replace_multi\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_docx_replace_paragraph(req_config, opts = {}) ⇒ ReplaceDocxParagraphResponse

Replace matching paragraphs in a Word DOCX document Returns the edited Word Document (DOCX) format file with the matching paragraphs replaced as requested. Replace a paragraph with another object such as an image. Useful for performing templating operations.



1762
1763
1764
1765
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1762

def edit_document_docx_replace_paragraph(req_config, opts = {})
  data, _status_code, _headers = edit_document_docx_replace_paragraph_with_http_info(req_config, opts)
  data
end

#edit_document_docx_replace_paragraph_with_http_info(req_config, opts = {}) ⇒ Array<(ReplaceDocxParagraphResponse, Fixnum, Hash)>

Replace matching paragraphs in a Word DOCX document Returns the edited Word Document (DOCX) format file with the matching paragraphs replaced as requested. Replace a paragraph with another object such as an image. Useful for performing templating operations.



1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1772

def edit_document_docx_replace_paragraph_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_replace_paragraph ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_replace_paragraph"
  end
  # resource path
  local_var_path = '/convert/edit/docx/replace/paragraph'

  # 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(req_config)
  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 => 'ReplaceDocxParagraphResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_replace_paragraph\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_docx_replace_with_http_info(req_config, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Replace string in Word DOCX document Replace all instances of a string in an Office Word Document (docx)



1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1664

def edit_document_docx_replace_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_replace ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_replace"
  end
  # resource path
  local_var_path = '/convert/edit/docx/replace-all'

  # 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(req_config)
  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: EditDocumentApi#edit_document_docx_replace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_docx_set_custom_metadata_properties(input, opts = {}) ⇒ String

Set custom property metadata properties in Word DOCX document Sets the custom property metadata for the metadata properties in an Office Word Document (docx)



1816
1817
1818
1819
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1816

def edit_document_docx_set_custom_metadata_properties(input, opts = {})
  data, _status_code, _headers = edit_document_docx_set_custom_metadata_properties_with_http_info(input, opts)
  data
end

#edit_document_docx_set_custom_metadata_properties_with_http_info(input, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Set custom property metadata properties in Word DOCX document Sets the custom property metadata for the metadata properties in an Office Word Document (docx)



1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1826

def edit_document_docx_set_custom_metadata_properties_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_set_custom_metadata_properties ...'
  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 EditDocumentApi.edit_document_docx_set_custom_metadata_properties"
  end
  # resource path
  local_var_path = '/convert/edit/docx/set-metadata/custom-property'

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

#edit_document_docx_set_footer(req_config, opts = {}) ⇒ DocxSetFooterResponse

Set the footer in a Word DOCX document Set the footer in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.



1870
1871
1872
1873
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1870

def edit_document_docx_set_footer(req_config, opts = {})
  data, _status_code, _headers = edit_document_docx_set_footer_with_http_info(req_config, opts)
  data
end

#edit_document_docx_set_footer_add_page_number(req_config, opts = {}) ⇒ DocxSetFooterResponse

Add page number to footer in a Word DOCX document Set the footer in a Word Document (DOCX) to contain a page number. Call Finish Editing on the output URL to complete the operation.



1924
1925
1926
1927
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1924

def edit_document_docx_set_footer_add_page_number(req_config, opts = {})
  data, _status_code, _headers = edit_document_docx_set_footer_add_page_number_with_http_info(req_config, opts)
  data
end

#edit_document_docx_set_footer_add_page_number_with_http_info(req_config, opts = {}) ⇒ Array<(DocxSetFooterResponse, Fixnum, Hash)>

Add page number to footer in a Word DOCX document Set the footer in a Word Document (DOCX) to contain a page number. Call Finish Editing on the output URL to complete the operation.



1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1934

def edit_document_docx_set_footer_add_page_number_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_set_footer_add_page_number ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_set_footer_add_page_number"
  end
  # resource path
  local_var_path = '/convert/edit/docx/set-footer/add-page-number'

  # 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(req_config)
  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 => 'DocxSetFooterResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_set_footer_add_page_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_docx_set_footer_with_http_info(req_config, opts = {}) ⇒ Array<(DocxSetFooterResponse, Fixnum, Hash)>

Set the footer in a Word DOCX document Set the footer in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.



1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1880

def edit_document_docx_set_footer_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_set_footer ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_set_footer"
  end
  # resource path
  local_var_path = '/convert/edit/docx/set-footer'

  # 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(req_config)
  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 => 'DocxSetFooterResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_set_footer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_docx_set_header(req_config, opts = {}) ⇒ DocxSetHeaderResponse

Set the header in a Word DOCX document Set the header in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.



1978
1979
1980
1981
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1978

def edit_document_docx_set_header(req_config, opts = {})
  data, _status_code, _headers = edit_document_docx_set_header_with_http_info(req_config, opts)
  data
end

#edit_document_docx_set_header_with_http_info(req_config, opts = {}) ⇒ Array<(DocxSetHeaderResponse, Fixnum, Hash)>

Set the header in a Word DOCX document Set the header in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.



1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1988

def edit_document_docx_set_header_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_set_header ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_set_header"
  end
  # resource path
  local_var_path = '/convert/edit/docx/set-header'

  # 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(req_config)
  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 => 'DocxSetHeaderResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_set_header\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_docx_update_table_cell(req_config, opts = {}) ⇒ UpdateDocxTableCellResponse

Update, set contents of a table cell in an existing table in a Word DOCX document Sets the contents of a table cell into a DOCX Document and returns the result. Call Finish Editing on the output URL to complete the operation.



2032
2033
2034
2035
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2032

def edit_document_docx_update_table_cell(req_config, opts = {})
  data, _status_code, _headers = edit_document_docx_update_table_cell_with_http_info(req_config, opts)
  data
end

#edit_document_docx_update_table_cell_with_http_info(req_config, opts = {}) ⇒ Array<(UpdateDocxTableCellResponse, Fixnum, Hash)>

Update, set contents of a table cell in an existing table in a Word DOCX document Sets the contents of a table cell into a DOCX Document and returns the result. Call Finish Editing on the output URL to complete the operation.



2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2042

def edit_document_docx_update_table_cell_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_update_table_cell ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_update_table_cell"
  end
  # resource path
  local_var_path = '/convert/edit/docx/update-table-cell'

  # 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(req_config)
  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 => 'UpdateDocxTableCellResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_update_table_cell\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_docx_update_table_row(req_config, opts = {}) ⇒ UpdateDocxTableRowResponse

Update, set contents of a table row in an existing table in a Word DOCX document Sets the contents of a table row into a DOCX Document and returns the result. Call Finish Editing on the output URL to complete the operation.



2086
2087
2088
2089
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2086

def edit_document_docx_update_table_row(req_config, opts = {})
  data, _status_code, _headers = edit_document_docx_update_table_row_with_http_info(req_config, opts)
  data
end

#edit_document_docx_update_table_row_with_http_info(req_config, opts = {}) ⇒ Array<(UpdateDocxTableRowResponse, Fixnum, Hash)>

Update, set contents of a table row in an existing table in a Word DOCX document Sets the contents of a table row into a DOCX Document and returns the result. Call Finish Editing on the output URL to complete the operation.



2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2096

def edit_document_docx_update_table_row_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_update_table_row ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_update_table_row"
  end
  # resource path
  local_var_path = '/convert/edit/docx/update-table-row'

  # 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(req_config)
  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 => 'UpdateDocxTableRowResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_update_table_row\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_finish_editing(req_config, opts = {}) ⇒ String

Finish editing document, and download result from document editing Once done editing a document, download the result. Begin editing a document by calling begin-editing, then perform operations, then call finish-editing to get the result.



2140
2141
2142
2143
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2140

def edit_document_finish_editing(req_config, opts = {})
  data, _status_code, _headers = edit_document_finish_editing_with_http_info(req_config, opts)
  data
end

#edit_document_finish_editing_with_http_info(req_config, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Finish editing document, and download result from document editing Once done editing a document, download the result. Begin editing a document by calling begin-editing, then perform operations, then call finish-editing to get the result.



2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2150

def edit_document_finish_editing_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_finish_editing ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_finish_editing"
  end
  # resource path
  local_var_path = '/convert/edit/finish-editing'

  # 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(req_config)
  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: EditDocumentApi#edit_document_finish_editing\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_pptx_delete_slides(req_config, opts = {}) ⇒ String

Delete, remove slides from a PowerPoint PPTX presentation document Edits the input PowerPoint PPTX presentation document to remove the specified slides



2194
2195
2196
2197
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2194

def edit_document_pptx_delete_slides(req_config, opts = {})
  data, _status_code, _headers = edit_document_pptx_delete_slides_with_http_info(req_config, opts)
  data
end

#edit_document_pptx_delete_slides_with_http_info(req_config, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete, remove slides from a PowerPoint PPTX presentation document Edits the input PowerPoint PPTX presentation document to remove the specified slides



2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2204

def edit_document_pptx_delete_slides_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_pptx_delete_slides ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_pptx_delete_slides"
  end
  # resource path
  local_var_path = '/convert/edit/pptx/delete-slides'

  # 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(req_config)
  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: EditDocumentApi#edit_document_pptx_delete_slides\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_pptx_get_macro_information(input_file, opts = {}) ⇒ GetMacrosResponse

Get macro information from a PowerPoint PPTX/PPTM presentation document Returns information about the Macros (e.g. VBA) defined in the PowerPoint Document



2248
2249
2250
2251
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2248

def edit_document_pptx_get_macro_information(input_file, opts = {})
  data, _status_code, _headers = edit_document_pptx_get_macro_information_with_http_info(input_file, opts)
  data
end

#edit_document_pptx_get_macro_information_with_http_info(input_file, opts = {}) ⇒ Array<(GetMacrosResponse, Fixnum, Hash)>

Get macro information from a PowerPoint PPTX/PPTM presentation document Returns information about the Macros (e.g. VBA) defined in the PowerPoint Document



2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2258

def edit_document_pptx_get_macro_information_with_http_info(input_file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_pptx_get_macro_information ...'
  end
  # verify the required parameter 'input_file' is set
  if @api_client.config.client_side_validation && input_file.nil?
    fail ArgumentError, "Missing the required parameter 'input_file' when calling EditDocumentApi.edit_document_pptx_get_macro_information"
  end
  # resource path
  local_var_path = '/convert/edit/pptx/get-macros'

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['inputFile'] = input_file

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

#edit_document_pptx_replace(req_config, opts = {}) ⇒ String

Replace string in PowerPoint PPTX presentation Replace all instances of a string in an Office PowerPoint Document (pptx)



2303
2304
2305
2306
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2303

def edit_document_pptx_replace(req_config, opts = {})
  data, _status_code, _headers = edit_document_pptx_replace_with_http_info(req_config, opts)
  data
end

#edit_document_pptx_replace_with_http_info(req_config, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Replace string in PowerPoint PPTX presentation Replace all instances of a string in an Office PowerPoint Document (pptx)



2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2313

def edit_document_pptx_replace_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_pptx_replace ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_pptx_replace"
  end
  # resource path
  local_var_path = '/convert/edit/pptx/replace-all'

  # 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(req_config)
  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: EditDocumentApi#edit_document_pptx_replace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_xlsx_append_row(input, opts = {}) ⇒ AppendXlsxRowResponse

Append row to a Excel XLSX spreadsheet, worksheet Appends a row to the end of an Excel Spreadsheet worksheet.



2357
2358
2359
2360
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2357

def edit_document_xlsx_append_row(input, opts = {})
  data, _status_code, _headers = edit_document_xlsx_append_row_with_http_info(input, opts)
  data
end

#edit_document_xlsx_append_row_with_http_info(input, opts = {}) ⇒ Array<(AppendXlsxRowResponse, Fixnum, Hash)>

Append row to a Excel XLSX spreadsheet, worksheet Appends a row to the end of an Excel Spreadsheet worksheet.



2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2367

def edit_document_xlsx_append_row_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_xlsx_append_row ...'
  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 EditDocumentApi.edit_document_xlsx_append_row"
  end
  # resource path
  local_var_path = '/convert/edit/xlsx/append-row'

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

#edit_document_xlsx_clear_cell_by_index(input, opts = {}) ⇒ ClearXlsxCellResponse

Clear cell contents in an Excel XLSX spreadsheet, worksheet by index Clears, sets to blank, the contents of a specific cell in an Excel XLSX spreadsheet, worksheet



2411
2412
2413
2414
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2411

def edit_document_xlsx_clear_cell_by_index(input, opts = {})
  data, _status_code, _headers = edit_document_xlsx_clear_cell_by_index_with_http_info(input, opts)
  data
end

#edit_document_xlsx_clear_cell_by_index_with_http_info(input, opts = {}) ⇒ Array<(ClearXlsxCellResponse, Fixnum, Hash)>

Clear cell contents in an Excel XLSX spreadsheet, worksheet by index Clears, sets to blank, the contents of a specific cell in an Excel XLSX spreadsheet, worksheet



2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2421

def edit_document_xlsx_clear_cell_by_index_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_xlsx_clear_cell_by_index ...'
  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 EditDocumentApi.edit_document_xlsx_clear_cell_by_index"
  end
  # resource path
  local_var_path = '/convert/edit/xlsx/clear-cell/by-index'

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

#edit_document_xlsx_clear_row(input, opts = {}) ⇒ ClearXlsxRowResponse

Clear row from a Excel XLSX spreadsheet, worksheet Clears data from a specific row in the Excel Spreadsheet worksheet, leaving a blank row. Use the Get Rows And Cells API to enumerate available rows in a spreadsheet.



2465
2466
2467
2468
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2465

def edit_document_xlsx_clear_row(input, opts = {})
  data, _status_code, _headers = edit_document_xlsx_clear_row_with_http_info(input, opts)
  data
end

#edit_document_xlsx_clear_row_with_http_info(input, opts = {}) ⇒ Array<(ClearXlsxRowResponse, Fixnum, Hash)>

Clear row from a Excel XLSX spreadsheet, worksheet Clears data from a specific row in the Excel Spreadsheet worksheet, leaving a blank row. Use the Get Rows And Cells API to enumerate available rows in a spreadsheet.



2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2475

def edit_document_xlsx_clear_row_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_xlsx_clear_row ...'
  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 EditDocumentApi.edit_document_xlsx_clear_row"
  end
  # resource path
  local_var_path = '/convert/edit/xlsx/clear-row'

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

#edit_document_xlsx_create_blank_spreadsheet(input, opts = {}) ⇒ CreateBlankSpreadsheetResponse

Create a blank Excel XLSX spreadsheet Returns a blank Excel XLSX Spreadsheet (XLSX) format file



2519
2520
2521
2522
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2519

def edit_document_xlsx_create_blank_spreadsheet(input, opts = {})
  data, _status_code, _headers = edit_document_xlsx_create_blank_spreadsheet_with_http_info(input, opts)
  data
end

#edit_document_xlsx_create_blank_spreadsheet_with_http_info(input, opts = {}) ⇒ Array<(CreateBlankSpreadsheetResponse, Fixnum, Hash)>

Create a blank Excel XLSX spreadsheet Returns a blank Excel XLSX Spreadsheet (XLSX) format file



2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2529

def edit_document_xlsx_create_blank_spreadsheet_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_xlsx_create_blank_spreadsheet ...'
  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 EditDocumentApi.edit_document_xlsx_create_blank_spreadsheet"
  end
  # resource path
  local_var_path = '/convert/edit/xlsx/create/blank'

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

#edit_document_xlsx_create_spreadsheet_from_data(input, opts = {}) ⇒ CreateSpreadsheetFromDataResponse

Create a new Excel XLSX spreadsheet from column and row data Returns a new Excel XLSX Spreadsheet (XLSX) format file populated with column and row data specified as input



2573
2574
2575
2576
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2573

def edit_document_xlsx_create_spreadsheet_from_data(input, opts = {})
  data, _status_code, _headers = edit_document_xlsx_create_spreadsheet_from_data_with_http_info(input, opts)
  data
end

#edit_document_xlsx_create_spreadsheet_from_data_with_http_info(input, opts = {}) ⇒ Array<(CreateSpreadsheetFromDataResponse, Fixnum, Hash)>

Create a new Excel XLSX spreadsheet from column and row data Returns a new Excel XLSX Spreadsheet (XLSX) format file populated with column and row data specified as input



2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2583

def edit_document_xlsx_create_spreadsheet_from_data_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_xlsx_create_spreadsheet_from_data ...'
  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 EditDocumentApi.edit_document_xlsx_create_spreadsheet_from_data"
  end
  # resource path
  local_var_path = '/convert/edit/xlsx/create/from/data'

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

#edit_document_xlsx_delete_worksheet(req_config, opts = {}) ⇒ String

Delete, remove worksheet from an Excel XLSX spreadsheet document Edits the input Excel XLSX spreadsheet document to remove the specified worksheet (tab). Use the Get Worksheets API to enumerate available worksheets in a spreadsheet.



2627
2628
2629
2630
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2627

def edit_document_xlsx_delete_worksheet(req_config, opts = {})
  data, _status_code, _headers = edit_document_xlsx_delete_worksheet_with_http_info(req_config, opts)
  data
end

#edit_document_xlsx_delete_worksheet_with_http_info(req_config, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete, remove worksheet from an Excel XLSX spreadsheet document Edits the input Excel XLSX spreadsheet document to remove the specified worksheet (tab). Use the Get Worksheets API to enumerate available worksheets in a spreadsheet.



2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2637

def edit_document_xlsx_delete_worksheet_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_xlsx_delete_worksheet ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_xlsx_delete_worksheet"
  end
  # resource path
  local_var_path = '/convert/edit/xlsx/delete-worksheet'

  # 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(req_config)
  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: EditDocumentApi#edit_document_xlsx_delete_worksheet\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_document_xlsx_disable_shared_workbook(input, opts = {}) ⇒ DisableSharedWorkbookResponse

Disable Shared Workbook (legacy) in Excel XLSX spreadsheet Disable the Shared Workbook (legacy) mode in an Excel XLSX spreadsheet



2681
2682
2683
2684
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2681

def edit_document_xlsx_disable_shared_workbook(input, opts = {})
  data, _status_code, _headers = edit_document_xlsx_disable_shared_workbook_with_http_info(input, opts)
  data
end

#edit_document_xlsx_disable_shared_workbook_with_http_info(input, opts = {}) ⇒ Array<(DisableSharedWorkbookResponse, Fixnum, Hash)>

Disable Shared Workbook (legacy) in Excel XLSX spreadsheet Disable the Shared Workbook (legacy) mode in an Excel XLSX spreadsheet



2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2691

def edit_document_xlsx_disable_shared_workbook_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_xlsx_disable_shared_workbook ...'
  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 EditDocumentApi.edit_document_xlsx_disable_shared_workbook"
  end
  # resource path
  local_var_path = '/convert/edit/xlsx/configuration/disable-shared-workbook'

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

#edit_document_xlsx_enable_shared_workbook(input, opts = {}) ⇒ EnableSharedWorkbookResponse

Enable Shared Workbook (legacy) in Excel XLSX spreadsheet Enables the Shared Workbook (legacy) mode in an Excel XLSX spreadsheet



2735
2736
2737
2738
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2735

def edit_document_xlsx_enable_shared_workbook(input, opts = {})
  data, _status_code, _headers = edit_document_xlsx_enable_shared_workbook_with_http_info(input, opts)
  data
end

#edit_document_xlsx_enable_shared_workbook_with_http_info(input, opts = {}) ⇒ Array<(EnableSharedWorkbookResponse, Fixnum, Hash)>

Enable Shared Workbook (legacy) in Excel XLSX spreadsheet Enables the Shared Workbook (legacy) mode in an Excel XLSX spreadsheet



2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2745

def edit_document_xlsx_enable_shared_workbook_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_xlsx_enable_shared_workbook ...'
  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 EditDocumentApi.edit_document_xlsx_enable_shared_workbook"
  end
  # resource path
  local_var_path = '/convert/edit/xlsx/configuration/enable-shared-workbook'

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

#edit_document_xlsx_get_cell_by_identifier(input, opts = {}) ⇒ GetXlsxCellByIdentifierResponse

Get cell from an Excel XLSX spreadsheet, worksheet by cell identifier Returns the value of a specific cell based on its identifier (e.g. A1, B22, C33, etc.) in the Excel Spreadsheet worksheet



2789
2790
2791
2792
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2789

def edit_document_xlsx_get_cell_by_identifier(input, opts = {})
  data, _status_code, _headers = edit_document_xlsx_get_cell_by_identifier_with_http_info(input, opts)
  data
end

#edit_document_xlsx_get_cell_by_identifier_with_http_info(input, opts = {}) ⇒ Array<(GetXlsxCellByIdentifierResponse, Fixnum, Hash)>

Get cell from an Excel XLSX spreadsheet, worksheet by cell identifier Returns the value of a specific cell based on its identifier (e.g. A1, B22, C33, etc.) in the Excel Spreadsheet worksheet



2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2799

def edit_document_xlsx_get_cell_by_identifier_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_xlsx_get_cell_by_identifier ...'
  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 EditDocumentApi.edit_document_xlsx_get_cell_by_identifier"
  end
  # resource path
  local_var_path = '/convert/edit/xlsx/get-cell/by-identifier'

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

#edit_document_xlsx_get_cell_by_index(input, opts = {}) ⇒ GetXlsxCellResponse

Get cell from an Excel XLSX spreadsheet, worksheet by index Returns the value and definition of a specific cell in a specific row in the Excel Spreadsheet worksheet



2843
2844
2845
2846
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2843

def edit_document_xlsx_get_cell_by_index(input, opts = {})
  data, _status_code, _headers = edit_document_xlsx_get_cell_by_index_with_http_info(input, opts)
  data
end

#edit_document_xlsx_get_cell_by_index_with_http_info(input, opts = {}) ⇒ Array<(GetXlsxCellResponse, Fixnum, Hash)>

Get cell from an Excel XLSX spreadsheet, worksheet by index Returns the value and definition of a specific cell in a specific row in the Excel Spreadsheet worksheet



2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2853

def edit_document_xlsx_get_cell_by_index_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_xlsx_get_cell_by_index ...'
  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 EditDocumentApi.edit_document_xlsx_get_cell_by_index"
  end
  # resource path
  local_var_path = '/convert/edit/xlsx/get-cell/by-index'

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

#edit_document_xlsx_get_columns(input, opts = {}) ⇒ GetXlsxColumnsResponse

Get columns from a Excel XLSX spreadsheet, worksheet Returns the columns defined in the Excel Spreadsheet worksheet



2897
2898
2899
2900
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2897

def edit_document_xlsx_get_columns(input, opts = {})
  data, _status_code, _headers = edit_document_xlsx_get_columns_with_http_info(input, opts)
  data
end

#edit_document_xlsx_get_columns_with_http_info(input, opts = {}) ⇒ Array<(GetXlsxColumnsResponse, Fixnum, Hash)>

Get columns from a Excel XLSX spreadsheet, worksheet Returns the columns defined in the Excel Spreadsheet worksheet



2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2907

def edit_document_xlsx_get_columns_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_xlsx_get_columns ...'
  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 EditDocumentApi.edit_document_xlsx_get_columns"
  end
  # resource path
  local_var_path = '/convert/edit/xlsx/get-columns'

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

#edit_document_xlsx_get_images(input, opts = {}) ⇒ GetXlsxImagesResponse

Get images from a Excel XLSX spreadsheet, worksheet Returns the images defined in the Excel Spreadsheet worksheet



2951
2952
2953
2954
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2951

def edit_document_xlsx_get_images(input, opts = {})
  data, _status_code, _headers = edit_document_xlsx_get_images_with_http_info(input, opts)
  data
end

#edit_document_xlsx_get_images_with_http_info(input, opts = {}) ⇒ Array<(GetXlsxImagesResponse, Fixnum, Hash)>

Get images from a Excel XLSX spreadsheet, worksheet Returns the images defined in the Excel Spreadsheet worksheet



2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 2961

def edit_document_xlsx_get_images_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_xlsx_get_images ...'
  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 EditDocumentApi.edit_document_xlsx_get_images"
  end
  # resource path
  local_var_path = '/convert/edit/xlsx/get-images'

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

#edit_document_xlsx_get_macro_information(input_file, opts = {}) ⇒ GetMacrosResponse

Get macro information from a Excel XLSX/XLSM spreadsheet, worksheet Returns information about the Macros (e.g. VBA) defined in the Excel Spreadsheet



3005
3006
3007
3008
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 3005

def edit_document_xlsx_get_macro_information(input_file, opts = {})
  data, _status_code, _headers = edit_document_xlsx_get_macro_information_with_http_info(input_file, opts)
  data
end

#edit_document_xlsx_get_macro_information_with_http_info(input_file, opts = {}) ⇒ Array<(GetMacrosResponse, Fixnum, Hash)>

Get macro information from a Excel XLSX/XLSM spreadsheet, worksheet Returns information about the Macros (e.g. VBA) defined in the Excel Spreadsheet



3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 3015

def edit_document_xlsx_get_macro_information_with_http_info(input_file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_xlsx_get_macro_information ...'
  end
  # verify the required parameter 'input_file' is set
  if @api_client.config.client_side_validation && input_file.nil?
    fail ArgumentError, "Missing the required parameter 'input_file' when calling EditDocumentApi.edit_document_xlsx_get_macro_information"
  end
  # resource path
  local_var_path = '/convert/edit/xlsx/get-macros'

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['inputFile'] = input_file

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

#edit_document_xlsx_get_rows_and_cells(input, opts = {}) ⇒ GetXlsxRowsAndCellsResponse

Get rows and cells from a Excel XLSX spreadsheet, worksheet Returns the rows and cells defined in the Excel Spreadsheet worksheet



3060
3061
3062
3063
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 3060

def edit_document_xlsx_get_rows_and_cells(input, opts = {})
  data, _status_code, _headers = edit_document_xlsx_get_rows_and_cells_with_http_info(input, opts)
  data
end

#edit_document_xlsx_get_rows_and_cells_with_http_info(input, opts = {}) ⇒ Array<(GetXlsxRowsAndCellsResponse, Fixnum, Hash)>

Get rows and cells from a Excel XLSX spreadsheet, worksheet Returns the rows and cells defined in the Excel Spreadsheet worksheet



3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 3070

def edit_document_xlsx_get_rows_and_cells_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_xlsx_get_rows_and_cells ...'
  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 EditDocumentApi.edit_document_xlsx_get_rows_and_cells"
  end
  # resource path
  local_var_path = '/convert/edit/xlsx/get-rows-and-cells'

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

#edit_document_xlsx_get_specific_row(input, opts = {}) ⇒ GetXlsxSpecificRowResponse

Get a specific row from a Excel XLSX spreadsheet, worksheet by path Returns the specific row and its cells defined in the Excel Spreadsheet worksheet based on the specified path.



3114
3115
3116
3117
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 3114

def edit_document_xlsx_get_specific_row(input, opts = {})
  data, _status_code, _headers = edit_document_xlsx_get_specific_row_with_http_info(input, opts)
  data
end

#edit_document_xlsx_get_specific_row_with_http_info(input, opts = {}) ⇒ Array<(GetXlsxSpecificRowResponse, Fixnum, Hash)>

Get a specific row from a Excel XLSX spreadsheet, worksheet by path Returns the specific row and its cells defined in the Excel Spreadsheet worksheet based on the specified path.



3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 3124

def edit_document_xlsx_get_specific_row_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_xlsx_get_specific_row ...'
  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 EditDocumentApi.edit_document_xlsx_get_specific_row"
  end
  # resource path
  local_var_path = '/convert/edit/xlsx/get-specific-row'

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

#edit_document_xlsx_get_styles(input, opts = {}) ⇒ GetXlsxStylesResponse

Get styles from a Excel XLSX spreadsheet, worksheet Returns the style defined in the Excel Spreadsheet



3168
3169
3170
3171
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 3168

def edit_document_xlsx_get_styles(input, opts = {})
  data, _status_code, _headers = edit_document_xlsx_get_styles_with_http_info(input, opts)
  data
end

#edit_document_xlsx_get_styles_with_http_info(input, opts = {}) ⇒ Array<(GetXlsxStylesResponse, Fixnum, Hash)>

Get styles from a Excel XLSX spreadsheet, worksheet Returns the style defined in the Excel Spreadsheet



3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 3178

def edit_document_xlsx_get_styles_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_xlsx_get_styles ...'
  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 EditDocumentApi.edit_document_xlsx_get_styles"
  end
  # resource path
  local_var_path = '/convert/edit/xlsx/get-styles'

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

#edit_document_xlsx_get_worksheets(input, opts = {}) ⇒ GetXlsxWorksheetsResponse

Get worksheets from a Excel XLSX spreadsheet Returns the worksheets (tabs) defined in the Excel Spreadsheet (XLSX) format file



3222
3223
3224
3225
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 3222

def edit_document_xlsx_get_worksheets(input, opts = {})
  data, _status_code, _headers = edit_document_xlsx_get_worksheets_with_http_info(input, opts)
  data
end

#edit_document_xlsx_get_worksheets_with_http_info(input, opts = {}) ⇒ Array<(GetXlsxWorksheetsResponse, Fixnum, Hash)>

Get worksheets from a Excel XLSX spreadsheet Returns the worksheets (tabs) defined in the Excel Spreadsheet (XLSX) format file



3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 3232

def edit_document_xlsx_get_worksheets_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_xlsx_get_worksheets ...'
  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 EditDocumentApi.edit_document_xlsx_get_worksheets"
  end
  # resource path
  local_var_path = '/convert/edit/xlsx/get-worksheets'

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

#edit_document_xlsx_insert_worksheet(input, opts = {}) ⇒ InsertXlsxWorksheetResponse

Insert a new worksheet into an Excel XLSX spreadsheet Inserts a new worksheet into an Excel Spreadsheet



3276
3277
3278
3279
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 3276

def edit_document_xlsx_insert_worksheet(input, opts = {})
  data, _status_code, _headers = edit_document_xlsx_insert_worksheet_with_http_info(input, opts)
  data
end

#edit_document_xlsx_insert_worksheet_with_http_info(input, opts = {}) ⇒ Array<(InsertXlsxWorksheetResponse, Fixnum, Hash)>

Insert a new worksheet into an Excel XLSX spreadsheet Inserts a new worksheet into an Excel Spreadsheet



3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 3286

def edit_document_xlsx_insert_worksheet_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_xlsx_insert_worksheet ...'
  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 EditDocumentApi.edit_document_xlsx_insert_worksheet"
  end
  # resource path
  local_var_path = '/convert/edit/xlsx/insert-worksheet'

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

#edit_document_xlsx_rename_worksheet(input, opts = {}) ⇒ RenameXlsxWorksheetResponse

Rename a specific worksheet in a Excel XLSX spreadsheet Edits the input Excel XLSX spreadsheet document to rename a specified worksheet (tab). Use the Get Worksheets API to enumerate available worksheets in a spreadsheet.



3330
3331
3332
3333
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 3330

def edit_document_xlsx_rename_worksheet(input, opts = {})
  data, _status_code, _headers = edit_document_xlsx_rename_worksheet_with_http_info(input, opts)
  data
end

#edit_document_xlsx_rename_worksheet_with_http_info(input, opts = {}) ⇒ Array<(RenameXlsxWorksheetResponse, Fixnum, Hash)>

Rename a specific worksheet in a Excel XLSX spreadsheet Edits the input Excel XLSX spreadsheet document to rename a specified worksheet (tab). Use the Get Worksheets API to enumerate available worksheets in a spreadsheet.



3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 3340

def edit_document_xlsx_rename_worksheet_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_xlsx_rename_worksheet ...'
  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 EditDocumentApi.edit_document_xlsx_rename_worksheet"
  end
  # resource path
  local_var_path = '/convert/edit/xlsx/rename-worksheet'

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

#edit_document_xlsx_set_cell_by_identifier(input, opts = {}) ⇒ SetXlsxCellByIdentifierResponse

Set, update cell contents in an Excel XLSX spreadsheet, worksheet by cell identifier Sets, updates the contents of a specific cell in an Excel XLSX spreadsheet, worksheet using its cell identifier (e.g. A1, B22, C33) in the worksheet



3384
3385
3386
3387
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 3384

def edit_document_xlsx_set_cell_by_identifier(input, opts = {})
  data, _status_code, _headers = edit_document_xlsx_set_cell_by_identifier_with_http_info(input, opts)
  data
end

#edit_document_xlsx_set_cell_by_identifier_with_http_info(input, opts = {}) ⇒ Array<(SetXlsxCellByIdentifierResponse, Fixnum, Hash)>

Set, update cell contents in an Excel XLSX spreadsheet, worksheet by cell identifier Sets, updates the contents of a specific cell in an Excel XLSX spreadsheet, worksheet using its cell identifier (e.g. A1, B22, C33) in the worksheet



3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 3394

def edit_document_xlsx_set_cell_by_identifier_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_xlsx_set_cell_by_identifier ...'
  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 EditDocumentApi.edit_document_xlsx_set_cell_by_identifier"
  end
  # resource path
  local_var_path = '/convert/edit/xlsx/set-cell/by-identifier'

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

#edit_document_xlsx_set_cell_by_index(input, opts = {}) ⇒ SetXlsxCellResponse

Set, update cell contents in an Excel XLSX spreadsheet, worksheet by index Sets, updates the contents of a specific cell in an Excel XLSX spreadsheet, worksheet



3438
3439
3440
3441
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 3438

def edit_document_xlsx_set_cell_by_index(input, opts = {})
  data, _status_code, _headers = edit_document_xlsx_set_cell_by_index_with_http_info(input, opts)
  data
end

#edit_document_xlsx_set_cell_by_index_with_http_info(input, opts = {}) ⇒ Array<(SetXlsxCellResponse, Fixnum, Hash)>

Set, update cell contents in an Excel XLSX spreadsheet, worksheet by index Sets, updates the contents of a specific cell in an Excel XLSX spreadsheet, worksheet



3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 3448

def edit_document_xlsx_set_cell_by_index_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_xlsx_set_cell_by_index ...'
  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 EditDocumentApi.edit_document_xlsx_set_cell_by_index"
  end
  # resource path
  local_var_path = '/convert/edit/xlsx/set-cell/by-index'

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