mailslurp_client 8.2.16 → 8.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c260595fb22734fe08c4bc9dde162a503cfdf5453db89b406da327d7ea742b3c
-  data.tar.gz: 278762360ddbfce4bd7aba024dadbc30c22a9a5cf6f371a34289b42d1cd5c443
+  metadata.gz: 4cb78fa34deefcfbacb0fc0869299b8cbbaed2841bd53cd23b249dc073ef2414
+  data.tar.gz: b340f56704df070bcf97748a33ddcebb452684e11c745b4b2c289f4e77889d97
 SHA512:
-  metadata.gz: 3282107ccdd4d938bc19e7c86d18c1114d3e1e725afbce084329f66730f8c8b9568a6fd9240c0c0b19ea516465478e4265e22f92b6f90488b36d3d3b761e08a7
-  data.tar.gz: d99dcf7ad1e8fc78bf1894e1dc76c867c63e6b48de715ff6f54d188d357aa6802a810ea840f12f7f0b407261c034301a9c5cb4a96a5bc2f76c7d283aca7ab3a0
+  metadata.gz: d4dd7529896f34076a28e421329676eceafe74e95841c66f2765483a4dad82762345e9c534886398a1a0e69232f62688f44a3028ae85fd69386084957252eeff
+  data.tar.gz: eb80474a178e52920d3419bc761dce06c585247e36f2a5ad9e8860cd40680015f995b3805c917417cf970f7a0c17e9f18293468eec5ce644772d6946e986c4d3

data/README.md

@@ -41,7 +41,7 @@ gem install mailslurp_client
 Or in your `Gemfile`:
 
 ```ruby
-gem 'mailslurp_client', '~> 8.2', '>= 8.2.2'
+gem 'mailslurp_client', '~> 8.3', '>= 8.3.0'
 ```
 
 And then run bundler install:
@@ -90,6 +90,35 @@ it 'can create email addresses' do
 end
 ```
 
+#### More options
+The `create_inbox` method has some limitations in the Ruby client. To create inboxes with more options use the alternative
+`create_inbox_with_options` method. (This uses a request body instead of query parameters.)
+
+```ruby
+it 'can an inbox with tags' do
+    inbox_controller = MailSlurpClient::InboxControllerApi.new
+    # create an inbox with tags
+    inbox = inbox_controller.create_inbox_with_options({
+      tags: ['t1','t2'],
+      description: "test with tags",
+      name: "test name"
+    })
+
+    # has tags
+    expect(inbox.id).to be_truthy
+    expect(inbox.description).to be_truthy
+    expect(inbox.name).to be_truthy
+    expect(inbox.tags).to include('t1')
+    expect(inbox.tags).to include('t2')
+
+    # can update tags
+    inbox_updated = inbox_controller.update_inbox(inbox.id, {
+      tags: ['newtag']
+    })
+    expect(inbox_updated.tags).to eq(['newtag'])
+end
+```
+
 ### List inboxes
 
 Inboxes you create can be listed in a paginated way.
@@ -234,7 +263,7 @@ email = wait_controller.wait_for_latest_email(wait_opts)
 # find the attachments on the email object
 expect(email.attachments.size).to be(1)
 
-# download the attachment
+# download the attachment as base64 (easier than byte arrays for ruby client)
 email_controller = MailSlurpClient::EmailControllerApi.new
 downloaded_attachment = email_controller.download_attachment_base64(email.attachments[0], email.id)
 

data/lib/mailslurp_client.rb

@@ -17,19 +17,24 @@ 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/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_owned_alias_options'
+require 'mailslurp_client/models/create_inbox_dto'
 require 'mailslurp_client/models/create_template_options'
 require 'mailslurp_client/models/create_webhook_options'
+require 'mailslurp_client/models/dns_lookup_options'
+require 'mailslurp_client/models/dns_lookup_result'
+require 'mailslurp_client/models/dns_lookup_results'
 require 'mailslurp_client/models/describe_domain_options'
 require 'mailslurp_client/models/describe_mail_server_domain_result'
 require 'mailslurp_client/models/domain_dto'
@@ -46,6 +51,7 @@ require 'mailslurp_client/models/group_contacts_dto'
 require 'mailslurp_client/models/group_dto'
 require 'mailslurp_client/models/group_projection'
 require 'mailslurp_client/models/html_validation_result'
+require 'mailslurp_client/models/ip_address_result'
 require 'mailslurp_client/models/inbox'
 require 'mailslurp_client/models/inbox_projection'
 require 'mailslurp_client/models/match_option'
@@ -63,6 +69,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'
@@ -73,6 +80,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,93 +19,31 @@ 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
-    # @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
-    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
-    # @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 = {})
-      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"
-      end
-      # resource path
-      local_var_path = '/aliases'
-
-      # 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_owned_alias_options) 
-
-      # 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(:POST, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: AliasControllerApi#create_alias\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Create an anonymous email alias
-    # @param create_anonymous_alias_options [CreateAnonymousAliasOptions] createAnonymousAliasOptions
+    # 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 [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)
+    def create_alias(create_alias_options, opts = {})
+      data, _status_code, _headers = create_alias_with_http_info(create_alias_options, opts)
       data
     end
 
-    # Create an anonymous email alias
-    # @param create_anonymous_alias_options [CreateAnonymousAliasOptions] createAnonymousAliasOptions
+    # 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<(ModelAlias, Integer, Hash)>] ModelAlias data, response status code and response headers
-    def create_anonymous_alias_with_http_info(create_anonymous_alias_options, opts = {})
+    def create_alias_with_http_info(create_alias_options, 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.create_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 '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/anonymous'
+      local_var_path = '/aliases'
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -121,7 +59,7 @@ module MailSlurpClient
       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] || @api_client.object_to_http_body(create_alias_options) 
 
       # return_type
       return_type = opts[:return_type] || 'ModelAlias' 
@@ -140,12 +78,12 @@ module MailSlurpClient
 
       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: AliasControllerApi#create_anonymous_alias\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: AliasControllerApi#create_alias\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Delete an owned alias
+    # Delete an email alias
     # @param alias_id [String] aliasId
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -154,7 +92,7 @@ module MailSlurpClient
       nil
     end
 
-    # Delete an owned alias
+    # Delete an email alias
     # @param alias_id [String] aliasId
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -207,7 +145,7 @@ module MailSlurpClient
     # Get an email alias by ID
     # @param alias_id [String] aliasId
     # @param [Hash] opts the optional parameters
-    # @return [ModelAlias]
+    # @return [AliasDto]
     def get_alias(alias_id, opts = {})
       data, _status_code, _headers = get_alias_with_http_info(alias_id, opts)
       data
@@ -217,7 +155,7 @@ module MailSlurpClient
     # Get an email alias by ID
     # @param alias_id [String] aliasId
     # @param [Hash] opts the optional parameters
-    # @return [Array<(ModelAlias, Integer, Hash)>] ModelAlias data, response status code and response headers
+    # @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.get_alias ...'
@@ -244,7 +182,7 @@ module MailSlurpClient
       post_body = opts[:body] 
 
       # return_type
-      return_type = opts[:return_type] || 'ModelAlias' 
+      return_type = opts[:return_type] || 'AliasDto' 
 
       # auth_names
       auth_names = opts[:auth_names] || ['API_KEY']
@@ -265,7 +203,7 @@ module MailSlurpClient
       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 +215,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 +272,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 +295,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 +316,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/domain_controller_api.rb

@@ -87,17 +87,17 @@ module MailSlurpClient
     # Delete a domain. This will disable any existing inboxes that use this domain.
     # @param id [String] id
     # @param [Hash] opts the optional parameters
-    # @return [nil]
+    # @return [Array<String>]
     def delete_domain(id, opts = {})
-      delete_domain_with_http_info(id, opts)
-      nil
+      data, _status_code, _headers = delete_domain_with_http_info(id, opts)
+      data
     end
 
     # Delete a domain
     # Delete a domain. This will disable any existing inboxes that use this domain.
     # @param id [String] id
     # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    # @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
     def delete_domain_with_http_info(id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: DomainControllerApi.delete_domain ...'
@@ -114,6 +114,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] || {}
@@ -122,7 +124,7 @@ module MailSlurpClient
       post_body = opts[:body] 
 
       # return_type
-      return_type = opts[:return_type] 
+      return_type = opts[:return_type] || 'Array<String>' 
 
       # auth_names
       auth_names = opts[:auth_names] || ['API_KEY']

data/lib/mailslurp_client/api/email_controller_api.rb

@@ -675,7 +675,7 @@ module MailSlurpClient
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :inbox_id Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
     # @option opts [Integer] :page Optional page index in email list pagination (default to 0)
-    # @option opts [Integer] :size Optional page size in email list pagination (default to 20)
+    # @option opts [Integer] :size Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (default to 20)
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
     # @option opts [Boolean] :unread_only Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (default to false)
     # @return [PageEmailProjection]
@@ -689,7 +689,7 @@ module MailSlurpClient
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :inbox_id Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
     # @option opts [Integer] :page Optional page index in email list pagination
-    # @option opts [Integer] :size Optional page size in email list pagination
+    # @option opts [Integer] :size Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
     # @option opts [Boolean] :unread_only Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly
     # @return [Array<(PageEmailProjection, Integer, Hash)>] PageEmailProjection data, response status code and response headers
@@ -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 &#x60;to&#x60;, &#x60;cc&#x60;, and &#x60;bcc&#x60;.
+    # @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