Skip to content

Commit 47ba05d

Browse files
evgeny-porodnovevgeny-porodnov
authored
Merge pull request #8 from kaferi/master
Add docs
2 parents 567feac + bac4170 commit 47ba05d

File tree

108 files changed

+6221
-4
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

+6221
-4
lines changed

‎.swagger-codegen-ignore‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@
2525
*.sh
2626
.travis.yml
2727
.gitignore
28-
*.md
29-
docs/**
28+
#*.md
29+
#docs/**
3030
test/**
3131

3232
# Ignore other files and folders

‎README.md‎

Lines changed: 312 additions & 2 deletions
Large diffs are not rendered by default.

‎docs/Annotation.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Annotation
2+
Provides annotation.
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**links** | [**list[Link]**](Link.md) | Link to the document. | [optional]
8+
**contents** | **str** | Get the annotation content. | [optional]
9+
**creation_date** | **str** | The date and time when the annotation was created. | [optional]
10+
**subject** | **str** | Get the annotation subject. | [optional]
11+
**title** | **str** | Get the annotation title. | [optional]
12+
**modified** | **str** | The date and time when the annotation was last modified. | [optional]
13+
**id** | **str** | Gets ID of the annotation. | [optional]
14+
**flags** | [**list[AnnotationFlags]**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional]
15+
**name** | **str** | Gets Name of the annotation. | [optional]
16+
**rect** | [**RectanglePdf**](RectanglePdf.md) | Gets Rect of the annotation. | [optional]
17+
**page_index** | **int** | Gets PageIndex of the annotation. | [optional]
18+
**z_index** | **int** | 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+
[[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+
24+

‎docs/AnnotationFlags.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# AnnotationFlags
2+
A set of flags specifying various characteristics of the annotation.
3+
4+
## Enum
5+
Name | Type | Value
6+
------------ | ------------- | -------------
7+
**DEFAULT** | **str** | "Default"
8+
**INVISIBLE** | **str** | "Invisible"
9+
**HIDDEN** | **str** | "Hidden"
10+
**PRINT** | **str** | "Print"
11+
**NOZOOM** | **str** | "NoZoom"
12+
**NOROTATE** | **str** | "NoRotate"
13+
**NOVIEW** | **str** | "NoView"
14+
**READONLY** | **str** | "ReadOnly"
15+
**LOCKED** | **str** | "Locked"
16+
**TOGGLENOVIEW** | **str** | "ToggleNoView"
17+
**LOCKEDCONTENTS** | **str** | "LockedContents"
18+
19+
20+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
21+
22+

‎docs/AnnotationInfo.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# AnnotationInfo
2+
Provides annotation.
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**links** | [**list[Link]**](Link.md) | Link to the document. | [optional]
8+
**contents** | **str** | Get the annotation content. | [optional]
9+
**creation_date** | **str** | The date and time when the annotation was created. | [optional]
10+
**subject** | **str** | Get the annotation subject. | [optional]
11+
**title** | **str** | Get the annotation title. | [optional]
12+
**modified** | **str** | The date and time when the annotation was last modified. | [optional]
13+
**id** | **str** | Gets ID of the annotation. | [optional]
14+
**flags** | [**list[AnnotationFlags]**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional]
15+
**name** | **str** | Gets Name of the annotation. | [optional]
16+
**rect** | [**RectanglePdf**](RectanglePdf.md) | Gets Rect of the annotation. | [optional]
17+
**page_index** | **int** | Gets PageIndex of the annotation. | [optional]
18+
**z_index** | **int** | 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+
[[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+
25+

‎docs/AnnotationState.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# AnnotationState
2+
The enumeration of states to which the original annotation can be set.
3+
4+
## Enum
5+
Name | Type | Value
6+
------------ | ------------- | -------------
7+
**UNDEFINED** | **str** | "Undefined"
8+
**MARKED** | **str** | "Marked"
9+
**UNMARKED** | **str** | "Unmarked"
10+
**ACCEPTED** | **str** | "Accepted"
11+
**REJECTED** | **str** | "Rejected"
12+
**CANCELLED** | **str** | "Cancelled"
13+
**COMPLETED** | **str** | "Completed"
14+
**NONE** | **str** | "None"
15+
16+
17+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
18+
19+

‎docs/AnnotationType.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# AnnotationType
2+
3+
4+
## Enum
5+
Name | Type | Value
6+
------------ | ------------- | -------------
7+
**TEXT** | **str** | "Text"
8+
**CIRCLE** | **str** | "Circle"
9+
**POLYGON** | **str** | "Polygon"
10+
**POLYLINE** | **str** | "PolyLine"
11+
**LINE** | **str** | "Line"
12+
**SQUARE** | **str** | "Square"
13+
**FREETEXT** | **str** | "FreeText"
14+
**HIGHLIGHT** | **str** | "Highlight"
15+
**UNDERLINE** | **str** | "Underline"
16+
**SQUIGGLY** | **str** | "Squiggly"
17+
**STRIKEOUT** | **str** | "StrikeOut"
18+
**CARET** | **str** | "Caret"
19+
**INK** | **str** | "Ink"
20+
**LINK** | **str** | "Link"
21+
**POPUP** | **str** | "Popup"
22+
**FILEATTACHMENT** | **str** | "FileAttachment"
23+
**SOUND** | **str** | "Sound"
24+
**MOVIE** | **str** | "Movie"
25+
**SCREEN** | **str** | "Screen"
26+
**WIDGET** | **str** | "Widget"
27+
**WATERMARK** | **str** | "Watermark"
28+
**TRAPNET** | **str** | "TrapNet"
29+
**PRINTERMARK** | **str** | "PrinterMark"
30+
**REDACTION** | **str** | "Redaction"
31+
**STAMP** | **str** | "Stamp"
32+
**RICHMEDIA** | **str** | "RichMedia"
33+
**UNKNOWN** | **str** | "Unknown"
34+
**PDF3D** | **str** | "PDF3D"
35+
36+
37+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
38+
39+

‎docs/AnnotationsInfo.md‎

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

‎docs/AnnotationsInfoResponse.md‎

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

‎docs/AntialiasingProcessingType.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# AntialiasingProcessingType
2+
This enum describes possible antialiasing measures during conversion
3+
4+
## Enum
5+
Name | Type | Value
6+
------------ | ------------- | -------------
7+
**NOADDITIONALPROCESSING** | **str** | "NoAdditionalProcessing"
8+
**TRYCORRECTRESULTHTML** | **str** | "TryCorrectResultHtml"
9+
10+
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+
13+

0 commit comments

Comments
 (0)