mailslurp_client 11.8.10 → 11.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5eca84e79eeb7cb5a559aa0ebb92571fb47752d127c972fbb5d8a6aff88eb6e
-  data.tar.gz: 7c45ad0ce22634eaab042e549f4edba04e9d73991d7731d2b6215da1b4ee0b72
+  metadata.gz: 5a7170ea201d4a298ba5b6b0849e258ae06e38805e56882f7b478debd341745d
+  data.tar.gz: 5fe4ccf57eaf5e65a1291b3c0714c094e512c6d1599f6190ad4dae787b86c845
 SHA512:
-  metadata.gz: 5b05ad66eadbf8e2a5534381ddd139498e120e56f551630bfb0ae7a43fe24075df48fb2831c75d341f5d9cf85637827ee54f7ce607050c78fcbe77ce36f9eba7
-  data.tar.gz: d87ae4b06cf93ba9d451cf10c49958e85946bdad1cb36babd6df380e88c904bbc9d2c4ea715839d3a506fb3c5427a81f12f4bf90d2bf38906119f07836eb2308
+  metadata.gz: d8e43add6138188ae58691f6c8607e2c2a91efd2308579918473d12a912ac6f34d482dd2786daa21b840880774d2fe75cec5f99583742cddc6d84fa2d5fe4442
+  data.tar.gz: edcc020a32184faf3452069aeb18df5be485d7ff366a007ccc85b511e0cf9dea5510d9e2da72edbecc7afc1293e5bfd45b9751ef3732396957870d51660ccfb2

data/lib/mailslurp_client.rb

@@ -104,6 +104,7 @@ require 'mailslurp_client/models/validation_message'
 require 'mailslurp_client/models/verify_email_address_options'
 require 'mailslurp_client/models/wait_for_conditions'
 require 'mailslurp_client/models/webhook_dto'
+require 'mailslurp_client/models/webhook_payload'
 require 'mailslurp_client/models/webhook_projection'
 require 'mailslurp_client/models/webhook_test_request'
 require 'mailslurp_client/models/webhook_test_response'

data/lib/mailslurp_client/api/attachment_controller_api.rb

@@ -19,6 +19,192 @@ module MailSlurpClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Get email attachment as base64 encoded string as alternative to binary responses. To read the content decode the Base64 encoded contents.
+    # Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the `downloadAttachment` method but allows some clients to get around issues with binary responses.
+    # @param attachment_id [String] ID of attachment
+    # @param [Hash] opts the optional parameters
+    # @return [DownloadAttachmentDto]
+    def download_attachment_as_base64_encoded(attachment_id, opts = {})
+      data, _status_code, _headers = download_attachment_as_base64_encoded_with_http_info(attachment_id, opts)
+      data
+    end
+
+    # Get email attachment as base64 encoded string as alternative to binary responses. To read the content decode the Base64 encoded contents.
+    # Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the `downloadAttachment` method but allows some clients to get around issues with binary responses.
+    # @param attachment_id [String] ID of attachment
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DownloadAttachmentDto, Integer, Hash)>] DownloadAttachmentDto data, response status code and response headers
+    def download_attachment_as_base64_encoded_with_http_info(attachment_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AttachmentControllerApi.download_attachment_as_base64_encoded ...'
+      end
+      # verify the required parameter 'attachment_id' is set
+      if @api_client.config.client_side_validation && attachment_id.nil?
+        fail ArgumentError, "Missing the required parameter 'attachment_id' when calling AttachmentControllerApi.download_attachment_as_base64_encoded"
+      end
+      # resource path
+      local_var_path = '/attachments/{attachmentId}/base64'.sub('{' + 'attachmentId' + '}', CGI.escape(attachment_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] || 'DownloadAttachmentDto' 
+
+      # 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: AttachmentControllerApi#download_attachment_as_base64_encoded\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Download attachments. Get email attachment bytes. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints.
+    # Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream.
+    # @param attachment_id [String] ID of attachment
+    # @param [Hash] opts the optional parameters
+    # @return [String]
+    def download_attachment_as_bytes(attachment_id, opts = {})
+      data, _status_code, _headers = download_attachment_as_bytes_with_http_info(attachment_id, opts)
+      data
+    end
+
+    # Download attachments. Get email attachment bytes. If you have trouble with byte responses try the &#x60;downloadAttachmentBase64&#x60; response endpoints.
+    # Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream.
+    # @param attachment_id [String] ID of attachment
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
+    def download_attachment_as_bytes_with_http_info(attachment_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AttachmentControllerApi.download_attachment_as_bytes ...'
+      end
+      # verify the required parameter 'attachment_id' is set
+      if @api_client.config.client_side_validation && attachment_id.nil?
+        fail ArgumentError, "Missing the required parameter 'attachment_id' when calling AttachmentControllerApi.download_attachment_as_bytes"
+      end
+      # resource path
+      local_var_path = '/attachments/{attachmentId}/bytes'.sub('{' + 'attachmentId' + '}', CGI.escape(attachment_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/octet-stream'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'String' 
+
+      # 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: AttachmentControllerApi#download_attachment_as_bytes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get email attachment metadata information
+    # Returns the metadata for an attachment. It is saved separately to the content of the attachment. Contains properties `name` and `content-type` and `content-length` in bytes for a given attachment.
+    # @param attachment_id [String] ID of attachment
+    # @param [Hash] opts the optional parameters
+    # @return [AttachmentMetaData]
+    def get_attachment_info(attachment_id, opts = {})
+      data, _status_code, _headers = get_attachment_info_with_http_info(attachment_id, opts)
+      data
+    end
+
+    # Get email attachment metadata information
+    # Returns the metadata for an attachment. It is saved separately to the content of the attachment. Contains properties &#x60;name&#x60; and &#x60;content-type&#x60; and &#x60;content-length&#x60; in bytes for a given attachment.
+    # @param attachment_id [String] ID of attachment
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AttachmentMetaData, Integer, Hash)>] AttachmentMetaData data, response status code and response headers
+    def get_attachment_info_with_http_info(attachment_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AttachmentControllerApi.get_attachment_info ...'
+      end
+      # verify the required parameter 'attachment_id' is set
+      if @api_client.config.client_side_validation && attachment_id.nil?
+        fail ArgumentError, "Missing the required parameter 'attachment_id' when calling AttachmentControllerApi.get_attachment_info"
+      end
+      # resource path
+      local_var_path = '/attachments/{attachmentId}/metadata'.sub('{' + 'attachmentId' + '}', CGI.escape(attachment_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] || 'AttachmentMetaData' 
+
+      # 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: AttachmentControllerApi#get_attachment_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Upload an attachment for sending using base64 file encoding. Returns an array whose first element is the ID of the uploaded attachment.
     # Email attachments are essentially files with meta data. Files are byte arrays and the meta data is a content type and a filename. These properties allow email clients to display the filename and icon etc. When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment ID and use it with subsequent email sending. For legacy reasons the ID is returned as the first element in an array. Only a single ID is ever returned. To send the attachments pass a list of attachment IDs with `SendEmailOptions` when sending an email. Using the upload endpoints prior to sending mean attachments can easily be reused.
     # @param upload_options [UploadAttachmentOptions] uploadOptions

data/lib/mailslurp_client/api/email_controller_api.rb

@@ -19,7 +19,7 @@ module MailSlurpClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Delete all emails
+    # Delete all emails in all inboxes.
     # Deletes all emails in your account. Be careful as emails cannot be recovered
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -28,7 +28,7 @@ module MailSlurpClient
       nil
     end
 
-    # Delete all emails
+    # Delete all emails in all inboxes.
     # Deletes all emails in your account. Be careful as emails cannot be recovered
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -133,7 +133,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get email attachment bytes. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints.
+    # Get email attachment bytes. Returned as `octet-stream` with content type header. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints and convert the base 64 encoded content to a file or string.
     # Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream.
     # @param attachment_id [String] ID of attachment
     # @param email_id [String] ID of email
@@ -145,7 +145,7 @@ module MailSlurpClient
       data
     end
 
-    # Get email attachment bytes. If you have trouble with byte responses try the &#x60;downloadAttachmentBase64&#x60; response endpoints.
+    # Get email attachment bytes. Returned as &#x60;octet-stream&#x60; with content type header. If you have trouble with byte responses try the &#x60;downloadAttachmentBase64&#x60; response endpoints and convert the base 64 encoded content to a file or string.
     # Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream.
     # @param attachment_id [String] ID of attachment
     # @param email_id [String] ID of email
@@ -204,7 +204,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get email attachment as base64 encoded string (alternative to binary responses)
+    # Get email attachment as base64 encoded string alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`.
     # Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the `downloadAttachment` method but allows some clients to get around issues with binary responses.
     # @param attachment_id [String] ID of attachment
     # @param email_id [String] ID of email
@@ -215,7 +215,7 @@ module MailSlurpClient
       data
     end
 
-    # Get email attachment as base64 encoded string (alternative to binary responses)
+    # Get email attachment as base64 encoded string alternative to binary responses. Decode the &#x60;base64FileContents&#x60; as a &#x60;utf-8&#x60; encoded string or array of bytes depending on the &#x60;contentType&#x60;.
     # Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the &#x60;downloadAttachment&#x60; method but allows some clients to get around issues with binary responses.
     # @param attachment_id [String] ID of attachment
     # @param email_id [String] ID of email
@@ -272,7 +272,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Forward email
+    # Forward email to recipients
     # Forward an existing email to new recipients.
     # @param email_id [String] ID of email
     # @param forward_email_options [ForwardEmailOptions] forwardEmailOptions
@@ -283,7 +283,7 @@ module MailSlurpClient
       nil
     end
 
-    # Forward email
+    # Forward email to recipients
     # Forward an existing email to new recipients.
     # @param email_id [String] ID of email
     # @param forward_email_options [ForwardEmailOptions] forwardEmailOptions
@@ -340,7 +340,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get email attachment metadata
+    # Get email attachment metadata. This is the `contentType` and `contentLength` of an attachment. To get the individual attachments  use the `downloadAttachment` methods.
     # Returns the metadata such as name and content-type for a given attachment and email.
     # @param attachment_id [String] ID of attachment
     # @param email_id [String] ID of email
@@ -351,7 +351,7 @@ module MailSlurpClient
       data
     end
 
-    # Get email attachment metadata
+    # Get email attachment metadata. This is the &#x60;contentType&#x60; and &#x60;contentLength&#x60; of an attachment. To get the individual attachments  use the &#x60;downloadAttachment&#x60; methods.
     # Returns the metadata such as name and content-type for a given attachment and email.
     # @param attachment_id [String] ID of attachment
     # @param email_id [String] ID of email
@@ -408,7 +408,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get all email attachment metadata
+    # Get all email attachment metadata. Metadata includes name and attachment size.
     # Returns an array of attachment metadata such as name and content-type for a given email if present.
     # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
@@ -418,7 +418,7 @@ module MailSlurpClient
       data
     end
 
-    # Get all email attachment metadata
+    # Get all email attachment metadata. Metadata includes name and attachment size.
     # Returns an array of attachment metadata such as name and content-type for a given email if present.
     # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
@@ -605,7 +605,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get email content as HTML
+    # 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`
     # @param email_id [String] emailId
     # @param [Hash] opts the optional parameters
@@ -616,7 +616,7 @@ module MailSlurpClient
       data
     end
 
-    # Get email content as HTML
+    # 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: &#x60;?apiKey&#x3D;xxx&#x60;
     # @param email_id [String] emailId
     # @param [Hash] opts the optional parameters
@@ -803,7 +803,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get all emails
+    # Get all emails in all inboxes. Email API list all.
     # By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :inbox_id Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
@@ -817,7 +817,7 @@ module MailSlurpClient
       data
     end
 
-    # Get all emails
+    # Get all emails in all inboxes. Email API list all.
     # By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :inbox_id Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
@@ -878,7 +878,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get latest email
+    # Get latest email in all inboxes. Most recently received.
     # Get the newest email in all inboxes or in a passed set of inbox IDs
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :inbox_ids Optional set of inboxes to filter by. Only get the latest email from these inbox IDs
@@ -888,7 +888,7 @@ module MailSlurpClient
       data
     end
 
-    # Get latest email
+    # Get latest email in all inboxes. Most recently received.
     # Get the newest email in all inboxes or in a passed set of inbox IDs
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :inbox_ids Optional set of inboxes to filter by. Only get the latest email from these inbox IDs
@@ -937,7 +937,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get latest email
+    # Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet.
     # Get the newest email in all inboxes or in a passed set of inbox IDs
     # @param [Hash] opts the optional parameters
     # @option opts [String] :inbox_id ID of the inbox you want to get the latest email from
@@ -947,7 +947,7 @@ module MailSlurpClient
       data
     end
 
-    # Get latest email
+    # Get latest email in an inbox. Use &#x60;WaitForController&#x60; to get emails that may not have arrived yet.
     # Get the newest email in all inboxes or in a passed set of inbox IDs
     # @param [Hash] opts the optional parameters
     # @option opts [String] :inbox_id ID of the inbox you want to get the latest email from
@@ -996,7 +996,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get all organization emails
+    # Get all organization emails. List team or shared test email accounts
     # By default returns all emails across all team inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :inbox_id Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
@@ -1010,7 +1010,7 @@ module MailSlurpClient
       data
     end
 
-    # Get all organization emails
+    # Get all organization emails. List team or shared test email accounts
     # By default returns all emails across all team inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :inbox_id Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
@@ -1071,7 +1071,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get raw email string
+    # Get raw email string. Returns unparsed raw SMTP message with headers and body.
     # Returns a raw, unparsed, and unprocessed email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawEmailJson endpoint
     # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
@@ -1081,7 +1081,7 @@ module MailSlurpClient
       data
     end
 
-    # Get raw email string
+    # Get raw email string. Returns unparsed raw SMTP message with headers and body.
     # Returns a raw, unparsed, and unprocessed email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawEmailJson endpoint
     # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
@@ -1133,7 +1133,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get raw email in JSON
+    # Get raw email in JSON. Unparsed SMTP message in JSON wrapper format.
     # Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response
     # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
@@ -1143,7 +1143,7 @@ module MailSlurpClient
       data
     end
 
-    # Get raw email in JSON
+    # Get raw email in JSON. Unparsed SMTP message in JSON wrapper format.
     # Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response
     # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
@@ -1196,7 +1196,7 @@ module MailSlurpClient
     end
 
     # Get unread email count
-    # Get number of emails unread
+    # Get number of emails unread. Unread means has not been viewed in dashboard or returned in an email API response
     # @param [Hash] opts the optional parameters
     # @return [UnreadCount]
     def get_unread_email_count(opts = {})
@@ -1205,7 +1205,7 @@ module MailSlurpClient
     end
 
     # Get unread email count
-    # Get number of emails unread
+    # Get number of emails unread. Unread means has not been viewed in dashboard or returned in an email API response
     # @param [Hash] opts the optional parameters
     # @return [Array<(UnreadCount, Integer, Hash)>] UnreadCount data, response status code and response headers
     def get_unread_email_count_with_http_info(opts = {})
@@ -1321,7 +1321,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Validate email
+    # Validate email HTML contents
     # Validate the HTML content of email if HTML is found. Considered valid if no HTML.
     # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
@@ -1331,7 +1331,7 @@ module MailSlurpClient
       data
     end
 
-    # Validate email
+    # Validate email HTML contents
     # Validate the HTML content of email if HTML is found. Considered valid if no HTML.
     # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters