Class: Telnyx::Resources::FqdnConnections::FqdnAuthentication

Inherits:

Object

• Object
• Telnyx::Resources::FqdnConnections::FqdnAuthentication

Defined in:

lib/telnyx/resources/fqdn_connections/fqdn_authentication.rb,
sig/telnyx/resources/fqdn_connections/fqdn_authentication.rbs

Overview

FQDN connection operations

Instance Method Summary

• #initialize(client:) ⇒ FqdnAuthentication constructor private

  A new instance of FqdnAuthentication.

• #list(fqdn_connection_id, request_options: {}) ⇒ Telnyx::Models::FqdnConnections::FqdnAuthenticationListResponse

  Retrieves the details of an existing FQDN authentication strategy for a specific FQDN connection.

• #patch_all(fqdn_connection_id, failover_url: nil, fqdn_outbound_authentication: nil, ip_authentication_method: nil, password: nil, txt_name: nil, txt_ttl: nil, txt_value: nil, user_name: nil, webhook_url: nil, request_options: {}) ⇒ Telnyx::Models::FqdnConnections::FqdnAuthenticationPatchAllResponse

  Updates the FQDN authentication strategy for a specific FQDN connection.

Constructor Details

#initialize(client:) ⇒ FqdnAuthentication

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

Parameters:

• client (Telnyx::Client)
• client: (Telnyx::Client)

# File 'lib/telnyx/resources/fqdn_connections/fqdn_authentication.rb', line 72

def initialize(client:)
  @client = client
end

Instance Method Details

#list(fqdn_connection_id, request_options: {}) ⇒ Telnyx::Models::FqdnConnections::FqdnAuthenticationListResponse

Retrieves the details of an existing FQDN authentication strategy for a specific FQDN connection.

Parameters:

• fqdn_connection_id (String) —

  The ID of the FQDN connection.

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

Returns:

• (Telnyx::Models::FqdnConnections::FqdnAuthenticationListResponse)

See Also:

• Models::FqdnConnections::FqdnAuthenticationListParams

# File 'lib/telnyx/resources/fqdn_connections/fqdn_authentication.rb', line 20

def list(fqdn_connection_id, params = {})
  @client.request(
    method: :get,
    path: ["fqdn_connections/%1$s/fqdn_authentication", fqdn_connection_id],
    model: Telnyx::Models::FqdnConnections::FqdnAuthenticationListResponse,
    options: params[:request_options]
  )
end

#patch_all(fqdn_connection_id, failover_url: nil, fqdn_outbound_authentication: nil, ip_authentication_method: nil, password: nil, txt_name: nil, txt_ttl: nil, txt_value: nil, user_name: nil, webhook_url: nil, request_options: {}) ⇒ Telnyx::Models::FqdnConnections::FqdnAuthenticationPatchAllResponse

Updates the FQDN authentication strategy for a specific FQDN connection.

Parameters:

• fqdn_connection_id (String) —

  The ID of the FQDN connection.

• failover_url (String) —

  The failover webhook URL.

• fqdn_outbound_authentication (Symbol, Telnyx::Models::FqdnConnections::FqdnAuthenticationPatchAllParams::FqdnOutboundAuthentication) —

  The outbound authentication type.

• ip_authentication_method (Symbol, Telnyx::Models::FqdnConnections::FqdnAuthenticationPatchAllParams::IPAuthenticationMethod) —

  The IP authentication method.

• password (String) —

  The password for authentication.

• txt_name (String) —

  The TXT record name for Microsoft Teams SBC DNS verification.

• txt_ttl (Integer) —

  The TTL for the TXT record.

• txt_value (String) —

  The TXT record value for Microsoft Teams SBC DNS verification.

• user_name (String) —

  The username for authentication.

• webhook_url (String) —

  The webhook URL for authentication events.

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

Returns:

• (Telnyx::Models::FqdnConnections::FqdnAuthenticationPatchAllResponse)

See Also:

• Models::FqdnConnections::FqdnAuthenticationPatchAllParams

# File 'lib/telnyx/resources/fqdn_connections/fqdn_authentication.rb', line 58

def patch_all(fqdn_connection_id, params = {})
  parsed, options = Telnyx::FqdnConnections::FqdnAuthenticationPatchAllParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["fqdn_connections/%1$s/fqdn_authentication", fqdn_connection_id],
    body: parsed,
    model: Telnyx::Models::FqdnConnections::FqdnAuthenticationPatchAllResponse,
    options: options
  )
end