cloudmersive-convert-api-client 1.6.6 → 1.6.7
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +32 -5
- data/docs/Base64DecodeRequest.md +8 -0
- data/docs/Base64DecodeResponse.md +9 -0
- data/docs/Base64DetectRequest.md +8 -0
- data/docs/Base64DetectResponse.md +9 -0
- data/docs/Base64EncodeRequest.md +8 -0
- data/docs/Base64EncodeResponse.md +9 -0
- data/docs/ChangeLineEndingResponse.md +9 -0
- data/docs/ConvertDocumentApi.md +6 -2
- data/docs/DetectLineEndingsResponse.md +11 -0
- data/docs/EditDocumentApi.md +5 -5
- data/docs/EditTextApi.md +506 -0
- data/docs/MergeDocumentApi.md +134 -0
- data/docs/RemoveHtmlFromTextRequest.md +8 -0
- data/docs/RemoveHtmlFromTextResponse.md +9 -0
- data/docs/RemoveWhitespaceFromTextRequest.md +8 -0
- data/docs/RemoveWhitespaceFromTextResponse.md +9 -0
- data/docs/SplitDocumentApi.md +62 -0
- data/docs/SplitTextDocumentByStringResult.md +10 -0
- data/docs/TextDocumentElement.md +9 -0
- data/docs/TextEncodingDetectResponse.md +9 -0
- data/lib/cloudmersive-convert-api-client.rb +16 -0
- data/lib/cloudmersive-convert-api-client/api/convert_document_api.rb +3 -0
- data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +6 -6
- data/lib/cloudmersive-convert-api-client/api/edit_text_api.rb +528 -0
- data/lib/cloudmersive-convert-api-client/api/merge_document_api.rb +150 -0
- data/lib/cloudmersive-convert-api-client/api/split_document_api.rb +66 -0
- data/lib/cloudmersive-convert-api-client/models/base64_decode_request.rb +189 -0
- data/lib/cloudmersive-convert-api-client/models/base64_decode_response.rb +215 -0
- data/lib/cloudmersive-convert-api-client/models/base64_detect_request.rb +189 -0
- data/lib/cloudmersive-convert-api-client/models/base64_detect_response.rb +199 -0
- data/lib/cloudmersive-convert-api-client/models/base64_encode_request.rb +205 -0
- data/lib/cloudmersive-convert-api-client/models/base64_encode_response.rb +199 -0
- data/lib/cloudmersive-convert-api-client/models/change_line_ending_response.rb +199 -0
- data/lib/cloudmersive-convert-api-client/models/detect_line_endings_response.rb +219 -0
- data/lib/cloudmersive-convert-api-client/models/remove_html_from_text_request.rb +189 -0
- data/lib/cloudmersive-convert-api-client/models/remove_html_from_text_response.rb +199 -0
- data/lib/cloudmersive-convert-api-client/models/remove_whitespace_from_text_request.rb +189 -0
- data/lib/cloudmersive-convert-api-client/models/remove_whitespace_from_text_response.rb +199 -0
- data/lib/cloudmersive-convert-api-client/models/split_text_document_by_string_result.rb +210 -0
- data/lib/cloudmersive-convert-api-client/models/text_document_element.rb +199 -0
- data/lib/cloudmersive-convert-api-client/models/text_encoding_detect_response.rb +199 -0
- data/lib/cloudmersive-convert-api-client/version.rb +1 -1
- data/spec/api/convert_document_api_spec.rb +1 -0
- data/spec/api/edit_document_api_spec.rb +3 -3
- data/spec/api/edit_text_api_spec.rb +144 -0
- data/spec/api/merge_document_api_spec.rb +34 -0
- data/spec/api/split_document_api_spec.rb +14 -0
- data/spec/models/base64_decode_request_spec.rb +42 -0
- data/spec/models/base64_decode_response_spec.rb +48 -0
- data/spec/models/base64_detect_request_spec.rb +42 -0
- data/spec/models/base64_detect_response_spec.rb +48 -0
- data/spec/models/base64_encode_request_spec.rb +42 -0
- data/spec/models/base64_encode_response_spec.rb +48 -0
- data/spec/models/change_line_ending_response_spec.rb +48 -0
- data/spec/models/detect_line_endings_response_spec.rb +60 -0
- data/spec/models/remove_html_from_text_request_spec.rb +42 -0
- data/spec/models/remove_html_from_text_response_spec.rb +48 -0
- data/spec/models/remove_whitespace_from_text_request_spec.rb +42 -0
- data/spec/models/remove_whitespace_from_text_response_spec.rb +48 -0
- data/spec/models/split_text_document_by_string_result_spec.rb +54 -0
- data/spec/models/text_document_element_spec.rb +48 -0
- data/spec/models/text_encoding_detect_response_spec.rb +48 -0
- metadata +50 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1c8f9d4b19be50fe42a7067932b9d79fb8b51c4196421f4f373c5b9e199bc839
|
4
|
+
data.tar.gz: a5a51747331493d5331a64758c10da8749d87facf73179783859aa082b644fb4
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ef226b4d536d61be81edeadb6a3f792721a266627d99e80015f4005632a91a82cc7321e72df343badd60c61857ae9a99ee1e6be7afa795ea5bc991b6b7d165d3
|
7
|
+
data.tar.gz: bda342354717451b217103a0d8d079b0f0e1073dd29ee396002dabca63c519ad9c840718d3fb3fd48a4214af5ec6645faa2cda28626f32e4a2edc1167582f4ca
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ Convert API lets you effortlessly convert file formats and types.
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: v1
|
10
|
-
- Package version: 1.6.
|
10
|
+
- Package version: 1.6.7
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
|
13
13
|
## Installation
|
@@ -23,15 +23,15 @@ gem build cloudmersive-convert-api-client.gemspec
|
|
23
23
|
Then either install the gem locally:
|
24
24
|
|
25
25
|
```shell
|
26
|
-
gem install ./cloudmersive-convert-api-client-1.6.
|
26
|
+
gem install ./cloudmersive-convert-api-client-1.6.7.gem
|
27
27
|
```
|
28
|
-
(for development, run `gem install --dev ./cloudmersive-convert-api-client-1.6.
|
28
|
+
(for development, run `gem install --dev ./cloudmersive-convert-api-client-1.6.7.gem` to install the development dependencies)
|
29
29
|
|
30
30
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
31
31
|
|
32
32
|
Finally add this to the Gemfile:
|
33
33
|
|
34
|
-
gem 'cloudmersive-convert-api-client', '~> 1.6.
|
34
|
+
gem 'cloudmersive-convert-api-client', '~> 1.6.7'
|
35
35
|
|
36
36
|
### Install from Git
|
37
37
|
|
@@ -174,7 +174,7 @@ Class | Method | HTTP request | Description
|
|
174
174
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_set_header**](docs/EditDocumentApi.md#edit_document_docx_set_header) | **POST** /convert/edit/docx/set-header | Set the header in a Word DOCX document
|
175
175
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_update_table_cell**](docs/EditDocumentApi.md#edit_document_docx_update_table_cell) | **POST** /convert/edit/docx/update-table-cell | Update, set contents of a table cell in an existing table in a Word DOCX document
|
176
176
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_update_table_row**](docs/EditDocumentApi.md#edit_document_docx_update_table_row) | **POST** /convert/edit/docx/update-table-row | Update, set contents of a table row in an existing table in a Word DOCX document
|
177
|
-
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_finish_editing**](docs/EditDocumentApi.md#edit_document_finish_editing) | **POST** /convert/edit/finish-editing |
|
177
|
+
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_finish_editing**](docs/EditDocumentApi.md#edit_document_finish_editing) | **POST** /convert/edit/finish-editing | Finish editing document, and download result from document editing
|
178
178
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_pptx_delete_slides**](docs/EditDocumentApi.md#edit_document_pptx_delete_slides) | **POST** /convert/edit/pptx/delete-slides | Delete, remove slides from a PowerPoint PPTX presentation document
|
179
179
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_pptx_replace**](docs/EditDocumentApi.md#edit_document_pptx_replace) | **POST** /convert/edit/pptx/replace-all | Replace string in PowerPoint PPTX presentation
|
180
180
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_clear_cell_by_index**](docs/EditDocumentApi.md#edit_document_xlsx_clear_cell_by_index) | **POST** /convert/edit/xlsx/clear-cell/by-index | Clear cell contents in an Excel XLSX spreadsheet, worksheet by index
|
@@ -209,6 +209,15 @@ Class | Method | HTTP request | Description
|
|
209
209
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_set_metadata**](docs/EditPdfApi.md#edit_pdf_set_metadata) | **POST** /convert/edit/pdf/set-metadata | Sets PDF document metadata
|
210
210
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_set_permissions**](docs/EditPdfApi.md#edit_pdf_set_permissions) | **POST** /convert/edit/pdf/encrypt/set-permissions | Encrypt, password-protect and set restricted permissions on a PDF
|
211
211
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_watermark_text**](docs/EditPdfApi.md#edit_pdf_watermark_text) | **POST** /convert/edit/pdf/watermark/text | Add a text watermark to a PDF
|
212
|
+
*CloudmersiveConvertApiClient::EditTextApi* | [**edit_text_base64_decode**](docs/EditTextApi.md#edit_text_base64_decode) | **POST** /convert/edit/text/encoding/base64/decode | Base 64 decode, convert base 64 string to binary content
|
213
|
+
*CloudmersiveConvertApiClient::EditTextApi* | [**edit_text_base64_detect**](docs/EditTextApi.md#edit_text_base64_detect) | **POST** /convert/edit/text/encoding/base64/detect | Detect, check if text string is base 64 encoded
|
214
|
+
*CloudmersiveConvertApiClient::EditTextApi* | [**edit_text_base64_encode**](docs/EditTextApi.md#edit_text_base64_encode) | **POST** /convert/edit/text/encoding/base64/encode | Base 64 encode, convert binary or file data to a text string
|
215
|
+
*CloudmersiveConvertApiClient::EditTextApi* | [**edit_text_change_line_endings**](docs/EditTextApi.md#edit_text_change_line_endings) | **POST** /convert/edit/text/line-endings/change | Set, change line endings of a text file
|
216
|
+
*CloudmersiveConvertApiClient::EditTextApi* | [**edit_text_detect_line_endings**](docs/EditTextApi.md#edit_text_detect_line_endings) | **POST** /convert/edit/text/line-endings/detect | Detect line endings of a text file
|
217
|
+
*CloudmersiveConvertApiClient::EditTextApi* | [**edit_text_remove_all_whitespace**](docs/EditTextApi.md#edit_text_remove_all_whitespace) | **POST** /convert/edit/text/remove/whitespace/all | Remove whitespace from text string
|
218
|
+
*CloudmersiveConvertApiClient::EditTextApi* | [**edit_text_remove_html**](docs/EditTextApi.md#edit_text_remove_html) | **POST** /convert/edit/text/remove/html | Remove HTML from text string
|
219
|
+
*CloudmersiveConvertApiClient::EditTextApi* | [**edit_text_text_encoding_detect**](docs/EditTextApi.md#edit_text_text_encoding_detect) | **POST** /convert/edit/text/encoding/detect | Detect text encoding of file
|
220
|
+
*CloudmersiveConvertApiClient::EditTextApi* | [**edit_text_trim_whitespace**](docs/EditTextApi.md#edit_text_trim_whitespace) | **POST** /convert/edit/text/remove/whitespace/trim | Trim leading and trailing whitespace from text string
|
212
221
|
*CloudmersiveConvertApiClient::MergeDocumentApi* | [**merge_document_docx**](docs/MergeDocumentApi.md#merge_document_docx) | **POST** /convert/merge/docx | Merge Two Word DOCX Together
|
213
222
|
*CloudmersiveConvertApiClient::MergeDocumentApi* | [**merge_document_docx_multi**](docs/MergeDocumentApi.md#merge_document_docx_multi) | **POST** /convert/merge/docx/multi | Merge Multple Word DOCX Together
|
214
223
|
*CloudmersiveConvertApiClient::MergeDocumentApi* | [**merge_document_pdf**](docs/MergeDocumentApi.md#merge_document_pdf) | **POST** /convert/merge/pdf | Merge Two PDF Files Together
|
@@ -216,12 +225,15 @@ Class | Method | HTTP request | Description
|
|
216
225
|
*CloudmersiveConvertApiClient::MergeDocumentApi* | [**merge_document_png**](docs/MergeDocumentApi.md#merge_document_png) | **POST** /convert/merge/png/vertical | Merge Multple PNG Files Together
|
217
226
|
*CloudmersiveConvertApiClient::MergeDocumentApi* | [**merge_document_pptx**](docs/MergeDocumentApi.md#merge_document_pptx) | **POST** /convert/merge/pptx | Merge Two PowerPoint PPTX Together
|
218
227
|
*CloudmersiveConvertApiClient::MergeDocumentApi* | [**merge_document_pptx_multi**](docs/MergeDocumentApi.md#merge_document_pptx_multi) | **POST** /convert/merge/pptx/multi | Merge Multple PowerPoint PPTX Together
|
228
|
+
*CloudmersiveConvertApiClient::MergeDocumentApi* | [**merge_document_txt**](docs/MergeDocumentApi.md#merge_document_txt) | **POST** /convert/merge/txt | Merge Two Text (TXT) Files Together
|
229
|
+
*CloudmersiveConvertApiClient::MergeDocumentApi* | [**merge_document_txt_multi**](docs/MergeDocumentApi.md#merge_document_txt_multi) | **POST** /convert/merge/txt/multi | Merge Multple Text (TXT) Files Together
|
219
230
|
*CloudmersiveConvertApiClient::MergeDocumentApi* | [**merge_document_xlsx**](docs/MergeDocumentApi.md#merge_document_xlsx) | **POST** /convert/merge/xlsx | Merge Two Excel XLSX Together
|
220
231
|
*CloudmersiveConvertApiClient::MergeDocumentApi* | [**merge_document_xlsx_multi**](docs/MergeDocumentApi.md#merge_document_xlsx_multi) | **POST** /convert/merge/xlsx/multi | Merge Multple Excel XLSX Together
|
221
232
|
*CloudmersiveConvertApiClient::SplitDocumentApi* | [**split_document_docx**](docs/SplitDocumentApi.md#split_document_docx) | **POST** /convert/split/docx | Split a single Word Document DOCX into Separate Documents by Page
|
222
233
|
*CloudmersiveConvertApiClient::SplitDocumentApi* | [**split_document_pdf_by_page**](docs/SplitDocumentApi.md#split_document_pdf_by_page) | **POST** /convert/split/pdf | Split a PDF file into separate PDF files, one per page
|
223
234
|
*CloudmersiveConvertApiClient::SplitDocumentApi* | [**split_document_pptx**](docs/SplitDocumentApi.md#split_document_pptx) | **POST** /convert/split/pptx | Split a single PowerPoint Presentation PPTX into Separate Slides
|
224
235
|
*CloudmersiveConvertApiClient::SplitDocumentApi* | [**split_document_txt_by_line**](docs/SplitDocumentApi.md#split_document_txt_by_line) | **POST** /convert/split/txt/by-line | Split a single Text file (txt) into lines
|
236
|
+
*CloudmersiveConvertApiClient::SplitDocumentApi* | [**split_document_txt_by_string**](docs/SplitDocumentApi.md#split_document_txt_by_string) | **POST** /convert/split/txt/by-string | Split a single Text file (txt) by a string delimiter
|
225
237
|
*CloudmersiveConvertApiClient::SplitDocumentApi* | [**split_document_xlsx**](docs/SplitDocumentApi.md#split_document_xlsx) | **POST** /convert/split/xlsx | Split a single Excel XLSX into Separate Worksheets
|
226
238
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_autodetect_validation**](docs/ValidateDocumentApi.md#validate_document_autodetect_validation) | **POST** /convert/validate/autodetect | Autodetect content type and validate
|
227
239
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_docx_validation**](docs/ValidateDocumentApi.md#validate_document_docx_validation) | **POST** /convert/validate/docx | Validate a Word document (DOCX)
|
@@ -241,6 +253,13 @@ Class | Method | HTTP request | Description
|
|
241
253
|
- [CloudmersiveConvertApiClient::AutodetectDocumentValidationResult](docs/AutodetectDocumentValidationResult.md)
|
242
254
|
- [CloudmersiveConvertApiClient::AutodetectGetInfoResult](docs/AutodetectGetInfoResult.md)
|
243
255
|
- [CloudmersiveConvertApiClient::AutodetectToPngResult](docs/AutodetectToPngResult.md)
|
256
|
+
- [CloudmersiveConvertApiClient::Base64DecodeRequest](docs/Base64DecodeRequest.md)
|
257
|
+
- [CloudmersiveConvertApiClient::Base64DecodeResponse](docs/Base64DecodeResponse.md)
|
258
|
+
- [CloudmersiveConvertApiClient::Base64DetectRequest](docs/Base64DetectRequest.md)
|
259
|
+
- [CloudmersiveConvertApiClient::Base64DetectResponse](docs/Base64DetectResponse.md)
|
260
|
+
- [CloudmersiveConvertApiClient::Base64EncodeRequest](docs/Base64EncodeRequest.md)
|
261
|
+
- [CloudmersiveConvertApiClient::Base64EncodeResponse](docs/Base64EncodeResponse.md)
|
262
|
+
- [CloudmersiveConvertApiClient::ChangeLineEndingResponse](docs/ChangeLineEndingResponse.md)
|
244
263
|
- [CloudmersiveConvertApiClient::ClearXlsxCellRequest](docs/ClearXlsxCellRequest.md)
|
245
264
|
- [CloudmersiveConvertApiClient::ClearXlsxCellResponse](docs/ClearXlsxCellResponse.md)
|
246
265
|
- [CloudmersiveConvertApiClient::ConvertedPngPage](docs/ConvertedPngPage.md)
|
@@ -254,6 +273,7 @@ Class | Method | HTTP request | Description
|
|
254
273
|
- [CloudmersiveConvertApiClient::DeleteDocxTableRowRangeResponse](docs/DeleteDocxTableRowRangeResponse.md)
|
255
274
|
- [CloudmersiveConvertApiClient::DeleteDocxTableRowRequest](docs/DeleteDocxTableRowRequest.md)
|
256
275
|
- [CloudmersiveConvertApiClient::DeleteDocxTableRowResponse](docs/DeleteDocxTableRowResponse.md)
|
276
|
+
- [CloudmersiveConvertApiClient::DetectLineEndingsResponse](docs/DetectLineEndingsResponse.md)
|
257
277
|
- [CloudmersiveConvertApiClient::DocumentValidationError](docs/DocumentValidationError.md)
|
258
278
|
- [CloudmersiveConvertApiClient::DocumentValidationResult](docs/DocumentValidationResult.md)
|
259
279
|
- [CloudmersiveConvertApiClient::DocxBody](docs/DocxBody.md)
|
@@ -356,7 +376,11 @@ Class | Method | HTTP request | Description
|
|
356
376
|
- [CloudmersiveConvertApiClient::RemoveDocxHeadersAndFootersRequest](docs/RemoveDocxHeadersAndFootersRequest.md)
|
357
377
|
- [CloudmersiveConvertApiClient::RemoveDocxHeadersAndFootersResponse](docs/RemoveDocxHeadersAndFootersResponse.md)
|
358
378
|
- [CloudmersiveConvertApiClient::RemoveDocxPagesRequest](docs/RemoveDocxPagesRequest.md)
|
379
|
+
- [CloudmersiveConvertApiClient::RemoveHtmlFromTextRequest](docs/RemoveHtmlFromTextRequest.md)
|
380
|
+
- [CloudmersiveConvertApiClient::RemoveHtmlFromTextResponse](docs/RemoveHtmlFromTextResponse.md)
|
359
381
|
- [CloudmersiveConvertApiClient::RemovePptxSlidesRequest](docs/RemovePptxSlidesRequest.md)
|
382
|
+
- [CloudmersiveConvertApiClient::RemoveWhitespaceFromTextRequest](docs/RemoveWhitespaceFromTextRequest.md)
|
383
|
+
- [CloudmersiveConvertApiClient::RemoveWhitespaceFromTextResponse](docs/RemoveWhitespaceFromTextResponse.md)
|
360
384
|
- [CloudmersiveConvertApiClient::RemoveXlsxWorksheetRequest](docs/RemoveXlsxWorksheetRequest.md)
|
361
385
|
- [CloudmersiveConvertApiClient::ReplaceStringRequest](docs/ReplaceStringRequest.md)
|
362
386
|
- [CloudmersiveConvertApiClient::ScreenshotRequest](docs/ScreenshotRequest.md)
|
@@ -372,9 +396,12 @@ Class | Method | HTTP request | Description
|
|
372
396
|
- [CloudmersiveConvertApiClient::SplitPdfResult](docs/SplitPdfResult.md)
|
373
397
|
- [CloudmersiveConvertApiClient::SplitPptxPresentationResult](docs/SplitPptxPresentationResult.md)
|
374
398
|
- [CloudmersiveConvertApiClient::SplitTextDocumentByLinesResult](docs/SplitTextDocumentByLinesResult.md)
|
399
|
+
- [CloudmersiveConvertApiClient::SplitTextDocumentByStringResult](docs/SplitTextDocumentByStringResult.md)
|
375
400
|
- [CloudmersiveConvertApiClient::SplitXlsxWorksheetResult](docs/SplitXlsxWorksheetResult.md)
|
376
401
|
- [CloudmersiveConvertApiClient::TextConversionResult](docs/TextConversionResult.md)
|
402
|
+
- [CloudmersiveConvertApiClient::TextDocumentElement](docs/TextDocumentElement.md)
|
377
403
|
- [CloudmersiveConvertApiClient::TextDocumentLine](docs/TextDocumentLine.md)
|
404
|
+
- [CloudmersiveConvertApiClient::TextEncodingDetectResponse](docs/TextEncodingDetectResponse.md)
|
378
405
|
- [CloudmersiveConvertApiClient::UpdateDocxTableCellRequest](docs/UpdateDocxTableCellRequest.md)
|
379
406
|
- [CloudmersiveConvertApiClient::UpdateDocxTableCellResponse](docs/UpdateDocxTableCellResponse.md)
|
380
407
|
- [CloudmersiveConvertApiClient::UpdateDocxTableRowRequest](docs/UpdateDocxTableRowRequest.md)
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::Base64DecodeRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**base64_content_to_decode** | **String** | Input content to decode from Base 64 into binary | [optional]
|
7
|
+
|
8
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::Base64DecodeResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
|
7
|
+
**content_result** | **String** | Result of performing a base 64 decode operation, binary file content | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::Base64DetectRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**base64_content_to_detect** | **String** | Input content text to detect if it is base 64 encoded | [optional]
|
7
|
+
|
8
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::Base64DetectResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
|
7
|
+
**is_base64_encoded** | **BOOLEAN** | True if the input string is base 64 encoded, false otherwise | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::Base64EncodeResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
|
7
|
+
**base64_text_content_result** | **String** | Result of performing a base 64 encoding operation, a text string representing the encoded original file content | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::ChangeLineEndingResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
|
7
|
+
**text_content_result** | **String** | Text content result | [optional]
|
8
|
+
|
9
|
+
|
data/docs/ConvertDocumentApi.md
CHANGED
@@ -527,7 +527,7 @@ Name | Type | Description | Notes
|
|
527
527
|
|
528
528
|
|
529
529
|
# **convert_document_docx_to_txt**
|
530
|
-
> TextConversionResult convert_document_docx_to_txt(input_file)
|
530
|
+
> TextConversionResult convert_document_docx_to_txt(input_file, opts)
|
531
531
|
|
532
532
|
Convert Word DOCX Document to Text (txt)
|
533
533
|
|
@@ -549,10 +549,13 @@ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
|
|
549
549
|
|
550
550
|
input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
|
551
551
|
|
552
|
+
opts = {
|
553
|
+
text_formatting_mode: "text_formatting_mode_example" # String | Optional; specify how whitespace should be handled when converting the document to text. Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases. Default is 'minimizeWhitespace'.
|
554
|
+
}
|
552
555
|
|
553
556
|
begin
|
554
557
|
#Convert Word DOCX Document to Text (txt)
|
555
|
-
result = api_instance.convert_document_docx_to_txt(input_file)
|
558
|
+
result = api_instance.convert_document_docx_to_txt(input_file, opts)
|
556
559
|
p result
|
557
560
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
558
561
|
puts "Exception when calling ConvertDocumentApi->convert_document_docx_to_txt: #{e}"
|
@@ -564,6 +567,7 @@ end
|
|
564
567
|
Name | Type | Description | Notes
|
565
568
|
------------- | ------------- | ------------- | -------------
|
566
569
|
**input_file** | **File**| Input file to perform the operation on. |
|
570
|
+
**text_formatting_mode** | **String**| Optional; specify how whitespace should be handled when converting the document to text. Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases. Default is 'minimizeWhitespace'. | [optional]
|
567
571
|
|
568
572
|
### Return type
|
569
573
|
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::DetectLineEndingsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
|
7
|
+
**primary_newline_type** | **String** | Type of newline in the file; possible vlaues are \"Mac\" (legacy Mac OS uses carriage return only); \"Unix\" (Unix and Linux OSes, and modern Mac OS); \"Windows\" (Windows operating systems) | [optional]
|
8
|
+
**primary_newline_terminator** | **String** | Characters used to terminate a newline; can be carriage return, linefeed, or carriage return + linefeed | [optional]
|
9
|
+
**input_length** | **Integer** | Length of the input string in characters | [optional]
|
10
|
+
|
11
|
+
|
data/docs/EditDocumentApi.md
CHANGED
@@ -33,7 +33,7 @@ Method | HTTP request | Description
|
|
33
33
|
[**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
|
34
34
|
[**edit_document_docx_update_table_cell**](EditDocumentApi.md#edit_document_docx_update_table_cell) | **POST** /convert/edit/docx/update-table-cell | Update, set contents of a table cell in an existing table in a Word DOCX document
|
35
35
|
[**edit_document_docx_update_table_row**](EditDocumentApi.md#edit_document_docx_update_table_row) | **POST** /convert/edit/docx/update-table-row | Update, set contents of a table row in an existing table in a Word DOCX document
|
36
|
-
[**edit_document_finish_editing**](EditDocumentApi.md#edit_document_finish_editing) | **POST** /convert/edit/finish-editing |
|
36
|
+
[**edit_document_finish_editing**](EditDocumentApi.md#edit_document_finish_editing) | **POST** /convert/edit/finish-editing | Finish editing document, and download result from document editing
|
37
37
|
[**edit_document_pptx_delete_slides**](EditDocumentApi.md#edit_document_pptx_delete_slides) | **POST** /convert/edit/pptx/delete-slides | Delete, remove slides from a PowerPoint PPTX presentation document
|
38
38
|
[**edit_document_pptx_replace**](EditDocumentApi.md#edit_document_pptx_replace) | **POST** /convert/edit/pptx/replace-all | Replace string in PowerPoint PPTX presentation
|
39
39
|
[**edit_document_xlsx_clear_cell_by_index**](EditDocumentApi.md#edit_document_xlsx_clear_cell_by_index) | **POST** /convert/edit/xlsx/clear-cell/by-index | Clear cell contents in an Excel XLSX spreadsheet, worksheet by index
|
@@ -57,7 +57,7 @@ Method | HTTP request | Description
|
|
57
57
|
|
58
58
|
Begin editing a document
|
59
59
|
|
60
|
-
Uploads a document to Cloudmersive to begin a series of one or more editing operations
|
60
|
+
Uploads a document to Cloudmersive to begin a series of one or more editing operations. To edit a document, first call Begin Editing on the document. Then perform operations on the document using the secure URL returned from BeginEditing, such as Word DOCX Delete Pages and Insert Table. Finally, perform finish editing on the URL to return the resulting edited document. The editing URL is temporary and only stored in-memory cache, and will automatically expire from the cache after 30 minutes, and cannot be directly accessed.
|
61
61
|
|
62
62
|
### Example
|
63
63
|
```ruby
|
@@ -165,7 +165,7 @@ Name | Type | Description | Notes
|
|
165
165
|
|
166
166
|
Create a blank Word DOCX document
|
167
167
|
|
168
|
-
Returns a blank Word DOCX Document format file
|
168
|
+
Returns a blank Word DOCX Document format file. The file is blank, with no contents. Use additional editing commands such as Insert Paragraph or Insert Table or Insert Image to populate the document.
|
169
169
|
|
170
170
|
### Example
|
171
171
|
```ruby
|
@@ -1621,7 +1621,7 @@ Name | Type | Description | Notes
|
|
1621
1621
|
# **edit_document_finish_editing**
|
1622
1622
|
> String edit_document_finish_editing(req_config)
|
1623
1623
|
|
1624
|
-
|
1624
|
+
Finish editing document, and download result from document editing
|
1625
1625
|
|
1626
1626
|
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.
|
1627
1627
|
|
@@ -1643,7 +1643,7 @@ req_config = CloudmersiveConvertApiClient::FinishEditingRequest.new # FinishEdit
|
|
1643
1643
|
|
1644
1644
|
|
1645
1645
|
begin
|
1646
|
-
#
|
1646
|
+
#Finish editing document, and download result from document editing
|
1647
1647
|
result = api_instance.edit_document_finish_editing(req_config)
|
1648
1648
|
p result
|
1649
1649
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
data/docs/EditTextApi.md
ADDED
@@ -0,0 +1,506 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::EditTextApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.cloudmersive.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**edit_text_base64_decode**](EditTextApi.md#edit_text_base64_decode) | **POST** /convert/edit/text/encoding/base64/decode | Base 64 decode, convert base 64 string to binary content
|
8
|
+
[**edit_text_base64_detect**](EditTextApi.md#edit_text_base64_detect) | **POST** /convert/edit/text/encoding/base64/detect | Detect, check if text string is base 64 encoded
|
9
|
+
[**edit_text_base64_encode**](EditTextApi.md#edit_text_base64_encode) | **POST** /convert/edit/text/encoding/base64/encode | Base 64 encode, convert binary or file data to a text string
|
10
|
+
[**edit_text_change_line_endings**](EditTextApi.md#edit_text_change_line_endings) | **POST** /convert/edit/text/line-endings/change | Set, change line endings of a text file
|
11
|
+
[**edit_text_detect_line_endings**](EditTextApi.md#edit_text_detect_line_endings) | **POST** /convert/edit/text/line-endings/detect | Detect line endings of a text file
|
12
|
+
[**edit_text_remove_all_whitespace**](EditTextApi.md#edit_text_remove_all_whitespace) | **POST** /convert/edit/text/remove/whitespace/all | Remove whitespace from text string
|
13
|
+
[**edit_text_remove_html**](EditTextApi.md#edit_text_remove_html) | **POST** /convert/edit/text/remove/html | Remove HTML from text string
|
14
|
+
[**edit_text_text_encoding_detect**](EditTextApi.md#edit_text_text_encoding_detect) | **POST** /convert/edit/text/encoding/detect | Detect text encoding of file
|
15
|
+
[**edit_text_trim_whitespace**](EditTextApi.md#edit_text_trim_whitespace) | **POST** /convert/edit/text/remove/whitespace/trim | Trim leading and trailing whitespace from text string
|
16
|
+
|
17
|
+
|
18
|
+
# **edit_text_base64_decode**
|
19
|
+
> Base64DecodeResponse edit_text_base64_decode(request)
|
20
|
+
|
21
|
+
Base 64 decode, convert base 64 string to binary content
|
22
|
+
|
23
|
+
Decodes / converts base 64 UTF-8 text string to binary content
|
24
|
+
|
25
|
+
### Example
|
26
|
+
```ruby
|
27
|
+
# load the gem
|
28
|
+
require 'cloudmersive-convert-api-client'
|
29
|
+
# setup authorization
|
30
|
+
CloudmersiveConvertApiClient.configure do |config|
|
31
|
+
# Configure API key authorization: Apikey
|
32
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
33
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
34
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
35
|
+
end
|
36
|
+
|
37
|
+
api_instance = CloudmersiveConvertApiClient::EditTextApi.new
|
38
|
+
|
39
|
+
request = CloudmersiveConvertApiClient::Base64DecodeRequest.new # Base64DecodeRequest |
|
40
|
+
|
41
|
+
|
42
|
+
begin
|
43
|
+
#Base 64 decode, convert base 64 string to binary content
|
44
|
+
result = api_instance.edit_text_base64_decode(request)
|
45
|
+
p result
|
46
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
47
|
+
puts "Exception when calling EditTextApi->edit_text_base64_decode: #{e}"
|
48
|
+
end
|
49
|
+
```
|
50
|
+
|
51
|
+
### Parameters
|
52
|
+
|
53
|
+
Name | Type | Description | Notes
|
54
|
+
------------- | ------------- | ------------- | -------------
|
55
|
+
**request** | [**Base64DecodeRequest**](Base64DecodeRequest.md)| |
|
56
|
+
|
57
|
+
### Return type
|
58
|
+
|
59
|
+
[**Base64DecodeResponse**](Base64DecodeResponse.md)
|
60
|
+
|
61
|
+
### Authorization
|
62
|
+
|
63
|
+
[Apikey](../README.md#Apikey)
|
64
|
+
|
65
|
+
### HTTP request headers
|
66
|
+
|
67
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
68
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
69
|
+
|
70
|
+
|
71
|
+
|
72
|
+
# **edit_text_base64_detect**
|
73
|
+
> Base64DetectResponse edit_text_base64_detect(request)
|
74
|
+
|
75
|
+
Detect, check if text string is base 64 encoded
|
76
|
+
|
77
|
+
Checks, detects if input string is base 64 encoded
|
78
|
+
|
79
|
+
### Example
|
80
|
+
```ruby
|
81
|
+
# load the gem
|
82
|
+
require 'cloudmersive-convert-api-client'
|
83
|
+
# setup authorization
|
84
|
+
CloudmersiveConvertApiClient.configure do |config|
|
85
|
+
# Configure API key authorization: Apikey
|
86
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
87
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
88
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
89
|
+
end
|
90
|
+
|
91
|
+
api_instance = CloudmersiveConvertApiClient::EditTextApi.new
|
92
|
+
|
93
|
+
request = CloudmersiveConvertApiClient::Base64DetectRequest.new # Base64DetectRequest |
|
94
|
+
|
95
|
+
|
96
|
+
begin
|
97
|
+
#Detect, check if text string is base 64 encoded
|
98
|
+
result = api_instance.edit_text_base64_detect(request)
|
99
|
+
p result
|
100
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
101
|
+
puts "Exception when calling EditTextApi->edit_text_base64_detect: #{e}"
|
102
|
+
end
|
103
|
+
```
|
104
|
+
|
105
|
+
### Parameters
|
106
|
+
|
107
|
+
Name | Type | Description | Notes
|
108
|
+
------------- | ------------- | ------------- | -------------
|
109
|
+
**request** | [**Base64DetectRequest**](Base64DetectRequest.md)| |
|
110
|
+
|
111
|
+
### Return type
|
112
|
+
|
113
|
+
[**Base64DetectResponse**](Base64DetectResponse.md)
|
114
|
+
|
115
|
+
### Authorization
|
116
|
+
|
117
|
+
[Apikey](../README.md#Apikey)
|
118
|
+
|
119
|
+
### HTTP request headers
|
120
|
+
|
121
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
122
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
123
|
+
|
124
|
+
|
125
|
+
|
126
|
+
# **edit_text_base64_encode**
|
127
|
+
> Base64EncodeResponse edit_text_base64_encode(request)
|
128
|
+
|
129
|
+
Base 64 encode, convert binary or file data to a text string
|
130
|
+
|
131
|
+
Encodes / converts binary or file data to a text string
|
132
|
+
|
133
|
+
### Example
|
134
|
+
```ruby
|
135
|
+
# load the gem
|
136
|
+
require 'cloudmersive-convert-api-client'
|
137
|
+
# setup authorization
|
138
|
+
CloudmersiveConvertApiClient.configure do |config|
|
139
|
+
# Configure API key authorization: Apikey
|
140
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
141
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
142
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
143
|
+
end
|
144
|
+
|
145
|
+
api_instance = CloudmersiveConvertApiClient::EditTextApi.new
|
146
|
+
|
147
|
+
request = CloudmersiveConvertApiClient::Base64EncodeRequest.new # Base64EncodeRequest |
|
148
|
+
|
149
|
+
|
150
|
+
begin
|
151
|
+
#Base 64 encode, convert binary or file data to a text string
|
152
|
+
result = api_instance.edit_text_base64_encode(request)
|
153
|
+
p result
|
154
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
155
|
+
puts "Exception when calling EditTextApi->edit_text_base64_encode: #{e}"
|
156
|
+
end
|
157
|
+
```
|
158
|
+
|
159
|
+
### Parameters
|
160
|
+
|
161
|
+
Name | Type | Description | Notes
|
162
|
+
------------- | ------------- | ------------- | -------------
|
163
|
+
**request** | [**Base64EncodeRequest**](Base64EncodeRequest.md)| |
|
164
|
+
|
165
|
+
### Return type
|
166
|
+
|
167
|
+
[**Base64EncodeResponse**](Base64EncodeResponse.md)
|
168
|
+
|
169
|
+
### Authorization
|
170
|
+
|
171
|
+
[Apikey](../README.md#Apikey)
|
172
|
+
|
173
|
+
### HTTP request headers
|
174
|
+
|
175
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
176
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
177
|
+
|
178
|
+
|
179
|
+
|
180
|
+
# **edit_text_change_line_endings**
|
181
|
+
> ChangeLineEndingResponse edit_text_change_line_endings(line_ending_type, input_file)
|
182
|
+
|
183
|
+
Set, change line endings of a text file
|
184
|
+
|
185
|
+
Sets the line ending type of a text file; set to Windows, Unix or Mac.
|
186
|
+
|
187
|
+
### Example
|
188
|
+
```ruby
|
189
|
+
# load the gem
|
190
|
+
require 'cloudmersive-convert-api-client'
|
191
|
+
# setup authorization
|
192
|
+
CloudmersiveConvertApiClient.configure do |config|
|
193
|
+
# Configure API key authorization: Apikey
|
194
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
195
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
196
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
197
|
+
end
|
198
|
+
|
199
|
+
api_instance = CloudmersiveConvertApiClient::EditTextApi.new
|
200
|
+
|
201
|
+
line_ending_type = "line_ending_type_example" # String | Required; 'Windows' will use carriage return and line feed, 'Unix' will use newline, and 'Mac' will use carriage return
|
202
|
+
|
203
|
+
input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
|
204
|
+
|
205
|
+
|
206
|
+
begin
|
207
|
+
#Set, change line endings of a text file
|
208
|
+
result = api_instance.edit_text_change_line_endings(line_ending_type, input_file)
|
209
|
+
p result
|
210
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
211
|
+
puts "Exception when calling EditTextApi->edit_text_change_line_endings: #{e}"
|
212
|
+
end
|
213
|
+
```
|
214
|
+
|
215
|
+
### Parameters
|
216
|
+
|
217
|
+
Name | Type | Description | Notes
|
218
|
+
------------- | ------------- | ------------- | -------------
|
219
|
+
**line_ending_type** | **String**| Required; 'Windows' will use carriage return and line feed, 'Unix' will use newline, and 'Mac' will use carriage return |
|
220
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
221
|
+
|
222
|
+
### Return type
|
223
|
+
|
224
|
+
[**ChangeLineEndingResponse**](ChangeLineEndingResponse.md)
|
225
|
+
|
226
|
+
### Authorization
|
227
|
+
|
228
|
+
[Apikey](../README.md#Apikey)
|
229
|
+
|
230
|
+
### HTTP request headers
|
231
|
+
|
232
|
+
- **Content-Type**: multipart/form-data
|
233
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
234
|
+
|
235
|
+
|
236
|
+
|
237
|
+
# **edit_text_detect_line_endings**
|
238
|
+
> DetectLineEndingsResponse edit_text_detect_line_endings(input_file)
|
239
|
+
|
240
|
+
Detect line endings of a text file
|
241
|
+
|
242
|
+
Detect line ending type (Windows, Unix or Mac) of an input file.
|
243
|
+
|
244
|
+
### Example
|
245
|
+
```ruby
|
246
|
+
# load the gem
|
247
|
+
require 'cloudmersive-convert-api-client'
|
248
|
+
# setup authorization
|
249
|
+
CloudmersiveConvertApiClient.configure do |config|
|
250
|
+
# Configure API key authorization: Apikey
|
251
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
252
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
253
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
254
|
+
end
|
255
|
+
|
256
|
+
api_instance = CloudmersiveConvertApiClient::EditTextApi.new
|
257
|
+
|
258
|
+
input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
|
259
|
+
|
260
|
+
|
261
|
+
begin
|
262
|
+
#Detect line endings of a text file
|
263
|
+
result = api_instance.edit_text_detect_line_endings(input_file)
|
264
|
+
p result
|
265
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
266
|
+
puts "Exception when calling EditTextApi->edit_text_detect_line_endings: #{e}"
|
267
|
+
end
|
268
|
+
```
|
269
|
+
|
270
|
+
### Parameters
|
271
|
+
|
272
|
+
Name | Type | Description | Notes
|
273
|
+
------------- | ------------- | ------------- | -------------
|
274
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
275
|
+
|
276
|
+
### Return type
|
277
|
+
|
278
|
+
[**DetectLineEndingsResponse**](DetectLineEndingsResponse.md)
|
279
|
+
|
280
|
+
### Authorization
|
281
|
+
|
282
|
+
[Apikey](../README.md#Apikey)
|
283
|
+
|
284
|
+
### HTTP request headers
|
285
|
+
|
286
|
+
- **Content-Type**: multipart/form-data
|
287
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
288
|
+
|
289
|
+
|
290
|
+
|
291
|
+
# **edit_text_remove_all_whitespace**
|
292
|
+
> RemoveWhitespaceFromTextResponse edit_text_remove_all_whitespace(request)
|
293
|
+
|
294
|
+
Remove whitespace from text string
|
295
|
+
|
296
|
+
Removes all whitespace from text, leaving behind only non-whitespace characters. Whitespace includes newlines, spaces and other whitespace characters.
|
297
|
+
|
298
|
+
### Example
|
299
|
+
```ruby
|
300
|
+
# load the gem
|
301
|
+
require 'cloudmersive-convert-api-client'
|
302
|
+
# setup authorization
|
303
|
+
CloudmersiveConvertApiClient.configure do |config|
|
304
|
+
# Configure API key authorization: Apikey
|
305
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
306
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
307
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
308
|
+
end
|
309
|
+
|
310
|
+
api_instance = CloudmersiveConvertApiClient::EditTextApi.new
|
311
|
+
|
312
|
+
request = CloudmersiveConvertApiClient::RemoveWhitespaceFromTextRequest.new # RemoveWhitespaceFromTextRequest |
|
313
|
+
|
314
|
+
|
315
|
+
begin
|
316
|
+
#Remove whitespace from text string
|
317
|
+
result = api_instance.edit_text_remove_all_whitespace(request)
|
318
|
+
p result
|
319
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
320
|
+
puts "Exception when calling EditTextApi->edit_text_remove_all_whitespace: #{e}"
|
321
|
+
end
|
322
|
+
```
|
323
|
+
|
324
|
+
### Parameters
|
325
|
+
|
326
|
+
Name | Type | Description | Notes
|
327
|
+
------------- | ------------- | ------------- | -------------
|
328
|
+
**request** | [**RemoveWhitespaceFromTextRequest**](RemoveWhitespaceFromTextRequest.md)| |
|
329
|
+
|
330
|
+
### Return type
|
331
|
+
|
332
|
+
[**RemoveWhitespaceFromTextResponse**](RemoveWhitespaceFromTextResponse.md)
|
333
|
+
|
334
|
+
### Authorization
|
335
|
+
|
336
|
+
[Apikey](../README.md#Apikey)
|
337
|
+
|
338
|
+
### HTTP request headers
|
339
|
+
|
340
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
341
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
342
|
+
|
343
|
+
|
344
|
+
|
345
|
+
# **edit_text_remove_html**
|
346
|
+
> RemoveHtmlFromTextResponse edit_text_remove_html(request)
|
347
|
+
|
348
|
+
Remove HTML from text string
|
349
|
+
|
350
|
+
Removes HTML from text, leaving behind only text. Formatted text will become plain text. Important for protecting against HTML and Cross-Site-Scripting attacks.
|
351
|
+
|
352
|
+
### Example
|
353
|
+
```ruby
|
354
|
+
# load the gem
|
355
|
+
require 'cloudmersive-convert-api-client'
|
356
|
+
# setup authorization
|
357
|
+
CloudmersiveConvertApiClient.configure do |config|
|
358
|
+
# Configure API key authorization: Apikey
|
359
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
360
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
361
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
362
|
+
end
|
363
|
+
|
364
|
+
api_instance = CloudmersiveConvertApiClient::EditTextApi.new
|
365
|
+
|
366
|
+
request = CloudmersiveConvertApiClient::RemoveHtmlFromTextRequest.new # RemoveHtmlFromTextRequest |
|
367
|
+
|
368
|
+
|
369
|
+
begin
|
370
|
+
#Remove HTML from text string
|
371
|
+
result = api_instance.edit_text_remove_html(request)
|
372
|
+
p result
|
373
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
374
|
+
puts "Exception when calling EditTextApi->edit_text_remove_html: #{e}"
|
375
|
+
end
|
376
|
+
```
|
377
|
+
|
378
|
+
### Parameters
|
379
|
+
|
380
|
+
Name | Type | Description | Notes
|
381
|
+
------------- | ------------- | ------------- | -------------
|
382
|
+
**request** | [**RemoveHtmlFromTextRequest**](RemoveHtmlFromTextRequest.md)| |
|
383
|
+
|
384
|
+
### Return type
|
385
|
+
|
386
|
+
[**RemoveHtmlFromTextResponse**](RemoveHtmlFromTextResponse.md)
|
387
|
+
|
388
|
+
### Authorization
|
389
|
+
|
390
|
+
[Apikey](../README.md#Apikey)
|
391
|
+
|
392
|
+
### HTTP request headers
|
393
|
+
|
394
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
395
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
396
|
+
|
397
|
+
|
398
|
+
|
399
|
+
# **edit_text_text_encoding_detect**
|
400
|
+
> TextEncodingDetectResponse edit_text_text_encoding_detect(input_file)
|
401
|
+
|
402
|
+
Detect text encoding of file
|
403
|
+
|
404
|
+
Checks text encoding of file
|
405
|
+
|
406
|
+
### Example
|
407
|
+
```ruby
|
408
|
+
# load the gem
|
409
|
+
require 'cloudmersive-convert-api-client'
|
410
|
+
# setup authorization
|
411
|
+
CloudmersiveConvertApiClient.configure do |config|
|
412
|
+
# Configure API key authorization: Apikey
|
413
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
414
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
415
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
416
|
+
end
|
417
|
+
|
418
|
+
api_instance = CloudmersiveConvertApiClient::EditTextApi.new
|
419
|
+
|
420
|
+
input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
|
421
|
+
|
422
|
+
|
423
|
+
begin
|
424
|
+
#Detect text encoding of file
|
425
|
+
result = api_instance.edit_text_text_encoding_detect(input_file)
|
426
|
+
p result
|
427
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
428
|
+
puts "Exception when calling EditTextApi->edit_text_text_encoding_detect: #{e}"
|
429
|
+
end
|
430
|
+
```
|
431
|
+
|
432
|
+
### Parameters
|
433
|
+
|
434
|
+
Name | Type | Description | Notes
|
435
|
+
------------- | ------------- | ------------- | -------------
|
436
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
437
|
+
|
438
|
+
### Return type
|
439
|
+
|
440
|
+
[**TextEncodingDetectResponse**](TextEncodingDetectResponse.md)
|
441
|
+
|
442
|
+
### Authorization
|
443
|
+
|
444
|
+
[Apikey](../README.md#Apikey)
|
445
|
+
|
446
|
+
### HTTP request headers
|
447
|
+
|
448
|
+
- **Content-Type**: multipart/form-data
|
449
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
450
|
+
|
451
|
+
|
452
|
+
|
453
|
+
# **edit_text_trim_whitespace**
|
454
|
+
> RemoveWhitespaceFromTextResponse edit_text_trim_whitespace(request)
|
455
|
+
|
456
|
+
Trim leading and trailing whitespace from text string
|
457
|
+
|
458
|
+
Trim leading and trailing whitespace from text, leaving behind a trimmed string. Whitespace includes newlines, spaces and other whitespace characters.
|
459
|
+
|
460
|
+
### Example
|
461
|
+
```ruby
|
462
|
+
# load the gem
|
463
|
+
require 'cloudmersive-convert-api-client'
|
464
|
+
# setup authorization
|
465
|
+
CloudmersiveConvertApiClient.configure do |config|
|
466
|
+
# Configure API key authorization: Apikey
|
467
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
468
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
469
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
470
|
+
end
|
471
|
+
|
472
|
+
api_instance = CloudmersiveConvertApiClient::EditTextApi.new
|
473
|
+
|
474
|
+
request = CloudmersiveConvertApiClient::RemoveWhitespaceFromTextRequest.new # RemoveWhitespaceFromTextRequest |
|
475
|
+
|
476
|
+
|
477
|
+
begin
|
478
|
+
#Trim leading and trailing whitespace from text string
|
479
|
+
result = api_instance.edit_text_trim_whitespace(request)
|
480
|
+
p result
|
481
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
482
|
+
puts "Exception when calling EditTextApi->edit_text_trim_whitespace: #{e}"
|
483
|
+
end
|
484
|
+
```
|
485
|
+
|
486
|
+
### Parameters
|
487
|
+
|
488
|
+
Name | Type | Description | Notes
|
489
|
+
------------- | ------------- | ------------- | -------------
|
490
|
+
**request** | [**RemoveWhitespaceFromTextRequest**](RemoveWhitespaceFromTextRequest.md)| |
|
491
|
+
|
492
|
+
### Return type
|
493
|
+
|
494
|
+
[**RemoveWhitespaceFromTextResponse**](RemoveWhitespaceFromTextResponse.md)
|
495
|
+
|
496
|
+
### Authorization
|
497
|
+
|
498
|
+
[Apikey](../README.md#Apikey)
|
499
|
+
|
500
|
+
### HTTP request headers
|
501
|
+
|
502
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
503
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
504
|
+
|
505
|
+
|
506
|
+
|