Class: Twilio::REST::FlexApi::V1::InteractionInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::FlexApi::V1::InteractionInstance
- Defined in:
- lib/twilio-ruby/rest/flex_api/v1/interaction.rb
Instance Method Summary collapse
-
#channel ⇒ Hash
A JSON object that defines the Interaction’s communication channel and includes details about the channel.
-
#channels ⇒ channels
Access the channels.
-
#context ⇒ InteractionContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#fetch ⇒ InteractionInstance
Fetch the InteractionInstance.
-
#initialize(version, payload, sid: nil) ⇒ InteractionInstance
constructor
Initialize the InteractionInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
- #interaction_context_sid ⇒ String
- #links ⇒ Hash
-
#routing ⇒ Hash
A JSON Object representing the routing rules for the Interaction Channel.
-
#sid ⇒ String
The unique string created by Twilio to identify an Interaction resource, prefixed with KD.
-
#to_s ⇒ Object
Provide a user friendly representation.
- #url ⇒ String
Constructor Details
#initialize(version, payload, sid: nil) ⇒ InteractionInstance
Initialize the InteractionInstance
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 169 def initialize(version, payload , sid: nil) super(version) # Marshaled Properties @properties = { 'sid' => payload['sid'], 'channel' => payload['channel'], 'routing' => payload['routing'], 'url' => payload['url'], 'links' => payload['links'], 'interaction_context_sid' => payload['interaction_context_sid'], } # Context @instance_context = nil @params = { 'sid' => sid || @properties['sid'] , } end |
Instance Method Details
#channel ⇒ Hash
Returns A JSON object that defines the Interaction’s communication channel and includes details about the channel. See the [Outbound SMS](www.twilio.com/docs/flex/developer/conversations/interactions-api/interactions#agent-initiated-outbound-interactions) and [inbound (API-initiated)](www.twilio.com/docs/flex/developer/conversations/interactions-api/interactions#api-initiated-contact) Channel object examples.
206 207 208 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 206 def channel @properties['channel'] end |
#channels ⇒ channels
Access the channels
245 246 247 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 245 def channels context.channels end |
#context ⇒ InteractionContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
191 192 193 194 195 196 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 191 def context unless @instance_context @instance_context = InteractionContext.new(@version , @params['sid']) end @instance_context end |
#fetch ⇒ InteractionInstance
Fetch the InteractionInstance
237 238 239 240 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 237 def fetch context.fetch end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
258 259 260 261 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 258 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.FlexApi.V1.InteractionInstance #{values}>" end |
#interaction_context_sid ⇒ String
230 231 232 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 230 def interaction_context_sid @properties['interaction_context_sid'] end |
#links ⇒ Hash
224 225 226 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 224 def links @properties['links'] end |
#routing ⇒ Hash
Returns A JSON Object representing the routing rules for the Interaction Channel. See [Outbound SMS Example](www.twilio.com/docs/flex/developer/conversations/interactions-api/interactions#agent-initiated-outbound-interactions) for an example Routing object. The Interactions resource uses TaskRouter for all routing functionality. All attributes in the Routing object on your Interaction request body are added “as is” to the task. For a list of known attributes consumed by the Flex UI and/or Flex Insights, see [Known Task Attributes](www.twilio.com/docs/flex/developer/conversations/interactions-api#task-attributes).
212 213 214 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 212 def routing @properties['routing'] end |
#sid ⇒ String
Returns The unique string created by Twilio to identify an Interaction resource, prefixed with KD.
200 201 202 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 200 def sid @properties['sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
251 252 253 254 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 251 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.FlexApi.V1.InteractionInstance #{values}>" end |
#url ⇒ String
218 219 220 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 218 def url @properties['url'] end |