org.oxerr.viagogo.client.rescu.sale.SaleResource 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.sale;

import java.io.IOException;
import java.time.Instant;

import org.oxerr.viagogo.client.rescu.ViagogoException;
import org.oxerr.viagogo.model.response.PagedResource;
import org.oxerr.viagogo.model.response.sale.Sale;

import jakarta.ws.rs.GET;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.PathParam;
import jakarta.ws.rs.QueryParam;

/**
 * viagogo Sales API.
 *
 * View your sales details and fulfill your sales.
 */
@Path("/{version}")
public interface SaleResource {

	/**
	 * List sales (recent updates).
	 *
	 * List sales for the authenticated user that have been created or updated over a certain period of time.
	 *
	 * @param updatedSince Filters the response to only return items that have been updated since the given timestamp.
	 * @return sales for the authenticated user that have been created or updated over a certain period of time.
	 * @throws IOException indicates I/O exception.
	 * @throws ViagogoException indicates business exception.
	 */
	@GET
	@Path("/sales/recentupdates")
	PagedResource getSalesRecentUpdates(@QueryParam("updated_since") Instant updatedSince)
		throws IOException, ViagogoException;

	/**
	 * List sales.
	 *
	 * List sales for the authenticated user.
	 *
	 * @param page specifies which page of data to retrieve.
	 * @param pageSize set custom page sizes on response.
	 * @param updatedSince filters the response to only return items
	 * that have been updated since the given timestamp.
	 * @param sort determines the ordering of items.
	 * A comma-separated string containing {@code created_at},
	 * {@code event_date}, {@code inhand_at}, {@code payment_amount},
	 * {@code quantity}, or {@code resource_version}.
	 * @return the sales for the authenticated user.
	 * @throws IOException indicates I/O exception.
	 * @throws ViagogoException indicates business exception.
	 */
	@GET
	@Path("/sales")
	PagedResource getSales(
		@QueryParam("page") Integer page,
		@QueryParam("page_size") Integer pageSize,
		@QueryParam("updated_since") Instant updatedSince,
		@QueryParam("sort") String sort
	) throws IOException, ViagogoException;

	/**
	 * Get a sale.
	 *
	 * @param saleId the sale ID.
	 * @return the sale.
	 * @throws IOException indicates I/O exception.
	 * @throws ViagogoException indicates business exception.
	 */
	@GET
	@Path("/sales/{saleId}")
	Sale getSale(@PathParam("saleId") Integer saleId) throws IOException, ViagogoException;

}