aspose_email_cloud 20.5.0 → 21.4.0

data/lib/aspose-email-cloud/api_invoker.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="api_invoker.rb">
+#    Copyright (c) 2018-2020 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 AsposeEmailCloud
+  # API client invoker. Processes all requests and obtains actual token if necessary.
+  class ApiInvoker
+    attr_reader :api_client
+
+    def initialize(api_client)
+      @api_client = api_client
+    end
+
+    def make_request(http_request, method, return_type)
+      call_api(http_request, method, return_type)
+    rescue ApiError => e
+      if e.code.equal? 401
+        request_token
+        return call_api(http_request, method, return_type)
+      end
+      raise
+    end
+
+    private
+
+    def call_api(http_request, method, return_type)
+      response = @api_client.call_api(method,
+                                      http_request.resource_path,
+                                      header_params: http_request.header_params,
+                                      query_params: http_request.query_params,
+                                      form_params: http_request.form_params,
+                                      body: http_request.body,
+                                      auth_names: http_request.auth_names,
+                                      return_type: return_type)
+      response[0]
+    end
+
+    def request_token
+      config = @api_client.config
+
+      header_params =
+        {
+          'Accept' => 'application/json',
+          'Content-Type' => 'application/x-www-form-urlencoded'
+        }
+
+      base_path = @api_client.config.base_path
+      @api_client.config.base_path = ''
+
+      data = @api_client.call_api(:POST, '/connect/token',
+                                  header_params: header_params,
+                                  form_params: request_token_form_params(config),
+                                  return_type: 'Object',
+                                  host: @api_client.config.auth_url)
+
+      @api_client.config.base_path = base_path
+      @api_client.config.access_token = data[0]['access_token'.to_sym]
+    end
+
+    def request_token_form_params(config)
+      {
+        'grant_type': 'client_credentials',
+        'client_id': config.client_credentials[:client_id],
+        'client_secret': config.client_credentials[:client_secret]
+      }
+    end
+  end
+end
+

data/lib/aspose-email-cloud/configuration.rb

@@ -51,9 +51,9 @@ module AsposeEmailCloud
     #
     # @return [Hash] key: parameter name, value: parameter value (API key)
     #
-    # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
-    #   config.api_key['api_key'] = 'xxx'
-    attr_accessor :api_key
+    # @example parameter name is "client_secret", API key is "xxx" (e.g. "client_secret=xxx" in query string)
+    #   config.client_secret['client_secret'] = 'xxx'
+    attr_accessor :client_credentials
 
     # Defines API key prefixes used with API Key authentications.
     #
@@ -152,19 +152,19 @@ module AsposeEmailCloud
     attr_accessor :force_ending_format
 
     # Initializes a new instance.
-    # @param [String] app_key Key to access the server.
-    # @param [String] app_sid ID to access the server.
+    # @param [String] client_secret Key to access the server.
+    # @param [String] client_id ID to access the server.
     # @param [String] base_url Server URL.
     # @param [String] api_version Api version.
     # @param [Object] debug Debug switch [true, false].
-    def initialize(app_key = nil, app_sid = nil, base_url = 'api-qa.aspose.cloud', api_version = 'v3.0', debug = false)
+    def initialize(client_secret = nil, client_id = nil, base_url = 'api-qa.aspose.cloud', api_version = 'v4.0', debug = false)
       @scheme = 'https'
       self.host = base_url
       self.auth_url = base_url
       @api_version = api_version
       self.base_path = @api_version
-      @api_key = { 'api_key': app_key || '',
-                   'app_sid': app_sid || '' }
+      @client_credentials = { 'client_secret': client_secret || '',
+                              'client_id': client_id || '' }
       @api_key_prefix = {}
       @timeout = 0
       @client_side_validation = true
@@ -177,7 +177,7 @@ module AsposeEmailCloud
       @inject_format = false
       @force_ending_format = false
       @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
-      @on_premise = (!(app_key || app_sid) && base_url)
+      @on_premise = (!(client_secret || client_id) && base_url)
 
       yield(self) if block_given?
     end
@@ -213,9 +213,9 @@ module AsposeEmailCloud
     # @param [String] param_name the parameter name of API key auth
     def api_key_with_prefix(param_name)
       if @api_key_prefix[param_name]
-        "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
+        "#{@api_key_prefix[param_name]} #{@client_credentials[param_name]}"
       else
-        @api_key[param_name]
+        @client_credentials[param_name]
       end
     end
 

data/lib/aspose-email-cloud/models/ai_bcr_image.rb

@@ -23,16 +23,14 @@
 #  </summary>
 #  ----------------------------------------------------------------------------
 
-
 require 'date'
 
 module AsposeEmailCloud
   # Image for recognition             
   class AiBcrImage
-    # Determines that image contains single VCard or more. Ignored in current version. Multiple cards on image support will be added soon             
+    # Determines that image contains single VCard or more.             
     # @return [BOOLEAN]
     attr_accessor :is_single
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -48,21 +46,9 @@ module AsposeEmailCloud
     end
 
     # Initializes the object
-    # @param [Hash] attributes Model attributes in the form of hash
-    def initialize(attributes = {})
-      return unless attributes.is_a?(Hash)
-
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
-
-      if attributes.has_key?(:'isSingle')
-        self.is_single = attributes[:'isSingle']
-      end
-    end
-
-    # Initializes the object
-    # @param [BOOLEAN] is_single Determines that image contains single VCard or more. Ignored in current version. Multiple cards on image support will be added soon             
-    def initialize(is_single=nil)
+    # @param [BOOLEAN] is_single Determines that image contains single VCard or more.             
+    def initialize(
+      is_single: nil)
       self.is_single = is_single if is_single
     end
 

data/lib/aspose-email-cloud/models/ai_bcr_image_storage_file.rb

@@ -23,20 +23,17 @@
 #  </summary>
 #  ----------------------------------------------------------------------------
 
-
 require 'date'
 
 module AsposeEmailCloud
   # Image from storage for recognition             
-  class AiBcrImageStorageFile
-    # Determines that image contains single VCard or more. Ignored in current version. Multiple cards on image support will be added soon             
+  class AiBcrImageStorageFile < AiBcrImage
+    # Determines that image contains single VCard or more.             
     # @return [BOOLEAN]
     attr_accessor :is_single
-
     # Image location             
-    # @return [Object]
+    # @return [StorageFileLocation]
     attr_accessor :file
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -49,31 +46,16 @@ module AsposeEmailCloud
     def self.swagger_types
       {
         :'is_single' => :'BOOLEAN',
-        :'file' => :'Object'
+        :'file' => :'StorageFileLocation'
       }
     end
 
     # Initializes the object
-    # @param [Hash] attributes Model attributes in the form of hash
-    def initialize(attributes = {})
-      return unless attributes.is_a?(Hash)
-
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
-
-      if attributes.has_key?(:'isSingle')
-        self.is_single = attributes[:'isSingle']
-      end
-
-      if attributes.has_key?(:'file')
-        self.file = attributes[:'file']
-      end
-    end
-
-    # Initializes the object
-    # @param [BOOLEAN] is_single Determines that image contains single VCard or more. Ignored in current version. Multiple cards on image support will be added soon             
-    # @param [Object] file Image location             
-    def initialize(is_single=nil, file=nil)
+    # @param [BOOLEAN] is_single Determines that image contains single VCard or more.             
+    # @param [StorageFileLocation] file Image location             
+    def initialize(
+      is_single: nil,
+      file: nil)
       self.is_single = is_single if is_single
       self.file = file if file
     end
@@ -86,6 +68,10 @@ module AsposeEmailCloud
         invalid_properties.push('invalid value for "is_single", is_single cannot be nil.')
       end
 
+      if @file.nil?
+        invalid_properties.push('invalid value for "file", file cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -93,6 +79,7 @@ module AsposeEmailCloud
     # @return true if the model is valid
     def valid?
       return false if @is_single.nil?
+      return false if @file.nil?
       true
     end
 

data/lib/aspose-email-cloud/models/ai_bcr_options.rb

@@ -23,20 +23,17 @@
 #  </summary>
 #  ----------------------------------------------------------------------------
 
-
 require 'date'
 
 module AsposeEmailCloud
-  # Recognition options             
+  # Recognition options.             
   class AiBcrOptions
-    # Comma-separated ISO-639 codes of languages (either 639-1 or 639-3; i.e. \"it\" or \"ita\" for Italian); it's \"\" by default             
+    # Comma-separated ISO-639 codes of languages (either 639-1 or 639-3; i.e. \"it\" or \"ita\" for Italian); it's \"\" by default.             
     # @return [String]
     attr_accessor :languages
-
-    # Comma-separated codes of countries             
+    # Comma-separated codes of countries.             
     # @return [String]
     attr_accessor :countries
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -54,26 +51,11 @@ module AsposeEmailCloud
     end
 
     # Initializes the object
-    # @param [Hash] attributes Model attributes in the form of hash
-    def initialize(attributes = {})
-      return unless attributes.is_a?(Hash)
-
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
-
-      if attributes.has_key?(:'languages')
-        self.languages = attributes[:'languages']
-      end
-
-      if attributes.has_key?(:'countries')
-        self.countries = attributes[:'countries']
-      end
-    end
-
-    # Initializes the object
-    # @param [String] languages Comma-separated ISO-639 codes of languages (either 639-1 or 639-3; i.e. \"it\" or \"ita\" for Italian); it's \"\" by default             
-    # @param [String] countries Comma-separated codes of countries             
-    def initialize(languages=nil, countries=nil)
+    # @param [String] languages Comma-separated ISO-639 codes of languages (either 639-1 or 639-3; i.e. \"it\" or \"ita\" for Italian); it's \"\" by default.             
+    # @param [String] countries Comma-separated codes of countries.             
+    def initialize(
+      languages: nil,
+      countries: nil)
       self.languages = languages if languages
       self.countries = countries if countries
     end

data/lib/aspose-email-cloud/models/ai_bcr_parse_request.rb

@@ -0,0 +1,95 @@
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="ai_bcr_parse_request.rb">
+#    Copyright (c) 2018-2020 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 './email_request'
+require_relative './http_request'
+
+module AsposeEmailCloud
+  # Request model for ai_bcr_parse operation.
+  class AiBcrParseRequest < EmailRequest
+    # File to parse
+    # @return [File]
+    attr_accessor :file
+    # Comma-separated codes of countries.
+    # @return [String]
+    attr_accessor :countries
+    # Comma-separated ISO-639 codes of languages (either 639-1 or 639-3; i.e. \&quot;it\&quot; or \&quot;ita\&quot; for Italian); it&#39;s \&quot;\&quot; by default.             
+    # @return [String]
+    attr_accessor :languages
+    # Determines that image contains single VCard or more.
+    # @return [BOOLEAN]
+    attr_accessor :is_single
+
+    # Parse images to vCard document models             
+    # @param [File] file File to parse
+    # @param [String] countries Comma-separated codes of countries.
+    # @param [String] languages Comma-separated ISO-639 codes of languages (either 639-1 or 639-3; i.e. \&quot;it\&quot; or \&quot;ita\&quot; for Italian); it&#39;s \&quot;\&quot; by default.             
+    # @param [BOOLEAN] is_single Determines that image contains single VCard or more.
+    def initialize(file:, countries: nil, languages: nil, is_single: nil)
+      self.file = file if file
+      self.countries = countries if countries
+      self.languages = languages if languages
+      self.is_single = is_single if is_single
+    end
+
+    def to_http_info(api_client)
+      # verify the required parameter 'file' is set
+      if api_client.config.client_side_validation && self.file.nil?
+        raise ArgumentError, "Missing the required parameter 'file' when calling AiBcrApi.parse"
+      end
+      # resource path
+      local_var_path = '/email/AiBcr/parse'
+
+      # query parameters
+      query_params = {}
+      query_params[:countries] = self.countries unless self.countries.nil?
+      query_params[:languages] = self.languages unless self.languages.nil?
+      query_params[:isSingle] = self.is_single unless self.is_single.nil?
+
+      # form parameters
+      form_params = {}
+      form_params['File'] = self.file
+
+      # http body (model)
+      auth_names = ['JWT']
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = EmailRequest.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = form_params.any? ? 'multipart/form-data' : EmailRequest.select_header_content_type(['multipart/form-data'])
+
+      AsposeEmailCloud::HttpRequest.new(resource_path: local_var_path,
+                                        header_params: header_params,
+                                        query_params: query_params,
+                                        form_params: form_params,
+                                        auth_names: auth_names)
+    end
+  end
+end
+
+
+

data/lib/aspose-email-cloud/models/{ai_bcr_storage_image_rq.rb → ai_bcr_parse_storage_request.rb}

@@ -1,5 +1,5 @@
 #  ----------------------------------------------------------------------------
-#  <copyright company="Aspose" file="AiBcrStorageImageRq.rb">
+#  <copyright company="Aspose" file="AiBcrParseStorageRequest.rb">
 #    Copyright (c) 2018-2020 Aspose Pty Ltd. All rights reserved.
 #  </copyright>
 #  <summary>
@@ -23,67 +23,59 @@
 #  </summary>
 #  ----------------------------------------------------------------------------
 
-
 require 'date'
 
 module AsposeEmailCloud
-  # Business card images from storage for recognition             
-  class AiBcrStorageImageRq
-    # Recognition options             
-    # @return [AiBcrOptions]
-    attr_accessor :options
-
-    # List of images with business cards             
+  # Parse business card images from Storage request             
+  class AiBcrParseStorageRequest
+    # Parse output folder location on storage             
+    # @return [StorageFolderLocation]
+    attr_accessor :out_folder
+    # Images to parse.             
     # @return [Array<AiBcrImageStorageFile>]
     attr_accessor :images
-
+    # Recognition options.             
+    # @return [AiBcrOptions]
+    attr_accessor :options
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'options' => :'options',
-        :'images' => :'images'
+        :'out_folder' => :'outFolder',
+        :'images' => :'images',
+        :'options' => :'options'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'options' => :'AiBcrOptions',
-        :'images' => :'Array<AiBcrImageStorageFile>'
+        :'out_folder' => :'StorageFolderLocation',
+        :'images' => :'Array<AiBcrImageStorageFile>',
+        :'options' => :'AiBcrOptions'
       }
     end
 
     # Initializes the object
-    # @param [Hash] attributes Model attributes in the form of hash
-    def initialize(attributes = {})
-      return unless attributes.is_a?(Hash)
-
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
-
-      if attributes.has_key?(:'options')
-        self.options = attributes[:'options']
-      end
-
-      if attributes.has_key?(:'images')
-        if (value = attributes[:'images']).is_a?(Array)
-          self.images = value
-        end
-      end
-    end
-
-    # Initializes the object
-    # @param [AiBcrOptions] options Recognition options             
-    # @param [Array<AiBcrImageStorageFile>] images List of images with business cards             
-    def initialize(options=nil, images=nil)
-      self.options = options if options
+    # @param [StorageFolderLocation] out_folder Parse output folder location on storage             
+    # @param [Array<AiBcrImageStorageFile>] images Images to parse.             
+    # @param [AiBcrOptions] options Recognition options.             
+    def initialize(
+      out_folder: nil,
+      images: nil,
+      options: nil)
+      self.out_folder = out_folder if out_folder
       self.images = images if images
+      self.options = options if options
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @out_folder.nil?
+        invalid_properties.push('invalid value for "out_folder", out_folder cannot be nil.')
+      end
+
       if @images.nil?
         invalid_properties.push('invalid value for "images", images cannot be nil.')
       end
@@ -94,6 +86,7 @@ module AsposeEmailCloud
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      return false if @out_folder.nil?
       return false if @images.nil?
       true
     end
@@ -103,8 +96,9 @@ module AsposeEmailCloud
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          options == o.options &&
-          images == o.images
+          out_folder == o.out_folder &&
+          images == o.images &&
+          options == o.options
     end
 
     # @see the `==` method
@@ -116,7 +110,7 @@ module AsposeEmailCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [options, images].hash
+      [out_folder, images, options].hash
     end
 
     # Builds the object from hash