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_optional

Constructor Details

#initialize(user_id) ⇒ DeleteUser

  • *Required arguments*

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



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

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.



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

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



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

def body_parameters
  p = Hash.new
  p
end

#method ⇒ Object

HTTP method



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

def method
  :delete
end

#path ⇒ Object

Relative path to the endpoint



48
49
50
 
# File 'lib/recombee_api_client/api/delete_user.rb', line 48

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

#query_parameters ⇒ Object

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



42
43
44
45
 
# File 'lib/recombee_api_client/api/delete_user.rb', line 42

def query_parameters
  params = {}
  params
end