Class: Twilio::REST::Api::V2010::AccountContext::SipList::DomainContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/domain/credential_list_mapping.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb

Defined Under Namespace

Classes: CredentialListMappingContext, CredentialListMappingInstance, CredentialListMappingList, CredentialListMappingPage, IpAccessControlListMappingContext, IpAccessControlListMappingInstance, IpAccessControlListMappingList, IpAccessControlListMappingPage

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid, sid) ⇒ DomainContext

Initialize the DomainContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • account_sid (String) —

    The account_sid

  • sid (String) —

    The domain sid that uniquely identifies the resource



214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 214

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

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

  # Dependents
  @ip_access_control_list_mappings = nil
  @credential_list_mappings = nil
end

Instance Method Details

#credential_list_mappings(sid = :unset) ⇒ CredentialListMappingList, CredentialListMappingContext

Access the credential_list_mappings

Returns:

Raises:

  • (ArgumentError) 


327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 327

def credential_list_mappings(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return CredentialListMappingContext.new(
        @version,
        @solution[:account_sid],
        @solution[:sid],
        sid,
    )
  end

  unless @credential_list_mappings
    @credential_list_mappings = CredentialListMappingList.new(
        @version,
        account_sid: @solution[:account_sid],
        domain_sid: @solution[:sid],
    )
  end

  @credential_list_mappings
end

#delete ⇒ Boolean

Deletes the DomainInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



292
293
294
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 292

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

#fetch ⇒ DomainInstance

Fetch a DomainInstance

Returns:



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

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

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

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

#ip_access_control_list_mappings(sid = :unset) ⇒ IpAccessControlListMappingList, IpAccessControlListMappingContext

Access the ip_access_control_list_mappings

Returns:

Raises:

  • (ArgumentError) 


300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 300

def ip_access_control_list_mappings(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return IpAccessControlListMappingContext.new(
        @version,
        @solution[:account_sid],
        @solution[:sid],
        sid,
    )
  end

  unless @ip_access_control_list_mappings
    @ip_access_control_list_mappings = IpAccessControlListMappingList.new(
        @version,
        account_sid: @solution[:account_sid],
        domain_sid: @solution[:sid],
    )
  end

  @ip_access_control_list_mappings
end

#to_s ⇒ Object

Provide a user friendly representation



352
353
354
355
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 352

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

#update(auth_type: :unset, friendly_name: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_status_callback_method: :unset, voice_status_callback_url: :unset, voice_url: :unset, sip_registration: :unset) ⇒ DomainInstance

Update the DomainInstance

Parameters:

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

    The auth_type

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

    A user-specified, human-readable name for the trigger.

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

    The voice_fallback_method

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

    The voice_fallback_url

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

    The HTTP method to use with the voice_url

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

    The voice_status_callback_method

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

    The voice_status_callback_url

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

    The voice_url

  • sip_registration (Boolean) (defaults to: :unset) —

    The sip_registration

Returns:



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 262

def update(auth_type: :unset, friendly_name: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_status_callback_method: :unset, voice_status_callback_url: :unset, voice_url: :unset, sip_registration: :unset)
  data = Twilio::Values.of({
      'AuthType' => auth_type,
      'FriendlyName' => friendly_name,
      'VoiceFallbackMethod' => voice_fallback_method,
      'VoiceFallbackUrl' => voice_fallback_url,
      'VoiceMethod' => voice_method,
      'VoiceStatusCallbackMethod' => voice_status_callback_method,
      'VoiceStatusCallbackUrl' => voice_status_callback_url,
      'VoiceUrl' => voice_url,
      'SipRegistration' => sip_registration,
  })

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

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