cloudmersive-convert-api-client 1.4.8 → 1.4.9

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.
Files changed (37) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +17 -4
  3. data/docs/EditDocumentApi.md +1 -1
  4. data/docs/EditPdfApi.md +220 -0
  5. data/docs/PdfDocument.md +10 -0
  6. data/docs/PdfFormField.md +11 -0
  7. data/docs/PdfFormFields.md +9 -0
  8. data/docs/PdfMetadata.md +15 -0
  9. data/docs/SetFormFieldValue.md +11 -0
  10. data/docs/SetPdfFormFieldsRequest.md +9 -0
  11. data/docs/SetPdfMetadataRequest.md +9 -0
  12. data/docs/SplitDocumentApi.md +60 -1
  13. data/docs/SplitPdfResult.md +9 -0
  14. data/lib/cloudmersive-convert-api-client.rb +8 -0
  15. data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +1 -1
  16. data/lib/cloudmersive-convert-api-client/api/edit_pdf_api.rb +222 -0
  17. data/lib/cloudmersive-convert-api-client/api/split_document_api.rb +60 -1
  18. data/lib/cloudmersive-convert-api-client/models/pdf_document.rb +225 -0
  19. data/lib/cloudmersive-convert-api-client/models/pdf_form_field.rb +219 -0
  20. data/lib/cloudmersive-convert-api-client/models/pdf_form_fields.rb +201 -0
  21. data/lib/cloudmersive-convert-api-client/models/pdf_metadata.rb +259 -0
  22. data/lib/cloudmersive-convert-api-client/models/set_form_field_value.rb +219 -0
  23. data/lib/cloudmersive-convert-api-client/models/set_pdf_form_fields_request.rb +217 -0
  24. data/lib/cloudmersive-convert-api-client/models/set_pdf_metadata_request.rb +213 -0
  25. data/lib/cloudmersive-convert-api-client/models/split_pdf_result.rb +201 -0
  26. data/lib/cloudmersive-convert-api-client/version.rb +1 -1
  27. data/spec/api/edit_pdf_api_spec.rb +48 -0
  28. data/spec/api/split_document_api_spec.rb +13 -0
  29. data/spec/models/pdf_document_spec.rb +54 -0
  30. data/spec/models/pdf_form_field_spec.rb +60 -0
  31. data/spec/models/pdf_form_fields_spec.rb +48 -0
  32. data/spec/models/pdf_metadata_spec.rb +84 -0
  33. data/spec/models/set_form_field_value_spec.rb +60 -0
  34. data/spec/models/set_pdf_form_fields_request_spec.rb +48 -0
  35. data/spec/models/set_pdf_metadata_request_spec.rb +48 -0
  36. data/spec/models/split_pdf_result_spec.rb +48 -0
  37. metadata +26 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 708bf710696f30a2f435f8e4363a49d3174ea46cc5a8895b72f860601810b994
4
- data.tar.gz: e2cda10f7364d3eda3072a69b350576b9f9cf13322cfd9e3104cef927f4f4352
3
+ metadata.gz: ed378c3bb9042c51d6ffaa519927c920160189b7e3b5315ddb8c0819b333abe3
4
+ data.tar.gz: bfae054531ec385fbb43eb23e7d61cda837892132aed41a51f6d032c880b4b25
5
5
  SHA512:
6
- metadata.gz: 81f8500718c43506356d965d97280d71eb71cf0f5be5928ac719c6cb77d8e885b36e560bfbdc377bb5fc12972eb13047d2eef69163b13794f81750fd1fa3e100
7
- data.tar.gz: 77c85ce3719db1f787263548b2c5f2a5277185b393baf05d5f6f12b3345da00d218486e6f71b1ecd61ec557f569d9bf3b24c17dbba5f295925df5e8bf143eb5a
6
+ metadata.gz: 33d2dd392d3475ec3f8a73ecd992f09ea9a15c6811a3d640044541d0c511c05519d23436ad52383c983a7ddbdc3fbb8d729e1e562d4a76772b18b9646b31e0f2
7
+ data.tar.gz: 8d69ac4b79a4b74c23a0e05cf766af34738c9ec4a54076ecffa2ff9428135d83b45b8c1d6b1bf3c5aeb4ab89a70c2280df61ea7dffd89f6212b920d6d9965fe9
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.4.8
10
+ - Package version: 1.4.9
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.4.8.gem
26
+ gem install ./cloudmersive-convert-api-client-1.4.9.gem
27
27
  ```
28
- (for development, run `gem install --dev ./cloudmersive-convert-api-client-1.4.8.gem` to install the development dependencies)
28
+ (for development, run `gem install --dev ./cloudmersive-convert-api-client-1.4.9.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.4.8'
34
+ gem 'cloudmersive-convert-api-client', '~> 1.4.9'
35
35
 
36
36
  ### Install from Git
37
37
 
@@ -153,7 +153,11 @@ Class | Method | HTTP request | Description
153
153
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_get_worksheets**](docs/EditDocumentApi.md#edit_document_xlsx_get_worksheets) | **POST** /convert/edit/xlsx/get-worksheets | Get worksheets from a XLSX
154
154
  *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_insert_worksheet**](docs/EditDocumentApi.md#edit_document_xlsx_insert_worksheet) | **POST** /convert/edit/xlsx/insert-worksheet | Insert a new worksheet into an XLSX spreadsheet
155
155
  *CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_encrypt**](docs/EditPdfApi.md#edit_pdf_encrypt) | **POST** /convert/edit/pdf/encrypt | Encrypt and password-protect a PDF
156
+ *CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_get_form_fields**](docs/EditPdfApi.md#edit_pdf_get_form_fields) | **POST** /convert/edit/pdf/form/get-fields | Gets PDF Form fields and values
157
+ *CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_get_metadata**](docs/EditPdfApi.md#edit_pdf_get_metadata) | **POST** /convert/edit/pdf/get-metadata | Get PDF document metadata
156
158
  *CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_rasterize**](docs/EditPdfApi.md#edit_pdf_rasterize) | **POST** /convert/edit/pdf/rasterize | Rasterize a PDF to an image-based PDF
159
+ *CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_set_form_fields**](docs/EditPdfApi.md#edit_pdf_set_form_fields) | **POST** /convert/edit/pdf/form/set-fields | Sets ands fills PDF Form field values
160
+ *CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_set_metadata**](docs/EditPdfApi.md#edit_pdf_set_metadata) | **POST** /convert/edit/pdf/set-metadata | Sets PDF document metadata
157
161
  *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
158
162
  *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
159
163
  *CloudmersiveConvertApiClient::MergeDocumentApi* | [**merge_document_docx**](docs/MergeDocumentApi.md#merge_document_docx) | **POST** /convert/merge/docx | Merge Two Word DOCX Together
@@ -165,6 +169,7 @@ Class | Method | HTTP request | Description
165
169
  *CloudmersiveConvertApiClient::MergeDocumentApi* | [**merge_document_pptx_multi**](docs/MergeDocumentApi.md#merge_document_pptx_multi) | **POST** /convert/merge/pptx/multi | Merge Multple PowerPoint PPTX Together
166
170
  *CloudmersiveConvertApiClient::MergeDocumentApi* | [**merge_document_xlsx**](docs/MergeDocumentApi.md#merge_document_xlsx) | **POST** /convert/merge/xlsx | Merge Two Excel XLSX Together
167
171
  *CloudmersiveConvertApiClient::MergeDocumentApi* | [**merge_document_xlsx_multi**](docs/MergeDocumentApi.md#merge_document_xlsx_multi) | **POST** /convert/merge/xlsx/multi | Merge Multple Excel XLSX Together
172
+ *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
168
173
  *CloudmersiveConvertApiClient::SplitDocumentApi* | [**split_document_xlsx**](docs/SplitDocumentApi.md#split_document_xlsx) | **POST** /convert/split/xlsx | Split a single Excel XLSX into Separate Worksheets
169
174
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_autodetect_validation**](docs/ValidateDocumentApi.md#validate_document_autodetect_validation) | **POST** /convert/validate/autodetect | Autodetect content type and validate
170
175
  *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_docx_validation**](docs/ValidateDocumentApi.md#validate_document_docx_validation) | **POST** /convert/validate/docx | Validate a Word document (DOCX)
@@ -249,11 +254,19 @@ Class | Method | HTTP request | Description
249
254
  - [CloudmersiveConvertApiClient::InsertXlsxWorksheetResponse](docs/InsertXlsxWorksheetResponse.md)
250
255
  - [CloudmersiveConvertApiClient::MultipageImageFormatConversionResult](docs/MultipageImageFormatConversionResult.md)
251
256
  - [CloudmersiveConvertApiClient::PageConversionResult](docs/PageConversionResult.md)
257
+ - [CloudmersiveConvertApiClient::PdfDocument](docs/PdfDocument.md)
258
+ - [CloudmersiveConvertApiClient::PdfFormField](docs/PdfFormField.md)
259
+ - [CloudmersiveConvertApiClient::PdfFormFields](docs/PdfFormFields.md)
260
+ - [CloudmersiveConvertApiClient::PdfMetadata](docs/PdfMetadata.md)
252
261
  - [CloudmersiveConvertApiClient::PdfToPngResult](docs/PdfToPngResult.md)
253
262
  - [CloudmersiveConvertApiClient::RemoveDocxHeadersAndFootersRequest](docs/RemoveDocxHeadersAndFootersRequest.md)
254
263
  - [CloudmersiveConvertApiClient::RemoveDocxHeadersAndFootersResponse](docs/RemoveDocxHeadersAndFootersResponse.md)
255
264
  - [CloudmersiveConvertApiClient::ReplaceStringRequest](docs/ReplaceStringRequest.md)
256
265
  - [CloudmersiveConvertApiClient::ScreenshotRequest](docs/ScreenshotRequest.md)
266
+ - [CloudmersiveConvertApiClient::SetFormFieldValue](docs/SetFormFieldValue.md)
267
+ - [CloudmersiveConvertApiClient::SetPdfFormFieldsRequest](docs/SetPdfFormFieldsRequest.md)
268
+ - [CloudmersiveConvertApiClient::SetPdfMetadataRequest](docs/SetPdfMetadataRequest.md)
269
+ - [CloudmersiveConvertApiClient::SplitPdfResult](docs/SplitPdfResult.md)
257
270
  - [CloudmersiveConvertApiClient::SplitXlsxWorksheetResult](docs/SplitXlsxWorksheetResult.md)
258
271
  - [CloudmersiveConvertApiClient::TextConversionResult](docs/TextConversionResult.md)
259
272
  - [CloudmersiveConvertApiClient::ViewerResponse](docs/ViewerResponse.md)
@@ -404,7 +404,7 @@ Name | Type | Description | Notes
404
404
  ### HTTP request headers
405
405
 
406
406
  - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
407
- - **Accept**: application/octet-stream
407
+ - **Accept**: application/json, text/json, application/xml, text/xml
408
408
 
409
409
 
410
410
 
data/docs/EditPdfApi.md CHANGED
@@ -5,7 +5,11 @@ All URIs are relative to *https://api.cloudmersive.com*
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**edit_pdf_encrypt**](EditPdfApi.md#edit_pdf_encrypt) | **POST** /convert/edit/pdf/encrypt | Encrypt and password-protect a PDF
8
+ [**edit_pdf_get_form_fields**](EditPdfApi.md#edit_pdf_get_form_fields) | **POST** /convert/edit/pdf/form/get-fields | Gets PDF Form fields and values
9
+ [**edit_pdf_get_metadata**](EditPdfApi.md#edit_pdf_get_metadata) | **POST** /convert/edit/pdf/get-metadata | Get PDF document metadata
8
10
  [**edit_pdf_rasterize**](EditPdfApi.md#edit_pdf_rasterize) | **POST** /convert/edit/pdf/rasterize | Rasterize a PDF to an image-based PDF
11
+ [**edit_pdf_set_form_fields**](EditPdfApi.md#edit_pdf_set_form_fields) | **POST** /convert/edit/pdf/form/set-fields | Sets ands fills PDF Form field values
12
+ [**edit_pdf_set_metadata**](EditPdfApi.md#edit_pdf_set_metadata) | **POST** /convert/edit/pdf/set-metadata | Sets PDF document metadata
9
13
  [**edit_pdf_set_permissions**](EditPdfApi.md#edit_pdf_set_permissions) | **POST** /convert/edit/pdf/encrypt/set-permissions | Encrypt, password-protect and set restricted permissions on a PDF
10
14
  [**edit_pdf_watermark_text**](EditPdfApi.md#edit_pdf_watermark_text) | **POST** /convert/edit/pdf/watermark/text | Add a text watermark to a PDF
11
15
 
@@ -70,6 +74,114 @@ Name | Type | Description | Notes
70
74
 
71
75
 
72
76
 
77
+ # **edit_pdf_get_form_fields**
78
+ > PdfFormFields edit_pdf_get_form_fields(input_file)
79
+
80
+ Gets PDF Form fields and values
81
+
82
+ Encrypt a PDF document with a password. Set an owner password to control owner (editor/creator) permissions, and set a user (reader) password to control the viewer of the PDF. Set the password fields null to omit the given password.
83
+
84
+ ### Example
85
+ ```ruby
86
+ # load the gem
87
+ require 'cloudmersive-convert-api-client'
88
+ # setup authorization
89
+ CloudmersiveConvertApiClient.configure do |config|
90
+ # Configure API key authorization: Apikey
91
+ config.api_key['Apikey'] = 'YOUR API KEY'
92
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
93
+ #config.api_key_prefix['Apikey'] = 'Bearer'
94
+ end
95
+
96
+ api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
97
+
98
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
99
+
100
+
101
+ begin
102
+ #Gets PDF Form fields and values
103
+ result = api_instance.edit_pdf_get_form_fields(input_file)
104
+ p result
105
+ rescue CloudmersiveConvertApiClient::ApiError => e
106
+ puts "Exception when calling EditPdfApi->edit_pdf_get_form_fields: #{e}"
107
+ end
108
+ ```
109
+
110
+ ### Parameters
111
+
112
+ Name | Type | Description | Notes
113
+ ------------- | ------------- | ------------- | -------------
114
+ **input_file** | **File**| Input file to perform the operation on. |
115
+
116
+ ### Return type
117
+
118
+ [**PdfFormFields**](PdfFormFields.md)
119
+
120
+ ### Authorization
121
+
122
+ [Apikey](../README.md#Apikey)
123
+
124
+ ### HTTP request headers
125
+
126
+ - **Content-Type**: multipart/form-data
127
+ - **Accept**: application/octet-stream
128
+
129
+
130
+
131
+ # **edit_pdf_get_metadata**
132
+ > PdfMetadata edit_pdf_get_metadata(input_file)
133
+
134
+ Get PDF document metadata
135
+
136
+ Returns the metadata from the PDF document, including Title, Author, etc.
137
+
138
+ ### Example
139
+ ```ruby
140
+ # load the gem
141
+ require 'cloudmersive-convert-api-client'
142
+ # setup authorization
143
+ CloudmersiveConvertApiClient.configure do |config|
144
+ # Configure API key authorization: Apikey
145
+ config.api_key['Apikey'] = 'YOUR API KEY'
146
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
147
+ #config.api_key_prefix['Apikey'] = 'Bearer'
148
+ end
149
+
150
+ api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
151
+
152
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
153
+
154
+
155
+ begin
156
+ #Get PDF document metadata
157
+ result = api_instance.edit_pdf_get_metadata(input_file)
158
+ p result
159
+ rescue CloudmersiveConvertApiClient::ApiError => e
160
+ puts "Exception when calling EditPdfApi->edit_pdf_get_metadata: #{e}"
161
+ end
162
+ ```
163
+
164
+ ### Parameters
165
+
166
+ Name | Type | Description | Notes
167
+ ------------- | ------------- | ------------- | -------------
168
+ **input_file** | **File**| Input file to perform the operation on. |
169
+
170
+ ### Return type
171
+
172
+ [**PdfMetadata**](PdfMetadata.md)
173
+
174
+ ### Authorization
175
+
176
+ [Apikey](../README.md#Apikey)
177
+
178
+ ### HTTP request headers
179
+
180
+ - **Content-Type**: multipart/form-data
181
+ - **Accept**: application/json, text/json, application/xml, text/xml
182
+
183
+
184
+
73
185
  # **edit_pdf_rasterize**
74
186
  > String edit_pdf_rasterize(input_file)
75
187
 
@@ -124,6 +236,114 @@ Name | Type | Description | Notes
124
236
 
125
237
 
126
238
 
239
+ # **edit_pdf_set_form_fields**
240
+ > String edit_pdf_set_form_fields(field_values)
241
+
242
+ Sets ands fills PDF Form field values
243
+
244
+ Fill in the form fields in a PDF form with specific values. Use form/get-fields to enumerate the available fields and their data types in an input form.
245
+
246
+ ### Example
247
+ ```ruby
248
+ # load the gem
249
+ require 'cloudmersive-convert-api-client'
250
+ # setup authorization
251
+ CloudmersiveConvertApiClient.configure do |config|
252
+ # Configure API key authorization: Apikey
253
+ config.api_key['Apikey'] = 'YOUR API KEY'
254
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
255
+ #config.api_key_prefix['Apikey'] = 'Bearer'
256
+ end
257
+
258
+ api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
259
+
260
+ field_values = CloudmersiveConvertApiClient::SetPdfFormFieldsRequest.new # SetPdfFormFieldsRequest |
261
+
262
+
263
+ begin
264
+ #Sets ands fills PDF Form field values
265
+ result = api_instance.edit_pdf_set_form_fields(field_values)
266
+ p result
267
+ rescue CloudmersiveConvertApiClient::ApiError => e
268
+ puts "Exception when calling EditPdfApi->edit_pdf_set_form_fields: #{e}"
269
+ end
270
+ ```
271
+
272
+ ### Parameters
273
+
274
+ Name | Type | Description | Notes
275
+ ------------- | ------------- | ------------- | -------------
276
+ **field_values** | [**SetPdfFormFieldsRequest**](SetPdfFormFieldsRequest.md)| |
277
+
278
+ ### Return type
279
+
280
+ **String**
281
+
282
+ ### Authorization
283
+
284
+ [Apikey](../README.md#Apikey)
285
+
286
+ ### HTTP request headers
287
+
288
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
289
+ - **Accept**: application/octet-stream
290
+
291
+
292
+
293
+ # **edit_pdf_set_metadata**
294
+ > Object edit_pdf_set_metadata(request)
295
+
296
+ Sets PDF document metadata
297
+
298
+ Sets (writes) metadata into the input PDF document, including Title, Author, etc.
299
+
300
+ ### Example
301
+ ```ruby
302
+ # load the gem
303
+ require 'cloudmersive-convert-api-client'
304
+ # setup authorization
305
+ CloudmersiveConvertApiClient.configure do |config|
306
+ # Configure API key authorization: Apikey
307
+ config.api_key['Apikey'] = 'YOUR API KEY'
308
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
309
+ #config.api_key_prefix['Apikey'] = 'Bearer'
310
+ end
311
+
312
+ api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
313
+
314
+ request = CloudmersiveConvertApiClient::SetPdfMetadataRequest.new # SetPdfMetadataRequest |
315
+
316
+
317
+ begin
318
+ #Sets PDF document metadata
319
+ result = api_instance.edit_pdf_set_metadata(request)
320
+ p result
321
+ rescue CloudmersiveConvertApiClient::ApiError => e
322
+ puts "Exception when calling EditPdfApi->edit_pdf_set_metadata: #{e}"
323
+ end
324
+ ```
325
+
326
+ ### Parameters
327
+
328
+ Name | Type | Description | Notes
329
+ ------------- | ------------- | ------------- | -------------
330
+ **request** | [**SetPdfMetadataRequest**](SetPdfMetadataRequest.md)| |
331
+
332
+ ### Return type
333
+
334
+ **Object**
335
+
336
+ ### Authorization
337
+
338
+ [Apikey](../README.md#Apikey)
339
+
340
+ ### HTTP request headers
341
+
342
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
343
+ - **Accept**: application/octet-stream
344
+
345
+
346
+
127
347
  # **edit_pdf_set_permissions**
128
348
  > String edit_pdf_set_permissions(owner_password, input_file, opts)
129
349
 
@@ -0,0 +1,10 @@
1
+ # CloudmersiveConvertApiClient::PdfDocument
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **page_number** | **Integer** | Page number of the converted page, starting with 1 for the first page | [optional]
7
+ **url** | **String** | URL to the PDF file of this worksheet; file is stored in an in-memory cache and will be deleted | [optional]
8
+ **document_contents** | **String** | If returnDocumentContents is set to true, will contain the contents of the document; otherwise will be set to null and the document contents will be available via the URL parameter | [optional]
9
+
10
+
@@ -0,0 +1,11 @@
1
+ # CloudmersiveConvertApiClient::PdfFormField
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **field_name** | **String** | Name of the form field | [optional]
7
+ **field_type** | **String** | The data type of the field; possible values are Text (FieldValue will be a string), Checkbox (FieldValue can be \"true\" or \"false\"), ComboBox (FieldComboBoxSelectedIndex will also be populated), Other | [optional]
8
+ **field_value** | **String** | Value of the form field | [optional]
9
+ **field_combo_box_selected_index** | **Integer** | Applies to ComboBox field types only; specifies the selected index of the combo box selection if available | [optional]
10
+
11
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::PdfFormFields
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
7
+ **form_fields** | [**Array<PdfFormField>**](PdfFormField.md) | Fields and field values found in the form | [optional]
8
+
9
+
@@ -0,0 +1,15 @@
1
+ # CloudmersiveConvertApiClient::PdfMetadata
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
7
+ **title** | **String** | Title of the document | [optional]
8
+ **keywords** | **String** | Keywords of the document | [optional]
9
+ **subject** | **String** | Subject of the document | [optional]
10
+ **author** | **String** | User name of the creator/author of the document, if available, null if not available | [optional]
11
+ **creator** | **String** | Creator of the document | [optional]
12
+ **date_modified** | **DateTime** | The timestamp that the document was last modified, if available, null if not available | [optional]
13
+ **date_created** | **DateTime** | The timestamp that the document was created, if available, null if not available | [optional]
14
+
15
+
@@ -0,0 +1,11 @@
1
+ # CloudmersiveConvertApiClient::SetFormFieldValue
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **field_name** | **String** | Name of the field to set; you can call /convert/edit/pdf/form/get-fields to enumerate field names in a form | [optional]
7
+ **text_value** | **String** | For fields of type Text, the text value to put into the field | [optional]
8
+ **checkbox_value** | **BOOLEAN** | For fields of type Checkbox, the value to put into the field | [optional]
9
+ **combo_box_selected_index** | **Integer** | For fields of type ComboBox; specifies the selected index of the combo box selection | [optional]
10
+
11
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::SetPdfFormFieldsRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **field_values** | [**Array<SetFormFieldValue>**](SetFormFieldValue.md) | Field values to set | [optional]
7
+ **input_file_bytes** | **String** | Contents of the input file to set the fields on | [optional]
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::SetPdfMetadataRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **input_file_bytes** | **String** | | [optional]
7
+ **metadata_to_set** | [**PdfMetadata**](PdfMetadata.md) | | [optional]
8
+
9
+
@@ -4,9 +4,68 @@ All URIs are relative to *https://api.cloudmersive.com*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
+ [**split_document_pdf_by_page**](SplitDocumentApi.md#split_document_pdf_by_page) | **POST** /convert/split/pdf | Split a PDF file into separate PDF files, one per page
7
8
  [**split_document_xlsx**](SplitDocumentApi.md#split_document_xlsx) | **POST** /convert/split/xlsx | Split a single Excel XLSX into Separate Worksheets
8
9
 
9
10
 
11
+ # **split_document_pdf_by_page**
12
+ > SplitPdfResult split_document_pdf_by_page(input_file, opts)
13
+
14
+ Split a PDF file into separate PDF files, one per page
15
+
16
+ Split an input PDF file into separate pages, comprised of one PDF file per page.
17
+
18
+ ### Example
19
+ ```ruby
20
+ # load the gem
21
+ require 'cloudmersive-convert-api-client'
22
+ # setup authorization
23
+ CloudmersiveConvertApiClient.configure do |config|
24
+ # Configure API key authorization: Apikey
25
+ config.api_key['Apikey'] = 'YOUR API KEY'
26
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
27
+ #config.api_key_prefix['Apikey'] = 'Bearer'
28
+ end
29
+
30
+ api_instance = CloudmersiveConvertApiClient::SplitDocumentApi.new
31
+
32
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
33
+
34
+ opts = {
35
+ return_document_contents: true # BOOLEAN | Set to true to directly return all of the document contents in the DocumentContents field; set to false to return contents as temporary URLs (more efficient for large operations). Default is false.
36
+ }
37
+
38
+ begin
39
+ #Split a PDF file into separate PDF files, one per page
40
+ result = api_instance.split_document_pdf_by_page(input_file, opts)
41
+ p result
42
+ rescue CloudmersiveConvertApiClient::ApiError => e
43
+ puts "Exception when calling SplitDocumentApi->split_document_pdf_by_page: #{e}"
44
+ end
45
+ ```
46
+
47
+ ### Parameters
48
+
49
+ Name | Type | Description | Notes
50
+ ------------- | ------------- | ------------- | -------------
51
+ **input_file** | **File**| Input file to perform the operation on. |
52
+ **return_document_contents** | **BOOLEAN**| Set to true to directly return all of the document contents in the DocumentContents field; set to false to return contents as temporary URLs (more efficient for large operations). Default is false. | [optional]
53
+
54
+ ### Return type
55
+
56
+ [**SplitPdfResult**](SplitPdfResult.md)
57
+
58
+ ### Authorization
59
+
60
+ [Apikey](../README.md#Apikey)
61
+
62
+ ### HTTP request headers
63
+
64
+ - **Content-Type**: multipart/form-data
65
+ - **Accept**: application/json, text/json, application/xml, text/xml
66
+
67
+
68
+
10
69
  # **split_document_xlsx**
11
70
  > SplitXlsxWorksheetResult split_document_xlsx(input_file)
12
71
 
@@ -57,7 +116,7 @@ Name | Type | Description | Notes
57
116
  ### HTTP request headers
58
117
 
59
118
  - **Content-Type**: multipart/form-data
60
- - **Accept**: application/octet-stream
119
+ - **Accept**: application/json, text/json, application/xml, text/xml
61
120
 
62
121
 
63
122