aspose_email_cloud 20.5.0 → 21.4.0

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

@@ -23,7 +23,6 @@
 #  </summary>
 #  ----------------------------------------------------------------------------
 
-
 require 'date'
 
 module AsposeEmailCloud
@@ -32,11 +31,9 @@ module AsposeEmailCloud
     # Property name             
     # @return [String]
     attr_accessor :name
-
     # Property value             
     # @return [String]
     attr_accessor :value
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -53,27 +50,12 @@ 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?(:'name')
-        self.name = attributes[:'name']
-      end
-
-      if attributes.has_key?(:'value')
-        self.value = attributes[:'value']
-      end
-    end
-
     # Initializes the object
     # @param [String] name Property name             
     # @param [String] value Property value             
-    def initialize(name=nil, value=nil)
+    def initialize(
+      name: nil,
+      value: nil)
       self.name = name if name
       self.value = value if value
     end

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

@@ -23,19 +23,17 @@
 #  </summary>
 #  ----------------------------------------------------------------------------
 
-
 require 'date'
 
 module AsposeEmailCloud
+  # Object exists
   class ObjectExist
-    
+    # Indicates that the file or folder exists.
     # @return [BOOLEAN]
     attr_accessor :exists
-
-    
+    # True if it is a folder, false if it is a file.
     # @return [BOOLEAN]
     attr_accessor :is_folder
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -53,26 +51,11 @@ 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?(:'exists')
-        self.exists = attributes[:'exists']
-      end
-
-      if attributes.has_key?(:'isFolder')
-        self.is_folder = attributes[:'isFolder']
-      end
-    end
-
-    # Initializes the object
-    # @param [BOOLEAN] exists 
-    # @param [BOOLEAN] is_folder 
-    def initialize(exists=nil, is_folder=nil)
+    # @param [BOOLEAN] exists Indicates that the file or folder exists.
+    # @param [BOOLEAN] is_folder True if it is a folder, false if it is a file.
+    def initialize(
+      exists: nil,
+      is_folder: nil)
       self.exists = exists if exists
       self.is_folder = is_folder if is_folder
     end

data/lib/aspose-email-cloud/models/{requests/object_exists_request_data.rb → object_exists_request.rb}

@@ -1,6 +1,5 @@
-
 #  ----------------------------------------------------------------------------
-#  <copyright company="Aspose" file="object_exists_request_data.rb">
+#  <copyright company="Aspose" file="object_exists_request.rb">
 #    Copyright (c) 2018-2020 Aspose Pty Ltd. All rights reserved.
 #  </copyright>
 #  <summary>
@@ -24,28 +23,27 @@
 #  </summary>
 #  ----------------------------------------------------------------------------
 
-
 require_relative './email_request'
 require_relative './http_request'
 
 module AsposeEmailCloud
   # Request model for object_exists operation.
-  class ObjectExistsRequestData < EmailRequest
-
-    # 
+  class ObjectExistsRequest < EmailRequest
+    # File or folder path e.g. &#39;/file.ext&#39; or &#39;/folder&#39;
     # @return [String]
     attr_accessor :path
-    # 
+    # Storage name
     # @return [String]
     attr_accessor :storage_name
-    # 
+    # File version ID
     # @return [String]
     attr_accessor :version_id
 
-    # @param [String] path 
-    # @param [String] storage_name 
-    # @param [String] version_id 
-    def initialize(path, storage_name = nil, version_id = nil)
+    # Check if file or folder exists
+    # @param [String] path File or folder path e.g. &#39;/file.ext&#39; or &#39;/folder&#39;
+    # @param [String] storage_name Storage name
+    # @param [String] version_id File version ID
+    def initialize(path:, storage_name: nil, version_id: nil)
       self.path = path if path
       self.storage_name = storage_name if storage_name
       self.version_id = version_id if version_id
@@ -54,9 +52,8 @@ module AsposeEmailCloud
     def to_http_info(api_client)
       # verify the required parameter 'path' is set
       if api_client.config.client_side_validation && self.path.nil?
-        raise ArgumentError, "Missing the required parameter 'path' when calling EmailApi.object_exists"
+        raise ArgumentError, "Missing the required parameter 'path' when calling StorageApi.object_exists"
       end
-
       # resource path
       local_var_path = '/email/storage/exist/{path}'.sub('{' + 'path' + '}', self.path.to_s)
 
@@ -69,22 +66,20 @@ module AsposeEmailCloud
       form_params = {}
 
       # 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(['application/json'])
 
-      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/phone_number.rb

@@ -23,7 +23,6 @@
 #  </summary>
 #  ----------------------------------------------------------------------------
 
-
 require 'date'
 
 module AsposeEmailCloud
@@ -32,15 +31,12 @@ module AsposeEmailCloud
     # Phone number category.             
     # @return [EnumWithCustomOfPhoneNumberCategory]
     attr_accessor :category
-
     # Phone number.             
     # @return [String]
     attr_accessor :number
-
     # Defines whether phone number is preferred.             
     # @return [BOOLEAN]
     attr_accessor :preferred
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -59,32 +55,14 @@ 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?(:'category')
-        self.category = attributes[:'category']
-      end
-
-      if attributes.has_key?(:'number')
-        self.number = attributes[:'number']
-      end
-
-      if attributes.has_key?(:'preferred')
-        self.preferred = attributes[:'preferred']
-      end
-    end
-
     # Initializes the object
     # @param [EnumWithCustomOfPhoneNumberCategory] category Phone number category.             
     # @param [String] number Phone number.             
     # @param [BOOLEAN] preferred Defines whether phone number is preferred.             
-    def initialize(category=nil, number=nil, preferred=nil)
+    def initialize(
+      category: nil,
+      number: nil,
+      preferred: nil)
       self.category = category if category
       self.number = number if number
       self.preferred = preferred if preferred

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

@@ -23,7 +23,6 @@
 #  </summary>
 #  ----------------------------------------------------------------------------
 
-
 require 'date'
 
 module AsposeEmailCloud
@@ -32,47 +31,36 @@ module AsposeEmailCloud
     # Address.             
     # @return [String]
     attr_accessor :address
-
     # Address category.             
     # @return [EnumWithCustomOfPostalAddressCategory]
     attr_accessor :category
-
     # Address's city.             
     # @return [String]
     attr_accessor :city
-
     # Address's country.             
     # @return [String]
     attr_accessor :country
-
     # Country code.             
     # @return [String]
     attr_accessor :country_code
-
     # Defines whether address may be used for mailing.             
     # @return [BOOLEAN]
     attr_accessor :is_mailing_address
-
     # Postal code.             
     # @return [String]
     attr_accessor :postal_code
-
     # Post Office box.             
     # @return [String]
     attr_accessor :post_office_box
-
     # Defines whether postal address is preferred.             
     # @return [BOOLEAN]
     attr_accessor :preferred
-
     # Address's region.             
     # @return [String]
     attr_accessor :state_or_province
-
     # Address's street.             
     # @return [String]
     attr_accessor :street
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -107,59 +95,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?(:'address')
-        self.address = attributes[:'address']
-      end
-
-      if attributes.has_key?(:'category')
-        self.category = attributes[:'category']
-      end
-
-      if attributes.has_key?(:'city')
-        self.city = attributes[:'city']
-      end
-
-      if attributes.has_key?(:'country')
-        self.country = attributes[:'country']
-      end
-
-      if attributes.has_key?(:'countryCode')
-        self.country_code = attributes[:'countryCode']
-      end
-
-      if attributes.has_key?(:'isMailingAddress')
-        self.is_mailing_address = attributes[:'isMailingAddress']
-      end
-
-      if attributes.has_key?(:'postalCode')
-        self.postal_code = attributes[:'postalCode']
-      end
-
-      if attributes.has_key?(:'postOfficeBox')
-        self.post_office_box = attributes[:'postOfficeBox']
-      end
-
-      if attributes.has_key?(:'preferred')
-        self.preferred = attributes[:'preferred']
-      end
-
-      if attributes.has_key?(:'stateOrProvince')
-        self.state_or_province = attributes[:'stateOrProvince']
-      end
-
-      if attributes.has_key?(:'street')
-        self.street = attributes[:'street']
-      end
-    end
-
     # Initializes the object
     # @param [String] address Address.             
     # @param [EnumWithCustomOfPostalAddressCategory] category Address category.             
@@ -172,7 +107,18 @@ module AsposeEmailCloud
     # @param [BOOLEAN] preferred Defines whether postal address is preferred.             
     # @param [String] state_or_province Address's region.             
     # @param [String] street Address's street.             
-    def initialize(address=nil, category=nil, city=nil, country=nil, country_code=nil, is_mailing_address=nil, postal_code=nil, post_office_box=nil, preferred=nil, state_or_province=nil, street=nil)
+    def initialize(
+      address: nil,
+      category: nil,
+      city: nil,
+      country: nil,
+      country_code: nil,
+      is_mailing_address: nil,
+      postal_code: nil,
+      post_office_box: nil,
+      preferred: nil,
+      state_or_province: nil,
+      street: nil)
       self.address = address if address
       self.category = category if category
       self.city = city if city

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

@@ -0,0 +1,261 @@
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="RecurrencePatternDto.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
+  # iCalendar recurrence pattern.             
+  class RecurrencePatternDto
+    # Number of recurrence units.             
+    # @return [Integer]
+    attr_accessor :interval
+    # Number of occurrences of the recurrence pattern.             
+    # @return [Integer]
+    attr_accessor :occurs
+    # End date.             
+    # @return [DateTime]
+    attr_accessor :end_date
+    # Represents the day of the week. Enum, available values: None, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday, Day, WeekDay, WeekendDay
+    # @return [String]
+    attr_accessor :week_start
+    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
+      {
+        :'interval' => :'interval',
+        :'occurs' => :'occurs',
+        :'end_date' => :'endDate',
+        :'week_start' => :'weekStart',
+        :'discriminator' => :'discriminator'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'interval' => :'Integer',
+        :'occurs' => :'Integer',
+        :'end_date' => :'DateTime',
+        :'week_start' => :'String',
+        :'discriminator' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Integer] interval Number of recurrence units.             
+    # @param [Integer] occurs Number of occurrences of the recurrence pattern.             
+    # @param [DateTime] end_date End date.             
+    # @param [String] week_start Represents the day of the week. Enum, available values: None, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday, Day, WeekDay, WeekendDay
+    def initialize(
+      interval: nil,
+      occurs: nil,
+      end_date: nil,
+      week_start: nil)
+      self.interval = interval if interval
+      self.occurs = occurs if occurs
+      self.end_date = end_date if end_date
+      self.week_start = week_start if week_start
+    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 @interval.nil?
+        invalid_properties.push('invalid value for "interval", interval cannot be nil.')
+      end
+
+      if @occurs.nil?
+        invalid_properties.push('invalid value for "occurs", occurs cannot be nil.')
+      end
+
+      if @end_date.nil?
+        invalid_properties.push('invalid value for "end_date", end_date cannot be nil.')
+      end
+
+      if @week_start.nil?
+        invalid_properties.push('invalid value for "week_start", week_start 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 @interval.nil?
+      return false if @occurs.nil?
+      return false if @end_date.nil?
+      return false if @week_start.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 &&
+          interval == o.interval &&
+          occurs == o.occurs &&
+          end_date == o.end_date &&
+          week_start == o.week_start &&
+          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
+      [interval, occurs, end_date, week_start, 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