mailslurp_client 8.5.4 → 9.0.0

data/lib/mailslurp_client/models/contact_projection.rb

@@ -18,6 +18,8 @@ module MailSlurpClient
 
     attr_accessor :created_at
 
+    attr_accessor :email_addresses
+
     attr_accessor :first_name
 
     attr_accessor :group_id
@@ -33,6 +35,7 @@ module MailSlurpClient
       {
         :'company' => :'company',
         :'created_at' => :'createdAt',
+        :'email_addresses' => :'emailAddresses',
         :'first_name' => :'firstName',
         :'group_id' => :'groupId',
         :'id' => :'id',
@@ -46,6 +49,7 @@ module MailSlurpClient
       {
         :'company' => :'String',
         :'created_at' => :'DateTime',
+        :'email_addresses' => :'Array<String>',
         :'first_name' => :'String',
         :'group_id' => :'String',
         :'id' => :'String',
@@ -83,6 +87,12 @@ module MailSlurpClient
         self.created_at = attributes[:'created_at']
       end
 
+      if attributes.key?(:'email_addresses')
+        if (value = attributes[:'email_addresses']).is_a?(Array)
+          self.email_addresses = value
+        end
+      end
+
       if attributes.key?(:'first_name')
         self.first_name = attributes[:'first_name']
       end
@@ -134,6 +144,7 @@ module MailSlurpClient
       self.class == o.class &&
           company == o.company &&
           created_at == o.created_at &&
+          email_addresses == o.email_addresses &&
           first_name == o.first_name &&
           group_id == o.group_id &&
           id == o.id &&
@@ -150,7 +161,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [company, created_at, first_name, group_id, id, last_name, opt_out].hash
+      [company, created_at, email_addresses, first_name, group_id, id, last_name, opt_out].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/create_inbox_dto.rb

@@ -13,17 +13,18 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # Options for creating an inbox. An inbox has a real email address that can send and receive emails. Inboxes can be permanent or expire at a given time. They can use a custom email address (by verifying your own domain) or a randomly assigned email ending in either `mailslurp.com` or if `useDomainPool` is enabled then ending in a similar domains such as `mailslurp.xyz` (selected at random). 
   class CreateInboxDto
-    # Optional description of an inbox for labelling purposes
+    # Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with
     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!
+    # A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.
     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.
+    # Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX.
     attr_accessor :expires_at
 
-    # Is the inbox favorited. Favouriting inboxes is typically done in the dashboard for quick access
+    # Is the inbox favorited. Favouriting inboxes is typically done in the dashboard for quick access or filtering
     attr_accessor :favourite
 
     # Optional name of the inbox. Displayed in the dashboard for easier search
@@ -32,6 +33,9 @@ module MailSlurpClient
     # 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
 
+    # Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field.
+    attr_accessor :use_domain_pool
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -40,7 +44,8 @@ module MailSlurpClient
         :'expires_at' => :'expiresAt',
         :'favourite' => :'favourite',
         :'name' => :'name',
-        :'tags' => :'tags'
+        :'tags' => :'tags',
+        :'use_domain_pool' => :'useDomainPool'
       }
     end
 
@@ -52,7 +57,8 @@ module MailSlurpClient
         :'expires_at' => :'DateTime',
         :'favourite' => :'Boolean',
         :'name' => :'String',
-        :'tags' => :'Array<String>'
+        :'tags' => :'Array<String>',
+        :'use_domain_pool' => :'Boolean'
       }
     end
 
@@ -102,6 +108,10 @@ module MailSlurpClient
           self.tags = value
         end
       end
+
+      if attributes.key?(:'use_domain_pool')
+        self.use_domain_pool = attributes[:'use_domain_pool']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -127,7 +137,8 @@ module MailSlurpClient
           expires_at == o.expires_at &&
           favourite == o.favourite &&
           name == o.name &&
-          tags == o.tags
+          tags == o.tags &&
+          use_domain_pool == o.use_domain_pool
     end
 
     # @see the `==` method
@@ -139,7 +150,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [description, email_address, expires_at, favourite, name, tags].hash
+      [description, email_address, expires_at, favourite, name, tags, use_domain_pool].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/domain_dto.rb

@@ -17,12 +17,15 @@ module MailSlurpClient
   class DomainDto
     attr_accessor :created_at
 
-    # DNS records for DKIM approval
+    # Unique token DKIM tokens
     attr_accessor :dkim_tokens
 
     # Custom domain name
     attr_accessor :domain
 
+    # List of DNS domain name records (C, MX, TXT) etc that you must add to the DNS server associated with your domain provider.
+    attr_accessor :domain_name_records
+
     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.
@@ -32,7 +35,7 @@ module MailSlurpClient
 
     attr_accessor :user_id
 
-    # A TXT record that you must place in the DNS settings of the domain to complete domain verification
+    # Verification tokens
     attr_accessor :verification_token
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -41,6 +44,7 @@ module MailSlurpClient
         :'created_at' => :'createdAt',
         :'dkim_tokens' => :'dkimTokens',
         :'domain' => :'domain',
+        :'domain_name_records' => :'domainNameRecords',
         :'id' => :'id',
         :'is_verified' => :'isVerified',
         :'updated_at' => :'updatedAt',
@@ -55,6 +59,7 @@ module MailSlurpClient
         :'created_at' => :'DateTime',
         :'dkim_tokens' => :'Array<String>',
         :'domain' => :'String',
+        :'domain_name_records' => :'Array<DomainNameRecord>',
         :'id' => :'String',
         :'is_verified' => :'Boolean',
         :'updated_at' => :'DateTime',
@@ -98,6 +103,12 @@ module MailSlurpClient
         self.domain = attributes[:'domain']
       end
 
+      if attributes.key?(:'domain_name_records')
+        if (value = attributes[:'domain_name_records']).is_a?(Array)
+          self.domain_name_records = value
+        end
+      end
+
       if attributes.key?(:'id')
         self.id = attributes[:'id']
       end
@@ -160,6 +171,7 @@ module MailSlurpClient
           created_at == o.created_at &&
           dkim_tokens == o.dkim_tokens &&
           domain == o.domain &&
+          domain_name_records == o.domain_name_records &&
           id == o.id &&
           is_verified == o.is_verified &&
           updated_at == o.updated_at &&
@@ -176,7 +188,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [created_at, dkim_tokens, domain, id, is_verified, updated_at, user_id, verification_token].hash
+      [created_at, dkim_tokens, domain, domain_name_records, id, is_verified, updated_at, user_id, verification_token].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/domain_name_record.rb

@@ -0,0 +1,290 @@
+=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
+  # DNS Record required for verification of a domain
+  class DomainNameRecord
+    attr_accessor :name
+
+    attr_accessor :record_entries
+
+    attr_accessor :record_type
+
+    attr_accessor :ttl
+
+    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
+      {
+        :'name' => :'name',
+        :'record_entries' => :'recordEntries',
+        :'record_type' => :'recordType',
+        :'ttl' => :'ttl'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'name' => :'String',
+        :'record_entries' => :'Array<String>',
+        :'record_type' => :'String',
+        :'ttl' => :'Integer'
+      }
+    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::DomainNameRecord` 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::DomainNameRecord`. 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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'record_entries')
+        if (value = attributes[:'record_entries']).is_a?(Array)
+          self.record_entries = value
+        end
+      end
+
+      if attributes.key?(:'record_type')
+        self.record_type = attributes[:'record_type']
+      end
+
+      if attributes.key?(:'ttl')
+        self.ttl = attributes[:'ttl']
+      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 @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @record_entries.nil?
+        invalid_properties.push('invalid value for "record_entries", record_entries cannot be nil.')
+      end
+
+      if @record_type.nil?
+        invalid_properties.push('invalid value for "record_type", record_type cannot be nil.')
+      end
+
+      if @ttl.nil?
+        invalid_properties.push('invalid value for "ttl", ttl 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 @name.nil?
+      return false if @record_entries.nil?
+      return false if @record_type.nil?
+      record_type_validator = EnumAttributeValidator.new('String', ["A", "NS", "MD", "MF", "CNAME", "SOA", "MB", "MG", "MR", "NULL", "WKS", "PTR", "HINFO", "MINFO", "MX", "TXT", "RP", "AFSDB", "X25", "ISDN", "RT", "NSAP", "NSAP_PTR", "SIG", "KEY", "PX", "GPOS", "AAAA", "LOC", "NXT", "EID", "NIMLOC", "SRV", "ATMA", "NAPTR", "KX", "CERT", "A6", "DNAME", "SINK", "OPT", "APL", "DS", "SSHFP", "IPSECKEY", "RRSIG", "NSEC", "DNSKEY", "DHCID", "NSEC3", "NSEC3PARAM", "TLSA", "SMIMEA", "HIP", "NINFO", "RKEY", "TALINK", "CDS", "CDNSKEY", "OPENPGPKEY", "CSYNC", "ZONEMD", "SVCB", "HTTPS", "SPF", "UINFO", "UID", "GID", "UNSPEC", "NID", "L32", "L64", "LP", "EUI48", "EUI64", "TKEY", "TSIG", "IXFR", "AXFR", "MAILB", "MAILA", "ANY", "URI", "CAA", "AVC", "DOA", "AMTRELAY", "TA", "DLV"])
+      return false unless record_type_validator.valid?(@record_type)
+      return false if @ttl.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] record_type Object to be assigned
+    def record_type=(record_type)
+      validator = EnumAttributeValidator.new('String', ["A", "NS", "MD", "MF", "CNAME", "SOA", "MB", "MG", "MR", "NULL", "WKS", "PTR", "HINFO", "MINFO", "MX", "TXT", "RP", "AFSDB", "X25", "ISDN", "RT", "NSAP", "NSAP_PTR", "SIG", "KEY", "PX", "GPOS", "AAAA", "LOC", "NXT", "EID", "NIMLOC", "SRV", "ATMA", "NAPTR", "KX", "CERT", "A6", "DNAME", "SINK", "OPT", "APL", "DS", "SSHFP", "IPSECKEY", "RRSIG", "NSEC", "DNSKEY", "DHCID", "NSEC3", "NSEC3PARAM", "TLSA", "SMIMEA", "HIP", "NINFO", "RKEY", "TALINK", "CDS", "CDNSKEY", "OPENPGPKEY", "CSYNC", "ZONEMD", "SVCB", "HTTPS", "SPF", "UINFO", "UID", "GID", "UNSPEC", "NID", "L32", "L64", "LP", "EUI48", "EUI64", "TKEY", "TSIG", "IXFR", "AXFR", "MAILB", "MAILA", "ANY", "URI", "CAA", "AVC", "DOA", "AMTRELAY", "TA", "DLV"])
+      unless validator.valid?(record_type)
+        fail ArgumentError, "invalid value for \"record_type\", must be one of #{validator.allowable_values}."
+      end
+      @record_type = record_type
+    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 &&
+          name == o.name &&
+          record_entries == o.record_entries &&
+          record_type == o.record_type &&
+          ttl == o.ttl
+    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
+      [name, record_entries, record_type, ttl].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