|
| 1 | +# AsposeDiagramCloud |
| 2 | + |
| 3 | +AsposeDiagramCloud - the Ruby gem for the Web API Swagger specification |
| 4 | + |
| 5 | +No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) |
| 6 | + |
| 7 | +This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project: |
| 8 | + |
| 9 | +- API version: 1.0 |
| 10 | +- Package version: 18.10 |
| 11 | +- Build package: io.swagger.codegen.languages.RubyClientCodegen |
| 12 | + |
| 13 | +## Installation |
| 14 | + |
| 15 | +### Build a gem |
| 16 | + |
| 17 | +To build the Ruby code into a gem: |
| 18 | + |
| 19 | +```shell |
| 20 | +gem build AsposeDiagramCloud.gemspec |
| 21 | +``` |
| 22 | + |
| 23 | +Then either install the gem locally: |
| 24 | + |
| 25 | +```shell |
| 26 | +gem install ./AsposeDiagramCloud-18.10.gem |
| 27 | +``` |
| 28 | +(for development, run `gem install --dev ./AsposeDiagramCloud-18.10.gem` to install the development dependencies) |
| 29 | + |
| 30 | +or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/). |
| 31 | + |
| 32 | +Finally add this to the Gemfile: |
| 33 | + |
| 34 | + gem 'AsposeDiagramCloud', '~> 18.10' |
| 35 | + |
| 36 | +### Install from Git |
| 37 | + |
| 38 | +If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile: |
| 39 | + |
| 40 | + gem 'AsposeDiagramCloud', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git' |
| 41 | + |
| 42 | +### Include the Ruby code directly |
| 43 | + |
| 44 | +Include the Ruby code directly using `-I` as follows: |
| 45 | + |
| 46 | +```shell |
| 47 | +ruby -Ilib script.rb |
| 48 | +``` |
| 49 | + |
| 50 | +## Getting Started |
| 51 | + |
| 52 | +Please follow the [installation](#installation) procedure and then run the following code: |
| 53 | +```ruby |
| 54 | +# Load the gem |
| 55 | +require 'AsposeDiagramCloud' |
| 56 | + |
| 57 | +api_instance = AsposeDiagramCloud::DiagramFileApi.new |
| 58 | + |
| 59 | +name = "name_example" # String | The document name. |
| 60 | + |
| 61 | +opts = { |
| 62 | + format: "format_example", # String | The exported file format. |
| 63 | + folder: "folder_example", # String | The document folder. |
| 64 | + storage: "storage_example" # String | storage name. |
| 65 | +} |
| 66 | + |
| 67 | +begin |
| 68 | + #Read document info or export. |
| 69 | + result = api_instance.diagram_file_get_diagram(name, opts) |
| 70 | + p result |
| 71 | +rescue AsposeDiagramCloud::ApiError => e |
| 72 | + puts "Exception when calling DiagramFileApi->diagram_file_get_diagram: #{e}" |
| 73 | +end |
| 74 | + |
| 75 | +``` |
| 76 | + |
| 77 | +## Documentation for API Endpoints |
| 78 | + |
| 79 | +All URIs are relative to *https://api.aspose.cloud/v1.1/* |
| 80 | + |
| 81 | +Class | Method | HTTP request | Description |
| 82 | +------------ | ------------- | ------------- | ------------- |
| 83 | +*AsposeDiagramCloud::DiagramFileApi* | [**diagram_file_get_diagram**](docs/DiagramFileApi.md#diagram_file_get_diagram) | **GET** /diagram/{name} | Read document info or export. |
| 84 | +*AsposeDiagramCloud::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. |
| 85 | +*AsposeDiagramCloud::DiagramFileApi* | [**diagram_file_put_create**](docs/DiagramFileApi.md#diagram_file_put_create) | **PUT** /diagram/{name} | Create new diagram and save result to storage. |
| 86 | +*AsposeDiagramCloud::DiagramFileApi* | [**diagram_file_put_upload**](docs/DiagramFileApi.md#diagram_file_put_upload) | **PUT** /diagram/{name}/upload | Upload file and save result to storage. |
| 87 | +*AsposeDiagramCloud::OAuthApi* | [**o_auth_post**](docs/OAuthApi.md#o_auth_post) | **POST** /oauth2/token | Get Access token |
| 88 | + |
| 89 | + |
| 90 | +## Documentation for Models |
| 91 | + |
| 92 | + - [AsposeDiagramCloud::AccessTokenResponse](docs/AccessTokenResponse.md) |
| 93 | + - [AsposeDiagramCloud::DiagramModel](docs/DiagramModel.md) |
| 94 | + - [AsposeDiagramCloud::FileFormatRequest](docs/FileFormatRequest.md) |
| 95 | + - [AsposeDiagramCloud::Link](docs/Link.md) |
| 96 | + - [AsposeDiagramCloud::PageModel](docs/PageModel.md) |
| 97 | + - [AsposeDiagramCloud::SaaSposeResponse](docs/SaaSposeResponse.md) |
| 98 | + - [AsposeDiagramCloud::SaveResult](docs/SaveResult.md) |
| 99 | + - [AsposeDiagramCloud::SharpModel](docs/SharpModel.md) |
| 100 | + - [AsposeDiagramCloud::DiagramResponse](docs/DiagramResponse.md) |
| 101 | + - [AsposeDiagramCloud::SaveResponse](docs/SaveResponse.md) |
| 102 | + |
| 103 | + |
| 104 | +## Documentation for Authorization |
| 105 | + |
| 106 | + |
| 107 | +### appsid |
| 108 | + |
| 109 | +- **Type**: API key |
| 110 | +- **API key parameter name**: appsid |
| 111 | +- **Location**: URL query string |
| 112 | + |
| 113 | +### oauth |
| 114 | + |
| 115 | +- **Type**: OAuth |
| 116 | +- **Flow**: implicit |
| 117 | +- **Authorization URL**: |
| 118 | +- **Scopes**: |
| 119 | + - write:pets: modify pets in your account |
| 120 | + |
| 121 | +### signature |
| 122 | + |
| 123 | +- **Type**: API key |
| 124 | +- **API key parameter name**: signature |
| 125 | +- **Location**: URL query string |
| 126 | + |
0 commit comments