sendmux-mailbox 1.0.0

data/lib/sendmux_mailbox_generated/models/mailbox_message.rb

@@ -0,0 +1,515 @@
+=begin
+#Sendmux API
+
+#Programmatic access to your Sendmux email infrastructure.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Sendmux::Mailbox::Generated
+  class MailboxMessage < ApiModelBase
+    attr_accessor :bcc
+
+    attr_accessor :cc
+
+    attr_accessor :flags
+
+    attr_accessor :folder_ids
+
+    attr_accessor :from
+
+    attr_accessor :has_attachments
+
+    # Message ID
+    attr_accessor :id
+
+    # Active message keywords, including system flags and custom labels.
+    attr_accessor :keywords
+
+    attr_accessor :preview
+
+    attr_accessor :received_at
+
+    attr_accessor :sent_at
+
+    attr_accessor :size_bytes
+
+    attr_accessor :subject
+
+    attr_accessor :thread_id
+
+    attr_accessor :to
+
+    attr_accessor :attachments
+
+    attr_accessor :html_body
+
+    attr_accessor :text_body
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'bcc' => :'bcc',
+        :'cc' => :'cc',
+        :'flags' => :'flags',
+        :'folder_ids' => :'folder_ids',
+        :'from' => :'from',
+        :'has_attachments' => :'has_attachments',
+        :'id' => :'id',
+        :'keywords' => :'keywords',
+        :'preview' => :'preview',
+        :'received_at' => :'received_at',
+        :'sent_at' => :'sent_at',
+        :'size_bytes' => :'size_bytes',
+        :'subject' => :'subject',
+        :'thread_id' => :'thread_id',
+        :'to' => :'to',
+        :'attachments' => :'attachments',
+        :'html_body' => :'html_body',
+        :'text_body' => :'text_body'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'bcc' => :'Array<MailboxAddress>',
+        :'cc' => :'Array<MailboxAddress>',
+        :'flags' => :'MailboxMessageFlags',
+        :'folder_ids' => :'Array<String>',
+        :'from' => :'MailboxMessageSummaryFrom',
+        :'has_attachments' => :'Boolean',
+        :'id' => :'String',
+        :'keywords' => :'Array<String>',
+        :'preview' => :'String',
+        :'received_at' => :'String',
+        :'sent_at' => :'String',
+        :'size_bytes' => :'Integer',
+        :'subject' => :'String',
+        :'thread_id' => :'String',
+        :'to' => :'Array<MailboxAddress>',
+        :'attachments' => :'Array<MailboxAttachment>',
+        :'html_body' => :'String',
+        :'text_body' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'preview',
+        :'received_at',
+        :'sent_at',
+        :'size_bytes',
+        :'subject',
+        :'thread_id',
+        :'html_body',
+        :'text_body'
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'MailboxMessageSummary'
+      ]
+    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 `Sendmux::Mailbox::Generated::MailboxMessage` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Sendmux::Mailbox::Generated::MailboxMessage`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'bcc')
+        if (value = attributes[:'bcc']).is_a?(Array)
+          self.bcc = value
+        end
+      else
+        self.bcc = nil
+      end
+
+      if attributes.key?(:'cc')
+        if (value = attributes[:'cc']).is_a?(Array)
+          self.cc = value
+        end
+      else
+        self.cc = nil
+      end
+
+      if attributes.key?(:'flags')
+        self.flags = attributes[:'flags']
+      else
+        self.flags = nil
+      end
+
+      if attributes.key?(:'folder_ids')
+        if (value = attributes[:'folder_ids']).is_a?(Array)
+          self.folder_ids = value
+        end
+      else
+        self.folder_ids = nil
+      end
+
+      if attributes.key?(:'from')
+        self.from = attributes[:'from']
+      else
+        self.from = nil
+      end
+
+      if attributes.key?(:'has_attachments')
+        self.has_attachments = attributes[:'has_attachments']
+      else
+        self.has_attachments = nil
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'keywords')
+        if (value = attributes[:'keywords']).is_a?(Array)
+          self.keywords = value
+        end
+      else
+        self.keywords = nil
+      end
+
+      if attributes.key?(:'preview')
+        self.preview = attributes[:'preview']
+      else
+        self.preview = nil
+      end
+
+      if attributes.key?(:'received_at')
+        self.received_at = attributes[:'received_at']
+      else
+        self.received_at = nil
+      end
+
+      if attributes.key?(:'sent_at')
+        self.sent_at = attributes[:'sent_at']
+      else
+        self.sent_at = nil
+      end
+
+      if attributes.key?(:'size_bytes')
+        self.size_bytes = attributes[:'size_bytes']
+      else
+        self.size_bytes = nil
+      end
+
+      if attributes.key?(:'subject')
+        self.subject = attributes[:'subject']
+      else
+        self.subject = nil
+      end
+
+      if attributes.key?(:'thread_id')
+        self.thread_id = attributes[:'thread_id']
+      else
+        self.thread_id = nil
+      end
+
+      if attributes.key?(:'to')
+        if (value = attributes[:'to']).is_a?(Array)
+          self.to = value
+        end
+      else
+        self.to = nil
+      end
+
+      if attributes.key?(:'attachments')
+        if (value = attributes[:'attachments']).is_a?(Array)
+          self.attachments = value
+        end
+      else
+        self.attachments = nil
+      end
+
+      if attributes.key?(:'html_body')
+        self.html_body = attributes[:'html_body']
+      else
+        self.html_body = nil
+      end
+
+      if attributes.key?(:'text_body')
+        self.text_body = attributes[:'text_body']
+      else
+        self.text_body = nil
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @bcc.nil?
+        invalid_properties.push('invalid value for "bcc", bcc cannot be nil.')
+      end
+
+      if @cc.nil?
+        invalid_properties.push('invalid value for "cc", cc cannot be nil.')
+      end
+
+      if @flags.nil?
+        invalid_properties.push('invalid value for "flags", flags cannot be nil.')
+      end
+
+      if @folder_ids.nil?
+        invalid_properties.push('invalid value for "folder_ids", folder_ids cannot be nil.')
+      end
+
+      if @from.nil?
+        invalid_properties.push('invalid value for "from", from cannot be nil.')
+      end
+
+      if @has_attachments.nil?
+        invalid_properties.push('invalid value for "has_attachments", has_attachments cannot be nil.')
+      end
+
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @keywords.nil?
+        invalid_properties.push('invalid value for "keywords", keywords cannot be nil.')
+      end
+
+      if @to.nil?
+        invalid_properties.push('invalid value for "to", to cannot be nil.')
+      end
+
+      if @attachments.nil?
+        invalid_properties.push('invalid value for "attachments", attachments 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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @bcc.nil?
+      return false if @cc.nil?
+      return false if @flags.nil?
+      return false if @folder_ids.nil?
+      return false if @from.nil?
+      return false if @has_attachments.nil?
+      return false if @id.nil?
+      return false if @keywords.nil?
+      return false if @to.nil?
+      return false if @attachments.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] bcc Value to be assigned
+    def bcc=(bcc)
+      if bcc.nil?
+        fail ArgumentError, 'bcc cannot be nil'
+      end
+
+      @bcc = bcc
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] cc Value to be assigned
+    def cc=(cc)
+      if cc.nil?
+        fail ArgumentError, 'cc cannot be nil'
+      end
+
+      @cc = cc
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] flags Value to be assigned
+    def flags=(flags)
+      if flags.nil?
+        fail ArgumentError, 'flags cannot be nil'
+      end
+
+      @flags = flags
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] folder_ids Value to be assigned
+    def folder_ids=(folder_ids)
+      if folder_ids.nil?
+        fail ArgumentError, 'folder_ids cannot be nil'
+      end
+
+      @folder_ids = folder_ids
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] from Value to be assigned
+    def from=(from)
+      if from.nil?
+        fail ArgumentError, 'from cannot be nil'
+      end
+
+      @from = from
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] has_attachments Value to be assigned
+    def has_attachments=(has_attachments)
+      if has_attachments.nil?
+        fail ArgumentError, 'has_attachments cannot be nil'
+      end
+
+      @has_attachments = has_attachments
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] keywords Value to be assigned
+    def keywords=(keywords)
+      if keywords.nil?
+        fail ArgumentError, 'keywords cannot be nil'
+      end
+
+      @keywords = keywords
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] to Value to be assigned
+    def to=(to)
+      if to.nil?
+        fail ArgumentError, 'to cannot be nil'
+      end
+
+      @to = to
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] attachments Value to be assigned
+    def attachments=(attachments)
+      if attachments.nil?
+        fail ArgumentError, 'attachments cannot be nil'
+      end
+
+      @attachments = attachments
+    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 &&
+          bcc == o.bcc &&
+          cc == o.cc &&
+          flags == o.flags &&
+          folder_ids == o.folder_ids &&
+          from == o.from &&
+          has_attachments == o.has_attachments &&
+          id == o.id &&
+          keywords == o.keywords &&
+          preview == o.preview &&
+          received_at == o.received_at &&
+          sent_at == o.sent_at &&
+          size_bytes == o.size_bytes &&
+          subject == o.subject &&
+          thread_id == o.thread_id &&
+          to == o.to &&
+          attachments == o.attachments &&
+          html_body == o.html_body &&
+          text_body == o.text_body
+    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
+      [bcc, cc, flags, folder_ids, from, has_attachments, id, keywords, preview, received_at, sent_at, size_bytes, subject, thread_id, to, attachments, html_body, text_body].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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif 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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_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
+
+  end
+
+end