Class: Twilio::REST::FlexApi::V1::InteractionContext

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/flex_api/v1/interaction.rb,
lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb,
lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_transfer.rb,
lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_invite.rb,
lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_participant.rb

Defined Under Namespace

Classes: InteractionChannelContext, InteractionChannelInstance, InteractionChannelInstanceMetadata, InteractionChannelList, InteractionChannelListResponse, InteractionChannelPage, InteractionChannelPageMetadata

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ InteractionContext

Initialize the InteractionContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    The SID of the Interaction resource to fetch.



124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 124

def initialize(version, sid)
    super(version)
    

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

    # Dependents
    @channels = nil
end

Instance Method Details

#channels(sid = :unset) ⇒ InteractionChannelList, InteractionChannelContext

Access the channels

Returns:

Raises:

  • (ArgumentError) 


241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 241

def channels(sid=:unset)

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

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

    unless @channels
        @channels = InteractionChannelList.new(
            @version, interaction_sid: @solution[:sid], )
    end

 @channels
end

#fetch ⇒ InteractionInstance

Fetch the InteractionInstance

Returns:



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 138

def fetch

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

#fetch_with_metadata ⇒ InteractionInstance

Fetch the InteractionInstanceMetadata

Returns:



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 157

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    interaction_instance = InteractionInstance.new(
        @version,
        response.body,
        sid: @solution[:sid],
    )
    InteractionInstanceMetadata.new(
        @version,
        interaction_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



266
267
268
269
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 266

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

#to_s ⇒ Object

Provide a user friendly representation



259
260
261
262
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 259

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

#update(webhook_ttid: :unset) ⇒ InteractionInstance

Update the InteractionInstance

Parameters:

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

    The unique identifier for Interaction level webhook

Returns:



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 183

def update(
    webhook_ttid: :unset
)

    data = Twilio::Values.of({
        'WebhookTtid' => webhook_ttid,
    })

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

#update_with_metadata(webhook_ttid: :unset) ⇒ InteractionInstance

Update the InteractionInstanceMetadata

Parameters:

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

    The unique identifier for Interaction level webhook

Returns:



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 209

def update_with_metadata(
  webhook_ttid: :unset
)

    data = Twilio::Values.of({
        'WebhookTtid' => webhook_ttid,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
    interaction_instance = InteractionInstance.new(
        @version,
        response.body,
        sid: @solution[:sid],
    )
    InteractionInstanceMetadata.new(
        @version,
        interaction_instance,
        response.headers,
        response.status_code
    )
end