Class: Twilio::REST::IpMessaging::V2::ServiceContext::RoleInstance

Inherits:
Twilio::REST::InstanceResource show all
Defined in:
lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, sid: nil) ⇒ RoleInstance

Initialize the RoleInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • service_sid (String) (defaults to: nil) —

    The service_sid

  • sid (String) (defaults to: nil) —

    The sid



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb', line 268

def initialize(version, payload, service_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'service_sid' => payload['service_sid'],
      'friendly_name' => payload['friendly_name'],
      'type' => payload['type'],
      'permissions' => payload['permissions'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'url' => payload['url'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns The account_sid.

Returns:

  • (String) —

    The account_sid



315
316
317
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb', line 315

def 
  @properties['account_sid']
end

#context ⇒ RoleContext

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

Returns:



296
297
298
299
300
301
302
303
304
305
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb', line 296

def context
  unless @instance_context
    @instance_context = RoleContext.new(
        @version,
        @params['service_sid'],
        @params['sid'],
    )
  end
  @instance_context
end

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



345
346
347
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb', line 345

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



351
352
353
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb', line 351

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the RoleInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



371
372
373
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb', line 371

def delete
  context.delete
end

#fetch ⇒ RoleInstance

Fetch a RoleInstance

Returns:



364
365
366
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb', line 364

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The friendly_name.

Returns:

  • (String) —

    The friendly_name



327
328
329
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb', line 327

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



394
395
396
397
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb', line 394

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

#permissions ⇒ String

Returns The permissions.

Returns:

  • (String) —

    The permissions



339
340
341
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb', line 339

def permissions
  @properties['permissions']
end

#service_sid ⇒ String

Returns The service_sid.

Returns:

  • (String) —

    The service_sid



321
322
323
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb', line 321

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



309
310
311
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb', line 309

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



387
388
389
390
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb', line 387

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

#type ⇒ role.RoleType

Returns The type.

Returns:

  • (role.RoleType) —

    The type



333
334
335
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb', line 333

def type
  @properties['type']
end

#update(permission: nil) ⇒ RoleInstance

Update the RoleInstance

Parameters:

  • permission (String) (defaults to: nil) —

    The permission

Returns:



379
380
381
382
383
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb', line 379

def update(permission: nil)
  context.update(
      permission: permission,
  )
end

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



357
358
359
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb', line 357

def url
  @properties['url']
end