|
| 1 | +# aspose-digaram-cloud-python |
| 2 | + |
| 3 | +Aspose.Digaram Cloud SDK for Python allows you to use Aspose.Digaram APIs in your Python applications |
| 4 | + |
| 5 | +- Package version: 18.10 |
| 6 | +- Build package: io.swagger.codegen.languages.PythonClientCodegen |
| 7 | + |
| 8 | +## Requirements. |
| 9 | + |
| 10 | +Python 2.7 and 3.5 |
| 11 | + |
| 12 | +## Installation & Usage |
| 13 | +### pip install |
| 14 | + |
| 15 | +```sh |
| 16 | +pip install asposeDiagramcloud |
| 17 | +``` |
| 18 | +(you may need to run `pip` with root permission: `sudo pip install asposeDiagramcloud`) |
| 19 | + |
| 20 | +Then import the package: |
| 21 | +```python |
| 22 | +import asposeDiagramcloud |
| 23 | +``` |
| 24 | + |
| 25 | +### Setuptools |
| 26 | + |
| 27 | +Install via [Setuptools](http://pypi.python.org/pypi/setuptools). |
| 28 | + |
| 29 | +```sh |
| 30 | +python setup.py install --user |
| 31 | +``` |
| 32 | +(or `sudo python setup.py install` to install the package for all users) |
| 33 | + |
| 34 | +Then import the package: |
| 35 | +```python |
| 36 | +import asposeDiagramcloud |
| 37 | +``` |
| 38 | + |
| 39 | +## Getting Started |
| 40 | + |
| 41 | +Please follow the [installation procedure](#installation--usage) and then run the following: |
| 42 | + |
| 43 | +```python |
| 44 | +from __future__ import print_function |
| 45 | +import time |
| 46 | +import asposeDiagramcloud |
| 47 | +from asposeDiagramcloud.rest import ApiException |
| 48 | +from pprint import pprint |
| 49 | +# create an instance of the API class |
| 50 | +api_instance = asposeDiagramcloud.DiagramFileApi() |
| 51 | +name = 'name_example' # str | The document name. |
| 52 | +format = 'format_example' # str | The exported file format. (optional) |
| 53 | +folder = 'folder_example' # str | The document folder. (optional) |
| 54 | +storage = 'storage_example' # str | storage name. (optional) |
| 55 | + |
| 56 | +try: |
| 57 | + # Read document info or export. |
| 58 | + api_response = api_instance.diagram_file_get_diagram(name, format=format, folder=folder, storage=storage) |
| 59 | + pprint(api_response) |
| 60 | +except ApiException as e: |
| 61 | + print("Exception when calling DiagramFileApi->diagram_file_get_diagram: %s\n" % e) |
| 62 | + |
| 63 | +``` |
| 64 | + |
| 65 | +## Documentation for API Endpoints |
| 66 | + |
| 67 | +All URIs are relative to *https://api.aspose.cloud/v1.1/* |
| 68 | + |
| 69 | +Class | Method | HTTP request | Description |
| 70 | +------------ | ------------- | ------------- | ------------- |
| 71 | +*DiagramFileApi* | [**diagram_file_get_diagram**](docs/DiagramFileApi.md#diagram_file_get_diagram) | **GET** /diagram/{name} | Read document info or export. |
| 72 | +*DiagramFileApi* | [**diagram_file_post_save_as**](docs/DiagramFileApi.md#diagram_file_post_save_as) | **POST** /diagram/{name}/SaveAs | Convert document and save result to storage. |
| 73 | +*DiagramFileApi* | [**diagram_file_put_create**](docs/DiagramFileApi.md#diagram_file_put_create) | **PUT** /diagram/{name} | Create new diagram and save result to storage. |
| 74 | +*DiagramFileApi* | [**diagram_file_put_upload**](docs/DiagramFileApi.md#diagram_file_put_upload) | **PUT** /diagram/{name}/upload | Upload file and save result to storage. |
| 75 | +*OAuthApi* | [**o_auth_post**](docs/OAuthApi.md#o_auth_post) | **POST** /oauth2/token | Get Access token |
| 76 | + |
| 77 | + |
| 78 | +## Documentation For Models |
| 79 | + |
| 80 | + - [AccessTokenResponse](docs/AccessTokenResponse.md) |
| 81 | + - [DiagramModel](docs/DiagramModel.md) |
| 82 | + - [FileFormatRequest](docs/FileFormatRequest.md) |
| 83 | + - [Link](docs/Link.md) |
| 84 | + - [PageModel](docs/PageModel.md) |
| 85 | + - [SaaSposeResponse](docs/SaaSposeResponse.md) |
| 86 | + - [SaveResult](docs/SaveResult.md) |
| 87 | + - [SharpModel](docs/SharpModel.md) |
| 88 | + - [DiagramResponse](docs/DiagramResponse.md) |
| 89 | + - [SaveResponse](docs/SaveResponse.md) |
| 90 | + |
| 91 | + |
| 92 | +## Documentation For Authorization |
| 93 | + |
| 94 | + |
| 95 | +## appsid |
| 96 | + |
| 97 | +- **Type**: API key |
| 98 | +- **API key parameter name**: appsid |
| 99 | +- **Location**: URL query string |
| 100 | + |
| 101 | +## oauth |
| 102 | + |
| 103 | +- **Type**: OAuth |
| 104 | +- **Flow**: implicit |
| 105 | +- **Authorization URL**: |
| 106 | +- **Scopes**: |
| 107 | + - **write:pets**: modify pets in your account |
| 108 | + |
| 109 | +## signature |
| 110 | + |
| 111 | +- **Type**: API key |
| 112 | +- **API key parameter name**: signature |
| 113 | +- **Location**: URL query string |
| 114 | + |
| 115 | + |
| 116 | + |
| 117 | + |
0 commit comments