aspose_diagram_cloud 18.10.3 → 19.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2a794767fe37a6b4ba9866b5e67d2329b0e2674
-  data.tar.gz: 738ade2f45d6ea81f7b5cb0b6180678e098ed8a1
+  metadata.gz: 677332a0fed405cae7e5cd04feaf4c09b427eb5b
+  data.tar.gz: aaf40b832efc82625ede388064f3557b1de4d398
 SHA512:
-  metadata.gz: 8398637e8b6b5a36ca51f6c1e988727d3581f71d4aa0ecb93af51b6383fd6a32105d52ec53b41dc5c9b4f1bfd576c08d5dcd28c441b25d92bb22d47369743680
-  data.tar.gz: 1694b612d464eabb49c71b15960c07cb495dda430df3196760ba97f1f8b39849ccd33317d80023505e8443d19d97649dc8c2c28247fc9b74f793bca7c1181d96
+  metadata.gz: 1728f8e6d0e521ca1fa380436fa8318e55bfdd55f81511bdc2e7f2e38dc9964b2c625edc23b4d8c29e17f09930dade865fa852adaadfd7b2ab1947258f8cca9c
+  data.tar.gz: 750335f8ed368be4c671a9336da16b0c9fb7e2364ef38e19d0db3cf7e78100d995e75b8fe236f20de3a95166991616a613e97e1ddd738a5ca305e67a4ca96013

data/{aspose_diagram_cloud.gemspec → AsposeDiagramCloud.gemspec}

@@ -1,11 +1,11 @@
 # -*- encoding: utf-8 -*-
 #
 =begin
-#Web API Swagger specification
+#Aspose.Diagram Cloud API Reference
 
 #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
 
-OpenAPI spec version: 1.0
+OpenAPI spec version: 3.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.3.0-SNAPSHOT
@@ -13,14 +13,14 @@ Swagger Codegen version: 2.3.0-SNAPSHOT
 =end
 
 $:.push File.expand_path("../lib", __FILE__)
-require "aspose_diagram_cloud/version"
+require "AsposeDiagramCloud/version"
 
 Gem::Specification.new do |s|
   s.name        = "aspose_diagram_cloud"
   s.version     = AsposeDiagramCloud::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Aspose Diagram Cloud"]
-  s.email       = [""]
+  s.authors     = ["AsposeCloud"]
+  s.email       = ["aspose.cloud@asposeptyltd.com"]
   s.homepage    = "https://github.com/aspose-diagram-cloud/aspose-diagram-cloud-ruby"
   s.summary     = "Aspose.Diagram Cloud API"
   s.description = "Ruby library for communicating with the Aspose.Diagram Cloud API"

data/README.md

@@ -1,126 +1,96 @@
-# 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](https://github.com/swagger-api/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:
-
-```shell
-gem build AsposeDiagramCloud.gemspec
-```
-
-Then either install the gem locally:
-
-```shell
-gem install ./AsposeDiagramCloud-18.10.gem
+[Aspose.Diagram Cloud](https://products.aspose.cloud/Diagram) helps you develop diagrams manipulation applications. Our REST API based Diagram Cloud SDK allows your applications to work with Microsoft Visio Object Model. 
+
+This repository contains Aspose.Diagram Cloud SDK source code. This SDK allows you to work with Aspose.Diagram Cloud REST APIs in your applications quickly and easily, with zero initial cost.
+
+To use this SDK, you will need App SID and App Key which can be looked up at [Aspose Cloud Dashboard](https://dashboard.aspose.cloud/#/apps) (free registration in Aspose Cloud is required for this).
+
+
+# Features
+
+### Support Import Formats  
+* VSDX
+* VDX
+* VSD
+* VSX
+* VTX
+* VSSX
+* VSTX
+* VSDM
+* VSSM
+* VSTM
+* VDW
+* VSS
+* VST
+
+### Support Export Formats  
+* VSDX
+* VDX
+* VSX
+* VTX
+* VSSX
+* VSTX
+* VSDM
+* VSSM
+* VSTM
+* PDF
+* XPS
+* SWF
+* SVG
+* EMF
+* JPEG
+* PNG
+* BMP
+* TIFF
+* HTML
+
+### Supported Operations
+* Convert document format
+* Create new document
+* Upload document and save it with supported format
+* Download document with supported format 
+
+For the complete list of use-cases, please refer to [common operations format support map](https://docs.aspose.cloud/display/diagramcloud/Supported+File+Formats#SupportedFileFormats-CommonOperationsFormatSupportMap) to see what you can achieve!
+
+
+# Storage API support
+#### Since version 19.10, SDK includes support of storage operations for better user experience and unification, so now there's no need to use 2 different SDKs!
+
+It gives you an ability to:
+* Upload, download, copy, move and delete files, including versions handling (if you are using Cloud storage that supports this feature - true by default)
+* Create, copy, move and delete folders
+* Copy and move files and folders accross separate storages in scope of a single operation
+* Check if certain file, folder or storage exists
+
+# Examples
+Please, look at [Examples](EXAMPLES.md) document for basic usage or use the [Examples](Examples) folder for more sophisticated scenarios.
+
+### Aspose Cloud-hosted service VS on-premise deployment (*experimental feature*)
+Starting from v19.10, you can choose either to use Aspose Cloud-hosted image processing service (the standard way) or the Docker image from Docker Hub deployed on-premise to serve the requests.
+The details about key differences and deployment process will be described on the dedicated Docker Hub page as soon as it's released.
+
+To succeed with your on-premise service usage by the SDK, you need to:
+1. Use the new API class constructor with grantType parameter, clientId and clientSecret parameters.
 ```
-(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](https://rubygems.org/).
-
-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:
-
-```shell
-ruby -Ilib script.rb
-```
-
-## Getting Started
-
-Please follow the [installation](#installation) procedure and then run the following code:
-```ruby
-# 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
-
+$diagramApi = AsposeDiagramCloud::DiagramApi.new($grant_type,$client_id,$client_secret) 
 ```
-
-## 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**](docs/DiagramFileApi.md#diagram_file_get_diagram) | **GET** /diagram/{name} | Read document info or export.
-*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.
-*AsposeDiagramCloud::DiagramFileApi* | [**diagram_file_put_create**](docs/DiagramFileApi.md#diagram_file_put_create) | **PUT** /diagram/{name} | Create new diagram and save result to storage.
-*AsposeDiagramCloud::DiagramFileApi* | [**diagram_file_put_upload**](docs/DiagramFileApi.md#diagram_file_put_upload) | **PUT** /diagram/{name}/upload | Upload file and save result to storage.
-*AsposeDiagramCloud::OAuthApi* | [**o_auth_post**](docs/OAuthApi.md#o_auth_post) | **POST** /oauth2/token | Get Access token
-
-
-## Documentation for Models
-
- - [AsposeDiagramCloud::AccessTokenResponse](docs/AccessTokenResponse.md)
- - [AsposeDiagramCloud::DiagramModel](docs/DiagramModel.md)
- - [AsposeDiagramCloud::FileFormatRequest](docs/FileFormatRequest.md)
- - [AsposeDiagramCloud::Link](docs/Link.md)
- - [AsposeDiagramCloud::PageModel](docs/PageModel.md)
- - [AsposeDiagramCloud::SaaSposeResponse](docs/SaaSposeResponse.md)
- - [AsposeDiagramCloud::SaveResult](docs/SaveResult.md)
- - [AsposeDiagramCloud::SharpModel](docs/SharpModel.md)
- - [AsposeDiagramCloud::DiagramResponse](docs/DiagramResponse.md)
- - [AsposeDiagramCloud::SaveResponse](docs/SaveResponse.md)
-
-
-## 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
-
+2. Set *storage* or *storageName* parameters for each request where they're present (mandatory!).
+
+# Tests
+Tests are intended for internal usage only.
+
+# Licensing
+All Aspose.Diagram Cloud SDKs, helper scripts and templates are licensed under [MIT License](LICENSE).
+
+# Contact Us
+Your feedback is very important to us. Please feel free to contact via
++ [**Free Support Forum**](https://forum.aspose.cloud/c/diagram)
++ [**Paid Support Helpdesk**](https://helpdesk.aspose.cloud/)
+
+# Resources
++ [**Website**](https://www.aspose.cloud)
++ [**Product Home**](https://products.aspose.cloud/diagram)
++ [**Documentation**](https://docs.aspose.cloud/display/diagramcloud/Home)
++ [**API Reference**](https://apireference.aspose.cloud/diagram/)
++ [**Free Support Forum**](https://forum.aspose.cloud/c/diagram)
++ [**Paid Support Helpdesk**](https://helpdesk.aspose.cloud/)
++ [**Blog**](https://blog.aspose.cloud/category/diagram/

data/docs/{FileFormatRequest.md → CreateNewResponse.md}

@@ -1,8 +1,8 @@
-# AsposeDiagramCloud::FileFormatRequest
+# AsposeDiagramCloud::CreateNewResponse
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**format** | **String** |  | [optional] 
+**created** | **String** |  | [optional] 
 
 

data/docs/DiagramApi.md

@@ -0,0 +1,241 @@
+# AsposeDiagramCloud::DiagramApi
+
+All URIs are relative to *https://api.aspose.cloud/v3.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**convert_document**](DiagramApi.md#convert_document) | **PUT** /diagram/{name}/convert | Converts document from the request's content to the specified format.
+[**create_new**](DiagramApi.md#create_new) | **PUT** /diagram/{name} | Create Empty file into the specified format.
+[**download_file_with_format**](DiagramApi.md#download_file_with_format) | **GET** /diagram/{name} | Exports the document into the specified format.
+[**save_as**](DiagramApi.md#save_as) | **POST** /diagram/{name}/saveAs | Converts document to destination format with detailed settings and saves result to storage.
+
+
+# **convert_document**
+> File convert_document(name, file, opts)
+
+Converts document from the request's content to the specified format.
+
+### Example
+```ruby
+# load the gem
+require 'AsposeDiagramCloud'
+# setup authorization
+AsposeDiagramCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: JWT
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = AsposeDiagramCloud::DiagramApi.new
+
+name = "name_example" # String | Download document name.
+
+file = File.new("/path/to/file.txt") # File | File to upload
+
+opts = { 
+  source_filename: "source_filename_example" # String | Source document name.
+}
+
+begin
+  #Converts document from the request's content to the specified format.
+  result = api_instance.convert_document(name, file, opts)
+  p result
+rescue AsposeDiagramCloud::ApiError => e
+  puts "Exception when calling DiagramApi->convert_document: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| Download document name. | 
+ **file** | **File**| File to upload | 
+ **source_filename** | **String**| Source document name. | [optional] 
+
+### Return type
+
+**File**
+
+### Authorization
+
+[JWT](../README.md#JWT)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: multipart/form-data
+
+
+
+# **create_new**
+> CreateNewResponse create_new(name, opts)
+
+Create Empty file into the specified format.
+
+### Example
+```ruby
+# load the gem
+require 'AsposeDiagramCloud'
+# setup authorization
+AsposeDiagramCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: JWT
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = AsposeDiagramCloud::DiagramApi.new
+
+name = "name_example" # String | The document name.
+
+opts = { 
+  folder: "folder_example", # String | The document folder.
+  is_overwrite: false # BOOLEAN | If true overwrite the same name file.The default value is false 
+}
+
+begin
+  #Create Empty file into the specified format.
+  result = api_instance.create_new(name, opts)
+  p result
+rescue AsposeDiagramCloud::ApiError => e
+  puts "Exception when calling DiagramApi->create_new: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| The document name. | 
+ **folder** | **String**| The document folder. | [optional] 
+ **is_overwrite** | **BOOLEAN**| If true overwrite the same name file.The default value is false  | [optional] [default to false]
+
+### Return type
+
+[**CreateNewResponse**](CreateNewResponse.md)
+
+### Authorization
+
+[JWT](../README.md#JWT)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **download_file_with_format**
+> File download_file_with_format(name, format, opts)
+
+Exports the document into the specified format.
+
+### Example
+```ruby
+# load the gem
+require 'AsposeDiagramCloud'
+# setup authorization
+AsposeDiagramCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: JWT
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = AsposeDiagramCloud::DiagramApi.new
+
+name = "name_example" # String | The document name.
+
+format = "format_example" # String | The destination format.
+
+opts = { 
+  folder: "folder_example" # String | Original document folder.
+}
+
+begin
+  #Exports the document into the specified format.
+  result = api_instance.download_file_with_format(name, format, opts)
+  p result
+rescue AsposeDiagramCloud::ApiError => e
+  puts "Exception when calling DiagramApi->download_file_with_format: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| The document name. | 
+ **format** | **String**| The destination format. | 
+ **folder** | **String**| Original document folder. | [optional] 
+
+### Return type
+
+**File**
+
+### Authorization
+
+[JWT](../README.md#JWT)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: multipart/form-data
+
+
+
+# **save_as**
+> SaveAsResponse save_as(name, save_options_request, opts)
+
+Converts document to destination format with detailed settings and saves result to storage.
+
+### Example
+```ruby
+# load the gem
+require 'AsposeDiagramCloud'
+# setup authorization
+AsposeDiagramCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: JWT
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = AsposeDiagramCloud::DiagramApi.new
+
+name = "name_example" # String | Original document name.
+
+save_options_request = AsposeDiagramCloud::SaveOptionsRequest.new # SaveOptionsRequest | Save options.
+
+opts = { 
+  folder: "folder_example", # String | Original document folder.
+  is_overwrite: false # BOOLEAN | If true overwrite the same name file.The default value is false 
+}
+
+begin
+  #Converts document to destination format with detailed settings and saves result to storage.
+  result = api_instance.save_as(name, save_options_request, opts)
+  p result
+rescue AsposeDiagramCloud::ApiError => e
+  puts "Exception when calling DiagramApi->save_as: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| Original document name. | 
+ **save_options_request** | [**SaveOptionsRequest**](SaveOptionsRequest.md)| Save options. | 
+ **folder** | **String**| Original document folder. | [optional] 
+ **is_overwrite** | **BOOLEAN**| If true overwrite the same name file.The default value is false  | [optional] [default to false]
+
+### Return type
+
+[**SaveAsResponse**](SaveAsResponse.md)
+
+### Authorization
+
+[JWT](../README.md#JWT)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+