aspose_imaging_cloud 20.1.1 → 20.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (9) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +116 -209
  3. data/lib/aspose-imaging-cloud.rb +2 -0
  4. data/lib/aspose-imaging-cloud/api/imaging_api.rb +16 -0
  5. data/lib/aspose-imaging-cloud/api_client.rb +1 -1
  6. data/lib/aspose-imaging-cloud/models/requests/create_grayscaled_image_request.rb +81 -0
  7. data/lib/aspose-imaging-cloud/models/requests/deskew_image_request.rb +1 -1
  8. data/lib/aspose-imaging-cloud/models/requests/grayscale_image_request.rb +80 -0
  9. metadata +4 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ac5b50616fe35d99eaee5a9e6ddcd50cd4e823fc15fe8b9a20d2d963f614087f
4
- data.tar.gz: 066e1512dfb9046b8cd31942fe469b8c1b582eaedc9b59110b5a6dc5349f08b0
3
+ metadata.gz: '0688c4217b35e6f496dbea423c8e247e666e9dad30b63f70aa548f7ebab2331b'
4
+ data.tar.gz: b2ad7bd22ba059e064d917420ffb19472ca9351aeac7f31dd207dca0f8139ec9
5
5
  SHA512:
6
- metadata.gz: 994f261d328ddea8dc8bfb60629424f66c2fcedbb89210b83d9ffc0dc7e9be9b1be5495b6d5e936061c2b92ad1e3e150af62122a1900d7aa5d36b3a3d2a9110a
7
- data.tar.gz: c94c54ef455908c167951e5a55bf2c30e8f087cd69f71b5b6c38fa1870446e9f6d05b68395a0e4123c121732df8191d6c83073741c79c0013a0e47fa35380f4c
6
+ metadata.gz: ed2501df61ab9640548efdd177de73c7b1ba945b357e748c85527f307960399e11cdec248b1a9781a2c1cc99d3f916867d326264bca2f9ac0431ffd740e86b23
7
+ data.tar.gz: e2987ab4ed18c03a8f93c1e23a76850faf8f2f5e42bdc9b3da9c60b2e6add5a2f4420cdfce8a82756653811fc9d91caa5b75df415748784fc196943c021e7371
data/README.md CHANGED
@@ -1,224 +1,131 @@
1
- # aspose_imaging_cloud
1
+ # Aspose.Imaging Cloud Ruby SDK
2
+ [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.
3
+
4
+ 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.
5
+
6
+ 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).
7
+
8
+ The solution is updated using [code generator](https://github.com/aspose-imaging-cloud/aspose-imaging-cloud-codegen).
9
+
10
+ ## Key Features
11
+ #### Image Formats Support
12
+ Export the following images to various formats (generally supported ones are BMP, PSD, JPEG, TIFF, GIF, PNG, JPEG2000, WEBP and PDF):
13
+ * BMP
14
+ * GIF
15
+ * DJVU
16
+ * WMF
17
+ * EMF
18
+ * JPEG
19
+ * JPEG2000
20
+ * PSD
21
+ * TIFF
22
+ * WEBP
23
+ * PNG
24
+ * DICOM
25
+ * CDR
26
+ * ODG
27
+ * OTG
28
+ * DNG
29
+ * SVG
30
+ * CMX
31
+
32
+ Process options, change and return images in the same format:
33
+ * PSD
34
+ * JPEG
35
+ * TIFF
36
+ * GIF
37
+ * BMP
38
+ * JPEG2000
39
+ * WEBP
40
+
41
+ Process options, change and return images in any supported export format:
42
+ * EMF
43
+ * WMF
44
+
45
+ #### Supported Imaging Operations
46
+ * Export
47
+ * Resize
48
+ * Crop
49
+ * Rotate and Flip
50
+ * TIFF frames extraction
51
+ * TIFF frames manipulation
52
+ * TIFF concatenation
53
+ * TIFF conversion to fax-friendly format
54
+ * Retrieve & update image properties
55
+ * Conversion to and from PSD format
56
+
57
+ #### Supported Imaging AI Operations
58
+ * Content-based image search
59
+ * Image duplicates search
60
+ * Image search by custom registered tags
61
+ * Image comparison and similarity detection
62
+ * Image features extraction (for now, AKAZE detector is supported)
63
+
64
+ 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!
65
+
66
+ #### Storage API support
67
+ 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!
68
+
69
+ It gives you an ability to:
70
+ * Upload, download, copy, move and delete files, including versions handling (if you are using Cloud storage that supports this feature - true by default)
71
+ * Create, copy, move and delete folders
72
+ * Copy and move files and folders accross separate storages in scope of a single operation
73
+ * Check if certain file, folder or storage exists
74
+
75
+ Detalied official documentation can be found at the [following link](https://docs.aspose.cloud/display/imagingcloud).
2
76
 
3
- AsposeImagingCloud - the Ruby gem for the Aspose.Imaging Cloud API Reference
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: 3.0
10
- - Package version: 1.0.0
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:
77
+ ## Getting Started
78
+ 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).
79
+ 2. **Minimum requirements**. This SDK requires [Python 2.5 or later](https://www.ruby-lang.org/en/downloads/).
80
+ 3. **Install Aspose.Imaging Cloud Python SDK**.
18
81
 
19
- ```shell
20
- gem build aspose_imaging_cloud.gemspec
82
+ Please, install the following [Ruby gem](https://rubygems.org/gems/aspose-imaging-cloud/) using command line.
21
83
  ```
22
-
23
- Then either install the gem locally:
24
-
25
- ```shell
26
- gem install ./aspose_imaging_cloud.gem
84
+ gem install aspose_imaging_cloud
27
85
  ```
28
- (for development, run `gem install --dev ./aspose_imaging_cloud.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 'aspose_imaging_cloud', '~> 20.1.1'
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 'aspose_imaging_cloud', :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:
86
+ Import the dependencies to your code as follows.
53
87
  ```ruby
54
- # Load the gem
55
88
  require 'aspose_imaging_cloud'
89
+ ```
90
+ 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.
91
+
92
+ ## Quick Examples
93
+ Please, look at [Examples](EXAMPLES.md) document for basic usage or use the [Examples](Examples) folder for more sophisticated scenarios.
56
94
 
57
- # Setup authorization
58
- AsposeImagingCloud.configure do |config|
59
- # Configure OAuth2 access token for authorization: JWT
60
- config.access_token = 'YOUR ACCESS TOKEN'
61
- end
95
+ #### Aspose Cloud-hosted service VS on-premise deployment (*experimental feature*)
96
+ 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.
97
+ The details about key differences and deployment process will be described on the dedicated Docker Hub page as soon as it's released.
62
98
 
63
- api_instance = AsposeImagingCloud::ImagingApi.new
99
+ To succeed with your on-premise service usage by the SDK, you need to:
100
+ 1. Use the API class constructor with base URL required parameter, API version and debug mode optional parameters, skipping the credentials parameters.
101
+ ```ruby
102
+ ImagingApi.new(nil, nil, 'yourServiceUrl')
103
+ ```
104
+ 2. Set *storage* or *storageName* parameters for each request where they're present (mandatory!).
64
105
 
65
- search_context_id = 'search_context_id_example' # String | Search context identifier.
106
+ ## Content
107
+ 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.
66
108
 
67
- image_id = 'image_id_example' # String | Image identifier.
109
+ ## Dependencies
110
+ * [Ruby 2.5 or later](https://www.ruby-lang.org/en/downloads/)
68
111
 
69
- opts = {
70
- image_data: File.new('/path/to/file.txt'), # File | Input image
71
- folder: 'folder_example', # String | Folder.
72
- storage: 'storage_example' # String | Storage
73
- }
112
+ ## Licensing
113
+ All Aspose.Imaging Cloud SDKs, helper scripts and templates are licensed under [MIT License](LICENSE).
74
114
 
75
- begin
76
- #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.
77
- api_instance.add_search_image(search_context_id, image_id, opts)
78
- rescue AsposeImagingCloud::ApiError => e
79
- puts "Exception when calling ImagingApi->add_search_image: #{e}"
80
- end
115
+ ## Contact Us
116
+ Your feedback is very important to us. Please feel free to contact via
117
+ + [**Free Support Forum**](https://forum.aspose.cloud/c/imaging)
118
+ + [**Paid Support Helpdesk**](https://helpdesk.aspose.cloud/)
81
119
 
82
- ```
120
+ ## Resources
121
+ + [**Web API reference**](https://apireference.aspose.cloud/imaging/)
122
+ + [**Website**](https://www.aspose.cloud)
123
+ + [**Product Home**](https://products.aspose.cloud/imaging)
124
+ + [**Documentation**](https://docs.aspose.cloud/display/imagingcloud/Home)
125
+ + [**Blog**](https://blog.aspose.cloud/category/aspose-products/aspose.imaging-cloud/)
83
126
 
84
- ## Documentation for API Endpoints
85
-
86
- All URIs are relative to *https://api-qa.aspose.cloud/v3.0*
87
-
88
- Class | Method | HTTP request | Description
89
- ------------ | ------------- | ------------- | -------------
90
- *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.
91
- *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).
92
- *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.
93
- *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.
94
- *AsposeImagingCloud::ImagingApi* | [**copy_file**](docs/ImagingApi.md#copy_file) | **PUT** /imaging/storage/file/copy/{srcPath} | Copy file
95
- *AsposeImagingCloud::ImagingApi* | [**copy_folder**](docs/ImagingApi.md#copy_folder) | **PUT** /imaging/storage/folder/copy/{srcPath} | Copy folder
96
- *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.
97
- *AsposeImagingCloud::ImagingApi* | [**create_folder**](docs/ImagingApi.md#create_folder) | **PUT** /imaging/storage/folder/{path} | Create the folder
98
- *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.
99
- *AsposeImagingCloud::ImagingApi* | [**create_image_frame**](docs/ImagingApi.md#create_image_frame) | **POST** /imaging/frames/{frameId} | Get separate frame from existing TIFF image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
100
- *AsposeImagingCloud::ImagingApi* | [**create_image_search**](docs/ImagingApi.md#create_image_search) | **POST** /imaging/ai/imageSearch/create | Create new search context.
101
- *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.
102
- *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.
103
- *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.
104
- *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.
105
- *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.
106
- *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.
107
- *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.
108
- *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.
109
- *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.
110
- *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.
111
- *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.
112
- *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.
113
- *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.
114
- *AsposeImagingCloud::ImagingApi* | [**create_saved_image_as**](docs/ImagingApi.md#create_saved_image_as) | **POST** /imaging/saveAs | Export existing image to another format. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
115
- *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.
116
- *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
117
- *AsposeImagingCloud::ImagingApi* | [**crop_image**](docs/ImagingApi.md#crop_image) | **GET** /imaging/{name}/crop | Crop an existing image.
118
- *AsposeImagingCloud::ImagingApi* | [**delete_file**](docs/ImagingApi.md#delete_file) | **DELETE** /imaging/storage/file/{path} | Delete file
119
- *AsposeImagingCloud::ImagingApi* | [**delete_folder**](docs/ImagingApi.md#delete_folder) | **DELETE** /imaging/storage/folder/{path} | Delete folder
120
- *AsposeImagingCloud::ImagingApi* | [**delete_image_features**](docs/ImagingApi.md#delete_image_features) | **DELETE** /imaging/ai/imageSearch/{searchContextId}/features | Deletes image features from search context.
121
- *AsposeImagingCloud::ImagingApi* | [**delete_image_search**](docs/ImagingApi.md#delete_image_search) | **DELETE** /imaging/ai/imageSearch/{searchContextId} | Deletes the search context.
122
- *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
123
- *AsposeImagingCloud::ImagingApi* | [**download_file**](docs/ImagingApi.md#download_file) | **GET** /imaging/storage/file/{path} | Download file
124
- *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.
125
- *AsposeImagingCloud::ImagingApi* | [**extract_image_frame_properties**](docs/ImagingApi.md#extract_image_frame_properties) | **POST** /imaging/frames/{frameId}/properties | Get separate frame properties of existing TIFF image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
126
- *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.
127
- *AsposeImagingCloud::ImagingApi* | [**filter_effect_image**](docs/ImagingApi.md#filter_effect_image) | **PUT** /imaging/{name}/filterEffect | Apply filtering effects to an existing image.
128
- *AsposeImagingCloud::ImagingApi* | [**find_image_duplicates**](docs/ImagingApi.md#find_image_duplicates) | **GET** /imaging/ai/imageSearch/{searchContextId}/findDuplicates | Find images duplicates.
129
- *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.
130
- *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.
131
- *AsposeImagingCloud::ImagingApi* | [**get_disc_usage**](docs/ImagingApi.md#get_disc_usage) | **GET** /imaging/storage/disc | Get disc usage
132
- *AsposeImagingCloud::ImagingApi* | [**get_file_versions**](docs/ImagingApi.md#get_file_versions) | **GET** /imaging/storage/version/{path} | Get file versions
133
- *AsposeImagingCloud::ImagingApi* | [**get_files_list**](docs/ImagingApi.md#get_files_list) | **GET** /imaging/storage/folder/{path} | Get all files and folders within a folder
134
- *AsposeImagingCloud::ImagingApi* | [**get_image_features**](docs/ImagingApi.md#get_image_features) | **GET** /imaging/ai/imageSearch/{searchContextId}/features | Gets image features from search context.
135
- *AsposeImagingCloud::ImagingApi* | [**get_image_frame**](docs/ImagingApi.md#get_image_frame) | **GET** /imaging/{name}/frames/{frameId} | Get separate frame from existing TIFF image.
136
- *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 TIFF image.
137
- *AsposeImagingCloud::ImagingApi* | [**get_image_properties**](docs/ImagingApi.md#get_image_properties) | **GET** /imaging/{name}/properties | Get properties of an image.
138
- *AsposeImagingCloud::ImagingApi* | [**get_image_search_status**](docs/ImagingApi.md#get_image_search_status) | **GET** /imaging/ai/imageSearch/{searchContextId}/status | Gets the search context status.
139
- *AsposeImagingCloud::ImagingApi* | [**get_search_image**](docs/ImagingApi.md#get_search_image) | **GET** /imaging/ai/imageSearch/{searchContextId}/image | Get image from search context
140
- *AsposeImagingCloud::ImagingApi* | [**modify_bmp**](docs/ImagingApi.md#modify_bmp) | **GET** /imaging/{name}/bmp | Update parameters of existing BMP image.
141
- *AsposeImagingCloud::ImagingApi* | [**modify_emf**](docs/ImagingApi.md#modify_emf) | **GET** /imaging/{name}/emf | Process existing EMF imaging using given parameters.
142
- *AsposeImagingCloud::ImagingApi* | [**modify_gif**](docs/ImagingApi.md#modify_gif) | **GET** /imaging/{name}/gif | Update parameters of existing GIF image.
143
- *AsposeImagingCloud::ImagingApi* | [**modify_jpeg**](docs/ImagingApi.md#modify_jpeg) | **GET** /imaging/{name}/jpg | Update parameters of existing JPEG image.
144
- *AsposeImagingCloud::ImagingApi* | [**modify_jpeg2000**](docs/ImagingApi.md#modify_jpeg2000) | **GET** /imaging/{name}/jpg2000 | Update parameters of existing JPEG2000 image.
145
- *AsposeImagingCloud::ImagingApi* | [**modify_psd**](docs/ImagingApi.md#modify_psd) | **GET** /imaging/{name}/psd | Update parameters of existing PSD image.
146
- *AsposeImagingCloud::ImagingApi* | [**modify_svg**](docs/ImagingApi.md#modify_svg) | **GET** /imaging/{name}/svg | Update parameters of existing SVG image.
147
- *AsposeImagingCloud::ImagingApi* | [**modify_tiff**](docs/ImagingApi.md#modify_tiff) | **GET** /imaging/{name}/tiff | Update parameters of existing TIFF image.
148
- *AsposeImagingCloud::ImagingApi* | [**modify_web_p**](docs/ImagingApi.md#modify_web_p) | **GET** /imaging/{name}/webp | Update parameters of existing WEBP image.
149
- *AsposeImagingCloud::ImagingApi* | [**modify_wmf**](docs/ImagingApi.md#modify_wmf) | **GET** /imaging/{name}/wmf | Process existing WMF image using given parameters.
150
- *AsposeImagingCloud::ImagingApi* | [**move_file**](docs/ImagingApi.md#move_file) | **PUT** /imaging/storage/file/move/{srcPath} | Move file
151
- *AsposeImagingCloud::ImagingApi* | [**move_folder**](docs/ImagingApi.md#move_folder) | **PUT** /imaging/storage/folder/move/{srcPath} | Move folder
152
- *AsposeImagingCloud::ImagingApi* | [**object_exists**](docs/ImagingApi.md#object_exists) | **GET** /imaging/storage/exist/{path} | Check if file or folder exists
153
- *AsposeImagingCloud::ImagingApi* | [**resize_image**](docs/ImagingApi.md#resize_image) | **GET** /imaging/{name}/resize | Resize an existing image.
154
- *AsposeImagingCloud::ImagingApi* | [**rotate_flip_image**](docs/ImagingApi.md#rotate_flip_image) | **GET** /imaging/{name}/rotateflip | Rotate and/or flip an existing image.
155
- *AsposeImagingCloud::ImagingApi* | [**save_image_as**](docs/ImagingApi.md#save_image_as) | **GET** /imaging/{name}/saveAs | Export existing image to another format.
156
- *AsposeImagingCloud::ImagingApi* | [**storage_exists**](docs/ImagingApi.md#storage_exists) | **GET** /imaging/storage/{storageName}/exist | Check if storage exists
157
- *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.
158
- *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.
159
- *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.
160
- *AsposeImagingCloud::ImagingApi* | [**upload_file**](docs/ImagingApi.md#upload_file) | **PUT** /imaging/storage/file/{path} | Upload file
161
-
162
-
163
- ## Documentation for Models
164
-
165
- - [AsposeImagingCloud::BmpProperties](docs/BmpProperties.md)
166
- - [AsposeImagingCloud::DicomProperties](docs/DicomProperties.md)
167
- - [AsposeImagingCloud::DiscUsage](docs/DiscUsage.md)
168
- - [AsposeImagingCloud::DjvuProperties](docs/DjvuProperties.md)
169
- - [AsposeImagingCloud::DngProperties](docs/DngProperties.md)
170
- - [AsposeImagingCloud::Error](docs/Error.md)
171
- - [AsposeImagingCloud::ErrorDetails](docs/ErrorDetails.md)
172
- - [AsposeImagingCloud::ExifData](docs/ExifData.md)
173
- - [AsposeImagingCloud::FileVersions](docs/FileVersions.md)
174
- - [AsposeImagingCloud::FilesList](docs/FilesList.md)
175
- - [AsposeImagingCloud::FilesUploadResult](docs/FilesUploadResult.md)
176
- - [AsposeImagingCloud::FilterPropertiesBase](docs/FilterPropertiesBase.md)
177
- - [AsposeImagingCloud::GifProperties](docs/GifProperties.md)
178
- - [AsposeImagingCloud::ImageDuplicates](docs/ImageDuplicates.md)
179
- - [AsposeImagingCloud::ImageDuplicatesSet](docs/ImageDuplicatesSet.md)
180
- - [AsposeImagingCloud::ImageFeatures](docs/ImageFeatures.md)
181
- - [AsposeImagingCloud::ImagingResponse](docs/ImagingResponse.md)
182
- - [AsposeImagingCloud::JfifData](docs/JfifData.md)
183
- - [AsposeImagingCloud::Jpeg2000Properties](docs/Jpeg2000Properties.md)
184
- - [AsposeImagingCloud::JpegProperties](docs/JpegProperties.md)
185
- - [AsposeImagingCloud::ObjectExist](docs/ObjectExist.md)
186
- - [AsposeImagingCloud::OdgMetadata](docs/OdgMetadata.md)
187
- - [AsposeImagingCloud::OdgPage](docs/OdgPage.md)
188
- - [AsposeImagingCloud::OdgProperties](docs/OdgProperties.md)
189
- - [AsposeImagingCloud::PngProperties](docs/PngProperties.md)
190
- - [AsposeImagingCloud::PsdProperties](docs/PsdProperties.md)
191
- - [AsposeImagingCloud::SearchContextStatus](docs/SearchContextStatus.md)
192
- - [AsposeImagingCloud::SearchResult](docs/SearchResult.md)
193
- - [AsposeImagingCloud::SearchResultsSet](docs/SearchResultsSet.md)
194
- - [AsposeImagingCloud::StorageExist](docs/StorageExist.md)
195
- - [AsposeImagingCloud::StorageFile](docs/StorageFile.md)
196
- - [AsposeImagingCloud::SvgProperties](docs/SvgProperties.md)
197
- - [AsposeImagingCloud::TiffFrame](docs/TiffFrame.md)
198
- - [AsposeImagingCloud::TiffOptions](docs/TiffOptions.md)
199
- - [AsposeImagingCloud::TiffProperties](docs/TiffProperties.md)
200
- - [AsposeImagingCloud::WebPProperties](docs/WebPProperties.md)
201
- - [AsposeImagingCloud::BigRectangularFilterProperties](docs/BigRectangularFilterProperties.md)
202
- - [AsposeImagingCloud::BilateralSmoothingFilterProperties](docs/BilateralSmoothingFilterProperties.md)
203
- - [AsposeImagingCloud::ConvolutionFilterProperties](docs/ConvolutionFilterProperties.md)
204
- - [AsposeImagingCloud::DeconvolutionFilterProperties](docs/DeconvolutionFilterProperties.md)
205
- - [AsposeImagingCloud::FileVersion](docs/FileVersion.md)
206
- - [AsposeImagingCloud::JpegExifData](docs/JpegExifData.md)
207
- - [AsposeImagingCloud::MedianFilterProperties](docs/MedianFilterProperties.md)
208
- - [AsposeImagingCloud::SmallRectangularFilterProperties](docs/SmallRectangularFilterProperties.md)
209
- - [AsposeImagingCloud::GaussWienerFilterProperties](docs/GaussWienerFilterProperties.md)
210
- - [AsposeImagingCloud::GaussianBlurFilterProperties](docs/GaussianBlurFilterProperties.md)
211
- - [AsposeImagingCloud::MotionWienerFilterProperties](docs/MotionWienerFilterProperties.md)
212
- - [AsposeImagingCloud::SharpenFilterProperties](docs/SharpenFilterProperties.md)
213
-
214
-
215
- ## Documentation for Authorization
216
-
217
-
218
- ### JWT
219
-
220
- - **Type**: OAuth
221
- - **Flow**: application
222
- - **Authorization URL**:
223
- - **Scopes**: N/A
127
+ ## Other languages
128
+ 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).
224
129
 
130
+ ## Code generator
131
+ The solution is updated using [code generator](https://github.com/aspose-imaging-cloud/aspose-imaging-cloud-codegen).
data/lib/aspose-imaging-cloud.rb CHANGED
@@ -94,6 +94,7 @@ require_relative './aspose-imaging-cloud/models/requests/copy_folder_request'
94
94
  require_relative './aspose-imaging-cloud/models/requests/create_cropped_image_request'
95
95
  require_relative './aspose-imaging-cloud/models/requests/create_deskewed_image_request'
96
96
  require_relative './aspose-imaging-cloud/models/requests/create_folder_request'
97
+ require_relative './aspose-imaging-cloud/models/requests/create_grayscaled_image_request'
97
98
  require_relative './aspose-imaging-cloud/models/requests/create_image_features_request'
98
99
  require_relative './aspose-imaging-cloud/models/requests/create_image_frame_request'
99
100
  require_relative './aspose-imaging-cloud/models/requests/create_image_search_request'
@@ -137,6 +138,7 @@ require_relative './aspose-imaging-cloud/models/requests/get_image_frame_request
137
138
  require_relative './aspose-imaging-cloud/models/requests/get_image_properties_request'
138
139
  require_relative './aspose-imaging-cloud/models/requests/get_image_search_status_request'
139
140
  require_relative './aspose-imaging-cloud/models/requests/get_search_image_request'
141
+ require_relative './aspose-imaging-cloud/models/requests/grayscale_image_request'
140
142
  require_relative './aspose-imaging-cloud/models/requests/http_request'
141
143
  require_relative './aspose-imaging-cloud/models/requests/imaging_request'
142
144
  require_relative './aspose-imaging-cloud/models/requests/modify_bmp_request'
data/lib/aspose-imaging-cloud/api/imaging_api.rb CHANGED
@@ -118,6 +118,14 @@ module AsposeImagingCloud
118
118
  nil
119
119
  end
120
120
 
121
+ # Grayscales an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
122
+ # @param [create_grayscaled_imageRequest] request Request object.
123
+ # @return [File]
124
+ def create_grayscaled_image(request)
125
+ http_request = request.to_http_info(@api_client.config)
126
+ make_request(http_request, :POST, 'File')
127
+ end
128
+
121
129
  # 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.
122
130
  # @param [create_image_featuresRequest] request Request object.
123
131
  # @return [nil]
@@ -470,6 +478,14 @@ module AsposeImagingCloud
470
478
  make_request(http_request, :GET, 'File')
471
479
  end
472
480
 
481
+ # Grayscale an existing image.
482
+ # @param [grayscale_imageRequest] request Request object.
483
+ # @return [File]
484
+ def grayscale_image(request)
485
+ http_request = request.to_http_info(@api_client.config)
486
+ make_request(http_request, :GET, 'File')
487
+ end
488
+
473
489
  # Update parameters of existing BMP image.
474
490
  # @param [modify_bmpRequest] request Request object.
475
491
  # @return [File]
data/lib/aspose-imaging-cloud/api_client.rb CHANGED
@@ -54,7 +54,7 @@ module AsposeImagingCloud
54
54
  @config = Configuration.new(app_key, app_sid, base_url, api_version, debug)
55
55
  @default_headers = {
56
56
  'x-aspose-client' => 'ruby sdk',
57
- 'x-aspose-version' => '20.1'
57
+ 'x-aspose-version' => '20.2'
58
58
  }
59
59
  end
60
60
 
data/lib/aspose-imaging-cloud/models/requests/create_grayscaled_image_request.rb ADDED
@@ -0,0 +1,81 @@
1
+ # ----------------------------------------------------------------------------
2
+ # <copyright company="Aspose" file="create_grayscaled_image_request.rb">
3
+ # Copyright (c) 2018-2019 Aspose Pty Ltd. All rights reserved.
4
+ # </copyright>
5
+ # <summary>
6
+ # Permission is hereby granted, free of charge, to any person obtaining a
7
+ # copy of this software and associated documentation files (the "Software"),
8
+ # to deal in the Software without restriction, including without limitation
9
+ # the rights to use, copy, modify, merge, publish, distribute, sublicense,
10
+ # and/or sell copies of the Software, and to permit persons to whom the
11
+ # Software is furnished to do so, subject to the following conditions:
12
+ #
13
+ # The above copyright notice and this permission notice shall be included in
14
+ # all copies or substantial portions of the Software.
15
+ #
16
+ # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
+ # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
+ # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
+ # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
+ # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21
+ # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22
+ # DEALINGS IN THE SOFTWARE.
23
+ # </summary>
24
+ # ----------------------------------------------------------------------------
25
+
26
+
27
+ require_relative './imaging_request'
28
+ require_relative './http_request'
29
+
30
+ module AsposeImagingCloud
31
+ # Request model for create_grayscaled_image operation.
32
+ class CreateGrayscaledImageRequest < ImagingRequest
33
+
34
+ # Grayscales an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
35
+ # @param [File] image_data Input image
36
+ # @param [String] out_path Path to updated file (if this is empty, response contains streamed image)
37
+ # @param [String] storage Your Aspose Cloud Storage name.
38
+ def initialize(image_data, out_path = nil, storage = nil)
39
+ @image_data = image_data
40
+ @out_path = out_path
41
+ @storage = storage
42
+ end
43
+
44
+ def to_http_info(config)
45
+ # verify the required parameter 'image_data' is set
46
+ if config.client_side_validation && @image_data.nil?
47
+ raise ArgumentError, "Missing the required parameter 'image_data' when calling ImagingApi.create_grayscaled_image"
48
+ end
49
+
50
+ # resource path
51
+ local_var_path = '/imaging/grayscale'
52
+
53
+ # query parameters
54
+ query_params = {}
55
+ query_params[:outPath] = @out_path unless @out_path.nil?
56
+ query_params[:storage] = @storage unless @storage.nil?
57
+
58
+ # form parameters
59
+ form_params = {}
60
+ form_params['imageData'] = @image_data
61
+
62
+ # http body (model)
63
+ post_body = nil
64
+ auth_names = ['JWT']
65
+
66
+ # header parameters
67
+ header_params = {}
68
+ # HTTP header 'Accept' (if needed)
69
+ header_params['Accept'] = select_header_accept(['application/json'])
70
+ # HTTP header 'Content-Type'
71
+ header_params['Content-Type'] = form_params.any? ? 'multipart/form-data' : select_header_content_type(['multipart/form-data'])
72
+
73
+ AsposeImagingCloud::HttpRequest.new(local_var_path,
74
+ header_params,
75
+ query_params,
76
+ form_params,
77
+ post_body,
78
+ auth_names)
79
+ end
80
+ end
81
+ end
data/lib/aspose-imaging-cloud/models/requests/deskew_image_request.rb CHANGED
@@ -32,7 +32,7 @@ module AsposeImagingCloud
32
32
  class DeskewImageRequest < ImagingRequest
33
33
 
34
34
  # Deskew an existing image.
35
- # @param [String] name Filename of an image.
35
+ # @param [String] name Image file name.
36
36
  # @param [BOOLEAN] resize_proportionally Resize proportionally
37
37
  # @param [String] bk_color Background color
38
38
  # @param [String] folder Folder
data/lib/aspose-imaging-cloud/models/requests/grayscale_image_request.rb ADDED
@@ -0,0 +1,80 @@
1
+ # ----------------------------------------------------------------------------
2
+ # <copyright company="Aspose" file="grayscale_image_request.rb">
3
+ # Copyright (c) 2018-2019 Aspose Pty Ltd. All rights reserved.
4
+ # </copyright>
5
+ # <summary>
6
+ # Permission is hereby granted, free of charge, to any person obtaining a
7
+ # copy of this software and associated documentation files (the "Software"),
8
+ # to deal in the Software without restriction, including without limitation
9
+ # the rights to use, copy, modify, merge, publish, distribute, sublicense,
10
+ # and/or sell copies of the Software, and to permit persons to whom the
11
+ # Software is furnished to do so, subject to the following conditions:
12
+ #
13
+ # The above copyright notice and this permission notice shall be included in
14
+ # all copies or substantial portions of the Software.
15
+ #
16
+ # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
+ # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
+ # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
+ # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
+ # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21
+ # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22
+ # DEALINGS IN THE SOFTWARE.
23
+ # </summary>
24
+ # ----------------------------------------------------------------------------
25
+
26
+
27
+ require_relative './imaging_request'
28
+ require_relative './http_request'
29
+
30
+ module AsposeImagingCloud
31
+ # Request model for grayscale_image operation.
32
+ class GrayscaleImageRequest < ImagingRequest
33
+
34
+ # Grayscale an existing image.
35
+ # @param [String] name Image file name.
36
+ # @param [String] folder Folder
37
+ # @param [String] storage Storage
38
+ def initialize(name, folder = nil, storage = nil)
39
+ @name = name
40
+ @folder = folder
41
+ @storage = storage
42
+ end
43
+
44
+ def to_http_info(config)
45
+ # verify the required parameter 'name' is set
46
+ if config.client_side_validation && @name.nil?
47
+ raise ArgumentError, "Missing the required parameter 'name' when calling ImagingApi.grayscale_image"
48
+ end
49
+
50
+ # resource path
51
+ local_var_path = '/imaging/{name}/grayscale'.sub('{' + 'name' + '}', @name.to_s)
52
+
53
+ # query parameters
54
+ query_params = {}
55
+ query_params[:folder] = @folder unless @folder.nil?
56
+ query_params[:storage] = @storage unless @storage.nil?
57
+
58
+ # form parameters
59
+ form_params = {}
60
+
61
+ # http body (model)
62
+ post_body = nil
63
+ auth_names = ['JWT']
64
+
65
+ # header parameters
66
+ header_params = {}
67
+ # HTTP header 'Accept' (if needed)
68
+ header_params['Accept'] = select_header_accept(['application/json'])
69
+ # HTTP header 'Content-Type'
70
+ header_params['Content-Type'] = form_params.any? ? 'multipart/form-data' : select_header_content_type(['application/json'])
71
+
72
+ AsposeImagingCloud::HttpRequest.new(local_var_path,
73
+ header_params,
74
+ query_params,
75
+ form_params,
76
+ post_body,
77
+ auth_names)
78
+ end
79
+ end
80
+ end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aspose_imaging_cloud
3
3
  version: !ruby/object:Gem::Version
4
- version: 20.1.1
4
+ version: '20.2'
5
5
  platform: ruby
6
6
  authors:
7
7
  - Sergei Zubov
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-02-07 00:00:00.000000000 Z
11
+ date: 2020-02-27 00:00:00.000000000 Z
12
12
  dependencies: []
13
13
  description: |2
14
14
 
@@ -78,6 +78,7 @@ files:
78
78
  - lib/aspose-imaging-cloud/models/requests/create_cropped_image_request.rb
79
79
  - lib/aspose-imaging-cloud/models/requests/create_deskewed_image_request.rb
80
80
  - lib/aspose-imaging-cloud/models/requests/create_folder_request.rb
81
+ - lib/aspose-imaging-cloud/models/requests/create_grayscaled_image_request.rb
81
82
  - lib/aspose-imaging-cloud/models/requests/create_image_features_request.rb
82
83
  - lib/aspose-imaging-cloud/models/requests/create_image_frame_request.rb
83
84
  - lib/aspose-imaging-cloud/models/requests/create_image_search_request.rb
@@ -121,6 +122,7 @@ files:
121
122
  - lib/aspose-imaging-cloud/models/requests/get_image_properties_request.rb
122
123
  - lib/aspose-imaging-cloud/models/requests/get_image_search_status_request.rb
123
124
  - lib/aspose-imaging-cloud/models/requests/get_search_image_request.rb
125
+ - lib/aspose-imaging-cloud/models/requests/grayscale_image_request.rb
124
126
  - lib/aspose-imaging-cloud/models/requests/http_request.rb
125
127
  - lib/aspose-imaging-cloud/models/requests/imaging_request.rb
126
128
  - lib/aspose-imaging-cloud/models/requests/modify_bmp_request.rb