Class FanApi

Hierarchy

FanApi

Index

Constructors

constructor

Properties

apiContext

Methods

Constructors

constructor

new FanApi(apiContext: SeatersApiContext): FanApi

- Defined in seaters-api/fan/fan-api.ts:41
Parameters
- apiContext: SeatersApiContext
Returns FanApi

Properties

Private apiContext

apiContext: SeatersApiContext

Methods

acceptSeats

acceptSeats(waitingListId: string): Promise<WaitingList>

- Defined in seaters-api/fan/fan-api.ts:232
Parameters
- waitingListId: string
Returns Promise<WaitingList>

createPositionSalesTransaction

createPositionSalesTransaction(waitingListId: string, transaction: PositionSalesTransactionInput): Promise<PositionSalesTransaction>

- Defined in seaters-api/fan/fan-api.ts:262
Parameters
- waitingListId: string
- transaction: PositionSalesTransactionInput
Returns Promise<PositionSalesTransaction>

deletePositionSalesTransaction

deletePositionSalesTransaction(waitingListId: string): Promise<any>

- Defined in seaters-api/fan/fan-api.ts:271
Parameters
- waitingListId: string
Returns Promise<any>

exportSeats

exportSeats(waitingListId: string): Promise<void>

- Defined in seaters-api/fan/fan-api.ts:244
Parameters
- waitingListId: string
Returns Promise<void>

fan

fan(): Promise<Fan>

- Defined in seaters-api/fan/fan-api.ts:44
Returns Promise<Fan>

fanGroup

fanGroup(fanGroupId: string): Promise<FanGroup>

- Defined in seaters-api/fan/fan-api.ts:64
Parameters
- fanGroupId: string
Returns Promise<FanGroup>

fanGroupBySlug

fanGroupBySlug(slug: string): Promise<FanGroup>

- Defined in seaters-api/fan/fan-api.ts:68
Parameters
- slug: string
Returns Promise<FanGroup>

fanGroupLook

fanGroupLook(slug: string): Promise<FanGroupLook>

- Defined in seaters-api/fan/fan-api.ts:94
Parameters
- slug: string
Returns Promise<FanGroupLook>

fanGroupLookBySlug

fanGroupLookBySlug(slug: string): Promise<FanGroupLook>

- Defined in seaters-api/fan/fan-api.ts:72
Parameters
- slug: string
Returns Promise<FanGroupLook>

fanGroupTranslatedDescription

fanGroupTranslatedDescription(fanGroupId: string): Promise<string>

- Defined in seaters-api/fan/fan-api.ts:76
Parameters
- fanGroupId: string
Returns Promise<string>

fanGroups

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

- Defined in seaters-api/fan/fan-api.ts:84
Parameters
- fanGroupIds: string[]
Returns Promise<FanGroup[]>

getAnswers

getAnswers(surveyInstanceId: string): Promise<PagedSortedResult<Answer>>

- Defined in seaters-api/fan/fan-api.ts:451
Gets list of answers for a given surveyInstanceId

Parameters
- surveyInstanceId: string
Returns Promise<PagedSortedResult<Answer>>

getEventDescription

getEventDescription(waitingListId: string): Promise<TranslationMap>

- Defined in seaters-api/fan/fan-api.ts:286
Parameters
- waitingListId: string
Returns Promise<TranslationMap>

getProfilingCategories

getProfilingCategories(pagingOptions?: PagingOptions): Promise<PagedSortedResult<ProfilingCategory>>

- Defined in seaters-api/fan/fan-api.ts:308
Gets complete list of categories

Parameters
- Optional pagingOptions: PagingOptions
Returns Promise<PagedSortedResult<ProfilingCategory>>

getProfilingCategoryById

getProfilingCategoryById(categoryId: any): Promise<ProfilingCategory>

- Defined in seaters-api/fan/fan-api.ts:317
Gets single category

Parameters
- categoryId: any
Returns Promise<ProfilingCategory>

getProfilingFanAttributeById

getProfilingFanAttributeById(fanAttributeId: string): Promise<ProfilingFanAttribute>

- Defined in seaters-api/fan/fan-api.ts:369
Gets single user fan attributes

Parameters
- fanAttributeId: string
Returns Promise<ProfilingFanAttribute>

getSurveys

getSurveys(pagingOptions?: PagingOptions): Promise<PagedSortedResult<SurveyInstance>>

- Defined in seaters-api/fan/fan-api.ts:442
Gets list of surveys per wishlist

Parameters
- Optional pagingOptions: PagingOptions
Returns Promise<PagedSortedResult<SurveyInstance>>

getTranslatedEventDescription

getTranslatedEventDescription(waitingListId: string): Promise<string>

- Defined in seaters-api/fan/fan-api.ts:294
Parameters
- waitingListId: string
Returns Promise<string>

getTranslatedVenueConditions

getTranslatedVenueConditions(waitingListId: string): Promise<string>

- Defined in seaters-api/fan/fan-api.ts:298
Parameters
- waitingListId: string
Returns Promise<string>

getUserAnswers

getUserAnswers(waitingListId: string, surveyInstanceId: string, pagingOptions?: PagingOptions): Promise<PagedSortedResult<Answer>>

- Defined in seaters-api/fan/fan-api.ts:492
Gets list of answers for a given user, survey and waitinglist

Parameters
- waitingListId: string
- surveyInstanceId: string
- Optional pagingOptions: PagingOptions
Returns Promise<PagedSortedResult<Answer>>

getUserFanAttributes

getUserFanAttributes(pagingOptions?: PagingOptions): Promise<PagedSortedResult<UserFanAttribute>>

- Defined in seaters-api/fan/fan-api.ts:357
Gets list of user fan attribute

Parameters
- Optional pagingOptions: PagingOptions
Returns Promise<PagedSortedResult<UserFanAttribute>>

getUserInterests

getUserInterests(pagingOptions?: PagingOptions): Promise<PagedSortedResult<UserInterest>>

- Defined in seaters-api/fan/fan-api.ts:327
Gets complete list of interests with their user status and their categoryId

Parameters
- Optional pagingOptions: PagingOptions
Returns Promise<PagedSortedResult<UserInterest>>

getVenueConditions

getVenueConditions(waitingListId: string): Promise<TranslationMap>

- Defined in seaters-api/fan/fan-api.ts:290
Parameters
- waitingListId: string
Returns Promise<TranslationMap>

getWaitingListCategories

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

- Defined in seaters-api/fan/fan-api.ts:388
Parameters
- Optional pagingOptions: PagingOptions
Returns Promise<PagedSortedResult<ProfilingCategory>>

getWaitingListFanAttributes

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

- Defined in seaters-api/fan/fan-api.ts:397
Parameters
- waitingListId: string
- pagingOptions: PagingOptions
Returns Promise<PagedSortedResult<WaitingListFanAttribute>>

getWaitingListInterests

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

- Defined in seaters-api/fan/fan-api.ts:393
Parameters
- waitingListId: string
Returns Promise<PagedSortedResult<WaitingListInterest>>

getWaitingListSurveys

getWaitingListSurveys(waitingListId: string, pagingOptions?: PagingOptions): Promise<PagedSortedResult<SurveyInstance>>

- Defined in seaters-api/fan/fan-api.ts:474
Gets list of surveys per wishlist

Parameters
- waitingListId: string
- Optional pagingOptions: PagingOptions
Returns Promise<PagedSortedResult<SurveyInstance>>

hasGeoFilteredWaitingLists

hasGeoFilteredWaitingLists(fanGroupId: string): Promise<FanGroupFilterInfo>

- Defined in seaters-api/fan/fan-api.ts:80
Parameters
- fanGroupId: string
Returns Promise<FanGroupFilterInfo>

joinFanGroup

joinFanGroup(fanGroupId: string): Promise<FanGroup>

- Defined in seaters-api/fan/fan-api.ts:98
Parameters
- fanGroupId: string
Returns Promise<FanGroup>

joinProtectedFanGroup

joinProtectedFanGroup(fg: FanGroup, code: string): Promise<FanGroupRequest>

- Defined in seaters-api/fan/fan-api.ts:102
Parameters
- fg: FanGroup
- code: string
Returns Promise<FanGroupRequest>

joinProtectedWaitingList

joinProtectedWaitingList(wl: WaitingList, code: string, numberOfSeats: number, additionalQueryParams: StringMap): Promise<WaitingListRequest>

- Defined in seaters-api/fan/fan-api.ts:200
Parameters
- wl: WaitingList
- code: string
- numberOfSeats: number
- additionalQueryParams: StringMap
Returns Promise<WaitingListRequest>

joinWaitingList

joinWaitingList(waitingListId: string, numberOfSeats: number, additionalQueryParams: StringMap): Promise<WaitingList>

- Defined in seaters-api/fan/fan-api.ts:187
Parameters
- waitingListId: string
- numberOfSeats: number
- additionalQueryParams: StringMap
Returns Promise<WaitingList>

joinedFanGroups

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

- Defined in seaters-api/fan/fan-api.ts:141
Parameters
- pagingOptions: PagingOptions
Returns Promise<PagedResult<FanGroup>>

joinedWaitingListsWithSeat

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

- Defined in seaters-api/fan/fan-api.ts:153
Parameters
- pagingOptions: PagingOptions
Returns Promise<PagedResult<WaitingList>>

joinedWaitingListsWithoutSeat

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

- Defined in seaters-api/fan/fan-api.ts:145
Parameters
- pagingOptions: PagingOptions
Returns Promise<PagedResult<WaitingList>>

leaveFanGroup

leaveFanGroup(fanGroupId: string): Promise<void>

- Defined in seaters-api/fan/fan-api.ts:117
Parameters
- fanGroupId: string
Returns Promise<void>

leaveWaitingList

leaveWaitingList(waitingListId: string): Promise<void>

- Defined in seaters-api/fan/fan-api.ts:226
Parameters
- waitingListId: string
Returns Promise<void>

linkWaitingListFanAttribute

linkWaitingListFanAttribute(waitingListId: string, fanAttributeId: string): Promise<WaitingListFanAttribute>

- Defined in seaters-api/fan/fan-api.ts:413
Parameters
- waitingListId: string
- fanAttributeId: string
Returns Promise<WaitingListFanAttribute>

linkWaitingListInterest

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

- Defined in seaters-api/fan/fan-api.ts:405
Parameters
- waitingListId: string
- interestId: string
Returns Promise<WaitingListInterest>

loadAdditionalCharges

loadAdditionalCharges(waitingListId: string): Promise<AdditionalCharges[]>

- Defined in seaters-api/fan/fan-api.ts:505
Parameters
- waitingListId: string
Returns Promise<AdditionalCharges[]>

positionBraintreeToken

positionBraintreeToken(waitingListId: string): Promise<BraintreeToken>

- Defined in seaters-api/fan/fan-api.ts:256
Parameters
- waitingListId: string
Returns Promise<BraintreeToken>

positionPaymentInfo

positionPaymentInfo(waitingListId: string): Promise<PaymentInfo>

- Defined in seaters-api/fan/fan-api.ts:250
Parameters
- waitingListId: string
Returns Promise<PaymentInfo>

rejectSeats

rejectSeats(waitingListId: string): Promise<WaitingList>

- Defined in seaters-api/fan/fan-api.ts:238
Parameters
- waitingListId: string
Returns Promise<WaitingList>

seachFanAttributes

seachFanAttributes(query: string, validated: boolean): Promise<ProfilingFanAttribute[]>

- Defined in seaters-api/fan/fan-api.ts:348
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[]>

shareFanGroup

shareFanGroup(fanGroupId: string): Promise<FanGroupShare>

- Defined in seaters-api/fan/fan-api.ts:121
Parameters
- fanGroupId: string
Returns Promise<FanGroupShare>

shareWaitingList

shareWaitingList(waitingListId: string): Promise<WaitingListShare>

- Defined in seaters-api/fan/fan-api.ts:222
Parameters
- waitingListId: string
Returns Promise<WaitingListShare>

submitAnswers

submitAnswers(surveyInstanceId: string, answers: Answer[]): Promise<Answer[]>

- Defined in seaters-api/fan/fan-api.ts:460
Submits list of answers for a given surveyInstanceId

Parameters
- surveyInstanceId: string
- answers: Answer[]
Returns Promise<Answer[]>

unlinkWaitingListFanAttribute

unlinkWaitingListFanAttribute(waitingListId: string, fanAttributeId: string): Promise<WaitingListFanAttribute>

- Defined in seaters-api/fan/fan-api.ts:429
Parameters
- waitingListId: string
- fanAttributeId: string
Returns Promise<WaitingListFanAttribute>

unlinkWaitingListInterest

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

- Defined in seaters-api/fan/fan-api.ts:421
Parameters
- waitingListId: string
- interestId: string
Returns Promise<WaitingListInterest>

updateAttendeesInfo

updateAttendeesInfo(waitingListId: string, attendeesInfo: AttendeeInfo[]): Promise<Position>

- Defined in seaters-api/fan/fan-api.ts:277
Parameters
- waitingListId: string
- attendeesInfo: AttendeeInfo[]
Returns Promise<Position>

updateEmail

updateEmail(data: IUpdateEmailDTO): Promise<Fan>

- Defined in seaters-api/fan/fan-api.ts:56
Parameters
- data: IUpdateEmailDTO
Returns Promise<Fan>

updateFan

updateFan(fan: Fan): Promise<Fan>

- Defined in seaters-api/fan/fan-api.ts:48
Parameters
- fan: Fan
Returns Promise<Fan>

updateMobilePhoneNumber

updateMobilePhoneNumber(data: PhoneNumber): Promise<Fan>

- Defined in seaters-api/fan/fan-api.ts:60
Parameters
- data: PhoneNumber
Returns Promise<Fan>

updatePassword

updatePassword(data: IUpdatePasswordDTO): Promise<Fan>

- Defined in seaters-api/fan/fan-api.ts:52
Parameters
- data: IUpdatePasswordDTO
Returns Promise<Fan>

updateUserFanAttribute

updateUserFanAttribute(options: UserFanAttributeUpdateDTO): Promise<UserFanAttribute>

- Defined in seaters-api/fan/fan-api.ts:378
Updates user fan attribute (Link / Unlink / Create )

Parameters
- options: UserFanAttributeUpdateDTO
Returns Promise<UserFanAttribute>

updateUserInterest

updateUserInterest(options: UserInterestUpdateDTO): Promise<UserInterest>

- Defined in seaters-api/fan/fan-api.ts:335
Updates a user interest

Parameters
- options: UserInterestUpdateDTO
Returns Promise<UserInterest>

waitingList

waitingList(waitingListId: string): Promise<WaitingList>

- Defined in seaters-api/fan/fan-api.ts:165
Parameters
- waitingListId: string
Returns Promise<WaitingList>

waitingListPrice

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

- Defined in seaters-api/fan/fan-api.ts:178
Parameters
- waitingListId: string
- numberOfSeats: number
Returns Promise<Price>

waitingListTranslatedVenueDescription

waitingListTranslatedVenueDescription(waitingListId: string): Promise<string>

- Defined in seaters-api/fan/fan-api.ts:161
Parameters
- waitingListId: string
Returns Promise<string>

waitingLists

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

- Defined in seaters-api/fan/fan-api.ts:171
Parameters
- waitingListIds: string[]
Returns Promise<WaitingList[]>

waitingListsInFanGroup

waitingListsInFanGroup(fanGroupId: string, pagingOptions: PagingOptions): Promise<PagedResult<WaitingList>>

- Defined in seaters-api/fan/fan-api.ts:125
Parameters
- fanGroupId: string
- pagingOptions: PagingOptions
Returns Promise<PagedResult<WaitingList>>

waitingListsInFanGroups

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

- Defined in seaters-api/fan/fan-api.ts:131
Parameters
- fanGroupIds: string[]
- pagingOptions: PagingOptions
Returns Promise<PagedResult<WaitingList>>

Generated using TypeDoc