@redotech/redo-api-schema 2.2.44 → 2.2.63

package/lib/openapi.d.ts

@@ -10,6 +10,13 @@ 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 {
+  "/invoices/{invoiceId}/items.csv": {
+    /**
+     * Get invoice
+     * @description Get an invoice as a CSV.
+     */
+    get: operations["Invoice csv get"];
+  };
   "/returns/{returnId}": {
     /**
      * Get return
@@ -18,7 +25,7 @@ export interface paths {
     get: operations["Return get"];
     parameters: {
       path: {
-        storeId: components["parameters"]["store-id.param"];
+        returnId: components["parameters"]["return-id.param"];
       };
     };
   };
@@ -56,6 +63,18 @@ export interface paths {
       };
     };
   };
+  "/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": {
     /**
      * List returns
@@ -249,6 +268,29 @@ export interface components {
        */
       url: string;
     };
+    /** @description Schema for an invoice. */
+    "invoice.schema": {
+      /** @description The charge that the invoice is for. */
+      charge: components["schemas"]["money.schema"];
+      /**
+       * Format: date-time
+       * @description The time the invoice was created.
+       */
+      createdAt: string;
+      /** @description The ID of the charge. */
+      id?: string;
+      /** @description The status of the invoice. */
+      status: string;
+      store?: {
+        /** @description The ID of the store. */
+        id: string;
+      };
+      /**
+       * Format: date-time
+       * @description The time the invoice was last updated.
+       */
+      updatedAt: string;
+    };
     /**
      * Item quantity
      * @description Item quantity.
@@ -261,7 +303,7 @@ export interface components {
      */
     "money.schema": {
       /** Amount */
-      amount?: number;
+      amount?: string;
       /** Currency */
       currency?: string;
     };
@@ -300,21 +342,28 @@ export interface components {
        */
       id: string;
       /** Line items */
-      items: {
+      items: ({
           /** @example 123 */
           externalId?: string;
+          /**
+           * @description ID of the location where the item was be fulfilled.
+           * @example 123
+           */
+          fulfillmentLocationId: string | Record<string, never>;
           /**
            * ID
            * @description Line item ID
            */
           id: string;
+          /** Price */
+          price: components["schemas"]["money.schema"];
           /** Product */
           product: components["schemas"]["product.schema"];
           /** Quantity */
           quantity: components["schemas"]["item-quantity.schema"];
           /** Variant */
           variant: components["schemas"]["product-variant.schema"];
-        }[];
+        })[];
       /**
        * Name
        * @description Shopify name.
@@ -677,6 +726,8 @@ export interface components {
   };
   responses: never;
   parameters: {
+    /** @description Invoice ID */
+    "invoice-id.param": string;
     /**
      * @description Page marker, from X-Page-Next header
      * @example 64df700931a04885276c3364
@@ -718,6 +769,31 @@ export type external = Record<string, never>;
 
 export interface operations {
 
+  /**
+   * Get invoice
+   * @description Get an invoice as a CSV.
+   */
+  "Invoice csv get": {
+    parameters: {
+      path: {
+        invoiceId: components["parameters"]["invoice-id.param"];
+      };
+    };
+    responses: {
+      /** @description Success */
+      200: {
+        content: {
+          "text/csv": string;
+        };
+      };
+      /** @description Error */
+      default: {
+        content: {
+          "application/problem+json": components["schemas"]["error.schema"];
+        };
+      };
+    };
+  };
   /**
    * Get return
    * @description Get return.
@@ -725,7 +801,7 @@ export interface operations {
   "Return get": {
     parameters: {
       path: {
-        storeId: components["parameters"]["store-id.param"];
+        returnId: components["parameters"]["return-id.param"];
       };
     };
     responses: {
@@ -862,6 +938,33 @@ export interface operations {
       };
     };
   };
+  /**
+   * Get invoice
+   * @description Get a list of invoices.
+   */
+  "Invoice list": {
+    parameters: {
+      path: {
+        storeId: components["parameters"]["store-id.param"];
+      };
+    };
+    responses: {
+      /** @description Success */
+      200: {
+        content: {
+          "application/json": {
+            invoice: components["schemas"]["invoice.schema"];
+          };
+        };
+      };
+      /** @description Error */
+      default: {
+        content: {
+          "application/problem+json": components["schemas"]["error.schema"];
+        };
+      };
+    };
+  };
   /**
    * List returns
    * @description List returns, sorted by most recent to least recent.

package/lib/openapi.yaml

@@ -5,6 +5,14 @@ components:
       schema:
         type: string
   parameters:
+    invoice-id.param:
+      description: Invoice ID
+      in: path
+      name: invoiceId
+      required: true
+      schema:
+        example: 64e4d5e837572a4813b73e40
+        type: string
     page-continue.param:
       description: Page marker, from X-Page-Next header
       example: 64df700931a04885276c3364
@@ -194,6 +202,41 @@ components:
         - url
       title: HTTPS callback
       type: object
+    invoice.schema:
+      description: Schema for an invoice.
+      properties:
+        charge:
+          $ref: '#/components/schemas/money.schema'
+          description: The charge that the invoice is for.
+        createdAt:
+          description: The time the invoice was created.
+          format: date-time
+          type: string
+        id:
+          description: The ID of the charge.
+          type: string
+        status:
+          description: The status of the invoice.
+          type: string
+        store:
+          properties:
+            id:
+              description: The ID of the store.
+              type: string
+          required:
+            - id
+          type: object
+        updatedAt:
+          description: The time the invoice was last updated.
+          format: date-time
+          type: string
+      required:
+        - team
+        - updatedAt
+        - status
+        - createdAt
+        - charge
+      type: object
     item-quantity.schema:
       description: Item quantity.
       example: 1
@@ -205,10 +248,10 @@ components:
       properties:
         amount:
           examples:
-            - 50.2
-            - 1.78
+            - '50.2'
+            - '1.78'
           title: Amount
-          type: number
+          type: string
         currency:
           examples:
             - USD
@@ -256,10 +299,19 @@ components:
               externalId:
                 example: '123'
                 type: string
+              fulfillmentLocationId:
+                description: ID of the location where the item was be fulfilled.
+                example: '123'
+                type:
+                  - string
+                  - null
               id:
                 description: Line item ID
                 title: ID
                 type: string
+              price:
+                $ref: '#/components/schemas/money.schema'
+                title: Price
               product:
                 $ref: '#/components/schemas/product.schema'
                 title: Product
@@ -274,6 +326,8 @@ components:
               - product
               - quantity
               - variant
+              - price
+              - fulfillmentLocationId
           title: Line items
           type: array
         name:
@@ -762,6 +816,33 @@ info:
   version: 2.2.0
 openapi: 3.1.0
 paths:
+  /invoices/{invoiceId}/items.csv:
+    description: Return invoice CSV file.
+    get:
+      description: Get an invoice as a CSV.
+      operationId: Invoice csv get
+      parameters:
+        - $ref: '#/components/parameters/invoice-id.param'
+      responses:
+        '200':
+          content:
+            text/csv:
+              schema:
+                format: binary
+                type: string
+          description: Success
+        default:
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/error.schema'
+          description: Error
+      security:
+        - Bearer: []
+      summary: Get invoice
+      tags:
+        - Invoice
+    summary: Invoice
   /returns/{returnId}:
     description: Return.
     get:
@@ -794,7 +875,7 @@ paths:
       tags:
         - Returns
     parameters:
-      - $ref: '#/components/parameters/store-id.param'
+      - $ref: '#/components/parameters/return-id.param'
     summary: Return
   /returns/{returnId}/comments:
     description: Return comment.
@@ -919,6 +1000,37 @@ paths:
       tags:
         - Returns
     summary: Return status
+  /stores/{storeId}/invoices:
+    description: Return a list of invoices.
+    get:
+      description: Get a list of invoices.
+      operationId: Invoice list
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                properties:
+                  invoice:
+                    $ref: '#/components/schemas/invoice.schema'
+                required:
+                  - invoice
+                type: object
+          description: Success
+        default:
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/error.schema'
+          description: Error
+      security:
+        Bearer: []
+      summary: Get invoice
+      tags:
+        - Invoice
+    parameters:
+      - $ref: '#/components/parameters/store-id.param'
+    summary: Invoice
   /stores/{storeId}/returns:
     description: List of returns for store.
     get:

package/package.json

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