Class: Twilio::REST::Intelligence::V3::ConfigurationContext

Inherits:
Twilio::REST::InstanceContext show all
Defined in:
lib/twilio-ruby/rest/intelligence/v3/configuration.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, id) ⇒ ConfigurationContext

Initialize the ConfigurationContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • id (String) —

    The unique identifier of the Intelligence Configuration.



608
609
610
611
612
613
614
615
616
617
618
 
# File 'lib/twilio-ruby/rest/intelligence/v3/configuration.rb', line 608

def initialize(version, id)
    
    apiV1Version = ApiV1Version.new version.domain, version
    super(apiV1Version)

    # Path Solution
    @solution = { id: id,  }
    @uri = "/ControlPlane/Configurations/#{@solution[:id]}"

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the ConfigurationInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



622
623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'lib/twilio-ruby/rest/intelligence/v3/configuration.rb', line 622

def delete

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

#delete_with_metadata ⇒ Boolean

Delete the ConfigurationInstanceMetadata

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
 
# File 'lib/twilio-ruby/rest/intelligence/v3/configuration.rb', line 640

def delete_with_metadata

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

#fetch ⇒ ConfigurationInstance

Fetch the ConfigurationInstance

Returns:



659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
 
# File 'lib/twilio-ruby/rest/intelligence/v3/configuration.rb', line 659

def fetch

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

#fetch_with_metadata ⇒ ConfigurationInstance

Fetch the ConfigurationInstanceMetadata

Returns:



678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
 
# File 'lib/twilio-ruby/rest/intelligence/v3/configuration.rb', line 678

def fetch_with_metadata

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



758
759
760
761
 
# File 'lib/twilio-ruby/rest/intelligence/v3/configuration.rb', line 758

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

#to_s ⇒ Object

Provide a user friendly representation



751
752
753
754
 
# File 'lib/twilio-ruby/rest/intelligence/v3/configuration.rb', line 751

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

#update(update_configuration_request: nil) ⇒ ConfigurationInstance

Update the ConfigurationInstance

Parameters:

  • update_configuration_request (UpdateConfigurationRequest) (defaults to: nil)

Returns:



704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
 
# File 'lib/twilio-ruby/rest/intelligence/v3/configuration.rb', line 704

def update(update_configuration_request: nil
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    headers['Content-Type'] = 'application/json'
    
    
    
    
    payload = @version.update('PUT', @uri, headers: headers, data: update_configuration_request.to_json)
    ConfigurationInstance.new(
        @version,
        payload,
        id: @solution[:id],
    )
end

#update_with_metadata(update_configuration_request: nil) ⇒ ConfigurationInstance

Update the ConfigurationInstanceMetadata

Parameters:

  • update_configuration_request (UpdateConfigurationRequest) (defaults to: nil)

Returns:



725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
 
# File 'lib/twilio-ruby/rest/intelligence/v3/configuration.rb', line 725

def update_with_metadata(update_configuration_request: nil
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    headers['Content-Type'] = 'application/json'
    
    
    
    
    response = @version.update_with_metadata('PUT', @uri, headers: headers, data: update_configuration_request.to_json)
    configuration_instance = ConfigurationInstance.new(
        @version,
        response.body,
        id: @solution[:id],
    )
    ConfigurationInstanceMetadata.new(
        @version,
        configuration_instance,
        response.headers,
        response.status_code
    )
end