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


228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb', line 228

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_sidString

Returns The account_sid.

Returns:

  • (String)

    The account_sid


268
269
270
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb', line 268

def 
  @properties['account_sid']
end

#contextRoleContext

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

Returns:


253
254
255
256
257
258
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb', line 253

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

#date_createdTime

Returns The date_created.

Returns:

  • (Time)

    The date_created


298
299
300
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb', line 298

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The date_updated.

Returns:

  • (Time)

    The date_updated


304
305
306
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb', line 304

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the RoleInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


324
325
326
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb', line 324

def delete
  context.delete
end

#fetchRoleInstance

Fetch the RoleInstance

Returns:


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

def fetch
  context.fetch
end

#friendly_nameString

Returns The friendly_name.

Returns:

  • (String)

    The friendly_name


280
281
282
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb', line 280

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation


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

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

#permissionsArray[String]

Returns The permissions.

Returns:

  • (Array[String])

    The permissions


292
293
294
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb', line 292

def permissions
  @properties['permissions']
end

#service_sidString

Returns The service_sid.

Returns:

  • (String)

    The service_sid


274
275
276
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb', line 274

def service_sid
  @properties['service_sid']
end

#sidString

Returns The sid.

Returns:

  • (String)

    The sid


262
263
264
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb', line 262

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation


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

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

#typerole.RoleType

Returns The type.

Returns:

  • (role.RoleType)

    The type


286
287
288
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb', line 286

def type
  @properties['type']
end

#update(permission: nil) ⇒ RoleInstance

Update the RoleInstance

Parameters:

  • permission (Array[String]) (defaults to: nil)

    The permission

Returns:


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

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

#urlString

Returns The url.

Returns:

  • (String)

    The url


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

def url
  @properties['url']
end