aspose_email_cloud 20.3.0 → 20.5.0

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

@@ -0,0 +1,294 @@
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="EmailThreadReadFlagRq.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
+  # Request to mark all messages in thread as read or unread             
+  class EmailThreadReadFlagRq
+    # First account storage file name             
+    # @return [String]
+    attr_accessor :first_account
+
+    # Additional email account (for example, FirstAccount could be IMAP, and second one could be SMTP)             
+    # @return [String]
+    attr_accessor :second_account
+
+    # Storage folder location of account files             
+    # @return [StorageFolderLocation]
+    attr_accessor :storage_folder
+
+    # Read flag to set. \"true\" by default             
+    # @return [BOOLEAN]
+    attr_accessor :is_read
+
+    # Specifies account folder to get thread from             
+    # @return [String]
+    attr_accessor :folder
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'first_account' => :'firstAccount',
+        :'second_account' => :'secondAccount',
+        :'storage_folder' => :'storageFolder',
+        :'is_read' => :'isRead',
+        :'folder' => :'folder'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'first_account' => :'String',
+        :'second_account' => :'String',
+        :'storage_folder' => :'StorageFolderLocation',
+        :'is_read' => :'BOOLEAN',
+        :'folder' => :'String'
+      }
+    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?(:'firstAccount')
+        self.first_account = attributes[:'firstAccount']
+      end
+
+      if attributes.has_key?(:'secondAccount')
+        self.second_account = attributes[:'secondAccount']
+      end
+
+      if attributes.has_key?(:'storageFolder')
+        self.storage_folder = attributes[:'storageFolder']
+      end
+
+      if attributes.has_key?(:'isRead')
+        self.is_read = attributes[:'isRead']
+      end
+
+      if attributes.has_key?(:'folder')
+        self.folder = attributes[:'folder']
+      end
+    end
+
+    # Initializes the object
+    # @param [String] first_account First account storage file name             
+    # @param [String] second_account Additional email account (for example, FirstAccount could be IMAP, and second one could be SMTP)             
+    # @param [StorageFolderLocation] storage_folder Storage folder location of account files             
+    # @param [BOOLEAN] is_read Read flag to set. \"true\" by default             
+    # @param [String] folder Specifies account folder to get thread from             
+    def initialize(first_account=nil, second_account=nil, storage_folder=nil, is_read=nil, folder=nil)
+      self.first_account = first_account if first_account
+      self.second_account = second_account if second_account
+      self.storage_folder = storage_folder if storage_folder
+      self.is_read = is_read if is_read
+      self.folder = folder if folder
+    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 @first_account.nil?
+        invalid_properties.push('invalid value for "first_account", first_account cannot be nil.')
+      end
+
+      if @first_account.to_s.length < 1
+        invalid_properties.push('invalid value for "first_account", the character length must be great than or equal to 1.')
+      end
+
+      if @is_read.nil?
+        invalid_properties.push('invalid value for "is_read", is_read cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # 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 @first_account.nil?
+      return false if @first_account.to_s.length < 1
+      return false if @is_read.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] first_account Value to be assigned
+    def first_account=(first_account)
+      if first_account.nil?
+        fail ArgumentError, 'first_account cannot be nil'
+      end
+
+      if first_account.to_s.length < 1
+        fail ArgumentError, 'invalid value for "first_account", the character length must be great than or equal to 1.'
+      end
+
+      @first_account = first_account
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          first_account == o.first_account &&
+          second_account == o.second_account &&
+          storage_folder == o.storage_folder &&
+          is_read == o.is_read &&
+          folder == o.folder
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [first_account, second_account, storage_folder, is_read, folder].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
+
+  end
+end

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

@@ -1,6 +1,6 @@
 #  ----------------------------------------------------------------------------
 #  <copyright company="Aspose" file="EnumWithCustomOfAssociatedPersonCategory.rb">
-#    Copyright (c) 2018-2019 Aspose Pty Ltd. All rights reserved.
+#    Copyright (c) 2018-2020 Aspose Pty Ltd. All rights reserved.
 #  </copyright>
 #  <summary>
 #    Permission is hereby granted, free of charge, to any person obtaining a

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

@@ -1,6 +1,6 @@
 #  ----------------------------------------------------------------------------
 #  <copyright company="Aspose" file="EnumWithCustomOfEmailAddressCategory.rb">
-#    Copyright (c) 2018-2019 Aspose Pty Ltd. All rights reserved.
+#    Copyright (c) 2018-2020 Aspose Pty Ltd. All rights reserved.
 #  </copyright>
 #  <summary>
 #    Permission is hereby granted, free of charge, to any person obtaining a

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

@@ -1,6 +1,6 @@
 #  ----------------------------------------------------------------------------
 #  <copyright company="Aspose" file="EnumWithCustomOfEventCategory.rb">
-#    Copyright (c) 2018-2019 Aspose Pty Ltd. All rights reserved.
+#    Copyright (c) 2018-2020 Aspose Pty Ltd. All rights reserved.
 #  </copyright>
 #  <summary>
 #    Permission is hereby granted, free of charge, to any person obtaining a

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

@@ -1,6 +1,6 @@
 #  ----------------------------------------------------------------------------
 #  <copyright company="Aspose" file="EnumWithCustomOfInstantMessengerCategory.rb">
-#    Copyright (c) 2018-2019 Aspose Pty Ltd. All rights reserved.
+#    Copyright (c) 2018-2020 Aspose Pty Ltd. All rights reserved.
 #  </copyright>
 #  <summary>
 #    Permission is hereby granted, free of charge, to any person obtaining a

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

@@ -1,6 +1,6 @@
 #  ----------------------------------------------------------------------------
 #  <copyright company="Aspose" file="EnumWithCustomOfPhoneNumberCategory.rb">
-#    Copyright (c) 2018-2019 Aspose Pty Ltd. All rights reserved.
+#    Copyright (c) 2018-2020 Aspose Pty Ltd. All rights reserved.
 #  </copyright>
 #  <summary>
 #    Permission is hereby granted, free of charge, to any person obtaining a

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

@@ -1,6 +1,6 @@
 #  ----------------------------------------------------------------------------
 #  <copyright company="Aspose" file="EnumWithCustomOfPostalAddressCategory.rb">
-#    Copyright (c) 2018-2019 Aspose Pty Ltd. All rights reserved.
+#    Copyright (c) 2018-2020 Aspose Pty Ltd. All rights reserved.
 #  </copyright>
 #  <summary>
 #    Permission is hereby granted, free of charge, to any person obtaining a

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

@@ -1,6 +1,6 @@
 #  ----------------------------------------------------------------------------
 #  <copyright company="Aspose" file="EnumWithCustomOfUrlCategory.rb">
-#    Copyright (c) 2018-2019 Aspose Pty Ltd. All rights reserved.
+#    Copyright (c) 2018-2020 Aspose Pty Ltd. All rights reserved.
 #  </copyright>
 #  <summary>
 #    Permission is hereby granted, free of charge, to any person obtaining a

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

@@ -1,6 +1,6 @@
 #  ----------------------------------------------------------------------------
 #  <copyright company="Aspose" file="Error.rb">
-#    Copyright (c) 2018-2019 Aspose Pty Ltd. All rights reserved.
+#    Copyright (c) 2018-2020 Aspose Pty Ltd. All rights reserved.
 #  </copyright>
 #  <summary>
 #    Permission is hereby granted, free of charge, to any person obtaining a
@@ -27,21 +27,20 @@
 require 'date'
 
 module AsposeEmailCloud
-  # Error
   class Error
-    # Code             
+    
     # @return [String]
     attr_accessor :code
 
-    # Message             
+    
     # @return [String]
     attr_accessor :message
 
-    # Description             
+    
     # @return [String]
     attr_accessor :description
 
-    # Inner Error             
+    
     # @return [ErrorDetails]
     attr_accessor :inner_error
 
@@ -91,10 +90,10 @@ module AsposeEmailCloud
     end
 
     # Initializes the object
-    # @param [String] code Code             
-    # @param [String] message Message             
-    # @param [String] description Description             
-    # @param [ErrorDetails] inner_error Inner Error             
+    # @param [String] code 
+    # @param [String] message 
+    # @param [String] description 
+    # @param [ErrorDetails] inner_error 
     def initialize(code=nil, message=nil, description=nil, inner_error=nil)
       self.code = code if code
       self.message = message if message

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

@@ -1,6 +1,6 @@
 #  ----------------------------------------------------------------------------
 #  <copyright company="Aspose" file="ErrorDetails.rb">
-#    Copyright (c) 2018-2019 Aspose Pty Ltd. All rights reserved.
+#    Copyright (c) 2018-2020 Aspose Pty Ltd. All rights reserved.
 #  </copyright>
 #  <summary>
 #    Permission is hereby granted, free of charge, to any person obtaining a
@@ -27,13 +27,12 @@
 require 'date'
 
 module AsposeEmailCloud
-  # The error details
   class ErrorDetails
-    # The request id
+    
     # @return [String]
     attr_accessor :request_id
 
-    # Date
+    
     # @return [DateTime]
     attr_accessor :date
 
@@ -71,8 +70,8 @@ module AsposeEmailCloud
     end
 
     # Initializes the object
-    # @param [String] request_id The request id
-    # @param [DateTime] date Date
+    # @param [String] request_id 
+    # @param [DateTime] date 
     def initialize(request_id=nil, date=nil)
       self.request_id = request_id if request_id
       self.date = date if date

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

@@ -1,6 +1,6 @@
 #  ----------------------------------------------------------------------------
 #  <copyright company="Aspose" file="FileVersion.rb">
-#    Copyright (c) 2018-2019 Aspose Pty Ltd. All rights reserved.
+#    Copyright (c) 2018-2020 Aspose Pty Ltd. All rights reserved.
 #  </copyright>
 #  <summary>
 #    Permission is hereby granted, free of charge, to any person obtaining a
@@ -27,33 +27,32 @@
 require 'date'
 
 module AsposeEmailCloud
-  # File Version
   class FileVersion
-    # File or folder name.
+    
     # @return [String]
     attr_accessor :name
 
-    # True if it is a folder.
+    
     # @return [BOOLEAN]
     attr_accessor :is_folder
 
-    # File or folder last modified DateTime.
+    
     # @return [DateTime]
     attr_accessor :modified_date
 
-    # File or folder size.
+    
     # @return [Integer]
     attr_accessor :size
 
-    # File or folder path.
+    
     # @return [String]
     attr_accessor :path
 
-    # File Version ID.
+    
     # @return [String]
     attr_accessor :version_id
 
-    # Specifies whether the file is (true) or is not (false) the latest version of an file.
+    
     # @return [BOOLEAN]
     attr_accessor :is_latest
 
@@ -121,13 +120,13 @@ module AsposeEmailCloud
     end
 
     # Initializes the object
-    # @param [String] name File or folder name.
-    # @param [BOOLEAN] is_folder True if it is a folder.
-    # @param [DateTime] modified_date File or folder last modified DateTime.
-    # @param [Integer] size File or folder size.
-    # @param [String] path File or folder path.
-    # @param [String] version_id File Version ID.
-    # @param [BOOLEAN] is_latest Specifies whether the file is (true) or is not (false) the latest version of an file.
+    # @param [String] name 
+    # @param [BOOLEAN] is_folder 
+    # @param [DateTime] modified_date 
+    # @param [Integer] size 
+    # @param [String] path 
+    # @param [String] version_id 
+    # @param [BOOLEAN] is_latest 
     def initialize(name=nil, is_folder=nil, modified_date=nil, size=nil, path=nil, version_id=nil, is_latest=nil)
       self.name = name if name
       self.is_folder = is_folder if is_folder