WC_REST_Customer_Downloads_V2_Controller::get_item_schema │ public │ WC 1.0

Get the Customer Download's schema, conforming to JSON Schema.

Method of the class: WC_REST_Customer_Downloads_V2_Controller{}

No Hooks.

Returns

Array.

Usage

$WC_REST_Customer_Downloads_V2_Controller = new WC_REST_Customer_Downloads_V2_Controller();
$WC_REST_Customer_Downloads_V2_Controller->get_item_schema();

WC_REST_Customer_Downloads_V2_Controller::get_item_schema() WC REST Customer Downloads V2 Controller::get item schema code ^{WC 10.3.6}

public function get_item_schema() {
	$schema = array(
		'$schema'    => 'http://json-schema.org/draft-04/schema#',
		'title'      => 'customer_download',
		'type'       => 'object',
		'properties' => array(
			'download_id'         => array(
				'description' => __( 'Download ID.', 'woocommerce' ),
				'type'        => 'string',
				'context'     => array( 'view' ),
				'readonly'    => true,
			),
			'download_url'        => array(
				'description' => __( 'Download file URL.', 'woocommerce' ),
				'type'        => 'string',
				'context'     => array( 'view' ),
				'readonly'    => true,
			),
			'product_id'          => array(
				'description' => __( 'Downloadable product ID.', 'woocommerce' ),
				'type'        => 'integer',
				'context'     => array( 'view' ),
				'readonly'    => true,
			),
			'product_name'        => array(
				'description' => __( 'Product name.', 'woocommerce' ),
				'type'        => 'string',
				'context'     => array( 'view' ),
				'readonly'    => true,
			),
			'download_name'       => array(
				'description' => __( 'Downloadable file name.', 'woocommerce' ),
				'type'        => 'string',
				'context'     => array( 'view' ),
				'readonly'    => true,
			),
			'order_id'            => array(
				'description' => __( 'Order ID.', 'woocommerce' ),
				'type'        => 'integer',
				'context'     => array( 'view' ),
				'readonly'    => true,
			),
			'order_key'           => array(
				'description' => __( 'Order key.', 'woocommerce' ),
				'type'        => 'string',
				'context'     => array( 'view' ),
				'readonly'    => true,
			),
			'downloads_remaining' => array(
				'description' => __( 'Number of downloads remaining.', 'woocommerce' ),
				'type'        => 'string',
				'context'     => array( 'view' ),
				'readonly'    => true,
			),
			'access_expires'      => array(
				'description' => __( "The date when download access expires, in the site's timezone.", 'woocommerce' ),
				'type'        => 'string',
				'context'     => array( 'view' ),
				'readonly'    => true,
			),
			'access_expires_gmt'  => array(
				'description' => __( 'The date when download access expires, as GMT.', 'woocommerce' ),
				'type'        => 'string',
				'context'     => array( 'view' ),
				'readonly'    => true,
			),
			'file'                => array(
				'description' => __( 'File details.', 'woocommerce' ),
				'type'        => 'object',
				'context'     => array( 'view' ),
				'readonly'    => true,
				'properties'  => array(
					'name' => array(
						'description' => __( 'File name.', 'woocommerce' ),
						'type'        => 'string',
						'context'     => array( 'view' ),
						'readonly'    => true,
					),
					'file' => array(
						'description' => __( 'File URL.', 'woocommerce' ),
						'type'        => 'string',
						'context'     => array( 'view' ),
						'readonly'    => true,
					),
				),
			),
		),
	);

	return $this->add_additional_fields_schema( $schema );
}