aspose_email_cloud 19.11.0 → 19.12.0

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

@@ -0,0 +1,91 @@
+
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="ai_name_expand_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 ai_name_expand operation.
+  class AiNameExpandRequestData < EmailRequest
+
+    # Expands a person&#39;s name into a list of possible alternatives using options for expanding instructions             
+    # @param [String] name A name to format (required)
+    # @param [String] language An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \&quot;it\&quot; or \&quot;ita\&quot; for Italian)
+    # @param [String] location A geographic code such as an ISO-3166 two letter country code, for example \&quot;FR\&quot; for France
+    # @param [String] encoding A character encoding name
+    # @param [String] script A writing system code; starts with the ISO-15924 script name
+    # @param [String] style Name writing style. Enum, available values: Formal, Informal, Legal, Academic
+    def initialize(name, language = nil, location = nil, encoding = nil, script = nil, style = nil)
+      @name = name if name
+      @language = language if language
+      @location = location if location
+      @encoding = encoding if encoding
+      @script = script if script
+      @style = style if style
+    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.ai_name_expand"
+      end
+
+      # resource path
+      local_var_path = '/email/AiName/expand'
+
+      # query parameters
+      query_params = {}
+      query_params[:name] = @name
+      query_params[:language] = @language unless @language.nil?
+      query_params[:location] = @location unless @location.nil?
+      query_params[:encoding] = @encoding unless @encoding.nil?
+      query_params[:script] = @script unless @script.nil?
+      query_params[:style] = @style unless @style.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/ai_name_format_parsed_request_data.rb

@@ -0,0 +1,75 @@
+
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="ai_name_format_parsed_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 ai_name_format_parsed operation.
+  class AiNameFormatParsedRequestData < EmailRequest
+
+    # Formats a person&#39;s parsed name in correct case and name order using options for formatting instructions             
+    # @param [AiNameParsedRq] rq Parsed name with options
+    def initialize(rq)
+      @rq = rq if rq
+    end
+
+    def to_http_info(api_client)
+      # verify the required parameter 'rq' is set
+      if api_client.config.client_side_validation && @rq.nil?
+        raise ArgumentError, "Missing the required parameter 'rq' when calling EmailApi.ai_name_format_parsed"
+      end
+
+      # resource path
+      local_var_path = '/email/AiName/format-parsed'
+
+      # query parameters
+      query_params = {}
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = api_client.object_to_http_body(@rq)
+      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/ai_name_format_request_data.rb

@@ -0,0 +1,94 @@
+
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="ai_name_format_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 ai_name_format operation.
+  class AiNameFormatRequestData < EmailRequest
+
+    # Formats a person&#39;s name in correct case and name order using options for formatting instructions             
+    # @param [String] name A name to format (required)
+    # @param [String] language An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \&quot;it\&quot; or \&quot;ita\&quot; for Italian)
+    # @param [String] location A geographic code such as an ISO-3166 two letter country code, for example \&quot;FR\&quot; for France
+    # @param [String] encoding A character encoding name
+    # @param [String] script A writing system code; starts with the ISO-15924 script name
+    # @param [String] format Format of the name. Predefined format can be used by ID, or custom format can be specified. Predefined formats:      /format/default/ (&#x3D; &#39;%t%F%m%N%L%p&#39;)     /format/FN+LN/ (&#x3D; &#39;%F%L&#39;)     /format/title+FN+LN/ (&#x3D; &#39;%t%F%L&#39;)     /format/FN+MN+LN/ (&#x3D; &#39;%F%M%N%L&#39;)     /format/title+FN+MN+LN/ (&#x3D; &#39;%t%F%M%N%L&#39;)     /format/FN+MI+LN/ (&#x3D; &#39;%F%m%N%L&#39;)     /format/title+FN+MI+LN/ (&#x3D; &#39;%t%F%m%N%L&#39;)     /format/LN/ (&#x3D; &#39;%L&#39;)     /format/title+LN/ (&#x3D; &#39;%t%L&#39;)     /format/LN+FN+MN/ (&#x3D; &#39;%L,%F%M%N&#39;)     /format/LN+title+FN+MN/ (&#x3D; &#39;%L,%t%F%M%N&#39;)     /format/LN+FN+MI/ (&#x3D; &#39;%L,%F%m%N&#39;)     /format/LN+title+FN+MI/ (&#x3D; &#39;%L,%t%F%m%N&#39;)  Custom format string - custom combination of characters and the next term placeholders:      &#39;%t&#39; - Title (prefix)     &#39;%F&#39; - First name     &#39;%f&#39; - First initial     &#39;%M&#39; - Middle name(s)     &#39;%m&#39; - Middle initial(s)     &#39;%N&#39; - Nickname     &#39;%L&#39; - Last name     &#39;%l&#39; - Last initial     &#39;%p&#39; - Postfix  If no value for format option was provided, its default value is &#39;%t%F%m%N%L%p&#39;             
+    # @param [String] style Name writing style. Enum, available values: Formal, Informal, Legal, Academic
+    def initialize(name, language = nil, location = nil, encoding = nil, script = nil, format = nil, style = nil)
+      @name = name if name
+      @language = language if language
+      @location = location if location
+      @encoding = encoding if encoding
+      @script = script if script
+      @format = format if format
+      @style = style if style
+    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.ai_name_format"
+      end
+
+      # resource path
+      local_var_path = '/email/AiName/format'
+
+      # query parameters
+      query_params = {}
+      query_params[:name] = @name
+      query_params[:language] = @language unless @language.nil?
+      query_params[:location] = @location unless @location.nil?
+      query_params[:encoding] = @encoding unless @encoding.nil?
+      query_params[:script] = @script unless @script.nil?
+      query_params[:format] = @format unless @format.nil?
+      query_params[:style] = @style unless @style.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/ai_name_genderize_parsed_request_data.rb

@@ -0,0 +1,75 @@
+
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="ai_name_genderize_parsed_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 ai_name_genderize_parsed operation.
+  class AiNameGenderizeParsedRequestData < EmailRequest
+
+    # Detect person&#39;s gender from parsed name             
+    # @param [AiNameParsedRq] rq Gender detection request data
+    def initialize(rq)
+      @rq = rq if rq
+    end
+
+    def to_http_info(api_client)
+      # verify the required parameter 'rq' is set
+      if api_client.config.client_side_validation && @rq.nil?
+        raise ArgumentError, "Missing the required parameter 'rq' when calling EmailApi.ai_name_genderize_parsed"
+      end
+
+      # resource path
+      local_var_path = '/email/AiName/genderize-parsed'
+
+      # query parameters
+      query_params = {}
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = api_client.object_to_http_body(@rq)
+      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/ai_name_genderize_request_data.rb

@@ -0,0 +1,91 @@
+
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="ai_name_genderize_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 ai_name_genderize operation.
+  class AiNameGenderizeRequestData < EmailRequest
+
+    # Detect person&#39;s gender from name string             
+    # @param [String] name A name to parse (required)
+    # @param [String] language An ISO-639 code of the language; either 639-1 or 639-3 (e.g. \&quot;it\&quot; or \&quot;ita\&quot; for Italian)
+    # @param [String] location A geographic code such as an ISO-3166 two letter country code, for example \&quot;FR\&quot; for France
+    # @param [String] encoding A character encoding name
+    # @param [String] script A writing system code; starts with the ISO-15924 script name
+    # @param [String] style Name writing style. Enum, available values: Formal, Informal, Legal, Academic
+    def initialize(name, language = nil, location = nil, encoding = nil, script = nil, style = nil)
+      @name = name if name
+      @language = language if language
+      @location = location if location
+      @encoding = encoding if encoding
+      @script = script if script
+      @style = style if style
+    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.ai_name_genderize"
+      end
+
+      # resource path
+      local_var_path = '/email/AiName/genderize'
+
+      # query parameters
+      query_params = {}
+      query_params[:name] = @name
+      query_params[:language] = @language unless @language.nil?
+      query_params[:location] = @location unless @location.nil?
+      query_params[:encoding] = @encoding unless @encoding.nil?
+      query_params[:script] = @script unless @script.nil?
+      query_params[:style] = @style unless @style.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/ai_name_match_parsed_request_data.rb

@@ -0,0 +1,75 @@
+
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="ai_name_match_parsed_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 ai_name_match_parsed operation.
+  class AiNameMatchParsedRequestData < EmailRequest
+
+    # Compare people&#39;s parsed names and attributes. Uses options for comparing instructions             
+    # @param [AiNameParsedMatchRq] rq Parsed names to match
+    def initialize(rq)
+      @rq = rq if rq
+    end
+
+    def to_http_info(api_client)
+      # verify the required parameter 'rq' is set
+      if api_client.config.client_side_validation && @rq.nil?
+        raise ArgumentError, "Missing the required parameter 'rq' when calling EmailApi.ai_name_match_parsed"
+      end
+
+      # resource path
+      local_var_path = '/email/AiName/match-parsed'
+
+      # query parameters
+      query_params = {}
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = api_client.object_to_http_body(@rq)
+      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