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

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

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 service_sid

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

    The map_sid

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

    The key



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_item.rb', line 302

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

Instance Method Details

#account_sid ⇒ String

Returns The account_sid.

Returns:

  • (String) —

    The account_sid



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

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:



332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_item.rb', line 332

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

Returns:

  • (String) —

    The created_by



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

def created_by
  @properties['created_by']
end

#data ⇒ Hash

Returns The data.

Returns:

  • (Hash) —

    The data



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

def data
  @properties['data']
end

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the SyncMapItemInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ SyncMapItemInstance

Fetch a SyncMapItemInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#key ⇒ String

Returns The key.

Returns:

  • (String) —

    The key



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

def key
  @properties['key']
end

#map_sid ⇒ String

Returns The map_sid.

Returns:

  • (String) —

    The map_sid



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

def map_sid
  @properties['map_sid']
end

#revision ⇒ String

Returns The revision.

Returns:

  • (String) —

    The revision



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

def revision
  @properties['revision']
end

#service_sid ⇒ String

Returns The service_sid.

Returns:

  • (String) —

    The service_sid



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

def service_sid
  @properties['service_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#update(data: nil) ⇒ SyncMapItemInstance

Update the SyncMapItemInstance

Parameters:

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

    The data

Returns:



422
423
424
425
426
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_item.rb', line 422

def update(data: nil)
  context.update(
      data: data,
  )
end

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end