class RecombeeApiClient::DeleteSeries
Deletes the series of the given ‘seriesId` from the database.
Deleting a series will only delete assignment of items to it, not the items themselves!
Attributes
Public Class Methods
Source
# File lib/recombee_api_client/api/delete_series.rb, line 26 def initialize(series_id, optional = {}) @series_id = series_id optional = normalize_optional(optional) @cascade_delete = optional['cascadeDelete'] @optional = optional @timeout = 3000 @ensure_https = false @optional.each do |par, _| fail UnknownOptionalParameter.new(par) unless ["cascadeDelete"].include? par end end
-
*Required arguments*
-
series_id
-> ID of the series to be deleted.
-
-
*Optional arguments (given as hash optional)*
-
cascadeDelete
-> If set to ‘true`, item with the same ID as seriesId will be also deleted. Default is `false`.
-
Public Instance Methods
Source
# File lib/recombee_api_client/api/delete_series.rb, line 44 def body_parameters p = Hash.new p['cascadeDelete'] = @optional['cascadeDelete'] if @optional.include? 'cascadeDelete' p end
Values of body parameters as a Hash
Source
# File lib/recombee_api_client/api/delete_series.rb, line 39 def method :delete end
HTTP method
Source
# File lib/recombee_api_client/api/delete_series.rb, line 58 def path "/{databaseId}/series/#{@series_id}" end
Relative path to the endpoint
Source
# File lib/recombee_api_client/api/delete_series.rb, line 52 def query_parameters params = {} params end
Values of query parameters as a Hash. name of parameter => value of the parameter