Skip to content

Latest commit

 

History

History
432 lines (290 loc) · 11.7 KB

File metadata and controls

432 lines (290 loc) · 11.7 KB

wallet.VideosApi

All URIs are relative to https://api.wall.et

Method HTTP request Description
archive_video DELETE /v2/video/{id} Archive Video
create_video POST /v2/video Create Video
fetch_all_video GET /v2/video/all Get all Videos
provision_video_upload POST /v2/video/upload/provision Provision a direct video upload
restore_video PATCH /v2/video/{id} Restore Video
update_video PUT /v2/video/{id} Update Video

archive_video

Video archive_video(id)

Archive Video

Example

import wallet
from wallet.models.video import Video
from wallet.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wall.et
# See configuration.py for a list of all supported configuration parameters.
configuration = wallet.Configuration(
    host = "https://api.wall.et"
)


# Enter a context with an instance of the API client
with wallet.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wallet.VideosApi(api_client)
    id = 'id_example' # str | 

    try:
        # Archive Video
        api_response = api_instance.archive_video(id)
        print("The response of VideosApi->archive_video:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VideosApi->archive_video: %s\n" % e)

Parameters

Name Type Description Notes
id str

Return type

Video

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Ok -
401 Authentication Failed -
422 Validation Failed -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_video

Video create_video(wt_video_create_params)

Create Video

Example

import wallet
from wallet.models.video import Video
from wallet.models.wt_video_create_params import WTVideoCreateParams
from wallet.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wall.et
# See configuration.py for a list of all supported configuration parameters.
configuration = wallet.Configuration(
    host = "https://api.wall.et"
)


# Enter a context with an instance of the API client
with wallet.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wallet.VideosApi(api_client)
    wt_video_create_params = wallet.WTVideoCreateParams() # WTVideoCreateParams | 

    try:
        # Create Video
        api_response = api_instance.create_video(wt_video_create_params)
        print("The response of VideosApi->create_video:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VideosApi->create_video: %s\n" % e)

Parameters

Name Type Description Notes
wt_video_create_params WTVideoCreateParams

Return type

Video

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Ok -
401 Authentication Failed -
422 Validation Failed -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fetch_all_video

object fetch_all_video(is_archive_included=is_archive_included)

Get all Videos

Example

import wallet
from wallet.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wall.et
# See configuration.py for a list of all supported configuration parameters.
configuration = wallet.Configuration(
    host = "https://api.wall.et"
)


# Enter a context with an instance of the API client
with wallet.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wallet.VideosApi(api_client)
    is_archive_included = True # bool |  (optional)

    try:
        # Get all Videos
        api_response = api_instance.fetch_all_video(is_archive_included=is_archive_included)
        print("The response of VideosApi->fetch_all_video:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VideosApi->fetch_all_video: %s\n" % e)

Parameters

Name Type Description Notes
is_archive_included bool [optional]

Return type

object

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Ok -
401 Authentication Failed -
422 Validation Failed -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

provision_video_upload

WTVideoUploadProvision provision_video_upload(wt_video_upload_provision_params)

Provision a direct video upload

Example

import wallet
from wallet.models.wt_video_upload_provision import WTVideoUploadProvision
from wallet.models.wt_video_upload_provision_params import WTVideoUploadProvisionParams
from wallet.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wall.et
# See configuration.py for a list of all supported configuration parameters.
configuration = wallet.Configuration(
    host = "https://api.wall.et"
)


# Enter a context with an instance of the API client
with wallet.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wallet.VideosApi(api_client)
    wt_video_upload_provision_params = wallet.WTVideoUploadProvisionParams() # WTVideoUploadProvisionParams | 

    try:
        # Provision a direct video upload
        api_response = api_instance.provision_video_upload(wt_video_upload_provision_params)
        print("The response of VideosApi->provision_video_upload:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VideosApi->provision_video_upload: %s\n" % e)

Parameters

Name Type Description Notes
wt_video_upload_provision_params WTVideoUploadProvisionParams

Return type

WTVideoUploadProvision

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Ok -
401 Authentication Failed -
422 Validation Failed -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

restore_video

Video restore_video(id)

Restore Video

Example

import wallet
from wallet.models.video import Video
from wallet.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wall.et
# See configuration.py for a list of all supported configuration parameters.
configuration = wallet.Configuration(
    host = "https://api.wall.et"
)


# Enter a context with an instance of the API client
with wallet.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wallet.VideosApi(api_client)
    id = 'id_example' # str | 

    try:
        # Restore Video
        api_response = api_instance.restore_video(id)
        print("The response of VideosApi->restore_video:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VideosApi->restore_video: %s\n" % e)

Parameters

Name Type Description Notes
id str

Return type

Video

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Ok -
401 Authentication Failed -
422 Validation Failed -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_video

Video update_video(id, wt_video_update_params)

Update Video

Example

import wallet
from wallet.models.video import Video
from wallet.models.wt_video_update_params import WTVideoUpdateParams
from wallet.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wall.et
# See configuration.py for a list of all supported configuration parameters.
configuration = wallet.Configuration(
    host = "https://api.wall.et"
)


# Enter a context with an instance of the API client
with wallet.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wallet.VideosApi(api_client)
    id = 'id_example' # str | 
    wt_video_update_params = wallet.WTVideoUpdateParams() # WTVideoUpdateParams | 

    try:
        # Update Video
        api_response = api_instance.update_video(id, wt_video_update_params)
        print("The response of VideosApi->update_video:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VideosApi->update_video: %s\n" % e)

Parameters

Name Type Description Notes
id str
wt_video_update_params WTVideoUpdateParams

Return type

Video

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Ok -
401 Authentication Failed -
422 Validation Failed -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]