aspose_imaging_cloud 1.0.0 → 19.12

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

@@ -0,0 +1,77 @@
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="create_folder_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 create_folder operation.
+  class CreateFolderRequest < ImagingRequest
+
+    # Create the folder
+    # @param [String] path Folder path to create e.g. &#39;folder_1/folder_2/&#39;
+    # @param [String] storage_name Storage name
+    def initialize(path, storage_name = nil)
+      @path = path
+      @storage_name = storage_name
+    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.create_folder"
+      end
+
+      # resource path
+      local_var_path = '/imaging/storage/folder/{path}'.sub('{' + 'path' + '}', @path.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:storageName] = @storage_name unless @storage_name.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/create_image_features_request.rb

@@ -0,0 +1,89 @@
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="create_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 create_image_features operation.
+  class CreateImageFeaturesRequest < ImagingRequest
+
+    # 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.
+    # @param [String] search_context_id The search context identifier.
+    # @param [File] image_data Input image
+    # @param [String] image_id The image identifier.
+    # @param [String] images_folder Images source - a folder
+    # @param [String] folder The folder.
+    # @param [String] storage The storage.
+    def initialize(search_context_id, image_data = nil, image_id = nil, images_folder = nil, folder = nil, storage = nil)
+      @search_context_id = search_context_id
+      @image_data = image_data
+      @image_id = image_id
+      @images_folder = images_folder
+      @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.create_image_features"
+      end
+
+      # resource path
+      local_var_path = '/imaging/ai/imageSearch/{searchContextId}/features'.sub('{' + 'searchContextId' + '}', @search_context_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:imageId] = @image_id unless @image_id.nil?
+      query_params[:imagesFolder] = @images_folder unless @images_folder.nil?
+      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/create_image_frame_request.rb

@@ -0,0 +1,112 @@
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="create_image_frame_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 create_image_frame operation.
+  class CreateImageFrameRequest < ImagingRequest
+
+    # Get separate frame from 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.
+    # @param [Integer] new_width New width.
+    # @param [Integer] new_height New height.
+    # @param [Integer] x X position of start point for cropping rectangle.
+    # @param [Integer] y Y position of start point for cropping rectangle.
+    # @param [Integer] rect_width Width of cropping rectangle.
+    # @param [Integer] rect_height Height of cropping rectangle.
+    # @param [String] rotate_flip_method RotateFlip method (Rotate180FlipNone, Rotate180FlipX, Rotate180FlipXY, Rotate180FlipY, Rotate270FlipNone, Rotate270FlipX, Rotate270FlipXY, Rotate270FlipY, Rotate90FlipNone, Rotate90FlipX, Rotate90FlipXY, Rotate90FlipY, RotateNoneFlipNone, RotateNoneFlipX, RotateNoneFlipXY, RotateNoneFlipY). Default is RotateNoneFlipNone.
+    # @param [BOOLEAN] save_other_frames If result will include all other frames or just a specified frame.
+    # @param [String] out_path Path to updated file (if this is empty, response contains streamed image).
+    # @param [String] storage Your Aspose Cloud Storage name.
+    def initialize(image_data, frame_id, new_width = nil, new_height = nil, x = nil, y = nil, rect_width = nil, rect_height = nil, rotate_flip_method = nil, save_other_frames = nil, out_path = nil, storage = nil)
+      @image_data = image_data
+      @frame_id = frame_id
+      @new_width = new_width
+      @new_height = new_height
+      @x = x
+      @y = y
+      @rect_width = rect_width
+      @rect_height = rect_height
+      @rotate_flip_method = rotate_flip_method
+      @save_other_frames = save_other_frames
+      @out_path = out_path
+      @storage = storage
+    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.create_image_frame"
+      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.create_image_frame"
+      end
+
+      # resource path
+      local_var_path = '/imaging/frames/{frameId}'.sub('{' + 'frameId' + '}', @frame_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:newWidth] = @new_width unless @new_width.nil?
+      query_params[:newHeight] = @new_height unless @new_height.nil?
+      query_params[:x] = @x unless @x.nil?
+      query_params[:y] = @y unless @y.nil?
+      query_params[:rectWidth] = @rect_width unless @rect_width.nil?
+      query_params[:rectHeight] = @rect_height unless @rect_height.nil?
+      query_params[:rotateFlipMethod] = @rotate_flip_method unless @rotate_flip_method.nil?
+      query_params[:saveOtherFrames] = @save_other_frames unless @save_other_frames.nil?
+      query_params[:outPath] = @out_path unless @out_path.nil?
+      query_params[:storage] = @storage unless @storage.nil?
+
+      # 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/create_image_search_request.rb

@@ -0,0 +1,79 @@
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="create_image_search_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 create_image_search operation.
+  class CreateImageSearchRequest < ImagingRequest
+
+    # Create new search context.
+    # @param [String] detector The image features detector.
+    # @param [String] matching_algorithm The matching algorithm.
+    # @param [String] folder The folder.
+    # @param [String] storage The storage.
+    def initialize(detector = nil, matching_algorithm = nil, folder = nil, storage = nil)
+      @detector = detector
+      @matching_algorithm = matching_algorithm
+      @folder = folder
+      @storage = storage
+    end
+
+    def to_http_info(config)
+      # resource path
+      local_var_path = '/imaging/ai/imageSearch/create'
+
+      # query parameters
+      query_params = {}
+      query_params[:detector] = @detector unless @detector.nil?
+      query_params[:matchingAlgorithm] = @matching_algorithm unless @matching_algorithm.nil?
+      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/create_image_tag_request.rb

@@ -0,0 +1,96 @@
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="create_image_tag_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 create_image_tag operation.
+  class CreateImageTagRequest < ImagingRequest
+
+    # Add tag and reference image to search context. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.
+    # @param [File] image_data Input image
+    # @param [String] search_context_id The search context identifier.
+    # @param [String] tag_name The tag.
+    # @param [String] folder The folder.
+    # @param [String] storage The storage.
+    def initialize(image_data, search_context_id, tag_name, folder = nil, storage = nil)
+      @image_data = image_data
+      @search_context_id = search_context_id
+      @tag_name = tag_name
+      @folder = folder
+      @storage = storage
+    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.create_image_tag"
+      end
+
+      # 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.create_image_tag"
+      end
+
+      # verify the required parameter 'tag_name' is set
+      if config.client_side_validation && @tag_name.nil?
+        raise ArgumentError, "Missing the required parameter 'tag_name' when calling ImagingApi.create_image_tag"
+      end
+
+      # resource path
+      local_var_path = '/imaging/ai/imageSearch/{searchContextId}/addTag'.sub('{' + 'searchContextId' + '}', @search_context_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:tagName] = @tag_name
+      query_params[:folder] = @folder unless @folder.nil?
+      query_params[:storage] = @storage unless @storage.nil?
+
+      # 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