mailslurp_client 17.0.0 → 17.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7efea0f0fed208677397550ab51c2190593e86600b3dd44ead4a04525285d50b
-  data.tar.gz: 671967e5dab48040ef9692a58308916319a38a3761722a4be5c177ab9657cc54
+  metadata.gz: 27a4ee654d3a0a27729c4a110bc04deb5b72ce5539c682ae05d0d17a68fbe568
+  data.tar.gz: 3311627fe88cb2f236e97f7b2b1809cb9b01904b90dafc59eb5295eadad77cd0
 SHA512:
-  metadata.gz: 81bffcbfaea650d9c9e62f7af40f5e73f68a3230d4eda2e23eff8d6728d169111f531e779aeaf9f3256bdd6526bdf0ab89c0c32510faa3d4493a3d8b34ea8752
-  data.tar.gz: 97d1bfc227445f10eccb4c21436a2e2d0fc0b3246a691d61f0ec599ae6885d4b4225aaa4b036782c7395598bc7fbc1e0cd0f11f1ce239ec2da84c03d47a5ac34
+  metadata.gz: f8cda0d790623e93588d3672a92e74e0c18ff74be53a62961e89da1d8606b6d4417641b10924daf0aa7bdcf4afabf8ab4004bac6f6da94a6813fec8ae6b7db6f
+  data.tar.gz: a2f07eaa7f7b32123a1d2a1c06f3368ddbca1205089fe1a6431cd2f939fcff4db72ed6a977765beee9b85d3b72882302052818ffd36fedf5d0f70fe5c4b3cce2

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2025 MailSlurp Email API (Provided by Pettman OÜ, Estonia)
+Copyright 2026 MailSlurp Email API (Provided by Pettman OÜ, Estonia)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

data/lib/mailslurp_client/api/ai_controller_api.rb

@@ -375,6 +375,70 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Export transformer results
+    # Export AI transformer results in formats such as Excel, CSV, XML etc.
+    # @param export_transformer_options [ExportTransformerOptions] 
+    # @param [Hash] opts the optional parameters
+    # @return [ExportTransformerResponse]
+    def export_transformer_results(export_transformer_options, opts = {})
+      data, _status_code, _headers = export_transformer_results_with_http_info(export_transformer_options, opts)
+      data
+    end
+
+    # Export transformer results
+    # Export AI transformer results in formats such as Excel, CSV, XML etc.
+    # @param export_transformer_options [ExportTransformerOptions] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ExportTransformerResponse, Integer, Hash)>] ExportTransformerResponse data, response status code and response headers
+    def export_transformer_results_with_http_info(export_transformer_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AIControllerApi.export_transformer_results ...'
+      end
+      # verify the required parameter 'export_transformer_options' is set
+      if @api_client.config.client_side_validation && export_transformer_options.nil?
+        fail ArgumentError, "Missing the required parameter 'export_transformer_options' when calling AIControllerApi.export_transformer_results"
+      end
+      # resource path
+      local_var_path = '/ai/transformer/results/export'
+
+      # 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(['*/*'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(export_transformer_options) 
+
+      # return_type
+      return_type = opts[:return_type] || 'ExportTransformerResponse' 
+
+      # 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: AIControllerApi#export_transformer_results\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Generate structured content for an attachment
     # Use output schemas to extract data from an attachment using AI
     # @param generate_structured_content_attachment_options [GenerateStructuredContentAttachmentOptions] 
@@ -567,6 +631,68 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Get export transformer results job
+    # Get the job status for an export
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [ExportTransformerResultJobDto]
+    def get_export_transformer_results_job(id, opts = {})
+      data, _status_code, _headers = get_export_transformer_results_job_with_http_info(id, opts)
+      data
+    end
+
+    # Get export transformer results job
+    # Get the job status for an export
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ExportTransformerResultJobDto, Integer, Hash)>] ExportTransformerResultJobDto data, response status code and response headers
+    def get_export_transformer_results_job_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AIControllerApi.get_export_transformer_results_job ...'
+      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 AIControllerApi.get_export_transformer_results_job"
+      end
+      # resource path
+      local_var_path = '/ai/transformer/results/export/{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(['*/*'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'ExportTransformerResultJobDto' 
+
+      # 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: AIControllerApi#get_export_transformer_results_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get a transformer
     # Get AI transformer and schemas by ID
     # @param id [String] 
@@ -842,6 +968,9 @@ module MailSlurpClient
     # Get transformer results
     # Get AI transformer results
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :email_id 
+    # @option opts [String] :sms_id 
+    # @option opts [String] :attachment_id 
     # @option opts [String] :ai_transform_id 
     # @option opts [String] :ai_transform_mapping_id 
     # @option opts [String] :entity_id 
@@ -858,6 +987,9 @@ module MailSlurpClient
     # Get transformer results
     # Get AI transformer results
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :email_id 
+    # @option opts [String] :sms_id 
+    # @option opts [String] :attachment_id 
     # @option opts [String] :ai_transform_id 
     # @option opts [String] :ai_transform_mapping_id 
     # @option opts [String] :entity_id 
@@ -887,6 +1019,9 @@ module MailSlurpClient
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'emailId'] = opts[:'email_id'] if !opts[:'email_id'].nil?
+      query_params[:'smsId'] = opts[:'sms_id'] if !opts[:'sms_id'].nil?
+      query_params[:'attachmentId'] = opts[:'attachment_id'] if !opts[:'attachment_id'].nil?
       query_params[:'aiTransformId'] = opts[:'ai_transform_id'] if !opts[:'ai_transform_id'].nil?
       query_params[:'aiTransformMappingId'] = opts[:'ai_transform_mapping_id'] if !opts[:'ai_transform_mapping_id'].nil?
       query_params[:'entityId'] = opts[:'entity_id'] if !opts[:'entity_id'].nil?
@@ -928,6 +1063,118 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Get transformer results table
+    # Get AI transformer results in table format
+    # @param include_meta_data [Boolean] 
+    # @param flatten_arrays_to_rows [Boolean] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :email_id 
+    # @option opts [String] :sms_id 
+    # @option opts [String] :attachment_id 
+    # @option opts [String] :ai_transform_id 
+    # @option opts [String] :ai_transform_mapping_id 
+    # @option opts [String] :entity_id 
+    # @option opts [String] :entity_type 
+    # @option opts [Integer] :page  (default to 0)
+    # @option opts [Integer] :size Optional page size. Maximum size is 100. Use page index and sort to page through larger results (default to 20)
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
+    # @return [PageTableData]
+    def get_transformer_results_table(include_meta_data, flatten_arrays_to_rows, opts = {})
+      data, _status_code, _headers = get_transformer_results_table_with_http_info(include_meta_data, flatten_arrays_to_rows, opts)
+      data
+    end
+
+    # Get transformer results table
+    # Get AI transformer results in table format
+    # @param include_meta_data [Boolean] 
+    # @param flatten_arrays_to_rows [Boolean] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :email_id 
+    # @option opts [String] :sms_id 
+    # @option opts [String] :attachment_id 
+    # @option opts [String] :ai_transform_id 
+    # @option opts [String] :ai_transform_mapping_id 
+    # @option opts [String] :entity_id 
+    # @option opts [String] :entity_type 
+    # @option opts [Integer] :page 
+    # @option opts [Integer] :size Optional page size. Maximum size is 100. Use page index and sort to page through larger results
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
+    # @return [Array<(PageTableData, Integer, Hash)>] PageTableData data, response status code and response headers
+    def get_transformer_results_table_with_http_info(include_meta_data, flatten_arrays_to_rows, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AIControllerApi.get_transformer_results_table ...'
+      end
+      # verify the required parameter 'include_meta_data' is set
+      if @api_client.config.client_side_validation && include_meta_data.nil?
+        fail ArgumentError, "Missing the required parameter 'include_meta_data' when calling AIControllerApi.get_transformer_results_table"
+      end
+      # verify the required parameter 'flatten_arrays_to_rows' is set
+      if @api_client.config.client_side_validation && flatten_arrays_to_rows.nil?
+        fail ArgumentError, "Missing the required parameter 'flatten_arrays_to_rows' when calling AIControllerApi.get_transformer_results_table"
+      end
+      allowable_values = ["INBOX", "PHONE"]
+      if @api_client.config.client_side_validation && opts[:'entity_type'] && !allowable_values.include?(opts[:'entity_type'])
+        fail ArgumentError, "invalid value for \"entity_type\", must be one of #{allowable_values}"
+      end
+      if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"size"]" when calling AIControllerApi.get_transformer_results_table, must be smaller than or equal to 100.'
+      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 = '/ai/transformer/results/table'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'includeMetaData'] = include_meta_data
+      query_params[:'flattenArraysToRows'] = flatten_arrays_to_rows
+      query_params[:'emailId'] = opts[:'email_id'] if !opts[:'email_id'].nil?
+      query_params[:'smsId'] = opts[:'sms_id'] if !opts[:'sms_id'].nil?
+      query_params[:'attachmentId'] = opts[:'attachment_id'] if !opts[:'attachment_id'].nil?
+      query_params[:'aiTransformId'] = opts[:'ai_transform_id'] if !opts[:'ai_transform_id'].nil?
+      query_params[:'aiTransformMappingId'] = opts[:'ai_transform_mapping_id'] if !opts[:'ai_transform_mapping_id'].nil?
+      query_params[:'entityId'] = opts[:'entity_id'] if !opts[:'entity_id'].nil?
+      query_params[:'entityType'] = opts[:'entity_type'] if !opts[:'entity_type'].nil?
+      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(['*/*'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'PageTableData' 
+
+      # 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: AIControllerApi#get_transformer_results_table\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # List transformers
     # List all AI transforms
     # @param [Hash] opts the optional parameters
@@ -1068,6 +1315,77 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Test transformer mapping match result
+    # Evaluate transform mapping match conditions for given email, sms, or attachment
+    # @param id [String] ID of transform mapping
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :email_id 
+    # @option opts [String] :sms_id 
+    # @option opts [String] :attachment_id 
+    # @return [AITransformMappingMatchResult]
+    def test_transformer_mapping_match(id, opts = {})
+      data, _status_code, _headers = test_transformer_mapping_match_with_http_info(id, opts)
+      data
+    end
+
+    # Test transformer mapping match result
+    # Evaluate transform mapping match conditions for given email, sms, or attachment
+    # @param id [String] ID of transform mapping
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :email_id 
+    # @option opts [String] :sms_id 
+    # @option opts [String] :attachment_id 
+    # @return [Array<(AITransformMappingMatchResult, Integer, Hash)>] AITransformMappingMatchResult data, response status code and response headers
+    def test_transformer_mapping_match_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AIControllerApi.test_transformer_mapping_match ...'
+      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 AIControllerApi.test_transformer_mapping_match"
+      end
+      # resource path
+      local_var_path = '/ai/transformer/mappings/{id}/match'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'emailId'] = opts[:'email_id'] if !opts[:'email_id'].nil?
+      query_params[:'smsId'] = opts[:'sms_id'] if !opts[:'sms_id'].nil?
+      query_params[:'attachmentId'] = opts[:'attachment_id'] if !opts[:'attachment_id'].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] || 'AITransformMappingMatchResult' 
+
+      # 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: AIControllerApi#test_transformer_mapping_match\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Validate structured content schema
     # Check if a schema is valid and can be used to extract data using AI
     # @param structured_output_schema [StructuredOutputSchema]