Package org.oxerr.viagogo.client.rescu.resource.sale

Interface SaleResource

@Path("/{version}")
public interface SaleResource

viagogo Sales API.

View your sales details and fulfill your sales.

Method Summary

Modifier and Type	Method	Description
org.oxerr.viagogo.model.response.sale.Sale	getSale(Integer saleId)	Get a sale.
org.oxerr.viagogo.model.response.PagedResource<org.oxerr.viagogo.model.response.sale.Sale>	getSales(Integer page, Integer pageSize, Instant updatedSince, String sort)	List sales.
org.oxerr.viagogo.model.response.PagedResource<org.oxerr.viagogo.model.response.sale.Sale>	getSalesRecentUpdates(Instant updatedSince)	List sales (recent updates).

Method Details

getSalesRecentUpdates

@GET
@Path("/sales/recentupdates")
org.oxerr.viagogo.model.response.PagedResource<org.oxerr.viagogo.model.response.sale.Sale> getSalesRecentUpdates(@QueryParam("updated_since")
 Instant updatedSince)
                                                                                                          throws IOException,
ViagogoException

List sales (recent updates).

List sales for the authenticated user that have been created or updated over a certain period of time.

Parameters:

updatedSince - Filters the response to only return items that have been updated since the given timestamp.

Returns:

sales for the authenticated user that have been created or updated over a certain period of time.

Throws:

IOException - indicates I/O exception.

ViagogoException - indicates business exception.

getSales

@GET
@Path("/sales")
org.oxerr.viagogo.model.response.PagedResource<org.oxerr.viagogo.model.response.sale.Sale> getSales(@QueryParam("page")
 Integer page,
 @QueryParam("page_size")
 Integer pageSize,
 @QueryParam("updated_since")
 Instant updatedSince,
 @QueryParam("sort")
 String sort)
                                                                                             throws IOException,
ViagogoException

List sales.

List sales for the authenticated user.

Parameters:

page - specifies which page of data to retrieve.

pageSize - set custom page sizes on response.

updatedSince - filters the response to only return items that have been updated since the given timestamp.

sort - determines the ordering of items. A comma-separated string containing created_at, event_date, inhand_at, payment_amount, quantity, or resource_version.

Returns:

the sales for the authenticated user.

Throws:

IOException - indicates I/O exception.

ViagogoException - indicates business exception.

getSale

@GET
@Path("/sales/{saleId}")
org.oxerr.viagogo.model.response.sale.Sale getSale(@PathParam("saleId")
 Integer saleId)
                                            throws IOException,
ViagogoException

Get a sale.

Parameters:

saleId - the sale ID.

Returns:

the sale.

Throws:

IOException - indicates I/O exception.

ViagogoException - indicates business exception.