Class: Twilio::REST::IpMessaging::V2::ServiceContext::UserContext

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

Defined Under Namespace

Classes: UserBindingContext, UserBindingInstance, UserBindingList, UserBindingPage, UserChannelContext, UserChannelInstance, UserChannelList, UserChannelPage

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, sid) ⇒ UserContext

Initialize the UserContext



189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 189

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

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

  # Dependents
  @user_channels = nil
  @user_bindings = nil
end

Instance Method Details

#delete ⇒ Boolean

Deletes the UserInstance



219
220
221
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 219

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

#fetch ⇒ UserInstance

Fetch a UserInstance



204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 204

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

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

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



301
302
303
304
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 301

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

#to_s ⇒ Object

Provide a user friendly representation



294
295
296
297
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 294

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

#update(role_sid: :unset, attributes: :unset, friendly_name: :unset) ⇒ UserInstance

Update the UserInstance



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 232

def update(role_sid: :unset, attributes: :unset, friendly_name: :unset)
  data = Twilio::Values.of({
      'RoleSid' => role_sid,
      'Attributes' => attributes,
      'FriendlyName' => friendly_name,
  })

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

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

#user_bindings(sid = :unset) ⇒ UserBindingList, UserBindingContext

Access the user_bindings

Raises:

  • (ArgumentError) 


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

def user_bindings(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return UserBindingContext.new(@version, @solution[:service_sid], @solution[:sid], sid, )
  end

  unless @user_bindings
    @user_bindings = UserBindingList.new(
        @version,
        service_sid: @solution[:service_sid],
        user_sid: @solution[:sid],
    )
  end

  @user_bindings
end

#user_channels(channel_sid = :unset) ⇒ UserChannelList, UserChannelContext

Access the user_channels

Raises:

  • (ArgumentError) 


252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 252

def user_channels(channel_sid=:unset)
  raise ArgumentError, 'channel_sid cannot be nil' if channel_sid.nil?

  if channel_sid != :unset
    return UserChannelContext.new(@version, @solution[:service_sid], @solution[:sid], channel_sid, )
  end

  unless @user_channels
    @user_channels = UserChannelList.new(
        @version,
        service_sid: @solution[:service_sid],
        user_sid: @solution[:sid],
    )
  end

  @user_channels
end