Class: Twilio::REST::Voice::V1::ConnectionPolicyContext

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

Defined Under Namespace

Classes: ConnectionPolicyTargetContext, ConnectionPolicyTargetInstance, ConnectionPolicyTargetInstanceMetadata, ConnectionPolicyTargetList, ConnectionPolicyTargetListResponse, ConnectionPolicyTargetPage, ConnectionPolicyTargetPageMetadata

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ ConnectionPolicyContext

Initialize the ConnectionPolicyContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

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



223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 223

def initialize(version, sid)
    super(version)
    

    # Path Solution
    @solution = { sid: sid,  }
    @uri = "/ConnectionPolicies/#{@solution[:sid]}"

    # Dependents
    @targets = nil
end

Instance Method Details

#delete ⇒ Boolean

Delete the ConnectionPolicyInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



237
238
239
240
241
242
243
244
245
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 237

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    

    @version.delete('DELETE', @uri, headers: headers)
end

#delete_with_metadata ⇒ Boolean

Delete the ConnectionPolicyInstanceMetadata

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 250

def delete_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
      response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
      connectionPolicy_instance = ConnectionPolicyInstance.new(
          @version,
          response.body,
          account_sid: @solution[:account_sid],
          sid: @solution[:sid],
      )
      ConnectionPolicyInstanceMetadata.new(@version, connectionPolicy_instance, response.headers, response.status_code)
end

#fetch ⇒ ConnectionPolicyInstance

Fetch the ConnectionPolicyInstance

Returns:



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 269

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    ConnectionPolicyInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end

#fetch_with_metadata ⇒ ConnectionPolicyInstance

Fetch the ConnectionPolicyInstanceMetadata

Returns:



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 288

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    connection_policy_instance = ConnectionPolicyInstance.new(
        @version,
        response.body,
        sid: @solution[:sid],
    )
    ConnectionPolicyInstanceMetadata.new(
        @version,
        connection_policy_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



397
398
399
400
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 397

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Voice.V1.ConnectionPolicyContext #{context}>"
end

#targets(sid = :unset) ⇒ ConnectionPolicyTargetList, ConnectionPolicyTargetContext

Access the targets

Returns:

Raises:

  • (ArgumentError) 


372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 372

def targets(sid=:unset)

    raise ArgumentError, 'sid cannot be nil' if sid.nil?

    if sid != :unset
        return ConnectionPolicyTargetContext.new(@version, @solution[:sid],sid )
    end

    unless @targets
        @targets = ConnectionPolicyTargetList.new(
            @version, connection_policy_sid: @solution[:sid], )
    end

 @targets
end

#to_s ⇒ Object

Provide a user friendly representation



390
391
392
393
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 390

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Voice.V1.ConnectionPolicyContext #{context}>"
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:



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 314

def update(
  friendly_name: :unset
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.update('POST', @uri, data: data, headers: headers)
    ConnectionPolicyInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end

#update_with_metadata(friendly_name: :unset) ⇒ ConnectionPolicyInstance

Update the ConnectionPolicyInstanceMetadata

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:



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 340

def update_with_metadata(
  friendly_name: :unset
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
    connection_policy_instance = ConnectionPolicyInstance.new(
        @version,
        response.body,
        sid: @solution[:sid],
    )
    ConnectionPolicyInstanceMetadata.new(
        @version,
        connection_policy_instance,
        response.headers,
        response.status_code
    )
end