AbandonedCheckoutRestServiceProvider.php
| 1 | <?php |
| 2 | |
| 3 | namespace SureCart\Rest; |
| 4 | |
| 5 | use SureCart\Controllers\Rest\AbandonedCheckoutsController; |
| 6 | use SureCart\Rest\RestServiceInterface; |
| 7 | |
| 8 | /** |
| 9 | * Service provider for Price Rest Requests |
| 10 | */ |
| 11 | class AbandonedCheckoutRestServiceProvider extends RestServiceProvider implements RestServiceInterface { |
| 12 | /** |
| 13 | * Endpoint. |
| 14 | * |
| 15 | * @var string |
| 16 | */ |
| 17 | protected $endpoint = 'abandoned_checkouts'; |
| 18 | |
| 19 | /** |
| 20 | * Rest Controller |
| 21 | * |
| 22 | * @var string |
| 23 | */ |
| 24 | protected $controller = AbandonedCheckoutsController::class; |
| 25 | |
| 26 | /** |
| 27 | * Methods allowed for the model. |
| 28 | * |
| 29 | * @var array |
| 30 | */ |
| 31 | protected $methods = [ 'index', 'find' ]; |
| 32 | |
| 33 | /** |
| 34 | * Get our sample schema for a post. |
| 35 | * |
| 36 | * @return array The sample schema for a post |
| 37 | */ |
| 38 | public function get_item_schema() { |
| 39 | if ( $this->schema ) { |
| 40 | // Since WordPress 5.3, the schema can be cached in the $schema property. |
| 41 | return $this->schema; |
| 42 | } |
| 43 | |
| 44 | $this->schema = [ |
| 45 | // This tells the spec of JSON Schema we are using which is draft 4. |
| 46 | '$schema' => 'http://json-schema.org/draft-04/schema#', |
| 47 | // The title property marks the identity of the resource. |
| 48 | 'title' => $this->endpoint, |
| 49 | 'type' => 'object', |
| 50 | // In JSON Schema you can specify object properties in the properties attribute. |
| 51 | 'properties' => [ |
| 52 | 'id' => [ |
| 53 | 'description' => esc_html__( 'Unique identifier for the object.', 'surecart' ), |
| 54 | 'type' => 'string', |
| 55 | 'context' => [ 'view', 'edit', 'embed' ], |
| 56 | 'readonly' => true, |
| 57 | ], |
| 58 | 'notification_status' => [ |
| 59 | 'description' => esc_html__( 'The current notification status for this abandonded checkout, which can be one of not_sent, scheduled, or sent.', 'surecart' ), |
| 60 | 'type' => 'string', |
| 61 | 'readonly' => true, |
| 62 | ], |
| 63 | 'notifications_scheduled_at' => [ |
| 64 | 'description' => esc_html__( 'The current status of this abandonded checkout, which can be one of not_notified, notified, or recovered.', 'surecart' ), |
| 65 | 'type' => 'object', |
| 66 | 'readonly' => true, |
| 67 | ], |
| 68 | 'checkout' => [ |
| 69 | 'description' => esc_html__( 'The checkout id for the checkout.', 'surecart' ), |
| 70 | 'type' => 'string', |
| 71 | 'context' => [ 'edit' ], |
| 72 | 'readonly' => true, |
| 73 | ], |
| 74 | 'customer' => [ |
| 75 | 'description' => esc_html__( 'The customer for the checkout.', 'surecart' ), |
| 76 | 'type' => 'object', |
| 77 | 'context' => [ 'edit' ], |
| 78 | 'readonly' => true, |
| 79 | ], |
| 80 | 'recovered_checkout' => [ |
| 81 | 'description' => esc_html__( "This customer's most recent checkout that has been abandoned.", 'surecart' ), |
| 82 | 'type' => 'object', |
| 83 | 'context' => [ 'edit' ], |
| 84 | 'readonly' => true, |
| 85 | ], |
| 86 | ], |
| 87 | ]; |
| 88 | |
| 89 | return $this->schema; |
| 90 | } |
| 91 | |
| 92 | /** |
| 93 | * Anyone can get a specific order if they have the unique order id. |
| 94 | * |
| 95 | * @param \WP_REST_Request $request Full details about the request. |
| 96 | * @return true|\WP_Error True if the request has access to create items, WP_Error object otherwise. |
| 97 | */ |
| 98 | public function get_item_permissions_check( $request ) { |
| 99 | return current_user_can( 'read_sc_checkouts' ); |
| 100 | } |
| 101 | |
| 102 | /** |
| 103 | * Listing |
| 104 | * |
| 105 | * @param \WP_REST_Request $request Full details about the request. |
| 106 | * @return true|\WP_Error True if the request has access to create items, WP_Error object otherwise. |
| 107 | */ |
| 108 | public function get_items_permissions_check( $request ) { |
| 109 | return current_user_can( 'read_sc_checkouts' ); |
| 110 | } |
| 111 | } |
| 112 |