mailslurp_client 15.4.0 → 15.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf4a01971704062a8c0fc5c66e177cc1ff525f13010caa9676b35650e7a51763
-  data.tar.gz: 1d8c3eccf5f2950001ea6f4b2f35520703b8f630b2f3724428c03ea91ecf68c4
+  metadata.gz: 0025e93c1ea051a036c283ea13400f9f3264a169aaa426d57d4f6a773084ff58
+  data.tar.gz: f02ad0898de31664e0f98f671636c2d4ae1a3be125155b76005a44ea4203afba
 SHA512:
-  metadata.gz: df6322da1dcde97c72555421e1279aafaa70d374c3afbc3a8653debaae60f4c9b2e99c020d543acb355bf47a871dd917cae33b22db983bd2def73f6ebee32546
-  data.tar.gz: f13859837c4d6702a62e26f05123c64f19679a12a93a4caba4fd6d1180fe2021a7c6587145ca5282b2098df35ed041a976b62d953770a7d1bc69caafdeb95ab9
+  metadata.gz: b183d0e4ddca5829ab295f4c8e0dac034eec294800f16d3d138dbbc4093e3d0e3a14fb3ece126c168765e5b80670bc6fd075356572c93dcf86dd3fb95d8a9a9b
+  data.tar.gz: 0d38552fe49aa707bb209f6da41a5ba199c37f73f905086659626999677f432141e95adb8222ce6bfa128d5e6610ed01e68e50f0500bd6c9fdcc4121f9f5801a

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/api/inbox_controller_api.rb

@@ -721,6 +721,63 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Get IMAP and SMTP access usernames and passwords
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :inbox_id Inbox ID
+    # @return [ImapSmtpAccessDetails]
+    def get_imap_smtp_access(opts = {})
+      data, _status_code, _headers = get_imap_smtp_access_with_http_info(opts)
+      data
+    end
+
+    # Get IMAP and SMTP access usernames and passwords
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :inbox_id Inbox ID
+    # @return [Array<(ImapSmtpAccessDetails, Integer, Hash)>] ImapSmtpAccessDetails data, response status code and response headers
+    def get_imap_smtp_access_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_imap_smtp_access ...'
+      end
+      # resource path
+      local_var_path = '/inboxes/imap-smtp-access'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['*/*'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'ImapSmtpAccessDetails' 
+
+      # 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: InboxControllerApi#get_imap_smtp_access\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get Inbox. Returns properties of an inbox.
     # Returns an inbox's properties, including its email address and ID.
     # @param inbox_id [String] 
@@ -1697,6 +1754,76 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Send email using an SMTP mail envelope and message body and return sent confirmation
+    # Send email using an SMTP envelope containing RCPT TO, MAIL FROM, and a SMTP BODY.
+    # @param inbox_id [String] ID of the inbox you want to send the email from
+    # @param send_smtp_envelope_options [SendSMTPEnvelopeOptions] 
+    # @param [Hash] opts the optional parameters
+    # @return [SentEmailDto]
+    def send_smtp_envelope(inbox_id, send_smtp_envelope_options, opts = {})
+      data, _status_code, _headers = send_smtp_envelope_with_http_info(inbox_id, send_smtp_envelope_options, opts)
+      data
+    end
+
+    # Send email using an SMTP mail envelope and message body and return sent confirmation
+    # Send email using an SMTP envelope containing RCPT TO, MAIL FROM, and a SMTP BODY.
+    # @param inbox_id [String] ID of the inbox you want to send the email from
+    # @param send_smtp_envelope_options [SendSMTPEnvelopeOptions] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SentEmailDto, Integer, Hash)>] SentEmailDto data, response status code and response headers
+    def send_smtp_envelope_with_http_info(inbox_id, send_smtp_envelope_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxControllerApi.send_smtp_envelope ...'
+      end
+      # verify the required parameter 'inbox_id' is set
+      if @api_client.config.client_side_validation && inbox_id.nil?
+        fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.send_smtp_envelope"
+      end
+      # verify the required parameter 'send_smtp_envelope_options' is set
+      if @api_client.config.client_side_validation && send_smtp_envelope_options.nil?
+        fail ArgumentError, "Missing the required parameter 'send_smtp_envelope_options' when calling InboxControllerApi.send_smtp_envelope"
+      end
+      # resource path
+      local_var_path = '/inboxes/{inboxId}/smtp-envelope'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_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(send_smtp_envelope_options) 
+
+      # return_type
+      return_type = opts[:return_type] || 'SentEmailDto' 
+
+      # 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: InboxControllerApi#send_smtp_envelope\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Send a test email to inbox
     # Send an inbox a test email to test email receiving is working
     # @param inbox_id [String] 

data/lib/mailslurp_client/models/alias_projection.rb

@@ -19,29 +19,29 @@ module MailSlurpClient
 
     attr_accessor :id
 
-    attr_accessor :inbox_id
-
     attr_accessor :user_id
 
     attr_accessor :email_address
 
-    attr_accessor :created_at
+    attr_accessor :inbox_id
 
-    attr_accessor :use_threads
+    attr_accessor :created_at
 
     attr_accessor :updated_at
 
+    attr_accessor :use_threads
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'name' => :'name',
         :'id' => :'id',
-        :'inbox_id' => :'inboxId',
         :'user_id' => :'userId',
         :'email_address' => :'emailAddress',
+        :'inbox_id' => :'inboxId',
         :'created_at' => :'createdAt',
-        :'use_threads' => :'useThreads',
-        :'updated_at' => :'updatedAt'
+        :'updated_at' => :'updatedAt',
+        :'use_threads' => :'useThreads'
       }
     end
 
@@ -50,12 +50,12 @@ module MailSlurpClient
       {
         :'name' => :'String',
         :'id' => :'String',
-        :'inbox_id' => :'String',
         :'user_id' => :'String',
         :'email_address' => :'String',
+        :'inbox_id' => :'String',
         :'created_at' => :'DateTime',
-        :'use_threads' => :'Boolean',
-        :'updated_at' => :'DateTime'
+        :'updated_at' => :'DateTime',
+        :'use_threads' => :'Boolean'
       }
     end
 
@@ -88,10 +88,6 @@ module MailSlurpClient
         self.id = attributes[:'id']
       end
 
-      if attributes.key?(:'inbox_id')
-        self.inbox_id = attributes[:'inbox_id']
-      end
-
       if attributes.key?(:'user_id')
         self.user_id = attributes[:'user_id']
       end
@@ -100,17 +96,21 @@ module MailSlurpClient
         self.email_address = attributes[:'email_address']
       end
 
-      if attributes.key?(:'created_at')
-        self.created_at = attributes[:'created_at']
+      if attributes.key?(:'inbox_id')
+        self.inbox_id = attributes[:'inbox_id']
       end
 
-      if attributes.key?(:'use_threads')
-        self.use_threads = attributes[:'use_threads']
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
       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?
@@ -121,10 +121,6 @@ module MailSlurpClient
         invalid_properties.push('invalid value for "id", id cannot be nil.')
       end
 
-      if @inbox_id.nil?
-        invalid_properties.push('invalid value for "inbox_id", inbox_id cannot be nil.')
-      end
-
       if @user_id.nil?
         invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
       end
@@ -133,6 +129,10 @@ module MailSlurpClient
         invalid_properties.push('invalid value for "email_address", email_address cannot be nil.')
       end
 
+      if @inbox_id.nil?
+        invalid_properties.push('invalid value for "inbox_id", inbox_id cannot be nil.')
+      end
+
       if @created_at.nil?
         invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
       end
@@ -148,9 +148,9 @@ module MailSlurpClient
     # @return true if the model is valid
     def valid?
       return false if @id.nil?
-      return false if @inbox_id.nil?
       return false if @user_id.nil?
       return false if @email_address.nil?
+      return false if @inbox_id.nil?
       return false if @created_at.nil?
       return false if @updated_at.nil?
       true
@@ -163,12 +163,12 @@ module MailSlurpClient
       self.class == o.class &&
           name == o.name &&
           id == o.id &&
-          inbox_id == o.inbox_id &&
           user_id == o.user_id &&
           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, inbox_id, user_id, email_address, 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

@@ -19,10 +19,10 @@ module MailSlurpClient
 
     attr_accessor :from
 
-    attr_accessor :inbox_id
-
     attr_accessor :subject
 
+    attr_accessor :inbox_id
+
     attr_accessor :to
 
     attr_accessor :attachments
@@ -46,8 +46,8 @@ module MailSlurpClient
       {
         :'id' => :'id',
         :'from' => :'from',
-        :'inbox_id' => :'inboxId',
         :'subject' => :'subject',
+        :'inbox_id' => :'inboxId',
         :'to' => :'to',
         :'attachments' => :'attachments',
         :'bcc' => :'bcc',
@@ -65,8 +65,8 @@ module MailSlurpClient
       {
         :'id' => :'String',
         :'from' => :'String',
-        :'inbox_id' => :'String',
         :'subject' => :'String',
+        :'inbox_id' => :'String',
         :'to' => :'Array<String>',
         :'attachments' => :'Array<String>',
         :'bcc' => :'Array<String>',
@@ -108,14 +108,14 @@ module MailSlurpClient
         self.from = attributes[:'from']
       end
 
-      if attributes.key?(:'inbox_id')
-        self.inbox_id = attributes[:'inbox_id']
-      end
-
       if attributes.key?(:'subject')
         self.subject = attributes[:'subject']
       end
 
+      if attributes.key?(:'inbox_id')
+        self.inbox_id = attributes[:'inbox_id']
+      end
+
       if attributes.key?(:'to')
         if (value = attributes[:'to']).is_a?(Array)
           self.to = value
@@ -201,8 +201,8 @@ module MailSlurpClient
       self.class == o.class &&
           id == o.id &&
           from == o.from &&
-          inbox_id == o.inbox_id &&
           subject == o.subject &&
+          inbox_id == o.inbox_id &&
           to == o.to &&
           attachments == o.attachments &&
           bcc == o.bcc &&
@@ -223,7 +223,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, from, inbox_id, subject, to, attachments, 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