Class: Telnyx::Resources::Texml

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/texml.rb,
lib/telnyx/resources/texml/accounts.rb,
lib/telnyx/resources/texml/accounts/calls.rb,
lib/telnyx/resources/texml/accounts/queues.rb,
lib/telnyx/resources/texml/accounts/recordings.rb,
lib/telnyx/resources/texml/accounts/conferences.rb,
lib/telnyx/resources/texml/accounts/calls/siprec.rb,
lib/telnyx/resources/texml/accounts/calls/streams.rb,
lib/telnyx/resources/texml/accounts/transcriptions.rb,
lib/telnyx/resources/texml/accounts/recordings/json.rb,
lib/telnyx/resources/texml/accounts/calls/recordings.rb,
lib/telnyx/resources/texml/accounts/transcriptions/json.rb,
lib/telnyx/resources/texml/accounts/calls/recordings_json.rb,
lib/telnyx/resources/texml/accounts/conferences/participants.rb

Overview

TeXML REST Commands

Defined Under Namespace

Classes: Accounts

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Texml

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 Texml.

Parameters:



45
46
47
48
 
# File 'lib/telnyx/resources/texml.rb', line 45

def initialize(client:)
  @client = client
  @accounts = Telnyx::Resources::Texml::Accounts.new(client: client)
end

Instance Attribute Details

#accounts ⇒ Telnyx::Resources::Texml::Accounts (readonly)

TeXML REST Commands

Returns:



9
10
11
 
# File 'lib/telnyx/resources/texml.rb', line 9

def accounts
  @accounts
end

Instance Method Details

#secrets(name:, value:, request_options: {}) ⇒ Telnyx::Models::TexmlSecretsResponse

Some parameter documentations has been truncated, see Models::TexmlSecretsParams for more details.

Create a TeXML secret which can be later used as a Dynamic Parameter for TeXML when using Mustache Templates in your TeXML. In your TeXML you will be able to use your secret name, and this name will be replaced by the actual secret value when processing the TeXML on Telnyx side. The secrets are not visible in any logs.

Parameters:

  • name (String) —

    Name used as a reference for the secret, if the name already exists within the a

  • value (String) —

    Secret value which will be used when rendering the TeXML template

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

Returns:

See Also:



31
32
33
34
35
36
37
38
39
40
 
# File 'lib/telnyx/resources/texml.rb', line 31

def secrets(params)
  parsed, options = Telnyx::TexmlSecretsParams.dump_request(params)
  @client.request(
    method: :post,
    path: "texml/secrets",
    body: parsed,
    model: Telnyx::Models::TexmlSecretsResponse,
    options: options
  )
end