sendmux-management 1.0.0

data/lib/sendmux_management_generated/models/balance.rb

@@ -0,0 +1,293 @@
+=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 Balance < ApiModelBase
+    attr_accessor :auto_topup
+
+    # Current balance (purchased - consumed)
+    attr_accessor :balance
+
+    attr_accessor :balance_consumed
+
+    attr_accessor :balance_purchased
+
+    attr_accessor :currency
+
+    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
+      {
+        :'auto_topup' => :'auto_topup',
+        :'balance' => :'balance',
+        :'balance_consumed' => :'balance_consumed',
+        :'balance_purchased' => :'balance_purchased',
+        :'currency' => :'currency'
+      }
+    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
+      {
+        :'auto_topup' => :'BalanceAutoTopup',
+        :'balance' => :'String',
+        :'balance_consumed' => :'String',
+        :'balance_purchased' => :'String',
+        :'currency' => :'String'
+      }
+    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::Balance` 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::Balance`. 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?(:'auto_topup')
+        self.auto_topup = attributes[:'auto_topup']
+      else
+        self.auto_topup = nil
+      end
+
+      if attributes.key?(:'balance')
+        self.balance = attributes[:'balance']
+      else
+        self.balance = nil
+      end
+
+      if attributes.key?(:'balance_consumed')
+        self.balance_consumed = attributes[:'balance_consumed']
+      else
+        self.balance_consumed = nil
+      end
+
+      if attributes.key?(:'balance_purchased')
+        self.balance_purchased = attributes[:'balance_purchased']
+      else
+        self.balance_purchased = nil
+      end
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      else
+        self.currency = 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 @auto_topup.nil?
+        invalid_properties.push('invalid value for "auto_topup", auto_topup cannot be nil.')
+      end
+
+      if @balance.nil?
+        invalid_properties.push('invalid value for "balance", balance cannot be nil.')
+      end
+
+      if @balance_consumed.nil?
+        invalid_properties.push('invalid value for "balance_consumed", balance_consumed cannot be nil.')
+      end
+
+      if @balance_purchased.nil?
+        invalid_properties.push('invalid value for "balance_purchased", balance_purchased cannot be nil.')
+      end
+
+      if @currency.nil?
+        invalid_properties.push('invalid value for "currency", currency 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 @auto_topup.nil?
+      return false if @balance.nil?
+      return false if @balance_consumed.nil?
+      return false if @balance_purchased.nil?
+      return false if @currency.nil?
+      currency_validator = EnumAttributeValidator.new('String', ["USD", "unknown_default_open_api"])
+      return false unless currency_validator.valid?(@currency)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] auto_topup Value to be assigned
+    def auto_topup=(auto_topup)
+      if auto_topup.nil?
+        fail ArgumentError, 'auto_topup cannot be nil'
+      end
+
+      @auto_topup = auto_topup
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] balance Value to be assigned
+    def balance=(balance)
+      if balance.nil?
+        fail ArgumentError, 'balance cannot be nil'
+      end
+
+      @balance = balance
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] balance_consumed Value to be assigned
+    def balance_consumed=(balance_consumed)
+      if balance_consumed.nil?
+        fail ArgumentError, 'balance_consumed cannot be nil'
+      end
+
+      @balance_consumed = balance_consumed
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] balance_purchased Value to be assigned
+    def balance_purchased=(balance_purchased)
+      if balance_purchased.nil?
+        fail ArgumentError, 'balance_purchased cannot be nil'
+      end
+
+      @balance_purchased = balance_purchased
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] currency Object to be assigned
+    def currency=(currency)
+      validator = EnumAttributeValidator.new('String', ["USD", "unknown_default_open_api"])
+      unless validator.valid?(currency)
+        fail ArgumentError, "invalid value for \"currency\", must be one of #{validator.allowable_values}."
+      end
+      @currency = currency
+    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 &&
+          auto_topup == o.auto_topup &&
+          balance == o.balance &&
+          balance_consumed == o.balance_consumed &&
+          balance_purchased == o.balance_purchased &&
+          currency == o.currency
+    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
+      [auto_topup, balance, balance_consumed, balance_purchased, currency].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/balance_auto_topup.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 BalanceAutoTopup < ApiModelBase
+    attr_accessor :amount
+
+    attr_accessor :enabled
+
+    attr_accessor :monthly_limit
+
+    attr_accessor :monthly_used
+
+    attr_accessor :threshold
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'amount' => :'amount',
+        :'enabled' => :'enabled',
+        :'monthly_limit' => :'monthly_limit',
+        :'monthly_used' => :'monthly_used',
+        :'threshold' => :'threshold'
+      }
+    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
+      {
+        :'amount' => :'String',
+        :'enabled' => :'Boolean',
+        :'monthly_limit' => :'String',
+        :'monthly_used' => :'String',
+        :'threshold' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'amount',
+        :'monthly_limit',
+        :'threshold'
+      ])
+    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::BalanceAutoTopup` 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::BalanceAutoTopup`. 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?(:'amount')
+        self.amount = attributes[:'amount']
+      else
+        self.amount = nil
+      end
+
+      if attributes.key?(:'enabled')
+        self.enabled = attributes[:'enabled']
+      else
+        self.enabled = nil
+      end
+
+      if attributes.key?(:'monthly_limit')
+        self.monthly_limit = attributes[:'monthly_limit']
+      else
+        self.monthly_limit = nil
+      end
+
+      if attributes.key?(:'monthly_used')
+        self.monthly_used = attributes[:'monthly_used']
+      else
+        self.monthly_used = nil
+      end
+
+      if attributes.key?(:'threshold')
+        self.threshold = attributes[:'threshold']
+      else
+        self.threshold = 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 @enabled.nil?
+        invalid_properties.push('invalid value for "enabled", enabled cannot be nil.')
+      end
+
+      if @monthly_used.nil?
+        invalid_properties.push('invalid value for "monthly_used", monthly_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 @enabled.nil?
+      return false if @monthly_used.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] enabled Value to be assigned
+    def enabled=(enabled)
+      if enabled.nil?
+        fail ArgumentError, 'enabled cannot be nil'
+      end
+
+      @enabled = enabled
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] monthly_used Value to be assigned
+    def monthly_used=(monthly_used)
+      if monthly_used.nil?
+        fail ArgumentError, 'monthly_used cannot be nil'
+      end
+
+      @monthly_used = monthly_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 &&
+          amount == o.amount &&
+          enabled == o.enabled &&
+          monthly_limit == o.monthly_limit &&
+          monthly_used == o.monthly_used &&
+          threshold == o.threshold
+    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
+      [amount, enabled, monthly_limit, monthly_used, threshold].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