UpsellRestServiceProvider.php — SureCart – Ecommerce Made Easy For Selling Physical Products, Digital Downloads, Subscriptions, Donations, & Payments 3.0.3

surecart / app / src / Rest / UpsellRestServiceProvider.php

surecart / app / src / Rest Last commit date

UpsellRestServiceProvider.php

165 lines

1	<?php
2
3	namespace SureCart\Rest;
4
5	use SureCart\Rest\RestServiceInterface;
6	use SureCart\Controllers\Rest\UpsellsController;
7
8	/**
9	* Service provider for Price Rest Requests
10	*/
11	class UpsellRestServiceProvider extends RestServiceProvider implements RestServiceInterface {
12	/**
13	* Endpoint.
14	*
15	* @var string
16	*/
17	protected $endpoint = 'upsells';
18
19	/**
20	* Rest Controller
21	*
22	* @var string
23	*/
24	protected $controller = UpsellsController::class;
25
26	/**
27	* Methods allowed for the model.
28	*
29	* @var array
30	*/
31	protected $methods = [ 'index', 'create', 'find', 'edit', 'delete' ];
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	'object' => [
59	'description' => esc_html__( 'Type of object (upsell)', 'surecart' ),
60	'type' => 'string',
61	'context' => [ 'view', 'edit', 'embed' ],
62	'readonly' => true,
63	],
64	'created_at' => [
65	'description' => esc_html__( 'Created at timestamp', 'surecart' ),
66	'type' => 'integer',
67	'context' => [ 'view', 'edit', 'embed' ],
68	'readonly' => true,
69	],
70	'updated_at' => [
71	'description' => esc_html__( 'Created at timestamp', 'surecart' ),
72	'type' => 'integer',
73	'context' => [ 'view', 'edit', 'embed' ],
74	'readonly' => true,
75	],
76	'amount_off' => [
77	'description' => esc_html__( 'Amount (in the currency of the price) that will be taken off line items associated with this upsell.', 'surecart' ),
78	'type' => [ 'integer', 'null' ],
79	'context' => [ 'view', 'edit', 'embed' ],
80	],
81	'duplicate_purchase_behavior' => [
82	'description' => esc_html__( 'How to handle duplicate purchases of the product – can be one of allow, block_within_checkout, or block.', 'surecart' ),
83	'type' => 'string',
84	'context' => [ 'view', 'edit', 'embed' ],
85	],
86	'fee_description' => [
87	'description' => esc_html__( 'The description for this upsell which will be visible to customers.', 'surecart' ),
88	'type' => 'string',
89	'context' => [ 'view', 'edit', 'embed' ],
90	],
91	'percent_off' => [
92	'description' => esc_html__( 'Percent that will be taken off line items associated with this upsell.', 'surecart' ),
93	'type' => [ 'integer', 'null' ],
94	'context' => [ 'view', 'edit', 'embed' ],
95	],
96	'step' => [
97	'description' => esc_html__( 'Where this upsell falls in position within the upsell funnel – can be one of initial, accepted, or declined.', 'surecart' ),
98	'type' => 'string',
99	'context' => [ 'view', 'edit', 'embed' ],
100	],
101	'price' => [
102	'description' => esc_html__( 'The UUID of the price.', 'surecart' ),
103	'type' => [ 'string', 'object' ],
104	'context' => [ 'view', 'edit', 'embed' ],
105	],
106	],
107	];
108
109	return $this->schema;
110	}
111
112	/**
113	* Anyone can get a specific price.
114	*
115	* @param \WP_REST_Request $request Full details about the request.
116	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
117	*/
118	public function get_item_permissions_check( $request ) {
119	return true;
120	}
121
122	/**
123	* Who can list prices
124	*
125	* @param \WP_REST_Request $request Full details about the request.
126	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
127	*/
128	public function get_items_permissions_check( $request ) {
129	if ( empty( $request['upsell_funnel_ids'] ) \|\| count( $request['upsell_funnel_ids'] ) > 1 ) {
130	return current_user_can( 'edit_sc_prices' );
131	}
132	return true;
133	}
134
135	/**
136	* Create model.
137	*
138	* @param \WP_REST_Request $request Full details about the request.
139	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
140	*/
141	public function create_item_permissions_check( $request ) {
142	return current_user_can( 'publish_sc_prices' );
143	}
144
145	/**
146	* Update model.
147	*
148	* @param \WP_REST_Request $request Full details about the request.
149	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
150	*/
151	public function update_item_permissions_check( $request ) {
152	return current_user_can( 'edit_sc_prices' );
153	}
154
155	/**
156	* Delete model.
157	*
158	* @param \WP_REST_Request $request Full details about the request.
159	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
160	*/
161	public function delete_item_permissions_check( $request ) {
162	return current_user_can( 'delete_sc_prices' );
163	}
164	}
165