Class: Twilio::REST::Studio::V2::FlowContext

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/studio/v2/flow.rb,
lib/twilio-ruby/rest/studio/v2/flow/execution.rb,
lib/twilio-ruby/rest/studio/v2/flow/flow_revision.rb,
lib/twilio-ruby/rest/studio/v2/flow/flow_test_user.rb,
lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb,
lib/twilio-ruby/rest/studio/v2/flow/execution/execution_context.rb,
lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step/execution_step_context.rb

Defined Under Namespace

Classes: ExecutionContext, ExecutionInstance, ExecutionList, ExecutionPage, FlowRevisionContext, FlowRevisionInstance, FlowRevisionList, FlowRevisionPage, FlowTestUserContext, FlowTestUserInstance, FlowTestUserList, FlowTestUserPage

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.



160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 160

def initialize(version, sid)
    super(version)

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

    # Dependents
    @executions = nil
    @test_users = nil
    @revisions = nil
end

Instance Method Details

#delete ⇒ Boolean

Delete the FlowInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



175
176
177
178
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 175

def delete

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

#executions(sid = :unset) ⇒ ExecutionList, ExecutionContext

Access the executions

Returns:

Raises:

  • (ArgumentError) 


226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 226

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:



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

def fetch

    payload = @version.fetch('GET', @uri)
    FlowInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



280
281
282
283
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 280

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

#revisions(revision = :unset) ⇒ FlowRevisionList, FlowRevisionContext

Access the revisions

Returns:

Raises:

  • (ArgumentError) 


255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 255

def revisions(revision=:unset)

    raise ArgumentError, 'revision cannot be nil' if revision.nil?

    if revision != :unset
        return FlowRevisionContext.new(@version, @solution[:sid],revision )
    end

    unless @revisions
        @revisions = FlowRevisionList.new(
            @version, sid: @solution[:sid], )
    end

 @revisions
end

#test_users ⇒ FlowTestUserList, FlowTestUserContext

Access the test_users

Returns:



245
246
247
248
249
250
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 245

def test_users
    FlowTestUserContext.new(
            @version,
            @solution[:sid]
            )
end

#to_s ⇒ Object

Provide a user friendly representation



273
274
275
276
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 273

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

#update(status: nil, friendly_name: :unset, definition: :unset, commit_message: :unset) ⇒ FlowInstance

Update the FlowInstance

Parameters:

  • status (Status) (defaults to: nil)
  • friendly_name (String) (defaults to: :unset) —

    The string that you assigned to describe the Flow.

  • definition (Object) (defaults to: :unset) —

    JSON representation of flow definition.

  • commit_message (String) (defaults to: :unset) —

    Description of change made in the revision.

Returns:



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 200

def update(
    status: nil, 
    friendly_name: :unset, 
    definition: :unset, 
    commit_message: :unset
)

    data = Twilio::Values.of({
        'Status' => status,
        'FriendlyName' => friendly_name,
        'Definition' => Twilio.serialize_object(definition),
        'CommitMessage' => commit_message,
    })

    payload = @version.update('POST', @uri, data: data)
    FlowInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end