Class: Twilio::REST::Studio::V1::FlowContext

Inherits:
InstanceContext show all
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, EngagementInstanceMetadata, EngagementList, EngagementListResponse, EngagementPage, EngagementPageMetadata, ExecutionContext, ExecutionInstance, ExecutionInstanceMetadata, ExecutionList, ExecutionListResponse, ExecutionPage, ExecutionPageMetadata

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ FlowContext

Initialize the FlowContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    The SID of the Flow resource to fetch.



167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 167

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

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



182
183
184
185
186
187
188
189
190
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 182

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    

    @version.delete('DELETE', @uri, headers: headers)
end

#delete_with_metadata ⇒ Boolean

Delete the FlowInstanceMetadata

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 195

def delete_with_metadata

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

#engagements(sid = :unset) ⇒ EngagementList, EngagementContext

Access the engagements

Returns:

Raises:

  • (ArgumentError) 


278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 278

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

Returns:

Raises:

  • (ArgumentError) 


259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 259

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

Returns:



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 214

def fetch

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

#fetch_with_metadata ⇒ FlowInstance

Fetch the FlowInstanceMetadata

Returns:



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 233

def fetch_with_metadata

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



303
304
305
306
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 303

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

#to_s ⇒ Object

Provide a user friendly representation



296
297
298
299
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 296

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