bitmovin_api_sdk.notifications package

Subpackages

• bitmovin_api_sdk.notifications.emails package
  • Subpackages
    • bitmovin_api_sdk.notifications.emails.encoding package
      • Subpackages
      • Submodules
      • bitmovin_api_sdk.notifications.emails.encoding.email_notification_list_query_params module
      • bitmovin_api_sdk.notifications.emails.encoding.encoding_api module
      • Module contents
    • bitmovin_api_sdk.notifications.emails.usage_reports package
      • Submodules
      • bitmovin_api_sdk.notifications.emails.usage_reports.email_notification_list_query_params module
      • bitmovin_api_sdk.notifications.emails.usage_reports.usage_reports_api module
      • Module contents
  • Submodules
  • bitmovin_api_sdk.notifications.emails.emails_api module
    • EmailsApi
      • EmailsApi.list()
  • bitmovin_api_sdk.notifications.emails.notification_list_query_params module
    • NotificationListQueryParams
      • NotificationListQueryParams.attribute_map
      • NotificationListQueryParams.openapi_types
  • Module contents
• bitmovin_api_sdk.notifications.states package
  • Submodules
  • bitmovin_api_sdk.notifications.states.notification_state_entry_list_query_params module
    • NotificationStateEntryListQueryParams
      • NotificationStateEntryListQueryParams.attribute_map
      • NotificationStateEntryListQueryParams.openapi_types
  • bitmovin_api_sdk.notifications.states.states_api module
    • StatesApi
      • StatesApi.list()
  • Module contents
• bitmovin_api_sdk.notifications.webhooks package
  • Subpackages
    • bitmovin_api_sdk.notifications.webhooks.encoding package
      • Subpackages
      • Submodules
      • bitmovin_api_sdk.notifications.webhooks.encoding.encoding_api module
      • Module contents
  • Submodules
  • bitmovin_api_sdk.notifications.webhooks.webhooks_api module
    • WebhooksApi
  • Module contents

Submodules

bitmovin_api_sdk.notifications.notification_list_query_params module

class bitmovin_api_sdk.notifications.notification_list_query_params.NotificationListQueryParams(offset=None, limit=None)

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=None, limit=None)

Bases: object

property attribute_map

property openapi_types

bitmovin_api_sdk.notifications.notifications_api module

class bitmovin_api_sdk.notifications.notifications_api.NotificationsApi(**kwargs)

Bases: BaseApi

delete(notification_id, **kwargs)

Delete Notification

Parameters:

notification_id (string_types, required) – Id of the notification

Returns:

Id of the notification

Return type:

BitmovinResponse

get(notification_id, **kwargs)

Get Notification

Parameters:

notification_id (string_types, required) – Id of the notification

Returns:

Webhook Details

Return type:

Notification

list(query_params=None, **kwargs)

List Notifications

Parameters:

query_params (NotificationListQueryParams) – Query parameters

Returns:

List of Notifications

Return type:

Notification

list_by_notification_id(notification_id, query_params=None, **kwargs)

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, **kwargs)

Mute Notification

Parameters:

notification_id (string_types, required) – Id of the notification

Returns:

Id of the notification

Return type:

BitmovinResponse

unmute(notification_id, **kwargs)

Unmute Notification

Parameters:

notification_id (string_types, required) – Id of the notification

Returns:

Id of the notification

Return type:

BitmovinResponse

Module contents