Ziggeo 2.18 → 2.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d18b6fc48bad291624a7711bb7520b9ee019b3e840e25d5459f1fd73dc2704fe
-  data.tar.gz: e01f52abed608851575a55557bd4d93a3c8826b43305a71d2402a942e1fd3a1f
+  metadata.gz: d66106c85f75e46affc2e3f874bc93c18c1f4afb94c86472e264f13198f964d8
+  data.tar.gz: 7071ad43e3fef3825cb67bf86bc10315e8de84aa0ccd132bf5f421d3150f0c6d
 SHA512:
-  metadata.gz: 6fefe2bc166b749895c0b940bf6c10a36f6c158f46a41e6c0a8d75351f8b228e6c2193ca697e7cc2aa5d0c435c4d74187182e9a46e2e1682c80e90864bdb7595
-  data.tar.gz: 7c61c3a9a5584333703575f8d5b549203e6533512fbf4a232fd562fdd6a87e47dd9619a8d4a29fa6d64384f3107847ec2249830397a9807b5455e8681600ba7f
+  metadata.gz: cd4c00e3fc72937933841ace5956f88689ce6f851779fa0e5f5d9edca683511ad9b05a1aecc47b1b196f2f3db2581e35bd25e858df2eec05d3f88ed3ab51a910
+  data.tar.gz: b2bddfd93042da50cda78831c6959ffe71e5d5d3eda8712a583b62bfd7876f62091c57ebdfe97800d42fed43324be558d655ccccd78c520ceeac9a48975c6c43

data/README.md

@@ -1,19 +1,129 @@
-# Ziggeo Ruby Server SDK 2.18
-
-Ziggeo API (https://ziggeo.com) allows you to integrate video recording and playback with only
-two lines of code in your site, service or app. This is the Ruby Server SDK repository.
-
-Pull requests welcome.
-
-
-## Installation
+# Ziggeo's Ruby Server SDK
+
+latest version: **2.26**
+
+## Index
+
+1. [Why Ziggeo's Ruby Server Side SDK?](#why-us)
+2. [Prerequisites](#prerequisites)
+    1. [Download](#download)
+    2. [How to use](#how-to-use)
+    3. [Installation](#install)
+3. [Client-Side Integration](#codes-client-side)
+4. [Server-Side Integration](#codes-server-side)
+    1. [Init](#codes-init)
+    2. [Available Methods](#codes-methods)
+    3. [Methods for Videos](#method-videos)
+        1. [Videos Index](#method-videos-index)
+        2. [Videos Count](#method-videos-count)
+        3. [Videos Get](#method-videos-get)
+        4. [Videos Get Bulk](#method-videos-get-bulk)
+        5. [Videos Stats Bulk](#method-videos-stats-bulk)
+        6. [Videos Download Video](#method-videos-download-video)
+        7. [Videos Download Image](#method-videos-download-image)
+        8. [Videos Get Stats](#method-videos-get-stats)
+        9. [Videos Push To Service](#method-videos-push-to-service)
+        10. [Videos Apply Effect](#method-videos-apply-effect)
+        11. [Videos Apply Meta](#method-videos-apply-meta)
+        12. [Videos Update](#method-videos-update)
+        13. [Videos Update Bulk](#method-videos-update-bulk)
+        14. [Videos Delete](#method-videos-delete)
+        15. [Videos Create](#method-videos-create)
+        16. [Videos Analytics](#method-videos-analytics)
+    4. [Methods for Streams](#method-streams)
+        1. [Streams Index](#method-streams-index)
+        2. [Streams Get](#method-streams-get)
+        3. [Streams Download Video](#method-streams-download-video)
+        4. [Streams Download Image](#method-streams-download-image)
+        5. [Streams Push To Service](#method-streams-push-to-service)
+        6. [Streams Delete](#method-streams-delete)
+        7. [Streams Create](#method-streams-create)
+        8. [Streams Attach Image](#method-streams-attach-image)
+        9. [Streams Attach Video](#method-streams-attach-video)
+        10. [Streams Attach Subtitle](#method-streams-attach-subtitle)
+        11. [Streams Bind](#method-streams-bind)
+    5. [Methods for Authtokens](#method-authtokens)
+        1. [Authtokens Get](#method-authtokens-get)
+        2. [Authtokens Update](#method-authtokens-update)
+        3. [Authtokens Delete](#method-authtokens-delete)
+        4. [Authtokens Create](#method-authtokens-create)
+    6. [Methods for Application](#method-application)
+        1. [Application Get](#method-application-get)
+        2. [Application Update](#method-application-update)
+        3. [Application Get Stats](#method-application-get-stats)
+    7. [Methods for Effect Profiles](#method-effect-profiles)
+        1. [Effect Profiles Create](#method-effect-profiles-create)
+        2. [Effect Profiles Index](#method-effect-profiles-index)
+        3. [Effect Profiles Get](#method-effect-profiles-get)
+        4. [Effect Profiles Delete](#method-effect-profiles-delete)
+        5. [Effect Profiles Update](#method-effect-profiles-update)
+    8. [Methods for Effect Profile Process](#method-effect-profile-process)
+        1. [Effect Profile Process Index](#method-effect-profile-process-index)
+        2. [Effect Profile Process Get](#method-effect-profile-process-get)
+        3. [Effect Profile Process Delete](#method-effect-profile-process-delete)
+        4. [Effect Profile Process Create Filter Process](#method-effect-profile-process-create-filter-process)
+        5. [Effect Profile Process Create Watermark Process](#method-effect-profile-process-create-watermark-process)
+        6. [Effect Profile Process Edit Watermark Process](#method-effect-profile-process-edit-watermark-process)
+    9. [Methods for Meta Profiles](#method-meta-profiles)
+        1. [Meta Profiles Create](#method-meta-profiles-create)
+        2. [Meta Profiles Index](#method-meta-profiles-index)
+        3. [Meta Profiles Get](#method-meta-profiles-get)
+        4. [Meta Profiles Delete](#method-meta-profiles-delete)
+    10. [Methods for Meta Profile Process](#method-meta-profile-process)
+        1. [Meta Profile Process Index](#method-meta-profile-process-index)
+        2. [Meta Profile Process Get](#method-meta-profile-process-get)
+        3. [Meta Profile Process Delete](#method-meta-profile-process-delete)
+        4. [Meta Profile Process Create Video Analysis Process](#method-meta-profile-process-create-video-analysis-process)
+        5. [Meta Profile Process Create Audio Transcription Process](#method-meta-profile-process-create-audio-transcription-process)
+        6. [Meta Profile Process Create Nsfw Process](#method-meta-profile-process-create-nsfw-process)
+        7. [Meta Profile Process Create Profanity Process](#method-meta-profile-process-create-profanity-process)
+    11. [Methods for Webhooks](#method-webhooks)
+        1. [Webhooks Create](#method-webhooks-create)
+        2. [Webhooks Confirm](#method-webhooks-confirm)
+        3. [Webhooks Delete](#method-webhooks-delete)
+    12. [Methods for Analytics](#method-analytics)
+        1. [Analytics Get](#method-analytics-get)
+5. [License](#license)
+
+
+## Why Ziggeo's Ruby Server Side SDK? <a name="why-us"></a>
+
+[Ziggeo](https://ziggeo.com) is a powerfull, whitelabel video SAAS with a goal to help people with their video revolution. And what better way to do it than with an award winning multimedia API.
+
+This server side SDK is designed to help you ease the communication with Ziggeo API. In that it allows you to privately communicate between your server and our server through requests of what you want to happen.
+
+It offers you pre-built functionality to call and manipulate and there are demos in /demos/ directory for you to check out and use as starting point.
+
+### Who it is for?
+
+1. Do you have a system that requires calls to be made which should not be seen on client side?
+2. Want to have an easier time handling the media as it comes to your server?
+3. Want something that is simple and easy to use?
+4. You need some powerful features high end video services provide?
+
+If any of the above is "Yes" then you are in the right place as this SDK is for you!
+
+## Prerequisites <a name="prerequisites"></a>
+
+### Download <a name="download"></a>
+
+You will want to either download the SDK zip file or to pull it in as git repository into your own project.
+
+To clone it you would go into your project folder and then
+```ruby    git clone https://github.com/Ziggeo/ZiggeoRubySdk```
+
+### How to use <a name="how-to-use"></a>
+
+To start using the Ruby SDK you would need to initialize the Ziggeo class with application token, private token and possibly encryption token. The token and keys can be found within the Ziggeo application once you log into your account, under Overview page.
+
+
+### Installation<a name="install"></a>
 
 For Rails applications, you can simply install this repository as a gem.
 
 gem "Ziggeo"
 
-
-## Client-Side Integration
+## Client-Side Integration<a name="codes-client-side"></a>
 
 For the client-side integration, you need to add these assets to your html file:
 
@@ -26,7 +136,9 @@ Then, you need to specify your api token:
 ```html 
 <script>
     var ziggeoApplication = new ZiggeoApi.V2.Application({
-        token: "APPLICATION_TOKEN"
+        token: "APPLICATION_TOKEN",
+        webrtc_streaming_if_necessary: true,
+        webrtc_on_mobile: true
     });
 </script>
 ```
@@ -45,9 +157,9 @@ To embed a player for an existing video, add:
 
 For the full documentation, please visit [ziggeo.com](https://ziggeo.com/docs).
 
+## Server-Side Integration<a name="codes-server-side"></a>
 
-
-## Server-Side Integration
+### Initialize Ziggeo class in your code<a name="codes-init"></a>
 
 You can integrate the Server SDK as follows:
 
@@ -55,789 +167,741 @@ You can integrate the Server SDK as follows:
 @ziggeo = Ziggeo.new("*token*", "*private_key*", "*encryption_key*") 
 ```
 
+Config is optional and if not specified (recommended), the Config file will be used instead.
 
-## Server-Side Methods
+### Available Methods<a name="codes-methods"></a>
 
-### Videos  
+Currently available methods are branched off within different categories:
 
-The videos resource allows you to access all single videos. Each video may contain more than one stream. 
- 
+1. Videos
+2. Streams
+3. Authtokens
+4. Application
+5. Effect Profiles
+6. Effect Profile Process
+7. Meta Profiles
+8. Meta Profile Process
+9. Webhooks
+10. Analytics
 
-#### Index 
- 
-Query an array of videos (will return at most 50 videos by default). Newest videos come first. 
+Each of this sections has their own actions and they are explained bellow
 
-```ruby 
-ziggeo.videos().index(arguments = nil) 
-``` 
- 
-Arguments 
-- limit: *Limit the number of returned videos. Can be set up to 100.* 
-- skip: *Skip the first [n] entries.* 
-- reverse: *Reverse the order in which videos are returned.* 
-- states: *Filter videos by state* 
-- tags: *Filter the search result to certain tags, encoded as a comma-separated string* 
 
 
-#### Count 
- 
-Get the video count for the application. 
+### Videos<a name="method-videos"></a>
 
-```ruby 
-ziggeo.videos().count(arguments = nil) 
-``` 
- 
-Arguments 
-- states: *Filter videos by state* 
-- tags: *Filter the search result to certain tags, encoded as a comma-separated string* 
 
+The videos resource allows you to access all single videos. Each video may contain more than one stream.
 
-#### Get 
- 
-Get a single video by token or key. 
+#### Index<a name="method-videos-index"></a>
 
-```ruby 
-ziggeo.videos().get(token_or_key) 
-``` 
- 
+Query an array of videos (will return at most 50 videos by default). Newest videos come first.
 
+```ruby
+ziggeo.videos().index(arguments = nil)
+```
 
-#### Get Bulk 
- 
-Get multiple videos by tokens or keys. 
+ Arguments
+- limit: *Limit the number of returned videos. Can be set up to 100.*
+- skip: *Skip the first [n] entries.*
+- reverse: *Reverse the order in which videos are returned.*
+- states: *Filter videos by state*
+- tags: *Filter the search result to certain tags, encoded as a comma-separated string*
 
-```ruby 
-ziggeo.videos().get_bulk(arguments = nil) 
-``` 
- 
-Arguments 
-- tokens_or_keys: *Comma-separated list with the desired videos tokens or keys (Limit: 100 tokens or keys).* 
+#### Count<a name="method-videos-count"></a>
 
+Get the video count for the application.
 
-#### Stats Bulk 
- 
-Get stats for multiple videos by tokens or keys. 
+```ruby
+ziggeo.videos().count(arguments = nil)
+```
 
-```ruby 
-ziggeo.videos().stats_bulk(arguments = nil) 
-``` 
- 
-Arguments 
-- tokens_or_keys: *Comma-separated list with the desired videos tokens or keys (Limit: 100 tokens or keys).* 
-- summarize: *Boolean. Set it to TRUE to get the stats summarized. Set it to FALSE to get the stats for each video in a separate array. Default: TRUE.* 
+ Arguments
+- states: *Filter videos by state*
+- tags: *Filter the search result to certain tags, encoded as a comma-separated string*
 
+#### Get<a name="method-videos-get"></a>
 
-#### Download Video 
- 
-Download the video data file 
+Get a single video by token or key.
 
-```ruby 
-ziggeo.videos().download_video(token_or_key) 
-``` 
- 
+```ruby
+ziggeo.videos().get(token_or_key)
+```
 
+#### Get Bulk<a name="method-videos-get-bulk"></a>
 
-#### Download Image 
- 
-Download the image data file 
+Get multiple videos by tokens or keys.
 
-```ruby 
-ziggeo.videos().download_image(token_or_key) 
-``` 
- 
+```ruby
+ziggeo.videos().get_bulk(arguments = nil)
+```
 
+ Arguments
+- tokens_or_keys: *Comma-separated list with the desired videos tokens or keys (Limit: 100 tokens or keys).*
 
-#### Get Stats 
- 
-Get the video's stats 
+#### Stats Bulk<a name="method-videos-stats-bulk"></a>
 
-```ruby 
-ziggeo.videos().get_stats(token_or_key) 
-``` 
- 
+Get stats for multiple videos by tokens or keys.
 
+```ruby
+ziggeo.videos().stats_bulk(arguments = nil)
+```
 
-#### Push To Service 
- 
-Push a video to a provided push service. 
+ Arguments
+- tokens_or_keys: *Comma-separated list with the desired videos tokens or keys (Limit: 100 tokens or keys).*
+- summarize: *Boolean. Set it to TRUE to get the stats summarized. Set it to FALSE to get the stats for each video in a separate array. Default: TRUE.*
 
-```ruby 
-ziggeo.videos().push_to_service(token_or_key, arguments = nil) 
-``` 
- 
-Arguments 
-- pushservicetoken: *Push Services's token (from the Push Services configured for the app)* 
+#### Download Video<a name="method-videos-download-video"></a>
 
+Download the video data file
 
-#### Apply Effect 
- 
-Apply an effect profile to a video. 
+```ruby
+ziggeo.videos().download_video(token_or_key)
+```
 
-```ruby 
-ziggeo.videos().apply_effect(token_or_key, arguments = nil) 
-``` 
- 
-Arguments 
-- effectprofiletoken: *Effect Profile token (from the Effect Profiles configured for the app)* 
+#### Download Image<a name="method-videos-download-image"></a>
 
+Download the image data file
 
-#### Apply Meta 
- 
-Apply a meta profile to a video. 
+```ruby
+ziggeo.videos().download_image(token_or_key)
+```
 
-```ruby 
-ziggeo.videos().apply_meta(token_or_key, arguments = nil) 
-``` 
- 
-Arguments 
-- metaprofiletoken: *Meta Profile token (from the Meta Profiles configured for the app)* 
+#### Get Stats<a name="method-videos-get-stats"></a>
 
+Get the video's stats
 
-#### Update 
- 
-Update single video by token or key. 
+```ruby
+ziggeo.videos().get_stats(token_or_key)
+```
 
-```ruby 
-ziggeo.videos().update(token_or_key, arguments = nil) 
-``` 
- 
-Arguments 
-- min_duration: *Minimal duration of video* 
-- max_duration: *Maximal duration of video* 
-- tags: *Video Tags* 
-- key: *Unique (optional) name of video* 
-- volatile: *Automatically removed this video if it remains empty* 
-- expiration_days: *After how many days will this video be deleted* 
-- expire_on: *On which date will this video be deleted. String in ISO 8601 format: YYYY-MM-DD* 
+#### Push To Service<a name="method-videos-push-to-service"></a>
 
+Push a video to a provided push service.
 
-#### Update Bulk 
- 
-Update multiple videos by token or key. 
+```ruby
+ziggeo.videos().push_to_service(token_or_key, arguments = nil)
+```
 
-```ruby 
-ziggeo.videos().update_bulk(arguments = nil) 
-``` 
- 
-Arguments 
-- tokens_or_keys: *Comma-separated list with the desired videos tokens or keys (Limit: 100 tokens or keys).* 
-- min_duration: *Minimal duration of video* 
-- max_duration: *Maximal duration of video* 
-- tags: *Video Tags* 
-- volatile: *Automatically removed this video if it remains empty* 
-- expiration_days: *After how many days will this video be deleted* 
-- expire_on: *On which date will this video be deleted. String in ISO 8601 format: YYYY-MM-DD* 
+ Arguments
+- pushservicetoken: *Push Services's token (from the Push Services configured for the app)*
 
+#### Apply Effect<a name="method-videos-apply-effect"></a>
 
-#### Delete 
- 
-Delete a single video by token or key. 
+Apply an effect profile to a video.
 
-```ruby 
-ziggeo.videos().delete(token_or_key) 
-``` 
- 
+```ruby
+ziggeo.videos().apply_effect(token_or_key, arguments = nil)
+```
 
+ Arguments
+- effectprofiletoken: *Effect Profile token (from the Effect Profiles configured for the app)*
 
-#### Create 
- 
-Create a new video. 
+#### Apply Meta<a name="method-videos-apply-meta"></a>
 
-```ruby 
-ziggeo.videos().create(arguments = nil, file = nil) 
-``` 
- 
-Arguments 
-- file: *Video file to be uploaded* 
-- min_duration: *Minimal duration of video* 
-- max_duration: *Maximal duration of video* 
-- tags: *Video Tags* 
-- key: *Unique (optional) name of video* 
-- volatile: *Automatically removed this video if it remains empty* 
+Apply a meta profile to a video.
 
+```ruby
+ziggeo.videos().apply_meta(token_or_key, arguments = nil)
+```
 
-#### Analytics 
- 
-Get analytics for a specific videos with the given params 
+ Arguments
+- metaprofiletoken: *Meta Profile token (from the Meta Profiles configured for the app)*
 
-```ruby 
-ziggeo.videos().analytics(token_or_key, arguments = nil) 
-``` 
- 
-Arguments 
-- from: *A UNIX timestamp in microseconds used as the start date of the query* 
-- to: *A UNIX timestamp in microseconds used as the end date of the query* 
-- date: *A UNIX timestamp in microseconds to retrieve data from a single date. If set, it overwrites the from and to params.* 
-- query: *The query you want to run. It can be one of the following: device_views_by_os, device_views_by_date, total_plays_by_country, full_plays_by_country, total_plays_by_hour, full_plays_by_hour, total_plays_by_browser, full_plays_by_browser* 
+#### Update<a name="method-videos-update"></a>
 
+Update single video by token or key.
 
-### Streams  
+```ruby
+ziggeo.videos().update(token_or_key, arguments = nil)
+```
 
-The streams resource allows you to directly access all streams associated with a single video. 
- 
+ Arguments
+- min_duration: *Minimal duration of video*
+- max_duration: *Maximal duration of video*
+- tags: *Video Tags*
+- key: *Unique (optional) name of video*
+- volatile: *Automatically removed this video if it remains empty*
+- expiration_days: *After how many days will this video be deleted*
+- expire_on: *On which date will this video be deleted. String in ISO 8601 format: YYYY-MM-DD*
 
-#### Index 
- 
-Return all streams associated with a video 
+#### Update Bulk<a name="method-videos-update-bulk"></a>
 
-```ruby 
-ziggeo.streams().index(video_token_or_key, arguments = nil) 
-``` 
- 
-Arguments 
-- states: *Filter streams by state* 
+Update multiple videos by token or key.
 
+```ruby
+ziggeo.videos().update_bulk(arguments = nil)
+```
 
-#### Get 
- 
-Get a single stream 
+ Arguments
+- tokens_or_keys: *Comma-separated list with the desired videos tokens or keys (Limit: 100 tokens or keys).*
+- min_duration: *Minimal duration of video*
+- max_duration: *Maximal duration of video*
+- tags: *Video Tags*
+- volatile: *Automatically removed this video if it remains empty*
+- expiration_days: *After how many days will this video be deleted*
+- expire_on: *On which date will this video be deleted. String in ISO 8601 format: YYYY-MM-DD*
 
-```ruby 
-ziggeo.streams().get(video_token_or_key, token_or_key) 
-``` 
- 
+#### Delete<a name="method-videos-delete"></a>
 
+Delete a single video by token or key.
 
-#### Download Video 
- 
-Download the video data associated with the stream 
+```ruby
+ziggeo.videos().delete(token_or_key)
+```
 
-```ruby 
-ziggeo.streams().download_video(video_token_or_key, token_or_key) 
-``` 
- 
+#### Create<a name="method-videos-create"></a>
 
+Create a new video.
 
-#### Download Image 
- 
-Download the image data associated with the stream 
+```ruby
+ziggeo.videos().create(arguments = nil, file = nil)
+```
 
-```ruby 
-ziggeo.streams().download_image(video_token_or_key, token_or_key) 
-``` 
- 
+ Arguments
+- file: *Video file to be uploaded*
+- min_duration: *Minimal duration of video*
+- max_duration: *Maximal duration of video*
+- tags: *Video Tags*
+- key: *Unique (optional) name of video*
+- volatile: *Automatically removed this video if it remains empty*
+- effect_profile: *Set the effect profile that you want to have applied to your video.*
+- meta_profile: *Set the meta profile that you want to have applied to your video once created.*
+- video_profile: *Set the video profile that you want to have applied to your video as you create it.*
 
+#### Analytics<a name="method-videos-analytics"></a>
 
-#### Push To Service 
- 
-Push a stream to a provided push service. 
+Get analytics for a specific videos with the given params
 
-```ruby 
-ziggeo.streams().push_to_service(video_token_or_key, token_or_key, arguments = nil) 
-``` 
- 
-Arguments 
-- pushservicetoken: *Push Services's token (from the Push Services configured for the app)* 
+```ruby
+ziggeo.videos().analytics(token_or_key, arguments = nil)
+```
 
+ Arguments
+- from: *A UNIX timestamp in microseconds used as the start date of the query*
+- to: *A UNIX timestamp in microseconds used as the end date of the query*
+- date: *A UNIX timestamp in microseconds to retrieve data from a single date. If set, it overwrites the from and to params.*
+- query: *The query you want to run. It can be one of the following: device_views_by_os, device_views_by_date, total_plays_by_country, full_plays_by_country, total_plays_by_hour, full_plays_by_hour, total_plays_by_browser, full_plays_by_browser*
 
-#### Delete 
- 
-Delete the stream 
+### Streams<a name="method-streams"></a>
 
-```ruby 
-ziggeo.streams().delete(video_token_or_key, token_or_key) 
-``` 
- 
 
+The streams resource allows you to directly access all streams associated with a single video.
 
-#### Create 
- 
-Create a new stream 
+#### Index<a name="method-streams-index"></a>
 
-```ruby 
-ziggeo.streams().create(video_token_or_key, arguments = nil, file = nil) 
-``` 
- 
-Arguments 
-- file: *Video file to be uploaded* 
+Return all streams associated with a video
 
+```ruby
+ziggeo.streams().index(video_token_or_key, arguments = nil)
+```
 
-#### Attach Image 
- 
-Attaches an image to a new stream 
+ Arguments
+- states: *Filter streams by state*
 
-```ruby 
-ziggeo.streams().attach_image(video_token_or_key, token_or_key, arguments = nil, file = nil) 
-``` 
- 
-Arguments 
-- file: *Image file to be attached* 
+#### Get<a name="method-streams-get"></a>
 
+Get a single stream
 
-#### Attach Video 
- 
-Attaches a video to a new stream 
+```ruby
+ziggeo.streams().get(video_token_or_key, token_or_key)
+```
 
-```ruby 
-ziggeo.streams().attach_video(video_token_or_key, token_or_key, arguments = nil, file = nil) 
-``` 
- 
-Arguments 
-- file: *Video file to be attached* 
+#### Download Video<a name="method-streams-download-video"></a>
 
+Download the video data associated with the stream
 
-#### Attach Subtitle 
- 
-Attaches a video to a new stream 
+```ruby
+ziggeo.streams().download_video(video_token_or_key, token_or_key)
+```
 
-```ruby 
-ziggeo.streams().attach_subtitle(video_token_or_key, token_or_key, arguments = nil) 
-``` 
- 
-Arguments 
-- lang: *Subtitle language* 
-- label: *Subtitle reference* 
-- data: *Actual subtitle* 
+#### Download Image<a name="method-streams-download-image"></a>
 
+Download the image data associated with the stream
 
-#### Bind 
- 
-Closes and submits the stream 
+```ruby
+ziggeo.streams().download_image(video_token_or_key, token_or_key)
+```
 
-```ruby 
-ziggeo.streams().bind(video_token_or_key, token_or_key, arguments = nil) 
-``` 
- 
+#### Push To Service<a name="method-streams-push-to-service"></a>
 
+Push a stream to a provided push service.
 
-### Authtokens  
+```ruby
+ziggeo.streams().push_to_service(video_token_or_key, token_or_key, arguments = nil)
+```
 
-The auth token resource allows you to manage authorization settings for video objects. 
- 
+ Arguments
+- pushservicetoken: *Push Services's token (from the Push Services configured for the app)*
 
-#### Get 
- 
-Get a single auth token by token. 
+#### Delete<a name="method-streams-delete"></a>
 
-```ruby 
-ziggeo.authtokens().get(token) 
-``` 
- 
+Delete the stream
 
+```ruby
+ziggeo.streams().delete(video_token_or_key, token_or_key)
+```
 
-#### Update 
- 
-Update single auth token by token. 
+#### Create<a name="method-streams-create"></a>
 
-```ruby 
-ziggeo.authtokens().update(token_or_key, arguments = nil) 
-``` 
- 
-Arguments 
-- volatile: *Will this object automatically be deleted if it remains empty?* 
-- hidden: *If hidden, the token cannot be used directly.* 
-- expiration_date: *Expiration date for the auth token* 
-- usage_experitation_time: *Expiration time per session* 
-- session_limit: *Maximal number of sessions* 
-- grants: *Permissions this tokens grants* 
+Create a new stream
 
+```ruby
+ziggeo.streams().create(video_token_or_key, arguments = nil, file = nil)
+```
 
-#### Delete 
- 
-Delete a single auth token by token. 
+ Arguments
+- file: *Video file to be uploaded*
 
-```ruby 
-ziggeo.authtokens().delete(token_or_key) 
-``` 
- 
+#### Attach Image<a name="method-streams-attach-image"></a>
 
+Attaches an image to a new stream
 
-#### Create 
- 
-Create a new auth token. 
+```ruby
+ziggeo.streams().attach_image(video_token_or_key, token_or_key, arguments = nil, file = nil)
+```
 
-```ruby 
-ziggeo.authtokens().create(arguments = nil) 
-``` 
- 
-Arguments 
-- volatile: *Will this object automatically be deleted if it remains empty?* 
-- hidden: *If hidden, the token cannot be used directly.* 
-- expiration_date: *Expiration date for the auth token* 
-- usage_experitation_time: *Expiration time per session* 
-- session_limit: *Maximal number of sessions* 
-- grants: *Permissions this tokens grants* 
+ Arguments
+- file: *Image file to be attached*
 
+#### Attach Video<a name="method-streams-attach-video"></a>
 
-### Application  
+Attaches a video to a new stream
 
-The application token resource allows you to manage your application. 
- 
+```ruby
+ziggeo.streams().attach_video(video_token_or_key, token_or_key, arguments = nil, file = nil)
+```
 
-#### Get 
- 
-Read application. 
+ Arguments
+- file: *Video file to be attached*
 
-```ruby 
-ziggeo.application().get() 
-``` 
- 
+#### Attach Subtitle<a name="method-streams-attach-subtitle"></a>
 
+Attaches a subtitle to the stream.
 
-#### Update 
- 
-Update application. 
+```ruby
+ziggeo.streams().attach_subtitle(video_token_or_key, token_or_key, arguments = nil)
+```
 
-```ruby 
-ziggeo.application().update(arguments = nil) 
-``` 
- 
-Arguments 
-- volatile: *Will this object automatically be deleted if it remains empty?* 
-- name: *Name of the application* 
-- auth_token_required_for_create: *Require auth token for creating videos* 
-- auth_token_required_for_update: *Require auth token for updating videos* 
-- auth_token_required_for_read: *Require auth token for reading videos* 
-- auth_token_required_for_destroy: *Require auth token for deleting videos* 
-- client_can_index_videos: *Client is allowed to perform the index operation* 
-- client_cannot_access_unaccepted_videos: *Client cannot view unaccepted videos* 
-- enable_video_subpages: *Enable hosted video pages* 
-
-
-#### Get Stats 
- 
-Read application stats 
+ Arguments
+- lang: *Subtitle language*
+- label: *Subtitle reference*
+- data: *Actual subtitle*
 
-```ruby 
-ziggeo.application().get_stats(arguments = nil) 
-``` 
- 
-Arguments 
-- period: *Optional. Can be 'year' or 'month'.* 
+#### Bind<a name="method-streams-bind"></a>
 
+Closes and submits the stream
 
-### EffectProfiles  
+```ruby
+ziggeo.streams().bind(video_token_or_key, token_or_key, arguments = nil)
+```
 
-The effect profiles resource allows you to access and create effect profiles for your app. Each effect profile may contain one process or more. 
- 
+ Arguments
 
-#### Create 
- 
-Create a new effect profile. 
+### Authtokens<a name="method-authtokens"></a>
 
-```ruby 
-ziggeo.effectProfiles().create(arguments = nil) 
-``` 
- 
-Arguments 
-- key: *Effect profile key.* 
-- title: *Effect profile title.* 
-- default_effect: *Boolean. If TRUE, sets an effect profile as default. If FALSE, removes the default status for the given effect* 
 
+The auth token resource allows you to manage authorization settings for video objects.
 
-#### Index 
- 
-Get list of effect profiles. 
+#### Get<a name="method-authtokens-get"></a>
 
-```ruby 
-ziggeo.effectProfiles().index(arguments = nil) 
-``` 
- 
-Arguments 
-- limit: *Limit the number of returned effect profiles. Can be set up to 100.* 
-- skip: *Skip the first [n] entries.* 
-- reverse: *Reverse the order in which effect profiles are returned.* 
+Get a single auth token by token.
 
+```ruby
+ziggeo.authtokens().get(token)
+```
 
-#### Get 
- 
-Get a single effect profile 
+#### Update<a name="method-authtokens-update"></a>
 
-```ruby 
-ziggeo.effectProfiles().get(token_or_key) 
-``` 
- 
+Update single auth token by token.
 
+```ruby
+ziggeo.authtokens().update(token_or_key, arguments = nil)
+```
 
-#### Delete 
- 
-Delete the effect profile 
+ Arguments
+- volatile: *Will this object automatically be deleted if it remains empty?*
+- hidden: *If hidden, the token cannot be used directly.*
+- expiration_date: *Expiration date for the auth token (Unix epoch time format)*
+- usage_expiration_time: *Expiration time per session (seconds)*
+- session_limit: *Maximal number of sessions*
+- grants: *Permissions this tokens grants*
 
-```ruby 
-ziggeo.effectProfiles().delete(token_or_key) 
-``` 
- 
+#### Delete<a name="method-authtokens-delete"></a>
 
+Delete a single auth token by token.
 
-#### Update 
- 
-Updates an effect profile. 
+```ruby
+ziggeo.authtokens().delete(token_or_key)
+```
 
-```ruby 
-ziggeo.effectProfiles().update(token_or_key, arguments = nil) 
-``` 
- 
-Arguments 
-- default_effect: *Boolean. If TRUE, sets an effect profile as default. If FALSE, removes the default status for the given effect* 
+#### Create<a name="method-authtokens-create"></a>
 
+Create a new auth token.
 
-### EffectProfileProcess  
+```ruby
+ziggeo.authtokens().create(arguments = nil)
+```
 
-The process resource allows you to directly access all process associated with a single effect profile. 
- 
+ Arguments
+- volatile: *Will this object automatically be deleted if it remains empty?*
+- hidden: *If hidden, the token cannot be used directly.*
+- expiration_date: *Expiration date for the auth token (Unix epoch time format)*
+- usage_expiration_time: *Expiration time per session (seconds)*
+- session_limit: *Maximal number of sessions*
+- grants: *Permissions this tokens grants*
 
-#### Index 
- 
-Return all processes associated with a effect profile 
+### Application<a name="method-application"></a>
 
-```ruby 
-ziggeo.effectProfileProcess().index(effect_token_or_key, arguments = nil) 
-``` 
- 
-Arguments 
-- states: *Filter streams by state* 
 
+The application token resource allows you to manage your application.
 
-#### Get 
- 
-Get a single process 
+#### Get<a name="method-application-get"></a>
 
-```ruby 
-ziggeo.effectProfileProcess().get(effect_token_or_key, token_or_key) 
-``` 
- 
+Read application.
 
+```ruby
+ziggeo.application().get()
+```
 
-#### Delete 
- 
-Delete the process 
+#### Update<a name="method-application-update"></a>
 
-```ruby 
-ziggeo.effectProfileProcess().delete(effect_token_or_key, token_or_key) 
-``` 
- 
+Update application.
 
+```ruby
+ziggeo.application().update(arguments = nil)
+```
 
-#### Create Filter Process 
- 
-Create a new filter effect process 
+ Arguments
+- volatile: *Will this object automatically be deleted if it remains empty?*
+- name: *Name of the application*
+- auth_token_required_for_create: *Require auth token for creating videos*
+- auth_token_required_for_update: *Require auth token for updating videos*
+- auth_token_required_for_read: *Require auth token for reading videos*
+- auth_token_required_for_destroy: *Require auth token for deleting videos*
+- client_can_index_videos: *Client is allowed to perform the index operation*
+- client_cannot_access_unaccepted_videos: *Client cannot view unaccepted videos*
+- enable_video_subpages: *Enable hosted video pages*
 
-```ruby 
-ziggeo.effectProfileProcess().create_filter_process(effect_token_or_key, arguments = nil) 
-``` 
- 
-Arguments 
-- effect: *Effect to be applied in the process* 
+#### Get Stats<a name="method-application-get-stats"></a>
 
+Read application stats
 
-#### Create Watermark Process 
- 
-Attaches an image to a new stream 
+```ruby
+ziggeo.application().get_stats(arguments = nil)
+```
 
-```ruby 
-ziggeo.effectProfileProcess().create_watermark_process(effect_token_or_key, arguments = nil, file = nil) 
-``` 
- 
-Arguments 
-- file: *Image file to be attached* 
-- vertical_position: *Specify the vertical position of your watermark (a value between 0.0 and 1.0)* 
-- horizontal_position: *Specify the horizontal position of your watermark (a value between 0.0 and 1.0)* 
-- video_scale: *Specify the image scale of your watermark (a value between 0.0 and 1.0)* 
+ Arguments
+- period: *Optional. Can be 'year' or 'month'.*
 
+### Effect Profiles<a name="method-effect-profiles"></a>
 
-#### Edit Watermark Process 
- 
-Edits an existing watermark process. 
 
-```ruby 
-ziggeo.effectProfileProcess().edit_watermark_process(effect_token_or_key, token_or_key, arguments = nil, file = nil) 
-``` 
- 
-Arguments 
-- file: *Image file to be attached* 
-- vertical_position: *Specify the vertical position of your watermark (a value between 0.0 and 1.0)* 
-- horizontal_position: *Specify the horizontal position of your watermark (a value between 0.0 and 1.0)* 
-- video_scale: *Specify the image scale of your watermark (a value between 0.0 and 1.0)* 
+The effect profiles resource allows you to access and create effect profiles for your app. Each effect profile may contain one process or more.
 
+#### Create<a name="method-effect-profiles-create"></a>
 
-### MetaProfiles  
+Create a new effect profile.
 
-The meta profiles resource allows you to access and create meta profiles for your app. Each meta profile may contain one process or more. 
- 
+```ruby
+ziggeo.effectProfiles().create(arguments = nil)
+```
 
-#### Create 
- 
-Create a new meta profile. 
+ Arguments
+- key: *Effect profile key.*
+- title: *Effect profile title.*
+- default_effect: *Boolean. If TRUE, sets an effect profile as default. If FALSE, removes the default status for the given effect*
 
-```ruby 
-ziggeo.metaProfiles().create(arguments = nil) 
-``` 
- 
-Arguments 
-- key: *Meta Profile profile key.* 
-- title: *Meta Profile profile title.* 
+#### Index<a name="method-effect-profiles-index"></a>
 
+Get list of effect profiles.
 
-#### Index 
- 
-Get list of meta profiles. 
+```ruby
+ziggeo.effectProfiles().index(arguments = nil)
+```
 
-```ruby 
-ziggeo.metaProfiles().index(arguments = nil) 
-``` 
- 
-Arguments 
-- limit: *Limit the number of returned meta profiles. Can be set up to 100.* 
-- skip: *Skip the first [n] entries.* 
-- reverse: *Reverse the order in which meta profiles are returned.* 
+ Arguments
+- limit: *Limit the number of returned effect profiles. Can be set up to 100.*
+- skip: *Skip the first [n] entries.*
+- reverse: *Reverse the order in which effect profiles are returned.*
 
+#### Get<a name="method-effect-profiles-get"></a>
 
-#### Get 
- 
-Get a single meta profile 
+Get a single effect profile
 
-```ruby 
-ziggeo.metaProfiles().get(token_or_key) 
-``` 
- 
+```ruby
+ziggeo.effectProfiles().get(token_or_key)
+```
 
+#### Delete<a name="method-effect-profiles-delete"></a>
 
-#### Delete 
- 
-Delete the meta profile 
+Delete the effect profile
 
-```ruby 
-ziggeo.metaProfiles().delete(token_or_key) 
-``` 
- 
+```ruby
+ziggeo.effectProfiles().delete(token_or_key)
+```
 
+#### Update<a name="method-effect-profiles-update"></a>
 
-### MetaProfileProcess  
+Updates an effect profile.
 
-The process resource allows you to directly access all process associated with a single meta profile. 
- 
+```ruby
+ziggeo.effectProfiles().update(token_or_key, arguments = nil)
+```
 
-#### Index 
- 
-Return all processes associated with a meta profile 
+ Arguments
+- default_effect: *Boolean. If TRUE, sets an effect profile as default. If FALSE, removes the default status for the given effect*
 
-```ruby 
-ziggeo.metaProfileProcess().index(meta_token_or_key) 
-``` 
- 
+### Effect Profile Process<a name="method-effect-profile-process"></a>
 
 
-#### Get 
- 
-Get a single process 
+The process resource allows you to directly access all process associated with a single effect profile.
 
-```ruby 
-ziggeo.metaProfileProcess().get(meta_token_or_key, token_or_key) 
-``` 
- 
+#### Index<a name="method-effect-profile-process-index"></a>
 
+Return all processes associated with a effect profile
 
-#### Delete 
- 
-Delete the process 
+```ruby
+ziggeo.effectProfileProcess().index(effect_token_or_key, arguments = nil)
+```
 
-```ruby 
-ziggeo.metaProfileProcess().delete(meta_token_or_key, token_or_key) 
-``` 
- 
+ Arguments
+- states: *Filter streams by state*
 
+#### Get<a name="method-effect-profile-process-get"></a>
 
-#### Create Video Analysis Process 
- 
-Create a new video analysis meta process 
+Get a single process
 
-```ruby 
-ziggeo.metaProfileProcess().create_video_analysis_process(meta_token_or_key) 
-``` 
- 
+```ruby
+ziggeo.effectProfileProcess().get(effect_token_or_key, token_or_key)
+```
 
+#### Delete<a name="method-effect-profile-process-delete"></a>
 
-#### Create Audio Transcription Process 
- 
-Create a new audio transcription meta process 
+Delete the process
 
-```ruby 
-ziggeo.metaProfileProcess().create_audio_transcription_process(meta_token_or_key) 
-``` 
- 
+```ruby
+ziggeo.effectProfileProcess().delete(effect_token_or_key, token_or_key)
+```
 
+#### Create Filter Process<a name="method-effect-profile-process-create-filter-process"></a>
 
-#### Create Nsfw Process 
- 
-Create a new nsfw filter meta process 
+Create a new filter effect process
 
-```ruby 
-ziggeo.metaProfileProcess().create_nsfw_process(meta_token_or_key, arguments = nil) 
-``` 
- 
-Arguments 
-- nsfw_action: *One of the following three: approve, reject, nothing.* 
+```ruby
+ziggeo.effectProfileProcess().create_filter_process(effect_token_or_key, arguments = nil)
+```
 
+ Arguments
+- effect: *Effect to be applied in the process*
 
-### Webhooks  
+#### Create Watermark Process<a name="method-effect-profile-process-create-watermark-process"></a>
 
-The webhooks resource allows you to create or delete webhooks related to a given application. 
- 
+Attaches an image to a new stream
 
-#### Create 
- 
-Create a new webhook for the given url to catch the given events. 
+```ruby
+ziggeo.effectProfileProcess().create_watermark_process(effect_token_or_key, arguments = nil, file = nil)
+```
 
-```ruby 
-ziggeo.webhooks().create(arguments = nil) 
-``` 
- 
-Arguments 
-- target_url: *The url that will catch the events* 
-- encoding: *Data encoding to be used by the webhook to send the events.* 
-- events: *Comma-separated list of the events the webhook will catch. They must be valid webhook type events.* 
+ Arguments
+- file: *Image file to be attached*
+- vertical_position: *Specify the vertical position of your watermark (a value between 0.0 and 1.0)*
+- horizontal_position: *Specify the horizontal position of your watermark (a value between 0.0 and 1.0)*
+- video_scale: *Specify the image scale of your watermark (a value between 0.0 and 1.0)*
 
+#### Edit Watermark Process<a name="method-effect-profile-process-edit-watermark-process"></a>
 
-#### Confirm 
- 
-Confirm a webhook using its ID and the corresponding validation code. 
+Edits an existing watermark process.
 
-```ruby 
-ziggeo.webhooks().confirm(arguments = nil) 
-``` 
- 
-Arguments 
-- webhook_id: *Webhook ID that's returned in the creation call.* 
-- validation_code: *Validation code that is sent to the webhook when created.* 
+```ruby
+ziggeo.effectProfileProcess().edit_watermark_process(effect_token_or_key, token_or_key, arguments = nil, file = nil)
+```
 
+ Arguments
+- file: *Image file to be attached*
+- vertical_position: *Specify the vertical position of your watermark (a value between 0.0 and 1.0)*
+- horizontal_position: *Specify the horizontal position of your watermark (a value between 0.0 and 1.0)*
+- video_scale: *Specify the image scale of your watermark (a value between 0.0 and 1.0)*
 
-#### Delete 
- 
-Delete a webhook using its URL. 
+### Meta Profiles<a name="method-meta-profiles"></a>
 
-```ruby 
-ziggeo.webhooks().delete(arguments = nil) 
-``` 
- 
-Arguments 
-- target_url: *The url that will catch the events* 
 
+The meta profiles resource allows you to access and create meta profiles for your app. Each meta profile may contain one process or more.
 
-### Analytics  
+#### Create<a name="method-meta-profiles-create"></a>
 
-The analytics resource allows you to access the analytics for the given application 
- 
+Create a new meta profile.
 
-#### Get 
- 
-Get analytics for the given params 
+```ruby
+ziggeo.metaProfiles().create(arguments = nil)
+```
 
-```ruby 
-ziggeo.analytics().get(arguments = nil) 
-``` 
- 
-Arguments 
-- from: *A UNIX timestamp in microseconds used as the start date of the query* 
-- to: *A UNIX timestamp in microseconds used as the end date of the query* 
-- date: *A UNIX timestamp in microseconds to retrieve data from a single date. If set, it overwrites the from and to params.* 
-- query: *The query you want to run. It can be one of the following: device_views_by_os, device_views_by_date, total_plays_by_country, full_plays_by_country, total_plays_by_hour, full_plays_by_hour, total_plays_by_browser, full_plays_by_browser* 
+ Arguments
+- key: *Meta Profile profile key.*
+- title: *Meta Profile profile title.*
+
+#### Index<a name="method-meta-profiles-index"></a>
+
+Get list of meta profiles.
+
+```ruby
+ziggeo.metaProfiles().index(arguments = nil)
+```
+
+ Arguments
+- limit: *Limit the number of returned meta profiles. Can be set up to 100.*
+- skip: *Skip the first [n] entries.*
+- reverse: *Reverse the order in which meta profiles are returned.*
+
+#### Get<a name="method-meta-profiles-get"></a>
+
+Get a single meta profile
+
+```ruby
+ziggeo.metaProfiles().get(token_or_key)
+```
+
+#### Delete<a name="method-meta-profiles-delete"></a>
+
+Delete the meta profile
+
+```ruby
+ziggeo.metaProfiles().delete(token_or_key)
+```
+
+### Meta Profile Process<a name="method-meta-profile-process"></a>
+
+
+The process resource allows you to directly access all process associated with a single meta profile.
+
+#### Index<a name="method-meta-profile-process-index"></a>
+
+Return all processes associated with a meta profile
+
+```ruby
+ziggeo.metaProfileProcess().index(meta_token_or_key)
+```
+
+#### Get<a name="method-meta-profile-process-get"></a>
+
+Get a single process
+
+```ruby
+ziggeo.metaProfileProcess().get(meta_token_or_key, token_or_key)
+```
+
+#### Delete<a name="method-meta-profile-process-delete"></a>
+
+Delete the process
+
+```ruby
+ziggeo.metaProfileProcess().delete(meta_token_or_key, token_or_key)
+```
+
+#### Create Video Analysis Process<a name="method-meta-profile-process-create-video-analysis-process"></a>
+
+Create a new video analysis meta process
+
+```ruby
+ziggeo.metaProfileProcess().create_video_analysis_process(meta_token_or_key)
+```
+
+#### Create Audio Transcription Process<a name="method-meta-profile-process-create-audio-transcription-process"></a>
+
+Create a new audio transcription meta process
+
+```ruby
+ziggeo.metaProfileProcess().create_audio_transcription_process(meta_token_or_key)
+```
+
+#### Create Nsfw Process<a name="method-meta-profile-process-create-nsfw-process"></a>
+
+Create a new nsfw filter meta process
+
+```ruby
+ziggeo.metaProfileProcess().create_nsfw_process(meta_token_or_key, arguments = nil)
+```
+
+ Arguments
+- nsfw_action: *One of the following three: approve, reject, nothing.*
+
+#### Create Profanity Process<a name="method-meta-profile-process-create-profanity-process"></a>
+
+Create a new profanity filter meta process
+
+```ruby
+ziggeo.metaProfileProcess().create_profanity_process(meta_token_or_key, arguments = nil)
+```
+
+ Arguments
+- profanity_action: *One of the following three: approve, reject, nothing.*
+
+### Webhooks<a name="method-webhooks"></a>
+
+
+The webhooks resource allows you to create or delete webhooks related to a given application.
+
+#### Create<a name="method-webhooks-create"></a>
+
+Create a new webhook for the given url to catch the given events.
+
+```ruby
+ziggeo.webhooks().create(arguments = nil)
+```
+
+ Arguments
+- target_url: *The url that will catch the events*
+- encoding: *Data encoding to be used by the webhook to send the events.*
+- events: *Comma-separated list of the events the webhook will catch. They must be valid webhook type events.*
+
+#### Confirm<a name="method-webhooks-confirm"></a>
+
+Confirm a webhook using its ID and the corresponding validation code.
+
+```ruby
+ziggeo.webhooks().confirm(arguments = nil)
+```
+
+ Arguments
+- webhook_id: *Webhook ID that's returned in the creation call.*
+- validation_code: *Validation code that is sent to the webhook when created.*
+
+#### Delete<a name="method-webhooks-delete"></a>
+
+Delete a webhook using its URL.
+
+```ruby
+ziggeo.webhooks().delete(arguments = nil)
+```
+
+ Arguments
+- target_url: *The url that will catch the events*
+
+### Analytics<a name="method-analytics"></a>
+
+
+The analytics resource allows you to access the analytics for the given application
+
+#### Get<a name="method-analytics-get"></a>
+
+Get analytics for the given params
+
+```ruby
+ziggeo.analytics().get(arguments = nil)
+```
+
+ Arguments
+- from: *A UNIX timestamp in microseconds used as the start date of the query*
+- to: *A UNIX timestamp in microseconds used as the end date of the query*
+- date: *A UNIX timestamp in microseconds to retrieve data from a single date. If set, it overwrites the from and to params.*
+- query: *The query you want to run. It can be one of the following: device_views_by_os, device_views_by_date, total_plays_by_country, full_plays_by_country, total_plays_by_hour, full_plays_by_hour, total_plays_by_browser, full_plays_by_browser*
 
 
 
 
 
-## License
+## License <a name="license"></a>
 
-Copyright (c) 2013-2020 Ziggeo
+Copyright (c) 2013-2021 Ziggeo
  
 Apache 2.0 License