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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 258

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



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

def 
  @properties['account_sid']
end

#channel_sid ⇒ String

Returns The channel_sid.

Returns:

  • (String) —

    The channel_sid



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

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:



288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 288

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



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

def created_by
  @properties['created_by']
end

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the InviteInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



370
371
372
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 370

def delete
  context.delete
end

#fetch ⇒ InviteInstance

Fetch a InviteInstance

Returns:



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

def fetch
  context.fetch
end

#identity ⇒ String

Returns The identity.

Returns:

  • (String) —

    The identity



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

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



383
384
385
386
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 383

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



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

def role_sid
  @properties['role_sid']
end

#service_sid ⇒ String

Returns The service_sid.

Returns:

  • (String) —

    The service_sid



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



376
377
378
379
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 376

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



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

def url
  @properties['url']
end