sendmux-management 1.0.0

data/lib/sendmux_management_generated/models/set_filter_state_body.rb

@@ -0,0 +1,226 @@
+=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 SetFilterStateBody < ApiModelBase
+    attr_accessor :mode
+
+    # Replacement rule set. Maximum 1000 rules per request. An empty array is valid (no rules).
+    attr_accessor :rules
+
+    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
+      {
+        :'mode' => :'mode',
+        :'rules' => :'rules'
+      }
+    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
+      {
+        :'mode' => :'String',
+        :'rules' => :'Array<FilterRule>'
+      }
+    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::Management::Generated::SetFilterStateBody` 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::SetFilterStateBody`. 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?(:'mode')
+        self.mode = attributes[:'mode']
+      else
+        self.mode = nil
+      end
+
+      if attributes.key?(:'rules')
+        if (value = attributes[:'rules']).is_a?(Array)
+          self.rules = value
+        end
+      else
+        self.rules = 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 @mode.nil?
+        invalid_properties.push('invalid value for "mode", mode cannot be nil.')
+      end
+
+      if @rules.nil?
+        invalid_properties.push('invalid value for "rules", rules cannot be nil.')
+      end
+
+      if @rules.length > 1000
+        invalid_properties.push('invalid value for "rules", number of items must be less than or equal to 1000.')
+      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 @mode.nil?
+      mode_validator = EnumAttributeValidator.new('String', ["off", "allowlist", "denylist", "unknown_default_open_api"])
+      return false unless mode_validator.valid?(@mode)
+      return false if @rules.nil?
+      return false if @rules.length > 1000
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] mode Object to be assigned
+    def mode=(mode)
+      validator = EnumAttributeValidator.new('String', ["off", "allowlist", "denylist", "unknown_default_open_api"])
+      unless validator.valid?(mode)
+        fail ArgumentError, "invalid value for \"mode\", must be one of #{validator.allowable_values}."
+      end
+      @mode = mode
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] rules Value to be assigned
+    def rules=(rules)
+      if rules.nil?
+        fail ArgumentError, 'rules cannot be nil'
+      end
+
+      if rules.length > 1000
+        fail ArgumentError, 'invalid value for "rules", number of items must be less than or equal to 1000.'
+      end
+
+      @rules = rules
+    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 &&
+          mode == o.mode &&
+          rules == o.rules
+    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
+      [mode, rules].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/shared_amazon_ses_limit.rb

@@ -0,0 +1,315 @@
+=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 SharedAmazonSesLimit < ApiModelBase
+    attr_accessor :can_request_increase
+
+    attr_accessor :daily_limit
+
+    attr_accessor :is_near_limit
+
+    attr_accessor :pending_request_id
+
+    attr_accessor :provider_id
+
+    attr_accessor :sent_today
+
+    attr_accessor :threshold_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',
+        :'daily_limit' => :'daily_limit',
+        :'is_near_limit' => :'is_near_limit',
+        :'pending_request_id' => :'pending_request_id',
+        :'provider_id' => :'provider_id',
+        :'sent_today' => :'sent_today',
+        :'threshold_usage' => :'threshold_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',
+        :'daily_limit' => :'Integer',
+        :'is_near_limit' => :'Boolean',
+        :'pending_request_id' => :'String',
+        :'provider_id' => :'String',
+        :'sent_today' => :'Integer',
+        :'threshold_usage' => :'Integer',
+        :'usage_ratio' => :'Float'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'daily_limit',
+        :'pending_request_id',
+        :'provider_id',
+        :'threshold_usage',
+        :'usage_ratio'
+      ])
+    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::SharedAmazonSesLimit` 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::SharedAmazonSesLimit`. 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?(:'daily_limit')
+        self.daily_limit = attributes[:'daily_limit']
+      else
+        self.daily_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?(:'pending_request_id')
+        self.pending_request_id = attributes[:'pending_request_id']
+      else
+        self.pending_request_id = nil
+      end
+
+      if attributes.key?(:'provider_id')
+        self.provider_id = attributes[:'provider_id']
+      else
+        self.provider_id = nil
+      end
+
+      if attributes.key?(:'sent_today')
+        self.sent_today = attributes[:'sent_today']
+      else
+        self.sent_today = nil
+      end
+
+      if attributes.key?(:'threshold_usage')
+        self.threshold_usage = attributes[:'threshold_usage']
+      else
+        self.threshold_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 @daily_limit < 0
+        invalid_properties.push('invalid value for "daily_limit", must be greater than or equal to 0.')
+      end
+
+      if @is_near_limit.nil?
+        invalid_properties.push('invalid value for "is_near_limit", is_near_limit cannot be nil.')
+      end
+
+      if @sent_today.nil?
+        invalid_properties.push('invalid value for "sent_today", sent_today cannot be nil.')
+      end
+
+      if @sent_today < 0
+        invalid_properties.push('invalid value for "sent_today", must be greater than or equal to 0.')
+      end
+
+      if @threshold_usage < 0
+        invalid_properties.push('invalid value for "threshold_usage", must be greater than or equal to 0.')
+      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 @daily_limit < 0
+      return false if @is_near_limit.nil?
+      return false if @sent_today.nil?
+      return false if @sent_today < 0
+      return false if @threshold_usage < 0
+      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] daily_limit Value to be assigned
+    def daily_limit=(daily_limit)
+      if !daily_limit.nil? && daily_limit < 0
+        fail ArgumentError, 'invalid value for "daily_limit", must be greater than or equal to 0.'
+      end
+
+      @daily_limit = daily_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] sent_today Value to be assigned
+    def sent_today=(sent_today)
+      if sent_today.nil?
+        fail ArgumentError, 'sent_today cannot be nil'
+      end
+
+      if sent_today < 0
+        fail ArgumentError, 'invalid value for "sent_today", must be greater than or equal to 0.'
+      end
+
+      @sent_today = sent_today
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] threshold_usage Value to be assigned
+    def threshold_usage=(threshold_usage)
+      if !threshold_usage.nil? && threshold_usage < 0
+        fail ArgumentError, 'invalid value for "threshold_usage", must be greater than or equal to 0.'
+      end
+
+      @threshold_usage = threshold_usage
+    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 &&
+          daily_limit == o.daily_limit &&
+          is_near_limit == o.is_near_limit &&
+          pending_request_id == o.pending_request_id &&
+          provider_id == o.provider_id &&
+          sent_today == o.sent_today &&
+          threshold_usage == o.threshold_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, daily_limit, is_near_limit, pending_request_id, provider_id, sent_today, threshold_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