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/services) the resource is associated with.

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

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

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

    The Twilio-provided string that uniquely identifies the Invite resource to fetch.



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

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



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

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



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

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:



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

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



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

def created_by
  @properties['created_by']
end

#date_created ⇒ Time

Returns The RFC 2822 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT when the resource was created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The RFC 2822 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT when the resource was last updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the InviteInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ InviteInstance

Fetch a InviteInstance

Returns:



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

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



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

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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



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

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



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

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



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



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

def url
  @properties['url']
end