class RecombeeApiClient::RemoveFromGroup

Removes an existing group item from the group.

Attributes

ensure_https[RW]
group_id[R]
item_id[R]
item_type[R]
timeout[RW]

Public Class Methods

new(group_id, item_type, item_id) click to toggle source
  • *Required arguments*

    • group_id -> ID of the group from which a group item is to be removed.

    • item_type -> Type of the item to be removed.

    • item_id -> ID of the item iff `itemType` is `item`. ID of the group iff `itemType` is `group`.

# File lib/recombee_api_client/api/remove_from_group.rb, line 22
def initialize(group_id, item_type, item_id)
  @group_id = group_id
  @item_type = item_type
  @item_id = item_id
  @timeout = 1000
  @ensure_https = false
end

Public Instance Methods

body_parameters() click to toggle source

Values of body parameters as a Hash

# File lib/recombee_api_client/api/remove_from_group.rb, line 36
def body_parameters
  p = Hash.new
  p
end
method() click to toggle source

HTTP method

# File lib/recombee_api_client/api/remove_from_group.rb, line 31
def method
  :delete
end
path() click to toggle source

Relative path to the endpoint

# File lib/recombee_api_client/api/remove_from_group.rb, line 51
def path
  "/{databaseId}/groups/#{@group_id}/items/"
end
query_parameters() click to toggle source

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

# File lib/recombee_api_client/api/remove_from_group.rb, line 43
def query_parameters
  params = {}
  params['itemType'] = @item_type
  params['itemId'] = @item_id
  params
end