Class: Twilio::REST::IpMessaging::V2::ServiceContext::ChannelContext::MemberInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the MemberInstance

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

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

    The SID of the Call resource to fetch.



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 628

def initialize(version, payload , service_sid: nil, channel_sid: nil, sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'channel_sid' => payload['channel_sid'],
        'service_sid' => payload['service_sid'],
        'identity' => payload['identity'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'role_sid' => payload['role_sid'],
        'last_consumed_message_index' => payload['last_consumed_message_index'] == nil ? payload['last_consumed_message_index'] : payload['last_consumed_message_index'].to_i,
        'last_consumption_timestamp' => Twilio.deserialize_iso8601_datetime(payload['last_consumption_timestamp']),
        'url' => payload['url'],
        'attributes' => payload['attributes'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns:

  • (String) 


672
673
674
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 672

def 
    @properties['account_sid']
end

#attributes ⇒ String

Returns:

  • (String) 


732
733
734
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 732

def attributes
    @properties['attributes']
end

#channel_sid ⇒ String

Returns:

  • (String) 


678
679
680
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 678

def channel_sid
    @properties['channel_sid']
end

#context ⇒ MemberContext

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

Returns:



657
658
659
660
661
662
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 657

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

#date_created ⇒ Time

Returns:

  • (Time) 


696
697
698
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 696

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns:

  • (Time) 


702
703
704
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 702

def date_updated
    @properties['date_updated']
end

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the MemberInstance

Parameters:

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

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



740
741
742
743
744
745
746
747
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 740

def delete(
    x_twilio_webhook_enabled: :unset
)

    context.delete(
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#fetch ⇒ MemberInstance

Fetch the MemberInstance

Returns:



752
753
754
755
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 752

def fetch

    context.fetch
end

#identity ⇒ String

Returns:

  • (String) 


690
691
692
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 690

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



797
798
799
800
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 797

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

#last_consumed_message_index ⇒ String

Returns:

  • (String) 


714
715
716
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 714

def last_consumed_message_index
    @properties['last_consumed_message_index']
end

#last_consumption_timestamp ⇒ Time

Returns:

  • (Time) 


720
721
722
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 720

def last_consumption_timestamp
    @properties['last_consumption_timestamp']
end

#role_sid ⇒ String

Returns:

  • (String) 


708
709
710
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 708

def role_sid
    @properties['role_sid']
end

#service_sid ⇒ String

Returns:

  • (String) 


684
685
686
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 684

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns:

  • (String) 


666
667
668
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 666

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



790
791
792
793
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 790

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

#update(role_sid: :unset, last_consumed_message_index: :unset, last_consumption_timestamp: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, x_twilio_webhook_enabled: :unset) ⇒ MemberInstance

Update the MemberInstance

Parameters:

  • role_sid (String) (defaults to: :unset)
  • last_consumed_message_index (String) (defaults to: :unset)
  • last_consumption_timestamp (Time) (defaults to: :unset)
  • date_created (Time) (defaults to: :unset)
  • date_updated (Time) (defaults to: :unset)
  • attributes (String) (defaults to: :unset)
  • x_twilio_webhook_enabled (MemberEnumWebhookEnabledType) (defaults to: :unset) —

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:



767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 767

def update(
    role_sid: :unset, 
    last_consumed_message_index: :unset, 
    last_consumption_timestamp: :unset, 
    date_created: :unset, 
    date_updated: :unset, 
    attributes: :unset, 
    x_twilio_webhook_enabled: :unset
)

    context.update(
        role_sid: role_sid, 
        last_consumed_message_index: last_consumed_message_index, 
        last_consumption_timestamp: last_consumption_timestamp, 
        date_created: date_created, 
        date_updated: date_updated, 
        attributes: attributes, 
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#url ⇒ String

Returns:

  • (String) 


726
727
728
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 726

def url
    @properties['url']
end