aspose_pdf_cloud 18.9.0 → 18.10.0

data/docs/AnnotationState.md

@@ -0,0 +1,17 @@
+# AsposePdfCloud::AnnotationState
+The enumeration of states to which the original annotation can be set.
+
+## Enum
+Name | Type | Value
+------------ | ------------- | -------------
+**UNDEFINED** | **String** | 'Undefined'
+**MARKED** | **String** | 'Marked'
+**UNMARKED** | **String** | 'Unmarked'
+**ACCEPTED** | **String** | 'Accepted'
+**REJECTED** | **String** | 'Rejected'
+**CANCELLED** | **String** | 'Cancelled'
+**COMPLETED** | **String** | 'Completed'
+**NONE** | **String** | 'None'
+
+
+

data/docs/AnnotationType.md

@@ -0,0 +1,37 @@
+# AsposePdfCloud::AnnotationType
+
+
+## Enum
+Name | Type | Value
+------------ | ------------- | -------------
+**TEXT** | **String** | 'Text'
+**CIRCLE** | **String** | 'Circle'
+**POLYGON** | **String** | 'Polygon'
+**POLY_LINE** | **String** | 'PolyLine'
+**LINE** | **String** | 'Line'
+**SQUARE** | **String** | 'Square'
+**FREE_TEXT** | **String** | 'FreeText'
+**HIGHLIGHT** | **String** | 'Highlight'
+**UNDERLINE** | **String** | 'Underline'
+**SQUIGGLY** | **String** | 'Squiggly'
+**STRIKE_OUT** | **String** | 'StrikeOut'
+**CARET** | **String** | 'Caret'
+**INK** | **String** | 'Ink'
+**LINK** | **String** | 'Link'
+**POPUP** | **String** | 'Popup'
+**FILE_ATTACHMENT** | **String** | 'FileAttachment'
+**SOUND** | **String** | 'Sound'
+**MOVIE** | **String** | 'Movie'
+**SCREEN** | **String** | 'Screen'
+**WIDGET** | **String** | 'Widget'
+**WATERMARK** | **String** | 'Watermark'
+**TRAP_NET** | **String** | 'TrapNet'
+**PRINTER_MARK** | **String** | 'PrinterMark'
+**REDACTION** | **String** | 'Redaction'
+**STAMP** | **String** | 'Stamp'
+**RICH_MEDIA** | **String** | 'RichMedia'
+**UNKNOWN** | **String** | 'Unknown'
+**PDF3_D** | **String** | 'PDF3D'
+
+
+

data/docs/AnnotationsInfo.md

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

data/docs/AnnotationsInfoResponse.md

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

data/docs/AntialiasingProcessingType.md

@@ -0,0 +1,11 @@
+# AsposePdfCloud::AntialiasingProcessingType
+This enum describes possible antialiasing measures during conversion
+
+## Enum
+Name | Type | Value
+------------ | ------------- | -------------
+**NO_ADDITIONAL_PROCESSING** | **String** | 'NoAdditionalProcessing'
+**TRY_CORRECT_RESULT_HTML** | **String** | 'TryCorrectResultHtml'
+
+
+

data/docs/AppendDocument.md

@@ -0,0 +1,11 @@
+# AsposePdfCloud::AppendDocument
+Class for appendDocument service request building.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**document** | **String** | Document to append (server path). | 
+**start_page** | **Integer** | Appending start page. | 
+**end_page** | **Integer** | Appending end page. | 
+
+

data/docs/AsposeResponse.md

@@ -0,0 +1,10 @@
+# AsposePdfCloud::AsposeResponse
+Base class for all responses.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **Integer** | Response status code. | 
+**status** | **String** | Response status. | [optional] 
+
+

data/docs/Attachment.md

@@ -0,0 +1,16 @@
+# AsposePdfCloud::Attachment
+Provides link to attachment.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional] 
+**description** | **String** | Gets text associated with the attachment.  | [optional] 
+**mime_type** | **String** | Gets subtype of the attachment file. | [optional] 
+**name** | **String** | Gets the name of the attachment.  | [optional] 
+**creation_date** | **String** | The date and time when the embedded file was created. | [optional] 
+**modification_date** | **String** | The date and time when the embedded file was last modified. | [optional] 
+**size** | **Integer** | The size of the uncompressed embedded file, in bytes. | [optional] 
+**check_sum** | **String** | A 16-byte string that is the checksum of the bytes of the uncompressed embedded file.  The checksum is calculated by applying the standard MD5 message-digest algorithm  to the bytes of the embedded file stream. | [optional] 
+
+

data/docs/AttachmentResponse.md

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

data/docs/Attachments.md

@@ -0,0 +1,10 @@
+# AsposePdfCloud::Attachments
+List of attachment.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional] 
+**list** | [**Array<LinkElement>**](LinkElement.md) |  | [optional] 
+
+

data/docs/AttachmentsResponse.md

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

data/docs/CaptionPosition.md

@@ -0,0 +1,11 @@
+# AsposePdfCloud::CaptionPosition
+Enumeration of the annotation?s caption positioning.
+
+## Enum
+Name | Type | Value
+------------ | ------------- | -------------
+**INLINE** | **String** | 'Inline'
+**TOP** | **String** | 'Top'
+
+
+

data/docs/CircleAnnotation.md

@@ -0,0 +1,26 @@
+# AsposePdfCloud::CircleAnnotation
+Provides CircleAnnotation.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional] 
+**contents** | **String** | Get the annotation content. | [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] 
+**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** | [**RectanglePdf**](RectanglePdf.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] 
+**rich_text** | **String** | Get the annotation RichText. | [optional] 
+**interior_color** | [**Color**](Color.md) | Get the annotation InteriorColor. | [optional] 
+**frame** | [**RectanglePdf**](RectanglePdf.md) | Get or set the annotation Rectangle of frame. | [optional] 
+**color** | [**Color**](Color.md) | Color of the annotation. | [optional] 
+
+

data/docs/CircleAnnotationResponse.md

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

data/docs/CircleAnnotations.md

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

data/docs/CircleAnnotationsResponse.md

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

data/docs/Color.md

@@ -0,0 +1,12 @@
+# AsposePdfCloud::Color
+Represents color DTO.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**a** | **Integer** |  | 
+**r** | **Integer** |  | 
+**g** | **Integer** |  | 
+**b** | **Integer** |  | 
+
+

data/docs/ColorDepth.md

@@ -0,0 +1,13 @@
+# AsposePdfCloud::ColorDepth
+Used to specify the parameter value passed to a Tiff image device.
+
+## Enum
+Name | Type | Value
+------------ | ------------- | -------------
+**DEFAULT** | **String** | 'Default'
+**FORMAT8BPP** | **String** | 'Format8bpp'
+**FORMAT4BPP** | **String** | 'Format4bpp'
+**FORMAT1BPP** | **String** | 'Format1bpp'
+
+
+

data/docs/CommonFigureAnnotation.md

@@ -0,0 +1,25 @@
+# AsposePdfCloud::CommonFigureAnnotation
+Provides CommonFigureAnnotation.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional] 
+**contents** | **String** | Get the annotation content. | [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] 
+**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** | [**RectanglePdf**](RectanglePdf.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] 
+**rich_text** | **String** | Get the annotation RichText. | [optional] 
+**interior_color** | [**Color**](Color.md) | Get the annotation InteriorColor. | [optional] 
+**frame** | [**RectanglePdf**](RectanglePdf.md) | Get or set the annotation Rectangle of frame. | [optional] 
+
+

data/docs/CompressionType.md

@@ -0,0 +1,14 @@
+# AsposePdfCloud::CompressionType
+Used to specify the parameter value passed to a Tiff image device.
+
+## Enum
+Name | Type | Value
+------------ | ------------- | -------------
+**LZW** | **String** | 'LZW'
+**CCITT4** | **String** | 'CCITT4'
+**CCITT3** | **String** | 'CCITT3'
+**RLE** | **String** | 'RLE'
+**NONE** | **String** | 'None'
+
+
+

data/docs/DocFormat.md

@@ -0,0 +1,11 @@
+# AsposePdfCloud::DocFormat
+Allows to specify .doc or .docx file format.
+
+## Enum
+Name | Type | Value
+------------ | ------------- | -------------
+**DOC** | **String** | 'Doc'
+**DOC_X** | **String** | 'DocX'
+
+
+

data/docs/DocRecognitionMode.md

@@ -0,0 +1,11 @@
+# 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'
+
+
+

data/docs/Document.md

@@ -0,0 +1,11 @@
+# AsposePdfCloud::Document
+Represents document DTO.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional] 
+**document_properties** | [**DocumentProperties**](DocumentProperties.md) | Document properties. | [optional] 
+**pages** | [**Pages**](Pages.md) | Document pages. | [optional] 
+
+

data/docs/DocumentPageResponse.md

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

data/docs/DocumentPagesResponse.md

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

data/docs/DocumentPrivilege.md

@@ -0,0 +1,19 @@
+# AsposePdfCloud::DocumentPrivilege
+Represents the privileges for accessing Pdf file./>.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**allow_print** | **BOOLEAN** | Sets the permission which allow print or not.  true is allow and false or not set is forbidden. | [optional] 
+**allow_degraded_printing** | **BOOLEAN** | Sets the permission which allow degraded printing or not.  true is allow and false or not set is forbidden. | [optional] 
+**allow_modify_contents** | **BOOLEAN** | Sets the permission which allow modify contents or not.  true is allow and false or not set is forbidden. | [optional] 
+**allow_copy** | **BOOLEAN** | Sets the permission which allow copy or not.  true is allow and false or not set is forbidden. | [optional] 
+**allow_modify_annotations** | **BOOLEAN** | Sets the permission which allow modify annotations or not.  true is allow and false or not set is forbidden. | [optional] 
+**allow_fill_in** | **BOOLEAN** | Sets the permission which allow fill in forms or not.  true is allow and false or not set is forbidden. | [optional] 
+**allow_screen_readers** | **BOOLEAN** | Sets the permission which allow screen readers or not.  true is allow and false or not set is forbidden. | [optional] 
+**allow_assembly** | **BOOLEAN** | Sets the permission which allow assembly or not.  true is allow and false or not set is forbidden. | [optional] 
+**print_allow_level** | **Integer** | Sets the print level of  document's privilege. Just as the Adobe Professional's Printing Allowed settings. 0: None. 1: Low Resolution (150 dpi). 2: High Resolution. | [optional] 
+**change_allow_level** | **Integer** | Sets the change level of  document's privilege. Just as the Adobe Professional's Changes Allowed settings. 0: None. 1: Inserting, Deleting and Rotating pages. 2: Filling in form fields and signing existing signature fields. 3: Commenting, filling in form fields, and signing existing signature fields. 4: Any except extracting pages. | [optional] 
+**copy_allow_level** | **Integer** | Sets the copy level of  document's privilege. Just as the Adobe Professional's permission settings. 0: None. 1: Enable text access for screen reader devices for the visually impaired. 2: Enable copying of text, images and other content. | [optional] 
+
+

data/docs/DocumentProperties.md

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

data/docs/DocumentPropertiesResponse.md

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

data/docs/DocumentProperty.md

@@ -0,0 +1,12 @@
+# 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] 
+
+