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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil) ⇒ WebhookInstance

Initialize the WebhookInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this Webhook resource.

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb', line 304

def initialize(version, payload , service_sid: nil, channel_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'service_sid' => payload['service_sid'],
        'channel_sid' => payload['channel_sid'],
        'type' => payload['type'],
        'url' => payload['url'],
        'configuration' => payload['configuration'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
    }

    # Context
    @instance_context = nil
    @params = { 'service_sid' => service_sid  || @properties['service_sid']  ,'channel_sid' => channel_sid  || @properties['channel_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns:

  • (String) 


344
345
346
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb', line 344

def 
    @properties['account_sid']
end

#channel_sid ⇒ String

Returns:

  • (String) 


356
357
358
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb', line 356

def channel_sid
    @properties['channel_sid']
end

#configuration ⇒ Hash

Returns:

  • (Hash) 


374
375
376
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb', line 374

def configuration
    @properties['configuration']
end

#context ⇒ WebhookContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



329
330
331
332
333
334
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb', line 329

def context
    unless @instance_context
        @instance_context = WebhookContext.new(@version , @params['service_sid'], @params['channel_sid'], @params['sid'])
    end
    @instance_context
end

#date_created ⇒ Time

Returns:

  • (Time) 


380
381
382
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb', line 380

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns:

  • (Time) 


386
387
388
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb', line 386

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the WebhookInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



393
394
395
396
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb', line 393

def delete

    context.delete
end

#fetch ⇒ WebhookInstance

Fetch the WebhookInstance

Returns:



401
402
403
404
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb', line 401

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



443
444
445
446
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb', line 443

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.IpMessaging.V2.WebhookInstance #{values}>"
end

#service_sid ⇒ String

Returns:

  • (String) 


350
351
352
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb', line 350

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns:

  • (String) 


338
339
340
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb', line 338

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



436
437
438
439
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb', line 436

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.IpMessaging.V2.WebhookInstance #{values}>"
end

#type ⇒ String

Returns:

  • (String) 


362
363
364
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb', line 362

def type
    @properties['type']
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:



415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb', line 415

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

    context.update(
        configuration_url: configuration_url, 
        configuration_method: configuration_method, 
        configuration_filters: configuration_filters, 
        configuration_triggers: configuration_triggers, 
        configuration_flow_sid: configuration_flow_sid, 
        configuration_retry_count: configuration_retry_count, 
    )
end

#url ⇒ String

Returns:

  • (String) 


368
369
370
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb', line 368

def url
    @properties['url']
end