mailslurp_client 11.15.0 → 12.1.22

data/lib/mailslurp_client/models/match_options.rb

@@ -13,14 +13,18 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
-  # Optional filter for matching emails based on fields. For instance filter results to only include emails whose `SUBJECT` value does `CONTAIN` given match value. An example payload would be `{ matches: [{ field: 'SUBJECT', should: 'CONTAIN', value: 'Welcome' }] }`. If you wish to extract regex matches inside the email content see the `getEmailContentMatch` method in the EmailController.
+  # Optional filter for matching emails based on fields. For instance filter results to only include emails whose `SUBJECT` value does `CONTAIN` given match value. An example payload would be `{ matches: [{ field: 'SUBJECT', should: 'CONTAIN', value: 'Welcome' }] }`. You can also pass conditions such as `HAS_ATTACHMENT`. If you wish to extract regex matches inside the email content see the `getEmailContentMatch` method in the EmailController.
   class MatchOptions
-    # 1 or more match options. Options are additive so if one does not match the email is excluded from results
+    # Zero or more conditions such as `{ condition: 'HAS_ATTACHMENTS', value: 'TRUE' }`. Note the values are the strings `TRUE|FALSE` not booleans.
+    attr_accessor :conditions
+
+    # Zero or more match options such as `{ field: 'SUBJECT', should: 'CONTAIN', value: 'Welcome' }`. Options are additive so if one does not match the email is excluded from results
     attr_accessor :matches
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'conditions' => :'conditions',
         :'matches' => :'matches'
       }
     end
@@ -28,6 +32,7 @@ module MailSlurpClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'conditions' => :'Array<ConditionOption>',
         :'matches' => :'Array<MatchOption>'
       }
     end
@@ -53,6 +58,12 @@ module MailSlurpClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'conditions')
+        if (value = attributes[:'conditions']).is_a?(Array)
+          self.conditions = value
+        end
+      end
+
       if attributes.key?(:'matches')
         if (value = attributes[:'matches']).is_a?(Array)
           self.matches = value
@@ -78,6 +89,7 @@ module MailSlurpClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          conditions == o.conditions &&
           matches == o.matches
     end
 
@@ -90,7 +102,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [matches].hash
+      [conditions, matches].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.

data/lib/mailslurp_client/models/reply_to_alias_email_options.rb

@@ -36,6 +36,9 @@ module MailSlurpClient
     # Template variables if using a template
     attr_accessor :template_variables
 
+    # Optionally use inbox name as display name for sender email address
+    attr_accessor :use_inbox_name
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -67,7 +70,8 @@ module MailSlurpClient
         :'is_html' => :'isHTML',
         :'send_strategy' => :'sendStrategy',
         :'template' => :'template',
-        :'template_variables' => :'templateVariables'
+        :'template_variables' => :'templateVariables',
+        :'use_inbox_name' => :'useInboxName'
       }
     end
 
@@ -80,7 +84,8 @@ module MailSlurpClient
         :'is_html' => :'Boolean',
         :'send_strategy' => :'String',
         :'template' => :'String',
-        :'template_variables' => :'Object'
+        :'template_variables' => :'Object',
+        :'use_inbox_name' => :'Boolean'
       }
     end
 
@@ -134,6 +139,10 @@ module MailSlurpClient
       if attributes.key?(:'template_variables')
         self.template_variables = attributes[:'template_variables']
       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?
@@ -172,7 +181,8 @@ module MailSlurpClient
           is_html == o.is_html &&
           send_strategy == o.send_strategy &&
           template == o.template &&
-          template_variables == o.template_variables
+          template_variables == o.template_variables &&
+          use_inbox_name == o.use_inbox_name
     end
 
     # @see the `==` method
@@ -184,7 +194,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [attachments, body, charset, is_html, send_strategy, template, template_variables].hash
+      [attachments, body, charset, is_html, send_strategy, template, template_variables, use_inbox_name].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/reply_to_email_options.rb

@@ -42,6 +42,9 @@ module MailSlurpClient
     # Template variables if using a template
     attr_accessor :template_variables
 
+    # Optionally use inbox name as display name for sender email address
+    attr_accessor :use_inbox_name
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -75,7 +78,8 @@ module MailSlurpClient
         :'reply_to' => :'replyTo',
         :'send_strategy' => :'sendStrategy',
         :'template' => :'template',
-        :'template_variables' => :'templateVariables'
+        :'template_variables' => :'templateVariables',
+        :'use_inbox_name' => :'useInboxName'
       }
     end
 
@@ -90,7 +94,8 @@ module MailSlurpClient
         :'reply_to' => :'String',
         :'send_strategy' => :'String',
         :'template' => :'String',
-        :'template_variables' => :'Object'
+        :'template_variables' => :'Object',
+        :'use_inbox_name' => :'Boolean'
       }
     end
 
@@ -152,6 +157,10 @@ module MailSlurpClient
       if attributes.key?(:'template_variables')
         self.template_variables = attributes[:'template_variables']
       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?
@@ -192,7 +201,8 @@ module MailSlurpClient
           reply_to == o.reply_to &&
           send_strategy == o.send_strategy &&
           template == o.template &&
-          template_variables == o.template_variables
+          template_variables == o.template_variables &&
+          use_inbox_name == o.use_inbox_name
     end
 
     # @see the `==` method
@@ -204,7 +214,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [attachments, body, charset, from, is_html, reply_to, send_strategy, template, template_variables].hash
+      [attachments, body, charset, from, is_html, reply_to, send_strategy, template, template_variables, use_inbox_name].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/send_email_options.rb

@@ -15,7 +15,7 @@ require 'date'
 module MailSlurpClient
   # Options for sending an email message from an inbox. You must provide one of: `to`, `toGroup`, or `toContacts` to send an email. All other parameters are optional. 
   class SendEmailOptions
-    # Optional list of attachment IDs to send with this email. You must first upload each attachment separately in order to obtain attachment IDs. This way you can reuse attachments with different emails once uploaded.
+    # Optional list of attachment IDs to send with this email. You must first upload each attachment separately via method call or dashboard in order to obtain attachment IDs. This way you can reuse attachments with different emails once uploaded. There are several ways to upload that support `multi-part form`, `base64 file encoding`, and octet stream binary uploads. See the `UploadController` for available methods. 
     attr_accessor :attachments
 
     # Optional list of bcc destination email addresses
@@ -30,9 +30,12 @@ module MailSlurpClient
     # Optional charset
     attr_accessor :charset
 
-    # Optional from address. If not set the source inbox address will be used for this field. Beware of potential spam penalties when setting this field to an address not used by the inbox. For custom email addresses use a custom domain.
+    # Optional from address. Email address is RFC 5322 format and may include a display name and email in angle brackets (`my@address.com` or `My inbox <my@address.com>`). If no sender is set the source inbox address will be used for this field. If you set `useInboxName` to `true` the from field will include the inbox name as a display name: `inbox_name <inbox@address.com>`. For this to work use the name field when creating an inbox. Beware of potential spam penalties when setting the from field to an address not used by the inbox. Your emails may get blocked by services if you impersonate another address. To use a custom email addresses use a custom domain. You can create domains with the DomainController. The domain must be verified in the dashboard before it can be used.
     attr_accessor :from
 
+    # Optional HTML flag to indicate that contents is HTML. Set's a `content-type: text/html` for email. (Deprecated: use `isHTML` instead.)
+    attr_accessor :html
+
     # Optional HTML flag. If true the `content-type` of the email will be `text/html`. Set to true when sending HTML to ensure proper rending on email clients
     attr_accessor :is_html
 
@@ -51,7 +54,7 @@ module MailSlurpClient
     # Optional map of template variables. Will replace moustache syntax variables in subject and body or template with the associated values if found.
     attr_accessor :template_variables
 
-    # List of destination email addresses. Even single recipients must be in array form. Maximum recipients per email depends on your plan. If you need to send many emails try using contacts or contact groups or use a non standard sendStrategy to ensure that spam filters are not triggered (many recipients in one email can affect your spam rating).
+    # List of destination email addresses. Each email address must be RFC 5322 format. Even single recipients must be in array form. Maximum recipients per email depends on your plan. If you need to send many emails try using contacts or contact groups or use a non standard sendStrategy to ensure that spam filters are not triggered (many recipients in one email can affect your spam rating). Be cautious when sending emails that your recipients exist. High bounce rates (meaning a high percentage of emails cannot be delivered because an address does not exist) can result in account freezing.
     attr_accessor :to
 
     # Optional list of contact IDs to send email to. Manage your contacts via the API or dashboard. When contacts are used the email is sent to each contact separately so they will not see other recipients.
@@ -60,6 +63,9 @@ module MailSlurpClient
     # Optional contact group ID to send email to. You can create contacts and contact groups in the API or dashboard and use them for email campaigns. When contact groups are used the email is sent to each contact separately so they will not see other recipients
     attr_accessor :to_group
 
+    # Use name of inbox as sender email address name. Will construct RFC 5322 email address with `Inbox name <inbox@address.com>` if the inbox has a name.
+    attr_accessor :use_inbox_name
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -91,6 +97,7 @@ module MailSlurpClient
         :'cc' => :'cc',
         :'charset' => :'charset',
         :'from' => :'from',
+        :'html' => :'html',
         :'is_html' => :'isHTML',
         :'reply_to' => :'replyTo',
         :'send_strategy' => :'sendStrategy',
@@ -99,7 +106,8 @@ module MailSlurpClient
         :'template_variables' => :'templateVariables',
         :'to' => :'to',
         :'to_contacts' => :'toContacts',
-        :'to_group' => :'toGroup'
+        :'to_group' => :'toGroup',
+        :'use_inbox_name' => :'useInboxName'
       }
     end
 
@@ -112,6 +120,7 @@ module MailSlurpClient
         :'cc' => :'Array<String>',
         :'charset' => :'String',
         :'from' => :'String',
+        :'html' => :'Boolean',
         :'is_html' => :'Boolean',
         :'reply_to' => :'String',
         :'send_strategy' => :'String',
@@ -120,7 +129,8 @@ module MailSlurpClient
         :'template_variables' => :'Object',
         :'to' => :'Array<String>',
         :'to_contacts' => :'Array<String>',
-        :'to_group' => :'String'
+        :'to_group' => :'String',
+        :'use_inbox_name' => :'Boolean'
       }
     end
 
@@ -175,6 +185,10 @@ module MailSlurpClient
         self.from = attributes[:'from']
       end
 
+      if attributes.key?(:'html')
+        self.html = attributes[:'html']
+      end
+
       if attributes.key?(:'is_html')
         self.is_html = attributes[:'is_html']
       end
@@ -214,6 +228,10 @@ module MailSlurpClient
       if attributes.key?(:'to_group')
         self.to_group = attributes[:'to_group']
       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?
@@ -252,6 +270,7 @@ module MailSlurpClient
           cc == o.cc &&
           charset == o.charset &&
           from == o.from &&
+          html == o.html &&
           is_html == o.is_html &&
           reply_to == o.reply_to &&
           send_strategy == o.send_strategy &&
@@ -260,7 +279,8 @@ module MailSlurpClient
           template_variables == o.template_variables &&
           to == o.to &&
           to_contacts == o.to_contacts &&
-          to_group == o.to_group
+          to_group == o.to_group &&
+          use_inbox_name == o.use_inbox_name
     end
 
     # @see the `==` method
@@ -272,7 +292,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [attachments, bcc, body, cc, charset, from, is_html, reply_to, send_strategy, subject, template, template_variables, to, to_contacts, to_group].hash
+      [attachments, bcc, body, cc, charset, from, html, is_html, reply_to, send_strategy, subject, template, template_variables, to, to_contacts, to_group, use_inbox_name].hash
     end
 
     # Builds the object from hash