Class: Twilio::REST::IpMessaging::V2::ServiceContext::ChannelContext::WebhookContext

Inherits:
Twilio::REST::InstanceContext show all
Defined in:
lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, channel_sid, sid) ⇒ WebhookContext

Initialize the WebhookContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String)
  • channel_sid (String)
  • sid (String) 


179
180
181
182
183
184
185
186
187
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb', line 179

def initialize(version, service_sid, channel_sid, sid)
    super(version)

    # Path Solution
    @solution = { service_sid: service_sid, channel_sid: channel_sid, sid: sid,  }
    @uri = "/Services/#{@solution[:service_sid]}/Channels/#{@solution[:channel_sid]}/Webhooks/#{@solution[:sid]}"

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the WebhookInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



191
192
193
194
195
196
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb', line 191

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    @version.delete('DELETE', @uri, headers: headers)
end

#fetch ⇒ WebhookInstance

Fetch the WebhookInstance

Returns:



201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb', line 201

def fetch

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



264
265
266
267
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb', line 264

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

#to_s ⇒ Object

Provide a user friendly representation



257
258
259
260
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb', line 257

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

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

Update the WebhookInstance

Parameters:

  • configuration_url (String) (defaults to: :unset)
  • configuration_method (Method) (defaults to: :unset)
  • configuration_filters (Array[String]) (defaults to: :unset)
  • configuration_triggers (Array[String]) (defaults to: :unset)
  • configuration_flow_sid (String) (defaults to: :unset)
  • configuration_retry_count (String) (defaults to: :unset)

Returns:



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb', line 224

def update(
    configuration_url: :unset, 
    configuration_method: :unset, 
    configuration_filters: :unset, 
    configuration_triggers: :unset, 
    configuration_flow_sid: :unset, 
    configuration_retry_count: :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,
        'Configuration.RetryCount' => configuration_retry_count,
    })

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