sendmux-management 1.0.0

data/lib/sendmux_management_generated/models/mailbox_credential.rb

@@ -0,0 +1,353 @@
+=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
+  # Initial credential for the mailbox. `null` if credential generation failed — call POST /mailboxes/{id}/keys to retry.
+  class MailboxCredential < ApiModelBase
+    # IMAP retrieval port
+    attr_accessor :imap_port
+
+    attr_accessor :key_prefix
+
+    attr_accessor :key_suffix
+
+    # Credential public ID
+    attr_accessor :public_id
+
+    # Mailbox credential — shown exactly once. Use as a Bearer token on the HTTP API and as the password for IMAP retrieval and SMTP submission.
+    attr_accessor :secret
+
+    # Mailbox server name
+    attr_accessor :server
+
+    # SMTP submission port
+    attr_accessor :smtp_port
+
+    # Mailbox email address used as the login
+    attr_accessor :username
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'imap_port' => :'imap_port',
+        :'key_prefix' => :'key_prefix',
+        :'key_suffix' => :'key_suffix',
+        :'public_id' => :'public_id',
+        :'secret' => :'secret',
+        :'server' => :'server',
+        :'smtp_port' => :'smtp_port',
+        :'username' => :'username'
+      }
+    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
+      {
+        :'imap_port' => :'Integer',
+        :'key_prefix' => :'String',
+        :'key_suffix' => :'String',
+        :'public_id' => :'String',
+        :'secret' => :'String',
+        :'server' => :'String',
+        :'smtp_port' => :'Integer',
+        :'username' => :'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::MailboxCredential` 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::MailboxCredential`. 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?(:'imap_port')
+        self.imap_port = attributes[:'imap_port']
+      else
+        self.imap_port = nil
+      end
+
+      if attributes.key?(:'key_prefix')
+        self.key_prefix = attributes[:'key_prefix']
+      else
+        self.key_prefix = nil
+      end
+
+      if attributes.key?(:'key_suffix')
+        self.key_suffix = attributes[:'key_suffix']
+      else
+        self.key_suffix = nil
+      end
+
+      if attributes.key?(:'public_id')
+        self.public_id = attributes[:'public_id']
+      else
+        self.public_id = nil
+      end
+
+      if attributes.key?(:'secret')
+        self.secret = attributes[:'secret']
+      else
+        self.secret = nil
+      end
+
+      if attributes.key?(:'server')
+        self.server = attributes[:'server']
+      else
+        self.server = nil
+      end
+
+      if attributes.key?(:'smtp_port')
+        self.smtp_port = attributes[:'smtp_port']
+      else
+        self.smtp_port = nil
+      end
+
+      if attributes.key?(:'username')
+        self.username = attributes[:'username']
+      else
+        self.username = 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 @imap_port.nil?
+        invalid_properties.push('invalid value for "imap_port", imap_port cannot be nil.')
+      end
+
+      if @key_prefix.nil?
+        invalid_properties.push('invalid value for "key_prefix", key_prefix cannot be nil.')
+      end
+
+      if @key_suffix.nil?
+        invalid_properties.push('invalid value for "key_suffix", key_suffix cannot be nil.')
+      end
+
+      if @public_id.nil?
+        invalid_properties.push('invalid value for "public_id", public_id cannot be nil.')
+      end
+
+      if @secret.nil?
+        invalid_properties.push('invalid value for "secret", secret cannot be nil.')
+      end
+
+      if @server.nil?
+        invalid_properties.push('invalid value for "server", server cannot be nil.')
+      end
+
+      if @smtp_port.nil?
+        invalid_properties.push('invalid value for "smtp_port", smtp_port cannot be nil.')
+      end
+
+      if @username.nil?
+        invalid_properties.push('invalid value for "username", username 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 @imap_port.nil?
+      return false if @key_prefix.nil?
+      return false if @key_suffix.nil?
+      return false if @public_id.nil?
+      return false if @secret.nil?
+      return false if @server.nil?
+      return false if @smtp_port.nil?
+      return false if @username.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] imap_port Value to be assigned
+    def imap_port=(imap_port)
+      if imap_port.nil?
+        fail ArgumentError, 'imap_port cannot be nil'
+      end
+
+      @imap_port = imap_port
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] key_prefix Value to be assigned
+    def key_prefix=(key_prefix)
+      if key_prefix.nil?
+        fail ArgumentError, 'key_prefix cannot be nil'
+      end
+
+      @key_prefix = key_prefix
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] key_suffix Value to be assigned
+    def key_suffix=(key_suffix)
+      if key_suffix.nil?
+        fail ArgumentError, 'key_suffix cannot be nil'
+      end
+
+      @key_suffix = key_suffix
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] public_id Value to be assigned
+    def public_id=(public_id)
+      if public_id.nil?
+        fail ArgumentError, 'public_id cannot be nil'
+      end
+
+      @public_id = public_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] secret Value to be assigned
+    def secret=(secret)
+      if secret.nil?
+        fail ArgumentError, 'secret cannot be nil'
+      end
+
+      @secret = secret
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] server Value to be assigned
+    def server=(server)
+      if server.nil?
+        fail ArgumentError, 'server cannot be nil'
+      end
+
+      @server = server
+    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
+
+      @smtp_port = smtp_port
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] username Value to be assigned
+    def username=(username)
+      if username.nil?
+        fail ArgumentError, 'username cannot be nil'
+      end
+
+      @username = username
+    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 &&
+          imap_port == o.imap_port &&
+          key_prefix == o.key_prefix &&
+          key_suffix == o.key_suffix &&
+          public_id == o.public_id &&
+          secret == o.secret &&
+          server == o.server &&
+          smtp_port == o.smtp_port &&
+          username == o.username
+    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
+      [imap_port, key_prefix, key_suffix, public_id, secret, server, smtp_port, username].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/mailbox_deleted_response.rb

@@ -0,0 +1,223 @@
+=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 MailboxDeletedResponse < ApiModelBase
+    attr_accessor :meta
+
+    attr_accessor :ok
+
+    attr_accessor :data
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'meta' => :'meta',
+        :'ok' => :'ok',
+        :'data' => :'data'
+      }
+    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
+      {
+        :'meta' => :'ResponseMeta',
+        :'ok' => :'Boolean',
+        :'data' => :'DomainDeletedResponseAllOfData'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'SuccessEnvelope'
+      ]
+    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::MailboxDeletedResponse` 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::MailboxDeletedResponse`. 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?(:'meta')
+        self.meta = attributes[:'meta']
+      else
+        self.meta = nil
+      end
+
+      if attributes.key?(:'ok')
+        self.ok = attributes[:'ok']
+      else
+        self.ok = nil
+      end
+
+      if attributes.key?(:'data')
+        self.data = attributes[:'data']
+      else
+        self.data = 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 @meta.nil?
+        invalid_properties.push('invalid value for "meta", meta cannot be nil.')
+      end
+
+      if @ok.nil?
+        invalid_properties.push('invalid value for "ok", ok cannot be nil.')
+      end
+
+      if @data.nil?
+        invalid_properties.push('invalid value for "data", data 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 @meta.nil?
+      return false if @ok.nil?
+      return false if @data.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] meta Value to be assigned
+    def meta=(meta)
+      if meta.nil?
+        fail ArgumentError, 'meta cannot be nil'
+      end
+
+      @meta = meta
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ok Value to be assigned
+    def ok=(ok)
+      if ok.nil?
+        fail ArgumentError, 'ok cannot be nil'
+      end
+
+      @ok = ok
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] data Value to be assigned
+    def data=(data)
+      if data.nil?
+        fail ArgumentError, 'data cannot be nil'
+      end
+
+      @data = data
+    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 &&
+          meta == o.meta &&
+          ok == o.ok &&
+          data == o.data
+    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
+      [meta, ok, data].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