Class: Twilio::REST::Conversations::V1::ServiceContext::ConversationInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the ConversationInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this Conversation resource.

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

    The SID of the Call resource to fetch.



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 409

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.

Returns:



448
449
450
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 448

def 
    @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.

Returns:

  • (String) —

    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.



484
485
486
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 484

def attributes
    @properties['attributes']
end

#bindings ⇒ Hash

Returns:

  • (Hash) 


526
527
528
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 526

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.

Returns:



454
455
456
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 454

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

Returns:



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

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.

Returns:

  • (Time) —

    The date that this resource was created.



496
497
498
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 496

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.



502
503
504
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 502

def date_updated
    @properties['date_updated']
end

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the ConversationInstance

Parameters:

  • x_twilio_webhook_enabled (ServiceConversationEnumWebhookEnabledType) (defaults to: :unset) —

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



534
535
536
537
538
539
540
541
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 534

def delete(
    x_twilio_webhook_enabled: :unset
)

    context.delete(
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#fetch ⇒ ConversationInstance

Fetch the ConversationInstance

Returns:



546
547
548
549
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 546

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns The human-readable name of this conversation, limited to 256 characters. Optional.

Returns:

  • (String) —

    The human-readable name of this conversation, limited to 256 characters. Optional.



472
473
474
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 472

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



627
628
629
630
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 627

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.

Returns:



520
521
522
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 520

def links
    @properties['links']
end

#messages ⇒ messages

Access the messages

Returns:



607
608
609
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 607

def messages
    context.messages
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.

Returns:



460
461
462
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 460

def messaging_service_sid
    @properties['messaging_service_sid']
end

#participants ⇒ participants

Access the participants

Returns:



600
601
602
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 600

def participants
    context.participants
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this resource.



466
467
468
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 466

def sid
    @properties['sid']
end

#state ⇒ State

Returns:

  • (State) 


490
491
492
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 490

def state
    @properties['state']
end

#timers ⇒ Hash

Returns Timer date values representing state update for this conversation.

Returns:

  • (Hash) —

    Timer date values representing state update for this conversation.



508
509
510
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 508

def timers
    @properties['timers']
end

#to_s ⇒ Object

Provide a user friendly representation



620
621
622
623
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 620

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.

Returns:

  • (String) —

    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.



478
479
480
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 478

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

Parameters:

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

    The human-readable name of this conversation, limited to 256 characters. Optional.

  • date_created (Time) (defaults to: :unset) —

    The date that this resource was created.

  • date_updated (Time) (defaults to: :unset) —

    The date that this resource was last updated.

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

    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.

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

    The unique ID of the [Messaging Service](www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to.

  • state (State) (defaults to: :unset)
  • timers_inactive (String) (defaults to: :unset) —

    ISO8601 duration when conversation will be switched to ‘inactive` state. Minimum value for this timer is 1 minute.

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

    ISO8601 duration when conversation will be switched to ‘closed` state. Minimum value for this timer is 10 minutes.

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

    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.

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

    The default email address that will be used when sending outbound emails in this conversation.

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

    The default name that will be used when sending outbound emails in this conversation.

  • x_twilio_webhook_enabled (ServiceConversationEnumWebhookEnabledType) (defaults to: :unset) —

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:



566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 566

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.

Returns:

  • (String) —

    An absolute API resource URL for this conversation.



514
515
516
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 514

def url
    @properties['url']
end

#webhooks ⇒ webhooks

Access the webhooks

Returns:



614
615
616
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 614

def webhooks
    context.webhooks
end