aspose_email_cloud 20.3.0 → 20.12.0

data/lib/aspose-email-cloud/models/{hierarchical_object_response.rb → client_thread_base_request.rb}

@@ -1,6 +1,6 @@
 #  ----------------------------------------------------------------------------
-#  <copyright company="Aspose" file="HierarchicalObjectResponse.rb">
-#    Copyright (c) 2018-2019 Aspose Pty Ltd. All rights reserved.
+#  <copyright company="Aspose" file="ClientThreadBaseRequest.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,81 +23,92 @@
 #  </summary>
 #  ----------------------------------------------------------------------------
 
-
 require 'date'
 
 module AsposeEmailCloud
-  # Document represented as hierarchical set of properties response             
-  class HierarchicalObjectResponse
-    # Document properties             
-    # @return [HierarchicalObject]
-    attr_accessor :hierarchical_object
-
-    # Document location in storage             
+  # Email client thread request.             
+  class ClientThreadBaseRequest < ClientAccountBaseRequest
+    # Email client account configuration location on storage.             
     # @return [StorageFileLocation]
-    attr_accessor :storage_file
-
+    attr_accessor :account_location
+    # Thread identifier.             
+    # @return [String]
+    attr_accessor :thread_id
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'hierarchical_object' => :'hierarchicalObject',
-        :'storage_file' => :'storageFile'
+        :'account_location' => :'accountLocation',
+        :'thread_id' => :'threadId'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'hierarchical_object' => :'HierarchicalObject',
-        :'storage_file' => :'StorageFileLocation'
+        :'account_location' => :'StorageFileLocation',
+        :'thread_id' => :'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?(:'hierarchicalObject')
-        self.hierarchical_object = attributes[:'hierarchicalObject']
-      end
-
-      if attributes.has_key?(:'storageFile')
-        self.storage_file = attributes[:'storageFile']
-      end
-    end
-
-    # Initializes the object
-    # @param [HierarchicalObject] hierarchical_object Document properties             
-    # @param [StorageFileLocation] storage_file Document location in storage             
-    def initialize(hierarchical_object=nil, storage_file=nil)
-      self.hierarchical_object = hierarchical_object if hierarchical_object
-      self.storage_file = storage_file if storage_file
+    # @param [StorageFileLocation] account_location Email client account configuration location on storage.             
+    # @param [String] thread_id Thread identifier.             
+    def initialize(
+      account_location: nil,
+      thread_id: nil)
+      self.account_location = account_location if account_location
+      self.thread_id = thread_id if thread_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 @thread_id.nil?
+        invalid_properties.push('invalid value for "thread_id", thread_id cannot be nil.')
+      end
+
+      if @thread_id.to_s.length < 1
+        invalid_properties.push('invalid value for "thread_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 @thread_id.nil?
+      return false if @thread_id.to_s.length < 1
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] thread_id Value to be assigned
+    def thread_id=(thread_id)
+      if thread_id.nil?
+        fail ArgumentError, 'thread_id cannot be nil'
+      end
+
+      if thread_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "thread_id", the character length must be great than or equal to 1.'
+      end
+
+      @thread_id = thread_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 &&
-          hierarchical_object == o.hierarchical_object &&
-          storage_file == o.storage_file
+          account_location == o.account_location &&
+          thread_id == o.thread_id
     end
 
     # @see the `==` method
@@ -109,7 +120,7 @@ module AsposeEmailCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [hierarchical_object, storage_file].hash
+      [account_location, thread_id].hash
     end
 
     # Builds the object from hash

data/lib/aspose-email-cloud/models/{ai_bcr_ocr_data.rb → client_thread_delete_request.rb}

@@ -1,6 +1,6 @@
 #  ----------------------------------------------------------------------------
-#  <copyright company="Aspose" file="AiBcrOcrData.rb">
-#    Copyright (c) 2018-2019 Aspose Pty Ltd. All rights reserved.
+#  <copyright company="Aspose" file="ClientThreadDeleteRequest.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,111 +23,101 @@
 #  </summary>
 #  ----------------------------------------------------------------------------
 
-
 require 'date'
 
 module AsposeEmailCloud
-  # Image OCR results             
-  class AiBcrOcrData
-    # Image identifier             
+  # Delete email client thread request.             
+  class ClientThreadDeleteRequest < ClientThreadBaseRequest
+    # Email client account configuration location on storage.             
+    # @return [StorageFileLocation]
+    attr_accessor :account_location
+    # Thread identifier.             
     # @return [String]
-    attr_accessor :id
-
-    # Image with possible pre-processing in Base64             
+    attr_accessor :thread_id
+    # Folder on email server, where thread is stored.             
     # @return [String]
-    attr_accessor :image
-
-    # Additional details from OCR engine             
-    # @return [Hash<String, String>]
-    attr_accessor :details
-
-    # OCR results             
-    # @return [Array<AiBcrOcrDataPart>]
-    attr_accessor :data
-
+    attr_accessor :folder
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id' => :'id',
-        :'image' => :'image',
-        :'details' => :'details',
-        :'data' => :'data'
+        :'account_location' => :'accountLocation',
+        :'thread_id' => :'threadId',
+        :'folder' => :'folder'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'id' => :'String',
-        :'image' => :'String',
-        :'details' => :'Hash<String, String>',
-        :'data' => :'Array<AiBcrOcrDataPart>'
+        :'account_location' => :'StorageFileLocation',
+        :'thread_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?(:'id')
-        self.id = attributes[:'id']
-      end
+    # @param [StorageFileLocation] account_location Email client account configuration location on storage.             
+    # @param [String] thread_id Thread identifier.             
+    # @param [String] folder Folder on email server, where thread is stored.             
+    def initialize(
+      account_location: nil,
+      thread_id: nil,
+      folder: nil)
+      self.account_location = account_location if account_location
+      self.thread_id = thread_id if thread_id
+      self.folder = folder if folder
+    end
 
-      if attributes.has_key?(:'image')
-        self.image = attributes[:'image']
+    # 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 attributes.has_key?(:'details')
-        if (value = attributes[:'details']).is_a?(Hash)
-          self.details = value
-        end
+      if @thread_id.nil?
+        invalid_properties.push('invalid value for "thread_id", thread_id cannot be nil.')
       end
 
-      if attributes.has_key?(:'data')
-        if (value = attributes[:'data']).is_a?(Array)
-          self.data = value
-        end
+      if @thread_id.to_s.length < 1
+        invalid_properties.push('invalid value for "thread_id", the character length must be great than or equal to 1.')
       end
-    end
-
-    # Initializes the object
-    # @param [String] id Image identifier             
-    # @param [String] image Image with possible pre-processing in Base64             
-    # @param [Hash<String, String>] details Additional details from OCR engine             
-    # @param [Array<AiBcrOcrDataPart>] data OCR results             
-    def initialize(id=nil, image=nil, details=nil, data=nil)
-      self.id = id if id
-      self.image = image if image
-      self.details = details if details
-      self.data = data if data
-    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
       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 @thread_id.nil?
+      return false if @thread_id.to_s.length < 1
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] thread_id Value to be assigned
+    def thread_id=(thread_id)
+      if thread_id.nil?
+        fail ArgumentError, 'thread_id cannot be nil'
+      end
+
+      if thread_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "thread_id", the character length must be great than or equal to 1.'
+      end
+
+      @thread_id = thread_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 &&
-          id == o.id &&
-          image == o.image &&
-          details == o.details &&
-          data == o.data
+          account_location == o.account_location &&
+          thread_id == o.thread_id &&
+          folder == o.folder
     end
 
     # @see the `==` method
@@ -139,7 +129,7 @@ module AsposeEmailCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, image, details, data].hash
+      [account_location, thread_id, folder].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,108 @@
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="client_thread_get_list_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_thread_get_list operation.
+  class ClientThreadGetListRequest < EmailRequest
+    # A folder in email account.             
+    # @return [String]
+    attr_accessor :folder
+    # Email account
+    # @return [String]
+    attr_accessor :account
+    # 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
+    # This parameter is only used in accounts with CacheFile. If true - get new messages and update threads cache for given folder. If false, get only threads from cache without any calls to an email account             
+    # @return [BOOLEAN]
+    attr_accessor :update_folder_cache
+    # Limit messages cache size if CacheFile is used. Ignored in accounts without limits support             
+    # @return [Integer]
+    attr_accessor :messages_cache_limit
+
+    # Get message threads from folder. All messages are partly fetched (without email body and some other fields).             
+    # @param [String] folder A folder in email account.             
+    # @param [String] account Email account
+    # @param [String] storage Storage name where account file located
+    # @param [String] account_storage_folder Folder in storage where account file located
+    # @param [BOOLEAN] update_folder_cache This parameter is only used in accounts with CacheFile. If true - get new messages and update threads cache for given folder. If false, get only threads from cache without any calls to an email account             
+    # @param [Integer] messages_cache_limit Limit messages cache size if CacheFile is used. Ignored in accounts without limits support             
+    def initialize(folder:, account:, storage: nil, account_storage_folder: nil, update_folder_cache: nil, messages_cache_limit: nil)
+      self.folder = folder if folder
+      self.account = account if account
+      self.storage = storage if storage
+      self.account_storage_folder = account_storage_folder if account_storage_folder
+      self.update_folder_cache = update_folder_cache if update_folder_cache
+      self.messages_cache_limit = messages_cache_limit if messages_cache_limit
+    end
+
+    def to_http_info(api_client)
+      # verify the required parameter 'folder' is set
+      if api_client.config.client_side_validation && self.folder.nil?
+        raise ArgumentError, "Missing the required parameter 'folder' when calling ClientThreadApi.get_list"
+      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 ClientThreadApi.get_list"
+      end
+      # resource path
+      local_var_path = '/email/client/thread/list'
+
+      # query parameters
+      query_params = {}
+      query_params[:folder] = self.folder
+      query_params[:account] = self.account
+      query_params[:storage] = self.storage unless self.storage.nil?
+      query_params[:accountStorageFolder] = self.account_storage_folder unless self.account_storage_folder.nil?
+      query_params[:updateFolderCache] = self.update_folder_cache unless self.update_folder_cache.nil?
+      query_params[:messagesCacheLimit] = self.messages_cache_limit unless self.messages_cache_limit.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/client_thread_get_messages_request.rb

@@ -0,0 +1,105 @@
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="client_thread_get_messages_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_thread_get_messages operation.
+  class ClientThreadGetMessagesRequest < EmailRequest
+    # Thread identifier
+    # @return [String]
+    attr_accessor :thread_id
+    # Email account
+    # @return [String]
+    attr_accessor :account
+    # Specifies account folder to get thread from             
+    # @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
+
+    # Get messages from thread by id. All messages are fully fetched. For accounts with CacheFile only cached messages will be returned.             
+    # @param [String] thread_id Thread identifier
+    # @param [String] account Email account
+    # @param [String] folder Specifies account folder to get thread from             
+    # @param [String] storage Storage name where account file located
+    # @param [String] account_storage_folder Folder in storage where account file located
+    def initialize(thread_id:, account:, folder: nil, storage: nil, account_storage_folder: nil)
+      self.thread_id = thread_id if thread_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
+    end
+
+    def to_http_info(api_client)
+      # verify the required parameter 'thread_id' is set
+      if api_client.config.client_side_validation && self.thread_id.nil?
+        raise ArgumentError, "Missing the required parameter 'thread_id' when calling ClientThreadApi.get_messages"
+      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 ClientThreadApi.get_messages"
+      end
+      # resource path
+      local_var_path = '/email/client/thread/messages'
+
+      # query parameters
+      query_params = {}
+      query_params[:threadId] = self.thread_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?
+
+      # 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
+
+
+