mailslurp_client 15.7.17 → 15.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a535b061f207d73a7900a31e1d48e547e0d911023fd588c833a2f18ae5a8400e
-  data.tar.gz: 35873ce71eba9f91a76b2a4666d7380c37dc97cfac6c9800f8dd6130756b824a
+  metadata.gz: 0cd94528b624d05b2418a77d42dda159fb84dd1190ad634ee0a0a26727815476
+  data.tar.gz: fb9d8fe02d0fd089bcb14f288182122f52ae85f9426432fd08301255c1f9cd13
 SHA512:
-  metadata.gz: a4aee9eea79d3e53881c3910084d0f4f5ef756f7b878f27393e3c4116216b9db6090053f1396cd79b1c24157bab6618cdba3a0669d05af88917a5853ec7974ad
-  data.tar.gz: 62b2aa11fc2d07ed90ff84a7b644a4e486659ac83f19111dddc18ac7c11c83bf4014174f5730ae7fb42e438ffbd30753f3676b40be999d0e32d38db9e8b36650
+  metadata.gz: 5eac32cda727ea19453a202f6a8030b215f1bd899f76e4e4a8e0abb20837d73961cc55b6ddec1ad3ca039e81d815c651fba39282a188283056c7bd0dd35fdad1
+  data.tar.gz: 2a286f8a8426ba315c3a16aa7b4c70928c5daeff1af918eb461059f85d81a7d580518d8cb5ab1c928eda9cb7d85aa53a665bb236594ae643a9021d7515be7e8a

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,29 +19,29 @@ module MailSlurpClient
 
     attr_accessor :id
 
-    attr_accessor :created_at
+    attr_accessor :inbox_id
 
     attr_accessor :user_id
 
     attr_accessor :email_address
 
-    attr_accessor :inbox_id
+    attr_accessor :updated_at
 
-    attr_accessor :use_threads
+    attr_accessor :created_at
 
-    attr_accessor :updated_at
+    attr_accessor :use_threads
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'name' => :'name',
         :'id' => :'id',
-        :'created_at' => :'createdAt',
+        :'inbox_id' => :'inboxId',
         :'user_id' => :'userId',
         :'email_address' => :'emailAddress',
-        :'inbox_id' => :'inboxId',
-        :'use_threads' => :'useThreads',
-        :'updated_at' => :'updatedAt'
+        :'updated_at' => :'updatedAt',
+        :'created_at' => :'createdAt',
+        :'use_threads' => :'useThreads'
       }
     end
 
@@ -50,12 +50,12 @@ module MailSlurpClient
       {
         :'name' => :'String',
         :'id' => :'String',
-        :'created_at' => :'DateTime',
+        :'inbox_id' => :'String',
         :'user_id' => :'String',
         :'email_address' => :'String',
-        :'inbox_id' => :'String',
-        :'use_threads' => :'Boolean',
-        :'updated_at' => :'DateTime'
+        :'updated_at' => :'DateTime',
+        :'created_at' => :'DateTime',
+        :'use_threads' => :'Boolean'
       }
     end
 
@@ -88,8 +88,8 @@ module MailSlurpClient
         self.id = attributes[:'id']
       end
 
-      if attributes.key?(:'created_at')
-        self.created_at = attributes[:'created_at']
+      if attributes.key?(:'inbox_id')
+        self.inbox_id = attributes[:'inbox_id']
       end
 
       if attributes.key?(:'user_id')
@@ -100,16 +100,16 @@ module MailSlurpClient
         self.email_address = attributes[:'email_address']
       end
 
-      if attributes.key?(:'inbox_id')
-        self.inbox_id = attributes[:'inbox_id']
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
       end
 
-      if attributes.key?(:'use_threads')
-        self.use_threads = attributes[:'use_threads']
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
       end
 
-      if attributes.key?(:'updated_at')
-        self.updated_at = attributes[:'updated_at']
+      if attributes.key?(:'use_threads')
+        self.use_threads = attributes[:'use_threads']
       end
     end
 
@@ -121,8 +121,8 @@ 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.')
+      if @inbox_id.nil?
+        invalid_properties.push('invalid value for "inbox_id", inbox_id cannot be nil.')
       end
 
       if @user_id.nil?
@@ -133,14 +133,14 @@ module MailSlurpClient
         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.')
-      end
-
       if @updated_at.nil?
         invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
       end
 
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -148,11 +148,11 @@ 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 @inbox_id.nil?
       return false if @user_id.nil?
       return false if @email_address.nil?
-      return false if @inbox_id.nil?
       return false if @updated_at.nil?
+      return false if @created_at.nil?
       true
     end
 
@@ -163,12 +163,12 @@ module MailSlurpClient
       self.class == o.class &&
           name == o.name &&
           id == o.id &&
-          created_at == o.created_at &&
+          inbox_id == o.inbox_id &&
           user_id == o.user_id &&
           email_address == o.email_address &&
-          inbox_id == o.inbox_id &&
-          use_threads == o.use_threads &&
-          updated_at == o.updated_at
+          updated_at == o.updated_at &&
+          created_at == o.created_at &&
+          use_threads == o.use_threads
     end
 
     # @see the `==` method
@@ -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, user_id, email_address, updated_at, created_at, use_threads].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/attachment_projection.rb

@@ -20,11 +20,6 @@ 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
@@ -32,16 +27,21 @@ module MailSlurpClient
 
     attr_accessor :updated_at
 
+    attr_accessor :created_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'
+        :'updated_at' => :'updatedAt',
+        :'created_at' => :'createdAt',
+        :'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'
+        :'updated_at' => :'DateTime',
+        :'created_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
@@ -106,16 +98,20 @@ module MailSlurpClient
       if attributes.key?(:'updated_at')
         self.updated_at = attributes[:'updated_at']
       end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_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
@@ -128,16 +124,20 @@ module MailSlurpClient
         invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
       end
 
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
       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?
-      return false if @created_at.nil?
       return false if @user_id.nil?
       return false if @attachment_id.nil?
       return false if @updated_at.nil?
+      return false if @created_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
+          updated_at == o.updated_at &&
+          created_at == o.created_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, updated_at, created_at, content_type].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/create_template_options.rb

@@ -13,10 +13,12 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
-  # Options for creating email templates
+  # Create template options
   class CreateTemplateOptions
+    # Name of template
     attr_accessor :name
 
+    # Template content. Can include moustache style variables such as {{var_name}}
     attr_accessor :content
 
     # Attribute mapping from ruby-style variable name to JSON key.