Class: Twilio::REST::IpMessaging::V1::ServiceContext::ChannelContext::InviteContext

Inherits:

Twilio::REST::InstanceContext

• Object
• Twilio::REST::InstanceContext
• Twilio::REST::IpMessaging::V1::ServiceContext::ChannelContext::InviteContext

Defined in:

lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb

Instance Method Summary

• #delete ⇒ Boolean

  Deletes the InviteInstance.

• #fetch ⇒ InviteInstance

  Fetch a InviteInstance.

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

  Initialize the InviteContext.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #to_s ⇒ Object

  Provide a user friendly representation.

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/api/chat/rest/services) to fetch the resource from.

• channel_sid (String) —

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

• sid (String) —

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

# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb', line 215

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

Deletes the InviteInstance

Returns:

• (Boolean) —

  true if delete succeeds, true otherwise

# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb', line 247

def delete
  @version.delete('delete', @uri)
end

#fetch ⇒ InviteInstance

Fetch a InviteInstance

Returns:

• (InviteInstance) —

  Fetched InviteInstance

# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb', line 226

def fetch
  params = Twilio::Values.of({})

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

  InviteInstance.new(
      @version,
      payload,
      service_sid: @solution[:service_sid],
      channel_sid: @solution[:channel_sid],
      sid: @solution[:sid],
  )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb', line 260

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

#to_s ⇒ Object

Provide a user friendly representation

# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb', line 253

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