mailslurp_client 15.17.24 → 15.17.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99978a46a96b4204b28a127447fded7dff2c2b24080324f2fdad86bb9458af09
-  data.tar.gz: 73816834c85b73ad98beddc512609599d0eb427a21f26e162611fe45cf7bcdac
+  metadata.gz: 962543de3268cc22b25947c5493aa6a2a977f5bb0b2c85a80c9259975f35b1e3
+  data.tar.gz: c12985a8264080271749a81da9967cb1fe7d9805c7db9eb22614d4eaca5fce0e
 SHA512:
-  metadata.gz: 7b641786cc473ae378ec04d14c5161e2b9d91338f0f90aa14c92ed8c40bd88dd8b6c53c4679ab27ce426984dd3b78ec11072d517acb05a625645a2272206ad31
-  data.tar.gz: 67ab483b9f7cead055adfb4fbce09ff804bbfb58cde962bc639daefa48132ed376364ac4fd2369e2682628632c0af6665126eed167b8fe32c0082e9948bf9e11
+  metadata.gz: 13e41d587d6d1e27dcf4361132e577fce0c08391d0cd36d11613979d5f7c88e81d1740d52940822e5358890da1b381777b9251f4422437cc115f0785739f6a9d
+  data.tar.gz: aa5652afc2d0170a63eeae3976f2b3c9d8f207dc5ca6ab847882c3e0f158a83a8f5da967554b75261dd42729452b8174500dd76f7ccfe4f3b5737d80939345e4

data/lib/mailslurp_client/api/email_controller_api.rb

@@ -2281,6 +2281,70 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Get all emails by search criteria. Return in paginated form.
+    # Search emails by given criteria return matches in paginated format. Searches against email recipients, sender, subject, email address and ID. Does not search email body
+    # @param search_emails_options [SearchEmailsOptions] 
+    # @param [Hash] opts the optional parameters
+    # @return [PageEmailProjection]
+    def search_emails(search_emails_options, opts = {})
+      data, _status_code, _headers = search_emails_with_http_info(search_emails_options, opts)
+      data
+    end
+
+    # Get all emails by search criteria. Return in paginated form.
+    # Search emails by given criteria return matches in paginated format. Searches against email recipients, sender, subject, email address and ID. Does not search email body
+    # @param search_emails_options [SearchEmailsOptions] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PageEmailProjection, Integer, Hash)>] PageEmailProjection data, response status code and response headers
+    def search_emails_with_http_info(search_emails_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EmailControllerApi.search_emails ...'
+      end
+      # verify the required parameter 'search_emails_options' is set
+      if @api_client.config.client_side_validation && search_emails_options.nil?
+        fail ArgumentError, "Missing the required parameter 'search_emails_options' when calling EmailControllerApi.search_emails"
+      end
+      # resource path
+      local_var_path = '/emails/search'
+
+      # 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(search_emails_options) 
+
+      # return_type
+      return_type = opts[:return_type] || 'PageEmailProjection' 
+
+      # 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: EmailControllerApi#search_emails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Send email
     # Alias for `InboxController.sendEmail` method - see original method for full details. Sends an email from a given inbox that you have created. If no inbox is supplied a random inbox will be created for you and used to send the email.
     # @param send_email_options [SendEmailOptions] 

data/lib/mailslurp_client/api/inbox_controller_api.rb

@@ -2493,6 +2493,70 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Search all inboxes and return matching inboxes
+    # Search inboxes and return in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results.
+    # @param search_inboxes_options [SearchInboxesOptions] 
+    # @param [Hash] opts the optional parameters
+    # @return [PageInboxProjection]
+    def search_inboxes(search_inboxes_options, opts = {})
+      data, _status_code, _headers = search_inboxes_with_http_info(search_inboxes_options, opts)
+      data
+    end
+
+    # Search all inboxes and return matching inboxes
+    # Search inboxes and return in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results.
+    # @param search_inboxes_options [SearchInboxesOptions] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PageInboxProjection, Integer, Hash)>] PageInboxProjection data, response status code and response headers
+    def search_inboxes_with_http_info(search_inboxes_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxControllerApi.search_inboxes ...'
+      end
+      # verify the required parameter 'search_inboxes_options' is set
+      if @api_client.config.client_side_validation && search_inboxes_options.nil?
+        fail ArgumentError, "Missing the required parameter 'search_inboxes_options' when calling InboxControllerApi.search_inboxes"
+      end
+      # resource path
+      local_var_path = '/inboxes/search'
+
+      # 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(search_inboxes_options) 
+
+      # return_type
+      return_type = opts[:return_type] || 'PageInboxProjection' 
+
+      # 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: InboxControllerApi#search_inboxes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Send Email
     # Send an email from an inbox's email address.  The request body should contain the `SendEmailOptions` that include recipients, attachments, body etc. See `SendEmailOptions` for all available properties. Note the `inboxId` refers to the inbox's id not the inbox's email address. See https://www.mailslurp.com/guides/ for more information on how to send emails. This method does not return a sent email entity due to legacy reasons. To send and get a sent email as returned response use the sister method `sendEmailAndConfirm`.
     # @param inbox_id [String] ID of the inbox you want to send the email from

data/lib/mailslurp_client/models/alias_projection.rb

@@ -15,12 +15,12 @@ require 'date'
 module MailSlurpClient
   # Representation of a alias
   class AliasProjection
+    attr_accessor :inbox_id
+
     attr_accessor :email_address
 
     attr_accessor :user_id
 
-    attr_accessor :inbox_id
-
     attr_accessor :use_threads
 
     attr_accessor :created_at
@@ -34,9 +34,9 @@ module MailSlurpClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'inbox_id' => :'inboxId',
         :'email_address' => :'emailAddress',
         :'user_id' => :'userId',
-        :'inbox_id' => :'inboxId',
         :'use_threads' => :'useThreads',
         :'created_at' => :'createdAt',
         :'updated_at' => :'updatedAt',
@@ -48,9 +48,9 @@ module MailSlurpClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'inbox_id' => :'String',
         :'email_address' => :'String',
         :'user_id' => :'String',
-        :'inbox_id' => :'String',
         :'use_threads' => :'Boolean',
         :'created_at' => :'DateTime',
         :'updated_at' => :'DateTime',
@@ -80,6 +80,10 @@ module MailSlurpClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'inbox_id')
+        self.inbox_id = attributes[:'inbox_id']
+      end
+
       if attributes.key?(:'email_address')
         self.email_address = attributes[:'email_address']
       end
@@ -88,10 +92,6 @@ module MailSlurpClient
         self.user_id = attributes[:'user_id']
       end
 
-      if attributes.key?(:'inbox_id')
-        self.inbox_id = attributes[:'inbox_id']
-      end
-
       if attributes.key?(:'use_threads')
         self.use_threads = attributes[:'use_threads']
       end
@@ -117,6 +117,10 @@ module MailSlurpClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @inbox_id.nil?
+        invalid_properties.push('invalid value for "inbox_id", inbox_id cannot be nil.')
+      end
+
       if @email_address.nil?
         invalid_properties.push('invalid value for "email_address", email_address cannot be nil.')
       end
@@ -125,10 +129,6 @@ module MailSlurpClient
         invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
       end
 
-      if @inbox_id.nil?
-        invalid_properties.push('invalid value for "inbox_id", inbox_id cannot be nil.')
-      end
-
       if @created_at.nil?
         invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
       end
@@ -147,9 +147,9 @@ module MailSlurpClient
     # 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 @inbox_id.nil?
       return false if @email_address.nil?
       return false if @user_id.nil?
-      return false if @inbox_id.nil?
       return false if @created_at.nil?
       return false if @updated_at.nil?
       return false if @id.nil?
@@ -161,9 +161,9 @@ module MailSlurpClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          inbox_id == o.inbox_id &&
           email_address == o.email_address &&
           user_id == o.user_id &&
-          inbox_id == o.inbox_id &&
           use_threads == o.use_threads &&
           created_at == o.created_at &&
           updated_at == o.updated_at &&
@@ -180,7 +180,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [email_address, user_id, inbox_id, use_threads, created_at, updated_at, name, id].hash
+      [inbox_id, email_address, user_id, use_threads, created_at, updated_at, name, id].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/bounce_projection.rb

@@ -15,8 +15,6 @@ require 'date'
 module MailSlurpClient
   # Bounced email event
   class BounceProjection
-    attr_accessor :subject
-
     attr_accessor :sender
 
     attr_accessor :bounce_type
@@ -25,16 +23,18 @@ module MailSlurpClient
 
     attr_accessor :created_at
 
+    attr_accessor :subject
+
     attr_accessor :id
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'subject' => :'subject',
         :'sender' => :'sender',
         :'bounce_type' => :'bounceType',
         :'bounce_mta' => :'bounceMta',
         :'created_at' => :'createdAt',
+        :'subject' => :'subject',
         :'id' => :'id'
       }
     end
@@ -42,11 +42,11 @@ module MailSlurpClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'subject' => :'String',
         :'sender' => :'String',
         :'bounce_type' => :'String',
         :'bounce_mta' => :'String',
         :'created_at' => :'DateTime',
+        :'subject' => :'String',
         :'id' => :'String'
       }
     end
@@ -54,9 +54,9 @@ module MailSlurpClient
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'subject',
         :'bounce_type',
         :'bounce_mta',
+        :'subject',
       ])
     end
 
@@ -75,10 +75,6 @@ module MailSlurpClient
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'subject')
-        self.subject = attributes[:'subject']
-      end
-
       if attributes.key?(:'sender')
         self.sender = attributes[:'sender']
       end
@@ -95,6 +91,10 @@ module MailSlurpClient
         self.created_at = attributes[:'created_at']
       end
 
+      if attributes.key?(:'subject')
+        self.subject = attributes[:'subject']
+      end
+
       if attributes.key?(:'id')
         self.id = attributes[:'id']
       end
@@ -128,11 +128,11 @@ module MailSlurpClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          subject == o.subject &&
           sender == o.sender &&
           bounce_type == o.bounce_type &&
           bounce_mta == o.bounce_mta &&
           created_at == o.created_at &&
+          subject == o.subject &&
           id == o.id
     end
 
@@ -145,7 +145,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [subject, sender, bounce_type, bounce_mta, created_at, id].hash
+      [sender, bounce_type, bounce_mta, created_at, subject, id].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/connector_projection.rb

@@ -15,10 +15,10 @@ require 'date'
 module MailSlurpClient
   # Connector
   class ConnectorProjection
-    attr_accessor :user_id
-
     attr_accessor :inbox_id
 
+    attr_accessor :user_id
+
     attr_accessor :sync_enabled
 
     attr_accessor :connector_type
@@ -56,8 +56,8 @@ module MailSlurpClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'user_id' => :'userId',
         :'inbox_id' => :'inboxId',
+        :'user_id' => :'userId',
         :'sync_enabled' => :'syncEnabled',
         :'connector_type' => :'connectorType',
         :'sync_schedule_type' => :'syncScheduleType',
@@ -70,8 +70,8 @@ module MailSlurpClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'user_id' => :'String',
         :'inbox_id' => :'String',
+        :'user_id' => :'String',
         :'sync_enabled' => :'Boolean',
         :'connector_type' => :'String',
         :'sync_schedule_type' => :'String',
@@ -102,14 +102,14 @@ module MailSlurpClient
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'user_id')
-        self.user_id = attributes[:'user_id']
-      end
-
       if attributes.key?(:'inbox_id')
         self.inbox_id = attributes[:'inbox_id']
       end
 
+      if attributes.key?(:'user_id')
+        self.user_id = attributes[:'user_id']
+      end
+
       if attributes.key?(:'sync_enabled')
         self.sync_enabled = attributes[:'sync_enabled']
       end
@@ -139,14 +139,14 @@ module MailSlurpClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @user_id.nil?
-        invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
-      end
-
       if @inbox_id.nil?
         invalid_properties.push('invalid value for "inbox_id", inbox_id cannot be nil.')
       end
 
+      if @user_id.nil?
+        invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
+      end
+
       if @sync_enabled.nil?
         invalid_properties.push('invalid value for "sync_enabled", sync_enabled cannot be nil.')
       end
@@ -169,8 +169,8 @@ module MailSlurpClient
     # 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 @user_id.nil?
       return false if @inbox_id.nil?
+      return false if @user_id.nil?
       return false if @sync_enabled.nil?
       return false if @connector_type.nil?
       connector_type_validator = EnumAttributeValidator.new('String', ["IMAP"])
@@ -207,8 +207,8 @@ module MailSlurpClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          user_id == o.user_id &&
           inbox_id == o.inbox_id &&
+          user_id == o.user_id &&
           sync_enabled == o.sync_enabled &&
           connector_type == o.connector_type &&
           sync_schedule_type == o.sync_schedule_type &&
@@ -226,7 +226,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [user_id, inbox_id, sync_enabled, connector_type, sync_schedule_type, sync_interval, created_at, id].hash
+      [inbox_id, user_id, sync_enabled, connector_type, sync_schedule_type, sync_interval, created_at, id].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/email_projection.rb

@@ -15,20 +15,18 @@ require 'date'
 module MailSlurpClient
   # A compact representation of a full email. Used in list endpoints to keep response sizes low. Body and attachments are not included. To get all fields of the email use the `getEmail` method with the email projection's ID. See `EmailDto` for documentation on projection properties.
   class EmailProjection
-    attr_accessor :subject
-
     attr_accessor :attachments
 
     attr_accessor :inbox_id
 
     attr_accessor :to
 
+    attr_accessor :domain_id
+
     attr_accessor :bcc
 
     attr_accessor :cc
 
-    attr_accessor :domain_id
-
     attr_accessor :read
 
     attr_accessor :body_excerpt
@@ -41,6 +39,8 @@ module MailSlurpClient
 
     attr_accessor :created_at
 
+    attr_accessor :subject
+
     attr_accessor :id
 
     attr_accessor :from
@@ -48,19 +48,19 @@ module MailSlurpClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'subject' => :'subject',
         :'attachments' => :'attachments',
         :'inbox_id' => :'inboxId',
         :'to' => :'to',
+        :'domain_id' => :'domainId',
         :'bcc' => :'bcc',
         :'cc' => :'cc',
-        :'domain_id' => :'domainId',
         :'read' => :'read',
         :'body_excerpt' => :'bodyExcerpt',
         :'team_access' => :'teamAccess',
         :'body_md5_hash' => :'bodyMD5Hash',
         :'text_excerpt' => :'textExcerpt',
         :'created_at' => :'createdAt',
+        :'subject' => :'subject',
         :'id' => :'id',
         :'from' => :'from'
       }
@@ -69,19 +69,19 @@ module MailSlurpClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'subject' => :'String',
         :'attachments' => :'Array<String>',
         :'inbox_id' => :'String',
         :'to' => :'Array<String>',
+        :'domain_id' => :'String',
         :'bcc' => :'Array<String>',
         :'cc' => :'Array<String>',
-        :'domain_id' => :'String',
         :'read' => :'Boolean',
         :'body_excerpt' => :'String',
         :'team_access' => :'Boolean',
         :'body_md5_hash' => :'String',
         :'text_excerpt' => :'String',
         :'created_at' => :'DateTime',
+        :'subject' => :'String',
         :'id' => :'String',
         :'from' => :'String'
       }
@@ -90,14 +90,14 @@ module MailSlurpClient
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'subject',
         :'attachments',
+        :'domain_id',
         :'bcc',
         :'cc',
-        :'domain_id',
         :'body_excerpt',
         :'body_md5_hash',
         :'text_excerpt',
+        :'subject',
         :'from'
       ])
     end
@@ -117,10 +117,6 @@ module MailSlurpClient
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'subject')
-        self.subject = attributes[:'subject']
-      end
-
       if attributes.key?(:'attachments')
         if (value = attributes[:'attachments']).is_a?(Array)
           self.attachments = value
@@ -137,6 +133,10 @@ module MailSlurpClient
         end
       end
 
+      if attributes.key?(:'domain_id')
+        self.domain_id = attributes[:'domain_id']
+      end
+
       if attributes.key?(:'bcc')
         if (value = attributes[:'bcc']).is_a?(Array)
           self.bcc = value
@@ -149,10 +149,6 @@ module MailSlurpClient
         end
       end
 
-      if attributes.key?(:'domain_id')
-        self.domain_id = attributes[:'domain_id']
-      end
-
       if attributes.key?(:'read')
         self.read = attributes[:'read']
       end
@@ -177,6 +173,10 @@ module MailSlurpClient
         self.created_at = attributes[:'created_at']
       end
 
+      if attributes.key?(:'subject')
+        self.subject = attributes[:'subject']
+      end
+
       if attributes.key?(:'id')
         self.id = attributes[:'id']
       end
@@ -234,19 +234,19 @@ module MailSlurpClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          subject == o.subject &&
           attachments == o.attachments &&
           inbox_id == o.inbox_id &&
           to == o.to &&
+          domain_id == o.domain_id &&
           bcc == o.bcc &&
           cc == o.cc &&
-          domain_id == o.domain_id &&
           read == o.read &&
           body_excerpt == o.body_excerpt &&
           team_access == o.team_access &&
           body_md5_hash == o.body_md5_hash &&
           text_excerpt == o.text_excerpt &&
           created_at == o.created_at &&
+          subject == o.subject &&
           id == o.id &&
           from == o.from
     end
@@ -260,7 +260,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [subject, attachments, inbox_id, to, bcc, cc, domain_id, read, body_excerpt, team_access, body_md5_hash, text_excerpt, created_at, id, from].hash
+      [attachments, inbox_id, to, domain_id, bcc, cc, read, body_excerpt, team_access, body_md5_hash, text_excerpt, created_at, subject, id, from].hash
     end
 
     # Builds the object from hash