twilio.rest.frontline_api.v1 package

Submodules

twilio.rest.frontline_api.v1.user module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/frontline_api/v1/user.py:docstring of twilio.rest.frontline_api.v1.user, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.frontline_api.v1.user.UserContext(version, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

fetch()[source]

Fetch the UserInstance

Returns:The fetched UserInstance
Return type:twilio.rest.frontline_api.v1.user.UserInstance
update(friendly_name=<object object>, avatar=<object object>, state=<object object>, is_available=<object object>)[source]

Update the UserInstance

Parameters:
  • friendly_name (unicode) – The string that you assigned to describe the User
  • avatar (unicode) – The avatar URL which will be shown in Frontline application
  • state (UserInstance.StateType) – Current state of this user
  • is_available (bool) – Whether the User is available for new conversations
Returns:

The updated UserInstance

Return type:

twilio.rest.frontline_api.v1.user.UserInstance

class twilio.rest.frontline_api.v1.user.UserInstance(version, payload, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

class StateType[source]

Bases: object

ACTIVE = 'active'
DEACTIVATED = 'deactivated'
avatar
Returns:The avatar URL which will be shown in Frontline application
Return type:unicode
fetch()[source]

Fetch the UserInstance

Returns:The fetched UserInstance
Return type:twilio.rest.frontline_api.v1.user.UserInstance
friendly_name
Returns:The string that you assigned to describe the User
Return type:unicode
identity
Returns:The string that identifies the resource’s User
Return type:unicode
is_available
Returns:Whether the User is available for new conversations
Return type:bool
sid
Returns:The unique string that identifies the resource
Return type:unicode
state
Returns:Current state of this user
Return type:UserInstance.StateType
update(friendly_name=<object object>, avatar=<object object>, state=<object object>, is_available=<object object>)[source]

Update the UserInstance

Parameters:
  • friendly_name (unicode) – The string that you assigned to describe the User
  • avatar (unicode) – The avatar URL which will be shown in Frontline application
  • state (UserInstance.StateType) – Current state of this user
  • is_available (bool) – Whether the User is available for new conversations
Returns:

The updated UserInstance

Return type:

twilio.rest.frontline_api.v1.user.UserInstance

url
Returns:An absolute URL for this user.
Return type:unicode
class twilio.rest.frontline_api.v1.user.UserList(version)[source]

Bases: twilio.base.list_resource.ListResource

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

get(sid)[source]

Constructs a UserContext

Parameters:sid – The SID of the User resource to fetch
Returns:twilio.rest.frontline_api.v1.user.UserContext
Return type:twilio.rest.frontline_api.v1.user.UserContext
class twilio.rest.frontline_api.v1.user.UserPage(version, response, solution)[source]

Bases: twilio.base.page.Page

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

get_instance(payload)[source]

Build an instance of UserInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.frontline_api.v1.user.UserInstance
Return type:twilio.rest.frontline_api.v1.user.UserInstance

Module contents

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/frontline_api/v1/__init__.py:docstring of twilio.rest.frontline_api.v1, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.frontline_api.v1.V1(domain)[source]

Bases: twilio.base.version.Version

users
Return type:twilio.rest.frontline_api.v1.user.UserList