aspose_pdf_cloud 18.9.0 → 18.10.0

data/docs/Point.md

@@ -0,0 +1,10 @@
+# AsposePdfCloud::Point
+Represent point with fractional coordinates.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**x** | **Float** | X coordinate value. | 
+**y** | **Float** | Y coordinate value. | 
+
+

data/docs/PolyAnnotation.md

@@ -0,0 +1,28 @@
+# AsposePdfCloud::PolyAnnotation
+Provides PolyAnnotation.
+
+## 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) | Gets or sets the interior color with which to fill the annotation?s line endings. | [optional] 
+**starting_style** | [**LineEnding**](LineEnding.md) | Gets or sets the style of first line ending. | [optional] 
+**ending_style** | [**LineEnding**](LineEnding.md) | Gets or sets the style of second line ending. | [optional] 
+**intent** | [**PolyIntent**](PolyIntent.md) | Gets or sets the intent of the polygon or polyline annotation. | [optional] 
+**vertices** | [**Array<Point>**](Point.md) | Gets or sets an array of points representing the horizontal and vertical coordinates of each vertex. | [optional] 
+
+

data/docs/PolyIntent.md

@@ -0,0 +1,13 @@
+# AsposePdfCloud::PolyIntent
+Enumerates the intents of the polygon or polyline annotation.
+
+## Enum
+Name | Type | Value
+------------ | ------------- | -------------
+**UNDEFINED** | **String** | 'Undefined'
+**POLYGON_CLOUD** | **String** | 'PolygonCloud'
+**POLY_LINE_DIMENSION** | **String** | 'PolyLineDimension'
+**POLYGON_DIMENSION** | **String** | 'PolygonDimension'
+
+
+

data/docs/PolyLineAnnotation.md

@@ -0,0 +1,29 @@
+# AsposePdfCloud::PolyLineAnnotation
+Provides PolyLineAnnotation.
+
+## 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) | Gets or sets the interior color with which to fill the annotation?s line endings. | [optional] 
+**starting_style** | [**LineEnding**](LineEnding.md) | Gets or sets the style of first line ending. | [optional] 
+**ending_style** | [**LineEnding**](LineEnding.md) | Gets or sets the style of second line ending. | [optional] 
+**intent** | [**PolyIntent**](PolyIntent.md) | Gets or sets the intent of the polygon or polyline annotation. | [optional] 
+**vertices** | [**Array<Point>**](Point.md) | Gets or sets an array of points representing the horizontal and vertical coordinates of each vertex. | [optional] 
+**color** | [**Color**](Color.md) | Color of the annotation. | [optional] 
+
+

data/docs/PolyLineAnnotationResponse.md

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

data/docs/PolyLineAnnotations.md

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

data/docs/PolyLineAnnotationsResponse.md

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

data/docs/PolygonAnnotation.md

@@ -0,0 +1,29 @@
+# AsposePdfCloud::PolygonAnnotation
+Provides PolygonAnnotation.
+
+## 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) | Gets or sets the interior color with which to fill the annotation?s line endings. | [optional] 
+**starting_style** | [**LineEnding**](LineEnding.md) | Gets or sets the style of first line ending. | [optional] 
+**ending_style** | [**LineEnding**](LineEnding.md) | Gets or sets the style of second line ending. | [optional] 
+**intent** | [**PolyIntent**](PolyIntent.md) | Gets or sets the intent of the polygon or polyline annotation. | [optional] 
+**vertices** | [**Array<Point>**](Point.md) | Gets or sets an array of points representing the horizontal and vertical coordinates of each vertex. | [optional] 
+**color** | [**Color**](Color.md) | Color of the annotation. | [optional] 
+
+

data/docs/PolygonAnnotationResponse.md

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

data/docs/PolygonAnnotations.md

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

data/docs/PolygonAnnotationsResponse.md

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

data/docs/RasterImagesSavingModes.md

@@ -0,0 +1,15 @@
+# AsposePdfCloud::RasterImagesSavingModes
+Converted PDF can contain raster images(.png, *.jpeg etc.)
+This enum defines methods of how raster images can be handled
+during conversion of PDF to HTML
+            
+
+## Enum
+Name | Type | Value
+------------ | ------------- | -------------
+**AS_PNG_IMAGES_EMBEDDED_INTO_SVG** | **String** | 'AsPngImagesEmbeddedIntoSvg'
+**AS_EXTERNAL_PNG_FILES_REFERENCED_VIA_SVG** | **String** | 'AsExternalPngFilesReferencedViaSvg'
+**AS_EMBEDDED_PARTS_OF_PNG_PAGE_BACKGROUND** | **String** | 'AsEmbeddedPartsOfPngPageBackground'
+
+
+

data/docs/RectanglePdf.md

@@ -0,0 +1,12 @@
+# AsposePdfCloud::RectanglePdf
+Represents rectangle DTO.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**llx** | **Float** |  | 
+**lly** | **Float** |  | 
+**urx** | **Float** |  | 
+**ury** | **Float** |  | 
+
+

data/docs/Rotation.md

@@ -0,0 +1,13 @@
+# AsposePdfCloud::Rotation
+Enumeration of possible rotation values.
+
+## Enum
+Name | Type | Value
+------------ | ------------- | -------------
+**NONE** | **String** | 'None'
+**ON90** | **String** | 'on90'
+**ON180** | **String** | 'on180'
+**ON270** | **String** | 'on270'
+
+
+

data/docs/Segment.md

@@ -0,0 +1,10 @@
+# AsposePdfCloud::Segment
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** |  | 
+**text_state** | [**TextState**](TextState.md) |  | [optional] 
+
+

data/docs/ShapeType.md

@@ -0,0 +1,12 @@
+# AsposePdfCloud::ShapeType
+This enum represents shape type for the extracted images.
+
+## Enum
+Name | Type | Value
+------------ | ------------- | -------------
+**NONE** | **String** | 'None'
+**LANDSCAPE** | **String** | 'Landscape'
+**PORTRAIT** | **String** | 'Portrait'
+
+
+

data/docs/Signature.md

@@ -0,0 +1,21 @@
+# AsposePdfCloud::Signature
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**signature_path** | **String** | Gets or sets the signature path. | 
+**signature_type** | [**SignatureType**](SignatureType.md) | Gets or sets the type of the signature. | 
+**password** | **String** | Gets or sets the signature password. | [optional] 
+**appearance** | **String** | Sets or gets a graphic appearance for the signature. Property value represents an image file name. | [optional] 
+**reason** | **String** | Gets or sets the reason of the signature. | [optional] 
+**contact** | **String** | Gets or sets the contact of the signature. | [optional] 
+**location** | **String** | Gets or sets the location of the signature. | [optional] 
+**visible** | **BOOLEAN** | Gets or sets a value indicating whether this  is visible. Supports only when signing particular page. | 
+**rectangle** | [**RectanglePdf**](RectanglePdf.md) | Gets or sets the visible rectangle of the signature. Supports only when signing particular page. | [optional] 
+**form_field_name** | **String** | Gets or sets the name of the signature field. Supports only when signing document with particular form field. | [optional] 
+**authority** | **String** | Gets or sets the name of the person or authority signing the document.. | [optional] 
+**date** | **String** | Gets or sets the time of signing. | [optional] 
+**show_properties** | **BOOLEAN** | Gets or sets the showproperties in signature field | 
+
+

data/docs/SignatureType.md

@@ -0,0 +1,12 @@
+# AsposePdfCloud::SignatureType
+
+
+## Enum
+Name | Type | Value
+------------ | ------------- | -------------
+**PKCS1** | **String** | 'PKCS1'
+**PKCS7** | **String** | 'PKCS7'
+**PKCS7_DETACHED** | **String** | 'PKCS7Detached'
+
+
+

data/docs/SignatureVerifyResponse.md

@@ -0,0 +1,11 @@
+# AsposePdfCloud::SignatureVerifyResponse
+Returns also a message.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **Integer** | Response status code. | 
+**status** | **String** | Response status. | [optional] 
+**valid** | **BOOLEAN** | Valid sign. | [optional] 
+
+

data/docs/SplitResult.md

@@ -0,0 +1,9 @@
+# AsposePdfCloud::SplitResult
+Represents split result object.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**documents** | [**Array<SplitResultDocument>**](SplitResultDocument.md) | Gets or sets the list of documents. | [optional] 
+
+

data/docs/SplitResultDocument.md

@@ -0,0 +1,13 @@
+# AsposePdfCloud::SplitResultDocument
+Represents split result document,
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**href** | **String** | The "href" attribute contains the link's IRI. atom:link elements MUST have an href attribute, whose value MUST be a IRI reference | [optional] 
+**rel** | **String** | atom:link elements MAY have a "rel" attribute that indicates the link relation type.  If the "rel" attribute is not present, the link element MUST be interpreted as if the link relation type is "alternate". | [optional] 
+**type** | **String** | On the link element, the "type" attribute's value is an advisory media type: it is a hint about the type of the representation that is expected to be returned when the value of the href attribute is dereferenced.  Note that the type attribute does not override the actual media type returned with the representation. | [optional] 
+**title** | **String** | The "title" attribute conveys human-readable information about the link.  The content of the "title" attribute is Language-Sensitive. | [optional] 
+**id** | **Integer** | Gets or sets the page number. | [optional] 
+
+

data/docs/SplitResultResponse.md

@@ -0,0 +1,11 @@
+# AsposePdfCloud::SplitResultResponse
+Represents split result object.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **Integer** | Response status code. | 
+**status** | **String** | Response status. | [optional] 
+**result** | [**SplitResult**](SplitResult.md) | Gets or sets the splitting result. | [optional] 
+
+

data/docs/SquareAnnotation.md

@@ -0,0 +1,26 @@
+# AsposePdfCloud::SquareAnnotation
+Provides SquareAnnotation.
+
+## 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/SquareAnnotationResponse.md

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

data/docs/SquareAnnotations.md

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

data/docs/SquareAnnotationsResponse.md

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

data/docs/Stamp.md

@@ -0,0 +1,30 @@
+# AsposePdfCloud::Stamp
+Represents Pdf stamps.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | [**StampType**](StampType.md) | Gets the stamp type. | 
+**background** | **BOOLEAN** | Sets or gets a bool value that indicates the content is stamped as background. If the value is true, the stamp content is layed at the bottom. By defalt, the value is false, the stamp content is layed at the top. | [optional] 
+**bottom_margin** | **Float** | Gets or sets bottom margin of stamp. | [optional] 
+**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets or sets Horizontal alignment of stamp on the page.  | [optional] 
+**left_margin** | **Float** | Gets or sets left margin of stamp. | [optional] 
+**opacity** | **Float** | Gets or sets a value to indicate the stamp opacity. The value is from 0.0 to 1.0. By default the value is 1.0. | [optional] 
+**right_margin** | **Float** | Gets or sets right margin of stamp. | [optional] 
+**rotate** | [**Rotation**](Rotation.md) | Sets or gets the rotation of stamp content according  values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property.  If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None. | [optional] 
+**rotate_angle** | **Float** | Gets or sets rotate angle of stamp in degrees. This property allows to set arbitrary rotate angle.  | [optional] 
+**top_margin** | **Float** | Gets or sets top margin of stamp. | [optional] 
+**vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets or sets vertical alignment of stamp on page. | [optional] 
+**x_indent** | **Float** | Horizontal stamp coordinate, starting from the left. | [optional] 
+**y_indent** | **Float** | Vertical stamp coordinate, starting from the bottom. | [optional] 
+**zoom** | **Float** | Zooming factor of the stamp. Allows to scale stamp. | [optional] 
+**text_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Alignment of the text inside the stamp. | [optional] 
+**value** | **String** | Gets or sets string value which is used as stamp on the page. | [optional] 
+**text_state** | [**TextState**](TextState.md) | Gets text properties of the stamp. See  for details. | [optional] 
+**file_name** | **String** | Gets or sets the file name. | [optional] 
+**width** | **Float** | Gets or sets image width. Setting this property allos to scal image horizontally. | [optional] 
+**height** | **Float** | Gets or sets image height. Setting this image allows to scale image vertically. | [optional] 
+**page_index** | **Integer** | Gets or sets the index of the page. | [optional] 
+**starting_number** | **Integer** | Gets or sets value of the number of starting page. Other pages will be numbered starting from this value. | [optional] 
+
+