mailslurp_client 15.20.0 → 15.21.1

data/lib/mailslurp_client/api/phone_controller_api.rb

@@ -83,6 +83,70 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Add phone number to your account. Only works if you have already added a plan and an initial phone number in your account and acknowledged the pricing and terms of service by enabling API phone creation.
+    # Create new phone number
+    # @param create_phone_number_options [CreatePhoneNumberOptions] 
+    # @param [Hash] opts the optional parameters
+    # @return [PhoneNumberDto]
+    def create_phone_number(create_phone_number_options, opts = {})
+      data, _status_code, _headers = create_phone_number_with_http_info(create_phone_number_options, opts)
+      data
+    end
+
+    # Add phone number to your account. Only works if you have already added a plan and an initial phone number in your account and acknowledged the pricing and terms of service by enabling API phone creation.
+    # Create new phone number
+    # @param create_phone_number_options [CreatePhoneNumberOptions] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PhoneNumberDto, Integer, Hash)>] PhoneNumberDto data, response status code and response headers
+    def create_phone_number_with_http_info(create_phone_number_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PhoneControllerApi.create_phone_number ...'
+      end
+      # verify the required parameter 'create_phone_number_options' is set
+      if @api_client.config.client_side_validation && create_phone_number_options.nil?
+        fail ArgumentError, "Missing the required parameter 'create_phone_number_options' when calling PhoneControllerApi.create_phone_number"
+      end
+      # resource path
+      local_var_path = '/phone'
+
+      # 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(create_phone_number_options) 
+
+      # return_type
+      return_type = opts[:return_type] || 'PhoneNumberDto' 
+
+      # 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: PhoneControllerApi#create_phone_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Delete an emergency address
     # Delete an emergency address
     # @param address_id [String] 
@@ -205,6 +269,68 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Get the latest messages for all phones
+    # List all message threads for all phones
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page  (default to 0)
+    # @option opts [Integer] :size  (default to 20)
+    # @return [PagePhoneMessageThreadProjection]
+    def get_all_phone_message_threads(opts = {})
+      data, _status_code, _headers = get_all_phone_message_threads_with_http_info(opts)
+      data
+    end
+
+    # Get the latest messages for all phones
+    # List all message threads for all phones
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page 
+    # @option opts [Integer] :size 
+    # @return [Array<(PagePhoneMessageThreadProjection, Integer, Hash)>] PagePhoneMessageThreadProjection data, response status code and response headers
+    def get_all_phone_message_threads_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PhoneControllerApi.get_all_phone_message_threads ...'
+      end
+      # resource path
+      local_var_path = '/phone/numbers/message-threads'
+
+      # 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?
+
+      # 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] || 'PagePhoneMessageThreadProjection' 
+
+      # 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: PhoneControllerApi#get_all_phone_message_threads\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get consent status
     # Get the status of phone usage consent
     # @param [Hash] opts the optional parameters
@@ -379,6 +505,148 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Get messages in a phone thread
+    # List message thread messages for a phone message thread
+    # @param phone_number_id [String] 
+    # @param other_number [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page  (default to 0)
+    # @option opts [Integer] :size  (default to 20)
+    # @return [PagePhoneMessageThreadItemProjection]
+    def get_phone_message_thread_items(phone_number_id, other_number, opts = {})
+      data, _status_code, _headers = get_phone_message_thread_items_with_http_info(phone_number_id, other_number, opts)
+      data
+    end
+
+    # Get messages in a phone thread
+    # List message thread messages for a phone message thread
+    # @param phone_number_id [String] 
+    # @param other_number [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page 
+    # @option opts [Integer] :size 
+    # @return [Array<(PagePhoneMessageThreadItemProjection, Integer, Hash)>] PagePhoneMessageThreadItemProjection data, response status code and response headers
+    def get_phone_message_thread_items_with_http_info(phone_number_id, other_number, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PhoneControllerApi.get_phone_message_thread_items ...'
+      end
+      # verify the required parameter 'phone_number_id' is set
+      if @api_client.config.client_side_validation && phone_number_id.nil?
+        fail ArgumentError, "Missing the required parameter 'phone_number_id' when calling PhoneControllerApi.get_phone_message_thread_items"
+      end
+      # verify the required parameter 'other_number' is set
+      if @api_client.config.client_side_validation && other_number.nil?
+        fail ArgumentError, "Missing the required parameter 'other_number' when calling PhoneControllerApi.get_phone_message_thread_items"
+      end
+      # resource path
+      local_var_path = '/phone/numbers/{phoneNumberId}/message-threads/{otherNumber}'.sub('{' + 'phoneNumberId' + '}', CGI.escape(phone_number_id.to_s)).sub('{' + 'otherNumber' + '}', CGI.escape(other_number.to_s))
+
+      # 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?
+
+      # 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] || 'PagePhoneMessageThreadItemProjection' 
+
+      # 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: PhoneControllerApi#get_phone_message_thread_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get the latest message preview for a thread
+    # List message threads for a phone
+    # @param phone_number_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page  (default to 0)
+    # @option opts [Integer] :size  (default to 20)
+    # @return [PagePhoneMessageThreadProjection]
+    def get_phone_message_threads(phone_number_id, opts = {})
+      data, _status_code, _headers = get_phone_message_threads_with_http_info(phone_number_id, opts)
+      data
+    end
+
+    # Get the latest message preview for a thread
+    # List message threads for a phone
+    # @param phone_number_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page 
+    # @option opts [Integer] :size 
+    # @return [Array<(PagePhoneMessageThreadProjection, Integer, Hash)>] PagePhoneMessageThreadProjection data, response status code and response headers
+    def get_phone_message_threads_with_http_info(phone_number_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PhoneControllerApi.get_phone_message_threads ...'
+      end
+      # verify the required parameter 'phone_number_id' is set
+      if @api_client.config.client_side_validation && phone_number_id.nil?
+        fail ArgumentError, "Missing the required parameter 'phone_number_id' when calling PhoneControllerApi.get_phone_message_threads"
+      end
+      # resource path
+      local_var_path = '/phone/numbers/{phoneNumberId}/message-threads'.sub('{' + 'phoneNumberId' + '}', CGI.escape(phone_number_id.to_s))
+
+      # 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?
+
+      # 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] || 'PagePhoneMessageThreadProjection' 
+
+      # 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: PhoneControllerApi#get_phone_message_threads\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get a phone number by ID
     # Get a phone number by ID
     # @param phone_number_id [String] 
@@ -441,6 +709,118 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Get a phone number by name
+    # Get a phone number by name
+    # @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)
+      data
+    end
+
+    # Get a phone number by name
+    # Get a phone number by name
+    # @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 = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PhoneControllerApi.get_phone_number_by_name ...'
+      end
+      # resource path
+      local_var_path = '/phone/numbers/by-name'
+
+      # 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(['*/*'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'PhoneNumberDto' 
+
+      # 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: PhoneControllerApi#get_phone_number_by_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a phone number by phone number
+    # Get a phone number by phone number
+    # @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)
+      data
+    end
+
+    # Get a phone number by phone number
+    # Get a phone number by phone number
+    # @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 = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: 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] || {}
+
+      # 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] || 'PhoneNumberDto' 
+
+      # 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: PhoneControllerApi#get_phone_number_by_phone_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get phone numbers
     # List phone numbers for account
     # @param [Hash] opts the optional parameters
@@ -476,7 +856,7 @@ module MailSlurpClient
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: PhoneControllerApi.get_phone_numbers ...'
       end
-      allowable_values = ["US", "GB", "AU"]
+      allowable_values = ["US", "GB", "AU", "CA", "EE", "HK", "PL", "CH", "PT", "NL", "IL", "SE"]
       if @api_client.config.client_side_validation && opts[:'phone_country'] && !allowable_values.include?(opts[:'phone_country'])
         fail ArgumentError, "invalid value for \"phone_country\", must be one of #{allowable_values}"
       end

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]