class Twilio::REST::IpMessaging::V1::ServiceContext::ChannelContext::InviteInstance
Public Class Methods
Initialize the InviteInstance
@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] channel_sid
The channel_sid
@param [String] sid The sid @return [InviteInstance] InviteInstance
Twilio::REST::InstanceResource::new
# File lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb 235 def initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil) 236 super(version) 237 238 # Marshaled Properties 239 @properties = { 240 'sid' => payload['sid'], 241 'account_sid' => payload['account_sid'], 242 'channel_sid' => payload['channel_sid'], 243 'service_sid' => payload['service_sid'], 244 'identity' => payload['identity'], 245 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']), 246 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']), 247 'role_sid' => payload['role_sid'], 248 'created_by' => payload['created_by'], 249 'url' => payload['url'], 250 } 251 252 # Context 253 @instance_context = nil 254 @params = { 255 'service_sid' => service_sid, 256 'channel_sid' => channel_sid, 257 'sid' => sid || @properties['sid'], 258 } 259 end
Public Instance Methods
@return [String] The account_sid
# File lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb 285 def account_sid 286 @properties['account_sid'] 287 end
@return [String] The channel_sid
# File lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb 291 def channel_sid 292 @properties['channel_sid'] 293 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 [InviteContext] InviteContext
for this InviteInstance
# File lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb 265 def context 266 unless @instance_context 267 @instance_context = InviteContext.new( 268 @version, 269 @params['service_sid'], 270 @params['channel_sid'], 271 @params['sid'], 272 ) 273 end 274 @instance_context 275 end
@return [String] The created_by
# File lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb 327 def created_by 328 @properties['created_by'] 329 end
@return [Time] The date_created
# File lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb 309 def date_created 310 @properties['date_created'] 311 end
@return [Time] The date_updated
# File lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb 315 def date_updated 316 @properties['date_updated'] 317 end
Delete the InviteInstance
@return [Boolean] true if delete succeeds, false otherwise
# File lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb 347 def delete 348 context.delete 349 end
Fetch the InviteInstance
@return [InviteInstance] Fetched InviteInstance
# File lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb 340 def fetch 341 context.fetch 342 end
@return [String] The identity
# File lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb 303 def identity 304 @properties['identity'] 305 end
Provide a detailed, user friendly representation
# File lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb 360 def inspect 361 values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") 362 "<Twilio.IpMessaging.V1.InviteInstance #{values}>" 363 end
@return [String] The role_sid
# File lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb 321 def role_sid 322 @properties['role_sid'] 323 end
@return [String] The service_sid
# File lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb 297 def service_sid 298 @properties['service_sid'] 299 end
@return [String] The sid
# File lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb 279 def sid 280 @properties['sid'] 281 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb 353 def to_s 354 values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") 355 "<Twilio.IpMessaging.V1.InviteInstance #{values}>" 356 end
@return [String] The url
# File lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb 333 def url 334 @properties['url'] 335 end