sendmux-management 1.0.0

data/lib/sendmux_management_generated/models/provider_item.rb

@@ -0,0 +1,695 @@
+=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 ProviderItem < ApiModelBase
+    attr_accessor :allowed_actions
+
+    # ISO 8601 creation timestamp
+    attr_accessor :created_at
+
+    # Default From email address.
+    attr_accessor :from_email
+
+    # Default From display name.
+    attr_accessor :from_name
+
+    # Whether an OAuth account has an active connection token.
+    attr_accessor :has_refresh_token
+
+    # Whether a custom SMTP password is stored.
+    attr_accessor :has_smtp_password
+
+    # Sending account public ID
+    attr_accessor :id
+
+    # Whether this account is enabled for sending.
+    attr_accessor :is_active
+
+    # False when the account is platform-managed.
+    attr_accessor :is_editable
+
+    # True for the team's shared Amazon SES account.
+    attr_accessor :is_shared
+
+    # Last connection test timestamp.
+    attr_accessor :last_tested_at
+
+    # Last send timestamp.
+    attr_accessor :last_used_at
+
+    # Display name
+    attr_accessor :name
+
+    # Connected account email for OAuth accounts.
+    attr_accessor :oauth_email
+
+    # Routing weight percentage.
+    attr_accessor :percentage
+
+    attr_accessor :quotas
+
+    # Default Reply-To email address.
+    attr_accessor :reply_to_email
+
+    # Default Reply-To display name.
+    attr_accessor :reply_to_name
+
+    # SMTP host for custom SMTP accounts.
+    attr_accessor :smtp_host
+
+    # SMTP port for custom SMTP accounts.
+    attr_accessor :smtp_port
+
+    # SMTP security mode.
+    attr_accessor :smtp_protocol
+
+    # SMTP username for custom SMTP accounts.
+    attr_accessor :smtp_username
+
+    # Current sending account status.
+    attr_accessor :status
+
+    # Public-safe reason for the current status.
+    attr_accessor :status_reason
+
+    # Custom tracking hostname.
+    attr_accessor :tracking_domain
+
+    # Sending account type. `amazon_ses` is the shared managed account.
+    attr_accessor :type
+
+    # ISO 8601 last update timestamp
+    attr_accessor :updated_at
+
+    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
+      {
+        :'allowed_actions' => :'allowed_actions',
+        :'created_at' => :'created_at',
+        :'from_email' => :'from_email',
+        :'from_name' => :'from_name',
+        :'has_refresh_token' => :'has_refresh_token',
+        :'has_smtp_password' => :'has_smtp_password',
+        :'id' => :'id',
+        :'is_active' => :'is_active',
+        :'is_editable' => :'is_editable',
+        :'is_shared' => :'is_shared',
+        :'last_tested_at' => :'last_tested_at',
+        :'last_used_at' => :'last_used_at',
+        :'name' => :'name',
+        :'oauth_email' => :'oauth_email',
+        :'percentage' => :'percentage',
+        :'quotas' => :'quotas',
+        :'reply_to_email' => :'reply_to_email',
+        :'reply_to_name' => :'reply_to_name',
+        :'smtp_host' => :'smtp_host',
+        :'smtp_port' => :'smtp_port',
+        :'smtp_protocol' => :'smtp_protocol',
+        :'smtp_username' => :'smtp_username',
+        :'status' => :'status',
+        :'status_reason' => :'status_reason',
+        :'tracking_domain' => :'tracking_domain',
+        :'type' => :'type',
+        :'updated_at' => :'updated_at'
+      }
+    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
+      {
+        :'allowed_actions' => :'ProviderAllowedActions',
+        :'created_at' => :'String',
+        :'from_email' => :'String',
+        :'from_name' => :'String',
+        :'has_refresh_token' => :'Boolean',
+        :'has_smtp_password' => :'Boolean',
+        :'id' => :'String',
+        :'is_active' => :'Boolean',
+        :'is_editable' => :'Boolean',
+        :'is_shared' => :'Boolean',
+        :'last_tested_at' => :'String',
+        :'last_used_at' => :'String',
+        :'name' => :'String',
+        :'oauth_email' => :'String',
+        :'percentage' => :'Integer',
+        :'quotas' => :'ProviderQuotas',
+        :'reply_to_email' => :'String',
+        :'reply_to_name' => :'String',
+        :'smtp_host' => :'String',
+        :'smtp_port' => :'Integer',
+        :'smtp_protocol' => :'String',
+        :'smtp_username' => :'String',
+        :'status' => :'String',
+        :'status_reason' => :'String',
+        :'tracking_domain' => :'String',
+        :'type' => :'String',
+        :'updated_at' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'from_email',
+        :'from_name',
+        :'last_tested_at',
+        :'last_used_at',
+        :'oauth_email',
+        :'percentage',
+        :'reply_to_email',
+        :'reply_to_name',
+        :'smtp_host',
+        :'smtp_port',
+        :'smtp_protocol',
+        :'smtp_username',
+        :'status_reason',
+        :'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::ProviderItem` 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::ProviderItem`. 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?(:'allowed_actions')
+        self.allowed_actions = attributes[:'allowed_actions']
+      else
+        self.allowed_actions = nil
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'from_email')
+        self.from_email = attributes[:'from_email']
+      else
+        self.from_email = nil
+      end
+
+      if attributes.key?(:'from_name')
+        self.from_name = attributes[:'from_name']
+      else
+        self.from_name = nil
+      end
+
+      if attributes.key?(:'has_refresh_token')
+        self.has_refresh_token = attributes[:'has_refresh_token']
+      else
+        self.has_refresh_token = nil
+      end
+
+      if attributes.key?(:'has_smtp_password')
+        self.has_smtp_password = attributes[:'has_smtp_password']
+      else
+        self.has_smtp_password = nil
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'is_active')
+        self.is_active = attributes[:'is_active']
+      else
+        self.is_active = nil
+      end
+
+      if attributes.key?(:'is_editable')
+        self.is_editable = attributes[:'is_editable']
+      else
+        self.is_editable = nil
+      end
+
+      if attributes.key?(:'is_shared')
+        self.is_shared = attributes[:'is_shared']
+      else
+        self.is_shared = nil
+      end
+
+      if attributes.key?(:'last_tested_at')
+        self.last_tested_at = attributes[:'last_tested_at']
+      else
+        self.last_tested_at = nil
+      end
+
+      if attributes.key?(:'last_used_at')
+        self.last_used_at = attributes[:'last_used_at']
+      else
+        self.last_used_at = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'oauth_email')
+        self.oauth_email = attributes[:'oauth_email']
+      else
+        self.oauth_email = nil
+      end
+
+      if attributes.key?(:'percentage')
+        self.percentage = attributes[:'percentage']
+      else
+        self.percentage = nil
+      end
+
+      if attributes.key?(:'quotas')
+        self.quotas = attributes[:'quotas']
+      else
+        self.quotas = nil
+      end
+
+      if attributes.key?(:'reply_to_email')
+        self.reply_to_email = attributes[:'reply_to_email']
+      else
+        self.reply_to_email = nil
+      end
+
+      if attributes.key?(:'reply_to_name')
+        self.reply_to_name = attributes[:'reply_to_name']
+      else
+        self.reply_to_name = nil
+      end
+
+      if attributes.key?(:'smtp_host')
+        self.smtp_host = attributes[:'smtp_host']
+      else
+        self.smtp_host = 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?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'status_reason')
+        self.status_reason = attributes[:'status_reason']
+      else
+        self.status_reason = nil
+      end
+
+      if attributes.key?(:'tracking_domain')
+        self.tracking_domain = attributes[:'tracking_domain']
+      else
+        self.tracking_domain = nil
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      else
+        self.updated_at = 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 @allowed_actions.nil?
+        invalid_properties.push('invalid value for "allowed_actions", allowed_actions cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @has_refresh_token.nil?
+        invalid_properties.push('invalid value for "has_refresh_token", has_refresh_token cannot be nil.')
+      end
+
+      if @has_smtp_password.nil?
+        invalid_properties.push('invalid value for "has_smtp_password", has_smtp_password cannot be nil.')
+      end
+
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @is_active.nil?
+        invalid_properties.push('invalid value for "is_active", is_active cannot be nil.')
+      end
+
+      if @is_editable.nil?
+        invalid_properties.push('invalid value for "is_editable", is_editable cannot be nil.')
+      end
+
+      if @is_shared.nil?
+        invalid_properties.push('invalid value for "is_shared", is_shared cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @quotas.nil?
+        invalid_properties.push('invalid value for "quotas", quotas cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @updated_at.nil?
+        invalid_properties.push('invalid value for "updated_at", updated_at 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 @allowed_actions.nil?
+      return false if @created_at.nil?
+      return false if @has_refresh_token.nil?
+      return false if @has_smtp_password.nil?
+      return false if @id.nil?
+      return false if @is_active.nil?
+      return false if @is_editable.nil?
+      return false if @is_shared.nil?
+      return false if @name.nil?
+      return false if @quotas.nil?
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["active", "inactive", "error", "pending", "unknown_default_open_api"])
+      return false unless status_validator.valid?(@status)
+      return false if @type.nil?
+      type_validator = EnumAttributeValidator.new('String', ["smtp", "gmail_api", "outlook_api", "amazon_ses", "unknown_default_open_api"])
+      return false unless type_validator.valid?(@type)
+      return false if @updated_at.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] allowed_actions Value to be assigned
+    def allowed_actions=(allowed_actions)
+      if allowed_actions.nil?
+        fail ArgumentError, 'allowed_actions cannot be nil'
+      end
+
+      @allowed_actions = allowed_actions
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] created_at Value to be assigned
+    def created_at=(created_at)
+      if created_at.nil?
+        fail ArgumentError, 'created_at cannot be nil'
+      end
+
+      @created_at = created_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] has_refresh_token Value to be assigned
+    def has_refresh_token=(has_refresh_token)
+      if has_refresh_token.nil?
+        fail ArgumentError, 'has_refresh_token cannot be nil'
+      end
+
+      @has_refresh_token = has_refresh_token
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] has_smtp_password Value to be assigned
+    def has_smtp_password=(has_smtp_password)
+      if has_smtp_password.nil?
+        fail ArgumentError, 'has_smtp_password cannot be nil'
+      end
+
+      @has_smtp_password = has_smtp_password
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] is_active Value to be assigned
+    def is_active=(is_active)
+      if is_active.nil?
+        fail ArgumentError, 'is_active cannot be nil'
+      end
+
+      @is_active = is_active
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] is_editable Value to be assigned
+    def is_editable=(is_editable)
+      if is_editable.nil?
+        fail ArgumentError, 'is_editable cannot be nil'
+      end
+
+      @is_editable = is_editable
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] is_shared Value to be assigned
+    def is_shared=(is_shared)
+      if is_shared.nil?
+        fail ArgumentError, 'is_shared cannot be nil'
+      end
+
+      @is_shared = is_shared
+    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
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] quotas Value to be assigned
+    def quotas=(quotas)
+      if quotas.nil?
+        fail ArgumentError, 'quotas cannot be nil'
+      end
+
+      @quotas = quotas
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["active", "inactive", "error", "pending", "unknown_default_open_api"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["smtp", "gmail_api", "outlook_api", "amazon_ses", "unknown_default_open_api"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] updated_at Value to be assigned
+    def updated_at=(updated_at)
+      if updated_at.nil?
+        fail ArgumentError, 'updated_at cannot be nil'
+      end
+
+      @updated_at = updated_at
+    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 &&
+          allowed_actions == o.allowed_actions &&
+          created_at == o.created_at &&
+          from_email == o.from_email &&
+          from_name == o.from_name &&
+          has_refresh_token == o.has_refresh_token &&
+          has_smtp_password == o.has_smtp_password &&
+          id == o.id &&
+          is_active == o.is_active &&
+          is_editable == o.is_editable &&
+          is_shared == o.is_shared &&
+          last_tested_at == o.last_tested_at &&
+          last_used_at == o.last_used_at &&
+          name == o.name &&
+          oauth_email == o.oauth_email &&
+          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_port == o.smtp_port &&
+          smtp_protocol == o.smtp_protocol &&
+          smtp_username == o.smtp_username &&
+          status == o.status &&
+          status_reason == o.status_reason &&
+          tracking_domain == o.tracking_domain &&
+          type == o.type &&
+          updated_at == o.updated_at
+    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
+      [allowed_actions, created_at, from_email, from_name, has_refresh_token, has_smtp_password, id, is_active, is_editable, is_shared, last_tested_at, last_used_at, name, oauth_email, percentage, quotas, reply_to_email, reply_to_name, smtp_host, smtp_port, smtp_protocol, smtp_username, status, status_reason, tracking_domain, type, updated_at].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