telestream_cloud 1.1.0 → 2.0.0.1

data/flip/.swagger-codegen/VERSION

@@ -0,0 +1 @@
+2.3.0

data/flip/Gemfile

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

data/flip/README.md

@@ -0,0 +1,130 @@
+# Telestream Cloud Flip 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/flip'
+
+TelestreamCloud::Flip.configure do |config|
+  config.api_key['X-Api-Key'] = '[API KEY]'
+end
+
+client = TelestreamCloud::Flip::FlipApi.new
+```
+
+### Upload video to Flip service
+
+```ruby
+factory_id = '...'
+uploader = TelestreamCloud::Flip::Uploader.new(
+  client,
+  factory_id: factory_id,
+  file: '/path/to/file.mp4',
+  extra_files: {
+    subtitles: '/path/to/subtitles'
+  }
+)
+
+video_id = uploader.upload
+```
+
+### Create video from source URL
+```ruby
+factory_id = '...'
+client.create_video(factory_id, source_url: 'http://url/to/file.mp4')
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.cloud.telestream.net/flip/3.1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*TelestreamCloud::Flip::FlipApi* | [**cancel_encoding**](docs/FlipApi.md#cancel_encoding) | **POST** /encodings/{id}/cancel.json | Cancels an Encoding.
+*TelestreamCloud::Flip::FlipApi* | [**copy_profile**](docs/FlipApi.md#copy_profile) | **POST** /profiles/{id}/copy.json | Copies a given Profile
+*TelestreamCloud::Flip::FlipApi* | [**create_encoding**](docs/FlipApi.md#create_encoding) | **POST** /encodings.json | Creates an Encoding
+*TelestreamCloud::Flip::FlipApi* | [**create_factory**](docs/FlipApi.md#create_factory) | **POST** /factories.json | Creates a new factory
+*TelestreamCloud::Flip::FlipApi* | [**create_profile**](docs/FlipApi.md#create_profile) | **POST** /profiles.json | Creates a Profile
+*TelestreamCloud::Flip::FlipApi* | [**create_video**](docs/FlipApi.md#create_video) | **POST** /videos.json | Creates a Video from a provided source_url.
+*TelestreamCloud::Flip::FlipApi* | [**create_workorder**](docs/FlipApi.md#create_workorder) | **POST** /workorders.json | Creates a Workorder.
+*TelestreamCloud::Flip::FlipApi* | [**delete_encoding**](docs/FlipApi.md#delete_encoding) | **DELETE** /encodings/{id}.json | Deletes an Encoding from both Telestream Cloud and your storage. Returns an information whether the operation was successful.
+*TelestreamCloud::Flip::FlipApi* | [**delete_profile**](docs/FlipApi.md#delete_profile) | **DELETE** /profiles/{id}.json | Deletes a given Profile
+*TelestreamCloud::Flip::FlipApi* | [**delete_video**](docs/FlipApi.md#delete_video) | **DELETE** /videos/{id}.json | Deletes a Video object.
+*TelestreamCloud::Flip::FlipApi* | [**delete_video_source**](docs/FlipApi.md#delete_video_source) | **DELETE** /videos/{id}/source.json | Delete a video's source file.
+*TelestreamCloud::Flip::FlipApi* | [**encoding**](docs/FlipApi.md#encoding) | **GET** /encodings/{id}.json | Returns an Encoding object.
+*TelestreamCloud::Flip::FlipApi* | [**encodings**](docs/FlipApi.md#encodings) | **GET** /encodings.json | Returns a list of Encoding objects
+*TelestreamCloud::Flip::FlipApi* | [**encodings_count**](docs/FlipApi.md#encodings_count) | **GET** /encodings/count.json | Returns a number of Encoding objects created using a given factory.
+*TelestreamCloud::Flip::FlipApi* | [**factories**](docs/FlipApi.md#factories) | **GET** /factories.json | Returns a collection of Factory objects.
+*TelestreamCloud::Flip::FlipApi* | [**factory**](docs/FlipApi.md#factory) | **GET** /factories/{id}.json | Returns a Factory object.
+*TelestreamCloud::Flip::FlipApi* | [**notifications**](docs/FlipApi.md#notifications) | **GET** /notifications.json | Returns a Factory's notification settings.
+*TelestreamCloud::Flip::FlipApi* | [**profile**](docs/FlipApi.md#profile) | **GET** /profiles/{id_or_name}.json | Returns a Profile object.
+*TelestreamCloud::Flip::FlipApi* | [**profile_encodings**](docs/FlipApi.md#profile_encodings) | **GET** /profiles/{id_or_name}/encodings.json | Returns a list of Encodings that belong to a Profile.
+*TelestreamCloud::Flip::FlipApi* | [**profiles**](docs/FlipApi.md#profiles) | **GET** /profiles.json | Returns a collection of Profile objects.
+*TelestreamCloud::Flip::FlipApi* | [**queued_videos**](docs/FlipApi.md#queued_videos) | **GET** /videos/queued.json | Returns a collection of Video objects queued for encoding.
+*TelestreamCloud::Flip::FlipApi* | [**resubmit_video**](docs/FlipApi.md#resubmit_video) | **POST** /videos/resubmit.json | Resubmits a video to encode.
+*TelestreamCloud::Flip::FlipApi* | [**retry_encoding**](docs/FlipApi.md#retry_encoding) | **POST** /encodings/{id}/retry.json | Retries a failed encoding.
+*TelestreamCloud::Flip::FlipApi* | [**signed_encoding_url**](docs/FlipApi.md#signed_encoding_url) | **GET** /encodings/{id}/signed-url.json | Returns a signed url pointing to an Encoding.
+*TelestreamCloud::Flip::FlipApi* | [**signed_encoding_urls**](docs/FlipApi.md#signed_encoding_urls) | **GET** /encodings/{id}/signed-urls.json | Returns a list of signed urls pointing to an Encoding's outputs.
+*TelestreamCloud::Flip::FlipApi* | [**signed_video_url**](docs/FlipApi.md#signed_video_url) | **GET** /videos/{id}/signed-url.json | Returns a signed url pointing to a Video.
+*TelestreamCloud::Flip::FlipApi* | [**toggle_factory_sync**](docs/FlipApi.md#toggle_factory_sync) | **POST** /factories/{id}/sync.json | Toggles synchronisation settings.
+*TelestreamCloud::Flip::FlipApi* | [**update_encoding**](docs/FlipApi.md#update_encoding) | **PUT** /encodings/{id}.json | Updates an Encoding
+*TelestreamCloud::Flip::FlipApi* | [**update_factory**](docs/FlipApi.md#update_factory) | **PATCH** /factories/{id}.json | Updates a Factory's settings. Returns a Factory object.
+*TelestreamCloud::Flip::FlipApi* | [**update_notifications**](docs/FlipApi.md#update_notifications) | **PUT** /notifications.json | Updates a Factory's notification settings.
+*TelestreamCloud::Flip::FlipApi* | [**update_profile**](docs/FlipApi.md#update_profile) | **PUT** /profiles/{id}.json | Updates a given Profile
+*TelestreamCloud::Flip::FlipApi* | [**upload_video**](docs/FlipApi.md#upload_video) | **POST** /videos/upload.json | Creates an upload session.
+*TelestreamCloud::Flip::FlipApi* | [**video**](docs/FlipApi.md#video) | **GET** /videos/{id}.json | Returns a Video object.
+*TelestreamCloud::Flip::FlipApi* | [**video_encodings**](docs/FlipApi.md#video_encodings) | **GET** /videos/{id}/encodings.json | Returns a list of Encodings that belong to a Video.
+*TelestreamCloud::Flip::FlipApi* | [**video_metadata**](docs/FlipApi.md#video_metadata) | **GET** /videos/{id}/metadata.json | Returns a Video's metadata
+*TelestreamCloud::Flip::FlipApi* | [**videos**](docs/FlipApi.md#videos) | **GET** /videos.json | Returns a collection of Video objects.
+*TelestreamCloud::Flip::FlipApi* | [**workflows**](docs/FlipApi.md#workflows) | **GET** /workflows.json | Returns a collection of Workflows that belong to a Factory.
+
+
+## Documentation for Models
+
+ - [TelestreamCloud::Flip::CanceledResponse](docs/CanceledResponse.md)
+ - [TelestreamCloud::Flip::CloudNotificationSettings](docs/CloudNotificationSettings.md)
+ - [TelestreamCloud::Flip::CloudNotificationSettingsEvents](docs/CloudNotificationSettingsEvents.md)
+ - [TelestreamCloud::Flip::CopyProfileBody](docs/CopyProfileBody.md)
+ - [TelestreamCloud::Flip::CountResponse](docs/CountResponse.md)
+ - [TelestreamCloud::Flip::CreateEncodingBody](docs/CreateEncodingBody.md)
+ - [TelestreamCloud::Flip::CreateVideoBody](docs/CreateVideoBody.md)
+ - [TelestreamCloud::Flip::DeletedResponse](docs/DeletedResponse.md)
+ - [TelestreamCloud::Flip::Encoding](docs/Encoding.md)
+ - [TelestreamCloud::Flip::EncodingSignedUrl](docs/EncodingSignedUrl.md)
+ - [TelestreamCloud::Flip::EncodingSignedUrls](docs/EncodingSignedUrls.md)
+ - [TelestreamCloud::Flip::Error](docs/Error.md)
+ - [TelestreamCloud::Flip::ExtraFile](docs/ExtraFile.md)
+ - [TelestreamCloud::Flip::Factory](docs/Factory.md)
+ - [TelestreamCloud::Flip::FactoryBody](docs/FactoryBody.md)
+ - [TelestreamCloud::Flip::FactoryBodyStorageCredentialAttributes](docs/FactoryBodyStorageCredentialAttributes.md)
+ - [TelestreamCloud::Flip::FactorySync](docs/FactorySync.md)
+ - [TelestreamCloud::Flip::FactorySyncBody](docs/FactorySyncBody.md)
+ - [TelestreamCloud::Flip::PaginatedEncodingsCollection](docs/PaginatedEncodingsCollection.md)
+ - [TelestreamCloud::Flip::PaginatedFactoryCollection](docs/PaginatedFactoryCollection.md)
+ - [TelestreamCloud::Flip::PaginatedProfilesCollection](docs/PaginatedProfilesCollection.md)
+ - [TelestreamCloud::Flip::PaginatedVideoCollection](docs/PaginatedVideoCollection.md)
+ - [TelestreamCloud::Flip::PaginatedWorkflowsCollection](docs/PaginatedWorkflowsCollection.md)
+ - [TelestreamCloud::Flip::Profile](docs/Profile.md)
+ - [TelestreamCloud::Flip::ProfileBody](docs/ProfileBody.md)
+ - [TelestreamCloud::Flip::ResubmitVideoBody](docs/ResubmitVideoBody.md)
+ - [TelestreamCloud::Flip::RetriedResponse](docs/RetriedResponse.md)
+ - [TelestreamCloud::Flip::SignedVideoUrl](docs/SignedVideoUrl.md)
+ - [TelestreamCloud::Flip::UpdateEncodingBody](docs/UpdateEncodingBody.md)
+ - [TelestreamCloud::Flip::UploadSession](docs/UploadSession.md)
+ - [TelestreamCloud::Flip::Video](docs/Video.md)
+ - [TelestreamCloud::Flip::VideoMetadata](docs/VideoMetadata.md)
+ - [TelestreamCloud::Flip::VideoUploadBody](docs/VideoUploadBody.md)
+
+
+## Documentation for Authorization
+
+
+### api_key
+
+- **Type**: API key
+- **API key parameter name**: X-Api-Key
+- **Location**: HTTP header
+

data/flip/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/flip/docs/CanceledResponse.md

@@ -0,0 +1,8 @@
+# TelestreamCloud::Flip::CanceledResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**canceled** | **BOOLEAN** | Informs whether an action has been canceled successfully. | [optional] 
+
+

data/flip/docs/CloudNotificationSettings.md

@@ -0,0 +1,11 @@
+# TelestreamCloud::Flip::CloudNotificationSettings
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | Notifications will be sent to this endpoint. | 
+**delay** | **Integer** |  | 
+**send_video_payload** | **BOOLEAN** | Determines whether a video payload will be included in notification messages. | 
+**events** | [**CloudNotificationSettingsEvents**](CloudNotificationSettingsEvents.md) |  | 
+
+

data/flip/docs/CloudNotificationSettingsEvents.md

@@ -0,0 +1,11 @@
+# TelestreamCloud::Flip::CloudNotificationSettingsEvents
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**encoding_completed** | **BOOLEAN** | If set to `true`, a notification will be sent after an encoding becomes complete. | 
+**encoding_progress** | **BOOLEAN** | If set to `true`, a notification will be sent after an encoding's progess changes. | 
+**video_created** | **BOOLEAN** | If set to `true`, a notification will be sent after a video is created. | 
+**video_encoded** | **BOOLEAN** | If set to `true`, a notification will be sent after a video is encoded. | 
+
+

data/flip/docs/CopyProfileBody.md

@@ -0,0 +1,9 @@
+# TelestreamCloud::Flip::CopyProfileBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**dest_factory_id** | **String** | an id of a target Factory that will own a copy of the Profile | 
+**profile_name** | **String** | a name for a copy of the Profile | 
+
+

data/flip/docs/CountResponse.md

@@ -0,0 +1,8 @@
+# TelestreamCloud::Flip::CountResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **Integer** | Informs how many objects are stored in the database. | [optional] 
+
+

data/flip/docs/CreateEncodingBody.md

@@ -0,0 +1,10 @@
+# TelestreamCloud::Flip::CreateEncodingBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**video_id** | **String** | Id of a Video that will be encoded. | 
+**profile_id** | **String** | Id of a Profile that will be used for encoding. | [optional] 
+**profile_name** | **String** | A name of a Profile that will be used for encoding. | [optional] 
+
+

data/flip/docs/CreateVideoBody.md

@@ -0,0 +1,12 @@
+# TelestreamCloud::Flip::CreateVideoBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**source_url** | **String** | An URL pointing to a source file. | [optional] 
+**profiles** | **String** | Comma-separated list of profile names or IDs to be used during encoding. Alternatively, specify none so no encodings are created yet. | [optional] 
+**payload** | **String** | Arbitrary string stored along the Video object. | [optional] 
+**pipeline** | **String** | String-encoded JSON describing profiles pipeline. | [optional] 
+**subtitle_files** | **Array<String>** | A list of urls pointing to remote subtitle files. | [optional] 
+
+

data/flip/docs/DeletedResponse.md

@@ -0,0 +1,8 @@
+# TelestreamCloud::Flip::DeletedResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**deleted** | **BOOLEAN** | Informs whether an object has been deleted successfully. | [optional] 
+
+

data/flip/docs/Encoding.md

@@ -0,0 +1,38 @@
+# TelestreamCloud::Flip::Encoding
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | A unique identifier of an Encoding. | [optional] 
+**audio_bitrate** | **Integer** | Audio bitrate (in bits/s). | [optional] 
+**audio_channels** | **Integer** | A number of audio channels. | [optional] 
+**audio_codec** | **String** | A codec that is used to encode audio streams. | [optional] 
+**audio_sample_rate** | **String** | A number of samples of audio carried per second. | [optional] 
+**created_at** | **String** | A date and time when the Encoding has been created. | [optional] 
+**duration** | **String** |  | [optional] 
+**encoding_progress** | **String** |  | [optional] 
+**encoding_time** | **String** |  | [optional] 
+**error_class** | **String** | A class of an error that has occurred during the encoding process. It is present only if the encoding status is equal to `fail`. | [optional] 
+**error_message** | **String** | A message that explains why the encoding process has resulted in an error. It is present only if the encoding status is equal to `fail`. | [optional] 
+**external_id** | **String** |  | [optional] 
+**extname** | **String** | Extension of the output file. | [optional] 
+**file_size** | **String** | A size of the output file. | [optional] 
+**files** | **Array<String>** | An array of output file names. | [optional] 
+**fps** | **String** | Number of frames per second. | [optional] 
+**height** | **String** | Height of the output video. | [optional] 
+**width** | **String** | Width of the output video. | [optional] 
+**logfile_url** | **String** | An URL pointing to a logfile. | [optional] 
+**mime_type** | **String** | A mime type of the encoded file. | [optional] 
+**parent_encoding_id** | **String** |  | [optional] 
+**path** | **String** |  | [optional] 
+**profile_id** | **String** | An id of a related Profile. | [optional] 
+**profile_name** | **String** | A name of the used Profile. | [optional] 
+**screenshots** | **Array<String>** |  | [optional] 
+**started_encoding_at** | **String** | A date and time when the encoding process has been started | [optional] 
+**status** | **String** | Determines at what stage the encoding process is at the moment. | [optional] 
+**updated_at** | **String** | A date and time when a Encoding has been updated last time. | [optional] 
+**video_bitrate** | **String** | video bitrate (in bits/s) | [optional] 
+**video_codec** | **String** | A codec that is used to encode video streams. | [optional] 
+**video_id** | **String** | An id of a related Video object | [optional] 
+
+

data/flip/docs/EncodingSignedUrl.md

@@ -0,0 +1,8 @@
+# TelestreamCloud::Flip::EncodingSignedUrl
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**signed_url** | **String** | A signed URLs pointing to the encoding's output. | [optional] 
+
+

data/flip/docs/EncodingSignedUrls.md

@@ -0,0 +1,8 @@
+# TelestreamCloud::Flip::EncodingSignedUrls
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**signed_urls** | **Array<String>** | A list of signed URLs pointing to the encoding's outputs. | [optional] 
+
+

data/flip/docs/Error.md

@@ -0,0 +1,9 @@
+# TelestreamCloud::Flip::Error
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | **String** | Error type | [optional] 
+**message** | **String** | Explanation why the error has been raised. | [optional] 
+
+

data/flip/docs/ExtraFile.md

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

data/flip/docs/Factory.md

@@ -0,0 +1,25 @@
+# TelestreamCloud::Flip::Factory
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | A unique identifier of a Factory. | [optional] 
+**name** | **String** | Human-readable identifier of a Factory. | [optional] 
+**factory_region** | **String** | A region where the factory is located. | [optional] 
+**output_bucket_name** | **String** | A bucket where processed files will be stored. | [optional] 
+**acl** | **String** | Specify if your files are public or private (private files need authorization url to access). By default this is not set. | [optional] 
+**created_at** | **String** | A date and time when a Factory has been created. | [optional] 
+**updated_at** | **String** | A date and time when a Factory has been updated last time. | [optional] 
+**url** | **String** | An URL pointing to the output_bucket_name. | [optional] 
+**server_side_encryption** | **BOOLEAN** | Specify if you want to use multi-factor server-side 256-bit AES-256 data encryption with Amazon S3-managed encryption keys (SSE-S3). Each object is encrypted using a unique key which as an additional safeguard is encrypted itself with a master key that S3 regularly rotates. By default this is not set. | [optional] 
+**input_bucket_name** | **String** | A name of an input bucket. | [optional] 
+**input_bucket_watch** | **BOOLEAN** | Determines whether the Factory should be notified about new files added to the input bucket. | [optional] 
+**input_bucket_files_map** | **String** |  | [optional] 
+**input_bucket_sync_every_n_min** | **String** | Determines how often the input bucket is synchronised. | [optional] 
+**input_bucket_recursive** | **String** |  | [optional] 
+**input_bucket_file_pattern** | **String** | A pattern that will be used to locate files in the input bucket. Valid wildcards might be used. | [optional] 
+**outputs_path_format** | **String** |  | [optional] 
+**storage_provider** | **Integer** | Specifies which storage provider the factory should use. Available options: S3: 0, Google Cloud Storage: 1, FTP storage: 2, Google Cloud Interoperability Storage: 5, Flip storage: 7, FASP storage: 8, Azure Blob Storage: 9 | [optional] 
+**provider_specific_settings** | **Object** |  | [optional] 
+
+

data/flip/docs/FactoryBody.md

@@ -0,0 +1,23 @@
+# TelestreamCloud::Flip::FactoryBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**aws_access_key** | **String** | AWS access key. | [optional] 
+**aws_secret_key** | **String** | AWS secret key. | [optional] 
+**factory_region** | **String** | A region where the factory is located. | [optional] 
+**input_bucket_file_pattern** | **String** | A pattern that will be used to locate files in the input bucket. Valid wildcards might be used. | [optional] 
+**input_bucket_name** | **String** | A name of an input bucket. | [optional] 
+**input_bucket_recursive** | **BOOLEAN** |  | [optional] 
+**input_bucket_sync_every_n_min** | **Integer** | Determines how often the input bucket is synchronised. | [optional] 
+**input_bucket_watch** | **BOOLEAN** | Determines whether the Factory should be notified about new files added to the input bucket. | [optional] 
+**name** | **String** | Name of the Factory. | 
+**outputs_path_format** | **String** | Specify the directory where the output files should be stored. By default it is not set. More info [here](https://cloud.telestream.net/docs#path-format---know-how). | [optional] 
+**provider_specific_settings** | **Object** |  | [optional] 
+**acl** | **String** | Specify if your files are public or private (private files need authorization url to access). By default this is not set. | [optional] 
+**output_bucket_name** | **String** | A bucket where processed files will be stored. | [optional] 
+**server_side_encryption** | **BOOLEAN** | Specify if you want to use multi-factor server-side 256-bit AES-256 data encryption with Amazon S3-managed encryption keys (SSE-S3). Each object is encrypted using a unique key which as an additional safeguard is encrypted itself with a master key that S3 regularly rotates. By default this is not set. | [optional] 
+**storage_credential_attributes** | [**FactoryBodyStorageCredentialAttributes**](FactoryBodyStorageCredentialAttributes.md) |  | [optional] 
+**storage_provider** | **Integer** | Specifies which storage provider the factory should use. Available options: S3: 0, Google Cloud Storage: 1, FTP storage: 2, Google Cloud Interoperability Storage: 5, Flip storage: 7, FASP storage: 8, Azure Blob Storage: 9 | [optional] 
+
+

data/flip/docs/FactoryBodyStorageCredentialAttributes.md

@@ -0,0 +1,11 @@
+# TelestreamCloud::Flip::FactoryBodyStorageCredentialAttributes
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**host** | **String** |  | [optional] 
+**username** | **String** |  | [optional] 
+**password** | **String** |  | [optional] 
+**port** | **Integer** |  | [optional] 
+
+

data/flip/docs/FactorySync.md

@@ -0,0 +1,8 @@
+# TelestreamCloud::Flip::FactorySync
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**syncing** | **String** | Determines whether a Factory will be synchronised with an input bucket. | [optional] 
+
+

data/flip/docs/FactorySyncBody.md

@@ -0,0 +1,8 @@
+# TelestreamCloud::Flip::FactorySyncBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sync** | **String** | Determines whether a Factory's data will be synchronised. | 
+
+

data/flip/docs/FlipApi.md

@@ -0,0 +1,2179 @@
+# TelestreamCloud::Flip::FlipApi
+
+All URIs are relative to *https://api.cloud.telestream.net/flip/3.1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**cancel_encoding**](FlipApi.md#cancel_encoding) | **POST** /encodings/{id}/cancel.json | Cancels an Encoding.
+[**copy_profile**](FlipApi.md#copy_profile) | **POST** /profiles/{id}/copy.json | Copies a given Profile
+[**create_encoding**](FlipApi.md#create_encoding) | **POST** /encodings.json | Creates an Encoding
+[**create_factory**](FlipApi.md#create_factory) | **POST** /factories.json | Creates a new factory
+[**create_profile**](FlipApi.md#create_profile) | **POST** /profiles.json | Creates a Profile
+[**create_video**](FlipApi.md#create_video) | **POST** /videos.json | Creates a Video from a provided source_url.
+[**create_workorder**](FlipApi.md#create_workorder) | **POST** /workorders.json | Creates a Workorder.
+[**delete_encoding**](FlipApi.md#delete_encoding) | **DELETE** /encodings/{id}.json | Deletes an Encoding from both Telestream Cloud and your storage. Returns an information whether the operation was successful.
+[**delete_profile**](FlipApi.md#delete_profile) | **DELETE** /profiles/{id}.json | Deletes a given Profile
+[**delete_video**](FlipApi.md#delete_video) | **DELETE** /videos/{id}.json | Deletes a Video object.
+[**delete_video_source**](FlipApi.md#delete_video_source) | **DELETE** /videos/{id}/source.json | Delete a video's source file.
+[**encoding**](FlipApi.md#encoding) | **GET** /encodings/{id}.json | Returns an Encoding object.
+[**encodings**](FlipApi.md#encodings) | **GET** /encodings.json | Returns a list of Encoding objects
+[**encodings_count**](FlipApi.md#encodings_count) | **GET** /encodings/count.json | Returns a number of Encoding objects created using a given factory.
+[**factories**](FlipApi.md#factories) | **GET** /factories.json | Returns a collection of Factory objects.
+[**factory**](FlipApi.md#factory) | **GET** /factories/{id}.json | Returns a Factory object.
+[**notifications**](FlipApi.md#notifications) | **GET** /notifications.json | Returns a Factory's notification settings.
+[**profile**](FlipApi.md#profile) | **GET** /profiles/{id_or_name}.json | Returns a Profile object.
+[**profile_encodings**](FlipApi.md#profile_encodings) | **GET** /profiles/{id_or_name}/encodings.json | Returns a list of Encodings that belong to a Profile.
+[**profiles**](FlipApi.md#profiles) | **GET** /profiles.json | Returns a collection of Profile objects.
+[**queued_videos**](FlipApi.md#queued_videos) | **GET** /videos/queued.json | Returns a collection of Video objects queued for encoding.
+[**resubmit_video**](FlipApi.md#resubmit_video) | **POST** /videos/resubmit.json | Resubmits a video to encode.
+[**retry_encoding**](FlipApi.md#retry_encoding) | **POST** /encodings/{id}/retry.json | Retries a failed encoding.
+[**signed_encoding_url**](FlipApi.md#signed_encoding_url) | **GET** /encodings/{id}/signed-url.json | Returns a signed url pointing to an Encoding.
+[**signed_encoding_urls**](FlipApi.md#signed_encoding_urls) | **GET** /encodings/{id}/signed-urls.json | Returns a list of signed urls pointing to an Encoding's outputs.
+[**signed_video_url**](FlipApi.md#signed_video_url) | **GET** /videos/{id}/signed-url.json | Returns a signed url pointing to a Video.
+[**toggle_factory_sync**](FlipApi.md#toggle_factory_sync) | **POST** /factories/{id}/sync.json | Toggles synchronisation settings.
+[**update_encoding**](FlipApi.md#update_encoding) | **PUT** /encodings/{id}.json | Updates an Encoding
+[**update_factory**](FlipApi.md#update_factory) | **PATCH** /factories/{id}.json | Updates a Factory's settings. Returns a Factory object.
+[**update_notifications**](FlipApi.md#update_notifications) | **PUT** /notifications.json | Updates a Factory's notification settings.
+[**update_profile**](FlipApi.md#update_profile) | **PUT** /profiles/{id}.json | Updates a given Profile
+[**upload_video**](FlipApi.md#upload_video) | **POST** /videos/upload.json | Creates an upload session.
+[**video**](FlipApi.md#video) | **GET** /videos/{id}.json | Returns a Video object.
+[**video_encodings**](FlipApi.md#video_encodings) | **GET** /videos/{id}/encodings.json | Returns a list of Encodings that belong to a Video.
+[**video_metadata**](FlipApi.md#video_metadata) | **GET** /videos/{id}/metadata.json | Returns a Video's metadata
+[**videos**](FlipApi.md#videos) | **GET** /videos.json | Returns a collection of Video objects.
+[**workflows**](FlipApi.md#workflows) | **GET** /workflows.json | Returns a collection of Workflows that belong to a Factory.
+
+
+# **cancel_encoding**
+> CanceledResponse cancel_encoding(id, factory_id)
+
+Cancels an Encoding.
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+id = "id_example" # String | Id of an Encoding.
+
+factory_id = "factory_id_example" # String | Id of a Factory.
+
+
+begin
+  #Cancels an Encoding.
+  result = api_instance.cancel_encoding(id, factory_id)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->cancel_encoding: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Id of an Encoding. | 
+ **factory_id** | **String**| Id of a Factory. | 
+
+### Return type
+
+[**CanceledResponse**](CanceledResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **copy_profile**
+> Profile copy_profile(id, factory_id, copy_profile_body, opts)
+
+Copies a given Profile
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+id = "id_example" # String | Id of a Profile.
+
+factory_id = "factory_id_example" # String | Id of a Factory.
+
+copy_profile_body = TelestreamCloud::Flip::CopyProfileBody.new # CopyProfileBody | 
+
+opts = { 
+  expand: true # BOOLEAN | If expand option is set Profile objects will contain all command parameters, even if their value is default. By default this is not set.
+}
+
+begin
+  #Copies a given Profile
+  result = api_instance.copy_profile(id, factory_id, copy_profile_body, opts)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->copy_profile: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Id of a Profile. | 
+ **factory_id** | **String**| Id of a Factory. | 
+ **copy_profile_body** | [**CopyProfileBody**](CopyProfileBody.md)|  | 
+ **expand** | **BOOLEAN**| If expand option is set Profile objects will contain all command parameters, even if their value is default. By default this is not set. | [optional] 
+
+### Return type
+
+[**Profile**](Profile.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_encoding**
+> Encoding create_encoding(factory_id, create_encoding_body, opts)
+
+Creates an Encoding
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+factory_id = "factory_id_example" # String | Id of a Factory.
+
+create_encoding_body = TelestreamCloud::Flip::CreateEncodingBody.new # CreateEncodingBody | 
+
+opts = { 
+  screenshots: true, # BOOLEAN | Determines whether the response will include screenshots. By default this is not set.
+  precise_status: true # BOOLEAN | Determines whether the response will include a precise status. By default this is not set.
+}
+
+begin
+  #Creates an Encoding
+  result = api_instance.create_encoding(factory_id, create_encoding_body, opts)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->create_encoding: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **factory_id** | **String**| Id of a Factory. | 
+ **create_encoding_body** | [**CreateEncodingBody**](CreateEncodingBody.md)|  | 
+ **screenshots** | **BOOLEAN**| Determines whether the response will include screenshots. By default this is not set. | [optional] 
+ **precise_status** | **BOOLEAN**| Determines whether the response will include a precise status. By default this is not set. | [optional] 
+
+### Return type
+
+[**Encoding**](Encoding.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_factory**
+> Factory create_factory(create_factory_body, opts)
+
+Creates a new factory
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+create_factory_body = TelestreamCloud::Flip::FactoryBody.new # FactoryBody | 
+
+opts = { 
+  with_storage_provider: true # BOOLEAN | if set to `true`, results will include a storage provider's id
+}
+
+begin
+  #Creates a new factory
+  result = api_instance.create_factory(create_factory_body, opts)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->create_factory: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_factory_body** | [**FactoryBody**](FactoryBody.md)|  | 
+ **with_storage_provider** | **BOOLEAN**| if set to `true`, results will include a storage provider's id | [optional] 
+
+### Return type
+
+[**Factory**](Factory.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_profile**
+> Profile create_profile(factory_id, create_profile_body, opts)
+
+Creates a Profile
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+factory_id = "factory_id_example" # String | Id of a Factory.
+
+create_profile_body = TelestreamCloud::Flip::ProfileBody.new # ProfileBody | 
+
+opts = { 
+  exclude_advanced_services: true, # BOOLEAN | 
+  expand: true # BOOLEAN | If expand option is set Profile objects will contain all command parameters, even if their value is default. By default it is not set.
+}
+
+begin
+  #Creates a Profile
+  result = api_instance.create_profile(factory_id, create_profile_body, opts)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->create_profile: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **factory_id** | **String**| Id of a Factory. | 
+ **create_profile_body** | [**ProfileBody**](ProfileBody.md)|  | 
+ **exclude_advanced_services** | **BOOLEAN**|  | [optional] 
+ **expand** | **BOOLEAN**| If expand option is set Profile objects will contain all command parameters, even if their value is default. By default it is not set. | [optional] 
+
+### Return type
+
+[**Profile**](Profile.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_video**
+> Video create_video(factory_id, create_video_body)
+
+Creates a Video from a provided source_url.
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+factory_id = "factory_id_example" # String | Id of a Factory.
+
+create_video_body = TelestreamCloud::Flip::CreateVideoBody.new # CreateVideoBody | 
+
+
+begin
+  #Creates a Video from a provided source_url.
+  result = api_instance.create_video(factory_id, create_video_body)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->create_video: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **factory_id** | **String**| Id of a Factory. | 
+ **create_video_body** | [**CreateVideoBody**](CreateVideoBody.md)|  | 
+
+### Return type
+
+[**Video**](Video.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_workorder**
+> create_workorder(factory_id, opts)
+
+Creates a Workorder.
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+factory_id = "factory_id_example" # String | Id of a Factory.
+
+opts = { 
+  profile_id: "profile_id_example", # String | Id of a Profile.
+  file: File.new("/path/to/file.txt"), # File | Input file.
+  source_url: "source_url_example" # String | URL pointing to an input file.
+}
+
+begin
+  #Creates a Workorder.
+  api_instance.create_workorder(factory_id, opts)
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->create_workorder: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **factory_id** | **String**| Id of a Factory. | 
+ **profile_id** | **String**| Id of a Profile. | [optional] 
+ **file** | **File**| Input file. | [optional] 
+ **source_url** | **String**| URL pointing to an input file. | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+
+
+# **delete_encoding**
+> DeletedResponse delete_encoding(id, factory_id)
+
+Deletes an Encoding from both Telestream Cloud and your storage. Returns an information whether the operation was successful.
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+id = "id_example" # String | Id of an Encoding.
+
+factory_id = "factory_id_example" # String | Id of a Factory.
+
+
+begin
+  #Deletes an Encoding from both Telestream Cloud and your storage. Returns an information whether the operation was successful.
+  result = api_instance.delete_encoding(id, factory_id)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->delete_encoding: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Id of an Encoding. | 
+ **factory_id** | **String**| Id of a Factory. | 
+
+### Return type
+
+[**DeletedResponse**](DeletedResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_profile**
+> DeletedResponse delete_profile(id, factory_id)
+
+Deletes a given Profile
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+id = "id_example" # String | Id of a Profile
+
+factory_id = "factory_id_example" # String | Id of a Factory.
+
+
+begin
+  #Deletes a given Profile
+  result = api_instance.delete_profile(id, factory_id)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->delete_profile: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Id of a Profile | 
+ **factory_id** | **String**| Id of a Factory. | 
+
+### Return type
+
+[**DeletedResponse**](DeletedResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_video**
+> DeletedResponse delete_video(id, factory_id)
+
+Deletes a Video object.
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+id = "id_example" # String | Id of a Video.
+
+factory_id = "factory_id_example" # String | Id of a Factory.
+
+
+begin
+  #Deletes a Video object.
+  result = api_instance.delete_video(id, factory_id)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->delete_video: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Id of a Video. | 
+ **factory_id** | **String**| Id of a Factory. | 
+
+### Return type
+
+[**DeletedResponse**](DeletedResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_video_source**
+> DeletedResponse delete_video_source(id, factory_id)
+
+Delete a video's source file.
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+id = "id_example" # String | Id of a Video.
+
+factory_id = "factory_id_example" # String | Id of a Factory.
+
+
+begin
+  #Delete a video's source file.
+  result = api_instance.delete_video_source(id, factory_id)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->delete_video_source: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Id of a Video. | 
+ **factory_id** | **String**| Id of a Factory. | 
+
+### Return type
+
+[**DeletedResponse**](DeletedResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **encoding**
+> Encoding encoding(id, factory_id, opts)
+
+Returns an Encoding object.
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+id = "id_example" # String | Id of an Encoding.
+
+factory_id = "factory_id_example" # String | Id of a Factory.
+
+opts = { 
+  screenshots: true, # BOOLEAN | Determines whether the response will include screenshots. By default this is not set.
+  precise_status: true # BOOLEAN | Determines whether the response will include a precise status. By default this is not set.
+}
+
+begin
+  #Returns an Encoding object.
+  result = api_instance.encoding(id, factory_id, opts)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->encoding: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Id of an Encoding. | 
+ **factory_id** | **String**| Id of a Factory. | 
+ **screenshots** | **BOOLEAN**| Determines whether the response will include screenshots. By default this is not set. | [optional] 
+ **precise_status** | **BOOLEAN**| Determines whether the response will include a precise status. By default this is not set. | [optional] 
+
+### Return type
+
+[**Encoding**](Encoding.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **encodings**
+> PaginatedEncodingsCollection encodings(factory_id, opts)
+
+Returns a list of Encoding objects
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+factory_id = "factory_id_example" # String | Id of a Factory.
+
+opts = { 
+  video_id: "video_id_example", # String | Id of a Video. When specified, the resulting list will contain videos that belong to the Video.
+  status: "status_example", # String | One of `success`, `fail`, `processing`. When specified, the resulting list will contain ecodings filtered by status.
+  profile_id: "profile_id_example", # String | Filter by profile_id.
+  profile_name: "profile_name_example", # String | Filter by profile_name.
+  page: 56, # Integer | A page to be fetched. Default is `1`.
+  per_page: 56, # Integer | A number of results per page. Default is `100`.
+  screenshots: true, # BOOLEAN | Determines whether the response will include screenshots. By default this is not set.
+  precise_status: true # BOOLEAN | Determines whether the response will include a precise status. By default this is not set.
+}
+
+begin
+  #Returns a list of Encoding objects
+  result = api_instance.encodings(factory_id, opts)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->encodings: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **factory_id** | **String**| Id of a Factory. | 
+ **video_id** | **String**| Id of a Video. When specified, the resulting list will contain videos that belong to the Video. | [optional] 
+ **status** | **String**| One of `success`, `fail`, `processing`. When specified, the resulting list will contain ecodings filtered by status. | [optional] 
+ **profile_id** | **String**| Filter by profile_id. | [optional] 
+ **profile_name** | **String**| Filter by profile_name. | [optional] 
+ **page** | **Integer**| A page to be fetched. Default is `1`. | [optional] 
+ **per_page** | **Integer**| A number of results per page. Default is `100`. | [optional] 
+ **screenshots** | **BOOLEAN**| Determines whether the response will include screenshots. By default this is not set. | [optional] 
+ **precise_status** | **BOOLEAN**| Determines whether the response will include a precise status. By default this is not set. | [optional] 
+
+### Return type
+
+[**PaginatedEncodingsCollection**](PaginatedEncodingsCollection.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **encodings_count**
+> CountResponse encodings_count(factory_id)
+
+Returns a number of Encoding objects created using a given factory.
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+factory_id = "factory_id_example" # String | Id of a Factory.
+
+
+begin
+  #Returns a number of Encoding objects created using a given factory.
+  result = api_instance.encodings_count(factory_id)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->encodings_count: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **factory_id** | **String**| Id of a Factory. | 
+
+### Return type
+
+[**CountResponse**](CountResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **factories**
+> PaginatedFactoryCollection factories(opts)
+
+Returns a collection of Factory objects.
+
+Returns a collection of Factory objects.
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+opts = { 
+  page: 56, # Integer | A page to be fetched. Default is `1`.
+  per_page: 56, # Integer | A number of results per page. Default is `100`.
+  with_storage_provider: true # BOOLEAN | if set to `true`, results will include a storage provider's id
+}
+
+begin
+  #Returns a collection of Factory objects.
+  result = api_instance.factories(opts)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->factories: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **Integer**| A page to be fetched. Default is `1`. | [optional] 
+ **per_page** | **Integer**| A number of results per page. Default is `100`. | [optional] 
+ **with_storage_provider** | **BOOLEAN**| if set to `true`, results will include a storage provider's id | [optional] 
+
+### Return type
+
+[**PaginatedFactoryCollection**](PaginatedFactoryCollection.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **factory**
+> Factory factory(id, opts)
+
+Returns a Factory object.
+
+Returns a Factory object.
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+id = "id_example" # String | id of a factory
+
+opts = { 
+  with_storage_provider: true # BOOLEAN | if set to `true`, results will include a storage provider's id
+}
+
+begin
+  #Returns a Factory object.
+  result = api_instance.factory(id, opts)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->factory: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| id of a factory | 
+ **with_storage_provider** | **BOOLEAN**| if set to `true`, results will include a storage provider's id | [optional] 
+
+### Return type
+
+[**Factory**](Factory.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **notifications**
+> CloudNotificationSettings notifications(factory_id)
+
+Returns a Factory's notification settings.
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+factory_id = "factory_id_example" # String | Id of a Factory.
+
+
+begin
+  #Returns a Factory's notification settings.
+  result = api_instance.notifications(factory_id)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->notifications: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **factory_id** | **String**| Id of a Factory. | 
+
+### Return type
+
+[**CloudNotificationSettings**](CloudNotificationSettings.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **profile**
+> Profile profile(id_or_name, factory_id, opts)
+
+Returns a Profile object.
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+id_or_name = "id_or_name_example" # String | A name or an id of a Profile.
+
+factory_id = "factory_id_example" # String | Id of a Factory.
+
+opts = { 
+  expand: true # BOOLEAN | If expand option is set Profile objects will contain all command parameters, even if their value is default. By default this is not set.
+}
+
+begin
+  #Returns a Profile object.
+  result = api_instance.profile(id_or_name, factory_id, opts)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->profile: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id_or_name** | **String**| A name or an id of a Profile. | 
+ **factory_id** | **String**| Id of a Factory. | 
+ **expand** | **BOOLEAN**| If expand option is set Profile objects will contain all command parameters, even if their value is default. By default this is not set. | [optional] 
+
+### Return type
+
+[**Profile**](Profile.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **profile_encodings**
+> PaginatedEncodingsCollection profile_encodings(id_or_name, factory_id)
+
+Returns a list of Encodings that belong to a Profile.
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+id_or_name = "id_or_name_example" # String | Id or name of a Profile.
+
+factory_id = "factory_id_example" # String | Id of a Factory.
+
+
+begin
+  #Returns a list of Encodings that belong to a Profile.
+  result = api_instance.profile_encodings(id_or_name, factory_id)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->profile_encodings: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id_or_name** | **String**| Id or name of a Profile. | 
+ **factory_id** | **String**| Id of a Factory. | 
+
+### Return type
+
+[**PaginatedEncodingsCollection**](PaginatedEncodingsCollection.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **profiles**
+> PaginatedProfilesCollection profiles(factory_id, opts)
+
+Returns a collection of Profile objects.
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+factory_id = "factory_id_example" # String | Id of a Factory.
+
+opts = { 
+  exclude_advanced_services: true, # BOOLEAN | Determine whether exclude Advanced Services profiles from the results. By default this is not set.
+  expand: true, # BOOLEAN | If expand option is set Profile objects will contain all command parameters, even if their value is default. By default this is not set.
+  page: 56, # Integer | A page to be fetched. Default is `1`.
+  per_page: 56 # Integer | A number of results per page. Default is `100`.
+}
+
+begin
+  #Returns a collection of Profile objects.
+  result = api_instance.profiles(factory_id, opts)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->profiles: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **factory_id** | **String**| Id of a Factory. | 
+ **exclude_advanced_services** | **BOOLEAN**| Determine whether exclude Advanced Services profiles from the results. By default this is not set. | [optional] 
+ **expand** | **BOOLEAN**| If expand option is set Profile objects will contain all command parameters, even if their value is default. By default this is not set. | [optional] 
+ **page** | **Integer**| A page to be fetched. Default is `1`. | [optional] 
+ **per_page** | **Integer**| A number of results per page. Default is `100`. | [optional] 
+
+### Return type
+
+[**PaginatedProfilesCollection**](PaginatedProfilesCollection.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **queued_videos**
+> PaginatedVideoCollection queued_videos(factory_id, opts)
+
+Returns a collection of Video objects queued for encoding.
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+factory_id = "factory_id_example" # String | Id of a Factory.
+
+opts = { 
+  page: 56, # Integer | A page to be fetched. Default is `1`.
+  per_page: 56 # Integer | A number of results per page. Default is `100`.
+}
+
+begin
+  #Returns a collection of Video objects queued for encoding.
+  result = api_instance.queued_videos(factory_id, opts)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->queued_videos: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **factory_id** | **String**| Id of a Factory. | 
+ **page** | **Integer**| A page to be fetched. Default is `1`. | [optional] 
+ **per_page** | **Integer**| A number of results per page. Default is `100`. | [optional] 
+
+### Return type
+
+[**PaginatedVideoCollection**](PaginatedVideoCollection.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **resubmit_video**
+> resubmit_video(factory_id, resubmit_video_body)
+
+Resubmits a video to encode.
+
+Resubmits the video to encode. Please note that this option will work only for videos in `success` status.
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+factory_id = "factory_id_example" # String | Id of a Factory.
+
+resubmit_video_body = TelestreamCloud::Flip::ResubmitVideoBody.new # ResubmitVideoBody | 
+
+
+begin
+  #Resubmits a video to encode.
+  api_instance.resubmit_video(factory_id, resubmit_video_body)
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->resubmit_video: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **factory_id** | **String**| Id of a Factory. | 
+ **resubmit_video_body** | [**ResubmitVideoBody**](ResubmitVideoBody.md)|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **retry_encoding**
+> RetriedResponse retry_encoding(id, factory_id)
+
+Retries a failed encoding.
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+id = "id_example" # String | Id of an Encoding.
+
+factory_id = "factory_id_example" # String | Id of a Factory.
+
+
+begin
+  #Retries a failed encoding.
+  result = api_instance.retry_encoding(id, factory_id)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->retry_encoding: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Id of an Encoding. | 
+ **factory_id** | **String**| Id of a Factory. | 
+
+### Return type
+
+[**RetriedResponse**](RetriedResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **signed_encoding_url**
+> EncodingSignedUrl signed_encoding_url(id, factory_id)
+
+Returns a signed url pointing to an Encoding.
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+id = "id_example" # String | Id of an Encoding.
+
+factory_id = "factory_id_example" # String | Id of a Factory.
+
+
+begin
+  #Returns a signed url pointing to an Encoding.
+  result = api_instance.signed_encoding_url(id, factory_id)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->signed_encoding_url: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Id of an Encoding. | 
+ **factory_id** | **String**| Id of a Factory. | 
+
+### Return type
+
+[**EncodingSignedUrl**](EncodingSignedUrl.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **signed_encoding_urls**
+> EncodingSignedUrls signed_encoding_urls(id, factory_id)
+
+Returns a list of signed urls pointing to an Encoding's outputs.
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+id = "id_example" # String | Id of an Encoding.
+
+factory_id = "factory_id_example" # String | Id of a Factory.
+
+
+begin
+  #Returns a list of signed urls pointing to an Encoding's outputs.
+  result = api_instance.signed_encoding_urls(id, factory_id)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->signed_encoding_urls: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Id of an Encoding. | 
+ **factory_id** | **String**| Id of a Factory. | 
+
+### Return type
+
+[**EncodingSignedUrls**](EncodingSignedUrls.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **signed_video_url**
+> SignedVideoUrl signed_video_url(id, factory_id)
+
+Returns a signed url pointing to a Video.
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+id = "id_example" # String | Id of a Video.
+
+factory_id = "factory_id_example" # String | Id of a Factory.
+
+
+begin
+  #Returns a signed url pointing to a Video.
+  result = api_instance.signed_video_url(id, factory_id)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->signed_video_url: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Id of a Video. | 
+ **factory_id** | **String**| Id of a Factory. | 
+
+### Return type
+
+[**SignedVideoUrl**](SignedVideoUrl.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **toggle_factory_sync**
+> FactorySync toggle_factory_sync(id, factory_sync_body)
+
+Toggles synchronisation settings.
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+id = "id_example" # String | id of the factory
+
+factory_sync_body = TelestreamCloud::Flip::FactorySyncBody.new # FactorySyncBody | 
+
+
+begin
+  #Toggles synchronisation settings.
+  result = api_instance.toggle_factory_sync(id, factory_sync_body)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->toggle_factory_sync: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| id of the factory | 
+ **factory_sync_body** | [**FactorySyncBody**](FactorySyncBody.md)|  | 
+
+### Return type
+
+[**FactorySync**](FactorySync.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_encoding**
+> Encoding update_encoding(id, factory_id, update_encoding_body, opts)
+
+Updates an Encoding
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+id = "id_example" # String | Id of an Encoding.
+
+factory_id = "factory_id_example" # String | Id of a Factory.
+
+update_encoding_body = TelestreamCloud::Flip::UpdateEncodingBody.new # UpdateEncodingBody | 
+
+opts = { 
+  screenshots: true, # BOOLEAN | Determines whether the response will include screenshots. By default this is not set.
+  precise_status: true # BOOLEAN | Determines whether the response will include a precise status. By default this is not set.
+}
+
+begin
+  #Updates an Encoding
+  result = api_instance.update_encoding(id, factory_id, update_encoding_body, opts)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->update_encoding: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Id of an Encoding. | 
+ **factory_id** | **String**| Id of a Factory. | 
+ **update_encoding_body** | [**UpdateEncodingBody**](UpdateEncodingBody.md)|  | 
+ **screenshots** | **BOOLEAN**| Determines whether the response will include screenshots. By default this is not set. | [optional] 
+ **precise_status** | **BOOLEAN**| Determines whether the response will include a precise status. By default this is not set. | [optional] 
+
+### Return type
+
+[**Encoding**](Encoding.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_factory**
+> Factory update_factory(id, update_factory_body, opts)
+
+Updates a Factory's settings. Returns a Factory object.
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+id = "id_example" # String | id of the factory
+
+update_factory_body = TelestreamCloud::Flip::FactoryBody.new # FactoryBody | 
+
+opts = { 
+  with_storage_provider: true # BOOLEAN | if set to `true`, results will include a storage provider's id
+}
+
+begin
+  #Updates a Factory's settings. Returns a Factory object.
+  result = api_instance.update_factory(id, update_factory_body, opts)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->update_factory: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| id of the factory | 
+ **update_factory_body** | [**FactoryBody**](FactoryBody.md)|  | 
+ **with_storage_provider** | **BOOLEAN**| if set to `true`, results will include a storage provider's id | [optional] 
+
+### Return type
+
+[**Factory**](Factory.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_notifications**
+> CloudNotificationSettings update_notifications(factory_id, cloud_notification_settings_body)
+
+Updates a Factory's notification settings.
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+factory_id = "factory_id_example" # String | Id of a Factory.
+
+cloud_notification_settings_body = TelestreamCloud::Flip::CloudNotificationSettings.new # CloudNotificationSettings | 
+
+
+begin
+  #Updates a Factory's notification settings.
+  result = api_instance.update_notifications(factory_id, cloud_notification_settings_body)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->update_notifications: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **factory_id** | **String**| Id of a Factory. | 
+ **cloud_notification_settings_body** | [**CloudNotificationSettings**](CloudNotificationSettings.md)|  | 
+
+### Return type
+
+[**CloudNotificationSettings**](CloudNotificationSettings.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_profile**
+> Profile update_profile(id, factory_id, update_profile_body, opts)
+
+Updates a given Profile
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+id = "id_example" # String | 
+
+factory_id = "factory_id_example" # String | Id of a Factory.
+
+update_profile_body = TelestreamCloud::Flip::ProfileBody.new # ProfileBody | 
+
+opts = { 
+  exclude_advanced_services: true, # BOOLEAN | 
+  expand: true # BOOLEAN | If expand option is set Profile objects will contain all command parameters, even if their value is default. By default this is not set.
+}
+
+begin
+  #Updates a given Profile
+  result = api_instance.update_profile(id, factory_id, update_profile_body, opts)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->update_profile: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **factory_id** | **String**| Id of a Factory. | 
+ **update_profile_body** | [**ProfileBody**](ProfileBody.md)|  | 
+ **exclude_advanced_services** | **BOOLEAN**|  | [optional] 
+ **expand** | **BOOLEAN**| If expand option is set Profile objects will contain all command parameters, even if their value is default. By default this is not set. | [optional] 
+
+### Return type
+
+[**Profile**](Profile.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **upload_video**
+> UploadSession upload_video(factory_id, video_upload_body)
+
+Creates an upload session.
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+factory_id = "factory_id_example" # String | Id of a Factory.
+
+video_upload_body = TelestreamCloud::Flip::VideoUploadBody.new # VideoUploadBody | 
+
+
+begin
+  #Creates an upload session.
+  result = api_instance.upload_video(factory_id, video_upload_body)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->upload_video: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **factory_id** | **String**| Id of a Factory. | 
+ **video_upload_body** | [**VideoUploadBody**](VideoUploadBody.md)|  | 
+
+### Return type
+
+[**UploadSession**](UploadSession.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **video**
+> Video video(id, factory_id)
+
+Returns a Video object.
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+id = "id_example" # String | Id of a Video.
+
+factory_id = "factory_id_example" # String | Id of a Factory.
+
+
+begin
+  #Returns a Video object.
+  result = api_instance.video(id, factory_id)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->video: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Id of a Video. | 
+ **factory_id** | **String**| Id of a Factory. | 
+
+### Return type
+
+[**Video**](Video.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **video_encodings**
+> PaginatedEncodingsCollection video_encodings(id, factory_id, opts)
+
+Returns a list of Encodings that belong to a Video.
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+id = "id_example" # String | Id of a Video.
+
+factory_id = "factory_id_example" # String | Id of a Factory.
+
+opts = { 
+  page: 56, # Integer | A page to be fetched. Default is `1`.
+  per_page: 56, # Integer | A number of results per page. Default is `100`.
+  screenshots: true, # BOOLEAN | Determines whether the response will include screenshots. By default this is not set.
+  precise_status: true # BOOLEAN | Determines whether the response will include a precise status. By default this is not set.
+}
+
+begin
+  #Returns a list of Encodings that belong to a Video.
+  result = api_instance.video_encodings(id, factory_id, opts)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->video_encodings: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Id of a Video. | 
+ **factory_id** | **String**| Id of a Factory. | 
+ **page** | **Integer**| A page to be fetched. Default is `1`. | [optional] 
+ **per_page** | **Integer**| A number of results per page. Default is `100`. | [optional] 
+ **screenshots** | **BOOLEAN**| Determines whether the response will include screenshots. By default this is not set. | [optional] 
+ **precise_status** | **BOOLEAN**| Determines whether the response will include a precise status. By default this is not set. | [optional] 
+
+### Return type
+
+[**PaginatedEncodingsCollection**](PaginatedEncodingsCollection.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **video_metadata**
+> VideoMetadata video_metadata(id, factory_id)
+
+Returns a Video's metadata
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+id = "id_example" # String | Id of a Video.
+
+factory_id = "factory_id_example" # String | Id of a Factory.
+
+
+begin
+  #Returns a Video's metadata
+  result = api_instance.video_metadata(id, factory_id)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->video_metadata: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Id of a Video. | 
+ **factory_id** | **String**| Id of a Factory. | 
+
+### Return type
+
+[**VideoMetadata**](VideoMetadata.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **videos**
+> PaginatedVideoCollection videos(factory_id, opts)
+
+Returns a collection of Video objects.
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+factory_id = "factory_id_example" # String | Id of a Factory.
+
+opts = { 
+  page: 56, # Integer | A page to be fetched. Default is `1`.
+  per_page: 56 # Integer | A number of results per page. Default is `100`.
+}
+
+begin
+  #Returns a collection of Video objects.
+  result = api_instance.videos(factory_id, opts)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->videos: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **factory_id** | **String**| Id of a Factory. | 
+ **page** | **Integer**| A page to be fetched. Default is `1`. | [optional] 
+ **per_page** | **Integer**| A number of results per page. Default is `100`. | [optional] 
+
+### Return type
+
+[**PaginatedVideoCollection**](PaginatedVideoCollection.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **workflows**
+> PaginatedWorkflowsCollection workflows(factory_id, opts)
+
+Returns a collection of Workflows that belong to a Factory.
+
+### Example
+```ruby
+# load the gem
+require 'telestream_cloud_flip'
+# setup authorization
+TelestreamCloud::Flip.configure do |config|
+  # Configure API key authorization: api_key
+  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::Flip::FlipApi.new
+
+factory_id = "factory_id_example" # String | Id of a Factory.
+
+opts = { 
+  page: 56, # Integer | A page to be fetched. Default is `1`.
+  per_page: 56 # Integer | A number of results per page. Default is `100`.
+}
+
+begin
+  #Returns a collection of Workflows that belong to a Factory.
+  result = api_instance.workflows(factory_id, opts)
+  p result
+rescue TelestreamCloud::Flip::ApiError => e
+  puts "Exception when calling FlipApi->workflows: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **factory_id** | **String**| Id of a Factory. | 
+ **page** | **Integer**| A page to be fetched. Default is `1`. | [optional] 
+ **per_page** | **Integer**| A number of results per page. Default is `100`. | [optional] 
+
+### Return type
+
+[**PaginatedWorkflowsCollection**](PaginatedWorkflowsCollection.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+