mailslurp_client 8.2.17 → 8.4.2

data/lib/mailslurp_client/models/{create_owned_alias_options.rb → create_alias_options.rb}

@@ -14,18 +14,18 @@ require 'date'
 
 module MailSlurpClient
   # Create email alias options. Email aliases can be used to mask real email addresses behind an ID. You can also attach an inbox to an alias so that any email received by the inbox email address if forwarded to the alias email address.
-  class CreateOwnedAliasOptions
-    # Email address to be hidden behind alias
+  class CreateAliasOptions
+    # Email address to be hidden behind alias. Emails sent to the alias email address will be forwarded to this address. If you want to enable replies set useThreads true and the reply-to for the email will allow outbound communication via a thread.
     attr_accessor :email_address
 
-    # Optional inbox ID to attach to alias. Emails received by this inbox will be forwarded to the alias email address
+    # Optional inbox ID to attach to alias. Null by default means an a new inbox will be created for the alias. Use a custom inbox to control what email address the alias uses. To use custom email addresses create a domain and an inbox, the use the inbox ID with this call. Emails received by this inbox will be forwarded to the alias email address
     attr_accessor :inbox_id
 
     # Optional name for alias
     attr_accessor :name
 
-    # Optional proxied flag. When proxied is true alias will forward the incoming emails to the aliased email address via a proxy inbox. A new proxy is created for every new email thread. By replying to the proxy you can correspond with using your email alias without revealing your real email address.
-    attr_accessor :proxied
+    # Enable threads options. If true emails will be sent with a unique reply-to thread address. This means you can reply to the forwarded email and it will be sent to the recipients via your alias address. That way a thread conversation is preserved.
+    attr_accessor :use_threads
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -33,7 +33,7 @@ module MailSlurpClient
         :'email_address' => :'emailAddress',
         :'inbox_id' => :'inboxId',
         :'name' => :'name',
-        :'proxied' => :'proxied'
+        :'use_threads' => :'useThreads'
       }
     end
 
@@ -43,7 +43,7 @@ module MailSlurpClient
         :'email_address' => :'String',
         :'inbox_id' => :'String',
         :'name' => :'String',
-        :'proxied' => :'Boolean'
+        :'use_threads' => :'Boolean'
       }
     end
 
@@ -57,13 +57,13 @@ module MailSlurpClient
     # @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::CreateOwnedAliasOptions` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::CreateAliasOptions` 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::CreateOwnedAliasOptions`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `MailSlurpClient::CreateAliasOptions`. 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
       }
@@ -80,8 +80,8 @@ module MailSlurpClient
         self.name = attributes[:'name']
       end
 
-      if attributes.key?(:'proxied')
-        self.proxied = attributes[:'proxied']
+      if attributes.key?(:'use_threads')
+        self.use_threads = attributes[:'use_threads']
       end
     end
 
@@ -106,7 +106,7 @@ module MailSlurpClient
           email_address == o.email_address &&
           inbox_id == o.inbox_id &&
           name == o.name &&
-          proxied == o.proxied
+          use_threads == o.use_threads
     end
 
     # @see the `==` method
@@ -118,7 +118,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [email_address, inbox_id, name, proxied].hash
+      [email_address, inbox_id, name, use_threads].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/create_inbox_dto.rb

@@ -0,0 +1,259 @@
+=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://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository 
+
+The version of the OpenAPI document: 6.5.2
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module MailSlurpClient
+  class CreateInboxDto
+    # Optional description of an inbox for labelling purposes
+    attr_accessor :description
+
+    # Optionally specify an email address you want the inbox to have. When left blank an email address will be randomly assigned to the inbox usually ending in `@mailslurp.com`. Custom email addresses must include your own custom domain that you have configured in MailSlurp. So if your domain is `mysite.com` you can created any email address ending in `@mysite.com`. All email addresses are transformed to lowercase!
+    attr_accessor :email_address
+
+    # When, if ever, will the inbox expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. Timestamp passed as string.
+    attr_accessor :expires_at
+
+    # Is the inbox favorited. Favouriting inboxes is typically done in the dashboard for quick access
+    attr_accessor :favourite
+
+    # Optional name of the inbox. Displayed in the dashboard for easier search
+    attr_accessor :name
+
+    # Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.
+    attr_accessor :tags
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'description' => :'description',
+        :'email_address' => :'emailAddress',
+        :'expires_at' => :'expiresAt',
+        :'favourite' => :'favourite',
+        :'name' => :'name',
+        :'tags' => :'tags'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'description' => :'String',
+        :'email_address' => :'String',
+        :'expires_at' => :'DateTime',
+        :'favourite' => :'Boolean',
+        :'name' => :'String',
+        :'tags' => :'Array<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 `MailSlurpClient::CreateInboxDto` 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::CreateInboxDto`. 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?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'email_address')
+        self.email_address = attributes[:'email_address']
+      end
+
+      if attributes.key?(:'expires_at')
+        self.expires_at = attributes[:'expires_at']
+      end
+
+      if attributes.key?(:'favourite')
+        self.favourite = attributes[:'favourite']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'tags')
+        if (value = attributes[:'tags']).is_a?(Array)
+          self.tags = value
+        end
+      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
+      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?
+      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 &&
+          description == o.description &&
+          email_address == o.email_address &&
+          expires_at == o.expires_at &&
+          favourite == o.favourite &&
+          name == o.name &&
+          tags == o.tags
+    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
+      [description, email_address, expires_at, favourite, name, tags].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/domain_dto.rb

@@ -17,22 +17,29 @@ module MailSlurpClient
   class DomainDto
     attr_accessor :created_at
 
+    # DNS records for DKIM approval
+    attr_accessor :dkim_tokens
+
+    # Custom domain name
     attr_accessor :domain
 
     attr_accessor :id
 
+    # Whether domain has been verified or not. If the domain is not verified after 72 hours there is most likely an issue with the domains DNS records.
     attr_accessor :is_verified
 
     attr_accessor :updated_at
 
     attr_accessor :user_id
 
+    # A TXT record that you must place in the DNS settings of the domain to complete domain verification
     attr_accessor :verification_token
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'created_at' => :'createdAt',
+        :'dkim_tokens' => :'dkimTokens',
         :'domain' => :'domain',
         :'id' => :'id',
         :'is_verified' => :'isVerified',
@@ -46,6 +53,7 @@ module MailSlurpClient
     def self.openapi_types
       {
         :'created_at' => :'DateTime',
+        :'dkim_tokens' => :'Array<String>',
         :'domain' => :'String',
         :'id' => :'String',
         :'is_verified' => :'Boolean',
@@ -80,6 +88,12 @@ module MailSlurpClient
         self.created_at = attributes[:'created_at']
       end
 
+      if attributes.key?(:'dkim_tokens')
+        if (value = attributes[:'dkim_tokens']).is_a?(Array)
+          self.dkim_tokens = value
+        end
+      end
+
       if attributes.key?(:'domain')
         self.domain = attributes[:'domain']
       end
@@ -113,18 +127,10 @@ module MailSlurpClient
         invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
       end
 
-      if @domain.nil?
-        invalid_properties.push('invalid value for "domain", domain cannot be nil.')
-      end
-
       if @id.nil?
         invalid_properties.push('invalid value for "id", id cannot be nil.')
       end
 
-      if @is_verified.nil?
-        invalid_properties.push('invalid value for "is_verified", is_verified cannot be nil.')
-      end
-
       if @updated_at.nil?
         invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
       end
@@ -133,10 +139,6 @@ module MailSlurpClient
         invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
       end
 
-      if @verification_token.nil?
-        invalid_properties.push('invalid value for "verification_token", verification_token cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -144,12 +146,9 @@ module MailSlurpClient
     # @return true if the model is valid
     def valid?
       return false if @created_at.nil?
-      return false if @domain.nil?
       return false if @id.nil?
-      return false if @is_verified.nil?
       return false if @updated_at.nil?
       return false if @user_id.nil?
-      return false if @verification_token.nil?
       true
     end
 
@@ -159,6 +158,7 @@ module MailSlurpClient
       return true if self.equal?(o)
       self.class == o.class &&
           created_at == o.created_at &&
+          dkim_tokens == o.dkim_tokens &&
           domain == o.domain &&
           id == o.id &&
           is_verified == o.is_verified &&
@@ -176,7 +176,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [created_at, domain, id, is_verified, updated_at, user_id, verification_token].hash
+      [created_at, dkim_tokens, domain, id, is_verified, updated_at, user_id, verification_token].hash
     end
 
     # Builds the object from hash