bitmovin_api_sdk.notifications package

Subpackages

Submodules

bitmovin_api_sdk.notifications.notification_list_query_params module

class bitmovin_api_sdk.notifications.notification_list_query_params.NotificationListQueryParams(offset: Optional[int] = None, limit: Optional[int] = None)[source]

Bases: object

property attribute_map

property openapi_types

bitmovin_api_sdk.notifications.notification_state_entry_list_by_notification_id_query_params module

class bitmovin_api_sdk.notifications.notification_state_entry_list_by_notification_id_query_params.NotificationStateEntryListByNotificationIdQueryParams(offset: Optional[int] = None, limit: Optional[int] = None)[source]

Bases: object

property attribute_map

property openapi_types

bitmovin_api_sdk.notifications.notifications_api module

class bitmovin_api_sdk.notifications.notifications_api.NotificationsApi(**kwargs)[source]

Bases: BaseApi

delete(notification_id: string_types, **kwargs: dict) → BitmovinResponse[source]

Delete Notification

Parameters: notification_id (string_types, required) – Id of the notification
Returns: Id of the notification
Return type: BitmovinResponse

get(notification_id: string_types, **kwargs: dict) → Notification[source]

Get Notification

Parameters: notification_id (string_types, required) – Id of the notification
Returns: Webhook Details
Return type: Notification

list(query_params: Optional[NotificationListQueryParams] = None, **kwargs: dict) → Notification[source]

List Notifications

Parameters: query_params (NotificationListQueryParams) – Query parameters
Returns: List of Notifications
Return type: Notification

list_by_notification_id(notification_id: string_types, query_params: NotificationStateEntryListByNotificationIdQueryParams = None, **kwargs: dict) → NotificationStateEntry[source]

List Notification State History (All Resources)

Parameters

notification_id (string_types, required) – Id of the notification
query_params (NotificationStateEntryListByNotificationIdQueryParams) – Query parameters

Returns

List of state entries

Return type

NotificationStateEntry

mute(notification_id: string_types, **kwargs: dict) → BitmovinResponse[source]

Mute Notification

Parameters: notification_id (string_types, required) – Id of the notification
Returns: Id of the notification
Return type: BitmovinResponse

unmute(notification_id: string_types, **kwargs: dict) → BitmovinResponse[source]

Unmute Notification

Parameters: notification_id (string_types, required) – Id of the notification
Returns: Id of the notification
Return type: BitmovinResponse