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

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

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.


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

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


409
410
411
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 409

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


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

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:


388
389
390
391
392
393
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 388

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


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

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


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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ServiceInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#documents ⇒ documents

Access the documents

Returns:


535
536
537
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 535

def documents
  context.documents
end

#fetch ⇒ ServiceInstance

Fetch the ServiceInstance

Returns:


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

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


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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation


569
570
571
572
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 569

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


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

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


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

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


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

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


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

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


397
398
399
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 397

def sid
  @properties['sid']
end

#sync_lists ⇒ sync_lists

Access the sync_lists

Returns:


542
543
544
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 542

def sync_lists
  context.sync_lists
end

#sync_maps ⇒ sync_maps

Access the sync_maps

Returns:


549
550
551
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 549

def sync_maps
  context.sync_maps
end

#sync_streams ⇒ sync_streams

Access the sync_streams

Returns:


556
557
558
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 556

def sync_streams
  context.sync_streams
end

#to_s ⇒ Object

Provide a user friendly representation


562
563
564
565
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 562

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


403
404
405
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 403

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 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:


520
521
522
523
524
525
526
527
528
529
530
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 520

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


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

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


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

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


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

def webhooks_from_rest_enabled
  @properties['webhooks_from_rest_enabled']
end