Class: Twilio::REST::Trunking::V1::TrunkContext

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/trunking/v1/trunk.rb,
lib/twilio-ruby/rest/trunking/v1/trunk/recording.rb,
lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb,
lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb,
lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb,
lib/twilio-ruby/rest/trunking/v1/trunk/ip_access_control_list.rb

Defined Under Namespace

Classes: CredentialListContext, CredentialListInstance, CredentialListList, CredentialListPage, IpAccessControlListContext, IpAccessControlListInstance, IpAccessControlListList, IpAccessControlListPage, OriginationUrlContext, OriginationUrlInstance, OriginationUrlList, OriginationUrlPage, PhoneNumberContext, PhoneNumberInstance, PhoneNumberList, PhoneNumberPage, RecordingContext, RecordingInstance, RecordingList, RecordingPage

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ TrunkContext

Initialize the TrunkContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    The unique string that we created to identify the Trunk resource to fetch.


200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 200

def initialize(version, sid)
  super(version)

  # Path Solution
  @solution = {sid: sid, }
  @uri = "/Trunks/#{@solution[:sid]}"

  # Dependents
  @origination_urls = nil
  @credentials_lists = nil
  @ip_access_control_lists = nil
  @phone_numbers = nil
  @recordings = nil
end

Instance Method Details

#credentials_lists(sid = :unset) ⇒ CredentialListList, CredentialListContext

Access the credentials_lists

Returns:

Raises:

  • (ArgumentError) 

304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 304

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

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

  unless @credentials_lists
    @credentials_lists = CredentialListList.new(@version, trunk_sid: @solution[:sid], )
  end

  @credentials_lists
end

#delete ⇒ Boolean

Delete the TrunkInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


227
228
229
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 227

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

#fetch ⇒ TrunkInstance

Fetch the TrunkInstance

Returns:


218
219
220
221
222
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 218

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

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

#inspect ⇒ Object

Provide a detailed, user friendly representation


371
372
373
374
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 371

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

#ip_access_control_lists(sid = :unset) ⇒ IpAccessControlListList, IpAccessControlListContext

Access the ip_access_control_lists

Returns:

Raises:

  • (ArgumentError) 

322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 322

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

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

  unless @ip_access_control_lists
    @ip_access_control_lists = IpAccessControlListList.new(@version, trunk_sid: @solution[:sid], )
  end

  @ip_access_control_lists
end

#origination_urls(sid = :unset) ⇒ OriginationUrlList, OriginationUrlContext

Access the origination_urls

Returns:

Raises:

  • (ArgumentError) 

286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 286

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

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

  unless @origination_urls
    @origination_urls = OriginationUrlList.new(@version, trunk_sid: @solution[:sid], )
  end

  @origination_urls
end

#phone_numbers(sid = :unset) ⇒ PhoneNumberList, PhoneNumberContext

Access the phone_numbers

Returns:

Raises:

  • (ArgumentError) 

340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 340

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

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

  unless @phone_numbers
    @phone_numbers = PhoneNumberList.new(@version, trunk_sid: @solution[:sid], )
  end

  @phone_numbers
end

#recordings ⇒ RecordingList, RecordingContext

Access the recordings

Returns:


358
359
360
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 358

def recordings
  RecordingContext.new(@version, @solution[:sid], )
end

#to_s ⇒ Object

Provide a user friendly representation


364
365
366
367
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 364

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

#update(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, transfer_mode: :unset, secure: :unset, cnam_lookup_enabled: :unset, transfer_caller_id: :unset) ⇒ TrunkInstance

Update the TrunkInstance

Parameters:

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

    A descriptive string that you create to describe the resource. It can be up to 64 characters long.

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

    The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and `-` and must end with `pstn.twilio.com`. See Termination Settings for more information.

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

    The URL we should call using the `disaster_recovery_method` if an error occurs while sending SIP traffic towards the configured Origination URL. We retrieve TwiML from the URL and execute the instructions like any other normal TwiML call. See Disaster Recovery for more information.

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

    The HTTP method we should use to call the `disaster_recovery_url`. Can be: `GET` or `POST`.

  • transfer_mode (trunk.TransferSetting) (defaults to: :unset) —

    The call transfer settings for the trunk. Can be: `enable-all`, `sip-only` and `disable-all`. See Transfer for more information.

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

    Whether Secure Trunking is enabled for the trunk. If enabled, all calls going through the trunk will be secure using SRTP for media and TLS for signaling. If disabled, then RTP will be used for media. See Secure Trunking for more information.

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

    Whether Caller ID Name (CNAM) lookup should be enabled for the trunk. If enabled, all inbound calls to the SIP Trunk from the United States and Canada automatically perform a CNAM Lookup and display Caller ID data on your phone. See CNAM Lookups for more information.

  • transfer_caller_id (trunk.TransferCallerId) (defaults to: :unset) —

    Caller Id for transfer target. Can be: `from-transferee` (default) or `from-transferor`.

Returns:


265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 265

def update(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, transfer_mode: :unset, secure: :unset, cnam_lookup_enabled: :unset, transfer_caller_id: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'DomainName' => domain_name,
      'DisasterRecoveryUrl' => disaster_recovery_url,
      'DisasterRecoveryMethod' => disaster_recovery_method,
      'TransferMode' => transfer_mode,
      'Secure' => secure,
      'CnamLookupEnabled' => cnam_lookup_enabled,
      'TransferCallerId' => transfer_caller_id,
  })

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

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