telestream_cloud_tts 2.0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 91e44dfa17e952baef6bd8b4ec2b220e868bdbc7
+  data.tar.gz: c356ab48571893b3db84a3f0ed233270254b0635
+SHA512:
+  metadata.gz: 78114e5cbe4000cd5d6fecffa8e8fb748be775fa4e6179f5e788c625c306cee095bbad70033c1346492497e40ad94f302edba491e9970cfca19f7672fe651c0b
+  data.tar.gz: 428877d7443b4362b8d0fcbe399ee93627648e0fb440ad42aab1f57109c40b845cdac6767eed7098303b27e629efbda6e21057320e7ca3dd8dcaaea128a1e5dc

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,92 @@
+# Telestream Cloud Timed Text Speech Ruby SDK
+
+This library provides a low-level interface to the REST API of Telestream Cloud, the online video encoding service.
+
+## Getting Started
+### Initialize client
+
+```ruby
+require 'telestream_cloud/tts'
+
+TelestreamCloud::Tts.configure do |config|
+  config.api_key['X-Api-Key'] = '[API KEY]'
+end
+
+client = TelestreamCloud::Tts::TtsApi.new
+```
+
+### Create a project
+```ruby
+client.create_project(name: 'Example project name', language: 'en-US')
+```
+
+### Create job from local file
+
+```ruby
+project_id = '...'
+uploader = TelestreamCloud::Flip::Uploader.new(
+  client,
+  project_id: project_id,
+  file: '/path/to/file.mp4',
+)
+
+job_id = uploader.upload
+```
+
+### Create job from source URL
+```ruby
+project_id = '...'
+client.create_job(project_id, source_url: 'http://url/to/file.mp4')
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.cloud.telestream.net/tts/v1.0*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*TelestreamCloud::Tts::TtsApi* | [**corpora**](docs/TtsApi.md#corpora) | **GET** /projects/{projectID}/corpora | Returns a collection of Corpora
+*TelestreamCloud::Tts::TtsApi* | [**corpus**](docs/TtsApi.md#corpus) | **GET** /projects/{projectID}/corpora/{name} | Returns the Corpus
+*TelestreamCloud::Tts::TtsApi* | [**create_corpus**](docs/TtsApi.md#create_corpus) | **POST** /projects/{projectID}/corpora/{name} | Creates a new Corpus
+*TelestreamCloud::Tts::TtsApi* | [**create_job**](docs/TtsApi.md#create_job) | **POST** /projects/{projectID}/jobs | Creates a new Job
+*TelestreamCloud::Tts::TtsApi* | [**create_project**](docs/TtsApi.md#create_project) | **POST** /projects | Creates a new Project
+*TelestreamCloud::Tts::TtsApi* | [**delete_corpus**](docs/TtsApi.md#delete_corpus) | **DELETE** /projects/{projectID}/corpora/{name} | Creates a new Corpus
+*TelestreamCloud::Tts::TtsApi* | [**delete_job**](docs/TtsApi.md#delete_job) | **DELETE** /projects/{projectID}/jobs/{id} | Deletes the Job
+*TelestreamCloud::Tts::TtsApi* | [**delete_project**](docs/TtsApi.md#delete_project) | **DELETE** /projects/{projectID} | Deletes the Project
+*TelestreamCloud::Tts::TtsApi* | [**job**](docs/TtsApi.md#job) | **GET** /projects/{projectID}/jobs/{id} | Returns the Job
+*TelestreamCloud::Tts::TtsApi* | [**job_result**](docs/TtsApi.md#job_result) | **GET** /projects/{projectID}/jobs/{id}/result | Returns the Job Result
+*TelestreamCloud::Tts::TtsApi* | [**jobs**](docs/TtsApi.md#jobs) | **GET** /projects/{projectID}/jobs | Returns a collection of Jobs
+*TelestreamCloud::Tts::TtsApi* | [**project**](docs/TtsApi.md#project) | **GET** /projects/{projectID} | Returns the Project
+*TelestreamCloud::Tts::TtsApi* | [**projects**](docs/TtsApi.md#projects) | **GET** /projects | Returns a collection of Projects
+*TelestreamCloud::Tts::TtsApi* | [**train_project**](docs/TtsApi.md#train_project) | **POST** /projects/{projectID}/train | Queues training
+*TelestreamCloud::Tts::TtsApi* | [**update_project**](docs/TtsApi.md#update_project) | **PUT** /projects/{projectID} | Updates an existing Project
+*TelestreamCloud::Tts::TtsApi* | [**upload_video**](docs/TtsApi.md#upload_video) | **POST** /projects/{projectID}/jobs/upload | Creates an upload session
+
+
+## Documentation for Models
+
+ - [TelestreamCloud::Tts::CorporaCollection](docs/CorporaCollection.md)
+ - [TelestreamCloud::Tts::Corpus](docs/Corpus.md)
+ - [TelestreamCloud::Tts::ErrorResponse](docs/ErrorResponse.md)
+ - [TelestreamCloud::Tts::ExtraFile](docs/ExtraFile.md)
+ - [TelestreamCloud::Tts::Fragment](docs/Fragment.md)
+ - [TelestreamCloud::Tts::FragmentVariant](docs/FragmentVariant.md)
+ - [TelestreamCloud::Tts::Job](docs/Job.md)
+ - [TelestreamCloud::Tts::JobResult](docs/JobResult.md)
+ - [TelestreamCloud::Tts::JobsCollection](docs/JobsCollection.md)
+ - [TelestreamCloud::Tts::Project](docs/Project.md)
+ - [TelestreamCloud::Tts::ProjectsCollection](docs/ProjectsCollection.md)
+ - [TelestreamCloud::Tts::Result](docs/Result.md)
+ - [TelestreamCloud::Tts::UploadSession](docs/UploadSession.md)
+ - [TelestreamCloud::Tts::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/CorporaCollection.md

@@ -0,0 +1,8 @@
+# TelestreamCloud::Tts::CorporaCollection
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**corpora** | [**Array<Corpus>**](Corpus.md) | An array of Corpus files | [optional] 
+
+

data/docs/Corpus.md

@@ -0,0 +1,9 @@
+# TelestreamCloud::Tts::Corpus
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the Corpus. | [optional] 
+**status** | **String** | Determines the status of the Corpus. | [optional] 
+
+

data/docs/ErrorResponse.md

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

data/docs/ExtraFile.md

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

data/docs/Fragment.md

@@ -0,0 +1,10 @@
+# TelestreamCloud::Tts::Fragment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**start_time** | **Float** | The start time in seconds of the fragment from the input audio | [optional] 
+**variants** | [**Array<FragmentVariant>**](FragmentVariant.md) | An array of FragmentVariants | [optional] 
+**end_time** | **Float** | The end time in seconds of the fragment from the input audio | [optional] 
+
+

data/docs/FragmentVariant.md

@@ -0,0 +1,9 @@
+# TelestreamCloud::Tts::FragmentVariant
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fragment** | **String** | An alternative hypothesis for a fragment from the input audio. | [optional] 
+**confidence** | **Float** | The confidence score of the fragment variant hypothesis in the range of 0 to 1. | [optional] 
+
+

data/docs/Job.md

@@ -0,0 +1,23 @@
+# TelestreamCloud::Tts::Job
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The ID of the job. | [optional] 
+**name** | **String** | The name of the job. | [optional] 
+**original_filename** | **String** | The name of the input file | [optional] 
+**project_id** | **String** | The ID of the project. | [optional] 
+**source_url** | **String** | The URL of source file. | [optional] 
+**status** | **String** | Determines the state of transcription job. | [optional] 
+**error** | **String** | If the status of the job is 'error', returns the state of job. | [optional] 
+**progress** | **Integer** | A percentage that indicates the progress of the job. | [optional] 
+**confidence** | **Integer** | The confidence score of the job in the range of 0 to 100. | [optional] 
+**duration** | **Integer** | The duration of the input audio in milliseconds. | [optional] 
+**bitrate** | **Integer** | The bitrate of the input audio. | [optional] 
+**sample_rate** | **Integer** | The sample rate of the input audio. | [optional] 
+**format** | **String** | The format of the input audio. | [optional] 
+**file_size** | **String** | The file size of the input file. | [optional] 
+**created_at** | **String** | A date and time when the job was created | [optional] 
+**updated_at** | **String** | A date and time when the job was updated | [optional] 
+
+

data/docs/JobResult.md

@@ -0,0 +1,8 @@
+# TelestreamCloud::Tts::JobResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**results** | [**Array<Result>**](Result.md) | An array of Results | [optional] 
+
+

data/docs/JobsCollection.md

@@ -0,0 +1,12 @@
+# TelestreamCloud::Tts::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 pages. | [optional] 
+**total_count** | **Integer** | A number of all jobs. | [optional] 
+
+

data/docs/Project.md

@@ -0,0 +1,18 @@
+# TelestreamCloud::Tts::Project
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The ID of the Project. | [optional] 
+**name** | **String** | The name of the Project. | [optional] 
+**description** | **String** | The description of the Project. | [optional] 
+**status** | **String** | Determines a stage of training. | [optional] 
+**language** | **String** | The language code of model. | [optional] 
+**sample_rate** | **Integer** | The sample rate of model. | [optional] 
+**profanity_filter** | **BOOLEAN** | If true, the service replaces profanity from output with asterisks. | [optional] 
+**generate_proxy** | **BOOLEAN** | Indicates whether video preview should be generated. | [optional] 
+**custom_words** | **String** | Words used for model training, separated by space. | [optional] 
+**created_at** | **String** | A date and time when the project was created | [optional] 
+**updated_at** | **String** | A date and time when the project was updated | [optional] 
+
+

data/docs/ProjectsCollection.md

@@ -0,0 +1,12 @@
+# TelestreamCloud::Tts::ProjectsCollection
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**projects** | [**Array<Project>**](Project.md) |  | [optional] 
+**page** | **Integer** | A number of the fetched page. | [optional] 
+**per_page** | **Integer** | A number of projects per page. | [optional] 
+**page_count** | **Integer** | A number of pages. | [optional] 
+**total_count** | **Integer** | A number of all projects. | [optional] 
+
+

data/docs/Result.md

@@ -0,0 +1,12 @@
+# TelestreamCloud::Tts::Result
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transcript** | **String** |  | [optional] 
+**start_time** | **Float** | The start time in seconds of the transcript from the input audio | [optional] 
+**fragments** | [**Array<Fragment>**](Fragment.md) | An array of Fragments | [optional] 
+**end_time** | **Float** | The end time time in seconds of the transcript from the input audio | [optional] 
+**confidence** | **Float** | The confidence score of the result in the range of 0 to 1 | [optional] 
+
+

data/docs/TtsApi.md

@@ -0,0 +1,902 @@
+# TelestreamCloud::Tts::TtsApi
+
+All URIs are relative to *https://api.cloud.telestream.net/tts/v1.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**corpora**](TtsApi.md#corpora) | **GET** /projects/{projectID}/corpora | Returns a collection of Corpora
+[**corpus**](TtsApi.md#corpus) | **GET** /projects/{projectID}/corpora/{name} | Returns the Corpus
+[**create_corpus**](TtsApi.md#create_corpus) | **POST** /projects/{projectID}/corpora/{name} | Creates a new Corpus
+[**create_job**](TtsApi.md#create_job) | **POST** /projects/{projectID}/jobs | Creates a new Job
+[**create_project**](TtsApi.md#create_project) | **POST** /projects | Creates a new Project
+[**delete_corpus**](TtsApi.md#delete_corpus) | **DELETE** /projects/{projectID}/corpora/{name} | Creates a new Corpus
+[**delete_job**](TtsApi.md#delete_job) | **DELETE** /projects/{projectID}/jobs/{id} | Deletes the Job
+[**delete_project**](TtsApi.md#delete_project) | **DELETE** /projects/{projectID} | Deletes the Project
+[**job**](TtsApi.md#job) | **GET** /projects/{projectID}/jobs/{id} | Returns the Job
+[**job_result**](TtsApi.md#job_result) | **GET** /projects/{projectID}/jobs/{id}/result | Returns the Job Result
+[**jobs**](TtsApi.md#jobs) | **GET** /projects/{projectID}/jobs | Returns a collection of Jobs
+[**project**](TtsApi.md#project) | **GET** /projects/{projectID} | Returns the Project
+[**projects**](TtsApi.md#projects) | **GET** /projects | Returns a collection of Projects
+[**train_project**](TtsApi.md#train_project) | **POST** /projects/{projectID}/train | Queues training
+[**update_project**](TtsApi.md#update_project) | **PUT** /projects/{projectID} | Updates an existing Project
+[**upload_video**](TtsApi.md#upload_video) | **POST** /projects/{projectID}/jobs/upload | Creates an upload session
+
+
+# **corpora**
+> CorporaCollection corpora(project_id)
+
+Returns a collection of Corpora
+
+Returns a collection of Corpora
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_tts'
+# setup authorization
+TelestreamCloud::Tts.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = TelestreamCloud::Tts::TtsApi.new
+
+project_id = "project_id_example" # String | ID of the Project
+
+
+begin
+  #Returns a collection of Corpora
+  result = api_instance.corpora(project_id)
+  p result
+rescue TelestreamCloud::Tts::ApiError => e
+  puts "Exception when calling TtsApi->corpora: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| ID of the Project | 
+
+### Return type
+
+[**CorporaCollection**](CorporaCollection.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **corpus**
+> Corpus corpus(project_id, name)
+
+Returns the Corpus
+
+Returns the Corpus
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_tts'
+# setup authorization
+TelestreamCloud::Tts.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = TelestreamCloud::Tts::TtsApi.new
+
+project_id = "project_id_example" # String | ID of the Project
+
+name = "name_example" # String | Corpus name
+
+
+begin
+  #Returns the Corpus
+  result = api_instance.corpus(project_id, name)
+  p result
+rescue TelestreamCloud::Tts::ApiError => e
+  puts "Exception when calling TtsApi->corpus: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| ID of the Project | 
+ **name** | **String**| Corpus name | 
+
+### Return type
+
+[**Corpus**](Corpus.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_corpus**
+> create_corpus(project_id, name, body)
+
+Creates a new Corpus
+
+Creates a new Corpus
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_tts'
+# setup authorization
+TelestreamCloud::Tts.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = TelestreamCloud::Tts::TtsApi.new
+
+project_id = "project_id_example" # String | ID of the Project
+
+name = "name_example" # String | Corpus name
+
+body = "body_example" # String | 
+
+
+begin
+  #Creates a new Corpus
+  api_instance.create_corpus(project_id, name, body)
+rescue TelestreamCloud::Tts::ApiError => e
+  puts "Exception when calling TtsApi->create_corpus: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| ID of the Project | 
+ **name** | **String**| Corpus name | 
+ **body** | **String**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: text/plain
+ - **Accept**: application/json
+
+
+
+# **create_job**
+> Job create_job(project_id, job)
+
+Creates a new Job
+
+Creates a new Job
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_tts'
+# setup authorization
+TelestreamCloud::Tts.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = TelestreamCloud::Tts::TtsApi.new
+
+project_id = "project_id_example" # String | ID of the Project
+
+job = TelestreamCloud::Tts::Job.new # Job | 
+
+
+begin
+  #Creates a new Job
+  result = api_instance.create_job(project_id, job)
+  p result
+rescue TelestreamCloud::Tts::ApiError => e
+  puts "Exception when calling TtsApi->create_job: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| ID of the Project | 
+ **job** | [**Job**](Job.md)|  | 
+
+### Return type
+
+[**Job**](Job.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_project**
+> Project create_project(project)
+
+Creates a new Project
+
+Creates a new Project
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_tts'
+# setup authorization
+TelestreamCloud::Tts.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = TelestreamCloud::Tts::TtsApi.new
+
+project = TelestreamCloud::Tts::Project.new # Project | 
+
+
+begin
+  #Creates a new Project
+  result = api_instance.create_project(project)
+  p result
+rescue TelestreamCloud::Tts::ApiError => e
+  puts "Exception when calling TtsApi->create_project: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project** | [**Project**](Project.md)|  | 
+
+### Return type
+
+[**Project**](Project.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_corpus**
+> delete_corpus(project_id, name)
+
+Creates a new Corpus
+
+Creates a new Corpus
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_tts'
+# setup authorization
+TelestreamCloud::Tts.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = TelestreamCloud::Tts::TtsApi.new
+
+project_id = "project_id_example" # String | ID of the Project
+
+name = "name_example" # String | Corpus name
+
+
+begin
+  #Creates a new Corpus
+  api_instance.delete_corpus(project_id, name)
+rescue TelestreamCloud::Tts::ApiError => e
+  puts "Exception when calling TtsApi->delete_corpus: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| ID of the Project | 
+ **name** | **String**| Corpus name | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_job**
+> delete_job(project_id, job_id)
+
+Deletes the Job
+
+Deletes the Job
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_tts'
+# setup authorization
+TelestreamCloud::Tts.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = TelestreamCloud::Tts::TtsApi.new
+
+project_id = "project_id_example" # String | ID of the Project
+
+job_id = "job_id_example" # String | 
+
+
+begin
+  #Deletes the Job
+  api_instance.delete_job(project_id, job_id)
+rescue TelestreamCloud::Tts::ApiError => e
+  puts "Exception when calling TtsApi->delete_job: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| ID of the Project | 
+ **job_id** | **String**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_project**
+> delete_project
+
+Deletes the Project
+
+Deletes the Project
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_tts'
+# setup authorization
+TelestreamCloud::Tts.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = TelestreamCloud::Tts::TtsApi.new
+
+begin
+  #Deletes the Project
+  api_instance.delete_project
+rescue TelestreamCloud::Tts::ApiError => e
+  puts "Exception when calling TtsApi->delete_project: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **job**
+> Job job(project_id, job_id)
+
+Returns the Job
+
+Returns the Job
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_tts'
+# setup authorization
+TelestreamCloud::Tts.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = TelestreamCloud::Tts::TtsApi.new
+
+project_id = "project_id_example" # String | ID of the Project
+
+job_id = "job_id_example" # String | 
+
+
+begin
+  #Returns the Job
+  result = api_instance.job(project_id, job_id)
+  p result
+rescue TelestreamCloud::Tts::ApiError => e
+  puts "Exception when calling TtsApi->job: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| ID of the Project | 
+ **job_id** | **String**|  | 
+
+### Return type
+
+[**Job**](Job.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **job_result**
+> JobResult job_result(project_id, job_id)
+
+Returns the Job Result
+
+Returns the Job Result
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_tts'
+# setup authorization
+TelestreamCloud::Tts.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = TelestreamCloud::Tts::TtsApi.new
+
+project_id = "project_id_example" # String | ID of the Project
+
+job_id = "job_id_example" # String | 
+
+
+begin
+  #Returns the Job Result
+  result = api_instance.job_result(project_id, job_id)
+  p result
+rescue TelestreamCloud::Tts::ApiError => e
+  puts "Exception when calling TtsApi->job_result: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| ID of the Project | 
+ **job_id** | **String**|  | 
+
+### Return type
+
+[**JobResult**](JobResult.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **jobs**
+> JobsCollection jobs(project_id, opts)
+
+Returns a collection of Jobs
+
+Returns a collection of Jobs
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_tts'
+# setup authorization
+TelestreamCloud::Tts.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = TelestreamCloud::Tts::TtsApi.new
+
+project_id = "project_id_example" # String | ID of the Project
+
+opts = { 
+  page: 56, # Integer | page number
+  per_page: 56 # Integer | number of records per page
+}
+
+begin
+  #Returns a collection of Jobs
+  result = api_instance.jobs(project_id, opts)
+  p result
+rescue TelestreamCloud::Tts::ApiError => e
+  puts "Exception when calling TtsApi->jobs: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| ID of the Project | 
+ **page** | **Integer**| page number | [optional] 
+ **per_page** | **Integer**| number of records per page | [optional] 
+
+### Return type
+
+[**JobsCollection**](JobsCollection.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **project**
+> Project project(project_id)
+
+Returns the Project
+
+Returns the Project
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_tts'
+# setup authorization
+TelestreamCloud::Tts.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = TelestreamCloud::Tts::TtsApi.new
+
+project_id = "project_id_example" # String | ID of the Project
+
+
+begin
+  #Returns the Project
+  result = api_instance.project(project_id)
+  p result
+rescue TelestreamCloud::Tts::ApiError => e
+  puts "Exception when calling TtsApi->project: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| ID of the Project | 
+
+### Return type
+
+[**Project**](Project.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **projects**
+> ProjectsCollection projects
+
+Returns a collection of Projects
+
+Returns a collection of Projects
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_tts'
+# setup authorization
+TelestreamCloud::Tts.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = TelestreamCloud::Tts::TtsApi.new
+
+begin
+  #Returns a collection of Projects
+  result = api_instance.projects
+  p result
+rescue TelestreamCloud::Tts::ApiError => e
+  puts "Exception when calling TtsApi->projects: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ProjectsCollection**](ProjectsCollection.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **train_project**
+> train_project(project_id)
+
+Queues training
+
+Queues training
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_tts'
+# setup authorization
+TelestreamCloud::Tts.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = TelestreamCloud::Tts::TtsApi.new
+
+project_id = "project_id_example" # String | ID of the Project
+
+
+begin
+  #Queues training
+  api_instance.train_project(project_id)
+rescue TelestreamCloud::Tts::ApiError => e
+  puts "Exception when calling TtsApi->train_project: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| ID of the Project | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_project**
+> Project update_project(project)
+
+Updates an existing Project
+
+Updates an existing Project
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_tts'
+# setup authorization
+TelestreamCloud::Tts.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = TelestreamCloud::Tts::TtsApi.new
+
+project = TelestreamCloud::Tts::Project.new # Project | 
+
+
+begin
+  #Updates an existing Project
+  result = api_instance.update_project(project)
+  p result
+rescue TelestreamCloud::Tts::ApiError => e
+  puts "Exception when calling TtsApi->update_project: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project** | [**Project**](Project.md)|  | 
+
+### Return type
+
+[**Project**](Project.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **upload_video**
+> UploadSession upload_video(project_id, video_upload_body)
+
+Creates an upload session
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_tts'
+# setup authorization
+TelestreamCloud::Tts.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = TelestreamCloud::Tts::TtsApi.new
+
+project_id = "project_id_example" # String | ID of the Project
+
+video_upload_body = TelestreamCloud::Tts::VideoUploadBody.new # VideoUploadBody | 
+
+
+begin
+  #Creates an upload session
+  result = api_instance.upload_video(project_id, video_upload_body)
+  p result
+rescue TelestreamCloud::Tts::ApiError => e
+  puts "Exception when calling TtsApi->upload_video: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| ID of the Project | 
+ **video_upload_body** | [**VideoUploadBody**](VideoUploadBody.md)|  | 
+
+### Return type
+
+[**UploadSession**](UploadSession.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+