Skip to content

Commit 6c6a172

Browse files
kaferikaferi
committed
Update to v20.1
1 parent dbd08e8 commit 6c6a172

File tree

6 files changed

+367
-3
lines changed

6 files changed

+367
-3
lines changed

‎README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Aspose.PDF Cloud
22
- API version: 3.0
3-
- Package version: 19.12.0
3+
- Package version: 20.1.0
44

55
[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.
66

@@ -336,6 +336,7 @@ Class | Method | HTTP request | Description
336336
*PdfApi* | [**post_radio_button_fields**](docs/PdfApi.md#post_radio_button_fields) | **POST** /pdf/\{name}/fields/radiobutton | Add document RadioButton fields.
337337
*PdfApi* | [**post_sign_document**](docs/PdfApi.md#post_sign_document) | **POST** /pdf/\{name}/sign | Sign document.
338338
*PdfApi* | [**post_sign_page**](docs/PdfApi.md#post_sign_page) | **POST** /pdf/\{name}/pages/\{pageNumber}/sign | Sign page.
339+
*PdfApi* | [**post_signature_field**](docs/PdfApi.md#post_signature_field) | **POST** /pdf/\{name}/fields/signature | Add document signature field.
339340
*PdfApi* | [**post_split_document**](docs/PdfApi.md#post_split_document) | **POST** /pdf/\{name}/split | Split document to parts.
340341
*PdfApi* | [**post_text_box_fields**](docs/PdfApi.md#post_text_box_fields) | **POST** /pdf/\{name}/fields/textbox | Add document text box fields.
341342
*PdfApi* | [**put_add_new_page**](docs/PdfApi.md#put_add_new_page) | **PUT** /pdf/\{name}/pages | Add new page to end of the document.
@@ -428,6 +429,7 @@ Class | Method | HTTP request | Description
428429
*PdfApi* | [**put_screen_annotation_data_extract**](docs/PdfApi.md#put_screen_annotation_data_extract) | **PUT** /pdf/\{name}/annotations/screen/\{annotationId}/data/extract | Extract document screen annotation content to storage
429430
*PdfApi* | [**put_searchable_document**](docs/PdfApi.md#put_searchable_document) | **PUT** /pdf/\{name}/ocr | Create searchable PDF document. Generate OCR layer for images in input PDF document.
430431
*PdfApi* | [**put_set_property**](docs/PdfApi.md#put_set_property) | **PUT** /pdf/\{name}/documentproperties/\{propertyName} | Add/update document property.
432+
*PdfApi* | [**put_signature_field**](docs/PdfApi.md#put_signature_field) | **PUT** /pdf/\{name}/fields/signature/\{fieldName} | Replace document signature field.
431433
*PdfApi* | [**put_sound_annotation**](docs/PdfApi.md#put_sound_annotation) | **PUT** /pdf/\{name}/annotations/sound/\{annotationId} | Replace document sound annotation
432434
*PdfApi* | [**put_sound_annotation_data_extract**](docs/PdfApi.md#put_sound_annotation_data_extract) | **PUT** /pdf/\{name}/annotations/sound/\{annotationId}/data/extract | Extract document sound annotation content to storage
433435
*PdfApi* | [**put_square_annotation**](docs/PdfApi.md#put_square_annotation) | **PUT** /pdf/\{name}/annotations/square/\{annotationId} | Replace document square annotation

‎asposepdfcloud/apis/pdf_api.py

Lines changed: 245 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28742,6 +28742,125 @@ def post_sign_page_with_http_info(self, name, page_number, sign, **kwargs):
2874228742
_request_timeout=params.get('_request_timeout'),
2874328743
collection_formats=collection_formats)
2874428744

28745+
def post_signature_field(self, name, field, **kwargs):
28746+
"""
28747+
Add document signature field.
28748+
This method makes a synchronous HTTP request by default. To make an
28749+
asynchronous HTTP request, please define a `callback` function
28750+
to be invoked when receiving the response.
28751+
>>> def callback_function(response):
28752+
>>> pprint(response)
28753+
>>>
28754+
>>> thread = api.post_signature_field(name, field, callback=callback_function)
28755+
28756+
:param callback function: The callback function
28757+
for asynchronous request. (optional)
28758+
:param str name: The document name. (required)
28759+
:param SignatureField field: The field. (required)
28760+
:param str storage: The document storage.
28761+
:param str folder: The document folder.
28762+
:return: AsposeResponse
28763+
If the method is called asynchronously,
28764+
returns the request thread.
28765+
"""
28766+
kwargs['_return_http_data_only'] = True
28767+
if kwargs.get('callback'):
28768+
return self.post_signature_field_with_http_info(name, field, **kwargs)
28769+
else:
28770+
(data) = self.post_signature_field_with_http_info(name, field, **kwargs)
28771+
return data
28772+
28773+
def post_signature_field_with_http_info(self, name, field, **kwargs):
28774+
"""
28775+
Add document signature field.
28776+
This method makes a synchronous HTTP request by default. To make an
28777+
asynchronous HTTP request, please define a `callback` function
28778+
to be invoked when receiving the response.
28779+
>>> def callback_function(response):
28780+
>>> pprint(response)
28781+
>>>
28782+
>>> thread = api.post_signature_field_with_http_info(name, field, callback=callback_function)
28783+
28784+
:param callback function: The callback function
28785+
for asynchronous request. (optional)
28786+
:param str name: The document name. (required)
28787+
:param SignatureField field: The field. (required)
28788+
:param str storage: The document storage.
28789+
:param str folder: The document folder.
28790+
:return: AsposeResponse
28791+
If the method is called asynchronously,
28792+
returns the request thread.
28793+
"""
28794+
28795+
all_params = ['name', 'field', 'storage', 'folder']
28796+
all_params.append('callback')
28797+
all_params.append('_return_http_data_only')
28798+
all_params.append('_preload_content')
28799+
all_params.append('_request_timeout')
28800+
28801+
params = locals()
28802+
for key, val in iteritems(params['kwargs']):
28803+
if key not in all_params:
28804+
raise TypeError(
28805+
"Got an unexpected keyword argument '%s'"
28806+
" to method post_signature_field" % key
28807+
)
28808+
params[key] = val
28809+
del params['kwargs']
28810+
# verify the required parameter 'name' is set
28811+
if ('name' not in params) or (params['name'] is None):
28812+
raise ValueError("Missing the required parameter `name` when calling `post_signature_field`")
28813+
# verify the required parameter 'field' is set
28814+
if ('field' not in params) or (params['field'] is None):
28815+
raise ValueError("Missing the required parameter `field` when calling `post_signature_field`")
28816+
28817+
28818+
collection_formats = {}
28819+
28820+
path_params = {}
28821+
if 'name' in params:
28822+
path_params['name'] = params['name']
28823+
28824+
query_params = []
28825+
if 'storage' in params:
28826+
query_params.append(('storage', params['storage']))
28827+
if 'folder' in params:
28828+
query_params.append(('folder', params['folder']))
28829+
28830+
header_params = {}
28831+
28832+
form_params = []
28833+
local_var_files = {}
28834+
28835+
body_params = None
28836+
if 'field' in params:
28837+
body_params = params['field']
28838+
# HTTP header `Accept`
28839+
header_params['Accept'] = self.api_client.\
28840+
select_header_accept(['application/json'])
28841+
28842+
# HTTP header `Content-Type`
28843+
header_params['Content-Type'] = self.api_client.\
28844+
select_header_content_type(['application/json'])
28845+
28846+
# Authentication setting
28847+
auth_settings = ['JWT']
28848+
28849+
return self.api_client.call_api('/pdf/{name}/fields/signature', 'POST',
28850+
path_params,
28851+
query_params,
28852+
header_params,
28853+
body=body_params,
28854+
post_params=form_params,
28855+
files=local_var_files,
28856+
response_type='AsposeResponse',
28857+
auth_settings=auth_settings,
28858+
callback=params.get('callback'),
28859+
_return_http_data_only=params.get('_return_http_data_only'),
28860+
_preload_content=params.get('_preload_content', True),
28861+
_request_timeout=params.get('_request_timeout'),
28862+
collection_formats=collection_formats)
28863+
2874528864
def post_split_document(self, name, **kwargs):
2874628865
"""
2874728866
Split document to parts.
@@ -40542,6 +40661,132 @@ def put_set_property_with_http_info(self, name, property_name, value, **kwargs):
4054240661
_request_timeout=params.get('_request_timeout'),
4054340662
collection_formats=collection_formats)
4054440663

40664+
def put_signature_field(self, name, field_name, field, **kwargs):
40665+
"""
40666+
Replace document signature field.
40667+
This method makes a synchronous HTTP request by default. To make an
40668+
asynchronous HTTP request, please define a `callback` function
40669+
to be invoked when receiving the response.
40670+
>>> def callback_function(response):
40671+
>>> pprint(response)
40672+
>>>
40673+
>>> thread = api.put_signature_field(name, field_name, field, callback=callback_function)
40674+
40675+
:param callback function: The callback function
40676+
for asynchronous request. (optional)
40677+
:param str name: The document name. (required)
40678+
:param str field_name: The field name. (required)
40679+
:param SignatureField field: The field. (required)
40680+
:param str storage: The document storage.
40681+
:param str folder: The document folder.
40682+
:return: SignatureFieldResponse
40683+
If the method is called asynchronously,
40684+
returns the request thread.
40685+
"""
40686+
kwargs['_return_http_data_only'] = True
40687+
if kwargs.get('callback'):
40688+
return self.put_signature_field_with_http_info(name, field_name, field, **kwargs)
40689+
else:
40690+
(data) = self.put_signature_field_with_http_info(name, field_name, field, **kwargs)
40691+
return data
40692+
40693+
def put_signature_field_with_http_info(self, name, field_name, field, **kwargs):
40694+
"""
40695+
Replace document signature field.
40696+
This method makes a synchronous HTTP request by default. To make an
40697+
asynchronous HTTP request, please define a `callback` function
40698+
to be invoked when receiving the response.
40699+
>>> def callback_function(response):
40700+
>>> pprint(response)
40701+
>>>
40702+
>>> thread = api.put_signature_field_with_http_info(name, field_name, field, callback=callback_function)
40703+
40704+
:param callback function: The callback function
40705+
for asynchronous request. (optional)
40706+
:param str name: The document name. (required)
40707+
:param str field_name: The field name. (required)
40708+
:param SignatureField field: The field. (required)
40709+
:param str storage: The document storage.
40710+
:param str folder: The document folder.
40711+
:return: SignatureFieldResponse
40712+
If the method is called asynchronously,
40713+
returns the request thread.
40714+
"""
40715+
40716+
all_params = ['name', 'field_name', 'field', 'storage', 'folder']
40717+
all_params.append('callback')
40718+
all_params.append('_return_http_data_only')
40719+
all_params.append('_preload_content')
40720+
all_params.append('_request_timeout')
40721+
40722+
params = locals()
40723+
for key, val in iteritems(params['kwargs']):
40724+
if key not in all_params:
40725+
raise TypeError(
40726+
"Got an unexpected keyword argument '%s'"
40727+
" to method put_signature_field" % key
40728+
)
40729+
params[key] = val
40730+
del params['kwargs']
40731+
# verify the required parameter 'name' is set
40732+
if ('name' not in params) or (params['name'] is None):
40733+
raise ValueError("Missing the required parameter `name` when calling `put_signature_field`")
40734+
# verify the required parameter 'field_name' is set
40735+
if ('field_name' not in params) or (params['field_name'] is None):
40736+
raise ValueError("Missing the required parameter `field_name` when calling `put_signature_field`")
40737+
# verify the required parameter 'field' is set
40738+
if ('field' not in params) or (params['field'] is None):
40739+
raise ValueError("Missing the required parameter `field` when calling `put_signature_field`")
40740+
40741+
40742+
collection_formats = {}
40743+
40744+
path_params = {}
40745+
if 'name' in params:
40746+
path_params['name'] = params['name']
40747+
if 'field_name' in params:
40748+
path_params['fieldName'] = params['field_name']
40749+
40750+
query_params = []
40751+
if 'storage' in params:
40752+
query_params.append(('storage', params['storage']))
40753+
if 'folder' in params:
40754+
query_params.append(('folder', params['folder']))
40755+
40756+
header_params = {}
40757+
40758+
form_params = []
40759+
local_var_files = {}
40760+
40761+
body_params = None
40762+
if 'field' in params:
40763+
body_params = params['field']
40764+
# HTTP header `Accept`
40765+
header_params['Accept'] = self.api_client.\
40766+
select_header_accept(['application/json'])
40767+
40768+
# HTTP header `Content-Type`
40769+
header_params['Content-Type'] = self.api_client.\
40770+
select_header_content_type(['application/json'])
40771+
40772+
# Authentication setting
40773+
auth_settings = ['JWT']
40774+
40775+
return self.api_client.call_api('/pdf/{name}/fields/signature/{fieldName}', 'PUT',
40776+
path_params,
40777+
query_params,
40778+
header_params,
40779+
body=body_params,
40780+
post_params=form_params,
40781+
files=local_var_files,
40782+
response_type='SignatureFieldResponse',
40783+
auth_settings=auth_settings,
40784+
callback=params.get('callback'),
40785+
_return_http_data_only=params.get('_return_http_data_only'),
40786+
_preload_content=params.get('_preload_content', True),
40787+
_request_timeout=params.get('_request_timeout'),
40788+
collection_formats=collection_formats)
40789+
4054540790
def put_sound_annotation(self, name, annotation_id, annotation, **kwargs):
4054640791
"""
4054740792
Replace document sound annotation

‎asposepdfcloud/configuration.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,5 +199,5 @@ def to_debug_report(self):
199199
"OS: {env}\n"\
200200
"Python Version: {pyversion}\n"\
201201
"Version of the API: 3.0\n"\
202-
"SDK Package Version: 19.12.0".\
202+
"SDK Package Version: 20.1.0".\
203203
format(env=sys.platform, pyversion=sys.version)

‎docs/PdfApi.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -243,6 +243,7 @@ Method | HTTP request | Description
243243
[**post_radio_button_fields**](PdfApi.md#post_radio_button_fields) | **POST** /pdf/\{name}/fields/radiobutton | Add document RadioButton fields.
244244
[**post_sign_document**](PdfApi.md#post_sign_document) | **POST** /pdf/\{name}/sign | Sign document.
245245
[**post_sign_page**](PdfApi.md#post_sign_page) | **POST** /pdf/\{name}/pages/\{pageNumber}/sign | Sign page.
246+
[**post_signature_field**](PdfApi.md#post_signature_field) | **POST** /pdf/\{name}/fields/signature | Add document signature field.
246247
[**post_split_document**](PdfApi.md#post_split_document) | **POST** /pdf/\{name}/split | Split document to parts.
247248
[**post_text_box_fields**](PdfApi.md#post_text_box_fields) | **POST** /pdf/\{name}/fields/textbox | Add document text box fields.
248249
[**put_add_new_page**](PdfApi.md#put_add_new_page) | **PUT** /pdf/\{name}/pages | Add new page to end of the document.
@@ -335,6 +336,7 @@ Method | HTTP request | Description
335336
[**put_screen_annotation_data_extract**](PdfApi.md#put_screen_annotation_data_extract) | **PUT** /pdf/\{name}/annotations/screen/\{annotationId}/data/extract | Extract document screen annotation content to storage
336337
[**put_searchable_document**](PdfApi.md#put_searchable_document) | **PUT** /pdf/\{name}/ocr | Create searchable PDF document. Generate OCR layer for images in input PDF document.
337338
[**put_set_property**](PdfApi.md#put_set_property) | **PUT** /pdf/\{name}/documentproperties/\{propertyName} | Add/update document property.
339+
[**put_signature_field**](PdfApi.md#put_signature_field) | **PUT** /pdf/\{name}/fields/signature/\{fieldName} | Replace document signature field.
338340
[**put_sound_annotation**](PdfApi.md#put_sound_annotation) | **PUT** /pdf/\{name}/annotations/sound/\{annotationId} | Replace document sound annotation
339341
[**put_sound_annotation_data_extract**](PdfApi.md#put_sound_annotation_data_extract) | **PUT** /pdf/\{name}/annotations/sound/\{annotationId}/data/extract | Extract document sound annotation content to storage
340342
[**put_square_annotation**](PdfApi.md#put_square_annotation) | **PUT** /pdf/\{name}/annotations/square/\{annotationId} | Replace document square annotation
@@ -6421,6 +6423,31 @@ Name | Type | Description | Notes
64216423

64226424
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
64236425

6426+
# **post_signature_field**
6427+
> AsposeResponse post_signature_field(name, field, storage=storage, folder=folder)
6428+
6429+
Add document signature field.
6430+
6431+
### Parameters
6432+
6433+
Name | Type | Description | Notes
6434+
------------- | ------------- | ------------- | -------------
6435+
**name** | **str**| The document name. |
6436+
**field** | [**SignatureField**](SignatureField.md)| The field. |
6437+
**storage** | **str**| The document storage. | [optional]
6438+
**folder** | **str**| The document folder. | [optional]
6439+
6440+
### Return type
6441+
6442+
[**AsposeResponse**](AsposeResponse.md)
6443+
6444+
### HTTP request headers
6445+
6446+
- **Content-Type**: application/json
6447+
- **Accept**: application/json
6448+
6449+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
6450+
64246451
# **post_split_document**
64256452
> SplitResultResponse post_split_document(name, format=format, _from=_from, to=to, storage=storage, folder=folder)
64266453
@@ -8921,6 +8948,32 @@ Name | Type | Description | Notes
89218948

89228949
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
89238950

8951+
# **put_signature_field**
8952+
> SignatureFieldResponse put_signature_field(name, field_name, field, storage=storage, folder=folder)
8953+
8954+
Replace document signature field.
8955+
8956+
### Parameters
8957+
8958+
Name | Type | Description | Notes
8959+
------------- | ------------- | ------------- | -------------
8960+
**name** | **str**| The document name. |
8961+
**field_name** | **str**| The field name. |
8962+
**field** | [**SignatureField**](SignatureField.md)| The field. |
8963+
**storage** | **str**| The document storage. | [optional]
8964+
**folder** | **str**| The document folder. | [optional]
8965+
8966+
### Return type
8967+
8968+
[**SignatureFieldResponse**](SignatureFieldResponse.md)
8969+
8970+
### HTTP request headers
8971+
8972+
- **Content-Type**: application/json
8973+
- **Accept**: application/json
8974+
8975+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
8976+
89248977
# **put_sound_annotation**
89258978
> SoundAnnotationResponse put_sound_annotation(name, annotation_id, annotation, storage=storage, folder=folder)
89268979

‎setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
from setuptools import setup, find_packages
3333

3434
NAME = "asposepdfcloud"
35-
VERSION = "19.12.0"
35+
VERSION = "20.1.0"
3636
# To install the library, run the following
3737
#
3838
# python setup.py install

0 commit comments

Comments
 (0)