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 service_sid

  • sid (String) —

    The sid



184
185
186
187
188
189
190
191
192
193
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 184

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



213
214
215
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 213

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

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

Access the document_permissions

Returns:

Raises:

  • (ArgumentError) 


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

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:



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

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



267
268
269
270
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 267

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

#to_s ⇒ Object

Provide a user friendly representation



260
261
262
263
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 260

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) —

    Contains an arbitrary JSON object to be stored in this Document. Serialized to string to respect HTTP form input, up to 16KB.

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

    New time-to-live of this Document in seconds. In the range [1, 31 536 000 (1 year)], or 0 for infinity.

Returns:



224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 224

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