wp-calypso/test/e2e/specs/shared/api-delete-site.ts

import { RestAPIClient } from '@automattic/calypso-e2e';
import type { SiteDetails } from '@automattic/calypso-e2e';

/**
 * Makes an API request to delete a site.
 *
 * @param {RestAPIClient} client Client to interact with the WP REST API.
 * @param {SiteDetails} siteDetails Details of the site to be closed.
 */
export async function apiDeleteSite(
	client: RestAPIClient,
	siteDetails: SiteDetails
): Promise< void > {
	console.info( `Deleting siteID ${ siteDetails.id }` );

	const response = await client.deleteSite( { id: siteDetails.id, domain: siteDetails.url } );

	// If the response is `null` then no action has been
	// performed.
	if ( response ) {
		// The only correct response is the string "deleted".
		if ( response.status !== 'deleted' ) {
			console.warn(
				`Failed to delete siteID ${ siteDetails.id }.\nExpected: "deleted", Got: ${ response.status }`
			);
		} else {
			console.log( `Successfully deleted siteID ${ siteDetails.id }.` );
		}
	} else {
		console.log( `Failed to delete site ID ${ siteDetails.id }; no action performed.` );
	}
}