Class: Twilio::REST::Api::V2010::AccountContext::OutgoingCallerIdInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_sid: nil, sid: nil) ⇒ OutgoingCallerIdInstance

Initialize the OutgoingCallerIdInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) (defaults to: nil) —

    The unique id of the Account responsible for this Caller Id.

  • sid (String) (defaults to: nil) —

    The outgoing-caller-id Sid that uniquely identifies this resource



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

def initialize(version, payload, account_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
      'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
      'friendly_name' => payload['friendly_name'],
      'account_sid' => payload['account_sid'],
      'phone_number' => payload['phone_number'],
      'uri' => payload['uri'],
  }

  # Context
  @instance_context = nil
  @params = {
      'account_sid' => ,
      'sid' => sid || @properties['sid'],
  }
end

Instance Method Details

#account_sid ⇒ String

Returns The unique sid that identifies this account.

Returns:

  • (String) —

    The unique sid that identifies this account



326
327
328
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 326

def 
  @properties['account_sid']
end

#context ⇒ OutgoingCallerIdContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



289
290
291
292
293
294
295
296
297
298
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 289

def context
  unless @instance_context
    @instance_context = OutgoingCallerIdContext.new(
        @version,
        @params['account_sid'],
        @params['sid'],
    )
  end
  @instance_context
end

#date_created ⇒ Time

Returns The date this resource was created.

Returns:

  • (Time) —

    The date this resource was created



308
309
310
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 308

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this resource was last updated.

Returns:

  • (Time) —

    The date this resource was last updated



314
315
316
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 314

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the OutgoingCallerIdInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



362
363
364
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 362

def delete
  context.delete
end

#fetch ⇒ OutgoingCallerIdInstance

Fetch a OutgoingCallerIdInstance

Returns:



345
346
347
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 345

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns A human readable description for this resource.

Returns:

  • (String) —

    A human readable description for this resource



320
321
322
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 320

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



375
376
377
378
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 375

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Api.V2010.OutgoingCallerIdInstance #{values}>"
end

#phone_number ⇒ String

Returns The incoming phone number.

Returns:

  • (String) —

    The incoming phone number



332
333
334
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 332

def phone_number
  @properties['phone_number']
end

#sid ⇒ String

Returns A string that uniquely identifies this outgoing-caller-ids.

Returns:

  • (String) —

    A string that uniquely identifies this outgoing-caller-ids



302
303
304
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 302

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



368
369
370
371
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 368

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Api.V2010.OutgoingCallerIdInstance #{values}>"
end

#update(friendly_name: :unset) ⇒ OutgoingCallerIdInstance

Update the OutgoingCallerIdInstance

Parameters:

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

    A human readable description of the caller ID

Returns:



353
354
355
356
357
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 353

def update(friendly_name: :unset)
  context.update(
      friendly_name: friendly_name,
  )
end

#uri ⇒ String

Returns The URI for this resource.

Returns:

  • (String) —

    The URI for this resource



338
339
340
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 338

def uri
  @properties['uri']
end