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/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

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ TrunkContext

Initialize the TrunkContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    The sid



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 190

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
end

Instance Method Details

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

Access the credentials_lists

Returns:

Raises:

  • (ArgumentError) 


293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 293

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

Deletes the TrunkInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

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

#fetch ⇒ TrunkInstance

Fetch a TrunkInstance

Returns:



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 209

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

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

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

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

Access the ip_access_control_lists

Returns:

Raises:

  • (ArgumentError) 


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

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) 


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/trunking/v1/trunk.rb', line 268

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) 


343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 343

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

#to_s ⇒ Object

Provide a user friendly representation



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

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, recording: :unset, secure: :unset) ⇒ TrunkInstance

Update the TrunkInstance

Parameters:

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

    The friendly_name

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

    The domain_name

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

    The disaster_recovery_url

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

    The disaster_recovery_method

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

    The recording

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

    The secure

Returns:



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 241

def update(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, recording: :unset, secure: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'DomainName' => domain_name,
      'DisasterRecoveryUrl' => disaster_recovery_url,
      'DisasterRecoveryMethod' => disaster_recovery_method,
      'Recording' => recording,
      'Secure' => secure,
  })

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

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