aspose_imaging_cloud 20.2 → 20.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0688c4217b35e6f496dbea423c8e247e666e9dad30b63f70aa548f7ebab2331b'
-  data.tar.gz: b2ad7bd22ba059e064d917420ffb19472ca9351aeac7f31dd207dca0f8139ec9
+  metadata.gz: dc704e75baba82b9e374e2136a51b8789e464935759440bd0ae6e7e3b02126f5
+  data.tar.gz: 74ed5d6f2b629ba12f0bfd0e2881e0390ca8d4e4094ff5ffc1e06a166d331e52
 SHA512:
-  metadata.gz: ed2501df61ab9640548efdd177de73c7b1ba945b357e748c85527f307960399e11cdec248b1a9781a2c1cc99d3f916867d326264bca2f9ac0431ffd740e86b23
-  data.tar.gz: e2987ab4ed18c03a8f93c1e23a76850faf8f2f5e42bdc9b3da9c60b2e6add5a2f4420cdfce8a82756653811fc9d91caa5b75df415748784fc196943c021e7371
+  metadata.gz: '092e54937373b0ce5b0c69952ae81f51c46a9bc36e74bae6ba0bd61153395e75d32efd8f2a1b2fef242cbd4527e12dc8cc766f9db49cf09158b6ad53ada4e306'
+  data.tar.gz: b99eb03e881b84943729ecb0ac2f3743aeca472d23c477d08c71e442d2d9b556d0cf2c1d303d5ff12ab72a1ed0bc892d95ffb2232d99c9e4d7f8f6308eaf6682

data/README.md

@@ -1,131 +1,236 @@
-# Aspose.Imaging Cloud Ruby SDK 
-[Aspose.Imaging Cloud](https://products.aspose.cloud/imaging) is a true [REST API](https://apireference.aspose.cloud/imaging/) that enables you to perform a wide range of image processing operations including creation, manipulation and conversion in the cloud, with zero initial costs. Our Cloud SDKs are wrappers around REST API in various programming languages, allowing you to process images in language of your choice quickly and easily, gaining all benefits of strong types and IDE highlights. 
-
-This repository contains [Aspose.Imaging Cloud Ruby SDK](https://products.aspose.cloud/imaging/ruby) source code. This SDK allows you to work with Aspose.Imaging Cloud REST APIs in your Ruby 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).
-
-The solution is updated using [code generator](https://github.com/aspose-imaging-cloud/aspose-imaging-cloud-codegen).
-
-## Key Features
-#### Image Formats Support
-Export the following images to various formats (generally supported ones are BMP, PSD, JPEG, TIFF, GIF, PNG, JPEG2000, WEBP and PDF):
-* BMP
-* GIF
-* DJVU
-* WMF
-* EMF
-* JPEG
-* JPEG2000
-* PSD
-* TIFF
-* WEBP
-* PNG
-* DICOM
-* CDR
-* ODG
-* OTG
-* DNG
-* SVG
-* CMX
-
-Process options, change and return images in the same format:
-* PSD
-* JPEG
-* TIFF
-* GIF
-* BMP
-* JPEG2000
-* WEBP
-
-Process options, change and return images in any supported export format:
-* EMF
-* WMF
-
-#### Supported Imaging Operations
-* Export 
-* Resize
-* Crop
-* Rotate and Flip
-* TIFF frames extraction
-* TIFF frames manipulation
-* TIFF concatenation
-* TIFF conversion to fax-friendly format
-* Retrieve & update image properties
-* Conversion to and from PSD format
-
-#### Supported Imaging AI Operations
-* Content-based image search
-* Image duplicates search
-* Image search by custom registered tags
-* Image comparison and similarity detection
-* Image features extraction (for now, AKAZE detector is supported)
-
-For the complete list of use-cases, please refer to the [format support document](https://docs.aspose.cloud/display/imagingcloud/Supported+File+Formats) to see what you can achieve!
-
-#### Storage API support
-Since version 19.4, 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
-
-Detalied official documentation can be found at the [following link](https://docs.aspose.cloud/display/imagingcloud).
+# aspose-imaging-cloud
 
-## Getting Started
-1. **Sign Up**. Before you begin, you need to sign up for an account on our [Dashboard](https://dashboard.aspose.cloud/) and retrieve your [credentials](https://dashboard.aspose.cloud/#/apps).
-2. **Minimum requirements**. This SDK requires [Python 2.5 or later](https://www.ruby-lang.org/en/downloads/).
-3. **Install Aspose.Imaging Cloud Python SDK**.
+AsposeImagingCloud - the Ruby gem for the Aspose.Imaging Cloud API Reference
 
-Please, install the following [Ruby gem](https://rubygems.org/gems/aspose-imaging-cloud/) using command line.
-```
-gem install aspose_imaging_cloud
+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: 3.0
+- Package version: 1.0.0
+- Build package: io.swagger.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build aspose-imaging-cloud.gemspec
 ```
-Import the dependencies to your code as follows.
-```ruby
-require 'aspose_imaging_cloud'
+
+Then either install the gem locally:
+
+```shell
+gem install ./aspose-imaging-cloud.gem
 ```
-4. **Using the SDK**. The best way to become familiar with how to use the SDK is to read the [Developer Guide](https://docs.aspose.cloud/display/imagingcloud/Developer+Guide). The [Getting Started Guide](https://docs.aspose.cloud/display/imagingcloud/Getting+Started) will help you to become familiar with the common concepts.
+(for development, run `gem install --dev ./aspose-imaging-cloud.gem` to install the development dependencies)
 
-## Quick Examples
-Please, look at [Examples](EXAMPLES.md) document for basic usage or use the [Examples](Examples) folder for more sophisticated scenarios.
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
-#### Aspose Cloud-hosted service VS on-premise deployment (*experimental feature*)
-Starting from v19.7, 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.
+Finally add this to the Gemfile:
 
-To succeed with your on-premise service usage by the SDK, you need to:
-1. Use the API class constructor with base URL required parameter, API version and debug mode optional parameters, skipping the credentials parameters.
-```ruby
-ImagingApi.new(nil, nil, 'yourServiceUrl')
+    gem 'aspose-imaging-cloud', '~> 20.7'
+
+### 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 'aspose-imaging-cloud', :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
 ```
-2. Set *storage* or *storageName* parameters for each request where they're present (mandatory!).
 
-## Content
-You may check our full [API endpoints list](docs/API_README.md#documentation-for-api-endpoints) or [models available](docs/API_README.md#documentation-for-models) in the SDK.
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# Load the gem
+require 'aspose-imaging-cloud'
+
+# Setup authorization
+AsposeImagingCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: JWT
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
 
-## Dependencies
-* [Ruby 2.5 or later](https://www.ruby-lang.org/en/downloads/)
+api_instance = AsposeImagingCloud::ImagingApi.new
 
-## Licensing
-All Aspose.Imaging Cloud SDKs, helper scripts and templates are licensed under [MIT License](LICENSE).
+search_context_id = 'search_context_id_example' # String | Search context identifier.
 
-## Contact Us
-Your feedback is very important to us. Please feel free to contact via
-+ [**Free Support Forum**](https://forum.aspose.cloud/c/imaging)
-+ [**Paid Support Helpdesk**](https://helpdesk.aspose.cloud/)
+image_id = 'image_id_example' # String | Image identifier.
 
-## Resources
-+ [**Web API reference**](https://apireference.aspose.cloud/imaging/)
-+ [**Website**](https://www.aspose.cloud)
-+ [**Product Home**](https://products.aspose.cloud/imaging)
-+ [**Documentation**](https://docs.aspose.cloud/display/imagingcloud/Home)
-+ [**Blog**](https://blog.aspose.cloud/category/aspose-products/aspose.imaging-cloud/)
+opts = { 
+  image_data: File.new('/path/to/file.txt'), # File | Input image
+  folder: 'folder_example', # String | Folder.
+  storage: 'storage_example' # String | Storage
+}
+
+begin
+  #Add image and images features to search context. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream.
+  api_instance.add_search_image(search_context_id, image_id, opts)
+rescue AsposeImagingCloud::ApiError => e
+  puts "Exception when calling ImagingApi->add_search_image: #{e}"
+end
+
+```
 
-## Other languages
-We generate our SDKs in different languages so you may check if yours is available in our [repository](https://github.com/aspose-imaging-cloud). If you don't find your language in the list, feel free to request it from us, or use raw REST API requests as you can find it [here](https://products.aspose.cloud/imaging/curl).
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.aspose.cloud/v3.0*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*AsposeImagingCloud::ImagingApi* | [**add_search_image**](docs/ImagingApi.md#add_search_image) | **POST** /imaging/ai/imageSearch/{searchContextId}/image | Add image and images features to search context. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream.
+*AsposeImagingCloud::ImagingApi* | [**append_tiff**](docs/ImagingApi.md#append_tiff) | **POST** /imaging/tiff/{name}/appendTiff | Appends existing TIFF image to another existing TIFF image (i.e. merges TIFF images).
+*AsposeImagingCloud::ImagingApi* | [**compare_images**](docs/ImagingApi.md#compare_images) | **POST** /imaging/ai/imageSearch/{searchContextId}/compare | Compare two images. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream.
+*AsposeImagingCloud::ImagingApi* | [**convert_tiff_to_fax**](docs/ImagingApi.md#convert_tiff_to_fax) | **GET** /imaging/tiff/{name}/toFax | Update parameters of existing TIFF image accordingly to fax parameters.
+*AsposeImagingCloud::ImagingApi* | [**copy_file**](docs/ImagingApi.md#copy_file) | **PUT** /imaging/storage/file/copy/{srcPath} | Copy file
+*AsposeImagingCloud::ImagingApi* | [**copy_folder**](docs/ImagingApi.md#copy_folder) | **PUT** /imaging/storage/folder/copy/{srcPath} | Copy folder
+*AsposeImagingCloud::ImagingApi* | [**create_cropped_image**](docs/ImagingApi.md#create_cropped_image) | **POST** /imaging/crop | Crop an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
+*AsposeImagingCloud::ImagingApi* | [**create_deskewed_image**](docs/ImagingApi.md#create_deskewed_image) | **POST** /imaging/deskew | Deskew an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
+*AsposeImagingCloud::ImagingApi* | [**create_fax_tiff**](docs/ImagingApi.md#create_fax_tiff) | **POST** /imaging/tiff/toFax | Update parameters of TIFF image accordingly to fax parameters. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
+*AsposeImagingCloud::ImagingApi* | [**create_folder**](docs/ImagingApi.md#create_folder) | **PUT** /imaging/storage/folder/{path} | Create the folder
+*AsposeImagingCloud::ImagingApi* | [**create_grayscaled_image**](docs/ImagingApi.md#create_grayscaled_image) | **POST** /imaging/grayscale | Grayscales an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
+*AsposeImagingCloud::ImagingApi* | [**create_image_features**](docs/ImagingApi.md#create_image_features) | **POST** /imaging/ai/imageSearch/{searchContextId}/features | Extract images features and add them to search context. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream.
+*AsposeImagingCloud::ImagingApi* | [**create_image_frame**](docs/ImagingApi.md#create_image_frame) | **POST** /imaging/frames/{frameId} | Get separate frame from existing image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
+*AsposeImagingCloud::ImagingApi* | [**create_image_frame_range**](docs/ImagingApi.md#create_image_frame_range) | **POST** /imaging/frames/range | Get frames range from existing image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
+*AsposeImagingCloud::ImagingApi* | [**create_image_search**](docs/ImagingApi.md#create_image_search) | **POST** /imaging/ai/imageSearch/create | Create new search context.
+*AsposeImagingCloud::ImagingApi* | [**create_image_tag**](docs/ImagingApi.md#create_image_tag) | **POST** /imaging/ai/imageSearch/{searchContextId}/addTag | Add tag and reference image to search context. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
+*AsposeImagingCloud::ImagingApi* | [**create_modified_bmp**](docs/ImagingApi.md#create_modified_bmp) | **POST** /imaging/bmp | Update parameters of BMP image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
+*AsposeImagingCloud::ImagingApi* | [**create_modified_emf**](docs/ImagingApi.md#create_modified_emf) | **POST** /imaging/emf | Process existing EMF imaging using given parameters. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
+*AsposeImagingCloud::ImagingApi* | [**create_modified_gif**](docs/ImagingApi.md#create_modified_gif) | **POST** /imaging/gif | Update parameters of GIF image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
+*AsposeImagingCloud::ImagingApi* | [**create_modified_jpeg**](docs/ImagingApi.md#create_modified_jpeg) | **POST** /imaging/jpg | Update parameters of JPEG image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
+*AsposeImagingCloud::ImagingApi* | [**create_modified_jpeg2000**](docs/ImagingApi.md#create_modified_jpeg2000) | **POST** /imaging/jpg2000 | Update parameters of JPEG2000 image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
+*AsposeImagingCloud::ImagingApi* | [**create_modified_psd**](docs/ImagingApi.md#create_modified_psd) | **POST** /imaging/psd | Update parameters of PSD image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
+*AsposeImagingCloud::ImagingApi* | [**create_modified_svg**](docs/ImagingApi.md#create_modified_svg) | **POST** /imaging/svg | Update parameters of SVG image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
+*AsposeImagingCloud::ImagingApi* | [**create_modified_tiff**](docs/ImagingApi.md#create_modified_tiff) | **POST** /imaging/tiff | Update parameters of TIFF image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
+*AsposeImagingCloud::ImagingApi* | [**create_modified_web_p**](docs/ImagingApi.md#create_modified_web_p) | **POST** /imaging/webp | Update parameters of WEBP image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
+*AsposeImagingCloud::ImagingApi* | [**create_modified_wmf**](docs/ImagingApi.md#create_modified_wmf) | **POST** /imaging/wmf | Process existing WMF image using given parameters. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
+*AsposeImagingCloud::ImagingApi* | [**create_object_bounds**](docs/ImagingApi.md#create_object_bounds) | **POST** /imaging/ai/objectdetection/bounds | Detects objects bounds. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
+*AsposeImagingCloud::ImagingApi* | [**create_resized_image**](docs/ImagingApi.md#create_resized_image) | **POST** /imaging/resize | Resize an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
+*AsposeImagingCloud::ImagingApi* | [**create_rotate_flipped_image**](docs/ImagingApi.md#create_rotate_flipped_image) | **POST** /imaging/rotateflip | Rotate and/or flip an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
+*AsposeImagingCloud::ImagingApi* | [**create_updated_image**](docs/ImagingApi.md#create_updated_image) | **POST** /imaging/updateImage | Perform scaling, cropping and flipping of an image in a single request. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
+*AsposeImagingCloud::ImagingApi* | [**create_visual_object_bounds**](docs/ImagingApi.md#create_visual_object_bounds) | **POST** /imaging/ai/objectdetection/visualbounds | Detects objects bounds and draw them on the original image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream
+*AsposeImagingCloud::ImagingApi* | [**create_web_site_image_features**](docs/ImagingApi.md#create_web_site_image_features) | **POST** /imaging/ai/imageSearch/{searchContextId}/features/web | Extract images features from web page and add them to search context
+*AsposeImagingCloud::ImagingApi* | [**crop_image**](docs/ImagingApi.md#crop_image) | **GET** /imaging/{name}/crop | Crop an existing image.
+*AsposeImagingCloud::ImagingApi* | [**delete_file**](docs/ImagingApi.md#delete_file) | **DELETE** /imaging/storage/file/{path} | Delete file
+*AsposeImagingCloud::ImagingApi* | [**delete_folder**](docs/ImagingApi.md#delete_folder) | **DELETE** /imaging/storage/folder/{path} | Delete folder
+*AsposeImagingCloud::ImagingApi* | [**delete_image_features**](docs/ImagingApi.md#delete_image_features) | **DELETE** /imaging/ai/imageSearch/{searchContextId}/features | Deletes image features from search context.
+*AsposeImagingCloud::ImagingApi* | [**delete_image_search**](docs/ImagingApi.md#delete_image_search) | **DELETE** /imaging/ai/imageSearch/{searchContextId} | Deletes the search context.
+*AsposeImagingCloud::ImagingApi* | [**delete_search_image**](docs/ImagingApi.md#delete_search_image) | **DELETE** /imaging/ai/imageSearch/{searchContextId}/image | Delete image and images features from search context
+*AsposeImagingCloud::ImagingApi* | [**deskew_image**](docs/ImagingApi.md#deskew_image) | **GET** /imaging/{name}/deskew | Deskew an existing image.
+*AsposeImagingCloud::ImagingApi* | [**download_file**](docs/ImagingApi.md#download_file) | **GET** /imaging/storage/file/{path} | Download file
+*AsposeImagingCloud::ImagingApi* | [**extract_image_features**](docs/ImagingApi.md#extract_image_features) | **GET** /imaging/ai/imageSearch/{searchContextId}/image2features | Extract features from image without adding to search context. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream.
+*AsposeImagingCloud::ImagingApi* | [**extract_image_frame_properties**](docs/ImagingApi.md#extract_image_frame_properties) | **POST** /imaging/frames/{frameId}/properties | Get separate frame properties of existing image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
+*AsposeImagingCloud::ImagingApi* | [**extract_image_properties**](docs/ImagingApi.md#extract_image_properties) | **POST** /imaging/properties | Get properties of an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
+*AsposeImagingCloud::ImagingApi* | [**filter_effect_image**](docs/ImagingApi.md#filter_effect_image) | **PUT** /imaging/{name}/filterEffect | Apply filtering effects to an existing image.
+*AsposeImagingCloud::ImagingApi* | [**find_image_duplicates**](docs/ImagingApi.md#find_image_duplicates) | **GET** /imaging/ai/imageSearch/{searchContextId}/findDuplicates | Find images duplicates.
+*AsposeImagingCloud::ImagingApi* | [**find_images_by_tags**](docs/ImagingApi.md#find_images_by_tags) | **POST** /imaging/ai/imageSearch/{searchContextId}/findByTags | Find images by tags. Tags JSON string is passed as zero-indexed multipart/form-data content or as raw body stream.
+*AsposeImagingCloud::ImagingApi* | [**find_similar_images**](docs/ImagingApi.md#find_similar_images) | **GET** /imaging/ai/imageSearch/{searchContextId}/findSimilar | Find similar images. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream.
+*AsposeImagingCloud::ImagingApi* | [**get_disc_usage**](docs/ImagingApi.md#get_disc_usage) | **GET** /imaging/storage/disc | Get disc usage
+*AsposeImagingCloud::ImagingApi* | [**get_file_versions**](docs/ImagingApi.md#get_file_versions) | **GET** /imaging/storage/version/{path} | Get file versions
+*AsposeImagingCloud::ImagingApi* | [**get_files_list**](docs/ImagingApi.md#get_files_list) | **GET** /imaging/storage/folder/{path} | Get all files and folders within a folder
+*AsposeImagingCloud::ImagingApi* | [**get_image_features**](docs/ImagingApi.md#get_image_features) | **GET** /imaging/ai/imageSearch/{searchContextId}/features | Gets image features from search context.
+*AsposeImagingCloud::ImagingApi* | [**get_image_frame**](docs/ImagingApi.md#get_image_frame) | **GET** /imaging/{name}/frames/{frameId} | Get separate frame from existing image.
+*AsposeImagingCloud::ImagingApi* | [**get_image_frame_properties**](docs/ImagingApi.md#get_image_frame_properties) | **GET** /imaging/{name}/frames/{frameId}/properties | Get separate frame properties of existing image.
+*AsposeImagingCloud::ImagingApi* | [**get_image_frame_range**](docs/ImagingApi.md#get_image_frame_range) | **GET** /imaging/{name}/frames/range | Get frames range from existing image.
+*AsposeImagingCloud::ImagingApi* | [**get_image_properties**](docs/ImagingApi.md#get_image_properties) | **GET** /imaging/{name}/properties | Get properties of an image.
+*AsposeImagingCloud::ImagingApi* | [**get_image_search_status**](docs/ImagingApi.md#get_image_search_status) | **GET** /imaging/ai/imageSearch/{searchContextId}/status | Gets the search context status.
+*AsposeImagingCloud::ImagingApi* | [**get_object_bounds**](docs/ImagingApi.md#get_object_bounds) | **GET** /imaging/ai/objectdetection/{name}/bounds | Detects objects' bounds
+*AsposeImagingCloud::ImagingApi* | [**get_search_image**](docs/ImagingApi.md#get_search_image) | **GET** /imaging/ai/imageSearch/{searchContextId}/image | Get image from search context
+*AsposeImagingCloud::ImagingApi* | [**get_visual_object_bounds**](docs/ImagingApi.md#get_visual_object_bounds) | **GET** /imaging/ai/objectdetection/{name}/visualbounds | Detects objects bounds and draw them on the original image
+*AsposeImagingCloud::ImagingApi* | [**grayscale_image**](docs/ImagingApi.md#grayscale_image) | **GET** /imaging/{name}/grayscale | Grayscale an existing image.
+*AsposeImagingCloud::ImagingApi* | [**modify_bmp**](docs/ImagingApi.md#modify_bmp) | **GET** /imaging/{name}/bmp | Update parameters of existing BMP image.
+*AsposeImagingCloud::ImagingApi* | [**modify_emf**](docs/ImagingApi.md#modify_emf) | **GET** /imaging/{name}/emf | Process existing EMF imaging using given parameters.
+*AsposeImagingCloud::ImagingApi* | [**modify_gif**](docs/ImagingApi.md#modify_gif) | **GET** /imaging/{name}/gif | Update parameters of existing GIF image.
+*AsposeImagingCloud::ImagingApi* | [**modify_jpeg**](docs/ImagingApi.md#modify_jpeg) | **GET** /imaging/{name}/jpg | Update parameters of existing JPEG image.
+*AsposeImagingCloud::ImagingApi* | [**modify_jpeg2000**](docs/ImagingApi.md#modify_jpeg2000) | **GET** /imaging/{name}/jpg2000 | Update parameters of existing JPEG2000 image.
+*AsposeImagingCloud::ImagingApi* | [**modify_psd**](docs/ImagingApi.md#modify_psd) | **GET** /imaging/{name}/psd | Update parameters of existing PSD image.
+*AsposeImagingCloud::ImagingApi* | [**modify_svg**](docs/ImagingApi.md#modify_svg) | **GET** /imaging/{name}/svg | Update parameters of existing SVG image.
+*AsposeImagingCloud::ImagingApi* | [**modify_tiff**](docs/ImagingApi.md#modify_tiff) | **GET** /imaging/{name}/tiff | Update parameters of existing TIFF image.
+*AsposeImagingCloud::ImagingApi* | [**modify_web_p**](docs/ImagingApi.md#modify_web_p) | **GET** /imaging/{name}/webp | Update parameters of existing WEBP image.
+*AsposeImagingCloud::ImagingApi* | [**modify_wmf**](docs/ImagingApi.md#modify_wmf) | **GET** /imaging/{name}/wmf | Process existing WMF image using given parameters.
+*AsposeImagingCloud::ImagingApi* | [**move_file**](docs/ImagingApi.md#move_file) | **PUT** /imaging/storage/file/move/{srcPath} | Move file
+*AsposeImagingCloud::ImagingApi* | [**move_folder**](docs/ImagingApi.md#move_folder) | **PUT** /imaging/storage/folder/move/{srcPath} | Move folder
+*AsposeImagingCloud::ImagingApi* | [**object_exists**](docs/ImagingApi.md#object_exists) | **GET** /imaging/storage/exist/{path} | Check if file or folder exists
+*AsposeImagingCloud::ImagingApi* | [**resize_image**](docs/ImagingApi.md#resize_image) | **GET** /imaging/{name}/resize | Resize an existing image.
+*AsposeImagingCloud::ImagingApi* | [**rotate_flip_image**](docs/ImagingApi.md#rotate_flip_image) | **GET** /imaging/{name}/rotateflip | Rotate and/or flip an existing image.
+*AsposeImagingCloud::ImagingApi* | [**storage_exists**](docs/ImagingApi.md#storage_exists) | **GET** /imaging/storage/{storageName}/exist | Check if storage exists
+*AsposeImagingCloud::ImagingApi* | [**update_image**](docs/ImagingApi.md#update_image) | **GET** /imaging/{name}/updateImage | Perform scaling, cropping and flipping of an existing image in a single request.
+*AsposeImagingCloud::ImagingApi* | [**update_image_features**](docs/ImagingApi.md#update_image_features) | **PUT** /imaging/ai/imageSearch/{searchContextId}/features | Update images features in search context. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream.
+*AsposeImagingCloud::ImagingApi* | [**update_search_image**](docs/ImagingApi.md#update_search_image) | **PUT** /imaging/ai/imageSearch/{searchContextId}/image | Update image and images features in search context. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream.
+*AsposeImagingCloud::ImagingApi* | [**upload_file**](docs/ImagingApi.md#upload_file) | **PUT** /imaging/storage/file/{path} | Upload file
+
+
+## Documentation for Models
+
+ - [AsposeImagingCloud::BmpProperties](docs/BmpProperties.md)
+ - [AsposeImagingCloud::DetectedObject](docs/DetectedObject.md)
+ - [AsposeImagingCloud::DetectedObjectList](docs/DetectedObjectList.md)
+ - [AsposeImagingCloud::DicomProperties](docs/DicomProperties.md)
+ - [AsposeImagingCloud::DiscUsage](docs/DiscUsage.md)
+ - [AsposeImagingCloud::DjvuProperties](docs/DjvuProperties.md)
+ - [AsposeImagingCloud::DngProperties](docs/DngProperties.md)
+ - [AsposeImagingCloud::Error](docs/Error.md)
+ - [AsposeImagingCloud::ErrorDetails](docs/ErrorDetails.md)
+ - [AsposeImagingCloud::ExifData](docs/ExifData.md)
+ - [AsposeImagingCloud::FileVersions](docs/FileVersions.md)
+ - [AsposeImagingCloud::FilesList](docs/FilesList.md)
+ - [AsposeImagingCloud::FilesUploadResult](docs/FilesUploadResult.md)
+ - [AsposeImagingCloud::FilterPropertiesBase](docs/FilterPropertiesBase.md)
+ - [AsposeImagingCloud::GifProperties](docs/GifProperties.md)
+ - [AsposeImagingCloud::ImageDuplicates](docs/ImageDuplicates.md)
+ - [AsposeImagingCloud::ImageDuplicatesSet](docs/ImageDuplicatesSet.md)
+ - [AsposeImagingCloud::ImageFeatures](docs/ImageFeatures.md)
+ - [AsposeImagingCloud::ImagingResponse](docs/ImagingResponse.md)
+ - [AsposeImagingCloud::JfifData](docs/JfifData.md)
+ - [AsposeImagingCloud::Jpeg2000Properties](docs/Jpeg2000Properties.md)
+ - [AsposeImagingCloud::JpegProperties](docs/JpegProperties.md)
+ - [AsposeImagingCloud::ObjectExist](docs/ObjectExist.md)
+ - [AsposeImagingCloud::OdgMetadata](docs/OdgMetadata.md)
+ - [AsposeImagingCloud::OdgPage](docs/OdgPage.md)
+ - [AsposeImagingCloud::OdgProperties](docs/OdgProperties.md)
+ - [AsposeImagingCloud::PngProperties](docs/PngProperties.md)
+ - [AsposeImagingCloud::PsdProperties](docs/PsdProperties.md)
+ - [AsposeImagingCloud::Rectangle](docs/Rectangle.md)
+ - [AsposeImagingCloud::SearchContextStatus](docs/SearchContextStatus.md)
+ - [AsposeImagingCloud::SearchResult](docs/SearchResult.md)
+ - [AsposeImagingCloud::SearchResultsSet](docs/SearchResultsSet.md)
+ - [AsposeImagingCloud::StorageExist](docs/StorageExist.md)
+ - [AsposeImagingCloud::StorageFile](docs/StorageFile.md)
+ - [AsposeImagingCloud::SvgProperties](docs/SvgProperties.md)
+ - [AsposeImagingCloud::TiffFrame](docs/TiffFrame.md)
+ - [AsposeImagingCloud::TiffOptions](docs/TiffOptions.md)
+ - [AsposeImagingCloud::TiffProperties](docs/TiffProperties.md)
+ - [AsposeImagingCloud::WebPProperties](docs/WebPProperties.md)
+ - [AsposeImagingCloud::BigRectangularFilterProperties](docs/BigRectangularFilterProperties.md)
+ - [AsposeImagingCloud::BilateralSmoothingFilterProperties](docs/BilateralSmoothingFilterProperties.md)
+ - [AsposeImagingCloud::ConvolutionFilterProperties](docs/ConvolutionFilterProperties.md)
+ - [AsposeImagingCloud::DeconvolutionFilterProperties](docs/DeconvolutionFilterProperties.md)
+ - [AsposeImagingCloud::FileVersion](docs/FileVersion.md)
+ - [AsposeImagingCloud::JpegExifData](docs/JpegExifData.md)
+ - [AsposeImagingCloud::MedianFilterProperties](docs/MedianFilterProperties.md)
+ - [AsposeImagingCloud::SmallRectangularFilterProperties](docs/SmallRectangularFilterProperties.md)
+ - [AsposeImagingCloud::GaussWienerFilterProperties](docs/GaussWienerFilterProperties.md)
+ - [AsposeImagingCloud::GaussianBlurFilterProperties](docs/GaussianBlurFilterProperties.md)
+ - [AsposeImagingCloud::MotionWienerFilterProperties](docs/MotionWienerFilterProperties.md)
+ - [AsposeImagingCloud::SharpenFilterProperties](docs/SharpenFilterProperties.md)
+
+
+## Documentation for Authorization
+
+
+### JWT
+
+- **Type**: OAuth
+- **Flow**: application
+- **Authorization URL**: 
+- **Scopes**: N/A
 
-## Code generator
-The solution is updated using [code generator](https://github.com/aspose-imaging-cloud/aspose-imaging-cloud-codegen).

data/lib/aspose-imaging-cloud.rb

@@ -1,6 +1,6 @@
 #  ----------------------------------------------------------------------------
 #  <copyright company="Aspose" file="aspose-imaging-cloud.rb">
-#    Copyright (c) 2018-2019 Aspose Pty Ltd. All rights reserved.
+#    Copyright (c) 2018-2020 Aspose Pty Ltd. All rights reserved.
 #  </copyright>
 #  <summary>
 #    Permission is hereby granted, free of charge, to any person obtaining a
@@ -31,7 +31,10 @@ require_relative './aspose-imaging-cloud/version'
 require_relative './aspose-imaging-cloud/configuration'
 
 # Models
+require_relative './aspose-imaging-cloud/models/available_labels_list'
 require_relative './aspose-imaging-cloud/models/bmp_properties'
+require_relative './aspose-imaging-cloud/models/detected_object'
+require_relative './aspose-imaging-cloud/models/detected_object_list'
 require_relative './aspose-imaging-cloud/models/dicom_properties'
 require_relative './aspose-imaging-cloud/models/disc_usage'
 require_relative './aspose-imaging-cloud/models/djvu_properties'
@@ -57,6 +60,7 @@ require_relative './aspose-imaging-cloud/models/odg_page'
 require_relative './aspose-imaging-cloud/models/odg_properties'
 require_relative './aspose-imaging-cloud/models/png_properties'
 require_relative './aspose-imaging-cloud/models/psd_properties'
+require_relative './aspose-imaging-cloud/models/rectangle'
 require_relative './aspose-imaging-cloud/models/search_context_status'
 require_relative './aspose-imaging-cloud/models/search_result'
 require_relative './aspose-imaging-cloud/models/search_results_set'
@@ -88,14 +92,18 @@ require_relative 'aspose-imaging-cloud/api/imaging_api'
 require_relative './aspose-imaging-cloud/models/requests/add_search_image_request'
 require_relative './aspose-imaging-cloud/models/requests/append_tiff_request'
 require_relative './aspose-imaging-cloud/models/requests/compare_images_request'
+require_relative './aspose-imaging-cloud/models/requests/convert_image_request'
 require_relative './aspose-imaging-cloud/models/requests/convert_tiff_to_fax_request'
 require_relative './aspose-imaging-cloud/models/requests/copy_file_request'
 require_relative './aspose-imaging-cloud/models/requests/copy_folder_request'
+require_relative './aspose-imaging-cloud/models/requests/create_converted_image_request'
 require_relative './aspose-imaging-cloud/models/requests/create_cropped_image_request'
 require_relative './aspose-imaging-cloud/models/requests/create_deskewed_image_request'
+require_relative './aspose-imaging-cloud/models/requests/create_fax_tiff_request'
 require_relative './aspose-imaging-cloud/models/requests/create_folder_request'
 require_relative './aspose-imaging-cloud/models/requests/create_grayscaled_image_request'
 require_relative './aspose-imaging-cloud/models/requests/create_image_features_request'
+require_relative './aspose-imaging-cloud/models/requests/create_image_frame_range_request'
 require_relative './aspose-imaging-cloud/models/requests/create_image_frame_request'
 require_relative './aspose-imaging-cloud/models/requests/create_image_search_request'
 require_relative './aspose-imaging-cloud/models/requests/create_image_tag_request'
@@ -109,10 +117,11 @@ require_relative './aspose-imaging-cloud/models/requests/create_modified_svg_req
 require_relative './aspose-imaging-cloud/models/requests/create_modified_tiff_request'
 require_relative './aspose-imaging-cloud/models/requests/create_modified_web_p_request'
 require_relative './aspose-imaging-cloud/models/requests/create_modified_wmf_request'
+require_relative './aspose-imaging-cloud/models/requests/create_object_bounds_request'
 require_relative './aspose-imaging-cloud/models/requests/create_resized_image_request'
 require_relative './aspose-imaging-cloud/models/requests/create_rotate_flipped_image_request'
-require_relative './aspose-imaging-cloud/models/requests/create_saved_image_as_request'
 require_relative './aspose-imaging-cloud/models/requests/create_updated_image_request'
+require_relative './aspose-imaging-cloud/models/requests/create_visual_object_bounds_request'
 require_relative './aspose-imaging-cloud/models/requests/create_web_site_image_features_request'
 require_relative './aspose-imaging-cloud/models/requests/crop_image_request'
 require_relative './aspose-imaging-cloud/models/requests/delete_file_request'
@@ -129,15 +138,19 @@ require_relative './aspose-imaging-cloud/models/requests/filter_effect_image_req
 require_relative './aspose-imaging-cloud/models/requests/find_images_by_tags_request'
 require_relative './aspose-imaging-cloud/models/requests/find_image_duplicates_request'
 require_relative './aspose-imaging-cloud/models/requests/find_similar_images_request'
+require_relative './aspose-imaging-cloud/models/requests/get_available_labels_request'
 require_relative './aspose-imaging-cloud/models/requests/get_disc_usage_request'
 require_relative './aspose-imaging-cloud/models/requests/get_files_list_request'
 require_relative './aspose-imaging-cloud/models/requests/get_file_versions_request'
 require_relative './aspose-imaging-cloud/models/requests/get_image_features_request'
 require_relative './aspose-imaging-cloud/models/requests/get_image_frame_properties_request'
+require_relative './aspose-imaging-cloud/models/requests/get_image_frame_range_request'
 require_relative './aspose-imaging-cloud/models/requests/get_image_frame_request'
 require_relative './aspose-imaging-cloud/models/requests/get_image_properties_request'
 require_relative './aspose-imaging-cloud/models/requests/get_image_search_status_request'
+require_relative './aspose-imaging-cloud/models/requests/get_object_bounds_request'
 require_relative './aspose-imaging-cloud/models/requests/get_search_image_request'
+require_relative './aspose-imaging-cloud/models/requests/get_visual_object_bounds_request'
 require_relative './aspose-imaging-cloud/models/requests/grayscale_image_request'
 require_relative './aspose-imaging-cloud/models/requests/http_request'
 require_relative './aspose-imaging-cloud/models/requests/imaging_request'
@@ -156,7 +169,6 @@ require_relative './aspose-imaging-cloud/models/requests/move_folder_request'
 require_relative './aspose-imaging-cloud/models/requests/object_exists_request'
 require_relative './aspose-imaging-cloud/models/requests/resize_image_request'
 require_relative './aspose-imaging-cloud/models/requests/rotate_flip_image_request'
-require_relative './aspose-imaging-cloud/models/requests/save_image_as_request'
 require_relative './aspose-imaging-cloud/models/requests/storage_exists_request'
 require_relative './aspose-imaging-cloud/models/requests/update_image_features_request'
 require_relative './aspose-imaging-cloud/models/requests/update_image_request'

data/lib/aspose-imaging-cloud/api/imaging_api.rb

@@ -1,6 +1,6 @@
 #  ----------------------------------------------------------------------------
 #  <copyright company="Aspose" file="imaging_api.rb">
-#    Copyright (c) 2018-2019 Aspose Pty Ltd. All rights reserved.
+#    Copyright (c) 2018-2020 Aspose Pty Ltd. All rights reserved.
 #  </copyright>
 #  <summary>
 #    Permission is hereby granted, free of charge, to any person obtaining a
@@ -67,6 +67,14 @@ module AsposeImagingCloud
       make_request(http_request, :POST, 'SearchResultsSet')
     end
 
+    # Convert existing image to another format.
+    # @param [convert_imageRequest] request Request object.
+    # @return [File]
+    def convert_image(request)
+      http_request = request.to_http_info(@api_client.config)
+      make_request(http_request, :GET, 'File')
+    end
+
     # Update parameters of existing TIFF image accordingly to fax parameters.
     # @param [convert_tiff_to_faxRequest] request Request object.
     # @return [File]
@@ -93,6 +101,14 @@ module AsposeImagingCloud
       nil
     end
 
+    # Convert existing image to another format. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.             
+    # @param [create_converted_imageRequest] request Request object.
+    # @return [File]
+    def create_converted_image(request)
+      http_request = request.to_http_info(@api_client.config)
+      make_request(http_request, :POST, 'File')
+    end
+
     # Crop an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
     # @param [create_cropped_imageRequest] request Request object.
     # @return [File]
@@ -109,6 +125,14 @@ module AsposeImagingCloud
       make_request(http_request, :POST, 'File')
     end
 
+    # Update parameters of TIFF image accordingly to fax parameters. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
+    # @param [create_fax_tiffRequest] request Request object.
+    # @return [File]
+    def create_fax_tiff(request)
+      http_request = request.to_http_info(@api_client.config)
+      make_request(http_request, :POST, 'File')
+    end
+
     # Create the folder
     # @param [create_folderRequest] request Request object.
     # @return [nil]
@@ -135,7 +159,7 @@ module AsposeImagingCloud
       nil
     end
 
-    # Get separate frame from existing TIFF image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
+    # Get separate frame from existing image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
     # @param [create_image_frameRequest] request Request object.
     # @return [File]
     def create_image_frame(request)
@@ -143,6 +167,14 @@ module AsposeImagingCloud
       make_request(http_request, :POST, 'File')
     end
 
+    # Get frames range from existing image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
+    # @param [create_image_frame_rangeRequest] request Request object.
+    # @return [File]
+    def create_image_frame_range(request)
+      http_request = request.to_http_info(@api_client.config)
+      make_request(http_request, :POST, 'File')
+    end
+
     # Create new search context.
     # @param [create_image_searchRequest] request Request object.
     # @return [SearchContextStatus]
@@ -240,6 +272,14 @@ module AsposeImagingCloud
       make_request(http_request, :POST, 'File')
     end
 
+    # Detects objects bounds. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
+    # @param [create_object_boundsRequest] request Request object.
+    # @return [DetectedObjectList]
+    def create_object_bounds(request)
+      http_request = request.to_http_info(@api_client.config)
+      make_request(http_request, :POST, 'DetectedObjectList')
+    end
+
     # Resize an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
     # @param [create_resized_imageRequest] request Request object.
     # @return [File]
@@ -256,18 +296,18 @@ module AsposeImagingCloud
       make_request(http_request, :POST, 'File')
     end
 
-    # Export existing image to another format. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.             
-    # @param [create_saved_image_asRequest] request Request object.
+    # Perform scaling, cropping and flipping of an image in a single request. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
+    # @param [create_updated_imageRequest] request Request object.
     # @return [File]
-    def create_saved_image_as(request)
+    def create_updated_image(request)
       http_request = request.to_http_info(@api_client.config)
       make_request(http_request, :POST, 'File')
     end
 
-    # Perform scaling, cropping and flipping of an image in a single request. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
-    # @param [create_updated_imageRequest] request Request object.
+    # Detects objects bounds and draw them on the original image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream
+    # @param [create_visual_object_boundsRequest] request Request object.
     # @return [File]
-    def create_updated_image(request)
+    def create_visual_object_bounds(request)
       http_request = request.to_http_info(@api_client.config)
       make_request(http_request, :POST, 'File')
     end
@@ -358,7 +398,7 @@ module AsposeImagingCloud
       make_request(http_request, :GET, 'ImageFeatures')
     end
 
-    # Get separate frame properties of existing TIFF image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
+    # Get separate frame properties of existing image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
     # @param [extract_image_frame_propertiesRequest] request Request object.
     # @return [ImagingResponse]
     def extract_image_frame_properties(request)
@@ -406,6 +446,14 @@ module AsposeImagingCloud
       make_request(http_request, :GET, 'SearchResultsSet')
     end
 
+    # Detects objects bounds and draw them on the original image
+    # @param [get_available_labelsRequest] request Request object.
+    # @return [AvailableLabelsList]
+    def get_available_labels(request)
+      http_request = request.to_http_info(@api_client.config)
+      make_request(http_request, :GET, 'AvailableLabelsList')
+    end
+
     # Get disc usage
     # @param [get_disc_usageRequest] request Request object.
     # @return [DiscUsage]
@@ -438,7 +486,7 @@ module AsposeImagingCloud
       make_request(http_request, :GET, 'ImageFeatures')
     end
 
-    # Get separate frame from existing TIFF image.
+    # Get separate frame from existing image.
     # @param [get_image_frameRequest] request Request object.
     # @return [File]
     def get_image_frame(request)
@@ -446,7 +494,7 @@ module AsposeImagingCloud
       make_request(http_request, :GET, 'File')
     end
 
-    # Get separate frame properties of existing TIFF image.
+    # Get separate frame properties of existing image.
     # @param [get_image_frame_propertiesRequest] request Request object.
     # @return [ImagingResponse]
     def get_image_frame_properties(request)
@@ -454,6 +502,14 @@ module AsposeImagingCloud
       make_request(http_request, :GET, 'ImagingResponse')
     end
 
+    # Get frames range from existing image.
+    # @param [get_image_frame_rangeRequest] request Request object.
+    # @return [File]
+    def get_image_frame_range(request)
+      http_request = request.to_http_info(@api_client.config)
+      make_request(http_request, :GET, 'File')
+    end
+
     # Get properties of an image.
     # @param [get_image_propertiesRequest] request Request object.
     # @return [ImagingResponse]
@@ -470,6 +526,14 @@ module AsposeImagingCloud
       make_request(http_request, :GET, 'SearchContextStatus')
     end
 
+    # Detects objects' bounds
+    # @param [get_object_boundsRequest] request Request object.
+    # @return [DetectedObjectList]
+    def get_object_bounds(request)
+      http_request = request.to_http_info(@api_client.config)
+      make_request(http_request, :GET, 'DetectedObjectList')
+    end
+
     # Get image from search context
     # @param [get_search_imageRequest] request Request object.
     # @return [File]
@@ -478,6 +542,14 @@ module AsposeImagingCloud
       make_request(http_request, :GET, 'File')
     end
 
+    # Detects objects bounds and draw them on the original image
+    # @param [get_visual_object_boundsRequest] request Request object.
+    # @return [File]
+    def get_visual_object_bounds(request)
+      http_request = request.to_http_info(@api_client.config)
+      make_request(http_request, :GET, 'File')
+    end
+
     # Grayscale an existing image.
     # @param [grayscale_imageRequest] request Request object.
     # @return [File]
@@ -608,14 +680,6 @@ module AsposeImagingCloud
       make_request(http_request, :GET, 'File')
     end
 
-    # Export existing image to another format.
-    # @param [save_image_asRequest] request Request object.
-    # @return [File]
-    def save_image_as(request)
-      http_request = request.to_http_info(@api_client.config)
-      make_request(http_request, :GET, 'File')
-    end
-
     # Check if storage exists
     # @param [storage_existsRequest] request Request object.
     # @return [StorageExist]