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

  • account_sid (String) —

    The SID of the Account that created this Service resource.

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

    The SID of the Call resource to fetch.



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 397

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'] == nil ? payload['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](www.twilio.com/docs/iam/api/account) that created the Service resource.

Returns:



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

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](www.twilio.com/docs/sync/api/sync-permissions) resource. It is disabled (false) by default.

Returns:



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

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:



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

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

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ServiceInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



521
522
523
524
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 521

def delete

    context.delete
end

#documents ⇒ documents

Access the documents

Returns:



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

def documents
    context.documents
end

#fetch ⇒ ServiceInstance

Fetch the ServiceInstance

Returns:



529
530
531
532
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 529

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.



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



602
603
604
605
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 602

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

#links ⇒ Hash

Returns The URLs of related resources.

Returns:

  • (Hash) —

    The URLs of related resources.



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

def links
    @properties['links']
end

#reachability_debouncing_enabled ⇒ Boolean

Returns 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.

Returns:

  • (Boolean) —

    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.



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

def reachability_debouncing_enabled
    @properties['reachability_debouncing_enabled']
end

#reachability_debouncing_window ⇒ String

Returns 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 `webhook_url` is called, if all endpoints remain offline. A reconnection from the same identity by any endpoint during this interval prevents the reachability event from occurring.

Returns:

  • (String) —

    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 `webhook_url` is called, if all endpoints remain offline. A reconnection from the same identity by any endpoint during this interval prevents the reachability event from occurring.



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

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. The default is `false`.

Returns:

  • (Boolean) —

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



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

def reachability_webhooks_enabled
    @properties['reachability_webhooks_enabled']
end

#sid ⇒ String

Returns The unique string that we created to identify the Service resource.

Returns:

  • (String) —

    The unique string that we created to identify the Service resource.



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

def sid
    @properties['sid']
end

#sync_lists ⇒ sync_lists

Access the sync_lists

Returns:



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

def sync_lists
    context.sync_lists
end

#sync_maps ⇒ sync_maps

Access the sync_maps

Returns:



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

def sync_maps
    context.sync_maps
end

#sync_streams ⇒ sync_streams

Access the sync_streams

Returns:



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

def sync_streams
    context.sync_streams
end

#to_s ⇒ Object

Provide a user friendly representation



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

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. It can be used in place of the resource’s ‘sid` in the URL to address the resource. It is a read-only property, it cannot be assigned using REST API.

Returns:

  • (String) —

    An application-defined string that uniquely identifies the resource. It can be used in place of the resource’s ‘sid` in the URL to address the resource. It is a read-only property, it cannot be assigned using REST API.



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

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



544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
 
# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 544

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.



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

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.



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

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. The default is `false`.

Returns:

  • (Boolean) —

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



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

def webhooks_from_rest_enabled
    @properties['webhooks_from_rest_enabled']
end