sendmux-management 1.0.0

data/lib/sendmux_management_generated/models/provider_usage_response.rb

@@ -0,0 +1,223 @@
+=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::Management::Generated
+  class ProviderUsageResponse < ApiModelBase
+    attr_accessor :meta
+
+    attr_accessor :ok
+
+    attr_accessor :data
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'meta' => :'meta',
+        :'ok' => :'ok',
+        :'data' => :'data'
+      }
+    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
+      {
+        :'meta' => :'ResponseMeta',
+        :'ok' => :'Boolean',
+        :'data' => :'ProviderUsage'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'SuccessEnvelope'
+      ]
+    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::Management::Generated::ProviderUsageResponse` 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::Management::Generated::ProviderUsageResponse`. 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?(:'meta')
+        self.meta = attributes[:'meta']
+      else
+        self.meta = nil
+      end
+
+      if attributes.key?(:'ok')
+        self.ok = attributes[:'ok']
+      else
+        self.ok = nil
+      end
+
+      if attributes.key?(:'data')
+        self.data = attributes[:'data']
+      else
+        self.data = 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 @meta.nil?
+        invalid_properties.push('invalid value for "meta", meta cannot be nil.')
+      end
+
+      if @ok.nil?
+        invalid_properties.push('invalid value for "ok", ok cannot be nil.')
+      end
+
+      if @data.nil?
+        invalid_properties.push('invalid value for "data", data 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 @meta.nil?
+      return false if @ok.nil?
+      return false if @data.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] meta Value to be assigned
+    def meta=(meta)
+      if meta.nil?
+        fail ArgumentError, 'meta cannot be nil'
+      end
+
+      @meta = meta
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ok Value to be assigned
+    def ok=(ok)
+      if ok.nil?
+        fail ArgumentError, 'ok cannot be nil'
+      end
+
+      @ok = ok
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] data Value to be assigned
+    def data=(data)
+      if data.nil?
+        fail ArgumentError, 'data cannot be nil'
+      end
+
+      @data = data
+    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 &&
+          meta == o.meta &&
+          ok == o.ok &&
+          data == o.data
+    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
+      [meta, ok, data].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_management_generated/models/resource_limit_snapshot.rb

@@ -0,0 +1,420 @@
+=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::Management::Generated
+  class ResourceLimitSnapshot < ApiModelBase
+    attr_accessor :can_request_increase
+
+    attr_accessor :is_at_limit
+
+    attr_accessor :is_near_limit
+
+    attr_accessor :max_allowed
+
+    attr_accessor :pending_request_id
+
+    attr_accessor :reserved
+
+    attr_accessor :resource_type
+
+    attr_accessor :threshold_usage
+
+    attr_accessor :usage
+
+    attr_accessor :usage_ratio
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'can_request_increase' => :'can_request_increase',
+        :'is_at_limit' => :'is_at_limit',
+        :'is_near_limit' => :'is_near_limit',
+        :'max_allowed' => :'max_allowed',
+        :'pending_request_id' => :'pending_request_id',
+        :'reserved' => :'reserved',
+        :'resource_type' => :'resource_type',
+        :'threshold_usage' => :'threshold_usage',
+        :'usage' => :'usage',
+        :'usage_ratio' => :'usage_ratio'
+      }
+    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
+      {
+        :'can_request_increase' => :'Boolean',
+        :'is_at_limit' => :'Boolean',
+        :'is_near_limit' => :'Boolean',
+        :'max_allowed' => :'Integer',
+        :'pending_request_id' => :'String',
+        :'reserved' => :'Integer',
+        :'resource_type' => :'String',
+        :'threshold_usage' => :'Integer',
+        :'usage' => :'Integer',
+        :'usage_ratio' => :'Float'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'pending_request_id',
+      ])
+    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::Management::Generated::ResourceLimitSnapshot` 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::Management::Generated::ResourceLimitSnapshot`. 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?(:'can_request_increase')
+        self.can_request_increase = attributes[:'can_request_increase']
+      else
+        self.can_request_increase = nil
+      end
+
+      if attributes.key?(:'is_at_limit')
+        self.is_at_limit = attributes[:'is_at_limit']
+      else
+        self.is_at_limit = nil
+      end
+
+      if attributes.key?(:'is_near_limit')
+        self.is_near_limit = attributes[:'is_near_limit']
+      else
+        self.is_near_limit = nil
+      end
+
+      if attributes.key?(:'max_allowed')
+        self.max_allowed = attributes[:'max_allowed']
+      else
+        self.max_allowed = nil
+      end
+
+      if attributes.key?(:'pending_request_id')
+        self.pending_request_id = attributes[:'pending_request_id']
+      else
+        self.pending_request_id = nil
+      end
+
+      if attributes.key?(:'reserved')
+        self.reserved = attributes[:'reserved']
+      else
+        self.reserved = nil
+      end
+
+      if attributes.key?(:'resource_type')
+        self.resource_type = attributes[:'resource_type']
+      else
+        self.resource_type = nil
+      end
+
+      if attributes.key?(:'threshold_usage')
+        self.threshold_usage = attributes[:'threshold_usage']
+      else
+        self.threshold_usage = nil
+      end
+
+      if attributes.key?(:'usage')
+        self.usage = attributes[:'usage']
+      else
+        self.usage = nil
+      end
+
+      if attributes.key?(:'usage_ratio')
+        self.usage_ratio = attributes[:'usage_ratio']
+      else
+        self.usage_ratio = 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 @can_request_increase.nil?
+        invalid_properties.push('invalid value for "can_request_increase", can_request_increase cannot be nil.')
+      end
+
+      if @is_at_limit.nil?
+        invalid_properties.push('invalid value for "is_at_limit", is_at_limit cannot be nil.')
+      end
+
+      if @is_near_limit.nil?
+        invalid_properties.push('invalid value for "is_near_limit", is_near_limit cannot be nil.')
+      end
+
+      if @max_allowed.nil?
+        invalid_properties.push('invalid value for "max_allowed", max_allowed cannot be nil.')
+      end
+
+      if @max_allowed <= 0
+        invalid_properties.push('invalid value for "max_allowed", must be greater than 0.')
+      end
+
+      if @reserved.nil?
+        invalid_properties.push('invalid value for "reserved", reserved cannot be nil.')
+      end
+
+      if @reserved < 0
+        invalid_properties.push('invalid value for "reserved", must be greater than or equal to 0.')
+      end
+
+      if @resource_type.nil?
+        invalid_properties.push('invalid value for "resource_type", resource_type cannot be nil.')
+      end
+
+      if @threshold_usage.nil?
+        invalid_properties.push('invalid value for "threshold_usage", threshold_usage cannot be nil.')
+      end
+
+      if @threshold_usage < 0
+        invalid_properties.push('invalid value for "threshold_usage", must be greater than or equal to 0.')
+      end
+
+      if @usage.nil?
+        invalid_properties.push('invalid value for "usage", usage cannot be nil.')
+      end
+
+      if @usage < 0
+        invalid_properties.push('invalid value for "usage", must be greater than or equal to 0.')
+      end
+
+      if @usage_ratio.nil?
+        invalid_properties.push('invalid value for "usage_ratio", usage_ratio 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 @can_request_increase.nil?
+      return false if @is_at_limit.nil?
+      return false if @is_near_limit.nil?
+      return false if @max_allowed.nil?
+      return false if @max_allowed <= 0
+      return false if @reserved.nil?
+      return false if @reserved < 0
+      return false if @resource_type.nil?
+      return false if @threshold_usage.nil?
+      return false if @threshold_usage < 0
+      return false if @usage.nil?
+      return false if @usage < 0
+      return false if @usage_ratio.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] can_request_increase Value to be assigned
+    def can_request_increase=(can_request_increase)
+      if can_request_increase.nil?
+        fail ArgumentError, 'can_request_increase cannot be nil'
+      end
+
+      @can_request_increase = can_request_increase
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] is_at_limit Value to be assigned
+    def is_at_limit=(is_at_limit)
+      if is_at_limit.nil?
+        fail ArgumentError, 'is_at_limit cannot be nil'
+      end
+
+      @is_at_limit = is_at_limit
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] is_near_limit Value to be assigned
+    def is_near_limit=(is_near_limit)
+      if is_near_limit.nil?
+        fail ArgumentError, 'is_near_limit cannot be nil'
+      end
+
+      @is_near_limit = is_near_limit
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] max_allowed Value to be assigned
+    def max_allowed=(max_allowed)
+      if max_allowed.nil?
+        fail ArgumentError, 'max_allowed cannot be nil'
+      end
+
+      if max_allowed <= 0
+        fail ArgumentError, 'invalid value for "max_allowed", must be greater than 0.'
+      end
+
+      @max_allowed = max_allowed
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reserved Value to be assigned
+    def reserved=(reserved)
+      if reserved.nil?
+        fail ArgumentError, 'reserved cannot be nil'
+      end
+
+      if reserved < 0
+        fail ArgumentError, 'invalid value for "reserved", must be greater than or equal to 0.'
+      end
+
+      @reserved = reserved
+    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] threshold_usage Value to be assigned
+    def threshold_usage=(threshold_usage)
+      if threshold_usage.nil?
+        fail ArgumentError, 'threshold_usage cannot be nil'
+      end
+
+      if threshold_usage < 0
+        fail ArgumentError, 'invalid value for "threshold_usage", must be greater than or equal to 0.'
+      end
+
+      @threshold_usage = threshold_usage
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] usage Value to be assigned
+    def usage=(usage)
+      if usage.nil?
+        fail ArgumentError, 'usage cannot be nil'
+      end
+
+      if usage < 0
+        fail ArgumentError, 'invalid value for "usage", must be greater than or equal to 0.'
+      end
+
+      @usage = usage
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] usage_ratio Value to be assigned
+    def usage_ratio=(usage_ratio)
+      if usage_ratio.nil?
+        fail ArgumentError, 'usage_ratio cannot be nil'
+      end
+
+      @usage_ratio = usage_ratio
+    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 &&
+          can_request_increase == o.can_request_increase &&
+          is_at_limit == o.is_at_limit &&
+          is_near_limit == o.is_near_limit &&
+          max_allowed == o.max_allowed &&
+          pending_request_id == o.pending_request_id &&
+          reserved == o.reserved &&
+          resource_type == o.resource_type &&
+          threshold_usage == o.threshold_usage &&
+          usage == o.usage &&
+          usage_ratio == o.usage_ratio
+    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
+      [can_request_increase, is_at_limit, is_near_limit, max_allowed, pending_request_id, reserved, resource_type, threshold_usage, usage, usage_ratio].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