net.worcade.client.api.GroupApi 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.OwnerApi;
import net.worcade.client.api.mixin.RemoteIdsApi;
import net.worcade.client.create.GroupCreate;
import net.worcade.client.get.Group;
import net.worcade.client.get.GroupProfile;
import net.worcade.client.get.Reference;
import net.worcade.client.get.ReferenceWithName;
import net.worcade.client.modify.GroupModification;
import net.worcade.client.query.GroupField;
import net.worcade.client.query.Query;

import java.util.Collection;

public interface GroupApi extends OwnerApi, RemoteIdsApi {
    GroupCreate createBuilder();

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

    /**
     * Get a filtered list of groups.
     * You can create a Query object using {@link Query#group()}
     */
    Result> getGroupList(Query query);

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

    Result addMembers(String id, Reference... members);
    Result addMembers(String id, Collection members);
    Result removeMembers(String id, Reference... members);

    Result searchByDomain(String domain);
    Result addDomains(String id, String... domains);
    Result removeDomains(String id, String... domains);
}