net.worcade.client.api.UserApi 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 library for interacting with the Worcade API

There is a newer version: 1.1.2

// Copyright (c) 2017, Worcade. Please see the AUTHORS file for details.
// All rights reserved. Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.

package net.worcade.client.api;

import net.worcade.client.Result;
import net.worcade.client.api.mixin.ApiKeysApi;
import net.worcade.client.api.mixin.RemoteIdsApi;
import net.worcade.client.create.UserCreate;
import net.worcade.client.get.Reference;
import net.worcade.client.get.User;
import net.worcade.client.get.UserProfile;
import net.worcade.client.modify.UserModification;

import java.util.Collection;

public interface UserApi extends ApiKeysApi, RemoteIdsApi {
    UserCreate createBuilder();

    Result get(String id);
    Result getProfile(String id);
    /**
     * Create a new User. Use the {@link #createBuilder()} method for a new, empty template.
     */
    Result create(UserModification subject);
    Result updateProfile(UserModification subject);
    Result cancelAccount(String id, String password);

    Result addEmailAddress(String id, String... emails);
    Result removeEmailAddress(String id, String... emails);
    Result confirmEmailAddress(String id, String secret);
    Result requestEmailConfirm(String id, String email);
    Result> searchByEmail(String email);

    Result changePassword(String id, String currentPassword, String newPassword);
    Result requestPasswordReset(String id);
    Result requestPasswordResetByEmail(String email);
    Result confirmPasswordReset(String id, String newPassword, String secret);

    Result requestApplicationTrust(String userId, String applicationId);
    Result confirmApplicationTrust(String userId, String applicationId);
    Result unlinkApplication(String userId, String applicationId);

    Result confirmJoinCompany(String id, String secret);

    Result requestSubscription(String id);
}