Class: Twilio::REST::Preview::Sync::ServiceInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/preview/sync/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.



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/twilio-ruby/rest/preview/sync/service.rb', line 335

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']),
        'url' => payload['url'],
        'webhook_url' => payload['webhook_url'],
        'reachability_webhooks_enabled' => payload['reachability_webhooks_enabled'],
        'acl_enabled' => payload['acl_enabled'],
        'links' => payload['links'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns:

  • (String) 


376
377
378
 
# File 'lib/twilio-ruby/rest/preview/sync/service.rb', line 376

def 
    @properties['account_sid']
end

#acl_enabled ⇒ Boolean

Returns:

  • (Boolean) 


418
419
420
 
# File 'lib/twilio-ruby/rest/preview/sync/service.rb', line 418

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:



361
362
363
364
365
366
 
# File 'lib/twilio-ruby/rest/preview/sync/service.rb', line 361

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

#date_created ⇒ Time

Returns:

  • (Time) 


388
389
390
 
# File 'lib/twilio-ruby/rest/preview/sync/service.rb', line 388

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns:

  • (Time) 


394
395
396
 
# File 'lib/twilio-ruby/rest/preview/sync/service.rb', line 394

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ServiceInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



431
432
433
434
 
# File 'lib/twilio-ruby/rest/preview/sync/service.rb', line 431

def delete

    context.delete
end

#documents ⇒ documents

Access the documents

Returns:



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

def documents
    context.documents
end

#fetch ⇒ ServiceInstance

Fetch the ServiceInstance

Returns:



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

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns:

  • (String) 


382
383
384
 
# File 'lib/twilio-ruby/rest/preview/sync/service.rb', line 382

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ Hash

Returns:

  • (Hash) 


424
425
426
 
# File 'lib/twilio-ruby/rest/preview/sync/service.rb', line 424

def links
    @properties['links']
end

#reachability_webhooks_enabled ⇒ Boolean

Returns:

  • (Boolean) 


412
413
414
 
# File 'lib/twilio-ruby/rest/preview/sync/service.rb', line 412

def reachability_webhooks_enabled
    @properties['reachability_webhooks_enabled']
end

#sid ⇒ String

Returns:

  • (String) 


370
371
372
 
# File 'lib/twilio-ruby/rest/preview/sync/service.rb', line 370

def sid
    @properties['sid']
end

#sync_lists ⇒ sync_lists

Access the sync_lists

Returns:



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

def sync_lists
    context.sync_lists
end

#sync_maps ⇒ sync_maps

Access the sync_maps

Returns:



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

def sync_maps
    context.sync_maps
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

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

Update the ServiceInstance

Parameters:

  • webhook_url (String) (defaults to: :unset)
  • friendly_name (String) (defaults to: :unset)
  • reachability_webhooks_enabled (Boolean) (defaults to: :unset)
  • acl_enabled (Boolean) (defaults to: :unset)

Returns:



451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'lib/twilio-ruby/rest/preview/sync/service.rb', line 451

def update(
    webhook_url: :unset, 
    friendly_name: :unset, 
    reachability_webhooks_enabled: :unset, 
    acl_enabled: :unset
)

    context.update(
        webhook_url: webhook_url, 
        friendly_name: friendly_name, 
        reachability_webhooks_enabled: reachability_webhooks_enabled, 
        acl_enabled: acl_enabled, 
    )
end

#url ⇒ String

Returns:

  • (String) 


400
401
402
 
# File 'lib/twilio-ruby/rest/preview/sync/service.rb', line 400

def url
    @properties['url']
end

#webhook_url ⇒ String

Returns:

  • (String) 


406
407
408
 
# File 'lib/twilio-ruby/rest/preview/sync/service.rb', line 406

def webhook_url
    @properties['webhook_url']
end