com.recombee.api_client.api_requests.DeleteUser Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api-client Show documentation

A client library for easy use of the Recombee recommendation API

There is a newer version: 4.1.5

package com.recombee.api_client.api_requests;

/*
 This file is auto-generated, do not edit
*/

import java.util.Date;
import java.util.Map;
import java.util.HashMap;

import com.recombee.api_client.bindings.Logic;
import com.recombee.api_client.util.HTTPMethod;

/**
 * Deletes a user of 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.
 */
public class DeleteUser extends Request {

    /**
     * ID of the user to be added.
     */
    protected String userId;

    /**
     * Construct the request
     * @param userId ID of the user to be added.
     */
    public DeleteUser (String userId) {
        this.userId = userId;
        this.timeout = 1000;
    }


    public String getUserId() {
         return this.userId;
    }

    /**
     * @return Used HTTP method
     */
    @Override
    public HTTPMethod getHTTPMethod() {
        return HTTPMethod.DELETE;
    }

    /**
     * @return URI to the endpoint including path parameters
     */
    @Override
    public String getPath() {
        return String.format("/users/%s", this.userId);
    }

    /**
     * Get query parameters
     * @return Values of query parameters (name of parameter: value of the parameter)
     */
    @Override
    public Map getQueryParameters() {
        HashMap params = new HashMap();
        return params;
    }

    /**
     * Get body parameters
     * @return Values of body parameters (name of parameter: value of the parameter)
     */
    @Override
    public Map getBodyParameters() {
        HashMap params = new HashMap();
        return params;
    }

}