Class: Twilio::REST::Conversations::V2::ConfigurationContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/conversations/v2/configuration.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ ConfigurationContext

Initialize the ConfigurationContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) 


708
709
710
711
712
713
714
715
716
717
718
 
# File 'lib/twilio-ruby/rest/conversations/v2/configuration.rb', line 708

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

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

    
end

Instance Method Details

#delete(idempotency_key: :unset) ⇒ Boolean

Delete the ConfigurationInstance

Parameters:

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

    Client-generated UUID key to ensure idempotent behavior. Submitting the same key returns the original response without creating a duplicate operation. Keys are scoped to account + region with a 24-hour TTL.

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
 
# File 'lib/twilio-ruby/rest/conversations/v2/configuration.rb', line 723

def delete(
  idempotency_key: :unset
)

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

#delete_with_metadata(idempotency_key: :unset) ⇒ Boolean

Delete the ConfigurationInstanceMetadata

Parameters:

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

    Client-generated UUID key to ensure idempotent behavior. Submitting the same key returns the original response without creating a duplicate operation. Keys are scoped to account + region with a 24-hour TTL.

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/twilio-ruby/rest/conversations/v2/configuration.rb', line 744

def delete_with_metadata(
  idempotency_key: :unset
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Idempotency-Key' => idempotency_key, })
    
    
    
      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:



765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
 
# File 'lib/twilio-ruby/rest/conversations/v2/configuration.rb', line 765

def fetch

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

#fetch_with_metadata ⇒ ConfigurationInstance

Fetch the ConfigurationInstanceMetadata

Returns:



784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
 
# File 'lib/twilio-ruby/rest/conversations/v2/configuration.rb', line 784

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,
        sid: @solution[:sid],
    )
    ConfigurationInstanceMetadata.new(
        @version,
        configuration_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



870
871
872
873
 
# File 'lib/twilio-ruby/rest/conversations/v2/configuration.rb', line 870

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

#to_s ⇒ Object

Provide a user friendly representation



863
864
865
866
 
# File 'lib/twilio-ruby/rest/conversations/v2/configuration.rb', line 863

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

#update(idempotency_key: :unset, update_configuration_request: :unset) ⇒ ConfigurationInstance

Update the ConfigurationInstance

Parameters:

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

    Client-generated UUID key to ensure idempotent behavior. Submitting the same key returns the original response without creating a duplicate operation. Keys are scoped to account + region with a 24-hour TTL.

  • update_configuration_request (UpdateConfigurationRequest) (defaults to: :unset) —

    The configuration to update

Returns:



811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
 
# File 'lib/twilio-ruby/rest/conversations/v2/configuration.rb', line 811

def update(
  idempotency_key: :unset,
  update_configuration_request: :unset
)

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

#update_with_metadata(idempotency_key: :unset, update_configuration_request: :unset) ⇒ ConfigurationInstance

Update the ConfigurationInstanceMetadata

Parameters:

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

    Client-generated UUID key to ensure idempotent behavior. Submitting the same key returns the original response without creating a duplicate operation. Keys are scoped to account + region with a 24-hour TTL.

  • update_configuration_request (UpdateConfigurationRequest) (defaults to: :unset) —

    The configuration to update

Returns:



835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
 
# File 'lib/twilio-ruby/rest/conversations/v2/configuration.rb', line 835

def update_with_metadata(
  idempotency_key: :unset,
update_configuration_request: :unset
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Idempotency-Key' => idempotency_key, })
    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,
        sid: @solution[:sid],
    )
    ConfigurationInstanceMetadata.new(
        @version,
        configuration_instance,
        response.headers,
        response.status_code
    )
end