aspose_pdf_cloud 18.11.0 → 19.1.0

data/docs/DocRecognitionMode.md

@@ -1,11 +1,11 @@
-# AsposePdfCloud::DocRecognitionMode
+# AsposePdfCloud::DocRecognitionMode
 Allows to control how a PDF document is converted into a word processing document.
 
 ## Enum
-Name | Type | Value
------------- | ------------- | -------------
-**TEXTBOX** | **String** | 'Textbox'
-**FLOW** | **String** | 'Flow'
+Name | Type | Value | Description
+------------ | ------------- | ------------- | -------------
+**TEXTBOX** | **String** | 'Textbox' | This mode is fast and good for maximally preserving original look of the PDF file, but editability of the resulting document could be limited.Every visually grouped block of text int the original PDF file is converted into a textbox in the resulting document. This achieves maximal resemblance of the output document to the original PDF file. The output document will look good, but it will consist entirely of textboxes and it could makes further editing of the document in Microsoft Word quite hard.This is the default mode.
+**FLOW** | **String** | 'Flow' | Full recognition mode, the engine performs grouping and multi-level analysis to restore the original document author's intent and produce a maximally editable document. The downside is that the output document might look different from the original PDF file.
 
 
 

data/docs/Document.md

@@ -1,4 +1,4 @@
-# AsposePdfCloud::Document
+# AsposePdfCloud::Document
 Represents document DTO.
 
 ## Properties

data/docs/DocumentPageResponse.md

@@ -1,11 +1,11 @@
-# AsposePdfCloud::DocumentPageResponse
-
+# AsposePdfCloud::DocumentPageResponse
+Represents response containing single page info
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **code** | **Integer** | Response status code. | 
 **status** | **String** | Response status. | [optional] 
-**page** | [**Page**](Page.md) |  | [optional] 
+**page** | [**Page**](Page.md) | Page object | [optional] 
 
 

data/docs/DocumentPagesResponse.md

@@ -1,11 +1,11 @@
-# AsposePdfCloud::DocumentPagesResponse
-
+# AsposePdfCloud::DocumentPagesResponse
+Represents response containing multiple pages info
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **code** | **Integer** | Response status code. | 
 **status** | **String** | Response status. | [optional] 
-**pages** | [**Pages**](Pages.md) |  | [optional] 
+**pages** | [**Pages**](Pages.md) | Page object | [optional] 
 
 

data/docs/DocumentPrivilege.md

@@ -1,4 +1,4 @@
-# AsposePdfCloud::DocumentPrivilege
+# AsposePdfCloud::DocumentPrivilege
 Represents the privileges for accessing Pdf file./>.
 
 ## Properties

data/docs/DocumentProperties.md

@@ -1,10 +1,10 @@
-# AsposePdfCloud::DocumentProperties
-Pdf document properties.
+# AsposePdfCloud::DocumentProperties
+Represents list of PDF document properties.
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **links** | [**Array<Link>**](Link.md) | Link to the document. | [optional] 
-**list** | [**Array<DocumentProperty>**](DocumentProperty.md) |  | [optional] 
+**list** | [**Array<DocumentProperty>**](DocumentProperty.md) | List of PDF document properties. | [optional] 
 
 

data/docs/DocumentPropertiesResponse.md

@@ -1,11 +1,11 @@
-# AsposePdfCloud::DocumentPropertiesResponse
-
+# AsposePdfCloud::DocumentPropertiesResponse
+Represents response containing multiple document properties info
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **code** | **Integer** | Response status code. | 
 **status** | **String** | Response status. | [optional] 
-**document_properties** | [**DocumentProperties**](DocumentProperties.md) |  | [optional] 
+**document_properties** | [**DocumentProperties**](DocumentProperties.md) | DocumentProperties object | [optional] 
 
 

data/docs/DocumentProperty.md

@@ -1,12 +1,12 @@
-# AsposePdfCloud::DocumentProperty
+# AsposePdfCloud::DocumentProperty
 Pdf document property.
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **links** | [**Array<Link>**](Link.md) | Link to the document. | [optional] 
-**name** | **String** |  | [optional] 
-**value** | **String** |  | [optional] 
-**built_in** | **BOOLEAN** |  | [optional] 
+**name** | **String** | Pame of the property. | [optional] 
+**value** | **String** | Property value. | [optional] 
+**built_in** | **BOOLEAN** | Value indicating whether it is a built-in property. | [optional] 
 
 

data/docs/DocumentPropertyResponse.md

@@ -1,11 +1,11 @@
-# AsposePdfCloud::DocumentPropertyResponse
-
+# AsposePdfCloud::DocumentPropertyResponse
+Represents response containing single document property info
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **code** | **Integer** | Response status code. | 
 **status** | **String** | Response status. | [optional] 
-**document_property** | [**DocumentProperty**](DocumentProperty.md) |  | [optional] 
+**document_property** | [**DocumentProperty**](DocumentProperty.md) | DocumentProperty object | [optional] 
 
 

data/docs/DocumentResponse.md

@@ -1,12 +1,12 @@
-# AsposePdfCloud::DocumentResponse
-
+# AsposePdfCloud::DocumentResponse
+Represents response containing document info
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **code** | **Integer** | Response status code. | 
 **status** | **String** | Response status. | [optional] 
-**document** | [**Document**](Document.md) |  | [optional] 
-**messages** | **Array<String>** |  | [optional] 
+**document** | [**Document**](Document.md) | Document object | [optional] 
+**messages** | **Array<String>** | A list of messages obtained while producing the responce | [optional] 
 
 

data/docs/EpubRecognitionMode.md

@@ -1,4 +1,4 @@
-# AsposePdfCloud::EpubRecognitionMode
+# AsposePdfCloud::EpubRecognitionMode
 When PDF file (that usually has fixed layout) is being converted,
             the conversion engine tries to perform grouping and multi-level analysis to restore
             the original document author's intent and produce result in flow layout.
@@ -7,11 +7,11 @@ When PDF file (that usually has fixed layout) is being converted,
             
 
 ## Enum
-Name | Type | Value
------------- | ------------- | -------------
-**FLOW** | **String** | 'Flow'
-**PDF_FLOW** | **String** | 'PdfFlow'
-**FIXED** | **String** | 'Fixed'
+Name | Type | Value | Description
+------------ | ------------- | ------------- | -------------
+**FLOW** | **String** | 'Flow' | Full recognition mode, the engine tries to perform grouping and multi-level analysis to restore the original document author's intent and produce xhtml in flow layout.
+**PDF_FLOW** | **String** | 'PdfFlow' | The main idea of this conversion is based on saving "natural" order of content rendering that is formed during processing of pdf documents. In the general cases pdf documents keep top-down\left-right rendering order (see attachment directions.png). This assumption allows to create a single-path algorithm that will transform Aps elements that have positions (fixed-layout) into flow formats like HTML,EPUB,DOC. This mode will be especially useful for converting from PDF(APS) into EPUB, because the EPUB format was developed for e-readers like the Kindle or smart-phones. The size of screen those devices usually is less than the size of screen of ordinary PC. Therefore the content of EPUB documents is better to save in the flow format, for correct rendering on screens with different sizes. In this mode every column will be added to the end of previous column this allows to keep the logical structure of transformed document during "pagination" in EPUB readers. This achievement allows correctly render scientific or magazine articles.
+**FIXED** | **String** | 'Fixed' | This mode is fast and good for maximally preserving the original look pages, but unfortunately many EPUB readeres don't support xhtml with fixed layout
 
 
 

data/docs/Field.md

@@ -1,4 +1,4 @@
-# AsposePdfCloud::Field
+# AsposePdfCloud::Field
 Represents form field.
 
 ## Properties
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **name** | **String** | Field name. | [optional] 
 **selected_items** | **Array<Integer>** | Selected items. | [optional] 
 **type** | [**FieldType**](FieldType.md) | Field type. | [optional] 
-**rect** | [**RectanglePdf**](RectanglePdf.md) | Field rectangle. | [optional] 
+**rect** | [**Rectangle**](Rectangle.md) | Field rectangle. | [optional] 
 **values** | **Array<String>** | Field values. | [optional] 
 
 

data/docs/FieldResponse.md

@@ -1,11 +1,11 @@
-# AsposePdfCloud::FieldResponse
-
+# AsposePdfCloud::FieldResponse
+Represents response containing single field info
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **code** | **Integer** | Response status code. | 
 **status** | **String** | Response status. | [optional] 
-**field** | [**Field**](Field.md) |  | [optional] 
+**field** | [**Field**](Field.md) | Field object | [optional] 
 
 

data/docs/FieldType.md

@@ -1,13 +1,13 @@
-# AsposePdfCloud::FieldType
+# AsposePdfCloud::FieldType
 Represents an enumeration of available field types.
 
 ## Enum
-Name | Type | Value
------------- | ------------- | -------------
-**TEXT** | **String** | 'Text'
-**INTEGER** | **String** | 'Integer'
-**BOOLEAN** | **String** | 'Boolean'
-**LIST** | **String** | 'List'
+Name | Type | Value | Description
+------------ | ------------- | ------------- | -------------
+**TEXT** | **String** | 'Text' | Textbox field
+**INTEGER** | **String** | 'Integer' | Numeric textbox field
+**BOOLEAN** | **String** | 'Boolean' | Checkbox field
+**LIST** | **String** | 'List' | Listbox field
 
 
 

data/docs/Fields.md

@@ -1,10 +1,10 @@
-# AsposePdfCloud::Fields
-List of form fields.
+# AsposePdfCloud::Fields
+Represents list of form fields.
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **links** | [**Array<Link>**](Link.md) | Link to the document. | [optional] 
-**list** | [**Array<Field>**](Field.md) |  | [optional] 
+**list** | [**Array<Field>**](Field.md) | List of form fields. | [optional] 
 
 

data/docs/FieldsResponse.md

@@ -1,11 +1,11 @@
-# AsposePdfCloud::FieldsResponse
-
+# AsposePdfCloud::FieldsResponse
+Represents response containing multiple fields info
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **code** | **Integer** | Response status code. | 
 **status** | **String** | Response status. | [optional] 
-**fields** | [**Fields**](Fields.md) |  | [optional] 
+**fields** | [**Fields**](Fields.md) | Fields object | [optional] 
 
 

data/docs/File.md

@@ -1,4 +1,4 @@
-# AsposePdfCloud::File
+# AsposePdfCloud::File
 Represents file DTO.
 
 ## Properties

data/docs/FileAttachmentAnnotation.md

@@ -0,0 +1,29 @@
+# AsposePdfCloud::FileAttachmentAnnotation
+Provides FileAttachmentAnnotation.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional] 
+**color** | [**Color**](Color.md) | Color of the annotation. | [optional] 
+**contents** | **String** | Get the annotation content. | [optional] 
+**modified** | **String** | The date and time when the annotation was last modified. | [optional] 
+**id** | **String** | Gets ID of the annotation. | [optional] 
+**flags** | [**Array<AnnotationFlags>**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional] 
+**name** | **String** | Gets Name of the annotation. | [optional] 
+**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. | [optional] 
+**page_index** | **Integer** | Gets PageIndex of the annotation. | [optional] 
+**z_index** | **Integer** | Gets ZIndex of the annotation. | [optional] 
+**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional] 
+**vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation. | [optional] 
+**creation_date** | **String** | The date and time when the annotation was created. | [optional] 
+**subject** | **String** | Get the annotation subject. | [optional] 
+**title** | **String** | Get the annotation title. | [optional] 
+**rich_text** | **String** | Get the annotation RichText. | [optional] 
+**icon** | [**FileIcon**](FileIcon.md) | Gets or sets icon that shall be used in displaying annotation. | [optional] 
+**opacity** | **Float** | Gets or sets icon's opacity from 0 to 1: 0 - completely transparant, 1 - completely opaque. | [optional] 
+**file_description** | **String** | Gets or sets text associated with the file specification.  | [optional] 
+**file_name** | **String** | Gets or sets file specification name.  | [optional] 
+**file_path** | **String** | Sets content file path.  | [optional] 
+
+

data/docs/FileAttachmentAnnotationResponse.md

@@ -0,0 +1,11 @@
+# AsposePdfCloud::FileAttachmentAnnotationResponse
+Represents response containing single FileAttachment annotation object
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **Integer** | Response status code. | 
+**status** | **String** | Response status. | [optional] 
+**annotation** | [**FileAttachmentAnnotation**](FileAttachmentAnnotation.md) | FileAttachment annotation object | [optional] 
+
+

data/docs/FileAttachmentAnnotations.md

@@ -0,0 +1,10 @@
+# AsposePdfCloud::FileAttachmentAnnotations
+Object representing a list of FileAttachment annotations.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional] 
+**list** | [**Array<FileAttachmentAnnotation>**](FileAttachmentAnnotation.md) | List of FileAttachment annotations. | [optional] 
+
+

data/docs/FileAttachmentAnnotationsResponse.md

@@ -0,0 +1,11 @@
+# AsposePdfCloud::FileAttachmentAnnotationsResponse
+Represents response containing multiple FileAttachment annotation objects
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **Integer** | Response status code. | 
+**status** | **String** | Response status. | [optional] 
+**annotations** | [**FileAttachmentAnnotations**](FileAttachmentAnnotations.md) | Free text annotations object | [optional] 
+
+

data/docs/FileExist.md

@@ -0,0 +1,10 @@
+# AsposePdfCloud::FileExist
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**is_exist** | **BOOLEAN** |  | 
+**is_folder** | **BOOLEAN** |  | 
+
+

data/docs/FileExistResponse.md

@@ -0,0 +1,11 @@
+# AsposePdfCloud::FileExistResponse
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **Integer** | Response status code. | 
+**status** | **String** | Response status. | [optional] 
+**file_exist** | [**FileExist**](FileExist.md) |  | [optional] 
+
+

data/docs/FileIcon.md

@@ -0,0 +1,13 @@
+# AsposePdfCloud::FileIcon
+An icon to be used in displaying the annotation.
+
+## Enum
+Name | Type | Value | Description
+------------ | ------------- | ------------- | -------------
+**PUSH_PIN** | **String** | 'PushPin' | PushPin icon (default value).
+**GRAPH** | **String** | 'Graph' | Graph icon.
+**PAPERCLIP** | **String** | 'Paperclip' | Paperclip icon.
+**TAG** | **String** | 'Tag' | This is tag icon.
+
+
+

data/docs/FileVersion.md

@@ -0,0 +1,15 @@
+# AsposePdfCloud::FileVersion
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**is_folder** | **BOOLEAN** |  | 
+**modified_date** | **DateTime** |  | [optional] 
+**size** | **Integer** |  | 
+**path** | **String** |  | [optional] 
+**version_id** | **String** |  | [optional] 
+**is_latest** | **BOOLEAN** |  | [optional] 
+
+

data/docs/FileVersionsResponse.md

@@ -0,0 +1,11 @@
+# AsposePdfCloud::FileVersionsResponse
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **Integer** | Response status code. | 
+**status** | **String** | Response status. | [optional] 
+**file_versions** | [**Array<FileVersion>**](FileVersion.md) |  | [optional] 
+
+

data/docs/FilesResponse.md

@@ -1,4 +1,4 @@
-# AsposePdfCloud::FilesResponse
+# AsposePdfCloud::FilesResponse
 
 
 ## Properties

data/docs/FontEncodingRules.md

@@ -1,11 +1,11 @@
-# AsposePdfCloud::FontEncodingRules
+# AsposePdfCloud::FontEncodingRules
 This enumeration defines rules which tune encoding logic
 
 ## Enum
-Name | Type | Value
------------- | ------------- | -------------
-**DEFAULT** | **String** | 'Default'
-**DECREASE_TO_UNICODE_PRIORITY_LEVEL** | **String** | 'DecreaseToUnicodePriorityLevel'
+Name | Type | Value | Description
+------------ | ------------- | ------------- | -------------
+**DEFAULT** | **String** | 'Default' | Leave encoding logic "as is" - in accordance with PDF specification
+**DECREASE_TO_UNICODE_PRIORITY_LEVEL** | **String** | 'DecreaseToUnicodePriorityLevel' | ToUnicode is a special mechanism which helps to decode input codes to unicode symbols. According to specification it must be used first of all mechanisms to get unicode symbols for specific input code. But some documents has non-standard fonts and to convert these documents correctly it may be necessary to decrease ToUnicode priority and use another mechanisms to decode input codes.
 
 
 

data/docs/FontSavingModes.md

@@ -1,15 +1,15 @@
-# AsposePdfCloud::FontSavingModes
+# AsposePdfCloud::FontSavingModes
 Enumerates modes that can be used for saving of fonts
 referenced in saved PDF 
             
 
 ## Enum
-Name | Type | Value
------------- | ------------- | -------------
-**ALWAYS_SAVE_AS_WOFF** | **String** | 'AlwaysSaveAsWOFF'
-**ALWAYS_SAVE_AS_TTF** | **String** | 'AlwaysSaveAsTTF'
-**ALWAYS_SAVE_AS_EOT** | **String** | 'AlwaysSaveAsEOT'
-**SAVE_IN_ALL_FORMATS** | **String** | 'SaveInAllFormats'
+Name | Type | Value | Description
+------------ | ------------- | ------------- | -------------
+**ALWAYS_SAVE_AS_WOFF** | **String** | 'AlwaysSaveAsWOFF' | All referenced fonts will be saved and referenced as WOFF-fonts
+**ALWAYS_SAVE_AS_TTF** | **String** | 'AlwaysSaveAsTTF' | All referenced fonts will be saved and referenced as TTF-fonts
+**ALWAYS_SAVE_AS_EOT** | **String** | 'AlwaysSaveAsEOT' | All referenced fonts will be saved and referenced as EOT-fonts
+**SAVE_IN_ALL_FORMATS** | **String** | 'SaveInAllFormats' | All referenced fonts will be saved (and referenced in CSS) as 3 independent files : EOT, TTH,WOFF. It increases size of output data but makes output sutable for overhelming majority of web brawsers
 
 
 

data/docs/FontStyles.md

@@ -1,13 +1,13 @@
-# AsposePdfCloud::FontStyles
+# AsposePdfCloud::FontStyles
 Specifies style information applied to text.
 
 ## Enum
-Name | Type | Value
------------- | ------------- | -------------
-**REGULAR** | **String** | 'Regular'
-**BOLD** | **String** | 'Bold'
-**ITALIC** | **String** | 'Italic'
-**BOLD_ITALIC** | **String** | 'BoldItalic'
+Name | Type | Value | Description
+------------ | ------------- | ------------- | -------------
+**REGULAR** | **String** | 'Regular' | Regular text
+**BOLD** | **String** | 'Bold' | Bold text
+**ITALIC** | **String** | 'Italic' | Italic text
+**BOLD_ITALIC** | **String** | 'BoldItalic' | Bold Italic text