aspose_email_cloud 20.3.0 → 20.12.0

data/lib/aspose-email-cloud/models/{requests/convert_email_request_data.rb → mapi_message_from_file_request.rb}

@@ -1,7 +1,6 @@
-
 #  ----------------------------------------------------------------------------
-#  <copyright company="Aspose" file="convert_email_request_data.rb">
-#    Copyright (c) 2018-2019 Aspose Pty Ltd. All rights reserved.
+#  <copyright company="Aspose" file="mapi_message_from_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
@@ -24,25 +23,23 @@
 #  </summary>
 #  ----------------------------------------------------------------------------
 
-
 require_relative './email_request'
 require_relative './http_request'
 
 module AsposeEmailCloud
-  # Request model for convert_email operation.
-  class ConvertEmailRequestData < EmailRequest
-
-    # File format Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html
+  # Request model for mapi_message_from_file operation.
+  class MapiMessageFromFileRequest < EmailRequest
+    # File format Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft
     # @return [String]
     attr_accessor :format
-    # File to upload
+    # File to convert
     # @return [File]
     attr_accessor :file
 
-    # Converts email document to specified format and returns as file             
-    # @param [String] format File format Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html
-    # @param [File] file File to upload
-    def initialize(format, file)
+    # Converts email file to a MAPI model representation             
+    # @param [String] format File format Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft
+    # @param [File] file File to convert
+    def initialize(format:, file:)
       self.format = format if format
       self.file = file if file
     end
@@ -50,41 +47,38 @@ module AsposeEmailCloud
     def to_http_info(api_client)
       # verify the required parameter 'format' is set
       if api_client.config.client_side_validation && self.format.nil?
-        raise ArgumentError, "Missing the required parameter 'format' when calling EmailApi.convert_email"
+        raise ArgumentError, "Missing the required parameter 'format' when calling MapiMessageApi.from_file"
       end
-
       # 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 EmailApi.convert_email"
+        raise ArgumentError, "Missing the required parameter 'file' when calling MapiMessageApi.from_file"
       end
-
       # resource path
-      local_var_path = '/email/convert/{format}'.sub('{' + 'format' + '}', self.format.to_s)
+      local_var_path = '/email/MapiMessage/from-file'
 
       # query parameters
       query_params = {}
+      query_params[:format] = self.format
 
       # form parameters
       form_params = {}
       form_params['File'] = self.file
 
       # 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'])
+      header_params['Accept'] = EmailRequest.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'])
+      header_params['Content-Type'] = form_params.any? ? 'multipart/form-data' : EmailRequest.select_header_content_type(['multipart/form-data'])
 
-      AsposeEmailCloud::HttpRequest.new(local_var_path,
-                                      header_params,
-                                      query_params,
-                                      form_params,
-                                      post_body,
-                                      auth_names)
+      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/mapi_message_get_request.rb

@@ -0,0 +1,99 @@
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="mapi_message_get_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 mapi_message_get operation.
+  class MapiMessageGetRequest < EmailRequest
+    # Email document format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft
+    # @return [String]
+    attr_accessor :format
+    # Email document file name.
+    # @return [String]
+    attr_accessor :file_name
+    # Path to folder in storage.
+    # @return [String]
+    attr_accessor :folder
+    # Storage name.
+    # @return [String]
+    attr_accessor :storage
+
+    # Get MAPI message document.             
+    # @param [String] format Email document format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft
+    # @param [String] file_name Email document file name.
+    # @param [String] folder Path to folder in storage.
+    # @param [String] storage Storage name.
+    def initialize(format:, file_name:, folder: nil, storage: nil)
+      self.format = format if format
+      self.file_name = file_name if file_name
+      self.folder = folder if folder
+      self.storage = storage if storage
+    end
+
+    def to_http_info(api_client)
+      # verify the required parameter 'format' is set
+      if api_client.config.client_side_validation && self.format.nil?
+        raise ArgumentError, "Missing the required parameter 'format' when calling MapiMessageApi.get"
+      end
+      # verify the required parameter 'file_name' is set
+      if api_client.config.client_side_validation && self.file_name.nil?
+        raise ArgumentError, "Missing the required parameter 'file_name' when calling MapiMessageApi.get"
+      end
+      # resource path
+      local_var_path = '/email/MapiMessage'
+
+      # query parameters
+      query_params = {}
+      query_params[:format] = self.format
+      query_params[:fileName] = self.file_name
+      query_params[:folder] = self.folder unless self.folder.nil?
+      query_params[:storage] = self.storage unless self.storage.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(['application/json'])
+      # 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
+
+
+

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

@@ -0,0 +1,359 @@
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="MapiMessageItemBaseDto.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
+  # Base Dto for MapiMessage, MapiCalendar or MapiContact             
+  class MapiMessageItemBaseDto
+    # Message item attachments.             
+    # @return [Array<MapiAttachmentDto>]
+    attr_accessor :attachments
+    # Billing information associated with an item.             
+    # @return [String]
+    attr_accessor :billing
+    # Message text.             
+    # @return [String]
+    attr_accessor :body
+    # Gets the BodyRtf of the message converted to HTML, if present, otherwise an empty string.             
+    # @return [String]
+    attr_accessor :body_html
+    # RTF formatted message text.             
+    # @return [String]
+    attr_accessor :body_rtf
+    # The content type of message body. Enum, available values: PlainText, Html, Rtf
+    # @return [String]
+    attr_accessor :body_type
+    # Contains keywords or categories for the message object.             
+    # @return [Array<String>]
+    attr_accessor :categories
+    # Contains the names of the companies that are associated with an item.             
+    # @return [Array<String>]
+    attr_accessor :companies
+    # The item id, uses with a server.             
+    # @return [String]
+    attr_accessor :item_id
+    # Case-sensitive string that identifies the sender-defined message class, such as IPM.Note. The message class specifies the type, purpose, or content of the message.             
+    # @return [String]
+    attr_accessor :message_class
+    # Contains the mileage information that is associated with an item.             
+    # @return [String]
+    attr_accessor :mileage
+    # Recipients of the message.             
+    # @return [Array<MapiRecipientDto>]
+    attr_accessor :recipients
+    # Contains values that indicate the message sensitivity. Enum, available values: None, Personal, Private, CompanyConfidential
+    # @return [String]
+    attr_accessor :sensitivity
+    # Subject of the message.             
+    # @return [String]
+    attr_accessor :subject
+    # Subject prefix that typically indicates some action on a message, such as \"FW: \" for forwarding.             
+    # @return [String]
+    attr_accessor :subject_prefix
+    # List of MAPI properties             
+    # @return [Array<MapiPropertyDto>]
+    attr_accessor :properties
+    def discriminator #getter method
+      self.class.name.split('::').last
+    end
+
+    def discriminator=(discriminator) #setter method, parameter ignored
+      @discriminator = self.class.name.split('::').last
+    end
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'attachments' => :'attachments',
+        :'billing' => :'billing',
+        :'body' => :'body',
+        :'body_html' => :'bodyHtml',
+        :'body_rtf' => :'bodyRtf',
+        :'body_type' => :'bodyType',
+        :'categories' => :'categories',
+        :'companies' => :'companies',
+        :'item_id' => :'itemId',
+        :'message_class' => :'messageClass',
+        :'mileage' => :'mileage',
+        :'recipients' => :'recipients',
+        :'sensitivity' => :'sensitivity',
+        :'subject' => :'subject',
+        :'subject_prefix' => :'subjectPrefix',
+        :'properties' => :'properties',
+        :'discriminator' => :'discriminator'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'attachments' => :'Array<MapiAttachmentDto>',
+        :'billing' => :'String',
+        :'body' => :'String',
+        :'body_html' => :'String',
+        :'body_rtf' => :'String',
+        :'body_type' => :'String',
+        :'categories' => :'Array<String>',
+        :'companies' => :'Array<String>',
+        :'item_id' => :'String',
+        :'message_class' => :'String',
+        :'mileage' => :'String',
+        :'recipients' => :'Array<MapiRecipientDto>',
+        :'sensitivity' => :'String',
+        :'subject' => :'String',
+        :'subject_prefix' => :'String',
+        :'properties' => :'Array<MapiPropertyDto>',
+        :'discriminator' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Array<MapiAttachmentDto>] attachments Message item attachments.             
+    # @param [String] billing Billing information associated with an item.             
+    # @param [String] body Message text.             
+    # @param [String] body_html Gets the BodyRtf of the message converted to HTML, if present, otherwise an empty string.             
+    # @param [String] body_rtf RTF formatted message text.             
+    # @param [String] body_type The content type of message body. Enum, available values: PlainText, Html, Rtf
+    # @param [Array<String>] categories Contains keywords or categories for the message object.             
+    # @param [Array<String>] companies Contains the names of the companies that are associated with an item.             
+    # @param [String] item_id The item id, uses with a server.             
+    # @param [String] message_class Case-sensitive string that identifies the sender-defined message class, such as IPM.Note. The message class specifies the type, purpose, or content of the message.             
+    # @param [String] mileage Contains the mileage information that is associated with an item.             
+    # @param [Array<MapiRecipientDto>] recipients Recipients of the message.             
+    # @param [String] sensitivity Contains values that indicate the message sensitivity. Enum, available values: None, Personal, Private, CompanyConfidential
+    # @param [String] subject Subject of the message.             
+    # @param [String] subject_prefix Subject prefix that typically indicates some action on a message, such as \"FW: \" for forwarding.             
+    # @param [Array<MapiPropertyDto>] properties List of MAPI properties             
+    def initialize(
+      attachments: nil,
+      billing: nil,
+      body: nil,
+      body_html: nil,
+      body_rtf: nil,
+      body_type: nil,
+      categories: nil,
+      companies: nil,
+      item_id: nil,
+      message_class: nil,
+      mileage: nil,
+      recipients: nil,
+      sensitivity: nil,
+      subject: nil,
+      subject_prefix: nil,
+      properties: nil)
+      self.attachments = attachments if attachments
+      self.billing = billing if billing
+      self.body = body if body
+      self.body_html = body_html if body_html
+      self.body_rtf = body_rtf if body_rtf
+      self.body_type = body_type if body_type
+      self.categories = categories if categories
+      self.companies = companies if companies
+      self.item_id = item_id if item_id
+      self.message_class = message_class if message_class
+      self.mileage = mileage if mileage
+      self.recipients = recipients if recipients
+      self.sensitivity = sensitivity if sensitivity
+      self.subject = subject if subject
+      self.subject_prefix = subject_prefix if subject_prefix
+      self.properties = properties if properties
+    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 @body_type.nil?
+        invalid_properties.push('invalid value for "body_type", body_type cannot be nil.')
+      end
+
+      if @sensitivity.nil?
+        invalid_properties.push('invalid value for "sensitivity", sensitivity cannot be nil.')
+      end
+
+      if @discriminator.nil?
+        invalid_properties.push('invalid value for "discriminator", discriminator 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 @body_type.nil?
+      return false if @sensitivity.nil?
+      return false if @discriminator.nil?
+      true
+    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 &&
+          attachments == o.attachments &&
+          billing == o.billing &&
+          body == o.body &&
+          body_html == o.body_html &&
+          body_rtf == o.body_rtf &&
+          body_type == o.body_type &&
+          categories == o.categories &&
+          companies == o.companies &&
+          item_id == o.item_id &&
+          message_class == o.message_class &&
+          mileage == o.mileage &&
+          recipients == o.recipients &&
+          sensitivity == o.sensitivity &&
+          subject == o.subject &&
+          subject_prefix == o.subject_prefix &&
+          properties == o.properties &&
+          discriminator == o.discriminator
+    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
+      [attachments, billing, body, body_html, body_rtf, body_type, categories, companies, item_id, message_class, mileage, recipients, sensitivity, subject, subject_prefix, properties, discriminator].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