mailslurp_client 11.0.1 → 11.4.0

data/lib/mailslurp_client/api/inbox_controller_api.rb

@@ -439,199 +439,6 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get an expired inbox record
-    # Inboxes created with an expiration date will expire after the given date and be moved to an ExpiredInbox entity. You can still read emails in the inbox but it can no longer send or receive emails. Fetch the expired inboxes to view the old inboxes properties
-    # @param expired_id [String] ID of the ExpiredInboxRecord you want to retrieve. This is different from the ID of the inbox you are interested in. See other methods for getting ExpiredInboxRecord for an inbox inboxId)
-    # @param [Hash] opts the optional parameters
-    # @return [ExpiredInboxDto]
-    def get_expired_inbox_record_by_id(expired_id, opts = {})
-      data, _status_code, _headers = get_expired_inbox_record_by_id_with_http_info(expired_id, opts)
-      data
-    end
-
-    # Get an expired inbox record
-    # Inboxes created with an expiration date will expire after the given date and be moved to an ExpiredInbox entity. You can still read emails in the inbox but it can no longer send or receive emails. Fetch the expired inboxes to view the old inboxes properties
-    # @param expired_id [String] ID of the ExpiredInboxRecord you want to retrieve. This is different from the ID of the inbox you are interested in. See other methods for getting ExpiredInboxRecord for an inbox inboxId)
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(ExpiredInboxDto, Integer, Hash)>] ExpiredInboxDto data, response status code and response headers
-    def get_expired_inbox_record_by_id_with_http_info(expired_id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_expired_inbox_record_by_id ...'
-      end
-      # verify the required parameter 'expired_id' is set
-      if @api_client.config.client_side_validation && expired_id.nil?
-        fail ArgumentError, "Missing the required parameter 'expired_id' when calling InboxControllerApi.get_expired_inbox_record_by_id"
-      end
-      # resource path
-      local_var_path = '/inboxes/expired-records/{expiredId}'.sub('{' + 'expiredId' + '}', CGI.escape(expired_id.to_s))
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-
-      # header parameters
-      header_params = opts[:header_params] || {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-
-      # form parameters
-      form_params = opts[:form_params] || {}
-
-      # http body (model)
-      post_body = opts[:body] 
-
-      # return_type
-      return_type = opts[:return_type] || 'ExpiredInboxDto' 
-
-      # auth_names
-      auth_names = opts[:auth_names] || ['API_KEY']
-
-      new_options = opts.merge(
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => return_type
-      )
-
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: InboxControllerApi#get_expired_inbox_record_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Get expired inbox record for a previously existing inbox
-    # Use the inboxId to return an ExpiredInboxRecord if an inbox has expired. Inboxes expire and are disabled if an expiration date is set or plan requires. Returns 404 if no expired inbox is found for the inboxId
-    # @param inbox_id [String] ID of inbox you want to retrieve (not the inbox ID)
-    # @param [Hash] opts the optional parameters
-    # @return [ExpiredInboxDto]
-    def get_expired_inbox_record_by_inbox_id(inbox_id, opts = {})
-      data, _status_code, _headers = get_expired_inbox_record_by_inbox_id_with_http_info(inbox_id, opts)
-      data
-    end
-
-    # Get expired inbox record for a previously existing inbox
-    # Use the inboxId to return an ExpiredInboxRecord if an inbox has expired. Inboxes expire and are disabled if an expiration date is set or plan requires. Returns 404 if no expired inbox is found for the inboxId
-    # @param inbox_id [String] ID of inbox you want to retrieve (not the inbox ID)
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(ExpiredInboxDto, Integer, Hash)>] ExpiredInboxDto data, response status code and response headers
-    def get_expired_inbox_record_by_inbox_id_with_http_info(inbox_id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_expired_inbox_record_by_inbox_id ...'
-      end
-      # verify the required parameter 'inbox_id' is set
-      if @api_client.config.client_side_validation && inbox_id.nil?
-        fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.get_expired_inbox_record_by_inbox_id"
-      end
-      # resource path
-      local_var_path = '/inboxes/{inboxId}/expired-record'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-
-      # header parameters
-      header_params = opts[:header_params] || {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-
-      # form parameters
-      form_params = opts[:form_params] || {}
-
-      # http body (model)
-      post_body = opts[:body] 
-
-      # return_type
-      return_type = opts[:return_type] || 'ExpiredInboxDto' 
-
-      # auth_names
-      auth_names = opts[:auth_names] || ['API_KEY']
-
-      new_options = opts.merge(
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => return_type
-      )
-
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: InboxControllerApi#get_expired_inbox_record_by_inbox_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # List records of expired inboxes
-    # Inboxes created with an expiration date will expire after the given date. An ExpiredInboxRecord is created that records the inboxes old ID and email address. You can still read emails in the inbox (using the inboxes old ID) but the email address associated with the inbox can no longer send or receive emails. Fetch expired inbox records to view the old inboxes properties
-    # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page Optional page index in inbox sent email list pagination (default to 0)
-    # @option opts [Integer] :size Optional page size in inbox sent email list pagination (default to 20)
-    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
-    # @return [PageExpiredInboxRecordProjection]
-    def get_expired_inbox_records(opts = {})
-      data, _status_code, _headers = get_expired_inbox_records_with_http_info(opts)
-      data
-    end
-
-    # List records of expired inboxes
-    # Inboxes created with an expiration date will expire after the given date. An ExpiredInboxRecord is created that records the inboxes old ID and email address. You can still read emails in the inbox (using the inboxes old ID) but the email address associated with the inbox can no longer send or receive emails. Fetch expired inbox records to view the old inboxes properties
-    # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page Optional page index in inbox sent email list pagination
-    # @option opts [Integer] :size Optional page size in inbox sent email list pagination
-    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
-    # @return [Array<(PageExpiredInboxRecordProjection, Integer, Hash)>] PageExpiredInboxRecordProjection data, response status code and response headers
-    def get_expired_inbox_records_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_expired_inbox_records ...'
-      end
-      allowable_values = ["ASC", "DESC"]
-      if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
-        fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
-      end
-      # resource path
-      local_var_path = '/inboxes/expired-records'
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
-      query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
-      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
-
-      # header parameters
-      header_params = opts[:header_params] || {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-
-      # form parameters
-      form_params = opts[:form_params] || {}
-
-      # http body (model)
-      post_body = opts[:body] 
-
-      # return_type
-      return_type = opts[:return_type] || 'PageExpiredInboxRecordProjection' 
-
-      # auth_names
-      auth_names = opts[:auth_names] || ['API_KEY']
-
-      new_options = opts.merge(
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => return_type
-      )
-
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: InboxControllerApi#get_expired_inbox_records\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # Get Inbox
     # Returns an inbox's properties, including its email address and ID.
     # @param inbox_id [String] inboxId

data/lib/mailslurp_client/models/create_domain_options.rb

@@ -13,14 +13,22 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
-  # Options for creating a domain to use with MailSlurp. You must have ownership access to this domain in order to verify it.
+  # Options for creating a domain to use with MailSlurp. You must have ownership access to this domain in order to verify it. Domains will not functionally currently until the domain has been verified. See https://www.mailslurp.com/guides/custom-domains for help.
   class CreateDomainOptions
-    # The top level domain you wish to use with MailSlurp
+    # Whether to create a catch all inbox for the domain. Any email sent to an address using your domain that cannot be matched to an existing inbox you created with the domain will be routed to the created catch all inbox. You can access emails using the regular methods on this inbox ID.
+    attr_accessor :created_catch_all_inbox
+
+    # Optional description of the domain.
+    attr_accessor :description
+
+    # The top level domain you wish to use with MailSlurp. Do not specify subdomain just the top level. So `test.com` covers all subdomains such as `mail.test.com`. Don't include a protocol such as `http://`. Once added you must complete the verification steps by adding the returned records to your domain.
     attr_accessor :domain
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'created_catch_all_inbox' => :'createdCatchAllInbox',
+        :'description' => :'description',
         :'domain' => :'domain'
       }
     end
@@ -28,6 +36,8 @@ module MailSlurpClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'created_catch_all_inbox' => :'Boolean',
+        :'description' => :'String',
         :'domain' => :'String'
       }
     end
@@ -53,6 +63,14 @@ module MailSlurpClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'created_catch_all_inbox')
+        self.created_catch_all_inbox = attributes[:'created_catch_all_inbox']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
       if attributes.key?(:'domain')
         self.domain = attributes[:'domain']
       end
@@ -76,6 +94,8 @@ module MailSlurpClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          created_catch_all_inbox == o.created_catch_all_inbox &&
+          description == o.description &&
           domain == o.domain
     end
 
@@ -88,7 +108,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [domain].hash
+      [created_catch_all_inbox, description, domain].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/domain_dto.rb

@@ -15,6 +15,9 @@ require 'date'
 module MailSlurpClient
   # Domain plus verification records and status
   class DomainDto
+    # The optional catch all inbox that will receive emails sent to the domain that cannot be matched.
+    attr_accessor :catch_all_inbox_id
+
     attr_accessor :created_at
 
     # Unique token DKIM tokens
@@ -41,6 +44,7 @@ module MailSlurpClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'catch_all_inbox_id' => :'catchAllInboxId',
         :'created_at' => :'createdAt',
         :'dkim_tokens' => :'dkimTokens',
         :'domain' => :'domain',
@@ -56,6 +60,7 @@ module MailSlurpClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'catch_all_inbox_id' => :'String',
         :'created_at' => :'DateTime',
         :'dkim_tokens' => :'Array<String>',
         :'domain' => :'String',
@@ -89,6 +94,10 @@ module MailSlurpClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'catch_all_inbox_id')
+        self.catch_all_inbox_id = attributes[:'catch_all_inbox_id']
+      end
+
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       end
@@ -168,6 +177,7 @@ module MailSlurpClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          catch_all_inbox_id == o.catch_all_inbox_id &&
           created_at == o.created_at &&
           dkim_tokens == o.dkim_tokens &&
           domain == o.domain &&
@@ -188,7 +198,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [created_at, dkim_tokens, domain, domain_name_records, id, is_verified, updated_at, user_id, verification_token].hash
+      [catch_all_inbox_id, 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_preview.rb

@@ -15,6 +15,8 @@ require 'date'
 module MailSlurpClient
   # Preview object for domain entity
   class DomainPreview
+    attr_accessor :catch_all_inbox_id
+
     attr_accessor :created_at
 
     attr_accessor :domain
@@ -24,6 +26,7 @@ module MailSlurpClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'catch_all_inbox_id' => :'catchAllInboxId',
         :'created_at' => :'createdAt',
         :'domain' => :'domain',
         :'id' => :'id'
@@ -33,6 +36,7 @@ module MailSlurpClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'catch_all_inbox_id' => :'String',
         :'created_at' => :'DateTime',
         :'domain' => :'String',
         :'id' => :'String'
@@ -60,6 +64,10 @@ module MailSlurpClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'catch_all_inbox_id')
+        self.catch_all_inbox_id = attributes[:'catch_all_inbox_id']
+      end
+
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       end
@@ -106,6 +114,7 @@ module MailSlurpClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          catch_all_inbox_id == o.catch_all_inbox_id &&
           created_at == o.created_at &&
           domain == o.domain &&
           id == o.id
@@ -120,7 +129,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [created_at, domain, id].hash
+      [catch_all_inbox_id, created_at, domain, id].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/email_text_lines_result.rb

@@ -0,0 +1,228 @@
+=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
+  # Parsed text of an email
+  class EmailTextLinesResult
+    attr_accessor :body
+
+    attr_accessor :lines
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'body' => :'body',
+        :'lines' => :'lines'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'body' => :'String',
+        :'lines' => :'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::EmailTextLinesResult` 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::EmailTextLinesResult`. 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?(:'body')
+        self.body = attributes[:'body']
+      end
+
+      if attributes.key?(:'lines')
+        if (value = attributes[:'lines']).is_a?(Array)
+          self.lines = 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
+      if @body.nil?
+        invalid_properties.push('invalid value for "body", body cannot be nil.')
+      end
+
+      if @lines.nil?
+        invalid_properties.push('invalid value for "lines", lines 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 @body.nil?
+      return false if @lines.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 &&
+          body == o.body &&
+          lines == o.lines
+    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
+      [body, lines].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