ESPRMAdminPassthrough
Defined in: src/ESPRMAdminPassthrough.ts:11
Shell class for admin external API passthrough operations. Methods are added via prototype augmentation in methods/ESPRMAdminPassthrough/*.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ESPRMAdminPassthrough():
ESPRMAdminPassthrough
Returns
Section titled “Returns”ESPRMAdminPassthrough
Methods
Section titled “Methods”createPassthroughConfig()
Section titled “createPassthroughConfig()”createPassthroughConfig(
params):Promise<CreatePassthroughConfigResponse>
Defined in: src/methods/ESPRMAdminPassthrough/CreatePassthroughConfig.ts:27
Creates a new external API passthrough configuration.
Parameters
Section titled “Parameters”params
Section titled “params”CreatePassthroughConfigRequest
The passthrough configuration details including service name.
Returns
Section titled “Returns”Promise<CreatePassthroughConfigResponse>
The response containing the created passthrough configuration.
getPassthroughConfig()
Section titled “getPassthroughConfig()”getPassthroughConfig(
params?):Promise<GetPassthroughConfigResponse>
Defined in: src/methods/ESPRMAdminPassthrough/GetPassthroughConfig.ts:22
Retrieves the external API passthrough configuration.
Parameters
Section titled “Parameters”params?
Section titled “params?”Optional filtering parameters for the passthrough config query.
Returns
Section titled “Returns”Promise<GetPassthroughConfigResponse>
The response containing passthrough configuration details.
updatePassthroughConfig()
Section titled “updatePassthroughConfig()”updatePassthroughConfig(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminPassthrough/UpdatePassthroughConfig.ts:22
Updates an existing external API passthrough configuration.
Parameters
Section titled “Parameters”params
Section titled “params”UpdatePassthroughConfigRequest
The updated passthrough configuration details.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the passthrough configuration was updated.