Class: Twilio::REST::IpMessaging::V2::ServiceInstance

Inherits:

Twilio::REST::InstanceResource

Object
Twilio::REST::InstanceResource
Twilio::REST::IpMessaging::V2::ServiceInstance

show all

Defined in:: lib/twilio-ruby/rest/ip_messaging/v2/service.rb

Instance Method Summary collapse

#account_sid ⇒ String

The unique id of the Account responsible for this service.
#bindings ⇒ bindings

Access the bindings.
#channels ⇒ channels

Access the channels.
#consumption_report_interval ⇒ String

DEPRECATED.
#context ⇒ ServiceContext

Generate an instance context for the instance, the context is capable of performing various actions.
#date_created ⇒ Time

The date that this resource was created.
#date_updated ⇒ Time

The date that this resource was last updated.
#default_channel_creator_role_sid ⇒ String

The channel role assigned to a channel creator when joining a new channel.
#default_channel_role_sid ⇒ String

The channel role assigned to users when they are added to a channel.
#default_service_role_sid ⇒ String

The service role assigned to users when they are added to the service.
#delete ⇒ Boolean

Deletes the ServiceInstance.
#fetch ⇒ ServiceInstance

Fetch a ServiceInstance.
#friendly_name ⇒ String

The human-readable name of this service.
#initialize(version, payload, sid: nil) ⇒ ServiceInstance constructor

Initialize the ServiceInstance.
#inspect ⇒ Object

Provide a detailed, user friendly representation.
#limits ⇒ Hash

Configuration for service instance level limits.
#links ⇒ String

URLs to access the Channels, Roles, and Users for this service.
#media ⇒ Hash

The media.
#notifications ⇒ Hash

Notification configuration for the Service instance.
#post_webhook_retry_count ⇒ String

Count of times webhook will be retried in case of timeout or 429/503/504 HTTP responses.
#post_webhook_url ⇒ String

The webhook URL for POST-Event webhooks.
#pre_webhook_retry_count ⇒ String

Count of times webhook will be retried in case of timeout or 429/503/504 HTTP responses.
#pre_webhook_url ⇒ String

The webhook URL for PRE-Event webhooks.
#reachability_enabled ⇒ Boolean

Indicates whether the the Reachability feature is enabled for this Service instance.
#read_status_enabled ⇒ Boolean

Enable the Message Consumption Horizon feature.
#roles ⇒ roles

Access the roles.
#sid ⇒ String

A 34 character string that uniquely identifies this resource.
#to_s ⇒ Object

Provide a user friendly representation.
#typing_indicator_timeout ⇒ String

The amount of time in seconds after a “started typing” event when clients should assume that user is no longer typing, even if no “ended typing” message was received.
#update(friendly_name: :unset, default_service_role_sid: :unset, default_channel_role_sid: :unset, default_channel_creator_role_sid: :unset, read_status_enabled: :unset, reachability_enabled: :unset, typing_indicator_timeout: :unset, consumption_report_interval: :unset, notifications_new_message_enabled: :unset, notifications_new_message_template: :unset, notifications_new_message_sound: :unset, notifications_new_message_badge_count_enabled: :unset, notifications_added_to_channel_enabled: :unset, notifications_added_to_channel_template: :unset, notifications_added_to_channel_sound: :unset, notifications_removed_from_channel_enabled: :unset, notifications_removed_from_channel_template: :unset, notifications_removed_from_channel_sound: :unset, notifications_invited_to_channel_enabled: :unset, notifications_invited_to_channel_template: :unset, notifications_invited_to_channel_sound: :unset, pre_webhook_url: :unset, post_webhook_url: :unset, webhook_method: :unset, webhook_filters: :unset, limits_channel_members: :unset, limits_user_channels: :unset, media_compatibility_message: :unset, pre_webhook_retry_count: :unset, post_webhook_retry_count: :unset, notifications_log_enabled: :unset) ⇒ ServiceInstance

Update the ServiceInstance.
#url ⇒ String

An absolute URL for this service.
#users ⇒ users

Access the users.
#webhook_filters ⇒ String

The list of WebHook events that are enabled for this Service instance.
#webhook_method ⇒ String

The webhook request format to use for both PRE and POST webhooks.

Constructor Details

#initialize(version, payload, sid: nil) ⇒ `ServiceInstance`

Initialize the ServiceInstance

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

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

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'friendly_name' => payload['friendly_name'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'default_service_role_sid' => payload['default_service_role_sid'],
      'default_channel_role_sid' => payload['default_channel_role_sid'],
      'default_channel_creator_role_sid' => payload['default_channel_creator_role_sid'],
      'read_status_enabled' => payload['read_status_enabled'],
      'reachability_enabled' => payload['reachability_enabled'],
      'typing_indicator_timeout' => payload['typing_indicator_timeout'].to_i,
      'consumption_report_interval' => payload['consumption_report_interval'].to_i,
      'limits' => payload['limits'],
      'pre_webhook_url' => payload['pre_webhook_url'],
      'post_webhook_url' => payload['post_webhook_url'],
      'webhook_method' => payload['webhook_method'],
      'webhook_filters' => payload['webhook_filters'],
      'pre_webhook_retry_count' => payload['pre_webhook_retry_count'].to_i,
      'post_webhook_retry_count' => payload['post_webhook_retry_count'].to_i,
      'notifications' => payload['notifications'],
      'media' => payload['media'],
      'url' => payload['url'],
      'links' => payload['links'],
  }

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

Instance Method Details

#account_sid ⇒ `String`



456
457
458

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

def account_sid
  @properties['account_sid']
end

#bindings ⇒ `bindings`

Access the bindings



728
729
730

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 728

def bindings
  context.bindings
end

#channels ⇒ `channels`

Access the channels



707
708
709

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 707

def channels
  context.channels
end

#consumption_report_interval ⇒ `String`



516
517
518

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 516

def consumption_report_interval
  @properties['consumption_report_interval']
end

#context ⇒ `ServiceContext`

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

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 441

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

#date_created ⇒ `Time`



468
469
470

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

def date_created
  @properties['date_created']
end

#date_updated ⇒ `Time`



474
475
476

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

def date_updated
  @properties['date_updated']
end

#default_channel_creator_role_sid ⇒ `String`



492
493
494

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 492

def default_channel_creator_role_sid
  @properties['default_channel_creator_role_sid']
end

#default_channel_role_sid ⇒ `String`



486
487
488

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 486

def default_channel_role_sid
  @properties['default_channel_role_sid']
end

#default_service_role_sid ⇒ `String`



480
481
482

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

def default_service_role_sid
  @properties['default_service_role_sid']
end

#delete ⇒ `Boolean`

Deletes the ServiceInstance



596
597
598

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 596

def delete
  context.delete
end

#fetch ⇒ `ServiceInstance`

Fetch a ServiceInstance



589
590
591

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 589

def fetch
  context.fetch
end

#friendly_name ⇒ `String`



462
463
464

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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ `Object`

Provide a detailed, user friendly representation

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 741

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

#limits ⇒ `Hash`



522
523
524

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 522

def limits
  @properties['limits']
end

#links ⇒ `String`



582
583
584

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 582

def links
  @properties['links']
end

#media ⇒ `Hash`



570
571
572

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 570

def media
  @properties['media']
end

#notifications ⇒ `Hash`



564
565
566

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 564

def notifications
  @properties['notifications']
end

#post_webhook_retry_count ⇒ `String`



558
559
560

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 558

def post_webhook_retry_count
  @properties['post_webhook_retry_count']
end

#post_webhook_url ⇒ `String`



534
535
536

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

def post_webhook_url
  @properties['post_webhook_url']
end

#pre_webhook_retry_count ⇒ `String`



552
553
554

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 552

def pre_webhook_retry_count
  @properties['pre_webhook_retry_count']
end

#pre_webhook_url ⇒ `String`



528
529
530

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

def pre_webhook_url
  @properties['pre_webhook_url']
end

#reachability_enabled ⇒ `Boolean`



504
505
506

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 504

def reachability_enabled
  @properties['reachability_enabled']
end

#read_status_enabled ⇒ `Boolean`



498
499
500

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 498

def read_status_enabled
  @properties['read_status_enabled']
end

#roles ⇒ `roles`

Access the roles



714
715
716

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 714

def roles
  context.roles
end

#sid ⇒ `String`



450
451
452

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

def sid
  @properties['sid']
end

#to_s ⇒ `Object`

Provide a user friendly representation

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 734

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

#typing_indicator_timeout ⇒ `String`



510
511
512

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 510

def typing_indicator_timeout
  @properties['typing_indicator_timeout']
end

#update(friendly_name: :unset, default_service_role_sid: :unset, default_channel_role_sid: :unset, default_channel_creator_role_sid: :unset, read_status_enabled: :unset, reachability_enabled: :unset, typing_indicator_timeout: :unset, consumption_report_interval: :unset, notifications_new_message_enabled: :unset, notifications_new_message_template: :unset, notifications_new_message_sound: :unset, notifications_new_message_badge_count_enabled: :unset, notifications_added_to_channel_enabled: :unset, notifications_added_to_channel_template: :unset, notifications_added_to_channel_sound: :unset, notifications_removed_from_channel_enabled: :unset, notifications_removed_from_channel_template: :unset, notifications_removed_from_channel_sound: :unset, notifications_invited_to_channel_enabled: :unset, notifications_invited_to_channel_template: :unset, notifications_invited_to_channel_sound: :unset, pre_webhook_url: :unset, post_webhook_url: :unset, webhook_method: :unset, webhook_filters: :unset, limits_channel_members: :unset, limits_user_channels: :unset, media_compatibility_message: :unset, pre_webhook_retry_count: :unset, post_webhook_retry_count: :unset, notifications_log_enabled: :unset) ⇒ `ServiceInstance`

Update the ServiceInstance

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 668

def update(friendly_name: :unset, default_service_role_sid: :unset, default_channel_role_sid: :unset, default_channel_creator_role_sid: :unset, read_status_enabled: :unset, reachability_enabled: :unset, typing_indicator_timeout: :unset, consumption_report_interval: :unset, notifications_new_message_enabled: :unset, notifications_new_message_template: :unset, notifications_new_message_sound: :unset, notifications_new_message_badge_count_enabled: :unset, notifications_added_to_channel_enabled: :unset, notifications_added_to_channel_template: :unset, notifications_added_to_channel_sound: :unset, notifications_removed_from_channel_enabled: :unset, notifications_removed_from_channel_template: :unset, notifications_removed_from_channel_sound: :unset, notifications_invited_to_channel_enabled: :unset, notifications_invited_to_channel_template: :unset, notifications_invited_to_channel_sound: :unset, pre_webhook_url: :unset, post_webhook_url: :unset, webhook_method: :unset, webhook_filters: :unset, limits_channel_members: :unset, limits_user_channels: :unset, media_compatibility_message: :unset, pre_webhook_retry_count: :unset, post_webhook_retry_count: :unset, notifications_log_enabled: :unset)
  context.update(
      friendly_name: friendly_name,
      default_service_role_sid: default_service_role_sid,
      default_channel_role_sid: default_channel_role_sid,
      default_channel_creator_role_sid: default_channel_creator_role_sid,
      read_status_enabled: read_status_enabled,
      reachability_enabled: reachability_enabled,
      typing_indicator_timeout: typing_indicator_timeout,
      consumption_report_interval: consumption_report_interval,
      notifications_new_message_enabled: notifications_new_message_enabled,
      notifications_new_message_template: notifications_new_message_template,
      notifications_new_message_sound: notifications_new_message_sound,
      notifications_new_message_badge_count_enabled: notifications_new_message_badge_count_enabled,
      notifications_added_to_channel_enabled: notifications_added_to_channel_enabled,
      notifications_added_to_channel_template: notifications_added_to_channel_template,
      notifications_added_to_channel_sound: notifications_added_to_channel_sound,
      notifications_removed_from_channel_enabled: notifications_removed_from_channel_enabled,
      notifications_removed_from_channel_template: notifications_removed_from_channel_template,
      notifications_removed_from_channel_sound: notifications_removed_from_channel_sound,
      notifications_invited_to_channel_enabled: notifications_invited_to_channel_enabled,
      notifications_invited_to_channel_template: notifications_invited_to_channel_template,
      notifications_invited_to_channel_sound: notifications_invited_to_channel_sound,
      pre_webhook_url: pre_webhook_url,
      post_webhook_url: post_webhook_url,
      webhook_method: webhook_method,
      webhook_filters: webhook_filters,
      limits_channel_members: limits_channel_members,
      limits_user_channels: limits_user_channels,
      media_compatibility_message: media_compatibility_message,
      pre_webhook_retry_count: pre_webhook_retry_count,
      post_webhook_retry_count: post_webhook_retry_count,
      notifications_log_enabled: notifications_log_enabled,
  )
end

#url ⇒ `String`



576
577
578

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 576

def url
  @properties['url']
end

#users ⇒ `users`

Access the users



721
722
723

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 721

def users
  context.users
end

#webhook_filters ⇒ `String`



546
547
548

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

def webhook_filters
  @properties['webhook_filters']
end

#webhook_method ⇒ `String`



540
541
542

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

def webhook_method
  @properties['webhook_method']
end

Class: Twilio::REST::IpMessaging::V2::ServiceInstance

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ ServiceInstance

Instance Method Details

#account_sid ⇒ String

#bindings ⇒ bindings

#channels ⇒ channels

#consumption_report_interval ⇒ String

#context ⇒ ServiceContext

#date_created ⇒ Time

#date_updated ⇒ Time

#default_channel_creator_role_sid ⇒ String

#default_channel_role_sid ⇒ String

#default_service_role_sid ⇒ String

#delete ⇒ Boolean

#fetch ⇒ ServiceInstance

#friendly_name ⇒ String

#inspect ⇒ Object

#limits ⇒ Hash

#links ⇒ String

#media ⇒ Hash

#notifications ⇒ Hash

#post_webhook_retry_count ⇒ String

#post_webhook_url ⇒ String

#pre_webhook_retry_count ⇒ String

#pre_webhook_url ⇒ String

#reachability_enabled ⇒ Boolean

#read_status_enabled ⇒ Boolean

#roles ⇒ roles

#sid ⇒ String

#to_s ⇒ Object

#typing_indicator_timeout ⇒ String

#url ⇒ String

#users ⇒ users

#webhook_filters ⇒ String

#webhook_method ⇒ String