Class: Telnyx::Resources::AccessIPAddress

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

Overview

IP Address Operations

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ AccessIPAddress

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

Parameters:



101
102
103
 
# File 'lib/telnyx/resources/access_ip_address.rb', line 101

def initialize(client:)
  @client = client
end

Instance Method Details

#create(ip_address:, description: nil, request_options: {}) ⇒ Telnyx::Models::AccessIPAddressResponse

Create new Access IP Address

Parameters:

  • ip_address (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_address.rb', line 18

def create(params)
  parsed, options = Telnyx::AccessIPAddressCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "access_ip_address",
    body: parsed,
    model: Telnyx::AccessIPAddressResponse,
    options: options
  )
end

#delete(access_ip_address_id, request_options: {}) ⇒ Telnyx::Models::AccessIPAddressResponse

Delete access IP address

Parameters:

Returns:

See Also:



89
90
91
92
93
94
95
96
 
# File 'lib/telnyx/resources/access_ip_address.rb', line 89

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

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

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

List all Access IP Addresses

Parameters:

Returns:

See Also:



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

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

#retrieve(access_ip_address_id, request_options: {}) ⇒ Telnyx::Models::AccessIPAddressResponse

Retrieve an access IP address

Parameters:

Returns:

See Also:



39
40
41
42
43
44
45
46
 
# File 'lib/telnyx/resources/access_ip_address.rb', line 39

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