Class: Telnyx::Resources::PrivateWirelessGateways

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

Overview

Private Wireless Gateways operations

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ PrivateWirelessGateways

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

Parameters:



125
126
127
 
# File 'lib/telnyx/resources/private_wireless_gateways.rb', line 125

def initialize(client:)
  @client = client
end

Instance Method Details

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

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

Asynchronously create a Private Wireless Gateway for SIM cards for a previously created network. This operation may take several minutes so you can check the Private Wireless Gateway status at the section Get a Private Wireless Gateway.

Parameters:

  • name (String) —

    The private wireless gateway name.

  • network_id (String) —

    The identification of the related network resource.

  • region_code (String) —

    The code of the region where the private wireless gateway will be assigned. A li

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

Returns:

See Also:



27
28
29
30
31
32
33
34
35
36
 
# File 'lib/telnyx/resources/private_wireless_gateways.rb', line 27

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

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

Deletes the Private Wireless Gateway.

Parameters:

  • id (String) —

    Identifies the private wireless gateway.

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

Returns:

See Also:



113
114
115
116
117
118
119
120
 
# File 'lib/telnyx/resources/private_wireless_gateways.rb', line 113

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

#list(filter_created_at: nil, filter_ip_range: nil, filter_name: nil, filter_region_code: nil, filter_updated_at: nil, page_number: nil, page_size: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::PrivateWirelessGateway>

Get all Private Wireless Gateways belonging to the user.

Parameters:

  • filter_created_at (String) —

    Private Wireless Gateway resource creation date.

  • filter_ip_range (String) —

    The IP address range of the Private Wireless Gateway.

  • filter_name (String) —

    The name of the Private Wireless Gateway.

  • filter_region_code (String) —

    The name of the region where the Private Wireless Gateway is deployed.

  • filter_updated_at (String) —

    When the Private Wireless Gateway was last updated.

  • page_number (Integer) —

    The page number to load.

  • page_size (Integer) —

    The size of the page.

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

Returns:

See Also:



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/telnyx/resources/private_wireless_gateways.rb', line 81

def list(params = {})
  parsed, options = Telnyx::PrivateWirelessGatewayListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "private_wireless_gateways",
    query: query.transform_keys(
      filter_created_at: "filter[created_at]",
      filter_ip_range: "filter[ip_range]",
      filter_name: "filter[name]",
      filter_region_code: "filter[region_code]",
      filter_updated_at: "filter[updated_at]",
      page_number: "page[number]",
      page_size: "page[size]"
    ),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::PrivateWirelessGateway,
    options: options
  )
end

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

Retrieve information about a Private Wireless Gateway.

Parameters:

  • id (String) —

    Identifies the private wireless gateway.

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

Returns:

See Also:



49
50
51
52
53
54
55
56
 
# File 'lib/telnyx/resources/private_wireless_gateways.rb', line 49

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