Class NotificationApi

NotificationApi - object-oriented interface

export

Hierarchy

BaseAPI
- NotificationApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new NotificationApi(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): NotificationApi

Inherited from BaseAPI.constructor
- Defined in base.ts:52
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns NotificationApi

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: Configuration

Methods

notifyGetList

notifyGetList(requestParameters?: NotificationApiNotifyGetListRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<NotificationThread[]>>

- Defined in apis/notification-api.ts:1022
summary
List users's notification threads

throws
{RequiredError}

memberof
NotificationApi

Parameters
- requestParameters: NotificationApiNotifyGetListRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<NotificationThread[]>>

notifyGetRepoList

notifyGetRepoList(requestParameters: NotificationApiNotifyGetRepoListRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<NotificationThread[]>>

- Defined in apis/notification-api.ts:1034
summary
List users's notification threads on a specific repo

throws
{RequiredError}

memberof
NotificationApi

Parameters
- requestParameters: NotificationApiNotifyGetRepoListRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<NotificationThread[]>>

notifyGetThread

notifyGetThread(requestParameters: NotificationApiNotifyGetThreadRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<NotificationThread>>

- Defined in apis/notification-api.ts:1046
summary
Get notification thread by ID

throws
{RequiredError}

memberof
NotificationApi

Parameters
- requestParameters: NotificationApiNotifyGetThreadRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<NotificationThread>>

notifyNewAvailable

notifyNewAvailable(options?: AxiosRequestConfig): Promise<AxiosResponse<NotificationCount>>

- Defined in apis/notification-api.ts:1057
summary
Check if unread notifications exist

throws
{RequiredError}

memberof
NotificationApi

Parameters
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<NotificationCount>>

notifyReadList

notifyReadList(requestParameters?: NotificationApiNotifyReadListRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<NotificationThread[]>>

- Defined in apis/notification-api.ts:1069
summary
Mark notification threads as read, pinned or unread

throws
{RequiredError}

memberof
NotificationApi

Parameters
- requestParameters: NotificationApiNotifyReadListRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<NotificationThread[]>>

notifyReadRepoList

notifyReadRepoList(requestParameters: NotificationApiNotifyReadRepoListRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<NotificationThread[]>>

- Defined in apis/notification-api.ts:1081
summary
Mark notification threads as read, pinned or unread on a specific repo

throws
{RequiredError}

memberof
NotificationApi

Parameters
- requestParameters: NotificationApiNotifyReadRepoListRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<NotificationThread[]>>

notifyReadThread

notifyReadThread(requestParameters: NotificationApiNotifyReadThreadRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<NotificationThread>>

- Defined in apis/notification-api.ts:1093
summary
Mark notification thread as read by ID

throws
{RequiredError}

memberof
NotificationApi

Parameters
- requestParameters: NotificationApiNotifyReadThreadRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<NotificationThread>>

Generated using TypeDoc