Skip to content

Commit 747ac74

Browse files
Merge pull request #11 from kaferi/master
Add docs
2 parents 287b4e3 + cef2207 commit 747ac74

File tree

108 files changed

+6009
-5
lines changed

Some content is hidden

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

108 files changed

+6009
-5
lines changed

.swagger-codegen-ignore

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@
2727
*.sh
2828
#.travis.yml
2929
.gitignore
30-
*.md
31-
docs/*
30+
#*.md
31+
#docs/*
3232
spec/**
3333
#spec/api/*
3434
#spec/models/*

README.md

Lines changed: 310 additions & 3 deletions
Large diffs are not rendered by default.

docs/Annotation.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# AsposePdfCloud::Annotation
2+
Provides annotation.
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional]
8+
**contents** | **String** | Get the annotation content. | [optional]
9+
**creation_date** | **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. | [optional]
17+
**page_index** | **Integer** | Gets PageIndex of the annotation. | [optional]
18+
**z_index** | **Integer** | Gets ZIndex of the annotation. | [optional]
19+
**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional]
20+
**vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation. | [optional]
21+
22+

docs/AnnotationFlags.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# AsposePdfCloud::AnnotationFlags
2+
A set of flags specifying various characteristics of the annotation.
3+
4+
## Enum
5+
Name | Type | Value
6+
------------ | ------------- | -------------
7+
**DEFAULT** | **String** | 'Default'
8+
**INVISIBLE** | **String** | 'Invisible'
9+
**HIDDEN** | **String** | 'Hidden'
10+
**PRINT** | **String** | 'Print'
11+
**NO_ZOOM** | **String** | 'NoZoom'
12+
**NO_ROTATE** | **String** | 'NoRotate'
13+
**NO_VIEW** | **String** | 'NoView'
14+
**READ_ONLY** | **String** | 'ReadOnly'
15+
**LOCKED** | **String** | 'Locked'
16+
**TOGGLE_NO_VIEW** | **String** | 'ToggleNoView'
17+
**LOCKED_CONTENTS** | **String** | 'LockedContents'
18+
19+
20+

docs/AnnotationInfo.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# AsposePdfCloud::AnnotationInfo
2+
Provides annotation.
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional]
8+
**contents** | **String** | Get the annotation content. | [optional]
9+
**creation_date** | **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. | [optional]
17+
**page_index** | **Integer** | Gets PageIndex of the annotation. | [optional]
18+
**z_index** | **Integer** | Gets ZIndex of the annotation. | [optional]
19+
**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional]
20+
**vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation. | [optional]
21+
**annotation_type** | [**AnnotationType**](AnnotationType.md) | Gets annotation type. | [optional]
22+
23+

docs/AnnotationState.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# AsposePdfCloud::AnnotationState
2+
The enumeration of states to which the original annotation can be set.
3+
4+
## Enum
5+
Name | Type | Value
6+
------------ | ------------- | -------------
7+
**UNDEFINED** | **String** | 'Undefined'
8+
**MARKED** | **String** | 'Marked'
9+
**UNMARKED** | **String** | 'Unmarked'
10+
**ACCEPTED** | **String** | 'Accepted'
11+
**REJECTED** | **String** | 'Rejected'
12+
**CANCELLED** | **String** | 'Cancelled'
13+
**COMPLETED** | **String** | 'Completed'
14+
**NONE** | **String** | 'None'
15+
16+
17+

docs/AnnotationType.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# AsposePdfCloud::AnnotationType
2+
3+
4+
## Enum
5+
Name | Type | Value
6+
------------ | ------------- | -------------
7+
**TEXT** | **String** | 'Text'
8+
**CIRCLE** | **String** | 'Circle'
9+
**POLYGON** | **String** | 'Polygon'
10+
**POLY_LINE** | **String** | 'PolyLine'
11+
**LINE** | **String** | 'Line'
12+
**SQUARE** | **String** | 'Square'
13+
**FREE_TEXT** | **String** | 'FreeText'
14+
**HIGHLIGHT** | **String** | 'Highlight'
15+
**UNDERLINE** | **String** | 'Underline'
16+
**SQUIGGLY** | **String** | 'Squiggly'
17+
**STRIKE_OUT** | **String** | 'StrikeOut'
18+
**CARET** | **String** | 'Caret'
19+
**INK** | **String** | 'Ink'
20+
**LINK** | **String** | 'Link'
21+
**POPUP** | **String** | 'Popup'
22+
**FILE_ATTACHMENT** | **String** | 'FileAttachment'
23+
**SOUND** | **String** | 'Sound'
24+
**MOVIE** | **String** | 'Movie'
25+
**SCREEN** | **String** | 'Screen'
26+
**WIDGET** | **String** | 'Widget'
27+
**WATERMARK** | **String** | 'Watermark'
28+
**TRAP_NET** | **String** | 'TrapNet'
29+
**PRINTER_MARK** | **String** | 'PrinterMark'
30+
**REDACTION** | **String** | 'Redaction'
31+
**STAMP** | **String** | 'Stamp'
32+
**RICH_MEDIA** | **String** | 'RichMedia'
33+
**UNKNOWN** | **String** | 'Unknown'
34+
**PDF3_D** | **String** | 'PDF3D'
35+
36+
37+

docs/AnnotationsInfo.md

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

docs/AnnotationsInfoResponse.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# AsposePdfCloud::AnnotationsInfoResponse
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**code** | **Integer** | Response status code. |
8+
**status** | **String** | Response status. | [optional]
9+
**annotations** | [**AnnotationsInfo**](AnnotationsInfo.md) | | [optional]
10+
11+

docs/AntialiasingProcessingType.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# AsposePdfCloud::AntialiasingProcessingType
2+
This enum describes possible antialiasing measures during conversion
3+
4+
## Enum
5+
Name | Type | Value
6+
------------ | ------------- | -------------
7+
**NO_ADDITIONAL_PROCESSING** | **String** | 'NoAdditionalProcessing'
8+
**TRY_CORRECT_RESULT_HTML** | **String** | 'TryCorrectResultHtml'
9+
10+
11+

0 commit comments

Comments
 (0)