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

  • service_sid (String) (defaults to: nil)

    The service_sid

  • channel_sid (String) (defaults to: nil)

    The channel_sid

  • sid (String) (defaults to: nil)

    The sid


288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 288

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,
      'channel_sid' => channel_sid,
      'sid' => sid || @properties['sid'],
  }
end

Instance Method Details

#account_sidString

Returns The account_sid.

Returns:

  • (String)

    The account_sid


340
341
342
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 340

def 
  @properties['account_sid']
end

#attributesString

Returns The attributes.

Returns:

  • (String)

    The attributes


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

def attributes
  @properties['attributes']
end

#channel_sidString

Returns The channel_sid.

Returns:

  • (String)

    The channel_sid


346
347
348
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 346

def channel_sid
  @properties['channel_sid']
end

#contextMemberContext

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

Returns:


320
321
322
323
324
325
326
327
328
329
330
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 320

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

#date_createdTime

Returns The date_created.

Returns:

  • (Time)

    The date_created


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

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The date_updated.

Returns:

  • (Time)

    The date_updated


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

def date_updated
  @properties['date_updated']
end

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the MemberInstance

Parameters:

  • x_twilio_webhook_enabled (member.WebhookEnabledType) (defaults to: :unset)

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


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

def delete(x_twilio_webhook_enabled: :unset)
  context.delete(x_twilio_webhook_enabled: x_twilio_webhook_enabled, )
end

#fetchMemberInstance

Fetch the MemberInstance

Returns:


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

def fetch
  context.fetch
end

#identityString

Returns The identity.

Returns:

  • (String)

    The identity


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

def identity
  @properties['identity']
end

#inspectObject

Provide a detailed, user friendly representation


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

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

#last_consumed_message_indexString

Returns The last_consumed_message_index.

Returns:

  • (String)

    The last_consumed_message_index


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

def last_consumed_message_index
  @properties['last_consumed_message_index']
end

#last_consumption_timestampTime

Returns The last_consumption_timestamp.

Returns:

  • (Time)

    The last_consumption_timestamp


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

def last_consumption_timestamp
  @properties['last_consumption_timestamp']
end

#role_sidString

Returns The role_sid.

Returns:

  • (String)

    The role_sid


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

def role_sid
  @properties['role_sid']
end

#service_sidString

Returns The service_sid.

Returns:

  • (String)

    The service_sid


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

def service_sid
  @properties['service_sid']
end

#sidString

Returns The sid.

Returns:

  • (String)

    The sid


334
335
336
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 334

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation


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

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)

    The role_sid

  • last_consumed_message_index (String) (defaults to: :unset)

    The last_consumed_message_index

  • last_consumption_timestamp (Time) (defaults to: :unset)

    The last_consumption_timestamp

  • date_created (Time) (defaults to: :unset)

    The date_created

  • date_updated (Time) (defaults to: :unset)

    The date_updated

  • attributes (String) (defaults to: :unset)

    The attributes

  • x_twilio_webhook_enabled (member.WebhookEnabledType) (defaults to: :unset)

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:


431
432
433
434
435
436
437
438
439
440
441
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 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)
  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

#urlString

Returns The url.

Returns:

  • (String)

    The url


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

def url
  @properties['url']
end