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

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/sync/v1/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.



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 301

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Document resource.

Returns:



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

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:



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

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. If the Sync Document is created from the client SDK, the value matches the Access Token’s ‘identity` field. If the Sync Document was created from the REST API, the value is `system`.

Returns:

  • (String) —

    The identity of the Sync Document’s creator. If the Sync Document is created from the client SDK, the value matches the Access Token’s ‘identity` field. If the Sync Document was created from the REST API, the value is `system`.



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

def created_by
    @properties['created_by']
end

#data ⇒ Hash

Returns An arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length.

Returns:

  • (Hash) —

    An arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length.



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

def data
    @properties['data']
end

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_expires ⇒ Time

Returns The date and time in GMT when the Sync Document expires and will be deleted, specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format. If the Sync Document does not expire, this value is ‘null`. The Document resource might not be deleted immediately after it expires.

Returns:

  • (Time) —

    The date and time in GMT when the Sync Document expires and will be deleted, specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format. If the Sync Document does not expire, this value is ‘null`. The Document resource might not be deleted immediately after it expires.



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

def date_expires
    @properties['date_expires']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the DocumentInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#document_permissions ⇒ document_permissions

Access the document_permissions

Returns:



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

def document_permissions
    context.document_permissions
end

#fetch ⇒ DocumentInstance

Fetch the DocumentInstance

Returns:



419
420
421
422
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 419

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



459
460
461
462
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 459

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

#links ⇒ Hash

Returns The URLs of resources related to the Sync Document.

Returns:

  • (Hash) —

    The URLs of resources related to the Sync Document.



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

def links
    @properties['links']
end

#revision ⇒ String

Returns The current revision of the Sync Document, represented as a string. The ‘revision` property is used with conditional updates to ensure data consistency.

Returns:

  • (String) —

    The current revision of the Sync Document, represented as a string. The ‘revision` property is used with conditional updates to ensure data consistency.



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

def revision
    @properties['revision']
end

#service_sid ⇒ String

Returns The SID of the [Sync Service](www.twilio.com/docs/sync/api/service) the resource is associated with.

Returns:



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

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that we created to identify the Document resource.

Returns:

  • (String) —

    The unique string that we created to identify the Document resource.



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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



452
453
454
455
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 452

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. It can be used in place of the resource’s ‘sid` in the URL to address the resource and can be up to 320 characters long.

Returns:

  • (String) —

    An application-defined string that uniquely identifies the resource. It can be used in place of the resource’s ‘sid` in the URL to address the resource and can be up to 320 characters long.



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

def unique_name
    @properties['unique_name']
end

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

Update the DocumentInstance

Parameters:

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

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

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

    How long, [in seconds](www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Document expires and is deleted (time-to-live).

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

    The If-Match HTTP request header

Returns:



430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 430

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

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

#url ⇒ String

Returns The absolute URL of the Document resource.

Returns:

  • (String) —

    The absolute URL of the Document resource.



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

def url
    @properties['url']
end