sendmux-mailbox 1.0.0

data/lib/sendmux_mailbox_generated/models/mailbox_usage.rb

@@ -0,0 +1,192 @@
+=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 MailboxUsage < ApiModelBase
+    attr_accessor :resources
+
+    attr_accessor :states
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'resources' => :'resources',
+        :'states' => :'states'
+      }
+    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
+      {
+        :'resources' => :'Array<MailboxUsageResource>',
+        :'states' => :'MailboxUsageStates'
+      }
+    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::MailboxUsage` 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::MailboxUsage`. 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?(:'resources')
+        if (value = attributes[:'resources']).is_a?(Array)
+          self.resources = value
+        end
+      else
+        self.resources = nil
+      end
+
+      if attributes.key?(:'states')
+        self.states = attributes[:'states']
+      else
+        self.states = 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 @resources.nil?
+        invalid_properties.push('invalid value for "resources", resources cannot be nil.')
+      end
+
+      if @states.nil?
+        invalid_properties.push('invalid value for "states", states 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 @resources.nil?
+      return false if @states.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] resources Value to be assigned
+    def resources=(resources)
+      if resources.nil?
+        fail ArgumentError, 'resources cannot be nil'
+      end
+
+      @resources = resources
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] states Value to be assigned
+    def states=(states)
+      if states.nil?
+        fail ArgumentError, 'states cannot be nil'
+      end
+
+      @states = states
+    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 &&
+          resources == o.resources &&
+          states == o.states
+    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
+      [resources, states].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_usage_resource.rb

@@ -0,0 +1,408 @@
+=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 MailboxUsageResource < ApiModelBase
+    attr_accessor :hard_limit
+
+    attr_accessor :limit_status
+
+    attr_accessor :name
+
+    attr_accessor :percent_used
+
+    attr_accessor :quota_id
+
+    attr_accessor :resource_type
+
+    attr_accessor :scope
+
+    attr_accessor :soft_limit
+
+    attr_accessor :types
+
+    attr_accessor :used
+
+    attr_accessor :warn_limit
+
+    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
+      {
+        :'hard_limit' => :'hard_limit',
+        :'limit_status' => :'limit_status',
+        :'name' => :'name',
+        :'percent_used' => :'percent_used',
+        :'quota_id' => :'quota_id',
+        :'resource_type' => :'resource_type',
+        :'scope' => :'scope',
+        :'soft_limit' => :'soft_limit',
+        :'types' => :'types',
+        :'used' => :'used',
+        :'warn_limit' => :'warn_limit'
+      }
+    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
+      {
+        :'hard_limit' => :'Integer',
+        :'limit_status' => :'String',
+        :'name' => :'String',
+        :'percent_used' => :'Float',
+        :'quota_id' => :'String',
+        :'resource_type' => :'String',
+        :'scope' => :'String',
+        :'soft_limit' => :'Integer',
+        :'types' => :'Array<String>',
+        :'used' => :'Integer',
+        :'warn_limit' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'percent_used',
+        :'soft_limit',
+        :'warn_limit'
+      ])
+    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::MailboxUsageResource` 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::MailboxUsageResource`. 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?(:'hard_limit')
+        self.hard_limit = attributes[:'hard_limit']
+      else
+        self.hard_limit = nil
+      end
+
+      if attributes.key?(:'limit_status')
+        self.limit_status = attributes[:'limit_status']
+      else
+        self.limit_status = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'percent_used')
+        self.percent_used = attributes[:'percent_used']
+      else
+        self.percent_used = nil
+      end
+
+      if attributes.key?(:'quota_id')
+        self.quota_id = attributes[:'quota_id']
+      else
+        self.quota_id = nil
+      end
+
+      if attributes.key?(:'resource_type')
+        self.resource_type = attributes[:'resource_type']
+      else
+        self.resource_type = nil
+      end
+
+      if attributes.key?(:'scope')
+        self.scope = attributes[:'scope']
+      else
+        self.scope = nil
+      end
+
+      if attributes.key?(:'soft_limit')
+        self.soft_limit = attributes[:'soft_limit']
+      else
+        self.soft_limit = nil
+      end
+
+      if attributes.key?(:'types')
+        if (value = attributes[:'types']).is_a?(Array)
+          self.types = value
+        end
+      else
+        self.types = nil
+      end
+
+      if attributes.key?(:'used')
+        self.used = attributes[:'used']
+      else
+        self.used = nil
+      end
+
+      if attributes.key?(:'warn_limit')
+        self.warn_limit = attributes[:'warn_limit']
+      else
+        self.warn_limit = 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 @hard_limit.nil?
+        invalid_properties.push('invalid value for "hard_limit", hard_limit cannot be nil.')
+      end
+
+      if @limit_status.nil?
+        invalid_properties.push('invalid value for "limit_status", limit_status cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @quota_id.nil?
+        invalid_properties.push('invalid value for "quota_id", quota_id cannot be nil.')
+      end
+
+      if @resource_type.nil?
+        invalid_properties.push('invalid value for "resource_type", resource_type cannot be nil.')
+      end
+
+      if @scope.nil?
+        invalid_properties.push('invalid value for "scope", scope cannot be nil.')
+      end
+
+      if @types.nil?
+        invalid_properties.push('invalid value for "types", types cannot be nil.')
+      end
+
+      if @used.nil?
+        invalid_properties.push('invalid value for "used", used 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 @hard_limit.nil?
+      return false if @limit_status.nil?
+      limit_status_validator = EnumAttributeValidator.new('String', ["ok", "warning", "soft_limit", "hard_limit", "unknown", "unknown_default_open_api"])
+      return false unless limit_status_validator.valid?(@limit_status)
+      return false if @name.nil?
+      return false if @quota_id.nil?
+      return false if @resource_type.nil?
+      return false if @scope.nil?
+      return false if @types.nil?
+      return false if @used.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] hard_limit Value to be assigned
+    def hard_limit=(hard_limit)
+      if hard_limit.nil?
+        fail ArgumentError, 'hard_limit cannot be nil'
+      end
+
+      @hard_limit = hard_limit
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] limit_status Object to be assigned
+    def limit_status=(limit_status)
+      validator = EnumAttributeValidator.new('String', ["ok", "warning", "soft_limit", "hard_limit", "unknown", "unknown_default_open_api"])
+      unless validator.valid?(limit_status)
+        fail ArgumentError, "invalid value for \"limit_status\", must be one of #{validator.allowable_values}."
+      end
+      @limit_status = limit_status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] quota_id Value to be assigned
+    def quota_id=(quota_id)
+      if quota_id.nil?
+        fail ArgumentError, 'quota_id cannot be nil'
+      end
+
+      @quota_id = quota_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] resource_type Value to be assigned
+    def resource_type=(resource_type)
+      if resource_type.nil?
+        fail ArgumentError, 'resource_type cannot be nil'
+      end
+
+      @resource_type = resource_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] scope Value to be assigned
+    def scope=(scope)
+      if scope.nil?
+        fail ArgumentError, 'scope cannot be nil'
+      end
+
+      @scope = scope
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] types Value to be assigned
+    def types=(types)
+      if types.nil?
+        fail ArgumentError, 'types cannot be nil'
+      end
+
+      @types = types
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] used Value to be assigned
+    def used=(used)
+      if used.nil?
+        fail ArgumentError, 'used cannot be nil'
+      end
+
+      @used = used
+    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 &&
+          hard_limit == o.hard_limit &&
+          limit_status == o.limit_status &&
+          name == o.name &&
+          percent_used == o.percent_used &&
+          quota_id == o.quota_id &&
+          resource_type == o.resource_type &&
+          scope == o.scope &&
+          soft_limit == o.soft_limit &&
+          types == o.types &&
+          used == o.used &&
+          warn_limit == o.warn_limit
+    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
+      [hard_limit, limit_status, name, percent_used, quota_id, resource_type, scope, soft_limit, types, used, warn_limit].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