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

Returns a new instance of 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

Parameters:

  • input_file —

    Input file to perform the operation on.

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

    the optional parameters

Returns:

  • (String) 


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

def edit_document_begin_editing(input_file, opts = {})
  data, _status_code, _headers = edit_document_begin_editing_with_http_info(input_file, opts)
  return 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

Parameters:

  • input_file —

    Input file to perform the operation on.

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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

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_body(req_config, opts = {}) ⇒ GetDocxBodyResponse

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

Parameters:

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

    the optional parameters

Returns:



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

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

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

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

Parameters:

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

    the optional parameters

Returns:

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

    GetDocxBodyResponse data, response status code and response headers



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 94

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_get_headers_and_footers(req_config, opts = {}) ⇒ GetDocxHeadersAndFootersResponse

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

Parameters:

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

    the optional parameters

Returns:



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

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)
  return 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 DOCX Returns the footer content from a Word Document (DOCX) format file

Parameters:

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

    the optional parameters

Returns:



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

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 DOCX Returns the images defined in the Word Document (DOCX) format file

Parameters:

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

    the optional parameters

Returns:



194
195
196
197
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 194

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

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

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

Parameters:

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

    the optional parameters

Returns:

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

    GetDocxImagesResponse data, response status code and response headers



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

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_sections(req_config, opts = {}) ⇒ GetDocxSectionsResponse

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

Parameters:

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

    the optional parameters

Returns:



249
250
251
252
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 249

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

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

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

Parameters:

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

    the optional parameters

Returns:

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

    GetDocxSectionsResponse data, response status code and response headers



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
294
295
296
297
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 259

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 DOCX Returns the styles defined in the Word Document (DOCX) format file

Parameters:

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

    the optional parameters

Returns:



304
305
306
307
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 304

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

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

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

Parameters:

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

    the optional parameters

Returns:

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

    GetDocxStylesResponse data, response status code and response headers



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
348
349
350
351
352
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 314

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_tables(req_config, opts = {}) ⇒ GetDocxTablesResponse

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

Parameters:

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

    the optional parameters

Returns:



359
360
361
362
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 359

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

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

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

Parameters:

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

    the optional parameters

Returns:

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

    GetDocxTablesResponse data, response status code and response headers



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

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/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 => '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_image(req_config, opts = {}) ⇒ DocxInsertImageResponse

Insert image into a DOCX Set the footer in a Word Document (DOCX)

Parameters:

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

    the optional parameters

Returns:



414
415
416
417
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 414

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

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

Insert image into a DOCX Set the footer in a Word Document (DOCX)

Parameters:

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

    the optional parameters

Returns:

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

    DocxInsertImageResponse data, response status code and response headers



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 424

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 DOCX 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).

Parameters:

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

    the optional parameters

Returns:



469
470
471
472
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 469

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

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

Insert a new paragraph into a DOCX 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).

Parameters:

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

    the optional parameters

Returns:



479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 479

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 DOCX Adds a new table into a DOCX and returns the result

Parameters:

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

    the optional parameters

Returns:



524
525
526
527
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 524

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

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

Insert a new table into a DOCX Adds a new table into a DOCX and returns the result

Parameters:

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

    the optional parameters

Returns:

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

    InsertDocxTablesResponse data, response status code and response headers



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
566
567
568
569
570
571
572
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 534

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_remove_headers_and_footers(req_config, opts = {}) ⇒ RemoveDocxHeadersAndFootersResponse

Remove headers and footers from DOCX Remove all headers, or footers, or both from a Word Document (DOCX)

Parameters:

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

    the optional parameters

Returns:



579
580
581
582
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 579

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)
  return data
end

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

Remove headers and footers from DOCX Remove all headers, or footers, or both from a Word Document (DOCX)

Parameters:

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

    the optional parameters

Returns:



589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 589

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 DOCX 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.

Parameters:

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

    the optional parameters

Returns:



634
635
636
637
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 634

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

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

Delete any object in a DOCX 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.

Parameters:

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

    the optional parameters

Returns:

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

    DocxRemoveObjectResponse data, response status code and response headers



644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 644

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 DOCX Replace all instances of a string in an Office Word Document (docx)

Parameters:

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

    the optional parameters

Returns:

  • (String) 


689
690
691
692
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 689

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

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

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

Parameters:

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 699

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_footer(req_config, opts = {}) ⇒ DocxSetFooterResponse

Set the footer in a DOCX Set the footer in a Word Document (DOCX)

Parameters:

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

    the optional parameters

Returns:



744
745
746
747
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 744

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

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

Set the footer in a DOCX Set the footer in a Word Document (DOCX)

Parameters:

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

    the optional parameters

Returns:

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

    DocxSetFooterResponse data, response status code and response headers



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

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 DOCX Set the header in a Word Document (DOCX)

Parameters:

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

    the optional parameters

Returns:



799
800
801
802
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 799

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

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

Set the header in a DOCX Set the header in a Word Document (DOCX)

Parameters:

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

    the optional parameters

Returns:

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

    DocxSetHeaderResponse data, response status code and response headers



809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 809

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_finish_editing(req_config, opts = {}) ⇒ String

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.

Parameters:

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

    the optional parameters

Returns:

  • (String) 


854
855
856
857
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 854

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

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

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.

Parameters:

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 864

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_replace(req_config, opts = {}) ⇒ String

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

Parameters:

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

    the optional parameters

Returns:

  • (String) 


909
910
911
912
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 909

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

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

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

Parameters:

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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

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_get_columns(input, opts = {}) ⇒ GetXlsxColumnsResponse

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

Parameters:

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

    the optional parameters

Returns:



964
965
966
967
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 964

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

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

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

Parameters:

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

    the optional parameters

Returns:

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

    GetXlsxColumnsResponse data, response status code and response headers



974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 974

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 XLSX worksheet Returns the images defined in the Excel Spreadsheet worksheet

Parameters:

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

    the optional parameters

Returns:



1019
1020
1021
1022
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1019

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

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

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

Parameters:

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

    the optional parameters

Returns:

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

    GetXlsxImagesResponse data, response status code and response headers



1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1029

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_rows_and_cells(input, opts = {}) ⇒ GetXlsxRowsAndCellsResponse

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

Parameters:

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

    the optional parameters

Returns:



1074
1075
1076
1077
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1074

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)
  return data
end

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

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

Parameters:

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

    the optional parameters

Returns:



1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1084

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_styles(input, opts = {}) ⇒ GetXlsxStylesResponse

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

Parameters:

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

    the optional parameters

Returns:



1129
1130
1131
1132
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1129

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

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

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

Parameters:

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

    the optional parameters

Returns:

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

    GetXlsxStylesResponse data, response status code and response headers



1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1139

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 XLSX Returns the worksheets (tabs) defined in the Excel Spreadsheet (XLSX) format file

Parameters:

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

    the optional parameters

Returns:



1184
1185
1186
1187
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1184

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

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

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

Parameters:

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

    the optional parameters

Returns:

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

    GetXlsxWorksheetsResponse data, response status code and response headers



1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1194

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 XLSX spreadsheet Inserts a new worksheet into an Excel Spreadsheet

Parameters:

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

    the optional parameters

Returns:



1239
1240
1241
1242
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1239

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

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

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

Parameters:

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

    the optional parameters

Returns:



1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
 
# File 'lib/cloudmersive-convert-api-client/api/edit_document_api.rb', line 1249

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