sendmux-management 1.0.0

data/lib/sendmux_management_generated/models/provider_create_body.rb

@@ -0,0 +1,579 @@
+=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 ProviderCreateBody < ApiModelBase
+    attr_accessor :from_email
+
+    attr_accessor :from_name
+
+    attr_accessor :name
+
+    attr_accessor :percentage
+
+    attr_accessor :quotas
+
+    attr_accessor :reply_to_email
+
+    attr_accessor :reply_to_name
+
+    attr_accessor :smtp_host
+
+    attr_accessor :smtp_password
+
+    attr_accessor :smtp_port
+
+    attr_accessor :smtp_protocol
+
+    attr_accessor :smtp_username
+
+    attr_accessor :tracking_domain
+
+    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
+      {
+        :'from_email' => :'from_email',
+        :'from_name' => :'from_name',
+        :'name' => :'name',
+        :'percentage' => :'percentage',
+        :'quotas' => :'quotas',
+        :'reply_to_email' => :'reply_to_email',
+        :'reply_to_name' => :'reply_to_name',
+        :'smtp_host' => :'smtp_host',
+        :'smtp_password' => :'smtp_password',
+        :'smtp_port' => :'smtp_port',
+        :'smtp_protocol' => :'smtp_protocol',
+        :'smtp_username' => :'smtp_username',
+        :'tracking_domain' => :'tracking_domain'
+      }
+    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
+      {
+        :'from_email' => :'String',
+        :'from_name' => :'String',
+        :'name' => :'String',
+        :'percentage' => :'Integer',
+        :'quotas' => :'ProviderCreateBodyQuotas',
+        :'reply_to_email' => :'String',
+        :'reply_to_name' => :'String',
+        :'smtp_host' => :'String',
+        :'smtp_password' => :'String',
+        :'smtp_port' => :'Integer',
+        :'smtp_protocol' => :'String',
+        :'smtp_username' => :'String',
+        :'tracking_domain' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'from_email',
+        :'from_name',
+        :'reply_to_email',
+        :'reply_to_name',
+        :'tracking_domain'
+      ])
+    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::ProviderCreateBody` 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::ProviderCreateBody`. 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?(:'from_email')
+        self.from_email = attributes[:'from_email']
+      end
+
+      if attributes.key?(:'from_name')
+        self.from_name = attributes[:'from_name']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'percentage')
+        self.percentage = attributes[:'percentage']
+      end
+
+      if attributes.key?(:'quotas')
+        self.quotas = attributes[:'quotas']
+      end
+
+      if attributes.key?(:'reply_to_email')
+        self.reply_to_email = attributes[:'reply_to_email']
+      end
+
+      if attributes.key?(:'reply_to_name')
+        self.reply_to_name = attributes[:'reply_to_name']
+      end
+
+      if attributes.key?(:'smtp_host')
+        self.smtp_host = attributes[:'smtp_host']
+      else
+        self.smtp_host = nil
+      end
+
+      if attributes.key?(:'smtp_password')
+        self.smtp_password = attributes[:'smtp_password']
+      else
+        self.smtp_password = nil
+      end
+
+      if attributes.key?(:'smtp_port')
+        self.smtp_port = attributes[:'smtp_port']
+      else
+        self.smtp_port = nil
+      end
+
+      if attributes.key?(:'smtp_protocol')
+        self.smtp_protocol = attributes[:'smtp_protocol']
+      else
+        self.smtp_protocol = nil
+      end
+
+      if attributes.key?(:'smtp_username')
+        self.smtp_username = attributes[:'smtp_username']
+      else
+        self.smtp_username = nil
+      end
+
+      if attributes.key?(:'tracking_domain')
+        self.tracking_domain = attributes[:'tracking_domain']
+      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 !@from_email.nil? && @from_email.to_s.length > 255
+        invalid_properties.push('invalid value for "from_email", the character length must be smaller than or equal to 255.')
+      end
+
+      if !@from_name.nil? && @from_name.to_s.length > 255
+        invalid_properties.push('invalid value for "from_name", the character length must be smaller than or equal to 255.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @name.to_s.length > 255
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 255.')
+      end
+
+      if @name.to_s.length < 1
+        invalid_properties.push('invalid value for "name", the character length must be greater than or equal to 1.')
+      end
+
+      if !@percentage.nil? && @percentage > 100
+        invalid_properties.push('invalid value for "percentage", must be smaller than or equal to 100.')
+      end
+
+      if !@percentage.nil? && @percentage < 0
+        invalid_properties.push('invalid value for "percentage", must be greater than or equal to 0.')
+      end
+
+      if !@reply_to_email.nil? && @reply_to_email.to_s.length > 255
+        invalid_properties.push('invalid value for "reply_to_email", the character length must be smaller than or equal to 255.')
+      end
+
+      if !@reply_to_name.nil? && @reply_to_name.to_s.length > 255
+        invalid_properties.push('invalid value for "reply_to_name", the character length must be smaller than or equal to 255.')
+      end
+
+      if @smtp_host.nil?
+        invalid_properties.push('invalid value for "smtp_host", smtp_host cannot be nil.')
+      end
+
+      if @smtp_host.to_s.length > 255
+        invalid_properties.push('invalid value for "smtp_host", the character length must be smaller than or equal to 255.')
+      end
+
+      if @smtp_host.to_s.length < 1
+        invalid_properties.push('invalid value for "smtp_host", the character length must be greater than or equal to 1.')
+      end
+
+      if @smtp_password.nil?
+        invalid_properties.push('invalid value for "smtp_password", smtp_password cannot be nil.')
+      end
+
+      if @smtp_password.to_s.length > 500
+        invalid_properties.push('invalid value for "smtp_password", the character length must be smaller than or equal to 500.')
+      end
+
+      if @smtp_password.to_s.length < 1
+        invalid_properties.push('invalid value for "smtp_password", the character length must be greater than or equal to 1.')
+      end
+
+      if @smtp_port.nil?
+        invalid_properties.push('invalid value for "smtp_port", smtp_port cannot be nil.')
+      end
+
+      if @smtp_port > 65535
+        invalid_properties.push('invalid value for "smtp_port", must be smaller than or equal to 65535.')
+      end
+
+      if @smtp_port < 1
+        invalid_properties.push('invalid value for "smtp_port", must be greater than or equal to 1.')
+      end
+
+      if @smtp_protocol.nil?
+        invalid_properties.push('invalid value for "smtp_protocol", smtp_protocol cannot be nil.')
+      end
+
+      if @smtp_username.nil?
+        invalid_properties.push('invalid value for "smtp_username", smtp_username cannot be nil.')
+      end
+
+      if @smtp_username.to_s.length > 255
+        invalid_properties.push('invalid value for "smtp_username", the character length must be smaller than or equal to 255.')
+      end
+
+      if @smtp_username.to_s.length < 1
+        invalid_properties.push('invalid value for "smtp_username", the character length must be greater than or equal to 1.')
+      end
+
+      if !@tracking_domain.nil? && @tracking_domain.to_s.length > 255
+        invalid_properties.push('invalid value for "tracking_domain", the character length must be smaller than or equal to 255.')
+      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 !@from_email.nil? && @from_email.to_s.length > 255
+      return false if !@from_name.nil? && @from_name.to_s.length > 255
+      return false if @name.nil?
+      return false if @name.to_s.length > 255
+      return false if @name.to_s.length < 1
+      return false if !@percentage.nil? && @percentage > 100
+      return false if !@percentage.nil? && @percentage < 0
+      return false if !@reply_to_email.nil? && @reply_to_email.to_s.length > 255
+      return false if !@reply_to_name.nil? && @reply_to_name.to_s.length > 255
+      return false if @smtp_host.nil?
+      return false if @smtp_host.to_s.length > 255
+      return false if @smtp_host.to_s.length < 1
+      return false if @smtp_password.nil?
+      return false if @smtp_password.to_s.length > 500
+      return false if @smtp_password.to_s.length < 1
+      return false if @smtp_port.nil?
+      return false if @smtp_port > 65535
+      return false if @smtp_port < 1
+      return false if @smtp_protocol.nil?
+      smtp_protocol_validator = EnumAttributeValidator.new('String', ["tls", "ssl", "none", "starttls", "unknown_default_open_api"])
+      return false unless smtp_protocol_validator.valid?(@smtp_protocol)
+      return false if @smtp_username.nil?
+      return false if @smtp_username.to_s.length > 255
+      return false if @smtp_username.to_s.length < 1
+      return false if !@tracking_domain.nil? && @tracking_domain.to_s.length > 255
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] from_email Value to be assigned
+    def from_email=(from_email)
+      if !from_email.nil? && from_email.to_s.length > 255
+        fail ArgumentError, 'invalid value for "from_email", the character length must be smaller than or equal to 255.'
+      end
+
+      @from_email = from_email
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] from_name Value to be assigned
+    def from_name=(from_name)
+      if !from_name.nil? && from_name.to_s.length > 255
+        fail ArgumentError, 'invalid value for "from_name", the character length must be smaller than or equal to 255.'
+      end
+
+      @from_name = from_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length > 255
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 255.'
+      end
+
+      if name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "name", the character length must be greater than or equal to 1.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] percentage Value to be assigned
+    def percentage=(percentage)
+      if percentage.nil?
+        fail ArgumentError, 'percentage cannot be nil'
+      end
+
+      if percentage > 100
+        fail ArgumentError, 'invalid value for "percentage", must be smaller than or equal to 100.'
+      end
+
+      if percentage < 0
+        fail ArgumentError, 'invalid value for "percentage", must be greater than or equal to 0.'
+      end
+
+      @percentage = percentage
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reply_to_email Value to be assigned
+    def reply_to_email=(reply_to_email)
+      if !reply_to_email.nil? && reply_to_email.to_s.length > 255
+        fail ArgumentError, 'invalid value for "reply_to_email", the character length must be smaller than or equal to 255.'
+      end
+
+      @reply_to_email = reply_to_email
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reply_to_name Value to be assigned
+    def reply_to_name=(reply_to_name)
+      if !reply_to_name.nil? && reply_to_name.to_s.length > 255
+        fail ArgumentError, 'invalid value for "reply_to_name", the character length must be smaller than or equal to 255.'
+      end
+
+      @reply_to_name = reply_to_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] smtp_host Value to be assigned
+    def smtp_host=(smtp_host)
+      if smtp_host.nil?
+        fail ArgumentError, 'smtp_host cannot be nil'
+      end
+
+      if smtp_host.to_s.length > 255
+        fail ArgumentError, 'invalid value for "smtp_host", the character length must be smaller than or equal to 255.'
+      end
+
+      if smtp_host.to_s.length < 1
+        fail ArgumentError, 'invalid value for "smtp_host", the character length must be greater than or equal to 1.'
+      end
+
+      @smtp_host = smtp_host
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] smtp_password Value to be assigned
+    def smtp_password=(smtp_password)
+      if smtp_password.nil?
+        fail ArgumentError, 'smtp_password cannot be nil'
+      end
+
+      if smtp_password.to_s.length > 500
+        fail ArgumentError, 'invalid value for "smtp_password", the character length must be smaller than or equal to 500.'
+      end
+
+      if smtp_password.to_s.length < 1
+        fail ArgumentError, 'invalid value for "smtp_password", the character length must be greater than or equal to 1.'
+      end
+
+      @smtp_password = smtp_password
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] smtp_port Value to be assigned
+    def smtp_port=(smtp_port)
+      if smtp_port.nil?
+        fail ArgumentError, 'smtp_port cannot be nil'
+      end
+
+      if smtp_port > 65535
+        fail ArgumentError, 'invalid value for "smtp_port", must be smaller than or equal to 65535.'
+      end
+
+      if smtp_port < 1
+        fail ArgumentError, 'invalid value for "smtp_port", must be greater than or equal to 1.'
+      end
+
+      @smtp_port = smtp_port
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] smtp_protocol Object to be assigned
+    def smtp_protocol=(smtp_protocol)
+      validator = EnumAttributeValidator.new('String', ["tls", "ssl", "none", "starttls", "unknown_default_open_api"])
+      unless validator.valid?(smtp_protocol)
+        fail ArgumentError, "invalid value for \"smtp_protocol\", must be one of #{validator.allowable_values}."
+      end
+      @smtp_protocol = smtp_protocol
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] smtp_username Value to be assigned
+    def smtp_username=(smtp_username)
+      if smtp_username.nil?
+        fail ArgumentError, 'smtp_username cannot be nil'
+      end
+
+      if smtp_username.to_s.length > 255
+        fail ArgumentError, 'invalid value for "smtp_username", the character length must be smaller than or equal to 255.'
+      end
+
+      if smtp_username.to_s.length < 1
+        fail ArgumentError, 'invalid value for "smtp_username", the character length must be greater than or equal to 1.'
+      end
+
+      @smtp_username = smtp_username
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] tracking_domain Value to be assigned
+    def tracking_domain=(tracking_domain)
+      if !tracking_domain.nil? && tracking_domain.to_s.length > 255
+        fail ArgumentError, 'invalid value for "tracking_domain", the character length must be smaller than or equal to 255.'
+      end
+
+      @tracking_domain = tracking_domain
+    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 &&
+          from_email == o.from_email &&
+          from_name == o.from_name &&
+          name == o.name &&
+          percentage == o.percentage &&
+          quotas == o.quotas &&
+          reply_to_email == o.reply_to_email &&
+          reply_to_name == o.reply_to_name &&
+          smtp_host == o.smtp_host &&
+          smtp_password == o.smtp_password &&
+          smtp_port == o.smtp_port &&
+          smtp_protocol == o.smtp_protocol &&
+          smtp_username == o.smtp_username &&
+          tracking_domain == o.tracking_domain
+    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
+      [from_email, from_name, name, percentage, quotas, reply_to_email, reply_to_name, smtp_host, smtp_password, smtp_port, smtp_protocol, smtp_username, tracking_domain].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