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.
@@ -81,7 +81,7 @@ describe 'ConvertDocumentApi' do
81
81
  end
82
82
 
83
83
  # unit tests for convert_document_csv_to_xlsx
84
- # CSV to Excel XLSX
84
+ # Convert CSV to Excel XLSX Spreadsheet
85
85
  # Convert CSV file to Office Excel XLSX Workbooks file format.
86
86
  # @param input_file Input file to perform the operation on.
87
87
  # @param [Hash] opts the optional parameters
@@ -93,7 +93,7 @@ describe 'ConvertDocumentApi' do
93
93
  end
94
94
 
95
95
  # unit tests for convert_document_doc_to_docx
96
- # Word DOC (97-03) to DOCX
96
+ # Convert Word DOC (97-03) Document to DOCX
97
97
  # Convert/upgrade Office Word (97-2003 Format) Documents (doc) to the modern DOCX format
98
98
  # @param input_file Input file to perform the operation on.
99
99
  # @param [Hash] opts the optional parameters
@@ -105,7 +105,7 @@ describe 'ConvertDocumentApi' do
105
105
  end
106
106
 
107
107
  # unit tests for convert_document_doc_to_pdf
108
- # Word DOC (97-03) to PDF
108
+ # Convert Word DOC (97-03) Document to PDF
109
109
  # Convert Office Word (97-2003 Format) Documents (doc) to standard PDF
110
110
  # @param input_file Input file to perform the operation on.
111
111
  # @param [Hash] opts the optional parameters
@@ -117,7 +117,7 @@ describe 'ConvertDocumentApi' do
117
117
  end
118
118
 
119
119
  # unit tests for convert_document_docx_to_pdf
120
- # Word DOCX to PDF
120
+ # Convert Word DOCX Document to PDF
121
121
  # Convert Office Word Documents (docx) to standard PDF
122
122
  # @param input_file Input file to perform the operation on.
123
123
  # @param [Hash] opts the optional parameters
@@ -129,7 +129,7 @@ describe 'ConvertDocumentApi' do
129
129
  end
130
130
 
131
131
  # unit tests for convert_document_docx_to_txt
132
- # Word DOCX to Text
132
+ # Convert Word DOCX Document to Text
133
133
  # Convert Office Word Documents (docx) to text
134
134
  # @param input_file Input file to perform the operation on.
135
135
  # @param [Hash] opts the optional parameters
@@ -141,7 +141,7 @@ describe 'ConvertDocumentApi' do
141
141
  end
142
142
 
143
143
  # unit tests for convert_document_html_to_pdf
144
- # HTML to PDF
144
+ # Convert HTML to PDF Document
145
145
  # Convert standard HTML, with full support for CSS, JavaScript, Images, and other complex behavior to PDF. To use external files such as images, use an absolute URL to the file.
146
146
  # @param input_file Input file to perform the operation on.
147
147
  # @param [Hash] opts the optional parameters
@@ -153,7 +153,7 @@ describe 'ConvertDocumentApi' do
153
153
  end
154
154
 
155
155
  # unit tests for convert_document_html_to_png
156
- # HTML to PNG array
156
+ # Convert HTML to PNG image array
157
157
  # Convert standard HTML, with full support for CSS, JavaScript, Images, and other complex behavior to an array of PNG images, one for each page. To use external files in your HTML such as images, use an absolute URL to the file.
158
158
  # @param input_file Input file to perform the operation on.
159
159
  # @param [Hash] opts the optional parameters
@@ -165,7 +165,7 @@ describe 'ConvertDocumentApi' do
165
165
  end
166
166
 
167
167
  # unit tests for convert_document_pdf_to_docx
168
- # PDF to Word DOCX
168
+ # Convert PDF to Word DOCX Document
169
169
  # Convert standard PDF to Office Word Documents (docx). Converts a PDF at high fidelity into Word format, where it can be easily edited and processed.
170
170
  # @param input_file Input file to perform the operation on.
171
171
  # @param [Hash] opts the optional parameters
@@ -177,7 +177,7 @@ describe 'ConvertDocumentApi' do
177
177
  end
178
178
 
179
179
  # unit tests for convert_document_pdf_to_png_array
180
- # PDF to PNG Array
180
+ # Convert PDF to PNG Image Array
181
181
  # Convert PDF document to PNG array, one image per page.
182
182
  # @param input_file Input file to perform the operation on.
183
183
  # @param [Hash] opts the optional parameters
@@ -189,7 +189,7 @@ describe 'ConvertDocumentApi' do
189
189
  end
190
190
 
191
191
  # unit tests for convert_document_pdf_to_png_single
192
- # PDF to Single PNG image
192
+ # Convert PDF to Single PNG image
193
193
  # Convert PDF document to a single tall PNG image, by stacking/concatenating the images vertically into a single \"tall\" image
194
194
  # @param input_file Input file to perform the operation on.
195
195
  # @param [Hash] opts the optional parameters
@@ -201,7 +201,7 @@ describe 'ConvertDocumentApi' do
201
201
  end
202
202
 
203
203
  # unit tests for convert_document_pdf_to_pptx
204
- # PDF to PowerPoint PPTX
204
+ # Convert PDF to PowerPoint PPTX Presentation
205
205
  # Convert standard PDF to Office PowerPoint Presentation (pptx). Converts a PDF file at high fidelity into PowerPoint format, where it can be easily edited and processed.
206
206
  # @param input_file Input file to perform the operation on.
207
207
  # @param [Hash] opts the optional parameters
@@ -213,7 +213,7 @@ describe 'ConvertDocumentApi' do
213
213
  end
214
214
 
215
215
  # unit tests for convert_document_pdf_to_txt
216
- # PDF to Text
216
+ # Convert PDF Document to Text
217
217
  # PDF document to text
218
218
  # @param input_file Input file to perform the operation on.
219
219
  # @param [Hash] opts the optional parameters
@@ -225,7 +225,7 @@ describe 'ConvertDocumentApi' do
225
225
  end
226
226
 
227
227
  # unit tests for convert_document_png_array_to_pdf
228
- # PNG Array to PDF
228
+ # Convert PNG Array to PDF
229
229
  # Convert an array of PNG images, one image per page, into a newly-created PDF. Supports images of different sizes as input.
230
230
  # @param input_file1 First input file to perform the operation on.
231
231
  # @param input_file2 Second input file to perform the operation on.
@@ -246,7 +246,7 @@ describe 'ConvertDocumentApi' do
246
246
  end
247
247
 
248
248
  # unit tests for convert_document_ppt_to_pdf
249
- # PowerPoint PPT (97-03) to PDF
249
+ # Convert PowerPoint PPT (97-03) Presentation to PDF
250
250
  # Convert Office PowerPoint (97-2003) Documents (ppt) to standard PDF
251
251
  # @param input_file Input file to perform the operation on.
252
252
  # @param [Hash] opts the optional parameters
@@ -258,7 +258,7 @@ describe 'ConvertDocumentApi' do
258
258
  end
259
259
 
260
260
  # unit tests for convert_document_ppt_to_pptx
261
- # PowerPoint PPT (97-03) to PPTX
261
+ # Convert PowerPoint PPT (97-03) Presentation to PPTX
262
262
  # Convert/upgrade Office PowerPoint (97-2003) Documents (ppt) to modern PPTX
263
263
  # @param input_file Input file to perform the operation on.
264
264
  # @param [Hash] opts the optional parameters
@@ -270,7 +270,7 @@ describe 'ConvertDocumentApi' do
270
270
  end
271
271
 
272
272
  # unit tests for convert_document_pptx_to_pdf
273
- # PowerPoint PPTX to PDF
273
+ # Convert PowerPoint PPTX Presentation to PDF
274
274
  # Convert Office PowerPoint Documents (pptx) to standard PDF
275
275
  # @param input_file Input file to perform the operation on.
276
276
  # @param [Hash] opts the optional parameters
@@ -282,7 +282,7 @@ describe 'ConvertDocumentApi' do
282
282
  end
283
283
 
284
284
  # unit tests for convert_document_pptx_to_txt
285
- # PowerPoint PPTX to Text
285
+ # Convert PowerPoint PPTX Presentation to Text
286
286
  # Convert Office PowerPoint Documents (pptx) to standard Text
287
287
  # @param input_file Input file to perform the operation on.
288
288
  # @param [Hash] opts the optional parameters
@@ -294,7 +294,7 @@ describe 'ConvertDocumentApi' do
294
294
  end
295
295
 
296
296
  # unit tests for convert_document_xls_to_csv
297
- # Excel XLS (97-03) to CSV
297
+ # Convert Excel XLS (97-03) Spreadsheet to CSV
298
298
  # Convert/upgrade Office Excel (97-2003) Workbooks (xls) to standard CSV format.
299
299
  # @param input_file Input file to perform the operation on.
300
300
  # @param [Hash] opts the optional parameters
@@ -306,7 +306,7 @@ describe 'ConvertDocumentApi' do
306
306
  end
307
307
 
308
308
  # unit tests for convert_document_xls_to_pdf
309
- # Excel XLS (97-03) to PDF
309
+ # Convert Excel XLS (97-03) Spreadsheet to PDF
310
310
  # Convert Office Excel (97-2003) Workbooks (xls) to standard PDF. Converts all worksheets in the workbook to PDF.
311
311
  # @param input_file Input file to perform the operation on.
312
312
  # @param [Hash] opts the optional parameters
@@ -318,7 +318,7 @@ describe 'ConvertDocumentApi' do
318
318
  end
319
319
 
320
320
  # unit tests for convert_document_xls_to_xlsx
321
- # Excel XLS (97-03) to XLSX
321
+ # Convert Excel XLS (97-03) Spreadsheet to XLSX
322
322
  # Convert/upgrade Office Excel (97-2003) Workbooks (xls) to modern XLSX format.
323
323
  # @param input_file Input file to perform the operation on.
324
324
  # @param [Hash] opts the optional parameters
@@ -330,7 +330,7 @@ describe 'ConvertDocumentApi' do
330
330
  end
331
331
 
332
332
  # unit tests for convert_document_xlsx_to_csv
333
- # Excel XLSX to CSV
333
+ # Convert Excel XLSX Spreadsheet to CSV
334
334
  # Convert Office Excel Workbooks (XLSX) to standard Comma-Separated Values (CSV) format. Supports both XLSX and XLSB file Excel formats.
335
335
  # @param input_file Input file to perform the operation on.
336
336
  # @param [Hash] opts the optional parameters
@@ -343,7 +343,7 @@ describe 'ConvertDocumentApi' do
343
343
  end
344
344
 
345
345
  # unit tests for convert_document_xlsx_to_pdf
346
- # Excel XLSX to PDF
346
+ # Convert Excel XLSX Spreadsheet to PDF
347
347
  # Convert Office Excel Workbooks (XLSX) to standard PDF. Converts all worksheets in the workbook to PDF. Supports both XLSX and XLSB Excel file formats.
348
348
  # @param input_file Input file to perform the operation on.
349
349
  # @param [Hash] opts the optional parameters
@@ -355,7 +355,7 @@ describe 'ConvertDocumentApi' do
355
355
  end
356
356
 
357
357
  # unit tests for convert_document_xlsx_to_txt
358
- # Excel XLSX to Text
358
+ # Convert Excel XLSX Spreadsheet to Text
359
359
  # Convert Office Excel Workbooks (XLSX) to standard Text. Converts all worksheets in the workbook to Text. Supports both XLSX and XLSB file formats.
360
360
  # @param input_file Input file to perform the operation on.
361
361
  # @param [Hash] opts the optional parameters
@@ -72,7 +72,7 @@ describe 'ConvertImageApi' do
72
72
  end
73
73
 
74
74
  # unit tests for convert_image_multipage_image_format_convert
75
- # Multi-page format conversion
75
+ # Multi-page image format conversion
76
76
  # Convert between over 100 file formats, including support for Multiple-Page formats (e.g. PDFs, TIFFs, etc. with multiple pages).
77
77
  # @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
78
78
  # @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
@@ -33,9 +33,9 @@ describe 'ConvertWebApi' do
33
33
  end
34
34
 
35
35
  # unit tests for convert_web_html_to_docx
36
- # HTML to DOCX
36
+ # Convert HTML to DOCX
37
37
  # Convert HTML to Office Word Document (DOCX) format
38
- # @param input_request
38
+ # @param input_request HTL input to convert to DOCX
39
39
  # @param [Hash] opts the optional parameters
40
40
  # @return [String]
41
41
  describe 'convert_web_html_to_docx test' do
@@ -56,6 +56,18 @@ describe 'ConvertWebApi' do
56
56
  end
57
57
  end
58
58
 
59
+ # unit tests for convert_web_html_to_png
60
+ # Convert HTML string to PNG
61
+ # Fully renders a website and returns a PNG (screenshot) of the HTML. Javascript, HTML5, CSS and other advanced features are all supported.
62
+ # @param input HTML to PNG request parameters
63
+ # @param [Hash] opts the optional parameters
64
+ # @return [Object]
65
+ describe 'convert_web_html_to_png test' do
66
+ it "should work" do
67
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
68
+ end
69
+ end
70
+
59
71
  # unit tests for convert_web_md_to_html
60
72
  # Convert Markdown to HTML
61
73
  # Convert a markdown file (.md) to HTML
@@ -45,9 +45,9 @@ describe 'EditDocumentApi' do
45
45
  end
46
46
 
47
47
  # unit tests for edit_document_docx_body
48
- # Get body from a DOCX
48
+ # Get body from a Word DOCX document
49
49
  # Returns the body defined in the Word Document (DOCX) format file; this is the main content part of a DOCX document
50
- # @param req_config
50
+ # @param req_config Document input request
51
51
  # @param [Hash] opts the optional parameters
52
52
  # @return [GetDocxBodyResponse]
53
53
  describe 'edit_document_docx_body test' do
@@ -57,9 +57,9 @@ describe 'EditDocumentApi' do
57
57
  end
58
58
 
59
59
  # unit tests for edit_document_docx_get_headers_and_footers
60
- # Get content of a footer from a DOCX
60
+ # Get content of a footer from a Word DOCX document
61
61
  # Returns the footer content from a Word Document (DOCX) format file
62
- # @param req_config
62
+ # @param req_config Document input request
63
63
  # @param [Hash] opts the optional parameters
64
64
  # @return [GetDocxHeadersAndFootersResponse]
65
65
  describe 'edit_document_docx_get_headers_and_footers test' do
@@ -69,9 +69,9 @@ describe 'EditDocumentApi' do
69
69
  end
70
70
 
71
71
  # unit tests for edit_document_docx_get_images
72
- # Get images from a DOCX
72
+ # Get images from a Word DOCX document
73
73
  # Returns the images defined in the Word Document (DOCX) format file
74
- # @param req_config
74
+ # @param req_config Document input request
75
75
  # @param [Hash] opts the optional parameters
76
76
  # @return [GetDocxImagesResponse]
77
77
  describe 'edit_document_docx_get_images test' do
@@ -81,9 +81,9 @@ describe 'EditDocumentApi' do
81
81
  end
82
82
 
83
83
  # unit tests for edit_document_docx_get_sections
84
- # Get sections from a DOCX
84
+ # Get sections from a Word DOCX document
85
85
  # Returns the sections defined in the Word Document (DOCX) format file
86
- # @param req_config
86
+ # @param req_config Document input request
87
87
  # @param [Hash] opts the optional parameters
88
88
  # @return [GetDocxSectionsResponse]
89
89
  describe 'edit_document_docx_get_sections test' do
@@ -93,9 +93,9 @@ describe 'EditDocumentApi' do
93
93
  end
94
94
 
95
95
  # unit tests for edit_document_docx_get_styles
96
- # Get styles from a DOCX
96
+ # Get styles from a Word DOCX document
97
97
  # Returns the styles defined in the Word Document (DOCX) format file
98
- # @param req_config
98
+ # @param req_config Document input request
99
99
  # @param [Hash] opts the optional parameters
100
100
  # @return [GetDocxStylesResponse]
101
101
  describe 'edit_document_docx_get_styles test' do
@@ -105,9 +105,9 @@ describe 'EditDocumentApi' do
105
105
  end
106
106
 
107
107
  # unit tests for edit_document_docx_get_tables
108
- # Get tables in DOCX
108
+ # Get tables in Word DOCX document
109
109
  # Returns all the table objects in an Office Word Document (docx)
110
- # @param req_config
110
+ # @param req_config Document input request
111
111
  # @param [Hash] opts the optional parameters
112
112
  # @return [GetDocxTablesResponse]
113
113
  describe 'edit_document_docx_get_tables test' do
@@ -117,9 +117,9 @@ describe 'EditDocumentApi' do
117
117
  end
118
118
 
119
119
  # unit tests for edit_document_docx_insert_image
120
- # Insert image into a DOCX
121
- # Set the footer in a Word Document (DOCX)
122
- # @param req_config
120
+ # Insert image into a Word DOCX document
121
+ # Set the footer in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
122
+ # @param req_config Document input request
123
123
  # @param [Hash] opts the optional parameters
124
124
  # @return [DocxInsertImageResponse]
125
125
  describe 'edit_document_docx_insert_image test' do
@@ -129,9 +129,9 @@ describe 'EditDocumentApi' do
129
129
  end
130
130
 
131
131
  # unit tests for edit_document_docx_insert_paragraph
132
- # Insert a new paragraph into a DOCX
133
- # 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).
134
- # @param req_config
132
+ # Insert a new paragraph into a Word DOCX document
133
+ # 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.
134
+ # @param req_config Document input request
135
135
  # @param [Hash] opts the optional parameters
136
136
  # @return [InsertDocxInsertParagraphResponse]
137
137
  describe 'edit_document_docx_insert_paragraph test' do
@@ -141,9 +141,9 @@ describe 'EditDocumentApi' do
141
141
  end
142
142
 
143
143
  # unit tests for edit_document_docx_insert_table
144
- # Insert a new table into a DOCX
145
- # Adds a new table into a DOCX and returns the result
146
- # @param req_config
144
+ # Insert a new table into a Word DOCX document
145
+ # Adds a new table into a DOCX and returns the result. Call Finish Editing on the output URL to complete the operation.
146
+ # @param req_config Document input request
147
147
  # @param [Hash] opts the optional parameters
148
148
  # @return [InsertDocxTablesResponse]
149
149
  describe 'edit_document_docx_insert_table test' do
@@ -153,9 +153,9 @@ describe 'EditDocumentApi' do
153
153
  end
154
154
 
155
155
  # unit tests for edit_document_docx_remove_headers_and_footers
156
- # Remove headers and footers from DOCX
157
- # Remove all headers, or footers, or both from a Word Document (DOCX)
158
- # @param req_config
156
+ # Remove headers and footers from Word DOCX document
157
+ # Remove all headers, or footers, or both from a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
158
+ # @param req_config Document input request
159
159
  # @param [Hash] opts the optional parameters
160
160
  # @return [RemoveDocxHeadersAndFootersResponse]
161
161
  describe 'edit_document_docx_remove_headers_and_footers test' do
@@ -165,9 +165,9 @@ describe 'EditDocumentApi' do
165
165
  end
166
166
 
167
167
  # unit tests for edit_document_docx_remove_object
168
- # Delete any object in a DOCX
169
- # 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.
170
- # @param req_config
168
+ # Delete any object in a Word DOCX document
169
+ # 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.
170
+ # @param req_config Document input request
171
171
  # @param [Hash] opts the optional parameters
172
172
  # @return [DocxRemoveObjectResponse]
173
173
  describe 'edit_document_docx_remove_object test' do
@@ -177,9 +177,9 @@ describe 'EditDocumentApi' do
177
177
  end
178
178
 
179
179
  # unit tests for edit_document_docx_replace
180
- # Replace string in DOCX
180
+ # Replace string in Word DOCX document
181
181
  # Replace all instances of a string in an Office Word Document (docx)
182
- # @param req_config
182
+ # @param req_config Document string replacement configuration input
183
183
  # @param [Hash] opts the optional parameters
184
184
  # @return [String]
185
185
  describe 'edit_document_docx_replace test' do
@@ -189,9 +189,9 @@ describe 'EditDocumentApi' do
189
189
  end
190
190
 
191
191
  # unit tests for edit_document_docx_set_footer
192
- # Set the footer in a DOCX
193
- # Set the footer in a Word Document (DOCX)
194
- # @param req_config
192
+ # Set the footer in a Word DOCX document
193
+ # Set the footer in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
194
+ # @param req_config Document input request
195
195
  # @param [Hash] opts the optional parameters
196
196
  # @return [DocxSetFooterResponse]
197
197
  describe 'edit_document_docx_set_footer test' do
@@ -201,9 +201,9 @@ describe 'EditDocumentApi' do
201
201
  end
202
202
 
203
203
  # unit tests for edit_document_docx_set_footer_add_page_number
204
- # Add page number to footer in a DOCX
205
- # Set the footer in a Word Document (DOCX) to contain a page number
206
- # @param req_config
204
+ # Add page number to footer in a Word DOCX document
205
+ # Set the footer in a Word Document (DOCX) to contain a page number. Call Finish Editing on the output URL to complete the operation.
206
+ # @param req_config Document input request
207
207
  # @param [Hash] opts the optional parameters
208
208
  # @return [DocxSetFooterResponse]
209
209
  describe 'edit_document_docx_set_footer_add_page_number test' do
@@ -213,9 +213,9 @@ describe 'EditDocumentApi' do
213
213
  end
214
214
 
215
215
  # unit tests for edit_document_docx_set_header
216
- # Set the header in a DOCX
217
- # Set the header in a Word Document (DOCX)
218
- # @param req_config
216
+ # Set the header in a Word DOCX document
217
+ # Set the header in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
218
+ # @param req_config Document input request
219
219
  # @param [Hash] opts the optional parameters
220
220
  # @return [DocxSetHeaderResponse]
221
221
  describe 'edit_document_docx_set_header test' do
@@ -227,7 +227,7 @@ describe 'EditDocumentApi' do
227
227
  # unit tests for edit_document_finish_editing
228
228
  # Download result from document editing
229
229
  # 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.
230
- # @param req_config
230
+ # @param req_config Cloudmersive Document URL to complete editing on
231
231
  # @param [Hash] opts the optional parameters
232
232
  # @return [String]
233
233
  describe 'edit_document_finish_editing test' do
@@ -237,9 +237,9 @@ describe 'EditDocumentApi' do
237
237
  end
238
238
 
239
239
  # unit tests for edit_document_pptx_replace
240
- # Replace string in PPTX
240
+ # Replace string in PowerPoint PPTX presentation
241
241
  # Replace all instances of a string in an Office PowerPoint Document (pptx)
242
- # @param req_config
242
+ # @param req_config Replacement document configuration input
243
243
  # @param [Hash] opts the optional parameters
244
244
  # @return [String]
245
245
  describe 'edit_document_pptx_replace test' do
@@ -249,9 +249,9 @@ describe 'EditDocumentApi' do
249
249
  end
250
250
 
251
251
  # unit tests for edit_document_xlsx_get_columns
252
- # Get rows and cells from a XLSX worksheet
252
+ # Get rows and cells from a Excel XLSX spreadsheet, worksheet
253
253
  # Returns the rows and cells defined in the Excel Spreadsheet worksheet
254
- # @param input
254
+ # @param input Document input request
255
255
  # @param [Hash] opts the optional parameters
256
256
  # @return [GetXlsxColumnsResponse]
257
257
  describe 'edit_document_xlsx_get_columns test' do
@@ -261,9 +261,9 @@ describe 'EditDocumentApi' do
261
261
  end
262
262
 
263
263
  # unit tests for edit_document_xlsx_get_images
264
- # Get images from a XLSX worksheet
264
+ # Get images from a Excel XLSX spreadsheet, worksheet
265
265
  # Returns the images defined in the Excel Spreadsheet worksheet
266
- # @param input
266
+ # @param input Document input request
267
267
  # @param [Hash] opts the optional parameters
268
268
  # @return [GetXlsxImagesResponse]
269
269
  describe 'edit_document_xlsx_get_images test' do
@@ -273,9 +273,9 @@ describe 'EditDocumentApi' do
273
273
  end
274
274
 
275
275
  # unit tests for edit_document_xlsx_get_rows_and_cells
276
- # Get rows and cells from a XLSX worksheet
276
+ # Get rows and cells from a Word XLSX spreadsheet, worksheet
277
277
  # Returns the rows and cells defined in the Excel Spreadsheet worksheet
278
- # @param input
278
+ # @param input Document input request
279
279
  # @param [Hash] opts the optional parameters
280
280
  # @return [GetXlsxRowsAndCellsResponse]
281
281
  describe 'edit_document_xlsx_get_rows_and_cells test' do
@@ -285,9 +285,9 @@ describe 'EditDocumentApi' do
285
285
  end
286
286
 
287
287
  # unit tests for edit_document_xlsx_get_styles
288
- # Get styles from a XLSX worksheet
288
+ # Get styles from a Excel XLSX spreadsheet, worksheet
289
289
  # Returns the style defined in the Excel Spreadsheet
290
- # @param input
290
+ # @param input Document input request
291
291
  # @param [Hash] opts the optional parameters
292
292
  # @return [GetXlsxStylesResponse]
293
293
  describe 'edit_document_xlsx_get_styles test' do
@@ -297,9 +297,9 @@ describe 'EditDocumentApi' do
297
297
  end
298
298
 
299
299
  # unit tests for edit_document_xlsx_get_worksheets
300
- # Get worksheets from a XLSX
300
+ # Get worksheets from a Excel XLSX spreadsheet
301
301
  # Returns the worksheets (tabs) defined in the Excel Spreadsheet (XLSX) format file
302
- # @param input
302
+ # @param input Document input request
303
303
  # @param [Hash] opts the optional parameters
304
304
  # @return [GetXlsxWorksheetsResponse]
305
305
  describe 'edit_document_xlsx_get_worksheets test' do
@@ -309,9 +309,9 @@ describe 'EditDocumentApi' do
309
309
  end
310
310
 
311
311
  # unit tests for edit_document_xlsx_insert_worksheet
312
- # Insert a new worksheet into an XLSX spreadsheet
312
+ # Insert a new worksheet into an Excel XLSX spreadsheet
313
313
  # Inserts a new worksheet into an Excel Spreadsheet
314
- # @param input
314
+ # @param input Document input request
315
315
  # @param [Hash] opts the optional parameters
316
316
  # @return [InsertXlsxWorksheetResponse]
317
317
  describe 'edit_document_xlsx_insert_worksheet test' do