RequestData models improved

aspose-email-cloud · Feb 18, 2020 · 88c1ee1 · 88c1ee1
1 parent 8aa68d6
commit 88c1ee1
Show file tree

Hide file tree

Showing 103 changed files with 1,641 additions and 706 deletions.
diff --git a/docs/EmailAccountConfig.md b/docs/EmailAccountConfig.md
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 **protocol_type** | **String** | Type of connection protocol. Enum, available values: IMAP, POP3, SMTP, EWS, WebDav | 
 **host** | **String** | Email account host.              | [optional] 
 **port** | **Integer** | Port.              | [optional] 
-**socket_type** | **String** | Security mode for a mail client Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto | 
+**socket_type** | **String** | Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto | 
 **authentication_types** | **Array&lt;String&gt;** | Supported authentication types.              Items: Email account authentication types. Enum, available values: NoAuth, OAuth2, PasswordCleartext, PasswordEncrypted, SmtpAfterPop, ClientIpAddress | [optional] 
 **extra_info** | [**Array&lt;NameValuePair&gt;**](NameValuePair.md) | Extra account information.              | [optional] 
 **is_validated** | **BOOLEAN** | Determines that configuration validated. Set to false if validation skipped.              | 

diff --git a/docs/EmailAccountRequest.md b/docs/EmailAccountRequest.md
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
 **host** | **String** | Email account host              | 
 **port** | **Integer** | Email account port              | 
 **login** | **String** | Email account login              | 
-**security_options** | **String** | Security mode for a mail client Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto | 
+**security_options** | **String** | Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto | 
 **protocol_type** | **String** | Type of connection protocol. Enum, available values: IMAP, POP3, SMTP, EWS, WebDav | 
 **description** | **String** | Email account description              | [optional] 
 **storage_file** | [**StorageFileLocation**](StorageFileLocation.md) | A storage file location info to store email account              | 

diff --git a/docs/NameValuePair.md b/docs/NameValuePair.md
@@ -2,8 +2,8 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**value** | **String** | Name of the property  | [optional] 
-**name** | **String** | Value of the property | [optional] 
+**value** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
 
 
 

diff --git a/docs/SaveEmailAccountRequest.md b/docs/SaveEmailAccountRequest.md
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
 **host** | **String** | Email account host              | 
 **port** | **Integer** | Email account port              | 
 **login** | **String** | Email account login              | 
-**security_options** | **String** | Security mode for a mail client Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto | 
+**security_options** | **String** | Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto | 
 **protocol_type** | **String** | Type of connection protocol. Enum, available values: IMAP, POP3, SMTP, EWS, WebDav | 
 **description** | **String** | Email account description              | [optional] 
 **storage_file** | [**StorageFileLocation**](StorageFileLocation.md) | A storage file location info to store email account              | 

diff --git a/docs/SaveOAuthEmailAccountRequest.md b/docs/SaveOAuthEmailAccountRequest.md
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
 **host** | **String** | Email account host              | 
 **port** | **Integer** | Email account port              | 
 **login** | **String** | Email account login              | 
-**security_options** | **String** | Security mode for a mail client Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto | 
+**security_options** | **String** | Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto | 
 **protocol_type** | **String** | Type of connection protocol. Enum, available values: IMAP, POP3, SMTP, EWS, WebDav | 
 **description** | **String** | Email account description              | [optional] 
 **storage_file** | [**StorageFileLocation**](StorageFileLocation.md) | A storage file location info to store email account              | 

diff --git a/lib/aspose-email-cloud/models/email_account_config.rb b/lib/aspose-email-cloud/models/email_account_config.rb
@@ -45,7 +45,7 @@ class EmailAccountConfig
     # @return [Integer]
     attr_accessor :port
 
-    # Security mode for a mail client Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto
+    # Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto
     # @return [String]
     attr_accessor :socket_type
 
@@ -139,7 +139,7 @@ def initialize(attributes = {})
     # @param [String] protocol_type Type of connection protocol. Enum, available values: IMAP, POP3, SMTP, EWS, WebDav
     # @param [String] host Email account host.             
     # @param [Integer] port Port.             
-    # @param [String] socket_type Security mode for a mail client Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto
+    # @param [String] socket_type Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto
     # @param [Array<String>] authentication_types Supported authentication types.              Items: Email account authentication types. Enum, available values: NoAuth, OAuth2, PasswordCleartext, PasswordEncrypted, SmtpAfterPop, ClientIpAddress
     # @param [Array<NameValuePair>] extra_info Extra account information.             
     # @param [BOOLEAN] is_validated Determines that configuration validated. Set to false if validation skipped.             

diff --git a/lib/aspose-email-cloud/models/email_account_request.rb b/lib/aspose-email-cloud/models/email_account_request.rb
@@ -41,7 +41,7 @@ class EmailAccountRequest
     # @return [String]
     attr_accessor :login
 
-    # Security mode for a mail client Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto
+    # Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto
     # @return [String]
     attr_accessor :security_options
 
@@ -124,7 +124,7 @@ def initialize(attributes = {})
     # @param [String] host Email account host             
     # @param [Integer] port Email account port             
     # @param [String] login Email account login             
-    # @param [String] security_options Security mode for a mail client Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto
+    # @param [String] security_options Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto
     # @param [String] protocol_type Type of connection protocol. Enum, available values: IMAP, POP3, SMTP, EWS, WebDav
     # @param [String] description Email account description             
     # @param [StorageFileLocation] storage_file A storage file location info to store email account             

diff --git a/lib/aspose-email-cloud/models/name_value_pair.rb b/lib/aspose-email-cloud/models/name_value_pair.rb
@@ -27,13 +27,12 @@
 require 'date'
 
 module AsposeEmailCloud
-  # An extended property.
   class NameValuePair
-    # Name of the property 
+
     # @return [String]
     attr_accessor :value
 
-    # Value of the property
+
     # @return [String]
     attr_accessor :name
 
@@ -71,8 +70,8 @@ def initialize(attributes = {})
     end
 
     # Initializes the object
-    # @param [String] value Name of the property 
-    # @param [String] name Value of the property
+    # @param [String] value 
+    # @param [String] name 
     def initialize(value=nil, name=nil)
       self.value = value if value
       self.name = name if name

diff --git a/lib/aspose-email-cloud/models/requests/add_calendar_attachment_request_data.rb b/lib/aspose-email-cloud/models/requests/add_calendar_attachment_request_data.rb
@@ -32,34 +32,44 @@ module AsposeEmailCloud
   # Request model for add_calendar_attachment operation.
   class AddCalendarAttachmentRequestData < EmailRequest
 
+    # Calendar file name in storage
+    # @return [String]
+    attr_accessor :name
+    # Attachment file name in storage
+    # @return [String]
+    attr_accessor :attachment
+    # Storage name and folder path for calendar and attachment files
+    # @return [AddAttachmentRequest]
+    attr_accessor :request
+
     # Adds an attachment to iCalendar file             
     # @param [String] name Calendar file name in storage
     # @param [String] attachment Attachment file name in storage
     # @param [AddAttachmentRequest] request Storage name and folder path for calendar and attachment files
     def initialize(name, attachment, request)
-      @name = name if name
-      @attachment = attachment if attachment
-      @request = request if request
+      self.name = name if name
+      self.attachment = attachment if attachment
+      self.request = request if request
     end
 
     def to_http_info(api_client)
       # verify the required parameter 'name' is set
-      if api_client.config.client_side_validation && @name.nil?
+      if api_client.config.client_side_validation && self.name.nil?
         raise ArgumentError, "Missing the required parameter 'name' when calling EmailApi.add_calendar_attachment"
       end
 
       # verify the required parameter 'attachment' is set
-      if api_client.config.client_side_validation && @attachment.nil?
+      if api_client.config.client_side_validation && self.attachment.nil?
         raise ArgumentError, "Missing the required parameter 'attachment' when calling EmailApi.add_calendar_attachment"
       end
 
       # verify the required parameter 'request' is set
-      if api_client.config.client_side_validation && @request.nil?
+      if api_client.config.client_side_validation && self.request.nil?
         raise ArgumentError, "Missing the required parameter 'request' when calling EmailApi.add_calendar_attachment"
       end
 
       # resource path
-      local_var_path = '/email/Calendar/{name}/attachments/{attachment}'.sub('{' + 'name' + '}', @name.to_s).sub('{' + 'attachment' + '}', @attachment.to_s)
+      local_var_path = '/email/Calendar/{name}/attachments/{attachment}'.sub('{' + 'name' + '}', self.name.to_s).sub('{' + 'attachment' + '}', self.attachment.to_s)
 
       # query parameters
       query_params = {}
@@ -68,7 +78,7 @@ def to_http_info(api_client)
       form_params = {}
 
       # http body (model)
-      post_body = api_client.object_to_http_body(@request)
+      post_body = api_client.object_to_http_body(self.request)
       auth_names = ['JWT']
 
       # header parameters

diff --git a/lib/aspose-email-cloud/models/requests/add_contact_attachment_request_data.rb b/lib/aspose-email-cloud/models/requests/add_contact_attachment_request_data.rb
@@ -32,41 +32,54 @@ module AsposeEmailCloud
   # Request model for add_contact_attachment operation.
   class AddContactAttachmentRequestData < EmailRequest
 
+    # Contact document format Enum, available values: VCard, WebDav, Msg
+    # @return [String]
+    attr_accessor :format
+    # Contact document file name
+    # @return [String]
+    attr_accessor :name
+    # Attachment name
+    # @return [String]
+    attr_accessor :attachment
+    # Add attachment request
+    # @return [AddAttachmentRequest]
+    attr_accessor :request
+
     # Add attachment to contact document             
     # @param [String] format Contact document format Enum, available values: VCard, WebDav, Msg
     # @param [String] name Contact document file name
     # @param [String] attachment Attachment name
     # @param [AddAttachmentRequest] request Add attachment request
     def initialize(format, name, attachment, request)
-      @format = format if format
-      @name = name if name
-      @attachment = attachment if attachment
-      @request = request if request
+      self.format = format if format
+      self.name = name if name
+      self.attachment = attachment if attachment
+      self.request = request if request
     end
 
     def to_http_info(api_client)
       # verify the required parameter 'format' is set
-      if api_client.config.client_side_validation && @format.nil?
+      if api_client.config.client_side_validation && self.format.nil?
         raise ArgumentError, "Missing the required parameter 'format' when calling EmailApi.add_contact_attachment"
       end
 
       # verify the required parameter 'name' is set
-      if api_client.config.client_side_validation && @name.nil?
+      if api_client.config.client_side_validation && self.name.nil?
         raise ArgumentError, "Missing the required parameter 'name' when calling EmailApi.add_contact_attachment"
       end
 
       # verify the required parameter 'attachment' is set
-      if api_client.config.client_side_validation && @attachment.nil?
+      if api_client.config.client_side_validation && self.attachment.nil?
         raise ArgumentError, "Missing the required parameter 'attachment' when calling EmailApi.add_contact_attachment"
       end
 
       # verify the required parameter 'request' is set
-      if api_client.config.client_side_validation && @request.nil?
+      if api_client.config.client_side_validation && self.request.nil?
         raise ArgumentError, "Missing the required parameter 'request' when calling EmailApi.add_contact_attachment"
       end
 
       # resource path
-      local_var_path = '/email/Contact/{format}/{name}/attachments/{attachment}'.sub('{' + 'format' + '}', @format.to_s).sub('{' + 'name' + '}', @name.to_s).sub('{' + 'attachment' + '}', @attachment.to_s)
+      local_var_path = '/email/Contact/{format}/{name}/attachments/{attachment}'.sub('{' + 'format' + '}', self.format.to_s).sub('{' + 'name' + '}', self.name.to_s).sub('{' + 'attachment' + '}', self.attachment.to_s)
 
       # query parameters
       query_params = {}
@@ -75,7 +88,7 @@ def to_http_info(api_client)
       form_params = {}
 
       # http body (model)
-      post_body = api_client.object_to_http_body(@request)
+      post_body = api_client.object_to_http_body(self.request)
       auth_names = ['JWT']
 
       # header parameters

diff --git a/lib/aspose-email-cloud/models/requests/add_email_attachment_request_data.rb b/lib/aspose-email-cloud/models/requests/add_email_attachment_request_data.rb
@@ -32,34 +32,44 @@ module AsposeEmailCloud
   # Request model for add_email_attachment operation.
   class AddEmailAttachmentRequestData < EmailRequest
 
+    # Attachment file name
+    # @return [String]
+    attr_accessor :attachment_name
+    # Email document file name
+    # @return [String]
+    attr_accessor :file_name
+    # Storage info to specify location of email document and attachment files
+    # @return [AddAttachmentRequest]
+    attr_accessor :request
+
     # Adds an attachment to Email document             
     # @param [String] attachment_name Attachment file name
     # @param [String] file_name Email document file name
     # @param [AddAttachmentRequest] request Storage info to specify location of email document and attachment files
     def initialize(attachment_name, file_name, request)
-      @attachment_name = attachment_name if attachment_name
-      @file_name = file_name if file_name
-      @request = request if request
+      self.attachment_name = attachment_name if attachment_name
+      self.file_name = file_name if file_name
+      self.request = request if request
     end
 
     def to_http_info(api_client)
       # verify the required parameter 'attachment_name' is set
-      if api_client.config.client_side_validation && @attachment_name.nil?
+      if api_client.config.client_side_validation && self.attachment_name.nil?
         raise ArgumentError, "Missing the required parameter 'attachment_name' when calling EmailApi.add_email_attachment"
       end
 
       # verify the required parameter 'file_name' is set
-      if api_client.config.client_side_validation && @file_name.nil?
+      if api_client.config.client_side_validation && self.file_name.nil?
         raise ArgumentError, "Missing the required parameter 'file_name' when calling EmailApi.add_email_attachment"
       end
 
       # verify the required parameter 'request' is set
-      if api_client.config.client_side_validation && @request.nil?
+      if api_client.config.client_side_validation && self.request.nil?
         raise ArgumentError, "Missing the required parameter 'request' when calling EmailApi.add_email_attachment"
       end
 
       # resource path
-      local_var_path = '/email/{fileName}/attachments/{attachmentName}'.sub('{' + 'attachmentName' + '}', @attachment_name.to_s).sub('{' + 'fileName' + '}', @file_name.to_s)
+      local_var_path = '/email/{fileName}/attachments/{attachmentName}'.sub('{' + 'attachmentName' + '}', self.attachment_name.to_s).sub('{' + 'fileName' + '}', self.file_name.to_s)
 
       # query parameters
       query_params = {}
@@ -68,7 +78,7 @@ def to_http_info(api_client)
       form_params = {}
 
       # http body (model)
-      post_body = api_client.object_to_http_body(@request)
+      post_body = api_client.object_to_http_body(self.request)
       auth_names = ['JWT']
 
       # header parameters

diff --git a/lib/aspose-email-cloud/models/requests/add_mapi_attachment_request_data.rb b/lib/aspose-email-cloud/models/requests/add_mapi_attachment_request_data.rb
@@ -32,34 +32,44 @@ module AsposeEmailCloud
   # Request model for add_mapi_attachment operation.
   class AddMapiAttachmentRequestData < EmailRequest
 
+    # Document file name
+    # @return [String]
+    attr_accessor :name
+    # Attachment file name
+    # @return [String]
+    attr_accessor :attachment
+    # Add attachment request
+    # @return [AddAttachmentRequest]
+    attr_accessor :request
+
     # Add attachment to document             
     # @param [String] name Document file name
     # @param [String] attachment Attachment file name
     # @param [AddAttachmentRequest] request Add attachment request
     def initialize(name, attachment, request)
-      @name = name if name
-      @attachment = attachment if attachment
-      @request = request if request
+      self.name = name if name
+      self.attachment = attachment if attachment
+      self.request = request if request
     end
 
     def to_http_info(api_client)
       # verify the required parameter 'name' is set
-      if api_client.config.client_side_validation && @name.nil?
+      if api_client.config.client_side_validation && self.name.nil?
         raise ArgumentError, "Missing the required parameter 'name' when calling EmailApi.add_mapi_attachment"
       end
 
       # verify the required parameter 'attachment' is set
-      if api_client.config.client_side_validation && @attachment.nil?
+      if api_client.config.client_side_validation && self.attachment.nil?
         raise ArgumentError, "Missing the required parameter 'attachment' when calling EmailApi.add_mapi_attachment"
       end
 
       # verify the required parameter 'request' is set
-      if api_client.config.client_side_validation && @request.nil?
+      if api_client.config.client_side_validation && self.request.nil?
         raise ArgumentError, "Missing the required parameter 'request' when calling EmailApi.add_mapi_attachment"
       end
 
       # resource path
-      local_var_path = '/email/Mapi/{name}/attachments/{attachment}'.sub('{' + 'name' + '}', @name.to_s).sub('{' + 'attachment' + '}', @attachment.to_s)
+      local_var_path = '/email/Mapi/{name}/attachments/{attachment}'.sub('{' + 'name' + '}', self.name.to_s).sub('{' + 'attachment' + '}', self.attachment.to_s)
 
       # query parameters
       query_params = {}
@@ -68,7 +78,7 @@ def to_http_info(api_client)
       form_params = {}
 
       # http body (model)
-      post_body = api_client.object_to_http_body(@request)
+      post_body = api_client.object_to_http_body(self.request)
       auth_names = ['JWT']
 
       # header parameters

diff --git a/lib/aspose-email-cloud/models/requests/ai_bcr_ocr_request_data.rb b/lib/aspose-email-cloud/models/requests/ai_bcr_ocr_request_data.rb
@@ -32,15 +32,19 @@ module AsposeEmailCloud
   # Request model for ai_bcr_ocr operation.
   class AiBcrOcrRequestData < EmailRequest
 
+    # Request with base64 images data
+    # @return [AiBcrBase64Rq]
+    attr_accessor :rq
+
     # Ocr images             
     # @param [AiBcrBase64Rq] rq Request with base64 images data
     def initialize(rq)
-      @rq = rq if rq
+      self.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?
+      if api_client.config.client_side_validation && self.rq.nil?
         raise ArgumentError, "Missing the required parameter 'rq' when calling EmailApi.ai_bcr_ocr"
       end
 
@@ -54,7 +58,7 @@ def to_http_info(api_client)
       form_params = {}
 
       # http body (model)
-      post_body = api_client.object_to_http_body(@rq)
+      post_body = api_client.object_to_http_body(self.rq)
       auth_names = ['JWT']
 
       # header parameters