mailslurp_client 15.21.1 → 16.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b949a60311c2b1cf276d6ebf75ebd4de078f1c8d9965555c59bfae7f566d5a69
-  data.tar.gz: b70e2f6a7243e735deadb15aee4f1e4de2c7a386250ea7adf97ceb0296ef59ed
+  metadata.gz: 96fa2cfefba0f6a9b235b2fe25ae534666dbb363074594c2b582adc9782f34a5
+  data.tar.gz: f523a9482a4dc1f9df76a943125068241deae03e2bb94bbf090f24367365b751
 SHA512:
-  metadata.gz: 291a348e82692d6b7afadcb9a9decd14482a4759086e848b7e0f39d8c69bc166da65ec3dc795241b2546eb38e4c7d68fc4decd59c93ce9942a8a0a45c1bb6d2f
-  data.tar.gz: e7be1ad8b4b3df4f02dbeb78b40d176730af79c46cb1ed396176f09ba5c3f28a23e6604736c82e6be3c4f1ac1b667d8fda9ef33b6c2c4cfe7f6fe33107163c3c
+  metadata.gz: 29f28f9f2a3f48ab9cd9897faf1926eca1e1aa1a6176ca06e1f0a9e5968bf00db4a787ce9998c0e67ad7b0682a5c232ceb12f896cf8400bebcaa6937e3ac8a0b
+  data.tar.gz: 5ef509e8d1fad73d27f9d20752d7b4544c28913e77a17621bc3747f4d1f32314c3b2a91123fe064e310c7a4d4d3c920c23e35bd3989f72ee970707cc81b2d32c

data/lib/mailslurp_client/api/ai_controller_api.rb

@@ -0,0 +1,86 @@
+=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 'cgi'
+
+module MailSlurpClient
+  class AIControllerApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    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] 
+    # @param [Hash] opts the optional parameters
+    # @return [StructuredContentResult]
+    def generate_structured_content_from_email(generate_structured_content_email_options, opts = {})
+      data, _status_code, _headers = generate_structured_content_from_email_with_http_info(generate_structured_content_email_options, opts)
+      data
+    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] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(StructuredContentResult, Integer, Hash)>] StructuredContentResult data, response status code and response headers
+    def generate_structured_content_from_email_with_http_info(generate_structured_content_email_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AIControllerApi.generate_structured_content_from_email ...'
+      end
+      # verify the required parameter 'generate_structured_content_email_options' is set
+      if @api_client.config.client_side_validation && generate_structured_content_email_options.nil?
+        fail ArgumentError, "Missing the required parameter 'generate_structured_content_email_options' when calling AIControllerApi.generate_structured_content_from_email"
+      end
+      # resource path
+      local_var_path = '/ai/structured-content/email'
+
+      # 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_email_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_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/mailslurp_client/api/phone_controller_api.rb

@@ -711,26 +711,33 @@ module MailSlurpClient
 
     # Get a phone number by name
     # Get a phone number by name
+    # @param name [String] 
     # @param [Hash] opts the optional parameters
     # @return [PhoneNumberDto]
-    def get_phone_number_by_name(opts = {})
-      data, _status_code, _headers = get_phone_number_by_name_with_http_info(opts)
+    def get_phone_number_by_name(name, opts = {})
+      data, _status_code, _headers = get_phone_number_by_name_with_http_info(name, opts)
       data
     end
 
     # Get a phone number by name
     # Get a phone number by name
+    # @param name [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(PhoneNumberDto, Integer, Hash)>] PhoneNumberDto data, response status code and response headers
-    def get_phone_number_by_name_with_http_info(opts = {})
+    def get_phone_number_by_name_with_http_info(name, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: PhoneControllerApi.get_phone_number_by_name ...'
       end
+      # verify the required parameter 'name' is set
+      if @api_client.config.client_side_validation && name.nil?
+        fail ArgumentError, "Missing the required parameter 'name' when calling PhoneControllerApi.get_phone_number_by_name"
+      end
       # resource path
       local_var_path = '/phone/numbers/by-name'
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'name'] = name
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -767,26 +774,33 @@ module MailSlurpClient
 
     # Get a phone number by phone number
     # Get a phone number by phone number
+    # @param phone_number [String] 
     # @param [Hash] opts the optional parameters
     # @return [PhoneNumberDto]
-    def get_phone_number_by_phone_number(opts = {})
-      data, _status_code, _headers = get_phone_number_by_phone_number_with_http_info(opts)
+    def get_phone_number_by_phone_number(phone_number, opts = {})
+      data, _status_code, _headers = get_phone_number_by_phone_number_with_http_info(phone_number, opts)
       data
     end
 
     # Get a phone number by phone number
     # Get a phone number by phone number
+    # @param phone_number [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(PhoneNumberDto, Integer, Hash)>] PhoneNumberDto data, response status code and response headers
-    def get_phone_number_by_phone_number_with_http_info(opts = {})
+    def get_phone_number_by_phone_number_with_http_info(phone_number, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: PhoneControllerApi.get_phone_number_by_phone_number ...'
       end
+      # verify the required parameter 'phone_number' is set
+      if @api_client.config.client_side_validation && phone_number.nil?
+        fail ArgumentError, "Missing the required parameter 'phone_number' when calling PhoneControllerApi.get_phone_number_by_phone_number"
+      end
       # resource path
       local_var_path = '/phone/numbers/by-phone-number'
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'phoneNumber'] = phone_number
 
       # header parameters
       header_params = opts[:header_params] || {}

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,6 +214,10 @@ 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
@@ -222,10 +226,6 @@ 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, 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
+      [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
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/generate_structured_content_email_options.rb

@@ -0,0 +1,281 @@
+=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 email
+  class GenerateStructuredContentEmailOptions
+    # Email ID to read and pass to AI
+    attr_accessor :email_id
+
+    # Content selector to select part of email to operate on
+    attr_accessor :content_selector
+
+    # 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
+
+    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
+      {
+        :'email_id' => :'emailId',
+        :'content_selector' => :'contentSelector',
+        :'instructions' => :'instructions',
+        :'output_schema' => :'outputSchema'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'email_id' => :'String',
+        :'content_selector' => :'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::GenerateStructuredContentEmailOptions` 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::GenerateStructuredContentEmailOptions`. 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?(:'email_id')
+        self.email_id = attributes[:'email_id']
+      end
+
+      if attributes.key?(:'content_selector')
+        self.content_selector = attributes[:'content_selector']
+      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 @email_id.nil?
+        invalid_properties.push('invalid value for "email_id", email_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 @email_id.nil?
+      content_selector_validator = EnumAttributeValidator.new('String', ["RAW", "BODY"])
+      return false unless content_selector_validator.valid?(@content_selector)
+      return false if @output_schema.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] content_selector Object to be assigned
+    def content_selector=(content_selector)
+      validator = EnumAttributeValidator.new('String', ["RAW", "BODY"])
+      unless validator.valid?(content_selector)
+        fail ArgumentError, "invalid value for \"content_selector\", must be one of #{validator.allowable_values}."
+      end
+      @content_selector = content_selector
+    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 &&
+          email_id == o.email_id &&
+          content_selector == o.content_selector &&
+          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
+      [email_id, content_selector, 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/sort_object.rb

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