mailslurp_client 12.1.1 → 12.1.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26d71dcbba0c71c4f1887b4b310766b50c5960a0f94f2fcd3c99ff7fc717fb93
-  data.tar.gz: 3ef52e97f70aa606f43040d4f0a96b8b7d37a9d26930e037f717298187ccd667
+  metadata.gz: 5f878bf983ebb1864e73ab7693ac90d1a04f8ef4a84698f2bef34752d9d97c5b
+  data.tar.gz: ce0ed9bf08a4bf8490cf11e9cbe8f041f3e9595c78a6ad86afe7fbdfc017dba3
 SHA512:
-  metadata.gz: 108460f9d2090917d2aa9ae56a1e11519c59e789906bb8b61fd5d4198e85a9673ec5ce7cd6ba7d42e5449be62f0df86ec63abd6cd2cceaf3f84cb839d5512d72
-  data.tar.gz: 55e1110b31561de24227c60bd694f6f1d0da8f431af3585c58700405866a5aefbfb1cae973b2779bb257b83e598ed3d258aa50a1063c16f0b3ebe52b2a9cad85
+  metadata.gz: 3b241ae5a62ce1bcff2d129230d81b83f60449620c762041ef5d6c1ccb474f1f5ac4c4d2a5d4d7c0fe4eb61b7d3d8fc9f8383eef39ed5f782c30bb2532a6a177
+  data.tar.gz: 79597481eb7050d4be1858b872252269f6a4ec540a9859196a7af4a60ca86041c0a2d09a376e15cd37674f764d06767ef7deb564de75c54d22dd789e3363e971

data/lib/mailslurp_client.rb

@@ -24,6 +24,7 @@ require 'mailslurp_client/models/attachment_meta_data'
 require 'mailslurp_client/models/attachment_projection'
 require 'mailslurp_client/models/basic_auth_options'
 require 'mailslurp_client/models/bulk_send_email_options'
+require 'mailslurp_client/models/condition_option'
 require 'mailslurp_client/models/contact_dto'
 require 'mailslurp_client/models/contact_projection'
 require 'mailslurp_client/models/content_match_options'

data/lib/mailslurp_client/api/wait_for_controller_api.rb

@@ -288,7 +288,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Wait for or return the first email that matches proved MatchOptions array
+    # Wait for or return the first email that matches provided MatchOptions array
     # Perform a search of emails in an inbox with the given patterns. If a result if found then return or else retry the search until a result is found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the `MatchOptions` object for options. An example payload is `{ matches: [{field: 'SUBJECT',should:'CONTAIN',value:'needle'}] }`. You can use an array of matches and they will be applied sequentially to filter out emails. If you want to perform matches and extractions of content using Regex patterns see the EmailController `getEmailContentMatch` method.
     # @param match_options [MatchOptions] matchOptions
     # @param [Hash] opts the optional parameters
@@ -301,7 +301,7 @@ module MailSlurpClient
       data
     end
 
-    # Wait for or return the first email that matches proved MatchOptions array
+    # Wait for or return the first email that matches provided MatchOptions array
     # Perform a search of emails in an inbox with the given patterns. If a result if found then return or else retry the search until a result is found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the `MatchOptions` object for options. An example payload is `{ matches: [{field: 'SUBJECT',should:'CONTAIN',value:'needle'}] }`. You can use an array of matches and they will be applied sequentially to filter out emails. If you want to perform matches and extractions of content using Regex patterns see the EmailController `getEmailContentMatch` method.
     # @param match_options [MatchOptions] matchOptions
     # @param [Hash] opts the optional parameters

data/lib/mailslurp_client/models/condition_option.rb

@@ -0,0 +1,264 @@
+=begin
+#MailSlurp API
+
+#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more.  ## Resources  - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository 
+
+The version of the OpenAPI document: 6.5.2
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module MailSlurpClient
+  # Options for matching emails in an inbox based on a condition such as `HAS_ATTACHMENTS=TRUE`
+  class ConditionOption
+    # The condition to evaluate against the email
+    attr_accessor :condition
+
+    # What the condition should evaluate to. A string 'TRUE|FALSE' not a boolean.
+    attr_accessor :value
+
+    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
+      {
+        :'condition' => :'condition',
+        :'value' => :'value'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'condition' => :'String',
+        :'value' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::ConditionOption` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `MailSlurpClient::ConditionOption`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'condition')
+        self.condition = attributes[:'condition']
+      end
+
+      if attributes.key?(:'value')
+        self.value = attributes[:'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
+      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?
+      condition_validator = EnumAttributeValidator.new('String', ["HAS_ATTACHMENTS"])
+      return false unless condition_validator.valid?(@condition)
+      value_validator = EnumAttributeValidator.new('String', ["TRUE", "FALSE"])
+      return false unless value_validator.valid?(@value)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] condition Object to be assigned
+    def condition=(condition)
+      validator = EnumAttributeValidator.new('String', ["HAS_ATTACHMENTS"])
+      unless validator.valid?(condition)
+        fail ArgumentError, "invalid value for \"condition\", must be one of #{validator.allowable_values}."
+      end
+      @condition = condition
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] value Object to be assigned
+    def value=(value)
+      validator = EnumAttributeValidator.new('String', ["TRUE", "FALSE"])
+      unless validator.valid?(value)
+        fail ArgumentError, "invalid value for \"value\", must be one of #{validator.allowable_values}."
+      end
+      @value = value
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          condition == o.condition &&
+          value == o.value
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [condition, value].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        MailSlurpClient.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+        
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

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/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,10 +30,10 @@ module MailSlurpClient
     # 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. 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 (Deprecated: use isHTML instead)
+    # 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
@@ -54,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.
@@ -63,7 +63,7 @@ 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>`
+    # 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

data/lib/mailslurp_client/models/wait_for_conditions.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
-  # Conditions that a `waitForXEmails` endpoint operates on. The methods wait until given conditions are met or a timeout is reached. If the conditions are met without needing to wait the results will be returned immediately.
+  # Conditions that a `waitForXEmails` endpoint operates on. The methods wait until given conditions are met or a timeout is reached. If the conditions are met without needing to wait the results will be returned immediately. Can include `unreadOnly` to ignore already read emails that were returned in an API call or viewing in the dashboard. Can also include matches for emails containing `from`, `subject`, `hasAttachments` etc.
   class WaitForConditions
     # Number of results that should match conditions. Either exactly or at least this amount based on the `countType`. If count condition is not met and the timeout has not been reached the `waitFor` method will retry the operation.
     attr_accessor :count

data/lib/mailslurp_client/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 4.3.1
 =end
 
 module MailSlurpClient
-  VERSION = '12.1.1'
+  VERSION = '12.1.22'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailslurp_client
 version: !ruby/object:Gem::Version
-  version: 12.1.1
+  version: 12.1.22
 platform: ruby
 authors:
 - mailslurp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-31 00:00:00.000000000 Z
+date: 2021-06-05 00:00:00.000000000 Z
 dependencies: []
 description: Create emails addresses in Ruby then send and receive real emails and
   attachments. See https://www.mailslurp.com/docs/ruby/ for full Ruby documentation.
@@ -50,6 +50,7 @@ files:
 - lib/mailslurp_client/models/attachment_projection.rb
 - lib/mailslurp_client/models/basic_auth_options.rb
 - lib/mailslurp_client/models/bulk_send_email_options.rb
+- lib/mailslurp_client/models/condition_option.rb
 - lib/mailslurp_client/models/contact_dto.rb
 - lib/mailslurp_client/models/contact_projection.rb
 - lib/mailslurp_client/models/content_match_options.rb