Class: Telnyx::Resources::CredentialConnections

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/credential_connections.rb,
lib/telnyx/resources/credential_connections/actions.rb

Overview

Credential connection operations

Defined Under Namespace

Classes: Actions

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ CredentialConnections

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

Parameters:



236
237
238
239
 
# File 'lib/telnyx/resources/credential_connections.rb', line 236

def initialize(client:)
  @client = client
  @actions = Telnyx::Resources::CredentialConnections::Actions.new(client: client)
end

Instance Attribute Details

#actions ⇒ Telnyx::Resources::CredentialConnections::Actions (readonly)

Credential connection operations

Returns:



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

def actions
  @actions
end

Instance Method Details

#create(connection_name:, password:, user_name:, active: nil, anchorsite_override: nil, android_push_credential_id: nil, call_cost_in_webhooks: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, inbound: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, rtcp_settings: nil, sip_uri_calling_preference: nil, tags: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {}) ⇒ Telnyx::Models::CredentialConnectionCreateResponse

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

Creates a credential connection.

Parameters:

  • connection_name (String) —

    A user-assigned name to help manage the connection.

  • password (String) —

    The password to be used as part of the credentials. Must be 8 to 128 characters

  • user_name (String) —

    The user name to be used as part of the credentials. Must be 4-32 characters lon

  • active (Boolean) —

    Defaults to true

  • anchorsite_override (Symbol, Telnyx::Models::AnchorsiteOverride) —

    ‘Latency` directs Telnyx to route media through the site with the lowest round-t

  • android_push_credential_id (String, nil) —

    The uuid of the push credential for Android

  • call_cost_in_webhooks (Boolean) —

    Specifies if call cost webhooks should be sent for this connection.

  • default_on_hold_comfort_noise_enabled (Boolean) —

    When enabled, Telnyx will generate comfort noise when you place the call on hold

  • dtmf_type (Symbol, Telnyx::Models::DtmfType) —

    Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF

  • encode_contact_header_enabled (Boolean) —

    Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scen

  • encrypted_media (Symbol, Telnyx::Models::EncryptedMedia, nil) —

    Enable use of SRTP for encryption. Cannot be set if the transport_portocol is TL

  • inbound (Telnyx::Models::CredentialInbound)
  • ios_push_credential_id (String, nil) —

    The uuid of the push credential for Ios

  • jitter_buffer (Telnyx::Models::ConnectionJitterBuffer) —

    Configuration options for Jitter Buffer. Enables Jitter Buffer for RTP streams o

  • noise_suppression (Symbol, Telnyx::Models::CredentialConnectionCreateParams::NoiseSuppression) —

    Controls when noise suppression is applied to calls. When set to ‘inbound’, nois

  • noise_suppression_details (Telnyx::Models::ConnectionNoiseSuppressionDetails) —

    Configuration options for noise suppression. These settings are stored regardles

  • onnet_t38_passthrough_enabled (Boolean) —

    Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly

  • outbound (Telnyx::Models::CredentialOutbound)
  • rtcp_settings (Telnyx::Models::ConnectionRtcpSettings)
  • sip_uri_calling_preference (Symbol, Telnyx::Models::CredentialConnectionCreateParams::SipUriCallingPreference) —

    This feature enables inbound SIP URI calls to your Credential Auth Connection. I

  • tags (Array<String>) —

    Tags associated with the connection.

  • webhook_api_version (Symbol, Telnyx::Models::CredentialConnectionCreateParams::WebhookAPIVersion) —

    Determines which webhook format will be used, Telnyx API v1, v2 or texml. Note -

  • webhook_event_failover_url (String, nil) —

    The failover URL where webhooks related to this connection will be sent if sendi

  • webhook_event_url (String) —

    The URL where webhooks related to this connection will be sent. Must include a s

  • webhook_timeout_secs (Integer, nil) —

    Specifies how many seconds to wait before timing out a webhook.

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

Returns:

See Also:



73
74
75
76
77
78
79
80
81
82
 
# File 'lib/telnyx/resources/credential_connections.rb', line 73

def create(params)
  parsed, options = Telnyx::CredentialConnectionCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "credential_connections",
    body: parsed,
    model: Telnyx::Models::CredentialConnectionCreateResponse,
    options: options
  )
end

#delete(id, request_options: {}) ⇒ Telnyx::Models::CredentialConnectionDeleteResponse

Deletes an existing credential connection.

Parameters:

  • id (String) —

    Identifies the resource.

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

Returns:

See Also:



224
225
226
227
228
229
230
231
 
# File 'lib/telnyx/resources/credential_connections.rb', line 224

def delete(id, params = {})
  @client.request(
    method: :delete,
    path: ["credential_connections/%1$s", id],
    model: Telnyx::Models::CredentialConnectionDeleteResponse,
    options: params[:request_options]
  )
end

#list(filter: nil, page_number: nil, page_size: nil, sort: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::CredentialConnection>

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

Returns a list of your credential connections.

filter[connection_

Parameters:

Returns:

See Also:



200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/telnyx/resources/credential_connections.rb', line 200

def list(params = {})
  parsed, options = Telnyx::CredentialConnectionListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "credential_connections",
    query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::CredentialConnection,
    options: options
  )
end

#retrieve(id, request_options: {}) ⇒ Telnyx::Models::CredentialConnectionRetrieveResponse

Retrieves the details of an existing credential connection.

Parameters:

  • id (String) —

    Identifies the resource.

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

Returns:

See Also:



95
96
97
98
99
100
101
102
 
# File 'lib/telnyx/resources/credential_connections.rb', line 95

def retrieve(id, params = {})
  @client.request(
    method: :get,
    path: ["credential_connections/%1$s", id],
    model: Telnyx::Models::CredentialConnectionRetrieveResponse,
    options: params[:request_options]
  )
end

#update(id, active: nil, anchorsite_override: nil, android_push_credential_id: nil, call_cost_in_webhooks: nil, connection_name: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, inbound: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, password: nil, rtcp_settings: nil, sip_uri_calling_preference: nil, tags: nil, user_name: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {}) ⇒ Telnyx::Models::CredentialConnectionUpdateResponse

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

Updates settings of an existing credential connection.

Parameters:

  • id (String) —

    Identifies the resource.

  • active (Boolean) —

    Defaults to true

  • anchorsite_override (Symbol, Telnyx::Models::AnchorsiteOverride) —

    ‘Latency` directs Telnyx to route media through the site with the lowest round-t

  • android_push_credential_id (String, nil) —

    The uuid of the push credential for Android

  • call_cost_in_webhooks (Boolean) —

    Specifies if call cost webhooks should be sent for this connection.

  • connection_name (String) —

    A user-assigned name to help manage the connection.

  • default_on_hold_comfort_noise_enabled (Boolean) —

    When enabled, Telnyx will generate comfort noise when you place the call on hold

  • dtmf_type (Symbol, Telnyx::Models::DtmfType) —

    Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF

  • encode_contact_header_enabled (Boolean) —

    Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scen

  • encrypted_media (Symbol, Telnyx::Models::EncryptedMedia, nil) —

    Enable use of SRTP for encryption. Cannot be set if the transport_portocol is TL

  • inbound (Telnyx::Models::CredentialInbound)
  • ios_push_credential_id (String, nil) —

    The uuid of the push credential for Ios

  • jitter_buffer (Telnyx::Models::ConnectionJitterBuffer) —

    Configuration options for Jitter Buffer. Enables Jitter Buffer for RTP streams o

  • noise_suppression (Symbol, Telnyx::Models::CredentialConnectionUpdateParams::NoiseSuppression) —

    Controls when noise suppression is applied to calls. When set to ‘inbound’, nois

  • noise_suppression_details (Telnyx::Models::ConnectionNoiseSuppressionDetails) —

    Configuration options for noise suppression. These settings are stored regardles

  • onnet_t38_passthrough_enabled (Boolean) —

    Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly

  • outbound (Telnyx::Models::CredentialOutbound)
  • password (String) —

    The password to be used as part of the credentials. Must be 8 to 128 characters

  • rtcp_settings (Telnyx::Models::ConnectionRtcpSettings)
  • sip_uri_calling_preference (Symbol, Telnyx::Models::CredentialConnectionUpdateParams::SipUriCallingPreference) —

    This feature enables inbound SIP URI calls to your Credential Auth Connection. I

  • tags (Array<String>) —

    Tags associated with the connection.

  • user_name (String) —

    The user name to be used as part of the credentials. Must be 4-32 characters lon

  • webhook_api_version (Symbol, Telnyx::Models::CredentialConnectionUpdateParams::WebhookAPIVersion) —

    Determines which webhook format will be used, Telnyx API v1 or v2.

  • webhook_event_failover_url (String, nil) —

    The failover URL where webhooks related to this connection will be sent if sendi

  • webhook_event_url (String) —

    The URL where webhooks related to this connection will be sent. Must include a s

  • webhook_timeout_secs (Integer, nil) —

    Specifies how many seconds to wait before timing out a webhook.

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

Returns:

See Also:



168
169
170
171
172
173
174
175
176
177
 
# File 'lib/telnyx/resources/credential_connections.rb', line 168

def update(id, params = {})
  parsed, options = Telnyx::CredentialConnectionUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["credential_connections/%1$s", id],
    body: parsed,
    model: Telnyx::Models::CredentialConnectionUpdateResponse,
    options: options
  )
end