telestream_cloud_qc 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c044286b34bcbcef33adfecdf11fe6d7cd281e3d
+  data.tar.gz: be863724c59f4df580a769964941a57ca1bf4670
+SHA512:
+  metadata.gz: 549949bdd03950358abaf3b710bd82845bbdd607f3883b1b42e198ac368c0a7451c1d57392eee185b38e41381c5243c5c544d373a58bff53d78b5da70299c412
+  data.tar.gz: 2a78a10f98b5d2b3db13a90066a63feaeccc47c54ad6ae59517b4bf888dfc5fbf187ab8d7484d5555c58dc0006597de44b43183824fb50b23bb1c5bad4361cb7

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+end

data/README.md

@@ -0,0 +1,58 @@
+# Telestream Cloud Quality Control Ruby SDK
+
+This library provides a low-level interface to the REST API of Telestream Cloud, the online video encoding service.
+
+## Getting Started
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.cloud.telestream.net/qc/v1.0*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*TelestreamCloud::Qc::QcApi* | [**cancel_job**](docs/QcApi.md#cancel_job) | **PUT** /projects/{project_id}/jobs/{job_id}/cancel.json | 
+*TelestreamCloud::Qc::QcApi* | [**create_job**](docs/QcApi.md#create_job) | **POST** /projects/{project_id}/jobs.json | Create a new job
+*TelestreamCloud::Qc::QcApi* | [**create_project**](docs/QcApi.md#create_project) | **POST** /projects.json | Create a new project
+*TelestreamCloud::Qc::QcApi* | [**get_job**](docs/QcApi.md#get_job) | **GET** /projects/{project_id}/jobs/{job_id}.json | Get QC job
+*TelestreamCloud::Qc::QcApi* | [**get_project**](docs/QcApi.md#get_project) | **GET** /projects/{project_id}.json | Get project by Id
+*TelestreamCloud::Qc::QcApi* | [**list_jobs**](docs/QcApi.md#list_jobs) | **GET** /projects/{project_id}/jobs.json | Get jobs form projects
+*TelestreamCloud::Qc::QcApi* | [**list_projects**](docs/QcApi.md#list_projects) | **GET** /projects.json | List all projects for an account
+*TelestreamCloud::Qc::QcApi* | [**modify_project**](docs/QcApi.md#modify_project) | **PUT** /projects/{project_id}.json | Modify project
+*TelestreamCloud::Qc::QcApi* | [**proxy**](docs/QcApi.md#proxy) | **GET** /projects/{project_id}/jobs/{job_id}/proxy.json | 
+*TelestreamCloud::Qc::QcApi* | [**remove_job**](docs/QcApi.md#remove_job) | **DELETE** /projects/{project_id}/jobs/{job_id}.json | 
+*TelestreamCloud::Qc::QcApi* | [**remove_project**](docs/QcApi.md#remove_project) | **DELETE** /projects/{project_id}.json | 
+*TelestreamCloud::Qc::QcApi* | [**signed_urls**](docs/QcApi.md#signed_urls) | **GET** /projects/{project_id}/jobs/{job_id}/signed-urls.json | 
+*TelestreamCloud::Qc::QcApi* | [**upload_video**](docs/QcApi.md#upload_video) | **POST** /projects/{project_id}/upload.json | Creates an upload session
+
+
+## Documentation for Models
+
+ - [TelestreamCloud::Qc::Alert](docs/Alert.md)
+ - [TelestreamCloud::Qc::AudioStream](docs/AudioStream.md)
+ - [TelestreamCloud::Qc::Container](docs/Container.md)
+ - [TelestreamCloud::Qc::Data](docs/Data.md)
+ - [TelestreamCloud::Qc::Data1](docs/Data1.md)
+ - [TelestreamCloud::Qc::ExtraFile](docs/ExtraFile.md)
+ - [TelestreamCloud::Qc::Job](docs/Job.md)
+ - [TelestreamCloud::Qc::JobData](docs/JobData.md)
+ - [TelestreamCloud::Qc::JobDetails](docs/JobDetails.md)
+ - [TelestreamCloud::Qc::JobDetailsResult](docs/JobDetailsResult.md)
+ - [TelestreamCloud::Qc::JobsCollection](docs/JobsCollection.md)
+ - [TelestreamCloud::Qc::Media](docs/Media.md)
+ - [TelestreamCloud::Qc::Options](docs/Options.md)
+ - [TelestreamCloud::Qc::Project](docs/Project.md)
+ - [TelestreamCloud::Qc::Proxy](docs/Proxy.md)
+ - [TelestreamCloud::Qc::UploadSession](docs/UploadSession.md)
+ - [TelestreamCloud::Qc::VideoStream](docs/VideoStream.md)
+ - [TelestreamCloud::Qc::VideoUploadBody](docs/VideoUploadBody.md)
+
+
+## Documentation for Authorization
+
+
+### apiKey
+
+- **Type**: API key
+- **API key parameter name**: X-Api-Key
+- **Location**: HTTP header
+

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/Alert.md

@@ -0,0 +1,13 @@
+# TelestreamCloud::Qc::Alert
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**level** | **String** |  | [optional] 
+**info** | **String** | Extra information for an alert. | [optional] 
+**_begin** | **String** | Start time of alert. | [optional] 
+**_end** | **String** | End time of alert. | [optional] 
+**stream** | **Integer** |  | [optional] 
+**detail** | **String** |  | [optional] 
+
+

data/docs/AudioStream.md

@@ -0,0 +1,13 @@
+# TelestreamCloud::Qc::AudioStream
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**duration** | **Float** | Audio duration measured in seconds. | [optional] 
+**codec** | **String** | Audio codec name. | [optional] 
+**channels** | **Integer** | Number of audio channels. | [optional] 
+**program** | **String** |  | [optional] 
+**bitrate** | **Integer** | Audio bitrate measured in bps | [optional] 
+**sample_rate** | **Integer** | Sample rate measured in Hz. | [optional] 
+
+

data/docs/Container.md

@@ -0,0 +1,9 @@
+# TelestreamCloud::Qc::Container
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | [optional] 
+**bitrate** | **String** | File bitrate measured in bps | [optional] 
+
+

data/docs/Data.md

@@ -0,0 +1,10 @@
+# TelestreamCloud::Qc::Data
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Human-readable identifier of a Project. | [optional] 
+**template** | **String** | Name of QC template. | [optional] 
+**options** | [**Options**](Options.md) |  | [optional] 
+
+

data/docs/Data1.md

@@ -0,0 +1,9 @@
+# TelestreamCloud::Qc::Data1
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**options** | [**Options**](Options.md) |  | [optional] 
+
+

data/docs/ExtraFile.md

@@ -0,0 +1,10 @@
+# TelestreamCloud::Qc::ExtraFile
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tag** | **String** |  | 
+**file_size** | **Integer** |  | 
+**file_name** | **String** |  | 
+
+

data/docs/Job.md

@@ -0,0 +1,12 @@
+# TelestreamCloud::Qc::Job
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**status** | **String** |  | [optional] 
+**duration** | **Integer** |  | [optional] 
+**type** | **String** |  | [optional] 
+**details** | [**JobDetails**](JobDetails.md) |  | [optional] 
+
+

data/docs/JobData.md

@@ -0,0 +1,9 @@
+# TelestreamCloud::Qc::JobData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**options** | [**Options**](Options.md) |  | [optional] 
+**url** | **String** |  | [optional] 
+
+

data/docs/JobDetails.md

@@ -0,0 +1,9 @@
+# TelestreamCloud::Qc::JobDetails
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**media** | [**Array<Media>**](Media.md) |  | [optional] 
+**result** | [**JobDetailsResult**](JobDetailsResult.md) |  | [optional] 
+
+

data/docs/JobDetailsResult.md

@@ -0,0 +1,8 @@
+# TelestreamCloud::Qc::JobDetailsResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**alerts** | [**Array<Alert>**](Alert.md) |  | [optional] 
+
+

data/docs/JobsCollection.md

@@ -0,0 +1,12 @@
+# TelestreamCloud::Qc::JobsCollection
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**jobs** | [**Array<Job>**](Job.md) |  | [optional] 
+**page** | **Integer** | A number of the fetched page. | [optional] 
+**per_page** | **Integer** | A number of jobs per page. | [optional] 
+**page_count** | **Integer** | A number of all pages. | [optional] 
+**total_count** | **Integer** | A number of all jobs stored in the db. | [optional] 
+
+

data/docs/Media.md

@@ -0,0 +1,10 @@
+# TelestreamCloud::Qc::Media
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**audio** | [**Array<AudioStream>**](AudioStream.md) |  | [optional] 
+**video** | [**Array<VideoStream>**](VideoStream.md) |  | [optional] 
+**container** | [**Container**](Container.md) |  | [optional] 
+
+

data/docs/Options.md

@@ -0,0 +1,7 @@
+# TelestreamCloud::Qc::Options
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/Project.md

@@ -0,0 +1,12 @@
+# TelestreamCloud::Qc::Project
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | A unique identifier of a Project. | [optional] 
+**name** | **String** | Human-readable identifier of a Project. | [optional] 
+**status** | **String** | Project status. | [optional] 
+**template** | **String** | Name of QC template. | [optional] 
+**options** | **String** | JSON with specific options | [optional] 
+
+

data/docs/Proxy.md

@@ -0,0 +1,12 @@
+# TelestreamCloud::Qc::Proxy
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** |  | [optional] 
+**progress** | **Integer** |  | [optional] 
+**url** | **String** |  | [optional] 
+**id** | **String** |  | [optional] 
+**updated_at** | **String** |  | [optional] 
+
+