Class: Twilio::REST::Preview::Sync::ServiceContext::DocumentContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/sync/service/document.rb,
lib/twilio-ruby/rest/preview/sync/service/document/document_permission.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].

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 service_sid

  • sid (String) —

    The sid



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

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, true otherwise



232
233
234
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 232

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

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

Access the document_permissions

Returns:

Raises:

  • (ArgumentError) 


263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 263

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:



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 212

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

#to_s ⇒ Object

Provide a user friendly representation



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

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

#update(data: nil) ⇒ DocumentInstance

Update the DocumentInstance

Parameters:

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

    The data

Returns:



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 240

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

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

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