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

Inherits:
Twilio::REST::InstanceResource show all
Defined in:
lib/twilio-ruby/rest/ip_messaging/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 SID of the [Service](www.twilio.com/docs/chat/rest/service-resource) the Invite resource is associated with.

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

    The SID of the [Channel](www.twilio.com/docs/chat/channels) the Invite resource belongs to.

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

    The SID of the Invite resource to fetch.



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 275

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 SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



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

def 
  @properties['account_sid']
end

#channel_sid ⇒ String

Returns The SID of the Channel the new resource belongs to.

Returns:

  • (String) —

    The SID of the Channel the new resource belongs to



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

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:



305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 305

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 identity of the User that created the invite.

Returns:

  • (String) —

    The identity of the User that created the invite



367
368
369
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 367

def created_by
  @properties['created_by']
end

#date_created ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was last updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the InviteInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



387
388
389
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 387

def delete
  context.delete
end

#fetch ⇒ InviteInstance

Fetch a InviteInstance

Returns:



380
381
382
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 380

def fetch
  context.fetch
end

#identity ⇒ String

Returns The string that identifies the resource’s User.

Returns:

  • (String) —

    The string that identifies the resource’s User



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

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



400
401
402
403
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 400

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

#role_sid ⇒ String

Returns The SID of the Role assigned to the member.

Returns:

  • (String) —

    The SID of the Role assigned to the member



361
362
363
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 361

def role_sid
  @properties['role_sid']
end

#service_sid ⇒ String

Returns The SID of the Service that the resource is associated with.

Returns:

  • (String) —

    The SID of the Service that the resource is associated with



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



393
394
395
396
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 393

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

#url ⇒ String

Returns The absolute URL of the Invite resource.

Returns:

  • (String) —

    The absolute URL of the Invite resource



373
374
375
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 373

def url
  @properties['url']
end