Automattic\WooCommerce\Internal\EmailEditor

EmailApiController::get_reset_schema │ public │ WC 1.0

Get the schema for the reset endpoint response.

Method of the class: EmailApiController{}

No Hooks.

Returns

Array.

Usage

$EmailApiController = new EmailApiController();
$EmailApiController->get_reset_schema(): array;

EmailApiController::get_reset_schema() EmailApiController::get reset schema code ^{WC 10.9.1}

public function get_reset_schema(): array {
	return array(
		'$schema'    => 'http://json-schema.org/draft-04/schema#',
		'title'      => 'woo_email_reset',
		'type'       => 'object',
		'properties' => array(
			'content'     => array(
				'description' => __( 'The canonical block content written to the post.', 'woocommerce' ),
				'type'        => 'string',
				'readonly'    => true,
			),
			'version'     => array(
				'description' => __( 'The core block template @version stamped on the post, or null when the email is not sync-enabled.', 'woocommerce' ),
				'type'        => array( 'string', 'null' ),
				'readonly'    => true,
			),
			'source_hash' => array(
				'description' => __( 'sha1 of the canonical block content stamped on the post, or null when the email is not sync-enabled.', 'woocommerce' ),
				'type'        => array( 'string', 'null' ),
				'readonly'    => true,
			),
			'synced_at'   => array(
				'description' => __( 'UTC timestamp when the post was stamped (Y-m-d H:i:s), or null when the email is not sync-enabled.', 'woocommerce' ),
				'type'        => array( 'string', 'null' ),
				'readonly'    => true,
			),
			'status'      => array(
				'description' => __( 'The post-reset sync status (in_sync on success for sync-enabled emails, null otherwise).', 'woocommerce' ),
				'type'        => array( 'string', 'null' ),
				'readonly'    => true,
			),
		),
	);
}