Class: Twilio::REST::Preview::Sync::ServiceContext::SyncMapContext::SyncMapPermissionInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, map_sid: nil, identity: nil) ⇒ SyncMapPermissionInstance

Initialize the SyncMapPermissionInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this SyncMapPermission resource.

  • sid (String) —

    The SID of the Call resource to fetch.



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_permission.rb', line 257

def initialize(version, payload , service_sid: nil, map_sid: nil, identity: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'service_sid' => payload['service_sid'],
        'map_sid' => payload['map_sid'],
        'identity' => payload['identity'],
        'read' => payload['read'],
        'write' => payload['write'],
        'manage' => payload['manage'],
        'url' => payload['url'],
    }

    # Context
    @instance_context = nil
    @params = { 'service_sid' => service_sid  || @properties['service_sid']  ,'map_sid' => map_sid  || @properties['map_sid']  ,'identity' => identity  || @properties['identity']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The unique SID identifier of the Twilio Account.

Returns:

  • (String) —

    The unique SID identifier of the Twilio Account.



290
291
292
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_permission.rb', line 290

def 
    @properties['account_sid']
end

#context ⇒ SyncMapPermissionContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



281
282
283
284
285
286
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_permission.rb', line 281

def context
    unless @instance_context
        @instance_context = SyncMapPermissionContext.new(@version , @params['service_sid'], @params['map_sid'], @params['identity'])
    end
    @instance_context
end

#delete ⇒ Boolean

Delete the SyncMapPermissionInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



339
340
341
342
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_permission.rb', line 339

def delete

    context.delete
end

#fetch ⇒ SyncMapPermissionInstance

Fetch the SyncMapPermissionInstance

Returns:



347
348
349
350
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_permission.rb', line 347

def fetch

    context.fetch
end

#identity ⇒ String

Returns Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.

Returns:

  • (String) —

    Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.



308
309
310
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_permission.rb', line 308

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



380
381
382
383
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_permission.rb', line 380

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Preview.Sync.SyncMapPermissionInstance #{values}>"
end

#manage ⇒ Boolean

Returns Boolean flag specifying whether the identity can delete the Sync Map.

Returns:

  • (Boolean) —

    Boolean flag specifying whether the identity can delete the Sync Map.



326
327
328
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_permission.rb', line 326

def manage
    @properties['manage']
end

#map_sid ⇒ String

Returns The unique SID identifier of the Sync Map to which the Permission applies.

Returns:

  • (String) —

    The unique SID identifier of the Sync Map to which the Permission applies.



302
303
304
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_permission.rb', line 302

def map_sid
    @properties['map_sid']
end

#read ⇒ Boolean

Returns Boolean flag specifying whether the identity can read the Sync Map and its Items.

Returns:

  • (Boolean) —

    Boolean flag specifying whether the identity can read the Sync Map and its Items.



314
315
316
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_permission.rb', line 314

def read
    @properties['read']
end

#service_sid ⇒ String

Returns The unique SID identifier of the Sync Service Instance.

Returns:

  • (String) —

    The unique SID identifier of the Sync Service Instance.



296
297
298
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_permission.rb', line 296

def service_sid
    @properties['service_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



373
374
375
376
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_permission.rb', line 373

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Preview.Sync.SyncMapPermissionInstance #{values}>"
end

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

Update the SyncMapPermissionInstance

Parameters:

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

    Boolean flag specifying whether the identity can read the Sync Map.

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

    Boolean flag specifying whether the identity can create, update and delete Items of the Sync Map.

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

    Boolean flag specifying whether the identity can delete the Sync Map.

Returns:



358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_permission.rb', line 358

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

    context.update(
        read: read, 
        write: write, 
        manage: manage, 
    )
end

#url ⇒ String

Returns Contains an absolute URL for this Sync Map Permission.

Returns:

  • (String) —

    Contains an absolute URL for this Sync Map Permission.



332
333
334
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_permission.rb', line 332

def url
    @properties['url']
end

#write ⇒ Boolean

Returns Boolean flag specifying whether the identity can create, update and delete Items of the Sync Map.

Returns:

  • (Boolean) —

    Boolean flag specifying whether the identity can create, update and delete Items of the Sync Map.



320
321
322
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_permission.rb', line 320

def write
    @properties['write']
end