aspose_email_cloud 20.7.0 → 20.9.0

data/lib/aspose-email-cloud/api/email_cloud.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="email_api.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>
+#  ----------------------------------------------------------------------------
+
+module AsposeEmailCloud
+  # Aspose.Email Cloud API.
+  class EmailCloud
+    attr_reader :api_invoker
+
+    
+    # iCalendar document operations.
+    attr_reader :calendar
+    
+    # Contact document operations. Supported formats: VCard, MSG, WebDav
+    attr_reader :contact
+    
+    # Email document (*.eml) operations.
+    attr_reader :email
+    
+    # Check email address is disposable operations
+    attr_reader :disposable_email
+    
+    # Email server configuration discovery.
+    attr_reader :email_config
+    
+
+    
+    # MAPI operations.
+    attr_reader :mapi
+    
+    # Builtin Email client operations.
+    attr_reader :client
+    
+    # AI powered operations.
+    attr_reader :ai
+    
+    # Cloud file storage operations.
+    attr_reader :cloud_storage
+    
+
+    # Initializes a new instance of the EmailApi class.
+    # @param [String] app_key Key to access the server.
+    # @param [String] app_sid ID to access the server.
+    # @param [String] base_url Server URL.
+    # @param [String] api_version Api version.
+    # @param [Object] debug Debug switch [true, false].
+    def initialize(app_key = nil, app_sid = nil, base_url = 'api.aspose.cloud', api_version = 'v4.0', debug = false)
+      api_client = ApiClient.new(app_key, app_sid, base_url, api_version, debug)
+      @api_invoker = ApiInvoker.new(api_client)
+    
+      @calendar = CalendarApi.new(@api_invoker)
+    
+      @contact = ContactApi.new(@api_invoker)
+    
+      @email = EmailApi.new(@api_invoker)
+    
+      @disposable_email = DisposableEmailApi.new(@api_invoker)
+    
+      @email_config = EmailConfigApi.new(@api_invoker)
+    
+    
+      @mapi = MapiGroup.new(@api_invoker)
+    
+      @client = ClientGroup.new(@api_invoker)
+    
+      @ai = AiGroup.new(@api_invoker)
+    
+      @cloud_storage = CloudStorageGroup.new(@api_invoker)
+    
+    end
+
+  end
+end

data/lib/aspose-email-cloud/api/email_config_api.rb

@@ -0,0 +1,111 @@
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="email_api.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 'uri'
+
+module AsposeEmailCloud
+  # EmailConfigApi operations.
+  class EmailConfigApi
+    attr_reader :api_invoker
+
+    # Initializes a new instance of the EmailConfigApi class.
+    # @param [String] app_key Key to access the server.
+    # @param [String] app_sid ID to access the server.
+    # @param [String] base_url Server URL.
+    # @param [String] api_version Api version.
+    # @param [Object] debug Debug switch [true, false].
+    # def initialize(app_key = nil, app_sid = nil, base_url = 'api-qa.aspose.cloud', api_version = 'v4.0', debug = false)
+    #   @api_client = ApiClient.new(app_key, app_sid, base_url, api_version, debug)
+    # end
+
+    # Initializes a new instance of the EmailConfigApi class.
+    # @param [ApiInvoker] api_invoker
+    def initialize(api_invoker)
+      @api_invoker = api_invoker
+    end
+
+    # Discover email accounts by email address. Does not validate discovered accounts.             
+    # @param [EmailConfigDiscoverRequest] request Request object.
+    # @return [EmailAccountConfigList]
+    def discover(request)
+      http_request = request.to_http_info(@api_invoker.api_client)
+      @api_invoker.make_request(http_request, :GET, 'EmailAccountConfigList')
+    end
+
+    # Discover email accounts by email address. Validates discovered accounts using OAuth 2.0.             
+    # @param [EmailConfigDiscoverOauthRequest] request Discover email configuration request.
+    # @return [EmailAccountConfigList]
+    def discover_oauth(request)
+      # verify the required parameter 'request' is set
+      if @api_invoker.api_client.config.client_side_validation && request.nil?
+        raise ArgumentError, "Missing the required parameter 'request' when calling EmailConfigApi.discover_oauth"
+      end
+
+      local_var_path = '/email/config/discover/oauth'
+      post_body = @api_invoker.api_client.object_to_http_body(request)
+      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'] = EmailRequest.select_header_content_type(['application/json'])
+      http_request = AsposeEmailCloud::HttpRequest.new(resource_path: local_var_path,
+                                                       header_params: header_params,
+                                                       body: post_body,
+                                                       auth_names: auth_names)
+
+      @api_invoker.make_request(http_request, :PUT, 'EmailAccountConfigList')
+    end
+
+    # Discover email accounts by email address. Validates discovered accounts using login and password.             
+    # @param [EmailConfigDiscoverPasswordRequest] request Discover email configuration request.
+    # @return [EmailAccountConfigList]
+    def discover_password(request)
+      # verify the required parameter 'request' is set
+      if @api_invoker.api_client.config.client_side_validation && request.nil?
+        raise ArgumentError, "Missing the required parameter 'request' when calling EmailConfigApi.discover_password"
+      end
+
+      local_var_path = '/email/config/discover/password'
+      post_body = @api_invoker.api_client.object_to_http_body(request)
+      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'] = EmailRequest.select_header_content_type(['application/json'])
+      http_request = AsposeEmailCloud::HttpRequest.new(resource_path: local_var_path,
+                                                       header_params: header_params,
+                                                       body: post_body,
+                                                       auth_names: auth_names)
+
+      @api_invoker.make_request(http_request, :PUT, 'EmailAccountConfigList')
+    end
+  end
+end

data/lib/aspose-email-cloud/api/file_api.rb

@@ -0,0 +1,92 @@
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="email_api.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 'uri'
+
+module AsposeEmailCloud
+  # FileApi operations.
+  class FileApi
+    attr_reader :api_invoker
+
+    # Initializes a new instance of the FileApi class.
+    # @param [String] app_key Key to access the server.
+    # @param [String] app_sid ID to access the server.
+    # @param [String] base_url Server URL.
+    # @param [String] api_version Api version.
+    # @param [Object] debug Debug switch [true, false].
+    # def initialize(app_key = nil, app_sid = nil, base_url = 'api-qa.aspose.cloud', api_version = 'v4.0', debug = false)
+    #   @api_client = ApiClient.new(app_key, app_sid, base_url, api_version, debug)
+    # end
+
+    # Initializes a new instance of the FileApi class.
+    # @param [ApiInvoker] api_invoker
+    def initialize(api_invoker)
+      @api_invoker = api_invoker
+    end
+
+    # Copy file
+    # @param [CopyFileRequest] request Request object.
+    # @return [nil]
+    def copy_file(request)
+      http_request = request.to_http_info(@api_invoker.api_client)
+      @api_invoker.make_request(http_request, :PUT, nil)
+      nil
+    end
+
+    # Delete file
+    # @param [DeleteFileRequest] request Request object.
+    # @return [nil]
+    def delete_file(request)
+      http_request = request.to_http_info(@api_invoker.api_client)
+      @api_invoker.make_request(http_request, :DELETE, nil)
+      nil
+    end
+
+    # Download file
+    # @param [DownloadFileRequest] request Request object.
+    # @return [File]
+    def download_file(request)
+      http_request = request.to_http_info(@api_invoker.api_client)
+      @api_invoker.make_request(http_request, :GET, 'File')
+    end
+
+    # Move file
+    # @param [MoveFileRequest] request Request object.
+    # @return [nil]
+    def move_file(request)
+      http_request = request.to_http_info(@api_invoker.api_client)
+      @api_invoker.make_request(http_request, :PUT, nil)
+      nil
+    end
+
+    # Upload file
+    # @param [UploadFileRequest] request Request object.
+    # @return [FilesUploadResult]
+    def upload_file(request)
+      http_request = request.to_http_info(@api_invoker.api_client)
+      @api_invoker.make_request(http_request, :PUT, 'FilesUploadResult')
+    end
+  end
+end

data/lib/aspose-email-cloud/api/folder_api.rb

@@ -0,0 +1,93 @@
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="email_api.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 'uri'
+
+module AsposeEmailCloud
+  # FolderApi operations.
+  class FolderApi
+    attr_reader :api_invoker
+
+    # Initializes a new instance of the FolderApi class.
+    # @param [String] app_key Key to access the server.
+    # @param [String] app_sid ID to access the server.
+    # @param [String] base_url Server URL.
+    # @param [String] api_version Api version.
+    # @param [Object] debug Debug switch [true, false].
+    # def initialize(app_key = nil, app_sid = nil, base_url = 'api-qa.aspose.cloud', api_version = 'v4.0', debug = false)
+    #   @api_client = ApiClient.new(app_key, app_sid, base_url, api_version, debug)
+    # end
+
+    # Initializes a new instance of the FolderApi class.
+    # @param [ApiInvoker] api_invoker
+    def initialize(api_invoker)
+      @api_invoker = api_invoker
+    end
+
+    # Copy folder
+    # @param [CopyFolderRequest] request Request object.
+    # @return [nil]
+    def copy_folder(request)
+      http_request = request.to_http_info(@api_invoker.api_client)
+      @api_invoker.make_request(http_request, :PUT, nil)
+      nil
+    end
+
+    # Create the folder
+    # @param [CreateFolderRequest] request Request object.
+    # @return [nil]
+    def create_folder(request)
+      http_request = request.to_http_info(@api_invoker.api_client)
+      @api_invoker.make_request(http_request, :PUT, nil)
+      nil
+    end
+
+    # Delete folder
+    # @param [DeleteFolderRequest] request Request object.
+    # @return [nil]
+    def delete_folder(request)
+      http_request = request.to_http_info(@api_invoker.api_client)
+      @api_invoker.make_request(http_request, :DELETE, nil)
+      nil
+    end
+
+    # Get all files and folders within a folder
+    # @param [GetFilesListRequest] request Request object.
+    # @return [FilesList]
+    def get_files_list(request)
+      http_request = request.to_http_info(@api_invoker.api_client)
+      @api_invoker.make_request(http_request, :GET, 'FilesList')
+    end
+
+    # Move folder
+    # @param [MoveFolderRequest] request Request object.
+    # @return [nil]
+    def move_folder(request)
+      http_request = request.to_http_info(@api_invoker.api_client)
+      @api_invoker.make_request(http_request, :PUT, nil)
+      nil
+    end
+  end
+end

data/lib/aspose-email-cloud/api/mapi_calendar_api.rb

@@ -0,0 +1,147 @@
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="email_api.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 'uri'
+
+module AsposeEmailCloud
+  # MapiCalendarApi operations.
+  class MapiCalendarApi
+    attr_reader :api_invoker
+
+    # Initializes a new instance of the MapiCalendarApi class.
+    # @param [String] app_key Key to access the server.
+    # @param [String] app_sid ID to access the server.
+    # @param [String] base_url Server URL.
+    # @param [String] api_version Api version.
+    # @param [Object] debug Debug switch [true, false].
+    # def initialize(app_key = nil, app_sid = nil, base_url = 'api-qa.aspose.cloud', api_version = 'v4.0', debug = false)
+    #   @api_client = ApiClient.new(app_key, app_sid, base_url, api_version, debug)
+    # end
+
+    # Initializes a new instance of the MapiCalendarApi class.
+    # @param [ApiInvoker] api_invoker
+    def initialize(api_invoker)
+      @api_invoker = api_invoker
+    end
+
+    # Converts MAPI calendar model to CalendarDto model.             
+    # @param [MapiCalendarDto] mapi_calendar_dto MAPI calendar model to convert.
+    # @return [CalendarDto]
+    def as_calendar_dto(mapi_calendar_dto)
+      # verify the required parameter 'mapi_calendar_dto' is set
+      if @api_invoker.api_client.config.client_side_validation && mapi_calendar_dto.nil?
+        raise ArgumentError, "Missing the required parameter 'mapi_calendar_dto' when calling MapiCalendarApi.as_calendar_dto"
+      end
+
+      local_var_path = '/email/MapiCalendar/as-calendar-dto'
+      post_body = @api_invoker.api_client.object_to_http_body(mapi_calendar_dto)
+      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'] = EmailRequest.select_header_content_type(['application/json'])
+      http_request = AsposeEmailCloud::HttpRequest.new(resource_path: local_var_path,
+                                                       header_params: header_params,
+                                                       body: post_body,
+                                                       auth_names: auth_names)
+
+      @api_invoker.make_request(http_request, :PUT, 'CalendarDto')
+    end
+
+    # Converts MAPI calendar model to specified format and returns as file.             
+    # @param [MapiCalendarAsFileRequest] request MAPI calendar model to convert.
+    # @return [File]
+    def as_file(request)
+      # verify the required parameter 'request' is set
+      if @api_invoker.api_client.config.client_side_validation && request.nil?
+        raise ArgumentError, "Missing the required parameter 'request' when calling MapiCalendarApi.as_file"
+      end
+
+      local_var_path = '/email/MapiCalendar/as-file'
+      post_body = @api_invoker.api_client.object_to_http_body(request)
+      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'] = EmailRequest.select_header_content_type(['application/json'])
+      http_request = AsposeEmailCloud::HttpRequest.new(resource_path: local_var_path,
+                                                       header_params: header_params,
+                                                       body: post_body,
+                                                       auth_names: auth_names)
+
+      @api_invoker.make_request(http_request, :PUT, 'File')
+    end
+
+    # Converts calendar file to a MAPI model representation.             
+    # @param [MapiCalendarFromFileRequest] request Request object.
+    # @return [MapiCalendarDto]
+    def from_file(request)
+      http_request = request.to_http_info(@api_invoker.api_client)
+      @api_invoker.make_request(http_request, :PUT, 'MapiCalendarDto')
+    end
+
+    # Get MAPI calendar document.             
+    # @param [MapiCalendarGetRequest] request Request object.
+    # @return [MapiCalendarDto]
+    def get(request)
+      http_request = request.to_http_info(@api_invoker.api_client)
+      @api_invoker.make_request(http_request, :GET, 'MapiCalendarDto')
+    end
+
+    # Save MAPI Calendar to storage.             
+    # @param [MapiCalendarSaveRequest] request Calendar create/update request.
+    # @return [nil]
+    def save(request)
+      # verify the required parameter 'request' is set
+      if @api_invoker.api_client.config.client_side_validation && request.nil?
+        raise ArgumentError, "Missing the required parameter 'request' when calling MapiCalendarApi.save"
+      end
+
+      local_var_path = '/email/MapiCalendar'
+      post_body = @api_invoker.api_client.object_to_http_body(request)
+      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'] = EmailRequest.select_header_content_type(['application/json'])
+      http_request = AsposeEmailCloud::HttpRequest.new(resource_path: local_var_path,
+                                                       header_params: header_params,
+                                                       body: post_body,
+                                                       auth_names: auth_names)
+
+      @api_invoker.make_request(http_request, :PUT, nil)
+      nil
+    end
+  end
+end