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

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/studio/v1/flow/engagement/step/step_context.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, flow_sid: nil, engagement_sid: nil, step_sid: nil) ⇒ StepContextInstance

Initialize the StepContextInstance

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.

  • engagement_sid (String) (defaults to: nil)

    The SID of the Engagement.

  • step_sid (String) (defaults to: nil)

    The SID of the Step the context is associated with.


128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step/step_context.rb', line 128

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

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

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

Instance Method Details

#account_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


164
165
166
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step/step_context.rb', line 164

def 
  @properties['account_sid']
end

#contextHash

Returns The current state of the flow.

Returns:

  • (Hash)

    The current state of the flow


150
151
152
153
154
155
156
157
158
159
160
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step/step_context.rb', line 150

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

#engagement_sidString

Returns The SID of the Engagement.

Returns:

  • (String)

    The SID of the Engagement


176
177
178
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step/step_context.rb', line 176

def engagement_sid
  @properties['engagement_sid']
end

#fetchStepContextInstance

Fetch the StepContextInstance

Returns:


201
202
203
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step/step_context.rb', line 201

def fetch
  context.fetch
end

#flow_sidString

Returns The SID of the Flow.

Returns:

  • (String)

    The SID of the Flow


182
183
184
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step/step_context.rb', line 182

def flow_sid
  @properties['flow_sid']
end

#inspectObject

Provide a detailed, user friendly representation


214
215
216
217
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step/step_context.rb', line 214

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

#step_sidString

Returns Step SID.

Returns:

  • (String)

    Step SID


188
189
190
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step/step_context.rb', line 188

def step_sid
  @properties['step_sid']
end

#to_sObject

Provide a user friendly representation


207
208
209
210
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step/step_context.rb', line 207

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

#urlString

Returns The absolute URL of the resource.

Returns:

  • (String)

    The absolute URL of the resource


194
195
196
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step/step_context.rb', line 194

def url
  @properties['url']
end