Class: Twilio::REST::Chat::V2::ServiceContext::ChannelContext::InviteContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, channel_sid, sid) ⇒ InviteContext

Initialize the InviteContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String) —

    The SID of the [Service](www.twilio.com/docs/chat/rest/service-resource) to fetch the Invite resource from.

  • channel_sid (String) —

    The SID of the [Channel](www.twilio.com/docs/chat/channels) the Invite resource to fetch belongs to. This value can be the Channel resource’s ‘sid` or `unique_name`.

  • sid (String) —

    The SID of the Invite resource to fetch.



248
249
250
251
252
253
254
255
256
257
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 248

def initialize(version, service_sid, channel_sid, sid)
    super(version)
    

    # Path Solution
    @solution = { service_sid: service_sid, channel_sid: channel_sid, sid: sid,  }
    @uri = "/Services/#{@solution[:service_sid]}/Channels/#{@solution[:channel_sid]}/Invites/#{@solution[:sid]}"

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the InviteInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



261
262
263
264
265
266
267
268
269
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 261

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    

    @version.delete('DELETE', @uri, headers: headers)
end

#delete_with_metadata ⇒ Boolean

Delete the InviteInstanceMetadata

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 274

def delete_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
      response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
      invite_instance = InviteInstance.new(
          @version,
          response.body,
          account_sid: @solution[:account_sid],
          sid: @solution[:sid],
      )
      InviteInstanceMetadata.new(@version, invite_instance, response.headers, response.status_code)
end

#fetch ⇒ InviteInstance

Fetch the InviteInstance

Returns:



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 293

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    InviteInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        channel_sid: @solution[:channel_sid],
        sid: @solution[:sid],
    )
end

#fetch_with_metadata ⇒ InviteInstance

Fetch the InviteInstanceMetadata

Returns:



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 314

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    invite_instance = InviteInstance.new(
        @version,
        response.body,
        service_sid: @solution[:service_sid],
        channel_sid: @solution[:channel_sid],
        sid: @solution[:sid],
    )
    InviteInstanceMetadata.new(
        @version,
        invite_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Chat.V2.InviteContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



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

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Chat.V2.InviteContext #{context}>"
end