Class: Twilio::REST::Sync::V1::ServiceContext::SyncMapContext::SyncMapItemInstance

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

Initialize the SyncMapItemInstance

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.

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

    The SID of the Sync Map that contains the Map Item.

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

    The ‘key` value of the Sync Map Item resource to fetch.



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb', line 354

def initialize(version, payload, service_sid: nil, map_sid: nil, key: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'key' => payload['key'],
      'account_sid' => payload['account_sid'],
      'service_sid' => payload['service_sid'],
      'map_sid' => payload['map_sid'],
      'url' => payload['url'],
      'revision' => payload['revision'],
      'data' => payload['data'],
      '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, 'map_sid' => map_sid, 'key' => key || @properties['key'], }
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



401
402
403
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb', line 401

def 
  @properties['account_sid']
end

#context ⇒ SyncMapItemContext

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

Returns:



381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb', line 381

def context
  unless @instance_context
    @instance_context = SyncMapItemContext.new(
        @version,
        @params['service_sid'],
        @params['map_sid'],
        @params['key'],
    )
  end
  @instance_context
end

#created_by ⇒ String

Returns The identity of the Map Item’s creator.

Returns:

  • (String) —

    The identity of the Map Item’s creator



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

def created_by
  @properties['created_by']
end

#data ⇒ Hash

Returns An arbitrary, schema-less object that the Map Item stores.

Returns:

  • (Hash) —

    An arbitrary, schema-less object that the Map Item stores



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

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



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

def date_created
  @properties['date_created']
end

#date_expires ⇒ Time

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

Returns:

  • (Time) —

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



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

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the SyncMapItemInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



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

def delete
  context.delete
end

#fetch ⇒ SyncMapItemInstance

Fetch a SyncMapItemInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



503
504
505
506
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb', line 503

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

#key ⇒ String

Returns The unique, user-defined key for the Map Item.

Returns:

  • (String) —

    The unique, user-defined key for the Map Item



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

def key
  @properties['key']
end

#map_sid ⇒ String

Returns The SID of the Sync Map that contains the Map Item.

Returns:

  • (String) —

    The SID of the Sync Map that contains the Map Item



413
414
415
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb', line 413

def map_sid
  @properties['map_sid']
end

#revision ⇒ String

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

Returns:

  • (String) —

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



425
426
427
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb', line 425

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



407
408
409
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb', line 407

def service_sid
  @properties['service_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#update(data: :unset, ttl: :unset, item_ttl: :unset, collection_ttl: :unset) ⇒ SyncMapItemInstance

Update the SyncMapItemInstance

Parameters:

  • data (Hash) (defaults to: :unset) —

    A JSON string that represents an arbitrary, schema-less object that the Map Item stores. Can be up to 16KB in length.

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

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

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

    How long, in seconds, before the Map Item 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 Map Item does not expire. The Map Item might not be deleted immediately after it expires.

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

    How long, in seconds, before the Map Item’s parent 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 parent Sync Map does not expire. This parameter can only be used when the Map Item’s ‘data` or `ttl` is updated in the same request. The Sync Map might not be deleted immediately after it expires.

Returns:



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

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

#url ⇒ String

Returns The absolute URL of the Map Item resource.

Returns:

  • (String) —

    The absolute URL of the Map Item resource



419
420
421
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb', line 419

def url
  @properties['url']
end