Class: Twilio::REST::Sync::V1::ServiceContext::SyncMapInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/sync/v1/service/sync_map.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, service_sid: nil, sid: nil) ⇒ SyncMapInstance

Initialize the SyncMapInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The SID of the [Sync Service](www.twilio.com/docs/sync/api/service) the resource is associated with.

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

    The SID of the Sync Map resource to fetch.



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 320

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

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'unique_name' => payload['unique_name'],
      'account_sid' => payload['account_sid'],
      'service_sid' => payload['service_sid'],
      'url' => payload['url'],
      'links' => payload['links'],
      'revision' => payload['revision'],
      'date_expires' => Twilio.deserialize_iso8601_datetime(payload['date_expires']),
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'created_by' => payload['created_by'],
  }

  # Context
  @instance_context = nil
  @params = {'service_sid' => service_sid, '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



368
369
370
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 368

def 
  @properties['account_sid']
end

#context ⇒ SyncMapContext

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

Returns:



347
348
349
350
351
352
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 347

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

#created_by ⇒ String

Returns The identity of the Sync Map’s creator.

Returns:

  • (String) —

    The identity of the Sync Map’s creator



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

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



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

def date_created
  @properties['date_created']
end

#date_expires ⇒ Time

Returns The ISO 8601 date and time in GMT when the Sync Map expires.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the Sync Map expires



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

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the SyncMapInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



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

def delete
  context.delete
end

#fetch ⇒ SyncMapInstance

Fetch a SyncMapInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ String

Returns The URLs of the Sync Map’s nested resources.

Returns:

  • (String) —

    The URLs of the Sync Map’s nested resources



386
387
388
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 386

def links
  @properties['links']
end

#revision ⇒ String

Returns The current revision of the Sync Map, represented as a string.

Returns:

  • (String) —

    The current revision of the Sync Map, represented as a string



392
393
394
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 392

def revision
  @properties['revision']
end

#service_sid ⇒ String

Returns The SID of the Sync Service that the resource is associated with.

Returns:

  • (String) —

    The SID of the Sync Service that the resource is associated with



374
375
376
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 374

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



356
357
358
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 356

def sid
  @properties['sid']
end

#sync_map_items ⇒ sync_map_items

Access the sync_map_items

Returns:



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

def sync_map_items
  context.sync_map_items
end

#sync_map_permissions ⇒ sync_map_permissions

Access the sync_map_permissions

Returns:



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

def sync_map_permissions
  context.sync_map_permissions
end

#to_s ⇒ Object

Provide a user friendly representation



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

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Sync.V1.SyncMapInstance #{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



362
363
364
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 362

def unique_name
  @properties['unique_name']
end

#update(ttl: :unset, collection_ttl: :unset) ⇒ SyncMapInstance

Update the SyncMapInstance

Parameters:

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

    An alias for ‘collection_ttl`. If both parameters are provided, this value is ignored.

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

    How long, in seconds, before the Sync Map expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is ‘0`, which means the Sync Map does not expire. The Sync Map will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources’s deletion.

Returns:



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

def update(ttl: :unset, collection_ttl: :unset)
  context.update(ttl: ttl, collection_ttl: collection_ttl, )
end

#url ⇒ String

Returns The absolute URL of the Sync Map resource.

Returns:

  • (String) —

    The absolute URL of the Sync Map resource



380
381
382
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 380

def url
  @properties['url']
end