Skip to content

Commit 7f8a175

Browse files
kaferikaferi
authored
Merge pull request #42 from kaferi/master
Update to v20.7
2 parents 304a9a6 + 1057a12 commit 7f8a175

16 files changed

+314
-38
lines changed

‎README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ Class | Method | HTTP request | Description
8383
*PdfApi* | [**deleteStamp**](docs/PdfApi.md#deleteStamp) | **DELETE** /pdf/\{name}/stamps/\{stampId} | Delete document stamp by ID
8484
*PdfApi* | [**deleteTable**](docs/PdfApi.md#deleteTable) | **DELETE** /pdf/\{name}/tables/\{tableId} | Delete document table by ID
8585
*PdfApi* | [**downloadFile**](docs/PdfApi.md#downloadFile) | **GET** /pdf/storage/file/\{path} | Download file
86+
*PdfApi* | [**getApiInfo**](docs/PdfApi.md#getApiInfo) | **GET** /pdf/info |
8687
*PdfApi* | [**getBookmark**](docs/PdfApi.md#getBookmark) | **GET** /pdf/\{name}/bookmarks/bookmark/\{bookmarkPath} | Read document bookmark.
8788
*PdfApi* | [**getBookmarks**](docs/PdfApi.md#getBookmarks) | **GET** /pdf/\{name}/bookmarks/list/\{bookmarkPath} | Read document bookmarks node list.
8889
*PdfApi* | [**getCaretAnnotation**](docs/PdfApi.md#getCaretAnnotation) | **GET** /pdf/\{name}/annotations/caret/\{annotationId} | Read document page caret annotation by ID.
@@ -91,7 +92,7 @@ Class | Method | HTTP request | Description
9192
*PdfApi* | [**getComboBoxField**](docs/PdfApi.md#getComboBoxField) | **GET** /pdf/\{name}/fields/combobox/\{fieldName} | Read document combobox field by name.
9293
*PdfApi* | [**getDiscUsage**](docs/PdfApi.md#getDiscUsage) | **GET** /pdf/storage/disc | Get disc usage
9394
*PdfApi* | [**getDocument**](docs/PdfApi.md#getDocument) | **GET** /pdf/\{name} | Read common document info.
94-
*PdfApi* | [**getDocumentAnnotations**](docs/PdfApi.md#getDocumentAnnotations) | **GET** /pdf/\{name}/annotations | Read documant page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases.
95+
*PdfApi* | [**getDocumentAnnotations**](docs/PdfApi.md#getDocumentAnnotations) | **GET** /pdf/\{name}/annotations | Read document page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases.
9596
*PdfApi* | [**getDocumentAttachmentByIndex**](docs/PdfApi.md#getDocumentAttachmentByIndex) | **GET** /pdf/\{name}/attachments/\{attachmentIndex} | Read document attachment info by its index.
9697
*PdfApi* | [**getDocumentAttachments**](docs/PdfApi.md#getDocumentAttachments) | **GET** /pdf/\{name}/attachments | Read document attachments info.
9798
*PdfApi* | [**getDocumentBookmarks**](docs/PdfApi.md#getDocumentBookmarks) | **GET** /pdf/\{name}/bookmarks/tree | Read document bookmarks tree.
@@ -240,7 +241,7 @@ Class | Method | HTTP request | Description
240241
*PdfApi* | [**getVerifySignature**](docs/PdfApi.md#getVerifySignature) | **GET** /pdf/\{name}/verifySignature | Verify signature document.
241242
*PdfApi* | [**getWebInStorageToPdf**](docs/PdfApi.md#getWebInStorageToPdf) | **GET** /pdf/create/web | Convert web page to PDF format and return resulting file in response.
242243
*PdfApi* | [**getWordsPerPage**](docs/PdfApi.md#getWordsPerPage) | **GET** /pdf/\{name}/pages/wordCount | Get number of words per document page.
243-
*PdfApi* | [**getXfaPdfInStorageToAcroForm**](docs/PdfApi.md#getXfaPdfInStorageToAcroForm) | **GET** /pdf/\{name}/convert/xfatoacroform | Converts PDF document which contatins XFA form (located on storage) to PDF with AcroForm and returns resulting file response content
244+
*PdfApi* | [**getXfaPdfInStorageToAcroForm**](docs/PdfApi.md#getXfaPdfInStorageToAcroForm) | **GET** /pdf/\{name}/convert/xfatoacroform | Converts PDF document which contains XFA form (located on storage) to PDF with AcroForm and returns resulting file response content
244245
*PdfApi* | [**getXmlInStorageToPdf**](docs/PdfApi.md#getXmlInStorageToPdf) | **GET** /pdf/create/xml | Convert XML file (located on storage) to PDF format and return resulting file in response.
245246
*PdfApi* | [**getXpsInStorageToPdf**](docs/PdfApi.md#getXpsInStorageToPdf) | **GET** /pdf/create/xps | Convert XPS file (located on storage) to PDF format and return resulting file in response.
246247
*PdfApi* | [**getXslFoInStorageToPdf**](docs/PdfApi.md#getXslFoInStorageToPdf) | **GET** /pdf/create/xslfo | Convert XslFo file (located on storage) to PDF format and return resulting file in response.
@@ -413,8 +414,8 @@ Class | Method | HTTP request | Description
413414
*PdfApi* | [**putUpdateField**](docs/PdfApi.md#putUpdateField) | **PUT** /pdf/\{name}/fields/\{fieldName} | Update field.
414415
*PdfApi* | [**putUpdateFields**](docs/PdfApi.md#putUpdateFields) | **PUT** /pdf/\{name}/fields | Update fields.
415416
*PdfApi* | [**putWebInStorageToPdf**](docs/PdfApi.md#putWebInStorageToPdf) | **PUT** /pdf/\{name}/create/web | Convert web page to PDF format and upload resulting file to storage.
416-
*PdfApi* | [**putXfaPdfInRequestToAcroForm**](docs/PdfApi.md#putXfaPdfInRequestToAcroForm) | **PUT** /pdf/convert/xfatoacroform | Converts PDF document which contatins XFA form (in request content) to PDF with AcroForm and uploads resulting file to storage.
417-
*PdfApi* | [**putXfaPdfInStorageToAcroForm**](docs/PdfApi.md#putXfaPdfInStorageToAcroForm) | **PUT** /pdf/\{name}/convert/xfatoacroform | Converts PDF document which contatins XFA form (located on storage) to PDF with AcroForm and uploads resulting file to storage
417+
*PdfApi* | [**putXfaPdfInRequestToAcroForm**](docs/PdfApi.md#putXfaPdfInRequestToAcroForm) | **PUT** /pdf/convert/xfatoacroform | Converts PDF document which contains XFA form (in request content) to PDF with AcroForm and uploads resulting file to storage.
418+
*PdfApi* | [**putXfaPdfInStorageToAcroForm**](docs/PdfApi.md#putXfaPdfInStorageToAcroForm) | **PUT** /pdf/\{name}/convert/xfatoacroform | Converts PDF document which contains XFA form (located on storage) to PDF with AcroForm and uploads resulting file to storage
418419
*PdfApi* | [**putXmlInStorageToPdf**](docs/PdfApi.md#putXmlInStorageToPdf) | **PUT** /pdf/\{name}/create/xml | Convert XML file (located on storage) to PDF format and upload resulting file to storage.
419420
*PdfApi* | [**putXpsInStorageToPdf**](docs/PdfApi.md#putXpsInStorageToPdf) | **PUT** /pdf/\{name}/create/xps | Convert XPS file (located on storage) to PDF format and upload resulting file to storage.
420421
*PdfApi* | [**putXslFoInStorageToPdf**](docs/PdfApi.md#putXslFoInStorageToPdf) | **PUT** /pdf/\{name}/create/xslfo | Convert XslFo file (located on storage) to PDF format and upload resulting file to storage.
@@ -433,6 +434,7 @@ Class | Description
433434
[**AnnotationState**](docs/AnnotationState.md) | The enumeration of states to which the original annotation can be set.
434435
[**AnnotationType**](docs/AnnotationType.md) |
435436
[**AntialiasingProcessingType**](docs/AntialiasingProcessingType.md) | This enum describes possible antialiasing measures during conversion
437+
[**ApiInfo**](docs/ApiInfo.md) | Represents response for ApiInfo DTO
436438
[**AsposeResponse**](docs/AsposeResponse.md) | Base class for all responses.
437439
[**Attachment**](docs/Attachment.md) | Provides link to attachment.
438440
[**AttachmentResponse**](docs/AttachmentResponse.md) | Represents response containing single attachment info
@@ -530,6 +532,8 @@ Class | Description
530532
[**HtmlDocumentType**](docs/HtmlDocumentType.md) | Represents enumeration of the Html document types.
531533
[**HtmlMarkupGenerationModes**](docs/HtmlMarkupGenerationModes.md) | Sometimes specific reqirments to created HTML are present. This enum defines HTML preparing modes that can be used during conversion of PDF to HTML to match such specific requirments.
532534
[**Image**](docs/Image.md) | Represents image DTO.
535+
[**ImageCompressionVersion**](docs/ImageCompressionVersion.md) | Describes versions of image compression algorithm.
536+
[**ImageEncoding**](docs/ImageEncoding.md) | Image encoding type.
533537
[**ImageFooter**](docs/ImageFooter.md) | Represents Pdf image footer.
534538
[**ImageFragment**](docs/ImageFragment.md) | Represents Image Fragment DTO.
535539
[**ImageHeader**](docs/ImageHeader.md) | Represents Pdf image header.

‎docs/ApiInfo.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# ApiInfo
2+
Represents response for ApiInfo DTO
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**name** | **string** | Product name. | [optional]
8+
**version** | **string** | API version. | [optional]
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/apiInfo.ts)
11+

‎docs/ImageCompressionVersion.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# ImageCompressionVersion
2+
Describes versions of image compression algorithm.
3+
4+
## Enum
5+
Name | Type | Value | Description
6+
------------ | ------------- | ------------- | -------------
7+
**Fast** | **string** | 'Fast' | Improved algorithm faster then standard but applicable not for all cases.
8+
**Mixed** | **string** | 'Mixed' | Use fast algorithm when possible and standard for other cases. May be slower then "Fast" but may produce better compression.
9+
**Standard** | **string** | 'Standard' | Standard algorithm. Default value.
10+
11+
[[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/imageCompressionVersion.ts)
12+

‎docs/ImageEncoding.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# ImageEncoding
2+
Image encoding type.
3+
4+
## Enum
5+
Name | Type | Value | Description
6+
------------ | ------------- | ------------- | -------------
7+
**Flate** | **string** | 'Flate' | Flate encoding.
8+
**Jpeg** | **string** | 'Jpeg' | JPEG (DCT) encoding.
9+
**Jpeg2000** | **string** | 'Jpeg2000' | JPEG2000 (JPX) encoding.
10+
**Unchanged** | **string** | 'Unchanged' | Don't change encoding.
11+
12+
[[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/imageEncoding.ts)
13+

‎docs/OptimizeOptions.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,19 @@ Represents Pdf optimize options.
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**allowReusePageContent** | **boolean** | If true page contents will be reused when document is optimized for equal pages. |
8-
**compressImages** | **boolean** | If this flag is set to true images will be compressed in the document. compression level is specfied with ImageQuality property. |
9-
**imageQuality** | **number** | Specifie slevel of image compression when CompressIamges flag is used. |
10-
**linkDuplcateStreams** | **boolean** | If this flag is set to true, Resource streams will be analyzed. If duplicate streams are found (i.e. if stream contents is equal), then thes streams will be stored as one object. This allows to decrease document size in some cases (for example, when same document was concatenedted multiple times). |
11-
**removeUnusedObjects** | **boolean** | If this flag is set to true, all document objects will be checked and unused objects (i.e. objects which does not have any reference) are removed from document. |
12-
**removeUnusedStreams** | **boolean** | If this flag set to true, every resource is checked on it's usage. If resource is never used, then resources is removed. This may decrease document size for example when pages were extracted from document. |
13-
**unembedFonts** | **boolean** | Make fonts not embedded if set to true. |
7+
**allowReusePageContent** | **boolean** | If true page contents will be reused when document is optimized for equal pages. | [optional]
8+
**compressImages** | **boolean** | If this flag is set to true images will be compressed in the document. Compression level is specified with ImageQuality property. | [optional]
9+
**imageQuality** | **number** | Specifies level of image compression when CompressImages flag is used. | [optional]
10+
**linkDuplcateStreams** | **boolean** | If this flag is set to true, Resource streams will be analyzed. If duplicate streams are found (i.e. if stream contents is equal), then thees streams will be stored as one object. This allows to decrease document size in some cases (for example, when same document was concatenated multiple times). | [optional]
11+
**removeUnusedObjects** | **boolean** | If this flag is set to true, all document objects will be checked and unused objects (i.e. objects which does not have any reference) are removed from document. | [optional]
12+
**removeUnusedStreams** | **boolean** | If this flag set to true, every resource is checked on it's usage. If resource is never used, then resources is removed. This may decrease document size for example when pages were extracted from document. | [optional]
13+
**unembedFonts** | **boolean** | Make fonts not embedded if set to true. | [optional]
14+
**resizeImages** | **boolean** | If this flag set to true and CompressImages is true images will be resized if image resolution is greater then specified MaxResolution parameter. | [optional]
15+
**maxResolution** | **number** | Specifies maximum resolution of images. If image has higher resolution it will be scaled. | [optional]
16+
**subsetFonts** | **boolean** | Fonts will be converted into subsets if set to true. | [optional]
17+
**removePrivateInfo** | **boolean** | Remove private information (page piece info). | [optional]
18+
**imageEncoding** | [**ImageEncoding**](ImageEncoding.md) | Image encode which will be used. | [optional]
19+
**imageCompressionVersion** | [**ImageCompressionVersion**](ImageCompressionVersion.md) | Version of compression algorithm. Possible values are: "Standard" - standard compression, "Fast" - fast (improved compression which is faster then standard but may be applicable not for all images), "Mixed" - mixed (standard compression is applied to images which can not be compressed by faster algorithm, this may give best compression but more slow then "Fast" algorithm. Version "Fast" is not applicable for resizing images (standard method will be used). Default is "Standard". | [optional]
1420

1521
[[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/optimizeOptions.ts)
1622

‎docs/PdfAType.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@ Allows to specify PdfA file format.
44
## Enum
55
Name | Type | Value | Description
66
------------ | ------------- | ------------- | -------------
7-
**PDFA1A** | **string** | 'PDFA1A' |
8-
**PDFA1B** | **string** | 'PDFA1B' |
7+
**PDFA1A** | **string** | 'PDFA1A' | Pdf/A-1a format
8+
**PDFA1B** | **string** | 'PDFA1B' | Pdf/A-1b format
9+
**PDFA3A** | **string** | 'PDFA3A' | Pdf/A-3a format
910

1011
[[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/pdfAType.ts)
1112

0 commit comments

Comments
 (0)