Class: Twilio::REST::Conversations::V1::ConversationContext::WebhookContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, conversation_sid, sid) ⇒ WebhookContext

Initialize the WebhookContext

Parameters:



173
174
175
176
177
178
179
180
181
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb', line 173

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

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

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the WebhookInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



185
186
187
188
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb', line 185

def delete

    @version.delete('DELETE', @uri)
end

#fetch ⇒ WebhookInstance

Fetch the WebhookInstance

Returns:



193
194
195
196
197
198
199
200
201
202
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb', line 193

def fetch

    payload = @version.fetch('GET', @uri)
    WebhookInstance.new(
        @version,
        payload,
        conversation_sid: @solution[:conversation_sid],
        sid: @solution[:sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



247
248
249
250
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb', line 247

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

#to_s ⇒ Object

Provide a user friendly representation



240
241
242
243
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb', line 240

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

#update(configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset) ⇒ WebhookInstance

Update the WebhookInstance

Parameters:

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

    The absolute url the webhook request should be sent to.

  • configuration_method (Method) (defaults to: :unset)
  • configuration_filters (Array[String]) (defaults to: :unset) —

    The list of events, firing webhook event for this Conversation.

  • configuration_triggers (Array[String]) (defaults to: :unset) —

    The list of keywords, firing webhook event for this Conversation.

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

    The studio flow SID, where the webhook should be sent to.

Returns:



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/conversations/v1/conversation/webhook.rb', line 212

def update(
    configuration_url: :unset, 
    configuration_method: :unset, 
    configuration_filters: :unset, 
    configuration_triggers: :unset, 
    configuration_flow_sid: :unset
)

    data = Twilio::Values.of({
        'Configuration.Url' => configuration_url,
        'Configuration.Method' => configuration_method,
        'Configuration.Filters' => Twilio.serialize_list(configuration_filters) { |e| e },
        'Configuration.Triggers' => Twilio.serialize_list(configuration_triggers) { |e| e },
        'Configuration.FlowSid' => configuration_flow_sid,
    })

    payload = @version.update('POST', @uri, data: data)
    WebhookInstance.new(
        @version,
        payload,
        conversation_sid: @solution[:conversation_sid],
        sid: @solution[:sid],
    )
end