Class: Twilio::REST::Sync::V1::ServiceContext::DocumentInstance

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

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

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 SID of the [Sync Service](www.twilio.com/docs/sync/api/service) the resource is associated with.

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

    The SID of the Document resource to fetch.



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 295

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_expires' => Twilio.deserialize_iso8601_datetime(payload['date_expires']),
      '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 SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



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

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:



323
324
325
326
327
328
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 323

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

#created_by ⇒ String

Returns The identity of the Sync Document’s creator.

Returns:

  • (String) —

    The identity of the Sync Document’s creator



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

def created_by
  @properties['created_by']
end

#data ⇒ Hash

Returns An arbitrary, schema-less object that the Sync Document stores.

Returns:

  • (Hash) —

    An arbitrary, schema-less object that the Sync Document stores



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

def data
  @properties['data']
end

#date_created ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was created



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

def date_created
  @properties['date_created']
end

#date_expires ⇒ Time

Returns The ISO 8601 date and time in GMT when the Sync Document expires.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the Sync Document expires



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

def date_expires
  @properties['date_expires']
end

#date_updated ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was last updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the DocumentInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



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

def delete
  context.delete
end

#document_permissions ⇒ document_permissions

Access the document_permissions

Returns:



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

def document_permissions
  context.document_permissions
end

#fetch ⇒ DocumentInstance

Fetch a DocumentInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ String

Returns The URLs of resources related to the Sync Document.

Returns:

  • (String) —

    The URLs of resources related to the Sync Document



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

def links
  @properties['links']
end

#revision ⇒ String

Returns The current revision of the Sync Document, represented by a string identifier.

Returns:

  • (String) —

    The current revision of the Sync Document, represented by a string identifier



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

def revision
  @properties['revision']
end

#service_sid ⇒ String

Returns The SID of the Sync Service that the resource is associated with.

Returns:

  • (String) —

    The SID of the Sync Service that the resource is associated with



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#unique_name ⇒ String

Returns An application-defined string that uniquely identifies the resource.

Returns:

  • (String) —

    An application-defined string that uniquely identifies the resource



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

def unique_name
  @properties['unique_name']
end

#update(data: :unset, ttl: :unset) ⇒ DocumentInstance

Update the DocumentInstance

Parameters:

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

    A JSON string that represents an arbitrary, schema-less object that the Sync Document stores. Can be up to 16KB in length.

  • ttl (String) (defaults to: :unset) —

    How long, in seconds, before the Sync Document expires and is deleted (time-to-live). Can be an integer from 0 to 31,536,000 (1 year). The default value is ‘0`, which means the Document resource does not expire. The Document resource might not be deleted immediately after it expires.

Returns:



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

def update(data: :unset, ttl: :unset)
  context.update(data: data, ttl: ttl, )
end

#url ⇒ String

Returns The absolute URL of the Document resource.

Returns:

  • (String) —

    The absolute URL of the Document resource



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

def url
  @properties['url']
end