mailslurp_client 12.4.5 → 12.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da8dea1905c104e63ec8b2fbfb335a1309549bb9460d2b0eae66e67800a5b011
-  data.tar.gz: 70987bff92bf7705b1185ac3bdcb04878efb38a6333218b793e7a1dc4c19ec63
+  metadata.gz: 70db6bce103b2e7d4ae3eca78e63daa2427d3b3f29db4a8c68cc99d2e2c199a4
+  data.tar.gz: 9f3ece76f8fc73b995257bf490e07742f1b955fd4880242bcbd1a275ef01bacf
 SHA512:
-  metadata.gz: 8192755ff36a77ec4ac99f926bdec134e399c204d40cec1102cb7be31e0948dcca931fc6a27c1e0565d970f181d1b7ab6c652df50b0fdbaf67fa62e183922a1f
-  data.tar.gz: cf83c2c2238b3b0ff1111b0e1c70aeb72ab96d98b73587a8d51069fa02c418c7ea260222831ceab19b0ca7d04779c2eff711e7b4439770ee0f11fc5d6a953098
+  metadata.gz: f9055da51031061aecc74efaa4ba90e84cfd1caae931fe467ec9c4c5cc7b902a248ac9ea2deea15983a6ee4d40eb104e35cee5e9ccb872a8c50803b50bb95308
+  data.tar.gz: e748394f21ccbb85dc20605367d2311dd00d5abc3508da54624b53e1945c345d1eea05551489084f3879163ebfdfd54b110d2afb38e4e78fb1f9a508091f972e

data/lib/mailslurp_client.rb

@@ -33,7 +33,9 @@ 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_inbox_dto'
+require 'mailslurp_client/models/create_inbox_ruleset_options'
 require 'mailslurp_client/models/create_template_options'
+require 'mailslurp_client/models/create_tracking_pixel_options'
 require 'mailslurp_client/models/create_webhook_options'
 require 'mailslurp_client/models/dns_lookup_options'
 require 'mailslurp_client/models/dns_lookup_result'
@@ -64,6 +66,9 @@ require 'mailslurp_client/models/html_validation_result'
 require 'mailslurp_client/models/ip_address_result'
 require 'mailslurp_client/models/inbox'
 require 'mailslurp_client/models/inbox_projection'
+require 'mailslurp_client/models/inbox_ruleset_dto'
+require 'mailslurp_client/models/inbox_ruleset_test_options'
+require 'mailslurp_client/models/inbox_ruleset_test_result'
 require 'mailslurp_client/models/match_option'
 require 'mailslurp_client/models/match_options'
 require 'mailslurp_client/models/missed_email'
@@ -79,11 +84,13 @@ require 'mailslurp_client/models/page_email_projection'
 require 'mailslurp_client/models/page_expired_inbox_record_projection'
 require 'mailslurp_client/models/page_group_projection'
 require 'mailslurp_client/models/page_inbox_projection'
+require 'mailslurp_client/models/page_inbox_ruleset_dto'
 require 'mailslurp_client/models/page_missed_email_projection'
 require 'mailslurp_client/models/page_organization_inbox_projection'
 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_tracking_pixel_projection'
 require 'mailslurp_client/models/page_webhook_projection'
 require 'mailslurp_client/models/page_webhook_result'
 require 'mailslurp_client/models/pageable'
@@ -99,7 +106,10 @@ require 'mailslurp_client/models/sort'
 require 'mailslurp_client/models/template_dto'
 require 'mailslurp_client/models/template_projection'
 require 'mailslurp_client/models/template_variable'
+require 'mailslurp_client/models/test_new_inbox_ruleset_options'
 require 'mailslurp_client/models/thread_projection'
+require 'mailslurp_client/models/tracking_pixel_dto'
+require 'mailslurp_client/models/tracking_pixel_projection'
 require 'mailslurp_client/models/unread_count'
 require 'mailslurp_client/models/update_alias_options'
 require 'mailslurp_client/models/update_domain_options'
@@ -133,10 +143,12 @@ 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'
+require 'mailslurp_client/api/inbox_ruleset_controller_api'
 require 'mailslurp_client/api/mail_server_controller_api'
 require 'mailslurp_client/api/missed_email_controller_api'
 require 'mailslurp_client/api/sent_emails_controller_api'
 require 'mailslurp_client/api/template_controller_api'
+require 'mailslurp_client/api/tracking_controller_api'
 require 'mailslurp_client/api/wait_for_controller_api'
 require 'mailslurp_client/api/webhook_controller_api'
 

data/lib/mailslurp_client/api/contact_controller_api.rb

@@ -141,8 +141,8 @@ module MailSlurpClient
 
     # Get all contacts
     # @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 [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 [PageContactProjection]
     def get_all_contacts(opts = {})
@@ -152,8 +152,8 @@ module MailSlurpClient
 
     # Get all contacts
     # @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 [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<(PageContactProjection, Integer, Hash)>] PageContactProjection data, response status code and response headers
     def get_all_contacts_with_http_info(opts = {})

data/lib/mailslurp_client/api/email_controller_api.rb

@@ -1451,6 +1451,70 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Send email
+    # Alias for `InboxController.sendEmail` method - see original method for full details. Sends an email from a given inbox that you have created. If no inbox is supplied a random inbox will be created for you and used to send the email.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :inbox_id ID of the inbox you want to send the email from
+    # @option opts [Boolean] :use_domain_pool Use domain pool. Optionally create inbox to send from using the mailslurp domain pool.
+    # @option opts [SendEmailOptions] :send_email_options Options for the email
+    # @return [nil]
+    def send_email_source_optional(opts = {})
+      send_email_source_optional_with_http_info(opts)
+      nil
+    end
+
+    # Send email
+    # Alias for `InboxController.sendEmail` method - see original method for full details. Sends an email from a given inbox that you have created. If no inbox is supplied a random inbox will be created for you and used to send the email.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :inbox_id ID of the inbox you want to send the email from
+    # @option opts [Boolean] :use_domain_pool Use domain pool. Optionally create inbox to send from using the mailslurp domain pool.
+    # @option opts [SendEmailOptions] :send_email_options Options for the email
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def send_email_source_optional_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EmailControllerApi.send_email_source_optional ...'
+      end
+      # resource path
+      local_var_path = '/emails'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
+      query_params[:'useDomainPool'] = opts[:'use_domain_pool'] if !opts[:'use_domain_pool'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # 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[:'send_email_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: EmailControllerApi#send_email_source_optional\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Validate email HTML contents
     # Validate the HTML content of email if HTML is found. Considered valid if no HTML is present.
     # @param email_id [String] ID of email

data/lib/mailslurp_client/api/group_controller_api.rb

@@ -209,8 +209,8 @@ module MailSlurpClient
 
     # Get all Contact Groups in paginated format
     # @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 [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 [PageGroupProjection]
     def get_all_groups(opts = {})
@@ -220,8 +220,8 @@ module MailSlurpClient
 
     # Get all Contact Groups in paginated format
     # @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 [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<(PageGroupProjection, Integer, Hash)>] PageGroupProjection data, response status code and response headers
     def get_all_groups_with_http_info(opts = {})

data/lib/mailslurp_client/api/inbox_controller_api.rb

@@ -109,6 +109,74 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Create an inbox ruleset
+    # Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
+    # @param inbox_id [String] inboxId
+    # @param create_inbox_ruleset_options [CreateInboxRulesetOptions] createInboxRulesetOptions
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def create_inbox_ruleset(inbox_id, create_inbox_ruleset_options, opts = {})
+      create_inbox_ruleset_with_http_info(inbox_id, create_inbox_ruleset_options, opts)
+      nil
+    end
+
+    # Create an inbox ruleset
+    # Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
+    # @param inbox_id [String] inboxId
+    # @param create_inbox_ruleset_options [CreateInboxRulesetOptions] createInboxRulesetOptions
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def create_inbox_ruleset_with_http_info(inbox_id, create_inbox_ruleset_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxControllerApi.create_inbox_ruleset ...'
+      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 InboxControllerApi.create_inbox_ruleset"
+      end
+      # verify the required parameter 'create_inbox_ruleset_options' is set
+      if @api_client.config.client_side_validation && create_inbox_ruleset_options.nil?
+        fail ArgumentError, "Missing the required parameter 'create_inbox_ruleset_options' when calling InboxControllerApi.create_inbox_ruleset"
+      end
+      # resource path
+      local_var_path = '/inboxes/{inboxId}/rulesets'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # 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_inbox_ruleset_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: InboxControllerApi#create_inbox_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Create an inbox with default options. Uses MailSlurp domain pool address and is private.
     # @param [Hash] opts the optional parameters
     # @return [Inbox]
@@ -345,9 +413,9 @@ module MailSlurpClient
     # List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results. Results do not include team access inboxes by default. Use organization method to list team inboxes or set `teamAccess` to true.
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :favourite Optionally filter results for favourites only (default to false)
-    # @option opts [Integer] :page Optional page index in inbox list pagination (default to 0)
+    # @option opts [Integer] :page Optional page index in list pagination (default to 0)
     # @option opts [String] :search Optionally filter by search words partial matching ID, tags, name, and email address
-    # @option opts [Integer] :size Optional page size in inbox list pagination (default to 20)
+    # @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')
     # @option opts [String] :tag Optionally filter by tags. Will return inboxes that include given tags
     # @option opts [Boolean] :team_access Optionally filter by team access. Defaults to false so organization inboxes are not included (default to false)
@@ -361,9 +429,9 @@ module MailSlurpClient
     # List inboxes in paginated form. The results are available on the &#x60;content&#x60; property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative &#x60;getInboxes&#x60; method returns a full list of inboxes but is limited to 100 results. Results do not include team access inboxes by default. Use organization method to list team inboxes or set &#x60;teamAccess&#x60; to true.
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :favourite Optionally filter results for favourites only
-    # @option opts [Integer] :page Optional page index in inbox list pagination
+    # @option opts [Integer] :page Optional page index in list pagination
     # @option opts [String] :search Optionally filter by search words partial matching ID, tags, name, and email address
-    # @option opts [Integer] :size Optional page size in inbox list pagination
+    # @option opts [Integer] :size Optional page size in list pagination
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
     # @option opts [String] :tag Optionally filter by tags. Will return inboxes that include given tags
     # @option opts [Boolean] :team_access Optionally filter by team access. Defaults to false so organization inboxes are not included
@@ -846,9 +914,9 @@ module MailSlurpClient
     # List Organization Inboxes Paginated
     # List organization inboxes in paginated form. These are inboxes created with `allowTeamAccess` flag enabled. Organization inboxes are `readOnly` for non-admin users. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). 
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page Optional page index in inbox list pagination (default to 0)
+    # @option opts [Integer] :page Optional page index in list pagination (default to 0)
     # @option opts [String] :search_filter Optional search filter
-    # @option opts [Integer] :size Optional page size in inbox list pagination (default to 20)
+    # @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 [PageOrganizationInboxProjection]
     def get_organization_inboxes(opts = {})
@@ -859,9 +927,9 @@ module MailSlurpClient
     # List Organization Inboxes Paginated
     # List organization inboxes in paginated form. These are inboxes created with &#x60;allowTeamAccess&#x60; flag enabled. Organization inboxes are &#x60;readOnly&#x60; for non-admin users. The results are available on the &#x60;content&#x60; property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). 
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page Optional page index in inbox list pagination
+    # @option opts [Integer] :page Optional page index in list pagination
     # @option opts [String] :search_filter Optional search filter
-    # @option opts [Integer] :size Optional page size in inbox 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<(PageOrganizationInboxProjection, Integer, Hash)>] PageOrganizationInboxProjection data, response status code and response headers
     def get_organization_inboxes_with_http_info(opts = {})
@@ -915,6 +983,82 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # List inbox rulesets
+    # List all rulesets attached to an inbox
+    # @param inbox_id [String] inboxId
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Optional page index in inbox ruleset list pagination (default to 0)
+    # @option opts [String] :search_filter Optional search filter
+    # @option opts [Integer] :size Optional page size in inbox ruleset list pagination (default to 20)
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
+    # @return [nil]
+    def list_inbox_rulesets(inbox_id, opts = {})
+      list_inbox_rulesets_with_http_info(inbox_id, opts)
+      nil
+    end
+
+    # List inbox rulesets
+    # List all rulesets attached to an inbox
+    # @param inbox_id [String] inboxId
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Optional page index in inbox ruleset list pagination
+    # @option opts [String] :search_filter Optional search filter
+    # @option opts [Integer] :size Optional page size in inbox ruleset list pagination
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def list_inbox_rulesets_with_http_info(inbox_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxControllerApi.list_inbox_rulesets ...'
+      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 InboxControllerApi.list_inbox_rulesets"
+      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 = '/inboxes/{inboxId}/rulesets'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].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] || {}
+
+      # 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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: InboxControllerApi#list_inbox_rulesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Send Email
     # Send an email from an inbox's email address.  The request body should contain the `SendEmailOptions` that include recipients, attachments, body etc. See `SendEmailOptions` for all available properties. Note the `inboxId` refers to the inbox's id not the inbox's email address. See https://www.mailslurp.com/guides/ for more information on how to send emails. This method does not return a sent email entity due to legacy reasons. To send and get a sent email as returned response use the sister method `sendEmailAndConfirm`.
     # @param inbox_id [String] ID of the inbox you want to send the email from

data/lib/mailslurp_client/api/inbox_ruleset_controller_api.rb

@@ -0,0 +1,548 @@
+=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 InboxRulesetControllerApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create an inbox ruleset
+    # Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
+    # @param create_inbox_ruleset_options [CreateInboxRulesetOptions] createInboxRulesetOptions
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :inbox_id Inbox id to attach ruleset to
+    # @return [InboxRulesetDto]
+    def create_new_inbox_ruleset(create_inbox_ruleset_options, opts = {})
+      data, _status_code, _headers = create_new_inbox_ruleset_with_http_info(create_inbox_ruleset_options, opts)
+      data
+    end
+
+    # Create an inbox ruleset
+    # Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
+    # @param create_inbox_ruleset_options [CreateInboxRulesetOptions] createInboxRulesetOptions
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :inbox_id Inbox id to attach ruleset to
+    # @return [Array<(InboxRulesetDto, Integer, Hash)>] InboxRulesetDto data, response status code and response headers
+    def create_new_inbox_ruleset_with_http_info(create_inbox_ruleset_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxRulesetControllerApi.create_new_inbox_ruleset ...'
+      end
+      # verify the required parameter 'create_inbox_ruleset_options' is set
+      if @api_client.config.client_side_validation && create_inbox_ruleset_options.nil?
+        fail ArgumentError, "Missing the required parameter 'create_inbox_ruleset_options' when calling InboxRulesetControllerApi.create_new_inbox_ruleset"
+      end
+      # resource path
+      local_var_path = '/rulesets'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].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(create_inbox_ruleset_options) 
+
+      # return_type
+      return_type = opts[:return_type] || 'InboxRulesetDto' 
+
+      # 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: InboxRulesetControllerApi#create_new_inbox_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete an inbox ruleset
+    # Delete inbox ruleset
+    # @param id [String] ID of inbox ruleset
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_inbox_ruleset(id, opts = {})
+      delete_inbox_ruleset_with_http_info(id, opts)
+      nil
+    end
+
+    # Delete an inbox ruleset
+    # Delete inbox ruleset
+    # @param id [String] ID of inbox ruleset
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_inbox_ruleset_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxRulesetControllerApi.delete_inbox_ruleset ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling InboxRulesetControllerApi.delete_inbox_ruleset"
+      end
+      # resource path
+      local_var_path = '/rulesets/{id}'.sub('{' + 'id' + '}', CGI.escape(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: InboxRulesetControllerApi#delete_inbox_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete inbox rulesets
+    # Delete inbox rulesets. Accepts optional inboxId filter.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :inbox_id Optional inbox id to attach ruleset to
+    # @return [nil]
+    def delete_inbox_rulesets(opts = {})
+      delete_inbox_rulesets_with_http_info(opts)
+      nil
+    end
+
+    # Delete inbox rulesets
+    # Delete inbox rulesets. Accepts optional inboxId filter.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :inbox_id Optional inbox id to attach ruleset to
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_inbox_rulesets_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxRulesetControllerApi.delete_inbox_rulesets ...'
+      end
+      # resource path
+      local_var_path = '/rulesets'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
+
+      # 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: InboxRulesetControllerApi#delete_inbox_rulesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get an inbox ruleset
+    # Get inbox ruleset
+    # @param id [String] ID of inbox ruleset
+    # @param [Hash] opts the optional parameters
+    # @return [InboxRulesetDto]
+    def get_inbox_ruleset(id, opts = {})
+      data, _status_code, _headers = get_inbox_ruleset_with_http_info(id, opts)
+      data
+    end
+
+    # Get an inbox ruleset
+    # Get inbox ruleset
+    # @param id [String] ID of inbox ruleset
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InboxRulesetDto, Integer, Hash)>] InboxRulesetDto data, response status code and response headers
+    def get_inbox_ruleset_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxRulesetControllerApi.get_inbox_ruleset ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling InboxRulesetControllerApi.get_inbox_ruleset"
+      end
+      # resource path
+      local_var_path = '/rulesets/{id}'.sub('{' + 'id' + '}', CGI.escape(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] || 'InboxRulesetDto' 
+
+      # 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: InboxRulesetControllerApi#get_inbox_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List inbox rulesets
+    # List all rulesets attached to an inbox
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :inbox_id Optional inbox id to get rulesets from
+    # @option opts [Integer] :page Optional page index in inbox ruleset list pagination (default to 0)
+    # @option opts [String] :search_filter Optional search filter
+    # @option opts [Integer] :size Optional page size in inbox ruleset list pagination (default to 20)
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
+    # @return [PageInboxRulesetDto]
+    def get_inbox_rulesets(opts = {})
+      data, _status_code, _headers = get_inbox_rulesets_with_http_info(opts)
+      data
+    end
+
+    # List inbox rulesets
+    # List all rulesets attached to an inbox
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :inbox_id Optional inbox id to get rulesets from
+    # @option opts [Integer] :page Optional page index in inbox ruleset list pagination
+    # @option opts [String] :search_filter Optional search filter
+    # @option opts [Integer] :size Optional page size in inbox ruleset list pagination
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
+    # @return [Array<(PageInboxRulesetDto, Integer, Hash)>] PageInboxRulesetDto data, response status code and response headers
+    def get_inbox_rulesets_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxRulesetControllerApi.get_inbox_rulesets ...'
+      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 = '/rulesets'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].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] || 'PageInboxRulesetDto' 
+
+      # 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: InboxRulesetControllerApi#get_inbox_rulesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Test an inbox ruleset
+    # Test an inbox ruleset
+    # @param id [String] ID of inbox ruleset
+    # @param inbox_ruleset_test_options [InboxRulesetTestOptions] inboxRulesetTestOptions
+    # @param [Hash] opts the optional parameters
+    # @return [InboxRulesetTestResult]
+    def test_inbox_ruleset(id, inbox_ruleset_test_options, opts = {})
+      data, _status_code, _headers = test_inbox_ruleset_with_http_info(id, inbox_ruleset_test_options, opts)
+      data
+    end
+
+    # Test an inbox ruleset
+    # Test an inbox ruleset
+    # @param id [String] ID of inbox ruleset
+    # @param inbox_ruleset_test_options [InboxRulesetTestOptions] inboxRulesetTestOptions
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InboxRulesetTestResult, Integer, Hash)>] InboxRulesetTestResult data, response status code and response headers
+    def test_inbox_ruleset_with_http_info(id, inbox_ruleset_test_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxRulesetControllerApi.test_inbox_ruleset ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling InboxRulesetControllerApi.test_inbox_ruleset"
+      end
+      # verify the required parameter 'inbox_ruleset_test_options' is set
+      if @api_client.config.client_side_validation && inbox_ruleset_test_options.nil?
+        fail ArgumentError, "Missing the required parameter 'inbox_ruleset_test_options' when calling InboxRulesetControllerApi.test_inbox_ruleset"
+      end
+      # resource path
+      local_var_path = '/rulesets/{id}/test'.sub('{' + 'id' + '}', CGI.escape(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(inbox_ruleset_test_options) 
+
+      # return_type
+      return_type = opts[:return_type] || 'InboxRulesetTestResult' 
+
+      # 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: InboxRulesetControllerApi#test_inbox_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Test inbox rulesets for inbox
+    # Test inbox rulesets for inbox
+    # @param inbox_id [String] ID of inbox
+    # @param inbox_ruleset_test_options [InboxRulesetTestOptions] inboxRulesetTestOptions
+    # @param [Hash] opts the optional parameters
+    # @return [InboxRulesetTestResult]
+    def test_inbox_rulesets_for_inbox(inbox_id, inbox_ruleset_test_options, opts = {})
+      data, _status_code, _headers = test_inbox_rulesets_for_inbox_with_http_info(inbox_id, inbox_ruleset_test_options, opts)
+      data
+    end
+
+    # Test inbox rulesets for inbox
+    # Test inbox rulesets for inbox
+    # @param inbox_id [String] ID of inbox
+    # @param inbox_ruleset_test_options [InboxRulesetTestOptions] inboxRulesetTestOptions
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InboxRulesetTestResult, Integer, Hash)>] InboxRulesetTestResult data, response status code and response headers
+    def test_inbox_rulesets_for_inbox_with_http_info(inbox_id, inbox_ruleset_test_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxRulesetControllerApi.test_inbox_rulesets_for_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 InboxRulesetControllerApi.test_inbox_rulesets_for_inbox"
+      end
+      # verify the required parameter 'inbox_ruleset_test_options' is set
+      if @api_client.config.client_side_validation && inbox_ruleset_test_options.nil?
+        fail ArgumentError, "Missing the required parameter 'inbox_ruleset_test_options' when calling InboxRulesetControllerApi.test_inbox_rulesets_for_inbox"
+      end
+      # resource path
+      local_var_path = '/rulesets'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'inboxId'] = inbox_id
+
+      # 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(inbox_ruleset_test_options) 
+
+      # return_type
+      return_type = opts[:return_type] || 'InboxRulesetTestResult' 
+
+      # 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: InboxRulesetControllerApi#test_inbox_rulesets_for_inbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Test new inbox ruleset
+    # Test new inbox ruleset
+    # @param test_new_inbox_ruleset_options [TestNewInboxRulesetOptions] testNewInboxRulesetOptions
+    # @param [Hash] opts the optional parameters
+    # @return [InboxRulesetTestResult]
+    def test_new_inbox_ruleset(test_new_inbox_ruleset_options, opts = {})
+      data, _status_code, _headers = test_new_inbox_ruleset_with_http_info(test_new_inbox_ruleset_options, opts)
+      data
+    end
+
+    # Test new inbox ruleset
+    # Test new inbox ruleset
+    # @param test_new_inbox_ruleset_options [TestNewInboxRulesetOptions] testNewInboxRulesetOptions
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InboxRulesetTestResult, Integer, Hash)>] InboxRulesetTestResult data, response status code and response headers
+    def test_new_inbox_ruleset_with_http_info(test_new_inbox_ruleset_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxRulesetControllerApi.test_new_inbox_ruleset ...'
+      end
+      # verify the required parameter 'test_new_inbox_ruleset_options' is set
+      if @api_client.config.client_side_validation && test_new_inbox_ruleset_options.nil?
+        fail ArgumentError, "Missing the required parameter 'test_new_inbox_ruleset_options' when calling InboxRulesetControllerApi.test_new_inbox_ruleset"
+      end
+      # resource path
+      local_var_path = '/rulesets'
+
+      # 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(test_new_inbox_ruleset_options) 
+
+      # return_type
+      return_type = opts[:return_type] || 'InboxRulesetTestResult' 
+
+      # 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(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: InboxRulesetControllerApi#test_new_inbox_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end