mailslurp_client 15.21.1 → 16.0.4

data/lib/mailslurp_client/models/structured_output_schema.rb

@@ -0,0 +1,557 @@
+=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
+  # JSON output schema for structured content repsonses. This schema dictates the format that an AI should use when responding to your instructions.
+  class StructuredOutputSchema
+    attr_accessor :any_of
+
+    attr_accessor :default
+
+    # Provide a description of the schema to help the AI understand the schema.
+    attr_accessor :description
+
+    # When using type string and format enum pass a collection of enum values here.
+    attr_accessor :enum
+
+    attr_accessor :example
+
+    # Format for string types. Can be null, date-time or enum.
+    attr_accessor :format
+
+    attr_accessor :items
+
+    attr_accessor :max_items
+
+    attr_accessor :min_items
+
+    attr_accessor :max_length
+
+    attr_accessor :min_length
+
+    attr_accessor :pattern
+
+    # Properties of an OBJECT schema. These are key value pairs where the key is the property name and the value is the schema for that property.
+    attr_accessor :properties
+
+    # Pass an array of property names to specify the order of properties in the generated JSON object if required.
+    attr_accessor :property_ordering
+
+    attr_accessor :required
+
+    attr_accessor :max_properties
+
+    attr_accessor :min_properties
+
+    attr_accessor :maximum
+
+    attr_accessor :minimum
+
+    attr_accessor :nullable
+
+    attr_accessor :title
+
+    # Primitive JSON schema types with a fallback CUSTOM for unknown values.
+    attr_accessor :type
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'any_of' => :'anyOf',
+        :'default' => :'default',
+        :'description' => :'description',
+        :'enum' => :'enum',
+        :'example' => :'example',
+        :'format' => :'format',
+        :'items' => :'items',
+        :'max_items' => :'maxItems',
+        :'min_items' => :'minItems',
+        :'max_length' => :'maxLength',
+        :'min_length' => :'minLength',
+        :'pattern' => :'pattern',
+        :'properties' => :'properties',
+        :'property_ordering' => :'propertyOrdering',
+        :'required' => :'required',
+        :'max_properties' => :'maxProperties',
+        :'min_properties' => :'minProperties',
+        :'maximum' => :'maximum',
+        :'minimum' => :'minimum',
+        :'nullable' => :'nullable',
+        :'title' => :'title',
+        :'type' => :'type'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'any_of' => :'Array<StructuredOutputSchema>',
+        :'default' => :'Object',
+        :'description' => :'String',
+        :'enum' => :'Array<String>',
+        :'example' => :'Object',
+        :'format' => :'String',
+        :'items' => :'StructuredOutputSchema',
+        :'max_items' => :'Integer',
+        :'min_items' => :'Integer',
+        :'max_length' => :'Integer',
+        :'min_length' => :'Integer',
+        :'pattern' => :'String',
+        :'properties' => :'Hash<String, StructuredOutputSchema>',
+        :'property_ordering' => :'Array<String>',
+        :'required' => :'Array<String>',
+        :'max_properties' => :'Integer',
+        :'min_properties' => :'Integer',
+        :'maximum' => :'Float',
+        :'minimum' => :'Float',
+        :'nullable' => :'Boolean',
+        :'title' => :'String',
+        :'type' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'any_of',
+        :'default',
+        :'description',
+        :'enum',
+        :'example',
+        :'format',
+        :'max_items',
+        :'min_items',
+        :'max_length',
+        :'min_length',
+        :'pattern',
+        :'properties',
+        :'property_ordering',
+        :'required',
+        :'max_properties',
+        :'min_properties',
+        :'maximum',
+        :'minimum',
+        :'nullable',
+        :'title',
+        :'type'
+      ])
+    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::StructuredOutputSchema` 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::StructuredOutputSchema`. 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?(:'any_of')
+        if (value = attributes[:'any_of']).is_a?(Array)
+          self.any_of = value
+        end
+      end
+
+      if attributes.key?(:'default')
+        self.default = attributes[:'default']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'enum')
+        if (value = attributes[:'enum']).is_a?(Array)
+          self.enum = value
+        end
+      end
+
+      if attributes.key?(:'example')
+        self.example = attributes[:'example']
+      end
+
+      if attributes.key?(:'format')
+        self.format = attributes[:'format']
+      end
+
+      if attributes.key?(:'items')
+        self.items = attributes[:'items']
+      end
+
+      if attributes.key?(:'max_items')
+        self.max_items = attributes[:'max_items']
+      end
+
+      if attributes.key?(:'min_items')
+        self.min_items = attributes[:'min_items']
+      end
+
+      if attributes.key?(:'max_length')
+        self.max_length = attributes[:'max_length']
+      end
+
+      if attributes.key?(:'min_length')
+        self.min_length = attributes[:'min_length']
+      end
+
+      if attributes.key?(:'pattern')
+        self.pattern = attributes[:'pattern']
+      end
+
+      if attributes.key?(:'properties')
+        if (value = attributes[:'properties']).is_a?(Hash)
+          self.properties = value
+        end
+      end
+
+      if attributes.key?(:'property_ordering')
+        if (value = attributes[:'property_ordering']).is_a?(Array)
+          self.property_ordering = value
+        end
+      end
+
+      if attributes.key?(:'required')
+        if (value = attributes[:'required']).is_a?(Array)
+          self.required = value
+        end
+      end
+
+      if attributes.key?(:'max_properties')
+        self.max_properties = attributes[:'max_properties']
+      end
+
+      if attributes.key?(:'min_properties')
+        self.min_properties = attributes[:'min_properties']
+      end
+
+      if attributes.key?(:'maximum')
+        self.maximum = attributes[:'maximum']
+      end
+
+      if attributes.key?(:'minimum')
+        self.minimum = attributes[:'minimum']
+      end
+
+      if attributes.key?(:'nullable')
+        self.nullable = attributes[:'nullable']
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      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 !@max_items.nil? && @max_items < 0
+        invalid_properties.push('invalid value for "max_items", must be greater than or equal to 0.')
+      end
+
+      if !@min_items.nil? && @min_items < 0
+        invalid_properties.push('invalid value for "min_items", must be greater than or equal to 0.')
+      end
+
+      if !@max_length.nil? && @max_length < 0
+        invalid_properties.push('invalid value for "max_length", must be greater than or equal to 0.')
+      end
+
+      if !@min_length.nil? && @min_length < 0
+        invalid_properties.push('invalid value for "min_length", must be greater than or equal to 0.')
+      end
+
+      if !@max_properties.nil? && @max_properties < 0
+        invalid_properties.push('invalid value for "max_properties", must be greater than or equal to 0.')
+      end
+
+      if !@min_properties.nil? && @min_properties < 0
+        invalid_properties.push('invalid value for "min_properties", must be greater than or equal to 0.')
+      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 !@max_items.nil? && @max_items < 0
+      return false if !@min_items.nil? && @min_items < 0
+      return false if !@max_length.nil? && @max_length < 0
+      return false if !@min_length.nil? && @min_length < 0
+      return false if !@max_properties.nil? && @max_properties < 0
+      return false if !@min_properties.nil? && @min_properties < 0
+      type_validator = EnumAttributeValidator.new('String', ["string", "number", "integer", "boolean", "object", "array", "null"])
+      return false unless type_validator.valid?(@type)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] max_items Value to be assigned
+    def max_items=(max_items)
+      if !max_items.nil? && max_items < 0
+        fail ArgumentError, 'invalid value for "max_items", must be greater than or equal to 0.'
+      end
+
+      @max_items = max_items
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] min_items Value to be assigned
+    def min_items=(min_items)
+      if !min_items.nil? && min_items < 0
+        fail ArgumentError, 'invalid value for "min_items", must be greater than or equal to 0.'
+      end
+
+      @min_items = min_items
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] max_length Value to be assigned
+    def max_length=(max_length)
+      if !max_length.nil? && max_length < 0
+        fail ArgumentError, 'invalid value for "max_length", must be greater than or equal to 0.'
+      end
+
+      @max_length = max_length
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] min_length Value to be assigned
+    def min_length=(min_length)
+      if !min_length.nil? && min_length < 0
+        fail ArgumentError, 'invalid value for "min_length", must be greater than or equal to 0.'
+      end
+
+      @min_length = min_length
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] max_properties Value to be assigned
+    def max_properties=(max_properties)
+      if !max_properties.nil? && max_properties < 0
+        fail ArgumentError, 'invalid value for "max_properties", must be greater than or equal to 0.'
+      end
+
+      @max_properties = max_properties
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] min_properties Value to be assigned
+    def min_properties=(min_properties)
+      if !min_properties.nil? && min_properties < 0
+        fail ArgumentError, 'invalid value for "min_properties", must be greater than or equal to 0.'
+      end
+
+      @min_properties = min_properties
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["string", "number", "integer", "boolean", "object", "array", "null"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    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 &&
+          any_of == o.any_of &&
+          default == o.default &&
+          description == o.description &&
+          enum == o.enum &&
+          example == o.example &&
+          format == o.format &&
+          items == o.items &&
+          max_items == o.max_items &&
+          min_items == o.min_items &&
+          max_length == o.max_length &&
+          min_length == o.min_length &&
+          pattern == o.pattern &&
+          properties == o.properties &&
+          property_ordering == o.property_ordering &&
+          required == o.required &&
+          max_properties == o.max_properties &&
+          min_properties == o.min_properties &&
+          maximum == o.maximum &&
+          minimum == o.minimum &&
+          nullable == o.nullable &&
+          title == o.title &&
+          type == o.type
+    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
+      [any_of, default, description, enum, example, format, items, max_items, min_items, max_length, min_length, pattern, properties, property_ordering, required, max_properties, min_properties, maximum, minimum, nullable, title, type].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 = '15.21.1'
+  VERSION = '16.0.4'
 end

data/lib/mailslurp_client.rb

@@ -149,6 +149,7 @@ require 'mailslurp_client/models/generate_dmarc_record_options'
 require 'mailslurp_client/models/generate_dmarc_record_results'
 require 'mailslurp_client/models/generate_mta_sts_record_options'
 require 'mailslurp_client/models/generate_mta_sts_record_results'
+require 'mailslurp_client/models/generate_structured_content_email_options'
 require 'mailslurp_client/models/generate_tls_reporting_record_options'
 require 'mailslurp_client/models/generate_tls_reporting_record_results'
 require 'mailslurp_client/models/get_email_screenshot_options'
@@ -318,6 +319,8 @@ require 'mailslurp_client/models/sms_send_options'
 require 'mailslurp_client/models/smtp_access_details'
 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/template_dto'
 require 'mailslurp_client/models/template_preview'
 require 'mailslurp_client/models/template_projection'
@@ -377,6 +380,7 @@ require 'mailslurp_client/models/webhook_test_response'
 require 'mailslurp_client/models/webhook_test_result'
 
 # APIs
+require 'mailslurp_client/api/ai_controller_api'
 require 'mailslurp_client/api/alias_controller_api'
 require 'mailslurp_client/api/attachment_controller_api'
 require 'mailslurp_client/api/bounce_controller_api'
@@ -404,7 +408,6 @@ require 'mailslurp_client/api/o_auth_connection_api'
 require 'mailslurp_client/api/phone_controller_api'
 require 'mailslurp_client/api/sent_emails_controller_api'
 require 'mailslurp_client/api/sms_controller_api'
-require 'mailslurp_client/api/sse_controller_api'
 require 'mailslurp_client/api/template_controller_api'
 require 'mailslurp_client/api/tools_controller_api'
 require 'mailslurp_client/api/tracking_controller_api'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailslurp_client
 version: !ruby/object:Gem::Version
-  version: 15.21.1
+  version: 16.0.4
 platform: ruby
 authors:
 - mailslurp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-05-11 00:00:00.000000000 Z
+date: 2025-05-22 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
@@ -23,6 +23,7 @@ files:
 - SECURITY.md
 - SUPPORT.md
 - lib/mailslurp_client.rb
+- lib/mailslurp_client/api/ai_controller_api.rb
 - lib/mailslurp_client/api/alias_controller_api.rb
 - lib/mailslurp_client/api/attachment_controller_api.rb
 - lib/mailslurp_client/api/bounce_controller_api.rb
@@ -50,7 +51,6 @@ files:
 - lib/mailslurp_client/api/phone_controller_api.rb
 - lib/mailslurp_client/api/sent_emails_controller_api.rb
 - lib/mailslurp_client/api/sms_controller_api.rb
-- lib/mailslurp_client/api/sse_controller_api.rb
 - lib/mailslurp_client/api/template_controller_api.rb
 - lib/mailslurp_client/api/tools_controller_api.rb
 - lib/mailslurp_client/api/tracking_controller_api.rb
@@ -192,6 +192,7 @@ files:
 - lib/mailslurp_client/models/generate_dmarc_record_results.rb
 - lib/mailslurp_client/models/generate_mta_sts_record_options.rb
 - lib/mailslurp_client/models/generate_mta_sts_record_results.rb
+- lib/mailslurp_client/models/generate_structured_content_email_options.rb
 - lib/mailslurp_client/models/generate_tls_reporting_record_options.rb
 - lib/mailslurp_client/models/generate_tls_reporting_record_results.rb
 - lib/mailslurp_client/models/get_email_screenshot_options.rb
@@ -361,6 +362,8 @@ files:
 - lib/mailslurp_client/models/smtp_access_details.rb
 - lib/mailslurp_client/models/sort_object.rb
 - 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/template_dto.rb
 - lib/mailslurp_client/models/template_preview.rb
 - lib/mailslurp_client/models/template_projection.rb