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:



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 264

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 unique id of the Account responsible for this member.

Returns:

  • (String) —

    The unique id of the Account responsible for this member.



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

def 
  @properties['account_sid']
end

#channel_sid ⇒ String

Returns The unique id of the Channel for this member.

Returns:

  • (String) —

    The unique id of the Channel for this member.



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

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:



294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 294

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



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

def created_by
  @properties['created_by']
end

#date_created ⇒ Time

Returns The date that this resource was created.

Returns:

  • (Time) —

    The date that this resource was created.



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this resource was last updated.

Returns:

  • (Time) —

    The date that this resource was last updated.



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the InviteInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ InviteInstance

Fetch a InviteInstance

Returns:



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

def fetch
  context.fetch
end

#identity ⇒ String

Returns A unique string identifier for this User in this Service.

Returns:

  • (String) —

    A unique string identifier for this User in this Service.



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

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#role_sid ⇒ String

Returns The Role assigned to this member.

Returns:

  • (String) —

    The Role assigned to this member.



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

def role_sid
  @properties['role_sid']
end

#service_sid ⇒ String

Returns The unique id of the Service this member belongs to.

Returns:

  • (String) —

    The unique id of the Service this member belongs to.



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this resource.



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#url ⇒ String

Returns An absolute URL for this member.

Returns:

  • (String) —

    An absolute URL for this member.



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

def url
  @properties['url']
end