@redotech/redo-api-schema 2.2.128 → 2.2.134

package/lib/openapi.d.ts

@@ -64,11 +64,6 @@ export interface paths {
      * @description Update return status.
      */
     put: operations["Return status update"];
-    parameters: {
-      path: {
-        returnId: components["parameters"]["return-id.param"];
-      };
-    };
   };
   "/stores/{storeId}/admin": {
     /**
@@ -190,14 +185,9 @@ export interface paths {
     put: operations["Webhook update"];
     /**
      * Delete webhook
-     * @description Delete a webbhook.
+     * @description Delete a webhook.
      */
     delete: operations["Webhook delete"];
-    parameters: {
-      path: {
-        webhookId: components["parameters"]["webhook-id.param"];
-      };
-    };
   };
   "/webhooks/{webhookId}/replay": {
     /**
@@ -748,18 +738,35 @@ export interface components {
      * Return status
      * @description Return status.
      *
-     * * manual_review: Return requires pre-shipment merchant authorization.
-     * * open: Return has been approved is awaiting shipment.
-     * * transit: Return shipment is in transit.
-     * * delivered: Return shipment has been delievered and awaiting processing.
+     * * complete: The return has been completed successfully.
+     * * open: Return has been approved and is awaiting shipment.
+     * * flagged: A problem with return processing requires merchant action.
+     * * rejected: The return has been rejected.
+     * * deleted: The return has been reset.
+     *
+     * @example open
+     * @enum {string}
+     */
+    "return-status-update.schema": "complete" | "open" | "flagged" | "rejected" | "deleted";
+    /**
+     * Return status
+     * @description Return status.
+     *
+     * * open: Return has been approved and is awaiting shipment.
+     * * in_transit: Return shipment is in transit.
+     * * delivered: Return shipment has been delivered and awaiting processing.
+     * * needs_review: Return requires review before further action.
+     * * in_review: Return is currently being reviewed.
+     * * complete: The return has been completed successfully.
+     * * rejected: The return has been rejected.
      * * flagged: A problem with return processing requires merchant action.
-     * * cancelled: The return has been cancelled.
-     * * closed: The return has been completed.
+     * * pre_shipment: Return requires pre-shipment merchant authorization.
+     * * deleted: The return has been deleted (Reset).
      *
      * @example open
      * @enum {string}
      */
-    "return-status.schema": "manual_review" | "open" | "transit" | "delivered" | "flagged" | "cancelled" | "closed";
+    "return-status.schema": "open" | "in_transit" | "delivered" | "needs_review" | "in_review" | "complete" | "rejected" | "flagged" | "pre_shipment" | "deleted";
     /**
      * Shipment Document Type
      * @description Type of shipping document.
@@ -1265,7 +1272,7 @@ export interface operations {
     requestBody: {
       content: {
         "application/json": {
-          status: components["schemas"]["return-status.schema"];
+          status: components["schemas"]["return-status-update.schema"];
         };
       };
     };
@@ -1711,7 +1718,7 @@ export interface operations {
   };
   /**
    * Delete webhook
-   * @description Delete a webbhook.
+   * @description Delete a webhook.
    */
   "Webhook delete": {
     parameters: {

package/lib/openapi.yaml

@@ -755,25 +755,49 @@ components:
         - updatedAt
       title: Return
       type: object
+    return-status-update.schema:
+      description: |
+        Return status.
+
+        * complete: The return has been completed successfully.
+        * open: Return has been approved and is awaiting shipment.
+        * flagged: A problem with return processing requires merchant action.
+        * rejected: The return has been rejected.
+        * deleted: The return has been reset.
+      enum:
+        - complete
+        - open
+        - flagged
+        - rejected
+        - deleted
+      example: open
+      title: Return status
+      type: string
     return-status.schema:
       description: |
         Return status.
 
-        * manual_review: Return requires pre-shipment merchant authorization.
-        * open: Return has been approved is awaiting shipment.
-        * transit: Return shipment is in transit.
-        * delivered: Return shipment has been delievered and awaiting processing.
+        * open: Return has been approved and is awaiting shipment.
+        * in_transit: Return shipment is in transit.
+        * delivered: Return shipment has been delivered and awaiting processing.
+        * needs_review: Return requires review before further action.
+        * in_review: Return is currently being reviewed.
+        * complete: The return has been completed successfully.
+        * rejected: The return has been rejected.
         * flagged: A problem with return processing requires merchant action.
-        * cancelled: The return has been cancelled.
-        * closed: The return has been completed.
+        * pre_shipment: Return requires pre-shipment merchant authorization.
+        * deleted: The return has been deleted (Reset).
       enum:
-        - manual_review
         - open
-        - transit
+        - in_transit
         - delivered
+        - needs_review
+        - in_review
+        - complete
+        - rejected
         - flagged
-        - cancelled
-        - closed
+        - pre_shipment
+        - deleted
       example: open
       title: Return status
       type: string
@@ -1325,6 +1349,8 @@ paths:
     get:
       description: Get return status.
       operationId: Return status get
+      parameters:
+        - $ref: '#/components/parameters/return-id.param'
       responses:
         '200':
           content:
@@ -1348,18 +1374,18 @@ paths:
       summary: Get return status
       tags:
         - Returns
-    parameters:
-      - $ref: '#/components/parameters/return-id.param'
     put:
       description: Update return status.
       operationId: Return status update
+      parameters:
+        - $ref: '#/components/parameters/return-id.param'
       requestBody:
         content:
           application/json:
             schema:
               properties:
                 status:
-                  $ref: '#/components/schemas/return-status.schema'
+                  $ref: '#/components/schemas/return-status-update.schema'
               required:
                 - status
               type: object
@@ -1822,8 +1848,10 @@ paths:
     summary: Webhooks
   /webhooks/{webhookId}:
     delete:
-      description: Delete a webbhook.
+      description: Delete a webhook.
       operationId: Webhook delete
+      parameters:
+        - $ref: '#/components/parameters/webhook-id.param'
       responses:
         '204':
           description: Deleted
@@ -1836,6 +1864,8 @@ paths:
     get:
       description: Get a webhook.
       operationId: Webhook get
+      parameters:
+        - $ref: '#/components/parameters/webhook-id.param'
       responses:
         '200':
           content:
@@ -1851,11 +1881,11 @@ paths:
       summary: Get webhook
       tags:
         - Webhooks
-    parameters:
-      - $ref: '#/components/parameters/webhook-id.param'
     put:
       description: Update a webhook.
       operationId: Webhook update
+      parameters:
+        - $ref: '#/components/parameters/webhook-id.param'
       requestBody:
         content:
           application/json:

package/package.json

@@ -31,5 +31,5 @@
       ]
     }
   },
-  "version": "2.2.128"
+  "version": "2.2.134"
 }