mailslurp_client 11.8.13 → 11.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11ebaabec4bbbf121b6a4e25953c0c9facd1eca5f287d13652d58e8e148857d3
-  data.tar.gz: 1b99f7d5e4dfc0079e8918051a83b7a32b81171dbd3eee85eaad1c9d4aa429ce
+  metadata.gz: f5c22a93ce6a491081d7363abcf426711694392876c24ab636d0622352ba52da
+  data.tar.gz: 047c593cca66950a9f895f162dbb526c3652ca2dcb04d06e487787c5e5b25056
 SHA512:
-  metadata.gz: a3da7479cb4a1577644c0113c3f0a04eafe3153e57825ee87dab7a7197fbf5ff110ee6aaa94ce90dd66a878112fe2e7a98d3c138ebe86c31bedbee0cd0271343
-  data.tar.gz: e0ed6e71c82824d0b3d8e34b443f56f2e364c4aa16cd9b634442b51be529c02ea0e9adcfb8ad3b4748d3fc8d0a9059f6e1db16e46a63af18019ebaa3961a9e52
+  metadata.gz: aef83e194f79409d63dc4081a74b6cac6b0a090dfea01f282e2599bc1255209072d36b7ed2523b69e9a158a19c81abf7dfa8de266686b690c69c51ec49462d57
+  data.tar.gz: f99073f4219ecdb6f07fc06fb7de6ccae6d96a5c81ffa1fd08f8aaed556692e44cb184980dc103cd88be2a7bb24063a2099aa131152481cfe6dc3353fdd4819d

data/lib/mailslurp_client/api/attachment_controller_api.rb

@@ -19,6 +19,192 @@ module MailSlurpClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Get email attachment as base64 encoded string as alternative to binary responses. To read the content decode the Base64 encoded contents.
+    # Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the `downloadAttachment` method but allows some clients to get around issues with binary responses.
+    # @param attachment_id [String] ID of attachment
+    # @param [Hash] opts the optional parameters
+    # @return [DownloadAttachmentDto]
+    def download_attachment_as_base64_encoded(attachment_id, opts = {})
+      data, _status_code, _headers = download_attachment_as_base64_encoded_with_http_info(attachment_id, opts)
+      data
+    end
+
+    # Get email attachment as base64 encoded string as alternative to binary responses. To read the content decode the Base64 encoded contents.
+    # Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the `downloadAttachment` method but allows some clients to get around issues with binary responses.
+    # @param attachment_id [String] ID of attachment
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DownloadAttachmentDto, Integer, Hash)>] DownloadAttachmentDto data, response status code and response headers
+    def download_attachment_as_base64_encoded_with_http_info(attachment_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AttachmentControllerApi.download_attachment_as_base64_encoded ...'
+      end
+      # verify the required parameter 'attachment_id' is set
+      if @api_client.config.client_side_validation && attachment_id.nil?
+        fail ArgumentError, "Missing the required parameter 'attachment_id' when calling AttachmentControllerApi.download_attachment_as_base64_encoded"
+      end
+      # resource path
+      local_var_path = '/attachments/{attachmentId}/base64'.sub('{' + 'attachmentId' + '}', CGI.escape(attachment_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'DownloadAttachmentDto' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['API_KEY']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AttachmentControllerApi#download_attachment_as_base64_encoded\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Download attachments. Get email attachment bytes. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints.
+    # Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream.
+    # @param attachment_id [String] ID of attachment
+    # @param [Hash] opts the optional parameters
+    # @return [String]
+    def download_attachment_as_bytes(attachment_id, opts = {})
+      data, _status_code, _headers = download_attachment_as_bytes_with_http_info(attachment_id, opts)
+      data
+    end
+
+    # Download attachments. Get email attachment bytes. If you have trouble with byte responses try the &#x60;downloadAttachmentBase64&#x60; response endpoints.
+    # Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream.
+    # @param attachment_id [String] ID of attachment
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
+    def download_attachment_as_bytes_with_http_info(attachment_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AttachmentControllerApi.download_attachment_as_bytes ...'
+      end
+      # verify the required parameter 'attachment_id' is set
+      if @api_client.config.client_side_validation && attachment_id.nil?
+        fail ArgumentError, "Missing the required parameter 'attachment_id' when calling AttachmentControllerApi.download_attachment_as_bytes"
+      end
+      # resource path
+      local_var_path = '/attachments/{attachmentId}/bytes'.sub('{' + 'attachmentId' + '}', CGI.escape(attachment_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'String' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['API_KEY']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AttachmentControllerApi#download_attachment_as_bytes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get email attachment metadata information
+    # Returns the metadata for an attachment. It is saved separately to the content of the attachment. Contains properties `name` and `content-type` and `content-length` in bytes for a given attachment.
+    # @param attachment_id [String] ID of attachment
+    # @param [Hash] opts the optional parameters
+    # @return [AttachmentMetaData]
+    def get_attachment_info(attachment_id, opts = {})
+      data, _status_code, _headers = get_attachment_info_with_http_info(attachment_id, opts)
+      data
+    end
+
+    # Get email attachment metadata information
+    # Returns the metadata for an attachment. It is saved separately to the content of the attachment. Contains properties &#x60;name&#x60; and &#x60;content-type&#x60; and &#x60;content-length&#x60; in bytes for a given attachment.
+    # @param attachment_id [String] ID of attachment
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AttachmentMetaData, Integer, Hash)>] AttachmentMetaData data, response status code and response headers
+    def get_attachment_info_with_http_info(attachment_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AttachmentControllerApi.get_attachment_info ...'
+      end
+      # verify the required parameter 'attachment_id' is set
+      if @api_client.config.client_side_validation && attachment_id.nil?
+        fail ArgumentError, "Missing the required parameter 'attachment_id' when calling AttachmentControllerApi.get_attachment_info"
+      end
+      # resource path
+      local_var_path = '/attachments/{attachmentId}/metadata'.sub('{' + 'attachmentId' + '}', CGI.escape(attachment_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'AttachmentMetaData' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['API_KEY']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AttachmentControllerApi#get_attachment_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Upload an attachment for sending using base64 file encoding. Returns an array whose first element is the ID of the uploaded attachment.
     # Email attachments are essentially files with meta data. Files are byte arrays and the meta data is a content type and a filename. These properties allow email clients to display the filename and icon etc. When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment ID and use it with subsequent email sending. For legacy reasons the ID is returned as the first element in an array. Only a single ID is ever returned. To send the attachments pass a list of attachment IDs with `SendEmailOptions` when sending an email. Using the upload endpoints prior to sending mean attachments can easily be reused.
     # @param upload_options [UploadAttachmentOptions] uploadOptions

data/lib/mailslurp_client/api/email_controller_api.rb

@@ -19,7 +19,7 @@ module MailSlurpClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Delete all emails
+    # Delete all emails in all inboxes.
     # Deletes all emails in your account. Be careful as emails cannot be recovered
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -28,7 +28,7 @@ module MailSlurpClient
       nil
     end
 
-    # Delete all emails
+    # Delete all emails in all inboxes.
     # Deletes all emails in your account. Be careful as emails cannot be recovered
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -133,7 +133,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get email attachment bytes. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints.
+    # Get email attachment bytes. Returned as `octet-stream` with content type header. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints and convert the base 64 encoded content to a file or string.
     # Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream.
     # @param attachment_id [String] ID of attachment
     # @param email_id [String] ID of email
@@ -145,7 +145,7 @@ module MailSlurpClient
       data
     end
 
-    # Get email attachment bytes. If you have trouble with byte responses try the &#x60;downloadAttachmentBase64&#x60; response endpoints.
+    # Get email attachment bytes. Returned as &#x60;octet-stream&#x60; with content type header. If you have trouble with byte responses try the &#x60;downloadAttachmentBase64&#x60; response endpoints and convert the base 64 encoded content to a file or string.
     # Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream.
     # @param attachment_id [String] ID of attachment
     # @param email_id [String] ID of email
@@ -204,7 +204,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get email attachment as base64 encoded string (alternative to binary responses)
+    # Get email attachment as base64 encoded string alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`.
     # Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the `downloadAttachment` method but allows some clients to get around issues with binary responses.
     # @param attachment_id [String] ID of attachment
     # @param email_id [String] ID of email
@@ -215,7 +215,7 @@ module MailSlurpClient
       data
     end
 
-    # Get email attachment as base64 encoded string (alternative to binary responses)
+    # Get email attachment as base64 encoded string alternative to binary responses. Decode the &#x60;base64FileContents&#x60; as a &#x60;utf-8&#x60; encoded string or array of bytes depending on the &#x60;contentType&#x60;.
     # Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the &#x60;downloadAttachment&#x60; method but allows some clients to get around issues with binary responses.
     # @param attachment_id [String] ID of attachment
     # @param email_id [String] ID of email
@@ -272,7 +272,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Forward email
+    # Forward email to recipients
     # Forward an existing email to new recipients.
     # @param email_id [String] ID of email
     # @param forward_email_options [ForwardEmailOptions] forwardEmailOptions
@@ -283,7 +283,7 @@ module MailSlurpClient
       nil
     end
 
-    # Forward email
+    # Forward email to recipients
     # Forward an existing email to new recipients.
     # @param email_id [String] ID of email
     # @param forward_email_options [ForwardEmailOptions] forwardEmailOptions
@@ -340,7 +340,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get email attachment metadata
+    # Get email attachment metadata. This is the `contentType` and `contentLength` of an attachment. To get the individual attachments  use the `downloadAttachment` methods.
     # Returns the metadata such as name and content-type for a given attachment and email.
     # @param attachment_id [String] ID of attachment
     # @param email_id [String] ID of email
@@ -351,7 +351,7 @@ module MailSlurpClient
       data
     end
 
-    # Get email attachment metadata
+    # Get email attachment metadata. This is the &#x60;contentType&#x60; and &#x60;contentLength&#x60; of an attachment. To get the individual attachments  use the &#x60;downloadAttachment&#x60; methods.
     # Returns the metadata such as name and content-type for a given attachment and email.
     # @param attachment_id [String] ID of attachment
     # @param email_id [String] ID of email
@@ -408,7 +408,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get all email attachment metadata
+    # Get all email attachment metadata. Metadata includes name and attachment size.
     # Returns an array of attachment metadata such as name and content-type for a given email if present.
     # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
@@ -418,7 +418,7 @@ module MailSlurpClient
       data
     end
 
-    # Get all email attachment metadata
+    # Get all email attachment metadata. Metadata includes name and attachment size.
     # Returns an array of attachment metadata such as name and content-type for a given email if present.
     # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
@@ -605,7 +605,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get email content as HTML
+    # Get email content as HTML. For displaying emails in browser context.
     # Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: `?apiKey=xxx`
     # @param email_id [String] emailId
     # @param [Hash] opts the optional parameters
@@ -616,7 +616,7 @@ module MailSlurpClient
       data
     end
 
-    # Get email content as HTML
+    # Get email content as HTML. For displaying emails in browser context.
     # Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: &#x60;?apiKey&#x3D;xxx&#x60;
     # @param email_id [String] emailId
     # @param [Hash] opts the optional parameters
@@ -878,7 +878,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get latest email
+    # Get latest email in all inboxes. Most recently received.
     # Get the newest email in all inboxes or in a passed set of inbox IDs
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :inbox_ids Optional set of inboxes to filter by. Only get the latest email from these inbox IDs
@@ -888,7 +888,7 @@ module MailSlurpClient
       data
     end
 
-    # Get latest email
+    # Get latest email in all inboxes. Most recently received.
     # Get the newest email in all inboxes or in a passed set of inbox IDs
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :inbox_ids Optional set of inboxes to filter by. Only get the latest email from these inbox IDs
@@ -937,7 +937,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get latest email
+    # Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet.
     # Get the newest email in all inboxes or in a passed set of inbox IDs
     # @param [Hash] opts the optional parameters
     # @option opts [String] :inbox_id ID of the inbox you want to get the latest email from
@@ -947,7 +947,7 @@ module MailSlurpClient
       data
     end
 
-    # Get latest email
+    # Get latest email in an inbox. Use &#x60;WaitForController&#x60; to get emails that may not have arrived yet.
     # Get the newest email in all inboxes or in a passed set of inbox IDs
     # @param [Hash] opts the optional parameters
     # @option opts [String] :inbox_id ID of the inbox you want to get the latest email from
@@ -1071,7 +1071,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get raw email string
+    # Get raw email string. Returns unparsed raw SMTP message with headers and body.
     # Returns a raw, unparsed, and unprocessed email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawEmailJson endpoint
     # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
@@ -1081,7 +1081,7 @@ module MailSlurpClient
       data
     end
 
-    # Get raw email string
+    # Get raw email string. Returns unparsed raw SMTP message with headers and body.
     # Returns a raw, unparsed, and unprocessed email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawEmailJson endpoint
     # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
@@ -1133,7 +1133,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get raw email in JSON
+    # Get raw email in JSON. Unparsed SMTP message in JSON wrapper format.
     # Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response
     # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
@@ -1143,7 +1143,7 @@ module MailSlurpClient
       data
     end
 
-    # Get raw email in JSON
+    # Get raw email in JSON. Unparsed SMTP message in JSON wrapper format.
     # Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response
     # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
@@ -1321,7 +1321,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Validate email
+    # Validate email HTML contents
     # Validate the HTML content of email if HTML is found. Considered valid if no HTML.
     # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
@@ -1331,7 +1331,7 @@ module MailSlurpClient
       data
     end
 
-    # Validate email
+    # Validate email HTML contents
     # Validate the HTML content of email if HTML is found. Considered valid if no HTML.
     # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters

data/lib/mailslurp_client/api/inbox_controller_api.rb

@@ -19,7 +19,7 @@ module MailSlurpClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Create an Inbox (email address)
+    # Create an inbox email address. An inbox has a real email address and can send and receive emails.
     # Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty. 
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :allow_team_access Grant team access to this inbox and the emails that belong to it for team members of your organization.
@@ -37,7 +37,7 @@ module MailSlurpClient
       data
     end
 
-    # Create an Inbox (email address)
+    # Create an inbox email address. An inbox has a real email address and can send and receive emails.
     # Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty. 
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :allow_team_access Grant team access to this inbox and the emails that belong to it for team members of your organization.
@@ -102,7 +102,61 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Create an inbox with additional options
+    # Create an inbox with default options. Uses MailSlurp domain pool address and is private.
+    # @param [Hash] opts the optional parameters
+    # @return [Inbox]
+    def create_inbox_with_defaults(opts = {})
+      data, _status_code, _headers = create_inbox_with_defaults_with_http_info(opts)
+      data
+    end
+
+    # Create an inbox with default options. Uses MailSlurp domain pool address and is private.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Inbox, Integer, Hash)>] Inbox data, response status code and response headers
+    def create_inbox_with_defaults_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxControllerApi.create_inbox_with_defaults ...'
+      end
+      # resource path
+      local_var_path = '/inboxes/withDefaults'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'Inbox' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['API_KEY']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: InboxControllerApi#create_inbox_with_defaults\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create an inbox with options. Extended options for inbox creation.
     # Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients.
     # @param create_inbox_dto [CreateInboxDto] createInboxDto
     # @param [Hash] opts the optional parameters
@@ -112,7 +166,7 @@ module MailSlurpClient
       data
     end
 
-    # Create an inbox with additional options
+    # Create an inbox with options. Extended options for inbox creation.
     # Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients.
     # @param create_inbox_dto [CreateInboxDto] createInboxDto
     # @param [Hash] opts the optional parameters
@@ -445,7 +499,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get Inbox
+    # Get Inbox. Returns properties of an inbox.
     # Returns an inbox's properties, including its email address and ID.
     # @param inbox_id [String] inboxId
     # @param [Hash] opts the optional parameters
@@ -455,7 +509,7 @@ module MailSlurpClient
       data
     end
 
-    # Get Inbox
+    # Get Inbox. Returns properties of an inbox.
     # Returns an inbox&#39;s properties, including its email address and ID.
     # @param inbox_id [String] inboxId
     # @param [Hash] opts the optional parameters
@@ -713,7 +767,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # List Inboxes / Email Addresses
+    # List Inboxes and email eddresses
     # List the inboxes you have created. Note use of the more advanced `getAllEmails` is recommended. You can provide a limit and sort parameter.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :size Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated &#x60;getAllEmails&#x60; for larger queries. (default to 100)
@@ -724,7 +778,7 @@ module MailSlurpClient
       data
     end
 
-    # List Inboxes / Email Addresses
+    # List Inboxes and email eddresses
     # List the inboxes you have created. Note use of the more advanced &#x60;getAllEmails&#x60; is recommended. You can provide a limit and sort parameter.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :size Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated &#x60;getAllEmails&#x60; for larger queries.
@@ -913,7 +967,7 @@ module MailSlurpClient
     end
 
     # Send email and return sent confirmation
-    # Sister method for standard `sendEmail` method with the benefit of returning a `SentEmail` entity confirming the successful sending of the email with link the the sent object created for it.
+    # Sister method for standard `sendEmail` method with the benefit of returning a `SentEmail` entity confirming the successful sending of the email with a link to the sent object created for it.
     # @param inbox_id [String] ID of the inbox you want to send the email from
     # @param [Hash] opts the optional parameters
     # @option opts [SendEmailOptions] :send_email_options Options for the email
@@ -924,7 +978,7 @@ module MailSlurpClient
     end
 
     # Send email and return sent confirmation
-    # Sister method for standard &#x60;sendEmail&#x60; method with the benefit of returning a &#x60;SentEmail&#x60; entity confirming the successful sending of the email with link the the sent object created for it.
+    # Sister method for standard &#x60;sendEmail&#x60; method with the benefit of returning a &#x60;SentEmail&#x60; entity confirming the successful sending of the email with a link to the sent object created for it.
     # @param inbox_id [String] ID of the inbox you want to send the email from
     # @param [Hash] opts the optional parameters
     # @option opts [SendEmailOptions] :send_email_options Options for the email
@@ -1048,7 +1102,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Update Inbox
+    # Update Inbox. Change name and description. Email address is not editable.
     # Update editable fields on an inbox
     # @param inbox_id [String] inboxId
     # @param update_inbox_options [UpdateInboxOptions] updateInboxOptions
@@ -1059,7 +1113,7 @@ module MailSlurpClient
       data
     end
 
-    # Update Inbox
+    # Update Inbox. Change name and description. Email address is not editable.
     # Update editable fields on an inbox
     # @param inbox_id [String] inboxId
     # @param update_inbox_options [UpdateInboxOptions] updateInboxOptions

data/lib/mailslurp_client/api/wait_for_controller_api.rb

@@ -19,20 +19,20 @@ module MailSlurpClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Wait for conditions to be met
+    # Wait for an email to match the provided filter conditions such as subject contains keyword.
     # Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already met
     # @param [Hash] opts the optional parameters
-    # @option opts [WaitForConditions] :wait_for_conditions Conditions to wait for
+    # @option opts [WaitForConditions] :wait_for_conditions Conditions to apply to emails that you are waiting for
     # @return [Array<EmailPreview>]
     def wait_for(opts = {})
       data, _status_code, _headers = wait_for_with_http_info(opts)
       data
     end
 
-    # Wait for conditions to be met
+    # Wait for an email to match the provided filter conditions such as subject contains keyword.
     # Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already met
     # @param [Hash] opts the optional parameters
-    # @option opts [WaitForConditions] :wait_for_conditions Conditions to wait for
+    # @option opts [WaitForConditions] :wait_for_conditions Conditions to apply to emails that you are waiting for
     # @return [Array<(Array<EmailPreview>, Integer, Hash)>] Array<EmailPreview> data, response status code and response headers
     def wait_for_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -79,7 +79,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Wait for and return count number of emails 
+    # Wait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs
     # If inbox contains count or more emails at time of request then return count worth of emails. If not wait until the count is reached and return those or return an error if timeout is exceeded.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :count Number of emails to wait for. Must be greater that 1
@@ -92,7 +92,7 @@ module MailSlurpClient
       data
     end
 
-    # Wait for and return count number of emails 
+    # Wait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs
     # If inbox contains count or more emails at time of request then return count worth of emails. If not wait until the count is reached and return those or return an error if timeout is exceeded.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :count Number of emails to wait for. Must be greater that 1
@@ -361,7 +361,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Wait for or fetch the email with a given index in the inbox specified
+    # Wait for or fetch the email with a given index in the inbox specified. IF indx doesn't exist waits for it to exist or timeout to occur.
     # If nth email is already present in inbox then return it. If not hold the connection open until timeout expires or the nth email is received and returned.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :inbox_id Id of the inbox you are fetching emails from
@@ -374,7 +374,7 @@ module MailSlurpClient
       data
     end
 
-    # Wait for or fetch the email with a given index in the inbox specified
+    # Wait for or fetch the email with a given index in the inbox specified. IF indx doesn&#39;t exist waits for it to exist or timeout to occur.
     # If nth email is already present in inbox then return it. If not hold the connection open until timeout expires or the nth email is received and returned.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :inbox_id Id of the inbox you are fetching emails from

data/lib/mailslurp_client/models/attachment_meta_data.rb

@@ -18,13 +18,13 @@ module MailSlurpClient
     # Size of attachment in bytes
     attr_accessor :content_length
 
-    # Content type of attachment
+    # Content type of attachment such as `image/png`
     attr_accessor :content_type
 
     # ID of attachment
     attr_accessor :id
 
-    # Name of attachment
+    # Name of attachment if given
     attr_accessor :name
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/mailslurp_client/models/download_attachment_dto.rb

@@ -15,13 +15,13 @@ require 'date'
 module MailSlurpClient
   # Content of attachment
   class DownloadAttachmentDto
-    # Base64 encoded string of attachment bytes. Decode the base64 string to get the raw file bytes
+    # Base64 encoded string of attachment bytes. Decode the base64 encoded string to get the raw contents. If the file has a content type such as `text/html` you can read the contents directly by converting it to string using `utf-8` encoding.
     attr_accessor :base64_file_contents
 
-    # Content type of attachment
+    # Content type of attachment. Examples are `image/png`, `application/msword`, `text/csv` etc.
     attr_accessor :content_type
 
-    # Size in bytes of attachment
+    # Size in bytes of attachment content
     attr_accessor :size_bytes
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/mailslurp_client/models/email.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
-  # Email model (also referred to as EmailDto). Represents an email that was received by an inbox. If you want the original SMTP message see the `getRawEmail` endpoint.
+  # Email entity (also known as EmailDto). When an SMTP email message is received by MailSlurp it is parsed. The body and attachments are written to disk and the fields such as to, from, subject etc are stored in a database. The `body` contains the email content. If you want the original SMTP message see the `getRawEmail` endpoints. The attachments can be fetched using the AttachmentController
   class Email
     attr_accessor :analysis
 
@@ -41,21 +41,22 @@ module MailSlurpClient
     # Who the email was sent from
     attr_accessor :from
 
+    # Collection of SMTP headers attached to email
     attr_accessor :headers
 
-    # ID of the email
+    # ID of the email entity
     attr_accessor :id
 
     # ID of the inbox that received the email
     attr_accessor :inbox_id
 
-    # Was HTML sent in the email body
+    # Is the email body HTML
     attr_accessor :is_html
 
-    # Has the email been viewed ever. This means viewed in the dashboard or requested via the full email entity endpoints
+    # Read flag. Has the email ever been viewed in the dashboard or fetched via the API? If so the email is marked as read.
     attr_accessor :read
 
-    # The replyTo field on the received email
+    # The `replyTo` field on the received email message
     attr_accessor :reply_to
 
     # The subject line of the email message
@@ -64,13 +65,13 @@ module MailSlurpClient
     # Can the email be accessed by organization team members
     attr_accessor :team_access
 
-    # List of `To` recipients email was addressed to
+    # List of `To` recipients that email was addressed to
     attr_accessor :to
 
     # When was the email last updated
     attr_accessor :updated_at
 
-    # ID of user that email belongs
+    # ID of user that email belongs to
     attr_accessor :user_id
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/mailslurp_client/models/email_preview.rb

@@ -30,16 +30,16 @@ module MailSlurpClient
     # Who the email was sent from
     attr_accessor :from
 
-    # ID of the email
+    # ID of the email entity
     attr_accessor :id
 
-    # Has the email been viewed ever. This means viewed in the dashboard or requested via the full email entity endpoints
+    # Read flag. Has the email ever been viewed in the dashboard or fetched via the API? If so the email is marked as read.
     attr_accessor :read
 
     # The subject line of the email message
     attr_accessor :subject
 
-    # List of `To` recipients email was addressed to
+    # List of `To` recipients that email was addressed to
     attr_accessor :to
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/mailslurp_client/models/inbox.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
-  # Representation of an inbox with an email address. Emails can be sent to or from this email address.
+  # Representation of a MailSlurp inbox. An inbox has an ID and a real email address. Emails can be sent to or from this email address. Use the `EmailController` or the `InboxController` methods to send and receive emails and attachments.
   class Inbox
     # When the inbox was created. Time stamps are in ISO DateTime Format `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` e.g. `2000-10-31T01:30:00.000-05:00`.
     attr_accessor :created_at
@@ -36,13 +36,13 @@ module MailSlurpClient
     # Name of the inbox. Displayed in the dashboard for easier search
     attr_accessor :name
 
-    # Is the inbox readOnly for the caller. Read only means can not be deleted or modified.
+    # Is the inbox readOnly for the caller. Read only means can not be deleted or modified. This flag is present when using team accounts and shared inboxes.
     attr_accessor :read_only
 
     # Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.
     attr_accessor :tags
 
-    # Does inbox permit team access for organization team members. If so team users can use inbox and emails associated with it.
+    # Does inbox permit team access for organization team members. If so team users can use inbox and emails associated with it. See the team access guide at https://www.mailslurp.com/guides/team-email-account-sharing/
     attr_accessor :team_access
 
     # ID of user that inbox belongs to

data/lib/mailslurp_client/models/organization_inbox_projection.rb

@@ -29,13 +29,13 @@ module MailSlurpClient
     # Name of the inbox. Displayed in the dashboard for easier search
     attr_accessor :name
 
-    # Is the inbox readOnly for the caller. Read only means can not be deleted or modified.
+    # Is the inbox readOnly for the caller. Read only means can not be deleted or modified. This flag is present when using team accounts and shared inboxes.
     attr_accessor :read_only
 
     # Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.
     attr_accessor :tags
 
-    # Does inbox permit team access for organization team members. If so team users can use inbox and emails associated with it.
+    # Does inbox permit team access for organization team members. If so team users can use inbox and emails associated with it. See the team access guide at https://www.mailslurp.com/guides/team-email-account-sharing/
     attr_accessor :team_access
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/mailslurp_client/models/webhook_dto.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
-  # Representation of a webhook for an inbox. The URL specified will be using by MailSlurp whenever an email is received by the attached inbox.
+  # Representation of a webhook for an inbox. The URL specified will be using by MailSlurp whenever an email is received by the attached inbox. A webhook entity should have a URL that points to your server. Your server should accept HTTP/S POST requests and return a success 200. MailSlurp will retry your webhooks if they fail. See https://api.mailslurp.com/schemas/webhook-payload for the payload schema.
   class WebhookDto
     # Does webhook expect basic authentication? If true it means you created this webhook with a username and password. MailSlurp will use these in the URL to authenticate itself.
     attr_accessor :basic_auth

data/lib/mailslurp_client/models/webhook_payload.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
-  # MailSlurp webhook payload schema. This schema describes the JSON object that is sent via HTTP POST to webhook urls when an email is received by an inbox that a webhook is attached to. Payloads may be delivered multiple times so use the ID as a key for event uniqueness. The payload contains IDs for the email and inbox affected. Use these to fetch more data related to the event using appropriate inbox and email endpoints. See https://www.mailslurp.com/guides/email-webhooks/ for more information. Your webhook endpoint should accept POST HTTP request and return a 200 in under 30 seconds. Process the webhook asynchronously if you need to.
+  # MailSlurp webhook payload schema is available at https://api.mailslurp.com/schemas/webhook-payload. This schema describes the JSON object that is sent via HTTP POST to webhook urls when an email is received by an inbox that a webhook is attached to. Payloads may be delivered multiple times so use the ID as a key for event uniqueness. The payload contains IDs for the email and inbox affected. Use these to fetch more data related to the event using appropriate inbox and email endpoints. See https://www.mailslurp.com/guides/email-webhooks/ for more information. Your webhook endpoint should accept POST HTTP request and return a 200 in under 30 seconds. Process the webhook asynchronously if you need to.
   class WebhookPayload
     # List of attachment meta data objects if attachments present
     attr_accessor :attachment_meta_datas
@@ -45,7 +45,7 @@ module MailSlurpClient
     # The subject line of the email message
     attr_accessor :subject
 
-    # List of `To` recipients email was addressed to
+    # List of `To` recipients that email was addressed to
     attr_accessor :to
 
     # ID of webhook entity being triggered

data/lib/mailslurp_client/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 4.3.1
 =end
 
 module MailSlurpClient
-  VERSION = '11.8.13'
+  VERSION = '11.9.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailslurp_client
 version: !ruby/object:Gem::Version
-  version: 11.8.13
+  version: 11.9.4
 platform: ruby
 authors:
 - mailslurp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-02 00:00:00.000000000 Z
+date: 2021-05-04 00:00:00.000000000 Z
 dependencies: []
 description: Create emails addresses in Ruby then send and receive real emails and
   attachments. See https://www.mailslurp.com/docs/ruby/ for full Ruby documentation.