aspose_email_cloud 20.3.0 → 20.12.0

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

@@ -0,0 +1,218 @@
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="ContactAsFileRequest.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
+  # Convert contact model to file request.             
+  class ContactAsFileRequest
+    # Enumerates contact formats. Enum, available values: VCard, WebDav, Msg
+    # @return [String]
+    attr_accessor :format
+    # Contact model.             
+    # @return [ContactDto]
+    attr_accessor :value
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'format' => :'format',
+        :'value' => :'value'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'format' => :'String',
+        :'value' => :'ContactDto'
+      }
+    end
+
+    # Initializes the object
+    # @param [String] format Enumerates contact formats. Enum, available values: VCard, WebDav, Msg
+    # @param [ContactDto] value Contact model.             
+    def initialize(
+      format: nil,
+      value: nil)
+      self.format = format if format
+      self.value = value if value
+    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 @format.nil?
+        invalid_properties.push('invalid value for "format", format cannot be nil.')
+      end
+
+      if @value.nil?
+        invalid_properties.push('invalid value for "value", value 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 @format.nil?
+      return false if @value.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 &&
+          format == o.format &&
+          value == o.value
+    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
+      [format, value].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/contact_convert_request.rb

@@ -0,0 +1,94 @@
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="contact_convert_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 contact_convert operation.
+  class ContactConvertRequest < EmailRequest
+    # File format to convert to Enum, available values: VCard, WebDav, Msg
+    # @return [String]
+    attr_accessor :to_format
+    # File format to convert from Enum, available values: VCard, WebDav, Msg
+    # @return [String]
+    attr_accessor :from_format
+    # File to convert
+    # @return [File]
+    attr_accessor :file
+
+    # Converts contact document to specified format and returns as file             
+    # @param [String] to_format File format to convert to Enum, available values: VCard, WebDav, Msg
+    # @param [String] from_format File format to convert from Enum, available values: VCard, WebDav, Msg
+    # @param [File] file File to convert
+    def initialize(to_format:, from_format:, file:)
+      self.to_format = to_format if to_format
+      self.from_format = from_format if from_format
+      self.file = file if file
+    end
+
+    def to_http_info(api_client)
+      # verify the required parameter 'to_format' is set
+      if api_client.config.client_side_validation && self.to_format.nil?
+        raise ArgumentError, "Missing the required parameter 'to_format' when calling ContactApi.convert"
+      end
+      # verify the required parameter 'from_format' is set
+      if api_client.config.client_side_validation && self.from_format.nil?
+        raise ArgumentError, "Missing the required parameter 'from_format' when calling ContactApi.convert"
+      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 ContactApi.convert"
+      end
+      # resource path
+      local_var_path = '/email/Contact/convert'
+
+      # query parameters
+      query_params = {}
+      query_params[:toFormat] = self.to_format
+      query_params[:fromFormat] = self.from_format
+
+      # 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(['multipart/form-data'])
+      # 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/contact_dto.rb

@@ -1,6 +1,6 @@
 #  ----------------------------------------------------------------------------
 #  <copyright company="Aspose" file="ContactDto.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
@@ -23,7 +23,6 @@
 #  </summary>
 #  ----------------------------------------------------------------------------
 
-
 require 'date'
 
 module AsposeEmailCloud
@@ -32,147 +31,111 @@ module AsposeEmailCloud
     # Associated persons.             
     # @return [Array<AssociatedPerson>]
     attr_accessor :associated_persons
-
     # Document attachments.             
     # @return [Array<Attachment>]
     attr_accessor :attachments
-
     # Company name.             
     # @return [String]
     attr_accessor :company_name
-
     # Computer network.             
     # @return [String]
     attr_accessor :computer_network_name
-
     # Customer id.             
     # @return [String]
     attr_accessor :customer_id
-
     # Department name.             
     # @return [String]
     attr_accessor :department_name
-
     # Display name.             
     # @return [String]
     attr_accessor :display_name
-
     # Person's email addresses.             
     # @return [Array<EmailAddress>]
     attr_accessor :email_addresses
-
     # Person's events.             
     # @return [Array<CustomerEvent>]
     attr_accessor :events
-
     # A name used for sorting.             
     # @return [String]
     attr_accessor :file_as
-
     # Specifies how to generate and recompute the value of the dispidFileAs property when other contact name properties change. Coincides MS-OXPROPS revision 16.2 from 7/31/2014. Enum, available values: Empty, DisplayName, FirstName, LastName, Organization, LastFirstMiddle, OrgLastFirstMiddle, LastFirstMiddleOrg, LastFirstMiddle2, LastFirstMiddle3, OrgLastFirstMiddle2, OrgLastFirstMiddle3, LastFirstMiddleOrg2, LastFirstMiddleOrg3, LastFirstMiddleGen, FirstMiddleLastGen, LastFirstMiddleGen2, BestMatch, AccordingToLocale, None
     # @return [String]
     attr_accessor :file_as_mapping
-
     # URL path from which a client can retrieve free/busy information for the contact as an iCal file.             
     # @return [String]
     attr_accessor :free_busy_location
-
     # Enum defines gender of a person. Enum, available values: Unspecified, Female, Male
     # @return [String]
     attr_accessor :gender
-
     # Person's given name.             
     # @return [String]
     attr_accessor :given_name
-
     # Government id number.             
     # @return [String]
     attr_accessor :government_id_number
-
     # Person's hobbies.             
     # @return [String]
     attr_accessor :hobbies
-
     # Person's initials.             
     # @return [String]
     attr_accessor :initials
-
     # Person's instant messenger addresses.             
     # @return [Array<InstantMessengerAddress>]
     attr_accessor :instant_messengers
-
     # Person's job title.             
     # @return [String]
     attr_accessor :job_title
-
     # Language.             
     # @return [String]
     attr_accessor :language
-
     # Person's location.             
     # @return [String]
     attr_accessor :location
-
     # Person's middle name.             
     # @return [String]
     attr_accessor :middle_name
-
     # Person's nickname.             
     # @return [String]
     attr_accessor :nickname
-
     # Notes.             
     # @return [String]
     attr_accessor :notes
-
     # Defines format of a text. Enum, available values: Text, Html
     # @return [String]
     attr_accessor :notes_format
-
     # Office location.             
     # @return [String]
     attr_accessor :office_location
-
     # Contains an identifier for the mail user used within the mail user's organization.             
     # @return [String]
     attr_accessor :organizational_id_number
-
     # Person's phone numbers.             
     # @return [Array<PhoneNumber>]
     attr_accessor :phone_numbers
-
     # Person's photo.             
     # @return [ContactPhoto]
     attr_accessor :photo
-
     # Person's physical addresses.             
     # @return [Array<PostalAddress>]
     attr_accessor :physical_addresses
-
     # Encoding for all text properties.             
     # @return [String]
     attr_accessor :preferred_text_encoding
-
     # A prefix of a full name such like Mr.(mister), Dr.(doctor) and so on.             
     # @return [String]
     attr_accessor :prefix
-
     # A job position of a person in a company.             
     # @return [String]
     attr_accessor :profession
-
     # A suffix of a full name such like Jr.(junior), Sr.(senior) and so on.             
     # @return [String]
     attr_accessor :suffix
-
     # Person's surname.             
     # @return [String]
     attr_accessor :surname
-
     # Person's urls.             
     # @return [Array<Url>]
     attr_accessor :urls
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -257,175 +220,6 @@ 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?(:'associatedPersons')
-        if (value = attributes[:'associatedPersons']).is_a?(Array)
-          self.associated_persons = value
-        end
-      end
-
-      if attributes.has_key?(:'attachments')
-        if (value = attributes[:'attachments']).is_a?(Array)
-          self.attachments = value
-        end
-      end
-
-      if attributes.has_key?(:'companyName')
-        self.company_name = attributes[:'companyName']
-      end
-
-      if attributes.has_key?(:'computerNetworkName')
-        self.computer_network_name = attributes[:'computerNetworkName']
-      end
-
-      if attributes.has_key?(:'customerId')
-        self.customer_id = attributes[:'customerId']
-      end
-
-      if attributes.has_key?(:'departmentName')
-        self.department_name = attributes[:'departmentName']
-      end
-
-      if attributes.has_key?(:'displayName')
-        self.display_name = attributes[:'displayName']
-      end
-
-      if attributes.has_key?(:'emailAddresses')
-        if (value = attributes[:'emailAddresses']).is_a?(Array)
-          self.email_addresses = value
-        end
-      end
-
-      if attributes.has_key?(:'events')
-        if (value = attributes[:'events']).is_a?(Array)
-          self.events = value
-        end
-      end
-
-      if attributes.has_key?(:'fileAs')
-        self.file_as = attributes[:'fileAs']
-      end
-
-      if attributes.has_key?(:'fileAsMapping')
-        self.file_as_mapping = attributes[:'fileAsMapping']
-      end
-
-      if attributes.has_key?(:'freeBusyLocation')
-        self.free_busy_location = attributes[:'freeBusyLocation']
-      end
-
-      if attributes.has_key?(:'gender')
-        self.gender = attributes[:'gender']
-      end
-
-      if attributes.has_key?(:'givenName')
-        self.given_name = attributes[:'givenName']
-      end
-
-      if attributes.has_key?(:'governmentIdNumber')
-        self.government_id_number = attributes[:'governmentIdNumber']
-      end
-
-      if attributes.has_key?(:'hobbies')
-        self.hobbies = attributes[:'hobbies']
-      end
-
-      if attributes.has_key?(:'initials')
-        self.initials = attributes[:'initials']
-      end
-
-      if attributes.has_key?(:'instantMessengers')
-        if (value = attributes[:'instantMessengers']).is_a?(Array)
-          self.instant_messengers = value
-        end
-      end
-
-      if attributes.has_key?(:'jobTitle')
-        self.job_title = attributes[:'jobTitle']
-      end
-
-      if attributes.has_key?(:'language')
-        self.language = attributes[:'language']
-      end
-
-      if attributes.has_key?(:'location')
-        self.location = attributes[:'location']
-      end
-
-      if attributes.has_key?(:'middleName')
-        self.middle_name = attributes[:'middleName']
-      end
-
-      if attributes.has_key?(:'nickname')
-        self.nickname = attributes[:'nickname']
-      end
-
-      if attributes.has_key?(:'notes')
-        self.notes = attributes[:'notes']
-      end
-
-      if attributes.has_key?(:'notesFormat')
-        self.notes_format = attributes[:'notesFormat']
-      end
-
-      if attributes.has_key?(:'officeLocation')
-        self.office_location = attributes[:'officeLocation']
-      end
-
-      if attributes.has_key?(:'organizationalIdNumber')
-        self.organizational_id_number = attributes[:'organizationalIdNumber']
-      end
-
-      if attributes.has_key?(:'phoneNumbers')
-        if (value = attributes[:'phoneNumbers']).is_a?(Array)
-          self.phone_numbers = value
-        end
-      end
-
-      if attributes.has_key?(:'photo')
-        self.photo = attributes[:'photo']
-      end
-
-      if attributes.has_key?(:'physicalAddresses')
-        if (value = attributes[:'physicalAddresses']).is_a?(Array)
-          self.physical_addresses = value
-        end
-      end
-
-      if attributes.has_key?(:'preferredTextEncoding')
-        self.preferred_text_encoding = attributes[:'preferredTextEncoding']
-      end
-
-      if attributes.has_key?(:'prefix')
-        self.prefix = attributes[:'prefix']
-      end
-
-      if attributes.has_key?(:'profession')
-        self.profession = attributes[:'profession']
-      end
-
-      if attributes.has_key?(:'suffix')
-        self.suffix = attributes[:'suffix']
-      end
-
-      if attributes.has_key?(:'surname')
-        self.surname = attributes[:'surname']
-      end
-
-      if attributes.has_key?(:'urls')
-        if (value = attributes[:'urls']).is_a?(Array)
-          self.urls = value
-        end
-      end
-    end
-
     # Initializes the object
     # @param [Array<AssociatedPerson>] associated_persons Associated persons.             
     # @param [Array<Attachment>] attachments Document attachments.             
@@ -463,7 +257,43 @@ module AsposeEmailCloud
     # @param [String] suffix A suffix of a full name such like Jr.(junior), Sr.(senior) and so on.             
     # @param [String] surname Person's surname.             
     # @param [Array<Url>] urls Person's urls.             
-    def initialize(associated_persons=nil, attachments=nil, company_name=nil, computer_network_name=nil, customer_id=nil, department_name=nil, display_name=nil, email_addresses=nil, events=nil, file_as=nil, file_as_mapping=nil, free_busy_location=nil, gender=nil, given_name=nil, government_id_number=nil, hobbies=nil, initials=nil, instant_messengers=nil, job_title=nil, language=nil, location=nil, middle_name=nil, nickname=nil, notes=nil, notes_format=nil, office_location=nil, organizational_id_number=nil, phone_numbers=nil, photo=nil, physical_addresses=nil, preferred_text_encoding=nil, prefix=nil, profession=nil, suffix=nil, surname=nil, urls=nil)
+    def initialize(
+      associated_persons: nil,
+      attachments: nil,
+      company_name: nil,
+      computer_network_name: nil,
+      customer_id: nil,
+      department_name: nil,
+      display_name: nil,
+      email_addresses: nil,
+      events: nil,
+      file_as: nil,
+      file_as_mapping: nil,
+      free_busy_location: nil,
+      gender: nil,
+      given_name: nil,
+      government_id_number: nil,
+      hobbies: nil,
+      initials: nil,
+      instant_messengers: nil,
+      job_title: nil,
+      language: nil,
+      location: nil,
+      middle_name: nil,
+      nickname: nil,
+      notes: nil,
+      notes_format: nil,
+      office_location: nil,
+      organizational_id_number: nil,
+      phone_numbers: nil,
+      photo: nil,
+      physical_addresses: nil,
+      preferred_text_encoding: nil,
+      prefix: nil,
+      profession: nil,
+      suffix: nil,
+      surname: nil,
+      urls: nil)
       self.associated_persons = associated_persons if associated_persons
       self.attachments = attachments if attachments
       self.company_name = company_name if company_name