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

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 update.

  • sid (String) —

    The SID of the Document resource to update. Can be the Document resource’s ‘sid` or its `unique_name`.



171
172
173
174
175
176
177
178
179
180
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 171

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

Delete the DocumentInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    @version.delete('DELETE', @uri, headers: headers)
end

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

Access the document_permissions

Returns:

Raises:

  • (ArgumentError) 


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

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 the DocumentInstance

Returns:



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

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    DocumentInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        sid: @solution[:sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



274
275
276
277
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 274

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

#to_s ⇒ Object

Provide a user friendly representation



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

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



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 219

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

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'If-Match' => if_match, })
    
    
    
    
    
    payload = @version.update('POST', @uri, data: data, headers: headers)
    DocumentInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        sid: @solution[:sid],
    )
end