Class NotificationsApi

Hierarchy

BaseAPI
- NotificationsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new NotificationsApi(configuration: Configuration): NotificationsApi

Overrides BaseAPI.constructor
- Defined in notifications/NotificationsApi.ts:23
Parameters
- configuration: Configuration
Returns NotificationsApi

Properties

emails

emails: EmailsApi

Protected restClient

restClient: RestClient

states

states: StatesApi

webhooks

webhooks: WebhooksApi

Methods

delete

delete(notificationId: string): Promise<BitmovinResponse>

- Defined in notifications/NotificationsApi.ts:38
Parameters
- notificationId: string
Returns Promise<BitmovinResponse>

get

get(notificationId: string): Promise<Notification>

- Defined in notifications/NotificationsApi.ts:53
Parameters
- notificationId: string
Returns Promise<Notification>

list

list(queryParameters: NotificationListQueryParams | function): Promise<PaginationResponse<Notification>>

- Defined in notifications/NotificationsApi.ts:68
Parameters
- Optional queryParameters: NotificationListQueryParams | function
Returns Promise<PaginationResponse<Notification>>

listByNotificationId

listByNotificationId(notificationId: string, queryParameters: NotificationStateEntryListByNotificationIdQueryParams | function): Promise<PaginationResponse<NotificationStateEntry>>

- Defined in notifications/NotificationsApi.ts:87
Parameters
- notificationId: string
- Optional queryParameters: NotificationStateEntryListByNotificationIdQueryParams | function
Returns Promise<PaginationResponse<NotificationStateEntry>>

mute

mute(notificationId: string): Promise<BitmovinResponse>

- Defined in notifications/NotificationsApi.ts:108
Parameters
- notificationId: string
Returns Promise<BitmovinResponse>

unmute

unmute(notificationId: string): Promise<BitmovinResponse>

- Defined in notifications/NotificationsApi.ts:123
Parameters
- notificationId: string
Returns Promise<BitmovinResponse>

Generated using TypeDoc