mailslurp_client 15.4.2 → 15.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2732728fb102413fbc4d84c30e6b6fc8a4da192e569d1b3cb5ed0cb7a77db750
-  data.tar.gz: b85e2541f0b53d20d460e2e5cd6099f55ed7dff5ad9df1e53d4dbb5fc502565b
+  metadata.gz: 321db681e2b205b73d6d5e39581c8ae5b5462b5d3a987379d65d02566b18a5de
+  data.tar.gz: 6b0d2169f1533437fab1e5a0a3f41d7bcbd724d6d482e4e01d778c06f6beef44
 SHA512:
-  metadata.gz: 16680ce38d426581fd23fcbf1cc92cd32c9395868494c7bdeec0ef9dab595a922509b5c2feaaef58d9293c0f0a93ff78eefbac8db42b32fe73174adcfcf9e076
-  data.tar.gz: 9e022a0c01c1644a5d429e3e0a4b06ca1b9ee7ba08151eaaa1058b41e16bb3f3f3fd618131b3201f54e27db28f560cd569498101cacc3ce2bbd469f279c90350
+  metadata.gz: fc87baa313862d2a9d9df81619fcd405142f8efa182abba46c6ba361e4b9af0a3447cca7bd07c5275177582dc52a1719bd15c0ece9577bbbc198e738f475cfd9
+  data.tar.gz: 21f7c76b4f009f0b508abf64fcf0469f1be26dceeddee0a8d59a9fbdb7c50bb33b458ddd3d2d8b43f2237e34ab6b8dccaa4f6f4176233b821f26b4964c727dc4

data/lib/mailslurp_client/api/email_controller_api.rb

@@ -19,6 +19,76 @@ module MailSlurpClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Set IMAP flags associated with a message. Only supports '\\Seen' flag.
+    # Apply RFC3501 section-2.3.2 IMAP flag operations on an email
+    # @param email_id [String] 
+    # @param imap_flag_operation_options [ImapFlagOperationOptions] 
+    # @param [Hash] opts the optional parameters
+    # @return [EmailPreview]
+    def apply_imap_flag_operation(email_id, imap_flag_operation_options, opts = {})
+      data, _status_code, _headers = apply_imap_flag_operation_with_http_info(email_id, imap_flag_operation_options, opts)
+      data
+    end
+
+    # Set IMAP flags associated with a message. Only supports '\\Seen' flag.
+    # Apply RFC3501 section-2.3.2 IMAP flag operations on an email
+    # @param email_id [String] 
+    # @param imap_flag_operation_options [ImapFlagOperationOptions] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EmailPreview, Integer, Hash)>] EmailPreview data, response status code and response headers
+    def apply_imap_flag_operation_with_http_info(email_id, imap_flag_operation_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EmailControllerApi.apply_imap_flag_operation ...'
+      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.apply_imap_flag_operation"
+      end
+      # verify the required parameter 'imap_flag_operation_options' is set
+      if @api_client.config.client_side_validation && imap_flag_operation_options.nil?
+        fail ArgumentError, "Missing the required parameter 'imap_flag_operation_options' when calling EmailControllerApi.apply_imap_flag_operation"
+      end
+      # resource path
+      local_var_path = '/emails/{emailId}/imap-flag-operation'.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(['*/*'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(imap_flag_operation_options) 
+
+      # return_type
+      return_type = opts[:return_type] || 'EmailPreview' 
+
+      # 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: EmailControllerApi#apply_imap_flag_operation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # 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

data/lib/mailslurp_client/models/alias_projection.rb

@@ -27,10 +27,10 @@ module MailSlurpClient
 
     attr_accessor :created_at
 
-    attr_accessor :use_threads
-
     attr_accessor :updated_at
 
+    attr_accessor :use_threads
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -40,8 +40,8 @@ module MailSlurpClient
         :'email_address' => :'emailAddress',
         :'inbox_id' => :'inboxId',
         :'created_at' => :'createdAt',
-        :'use_threads' => :'useThreads',
-        :'updated_at' => :'updatedAt'
+        :'updated_at' => :'updatedAt',
+        :'use_threads' => :'useThreads'
       }
     end
 
@@ -54,8 +54,8 @@ module MailSlurpClient
         :'email_address' => :'String',
         :'inbox_id' => :'String',
         :'created_at' => :'DateTime',
-        :'use_threads' => :'Boolean',
-        :'updated_at' => :'DateTime'
+        :'updated_at' => :'DateTime',
+        :'use_threads' => :'Boolean'
       }
     end
 
@@ -104,13 +104,13 @@ module MailSlurpClient
         self.created_at = attributes[:'created_at']
       end
 
-      if attributes.key?(:'use_threads')
-        self.use_threads = attributes[:'use_threads']
-      end
-
       if attributes.key?(:'updated_at')
         self.updated_at = attributes[:'updated_at']
       end
+
+      if attributes.key?(:'use_threads')
+        self.use_threads = attributes[:'use_threads']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -167,8 +167,8 @@ module MailSlurpClient
           email_address == o.email_address &&
           inbox_id == o.inbox_id &&
           created_at == o.created_at &&
-          use_threads == o.use_threads &&
-          updated_at == o.updated_at
+          updated_at == o.updated_at &&
+          use_threads == o.use_threads
     end
 
     # @see the `==` method
@@ -180,7 +180,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, id, user_id, email_address, inbox_id, created_at, use_threads, updated_at].hash
+      [name, id, user_id, email_address, inbox_id, created_at, updated_at, use_threads].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/attachment_projection.rb

@@ -19,6 +19,9 @@ module MailSlurpClient
     # Content length of attachment in bytes
     attr_accessor :content_length
 
+    # Content type of attachment.
+    attr_accessor :content_type
+
     attr_accessor :user_id
 
     # Attachment ID
@@ -28,19 +31,16 @@ module MailSlurpClient
 
     attr_accessor :updated_at
 
-    # Content type of attachment.
-    attr_accessor :content_type
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'name' => :'name',
         :'content_length' => :'contentLength',
+        :'content_type' => :'contentType',
         :'user_id' => :'userId',
         :'attachment_id' => :'attachmentId',
         :'created_at' => :'createdAt',
-        :'updated_at' => :'updatedAt',
-        :'content_type' => :'contentType'
+        :'updated_at' => :'updatedAt'
       }
     end
 
@@ -49,11 +49,11 @@ module MailSlurpClient
       {
         :'name' => :'String',
         :'content_length' => :'Integer',
+        :'content_type' => :'String',
         :'user_id' => :'String',
         :'attachment_id' => :'String',
         :'created_at' => :'DateTime',
-        :'updated_at' => :'DateTime',
-        :'content_type' => :'String'
+        :'updated_at' => :'DateTime'
       }
     end
 
@@ -86,6 +86,10 @@ module MailSlurpClient
         self.content_length = attributes[:'content_length']
       end
 
+      if attributes.key?(:'content_type')
+        self.content_type = attributes[:'content_type']
+      end
+
       if attributes.key?(:'user_id')
         self.user_id = attributes[:'user_id']
       end
@@ -101,10 +105,6 @@ module MailSlurpClient
       if attributes.key?(:'updated_at')
         self.updated_at = attributes[:'updated_at']
       end
-
-      if attributes.key?(:'content_type')
-        self.content_type = attributes[:'content_type']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -147,11 +147,11 @@ module MailSlurpClient
       self.class == o.class &&
           name == o.name &&
           content_length == o.content_length &&
+          content_type == o.content_type &&
           user_id == o.user_id &&
           attachment_id == o.attachment_id &&
           created_at == o.created_at &&
-          updated_at == o.updated_at &&
-          content_type == o.content_type
+          updated_at == o.updated_at
     end
 
     # @see the `==` method
@@ -163,7 +163,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, content_length, user_id, attachment_id, created_at, updated_at, content_type].hash
+      [name, content_length, content_type, user_id, attachment_id, created_at, updated_at].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/create_inbox_dto.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
-  # Options for creating an inbox. An inbox has a real email address that can send and receive emails. Inboxes can be permanent or expire at a given time. Inboxes are either `SMTP` or `HTTP` mailboxes. `SMTP` inboxes are receive only and processed by a mail server running at `mx.mailslurp.com` while `HTTP` inboxes can send and receive and are processed by AWS SES. Inboxes can use a custom email address (by verifying your own domain) or a randomly assigned email ending in either `mailslurp.com` or (if `useDomainPool` is enabled) ending in a similar domain such as `mailslurp.xyz` (selected at random). 
+  # Options for creating an inbox. An inbox has a real email address that can send and receive emails. Inboxes can be permanent or expire at a given time. Inboxes are either `SMTP` or `HTTP` mailboxes. `SMTP` inboxes are processed by a mail server running at `mx.mailslurp.com` while `HTTP` inboxes are processed by AWS SES. Inboxes can use a custom email address (by verifying your own domain) or a randomly assigned email ending in either `mailslurp.com` or (if `useDomainPool` is enabled) ending in a similar domain such as `mailslurp.xyz` (selected at random). 
   class CreateInboxDto
     # A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.
     attr_accessor :email_address

data/lib/mailslurp_client/models/email_projection.rb

@@ -23,10 +23,10 @@ module MailSlurpClient
 
     attr_accessor :inbox_id
 
-    attr_accessor :attachments
-
     attr_accessor :to
 
+    attr_accessor :attachments
+
     attr_accessor :bcc
 
     attr_accessor :cc
@@ -48,8 +48,8 @@ module MailSlurpClient
         :'from' => :'from',
         :'subject' => :'subject',
         :'inbox_id' => :'inboxId',
-        :'attachments' => :'attachments',
         :'to' => :'to',
+        :'attachments' => :'attachments',
         :'bcc' => :'bcc',
         :'cc' => :'cc',
         :'created_at' => :'createdAt',
@@ -67,8 +67,8 @@ module MailSlurpClient
         :'from' => :'String',
         :'subject' => :'String',
         :'inbox_id' => :'String',
-        :'attachments' => :'Array<String>',
         :'to' => :'Array<String>',
+        :'attachments' => :'Array<String>',
         :'bcc' => :'Array<String>',
         :'cc' => :'Array<String>',
         :'created_at' => :'DateTime',
@@ -116,18 +116,18 @@ module MailSlurpClient
         self.inbox_id = attributes[:'inbox_id']
       end
 
-      if attributes.key?(:'attachments')
-        if (value = attributes[:'attachments']).is_a?(Array)
-          self.attachments = value
-        end
-      end
-
       if attributes.key?(:'to')
         if (value = attributes[:'to']).is_a?(Array)
           self.to = value
         end
       end
 
+      if attributes.key?(:'attachments')
+        if (value = attributes[:'attachments']).is_a?(Array)
+          self.attachments = value
+        end
+      end
+
       if attributes.key?(:'bcc')
         if (value = attributes[:'bcc']).is_a?(Array)
           self.bcc = value
@@ -203,8 +203,8 @@ module MailSlurpClient
           from == o.from &&
           subject == o.subject &&
           inbox_id == o.inbox_id &&
-          attachments == o.attachments &&
           to == o.to &&
+          attachments == o.attachments &&
           bcc == o.bcc &&
           cc == o.cc &&
           created_at == o.created_at &&
@@ -223,7 +223,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, from, subject, inbox_id, attachments, to, bcc, cc, created_at, team_access, read, body_md5_hash, body_excerpt].hash
+      [id, from, subject, inbox_id, to, attachments, bcc, cc, created_at, team_access, read, body_md5_hash, body_excerpt].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/imap_flag_operation_options.rb

@@ -0,0 +1,261 @@
+=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
+Contact: contact@mailslurp.dev
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module MailSlurpClient
+  class ImapFlagOperationOptions
+    attr_accessor :flag_operation
+
+    attr_accessor :flags
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'flag_operation' => :'flagOperation',
+        :'flags' => :'flags'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'flag_operation' => :'String',
+        :'flags' => :'Array<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::ImapFlagOperationOptions` 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::ImapFlagOperationOptions`. 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?(:'flag_operation')
+        self.flag_operation = attributes[:'flag_operation']
+      end
+
+      if attributes.key?(:'flags')
+        if (value = attributes[:'flags']).is_a?(Array)
+          self.flags = value
+        end
+      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 @flag_operation.nil?
+        invalid_properties.push('invalid value for "flag_operation", flag_operation cannot be nil.')
+      end
+
+      if @flags.nil?
+        invalid_properties.push('invalid value for "flags", flags 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 @flag_operation.nil?
+      flag_operation_validator = EnumAttributeValidator.new('String', ["SET_FLAGS", "ADD_FLAGS", "REMOVE_FLAGS"])
+      return false unless flag_operation_validator.valid?(@flag_operation)
+      return false if @flags.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] flag_operation Object to be assigned
+    def flag_operation=(flag_operation)
+      validator = EnumAttributeValidator.new('String', ["SET_FLAGS", "ADD_FLAGS", "REMOVE_FLAGS"])
+      unless validator.valid?(flag_operation)
+        fail ArgumentError, "invalid value for \"flag_operation\", must be one of #{validator.allowable_values}."
+      end
+      @flag_operation = flag_operation
+    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 &&
+          flag_operation == o.flag_operation &&
+          flags == o.flags
+    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
+      [flag_operation, flags].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