class Twilio::REST::IpMessaging::V2::ServiceContext::ChannelContext::WebhookInstance
Public Class Methods
Initialize the WebhookInstance
@param [Version] version Version
that contains the resource @param [Hash] payload payload that contains response from Twilio
@param [String] service_sid
The service_sid
@param [String] channel_sid
The channel_sid
@param [String] sid The sid @return [WebhookInstance] WebhookInstance
Twilio::REST::InstanceResource::new
# File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb 274 def initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil) 275 super(version) 276 277 # Marshaled Properties 278 @properties = { 279 'sid' => payload['sid'], 280 'account_sid' => payload['account_sid'], 281 'service_sid' => payload['service_sid'], 282 'channel_sid' => payload['channel_sid'], 283 'type' => payload['type'], 284 'url' => payload['url'], 285 'configuration' => payload['configuration'], 286 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']), 287 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']), 288 } 289 290 # Context 291 @instance_context = nil 292 @params = { 293 'service_sid' => service_sid, 294 'channel_sid' => channel_sid, 295 'sid' => sid || @properties['sid'], 296 } 297 end
Public Instance Methods
@return [String] The account_sid
# File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb 323 def account_sid 324 @properties['account_sid'] 325 end
@return [String] The channel_sid
# File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb 335 def channel_sid 336 @properties['channel_sid'] 337 end
@return [Hash] The configuration
# File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb 353 def configuration 354 @properties['configuration'] 355 end
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context @return [WebhookContext] WebhookContext
for this WebhookInstance
# File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb 303 def context 304 unless @instance_context 305 @instance_context = WebhookContext.new( 306 @version, 307 @params['service_sid'], 308 @params['channel_sid'], 309 @params['sid'], 310 ) 311 end 312 @instance_context 313 end
@return [Time] The date_created
# File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb 359 def date_created 360 @properties['date_created'] 361 end
@return [Time] The date_updated
# File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb 365 def date_updated 366 @properties['date_updated'] 367 end
Delete the WebhookInstance
@return [Boolean] true if delete succeeds, false otherwise
# File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb 399 def delete 400 context.delete 401 end
Fetch the WebhookInstance
@return [WebhookInstance] Fetched WebhookInstance
# File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb 372 def fetch 373 context.fetch 374 end
Provide a detailed, user friendly representation
# File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb 412 def inspect 413 values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") 414 "<Twilio.IpMessaging.V2.WebhookInstance #{values}>" 415 end
@return [String] The service_sid
# File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb 329 def service_sid 330 @properties['service_sid'] 331 end
@return [String] The sid
# File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb 317 def sid 318 @properties['sid'] 319 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb 405 def to_s 406 values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") 407 "<Twilio.IpMessaging.V2.WebhookInstance #{values}>" 408 end
@return [String] The type
# File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb 341 def type 342 @properties['type'] 343 end
Update the WebhookInstance
@param [String] configuration_url The configuration.url @param [webhook.Method] configuration_method The configuration.method @param [Array] configuration_filters The configuration.filters @param [Array] configuration_triggers The configuration.triggers @param [String] configuration_flow_sid The configuration.flow_sid @param [String] configuration_retry_count The configuration.retry_count @return [WebhookInstance] Updated WebhookInstance
# File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb 385 def update(configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset, configuration_retry_count: :unset) 386 context.update( 387 configuration_url: configuration_url, 388 configuration_method: configuration_method, 389 configuration_filters: configuration_filters, 390 configuration_triggers: configuration_triggers, 391 configuration_flow_sid: configuration_flow_sid, 392 configuration_retry_count: configuration_retry_count, 393 ) 394 end
@return [String] The url
# File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb 347 def url 348 @properties['url'] 349 end