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 SID of the [Account](www.twilio.com/docs/api/rest/account) that created the OutgoingCallerId resource.

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

    The Twilio-provided string that uniquely identifies the OutgoingCallerId resource to fetch.



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

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 SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



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

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:



287
288
289
290
291
292
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 287

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

#date_created ⇒ Time

Returns The RFC 2822 date and time in GMT that the resource was created.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT that the resource was created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The RFC 2822 date and time in GMT that the resource was last updated.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT that the resource was last updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the OutgoingCallerIdInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ OutgoingCallerIdInstance

Fetch a OutgoingCallerIdInstance

Returns:



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

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the resource.

Returns:

  • (String) —

    The string that you assigned to describe the resource



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#phone_number ⇒ String

Returns The phone number in E.164 format.

Returns:

  • (String) —

    The phone number in E.164 format



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

def phone_number
  @properties['phone_number']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



296
297
298
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 296

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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 descriptive string that you create to describe the resource. It can be up to 64 characters long.

Returns:



348
349
350
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 348

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

#uri ⇒ String

Returns The URI of the resource, relative to ‘api.twilio.com`.

Returns:

  • (String) —

    The URI of the resource, relative to ‘api.twilio.com`



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

def uri
  @properties['uri']
end