Automattic\WooCommerce\Internal\RestApi\Routes\V4\Settings\Emails\Schema

EmailsSettingsSchema::get_item_schema_properties │ public │ WC 1.0

Return all properties for the item schema.

Method of the class: EmailsSettingsSchema{}

No Hooks.

Returns

Array.

Usage

$EmailsSettingsSchema = new EmailsSettingsSchema();
$EmailsSettingsSchema->get_item_schema_properties(): array;

EmailsSettingsSchema::get_item_schema_properties() EmailsSettingsSchema::get item schema properties code ^{WC 10.4.3}

public function get_item_schema_properties(): array {
	return array(
		'id'                => array(
			'description' => __( 'Email template ID.', 'woocommerce' ),
			'type'        => 'string',
			'context'     => self::VIEW_EDIT_CONTEXT,
			'readonly'    => true,
		),
		'title'             => array(
			'description' => __( 'Email title.', 'woocommerce' ),
			'type'        => 'string',
			'context'     => self::VIEW_EDIT_CONTEXT,
			'readonly'    => true,
		),
		'description'       => array(
			'description' => __( 'Email description.', 'woocommerce' ),
			'type'        => 'string',
			'context'     => self::VIEW_EDIT_CONTEXT,
			'readonly'    => true,
		),
		'post_id'           => array(
			'description' => __( 'Template post ID.', 'woocommerce' ),
			'type'        => array( 'integer', 'null' ),
			'context'     => self::VIEW_EDIT_CONTEXT,
			'readonly'    => true,
		),
		'link'              => array(
			'description' => __( 'Link to template editor.', 'woocommerce' ),
			'type'        => 'string',
			'format'      => 'uri',
			'context'     => self::VIEW_EDIT_CONTEXT,
			'readonly'    => true,
		),
		'email_group'       => array(
			'description' => __( 'Email group identifier.', 'woocommerce' ),
			'type'        => 'string',
			'context'     => self::VIEW_EDIT_CONTEXT,
			'readonly'    => true,
		),
		'email_group_title' => array(
			'description' => __( 'Email group title.', 'woocommerce' ),
			'type'        => 'string',
			'context'     => self::VIEW_EDIT_CONTEXT,
			'readonly'    => true,
		),
		'is_customer_email' => array(
			'description' => __( 'Whether this is a customer email.', 'woocommerce' ),
			'type'        => 'boolean',
			'context'     => self::VIEW_EDIT_CONTEXT,
			'readonly'    => true,
		),
		'is_manual'         => array(
			'description' => __( 'Whether this is sent only manually.', 'woocommerce' ),
			'type'        => 'boolean',
			'context'     => self::VIEW_EDIT_CONTEXT,
			'readonly'    => true,
		),
		'values'            => array(
			'description'          => __( 'Flat key-value mapping of all setting field values.', 'woocommerce' ),
			'type'                 => 'object',
			'context'              => self::VIEW_EDIT_CONTEXT,
			'additionalProperties' => array(
				'description' => __( 'Setting field value.', 'woocommerce' ),
				'type'        => array( 'string', 'number', 'array', 'boolean' ),
			),
		),
		'groups'            => array(
			'description'          => __( 'Collection of setting groups.', 'woocommerce' ),
			'type'                 => 'object',
			'context'              => self::VIEW_EDIT_CONTEXT,
			'additionalProperties' => array(
				'type'        => 'object',
				'description' => __( 'Settings group.', 'woocommerce' ),
				'properties'  => array(
					'title'       => array(
						'description' => __( 'Group title.', 'woocommerce' ),
						'type'        => 'string',
						'context'     => self::VIEW_EDIT_CONTEXT,
					),
					'description' => array(
						'description' => __( 'Group description.', 'woocommerce' ),
						'type'        => 'string',
						'context'     => self::VIEW_EDIT_CONTEXT,
					),
					'order'       => array(
						'description' => __( 'Display order for the group.', 'woocommerce' ),
						'type'        => 'integer',
						'context'     => self::VIEW_EDIT_CONTEXT,
						'readonly'    => true,
					),
					'fields'      => array(
						'description' => __( 'Settings fields.', 'woocommerce' ),
						'type'        => 'array',
						'context'     => self::VIEW_EDIT_CONTEXT,
						'items'       => $this->get_field_schema(),
					),
				),
			),
		),
	);
}