mailslurp_client 15.0.1 → 15.0.5

data/lib/mailslurp_client/models/send_email_options.rb

@@ -13,62 +13,59 @@ OpenAPI Generator version: 4.3.1
 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. 
+  # Options for the email
   class SendEmailOptions
-    # Add tracking pixel to email
-    attr_accessor :add_tracking_pixel
+    # 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.
+    attr_accessor :to_contacts
 
-    # 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 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
 
-    # Optional list of bcc destination email addresses
-    attr_accessor :bcc
+    # 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 contents of email. If body contains HTML then set `isHTML` to true to ensure that email clients render it correctly. You can use moustache template syntax in the email body in conjunction with `toGroup` contact variables or `templateVariables` data. If you need more templating control consider creating a template and using the `template` property instead of the body.
-    attr_accessor :body
+    # 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 list of cc destination email addresses
     attr_accessor :cc
 
-    # Optional charset
-    attr_accessor :charset
-
-    # 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 list of bcc destination email addresses
+    attr_accessor :bcc
 
-    # 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
+    # Optional email subject line
+    attr_accessor :subject
 
     # Optional replyTo header
     attr_accessor :reply_to
 
-    # Optional strategy to use when sending the email
-    attr_accessor :send_strategy
+    # Optional contents of email. If body contains HTML then set `isHTML` to true to ensure that email clients render it correctly. You can use moustache template syntax in the email body in conjunction with `toGroup` contact variables or `templateVariables` data. If you need more templating control consider creating a template and using the `template` property instead of the body.
+    attr_accessor :body
 
-    # Optional email subject line
-    attr_accessor :subject
+    # 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 template ID to use for body. Will override body if provided. When using a template make sure you pass the corresponding map of `templateVariables`. You can find which variables are needed by fetching the template itself or viewing it in the dashboard.
-    attr_accessor :template
+    # Optional charset
+    attr_accessor :charset
+
+    # 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 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. 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.
-    attr_accessor :to_contacts
+    # Optional template ID to use for body. Will override body if provided. When using a template make sure you pass the corresponding map of `templateVariables`. You can find which variables are needed by fetching the template itself or viewing it in the dashboard.
+    attr_accessor :template
 
-    # 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
+    # How an email should be sent based on its recipients
+    attr_accessor :send_strategy
 
     # 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
 
+    # Add tracking pixel to email
+    attr_accessor :add_tracking_pixel
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -94,48 +91,46 @@ module MailSlurpClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'add_tracking_pixel' => :'addTrackingPixel',
-        :'attachments' => :'attachments',
+        :'to_contacts' => :'toContacts',
+        :'to_group' => :'toGroup',
+        :'to' => :'to',
+        :'from' => :'from',
+        :'cc' => :'cc',
         :'bcc' => :'bcc',
+        :'subject' => :'subject',
+        :'reply_to' => :'replyTo',
         :'body' => :'body',
-        :'cc' => :'cc',
-        :'charset' => :'charset',
-        :'from' => :'from',
         :'html' => :'html',
-        :'is_html' => :'isHTML',
-        :'reply_to' => :'replyTo',
-        :'send_strategy' => :'sendStrategy',
-        :'subject' => :'subject',
-        :'template' => :'template',
+        :'charset' => :'charset',
+        :'attachments' => :'attachments',
         :'template_variables' => :'templateVariables',
-        :'to' => :'to',
-        :'to_contacts' => :'toContacts',
-        :'to_group' => :'toGroup',
-        :'use_inbox_name' => :'useInboxName'
+        :'template' => :'template',
+        :'send_strategy' => :'sendStrategy',
+        :'use_inbox_name' => :'useInboxName',
+        :'add_tracking_pixel' => :'addTrackingPixel'
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'add_tracking_pixel' => :'Boolean',
-        :'attachments' => :'Array<String>',
+        :'to_contacts' => :'Array<String>',
+        :'to_group' => :'String',
+        :'to' => :'Array<String>',
+        :'from' => :'String',
+        :'cc' => :'Array<String>',
         :'bcc' => :'Array<String>',
+        :'subject' => :'String',
+        :'reply_to' => :'String',
         :'body' => :'String',
-        :'cc' => :'Array<String>',
-        :'charset' => :'String',
-        :'from' => :'String',
         :'html' => :'Boolean',
-        :'is_html' => :'Boolean',
-        :'reply_to' => :'String',
-        :'send_strategy' => :'String',
-        :'subject' => :'String',
+        :'charset' => :'String',
+        :'attachments' => :'Array<String>',
+        :'template_variables' => :'Hash<String, Object>',
         :'template' => :'String',
-        :'template_variables' => :'Object',
-        :'to' => :'Array<String>',
-        :'to_contacts' => :'Array<String>',
-        :'to_group' => :'String',
-        :'use_inbox_name' => :'Boolean'
+        :'send_strategy' => :'String',
+        :'use_inbox_name' => :'Boolean',
+        :'add_tracking_pixel' => :'Boolean'
       }
     end
 
@@ -160,24 +155,24 @@ module MailSlurpClient
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'add_tracking_pixel')
-        self.add_tracking_pixel = attributes[:'add_tracking_pixel']
+      if attributes.key?(:'to_contacts')
+        if (value = attributes[:'to_contacts']).is_a?(Array)
+          self.to_contacts = value
+        end
       end
 
-      if attributes.key?(:'attachments')
-        if (value = attributes[:'attachments']).is_a?(Array)
-          self.attachments = value
-        end
+      if attributes.key?(:'to_group')
+        self.to_group = attributes[:'to_group']
       end
 
-      if attributes.key?(:'bcc')
-        if (value = attributes[:'bcc']).is_a?(Array)
-          self.bcc = value
+      if attributes.key?(:'to')
+        if (value = attributes[:'to']).is_a?(Array)
+          self.to = value
         end
       end
 
-      if attributes.key?(:'body')
-        self.body = attributes[:'body']
+      if attributes.key?(:'from')
+        self.from = attributes[:'from']
       end
 
       if attributes.key?(:'cc')
@@ -186,61 +181,59 @@ module MailSlurpClient
         end
       end
 
-      if attributes.key?(:'charset')
-        self.charset = attributes[:'charset']
-      end
-
-      if attributes.key?(:'from')
-        self.from = attributes[:'from']
-      end
-
-      if attributes.key?(:'html')
-        self.html = attributes[:'html']
+      if attributes.key?(:'bcc')
+        if (value = attributes[:'bcc']).is_a?(Array)
+          self.bcc = value
+        end
       end
 
-      if attributes.key?(:'is_html')
-        self.is_html = attributes[:'is_html']
+      if attributes.key?(:'subject')
+        self.subject = attributes[:'subject']
       end
 
       if attributes.key?(:'reply_to')
         self.reply_to = attributes[:'reply_to']
       end
 
-      if attributes.key?(:'send_strategy')
-        self.send_strategy = attributes[:'send_strategy']
+      if attributes.key?(:'body')
+        self.body = attributes[:'body']
       end
 
-      if attributes.key?(:'subject')
-        self.subject = attributes[:'subject']
+      if attributes.key?(:'html')
+        self.html = attributes[:'html']
       end
 
-      if attributes.key?(:'template')
-        self.template = attributes[:'template']
+      if attributes.key?(:'charset')
+        self.charset = attributes[:'charset']
       end
 
-      if attributes.key?(:'template_variables')
-        self.template_variables = attributes[:'template_variables']
+      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
+      if attributes.key?(:'template_variables')
+        if (value = attributes[:'template_variables']).is_a?(Hash)
+          self.template_variables = value
         end
       end
 
-      if attributes.key?(:'to_contacts')
-        if (value = attributes[:'to_contacts']).is_a?(Array)
-          self.to_contacts = value
-        end
+      if attributes.key?(:'template')
+        self.template = attributes[:'template']
       end
 
-      if attributes.key?(:'to_group')
-        self.to_group = attributes[:'to_group']
+      if attributes.key?(:'send_strategy')
+        self.send_strategy = attributes[:'send_strategy']
       end
 
       if attributes.key?(:'use_inbox_name')
         self.use_inbox_name = attributes[:'use_inbox_name']
       end
+
+      if attributes.key?(:'add_tracking_pixel')
+        self.add_tracking_pixel = attributes[:'add_tracking_pixel']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -273,24 +266,23 @@ module MailSlurpClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          add_tracking_pixel == o.add_tracking_pixel &&
-          attachments == o.attachments &&
+          to_contacts == o.to_contacts &&
+          to_group == o.to_group &&
+          to == o.to &&
+          from == o.from &&
+          cc == o.cc &&
           bcc == o.bcc &&
+          subject == o.subject &&
+          reply_to == o.reply_to &&
           body == o.body &&
-          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 &&
-          subject == o.subject &&
-          template == o.template &&
+          charset == o.charset &&
+          attachments == o.attachments &&
           template_variables == o.template_variables &&
-          to == o.to &&
-          to_contacts == o.to_contacts &&
-          to_group == o.to_group &&
-          use_inbox_name == o.use_inbox_name
+          template == o.template &&
+          send_strategy == o.send_strategy &&
+          use_inbox_name == o.use_inbox_name &&
+          add_tracking_pixel == o.add_tracking_pixel
     end
 
     # @see the `==` method
@@ -302,7 +294,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [add_tracking_pixel, 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
+      [to_contacts, to_group, to, from, cc, bcc, subject, reply_to, body, html, charset, attachments, template_variables, template, send_strategy, use_inbox_name, add_tracking_pixel].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/sender.rb

@@ -13,28 +13,29 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # Sender object containing from email address and from personal name if provided in address
   class Sender
+    attr_accessor :raw_value
+
     attr_accessor :email_address
 
     attr_accessor :name
 
-    attr_accessor :raw_value
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'raw_value' => :'rawValue',
         :'email_address' => :'emailAddress',
-        :'name' => :'name',
-        :'raw_value' => :'rawValue'
+        :'name' => :'name'
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'raw_value' => :'String',
         :'email_address' => :'String',
-        :'name' => :'String',
-        :'raw_value' => :'String'
+        :'name' => :'String'
       }
     end
 
@@ -59,6 +60,10 @@ module MailSlurpClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'raw_value')
+        self.raw_value = attributes[:'raw_value']
+      end
+
       if attributes.key?(:'email_address')
         self.email_address = attributes[:'email_address']
       end
@@ -66,32 +71,18 @@ module MailSlurpClient
       if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
-
-      if attributes.key?(:'raw_value')
-        self.raw_value = attributes[:'raw_value']
-      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 @email_address.nil?
-        invalid_properties.push('invalid value for "email_address", email_address cannot be nil.')
-      end
-
-      if @raw_value.nil?
-        invalid_properties.push('invalid value for "raw_value", raw_value 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 @email_address.nil?
-      return false if @raw_value.nil?
       true
     end
 
@@ -100,9 +91,9 @@ module MailSlurpClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          raw_value == o.raw_value &&
           email_address == o.email_address &&
-          name == o.name &&
-          raw_value == o.raw_value
+          name == o.name
     end
 
     # @see the `==` method
@@ -114,7 +105,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [email_address, name, raw_value].hash
+      [raw_value, email_address, name].hash
     end
 
     # Builds the object from hash