Class: TicketsAPI

new TicketsAPI(rest)

This class is used to interact with Tickets in TidyHQ.

Parameters:

Name	Type	Description
`rest`	Rest	The rest instance to use for requests.

Source: src/Tickets.js, line 15

Methods

(async) createTicket(event_id, name, optionsopt) → {Promise.<TidyAPI_V1_Ticket>}

Create a ticket category for an event.

Parameters:

Name Type Attributes Default Description

event_id number The ID of the event.

name string The name for the type of ticket.

options

object

{}

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.
`amount`	number	<optional>	The amount for the ticket. Default is 0.00 and is for free tickets.
`initial_quantity`	number	<optional>	Limit the number of tickets available. Default is null and is for unlimited.
`maximum_purchase`	number	<optional>	Limit the number of tickets per purchase.
`sales_end`	string	<optional>	The date in ISO 8601 format for sales to end. Default is null and is for no end date.

Source: src/Tickets.js, line 74

Returns:

- The newly created ticket.

Type:: Promise.<TidyAPI_V1_Ticket>

(async) deleteTicket(event_id, ticket_id, optionsopt) → {Promise.<TidyAPI_Response>}

Delete a ticket category for an event.

Parameters:

Name Type Attributes Default Description

event_id number The ID of the event.

ticket_id string The ID of the ticket.

options

object

{}

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.

Source: src/Tickets.js, line 122

Returns:

- Whether or not the ticket was deleted.

Type:: Promise.<TidyAPI_Response>

(async) getSoldTickets(event_id, optionsopt) → {Promise.<TidyAPI_V1_SoldTickets>}

Get a list of all sold tickets from an event.

Parameters:

Name Type Attributes Default Description

event_id number The ID of the event.

options

object

{}

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.

Source: src/Tickets.js, line 57

Returns:

- The list of sold tickets.

Type:: Promise.<TidyAPI_V1_SoldTickets>

(async) getTicket(event_id, ticket_id, optionsopt) → {Promise.<TidyAPI_V1_Ticket>}

Get a list of all tickets from an event.

Parameters:

Name Type Attributes Default Description

event_id number The ID of the event.

ticket_id string The ID of the ticket.

options

object

{}

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.

Source: src/Tickets.js, line 45

Returns:

- The ticket.

Type:: Promise.<TidyAPI_V1_Ticket>

(async) getTickets(event_id, optionsopt) → {Promise.<TidyAPI_V1_Tickets>}

Get a list of all tickets from an event.

Parameters:

Name Type Attributes Default Description

event_id number The ID of the event.

options

object

{}

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.

Source: src/Tickets.js, line 32

Returns:

- The list of tickets.

Type:: Promise.<TidyAPI_V1_Tickets>

(async) updateTicket(event_id, ticket_id, optionsopt) → {Promise.<TidyAPI_V1_Ticket>}

Update a ticket category for an event.

Parameters:

Name Type Attributes Description

event_id number The ID of the event.

ticket_id string The ID of the ticket.

options

Object

The options for the ticket. At least one option is required that isn't the access token.

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.
`name`	string	<optional>	The name for the type of ticket.
`amount`	number	<optional>	The amount for the ticket.
`initial_quantity`	number	<optional>	Limit the number of tickets available.
`maximum_purchase`	number	<optional>	Limit the number of tickets per purchase.
`sales_end`	string	<optional>	The date in ISO 8601 format for sales to end.

Source: src/Tickets.js, line 99

Returns:

- The updated ticket.

Type:: Promise.<TidyAPI_V1_Ticket>