aspose_email_cloud 19.11.0 → 20.5.0

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

@@ -1,64 +1,78 @@
-#  ----------------------------------------------------------------------------
-#  <copyright company="Aspose" file="SaveOAuthEmailAccountRequest.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 'date'
-
-module AsposeEmailCloud
-  # Save email account settings with OAuth request
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="SaveOAuthEmailAccountRequest.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 'date'
+
+module AsposeEmailCloud
+  # Save email account settings with OAuth request             
   class SaveOAuthEmailAccountRequest
-    # Email account host
+    # Email account host             
+    # @return [String]
     attr_accessor :host
 
-    # Email account port
+    # Email account port             
+    # @return [Integer]
     attr_accessor :port
 
-    # Email account login
+    # Email account login             
+    # @return [String]
     attr_accessor :login
 
-    # Email account security options
+    # Email account security mode Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto
+    # @return [String]
     attr_accessor :security_options
 
-    # Email account protocol type
+    # Type of connection protocol. Enum, available values: IMAP, POP3, SMTP, EWS, WebDav
+    # @return [String]
     attr_accessor :protocol_type
 
-    # Email account description
+    # Email account description             
+    # @return [String]
     attr_accessor :description
 
-    # A storage file location info to store email account
+    # A storage file location info to store email account             
+    # @return [StorageFileLocation]
     attr_accessor :storage_file
 
-    # OAuth client identifier
+    # OAuth client identifier             
+    # @return [String]
     attr_accessor :client_id
 
-    # OAuth client secret
+    # OAuth client secret             
+    # @return [String]
     attr_accessor :client_secret
 
-    # OAuth refresh token
+    # OAuth refresh token             
+    # @return [String]
     attr_accessor :refresh_token
 
+    # The url to obtain access token. If not specified, will try to discover from email account host.             
+    # @return [String]
+    attr_accessor :request_url
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -71,7 +85,8 @@ module AsposeEmailCloud
         :'storage_file' => :'storageFile',
         :'client_id' => :'clientId',
         :'client_secret' => :'clientSecret',
-        :'refresh_token' => :'refreshToken'
+        :'refresh_token' => :'refreshToken',
+        :'request_url' => :'requestUrl'
       }
     end
 
@@ -81,13 +96,14 @@ module AsposeEmailCloud
         :'host' => :'String',
         :'port' => :'Integer',
         :'login' => :'String',
-        :'security_options' => :'Object',
-        :'protocol_type' => :'Object',
+        :'security_options' => :'String',
+        :'protocol_type' => :'String',
         :'description' => :'String',
         :'storage_file' => :'StorageFileLocation',
         :'client_id' => :'String',
         :'client_secret' => :'String',
-        :'refresh_token' => :'String'
+        :'refresh_token' => :'String',
+        :'request_url' => :'String'
       }
     end
 
@@ -138,20 +154,36 @@ module AsposeEmailCloud
       if attributes.has_key?(:'refreshToken')
         self.refresh_token = attributes[:'refreshToken']
       end
+
+      if attributes.has_key?(:'requestUrl')
+        self.request_url = attributes[:'requestUrl']
+      end
     end
 
     # Initializes the object
-    def initialize(host=nil, port=nil, login=nil, security_options=nil, protocol_type=nil, description=nil, storage_file=nil, client_id=nil, client_secret=nil, refresh_token=nil)
-      self.host = host
-      self.port = port
-      self.login = login
-      self.security_options = security_options
-      self.protocol_type = protocol_type
-      self.description = description
-      self.storage_file = storage_file
-      self.client_id = client_id
-      self.client_secret = client_secret
-      self.refresh_token = refresh_token
+    # @param [String] host Email account host             
+    # @param [Integer] port Email account port             
+    # @param [String] login Email account login             
+    # @param [String] security_options Email account security mode Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto
+    # @param [String] protocol_type Type of connection protocol. Enum, available values: IMAP, POP3, SMTP, EWS, WebDav
+    # @param [String] description Email account description             
+    # @param [StorageFileLocation] storage_file A storage file location info to store email account             
+    # @param [String] client_id OAuth client identifier             
+    # @param [String] client_secret OAuth client secret             
+    # @param [String] refresh_token OAuth refresh token             
+    # @param [String] request_url The url to obtain access token. If not specified, will try to discover from email account host.             
+    def initialize(host=nil, port=nil, login=nil, security_options=nil, protocol_type=nil, description=nil, storage_file=nil, client_id=nil, client_secret=nil, refresh_token=nil, request_url=nil)
+      self.host = host if host
+      self.port = port if port
+      self.login = login if login
+      self.security_options = security_options if security_options
+      self.protocol_type = protocol_type if protocol_type
+      self.description = description if description
+      self.storage_file = storage_file if storage_file
+      self.client_id = client_id if client_id
+      self.client_secret = client_secret if client_secret
+      self.refresh_token = refresh_token if refresh_token
+      self.request_url = request_url if request_url
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -182,10 +214,18 @@ module AsposeEmailCloud
         invalid_properties.push('invalid value for "security_options", security_options cannot be nil.')
       end
 
+      if @security_options.to_s.length < 1
+        invalid_properties.push('invalid value for "security_options", the character length must be great than or equal to 1.')
+      end
+
       if @protocol_type.nil?
         invalid_properties.push('invalid value for "protocol_type", protocol_type cannot be nil.')
       end
 
+      if @protocol_type.to_s.length < 1
+        invalid_properties.push('invalid value for "protocol_type", the character length must be great than or equal to 1.')
+      end
+
       if @storage_file.nil?
         invalid_properties.push('invalid value for "storage_file", storage_file cannot be nil.')
       end
@@ -226,7 +266,9 @@ module AsposeEmailCloud
       return false if @login.nil?
       return false if @login.to_s.length < 1
       return false if @security_options.nil?
+      return false if @security_options.to_s.length < 1
       return false if @protocol_type.nil?
+      return false if @protocol_type.to_s.length < 1
       return false if @storage_file.nil?
       return false if @client_id.nil?
       return false if @client_id.to_s.length < 1
@@ -265,6 +307,34 @@ module AsposeEmailCloud
       @login = login
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] security_options Value to be assigned
+    def security_options=(security_options)
+      if security_options.nil?
+        fail ArgumentError, 'security_options cannot be nil'
+      end
+
+      if security_options.to_s.length < 1
+        fail ArgumentError, 'invalid value for "security_options", the character length must be great than or equal to 1.'
+      end
+
+      @security_options = security_options
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] protocol_type Value to be assigned
+    def protocol_type=(protocol_type)
+      if protocol_type.nil?
+        fail ArgumentError, 'protocol_type cannot be nil'
+      end
+
+      if protocol_type.to_s.length < 1
+        fail ArgumentError, 'invalid value for "protocol_type", the character length must be great than or equal to 1.'
+      end
+
+      @protocol_type = protocol_type
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] client_id Value to be assigned
     def client_id=(client_id)
@@ -321,7 +391,8 @@ module AsposeEmailCloud
           storage_file == o.storage_file &&
           client_id == o.client_id &&
           client_secret == o.client_secret &&
-          refresh_token == o.refresh_token
+          refresh_token == o.refresh_token &&
+          request_url == o.request_url
     end
 
     # @see the `==` method
@@ -333,115 +404,118 @@ module AsposeEmailCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [host, port, login, security_options, protocol_type, description, storage_file, client_id, client_secret, refresh_token].hash
+      [host, port, login, security_options, protocol_type, description, storage_file, client_id, client_secret, refresh_token, request_url].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        attribute_key = self.class.attribute_map[key]
+        attribute_key = (attribute_key[0, 1].downcase + attribute_key[1..-1]).to_sym
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_key].is_a?(Array)
+            self.send("#{key}=", attributes[attribute_key].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[attribute_key].nil?
+          self.send("#{key}=", _deserialize(type, attributes[attribute_key]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        sub_type = value[:type] || value[:discriminator] || type
+        if AsposeEmailCloud.const_defined?(sub_type)
+          type = sub_type
+        end
+        temp_model = AsposeEmailCloud.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
     end
 
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def build_from_hash(attributes)
-      return nil unless attributes.is_a?(Hash)
-      self.class.swagger_types.each_pair do |key, type|
-        attribute_key = self.class.attribute_map[key]
-        attribute_key = (attribute_key[0, 1].downcase + attribute_key[1..-1]).to_sym
-        if type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the the attribute
-          # is documented as an array but the input is not
-          if attributes[attribute_key].is_a?(Array)
-            self.send("#{key}=", attributes[attribute_key].map { |v| _deserialize($1, v) })
-          end
-        elsif !attributes[attribute_key].nil?
-          self.send("#{key}=", _deserialize(type, attributes[attribute_key]))
-        end # or else data not found in attributes(hash), not an issue as the data can be optional
-      end
-
-      self
-    end
-
-    # Deserializes the data based on type
-    # @param string type Data type
-    # @param string value Value to be deserialized
-    # @return [Object] Deserialized data
-    def _deserialize(type, value)
-      case type.to_sym
-      when :DateTime
-        DateTime.parse(value)
-      when :Date
-        Date.parse(value)
-      when :String
-        value.to_s
-      when :Integer
-        value.to_i
-      when :Float
-        value.to_f
-      when :BOOLEAN
-        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
-          true
-        else
-          false
-        end
-      when :Object
-        # generic object (usually a Hash), return directly
-        value
-      when /\AArray<(?<inner_type>.+)>\z/
-        inner_type = Regexp.last_match[:inner_type]
-        value.map { |v| _deserialize(inner_type, v) }
-      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
-        k_type = Regexp.last_match[:k_type]
-        v_type = Regexp.last_match[:v_type]
-        {}.tap do |hash|
-          value.each do |k, v|
-            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
-          end
-        end
-      else # model
-        type = value[:type] || type
-        temp_model = AsposeEmailCloud.const_get(type).new
-        temp_model.build_from_hash(value)
-      end
-    end
-
-    # Returns the string representation of the object
-    # @return [String] String presentation of the object
-    def to_s
-      to_hash.to_s
-    end
-
-    # to_body is an alias to to_hash (backward compatibility)
-    # @return [Hash] Returns the object in the form of hash
-    def to_body
-      to_hash
-    end
-
-    # Returns the object in the form of hash
-    # @return [Hash] Returns the object in the form of hash
-    def to_hash
-      hash = {}
-      self.class.attribute_map.each_pair do |attr, param|
-        value = self.send(attr)
-        next if value.nil?
-        hash[param] = _to_hash(value)
-      end
-      hash
-    end
-
-    # Outputs non-array value in the form of hash
-    # For object, use to_hash. Otherwise, just return the value
-    # @param [Object] value Any valid value
-    # @return [Hash] Returns the value in the form of hash
-    def _to_hash(value)
-      if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
-      elsif value.is_a?(Hash)
-        {}.tap do |hash|
-          value.each { |k, v| hash[k] = _to_hash(v) }
-        end
-      elsif value.respond_to? :to_hash
-        value.to_hash
-      else
-        value
-      end
-    end
-
-  end
-end
+  end
+end