NAME
Auth
FUNCTIONS
- new($api)
-
Create a new object for accessing Auth API
Parameters
$api
API object
- get_trays
-
Get trays
Return value
JSON response as a string
- get_tray_by_type
-
Get tray by type
Parameters
$username
Username
$type
Thread type
Return value
JSON response as a string
- get_thread_details
-
List thread details based on thread id
Parameters
$username
Username
$thread_id
Thread ID
Return value
JSON response as a string
- get_thread_by_context
-
Get a specific thread by context
Parameters
$username
Username
$job_key
Thread ID
$application_id
Application ID
$context
Optional, by default 'Interviews'. Context
Return value
JSON response as a string
- get_thread_by_context_last_posts
-
Get a specific thread by context (last message content)
Parameters
$username
Username
$job_key
Thread ID
$application_id
Application ID
$context
Context
Return value
JSON response as a string
- start_new_thread
-
Send new message
Parameters
$username
Username
$params
Hash of parameters
Return value
JSON response as a string
- reply_to_thread
-
Reply to existent thread
Parameters
$username
Username
$thread_id
Thread ID
$params
Hash of parameters
Return value
JSON response as a string
- mark_thread
-
Update threads based on user actions
Parameters
$username
Username
$thread_id
Thread ID
$params
Hash of parameters
Return value
JSON response as a string
AUTHOR
Maksym Novozhylov <mnovozhilov@upwork.com>
COPYRIGHT
Copyright © Upwork Global Corp., 2015