mailslurp_client 8.0.21 → 8.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 914601eec3611189343e0f7444c941b54de75231c9153c6400e48b8b179680e3
-  data.tar.gz: 5b004de15214282e37892dc3d8fac888d10b1e458bf9a7ac084abf352138bf7a
+  metadata.gz: 36ce41a5fe3eceb494c8afd8a919e2f5de8fcf5d6df42eea3ee221e4567ab428
+  data.tar.gz: 475f30343f6b85b51a55dec7531bd4bcfe83441f729fbf18d886d36106c2164b
 SHA512:
-  metadata.gz: 2b6c1300aa05e68cfd82913439816503fec19d0ce5ba3494be5afe6e370169a961a6564d7d8eb79860d673812748944f306d0fa5ac9d7f2bdd525ba672a88af5
-  data.tar.gz: e3618def0d458006b241347d1462810640929847507c719c716047077659e0ebb7eccf22e8b91c29996f89e8025db1775f5bad894e1e8171d04a96c927fcc09a
+  metadata.gz: a62a060b64eee4163154b284d0ad61d00dfbdd07f6e07e2f5bca58080334f2e6c615b8280abbe1335289ee716fa73ca59d6ee6e2aab37c39bc84d9cc302181b4
+  data.tar.gz: c5dd378fa61330c8a38df16ec2f773ea42c2f34caff69d9a760e42c57bc69b2f18f699405b7e09f44443a524bb46d97c5fa9c5a1ce5e22b30a9efeccf06c48fe

data/lib/mailslurp_client.rb

@@ -33,6 +33,7 @@ require 'mailslurp_client/models/describe_domain_options'
 require 'mailslurp_client/models/describe_mail_server_domain_result'
 require 'mailslurp_client/models/domain_dto'
 require 'mailslurp_client/models/domain_preview'
+require 'mailslurp_client/models/download_attachment_dto'
 require 'mailslurp_client/models/email'
 require 'mailslurp_client/models/email_analysis'
 require 'mailslurp_client/models/email_preview'

data/lib/mailslurp_client/api/email_controller_api.rb

@@ -133,24 +133,24 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get email attachment bytes
-    # Returns the specified attachment for a given email as a byte stream (file download). You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream.
+    # 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 [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
+    # @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]
     def download_attachment(attachment_id, email_id, opts = {})
       data, _status_code, _headers = download_attachment_with_http_info(attachment_id, email_id, opts)
       data
     end
 
-    # Get email attachment bytes
-    # Returns the specified attachment for a given email as a byte stream (file download). You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream.
+    # 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 [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
+    # @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
     def download_attachment_with_http_info(attachment_id, email_id, opts = {})
       if @api_client.config.debugging
@@ -204,6 +204,74 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # 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 [Hash] opts the optional parameters
+    # @return [DownloadAttachmentDto]
+    def download_attachment_base64(attachment_id, email_id, opts = {})
+      data, _status_code, _headers = download_attachment_base64_with_http_info(attachment_id, email_id, opts)
+      data
+    end
+
+    # 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 [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 = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EmailControllerApi.download_attachment_base64 ...'
+      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 EmailControllerApi.download_attachment_base64"
+      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.download_attachment_base64"
+      end
+      # resource path
+      local_var_path = '/emails/{emailId}/attachments/{attachmentId}/base64'.sub('{' + 'attachmentId' + '}', CGI.escape(attachment_id.to_s)).sub('{' + 'emailId' + '}', CGI.escape(email_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: EmailControllerApi#download_attachment_base64\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Forward email
     # Forward an existing email to new recipients.
     # @param email_id [String] emailId

data/lib/mailslurp_client/models/download_attachment_dto.rb

@@ -0,0 +1,228 @@
+=begin
+#MailSlurp API
+
+#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more.   ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository 
+
+The version of the OpenAPI document: 6.5.2
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+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
+    attr_accessor :base64_file_contents
+
+    # Content type of attachment
+    attr_accessor :content_type
+
+    # Size in bytes of attachment
+    attr_accessor :size_bytes
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'base64_file_contents' => :'base64FileContents',
+        :'content_type' => :'contentType',
+        :'size_bytes' => :'sizeBytes'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'base64_file_contents' => :'String',
+        :'content_type' => :'String',
+        :'size_bytes' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::DownloadAttachmentDto` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `MailSlurpClient::DownloadAttachmentDto`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'base64_file_contents')
+        self.base64_file_contents = attributes[:'base64_file_contents']
+      end
+
+      if attributes.key?(:'content_type')
+        self.content_type = attributes[:'content_type']
+      end
+
+      if attributes.key?(:'size_bytes')
+        self.size_bytes = attributes[:'size_bytes']
+      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
+      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?
+      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 &&
+          base64_file_contents == o.base64_file_contents &&
+          content_type == o.content_type &&
+          size_bytes == o.size_bytes
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [base64_file_contents, content_type, size_bytes].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    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 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
+        MailSlurpClient.const_get(type).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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+        
+        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

data/lib/mailslurp_client/models/inbox_projection.rb

@@ -106,6 +106,10 @@ module MailSlurpClient
         invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
       end
 
+      if @favourite.nil?
+        invalid_properties.push('invalid value for "favourite", favourite cannot be nil.')
+      end
+
       if @id.nil?
         invalid_properties.push('invalid value for "id", id cannot be nil.')
       end
@@ -117,6 +121,7 @@ module MailSlurpClient
     # @return true if the model is valid
     def valid?
       return false if @created_at.nil?
+      return false if @favourite.nil?
       return false if @id.nil?
       true
     end

data/lib/mailslurp_client/models/page_alias.rb

@@ -13,6 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # Paginated email alias results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full inbox entity use the projection ID with individual method calls.
   class PageAlias
     attr_accessor :content
 

data/lib/mailslurp_client/models/page_contact_projection.rb

@@ -13,6 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # Paginated contact results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full inbox entity use the projection ID with individual method calls.
   class PageContactProjection
     attr_accessor :content
 

data/lib/mailslurp_client/models/page_email_preview.rb

@@ -13,6 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # Paginated email preview results. EmailProjections and EmailPreviews are essentially the same but have legacy naming issues. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls. For emails there are several methods for fetching message bodies and attachments.
   class PageEmailPreview
     attr_accessor :content
 

data/lib/mailslurp_client/models/page_email_projection.rb

@@ -13,6 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # Paginated email projection results. EmailProjections and EmailPreviews are essentially the same but have legacy naming issues. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full email entity use the projection ID with individual method calls. For emails there are several methods for fetching message bodies and attachments.
   class PageEmailProjection
     attr_accessor :content
 

data/lib/mailslurp_client/models/page_group_projection.rb

@@ -13,6 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # Paginated contact group results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full inbox entity use the projection ID with individual method calls.
   class PageGroupProjection
     attr_accessor :content
 

data/lib/mailslurp_client/models/page_inbox_projection.rb

@@ -13,6 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # Paginated inbox results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full inbox entity use the projection ID with individual method calls.
   class PageInboxProjection
     attr_accessor :content
 

data/lib/mailslurp_client/models/page_sent_email_projection.rb

@@ -13,6 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # Paginated sent email results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full sent email entity use the projection ID with individual method calls.
   class PageSentEmailProjection
     attr_accessor :content
 

data/lib/mailslurp_client/models/page_template_projection.rb

@@ -13,6 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # Paginated email template results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full inbox entity use the projection ID with individual method calls.
   class PageTemplateProjection
     attr_accessor :content
 

data/lib/mailslurp_client/models/page_webhook_projection.rb

@@ -13,6 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # Paginated webhook results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full inbox entity use the projection ID with individual method calls.
   class PageWebhookProjection
     attr_accessor :content
 

data/lib/mailslurp_client/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailslurp_client
 version: !ruby/object:Gem::Version
-  version: 8.0.21
+  version: 8.2.1
 platform: ruby
 authors:
 - mailslurp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-18 00:00:00.000000000 Z
+date: 2020-11-19 00:00:00.000000000 Z
 dependencies: []
 description: Create emails addresses in Ruby then send and receive real emails and
   attachments. See https://www.mailslurp.com/docs/ruby/ for full Ruby documentation.
@@ -57,6 +57,7 @@ files:
 - lib/mailslurp_client/models/describe_mail_server_domain_result.rb
 - lib/mailslurp_client/models/domain_dto.rb
 - lib/mailslurp_client/models/domain_preview.rb
+- lib/mailslurp_client/models/download_attachment_dto.rb
 - lib/mailslurp_client/models/email.rb
 - lib/mailslurp_client/models/email_analysis.rb
 - lib/mailslurp_client/models/email_preview.rb