mailslurp_client 8.2.4 → 8.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14c8172e82d0cc82bc46542483fb851b2777335c4eb54763a5468963faff7bd2
-  data.tar.gz: 8256fcef95c9dec144f7ab4b2e3e6ea16d624a3e19823f6d1f42b85b29510f02
+  metadata.gz: d43cd1bb1d8721e84b8b669cd5de147a6dfff0214b63ac5d7c6a65e54bc3138f
+  data.tar.gz: 48406a14cca23deea240502513a688b5d4e8986a369bfe8f829684ad663e28b8
 SHA512:
-  metadata.gz: 8318ee26eb26b2851e543c5e1391da15b0222f11a914625ee064dbfd0f96cca44514a90496b2cf9f5aafab0705a3268829ecb4c45c630bb5b54972d669706356
-  data.tar.gz: b1e5948a5e6edd68b2b4b24d4d922c5d2b1fe3f45183137e38be5f8a999c91ab2aecb5b749912f76abba22cb3f56a1edc56983069bc148963f5b902535353171
+  metadata.gz: 385962cfa9c007605b9a86960a4fd4b5156fe49f779187e0a28d9098b8b02967ded75affa329a04cc536c0f07b439a9581e61ca2ef54b24e667fa0319ba7b3b6
+  data.tar.gz: 96e637f3f737c2b516d55026c66cdd10341ca902cc79f18e756f607d691682973972062f266b76dc5bf0d6aa8b68c2c4d234ed6d1e5a241563db678ecc94ad43

data/README.md

@@ -13,11 +13,13 @@ MailSlurp is an email API service that lets you create real email addresses in c
 ## Get started
 
 ::: tip
+
 This section describes how to get up and running with the Ruby client.
 
 See the [examples page](https://www.mailslurp.com/examples/) for more examples and use with common frameworks such as Rails and RSpec.
 
 See the method documentation for a [list of all functions](./docs)
+
 :::
 
 ### Create API Key
@@ -169,7 +171,9 @@ expect(email.body).to include("Your email body")
 You can send attachments by first uploading files with the `AttachmentControllerApi` then using the returned attachment IDs in the send email method.
 
 ::: tip
+
 MailSlurp endpoints use base64 string encoding for upload and download files. To encode or decode strings in Ruby make sure you use the **strict** variables that avoid added newlines.
+
 :::
 
 #### Upload and send

data/lib/mailslurp_client/api/attachment_controller_api.rb

@@ -19,8 +19,8 @@ module MailSlurpClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     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.
+    # Upload an attachment for sending using base64 file encoding. Returns an array whose first element is the ID of the uploaded attachment.
+    # When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment IDs. For legacy reasons the ID is returned in an array. Only a single ID is ever returned at one time. 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
     # @param [Hash] opts the optional parameters
     # @return [Array<String>]
@@ -29,8 +29,8 @@ module MailSlurpClient
       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.
+    # Upload an attachment for sending using base64 file encoding. Returns an array whose first element is the ID of the uploaded attachment.
+    # When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment IDs. For legacy reasons the ID is returned in an array. Only a single ID is ever returned at one time. 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
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
@@ -83,26 +83,92 @@ module MailSlurpClient
       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.
+    # Upload an attachment for sending using file byte stream input octet stream. Returns an array whose first element is the ID of the uploaded attachment.
+    # When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment IDs. For legacy reasons the ID is returned in an array. Only a single ID is ever returned at one time. 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 [Hash] opts the optional parameters
+    # @option opts [String] :string Optional contentType for file. For instance &#x60;application/pdf&#x60;
+    # @option opts [String] :filename Optional filename to save upload with
+    # @option opts [String] :byte_array Byte array request body
+    # @return [Array<String>]
+    def upload_attachment_bytes(opts = {})
+      data, _status_code, _headers = upload_attachment_bytes_with_http_info(opts)
+      data
+    end
+
+    # Upload an attachment for sending using file byte stream input octet stream. Returns an array whose first element is the ID of the uploaded attachment.
+    # When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment IDs. For legacy reasons the ID is returned in an array. Only a single ID is ever returned at one time. 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 [Hash] opts the optional parameters
+    # @option opts [String] :string Optional contentType for file. For instance &#x60;application/pdf&#x60;
+    # @option opts [String] :filename Optional filename to save upload with
+    # @option opts [String] :byte_array Byte array request body
+    # @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
+    def upload_attachment_bytes_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AttachmentControllerApi.upload_attachment_bytes ...'
+      end
+      # resource path
+      local_var_path = '/attachments/bytes'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'String'] = opts[:'string'] if !opts[:'string'].nil?
+      query_params[:'filename'] = opts[:'filename'] if !opts[:'filename'].nil?
+
+      # header parameters
+      header_params = opts[: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/octet-stream'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(opts[:'byte_array']) 
+
+      # return_type
+      return_type = opts[:return_type] || 'Array<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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AttachmentControllerApi#upload_attachment_bytes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Upload an attachment for sending using a Multipart Form request. Returns an array whose first element is the ID of the uploaded attachment.
+    # When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment IDs. For legacy reasons the ID is returned in an array. Only a single ID is ever returned at one time. 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 file [File] file
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :content_type contentType
-    # @option opts [String] :filename filename
-    # @option opts [String] :x_filename x-filename
+    # @option opts [String] :content_type Optional content type of attachment
+    # @option opts [String] :filename Optional name of file
+    # @option opts [String] :x_filename Optional content type header of attachment
     # @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.
+    # Upload an attachment for sending using a Multipart Form request. Returns an array whose first element is the ID of the uploaded attachment.
+    # When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment IDs. For legacy reasons the ID is returned in an array. Only a single ID is ever returned at one time. 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 file [File] file
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :content_type contentType
-    # @option opts [String] :filename filename
-    # @option opts [String] :x_filename x-filename
+    # @option opts [String] :content_type Optional content type of attachment
+    # @option opts [String] :filename Optional name of file
+    # @option opts [String] :x_filename Optional content type header of attachment
     # @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
     def upload_multipart_form_with_http_info(file, opts = {})
       if @api_client.config.debugging

data/lib/mailslurp_client/api/email_controller_api.rb

@@ -75,7 +75,7 @@ module MailSlurpClient
 
     # Delete an email
     # Deletes an email and removes it from the inbox. Deleted emails cannot be recovered.
-    # @param email_id [String] emailId
+    # @param email_id [String] ID of email to delete
     # @param [Hash] opts the optional parameters
     # @return [nil]
     def delete_email(email_id, opts = {})
@@ -85,7 +85,7 @@ module MailSlurpClient
 
     # Delete an email
     # Deletes an email and removes it from the inbox. Deleted emails cannot be recovered.
-    # @param email_id [String] emailId
+    # @param email_id [String] ID of email to delete
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def delete_email_with_http_info(email_id, opts = {})
@@ -135,8 +135,8 @@ module MailSlurpClient
 
     # 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] attachmentId
-    # @param email_id [String] emailId
+    # @param attachment_id [String] ID of attachment
+    # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
     # @option opts [String] :api_key Can pass apiKey in url for this request if you wish to download the file in a browser. Content type will be set to original content type of the attachment file. This is so that browsers can download the file correctly.
     # @return [String]
@@ -147,8 +147,8 @@ module MailSlurpClient
 
     # 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] attachmentId
-    # @param email_id [String] emailId
+    # @param attachment_id [String] ID of attachment
+    # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
     # @option opts [String] :api_key Can pass apiKey in url for this request if you wish to download the file in a browser. Content type will be set to original content type of the attachment file. This is so that browsers can download the file correctly.
     # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
@@ -206,8 +206,8 @@ module MailSlurpClient
 
     # Get email attachment as base64 encoded string (alternative to binary responses)
     # 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] attachmentId
-    # @param email_id [String] emailId
+    # @param attachment_id [String] ID of attachment
+    # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
     # @return [DownloadAttachmentDto]
     def download_attachment_base64(attachment_id, email_id, opts = {})
@@ -217,8 +217,8 @@ module MailSlurpClient
 
     # Get email attachment as base64 encoded string (alternative to binary responses)
     # 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] attachmentId
-    # @param email_id [String] emailId
+    # @param attachment_id [String] ID of attachment
+    # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
     # @return [Array<(DownloadAttachmentDto, Integer, Hash)>] DownloadAttachmentDto data, response status code and response headers
     def download_attachment_base64_with_http_info(attachment_id, email_id, opts = {})
@@ -274,7 +274,7 @@ module MailSlurpClient
 
     # Forward email
     # Forward an existing email to new recipients.
-    # @param email_id [String] emailId
+    # @param email_id [String] ID of email
     # @param forward_email_options [ForwardEmailOptions] forwardEmailOptions
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -285,7 +285,7 @@ module MailSlurpClient
 
     # Forward email
     # Forward an existing email to new recipients.
-    # @param email_id [String] emailId
+    # @param email_id [String] ID of email
     # @param forward_email_options [ForwardEmailOptions] forwardEmailOptions
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -342,8 +342,8 @@ module MailSlurpClient
 
     # Get email attachment metadata
     # Returns the metadata such as name and content-type for a given attachment and email.
-    # @param attachment_id [String] attachmentId
-    # @param email_id [String] emailId
+    # @param attachment_id [String] ID of attachment
+    # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
     # @return [AttachmentMetaData]
     def get_attachment_meta_data(attachment_id, email_id, opts = {})
@@ -353,8 +353,8 @@ module MailSlurpClient
 
     # Get email attachment metadata
     # Returns the metadata such as name and content-type for a given attachment and email.
-    # @param attachment_id [String] attachmentId
-    # @param email_id [String] emailId
+    # @param attachment_id [String] ID of attachment
+    # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
     # @return [Array<(AttachmentMetaData, Integer, Hash)>] AttachmentMetaData data, response status code and response headers
     def get_attachment_meta_data_with_http_info(attachment_id, email_id, opts = {})
@@ -410,7 +410,7 @@ module MailSlurpClient
 
     # Get all email attachment metadata
     # Returns an array of attachment metadata such as name and content-type for a given email if present.
-    # @param email_id [String] emailId
+    # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
     # @return [Array<AttachmentMetaData>]
     def get_attachments(email_id, opts = {})
@@ -420,7 +420,7 @@ module MailSlurpClient
 
     # Get all email attachment metadata
     # Returns an array of attachment metadata such as name and content-type for a given email if present.
-    # @param email_id [String] emailId
+    # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<AttachmentMetaData>, Integer, Hash)>] Array<AttachmentMetaData> data, response status code and response headers
     def get_attachments_with_http_info(email_id, opts = {})
@@ -677,7 +677,7 @@ module MailSlurpClient
 
     # Get raw email string
     # 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] emailId
+    # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
     # @return [String]
     def get_raw_email_contents(email_id, opts = {})
@@ -687,7 +687,7 @@ module MailSlurpClient
 
     # Get raw email string
     # 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] emailId
+    # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
     # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
     def get_raw_email_contents_with_http_info(email_id, opts = {})
@@ -739,7 +739,7 @@ module MailSlurpClient
 
     # Get raw email in JSON
     # 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] emailId
+    # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
     # @return [RawEmailJson]
     def get_raw_email_json(email_id, opts = {})
@@ -749,7 +749,7 @@ module MailSlurpClient
 
     # Get raw email in JSON
     # 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] emailId
+    # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
     # @return [Array<(RawEmailJson, Integer, Hash)>] RawEmailJson data, response status code and response headers
     def get_raw_email_json_with_http_info(email_id, opts = {})
@@ -857,7 +857,7 @@ module MailSlurpClient
 
     # Validate email
     # Validate the HTML content of email if HTML is found. Considered valid if no HTML.
-    # @param email_id [String] emailId
+    # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
     # @return [ValidationDto]
     def validate_email(email_id, opts = {})
@@ -867,7 +867,7 @@ module MailSlurpClient
 
     # Validate email
     # Validate the HTML content of email if HTML is found. Considered valid if no HTML.
-    # @param email_id [String] emailId
+    # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
     # @return [Array<(ValidationDto, Integer, Hash)>] ValidationDto data, response status code and response headers
     def validate_email_with_http_info(email_id, opts = {})

data/lib/mailslurp_client/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 4.3.1
 =end
 
 module MailSlurpClient
-  VERSION = '8.2.4'
+  VERSION = '8.2.9'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailslurp_client
 version: !ruby/object:Gem::Version
-  version: 8.2.4
+  version: 8.2.9
 platform: ruby
 authors:
 - mailslurp