Class: Twilio::REST::Studio::V1::FlowContext::ExecutionContext::ExecutionStepContext::ExecutionStepContextInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step/execution_step_context.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, flow_sid: nil, execution_sid: nil, step_sid: nil) ⇒ ExecutionStepContextInstance

Initialize the ExecutionStepContextInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • flow_sid (String) (defaults to: nil) —

    The SID of the Flow.

  • execution_sid (String) (defaults to: nil) —

    The SID of the context's Execution resource.

  • step_sid (String) (defaults to: nil) —

    The SID of the Step that the context is associated with.


131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step/execution_step_context.rb', line 131

def initialize(version, payload, flow_sid: nil, execution_sid: nil, step_sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'context' => payload['context'],
      'execution_sid' => payload['execution_sid'],
      'flow_sid' => payload['flow_sid'],
      'step_sid' => payload['step_sid'],
      'url' => payload['url'],
  }

  # Context
  @instance_context = nil
  @params = {'flow_sid' => flow_sid, 'execution_sid' => execution_sid, 'step_sid' => step_sid, }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource


167
168
169
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step/execution_step_context.rb', line 167

def 
  @properties['account_sid']
end

#context ⇒ Hash

Returns The current state of the flow.

Returns:

  • (Hash) —

    The current state of the flow


153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step/execution_step_context.rb', line 153

def context
  unless @instance_context
    @instance_context = ExecutionStepContextContext.new(
        @version,
        @params['flow_sid'],
        @params['execution_sid'],
        @params['step_sid'],
    )
  end
  @instance_context
end

#execution_sid ⇒ String

Returns The SID of the Execution.

Returns:

  • (String) —

    The SID of the Execution


179
180
181
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step/execution_step_context.rb', line 179

def execution_sid
  @properties['execution_sid']
end

#fetch ⇒ ExecutionStepContextInstance

Fetch the ExecutionStepContextInstance

Returns:


204
205
206
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step/execution_step_context.rb', line 204

def fetch
  context.fetch
end

#flow_sid ⇒ String

Returns The SID of the Flow.

Returns:

  • (String) —

    The SID of the Flow


185
186
187
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step/execution_step_context.rb', line 185

def flow_sid
  @properties['flow_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation


217
218
219
220
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step/execution_step_context.rb', line 217

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

#step_sid ⇒ String

Returns Step SID.

Returns:

  • (String) —

    Step SID


191
192
193
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step/execution_step_context.rb', line 191

def step_sid
  @properties['step_sid']
end

#to_s ⇒ Object

Provide a user friendly representation


210
211
212
213
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step/execution_step_context.rb', line 210

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

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource


197
198
199
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step/execution_step_context.rb', line 197

def url
  @properties['url']
end