Class: Twilio::REST::Sync::V1::ServiceInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/sync/v1/service.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

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

Initialize the ServiceInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • sid (String) (defaults to: nil) —

    The SID of the Service resource to fetch.



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 383

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

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'unique_name' => payload['unique_name'],
      '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']),
      'url' => payload['url'],
      'webhook_url' => payload['webhook_url'],
      'webhooks_from_rest_enabled' => payload['webhooks_from_rest_enabled'],
      'reachability_webhooks_enabled' => payload['reachability_webhooks_enabled'],
      'acl_enabled' => payload['acl_enabled'],
      'reachability_debouncing_enabled' => payload['reachability_debouncing_enabled'],
      'reachability_debouncing_window' => payload['reachability_debouncing_window'].to_i,
      'links' => payload['links'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



434
435
436
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 434

def 
  @properties['account_sid']
end

#acl_enabled ⇒ Boolean

Returns Whether token identities in the Service must be granted access to Sync objects by using the Permissions resource.

Returns:

  • (Boolean) —

    Whether token identities in the Service must be granted access to Sync objects by using the Permissions resource



482
483
484
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 482

def acl_enabled
  @properties['acl_enabled']
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

Returns:



413
414
415
416
417
418
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 413

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

#date_created ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was created



446
447
448
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 446

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was last updated



452
453
454
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 452

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the ServiceInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



514
515
516
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 514

def delete
  context.delete
end

#documents ⇒ documents

Access the documents

Returns:



560
561
562
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 560

def documents
  context.documents
end

#fetch ⇒ ServiceInstance

Fetch a ServiceInstance

Returns:



507
508
509
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 507

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the resource.

Returns:

  • (String) —

    The string that you assigned to describe the resource



440
441
442
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 440

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



594
595
596
597
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 594

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

#links ⇒ String

Returns The URLs of related resources.

Returns:

  • (String) —

    The URLs of related resources



500
501
502
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 500

def links
  @properties['links']
end

#reachability_debouncing_enabled ⇒ Boolean

Returns Whether every endpoint_disconnected event occurs after a configurable delay.

Returns:

  • (Boolean) —

    Whether every endpoint_disconnected event occurs after a configurable delay



488
489
490
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 488

def reachability_debouncing_enabled
  @properties['reachability_debouncing_enabled']
end

#reachability_debouncing_window ⇒ String

Returns The reachability event delay in milliseconds.

Returns:

  • (String) —

    The reachability event delay in milliseconds



494
495
496
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 494

def reachability_debouncing_window
  @properties['reachability_debouncing_window']
end

#reachability_webhooks_enabled ⇒ Boolean

Returns Whether the service instance calls webhook_url when client endpoints connect to Sync.

Returns:

  • (Boolean) —

    Whether the service instance calls webhook_url when client endpoints connect to Sync



476
477
478
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 476

def reachability_webhooks_enabled
  @properties['reachability_webhooks_enabled']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



422
423
424
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 422

def sid
  @properties['sid']
end

#sync_lists ⇒ sync_lists

Access the sync_lists

Returns:



567
568
569
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 567

def sync_lists
  context.sync_lists
end

#sync_maps ⇒ sync_maps

Access the sync_maps

Returns:



574
575
576
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 574

def sync_maps
  context.sync_maps
end

#sync_streams ⇒ sync_streams

Access the sync_streams

Returns:



581
582
583
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 581

def sync_streams
  context.sync_streams
end

#to_s ⇒ Object

Provide a user friendly representation



587
588
589
590
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 587

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

#unique_name ⇒ String

Returns An application-defined string that uniquely identifies the resource.

Returns:

  • (String) —

    An application-defined string that uniquely identifies the resource



428
429
430
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 428

def unique_name
  @properties['unique_name']
end

#update(webhook_url: :unset, friendly_name: :unset, reachability_webhooks_enabled: :unset, acl_enabled: :unset, reachability_debouncing_enabled: :unset, reachability_debouncing_window: :unset, webhooks_from_rest_enabled: :unset) ⇒ ServiceInstance

Update the ServiceInstance

Parameters:

  • webhook_url (String) (defaults to: :unset) —

    The URL we should call when Sync objects are manipulated.

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

    A string that you assign to describe the resource.

  • reachability_webhooks_enabled (Boolean) (defaults to: :unset) —

    Whether the service instance should call ‘webhook_url` when client endpoints connect to Sync. The default is `false`.

  • acl_enabled (Boolean) (defaults to: :unset) —

    Whether token identities in the Service must be granted access to Sync objects by using the [Permissions](www.twilio.com/docs/sync/api/permissions) resource.

  • reachability_debouncing_enabled (Boolean) (defaults to: :unset) —

    Whether every ‘endpoint_disconnected` event should occur after a configurable delay. The default is `false`, where the `endpoint_disconnected` event occurs immediately after disconnection. When `true`, intervening reconnections can prevent the `endpoint_disconnected` event.

  • reachability_debouncing_window (String) (defaults to: :unset) —

    The reachability event delay in milliseconds if ‘reachability_debouncing_enabled` = `true`. Must be between 1,000 and 30,000 and defaults to 5,000. This is the number of milliseconds after the last running client disconnects, and a Sync identity is declared offline, before the webhook is called if all endpoints remain offline. A reconnection from the same identity by any endpoint during this interval prevents the webhook from being called.

  • webhooks_from_rest_enabled (Boolean) (defaults to: :unset) —

    Whether the Service instance should call ‘webhook_url` when the REST API is used to update Sync objects. The default is `false`.

Returns:



545
546
547
548
549
550
551
552
553
554
555
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 545

def update(webhook_url: :unset, friendly_name: :unset, reachability_webhooks_enabled: :unset, acl_enabled: :unset, reachability_debouncing_enabled: :unset, reachability_debouncing_window: :unset, webhooks_from_rest_enabled: :unset)
  context.update(
      webhook_url: webhook_url,
      friendly_name: friendly_name,
      reachability_webhooks_enabled: reachability_webhooks_enabled,
      acl_enabled: acl_enabled,
      reachability_debouncing_enabled: reachability_debouncing_enabled,
      reachability_debouncing_window: reachability_debouncing_window,
      webhooks_from_rest_enabled: webhooks_from_rest_enabled,
  )
end

#url ⇒ String

Returns The absolute URL of the Service resource.

Returns:

  • (String) —

    The absolute URL of the Service resource



458
459
460
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 458

def url
  @properties['url']
end

#webhook_url ⇒ String

Returns The URL we call when Sync objects are manipulated.

Returns:

  • (String) —

    The URL we call when Sync objects are manipulated



464
465
466
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 464

def webhook_url
  @properties['webhook_url']
end

#webhooks_from_rest_enabled ⇒ Boolean

Returns Whether the Service instance should call webhook_url when the REST API is used to update Sync objects.

Returns:

  • (Boolean) —

    Whether the Service instance should call webhook_url when the REST API is used to update Sync objects



470
471
472
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 470

def webhooks_from_rest_enabled
  @properties['webhooks_from_rest_enabled']
end