Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 36 additions & 23 deletions README.md

Large diffs are not rendered by default.

27 changes: 27 additions & 0 deletions docs/Bookmark.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Bookmark
Provides link to bookmark.

*Inherited from [LinkElement](LinkElement.md)*
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**title** | **string** | Get the Title; | [optional]
**italic** | **boolean** | Is bookmark italic. | [optional]
**bold** | **boolean** | Is bookmark bold. | [optional]
**color** | [**Color**](Color.md) | Get the color | [optional]
**action** | **string** | Gets or sets the action bound with the bookmark. If PageNumber is presented the action can not be specified. The action type includes: "GoTo", "GoToR", "Launch", "Named". | [optional]
**level** | **number** | Gets or sets bookmark's hierarchy level. | [optional]
**destination** | **string** | Gets or sets bookmark's destination page. Required if action is set as string.Empty. | [optional]
**pageDisplay** | **string** | Gets or sets the type of display bookmark's destination page. | [optional]
**pageDisplay_Bottom** | **number** | Gets or sets the bottom coordinate of page display. | [optional]
**pageDisplay_Left** | **number** | Gets or sets the left coordinate of page display. | [optional]
**pageDisplay_Right** | **number** | Gets or sets the right coordinate of page display. | [optional]
**pageDisplay_Top** | **number** | Gets or sets the top coordinate of page display. | [optional]
**pageDisplay_Zoom** | **number** | Gets or sets the zoom factor of page display. | [optional]
**pageNumber** | **number** | Gets or sets the number of bookmark's destination page. | [optional]
**remoteFile** | **string** | Gets or sets the file (path) which is required for "GoToR" action of bookmark. | [optional]
**bookmarks** | [**Bookmarks**](Bookmarks.md) | The children bookmarks. | [optional]
**links** | [**Array&lt;Link&gt;**](Link.md) | Link to the document.<br />*Inherited from [LinkElement](LinkElement.md)* | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/bookmark.ts)

8 changes: 4 additions & 4 deletions docs/FileExistResponse.md → docs/BookmarkResponse.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# FileExistResponse

# BookmarkResponse
Represents response containing single bookmark info

*Inherited from [AsposeResponse](AsposeResponse.md)*
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**fileExist** | [**FileExist**](FileExist.md) | | [optional]
**bookmark** | [**Bookmark**](Bookmark.md) | Bookmark object | [optional]
**code** | **number** | Response status code.<br />*Inherited from [AsposeResponse](AsposeResponse.md)* |
**status** | **string** | Response status.<br />*Inherited from [AsposeResponse](AsposeResponse.md)* | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/fileExistResponse.ts)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/bookmarkResponse.ts)

12 changes: 12 additions & 0 deletions docs/Bookmarks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Bookmarks
Represents list of bookmark.

*Inherited from [LinkElement](LinkElement.md)*
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**list** | [**Array&lt;Bookmark&gt;**](Bookmark.md) | List of bookmarks. | [optional]
**links** | [**Array&lt;Link&gt;**](Link.md) | Link to the document.<br />*Inherited from [LinkElement](LinkElement.md)* | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/bookmarks.ts)

8 changes: 4 additions & 4 deletions docs/DiscUsageResponse.md → docs/BookmarksResponse.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# DiscUsageResponse

# BookmarksResponse
Represents response containing multiple bookmarks info

*Inherited from [AsposeResponse](AsposeResponse.md)*
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**discUsage** | [**DiscUsage**](DiscUsage.md) | | [optional]
**bookmarks** | [**Bookmarks**](Bookmarks.md) | Bookmarks object | [optional]
**code** | **number** | Response status code.<br />*Inherited from [AsposeResponse](AsposeResponse.md)* |
**status** | **string** | Response status.<br />*Inherited from [AsposeResponse](AsposeResponse.md)* | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/discUsageResponse.ts)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/bookmarksResponse.ts)

2 changes: 1 addition & 1 deletion docs/CellRecognized.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**textRects** | [**TextRects**](TextRects.md) | Gets collection of objects that describes text containing in the cell | [optional]
**textRects** | [**TextRects**](TextRects.md) | Gets collection of TextRect objects that describes text containing in the cell | [optional]
**rectangle** | [**Rectangle**](Rectangle.md) | Gets rectangle that describes position of the cell on page | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/cellRecognized.ts)
Expand Down
6 changes: 3 additions & 3 deletions docs/DiscUsage.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# DiscUsage

Class for disc space information.

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**usedSize** | **number** | |
**totalSize** | **number** | |
**usedSize** | **number** | Application used disc space. |
**totalSize** | **number** | Total disc space. |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/discUsage.ts)

2 changes: 1 addition & 1 deletion docs/DocumentPrivilege.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# DocumentPrivilege
Represents the privileges for accessing Pdf file./>.
Represents the privileges for accessing Pdf file.

## Properties
Name | Type | Description | Notes
Expand Down
13 changes: 7 additions & 6 deletions docs/AppendDocument.md → docs/Error.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# AppendDocument
Class for appendDocument service request building.
# Error
Error

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**document** | **string** | Document to append (server path). |
**startPage** | **number** | Appending start page. |
**endPage** | **number** | Appending end page. |
**code** | **string** | Code | [optional]
**message** | **string** | Message | [optional]
**description** | **string** | Description | [optional]
**innerError** | [**ErrorDetails**](ErrorDetails.md) | Inner Error | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/appendDocument.ts)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/error.ts)

13 changes: 5 additions & 8 deletions docs/File.md → docs/ErrorDetails.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,11 @@
# File
Represents file DTO.
# ErrorDetails
The error details

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** | | [optional]
**isFolder** | **boolean** | |
**modifiedDate** | **string** | | [optional]
**size** | **number** | |
**path** | **string** | | [optional]
**requestId** | **string** | The request id | [optional]
**date** | **string** | Date |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/file.ts)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/errorDetails.ts)

18 changes: 9 additions & 9 deletions docs/FileVersion.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# FileVersion
File Version


*Inherited from [File](File.md)*
*Inherited from [StorageFile](StorageFile.md)*
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**versionId** | **string** | | [optional]
**isLatest** | **boolean** | |
**name** | **string** | <br />*Inherited from [File](File.md)* | [optional]
**isFolder** | **boolean** | <br />*Inherited from [File](File.md)* |
**modifiedDate** | **string** | <br />*Inherited from [File](File.md)* | [optional]
**size** | **number** | <br />*Inherited from [File](File.md)* |
**path** | **string** | <br />*Inherited from [File](File.md)* | [optional]
**versionId** | **string** | File Version ID. | [optional]
**isLatest** | **boolean** | Specifies whether the file is (true) or is not (false) the latest version of an file. |
**name** | **string** | File or folder name.<br />*Inherited from [StorageFile](StorageFile.md)* | [optional]
**isFolder** | **boolean** | True if it is a folder.<br />*Inherited from [StorageFile](StorageFile.md)* |
**modifiedDate** | **string** | File or folder last modified DateTime.<br />*Inherited from [StorageFile](StorageFile.md)* | [optional]
**size** | **number** | File or folder size.<br />*Inherited from [StorageFile](StorageFile.md)* |
**path** | **string** | File or folder path.<br />*Inherited from [StorageFile](StorageFile.md)* | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/fileVersion.ts)

10 changes: 10 additions & 0 deletions docs/FileVersions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# FileVersions
File versions FileVersion.

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**value** | [**Array&lt;FileVersion&gt;**](FileVersion.md) | File versions FileVersion. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/fileVersions.ts)

13 changes: 0 additions & 13 deletions docs/FileVersionsResponse.md

This file was deleted.

10 changes: 10 additions & 0 deletions docs/FilesList.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# FilesList
Files list

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**value** | [**Array&lt;StorageFile&gt;**](StorageFile.md) | Files and folders contained by folder StorageFile. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/filesList.ts)

13 changes: 0 additions & 13 deletions docs/FilesResponse.md

This file was deleted.

11 changes: 11 additions & 0 deletions docs/FilesUploadResult.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# FilesUploadResult
File upload result

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**uploaded** | **Array&lt;string&gt;** | List of uploaded file names | [optional]
**errors** | [**Array&lt;Error&gt;**](Error.md) | List of errors. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/filesUploadResult.ts)

4 changes: 2 additions & 2 deletions docs/GraphInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ Represents graphics info.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**lineWidth** | **number** | Gets or sets a float value that indicates the line width of the graph. | [optional]
**color** | [**Color**](Color.md) | Gets or sets a object that indicates the color of the graph. | [optional]
**color** | [**Color**](Color.md) | Gets or sets a Color object that indicates the color of the graph. | [optional]
**dashArray** | **Array&lt;number&gt;** | Gets or sets a dash array. | [optional]
**dashPhase** | **number** | Gets or sets a dash phase. | [optional]
**fillColor** | [**Color**](Color.md) | Gets or sets a object that indicates the fill color of the graph. | [optional]
**fillColor** | [**Color**](Color.md) | Gets or sets a Color object that indicates the fill color of the graph. | [optional]
**isDoubled** | **boolean** | Gets or sets is border doubled. | [optional]
**skewAngleX** | **number** | Gets or sets a float value that indicates the skew angle of the x-coordinate when transforming a coordinate system. | [optional]
**skewAngleY** | **number** | Gets or sets a float value that indicates the skew angle of the y-coordinate when transforming a coordinate system. | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/ImageFooter.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Name | Type | Description | Notes
**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.<br />*Inherited from [StampBase](StampBase.md)* | [optional]
**horizontalAlignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets or sets Horizontal alignment of stamp on the page. <br />*Inherited from [StampBase](StampBase.md)* | [optional]
**opacity** | **number** | 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.<br />*Inherited from [StampBase](StampBase.md)* | [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.<br />*Inherited from [StampBase](StampBase.md)* | [optional]
**rotate** | [**Rotation**](Rotation.md) | Sets or gets the rotation of stamp content according Rotation 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.<br />*Inherited from [StampBase](StampBase.md)* | [optional]
**rotateAngle** | **number** | Gets or sets rotate angle of stamp in degrees. This property allows to set arbitrary rotate angle. <br />*Inherited from [StampBase](StampBase.md)* | [optional]
**xIndent** | **number** | Horizontal stamp coordinate, starting from the left.<br />*Inherited from [StampBase](StampBase.md)* | [optional]
**yIndent** | **number** | Vertical stamp coordinate, starting from the bottom.<br />*Inherited from [StampBase](StampBase.md)* | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/ImageHeader.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Name | Type | Description | Notes
**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.<br />*Inherited from [StampBase](StampBase.md)* | [optional]
**horizontalAlignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets or sets Horizontal alignment of stamp on the page. <br />*Inherited from [StampBase](StampBase.md)* | [optional]
**opacity** | **number** | 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.<br />*Inherited from [StampBase](StampBase.md)* | [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.<br />*Inherited from [StampBase](StampBase.md)* | [optional]
**rotate** | [**Rotation**](Rotation.md) | Sets or gets the rotation of stamp content according Rotation 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.<br />*Inherited from [StampBase](StampBase.md)* | [optional]
**rotateAngle** | **number** | Gets or sets rotate angle of stamp in degrees. This property allows to set arbitrary rotate angle. <br />*Inherited from [StampBase](StampBase.md)* | [optional]
**xIndent** | **number** | Horizontal stamp coordinate, starting from the left.<br />*Inherited from [StampBase](StampBase.md)* | [optional]
**yIndent** | **number** | Vertical stamp coordinate, starting from the bottom.<br />*Inherited from [StampBase](StampBase.md)* | [optional]
Expand Down
Loading