Class: Twilio::REST::Autopilot::V1::AssistantContext::WebhookInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb

Instance Method Summary collapse

Constructor Details

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

Initialize the WebhookInstance

Parameters:

  • Version that contains the resource

  • payload that contains response from Twilio

  • The SID of the Account that created this Webhook resource.

  • (defaults to: nil)

    The SID of the Call resource to fetch.



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb', line 282

def initialize(version, payload , assistant_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'url' => payload['url'],
        'account_sid' => payload['account_sid'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'assistant_sid' => payload['assistant_sid'],
        'sid' => payload['sid'],
        'unique_name' => payload['unique_name'],
        'events' => payload['events'],
        'webhook_url' => payload['webhook_url'],
        'webhook_method' => payload['webhook_method'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the Webhook resource.

Returns:

  • The SID of the Account that created the Webhook resource.



323
324
325
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb', line 323

def 
    @properties['account_sid']
end

#assistant_sid ⇒ String

Returns The SID of the Assistant that is the parent of the resource.

Returns:

  • The SID of the Assistant that is the parent of the resource.



341
342
343
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb', line 341

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

  • CallContext for this CallInstance



308
309
310
311
312
313
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb', line 308

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

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in RFC 2822 format.

Returns:

  • The date and time in GMT when the resource was created specified in RFC 2822 format.



329
330
331
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb', line 329

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in RFC 2822 format.

Returns:

  • The date and time in GMT when the resource was last updated specified in RFC 2822 format.



335
336
337
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb', line 335

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the WebhookInstance

Returns:

  • True if delete succeeds, false otherwise



378
379
380
381
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb', line 378

def delete

    context.delete
end

#events ⇒ String

Returns The list of space-separated events that this Webhook is subscribed to.

Returns:

  • The list of space-separated events that this Webhook is subscribed to.



359
360
361
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb', line 359

def events
    @properties['events']
end

#fetch ⇒ WebhookInstance

Fetch the WebhookInstance

Returns:

  • Fetched WebhookInstance



386
387
388
389
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb', line 386

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



422
423
424
425
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb', line 422

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

#sid ⇒ String

Returns The unique string that we created to identify the Webhook resource.

Returns:

  • The unique string that we created to identify the Webhook resource.



347
348
349
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb', line 347

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



415
416
417
418
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb', line 415

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

#unique_name ⇒ String

Returns An application-defined string that uniquely identifies the resource. It can be used in place of the resource's sid in the URL to address the resource.

Returns:

  • An application-defined string that uniquely identifies the resource. It can be used in place of the resource's sid in the URL to address the resource.



353
354
355
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb', line 353

def unique_name
    @properties['unique_name']
end

#update(unique_name: :unset, events: :unset, webhook_url: :unset, webhook_method: :unset) ⇒ WebhookInstance

Update the WebhookInstance

Parameters:

  • (defaults to: :unset)

    An application-defined string that uniquely identifies the new resource. It can be used as an alternative to the sid in the URL path to address the resource. This value must be unique and 64 characters or less in length.

  • (defaults to: :unset)

    The list of space-separated events that this Webhook will subscribe to.

  • (defaults to: :unset)

    The URL associated with this Webhook.

  • (defaults to: :unset)

    The method to be used when calling the webhook's URL.

Returns:

  • Updated WebhookInstance



398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb', line 398

def update(
    unique_name: :unset, 
    events: :unset, 
    webhook_url: :unset, 
    webhook_method: :unset
)

    context.update(
        unique_name: unique_name, 
        events: events, 
        webhook_url: webhook_url, 
        webhook_method: webhook_method, 
    )
end

#url ⇒ String

Returns The absolute URL of the Webhook resource.

Returns:

  • The absolute URL of the Webhook resource.



317
318
319
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb', line 317

def url
    @properties['url']
end

#webhook_method ⇒ String

Returns The method used when calling the webhook's URL.

Returns:

  • The method used when calling the webhook's URL.



371
372
373
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb', line 371

def webhook_method
    @properties['webhook_method']
end

#webhook_url ⇒ String

Returns The URL associated with this Webhook.

Returns:

  • The URL associated with this Webhook.



365
366
367
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb', line 365

def webhook_url
    @properties['webhook_url']
end