Class NotificationsApi

NotificationsApi - object-oriented interface export NotificationsApi

Hierarchy (view full)

Constructors

constructor

Properties

axios basePath configuration

Methods

apiNotificationsBulkPut apiNotificationsCountGet apiNotificationsGet apiNotificationsIdDelete apiNotificationsIdPut apiNotificationsNotificationNegotiatePost

Constructors

constructor

Properties

Protectedaxios

axios: AxiosInstance = globalAxios

ProtectedbasePath

basePath: string = BASE_PATH

Protectedconfiguration

configuration: undefined | Configuration

Methods

apiNotificationsBulkPut

  • apiNotificationsBulkPut(notificationsBulkUpdateDeets?, options?): Promise<AxiosResponse<number, any>>

  • summary Update one or many Notifications (mark as read)

    Parameters

    Returns Promise<AxiosResponse<number, any>>

    Throws

    memberof NotificationsApi

apiNotificationsCountGet

  • apiNotificationsCountGet(markAsRead?, limit?, page?, userId?, options?): Promise<AxiosResponse<NotificationAggregate, any>>

  • summary Retrieve notifications counts

    Parameters

    • OptionalmarkAsRead: boolean
    • Optionallimit: number

      A limit of the number of objects to be returned for the next page, between 1 and 100. The default is 25

    • Optionalpage: number

      1-based page index for paginated results

    • OptionaluserId: string

      The user id to operate on their behalf (tenants only)

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<NotificationAggregate, any>>

    Throws

    memberof NotificationsApi

apiNotificationsGet

  • apiNotificationsGet(markAsRead?, limit?, page?, userId?, options?): Promise<AxiosResponse<NotificationResponse[], any>>

  • Notifications are brief dated messages. A Notification may be marked read or deleted

    summary Retrieve a list of Notifications

    Parameters

    • OptionalmarkAsRead: boolean
    • Optionallimit: number

      A limit of the number of objects to be returned for the next page, between 1 and 100. The default is 25

    • Optionalpage: number

      1-based page index for paginated results

    • OptionaluserId: string

      The user id to operate on their behalf (tenants only)

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<NotificationResponse[], any>>

    Throws

    memberof NotificationsApi

apiNotificationsIdDelete

  • apiNotificationsIdDelete(id, options?): Promise<AxiosResponse<number, any>>

  • summary Deletes a Notification

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<number, any>>

    Throws

    memberof NotificationsApi

apiNotificationsIdPut

  • apiNotificationsIdPut(id, notificationsUpdateDeets?, options?): Promise<AxiosResponse<number, any>>

  • summary Update a Notification (mark as read)

    Parameters

    • id: string
    • OptionalnotificationsUpdateDeets: NotificationsUpdateDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<number, any>>

    Throws

    memberof NotificationsApi

apiNotificationsNotificationNegotiatePost

  • apiNotificationsNotificationNegotiatePost(options?): Promise<AxiosResponse<void, any>>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<void, any>>

    Throws

    memberof NotificationsApi

Settings

Member Visibility

On This Page

Constructors
Properties
Methods