Class: Twilio::REST::Conversations::V1::ConversationInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Conversations::V1::ConversationInstance
- Defined in:
- lib/twilio-ruby/rest/conversations/v1/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, 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/messaging/api/service-resource) 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, bindings_email_address: :unset, bindings_email_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, sid: nil) ⇒ ConversationInstance
Initialize the ConversationInstance
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 403 def initialize(version, payload , 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 = { '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.
442 443 444 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 442 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.
478 479 480 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 478 def attributes @properties['attributes'] end |
#bindings ⇒ Hash
520 521 522 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 520 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.
448 449 450 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 448 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
433 434 435 436 437 438 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 433 def context unless @instance_context @instance_context = ConversationContext.new(@version , @params['sid']) end @instance_context end |
#date_created ⇒ Time
Returns The date that this resource was created.
490 491 492 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 490 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
Returns The date that this resource was last updated.
496 497 498 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 496 def date_updated @properties['date_updated'] end |
#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean
Delete the ConversationInstance
528 529 530 531 532 533 534 535 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 528 def delete( x_twilio_webhook_enabled: :unset ) context.delete( x_twilio_webhook_enabled: x_twilio_webhook_enabled, ) end |
#fetch ⇒ ConversationInstance
Fetch the ConversationInstance
540 541 542 543 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 540 def fetch context.fetch end |
#friendly_name ⇒ String
Returns The human-readable name of this conversation, limited to 256 characters. Optional.
466 467 468 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 466 def friendly_name @properties['friendly_name'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
621 622 623 624 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 621 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.
514 515 516 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 514 def links @properties['links'] end |
#messages ⇒ messages
Access the messages
601 602 603 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 601 def context. end |
#messaging_service_sid ⇒ String
Returns The unique ID of the [Messaging Service](www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to.
454 455 456 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 454 def messaging_service_sid @properties['messaging_service_sid'] end |
#participants ⇒ participants
Access the participants
608 609 610 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 608 def participants context.participants end |
#sid ⇒ String
Returns A 34 character string that uniquely identifies this resource.
460 461 462 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 460 def sid @properties['sid'] end |
#state ⇒ State
484 485 486 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 484 def state @properties['state'] end |
#timers ⇒ Hash
Returns Timer date values representing state update for this conversation.
502 503 504 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 502 def timers @properties['timers'] end |
#to_s ⇒ Object
Provide a user friendly representation
614 615 616 617 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 614 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.
472 473 474 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 472 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, bindings_email_address: :unset, bindings_email_name: :unset, x_twilio_webhook_enabled: :unset) ⇒ ConversationInstance
Update the ConversationInstance
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 560 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, bindings_email_address: :unset, bindings_email_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, bindings_email_address: bindings_email_address, bindings_email_name: bindings_email_name, x_twilio_webhook_enabled: x_twilio_webhook_enabled, ) end |
#url ⇒ String
Returns An absolute API resource URL for this conversation.
508 509 510 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 508 def url @properties['url'] end |
#webhooks ⇒ webhooks
Access the webhooks
594 595 596 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 594 def webhooks context.webhooks end |