Class: Telnyx::Resources::AccessIPRanges

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

Overview

IP Range Operations

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ AccessIPRanges

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

Parameters:



82
83
84
 
# File 'lib/telnyx/resources/access_ip_ranges.rb', line 82

def initialize(client:)
  @client = client
end

Instance Method Details

#create(cidr_block:, description: nil, request_options: {}) ⇒ Telnyx::Models::AccessIPRange

Create new Access IP Range

Parameters:

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

Returns:

See Also:



18
19
20
21
22
23
24
25
26
27
 
# File 'lib/telnyx/resources/access_ip_ranges.rb', line 18

def create(params)
  parsed, options = Telnyx::AccessIPRangeCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "access_ip_ranges",
    body: parsed,
    model: Telnyx::AccessIPRange,
    options: options
  )
end

#delete(access_ip_range_id, request_options: {}) ⇒ Telnyx::Models::AccessIPRange

Delete access IP ranges

Parameters:

Returns:

See Also:



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

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

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

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

List all Access IP Ranges

Parameters:

Returns:

See Also:



47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/telnyx/resources/access_ip_ranges.rb', line 47

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