mailslurp_client 11.13.0 → 12.1.0

data/lib/mailslurp_client/models/domain_name_record.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
-  # DNS Record required for verification of a domain
+  # DNS Record required for verification of a domain. Record vary depending on domain type.
   class DomainNameRecord
     attr_accessor :name
 

data/lib/mailslurp_client/models/forward_email_options.rb

@@ -21,19 +21,27 @@ module MailSlurpClient
     # Optional cc recipients
     attr_accessor :cc
 
+    # Optional from override
+    attr_accessor :from
+
     # Subject for forwarded email
     attr_accessor :subject
 
     # To recipients for forwarded email
     attr_accessor :to
 
+    # Optionally use inbox name as display name for sender email address
+    attr_accessor :use_inbox_name
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'bcc' => :'bcc',
         :'cc' => :'cc',
+        :'from' => :'from',
         :'subject' => :'subject',
-        :'to' => :'to'
+        :'to' => :'to',
+        :'use_inbox_name' => :'useInboxName'
       }
     end
 
@@ -42,8 +50,10 @@ module MailSlurpClient
       {
         :'bcc' => :'Array<String>',
         :'cc' => :'Array<String>',
+        :'from' => :'String',
         :'subject' => :'String',
-        :'to' => :'Array<String>'
+        :'to' => :'Array<String>',
+        :'use_inbox_name' => :'Boolean'
       }
     end
 
@@ -80,6 +90,10 @@ module MailSlurpClient
         end
       end
 
+      if attributes.key?(:'from')
+        self.from = attributes[:'from']
+      end
+
       if attributes.key?(:'subject')
         self.subject = attributes[:'subject']
       end
@@ -89,6 +103,10 @@ module MailSlurpClient
           self.to = value
         end
       end
+
+      if attributes.key?(:'use_inbox_name')
+        self.use_inbox_name = attributes[:'use_inbox_name']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -111,8 +129,10 @@ module MailSlurpClient
       self.class == o.class &&
           bcc == o.bcc &&
           cc == o.cc &&
+          from == o.from &&
           subject == o.subject &&
-          to == o.to
+          to == o.to &&
+          use_inbox_name == o.use_inbox_name
     end
 
     # @see the `==` method
@@ -124,7 +144,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [bcc, cc, subject, to].hash
+      [bcc, cc, from, subject, to, use_inbox_name].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/inbox.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
-  # Representation of a MailSlurp inbox. An inbox has an ID and a real email address. Emails can be sent to or from this email address. Use the `EmailController` or the `InboxController` methods to send and receive emails and attachments.
+  # Representation of a MailSlurp inbox. An inbox has an ID and a real email address. Emails can be sent to or from this email address. Inboxes are either `SMTP` or `HTTP` mailboxes. The default, `HTTP` inboxes, use AWS SES to process emails and are best suited as test email accounts. `SMTP` inboxes use a custom mail server at `mx.mailslurp.com` and are best used for public facing email addresses. Use the `EmailController` or the `InboxController` methods to send and receive emails and attachments. Inboxes may have a description, name, and tags for display purposes. You can also favourite an inbox for easier searching. Inboxes can be private or allow team access. Team access enabled inboxes can be seen by other members of an organization. 
   class Inbox
     # When the inbox was created. Time stamps are in ISO DateTime Format `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` e.g. `2000-10-31T01:30:00.000-05:00`.
     attr_accessor :created_at
@@ -27,13 +27,16 @@ module MailSlurpClient
     # 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
 
-    # Is the inbox favorited. Favouriting inboxes is typically done in the dashboard for quick access or filtering
+    # Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering
     attr_accessor :favourite
 
     # 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
 
-    # Name of the inbox. Displayed in the dashboard for easier search
+    # Type of inbox - either HTTP (default) or SMTP. HTTP inboxes are great for testing. SMTP inboxes are processed by a custom SMTP mail server and are better for public facing inboxes that receive emails from Gmail and other large providers. If using a custom domain the domain type must match the inbox type. Use an SMTP domain for SMTP inboxes that includes an MX record pointing to `10 mx.mailslurp.com` for inbound messages.
+    attr_accessor :inbox_type
+
+    # Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search
     attr_accessor :name
 
     # Is the inbox readOnly for the caller. Read only means can not be deleted or modified. This flag is present when using team accounts and shared inboxes.
@@ -48,6 +51,28 @@ module MailSlurpClient
     # ID of user that inbox belongs to
     attr_accessor :user_id
 
+    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
       {
@@ -57,6 +82,7 @@ module MailSlurpClient
         :'expires_at' => :'expiresAt',
         :'favourite' => :'favourite',
         :'id' => :'id',
+        :'inbox_type' => :'inboxType',
         :'name' => :'name',
         :'read_only' => :'readOnly',
         :'tags' => :'tags',
@@ -74,6 +100,7 @@ module MailSlurpClient
         :'expires_at' => :'String',
         :'favourite' => :'Boolean',
         :'id' => :'String',
+        :'inbox_type' => :'String',
         :'name' => :'String',
         :'read_only' => :'Boolean',
         :'tags' => :'Array<String>',
@@ -127,6 +154,10 @@ module MailSlurpClient
         self.id = attributes[:'id']
       end
 
+      if attributes.key?(:'inbox_type')
+        self.inbox_type = attributes[:'inbox_type']
+      end
+
       if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
@@ -160,9 +191,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)
@@ -174,6 +217,7 @@ module MailSlurpClient
           expires_at == o.expires_at &&
           favourite == o.favourite &&
           id == o.id &&
+          inbox_type == o.inbox_type &&
           name == o.name &&
           read_only == o.read_only &&
           tags == o.tags &&
@@ -190,7 +234,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [created_at, description, email_address, expires_at, favourite, id, name, read_only, tags, team_access, user_id].hash
+      [created_at, description, email_address, expires_at, favourite, id, inbox_type, name, read_only, tags, team_access, user_id].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/inbox_projection.rb

@@ -22,12 +22,36 @@ module MailSlurpClient
 
     attr_accessor :id
 
+    attr_accessor :inbox_type
+
     attr_accessor :name
 
     attr_accessor :tags
 
     attr_accessor :team_access
 
+    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
       {
@@ -35,6 +59,7 @@ module MailSlurpClient
         :'email_address' => :'emailAddress',
         :'favourite' => :'favourite',
         :'id' => :'id',
+        :'inbox_type' => :'inboxType',
         :'name' => :'name',
         :'tags' => :'tags',
         :'team_access' => :'teamAccess'
@@ -48,6 +73,7 @@ module MailSlurpClient
         :'email_address' => :'String',
         :'favourite' => :'Boolean',
         :'id' => :'String',
+        :'inbox_type' => :'String',
         :'name' => :'String',
         :'tags' => :'Array<String>',
         :'team_access' => :'Boolean'
@@ -91,6 +117,10 @@ module MailSlurpClient
         self.id = attributes[:'id']
       end
 
+      if attributes.key?(:'inbox_type')
+        self.inbox_type = attributes[:'inbox_type']
+      end
+
       if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
@@ -135,10 +165,22 @@ module MailSlurpClient
       return false if @created_at.nil?
       return false if @favourite.nil?
       return false if @id.nil?
+      inbox_type_validator = EnumAttributeValidator.new('String', ["HTTP_INBOX", "SMTP_INBOX"])
+      return false unless inbox_type_validator.valid?(@inbox_type)
       return false if @team_access.nil?
       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)
@@ -148,6 +190,7 @@ module MailSlurpClient
           email_address == o.email_address &&
           favourite == o.favourite &&
           id == o.id &&
+          inbox_type == o.inbox_type &&
           name == o.name &&
           tags == o.tags &&
           team_access == o.team_access
@@ -162,7 +205,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [created_at, email_address, favourite, id, name, tags, team_access].hash
+      [created_at, email_address, favourite, id, inbox_type, name, tags, team_access].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/organization_inbox_projection.rb

@@ -20,13 +20,16 @@ module MailSlurpClient
     # The inbox's email address. Inbox projections and previews may not include the email address. To view the email address fetch the inbox entity directly. Send an email to this address and the inbox will receive and store it for you. Note the email address in MailSlurp match characters exactly and are case sensitive so `+123` additions are considered different addresses. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.
     attr_accessor :email_address
 
-    # Is the inbox favorited. Favouriting inboxes is typically done in the dashboard for quick access or filtering
+    # Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering
     attr_accessor :favourite
 
     # 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
 
-    # Name of the inbox. Displayed in the dashboard for easier search
+    # Type of inbox - either HTTP (default) or SMTP. HTTP inboxes are great for testing. SMTP inboxes are processed by a custom SMTP mail server and are better for public facing inboxes that receive emails from Gmail and other large providers. If using a custom domain the domain type must match the inbox type. Use an SMTP domain for SMTP inboxes that includes an MX record pointing to `10 mx.mailslurp.com` for inbound messages.
+    attr_accessor :inbox_type
+
+    # Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search
     attr_accessor :name
 
     # Is the inbox readOnly for the caller. Read only means can not be deleted or modified. This flag is present when using team accounts and shared inboxes.
@@ -38,6 +41,28 @@ module MailSlurpClient
     # Does inbox permit team access for organization team members. If so team users can use inbox and emails associated with it. See the team access guide at https://www.mailslurp.com/guides/team-email-account-sharing/
     attr_accessor :team_access
 
+    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
       {
@@ -45,6 +70,7 @@ module MailSlurpClient
         :'email_address' => :'emailAddress',
         :'favourite' => :'favourite',
         :'id' => :'id',
+        :'inbox_type' => :'inboxType',
         :'name' => :'name',
         :'read_only' => :'readOnly',
         :'tags' => :'tags',
@@ -59,6 +85,7 @@ module MailSlurpClient
         :'email_address' => :'String',
         :'favourite' => :'Boolean',
         :'id' => :'String',
+        :'inbox_type' => :'String',
         :'name' => :'String',
         :'read_only' => :'Boolean',
         :'tags' => :'Array<String>',
@@ -103,6 +130,10 @@ module MailSlurpClient
         self.id = attributes[:'id']
       end
 
+      if attributes.key?(:'inbox_type')
+        self.inbox_type = attributes[:'inbox_type']
+      end
+
       if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
@@ -132,9 +163,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)
@@ -144,6 +187,7 @@ module MailSlurpClient
           email_address == o.email_address &&
           favourite == o.favourite &&
           id == o.id &&
+          inbox_type == o.inbox_type &&
           name == o.name &&
           read_only == o.read_only &&
           tags == o.tags &&
@@ -159,7 +203,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [created_at, email_address, favourite, id, name, read_only, tags, team_access].hash
+      [created_at, email_address, favourite, id, inbox_type, name, read_only, tags, team_access].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/page_attachment_entity.rb

@@ -57,7 +57,7 @@ module MailSlurpClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'content' => :'Array<AttachmentEntity>',
+        :'content' => :'Array<AttachmentProjection>',
         :'empty' => :'Boolean',
         :'first' => :'Boolean',
         :'last' => :'Boolean',

data/lib/mailslurp_client/models/page_sent_email_projection.rb

@@ -15,6 +15,7 @@ require 'date'
 module MailSlurpClient
   # Paginated sent email results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full sent email entity use the projection ID with individual method calls.
   class PageSentEmailProjection
+    # Collection of items
     attr_accessor :content
 
     attr_accessor :empty
@@ -23,18 +24,23 @@ module MailSlurpClient
 
     attr_accessor :last
 
+    # Page number starting at 0
     attr_accessor :number
 
+    # Number of items returned
     attr_accessor :number_of_elements
 
     attr_accessor :pageable
 
+    # Size of page requested
     attr_accessor :size
 
     attr_accessor :sort
 
+    # Total number of items available for querying
     attr_accessor :total_elements
 
+    # Total number of pages available
     attr_accessor :total_pages
 
     # Attribute mapping from ruby-style variable name to JSON key.