Class: Twilio::REST::FlexApi::V1::FlexFlowInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ FlexFlowInstance

Initialize the FlexFlowInstance



721
722
723
724
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/flex_api/v1/flex_flow.rb', line 721

def initialize(version, payload , sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'sid' => payload['sid'],
        'friendly_name' => payload['friendly_name'],
        'chat_service_sid' => payload['chat_service_sid'],
        'channel_type' => payload['channel_type'],
        'contact_identity' => payload['contact_identity'],
        'enabled' => payload['enabled'],
        'integration_type' => payload['integration_type'],
        'integration' => payload['integration'],
        'long_lived' => payload['long_lived'],
        'janitor_enabled' => payload['janitor_enabled'],
        'url' => payload['url'],
    }

    # Context
    @instance_context = nil
    @params = { 'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String 



761
762
763
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 761

def 
    @properties['account_sid']
end

#channel_type ⇒ ChannelType 



797
798
799
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 797

def channel_type
    @properties['channel_type']
end

#chat_service_sid ⇒ String 



791
792
793
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 791

def chat_service_sid
    @properties['chat_service_sid']
end

#contact_identity ⇒ String 



803
804
805
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 803

def contact_identity
    @properties['contact_identity']
end

#context ⇒ FlexFlowContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context



752
753
754
755
756
757
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 752

def context
    unless @instance_context
        @instance_context = FlexFlowContext.new(@version , @params['sid'])
    end
    @instance_context
end

#date_created ⇒ Time 



767
768
769
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 767

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



773
774
775
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 773

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the FlexFlowInstance



846
847
848
849
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 846

def delete

    context.delete
end

#enabled ⇒ Boolean 



809
810
811
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 809

def enabled
    @properties['enabled']
end

#fetch ⇒ FlexFlowInstance

Fetch the FlexFlowInstance



854
855
856
857
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 854

def fetch

    context.fetch
end

#friendly_name ⇒ String 



785
786
787
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 785

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



929
930
931
932
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 929

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.FlexApi.V1.FlexFlowInstance #{values}>"
end

#integration ⇒ Hash 



821
822
823
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 821

def integration
    @properties['integration']
end

#integration_type ⇒ IntegrationType 



815
816
817
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 815

def integration_type
    @properties['integration_type']
end

#janitor_enabled ⇒ Boolean 



833
834
835
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 833

def janitor_enabled
    @properties['janitor_enabled']
end

#long_lived ⇒ Boolean 



827
828
829
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 827

def long_lived
    @properties['long_lived']
end

#sid ⇒ String 



779
780
781
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 779

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



922
923
924
925
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 922

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.FlexApi.V1.FlexFlowInstance #{values}>"
end

#update(friendly_name: :unset, chat_service_sid: :unset, channel_type: :unset, contact_identity: :unset, enabled: :unset, integration_type: :unset, integration_flow_sid: :unset, integration_url: :unset, integration_workspace_sid: :unset, integration_workflow_sid: :unset, integration_channel: :unset, integration_timeout: :unset, integration_priority: :unset, integration_creation_on_message: :unset, long_lived: :unset, janitor_enabled: :unset, integration_retry_count: :unset) ⇒ FlexFlowInstance

Update the FlexFlowInstance



879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 879

def update(
    friendly_name: :unset, 
    chat_service_sid: :unset, 
    channel_type: :unset, 
    contact_identity: :unset, 
    enabled: :unset, 
    integration_type: :unset, 
    integration_flow_sid: :unset, 
    integration_url: :unset, 
    integration_workspace_sid: :unset, 
    integration_workflow_sid: :unset, 
    integration_channel: :unset, 
    integration_timeout: :unset, 
    integration_priority: :unset, 
    integration_creation_on_message: :unset, 
    long_lived: :unset, 
    janitor_enabled: :unset, 
    integration_retry_count: :unset
)

    context.update(
        friendly_name: friendly_name, 
        chat_service_sid: chat_service_sid, 
        channel_type: channel_type, 
        contact_identity: contact_identity, 
        enabled: enabled, 
        integration_type: integration_type, 
        integration_flow_sid: integration_flow_sid, 
        integration_url: integration_url, 
        integration_workspace_sid: integration_workspace_sid, 
        integration_workflow_sid: integration_workflow_sid, 
        integration_channel: integration_channel, 
        integration_timeout: integration_timeout, 
        integration_priority: integration_priority, 
        integration_creation_on_message: integration_creation_on_message, 
        long_lived: long_lived, 
        janitor_enabled: janitor_enabled, 
        integration_retry_count: integration_retry_count, 
    )
end

#url ⇒ String 



839
840
841
 
# File 'lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb', line 839

def url
    @properties['url']
end