org.oxerr.viagogo.client.rescu.webhook.WebhookResource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gogokit-client-rescu Show documentation
There is a newer version: 5.0.2
package org.oxerr.viagogo.client.rescu.webhook;

import java.io.IOException;

import org.oxerr.viagogo.client.rescu.ViagogoException;
import org.oxerr.viagogo.model.response.webhook.Webhook;
import org.oxerr.viagogo.model.response.webhook.Webhooks;

import jakarta.ws.rs.Consumes;
import jakarta.ws.rs.DELETE;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.PATCH;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.PathParam;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.QueryParam;
import jakarta.ws.rs.core.MediaType;

@Path("/{version}/webhooks")
public interface WebhookResource {

	/**
	 * List webhooks
	 *
	 * List webhooks for the authenticated user.
	 *
	 * @param page Specifies which page of data to retrieve.
	 * @param pageSize Set custom page sizes on response.
	 * @param sort Determines the ordering of items. A comma-separated string containing {@code resource_version}.
	 * @return all webhooks on the viagogo platform.
	 * @throws IOException indicates I/O exception
	 * @throws ViagogoException indicates business exception
	 */
	@GET
	@Produces(MediaType.APPLICATION_JSON)
	@Consumes(MediaType.APPLICATION_JSON)
	Webhooks getWebhooks(
		@QueryParam("page") Integer page,
		@QueryParam("page_size") Integer pageSize,
		@QueryParam("sort") String sort
	) throws IOException, ViagogoException;

	/**
	 * Create a webhook
	 *
	 * @param webhook the webhook.
	 * @return the created webhook.
	 * @throws IOException indicates I/O exception
	 * @throws ViagogoException indicates business exception
	 */
	@POST
	@Produces(MediaType.APPLICATION_JSON)
	@Consumes(MediaType.APPLICATION_JSON)
	Webhook createWebhook(Webhook webhook) throws IOException, ViagogoException;

	/**
	 * Get a webhook
	 *
	 * @param webhookId the webhook ID.
	 * @return the webhook.
	 * @throws IOException indicates I/O exception
	 * @throws ViagogoException indicates business exception
	 */
	@GET
	@Path("/{webhookId}")
	Webhook getWebhook(@PathParam("webhookId") Integer webhookId) throws IOException, ViagogoException;

	/**
	 * Update a webhook
	 *
	 * @param webhookId the webhook ID.
	 * @param webhook the webhook.
	 * @return the updated webhook.
	 * @throws IOException indicates I/O exception
	 * @throws ViagogoException indicates business exception
	 */
	@PATCH
	@Path("/{webhookId}")
	@Produces(MediaType.APPLICATION_JSON)
	@Consumes(MediaType.APPLICATION_JSON)
	Webhook updateWebhook(@PathParam("webhookId") Integer webhookId, Webhook webhook) throws IOException, ViagogoException;

	/**
	 * Delete a webhook
	 *
	 * @param webhookId the webhook ID.
	 * @throws IOException indicates I/O exception
	 * @throws ViagogoException indicates business exception
	 */
	@DELETE
	@Path("/{webhookId}")
	void deleteWebhook(@PathParam("webhookId") Integer webhookId) throws IOException, ViagogoException;

	/**
	 * Ping a webhook
	 *
	 * Triggers a request to be sent to your webhook. Call this endpoint to test your webhook.
	 *
	 * @param webhookId the webhook ID.
	 * @throws IOException indicates I/O exception
	 * @throws ViagogoException indicates business exception
	 */
	@POST
	@Path("/{webhookId}/ping")
	@Produces(MediaType.APPLICATION_JSON)
	@Consumes(MediaType.APPLICATION_JSON)
	void ping(@PathParam("webhookId") Integer webhookId) throws IOException, ViagogoException;

}