mailslurp_client 5.0.0 → 7.0.7

data/lib/mailslurp_client/models/email_preview.rb

@@ -1,39 +1,53 @@
 =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
-  # Preview of an email message. For full message call the message endpoint with a given message id.
+  # Preview of an email message. For full message call the email endpoints with the provided email id.
   class EmailPreview
+    # 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
 
+    # List of `CC` recipients email was addressed to
     attr_accessor :cc
 
-    attr_accessor :created
+    # When was the email received by MailSlurp
+    attr_accessor :created_at
 
+    # ID of the email
     attr_accessor :id
 
+    # 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
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'attachments' => :'attachments',
         :'bcc' => :'bcc',
         :'cc' => :'cc',
-        :'created' => :'created',
+        :'created_at' => :'createdAt',
         :'id' => :'id',
+        :'read' => :'read',
         :'subject' => :'subject',
         :'to' => :'to'
       }
@@ -42,48 +56,73 @@ module MailSlurpClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'attachments' => :'Array<String>',
         :'bcc' => :'Array<String>',
         :'cc' => :'Array<String>',
-        :'created' => :'DateTime',
+        :'created_at' => :'DateTime',
         :'id' => :'String',
+        :'read' => :'Boolean',
         :'subject' => :'String',
         :'to' => :'Array<String>'
       }
     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::EmailPreview` 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::EmailPreview`. 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?(:'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?(:'cc')
+      if attributes.key?(:'cc')
         if (value = attributes[:'cc']).is_a?(Array)
           self.cc = value
         end
       end
 
-      if attributes.has_key?(:'created')
-        self.created = attributes[:'created']
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
       end
 
-      if attributes.has_key?(:'id')
+      if attributes.key?(:'id')
         self.id = attributes[:'id']
       end
 
-      if attributes.has_key?(:'subject')
+      if attributes.key?(:'read')
+        self.read = attributes[:'read']
+      end
+
+      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
@@ -94,27 +133,12 @@ module MailSlurpClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @created.nil?
-        invalid_properties.push('invalid value for "created", created cannot be nil.')
-      end
-
-      if @id.nil?
-        invalid_properties.push('invalid value for "id", id cannot be nil.')
-      end
-
-      if @to.nil?
-        invalid_properties.push('invalid value for "to", to 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.nil?
-      return false if @id.nil?
-      return false if @to.nil?
       true
     end
 
@@ -123,10 +147,12 @@ module MailSlurpClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          attachments == o.attachments &&
           bcc == o.bcc &&
           cc == o.cc &&
-          created == o.created &&
+          created_at == o.created_at &&
           id == o.id &&
+          read == o.read &&
           subject == o.subject &&
           to == o.to
     end
@@ -138,9 +164,16 @@ module MailSlurpClient
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [bcc, cc, created, id, subject, to].hash
+      [attachments, bcc, cc, created_at, id, read, subject, to].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
@@ -150,7 +183,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) })
@@ -179,7 +212,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
@@ -200,8 +233,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
 
@@ -223,7 +255,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_projection.rb

@@ -0,0 +1,306 @@
+=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: 67c9a1eda264be4cfe0bb2c76151f0aadf0862bc
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.3
+
+=end
+
+require 'date'
+
+module MailSlurpClient
+  class EmailProjection
+    attr_accessor :attachments
+
+    attr_accessor :bcc
+
+    attr_accessor :cc
+
+    attr_accessor :created_at
+
+    attr_accessor :id
+
+    attr_accessor :inbox_id
+
+    attr_accessor :read
+
+    attr_accessor :subject
+
+    attr_accessor :to
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'attachments' => :'attachments',
+        :'bcc' => :'bcc',
+        :'cc' => :'cc',
+        :'created_at' => :'createdAt',
+        :'id' => :'id',
+        :'inbox_id' => :'inboxId',
+        :'read' => :'read',
+        :'subject' => :'subject',
+        :'to' => :'to'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'attachments' => :'Array<String>',
+        :'bcc' => :'Array<String>',
+        :'cc' => :'Array<String>',
+        :'created_at' => :'DateTime',
+        :'id' => :'String',
+        :'inbox_id' => :'String',
+        :'read' => :'Boolean',
+        :'subject' => :'String',
+        :'to' => :'Array<String>'
+      }
+    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::EmailProjection` 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::EmailProjection`. 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?(:'attachments')
+        if (value = attributes[:'attachments']).is_a?(Array)
+          self.attachments = value
+        end
+      end
+
+      if attributes.key?(:'bcc')
+        if (value = attributes[:'bcc']).is_a?(Array)
+          self.bcc = value
+        end
+      end
+
+      if attributes.key?(:'cc')
+        if (value = attributes[:'cc']).is_a?(Array)
+          self.cc = value
+        end
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'inbox_id')
+        self.inbox_id = attributes[:'inbox_id']
+      end
+
+      if attributes.key?(:'read')
+        self.read = attributes[:'read']
+      end
+
+      if attributes.key?(:'subject')
+        self.subject = attributes[:'subject']
+      end
+
+      if attributes.key?(:'to')
+        if (value = attributes[:'to']).is_a?(Array)
+          self.to = 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 @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
+
+      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?
+      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 &&
+          attachments == o.attachments &&
+          bcc == o.bcc &&
+          cc == o.cc &&
+          created_at == o.created_at &&
+          id == o.id &&
+          inbox_id == o.inbox_id &&
+          read == o.read &&
+          subject == o.subject &&
+          to == o.to
+    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
+      [attachments, bcc, cc, created_at, id, inbox_id, read, subject, to].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