mailslurp_client 8.2.14 → 8.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 885a47966c945561dd2f0d6ded52689c21a44d055877e7ce1c6298cbfc7b6e43
-  data.tar.gz: a30ae7021cefd27456e10ff7503e6674ee45e822bf9c826c69289faec89133ba
+  metadata.gz: 73a7a6bce5d2930743647f53b1b93e19ea81179b32de56b6bd3c7a0d4ca84e62
+  data.tar.gz: 6f02b97e47c2f56c52e9c0eb68351c5a24b7b646b56dd0cdd7ac4efd4bf82801
 SHA512:
-  metadata.gz: f91f21f8d50b6c154ae5a2240554734dce8c922c5e213f3a9a402959c286008a53b9c47f16da51e8e95c2d06ab3fb83f946324ccbba47281c0eb1237f15cba15
-  data.tar.gz: 69b0b31c1248e8660446d0eb35328bd659a80080c1b62cfd0bb79f08366ff422a9064e33b48d7a2770dd5ac4f1ce3da27731487c43adf117700e029ea572d014
+  metadata.gz: 819cfdb8b68c76a89130bef694eaabd2db78e98d1205f7258fb1bee9f1696ca751bcc2a9c50099779a24110997f27f559b2632b1bc0a6292416b4f6fafdad65b
+  data.tar.gz: d878ffa757ae2fd463ac0b5a59db2ae7433abf85925186d21ba780b0cd73c23b648759b3a010f08dfe630a999bddf2a503a7f08deba97ed2a46f26246e7136fc

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

@@ -27,9 +27,13 @@ require 'mailslurp_client/models/create_anonymous_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'
+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 +50,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'

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

data/lib/mailslurp_client/api/inbox_controller_api.rb

@@ -93,6 +93,70 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Create an inbox with additional options
+    # Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients.
+    # @param create_inbox_dto [CreateInboxDto] createInboxDto
+    # @param [Hash] opts the optional parameters
+    # @return [Inbox]
+    def create_inbox_with_options(create_inbox_dto, opts = {})
+      data, _status_code, _headers = create_inbox_with_options_with_http_info(create_inbox_dto, opts)
+      data
+    end
+
+    # Create an inbox with additional options
+    # Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients.
+    # @param create_inbox_dto [CreateInboxDto] createInboxDto
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Inbox, Integer, Hash)>] Inbox data, response status code and response headers
+    def create_inbox_with_options_with_http_info(create_inbox_dto, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxControllerApi.create_inbox_with_options ...'
+      end
+      # verify the required parameter 'create_inbox_dto' is set
+      if @api_client.config.client_side_validation && create_inbox_dto.nil?
+        fail ArgumentError, "Missing the required parameter 'create_inbox_dto' when calling InboxControllerApi.create_inbox_with_options"
+      end
+      # resource path
+      local_var_path = '/inboxes/withOptions'
+
+      # 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_inbox_dto) 
+
+      # return_type
+      return_type = opts[:return_type] || 'Inbox' 
+
+      # 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#create_inbox_with_options\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Delete all inboxes
     # Permanently delete all inboxes and associated email addresses. This will also delete all emails within the inboxes. Be careful as inboxes cannot be recovered once deleted. Note: deleting inboxes will not impact your usage limits. Monthly inbox creation limits are based on how many inboxes were created in the last 30 days, not how many inboxes you currently have.
     # @param [Hash] opts the optional parameters
@@ -207,8 +271,8 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # List Inboxes Paginated
-    # List inboxes in paginated form. Allows for page index, page size, and sort direction. Can also filter by favourited or email address like pattern.
+    # List All Inboxes Paginated
+    # List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return(, and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results.
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :favourite Optionally filter results for favourites only (default to false)
     # @option opts [Integer] :page Optional page index in inbox list pagination (default to 0)
@@ -222,8 +286,8 @@ module MailSlurpClient
       data
     end
 
-    # List Inboxes Paginated
-    # List inboxes in paginated form. Allows for page index, page size, and sort direction. Can also filter by favourited or email address like pattern.
+    # List All Inboxes Paginated
+    # List inboxes in paginated form. The results are available on the &#x60;content&#x60; property of the returned object. This method allows for page index (zero based), page size (how many results to return(, and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative &#x60;getInboxes&#x60; method returns a full list of inboxes but is limited to 100 results.
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :favourite Optionally filter results for favourites only
     # @option opts [Integer] :page Optional page index in inbox list pagination
@@ -285,14 +349,15 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get emails in an Inbox
+    # Get emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead.
     # List emails that an inbox has received. Only emails that are sent to the inbox's email address will appear in the inbox. It may take several seconds for any email you send to an inbox's email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the `minCount` parameter. The server will retry the inbox database until the `minCount` is satisfied or the `retryTimeout` is reached
     # @param inbox_id [String] Id of inbox that emails belongs to
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :limit Limit the result set, ordered by received date time sort direction
+    # @option opts [Integer] :limit Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller
     # @option opts [Integer] :min_count Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached.
     # @option opts [Integer] :retry_timeout Maximum milliseconds to spend retrying inbox database until minCount emails are returned
     # @option opts [DateTime] :since Exclude emails received before this ISO 8601 date time
+    # @option opts [Integer] :size Alias for limit. Assessed first before assessing any passed limit.
     # @option opts [String] :sort Sort the results by received date and direction ASC or DESC
     # @return [Array<EmailPreview>]
     def get_emails(inbox_id, opts = {})
@@ -300,14 +365,15 @@ module MailSlurpClient
       data
     end
 
-    # Get emails in an Inbox
+    # Get emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead.
     # List emails that an inbox has received. Only emails that are sent to the inbox&#39;s email address will appear in the inbox. It may take several seconds for any email you send to an inbox&#39;s email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the &#x60;minCount&#x60; parameter. The server will retry the inbox database until the &#x60;minCount&#x60; is satisfied or the &#x60;retryTimeout&#x60; is reached
     # @param inbox_id [String] Id of inbox that emails belongs to
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :limit Limit the result set, ordered by received date time sort direction
+    # @option opts [Integer] :limit Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller
     # @option opts [Integer] :min_count Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached.
     # @option opts [Integer] :retry_timeout Maximum milliseconds to spend retrying inbox database until minCount emails are returned
     # @option opts [DateTime] :since Exclude emails received before this ISO 8601 date time
+    # @option opts [Integer] :size Alias for limit. Assessed first before assessing any passed limit.
     # @option opts [String] :sort Sort the results by received date and direction ASC or DESC
     # @return [Array<(Array<EmailPreview>, Integer, Hash)>] Array<EmailPreview> data, response status code and response headers
     def get_emails_with_http_info(inbox_id, opts = {})
@@ -331,6 +397,7 @@ module MailSlurpClient
       query_params[:'minCount'] = opts[:'min_count'] if !opts[:'min_count'].nil?
       query_params[:'retryTimeout'] = opts[:'retry_timeout'] if !opts[:'retry_timeout'].nil?
       query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
+      query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
       query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
 
       # header parameters
@@ -635,8 +702,10 @@ module MailSlurpClient
     end
 
     # List Inboxes / Email Addresses
-    # List the inboxes you have created
+    # List the inboxes you have created. Note use of the more advanced `getAllEmails` is recommended. You can provide a limit and sort parameter.
     # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :size Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated &#x60;getAllEmails&#x60; for larger queries. (default to 100)
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
     # @return [Array<Inbox>]
     def get_inboxes(opts = {})
       data, _status_code, _headers = get_inboxes_with_http_info(opts)
@@ -644,18 +713,26 @@ module MailSlurpClient
     end
 
     # List Inboxes / Email Addresses
-    # List the inboxes you have created
+    # List the inboxes you have created. Note use of the more advanced &#x60;getAllEmails&#x60; is recommended. You can provide a limit and sort parameter.
     # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :size Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated &#x60;getAllEmails&#x60; for larger queries.
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
     # @return [Array<(Array<Inbox>, Integer, Hash)>] Array<Inbox> data, response status code and response headers
     def get_inboxes_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inboxes ...'
       end
+      allowable_values = ["ASC", "DESC"]
+      if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
+        fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
+      end
       # resource path
       local_var_path = '/inboxes'
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/mailslurp_client/api/mail_server_controller_api.rb

@@ -81,6 +81,129 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Lookup DNS records for a domain
+    # @param dns_lookup_options [DNSLookupOptions] dnsLookupOptions
+    # @param [Hash] opts the optional parameters
+    # @return [DNSLookupResults]
+    def get_dns_lookup(dns_lookup_options, opts = {})
+      data, _status_code, _headers = get_dns_lookup_with_http_info(dns_lookup_options, opts)
+      data
+    end
+
+    # Lookup DNS records for a domain
+    # @param dns_lookup_options [DNSLookupOptions] dnsLookupOptions
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DNSLookupResults, Integer, Hash)>] DNSLookupResults data, response status code and response headers
+    def get_dns_lookup_with_http_info(dns_lookup_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MailServerControllerApi.get_dns_lookup ...'
+      end
+      # verify the required parameter 'dns_lookup_options' is set
+      if @api_client.config.client_side_validation && dns_lookup_options.nil?
+        fail ArgumentError, "Missing the required parameter 'dns_lookup_options' when calling MailServerControllerApi.get_dns_lookup"
+      end
+      # resource path
+      local_var_path = '/mail-server/describe/dns-lookup'
+
+      # 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(dns_lookup_options) 
+
+      # return_type
+      return_type = opts[:return_type] || 'DNSLookupResults' 
+
+      # 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: MailServerControllerApi#get_dns_lookup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get IP address for a domain
+    # @param name [String] name
+    # @param [Hash] opts the optional parameters
+    # @return [IPAddressResult]
+    def get_ip_address(name, opts = {})
+      data, _status_code, _headers = get_ip_address_with_http_info(name, opts)
+      data
+    end
+
+    # Get IP address for a domain
+    # @param name [String] name
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IPAddressResult, Integer, Hash)>] IPAddressResult data, response status code and response headers
+    def get_ip_address_with_http_info(name, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MailServerControllerApi.get_ip_address ...'
+      end
+      # verify the required parameter 'name' is set
+      if @api_client.config.client_side_validation && name.nil?
+        fail ArgumentError, "Missing the required parameter 'name' when calling MailServerControllerApi.get_ip_address"
+      end
+      # resource path
+      local_var_path = '/mail-server/describe/ip-address'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'name'] = name
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'IPAddressResult' 
+
+      # 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: MailServerControllerApi#get_ip_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Verify the existence of an email address at a given mail server.
     # @param verify_options [VerifyEmailAddressOptions] verifyOptions
     # @param [Hash] opts the optional parameters