class Twilio::REST::IpMessaging::V2::ServiceContext::RoleInstance
Public Class Methods
Initialize the RoleInstance
@param [Version] version Version
that contains the resource @param [Hash] payload payload that contains response from Twilio
@param [String] service_sid
The service_sid
@param [String] sid The sid @return [RoleInstance] RoleInstance
Twilio::REST::InstanceResource::new
# File lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb 228 def initialize(version, payload, service_sid: nil, sid: nil) 229 super(version) 230 231 # Marshaled Properties 232 @properties = { 233 'sid' => payload['sid'], 234 'account_sid' => payload['account_sid'], 235 'service_sid' => payload['service_sid'], 236 'friendly_name' => payload['friendly_name'], 237 'type' => payload['type'], 238 'permissions' => payload['permissions'], 239 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']), 240 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']), 241 'url' => payload['url'], 242 } 243 244 # Context 245 @instance_context = nil 246 @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid'], } 247 end
Public Instance Methods
@return [String] The account_sid
# File lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb 268 def account_sid 269 @properties['account_sid'] 270 end
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context @return [RoleContext] RoleContext
for this RoleInstance
# File lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb 253 def context 254 unless @instance_context 255 @instance_context = RoleContext.new(@version, @params['service_sid'], @params['sid'], ) 256 end 257 @instance_context 258 end
@return [Time] The date_created
# File lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb 298 def date_created 299 @properties['date_created'] 300 end
@return [Time] The date_updated
# File lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb 304 def date_updated 305 @properties['date_updated'] 306 end
Delete the RoleInstance
@return [Boolean] true if delete succeeds, false otherwise
# File lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb 324 def delete 325 context.delete 326 end
Fetch the RoleInstance
@return [RoleInstance] Fetched RoleInstance
# File lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb 317 def fetch 318 context.fetch 319 end
@return [String] The friendly_name
# File lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb 280 def friendly_name 281 @properties['friendly_name'] 282 end
Provide a detailed, user friendly representation
# File lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb 345 def inspect 346 values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") 347 "<Twilio.IpMessaging.V2.RoleInstance #{values}>" 348 end
@return [Array] The permissions
# File lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb 292 def permissions 293 @properties['permissions'] 294 end
@return [String] The service_sid
# File lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb 274 def service_sid 275 @properties['service_sid'] 276 end
@return [String] The sid
# File lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb 262 def sid 263 @properties['sid'] 264 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb 338 def to_s 339 values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") 340 "<Twilio.IpMessaging.V2.RoleInstance #{values}>" 341 end
@return [role.RoleType] The type
# File lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb 286 def type 287 @properties['type'] 288 end
Update the RoleInstance
@param [Array] permission The permission @return [RoleInstance] Updated RoleInstance
# File lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb 332 def update(permission: nil) 333 context.update(permission: permission, ) 334 end
@return [String] The url
# File lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb 310 def url 311 @properties['url'] 312 end