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

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

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


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

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

Returns:

  • (String) —

    The SID of the Account that created the resource


275
276
277
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 275

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:


266
267
268
269
270
271
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 266

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

#date_created ⇒ Time

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

Returns:

  • (Time) —

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


293
294
295
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 293

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

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

Returns:

  • (Time) —

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


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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ConnectionPolicyInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#fetch ⇒ ConnectionPolicyInstance

Fetch the ConnectionPolicyInstance

Returns:


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

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


287
288
289
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 287

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation


354
355
356
357
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 354

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

#links ⇒ String

Returns The URLs of related resources.

Returns:

  • (String) —

    The URLs of related resources


311
312
313
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 311

def links
  @properties['links']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource


281
282
283
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 281

def sid
  @properties['sid']
end

#targets ⇒ targets

Access the targets

Returns:


341
342
343
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 341

def targets
  context.targets
end

#to_s ⇒ Object

Provide a user friendly representation


347
348
349
350
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 347

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:


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

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


305
306
307
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 305

def url
  @properties['url']
end