mailslurp_client 15.11.0 → 15.12.1

data/lib/mailslurp_client/models/user_info_dto.rb

@@ -0,0 +1,334 @@
+=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 UserInfoDto
+    attr_accessor :id
+
+    attr_accessor :email_address
+
+    attr_accessor :account_state
+
+    attr_accessor :subscription_type
+
+    attr_accessor :account_type
+
+    attr_accessor :created_at
+
+    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
+      {
+        :'id' => :'id',
+        :'email_address' => :'emailAddress',
+        :'account_state' => :'accountState',
+        :'subscription_type' => :'subscriptionType',
+        :'account_type' => :'accountType',
+        :'created_at' => :'createdAt'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'email_address' => :'String',
+        :'account_state' => :'String',
+        :'subscription_type' => :'String',
+        :'account_type' => :'String',
+        :'created_at' => :'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::UserInfoDto` 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::UserInfoDto`. 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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'email_address')
+        self.email_address = attributes[:'email_address']
+      end
+
+      if attributes.key?(:'account_state')
+        self.account_state = attributes[:'account_state']
+      end
+
+      if attributes.key?(:'subscription_type')
+        self.subscription_type = attributes[:'subscription_type']
+      end
+
+      if attributes.key?(:'account_type')
+        self.account_type = attributes[:'account_type']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @email_address.nil?
+        invalid_properties.push('invalid value for "email_address", email_address cannot be nil.')
+      end
+
+      if @account_state.nil?
+        invalid_properties.push('invalid value for "account_state", account_state cannot be nil.')
+      end
+
+      if @account_type.nil?
+        invalid_properties.push('invalid value for "account_type", account_type cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at 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 @id.nil?
+      return false if @email_address.nil?
+      return false if @account_state.nil?
+      account_state_validator = EnumAttributeValidator.new('String', ["FROZEN", "ACTIVE"])
+      return false unless account_state_validator.valid?(@account_state)
+      subscription_type_validator = EnumAttributeValidator.new('String', ["PRO_MONTHLY", "STARTER", "TEAM", "ENTERPRISE"])
+      return false unless subscription_type_validator.valid?(@subscription_type)
+      return false if @account_type.nil?
+      account_type_validator = EnumAttributeValidator.new('String', ["SOLO", "CHILD_SOLO", "CHILD_TEAM"])
+      return false unless account_type_validator.valid?(@account_type)
+      return false if @created_at.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] account_state Object to be assigned
+    def account_state=(account_state)
+      validator = EnumAttributeValidator.new('String', ["FROZEN", "ACTIVE"])
+      unless validator.valid?(account_state)
+        fail ArgumentError, "invalid value for \"account_state\", must be one of #{validator.allowable_values}."
+      end
+      @account_state = account_state
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] subscription_type Object to be assigned
+    def subscription_type=(subscription_type)
+      validator = EnumAttributeValidator.new('String', ["PRO_MONTHLY", "STARTER", "TEAM", "ENTERPRISE"])
+      unless validator.valid?(subscription_type)
+        fail ArgumentError, "invalid value for \"subscription_type\", must be one of #{validator.allowable_values}."
+      end
+      @subscription_type = subscription_type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] account_type Object to be assigned
+    def account_type=(account_type)
+      validator = EnumAttributeValidator.new('String', ["SOLO", "CHILD_SOLO", "CHILD_TEAM"])
+      unless validator.valid?(account_type)
+        fail ArgumentError, "invalid value for \"account_type\", must be one of #{validator.allowable_values}."
+      end
+      @account_type = account_type
+    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 &&
+          id == o.id &&
+          email_address == o.email_address &&
+          account_state == o.account_state &&
+          subscription_type == o.subscription_type &&
+          account_type == o.account_type &&
+          created_at == o.created_at
+    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
+      [id, email_address, account_state, subscription_type, account_type, created_at].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/wait_for_sms_conditions.rb

@@ -0,0 +1,371 @@
+=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
+  # Conditions to apply to emails that you are waiting for
+  class WaitForSmsConditions
+    # ID of phone number to search within and apply conditions to. Essentially filtering the SMS found to give a count.
+    attr_accessor :phone_number_id
+
+    # Limit results
+    attr_accessor :limit
+
+    # 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
+
+    # Max time in milliseconds to wait between retries if a `timeout` is specified.
+    attr_accessor :delay_timeout
+
+    # Max time in milliseconds to retry the `waitFor` operation until conditions are met.
+    attr_accessor :timeout
+
+    # Apply conditions only to **unread** SMS. All SMS messages begin with `read=false`. An SMS is marked `read=true` when an `SMS` has been returned to the user at least once. For example you have called `getSms` or `waitForSms` etc., or you have viewed the SMS in the dashboard.
+    attr_accessor :unread_only
+
+    # How result size should be compared with the expected size. Exactly or at-least matching result?
+    attr_accessor :count_type
+
+    # Conditions that should be matched for an SMS to qualify for results. Each condition will be applied in order to each SMS within a phone number to filter a result list of matching SMSs you are waiting for.
+    attr_accessor :matches
+
+    # Direction to sort matching SMSs by created time
+    attr_accessor :sort_direction
+
+    # ISO Date Time earliest time of SMS to consider. Filter for matching SMSs that were received after this date
+    attr_accessor :since
+
+    # ISO Date Time latest time of SMS to consider. Filter for matching SMSs that were received before this date
+    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
+      {
+        :'phone_number_id' => :'phoneNumberId',
+        :'limit' => :'limit',
+        :'count' => :'count',
+        :'delay_timeout' => :'delayTimeout',
+        :'timeout' => :'timeout',
+        :'unread_only' => :'unreadOnly',
+        :'count_type' => :'countType',
+        :'matches' => :'matches',
+        :'sort_direction' => :'sortDirection',
+        :'since' => :'since',
+        :'before' => :'before'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'phone_number_id' => :'String',
+        :'limit' => :'Integer',
+        :'count' => :'Integer',
+        :'delay_timeout' => :'Integer',
+        :'timeout' => :'Integer',
+        :'unread_only' => :'Boolean',
+        :'count_type' => :'String',
+        :'matches' => :'Array<SmsMatchOption>',
+        :'sort_direction' => :'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::WaitForSmsConditions` 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::WaitForSmsConditions`. 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?(:'phone_number_id')
+        self.phone_number_id = attributes[:'phone_number_id']
+      end
+
+      if attributes.key?(:'limit')
+        self.limit = attributes[:'limit']
+      end
+
+      if attributes.key?(:'count')
+        self.count = attributes[:'count']
+      end
+
+      if attributes.key?(:'delay_timeout')
+        self.delay_timeout = attributes[:'delay_timeout']
+      end
+
+      if attributes.key?(:'timeout')
+        self.timeout = attributes[:'timeout']
+      end
+
+      if attributes.key?(:'unread_only')
+        self.unread_only = attributes[:'unread_only']
+      end
+
+      if attributes.key?(:'count_type')
+        self.count_type = attributes[:'count_type']
+      end
+
+      if attributes.key?(:'matches')
+        if (value = attributes[:'matches']).is_a?(Array)
+          self.matches = value
+        end
+      end
+
+      if attributes.key?(:'sort_direction')
+        self.sort_direction = attributes[:'sort_direction']
+      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 @phone_number_id.nil?
+        invalid_properties.push('invalid value for "phone_number_id", phone_number_id cannot be nil.')
+      end
+
+      if @count.nil?
+        invalid_properties.push('invalid value for "count", count cannot be nil.')
+      end
+
+      if @timeout.nil?
+        invalid_properties.push('invalid value for "timeout", timeout 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 @phone_number_id.nil?
+      return false if @count.nil?
+      return false if @timeout.nil?
+      count_type_validator = EnumAttributeValidator.new('String', ["EXACTLY", "ATLEAST"])
+      return false unless count_type_validator.valid?(@count_type)
+      sort_direction_validator = EnumAttributeValidator.new('String', ["ASC", "DESC"])
+      return false unless sort_direction_validator.valid?(@sort_direction)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] count_type Object to be assigned
+    def count_type=(count_type)
+      validator = EnumAttributeValidator.new('String', ["EXACTLY", "ATLEAST"])
+      unless validator.valid?(count_type)
+        fail ArgumentError, "invalid value for \"count_type\", must be one of #{validator.allowable_values}."
+      end
+      @count_type = count_type
+    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 &&
+          phone_number_id == o.phone_number_id &&
+          limit == o.limit &&
+          count == o.count &&
+          delay_timeout == o.delay_timeout &&
+          timeout == o.timeout &&
+          unread_only == o.unread_only &&
+          count_type == o.count_type &&
+          matches == o.matches &&
+          sort_direction == o.sort_direction &&
+          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
+      [phone_number_id, limit, count, delay_timeout, timeout, unread_only, count_type, matches, sort_direction, 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