mailslurp_client 12.1.27 → 12.1.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74428eeba00a17f2f1d9b1d2add70dbd36973719d15c62bb0bc197c67adb00d7
-  data.tar.gz: fb52f5bd0d962e1ad5bcbd9d117df2d78334f949405194b1babcdc7c95076036
+  metadata.gz: 283f8dec3e07d1960fdd61c107710610a6cdc78f2b11014d287e39d8e272a5f0
+  data.tar.gz: 75a9a47151a8e94c37291467007ebbee99df129fc2ff0c00e311fb9a58f51229
 SHA512:
-  metadata.gz: d82a8c604966d77ea1a321aad3932ec997872dbe4d0289552379764943076ace318501f54f4cac13d400b194949634587055fbcd74adea4dd52baf96c32beb36
-  data.tar.gz: 768f84d44aef1b10f9271d250478b40b050d4e309ce4166cb3ace2ee999d0b4616d69c4e873a87ca011b20ae803be864f25a707f355bd8ff8a22f7290697f5d8
+  metadata.gz: b38d78563f534945d5bad5ab59589464fb2942074ceed834543dff19d32471dd8c40ebbe4fb8e6c9a3a4a6425bb7a6c51c15d0f2587e7248339506f501e352a5
+  data.tar.gz: 4c91cb836a0760920baa12d23d98a328cb24dc50610f778c8755dffa677bd61d83814a1078a21c2bd8f556cb46fa11672f6fe8e9d9a254f864e9387d6489f5bf

data/README.md

@@ -126,6 +126,9 @@ it 'can an inbox with tags' do
 end
 ```
 
+#### Inbox types
+Inboxes can be either `SMTP` or `HTTP` type. Set the inbox type using the `inboxType` property. SMTP inboxes are handled by a custom mailserver and support a wide range of clients while HTTP inboxes use Amazon SES and don't support some older clients like Outlook. SMTP inboxes are recommended for public facing email addresses while HTTP inboxes are best for application testing. Please see the guide on [types of inboxes](https://www.mailslurp.com/guides/smtp-vs-http-email-inboxes/) for more information.
+
 ### List inboxes
 
 Inboxes you create can be listed in a paginated way using the [InboxController](https://www.mailslurp.com/docs/ruby/docs/InboxControllerApi/)).

data/lib/mailslurp_client.rb

@@ -54,6 +54,8 @@ require 'mailslurp_client/models/email_verification_result'
 require 'mailslurp_client/models/expiration_defaults'
 require 'mailslurp_client/models/expired_inbox_dto'
 require 'mailslurp_client/models/expired_inbox_record_projection'
+require 'mailslurp_client/models/export_link'
+require 'mailslurp_client/models/export_options'
 require 'mailslurp_client/models/forward_email_options'
 require 'mailslurp_client/models/group_contacts_dto'
 require 'mailslurp_client/models/group_dto'
@@ -83,6 +85,7 @@ require 'mailslurp_client/models/page_sent_email_projection'
 require 'mailslurp_client/models/page_template_projection'
 require 'mailslurp_client/models/page_thread_projection'
 require 'mailslurp_client/models/page_webhook_projection'
+require 'mailslurp_client/models/page_webhook_result'
 require 'mailslurp_client/models/pageable'
 require 'mailslurp_client/models/raw_email_json'
 require 'mailslurp_client/models/reply_to_alias_email_options'
@@ -112,6 +115,7 @@ require 'mailslurp_client/models/webhook_new_attachment_payload'
 require 'mailslurp_client/models/webhook_new_contact_payload'
 require 'mailslurp_client/models/webhook_new_email_payload'
 require 'mailslurp_client/models/webhook_projection'
+require 'mailslurp_client/models/webhook_result_entity'
 require 'mailslurp_client/models/webhook_test_request'
 require 'mailslurp_client/models/webhook_test_response'
 require 'mailslurp_client/models/webhook_test_result'
@@ -125,6 +129,7 @@ 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/expired_controller_api'
+require 'mailslurp_client/api/export_controller_api'
 require 'mailslurp_client/api/form_controller_api'
 require 'mailslurp_client/api/group_controller_api'
 require 'mailslurp_client/api/inbox_controller_api'

data/lib/mailslurp_client/api/export_controller_api.rb

@@ -0,0 +1,199 @@
+=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: 6.5.2
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'cgi'
+
+module MailSlurpClient
+  class ExportControllerApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Export inboxes link callable via browser
+    # @param api_key [String] apiKey
+    # @param export_type [String] exportType
+    # @param output_format [String] outputFormat
+    # @param [Hash] opts the optional parameters
+    # @option opts [DateTime] :created_earliest_time createdEarliestTime
+    # @option opts [DateTime] :created_oldest_time createdOldestTime
+    # @option opts [Boolean] :exclude_previously_exported excludePreviouslyExported
+    # @option opts [String] :filter filter
+    # @option opts [String] :list_separator_token listSeparatorToken
+    # @return [String]
+    def export_entities(api_key, export_type, output_format, opts = {})
+      data, _status_code, _headers = export_entities_with_http_info(api_key, export_type, output_format, opts)
+      data
+    end
+
+    # Export inboxes link callable via browser
+    # @param api_key [String] apiKey
+    # @param export_type [String] exportType
+    # @param output_format [String] outputFormat
+    # @param [Hash] opts the optional parameters
+    # @option opts [DateTime] :created_earliest_time createdEarliestTime
+    # @option opts [DateTime] :created_oldest_time createdOldestTime
+    # @option opts [Boolean] :exclude_previously_exported excludePreviouslyExported
+    # @option opts [String] :filter filter
+    # @option opts [String] :list_separator_token listSeparatorToken
+    # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
+    def export_entities_with_http_info(api_key, export_type, output_format, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ExportControllerApi.export_entities ...'
+      end
+      # verify the required parameter 'api_key' is set
+      if @api_client.config.client_side_validation && api_key.nil?
+        fail ArgumentError, "Missing the required parameter 'api_key' when calling ExportControllerApi.export_entities"
+      end
+      # verify the required parameter 'export_type' is set
+      if @api_client.config.client_side_validation && export_type.nil?
+        fail ArgumentError, "Missing the required parameter 'export_type' when calling ExportControllerApi.export_entities"
+      end
+      # verify enum value
+      allowable_values = ["INBOXES", "CONTACTS", "ATTACHMENTS", "EMAILS"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(export_type)
+        fail ArgumentError, "invalid value for \"export_type\", must be one of #{allowable_values}"
+      end
+      # verify the required parameter 'output_format' is set
+      if @api_client.config.client_side_validation && output_format.nil?
+        fail ArgumentError, "Missing the required parameter 'output_format' when calling ExportControllerApi.export_entities"
+      end
+      # verify enum value
+      allowable_values = ["CSV_DEFAULT", "CSV_EXCEL"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(output_format)
+        fail ArgumentError, "invalid value for \"output_format\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/export'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'apiKey'] = api_key
+      query_params[:'exportType'] = export_type
+      query_params[:'outputFormat'] = output_format
+      query_params[:'createdEarliestTime'] = opts[:'created_earliest_time'] if !opts[:'created_earliest_time'].nil?
+      query_params[:'createdOldestTime'] = opts[:'created_oldest_time'] if !opts[:'created_oldest_time'].nil?
+      query_params[:'excludePreviouslyExported'] = opts[:'exclude_previously_exported'] if !opts[:'exclude_previously_exported'].nil?
+      query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
+      query_params[:'listSeparatorToken'] = opts[:'list_separator_token'] if !opts[:'list_separator_token'].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] || 'String' 
+
+      # 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: ExportControllerApi#export_entities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get export link
+    # @param export_type [String] exportType
+    # @param export_options [ExportOptions] exportOptions
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :api_key apiKey
+    # @return [ExportLink]
+    def get_export_link(export_type, export_options, opts = {})
+      data, _status_code, _headers = get_export_link_with_http_info(export_type, export_options, opts)
+      data
+    end
+
+    # Get export link
+    # @param export_type [String] exportType
+    # @param export_options [ExportOptions] exportOptions
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :api_key apiKey
+    # @return [Array<(ExportLink, Integer, Hash)>] ExportLink data, response status code and response headers
+    def get_export_link_with_http_info(export_type, export_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ExportControllerApi.get_export_link ...'
+      end
+      # verify the required parameter 'export_type' is set
+      if @api_client.config.client_side_validation && export_type.nil?
+        fail ArgumentError, "Missing the required parameter 'export_type' when calling ExportControllerApi.get_export_link"
+      end
+      # verify enum value
+      allowable_values = ["INBOXES", "CONTACTS", "ATTACHMENTS", "EMAILS"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(export_type)
+        fail ArgumentError, "invalid value for \"export_type\", must be one of #{allowable_values}"
+      end
+      # verify the required parameter 'export_options' is set
+      if @api_client.config.client_side_validation && export_options.nil?
+        fail ArgumentError, "Missing the required parameter 'export_options' when calling ExportControllerApi.get_export_link"
+      end
+      # resource path
+      local_var_path = '/export'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'exportType'] = export_type
+      query_params[:'apiKey'] = opts[:'api_key'] if !opts[:'api_key'].nil?
+
+      # 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(export_options) 
+
+      # return_type
+      return_type = opts[:return_type] || 'ExportLink' 
+
+      # 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: ExportControllerApi#get_export_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/mailslurp_client/api/webhook_controller_api.rb

@@ -153,6 +153,73 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Get results for all webhooks
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Optional page index in list pagination (default to 0)
+    # @option opts [Integer] :size Optional page size in list pagination (default to 20)
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
+    # @return [PageWebhookResult]
+    def get_all_webhook_results(opts = {})
+      data, _status_code, _headers = get_all_webhook_results_with_http_info(opts)
+      data
+    end
+
+    # Get results for all webhooks
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Optional page index in list pagination
+    # @option opts [Integer] :size Optional page size in list pagination
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
+    # @return [Array<(PageWebhookResult, Integer, Hash)>] PageWebhookResult data, response status code and response headers
+    def get_all_webhook_results_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhookControllerApi.get_all_webhook_results ...'
+      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 = '/webhooks/results'
+
+      # 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] || 'PageWebhookResult' 
+
+      # 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: WebhookControllerApi#get_all_webhook_results\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # List Webhooks Paginated
     # List webhooks in paginated form. Allows for page index, page size, and sort direction.
     # @param [Hash] opts the optional parameters
@@ -505,6 +572,139 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Get a webhook result for a webhook
+    # @param webhook_result_id [String] Webhook Result ID
+    # @param [Hash] opts the optional parameters
+    # @return [WebhookResultEntity]
+    def get_webhook_result(webhook_result_id, opts = {})
+      data, _status_code, _headers = get_webhook_result_with_http_info(webhook_result_id, opts)
+      data
+    end
+
+    # Get a webhook result for a webhook
+    # @param webhook_result_id [String] Webhook Result ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(WebhookResultEntity, Integer, Hash)>] WebhookResultEntity data, response status code and response headers
+    def get_webhook_result_with_http_info(webhook_result_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhookControllerApi.get_webhook_result ...'
+      end
+      # verify the required parameter 'webhook_result_id' is set
+      if @api_client.config.client_side_validation && webhook_result_id.nil?
+        fail ArgumentError, "Missing the required parameter 'webhook_result_id' when calling WebhookControllerApi.get_webhook_result"
+      end
+      # resource path
+      local_var_path = '/webhooks/results/{webhookResultId}'.sub('{' + 'webhookResultId' + '}', CGI.escape(webhook_result_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] || 'WebhookResultEntity' 
+
+      # 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: WebhookControllerApi#get_webhook_result\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a webhook results for a webhook
+    # @param webhook_id [String] ID of webhook to get results for
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Optional page index in list pagination (default to 0)
+    # @option opts [Integer] :size Optional page size in list pagination (default to 20)
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
+    # @return [PageWebhookResult]
+    def get_webhook_results(webhook_id, opts = {})
+      data, _status_code, _headers = get_webhook_results_with_http_info(webhook_id, opts)
+      data
+    end
+
+    # Get a webhook results for a webhook
+    # @param webhook_id [String] ID of webhook to get results for
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Optional page index in list pagination
+    # @option opts [Integer] :size Optional page size in list pagination
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
+    # @return [Array<(PageWebhookResult, Integer, Hash)>] PageWebhookResult data, response status code and response headers
+    def get_webhook_results_with_http_info(webhook_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhookControllerApi.get_webhook_results ...'
+      end
+      # verify the required parameter 'webhook_id' is set
+      if @api_client.config.client_side_validation && webhook_id.nil?
+        fail ArgumentError, "Missing the required parameter 'webhook_id' when calling WebhookControllerApi.get_webhook_results"
+      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 = '/webhooks/{webhookId}/results'.sub('{' + 'webhookId' + '}', CGI.escape(webhook_id.to_s))
+
+      # 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] || 'PageWebhookResult' 
+
+      # 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: WebhookControllerApi#get_webhook_results\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get all webhooks for an Inbox
     # @param inbox_id [String] inboxId
     # @param [Hash] opts the optional parameters