Class: Twilio::REST::IpMessaging::V2::ServiceContext::ChannelInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the ChannelInstance

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

  • sid (String) (defaults to: nil)

    The sid


356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 356

def initialize(version, payload, service_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'service_sid' => payload['service_sid'],
      'friendly_name' => payload['friendly_name'],
      'unique_name' => payload['unique_name'],
      'attributes' => payload['attributes'],
      'type' => payload['type'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'created_by' => payload['created_by'],
      'members_count' => payload['members_count'].to_i,
      'messages_count' => payload['messages_count'].to_i,
      'url' => payload['url'],
      'links' => payload['links'],
  }

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

Instance Method Details

#account_sidString

Returns The account_sid.

Returns:

  • (String)

    The account_sid


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

def 
  @properties['account_sid']
end

#attributesString

Returns The attributes.

Returns:

  • (String)

    The attributes


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

def attributes
  @properties['attributes']
end

#contextChannelContext

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

Returns:


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

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

#created_byString

Returns The created_by.

Returns:

  • (String)

    The created_by


449
450
451
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 449

def created_by
  @properties['created_by']
end

#date_createdTime

Returns The date_created.

Returns:

  • (Time)

    The date_created


437
438
439
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 437

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The date_updated.

Returns:

  • (Time)

    The date_updated


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

def date_updated
  @properties['date_updated']
end

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the ChannelInstance

Parameters:

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

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


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

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

#fetchChannelInstance

Fetch the ChannelInstance

Returns:


480
481
482
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 480

def fetch
  context.fetch
end

#friendly_nameString

Returns The friendly_name.

Returns:

  • (String)

    The friendly_name


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

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation


553
554
555
556
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 553

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

#invitesinvites

Access the invites

Returns:


533
534
535
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 533

def invites
  context.invites
end

Returns The links.

Returns:

  • (String)

    The links


473
474
475
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 473

def links
  @properties['links']
end

#membersmembers

Access the members

Returns:


519
520
521
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 519

def members
  context.members
end

#members_countString

Returns The members_count.

Returns:

  • (String)

    The members_count


455
456
457
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 455

def members_count
  @properties['members_count']
end

#messagesmessages

Access the messages

Returns:


526
527
528
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 526

def messages
  context.messages
end

#messages_countString

Returns The messages_count.

Returns:

  • (String)

    The messages_count


461
462
463
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 461

def messages_count
  @properties['messages_count']
end

#service_sidString

Returns The service_sid.

Returns:

  • (String)

    The service_sid


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

def service_sid
  @properties['service_sid']
end

#sidString

Returns The sid.

Returns:

  • (String)

    The sid


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

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation


546
547
548
549
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 546

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

#typechannel.ChannelType

Returns The type.

Returns:

  • (channel.ChannelType)

    The type


431
432
433
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 431

def type
  @properties['type']
end

#unique_nameString

Returns The unique_name.

Returns:

  • (String)

    The unique_name


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

def unique_name
  @properties['unique_name']
end

#update(friendly_name: :unset, unique_name: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, created_by: :unset, x_twilio_webhook_enabled: :unset) ⇒ ChannelInstance

Update the ChannelInstance

Parameters:

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

    The friendly_name

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

    The unique_name

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

    The attributes

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

    The date_created

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

    The date_updated

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

    The created_by

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

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:


504
505
506
507
508
509
510
511
512
513
514
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 504

def update(friendly_name: :unset, unique_name: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, created_by: :unset, x_twilio_webhook_enabled: :unset)
  context.update(
      friendly_name: friendly_name,
      unique_name: unique_name,
      attributes: attributes,
      date_created: date_created,
      date_updated: date_updated,
      created_by: created_by,
      x_twilio_webhook_enabled: x_twilio_webhook_enabled,
  )
end

#urlString

Returns The url.

Returns:

  • (String)

    The url


467
468
469
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 467

def url
  @properties['url']
end

#webhookswebhooks

Access the webhooks

Returns:


540
541
542
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 540

def webhooks
  context.webhooks
end