Class: Twilio::REST::Sync::V1::ServiceContext::SyncMapContext::SyncMapPermissionContext

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

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, map_sid, identity) ⇒ SyncMapPermissionContext

Initialize the SyncMapPermissionContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String) —

    The SID of the Sync Service with the Sync Map Permission resource to fetch. Can be the Service's `sid` value or `default`.

  • map_sid (String) —

    The SID of the Sync Map with the Sync Map Permission resource to fetch. Can be the Sync Map resource's `sid` or its `unique_name`.

  • identity (String) —

    The application-defined string that uniquely identifies the User's Sync Map Permission resource to fetch.


165
166
167
168
169
170
171
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb', line 165

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

  # Path Solution
  @solution = {service_sid: service_sid, map_sid: map_sid, identity: identity, }
  @uri = "/Services/#{@solution[:service_sid]}/Maps/#{@solution[:map_sid]}/Permissions/#{@solution[:identity]}"
end

Instance Method Details

#delete ⇒ Boolean

Delete the SyncMapPermissionInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


191
192
193
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb', line 191

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

#fetch ⇒ SyncMapPermissionInstance

Fetch the SyncMapPermissionInstance

Returns:


176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb', line 176

def fetch
  payload = @version.fetch('GET', @uri)

  SyncMapPermissionInstance.new(
      @version,
      payload,
      service_sid: @solution[:service_sid],
      map_sid: @solution[:map_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/sync_map/sync_map_permission.rb', line 227

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

#to_s ⇒ Object

Provide a user friendly representation


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

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

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

Update the SyncMapPermissionInstance

Parameters:

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

    Whether the identity can read the Sync Map and its Items. Default value is `false`.

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

    Whether the identity can create, update, and delete Items in the Sync Map. Default value is `false`.

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

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

Returns:


204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb', line 204

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

  payload = @version.update('POST', @uri, data: data)

  SyncMapPermissionInstance.new(
      @version,
      payload,
      service_sid: @solution[:service_sid],
      map_sid: @solution[:map_sid],
      identity: @solution[:identity],
  )
end