sendmux-mailbox 1.0.0

data/lib/sendmux_mailbox_generated/models/mailbox_batch_get_body.rb

@@ -0,0 +1,363 @@
+=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 MailboxBatchGetBody < ApiModelBase
+    attr_accessor :body_mode
+
+    attr_accessor :ids
+
+    attr_accessor :include_attachments
+
+    attr_accessor :include_headers
+
+    attr_accessor :include_html
+
+    attr_accessor :include_links
+
+    attr_accessor :max_body_chars
+
+    attr_accessor :part
+
+    attr_accessor :strip_quotes
+
+    attr_accessor :strip_signature
+
+    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
+      {
+        :'body_mode' => :'body_mode',
+        :'ids' => :'ids',
+        :'include_attachments' => :'include_attachments',
+        :'include_headers' => :'include_headers',
+        :'include_html' => :'include_html',
+        :'include_links' => :'include_links',
+        :'max_body_chars' => :'max_body_chars',
+        :'part' => :'part',
+        :'strip_quotes' => :'strip_quotes',
+        :'strip_signature' => :'strip_signature'
+      }
+    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
+      {
+        :'body_mode' => :'String',
+        :'ids' => :'Array<String>',
+        :'include_attachments' => :'String',
+        :'include_headers' => :'String',
+        :'include_html' => :'Boolean',
+        :'include_links' => :'Boolean',
+        :'max_body_chars' => :'Integer',
+        :'part' => :'String',
+        :'strip_quotes' => :'Boolean',
+        :'strip_signature' => :'Boolean'
+      }
+    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 `Sendmux::Mailbox::Generated::MailboxBatchGetBody` 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::MailboxBatchGetBody`. 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?(:'body_mode')
+        self.body_mode = attributes[:'body_mode']
+      end
+
+      if attributes.key?(:'ids')
+        if (value = attributes[:'ids']).is_a?(Array)
+          self.ids = value
+        end
+      else
+        self.ids = nil
+      end
+
+      if attributes.key?(:'include_attachments')
+        self.include_attachments = attributes[:'include_attachments']
+      end
+
+      if attributes.key?(:'include_headers')
+        self.include_headers = attributes[:'include_headers']
+      end
+
+      if attributes.key?(:'include_html')
+        self.include_html = attributes[:'include_html']
+      end
+
+      if attributes.key?(:'include_links')
+        self.include_links = attributes[:'include_links']
+      end
+
+      if attributes.key?(:'max_body_chars')
+        self.max_body_chars = attributes[:'max_body_chars']
+      end
+
+      if attributes.key?(:'part')
+        self.part = attributes[:'part']
+      end
+
+      if attributes.key?(:'strip_quotes')
+        self.strip_quotes = attributes[:'strip_quotes']
+      end
+
+      if attributes.key?(:'strip_signature')
+        self.strip_signature = attributes[:'strip_signature']
+      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 @ids.nil?
+        invalid_properties.push('invalid value for "ids", ids cannot be nil.')
+      end
+
+      if @ids.length > 100
+        invalid_properties.push('invalid value for "ids", number of items must be less than or equal to 100.')
+      end
+
+      if @ids.length < 1
+        invalid_properties.push('invalid value for "ids", number of items must be greater than or equal to 1.')
+      end
+
+      if !@max_body_chars.nil? && @max_body_chars > 1000000
+        invalid_properties.push('invalid value for "max_body_chars", must be smaller than or equal to 1000000.')
+      end
+
+      if !@max_body_chars.nil? && @max_body_chars < 1
+        invalid_properties.push('invalid value for "max_body_chars", must be greater than or equal to 1.')
+      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'
+      body_mode_validator = EnumAttributeValidator.new('String', ["none", "raw", "clean_json", "unknown_default_open_api"])
+      return false unless body_mode_validator.valid?(@body_mode)
+      return false if @ids.nil?
+      return false if @ids.length > 100
+      return false if @ids.length < 1
+      include_attachments_validator = EnumAttributeValidator.new('String', ["none", "metadata", "unknown_default_open_api"])
+      return false unless include_attachments_validator.valid?(@include_attachments)
+      include_headers_validator = EnumAttributeValidator.new('String', ["none", "selected", "full", "unknown_default_open_api"])
+      return false unless include_headers_validator.valid?(@include_headers)
+      return false if !@max_body_chars.nil? && @max_body_chars > 1000000
+      return false if !@max_body_chars.nil? && @max_body_chars < 1
+      part_validator = EnumAttributeValidator.new('String', ["auto", "text", "html", "both", "unknown_default_open_api"])
+      return false unless part_validator.valid?(@part)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] body_mode Object to be assigned
+    def body_mode=(body_mode)
+      validator = EnumAttributeValidator.new('String', ["none", "raw", "clean_json", "unknown_default_open_api"])
+      unless validator.valid?(body_mode)
+        fail ArgumentError, "invalid value for \"body_mode\", must be one of #{validator.allowable_values}."
+      end
+      @body_mode = body_mode
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ids Value to be assigned
+    def ids=(ids)
+      if ids.nil?
+        fail ArgumentError, 'ids cannot be nil'
+      end
+
+      if ids.length > 100
+        fail ArgumentError, 'invalid value for "ids", number of items must be less than or equal to 100.'
+      end
+
+      if ids.length < 1
+        fail ArgumentError, 'invalid value for "ids", number of items must be greater than or equal to 1.'
+      end
+
+      @ids = ids
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] include_attachments Object to be assigned
+    def include_attachments=(include_attachments)
+      validator = EnumAttributeValidator.new('String', ["none", "metadata", "unknown_default_open_api"])
+      unless validator.valid?(include_attachments)
+        fail ArgumentError, "invalid value for \"include_attachments\", must be one of #{validator.allowable_values}."
+      end
+      @include_attachments = include_attachments
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] include_headers Object to be assigned
+    def include_headers=(include_headers)
+      validator = EnumAttributeValidator.new('String', ["none", "selected", "full", "unknown_default_open_api"])
+      unless validator.valid?(include_headers)
+        fail ArgumentError, "invalid value for \"include_headers\", must be one of #{validator.allowable_values}."
+      end
+      @include_headers = include_headers
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] max_body_chars Value to be assigned
+    def max_body_chars=(max_body_chars)
+      if max_body_chars.nil?
+        fail ArgumentError, 'max_body_chars cannot be nil'
+      end
+
+      if max_body_chars > 1000000
+        fail ArgumentError, 'invalid value for "max_body_chars", must be smaller than or equal to 1000000.'
+      end
+
+      if max_body_chars < 1
+        fail ArgumentError, 'invalid value for "max_body_chars", must be greater than or equal to 1.'
+      end
+
+      @max_body_chars = max_body_chars
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] part Object to be assigned
+    def part=(part)
+      validator = EnumAttributeValidator.new('String', ["auto", "text", "html", "both", "unknown_default_open_api"])
+      unless validator.valid?(part)
+        fail ArgumentError, "invalid value for \"part\", must be one of #{validator.allowable_values}."
+      end
+      @part = part
+    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 &&
+          body_mode == o.body_mode &&
+          ids == o.ids &&
+          include_attachments == o.include_attachments &&
+          include_headers == o.include_headers &&
+          include_html == o.include_html &&
+          include_links == o.include_links &&
+          max_body_chars == o.max_body_chars &&
+          part == o.part &&
+          strip_quotes == o.strip_quotes &&
+          strip_signature == o.strip_signature
+    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
+      [body_mode, ids, include_attachments, include_headers, include_html, include_links, max_body_chars, part, strip_quotes, strip_signature].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

data/lib/sendmux_mailbox_generated/models/mailbox_batch_get_item.rb

@@ -0,0 +1,188 @@
+=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 MailboxBatchGetItem < ApiModelBase
+    attr_accessor :content
+
+    attr_accessor :message
+
+    attr_accessor :raw_body
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'content' => :'content',
+        :'message' => :'message',
+        :'raw_body' => :'raw_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
+      {
+        :'content' => :'MailboxMessageContent',
+        :'message' => :'MailboxMessageSummary',
+        :'raw_body' => :'MailboxRawBody'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'content',
+        :'raw_body'
+      ])
+    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::MailboxBatchGetItem` 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::MailboxBatchGetItem`. 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?(:'content')
+        self.content = attributes[:'content']
+      else
+        self.content = nil
+      end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      else
+        self.message = nil
+      end
+
+      if attributes.key?(:'raw_body')
+        self.raw_body = attributes[:'raw_body']
+      else
+        self.raw_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 @message.nil?
+        invalid_properties.push('invalid value for "message", message 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 @message.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] message Value to be assigned
+    def message=(message)
+      if message.nil?
+        fail ArgumentError, 'message cannot be nil'
+      end
+
+      @message = message
+    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 &&
+          content == o.content &&
+          message == o.message &&
+          raw_body == o.raw_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
+      [content, message, raw_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