Class: Twilio::REST::IpMessaging::V1::ServiceContext::RoleContext

Inherits:
Twilio::REST::InstanceContext show all
Defined in:
lib/twilio-ruby/rest/ip_messaging/v1/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)
  • sid (String)


162
163
164
165
166
167
168
169
170
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/role.rb', line 162

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



174
175
176
177
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/role.rb', line 174

def delete

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

#fetchRoleInstance

Fetch the RoleInstance

Returns:



182
183
184
185
186
187
188
189
190
191
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/role.rb', line 182

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



224
225
226
227
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/role.rb', line 224

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

#to_sObject

Provide a user friendly representation



217
218
219
220
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/role.rb', line 217

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

#update(permission: nil) ⇒ RoleInstance

Update the RoleInstance

Parameters:

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

Returns:



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
# File 'lib/twilio-ruby/rest/ip_messaging/v1/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