mailslurp_client 5.0.0 → 7.0.7

data/lib/mailslurp_client/models/email.rb

@@ -1,52 +1,67 @@
 =begin
 #MailSlurp API
 
-#For documentation see [developer guide](https://www.mailslurp.com/developers). [Create an account](https://app.mailslurp.com) in the MailSlurp Dashboard to [view your API Key](https://app). For all bugs, feature requests, or help please [see support](https://www.mailslurp.com/support/).
+#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: 67c9a1eda264be4cfe0bb2c76151f0aadf0862bc
 
-OpenAPI spec version: 0.0.1-alpha
-Contact: contact@mailslurp.dev
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 3.3.4
+OpenAPI Generator version: 4.2.3
 
 =end
 
 require 'date'
 
 module MailSlurpClient
-  # Representation of an email
+  # Representation of an email received by an inbox. Use the ID to access more properties of an email using the EmailController endpoints.
   class Email
     attr_accessor :analysis
 
+    # List of IDs of attachments found in the email. Use these IDs with the Inbox and Email Controllers to download attachments and attachment meta data such as filesize, name, extension.
     attr_accessor :attachments
 
+    # List of `BCC` recipients email was addressed to
     attr_accessor :bcc
 
+    # The body of the email message
     attr_accessor :body
 
+    # List of `CC` recipients email was addressed to
     attr_accessor :cc
 
+    # Detected character set of the email body such as UTF-8
     attr_accessor :charset
 
+    # When was the email received by MailSlurp
     attr_accessor :created_at
 
+    # Who the email was sent from
     attr_accessor :from
 
     attr_accessor :headers
 
-    attr_accessor :html
-
+    # ID of the email
     attr_accessor :id
 
+    # ID of the inbox that received the email
     attr_accessor :inbox_id
 
-    attr_accessor :raw_url
+    # Was HTML sent in the email body
+    attr_accessor :is_html
 
+    # Has the email been viewed ever
+    attr_accessor :read
+
+    # The subject line of the email message
     attr_accessor :subject
 
+    # List of `To` recipients email was addressed to
     attr_accessor :to
 
+    # When was the email last updated
     attr_accessor :updated_at
 
+    # ID of user that email belongs
     attr_accessor :user_id
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -61,10 +76,10 @@ module MailSlurpClient
         :'created_at' => :'createdAt',
         :'from' => :'from',
         :'headers' => :'headers',
-        :'html' => :'html',
         :'id' => :'id',
         :'inbox_id' => :'inboxId',
-        :'raw_url' => :'rawUrl',
+        :'is_html' => :'isHTML',
+        :'read' => :'read',
         :'subject' => :'subject',
         :'to' => :'to',
         :'updated_at' => :'updatedAt',
@@ -84,10 +99,10 @@ module MailSlurpClient
         :'created_at' => :'DateTime',
         :'from' => :'String',
         :'headers' => :'Hash<String, String>',
-        :'html' => :'BOOLEAN',
         :'id' => :'String',
         :'inbox_id' => :'String',
-        :'raw_url' => :'String',
+        :'is_html' => :'Boolean',
+        :'read' => :'Boolean',
         :'subject' => :'String',
         :'to' => :'Array<String>',
         :'updated_at' => :'DateTime',
@@ -95,90 +110,103 @@ module MailSlurpClient
       }
     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 = {})
-      return unless attributes.is_a?(Hash)
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::Email` initialize method"
+      end
 
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+      # 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::Email`. 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.has_key?(:'analysis')
+      if attributes.key?(:'analysis')
         self.analysis = attributes[:'analysis']
       end
 
-      if attributes.has_key?(:'attachments')
+      if attributes.key?(:'attachments')
         if (value = attributes[:'attachments']).is_a?(Array)
           self.attachments = value
         end
       end
 
-      if attributes.has_key?(:'bcc')
+      if attributes.key?(:'bcc')
         if (value = attributes[:'bcc']).is_a?(Array)
           self.bcc = value
         end
       end
 
-      if attributes.has_key?(:'body')
+      if attributes.key?(:'body')
         self.body = attributes[:'body']
       end
 
-      if attributes.has_key?(:'cc')
+      if attributes.key?(:'cc')
         if (value = attributes[:'cc']).is_a?(Array)
           self.cc = value
         end
       end
 
-      if attributes.has_key?(:'charset')
+      if attributes.key?(:'charset')
         self.charset = attributes[:'charset']
       end
 
-      if attributes.has_key?(:'createdAt')
-        self.created_at = attributes[:'createdAt']
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
       end
 
-      if attributes.has_key?(:'from')
+      if attributes.key?(:'from')
         self.from = attributes[:'from']
       end
 
-      if attributes.has_key?(:'headers')
+      if attributes.key?(:'headers')
         if (value = attributes[:'headers']).is_a?(Hash)
           self.headers = value
         end
       end
 
-      if attributes.has_key?(:'html')
-        self.html = attributes[:'html']
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
       end
 
-      if attributes.has_key?(:'id')
-        self.id = attributes[:'id']
+      if attributes.key?(:'inbox_id')
+        self.inbox_id = attributes[:'inbox_id']
       end
 
-      if attributes.has_key?(:'inboxId')
-        self.inbox_id = attributes[:'inboxId']
+      if attributes.key?(:'is_html')
+        self.is_html = attributes[:'is_html']
       end
 
-      if attributes.has_key?(:'rawUrl')
-        self.raw_url = attributes[:'rawUrl']
+      if attributes.key?(:'read')
+        self.read = attributes[:'read']
       end
 
-      if attributes.has_key?(:'subject')
+      if attributes.key?(:'subject')
         self.subject = attributes[:'subject']
       end
 
-      if attributes.has_key?(:'to')
+      if attributes.key?(:'to')
         if (value = attributes[:'to']).is_a?(Array)
           self.to = value
         end
       end
 
-      if attributes.has_key?(:'updatedAt')
-        self.updated_at = attributes[:'updatedAt']
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
       end
 
-      if attributes.has_key?(:'userId')
-        self.user_id = attributes[:'userId']
+      if attributes.key?(:'user_id')
+        self.user_id = attributes[:'user_id']
       end
     end
 
@@ -186,42 +214,12 @@ module MailSlurpClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @created_at.nil?
-        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
-      end
-
-      if @id.nil?
-        invalid_properties.push('invalid value for "id", id cannot be nil.')
-      end
-
-      if @inbox_id.nil?
-        invalid_properties.push('invalid value for "inbox_id", inbox_id cannot be nil.')
-      end
-
-      if @to.nil?
-        invalid_properties.push('invalid value for "to", to cannot be nil.')
-      end
-
-      if @updated_at.nil?
-        invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
-      end
-
-      if @user_id.nil?
-        invalid_properties.push('invalid value for "user_id", user_id 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 @created_at.nil?
-      return false if @id.nil?
-      return false if @inbox_id.nil?
-      return false if @to.nil?
-      return false if @updated_at.nil?
-      return false if @user_id.nil?
       true
     end
 
@@ -239,10 +237,10 @@ module MailSlurpClient
           created_at == o.created_at &&
           from == o.from &&
           headers == o.headers &&
-          html == o.html &&
           id == o.id &&
           inbox_id == o.inbox_id &&
-          raw_url == o.raw_url &&
+          is_html == o.is_html &&
+          read == o.read &&
           subject == o.subject &&
           to == o.to &&
           updated_at == o.updated_at &&
@@ -256,9 +254,16 @@ module MailSlurpClient
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [analysis, attachments, bcc, body, cc, charset, created_at, from, headers, html, id, inbox_id, raw_url, subject, to, updated_at, user_id].hash
+      [analysis, attachments, bcc, body, cc, charset, created_at, from, headers, id, inbox_id, is_html, read, subject, to, updated_at, user_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
@@ -268,7 +273,7 @@ module MailSlurpClient
       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 the attribute
+          # 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) })
@@ -297,7 +302,7 @@ module MailSlurpClient
         value.to_i
       when :Float
         value.to_f
-      when :BOOLEAN
+      when :Boolean
         if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true
         else
@@ -318,8 +323,7 @@ module MailSlurpClient
           end
         end
       else # model
-        temp_model = MailSlurpClient.const_get(type).new
-        temp_model.build_from_hash(value)
+        MailSlurpClient.const_get(type).build_from_hash(value)
       end
     end
 
@@ -341,7 +345,11 @@ module MailSlurpClient
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
-        next if value.nil?
+        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

data/lib/mailslurp_client/models/email_analysis.rb

@@ -1,12 +1,12 @@
 =begin
 #MailSlurp API
 
-#For documentation see [developer guide](https://www.mailslurp.com/developers). [Create an account](https://app.mailslurp.com) in the MailSlurp Dashboard to [view your API Key](https://app). For all bugs, feature requests, or help please [see support](https://www.mailslurp.com/support/).
+#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: 67c9a1eda264be4cfe0bb2c76151f0aadf0862bc
 
-OpenAPI spec version: 0.0.1-alpha
-Contact: contact@mailslurp.dev
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 3.3.4
+OpenAPI Generator version: 4.2.3
 
 =end
 
@@ -47,32 +47,45 @@ module MailSlurpClient
       }
     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 = {})
-      return unless attributes.is_a?(Hash)
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::EmailAnalysis` initialize method"
+      end
 
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+      # 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::EmailAnalysis`. 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.has_key?(:'dkimVerdict')
-        self.dkim_verdict = attributes[:'dkimVerdict']
+      if attributes.key?(:'dkim_verdict')
+        self.dkim_verdict = attributes[:'dkim_verdict']
       end
 
-      if attributes.has_key?(:'dmarcVerdict')
-        self.dmarc_verdict = attributes[:'dmarcVerdict']
+      if attributes.key?(:'dmarc_verdict')
+        self.dmarc_verdict = attributes[:'dmarc_verdict']
       end
 
-      if attributes.has_key?(:'spamVerdict')
-        self.spam_verdict = attributes[:'spamVerdict']
+      if attributes.key?(:'spam_verdict')
+        self.spam_verdict = attributes[:'spam_verdict']
       end
 
-      if attributes.has_key?(:'spfVerdict')
-        self.spf_verdict = attributes[:'spfVerdict']
+      if attributes.key?(:'spf_verdict')
+        self.spf_verdict = attributes[:'spf_verdict']
       end
 
-      if attributes.has_key?(:'virusVerdict')
-        self.virus_verdict = attributes[:'virusVerdict']
+      if attributes.key?(:'virus_verdict')
+        self.virus_verdict = attributes[:'virus_verdict']
       end
     end
 
@@ -80,37 +93,12 @@ module MailSlurpClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @dkim_verdict.nil?
-        invalid_properties.push('invalid value for "dkim_verdict", dkim_verdict cannot be nil.')
-      end
-
-      if @dmarc_verdict.nil?
-        invalid_properties.push('invalid value for "dmarc_verdict", dmarc_verdict cannot be nil.')
-      end
-
-      if @spam_verdict.nil?
-        invalid_properties.push('invalid value for "spam_verdict", spam_verdict cannot be nil.')
-      end
-
-      if @spf_verdict.nil?
-        invalid_properties.push('invalid value for "spf_verdict", spf_verdict cannot be nil.')
-      end
-
-      if @virus_verdict.nil?
-        invalid_properties.push('invalid value for "virus_verdict", virus_verdict 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 @dkim_verdict.nil?
-      return false if @dmarc_verdict.nil?
-      return false if @spam_verdict.nil?
-      return false if @spf_verdict.nil?
-      return false if @virus_verdict.nil?
       true
     end
 
@@ -133,11 +121,18 @@ module MailSlurpClient
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
       [dkim_verdict, dmarc_verdict, spam_verdict, spf_verdict, virus_verdict].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
@@ -145,7 +140,7 @@ module MailSlurpClient
       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 the attribute
+          # 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) })
@@ -174,7 +169,7 @@ module MailSlurpClient
         value.to_i
       when :Float
         value.to_f
-      when :BOOLEAN
+      when :Boolean
         if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true
         else
@@ -195,8 +190,7 @@ module MailSlurpClient
           end
         end
       else # model
-        temp_model = MailSlurpClient.const_get(type).new
-        temp_model.build_from_hash(value)
+        MailSlurpClient.const_get(type).build_from_hash(value)
       end
     end
 
@@ -218,7 +212,11 @@ module MailSlurpClient
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
-        next if value.nil?
+        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