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 account_sid

  • ip_access_control_list_sid (String) —

    The ip_access_control_list_sid

  • sid (String) —

    The sid



183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 183

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

#delete ⇒ Boolean

Deletes the IpAddressInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



242
243
244
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 242

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

#fetch ⇒ IpAddressInstance

Fetch a IpAddressInstance

Returns:



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 198

def fetch
  params = Twilio::Values.of({})

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

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

#to_s ⇒ Object

Provide a user friendly representation



248
249
250
251
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 248

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

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

Update the IpAddressInstance

Parameters:

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

    The ip_address

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

    The friendly_name

Returns:



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 221

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

  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