livepeer 0.0.1 → 0.0.2

data/lib/sdk/sdk.rb

@@ -12,7 +12,7 @@ module Livepeer
   class SDK
     extend T::Sig
 
-    attr_accessor :stream, :multistream_target, :webhook, :asset, :metrics, :session, :access_control, :task, :transcode, :playback
+    attr_accessor :stream, :multistream_target, :webhook, :asset, :session, :metrics, :signing_key, :task, :transcode, :playback
 
     attr_accessor :security, :language, :sdk_version, :gen_version
 
@@ -78,12 +78,42 @@ module Livepeer
       @multistream_target = MultistreamTarget.new(@sdk_configuration)
       @webhook = Webhook.new(@sdk_configuration)
       @asset = Asset.new(@sdk_configuration)
-      @metrics = Metrics.new(@sdk_configuration)
       @session = Session.new(@sdk_configuration)
-      @access_control = AccessControl.new(@sdk_configuration)
+      @metrics = Metrics.new(@sdk_configuration)
+      @signing_key = SigningKey.new(@sdk_configuration)
       @task = Task.new(@sdk_configuration)
       @transcode = Transcode.new(@sdk_configuration)
       @playback = Playback.new(@sdk_configuration)
     end
+
+    
+    sig { returns(Utils::FieldAugmented) }
+    def get_all
+      # get_all - Retrieves signing keys
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
+      url = "#{base_url}/access-control/signing-key"
+      headers = {}
+      headers['Accept'] = 'application/json'
+      headers['user-agent'] = @sdk_configuration.user_agent
+
+      r = @sdk_configuration.client.get(url) do |req|
+        req.headers = headers
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
+      end
+
+      content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
+
+      res = Operations::GetSigningKeysResponse.new(
+        status_code: r.status, content_type: content_type, raw_response: r
+      )
+      if r.status == 200
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, T::Array[Shared::SigningKey])
+          res.classes = out
+        end
+      end
+      res
+    end
   end
 end

data/lib/sdk/sdkconfiguration.rb

@@ -37,9 +37,9 @@ module OpenApiSDK
       @server_idx = server_idx.nil? ? 0 : server_idx
       @language = 'ruby'
       @openapi_doc_version = '1.0.0'
-      @sdk_version = '0.0.1'
-      @gen_version = '2.188.1'
-      @user_agent = 'speakeasy-sdk/ruby 0.0.1 2.188.1 1.0.0 livepeer'
+      @sdk_version = '0.0.2'
+      @gen_version = '2.188.3'
+      @user_agent = 'speakeasy-sdk/ruby 0.0.2 2.188.3 1.0.0 livepeer'
     end
 
     sig { returns([String, T::Hash[Symbol, String]]) }

data/lib/sdk/session.rb

@@ -17,6 +17,44 @@ module Livepeer
       @sdk_configuration = sdk_config
     end
 
+    sig { params(id: String).returns(Utils::FieldAugmented) }
+    def get_all_clips(id)
+      # get_all_clips - Retrieve clips of a session
+      request = Operations::GetSessionIdClipsRequest.new(
+        
+        id: id
+      )
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
+      url = Utils.generate_url(
+        Operations::GetSessionIdClipsRequest,
+        base_url,
+        '/session/{id}/clips',
+        request
+      )
+      headers = {}
+      headers['Accept'] = 'application/json'
+      headers['user-agent'] = @sdk_configuration.user_agent
+
+      r = @sdk_configuration.client.get(url) do |req|
+        req.headers = headers
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
+      end
+
+      content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
+
+      res = Operations::GetSessionIdClipsResponse.new(
+        status_code: r.status, content_type: content_type, raw_response: r
+      )
+      if r.status == 200
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, T::Array[Shared::Asset])
+          res.classes = out
+        end
+      end
+      res
+    end
+
     sig { returns(Utils::FieldAugmented) }
     def get_all
       # get_all - Retrieve sessions
@@ -40,7 +78,7 @@ module Livepeer
       if r.status == 200
         if Utils.match_content_type(content_type, 'application/json')
           out = Utils.unmarshal_complex(r.env.response_body, T::Array[Shared::Session])
-          res.data = out
+          res.classes = out
         end
       end
       res
@@ -119,45 +157,7 @@ module Livepeer
       if r.status == 200
         if Utils.match_content_type(content_type, 'application/json')
           out = Utils.unmarshal_complex(r.env.response_body, T::Array[Shared::Session])
-          res.data = out
-        end
-      end
-      res
-    end
-
-    sig { params(id: String).returns(Utils::FieldAugmented) }
-    def get_all_clips(id)
-      # get_all_clips - Retrieve clips of a session
-      request = Operations::GetSessionIdClipsRequest.new(
-        
-        id: id
-      )
-      url, params = @sdk_configuration.get_server_details
-      base_url = Utils.template_url(url, params)
-      url = Utils.generate_url(
-        Operations::GetSessionIdClipsRequest,
-        base_url,
-        '/session/{id}/clips',
-        request
-      )
-      headers = {}
-      headers['Accept'] = 'application/json'
-      headers['user-agent'] = @sdk_configuration.user_agent
-
-      r = @sdk_configuration.client.get(url) do |req|
-        req.headers = headers
-        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
-      end
-
-      content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
-
-      res = Operations::GetSessionIdClipsResponse.new(
-        status_code: r.status, content_type: content_type, raw_response: r
-      )
-      if r.status == 200
-        if Utils.match_content_type(content_type, 'application/json')
-          out = Utils.unmarshal_complex(r.env.response_body, T::Array[Shared::Asset])
-          res.data = out
+          res.classes = out
         end
       end
       res

data/lib/sdk/{access_control.rb → signing_key.rb}

@@ -9,7 +9,7 @@ require 'sorbet-runtime'
 
 module Livepeer
   extend T::Sig
-  class AccessControl
+  class SigningKey
 
     extend T::Sig
     sig { params(sdk_config: SDKConfiguration).void }
@@ -18,37 +18,12 @@ module Livepeer
     end
 
     sig { returns(Utils::FieldAugmented) }
-    def get_signing_keys
-      # get_signing_keys - Retrieves signing keys
-      url, params = @sdk_configuration.get_server_details
-      base_url = Utils.template_url(url, params)
-      url = "#{base_url}/access-control/signing-key"
-      headers = {}
-      headers['Accept'] = 'application/json'
-      headers['user-agent'] = @sdk_configuration.user_agent
-
-      r = @sdk_configuration.client.get(url) do |req|
-        req.headers = headers
-        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
-      end
-
-      content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
-
-      res = Operations::GetSigningKeysResponse.new(
-        status_code: r.status, content_type: content_type, raw_response: r
-      )
-      if r.status == 200
-        if Utils.match_content_type(content_type, 'application/json')
-          out = Utils.unmarshal_complex(r.env.response_body, T::Array[Shared::SigningKey])
-          res.data = out
-        end
-      end
-      res
-    end
-
-    sig { returns(Utils::FieldAugmented) }
-    def create_signing_key
-      # create_signing_key - Create a signing key
+    def create
+      # create - Create a signing key
+      # 
+      # The publicKey is a representation of the public key, encoded as base 64 and is passed as a string, and  the privateKey is displayed only on creation. This is the only moment where the client can save the private key, otherwise it will be lost. Remember to decode your string when signing JWTs.
+      # Up to 10 signing keys can be generated, after that you must delete at least one signing key to create a new one.
+      # 
       url, params = @sdk_configuration.get_server_details
       base_url = Utils.template_url(url, params)
       url = "#{base_url}/access-control/signing-key"
@@ -68,16 +43,16 @@ module Livepeer
       )
       if r.status == 200
         if Utils.match_content_type(content_type, 'application/json')
-          out = Utils.unmarshal_complex(r.env.response_body, Shared::SigningKeyResponsePayload)
-          res.signing_key_response_payload = out
+          out = Utils.unmarshal_complex(r.env.response_body, Shared::SigningKey)
+          res.signing_key = out
         end
       end
       res
     end
 
     sig { params(key_id: String).returns(Utils::FieldAugmented) }
-    def delete_signing_key(key_id)
-      # delete_signing_key - Delete Signing Key
+    def delete(key_id)
+      # delete - Delete Signing Key
       request = Operations::DeleteSigningKeyRequest.new(
         
         key_id: key_id
@@ -110,8 +85,8 @@ module Livepeer
     end
 
     sig { params(key_id: String).returns(Utils::FieldAugmented) }
-    def get_signing_key(key_id)
-      # get_signing_key - Retrieves a signing key
+    def get(key_id)
+      # get - Retrieves a signing key
       request = Operations::GetSigningKeyRequest.new(
         
         key_id: key_id
@@ -148,8 +123,8 @@ module Livepeer
     end
 
     sig { params(key_id: String, request_body: Operations::UpdateSigningKeyRequestBody).returns(Utils::FieldAugmented) }
-    def update_signing_key(key_id, request_body)
-      # update_signing_key - Update a signing key
+    def update(key_id, request_body)
+      # update - Update a signing key
       request = Operations::UpdateSigningKeyRequest.new(
         
         key_id: key_id,

data/lib/sdk/stream.rb

@@ -46,7 +46,7 @@ module Livepeer
       if r.status == 200
         if Utils.match_content_type(content_type, 'application/json')
           out = Utils.unmarshal_complex(r.env.response_body, T::Array[Shared::Stream])
-          res.data = out
+          res.classes = out
         end
       end
       res
@@ -55,6 +55,20 @@ module Livepeer
     sig { params(request: Shared::NewStreamPayload).returns(Utils::FieldAugmented) }
     def create(request)
       # create - Create a stream
+      # The only parameter you are required to set is the name of your stream,
+      # but we also highly recommend that you define transcoding profiles
+      # parameter that suits your specific broadcasting configuration.
+      # \
+      # \
+      # If you do not define transcoding rendition profiles when creating the
+      # stream, a default set of profiles will be used. These profiles include
+      # 240p,  360p, 480p and 720p.
+      # \
+      # \
+      # The playback policy is set to public by default for new streams. It can
+      # also be added upon the creation of a new stream by adding
+      # `"playbackPolicy": {"type": "jwt"}`
+      # 
       url, params = @sdk_configuration.get_server_details
       base_url = Utils.template_url(url, params)
       url = "#{base_url}/stream"
@@ -85,7 +99,7 @@ module Livepeer
       if r.status == 200
         if Utils.match_content_type(content_type, 'application/json')
           out = Utils.unmarshal_complex(r.env.response_body, T::Array[Shared::Stream])
-          res.data = out
+          res.classes = out
         end
       end
       res
@@ -94,6 +108,12 @@ module Livepeer
     sig { params(id: String).returns(Utils::FieldAugmented) }
     def delete(id)
       # delete - Delete a stream
+      # 
+      # This will also suspend any active stream sessions, so make sure to wait
+      # until the stream has finished. To explicitly interrupt an active
+      # session, consider instead updating the suspended field in the stream
+      # using the PATCH stream API.
+      # 
       request = Operations::DeleteStreamRequest.new(
         
         id: id
@@ -208,11 +228,52 @@ module Livepeer
       res
     end
 
+    sig { params(id: String).returns(Utils::FieldAugmented) }
+    def terminate(id)
+      # terminate - Terminates a live stream
+      # `DELETE /stream/{id}/terminate` can be used to terminate an ongoing
+      # session on a live stream. Unlike suspending the stream, it allows the
+      # streamer to restart streaming even immediately, but it will force
+      # terminate the current session and stop the recording.
+      # \
+      # \
+      # A 204 No Content status response indicates the stream was successfully
+      # terminated.
+      # 
+      request = Operations::TerminateStreamRequest.new(
+        
+        id: id
+      )
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
+      url = Utils.generate_url(
+        Operations::TerminateStreamRequest,
+        base_url,
+        '/stream/{id}/terminate',
+        request
+      )
+      headers = {}
+      headers['Accept'] = '*/*'
+      headers['user-agent'] = @sdk_configuration.user_agent
+
+      r = @sdk_configuration.client.delete(url) do |req|
+        req.headers = headers
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
+      end
+
+      content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
+
+      res = Operations::TerminateStreamResponse.new(
+        status_code: r.status, content_type: content_type, raw_response: r
+      )
+      if r.status == 204
+      end
+      res
+    end
+
     sig { params(request: Shared::ClipPayload).returns(Utils::FieldAugmented) }
     def create_clip(request)
       # create_clip - Create a clip
-      # Create a clip from a livestream
-      # 
       url, params = @sdk_configuration.get_server_details
       base_url = Utils.template_url(url, params)
       url = "#{base_url}/clip"
@@ -242,8 +303,8 @@ module Livepeer
       )
       if r.status == 200
         if Utils.match_content_type(content_type, 'application/json')
-          out = Utils.unmarshal_complex(r.env.response_body, Operations::PostClipData)
-          res.data = out
+          out = Utils.unmarshal_complex(r.env.response_body, Operations::PostClipResponseBody)
+          res.object = out
         end
       end
       res
@@ -281,9 +342,89 @@ module Livepeer
       if r.status == 200
         if Utils.match_content_type(content_type, 'application/json')
           out = Utils.unmarshal_complex(r.env.response_body, T::Array[Shared::Asset])
-          res.data = out
+          res.classes = out
+        end
+      end
+      res
+    end
+
+    sig { params(id: String, target_add_payload: Shared::TargetAddPayload).returns(Utils::FieldAugmented) }
+    def create_multistream_target(id, target_add_payload)
+      # create_multistream_target - Add a multistream target
+      request = Operations::AddMultistreamTargetRequest.new(
+        
+        id: id,
+        target_add_payload: target_add_payload
+      )
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
+      url = Utils.generate_url(
+        Operations::AddMultistreamTargetRequest,
+        base_url,
+        '/stream/{id}/create-multistream-target',
+        request
+      )
+      headers = {}
+      req_content_type, data, form = Utils.serialize_request_body(request, :target_add_payload, :json)
+      headers['content-type'] = req_content_type
+      raise StandardError, 'request body is required' if data.nil? && form.nil?
+      headers['Accept'] = '*/*'
+      headers['user-agent'] = @sdk_configuration.user_agent
+
+      r = @sdk_configuration.client.post(url) do |req|
+        req.headers = headers
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
+        if form
+          req.body = Utils.encode_form(form)
+        elsif Utils.match_content_type(req_content_type, 'application/x-www-form-urlencoded')
+          req.body = URI.encode_www_form(data)
+        else
+          req.body = data
         end
       end
+
+      content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
+
+      res = Operations::AddMultistreamTargetResponse.new(
+        status_code: r.status, content_type: content_type, raw_response: r
+      )
+      if r.status == 204
+      end
+      res
+    end
+
+    sig { params(id: String, target_id: String).returns(Utils::FieldAugmented) }
+    def delete_multistream_target(id, target_id)
+      # delete_multistream_target - Remove a multistream target
+      request = Operations::RemoveMultistreamTargetRequest.new(
+        
+        id: id,
+        target_id: target_id
+      )
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
+      url = Utils.generate_url(
+        Operations::RemoveMultistreamTargetRequest,
+        base_url,
+        '/stream/{id}/multistream/{targetId}',
+        request
+      )
+      headers = {}
+      headers['Accept'] = '*/*'
+      headers['user-agent'] = @sdk_configuration.user_agent
+
+      r = @sdk_configuration.client.delete(url) do |req|
+        req.headers = headers
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
+      end
+
+      content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
+
+      res = Operations::RemoveMultistreamTargetResponse.new(
+        status_code: r.status, content_type: content_type, raw_response: r
+      )
+      if r.status == 204
+      end
       res
     end
   end

data/lib/sdk/task.rb

@@ -40,7 +40,7 @@ module Livepeer
       if r.status == 200
         if Utils.match_content_type(content_type, 'application/json')
           out = Utils.unmarshal_complex(r.env.response_body, T::Array[Shared::Task])
-          res.data = out
+          res.classes = out
         end
       end
       res

data/lib/sdk/transcode.rb

@@ -17,9 +17,131 @@ module Livepeer
       @sdk_configuration = sdk_config
     end
 
-    sig { params(request: Shared::TaskInput).returns(Utils::FieldAugmented) }
+    sig { params(request: Shared::TranscodePayload).returns(Utils::FieldAugmented) }
     def create(request)
       # create - Transcode a video
+      # `POST /transcode` transcodes a video file and uploads the results to the
+      # specified storage service. 
+      # \
+      # \
+      # Transcoding is asynchronous so you will need to check the status of the
+      # task in order to determine when transcoding is complete. The `id` field
+      # in the response is the unique ID for the transcoding `Task`. The task
+      # status can be queried using the [GET tasks
+      # endpoint](https://docs.livepeer.org/reference/api/get-tasks):
+      # \
+      # \
+      # When `status.phase` is `completed`,  transcoding will be complete and
+      # the results will be stored in the storage service and the specified
+      # output location.
+      # \
+      # \
+      # The results will be available under `params.outputs.hls.path` and
+      # `params.outputs.mp4.path` in the specified storage service.
+      # ## Input
+      # \
+      # This endpoint currently supports the following inputs:
+      # - HTTP
+      # - S3 API Compatible Service
+      # \
+      # \
+      # **HTTP**
+      # \
+      # A public HTTP URL can be used to read a video file.
+      # ```json
+      # {
+      #     "url": "https://www.example.com/video.mp4"
+      # }
+      # ```
+      # | Name | Type   | Description                          |
+      # | ---- | ------ | ------------------------------------ |
+      # | url  | string | A public HTTP URL for the video file. |
+      # 
+      # Note: For IPFS HTTP gateway URLs, the API currently only supports “path
+      # style” URLs and does not support “subdomain style” URLs. The API will
+      # support both styles of URLs in a future update.
+      # \
+      # \
+      # **S3 API Compatible Service**
+      # \
+      # \
+      # S3 credentials can be used to authenticate with a S3 API compatible
+      # service to read a video file.
+      # 
+      # ```json
+      # {
+      #     "type": "s3",
+      #     "endpoint": "https://gateway.storjshare.io",
+      #     "credentials": {
+      #         "accessKeyId": "$ACCESS_KEY_ID",
+      #         "secretAccessKey": "$SECRET_ACCESS_KEY"
+      #     },
+      #     "bucket": "inbucket",
+      #     "path": "/video/source.mp4"
+      # }
+      # ```
+      # 
+      # 
+      # ## Storage
+      # \
+      # This endpoint currently supports the following storage services:
+      # - S3 API Compatible Service
+      # - Web3 Storage
+      # \
+      # \
+      # **S3 API Compatible Service**
+      # ```json
+      # {
+      #   "type": "s3",
+      #     "endpoint": "https://gateway.storjshare.io",
+      #     "credentials": {
+      #         "accessKeyId": "$ACCESS_KEY_ID",
+      #         "secretAccessKey": "$SECRET_ACCESS_KEY"
+      #     },
+      #     "bucket": "mybucket"
+      # }
+      # ```
+      # 
+      # **Web3 Storage**
+      # 
+      # ```json
+      # {
+      #   "type": "web3.storage",
+      #     "credentials": {
+      #         "proof": "$UCAN_DELEGATION_PROOF",
+      #     }
+      # }
+      # ```
+      # 
+      # 
+      # 
+      # ## Outputs
+      # \
+      # This endpoint currently supports the following output types:
+      # - HLS
+      # - MP4
+      # 
+      # **HLS**
+      # 
+      # ```json
+      # {
+      #   "hls": {
+      #         "path": "/samplevideo/hls"
+      #     }
+      # }
+      # ```
+      # 
+      # 
+      # **MP4**
+      # 
+      # ```json
+      # {
+      #   "mp4": {
+      #         "path": "/samplevideo/mp4"
+      #     }
+      # }
+      # ```
+      # 
       url, params = @sdk_configuration.get_server_details
       base_url = Utils.template_url(url, params)
       url = "#{base_url}/transcode"

data/lib/sdk/webhook.rb

@@ -40,7 +40,7 @@ module Livepeer
       if r.status == 200
         if Utils.match_content_type(content_type, 'application/json')
           out = Utils.unmarshal_complex(r.env.response_body, T::Array[Shared::Webhook])
-          res.data = out
+          res.classes = out
         end
       end
       res
@@ -49,6 +49,8 @@ module Livepeer
     sig { returns(Utils::FieldAugmented) }
     def create
       # create - Create a webhook
+      # To create a new webhook, you need to make an API call with the events you want to listen for and the URL that will be called when those events occur.
+      # 
       url, params = @sdk_configuration.get_server_details
       base_url = Utils.template_url(url, params)
       url = "#{base_url}/webhook"