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

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/sync/service/document.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, sid: nil) ⇒ DocumentInstance

Initialize the DocumentInstance

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

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

    The sid



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

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

Instance Method Details

#account_sid ⇒ String

Returns The account_sid.

Returns:

  • (String) —

    The account_sid



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

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:



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

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

#created_by ⇒ String

Returns The created_by.

Returns:

  • (String) —

    The created_by



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

def created_by
  @properties['created_by']
end

#data ⇒ Hash

Returns The data.

Returns:

  • (Hash) —

    The data



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

def data
  @properties['data']
end

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the DocumentInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



421
422
423
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 421

def delete
  context.delete
end

#document_permissions ⇒ document_permissions

Access the document_permissions

Returns:



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

def document_permissions
  context.document_permissions
end

#fetch ⇒ DocumentInstance

Fetch a DocumentInstance

Returns:



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

def fetch
  context.fetch
end

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



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

def links
  @properties['links']
end

#revision ⇒ String

Returns The revision.

Returns:

  • (String) —

    The revision



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

def revision
  @properties['revision']
end

#service_sid ⇒ String

Returns The service_sid.

Returns:

  • (String) —

    The service_sid



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



347
348
349
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 347

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



444
445
446
447
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 444

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

#unique_name ⇒ String

Returns The unique_name.

Returns:

  • (String) —

    The unique_name



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

def unique_name
  @properties['unique_name']
end

#update(data: nil) ⇒ DocumentInstance

Update the DocumentInstance

Parameters:

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

    The data

Returns:



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

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

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end