Class: Telnyx::Resources::Networks

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

Overview

Network operations

Defined Under Namespace

Classes: DefaultGateway

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Networks

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

Parameters:



161
162
163
164
 
# File 'lib/telnyx/resources/networks.rb', line 161

def initialize(client:)
  @client = client
  @default_gateway = Telnyx::Resources::Networks::DefaultGateway.new(client: client)
end

Instance Attribute Details

#default_gateway ⇒ Telnyx::Resources::Networks::DefaultGateway (readonly)

Network operations

Returns:



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

def default_gateway
  @default_gateway
end

Instance Method Details

#create(name:, request_options: {}) ⇒ Telnyx::Models::NetworkCreateResponse

Create a new Network.

Parameters:

  • name (String) —

    A user specified name for the network.

  • 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.rb', line 22

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

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

Delete a Network.

Parameters:

  • id (String) —

    Identifies the resource.

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

Returns:

See Also:



116
117
118
119
120
121
122
123
 
# File 'lib/telnyx/resources/networks.rb', line 116

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

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

List all Networks.

Parameters:

Returns:

See Also:



92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/telnyx/resources/networks.rb', line 92

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

#list_interfaces(id, filter: nil, page_number: nil, page_size: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::NetworkListInterfacesResponse>

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

List all Interfaces for a Network.

Parameters:

Returns:

See Also:



145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/telnyx/resources/networks.rb', line 145

def list_interfaces(id, params = {})
  parsed, options = Telnyx::NetworkListInterfacesParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["networks/%1$s/network_interfaces", id],
    query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::Models::NetworkListInterfacesResponse,
    options: options
  )
end

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

Retrieve a 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.rb', line 44

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

#update(network_id, name:, request_options: {}) ⇒ Telnyx::Models::NetworkUpdateResponse

Update a Network.

Parameters:

  • network_id (String) —

    Identifies the resource.

  • name (String) —

    A user specified name for the network.

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

Returns:

See Also:



66
67
68
69
70
71
72
73
74
75
 
# File 'lib/telnyx/resources/networks.rb', line 66

def update(network_id, params)
  parsed, options = Telnyx::NetworkUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["networks/%1$s", network_id],
    body: parsed,
    model: Telnyx::Models::NetworkUpdateResponse,
    options: options
  )
end