aspose_email_cloud 18.7.0 → 19.11.0

data/lib/aspose-email-cloud/models/requests/delete_file_request_data.rb

@@ -0,0 +1,81 @@
+
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="delete_file_request_data.rb">
+#    Copyright (c) 2018-2019 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 delete_file operation.
+  class DeleteFileRequestData < EmailRequest
+
+    # Delete file
+    # @param [String] path File path e.g. &#39;/folder/file.ext&#39;
+    # @param [String] storage_name Storage name
+    # @param [String] version_id File version ID to delete
+    def initialize(path, storage_name = nil, version_id = nil)
+      @path = path
+      @storage_name = storage_name
+      @version_id = version_id
+    end
+
+    def to_http_info(api_client)
+      # verify the required parameter 'path' is set
+      if api_client.config.client_side_validation && @path.nil?
+        raise ArgumentError, "Missing the required parameter 'path' when calling EmailApi.delete_file"
+      end
+
+      # resource path
+      local_var_path = '/email/storage/file/{path}'.sub('{' + 'path' + '}', @path.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:storageName] = @storage_name unless @storage_name.nil?
+      query_params[:versionId] = @version_id unless @version_id.nil?
+
+      # form parameters
+      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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = form_params.any? ? 'multipart/form-data' : select_header_content_type(['application/json'])
+
+      AsposeEmailCloud::HttpRequest.new(local_var_path,
+                                      header_params,
+                                      query_params,
+                                      form_params,
+                                      post_body,
+                                      auth_names)
+    end
+  end
+end

data/lib/aspose-email-cloud/models/requests/delete_folder_request_data.rb

@@ -0,0 +1,81 @@
+
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="delete_folder_request_data.rb">
+#    Copyright (c) 2018-2019 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 delete_folder operation.
+  class DeleteFolderRequestData < EmailRequest
+
+    # Delete folder
+    # @param [String] path Folder path e.g. &#39;/folder&#39;
+    # @param [String] storage_name Storage name
+    # @param [BOOLEAN] recursive Enable to delete folders, subfolders and files
+    def initialize(path, storage_name = nil, recursive = nil)
+      @path = path
+      @storage_name = storage_name
+      @recursive = recursive
+    end
+
+    def to_http_info(api_client)
+      # verify the required parameter 'path' is set
+      if api_client.config.client_side_validation && @path.nil?
+        raise ArgumentError, "Missing the required parameter 'path' when calling EmailApi.delete_folder"
+      end
+
+      # resource path
+      local_var_path = '/email/storage/folder/{path}'.sub('{' + 'path' + '}', @path.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:storageName] = @storage_name unless @storage_name.nil?
+      query_params[:recursive] = @recursive unless @recursive.nil?
+
+      # form parameters
+      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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = form_params.any? ? 'multipart/form-data' : select_header_content_type(['application/json'])
+
+      AsposeEmailCloud::HttpRequest.new(local_var_path,
+                                      header_params,
+                                      query_params,
+                                      form_params,
+                                      post_body,
+                                      auth_names)
+    end
+  end
+end

data/lib/aspose-email-cloud/models/requests/delete_mapi_attachment_request_data.rb

@@ -0,0 +1,89 @@
+
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="delete_mapi_attachment_request_data.rb">
+#    Copyright (c) 2018-2019 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 delete_mapi_attachment operation.
+  class DeleteMapiAttachmentRequestData < EmailRequest
+
+    # Remove attachment from document
+    # @param [String] name Document file name
+    # @param [String] attachment Attachment name or index
+    # @param [StorageFolderLocation] storage Document file storage location info
+    def initialize(name, attachment, storage)
+      @name = name
+      @attachment = attachment
+      @storage = storage
+    end
+
+    def to_http_info(api_client)
+      # verify the required parameter 'name' is set
+      if api_client.config.client_side_validation && @name.nil?
+        raise ArgumentError, "Missing the required parameter 'name' when calling EmailApi.delete_mapi_attachment"
+      end
+
+      # verify the required parameter 'attachment' is set
+      if api_client.config.client_side_validation && @attachment.nil?
+        raise ArgumentError, "Missing the required parameter 'attachment' when calling EmailApi.delete_mapi_attachment"
+      end
+
+      # verify the required parameter 'storage' is set
+      if api_client.config.client_side_validation && @storage.nil?
+        raise ArgumentError, "Missing the required parameter 'storage' when calling EmailApi.delete_mapi_attachment"
+      end
+
+      # resource path
+      local_var_path = '/email/Mapi/{name}/attachments/{attachment}'.sub('{' + 'name' + '}', @name.to_s).sub('{' + 'attachment' + '}', @attachment.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = api_client.object_to_http_body(@storage)
+      auth_names = ['JWT']
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = 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'])
+
+      AsposeEmailCloud::HttpRequest.new(local_var_path,
+                                      header_params,
+                                      query_params,
+                                      form_params,
+                                      post_body,
+                                      auth_names)
+    end
+  end
+end

data/lib/aspose-email-cloud/models/requests/delete_mapi_properties_request_data.rb

@@ -0,0 +1,82 @@
+
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="delete_mapi_properties_request_data.rb">
+#    Copyright (c) 2018-2019 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 delete_mapi_properties operation.
+  class DeleteMapiPropertiesRequestData < EmailRequest
+
+    # Delete document properties
+    # @param [String] name Document file name
+    # @param [HierarchicalObjectRequest] request Properties that should be deleted
+    def initialize(name, request)
+      @name = name
+      @request = request
+    end
+
+    def to_http_info(api_client)
+      # verify the required parameter 'name' is set
+      if api_client.config.client_side_validation && @name.nil?
+        raise ArgumentError, "Missing the required parameter 'name' when calling EmailApi.delete_mapi_properties"
+      end
+
+      # verify the required parameter 'request' is set
+      if api_client.config.client_side_validation && @request.nil?
+        raise ArgumentError, "Missing the required parameter 'request' when calling EmailApi.delete_mapi_properties"
+      end
+
+      # resource path
+      local_var_path = '/email/Mapi/{name}/properties'.sub('{' + 'name' + '}', @name.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = api_client.object_to_http_body(@request)
+      auth_names = ['JWT']
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = 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'])
+
+      AsposeEmailCloud::HttpRequest.new(local_var_path,
+                                      header_params,
+                                      query_params,
+                                      form_params,
+                                      post_body,
+                                      auth_names)
+    end
+  end
+end

data/lib/aspose-email-cloud/models/requests/download_file_request_data.rb

@@ -0,0 +1,81 @@
+
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="download_file_request_data.rb">
+#    Copyright (c) 2018-2019 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 download_file operation.
+  class DownloadFileRequestData < EmailRequest
+
+    # Download file
+    # @param [String] path File path e.g. &#39;/folder/file.ext&#39;
+    # @param [String] storage_name Storage name
+    # @param [String] version_id File version ID to download
+    def initialize(path, storage_name = nil, version_id = nil)
+      @path = path
+      @storage_name = storage_name
+      @version_id = version_id
+    end
+
+    def to_http_info(api_client)
+      # verify the required parameter 'path' is set
+      if api_client.config.client_side_validation && @path.nil?
+        raise ArgumentError, "Missing the required parameter 'path' when calling EmailApi.download_file"
+      end
+
+      # resource path
+      local_var_path = '/email/storage/file/{path}'.sub('{' + 'path' + '}', @path.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:storageName] = @storage_name unless @storage_name.nil?
+      query_params[:versionId] = @version_id unless @version_id.nil?
+
+      # form parameters
+      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(['multipart/form-data'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = form_params.any? ? 'multipart/form-data' : select_header_content_type(['application/json'])
+
+      AsposeEmailCloud::HttpRequest.new(local_var_path,
+                                      header_params,
+                                      query_params,
+                                      form_params,
+                                      post_body,
+                                      auth_names)
+    end
+  end
+end

data/lib/aspose-email-cloud/models/requests/email_request.rb

@@ -0,0 +1,75 @@
+
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="email_request.rb">
+#    Copyright (c) 2018-2019 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>
+#  ----------------------------------------------------------------------------
+
+
+module AsposeEmailCloud
+
+  # Base class for requests with basic operations
+  class EmailRequest
+    def to_http_info(config); end
+
+    protected
+
+    # Return Accept header based on an array of accepts provided.
+    # @param [Array] accepts array for Accept
+    # @return [String] the Accept header (e.g. application/json)
+    def select_header_accept(accepts)
+      return nil if accepts.nil? || accepts.empty?
+
+      # use JSON when present, otherwise use all of the provided
+      json_accept = accepts.find { |s| json_mime?(s) }
+      json_accept || accepts.join(',')
+    end
+
+    # Return Content-Type header based on an array of content types provided.
+    # @param [Array] content_types array for Content-Type
+    # @return [String] the Content-Type header  (e.g. application/json)
+    def select_header_content_type(content_types)
+      # use application/json by default
+      return 'application/json' if content_types.nil? || content_types.empty?
+
+      # use JSON when present, otherwise use the first one
+      json_content_type = content_types.find { |s| json_mime?(s) }
+      json_content_type || content_types.first
+    end
+
+    private
+
+    # Check if the given MIME is a JSON MIME.
+    # JSON MIME examples:
+    #   application/json
+    #   application/json; charset=UTF8
+    #   APPLICATION/JSON
+    #   */*
+    # @param [String] mime MIME
+    # @return [Boolean] True if the MIME is application/json
+    def json_mime?(mime)
+      (mime == '*/*') || !(mime =~ %r{Application/.*json(?!p)(;.*)?}i).nil?
+    end
+  end
+end
+
+