Skip to content

Commit 6d2b354

Browse files
Merge pull request #30 from kaferi/master
Update to v19.12
2 parents 08955fb + 338b455 commit 6d2b354

File tree

342 files changed

+2067
-440
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

342 files changed

+2067
-440
lines changed

LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2019 Aspose Pty Ltd
3+
Copyright (c) 2020 Aspose Pty Ltd
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

+23
Original file line numberDiff line numberDiff line change
@@ -97,11 +97,13 @@ Class | Method | HTTP request | Description
9797
*PdfApi* | [**getDocumentCheckBoxFields**](docs/PdfApi.md#getDocumentCheckBoxFields) | **GET** /pdf/\{name}/fields/checkbox | Read document checkbox fields.
9898
*PdfApi* | [**getDocumentCircleAnnotations**](docs/PdfApi.md#getDocumentCircleAnnotations) | **GET** /pdf/\{name}/annotations/circle | Read document circle annotations.
9999
*PdfApi* | [**getDocumentComboBoxFields**](docs/PdfApi.md#getDocumentComboBoxFields) | **GET** /pdf/\{name}/fields/combobox | Read document combobox fields.
100+
*PdfApi* | [**getDocumentDisplayProperties**](docs/PdfApi.md#getDocumentDisplayProperties) | **GET** /pdf/\{name}/displayproperties | Read document display properties.
100101
*PdfApi* | [**getDocumentFileAttachmentAnnotations**](docs/PdfApi.md#getDocumentFileAttachmentAnnotations) | **GET** /pdf/\{name}/annotations/fileattachment | Read document FileAttachment annotations.
101102
*PdfApi* | [**getDocumentFreeTextAnnotations**](docs/PdfApi.md#getDocumentFreeTextAnnotations) | **GET** /pdf/\{name}/annotations/freetext | Read document free text annotations.
102103
*PdfApi* | [**getDocumentHighlightAnnotations**](docs/PdfApi.md#getDocumentHighlightAnnotations) | **GET** /pdf/\{name}/annotations/highlight | Read document highlight annotations.
103104
*PdfApi* | [**getDocumentInkAnnotations**](docs/PdfApi.md#getDocumentInkAnnotations) | **GET** /pdf/\{name}/annotations/ink | Read document ink annotations.
104105
*PdfApi* | [**getDocumentLineAnnotations**](docs/PdfApi.md#getDocumentLineAnnotations) | **GET** /pdf/\{name}/annotations/line | Read document line annotations.
106+
*PdfApi* | [**getDocumentListBoxFields**](docs/PdfApi.md#getDocumentListBoxFields) | **GET** /pdf/\{name}/fields/listbox | Read document listbox fields.
105107
*PdfApi* | [**getDocumentMovieAnnotations**](docs/PdfApi.md#getDocumentMovieAnnotations) | **GET** /pdf/\{name}/annotations/movie | Read document movie annotations.
106108
*PdfApi* | [**getDocumentPolygonAnnotations**](docs/PdfApi.md#getDocumentPolygonAnnotations) | **GET** /pdf/\{name}/annotations/polygon | Read document polygon annotations.
107109
*PdfApi* | [**getDocumentPolyLineAnnotations**](docs/PdfApi.md#getDocumentPolyLineAnnotations) | **GET** /pdf/\{name}/annotations/polyline | Read document polyline annotations.
@@ -150,6 +152,7 @@ Class | Method | HTTP request | Description
150152
*PdfApi* | [**getLaTeXInStorageToPdf**](docs/PdfApi.md#getLaTeXInStorageToPdf) | **GET** /pdf/create/latex | Convert LaTeX file (located on storage) to PDF format and return resulting file in response.
151153
*PdfApi* | [**getLineAnnotation**](docs/PdfApi.md#getLineAnnotation) | **GET** /pdf/\{name}/annotations/line/\{annotationId} | Read document page line annotation by ID.
152154
*PdfApi* | [**getLinkAnnotation**](docs/PdfApi.md#getLinkAnnotation) | **GET** /pdf/\{name}/links/\{linkId} | Read document link annotation by ID.
155+
*PdfApi* | [**getListBoxField**](docs/PdfApi.md#getListBoxField) | **GET** /pdf/\{name}/fields/listbox/\{fieldName} | Read document listbox field by name.
153156
*PdfApi* | [**getMarkdownInStorageToPdf**](docs/PdfApi.md#getMarkdownInStorageToPdf) | **GET** /pdf/create/markdown | Convert MD file (located on storage) to PDF format and return resulting file in response.
154157
*PdfApi* | [**getMhtInStorageToPdf**](docs/PdfApi.md#getMhtInStorageToPdf) | **GET** /pdf/create/mht | Convert MHT file (located on storage) to PDF format and return resulting file in response.
155158
*PdfApi* | [**getMovieAnnotation**](docs/PdfApi.md#getMovieAnnotation) | **GET** /pdf/\{name}/annotations/movie/\{annotationId} | Read document page movie annotation by ID.
@@ -172,6 +175,7 @@ Class | Method | HTTP request | Description
172175
*PdfApi* | [**getPageLineAnnotations**](docs/PdfApi.md#getPageLineAnnotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/line | Read document page line annotations.
173176
*PdfApi* | [**getPageLinkAnnotation**](docs/PdfApi.md#getPageLinkAnnotation) | **GET** /pdf/\{name}/pages/\{pageNumber}/links/\{linkId} | Read document page link annotation by ID.
174177
*PdfApi* | [**getPageLinkAnnotations**](docs/PdfApi.md#getPageLinkAnnotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/links | Read document page link annotations.
178+
*PdfApi* | [**getPageListBoxFields**](docs/PdfApi.md#getPageListBoxFields) | **GET** /pdf/\{name}/page/\{pageNumber}/fields/listbox | Read document page listbox fields.
175179
*PdfApi* | [**getPageMovieAnnotations**](docs/PdfApi.md#getPageMovieAnnotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/movie | Read document page movie annotations.
176180
*PdfApi* | [**getPagePolygonAnnotations**](docs/PdfApi.md#getPagePolygonAnnotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/polygon | Read document page polygon annotations.
177181
*PdfApi* | [**getPagePolyLineAnnotations**](docs/PdfApi.md#getPagePolyLineAnnotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/polyline | Read document page polyline annotations.
@@ -243,6 +247,7 @@ Class | Method | HTTP request | Description
243247
*PdfApi* | [**postChangePasswordDocumentInStorage**](docs/PdfApi.md#postChangePasswordDocumentInStorage) | **POST** /pdf/\{name}/changepassword | Change document password in storage.
244248
*PdfApi* | [**postCheckBoxFields**](docs/PdfApi.md#postCheckBoxFields) | **POST** /pdf/\{name}/fields/checkbox | Add document checkbox fields.
245249
*PdfApi* | [**postComboBoxFields**](docs/PdfApi.md#postComboBoxFields) | **POST** /pdf/\{name}/fields/combobox | Add document combobox fields.
250+
*PdfApi* | [**postCreateDocument**](docs/PdfApi.md#postCreateDocument) | **POST** /pdf/\{name} | Create empty document.
246251
*PdfApi* | [**postCreateField**](docs/PdfApi.md#postCreateField) | **POST** /pdf/\{name}/fields | Create field.
247252
*PdfApi* | [**postDecryptDocumentInStorage**](docs/PdfApi.md#postDecryptDocumentInStorage) | **POST** /pdf/\{name}/decrypt | Decrypt document in storage.
248253
*PdfApi* | [**postDocumentImageFooter**](docs/PdfApi.md#postDocumentImageFooter) | **POST** /pdf/\{name}/footer/image | Add document image footer.
@@ -257,6 +262,7 @@ Class | Method | HTTP request | Description
257262
*PdfApi* | [**postImportFieldsFromXfdf**](docs/PdfApi.md#postImportFieldsFromXfdf) | **POST** /pdf/\{name}/import/xfdf | Update fields from XFDF file in request.
258263
*PdfApi* | [**postImportFieldsFromXml**](docs/PdfApi.md#postImportFieldsFromXml) | **POST** /pdf/\{name}/import/xml | Update fields from XML file in request.
259264
*PdfApi* | [**postInsertImage**](docs/PdfApi.md#postInsertImage) | **POST** /pdf/\{name}/pages/\{pageNumber}/images | Insert image to document page.
265+
*PdfApi* | [**postListBoxFields**](docs/PdfApi.md#postListBoxFields) | **POST** /pdf/\{name}/fields/listbox | Add document listbox fields.
260266
*PdfApi* | [**postMovePage**](docs/PdfApi.md#postMovePage) | **POST** /pdf/\{name}/pages/\{pageNumber}/movePage | Move page to new position.
261267
*PdfApi* | [**postOptimizeDocument**](docs/PdfApi.md#postOptimizeDocument) | **POST** /pdf/\{name}/optimize | Optimize document.
262268
*PdfApi* | [**postPageCaretAnnotations**](docs/PdfApi.md#postPageCaretAnnotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/caret | Add document page caret annotations.
@@ -302,6 +308,7 @@ Class | Method | HTTP request | Description
302308
*PdfApi* | [**putComboBoxField**](docs/PdfApi.md#putComboBoxField) | **PUT** /pdf/\{name}/fields/combobox/\{fieldName} | Replace document combobox field
303309
*PdfApi* | [**putCreateDocument**](docs/PdfApi.md#putCreateDocument) | **PUT** /pdf/\{name} | Create empty document.
304310
*PdfApi* | [**putDecryptDocument**](docs/PdfApi.md#putDecryptDocument) | **PUT** /pdf/decrypt | Decrypt document from content.
311+
*PdfApi* | [**putDocumentDisplayProperties**](docs/PdfApi.md#putDocumentDisplayProperties) | **PUT** /pdf/\{name}/displayproperties | Update document display properties.
305312
*PdfApi* | [**putEncryptDocument**](docs/PdfApi.md#putEncryptDocument) | **PUT** /pdf/encrypt | Encrypt document from content.
306313
*PdfApi* | [**putEpubInStorageToPdf**](docs/PdfApi.md#putEpubInStorageToPdf) | **PUT** /pdf/\{name}/create/epub | Convert EPUB file (located on storage) to PDF format and upload resulting file to storage.
307314
*PdfApi* | [**putExportFieldsFromPdfToFdfInStorage**](docs/PdfApi.md#putExportFieldsFromPdfToFdfInStorage) | **PUT** /pdf/\{name}/export/fdf | Export fields from from PDF in storage to FDF file in storage.
@@ -329,6 +336,7 @@ Class | Method | HTTP request | Description
329336
*PdfApi* | [**putLaTeXInStorageToPdf**](docs/PdfApi.md#putLaTeXInStorageToPdf) | **PUT** /pdf/\{name}/create/latex | Convert LaTeX file (located on storage) to PDF format and upload resulting file to storage.
330337
*PdfApi* | [**putLineAnnotation**](docs/PdfApi.md#putLineAnnotation) | **PUT** /pdf/\{name}/annotations/line/\{annotationId} | Replace document line annotation
331338
*PdfApi* | [**putLinkAnnotation**](docs/PdfApi.md#putLinkAnnotation) | **PUT** /pdf/\{name}/links/\{linkId} | Replace document page link annotations
339+
*PdfApi* | [**putListBoxField**](docs/PdfApi.md#putListBoxField) | **PUT** /pdf/\{name}/fields/listbox/\{fieldName} | Replace document listbox field
332340
*PdfApi* | [**putMarkdownInStorageToPdf**](docs/PdfApi.md#putMarkdownInStorageToPdf) | **PUT** /pdf/\{name}/create/markdown | Convert MD file (located on storage) to PDF format and upload resulting file to storage.
333341
*PdfApi* | [**putMergeDocuments**](docs/PdfApi.md#putMergeDocuments) | **PUT** /pdf/\{name}/merge | Merge a list of documents.
334342
*PdfApi* | [**putMhtInStorageToPdf**](docs/PdfApi.md#putMhtInStorageToPdf) | **PUT** /pdf/\{name}/create/mht | Convert MHT file (located on storage) to PDF format and upload resulting file to storage.
@@ -423,8 +431,11 @@ Class | Description
423431
[**BookmarkResponse**](docs/BookmarkResponse.md) | Represents response containing single bookmark info
424432
[**Bookmarks**](docs/Bookmarks.md) | Represents list of bookmark.
425433
[**BookmarksResponse**](docs/BookmarksResponse.md) | Represents response containing multiple bookmarks info
434+
[**Border**](docs/Border.md) | Class representing characteristics of annotation border.
426435
[**BorderCornerStyle**](docs/BorderCornerStyle.md) | Enumerates the border corner styles for border.
436+
[**BorderEffect**](docs/BorderEffect.md) | Describes effect which should be applied to the border of the annotations.
427437
[**BorderInfo**](docs/BorderInfo.md) | This class represents border for graphics elements.
438+
[**BorderStyle**](docs/BorderStyle.md) | Describes style of the annotation border.
428439
[**BoxStyle**](docs/BoxStyle.md) | Represents an enumeration of available BoxStyle types.
429440
[**CapStyle**](docs/CapStyle.md) | Style of line ending of Ink annotation line.
430441
[**CaptionPosition**](docs/CaptionPosition.md) | Enumeration of the annotation’s caption positioning.
@@ -454,11 +465,17 @@ Class | Description
454465
[**CommonFigureAnnotation**](docs/CommonFigureAnnotation.md) | Provides CommonFigureAnnotation.
455466
[**CompressionType**](docs/CompressionType.md) | Used to specify the parameter value passed to a Tiff image device.
456467
[**CryptoAlgorithm**](docs/CryptoAlgorithm.md) | Represent type of cryptographic algorithm that used in encryption/decryption routines.
468+
[**Dash**](docs/Dash.md) | Class representing line dash pattern.
469+
[**DefaultPageConfig**](docs/DefaultPageConfig.md) | Provides link to DefaultPageConfig.
470+
[**Direction**](docs/Direction.md) | Text direction.
457471
[**DiscUsage**](docs/DiscUsage.md) | Class for disc space information.
472+
[**DisplayProperties**](docs/DisplayProperties.md) | Provides link to DisplayProperties.
473+
[**DisplayPropertiesResponse**](docs/DisplayPropertiesResponse.md) | Represents response containing DisplayProperties
458474
[**DocFormat**](docs/DocFormat.md) | Allows to specify .doc or .docx file format.
459475
[**DocMDPAccessPermissionType**](docs/DocMDPAccessPermissionType.md) | The access permissions granted for this document. Valid values are: 1 - No changes to the document are permitted; any change to the document invalidates the signature. 2 - Permitted changes are filling in forms, instantiating page templates, and signing; other changes invalidate the signature. 3 - Permitted changes are the same as for 2, as well as annotation creation, deletion, and modification; other changes invalidate the signature.
460476
[**DocRecognitionMode**](docs/DocRecognitionMode.md) | Allows to control how a PDF document is converted into a word processing document.
461477
[**Document**](docs/Document.md) | Represents document DTO.
478+
[**DocumentConfig**](docs/DocumentConfig.md) | Provides link to DocumentConfig.
462479
[**DocumentPageResponse**](docs/DocumentPageResponse.md) | Represents response containing single page info
463480
[**DocumentPagesResponse**](docs/DocumentPagesResponse.md) | Represents response containing multiple pages info
464481
[**DocumentPrivilege**](docs/DocumentPrivilege.md) | Represents the privileges for accessing Pdf file.
@@ -532,6 +549,10 @@ Class | Description
532549
[**LinkAnnotationsResponse**](docs/LinkAnnotationsResponse.md) | Represents response containing multiple links info
533550
[**LinkElement**](docs/LinkElement.md) | Represents base DTO object.
534551
[**LinkHighlightingMode**](docs/LinkHighlightingMode.md) | Enumerates the annotation’s highlighting mode, the visual effect to be used when the mouse button is pressed or held down inside its active area.
552+
[**ListBoxField**](docs/ListBoxField.md) | Provides ListBoxField.
553+
[**ListBoxFieldResponse**](docs/ListBoxFieldResponse.md) | Represents response containing single listbox field object
554+
[**ListBoxFields**](docs/ListBoxFields.md) | Object representing a list of listbox fields.
555+
[**ListBoxFieldsResponse**](docs/ListBoxFieldsResponse.md) | Represents response containing multiple listbox field objects
535556
[**MarginInfo**](docs/MarginInfo.md) | This class represents a margin for different objects.
536557
[**MarkupAnnotation**](docs/MarkupAnnotation.md) | Provides MarkupAnnotation.
537558
[**MergeDocuments**](docs/MergeDocuments.md) | Documents for merging.
@@ -543,6 +564,8 @@ Class | Description
543564
[**OptimizeOptions**](docs/OptimizeOptions.md) | Represents Pdf optimize options.
544565
[**Option**](docs/Option.md) | Provides form option.
545566
[**Page**](docs/Page.md) | Provides link to page.
567+
[**PageLayout**](docs/PageLayout.md) | Descibes page layout.
568+
[**PageMode**](docs/PageMode.md) | Class descibes used components of the document page.
546569
[**PageNumberStamp**](docs/PageNumberStamp.md) | Represents Pdf stamps.
547570
[**Pages**](docs/Pages.md) | Represents list of pages.
548571
[**PageWordCount**](docs/PageWordCount.md) | Page words count.

docs/Border.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Border
2+
Class representing characteristics of annotation border.
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**width** | **number** | Gets or sets border width. | [optional]
8+
**effectIntensity** | **number** | Gets or sets effect intencity. Valid range of value is [0..2]. | [optional]
9+
**style** | [**BorderStyle**](BorderStyle.md) | Gets or sets border style. | [optional]
10+
**effect** | [**BorderEffect**](BorderEffect.md) | Gets or sets border effect. | [optional]
11+
**dash** | [**Dash**](Dash.md) | Gets or sets dash pattern. | [optional]
12+
**color** | [**Color**](Color.md) | Gets or sets border color. | [optional]
13+
14+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/border.ts)
15+

docs/BorderEffect.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# BorderEffect
2+
Describes effect which should be applied to the border of the annotations.
3+
4+
## Enum
5+
Name | Type | Value | Description
6+
------------ | ------------- | ------------- | -------------
7+
**Cloudy** | **string** | 'Cloudy' | The border will appear "cloudly".
8+
**None** | **string** | 'None' | No effect.
9+
10+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/borderEffect.ts)
11+

docs/BorderStyle.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# BorderStyle
2+
Describes style of the annotation border.
3+
4+
## Enum
5+
Name | Type | Value | Description
6+
------------ | ------------- | ------------- | -------------
7+
**Beveled** | **string** | 'Beveled' | Bevelled border.
8+
**Dashed** | **string** | 'Dashed' | Dashed border.
9+
**Inset** | **string** | 'Inset' | Inset border.
10+
**Solid** | **string** | 'Solid' | Solid border.
11+
**Underline** | **string** | 'Underline' | Underlined border.
12+
13+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/borderStyle.ts)
14+

docs/CheckBoxField.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Name | Type | Description | Notes
1717
**height** | **number** | Gets or sets height of the field.<br />*Inherited from [FormField](FormField.md)* | [optional]
1818
**width** | **number** | Gets or sets width of the field.<br />*Inherited from [FormField](FormField.md)* | [optional]
1919
**zIndex** | **number** | Z index.<br />*Inherited from [FormField](FormField.md)* | [optional]
20-
**isGroup** | **boolean** | Is group.<br />*Inherited from [FormField](FormField.md)* |
20+
**isGroup** | **boolean** | Is group.<br />*Inherited from [FormField](FormField.md)* | [optional]
2121
**parent** | [**FormField**](FormField.md) | Gets field parent.<br />*Inherited from [FormField](FormField.md)* | [optional]
2222
**isSharedField** | **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.<br />*Inherited from [FormField](FormField.md)* | [optional]
2323
**flags** | [**Array&lt;AnnotationFlags&gt;**](AnnotationFlags.md) | Gets Flags of the field.<br />*Inherited from [FormField](FormField.md)* | [optional]
@@ -27,6 +27,7 @@ Name | Type | Description | Notes
2727
**highlighting** | [**LinkHighlightingMode**](LinkHighlightingMode.md) | Field highlighting mode.<br />*Inherited from [FormField](FormField.md)* | [optional]
2828
**horizontalAlignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the field.<br />*Inherited from [FormField](FormField.md)* | [optional]
2929
**verticalAlignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the field.<br />*Inherited from [FormField](FormField.md)* | [optional]
30+
**border** | [**Border**](Border.md) | Gets or sets annotation border characteristics.<br />*Inherited from [FormField](FormField.md)* | [optional]
3031
**links** | [**Array&lt;Link&gt;**](Link.md) | Link to the document.<br />*Inherited from [LinkElement](LinkElement.md)* | [optional]
3132

3233
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/checkBoxField.ts)

0 commit comments

Comments
 (0)