mailslurp_client 11.15.0 → 12.1.22

data/lib/mailslurp_client/models/create_domain_options.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
-  # Options for creating a domain to use with MailSlurp. You must have ownership access to this domain in order to verify it. Domains will not functionally currently until the domain has been verified. See https://www.mailslurp.com/guides/custom-domains for help.
+  # Options for creating a domain to use with MailSlurp. You must have ownership access to this domain in order to verify it. Domains will not function correctly until the domain has been verified. See https://www.mailslurp.com/guides/custom-domains for help. Domains can be either `HTTP` or `SMTP` type. The type of domain determines which inboxes can be used with it. `SMTP` inboxes use a mail server running `mx.mailslurp.com` while `HTTP` inboxes are handled by AWS SES.
   class CreateDomainOptions
     # Whether to create a catch all inbox for the domain. Any email sent to an address using your domain that cannot be matched to an existing inbox you created with the domain will be routed to the created catch all inbox. You can access emails using the regular methods on this inbox ID.
     attr_accessor :created_catch_all_inbox
@@ -24,7 +24,7 @@ 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
+    # Domain type to create. HTTP or SMTP domain. HTTP domain uses MailSlurps SES MX records. SMTP uses a custom SMTP server MX record. SMTP domains can only be used with SMTP inboxes. SMTP inboxes are more reliable for public inbound emails while HTTP inboxes are more suitable for testing.
     attr_accessor :domain_type
 
     class EnumAttributeValidator

data/lib/mailslurp_client/models/create_inbox_dto.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
-  # Options for creating an inbox. An inbox has a real email address that can send and receive emails. Inboxes can be permanent or expire at a given time. They can use a custom email address (by verifying your own domain) or a randomly assigned email ending in either `mailslurp.com` or if `useDomainPool` is enabled then ending in a similar domains such as `mailslurp.xyz` (selected at random). 
+  # Options for creating an inbox. An inbox has a real email address that can send and receive emails. Inboxes can be permanent or expire at a given time. Inboxes are either `SMTP` or `HTTP` mailboxes. Use `SMTP` for public facing mailboxes and `HTTP` for test email accounts. `SMTP` inboxes are processed by a mail server running at `mx.mailslurp.com` while `HTTP` inboxes are processed by AWS SES. Inboxes can use a custom email address (by verifying your own domain) or a randomly assigned email ending in either `mailslurp.com` or (if `useDomainPool` is enabled) ending in a similar domain such as `mailslurp.xyz` (selected at random). 
   class CreateInboxDto
     # Grant team access to this inbox and the emails that belong to it for team members of your organization.
     attr_accessor :allow_team_access
@@ -21,7 +21,7 @@ module MailSlurpClient
     # Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with
     attr_accessor :description
 
-    # A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.
+    # A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.
     attr_accessor :email_address
 
     # Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX.
@@ -30,19 +30,19 @@ module MailSlurpClient
     # Number of milliseconds that inbox should exist for
     attr_accessor :expires_in
 
-    # Is the inbox favorited. Favouriting inboxes is typically done in the dashboard for quick access or filtering
+    # Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering
     attr_accessor :favourite
 
-    # HTTP or SMTP inbox
+    # HTTP (default) or SMTP inbox type. HTTP inboxes are best for testing while SMTP inboxes are more reliable for public inbound email consumption. When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mx.mailslurp.com`.
     attr_accessor :inbox_type
 
-    # Optional name of the inbox. Displayed in the dashboard for easier search
+    # Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails.
     attr_accessor :name
 
     # Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.
     attr_accessor :tags
 
-    # 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.
+    # 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. Note this feature is only available for `HTTP` inbox types.
     attr_accessor :use_domain_pool
 
     class EnumAttributeValidator

data/lib/mailslurp_client/models/domain_dto.rb

@@ -29,6 +29,9 @@ module MailSlurpClient
     # List of DNS domain name records (C, MX, TXT) etc that you must add to the DNS server associated with your domain provider.
     attr_accessor :domain_name_records
 
+    # The type of domain. SMTP or HTTP domains differ in what inboxes can be used with them.
+    attr_accessor :domain_type
+
     attr_accessor :id
 
     # Whether domain has been verified or not. If the domain is not verified after 72 hours there is most likely an issue with the domains DNS records.
@@ -41,6 +44,28 @@ module MailSlurpClient
     # Verification tokens
     attr_accessor :verification_token
 
+    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
       {
@@ -49,6 +74,7 @@ module MailSlurpClient
         :'dkim_tokens' => :'dkimTokens',
         :'domain' => :'domain',
         :'domain_name_records' => :'domainNameRecords',
+        :'domain_type' => :'domainType',
         :'id' => :'id',
         :'is_verified' => :'isVerified',
         :'updated_at' => :'updatedAt',
@@ -65,6 +91,7 @@ module MailSlurpClient
         :'dkim_tokens' => :'Array<String>',
         :'domain' => :'String',
         :'domain_name_records' => :'Array<DomainNameRecord>',
+        :'domain_type' => :'String',
         :'id' => :'String',
         :'is_verified' => :'Boolean',
         :'updated_at' => :'DateTime',
@@ -118,6 +145,10 @@ module MailSlurpClient
         end
       end
 
+      if attributes.key?(:'domain_type')
+        self.domain_type = attributes[:'domain_type']
+      end
+
       if attributes.key?(:'id')
         self.id = attributes[:'id']
       end
@@ -166,12 +197,24 @@ module MailSlurpClient
     # @return true if the model is valid
     def valid?
       return false if @created_at.nil?
+      domain_type_validator = EnumAttributeValidator.new('String', ["HTTP_INBOX", "SMTP_DOMAIN"])
+      return false unless domain_type_validator.valid?(@domain_type)
       return false if @id.nil?
       return false if @updated_at.nil?
       return false if @user_id.nil?
       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)
@@ -182,6 +225,7 @@ module MailSlurpClient
           dkim_tokens == o.dkim_tokens &&
           domain == o.domain &&
           domain_name_records == o.domain_name_records &&
+          domain_type == o.domain_type &&
           id == o.id &&
           is_verified == o.is_verified &&
           updated_at == o.updated_at &&
@@ -198,7 +242,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [catch_all_inbox_id, created_at, dkim_tokens, domain, domain_name_records, id, is_verified, updated_at, user_id, verification_token].hash
+      [catch_all_inbox_id, created_at, dkim_tokens, domain, domain_name_records, domain_type, id, is_verified, updated_at, user_id, verification_token].hash
     end
 
     # Builds the object from hash

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