Class Organizers

Hierarchy

  • Organizers

Constructors

constructor

Properties

routeCancelSubscription routeCreateOrganizer routeCreateSubscription routeCurrentSubscription routeDeleterOrganizer routeGetSubscriptions routeListOrganizers routeRemoveUserFromRoleWithOganizer routeSetUserToRoleWithOganizer routeSingleSubscription routeUpdateOrganizer routeViewOrganizer

Methods

cancelSubscription createOrganizer createSubscription deleteOrganizer getCurrentSubscription getOrganizers getSubscriptions removeUserFromRole setUserToRole updateOrganizer viewOrganizer viewSubscription

Constructors

constructor

Properties

Static Private routeCancelSubscription

routeCancelSubscription: Route = ...

Static Private routeCreateOrganizer

routeCreateOrganizer: Route = ...

Static Private routeCreateSubscription

routeCreateSubscription: Route = ...

Static Private routeCurrentSubscription

routeCurrentSubscription: Route = ...

Static Private routeDeleterOrganizer

routeDeleterOrganizer: Route = ...

Static Private routeGetSubscriptions

routeGetSubscriptions: Route = ...

Static Private routeListOrganizers

routeListOrganizers: Route = ...

Static Private routeRemoveUserFromRoleWithOganizer

routeRemoveUserFromRoleWithOganizer: Route = ...

Static Private routeSetUserToRoleWithOganizer

routeSetUserToRoleWithOganizer: Route = ...

Static Private routeSingleSubscription

routeSingleSubscription: Route = ...

Static Private routeUpdateOrganizer

routeUpdateOrganizer: Route = ...

Static Private routeViewOrganizer

routeViewOrganizer: Route = ...

Methods

Static cancelSubscription

  • Cancles subscription.

    Todo

    Needs documentation.

    Returns

    Returns a promise from Axios.

    Parameters

    • organizer_id: string

      The id of the organizer account.

    • 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>

Static createOrganizer

  • Creates an organizer account.

    See

    Organizers Create - 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>

Static createSubscription

  • Creates subscription for organizer account.

    Todo

    Needs documentation.

    Returns

    Returns a promise from Axios.

    Parameters

    • organizer_id: string

      The id of the organizer account.

    • 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>

Static deleteOrganizer

  • Deletes organizer account.

    Todo

    Needs documentation.

    Returns

    Returns a promise from Axios.

    Parameters

    • organizer_id: string

      The id of the organizer account.

    • 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>

Static getCurrentSubscription

  • Retrieves the information pertaining to current subscription.

    Todo

    Needs documentation.

    Returns

    Returns a promise from Axios.

    Parameters

    • organizer_id: string

      The id of the organizer account.

    • 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>

Static getOrganizers

  • Show a list organizer associated with the current JSON Web Token.

    See

    Organizers 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>

Static getSubscriptions

  • Retrieves subscription information from organizer account.

    Todo

    Needs documentation.

    Returns

    Returns a promise from Axios.

    Parameters

    • organizer_id: string

      The id of the organizer account.

    • 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>

Static removeUserFromRole

  • Removes an account from a role for the current organizer account.

    See

    Organizers Remove Account From Role - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • organizer_id: string

      The id of the organizer account.

    • 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>

Static setUserToRole

  • Set a user's role for how much access they will have on the platform.

    See

    Organizers Set Role - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • organizer_id: string

      The id of the organizer account.

    • 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>

Static updateOrganizer

  • Update the information to an organizer account.

    See

    Organizers Update Organizer - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • organizer_id: string

      The id of the organizer account.

    • 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>

Static viewOrganizer

  • View the information pertaining to a single organizer account.

    See

    Organizers View Organizer - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • organizer_id: string

      The id of the organizer account.

    • 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>

Static viewSubscription

  • View the information pertaining to subscription.

    Todo

    Needs documentation.

    Returns

    Returns a promise from Axios.

    Parameters

    • organizer_id: string

      The id of the organizer account.

    • subscription_id: string

      The id of subscription.

    • 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>

Settings

Member Visibility

Theme

Generated using TypeDoc