Class: Twilio::REST::Studio::V1::FlowContext
- Inherits:
-
InstanceContext
- Object
- InstanceContext
- Twilio::REST::Studio::V1::FlowContext
- Defined in:
- lib/twilio-ruby/rest/studio/v1/flow.rb,
lib/twilio-ruby/rest/studio/v1/flow/execution.rb,
lib/twilio-ruby/rest/studio/v1/flow/engagement.rb,
lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb,
lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb,
lib/twilio-ruby/rest/studio/v1/flow/execution/execution_context.rb,
lib/twilio-ruby/rest/studio/v1/flow/engagement/step/step_context.rb,
lib/twilio-ruby/rest/studio/v1/flow/engagement/engagement_context.rb,
lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step/execution_step_context.rb
Defined Under Namespace
Classes: EngagementContext, EngagementInstance, EngagementList, EngagementPage, ExecutionContext, ExecutionInstance, ExecutionList, ExecutionPage
Instance Method Summary collapse
-
#delete ⇒ Boolean
Delete the FlowInstance.
-
#engagements(sid = :unset) ⇒ EngagementList, EngagementContext
Access the engagements.
-
#executions(sid = :unset) ⇒ ExecutionList, ExecutionContext
Access the executions.
-
#fetch ⇒ FlowInstance
Fetch the FlowInstance.
-
#initialize(version, sid) ⇒ FlowContext
constructor
Initialize the FlowContext.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version, sid) ⇒ FlowContext
Initialize the FlowContext
132 133 134 135 136 137 138 139 140 141 142 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 132 def initialize(version, sid) super(version) # Path Solution @solution = { sid: sid, } @uri = "/Flows/#{@solution[:sid]}" # Dependents @executions = nil @engagements = nil end |
Instance Method Details
#delete ⇒ Boolean
Delete the FlowInstance
146 147 148 149 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 146 def delete @version.delete('DELETE', @uri) end |
#engagements(sid = :unset) ⇒ EngagementList, EngagementContext
Access the engagements
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 187 def engagements(sid=:unset) raise ArgumentError, 'sid cannot be nil' if sid.nil? if sid != :unset return EngagementContext.new(@version, @solution[:sid],sid ) end unless @engagements @engagements = EngagementList.new( @version, flow_sid: @solution[:sid], ) end @engagements end |
#executions(sid = :unset) ⇒ ExecutionList, ExecutionContext
Access the executions
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 168 def executions(sid=:unset) raise ArgumentError, 'sid cannot be nil' if sid.nil? if sid != :unset return ExecutionContext.new(@version, @solution[:sid],sid ) end unless @executions @executions = ExecutionList.new( @version, flow_sid: @solution[:sid], ) end @executions end |
#fetch ⇒ FlowInstance
Fetch the FlowInstance
154 155 156 157 158 159 160 161 162 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 154 def fetch payload = @version.fetch('GET', @uri) FlowInstance.new( @version, payload, sid: @solution[:sid], ) end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
212 213 214 215 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 212 def inspect context = @solution.map{|k, v| "#{k}: #{v}"}.join(',') "#<Twilio.Studio.V1.FlowContext #{context}>" end |
#to_s ⇒ Object
Provide a user friendly representation
205 206 207 208 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 205 def to_s context = @solution.map{|k, v| "#{k}: #{v}"}.join(',') "#<Twilio.Studio.V1.FlowContext #{context}>" end |