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

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

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

  • account_sid (String) —

    The SID of the Account that created this SyncMapItem resource.

  • sid (String) —

    The SID of the Call resource to fetch.



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

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_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  || @properties['service_sid']  ,'map_sid' => map_sid  || @properties['map_sid']  ,'key' => key  || @properties['key']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns:

  • (String) 


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

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:



344
345
346
347
348
349
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_item.rb', line 344

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:

  • (String) 


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

def created_by
    @properties['created_by']
end

#data ⇒ Hash

Returns:

  • (Hash) 


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

def data
    @properties['data']
end

#date_created ⇒ Time

Returns:

  • (Time) 


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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns:

  • (Time) 


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

def date_updated
    @properties['date_updated']
end

#delete(if_match: :unset) ⇒ Boolean

Delete the SyncMapItemInstance

Parameters:

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

    The If-Match HTTP request header

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



415
416
417
418
419
420
421
422
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_item.rb', line 415

def delete(
    if_match: :unset
)

    context.delete(
        if_match: if_match, 
    )
end

#fetch ⇒ SyncMapItemInstance

Fetch the SyncMapItemInstance

Returns:



427
428
429
430
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_item.rb', line 427

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#key ⇒ String

Returns:

  • (String) 


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

def key
    @properties['key']
end

#map_sid ⇒ String

Returns:

  • (String) 


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

def map_sid
    @properties['map_sid']
end

#revision ⇒ String

Returns:

  • (String) 


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

def revision
    @properties['revision']
end

#service_sid ⇒ String

Returns:

  • (String) 


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

def service_sid
    @properties['service_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#update(data: nil, if_match: :unset) ⇒ SyncMapItemInstance

Update the SyncMapItemInstance

Parameters:

  • data (Object) (defaults to: nil)
  • if_match (String) (defaults to: :unset) —

    The If-Match HTTP request header

Returns:



437
438
439
440
441
442
443
444
445
446
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_item.rb', line 437

def update(
    data: nil, 
    if_match: :unset
)

    context.update(
        data: data, 
        if_match: if_match, 
    )
end

#url ⇒ String

Returns:

  • (String) 


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

def url
    @properties['url']
end