Class: Twilio::REST::Conversations::V2::ConversationContext

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

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ ConversationContext

Initialize the ConversationContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) 


773
774
775
776
777
778
779
780
781
782
783
 
# File 'lib/twilio-ruby/rest/conversations/v2/conversation.rb', line 773

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

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

    
end

Instance Method Details

#delete(idempotency_key: :unset) ⇒ Boolean

Delete the ConversationInstance

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



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

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)
    ConversationInstance.new(
      @version,
      response.body,
        sid: @solution[:sid],
    )
    
end

#delete_with_metadata(idempotency_key: :unset) ⇒ Boolean

Delete the ConversationInstanceMetadata

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



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

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)
      conversation_instance = ConversationInstance.new(
          @version,
          response.body,
          account_sid: @solution[:account_sid],
          sid: @solution[:sid],
      )
      ConversationInstanceMetadata.new(@version, conversation_instance, response.headers, response.status_code)
end

#fetch ⇒ ConversationInstance

Fetch the ConversationInstance

Returns:



830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
 
# File 'lib/twilio-ruby/rest/conversations/v2/conversation.rb', line 830

def fetch

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

#fetch_with_metadata ⇒ ConversationInstance

Fetch the ConversationInstanceMetadata

Returns:



849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
 
# File 'lib/twilio-ruby/rest/conversations/v2/conversation.rb', line 849

def fetch_with_metadata

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



977
978
979
980
 
# File 'lib/twilio-ruby/rest/conversations/v2/conversation.rb', line 977

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

#patch(patch_conversation_by_id_request: :unset) ⇒ ConversationInstance

Patch the ConversationInstance

Parameters:

  • patch_conversation_by_id_request (PatchConversationByIdRequest) (defaults to: :unset) —

    The conversation fields to update

Returns:



875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
 
# File 'lib/twilio-ruby/rest/conversations/v2/conversation.rb', line 875

def patch(patch_conversation_by_id_request: :unset
)

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

#patch_with_metadata(patch_conversation_by_id_request: :unset) ⇒ ConversationInstance

Patch the ConversationInstanceMetadata

Parameters:

  • patch_conversation_by_id_request (PatchConversationByIdRequest) (defaults to: :unset) —

    The conversation fields to update

Returns:



896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/twilio-ruby/rest/conversations/v2/conversation.rb', line 896

def patch_with_metadata(patch_conversation_by_id_request: :unset
)

    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: patch_conversation_by_id_request.to_json)
    conversation_instance = ConversationInstance.new(
        @version,
        response.body,
        sid: @solution[:sid],
    )
    ConversationInstanceMetadata.new(
        @version,
        conversation_instance,
        response.headers,
        response.status_code
    )
end

#to_s ⇒ Object

Provide a user friendly representation



970
971
972
973
 
# File 'lib/twilio-ruby/rest/conversations/v2/conversation.rb', line 970

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

#update(update_conversation_by_id_request: :unset) ⇒ ConversationInstance

Update the ConversationInstance

Parameters:

  • update_conversation_by_id_request (UpdateConversationByIdRequest) (defaults to: :unset) —

    The conversation to update

Returns:



923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
 
# File 'lib/twilio-ruby/rest/conversations/v2/conversation.rb', line 923

def update(update_conversation_by_id_request: :unset
)

    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_conversation_by_id_request.to_json)
    ConversationInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end

#update_with_metadata(update_conversation_by_id_request: :unset) ⇒ ConversationInstance

Update the ConversationInstanceMetadata

Parameters:

  • update_conversation_by_id_request (UpdateConversationByIdRequest) (defaults to: :unset) —

    The conversation to update

Returns:



944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
 
# File 'lib/twilio-ruby/rest/conversations/v2/conversation.rb', line 944

def update_with_metadata(update_conversation_by_id_request: :unset
)

    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_conversation_by_id_request.to_json)
    conversation_instance = ConversationInstance.new(
        @version,
        response.body,
        sid: @solution[:sid],
    )
    ConversationInstanceMetadata.new(
        @version,
        conversation_instance,
        response.headers,
        response.status_code
    )
end