mailslurp_client 12.8.2 → 12.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9631374b4be566eabd7d85aa8bdc05f9b27d3904be856e85a6eb70df08ec272f
-  data.tar.gz: 660a9a5e1d6af82ee9213085f06acf469f2d5f396ac61d43d09f10fc14bafc7d
+  metadata.gz: 0be4890f6575516d8fd55e9c1ecddec727214797175b97bc7a3640e854ab4efa
+  data.tar.gz: 5c4d1103dd95353d2a45b3c77082f53288f8d92949f81616406c854363bf31a8
 SHA512:
-  metadata.gz: 871cd565c92d7ec331543bc40e44a250cb5b5ef81af8ba8c9a0ce5a0790aba35c3e925eb2eafb179eed3aee194e825ee064ad0bf773ff00ae19d836cb76adfff
-  data.tar.gz: 709bbd3304bc4092f49c02054ac726f5ce6de43abf4edb804d60f0feb292e35cc909f5bb62323fb51fab6a22eb07f917ea16c15f63f99922ccf3f8f042338776
+  metadata.gz: bbdedc8356a9c4c5a0fc3dfdc118aa80933f5682062412c2e967dea81b26862332eec13e39106d24a9dc40a0cb318647389aa669f9ea9af9f4e85aa87794859a
+  data.tar.gz: cbf43aff215df9400b093697d8f665b2e0c3d88ad6ab169c2fc2bcd774287bb16c00547a00a0ba4bbbbc8fdfea5650296518d73c12ea8c8879062509b69e0865

data/lib/mailslurp_client.rb

@@ -20,6 +20,7 @@ require 'mailslurp_client/configuration'
 require 'mailslurp_client/models/abstract_webhook_payload'
 require 'mailslurp_client/models/alias_dto'
 require 'mailslurp_client/models/alias_projection'
+require 'mailslurp_client/models/attachment_entity'
 require 'mailslurp_client/models/attachment_meta_data'
 require 'mailslurp_client/models/attachment_projection'
 require 'mailslurp_client/models/basic_auth_options'

data/lib/mailslurp_client/api/attachment_controller_api.rb

@@ -19,6 +19,58 @@ module MailSlurpClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Delete all attachments
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_all_attachments(opts = {})
+      delete_all_attachments_with_http_info(opts)
+      nil
+    end
+
+    # Delete all attachments
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_all_attachments_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AttachmentControllerApi.delete_all_attachments ...'
+      end
+      # resource path
+      local_var_path = '/attachments'
+
+      # 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(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AttachmentControllerApi#delete_all_attachments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Delete an 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 attachment_id [String] ID of attachment
@@ -203,6 +255,68 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Get an attachment entity
+    # 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 attachment_id [String] ID of attachment
+    # @param [Hash] opts the optional parameters
+    # @return [AttachmentEntity]
+    def get_attachment(attachment_id, opts = {})
+      data, _status_code, _headers = get_attachment_with_http_info(attachment_id, opts)
+      data
+    end
+
+    # Get an attachment entity
+    # 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 &#x60;SendEmailOptions&#x60; when sending an email. Using the upload endpoints prior to sending mean attachments can easily be reused.
+    # @param attachment_id [String] ID of attachment
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AttachmentEntity, Integer, Hash)>] AttachmentEntity data, response status code and response headers
+    def get_attachment_with_http_info(attachment_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AttachmentControllerApi.get_attachment ...'
+      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"
+      end
+      # resource path
+      local_var_path = '/attachments/{attachmentId}'.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] || 'AttachmentEntity' 
+
+      # 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\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
@@ -404,7 +518,7 @@ module MailSlurpClient
     # 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.
     # 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 [Hash] opts the optional parameters
-    # @option opts [String] :string Optional contentType for file. For instance &#x60;application/pdf&#x60;
+    # @option opts [String] :content_type 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>]
@@ -416,7 +530,7 @@ module MailSlurpClient
     # 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.
     # 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 &#x60;SendEmailOptions&#x60; 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] :content_type 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
@@ -429,7 +543,7 @@ module MailSlurpClient
 
       # query parameters
       query_params = opts[:query_params] || {}
-      query_params[:'String'] = opts[:'string'] if !opts[:'string'].nil?
+      query_params[:'contentType'] = opts[:'content_type'] if !opts[:'content_type'].nil?
       query_params[:'filename'] = opts[:'filename'] if !opts[:'filename'].nil?
 
       # header parameters

data/lib/mailslurp_client/models/attachment_entity.rb

@@ -0,0 +1,289 @@
+=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
+  class AttachmentEntity
+    attr_accessor :attachment_id
+
+    attr_accessor :content_length
+
+    attr_accessor :content_type
+
+    attr_accessor :created_at
+
+    attr_accessor :id
+
+    attr_accessor :name
+
+    attr_accessor :updated_at
+
+    attr_accessor :user_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'attachment_id' => :'attachmentId',
+        :'content_length' => :'contentLength',
+        :'content_type' => :'contentType',
+        :'created_at' => :'createdAt',
+        :'id' => :'id',
+        :'name' => :'name',
+        :'updated_at' => :'updatedAt',
+        :'user_id' => :'userId'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'attachment_id' => :'String',
+        :'content_length' => :'Integer',
+        :'content_type' => :'String',
+        :'created_at' => :'DateTime',
+        :'id' => :'String',
+        :'name' => :'String',
+        :'updated_at' => :'DateTime',
+        :'user_id' => :'String'
+      }
+    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::AttachmentEntity` 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::AttachmentEntity`. 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?(:'attachment_id')
+        self.attachment_id = attributes[:'attachment_id']
+      end
+
+      if attributes.key?(:'content_length')
+        self.content_length = attributes[:'content_length']
+      end
+
+      if attributes.key?(:'content_type')
+        self.content_type = attributes[:'content_type']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      end
+
+      if attributes.key?(:'user_id')
+        self.user_id = attributes[:'user_id']
+      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
+      if @attachment_id.nil?
+        invalid_properties.push('invalid value for "attachment_id", attachment_id cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @updated_at.nil?
+        invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
+      end
+
+      if @user_id.nil?
+        invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
+      end
+
+      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?
+      return false if @attachment_id.nil?
+      return false if @created_at.nil?
+      return false if @updated_at.nil?
+      return false if @user_id.nil?
+      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 &&
+          attachment_id == o.attachment_id &&
+          content_length == o.content_length &&
+          content_type == o.content_type &&
+          created_at == o.created_at &&
+          id == o.id &&
+          name == o.name &&
+          updated_at == o.updated_at &&
+          user_id == o.user_id
+    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
+      [attachment_id, content_length, content_type, created_at, id, name, updated_at, user_id].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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailslurp_client
 version: !ruby/object:Gem::Version
-  version: 12.8.2
+  version: 12.8.3
 platform: ruby
 authors:
 - mailslurp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-21 00:00:00.000000000 Z
+date: 2021-07-23 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.
@@ -51,6 +51,7 @@ files:
 - lib/mailslurp_client/models/abstract_webhook_payload.rb
 - lib/mailslurp_client/models/alias_dto.rb
 - lib/mailslurp_client/models/alias_projection.rb
+- lib/mailslurp_client/models/attachment_entity.rb
 - lib/mailslurp_client/models/attachment_meta_data.rb
 - lib/mailslurp_client/models/attachment_projection.rb
 - lib/mailslurp_client/models/basic_auth_options.rb