Class: Telnyx::Resources::WirelessBlocklists

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

Overview

Wireless Blocklists operations

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ WirelessBlocklists

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

Parameters:



140
141
142
 
# File 'lib/telnyx/resources/wireless_blocklists.rb', line 140

def initialize(client:)
  @client = client
end

Instance Method Details

#create(name:, type:, values:, request_options: {}) ⇒ Telnyx::Models::WirelessBlocklistCreateResponse

Create a Wireless Blocklist to prevent SIMs from connecting to certain networks.

Parameters:

Returns:

See Also:



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

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

#delete(id, request_options: {}) ⇒ nil

Permanently deletes the specified wireless blocklist from your account. The request returns 422 when the wireless blocklist is assigned to a SIM Card Group.

Parameters:

  • id (String) —

    Identifies the wireless blocklist.

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

Returns:

  • (nil)

See Also:



128
129
130
131
132
133
134
135
 
# File 'lib/telnyx/resources/wireless_blocklists.rb', line 128

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

#list(filter_name: nil, filter_type: nil, page_number: nil, page_size: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::WirelessWirelessBlocklist>

Get all Wireless Blocklists belonging to the user.

Parameters:

  • filter_name (String) —

    The name of the Wireless Blocklist.

  • filter_type (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:



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/telnyx/resources/wireless_blocklists.rb', line 97

def list(params = {})
  parsed, options = Telnyx::WirelessBlocklistListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "wireless_blocklists",
    query: query.transform_keys(
      filter_name: "filter[name]",
      filter_type: "filter[type]",
      page_number: "page[number]",
      page_size: "page[size]"
    ),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::WirelessWirelessBlocklist,
    options: options
  )
end

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

Retrieve information about a Wireless Blocklist.

Parameters:

  • id (String) —

    Identifies the wireless blocklist.

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

Returns:

See Also:



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

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

#update(id, name: nil, values: nil, request_options: {}) ⇒ Telnyx::Models::WirelessBlocklistUpdateResponse

Updates the specified wireless blocklist. The update is processed asynchronously, so the request is accepted and completes in the background.

Parameters:

  • id (String) —

    Identifies the wireless blocklist.

  • name (String) —

    The name of the Wireless Blocklist.

  • values (Array<String>) —

    Values to block. The values here depend on the type of Wireless Blocklist.

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

Returns:

See Also:



69
70
71
72
73
74
75
76
77
78
 
# File 'lib/telnyx/resources/wireless_blocklists.rb', line 69

def update(id, params = {})
  parsed, options = Telnyx::WirelessBlocklistUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["wireless_blocklists/%1$s", id],
    body: parsed,
    model: Telnyx::Models::WirelessBlocklistUpdateResponse,
    options: options
  )
end