Class: Telnyx::Resources::PublicInternetGateways

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/public_internet_gateways.rb

Overview

Public Internet Gateway operations

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ PublicInternetGateways

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

Parameters:



107
108
109
 
# File 'lib/telnyx/resources/public_internet_gateways.rb', line 107

def initialize(client:)
  @client = client
end

Instance Method Details

#create(name: nil, network_id: nil, region_code: nil, request_options: {}) ⇒ Telnyx::Models::PublicInternetGatewayCreateResponse

Create a new Public Internet Gateway.

Parameters:

  • name (String) —

    A user specified name for the interface.

  • network_id (String) —

    The id of the network associated with the interface.

  • region_code (String) —

    The region interface is deployed to.

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

def create(params = {})
  parsed, options = Telnyx::PublicInternetGatewayCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "public_internet_gateways",
    body: parsed,
    model: Telnyx::Models::PublicInternetGatewayCreateResponse,
    options: options
  )
end

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

Delete a Public Internet Gateway.

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/public_internet_gateways.rb', line 95

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

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

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

List all Public Internet Gateways.

Parameters:

Returns:

See Also:



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

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

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

Retrieve a Public Internet Gateway.

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/public_internet_gateways.rb', line 44

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