AsposeDiagramCloud

AsposeDiagramCloud - the Ruby gem for the Web API Swagger specification

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0
• Package version: 18.10
• Build package: io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build AsposeDiagramCloud.gemspec

Then either install the gem locally:

gem install ./AsposeDiagramCloud-18.10.gem

(for development, run gem install --dev ./AsposeDiagramCloud-18.10.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'AsposeDiagramCloud', '~> 18.10'

Install from Git

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:

gem 'AsposeDiagramCloud', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'aspose_diagram_cloud'

api_instance = AsposeDiagramCloud::DiagramFileApi.new

name = "name_example" # String | The document name.

opts = { 
  format: "format_example", # String | The exported file format.
  folder: "folder_example", # String | The document folder.
  storage: "storage_example" # String | storage name.
}

begin
  #Read document info or export.
  result = api_instance.diagram_file_get_diagram(name, opts)
  p result
rescue AsposeDiagramCloud::ApiError => e
  puts "Exception when calling DiagramFileApi->diagram_file_get_diagram: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.aspose.cloud/v1.1/

Class	Method	HTTP request	Description
AsposeDiagramCloud::DiagramFileApi	diagram_file_get_diagram	GET /diagram/name	Read document info or export.
AsposeDiagramCloud::DiagramFileApi	diagram_file_post_save_as	POST /diagram/name/SaveAs	Convert document and save result to storage.
AsposeDiagramCloud::DiagramFileApi	diagram_file_put_create	PUT /diagram/name	Create new diagram and save result to storage.
AsposeDiagramCloud::DiagramFileApi	diagram_file_put_upload	PUT /diagram/name/upload	Upload file and save result to storage.
AsposeDiagramCloud::OAuthApi	o_auth_post	POST /oauth2/token	Get Access token

Documentation for Models

• AsposeDiagramCloud::AccessTokenResponse
• AsposeDiagramCloud::DiagramModel
• AsposeDiagramCloud::FileFormatRequest
• AsposeDiagramCloud::Link
• AsposeDiagramCloud::PageModel
• AsposeDiagramCloud::SaaSposeResponse
• AsposeDiagramCloud::SaveResult
• AsposeDiagramCloud::SharpModel
• AsposeDiagramCloud::DiagramResponse
• AsposeDiagramCloud::SaveResponse

Documentation for Authorization

appsid

• Type: API key
• API key parameter name: appsid
• Location: URL query string

oauth

• Type: OAuth
• Flow: implicit
• Authorization URL:
• Scopes:
  • write:pets: modify pets in your account

signature

• Type: API key
• API key parameter name: signature
• Location: URL query string