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

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

    The unique ID of the Conversation Service this conversation belongs to.

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

    A 34 character string that uniquely identifies this resource. Can also be the `unique_name` of the Conversation.


379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 379

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, '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.


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

def 
  @properties['account_sid']
end

#attributes ⇒ String

Returns An optional string metadata field you can use to store any data you wish.

Returns:

  • (String) —

    An optional string metadata field you can use to store any data you wish.


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

def attributes
  @properties['attributes']
end

#bindings ⇒ Hash

Returns The bindings.

Returns:

  • (Hash) —

    The bindings


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

def bindings
  @properties['bindings']
end

#chat_service_sid ⇒ String

Returns The unique ID of the Conversation Service this conversation belongs to.

Returns:

  • (String) —

    The unique ID of the Conversation Service this conversation belongs to.


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

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:


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

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.


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

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.


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

def date_updated
  @properties['date_updated']
end

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the ConversationInstance

Parameters:

  • x_twilio_webhook_enabled (conversation.WebhookEnabledType) (defaults to: :unset) —

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


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

def delete(x_twilio_webhook_enabled: :unset)
  context.delete(x_twilio_webhook_enabled: x_twilio_webhook_enabled, )
end

#fetch ⇒ ConversationInstance

Fetch the ConversationInstance

Returns:


552
553
554
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 552

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The human-readable name of this conversation.

Returns:

  • (String) —

    The human-readable name of this conversation.


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

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/service/conversation.rb', line 586

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

#links ⇒ String

Returns Absolute URLs to access the participants, messages and webhooks of this conversation.

Returns:

  • (String) —

    Absolute URLs to access the participants, messages and webhooks of this conversation.


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

def links
  @properties['links']
end

#messages ⇒ messages

Access the messages

Returns:


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

def messages
  context.messages
end

#messaging_service_sid ⇒ String

Returns The unique ID of the Messaging Service this conversation belongs to.

Returns:

  • (String) —

    The unique ID of the Messaging Service this conversation belongs to.


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

def messaging_service_sid
  @properties['messaging_service_sid']
end

#participants ⇒ participants

Access the participants

Returns:


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

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.


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

def sid
  @properties['sid']
end

#state ⇒ conversation.State

Returns Current state of this conversation.

Returns:

  • (conversation.State) —

    Current state of this conversation.


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

def state
  @properties['state']
end

#timers ⇒ Hash

Returns Timer date values for this conversation.

Returns:

  • (Hash) —

    Timer date values for this conversation.


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

def timers
  @properties['timers']
end

#to_s ⇒ Object

Provide a user friendly representation


579
580
581
582
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/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.

Returns:

  • (String) —

    An application-defined string that uniquely identifies the resource


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

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 this conversation belongs to.

  • state (conversation.State) (defaults to: :unset) —

    Current state of this conversation. Can be either `active`, `inactive` or `closed` and defaults to `active`

  • 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 (conversation.WebhookEnabledType) (defaults to: :unset) —

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:


525
526
527
528
529
530
531
532
533
534
535
536
537
538
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 525

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 URL for this conversation.

Returns:

  • (String) —

    An absolute URL for this conversation.


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

def url
  @properties['url']
end

#webhooks ⇒ webhooks

Access the webhooks

Returns:


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

def webhooks
  context.webhooks
end