mailslurp_client 11.8.9 → 11.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63395ce2606bb8bc464f1e132c154d8fd558be33591b1f2c1e5d886ea54341e9
-  data.tar.gz: ba318aa96935fa63f007555ae1dea396e013bd0b7157d3de56e561e5585d0bb1
+  metadata.gz: a71ed75df545930dc62b3579bc134fa293d36c746fcd4471a738c1a2c1f29bcf
+  data.tar.gz: 416cd46b4cffb6f3a61fbd9fdc5543800c62670a68652621674ae450f5428daf
 SHA512:
-  metadata.gz: 312811da8c23aa5cb20ba621369f779a240cee55218850e6aa1141ce9ef381756085aa6cec91a54de70a46db1c09b4d32a62ccf578aa3a4a4837159555fd45fa
-  data.tar.gz: 9a4ecc1a2c98a7b1b0a85ff1c92171a7700b63abdb669d1cf47b63cce255b7fd69da9c894d68252b7ec8505851d8d33015f47cc30e80a80e11cfb02284d707ea
+  metadata.gz: '069aca4edc0db8dc46187d2796ba0a012b4f4c6ee6b684188147ebbf037ddab7362224db8512084cd13e4fe975aee83ec78c6bf897134ca265e276a9b1846cf5'
+  data.tar.gz: 0e65f158ed5b1bb606cf50b31736768109d836ceca535bee7552e038e8fcbca20aef2c6d06c21f78d64836b454a78559d72af3e6cb2af54c12eecf6c90591263

data/lib/mailslurp_client.rb

@@ -104,6 +104,7 @@ require 'mailslurp_client/models/validation_message'
 require 'mailslurp_client/models/verify_email_address_options'
 require 'mailslurp_client/models/wait_for_conditions'
 require 'mailslurp_client/models/webhook_dto'
+require 'mailslurp_client/models/webhook_payload'
 require 'mailslurp_client/models/webhook_projection'
 require 'mailslurp_client/models/webhook_test_request'
 require 'mailslurp_client/models/webhook_test_response'

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 (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 (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

@@ -803,7 +803,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get all emails
+    # Get all emails in all inboxes. Email API list all.
     # By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :inbox_id Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
@@ -817,7 +817,7 @@ module MailSlurpClient
       data
     end
 
-    # Get all emails
+    # Get all emails in all inboxes. Email API list all.
     # By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :inbox_id Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
@@ -996,7 +996,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get all organization emails
+    # Get all organization emails. List team or shared test email accounts
     # By default returns all emails across all team inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :inbox_id Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
@@ -1010,7 +1010,7 @@ module MailSlurpClient
       data
     end
 
-    # Get all organization emails
+    # Get all organization emails. List team or shared test email accounts
     # By default returns all emails across all team inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :inbox_id Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
@@ -1196,7 +1196,7 @@ module MailSlurpClient
     end
 
     # Get unread email count
-    # Get number of emails unread
+    # Get number of emails unread. Unread means has not been viewed in dashboard or returned in an email API response
     # @param [Hash] opts the optional parameters
     # @return [UnreadCount]
     def get_unread_email_count(opts = {})
@@ -1205,7 +1205,7 @@ module MailSlurpClient
     end
 
     # Get unread email count
-    # Get number of emails unread
+    # Get number of emails unread. Unread means has not been viewed in dashboard or returned in an email API response
     # @param [Hash] opts the optional parameters
     # @return [Array<(UnreadCount, Integer, Hash)>] UnreadCount data, response status code and response headers
     def get_unread_email_count_with_http_info(opts = {})

data/lib/mailslurp_client/api/webhook_controller_api.rb

@@ -156,8 +156,8 @@ module MailSlurpClient
     # List Webhooks Paginated
     # List webhooks in paginated form. Allows for page index, page size, and sort direction.
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page Optional page index in inbox list pagination (default to 0)
-    # @option opts [Integer] :size Optional page size in inbox list pagination (default to 20)
+    # @option opts [Integer] :page Optional page index in list pagination (default to 0)
+    # @option opts [Integer] :size Optional page size in list pagination (default to 20)
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
     # @return [PageWebhookProjection]
     def get_all_webhooks(opts = {})
@@ -168,8 +168,8 @@ module MailSlurpClient
     # List Webhooks Paginated
     # List webhooks in paginated form. Allows for page index, page size, and sort direction.
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page Optional page index in inbox list pagination
-    # @option opts [Integer] :size Optional page size in inbox list pagination
+    # @option opts [Integer] :page Optional page index in list pagination
+    # @option opts [Integer] :size Optional page size in list pagination
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
     # @return [Array<(PageWebhookProjection, Integer, Hash)>] PageWebhookProjection data, response status code and response headers
     def get_all_webhooks_with_http_info(opts = {})
@@ -222,6 +222,60 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Get test webhook payload example
+    # @param [Hash] opts the optional parameters
+    # @return [WebhookPayload]
+    def get_test_webhook_payload(opts = {})
+      data, _status_code, _headers = get_test_webhook_payload_with_http_info(opts)
+      data
+    end
+
+    # Get test webhook payload example
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(WebhookPayload, Integer, Hash)>] WebhookPayload data, response status code and response headers
+    def get_test_webhook_payload_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhookControllerApi.get_test_webhook_payload ...'
+      end
+      # resource path
+      local_var_path = '/webhooks/test'
+
+      # 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] || 'WebhookPayload' 
+
+      # 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: WebhookControllerApi#get_test_webhook_payload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get a webhook for an Inbox
     # @param webhook_id [String] webhookId
     # @param [Hash] opts the optional parameters
@@ -282,7 +336,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get all Webhooks for an Inbox
+    # Get all webhooks for an Inbox
     # @param inbox_id [String] inboxId
     # @param [Hash] opts the optional parameters
     # @return [Array<WebhookDto>]
@@ -291,7 +345,7 @@ module MailSlurpClient
       data
     end
 
-    # Get all Webhooks for an Inbox
+    # Get all webhooks for an Inbox
     # @param inbox_id [String] inboxId
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<WebhookDto>, Integer, Hash)>] Array<WebhookDto> data, response status code and response headers

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/create_domain_options.rb

@@ -24,12 +24,38 @@ module MailSlurpClient
     # The top level domain you wish to use with MailSlurp. Do not specify subdomain just the top level. So `test.com` covers all subdomains such as `mail.test.com`. Don't include a protocol such as `http://`. Once added you must complete the verification steps by adding the returned records to your domain.
     attr_accessor :domain
 
+    # Domain type to create. HTTP or SMTP domain. HTTP domain uses MailSlurps SES MX records. SMTP uses a custom SMTP server MX record
+    attr_accessor :domain_type
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'created_catch_all_inbox' => :'createdCatchAllInbox',
         :'description' => :'description',
-        :'domain' => :'domain'
+        :'domain' => :'domain',
+        :'domain_type' => :'domainType'
       }
     end
 
@@ -38,7 +64,8 @@ module MailSlurpClient
       {
         :'created_catch_all_inbox' => :'Boolean',
         :'description' => :'String',
-        :'domain' => :'String'
+        :'domain' => :'String',
+        :'domain_type' => :'String'
       }
     end
 
@@ -74,6 +101,10 @@ module MailSlurpClient
       if attributes.key?(:'domain')
         self.domain = attributes[:'domain']
       end
+
+      if attributes.key?(:'domain_type')
+        self.domain_type = attributes[:'domain_type']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -86,9 +117,21 @@ module MailSlurpClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      domain_type_validator = EnumAttributeValidator.new('String', ["HTTP_INBOX", "SMTP_DOMAIN"])
+      return false unless domain_type_validator.valid?(@domain_type)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] domain_type Object to be assigned
+    def domain_type=(domain_type)
+      validator = EnumAttributeValidator.new('String', ["HTTP_INBOX", "SMTP_DOMAIN"])
+      unless validator.valid?(domain_type)
+        fail ArgumentError, "invalid value for \"domain_type\", must be one of #{validator.allowable_values}."
+      end
+      @domain_type = domain_type
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -96,7 +139,8 @@ module MailSlurpClient
       self.class == o.class &&
           created_catch_all_inbox == o.created_catch_all_inbox &&
           description == o.description &&
-          domain == o.domain
+          domain == o.domain &&
+          domain_type == o.domain_type
     end
 
     # @see the `==` method
@@ -108,7 +152,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [created_catch_all_inbox, description, domain].hash
+      [created_catch_all_inbox, description, domain, domain_type].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/create_inbox_dto.rb

@@ -33,6 +33,9 @@ module MailSlurpClient
     # Is the inbox favorited. Favouriting inboxes is typically done in the dashboard for quick access or filtering
     attr_accessor :favourite
 
+    # HTTP or SMTP inbox
+    attr_accessor :inbox_type
+
     # Optional name of the inbox. Displayed in the dashboard for easier search
     attr_accessor :name
 
@@ -42,6 +45,28 @@ module MailSlurpClient
     # Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field.
     attr_accessor :use_domain_pool
 
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -51,6 +76,7 @@ module MailSlurpClient
         :'expires_at' => :'expiresAt',
         :'expires_in' => :'expiresIn',
         :'favourite' => :'favourite',
+        :'inbox_type' => :'inboxType',
         :'name' => :'name',
         :'tags' => :'tags',
         :'use_domain_pool' => :'useDomainPool'
@@ -66,6 +92,7 @@ module MailSlurpClient
         :'expires_at' => :'DateTime',
         :'expires_in' => :'Integer',
         :'favourite' => :'Boolean',
+        :'inbox_type' => :'String',
         :'name' => :'String',
         :'tags' => :'Array<String>',
         :'use_domain_pool' => :'Boolean'
@@ -117,6 +144,10 @@ module MailSlurpClient
         self.favourite = attributes[:'favourite']
       end
 
+      if attributes.key?(:'inbox_type')
+        self.inbox_type = attributes[:'inbox_type']
+      end
+
       if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
@@ -142,9 +173,21 @@ module MailSlurpClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      inbox_type_validator = EnumAttributeValidator.new('String', ["HTTP_INBOX", "SMTP_INBOX"])
+      return false unless inbox_type_validator.valid?(@inbox_type)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] inbox_type Object to be assigned
+    def inbox_type=(inbox_type)
+      validator = EnumAttributeValidator.new('String', ["HTTP_INBOX", "SMTP_INBOX"])
+      unless validator.valid?(inbox_type)
+        fail ArgumentError, "invalid value for \"inbox_type\", must be one of #{validator.allowable_values}."
+      end
+      @inbox_type = inbox_type
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -156,6 +199,7 @@ module MailSlurpClient
           expires_at == o.expires_at &&
           expires_in == o.expires_in &&
           favourite == o.favourite &&
+          inbox_type == o.inbox_type &&
           name == o.name &&
           tags == o.tags &&
           use_domain_pool == o.use_domain_pool
@@ -170,7 +214,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [allow_team_access, description, email_address, expires_at, expires_in, favourite, name, tags, use_domain_pool].hash
+      [allow_team_access, description, email_address, expires_at, expires_in, favourite, inbox_type, name, tags, use_domain_pool].hash
     end
 
     # Builds the object from hash

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/webhook_payload.rb

@@ -0,0 +1,370 @@
+=begin
+#MailSlurp API
+
+#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more.   ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository 
+
+The version of the OpenAPI document: 6.5.2
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+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.
+  class WebhookPayload
+    # List of attachment meta data objects if attachments present
+    attr_accessor :attachment_meta_datas
+
+    # List of `BCC` recipients email was addressed to
+    attr_accessor :bcc
+
+    # List of `CC` recipients email was addressed to
+    attr_accessor :cc
+
+    # Date time of event creation
+    attr_accessor :created_at
+
+    # ID of the email that was received. Use this ID for fetching the email
+    attr_accessor :email_id
+
+    # Name of the event type webhook is being triggered for
+    attr_accessor :event_name
+
+    # Who the email was sent from
+    attr_accessor :from
+
+    # Id of the inbox that receive an email
+    attr_accessor :inbox_id
+
+    # Idempotent message ID. Store this ID locally or in a database to prevent message duplication.
+    attr_accessor :message_id
+
+    # The subject line of the email message
+    attr_accessor :subject
+
+    # List of `To` recipients email was addressed to
+    attr_accessor :to
+
+    # ID of webhook entity being triggered
+    attr_accessor :webhook_id
+
+    # Name of the webhook being triggered
+    attr_accessor :webhook_name
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'attachment_meta_datas' => :'attachmentMetaDatas',
+        :'bcc' => :'bcc',
+        :'cc' => :'cc',
+        :'created_at' => :'createdAt',
+        :'email_id' => :'emailId',
+        :'event_name' => :'eventName',
+        :'from' => :'from',
+        :'inbox_id' => :'inboxId',
+        :'message_id' => :'messageId',
+        :'subject' => :'subject',
+        :'to' => :'to',
+        :'webhook_id' => :'webhookId',
+        :'webhook_name' => :'webhookName'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'attachment_meta_datas' => :'Array<AttachmentMetaData>',
+        :'bcc' => :'Array<String>',
+        :'cc' => :'Array<String>',
+        :'created_at' => :'DateTime',
+        :'email_id' => :'String',
+        :'event_name' => :'String',
+        :'from' => :'String',
+        :'inbox_id' => :'String',
+        :'message_id' => :'String',
+        :'subject' => :'String',
+        :'to' => :'Array<String>',
+        :'webhook_id' => :'String',
+        :'webhook_name' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::WebhookPayload` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `MailSlurpClient::WebhookPayload`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'attachment_meta_datas')
+        if (value = attributes[:'attachment_meta_datas']).is_a?(Array)
+          self.attachment_meta_datas = value
+        end
+      end
+
+      if attributes.key?(:'bcc')
+        if (value = attributes[:'bcc']).is_a?(Array)
+          self.bcc = value
+        end
+      end
+
+      if attributes.key?(:'cc')
+        if (value = attributes[:'cc']).is_a?(Array)
+          self.cc = value
+        end
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'email_id')
+        self.email_id = attributes[:'email_id']
+      end
+
+      if attributes.key?(:'event_name')
+        self.event_name = attributes[:'event_name']
+      end
+
+      if attributes.key?(:'from')
+        self.from = attributes[:'from']
+      end
+
+      if attributes.key?(:'inbox_id')
+        self.inbox_id = attributes[:'inbox_id']
+      end
+
+      if attributes.key?(:'message_id')
+        self.message_id = attributes[:'message_id']
+      end
+
+      if attributes.key?(:'subject')
+        self.subject = attributes[:'subject']
+      end
+
+      if attributes.key?(:'to')
+        if (value = attributes[:'to']).is_a?(Array)
+          self.to = value
+        end
+      end
+
+      if attributes.key?(:'webhook_id')
+        self.webhook_id = attributes[:'webhook_id']
+      end
+
+      if attributes.key?(:'webhook_name')
+        self.webhook_name = attributes[:'webhook_name']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      event_name_validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED"])
+      return false unless event_name_validator.valid?(@event_name)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] event_name Object to be assigned
+    def event_name=(event_name)
+      validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED"])
+      unless validator.valid?(event_name)
+        fail ArgumentError, "invalid value for \"event_name\", must be one of #{validator.allowable_values}."
+      end
+      @event_name = event_name
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          attachment_meta_datas == o.attachment_meta_datas &&
+          bcc == o.bcc &&
+          cc == o.cc &&
+          created_at == o.created_at &&
+          email_id == o.email_id &&
+          event_name == o.event_name &&
+          from == o.from &&
+          inbox_id == o.inbox_id &&
+          message_id == o.message_id &&
+          subject == o.subject &&
+          to == o.to &&
+          webhook_id == o.webhook_id &&
+          webhook_name == o.webhook_name
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [attachment_meta_datas, bcc, cc, created_at, email_id, event_name, from, inbox_id, message_id, subject, to, webhook_id, webhook_name].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        MailSlurpClient.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+        
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/mailslurp_client/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailslurp_client
 version: !ruby/object:Gem::Version
-  version: 11.8.9
+  version: 11.9.0
 platform: ruby
 authors:
 - mailslurp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-26 00:00:00.000000000 Z
+date: 2021-05-02 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.
@@ -130,6 +130,7 @@ files:
 - lib/mailslurp_client/models/verify_email_address_options.rb
 - lib/mailslurp_client/models/wait_for_conditions.rb
 - lib/mailslurp_client/models/webhook_dto.rb
+- lib/mailslurp_client/models/webhook_payload.rb
 - lib/mailslurp_client/models/webhook_projection.rb
 - lib/mailslurp_client/models/webhook_test_request.rb
 - lib/mailslurp_client/models/webhook_test_response.rb