mailslurp_client 15.7.16 → 15.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bdf6204c13a67023421303a8ae72ff9cc3968ae5bcb6e73315a9b8e50889a32
-  data.tar.gz: 9267034416c67df0873c6705f8bc59e65a5d425e9da0422ece0580f13ba21a90
+  metadata.gz: 4c57b9ba3a7c06a9bf126689e80920a1e0eae9be28a03bdea3b724cad4ab100f
+  data.tar.gz: 1290b7e2f2e09d23c22f1be518b6cad3299c473f0bb5abb6b8b455c59852a5be
 SHA512:
-  metadata.gz: 040ca454d24aac9237ac85474e5628ec9052e328f42ac49c47567430caa7f4afbe6e69dfff1242a656fe011e06e3069312a4d40c9104a2dd0995eaec4dbe2e53
-  data.tar.gz: 135ea65e05534ddb61c53dff71557f34610a75e0e507edf7a71d37bebbabcd2924b10973cbe133f9d57dd568b65020c76b15f013e10cf7fbe6fbe5f58bc10fa2
+  metadata.gz: 9a3027477ae43a11e1298f6c06c69ca79ec9858732375c06b70b283d0ae4414f83367f7471ba3751c7842ff4b44aafb9c553344d6564cd65d220087639144cb6
+  data.tar.gz: ea9ae376f7209b22aa3c9cf54769ba16f15bda619ce2bb78e4a19f4b7b5bda04a804c8fef92114b6733327a1f323d0767eeb2cfd26aead8e1e1e0e89554d9f05

data/lib/mailslurp_client/api/inbox_controller_api.rb

@@ -2019,7 +2019,7 @@ module MailSlurpClient
 
     # Set inbox favourited state
     # Set and return new favourite state for an inbox
-    # @param inbox_id [String] 
+    # @param inbox_id [String] ID of inbox to set favourite state
     # @param set_inbox_favourited_options [SetInboxFavouritedOptions] 
     # @param [Hash] opts the optional parameters
     # @return [InboxDto]
@@ -2030,7 +2030,7 @@ module MailSlurpClient
 
     # Set inbox favourited state
     # Set and return new favourite state for an inbox
-    # @param inbox_id [String] 
+    # @param inbox_id [String] ID of inbox to set favourite state
     # @param set_inbox_favourited_options [SetInboxFavouritedOptions] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(InboxDto, Integer, Hash)>] InboxDto data, response status code and response headers

data/lib/mailslurp_client/api/template_controller_api.rb

@@ -20,6 +20,7 @@ module MailSlurpClient
       @api_client = api_client
     end
     # Create a Template
+    # Create an email template with variables for use with templated transactional emails.
     # @param create_template_options [CreateTemplateOptions] 
     # @param [Hash] opts the optional parameters
     # @return [TemplateDto]
@@ -29,6 +30,7 @@ module MailSlurpClient
     end
 
     # Create a Template
+    # Create an email template with variables for use with templated transactional emails.
     # @param create_template_options [CreateTemplateOptions] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(TemplateDto, Integer, Hash)>] TemplateDto data, response status code and response headers
@@ -81,8 +83,9 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Delete Template
-    # @param template_id [String] 
+    # Delete email template
+    # Delete template
+    # @param template_id [String] Template ID
     # @param [Hash] opts the optional parameters
     # @return [nil]
     def delete_template(template_id, opts = {})
@@ -90,8 +93,9 @@ module MailSlurpClient
       nil
     end
 
-    # Delete Template
-    # @param template_id [String] 
+    # Delete email template
+    # Delete template
+    # @param template_id [String] Template ID
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def delete_template_with_http_info(template_id, opts = {})
@@ -139,7 +143,8 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get all Templates in paginated format
+    # List templates
+    # Get all templates in paginated format
     # @param [Hash] opts the optional parameters
     # @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)
@@ -152,7 +157,8 @@ module MailSlurpClient
       data
     end
 
-    # Get all Templates in paginated format
+    # List templates
+    # Get all templates in paginated format
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page Optional page index in list pagination
     # @option opts [Integer] :size Optional page size in list pagination
@@ -212,8 +218,9 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get Template
-    # @param template_id [String] 
+    # Get template
+    # Get email template
+    # @param template_id [String] Template ID
     # @param [Hash] opts the optional parameters
     # @return [TemplateDto]
     def get_template(template_id, opts = {})
@@ -221,8 +228,9 @@ module MailSlurpClient
       data
     end
 
-    # Get Template
-    # @param template_id [String] 
+    # Get template
+    # Get email template
+    # @param template_id [String] Template ID
     # @param [Hash] opts the optional parameters
     # @return [Array<(TemplateDto, Integer, Hash)>] TemplateDto data, response status code and response headers
     def get_template_with_http_info(template_id, opts = {})
@@ -272,7 +280,8 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get all Templates
+    # List templates
+    # Get all templates
     # @param [Hash] opts the optional parameters
     # @return [Array<TemplateProjection>]
     def get_templates(opts = {})
@@ -280,7 +289,8 @@ module MailSlurpClient
       data
     end
 
-    # Get all Templates
+    # List templates
+    # Get all templates
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<TemplateProjection>, Integer, Hash)>] Array<TemplateProjection> data, response status code and response headers
     def get_templates_with_http_info(opts = {})
@@ -326,8 +336,9 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Update a Template
-    # @param template_id [String] 
+    # Update template
+    # Update email template
+    # @param template_id [String] Template ID
     # @param create_template_options [CreateTemplateOptions] 
     # @param [Hash] opts the optional parameters
     # @return [TemplateDto]
@@ -336,8 +347,9 @@ module MailSlurpClient
       data
     end
 
-    # Update a Template
-    # @param template_id [String] 
+    # Update template
+    # Update email template
+    # @param template_id [String] Template ID
     # @param create_template_options [CreateTemplateOptions] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(TemplateDto, Integer, Hash)>] TemplateDto data, response status code and response headers

data/lib/mailslurp_client/api/webhook_controller_api.rb

@@ -1413,28 +1413,22 @@ module MailSlurpClient
     end
 
     # Get count of unseen webhook results with error status
-    # @param inbox_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [UnseenErrorCountDto]
-    def get_webhook_results_unseen_error_count(inbox_id, opts = {})
-      data, _status_code, _headers = get_webhook_results_unseen_error_count_with_http_info(inbox_id, opts)
+    def get_webhook_results_unseen_error_count(opts = {})
+      data, _status_code, _headers = get_webhook_results_unseen_error_count_with_http_info(opts)
       data
     end
 
     # Get count of unseen webhook results with error status
-    # @param inbox_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(UnseenErrorCountDto, Integer, Hash)>] UnseenErrorCountDto data, response status code and response headers
-    def get_webhook_results_unseen_error_count_with_http_info(inbox_id, opts = {})
+    def get_webhook_results_unseen_error_count_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: WebhookControllerApi.get_webhook_results_unseen_error_count ...'
       end
-      # verify the required parameter 'inbox_id' is set
-      if @api_client.config.client_side_validation && inbox_id.nil?
-        fail ArgumentError, "Missing the required parameter 'inbox_id' when calling WebhookControllerApi.get_webhook_results_unseen_error_count"
-      end
       # resource path
-      local_var_path = '/webhooks/results/unseen-count'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
+      local_var_path = '/webhooks/results/unseen-count'
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -1653,5 +1647,69 @@ module MailSlurpClient
       end
       return data, status_code, headers
     end
+
+    # Verify a webhook payload signature
+    # Verify a webhook payload using the messageId and signature. This allows you to be sure that MailSlurp sent the payload and not another server.
+    # @param verify_webhook_signature_options [VerifyWebhookSignatureOptions] 
+    # @param [Hash] opts the optional parameters
+    # @return [VerifyWebhookSignatureResults]
+    def verify_webhook_signature(verify_webhook_signature_options, opts = {})
+      data, _status_code, _headers = verify_webhook_signature_with_http_info(verify_webhook_signature_options, opts)
+      data
+    end
+
+    # Verify a webhook payload signature
+    # Verify a webhook payload using the messageId and signature. This allows you to be sure that MailSlurp sent the payload and not another server.
+    # @param verify_webhook_signature_options [VerifyWebhookSignatureOptions] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(VerifyWebhookSignatureResults, Integer, Hash)>] VerifyWebhookSignatureResults data, response status code and response headers
+    def verify_webhook_signature_with_http_info(verify_webhook_signature_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhookControllerApi.verify_webhook_signature ...'
+      end
+      # verify the required parameter 'verify_webhook_signature_options' is set
+      if @api_client.config.client_side_validation && verify_webhook_signature_options.nil?
+        fail ArgumentError, "Missing the required parameter 'verify_webhook_signature_options' when calling WebhookControllerApi.verify_webhook_signature"
+      end
+      # resource path
+      local_var_path = '/webhooks/verify'
+
+      # 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(['*/*'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(verify_webhook_signature_options) 
+
+      # return_type
+      return_type = opts[:return_type] || 'VerifyWebhookSignatureResults' 
+
+      # 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: WebhookControllerApi#verify_webhook_signature\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/mailslurp_client/models/abstract_webhook_payload.rb

@@ -17,10 +17,10 @@ module MailSlurpClient
   class AbstractWebhookPayload
     attr_accessor :event_name
 
-    attr_accessor :webhook_id
-
     attr_accessor :message_id
 
+    attr_accessor :webhook_id
+
     attr_accessor :webhook_name
 
     class EnumAttributeValidator
@@ -49,8 +49,8 @@ module MailSlurpClient
     def self.attribute_map
       {
         :'event_name' => :'eventName',
-        :'webhook_id' => :'webhookId',
         :'message_id' => :'messageId',
+        :'webhook_id' => :'webhookId',
         :'webhook_name' => :'webhookName'
       }
     end
@@ -59,8 +59,8 @@ module MailSlurpClient
     def self.openapi_types
       {
         :'event_name' => :'String',
-        :'webhook_id' => :'String',
         :'message_id' => :'String',
+        :'webhook_id' => :'String',
         :'webhook_name' => :'String'
       }
     end
@@ -90,14 +90,14 @@ module MailSlurpClient
         self.event_name = attributes[:'event_name']
       end
 
-      if attributes.key?(:'webhook_id')
-        self.webhook_id = attributes[:'webhook_id']
-      end
-
       if attributes.key?(:'message_id')
         self.message_id = attributes[:'message_id']
       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
@@ -111,14 +111,14 @@ module MailSlurpClient
         invalid_properties.push('invalid value for "event_name", event_name cannot be nil.')
       end
 
-      if @webhook_id.nil?
-        invalid_properties.push('invalid value for "webhook_id", webhook_id cannot be nil.')
-      end
-
       if @message_id.nil?
         invalid_properties.push('invalid value for "message_id", message_id cannot be nil.')
       end
 
+      if @webhook_id.nil?
+        invalid_properties.push('invalid value for "webhook_id", webhook_id cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -128,8 +128,8 @@ module MailSlurpClient
       return false if @event_name.nil?
       event_name_validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ", "BOUNCE", "BOUNCE_RECIPIENT"])
       return false unless event_name_validator.valid?(@event_name)
-      return false if @webhook_id.nil?
       return false if @message_id.nil?
+      return false if @webhook_id.nil?
       true
     end
 
@@ -149,8 +149,8 @@ module MailSlurpClient
       return true if self.equal?(o)
       self.class == o.class &&
           event_name == o.event_name &&
-          webhook_id == o.webhook_id &&
           message_id == o.message_id &&
+          webhook_id == o.webhook_id &&
           webhook_name == o.webhook_name
     end
 
@@ -163,7 +163,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [event_name, webhook_id, message_id, webhook_name].hash
+      [event_name, message_id, webhook_id, webhook_name].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/alias_projection.rb

@@ -19,16 +19,16 @@ module MailSlurpClient
 
     attr_accessor :id
 
-    attr_accessor :created_at
-
-    attr_accessor :user_id
+    attr_accessor :inbox_id
 
     attr_accessor :email_address
 
-    attr_accessor :inbox_id
+    attr_accessor :user_id
 
     attr_accessor :use_threads
 
+    attr_accessor :created_at
+
     attr_accessor :updated_at
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -36,11 +36,11 @@ module MailSlurpClient
       {
         :'name' => :'name',
         :'id' => :'id',
-        :'created_at' => :'createdAt',
-        :'user_id' => :'userId',
-        :'email_address' => :'emailAddress',
         :'inbox_id' => :'inboxId',
+        :'email_address' => :'emailAddress',
+        :'user_id' => :'userId',
         :'use_threads' => :'useThreads',
+        :'created_at' => :'createdAt',
         :'updated_at' => :'updatedAt'
       }
     end
@@ -50,11 +50,11 @@ module MailSlurpClient
       {
         :'name' => :'String',
         :'id' => :'String',
-        :'created_at' => :'DateTime',
-        :'user_id' => :'String',
-        :'email_address' => :'String',
         :'inbox_id' => :'String',
+        :'email_address' => :'String',
+        :'user_id' => :'String',
         :'use_threads' => :'Boolean',
+        :'created_at' => :'DateTime',
         :'updated_at' => :'DateTime'
       }
     end
@@ -88,26 +88,26 @@ module MailSlurpClient
         self.id = attributes[:'id']
       end
 
-      if attributes.key?(:'created_at')
-        self.created_at = attributes[:'created_at']
-      end
-
-      if attributes.key?(:'user_id')
-        self.user_id = attributes[:'user_id']
+      if attributes.key?(:'inbox_id')
+        self.inbox_id = attributes[:'inbox_id']
       end
 
       if attributes.key?(:'email_address')
         self.email_address = attributes[:'email_address']
       end
 
-      if attributes.key?(:'inbox_id')
-        self.inbox_id = attributes[:'inbox_id']
+      if attributes.key?(:'user_id')
+        self.user_id = attributes[:'user_id']
       end
 
       if attributes.key?(:'use_threads')
         self.use_threads = attributes[:'use_threads']
       end
 
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
       if attributes.key?(:'updated_at')
         self.updated_at = attributes[:'updated_at']
       end
@@ -121,20 +121,20 @@ module MailSlurpClient
         invalid_properties.push('invalid value for "id", id cannot be nil.')
       end
 
-      if @created_at.nil?
-        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
-      end
-
-      if @user_id.nil?
-        invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
+      if @inbox_id.nil?
+        invalid_properties.push('invalid value for "inbox_id", inbox_id cannot be nil.')
       end
 
       if @email_address.nil?
         invalid_properties.push('invalid value for "email_address", email_address cannot be nil.')
       end
 
-      if @inbox_id.nil?
-        invalid_properties.push('invalid value for "inbox_id", inbox_id cannot be nil.')
+      if @user_id.nil?
+        invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
       end
 
       if @updated_at.nil?
@@ -148,10 +148,10 @@ module MailSlurpClient
     # @return true if the model is valid
     def valid?
       return false if @id.nil?
-      return false if @created_at.nil?
-      return false if @user_id.nil?
-      return false if @email_address.nil?
       return false if @inbox_id.nil?
+      return false if @email_address.nil?
+      return false if @user_id.nil?
+      return false if @created_at.nil?
       return false if @updated_at.nil?
       true
     end
@@ -163,11 +163,11 @@ module MailSlurpClient
       self.class == o.class &&
           name == o.name &&
           id == o.id &&
-          created_at == o.created_at &&
-          user_id == o.user_id &&
-          email_address == o.email_address &&
           inbox_id == o.inbox_id &&
+          email_address == o.email_address &&
+          user_id == o.user_id &&
           use_threads == o.use_threads &&
+          created_at == o.created_at &&
           updated_at == o.updated_at
     end
 
@@ -180,7 +180,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, id, created_at, user_id, email_address, inbox_id, use_threads, updated_at].hash
+      [name, id, inbox_id, email_address, user_id, use_threads, created_at, updated_at].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/attachment_projection.rb

@@ -20,28 +20,28 @@ module MailSlurpClient
     # Content length of attachment in bytes
     attr_accessor :content_length
 
-    # Content type of attachment.
-    attr_accessor :content_type
-
-    attr_accessor :created_at
-
     attr_accessor :user_id
 
     # Attachment ID
     attr_accessor :attachment_id
 
+    attr_accessor :created_at
+
     attr_accessor :updated_at
 
+    # Content type of attachment.
+    attr_accessor :content_type
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'name' => :'name',
         :'content_length' => :'contentLength',
-        :'content_type' => :'contentType',
-        :'created_at' => :'createdAt',
         :'user_id' => :'userId',
         :'attachment_id' => :'attachmentId',
-        :'updated_at' => :'updatedAt'
+        :'created_at' => :'createdAt',
+        :'updated_at' => :'updatedAt',
+        :'content_type' => :'contentType'
       }
     end
 
@@ -50,11 +50,11 @@ module MailSlurpClient
       {
         :'name' => :'String',
         :'content_length' => :'Integer',
-        :'content_type' => :'String',
-        :'created_at' => :'DateTime',
         :'user_id' => :'String',
         :'attachment_id' => :'String',
-        :'updated_at' => :'DateTime'
+        :'created_at' => :'DateTime',
+        :'updated_at' => :'DateTime',
+        :'content_type' => :'String'
       }
     end
 
@@ -87,14 +87,6 @@ module MailSlurpClient
         self.content_length = attributes[:'content_length']
       end
 
-      if attributes.key?(:'content_type')
-        self.content_type = attributes[:'content_type']
-      end
-
-      if attributes.key?(:'created_at')
-        self.created_at = attributes[:'created_at']
-      end
-
       if attributes.key?(:'user_id')
         self.user_id = attributes[:'user_id']
       end
@@ -103,19 +95,23 @@ module MailSlurpClient
         self.attachment_id = attributes[:'attachment_id']
       end
 
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
       if attributes.key?(:'updated_at')
         self.updated_at = attributes[:'updated_at']
       end
+
+      if attributes.key?(:'content_type')
+        self.content_type = attributes[:'content_type']
+      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
-      if @created_at.nil?
-        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
-      end
-
       if @user_id.nil?
         invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
       end
@@ -124,6 +120,10 @@ module MailSlurpClient
         invalid_properties.push('invalid value for "attachment_id", attachment_id cannot be nil.')
       end
 
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
       if @updated_at.nil?
         invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
       end
@@ -134,9 +134,9 @@ module MailSlurpClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      return false if @created_at.nil?
       return false if @user_id.nil?
       return false if @attachment_id.nil?
+      return false if @created_at.nil?
       return false if @updated_at.nil?
       true
     end
@@ -148,11 +148,11 @@ module MailSlurpClient
       self.class == o.class &&
           name == o.name &&
           content_length == o.content_length &&
-          content_type == o.content_type &&
-          created_at == o.created_at &&
           user_id == o.user_id &&
           attachment_id == o.attachment_id &&
-          updated_at == o.updated_at
+          created_at == o.created_at &&
+          updated_at == o.updated_at &&
+          content_type == o.content_type
     end
 
     # @see the `==` method
@@ -164,7 +164,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, content_length, content_type, created_at, user_id, attachment_id, updated_at].hash
+      [name, content_length, user_id, attachment_id, created_at, updated_at, content_type].hash
     end
 
     # Builds the object from hash