Class: Twilio::REST::Voice::V1::ConnectionPolicyInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/voice/v1/connection_policy.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ ConnectionPolicyInstance

Initialize the ConnectionPolicyInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this ConnectionPolicy resource.

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

    The SID of the Call resource to fetch.



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 276

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'sid' => payload['sid'],
        'friendly_name' => payload['friendly_name'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'url' => payload['url'],
        'links' => payload['links'],
    }

    # Context
    @instance_context = nil
    @params = { '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 Connection Policy resource.

Returns:



308
309
310
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 308

def 
    @properties['account_sid']
end

#context ⇒ ConnectionPolicyContext

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

Returns:



299
300
301
302
303
304
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 299

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

#date_created ⇒ Time

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

Returns:



326
327
328
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 326

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

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

Returns:



332
333
334
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 332

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ConnectionPolicyInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



351
352
353
354
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 351

def delete

    context.delete
end

#fetch ⇒ ConnectionPolicyInstance

Fetch the ConnectionPolicyInstance

Returns:



359
360
361
362
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 359

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.



320
321
322
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 320

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



393
394
395
396
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 393

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

#links ⇒ Hash

Returns The URLs of related resources.

Returns:

  • (Hash) —

    The URLs of related resources.



344
345
346
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 344

def links
    @properties['links']
end

#sid ⇒ String

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

Returns:

  • (String) —

    The unique string that we created to identify the Connection Policy resource.



314
315
316
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 314

def sid
    @properties['sid']
end

#targets ⇒ targets

Access the targets

Returns:



380
381
382
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 380

def targets
    context.targets
end

#to_s ⇒ Object

Provide a user friendly representation



386
387
388
389
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 386

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

#update(friendly_name: :unset) ⇒ ConnectionPolicyInstance

Update the ConnectionPolicyInstance

Parameters:

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

    A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long.

Returns:



368
369
370
371
372
373
374
375
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 368

def update(
    friendly_name: :unset
)

    context.update(
        friendly_name: friendly_name, 
    )
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource.



338
339
340
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 338

def url
    @properties['url']
end