aspose_imaging_cloud 1.0.0 → 19.12

data/lib/aspose-imaging-cloud/models/requests/delete_search_image_request.rb

@@ -0,0 +1,88 @@
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="delete_search_image_request.rb">
+#    Copyright (c) 2018-2019 Aspose Pty Ltd. All rights reserved.
+#  </copyright>
+#  <summary>
+#    Permission is hereby granted, free of charge, to any person obtaining a
+#   copy  of this software and associated documentation files (the "Software"),
+#   to deal  in the Software without restriction, including without limitation
+#   the rights  to use, copy, modify, merge, publish, distribute, sublicense,
+#   and/or sell  copies of the Software, and to permit persons to whom the
+#   Software is  furnished to do so, subject to the following conditions:
+#
+#   The above copyright notice and this permission notice shall be included in
+#   all  copies or substantial portions of the Software.
+#
+#   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+#   FROM,  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+#   DEALINGS IN THE SOFTWARE.
+#  </summary>
+#  ----------------------------------------------------------------------------
+
+
+require_relative './imaging_request'
+require_relative './http_request'
+
+module AsposeImagingCloud
+  # Request model for delete_search_image operation.
+  class DeleteSearchImageRequest < ImagingRequest
+
+    # Delete image and images features from search context
+    # @param [String] search_context_id Search context identifier.
+    # @param [String] image_id Image identifier.
+    # @param [String] folder Folder.
+    # @param [String] storage Storage
+    def initialize(search_context_id, image_id, folder = nil, storage = nil)
+      @search_context_id = search_context_id
+      @image_id = image_id
+      @folder = folder
+      @storage = storage
+    end
+
+    def to_http_info(config)
+      # verify the required parameter 'search_context_id' is set
+      if config.client_side_validation && @search_context_id.nil?
+        raise ArgumentError, "Missing the required parameter 'search_context_id' when calling ImagingApi.delete_search_image"
+      end
+
+      # verify the required parameter 'image_id' is set
+      if config.client_side_validation && @image_id.nil?
+        raise ArgumentError, "Missing the required parameter 'image_id' when calling ImagingApi.delete_search_image"
+      end
+
+      # resource path
+      local_var_path = '/imaging/ai/imageSearch/{searchContextId}/image'.sub('{' + 'searchContextId' + '}', @search_context_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:imageId] = @image_id
+      query_params[:folder] = @folder unless @folder.nil?
+      query_params[:storage] = @storage unless @storage.nil?
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['JWT']
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = form_params.any? ? 'multipart/form-data' : select_header_content_type(['application/json'])
+
+      AsposeImagingCloud::HttpRequest.new(local_var_path,
+                                      header_params,
+                                      query_params,
+                                      form_params,
+                                      post_body,
+                                      auth_names)
+    end
+  end
+end

data/lib/aspose-imaging-cloud/models/requests/download_file_request.rb

@@ -0,0 +1,80 @@
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="download_file_request.rb">
+#    Copyright (c) 2018-2019 Aspose Pty Ltd. All rights reserved.
+#  </copyright>
+#  <summary>
+#    Permission is hereby granted, free of charge, to any person obtaining a
+#   copy  of this software and associated documentation files (the "Software"),
+#   to deal  in the Software without restriction, including without limitation
+#   the rights  to use, copy, modify, merge, publish, distribute, sublicense,
+#   and/or sell  copies of the Software, and to permit persons to whom the
+#   Software is  furnished to do so, subject to the following conditions:
+#
+#   The above copyright notice and this permission notice shall be included in
+#   all  copies or substantial portions of the Software.
+#
+#   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+#   FROM,  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+#   DEALINGS IN THE SOFTWARE.
+#  </summary>
+#  ----------------------------------------------------------------------------
+
+
+require_relative './imaging_request'
+require_relative './http_request'
+
+module AsposeImagingCloud
+  # Request model for download_file operation.
+  class DownloadFileRequest < ImagingRequest
+
+    # Download file
+    # @param [String] path File path e.g. &#39;/folder/file.ext&#39;
+    # @param [String] storage_name Storage name
+    # @param [String] version_id File version ID to download
+    def initialize(path, storage_name = nil, version_id = nil)
+      @path = path
+      @storage_name = storage_name
+      @version_id = version_id
+    end
+
+    def to_http_info(config)
+      # verify the required parameter 'path' is set
+      if config.client_side_validation && @path.nil?
+        raise ArgumentError, "Missing the required parameter 'path' when calling ImagingApi.download_file"
+      end
+
+      # resource path
+      local_var_path = '/imaging/storage/file/{path}'.sub('{' + 'path' + '}', @path.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:storageName] = @storage_name unless @storage_name.nil?
+      query_params[:versionId] = @version_id unless @version_id.nil?
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['JWT']
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = select_header_accept(['multipart/form-data'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = form_params.any? ? 'multipart/form-data' : select_header_content_type(['application/json'])
+
+      AsposeImagingCloud::HttpRequest.new(local_var_path,
+                                      header_params,
+                                      query_params,
+                                      form_params,
+                                      post_body,
+                                      auth_names)
+    end
+  end
+end

data/lib/aspose-imaging-cloud/models/requests/extract_image_features_request.rb

@@ -0,0 +1,91 @@
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="extract_image_features_request.rb">
+#    Copyright (c) 2018-2019 Aspose Pty Ltd. All rights reserved.
+#  </copyright>
+#  <summary>
+#    Permission is hereby granted, free of charge, to any person obtaining a
+#   copy  of this software and associated documentation files (the "Software"),
+#   to deal  in the Software without restriction, including without limitation
+#   the rights  to use, copy, modify, merge, publish, distribute, sublicense,
+#   and/or sell  copies of the Software, and to permit persons to whom the
+#   Software is  furnished to do so, subject to the following conditions:
+#
+#   The above copyright notice and this permission notice shall be included in
+#   all  copies or substantial portions of the Software.
+#
+#   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+#   FROM,  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+#   DEALINGS IN THE SOFTWARE.
+#  </summary>
+#  ----------------------------------------------------------------------------
+
+
+require_relative './imaging_request'
+require_relative './http_request'
+
+module AsposeImagingCloud
+  # Request model for extract_image_features operation.
+  class ExtractImageFeaturesRequest < ImagingRequest
+
+    # 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.
+    # @param [String] search_context_id The search context identifier.
+    # @param [String] image_id The image identifier.
+    # @param [File] image_data Input image
+    # @param [String] folder The folder.
+    # @param [String] storage The storage.
+    def initialize(search_context_id, image_id, image_data = nil, folder = nil, storage = nil)
+      @search_context_id = search_context_id
+      @image_id = image_id
+      @image_data = image_data
+      @folder = folder
+      @storage = storage
+    end
+
+    def to_http_info(config)
+      # verify the required parameter 'search_context_id' is set
+      if config.client_side_validation && @search_context_id.nil?
+        raise ArgumentError, "Missing the required parameter 'search_context_id' when calling ImagingApi.extract_image_features"
+      end
+
+      # verify the required parameter 'image_id' is set
+      if config.client_side_validation && @image_id.nil?
+        raise ArgumentError, "Missing the required parameter 'image_id' when calling ImagingApi.extract_image_features"
+      end
+
+      # resource path
+      local_var_path = '/imaging/ai/imageSearch/{searchContextId}/image2features'.sub('{' + 'searchContextId' + '}', @search_context_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:imageId] = @image_id
+      query_params[:folder] = @folder unless @folder.nil?
+      query_params[:storage] = @storage unless @storage.nil?
+
+      # form parameters
+      form_params = {}
+      form_params['imageData'] = @image_data unless @image_data.nil?
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['JWT']
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = form_params.any? ? 'multipart/form-data' : select_header_content_type(['multipart/form-data'])
+
+      AsposeImagingCloud::HttpRequest.new(local_var_path,
+                                      header_params,
+                                      query_params,
+                                      form_params,
+                                      post_body,
+                                      auth_names)
+    end
+  end
+end

data/lib/aspose-imaging-cloud/models/requests/extract_image_frame_properties_request.rb

@@ -0,0 +1,82 @@
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="extract_image_frame_properties_request.rb">
+#    Copyright (c) 2018-2019 Aspose Pty Ltd. All rights reserved.
+#  </copyright>
+#  <summary>
+#    Permission is hereby granted, free of charge, to any person obtaining a
+#   copy  of this software and associated documentation files (the "Software"),
+#   to deal  in the Software without restriction, including without limitation
+#   the rights  to use, copy, modify, merge, publish, distribute, sublicense,
+#   and/or sell  copies of the Software, and to permit persons to whom the
+#   Software is  furnished to do so, subject to the following conditions:
+#
+#   The above copyright notice and this permission notice shall be included in
+#   all  copies or substantial portions of the Software.
+#
+#   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+#   FROM,  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+#   DEALINGS IN THE SOFTWARE.
+#  </summary>
+#  ----------------------------------------------------------------------------
+
+
+require_relative './imaging_request'
+require_relative './http_request'
+
+module AsposeImagingCloud
+  # Request model for extract_image_frame_properties operation.
+  class ExtractImageFramePropertiesRequest < ImagingRequest
+
+    # Get separate frame properties of existing TIFF image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
+    # @param [File] image_data Input image
+    # @param [Integer] frame_id Number of a frame.
+    def initialize(image_data, frame_id)
+      @image_data = image_data
+      @frame_id = frame_id
+    end
+
+    def to_http_info(config)
+      # verify the required parameter 'image_data' is set
+      if config.client_side_validation && @image_data.nil?
+        raise ArgumentError, "Missing the required parameter 'image_data' when calling ImagingApi.extract_image_frame_properties"
+      end
+
+      # verify the required parameter 'frame_id' is set
+      if config.client_side_validation && @frame_id.nil?
+        raise ArgumentError, "Missing the required parameter 'frame_id' when calling ImagingApi.extract_image_frame_properties"
+      end
+
+      # resource path
+      local_var_path = '/imaging/frames/{frameId}/properties'.sub('{' + 'frameId' + '}', @frame_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # form parameters
+      form_params = {}
+      form_params['imageData'] = @image_data
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['JWT']
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = form_params.any? ? 'multipart/form-data' : select_header_content_type(['multipart/form-data'])
+
+      AsposeImagingCloud::HttpRequest.new(local_var_path,
+                                      header_params,
+                                      query_params,
+                                      form_params,
+                                      post_body,
+                                      auth_names)
+    end
+  end
+end

data/lib/aspose-imaging-cloud/models/requests/extract_image_properties_request.rb

@@ -0,0 +1,75 @@
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="extract_image_properties_request.rb">
+#    Copyright (c) 2018-2019 Aspose Pty Ltd. All rights reserved.
+#  </copyright>
+#  <summary>
+#    Permission is hereby granted, free of charge, to any person obtaining a
+#   copy  of this software and associated documentation files (the "Software"),
+#   to deal  in the Software without restriction, including without limitation
+#   the rights  to use, copy, modify, merge, publish, distribute, sublicense,
+#   and/or sell  copies of the Software, and to permit persons to whom the
+#   Software is  furnished to do so, subject to the following conditions:
+#
+#   The above copyright notice and this permission notice shall be included in
+#   all  copies or substantial portions of the Software.
+#
+#   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+#   FROM,  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+#   DEALINGS IN THE SOFTWARE.
+#  </summary>
+#  ----------------------------------------------------------------------------
+
+
+require_relative './imaging_request'
+require_relative './http_request'
+
+module AsposeImagingCloud
+  # Request model for extract_image_properties operation.
+  class ExtractImagePropertiesRequest < ImagingRequest
+
+    # Get properties of an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
+    # @param [File] image_data Input image
+    def initialize(image_data)
+      @image_data = image_data
+    end
+
+    def to_http_info(config)
+      # verify the required parameter 'image_data' is set
+      if config.client_side_validation && @image_data.nil?
+        raise ArgumentError, "Missing the required parameter 'image_data' when calling ImagingApi.extract_image_properties"
+      end
+
+      # resource path
+      local_var_path = '/imaging/properties'
+
+      # query parameters
+      query_params = {}
+
+      # form parameters
+      form_params = {}
+      form_params['imageData'] = @image_data
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['JWT']
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = form_params.any? ? 'multipart/form-data' : select_header_content_type(['multipart/form-data'])
+
+      AsposeImagingCloud::HttpRequest.new(local_var_path,
+                                      header_params,
+                                      query_params,
+                                      form_params,
+                                      post_body,
+                                      auth_names)
+    end
+  end
+end

data/lib/aspose-imaging-cloud/models/requests/filter_effect_image_request.rb

@@ -0,0 +1,103 @@
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="filter_effect_image_request.rb">
+#    Copyright (c) 2018-2019 Aspose Pty Ltd. All rights reserved.
+#  </copyright>
+#  <summary>
+#    Permission is hereby granted, free of charge, to any person obtaining a
+#   copy  of this software and associated documentation files (the "Software"),
+#   to deal  in the Software without restriction, including without limitation
+#   the rights  to use, copy, modify, merge, publish, distribute, sublicense,
+#   and/or sell  copies of the Software, and to permit persons to whom the
+#   Software is  furnished to do so, subject to the following conditions:
+#
+#   The above copyright notice and this permission notice shall be included in
+#   all  copies or substantial portions of the Software.
+#
+#   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+#   FROM,  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+#   DEALINGS IN THE SOFTWARE.
+#  </summary>
+#  ----------------------------------------------------------------------------
+
+
+require_relative './imaging_request'
+require_relative './http_request'
+
+module AsposeImagingCloud
+  # Request model for filter_effect_image operation.
+  class FilterEffectImageRequest < ImagingRequest
+
+    # Apply filtering effects to an existing image.
+    # @param [String] name Filename of an image.
+    # @param [String] format Resulting image format. Please, refer to https://docs.aspose.cloud/display/imagingcloud/Supported+File+Formats#SupportedFileFormats-CommonOperationsFormatSupportMap for possible use-cases.
+    # @param [String] filter_type Filter type (BigRectangular, SmallRectangular, Median, GaussWiener, MotionWiener, GaussianBlur, Sharpen, BilateralSmoothing).
+    # @param [FilterPropertiesBase] filter_properties Filter properties.
+    # @param [String] folder Folder with image to process.
+    # @param [String] storage Your Aspose Cloud Storage name.
+    def initialize(name, format, filter_type, filter_properties, folder = nil, storage = nil)
+      @name = name
+      @format = format
+      @filter_type = filter_type
+      @filter_properties = filter_properties
+      @folder = folder
+      @storage = storage
+    end
+
+    def to_http_info(config)
+      # verify the required parameter 'name' is set
+      if config.client_side_validation && @name.nil?
+        raise ArgumentError, "Missing the required parameter 'name' when calling ImagingApi.filter_effect_image"
+      end
+
+      # verify the required parameter 'format' is set
+      if config.client_side_validation && @format.nil?
+        raise ArgumentError, "Missing the required parameter 'format' when calling ImagingApi.filter_effect_image"
+      end
+
+      # verify the required parameter 'filter_type' is set
+      if config.client_side_validation && @filter_type.nil?
+        raise ArgumentError, "Missing the required parameter 'filter_type' when calling ImagingApi.filter_effect_image"
+      end
+
+      # verify the required parameter 'filter_properties' is set
+      if config.client_side_validation && @filter_properties.nil?
+        raise ArgumentError, "Missing the required parameter 'filter_properties' when calling ImagingApi.filter_effect_image"
+      end
+
+      # resource path
+      local_var_path = '/imaging/{name}/filterEffect'.sub('{' + 'name' + '}', @name.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:format] = @format
+      query_params[:filterType] = @filter_type
+      query_params[:folder] = @folder unless @folder.nil?
+      query_params[:storage] = @storage unless @storage.nil?
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = object_to_http_body(@filter_properties)
+      auth_names = ['JWT']
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = form_params.any? ? 'multipart/form-data' : select_header_content_type(['application/json', 'application/xml'])
+
+      AsposeImagingCloud::HttpRequest.new(local_var_path,
+                                      header_params,
+                                      query_params,
+                                      form_params,
+                                      post_body,
+                                      auth_names)
+    end
+  end
+end