feat: new rest api for orders, countries, tax, shipping

includes/REST/DataCountryController.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace WeDevs\Dokan\REST;
+
+use WC_REST_Data_Countries_Controller;
+use WP_Error;
+use WP_REST_Request;
+
+defined( 'ABSPATH' ) || exit;
+
+/**
+ * Dokan REST API Data Countries controller class.
+ *
+ * @since DOKAN_SINCE
+ *
+ * @package WeDevs\Dokan\REST
+ */
+class DataCountryController extends WC_REST_Data_Countries_Controller {
+
+    /**
+     * Endpoint namespace.
+     *
+     * @var string
+     */
+    protected $namespace = 'dokan/v1';
+
+    /**
+     * Check whether a given request has permission to read countries data.
+     *
+     * @param  WP_REST_Request $request Full details about the request.
+     * @return WP_Error|boolean
+     */
+    public function get_items_permissions_check( $request ) {
+        if ( ! $this->check_vendor_permission() ) {
+            return new WP_Error( 'dokan_rest_cannot_view', __( 'Sorry, you cannot list resources.', 'dokan-lite' ), array( 'status' => rest_authorization_required_code() ) );
+        }
+        return true;
+    }
+
+    /**
+     * Check vendor permission.
+     *
+     * @return bool
+     */
+    protected function check_vendor_permission(): bool {
+        return dokan_is_user_seller( dokan_get_current_user_id() );
+    }
+}

includes/REST/Manager.php

@@ -234,6 +234,16 @@ private function get_rest_api_class_map() {
                 DOKAN_DIR . '/includes/REST/StoreSettingControllerV2.php'        => '\WeDevs\Dokan\REST\StoreSettingControllerV2',
                 DOKAN_DIR . '/includes/REST/VendorDashboardController.php'       => '\WeDevs\Dokan\REST\VendorDashboardController',
                 DOKAN_DIR . '/includes/REST/ProductBlockController.php'          => '\WeDevs\Dokan\REST\ProductBlockController',
+                DOKAN_DIR . '/includes/REST/DataCountryController.php'         => '\WeDevs\Dokan\REST\DataCountryController',
+                DOKAN_DIR . '/includes/REST/ShippingMethodController.php'       => '\WeDevs\Dokan\REST\ShippingMethodController',
+                DOKAN_DIR . '/includes/REST/ShippingStatusController.php'        => '\WeDevs\Dokan\REST\ShippingStatusController',
+                DOKAN_DIR . '/includes/REST/TaxClassController.php'            => '\WeDevs\Dokan\REST\TaxClassController',
+                DOKAN_DIR . '/includes/REST/TaxController.php'                 => '\WeDevs\Dokan\REST\TaxController',
+                DOKAN_DIR . '/includes/REST/PaymentGatewayController.php'       => '\WeDevs\Dokan\REST\PaymentGatewayController',
+                DOKAN_DIR . '/includes/REST/OrderControllerV3.php'              => '\WeDevs\Dokan\REST\OrderControllerV3',
+                DOKAN_DIR . '/includes/REST/OrderNoteControllerV3.php'            => '\WeDevs\Dokan\REST\OrderNoteControllerV3',
+                DOKAN_DIR . '/includes/REST/OrderRefundControllerV3.php'          => '\WeDevs\Dokan\REST\OrderRefundControllerV3',
+                DOKAN_DIR . '/includes/REST/OrderActionControllerV3.php'          => '\WeDevs\Dokan\REST\OrderActionControllerV3',
             )
         );
     }

includes/REST/OrderActionControllerV3.php

@@ -0,0 +1,323 @@
+<?php
+
+namespace WeDevs\Dokan\REST;
+
+use Exception;
+use WC_Data_Store;
+use WC_Order;
+use WeDevs\Dokan\Abstracts\DokanRESTController;
+use WP_Error;
+use WP_REST_Request;
+use WP_REST_Response;
+use WP_REST_Server;
+
+/**
+ * Dokan REST API Order Actions Controller
+ *
+ * Handles requests to the /orders/<id>/actions endpoint
+ *
+ * @since DOKAN_SINCE
+ */
+class OrderActionControllerV3 extends DokanRESTController {
+
+    /**
+     * Endpoint namespace
+     *
+     * @var string
+     */
+    protected $namespace = 'dokan/v3';
+
+    /**
+     * Route base
+     *
+     * @var string
+     */
+    protected $rest_base = 'orders/(?P<id>[\d]+)/actions';
+
+    /**
+     * Register routes
+     *
+     * @return void
+     */
+    public function register_routes() {
+        register_rest_route(
+            $this->namespace, '/' . $this->rest_base, array(
+                array(
+                    'methods'             => WP_REST_Server::READABLE,
+                    'callback'            => array( $this, 'get_items' ),
+                    'permission_callback' => array( $this, 'get_items_permissions_check' ),
+                ),
+                array(
+                    'methods'             => WP_REST_Server::CREATABLE,
+                    'callback'            => array( $this, 'create_item' ),
+                    'permission_callback' => array( $this, 'create_item_permissions_check' ),
+                    'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ),
+                ),
+            )
+        );
+    }
+
+    /**
+     * Check if the current user has authorization for a specific order.
+     *
+     * @param int $order_id The order ID to check authorization for.
+     * @return bool|WP_Error True if authorized, WP_Error if not.
+     */
+    protected function check_order_authorization( int $order_id ) {
+        $order = wc_get_order( $order_id );
+
+        if ( ! $order ) {
+            return new WP_Error( 'dokan_rest_invalid_order_id', __( 'Invalid order ID.', 'dokan-lite' ), array( 'status' => 404 ) );
+        }
+
+        if ( $order->get_meta( 'has_sub_order' ) ) {
+            return new WP_Error( 'dokan_rest_invalid_order', __( 'Sorry, this is a parent order', 'dokan-lite' ), array( 'status' => 404 ) );
+        }
+
+        $vendor_id = dokan_get_seller_id_by_order( $order_id );
+        if ( $vendor_id !== dokan_get_current_user_id() ) {
+            return new WP_Error( 'dokan_rest_unauthorized_order', __( 'You do not have permission to access this order', 'dokan-lite' ), array( 'status' => 403 ) );
+        }
+
+        return true;
+    }
+
+    /**
+     * Check if a given request has access to get items
+     *
+     * @param WP_REST_Request $request Full data about the request.
+     * @return WP_Error|bool
+     */
+    public function get_items_permissions_check( $request ) {
+        if ( ! $this->check_vendor_permission() ) {
+            return new WP_Error( 'dokan_rest_cannot_view', __( 'Sorry, you cannot list resources.', 'dokan-lite' ), array( 'status' => rest_authorization_required_code() ) );
+        }
+
+        return $this->check_order_authorization( $request['id'] );
+    }
+
+    /**
+     * Check if a given request has access to create items
+     *
+     * @param WP_REST_Request $request Full data about the request.
+     * @return WP_Error|bool
+     */
+    public function create_item_permissions_check( $request ) {
+        if ( ! $this->check_vendor_permission() ) {
+            return new WP_Error( 'dokan_rest_cannot_create', esc_html__( 'Sorry, you are not allowed to create resources.', 'dokan-lite' ), array( 'status' => rest_authorization_required_code() ) );
+        }
+
+        return $this->check_order_authorization( $request['id'] );
+    }
+
+    /**
+     * Check permission for the request
+     *
+     * @return bool
+     */
+    public function check_vendor_permission(): bool {
+        return dokan_is_user_seller( dokan_get_current_user_id() );
+    }
+
+    /**
+     * Get available order actions
+     *
+     * @param WP_REST_Request $request Full data about the request.
+     * @return WP_Error|WP_REST_Response
+     */
+    public function get_items( $request ) {
+        $order_id = $request['id'];
+        $auth_check = $this->check_order_authorization( $order_id );
+        if ( is_wp_error( $auth_check ) ) {
+            return $auth_check;
+        }
+
+        $order = wc_get_order( $order_id );
+        $actions = $this->get_available_order_actions_for_order( $order );
+
+        return rest_ensure_response( $actions );
+    }
+
+    /**
+     * Create an order action
+     *
+     * @param WP_REST_Request $request Full data about the request.
+     * @return WP_Error|WP_REST_Response
+     * @throws Exception If the action is invalid
+     */
+    public function create_item( $request ) {
+        $order_id = $request['id'];
+        $auth_check = $this->check_order_authorization( $order_id );
+        if ( is_wp_error( $auth_check ) ) {
+            return $auth_check;
+        }
+
+        $action = $request['action'];
+        $order = wc_get_order( $order_id );
+
+        $result = $this->process_order_action( $order, $action );
+
+        if ( is_wp_error( $result ) ) {
+            return $result;
+        }
+
+        return rest_ensure_response(
+            array(
+                'message' => esc_html__( 'Order action applied successfully.', 'dokan-lite' ),
+                'action'  => $action,
+            )
+        );
+    }
+
+    /**
+     * Get available order actions for a given order
+     *
+     * @param WC_Order $order
+     * @return array
+     */
+    private function get_available_order_actions_for_order( WC_Order $order ): array {
+        $actions = array(
+            'send_order_details'              => __( 'Send order details to customer', 'dokan-lite' ),
+            'send_order_details_admin'        => __( 'Resend new order notification', 'dokan-lite' ),
+            'regenerate_download_permissions' => __( 'Regenerate download permissions', 'dokan-lite' ),
+        );
+
+        /**
+         * Filters the list of available order actions.
+         *
+         * This filter allows you to add or remove order actions for the Dokan vendor dashboard.
+         *
+         * @since DOKAN_SINCE
+         *
+         * @param array    $actions The list of available order actions.
+         * @param WC_Order $order   The order object.
+         */
+        return apply_filters( 'woocommerce_order_actions', $actions, $order );
+    }
+
+    /**
+     * Process the order action
+     *
+     * @param WC_Order $order
+     * @param string $action
+     * @return bool|WP_Error
+     * @throws Exception If the action is invalid
+     */
+    private function process_order_action( WC_Order $order, string $action ) {
+        switch ( $action ) {
+            case 'send_order_details':
+                /**
+                 * Fires before resending order emails.
+                 *
+                 * This action is triggered before resending various types of order emails.
+                 *
+                 * @since DOKAN_SINCE
+                 *
+                 * @param WC_Order $order The order object for which emails are being resent.
+                 * @param string   $email_type The type of email being resent (e.g., 'customer_invoice', 'new_order').
+                 */
+                do_action( 'woocommerce_before_resend_order_emails', $order, 'customer_invoice' );
+
+                WC()->payment_gateways();
+                WC()->shipping();
+                WC()->mailer()->customer_invoice( $order );
+                $order->add_order_note( __( 'Order details manually sent to customer.', 'dokan-lite' ), false, true );
+
+                /**
+                 * Fires after resending an order email.
+                 *
+                 * This action is triggered after an order email has been resent.
+                 *
+                 * @since DOKAN_SINCE
+                 *
+                 * @param WC_Order $order The order object for which an email was resent.
+                 * @param string   $email_type The type of email that was resent (e.g., 'customer_invoice', 'new_order').
+                 */
+                do_action( 'woocommerce_after_resend_order_email', $order, 'customer_invoice' );
+                break;
+
+            case 'send_order_details_admin':
+                /**
+                 * Fires before resending order emails.
+                 *
+                 * This action is triggered before resending various types of order emails.
+                 *
+                 * @since DOKAN_SINCE
+                 *
+                 * @param WC_Order $order The order object for which emails are being resent.
+                 * @param string   $email_type The type of email being resent (e.g., 'customer_invoice', 'new_order').
+                 */
+                do_action( 'woocommerce_before_resend_order_emails', $order, 'new_order' );
+
+                WC()->payment_gateways();
+                WC()->shipping();
+
+                add_filter( 'woocommerce_new_order_email_allows_resend', '__return_true' );
+                WC()->mailer()->emails['WC_Email_New_Order']->trigger( $order->get_id(), $order, true );
+                remove_filter( 'woocommerce_new_order_email_allows_resend', '__return_true' );
+
+                /**
+                 * Fires after resending an order email.
+                 *
+                 * This action is triggered after an order email has been resent.
+                 *
+                 * @since DOKAN_SINCE
+                 *
+                 * @param WC_Order $order The order object for which an email was resent.
+                 * @param string   $email_type The type of email that was resent (e.g., 'customer_invoice', 'new_order').
+                 */
+                do_action( 'woocommerce_after_resend_order_email', $order, 'new_order' );
+                break;
+
+            case 'regenerate_download_permissions':
+                $data_store = WC_Data_Store::load( 'customer-download' );
+                $data_store->delete_by_order_id( $order->get_id() );
+                wc_downloadable_product_permissions( $order->get_id(), true );
+                break;
+
+            default:
+                if ( did_action( 'woocommerce_order_action_' . sanitize_title( $action ) ) ) {
+                    /**
+                     * Fires when a custom order action is being processed.
+                     *
+                     * This hook allows third-party plugins to add custom order actions
+                     * and define their behavior when triggered through the API.
+                     *
+                     * @since DOKAN_SINCE
+                     *
+                     * @param WC_Order $order The order object for which the action is being performed.
+                     *
+                     * @hook woocommerce_order_action_{$action}
+                     */
+                    do_action( 'woocommerce_order_action_' . sanitize_title( $action ), $order );
+                } else {
+                    return new WP_Error( 'dokan_rest_invalid_order_action', esc_html__( 'Invalid order action.', 'dokan-lite' ), array( 'status' => 400 ) );
+                }
+        }
+
+        return true;
+    }
+
+    /**
+     * Get the Order Actions schema, conforming to JSON Schema
+     *
+     * @return array
+     */
+    public function get_item_schema(): array {
+        $schema = array(
+            '$schema'    => 'http://json-schema.org/draft-04/schema#',
+            'title'      => 'order_action',
+            'type'       => 'object',
+            'properties' => array(
+                'action' => array(
+                    'description' => esc_html__( 'Order action to perform.', 'dokan-lite' ),
+                    'type'        => 'string',
+                    'context'     => array( 'view', 'edit' ),
+                    'required'    => true,
+                ),
+            ),
+        );
+
+        return $this->add_additional_fields_schema( $schema );
+    }
+}