mailslurp_client 17.3.0 → 17.4.0

data/lib/mailslurp_client/models/inbox_automation_match_options.rb

@@ -0,0 +1,273 @@
+=begin
+#MailSlurp API
+
+#MailSlurp is an API for sending and receiving emails and SMS from dynamically allocated email addresses and phone numbers. 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://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository
+
+The version of the OpenAPI document: 6.5.2
+Contact: contact@mailslurp.dev
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module MailSlurpClient
+  # Nested AND/OR match tree for inbox forwarders and repliers.
+  class InboxAutomationMatchOptions
+    # Boolean operator used to combine inbox automation match rules.
+    attr_accessor :operator
+
+    # Leaf match rules in this group.
+    attr_accessor :matches
+
+    # Nested child groups.
+    attr_accessor :groups
+
+    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
+      {
+        :'operator' => :'operator',
+        :'matches' => :'matches',
+        :'groups' => :'groups'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'operator' => :'String',
+        :'matches' => :'Array<InboxAutomationMatchOption>',
+        :'groups' => :'Array<InboxAutomationMatchOptions>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'matches',
+        :'groups'
+      ])
+    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::InboxAutomationMatchOptions` 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::InboxAutomationMatchOptions`. 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?(:'operator')
+        self.operator = attributes[:'operator']
+      end
+
+      if attributes.key?(:'matches')
+        if (value = attributes[:'matches']).is_a?(Array)
+          self.matches = value
+        end
+      end
+
+      if attributes.key?(:'groups')
+        if (value = attributes[:'groups']).is_a?(Array)
+          self.groups = value
+        end
+      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 @operator.nil?
+        invalid_properties.push('invalid value for "operator", operator 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 @operator.nil?
+      operator_validator = EnumAttributeValidator.new('String', ["AND", "OR"])
+      return false unless operator_validator.valid?(@operator)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] operator Object to be assigned
+    def operator=(operator)
+      validator = EnumAttributeValidator.new('String', ["AND", "OR"])
+      unless validator.valid?(operator)
+        fail ArgumentError, "invalid value for \"operator\", must be one of #{validator.allowable_values}."
+      end
+      @operator = operator
+    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 &&
+          operator == o.operator &&
+          matches == o.matches &&
+          groups == o.groups
+    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
+      [operator, matches, groups].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/inbox_forwarder_dto.rb

@@ -25,7 +25,7 @@ module MailSlurpClient
     # Which field to match against
     attr_accessor :field
 
-    # Wild-card type pattern to apply to field
+    # Pattern to apply to field
     attr_accessor :match
 
     # Who to send forwarded email to
@@ -33,6 +33,14 @@ module MailSlurpClient
 
     attr_accessor :created_at
 
+    # Comparison mode for inbox automation matching.
+    attr_accessor :should
+
+    attr_accessor :match_options
+
+    # Method for extracting text from attachments.
+    attr_accessor :attachment_text_extraction_method
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -64,7 +72,10 @@ module MailSlurpClient
         :'field' => :'field',
         :'match' => :'match',
         :'forward_to_recipients' => :'forwardToRecipients',
-        :'created_at' => :'createdAt'
+        :'created_at' => :'createdAt',
+        :'should' => :'should',
+        :'match_options' => :'matchOptions',
+        :'attachment_text_extraction_method' => :'attachmentTextExtractionMethod'
       }
     end
 
@@ -77,7 +88,10 @@ module MailSlurpClient
         :'field' => :'String',
         :'match' => :'String',
         :'forward_to_recipients' => :'Array<String>',
-        :'created_at' => :'DateTime'
+        :'created_at' => :'DateTime',
+        :'should' => :'String',
+        :'match_options' => :'InboxAutomationMatchOptions',
+        :'attachment_text_extraction_method' => :'String'
       }
     end
 
@@ -86,6 +100,11 @@ module MailSlurpClient
       Set.new([
         :'inbox_id',
         :'name',
+        :'field',
+        :'match',
+        :'should',
+        :'match_options',
+        :'attachment_text_extraction_method'
       ])
     end
 
@@ -133,6 +152,18 @@ module MailSlurpClient
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       end
+
+      if attributes.key?(:'should')
+        self.should = attributes[:'should']
+      end
+
+      if attributes.key?(:'match_options')
+        self.match_options = attributes[:'match_options']
+      end
+
+      if attributes.key?(:'attachment_text_extraction_method')
+        self.attachment_text_extraction_method = attributes[:'attachment_text_extraction_method']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -143,14 +174,6 @@ module MailSlurpClient
         invalid_properties.push('invalid value for "id", id cannot be nil.')
       end
 
-      if @field.nil?
-        invalid_properties.push('invalid value for "field", field cannot be nil.')
-      end
-
-      if @match.nil?
-        invalid_properties.push('invalid value for "match", match cannot be nil.')
-      end
-
       if @forward_to_recipients.nil?
         invalid_properties.push('invalid value for "forward_to_recipients", forward_to_recipients cannot be nil.')
       end
@@ -166,25 +189,47 @@ module MailSlurpClient
     # @return true if the model is valid
     def valid?
       return false if @id.nil?
-      return false if @field.nil?
-      field_validator = EnumAttributeValidator.new('String', ["RECIPIENTS", "SENDER", "SUBJECT", "ATTACHMENTS"])
+      field_validator = EnumAttributeValidator.new('String', ["RECIPIENTS", "SENDER", "SUBJECT", "ATTACHMENTS", "ATTACHMENT_FILENAME", "ATTACHMENT_TEXT"])
       return false unless field_validator.valid?(@field)
-      return false if @match.nil?
       return false if @forward_to_recipients.nil?
       return false if @created_at.nil?
+      should_validator = EnumAttributeValidator.new('String', ["WILDCARD", "MATCH", "CONTAIN", "EQUAL"])
+      return false unless should_validator.valid?(@should)
+      attachment_text_extraction_method_validator = EnumAttributeValidator.new('String', ["AUTO", "NATIVE", "OCR", "LLM", "OCR_THEN_LLM"])
+      return false unless attachment_text_extraction_method_validator.valid?(@attachment_text_extraction_method)
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] field Object to be assigned
     def field=(field)
-      validator = EnumAttributeValidator.new('String', ["RECIPIENTS", "SENDER", "SUBJECT", "ATTACHMENTS"])
+      validator = EnumAttributeValidator.new('String', ["RECIPIENTS", "SENDER", "SUBJECT", "ATTACHMENTS", "ATTACHMENT_FILENAME", "ATTACHMENT_TEXT"])
       unless validator.valid?(field)
         fail ArgumentError, "invalid value for \"field\", must be one of #{validator.allowable_values}."
       end
       @field = field
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] should Object to be assigned
+    def should=(should)
+      validator = EnumAttributeValidator.new('String', ["WILDCARD", "MATCH", "CONTAIN", "EQUAL"])
+      unless validator.valid?(should)
+        fail ArgumentError, "invalid value for \"should\", must be one of #{validator.allowable_values}."
+      end
+      @should = should
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] attachment_text_extraction_method Object to be assigned
+    def attachment_text_extraction_method=(attachment_text_extraction_method)
+      validator = EnumAttributeValidator.new('String', ["AUTO", "NATIVE", "OCR", "LLM", "OCR_THEN_LLM"])
+      unless validator.valid?(attachment_text_extraction_method)
+        fail ArgumentError, "invalid value for \"attachment_text_extraction_method\", must be one of #{validator.allowable_values}."
+      end
+      @attachment_text_extraction_method = attachment_text_extraction_method
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -196,7 +241,10 @@ module MailSlurpClient
           field == o.field &&
           match == o.match &&
           forward_to_recipients == o.forward_to_recipients &&
-          created_at == o.created_at
+          created_at == o.created_at &&
+          should == o.should &&
+          match_options == o.match_options &&
+          attachment_text_extraction_method == o.attachment_text_extraction_method
     end
 
     # @see the `==` method
@@ -208,7 +256,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, inbox_id, name, field, match, forward_to_recipients, created_at].hash
+      [id, inbox_id, name, field, match, forward_to_recipients, created_at, should, match_options, attachment_text_extraction_method].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/inbox_forwarder_event_projection.rb

@@ -19,6 +19,8 @@ module MailSlurpClient
 
     attr_accessor :id
 
+    attr_accessor :status
+
     attr_accessor :user_id
 
     attr_accessor :email_id
@@ -31,8 +33,6 @@ module MailSlurpClient
 
     attr_accessor :forwarder_id
 
-    attr_accessor :status
-
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -60,13 +60,13 @@ module MailSlurpClient
       {
         :'message' => :'message',
         :'id' => :'id',
+        :'status' => :'status',
         :'user_id' => :'userId',
         :'email_id' => :'emailId',
         :'inbox_id' => :'inboxId',
         :'created_at' => :'createdAt',
         :'sent_id' => :'sentId',
-        :'forwarder_id' => :'forwarderId',
-        :'status' => :'status'
+        :'forwarder_id' => :'forwarderId'
       }
     end
 
@@ -75,13 +75,13 @@ module MailSlurpClient
       {
         :'message' => :'String',
         :'id' => :'String',
+        :'status' => :'String',
         :'user_id' => :'String',
         :'email_id' => :'String',
         :'inbox_id' => :'String',
         :'created_at' => :'DateTime',
         :'sent_id' => :'String',
-        :'forwarder_id' => :'String',
-        :'status' => :'String'
+        :'forwarder_id' => :'String'
       }
     end
 
@@ -90,12 +90,12 @@ module MailSlurpClient
       Set.new([
         :'message',
         :'id',
+        :'status',
         :'user_id',
         :'email_id',
         :'inbox_id',
         :'sent_id',
-        :'forwarder_id',
-        :'status'
+        :'forwarder_id'
       ])
     end
 
@@ -122,6 +122,10 @@ module MailSlurpClient
         self.id = attributes[:'id']
       end
 
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
       if attributes.key?(:'user_id')
         self.user_id = attributes[:'user_id']
       end
@@ -145,10 +149,6 @@ module MailSlurpClient
       if attributes.key?(:'forwarder_id')
         self.forwarder_id = attributes[:'forwarder_id']
       end
-
-      if attributes.key?(:'status')
-        self.status = attributes[:'status']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -165,9 +165,9 @@ module MailSlurpClient
     # 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 @created_at.nil?
       status_validator = EnumAttributeValidator.new('String', ["SUCCESS", "FAILURE"])
       return false unless status_validator.valid?(@status)
+      return false if @created_at.nil?
       true
     end
 
@@ -188,13 +188,13 @@ module MailSlurpClient
       self.class == o.class &&
           message == o.message &&
           id == o.id &&
+          status == o.status &&
           user_id == o.user_id &&
           email_id == o.email_id &&
           inbox_id == o.inbox_id &&
           created_at == o.created_at &&
           sent_id == o.sent_id &&
-          forwarder_id == o.forwarder_id &&
-          status == o.status
+          forwarder_id == o.forwarder_id
     end
 
     # @see the `==` method
@@ -206,7 +206,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [message, id, user_id, email_id, inbox_id, created_at, sent_id, forwarder_id, status].hash
+      [message, id, status, user_id, email_id, inbox_id, created_at, sent_id, forwarder_id].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/inbox_forwarder_test_options.rb

@@ -15,25 +15,33 @@ require 'date'
 module MailSlurpClient
   # Options for testing an inbox forwarder against a value
   class InboxForwarderTestOptions
+    # Simple value to test against the forwarder's simple field/match rule. Required when emailId is not provided.
     attr_accessor :test_value
 
+    # Optional email ID to evaluate the forwarder using full inbound email content (headers, recipients, and attachments).
+    attr_accessor :email_id
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'test_value' => :'testValue'
+        :'test_value' => :'testValue',
+        :'email_id' => :'emailId'
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'test_value' => :'String'
+        :'test_value' => :'String',
+        :'email_id' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'test_value',
+        :'email_id'
       ])
     end
 
@@ -55,23 +63,22 @@ module MailSlurpClient
       if attributes.key?(:'test_value')
         self.test_value = attributes[:'test_value']
       end
+
+      if attributes.key?(:'email_id')
+        self.email_id = attributes[:'email_id']
+      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 @test_value.nil?
-        invalid_properties.push('invalid value for "test_value", test_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 @test_value.nil?
       true
     end
 
@@ -80,7 +87,8 @@ module MailSlurpClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          test_value == o.test_value
+          test_value == o.test_value &&
+          email_id == o.email_id
     end
 
     # @see the `==` method
@@ -92,7 +100,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [test_value].hash
+      [test_value, email_id].hash
     end
 
     # Builds the object from hash