Ziggeo 2.26 → 2.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d66106c85f75e46affc2e3f874bc93c18c1f4afb94c86472e264f13198f964d8
-  data.tar.gz: 7071ad43e3fef3825cb67bf86bc10315e8de84aa0ccd132bf5f421d3150f0c6d
+  metadata.gz: a56bf11e9e44b493db87694f14ac2451420b9186d9d9db6fdd6c72e6732312e5
+  data.tar.gz: 159633653ddb74b0ed6abf4d1527b511e615fcb0d84ab5a7a97a71cb0ad7e763
 SHA512:
-  metadata.gz: cd4c00e3fc72937933841ace5956f88689ce6f851779fa0e5f5d9edca683511ad9b05a1aecc47b1b196f2f3db2581e35bd25e858df2eec05d3f88ed3ab51a910
-  data.tar.gz: b2bddfd93042da50cda78831c6959ffe71e5d5d3eda8712a583b62bfd7876f62091c57ebdfe97800d42fed43324be558d655ccccd78c520ceeac9a48975c6c43
+  metadata.gz: 770f8adb4fcca15cb84b0d6f4cbeae99327bc46c732b7dfc2e34d3f83de8356a0ac5203d61f3e8d056cb52a0b50c26da11c0d73245be464251b3294754007987
+  data.tar.gz: 984f4395288cc69f5a31ccc72b877af69a289dedd5083a28aaa8a94f21bac035c7e8f7c0bd3fbb5fc9bd2302d0b4863f63bcd78e66e1d0f3741b6950f5473cde

data/README.md

@@ -1,6 +1,6 @@
 # Ziggeo's Ruby Server SDK
 
-latest version: **2.26**
+latest version: **2.29**
 
 ## Index
 
@@ -41,35 +41,50 @@ latest version: **2.26**
         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)
+    5. [Methods for Audios](#method-audios)
+        1. [Audios Index](#method-audios-index)
+        2. [Audios Count](#method-audios-count)
+        3. [Audios Get](#method-audios-get)
+        4. [Audios Get Bulk](#method-audios-get-bulk)
+        5. [Audios Download Audio](#method-audios-download-audio)
+        6. [Audios Update](#method-audios-update)
+        7. [Audios Update Bulk](#method-audios-update-bulk)
+        8. [Audios Delete](#method-audios-delete)
+        9. [Audios Create](#method-audios-create)
+    6. [Methods for Audio_streams](#method-audio-streams)
+        1. [Audio_streams Index](#method-audio-streams-index)
+        2. [Audio_streams Get](#method-audio-streams-get)
+        3. [Audio_streams Download Audio](#method-audio-streams-download-audio)
+        4. [Audio_streams Delete](#method-audio-streams-delete)
+        5. [Audio_streams Create](#method-audio-streams-create)
+    7. [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)
+    8. [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)
+    9. [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)
+    10. [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)
+    11. [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)
+    12. [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)
@@ -77,11 +92,11 @@ latest version: **2.26**
         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)
+    13. [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)
+    14. [Methods for Analytics](#method-analytics)
         1. [Analytics Get](#method-analytics-get)
 5. [License](#license)
 
@@ -175,14 +190,16 @@ Currently available methods are branched off within different categories:
 
 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
+3. Audios
+4. Audio_streams
+5. Authtokens
+6. Application
+7. Effect Profiles
+8. Effect Profile Process
+9. Meta Profiles
+10. Meta Profile Process
+11. Webhooks
+12. Analytics
 
 Each of this sections has their own actions and they are explained bellow
 
@@ -455,7 +472,7 @@ ziggeo.streams().create(video_token_or_key, arguments = nil, file = nil)
 
 #### Attach Image<a name="method-streams-attach-image"></a>
 
-Attaches an image to a new stream
+Attaches an image to a new stream. Must be attached before video, since video upload triggers the transcoding job and binds the stream
 
 ```ruby
 ziggeo.streams().attach_image(video_token_or_key, token_or_key, arguments = nil, file = nil)
@@ -488,15 +505,173 @@ ziggeo.streams().attach_subtitle(video_token_or_key, token_or_key, arguments = n
 - label: *Subtitle reference*
 - data: *Actual subtitle*
 
-#### Bind<a name="method-streams-bind"></a>
+### Audios<a name="method-audios"></a>
+
+
+The audios resource allows you to access all single audios. Each video may contain more than one stream.
+
+#### Index<a name="method-audios-index"></a>
+
+Query an array of audios (will return at most 50 audios by default). Newest audios come first.
+
+```ruby
+ziggeo.audios().index(arguments = nil)
+```
+
+ Arguments
+- limit: *Limit the number of returned audios. Can be set up to 100.*
+- skip: *Skip the first [n] entries.*
+- reverse: *Reverse the order in which audios are returned.*
+- states: *Filter audios by state*
+- tags: *Filter the search result to certain tags, encoded as a comma-separated string*
+
+#### Count<a name="method-audios-count"></a>
+
+Get the audio count for the application.
+
+```ruby
+ziggeo.audios().count(arguments = nil)
+```
+
+ Arguments
+- states: *Filter audios by state*
+- tags: *Filter the search result to certain tags, encoded as a comma-separated string*
+
+#### Get<a name="method-audios-get"></a>
+
+Get a single audio by token or key.
+
+```ruby
+ziggeo.audios().get(token_or_key)
+```
+
+#### Get Bulk<a name="method-audios-get-bulk"></a>
+
+Get multiple audios by tokens or keys.
+
+```ruby
+ziggeo.audios().get_bulk(arguments = nil)
+```
+
+ Arguments
+- tokens_or_keys: *Comma-separated list with the desired audios tokens or keys (Limit: 100 tokens or keys).*
+
+#### Download Audio<a name="method-audios-download-audio"></a>
+
+Download the audio data file
+
+```ruby
+ziggeo.audios().download_audio(token_or_key)
+```
+
+#### Update<a name="method-audios-update"></a>
+
+Update single audio by token or key.
+
+```ruby
+ziggeo.audios().update(token_or_key, arguments = nil)
+```
+
+ Arguments
+- min_duration: *Minimal duration of audio*
+- max_duration: *Maximal duration of audio*
+- tags: *Audio Tags*
+- key: *Unique (optional) name of audio*
+- volatile: *Automatically removed this audio if it remains empty*
+- expiration_days: *After how many days will this audio be deleted*
+- expire_on: *On which date will this audio be deleted. String in ISO 8601 format: YYYY-MM-DD*
+
+#### Update Bulk<a name="method-audios-update-bulk"></a>
+
+Update multiple audios by token or key.
+
+```ruby
+ziggeo.audios().update_bulk(arguments = nil)
+```
+
+ Arguments
+- tokens_or_keys: *Comma-separated list with the desired audios tokens or keys (Limit: 100 tokens or keys).*
+- min_duration: *Minimal duration of audio*
+- max_duration: *Maximal duration of audio*
+- tags: *Audio Tags*
+- volatile: *Automatically removed this audio if it remains empty*
+- expiration_days: *After how many days will this audio be deleted*
+- expire_on: *On which date will this audio be deleted. String in ISO 8601 format: YYYY-MM-DD*
+
+#### Delete<a name="method-audios-delete"></a>
+
+Delete a single audio by token or key.
+
+```ruby
+ziggeo.audios().delete(token_or_key)
+```
+
+#### Create<a name="method-audios-create"></a>
+
+Create a new audio.
+
+```ruby
+ziggeo.audios().create(arguments = nil, file = nil)
+```
+
+ Arguments
+- file: *Audio file to be uploaded*
+- min_duration: *Minimal duration of audio*
+- max_duration: *Maximal duration of audio*
+- tags: *Audio Tags*
+- key: *Unique (optional) name of audio*
+- volatile: *Automatically removed this video if it remains empty*
+
+### Audio_streams<a name="method-audio-streams"></a>
 
-Closes and submits the stream
+
+The streams resource allows you to directly access all streams associated with a single audio.
+
+#### Index<a name="method-audio-streams-index"></a>
+
+Return all streams associated with a audio
+
+```ruby
+ziggeo.audio_streams().index(audio_token_or_key, arguments = nil)
+```
+
+ Arguments
+- states: *Filter streams by state*
+
+#### Get<a name="method-audio-streams-get"></a>
+
+Get a single stream
+
+```ruby
+ziggeo.audio_streams().get(audio_token_or_key, token_or_key)
+```
+
+#### Download Audio<a name="method-audio-streams-download-audio"></a>
+
+Download the audio data associated with the stream
+
+```ruby
+ziggeo.audio_streams().download_audio(audio_token_or_key, token_or_key)
+```
+
+#### Delete<a name="method-audio-streams-delete"></a>
+
+Delete the stream
+
+```ruby
+ziggeo.audio_streams().delete(audio_token_or_key, token_or_key)
+```
+
+#### Create<a name="method-audio-streams-create"></a>
+
+Create a new stream
 
 ```ruby
-ziggeo.streams().bind(video_token_or_key, token_or_key, arguments = nil)
+ziggeo.audio_streams().create(audio_token_or_key, arguments = nil, file = nil)
 ```
 
  Arguments
+- file: *Audio file to be uploaded*
 
 ### Authtokens<a name="method-authtokens"></a>
 
@@ -902,6 +1077,6 @@ ziggeo.analytics().get(arguments = nil)
 
 ## License <a name="license"></a>
 
-Copyright (c) 2013-2021 Ziggeo
+Copyright (c) 2013-2022 Ziggeo
  
 Apache 2.0 License

data/lib/Ziggeo.rb

@@ -8,6 +8,8 @@ require_relative "classes/ZiggeoConnect"
 require_relative "classes/ZiggeoAuth"
 require_relative "classes/ZiggeoVideos"
 require_relative "classes/ZiggeoStreams"
+require_relative "classes/ZiggeoAudios"
+require_relative "classes/ZiggeoAudio_streams"
 require_relative "classes/ZiggeoAuthtokens"
 require_relative "classes/ZiggeoApplication"
 require_relative "classes/ZiggeoEffectProfiles"
@@ -53,6 +55,8 @@ class Ziggeo
         @auth = nil
         @videos = nil
         @streams = nil
+        @audios = nil
+        @audio_streams = nil
         @authtokens = nil
         @application = nil
         @effectProfiles = nil
@@ -86,6 +90,16 @@ class Ziggeo
         return @streams
     end
 
+    def audios()
+        @audios = @audios || ZiggeoAudios.new(self)
+        return @audios
+    end
+
+    def audio_streams()
+        @audio_streams = @audio_streams || ZiggeoAudio_streams.new(self)
+        return @audio_streams
+    end
+
     def authtokens()
         @authtokens = @authtokens || ZiggeoAuthtokens.new(self)
         return @authtokens

data/lib/classes/ZiggeoAudioStreams.rb

@@ -0,0 +1,33 @@
+class ZiggeoAudio_streams
+
+  def initialize(application)
+    @application = application
+  end
+
+  def index(audio_token_or_key, data = nil)
+    return @application.api_connect.getJSON('/server/v1/audios/bytoken/' + audio_token_or_key + '/streams', data)
+  end
+
+  def get(audio_token_or_key, token_or_key)
+    return @application.api_connect.getJSON('/server/v1/audios/bytoken/' + audio_token_or_key + '/streams/bytoken/' + token_or_key + '')
+  end
+
+  def download_audio(audio_token_or_key, token_or_key)
+    return @application.connect.get('/v1/server/v1/audios/bytoken/' + audio_token_or_key + '/streams/bytoken/' + token_or_key + '/audio')
+  end
+
+  def delete(audio_token_or_key, token_or_key)
+    return @application.api_connect.delete('/server/v1/audios/bytoken/' + audio_token_or_key + '/streams/bytoken/' + token_or_key + '')
+  end
+
+  def create(audio_token_or_key, data = nil, file = nil)
+    unless file.nil?
+      result = @application.connect.postUploadJSON('/server/v1/audios/' + audio_token_or_key + '/streams-upload-url', 'stream', data, file, 'audio_type')
+      result = @application.connect.postJSON('/server/v1/audios/' + audio_token_or_key + '/streams/' + result["token"] + '/confirm-video');
+      return result
+    else
+      return @application.api_connect.postJSON('/server/v1/audios/bytoken/' + audio_token_or_key + '/streams', data, file)
+    end
+  end
+
+end

data/lib/classes/ZiggeoAudios.rb

@@ -0,0 +1,49 @@
+class ZiggeoAudios
+
+  def initialize(application)
+    @application = application
+  end
+
+  def index(data = nil)
+    return @application.api_connect.getJSON('/server/v1/audios/', data)
+  end
+
+  def count(data = nil)
+    return @application.api_connect.getJSON('/server/v1/audios/count', data)
+  end
+
+  def get(token_or_key)
+    return @application.api_connect.getJSON('/server/v1/audios/bytoken/' + token_or_key + '')
+  end
+
+  def get_bulk(data = nil)
+    return @application.api_connect.postJSON('/server/v1/audios/get-bulk', data)
+  end
+
+  def download_audio(token_or_key)
+    return @application.connect.get('/v1/server/v1/audios/bytoken/' + token_or_key + '/video')
+  end
+
+  def update(token_or_key, data = nil)
+    return @application.api_connect.postJSON('/server/v1/audios/bytoken/' + token_or_key + '', data)
+  end
+
+  def update_bulk(data = nil)
+    return @application.api_connect.postJSON('/server/v1/audios/update-bulk', data)
+  end
+
+  def delete(token_or_key)
+    return @application.api_connect.delete('/server/v1/audios/bytoken/' + token_or_key + '')
+  end
+
+  def create(data = nil, file = nil)
+    unless file.nil?
+      result = @application.connect.postUploadJSON('/server/v1/audios/audios-upload-url', 'audio', data, file, 'audio_type')
+      result["default_stream"] = @application.connect.postJSON('/server/v1/audios/' + result["token"] + '/streams/' + result["default_stream"]["token"] + '/confirm-audio');
+      return result
+    else
+      return @application.api_connect.postJSON('/server/v1/audios/', data, file)
+    end
+  end
+
+end

data/lib/classes/ZiggeoStreams.rb

@@ -62,8 +62,4 @@ class ZiggeoStreams
     return @application.connect.postJSON('/v1/videos/' + video_token_or_key + '/streams/' + token_or_key + '/subtitle', data)
   end
 
-  def bind(video_token_or_key, token_or_key)
-    return @application.connect.postJSON('/v1/videos/' + video_token_or_key + '/streams/' + token_or_key + '/bind')
-  end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: Ziggeo
 version: !ruby/object:Gem::Version
-  version: '2.26'
+  version: '2.29'
 platform: ruby
 authors:
 - Ziggeo, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-26 00:00:00.000000000 Z
+date: 2022-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -35,6 +35,8 @@ files:
 - lib/Ziggeo.rb
 - lib/classes/ZiggeoAnalytics.rb
 - lib/classes/ZiggeoApplication.rb
+- lib/classes/ZiggeoAudioStreams.rb
+- lib/classes/ZiggeoAudios.rb
 - lib/classes/ZiggeoAuth.rb
 - lib/classes/ZiggeoAuthtokens.rb
 - lib/classes/ZiggeoConfig.rb
@@ -65,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: The Ziggeo ServerSDK gem.