mailslurp_client 8.2.15 → 8.4.0

data/lib/mailslurp_client/models/dns_lookup_results.rb

@@ -0,0 +1,214 @@
+=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
+  # Results of query on domain name servers
+  class DNSLookupResults
+    attr_accessor :results
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'results' => :'results'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'results' => :'Array<DNSLookupResult>'
+      }
+    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::DNSLookupResults` 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::DNSLookupResults`. 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?(:'results')
+        if (value = attributes[:'results']).is_a?(Array)
+          self.results = 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 @results.nil?
+        invalid_properties.push('invalid value for "results", results 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 @results.nil?
+      true
+    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 &&
+          results == o.results
+    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
+      [results].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/domain_dto.rb

@@ -17,22 +17,29 @@ module MailSlurpClient
   class DomainDto
     attr_accessor :created_at
 
+    # DNS records for DKIM approval
+    attr_accessor :dkim_tokens
+
+    # Custom domain name
     attr_accessor :domain
 
     attr_accessor :id
 
+    # Whether domain has been verified or not. If the domain is not verified after 72 hours there is most likely an issue with the domains DNS records.
     attr_accessor :is_verified
 
     attr_accessor :updated_at
 
     attr_accessor :user_id
 
+    # A TXT record that you must place in the DNS settings of the domain to complete domain verification
     attr_accessor :verification_token
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'created_at' => :'createdAt',
+        :'dkim_tokens' => :'dkimTokens',
         :'domain' => :'domain',
         :'id' => :'id',
         :'is_verified' => :'isVerified',
@@ -46,6 +53,7 @@ module MailSlurpClient
     def self.openapi_types
       {
         :'created_at' => :'DateTime',
+        :'dkim_tokens' => :'Array<String>',
         :'domain' => :'String',
         :'id' => :'String',
         :'is_verified' => :'Boolean',
@@ -80,6 +88,12 @@ module MailSlurpClient
         self.created_at = attributes[:'created_at']
       end
 
+      if attributes.key?(:'dkim_tokens')
+        if (value = attributes[:'dkim_tokens']).is_a?(Array)
+          self.dkim_tokens = value
+        end
+      end
+
       if attributes.key?(:'domain')
         self.domain = attributes[:'domain']
       end
@@ -113,18 +127,10 @@ module MailSlurpClient
         invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
       end
 
-      if @domain.nil?
-        invalid_properties.push('invalid value for "domain", domain cannot be nil.')
-      end
-
       if @id.nil?
         invalid_properties.push('invalid value for "id", id cannot be nil.')
       end
 
-      if @is_verified.nil?
-        invalid_properties.push('invalid value for "is_verified", is_verified cannot be nil.')
-      end
-
       if @updated_at.nil?
         invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
       end
@@ -133,10 +139,6 @@ module MailSlurpClient
         invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
       end
 
-      if @verification_token.nil?
-        invalid_properties.push('invalid value for "verification_token", verification_token cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -144,12 +146,9 @@ module MailSlurpClient
     # @return true if the model is valid
     def valid?
       return false if @created_at.nil?
-      return false if @domain.nil?
       return false if @id.nil?
-      return false if @is_verified.nil?
       return false if @updated_at.nil?
       return false if @user_id.nil?
-      return false if @verification_token.nil?
       true
     end
 
@@ -159,6 +158,7 @@ module MailSlurpClient
       return true if self.equal?(o)
       self.class == o.class &&
           created_at == o.created_at &&
+          dkim_tokens == o.dkim_tokens &&
           domain == o.domain &&
           id == o.id &&
           is_verified == o.is_verified &&
@@ -176,7 +176,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [created_at, domain, id, is_verified, updated_at, user_id, verification_token].hash
+      [created_at, dkim_tokens, domain, id, is_verified, updated_at, user_id, verification_token].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/email.rb

@@ -55,6 +55,9 @@ module MailSlurpClient
     # Has the email been viewed ever
     attr_accessor :read
 
+    # The replyTo field on the received email
+    attr_accessor :reply_to
+
     # The subject line of the email message
     attr_accessor :subject
 
@@ -84,6 +87,7 @@ module MailSlurpClient
         :'inbox_id' => :'inboxId',
         :'is_html' => :'isHTML',
         :'read' => :'read',
+        :'reply_to' => :'replyTo',
         :'subject' => :'subject',
         :'to' => :'to',
         :'updated_at' => :'updatedAt',
@@ -108,6 +112,7 @@ module MailSlurpClient
         :'inbox_id' => :'String',
         :'is_html' => :'Boolean',
         :'read' => :'Boolean',
+        :'reply_to' => :'String',
         :'subject' => :'String',
         :'to' => :'Array<String>',
         :'updated_at' => :'DateTime',
@@ -200,6 +205,10 @@ module MailSlurpClient
         self.read = attributes[:'read']
       end
 
+      if attributes.key?(:'reply_to')
+        self.reply_to = attributes[:'reply_to']
+      end
+
       if attributes.key?(:'subject')
         self.subject = attributes[:'subject']
       end
@@ -251,6 +260,7 @@ module MailSlurpClient
           inbox_id == o.inbox_id &&
           is_html == o.is_html &&
           read == o.read &&
+          reply_to == o.reply_to &&
           subject == o.subject &&
           to == o.to &&
           updated_at == o.updated_at &&
@@ -266,7 +276,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [analysis, attachments, bcc, body, body_md5_hash, cc, charset, created_at, from, headers, id, inbox_id, is_html, read, subject, to, updated_at, user_id].hash
+      [analysis, attachments, bcc, body, body_md5_hash, cc, charset, created_at, from, headers, id, inbox_id, is_html, read, reply_to, subject, to, updated_at, user_id].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/html_validation_result.rb

@@ -15,10 +15,13 @@ require 'date'
 module MailSlurpClient
   # HTML Validation Results
   class HTMLValidationResult
+    # Optional errors resulting from HTML validation
     attr_accessor :errors
 
+    # Is HTML validation result valid
     attr_accessor :is_valid
 
+    # Optional warnings resulting from HTML validation
     attr_accessor :warnings
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -81,27 +84,12 @@ module MailSlurpClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @errors.nil?
-        invalid_properties.push('invalid value for "errors", errors cannot be nil.')
-      end
-
-      if @is_valid.nil?
-        invalid_properties.push('invalid value for "is_valid", is_valid cannot be nil.')
-      end
-
-      if @warnings.nil?
-        invalid_properties.push('invalid value for "warnings", warnings 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 @errors.nil?
-      return false if @is_valid.nil?
-      return false if @warnings.nil?
       true
     end
 

data/lib/mailslurp_client/models/inbox.rb

@@ -15,28 +15,28 @@ require 'date'
 module MailSlurpClient
   # Representation of an inbox with an email address. Emails can be sent to or from this email address.
   class Inbox
-    # When was the inbox created
+    # When was the inbox created. Time stamps are in ISO DateTime Format `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` e.g. `2000-10-31T01:30:00.000-05:00`.
     attr_accessor :created_at
 
     # Optional description of an inbox for labelling purposes
     attr_accessor :description
 
-    # The inbox's email address. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints.
+    # The inbox's email address. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.
     attr_accessor :email_address
 
     # When, if ever, will the inbox expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. Timestamp passed as string.
     attr_accessor :expires_at
 
-    # Is the inbox favourited
+    # Is the inbox favorited. Favouriting inboxes is typically done in the dashboard for quick access
     attr_accessor :favourite
 
-    # ID of the inbox
+    # ID of the inbox. The ID is a UUID-V4 string. See the emailAddress property for the email address.
     attr_accessor :id
 
     # Optional name of the inbox. Displayed in the dashboard for easier search
     attr_accessor :name
 
-    # Tags that inbox has been tagged with
+    # Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.
     attr_accessor :tags
 
     # ID of user that inbox belongs to