mailslurp_client 5.0.0 → 7.0.7

data/docs/Webhook.md

@@ -1,13 +0,0 @@
-# MailSlurpClient::Webhook
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**basic_auth** | **BOOLEAN** | Does Webhook expect basic authentication | [optional] 
-**created_at** | **DateTime** |  | 
-**id** | **String** | ID of the Webhook | [optional] 
-**inbox_id** | **String** | The inbox that the Webhook will be triggered by | [optional] 
-**name** | **String** |  | [optional] 
-**updated_at** | **DateTime** |  | 
-
-

data/lib/mailslurp_client/api/common_operations_api.rb

@@ -1,502 +0,0 @@
-=begin
-#MailSlurp API
-
-#For documentation see [developer guide](https://www.mailslurp.com/developers). [Create an account](https://app.mailslurp.com) in the MailSlurp Dashboard to [view your API Key](https://app). For all bugs, feature requests, or help please [see support](https://www.mailslurp.com/support/).
-
-OpenAPI spec version: 0.0.1-alpha
-Contact: contact@mailslurp.dev
-Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 3.3.4
-
-=end
-
-require 'uri'
-
-module MailSlurpClient
-  class CommonOperationsApi
-    attr_accessor :api_client
-
-    def initialize(api_client = ApiClient.default)
-      @api_client = api_client
-    end
-    # Create new email address
-    # Returns an Inbox with an `id` and an `emailAddress`
-    # @param [Hash] opts the optional parameters
-    # @return [Inbox]
-    def create_new_email_address(opts = {})
-      data, _status_code, _headers = create_new_email_address_with_http_info(opts)
-      data
-    end
-
-    # Create new email address
-    # Returns an Inbox with an `id` and an `emailAddress`
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(Inbox, Fixnum, Hash)>] Inbox data, response status code and response headers
-    def create_new_email_address_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: CommonOperationsApi.create_new_email_address ...'
-      end
-      # resource path
-      local_var_path = '/newEmailAddress'
-
-      # query parameters
-      query_params = {}
-
-      # header parameters
-      header_params = {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = nil
-      auth_names = ['API_KEY']
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'Inbox')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: CommonOperationsApi#create_new_email_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Delete an email
-    # Deletes an email
-    # @param email_id emailId
-    # @param [Hash] opts the optional parameters
-    # @return [nil]
-    def delete_email(email_id, opts = {})
-      delete_email_with_http_info(email_id, opts)
-      nil
-    end
-
-    # Delete an email
-    # Deletes an email
-    # @param email_id emailId
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def delete_email_with_http_info(email_id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: CommonOperationsApi.delete_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 CommonOperationsApi.delete_email"
-      end
-      # resource path
-      local_var_path = '/deleteEmail'
-
-      # query parameters
-      query_params = {}
-      query_params[:'emailId'] = email_id
-
-      # header parameters
-      header_params = {}
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = nil
-      auth_names = ['API_KEY']
-      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: CommonOperationsApi#delete_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Delete email address and its emails
-    # Deletes an inbox
-    # @param inbox_id inboxId
-    # @param [Hash] opts the optional parameters
-    # @return [nil]
-    def delete_email_address(inbox_id, opts = {})
-      delete_email_address_with_http_info(inbox_id, opts)
-      nil
-    end
-
-    # Delete email address and its emails
-    # Deletes an inbox
-    # @param inbox_id inboxId
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def delete_email_address_with_http_info(inbox_id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: CommonOperationsApi.delete_email_address ...'
-      end
-      # verify the required parameter 'inbox_id' is set
-      if @api_client.config.client_side_validation && inbox_id.nil?
-        fail ArgumentError, "Missing the required parameter 'inbox_id' when calling CommonOperationsApi.delete_email_address"
-      end
-      # resource path
-      local_var_path = '/deleteEmailAddress'
-
-      # query parameters
-      query_params = {}
-      query_params[:'inboxId'] = inbox_id
-
-      # header parameters
-      header_params = {}
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = nil
-      auth_names = ['API_KEY']
-      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: CommonOperationsApi#delete_email_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Delete all emails in an inbox
-    # Deletes all emails
-    # @param inbox_id inboxId
-    # @param [Hash] opts the optional parameters
-    # @return [nil]
-    def empty_inbox(inbox_id, opts = {})
-      empty_inbox_with_http_info(inbox_id, opts)
-      nil
-    end
-
-    # Delete all emails in an inbox
-    # Deletes all emails
-    # @param inbox_id inboxId
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def empty_inbox_with_http_info(inbox_id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: CommonOperationsApi.empty_inbox ...'
-      end
-      # verify the required parameter 'inbox_id' is set
-      if @api_client.config.client_side_validation && inbox_id.nil?
-        fail ArgumentError, "Missing the required parameter 'inbox_id' when calling CommonOperationsApi.empty_inbox"
-      end
-      # resource path
-      local_var_path = '/emptyInbox'
-
-      # query parameters
-      query_params = {}
-      query_params[:'inboxId'] = inbox_id
-
-      # header parameters
-      header_params = {}
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = nil
-      auth_names = ['API_KEY']
-      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: CommonOperationsApi#empty_inbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Send an email from a random email address
-    # To specify an email address first create an inbox and use that with the other send email methods
-    # @param send_email_options sendEmailOptions
-    # @param [Hash] opts the optional parameters
-    # @return [nil]
-    def send_email_simple(send_email_options, opts = {})
-      send_email_simple_with_http_info(send_email_options, opts)
-      nil
-    end
-
-    # Send an email from a random email address
-    # To specify an email address first create an inbox and use that with the other send email methods
-    # @param send_email_options sendEmailOptions
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def send_email_simple_with_http_info(send_email_options, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: CommonOperationsApi.send_email_simple ...'
-      end
-      # verify the required parameter 'send_email_options' is set
-      if @api_client.config.client_side_validation && send_email_options.nil?
-        fail ArgumentError, "Missing the required parameter 'send_email_options' when calling CommonOperationsApi.send_email_simple"
-      end
-      # resource path
-      local_var_path = '/sendEmail'
-
-      # query parameters
-      query_params = {}
-
-      # header parameters
-      header_params = {}
-      # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = @api_client.object_to_http_body(send_email_options)
-      auth_names = ['API_KEY']
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: CommonOperationsApi#send_email_simple\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Wait for and return count number of emails 
-    # Will only wait if count is greater that the found emails in given inbox.If you need to wait for an email for a non-empty inbox see the other receive methods.
-    # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :count Number of emails to wait for. Must be greater that 1
-    # @option opts [String] :inbox_id Id of the inbox we are fetching emails from
-    # @option opts [Integer] :timeout Max milliseconds to wait
-    # @return [Array<EmailPreview>]
-    def wait_for_email_count(opts = {})
-      data, _status_code, _headers = wait_for_email_count_with_http_info(opts)
-      data
-    end
-
-    # Wait for and return count number of emails 
-    # Will only wait if count is greater that the found emails in given inbox.If you need to wait for an email for a non-empty inbox see the other receive methods.
-    # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :count Number of emails to wait for. Must be greater that 1
-    # @option opts [String] :inbox_id Id of the inbox we are fetching emails from
-    # @option opts [Integer] :timeout Max milliseconds to wait
-    # @return [Array<(Array<EmailPreview>, Fixnum, Hash)>] Array<EmailPreview> data, response status code and response headers
-    def wait_for_email_count_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: CommonOperationsApi.wait_for_email_count ...'
-      end
-      # resource path
-      local_var_path = '/waitForEmailCount'
-
-      # query parameters
-      query_params = {}
-      query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
-      query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
-      query_params[:'timeout'] = opts[:'timeout'] if !opts[:'timeout'].nil?
-
-      # header parameters
-      header_params = {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = nil
-      auth_names = ['API_KEY']
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'Array<EmailPreview>')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: CommonOperationsApi#wait_for_email_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Fetch inbox's latest email or if empty wait for 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.
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :inbox_id Id of the inbox we are fetching emails from
-    # @option opts [Integer] :timeout Max milliseconds to wait
-    # @return [Email]
-    def wait_for_latest_email(opts = {})
-      data, _status_code, _headers = wait_for_latest_email_with_http_info(opts)
-      data
-    end
-
-    # Fetch inbox&#39;s latest email or if empty wait for 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.
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :inbox_id Id of the inbox we are fetching emails from
-    # @option opts [Integer] :timeout Max milliseconds to wait
-    # @return [Array<(Email, Fixnum, Hash)>] Email data, response status code and response headers
-    def wait_for_latest_email_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: CommonOperationsApi.wait_for_latest_email ...'
-      end
-      # resource path
-      local_var_path = '/waitForLatestEmail'
-
-      # query parameters
-      query_params = {}
-      query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
-      query_params[:'timeout'] = opts[:'timeout'] if !opts[:'timeout'].nil?
-
-      # header parameters
-      header_params = {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = nil
-      auth_names = ['API_KEY']
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'Email')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: CommonOperationsApi#wait_for_latest_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Wait or return list of emails that match simple matching patterns
-    # Results must also meet provided count. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM.
-    # @param match_options matchOptions
-    # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :count Number of emails to wait for. Must be greater that 1
-    # @option opts [String] :inbox_id Id of the inbox we are fetching emails from
-    # @option opts [Integer] :timeout Max milliseconds to wait
-    # @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)
-      data
-    end
-
-    # Wait or return list of emails that match simple matching patterns
-    # Results must also meet provided count. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM.
-    # @param match_options matchOptions
-    # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :count Number of emails to wait for. Must be greater that 1
-    # @option opts [String] :inbox_id Id of the inbox we are fetching emails from
-    # @option opts [Integer] :timeout Max milliseconds to wait
-    # @return [Array<(Array<EmailPreview>, Fixnum, Hash)>] Array<EmailPreview> data, response status code and response headers
-    def wait_for_matching_email_with_http_info(match_options, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: CommonOperationsApi.wait_for_matching_email ...'
-      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 CommonOperationsApi.wait_for_matching_email"
-      end
-      # resource path
-      local_var_path = '/waitForMatchingEmails'
-
-      # query parameters
-      query_params = {}
-      query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
-      query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
-      query_params[:'timeout'] = opts[:'timeout'] if !opts[:'timeout'].nil?
-
-      # header parameters
-      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 = {}
-
-      # http body (model)
-      post_body = @api_client.object_to_http_body(match_options)
-      auth_names = ['API_KEY']
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'Array<EmailPreview>')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: CommonOperationsApi#wait_for_matching_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Wait for or fetch the email with a given index in the inbox specified
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :inbox_id Id of the inbox we are fetching emails from
-    # @option opts [Integer] :index Zero based index of the email to wait for
-    # @option opts [Integer] :timeout Max milliseconds to wait
-    # @return [Email]
-    def wait_for_nth_email(opts = {})
-      data, _status_code, _headers = wait_for_nth_email_with_http_info(opts)
-      data
-    end
-
-    # Wait for or fetch the email with a given index in the inbox specified
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :inbox_id Id of the inbox we are fetching emails from
-    # @option opts [Integer] :index Zero based index of the email to wait for
-    # @option opts [Integer] :timeout Max milliseconds to wait
-    # @return [Array<(Email, Fixnum, Hash)>] Email data, response status code and response headers
-    def wait_for_nth_email_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: CommonOperationsApi.wait_for_nth_email ...'
-      end
-      # resource path
-      local_var_path = '/waitForNthEmail'
-
-      # query parameters
-      query_params = {}
-      query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
-      query_params[:'index'] = opts[:'index'] if !opts[:'index'].nil?
-      query_params[:'timeout'] = opts[:'timeout'] if !opts[:'timeout'].nil?
-
-      # header parameters
-      header_params = {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = nil
-      auth_names = ['API_KEY']
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'Email')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: CommonOperationsApi#wait_for_nth_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-  end
-end