Class: RecombeeApiClient::DeleteUser

Inherits:
ApiRequest show all
Defined in:
lib/recombee_api_client/api/delete_user.rb

Overview

Deletes a user of the given userId from the database.

If there are any purchases, ratings, bookmarks, cart additions or detail views made by the user present in the database, they will be deleted in cascade as well.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from HashNormalizer

#camelize, #normalize_hash_to_camel_case

Constructor Details

#initialize(user_id) ⇒ DeleteUser

  • *Required arguments*

    • user_id -> ID of the user to be deleted.



22
23
24
25
26
 
# File 'lib/recombee_api_client/api/delete_user.rb', line 22

def initialize(user_id)
  @user_id = user_id
  @timeout = 3000
  @ensure_https = false
end

Instance Attribute Details

#ensure_https ⇒ Object

Returns the value of attribute ensure_https.



16
17
18
 
# File 'lib/recombee_api_client/api/delete_user.rb', line 16

def ensure_https
  @ensure_https
end

#timeout ⇒ Object

Returns the value of attribute timeout.



16
17
18
 
# File 'lib/recombee_api_client/api/delete_user.rb', line 16

def timeout
  @timeout
end

#user_id ⇒ Object (readonly)

Returns the value of attribute user_id.



15
16
17
 
# File 'lib/recombee_api_client/api/delete_user.rb', line 15

def user_id
  @user_id
end

Instance Method Details

#body_parameters ⇒ Object

Values of body parameters as a Hash



34
35
36
 
# File 'lib/recombee_api_client/api/delete_user.rb', line 34

def body_parameters
  {}
end

#method ⇒ Object

HTTP method



29
30
31
 
# File 'lib/recombee_api_client/api/delete_user.rb', line 29

def method
  :delete
end

#path ⇒ Object

Relative path to the endpoint



45
46
47
 
# File 'lib/recombee_api_client/api/delete_user.rb', line 45

def path
  "/{databaseId}/users/#{@user_id}"
end

#query_parameters ⇒ Object

Values of query parameters as a Hash. name of parameter => value of the parameter



40
41
42
 
# File 'lib/recombee_api_client/api/delete_user.rb', line 40

def query_parameters
  {}
end