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.
- checksums.yaml +4 -4
- data/README.md +59 -55
- data/docs/ConvertDataApi.md +12 -12
- data/docs/ConvertDocumentApi.md +73 -73
- data/docs/ConvertImageApi.md +3 -3
- data/docs/ConvertWebApi.md +63 -8
- data/docs/EditDocumentApi.md +120 -120
- data/docs/EditPdfApi.md +130 -2
- data/docs/HtmlToPngRequest.md +11 -0
- data/lib/cloudmersive-convert-api-client.rb +1 -0
- data/lib/cloudmersive-convert-api-client/api/convert_data_api.rb +8 -8
- data/lib/cloudmersive-convert-api-client/api/convert_document_api.rb +50 -50
- data/lib/cloudmersive-convert-api-client/api/convert_image_api.rb +2 -2
- data/lib/cloudmersive-convert-api-client/api/convert_web_api.rb +62 -7
- data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +106 -106
- data/lib/cloudmersive-convert-api-client/api/edit_pdf_api.rb +157 -3
- data/lib/cloudmersive-convert-api-client/models/html_to_png_request.rb +219 -0
- data/lib/cloudmersive-convert-api-client/version.rb +1 -1
- data/spec/api/convert_data_api_spec.rb +4 -4
- data/spec/api/convert_document_api_spec.rb +23 -23
- data/spec/api/convert_image_api_spec.rb +1 -1
- data/spec/api/convert_web_api_spec.rb +14 -2
- data/spec/api/edit_document_api_spec.rb +53 -53
- data/spec/api/edit_pdf_api_spec.rb +31 -1
- data/spec/models/html_to_png_request_spec.rb +60 -0
- metadata +5 -2
data/docs/ConvertImageApi.md
CHANGED
@@ -7,7 +7,7 @@ Method | HTTP request | Description
|
|
7
7
|
[**convert_image_get_image_info**](ConvertImageApi.md#convert_image_get_image_info) | **POST** /convert/image/get-info | Get information about an image
|
8
8
|
[**convert_image_image_format_convert**](ConvertImageApi.md#convert_image_image_format_convert) | **POST** /convert/image/{format1}/to/{format2} | Image format conversion
|
9
9
|
[**convert_image_image_set_dpi**](ConvertImageApi.md#convert_image_image_set_dpi) | **POST** /convert/image/set-dpi/{dpi} | Change image DPI
|
10
|
-
[**convert_image_multipage_image_format_convert**](ConvertImageApi.md#convert_image_multipage_image_format_convert) | **POST** /convert/image-multipage/{format1}/to/{format2} | Multi-page format conversion
|
10
|
+
[**convert_image_multipage_image_format_convert**](ConvertImageApi.md#convert_image_multipage_image_format_convert) | **POST** /convert/image-multipage/{format1}/to/{format2} | Multi-page image format conversion
|
11
11
|
|
12
12
|
|
13
13
|
# **convert_image_get_image_info**
|
@@ -184,7 +184,7 @@ Name | Type | Description | Notes
|
|
184
184
|
# **convert_image_multipage_image_format_convert**
|
185
185
|
> MultipageImageFormatConversionResult convert_image_multipage_image_format_convert(format1, format2, input_file)
|
186
186
|
|
187
|
-
Multi-page format conversion
|
187
|
+
Multi-page image format conversion
|
188
188
|
|
189
189
|
Convert between over 100 file formats, including support for Multiple-Page formats (e.g. PDFs, TIFFs, etc. with multiple pages).
|
190
190
|
|
@@ -210,7 +210,7 @@ input_file = File.new("/path/to/file.txt") # File | Input file to perform the op
|
|
210
210
|
|
211
211
|
|
212
212
|
begin
|
213
|
-
#Multi-page format conversion
|
213
|
+
#Multi-page image format conversion
|
214
214
|
result = api_instance.convert_image_multipage_image_format_convert(format1, format2, input_file)
|
215
215
|
p result
|
216
216
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
data/docs/ConvertWebApi.md
CHANGED
@@ -4,8 +4,9 @@ All URIs are relative to *https://api.cloudmersive.com*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**convert_web_html_to_docx**](ConvertWebApi.md#convert_web_html_to_docx) | **POST** /convert/html/to/docx | HTML to DOCX
|
7
|
+
[**convert_web_html_to_docx**](ConvertWebApi.md#convert_web_html_to_docx) | **POST** /convert/html/to/docx | Convert HTML to DOCX
|
8
8
|
[**convert_web_html_to_pdf**](ConvertWebApi.md#convert_web_html_to_pdf) | **POST** /convert/web/html/to/pdf | Convert HTML string to PDF
|
9
|
+
[**convert_web_html_to_png**](ConvertWebApi.md#convert_web_html_to_png) | **POST** /convert/web/html/to/png | Convert HTML string to PNG
|
9
10
|
[**convert_web_md_to_html**](ConvertWebApi.md#convert_web_md_to_html) | **POST** /convert/web/md/to/html | Convert Markdown to HTML
|
10
11
|
[**convert_web_url_to_pdf**](ConvertWebApi.md#convert_web_url_to_pdf) | **POST** /convert/web/url/to/pdf | Convert a URL to PDF
|
11
12
|
[**convert_web_url_to_screenshot**](ConvertWebApi.md#convert_web_url_to_screenshot) | **POST** /convert/web/url/to/screenshot | Take screenshot of URL
|
@@ -14,7 +15,7 @@ Method | HTTP request | Description
|
|
14
15
|
# **convert_web_html_to_docx**
|
15
16
|
> String convert_web_html_to_docx(input_request)
|
16
17
|
|
17
|
-
HTML to DOCX
|
18
|
+
Convert HTML to DOCX
|
18
19
|
|
19
20
|
Convert HTML to Office Word Document (DOCX) format
|
20
21
|
|
@@ -32,11 +33,11 @@ end
|
|
32
33
|
|
33
34
|
api_instance = CloudmersiveConvertApiClient::ConvertWebApi.new
|
34
35
|
|
35
|
-
input_request = CloudmersiveConvertApiClient::HtmlToOfficeRequest.new # HtmlToOfficeRequest |
|
36
|
+
input_request = CloudmersiveConvertApiClient::HtmlToOfficeRequest.new # HtmlToOfficeRequest | HTL input to convert to DOCX
|
36
37
|
|
37
38
|
|
38
39
|
begin
|
39
|
-
#HTML to DOCX
|
40
|
+
#Convert HTML to DOCX
|
40
41
|
result = api_instance.convert_web_html_to_docx(input_request)
|
41
42
|
p result
|
42
43
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
@@ -48,7 +49,7 @@ end
|
|
48
49
|
|
49
50
|
Name | Type | Description | Notes
|
50
51
|
------------- | ------------- | ------------- | -------------
|
51
|
-
**input_request** | [**HtmlToOfficeRequest**](HtmlToOfficeRequest.md)|
|
52
|
+
**input_request** | [**HtmlToOfficeRequest**](HtmlToOfficeRequest.md)| HTL input to convert to DOCX |
|
52
53
|
|
53
54
|
### Return type
|
54
55
|
|
@@ -115,7 +116,61 @@ Name | Type | Description | Notes
|
|
115
116
|
### HTTP request headers
|
116
117
|
|
117
118
|
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
118
|
-
- **Accept**: application/
|
119
|
+
- **Accept**: application/octet-stream
|
120
|
+
|
121
|
+
|
122
|
+
|
123
|
+
# **convert_web_html_to_png**
|
124
|
+
> Object convert_web_html_to_png(input)
|
125
|
+
|
126
|
+
Convert HTML string to PNG
|
127
|
+
|
128
|
+
Fully renders a website and returns a PNG (screenshot) of the HTML. Javascript, HTML5, CSS and other advanced features are all supported.
|
129
|
+
|
130
|
+
### Example
|
131
|
+
```ruby
|
132
|
+
# load the gem
|
133
|
+
require 'cloudmersive-convert-api-client'
|
134
|
+
# setup authorization
|
135
|
+
CloudmersiveConvertApiClient.configure do |config|
|
136
|
+
# Configure API key authorization: Apikey
|
137
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
138
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
139
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
140
|
+
end
|
141
|
+
|
142
|
+
api_instance = CloudmersiveConvertApiClient::ConvertWebApi.new
|
143
|
+
|
144
|
+
input = CloudmersiveConvertApiClient::HtmlToPngRequest.new # HtmlToPngRequest | HTML to PNG request parameters
|
145
|
+
|
146
|
+
|
147
|
+
begin
|
148
|
+
#Convert HTML string to PNG
|
149
|
+
result = api_instance.convert_web_html_to_png(input)
|
150
|
+
p result
|
151
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
152
|
+
puts "Exception when calling ConvertWebApi->convert_web_html_to_png: #{e}"
|
153
|
+
end
|
154
|
+
```
|
155
|
+
|
156
|
+
### Parameters
|
157
|
+
|
158
|
+
Name | Type | Description | Notes
|
159
|
+
------------- | ------------- | ------------- | -------------
|
160
|
+
**input** | [**HtmlToPngRequest**](HtmlToPngRequest.md)| HTML to PNG request parameters |
|
161
|
+
|
162
|
+
### Return type
|
163
|
+
|
164
|
+
**Object**
|
165
|
+
|
166
|
+
### Authorization
|
167
|
+
|
168
|
+
[Apikey](../README.md#Apikey)
|
169
|
+
|
170
|
+
### HTTP request headers
|
171
|
+
|
172
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
173
|
+
- **Accept**: application/octet-stream
|
119
174
|
|
120
175
|
|
121
176
|
|
@@ -223,7 +278,7 @@ Name | Type | Description | Notes
|
|
223
278
|
### HTTP request headers
|
224
279
|
|
225
280
|
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
226
|
-
- **Accept**: application/
|
281
|
+
- **Accept**: application/octet-stream
|
227
282
|
|
228
283
|
|
229
284
|
|
@@ -277,7 +332,7 @@ Name | Type | Description | Notes
|
|
277
332
|
### HTTP request headers
|
278
333
|
|
279
334
|
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
280
|
-
- **Accept**: application/
|
335
|
+
- **Accept**: application/octet-stream
|
281
336
|
|
282
337
|
|
283
338
|
|
data/docs/EditDocumentApi.md
CHANGED
@@ -5,29 +5,29 @@ All URIs are relative to *https://api.cloudmersive.com*
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**edit_document_begin_editing**](EditDocumentApi.md#edit_document_begin_editing) | **POST** /convert/edit/begin-editing | Begin editing a document
|
8
|
-
[**edit_document_docx_body**](EditDocumentApi.md#edit_document_docx_body) | **POST** /convert/edit/docx/get-body | Get body from a DOCX
|
9
|
-
[**edit_document_docx_get_headers_and_footers**](EditDocumentApi.md#edit_document_docx_get_headers_and_footers) | **POST** /convert/edit/docx/get-headers-and-footers | Get content of a footer from a DOCX
|
10
|
-
[**edit_document_docx_get_images**](EditDocumentApi.md#edit_document_docx_get_images) | **POST** /convert/edit/docx/get-images | Get images from a DOCX
|
11
|
-
[**edit_document_docx_get_sections**](EditDocumentApi.md#edit_document_docx_get_sections) | **POST** /convert/edit/docx/get-sections | Get sections from a DOCX
|
12
|
-
[**edit_document_docx_get_styles**](EditDocumentApi.md#edit_document_docx_get_styles) | **POST** /convert/edit/docx/get-styles | Get styles from a DOCX
|
13
|
-
[**edit_document_docx_get_tables**](EditDocumentApi.md#edit_document_docx_get_tables) | **POST** /convert/edit/docx/get-tables | Get tables in DOCX
|
14
|
-
[**edit_document_docx_insert_image**](EditDocumentApi.md#edit_document_docx_insert_image) | **POST** /convert/edit/docx/insert-image | Insert image into a DOCX
|
15
|
-
[**edit_document_docx_insert_paragraph**](EditDocumentApi.md#edit_document_docx_insert_paragraph) | **POST** /convert/edit/docx/insert-paragraph | Insert a new paragraph into a DOCX
|
16
|
-
[**edit_document_docx_insert_table**](EditDocumentApi.md#edit_document_docx_insert_table) | **POST** /convert/edit/docx/insert-table | Insert a new table into a DOCX
|
17
|
-
[**edit_document_docx_remove_headers_and_footers**](EditDocumentApi.md#edit_document_docx_remove_headers_and_footers) | **POST** /convert/edit/docx/remove-headers-and-footers | Remove headers and footers from DOCX
|
18
|
-
[**edit_document_docx_remove_object**](EditDocumentApi.md#edit_document_docx_remove_object) | **POST** /convert/edit/docx/remove-object | Delete any object in a DOCX
|
19
|
-
[**edit_document_docx_replace**](EditDocumentApi.md#edit_document_docx_replace) | **POST** /convert/edit/docx/replace-all | Replace string in DOCX
|
20
|
-
[**edit_document_docx_set_footer**](EditDocumentApi.md#edit_document_docx_set_footer) | **POST** /convert/edit/docx/set-footer | Set the footer in a DOCX
|
21
|
-
[**edit_document_docx_set_footer_add_page_number**](EditDocumentApi.md#edit_document_docx_set_footer_add_page_number) | **POST** /convert/edit/docx/set-footer/add-page-number | Add page number to footer in a DOCX
|
22
|
-
[**edit_document_docx_set_header**](EditDocumentApi.md#edit_document_docx_set_header) | **POST** /convert/edit/docx/set-header | Set the header in a DOCX
|
8
|
+
[**edit_document_docx_body**](EditDocumentApi.md#edit_document_docx_body) | **POST** /convert/edit/docx/get-body | Get body from a Word DOCX document
|
9
|
+
[**edit_document_docx_get_headers_and_footers**](EditDocumentApi.md#edit_document_docx_get_headers_and_footers) | **POST** /convert/edit/docx/get-headers-and-footers | Get content of a footer from a Word DOCX document
|
10
|
+
[**edit_document_docx_get_images**](EditDocumentApi.md#edit_document_docx_get_images) | **POST** /convert/edit/docx/get-images | Get images from a Word DOCX document
|
11
|
+
[**edit_document_docx_get_sections**](EditDocumentApi.md#edit_document_docx_get_sections) | **POST** /convert/edit/docx/get-sections | Get sections from a Word DOCX document
|
12
|
+
[**edit_document_docx_get_styles**](EditDocumentApi.md#edit_document_docx_get_styles) | **POST** /convert/edit/docx/get-styles | Get styles from a Word DOCX document
|
13
|
+
[**edit_document_docx_get_tables**](EditDocumentApi.md#edit_document_docx_get_tables) | **POST** /convert/edit/docx/get-tables | Get tables in Word DOCX document
|
14
|
+
[**edit_document_docx_insert_image**](EditDocumentApi.md#edit_document_docx_insert_image) | **POST** /convert/edit/docx/insert-image | Insert image into a Word DOCX document
|
15
|
+
[**edit_document_docx_insert_paragraph**](EditDocumentApi.md#edit_document_docx_insert_paragraph) | **POST** /convert/edit/docx/insert-paragraph | Insert a new paragraph into a Word DOCX document
|
16
|
+
[**edit_document_docx_insert_table**](EditDocumentApi.md#edit_document_docx_insert_table) | **POST** /convert/edit/docx/insert-table | Insert a new table into a Word DOCX document
|
17
|
+
[**edit_document_docx_remove_headers_and_footers**](EditDocumentApi.md#edit_document_docx_remove_headers_and_footers) | **POST** /convert/edit/docx/remove-headers-and-footers | Remove headers and footers from Word DOCX document
|
18
|
+
[**edit_document_docx_remove_object**](EditDocumentApi.md#edit_document_docx_remove_object) | **POST** /convert/edit/docx/remove-object | Delete any object in a Word DOCX document
|
19
|
+
[**edit_document_docx_replace**](EditDocumentApi.md#edit_document_docx_replace) | **POST** /convert/edit/docx/replace-all | Replace string in Word DOCX document
|
20
|
+
[**edit_document_docx_set_footer**](EditDocumentApi.md#edit_document_docx_set_footer) | **POST** /convert/edit/docx/set-footer | Set the footer in a Word DOCX document
|
21
|
+
[**edit_document_docx_set_footer_add_page_number**](EditDocumentApi.md#edit_document_docx_set_footer_add_page_number) | **POST** /convert/edit/docx/set-footer/add-page-number | Add page number to footer in a Word DOCX document
|
22
|
+
[**edit_document_docx_set_header**](EditDocumentApi.md#edit_document_docx_set_header) | **POST** /convert/edit/docx/set-header | Set the header in a Word DOCX document
|
23
23
|
[**edit_document_finish_editing**](EditDocumentApi.md#edit_document_finish_editing) | **POST** /convert/edit/finish-editing | Download result from document editing
|
24
|
-
[**edit_document_pptx_replace**](EditDocumentApi.md#edit_document_pptx_replace) | **POST** /convert/edit/pptx/replace-all | Replace string in PPTX
|
25
|
-
[**edit_document_xlsx_get_columns**](EditDocumentApi.md#edit_document_xlsx_get_columns) | **POST** /convert/edit/xlsx/get-columns | Get rows and cells from a XLSX worksheet
|
26
|
-
[**edit_document_xlsx_get_images**](EditDocumentApi.md#edit_document_xlsx_get_images) | **POST** /convert/edit/xlsx/get-images | Get images from a XLSX worksheet
|
27
|
-
[**edit_document_xlsx_get_rows_and_cells**](EditDocumentApi.md#edit_document_xlsx_get_rows_and_cells) | **POST** /convert/edit/xlsx/get-rows-and-cells | Get rows and cells from a XLSX worksheet
|
28
|
-
[**edit_document_xlsx_get_styles**](EditDocumentApi.md#edit_document_xlsx_get_styles) | **POST** /convert/edit/xlsx/get-styles | Get styles from a XLSX worksheet
|
29
|
-
[**edit_document_xlsx_get_worksheets**](EditDocumentApi.md#edit_document_xlsx_get_worksheets) | **POST** /convert/edit/xlsx/get-worksheets | Get worksheets from a XLSX
|
30
|
-
[**edit_document_xlsx_insert_worksheet**](EditDocumentApi.md#edit_document_xlsx_insert_worksheet) | **POST** /convert/edit/xlsx/insert-worksheet | Insert a new worksheet into an XLSX spreadsheet
|
24
|
+
[**edit_document_pptx_replace**](EditDocumentApi.md#edit_document_pptx_replace) | **POST** /convert/edit/pptx/replace-all | Replace string in PowerPoint PPTX presentation
|
25
|
+
[**edit_document_xlsx_get_columns**](EditDocumentApi.md#edit_document_xlsx_get_columns) | **POST** /convert/edit/xlsx/get-columns | Get rows and cells from a Excel XLSX spreadsheet, worksheet
|
26
|
+
[**edit_document_xlsx_get_images**](EditDocumentApi.md#edit_document_xlsx_get_images) | **POST** /convert/edit/xlsx/get-images | Get images from a Excel XLSX spreadsheet, worksheet
|
27
|
+
[**edit_document_xlsx_get_rows_and_cells**](EditDocumentApi.md#edit_document_xlsx_get_rows_and_cells) | **POST** /convert/edit/xlsx/get-rows-and-cells | Get rows and cells from a Word XLSX spreadsheet, worksheet
|
28
|
+
[**edit_document_xlsx_get_styles**](EditDocumentApi.md#edit_document_xlsx_get_styles) | **POST** /convert/edit/xlsx/get-styles | Get styles from a Excel XLSX spreadsheet, worksheet
|
29
|
+
[**edit_document_xlsx_get_worksheets**](EditDocumentApi.md#edit_document_xlsx_get_worksheets) | **POST** /convert/edit/xlsx/get-worksheets | Get worksheets from a Excel XLSX spreadsheet
|
30
|
+
[**edit_document_xlsx_insert_worksheet**](EditDocumentApi.md#edit_document_xlsx_insert_worksheet) | **POST** /convert/edit/xlsx/insert-worksheet | Insert a new worksheet into an Excel XLSX spreadsheet
|
31
31
|
|
32
32
|
|
33
33
|
# **edit_document_begin_editing**
|
@@ -87,7 +87,7 @@ Name | Type | Description | Notes
|
|
87
87
|
# **edit_document_docx_body**
|
88
88
|
> GetDocxBodyResponse edit_document_docx_body(req_config)
|
89
89
|
|
90
|
-
Get body from a DOCX
|
90
|
+
Get body from a Word DOCX document
|
91
91
|
|
92
92
|
Returns the body defined in the Word Document (DOCX) format file; this is the main content part of a DOCX document
|
93
93
|
|
@@ -105,11 +105,11 @@ end
|
|
105
105
|
|
106
106
|
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
107
107
|
|
108
|
-
req_config = CloudmersiveConvertApiClient::GetDocxBodyRequest.new # GetDocxBodyRequest |
|
108
|
+
req_config = CloudmersiveConvertApiClient::GetDocxBodyRequest.new # GetDocxBodyRequest | Document input request
|
109
109
|
|
110
110
|
|
111
111
|
begin
|
112
|
-
#Get body from a DOCX
|
112
|
+
#Get body from a Word DOCX document
|
113
113
|
result = api_instance.edit_document_docx_body(req_config)
|
114
114
|
p result
|
115
115
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
@@ -121,7 +121,7 @@ end
|
|
121
121
|
|
122
122
|
Name | Type | Description | Notes
|
123
123
|
------------- | ------------- | ------------- | -------------
|
124
|
-
**req_config** | [**GetDocxBodyRequest**](GetDocxBodyRequest.md)|
|
124
|
+
**req_config** | [**GetDocxBodyRequest**](GetDocxBodyRequest.md)| Document input request |
|
125
125
|
|
126
126
|
### Return type
|
127
127
|
|
@@ -141,7 +141,7 @@ Name | Type | Description | Notes
|
|
141
141
|
# **edit_document_docx_get_headers_and_footers**
|
142
142
|
> GetDocxHeadersAndFootersResponse edit_document_docx_get_headers_and_footers(req_config)
|
143
143
|
|
144
|
-
Get content of a footer from a DOCX
|
144
|
+
Get content of a footer from a Word DOCX document
|
145
145
|
|
146
146
|
Returns the footer content from a Word Document (DOCX) format file
|
147
147
|
|
@@ -159,11 +159,11 @@ end
|
|
159
159
|
|
160
160
|
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
161
161
|
|
162
|
-
req_config = CloudmersiveConvertApiClient::GetDocxHeadersAndFootersRequest.new # GetDocxHeadersAndFootersRequest |
|
162
|
+
req_config = CloudmersiveConvertApiClient::GetDocxHeadersAndFootersRequest.new # GetDocxHeadersAndFootersRequest | Document input request
|
163
163
|
|
164
164
|
|
165
165
|
begin
|
166
|
-
#Get content of a footer from a DOCX
|
166
|
+
#Get content of a footer from a Word DOCX document
|
167
167
|
result = api_instance.edit_document_docx_get_headers_and_footers(req_config)
|
168
168
|
p result
|
169
169
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
@@ -175,7 +175,7 @@ end
|
|
175
175
|
|
176
176
|
Name | Type | Description | Notes
|
177
177
|
------------- | ------------- | ------------- | -------------
|
178
|
-
**req_config** | [**GetDocxHeadersAndFootersRequest**](GetDocxHeadersAndFootersRequest.md)|
|
178
|
+
**req_config** | [**GetDocxHeadersAndFootersRequest**](GetDocxHeadersAndFootersRequest.md)| Document input request |
|
179
179
|
|
180
180
|
### Return type
|
181
181
|
|
@@ -195,7 +195,7 @@ Name | Type | Description | Notes
|
|
195
195
|
# **edit_document_docx_get_images**
|
196
196
|
> GetDocxImagesResponse edit_document_docx_get_images(req_config)
|
197
197
|
|
198
|
-
Get images from a DOCX
|
198
|
+
Get images from a Word DOCX document
|
199
199
|
|
200
200
|
Returns the images defined in the Word Document (DOCX) format file
|
201
201
|
|
@@ -213,11 +213,11 @@ end
|
|
213
213
|
|
214
214
|
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
215
215
|
|
216
|
-
req_config = CloudmersiveConvertApiClient::GetDocxImagesRequest.new # GetDocxImagesRequest |
|
216
|
+
req_config = CloudmersiveConvertApiClient::GetDocxImagesRequest.new # GetDocxImagesRequest | Document input request
|
217
217
|
|
218
218
|
|
219
219
|
begin
|
220
|
-
#Get images from a DOCX
|
220
|
+
#Get images from a Word DOCX document
|
221
221
|
result = api_instance.edit_document_docx_get_images(req_config)
|
222
222
|
p result
|
223
223
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
@@ -229,7 +229,7 @@ end
|
|
229
229
|
|
230
230
|
Name | Type | Description | Notes
|
231
231
|
------------- | ------------- | ------------- | -------------
|
232
|
-
**req_config** | [**GetDocxImagesRequest**](GetDocxImagesRequest.md)|
|
232
|
+
**req_config** | [**GetDocxImagesRequest**](GetDocxImagesRequest.md)| Document input request |
|
233
233
|
|
234
234
|
### Return type
|
235
235
|
|
@@ -249,7 +249,7 @@ Name | Type | Description | Notes
|
|
249
249
|
# **edit_document_docx_get_sections**
|
250
250
|
> GetDocxSectionsResponse edit_document_docx_get_sections(req_config)
|
251
251
|
|
252
|
-
Get sections from a DOCX
|
252
|
+
Get sections from a Word DOCX document
|
253
253
|
|
254
254
|
Returns the sections defined in the Word Document (DOCX) format file
|
255
255
|
|
@@ -267,11 +267,11 @@ end
|
|
267
267
|
|
268
268
|
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
269
269
|
|
270
|
-
req_config = CloudmersiveConvertApiClient::GetDocxSectionsRequest.new # GetDocxSectionsRequest |
|
270
|
+
req_config = CloudmersiveConvertApiClient::GetDocxSectionsRequest.new # GetDocxSectionsRequest | Document input request
|
271
271
|
|
272
272
|
|
273
273
|
begin
|
274
|
-
#Get sections from a DOCX
|
274
|
+
#Get sections from a Word DOCX document
|
275
275
|
result = api_instance.edit_document_docx_get_sections(req_config)
|
276
276
|
p result
|
277
277
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
@@ -283,7 +283,7 @@ end
|
|
283
283
|
|
284
284
|
Name | Type | Description | Notes
|
285
285
|
------------- | ------------- | ------------- | -------------
|
286
|
-
**req_config** | [**GetDocxSectionsRequest**](GetDocxSectionsRequest.md)|
|
286
|
+
**req_config** | [**GetDocxSectionsRequest**](GetDocxSectionsRequest.md)| Document input request |
|
287
287
|
|
288
288
|
### Return type
|
289
289
|
|
@@ -303,7 +303,7 @@ Name | Type | Description | Notes
|
|
303
303
|
# **edit_document_docx_get_styles**
|
304
304
|
> GetDocxStylesResponse edit_document_docx_get_styles(req_config)
|
305
305
|
|
306
|
-
Get styles from a DOCX
|
306
|
+
Get styles from a Word DOCX document
|
307
307
|
|
308
308
|
Returns the styles defined in the Word Document (DOCX) format file
|
309
309
|
|
@@ -321,11 +321,11 @@ end
|
|
321
321
|
|
322
322
|
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
323
323
|
|
324
|
-
req_config = CloudmersiveConvertApiClient::GetDocxStylesRequest.new # GetDocxStylesRequest |
|
324
|
+
req_config = CloudmersiveConvertApiClient::GetDocxStylesRequest.new # GetDocxStylesRequest | Document input request
|
325
325
|
|
326
326
|
|
327
327
|
begin
|
328
|
-
#Get styles from a DOCX
|
328
|
+
#Get styles from a Word DOCX document
|
329
329
|
result = api_instance.edit_document_docx_get_styles(req_config)
|
330
330
|
p result
|
331
331
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
@@ -337,7 +337,7 @@ end
|
|
337
337
|
|
338
338
|
Name | Type | Description | Notes
|
339
339
|
------------- | ------------- | ------------- | -------------
|
340
|
-
**req_config** | [**GetDocxStylesRequest**](GetDocxStylesRequest.md)|
|
340
|
+
**req_config** | [**GetDocxStylesRequest**](GetDocxStylesRequest.md)| Document input request |
|
341
341
|
|
342
342
|
### Return type
|
343
343
|
|
@@ -357,7 +357,7 @@ Name | Type | Description | Notes
|
|
357
357
|
# **edit_document_docx_get_tables**
|
358
358
|
> GetDocxTablesResponse edit_document_docx_get_tables(req_config)
|
359
359
|
|
360
|
-
Get tables in DOCX
|
360
|
+
Get tables in Word DOCX document
|
361
361
|
|
362
362
|
Returns all the table objects in an Office Word Document (docx)
|
363
363
|
|
@@ -375,11 +375,11 @@ end
|
|
375
375
|
|
376
376
|
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
377
377
|
|
378
|
-
req_config = CloudmersiveConvertApiClient::GetDocxTablesRequest.new # GetDocxTablesRequest |
|
378
|
+
req_config = CloudmersiveConvertApiClient::GetDocxTablesRequest.new # GetDocxTablesRequest | Document input request
|
379
379
|
|
380
380
|
|
381
381
|
begin
|
382
|
-
#Get tables in DOCX
|
382
|
+
#Get tables in Word DOCX document
|
383
383
|
result = api_instance.edit_document_docx_get_tables(req_config)
|
384
384
|
p result
|
385
385
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
@@ -391,7 +391,7 @@ end
|
|
391
391
|
|
392
392
|
Name | Type | Description | Notes
|
393
393
|
------------- | ------------- | ------------- | -------------
|
394
|
-
**req_config** | [**GetDocxTablesRequest**](GetDocxTablesRequest.md)|
|
394
|
+
**req_config** | [**GetDocxTablesRequest**](GetDocxTablesRequest.md)| Document input request |
|
395
395
|
|
396
396
|
### Return type
|
397
397
|
|
@@ -411,9 +411,9 @@ Name | Type | Description | Notes
|
|
411
411
|
# **edit_document_docx_insert_image**
|
412
412
|
> DocxInsertImageResponse edit_document_docx_insert_image(req_config)
|
413
413
|
|
414
|
-
Insert image into a DOCX
|
414
|
+
Insert image into a Word DOCX document
|
415
415
|
|
416
|
-
Set the footer in a Word Document (DOCX)
|
416
|
+
Set the footer in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
|
417
417
|
|
418
418
|
### Example
|
419
419
|
```ruby
|
@@ -429,11 +429,11 @@ end
|
|
429
429
|
|
430
430
|
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
431
431
|
|
432
|
-
req_config = CloudmersiveConvertApiClient::DocxInsertImageRequest.new # DocxInsertImageRequest |
|
432
|
+
req_config = CloudmersiveConvertApiClient::DocxInsertImageRequest.new # DocxInsertImageRequest | Document input request
|
433
433
|
|
434
434
|
|
435
435
|
begin
|
436
|
-
#Insert image into a DOCX
|
436
|
+
#Insert image into a Word DOCX document
|
437
437
|
result = api_instance.edit_document_docx_insert_image(req_config)
|
438
438
|
p result
|
439
439
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
@@ -445,7 +445,7 @@ end
|
|
445
445
|
|
446
446
|
Name | Type | Description | Notes
|
447
447
|
------------- | ------------- | ------------- | -------------
|
448
|
-
**req_config** | [**DocxInsertImageRequest**](DocxInsertImageRequest.md)|
|
448
|
+
**req_config** | [**DocxInsertImageRequest**](DocxInsertImageRequest.md)| Document input request |
|
449
449
|
|
450
450
|
### Return type
|
451
451
|
|
@@ -465,9 +465,9 @@ Name | Type | Description | Notes
|
|
465
465
|
# **edit_document_docx_insert_paragraph**
|
466
466
|
> InsertDocxInsertParagraphResponse edit_document_docx_insert_paragraph(req_config)
|
467
467
|
|
468
|
-
Insert a new paragraph into a DOCX
|
468
|
+
Insert a new paragraph into a Word DOCX document
|
469
469
|
|
470
|
-
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).
|
470
|
+
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.
|
471
471
|
|
472
472
|
### Example
|
473
473
|
```ruby
|
@@ -483,11 +483,11 @@ end
|
|
483
483
|
|
484
484
|
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
485
485
|
|
486
|
-
req_config = CloudmersiveConvertApiClient::InsertDocxInsertParagraphRequest.new # InsertDocxInsertParagraphRequest |
|
486
|
+
req_config = CloudmersiveConvertApiClient::InsertDocxInsertParagraphRequest.new # InsertDocxInsertParagraphRequest | Document input request
|
487
487
|
|
488
488
|
|
489
489
|
begin
|
490
|
-
#Insert a new paragraph into a DOCX
|
490
|
+
#Insert a new paragraph into a Word DOCX document
|
491
491
|
result = api_instance.edit_document_docx_insert_paragraph(req_config)
|
492
492
|
p result
|
493
493
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
@@ -499,7 +499,7 @@ end
|
|
499
499
|
|
500
500
|
Name | Type | Description | Notes
|
501
501
|
------------- | ------------- | ------------- | -------------
|
502
|
-
**req_config** | [**InsertDocxInsertParagraphRequest**](InsertDocxInsertParagraphRequest.md)|
|
502
|
+
**req_config** | [**InsertDocxInsertParagraphRequest**](InsertDocxInsertParagraphRequest.md)| Document input request |
|
503
503
|
|
504
504
|
### Return type
|
505
505
|
|
@@ -519,9 +519,9 @@ Name | Type | Description | Notes
|
|
519
519
|
# **edit_document_docx_insert_table**
|
520
520
|
> InsertDocxTablesResponse edit_document_docx_insert_table(req_config)
|
521
521
|
|
522
|
-
Insert a new table into a DOCX
|
522
|
+
Insert a new table into a Word DOCX document
|
523
523
|
|
524
|
-
Adds a new table into a DOCX and returns the result
|
524
|
+
Adds a new table into a DOCX and returns the result. Call Finish Editing on the output URL to complete the operation.
|
525
525
|
|
526
526
|
### Example
|
527
527
|
```ruby
|
@@ -537,11 +537,11 @@ end
|
|
537
537
|
|
538
538
|
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
539
539
|
|
540
|
-
req_config = CloudmersiveConvertApiClient::InsertDocxTablesRequest.new # InsertDocxTablesRequest |
|
540
|
+
req_config = CloudmersiveConvertApiClient::InsertDocxTablesRequest.new # InsertDocxTablesRequest | Document input request
|
541
541
|
|
542
542
|
|
543
543
|
begin
|
544
|
-
#Insert a new table into a DOCX
|
544
|
+
#Insert a new table into a Word DOCX document
|
545
545
|
result = api_instance.edit_document_docx_insert_table(req_config)
|
546
546
|
p result
|
547
547
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
@@ -553,7 +553,7 @@ end
|
|
553
553
|
|
554
554
|
Name | Type | Description | Notes
|
555
555
|
------------- | ------------- | ------------- | -------------
|
556
|
-
**req_config** | [**InsertDocxTablesRequest**](InsertDocxTablesRequest.md)|
|
556
|
+
**req_config** | [**InsertDocxTablesRequest**](InsertDocxTablesRequest.md)| Document input request |
|
557
557
|
|
558
558
|
### Return type
|
559
559
|
|
@@ -573,9 +573,9 @@ Name | Type | Description | Notes
|
|
573
573
|
# **edit_document_docx_remove_headers_and_footers**
|
574
574
|
> RemoveDocxHeadersAndFootersResponse edit_document_docx_remove_headers_and_footers(req_config)
|
575
575
|
|
576
|
-
Remove headers and footers from DOCX
|
576
|
+
Remove headers and footers from Word DOCX document
|
577
577
|
|
578
|
-
Remove all headers, or footers, or both from a Word Document (DOCX)
|
578
|
+
Remove all headers, or footers, or both from a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
|
579
579
|
|
580
580
|
### Example
|
581
581
|
```ruby
|
@@ -591,11 +591,11 @@ end
|
|
591
591
|
|
592
592
|
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
593
593
|
|
594
|
-
req_config = CloudmersiveConvertApiClient::RemoveDocxHeadersAndFootersRequest.new # RemoveDocxHeadersAndFootersRequest |
|
594
|
+
req_config = CloudmersiveConvertApiClient::RemoveDocxHeadersAndFootersRequest.new # RemoveDocxHeadersAndFootersRequest | Document input request
|
595
595
|
|
596
596
|
|
597
597
|
begin
|
598
|
-
#Remove headers and footers from DOCX
|
598
|
+
#Remove headers and footers from Word DOCX document
|
599
599
|
result = api_instance.edit_document_docx_remove_headers_and_footers(req_config)
|
600
600
|
p result
|
601
601
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
@@ -607,7 +607,7 @@ end
|
|
607
607
|
|
608
608
|
Name | Type | Description | Notes
|
609
609
|
------------- | ------------- | ------------- | -------------
|
610
|
-
**req_config** | [**RemoveDocxHeadersAndFootersRequest**](RemoveDocxHeadersAndFootersRequest.md)|
|
610
|
+
**req_config** | [**RemoveDocxHeadersAndFootersRequest**](RemoveDocxHeadersAndFootersRequest.md)| Document input request |
|
611
611
|
|
612
612
|
### Return type
|
613
613
|
|
@@ -627,9 +627,9 @@ Name | Type | Description | Notes
|
|
627
627
|
# **edit_document_docx_remove_object**
|
628
628
|
> DocxRemoveObjectResponse edit_document_docx_remove_object(req_config)
|
629
629
|
|
630
|
-
Delete any object in a DOCX
|
630
|
+
Delete any object in a Word DOCX document
|
631
631
|
|
632
|
-
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.
|
632
|
+
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.
|
633
633
|
|
634
634
|
### Example
|
635
635
|
```ruby
|
@@ -645,11 +645,11 @@ end
|
|
645
645
|
|
646
646
|
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
647
647
|
|
648
|
-
req_config = CloudmersiveConvertApiClient::DocxRemoveObjectRequest.new # DocxRemoveObjectRequest |
|
648
|
+
req_config = CloudmersiveConvertApiClient::DocxRemoveObjectRequest.new # DocxRemoveObjectRequest | Document input request
|
649
649
|
|
650
650
|
|
651
651
|
begin
|
652
|
-
#Delete any object in a DOCX
|
652
|
+
#Delete any object in a Word DOCX document
|
653
653
|
result = api_instance.edit_document_docx_remove_object(req_config)
|
654
654
|
p result
|
655
655
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
@@ -661,7 +661,7 @@ end
|
|
661
661
|
|
662
662
|
Name | Type | Description | Notes
|
663
663
|
------------- | ------------- | ------------- | -------------
|
664
|
-
**req_config** | [**DocxRemoveObjectRequest**](DocxRemoveObjectRequest.md)|
|
664
|
+
**req_config** | [**DocxRemoveObjectRequest**](DocxRemoveObjectRequest.md)| Document input request |
|
665
665
|
|
666
666
|
### Return type
|
667
667
|
|
@@ -681,7 +681,7 @@ Name | Type | Description | Notes
|
|
681
681
|
# **edit_document_docx_replace**
|
682
682
|
> String edit_document_docx_replace(req_config)
|
683
683
|
|
684
|
-
Replace string in DOCX
|
684
|
+
Replace string in Word DOCX document
|
685
685
|
|
686
686
|
Replace all instances of a string in an Office Word Document (docx)
|
687
687
|
|
@@ -699,11 +699,11 @@ end
|
|
699
699
|
|
700
700
|
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
701
701
|
|
702
|
-
req_config = CloudmersiveConvertApiClient::ReplaceStringRequest.new # ReplaceStringRequest |
|
702
|
+
req_config = CloudmersiveConvertApiClient::ReplaceStringRequest.new # ReplaceStringRequest | Document string replacement configuration input
|
703
703
|
|
704
704
|
|
705
705
|
begin
|
706
|
-
#Replace string in DOCX
|
706
|
+
#Replace string in Word DOCX document
|
707
707
|
result = api_instance.edit_document_docx_replace(req_config)
|
708
708
|
p result
|
709
709
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
@@ -715,7 +715,7 @@ end
|
|
715
715
|
|
716
716
|
Name | Type | Description | Notes
|
717
717
|
------------- | ------------- | ------------- | -------------
|
718
|
-
**req_config** | [**ReplaceStringRequest**](ReplaceStringRequest.md)|
|
718
|
+
**req_config** | [**ReplaceStringRequest**](ReplaceStringRequest.md)| Document string replacement configuration input |
|
719
719
|
|
720
720
|
### Return type
|
721
721
|
|
@@ -735,9 +735,9 @@ Name | Type | Description | Notes
|
|
735
735
|
# **edit_document_docx_set_footer**
|
736
736
|
> DocxSetFooterResponse edit_document_docx_set_footer(req_config)
|
737
737
|
|
738
|
-
Set the footer in a DOCX
|
738
|
+
Set the footer in a Word DOCX document
|
739
739
|
|
740
|
-
Set the footer in a Word Document (DOCX)
|
740
|
+
Set the footer in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
|
741
741
|
|
742
742
|
### Example
|
743
743
|
```ruby
|
@@ -753,11 +753,11 @@ end
|
|
753
753
|
|
754
754
|
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
755
755
|
|
756
|
-
req_config = CloudmersiveConvertApiClient::DocxSetFooterRequest.new # DocxSetFooterRequest |
|
756
|
+
req_config = CloudmersiveConvertApiClient::DocxSetFooterRequest.new # DocxSetFooterRequest | Document input request
|
757
757
|
|
758
758
|
|
759
759
|
begin
|
760
|
-
#Set the footer in a DOCX
|
760
|
+
#Set the footer in a Word DOCX document
|
761
761
|
result = api_instance.edit_document_docx_set_footer(req_config)
|
762
762
|
p result
|
763
763
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
@@ -769,7 +769,7 @@ end
|
|
769
769
|
|
770
770
|
Name | Type | Description | Notes
|
771
771
|
------------- | ------------- | ------------- | -------------
|
772
|
-
**req_config** | [**DocxSetFooterRequest**](DocxSetFooterRequest.md)|
|
772
|
+
**req_config** | [**DocxSetFooterRequest**](DocxSetFooterRequest.md)| Document input request |
|
773
773
|
|
774
774
|
### Return type
|
775
775
|
|
@@ -789,9 +789,9 @@ Name | Type | Description | Notes
|
|
789
789
|
# **edit_document_docx_set_footer_add_page_number**
|
790
790
|
> DocxSetFooterResponse edit_document_docx_set_footer_add_page_number(req_config)
|
791
791
|
|
792
|
-
Add page number to footer in a DOCX
|
792
|
+
Add page number to footer in a Word DOCX document
|
793
793
|
|
794
|
-
Set the footer in a Word Document (DOCX) to contain a page number
|
794
|
+
Set the footer in a Word Document (DOCX) to contain a page number. Call Finish Editing on the output URL to complete the operation.
|
795
795
|
|
796
796
|
### Example
|
797
797
|
```ruby
|
@@ -807,11 +807,11 @@ end
|
|
807
807
|
|
808
808
|
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
809
809
|
|
810
|
-
req_config = CloudmersiveConvertApiClient::DocxSetFooterAddPageNumberRequest.new # DocxSetFooterAddPageNumberRequest |
|
810
|
+
req_config = CloudmersiveConvertApiClient::DocxSetFooterAddPageNumberRequest.new # DocxSetFooterAddPageNumberRequest | Document input request
|
811
811
|
|
812
812
|
|
813
813
|
begin
|
814
|
-
#Add page number to footer in a DOCX
|
814
|
+
#Add page number to footer in a Word DOCX document
|
815
815
|
result = api_instance.edit_document_docx_set_footer_add_page_number(req_config)
|
816
816
|
p result
|
817
817
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
@@ -823,7 +823,7 @@ end
|
|
823
823
|
|
824
824
|
Name | Type | Description | Notes
|
825
825
|
------------- | ------------- | ------------- | -------------
|
826
|
-
**req_config** | [**DocxSetFooterAddPageNumberRequest**](DocxSetFooterAddPageNumberRequest.md)|
|
826
|
+
**req_config** | [**DocxSetFooterAddPageNumberRequest**](DocxSetFooterAddPageNumberRequest.md)| Document input request |
|
827
827
|
|
828
828
|
### Return type
|
829
829
|
|
@@ -843,9 +843,9 @@ Name | Type | Description | Notes
|
|
843
843
|
# **edit_document_docx_set_header**
|
844
844
|
> DocxSetHeaderResponse edit_document_docx_set_header(req_config)
|
845
845
|
|
846
|
-
Set the header in a DOCX
|
846
|
+
Set the header in a Word DOCX document
|
847
847
|
|
848
|
-
Set the header in a Word Document (DOCX)
|
848
|
+
Set the header in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
|
849
849
|
|
850
850
|
### Example
|
851
851
|
```ruby
|
@@ -861,11 +861,11 @@ end
|
|
861
861
|
|
862
862
|
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
863
863
|
|
864
|
-
req_config = CloudmersiveConvertApiClient::DocxSetHeaderRequest.new # DocxSetHeaderRequest |
|
864
|
+
req_config = CloudmersiveConvertApiClient::DocxSetHeaderRequest.new # DocxSetHeaderRequest | Document input request
|
865
865
|
|
866
866
|
|
867
867
|
begin
|
868
|
-
#Set the header in a DOCX
|
868
|
+
#Set the header in a Word DOCX document
|
869
869
|
result = api_instance.edit_document_docx_set_header(req_config)
|
870
870
|
p result
|
871
871
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
@@ -877,7 +877,7 @@ end
|
|
877
877
|
|
878
878
|
Name | Type | Description | Notes
|
879
879
|
------------- | ------------- | ------------- | -------------
|
880
|
-
**req_config** | [**DocxSetHeaderRequest**](DocxSetHeaderRequest.md)|
|
880
|
+
**req_config** | [**DocxSetHeaderRequest**](DocxSetHeaderRequest.md)| Document input request |
|
881
881
|
|
882
882
|
### Return type
|
883
883
|
|
@@ -915,7 +915,7 @@ end
|
|
915
915
|
|
916
916
|
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
917
917
|
|
918
|
-
req_config = CloudmersiveConvertApiClient::FinishEditingRequest.new # FinishEditingRequest |
|
918
|
+
req_config = CloudmersiveConvertApiClient::FinishEditingRequest.new # FinishEditingRequest | Cloudmersive Document URL to complete editing on
|
919
919
|
|
920
920
|
|
921
921
|
begin
|
@@ -931,7 +931,7 @@ end
|
|
931
931
|
|
932
932
|
Name | Type | Description | Notes
|
933
933
|
------------- | ------------- | ------------- | -------------
|
934
|
-
**req_config** | [**FinishEditingRequest**](FinishEditingRequest.md)|
|
934
|
+
**req_config** | [**FinishEditingRequest**](FinishEditingRequest.md)| Cloudmersive Document URL to complete editing on |
|
935
935
|
|
936
936
|
### Return type
|
937
937
|
|
@@ -951,7 +951,7 @@ Name | Type | Description | Notes
|
|
951
951
|
# **edit_document_pptx_replace**
|
952
952
|
> String edit_document_pptx_replace(req_config)
|
953
953
|
|
954
|
-
Replace string in PPTX
|
954
|
+
Replace string in PowerPoint PPTX presentation
|
955
955
|
|
956
956
|
Replace all instances of a string in an Office PowerPoint Document (pptx)
|
957
957
|
|
@@ -969,11 +969,11 @@ end
|
|
969
969
|
|
970
970
|
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
971
971
|
|
972
|
-
req_config = CloudmersiveConvertApiClient::ReplaceStringRequest.new # ReplaceStringRequest |
|
972
|
+
req_config = CloudmersiveConvertApiClient::ReplaceStringRequest.new # ReplaceStringRequest | Replacement document configuration input
|
973
973
|
|
974
974
|
|
975
975
|
begin
|
976
|
-
#Replace string in PPTX
|
976
|
+
#Replace string in PowerPoint PPTX presentation
|
977
977
|
result = api_instance.edit_document_pptx_replace(req_config)
|
978
978
|
p result
|
979
979
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
@@ -985,7 +985,7 @@ end
|
|
985
985
|
|
986
986
|
Name | Type | Description | Notes
|
987
987
|
------------- | ------------- | ------------- | -------------
|
988
|
-
**req_config** | [**ReplaceStringRequest**](ReplaceStringRequest.md)|
|
988
|
+
**req_config** | [**ReplaceStringRequest**](ReplaceStringRequest.md)| Replacement document configuration input |
|
989
989
|
|
990
990
|
### Return type
|
991
991
|
|
@@ -1005,7 +1005,7 @@ Name | Type | Description | Notes
|
|
1005
1005
|
# **edit_document_xlsx_get_columns**
|
1006
1006
|
> GetXlsxColumnsResponse edit_document_xlsx_get_columns(input)
|
1007
1007
|
|
1008
|
-
Get rows and cells from a XLSX worksheet
|
1008
|
+
Get rows and cells from a Excel XLSX spreadsheet, worksheet
|
1009
1009
|
|
1010
1010
|
Returns the rows and cells defined in the Excel Spreadsheet worksheet
|
1011
1011
|
|
@@ -1023,11 +1023,11 @@ end
|
|
1023
1023
|
|
1024
1024
|
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
1025
1025
|
|
1026
|
-
input = CloudmersiveConvertApiClient::GetXlsxColumnsRequest.new # GetXlsxColumnsRequest |
|
1026
|
+
input = CloudmersiveConvertApiClient::GetXlsxColumnsRequest.new # GetXlsxColumnsRequest | Document input request
|
1027
1027
|
|
1028
1028
|
|
1029
1029
|
begin
|
1030
|
-
#Get rows and cells from a XLSX worksheet
|
1030
|
+
#Get rows and cells from a Excel XLSX spreadsheet, worksheet
|
1031
1031
|
result = api_instance.edit_document_xlsx_get_columns(input)
|
1032
1032
|
p result
|
1033
1033
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
@@ -1039,7 +1039,7 @@ end
|
|
1039
1039
|
|
1040
1040
|
Name | Type | Description | Notes
|
1041
1041
|
------------- | ------------- | ------------- | -------------
|
1042
|
-
**input** | [**GetXlsxColumnsRequest**](GetXlsxColumnsRequest.md)|
|
1042
|
+
**input** | [**GetXlsxColumnsRequest**](GetXlsxColumnsRequest.md)| Document input request |
|
1043
1043
|
|
1044
1044
|
### Return type
|
1045
1045
|
|
@@ -1059,7 +1059,7 @@ Name | Type | Description | Notes
|
|
1059
1059
|
# **edit_document_xlsx_get_images**
|
1060
1060
|
> GetXlsxImagesResponse edit_document_xlsx_get_images(input)
|
1061
1061
|
|
1062
|
-
Get images from a XLSX worksheet
|
1062
|
+
Get images from a Excel XLSX spreadsheet, worksheet
|
1063
1063
|
|
1064
1064
|
Returns the images defined in the Excel Spreadsheet worksheet
|
1065
1065
|
|
@@ -1077,11 +1077,11 @@ end
|
|
1077
1077
|
|
1078
1078
|
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
1079
1079
|
|
1080
|
-
input = CloudmersiveConvertApiClient::GetXlsxImagesRequest.new # GetXlsxImagesRequest |
|
1080
|
+
input = CloudmersiveConvertApiClient::GetXlsxImagesRequest.new # GetXlsxImagesRequest | Document input request
|
1081
1081
|
|
1082
1082
|
|
1083
1083
|
begin
|
1084
|
-
#Get images from a XLSX worksheet
|
1084
|
+
#Get images from a Excel XLSX spreadsheet, worksheet
|
1085
1085
|
result = api_instance.edit_document_xlsx_get_images(input)
|
1086
1086
|
p result
|
1087
1087
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
@@ -1093,7 +1093,7 @@ end
|
|
1093
1093
|
|
1094
1094
|
Name | Type | Description | Notes
|
1095
1095
|
------------- | ------------- | ------------- | -------------
|
1096
|
-
**input** | [**GetXlsxImagesRequest**](GetXlsxImagesRequest.md)|
|
1096
|
+
**input** | [**GetXlsxImagesRequest**](GetXlsxImagesRequest.md)| Document input request |
|
1097
1097
|
|
1098
1098
|
### Return type
|
1099
1099
|
|
@@ -1113,7 +1113,7 @@ Name | Type | Description | Notes
|
|
1113
1113
|
# **edit_document_xlsx_get_rows_and_cells**
|
1114
1114
|
> GetXlsxRowsAndCellsResponse edit_document_xlsx_get_rows_and_cells(input)
|
1115
1115
|
|
1116
|
-
Get rows and cells from a XLSX worksheet
|
1116
|
+
Get rows and cells from a Word XLSX spreadsheet, worksheet
|
1117
1117
|
|
1118
1118
|
Returns the rows and cells defined in the Excel Spreadsheet worksheet
|
1119
1119
|
|
@@ -1131,11 +1131,11 @@ end
|
|
1131
1131
|
|
1132
1132
|
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
1133
1133
|
|
1134
|
-
input = CloudmersiveConvertApiClient::GetXlsxRowsAndCellsRequest.new # GetXlsxRowsAndCellsRequest |
|
1134
|
+
input = CloudmersiveConvertApiClient::GetXlsxRowsAndCellsRequest.new # GetXlsxRowsAndCellsRequest | Document input request
|
1135
1135
|
|
1136
1136
|
|
1137
1137
|
begin
|
1138
|
-
#Get rows and cells from a XLSX worksheet
|
1138
|
+
#Get rows and cells from a Word XLSX spreadsheet, worksheet
|
1139
1139
|
result = api_instance.edit_document_xlsx_get_rows_and_cells(input)
|
1140
1140
|
p result
|
1141
1141
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
@@ -1147,7 +1147,7 @@ end
|
|
1147
1147
|
|
1148
1148
|
Name | Type | Description | Notes
|
1149
1149
|
------------- | ------------- | ------------- | -------------
|
1150
|
-
**input** | [**GetXlsxRowsAndCellsRequest**](GetXlsxRowsAndCellsRequest.md)|
|
1150
|
+
**input** | [**GetXlsxRowsAndCellsRequest**](GetXlsxRowsAndCellsRequest.md)| Document input request |
|
1151
1151
|
|
1152
1152
|
### Return type
|
1153
1153
|
|
@@ -1167,7 +1167,7 @@ Name | Type | Description | Notes
|
|
1167
1167
|
# **edit_document_xlsx_get_styles**
|
1168
1168
|
> GetXlsxStylesResponse edit_document_xlsx_get_styles(input)
|
1169
1169
|
|
1170
|
-
Get styles from a XLSX worksheet
|
1170
|
+
Get styles from a Excel XLSX spreadsheet, worksheet
|
1171
1171
|
|
1172
1172
|
Returns the style defined in the Excel Spreadsheet
|
1173
1173
|
|
@@ -1185,11 +1185,11 @@ end
|
|
1185
1185
|
|
1186
1186
|
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
1187
1187
|
|
1188
|
-
input = CloudmersiveConvertApiClient::GetXlsxStylesRequest.new # GetXlsxStylesRequest |
|
1188
|
+
input = CloudmersiveConvertApiClient::GetXlsxStylesRequest.new # GetXlsxStylesRequest | Document input request
|
1189
1189
|
|
1190
1190
|
|
1191
1191
|
begin
|
1192
|
-
#Get styles from a XLSX worksheet
|
1192
|
+
#Get styles from a Excel XLSX spreadsheet, worksheet
|
1193
1193
|
result = api_instance.edit_document_xlsx_get_styles(input)
|
1194
1194
|
p result
|
1195
1195
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
@@ -1201,7 +1201,7 @@ end
|
|
1201
1201
|
|
1202
1202
|
Name | Type | Description | Notes
|
1203
1203
|
------------- | ------------- | ------------- | -------------
|
1204
|
-
**input** | [**GetXlsxStylesRequest**](GetXlsxStylesRequest.md)|
|
1204
|
+
**input** | [**GetXlsxStylesRequest**](GetXlsxStylesRequest.md)| Document input request |
|
1205
1205
|
|
1206
1206
|
### Return type
|
1207
1207
|
|
@@ -1221,7 +1221,7 @@ Name | Type | Description | Notes
|
|
1221
1221
|
# **edit_document_xlsx_get_worksheets**
|
1222
1222
|
> GetXlsxWorksheetsResponse edit_document_xlsx_get_worksheets(input)
|
1223
1223
|
|
1224
|
-
Get worksheets from a XLSX
|
1224
|
+
Get worksheets from a Excel XLSX spreadsheet
|
1225
1225
|
|
1226
1226
|
Returns the worksheets (tabs) defined in the Excel Spreadsheet (XLSX) format file
|
1227
1227
|
|
@@ -1239,11 +1239,11 @@ end
|
|
1239
1239
|
|
1240
1240
|
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
1241
1241
|
|
1242
|
-
input = CloudmersiveConvertApiClient::GetXlsxWorksheetsRequest.new # GetXlsxWorksheetsRequest |
|
1242
|
+
input = CloudmersiveConvertApiClient::GetXlsxWorksheetsRequest.new # GetXlsxWorksheetsRequest | Document input request
|
1243
1243
|
|
1244
1244
|
|
1245
1245
|
begin
|
1246
|
-
#Get worksheets from a XLSX
|
1246
|
+
#Get worksheets from a Excel XLSX spreadsheet
|
1247
1247
|
result = api_instance.edit_document_xlsx_get_worksheets(input)
|
1248
1248
|
p result
|
1249
1249
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
@@ -1255,7 +1255,7 @@ end
|
|
1255
1255
|
|
1256
1256
|
Name | Type | Description | Notes
|
1257
1257
|
------------- | ------------- | ------------- | -------------
|
1258
|
-
**input** | [**GetXlsxWorksheetsRequest**](GetXlsxWorksheetsRequest.md)|
|
1258
|
+
**input** | [**GetXlsxWorksheetsRequest**](GetXlsxWorksheetsRequest.md)| Document input request |
|
1259
1259
|
|
1260
1260
|
### Return type
|
1261
1261
|
|
@@ -1275,7 +1275,7 @@ Name | Type | Description | Notes
|
|
1275
1275
|
# **edit_document_xlsx_insert_worksheet**
|
1276
1276
|
> InsertXlsxWorksheetResponse edit_document_xlsx_insert_worksheet(input)
|
1277
1277
|
|
1278
|
-
Insert a new worksheet into an XLSX spreadsheet
|
1278
|
+
Insert a new worksheet into an Excel XLSX spreadsheet
|
1279
1279
|
|
1280
1280
|
Inserts a new worksheet into an Excel Spreadsheet
|
1281
1281
|
|
@@ -1293,11 +1293,11 @@ end
|
|
1293
1293
|
|
1294
1294
|
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
1295
1295
|
|
1296
|
-
input = CloudmersiveConvertApiClient::InsertXlsxWorksheetRequest.new # InsertXlsxWorksheetRequest |
|
1296
|
+
input = CloudmersiveConvertApiClient::InsertXlsxWorksheetRequest.new # InsertXlsxWorksheetRequest | Document input request
|
1297
1297
|
|
1298
1298
|
|
1299
1299
|
begin
|
1300
|
-
#Insert a new worksheet into an XLSX spreadsheet
|
1300
|
+
#Insert a new worksheet into an Excel XLSX spreadsheet
|
1301
1301
|
result = api_instance.edit_document_xlsx_insert_worksheet(input)
|
1302
1302
|
p result
|
1303
1303
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
@@ -1309,7 +1309,7 @@ end
|
|
1309
1309
|
|
1310
1310
|
Name | Type | Description | Notes
|
1311
1311
|
------------- | ------------- | ------------- | -------------
|
1312
|
-
**input** | [**InsertXlsxWorksheetRequest**](InsertXlsxWorksheetRequest.md)|
|
1312
|
+
**input** | [**InsertXlsxWorksheetRequest**](InsertXlsxWorksheetRequest.md)| Document input request |
|
1313
1313
|
|
1314
1314
|
### Return type
|
1315
1315
|
|