Class: Twilio::REST::Conversations::V1::ServiceContext::ConversationInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Conversations::V1::ServiceContext::ConversationInstance
- Defined in:
- lib/twilio-ruby/rest/conversations/v1/service/conversation.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The unique ID of the [Account](www.twilio.com/docs/iam/api/account) responsible for this conversation.
-
#attributes ⇒ String
An optional string metadata field you can use to store any data you wish.
- #bindings ⇒ Hash
-
#chat_service_sid ⇒ String
The unique ID of the [Conversation Service](www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to.
-
#context ⇒ ConversationContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#date_created ⇒ Time
The date that this resource was created.
-
#date_updated ⇒ Time
The date that this resource was last updated.
-
#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean
Delete the ConversationInstance.
-
#fetch ⇒ ConversationInstance
Fetch the ConversationInstance.
-
#friendly_name ⇒ String
The human-readable name of this conversation, limited to 256 characters.
-
#initialize(version, payload, chat_service_sid: nil, sid: nil) ⇒ ConversationInstance
constructor
Initialize the ConversationInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#links ⇒ Hash
Contains absolute URLs to access the [participants](www.twilio.com/docs/conversations/api/conversation-participant-resource), [messages](www.twilio.com/docs/conversations/api/conversation-message-resource) and [webhooks](www.twilio.com/docs/conversations/api/conversation-scoped-webhook-resource) of this conversation.
-
#messages ⇒ messages
Access the messages.
-
#messaging_service_sid ⇒ String
The unique ID of the [Messaging Service](www.twilio.com/docs/sms/services/api) this conversation belongs to.
-
#participants ⇒ participants
Access the participants.
-
#sid ⇒ String
A 34 character string that uniquely identifies this resource.
- #state ⇒ State
-
#timers ⇒ Hash
Timer date values representing state update for this conversation.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#unique_name ⇒ String
An application-defined string that uniquely identifies the resource.
-
#update(friendly_name: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, messaging_service_sid: :unset, state: :unset, timers_inactive: :unset, timers_closed: :unset, unique_name: :unset, x_twilio_webhook_enabled: :unset) ⇒ ConversationInstance
Update the ConversationInstance.
-
#url ⇒ String
An absolute API resource URL for this conversation.
-
#webhooks ⇒ webhooks
Access the webhooks.
Constructor Details
#initialize(version, payload, chat_service_sid: nil, sid: nil) ⇒ ConversationInstance
Initialize the ConversationInstance
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 380 def initialize(version, payload , chat_service_sid: nil, sid: nil) super(version) # Marshaled Properties @properties = { 'account_sid' => payload['account_sid'], 'chat_service_sid' => payload['chat_service_sid'], 'messaging_service_sid' => payload['messaging_service_sid'], 'sid' => payload['sid'], 'friendly_name' => payload['friendly_name'], 'unique_name' => payload['unique_name'], 'attributes' => payload['attributes'], 'state' => payload['state'], 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']), 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']), 'timers' => payload['timers'], 'url' => payload['url'], 'links' => payload['links'], 'bindings' => payload['bindings'], } # Context @instance_context = nil @params = { 'chat_service_sid' => chat_service_sid || @properties['chat_service_sid'] ,'sid' => sid || @properties['sid'] , } end |
Instance Method Details
#account_sid ⇒ String
Returns The unique ID of the [Account](www.twilio.com/docs/iam/api/account) responsible for this conversation.
419 420 421 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 419 def account_sid @properties['account_sid'] end |
#attributes ⇒ String
Returns An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set "{}" will be returned.
455 456 457 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 455 def attributes @properties['attributes'] end |
#bindings ⇒ Hash
497 498 499 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 497 def bindings @properties['bindings'] end |
#chat_service_sid ⇒ String
Returns The unique ID of the [Conversation Service](www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to.
425 426 427 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 425 def chat_service_sid @properties['chat_service_sid'] end |
#context ⇒ ConversationContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
410 411 412 413 414 415 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 410 def context unless @instance_context @instance_context = ConversationContext.new(@version , @params['chat_service_sid'], @params['sid']) end @instance_context end |
#date_created ⇒ Time
Returns The date that this resource was created.
467 468 469 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 467 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
Returns The date that this resource was last updated.
473 474 475 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 473 def date_updated @properties['date_updated'] end |
#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean
Delete the ConversationInstance
505 506 507 508 509 510 511 512 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 505 def delete( x_twilio_webhook_enabled: :unset ) context.delete( x_twilio_webhook_enabled: x_twilio_webhook_enabled, ) end |
#fetch ⇒ ConversationInstance
Fetch the ConversationInstance
517 518 519 520 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 517 def fetch context.fetch end |
#friendly_name ⇒ String
Returns The human-readable name of this conversation, limited to 256 characters. Optional.
443 444 445 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 443 def friendly_name @properties['friendly_name'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
592 593 594 595 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 592 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Conversations.V1.ConversationInstance #{values}>" end |
#links ⇒ Hash
Returns Contains absolute URLs to access the [participants](www.twilio.com/docs/conversations/api/conversation-participant-resource), [messages](www.twilio.com/docs/conversations/api/conversation-message-resource) and [webhooks](www.twilio.com/docs/conversations/api/conversation-scoped-webhook-resource) of this conversation.
491 492 493 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 491 def links @properties['links'] end |
#messages ⇒ messages
Access the messages
572 573 574 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 572 def context. end |
#messaging_service_sid ⇒ String
Returns The unique ID of the [Messaging Service](www.twilio.com/docs/sms/services/api) this conversation belongs to.
431 432 433 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 431 def messaging_service_sid @properties['messaging_service_sid'] end |
#participants ⇒ participants
Access the participants
565 566 567 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 565 def participants context.participants end |
#sid ⇒ String
Returns A 34 character string that uniquely identifies this resource.
437 438 439 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 437 def sid @properties['sid'] end |
#state ⇒ State
461 462 463 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 461 def state @properties['state'] end |
#timers ⇒ Hash
Returns Timer date values representing state update for this conversation.
479 480 481 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 479 def timers @properties['timers'] end |
#to_s ⇒ Object
Provide a user friendly representation
585 586 587 588 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 585 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Conversations.V1.ConversationInstance #{values}>" end |
#unique_name ⇒ String
Returns An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource’s ‘sid` in the URL.
449 450 451 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 449 def unique_name @properties['unique_name'] end |
#update(friendly_name: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, messaging_service_sid: :unset, state: :unset, timers_inactive: :unset, timers_closed: :unset, unique_name: :unset, x_twilio_webhook_enabled: :unset) ⇒ ConversationInstance
Update the ConversationInstance
535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 535 def update( friendly_name: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, messaging_service_sid: :unset, state: :unset, timers_inactive: :unset, timers_closed: :unset, unique_name: :unset, x_twilio_webhook_enabled: :unset ) context.update( friendly_name: friendly_name, date_created: date_created, date_updated: date_updated, attributes: attributes, messaging_service_sid: messaging_service_sid, state: state, timers_inactive: timers_inactive, timers_closed: timers_closed, unique_name: unique_name, x_twilio_webhook_enabled: x_twilio_webhook_enabled, ) end |
#url ⇒ String
Returns An absolute API resource URL for this conversation.
485 486 487 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 485 def url @properties['url'] end |
#webhooks ⇒ webhooks
Access the webhooks
579 580 581 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 579 def webhooks context.webhooks end |