Class: JobAgentClient
API client to make requests to the Job Agent API.
Constructors
Constructor
new JobAgentClient(
basePath,backend?):JobAgentClient
Parameters
basePath
string
backend?
HttpBackend = fetchBackend
Returns
JobAgentClient
Methods
activate()
activate(
customerId,language,code,type):Promise<void>
Activates an existing Job Agent.
Parameters
customerId
string
Your customer id.
language
string
The language to request.
code
string
The code of the Job Agent.
type
string
The type of the Job Agent.
Returns
Promise<void>
createJobAgent()
createJobAgent(
customerId,language,jobAgent,type):Promise<void>
Creates a new Job Agent.
Parameters
customerId
string
Your customer id.
language
string
The language to request.
jobAgent
The Job Agent to create.
type
string
The type of the Job Agent.
Returns
Promise<void>
deleteJobAgent()
deleteJobAgent(
customerId,language,jobAgentId,code,type):Promise<void>
Deletes an existing Job Agent.
Parameters
customerId
string
Your customer id.
language
string
The language to request.
jobAgentId
string
The id of the Job Agent.
code
string
The code of the Job Agent.
type
string
The type of the Job Agent.
Returns
Promise<void>
getJobAgent()
getJobAgent(
customerId,language,jobAgentId,code,type):Promise<JobAgent>
Returns a specific Job Agent.
Parameters
customerId
string
Your customer id.
language
string
The language to request.
jobAgentId
string
The id of the Job Agent.
code
string
The code of the Job Agent.
type
string
The type of the Job Agent.
Returns
Promise<JobAgent>
getJobAgentConfiguration()
getJobAgentConfiguration(
customerId,language):Promise<JobAgentConfiguration>
Returns the site settings for Job Agents.
Parameters
customerId
string
Your customer id.
language
string
The language to request.
Returns
Promise<JobAgentConfiguration>
getJobAgentType()
getJobAgentType(
customerId,language,type):Promise<JobAgentType>
Returns the settings for a specific Job Agent type.
Parameters
customerId
string
Your customer id.
language
string
The language to request.
type
string
The id of a Job Agent type.
Returns
Promise<JobAgentType>
resendEmail()
resendEmail(
customerId,language,type):Promise<void>
Tries to email the user allowing them to activate/modify/delete their Job Agent. This API always returns success, even if the email was not found in the system to prevent checking if emails are in the system or not.
Parameters
customerId
string
Your customer id.
language
string
The language to request.
email
string
The email that should be in the system to try to resent the recent Job Agent information to.
type
string
The type of the Job Agent.
Returns
Promise<void>
updateJobAgent()
updateJobAgent(
customerId,language,jobAgent,type):Promise<void>
Updates an existing Job Agent.
Parameters
customerId
string
Your customer id.
language
string
The language to request.
jobAgent
The Job Agent to change.
type
string
The type of the Job Agent.
Returns
Promise<void>