mailslurp_client 15.20.0 → 15.21.0

data/lib/mailslurp_client/api/user_controller_api.rb

@@ -19,6 +19,273 @@ module MailSlurpClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Optional page index (default to 0)
+    # @option opts [Integer] :size Optional page size (default to 20)
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'DESC')
+    # @option opts [DateTime] :since Filter by created at after the given timestamp
+    # @option opts [DateTime] :before Filter by created at before the given timestamp
+    # @option opts [String] :inbox_id Optional inbox ID
+    # @option opts [String] :phone_id Optional phone ID
+    # @option opts [String] :filter Optional automation type filter
+    # @return [PageEntityAutomationItems]
+    def get_entity_automations(opts = {})
+      data, _status_code, _headers = get_entity_automations_with_http_info(opts)
+      data
+    end
+
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Optional page index
+    # @option opts [Integer] :size Optional page size
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
+    # @option opts [DateTime] :since Filter by created at after the given timestamp
+    # @option opts [DateTime] :before Filter by created at before the given timestamp
+    # @option opts [String] :inbox_id Optional inbox ID
+    # @option opts [String] :phone_id Optional phone ID
+    # @option opts [String] :filter Optional automation type filter
+    # @return [Array<(PageEntityAutomationItems, Integer, Hash)>] PageEntityAutomationItems data, response status code and response headers
+    def get_entity_automations_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UserControllerApi.get_entity_automations ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"size"]" when calling UserControllerApi.get_entity_automations, must be smaller than or equal to 100.'
+      end
+
+      allowable_values = ["ASC", "DESC"]
+      if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
+        fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
+      end
+      allowable_values = ["INBOX_FORWARDER", "INBOX_REPLIER", "INBOX_RULESET"]
+      if @api_client.config.client_side_validation && opts[:'filter'] && !allowable_values.include?(opts[:'filter'])
+        fail ArgumentError, "invalid value for \"filter\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/user/automations'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+      query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
+      query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
+      query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
+      query_params[:'phoneId'] = opts[:'phone_id'] if !opts[:'phone_id'].nil?
+      query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['*/*'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'PageEntityAutomationItems' 
+
+      # 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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UserControllerApi#get_entity_automations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Optional page index (default to 0)
+    # @option opts [Integer] :size Optional page size (default to 20)
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'DESC')
+    # @option opts [DateTime] :since Filter by created at after the given timestamp
+    # @option opts [DateTime] :before Filter by created at before the given timestamp
+    # @option opts [String] :inbox_id Optional inbox ID
+    # @option opts [String] :email_id Optional email ID
+    # @option opts [String] :phone_id Optional phone ID
+    # @option opts [String] :sms_id Optional SMS ID
+    # @option opts [String] :attachment_id Optional attachment ID
+    # @option opts [String] :filter Optional type filter
+    # @return [PageEntityEventItems]
+    def get_entity_events(opts = {})
+      data, _status_code, _headers = get_entity_events_with_http_info(opts)
+      data
+    end
+
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Optional page index
+    # @option opts [Integer] :size Optional page size
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
+    # @option opts [DateTime] :since Filter by created at after the given timestamp
+    # @option opts [DateTime] :before Filter by created at before the given timestamp
+    # @option opts [String] :inbox_id Optional inbox ID
+    # @option opts [String] :email_id Optional email ID
+    # @option opts [String] :phone_id Optional phone ID
+    # @option opts [String] :sms_id Optional SMS ID
+    # @option opts [String] :attachment_id Optional attachment ID
+    # @option opts [String] :filter Optional type filter
+    # @return [Array<(PageEntityEventItems, Integer, Hash)>] PageEntityEventItems data, response status code and response headers
+    def get_entity_events_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UserControllerApi.get_entity_events ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"size"]" when calling UserControllerApi.get_entity_events, must be smaller than or equal to 100.'
+      end
+
+      allowable_values = ["ASC", "DESC"]
+      if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
+        fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
+      end
+      allowable_values = ["WEBHOOK_EVENT", "INBOX_FORWARDER_EVENT", "INBOX_REPLIER_EVENT", "INBOX_RULESET_EVENT", "ALIAS_EVENT"]
+      if @api_client.config.client_side_validation && opts[:'filter'] && !allowable_values.include?(opts[:'filter'])
+        fail ArgumentError, "invalid value for \"filter\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/user/events'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+      query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
+      query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
+      query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
+      query_params[:'emailId'] = opts[:'email_id'] if !opts[:'email_id'].nil?
+      query_params[:'phoneId'] = opts[:'phone_id'] if !opts[:'phone_id'].nil?
+      query_params[:'smsId'] = opts[:'sms_id'] if !opts[:'sms_id'].nil?
+      query_params[:'attachmentId'] = opts[:'attachment_id'] if !opts[:'attachment_id'].nil?
+      query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['*/*'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'PageEntityEventItems' 
+
+      # 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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UserControllerApi#get_entity_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Optional page index (default to 0)
+    # @option opts [Integer] :size Optional page size (default to 20)
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'DESC')
+    # @option opts [DateTime] :since Filter by created at after the given timestamp
+    # @option opts [DateTime] :before Filter by created at before the given timestamp
+    # @option opts [String] :filter Optional type filter
+    # @return [PageEntityFavouriteItems]
+    def get_entity_favorites(opts = {})
+      data, _status_code, _headers = get_entity_favorites_with_http_info(opts)
+      data
+    end
+
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Optional page index
+    # @option opts [Integer] :size Optional page size
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
+    # @option opts [DateTime] :since Filter by created at after the given timestamp
+    # @option opts [DateTime] :before Filter by created at before the given timestamp
+    # @option opts [String] :filter Optional type filter
+    # @return [Array<(PageEntityFavouriteItems, Integer, Hash)>] PageEntityFavouriteItems data, response status code and response headers
+    def get_entity_favorites_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UserControllerApi.get_entity_favorites ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"size"]" when calling UserControllerApi.get_entity_favorites, must be smaller than or equal to 100.'
+      end
+
+      allowable_values = ["ASC", "DESC"]
+      if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
+        fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
+      end
+      allowable_values = ["INBOX", "EMAIL", "ATTACHMENT", "PHONE", "SMS"]
+      if @api_client.config.client_side_validation && opts[:'filter'] && !allowable_values.include?(opts[:'filter'])
+        fail ArgumentError, "invalid value for \"filter\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/user/favorites'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+      query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
+      query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
+      query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['*/*'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'PageEntityFavouriteItems' 
+
+      # 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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UserControllerApi#get_entity_favorites\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Utility function to extract properties from JSON objects in language where this is cumbersome.
     # @param property [String] JSON property name or dot separated path selector such as &#x60;a.b.c&#x60;
     # @param body [Object] 

data/lib/mailslurp_client/models/alias_projection.rb

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

data/lib/mailslurp_client/models/alias_thread_projection.rb

@@ -15,21 +15,18 @@ require 'date'
 module MailSlurpClient
   # A thread is a message thread created for a message received by an alias
   class AliasThreadProjection
-    # Thread subject
-    attr_accessor :subject
-
-    # Created at DateTime
-    attr_accessor :created_at
-
-    # Updated at DateTime
-    attr_accessor :updated_at
-
     # User ID
     attr_accessor :user_id
 
     # Inbox ID
     attr_accessor :inbox_id
 
+    # Updated at DateTime
+    attr_accessor :updated_at
+
+    # Created at DateTime
+    attr_accessor :created_at
+
     # To recipients
     attr_accessor :to
 
@@ -42,6 +39,9 @@ module MailSlurpClient
     # Alias ID
     attr_accessor :alias_id
 
+    # Thread subject
+    attr_accessor :subject
+
     # Name of thread
     attr_accessor :name
 
@@ -51,15 +51,15 @@ module MailSlurpClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'subject' => :'subject',
-        :'created_at' => :'createdAt',
-        :'updated_at' => :'updatedAt',
         :'user_id' => :'userId',
         :'inbox_id' => :'inboxId',
+        :'updated_at' => :'updatedAt',
+        :'created_at' => :'createdAt',
         :'to' => :'to',
         :'cc' => :'cc',
         :'bcc' => :'bcc',
         :'alias_id' => :'aliasId',
+        :'subject' => :'subject',
         :'name' => :'name',
         :'id' => :'id'
       }
@@ -68,15 +68,15 @@ module MailSlurpClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'subject' => :'String',
-        :'created_at' => :'DateTime',
-        :'updated_at' => :'DateTime',
         :'user_id' => :'String',
         :'inbox_id' => :'String',
+        :'updated_at' => :'DateTime',
+        :'created_at' => :'DateTime',
         :'to' => :'Array<String>',
         :'cc' => :'Array<String>',
         :'bcc' => :'Array<String>',
         :'alias_id' => :'String',
+        :'subject' => :'String',
         :'name' => :'String',
         :'id' => :'String'
       }
@@ -103,24 +103,20 @@ module MailSlurpClient
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'subject')
-        self.subject = attributes[:'subject']
+      if attributes.key?(:'user_id')
+        self.user_id = attributes[:'user_id']
       end
 
-      if attributes.key?(:'created_at')
-        self.created_at = attributes[:'created_at']
+      if attributes.key?(:'inbox_id')
+        self.inbox_id = attributes[:'inbox_id']
       end
 
       if attributes.key?(:'updated_at')
         self.updated_at = attributes[:'updated_at']
       end
 
-      if attributes.key?(:'user_id')
-        self.user_id = attributes[:'user_id']
-      end
-
-      if attributes.key?(:'inbox_id')
-        self.inbox_id = attributes[:'inbox_id']
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
       end
 
       if attributes.key?(:'to')
@@ -145,6 +141,10 @@ module MailSlurpClient
         self.alias_id = attributes[:'alias_id']
       end
 
+      if attributes.key?(:'subject')
+        self.subject = attributes[:'subject']
+      end
+
       if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
@@ -158,14 +158,6 @@ module MailSlurpClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @created_at.nil?
-        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
-      end
-
-      if @updated_at.nil?
-        invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
-      end
-
       if @user_id.nil?
         invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
       end
@@ -174,6 +166,14 @@ module MailSlurpClient
         invalid_properties.push('invalid value for "inbox_id", inbox_id cannot be nil.')
       end
 
+      if @updated_at.nil?
+        invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
       if @to.nil?
         invalid_properties.push('invalid value for "to", to cannot be nil.')
       end
@@ -192,10 +192,10 @@ 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 @created_at.nil?
-      return false if @updated_at.nil?
       return false if @user_id.nil?
       return false if @inbox_id.nil?
+      return false if @updated_at.nil?
+      return false if @created_at.nil?
       return false if @to.nil?
       return false if @alias_id.nil?
       return false if @id.nil?
@@ -207,15 +207,15 @@ module MailSlurpClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          subject == o.subject &&
-          created_at == o.created_at &&
-          updated_at == o.updated_at &&
           user_id == o.user_id &&
           inbox_id == o.inbox_id &&
+          updated_at == o.updated_at &&
+          created_at == o.created_at &&
           to == o.to &&
           cc == o.cc &&
           bcc == o.bcc &&
           alias_id == o.alias_id &&
+          subject == o.subject &&
           name == o.name &&
           id == o.id
     end
@@ -229,7 +229,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [subject, created_at, updated_at, user_id, inbox_id, to, cc, bcc, alias_id, name, id].hash
+      [user_id, inbox_id, updated_at, created_at, to, cc, bcc, alias_id, subject, name, id].hash
     end
 
     # Builds the object from hash