Class FinishedApi

Hierarchy

BaseAPI
BaseAPI
- FinishedApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new FinishedApi(configuration: Configuration): FinishedApi

Overrides BaseAPI.constructor
- Defined in notifications/webhooks/encoding/encodings/finished/FinishedApi.ts:18
Parameters
- configuration: Configuration
Returns FinishedApi

Properties

customdata

customdata: CustomdataApi

Protected restClient

restClient: RestClient

Methods

create

create(webhook: Webhook): Promise<Webhook>

- Defined in notifications/webhooks/encoding/encodings/finished/FinishedApi.ts:31
Parameters
- Optional webhook: Webhook
Returns Promise<Webhook>

createByEncodingId

createByEncodingId(encodingId: string, webhook: Webhook): Promise<Webhook>

- Defined in notifications/webhooks/encoding/encodings/finished/FinishedApi.ts:44
Parameters
- encodingId: string
- Optional webhook: Webhook
Returns Promise<Webhook>

createByManifestId

createByManifestId(manifestId: string, webhook: Webhook): Promise<Webhook>

- Defined in notifications/webhooks/encoding/manifest/finished/FinishedApi.ts:38
Parameters
- manifestId: string
- Optional webhook: Webhook
Returns Promise<Webhook>

delete

delete(notificationId: string): Promise<BitmovinResponse>

- Defined in notifications/webhooks/encoding/manifest/finished/FinishedApi.ts:53
Parameters
- notificationId: string
Returns Promise<BitmovinResponse>

deleteByEncodingIdAndWebhookId

deleteByEncodingIdAndWebhookId(encodingId: string, webhookId: string): Promise<BitmovinResponse>

- Defined in notifications/webhooks/encoding/encodings/finished/FinishedApi.ts:60
Parameters
- encodingId: string
- webhookId: string
Returns Promise<BitmovinResponse>

deleteByWebhookId

deleteByWebhookId(webhookId: string): Promise<BitmovinResponse>

- Defined in notifications/webhooks/encoding/encodings/finished/FinishedApi.ts:76
Parameters
- webhookId: string
Returns Promise<BitmovinResponse>

getByEncodingIdAndWebhookId

getByEncodingIdAndWebhookId(encodingId: string, webhookId: string): Promise<Webhook>

- Defined in notifications/webhooks/encoding/encodings/finished/FinishedApi.ts:92
Parameters
- encodingId: string
- webhookId: string
Returns Promise<Webhook>

getByWebhookId

getByWebhookId(webhookId: string): Promise<Webhook>

- Defined in notifications/webhooks/encoding/encodings/finished/FinishedApi.ts:108
Parameters
- webhookId: string
Returns Promise<Webhook>

list

list(queryParameters: WebhookListQueryParams | function): Promise<PaginationResponse<Webhook>>

- Defined in notifications/webhooks/encoding/encodings/finished/FinishedApi.ts:123
Parameters
- Optional queryParameters: WebhookListQueryParams | function
Returns Promise<PaginationResponse<Webhook>>

listByEncodingId

listByEncodingId(encodingId: string, queryParameters: WebhookListByEncodingIdQueryParams | function): Promise<PaginationResponse<Webhook>>

- Defined in notifications/webhooks/encoding/encodings/finished/FinishedApi.ts:142
Parameters
- encodingId: string
- Optional queryParameters: WebhookListByEncodingIdQueryParams | function
Returns Promise<PaginationResponse<Webhook>>

update

update(notificationId: string, webhook: Webhook): Promise<Webhook>

- Defined in notifications/webhooks/encoding/manifest/finished/FinishedApi.ts:69
Parameters
- notificationId: string
- Optional webhook: Webhook
Returns Promise<Webhook>

Generated using TypeDoc