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



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 322

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 



365
366
367
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 365

def 
    @properties['account_sid']
end

#attributes ⇒ String 



425
426
427
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 425

def attributes
    @properties['attributes']
end

#channel_sid ⇒ String 



371
372
373
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 371

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



350
351
352
353
354
355
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 350

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 



389
390
391
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 389

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



395
396
397
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 395

def date_updated
    @properties['date_updated']
end

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the MemberInstance



433
434
435
436
437
438
439
440
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 433

def delete(
    x_twilio_webhook_enabled: :unset
)

    context.delete(
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#fetch ⇒ MemberInstance

Fetch the MemberInstance



445
446
447
448
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 445

def fetch

    context.fetch
end

#identity ⇒ String 



383
384
385
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 383

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#last_consumed_message_index ⇒ String 



407
408
409
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 407

def last_consumed_message_index
    @properties['last_consumed_message_index']
end

#last_consumption_timestamp ⇒ Time 



413
414
415
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 413

def last_consumption_timestamp
    @properties['last_consumption_timestamp']
end

#role_sid ⇒ String 



401
402
403
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 401

def role_sid
    @properties['role_sid']
end

#service_sid ⇒ String 



377
378
379
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 377

def service_sid
    @properties['service_sid']
end

#sid ⇒ String 



359
360
361
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 359

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 460

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 



419
420
421
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 419

def url
    @properties['url']
end