mailslurp_client 15.18.5 → 15.19.0

data/lib/mailslurp_client/models/create_connector_imap_connection_options.rb

@@ -0,0 +1,286 @@
+=begin
+#MailSlurp API
+
+#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more.  ## Resources  - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository
+
+The version of the OpenAPI document: 6.5.2
+Contact: contact@mailslurp.dev
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module MailSlurpClient
+  # Options for IMAP connection to external email inbox. Allows syncing emails iva IMAP.
+  class CreateConnectorImapConnectionOptions
+    attr_accessor :imap_ssl
+
+    attr_accessor :imap_username
+
+    attr_accessor :imap_password
+
+    # Optional folder to select during IMAP connection
+    attr_accessor :select_folder
+
+    attr_accessor :search_terms
+
+    # IMAP server port
+    attr_accessor :imap_port
+
+    # IMAP server host
+    attr_accessor :imap_host
+
+    # IMAP server enabled
+    attr_accessor :enabled
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'imap_ssl' => :'imapSsl',
+        :'imap_username' => :'imapUsername',
+        :'imap_password' => :'imapPassword',
+        :'select_folder' => :'selectFolder',
+        :'search_terms' => :'searchTerms',
+        :'imap_port' => :'imapPort',
+        :'imap_host' => :'imapHost',
+        :'enabled' => :'enabled'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'imap_ssl' => :'Boolean',
+        :'imap_username' => :'String',
+        :'imap_password' => :'String',
+        :'select_folder' => :'String',
+        :'search_terms' => :'String',
+        :'imap_port' => :'Integer',
+        :'imap_host' => :'String',
+        :'enabled' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'imap_ssl',
+        :'imap_username',
+        :'imap_password',
+        :'select_folder',
+        :'search_terms',
+        :'imap_port',
+        :'enabled'
+      ])
+    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 `MailSlurpClient::CreateConnectorImapConnectionOptions` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `MailSlurpClient::CreateConnectorImapConnectionOptions`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'imap_ssl')
+        self.imap_ssl = attributes[:'imap_ssl']
+      end
+
+      if attributes.key?(:'imap_username')
+        self.imap_username = attributes[:'imap_username']
+      end
+
+      if attributes.key?(:'imap_password')
+        self.imap_password = attributes[:'imap_password']
+      end
+
+      if attributes.key?(:'select_folder')
+        self.select_folder = attributes[:'select_folder']
+      end
+
+      if attributes.key?(:'search_terms')
+        self.search_terms = attributes[:'search_terms']
+      end
+
+      if attributes.key?(:'imap_port')
+        self.imap_port = attributes[:'imap_port']
+      end
+
+      if attributes.key?(:'imap_host')
+        self.imap_host = attributes[:'imap_host']
+      end
+
+      if attributes.key?(:'enabled')
+        self.enabled = attributes[:'enabled']
+      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
+      invalid_properties = Array.new
+      if @imap_host.nil?
+        invalid_properties.push('invalid value for "imap_host", imap_host 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?
+      return false if @imap_host.nil?
+      true
+    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_ssl == o.imap_ssl &&
+          imap_username == o.imap_username &&
+          imap_password == o.imap_password &&
+          select_folder == o.select_folder &&
+          search_terms == o.search_terms &&
+          imap_port == o.imap_port &&
+          imap_host == o.imap_host &&
+          enabled == o.enabled
+    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_ssl, imap_username, imap_password, select_folder, search_terms, imap_port, imap_host, enabled].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)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if 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[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        MailSlurpClient.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_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
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/mailslurp_client/models/create_connector_options.rb

@@ -13,22 +13,25 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # Options for creating an inbox connection with an external mail provider
   class CreateConnectorOptions
-    attr_accessor :connector_type
-
-    attr_accessor :connector_auth_type
-
-    attr_accessor :imap_settings
-
-    attr_accessor :inbox_id
-
+    # Enable automatic background sync
     attr_accessor :sync_enabled
 
+    # Sync schedule type
     attr_accessor :sync_schedule_type
 
+    # Sync interval in minutes
     attr_accessor :sync_interval
 
-    attr_accessor :fetch_settings
+    # Name of connector
+    attr_accessor :name
+
+    # Email address of external inbox
+    attr_accessor :email_address
+
+    # Is connector enabled
+    attr_accessor :enabled
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -55,34 +58,36 @@ module MailSlurpClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'connector_type' => :'connectorType',
-        :'connector_auth_type' => :'connectorAuthType',
-        :'imap_settings' => :'imapSettings',
-        :'inbox_id' => :'inboxId',
         :'sync_enabled' => :'syncEnabled',
         :'sync_schedule_type' => :'syncScheduleType',
         :'sync_interval' => :'syncInterval',
-        :'fetch_settings' => :'fetchSettings'
+        :'name' => :'name',
+        :'email_address' => :'emailAddress',
+        :'enabled' => :'enabled'
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'connector_type' => :'String',
-        :'connector_auth_type' => :'String',
-        :'imap_settings' => :'CreateConnectorImapOptions',
-        :'inbox_id' => :'String',
         :'sync_enabled' => :'Boolean',
         :'sync_schedule_type' => :'String',
         :'sync_interval' => :'Integer',
-        :'fetch_settings' => :'CreateConnectorImapFetchOptions'
+        :'name' => :'String',
+        :'email_address' => :'String',
+        :'enabled' => :'Boolean'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'sync_enabled',
+        :'sync_schedule_type',
+        :'sync_interval',
+        :'name',
+        :'email_address',
+        :'enabled'
       ])
     end
 
@@ -101,22 +106,6 @@ module MailSlurpClient
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'connector_type')
-        self.connector_type = attributes[:'connector_type']
-      end
-
-      if attributes.key?(:'connector_auth_type')
-        self.connector_auth_type = attributes[:'connector_auth_type']
-      end
-
-      if attributes.key?(:'imap_settings')
-        self.imap_settings = attributes[:'imap_settings']
-      end
-
-      if attributes.key?(:'inbox_id')
-        self.inbox_id = attributes[:'inbox_id']
-      end
-
       if attributes.key?(:'sync_enabled')
         self.sync_enabled = attributes[:'sync_enabled']
       end
@@ -129,8 +118,16 @@ module MailSlurpClient
         self.sync_interval = attributes[:'sync_interval']
       end
 
-      if attributes.key?(:'fetch_settings')
-        self.fetch_settings = attributes[:'fetch_settings']
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'email_address')
+        self.email_address = attributes[:'email_address']
+      end
+
+      if attributes.key?(:'enabled')
+        self.enabled = attributes[:'enabled']
       end
     end
 
@@ -138,61 +135,17 @@ module MailSlurpClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @connector_type.nil?
-        invalid_properties.push('invalid value for "connector_type", connector_type cannot be nil.')
-      end
-
-      if @connector_auth_type.nil?
-        invalid_properties.push('invalid value for "connector_auth_type", connector_auth_type cannot be nil.')
-      end
-
-      if @sync_enabled.nil?
-        invalid_properties.push('invalid value for "sync_enabled", sync_enabled cannot be nil.')
-      end
-
-      if @sync_schedule_type.nil?
-        invalid_properties.push('invalid value for "sync_schedule_type", sync_schedule_type 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?
-      return false if @connector_type.nil?
-      connector_type_validator = EnumAttributeValidator.new('String', ["IMAP"])
-      return false unless connector_type_validator.valid?(@connector_type)
-      return false if @connector_auth_type.nil?
-      connector_auth_type_validator = EnumAttributeValidator.new('String', ["PLAIN_TEXT"])
-      return false unless connector_auth_type_validator.valid?(@connector_auth_type)
-      return false if @sync_enabled.nil?
-      return false if @sync_schedule_type.nil?
       sync_schedule_type_validator = EnumAttributeValidator.new('String', ["INTERVAL"])
       return false unless sync_schedule_type_validator.valid?(@sync_schedule_type)
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] connector_type Object to be assigned
-    def connector_type=(connector_type)
-      validator = EnumAttributeValidator.new('String', ["IMAP"])
-      unless validator.valid?(connector_type)
-        fail ArgumentError, "invalid value for \"connector_type\", must be one of #{validator.allowable_values}."
-      end
-      @connector_type = connector_type
-    end
-
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] connector_auth_type Object to be assigned
-    def connector_auth_type=(connector_auth_type)
-      validator = EnumAttributeValidator.new('String', ["PLAIN_TEXT"])
-      unless validator.valid?(connector_auth_type)
-        fail ArgumentError, "invalid value for \"connector_auth_type\", must be one of #{validator.allowable_values}."
-      end
-      @connector_auth_type = connector_auth_type
-    end
-
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] sync_schedule_type Object to be assigned
     def sync_schedule_type=(sync_schedule_type)
@@ -208,14 +161,12 @@ module MailSlurpClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          connector_type == o.connector_type &&
-          connector_auth_type == o.connector_auth_type &&
-          imap_settings == o.imap_settings &&
-          inbox_id == o.inbox_id &&
           sync_enabled == o.sync_enabled &&
           sync_schedule_type == o.sync_schedule_type &&
           sync_interval == o.sync_interval &&
-          fetch_settings == o.fetch_settings
+          name == o.name &&
+          email_address == o.email_address &&
+          enabled == o.enabled
     end
 
     # @see the `==` method
@@ -227,7 +178,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [connector_type, connector_auth_type, imap_settings, inbox_id, sync_enabled, sync_schedule_type, sync_interval, fetch_settings].hash
+      [sync_enabled, sync_schedule_type, sync_interval, name, email_address, enabled].hash
     end
 
     # Builds the object from hash