aspose_email_cloud 20.3.0 → 20.12.0

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

@@ -0,0 +1,237 @@
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="ClientMessageBaseRequest.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
+  # Email client message request.             
+  class ClientMessageBaseRequest < ClientAccountBaseRequest
+    # Email client account configuration location on storage.             
+    # @return [StorageFileLocation]
+    attr_accessor :account_location
+    # Message identifier.             
+    # @return [String]
+    attr_accessor :message_id
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'account_location' => :'accountLocation',
+        :'message_id' => :'messageId'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'account_location' => :'StorageFileLocation',
+        :'message_id' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [StorageFileLocation] account_location Email client account configuration location on storage.             
+    # @param [String] message_id Message identifier.             
+    def initialize(
+      account_location: nil,
+      message_id: nil)
+      self.account_location = account_location if account_location
+      self.message_id = message_id if message_id
+    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 @account_location.nil?
+        invalid_properties.push('invalid value for "account_location", account_location cannot be nil.')
+      end
+
+      if @message_id.nil?
+        invalid_properties.push('invalid value for "message_id", message_id cannot be nil.')
+      end
+
+      if @message_id.to_s.length < 1
+        invalid_properties.push('invalid value for "message_id", the character length must be great than or equal to 1.')
+      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 @account_location.nil?
+      return false if @message_id.nil?
+      return false if @message_id.to_s.length < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] message_id Value to be assigned
+    def message_id=(message_id)
+      if message_id.nil?
+        fail ArgumentError, 'message_id cannot be nil'
+      end
+
+      if message_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "message_id", the character length must be great than or equal to 1.'
+      end
+
+      @message_id = message_id
+    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 &&
+          account_location == o.account_location &&
+          message_id == o.message_id
+    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
+      [account_location, message_id].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/{email_property.rb → client_message_delete_request.rb}

@@ -1,6 +1,6 @@
 #  ----------------------------------------------------------------------------
-#  <copyright company="Aspose" file="EmailProperty.rb">
-#    Copyright (c) 2018-2019 Aspose Pty Ltd. All rights reserved.
+#  <copyright company="Aspose" file="ClientMessageDeleteRequest.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
@@ -23,87 +23,65 @@
 #  </summary>
 #  ----------------------------------------------------------------------------
 
-
 require 'date'
 
 module AsposeEmailCloud
-  # Email property.             
-  class EmailProperty
-    # Link to property             
-    # @return [Link]
-    attr_accessor :link
-
-    # Property name             
+  # Email client delete message request.             
+  class ClientMessageDeleteRequest < ClientMessageBaseRequest
+    # Email client account configuration location on storage.             
+    # @return [StorageFileLocation]
+    attr_accessor :account_location
+    # Message identifier.             
     # @return [String]
-    attr_accessor :name
-
-    # Property value             
-    # @return [Object]
-    attr_accessor :value
-
+    attr_accessor :message_id
+    # Folder to delete message from.             
+    # @return [String]
+    attr_accessor :folder
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'link' => :'link',
-        :'name' => :'name',
-        :'value' => :'value'
+        :'account_location' => :'accountLocation',
+        :'message_id' => :'messageId',
+        :'folder' => :'folder'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'link' => :'Link',
-        :'name' => :'String',
-        :'value' => :'Object'
+        :'account_location' => :'StorageFileLocation',
+        :'message_id' => :'String',
+        :'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?(:'link')
-        self.link = attributes[:'link']
-      end
-
-      if attributes.has_key?(:'name')
-        self.name = attributes[:'name']
-      end
-
-      if attributes.has_key?(:'value')
-        self.value = attributes[:'value']
-      end
-    end
-
-    # Initializes the object
-    # @param [Link] link Link to property             
-    # @param [String] name Property name             
-    # @param [Object] value Property value             
-    def initialize(link=nil, name=nil, value=nil)
-      self.link = link if link
-      self.name = name if name
-      self.value = value if value
+    # @param [StorageFileLocation] account_location Email client account configuration location on storage.             
+    # @param [String] message_id Message identifier.             
+    # @param [String] folder Folder to delete message from.             
+    def initialize(
+      account_location: nil,
+      message_id: nil,
+      folder: nil)
+      self.account_location = account_location if account_location
+      self.message_id = message_id if message_id
+      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 @name.nil?
-        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      if @account_location.nil?
+        invalid_properties.push('invalid value for "account_location", account_location cannot be nil.')
       end
 
-      if @name.to_s.length < 1
-        invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
+      if @message_id.nil?
+        invalid_properties.push('invalid value for "message_id", message_id cannot be nil.')
       end
 
-      if @value.nil?
-        invalid_properties.push('invalid value for "value", value cannot be nil.')
+      if @message_id.to_s.length < 1
+        invalid_properties.push('invalid value for "message_id", the character length must be great than or equal to 1.')
       end
 
       invalid_properties
@@ -112,24 +90,24 @@ 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 @name.nil?
-      return false if @name.to_s.length < 1
-      return false if @value.nil?
+      return false if @account_location.nil?
+      return false if @message_id.nil?
+      return false if @message_id.to_s.length < 1
       true
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] name Value to be assigned
-    def name=(name)
-      if name.nil?
-        fail ArgumentError, 'name cannot be nil'
+    # @param [Object] message_id Value to be assigned
+    def message_id=(message_id)
+      if message_id.nil?
+        fail ArgumentError, 'message_id cannot be nil'
       end
 
-      if name.to_s.length < 1
-        fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.'
+      if message_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "message_id", the character length must be great than or equal to 1.'
       end
 
-      @name = name
+      @message_id = message_id
     end
 
     # Checks equality by comparing each attribute.
@@ -137,9 +115,9 @@ module AsposeEmailCloud
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          link == o.link &&
-          name == o.name &&
-          value == o.value
+          account_location == o.account_location &&
+          message_id == o.message_id &&
+          folder == o.folder
     end
 
     # @see the `==` method
@@ -151,7 +129,7 @@ module AsposeEmailCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [link, name, value].hash
+      [account_location, message_id, folder].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,108 @@
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="client_message_fetch_file_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 client_message_fetch_file operation.
+  class ClientMessageFetchFileRequest < EmailRequest
+    # Message identifier
+    # @return [String]
+    attr_accessor :message_id
+    # Email account
+    # @return [String]
+    attr_accessor :account
+    # Account folder to fetch from (should be specified for some protocols such as IMAP)             
+    # @return [String]
+    attr_accessor :folder
+    # Storage name where account file located.
+    # @return [String]
+    attr_accessor :storage
+    # Folder in storage where account file located.
+    # @return [String]
+    attr_accessor :account_storage_folder
+    # Fetched message file format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft
+    # @return [String]
+    attr_accessor :format
+
+    # Fetch message as file from email account             
+    # @param [String] message_id Message identifier
+    # @param [String] account Email account
+    # @param [String] folder Account folder to fetch from (should be specified for some protocols such as IMAP)             
+    # @param [String] storage Storage name where account file located.
+    # @param [String] account_storage_folder Folder in storage where account file located.
+    # @param [String] format Fetched message file format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft
+    def initialize(message_id:, account:, folder: nil, storage: nil, account_storage_folder: nil, format: nil)
+      self.message_id = message_id if message_id
+      self.account = account if account
+      self.folder = folder if folder
+      self.storage = storage if storage
+      self.account_storage_folder = account_storage_folder if account_storage_folder
+      self.format = format if format
+    end
+
+    def to_http_info(api_client)
+      # verify the required parameter 'message_id' is set
+      if api_client.config.client_side_validation && self.message_id.nil?
+        raise ArgumentError, "Missing the required parameter 'message_id' when calling ClientMessageApi.fetch_file"
+      end
+      # verify the required parameter 'account' is set
+      if api_client.config.client_side_validation && self.account.nil?
+        raise ArgumentError, "Missing the required parameter 'account' when calling ClientMessageApi.fetch_file"
+      end
+      # resource path
+      local_var_path = '/email/client/message/file'
+
+      # query parameters
+      query_params = {}
+      query_params[:messageId] = self.message_id
+      query_params[:account] = self.account
+      query_params[:folder] = self.folder unless self.folder.nil?
+      query_params[:storage] = self.storage unless self.storage.nil?
+      query_params[:accountStorageFolder] = self.account_storage_folder unless self.account_storage_folder.nil?
+      query_params[:format] = self.format unless self.format.nil?
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      auth_names = ['JWT']
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = EmailRequest.select_header_accept(['multipart/form-data'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = form_params.any? ? 'multipart/form-data' : EmailRequest.select_header_content_type(['application/json'])
+
+      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