Skip to content

Commit 464d993

Browse files
kaferikaferi
committed
Add Model Docs
1 parent 3eb0bc4 commit 464d993

File tree

96 files changed

+1373
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

96 files changed

+1373
-0
lines changed

‎docs/Annotation.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Annotation
2+
Provides annotation.
3+
4+
*Inherited from [LinkElement](LinkElement.md)*
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**contents** | **string** | Get the annotation content. | [optional]
9+
**creationDate** | **string** | The date and time when the annotation was created. | [optional]
10+
**subject** | **string** | Get the annotation subject. | [optional]
11+
**title** | **string** | Get the annotation title. | [optional]
12+
**modified** | **string** | The date and time when the annotation was last modified. | [optional]
13+
**id** | **string** | Gets ID of the annotation. | [optional]
14+
**flags** | [**Array<AnnotationFlags>**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional]
15+
**name** | **string** | Gets Name of the annotation. | [optional]
16+
**rect** | [**RectanglePdf**](RectanglePdf.md) | Gets Rect of the annotation. |
17+
**pageIndex** | **number** | Gets PageIndex of the annotation. | [optional]
18+
**zIndex** | **number** | Gets ZIndex of the annotation. | [optional]
19+
**horizontalAlignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional]
20+
**verticalAlignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation. | [optional]
21+
**links** | [**Array<Link>**](Link.md) | Link to the document. (Inherited from **[LinkElement](LinkElement.md)**) | [optional]
22+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
23+

‎docs/AnnotationInfo.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# AnnotationInfo
2+
Provides annotation.
3+
4+
*Inherited from [Annotation](Annotation.md)*
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**annotationType** | [**AnnotationType**](AnnotationType.md) | Gets annotation type. |
9+
**contents** | **string** | Get the annotation content. (Inherited from **[Annotation](Annotation.md)**) | [optional]
10+
**creationDate** | **string** | The date and time when the annotation was created. (Inherited from **[Annotation](Annotation.md)**) | [optional]
11+
**subject** | **string** | Get the annotation subject. (Inherited from **[Annotation](Annotation.md)**) | [optional]
12+
**title** | **string** | Get the annotation title. (Inherited from **[Annotation](Annotation.md)**) | [optional]
13+
**modified** | **string** | The date and time when the annotation was last modified. (Inherited from **[Annotation](Annotation.md)**) | [optional]
14+
**id** | **string** | Gets ID of the annotation. (Inherited from **[Annotation](Annotation.md)**) | [optional]
15+
**flags** | [**Array<AnnotationFlags>**](AnnotationFlags.md) | Gets Flags of the annotation. (Inherited from **[Annotation](Annotation.md)**) | [optional]
16+
**name** | **string** | Gets Name of the annotation. (Inherited from **[Annotation](Annotation.md)**) | [optional]
17+
**rect** | [**RectanglePdf**](RectanglePdf.md) | Gets Rect of the annotation. (Inherited from **[Annotation](Annotation.md)**) |
18+
**pageIndex** | **number** | Gets PageIndex of the annotation. (Inherited from **[Annotation](Annotation.md)**) | [optional]
19+
**zIndex** | **number** | Gets ZIndex of the annotation. (Inherited from **[Annotation](Annotation.md)**) | [optional]
20+
**horizontalAlignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. (Inherited from **[Annotation](Annotation.md)**) | [optional]
21+
**verticalAlignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation. (Inherited from **[Annotation](Annotation.md)**) | [optional]
22+
**links** | [**Array<Link>**](Link.md) | Link to the document. (Inherited from **[LinkElement](LinkElement.md)**) | [optional]
23+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
24+

‎docs/AnnotationsInfo.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# AnnotationsInfo
2+
List of annotations.
3+
4+
*Inherited from [LinkElement](LinkElement.md)*
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**list** | [**Array<AnnotationInfo>**](AnnotationInfo.md) | | [optional]
9+
**links** | [**Array<Link>**](Link.md) | Link to the document. (Inherited from **[LinkElement](LinkElement.md)**) | [optional]
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)
11+

‎docs/AnnotationsInfoResponse.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# AnnotationsInfoResponse
2+
3+
4+
*Inherited from [AsposeResponse](AsposeResponse.md)*
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**annotations** | [**AnnotationsInfo**](AnnotationsInfo.md) | | [optional]
9+
**code** | **number** | Response status code. (Inherited from **[AsposeResponse](AsposeResponse.md)**) |
10+
**status** | **string** | Response status. (Inherited from **[AsposeResponse](AsposeResponse.md)**) | [optional]
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)
12+

‎docs/AppendDocument.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# AppendDocument
2+
Class for appendDocument service request building.
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**document** | **string** | Document to append (server path). |
8+
**startPage** | **number** | Appending start page. |
9+
**endPage** | **number** | Appending end page. |
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)
11+

‎docs/AsposeResponse.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# AsposeResponse
2+
Base class for all responses.
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**code** | **number** | Response status code. |
8+
**status** | **string** | Response status. | [optional]
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+

‎docs/Attachment.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Attachment
2+
Provides link to attachment.
3+
4+
*Inherited from [LinkElement](LinkElement.md)*
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**description** | **string** | Gets text associated with the attachment. | [optional]
9+
**mimeType** | **string** | Gets subtype of the attachment file. | [optional]
10+
**name** | **string** | Gets the name of the attachment. | [optional]
11+
**creationDate** | **string** | The date and time when the embedded file was created. | [optional]
12+
**modificationDate** | **string** | The date and time when the embedded file was last modified. | [optional]
13+
**size** | **number** | The size of the uncompressed embedded file, in bytes. |
14+
**checkSum** | **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]
15+
**links** | [**Array<Link>**](Link.md) | Link to the document. (Inherited from **[LinkElement](LinkElement.md)**) | [optional]
16+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
17+

‎docs/AttachmentResponse.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# AttachmentResponse
2+
3+
4+
*Inherited from [AsposeResponse](AsposeResponse.md)*
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**attachment** | [**Attachment**](Attachment.md) | | [optional]
9+
**code** | **number** | Response status code. (Inherited from **[AsposeResponse](AsposeResponse.md)**) |
10+
**status** | **string** | Response status. (Inherited from **[AsposeResponse](AsposeResponse.md)**) | [optional]
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)
12+

‎docs/Attachments.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Attachments
2+
List of attachment.
3+
4+
*Inherited from [LinkElement](LinkElement.md)*
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**list** | [**Array<LinkElement>**](LinkElement.md) | | [optional]
9+
**links** | [**Array<Link>**](Link.md) | Link to the document. (Inherited from **[LinkElement](LinkElement.md)**) | [optional]
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)
11+

‎docs/AttachmentsResponse.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# AttachmentsResponse
2+
3+
4+
*Inherited from [AsposeResponse](AsposeResponse.md)*
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**attachments** | [**Attachments**](Attachments.md) | | [optional]
9+
**code** | **number** | Response status code. (Inherited from **[AsposeResponse](AsposeResponse.md)**) |
10+
**status** | **string** | Response status. (Inherited from **[AsposeResponse](AsposeResponse.md)**) | [optional]
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)
12+

0 commit comments

Comments
 (0)