ESPRMAdminTermsPolicy
Defined in: src/ESPRMAdminTermsPolicy.ts:11
Shell class for admin terms and policy operations. Methods are added via prototype augmentation in methods/ESPRMAdminTermsPolicy/*.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ESPRMAdminTermsPolicy():
ESPRMAdminTermsPolicy
Returns
Section titled “Returns”ESPRMAdminTermsPolicy
Methods
Section titled “Methods”deleteTermsPolicy()
Section titled “deleteTermsPolicy()”deleteTermsPolicy(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminTermsPolicy/DeleteTermsPolicy.ts:22
Deletes a terms of service or privacy policy from the deployment.
Parameters
Section titled “Parameters”params
Section titled “params”The parameters identifying the terms/policy to delete.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A promise that resolves to a success response.
getTermsPolicy()
Section titled “getTermsPolicy()”getTermsPolicy(
params?):Promise<GetTermsPolicyResponse>
Defined in: src/methods/ESPRMAdminTermsPolicy/GetTermsPolicy.ts:22
Retrieves the current terms of service or privacy policy for the deployment.
Parameters
Section titled “Parameters”params?
Section titled “params?”Optional parameters to filter the terms/policy request.
Returns
Section titled “Returns”Promise<GetTermsPolicyResponse>
A promise that resolves to the terms/policy response.
updateTermsPolicy()
Section titled “updateTermsPolicy()”updateTermsPolicy(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminTermsPolicy/UpdateTermsPolicy.ts:22
Updates the terms of service or privacy policy for the deployment.
Parameters
Section titled “Parameters”params
Section titled “params”The terms/policy update request parameters.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A promise that resolves to a success response.