Class: Twilio::REST::Sync::V1::ServiceContext::SyncListContext::SyncListItemInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Sync::V1::ServiceContext::SyncListContext::SyncListItemInstance
- Defined in:
- lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the List Item resource.
-
#context ⇒ SyncListItemContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#created_by ⇒ String
The identity of the List Item’s creator.
-
#data ⇒ Hash
An arbitrary, schema-less object that the List Item stores.
-
#date_created ⇒ Time
The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
-
#date_expires ⇒ Time
The date and time in GMT when the List Item expires and will be deleted, specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
-
#date_updated ⇒ Time
The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
-
#delete(if_match: :unset) ⇒ Boolean
Delete the SyncListItemInstance.
-
#fetch ⇒ SyncListItemInstance
Fetch the SyncListItemInstance.
-
#index ⇒ String
The automatically generated index of the List Item.
-
#initialize(version, payload, service_sid: nil, list_sid: nil, index: nil) ⇒ SyncListItemInstance
constructor
Initialize the SyncListItemInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#list_sid ⇒ String
The SID of the Sync List that contains the List Item.
-
#revision ⇒ String
The current revision of the item, represented as a string.
-
#service_sid ⇒ String
The SID of the [Sync Service](www.twilio.com/docs/sync/api/service) the resource is associated with.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#update(data: :unset, ttl: :unset, item_ttl: :unset, collection_ttl: :unset, if_match: :unset) ⇒ SyncListItemInstance
Update the SyncListItemInstance.
-
#url ⇒ String
The absolute URL of the List Item resource.
Constructor Details
#initialize(version, payload, service_sid: nil, list_sid: nil, index: nil) ⇒ SyncListItemInstance
Initialize the SyncListItemInstance
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 309 def initialize(version, payload , service_sid: nil, list_sid: nil, index: nil) super(version) # Marshaled Properties @properties = { 'index' => payload['index'] == nil ? payload['index'] : payload['index'].to_i, 'account_sid' => payload['account_sid'], 'service_sid' => payload['service_sid'], 'list_sid' => payload['list_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 || @properties['service_sid'] ,'list_sid' => list_sid || @properties['list_sid'] ,'index' => index || @properties['index'] , } end |
Instance Method Details
#account_sid ⇒ String
Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the List Item resource.
351 352 353 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 351 def account_sid @properties['account_sid'] end |
#context ⇒ SyncListItemContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
336 337 338 339 340 341 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 336 def context unless @instance_context @instance_context = SyncListItemContext.new(@version , @params['service_sid'], @params['list_sid'], @params['index']) end @instance_context end |
#created_by ⇒ String
Returns The identity of the List Item’s creator. If the item is created from the client SDK, the value matches the Access Token’s ‘identity` field. If the item was created from the REST API, the value is `system`.
405 406 407 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 405 def created_by @properties['created_by'] end |
#data ⇒ Hash
Returns An arbitrary, schema-less object that the List Item stores. Can be up to 16 KiB in length.
381 382 383 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 381 def data @properties['data'] end |
#date_created ⇒ Time
Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
393 394 395 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 393 def date_created @properties['date_created'] end |
#date_expires ⇒ Time
Returns The date and time in GMT when the List Item expires and will be deleted, specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format. If the List Item does not expire, this value is ‘null`. The List Item resource might not be deleted immediately after it expires.
387 388 389 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 387 def date_expires @properties['date_expires'] end |
#date_updated ⇒ Time
Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
399 400 401 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 399 def date_updated @properties['date_updated'] end |
#delete(if_match: :unset) ⇒ Boolean
Delete the SyncListItemInstance
413 414 415 416 417 418 419 420 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 413 def delete( if_match: :unset ) context.delete( if_match: if_match, ) end |
#fetch ⇒ SyncListItemInstance
Fetch the SyncListItemInstance
425 426 427 428 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 425 def fetch context.fetch end |
#index ⇒ String
Returns The automatically generated index of the List Item. The ‘index` values of the List Items in a Sync List can have gaps in their sequence.
345 346 347 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 345 def index @properties['index'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
464 465 466 467 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 464 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Sync.V1.SyncListItemInstance #{values}>" end |
#list_sid ⇒ String
Returns The SID of the Sync List that contains the List Item.
363 364 365 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 363 def list_sid @properties['list_sid'] end |
#revision ⇒ String
Returns The current revision of the item, represented as a string.
375 376 377 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 375 def revision @properties['revision'] end |
#service_sid ⇒ String
Returns The SID of the [Sync Service](www.twilio.com/docs/sync/api/service) the resource is associated with.
357 358 359 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 357 def service_sid @properties['service_sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
457 458 459 460 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 457 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Sync.V1.SyncListItemInstance #{values}>" end |
#update(data: :unset, ttl: :unset, item_ttl: :unset, collection_ttl: :unset, if_match: :unset) ⇒ SyncListItemInstance
Update the SyncListItemInstance
438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 438 def update( data: :unset, ttl: :unset, item_ttl: :unset, collection_ttl: :unset, if_match: :unset ) context.update( data: data, ttl: ttl, item_ttl: item_ttl, collection_ttl: collection_ttl, if_match: if_match, ) end |
#url ⇒ String
Returns The absolute URL of the List Item resource.
369 370 371 |
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 369 def url @properties['url'] end |