mailslurp_client 15.17.24 → 15.17.26

data/lib/mailslurp_client/models/search_emails_options.rb

@@ -0,0 +1,328 @@
+=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://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
+  class SearchEmailsOptions
+    # Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
+    attr_accessor :inbox_ids
+
+    # Optional page index in email list pagination
+    attr_accessor :page_index
+
+    # Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results
+    attr_accessor :page_size
+
+    # Optional createdAt sort direction ASC or DESC
+    attr_accessor :sort_direction
+
+    # Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly
+    attr_accessor :unread_only
+
+    # Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body
+    attr_accessor :search_filter
+
+    # Optional filter emails received after given date time
+    attr_accessor :since
+
+    # Optional filter emails received before given date time
+    attr_accessor :before
+
+    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
+      {
+        :'inbox_ids' => :'inboxIds',
+        :'page_index' => :'pageIndex',
+        :'page_size' => :'pageSize',
+        :'sort_direction' => :'sortDirection',
+        :'unread_only' => :'unreadOnly',
+        :'search_filter' => :'searchFilter',
+        :'since' => :'since',
+        :'before' => :'before'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'inbox_ids' => :'Array<String>',
+        :'page_index' => :'Integer',
+        :'page_size' => :'Integer',
+        :'sort_direction' => :'String',
+        :'unread_only' => :'Boolean',
+        :'search_filter' => :'String',
+        :'since' => :'DateTime',
+        :'before' => :'DateTime'
+      }
+    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::SearchEmailsOptions` 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::SearchEmailsOptions`. 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?(:'inbox_ids')
+        if (value = attributes[:'inbox_ids']).is_a?(Array)
+          self.inbox_ids = value
+        end
+      end
+
+      if attributes.key?(:'page_index')
+        self.page_index = attributes[:'page_index']
+      end
+
+      if attributes.key?(:'page_size')
+        self.page_size = attributes[:'page_size']
+      end
+
+      if attributes.key?(:'sort_direction')
+        self.sort_direction = attributes[:'sort_direction']
+      end
+
+      if attributes.key?(:'unread_only')
+        self.unread_only = attributes[:'unread_only']
+      end
+
+      if attributes.key?(:'search_filter')
+        self.search_filter = attributes[:'search_filter']
+      end
+
+      if attributes.key?(:'since')
+        self.since = attributes[:'since']
+      end
+
+      if attributes.key?(:'before')
+        self.before = attributes[:'before']
+      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 !@page_size.nil? && @page_size > 100
+        invalid_properties.push('invalid value for "page_size", must be smaller than or equal to 100.')
+      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 !@page_size.nil? && @page_size > 100
+      sort_direction_validator = EnumAttributeValidator.new('String', ["ASC", "DESC"])
+      return false unless sort_direction_validator.valid?(@sort_direction)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] page_size Value to be assigned
+    def page_size=(page_size)
+      if !page_size.nil? && page_size > 100
+        fail ArgumentError, 'invalid value for "page_size", must be smaller than or equal to 100.'
+      end
+
+      @page_size = page_size
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] sort_direction Object to be assigned
+    def sort_direction=(sort_direction)
+      validator = EnumAttributeValidator.new('String', ["ASC", "DESC"])
+      unless validator.valid?(sort_direction)
+        fail ArgumentError, "invalid value for \"sort_direction\", must be one of #{validator.allowable_values}."
+      end
+      @sort_direction = sort_direction
+    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 &&
+          inbox_ids == o.inbox_ids &&
+          page_index == o.page_index &&
+          page_size == o.page_size &&
+          sort_direction == o.sort_direction &&
+          unread_only == o.unread_only &&
+          search_filter == o.search_filter &&
+          since == o.since &&
+          before == o.before
+    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
+      [inbox_ids, page_index, page_size, sort_direction, unread_only, search_filter, since, before].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/search_inboxes_options.rb

@@ -0,0 +1,376 @@
+=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://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
+  class SearchInboxesOptions
+    # Optional page index in list pagination
+    attr_accessor :page_index
+
+    # Optional page size in list pagination
+    attr_accessor :page_size
+
+    # Optional createdAt sort direction ASC or DESC
+    attr_accessor :sort_direction
+
+    # Optionally filter results for favourites only
+    attr_accessor :favourite
+
+    # Optionally filter by search words partial matching ID, tags, name, and email address
+    attr_accessor :search
+
+    # Optionally filter by tags. Will return inboxes that include given tags
+    attr_accessor :tag
+
+    # Optional filter by created after given date time
+    attr_accessor :since
+
+    # Optional filter by created before given date time
+    attr_accessor :before
+
+    # Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send).
+    attr_accessor :inbox_type
+
+    # Optional filter by inbox function
+    attr_accessor :inbox_function
+
+    # Optional domain ID filter
+    attr_accessor :domain_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
+      {
+        :'page_index' => :'pageIndex',
+        :'page_size' => :'pageSize',
+        :'sort_direction' => :'sortDirection',
+        :'favourite' => :'favourite',
+        :'search' => :'search',
+        :'tag' => :'tag',
+        :'since' => :'since',
+        :'before' => :'before',
+        :'inbox_type' => :'inboxType',
+        :'inbox_function' => :'inboxFunction',
+        :'domain_id' => :'domainId'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'page_index' => :'Integer',
+        :'page_size' => :'Integer',
+        :'sort_direction' => :'String',
+        :'favourite' => :'Boolean',
+        :'search' => :'String',
+        :'tag' => :'String',
+        :'since' => :'DateTime',
+        :'before' => :'DateTime',
+        :'inbox_type' => :'String',
+        :'inbox_function' => :'String',
+        :'domain_id' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'page_index',
+        :'page_size',
+        :'sort_direction',
+        :'favourite',
+        :'search',
+        :'tag',
+        :'since',
+        :'before',
+        :'inbox_type',
+        :'inbox_function',
+        :'domain_id'
+      ])
+    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::SearchInboxesOptions` 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::SearchInboxesOptions`. 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?(:'page_index')
+        self.page_index = attributes[:'page_index']
+      end
+
+      if attributes.key?(:'page_size')
+        self.page_size = attributes[:'page_size']
+      end
+
+      if attributes.key?(:'sort_direction')
+        self.sort_direction = attributes[:'sort_direction']
+      end
+
+      if attributes.key?(:'favourite')
+        self.favourite = attributes[:'favourite']
+      end
+
+      if attributes.key?(:'search')
+        self.search = attributes[:'search']
+      end
+
+      if attributes.key?(:'tag')
+        self.tag = attributes[:'tag']
+      end
+
+      if attributes.key?(:'since')
+        self.since = attributes[:'since']
+      end
+
+      if attributes.key?(:'before')
+        self.before = attributes[:'before']
+      end
+
+      if attributes.key?(:'inbox_type')
+        self.inbox_type = attributes[:'inbox_type']
+      end
+
+      if attributes.key?(:'inbox_function')
+        self.inbox_function = attributes[:'inbox_function']
+      end
+
+      if attributes.key?(:'domain_id')
+        self.domain_id = attributes[:'domain_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
+      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?
+      sort_direction_validator = EnumAttributeValidator.new('String', ["ASC", "DESC"])
+      return false unless sort_direction_validator.valid?(@sort_direction)
+      inbox_type_validator = EnumAttributeValidator.new('String', ["HTTP_INBOX", "SMTP_INBOX"])
+      return false unless inbox_type_validator.valid?(@inbox_type)
+      inbox_function_validator = EnumAttributeValidator.new('String', ["ALIAS", "THREAD", "CATCH_ALL", "CONNECTOR"])
+      return false unless inbox_function_validator.valid?(@inbox_function)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] sort_direction Object to be assigned
+    def sort_direction=(sort_direction)
+      validator = EnumAttributeValidator.new('String', ["ASC", "DESC"])
+      unless validator.valid?(sort_direction)
+        fail ArgumentError, "invalid value for \"sort_direction\", must be one of #{validator.allowable_values}."
+      end
+      @sort_direction = sort_direction
+    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
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] inbox_function Object to be assigned
+    def inbox_function=(inbox_function)
+      validator = EnumAttributeValidator.new('String', ["ALIAS", "THREAD", "CATCH_ALL", "CONNECTOR"])
+      unless validator.valid?(inbox_function)
+        fail ArgumentError, "invalid value for \"inbox_function\", must be one of #{validator.allowable_values}."
+      end
+      @inbox_function = inbox_function
+    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 &&
+          page_index == o.page_index &&
+          page_size == o.page_size &&
+          sort_direction == o.sort_direction &&
+          favourite == o.favourite &&
+          search == o.search &&
+          tag == o.tag &&
+          since == o.since &&
+          before == o.before &&
+          inbox_type == o.inbox_type &&
+          inbox_function == o.inbox_function &&
+          domain_id == o.domain_id
+    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
+      [page_index, page_size, sort_direction, favourite, search, tag, since, before, inbox_type, inbox_function, domain_id].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