Class: Twilio::REST::Preview::Sync::ServiceContext::DocumentInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Preview::Sync::ServiceContext::DocumentInstance
- Defined in:
- lib/twilio-ruby/rest/preview/sync/service/document.rb
Instance Method Summary collapse
- #account_sid ⇒ String
-
#context ⇒ DocumentContext
Generate an instance context for the instance, the context is capable of performing various actions.
- #created_by ⇒ String
- #data ⇒ Hash
- #date_created ⇒ Time
- #date_updated ⇒ Time
-
#delete ⇒ Boolean
Delete the DocumentInstance.
-
#document_permissions ⇒ document_permissions
Access the document_permissions.
-
#fetch ⇒ DocumentInstance
Fetch the DocumentInstance.
-
#initialize(version, payload, service_sid: nil, sid: nil) ⇒ DocumentInstance
constructor
Initialize the DocumentInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
- #links ⇒ Hash
- #revision ⇒ String
- #service_sid ⇒ String
- #sid ⇒ String
-
#to_s ⇒ Object
Provide a user friendly representation.
- #unique_name ⇒ String
-
#update(data: nil, if_match: :unset) ⇒ DocumentInstance
Update the DocumentInstance.
- #url ⇒ String
Constructor Details
#initialize(version, payload, service_sid: nil, sid: nil) ⇒ DocumentInstance
Initialize the DocumentInstance
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 |
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 289 def initialize(version, payload , service_sid: nil, sid: nil) super(version) # Marshaled Properties @properties = { 'sid' => payload['sid'], 'unique_name' => payload['unique_name'], 'account_sid' => payload['account_sid'], 'service_sid' => payload['service_sid'], 'url' => payload['url'], 'links' => payload['links'], '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'] ,'sid' => sid || @properties['sid'] , } end |
Instance Method Details
#account_sid ⇒ String
337 338 339 |
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 337 def account_sid @properties['account_sid'] end |
#context ⇒ DocumentContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
316 317 318 319 320 321 |
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 316 def context unless @instance_context @instance_context = DocumentContext.new(@version , @params['service_sid'], @params['sid']) end @instance_context end |
#created_by ⇒ String
385 386 387 |
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 385 def created_by @properties['created_by'] end |
#data ⇒ Hash
367 368 369 |
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 367 def data @properties['data'] end |
#date_created ⇒ Time
373 374 375 |
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 373 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
379 380 381 |
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 379 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the DocumentInstance
392 393 394 395 |
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 392 def delete context.delete end |
#document_permissions ⇒ document_permissions
Access the document_permissions
424 425 426 |
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 424 def context. end |
#fetch ⇒ DocumentInstance
Fetch the DocumentInstance
400 401 402 403 |
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 400 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/document.rb', line 437 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Preview.Sync.DocumentInstance #{values}>" end |
#links ⇒ Hash
355 356 357 |
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 355 def links @properties['links'] end |
#revision ⇒ String
361 362 363 |
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 361 def revision @properties['revision'] end |
#service_sid ⇒ String
343 344 345 |
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 343 def service_sid @properties['service_sid'] end |
#sid ⇒ String
325 326 327 |
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 325 def sid @properties['sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
430 431 432 433 |
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 430 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Preview.Sync.DocumentInstance #{values}>" end |
#unique_name ⇒ String
331 332 333 |
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 331 def unique_name @properties['unique_name'] end |
#update(data: nil, if_match: :unset) ⇒ DocumentInstance
Update the DocumentInstance
410 411 412 413 414 415 416 417 418 419 |
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 410 def update( data: nil, if_match: :unset ) context.update( data: data, if_match: if_match, ) end |
#url ⇒ String
349 350 351 |
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 349 def url @properties['url'] end |