mailslurp_client 15.7.13 → 15.7.16

data/lib/mailslurp_client/models/email.rb

@@ -81,6 +81,8 @@ module MailSlurpClient
     # Can the email be accessed by organization team members
     attr_accessor :team_access
 
+    attr_accessor :html
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -106,7 +108,8 @@ module MailSlurpClient
         :'created_at' => :'createdAt',
         :'updated_at' => :'updatedAt',
         :'read' => :'read',
-        :'team_access' => :'teamAccess'
+        :'team_access' => :'teamAccess',
+        :'html' => :'html'
       }
     end
 
@@ -135,7 +138,8 @@ module MailSlurpClient
         :'created_at' => :'DateTime',
         :'updated_at' => :'DateTime',
         :'read' => :'Boolean',
-        :'team_access' => :'Boolean'
+        :'team_access' => :'Boolean',
+        :'html' => :'Boolean'
       }
     end
 
@@ -261,6 +265,10 @@ module MailSlurpClient
       if attributes.key?(:'team_access')
         self.team_access = attributes[:'team_access']
       end
+
+      if attributes.key?(:'html')
+        self.html = attributes[:'html']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -343,7 +351,8 @@ module MailSlurpClient
           created_at == o.created_at &&
           updated_at == o.updated_at &&
           read == o.read &&
-          team_access == o.team_access
+          team_access == o.team_access &&
+          html == o.html
     end
 
     # @see the `==` method
@@ -355,7 +364,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, user_id, inbox_id, to, from, sender, recipients, reply_to, cc, bcc, headers, attachments, subject, body, body_excerpt, body_md5_hash, is_html, charset, analysis, created_at, updated_at, read, team_access].hash
+      [id, user_id, inbox_id, to, from, sender, recipients, reply_to, cc, bcc, headers, attachments, subject, body, body_excerpt, body_md5_hash, is_html, charset, analysis, created_at, updated_at, read, team_access, html].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/email_preview_urls.rb

@@ -13,6 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # URLs for email body
   class EmailPreviewUrls
     attr_accessor :raw_smtp_message_url
 

data/lib/mailslurp_client/models/email_projection.rb

@@ -21,17 +21,19 @@ module MailSlurpClient
 
     attr_accessor :subject
 
-    attr_accessor :attachments
+    attr_accessor :created_at
 
     attr_accessor :inbox_id
 
+    attr_accessor :attachments
+
     attr_accessor :to
 
     attr_accessor :bcc
 
     attr_accessor :cc
 
-    attr_accessor :created_at
+    attr_accessor :team_access
 
     attr_accessor :read
 
@@ -39,24 +41,22 @@ module MailSlurpClient
 
     attr_accessor :body_excerpt
 
-    attr_accessor :team_access
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'id' => :'id',
         :'from' => :'from',
         :'subject' => :'subject',
-        :'attachments' => :'attachments',
+        :'created_at' => :'createdAt',
         :'inbox_id' => :'inboxId',
+        :'attachments' => :'attachments',
         :'to' => :'to',
         :'bcc' => :'bcc',
         :'cc' => :'cc',
-        :'created_at' => :'createdAt',
+        :'team_access' => :'teamAccess',
         :'read' => :'read',
         :'body_md5_hash' => :'bodyMD5Hash',
-        :'body_excerpt' => :'bodyExcerpt',
-        :'team_access' => :'teamAccess'
+        :'body_excerpt' => :'bodyExcerpt'
       }
     end
 
@@ -66,16 +66,16 @@ module MailSlurpClient
         :'id' => :'String',
         :'from' => :'String',
         :'subject' => :'String',
-        :'attachments' => :'Array<String>',
+        :'created_at' => :'DateTime',
         :'inbox_id' => :'String',
+        :'attachments' => :'Array<String>',
         :'to' => :'Array<String>',
         :'bcc' => :'Array<String>',
         :'cc' => :'Array<String>',
-        :'created_at' => :'DateTime',
+        :'team_access' => :'Boolean',
         :'read' => :'Boolean',
         :'body_md5_hash' => :'String',
-        :'body_excerpt' => :'String',
-        :'team_access' => :'Boolean'
+        :'body_excerpt' => :'String'
       }
     end
 
@@ -112,16 +112,20 @@ module MailSlurpClient
         self.subject = attributes[:'subject']
       end
 
-      if attributes.key?(:'attachments')
-        if (value = attributes[:'attachments']).is_a?(Array)
-          self.attachments = value
-        end
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
       end
 
       if attributes.key?(:'inbox_id')
         self.inbox_id = attributes[:'inbox_id']
       end
 
+      if attributes.key?(:'attachments')
+        if (value = attributes[:'attachments']).is_a?(Array)
+          self.attachments = value
+        end
+      end
+
       if attributes.key?(:'to')
         if (value = attributes[:'to']).is_a?(Array)
           self.to = value
@@ -140,8 +144,8 @@ module MailSlurpClient
         end
       end
 
-      if attributes.key?(:'created_at')
-        self.created_at = attributes[:'created_at']
+      if attributes.key?(:'team_access')
+        self.team_access = attributes[:'team_access']
       end
 
       if attributes.key?(:'read')
@@ -155,10 +159,6 @@ module MailSlurpClient
       if attributes.key?(:'body_excerpt')
         self.body_excerpt = attributes[:'body_excerpt']
       end
-
-      if attributes.key?(:'team_access')
-        self.team_access = attributes[:'team_access']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -169,6 +169,10 @@ 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 @inbox_id.nil?
         invalid_properties.push('invalid value for "inbox_id", inbox_id cannot be nil.')
       end
@@ -177,10 +181,6 @@ module MailSlurpClient
         invalid_properties.push('invalid value for "to", to 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
 
@@ -188,9 +188,9 @@ 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 @to.nil?
-      return false if @created_at.nil?
       true
     end
 
@@ -202,16 +202,16 @@ module MailSlurpClient
           id == o.id &&
           from == o.from &&
           subject == o.subject &&
-          attachments == o.attachments &&
+          created_at == o.created_at &&
           inbox_id == o.inbox_id &&
+          attachments == o.attachments &&
           to == o.to &&
           bcc == o.bcc &&
           cc == o.cc &&
-          created_at == o.created_at &&
+          team_access == o.team_access &&
           read == o.read &&
           body_md5_hash == o.body_md5_hash &&
-          body_excerpt == o.body_excerpt &&
-          team_access == o.team_access
+          body_excerpt == o.body_excerpt
     end
 
     # @see the `==` method
@@ -223,7 +223,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, from, subject, attachments, inbox_id, to, bcc, cc, created_at, read, body_md5_hash, body_excerpt, team_access].hash
+      [id, from, subject, created_at, inbox_id, attachments, to, bcc, cc, team_access, read, body_md5_hash, body_excerpt].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/email_validation_request.rb

@@ -13,6 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # Email validation request
   class EmailValidationRequest
     attr_accessor :id
 

data/lib/mailslurp_client/models/expired_inbox_record_projection.rb

@@ -13,22 +13,23 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # Record of inbox expiration
   class ExpiredInboxRecordProjection
     attr_accessor :id
 
+    attr_accessor :created_at
+
     attr_accessor :user_id
 
     attr_accessor :email_address
 
-    attr_accessor :created_at
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'id' => :'id',
+        :'created_at' => :'createdAt',
         :'user_id' => :'userId',
-        :'email_address' => :'emailAddress',
-        :'created_at' => :'createdAt'
+        :'email_address' => :'emailAddress'
       }
     end
 
@@ -36,9 +37,9 @@ module MailSlurpClient
     def self.openapi_types
       {
         :'id' => :'String',
+        :'created_at' => :'DateTime',
         :'user_id' => :'String',
-        :'email_address' => :'String',
-        :'created_at' => :'DateTime'
+        :'email_address' => :'String'
       }
     end
 
@@ -67,6 +68,10 @@ 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']
       end
@@ -74,10 +79,6 @@ module MailSlurpClient
       if attributes.key?(:'email_address')
         self.email_address = attributes[:'email_address']
       end
-
-      if attributes.key?(:'created_at')
-        self.created_at = attributes[:'created_at']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -88,6 +89,10 @@ 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.')
       end
@@ -96,10 +101,6 @@ module MailSlurpClient
         invalid_properties.push('invalid value for "email_address", email_address 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
 
@@ -107,9 +108,9 @@ 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 @created_at.nil?
       true
     end
 
@@ -119,9 +120,9 @@ module MailSlurpClient
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
+          created_at == o.created_at &&
           user_id == o.user_id &&
-          email_address == o.email_address &&
-          created_at == o.created_at
+          email_address == o.email_address
     end
 
     # @see the `==` method
@@ -133,7 +134,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, user_id, email_address, created_at].hash
+      [id, created_at, user_id, email_address].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/filter_bounced_recipients_options.rb

@@ -13,6 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # Options for filtering bounced email recipients
   class FilterBouncedRecipientsOptions
     attr_accessor :email_recipients
 

data/lib/mailslurp_client/models/filter_bounced_recipients_result.rb

@@ -13,6 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # Remaining recipients that were filtered to remove bounced recipients
   class FilterBouncedRecipientsResult
     attr_accessor :filtered_recipients
 

data/lib/mailslurp_client/models/flush_expired_inboxes_result.rb

@@ -13,6 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # Result from calling expire on any inboxes that have applicable expiration dates given current time.
   class FlushExpiredInboxesResult
     attr_accessor :inbox_ids
 

data/lib/mailslurp_client/models/gravatar_url.rb

@@ -13,6 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # User image
   class GravatarUrl
     attr_accessor :url
 

data/lib/mailslurp_client/models/group_contacts_dto.rb

@@ -13,6 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # Describes contacts attached to a contact group
   class GroupContactsDto
     attr_accessor :group
 

data/lib/mailslurp_client/models/group_dto.rb

@@ -13,6 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # Contact group data
   class GroupDto
     attr_accessor :id
 

data/lib/mailslurp_client/models/group_projection.rb

@@ -13,6 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # Data for contact group
   class GroupProjection
     attr_accessor :name
 

data/lib/mailslurp_client/models/imap_flag_operation_options.rb

@@ -13,6 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # IMAP operation flags
   class ImapFlagOperationOptions
     attr_accessor :flag_operation
 

data/lib/mailslurp_client/models/imap_smtp_access_details.rb

@@ -13,21 +13,30 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # Access details for inbox using SMTP or IMAP
   class ImapSmtpAccessDetails
+    # SMTP server host domain
     attr_accessor :smtp_server_host
 
+    # SMTP server host port
     attr_accessor :smtp_server_port
 
+    # SMTP username for login
     attr_accessor :smtp_username
 
+    # SMTP  for login
     attr_accessor :smtp_password
 
+    # IMAP server host domain
     attr_accessor :imap_server_host
 
+    # IMAP server host port
     attr_accessor :imap_server_port
 
+    # IMAP username for login
     attr_accessor :imap_username
 
+    # IMAP password for login
     attr_accessor :imap_password
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/mailslurp_client/models/inbox_by_email_address_result.rb

@@ -13,6 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # Result of search for inbox by email address
   class InboxByEmailAddressResult
     attr_accessor :inbox_id
 

data/lib/mailslurp_client/models/inbox_dto.rb

@@ -48,6 +48,9 @@ module MailSlurpClient
     # 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
 
+    # Virtual inbox can receive email but will not send emails to real recipients. Will save sent email record but never send an actual email. Perfect for testing mail server actions.
+    attr_accessor :virtual_inbox
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -83,7 +86,8 @@ module MailSlurpClient
         :'favourite' => :'favourite',
         :'tags' => :'tags',
         :'inbox_type' => :'inboxType',
-        :'read_only' => :'readOnly'
+        :'read_only' => :'readOnly',
+        :'virtual_inbox' => :'virtualInbox'
       }
     end
 
@@ -100,7 +104,8 @@ module MailSlurpClient
         :'favourite' => :'Boolean',
         :'tags' => :'Array<String>',
         :'inbox_type' => :'String',
-        :'read_only' => :'Boolean'
+        :'read_only' => :'Boolean',
+        :'virtual_inbox' => :'Boolean'
       }
     end
 
@@ -170,6 +175,10 @@ module MailSlurpClient
       if attributes.key?(:'read_only')
         self.read_only = attributes[:'read_only']
       end
+
+      if attributes.key?(:'virtual_inbox')
+        self.virtual_inbox = attributes[:'virtual_inbox']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -196,6 +205,10 @@ module MailSlurpClient
         invalid_properties.push('invalid value for "read_only", read_only cannot be nil.')
       end
 
+      if @virtual_inbox.nil?
+        invalid_properties.push('invalid value for "virtual_inbox", virtual_inbox cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -209,6 +222,7 @@ module MailSlurpClient
       inbox_type_validator = EnumAttributeValidator.new('String', ["HTTP_INBOX", "SMTP_INBOX"])
       return false unless inbox_type_validator.valid?(@inbox_type)
       return false if @read_only.nil?
+      return false if @virtual_inbox.nil?
       true
     end
 
@@ -237,7 +251,8 @@ module MailSlurpClient
           favourite == o.favourite &&
           tags == o.tags &&
           inbox_type == o.inbox_type &&
-          read_only == o.read_only
+          read_only == o.read_only &&
+          virtual_inbox == o.virtual_inbox
     end
 
     # @see the `==` method
@@ -249,7 +264,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, user_id, created_at, name, description, email_address, expires_at, favourite, tags, inbox_type, read_only].hash
+      [id, user_id, created_at, name, description, email_address, expires_at, favourite, tags, inbox_type, read_only, virtual_inbox].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/inbox_exists_dto.rb

@@ -13,6 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # Result of email exists query
   class InboxExistsDto
     attr_accessor :exists
 

data/lib/mailslurp_client/models/inbox_forwarder_dto.rb

@@ -13,6 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # Inbox forwarder
   class InboxForwarderDto
     attr_accessor :id
 

data/lib/mailslurp_client/models/inbox_forwarder_test_options.rb

@@ -13,6 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # Options for testing an inbox forwarder against a value
   class InboxForwarderTestOptions
     attr_accessor :test_value
 

data/lib/mailslurp_client/models/inbox_forwarder_test_result.rb

@@ -13,6 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # Results of inbox forwarder test
   class InboxForwarderTestResult
     attr_accessor :matches
 

data/lib/mailslurp_client/models/inbox_id_item.rb

@@ -13,6 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # Inbox ID and email address pair
   class InboxIdItem
     attr_accessor :id
 

data/lib/mailslurp_client/models/inbox_ids_result.rb

@@ -13,6 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # List of inbox IDs and email addresses
   class InboxIdsResult
     attr_accessor :inbox_ids
 

data/lib/mailslurp_client/models/inbox_preview.rb

@@ -13,6 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # Inbox data
   class InboxPreview
     # ID of the inbox. The ID is a UUID-V4 format string. Use the inboxId for calls to Inbox and Email Controller endpoints. See the emailAddress property for the email address or the inbox. To get emails in an inbox use the WaitFor and Inbox Controller methods `waitForLatestEmail` and `getEmails` methods respectively. Inboxes can be used with aliases to forward emails automatically.
     attr_accessor :id
@@ -38,6 +39,9 @@ module MailSlurpClient
     # Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send).
     attr_accessor :inbox_type
 
+    # Virtual inbox can receive email but will not send emails to real recipients. Will save sent email record but never send an actual email. Perfect for testing mail server actions.
+    attr_accessor :virtual_inbox
+
     # Inbox expiration time. When, if ever, the inbox should expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. This is the default behavior unless expiration date is set. If an expiration date is set and the time is reached MailSlurp will expire the inbox and move it to an expired inbox entity. You can still access the emails belonging to it but it can no longer send or receive email.
     attr_accessor :expires_at
 
@@ -74,6 +78,7 @@ module MailSlurpClient
         :'tags' => :'tags',
         :'team_access' => :'teamAccess',
         :'inbox_type' => :'inboxType',
+        :'virtual_inbox' => :'virtualInbox',
         :'expires_at' => :'expiresAt'
       }
     end
@@ -89,6 +94,7 @@ module MailSlurpClient
         :'tags' => :'Array<String>',
         :'team_access' => :'Boolean',
         :'inbox_type' => :'String',
+        :'virtual_inbox' => :'Boolean',
         :'expires_at' => :'String'
       }
     end
@@ -148,6 +154,10 @@ module MailSlurpClient
         self.inbox_type = attributes[:'inbox_type']
       end
 
+      if attributes.key?(:'virtual_inbox')
+        self.virtual_inbox = attributes[:'virtual_inbox']
+      end
+
       if attributes.key?(:'expires_at')
         self.expires_at = attributes[:'expires_at']
       end
@@ -211,6 +221,7 @@ module MailSlurpClient
           tags == o.tags &&
           team_access == o.team_access &&
           inbox_type == o.inbox_type &&
+          virtual_inbox == o.virtual_inbox &&
           expires_at == o.expires_at
     end
 
@@ -223,7 +234,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, email_address, created_at, favourite, name, tags, team_access, inbox_type, expires_at].hash
+      [id, email_address, created_at, favourite, name, tags, team_access, inbox_type, virtual_inbox, expires_at].hash
     end
 
     # Builds the object from hash