mailslurp_client 16.1.0 → 16.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7971e90590ed1ba764700daeea4c2759f07a908f3bfbe8acfeb35bf7788db56b
-  data.tar.gz: a15be1803a074d2ed65b308b2adfad8660eb9656ca60da6df34e2d3f119c2c72
+  metadata.gz: 721d86a1a795042b4160e785468d389da75506821303cf137ad5f612eb03525d
+  data.tar.gz: 93d521285ffeeff92219f75fb6beffd713c50d67e304f9cf19b376d5d75028b7
 SHA512:
-  metadata.gz: d23d629960bcdd3a8d28a32994aed0899b9bf3882e1eeedbead0c95c64bbd0e7e4bc85354d9fa3ad23fa25d7a718ba43130586323ae7c982369c7e4ed75ea7b1
-  data.tar.gz: 1f64552a63710adbf3ff71333a7630b4efaaa126b8db28f57a957b0445487b2cff9a1c4926cac7473aa91854b855e1f2b5d51d0b603ec1495e2cb07364bd6b85
+  metadata.gz: cebe7dad2d5516d911ff06e7724f292f55ddc398b9426255328e30d2acf13099d677fb77a768787b2a4a180655cef95a4298d56de6010fac95d8c912a9e3da23
+  data.tar.gz: b141f6384de76ddf78789d9663112880314fe856503f1f558f6e91634abf1c9a2ddb59ec903b6100276775134dd86d28a8195739e6325e60e3a959e3ae13725e

data/lib/mailslurp_client/api/ai_controller_api.rb

@@ -82,5 +82,69 @@ module MailSlurpClient
       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] 
+    # @param [Hash] opts the optional parameters
+    # @return [StructuredOutputSchemaValidation]
+    def validate_structured_output_schema(structured_output_schema, opts = {})
+      data, _status_code, _headers = validate_structured_output_schema_with_http_info(structured_output_schema, opts)
+      data
+    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] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(StructuredOutputSchemaValidation, Integer, Hash)>] StructuredOutputSchemaValidation data, response status code and response headers
+    def validate_structured_output_schema_with_http_info(structured_output_schema, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AIControllerApi.validate_structured_output_schema ...'
+      end
+      # verify the required parameter 'structured_output_schema' is set
+      if @api_client.config.client_side_validation && structured_output_schema.nil?
+        fail ArgumentError, "Missing the required parameter 'structured_output_schema' when calling AIControllerApi.validate_structured_output_schema"
+      end
+      # resource path
+      local_var_path = '/ai/structured-content/validate'
+
+      # 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(structured_output_schema) 
+
+      # return_type
+      return_type = opts[:return_type] || 'StructuredOutputSchemaValidation' 
+
+      # 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#validate_structured_output_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/mailslurp_client/models/sent_email_projection.rb

@@ -16,14 +16,14 @@ module MailSlurpClient
   class SentEmailProjection
     attr_accessor :id
 
+    attr_accessor :subject
+
     attr_accessor :from
 
     attr_accessor :sender
 
     attr_accessor :recipients
 
-    attr_accessor :subject
-
     attr_accessor :user_id
 
     attr_accessor :attachments
@@ -56,10 +56,10 @@ module MailSlurpClient
     def self.attribute_map
       {
         :'id' => :'id',
+        :'subject' => :'subject',
         :'from' => :'from',
         :'sender' => :'sender',
         :'recipients' => :'recipients',
-        :'subject' => :'subject',
         :'user_id' => :'userId',
         :'attachments' => :'attachments',
         :'inbox_id' => :'inboxId',
@@ -81,10 +81,10 @@ module MailSlurpClient
     def self.openapi_types
       {
         :'id' => :'String',
+        :'subject' => :'String',
         :'from' => :'String',
         :'sender' => :'Sender',
         :'recipients' => :'EmailRecipients',
-        :'subject' => :'String',
         :'user_id' => :'String',
         :'attachments' => :'Array<String>',
         :'inbox_id' => :'String',
@@ -105,10 +105,10 @@ module MailSlurpClient
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'subject',
         :'from',
         :'sender',
         :'recipients',
-        :'subject',
         :'attachments',
         :'message_id',
         :'in_reply_to',
@@ -138,6 +138,10 @@ module MailSlurpClient
         self.id = attributes[:'id']
       end
 
+      if attributes.key?(:'subject')
+        self.subject = attributes[:'subject']
+      end
+
       if attributes.key?(:'from')
         self.from = attributes[:'from']
       end
@@ -150,10 +154,6 @@ module MailSlurpClient
         self.recipients = attributes[:'recipients']
       end
 
-      if attributes.key?(:'subject')
-        self.subject = attributes[:'subject']
-      end
-
       if attributes.key?(:'user_id')
         self.user_id = attributes[:'user_id']
       end
@@ -278,10 +278,10 @@ module MailSlurpClient
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
+          subject == o.subject &&
           from == o.from &&
           sender == o.sender &&
           recipients == o.recipients &&
-          subject == o.subject &&
           user_id == o.user_id &&
           attachments == o.attachments &&
           inbox_id == o.inbox_id &&
@@ -307,7 +307,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, from, sender, recipients, subject, user_id, attachments, inbox_id, created_at, to, cc, bcc, message_id, in_reply_to, body_excerpt, text_excerpt, body_md5_hash, virtual_send, thread_id].hash
+      [id, subject, from, sender, recipients, user_id, attachments, inbox_id, created_at, to, cc, bcc, message_id, in_reply_to, body_excerpt, text_excerpt, body_md5_hash, virtual_send, thread_id].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/sort_object.rb

@@ -14,17 +14,17 @@ require 'date'
 
 module MailSlurpClient
   class SortObject
-    attr_accessor :unsorted
-
     attr_accessor :sorted
 
+    attr_accessor :unsorted
+
     attr_accessor :empty
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'unsorted' => :'unsorted',
         :'sorted' => :'sorted',
+        :'unsorted' => :'unsorted',
         :'empty' => :'empty'
       }
     end
@@ -32,8 +32,8 @@ module MailSlurpClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'unsorted' => :'Boolean',
         :'sorted' => :'Boolean',
+        :'unsorted' => :'Boolean',
         :'empty' => :'Boolean'
       }
     end
@@ -59,14 +59,14 @@ module MailSlurpClient
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'unsorted')
-        self.unsorted = attributes[:'unsorted']
-      end
-
       if attributes.key?(:'sorted')
         self.sorted = attributes[:'sorted']
       end
 
+      if attributes.key?(:'unsorted')
+        self.unsorted = attributes[:'unsorted']
+      end
+
       if attributes.key?(:'empty')
         self.empty = attributes[:'empty']
       end
@@ -90,8 +90,8 @@ module MailSlurpClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          unsorted == o.unsorted &&
           sorted == o.sorted &&
+          unsorted == o.unsorted &&
           empty == o.empty
     end
 
@@ -104,7 +104,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [unsorted, sorted, empty].hash
+      [sorted, unsorted, empty].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/structured_output_schema_validation.rb

@@ -0,0 +1,231 @@
+=begin
+#MailSlurp API
+
+#MailSlurp is an API for sending and receiving emails and SMS from dynamically allocated email addresses and phone numbers. 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://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository
+
+The version of the OpenAPI document: 6.5.2
+Contact: contact@mailslurp.dev
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module MailSlurpClient
+  class StructuredOutputSchemaValidation
+    attr_accessor :valid
+
+    attr_accessor :errors
+
+    attr_accessor :example_output
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'valid' => :'valid',
+        :'errors' => :'errors',
+        :'example_output' => :'exampleOutput'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'valid' => :'Boolean',
+        :'errors' => :'Array<String>',
+        :'example_output' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::StructuredOutputSchemaValidation` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `MailSlurpClient::StructuredOutputSchemaValidation`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'valid')
+        self.valid = attributes[:'valid']
+      end
+
+      if attributes.key?(:'errors')
+        if (value = attributes[:'errors']).is_a?(Array)
+          self.errors = value
+        end
+      end
+
+      if attributes.key?(:'example_output')
+        self.example_output = attributes[:'example_output']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @valid.nil?
+        invalid_properties.push('invalid value for "valid", valid cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @valid.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          valid == o.valid &&
+          errors == o.errors &&
+          example_output == o.example_output
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [valid, errors, example_output].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        MailSlurpClient.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+        
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/mailslurp_client/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 4.3.1
 =end
 
 module MailSlurpClient
-  VERSION = '16.1.0'
+  VERSION = '16.1.1'
 end

data/lib/mailslurp_client.rb

@@ -321,6 +321,7 @@ require 'mailslurp_client/models/sort_object'
 require 'mailslurp_client/models/spelling_issue'
 require 'mailslurp_client/models/structured_content_result'
 require 'mailslurp_client/models/structured_output_schema'
+require 'mailslurp_client/models/structured_output_schema_validation'
 require 'mailslurp_client/models/template_dto'
 require 'mailslurp_client/models/template_preview'
 require 'mailslurp_client/models/template_projection'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailslurp_client
 version: !ruby/object:Gem::Version
-  version: 16.1.0
+  version: 16.1.1
 platform: ruby
 authors:
 - mailslurp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-05-23 00:00:00.000000000 Z
+date: 2025-05-24 00:00:00.000000000 Z
 dependencies: []
 description: Create emails addresses in Ruby then send and receive real emails and
   attachments. See https://www.mailslurp.com/ruby/ for full Ruby documentation. Get
@@ -364,6 +364,7 @@ files:
 - lib/mailslurp_client/models/spelling_issue.rb
 - lib/mailslurp_client/models/structured_content_result.rb
 - lib/mailslurp_client/models/structured_output_schema.rb
+- lib/mailslurp_client/models/structured_output_schema_validation.rb
 - lib/mailslurp_client/models/template_dto.rb
 - lib/mailslurp_client/models/template_preview.rb
 - lib/mailslurp_client/models/template_projection.rb