mailslurp_client 13.0.1 → 14.0.2

data/lib/mailslurp_client/api/wait_for_controller_api.rb

@@ -1,7 +1,7 @@
 =begin
 #MailSlurp API
 
-#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more.  ## Resources  - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository 
+#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more.  ## Resources  - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
 
 The version of the OpenAPI document: 6.5.2
 
@@ -82,6 +82,7 @@ module MailSlurpClient
     # Wait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs
     # If inbox contains count or more emails at time of request then return count worth of emails. If not wait until the count is reached and return those or return an error if timeout is exceeded.
     # @param [Hash] opts the optional parameters
+    # @option opts [DateTime] :before Filter for emails that were received before the given timestamp
     # @option opts [Integer] :count Number of emails to wait for. Must be greater that 1
     # @option opts [Integer] :delay Max milliseconds delay between calls
     # @option opts [String] :inbox_id Id of the inbox we are fetching emails from
@@ -98,6 +99,7 @@ module MailSlurpClient
     # Wait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs
     # If inbox contains count or more emails at time of request then return count worth of emails. If not wait until the count is reached and return those or return an error if timeout is exceeded.
     # @param [Hash] opts the optional parameters
+    # @option opts [DateTime] :before Filter for emails that were received before the given timestamp
     # @option opts [Integer] :count Number of emails to wait for. Must be greater that 1
     # @option opts [Integer] :delay Max milliseconds delay between calls
     # @option opts [String] :inbox_id Id of the inbox we are fetching emails from
@@ -119,6 +121,7 @@ module MailSlurpClient
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
       query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
       query_params[:'delay'] = opts[:'delay'] if !opts[:'delay'].nil?
       query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
@@ -163,6 +166,7 @@ module MailSlurpClient
     # Fetch inbox's latest email or if empty wait for an email to arrive
     # Will return either the last received email or wait for an email to arrive and return that. If you need to wait for an email for a non-empty inbox set `unreadOnly=true` or see the other receive methods such as `waitForNthEmail` or `waitForEmailCount`.
     # @param [Hash] opts the optional parameters
+    # @option opts [DateTime] :before Filter for emails that were before after the given timestamp
     # @option opts [Integer] :delay Max milliseconds delay between calls
     # @option opts [String] :inbox_id Id of the inbox we are fetching emails from
     # @option opts [DateTime] :since Filter for emails that were received after the given timestamp
@@ -178,6 +182,7 @@ module MailSlurpClient
     # Fetch inbox's latest email or if empty wait for an email to arrive
     # Will return either the last received email or wait for an email to arrive and return that. If you need to wait for an email for a non-empty inbox set `unreadOnly=true` or see the other receive methods such as `waitForNthEmail` or `waitForEmailCount`.
     # @param [Hash] opts the optional parameters
+    # @option opts [DateTime] :before Filter for emails that were before after the given timestamp
     # @option opts [Integer] :delay Max milliseconds delay between calls
     # @option opts [String] :inbox_id Id of the inbox we are fetching emails from
     # @option opts [DateTime] :since Filter for emails that were received after the given timestamp
@@ -198,6 +203,7 @@ module MailSlurpClient
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
       query_params[:'delay'] = opts[:'delay'] if !opts[:'delay'].nil?
       query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
       query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
@@ -242,6 +248,7 @@ module MailSlurpClient
     # Perform a search of emails in an inbox with the given patterns. If results match expected count then return or else retry the search until results are found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the `MatchOptions` object for options. An example payload is `{ matches: [{field: 'SUBJECT',should:'CONTAIN',value:'needle'}] }`. You can use an array of matches and they will be applied sequentially to filter out emails. If you want to perform matches and extractions of content using Regex patterns see the EmailController `getEmailContentMatch` method.
     # @param match_options [MatchOptions] matchOptions
     # @param [Hash] opts the optional parameters
+    # @option opts [DateTime] :before Filter for emails that were received before the given timestamp
     # @option opts [Integer] :count Number of emails to wait for. Must be greater or equal to 1
     # @option opts [Integer] :delay Max milliseconds delay between calls
     # @option opts [String] :inbox_id Id of the inbox we are fetching emails from
@@ -250,8 +257,8 @@ module MailSlurpClient
     # @option opts [Integer] :timeout Max milliseconds to wait
     # @option opts [Boolean] :unread_only Optional filter for unread only (default to false)
     # @return [Array<EmailPreview>]
-    def wait_for_matching_email(match_options, opts = {})
-      data, _status_code, _headers = wait_for_matching_email_with_http_info(match_options, opts)
+    def wait_for_matching_emails(match_options, opts = {})
+      data, _status_code, _headers = wait_for_matching_emails_with_http_info(match_options, opts)
       data
     end
 
@@ -259,6 +266,7 @@ module MailSlurpClient
     # Perform a search of emails in an inbox with the given patterns. If results match expected count then return or else retry the search until results are found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the &#x60;MatchOptions&#x60; object for options. An example payload is &#x60;{ matches: [{field: &#39;SUBJECT&#39;,should:&#39;CONTAIN&#39;,value:&#39;needle&#39;}] }&#x60;. You can use an array of matches and they will be applied sequentially to filter out emails. If you want to perform matches and extractions of content using Regex patterns see the EmailController &#x60;getEmailContentMatch&#x60; method.
     # @param match_options [MatchOptions] matchOptions
     # @param [Hash] opts the optional parameters
+    # @option opts [DateTime] :before Filter for emails that were received before the given timestamp
     # @option opts [Integer] :count Number of emails to wait for. Must be greater or equal to 1
     # @option opts [Integer] :delay Max milliseconds delay between calls
     # @option opts [String] :inbox_id Id of the inbox we are fetching emails from
@@ -267,13 +275,13 @@ module MailSlurpClient
     # @option opts [Integer] :timeout Max milliseconds to wait
     # @option opts [Boolean] :unread_only Optional filter for unread only
     # @return [Array<(Array<EmailPreview>, Integer, Hash)>] Array<EmailPreview> data, response status code and response headers
-    def wait_for_matching_email_with_http_info(match_options, opts = {})
+    def wait_for_matching_emails_with_http_info(match_options, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: WaitForControllerApi.wait_for_matching_email ...'
+        @api_client.config.logger.debug 'Calling API: WaitForControllerApi.wait_for_matching_emails ...'
       end
       # verify the required parameter 'match_options' is set
       if @api_client.config.client_side_validation && match_options.nil?
-        fail ArgumentError, "Missing the required parameter 'match_options' when calling WaitForControllerApi.wait_for_matching_email"
+        fail ArgumentError, "Missing the required parameter 'match_options' when calling WaitForControllerApi.wait_for_matching_emails"
       end
       allowable_values = ["ASC", "DESC"]
       if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
@@ -284,6 +292,7 @@ module MailSlurpClient
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
       query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
       query_params[:'delay'] = opts[:'delay'] if !opts[:'delay'].nil?
       query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
@@ -322,7 +331,7 @@ 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: WaitForControllerApi#wait_for_matching_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: WaitForControllerApi#wait_for_matching_emails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
@@ -331,6 +340,7 @@ module MailSlurpClient
     # Perform a search of emails in an inbox with the given patterns. If a result if found then return or else retry the search until a result is found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the `MatchOptions` object for options. An example payload is `{ matches: [{field: 'SUBJECT',should:'CONTAIN',value:'needle'}] }`. You can use an array of matches and they will be applied sequentially to filter out emails. If you want to perform matches and extractions of content using Regex patterns see the EmailController `getEmailContentMatch` method.
     # @param match_options [MatchOptions] matchOptions
     # @param [Hash] opts the optional parameters
+    # @option opts [DateTime] :before Filter for emails that were received before the given timestamp
     # @option opts [Integer] :delay Max milliseconds delay between calls
     # @option opts [String] :inbox_id Id of the inbox we are matching an email for
     # @option opts [DateTime] :since Filter for emails that were received after the given timestamp
@@ -347,6 +357,7 @@ module MailSlurpClient
     # Perform a search of emails in an inbox with the given patterns. If a result if found then return or else retry the search until a result is found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the &#x60;MatchOptions&#x60; object for options. An example payload is &#x60;{ matches: [{field: &#39;SUBJECT&#39;,should:&#39;CONTAIN&#39;,value:&#39;needle&#39;}] }&#x60;. You can use an array of matches and they will be applied sequentially to filter out emails. If you want to perform matches and extractions of content using Regex patterns see the EmailController &#x60;getEmailContentMatch&#x60; method.
     # @param match_options [MatchOptions] matchOptions
     # @param [Hash] opts the optional parameters
+    # @option opts [DateTime] :before Filter for emails that were received before the given timestamp
     # @option opts [Integer] :delay Max milliseconds delay between calls
     # @option opts [String] :inbox_id Id of the inbox we are matching an email for
     # @option opts [DateTime] :since Filter for emails that were received after the given timestamp
@@ -371,6 +382,7 @@ module MailSlurpClient
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
       query_params[:'delay'] = opts[:'delay'] if !opts[:'delay'].nil?
       query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
       query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
@@ -416,6 +428,7 @@ module MailSlurpClient
     # Wait for or fetch the email with a given index in the inbox specified. If index doesn't exist waits for it to exist or timeout to occur.
     # If nth email is already present in inbox then return it. If not hold the connection open until timeout expires or the nth email is received and returned.
     # @param [Hash] opts the optional parameters
+    # @option opts [DateTime] :before Filter for emails that were received before the given timestamp
     # @option opts [Integer] :delay Max milliseconds delay between calls
     # @option opts [String] :inbox_id Id of the inbox you are fetching emails from
     # @option opts [Integer] :index Zero based index of the email to wait for. If an inbox has 1 email already and you want to wait for the 2nd email pass index&#x3D;1 (default to 0)
@@ -432,6 +445,7 @@ module MailSlurpClient
     # Wait for or fetch the email with a given index in the inbox specified. If index doesn&#39;t exist waits for it to exist or timeout to occur.
     # If nth email is already present in inbox then return it. If not hold the connection open until timeout expires or the nth email is received and returned.
     # @param [Hash] opts the optional parameters
+    # @option opts [DateTime] :before Filter for emails that were received before the given timestamp
     # @option opts [Integer] :delay Max milliseconds delay between calls
     # @option opts [String] :inbox_id Id of the inbox you are fetching emails from
     # @option opts [Integer] :index Zero based index of the email to wait for. If an inbox has 1 email already and you want to wait for the 2nd email pass index&#x3D;1
@@ -453,6 +467,7 @@ module MailSlurpClient
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
       query_params[:'delay'] = opts[:'delay'] if !opts[:'delay'].nil?
       query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
       query_params[:'index'] = opts[:'index'] if !opts[:'index'].nil?