Class: Twilio::REST::Preview::Sync::ServiceContext::DocumentContext
- Inherits:
-
InstanceContext
- Object
- InstanceContext
- Twilio::REST::Preview::Sync::ServiceContext::DocumentContext
- 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
-
#delete ⇒ Boolean
Delete the DocumentInstance.
-
#document_permissions(identity = :unset) ⇒ DocumentPermissionList, DocumentPermissionContext
Access the document_permissions.
-
#fetch ⇒ DocumentInstance
Fetch the DocumentInstance.
-
#initialize(version, service_sid, sid) ⇒ DocumentContext
constructor
Initialize the DocumentContext.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#update(data: nil, if_match: :unset) ⇒ DocumentInstance
Update the DocumentInstance.
Constructor Details
#initialize(version, service_sid, sid) ⇒ DocumentContext
Initialize the DocumentContext
160 161 162 163 164 165 166 167 168 169 |
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 160 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
173 174 175 176 |
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 173 def delete @version.delete('DELETE', @uri) end |
#document_permissions(identity = :unset) ⇒ DocumentPermissionList, DocumentPermissionContext
Access the document_permissions
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 220 def (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
181 182 183 184 185 186 187 188 189 190 |
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 181 def fetch payload = @version.fetch('GET', @uri) DocumentInstance.new( @version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], ) end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
245 246 247 248 |
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 245 def inspect context = @solution.map{|k, v| "#{k}: #{v}"}.join(',') "#<Twilio.Preview.Sync.DocumentContext #{context}>" end |
#to_s ⇒ Object
Provide a user friendly representation
238 239 240 241 |
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 238 def to_s context = @solution.map{|k, v| "#{k}: #{v}"}.join(',') "#<Twilio.Preview.Sync.DocumentContext #{context}>" end |
#update(data: nil, if_match: :unset) ⇒ DocumentInstance
Update the DocumentInstance
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 |
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 197 def update( data: nil, if_match: :unset ) data = Twilio::Values.of({ 'Data' => Twilio.serialize_object(data), }) headers = Twilio::Values.of({ '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 |