ESPRMAdminMatter
Defined in: src/ESPRMAdminMatter.ts:11
Shell class for admin Matter setup operations. Methods are added via prototype augmentation in methods/ESPRMAdminMatter/*.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ESPRMAdminMatter():
ESPRMAdminMatter
Returns
Section titled “Returns”ESPRMAdminMatter
Methods
Section titled “Methods”createMatterAuth()
Section titled “createMatterAuth()”createMatterAuth(
params):Promise<MatterAuthKeyResponse>
Defined in: src/methods/ESPRMAdminMatter/CreateMatterAuth.ts:22
Creates Matter authentication credentials for the deployment.
Parameters
Section titled “Parameters”params
Section titled “params”The Matter authentication request parameters.
Returns
Section titled “Returns”Promise<MatterAuthKeyResponse>
The response containing the generated Matter auth key.
createMatterBatch()
Section titled “createMatterBatch()”createMatterBatch(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminMatter/CreateMatterBatch.ts:27
Creates a new Matter device batch for provisioning.
Parameters
Section titled “Parameters”params
Section titled “params”The batch creation parameters including batch ID.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the batch was created.
getMatterAuth()
Section titled “getMatterAuth()”getMatterAuth():
Promise<GetMatterAuthResponse>
Defined in: src/methods/ESPRMAdminMatter/GetMatterAuth.ts:20
Retrieves the current Matter authentication configuration.
Returns
Section titled “Returns”Promise<GetMatterAuthResponse>
The response containing Matter auth details.
getMatterBatch()
Section titled “getMatterBatch()”getMatterBatch(
params?):Promise<GetMatterBatchResponse>
Defined in: src/methods/ESPRMAdminMatter/GetMatterBatch.ts:22
Retrieves Matter device batch details.
Parameters
Section titled “Parameters”params?
Section titled “params?”Optional filtering parameters for the batch query.
Returns
Section titled “Returns”Promise<GetMatterBatchResponse>
The response containing Matter batch details.
getMatterBatchNodes()
Section titled “getMatterBatchNodes()”getMatterBatchNodes(
params):Promise<GetMatterBatchNodesResponse>
Defined in: src/methods/ESPRMAdminMatter/GetMatterBatchNodes.ts:27
Retrieves the list of nodes associated with a Matter batch.
Parameters
Section titled “Parameters”params
Section titled “params”The parameters including the batch ID to query nodes for.
Returns
Section titled “Returns”Promise<GetMatterBatchNodesResponse>
The response containing the batch’s node list.
updateMatterBatch()
Section titled “updateMatterBatch()”updateMatterBatch(
batchId,params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminMatter/UpdateMatterBatch.ts:28
Updates an existing Matter device batch configuration.
Parameters
Section titled “Parameters”batchId
Section titled “batchId”string
The identifier of the batch to update.
params
Section titled “params”The updated batch configuration details.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the batch was updated.