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.



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

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) 


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

def 
    @properties['account_sid']
end

#attributes ⇒ String

Returns:

  • (String) 


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

def attributes
    @properties['attributes']
end

#channel_sid ⇒ String

Returns:

  • (String) 


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

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:



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

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) 


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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns:

  • (Time) 


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

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



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

def delete(
    x_twilio_webhook_enabled: :unset
)

    context.delete(
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#fetch ⇒ MemberInstance

Fetch the MemberInstance

Returns:



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

def fetch

    context.fetch
end

#identity ⇒ String

Returns:

  • (String) 


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

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#last_consumed_message_index ⇒ String

Returns:

  • (String) 


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

def last_consumed_message_index
    @properties['last_consumed_message_index']
end

#last_consumption_timestamp ⇒ Time

Returns:

  • (Time) 


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

def last_consumption_timestamp
    @properties['last_consumption_timestamp']
end

#role_sid ⇒ String

Returns:

  • (String) 


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

def role_sid
    @properties['role_sid']
end

#service_sid ⇒ String

Returns:

  • (String) 


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

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns:

  • (String) 


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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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:



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

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) 


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

def url
    @properties['url']
end