Class: Telnyx::Resources::Networks::DefaultGateway

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/networks/default_gateway.rb,
sig/telnyx/resources/networks/default_gateway.rbs

Overview

Network operations

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ DefaultGateway

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

Parameters:



76
77
78
 
# File 'lib/telnyx/resources/networks/default_gateway.rb', line 76

def initialize(client:)
  @client = client
end

Instance Method Details

#create(network_identifier, wireguard_peer_id: nil, request_options: {}) ⇒ Telnyx::Models::Networks::DefaultGatewayCreateResponse

Creates a default gateway on the specified network, directing the network's outbound traffic through the chosen gateway.

Parameters:

  • network_identifier (String) —

    Identifies the resource.

  • wireguard_peer_id (String) —

    Wireguard peer ID.

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

Returns:

See Also:



22
23
24
25
26
27
28
29
30
31
 
# File 'lib/telnyx/resources/networks/default_gateway.rb', line 22

def create(network_identifier, params = {})
  parsed, options = Telnyx::Networks::DefaultGatewayCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["networks/%1$s/default_gateway", network_identifier],
    body: parsed,
    model: Telnyx::Models::Networks::DefaultGatewayCreateResponse,
    options: options
  )
end

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

Removes the default gateway from the specified network.

Parameters:

  • id (String) —

    Identifies the resource.

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

Returns:

See Also:



64
65
66
67
68
69
70
71
 
# File 'lib/telnyx/resources/networks/default_gateway.rb', line 64

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

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

Returns the status of the default gateway configured on the specified network.

Parameters:

  • id (String) —

    Identifies the resource.

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

Returns:

See Also:



44
45
46
47
48
49
50
51
 
# File 'lib/telnyx/resources/networks/default_gateway.rb', line 44

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