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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 273

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



321
322
323
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 321

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:



300
301
302
303
304
305
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 300

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



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

def created_by
  @properties['created_by']
end

#data ⇒ Hash

Returns The data.

Returns:

  • (Hash) —

    The data



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

def data
  @properties['data']
end

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the DocumentInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#document_permissions ⇒ document_permissions

Access the document_permissions

Returns:



398
399
400
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 398

def document_permissions
  context.document_permissions
end

#fetch ⇒ DocumentInstance

Fetch a DocumentInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



411
412
413
414
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 411

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

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



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

def links
  @properties['links']
end

#revision ⇒ String

Returns The revision.

Returns:

  • (String) —

    The revision



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

def revision
  @properties['revision']
end

#service_sid ⇒ String

Returns The service_sid.

Returns:

  • (String) —

    The service_sid



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



309
310
311
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 309

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



404
405
406
407
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 404

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



315
316
317
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 315

def unique_name
  @properties['unique_name']
end

#update(data: nil) ⇒ DocumentInstance

Update the DocumentInstance

Parameters:

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

    The data

Returns:



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

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

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end