Class: Twilio::REST::Api::V2010::AccountContext::SipList::IpAccessControlListContext::IpAddressContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid, ip_access_control_list_sid, sid) ⇒ IpAddressContext

Initialize the IpAddressContext

Parameters:

  • version (Version)

    Version that contains the resource

  • account_sid (String)

    The unique id of the Account responsible for this resource.

  • ip_access_control_list_sid (String)

    The IpAccessControlList Sid that identifies the IpAddress resources to fetch.

  • sid (String)

    A 34 character string that uniquely identifies the IpAddress resource to fetch.


194
195
196
197
198
199
200
201
202
203
204
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 194

def initialize(version, , ip_access_control_list_sid, sid)
  super(version)

  # Path Solution
  @solution = {
      account_sid: ,
      ip_access_control_list_sid: ip_access_control_list_sid,
      sid: sid,
  }
  @uri = "/Accounts/#{@solution[:account_sid]}/SIP/IpAccessControlLists/#{@solution[:ip_access_control_list_sid]}/IpAddresses/#{@solution[:sid]}.json"
end

Instance Method Details

#deleteBoolean

Delete the IpAddressInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


253
254
255
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 253

def delete
   @version.delete('DELETE', @uri)
end

#fetchIpAddressInstance

Fetch the IpAddressInstance

Returns:


209
210
211
212
213
214
215
216
217
218
219
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 209

def fetch
  payload = @version.fetch('GET', @uri)

  IpAddressInstance.new(
      @version,
      payload,
      account_sid: @solution[:account_sid],
      ip_access_control_list_sid: @solution[:ip_access_control_list_sid],
      sid: @solution[:sid],
  )
end

#inspectObject

Provide a detailed, user friendly representation


266
267
268
269
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 266

def inspect
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Api.V2010.IpAddressContext #{context}>"
end

#to_sObject

Provide a user friendly representation


259
260
261
262
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 259

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Api.V2010.IpAddressContext #{context}>"
end

#update(ip_address: :unset, friendly_name: :unset, cidr_prefix_length: :unset) ⇒ IpAddressInstance

Update the IpAddressInstance

Parameters:

  • ip_address (String) (defaults to: :unset)

    An IP address in dotted decimal notation from which you want to accept traffic. Any SIP requests from this IP address will be allowed by Twilio. IPv4 only supported today.

  • friendly_name (String) (defaults to: :unset)

    A human readable descriptive text for this resource, up to 64 characters long.

  • cidr_prefix_length (String) (defaults to: :unset)

    An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used.

Returns:


232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 232

def update(ip_address: :unset, friendly_name: :unset, cidr_prefix_length: :unset)
  data = Twilio::Values.of({
      'IpAddress' => ip_address,
      'FriendlyName' => friendly_name,
      'CidrPrefixLength' => cidr_prefix_length,
  })

  payload = @version.update('POST', @uri, data: data)

  IpAddressInstance.new(
      @version,
      payload,
      account_sid: @solution[:account_sid],
      ip_access_control_list_sid: @solution[:ip_access_control_list_sid],
      sid: @solution[:sid],
  )
end