Class: Twilio::REST::IpMessaging::V2::ServiceContext::ChannelInstance

Inherits:
Twilio::REST::InstanceResource show all
Defined in:
lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, sid: nil) ⇒ ChannelInstance

Initialize the ChannelInstance

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 Channel resource.

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

    The SID of the Call resource to fetch.



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 397

def initialize(version, payload , service_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'service_sid' => payload['service_sid'],
        'friendly_name' => payload['friendly_name'],
        'unique_name' => payload['unique_name'],
        'attributes' => payload['attributes'],
        'type' => payload['type'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'created_by' => payload['created_by'],
        'members_count' => payload['members_count'] == nil ? payload['members_count'] : payload['members_count'].to_i,
        'messages_count' => payload['messages_count'] == nil ? payload['messages_count'] : payload['messages_count'].to_i,
        'url' => payload['url'],
        'links' => payload['links'],
    }

    # Context
    @instance_context = nil
    @params = { 'service_sid' => service_sid  || @properties['service_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns:

  • (String) 


442
443
444
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 442

def 
    @properties['account_sid']
end

#attributes ⇒ String

Returns:

  • (String) 


466
467
468
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 466

def attributes
    @properties['attributes']
end

#context ⇒ ChannelContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



427
428
429
430
431
432
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 427

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

#created_by ⇒ String

Returns:

  • (String) 


490
491
492
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 490

def created_by
    @properties['created_by']
end

#date_created ⇒ Time

Returns:

  • (Time) 


478
479
480
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 478

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns:

  • (Time) 


484
485
486
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 484

def date_updated
    @properties['date_updated']
end

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the ChannelInstance

Parameters:

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

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



522
523
524
525
526
527
528
529
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 522

def delete(
    x_twilio_webhook_enabled: :unset
)

    context.delete(
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#fetch ⇒ ChannelInstance

Fetch the ChannelInstance

Returns:



534
535
536
537
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 534

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns:

  • (String) 


454
455
456
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 454

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



607
608
609
610
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 607

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

#invites ⇒ invites

Access the invites

Returns:



594
595
596
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 594

def invites
    context.invites
end

#links ⇒ Hash

Returns:

  • (Hash) 


514
515
516
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 514

def links
    @properties['links']
end

#members ⇒ members

Access the members

Returns:



580
581
582
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 580

def members
    context.members
end

#members_count ⇒ String

Returns:

  • (String) 


496
497
498
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 496

def members_count
    @properties['members_count']
end

#messages ⇒ messages

Access the messages

Returns:



587
588
589
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 587

def messages
    context.messages
end

#messages_count ⇒ String

Returns:

  • (String) 


502
503
504
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 502

def messages_count
    @properties['messages_count']
end

#service_sid ⇒ String

Returns:

  • (String) 


448
449
450
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 448

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns:

  • (String) 


436
437
438
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 436

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



600
601
602
603
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 600

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

#type ⇒ ChannelType

Returns:

  • (ChannelType) 


472
473
474
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 472

def type
    @properties['type']
end

#unique_name ⇒ String

Returns:

  • (String) 


460
461
462
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 460

def unique_name
    @properties['unique_name']
end

#update(friendly_name: :unset, unique_name: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, created_by: :unset, x_twilio_webhook_enabled: :unset) ⇒ ChannelInstance

Update the ChannelInstance

Parameters:

  • friendly_name (String) (defaults to: :unset)
  • unique_name (String) (defaults to: :unset)
  • attributes (String) (defaults to: :unset)
  • date_created (Time) (defaults to: :unset)
  • date_updated (Time) (defaults to: :unset)
  • created_by (String) (defaults to: :unset)
  • x_twilio_webhook_enabled (ChannelEnumWebhookEnabledType) (defaults to: :unset) —

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:



549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 549

def update(
    friendly_name: :unset, 
    unique_name: :unset, 
    attributes: :unset, 
    date_created: :unset, 
    date_updated: :unset, 
    created_by: :unset, 
    x_twilio_webhook_enabled: :unset
)

    context.update(
        friendly_name: friendly_name, 
        unique_name: unique_name, 
        attributes: attributes, 
        date_created: date_created, 
        date_updated: date_updated, 
        created_by: created_by, 
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#url ⇒ String

Returns:

  • (String) 


508
509
510
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 508

def url
    @properties['url']
end

#webhooks ⇒ webhooks

Access the webhooks

Returns:



573
574
575
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 573

def webhooks
    context.webhooks
end