aspose_imaging_cloud 1.0.0 → 19.12

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

@@ -0,0 +1,88 @@
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="get_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 get_search_image operation.
+  class GetSearchImageRequest < ImagingRequest
+
+    # Get image 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.get_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.get_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/http_request.rb

@@ -0,0 +1,50 @@
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="http_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>
+#  ----------------------------------------------------------------------------
+
+
+module AsposeImagingCloud
+
+  # Http request data.
+  class HttpRequest
+
+    # Initializes a new instance.
+    # @param [String] resource_path Path to method endpoint.
+    # @param [Hash] header_params Header parameters to be placed in the request header.
+    # @param [Hash] query_params Query parameters in the url.
+    # @param [Hash] form_params Request post form parameters, for `application/x-www-form-urlencoded`, `multipart/form-data`.
+    # @param [Object] body Request body.
+    # @param [Array] auth_names Auth Settings names for the request.
+    def initialize(resource_path, header_params, query_params, form_params, body, auth_names)
+      @resource_path = resource_path
+      @query_params = query_params
+      @header_params = header_params
+      @form_params = form_params
+      @body = body
+      @auth_names = auth_names
+    end
+
+    attr_reader :resource_path, :header_params, :query_params, :form_params, :body, :auth_names
+  end
+end

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

@@ -0,0 +1,101 @@
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="imaging_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>
+#  ----------------------------------------------------------------------------
+
+
+module AsposeImagingCloud
+
+  # Base class for requests with basic operations
+  class ImagingRequest
+    def to_http_info(config); end
+
+    protected
+
+    # Return Accept header based on an array of accepts provided.
+    # @param [Array] accepts array for Accept
+    # @return [String] the Accept header (e.g. application/json)
+    def select_header_accept(accepts)
+      return nil if accepts.nil? || accepts.empty?
+
+      # use JSON when present, otherwise use all of the provided
+      json_accept = accepts.find { |s| json_mime?(s) }
+      json_accept || accepts.join(',')
+    end
+
+    # Return Content-Type header based on an array of content types provided.
+    # @param [Array] content_types array for Content-Type
+    # @return [String] the Content-Type header  (e.g. application/json)
+    def select_header_content_type(content_types)
+      # use application/json by default
+      return 'application/json' if content_types.nil? || content_types.empty?
+
+      # use JSON when present, otherwise use the first one
+      json_content_type = content_types.find { |s| json_mime?(s) }
+      json_content_type || content_types.first
+    end
+
+    private
+
+    # Check if the given MIME is a JSON MIME.
+    # JSON MIME examples:
+    #   application/json
+    #   application/json; charset=UTF8
+    #   APPLICATION/JSON
+    #   */*
+    # @param [String] mime MIME
+    # @return [Boolean] True if the MIME is application/json
+    def json_mime?(mime)
+      (mime == '*/*') || !(mime =~ %r{Application/.*json(?!p)(;.*)?}i).nil?
+    end
+
+    # Convert object (array, hash, object, etc) to JSON string.
+    # @param [Object] model object to be converted into JSON string
+    # @return [String] JSON string representation of the object
+    def object_to_http_body(model)
+      return model if model.nil? || model.is_a?(String)
+
+      local_body = nil
+      local_body = if model.is_a?(Array)
+                     model.map { |m| object_to_hash(m) }
+                   else
+                     object_to_hash(model)
+                   end
+      local_body.to_json
+    end
+
+    # Convert object(non-array) to hash.
+    # @param [Object] obj object to be converted into JSON string
+    # @return [String] JSON string representation of the object
+    def object_to_hash(obj)
+      if obj.respond_to?(:to_hash)
+        obj.to_hash
+      else
+        obj
+      end
+    end
+  end
+end
+
+
+

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

@@ -0,0 +1,107 @@
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="modify_bmp_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 modify_bmp operation.
+  class ModifyBmpRequest < ImagingRequest
+
+    # Update parameters of existing BMP image.
+    # @param [String] name Filename of image.
+    # @param [Integer] bits_per_pixel Color depth.
+    # @param [Integer] horizontal_resolution New horizontal resolution.
+    # @param [Integer] vertical_resolution New vertical resolution.
+    # @param [BOOLEAN] from_scratch Specifies where additional parameters we do not support should be taken from. If this is true – they will be taken from default values for standard image, if it is false – they will be saved from current image. Default is false.
+    # @param [String] folder Folder with image to process.
+    # @param [String] storage Your Aspose Cloud Storage name.
+    def initialize(name, bits_per_pixel, horizontal_resolution, vertical_resolution, from_scratch = nil, folder = nil, storage = nil)
+      @name = name
+      @bits_per_pixel = bits_per_pixel
+      @horizontal_resolution = horizontal_resolution
+      @vertical_resolution = vertical_resolution
+      @from_scratch = from_scratch
+      @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.modify_bmp"
+      end
+
+      # verify the required parameter 'bits_per_pixel' is set
+      if config.client_side_validation && @bits_per_pixel.nil?
+        raise ArgumentError, "Missing the required parameter 'bits_per_pixel' when calling ImagingApi.modify_bmp"
+      end
+
+      # verify the required parameter 'horizontal_resolution' is set
+      if config.client_side_validation && @horizontal_resolution.nil?
+        raise ArgumentError, "Missing the required parameter 'horizontal_resolution' when calling ImagingApi.modify_bmp"
+      end
+
+      # verify the required parameter 'vertical_resolution' is set
+      if config.client_side_validation && @vertical_resolution.nil?
+        raise ArgumentError, "Missing the required parameter 'vertical_resolution' when calling ImagingApi.modify_bmp"
+      end
+
+      # resource path
+      local_var_path = '/imaging/{name}/bmp'.sub('{' + 'name' + '}', @name.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:bitsPerPixel] = @bits_per_pixel
+      query_params[:horizontalResolution] = @horizontal_resolution
+      query_params[:verticalResolution] = @vertical_resolution
+      query_params[:fromScratch] = @from_scratch unless @from_scratch.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/modify_emf_request.rb

@@ -0,0 +1,126 @@
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="modify_emf_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 modify_emf operation.
+  class ModifyEmfRequest < ImagingRequest
+
+    # Process existing EMF imaging using given parameters.
+    # @param [String] name Filename of image.
+    # @param [String] bk_color Color of the background.
+    # @param [Integer] page_width Width of the page.
+    # @param [Integer] page_height Height of the page.
+    # @param [Integer] border_x Border width.
+    # @param [Integer] border_y Border height.
+    # @param [BOOLEAN] from_scratch Specifies where additional parameters we do not support should be taken from. If this is true – they will be taken from default values for standard image, if it is false – they will be saved from current image. Default is false.
+    # @param [String] folder Folder with image to process.
+    # @param [String] storage Your Aspose Cloud Storage name.
+    # @param [String] format Export format (PNG is the default one). Please, refer to the export table from https://docs.aspose.cloud/display/imagingcloud/Supported+File+Formats#SupportedFileFormats-CommonOperationsFormatSupportMap for possible use-cases.
+    def initialize(name, bk_color, page_width, page_height, border_x, border_y, from_scratch = nil, folder = nil, storage = nil, format = nil)
+      @name = name
+      @bk_color = bk_color
+      @page_width = page_width
+      @page_height = page_height
+      @border_x = border_x
+      @border_y = border_y
+      @from_scratch = from_scratch
+      @folder = folder
+      @storage = storage
+      @format = format
+    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.modify_emf"
+      end
+
+      # verify the required parameter 'bk_color' is set
+      if config.client_side_validation && @bk_color.nil?
+        raise ArgumentError, "Missing the required parameter 'bk_color' when calling ImagingApi.modify_emf"
+      end
+
+      # verify the required parameter 'page_width' is set
+      if config.client_side_validation && @page_width.nil?
+        raise ArgumentError, "Missing the required parameter 'page_width' when calling ImagingApi.modify_emf"
+      end
+
+      # verify the required parameter 'page_height' is set
+      if config.client_side_validation && @page_height.nil?
+        raise ArgumentError, "Missing the required parameter 'page_height' when calling ImagingApi.modify_emf"
+      end
+
+      # verify the required parameter 'border_x' is set
+      if config.client_side_validation && @border_x.nil?
+        raise ArgumentError, "Missing the required parameter 'border_x' when calling ImagingApi.modify_emf"
+      end
+
+      # verify the required parameter 'border_y' is set
+      if config.client_side_validation && @border_y.nil?
+        raise ArgumentError, "Missing the required parameter 'border_y' when calling ImagingApi.modify_emf"
+      end
+
+      # resource path
+      local_var_path = '/imaging/{name}/emf'.sub('{' + 'name' + '}', @name.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:bkColor] = @bk_color
+      query_params[:pageWidth] = @page_width
+      query_params[:pageHeight] = @page_height
+      query_params[:borderX] = @border_x
+      query_params[:borderY] = @border_y
+      query_params[:fromScratch] = @from_scratch unless @from_scratch.nil?
+      query_params[:folder] = @folder unless @folder.nil?
+      query_params[:storage] = @storage unless @storage.nil?
+      query_params[:format] = @format unless @format.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