mailslurp_client 4.3.3 → 5.0.0

data/lib/mailslurp_client/api/extra_operations_api.rb

@@ -227,7 +227,7 @@ module MailSlurpClient
     # Attach a WebHook URL to an inbox
     # Get notified whenever an inbox receives an email via a WebHook URL. An emailID will be posted to this URL every time an email is received for this inbox. The URL must be publicly reachable by the MailSlurp server. You can provide basicAuth values if you wish to secure this endpoint.
     # @param inbox_id inboxId
-    # @param create_webhook_options options
+    # @param create_webhook_options webhookOptions
     # @param [Hash] opts the optional parameters
     # @return [Webhook]
     def create_webhook(inbox_id, create_webhook_options, opts = {})
@@ -238,7 +238,7 @@ module MailSlurpClient
     # Attach a WebHook URL to an inbox
     # Get notified whenever an inbox receives an email via a WebHook URL. An emailID will be posted to this URL every time an email is received for this inbox. The URL must be publicly reachable by the MailSlurp server. You can provide basicAuth values if you wish to secure this endpoint.
     # @param inbox_id inboxId
-    # @param create_webhook_options options
+    # @param create_webhook_options webhookOptions
     # @param [Hash] opts the optional parameters
     # @return [Array<(Webhook, Fixnum, Hash)>] Webhook data, response status code and response headers
     def create_webhook_with_http_info(inbox_id, create_webhook_options, opts = {})
@@ -290,8 +290,8 @@ module MailSlurpClient
     # @param email_id emailId
     # @param [Hash] opts the optional parameters
     # @return [nil]
-    def delete_email(email_id, opts = {})
-      delete_email_with_http_info(email_id, opts)
+    def delete_email1(email_id, opts = {})
+      delete_email1_with_http_info(email_id, opts)
       nil
     end
 
@@ -300,13 +300,13 @@ module MailSlurpClient
     # @param email_id emailId
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def delete_email_with_http_info(email_id, opts = {})
+    def delete_email1_with_http_info(email_id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: ExtraOperationsApi.delete_email ...'
+        @api_client.config.logger.debug 'Calling API: ExtraOperationsApi.delete_email1 ...'
       end
       # verify the required parameter 'email_id' is set
       if @api_client.config.client_side_validation && email_id.nil?
-        fail ArgumentError, "Missing the required parameter 'email_id' when calling ExtraOperationsApi.delete_email"
+        fail ArgumentError, "Missing the required parameter 'email_id' when calling ExtraOperationsApi.delete_email1"
       end
       # resource path
       local_var_path = '/emails/{emailId}'.sub('{' + 'emailId' + '}', email_id.to_s)
@@ -330,7 +330,7 @@ module MailSlurpClient
         :body => post_body,
         :auth_names => auth_names)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: ExtraOperationsApi#delete_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: ExtraOperationsApi#delete_email1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
@@ -495,6 +495,64 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Forward Email
+    # Forward email content to given recipients
+    # @param email_id emailId
+    # @param forward_email_options forwardEmailOptions
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def forward_email(email_id, forward_email_options, opts = {})
+      forward_email_with_http_info(email_id, forward_email_options, opts)
+      nil
+    end
+
+    # Forward Email
+    # Forward email content to given recipients
+    # @param email_id emailId
+    # @param forward_email_options forwardEmailOptions
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def forward_email_with_http_info(email_id, forward_email_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ExtraOperationsApi.forward_email ...'
+      end
+      # verify the required parameter 'email_id' is set
+      if @api_client.config.client_side_validation && email_id.nil?
+        fail ArgumentError, "Missing the required parameter 'email_id' when calling ExtraOperationsApi.forward_email"
+      end
+      # verify the required parameter 'forward_email_options' is set
+      if @api_client.config.client_side_validation && forward_email_options.nil?
+        fail ArgumentError, "Missing the required parameter 'forward_email_options' when calling ExtraOperationsApi.forward_email"
+      end
+      # resource path
+      local_var_path = '/emails/{emailId}/forward'.sub('{' + 'emailId' + '}', email_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(forward_email_options)
+      auth_names = ['API_KEY']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ExtraOperationsApi#forward_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get Email Content
     # Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawMessage endpoint
     # @param email_id emailId
@@ -875,5 +933,122 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Upload an attachment for sending
+    # When sending emails with attachments first upload each attachment with this endpoint. Record the returned attachment IDs. Then use these attachment IDs in the SendEmailOptions when sending an email. This means that attachments can easily be reused.
+    # @param upload_attachment_options uploadOptions
+    # @param [Hash] opts the optional parameters
+    # @return [Array<String>]
+    def upload_attachment(upload_attachment_options, opts = {})
+      data, _status_code, _headers = upload_attachment_with_http_info(upload_attachment_options, opts)
+      data
+    end
+
+    # Upload an attachment for sending
+    # When sending emails with attachments first upload each attachment with this endpoint. Record the returned attachment IDs. Then use these attachment IDs in the SendEmailOptions when sending an email. This means that attachments can easily be reused.
+    # @param upload_attachment_options uploadOptions
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<String>, Fixnum, Hash)>] Array<String> data, response status code and response headers
+    def upload_attachment_with_http_info(upload_attachment_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ExtraOperationsApi.upload_attachment ...'
+      end
+      # verify the required parameter 'upload_attachment_options' is set
+      if @api_client.config.client_side_validation && upload_attachment_options.nil?
+        fail ArgumentError, "Missing the required parameter 'upload_attachment_options' when calling ExtraOperationsApi.upload_attachment"
+      end
+      # resource path
+      local_var_path = '/attachments'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(upload_attachment_options)
+      auth_names = ['API_KEY']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Array<String>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ExtraOperationsApi#upload_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Upload an attachment for sending using Multipart Form
+    # When sending emails with attachments first upload each attachment with this endpoint. Record the returned attachment IDs. Then use these attachment IDs in the SendEmailOptions when sending an email. This means that attachments can easily be reused.
+    # @param file file
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :content_type contentType
+    # @option opts [String] :filename filename
+    # @return [Array<String>]
+    def upload_multipart_form(file, opts = {})
+      data, _status_code, _headers = upload_multipart_form_with_http_info(file, opts)
+      data
+    end
+
+    # Upload an attachment for sending using Multipart Form
+    # When sending emails with attachments first upload each attachment with this endpoint. Record the returned attachment IDs. Then use these attachment IDs in the SendEmailOptions when sending an email. This means that attachments can easily be reused.
+    # @param file file
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :content_type contentType
+    # @option opts [String] :filename filename
+    # @return [Array<(Array<String>, Fixnum, Hash)>] Array<String> data, response status code and response headers
+    def upload_multipart_form_with_http_info(file, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ExtraOperationsApi.upload_multipart_form ...'
+      end
+      # verify the required parameter 'file' is set
+      if @api_client.config.client_side_validation && file.nil?
+        fail ArgumentError, "Missing the required parameter 'file' when calling ExtraOperationsApi.upload_multipart_form"
+      end
+      # resource path
+      local_var_path = '/attachments/multipart'
+
+      # query parameters
+      query_params = {}
+      query_params[:'contentType'] = opts[:'content_type'] if !opts[:'content_type'].nil?
+      query_params[:'filename'] = opts[:'filename'] if !opts[:'filename'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
+
+      # form parameters
+      form_params = {}
+      form_params['file'] = file
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['API_KEY']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Array<String>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ExtraOperationsApi#upload_multipart_form\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
   end
 end

data/lib/mailslurp_client/models/email.rb

@@ -25,12 +25,16 @@ module MailSlurpClient
 
     attr_accessor :cc
 
+    attr_accessor :charset
+
     attr_accessor :created_at
 
     attr_accessor :from
 
     attr_accessor :headers
 
+    attr_accessor :html
+
     attr_accessor :id
 
     attr_accessor :inbox_id
@@ -53,9 +57,11 @@ module MailSlurpClient
         :'bcc' => :'bcc',
         :'body' => :'body',
         :'cc' => :'cc',
+        :'charset' => :'charset',
         :'created_at' => :'createdAt',
         :'from' => :'from',
         :'headers' => :'headers',
+        :'html' => :'html',
         :'id' => :'id',
         :'inbox_id' => :'inboxId',
         :'raw_url' => :'rawUrl',
@@ -74,9 +80,11 @@ module MailSlurpClient
         :'bcc' => :'Array<String>',
         :'body' => :'String',
         :'cc' => :'Array<String>',
+        :'charset' => :'String',
         :'created_at' => :'DateTime',
         :'from' => :'String',
         :'headers' => :'Hash<String, String>',
+        :'html' => :'BOOLEAN',
         :'id' => :'String',
         :'inbox_id' => :'String',
         :'raw_url' => :'String',
@@ -121,6 +129,10 @@ module MailSlurpClient
         end
       end
 
+      if attributes.has_key?(:'charset')
+        self.charset = attributes[:'charset']
+      end
+
       if attributes.has_key?(:'createdAt')
         self.created_at = attributes[:'createdAt']
       end
@@ -135,6 +147,10 @@ module MailSlurpClient
         end
       end
 
+      if attributes.has_key?(:'html')
+        self.html = attributes[:'html']
+      end
+
       if attributes.has_key?(:'id')
         self.id = attributes[:'id']
       end
@@ -219,9 +235,11 @@ module MailSlurpClient
           bcc == o.bcc &&
           body == o.body &&
           cc == o.cc &&
+          charset == o.charset &&
           created_at == o.created_at &&
           from == o.from &&
           headers == o.headers &&
+          html == o.html &&
           id == o.id &&
           inbox_id == o.inbox_id &&
           raw_url == o.raw_url &&
@@ -240,7 +258,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [analysis, attachments, bcc, body, cc, created_at, from, headers, id, inbox_id, raw_url, subject, to, updated_at, user_id].hash
+      [analysis, attachments, bcc, body, cc, charset, created_at, from, headers, html, id, inbox_id, raw_url, subject, to, updated_at, user_id].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/email_preview.rb

@@ -15,23 +15,39 @@ require 'date'
 module MailSlurpClient
   # Preview of an email message. For full message call the message endpoint with a given message id.
   class EmailPreview
+    attr_accessor :bcc
+
+    attr_accessor :cc
+
     attr_accessor :created
 
     attr_accessor :id
 
+    attr_accessor :subject
+
+    attr_accessor :to
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'bcc' => :'bcc',
+        :'cc' => :'cc',
         :'created' => :'created',
-        :'id' => :'id'
+        :'id' => :'id',
+        :'subject' => :'subject',
+        :'to' => :'to'
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'bcc' => :'Array<String>',
+        :'cc' => :'Array<String>',
         :'created' => :'DateTime',
-        :'id' => :'String'
+        :'id' => :'String',
+        :'subject' => :'String',
+        :'to' => :'Array<String>'
       }
     end
 
@@ -43,6 +59,18 @@ module MailSlurpClient
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
+      if attributes.has_key?(:'bcc')
+        if (value = attributes[:'bcc']).is_a?(Array)
+          self.bcc = value
+        end
+      end
+
+      if attributes.has_key?(:'cc')
+        if (value = attributes[:'cc']).is_a?(Array)
+          self.cc = value
+        end
+      end
+
       if attributes.has_key?(:'created')
         self.created = attributes[:'created']
       end
@@ -50,6 +78,16 @@ module MailSlurpClient
       if attributes.has_key?(:'id')
         self.id = attributes[:'id']
       end
+
+      if attributes.has_key?(:'subject')
+        self.subject = attributes[:'subject']
+      end
+
+      if attributes.has_key?(:'to')
+        if (value = attributes[:'to']).is_a?(Array)
+          self.to = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -64,6 +102,10 @@ module MailSlurpClient
         invalid_properties.push('invalid value for "id", id cannot be nil.')
       end
 
+      if @to.nil?
+        invalid_properties.push('invalid value for "to", to cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -72,6 +114,7 @@ module MailSlurpClient
     def valid?
       return false if @created.nil?
       return false if @id.nil?
+      return false if @to.nil?
       true
     end
 
@@ -80,8 +123,12 @@ module MailSlurpClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          bcc == o.bcc &&
+          cc == o.cc &&
           created == o.created &&
-          id == o.id
+          id == o.id &&
+          subject == o.subject &&
+          to == o.to
     end
 
     # @see the `==` method
@@ -93,7 +140,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [created, id].hash
+      [bcc, cc, created, id, subject, to].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/forward_email_options.rb

@@ -0,0 +1,222 @@
+=begin
+#MailSlurp API
+
+#For documentation see [developer guide](https://www.mailslurp.com/developers). [Create an account](https://app.mailslurp.com) in the MailSlurp Dashboard to [view your API Key](https://app). For all bugs, feature requests, or help please [see support](https://www.mailslurp.com/support/).
+
+OpenAPI spec version: 0.0.1-alpha
+Contact: contact@mailslurp.dev
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.4
+
+=end
+
+require 'date'
+
+module MailSlurpClient
+  # Options for forwarding an email
+  class ForwardEmailOptions
+    attr_accessor :to
+
+    attr_accessor :subject
+
+    attr_accessor :cc
+
+    attr_accessor :bcc
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'to' => :'to',
+        :'subject' => :'subject',
+        :'cc' => :'cc',
+        :'bcc' => :'bcc'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'to' => :'Array<String>',
+        :'subject' => :'String',
+        :'cc' => :'Array<String>',
+        :'bcc' => :'Array<String>'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'to')
+        if (value = attributes[:'to']).is_a?(Array)
+          self.to = value
+        end
+      end
+
+      if attributes.has_key?(:'subject')
+        self.subject = attributes[:'subject']
+      end
+
+      if attributes.has_key?(:'cc')
+        if (value = attributes[:'cc']).is_a?(Array)
+          self.cc = value
+        end
+      end
+
+      if attributes.has_key?(:'bcc')
+        if (value = attributes[:'bcc']).is_a?(Array)
+          self.bcc = 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 @to.nil?
+        invalid_properties.push('invalid value for "to", to 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 @to.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 &&
+          to == o.to &&
+          subject == o.subject &&
+          cc == o.cc &&
+          bcc == o.bcc
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [to, subject, cc, bcc].hash
+    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 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
+        temp_model = MailSlurpClient.const_get(type).new
+        temp_model.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)
+        next if value.nil?
+        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