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

  • account_sid (String) —

    The SID of the Account that created this Invite resource.

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

    The SID of the Call resource to fetch.



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 255

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  || @properties['service_sid']  ,'channel_sid' => channel_sid  || @properties['channel_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Invite resource.

Returns:



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

def 
    @properties['account_sid']
end

#channel_sid ⇒ String

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

Returns:



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

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:



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

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.



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

def created_by
    @properties['created_by']
end

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the InviteInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetch ⇒ InviteInstance

Fetch the InviteInstance

Returns:



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

def fetch

    context.fetch
end

#identity ⇒ String

Returns The application-defined string that uniquely identifies the resource’s [User](www.twilio.com/docs/chat/rest/user-resource) within the [Service](www.twilio.com/docs/chat/rest/service-resource). See [access tokens](www.twilio.com/docs/chat/create-tokens) for more info.

Returns:



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

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#role_sid ⇒ String

Returns The SID of the [Role](www.twilio.com/docs/chat/rest/role-resource) assigned to the resource.

Returns:



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

def role_sid
    @properties['role_sid']
end

#service_sid ⇒ String

Returns The SID of the [Service](www.twilio.com/docs/chat/rest/service-resource) the Invite resource is associated with.

Returns:



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

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that we created to identify the Invite resource.

Returns:

  • (String) —

    The unique string that we created to identify the Invite resource.



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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#url ⇒ String

Returns The absolute URL of the Invite resource.

Returns:

  • (String) —

    The absolute URL of the Invite resource.



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

def url
    @properties['url']
end