telestream_cloud_qc 2.0.0 → 2.0.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +48 -1
- data/docs/Alert.md +2 -2
- data/docs/Container.md +1 -1
- data/docs/InlineResponse200.md +9 -0
- data/docs/InlineResponse422.md +8 -0
- data/docs/Job.md +10 -0
- data/docs/JobData.md +1 -0
- data/docs/JobDetails.md +2 -0
- data/docs/JobDetailsResult.md +1 -0
- data/docs/Project.md +1 -1
- data/docs/QcApi.md +129 -26
- data/docs/Summary.md +13 -0
- data/docs/SynchronizationEvent.md +10 -0
- data/docs/Template.md +12 -0
- data/docs/VideoStream.md +1 -1
- data/lib/telestream_cloud_qc.rb +7 -2
- data/lib/telestream_cloud_qc/api/qc_api.rb +119 -15
- data/lib/telestream_cloud_qc/api_client.rb +2 -2
- data/lib/telestream_cloud_qc/api_error.rb +2 -2
- data/lib/telestream_cloud_qc/configuration.rb +3 -3
- data/lib/telestream_cloud_qc/models/alert.rb +4 -4
- data/lib/telestream_cloud_qc/models/audio_stream.rb +2 -2
- data/lib/telestream_cloud_qc/models/container.rb +3 -3
- data/lib/telestream_cloud_qc/models/data.rb +2 -2
- data/lib/telestream_cloud_qc/models/data_1.rb +2 -2
- data/lib/telestream_cloud_qc/models/extra_file.rb +2 -2
- data/lib/telestream_cloud_qc/models/inline_response_200.rb +197 -0
- data/lib/telestream_cloud_qc/models/inline_response_422.rb +188 -0
- data/lib/telestream_cloud_qc/models/job.rb +95 -5
- data/lib/telestream_cloud_qc/models/job_data.rb +16 -6
- data/lib/telestream_cloud_qc/models/job_details.rb +26 -6
- data/lib/telestream_cloud_qc/models/job_details_result.rb +17 -6
- data/lib/telestream_cloud_qc/models/jobs_collection.rb +2 -2
- data/lib/telestream_cloud_qc/models/media.rb +2 -2
- data/lib/telestream_cloud_qc/models/options.rb +2 -2
- data/lib/telestream_cloud_qc/models/project.rb +6 -4
- data/lib/telestream_cloud_qc/models/proxy.rb +2 -2
- data/lib/telestream_cloud_qc/models/summary.rb +236 -0
- data/lib/telestream_cloud_qc/models/synchronization_event.rb +206 -0
- data/lib/telestream_cloud_qc/models/template.rb +228 -0
- data/lib/telestream_cloud_qc/models/upload_session.rb +2 -2
- data/lib/telestream_cloud_qc/models/video_stream.rb +3 -3
- data/lib/telestream_cloud_qc/models/video_upload_body.rb +2 -2
- data/lib/telestream_cloud_qc/uploader.rb +12 -0
- data/lib/telestream_cloud_qc/version.rb +3 -3
- data/spec/api/qc_api_spec.rb +26 -2
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/alert_spec.rb +2 -2
- data/spec/models/audio_stream_spec.rb +2 -2
- data/spec/models/container_spec.rb +2 -2
- data/spec/models/data_1_spec.rb +2 -2
- data/spec/models/data_spec.rb +2 -2
- data/spec/models/extra_file_spec.rb +2 -2
- data/spec/models/inline_response_200_spec.rb +48 -0
- data/spec/models/inline_response_422_spec.rb +42 -0
- data/spec/models/job_data_spec.rb +8 -2
- data/spec/models/job_details_result_spec.rb +8 -2
- data/spec/models/job_details_spec.rb +14 -2
- data/spec/models/job_spec.rb +63 -3
- data/spec/models/jobs_collection_spec.rb +2 -2
- data/spec/models/media_spec.rb +2 -2
- data/spec/models/options_spec.rb +2 -2
- data/spec/models/project_spec.rb +2 -2
- data/spec/models/proxy_spec.rb +2 -2
- data/spec/models/summary_spec.rb +72 -0
- data/spec/models/synchronization_event_spec.rb +54 -0
- data/spec/models/template_spec.rb +66 -0
- data/spec/models/upload_session_spec.rb +2 -2
- data/spec/models/video_stream_spec.rb +2 -2
- data/spec/models/video_upload_body_spec.rb +2 -2
- data/spec/spec_helper.rb +2 -2
- data/telestream_cloud_qc.gemspec +2 -2
- metadata +35 -15
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: c60424e18db26a4bd5de3b98327ac98fb3e2ad18
|
|
4
|
+
data.tar.gz: 1e3cb25c18d5fdd5df3a4c778c418ae784a96758
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 6eec7d4e0e2db35d6533db24f950358bc3e69ee87d4e9fc50ee5538cb62e254bb324076dbc6b6970a01b25855c65b36d16cad2e3156da3a336e2c7abae69606e
|
|
7
|
+
data.tar.gz: ae5cd684c855a8b353770836ba365d1cb755a2df8e5d76b7145196f44ad00c3e469ef94fa877a44ba158ffb19b59f021ecca85aa3ddf23ca61c1c1458b7da1ab
|
data/README.md
CHANGED
|
@@ -3,6 +3,46 @@
|
|
|
3
3
|
This library provides a low-level interface to the REST API of Telestream Cloud, the online video encoding service.
|
|
4
4
|
|
|
5
5
|
## Getting Started
|
|
6
|
+
Configure client, replace `[YOUR API KEY]` with proper `ApiKey`
|
|
7
|
+
|
|
8
|
+
```ruby
|
|
9
|
+
require 'telestream_cloud_qc'
|
|
10
|
+
|
|
11
|
+
TelestreamCloud::Qc.configure do |config|
|
|
12
|
+
config.api_key['X-Api-Key'] = '[YOUR API KEY]'
|
|
13
|
+
end
|
|
14
|
+
|
|
15
|
+
api = TelestreamCloud::Qc::QcApi.new
|
|
16
|
+
```
|
|
17
|
+
Create a new project
|
|
18
|
+
```ruby
|
|
19
|
+
|
|
20
|
+
project = api.create_project({data: {name: "MyProject", template: "amazon"}})
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Upload file from local store, replace project id `[PROJECT ID]`
|
|
24
|
+
|
|
25
|
+
```ruby
|
|
26
|
+
upload = TelestreamCloud::Qc::Uploader.new(api, {
|
|
27
|
+
file: '/tmp/video.mp4',
|
|
28
|
+
project_id: '[PROJECT ID]',
|
|
29
|
+
})
|
|
30
|
+
|
|
31
|
+
puts upload.upload
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Get status of job
|
|
35
|
+
```ruby
|
|
36
|
+
project_id = '[PROJECT ID]'
|
|
37
|
+
job_id = '[JOB ID]'
|
|
38
|
+
|
|
39
|
+
api.get_job(project_id, job_id)
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
Start a new job using URL to file
|
|
43
|
+
```ruby
|
|
44
|
+
api.create_job(project_id, {url: 'http://example.com/video.mp4'})
|
|
45
|
+
```
|
|
6
46
|
|
|
7
47
|
## Documentation for API Endpoints
|
|
8
48
|
|
|
@@ -15,6 +55,7 @@ Class | Method | HTTP request | Description
|
|
|
15
55
|
*TelestreamCloud::Qc::QcApi* | [**create_project**](docs/QcApi.md#create_project) | **POST** /projects.json | Create a new project
|
|
16
56
|
*TelestreamCloud::Qc::QcApi* | [**get_job**](docs/QcApi.md#get_job) | **GET** /projects/{project_id}/jobs/{job_id}.json | Get QC job
|
|
17
57
|
*TelestreamCloud::Qc::QcApi* | [**get_project**](docs/QcApi.md#get_project) | **GET** /projects/{project_id}.json | Get project by Id
|
|
58
|
+
*TelestreamCloud::Qc::QcApi* | [**import_template**](docs/QcApi.md#import_template) | **POST** /projects/import.json | Import Vidchecker template
|
|
18
59
|
*TelestreamCloud::Qc::QcApi* | [**list_jobs**](docs/QcApi.md#list_jobs) | **GET** /projects/{project_id}/jobs.json | Get jobs form projects
|
|
19
60
|
*TelestreamCloud::Qc::QcApi* | [**list_projects**](docs/QcApi.md#list_projects) | **GET** /projects.json | List all projects for an account
|
|
20
61
|
*TelestreamCloud::Qc::QcApi* | [**modify_project**](docs/QcApi.md#modify_project) | **PUT** /projects/{project_id}.json | Modify project
|
|
@@ -22,6 +63,7 @@ Class | Method | HTTP request | Description
|
|
|
22
63
|
*TelestreamCloud::Qc::QcApi* | [**remove_job**](docs/QcApi.md#remove_job) | **DELETE** /projects/{project_id}/jobs/{job_id}.json |
|
|
23
64
|
*TelestreamCloud::Qc::QcApi* | [**remove_project**](docs/QcApi.md#remove_project) | **DELETE** /projects/{project_id}.json |
|
|
24
65
|
*TelestreamCloud::Qc::QcApi* | [**signed_urls**](docs/QcApi.md#signed_urls) | **GET** /projects/{project_id}/jobs/{job_id}/signed-urls.json |
|
|
66
|
+
*TelestreamCloud::Qc::QcApi* | [**templates**](docs/QcApi.md#templates) | **GET** /templates.json | List all templates
|
|
25
67
|
*TelestreamCloud::Qc::QcApi* | [**upload_video**](docs/QcApi.md#upload_video) | **POST** /projects/{project_id}/upload.json | Creates an upload session
|
|
26
68
|
|
|
27
69
|
|
|
@@ -33,6 +75,8 @@ Class | Method | HTTP request | Description
|
|
|
33
75
|
- [TelestreamCloud::Qc::Data](docs/Data.md)
|
|
34
76
|
- [TelestreamCloud::Qc::Data1](docs/Data1.md)
|
|
35
77
|
- [TelestreamCloud::Qc::ExtraFile](docs/ExtraFile.md)
|
|
78
|
+
- [TelestreamCloud::Qc::InlineResponse200](docs/InlineResponse200.md)
|
|
79
|
+
- [TelestreamCloud::Qc::InlineResponse422](docs/InlineResponse422.md)
|
|
36
80
|
- [TelestreamCloud::Qc::Job](docs/Job.md)
|
|
37
81
|
- [TelestreamCloud::Qc::JobData](docs/JobData.md)
|
|
38
82
|
- [TelestreamCloud::Qc::JobDetails](docs/JobDetails.md)
|
|
@@ -42,6 +86,9 @@ Class | Method | HTTP request | Description
|
|
|
42
86
|
- [TelestreamCloud::Qc::Options](docs/Options.md)
|
|
43
87
|
- [TelestreamCloud::Qc::Project](docs/Project.md)
|
|
44
88
|
- [TelestreamCloud::Qc::Proxy](docs/Proxy.md)
|
|
89
|
+
- [TelestreamCloud::Qc::Summary](docs/Summary.md)
|
|
90
|
+
- [TelestreamCloud::Qc::SynchronizationEvent](docs/SynchronizationEvent.md)
|
|
91
|
+
- [TelestreamCloud::Qc::Template](docs/Template.md)
|
|
45
92
|
- [TelestreamCloud::Qc::UploadSession](docs/UploadSession.md)
|
|
46
93
|
- [TelestreamCloud::Qc::VideoStream](docs/VideoStream.md)
|
|
47
94
|
- [TelestreamCloud::Qc::VideoUploadBody](docs/VideoUploadBody.md)
|
|
@@ -50,7 +97,7 @@ Class | Method | HTTP request | Description
|
|
|
50
97
|
## Documentation for Authorization
|
|
51
98
|
|
|
52
99
|
|
|
53
|
-
###
|
|
100
|
+
### api_key
|
|
54
101
|
|
|
55
102
|
- **Type**: API key
|
|
56
103
|
- **API key parameter name**: X-Api-Key
|
data/docs/Alert.md
CHANGED
|
@@ -5,8 +5,8 @@ Name | Type | Description | Notes
|
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**level** | **String** | | [optional]
|
|
7
7
|
**info** | **String** | Extra information for an alert. | [optional]
|
|
8
|
-
**_begin** | **
|
|
9
|
-
**_end** | **
|
|
8
|
+
**_begin** | **Float** | Start time of alert. | [optional]
|
|
9
|
+
**_end** | **Float** | End time of alert. | [optional]
|
|
10
10
|
**stream** | **Integer** | | [optional]
|
|
11
11
|
**detail** | **String** | | [optional]
|
|
12
12
|
|
data/docs/Container.md
CHANGED
|
@@ -4,6 +4,6 @@
|
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**type** | **String** | | [optional]
|
|
7
|
-
**bitrate** | **
|
|
7
|
+
**bitrate** | **Integer** | File bitrate measured in bps | [optional]
|
|
8
8
|
|
|
9
9
|
|
data/docs/Job.md
CHANGED
|
@@ -4,9 +4,19 @@
|
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**id** | **String** | | [optional]
|
|
7
|
+
**project_id** | **String** | | [optional]
|
|
7
8
|
**status** | **String** | | [optional]
|
|
9
|
+
**state** | **String** | | [optional]
|
|
8
10
|
**duration** | **Integer** | | [optional]
|
|
9
11
|
**type** | **String** | | [optional]
|
|
12
|
+
**progress** | **Integer** | | [optional]
|
|
13
|
+
**filename** | **String** | | [optional]
|
|
14
|
+
**source_url** | **String** | | [optional]
|
|
15
|
+
**created_at** | **String** | | [optional]
|
|
16
|
+
**updated_at** | **String** | | [optional]
|
|
17
|
+
**error_class** | **String** | | [optional]
|
|
18
|
+
**error_message** | **String** | | [optional]
|
|
19
|
+
**payload** | **String** | | [optional]
|
|
10
20
|
**details** | [**JobDetails**](JobDetails.md) | | [optional]
|
|
11
21
|
|
|
12
22
|
|
data/docs/JobData.md
CHANGED
|
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
|
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**options** | [**Options**](Options.md) | | [optional]
|
|
7
7
|
**url** | **String** | | [optional]
|
|
8
|
+
**payload** | **String** | Payload is an arbitrary text of length 256 or shorter that you can store along the Media. It is typically used to retain an association with one of your own DB record ID. | [optional]
|
|
8
9
|
|
|
9
10
|
|
data/docs/JobDetails.md
CHANGED
|
@@ -5,5 +5,7 @@ Name | Type | Description | Notes
|
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**media** | [**Array<Media>**](Media.md) | | [optional]
|
|
7
7
|
**result** | [**JobDetailsResult**](JobDetailsResult.md) | | [optional]
|
|
8
|
+
**synchronization_events** | [**Array<SynchronizationEvent>**](SynchronizationEvent.md) | | [optional]
|
|
9
|
+
**summary** | [**Summary**](Summary.md) | | [optional]
|
|
8
10
|
|
|
9
11
|
|
data/docs/JobDetailsResult.md
CHANGED
data/docs/Project.md
CHANGED
|
@@ -7,6 +7,6 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**name** | **String** | Human-readable identifier of a Project. | [optional]
|
|
8
8
|
**status** | **String** | Project status. | [optional]
|
|
9
9
|
**template** | **String** | Name of QC template. | [optional]
|
|
10
|
-
**options** | **String
|
|
10
|
+
**options** | **Hash<String, Object>** | JSON with specific options | [optional]
|
|
11
11
|
|
|
12
12
|
|
data/docs/QcApi.md
CHANGED
|
@@ -9,6 +9,7 @@ Method | HTTP request | Description
|
|
|
9
9
|
[**create_project**](QcApi.md#create_project) | **POST** /projects.json | Create a new project
|
|
10
10
|
[**get_job**](QcApi.md#get_job) | **GET** /projects/{project_id}/jobs/{job_id}.json | Get QC job
|
|
11
11
|
[**get_project**](QcApi.md#get_project) | **GET** /projects/{project_id}.json | Get project by Id
|
|
12
|
+
[**import_template**](QcApi.md#import_template) | **POST** /projects/import.json | Import Vidchecker template
|
|
12
13
|
[**list_jobs**](QcApi.md#list_jobs) | **GET** /projects/{project_id}/jobs.json | Get jobs form projects
|
|
13
14
|
[**list_projects**](QcApi.md#list_projects) | **GET** /projects.json | List all projects for an account
|
|
14
15
|
[**modify_project**](QcApi.md#modify_project) | **PUT** /projects/{project_id}.json | Modify project
|
|
@@ -16,6 +17,7 @@ Method | HTTP request | Description
|
|
|
16
17
|
[**remove_job**](QcApi.md#remove_job) | **DELETE** /projects/{project_id}/jobs/{job_id}.json |
|
|
17
18
|
[**remove_project**](QcApi.md#remove_project) | **DELETE** /projects/{project_id}.json |
|
|
18
19
|
[**signed_urls**](QcApi.md#signed_urls) | **GET** /projects/{project_id}/jobs/{job_id}/signed-urls.json |
|
|
20
|
+
[**templates**](QcApi.md#templates) | **GET** /templates.json | List all templates
|
|
19
21
|
[**upload_video**](QcApi.md#upload_video) | **POST** /projects/{project_id}/upload.json | Creates an upload session
|
|
20
22
|
|
|
21
23
|
|
|
@@ -30,7 +32,7 @@ Method | HTTP request | Description
|
|
|
30
32
|
require 'telestream_cloud_qc'
|
|
31
33
|
# setup authorization
|
|
32
34
|
TelestreamCloud::Qc.configure do |config|
|
|
33
|
-
# Configure API key authorization:
|
|
35
|
+
# Configure API key authorization: api_key
|
|
34
36
|
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
|
35
37
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
36
38
|
#config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
|
@@ -63,7 +65,7 @@ nil (empty response body)
|
|
|
63
65
|
|
|
64
66
|
### Authorization
|
|
65
67
|
|
|
66
|
-
[
|
|
68
|
+
[api_key](../README.md#api_key)
|
|
67
69
|
|
|
68
70
|
### HTTP request headers
|
|
69
71
|
|
|
@@ -83,7 +85,7 @@ Create a new job
|
|
|
83
85
|
require 'telestream_cloud_qc'
|
|
84
86
|
# setup authorization
|
|
85
87
|
TelestreamCloud::Qc.configure do |config|
|
|
86
|
-
# Configure API key authorization:
|
|
88
|
+
# Configure API key authorization: api_key
|
|
87
89
|
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
|
88
90
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
89
91
|
#config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
|
@@ -118,7 +120,7 @@ Name | Type | Description | Notes
|
|
|
118
120
|
|
|
119
121
|
### Authorization
|
|
120
122
|
|
|
121
|
-
[
|
|
123
|
+
[api_key](../README.md#api_key)
|
|
122
124
|
|
|
123
125
|
### HTTP request headers
|
|
124
126
|
|
|
@@ -138,7 +140,7 @@ Create a new project
|
|
|
138
140
|
require 'telestream_cloud_qc'
|
|
139
141
|
# setup authorization
|
|
140
142
|
TelestreamCloud::Qc.configure do |config|
|
|
141
|
-
# Configure API key authorization:
|
|
143
|
+
# Configure API key authorization: api_key
|
|
142
144
|
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
|
143
145
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
144
146
|
#config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
|
@@ -171,7 +173,7 @@ Name | Type | Description | Notes
|
|
|
171
173
|
|
|
172
174
|
### Authorization
|
|
173
175
|
|
|
174
|
-
[
|
|
176
|
+
[api_key](../README.md#api_key)
|
|
175
177
|
|
|
176
178
|
### HTTP request headers
|
|
177
179
|
|
|
@@ -191,7 +193,7 @@ Get QC job
|
|
|
191
193
|
require 'telestream_cloud_qc'
|
|
192
194
|
# setup authorization
|
|
193
195
|
TelestreamCloud::Qc.configure do |config|
|
|
194
|
-
# Configure API key authorization:
|
|
196
|
+
# Configure API key authorization: api_key
|
|
195
197
|
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
|
196
198
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
197
199
|
#config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
|
@@ -226,7 +228,7 @@ Name | Type | Description | Notes
|
|
|
226
228
|
|
|
227
229
|
### Authorization
|
|
228
230
|
|
|
229
|
-
[
|
|
231
|
+
[api_key](../README.md#api_key)
|
|
230
232
|
|
|
231
233
|
### HTTP request headers
|
|
232
234
|
|
|
@@ -246,7 +248,7 @@ Get project by Id
|
|
|
246
248
|
require 'telestream_cloud_qc'
|
|
247
249
|
# setup authorization
|
|
248
250
|
TelestreamCloud::Qc.configure do |config|
|
|
249
|
-
# Configure API key authorization:
|
|
251
|
+
# Configure API key authorization: api_key
|
|
250
252
|
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
|
251
253
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
252
254
|
#config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
|
@@ -278,7 +280,7 @@ Name | Type | Description | Notes
|
|
|
278
280
|
|
|
279
281
|
### Authorization
|
|
280
282
|
|
|
281
|
-
[
|
|
283
|
+
[api_key](../README.md#api_key)
|
|
282
284
|
|
|
283
285
|
### HTTP request headers
|
|
284
286
|
|
|
@@ -287,6 +289,61 @@ Name | Type | Description | Notes
|
|
|
287
289
|
|
|
288
290
|
|
|
289
291
|
|
|
292
|
+
# **import_template**
|
|
293
|
+
> Array<InlineResponse200> import_template(opts)
|
|
294
|
+
|
|
295
|
+
Import Vidchecker template
|
|
296
|
+
|
|
297
|
+
### Example
|
|
298
|
+
```ruby
|
|
299
|
+
# load the gem
|
|
300
|
+
require 'telestream_cloud_qc'
|
|
301
|
+
# setup authorization
|
|
302
|
+
TelestreamCloud::Qc.configure do |config|
|
|
303
|
+
# Configure API key authorization: api_key
|
|
304
|
+
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
|
305
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
306
|
+
#config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
|
307
|
+
end
|
|
308
|
+
|
|
309
|
+
api_instance = TelestreamCloud::Qc::QcApi.new
|
|
310
|
+
|
|
311
|
+
opts = {
|
|
312
|
+
name: "name_example", # String |
|
|
313
|
+
file: File.new("/path/to/file.txt") # File |
|
|
314
|
+
}
|
|
315
|
+
|
|
316
|
+
begin
|
|
317
|
+
#Import Vidchecker template
|
|
318
|
+
result = api_instance.import_template(opts)
|
|
319
|
+
p result
|
|
320
|
+
rescue TelestreamCloud::Qc::ApiError => e
|
|
321
|
+
puts "Exception when calling QcApi->import_template: #{e}"
|
|
322
|
+
end
|
|
323
|
+
```
|
|
324
|
+
|
|
325
|
+
### Parameters
|
|
326
|
+
|
|
327
|
+
Name | Type | Description | Notes
|
|
328
|
+
------------- | ------------- | ------------- | -------------
|
|
329
|
+
**name** | **String**| | [optional]
|
|
330
|
+
**file** | **File**| | [optional]
|
|
331
|
+
|
|
332
|
+
### Return type
|
|
333
|
+
|
|
334
|
+
[**Array<InlineResponse200>**](InlineResponse200.md)
|
|
335
|
+
|
|
336
|
+
### Authorization
|
|
337
|
+
|
|
338
|
+
[api_key](../README.md#api_key)
|
|
339
|
+
|
|
340
|
+
### HTTP request headers
|
|
341
|
+
|
|
342
|
+
- **Content-Type**: text/xml
|
|
343
|
+
- **Accept**: application/json
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
|
|
290
347
|
# **list_jobs**
|
|
291
348
|
> JobsCollection list_jobs(project_id, opts)
|
|
292
349
|
|
|
@@ -298,7 +355,7 @@ Get jobs form projects
|
|
|
298
355
|
require 'telestream_cloud_qc'
|
|
299
356
|
# setup authorization
|
|
300
357
|
TelestreamCloud::Qc.configure do |config|
|
|
301
|
-
# Configure API key authorization:
|
|
358
|
+
# Configure API key authorization: api_key
|
|
302
359
|
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
|
303
360
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
304
361
|
#config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
|
@@ -340,7 +397,7 @@ Name | Type | Description | Notes
|
|
|
340
397
|
|
|
341
398
|
### Authorization
|
|
342
399
|
|
|
343
|
-
[
|
|
400
|
+
[api_key](../README.md#api_key)
|
|
344
401
|
|
|
345
402
|
### HTTP request headers
|
|
346
403
|
|
|
@@ -360,7 +417,7 @@ List all projects for an account
|
|
|
360
417
|
require 'telestream_cloud_qc'
|
|
361
418
|
# setup authorization
|
|
362
419
|
TelestreamCloud::Qc.configure do |config|
|
|
363
|
-
# Configure API key authorization:
|
|
420
|
+
# Configure API key authorization: api_key
|
|
364
421
|
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
|
365
422
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
366
423
|
#config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
|
@@ -386,7 +443,7 @@ This endpoint does not need any parameter.
|
|
|
386
443
|
|
|
387
444
|
### Authorization
|
|
388
445
|
|
|
389
|
-
[
|
|
446
|
+
[api_key](../README.md#api_key)
|
|
390
447
|
|
|
391
448
|
### HTTP request headers
|
|
392
449
|
|
|
@@ -406,7 +463,7 @@ Modify project
|
|
|
406
463
|
require 'telestream_cloud_qc'
|
|
407
464
|
# setup authorization
|
|
408
465
|
TelestreamCloud::Qc.configure do |config|
|
|
409
|
-
# Configure API key authorization:
|
|
466
|
+
# Configure API key authorization: api_key
|
|
410
467
|
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
|
411
468
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
412
469
|
#config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
|
@@ -442,7 +499,7 @@ Name | Type | Description | Notes
|
|
|
442
499
|
|
|
443
500
|
### Authorization
|
|
444
501
|
|
|
445
|
-
[
|
|
502
|
+
[api_key](../README.md#api_key)
|
|
446
503
|
|
|
447
504
|
### HTTP request headers
|
|
448
505
|
|
|
@@ -462,7 +519,7 @@ Name | Type | Description | Notes
|
|
|
462
519
|
require 'telestream_cloud_qc'
|
|
463
520
|
# setup authorization
|
|
464
521
|
TelestreamCloud::Qc.configure do |config|
|
|
465
|
-
# Configure API key authorization:
|
|
522
|
+
# Configure API key authorization: api_key
|
|
466
523
|
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
|
467
524
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
468
525
|
#config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
|
@@ -496,7 +553,7 @@ Name | Type | Description | Notes
|
|
|
496
553
|
|
|
497
554
|
### Authorization
|
|
498
555
|
|
|
499
|
-
[
|
|
556
|
+
[api_key](../README.md#api_key)
|
|
500
557
|
|
|
501
558
|
### HTTP request headers
|
|
502
559
|
|
|
@@ -516,7 +573,7 @@ Name | Type | Description | Notes
|
|
|
516
573
|
require 'telestream_cloud_qc'
|
|
517
574
|
# setup authorization
|
|
518
575
|
TelestreamCloud::Qc.configure do |config|
|
|
519
|
-
# Configure API key authorization:
|
|
576
|
+
# Configure API key authorization: api_key
|
|
520
577
|
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
|
521
578
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
522
579
|
#config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
|
@@ -549,7 +606,7 @@ nil (empty response body)
|
|
|
549
606
|
|
|
550
607
|
### Authorization
|
|
551
608
|
|
|
552
|
-
[
|
|
609
|
+
[api_key](../README.md#api_key)
|
|
553
610
|
|
|
554
611
|
### HTTP request headers
|
|
555
612
|
|
|
@@ -569,7 +626,7 @@ nil (empty response body)
|
|
|
569
626
|
require 'telestream_cloud_qc'
|
|
570
627
|
# setup authorization
|
|
571
628
|
TelestreamCloud::Qc.configure do |config|
|
|
572
|
-
# Configure API key authorization:
|
|
629
|
+
# Configure API key authorization: api_key
|
|
573
630
|
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
|
574
631
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
575
632
|
#config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
|
@@ -599,7 +656,7 @@ nil (empty response body)
|
|
|
599
656
|
|
|
600
657
|
### Authorization
|
|
601
658
|
|
|
602
|
-
[
|
|
659
|
+
[api_key](../README.md#api_key)
|
|
603
660
|
|
|
604
661
|
### HTTP request headers
|
|
605
662
|
|
|
@@ -619,7 +676,7 @@ nil (empty response body)
|
|
|
619
676
|
require 'telestream_cloud_qc'
|
|
620
677
|
# setup authorization
|
|
621
678
|
TelestreamCloud::Qc.configure do |config|
|
|
622
|
-
# Configure API key authorization:
|
|
679
|
+
# Configure API key authorization: api_key
|
|
623
680
|
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
|
624
681
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
625
682
|
#config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
|
@@ -653,7 +710,53 @@ Name | Type | Description | Notes
|
|
|
653
710
|
|
|
654
711
|
### Authorization
|
|
655
712
|
|
|
656
|
-
[
|
|
713
|
+
[api_key](../README.md#api_key)
|
|
714
|
+
|
|
715
|
+
### HTTP request headers
|
|
716
|
+
|
|
717
|
+
- **Content-Type**: application/json
|
|
718
|
+
- **Accept**: application/json
|
|
719
|
+
|
|
720
|
+
|
|
721
|
+
|
|
722
|
+
# **templates**
|
|
723
|
+
> Array<Template> templates
|
|
724
|
+
|
|
725
|
+
List all templates
|
|
726
|
+
|
|
727
|
+
### Example
|
|
728
|
+
```ruby
|
|
729
|
+
# load the gem
|
|
730
|
+
require 'telestream_cloud_qc'
|
|
731
|
+
# setup authorization
|
|
732
|
+
TelestreamCloud::Qc.configure do |config|
|
|
733
|
+
# Configure API key authorization: api_key
|
|
734
|
+
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
|
735
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
736
|
+
#config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
|
737
|
+
end
|
|
738
|
+
|
|
739
|
+
api_instance = TelestreamCloud::Qc::QcApi.new
|
|
740
|
+
|
|
741
|
+
begin
|
|
742
|
+
#List all templates
|
|
743
|
+
result = api_instance.templates
|
|
744
|
+
p result
|
|
745
|
+
rescue TelestreamCloud::Qc::ApiError => e
|
|
746
|
+
puts "Exception when calling QcApi->templates: #{e}"
|
|
747
|
+
end
|
|
748
|
+
```
|
|
749
|
+
|
|
750
|
+
### Parameters
|
|
751
|
+
This endpoint does not need any parameter.
|
|
752
|
+
|
|
753
|
+
### Return type
|
|
754
|
+
|
|
755
|
+
[**Array<Template>**](Template.md)
|
|
756
|
+
|
|
757
|
+
### Authorization
|
|
758
|
+
|
|
759
|
+
[api_key](../README.md#api_key)
|
|
657
760
|
|
|
658
761
|
### HTTP request headers
|
|
659
762
|
|
|
@@ -673,7 +776,7 @@ Creates an upload session
|
|
|
673
776
|
require 'telestream_cloud_qc'
|
|
674
777
|
# setup authorization
|
|
675
778
|
TelestreamCloud::Qc.configure do |config|
|
|
676
|
-
# Configure API key authorization:
|
|
779
|
+
# Configure API key authorization: api_key
|
|
677
780
|
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
|
678
781
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
679
782
|
#config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
|
@@ -708,7 +811,7 @@ Name | Type | Description | Notes
|
|
|
708
811
|
|
|
709
812
|
### Authorization
|
|
710
813
|
|
|
711
|
-
[
|
|
814
|
+
[api_key](../README.md#api_key)
|
|
712
815
|
|
|
713
816
|
### HTTP request headers
|
|
714
817
|
|