mailslurp_client 16.1.1 → 16.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 721d86a1a795042b4160e785468d389da75506821303cf137ad5f612eb03525d
-  data.tar.gz: 93d521285ffeeff92219f75fb6beffd713c50d67e304f9cf19b376d5d75028b7
+  metadata.gz: b492d4191b18fa05d5e786346cef136f346825a1fd1720abf872b1f419c647da
+  data.tar.gz: 7e0c138324715014156cd2259353b04e9c6f04991dcb7ff649df3f4b6ed4a891
 SHA512:
-  metadata.gz: cebe7dad2d5516d911ff06e7724f292f55ddc398b9426255328e30d2acf13099d677fb77a768787b2a4a180655cef95a4298d56de6010fac95d8c912a9e3da23
-  data.tar.gz: b141f6384de76ddf78789d9663112880314fe856503f1f558f6e91634abf1c9a2ddb59ec903b6100276775134dd86d28a8195739e6325e60e3a959e3ae13725e
+  metadata.gz: 7c2e131375f887f41b8e4d263d36af50f39765f7dd7db40e6b7c0abc09b76eb42cc5bb26fd76a7503b8673ddefc577cf910409c8b60651ad4fa026664ec1e974
+  data.tar.gz: 342ec2079c9a1bb5740aaf12f2b141893178f18ae1f895a19158db8cd6e4bd8eab3d916290d909411d1e8e6ab50029f8495d5de9f08b69512eef2f6b7ca1fe46

data/lib/mailslurp_client/api/ai_controller_api.rb

@@ -19,6 +19,70 @@ module MailSlurpClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     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] 
+    # @param [Hash] opts the optional parameters
+    # @return [StructuredContentResult]
+    def generate_structured_content_from_attachment(generate_structured_content_attachment_options, opts = {})
+      data, _status_code, _headers = generate_structured_content_from_attachment_with_http_info(generate_structured_content_attachment_options, opts)
+      data
+    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] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(StructuredContentResult, Integer, Hash)>] StructuredContentResult data, response status code and response headers
+    def generate_structured_content_from_attachment_with_http_info(generate_structured_content_attachment_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AIControllerApi.generate_structured_content_from_attachment ...'
+      end
+      # verify the required parameter 'generate_structured_content_attachment_options' is set
+      if @api_client.config.client_side_validation && generate_structured_content_attachment_options.nil?
+        fail ArgumentError, "Missing the required parameter 'generate_structured_content_attachment_options' when calling AIControllerApi.generate_structured_content_from_attachment"
+      end
+      # resource path
+      local_var_path = '/ai/structured-content/attachment'
+
+      # 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(generate_structured_content_attachment_options) 
+
+      # return_type
+      return_type = opts[:return_type] || 'StructuredContentResult' 
+
+      # 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#generate_structured_content_from_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Generate structured content for an email
     # Use output schemas to extract data from an email using AI
     # @param generate_structured_content_email_options [GenerateStructuredContentEmailOptions] 

data/lib/mailslurp_client/models/email_projection.rb

@@ -37,12 +37,12 @@ module MailSlurpClient
 
     attr_accessor :favourite
 
-    attr_accessor :in_reply_to
-
     attr_accessor :plus_address
 
     attr_accessor :size_bytes
 
+    attr_accessor :in_reply_to
+
     attr_accessor :read
 
     attr_accessor :body_excerpt
@@ -77,9 +77,9 @@ module MailSlurpClient
         :'message_id' => :'messageId',
         :'domain_id' => :'domainId',
         :'favourite' => :'favourite',
-        :'in_reply_to' => :'inReplyTo',
         :'plus_address' => :'plusAddress',
         :'size_bytes' => :'sizeBytes',
+        :'in_reply_to' => :'inReplyTo',
         :'read' => :'read',
         :'body_excerpt' => :'bodyExcerpt',
         :'text_excerpt' => :'textExcerpt',
@@ -107,9 +107,9 @@ module MailSlurpClient
         :'message_id' => :'String',
         :'domain_id' => :'String',
         :'favourite' => :'Boolean',
-        :'in_reply_to' => :'String',
         :'plus_address' => :'String',
         :'size_bytes' => :'Integer',
+        :'in_reply_to' => :'String',
         :'read' => :'Boolean',
         :'body_excerpt' => :'String',
         :'text_excerpt' => :'String',
@@ -134,9 +134,9 @@ module MailSlurpClient
         :'message_id',
         :'domain_id',
         :'favourite',
-        :'in_reply_to',
         :'plus_address',
         :'size_bytes',
+        :'in_reply_to',
         :'body_excerpt',
         :'text_excerpt',
         :'body_part_content_types',
@@ -214,10 +214,6 @@ module MailSlurpClient
         self.favourite = attributes[:'favourite']
       end
 
-      if attributes.key?(:'in_reply_to')
-        self.in_reply_to = attributes[:'in_reply_to']
-      end
-
       if attributes.key?(:'plus_address')
         self.plus_address = attributes[:'plus_address']
       end
@@ -226,6 +222,10 @@ module MailSlurpClient
         self.size_bytes = attributes[:'size_bytes']
       end
 
+      if attributes.key?(:'in_reply_to')
+        self.in_reply_to = attributes[:'in_reply_to']
+      end
+
       if attributes.key?(:'read')
         self.read = attributes[:'read']
       end
@@ -328,9 +328,9 @@ module MailSlurpClient
           message_id == o.message_id &&
           domain_id == o.domain_id &&
           favourite == o.favourite &&
-          in_reply_to == o.in_reply_to &&
           plus_address == o.plus_address &&
           size_bytes == o.size_bytes &&
+          in_reply_to == o.in_reply_to &&
           read == o.read &&
           body_excerpt == o.body_excerpt &&
           text_excerpt == o.text_excerpt &&
@@ -352,7 +352,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [sender, recipients, attachments, inbox_id, created_at, to, cc, bcc, message_id, domain_id, favourite, in_reply_to, plus_address, size_bytes, read, body_excerpt, text_excerpt, body_part_content_types, body_md5_hash, team_access, subject, id, thread_id, from].hash
+      [sender, recipients, attachments, inbox_id, created_at, to, cc, bcc, message_id, domain_id, favourite, plus_address, size_bytes, in_reply_to, read, body_excerpt, text_excerpt, body_part_content_types, body_md5_hash, team_access, subject, id, thread_id, from].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/email_thread_projection.rb

@@ -43,12 +43,6 @@ module MailSlurpClient
     # Has attachments
     attr_accessor :has_attachments
 
-    # Has unread
-    attr_accessor :unread
-
-    # Number of messages in the thread
-    attr_accessor :message_count
-
     # Last body excerpt
     attr_accessor :last_body_excerpt
 
@@ -63,6 +57,12 @@ module MailSlurpClient
 
     attr_accessor :last_sender
 
+    # Number of messages in the thread
+    attr_accessor :message_count
+
+    # Has unread
+    attr_accessor :unread
+
     # Thread topic subject
     attr_accessor :subject
 
@@ -85,13 +85,13 @@ module MailSlurpClient
         :'cc' => :'cc',
         :'bcc' => :'bcc',
         :'has_attachments' => :'hasAttachments',
-        :'unread' => :'unread',
-        :'message_count' => :'messageCount',
         :'last_body_excerpt' => :'lastBodyExcerpt',
         :'last_text_excerpt' => :'lastTextExcerpt',
         :'last_created_at' => :'lastCreatedAt',
         :'last_from' => :'lastFrom',
         :'last_sender' => :'lastSender',
+        :'message_count' => :'messageCount',
+        :'unread' => :'unread',
         :'subject' => :'subject',
         :'id' => :'id',
         :'from' => :'from'
@@ -111,13 +111,13 @@ module MailSlurpClient
         :'cc' => :'Array<String>',
         :'bcc' => :'Array<String>',
         :'has_attachments' => :'Boolean',
-        :'unread' => :'Boolean',
-        :'message_count' => :'Integer',
         :'last_body_excerpt' => :'String',
         :'last_text_excerpt' => :'String',
         :'last_created_at' => :'DateTime',
         :'last_from' => :'String',
         :'last_sender' => :'SenderProjection',
+        :'message_count' => :'Integer',
+        :'unread' => :'Boolean',
         :'subject' => :'String',
         :'id' => :'String',
         :'from' => :'String'
@@ -191,14 +191,6 @@ module MailSlurpClient
         self.has_attachments = attributes[:'has_attachments']
       end
 
-      if attributes.key?(:'unread')
-        self.unread = attributes[:'unread']
-      end
-
-      if attributes.key?(:'message_count')
-        self.message_count = attributes[:'message_count']
-      end
-
       if attributes.key?(:'last_body_excerpt')
         self.last_body_excerpt = attributes[:'last_body_excerpt']
       end
@@ -219,6 +211,14 @@ module MailSlurpClient
         self.last_sender = attributes[:'last_sender']
       end
 
+      if attributes.key?(:'message_count')
+        self.message_count = attributes[:'message_count']
+      end
+
+      if attributes.key?(:'unread')
+        self.unread = attributes[:'unread']
+      end
+
       if attributes.key?(:'subject')
         self.subject = attributes[:'subject']
       end
@@ -256,14 +256,14 @@ module MailSlurpClient
         invalid_properties.push('invalid value for "has_attachments", has_attachments cannot be nil.')
       end
 
-      if @unread.nil?
-        invalid_properties.push('invalid value for "unread", unread cannot be nil.')
-      end
-
       if @message_count.nil?
         invalid_properties.push('invalid value for "message_count", message_count cannot be nil.')
       end
 
+      if @unread.nil?
+        invalid_properties.push('invalid value for "unread", unread cannot be nil.')
+      end
+
       if @id.nil?
         invalid_properties.push('invalid value for "id", id cannot be nil.')
       end
@@ -279,8 +279,8 @@ module MailSlurpClient
       return false if @created_at.nil?
       return false if @to.nil?
       return false if @has_attachments.nil?
-      return false if @unread.nil?
       return false if @message_count.nil?
+      return false if @unread.nil?
       return false if @id.nil?
       true
     end
@@ -300,13 +300,13 @@ module MailSlurpClient
           cc == o.cc &&
           bcc == o.bcc &&
           has_attachments == o.has_attachments &&
-          unread == o.unread &&
-          message_count == o.message_count &&
           last_body_excerpt == o.last_body_excerpt &&
           last_text_excerpt == o.last_text_excerpt &&
           last_created_at == o.last_created_at &&
           last_from == o.last_from &&
           last_sender == o.last_sender &&
+          message_count == o.message_count &&
+          unread == o.unread &&
           subject == o.subject &&
           id == o.id &&
           from == o.from
@@ -321,7 +321,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [sender, recipients, user_id, inbox_id, updated_at, created_at, to, cc, bcc, has_attachments, unread, message_count, last_body_excerpt, last_text_excerpt, last_created_at, last_from, last_sender, subject, id, from].hash
+      [sender, recipients, user_id, inbox_id, updated_at, created_at, to, cc, bcc, has_attachments, last_body_excerpt, last_text_excerpt, last_created_at, last_from, last_sender, message_count, unread, subject, id, from].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/generate_structured_content_attachment_options.rb

@@ -0,0 +1,237 @@
+=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
+  # Options for generating structured content output from an attachment
+  class GenerateStructuredContentAttachmentOptions
+    # Attachment ID to read and pass to AI
+    attr_accessor :attachment_id
+
+    # Optional instructions for the AI to follow. Try to be precise and clear. You can include examples and hints.
+    attr_accessor :instructions
+
+    attr_accessor :output_schema
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'attachment_id' => :'attachmentId',
+        :'instructions' => :'instructions',
+        :'output_schema' => :'outputSchema'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'attachment_id' => :'String',
+        :'instructions' => :'String',
+        :'output_schema' => :'StructuredOutputSchema'
+      }
+    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::GenerateStructuredContentAttachmentOptions` 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::GenerateStructuredContentAttachmentOptions`. 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?(:'attachment_id')
+        self.attachment_id = attributes[:'attachment_id']
+      end
+
+      if attributes.key?(:'instructions')
+        self.instructions = attributes[:'instructions']
+      end
+
+      if attributes.key?(:'output_schema')
+        self.output_schema = attributes[:'output_schema']
+      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 @attachment_id.nil?
+        invalid_properties.push('invalid value for "attachment_id", attachment_id cannot be nil.')
+      end
+
+      if @output_schema.nil?
+        invalid_properties.push('invalid value for "output_schema", output_schema 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 @attachment_id.nil?
+      return false if @output_schema.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 &&
+          attachment_id == o.attachment_id &&
+          instructions == o.instructions &&
+          output_schema == o.output_schema
+    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
+      [attachment_id, instructions, output_schema].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/models/page_alias.rb

@@ -19,10 +19,10 @@ module MailSlurpClient
 
     attr_accessor :pageable
 
-    attr_accessor :total_elements
-
     attr_accessor :total_pages
 
+    attr_accessor :total_elements
+
     attr_accessor :last
 
     attr_accessor :number_of_elements
@@ -42,8 +42,8 @@ module MailSlurpClient
       {
         :'content' => :'content',
         :'pageable' => :'pageable',
-        :'total_elements' => :'totalElements',
         :'total_pages' => :'totalPages',
+        :'total_elements' => :'totalElements',
         :'last' => :'last',
         :'number_of_elements' => :'numberOfElements',
         :'first' => :'first',
@@ -59,8 +59,8 @@ module MailSlurpClient
       {
         :'content' => :'Array<AliasProjection>',
         :'pageable' => :'PageableObject',
-        :'total_elements' => :'Integer',
         :'total_pages' => :'Integer',
+        :'total_elements' => :'Integer',
         :'last' => :'Boolean',
         :'number_of_elements' => :'Integer',
         :'first' => :'Boolean',
@@ -102,14 +102,14 @@ module MailSlurpClient
         self.pageable = attributes[:'pageable']
       end
 
-      if attributes.key?(:'total_elements')
-        self.total_elements = attributes[:'total_elements']
-      end
-
       if attributes.key?(:'total_pages')
         self.total_pages = attributes[:'total_pages']
       end
 
+      if attributes.key?(:'total_elements')
+        self.total_elements = attributes[:'total_elements']
+      end
+
       if attributes.key?(:'last')
         self.last = attributes[:'last']
       end
@@ -143,22 +143,22 @@ module MailSlurpClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @total_elements.nil?
-        invalid_properties.push('invalid value for "total_elements", total_elements cannot be nil.')
-      end
-
       if @total_pages.nil?
         invalid_properties.push('invalid value for "total_pages", total_pages cannot be nil.')
       end
 
+      if @total_elements.nil?
+        invalid_properties.push('invalid value for "total_elements", total_elements 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 @total_elements.nil?
       return false if @total_pages.nil?
+      return false if @total_elements.nil?
       true
     end
 
@@ -169,8 +169,8 @@ module MailSlurpClient
       self.class == o.class &&
           content == o.content &&
           pageable == o.pageable &&
-          total_elements == o.total_elements &&
           total_pages == o.total_pages &&
+          total_elements == o.total_elements &&
           last == o.last &&
           number_of_elements == o.number_of_elements &&
           first == o.first &&
@@ -189,7 +189,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [content, pageable, total_elements, total_pages, last, number_of_elements, first, size, number, sort, empty].hash
+      [content, pageable, total_pages, total_elements, last, number_of_elements, first, size, number, sort, empty].hash
     end
 
     # Builds the object from hash