42videobricks-python-client 1.1.2

Official Pyhton client library for 42videobricks API

42videobricks-python-client

Official Pyhton client library for 42videobricks API.

42videobricks is a Video Platform As A Service (VPaaS)

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.1
• Package version: 1.1.2
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/42videobricks/42videobricks-python-client.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/42videobricks/42videobricks-python-client.git)

Then import the package:

import Api42Vb

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import Api42Vb

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import time
import Api42Vb
from Api42Vb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api-sbx.42videobricks.com
# See configuration.py for a list of all supported configuration parameters.
configuration = Api42Vb.Configuration(
    host = "https://api-sbx.42videobricks.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: api_key
configuration.api_key['api_key'] = "YOUR API KEY"

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'


# Enter a context with an instance of the API client
with Api42Vb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = Api42Vb.DataApi(api_client)
    limit = 10 # int | Number of elements to return (default=10) (optional)
    offset = 0 # int | offset for pagination (optional)

    try:
        # List Video Usage KPIs
        api_response = api_instance.get_data_video_usage(limit=limit, offset=offset)
        print("The response of DataApi->get_data_video_usage:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DataApi->get_data_video_usage: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api-sbx.42videobricks.com

Class	Method	HTTP request	Description
DataApi	get_data_video_usage	GET /data/videos/usage	List Video Usage KPIs
TagsApi	get_tags	GET /tags	List Video Tags
VideosApi	add_attachment_by_video_id	POST /videos/{videoId}/attachments/{attachmentType}/{locale}	Upload an attachement
VideosApi	add_thumbnail_by_video_id	POST /videos/{videoId}/thumbnail	Upload a thumbnail
VideosApi	add_video	POST /videos	Add a new video
VideosApi	delete_attachment_by_video_id	DELETE /videos/{videoId}/attachments/{attachmentType}/{locale}	Delete an attachment
VideosApi	delete_thumbnail_by_video_id	DELETE /videos/{videoId}/thumbnail	Delete a thumbnail
VideosApi	delete_video_by_id	DELETE /videos/{videoId}	Delete a video
VideosApi	finalize_multipart_upload_video_by_id	POST /videos/{videoId}/multipart-upload/finalize	Multipart upload finalization
VideosApi	finalize_upload_video_by_id	PUT /videos/{videoId}/upload/finalize	Single file upload finalization
VideosApi	get_attachment_by_video_id	GET /videos/{videoId}/attachments/{attachmentType}/{locale}	Get the attachment
VideosApi	get_attachment_file_by_video_id	GET /videos/{videoId}/attachments/{attachmentType}/{locale}/file	Get attachement file
VideosApi	get_attachments_by_video_id	GET /videos/{videoId}/attachments	List of attachments
VideosApi	get_video_by_id	GET /videos/{videoId}	Retun a single video
VideosApi	get_videos	GET /videos	List videos
VideosApi	init_multipart_upload_video_by_id	POST /videos/{videoId}/multipart-upload/init	Multipart upload intialization
VideosApi	init_upload_video_by_id	GET /videos/{videoId}/upload/init	Single file upload intialization
VideosApi	update_video_by_id	PUT /videos/{videoId}	Update an existing video
WebhooksApi	add_webhook	POST /webhooks	Add a new webhook
WebhooksApi	delete_webhook_by_id	DELETE /webhooks/{webhookId}	Delete a webhook
WebhooksApi	get_webhook_by_id	GET /webhooks/{webhookId}	Retun a single webhook
WebhooksApi	get_webhooks	GET /webhooks	List webhooks
WebhooksApi	update_webhook_by_id	PUT /webhooks/{webhookId}	Update an existing webhook

Documentation For Models

• DataVideoUsage
• DataVideoUsageList
• Error
• Pagination
• TagList
• Video
• VideoAssets
• VideoAttachment
• VideoAttachmentList
• VideoList
• VideoMultipartUploadFinalize
• VideoMultipartUploadFinalizePartsInner
• VideoMultipartUploadInit
• VideoMultipartUploadInitResponse
• VideoMultipartUploadInitResponsePartsInner
• VideoProperties
• VideoUploadInitResponse
• Webhook
• WebhookList
• WebhookProperties

Documentation For Authorization

Authentication schemes defined for the API:

api_key

• Type: API key
• API key parameter name: x-api-key
• Location: HTTP header

Author