mailslurp_client 15.8.1 → 15.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c57b9ba3a7c06a9bf126689e80920a1e0eae9be28a03bdea3b724cad4ab100f
-  data.tar.gz: 1290b7e2f2e09d23c22f1be518b6cad3299c473f0bb5abb6b8b455c59852a5be
+  metadata.gz: 8405ef6045794e6a9cc24dc15eb01813410bf4120aaec0f63b41d59c59097071
+  data.tar.gz: b20cef3856ade796cf813a54c318d3c1168bada7543d9eac88c0314e01e1b180
 SHA512:
-  metadata.gz: 9a3027477ae43a11e1298f6c06c69ca79ec9858732375c06b70b283d0ae4414f83367f7471ba3751c7842ff4b44aafb9c553344d6564cd65d220087639144cb6
-  data.tar.gz: ea9ae376f7209b22aa3c9cf54769ba16f15bda619ce2bb78e4a19f4b7b5bda04a804c8fef92114b6733327a1f323d0767eeb2cfd26aead8e1e1e0e89554d9f05
+  metadata.gz: d35ee5a2d41e2b48c77c42a8426dc1eaabb33259dc68cc9d51df09f324a9fa2b9ea3c787cea0804d485599c7b73f47f8d1ee3b30aa5c449412a76d1c60b3293c
+  data.tar.gz: c6b0deb8bc5645ee744fe674ccbe18cab4884697dc78a881d7834c7ee1cf7333d3746d4539a4504e3b83bced66f145cbef35b7af1523f164fb04dd579b5c901f

data/lib/mailslurp_client/api/attachment_controller_api.rb

@@ -378,8 +378,8 @@ module MailSlurpClient
     # Get email attachments
     # Get all attachments in paginated response. Each entity contains meta data for the attachment such as `name` and `content-type`. Use the `attachmentId` and the download endpoints to get the file contents.
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page Optional page index event list pagination (default to 0)
-    # @option opts [Integer] :size Optional page size event list pagination (default to 20)
+    # @option opts [Integer] :page Optional page index for list pagination (default to 0)
+    # @option opts [Integer] :size Optional page size for list pagination (default to 20)
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
     # @option opts [String] :file_name_filter Optional file name and content type search filter
     # @option opts [DateTime] :since Filter by created at after the given timestamp
@@ -393,8 +393,8 @@ module MailSlurpClient
     # Get email attachments
     # Get all attachments in paginated response. Each entity contains meta data for the attachment such as `name` and `content-type`. Use the `attachmentId` and the download endpoints to get the file contents.
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page Optional page index event list pagination
-    # @option opts [Integer] :size Optional page size event list pagination
+    # @option opts [Integer] :page Optional page index for list pagination
+    # @option opts [Integer] :size Optional page size for list pagination
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
     # @option opts [String] :file_name_filter Optional file name and content type search filter
     # @option opts [DateTime] :since Filter by created at after the given timestamp

data/lib/mailslurp_client/api/email_controller_api.rb

@@ -856,7 +856,7 @@ module MailSlurpClient
     end
 
     # Get email content as HTML. For displaying emails in browser context.
-    # Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: `?apiKey=xxx`
+    # Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: `?apiKey=xxx`. Returns content-type `text/html;charset=utf-8` so you must call expecting that content response not JSON. For JSON response see the `getEmailHTMLJson` method.
     # @param email_id [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :decode  (default to false)
@@ -867,7 +867,7 @@ module MailSlurpClient
     end
 
     # Get email content as HTML. For displaying emails in browser context.
-    # Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: `?apiKey=xxx`
+    # Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: `?apiKey=xxx`. Returns content-type `text/html;charset=utf-8` so you must call expecting that content response not JSON. For JSON response see the `getEmailHTMLJson` method.
     # @param email_id [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :decode 
@@ -890,7 +890,7 @@ module MailSlurpClient
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['text/html'])
+      header_params['Accept'] = @api_client.select_header_accept(['text/html;charset=utf-8', 'text/html'])
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -920,6 +920,71 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Get email content as HTML in JSON wrapper. For fetching entity decoded HTML content
+    # Retrieve email content as HTML response. Decodes quoted-printable entities and converts charset to UTF-8. Returns content-type `application/json;charset=utf-8` so you must call expecting that content response not JSON.
+    # @param email_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :decode  (default to false)
+    # @return [EmailHtmlDto]
+    def get_email_html_json(email_id, opts = {})
+      data, _status_code, _headers = get_email_html_json_with_http_info(email_id, opts)
+      data
+    end
+
+    # Get email content as HTML in JSON wrapper. For fetching entity decoded HTML content
+    # Retrieve email content as HTML response. Decodes quoted-printable entities and converts charset to UTF-8. Returns content-type `application/json;charset=utf-8` so you must call expecting that content response not JSON.
+    # @param email_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :decode 
+    # @return [Array<(EmailHtmlDto, Integer, Hash)>] EmailHtmlDto data, response status code and response headers
+    def get_email_html_json_with_http_info(email_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_html_json ...'
+      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 EmailControllerApi.get_email_html_json"
+      end
+      # resource path
+      local_var_path = '/emails/{emailId}/html/json'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'decode'] = opts[:'decode'] if !opts[:'decode'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['*/*'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'EmailHtmlDto' 
+
+      # 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: EmailControllerApi#get_email_html_json\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Parse and return text from an email, stripping HTML and decoding encoded characters
     # Parse an email body and return the content as an array of text. HTML parsing uses JSoup which supports JQuery/CSS style selectors
     # @param email_id [String] ID of email to perform HTML query on

data/lib/mailslurp_client/api/form_controller_api.rb

@@ -20,7 +20,7 @@ module MailSlurpClient
       @api_client = api_client
     end
     # Submit a form to be parsed and sent as an email to an address determined by the form fields
-    # This endpoint allows you to submit HTML forms and receive the field values and files via email.   #### Parameters The endpoint looks for special meta parameters in the form fields OR in the URL request parameters. The meta parameters can be used to specify the behaviour of the email.   You must provide at-least a `_to` email address to tell the endpoint where the form should be emailed. These can be submitted as hidden HTML input fields with the corresponding `name` attributes or as URL query parameters such as `?_to=test@example.com`  The endpoint takes all other form fields that are named and includes them in the message body of the email. Files are sent as attachments.  #### Submitting This endpoint accepts form submission via POST method. It accepts `application/x-www-form-urlencoded`, and `multipart/form-data` content-types.  #### HTML Example ```html <form    action=\"https://api.mailslurp.com/forms\"   method=\"post\" >   <input name=\"_to\" type=\"hidden\" value=\"test@example.com\"/>   <textarea name=\"feedback\"></textarea>   <button type=\"submit\">Submit</button> </form> ```  #### URL Example ```html <form    action=\"https://api.mailslurp.com/forms?_to=test@example.com\"   method=\"post\" >   <textarea name=\"feedback\"></textarea>   <button type=\"submit\">Submit</button> </form> ```    The email address is specified by a `_to` field OR is extracted from an email alias specified by a `_toAlias` field (see the alias controller for more information).  Endpoint accepts .  You can specify a content type in HTML forms using the `enctype` attribute, for instance: `<form enctype=\"multipart/form-data\">`.  
+    # This endpoint allows you to submit HTML forms and receive the field values and files via email.   #### Parameters The endpoint looks for special meta parameters in the form fields OR in the URL request parameters. The meta parameters can be used to specify the behaviour of the email.   You must provide at-least a `_to` email address to tell the endpoint where the form should be emailed. These can be submitted as hidden HTML input fields with the corresponding `name` attributes or as URL query parameters such as `?_to=test@example.com`  The endpoint takes all other form fields that are named and includes them in the message body of the email. Files are sent as attachments.  #### Submitting This endpoint accepts form submission via POST method. It accepts `application/x-www-form-urlencoded`, and `multipart/form-data` content-types.  #### HTML Example ```html <form    action=\"https://ruby.api.mailslurp.com/forms\"   method=\"post\" >   <input name=\"_to\" type=\"hidden\" value=\"test@example.com\"/>   <textarea name=\"feedback\"></textarea>   <button type=\"submit\">Submit</button> </form> ```  #### URL Example ```html <form    action=\"https://ruby.api.mailslurp.com/forms?_to=test@example.com\"   method=\"post\" >   <textarea name=\"feedback\"></textarea>   <button type=\"submit\">Submit</button> </form> ```    The email address is specified by a `_to` field OR is extracted from an email alias specified by a `_toAlias` field (see the alias controller for more information).  Endpoint accepts .  You can specify a content type in HTML forms using the `enctype` attribute, for instance: `<form enctype=\"multipart/form-data\">`.  
     # @param [Hash] opts the optional parameters
     # @option opts [String] :_to The email address that submitted form should be sent to.
     # @option opts [String] :_subject Optional subject of the email that will be sent.
@@ -36,7 +36,7 @@ module MailSlurpClient
     end
 
     # Submit a form to be parsed and sent as an email to an address determined by the form fields
-    # This endpoint allows you to submit HTML forms and receive the field values and files via email.   #### Parameters The endpoint looks for special meta parameters in the form fields OR in the URL request parameters. The meta parameters can be used to specify the behaviour of the email.   You must provide at-least a &#x60;_to&#x60; email address to tell the endpoint where the form should be emailed. These can be submitted as hidden HTML input fields with the corresponding &#x60;name&#x60; attributes or as URL query parameters such as &#x60;?_to&#x3D;test@example.com&#x60;  The endpoint takes all other form fields that are named and includes them in the message body of the email. Files are sent as attachments.  #### Submitting This endpoint accepts form submission via POST method. It accepts &#x60;application/x-www-form-urlencoded&#x60;, and &#x60;multipart/form-data&#x60; content-types.  #### HTML Example &#x60;&#x60;&#x60;html &lt;form    action&#x3D;\&quot;https://api.mailslurp.com/forms\&quot;   method&#x3D;\&quot;post\&quot; &gt;   &lt;input name&#x3D;\&quot;_to\&quot; type&#x3D;\&quot;hidden\&quot; value&#x3D;\&quot;test@example.com\&quot;/&gt;   &lt;textarea name&#x3D;\&quot;feedback\&quot;&gt;&lt;/textarea&gt;   &lt;button type&#x3D;\&quot;submit\&quot;&gt;Submit&lt;/button&gt; &lt;/form&gt; &#x60;&#x60;&#x60;  #### URL Example &#x60;&#x60;&#x60;html &lt;form    action&#x3D;\&quot;https://api.mailslurp.com/forms?_to&#x3D;test@example.com\&quot;   method&#x3D;\&quot;post\&quot; &gt;   &lt;textarea name&#x3D;\&quot;feedback\&quot;&gt;&lt;/textarea&gt;   &lt;button type&#x3D;\&quot;submit\&quot;&gt;Submit&lt;/button&gt; &lt;/form&gt; &#x60;&#x60;&#x60;    The email address is specified by a &#x60;_to&#x60; field OR is extracted from an email alias specified by a &#x60;_toAlias&#x60; field (see the alias controller for more information).  Endpoint accepts .  You can specify a content type in HTML forms using the &#x60;enctype&#x60; attribute, for instance: &#x60;&lt;form enctype&#x3D;\&quot;multipart/form-data\&quot;&gt;&#x60;.  
+    # This endpoint allows you to submit HTML forms and receive the field values and files via email.   #### Parameters The endpoint looks for special meta parameters in the form fields OR in the URL request parameters. The meta parameters can be used to specify the behaviour of the email.   You must provide at-least a &#x60;_to&#x60; email address to tell the endpoint where the form should be emailed. These can be submitted as hidden HTML input fields with the corresponding &#x60;name&#x60; attributes or as URL query parameters such as &#x60;?_to&#x3D;test@example.com&#x60;  The endpoint takes all other form fields that are named and includes them in the message body of the email. Files are sent as attachments.  #### Submitting This endpoint accepts form submission via POST method. It accepts &#x60;application/x-www-form-urlencoded&#x60;, and &#x60;multipart/form-data&#x60; content-types.  #### HTML Example &#x60;&#x60;&#x60;html &lt;form    action&#x3D;\&quot;https://ruby.api.mailslurp.com/forms\&quot;   method&#x3D;\&quot;post\&quot; &gt;   &lt;input name&#x3D;\&quot;_to\&quot; type&#x3D;\&quot;hidden\&quot; value&#x3D;\&quot;test@example.com\&quot;/&gt;   &lt;textarea name&#x3D;\&quot;feedback\&quot;&gt;&lt;/textarea&gt;   &lt;button type&#x3D;\&quot;submit\&quot;&gt;Submit&lt;/button&gt; &lt;/form&gt; &#x60;&#x60;&#x60;  #### URL Example &#x60;&#x60;&#x60;html &lt;form    action&#x3D;\&quot;https://ruby.api.mailslurp.com/forms?_to&#x3D;test@example.com\&quot;   method&#x3D;\&quot;post\&quot; &gt;   &lt;textarea name&#x3D;\&quot;feedback\&quot;&gt;&lt;/textarea&gt;   &lt;button type&#x3D;\&quot;submit\&quot;&gt;Submit&lt;/button&gt; &lt;/form&gt; &#x60;&#x60;&#x60;    The email address is specified by a &#x60;_to&#x60; field OR is extracted from an email alias specified by a &#x60;_toAlias&#x60; field (see the alias controller for more information).  Endpoint accepts .  You can specify a content type in HTML forms using the &#x60;enctype&#x60; attribute, for instance: &#x60;&lt;form enctype&#x3D;\&quot;multipart/form-data\&quot;&gt;&#x60;.  
     # @param [Hash] opts the optional parameters
     # @option opts [String] :_to The email address that submitted form should be sent to.
     # @option opts [String] :_subject Optional subject of the email that will be sent.

data/lib/mailslurp_client/api/inbox_controller_api.rb

@@ -1887,6 +1887,81 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Send email with queue
+    # Send an email using a queue. Will place the email onto a queue that will then be processed and sent. Use this queue method to enable any failed email sending to be recovered. This will prevent lost emails when sending if your account encounters a block or payment issue.
+    # @param inbox_id [String] ID of the inbox you want to send the email from
+    # @param validate_before_enqueue [Boolean] Validate before adding to queue
+    # @param send_email_options [SendEmailOptions] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def send_email_with_queue(inbox_id, validate_before_enqueue, send_email_options, opts = {})
+      send_email_with_queue_with_http_info(inbox_id, validate_before_enqueue, send_email_options, opts)
+      nil
+    end
+
+    # Send email with queue
+    # Send an email using a queue. Will place the email onto a queue that will then be processed and sent. Use this queue method to enable any failed email sending to be recovered. This will prevent lost emails when sending if your account encounters a block or payment issue.
+    # @param inbox_id [String] ID of the inbox you want to send the email from
+    # @param validate_before_enqueue [Boolean] Validate before adding to queue
+    # @param send_email_options [SendEmailOptions] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def send_email_with_queue_with_http_info(inbox_id, validate_before_enqueue, send_email_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxControllerApi.send_email_with_queue ...'
+      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.send_email_with_queue"
+      end
+      # verify the required parameter 'validate_before_enqueue' is set
+      if @api_client.config.client_side_validation && validate_before_enqueue.nil?
+        fail ArgumentError, "Missing the required parameter 'validate_before_enqueue' when calling InboxControllerApi.send_email_with_queue"
+      end
+      # verify the required parameter 'send_email_options' is set
+      if @api_client.config.client_side_validation && send_email_options.nil?
+        fail ArgumentError, "Missing the required parameter 'send_email_options' when calling InboxControllerApi.send_email_with_queue"
+      end
+      # resource path
+      local_var_path = '/inboxes/{inboxId}/with-queue'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'validateBeforeEnqueue'] = validate_before_enqueue
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(send_email_options) 
+
+      # return_type
+      return_type = opts[:return_type] 
+
+      # 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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: InboxControllerApi#send_email_with_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Send email using an SMTP mail envelope and message body and return sent confirmation
     # Send email using an SMTP envelope containing RCPT TO, MAIL FROM, and a SMTP BODY.
     # @param inbox_id [String] ID of the inbox you want to send the email from

data/lib/mailslurp_client/api/missed_email_controller_api.rb

@@ -180,6 +180,7 @@ module MailSlurpClient
     end
 
     # Get MissedEmail
+    # List emails that were missed due to plan limits.
     # @param missed_email_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [MissedEmail]
@@ -189,6 +190,7 @@ module MailSlurpClient
     end
 
     # Get MissedEmail
+    # List emails that were missed due to plan limits.
     # @param missed_email_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(MissedEmail, Integer, Hash)>] MissedEmail data, response status code and response headers
@@ -239,6 +241,60 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Restore missed emails
+    # If emails were missed due to a plan limit they are saved as missed emails. If support team enables the canRestore flag these emails can be reload into your account using this method.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def restore_missed_emails(opts = {})
+      restore_missed_emails_with_http_info(opts)
+      nil
+    end
+
+    # Restore missed emails
+    # If emails were missed due to a plan limit they are saved as missed emails. If support team enables the canRestore flag these emails can be reload into your account using this method.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def restore_missed_emails_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MissedEmailControllerApi.restore_missed_emails ...'
+      end
+      # resource path
+      local_var_path = '/missed-emails/restore'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] 
+
+      # 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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MissedEmailControllerApi#restore_missed_emails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Wait for Nth missed email
     # Wait for 0 based index missed email
     # @param index [Integer] Zero based index of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass index&#x3D;1