mailslurp_client 8.3.1 → 8.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73a7a6bce5d2930743647f53b1b93e19ea81179b32de56b6bd3c7a0d4ca84e62
-  data.tar.gz: 6f02b97e47c2f56c52e9c0eb68351c5a24b7b646b56dd0cdd7ac4efd4bf82801
+  metadata.gz: 9005d0f3b6653725d8c99997bde969c67c85d182407200ab1df23b8105635c8a
+  data.tar.gz: c81db7a3da9ee55e22377a5c10a52f20c550bdc2ad20c70e6ce6183cca1c12f8
 SHA512:
-  metadata.gz: 819cfdb8b68c76a89130bef694eaabd2db78e98d1205f7258fb1bee9f1696ca751bcc2a9c50099779a24110997f27f559b2632b1bc0a6292416b4f6fafdad65b
-  data.tar.gz: d878ffa757ae2fd463ac0b5a59db2ae7433abf85925186d21ba780b0cd73c23b648759b3a010f08dfe630a999bddf2a503a7f08deba97ed2a46f26246e7136fc
+  metadata.gz: 3910aefd959a7b28869636571e51b3a15d98073f8ff243919c3118a70a37ffbb810fd9f688ccedf47f62d5ace6be9ccc9af70d6dbeeb57ea882364676f6e8ed2
+  data.tar.gz: ef868c5a8e1f3fd0c6c6b87d381b13d1fff3bcfe731330cc7e7e046f44cdeb520d54cf9a1db98270da6855a6b8f5ded0304e69b702157d7fc8c0167a8f3ed36b

data/lib/mailslurp_client.rb

@@ -17,18 +17,20 @@ require 'mailslurp_client/version'
 require 'mailslurp_client/configuration'
 
 # Models
+require 'mailslurp_client/models/alias_dto'
+require 'mailslurp_client/models/alias_projection'
+require 'mailslurp_client/models/alias_verification_result'
 require 'mailslurp_client/models/attachment_meta_data'
 require 'mailslurp_client/models/basic_auth_options'
 require 'mailslurp_client/models/bulk_send_email_options'
 require 'mailslurp_client/models/contact_dto'
 require 'mailslurp_client/models/contact_projection'
 require 'mailslurp_client/models/content_match_options'
-require 'mailslurp_client/models/create_anonymous_alias_options'
+require 'mailslurp_client/models/create_alias_options'
 require 'mailslurp_client/models/create_contact_options'
 require 'mailslurp_client/models/create_domain_options'
 require 'mailslurp_client/models/create_group_options'
 require 'mailslurp_client/models/create_inbox_dto'
-require 'mailslurp_client/models/create_owned_alias_options'
 require 'mailslurp_client/models/create_template_options'
 require 'mailslurp_client/models/create_webhook_options'
 require 'mailslurp_client/models/dns_lookup_options'
@@ -68,6 +70,7 @@ require 'mailslurp_client/models/page_template_projection'
 require 'mailslurp_client/models/page_webhook_projection'
 require 'mailslurp_client/models/pageable'
 require 'mailslurp_client/models/raw_email_json'
+require 'mailslurp_client/models/reply_to_email_options'
 require 'mailslurp_client/models/send_email_options'
 require 'mailslurp_client/models/sent_email_dto'
 require 'mailslurp_client/models/sent_email_projection'
@@ -78,6 +81,7 @@ require 'mailslurp_client/models/template_dto'
 require 'mailslurp_client/models/template_projection'
 require 'mailslurp_client/models/template_variable'
 require 'mailslurp_client/models/unread_count'
+require 'mailslurp_client/models/update_alias_options'
 require 'mailslurp_client/models/update_group_contacts'
 require 'mailslurp_client/models/update_inbox_options'
 require 'mailslurp_client/models/upload_attachment_options'

data/lib/mailslurp_client/api/alias_controller_api.rb

@@ -19,28 +19,28 @@ module MailSlurpClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Create an email alias
-    # Create an email alias belonging to a user ID. To create anonymous aliases use the `createAnonymousAlias` method.
-    # @param create_owned_alias_options [CreateOwnedAliasOptions] createOwnedAliasOptions
+    # Create an email alias. Must be verified by clicking link inside verification email that will be sent to the address. Once verified the alias will be active.
+    # Email aliases use a MailSlurp randomly generated email address (or a custom domain inbox that you provide) to mask or proxy a real email address. Emails sent to the alias address will be forwarded to the hidden email address it was created for. If you want to send a reply use the threadId attached
+    # @param create_alias_options [CreateAliasOptions] createAliasOptions
     # @param [Hash] opts the optional parameters
-    # @return [nil]
-    def create_alias(create_owned_alias_options, opts = {})
-      create_alias_with_http_info(create_owned_alias_options, opts)
-      nil
+    # @return [ModelAlias]
+    def create_alias(create_alias_options, opts = {})
+      data, _status_code, _headers = create_alias_with_http_info(create_alias_options, opts)
+      data
     end
 
-    # Create an email alias
-    # Create an email alias belonging to a user ID. To create anonymous aliases use the `createAnonymousAlias` method.
-    # @param create_owned_alias_options [CreateOwnedAliasOptions] createOwnedAliasOptions
+    # Create an email alias. Must be verified by clicking link inside verification email that will be sent to the address. Once verified the alias will be active.
+    # Email aliases use a MailSlurp randomly generated email address (or a custom domain inbox that you provide) to mask or proxy a real email address. Emails sent to the alias address will be forwarded to the hidden email address it was created for. If you want to send a reply use the threadId attached
+    # @param create_alias_options [CreateAliasOptions] createAliasOptions
     # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def create_alias_with_http_info(create_owned_alias_options, opts = {})
+    # @return [Array<(ModelAlias, Integer, Hash)>] ModelAlias data, response status code and response headers
+    def create_alias_with_http_info(create_alias_options, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: AliasControllerApi.create_alias ...'
       end
-      # verify the required parameter 'create_owned_alias_options' is set
-      if @api_client.config.client_side_validation && create_owned_alias_options.nil?
-        fail ArgumentError, "Missing the required parameter 'create_owned_alias_options' when calling AliasControllerApi.create_alias"
+      # verify the required parameter 'create_alias_options' is set
+      if @api_client.config.client_side_validation && create_alias_options.nil?
+        fail ArgumentError, "Missing the required parameter 'create_alias_options' when calling AliasControllerApi.create_alias"
       end
       # resource path
       local_var_path = '/aliases'
@@ -59,10 +59,10 @@ module MailSlurpClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(create_owned_alias_options) 
+      post_body = opts[:body] || @api_client.object_to_http_body(create_alias_options) 
 
       # return_type
-      return_type = opts[:return_type] 
+      return_type = opts[:return_type] || 'ModelAlias' 
 
       # auth_names
       auth_names = opts[:auth_names] || ['API_KEY']
@@ -83,48 +83,44 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Create an anonymous email alias
-    # @param create_anonymous_alias_options [CreateAnonymousAliasOptions] createAnonymousAliasOptions
+    # Delete an email alias
+    # @param alias_id [String] aliasId
     # @param [Hash] opts the optional parameters
-    # @return [ModelAlias]
-    def create_anonymous_alias(create_anonymous_alias_options, opts = {})
-      data, _status_code, _headers = create_anonymous_alias_with_http_info(create_anonymous_alias_options, opts)
-      data
+    # @return [nil]
+    def delete_alias(alias_id, opts = {})
+      delete_alias_with_http_info(alias_id, opts)
+      nil
     end
 
-    # Create an anonymous email alias
-    # @param create_anonymous_alias_options [CreateAnonymousAliasOptions] createAnonymousAliasOptions
+    # Delete an email alias
+    # @param alias_id [String] aliasId
     # @param [Hash] opts the optional parameters
-    # @return [Array<(ModelAlias, Integer, Hash)>] ModelAlias data, response status code and response headers
-    def create_anonymous_alias_with_http_info(create_anonymous_alias_options, opts = {})
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_alias_with_http_info(alias_id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AliasControllerApi.create_anonymous_alias ...'
+        @api_client.config.logger.debug 'Calling API: AliasControllerApi.delete_alias ...'
       end
-      # verify the required parameter 'create_anonymous_alias_options' is set
-      if @api_client.config.client_side_validation && create_anonymous_alias_options.nil?
-        fail ArgumentError, "Missing the required parameter 'create_anonymous_alias_options' when calling AliasControllerApi.create_anonymous_alias"
+      # verify the required parameter 'alias_id' is set
+      if @api_client.config.client_side_validation && alias_id.nil?
+        fail ArgumentError, "Missing the required parameter 'alias_id' when calling AliasControllerApi.delete_alias"
       end
       # resource path
-      local_var_path = '/aliases/anonymous'
+      local_var_path = '/aliases/{aliasId}'.sub('{' + 'aliasId' + '}', CGI.escape(alias_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'])
-      # 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(create_anonymous_alias_options) 
+      post_body = opts[:body] 
 
       # return_type
-      return_type = opts[:return_type] || 'ModelAlias' 
+      return_type = opts[:return_type] 
 
       # auth_names
       auth_names = opts[:auth_names] || ['API_KEY']
@@ -138,33 +134,35 @@ module MailSlurpClient
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      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: AliasControllerApi#create_anonymous_alias\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: AliasControllerApi#delete_alias\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Delete an owned alias
+    # Get an email alias
+    # Get an email alias by ID
     # @param alias_id [String] aliasId
     # @param [Hash] opts the optional parameters
-    # @return [nil]
-    def delete_alias(alias_id, opts = {})
-      delete_alias_with_http_info(alias_id, opts)
-      nil
+    # @return [AliasDto]
+    def get_alias(alias_id, opts = {})
+      data, _status_code, _headers = get_alias_with_http_info(alias_id, opts)
+      data
     end
 
-    # Delete an owned alias
+    # Get an email alias
+    # Get an email alias by ID
     # @param alias_id [String] aliasId
     # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def delete_alias_with_http_info(alias_id, opts = {})
+    # @return [Array<(AliasDto, Integer, Hash)>] AliasDto data, response status code and response headers
+    def get_alias_with_http_info(alias_id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AliasControllerApi.delete_alias ...'
+        @api_client.config.logger.debug 'Calling API: AliasControllerApi.get_alias ...'
       end
       # verify the required parameter 'alias_id' is set
       if @api_client.config.client_side_validation && alias_id.nil?
-        fail ArgumentError, "Missing the required parameter 'alias_id' when calling AliasControllerApi.delete_alias"
+        fail ArgumentError, "Missing the required parameter 'alias_id' when calling AliasControllerApi.get_alias"
       end
       # resource path
       local_var_path = '/aliases/{aliasId}'.sub('{' + 'aliasId' + '}', CGI.escape(alias_id.to_s))
@@ -174,6 +172,8 @@ module MailSlurpClient
 
       # 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] || {}
@@ -182,7 +182,7 @@ module MailSlurpClient
       post_body = opts[:body] 
 
       # return_type
-      return_type = opts[:return_type] 
+      return_type = opts[:return_type] || 'AliasDto' 
 
       # auth_names
       auth_names = opts[:auth_names] || ['API_KEY']
@@ -196,41 +196,55 @@ module MailSlurpClient
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      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: AliasControllerApi#delete_alias\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: AliasControllerApi#get_alias\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Get an email alias
-    # Get an email alias by ID
+    # Get validation result from alias verification
+    # Verify an email alias email address with the verification token that was emailed to the address
     # @param alias_id [String] aliasId
+    # @param email_address [String] emailAddress
+    # @param verification_token [String] verificationToken
     # @param [Hash] opts the optional parameters
-    # @return [ModelAlias]
-    def get_alias(alias_id, opts = {})
-      data, _status_code, _headers = get_alias_with_http_info(alias_id, opts)
+    # @return [AliasVerificationResult]
+    def get_alias_verification(alias_id, email_address, verification_token, opts = {})
+      data, _status_code, _headers = get_alias_verification_with_http_info(alias_id, email_address, verification_token, opts)
       data
     end
 
-    # Get an email alias
-    # Get an email alias by ID
+    # Get validation result from alias verification
+    # Verify an email alias email address with the verification token that was emailed to the address
     # @param alias_id [String] aliasId
+    # @param email_address [String] emailAddress
+    # @param verification_token [String] verificationToken
     # @param [Hash] opts the optional parameters
-    # @return [Array<(ModelAlias, Integer, Hash)>] ModelAlias data, response status code and response headers
-    def get_alias_with_http_info(alias_id, opts = {})
+    # @return [Array<(AliasVerificationResult, Integer, Hash)>] AliasVerificationResult data, response status code and response headers
+    def get_alias_verification_with_http_info(alias_id, email_address, verification_token, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AliasControllerApi.get_alias ...'
+        @api_client.config.logger.debug 'Calling API: AliasControllerApi.get_alias_verification ...'
       end
       # verify the required parameter 'alias_id' is set
       if @api_client.config.client_side_validation && alias_id.nil?
-        fail ArgumentError, "Missing the required parameter 'alias_id' when calling AliasControllerApi.get_alias"
+        fail ArgumentError, "Missing the required parameter 'alias_id' when calling AliasControllerApi.get_alias_verification"
+      end
+      # verify the required parameter 'email_address' is set
+      if @api_client.config.client_side_validation && email_address.nil?
+        fail ArgumentError, "Missing the required parameter 'email_address' when calling AliasControllerApi.get_alias_verification"
+      end
+      # verify the required parameter 'verification_token' is set
+      if @api_client.config.client_side_validation && verification_token.nil?
+        fail ArgumentError, "Missing the required parameter 'verification_token' when calling AliasControllerApi.get_alias_verification"
       end
       # resource path
-      local_var_path = '/aliases/{aliasId}'.sub('{' + 'aliasId' + '}', CGI.escape(alias_id.to_s))
+      local_var_path = '/aliases/{aliasId}/verification'.sub('{' + 'aliasId' + '}', CGI.escape(alias_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'emailAddress'] = email_address
+      query_params[:'verificationToken'] = verification_token
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -244,7 +258,7 @@ module MailSlurpClient
       post_body = opts[:body] 
 
       # return_type
-      return_type = opts[:return_type] || 'ModelAlias' 
+      return_type = opts[:return_type] || 'AliasVerificationResult' 
 
       # auth_names
       auth_names = opts[:auth_names] || ['API_KEY']
@@ -260,12 +274,12 @@ module MailSlurpClient
 
       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: AliasControllerApi#get_alias\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: AliasControllerApi#get_alias_verification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Get all email aliases
+    # Get all email aliases you have created
     # Get all email aliases in paginated form
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page Optional page index in alias list pagination (default to 0)
@@ -277,7 +291,7 @@ module MailSlurpClient
       data
     end
 
-    # Get all email aliases
+    # Get all email aliases you have created
     # Get all email aliases in paginated form
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page Optional page index in alias list pagination
@@ -334,22 +348,22 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Update an owned alias
+    # Update an email alias
     # @param alias_id [String] aliasId
-    # @param create_owned_alias_options [CreateOwnedAliasOptions] createOwnedAliasOptions
+    # @param update_alias_options [UpdateAliasOptions] updateAliasOptions
     # @param [Hash] opts the optional parameters
     # @return [nil]
-    def update_alias(alias_id, create_owned_alias_options, opts = {})
-      update_alias_with_http_info(alias_id, create_owned_alias_options, opts)
+    def update_alias(alias_id, update_alias_options, opts = {})
+      update_alias_with_http_info(alias_id, update_alias_options, opts)
       nil
     end
 
-    # Update an owned alias
+    # Update an email alias
     # @param alias_id [String] aliasId
-    # @param create_owned_alias_options [CreateOwnedAliasOptions] createOwnedAliasOptions
+    # @param update_alias_options [UpdateAliasOptions] updateAliasOptions
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def update_alias_with_http_info(alias_id, create_owned_alias_options, opts = {})
+    def update_alias_with_http_info(alias_id, update_alias_options, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: AliasControllerApi.update_alias ...'
       end
@@ -357,9 +371,9 @@ module MailSlurpClient
       if @api_client.config.client_side_validation && alias_id.nil?
         fail ArgumentError, "Missing the required parameter 'alias_id' when calling AliasControllerApi.update_alias"
       end
-      # verify the required parameter 'create_owned_alias_options' is set
-      if @api_client.config.client_side_validation && create_owned_alias_options.nil?
-        fail ArgumentError, "Missing the required parameter 'create_owned_alias_options' when calling AliasControllerApi.update_alias"
+      # verify the required parameter 'update_alias_options' is set
+      if @api_client.config.client_side_validation && update_alias_options.nil?
+        fail ArgumentError, "Missing the required parameter 'update_alias_options' when calling AliasControllerApi.update_alias"
       end
       # resource path
       local_var_path = '/aliases/{aliasId}'.sub('{' + 'aliasId' + '}', CGI.escape(alias_id.to_s))
@@ -378,7 +392,7 @@ module MailSlurpClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(create_owned_alias_options) 
+      post_body = opts[:body] || @api_client.object_to_http_body(update_alias_options) 
 
       # return_type
       return_type = opts[:return_type] 

data/lib/mailslurp_client/api/email_controller_api.rb

@@ -925,6 +925,76 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Reply to an email
+    # Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails `to`, `cc`, and `bcc`.
+    # @param email_id [String] emailId
+    # @param reply_to_email_options [ReplyToEmailOptions] replyToEmailOptions
+    # @param [Hash] opts the optional parameters
+    # @return [SentEmailDto]
+    def reply_to_email(email_id, reply_to_email_options, opts = {})
+      data, _status_code, _headers = reply_to_email_with_http_info(email_id, reply_to_email_options, opts)
+      data
+    end
+
+    # Reply to an email
+    # Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails `to`, `cc`, and `bcc`.
+    # @param email_id [String] emailId
+    # @param reply_to_email_options [ReplyToEmailOptions] replyToEmailOptions
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SentEmailDto, Integer, Hash)>] SentEmailDto data, response status code and response headers
+    def reply_to_email_with_http_info(email_id, reply_to_email_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EmailControllerApi.reply_to_email ...'
+      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.reply_to_email"
+      end
+      # verify the required parameter 'reply_to_email_options' is set
+      if @api_client.config.client_side_validation && reply_to_email_options.nil?
+        fail ArgumentError, "Missing the required parameter 'reply_to_email_options' when calling EmailControllerApi.reply_to_email"
+      end
+      # resource path
+      local_var_path = '/emails/{emailId}'.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'])
+      # 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(reply_to_email_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(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EmailControllerApi#reply_to_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Validate email
     # Validate the HTML content of email if HTML is found. Considered valid if no HTML.
     # @param email_id [String] ID of email