Class: Twilio::REST::Preview::Sync::ServiceContext::DocumentInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, sid: nil) ⇒ DocumentInstance

Initialize the DocumentInstance

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 Document resource.

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

    The SID of the Call resource to fetch.



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 290

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

Returns:

  • (String) 


338
339
340
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 338

def 
    @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

Returns:



317
318
319
320
321
322
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 317

def context
    unless @instance_context
        @instance_context = DocumentContext.new(@version , @params['service_sid'], @params['sid'])
    end
    @instance_context
end

#created_by ⇒ String

Returns:

  • (String) 


386
387
388
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 386

def created_by
    @properties['created_by']
end

#data ⇒ Hash

Returns:

  • (Hash) 


368
369
370
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 368

def data
    @properties['data']
end

#date_created ⇒ Time

Returns:

  • (Time) 


374
375
376
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 374

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns:

  • (Time) 


380
381
382
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 380

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the DocumentInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#document_permissions ⇒ document_permissions

Access the document_permissions

Returns:



425
426
427
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 425

def document_permissions
    context.document_permissions
end

#fetch ⇒ DocumentInstance

Fetch the DocumentInstance

Returns:



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

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



438
439
440
441
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 438

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

#links ⇒ Hash

Returns:

  • (Hash) 


356
357
358
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 356

def links
    @properties['links']
end

#revision ⇒ String

Returns:

  • (String) 


362
363
364
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 362

def revision
    @properties['revision']
end

#service_sid ⇒ String

Returns:

  • (String) 


344
345
346
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 344

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns:

  • (String) 


326
327
328
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 326

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



431
432
433
434
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 431

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

#unique_name ⇒ String

Returns:

  • (String) 


332
333
334
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 332

def unique_name
    @properties['unique_name']
end

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

Update the DocumentInstance

Parameters:

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

    The If-Match HTTP request header

Returns:



411
412
413
414
415
416
417
418
419
420
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 411

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

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

#url ⇒ String

Returns:

  • (String) 


350
351
352
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 350

def url
    @properties['url']
end