Function NotificationsApiFactory

NotificationsApi - factory interface export

  • NotificationsApiFactory(configuration?, basePath?, axios?): {
        apiNotificationsBulkPut(notificationsBulkUpdateDeets?: NotificationsBulkUpdateDeets, options?: RawAxiosRequestConfig): AxiosPromise<number>;
        apiNotificationsCountGet(markAsRead?: boolean, limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<NotificationAggregate>;
        apiNotificationsGet(markAsRead?: boolean, limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<NotificationResponse[]>;
        apiNotificationsIdDelete(id: string, options?: RawAxiosRequestConfig): AxiosPromise<number>;
        apiNotificationsIdPut(id: string, notificationsUpdateDeets?: NotificationsUpdateDeets, options?: RawAxiosRequestConfig): AxiosPromise<number>;
        apiNotificationsNotificationNegotiatePost(options?: RawAxiosRequestConfig): AxiosPromise<void>;
    }

  • Parameters

    • Optionalconfiguration: Configuration
    • OptionalbasePath: string
    • Optionalaxios: AxiosInstance

    Returns {
        apiNotificationsBulkPut(notificationsBulkUpdateDeets?: NotificationsBulkUpdateDeets, options?: RawAxiosRequestConfig): AxiosPromise<number>;
        apiNotificationsCountGet(markAsRead?: boolean, limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<NotificationAggregate>;
        apiNotificationsGet(markAsRead?: boolean, limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<NotificationResponse[]>;
        apiNotificationsIdDelete(id: string, options?: RawAxiosRequestConfig): AxiosPromise<number>;
        apiNotificationsIdPut(id: string, notificationsUpdateDeets?: NotificationsUpdateDeets, options?: RawAxiosRequestConfig): AxiosPromise<number>;
        apiNotificationsNotificationNegotiatePost(options?: RawAxiosRequestConfig): AxiosPromise<void>;
    }

    • apiNotificationsBulkPut:function
      • apiNotificationsBulkPut(notificationsBulkUpdateDeets?, options?): AxiosPromise<number>

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

        Parameters

        Returns AxiosPromise<number>

        Throws

    • apiNotificationsCountGet:function
      • apiNotificationsCountGet(markAsRead?, limit?, page?, userId?, options?): AxiosPromise<NotificationAggregate>

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

        Throws

    • apiNotificationsGet:function
      • apiNotificationsGet(markAsRead?, limit?, page?, userId?, options?): AxiosPromise<NotificationResponse[]>

      • 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 AxiosPromise<NotificationResponse[]>

        Throws

    • apiNotificationsIdDelete:function
      • apiNotificationsIdDelete(id, options?): AxiosPromise<number>

      • summary Deletes a Notification

        Parameters

        • id: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<number>

        Throws

    • apiNotificationsIdPut:function
      • apiNotificationsIdPut(id, notificationsUpdateDeets?, options?): AxiosPromise<number>

      • summary Update a Notification (mark as read)

        Parameters

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

          Override http request option.

        Returns AxiosPromise<number>

        Throws

    • apiNotificationsNotificationNegotiatePost:function
      • apiNotificationsNotificationNegotiatePost(options?): AxiosPromise<void>

      • Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<void>

        Throws

Settings

Member Visibility