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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 258

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 



306
307
308
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 306

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



285
286
287
288
289
290
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 285

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

#created_by ⇒ String 



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

def created_by
  @properties['created_by']
end

#data ⇒ Hash 



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

def data
  @properties['data']
end

#date_created ⇒ Time 



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the DocumentInstance



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

def delete
  context.delete
end

#document_permissions ⇒ document_permissions

Access the document_permissions



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

def document_permissions
  context.document_permissions
end

#fetch ⇒ DocumentInstance

Fetch the DocumentInstance



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ String 



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

def links
  @properties['links']
end

#revision ⇒ String 



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

def revision
  @properties['revision']
end

#service_sid ⇒ String 



312
313
314
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 312

def service_sid
  @properties['service_sid']
end

#sid ⇒ String 



294
295
296
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 294

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#unique_name ⇒ String 



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

def unique_name
  @properties['unique_name']
end

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

Update the DocumentInstance



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

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

#url ⇒ String 



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

def url
  @properties['url']
end