sendmux-management 1.0.0

data/lib/sendmux_management_generated/models/email_metrics.rb

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

@@ -0,0 +1,294 @@
+=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 EmailMetricsComparison < ApiModelBase
+    attr_accessor :change_pct
+
+    attr_accessor :failed
+
+    attr_accessor :pending
+
+    attr_accessor :rejected
+
+    attr_accessor :sent
+
+    attr_accessor :total
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'change_pct' => :'change_pct',
+        :'failed' => :'failed',
+        :'pending' => :'pending',
+        :'rejected' => :'rejected',
+        :'sent' => :'sent',
+        :'total' => :'total'
+      }
+    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
+      {
+        :'change_pct' => :'EmailMetricsComparisonChangePct',
+        :'failed' => :'Float',
+        :'pending' => :'Float',
+        :'rejected' => :'Float',
+        :'sent' => :'Float',
+        :'total' => :'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::EmailMetricsComparison` 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::EmailMetricsComparison`. 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?(:'change_pct')
+        self.change_pct = attributes[:'change_pct']
+      else
+        self.change_pct = nil
+      end
+
+      if attributes.key?(:'failed')
+        self.failed = attributes[:'failed']
+      else
+        self.failed = nil
+      end
+
+      if attributes.key?(:'pending')
+        self.pending = attributes[:'pending']
+      else
+        self.pending = nil
+      end
+
+      if attributes.key?(:'rejected')
+        self.rejected = attributes[:'rejected']
+      else
+        self.rejected = nil
+      end
+
+      if attributes.key?(:'sent')
+        self.sent = attributes[:'sent']
+      else
+        self.sent = nil
+      end
+
+      if attributes.key?(:'total')
+        self.total = attributes[:'total']
+      else
+        self.total = 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 @change_pct.nil?
+        invalid_properties.push('invalid value for "change_pct", change_pct cannot be nil.')
+      end
+
+      if @failed.nil?
+        invalid_properties.push('invalid value for "failed", failed cannot be nil.')
+      end
+
+      if @pending.nil?
+        invalid_properties.push('invalid value for "pending", pending cannot be nil.')
+      end
+
+      if @rejected.nil?
+        invalid_properties.push('invalid value for "rejected", rejected cannot be nil.')
+      end
+
+      if @sent.nil?
+        invalid_properties.push('invalid value for "sent", sent cannot be nil.')
+      end
+
+      if @total.nil?
+        invalid_properties.push('invalid value for "total", total 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 @change_pct.nil?
+      return false if @failed.nil?
+      return false if @pending.nil?
+      return false if @rejected.nil?
+      return false if @sent.nil?
+      return false if @total.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] change_pct Value to be assigned
+    def change_pct=(change_pct)
+      if change_pct.nil?
+        fail ArgumentError, 'change_pct cannot be nil'
+      end
+
+      @change_pct = change_pct
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] failed Value to be assigned
+    def failed=(failed)
+      if failed.nil?
+        fail ArgumentError, 'failed cannot be nil'
+      end
+
+      @failed = failed
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] pending Value to be assigned
+    def pending=(pending)
+      if pending.nil?
+        fail ArgumentError, 'pending cannot be nil'
+      end
+
+      @pending = pending
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] rejected Value to be assigned
+    def rejected=(rejected)
+      if rejected.nil?
+        fail ArgumentError, 'rejected cannot be nil'
+      end
+
+      @rejected = rejected
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sent Value to be assigned
+    def sent=(sent)
+      if sent.nil?
+        fail ArgumentError, 'sent cannot be nil'
+      end
+
+      @sent = sent
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] total Value to be assigned
+    def total=(total)
+      if total.nil?
+        fail ArgumentError, 'total cannot be nil'
+      end
+
+      @total = total
+    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 &&
+          change_pct == o.change_pct &&
+          failed == o.failed &&
+          pending == o.pending &&
+          rejected == o.rejected &&
+          sent == o.sent &&
+          total == o.total
+    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
+      [change_pct, failed, pending, rejected, sent, total].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