Class: Twilio::REST::Chat::V2::ServiceContext::ChannelContext::InviteInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb

Instance Method Summary collapse

Constructor Details

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

Initialize the InviteInstance

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

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

    The channel_sid

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

    The sid



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 239

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

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'channel_sid' => payload['channel_sid'],
      'service_sid' => payload['service_sid'],
      'identity' => payload['identity'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'role_sid' => payload['role_sid'],
      'created_by' => payload['created_by'],
      'url' => payload['url'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns The account_sid.

Returns:

  • (String) —

    The account_sid



289
290
291
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 289

def 
  @properties['account_sid']
end

#channel_sid ⇒ String

Returns The channel_sid.

Returns:

  • (String) —

    The channel_sid



295
296
297
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 295

def channel_sid
  @properties['channel_sid']
end

#context ⇒ InviteContext

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

Returns:



269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 269

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

#created_by ⇒ String

Returns The created_by.

Returns:

  • (String) —

    The created_by



331
332
333
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 331

def created_by
  @properties['created_by']
end

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



313
314
315
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 313

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



319
320
321
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 319

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the InviteInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



351
352
353
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 351

def delete
  context.delete
end

#fetch ⇒ InviteInstance

Fetch a InviteInstance

Returns:



344
345
346
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 344

def fetch
  context.fetch
end

#identity ⇒ String

Returns The identity.

Returns:

  • (String) —

    The identity



307
308
309
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 307

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



364
365
366
367
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 364

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

#role_sid ⇒ String

Returns The role_sid.

Returns:

  • (String) —

    The role_sid



325
326
327
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 325

def role_sid
  @properties['role_sid']
end

#service_sid ⇒ String

Returns The service_sid.

Returns:

  • (String) —

    The service_sid



301
302
303
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 301

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



283
284
285
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 283

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



357
358
359
360
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 357

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

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



337
338
339
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 337

def url
  @properties['url']
end