ESPRMAdminOTAJob
Defined in: src/ESPRMAdminOTAJob.ts:11
Shell class for admin OTA job management operations. Methods are added via prototype augmentation in methods/ESPRMAdminOTAJob/*.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ESPRMAdminOTAJob():
ESPRMAdminOTAJob
Returns
Section titled “Returns”ESPRMAdminOTAJob
Methods
Section titled “Methods”createJob()
Section titled “createJob()”createJob(
body,options?):Promise<OTAJobCreateResponse>
Defined in: src/methods/ESPRMAdminOTAJob/CreateJob.ts:31
Creates a new OTA update job.
Body fields (job name, image, targets, metadata, secure boot, etc.) are sent
in the request body, while behavioural flags (force push, user approval, notify,
continuous, network serialised) are sent as query-string parameters, matching
the /admin/otajob REST contract.
Parameters
Section titled “Parameters”Job body fields.
options?
Section titled “options?”Optional behavioural flags sent as query parameters.
Returns
Section titled “Returns”Promise<OTAJobCreateResponse>
The response containing the created OTA job details.
deleteJob()
Section titled “deleteJob()”deleteJob(
otaJobId):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminOTAJob/DeleteJob.ts:26
Deletes an OTA job by its job ID.
Parameters
Section titled “Parameters”otaJobId
Section titled “otaJobId”string
The ID of the OTA job to delete.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the job was deleted.
getJob()
Section titled “getJob()”getJob(
params?):Promise<GetOTAJobsResponse>
Defined in: src/methods/ESPRMAdminOTAJob/GetJob.ts:22
Retrieves OTA jobs with optional filtering parameters.
Parameters
Section titled “Parameters”params?
Section titled “params?”Optional query parameters to filter the job list.
Returns
Section titled “Returns”Promise<GetOTAJobsResponse>
The list of OTA jobs matching the specified criteria.
getJobStatus()
Section titled “getJobStatus()”getJobStatus(
params):Promise<OTAJobStatusResponse>
Defined in: src/methods/ESPRMAdminOTAJob/GetJobStatus.ts:27
Retrieves the status of a specific OTA job.
Parameters
Section titled “Parameters”params
Section titled “params”Parameters including the OTA job ID to query.
Returns
Section titled “Returns”Promise<OTAJobStatusResponse>
The status details for the specified OTA job.
getJobStatusSummary()
Section titled “getJobStatusSummary()”getJobStatusSummary(
params):Promise<OTAJobStatusSummaryResponse>
Defined in: src/methods/ESPRMAdminOTAJob/GetJobStatusSummary.ts:28
Retrieves per-node OTA status counts for a job (triggered, in progress, etc.).
Parameters
Section titled “Parameters”params
Section titled “params”Must include ota_job_id.
Returns
Section titled “Returns”Promise<OTAJobStatusSummaryResponse>
retriggerJob()
Section titled “retriggerJob()”retriggerJob(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminOTAJob/RetriggerJob.ts:27
Retriggers a previously created OTA job for failed or pending nodes.
Parameters
Section titled “Parameters”params
Section titled “params”Parameters including the OTA job ID to retrigger.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the job was retriggered.
updateJob()
Section titled “updateJob()”updateJob(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminOTAJob/UpdateJob.ts:27
Updates an existing OTA job’s configuration.
Parameters
Section titled “Parameters”params
Section titled “params”The update parameters including the OTA job ID.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the job was updated.