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 unique SID identifier of the Service Instance that hosts this Map object.

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

    The unique 34-character SID identifier of the Map containing this Item.

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

    The key



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb', line 330

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 unique SID identifier of the Twilio Account.

Returns:

  • (String) —

    The unique SID identifier of the Twilio Account.



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

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:



357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb', line 357

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

Returns:

  • (String) —

    The identity of the Map creator.



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

def created_by
  @properties['created_by']
end

#data ⇒ Hash

Returns Contains arbitrary user-defined, schema-less data that this Map Item stores, represented by a JSON object, up to 16KB.

Returns:

  • (Hash) —

    Contains arbitrary user-defined, schema-less data that this Map Item stores, represented by a JSON object, up to 16KB.



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

def data
  @properties['data']
end

#date_created ⇒ Time

Returns The date this Map was created, given in UTC ISO 8601 format.

Returns:

  • (Time) —

    The date this Map was created, given in UTC ISO 8601 format.



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

def date_created
  @properties['date_created']
end

#date_expires ⇒ Time

Returns Contains the date this Map expires and gets deleted automatically.

Returns:

  • (Time) —

    Contains the date this Map expires and gets deleted automatically.



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

def date_expires
  @properties['date_expires']
end

#date_updated ⇒ Time

Returns Specifies the date this Map was last updated, given in UTC ISO 8601 format.

Returns:

  • (Time) —

    Specifies the date this Map was last updated, given in UTC ISO 8601 format.



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the SyncMapItemInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ SyncMapItemInstance

Fetch a SyncMapItemInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



476
477
478
479
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb', line 476

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

#key ⇒ String

Returns The unique user-defined key of this Map Item.

Returns:

  • (String) —

    The unique user-defined key of this Map Item.



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

def key
  @properties['key']
end

#map_sid ⇒ String

Returns The unique 34-character SID identifier of the Map containing this Item.

Returns:

  • (String) —

    The unique 34-character SID identifier of the Map containing this Item.



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

def map_sid
  @properties['map_sid']
end

#revision ⇒ String

Returns Contains the current revision of this Map, represented by a string identifier.

Returns:

  • (String) —

    Contains the current revision of this Map, represented by a string identifier.



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

def revision
  @properties['revision']
end

#service_sid ⇒ String

Returns The unique SID identifier of the Service Instance that hosts this Map object.

Returns:

  • (String) —

    The unique SID identifier of the Service Instance that hosts this Map object.



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

def service_sid
  @properties['service_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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) —

    Contains an arbitrary JSON object to be stored in this Map Item. Serialized to string to respect HTTP form input, up to 16KB.

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

    Alias for item_ttl. If both are provided, this value is ignored.

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

    Time-to-live of this item in seconds, defaults to no expiration. In the range [1, 31 536 000 (1 year)], or 0 for infinity. Upon expiry, the map item will be cleaned up at least in a matter of hours, and often within seconds, making this a good tool for garbage management.

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

    Time-to-live of this item’s parent Map in seconds, defaults to no expiration. In the range [1, 31 536 000 (1 year)], or 0 for infinity.

Returns:



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

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 for this Map.

Returns:

  • (String) —

    The absolute URL for this Map.



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

def url
  @properties['url']
end