Class: Twilio::REST::Conversations::V1::UserContext

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/conversations/v1/user.rb,
lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb

Defined Under Namespace

Classes: UserConversationContext, UserConversationInstance, UserConversationList, UserConversationPage

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ UserContext

Initialize the UserContext

Parameters:

  • version (Version)

    Version that contains the resource

  • sid (String)

    The SID of the User resource to fetch. This value can be either the `sid` or the `identity` of the User resource to fetch.


179
180
181
182
183
184
185
186
187
188
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 179

def initialize(version, sid)
  super(version)

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

  # Dependents
  @user_conversations = nil
end

Instance Method Details

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the UserInstance

Parameters:

  • x_twilio_webhook_enabled (user.WebhookEnabledType) (defaults to: :unset)

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


220
221
222
223
224
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 220

def delete(x_twilio_webhook_enabled: :unset)
  headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })

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

#fetchUserInstance

Fetch the UserInstance

Returns:


229
230
231
232
233
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 229

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

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

#inspectObject

Provide a detailed, user friendly representation


262
263
264
265
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 262

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

#to_sObject

Provide a user friendly representation


255
256
257
258
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 255

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

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

Update the UserInstance

Parameters:

  • friendly_name (String) (defaults to: :unset)

    The string that you assigned to describe the resource.

  • attributes (String) (defaults to: :unset)

    The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned.

  • role_sid (String) (defaults to: :unset)

    The SID of a service-level Role to assign to the user.

  • x_twilio_webhook_enabled (user.WebhookEnabledType) (defaults to: :unset)

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:


202
203
204
205
206
207
208
209
210
211
212
213
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 202

def update(friendly_name: :unset, attributes: :unset, role_sid: :unset, x_twilio_webhook_enabled: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'Attributes' => attributes,
      'RoleSid' => role_sid,
  })
  headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })

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

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

#user_conversations(conversation_sid = :unset) ⇒ UserConversationList, UserConversationContext

Access the user_conversations

Returns:

Raises:

  • (ArgumentError)

239
240
241
242
243
244
245
246
247
248
249
250
251
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 239

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

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

  unless @user_conversations
    @user_conversations = UserConversationList.new(@version, user_sid: @solution[:sid], )
  end

  @user_conversations
end