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



164
165
166
167
168
169
170
171
172
173
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 164

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



177
178
179
180
181
182
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 177

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

Raises:

  • (ArgumentError) 


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

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, )
    end

 @document_permissions
end

#fetch ⇒ DocumentInstance

Fetch the DocumentInstance



187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 187

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



257
258
259
260
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 257

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

#to_s ⇒ Object

Provide a user friendly representation



250
251
252
253
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 250

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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 206

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