@redotech/redo-api-schema 2.2.63 → 2.2.75

package/lib/openapi.d.ts

@@ -63,17 +63,19 @@ export interface paths {
       };
     };
   };
+  "/stores/{storeId}/coverage-products": {
+    /**
+     * Get coverage products
+     * @description Get available coverage products.
+     */
+    post: operations["Coverage products"];
+  };
   "/stores/{storeId}/invoices": {
     /**
      * Get invoice
      * @description Get a list of invoices.
      */
     get: operations["Invoice list"];
-    parameters: {
-      path: {
-        storeId: components["parameters"]["store-id.param"];
-      };
-    };
   };
   "/stores/{storeId}/returns": {
     /**
@@ -203,6 +205,37 @@ export interface components {
        */
       message?: string;
     }]>;
+    /**
+     * Coverage product
+     * @description Coverage product.
+     */
+    "coverage-product.schema": {
+      /** @description Coverage. */
+      coverages?: ({
+          lineItems: {
+              /**
+               * ID
+               * @description Line item ID.
+               */
+              id?: string;
+            }[];
+          /**
+           * Coverage
+           * @enum {unknown}
+           */
+          type: "shipping_failure" | "return_shipping";
+        })[];
+      /**
+       * ID
+       * @description Coverage ID.
+       */
+      id: string;
+      /**
+       * Price
+       * @description Price.
+       */
+      price: components["schemas"]["money.schema"];
+    };
     /**
      * Problem details
      * @description Problem details. See [RFC 7807 Section 3](https://datatracker.ietf.org/doc/html/rfc7807#section-3).
@@ -349,7 +382,7 @@ export interface components {
            * @description ID of the location where the item was be fulfilled.
            * @example 123
            */
-          fulfillmentLocationId: string | Record<string, never>;
+          fulfillmentLocationId: string | null;
           /**
            * ID
            * @description Line item ID
@@ -622,6 +655,59 @@ export interface components {
      * @enum {string}
      */
     "return-status.schema": "manual_review" | "open" | "transit" | "delivered" | "flagged" | "cancelled" | "closed";
+    /**
+     * Storefront Cart
+     * @description Storefront cart.
+     */
+    "storefront-cart.schema": {
+      /**
+       * Line items
+       * @description Line items.
+       */
+      lineItems: {
+          /**
+           * ID
+           * @description Line item ID.
+           */
+          id: string;
+          /**
+           * Price
+           * @description Total price.
+           */
+          priceTotal?: components["schemas"]["money.schema"];
+          /** @description Product. */
+          product: {
+            /** ID */
+            id?: string;
+          };
+          /**
+           * Quantity
+           * @description Quantity.
+           */
+          quantity: number;
+          /** @description Variant. */
+          variant: {
+            /** ID */
+            id?: string;
+          };
+        }[];
+      /**
+       * Price
+       * @description Total price.
+       */
+      priceTotal?: components["schemas"]["money.schema"];
+    };
+    /**
+     * Storefront Customer
+     * @description Storefront customer.
+     */
+    "storefront-customer.schema": {
+      /**
+       * ID
+       * @description Customer ID.
+       */
+      id: string;
+    };
     /**
      * Webhook create
      * @description Webhook create.
@@ -938,6 +1024,45 @@ export interface operations {
       };
     };
   };
+  /**
+   * Get coverage products
+   * @description Get available coverage products.
+   */
+  "Coverage products": {
+    parameters: {
+      path: {
+        storeId: components["parameters"]["store-id.param"];
+      };
+    };
+    requestBody: {
+      content: {
+        "application/json": {
+          cart: components["schemas"]["storefront-cart.schema"];
+          customer?: components["schemas"]["storefront-customer.schema"];
+        };
+      };
+    };
+    responses: {
+      /** @description Success */
+      200: {
+        content: {
+          "application/json": {
+            /**
+             * Coverage Products
+             * @description Coverage products.
+             */
+            coverageProducts: components["schemas"]["coverage-product.schema"][];
+          };
+        };
+      };
+      /** @description Error */
+      default: {
+        content: {
+          "application/problem+json": components["schemas"]["error.schema"];
+        };
+      };
+    };
+  };
   /**
    * Get invoice
    * @description Get a list of invoices.
@@ -953,7 +1078,7 @@ export interface operations {
       200: {
         content: {
           "application/json": {
-            invoice: components["schemas"]["invoice.schema"];
+            invoices: components["schemas"]["invoice.schema"][];
           };
         };
       };

package/lib/openapi.yaml

@@ -140,6 +140,46 @@ components:
           title: Message comment
           type: object
       title: Comment
+    coverage-product.schema:
+      description: Coverage product.
+      properties:
+        coverages:
+          description: Coverage.
+          items:
+            properties:
+              lineItems:
+                items:
+                  properties:
+                    id:
+                      description: Line item ID.
+                      title: ID
+                      type: string
+                  type: object
+                type: array
+              type:
+                enum:
+                  - shipping_failure
+                  - return_shipping
+                title: Coverage
+            required:
+              - lineItems
+              - type
+            type: object
+          type: array
+        id:
+          description: Coverage ID.
+          title: ID
+          type: string
+        price:
+          $ref: '#/components/schemas/money.schema'
+          description: Price.
+          title: Price
+      required:
+        - coverage
+        - id
+        - price
+      title: Coverage product
+      type: object
     error.schema:
       description: Problem details. See [RFC 7807 Section 3](https://datatracker.ietf.org/doc/html/rfc7807#section-3).
       properties:
@@ -304,7 +344,7 @@ components:
                 example: '123'
                 type:
                   - string
-                  - null
+                  - 'null'
               id:
                 description: Line item ID
                 title: ID
@@ -667,6 +707,66 @@ components:
       example: open
       title: Return status
       type: string
+    storefront-cart.schema:
+      description: Storefront cart.
+      properties:
+        lineItems:
+          description: Line items.
+          items:
+            properties:
+              id:
+                description: Line item ID.
+                title: ID
+                type: string
+              priceTotal:
+                $ref: '#/components/schemas/money.schema'
+                description: Total price.
+                title: Price
+              product:
+                description: Product.
+                properties:
+                  id:
+                    title: ID
+                    type: string
+                type: object
+              quantity:
+                description: Quantity.
+                title: Quantity
+                type: integer
+              variant:
+                description: Variant.
+                properties:
+                  id:
+                    title: ID
+                    type: string
+                type: object
+            required:
+              - id
+              - quantity
+              - product
+              - variant
+            type: object
+          title: Line items
+          type: array
+        priceTotal:
+          $ref: '#/components/schemas/money.schema'
+          description: Total price.
+          title: Price
+      required:
+        - lineItems
+      title: Storefront Cart
+      type: object
+    storefront-customer.schema:
+      description: Storefront customer.
+      properties:
+        id:
+          description: Customer ID.
+          title: ID
+          type: string
+      required:
+        - id
+      title: Storefront Customer
+      type: object
     webhook-create.schema:
       description: Webhook create.
       properties:
@@ -813,7 +913,7 @@ info:
     If the response is not a 2xx status code, the event will be retried multiple
     times before discarding it.
   title: Redo API
-  version: 2.2.0
+  version: 2.2.1
 openapi: 3.1.0
 paths:
   /invoices/{invoiceId}/items.csv:
@@ -1000,21 +1100,71 @@ paths:
       tags:
         - Returns
     summary: Return status
+  /stores/{storeId}/coverage-products:
+    description: Available coverage products.
+    post:
+      description: Get available coverage products.
+      operationId: Coverage products
+      parameters:
+        - $ref: '#/components/parameters/store-id.param'
+      requestBody:
+        content:
+          application/json:
+            schema:
+              properties:
+                cart:
+                  $ref: '#/components/schemas/storefront-cart.schema'
+                customer:
+                  $ref: '#/components/schemas/storefront-customer.schema'
+              required:
+                - cart
+              type: object
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                properties:
+                  coverageProducts:
+                    description: Coverage products.
+                    items:
+                      $ref: '#/components/schemas/coverage-product.schema'
+                    title: Coverage Products
+                    type: array
+                required:
+                  - coverageProducts
+                type: type
+          description: Success
+        default:
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/error.schema'
+          description: Error
+      summary: Get coverage products
+      tags:
+        - Coverage Products
+    summary: Coverage products
   /stores/{storeId}/invoices:
     description: Return a list of invoices.
     get:
       description: Get a list of invoices.
       operationId: Invoice list
+      parameters:
+        - $ref: '#/components/parameters/store-id.param'
       responses:
         '200':
           content:
             application/json:
               schema:
                 properties:
-                  invoice:
-                    $ref: '#/components/schemas/invoice.schema'
+                  invoices:
+                    items:
+                      $ref: '#/components/schemas/invoice.schema'
+                    type: array
                 required:
-                  - invoice
+                  - invoices
                 type: object
           description: Success
         default:
@@ -1028,8 +1178,6 @@ paths:
       summary: Get invoice
       tags:
         - Invoice
-    parameters:
-      - $ref: '#/components/parameters/store-id.param'
     summary: Invoice
   /stores/{storeId}/returns:
     description: List of returns for store.

package/package.json

@@ -31,5 +31,5 @@
       ]
     }
   },
-  "version": "2.2.63"
+  "version": "2.2.75"
 }