Class: Twilio::REST::Memory::V1::ObservationContext

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/memory/v1/observation.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, store_id, profile_id, observation_id) ⇒ ObservationContext

Initialize the ObservationContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • store_id (String) —

    A unique Memory Store ID using Twilio Type ID (TTID) format

  • profile_id (String) —

    The unique identifier for the profile using Twilio Type ID (TTID) format.

  • observation_id (String) —

    The observation ID.



398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/twilio-ruby/rest/memory/v1/observation.rb', line 398

def initialize(version, store_id, profile_id, observation_id)
    
    apiV1Version = ApiV1Version.new version.domain, version
    super(apiV1Version)

    # Path Solution
    @solution = { store_id: store_id, profile_id: profile_id, observation_id: observation_id,  }
    @uri = "/Stores/#{@solution[:store_id]}/Profiles/#{@solution[:profile_id]}/Observations/#{@solution[:observation_id]}"

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the ObservationInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/twilio-ruby/rest/memory/v1/observation.rb', line 412

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
    ObservationInstance.new(
      @version,
      response.body,
        store_id: @solution[:store_id],
        profile_id: @solution[:profile_id],
        observation_id: @solution[:observation_id],
    )
    
end

#delete_with_metadata ⇒ Boolean

Delete the ObservationInstanceMetadata

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/twilio-ruby/rest/memory/v1/observation.rb', line 432

def delete_with_metadata

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

#fetch ⇒ ObservationInstance

Fetch the ObservationInstance

Returns:



451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/twilio-ruby/rest/memory/v1/observation.rb', line 451

def fetch

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

#fetch_with_metadata ⇒ ObservationInstance

Fetch the ObservationInstanceMetadata

Returns:



472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
 
# File 'lib/twilio-ruby/rest/memory/v1/observation.rb', line 472

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    observation_instance = ObservationInstance.new(
        @version,
        response.body,
        store_id: @solution[:store_id],
        profile_id: @solution[:profile_id],
        observation_id: @solution[:observation_id],
    )
    ObservationInstanceMetadata.new(
        @version,
        observation_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



558
559
560
561
 
# File 'lib/twilio-ruby/rest/memory/v1/observation.rb', line 558

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

#patch(observation_base: nil) ⇒ ObservationInstance

Patch the ObservationInstance

Parameters:

  • observation_base (ObservationBase) (defaults to: nil)

Returns:



500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'lib/twilio-ruby/rest/memory/v1/observation.rb', line 500

def patch(observation_base: nil
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    headers['Content-Type'] = 'application/json'
    
    
    
    
    payload = @version.patch('PATCH', @uri, headers: headers, data: observation_base.to_json)
    ObservationInstance.new(
        @version,
        payload,
        store_id: @solution[:store_id],
        profile_id: @solution[:profile_id],
        observation_id: @solution[:observation_id],
    )
end

#patch_with_metadata(observation_base: nil) ⇒ ObservationInstance

Patch the ObservationInstanceMetadata

Parameters:

  • observation_base (ObservationBase) (defaults to: nil)

Returns:



523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'lib/twilio-ruby/rest/memory/v1/observation.rb', line 523

def patch_with_metadata(observation_base: nil
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    headers['Content-Type'] = 'application/json'
    
    
    
    
    response = @version.patch_with_metadata('PATCH', @uri, headers: headers, data: observation_base.to_json)
    observation_instance = ObservationInstance.new(
        @version,
        response.body,
        store_id: @solution[:store_id],
        profile_id: @solution[:profile_id],
        observation_id: @solution[:observation_id],
    )
    ObservationInstanceMetadata.new(
        @version,
        observation_instance,
        response.headers,
        response.status_code
    )
end

#to_s ⇒ Object

Provide a user friendly representation



551
552
553
554
 
# File 'lib/twilio-ruby/rest/memory/v1/observation.rb', line 551

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