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

Inherits:
InstanceContext
  • Object
show all
Defined in:
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/engagement/step/step_context.rb,
lib/twilio-ruby/rest/studio/v1/flow/engagement/engagement_context.rb

Defined Under Namespace

Classes: EngagementContextContext, EngagementContextInstance, EngagementContextList, EngagementContextPage, StepContext, StepInstance, StepList, StepPage

Instance Method Summary collapse

Constructor Details

#initialize(version, flow_sid, sid) ⇒ EngagementContext

Initialize the EngagementContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • flow_sid (String) —

    The SID of the Flow.

  • sid (String) —

    The SID of the Engagement resource to fetch.



164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 164

def initialize(version, flow_sid, sid)
    super(version)

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

    # Dependents
    @steps = nil
    @engagement_context = nil
end

Instance Method Details

#delete ⇒ Boolean

Delete the EngagementInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



178
179
180
181
182
183
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 178

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    @version.delete('DELETE', @uri, headers: headers)
end

#engagement_context ⇒ EngagementContextList, EngagementContextContext

Access the engagement_context

Returns:



224
225
226
227
228
229
230
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 224

def engagement_context
    EngagementContextContext.new(
            @version,
            @solution[:flow_sid],
            @solution[:sid]
            )
end

#fetch ⇒ EngagementInstance

Fetch the EngagementInstance

Returns:



188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 188

def fetch

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



241
242
243
244
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 241

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

#steps(sid = :unset) ⇒ StepList, StepContext

Access the steps

Returns:

Raises:

  • (ArgumentError) 


205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 205

def steps(sid=:unset)

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

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

    unless @steps
        @steps = StepList.new(
            @version, flow_sid: @solution[:flow_sid], engagement_sid: @solution[:sid], )
    end

 @steps
end

#to_s ⇒ Object

Provide a user friendly representation



234
235
236
237
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 234

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