Hierarchy

  • Accounts

Constructors

Properties

routeList: Route = ...
routeMe: Route = ...
routeMyTickets: Route = ...
routeProfile: Route = ...
routeRemovePreference: Route = ...
routeRemoveSecurePreference: Route = ...
routeSetAvatarImage: Route = ...
routeSetPreference: Route = ...
routeSetProfileImage: Route = ...
routeSetSecurePreference: Route = ...
routeUpdate: Route = ...

Methods

  • Retrives a list of accounts that is associated with an organizer's account. The auth token used must be related to the organizer account.

    See

    Accounts List - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • Optional query: null | object

      Data that will be passed in the query string as a parameter.

    • Optional options: null | object

      Further options that can be used to modify the request.

    Returns Promise<any>

  • Retrieves the current users account based the auth token being used.

    See

    Accounts Me - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • Optional query: null | object

      Data that will be passed in the query string as a parameter.

    • Optional options: null | object

      Further options that can be used to modify the request.

    Returns Promise<any>

  • For users that have either RSVPed or purchased tickets to an event, this will list their tickets.

    See

    Accounts My Tickets - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • Optional query: null | object

      Data that will be passed in the query string as a parameter.

    • Optional options: null | object

      Further options that can be used to modify the request.

    Returns Promise<any>

  • Retrieve the profile related to a user by their ID.

    See

    Accounts Profile - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • user_id: string

      The id of the user whose profile you want to retrieve

    • Optional query: null | object

      Data that will be passed in the query string as a parameter.

    • Optional options: null | object

      Further options that can be used to modify the request.

    Returns Promise<any>

  • Removes a preference key-value pair that has been set for the user.

    See

    Accounts Remove Preference - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • user_id: string

      The id of the user.

    • key: string

      The key to remove, which will remove the entire preference.

    • Optional data: null | object

      Data that will be passed in the body of the request.

    • Optional query: null | object

      Data that will be passed in the query string as a parameter.

    • Optional options: null | object

      Further options that can be used to modify the request.

    Returns Promise<any>

  • Removes a secure preference key-value pair that has been set for the user. With a secure preference, only the current user is able to access and remove the preference.

    See

    Accounts Remove Secure Preference - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • user_id: string

      The id of the user.

    • key: string

      The key to remove, which will remove the entire preference.

    • Optional data: null | object

      Data that will be passed in the body of the request.

    • Optional query: null | object

      Data that will be passed in the query string as a parameter.

    • Optional options: null | object

      Further options that can be used to modify the request.

    Returns Promise<any>

  • Sets preference item for a user. Items are stored in a key-value pair.

    See

    Accounts Set Prefrence - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • user_id: string

      The id of the user

    • data: object

      Data that will be passed in the body of the request.

    • Optional query: null | object

      Data that will be passed in the query string as a parameter.

    • Optional options: null | object

      Further options that can be used to modify the request.

    Returns Promise<any>

  • Sets a secure preference item for a user. in which items are stored in a key-value pair. Secure preferences cannot be read by others, and only the current user is able to access this preference. Store sensitive information such as tokens in this field.

    See

    Accounts Set Secure Prefrence - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • user_id: string

      The id of the user

    • data: object

      Data that will be passed in the body of the request.

    • Optional query: null | object

      Data that will be passed in the query string as a parameter.

    • Optional options: null | object

      Further options that can be used to modify the request.

    Returns Promise<any>

  • Upate a users account based on the users auth token. Only a user is able to update thier own account.

    See

    Accounts Update Account - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • data: object

      Data that will be passed in the body of the request.

    • Optional query: null | object

      Data that will be passed in the query string as a parameter.

    • Optional options: null | object

      Further options that can be used to modify the request.

    Returns Promise<any>

Generated using TypeDoc