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



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 347

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 



386
387
388
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 386

def 
  @properties['account_sid']
end

#attributes ⇒ String 



422
423
424
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 422

def attributes
  @properties['attributes']
end

#bindings ⇒ Hash 



464
465
466
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 464

def bindings
  @properties['bindings']
end

#chat_service_sid ⇒ String 



392
393
394
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 392

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



377
378
379
380
381
382
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 377

def context
  unless @instance_context
    @instance_context = ConversationContext.new(@version, @params['sid'], )
  end
  @instance_context
end

#date_created ⇒ Time 



434
435
436
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 434

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
  @properties['date_updated']
end

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the ConversationInstance



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

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

#fetch ⇒ ConversationInstance

Fetch the ConversationInstance



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

def fetch
  context.fetch
end

#friendly_name ⇒ String 



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



554
555
556
557
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 554

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

#links ⇒ String 



458
459
460
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 458

def links
  @properties['links']
end

#messages ⇒ messages

Access the messages



534
535
536
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 534

def messages
  context.messages
end

#messaging_service_sid ⇒ String 



398
399
400
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 398

def messaging_service_sid
  @properties['messaging_service_sid']
end

#participants ⇒ participants

Access the participants



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

def participants
  context.participants
end

#sid ⇒ String 



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

def sid
  @properties['sid']
end

#state ⇒ conversation.State 



428
429
430
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 428

def state
  @properties['state']
end

#timers ⇒ Hash 



446
447
448
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 446

def timers
  @properties['timers']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#unique_name ⇒ String 



416
417
418
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 416

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



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

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 



452
453
454
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 452

def url
  @properties['url']
end

#webhooks ⇒ webhooks

Access the webhooks



541
542
543
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 541

def webhooks
  context.webhooks
end