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, id) ⇒ ConfigurationContext

Initialize the ConfigurationContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • id (String) 


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

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(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



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

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,
        id: @solution[:id],
    )
    
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



782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
 
# File 'lib/twilio-ruby/rest/conversations/v2/configuration.rb', line 782

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:



803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
 
# File 'lib/twilio-ruby/rest/conversations/v2/configuration.rb', line 803

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:



822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
 
# File 'lib/twilio-ruby/rest/conversations/v2/configuration.rb', line 822

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



908
909
910
911
 
# File 'lib/twilio-ruby/rest/conversations/v2/configuration.rb', line 908

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

#to_s ⇒ Object

Provide a user friendly representation



901
902
903
904
 
# File 'lib/twilio-ruby/rest/conversations/v2/configuration.rb', line 901

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:



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

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,
        id: @solution[:id],
    )
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:



873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
 
# File 'lib/twilio-ruby/rest/conversations/v2/configuration.rb', line 873

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