aspose_pdf_cloud 19.8.0 → 19.9.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +13 -4
- data/docs/DocMDPAccessPermissionType.md +1 -1
- data/docs/PdfApi.md +130 -0
- data/docs/TextBoxField.md +32 -0
- data/docs/TextBoxFieldResponse.md +11 -0
- data/docs/TextBoxFields.md +10 -0
- data/docs/TextBoxFieldsResponse.md +11 -0
- data/lib/aspose_pdf_cloud.rb +4 -0
- data/lib/aspose_pdf_cloud/api/pdf_api.rb +388 -0
- data/lib/aspose_pdf_cloud/models/text_box_field.rb +443 -0
- data/lib/aspose_pdf_cloud/models/text_box_field_response.rb +224 -0
- data/lib/aspose_pdf_cloud/models/text_box_fields.rb +213 -0
- data/lib/aspose_pdf_cloud/models/text_box_fields_response.rb +224 -0
- data/lib/aspose_pdf_cloud/version.rb +1 -1
- data/test/pdf_tests.rb +84 -0
- data/test_data/FormDataTextBox.pdf +0 -0
- metadata +11 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 813acc9b0cfece4b96349f7267590fc1d0aecec77ee1d3e608427f5968678715
|
4
|
+
data.tar.gz: 71ff3a93504510c9fa3a112ab82f69a522d1afbd8f11289892d57f5434c07304
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7b06e44b31432b7e25b24d7a061a09062547315cf21ac7c5be682eb0a6662bb9dda9e92879070292db3e37344e862bf136fc4758b6629c212c0676bebb3a91de
|
7
|
+
data.tar.gz: b03e3b51ad172ed8bbbde3e453ae6aadfdbe53c7cd8c124f5ed64a6ba3c32f35a4801b1057843bab41cfb875aee630bc819b79af95937379c6297cbdb8432f31
|
data/README.md
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
# Aspose.PDF Cloud
|
2
2
|
|
3
3
|
- API version: 3.0
|
4
|
-
- Package version: 19.
|
4
|
+
- Package version: 19.9.0
|
5
5
|
|
6
6
|
[Aspose.PDF Cloud](https://products.aspose.cloud/pdf) is a true REST API that enables you to perform a wide range of document processing operations including creation, manipulation, conversion and rendering of Pdf documents in the cloud.
|
7
7
|
|
@@ -22,15 +22,15 @@ gem build aspose_pdf_cloud.gemspec
|
|
22
22
|
Then either install the gem locally:
|
23
23
|
|
24
24
|
```shell
|
25
|
-
gem install ./aspose_pdf_cloud-19.
|
25
|
+
gem install ./aspose_pdf_cloud-19.9.0.gem
|
26
26
|
```
|
27
|
-
(for development, run `gem install --dev ./aspose_pdf_cloud-19.
|
27
|
+
(for development, run `gem install --dev ./aspose_pdf_cloud-19.9.0.gem` to install the development dependencies)
|
28
28
|
|
29
29
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
30
30
|
|
31
31
|
Finally add this to the Gemfile:
|
32
32
|
|
33
|
-
gem 'aspose_pdf_cloud', '~> 19.
|
33
|
+
gem 'aspose_pdf_cloud', '~> 19.9.0'
|
34
34
|
|
35
35
|
### Install from Git
|
36
36
|
|
@@ -149,6 +149,7 @@ Class | Method | HTTP request | Description
|
|
149
149
|
*AsposePdfCloud::PdfApi* | [**get_document_strike_out_annotations**](docs/PdfApi.md#get_document_strike_out_annotations) | **GET** /pdf/\{name}/annotations/strikeout | Read document StrikeOut annotations.
|
150
150
|
*AsposePdfCloud::PdfApi* | [**get_document_tables**](docs/PdfApi.md#get_document_tables) | **GET** /pdf/\{name}/tables | Read document tables.
|
151
151
|
*AsposePdfCloud::PdfApi* | [**get_document_text_annotations**](docs/PdfApi.md#get_document_text_annotations) | **GET** /pdf/\{name}/annotations/text | Read document text annotations.
|
152
|
+
*AsposePdfCloud::PdfApi* | [**get_document_text_box_fields**](docs/PdfApi.md#get_document_text_box_fields) | **GET** /pdf/\{name}/fields/textbox | Read document text box fields.
|
152
153
|
*AsposePdfCloud::PdfApi* | [**get_document_underline_annotations**](docs/PdfApi.md#get_document_underline_annotations) | **GET** /pdf/\{name}/annotations/underline | Read document underline annotations.
|
153
154
|
*AsposePdfCloud::PdfApi* | [**get_download_document_attachment_by_index**](docs/PdfApi.md#get_download_document_attachment_by_index) | **GET** /pdf/\{name}/attachments/\{attachmentIndex}/download | Download document attachment content by its index.
|
154
155
|
*AsposePdfCloud::PdfApi* | [**get_epub_in_storage_to_pdf**](docs/PdfApi.md#get_epub_in_storage_to_pdf) | **GET** /pdf/create/epub | Convert EPUB file (located on storage) to PDF format and return resulting file in response.
|
@@ -213,6 +214,7 @@ Class | Method | HTTP request | Description
|
|
213
214
|
*AsposePdfCloud::PdfApi* | [**get_page_tables**](docs/PdfApi.md#get_page_tables) | **GET** /pdf/\{name}/pages/\{pageNumber}/tables | Read document page tables.
|
214
215
|
*AsposePdfCloud::PdfApi* | [**get_page_text**](docs/PdfApi.md#get_page_text) | **GET** /pdf/\{name}/pages/\{pageNumber}/text | Read page text items.
|
215
216
|
*AsposePdfCloud::PdfApi* | [**get_page_text_annotations**](docs/PdfApi.md#get_page_text_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/text | Read document page text annotations.
|
217
|
+
*AsposePdfCloud::PdfApi* | [**get_page_text_box_fields**](docs/PdfApi.md#get_page_text_box_fields) | **GET** /pdf/\{name}/page/\{pageNumber}/fields/textbox | Read document page text box fields.
|
216
218
|
*AsposePdfCloud::PdfApi* | [**get_page_underline_annotations**](docs/PdfApi.md#get_page_underline_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/underline | Read document page underline annotations.
|
217
219
|
*AsposePdfCloud::PdfApi* | [**get_pages**](docs/PdfApi.md#get_pages) | **GET** /pdf/\{name}/pages | Read document pages info.
|
218
220
|
*AsposePdfCloud::PdfApi* | [**get_pcl_in_storage_to_pdf**](docs/PdfApi.md#get_pcl_in_storage_to_pdf) | **GET** /pdf/create/pcl | Convert PCL file (located on storage) to PDF format and return resulting file in response.
|
@@ -248,6 +250,7 @@ Class | Method | HTTP request | Description
|
|
248
250
|
*AsposePdfCloud::PdfApi* | [**get_table**](docs/PdfApi.md#get_table) | **GET** /pdf/\{name}/tables/\{tableId} | Read document page table by ID.
|
249
251
|
*AsposePdfCloud::PdfApi* | [**get_text**](docs/PdfApi.md#get_text) | **GET** /pdf/\{name}/text | Read document text.
|
250
252
|
*AsposePdfCloud::PdfApi* | [**get_text_annotation**](docs/PdfApi.md#get_text_annotation) | **GET** /pdf/\{name}/annotations/text/\{annotationId} | Read document page text annotation by ID.
|
253
|
+
*AsposePdfCloud::PdfApi* | [**get_text_box_field**](docs/PdfApi.md#get_text_box_field) | **GET** /pdf/\{name}/fields/textbox/\{fieldName} | Read document text box field by name.
|
251
254
|
*AsposePdfCloud::PdfApi* | [**get_underline_annotation**](docs/PdfApi.md#get_underline_annotation) | **GET** /pdf/\{name}/annotations/underline/\{annotationId} | Read document page underline annotation by ID.
|
252
255
|
*AsposePdfCloud::PdfApi* | [**get_verify_signature**](docs/PdfApi.md#get_verify_signature) | **GET** /pdf/\{name}/verifySignature | Verify signature document.
|
253
256
|
*AsposePdfCloud::PdfApi* | [**get_web_in_storage_to_pdf**](docs/PdfApi.md#get_web_in_storage_to_pdf) | **GET** /pdf/create/web | Convert web page to PDF format and return resulting file in response.
|
@@ -308,6 +311,7 @@ Class | Method | HTTP request | Description
|
|
308
311
|
*AsposePdfCloud::PdfApi* | [**post_sign_document**](docs/PdfApi.md#post_sign_document) | **POST** /pdf/\{name}/sign | Sign document.
|
309
312
|
*AsposePdfCloud::PdfApi* | [**post_sign_page**](docs/PdfApi.md#post_sign_page) | **POST** /pdf/\{name}/pages/\{pageNumber}/sign | Sign page.
|
310
313
|
*AsposePdfCloud::PdfApi* | [**post_split_document**](docs/PdfApi.md#post_split_document) | **POST** /pdf/\{name}/split | Split document to parts.
|
314
|
+
*AsposePdfCloud::PdfApi* | [**post_text_box_fields**](docs/PdfApi.md#post_text_box_fields) | **POST** /pdf/\{name}/fields/textbox | Add document text box fields.
|
311
315
|
*AsposePdfCloud::PdfApi* | [**put_add_new_page**](docs/PdfApi.md#put_add_new_page) | **PUT** /pdf/\{name}/pages | Add new page to end of the document.
|
312
316
|
*AsposePdfCloud::PdfApi* | [**put_add_text**](docs/PdfApi.md#put_add_text) | **PUT** /pdf/\{name}/pages/\{pageNumber}/text | Add text to PDF document page.
|
313
317
|
*AsposePdfCloud::PdfApi* | [**put_annotations_flatten**](docs/PdfApi.md#put_annotations_flatten) | **PUT** /pdf/\{name}/annotations/flatten | Flattens the annotations of the specified types
|
@@ -403,6 +407,7 @@ Class | Method | HTTP request | Description
|
|
403
407
|
*AsposePdfCloud::PdfApi* | [**put_svg_in_storage_to_pdf**](docs/PdfApi.md#put_svg_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/svg | Convert SVG file (located on storage) to PDF format and upload resulting file to storage.
|
404
408
|
*AsposePdfCloud::PdfApi* | [**put_table**](docs/PdfApi.md#put_table) | **PUT** /pdf/\{name}/tables/\{tableId} | Replace document page table.
|
405
409
|
*AsposePdfCloud::PdfApi* | [**put_text_annotation**](docs/PdfApi.md#put_text_annotation) | **PUT** /pdf/\{name}/annotations/text/\{annotationId} | Replace document text annotation
|
410
|
+
*AsposePdfCloud::PdfApi* | [**put_text_box_field**](docs/PdfApi.md#put_text_box_field) | **PUT** /pdf/\{name}/fields/textbox/\{fieldName} | Replace document text box field
|
406
411
|
*AsposePdfCloud::PdfApi* | [**put_underline_annotation**](docs/PdfApi.md#put_underline_annotation) | **PUT** /pdf/\{name}/annotations/underline/\{annotationId} | Replace document underline annotation
|
407
412
|
*AsposePdfCloud::PdfApi* | [**put_update_field**](docs/PdfApi.md#put_update_field) | **PUT** /pdf/\{name}/fields/\{fieldName} | Update field.
|
408
413
|
*AsposePdfCloud::PdfApi* | [**put_update_fields**](docs/PdfApi.md#put_update_fields) | **PUT** /pdf/\{name}/fields | Update fields.
|
@@ -619,6 +624,9 @@ Class | Method | HTTP request | Description
|
|
619
624
|
- [AsposePdfCloud::TextAnnotationResponse](docs/TextAnnotationResponse.md)
|
620
625
|
- [AsposePdfCloud::TextAnnotations](docs/TextAnnotations.md)
|
621
626
|
- [AsposePdfCloud::TextAnnotationsResponse](docs/TextAnnotationsResponse.md)
|
627
|
+
- [AsposePdfCloud::TextBoxFieldResponse](docs/TextBoxFieldResponse.md)
|
628
|
+
- [AsposePdfCloud::TextBoxFields](docs/TextBoxFields.md)
|
629
|
+
- [AsposePdfCloud::TextBoxFieldsResponse](docs/TextBoxFieldsResponse.md)
|
622
630
|
- [AsposePdfCloud::TextRectsResponse](docs/TextRectsResponse.md)
|
623
631
|
- [AsposePdfCloud::TextReplaceResponse](docs/TextReplaceResponse.md)
|
624
632
|
- [AsposePdfCloud::UnderlineAnnotationResponse](docs/UnderlineAnnotationResponse.md)
|
@@ -637,6 +645,7 @@ Class | Method | HTTP request | Description
|
|
637
645
|
- [AsposePdfCloud::RedactionAnnotation](docs/RedactionAnnotation.md)
|
638
646
|
- [AsposePdfCloud::ScreenAnnotation](docs/ScreenAnnotation.md)
|
639
647
|
- [AsposePdfCloud::SignatureField](docs/SignatureField.md)
|
648
|
+
- [AsposePdfCloud::TextBoxField](docs/TextBoxField.md)
|
640
649
|
- [AsposePdfCloud::TextFooter](docs/TextFooter.md)
|
641
650
|
- [AsposePdfCloud::TextHeader](docs/TextHeader.md)
|
642
651
|
- [AsposePdfCloud::TextStamp](docs/TextStamp.md)
|
@@ -10,7 +10,7 @@ Name | Type | Value | Description
|
|
10
10
|
------------ | ------------- | ------------- | -------------
|
11
11
|
**NO_CHANGES** | **String** | 'NoChanges' | No changes to the document are permitted; any change to the document invalidates the signature.
|
12
12
|
**FILLING_IN_FORMS** | **String** | 'FillingInForms' | Permitted changes are filling in forms, instantiating page templates, and signing; other changes invalidate the signature.
|
13
|
-
**ANNOTATION_MODIFICATION** | **String** | 'AnnotationModification' | Permitted changes are the same as for
|
13
|
+
**ANNOTATION_MODIFICATION** | **String** | 'AnnotationModification' | Permitted changes are the same as for FillingInForms, as well as annotation creation, deletion, and modification; other changes invalidate the signature.
|
14
14
|
|
15
15
|
|
16
16
|
|
data/docs/PdfApi.md
CHANGED
@@ -64,6 +64,7 @@ Method | HTTP request | Description
|
|
64
64
|
[**get_document_strike_out_annotations**](PdfApi.md#get_document_strike_out_annotations) | **GET** /pdf/\{name}/annotations/strikeout | Read document StrikeOut annotations.
|
65
65
|
[**get_document_tables**](PdfApi.md#get_document_tables) | **GET** /pdf/\{name}/tables | Read document tables.
|
66
66
|
[**get_document_text_annotations**](PdfApi.md#get_document_text_annotations) | **GET** /pdf/\{name}/annotations/text | Read document text annotations.
|
67
|
+
[**get_document_text_box_fields**](PdfApi.md#get_document_text_box_fields) | **GET** /pdf/\{name}/fields/textbox | Read document text box fields.
|
67
68
|
[**get_document_underline_annotations**](PdfApi.md#get_document_underline_annotations) | **GET** /pdf/\{name}/annotations/underline | Read document underline annotations.
|
68
69
|
[**get_download_document_attachment_by_index**](PdfApi.md#get_download_document_attachment_by_index) | **GET** /pdf/\{name}/attachments/\{attachmentIndex}/download | Download document attachment content by its index.
|
69
70
|
[**get_epub_in_storage_to_pdf**](PdfApi.md#get_epub_in_storage_to_pdf) | **GET** /pdf/create/epub | Convert EPUB file (located on storage) to PDF format and return resulting file in response.
|
@@ -128,6 +129,7 @@ Method | HTTP request | Description
|
|
128
129
|
[**get_page_tables**](PdfApi.md#get_page_tables) | **GET** /pdf/\{name}/pages/\{pageNumber}/tables | Read document page tables.
|
129
130
|
[**get_page_text**](PdfApi.md#get_page_text) | **GET** /pdf/\{name}/pages/\{pageNumber}/text | Read page text items.
|
130
131
|
[**get_page_text_annotations**](PdfApi.md#get_page_text_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/text | Read document page text annotations.
|
132
|
+
[**get_page_text_box_fields**](PdfApi.md#get_page_text_box_fields) | **GET** /pdf/\{name}/page/\{pageNumber}/fields/textbox | Read document page text box fields.
|
131
133
|
[**get_page_underline_annotations**](PdfApi.md#get_page_underline_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/underline | Read document page underline annotations.
|
132
134
|
[**get_pages**](PdfApi.md#get_pages) | **GET** /pdf/\{name}/pages | Read document pages info.
|
133
135
|
[**get_pcl_in_storage_to_pdf**](PdfApi.md#get_pcl_in_storage_to_pdf) | **GET** /pdf/create/pcl | Convert PCL file (located on storage) to PDF format and return resulting file in response.
|
@@ -163,6 +165,7 @@ Method | HTTP request | Description
|
|
163
165
|
[**get_table**](PdfApi.md#get_table) | **GET** /pdf/\{name}/tables/\{tableId} | Read document page table by ID.
|
164
166
|
[**get_text**](PdfApi.md#get_text) | **GET** /pdf/\{name}/text | Read document text.
|
165
167
|
[**get_text_annotation**](PdfApi.md#get_text_annotation) | **GET** /pdf/\{name}/annotations/text/\{annotationId} | Read document page text annotation by ID.
|
168
|
+
[**get_text_box_field**](PdfApi.md#get_text_box_field) | **GET** /pdf/\{name}/fields/textbox/\{fieldName} | Read document text box field by name.
|
166
169
|
[**get_underline_annotation**](PdfApi.md#get_underline_annotation) | **GET** /pdf/\{name}/annotations/underline/\{annotationId} | Read document page underline annotation by ID.
|
167
170
|
[**get_verify_signature**](PdfApi.md#get_verify_signature) | **GET** /pdf/\{name}/verifySignature | Verify signature document.
|
168
171
|
[**get_web_in_storage_to_pdf**](PdfApi.md#get_web_in_storage_to_pdf) | **GET** /pdf/create/web | Convert web page to PDF format and return resulting file in response.
|
@@ -223,6 +226,7 @@ Method | HTTP request | Description
|
|
223
226
|
[**post_sign_document**](PdfApi.md#post_sign_document) | **POST** /pdf/\{name}/sign | Sign document.
|
224
227
|
[**post_sign_page**](PdfApi.md#post_sign_page) | **POST** /pdf/\{name}/pages/\{pageNumber}/sign | Sign page.
|
225
228
|
[**post_split_document**](PdfApi.md#post_split_document) | **POST** /pdf/\{name}/split | Split document to parts.
|
229
|
+
[**post_text_box_fields**](PdfApi.md#post_text_box_fields) | **POST** /pdf/\{name}/fields/textbox | Add document text box fields.
|
226
230
|
[**put_add_new_page**](PdfApi.md#put_add_new_page) | **PUT** /pdf/\{name}/pages | Add new page to end of the document.
|
227
231
|
[**put_add_text**](PdfApi.md#put_add_text) | **PUT** /pdf/\{name}/pages/\{pageNumber}/text | Add text to PDF document page.
|
228
232
|
[**put_annotations_flatten**](PdfApi.md#put_annotations_flatten) | **PUT** /pdf/\{name}/annotations/flatten | Flattens the annotations of the specified types
|
@@ -318,6 +322,7 @@ Method | HTTP request | Description
|
|
318
322
|
[**put_svg_in_storage_to_pdf**](PdfApi.md#put_svg_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/svg | Convert SVG file (located on storage) to PDF format and upload resulting file to storage.
|
319
323
|
[**put_table**](PdfApi.md#put_table) | **PUT** /pdf/\{name}/tables/\{tableId} | Replace document page table.
|
320
324
|
[**put_text_annotation**](PdfApi.md#put_text_annotation) | **PUT** /pdf/\{name}/annotations/text/\{annotationId} | Replace document text annotation
|
325
|
+
[**put_text_box_field**](PdfApi.md#put_text_box_field) | **PUT** /pdf/\{name}/fields/textbox/\{fieldName} | Replace document text box field
|
321
326
|
[**put_underline_annotation**](PdfApi.md#put_underline_annotation) | **PUT** /pdf/\{name}/annotations/underline/\{annotationId} | Replace document underline annotation
|
322
327
|
[**put_update_field**](PdfApi.md#put_update_field) | **PUT** /pdf/\{name}/fields/\{fieldName} | Update field.
|
323
328
|
[**put_update_fields**](PdfApi.md#put_update_fields) | **PUT** /pdf/\{name}/fields | Update fields.
|
@@ -1791,6 +1796,30 @@ Name | Type | Description | Notes
|
|
1791
1796
|
|
1792
1797
|
|
1793
1798
|
|
1799
|
+
# **get_document_text_box_fields**
|
1800
|
+
> TextBoxFieldsResponse get_document_text_box_fields(name, opts)
|
1801
|
+
|
1802
|
+
Read document text box fields.
|
1803
|
+
|
1804
|
+
### Parameters
|
1805
|
+
|
1806
|
+
Name | Type | Description | Notes
|
1807
|
+
------------- | ------------- | ------------- | -------------
|
1808
|
+
**name** | **String**| The document name. |
|
1809
|
+
**storage** | **String**| The document storage. | [optional]
|
1810
|
+
**folder** | **String**| The document folder. | [optional]
|
1811
|
+
|
1812
|
+
### Return type
|
1813
|
+
|
1814
|
+
[**TextBoxFieldsResponse**](TextBoxFieldsResponse.md)
|
1815
|
+
|
1816
|
+
### HTTP request headers
|
1817
|
+
|
1818
|
+
- **Content-Type**: application/json
|
1819
|
+
- **Accept**: application/json
|
1820
|
+
|
1821
|
+
|
1822
|
+
|
1794
1823
|
# **get_document_underline_annotations**
|
1795
1824
|
> UnderlineAnnotationsResponse get_document_underline_annotations(name, opts)
|
1796
1825
|
|
@@ -3408,6 +3437,31 @@ Name | Type | Description | Notes
|
|
3408
3437
|
|
3409
3438
|
|
3410
3439
|
|
3440
|
+
# **get_page_text_box_fields**
|
3441
|
+
> TextBoxFieldsResponse get_page_text_box_fields(name, page_number, opts)
|
3442
|
+
|
3443
|
+
Read document page text box fields.
|
3444
|
+
|
3445
|
+
### Parameters
|
3446
|
+
|
3447
|
+
Name | Type | Description | Notes
|
3448
|
+
------------- | ------------- | ------------- | -------------
|
3449
|
+
**name** | **String**| The document name. |
|
3450
|
+
**page_number** | **Integer**| The page number. |
|
3451
|
+
**storage** | **String**| The document storage. | [optional]
|
3452
|
+
**folder** | **String**| The document folder. | [optional]
|
3453
|
+
|
3454
|
+
### Return type
|
3455
|
+
|
3456
|
+
[**TextBoxFieldsResponse**](TextBoxFieldsResponse.md)
|
3457
|
+
|
3458
|
+
### HTTP request headers
|
3459
|
+
|
3460
|
+
- **Content-Type**: application/json
|
3461
|
+
- **Accept**: application/json
|
3462
|
+
|
3463
|
+
|
3464
|
+
|
3411
3465
|
# **get_page_underline_annotations**
|
3412
3466
|
> UnderlineAnnotationsResponse get_page_underline_annotations(name, page_number, opts)
|
3413
3467
|
|
@@ -4342,6 +4396,31 @@ Name | Type | Description | Notes
|
|
4342
4396
|
|
4343
4397
|
|
4344
4398
|
|
4399
|
+
# **get_text_box_field**
|
4400
|
+
> TextBoxFieldResponse get_text_box_field(name, field_name, opts)
|
4401
|
+
|
4402
|
+
Read document text box field by name.
|
4403
|
+
|
4404
|
+
### Parameters
|
4405
|
+
|
4406
|
+
Name | Type | Description | Notes
|
4407
|
+
------------- | ------------- | ------------- | -------------
|
4408
|
+
**name** | **String**| The document name. |
|
4409
|
+
**field_name** | **String**| The field name. |
|
4410
|
+
**storage** | **String**| The document storage. | [optional]
|
4411
|
+
**folder** | **String**| The document folder. | [optional]
|
4412
|
+
|
4413
|
+
### Return type
|
4414
|
+
|
4415
|
+
[**TextBoxFieldResponse**](TextBoxFieldResponse.md)
|
4416
|
+
|
4417
|
+
### HTTP request headers
|
4418
|
+
|
4419
|
+
- **Content-Type**: application/json
|
4420
|
+
- **Accept**: application/json
|
4421
|
+
|
4422
|
+
|
4423
|
+
|
4345
4424
|
# **get_underline_annotation**
|
4346
4425
|
> UnderlineAnnotationResponse get_underline_annotation(name, annotation_id, opts)
|
4347
4426
|
|
@@ -5900,6 +5979,31 @@ Name | Type | Description | Notes
|
|
5900
5979
|
|
5901
5980
|
|
5902
5981
|
|
5982
|
+
# **post_text_box_fields**
|
5983
|
+
> AsposeResponse post_text_box_fields(name, fields, opts)
|
5984
|
+
|
5985
|
+
Add document text box fields.
|
5986
|
+
|
5987
|
+
### Parameters
|
5988
|
+
|
5989
|
+
Name | Type | Description | Notes
|
5990
|
+
------------- | ------------- | ------------- | -------------
|
5991
|
+
**name** | **String**| The document name. |
|
5992
|
+
**fields** | [**Array<TextBoxField>**](TextBoxField.md)| The array of field. |
|
5993
|
+
**storage** | **String**| The document storage. | [optional]
|
5994
|
+
**folder** | **String**| The document folder. | [optional]
|
5995
|
+
|
5996
|
+
### Return type
|
5997
|
+
|
5998
|
+
[**AsposeResponse**](AsposeResponse.md)
|
5999
|
+
|
6000
|
+
### HTTP request headers
|
6001
|
+
|
6002
|
+
- **Content-Type**: application/json
|
6003
|
+
- **Accept**: application/json
|
6004
|
+
|
6005
|
+
|
6006
|
+
|
5903
6007
|
# **put_add_new_page**
|
5904
6008
|
> DocumentPagesResponse put_add_new_page(name, opts)
|
5905
6009
|
|
@@ -8484,6 +8588,32 @@ Name | Type | Description | Notes
|
|
8484
8588
|
|
8485
8589
|
|
8486
8590
|
|
8591
|
+
# **put_text_box_field**
|
8592
|
+
> TextBoxFieldResponse put_text_box_field(name, field_name, field, opts)
|
8593
|
+
|
8594
|
+
Replace document text box field
|
8595
|
+
|
8596
|
+
### Parameters
|
8597
|
+
|
8598
|
+
Name | Type | Description | Notes
|
8599
|
+
------------- | ------------- | ------------- | -------------
|
8600
|
+
**name** | **String**| The document name. |
|
8601
|
+
**field_name** | **String**| The field name. |
|
8602
|
+
**field** | [**TextBoxField**](TextBoxField.md)| The field. |
|
8603
|
+
**storage** | **String**| The document storage. | [optional]
|
8604
|
+
**folder** | **String**| The document folder. | [optional]
|
8605
|
+
|
8606
|
+
### Return type
|
8607
|
+
|
8608
|
+
[**TextBoxFieldResponse**](TextBoxFieldResponse.md)
|
8609
|
+
|
8610
|
+
### HTTP request headers
|
8611
|
+
|
8612
|
+
- **Content-Type**: application/json
|
8613
|
+
- **Accept**: application/json
|
8614
|
+
|
8615
|
+
|
8616
|
+
|
8487
8617
|
# **put_underline_annotation**
|
8488
8618
|
> UnderlineAnnotationResponse put_underline_annotation(name, annotation_id, annotation, opts)
|
8489
8619
|
|
@@ -0,0 +1,32 @@
|
|
1
|
+
# AsposePdfCloud::TextBoxField
|
2
|
+
Provides TextBoxField.
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional]
|
8
|
+
**partial_name** | **String** | Field name. | [optional]
|
9
|
+
**rect** | [**Rectangle**](Rectangle.md) | Field rectangle. | [optional]
|
10
|
+
**value** | **String** | Field value. | [optional]
|
11
|
+
**page_index** | **Integer** | Page index. |
|
12
|
+
**height** | **Float** | Gets or sets height of the field. | [optional]
|
13
|
+
**width** | **Float** | Gets or sets width of the field. | [optional]
|
14
|
+
**z_index** | **Integer** | Z index. | [optional]
|
15
|
+
**is_group** | **BOOLEAN** | Is group. |
|
16
|
+
**parent** | [**FormField**](FormField.md) | Gets field parent. | [optional]
|
17
|
+
**is_shared_field** | **BOOLEAN** | Property for Generator support. Used when field is added to header or footer. If true, this field will created once and it's appearance will be visible on all pages of the document. If false, separated field will be created for every document page. | [optional]
|
18
|
+
**flags** | [**Array<AnnotationFlags>**](AnnotationFlags.md) | Gets Flags of the field. | [optional]
|
19
|
+
**color** | [**Color**](Color.md) | Color of the annotation. | [optional]
|
20
|
+
**contents** | **String** | Get the field content. | [optional]
|
21
|
+
**margin** | [**MarginInfo**](MarginInfo.md) | Gets or sets a outer margin for paragraph (for pdf generation) | [optional]
|
22
|
+
**highlighting** | [**LinkHighlightingMode**](LinkHighlightingMode.md) | Field highlighting mode. | [optional]
|
23
|
+
**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the field. | [optional]
|
24
|
+
**vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the field. | [optional]
|
25
|
+
**multiline** | **BOOLEAN** | Gets or sets multiline flag of the field. If Multiline is true field can contain multiple lines of text. | [optional]
|
26
|
+
**spell_check** | **BOOLEAN** | Gets or sets spellcheck flag for field. If true field shall be spell checked. | [optional]
|
27
|
+
**scrollable** | **BOOLEAN** | Gets or sets scrollable flag of field. If true field can be scrolled. | [optional]
|
28
|
+
**force_combs** | **BOOLEAN** | Gets or sets flag which indicates is field divided into spaced positions. | [optional]
|
29
|
+
**max_len** | **Integer** | Gets or sets maximum length of text in the field. | [optional]
|
30
|
+
**barcode** | **String** | Adds barcode 128 into the field. Field value will be changed onto the code and field become read only. | [optional]
|
31
|
+
|
32
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# AsposePdfCloud::TextBoxFieldResponse
|
2
|
+
Represents response containing single text box field object
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**code** | **Integer** | Response status code. |
|
8
|
+
**status** | **String** | Response status. | [optional]
|
9
|
+
**field** | [**TextBoxField**](TextBoxField.md) | Text box field object | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# AsposePdfCloud::TextBoxFields
|
2
|
+
Object representing a list of text box fields.
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional]
|
8
|
+
**list** | [**Array<TextBoxField>**](TextBoxField.md) | List of text box fields. | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# AsposePdfCloud::TextBoxFieldsResponse
|
2
|
+
Represents response containing multiple text box field objects
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**code** | **Integer** | Response status code. |
|
8
|
+
**status** | **String** | Response status. | [optional]
|
9
|
+
**fields** | [**TextBoxFields**](TextBoxFields.md) | Text box fields object | [optional]
|
10
|
+
|
11
|
+
|
data/lib/aspose_pdf_cloud.rb
CHANGED
@@ -227,6 +227,9 @@ require_relative 'aspose_pdf_cloud/models/tables_recognized_response'
|
|
227
227
|
require_relative 'aspose_pdf_cloud/models/text_annotation_response'
|
228
228
|
require_relative 'aspose_pdf_cloud/models/text_annotations'
|
229
229
|
require_relative 'aspose_pdf_cloud/models/text_annotations_response'
|
230
|
+
require_relative 'aspose_pdf_cloud/models/text_box_field_response'
|
231
|
+
require_relative 'aspose_pdf_cloud/models/text_box_fields'
|
232
|
+
require_relative 'aspose_pdf_cloud/models/text_box_fields_response'
|
230
233
|
require_relative 'aspose_pdf_cloud/models/text_rects_response'
|
231
234
|
require_relative 'aspose_pdf_cloud/models/text_replace_response'
|
232
235
|
require_relative 'aspose_pdf_cloud/models/underline_annotation_response'
|
@@ -245,6 +248,7 @@ require_relative 'aspose_pdf_cloud/models/popup_annotation'
|
|
245
248
|
require_relative 'aspose_pdf_cloud/models/redaction_annotation'
|
246
249
|
require_relative 'aspose_pdf_cloud/models/screen_annotation'
|
247
250
|
require_relative 'aspose_pdf_cloud/models/signature_field'
|
251
|
+
require_relative 'aspose_pdf_cloud/models/text_box_field'
|
248
252
|
require_relative 'aspose_pdf_cloud/models/text_footer'
|
249
253
|
require_relative 'aspose_pdf_cloud/models/text_header'
|
250
254
|
require_relative 'aspose_pdf_cloud/models/text_stamp'
|
@@ -4472,6 +4472,78 @@ module AsposePdfCloud
|
|
4472
4472
|
return data, status_code, headers
|
4473
4473
|
end
|
4474
4474
|
|
4475
|
+
# Read document text box fields.
|
4476
|
+
#
|
4477
|
+
# @param name The document name.
|
4478
|
+
# @param [Hash] opts the optional parameters
|
4479
|
+
# @option opts [String] :storage The document storage.
|
4480
|
+
# @option opts [String] :folder The document folder.
|
4481
|
+
# @return [TextBoxFieldsResponse]
|
4482
|
+
def get_document_text_box_fields(name, opts = {})
|
4483
|
+
@api_client.request_token_if_needed
|
4484
|
+
data, _status_code, _headers = get_document_text_box_fields_with_http_info(name, opts)
|
4485
|
+
rescue ApiError => error
|
4486
|
+
if error.code == 401
|
4487
|
+
@api_client.request_token_if_needed
|
4488
|
+
data, _status_code, _headers = get_document_text_box_fields_with_http_info(name, opts)
|
4489
|
+
else
|
4490
|
+
raise
|
4491
|
+
end
|
4492
|
+
return data
|
4493
|
+
end
|
4494
|
+
|
4495
|
+
# Read document text box fields.
|
4496
|
+
#
|
4497
|
+
# @param name The document name.
|
4498
|
+
# @param [Hash] opts the optional parameters
|
4499
|
+
# @option opts [String] :storage The document storage.
|
4500
|
+
# @option opts [String] :folder The document folder.
|
4501
|
+
# @return [Array<(TextBoxFieldsResponse, Fixnum, Hash)>] TextBoxFieldsResponse data, response status code and response headers
|
4502
|
+
def get_document_text_box_fields_with_http_info(name, opts = {})
|
4503
|
+
if @api_client.config.debugging
|
4504
|
+
@api_client.config.logger.debug "Calling API: PdfApi.get_document_text_box_fields ..."
|
4505
|
+
end
|
4506
|
+
# verify the required parameter 'name' is set
|
4507
|
+
if @api_client.config.client_side_validation && name.nil?
|
4508
|
+
fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_text_box_fields"
|
4509
|
+
end
|
4510
|
+
# resource path
|
4511
|
+
local_var_path = "/pdf/{name}/fields/textbox".sub('{' + 'name' + '}', name.to_s)
|
4512
|
+
|
4513
|
+
# query parameters
|
4514
|
+
query_params = {}
|
4515
|
+
query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
|
4516
|
+
query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
|
4517
|
+
|
4518
|
+
# header parameters
|
4519
|
+
header_params = {}
|
4520
|
+
# HTTP header 'Accept' (if needed)
|
4521
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
4522
|
+
# HTTP header 'Content-Type'
|
4523
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
4524
|
+
|
4525
|
+
# form parameters
|
4526
|
+
form_params = {}
|
4527
|
+
# Fix header in file
|
4528
|
+
post_body = nil
|
4529
|
+
|
4530
|
+
# http body (model)
|
4531
|
+
# Fix header in file
|
4532
|
+
# post_body = nil
|
4533
|
+
auth_names = ['JWT']
|
4534
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
4535
|
+
:header_params => header_params,
|
4536
|
+
:query_params => query_params,
|
4537
|
+
:form_params => form_params,
|
4538
|
+
:body => post_body,
|
4539
|
+
:auth_names => auth_names,
|
4540
|
+
:return_type => 'TextBoxFieldsResponse')
|
4541
|
+
if @api_client.config.debugging
|
4542
|
+
@api_client.config.logger.debug "API called: PdfApi#get_document_text_box_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4543
|
+
end
|
4544
|
+
return data, status_code, headers
|
4545
|
+
end
|
4546
|
+
|
4475
4547
|
# Read document underline annotations.
|
4476
4548
|
#
|
4477
4549
|
# @param name The document name.
|
@@ -9506,6 +9578,84 @@ module AsposePdfCloud
|
|
9506
9578
|
return data, status_code, headers
|
9507
9579
|
end
|
9508
9580
|
|
9581
|
+
# Read document page text box fields.
|
9582
|
+
#
|
9583
|
+
# @param name The document name.
|
9584
|
+
# @param page_number The page number.
|
9585
|
+
# @param [Hash] opts the optional parameters
|
9586
|
+
# @option opts [String] :storage The document storage.
|
9587
|
+
# @option opts [String] :folder The document folder.
|
9588
|
+
# @return [TextBoxFieldsResponse]
|
9589
|
+
def get_page_text_box_fields(name, page_number, opts = {})
|
9590
|
+
@api_client.request_token_if_needed
|
9591
|
+
data, _status_code, _headers = get_page_text_box_fields_with_http_info(name, page_number, opts)
|
9592
|
+
rescue ApiError => error
|
9593
|
+
if error.code == 401
|
9594
|
+
@api_client.request_token_if_needed
|
9595
|
+
data, _status_code, _headers = get_page_text_box_fields_with_http_info(name, page_number, opts)
|
9596
|
+
else
|
9597
|
+
raise
|
9598
|
+
end
|
9599
|
+
return data
|
9600
|
+
end
|
9601
|
+
|
9602
|
+
# Read document page text box fields.
|
9603
|
+
#
|
9604
|
+
# @param name The document name.
|
9605
|
+
# @param page_number The page number.
|
9606
|
+
# @param [Hash] opts the optional parameters
|
9607
|
+
# @option opts [String] :storage The document storage.
|
9608
|
+
# @option opts [String] :folder The document folder.
|
9609
|
+
# @return [Array<(TextBoxFieldsResponse, Fixnum, Hash)>] TextBoxFieldsResponse data, response status code and response headers
|
9610
|
+
def get_page_text_box_fields_with_http_info(name, page_number, opts = {})
|
9611
|
+
if @api_client.config.debugging
|
9612
|
+
@api_client.config.logger.debug "Calling API: PdfApi.get_page_text_box_fields ..."
|
9613
|
+
end
|
9614
|
+
# verify the required parameter 'name' is set
|
9615
|
+
if @api_client.config.client_side_validation && name.nil?
|
9616
|
+
fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_text_box_fields"
|
9617
|
+
end
|
9618
|
+
# verify the required parameter 'page_number' is set
|
9619
|
+
if @api_client.config.client_side_validation && page_number.nil?
|
9620
|
+
fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_text_box_fields"
|
9621
|
+
end
|
9622
|
+
# resource path
|
9623
|
+
local_var_path = "/pdf/{name}/page/{pageNumber}/fields/textbox".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)
|
9624
|
+
|
9625
|
+
# query parameters
|
9626
|
+
query_params = {}
|
9627
|
+
query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
|
9628
|
+
query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
|
9629
|
+
|
9630
|
+
# header parameters
|
9631
|
+
header_params = {}
|
9632
|
+
# HTTP header 'Accept' (if needed)
|
9633
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
9634
|
+
# HTTP header 'Content-Type'
|
9635
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
9636
|
+
|
9637
|
+
# form parameters
|
9638
|
+
form_params = {}
|
9639
|
+
# Fix header in file
|
9640
|
+
post_body = nil
|
9641
|
+
|
9642
|
+
# http body (model)
|
9643
|
+
# Fix header in file
|
9644
|
+
# post_body = nil
|
9645
|
+
auth_names = ['JWT']
|
9646
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
9647
|
+
:header_params => header_params,
|
9648
|
+
:query_params => query_params,
|
9649
|
+
:form_params => form_params,
|
9650
|
+
:body => post_body,
|
9651
|
+
:auth_names => auth_names,
|
9652
|
+
:return_type => 'TextBoxFieldsResponse')
|
9653
|
+
if @api_client.config.debugging
|
9654
|
+
@api_client.config.logger.debug "API called: PdfApi#get_page_text_box_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
9655
|
+
end
|
9656
|
+
return data, status_code, headers
|
9657
|
+
end
|
9658
|
+
|
9509
9659
|
# Read document page underline annotations.
|
9510
9660
|
#
|
9511
9661
|
# @param name The document name.
|
@@ -12428,6 +12578,84 @@ module AsposePdfCloud
|
|
12428
12578
|
return data, status_code, headers
|
12429
12579
|
end
|
12430
12580
|
|
12581
|
+
# Read document text box field by name.
|
12582
|
+
#
|
12583
|
+
# @param name The document name.
|
12584
|
+
# @param field_name The field name.
|
12585
|
+
# @param [Hash] opts the optional parameters
|
12586
|
+
# @option opts [String] :storage The document storage.
|
12587
|
+
# @option opts [String] :folder The document folder.
|
12588
|
+
# @return [TextBoxFieldResponse]
|
12589
|
+
def get_text_box_field(name, field_name, opts = {})
|
12590
|
+
@api_client.request_token_if_needed
|
12591
|
+
data, _status_code, _headers = get_text_box_field_with_http_info(name, field_name, opts)
|
12592
|
+
rescue ApiError => error
|
12593
|
+
if error.code == 401
|
12594
|
+
@api_client.request_token_if_needed
|
12595
|
+
data, _status_code, _headers = get_text_box_field_with_http_info(name, field_name, opts)
|
12596
|
+
else
|
12597
|
+
raise
|
12598
|
+
end
|
12599
|
+
return data
|
12600
|
+
end
|
12601
|
+
|
12602
|
+
# Read document text box field by name.
|
12603
|
+
#
|
12604
|
+
# @param name The document name.
|
12605
|
+
# @param field_name The field name.
|
12606
|
+
# @param [Hash] opts the optional parameters
|
12607
|
+
# @option opts [String] :storage The document storage.
|
12608
|
+
# @option opts [String] :folder The document folder.
|
12609
|
+
# @return [Array<(TextBoxFieldResponse, Fixnum, Hash)>] TextBoxFieldResponse data, response status code and response headers
|
12610
|
+
def get_text_box_field_with_http_info(name, field_name, opts = {})
|
12611
|
+
if @api_client.config.debugging
|
12612
|
+
@api_client.config.logger.debug "Calling API: PdfApi.get_text_box_field ..."
|
12613
|
+
end
|
12614
|
+
# verify the required parameter 'name' is set
|
12615
|
+
if @api_client.config.client_side_validation && name.nil?
|
12616
|
+
fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_text_box_field"
|
12617
|
+
end
|
12618
|
+
# verify the required parameter 'field_name' is set
|
12619
|
+
if @api_client.config.client_side_validation && field_name.nil?
|
12620
|
+
fail ArgumentError, "Missing the required parameter 'field_name' when calling PdfApi.get_text_box_field"
|
12621
|
+
end
|
12622
|
+
# resource path
|
12623
|
+
local_var_path = "/pdf/{name}/fields/textbox/{fieldName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'fieldName' + '}', field_name.to_s)
|
12624
|
+
|
12625
|
+
# query parameters
|
12626
|
+
query_params = {}
|
12627
|
+
query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
|
12628
|
+
query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
|
12629
|
+
|
12630
|
+
# header parameters
|
12631
|
+
header_params = {}
|
12632
|
+
# HTTP header 'Accept' (if needed)
|
12633
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
12634
|
+
# HTTP header 'Content-Type'
|
12635
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
12636
|
+
|
12637
|
+
# form parameters
|
12638
|
+
form_params = {}
|
12639
|
+
# Fix header in file
|
12640
|
+
post_body = nil
|
12641
|
+
|
12642
|
+
# http body (model)
|
12643
|
+
# Fix header in file
|
12644
|
+
# post_body = nil
|
12645
|
+
auth_names = ['JWT']
|
12646
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
12647
|
+
:header_params => header_params,
|
12648
|
+
:query_params => query_params,
|
12649
|
+
:form_params => form_params,
|
12650
|
+
:body => post_body,
|
12651
|
+
:auth_names => auth_names,
|
12652
|
+
:return_type => 'TextBoxFieldResponse')
|
12653
|
+
if @api_client.config.debugging
|
12654
|
+
@api_client.config.logger.debug "API called: PdfApi#get_text_box_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
12655
|
+
end
|
12656
|
+
return data, status_code, headers
|
12657
|
+
end
|
12658
|
+
|
12431
12659
|
# Read document page underline annotation by ID.
|
12432
12660
|
#
|
12433
12661
|
# @param name The document name.
|
@@ -17360,6 +17588,83 @@ module AsposePdfCloud
|
|
17360
17588
|
return data, status_code, headers
|
17361
17589
|
end
|
17362
17590
|
|
17591
|
+
# Add document text box fields.
|
17592
|
+
#
|
17593
|
+
# @param name The document name.
|
17594
|
+
# @param fields The array of field.
|
17595
|
+
# @param [Hash] opts the optional parameters
|
17596
|
+
# @option opts [String] :storage The document storage.
|
17597
|
+
# @option opts [String] :folder The document folder.
|
17598
|
+
# @return [AsposeResponse]
|
17599
|
+
def post_text_box_fields(name, fields, opts = {})
|
17600
|
+
@api_client.request_token_if_needed
|
17601
|
+
data, _status_code, _headers = post_text_box_fields_with_http_info(name, fields, opts)
|
17602
|
+
rescue ApiError => error
|
17603
|
+
if error.code == 401
|
17604
|
+
@api_client.request_token_if_needed
|
17605
|
+
data, _status_code, _headers = post_text_box_fields_with_http_info(name, fields, opts)
|
17606
|
+
else
|
17607
|
+
raise
|
17608
|
+
end
|
17609
|
+
return data
|
17610
|
+
end
|
17611
|
+
|
17612
|
+
# Add document text box fields.
|
17613
|
+
#
|
17614
|
+
# @param name The document name.
|
17615
|
+
# @param fields The array of field.
|
17616
|
+
# @param [Hash] opts the optional parameters
|
17617
|
+
# @option opts [String] :storage The document storage.
|
17618
|
+
# @option opts [String] :folder The document folder.
|
17619
|
+
# @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
|
17620
|
+
def post_text_box_fields_with_http_info(name, fields, opts = {})
|
17621
|
+
if @api_client.config.debugging
|
17622
|
+
@api_client.config.logger.debug "Calling API: PdfApi.post_text_box_fields ..."
|
17623
|
+
end
|
17624
|
+
# verify the required parameter 'name' is set
|
17625
|
+
if @api_client.config.client_side_validation && name.nil?
|
17626
|
+
fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_text_box_fields"
|
17627
|
+
end
|
17628
|
+
# verify the required parameter 'fields' is set
|
17629
|
+
if @api_client.config.client_side_validation && fields.nil?
|
17630
|
+
fail ArgumentError, "Missing the required parameter 'fields' when calling PdfApi.post_text_box_fields"
|
17631
|
+
end
|
17632
|
+
# resource path
|
17633
|
+
local_var_path = "/pdf/{name}/fields/textbox".sub('{' + 'name' + '}', name.to_s)
|
17634
|
+
|
17635
|
+
# query parameters
|
17636
|
+
query_params = {}
|
17637
|
+
query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
|
17638
|
+
query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
|
17639
|
+
|
17640
|
+
# header parameters
|
17641
|
+
header_params = {}
|
17642
|
+
# HTTP header 'Accept' (if needed)
|
17643
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
17644
|
+
# HTTP header 'Content-Type'
|
17645
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
17646
|
+
|
17647
|
+
# form parameters
|
17648
|
+
form_params = {}
|
17649
|
+
# Fix header in file
|
17650
|
+
post_body = nil
|
17651
|
+
|
17652
|
+
# http body (model)
|
17653
|
+
post_body = @api_client.object_to_http_body(fields)
|
17654
|
+
auth_names = ['JWT']
|
17655
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
17656
|
+
:header_params => header_params,
|
17657
|
+
:query_params => query_params,
|
17658
|
+
:form_params => form_params,
|
17659
|
+
:body => post_body,
|
17660
|
+
:auth_names => auth_names,
|
17661
|
+
:return_type => 'AsposeResponse')
|
17662
|
+
if @api_client.config.debugging
|
17663
|
+
@api_client.config.logger.debug "API called: PdfApi#post_text_box_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
17664
|
+
end
|
17665
|
+
return data, status_code, headers
|
17666
|
+
end
|
17667
|
+
|
17363
17668
|
# Add new page to end of the document.
|
17364
17669
|
#
|
17365
17670
|
# @param name The document name.
|
@@ -25611,6 +25916,89 @@ module AsposePdfCloud
|
|
25611
25916
|
return data, status_code, headers
|
25612
25917
|
end
|
25613
25918
|
|
25919
|
+
# Replace document text box field
|
25920
|
+
#
|
25921
|
+
# @param name The document name.
|
25922
|
+
# @param field_name The field name.
|
25923
|
+
# @param field The field.
|
25924
|
+
# @param [Hash] opts the optional parameters
|
25925
|
+
# @option opts [String] :storage The document storage.
|
25926
|
+
# @option opts [String] :folder The document folder.
|
25927
|
+
# @return [TextBoxFieldResponse]
|
25928
|
+
def put_text_box_field(name, field_name, field, opts = {})
|
25929
|
+
@api_client.request_token_if_needed
|
25930
|
+
data, _status_code, _headers = put_text_box_field_with_http_info(name, field_name, field, opts)
|
25931
|
+
rescue ApiError => error
|
25932
|
+
if error.code == 401
|
25933
|
+
@api_client.request_token_if_needed
|
25934
|
+
data, _status_code, _headers = put_text_box_field_with_http_info(name, field_name, field, opts)
|
25935
|
+
else
|
25936
|
+
raise
|
25937
|
+
end
|
25938
|
+
return data
|
25939
|
+
end
|
25940
|
+
|
25941
|
+
# Replace document text box field
|
25942
|
+
#
|
25943
|
+
# @param name The document name.
|
25944
|
+
# @param field_name The field name.
|
25945
|
+
# @param field The field.
|
25946
|
+
# @param [Hash] opts the optional parameters
|
25947
|
+
# @option opts [String] :storage The document storage.
|
25948
|
+
# @option opts [String] :folder The document folder.
|
25949
|
+
# @return [Array<(TextBoxFieldResponse, Fixnum, Hash)>] TextBoxFieldResponse data, response status code and response headers
|
25950
|
+
def put_text_box_field_with_http_info(name, field_name, field, opts = {})
|
25951
|
+
if @api_client.config.debugging
|
25952
|
+
@api_client.config.logger.debug "Calling API: PdfApi.put_text_box_field ..."
|
25953
|
+
end
|
25954
|
+
# verify the required parameter 'name' is set
|
25955
|
+
if @api_client.config.client_side_validation && name.nil?
|
25956
|
+
fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_text_box_field"
|
25957
|
+
end
|
25958
|
+
# verify the required parameter 'field_name' is set
|
25959
|
+
if @api_client.config.client_side_validation && field_name.nil?
|
25960
|
+
fail ArgumentError, "Missing the required parameter 'field_name' when calling PdfApi.put_text_box_field"
|
25961
|
+
end
|
25962
|
+
# verify the required parameter 'field' is set
|
25963
|
+
if @api_client.config.client_side_validation && field.nil?
|
25964
|
+
fail ArgumentError, "Missing the required parameter 'field' when calling PdfApi.put_text_box_field"
|
25965
|
+
end
|
25966
|
+
# resource path
|
25967
|
+
local_var_path = "/pdf/{name}/fields/textbox/{fieldName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'fieldName' + '}', field_name.to_s)
|
25968
|
+
|
25969
|
+
# query parameters
|
25970
|
+
query_params = {}
|
25971
|
+
query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
|
25972
|
+
query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
|
25973
|
+
|
25974
|
+
# header parameters
|
25975
|
+
header_params = {}
|
25976
|
+
# HTTP header 'Accept' (if needed)
|
25977
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
25978
|
+
# HTTP header 'Content-Type'
|
25979
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
25980
|
+
|
25981
|
+
# form parameters
|
25982
|
+
form_params = {}
|
25983
|
+
# Fix header in file
|
25984
|
+
post_body = nil
|
25985
|
+
|
25986
|
+
# http body (model)
|
25987
|
+
post_body = @api_client.object_to_http_body(field)
|
25988
|
+
auth_names = ['JWT']
|
25989
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
25990
|
+
:header_params => header_params,
|
25991
|
+
:query_params => query_params,
|
25992
|
+
:form_params => form_params,
|
25993
|
+
:body => post_body,
|
25994
|
+
:auth_names => auth_names,
|
25995
|
+
:return_type => 'TextBoxFieldResponse')
|
25996
|
+
if @api_client.config.debugging
|
25997
|
+
@api_client.config.logger.debug "API called: PdfApi#put_text_box_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
25998
|
+
end
|
25999
|
+
return data, status_code, headers
|
26000
|
+
end
|
26001
|
+
|
25614
26002
|
# Replace document underline annotation
|
25615
26003
|
#
|
25616
26004
|
# @param name The document name.
|