Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FanApi

Hierarchy

  • FanApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private apiContext

apiContext: SeatersApiContext

Methods

acceptSeats

  • acceptSeats(waitingListId: string, formatUsed: string): Promise<WaitingList>
  • Parameters

    • waitingListId: string
    • formatUsed: string

    Returns Promise<WaitingList>

addChoices

  • addChoices(questionId: string, choices: any): any
  • Parameters

    • questionId: string
    • choices: any

    Returns any

addPosition

  • addPosition(waitingListId: string, fanId: string, params: any): Promise<any>
  • Parameters

    • waitingListId: string
    • fanId: string
    • params: any

    Returns Promise<any>

addProperties

  • addProperties(waitingListId: string, properties: any): Promise<any>
  • Parameters

    • waitingListId: string
    • properties: any

    Returns Promise<any>

addWaitingListTickets

  • addWaitingListTickets(waitingListId: string, totalTickets: number, ticketsToAdd: number): Promise<any>
  • Parameters

    • waitingListId: string
    • totalTickets: number
    • ticketsToAdd: number

    Returns Promise<any>

assignWaitingListParkingSeatToFan

  • assignWaitingListParkingSeatToFan(waitingListId: string, fanId: string): Promise<any>
  • Parameters

    • waitingListId: string
    • fanId: string

    Returns Promise<any>

assignWaitingListSeatToFan

  • assignWaitingListSeatToFan(waitingListId: string, fanId: string): Promise<any>
  • Parameters

    • waitingListId: string
    • fanId: string

    Returns Promise<any>

assignWithoutSeats

  • assignWithoutSeats(waitingListId: string, fanId: string): Promise<any>
  • Parameters

    • waitingListId: string
    • fanId: string

    Returns Promise<any>

closeWaitingList

  • closeWaitingList(waitingListId: string): Promise<any>
  • Parameters

    • waitingListId: string

    Returns Promise<any>

createPositionSalesTransaction

createWaitingList

  • createWaitingList(fanGroupId: any, waitingList: any): Promise<any>
  • Parameters

    • fanGroupId: any
    • waitingList: any

    Returns Promise<any>

declineFanPosition

  • declineFanPosition(waitingListId: string, fanId: string): Promise<any>
  • Parameters

    • waitingListId: string
    • fanId: string

    Returns Promise<any>

deletePositionSalesTransaction

  • deletePositionSalesTransaction(waitingListId: string): Promise<any>
  • Parameters

    • waitingListId: string

    Returns Promise<any>

draftWaitingList

  • draftWaitingList(waitingListId: string): Promise<any>
  • Parameters

    • waitingListId: string

    Returns Promise<any>

exportSeats

  • exportSeats(waitingListId: string, formatUsed: string): Promise<void>
  • Parameters

    • waitingListId: string
    • formatUsed: string

    Returns Promise<void>

fan

  • fan(): Promise<Fan>
  • Returns Promise<Fan>

fanGroup

  • fanGroup(fanGroupId: string): Promise<FanGroup>
  • Parameters

    • fanGroupId: string

    Returns Promise<FanGroup>

fanGroupBySlug

  • fanGroupBySlug(slug: string): Promise<FanGroup>
  • Parameters

    • slug: string

    Returns Promise<FanGroup>

fanGroupLook

  • Parameters

    • slug: string

    Returns Promise<FanGroupLook>

fanGroupLookBySlug

  • Parameters

    • slug: string

    Returns Promise<FanGroupLook>

fanGroupTranslatedDescription

  • fanGroupTranslatedDescription(fanGroupId: string): Promise<string>
  • Parameters

    • fanGroupId: string

    Returns Promise<string>

fanGroups

  • fanGroups(fanGroupIds: string[]): Promise<FanGroup[]>
  • Parameters

    • fanGroupIds: string[]

    Returns Promise<FanGroup[]>

getAdditionalInfos

  • getAdditionalInfos(waitingListId: string): Promise<any>
  • Parameters

    • waitingListId: string

    Returns Promise<any>

getAnswers

  • getAnswers(surveyInstanceId: string): Promise<PagedSortedResult<Answer>>
  • Gets list of answers for a given surveyInstanceId

    Parameters

    • surveyInstanceId: string

    Returns Promise<PagedSortedResult<Answer>>

getAvailableSeats

  • getAvailableSeats(wlId: any): Promise<any>
  • Parameters

    • wlId: any

    Returns Promise<any>

getBadgeProtection

  • Parameters

    • waitingListId: string

    Returns Promise<BadgeProtection>

getBadges

  • getBadges(fanGroupId: string, pagingOptions?: PagingOptions): Promise<PagedSortedResult<Badge>>
  • Parameters

    • fanGroupId: string
    • Optional pagingOptions: PagingOptions

    Returns Promise<PagedSortedResult<Badge>>

getBasicConnectedAppToken

  • getBasicConnectedAppToken(): Promise<any>
  • Returns Promise<any>

getChoices

  • getChoices(questionId: string, pagingOptions?: any): any
  • Parameters

    • questionId: string
    • Optional pagingOptions: any

    Returns any

getChoicesAsFO

  • getChoicesAsFO(questionId: string, pagingOptions?: any): any
  • Parameters

    • questionId: string
    • Default value pagingOptions: any = { itemOffset: 0, maxPageSize: 200000 }

    Returns any

getEventDescription

  • Parameters

    • waitingListId: string

    Returns Promise<TranslationMap>

getExiredPositions

  • getExiredPositions(waitingListId: string, query: string): Promise<any>
  • Parameters

    • waitingListId: string
    • query: string

    Returns Promise<any>

getFanActivities

  • getFanActivities(fanId: string, fanGroupId: string): Promise<any>
  • Parameters

    • fanId: string
    • fanGroupId: string

    Returns Promise<any>

getFanAttribute

  • getFanAttribute(fanId: string): Promise<any>
  • Parameters

    • fanId: string

    Returns Promise<any>

getFanGroupBadges

  • getFanGroupBadges(fanGroupId: string, pagingOptions?: PagingOptions): Promise<PagedSortedResult<Badge>>
  • Parameters

    • fanGroupId: string
    • Optional pagingOptions: PagingOptions

    Returns Promise<PagedSortedResult<Badge>>

getFanInfo

  • getFanInfo(fanId: string): Promise<any>
  • Parameters

    • fanId: string

    Returns Promise<any>

getFanInterests

  • getFanInterests(fanId: string): Promise<any>
  • Parameters

    • fanId: string

    Returns Promise<any>

getJoinsCount

  • getJoinsCount(): Promise<any>
  • Returns Promise<any>

getOwnedFanGroups

  • getOwnedFanGroups(pagingOptions?: PagingOptions): Promise<any>
  • Parameters

    • Optional pagingOptions: PagingOptions

    Returns Promise<any>

getPickedSeats

  • getPickedSeats(wlId: any): Promise<any>
  • Parameters

    • wlId: any

    Returns Promise<any>

getPositionSalesTransaction

getPositions

  • getPositions(waitingListId: any, query?: string, pagingOptions?: PagingOptions): Promise<any>
  • Parameters

    • waitingListId: any
    • Optional query: string
    • Optional pagingOptions: PagingOptions

    Returns Promise<any>

getProfilingCategories

  • getProfilingCategories(pagingOptions?: PagingOptions): Promise<PagedSortedResult<ProfilingCategory>>
  • Gets complete list of categories

    Parameters

    • Optional pagingOptions: PagingOptions

    Returns Promise<PagedSortedResult<ProfilingCategory>>

getProfilingCategoryById

  • Gets single category

    Parameters

    • categoryId: any

    Returns Promise<ProfilingCategory>

getProfilingFanAttributeById

  • Gets single user fan attributes

    Parameters

    • fanAttributeId: string

    Returns Promise<ProfilingFanAttribute>

getSeatingMap

  • getSeatingMap(wlId: any): Promise<any>
  • Parameters

    • wlId: any

    Returns Promise<any>

getSeats

  • getSeats(waitingListId: any, query?: string, pagingOptions?: PagingOptions): Promise<any>
  • Parameters

    • waitingListId: any
    • Optional query: string
    • Optional pagingOptions: PagingOptions

    Returns Promise<any>

getSurveys

  • getSurveys(pagingOptions?: PagingOptions): Promise<PagedSortedResult<SurveyInstance>>
  • Gets list of surveys per wishlist

    Parameters

    • Optional pagingOptions: PagingOptions

    Returns Promise<PagedSortedResult<SurveyInstance>>

getTranslatedEventDescription

  • getTranslatedEventDescription(waitingListId: string): Promise<string>
  • Parameters

    • waitingListId: string

    Returns Promise<string>

getTranslatedVenueConditions

  • getTranslatedVenueConditions(waitingListId: string): Promise<string>
  • Parameters

    • waitingListId: string

    Returns Promise<string>

getUserAnswers

  • getUserAnswers(waitingListId: string, surveyInstanceId: string, pagingOptions?: PagingOptions): Promise<PagedSortedResult<Answer>>
  • Gets list of answers for a given user, survey and waitinglist

    Parameters

    • waitingListId: string
    • surveyInstanceId: string
    • Optional pagingOptions: PagingOptions

    Returns Promise<PagedSortedResult<Answer>>

getUserBadges

  • getUserBadges(fanGroupId: string, userId: string, pagingOptions?: PagingOptions): Promise<PagedSortedResult<Badge>>
  • Parameters

    • fanGroupId: string
    • userId: string
    • Optional pagingOptions: PagingOptions

    Returns Promise<PagedSortedResult<Badge>>

getUserFanAttributes

  • getUserFanAttributes(pagingOptions?: PagingOptions): Promise<PagedSortedResult<UserFanAttribute>>
  • Gets list of user fan attribute

    Parameters

    • Optional pagingOptions: PagingOptions

    Returns Promise<PagedSortedResult<UserFanAttribute>>

getUserInterests

  • getUserInterests(pagingOptions?: PagingOptions): Promise<PagedSortedResult<UserInterest>>
  • Gets complete list of interests with their user status and their categoryId

    Parameters

    • Optional pagingOptions: PagingOptions

    Returns Promise<PagedSortedResult<UserInterest>>

getVenueConditions

  • Parameters

    • waitingListId: string

    Returns Promise<TranslationMap>

getWLBadges

  • getWLBadges(waitingListId: string, pagingOptions?: PagingOptions): Promise<any>
  • Parameters

    • waitingListId: string
    • Optional pagingOptions: PagingOptions

    Returns Promise<any>

getWaitingListAsFGO

  • getWaitingListAsFGO(waitingListId: string): Promise<any>
  • Parameters

    • waitingListId: string

    Returns Promise<any>

getWaitingListCategories

  • getWaitingListCategories(pagingOptions?: PagingOptions): Promise<PagedSortedResult<ProfilingCategory>>
  • Parameters

    • Optional pagingOptions: PagingOptions

    Returns Promise<PagedSortedResult<ProfilingCategory>>

getWaitingListFanAttributes

  • getWaitingListFanAttributes(waitingListId: string, pagingOptions: PagingOptions): Promise<PagedSortedResult<WaitingListFanAttribute>>
  • Parameters

    • waitingListId: string
    • pagingOptions: PagingOptions

    Returns Promise<PagedSortedResult<WaitingListFanAttribute>>

getWaitingListInterests

  • getWaitingListInterests(waitingListId: string): Promise<PagedSortedResult<WaitingListInterest>>
  • Parameters

    • waitingListId: string

    Returns Promise<PagedSortedResult<WaitingListInterest>>

getWaitingListSurveys

  • getWaitingListSurveys(waitingListId: string, pagingOptions?: PagingOptions): Promise<PagedSortedResult<SurveyInstance>>
  • Gets list of surveys per wishlist

    Parameters

    • waitingListId: string
    • Optional pagingOptions: PagingOptions

    Returns Promise<PagedSortedResult<SurveyInstance>>

getWaitingListsAsFGO

  • getWaitingListsAsFGO(fanGroupId: string, searchOptions: any, pagingOptions?: PagingOptions): Promise<any>
  • Parameters

    • fanGroupId: string
    • searchOptions: any
    • Optional pagingOptions: PagingOptions

    Returns Promise<any>

grantBadge

  • Parameters

    Returns Promise<any>

hasGeoFilteredWaitingLists

  • Parameters

    • fanGroupId: string

    Returns Promise<FanGroupFilterInfo>

joinFanGroup

  • joinFanGroup(fanGroupId: string): Promise<FanGroup>
  • Parameters

    • fanGroupId: string

    Returns Promise<FanGroup>

joinProtectedFanGroup

joinProtectedWaitingList

joinWaitingList

  • joinWaitingList(waitingListId: string, numberOfSeats: number, selectedSeats: any, additionalQueryParams: StringMap): Promise<WaitingList>
  • Parameters

    • waitingListId: string
    • numberOfSeats: number
    • selectedSeats: any
    • additionalQueryParams: StringMap

    Returns Promise<WaitingList>

joinedFanGroups

  • joinedFanGroups(pagingOptions: PagingOptions): Promise<PagedResult<FanGroup>>
  • Parameters

    • pagingOptions: PagingOptions

    Returns Promise<PagedResult<FanGroup>>

joinedWaitingListsWithSeat

  • joinedWaitingListsWithSeat(pagingOptions: PagingOptions): Promise<PagedResult<WaitingList>>
  • Parameters

    • pagingOptions: PagingOptions

    Returns Promise<PagedResult<WaitingList>>

joinedWaitingListsWithoutSeat

  • joinedWaitingListsWithoutSeat(pagingOptions: PagingOptions): Promise<PagedResult<WaitingList>>
  • Parameters

    • pagingOptions: PagingOptions

    Returns Promise<PagedResult<WaitingList>>

leaveFanGroup

  • leaveFanGroup(fanGroupId: string): Promise<void>
  • Parameters

    • fanGroupId: string

    Returns Promise<void>

leaveWaitingList

  • leaveWaitingList(waitingListId: string): Promise<void>
  • Parameters

    • waitingListId: string

    Returns Promise<void>

linkBadgeToWl

  • linkBadgeToWl(waitingListId: string, body: BadgeWlOptions): Promise<any>
  • Parameters

    Returns Promise<any>

linkWaitingListFanAttribute

  • Parameters

    • waitingListId: string
    • fanAttributeId: string

    Returns Promise<WaitingListFanAttribute>

linkWaitingListInterest

  • linkWaitingListInterest(waitingListId: string, interestId: string): Promise<WaitingListInterest>
  • Parameters

    • waitingListId: string
    • interestId: string

    Returns Promise<WaitingListInterest>

loadAdditionalCharges

  • Parameters

    • waitingListId: string

    Returns Promise<AdditionalCharges[]>

oauthAuthorizationCodeUrl

  • oauthAuthorizationCodeUrl(provider: string): Promise<any>
  • Parameters

    • provider: string

    Returns Promise<any>

openWaitingList

  • openWaitingList(waitingListId: string): Promise<any>
  • Parameters

    • waitingListId: string

    Returns Promise<any>

positionBraintreeToken

  • positionBraintreeToken(waitingListId: string): Promise<BraintreeToken>
  • Parameters

    • waitingListId: string

    Returns Promise<BraintreeToken>

positionPaymentInfo

  • positionPaymentInfo(waitingListId: string): Promise<PaymentInfo>
  • Parameters

    • waitingListId: string

    Returns Promise<PaymentInfo>

publishWaitingList

  • publishWaitingList(waitingListId: string): Promise<any>
  • Parameters

    • waitingListId: string

    Returns Promise<any>

rejectSeats

  • rejectSeats(waitingListId: string): Promise<WaitingList>
  • Parameters

    • waitingListId: string

    Returns Promise<WaitingList>

relinkBadgeToWl

  • relinkBadgeToWl(waitingListId: string, linkId: string): Promise<any>
  • Parameters

    • waitingListId: string
    • linkId: string

    Returns Promise<any>

removeFanFromWaitingList

  • removeFanFromWaitingList(waitingListId: string, fanId: string): Promise<any>
  • Parameters

    • waitingListId: string
    • fanId: string

    Returns Promise<any>

requestOneTimeFileUpload

  • requestOneTimeFileUpload(fileName?: string): Promise<any>
  • Parameters

    • Optional fileName: string

    Returns Promise<any>

revokeBadge

  • Parameters

    Returns Promise<any>

scheduleWaitingList

  • scheduleWaitingList(waitingListId: string, date: string): Promise<any>
  • Parameters

    • waitingListId: string
    • date: string

    Returns Promise<any>

seachFanAttributes

  • Performs search operation on name and aliases of fan attribues

    Parameters

    • query: string

      search query

    • validated: boolean

      to fetch only validated fan attributes

    Returns Promise<ProfilingFanAttribute[]>

searchEvent

  • searchEvent(eventName: string, date: string, pagingOptions?: PagingOptions): Promise<any>
  • Parameters

    • eventName: string
    • date: string
    • Optional pagingOptions: PagingOptions

    Returns Promise<any>

searchMember

  • searchMember(fanGroupId: string, query: string, pagingOptions?: PagingOptions): Promise<any>
  • Parameters

    • fanGroupId: string
    • query: string
    • Optional pagingOptions: PagingOptions

    Returns Promise<any>

searchVenues

  • searchVenues(venueName?: string, pagingOptions?: PagingOptions): Promise<any>
  • Parameters

    • Optional venueName: string
    • Optional pagingOptions: PagingOptions

    Returns Promise<any>

sendExportedSeats

  • sendExportedSeats(waitingListId: string): Promise<any>
  • Parameters

    • waitingListId: string

    Returns Promise<any>

sendPayCallback

  • sendPayCallback(reference: string): any
  • Parameters

    • reference: string

    Returns any

shareFanGroup

  • Parameters

    • fanGroupId: string

    Returns Promise<FanGroupShare>

shareWaitingList

  • Parameters

    • waitingListId: string

    Returns Promise<WaitingListShare>

submitAnswers

  • submitAnswers(surveyInstanceId: string, answers: Answer[]): Promise<Answer[]>
  • Submits list of answers for a given surveyInstanceId

    Parameters

    • surveyInstanceId: string
    • answers: Answer[]

    Returns Promise<Answer[]>

unlinkBadgeToWl

  • unlinkBadgeToWl(waitingListId: string, linkId: string): Promise<any>
  • Parameters

    • waitingListId: string
    • linkId: string

    Returns Promise<any>

unlinkWaitingListFanAttribute

  • Parameters

    • waitingListId: string
    • fanAttributeId: string

    Returns Promise<WaitingListFanAttribute>

unlinkWaitingListInterest

  • unlinkWaitingListInterest(waitingListId: string, interestId: string): Promise<WaitingListInterest>
  • Parameters

    • waitingListId: string
    • interestId: string

    Returns Promise<WaitingListInterest>

updateAttendeesInfo

  • Parameters

    Returns Promise<Position>

updateEmail

  • Parameters

    Returns Promise<Fan>

updateFan

  • updateFan(fan: Fan): Promise<Fan>
  • Parameters

    Returns Promise<Fan>

updateMobilePhoneNumber

  • Parameters

    Returns Promise<Fan>

updatePassword

updateUserFanAttribute

updateUserInterest

updateWaitingList

  • updateWaitingList(waitingList: any): Promise<any>
  • Parameters

    • waitingList: any

    Returns Promise<any>

updateWlImage

  • updateWlImage(waitingListId: string, fileId: string): Promise<any>
  • Parameters

    • waitingListId: string
    • fileId: string

    Returns Promise<any>

uploadOneTimeFile

  • uploadOneTimeFile(oneTimeFileUrl: string, data: any): Promise<any>
  • Parameters

    • oneTimeFileUrl: string
    • data: any

    Returns Promise<any>

waitingList

  • waitingList(waitingListId: string): Promise<WaitingList>
  • Parameters

    • waitingListId: string

    Returns Promise<WaitingList>

waitingListPrice

  • waitingListPrice(waitingListId: string, numberOfSeats: number): Promise<Price>
  • Parameters

    • waitingListId: string
    • numberOfSeats: number

    Returns Promise<Price>

waitingListTotalDemand

  • waitingListTotalDemand(waitingListId: string): Promise<any>
  • Parameters

    • waitingListId: string

    Returns Promise<any>

waitingListTranslatedVenueDescription

  • waitingListTranslatedVenueDescription(waitingListId: string): Promise<string>
  • Parameters

    • waitingListId: string

    Returns Promise<string>

waitingLists

  • waitingLists(waitingListIds: string[]): Promise<WaitingList[]>
  • Parameters

    • waitingListIds: string[]

    Returns Promise<WaitingList[]>

waitingListsInFanGroup

  • waitingListsInFanGroup(fanGroupId: string, pagingOptions: PagingOptions, keyWords?: string): Promise<PagedResult<WaitingList>>
  • Parameters

    • fanGroupId: string
    • pagingOptions: PagingOptions
    • Optional keyWords: string

    Returns Promise<PagedResult<WaitingList>>

waitingListsInFanGroupByKeywords

  • waitingListsInFanGroupByKeywords(groupIds: string, pagingOptions: PagingOptions, keyWords?: string): Promise<PagedResult<WaitingList>>
  • Parameters

    • groupIds: string
    • pagingOptions: PagingOptions
    • Optional keyWords: string

    Returns Promise<PagedResult<WaitingList>>

waitingListsInFanGroups

  • waitingListsInFanGroups(fanGroupIds: string[], pagingOptions: PagingOptions, keyWords?: string): Promise<PagedResult<WaitingList>>
  • Parameters

    • fanGroupIds: string[]
    • pagingOptions: PagingOptions
    • Optional keyWords: string

    Returns Promise<PagedResult<WaitingList>>

waitinglistAvailableSeats

  • waitinglistAvailableSeats(waitingListId: string): Promise<any>
  • Parameters

    • waitingListId: string

    Returns Promise<any>

waitinglistFinishedDistributing

  • waitinglistFinishedDistributing(waitingListId: string, nextDistributionNumber: any): Promise<any>
  • Parameters

    • waitingListId: string
    • nextDistributionNumber: any

    Returns Promise<any>

waitinglistParkingAvailableSeats

  • waitinglistParkingAvailableSeats(waitingListId: string): Promise<any>
  • Parameters

    • waitingListId: string

    Returns Promise<any>

Generated using TypeDoc