mailslurp_client 8.0.6 → 8.0.12

data/lib/mailslurp_client/api/wait_for_controller_api.rb

@@ -0,0 +1,359 @@
+=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 WaitForControllerApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Wait for conditions to be met
+    # Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already met
+    # @param [Hash] opts the optional parameters
+    # @option opts [WaitForConditions] :wait_for_conditions Conditions to wait for
+    # @return [Array<EmailPreview>]
+    def wait_for(opts = {})
+      data, _status_code, _headers = wait_for_with_http_info(opts)
+      data
+    end
+
+    # Wait for conditions to be met
+    # Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already met
+    # @param [Hash] opts the optional parameters
+    # @option opts [WaitForConditions] :wait_for_conditions Conditions to wait for
+    # @return [Array<(Array<EmailPreview>, Integer, Hash)>] Array<EmailPreview> data, response status code and response headers
+    def wait_for_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WaitForControllerApi.wait_for ...'
+      end
+      # resource path
+      local_var_path = '/waitFor'
+
+      # 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(opts[:'wait_for_conditions']) 
+
+      # return_type
+      return_type = opts[:return_type] || 'Array<EmailPreview>' 
+
+      # 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: WaitForControllerApi#wait_for\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Wait for and return count number of emails 
+    # 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 [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
+    # @option opts [Boolean] :unread_only Optional filter for unread only (default to false)
+    # @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 
+    # 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 [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
+    # @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_email_count_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WaitForControllerApi.wait_for_email_count ...'
+      end
+      # resource path
+      local_var_path = '/waitForEmailCount'
+
+      # query parameters
+      query_params = opts[: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?
+      query_params[:'unreadOnly'] = opts[:'unread_only'] if !opts[:'unread_only'].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] || 'Array<EmailPreview>' 
+
+      # 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: WaitForControllerApi#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 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 [String] :inbox_id Id of the inbox we are fetching emails from
+    # @option opts [Integer] :timeout Max milliseconds to wait
+    # @option opts [Boolean] :unread_only Optional filter for unread only. (default to false)
+    # @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 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 &#x60;unreadOnly&#x3D;true&#x60; or see the other receive methods such as &#x60;waitForNthEmail&#x60; or &#x60;waitForEmailCount&#x60;.
+    # @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
+    # @option opts [Boolean] :unread_only Optional filter for unread only.
+    # @return [Array<(Email, Integer, 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: WaitForControllerApi.wait_for_latest_email ...'
+      end
+      # resource path
+      local_var_path = '/waitForLatestEmail'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
+      query_params[:'timeout'] = opts[:'timeout'] if !opts[:'timeout'].nil?
+      query_params[:'unreadOnly'] = opts[:'unread_only'] if !opts[:'unread_only'].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] || 'Email' 
+
+      # 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: WaitForControllerApi#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
+    # 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.
+    # @param match_options [MatchOptions] 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
+    # @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)
+      data
+    end
+
+    # Wait or return list of emails that match simple matching patterns
+    # 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.
+    # @param match_options [MatchOptions] 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
+    # @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 = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WaitForControllerApi.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 WaitForControllerApi.wait_for_matching_email"
+      end
+      # resource path
+      local_var_path = '/waitForMatchingEmails'
+
+      # query parameters
+      query_params = opts[: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?
+      query_params[:'unreadOnly'] = opts[:'unread_only'] if !opts[:'unread_only'].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(match_options) 
+
+      # return_type
+      return_type = opts[:return_type] || 'Array<EmailPreview>' 
+
+      # 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: WaitForControllerApi#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
+    # 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 [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)
+    # @option opts [Integer] :timeout Max milliseconds to wait for the nth email if not already present
+    # @option opts [Boolean] :unread_only Optional filter for unread only (default to false)
+    # @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
+    # 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 [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
+    # @option opts [Integer] :timeout Max milliseconds to wait for the nth email if not already present
+    # @option opts [Boolean] :unread_only Optional filter for unread only
+    # @return [Array<(Email, Integer, 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: WaitForControllerApi.wait_for_nth_email ...'
+      end
+      # resource path
+      local_var_path = '/waitForNthEmail'
+
+      # query parameters
+      query_params = opts[: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?
+      query_params[:'unreadOnly'] = opts[:'unread_only'] if !opts[:'unread_only'].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] || 'Email' 
+
+      # 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: WaitForControllerApi#wait_for_nth_email\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

@@ -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: 6.5.2
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'cgi'
+
+module MailSlurpClient
+  class WebhookControllerApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Attach a WebHook URL to an inbox
+    # Get notified whenever an inbox receives an email via a WebHook URL. An emailID will be posted to this URL every time an email is received for this inbox. The URL must be publicly reachable by the MailSlurp server. You can provide basicAuth values if you wish to secure this endpoint.
+    # @param inbox_id [String] inboxId
+    # @param webhook_options [CreateWebhookOptions] webhookOptions
+    # @param [Hash] opts the optional parameters
+    # @return [WebhookDto]
+    def create_webhook(inbox_id, webhook_options, opts = {})
+      data, _status_code, _headers = create_webhook_with_http_info(inbox_id, webhook_options, opts)
+      data
+    end
+
+    # Attach a WebHook URL to an inbox
+    # Get notified whenever an inbox receives an email via a WebHook URL. An emailID will be posted to this URL every time an email is received for this inbox. The URL must be publicly reachable by the MailSlurp server. You can provide basicAuth values if you wish to secure this endpoint.
+    # @param inbox_id [String] inboxId
+    # @param webhook_options [CreateWebhookOptions] webhookOptions
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(WebhookDto, Integer, Hash)>] WebhookDto data, response status code and response headers
+    def create_webhook_with_http_info(inbox_id, webhook_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhookControllerApi.create_webhook ...'
+      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 WebhookControllerApi.create_webhook"
+      end
+      # verify the required parameter 'webhook_options' is set
+      if @api_client.config.client_side_validation && webhook_options.nil?
+        fail ArgumentError, "Missing the required parameter 'webhook_options' when calling WebhookControllerApi.create_webhook"
+      end
+      # resource path
+      local_var_path = '/inboxes/{inboxId}/webhooks'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_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(webhook_options) 
+
+      # return_type
+      return_type = opts[:return_type] || 'WebhookDto' 
+
+      # 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: WebhookControllerApi#create_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete and disable a Webhook for an Inbox
+    # @param inbox_id [String] inboxId
+    # @param webhook_id [String] webhookId
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_webhook(inbox_id, webhook_id, opts = {})
+      delete_webhook_with_http_info(inbox_id, webhook_id, opts)
+      nil
+    end
+
+    # Delete and disable a Webhook for an Inbox
+    # @param inbox_id [String] inboxId
+    # @param webhook_id [String] webhookId
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_webhook_with_http_info(inbox_id, webhook_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhookControllerApi.delete_webhook ...'
+      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 WebhookControllerApi.delete_webhook"
+      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.delete_webhook"
+      end
+      # resource path
+      local_var_path = '/inboxes/{inboxId}/webhooks/{webhookId}'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s)).sub('{' + 'webhookId' + '}', CGI.escape(webhook_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: WebhookControllerApi#delete_webhook\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
+    # @option opts [Integer] :page Optional page index in inbox list pagination (default to 0)
+    # @option opts [Integer] :size Optional page size in inbox list pagination (default to 20)
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
+    # @return [PageWebhookProjection]
+    def get_all_webhooks(opts = {})
+      data, _status_code, _headers = get_all_webhooks_with_http_info(opts)
+      data
+    end
+
+    # List Webhooks Paginated
+    # List webhooks in paginated form. Allows for page index, page size, and sort direction.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Optional page index in inbox list pagination
+    # @option opts [Integer] :size Optional page size in inbox list pagination
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
+    # @return [Array<(PageWebhookProjection, Integer, Hash)>] PageWebhookProjection data, response status code and response headers
+    def get_all_webhooks_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhookControllerApi.get_all_webhooks ...'
+      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/paginated'
+
+      # 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] || 'PageWebhookProjection' 
+
+      # 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_webhooks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a webhook for an Inbox
+    # @param webhook_id [String] webhookId
+    # @param [Hash] opts the optional parameters
+    # @return [WebhookDto]
+    def get_webhook(webhook_id, opts = {})
+      data, _status_code, _headers = get_webhook_with_http_info(webhook_id, opts)
+      data
+    end
+
+    # Get a webhook for an Inbox
+    # @param webhook_id [String] webhookId
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(WebhookDto, Integer, Hash)>] WebhookDto data, response status code and response headers
+    def get_webhook_with_http_info(webhook_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhookControllerApi.get_webhook ...'
+      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"
+      end
+      # resource path
+      local_var_path = '/webhooks/{webhookId}'.sub('{' + 'webhookId' + '}', CGI.escape(webhook_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] || 'WebhookDto' 
+
+      # 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\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
+    # @return [Array<WebhookDto>]
+    def get_webhooks(inbox_id, opts = {})
+      data, _status_code, _headers = get_webhooks_with_http_info(inbox_id, opts)
+      data
+    end
+
+    # Get all Webhooks for an Inbox
+    # @param inbox_id [String] inboxId
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<WebhookDto>, Integer, Hash)>] Array<WebhookDto> data, response status code and response headers
+    def get_webhooks_with_http_info(inbox_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhookControllerApi.get_webhooks ...'
+      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 WebhookControllerApi.get_webhooks"
+      end
+      # resource path
+      local_var_path = '/inboxes/{inboxId}/webhooks'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_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] || 'Array<WebhookDto>' 
+
+      # 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_webhooks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Send webhook test data
+    # @param webhook_id [String] webhookId
+    # @param [Hash] opts the optional parameters
+    # @return [WebhookTestResult]
+    def send_test_data(webhook_id, opts = {})
+      data, _status_code, _headers = send_test_data_with_http_info(webhook_id, opts)
+      data
+    end
+
+    # Send webhook test data
+    # @param webhook_id [String] webhookId
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(WebhookTestResult, Integer, Hash)>] WebhookTestResult data, response status code and response headers
+    def send_test_data_with_http_info(webhook_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhookControllerApi.send_test_data ...'
+      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.send_test_data"
+      end
+      # resource path
+      local_var_path = '/webhooks/{webhookId}/test'.sub('{' + 'webhookId' + '}', CGI.escape(webhook_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] || 'WebhookTestResult' 
+
+      # 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: WebhookControllerApi#send_test_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end