Class: Twilio::REST::Sync::V1::ServiceContext::DocumentContext::DocumentPermissionContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, document_sid, identity) ⇒ DocumentPermissionContext

Initialize the DocumentPermissionContext

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 Permission resource to update.

  • document_sid (String) —

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

  • identity (String) —

    The application-defined string that uniquely identifies the User’s Document Permission resource to update.



141
142
143
144
145
146
147
148
149
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 141

def initialize(version, service_sid, document_sid, identity)
    super(version)

    # Path Solution
    @solution = { service_sid: service_sid, document_sid: document_sid, identity: identity,  }
    @uri = "/Services/#{@solution[:service_sid]}/Documents/#{@solution[:document_sid]}/Permissions/#{@solution[:identity]}"

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the DocumentPermissionInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



153
154
155
156
157
158
159
160
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 153

def delete

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

#fetch ⇒ DocumentPermissionInstance

Fetch the DocumentPermissionInstance

Returns:



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 165

def fetch

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



227
228
229
230
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 227

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

#to_s ⇒ Object

Provide a user friendly representation



220
221
222
223
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 220

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

#update(read: nil, write: nil, manage: nil) ⇒ DocumentPermissionInstance

Update the DocumentPermissionInstance

Parameters:

  • read (Boolean) (defaults to: nil) —

    Whether the identity can read the Sync Document. Default value is ‘false`.

  • write (Boolean) (defaults to: nil) —

    Whether the identity can update the Sync Document. Default value is ‘false`.

  • manage (Boolean) (defaults to: nil) —

    Whether the identity can delete the Sync Document. Default value is ‘false`.

Returns:



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 189

def update(
    read: nil, 
    write: nil, 
    manage: nil
)

    data = Twilio::Values.of({
        'Read' => read,
        'Write' => write,
        'Manage' => manage,
    })

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