woocommerce
/
includes
/
rest-api
/
Controllers
/
Version2
/
class-wc-rest-webhooks-v2-controller.php
class-wc-rest-coupons-v2-controller.php
2 months ago
class-wc-rest-customer-downloads-v2-controller.php
5 years ago
class-wc-rest-customers-v2-controller.php
2 months ago
class-wc-rest-network-orders-v2-controller.php
1 year ago
class-wc-rest-order-notes-v2-controller.php
5 years ago
class-wc-rest-order-refunds-v2-controller.php
2 months ago
class-wc-rest-orders-v2-controller.php
1 month ago
class-wc-rest-payment-gateways-v2-controller.php
11 months ago
class-wc-rest-product-attribute-terms-v2-controller.php
5 years ago
class-wc-rest-product-attributes-v2-controller.php
5 years ago
class-wc-rest-product-brands-v2-controller.php
1 year ago
class-wc-rest-product-categories-v2-controller.php
3 months ago
class-wc-rest-product-reviews-v2-controller.php
4 years ago
class-wc-rest-product-shipping-classes-v2-controller.php
5 years ago
class-wc-rest-product-tags-v2-controller.php
5 years ago
class-wc-rest-product-variations-v2-controller.php
2 months ago
class-wc-rest-products-v2-controller.php
2 months ago
class-wc-rest-report-sales-v2-controller.php
5 years ago
class-wc-rest-report-top-sellers-v2-controller.php
5 years ago
class-wc-rest-reports-v2-controller.php
5 years ago
class-wc-rest-setting-options-v2-controller.php
2 months ago
class-wc-rest-settings-v2-controller.php
5 years ago
class-wc-rest-shipping-methods-v2-controller.php
1 year ago
class-wc-rest-shipping-zone-locations-v2-controller.php
1 year ago
class-wc-rest-shipping-zone-methods-v2-controller.php
1 year ago
class-wc-rest-shipping-zones-v2-controller.php
1 month ago
class-wc-rest-system-status-tools-v2-controller.php
1 month ago
class-wc-rest-system-status-v2-controller.php
1 month ago
class-wc-rest-tax-classes-v2-controller.php
1 year ago
class-wc-rest-taxes-v2-controller.php
5 years ago
class-wc-rest-webhook-deliveries-v2-controller.php
5 years ago
class-wc-rest-webhooks-v2-controller.php
1 year ago
class-wc-rest-webhooks-v2-controller.php
183 lines
| 1 | <?php |
| 2 | /** |
| 3 | * REST API Webhooks controller |
| 4 | * |
| 5 | * Handles requests to the /webhooks endpoint. |
| 6 | * |
| 7 | * @package WooCommerce\RestApi |
| 8 | * @since 2.6.0 |
| 9 | */ |
| 10 | |
| 11 | defined( 'ABSPATH' ) || exit; |
| 12 | |
| 13 | /** |
| 14 | * REST API Webhooks controller class. |
| 15 | * |
| 16 | * @package WooCommerce\RestApi |
| 17 | * @extends WC_REST_Webhooks_V1_Controller |
| 18 | */ |
| 19 | class WC_REST_Webhooks_V2_Controller extends WC_REST_Webhooks_V1_Controller { |
| 20 | |
| 21 | /** |
| 22 | * Endpoint namespace. |
| 23 | * |
| 24 | * @var string |
| 25 | */ |
| 26 | protected $namespace = 'wc/v2'; |
| 27 | |
| 28 | /** |
| 29 | * Prepare a single webhook output for response. |
| 30 | * |
| 31 | * @param int $id Webhook ID. |
| 32 | * @param WP_REST_Request $request Request object. |
| 33 | * @return WP_REST_Response $response |
| 34 | */ |
| 35 | public function prepare_item_for_response( $id, $request ) { |
| 36 | $webhook = wc_get_webhook( $id ); |
| 37 | |
| 38 | if ( empty( $webhook ) || is_null( $webhook ) ) { |
| 39 | return new WP_Error( "woocommerce_rest_{$this->post_type}_invalid_id", __( 'ID is invalid.', 'woocommerce' ), array( 'status' => 404 ) ); |
| 40 | } |
| 41 | |
| 42 | $data = array( |
| 43 | 'id' => $webhook->get_id(), |
| 44 | 'name' => $webhook->get_name(), |
| 45 | 'status' => $webhook->get_status(), |
| 46 | 'topic' => $webhook->get_topic(), |
| 47 | 'resource' => $webhook->get_resource(), |
| 48 | 'event' => $webhook->get_event(), |
| 49 | 'hooks' => $webhook->get_hooks(), |
| 50 | 'delivery_url' => $webhook->get_delivery_url(), |
| 51 | 'date_created' => wc_rest_prepare_date_response( $webhook->get_date_created(), false ), |
| 52 | 'date_created_gmt' => wc_rest_prepare_date_response( $webhook->get_date_created() ), |
| 53 | 'date_modified' => wc_rest_prepare_date_response( $webhook->get_date_modified(), false ), |
| 54 | 'date_modified_gmt' => wc_rest_prepare_date_response( $webhook->get_date_modified() ), |
| 55 | ); |
| 56 | |
| 57 | $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
| 58 | $data = $this->add_additional_fields_to_object( $data, $request ); |
| 59 | $data = $this->filter_response_by_context( $data, $context ); |
| 60 | |
| 61 | // Wrap the data in a response object. |
| 62 | $response = rest_ensure_response( $data ); |
| 63 | |
| 64 | $response->add_links( $this->prepare_links( $webhook->get_id(), $request ) ); |
| 65 | |
| 66 | /** |
| 67 | * Filter webhook object returned from the REST API. |
| 68 | * |
| 69 | * @param WP_REST_Response $response The response object. |
| 70 | * @param WC_Webhook $webhook Webhook object used to create response. |
| 71 | * @param WP_REST_Request $request Request object. |
| 72 | */ |
| 73 | return apply_filters( "woocommerce_rest_prepare_{$this->post_type}", $response, $webhook, $request ); |
| 74 | } |
| 75 | |
| 76 | /** |
| 77 | * Get the default REST API version. |
| 78 | * |
| 79 | * @since 3.0.0 |
| 80 | * @return string |
| 81 | */ |
| 82 | protected function get_default_api_version() { |
| 83 | return 'wp_api_v2'; |
| 84 | } |
| 85 | |
| 86 | /** |
| 87 | * Get the Webhook's schema, conforming to JSON Schema. |
| 88 | * |
| 89 | * @return array |
| 90 | */ |
| 91 | public function get_item_schema() { |
| 92 | $schema = array( |
| 93 | '$schema' => 'http://json-schema.org/draft-04/schema#', |
| 94 | 'title' => 'webhook', |
| 95 | 'type' => 'object', |
| 96 | 'properties' => array( |
| 97 | 'id' => array( |
| 98 | 'description' => __( 'Unique identifier for the resource.', 'woocommerce' ), |
| 99 | 'type' => 'integer', |
| 100 | 'context' => array( 'view', 'edit' ), |
| 101 | 'readonly' => true, |
| 102 | ), |
| 103 | 'name' => array( |
| 104 | 'description' => __( 'A friendly name for the webhook.', 'woocommerce' ), |
| 105 | 'type' => 'string', |
| 106 | 'context' => array( 'view', 'edit' ), |
| 107 | ), |
| 108 | 'status' => array( |
| 109 | 'description' => __( 'Webhook status.', 'woocommerce' ), |
| 110 | 'type' => 'string', |
| 111 | 'default' => 'active', |
| 112 | 'enum' => array_keys( wc_get_webhook_statuses() ), |
| 113 | 'context' => array( 'view', 'edit' ), |
| 114 | ), |
| 115 | 'topic' => array( |
| 116 | 'description' => __( 'Webhook topic.', 'woocommerce' ), |
| 117 | 'type' => 'string', |
| 118 | 'context' => array( 'view', 'edit' ), |
| 119 | ), |
| 120 | 'resource' => array( |
| 121 | 'description' => __( 'Webhook resource.', 'woocommerce' ), |
| 122 | 'type' => 'string', |
| 123 | 'context' => array( 'view', 'edit' ), |
| 124 | 'readonly' => true, |
| 125 | ), |
| 126 | 'event' => array( |
| 127 | 'description' => __( 'Webhook event.', 'woocommerce' ), |
| 128 | 'type' => 'string', |
| 129 | 'context' => array( 'view', 'edit' ), |
| 130 | 'readonly' => true, |
| 131 | ), |
| 132 | 'hooks' => array( |
| 133 | 'description' => __( 'WooCommerce action names associated with the webhook.', 'woocommerce' ), |
| 134 | 'type' => 'array', |
| 135 | 'context' => array( 'view', 'edit' ), |
| 136 | 'readonly' => true, |
| 137 | 'items' => array( |
| 138 | 'type' => 'string', |
| 139 | ), |
| 140 | ), |
| 141 | 'delivery_url' => array( |
| 142 | 'description' => __( 'The URL where the webhook payload is delivered.', 'woocommerce' ), |
| 143 | 'type' => 'string', |
| 144 | 'format' => 'uri', |
| 145 | 'context' => array( 'view', 'edit' ), |
| 146 | 'readonly' => true, |
| 147 | ), |
| 148 | 'secret' => array( |
| 149 | 'description' => __( "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", 'woocommerce' ), |
| 150 | 'type' => 'string', |
| 151 | 'context' => array( 'edit' ), |
| 152 | ), |
| 153 | 'date_created' => array( |
| 154 | 'description' => __( "The date the webhook was created, in the site's timezone.", 'woocommerce' ), |
| 155 | 'type' => 'date-time', |
| 156 | 'context' => array( 'view', 'edit' ), |
| 157 | 'readonly' => true, |
| 158 | ), |
| 159 | 'date_created_gmt' => array( |
| 160 | 'description' => __( 'The date the webhook was created, as GMT.', 'woocommerce' ), |
| 161 | 'type' => 'date-time', |
| 162 | 'context' => array( 'view', 'edit' ), |
| 163 | 'readonly' => true, |
| 164 | ), |
| 165 | 'date_modified' => array( |
| 166 | 'description' => __( "The date the webhook was last modified, in the site's timezone.", 'woocommerce' ), |
| 167 | 'type' => 'date-time', |
| 168 | 'context' => array( 'view', 'edit' ), |
| 169 | 'readonly' => true, |
| 170 | ), |
| 171 | 'date_modified_gmt' => array( |
| 172 | 'description' => __( 'The date the webhook was last modified, as GMT.', 'woocommerce' ), |
| 173 | 'type' => 'date-time', |
| 174 | 'context' => array( 'view', 'edit' ), |
| 175 | 'readonly' => true, |
| 176 | ), |
| 177 | ), |
| 178 | ); |
| 179 | |
| 180 | return $this->add_additional_fields_schema( $schema ); |
| 181 | } |
| 182 | } |
| 183 |