cloudmersive-convert-api-client 1.4.9 → 1.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -206,7 +206,7 @@ module CloudmersiveConvertApiClient
206
206
  return data, status_code, headers
207
207
  end
208
208
 
209
- # Multi-page format conversion
209
+ # Multi-page image format conversion
210
210
  # Convert between over 100 file formats, including support for Multiple-Page formats (e.g. PDFs, TIFFs, etc. with multiple pages).
211
211
  # @param format1 Input file format as a 3+ letter file extension. You can also provide UNKNOWN for unknown file formats. Supported formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV
212
212
  # @param format2 Output (convert to this format) file format as a 3+ letter file extension. Supported formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV
@@ -218,7 +218,7 @@ module CloudmersiveConvertApiClient
218
218
  return data
219
219
  end
220
220
 
221
- # Multi-page format conversion
221
+ # Multi-page image format conversion
222
222
  # Convert between over 100 file formats, including support for Multiple-Page formats (e.g. PDFs, TIFFs, etc. with multiple pages).
223
223
  # @param format1 Input file format as a 3+ letter file extension. You can also provide UNKNOWN for unknown file formats. Supported formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV
224
224
  # @param format2 Output (convert to this format) file format as a 3+ letter file extension. Supported formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV
@@ -20,9 +20,9 @@ module CloudmersiveConvertApiClient
20
20
  @api_client = api_client
21
21
  end
22
22
 
23
- # HTML to DOCX
23
+ # Convert HTML to DOCX
24
24
  # Convert HTML to Office Word Document (DOCX) format
25
- # @param input_request
25
+ # @param input_request HTL input to convert to DOCX
26
26
  # @param [Hash] opts the optional parameters
27
27
  # @return [String]
28
28
  def convert_web_html_to_docx(input_request, opts = {})
@@ -30,9 +30,9 @@ module CloudmersiveConvertApiClient
30
30
  return data
31
31
  end
32
32
 
33
- # HTML to DOCX
33
+ # Convert HTML to DOCX
34
34
  # Convert HTML to Office Word Document (DOCX) format
35
- # @param input_request
35
+ # @param input_request HTL input to convert to DOCX
36
36
  # @param [Hash] opts the optional parameters
37
37
  # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
38
38
  def convert_web_html_to_docx_with_http_info(input_request, opts = {})
@@ -107,7 +107,7 @@ module CloudmersiveConvertApiClient
107
107
  # header parameters
108
108
  header_params = {}
109
109
  # HTTP header 'Accept' (if needed)
110
- header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
110
+ header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
111
111
  # HTTP header 'Content-Type'
112
112
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
113
113
 
@@ -130,6 +130,61 @@ module CloudmersiveConvertApiClient
130
130
  return data, status_code, headers
131
131
  end
132
132
 
133
+ # Convert HTML string to PNG
134
+ # Fully renders a website and returns a PNG (screenshot) of the HTML. Javascript, HTML5, CSS and other advanced features are all supported.
135
+ # @param input HTML to PNG request parameters
136
+ # @param [Hash] opts the optional parameters
137
+ # @return [Object]
138
+ def convert_web_html_to_png(input, opts = {})
139
+ data, _status_code, _headers = convert_web_html_to_png_with_http_info(input, opts)
140
+ return data
141
+ end
142
+
143
+ # Convert HTML string to PNG
144
+ # Fully renders a website and returns a PNG (screenshot) of the HTML. Javascript, HTML5, CSS and other advanced features are all supported.
145
+ # @param input HTML to PNG request parameters
146
+ # @param [Hash] opts the optional parameters
147
+ # @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
148
+ def convert_web_html_to_png_with_http_info(input, opts = {})
149
+ if @api_client.config.debugging
150
+ @api_client.config.logger.debug "Calling API: ConvertWebApi.convert_web_html_to_png ..."
151
+ end
152
+ # verify the required parameter 'input' is set
153
+ if @api_client.config.client_side_validation && input.nil?
154
+ fail ArgumentError, "Missing the required parameter 'input' when calling ConvertWebApi.convert_web_html_to_png"
155
+ end
156
+ # resource path
157
+ local_var_path = "/convert/web/html/to/png"
158
+
159
+ # query parameters
160
+ query_params = {}
161
+
162
+ # header parameters
163
+ header_params = {}
164
+ # HTTP header 'Accept' (if needed)
165
+ header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
166
+ # HTTP header 'Content-Type'
167
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
168
+
169
+ # form parameters
170
+ form_params = {}
171
+
172
+ # http body (model)
173
+ post_body = @api_client.object_to_http_body(input)
174
+ auth_names = ['Apikey']
175
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
176
+ :header_params => header_params,
177
+ :query_params => query_params,
178
+ :form_params => form_params,
179
+ :body => post_body,
180
+ :auth_names => auth_names,
181
+ :return_type => 'Object')
182
+ if @api_client.config.debugging
183
+ @api_client.config.logger.debug "API called: ConvertWebApi#convert_web_html_to_png\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
184
+ end
185
+ return data, status_code, headers
186
+ end
187
+
133
188
  # Convert Markdown to HTML
134
189
  # Convert a markdown file (.md) to HTML
135
190
  # @param input_file Input file to perform the operation on.
@@ -218,7 +273,7 @@ module CloudmersiveConvertApiClient
218
273
  # header parameters
219
274
  header_params = {}
220
275
  # HTTP header 'Accept' (if needed)
221
- header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
276
+ header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
222
277
  # HTTP header 'Content-Type'
223
278
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
224
279
 
@@ -273,7 +328,7 @@ module CloudmersiveConvertApiClient
273
328
  # header parameters
274
329
  header_params = {}
275
330
  # HTTP header 'Accept' (if needed)
276
- header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
331
+ header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
277
332
  # HTTP header 'Content-Type'
278
333
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
279
334
 
@@ -76,9 +76,9 @@ module CloudmersiveConvertApiClient
76
76
  return data, status_code, headers
77
77
  end
78
78
 
79
- # Get body from a DOCX
79
+ # Get body from a Word DOCX document
80
80
  # Returns the body defined in the Word Document (DOCX) format file; this is the main content part of a DOCX document
81
- # @param req_config
81
+ # @param req_config Document input request
82
82
  # @param [Hash] opts the optional parameters
83
83
  # @return [GetDocxBodyResponse]
84
84
  def edit_document_docx_body(req_config, opts = {})
@@ -86,9 +86,9 @@ module CloudmersiveConvertApiClient
86
86
  return data
87
87
  end
88
88
 
89
- # Get body from a DOCX
89
+ # Get body from a Word DOCX document
90
90
  # Returns the body defined in the Word Document (DOCX) format file; this is the main content part of a DOCX document
91
- # @param req_config
91
+ # @param req_config Document input request
92
92
  # @param [Hash] opts the optional parameters
93
93
  # @return [Array<(GetDocxBodyResponse, Fixnum, Hash)>] GetDocxBodyResponse data, response status code and response headers
94
94
  def edit_document_docx_body_with_http_info(req_config, opts = {})
@@ -131,9 +131,9 @@ module CloudmersiveConvertApiClient
131
131
  return data, status_code, headers
132
132
  end
133
133
 
134
- # Get content of a footer from a DOCX
134
+ # Get content of a footer from a Word DOCX document
135
135
  # Returns the footer content from a Word Document (DOCX) format file
136
- # @param req_config
136
+ # @param req_config Document input request
137
137
  # @param [Hash] opts the optional parameters
138
138
  # @return [GetDocxHeadersAndFootersResponse]
139
139
  def edit_document_docx_get_headers_and_footers(req_config, opts = {})
@@ -141,9 +141,9 @@ module CloudmersiveConvertApiClient
141
141
  return data
142
142
  end
143
143
 
144
- # Get content of a footer from a DOCX
144
+ # Get content of a footer from a Word DOCX document
145
145
  # Returns the footer content from a Word Document (DOCX) format file
146
- # @param req_config
146
+ # @param req_config Document input request
147
147
  # @param [Hash] opts the optional parameters
148
148
  # @return [Array<(GetDocxHeadersAndFootersResponse, Fixnum, Hash)>] GetDocxHeadersAndFootersResponse data, response status code and response headers
149
149
  def edit_document_docx_get_headers_and_footers_with_http_info(req_config, opts = {})
@@ -186,9 +186,9 @@ module CloudmersiveConvertApiClient
186
186
  return data, status_code, headers
187
187
  end
188
188
 
189
- # Get images from a DOCX
189
+ # Get images from a Word DOCX document
190
190
  # Returns the images defined in the Word Document (DOCX) format file
191
- # @param req_config
191
+ # @param req_config Document input request
192
192
  # @param [Hash] opts the optional parameters
193
193
  # @return [GetDocxImagesResponse]
194
194
  def edit_document_docx_get_images(req_config, opts = {})
@@ -196,9 +196,9 @@ module CloudmersiveConvertApiClient
196
196
  return data
197
197
  end
198
198
 
199
- # Get images from a DOCX
199
+ # Get images from a Word DOCX document
200
200
  # Returns the images defined in the Word Document (DOCX) format file
201
- # @param req_config
201
+ # @param req_config Document input request
202
202
  # @param [Hash] opts the optional parameters
203
203
  # @return [Array<(GetDocxImagesResponse, Fixnum, Hash)>] GetDocxImagesResponse data, response status code and response headers
204
204
  def edit_document_docx_get_images_with_http_info(req_config, opts = {})
@@ -241,9 +241,9 @@ module CloudmersiveConvertApiClient
241
241
  return data, status_code, headers
242
242
  end
243
243
 
244
- # Get sections from a DOCX
244
+ # Get sections from a Word DOCX document
245
245
  # Returns the sections defined in the Word Document (DOCX) format file
246
- # @param req_config
246
+ # @param req_config Document input request
247
247
  # @param [Hash] opts the optional parameters
248
248
  # @return [GetDocxSectionsResponse]
249
249
  def edit_document_docx_get_sections(req_config, opts = {})
@@ -251,9 +251,9 @@ module CloudmersiveConvertApiClient
251
251
  return data
252
252
  end
253
253
 
254
- # Get sections from a DOCX
254
+ # Get sections from a Word DOCX document
255
255
  # Returns the sections defined in the Word Document (DOCX) format file
256
- # @param req_config
256
+ # @param req_config Document input request
257
257
  # @param [Hash] opts the optional parameters
258
258
  # @return [Array<(GetDocxSectionsResponse, Fixnum, Hash)>] GetDocxSectionsResponse data, response status code and response headers
259
259
  def edit_document_docx_get_sections_with_http_info(req_config, opts = {})
@@ -296,9 +296,9 @@ module CloudmersiveConvertApiClient
296
296
  return data, status_code, headers
297
297
  end
298
298
 
299
- # Get styles from a DOCX
299
+ # Get styles from a Word DOCX document
300
300
  # Returns the styles defined in the Word Document (DOCX) format file
301
- # @param req_config
301
+ # @param req_config Document input request
302
302
  # @param [Hash] opts the optional parameters
303
303
  # @return [GetDocxStylesResponse]
304
304
  def edit_document_docx_get_styles(req_config, opts = {})
@@ -306,9 +306,9 @@ module CloudmersiveConvertApiClient
306
306
  return data
307
307
  end
308
308
 
309
- # Get styles from a DOCX
309
+ # Get styles from a Word DOCX document
310
310
  # Returns the styles defined in the Word Document (DOCX) format file
311
- # @param req_config
311
+ # @param req_config Document input request
312
312
  # @param [Hash] opts the optional parameters
313
313
  # @return [Array<(GetDocxStylesResponse, Fixnum, Hash)>] GetDocxStylesResponse data, response status code and response headers
314
314
  def edit_document_docx_get_styles_with_http_info(req_config, opts = {})
@@ -351,9 +351,9 @@ module CloudmersiveConvertApiClient
351
351
  return data, status_code, headers
352
352
  end
353
353
 
354
- # Get tables in DOCX
354
+ # Get tables in Word DOCX document
355
355
  # Returns all the table objects in an Office Word Document (docx)
356
- # @param req_config
356
+ # @param req_config Document input request
357
357
  # @param [Hash] opts the optional parameters
358
358
  # @return [GetDocxTablesResponse]
359
359
  def edit_document_docx_get_tables(req_config, opts = {})
@@ -361,9 +361,9 @@ module CloudmersiveConvertApiClient
361
361
  return data
362
362
  end
363
363
 
364
- # Get tables in DOCX
364
+ # Get tables in Word DOCX document
365
365
  # Returns all the table objects in an Office Word Document (docx)
366
- # @param req_config
366
+ # @param req_config Document input request
367
367
  # @param [Hash] opts the optional parameters
368
368
  # @return [Array<(GetDocxTablesResponse, Fixnum, Hash)>] GetDocxTablesResponse data, response status code and response headers
369
369
  def edit_document_docx_get_tables_with_http_info(req_config, opts = {})
@@ -406,9 +406,9 @@ module CloudmersiveConvertApiClient
406
406
  return data, status_code, headers
407
407
  end
408
408
 
409
- # Insert image into a DOCX
410
- # Set the footer in a Word Document (DOCX)
411
- # @param req_config
409
+ # Insert image into a Word DOCX document
410
+ # Set the footer in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
411
+ # @param req_config Document input request
412
412
  # @param [Hash] opts the optional parameters
413
413
  # @return [DocxInsertImageResponse]
414
414
  def edit_document_docx_insert_image(req_config, opts = {})
@@ -416,9 +416,9 @@ module CloudmersiveConvertApiClient
416
416
  return data
417
417
  end
418
418
 
419
- # Insert image into a DOCX
420
- # Set the footer in a Word Document (DOCX)
421
- # @param req_config
419
+ # Insert image into a Word DOCX document
420
+ # Set the footer in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
421
+ # @param req_config Document input request
422
422
  # @param [Hash] opts the optional parameters
423
423
  # @return [Array<(DocxInsertImageResponse, Fixnum, Hash)>] DocxInsertImageResponse data, response status code and response headers
424
424
  def edit_document_docx_insert_image_with_http_info(req_config, opts = {})
@@ -461,9 +461,9 @@ module CloudmersiveConvertApiClient
461
461
  return data, status_code, headers
462
462
  end
463
463
 
464
- # Insert a new paragraph into a DOCX
465
- # 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).
466
- # @param req_config
464
+ # Insert a new paragraph into a Word DOCX document
465
+ # 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.
466
+ # @param req_config Document input request
467
467
  # @param [Hash] opts the optional parameters
468
468
  # @return [InsertDocxInsertParagraphResponse]
469
469
  def edit_document_docx_insert_paragraph(req_config, opts = {})
@@ -471,9 +471,9 @@ module CloudmersiveConvertApiClient
471
471
  return data
472
472
  end
473
473
 
474
- # Insert a new paragraph into a DOCX
475
- # 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).
476
- # @param req_config
474
+ # Insert a new paragraph into a Word DOCX document
475
+ # 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.
476
+ # @param req_config Document input request
477
477
  # @param [Hash] opts the optional parameters
478
478
  # @return [Array<(InsertDocxInsertParagraphResponse, Fixnum, Hash)>] InsertDocxInsertParagraphResponse data, response status code and response headers
479
479
  def edit_document_docx_insert_paragraph_with_http_info(req_config, opts = {})
@@ -516,9 +516,9 @@ module CloudmersiveConvertApiClient
516
516
  return data, status_code, headers
517
517
  end
518
518
 
519
- # Insert a new table into a DOCX
520
- # Adds a new table into a DOCX and returns the result
521
- # @param req_config
519
+ # Insert a new table into a Word DOCX document
520
+ # Adds a new table into a DOCX and returns the result. Call Finish Editing on the output URL to complete the operation.
521
+ # @param req_config Document input request
522
522
  # @param [Hash] opts the optional parameters
523
523
  # @return [InsertDocxTablesResponse]
524
524
  def edit_document_docx_insert_table(req_config, opts = {})
@@ -526,9 +526,9 @@ module CloudmersiveConvertApiClient
526
526
  return data
527
527
  end
528
528
 
529
- # Insert a new table into a DOCX
530
- # Adds a new table into a DOCX and returns the result
531
- # @param req_config
529
+ # Insert a new table into a Word DOCX document
530
+ # Adds a new table into a DOCX and returns the result. Call Finish Editing on the output URL to complete the operation.
531
+ # @param req_config Document input request
532
532
  # @param [Hash] opts the optional parameters
533
533
  # @return [Array<(InsertDocxTablesResponse, Fixnum, Hash)>] InsertDocxTablesResponse data, response status code and response headers
534
534
  def edit_document_docx_insert_table_with_http_info(req_config, opts = {})
@@ -571,9 +571,9 @@ module CloudmersiveConvertApiClient
571
571
  return data, status_code, headers
572
572
  end
573
573
 
574
- # Remove headers and footers from DOCX
575
- # Remove all headers, or footers, or both from a Word Document (DOCX)
576
- # @param req_config
574
+ # Remove headers and footers from Word DOCX document
575
+ # Remove all headers, or footers, or both from a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
576
+ # @param req_config Document input request
577
577
  # @param [Hash] opts the optional parameters
578
578
  # @return [RemoveDocxHeadersAndFootersResponse]
579
579
  def edit_document_docx_remove_headers_and_footers(req_config, opts = {})
@@ -581,9 +581,9 @@ module CloudmersiveConvertApiClient
581
581
  return data
582
582
  end
583
583
 
584
- # Remove headers and footers from DOCX
585
- # Remove all headers, or footers, or both from a Word Document (DOCX)
586
- # @param req_config
584
+ # Remove headers and footers from Word DOCX document
585
+ # Remove all headers, or footers, or both from a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
586
+ # @param req_config Document input request
587
587
  # @param [Hash] opts the optional parameters
588
588
  # @return [Array<(RemoveDocxHeadersAndFootersResponse, Fixnum, Hash)>] RemoveDocxHeadersAndFootersResponse data, response status code and response headers
589
589
  def edit_document_docx_remove_headers_and_footers_with_http_info(req_config, opts = {})
@@ -626,9 +626,9 @@ module CloudmersiveConvertApiClient
626
626
  return data, status_code, headers
627
627
  end
628
628
 
629
- # Delete any object in a DOCX
630
- # 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.
631
- # @param req_config
629
+ # Delete any object in a Word DOCX document
630
+ # 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.
631
+ # @param req_config Document input request
632
632
  # @param [Hash] opts the optional parameters
633
633
  # @return [DocxRemoveObjectResponse]
634
634
  def edit_document_docx_remove_object(req_config, opts = {})
@@ -636,9 +636,9 @@ module CloudmersiveConvertApiClient
636
636
  return data
637
637
  end
638
638
 
639
- # Delete any object in a DOCX
640
- # 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.
641
- # @param req_config
639
+ # Delete any object in a Word DOCX document
640
+ # 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.
641
+ # @param req_config Document input request
642
642
  # @param [Hash] opts the optional parameters
643
643
  # @return [Array<(DocxRemoveObjectResponse, Fixnum, Hash)>] DocxRemoveObjectResponse data, response status code and response headers
644
644
  def edit_document_docx_remove_object_with_http_info(req_config, opts = {})
@@ -681,9 +681,9 @@ module CloudmersiveConvertApiClient
681
681
  return data, status_code, headers
682
682
  end
683
683
 
684
- # Replace string in DOCX
684
+ # Replace string in Word DOCX document
685
685
  # Replace all instances of a string in an Office Word Document (docx)
686
- # @param req_config
686
+ # @param req_config Document string replacement configuration input
687
687
  # @param [Hash] opts the optional parameters
688
688
  # @return [String]
689
689
  def edit_document_docx_replace(req_config, opts = {})
@@ -691,9 +691,9 @@ module CloudmersiveConvertApiClient
691
691
  return data
692
692
  end
693
693
 
694
- # Replace string in DOCX
694
+ # Replace string in Word DOCX document
695
695
  # Replace all instances of a string in an Office Word Document (docx)
696
- # @param req_config
696
+ # @param req_config Document string replacement configuration input
697
697
  # @param [Hash] opts the optional parameters
698
698
  # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
699
699
  def edit_document_docx_replace_with_http_info(req_config, opts = {})
@@ -736,9 +736,9 @@ module CloudmersiveConvertApiClient
736
736
  return data, status_code, headers
737
737
  end
738
738
 
739
- # Set the footer in a DOCX
740
- # Set the footer in a Word Document (DOCX)
741
- # @param req_config
739
+ # Set the footer in a Word DOCX document
740
+ # Set the footer in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
741
+ # @param req_config Document input request
742
742
  # @param [Hash] opts the optional parameters
743
743
  # @return [DocxSetFooterResponse]
744
744
  def edit_document_docx_set_footer(req_config, opts = {})
@@ -746,9 +746,9 @@ module CloudmersiveConvertApiClient
746
746
  return data
747
747
  end
748
748
 
749
- # Set the footer in a DOCX
750
- # Set the footer in a Word Document (DOCX)
751
- # @param req_config
749
+ # Set the footer in a Word DOCX document
750
+ # Set the footer in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
751
+ # @param req_config Document input request
752
752
  # @param [Hash] opts the optional parameters
753
753
  # @return [Array<(DocxSetFooterResponse, Fixnum, Hash)>] DocxSetFooterResponse data, response status code and response headers
754
754
  def edit_document_docx_set_footer_with_http_info(req_config, opts = {})
@@ -791,9 +791,9 @@ module CloudmersiveConvertApiClient
791
791
  return data, status_code, headers
792
792
  end
793
793
 
794
- # Add page number to footer in a DOCX
795
- # Set the footer in a Word Document (DOCX) to contain a page number
796
- # @param req_config
794
+ # Add page number to footer in a Word DOCX document
795
+ # Set the footer in a Word Document (DOCX) to contain a page number. Call Finish Editing on the output URL to complete the operation.
796
+ # @param req_config Document input request
797
797
  # @param [Hash] opts the optional parameters
798
798
  # @return [DocxSetFooterResponse]
799
799
  def edit_document_docx_set_footer_add_page_number(req_config, opts = {})
@@ -801,9 +801,9 @@ module CloudmersiveConvertApiClient
801
801
  return data
802
802
  end
803
803
 
804
- # Add page number to footer in a DOCX
805
- # Set the footer in a Word Document (DOCX) to contain a page number
806
- # @param req_config
804
+ # Add page number to footer in a Word DOCX document
805
+ # Set the footer in a Word Document (DOCX) to contain a page number. Call Finish Editing on the output URL to complete the operation.
806
+ # @param req_config Document input request
807
807
  # @param [Hash] opts the optional parameters
808
808
  # @return [Array<(DocxSetFooterResponse, Fixnum, Hash)>] DocxSetFooterResponse data, response status code and response headers
809
809
  def edit_document_docx_set_footer_add_page_number_with_http_info(req_config, opts = {})
@@ -846,9 +846,9 @@ module CloudmersiveConvertApiClient
846
846
  return data, status_code, headers
847
847
  end
848
848
 
849
- # Set the header in a DOCX
850
- # Set the header in a Word Document (DOCX)
851
- # @param req_config
849
+ # Set the header in a Word DOCX document
850
+ # Set the header in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
851
+ # @param req_config Document input request
852
852
  # @param [Hash] opts the optional parameters
853
853
  # @return [DocxSetHeaderResponse]
854
854
  def edit_document_docx_set_header(req_config, opts = {})
@@ -856,9 +856,9 @@ module CloudmersiveConvertApiClient
856
856
  return data
857
857
  end
858
858
 
859
- # Set the header in a DOCX
860
- # Set the header in a Word Document (DOCX)
861
- # @param req_config
859
+ # Set the header in a Word DOCX document
860
+ # Set the header in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
861
+ # @param req_config Document input request
862
862
  # @param [Hash] opts the optional parameters
863
863
  # @return [Array<(DocxSetHeaderResponse, Fixnum, Hash)>] DocxSetHeaderResponse data, response status code and response headers
864
864
  def edit_document_docx_set_header_with_http_info(req_config, opts = {})
@@ -903,7 +903,7 @@ module CloudmersiveConvertApiClient
903
903
 
904
904
  # Download result from document editing
905
905
  # 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.
906
- # @param req_config
906
+ # @param req_config Cloudmersive Document URL to complete editing on
907
907
  # @param [Hash] opts the optional parameters
908
908
  # @return [String]
909
909
  def edit_document_finish_editing(req_config, opts = {})
@@ -913,7 +913,7 @@ module CloudmersiveConvertApiClient
913
913
 
914
914
  # Download result from document editing
915
915
  # 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.
916
- # @param req_config
916
+ # @param req_config Cloudmersive Document URL to complete editing on
917
917
  # @param [Hash] opts the optional parameters
918
918
  # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
919
919
  def edit_document_finish_editing_with_http_info(req_config, opts = {})
@@ -956,9 +956,9 @@ module CloudmersiveConvertApiClient
956
956
  return data, status_code, headers
957
957
  end
958
958
 
959
- # Replace string in PPTX
959
+ # Replace string in PowerPoint PPTX presentation
960
960
  # Replace all instances of a string in an Office PowerPoint Document (pptx)
961
- # @param req_config
961
+ # @param req_config Replacement document configuration input
962
962
  # @param [Hash] opts the optional parameters
963
963
  # @return [String]
964
964
  def edit_document_pptx_replace(req_config, opts = {})
@@ -966,9 +966,9 @@ module CloudmersiveConvertApiClient
966
966
  return data
967
967
  end
968
968
 
969
- # Replace string in PPTX
969
+ # Replace string in PowerPoint PPTX presentation
970
970
  # Replace all instances of a string in an Office PowerPoint Document (pptx)
971
- # @param req_config
971
+ # @param req_config Replacement document configuration input
972
972
  # @param [Hash] opts the optional parameters
973
973
  # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
974
974
  def edit_document_pptx_replace_with_http_info(req_config, opts = {})
@@ -1011,9 +1011,9 @@ module CloudmersiveConvertApiClient
1011
1011
  return data, status_code, headers
1012
1012
  end
1013
1013
 
1014
- # Get rows and cells from a XLSX worksheet
1014
+ # Get rows and cells from a Excel XLSX spreadsheet, worksheet
1015
1015
  # Returns the rows and cells defined in the Excel Spreadsheet worksheet
1016
- # @param input
1016
+ # @param input Document input request
1017
1017
  # @param [Hash] opts the optional parameters
1018
1018
  # @return [GetXlsxColumnsResponse]
1019
1019
  def edit_document_xlsx_get_columns(input, opts = {})
@@ -1021,9 +1021,9 @@ module CloudmersiveConvertApiClient
1021
1021
  return data
1022
1022
  end
1023
1023
 
1024
- # Get rows and cells from a XLSX worksheet
1024
+ # Get rows and cells from a Excel XLSX spreadsheet, worksheet
1025
1025
  # Returns the rows and cells defined in the Excel Spreadsheet worksheet
1026
- # @param input
1026
+ # @param input Document input request
1027
1027
  # @param [Hash] opts the optional parameters
1028
1028
  # @return [Array<(GetXlsxColumnsResponse, Fixnum, Hash)>] GetXlsxColumnsResponse data, response status code and response headers
1029
1029
  def edit_document_xlsx_get_columns_with_http_info(input, opts = {})
@@ -1066,9 +1066,9 @@ module CloudmersiveConvertApiClient
1066
1066
  return data, status_code, headers
1067
1067
  end
1068
1068
 
1069
- # Get images from a XLSX worksheet
1069
+ # Get images from a Excel XLSX spreadsheet, worksheet
1070
1070
  # Returns the images defined in the Excel Spreadsheet worksheet
1071
- # @param input
1071
+ # @param input Document input request
1072
1072
  # @param [Hash] opts the optional parameters
1073
1073
  # @return [GetXlsxImagesResponse]
1074
1074
  def edit_document_xlsx_get_images(input, opts = {})
@@ -1076,9 +1076,9 @@ module CloudmersiveConvertApiClient
1076
1076
  return data
1077
1077
  end
1078
1078
 
1079
- # Get images from a XLSX worksheet
1079
+ # Get images from a Excel XLSX spreadsheet, worksheet
1080
1080
  # Returns the images defined in the Excel Spreadsheet worksheet
1081
- # @param input
1081
+ # @param input Document input request
1082
1082
  # @param [Hash] opts the optional parameters
1083
1083
  # @return [Array<(GetXlsxImagesResponse, Fixnum, Hash)>] GetXlsxImagesResponse data, response status code and response headers
1084
1084
  def edit_document_xlsx_get_images_with_http_info(input, opts = {})
@@ -1121,9 +1121,9 @@ module CloudmersiveConvertApiClient
1121
1121
  return data, status_code, headers
1122
1122
  end
1123
1123
 
1124
- # Get rows and cells from a XLSX worksheet
1124
+ # Get rows and cells from a Word XLSX spreadsheet, worksheet
1125
1125
  # Returns the rows and cells defined in the Excel Spreadsheet worksheet
1126
- # @param input
1126
+ # @param input Document input request
1127
1127
  # @param [Hash] opts the optional parameters
1128
1128
  # @return [GetXlsxRowsAndCellsResponse]
1129
1129
  def edit_document_xlsx_get_rows_and_cells(input, opts = {})
@@ -1131,9 +1131,9 @@ module CloudmersiveConvertApiClient
1131
1131
  return data
1132
1132
  end
1133
1133
 
1134
- # Get rows and cells from a XLSX worksheet
1134
+ # Get rows and cells from a Word XLSX spreadsheet, worksheet
1135
1135
  # Returns the rows and cells defined in the Excel Spreadsheet worksheet
1136
- # @param input
1136
+ # @param input Document input request
1137
1137
  # @param [Hash] opts the optional parameters
1138
1138
  # @return [Array<(GetXlsxRowsAndCellsResponse, Fixnum, Hash)>] GetXlsxRowsAndCellsResponse data, response status code and response headers
1139
1139
  def edit_document_xlsx_get_rows_and_cells_with_http_info(input, opts = {})
@@ -1176,9 +1176,9 @@ module CloudmersiveConvertApiClient
1176
1176
  return data, status_code, headers
1177
1177
  end
1178
1178
 
1179
- # Get styles from a XLSX worksheet
1179
+ # Get styles from a Excel XLSX spreadsheet, worksheet
1180
1180
  # Returns the style defined in the Excel Spreadsheet
1181
- # @param input
1181
+ # @param input Document input request
1182
1182
  # @param [Hash] opts the optional parameters
1183
1183
  # @return [GetXlsxStylesResponse]
1184
1184
  def edit_document_xlsx_get_styles(input, opts = {})
@@ -1186,9 +1186,9 @@ module CloudmersiveConvertApiClient
1186
1186
  return data
1187
1187
  end
1188
1188
 
1189
- # Get styles from a XLSX worksheet
1189
+ # Get styles from a Excel XLSX spreadsheet, worksheet
1190
1190
  # Returns the style defined in the Excel Spreadsheet
1191
- # @param input
1191
+ # @param input Document input request
1192
1192
  # @param [Hash] opts the optional parameters
1193
1193
  # @return [Array<(GetXlsxStylesResponse, Fixnum, Hash)>] GetXlsxStylesResponse data, response status code and response headers
1194
1194
  def edit_document_xlsx_get_styles_with_http_info(input, opts = {})
@@ -1231,9 +1231,9 @@ module CloudmersiveConvertApiClient
1231
1231
  return data, status_code, headers
1232
1232
  end
1233
1233
 
1234
- # Get worksheets from a XLSX
1234
+ # Get worksheets from a Excel XLSX spreadsheet
1235
1235
  # Returns the worksheets (tabs) defined in the Excel Spreadsheet (XLSX) format file
1236
- # @param input
1236
+ # @param input Document input request
1237
1237
  # @param [Hash] opts the optional parameters
1238
1238
  # @return [GetXlsxWorksheetsResponse]
1239
1239
  def edit_document_xlsx_get_worksheets(input, opts = {})
@@ -1241,9 +1241,9 @@ module CloudmersiveConvertApiClient
1241
1241
  return data
1242
1242
  end
1243
1243
 
1244
- # Get worksheets from a XLSX
1244
+ # Get worksheets from a Excel XLSX spreadsheet
1245
1245
  # Returns the worksheets (tabs) defined in the Excel Spreadsheet (XLSX) format file
1246
- # @param input
1246
+ # @param input Document input request
1247
1247
  # @param [Hash] opts the optional parameters
1248
1248
  # @return [Array<(GetXlsxWorksheetsResponse, Fixnum, Hash)>] GetXlsxWorksheetsResponse data, response status code and response headers
1249
1249
  def edit_document_xlsx_get_worksheets_with_http_info(input, opts = {})
@@ -1286,9 +1286,9 @@ module CloudmersiveConvertApiClient
1286
1286
  return data, status_code, headers
1287
1287
  end
1288
1288
 
1289
- # Insert a new worksheet into an XLSX spreadsheet
1289
+ # Insert a new worksheet into an Excel XLSX spreadsheet
1290
1290
  # Inserts a new worksheet into an Excel Spreadsheet
1291
- # @param input
1291
+ # @param input Document input request
1292
1292
  # @param [Hash] opts the optional parameters
1293
1293
  # @return [InsertXlsxWorksheetResponse]
1294
1294
  def edit_document_xlsx_insert_worksheet(input, opts = {})
@@ -1296,9 +1296,9 @@ module CloudmersiveConvertApiClient
1296
1296
  return data
1297
1297
  end
1298
1298
 
1299
- # Insert a new worksheet into an XLSX spreadsheet
1299
+ # Insert a new worksheet into an Excel XLSX spreadsheet
1300
1300
  # Inserts a new worksheet into an Excel Spreadsheet
1301
- # @param input
1301
+ # @param input Document input request
1302
1302
  # @param [Hash] opts the optional parameters
1303
1303
  # @return [Array<(InsertXlsxWorksheetResponse, Fixnum, Hash)>] InsertXlsxWorksheetResponse data, response status code and response headers
1304
1304
  def edit_document_xlsx_insert_worksheet_with_http_info(input, opts = {})