mailslurp_client 7.0.7 → 7.0.8

data/docs/SimpleSendEmailOptions.md

@@ -0,0 +1,23 @@
+# MailSlurpClient::SimpleSendEmailOptions
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**body** | **String** | Body of the email message. Supports HTML | [optional] 
+**sender_id** | **String** | ID of inbox to send from | [optional] 
+**subject** | **String** | Subject line of the email | [optional] 
+**to** | **String** | Email address to send to | [optional] 
+
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::SimpleSendEmailOptions.new(body: null,
+                                 sender_id: null,
+                                 subject: null,
+                                 to: null)
+```
+
+

data/docs/ValidationDto.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**email_id** | **String** |  | 
-**html** | [**HTMLValidationResult**](HTMLValidationResult.md) |  | 
+**email_id** | **String** | ID of the email validated | [optional] 
+**html** | [**HTMLValidationResult**](HTMLValidationResult.md) |  | [optional] 
 
 ## Code Sample
 

data/docs/WaitForConditions.md

@@ -4,13 +4,13 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**count** | **Integer** | Number of results that should match conditions | [optional] 
-**count_type** | **String** | Should exactly count number of results be returned or at least that many. | [optional] 
-**inbox_id** | **String** | Inbox to search within | [optional] 
-**matches** | [**Array<MatchOption>**](MatchOption.md) | Conditions that should be matched | [optional] 
+**count** | **Integer** | Number of results that should match conditions. Either exactly or at least this amount based on the `countType`. If count condition is not met and the timeout has not been reached the `waitFor` method will retry the operation. | [optional] 
+**count_type** | **String** | How should the found count be compared to the expected count. | [optional] 
+**inbox_id** | **String** | ID of inbox to search within and apply conditions to. Essentially filtering the emails found to give a count. | [optional] 
+**matches** | [**Array<MatchOption>**](MatchOption.md) | Conditions that should be matched for an email to qualify for results. Each condition will be applied in order to each email within an inbox to filter a result list of matching emails you are waiting for. | [optional] 
 **sort_direction** | **String** | Direction to sort matching emails by created time | [optional] 
-**timeout** | **Integer** | Max time in milliseconds to wait until conditions are met | [optional] 
-**unread_only** | **Boolean** | Apply only to unread emails | [optional] 
+**timeout** | **Integer** | Max time in milliseconds to retry the `waitFor` operation until conditions are met. | [optional] 
+**unread_only** | **Boolean** | Apply conditions only to **unread** emails. All emails begin with `read=false`. An email is marked `read=true` when an `EmailDto` representation of it has been returned to the user at least once. For example you have called `getEmail` or `waitForLatestEmail` etc., or you have viewed the email in the dashboard.  | [optional] 
 
 ## Code Sample
 

data/docs/WaitForControllerApi.md

@@ -136,7 +136,7 @@ Name | Type | Description  | Notes
 
 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 see the other receive methods such as waitForNthEmail or waitForEmailCount.
+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`.
 
 ### Example
 
@@ -155,7 +155,7 @@ api_instance = MailSlurpClient::WaitForControllerApi.new
 opts = {
   inbox_id: 'inbox_id_example', # String | Id of the inbox we are fetching emails from
   timeout: 56, # Integer | Max milliseconds to wait
-  unread_only: false # Boolean | Optional filter for unread only
+  unread_only: false # Boolean | Optional filter for unread only.
 }
 
 begin
@@ -174,7 +174,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **inbox_id** | [**String**](.md)| Id of the inbox we are fetching emails from | [optional] 
  **timeout** | **Integer**| Max milliseconds to wait | [optional] 
- **unread_only** | **Boolean**| Optional filter for unread only | [optional] [default to false]
+ **unread_only** | **Boolean**| Optional filter for unread only. | [optional] [default to false]
 
 ### Return type
 

data/lib/mailslurp_client.rb

@@ -3,7 +3,7 @@
 
 #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: 67c9a1eda264be4cfe0bb2c76151f0aadf0862bc
+The version of the OpenAPI document: d1659dc1567a5b62f65d0612107a50aace03e085
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.2.3
@@ -22,9 +22,11 @@ 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/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_owned_alias_options'
 require 'mailslurp_client/models/create_template_options'
 require 'mailslurp_client/models/create_webhook_options'
 require 'mailslurp_client/models/domain_dto'
@@ -43,6 +45,8 @@ require 'mailslurp_client/models/inbox_projection'
 require 'mailslurp_client/models/json_node'
 require 'mailslurp_client/models/match_option'
 require 'mailslurp_client/models/match_options'
+require 'mailslurp_client/models/model_alias'
+require 'mailslurp_client/models/page_alias'
 require 'mailslurp_client/models/page_contact_projection'
 require 'mailslurp_client/models/page_email_preview'
 require 'mailslurp_client/models/page_email_projection'
@@ -54,6 +58,7 @@ require 'mailslurp_client/models/pageable'
 require 'mailslurp_client/models/raw_email_json'
 require 'mailslurp_client/models/send_email_options'
 require 'mailslurp_client/models/set_inbox_favourited_options'
+require 'mailslurp_client/models/simple_send_email_options'
 require 'mailslurp_client/models/sort'
 require 'mailslurp_client/models/template_dto'
 require 'mailslurp_client/models/template_projection'
@@ -72,12 +77,14 @@ require 'mailslurp_client/models/webhook_test_response'
 require 'mailslurp_client/models/webhook_test_result'
 
 # APIs
+require 'mailslurp_client/api/alias_controller_api'
 require 'mailslurp_client/api/attachment_controller_api'
 require 'mailslurp_client/api/bulk_actions_controller_api'
 require 'mailslurp_client/api/common_actions_controller_api'
 require 'mailslurp_client/api/contact_controller_api'
 require 'mailslurp_client/api/domain_controller_api'
 require 'mailslurp_client/api/email_controller_api'
+require 'mailslurp_client/api/form_controller_api'
 require 'mailslurp_client/api/group_controller_api'
 require 'mailslurp_client/api/inbox_controller_api'
 require 'mailslurp_client/api/template_controller_api'

data/lib/mailslurp_client/api/alias_controller_api.rb

@@ -0,0 +1,405 @@
+=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 
+
+The version of the OpenAPI document: d1659dc1567a5b62f65d0612107a50aace03e085
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.3
+
+=end
+
+require 'cgi'
+
+module MailSlurpClient
+  class AliasControllerApi
+    attr_accessor :api_client
+
+    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
+    # @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
+    end
+
+    # Create an anonymous email alias
+    # @param create_anonymous_alias_options [CreateAnonymousAliasOptions] createAnonymousAliasOptions
+    # @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 = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AliasControllerApi.create_anonymous_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"
+      end
+      # resource path
+      local_var_path = '/aliases/anonymous'
+
+      # 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) 
+
+      # return_type
+      return_type = opts[:return_type] || 'ModelAlias' 
+
+      # 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_anonymous_alias\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete an owned alias
+    # @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
+    end
+
+    # Delete an owned alias
+    # @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 = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AliasControllerApi.delete_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"
+      end
+      # resource path
+      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] || {}
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # 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(:DELETE, 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}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get an email alias
+    # Get an email alias by ID
+    # @param alias_id [String] aliasId
+    # @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)
+      data
+    end
+
+    # Get an email alias
+    # 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
+    def get_alias_with_http_info(alias_id, opts = {})
+      if @api_client.config.debugging
+        @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.get_alias"
+      end
+      # resource path
+      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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'ModelAlias' 
+
+      # 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: AliasControllerApi#get_alias\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get all email aliases
+    # 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)
+    # @option opts [Integer] :size Optional page size in alias list pagination (default to 20)
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
+    # @return [PageAlias]
+    def get_aliases(opts = {})
+      data, _status_code, _headers = get_aliases_with_http_info(opts)
+      data
+    end
+
+    # Get all email aliases
+    # Get all email aliases in paginated form
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Optional page index in alias list pagination
+    # @option opts [Integer] :size Optional page size in alias list pagination
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
+    # @return [Array<(PageAlias, Integer, Hash)>] PageAlias data, response status code and response headers
+    def get_aliases_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AliasControllerApi.get_aliases ...'
+      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 = '/aliases'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      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] || {}
+      # 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] || 'PageAlias' 
+
+      # 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: AliasControllerApi#get_aliases\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update an owned alias
+    # @param alias_id [String] aliasId
+    # @param create_owned_alias_options [CreateOwnedAliasOptions] createOwnedAliasOptions
+    # @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)
+      nil
+    end
+
+    # Update an owned alias
+    # @param alias_id [String] aliasId
+    # @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 update_alias_with_http_info(alias_id, create_owned_alias_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AliasControllerApi.update_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.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"
+      end
+      # resource path
+      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_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(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AliasControllerApi#update_alias\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end