Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AdminApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private apiContext

apiContext: SeatersApiContext

Methods

addAliases

  • Parameters

    • id: string
    • idsToConvert: string[]

    Returns Promise<ProfilingFanAttribute>

Protected buildPagingQueryParams

  • buildPagingQueryParams(pagingOptions: PagingOptions): object

Protected buildParams

  • buildParams(obj?: object): object

  • Parameters

    • Default value obj: object = {}

    Returns object

createAnswerSemantic

createCategory

createFanAttribute

createFanGroupProtectionCode

  • createFanGroupProtectionCode(fanGroupId: string, code: string, maxTimesUsed: number): Promise<FanGroupProtectionCode>

  • Parameters

    • fanGroupId: string
    • code: string
    • maxTimesUsed: number

    Returns Promise<FanGroupProtectionCode>

createInterest

createQuestion

  • Parameters

    Returns Promise<Question>

createSurvey

  • Parameters

    Returns Promise<Survey>

createSurveyInstances

createUser

  • Parameters

    Returns Promise<User>

createUserOwnership

deleteCategory

  • deleteCategory(id: string): Promise<any>

  • Parameters

    • id: string

    Returns Promise<any>

deleteFanAttribute

  • deleteFanAttribute(id: string): Promise<any>

  • Parameters

    • id: string

    Returns Promise<any>

deleteFanGroupProtectionCode

  • deleteFanGroupProtectionCode(fanGroupId: string, code: string): Promise<any>

  • Parameters

    • fanGroupId: string
    • code: string

    Returns Promise<any>

deleteInterest

  • deleteInterest(id: string): Promise<any>

  • Parameters

    • id: string

    Returns Promise<any>

deleteUser

  • deleteUser(id: string): Promise<User>

  • Parameters

    • id: string

    Returns Promise<User>

deleteUserOwnership

deleteWaitingList

  • deleteWaitingList(waitingListId: string): Promise<any>

  • Parameters

    • waitingListId: string

    Returns Promise<any>

getAnswerSemantic

  • Parameters

    • id: string

    Returns Promise<AnswerSemantic>

getAnswerSemantics

  • getAnswerSemantics(options: PagingOptions): Promise<PagedResult<AnswerSemantic>>

  • Parameters

    • options: PagingOptions

    Returns Promise<PagedResult<AnswerSemantic>>

getCategories

  • Parameters

    • options: PagingOptions

    Returns Promise<PagedResult<ProfilingCategory>>

getCategory

  • Parameters

    • id: string

    Returns Promise<ProfilingCategory>

getFanAttribute

  • Parameters

    • id: string

    Returns Promise<ProfilingFanAttribute>

getFanAttributes

  • Parameters

    • options: PagingOptions

    Returns Promise<PagedResult<ProfilingFanAttribute>>

getFanGroup

  • getFanGroup(fanGroupId: string): Promise<FanGroup>

  • Parameters

    • fanGroupId: string

    Returns Promise<FanGroup>

getFanGroupProtectionCodes

  • getFanGroupProtectionCodes(fanGroupId: string, page: PagingOptions): Promise<PagedResult<FanGroupProtectionCode>>

  • Parameters

    • fanGroupId: string
    • page: PagingOptions

    Returns Promise<PagedResult<FanGroupProtectionCode>>

getFanGroupWaitingLists

  • getFanGroupWaitingLists(fanGroupId: string, page: PagingOptions): Promise<PagedResult<WaitingList>>

  • Parameters

    • fanGroupId: string
    • page: PagingOptions

    Returns Promise<PagedResult<WaitingList>>

getInterest

  • Parameters

    • id: string

    Returns Promise<ProfilingInterest>

getInterests

  • Parameters

    • options: PagingOptions

    Returns Promise<PagedResult<ProfilingCategory>>

getQuestion

  • getQuestion(id: string): Promise<Question>

  • Parameters

    • id: string

    Returns Promise<Question>

getQuestions

  • getQuestions(options: PagingOptions): Promise<PagedResult<Question>>

  • Parameters

    • options: PagingOptions

    Returns Promise<PagedResult<Question>>

getSurvey

  • getSurvey(id: string): Promise<Survey>

  • Parameters

    • id: string

    Returns Promise<Survey>

getSurveyInstance

  • getSurveyInstance(id: string): Promise<Survey>

  • Parameters

    • id: string

    Returns Promise<Survey>

getSurveyInstances

  • getSurveyInstances(options: PagingOptions): Promise<PagedResult<SurveyInstance>>

  • Parameters

    • options: PagingOptions

    Returns Promise<PagedResult<SurveyInstance>>

getSurveys

  • getSurveys(options: PagingOptions): Promise<PagedResult<Survey>>

  • Parameters

    • options: PagingOptions

    Returns Promise<PagedResult<Survey>>

getUser

  • getUser(id: string): Promise<User>

  • Parameters

    • id: string

    Returns Promise<User>

getUserOwnerships

  • getUserOwnerships(userId: string, page: PagingOptions): Promise<PagedResult<FanGroupOwnership>>

  • Parameters

    • userId: string
    • page: PagingOptions

    Returns Promise<PagedResult<FanGroupOwnership>>

getUsers

  • getUsers(page: PagingOptions): Promise<PagedResult<User>>

  • Parameters

    • page: PagingOptions

    Returns Promise<PagedResult<User>>

getWaitingList

  • getWaitingList(waitingListId: string): Promise<WaitingList>

  • Parameters

    • waitingListId: string

    Returns Promise<WaitingList>

importFanGroupProtectionCodes

  • importFanGroupProtectionCodes(fanGroupId: string, fileId: string): Promise<any>

  • Parameters

    • fanGroupId: string
    • fileId: string

    Returns Promise<any>

orderCategories

  • orderCategories(orderedCategoryIds: string[]): Promise<any>

  • Parameters

    • orderedCategoryIds: string[]

    Returns Promise<any>

requestFanGroupBackgroundImageUpload

  • requestFanGroupBackgroundImageUpload(fanGroupId: string, fileName?: string): Promise<OneTimeFile>

  • Parameters

    • fanGroupId: string
    • Optional fileName: string

    Returns Promise<OneTimeFile>

requestFanGroupCoverImageUpload

  • requestFanGroupCoverImageUpload(fanGroupId: string, fileName?: string): Promise<OneTimeFile>

  • Parameters

    • fanGroupId: string
    • Optional fileName: string

    Returns Promise<OneTimeFile>

Private requestFanGroupImageUpload

  • requestFanGroupImageUpload(fanGroupId: string, endpoint: string, fileName?: string): Promise<OneTimeFile>

  • HELPERS

    Parameters

    • fanGroupId: string
    • endpoint: string
    • Optional fileName: string

    Returns Promise<OneTimeFile>

requestFanGroupProfileImageUpload

  • requestFanGroupProfileImageUpload(fanGroupId: string, fileName?: string): Promise<OneTimeFile>

  • Parameters

    • fanGroupId: string
    • Optional fileName: string

    Returns Promise<OneTimeFile>

requestOneTimeFileUpload

  • requestOneTimeFileUpload(fileName?: string): Promise<OneTimeFile>

  • Parameters

    • Optional fileName: string

    Returns Promise<OneTimeFile>

searchUsers

  • Parameters

    Returns Promise<PagedResult<User>>

unvalidateFanAttribute

  • Parameters

    • id: string

    Returns Promise<ProfilingFanAttribute>

updateAnswerSemantic

updateCategory

updateFanAttribute

updateInterest

updateQuestion

  • Parameters

    Returns Promise<Question>

updateSurvey

  • Parameters

    Returns Promise<Survey>

updateSurveyInstances

updateUser

  • Parameters

    Returns Promise<User>

updateWaitingList

  • Parameters

    Returns Promise<WaitingList>

uploadOneTimeFile

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

  • Upload a onetime file

    Parameters

    • oneTimeFileUrl: string

      url of a OneTimeFile returned by requestOneTimeFileUpload

    • data: any

      for browsers: HTMLInputElement, for node: not supported

    Returns Promise<any>

validateFanAttribute

Generated using TypeDoc