Class: Twilio::REST::IpMessaging::V2::ServiceContext::RoleContext

Inherits:
Twilio::REST::InstanceContext show all
Defined in:
lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, sid) ⇒ RoleContext

Initialize the RoleContext

Parameters:

  • version (Version)

    Version that contains the resource

  • service_sid (String)

    The service_sid

  • sid (String)

    The sid


169
170
171
172
173
174
175
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb', line 169

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

  # Path Solution
  @solution = {service_sid: service_sid, sid: sid, }
  @uri = "/Services/#{@solution[:service_sid]}/Roles/#{@solution[:sid]}"
end

Instance Method Details

#deleteBoolean

Delete the RoleInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


189
190
191
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb', line 189

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

#fetchRoleInstance

Fetch the RoleInstance

Returns:


180
181
182
183
184
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb', line 180

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

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

#inspectObject

Provide a detailed, user friendly representation


214
215
216
217
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb', line 214

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

#to_sObject

Provide a user friendly representation


207
208
209
210
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb', line 207

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

#update(permission: nil) ⇒ RoleInstance

Update the RoleInstance

Parameters:

  • permission (Array[String]) (defaults to: nil)

    The permission

Returns:


197
198
199
200
201
202
203
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb', line 197

def update(permission: nil)
  data = Twilio::Values.of({'Permission' => Twilio.serialize_list(permission) { |e| e }, })

  payload = @version.update('POST', @uri, data: data)

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