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

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

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

Instance Method Summary collapse

Constructor Details

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

Initialize the WebhookInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The SID of the [Assistant](www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource.

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

    The Twilio-provided string that uniquely identifies the Webhook resource to fetch.



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb', line 291

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, 'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



332
333
334
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb', line 332

def 
  @properties['account_sid']
end

#assistant_sid ⇒ String

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

Returns:

  • (String) —

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



350
351
352
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb', line 350

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:



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

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

#date_created ⇒ Time

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

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT when the resource was created



338
339
340
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb', line 338

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

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

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT when the resource was last updated



344
345
346
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb', line 344

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the WebhookInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#events ⇒ String

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

Returns:

  • (String) —

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



368
369
370
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb', line 368

def events
  @properties['events']
end

#fetch ⇒ WebhookInstance

Fetch a WebhookInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



428
429
430
431
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb', line 428

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

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



356
357
358
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb', line 356

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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.

Returns:

  • (String) —

    An application-defined string that uniquely identifies the resource



362
363
364
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb', line 362

def unique_name
  @properties['unique_name']
end

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

Update the WebhookInstance

Parameters:

  • unique_name (String) (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.

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

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

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

    The URL associated with this Webhook.

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

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

Returns:



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

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:

  • (String) —

    The absolute URL of the Webhook resource



326
327
328
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb', line 326

def url
  @properties['url']
end

#webhook_method ⇒ String

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

Returns:

  • (String) —

    The method used when calling the webhook’s URL.



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

def webhook_method
  @properties['webhook_method']
end

#webhook_url ⇒ String

Returns The URL associated with this Webhook.

Returns:

  • (String) —

    The URL associated with this Webhook.



374
375
376
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/webhook.rb', line 374

def webhook_url
  @properties['webhook_url']
end