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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, 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.



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 374

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.

Returns:



413
414
415
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 413

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.



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

def attributes
    @properties['attributes']
end

#bindings ⇒ Hash

Returns:

  • (Hash) 


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

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:



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

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:



404
405
406
407
408
409
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 404

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.

Returns:

  • (Time) —

    The date that this resource was created.



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

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.



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

def date_updated
    @properties['date_updated']
end

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the ConversationInstance

Parameters:

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

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



499
500
501
502
503
504
505
506
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 499

def delete(
    x_twilio_webhook_enabled: :unset
)

    context.delete(
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#fetch ⇒ ConversationInstance

Fetch the ConversationInstance

Returns:



511
512
513
514
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 511

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.



437
438
439
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 437

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



586
587
588
589
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 586

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:



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

def links
    @properties['links']
end

#messages ⇒ messages

Access the messages

Returns:



566
567
568
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 566

def messages
    context.messages
end

#messaging_service_sid ⇒ String

Returns The unique ID of the [Messaging Service](www.twilio.com/docs/sms/services/api) this conversation belongs to.

Returns:



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

def messaging_service_sid
    @properties['messaging_service_sid']
end

#participants ⇒ participants

Access the participants

Returns:



573
574
575
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 573

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.



431
432
433
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 431

def sid
    @properties['sid']
end

#state ⇒ State

Returns:

  • (State) 


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

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.



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

def timers
    @properties['timers']
end

#to_s ⇒ Object

Provide a user friendly representation



579
580
581
582
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 579

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.



443
444
445
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 443

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

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/sms/services/api) 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.

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

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:



529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 529

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.

Returns:

  • (String) —

    An absolute API resource URL for this conversation.



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

def url
    @properties['url']
end

#webhooks ⇒ webhooks

Access the webhooks

Returns:



559
560
561
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 559

def webhooks
    context.webhooks
end