Class: Twilio::REST::Conversations::V1::ServiceContext::ConversationContext::WebhookInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/conversations/v1/service/conversation/webhook.rb

Instance Method Summary collapse

Constructor Details

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

Initialize the WebhookInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The SID of the Conversation Service the Participant resource is associated with.

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

    The unique ID of the Conversation for this webhook.

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

    A 34 character string that uniquely identifies this resource.


298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/webhook.rb', line 298

def initialize(version, payload, chat_service_sid: nil, conversation_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'chat_service_sid' => payload['chat_service_sid'],
      'conversation_sid' => payload['conversation_sid'],
      'target' => payload['target'],
      '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 = {
      'chat_service_sid' => chat_service_sid,
      'conversation_sid' => conversation_sid,
      'sid' => sid || @properties['sid'],
  }
end

Instance Method Details

#account_sid ⇒ String

Returns The unique ID of the Account responsible for this conversation.

Returns:

  • (String) —

    The unique ID of the Account responsible for this conversation.


347
348
349
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/webhook.rb', line 347

def 
  @properties['account_sid']
end

#chat_service_sid ⇒ String

Returns The SID of the Conversation Service that the resource is associated with.

Returns:

  • (String) —

    The SID of the Conversation Service that the resource is associated with.


353
354
355
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/webhook.rb', line 353

def chat_service_sid
  @properties['chat_service_sid']
end

#configuration ⇒ Hash

Returns The configuration of this webhook.

Returns:

  • (Hash) —

    The configuration of this webhook.


377
378
379
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/webhook.rb', line 377

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:


327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/webhook.rb', line 327

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

#conversation_sid ⇒ String

Returns The unique ID of the Conversation for this webhook.

Returns:

  • (String) —

    The unique ID of the Conversation for this webhook.


359
360
361
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/webhook.rb', line 359

def conversation_sid
  @properties['conversation_sid']
end

#date_created ⇒ Time

Returns The date that this resource was created.

Returns:

  • (Time) —

    The date that this resource was created.


383
384
385
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/webhook.rb', line 383

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this resource was last updated.

Returns:

  • (Time) —

    The date that this resource was last updated.


389
390
391
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/webhook.rb', line 389

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the WebhookInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


419
420
421
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/webhook.rb', line 419

def delete
  context.delete
end

#fetch ⇒ WebhookInstance

Fetch the WebhookInstance

Returns:


426
427
428
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/webhook.rb', line 426

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation


439
440
441
442
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/webhook.rb', line 439

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

#sid ⇒ String

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this resource.


341
342
343
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/webhook.rb', line 341

def sid
  @properties['sid']
end

#target ⇒ String

Returns The target of this webhook.

Returns:

  • (String) —

    The target of this webhook.


365
366
367
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/webhook.rb', line 365

def target
  @properties['target']
end

#to_s ⇒ Object

Provide a user friendly representation


432
433
434
435
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/webhook.rb', line 432

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

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

Update the WebhookInstance

Parameters:

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

    The absolute url the webhook request should be sent to.

  • configuration_method (webhook.Method) (defaults to: :unset) —

    The HTTP method to be used when sending a webhook request.

  • configuration_filters (Array[String]) (defaults to: :unset) —

    The list of events, firing webhook event for this Conversation.

  • configuration_triggers (Array[String]) (defaults to: :unset) —

    The list of keywords, firing webhook event for this Conversation.

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

    The studio flow SID, where the webhook should be sent to.

Returns:


406
407
408
409
410
411
412
413
414
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/webhook.rb', line 406

def update(configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :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,
  )
end

#url ⇒ String

Returns An absolute URL for this webhook.

Returns:

  • (String) —

    An absolute URL for this webhook.


371
372
373
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/webhook.rb', line 371

def url
  @properties['url']
end