sendmux-management 1.0.0

data/lib/sendmux_management_generated/models/provider_usage.rb

@@ -0,0 +1,216 @@
+=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 ProviderUsage < ApiModelBase
+    attr_accessor :providers
+
+    attr_accessor :window_days
+
+    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
+      {
+        :'providers' => :'providers',
+        :'window_days' => :'window_days'
+      }
+    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
+      {
+        :'providers' => :'Array<ProviderUsageItem>',
+        :'window_days' => :'Float'
+      }
+    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::ProviderUsage` 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::ProviderUsage`. 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?(:'providers')
+        if (value = attributes[:'providers']).is_a?(Array)
+          self.providers = value
+        end
+      else
+        self.providers = nil
+      end
+
+      if attributes.key?(:'window_days')
+        self.window_days = attributes[:'window_days']
+      else
+        self.window_days = 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 @providers.nil?
+        invalid_properties.push('invalid value for "providers", providers cannot be nil.')
+      end
+
+      if @window_days.nil?
+        invalid_properties.push('invalid value for "window_days", window_days 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 @providers.nil?
+      return false if @window_days.nil?
+      window_days_validator = EnumAttributeValidator.new('Float', [7, 11184809])
+      return false unless window_days_validator.valid?(@window_days)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] providers Value to be assigned
+    def providers=(providers)
+      if providers.nil?
+        fail ArgumentError, 'providers cannot be nil'
+      end
+
+      @providers = providers
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] window_days Object to be assigned
+    def window_days=(window_days)
+      validator = EnumAttributeValidator.new('Float', [7, 11184809])
+      unless validator.valid?(window_days)
+        fail ArgumentError, "invalid value for \"window_days\", must be one of #{validator.allowable_values}."
+      end
+      @window_days = window_days
+    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 &&
+          providers == o.providers &&
+          window_days == o.window_days
+    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
+      [providers, window_days].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/provider_usage_item.rb

@@ -0,0 +1,374 @@
+=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 ProviderUsageItem < ApiModelBase
+    attr_accessor :failed_7d
+
+    attr_accessor :pending_7d
+
+    attr_accessor :provider_id
+
+    attr_accessor :rejected_7d
+
+    attr_accessor :sent_7d
+
+    attr_accessor :sent_today
+
+    attr_accessor :total_7d
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'failed_7d' => :'failed_7d',
+        :'pending_7d' => :'pending_7d',
+        :'provider_id' => :'provider_id',
+        :'rejected_7d' => :'rejected_7d',
+        :'sent_7d' => :'sent_7d',
+        :'sent_today' => :'sent_today',
+        :'total_7d' => :'total_7d'
+      }
+    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
+      {
+        :'failed_7d' => :'Integer',
+        :'pending_7d' => :'Integer',
+        :'provider_id' => :'String',
+        :'rejected_7d' => :'Integer',
+        :'sent_7d' => :'Integer',
+        :'sent_today' => :'Integer',
+        :'total_7d' => :'Integer'
+      }
+    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::ProviderUsageItem` 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::ProviderUsageItem`. 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?(:'failed_7d')
+        self.failed_7d = attributes[:'failed_7d']
+      else
+        self.failed_7d = nil
+      end
+
+      if attributes.key?(:'pending_7d')
+        self.pending_7d = attributes[:'pending_7d']
+      else
+        self.pending_7d = nil
+      end
+
+      if attributes.key?(:'provider_id')
+        self.provider_id = attributes[:'provider_id']
+      else
+        self.provider_id = nil
+      end
+
+      if attributes.key?(:'rejected_7d')
+        self.rejected_7d = attributes[:'rejected_7d']
+      else
+        self.rejected_7d = nil
+      end
+
+      if attributes.key?(:'sent_7d')
+        self.sent_7d = attributes[:'sent_7d']
+      else
+        self.sent_7d = nil
+      end
+
+      if attributes.key?(:'sent_today')
+        self.sent_today = attributes[:'sent_today']
+      else
+        self.sent_today = nil
+      end
+
+      if attributes.key?(:'total_7d')
+        self.total_7d = attributes[:'total_7d']
+      else
+        self.total_7d = 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 @failed_7d.nil?
+        invalid_properties.push('invalid value for "failed_7d", failed_7d cannot be nil.')
+      end
+
+      if @failed_7d < 0
+        invalid_properties.push('invalid value for "failed_7d", must be greater than or equal to 0.')
+      end
+
+      if @pending_7d.nil?
+        invalid_properties.push('invalid value for "pending_7d", pending_7d cannot be nil.')
+      end
+
+      if @pending_7d < 0
+        invalid_properties.push('invalid value for "pending_7d", must be greater than or equal to 0.')
+      end
+
+      if @provider_id.nil?
+        invalid_properties.push('invalid value for "provider_id", provider_id cannot be nil.')
+      end
+
+      if @rejected_7d.nil?
+        invalid_properties.push('invalid value for "rejected_7d", rejected_7d cannot be nil.')
+      end
+
+      if @rejected_7d < 0
+        invalid_properties.push('invalid value for "rejected_7d", must be greater than or equal to 0.')
+      end
+
+      if @sent_7d.nil?
+        invalid_properties.push('invalid value for "sent_7d", sent_7d cannot be nil.')
+      end
+
+      if @sent_7d < 0
+        invalid_properties.push('invalid value for "sent_7d", must be greater than or equal to 0.')
+      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 @total_7d.nil?
+        invalid_properties.push('invalid value for "total_7d", total_7d cannot be nil.')
+      end
+
+      if @total_7d < 0
+        invalid_properties.push('invalid value for "total_7d", 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 @failed_7d.nil?
+      return false if @failed_7d < 0
+      return false if @pending_7d.nil?
+      return false if @pending_7d < 0
+      return false if @provider_id.nil?
+      return false if @rejected_7d.nil?
+      return false if @rejected_7d < 0
+      return false if @sent_7d.nil?
+      return false if @sent_7d < 0
+      return false if @sent_today.nil?
+      return false if @sent_today < 0
+      return false if @total_7d.nil?
+      return false if @total_7d < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] failed_7d Value to be assigned
+    def failed_7d=(failed_7d)
+      if failed_7d.nil?
+        fail ArgumentError, 'failed_7d cannot be nil'
+      end
+
+      if failed_7d < 0
+        fail ArgumentError, 'invalid value for "failed_7d", must be greater than or equal to 0.'
+      end
+
+      @failed_7d = failed_7d
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] pending_7d Value to be assigned
+    def pending_7d=(pending_7d)
+      if pending_7d.nil?
+        fail ArgumentError, 'pending_7d cannot be nil'
+      end
+
+      if pending_7d < 0
+        fail ArgumentError, 'invalid value for "pending_7d", must be greater than or equal to 0.'
+      end
+
+      @pending_7d = pending_7d
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] provider_id Value to be assigned
+    def provider_id=(provider_id)
+      if provider_id.nil?
+        fail ArgumentError, 'provider_id cannot be nil'
+      end
+
+      @provider_id = provider_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] rejected_7d Value to be assigned
+    def rejected_7d=(rejected_7d)
+      if rejected_7d.nil?
+        fail ArgumentError, 'rejected_7d cannot be nil'
+      end
+
+      if rejected_7d < 0
+        fail ArgumentError, 'invalid value for "rejected_7d", must be greater than or equal to 0.'
+      end
+
+      @rejected_7d = rejected_7d
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sent_7d Value to be assigned
+    def sent_7d=(sent_7d)
+      if sent_7d.nil?
+        fail ArgumentError, 'sent_7d cannot be nil'
+      end
+
+      if sent_7d < 0
+        fail ArgumentError, 'invalid value for "sent_7d", must be greater than or equal to 0.'
+      end
+
+      @sent_7d = sent_7d
+    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] total_7d Value to be assigned
+    def total_7d=(total_7d)
+      if total_7d.nil?
+        fail ArgumentError, 'total_7d cannot be nil'
+      end
+
+      if total_7d < 0
+        fail ArgumentError, 'invalid value for "total_7d", must be greater than or equal to 0.'
+      end
+
+      @total_7d = total_7d
+    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 &&
+          failed_7d == o.failed_7d &&
+          pending_7d == o.pending_7d &&
+          provider_id == o.provider_id &&
+          rejected_7d == o.rejected_7d &&
+          sent_7d == o.sent_7d &&
+          sent_today == o.sent_today &&
+          total_7d == o.total_7d
+    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
+      [failed_7d, pending_7d, provider_id, rejected_7d, sent_7d, sent_today, total_7d].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