Class: Twilio::REST::Sync::V1::ServiceContext::DocumentContext

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

Overview

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

Defined Under Namespace

Classes: DocumentPermissionContext, DocumentPermissionInstance, DocumentPermissionList, DocumentPermissionPage

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, sid) ⇒ DocumentContext

Initialize the DocumentContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String) —

    The SID of the [Sync Service](www.twilio.com/docs/sync/api/service) with the Document resource to fetch.

  • sid (String) —

    The SID of the Document resource to fetch.



192
193
194
195
196
197
198
199
200
201
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 192

def initialize(version, service_sid, sid)
  super(version)

  # Path Solution
  @solution = {service_sid: service_sid, sid: sid, }
  @uri = "/Services/#{@solution[:service_sid]}/Documents/#{@solution[:sid]}"

  # Dependents
  @document_permissions = nil
end

Instance Method Details

#delete ⇒ Boolean

Deletes the DocumentInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



221
222
223
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 221

def delete
  @version.delete('delete', @uri)
end

#document_permissions(identity = :unset) ⇒ DocumentPermissionList, DocumentPermissionContext

Access the document_permissions

Returns:

Raises:

  • (ArgumentError) 


250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 250

def document_permissions(identity=:unset)
  raise ArgumentError, 'identity cannot be nil' if identity.nil?

  if identity != :unset
    return DocumentPermissionContext.new(@version, @solution[:service_sid], @solution[:sid], identity, )
  end

  unless @document_permissions
    @document_permissions = DocumentPermissionList.new(
        @version,
        service_sid: @solution[:service_sid],
        document_sid: @solution[:sid],
    )
  end

  @document_permissions
end

#fetch ⇒ DocumentInstance

Fetch a DocumentInstance

Returns:



206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 206

def fetch
  params = Twilio::Values.of({})

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

  DocumentInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



277
278
279
280
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 277

def inspect
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Sync.V1.DocumentContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



270
271
272
273
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 270

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Sync.V1.DocumentContext #{context}>"
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:



234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 234

def update(data: :unset, ttl: :unset)
  data = Twilio::Values.of({'Data' => Twilio.serialize_object(data), 'Ttl' => ttl, })

  payload = @version.update(
      'POST',
      @uri,
      data: data,
  )

  DocumentInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
end