Merge pull request #11 from kaferi/master

Add enum descriptions

Author: evgeny-porodnov

README.md

@@ -1,4 +1,4 @@
-# Aspose.PDF Cloud
+# Aspose.PDF Cloud
 - API version: 2.0
 - Package version: 18.11.0
 

asposepdfcloud/apis/pdf_api.py

@@ -9893,7 +9893,7 @@ def get_pdf_in_storage_to_epub(self, name, **kwargs):
         :param callback function: The callback function
             for asynchronous request. (optional)
         :param str name: The document name. (required)
-        :param str content_recognition_mode: ?roperty tunes conversion for this or that desirable method of recognition of content.
+        :param str content_recognition_mode: Рroperty tunes conversion for this or that desirable method of recognition of content.
         :param str folder: The document folder.
         :param str storage: The document storage.
         :return: file
@@ -9921,7 +9921,7 @@ def get_pdf_in_storage_to_epub_with_http_info(self, name, **kwargs):
         :param callback function: The callback function
             for asynchronous request. (optional)
         :param str name: The document name. (required)
-        :param str content_recognition_mode: ?roperty tunes conversion for this or that desirable method of recognition of content.
+        :param str content_recognition_mode: Рroperty tunes conversion for this or that desirable method of recognition of content.
         :param str folder: The document folder.
         :param str storage: The document storage.
         :return: file
@@ -21091,7 +21091,7 @@ def put_pdf_in_request_to_epub(self, out_path, **kwargs):
         :param callback function: The callback function
             for asynchronous request. (optional)
         :param str out_path: Full resulting filename (ex. /folder1/folder2/result.epub) (required)
-        :param str content_recognition_mode: ?roperty tunes conversion for this or that desirable method of recognition of content.
+        :param str content_recognition_mode: Рroperty tunes conversion for this or that desirable method of recognition of content.
         :param str storage: The document storage.
         :param file file: A file to be converted.
         :return: AsposeResponse
@@ -21119,7 +21119,7 @@ def put_pdf_in_request_to_epub_with_http_info(self, out_path, **kwargs):
         :param callback function: The callback function
             for asynchronous request. (optional)
         :param str out_path: Full resulting filename (ex. /folder1/folder2/result.epub) (required)
-        :param str content_recognition_mode: ?roperty tunes conversion for this or that desirable method of recognition of content.
+        :param str content_recognition_mode: Рroperty tunes conversion for this or that desirable method of recognition of content.
         :param str storage: The document storage.
         :param file file: A file to be converted.
         :return: AsposeResponse
@@ -22687,7 +22687,7 @@ def put_pdf_in_storage_to_epub(self, name, out_path, **kwargs):
             for asynchronous request. (optional)
         :param str name: The document name. (required)
         :param str out_path: Full resulting filename (ex. /folder1/folder2/result.epub) (required)
-        :param str content_recognition_mode: ?roperty tunes conversion for this or that desirable method of recognition of content.
+        :param str content_recognition_mode: Рroperty tunes conversion for this or that desirable method of recognition of content.
         :param str folder: The document folder.
         :param str storage: The document storage.
         :return: AsposeResponse
@@ -22716,7 +22716,7 @@ def put_pdf_in_storage_to_epub_with_http_info(self, name, out_path, **kwargs):
             for asynchronous request. (optional)
         :param str name: The document name. (required)
         :param str out_path: Full resulting filename (ex. /folder1/folder2/result.epub) (required)
-        :param str content_recognition_mode: ?roperty tunes conversion for this or that desirable method of recognition of content.
+        :param str content_recognition_mode: Рroperty tunes conversion for this or that desirable method of recognition of content.
         :param str folder: The document folder.
         :param str storage: The document storage.
         :return: AsposeResponse

asposepdfcloud/models/poly_annotation.py

@@ -509,7 +509,7 @@ def rich_text(self, rich_text):
     def interior_color(self):
         """
         Gets the interior_color of this PolyAnnotation.
-        Gets or sets the interior color with which to fill the annotation?s line endings.
+        Gets or sets the interior color with which to fill the annotation’s line endings.
 
         :return: The interior_color of this PolyAnnotation.
         :rtype: Color
@@ -520,7 +520,7 @@ def interior_color(self):
     def interior_color(self, interior_color):
         """
         Sets the interior_color of this PolyAnnotation.
-        Gets or sets the interior color with which to fill the annotation?s line endings.
+        Gets or sets the interior color with which to fill the annotation’s line endings.
 
         :param interior_color: The interior_color of this PolyAnnotation.
         :type: Color

asposepdfcloud/models/poly_line_annotation.py

@@ -514,7 +514,7 @@ def rich_text(self, rich_text):
     def interior_color(self):
         """
         Gets the interior_color of this PolyLineAnnotation.
-        Gets or sets the interior color with which to fill the annotation?s line endings.
+        Gets or sets the interior color with which to fill the annotation’s line endings.
 
         :return: The interior_color of this PolyLineAnnotation.
         :rtype: Color
@@ -525,7 +525,7 @@ def interior_color(self):
     def interior_color(self, interior_color):
         """
         Sets the interior_color of this PolyLineAnnotation.
-        Gets or sets the interior color with which to fill the annotation?s line endings.
+        Gets or sets the interior color with which to fill the annotation’s line endings.
 
         :param interior_color: The interior_color of this PolyLineAnnotation.
         :type: Color

asposepdfcloud/models/polygon_annotation.py

@@ -514,7 +514,7 @@ def rich_text(self, rich_text):
     def interior_color(self):
         """
         Gets the interior_color of this PolygonAnnotation.
-        Gets or sets the interior color with which to fill the annotation?s line endings.
+        Gets or sets the interior color with which to fill the annotation’s line endings.
 
         :return: The interior_color of this PolygonAnnotation.
         :rtype: Color
@@ -525,7 +525,7 @@ def interior_color(self):
     def interior_color(self, interior_color):
         """
         Sets the interior_color of this PolygonAnnotation.
-        Gets or sets the interior color with which to fill the annotation?s line endings.
+        Gets or sets the interior color with which to fill the annotation’s line endings.
 
         :param interior_color: The interior_color of this PolygonAnnotation.
         :type: Color

docs/Annotation.md

@@ -1,4 +1,4 @@
-# Annotation
+# Annotation
 Provides annotation.
 
 ## Properties

docs/AnnotationFlags.md

@@ -1,20 +1,20 @@
-# AnnotationFlags
+# AnnotationFlags
 A set of flags specifying various characteristics of the annotation.
 
 ## Enum
-Name | Type | Value
------------- | ------------- | -------------
-**DEFAULT** | **str** | "Default"
-**INVISIBLE** | **str** | "Invisible"
-**HIDDEN** | **str** | "Hidden"
-**PRINT** | **str** | "Print"
-**NOZOOM** | **str** | "NoZoom"
-**NOROTATE** | **str** | "NoRotate"
-**NOVIEW** | **str** | "NoView"
-**READONLY** | **str** | "ReadOnly"
-**LOCKED** | **str** | "Locked"
-**TOGGLENOVIEW** | **str** | "ToggleNoView"
-**LOCKEDCONTENTS** | **str** | "LockedContents"
+Name | Type | Value | Description
+------------ | ------------- | ------------- | -------------
+**DEFAULT** | **str** | "Default" | Default value.
+**INVISIBLE** | **str** | "Invisible" | If set, do not display the annotation if it does not belong to one of the standard annotation types and no annotation handler is available. If clear, display such an unknown annotation using an appearance stream specified by its appearance dictionary, if any.
+**HIDDEN** | **str** | "Hidden" | If set, do not display or print the annotation or allow it to interact with the user, regardless of its annotation type or whether an annotation handler is available. In cases where screen space is limited, the ability to hide and show annotations selectively can be used in combination with appearance streams to display auxiliary pop-up information similar in function to online help systems.
+**PRINT** | **str** | "Print" | If set, print the annotation when the page is printed. If clear, never print the annotation, regardless of whether it is displayed on the screen. This can be useful, for example, for annotations representing interactive pushbuttons, which would serve no meaningful purpose on the printed page.
+**NOZOOM** | **str** | "NoZoom" | If set, do not scale the annotation’s appearance to match the magnification of the page. The location of the annotation on the page (defined by the upper-left corner of its annotation rectangle) remains fixed, regardless of the page magnification.
+**NOROTATE** | **str** | "NoRotate" | If set, do not rotate the annotation’s appearance to match the rotation of the page. The upper-left corner of the annotation rectangle remains in a fixed location on the page, regardless of the page rotation.
+**NOVIEW** | **str** | "NoView" | If set, do not display the annotation on the screen or allow it to interact with the user. The annotation may be printed (depending on the setting of the Print flag) but should be considered hidden for purposes of on-screen display and user interaction.
+**READONLY** | **str** | "ReadOnly" | If set, do not allow the annotation to interact with the user. The annotation may be displayed or printed (depending on the settings of the NoView and Print flags) but should not respond to mouse clicks or change its appearance in response to mouse motions. This flag is ignored for widget annotations; its function is subsumed by the ReadOnly flag of the associated form field.
+**LOCKED** | **str** | "Locked" | If set, do not allow the annotation to be deleted or its properties (including position and size) to be modified by the user. However, this flag does not restrict changes to the annotation’s contents, such as the value of a form field.
+**TOGGLENOVIEW** | **str** | "ToggleNoView" | If set, invert the interpretation of the NoView flag for certain events. A typical use is to have an annotation that appears only when a mouse cursor is held over it.
+**LOCKEDCONTENTS** | **str** | "LockedContents" | If set, do not allow the contents of the annotation to be modified by the user. This flag does not restrict deletion of the annotation or changes to other annotation properties, such as position and size.
 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/AnnotationInfo.md

@@ -1,4 +1,4 @@
-# AnnotationInfo
+# AnnotationInfo
 Provides annotation.
 
 ## Properties

docs/AnnotationState.md

@@ -1,17 +1,17 @@
-# AnnotationState
+# AnnotationState
 The enumeration of states to which the original annotation can be set.
 
 ## Enum
-Name | Type | Value
------------- | ------------- | -------------
-**UNDEFINED** | **str** | "Undefined"
-**MARKED** | **str** | "Marked"
-**UNMARKED** | **str** | "Unmarked"
-**ACCEPTED** | **str** | "Accepted"
-**REJECTED** | **str** | "Rejected"
-**CANCELLED** | **str** | "Cancelled"
-**COMPLETED** | **str** | "Completed"
-**NONE** | **str** | "None"
+Name | Type | Value | Description
+------------ | ------------- | ------------- | -------------
+**UNDEFINED** | **str** | "Undefined" | Not defined state.
+**MARKED** | **str** | "Marked" | The annotation has been marked by the user.
+**UNMARKED** | **str** | "Unmarked" | The annotation has not been marked by the user.
+**ACCEPTED** | **str** | "Accepted" | The user agrees with the change.
+**REJECTED** | **str** | "Rejected" | The user disagrees with the change.
+**CANCELLED** | **str** | "Cancelled" | The change has been cancelled.
+**COMPLETED** | **str** | "Completed" | The change has been completed.
+**NONE** | **str** | "None" | The user has indicated nothing about the change.
 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/AnnotationType.md

@@ -1,37 +1,37 @@
-# AnnotationType
+# AnnotationType
 
 
 ## Enum
-Name | Type | Value
------------- | ------------- | -------------
-**TEXT** | **str** | "Text"
-**CIRCLE** | **str** | "Circle"
-**POLYGON** | **str** | "Polygon"
-**POLYLINE** | **str** | "PolyLine"
-**LINE** | **str** | "Line"
-**SQUARE** | **str** | "Square"
-**FREETEXT** | **str** | "FreeText"
-**HIGHLIGHT** | **str** | "Highlight"
-**UNDERLINE** | **str** | "Underline"
-**SQUIGGLY** | **str** | "Squiggly"
-**STRIKEOUT** | **str** | "StrikeOut"
-**CARET** | **str** | "Caret"
-**INK** | **str** | "Ink"
-**LINK** | **str** | "Link"
-**POPUP** | **str** | "Popup"
-**FILEATTACHMENT** | **str** | "FileAttachment"
-**SOUND** | **str** | "Sound"
-**MOVIE** | **str** | "Movie"
-**SCREEN** | **str** | "Screen"
-**WIDGET** | **str** | "Widget"
-**WATERMARK** | **str** | "Watermark"
-**TRAPNET** | **str** | "TrapNet"
-**PRINTERMARK** | **str** | "PrinterMark"
-**REDACTION** | **str** | "Redaction"
-**STAMP** | **str** | "Stamp"
-**RICHMEDIA** | **str** | "RichMedia"
-**UNKNOWN** | **str** | "Unknown"
-**PDF3D** | **str** | "PDF3D"
+Name | Type | Value | Description
+------------ | ------------- | ------------- | -------------
+**TEXT** | **str** | "Text" | Text annotation type.
+**CIRCLE** | **str** | "Circle" | Circle annotation type.
+**POLYGON** | **str** | "Polygon" | Polygon annotation type.
+**POLYLINE** | **str** | "PolyLine" | Plyline annotation type.
+**LINE** | **str** | "Line" | Line annotation type.
+**SQUARE** | **str** | "Square" | Square annotatotion type.
+**FREETEXT** | **str** | "FreeText" | Free text annotation type.
+**HIGHLIGHT** | **str** | "Highlight" | Highlight annotation type.
+**UNDERLINE** | **str** | "Underline" | Underline annotation type.
+**SQUIGGLY** | **str** | "Squiggly" | Squiggle annotation type.
+**STRIKEOUT** | **str** | "StrikeOut" | Strikeout annotation type.
+**CARET** | **str** | "Caret" | Caret annotation type.
+**INK** | **str** | "Ink" | Ink annotation type.
+**LINK** | **str** | "Link" | Link annotation type.
+**POPUP** | **str** | "Popup" | Popup annotation type.
+**FILEATTACHMENT** | **str** | "FileAttachment" | File attachment annotation type.
+**SOUND** | **str** | "Sound" | Sound annotation type.
+**MOVIE** | **str** | "Movie" | Movie annotation type.
+**SCREEN** | **str** | "Screen" | Screen annotation type.
+**WIDGET** | **str** | "Widget" | Widget annotation type.
+**WATERMARK** | **str** | "Watermark" | Watermark annotation type.
+**TRAPNET** | **str** | "TrapNet" | Trap network annotation type.
+**PRINTERMARK** | **str** | "PrinterMark" | Printer mark annotation type.
+**REDACTION** | **str** | "Redaction" | Redaction annotation type.
+**STAMP** | **str** | "Stamp" | Rubber stamp annotation type.
+**RICHMEDIA** | **str** | "RichMedia" | Rich media annotation type
+**UNKNOWN** | **str** | "Unknown" | Unknown annotation.
+**PDF3D** | **str** | "PDF3D" | 
 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)