@redotech/redo-api-schema 2.2.42 → 2.2.44

package/lib/openapi.d.ts

@@ -10,9 +10,17 @@ type XOR<T, U> = (T | U) extends object ? (Without<T, U> & U) | (Without<U, T> &
 type OneOf<T extends any[]> = T extends [infer Only] ? Only : T extends [infer A, infer B, ...infer Rest] ? OneOf<[XOR<A, B>, ...Rest]> : never;
 
 export interface paths {
-  "/__return": {
-    /** Return event [Webhook] */
-    post: operations["Webhook return event"];
+  "/returns/{returnId}": {
+    /**
+     * Get return
+     * @description Get return.
+     */
+    get: operations["Return get"];
+    parameters: {
+      path: {
+        storeId: components["parameters"]["store-id.param"];
+      };
+    };
   };
   "/returns/{returnId}/comments": {
     /**
@@ -115,7 +123,7 @@ export interface paths {
 
 export interface webhooks {
   "return": {
-    /** Return event [Webhook] */
+    /** Return event */
     post: operations["Webhook return event"];
   };
 }
@@ -178,20 +186,27 @@ export interface components {
     }]>;
     /**
      * Problem details
-     * @description See [RFC 7807 Section 3](https://datatracker.ietf.org/doc/html/rfc7807#section-3).
+     * @description Problem details. See [RFC 7807 Section 3](https://datatracker.ietf.org/doc/html/rfc7807#section-3).
      */
     "error.schema": {
-      /** @description A human-readable explanation specific to this occurrence of the problem. */
+      /**
+       * Detail
+       * @description Human-readable description of the problem.
+       */
       detail?: string;
-      /** @description A URI reference that identifies the specific occurrence of the problem.  It may or may not yield further information if dereferenced. */
+      /**
+       * Format: uri-reference
+       * @description A URI reference that identifies this problem.
+       */
       instance?: string;
-      /** @description The HTTP status code ([[RFC7231], Section 6](https://datatracker.ietf.org/doc/html/rfc7231#section-6)) generated by the origin server for this occurrence of the problem. */
-      status?: number;
-      /** @description A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [[RFC7231], Section 3.4](https://datatracker.ietf.org/doc/html/rfc7231#section-3.4)). */
+      /**
+       * Title
+       * @description Human-readable summary of the problem type.
+       */
       title?: string;
       /**
        * Format: uri-reference
-       * @description A URI reference [[RFC3986](https://datatracker.ietf.org/doc/html/rfc3986)] that identifies the problem type.  This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [[W3C.REC-html5-20141028](https://datatracker.ietf.org/doc/html/rfc7807#ref-W3C.REC-html5-20141028)]).  When this member is not present, its value is assumed to be "about:blank".
+       * @description A URI reference that identifies the problem type.
        * @default about:blank
        */
       type?: string;
@@ -703,51 +718,31 @@ export type external = Record<string, never>;
 
 export interface operations {
 
-  /** Return event [Webhook] */
-  "Webhook return event": {
-    /**
-     * @description Return event webhook.
-     *
-     * <!-- theme: warning -->
-     * > #### Note
-     * >
-     * > This is not an actual Redo API endpoint, but a webhook.
-     */
-    requestBody: {
-      content: {
-        "application/json": {
-          /**
-           * At
-           * Format: date-time
-           * @description Event time
-           */
-          at?: string;
-          /**
-           * Order
-           * @description Order for return.
-           */
-          order?: components["schemas"]["order-read.schema"];
-          /**
-           * Return
-           * @description Return.
-           */
-          return?: components["schemas"]["return-read.schema"];
-          /**
-           * @description Event type
-           * @enum {string}
-           */
-          type?: "backfill" | "created" | "updated";
-        };
+  /**
+   * Get return
+   * @description Get return.
+   */
+  "Return get": {
+    parameters: {
+      path: {
+        storeId: components["parameters"]["store-id.param"];
       };
     };
     responses: {
-      /** @description Success. Return a 2xx status code to indicate success. */
-      "2xx": {
-        content: never;
+      /** @description Success */
+      200: {
+        content: {
+          "application/json": {
+            order: components["schemas"]["order-read.schema"];
+            return: components["schemas"]["return-read.schema"];
+          };
+        };
       };
-      /** @description Error. The event will be retried multiple times and then discarded. */
+      /** @description Error */
       default: {
-        content: never;
+        content: {
+          "application/problem+json": components["schemas"]["error.schema"];
+        };
       };
     };
   };
@@ -1074,4 +1069,45 @@ export interface operations {
       };
     };
   };
+  /** Return event */
+  "Webhook return event": {
+    /** @description Return event webhook. */
+    requestBody: {
+      content: {
+        "application/json": {
+          /**
+           * At
+           * Format: date-time
+           * @description Event time
+           */
+          at?: string;
+          /**
+           * Order
+           * @description Order for return.
+           */
+          order?: components["schemas"]["order-read.schema"];
+          /**
+           * Return
+           * @description Return.
+           */
+          return?: components["schemas"]["return-read.schema"];
+          /**
+           * @description Event type
+           * @enum {string}
+           */
+          type?: "backfill" | "created" | "updated";
+        };
+      };
+    };
+    responses: {
+      /** @description Success. Return a 2xx status code to indicate success. */
+      "2xx": {
+        content: never;
+      };
+      /** @description Error. The event will be retried multiple times and then discarded. */
+      default: {
+        content: never;
+      };
+    };
+  };
 }

package/lib/openapi.yaml

@@ -133,23 +133,23 @@ components:
           type: object
       title: Comment
     error.schema:
-      description: See [RFC 7807 Section 3](https://datatracker.ietf.org/doc/html/rfc7807#section-3).
+      description: Problem details. See [RFC 7807 Section 3](https://datatracker.ietf.org/doc/html/rfc7807#section-3).
       properties:
         detail:
-          description: A human-readable explanation specific to this occurrence of the problem.
+          description: Human-readable description of the problem.
+          title: Detail
           type: string
         instance:
-          description: A URI reference that identifies the specific occurrence of the problem.  It may or may not yield further information if dereferenced.
+          description: A URI reference that identifies this problem.
+          format: uri-reference
           type: string
-        status:
-          description: The HTTP status code ([[RFC7231], Section 6](https://datatracker.ietf.org/doc/html/rfc7231#section-6)) generated by the origin server for this occurrence of the problem.
-          type: number
         title:
-          description: A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [[RFC7231], Section 3.4](https://datatracker.ietf.org/doc/html/rfc7231#section-3.4)).
+          description: Human-readable summary of the problem type.
+          title: Title
           type: string
         type:
           default: about:blank
-          description: A URI reference [[RFC3986](https://datatracker.ietf.org/doc/html/rfc3986)] that identifies the problem type.  This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [[W3C.REC-html5-20141028](https://datatracker.ietf.org/doc/html/rfc7807#ref-W3C.REC-html5-20141028)]).  When this member is not present, its value is assumed to be "about:blank".
+          description: A URI reference that identifies the problem type.
           format: uri-reference
           type: string
       title: Problem details
@@ -762,56 +762,40 @@ info:
   version: 2.2.0
 openapi: 3.1.0
 paths:
-  /__return:
-    description: Return event webhook.
-    post:
-      operationId: Webhook return event
-      requestBody:
-        content:
-          application/json:
-            schema:
-              description: Return event
-              properties:
-                at:
-                  description: Event time
-                  format: date-time
-                  title: At
-                  type: string
-                order:
-                  $ref: '#/components/schemas/order-read.schema'
-                  description: Order for return.
-                  title: Order
-                return:
-                  $ref: '#/components/schemas/return-read.schema'
-                  description: Return.
-                  title: Return
-                type:
-                  description: Event type
-                  enum:
-                    - backfill
-                    - created
-                    - updated
-                  type: string
-              type: object
-        description: |
-          Return event webhook.
-
-          <!-- theme: warning -->
-          > #### Note
-          >
-          > This is not an actual Redo API endpoint, but a webhook.
-        required: true
+  /returns/{returnId}:
+    description: Return.
+    get:
+      description: Get return.
+      operationId: Return get
       responses:
-        2xx:
-          description: Success. Return a 2xx status code to indicate success.
+        '200':
+          content:
+            application/json:
+              schema:
+                properties:
+                  order:
+                    $ref: '#/components/schemas/order-read.schema'
+                  return:
+                    $ref: '#/components/schemas/return-read.schema'
+                required:
+                  - return
+                  - order
+                type: object
+          description: Success
         default:
-          description: Error. The event will be retried multiple times and then discarded.
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/error.schema'
+          description: Error
       security:
-        - UserBearer: []
-      summary: Return event [Webhook]
+        - Bearer: []
+      summary: Get return
       tags:
         - Returns
-    summary: Return event [Webhook]
+    parameters:
+      - $ref: '#/components/parameters/store-id.param'
+    summary: Return
   /returns/{returnId}/comments:
     description: Return comment.
     get:
@@ -1182,11 +1166,6 @@ webhooks:
               type: object
         description: |
           Return event webhook.
-
-          <!-- theme: warning -->
-          > #### Note
-          >
-          > This is not an actual Redo API endpoint, but a webhook.
         required: true
       responses:
         2xx:
@@ -1195,7 +1174,7 @@ webhooks:
           description: Error. The event will be retried multiple times and then discarded.
       security:
         - UserBearer: []
-      summary: Return event [Webhook]
+      summary: Return event
       tags:
         - Returns
-    summary: Return event [Webhook]
+    summary: Return event

package/package.json

@@ -31,5 +31,5 @@
       ]
     }
   },
-  "version": "2.2.42"
+  "version": "2.2.44"
 }