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

Inherits:
InstanceContext
  • Object
show all
Defined in:
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.

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, document_sid, identity) ⇒ DocumentPermissionContext

Initialize the DocumentPermissionContext



179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 179

def initialize(version, service_sid, document_sid, identity)
  super(version)

  # Path Solution
  @solution = {
      service_sid: service_sid,
      document_sid: document_sid,
      identity: identity,
  }
  @uri = "/Services/#{@solution[:service_sid]}/Documents/#{@solution[:document_sid]}/Permissions/#{@solution[:identity]}"
end

Instance Method Details

#delete ⇒ Boolean

Deletes the DocumentPermissionInstance



215
216
217
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 215

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

#fetch ⇒ DocumentPermissionInstance

Fetch a DocumentPermissionInstance



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 194

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

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

  DocumentPermissionInstance.new(
      @version,
      payload,
      service_sid: @solution[:service_sid],
      document_sid: @solution[:document_sid],
      identity: @solution[:identity],
  )
end

#to_s ⇒ Object

Provide a user friendly representation



252
253
254
255
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 252

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

#update(read: nil, write: nil, manage: nil) ⇒ DocumentPermissionInstance

Update the DocumentPermissionInstance



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 228

def update(read: nil, write: nil, manage: nil)
  data = Twilio::Values.of({
      'Read' => read,
      'Write' => write,
      'Manage' => manage,
  })

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

  DocumentPermissionInstance.new(
      @version,
      payload,
      service_sid: @solution[:service_sid],
      document_sid: @solution[:document_sid],
      identity: @solution[:identity],
  )
end