Package video.api.client.api.clients

Class WebhooksApi

java.lang.Object
video.api.client.api.clients.WebhooksApi
public class WebhooksApi
extends java.lang.Object

  • Nested Class Summary

    Nested Classes
    Modifier and Type Class Description
    class  WebhooksApi.APIlistRequest  

  • Constructor Summary

    Constructors
    Constructor Description
    WebhooksApi​(ApiClient apiClient)  

  • Method Summary

    Modifier and Type Method Description
    Webhook create​(WebhooksCreatePayload webhooksCreatePayload)
    Create Webhook Webhooks can push notifications to your server, rather than polling api.video for changes.
    ApiResponse<Webhook> createWithHttpInfo​(WebhooksCreatePayload webhooksCreatePayload)
    Create Webhook Webhooks can push notifications to your server, rather than polling api.video for changes.
    void delete​(java.lang.String webhookId)
    Delete a Webhook This endpoint will delete the indicated webhook.
    ApiResponse<java.lang.Void> deleteWithHttpInfo​(java.lang.String webhookId)
    Delete a Webhook This endpoint will delete the indicated webhook.
    Webhook get​(java.lang.String webhookId)
    Show Webhook details This call provides the same JSON information provided on Webjhook creation.
    ApiClient getApiClient()  
    ApiResponse<Webhook> getWithHttpInfo​(java.lang.String webhookId)
    Show Webhook details This call provides the same JSON information provided on Webjhook creation.
    WebhooksApi.APIlistRequest list()
    List all webhooks Requests to this endpoint return a list of your webhooks (with all their details).
    void setApiClient​(ApiClient apiClient)  

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • WebhooksApi

      public WebhooksApi​(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient​(ApiClient apiClient)

    • delete

      public void delete​(java.lang.String webhookId) throws ApiException
      Delete a Webhook This endpoint will delete the indicated webhook.
      Parameters:
      webhookId - The webhook you wish to delete. (required)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      204 No Content -
      404 Not Found -

    • deleteWithHttpInfo

      public ApiResponse<java.lang.Void> deleteWithHttpInfo​(java.lang.String webhookId) throws ApiException
      Delete a Webhook This endpoint will delete the indicated webhook.
      Parameters:
      webhookId - The webhook you wish to delete. (required)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      204 No Content -
      404 Not Found -

    • get

      public Webhook get​(java.lang.String webhookId) throws ApiException
      Show Webhook details This call provides the same JSON information provided on Webjhook creation.
      Parameters:
      webhookId - The unique webhook you wish to retreive details on. (required)
      Returns:
      Webhook
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 Success -

    • getWithHttpInfo

      public ApiResponse<Webhook> getWithHttpInfo​(java.lang.String webhookId) throws ApiException
      Show Webhook details This call provides the same JSON information provided on Webjhook creation.
      Parameters:
      webhookId - The unique webhook you wish to retreive details on. (required)
      Returns:
      ApiResponse<Webhook>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 Success -

    • list

      public WebhooksApi.APIlistRequest list()
      List all webhooks Requests to this endpoint return a list of your webhooks (with all their details). You can filter what the webhook list that the API returns using the parameters described below.
      Returns:
      APIlistRequest
      Http Response Details:
      Status Code Description Response Headers
      200 Success -

    • create

      public Webhook create​(WebhooksCreatePayload webhooksCreatePayload) throws ApiException
      Create Webhook Webhooks can push notifications to your server, rather than polling api.video for changes. We currently offer one event, the ```video.encoding.quality.completed``` event. When a new video is uploaded into your account, it will be encoded into several different HLS sizes/bitrates. When each version is encoded, your webhook will get a notification. It will look like ```{ \\\"type\\\": \\\"video.encoding.quality.completed\\\", \\\"emittedAt\\\": \\\"2021-01-29T16:46:25.217+01:00\\\", \\\"videoId\\\": \\\"viXXXXXXXX\\\", \\\"encoding\\\": \\\"hls\\\", \\\"quality\\\": \\\"720p\\\"} ```. This request says that the 720p HLS encoding was completed.
      Parameters:
      webhooksCreatePayload - (required)
      Returns:
      Webhook
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      201 Created -
      400 Bad Request -

    • createWithHttpInfo

      public ApiResponse<Webhook> createWithHttpInfo​(WebhooksCreatePayload webhooksCreatePayload) throws ApiException
      Create Webhook Webhooks can push notifications to your server, rather than polling api.video for changes. We currently offer one event, the ```video.encoding.quality.completed``` event. When a new video is uploaded into your account, it will be encoded into several different HLS sizes/bitrates. When each version is encoded, your webhook will get a notification. It will look like ```{ \\\"type\\\": \\\"video.encoding.quality.completed\\\", \\\"emittedAt\\\": \\\"2021-01-29T16:46:25.217+01:00\\\", \\\"videoId\\\": \\\"viXXXXXXXX\\\", \\\"encoding\\\": \\\"hls\\\", \\\"quality\\\": \\\"720p\\\"} ```. This request says that the 720p HLS encoding was completed.
      Parameters:
      webhooksCreatePayload - (required)
      Returns:
      ApiResponse<Webhook>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      201 Created -
      400 Bad Request -