Class: Telnyx::Resources::Texml::Accounts::Calls::Streams

Inherits:

Object

• Object
• Telnyx::Resources::Texml::Accounts::Calls::Streams

Defined in:

lib/telnyx/resources/texml/accounts/calls/streams.rb

Overview

TeXML REST Commands

Instance Method Summary

• #initialize(client:) ⇒ Streams constructor private

  A new instance of Streams.

• #streaming_sid_json(streaming_sid, account_sid:, call_sid:, status: nil, request_options: {}) ⇒ Telnyx::Models::Texml::Accounts::Calls::StreamStreamingSidJsonResponse

  Updates streaming resource for particular call.

Constructor Details

#initialize(client:) ⇒ Streams

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Streams.

Parameters:

• client (Telnyx::Client)

# File 'lib/telnyx/resources/texml/accounts/calls/streams.rb', line 55

def initialize(client:)
  @client = client
end

Instance Method Details

#streaming_sid_json(streaming_sid, account_sid:, call_sid:, status: nil, request_options: {}) ⇒ Telnyx::Models::Texml::Accounts::Calls::StreamStreamingSidJsonResponse

Updates streaming resource for particular call.

Parameters:

• streaming_sid (String) —

  Path param: Uniquely identifies the streaming by id.

• account_sid (String) —

  Path param: The id of the account the resource belongs to.

• call_sid (String) —

  Path param: The CallSid that identifies the call to update.

• status (Symbol, Telnyx::Models::Texml::Accounts::Calls::StreamStreamingSidJsonParams::Status) —

  Body param: The status of the Stream you wish to update.

• request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Telnyx::Models::Texml::Accounts::Calls::StreamStreamingSidJsonResponse)

See Also:

• Models::Texml::Accounts::Calls::StreamStreamingSidJsonParams

# File 'lib/telnyx/resources/texml/accounts/calls/streams.rb', line 27

def streaming_sid_json(streaming_sid, params)
  parsed, options = Telnyx::Texml::Accounts::Calls::StreamStreamingSidJsonParams.dump_request(params)
  account_sid =
    parsed.delete(:account_sid) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  call_sid =
    parsed.delete(:call_sid) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :post,
    path: [
      "texml/Accounts/%1$s/Calls/%2$s/Streams/%3$s.json",
      account_sid,
      call_sid,
      streaming_sid
    ],
    headers: {"content-type" => "application/x-www-form-urlencoded"},
    body: parsed,
    model: Telnyx::Models::Texml::Accounts::Calls::StreamStreamingSidJsonResponse,
    options: options
  )
end