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

Public Class Methods

new(version, payload, service_sid: nil, channel_sid: nil, sid: nil) click to toggle source

Initialize the MemberInstance @param [Version] version Version that contains the resource @param [Hash] payload payload that contains response from Twilio @param [String] service_sid The service_sid @param [String] channel_sid The channel_sid @param [String] sid The sid @return [MemberInstance] MemberInstance

Calls superclass method Twilio::REST::InstanceResource::new
    # File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb
288 def initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil)
289   super(version)
290 
291   # Marshaled Properties
292   @properties = {
293       'sid' => payload['sid'],
294       'account_sid' => payload['account_sid'],
295       'channel_sid' => payload['channel_sid'],
296       'service_sid' => payload['service_sid'],
297       'identity' => payload['identity'],
298       'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
299       'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
300       'role_sid' => payload['role_sid'],
301       'last_consumed_message_index' => payload['last_consumed_message_index'] == nil ? payload['last_consumed_message_index'] : payload['last_consumed_message_index'].to_i,
302       'last_consumption_timestamp' => Twilio.deserialize_iso8601_datetime(payload['last_consumption_timestamp']),
303       'url' => payload['url'],
304       'attributes' => payload['attributes'],
305   }
306 
307   # Context
308   @instance_context = nil
309   @params = {
310       'service_sid' => service_sid,
311       'channel_sid' => channel_sid,
312       'sid' => sid || @properties['sid'],
313   }
314 end

Public Instance Methods

account_sid() click to toggle source

@return [String] The account_sid

    # File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb
340 def account_sid
341   @properties['account_sid']
342 end
attributes() click to toggle source

@return [String] The attributes

    # File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb
400 def attributes
401   @properties['attributes']
402 end
channel_sid() click to toggle source

@return [String] The channel_sid

    # File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb
346 def channel_sid
347   @properties['channel_sid']
348 end
context() click to toggle source

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context @return [MemberContext] MemberContext for this MemberInstance

    # File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb
320 def context
321   unless @instance_context
322     @instance_context = MemberContext.new(
323         @version,
324         @params['service_sid'],
325         @params['channel_sid'],
326         @params['sid'],
327     )
328   end
329   @instance_context
330 end
date_created() click to toggle source

@return [Time] The date_created

    # File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb
364 def date_created
365   @properties['date_created']
366 end
date_updated() click to toggle source

@return [Time] The date_updated

    # File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb
370 def date_updated
371   @properties['date_updated']
372 end
delete(x_twilio_webhook_enabled: :unset) click to toggle source

Delete the MemberInstance @param [member.WebhookEnabledType] x_twilio_webhook_enabled The

X-Twilio-Webhook-Enabled HTTP request header

@return [Boolean] true if delete succeeds, false otherwise

    # File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb
416 def delete(x_twilio_webhook_enabled: :unset)
417   context.delete(x_twilio_webhook_enabled: x_twilio_webhook_enabled, )
418 end
fetch() click to toggle source

Fetch the MemberInstance @return [MemberInstance] Fetched MemberInstance

    # File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb
407 def fetch
408   context.fetch
409 end
identity() click to toggle source

@return [String] The identity

    # File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb
358 def identity
359   @properties['identity']
360 end
inspect() click to toggle source

Provide a detailed, user friendly representation

    # File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb
452 def inspect
453   values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
454   "<Twilio.IpMessaging.V2.MemberInstance #{values}>"
455 end
last_consumed_message_index() click to toggle source

@return [String] The last_consumed_message_index

    # File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb
382 def last_consumed_message_index
383   @properties['last_consumed_message_index']
384 end
last_consumption_timestamp() click to toggle source

@return [Time] The last_consumption_timestamp

    # File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb
388 def last_consumption_timestamp
389   @properties['last_consumption_timestamp']
390 end
role_sid() click to toggle source

@return [String] The role_sid

    # File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb
376 def role_sid
377   @properties['role_sid']
378 end
service_sid() click to toggle source

@return [String] The service_sid

    # File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb
352 def service_sid
353   @properties['service_sid']
354 end
sid() click to toggle source

@return [String] The sid

    # File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb
334 def sid
335   @properties['sid']
336 end
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb
445 def to_s
446   values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
447   "<Twilio.IpMessaging.V2.MemberInstance #{values}>"
448 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) click to toggle source

Update the MemberInstance @param [String] role_sid The role_sid @param [String] last_consumed_message_index The last_consumed_message_index @param [Time] last_consumption_timestamp The last_consumption_timestamp @param [Time] date_created The date_created @param [Time] date_updated The date_updated @param [String] attributes The attributes @param [member.WebhookEnabledType] x_twilio_webhook_enabled The

X-Twilio-Webhook-Enabled HTTP request header

@return [MemberInstance] Updated MemberInstance

    # File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb
431 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)
432   context.update(
433       role_sid: role_sid,
434       last_consumed_message_index: last_consumed_message_index,
435       last_consumption_timestamp: last_consumption_timestamp,
436       date_created: date_created,
437       date_updated: date_updated,
438       attributes: attributes,
439       x_twilio_webhook_enabled: x_twilio_webhook_enabled,
440   )
441 end
url() click to toggle source

@return [String] The url

    # File lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb
394 def url
395   @properties['url']
396 end