net.worcade.client.api.WebhookApi 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.create.WebhookCreate;
import net.worcade.client.get.Reference;
import net.worcade.client.get.Webhook;
import net.worcade.client.get.WebhookTestResult;
import net.worcade.client.query.Query;
import net.worcade.client.query.WebhookField;

import java.util.Collection;

public interface WebhookApi {
    WebhookCreate createBuilder();

    /**
     * Create a new Webhook. Use the {@link #createBuilder()} method for a new, empty template.
     */
    Result create(String ownerId, WebhookCreate subject);
    Result delete(String id);
    Result> getWebhookList(Query query);
    Result> getLogs(String id, boolean includeDeleted);

    /**
     * @param id The id of the webhook to test
     */
    Result requestTest(String id);
}