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 that created this OutgoingCallerId resource.

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

    The SID of the Call resource to fetch.



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 260

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

Returns:



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

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:



283
284
285
286
287
288
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 283

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 and time in GMT that the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT that the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the OutgoingCallerIdInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



335
336
337
338
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 335

def delete

    context.delete
end

#fetch ⇒ OutgoingCallerIdInstance

Fetch the OutgoingCallerIdInstance

Returns:



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

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.



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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](www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.

Returns:



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

def phone_number
    @properties['phone_number']
end

#sid ⇒ String

Returns The unique string that that we created to identify the OutgoingCallerId resource.

Returns:

  • (String) —

    The unique string that that we created to identify the OutgoingCallerId resource.



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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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:



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

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`.



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

def uri
    @properties['uri']
end