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

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

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 the resource is associated with.

  • sid (String) (defaults to: nil)

    The SID of the Sync Map resource to fetch. Can be the Sync Map's `sid` or its `unique_name`.


293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 293

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_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


341
342
343
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 341

def 
  @properties['account_sid']
end

#contextSyncMapContext

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

Returns:


320
321
322
323
324
325
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 320

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

#created_byString

Returns The identity of the Sync Map's creator.

Returns:

  • (String)

    The identity of the Sync Map's creator


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

def created_by
  @properties['created_by']
end

#date_createdTime

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


377
378
379
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 377

def date_created
  @properties['date_created']
end

#date_expiresTime

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


371
372
373
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 371

def date_expires
  @properties['date_expires']
end

#date_updatedTime

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


383
384
385
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 383

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the SyncMapInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#fetchSyncMapInstance

Fetch the SyncMapInstance

Returns:


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

def fetch
  context.fetch
end

#inspectObject

Provide a detailed, user friendly representation


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

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

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

Returns:

  • (String)

    The URLs of the Sync Map's nested resources


359
360
361
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 359

def links
  @properties['links']
end

#revisionString

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


365
366
367
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 365

def revision
  @properties['revision']
end

#service_sidString

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


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

def service_sid
  @properties['service_sid']
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


329
330
331
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 329

def sid
  @properties['sid']
end

#sync_map_itemssync_map_items

Access the sync_map_items

Returns:


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

def sync_map_items
  context.sync_map_items
end

#sync_map_permissionssync_map_permissions

Access the sync_map_permissions

Returns:


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

def sync_map_permissions
  context.sync_map_permissions
end

#to_sObject

Provide a user friendly representation


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

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

#unique_nameString

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

Returns:

  • (String)

    An application-defined string that uniquely identifies the resource


335
336
337
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 335

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.

Returns:


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

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

#urlString

Returns The absolute URL of the Sync Map resource.

Returns:

  • (String)

    The absolute URL of the Sync Map resource


353
354
355
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 353

def url
  @properties['url']
end