Ticketmaster Discovery API/com.ticketmaster.discoveryapi.models

Package-level declarations

Types

open class DiscoveryAbstractEntity(val discoveryID: String? = null, val hostID: String? = null, val name: String? = null, val isActive: Boolean? = null, val isDiscoverable: Boolean? = null, val type: String? = null, val prismicImage: String? = null, val imageMetadataList: List<DiscoveryImageMetadata>? = null, val shareURL: String? = null, var tmMarketDomain: TMMarketDomain? = null, val countryCode: String? = null) : Parcelable

Base class for entities like artists or teams in the Discovery API.

DiscoveryAttraction

data class DiscoveryAttraction(val discoveryID: String? = null, val hostID: String? = null, val name: String? = null, val isActive: Boolean? = null, val isDiscoverable: Boolean? = null, val isTestAttraction: Boolean? = null, val type: String? = null, val locale: String? = null, val prismicImage: String? = null, val imageMetadataList: List<DiscoveryImageMetadata>? = null, val classificationList: List<DiscoveryClassification>? = null, val shareURL: String? = null, var tmMarketDomain: TMMarketDomain? = null, val countryCode: String? = null) : DiscoveryAbstractEntity, Parcelable

Represents an artist or sports team in the Discovery API.

DiscoveryAttractionDetailsCriteria

data class DiscoveryAttractionDetailsCriteria(val attractionIDList: List<String>? = null, val pageSize: Int? = null, val sortMethod: String? = null, val classificationIdentifiers: List<String>? = null, val webDomain: TMMarketDomain? = null, val locale: String? = null)

Criteria for querying attraction details in the Discovery API.

DiscoveryAttractionDetailsResponse

data class DiscoveryAttractionDetailsResponse(val id: String?, val name: String?, val type: String?, val url: String?, val locale: String?, val references: DiscoveryReferencesResponse?, val classifications: List<DiscoveryClassificationResponse>?, val images: List<DiscoveryImageResponse>?, val active: Boolean?, val test: Boolean?, val isDiscoverable: Boolean?, val legacyId: String?, val legacyIdUS: String?, val legacyIdUK: String?)

Represents an attraction details response from the Discovery API.

DiscoveryAttractionsContainerResponse

data class DiscoveryAttractionsContainerResponse(val attractionsEmbedded: DiscoveryAttractionsContainerResponse.DiscoveryAttracitionEmbeddedResponse, val pagination: DiscoveryPaginationResponse)

Represents a container for attraction responses from the Discovery API.

DiscoveryAttractionSearchCriteria

data class DiscoveryAttractionSearchCriteria(val attractionIDList: List<String>? = null, val keywordsFilter: String? = null, val source: String? = null, val pageSize: Int? = null, val currentPage: Int? = null, val sortMethod: String? = null, val classificationIdentifiers: List<String>? = null, val classificationName: List<String>? = null, val webDomain: TMMarketDomain? = null, val locale: String? = null)

Criteria for searching attractions in the Discovery API.

DiscoveryCityMedia

data class DiscoveryCityMedia(val name: String?, val largeImage: String?, val smallImage: String?)

DiscoveryCityMediaResponse

data class DiscoveryCityMediaResponse(val name: String?, val header: DiscoveryCityMediaResponse.DiscoveryCityMediaHeader?)

DiscoveryClassification

data class DiscoveryClassification(val segment: DiscoveryClassificationItem?, val genre: DiscoveryClassificationItem?, val subGenre: DiscoveryClassificationItem?, val type: DiscoveryClassificationItem?, val subType: DiscoveryClassificationItem?, val isPrimary: Boolean?) : Parcelable

Represents a classification in the Discovery API.

DiscoveryClassificationDetailsCriteria

data class DiscoveryClassificationDetailsCriteria(val classificationID: String? = null, val webDomain: List<TMMarketDomain>? = null)

Criteria for querying classification details in the Discovery API.

DiscoveryClassificationItem

data class DiscoveryClassificationItem(val classificationId: String?, val name: String?) : Parcelable

Represents a classification item in the Discovery API.

DiscoveryClassificationResponse

data class DiscoveryClassificationResponse(val primary: Boolean, val segment: SegmentResponse, val genre: GenreResponse, val subGenre: GenreResponse, val type: TypeResponse, val subType: TypeResponse)

Represents a classification response from the Discovery API.

DiscoveryClassificationSearchCriteria

data class DiscoveryClassificationSearchCriteria(val classificationID: String? = null, val keywordsFilter: String? = null, val source: List<String>? = null, val locale: List<String>? = null, val pageSize: Int? = null, val currentPage: Int? = null, val sortMethod: String? = null, val preferredCountry: List<String>? = null, val includeSpellCheckResults: Boolean? = null, val webDomain: List<TMMarketDomain>? = null)

Criteria for searching classifications in the Discovery API.

DiscoveryDateRange

data class DiscoveryDateRange(val name: String?, val startDate: String?, val endDate: String?, val dateTBD: Boolean?, val url: String?, val description: String?) : Parcelable

Represents a date range for events in the Discovery API.

DiscoveryEmbeddedEventsResponse

data class DiscoveryEmbeddedEventsResponse(val events: List<DiscoveryEventDetailsResponse>)

Represents embedded event data in the Discovery API response.

DiscoveryEvent

data class DiscoveryEvent(val discoveryID: String? = null, val name: String? = null, val hostID: String? = null, val startDate: String? = null, val localStartDate: String? = null, val localStartTime: String? = null, val endDate: String? = null, val localEndDate: String? = null, val timeZone: String? = null, val spanMultipleDays: Boolean? = null, val dateTBA: Boolean? = null, val dateTBD: Boolean? = null, val timeTBA: Boolean? = null, val noSpecificTime: Boolean? = null, val isActive: Boolean? = null, val isVisible: Boolean? = null, val isDiscoverable: Boolean? = null, val isTestEvent: Boolean? = null, val onSaleStatusCode: String? = null, val type: String? = null, val hostEventType: String? = null, val seriesMaster: Boolean? = null, val domain: String? = null, val locale: String? = null, val info: String? = null, val notes: String? = null, val externalURL: String? = null, val resaleSoftLanding: Boolean? = null, val distance: Double? = null, val visibilityDateRange: DiscoveryDateRange? = null, val publicOnSaleDateRange: DiscoveryDateRange? = null, val presaleDateRangeArray: List<DiscoveryDateRange>? = null, val priceRangeList: List<DiscoveryPriceRange>? = null, val promoter: DiscoveryPromoter? = null, val classificationList: List<DiscoveryClassification>? = null, val imageMetadataList: List<DiscoveryImageMetadata>? = null, val attractions: List<DiscoveryAttraction>? = null, val venues: List<DiscoveryVenue>? = null, val error: TMDiscoveryAPIError? = null) : Parcelable

Represents an event in the Discovery API, such as a concert or sports game.

DiscoveryEventsContainerResponse

data class DiscoveryEventsContainerResponse(val eventsEmbedded: DiscoveryEmbeddedEventsResponse, val pagination: DiscoveryPaginationResponse)

Represents a container for event responses from the Discovery API.

DiscoveryGeoPoint

data class DiscoveryGeoPoint(val latitude: Double, val longitude: Double)

Represents a geographic point in the Discovery API.

DiscoveryImageMetadata

data class DiscoveryImageMetadata(val url: String?, val width: Int?, val height: Int?, val ratio: String?, val fallback: Boolean?, val domainList: List<String>?) : Parcelable

Represents image metadata in the Discovery API.

DiscoveryImageResponse

data class DiscoveryImageResponse(val ratio: String, val url: String, val width: Int, val height: Int, val fallback: Boolean, val domainList: List<String>)

Represents an image response from the Discovery API.

DiscoveryLocationQuery

data class DiscoveryLocationQuery(val geoPoint: DiscoveryGeoPoint, val radius: Int, val unit: Unit)

Represents a location query for the Discovery API.

DiscoveryPaginationResponse

data class DiscoveryPaginationResponse(val size: Int, val totalElements: Int, val totalPage: Int, val number: Int)

Represents pagination details in the Discovery API response.

DiscoveryPriceRange

data class DiscoveryPriceRange(val type: String?, val minimum: Double?, val maximum: Double?, val currency: String?) : Parcelable

Represents a price range in the Discovery API.

DiscoveryPromoter

data class DiscoveryPromoter(val promoterId: String?, val name: String?, val description: String?) : Parcelable

Represents a promoter in the Discovery API.

DiscoveryReferencesResponse

data class DiscoveryReferencesResponse(val ticketmasterUSID: String?, val ticketmasterUKID: String?, val ticketmasterTATID: String?, val ticketmasterBEID: String?, val ticketmasterCZID: String?, val ticketmasterDKID: String?, val ticketmasterDEID: String?, val ticketmasterESID: String?, val ticketmasterNLID: String?, val ticketmasterNOID: String?, val ticketmasterATID: String?, val ticketmasterPLID: String?, val ticketmasterZAID: String?, val ticketmasterFIID: String?, val ticketmasterSEID: String?, val ticketmasterCHID: String?, val ticketmasterAEID: String?)

Represents reference IDs for entities in the Discovery API.

DiscoveryVenue

data class DiscoveryVenue(val discoveryID: String? = null, val hostID: String? = null, val name: String? = null, val isActive: Boolean? = null, val isDiscoverable: Boolean? = null, val venueSystemID: String? = null, val venueCodeString: String? = null, val isTestVenue: Boolean? = null, val addressLine1: String? = null, val addressLine2: String? = null, val city: String? = null, val stateCode: String? = null, val postalCode: String? = null, val countryCode: String? = null, val countryName: String? = null, val latitude: String? = null, val longitude: String? = null, val timeZone: String? = null, val distance: Double? = null, val type: String? = null, val marketList: List<String>? = null, val dmaList: List<String>? = null, val generalRules: String? = null, val childRules: String? = null, val parkingDetails: String? = null, val accessibleSeatingDetails: String? = null, val boxOfficeHours: String? = null, val boxOfficePhoneNumber: String? = null, val boxOfficePaymentDetails: String? = null, val boxOfficeWillCallDetails: String? = null, val prismicImage: String? = null, val imageMetadataList: List<DiscoveryImageMetadata>? = null, val shareURL: String? = null, var tmMarketDomain: TMMarketDomain? = null) : DiscoveryAbstractEntity, Parcelable

Represents a venue in the Discovery API.

DiscoveryVenueSearchCriteria

data class DiscoveryVenueSearchCriteria(val venueIDList: List<String>? = null, val keywordsFilter: String? = null, val location: DiscoveryLocationQuery? = null, val source: String? = null, val pageSize: Int? = null, val currentPage: Int? = null, val sortMethod: String? = null, val webDomain: TMMarketDomain? = null, val locale: List<String>? = null, val countryCode: String? = null)

Criteria for searching venues in the Discovery API.

GenreResponse

data class GenreResponse(val id: String, val name: String)

Represents a genre response from the Discovery API.

MemberInfo

data class MemberInfo(val email: String? = "", val firstName: String? = "", val lastName: String? = "", val memberId: String? = "", val hmacId: String? = "", val accessToken: String? = "", val deviceType: String? = "", val countryCode: String? = "") : Parcelable

Represents member information in the Discovery API.

SegmentResponse

data class SegmentResponse(val id: String, val name: String)

Represents a segment response from the Discovery API.

TypeResponse

data class TypeResponse(val id: String, val name: String)

Represents a type response from the Discovery API.

Functions

area

fun DiscoveryImageResponse.area(): Int