mailslurp_client 17.2.0 → 17.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 420aa7c6b2b976ac6856aae33e3c1e40d30b32f42612a5198e89ed2467c0beec
-  data.tar.gz: fe12cd04f6055bfbdecc98c83142d8bf6c13506200fce04b10ea14fbcb692b61
+  metadata.gz: 64209e27f0411814f8f14ce3310416e1b33a628bbb5c90c3d3166e102a057f09
+  data.tar.gz: d765adf95e703165c9c41b546f4cacb07231f757b1a50932cc7bc7f6b3f967cc
 SHA512:
-  metadata.gz: 277c2ceb738ef6a049061d64ceedff9dcb815a69b20775b4acc1312a8e6632d50f6ed41a528c4e9e19bf7df8ab703cba70e35432b41d0b810130f4dc08d23da5
-  data.tar.gz: 78791f3a6a24b92e3d66b7bbd04d14f9a854663f14f29f6eebd73be33e0b2602cc0d5cada55aa0fb51e7b7e3046389cf83053b196f410f5d69b7165081c3eb11
+  metadata.gz: 579e8fd015060eb5de264100bcbc05721c71ded3be238806338d8401e93cc886b1f8ecdee0d7a231804a7b1e101ba3b2e2ea551389e462b735c1a691a5535d52
+  data.tar.gz: 0dea59d945b55b3ef83cd07745e621ac056e9d310b891d68f0b19997012470fed1ff4f0c1fef614cb9cdbdb46acff2dc24c3f6e899e94a3cad1b861385cc6062

data/lib/mailslurp_client/api/campaign_probe_controller_api.rb

@@ -19,6 +19,78 @@ module MailSlurpClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Compare two campaign probe runs
+    # @param probe_id [String] 
+    # @param run_id [String] 
+    # @param other_run_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [CampaignProbeRunComparisonDto]
+    def compare_campaign_probe_runs(probe_id, run_id, other_run_id, opts = {})
+      data, _status_code, _headers = compare_campaign_probe_runs_with_http_info(probe_id, run_id, other_run_id, opts)
+      data
+    end
+
+    # Compare two campaign probe runs
+    # @param probe_id [String] 
+    # @param run_id [String] 
+    # @param other_run_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CampaignProbeRunComparisonDto, Integer, Hash)>] CampaignProbeRunComparisonDto data, response status code and response headers
+    def compare_campaign_probe_runs_with_http_info(probe_id, run_id, other_run_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CampaignProbeControllerApi.compare_campaign_probe_runs ...'
+      end
+      # verify the required parameter 'probe_id' is set
+      if @api_client.config.client_side_validation && probe_id.nil?
+        fail ArgumentError, "Missing the required parameter 'probe_id' when calling CampaignProbeControllerApi.compare_campaign_probe_runs"
+      end
+      # verify the required parameter 'run_id' is set
+      if @api_client.config.client_side_validation && run_id.nil?
+        fail ArgumentError, "Missing the required parameter 'run_id' when calling CampaignProbeControllerApi.compare_campaign_probe_runs"
+      end
+      # verify the required parameter 'other_run_id' is set
+      if @api_client.config.client_side_validation && other_run_id.nil?
+        fail ArgumentError, "Missing the required parameter 'other_run_id' when calling CampaignProbeControllerApi.compare_campaign_probe_runs"
+      end
+      # resource path
+      local_var_path = '/campaign-probe/probes/{probeId}/runs/{runId}/compare/{otherRunId}'.sub('{' + 'probeId' + '}', CGI.escape(probe_id.to_s)).sub('{' + 'runId' + '}', CGI.escape(run_id.to_s)).sub('{' + 'otherRunId' + '}', CGI.escape(other_run_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(['*/*'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'CampaignProbeRunComparisonDto' 
+
+      # 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: CampaignProbeControllerApi#compare_campaign_probe_runs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Create campaign probe
     # @param create_campaign_probe_options [CreateCampaignProbeOptions] 
     # @param [Hash] opts the optional parameters
@@ -265,6 +337,72 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Get campaign probe run
+    # @param probe_id [String] 
+    # @param run_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [CampaignProbeRunDto]
+    def get_campaign_probe_run(probe_id, run_id, opts = {})
+      data, _status_code, _headers = get_campaign_probe_run_with_http_info(probe_id, run_id, opts)
+      data
+    end
+
+    # Get campaign probe run
+    # @param probe_id [String] 
+    # @param run_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CampaignProbeRunDto, Integer, Hash)>] CampaignProbeRunDto data, response status code and response headers
+    def get_campaign_probe_run_with_http_info(probe_id, run_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CampaignProbeControllerApi.get_campaign_probe_run ...'
+      end
+      # verify the required parameter 'probe_id' is set
+      if @api_client.config.client_side_validation && probe_id.nil?
+        fail ArgumentError, "Missing the required parameter 'probe_id' when calling CampaignProbeControllerApi.get_campaign_probe_run"
+      end
+      # verify the required parameter 'run_id' is set
+      if @api_client.config.client_side_validation && run_id.nil?
+        fail ArgumentError, "Missing the required parameter 'run_id' when calling CampaignProbeControllerApi.get_campaign_probe_run"
+      end
+      # resource path
+      local_var_path = '/campaign-probe/probes/{probeId}/runs/{runId}'.sub('{' + 'probeId' + '}', CGI.escape(probe_id.to_s)).sub('{' + 'runId' + '}', CGI.escape(run_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(['*/*'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'CampaignProbeRunDto' 
+
+      # 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: CampaignProbeControllerApi#get_campaign_probe_run\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # List campaign probe runs
     # @param probe_id [String] 
     # @param [Hash] opts the optional parameters

data/lib/mailslurp_client/api/domain_monitor_controller_api.rb

@@ -19,6 +19,78 @@ module MailSlurpClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Compare two monitor runs
+    # @param monitor_id [String] 
+    # @param run_id [String] 
+    # @param other_run_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [DomainMonitorRunComparisonDto]
+    def compare_domain_monitor_runs(monitor_id, run_id, other_run_id, opts = {})
+      data, _status_code, _headers = compare_domain_monitor_runs_with_http_info(monitor_id, run_id, other_run_id, opts)
+      data
+    end
+
+    # Compare two monitor runs
+    # @param monitor_id [String] 
+    # @param run_id [String] 
+    # @param other_run_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DomainMonitorRunComparisonDto, Integer, Hash)>] DomainMonitorRunComparisonDto data, response status code and response headers
+    def compare_domain_monitor_runs_with_http_info(monitor_id, run_id, other_run_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DomainMonitorControllerApi.compare_domain_monitor_runs ...'
+      end
+      # verify the required parameter 'monitor_id' is set
+      if @api_client.config.client_side_validation && monitor_id.nil?
+        fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DomainMonitorControllerApi.compare_domain_monitor_runs"
+      end
+      # verify the required parameter 'run_id' is set
+      if @api_client.config.client_side_validation && run_id.nil?
+        fail ArgumentError, "Missing the required parameter 'run_id' when calling DomainMonitorControllerApi.compare_domain_monitor_runs"
+      end
+      # verify the required parameter 'other_run_id' is set
+      if @api_client.config.client_side_validation && other_run_id.nil?
+        fail ArgumentError, "Missing the required parameter 'other_run_id' when calling DomainMonitorControllerApi.compare_domain_monitor_runs"
+      end
+      # resource path
+      local_var_path = '/domain-monitor/monitors/{monitorId}/runs/{runId}/compare/{otherRunId}'.sub('{' + 'monitorId' + '}', CGI.escape(monitor_id.to_s)).sub('{' + 'runId' + '}', CGI.escape(run_id.to_s)).sub('{' + 'otherRunId' + '}', CGI.escape(other_run_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(['*/*'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'DomainMonitorRunComparisonDto' 
+
+      # 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: DomainMonitorControllerApi#compare_domain_monitor_runs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Create domain monitor
     # @param create_domain_monitor_options [CreateDomainMonitorOptions] 
     # @param [Hash] opts the optional parameters
@@ -391,6 +463,69 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Get current auth stack for monitor domain
+    # @param monitor_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :dkim_selector 
+    # @return [CheckEmailAuthStackResults]
+    def get_domain_monitor_auth_stack(monitor_id, opts = {})
+      data, _status_code, _headers = get_domain_monitor_auth_stack_with_http_info(monitor_id, opts)
+      data
+    end
+
+    # Get current auth stack for monitor domain
+    # @param monitor_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :dkim_selector 
+    # @return [Array<(CheckEmailAuthStackResults, Integer, Hash)>] CheckEmailAuthStackResults data, response status code and response headers
+    def get_domain_monitor_auth_stack_with_http_info(monitor_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DomainMonitorControllerApi.get_domain_monitor_auth_stack ...'
+      end
+      # verify the required parameter 'monitor_id' is set
+      if @api_client.config.client_side_validation && monitor_id.nil?
+        fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DomainMonitorControllerApi.get_domain_monitor_auth_stack"
+      end
+      # resource path
+      local_var_path = '/domain-monitor/monitors/{monitorId}/auth-stack'.sub('{' + 'monitorId' + '}', CGI.escape(monitor_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'dkimSelector'] = opts[:'dkim_selector'] if !opts[:'dkim_selector'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['*/*'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'CheckEmailAuthStackResults' 
+
+      # 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: DomainMonitorControllerApi#get_domain_monitor_auth_stack\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get monitor insights
     # @param monitor_id [String] 
     # @param [Hash] opts the optional parameters
@@ -457,6 +592,72 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Get monitor run
+    # @param monitor_id [String] 
+    # @param run_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [DomainMonitorRunDto]
+    def get_domain_monitor_run(monitor_id, run_id, opts = {})
+      data, _status_code, _headers = get_domain_monitor_run_with_http_info(monitor_id, run_id, opts)
+      data
+    end
+
+    # Get monitor run
+    # @param monitor_id [String] 
+    # @param run_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DomainMonitorRunDto, Integer, Hash)>] DomainMonitorRunDto data, response status code and response headers
+    def get_domain_monitor_run_with_http_info(monitor_id, run_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DomainMonitorControllerApi.get_domain_monitor_run ...'
+      end
+      # verify the required parameter 'monitor_id' is set
+      if @api_client.config.client_side_validation && monitor_id.nil?
+        fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DomainMonitorControllerApi.get_domain_monitor_run"
+      end
+      # verify the required parameter 'run_id' is set
+      if @api_client.config.client_side_validation && run_id.nil?
+        fail ArgumentError, "Missing the required parameter 'run_id' when calling DomainMonitorControllerApi.get_domain_monitor_run"
+      end
+      # resource path
+      local_var_path = '/domain-monitor/monitors/{monitorId}/runs/{runId}'.sub('{' + 'monitorId' + '}', CGI.escape(monitor_id.to_s)).sub('{' + 'runId' + '}', CGI.escape(run_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(['*/*'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'DomainMonitorRunDto' 
+
+      # 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: DomainMonitorControllerApi#get_domain_monitor_run\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # List monitor runs
     # @param monitor_id [String] 
     # @param [Hash] opts the optional parameters
@@ -606,6 +807,69 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Get domain monitor summary
+    # @param monitor_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :dkim_selector 
+    # @return [DomainMonitorSummaryDto]
+    def get_domain_monitor_summary(monitor_id, opts = {})
+      data, _status_code, _headers = get_domain_monitor_summary_with_http_info(monitor_id, opts)
+      data
+    end
+
+    # Get domain monitor summary
+    # @param monitor_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :dkim_selector 
+    # @return [Array<(DomainMonitorSummaryDto, Integer, Hash)>] DomainMonitorSummaryDto data, response status code and response headers
+    def get_domain_monitor_summary_with_http_info(monitor_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DomainMonitorControllerApi.get_domain_monitor_summary ...'
+      end
+      # verify the required parameter 'monitor_id' is set
+      if @api_client.config.client_side_validation && monitor_id.nil?
+        fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DomainMonitorControllerApi.get_domain_monitor_summary"
+      end
+      # resource path
+      local_var_path = '/domain-monitor/monitors/{monitorId}/summary'.sub('{' + 'monitorId' + '}', CGI.escape(monitor_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'dkimSelector'] = opts[:'dkim_selector'] if !opts[:'dkim_selector'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['*/*'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'DomainMonitorSummaryDto' 
+
+      # 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: DomainMonitorControllerApi#get_domain_monitor_summary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # List domain monitors
     # @param [Hash] opts the optional parameters
     # @return [Array<DomainMonitorDto>]