ESPRMAdminOTAImage
Defined in: src/ESPRMAdminOTAImage.ts:11
Shell class for admin OTA image management operations. Methods are added via prototype augmentation in methods/ESPRMAdminOTAImage/*.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ESPRMAdminOTAImage():
ESPRMAdminOTAImage
Returns
Section titled “Returns”ESPRMAdminOTAImage
Methods
Section titled “Methods”archiveImage()
Section titled “archiveImage()”archiveImage(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminOTAImage/ArchiveImage.ts:27
Archives an OTA firmware image by its image ID.
Parameters
Section titled “Parameters”params
Section titled “params”Parameters including the OTA image ID to archive.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the image was archived.
confirmPackageUpload()
Section titled “confirmPackageUpload()”confirmPackageUpload(
params):Promise<ConfirmOTAPackageUploadResponse>
Defined in: src/methods/ESPRMAdminOTAImage/ConfirmPackageUpload.ts:22
Confirms a completed OTA package (.zip) upload.
Parameters
Section titled “Parameters”params
Section titled “params”ConfirmOTAPackageUploadRequest
The file path, image name, and metadata.
Returns
Section titled “Returns”Promise<ConfirmOTAPackageUploadResponse>
The confirmation response with image ID.
confirmUpload()
Section titled “confirmUpload()”confirmUpload(
params):Promise<ConfirmOTAImageUploadResponse>
Defined in: src/methods/ESPRMAdminOTAImage/ConfirmUpload.ts:22
Confirms a completed OTA image upload.
Parameters
Section titled “Parameters”params
Section titled “params”The image ID and metadata to associate with the upload.
Returns
Section titled “Returns”Promise<ConfirmOTAImageUploadResponse>
The confirmation response with the image URL.
deleteImage()
Section titled “deleteImage()”deleteImage(
otaImageId):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminOTAImage/DeleteImage.ts:26
Deletes an OTA firmware image by its image ID.
Parameters
Section titled “Parameters”otaImageId
Section titled “otaImageId”string
The ID of the OTA image to delete.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the image was deleted.
getImages()
Section titled “getImages()”getImages(
params?):Promise<GetOTAImagesResponse>
Defined in: src/methods/ESPRMAdminOTAImage/GetImages.ts:22
Retrieves OTA firmware images with optional filtering parameters.
Parameters
Section titled “Parameters”params?
Section titled “params?”Optional query parameters to filter the image list.
Returns
Section titled “Returns”Promise<GetOTAImagesResponse>
The list of OTA images matching the specified criteria.
getPackageUploadUrl()
Section titled “getPackageUploadUrl()”getPackageUploadUrl(
params):Promise<OTAPackageUploadUrlResponse>
Defined in: src/methods/ESPRMAdminOTAImage/GetPackageUploadUrl.ts:22
Requests a pre-signed URL for uploading an OTA package (.zip) file.
Parameters
Section titled “Parameters”params
Section titled “params”The package file name.
Returns
Section titled “Returns”Promise<OTAPackageUploadUrlResponse>
The pre-signed upload URL.
getUploadUrl()
Section titled “getUploadUrl()”getUploadUrl(
params):Promise<OTAImageUploadUrlResponse>
Defined in: src/methods/ESPRMAdminOTAImage/GetUploadUrl.ts:22
Requests a pre-signed URL for uploading an OTA image file.
Parameters
Section titled “Parameters”params
Section titled “params”The image name and optional image type.
Returns
Section titled “Returns”Promise<OTAImageUploadUrlResponse>
The pre-signed upload URL and assigned OTA image ID.
uploadImage()
Section titled “uploadImage()”uploadImage(
params):Promise<OTAImageCreateResponse>
Defined in: src/methods/ESPRMAdminOTAImage/UploadImage.ts:22
Uploads a new OTA firmware image.
Parameters
Section titled “Parameters”params
Section titled “params”The image creation request including image metadata.
Returns
Section titled “Returns”Promise<OTAImageCreateResponse>
The response containing the created OTA image details.