Package-level declarations

Types

Link copied to clipboard
data class AccessResponse(var startDateTime: String? = null, var startApproximate: Boolean = false, var endDateTime: String? = null, var endApproximate: Boolean = false)

Represents access time details for an event in the Discovery API.

Link copied to clipboard
class ApiEndPointProvider(currentMarket: TMMarketDomain = TMMarketDomain.US)

Provides API and web endpoints for the Discovery API based on market.

Link copied to clipboard
interface DiscoveryApiSdkComponent : KoinScopeComponent
Link copied to clipboard
class DiscoveryAttractionService(getAttractionSearchUseCase: GetAttractionSearchUseCase, getAttractionDetailsUseCase: GetAttractionDetailsUseCase)

Service for retrieving attraction-related data in the Discovery API.

Link copied to clipboard

Service for managing authentication cookies in the Discovery API.

Link copied to clipboard

Service for retrieving category data in the Discovery API.

Link copied to clipboard
class DiscoveryClassificationService(getClassificationSearchUseCase: GetClassificationSearchUseCase, getClassificationDetailsUseCase: GetClassificationDetailsUseCase)

Service for retrieving classification data in the Discovery API.

Link copied to clipboard
data class DiscoveryEventDetailsResponse(var id: String? = null, var classifications: List<DiscoveryClassificationResponse>? = null, var eventDatesResponse: EventDatesResponse? = null, var images: List<DiscoveryImageResponse>? = null, var info: String? = null, var locale: String? = null, var name: String? = null, var pleaseNote: String? = null, var priceRanges: List<PriceRangeResponse>? = null, var promoter: PromoterResponse? = null, var sales: SalesResponse? = null, var test: Boolean = false, var onSaleStatusCode: String? = null, var type: String? = null, var url: String? = null, var isActive: Boolean? = null, var isVisible: Boolean? = null, var isDiscoverable: Boolean? = null, var domain: String? = null, var distance: Double? = null, var source: DiscoveryEventDetailsResponse.Source? = null, var eventExtensions: DiscoveryEventDetailsResponse.DiscoveryEventExtensions? = null, var references: DiscoveryReferencesResponse? = null, var visibilityDateRange: PublicSalesResponse? = null, var embeddedContainer: DiscoveryEventDetailsResponse.DiscoveryEmbeddedContainer? = null, var errors: TMDiscoveryAPIError? = null)

Represents an event details response from the Discovery API.

Link copied to clipboard
class DiscoveryEventService(getEventDetailsUseCase: GetEventDetailsUseCase, getEventListUseCase: GetEventListUseCase)

Service for retrieving event data in the Discovery API.

Link copied to clipboard
data class DiscoveryIDConversionResponse(var idList: List<String>? = null)

Represents an ID conversion response from the Discovery API.

Link copied to clipboard
class DiscoveryIDConversionService(getDiscoveryIDUseCase: GetDiscoveryIDConversionUseCase, getDiscoveryEventIDUseCase: GetDiscoveryEventIdsConversionUseCase, getDiscoveryVenueIDUseCase: GetDiscoveryVenueIdsConversionUseCase)

Service for handling ID conversions in the Discovery API.

Link copied to clipboard
data class DiscoveryPlaceResponse(var area: DiscoveryPlaceResponse.Area? = null, var address: DiscoveryPlaceResponse.Address? = null, var city: DiscoveryPlaceResponse.City? = null, var state: DiscoveryPlaceResponse.State? = null, var country: DiscoveryPlaceResponse.Country? = null, var postalCode: String? = null, var location: DiscoveryPlaceResponse.Location? = null, var name: String? = null)

Represents a place response from the Discovery API.

Link copied to clipboard

Service for handling third-party operations in the Discovery API.

Link copied to clipboard
data class DiscoveryVenueDetailsResponse(var id: String? = null, var name: String? = null, var type: String? = null, var url: String? = null, var locale: String? = null, var postalCode: String? = null, var timezone: String? = null, var parkingDetail: String? = null, var active: Boolean = false, var test: Boolean = false, var source: DiscoveryVenueDetailsResponse.Source? = null, val lastUpdate: Long? = null, val entityChanges: EntityChanges? = null, val relationships: List<Relationship>? = null, val upcomingEvents: UpcomingEvents? = null, val links: Links? = null, var distance: Double = 0.0, var units: String? = null, var city: DiscoveryPlaceResponse.City? = null, var state: DiscoveryPlaceResponse.State? = null, var country: DiscoveryPlaceResponse.Country? = null, var location: DiscoveryPlaceResponse.Location? = null, var address: DiscoveryPlaceResponse.Address? = null, var markets: List<DiscoveryVenueDetailsResponse.Market?>? = null, var dmas: List<DiscoveryVenueDetailsResponse.Dma?>? = null, var generalInfo: DiscoveryVenueDetailsResponse.GeneralInfo? = null, var references: DiscoveryReferencesResponse? = null, var isDiscoverable: Boolean = false, var accessibleSeatingDetail: String? = null, var boxOfficeInfo: DiscoveryVenueDetailsResponse.BoxOfficeInfo? = null, var imageList: List<DiscoveryImageResponse>? = null)

Represents a venue details response from the Discovery API.

Link copied to clipboard

Represents a container for venue responses from the Discovery API.

Link copied to clipboard
class DiscoveryVenueService(getVenueSearchUseCase: GetVenueSearchUseCase, getVenueDetailsUseCase: GetVenueDetailsUseCase, apiEndPointProvider: ApiEndPointProvider)

Service for retrieving venue data in the Discovery API.

Link copied to clipboard
data class EventDatesResponse(var id: String? = null, var access: AccessResponse? = null, var start: EventStartResponse? = null, var end: EventEndResponse? = null, var timezone: String? = null, var status: EventStatusResponse? = null, var spanMultipleDays: Boolean = false)

Represents event date details in the Discovery API response.

Link copied to clipboard
data class EventEndResponse(var approximate: Boolean = false, var dateTime: String? = null, var localDate: String? = null, var noSpecificTime: Boolean = false)

Represents event end date details in the Discovery API response.

Link copied to clipboard
data class EventStartResponse(var dateTime: String? = null, var localDate: String? = null, var localTime: String? = null, var dateTBD: Boolean = false, var dateTBA: Boolean = false, var timeTBA: Boolean = false, var noSpecificTime: Boolean = false)

Represents event start date details in the Discovery API response.

Link copied to clipboard
data class EventStatusResponse(var code: String? = null)

Represents event status details in the Discovery API response.

Link copied to clipboard
data class PriceRangeResponse(var type: String? = null, var currency: String? = null, var min: Double = 0.0, var max: Double = 0.0)

Represents a price range response from the Discovery API.

Link copied to clipboard
class PrismicInterceptor : Interceptor

Interceptor for adding Prismic headers to API requests in the Discovery API.

Link copied to clipboard
data class PromoterResponse(var id: String? = null, var name: String? = null, var description: String? = null)

Represents a promoter response from the Discovery API.

Link copied to clipboard
data class PublicSalesResponse(var startDateTime: String? = null, var startTBD: Boolean = false, var endDateTime: String? = null, var name: String? = null, var url: String? = null, var description: String? = null)

Represents public sales details in the Discovery API response.

Link copied to clipboard
data class SalesResponse(var publicSales: PublicSalesResponse? = null, var preSalesDateRangeList: List<PublicSalesResponse>? = null)

Represents sales details in the Discovery API response.

Link copied to clipboard

Main entry point for the Discovery API SDK.

Link copied to clipboard
data class TMDiscoveryAPIError(val code: String, val detail: String, val status: String) : Parcelable

Represents an error response from the Discovery API.

Link copied to clipboard

Represents a collection of error responses from the Discovery API.

Properties

Link copied to clipboard
const val AE_ID: String

Constant for the UAE market ID.

Link copied to clipboard
const val AE_NAME: String

Constant for the UAE market name.

Link copied to clipboard
const val ARTIST_PATH: String

Constant for the artist path in URLs.

Link copied to clipboard

Constant for the arts and theater category ID.

Link copied to clipboard
const val AT_ID: String

Constant for the Austria market ID.

Link copied to clipboard
const val AT_NAME: String

Constant for the Austria market name.

Link copied to clipboard

Constant for the attraction ID query parameter.

Link copied to clipboard
const val AU_NAME: String

Constant for the Australia market name.

Link copied to clipboard
const val BE_ID: String

Constant for the Belgium market ID.

Link copied to clipboard
const val BE_NAME: String

Constant for the Belgium market name.

Link copied to clipboard

Constant key for storing browsing market selection.

Link copied to clipboard
const val CA_ES_LANG: String

Constant for the Catalan locale.

Link copied to clipboard
const val CA_NAME: String

Constant for the Canada market name.

Link copied to clipboard
const val CH_ID: String

Constant for the Switzerland market ID.

Link copied to clipboard
const val CH_NAME: String

Constant for the Switzerland market name.

Link copied to clipboard

Constant for the classification ID query parameter.

Link copied to clipboard

Constant for the classification name query parameter.

Link copied to clipboard

Constant for the client visibility query parameter.

Link copied to clipboard

Constant for the comedy category ID.

Link copied to clipboard

Constant for the concert category ID.

Link copied to clipboard
const val COUNTRY_CODE: String

Constant for the country code query parameter.

Link copied to clipboard

Constant key for tracking country dialog dismissal.

Link copied to clipboard

Constant key for tracking country pointer dismissal.

Link copied to clipboard
const val CS_CZ_LANG: String

Constant for the Czech locale.

Link copied to clipboard
const val CURRENT_PAGE: String

Constant for the current page query parameter.

Link copied to clipboard
const val CZ_ID: String

Constant for the Czech Republic market ID.

Link copied to clipboard
const val CZ_NAME: String

Constant for the Czech Republic market name.

Link copied to clipboard
const val DA_DK_LANG: String

Constant for the Danish locale.

Link copied to clipboard
const val DE_AT_LANG: String

Constant for the Austrian German locale.

Link copied to clipboard
const val DE_CH_LANG: String

Constant for the Swiss German locale.

Link copied to clipboard
const val DE_DE_LANG: String

Constant for the German locale.

Link copied to clipboard
const val DE_ID: String

Constant for the Germany market ID.

Link copied to clipboard
const val DE_NAME: String

Constant for the Germany market name.

Link copied to clipboard
const val DEFAULT_PAGE_SIZE: Int = 20

Constant for the default page size.

Link copied to clipboard
const val DEFAULT_STARTING_PAGE: Int = 0

Constant for the default starting page number.

Link copied to clipboard
const val DID_PARAM: String

Constant for the device ID parameter in API requests.

Link copied to clipboard

Constant for the UAE discovery domain.

Link copied to clipboard

Constant for the Austria discovery domain.

Link copied to clipboard

Constant for the Australia discovery domain.

Link copied to clipboard

Constant for the Belgium discovery domain.

Link copied to clipboard

Constant for the Canada discovery domain.

Link copied to clipboard

Constant for the Switzerland discovery domain.

Link copied to clipboard

Constant for the Czech Republic discovery domain.

Link copied to clipboard

Constant for the Germany discovery domain.

Link copied to clipboard

Constant for the Denmark discovery domain.

Link copied to clipboard

Constant for the Spain discovery domain.

Link copied to clipboard

Constant for the Finland discovery domain.

Link copied to clipboard

Constant for the Ireland discovery domain.

Link copied to clipboard

Constant for the Mexico discovery domain.

Link copied to clipboard

Constant for the Netherlands discovery domain.

Link copied to clipboard

Constant for the Norway discovery domain.

Link copied to clipboard

Constant for the New Zealand discovery domain.

Link copied to clipboard

Constant for the Poland discovery domain.

Link copied to clipboard

Constant for the Sweden discovery domain.

Link copied to clipboard
const val DISCOVER_TAT: String

Constant for the TAT discovery domain.

Link copied to clipboard
const val DISCOVER_UK: String

Constant for the UK discovery domain.

Link copied to clipboard

Constant for the UK discovery domain.

Link copied to clipboard
const val DISCOVER_US: String

Constant for the US discovery domain.

Link copied to clipboard

Constant for the US discovery domain.

Link copied to clipboard

Constant for the internal discovery view.

Link copied to clipboard

Constant for discovery visibility settings.

Link copied to clipboard

Constant for the South Africa discovery domain.

Link copied to clipboard

Constant for the Ticketmaster discovery extension.

Link copied to clipboard
const val DK_ID: String

Constant for the Denmark market ID.

Link copied to clipboard
const val DK_NAME: String

Constant for the Denmark market name.

Link copied to clipboard
const val DMA_ID: String

Constant for the DMA ID query parameter.

Link copied to clipboard
const val DOMAIN: String

Constant for the domain query parameter.

Link copied to clipboard
const val EMPTY: String

Constant for an empty string placeholder.

Link copied to clipboard
const val EN: String

Constant for the generic English language code.

Link copied to clipboard
const val EN_AE_LANG: String

Constant for the UAE English locale.

Link copied to clipboard
const val EN_AU_LANG: String

Constant for the Australian English locale.

Link copied to clipboard
const val EN_CA_LANG: String

Constant for the Canadian English locale.

Link copied to clipboard
const val EN_IE_LANG: String

Constant for the Irish English locale.

Link copied to clipboard
const val EN_LANG: String

Constant for the US English locale.

Link copied to clipboard
const val EN_NZ_LANG: String

Constant for the New Zealand English locale.

Link copied to clipboard
const val EN_UK_LANG: String

Constant for the UK English locale.

Link copied to clipboard
const val EN_ZA_LANG: String

Constant for the South African English locale.

Link copied to clipboard
const val END_DATE: String

Constant for the end date query parameter.

Link copied to clipboard
const val ENTITY_ID: String

Constant for the entity ID query parameter.

Link copied to clipboard
const val ES_ES_LANG: String

Constant for the Spanish locale.

Link copied to clipboard
const val ES_ID: String

Constant for the Spain market ID.

Link copied to clipboard
const val ES_MX_LANG: String

Constant for the Mexican Spanish locale.

Link copied to clipboard
const val ES_NAME: String

Constant for the Spain market name.

Link copied to clipboard
const val EVENT_ID: String

Constant for the event ID query parameter.

Link copied to clipboard
const val EVENT_PATH: String

Constant for the event path in URLs.

Link copied to clipboard

Constant for storing favorite event IDs in preferences.

Link copied to clipboard
const val EXTENSIONS: String

Constant for the extensions query parameter.

Link copied to clipboard

Constant for the artist ID extra in intents.

Link copied to clipboard

Constant for the source of navigation in intents.

Link copied to clipboard

Constant for the category path extra in intents.

Link copied to clipboard

Constant for forcing favorites enablement in intents.

Link copied to clipboard

Constant for the venue ID extra in intents.

Link copied to clipboard

Constant for the family category ID.

Link copied to clipboard

Constant for the festival category ID.

Link copied to clipboard
const val FI_FI_LANG: String

Constant for the Finnish locale.

Link copied to clipboard
const val FI_ID: String

Constant for the Finland market ID.

Link copied to clipboard
const val FI_NAME: String

Constant for the Finland market name.

Link copied to clipboard
const val FR_BE_LANG: String

Constant for the Belgian French locale.

Link copied to clipboard
const val FR_CA_LANG: String

Constant for the Canadian French locale.

Link copied to clipboard
const val FR_CH_LANG: String

Constant for the Swiss French locale.

Link copied to clipboard

Constant for hiding the web country icon in API requests.

Link copied to clipboard

Constant for hiding the web heart icon in API requests.

Link copied to clipboard

Constant for enabling ICCP category page in API requests.

Link copied to clipboard
const val ID: String

Constant for the ID query parameter.

Link copied to clipboard
const val IE_NAME: String

Constant for the Ireland market name.

Link copied to clipboard

Constant for enabling checkout SDK in API requests.

Link copied to clipboard

Constant for the Ignite client parameter in API requests.

Link copied to clipboard

Constant for the mobile application name in API requests.

Link copied to clipboard

Constant for enabling global web view in API requests.

Link copied to clipboard

Constant for enabling spell check in queries.

Link copied to clipboard
const val INCLUDE_TBA: String

Constant for including TBA events in queries.

Link copied to clipboard
const val INCLUDE_TBD: String

Constant for including TBD events in queries.

Link copied to clipboard
const val INCLUDE_TEST: String

Constant for including test events in queries.

Link copied to clipboard
const val IT_IT_LANG: String

Constant for the Italian locale.

Link copied to clipboard
const val KEYWORD: String

Constant for the keyword query parameter.

Link copied to clipboard

Constant for the language query parameter in API requests.

Link copied to clipboard
const val LATLONG: String

Constant for the latlong query parameter.

Link copied to clipboard
const val LOCALE: String

Constant for the locale query parameter.

Link copied to clipboard
const val MARKET_ID: String

Constant for the market ID query parameter.

Link copied to clipboard

Constant for the miscellaneous category ID.

Link copied to clipboard
const val MX_NAME: String

Constant for the Mexico market name.

Link copied to clipboard
const val NL_BE_LANG: String

Constant for the Belgian Dutch locale.

Link copied to clipboard
const val NL_ID: String

Constant for the Netherlands market ID.

Link copied to clipboard
const val NL_NAME: String

Constant for the Netherlands market name.

Link copied to clipboard
const val NL_NL_LANG: String

Constant for the Dutch locale.

Link copied to clipboard
const val NO_ID: String

Constant for the Norway market ID.

Link copied to clipboard
const val NO_NAME: String

Constant for the Norway market name.

Link copied to clipboard
const val NO_NO_LANG: String

Constant for the Norwegian locale.

Link copied to clipboard
const val NZ_NAME: String

Constant for the New Zealand market name.

Link copied to clipboard
const val ONSALE_AFTER: String

Constant for the on-sale after start date query parameter.

Link copied to clipboard
const val ONSALE_END: String

Constant for the on-sale end date query parameter.

Link copied to clipboard
const val ONSALE_START: String

Constant for the on-sale start date query parameter.

Link copied to clipboard
const val PAGE_SIZE: String

Constant for the page size query parameter.

Link copied to clipboard
const val PL_ID: String

Constant for the Poland market ID.

Link copied to clipboard
const val PL_NAME: String

Constant for the Poland market name.

Link copied to clipboard
const val PL_PL_LANG: String

Constant for the Polish locale.

Link copied to clipboard

Constant value for the global platform in API requests.

Link copied to clipboard

Constant for the platform header in API requests.

Link copied to clipboard
const val POSTAL_CODE: String

Constant for the postal code query parameter.

Link copied to clipboard

Constant for pre-purchase preferences storage.

Link copied to clipboard

Constant for the preferred country query parameter.

Link copied to clipboard
const val PROMOTER_ID: String

Constant for the promoter ID query parameter.

Link copied to clipboard
const val RADIUS: String

Constant for the radius query parameter.

Link copied to clipboard
const val REGION_PARAM: String

Constant for the region parameter in API requests.

Link copied to clipboard
const val RESOURCE: String

Constant for the resource query parameter.

Link copied to clipboard
const val SE_ID: String

Constant for the Sweden market ID.

Link copied to clipboard
const val SE_NAME: String

Constant for the Sweden market name.

Link copied to clipboard
const val SEARCH_PATH: String

Constant for the search path in URLs.

Link copied to clipboard

Constant for showing cities in app header in API requests.

Link copied to clipboard
const val SORT_BY: String

Constant for the sort method query parameter.

Link copied to clipboard
const val SOURCE: String

Constant for the source query parameter.

Link copied to clipboard

Constant for the baseball sport category ID.

Link copied to clipboard

Constant for the basketball sport category ID.

Link copied to clipboard

Constant for the football sport category ID.

Link copied to clipboard

Constant for the hockey sport category ID.

Link copied to clipboard

Constant for the sports category ID.

Link copied to clipboard
const val START_DATE: String

Constant for the start date query parameter.

Link copied to clipboard
const val STATE_CODE: String

Constant for the state code query parameter.

Link copied to clipboard

Constant for the subchannel ID parameter in API requests.

Link copied to clipboard
const val SV_SE_LANG: String

Constant for the Swedish locale.

Link copied to clipboard

Constant for the Ticketmaster app package name.

Link copied to clipboard

Constant for the Ticketmaster demo app package name.

Link copied to clipboard
const val UK_NAME: String

Constant for the United Kingdom market name.

Link copied to clipboard
const val UNIT: String

Constant for the unit query parameter.

Link copied to clipboard
const val US_NAME: String

Constant for the United States market name.

Link copied to clipboard

Constant for the user-agent header in API requests.

Link copied to clipboard
const val VENUE_ID: String

Constant for the venue ID query parameter.

Link copied to clipboard
const val VENUE_PATH: String

Constant for the venue path in URLs.

Link copied to clipboard
const val VIEW: String

Constant for the view query parameter.

Link copied to clipboard
const val WILD_CARD: String

Constant for the wildcard locale.

Link copied to clipboard
const val ZA_ID: String

Constant for the South Africa market ID.

Link copied to clipboard
const val ZA_NAME: String

Constant for the South Africa market name.