mailslurp_client 11.8.13 → 11.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11ebaabec4bbbf121b6a4e25953c0c9facd1eca5f287d13652d58e8e148857d3
-  data.tar.gz: 1b99f7d5e4dfc0079e8918051a83b7a32b81171dbd3eee85eaad1c9d4aa429ce
+  metadata.gz: a71ed75df545930dc62b3579bc134fa293d36c746fcd4471a738c1a2c1f29bcf
+  data.tar.gz: 416cd46b4cffb6f3a61fbd9fdc5543800c62670a68652621674ae450f5428daf
 SHA512:
-  metadata.gz: a3da7479cb4a1577644c0113c3f0a04eafe3153e57825ee87dab7a7197fbf5ff110ee6aaa94ce90dd66a878112fe2e7a98d3c138ebe86c31bedbee0cd0271343
-  data.tar.gz: e0ed6e71c82824d0b3d8e34b443f56f2e364c4aa16cd9b634442b51be529c02ea0e9adcfb8ad3b4748d3fc8d0a9059f6e1db16e46a63af18019ebaa3961a9e52
+  metadata.gz: '069aca4edc0db8dc46187d2796ba0a012b4f4c6ee6b684188147ebbf037ddab7362224db8512084cd13e4fe975aee83ec78c6bf897134ca265e276a9b1846cf5'
+  data.tar.gz: 0e65f158ed5b1bb606cf50b31736768109d836ceca535bee7552e038e8fcbca20aef2c6d06c21f78d64836b454a78559d72af3e6cb2af54c12eecf6c90591263

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 (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 (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/models/attachment_meta_data.rb

@@ -18,13 +18,13 @@ module MailSlurpClient
     # Size of attachment in bytes
     attr_accessor :content_length
 
-    # Content type of attachment
+    # Content type of attachment such as `image/png`
     attr_accessor :content_type
 
     # ID of attachment
     attr_accessor :id
 
-    # Name of attachment
+    # Name of attachment if given
     attr_accessor :name
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/mailslurp_client/models/download_attachment_dto.rb

@@ -15,13 +15,13 @@ require 'date'
 module MailSlurpClient
   # Content of attachment
   class DownloadAttachmentDto
-    # Base64 encoded string of attachment bytes. Decode the base64 string to get the raw file bytes
+    # Base64 encoded string of attachment bytes. Decode the base64 encoded string to get the raw contents. If the file has a content type such as `text/html` you can read the contents directly by converting it to string using `utf-8` encoding.
     attr_accessor :base64_file_contents
 
-    # Content type of attachment
+    # Content type of attachment. Examples are `image/png`, `application/msword`, `text/csv` etc.
     attr_accessor :content_type
 
-    # Size in bytes of attachment
+    # Size in bytes of attachment content
     attr_accessor :size_bytes
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/mailslurp_client/version.rb

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

metadata

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