@kosdev-code/kos-dispense-sdk 2.0.43 → 2.0.45

package/models/utils/services/dispense/1.6.5/openapi.d.ts

@@ -0,0 +1,845 @@
+export interface paths {
+  "/api/ext/dispense/pumpEvents/replaceLine/{holder}": {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    get?: never;
+    put?: never;
+    /** Indicate that the lines associated with holder have been replaced. (v1.0) */
+    post: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path: {
+          /** @description The holder associated with the replaced line. */
+          holder: string;
+        };
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description OK */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content?: never;
+        };
+      };
+    };
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  "/api/ext/dispense/pumpEvents/replacePump/{pump}": {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    get?: never;
+    put?: never;
+    /** Indicate that the specified pump has been replaced. (v1.0) */
+    post: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path: {
+          /** @description The pump that has been replaced. */
+          pump: string;
+        };
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description OK */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content?: never;
+        };
+      };
+    };
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  "/api/ext/dispense/ingredients": {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /** Return the list of all currently known ingredients by sourceId. (v1.0) */
+    get: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path?: never;
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description OK */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            "application/json": components["schemas"]["504fffac-5661-48bf-8556-b4de9a420099"];
+          };
+        };
+      };
+    };
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  "/api/ext/dispense/ingredients/sources": {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /** Return the list of all currently known sources. (v1.0) */
+    get: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path?: never;
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description OK */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            "application/json": components["schemas"]["8ecd7a2e-829a-490e-88a3-3bf617a5ecae"];
+          };
+        };
+      };
+    };
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  "/api/ext/dispense/insertion/filters": {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /** Return the filters in the chain. (v1.0) */
+    get: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path?: never;
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description OK */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            "application/json": components["schemas"]["59f341e8-c61f-41dc-8c1f-a14d5a296dad"];
+          };
+        };
+      };
+    };
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  "/api/ext/dispense/metrics": {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /** Return all metrics in the system. This should only be used for debugging. (v1.0) */
+    get: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path?: never;
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description OK */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            "application/json": components["schemas"]["721ad844-3ba1-460b-aa78-857142241aa1"];
+          };
+        };
+      };
+    };
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  "/api/ext/dispense/metrics/names": {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /** Return the names of all global metrics. (v1.0) */
+    get: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path?: never;
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description OK */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            "application/json": components["schemas"]["8ecd7a2e-829a-490e-88a3-3bf617a5ecae"];
+          };
+        };
+      };
+    };
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  "/api/ext/dispense/metrics/{name}": {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /** Return the named global metrics object. (v1.0) */
+    get: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path: {
+          /** @description Name of the metrics to return. */
+          name: string;
+        };
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description OK */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            "application/json": components["schemas"]["f53d3e2a-4f5c-4622-b51a-2e226184aeaf"];
+          };
+        };
+      };
+    };
+    put?: never;
+    /** Create / reset the named global metrics object. (v1.0) */
+    post: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path: {
+          /** @description Name of the metrics to create / reset. */
+          name: string;
+        };
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description OK */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content?: never;
+        };
+      };
+    };
+    /** Remove the named global metrics object. (v1.0) */
+    delete: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path: {
+          /** @description Name of the metrics to remove. */
+          name: string;
+        };
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description OK */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content?: never;
+        };
+      };
+    };
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  "/api/ext/dispense/metrics/{nozzle}/names": {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /** Return the names of all metrics for the nozzle. (v1.0) */
+    get: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path: {
+          /** @description Path of the nozzle to query. */
+          nozzle: string;
+        };
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description OK */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            "application/json": components["schemas"]["8ecd7a2e-829a-490e-88a3-3bf617a5ecae"];
+          };
+        };
+      };
+    };
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  "/api/ext/dispense/metrics/{nozzle}/{name}": {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /** Return the named metrics object for the nozzle. (v1.0) */
+    get: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path: {
+          /** @description Path of the nozzle to query. */
+          nozzle: string;
+          /** @description Name of the metrics to return. */
+          name: string;
+        };
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description OK */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            "application/json": components["schemas"]["f53d3e2a-4f5c-4622-b51a-2e226184aeaf"];
+          };
+        };
+      };
+    };
+    put?: never;
+    /** Create / reset the named metrics object for the nozzle. (v1.0) */
+    post: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path: {
+          /** @description Path of the nozzle to query. */
+          nozzle: string;
+          /** @description Name of the metrics to create / reset. */
+          name: string;
+        };
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description OK */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content?: never;
+        };
+      };
+    };
+    /** Remove the named metrics object for the nozzle. (v1.0) */
+    delete: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path: {
+          /** @description Path of the nozzle to query. */
+          nozzle: string;
+          /** @description Name of the metrics to remove. */
+          name: string;
+        };
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description OK */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content?: never;
+        };
+      };
+    };
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  "/api/ext/dispense/assignments": {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /** Returns all existing ingredient assigments. (v1.0) */
+    get: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path?: never;
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description OK */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            "application/json": components["schemas"]["34a22bb0-b634-43f2-8f88-0826b22d19ed"];
+          };
+        };
+      };
+    };
+    put?: never;
+    /** Create a new ingredient assignment for the specified holder. If an existing
+     *     assignment exists for the holder, it will be removed as part of adding the
+     *     new mapping. (v1.0) */
+    post: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path?: never;
+        cookie?: never;
+      };
+      requestBody: {
+        content: {
+          "application/json": components["schemas"]["95c6b189-20f0-4999-8e7c-e326bc9cc30e"];
+        };
+      };
+      responses: {
+        /** @description OK */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            "application/json": components["schemas"]["95c6b189-20f0-4999-8e7c-e326bc9cc30e"];
+          };
+        };
+      };
+    };
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  "/api/ext/dispense/assignments/{holderPath}": {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    get?: never;
+    put?: never;
+    post?: never;
+    /** Delete an existing ingredient mapping for the specified holder. (v1.0) */
+    delete: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path: {
+          /** @description The handle path for the holder */
+          holderPath: string;
+        };
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description OK */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content?: never;
+        };
+      };
+    };
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  "/api/ext/dispense/soldOuts/container/{pump}/{reason}": {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    get?: never;
+    put?: never;
+    /** Create a sold out trouble for the container attached to the pump. (v1.0) */
+    post: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path: {
+          /** @description Handle for the pump. */
+          pump: string;
+          /** @description Reason for the trouble. */
+          reason: string;
+        };
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description OK */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content?: never;
+        };
+      };
+    };
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  "/api/ext/dispense/soldOuts/slice/{pump}/{reason}": {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    get?: never;
+    put?: never;
+    /** Create a sold out trouble for the container attached to the pump. (v1.0) */
+    post: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path: {
+          /** @description Handle for the pump. */
+          pump: string;
+          /** @description Reason for the trouble. */
+          reason: string;
+        };
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description OK */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content?: never;
+        };
+      };
+    };
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  "/api/ext/dispense/soldOuts/troubles": {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /** Return all existing SoldOutAware troubles. (v1.0) */
+    get: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path?: never;
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description OK */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            "application/json": components["schemas"]["b77205bf-f552-426e-89ec-595bd1309604"];
+          };
+        };
+      };
+    };
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  "/api/ext/dispense/soldOuts/db": {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /** Return the sold out data from the database. (v1.0) */
+    get: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path?: never;
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description OK */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            "application/json": components["schemas"]["f298c456-a639-4eb0-b6ee-d87da4e7c177"];
+          };
+        };
+      };
+    };
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+  schemas: {
+    /** @description (typeName=java.util.Collection<? extends com.tccc.kos.ext.dispense.service.ingredient.BaseIngredient>) */
+    "504fffac-5661-48bf-8556-b4de9a420099": components["schemas"]["24ad4bcc-87de-4b4d-a1c9-7b269df17128"];
+    "24ad4bcc-87de-4b4d-a1c9-7b269df17128": components["schemas"]["1b8f1b11-68f6-4da6-8bf7-30338b29deba"][];
+    "1b8f1b11-68f6-4da6-8bf7-30338b29deba": {
+      sourceId?: string;
+      name?: string;
+      id?: string;
+      type?: string;
+    };
+    "8ecd7a2e-829a-490e-88a3-3bf617a5ecae": string[];
+    "59f341e8-c61f-41dc-8c1f-a14d5a296dad": components["schemas"]["36886c70-659a-4397-b970-c0652b5b754c"][];
+    "36886c70-659a-4397-b970-c0652b5b754c": {
+      /** Format: double */
+      position?: number;
+      /** Format: double */
+      group?: number;
+    };
+    /** @description (typeName=java.util.Map<java.lang.String, com.tccc.kos.ext.dispense.service.nozzle.metrics.NozzleMetrics>) */
+    "721ad844-3ba1-460b-aa78-857142241aa1": components["schemas"]["0110553d-e2cc-4a3a-bf54-16e3261810a6"];
+    /** @description (typeName=com.tccc.kos.ext.dispense.service.nozzle.metrics.NozzleMetrics) */
+    "0110553d-e2cc-4a3a-bf54-16e3261810a6": components["schemas"]["5179dde3-0421-4404-937d-a397d7a6bdcd"];
+    "5179dde3-0421-4404-937d-a397d7a6bdcd": {
+      /** Format: int64 */
+      lastChangedTimeMono?: number;
+      /** Format: double */
+      totalVolume?: number;
+      internal?: boolean;
+      /** Format: int64 */
+      creationTimeMS?: number;
+      /** @description (typeName=java.util.Collection<java.lang.String>) */
+      ingredientIds?: components["schemas"]["8ecd7a2e-829a-490e-88a3-3bf617a5ecae"];
+      /** Format: date-time */
+      creationDate?: string;
+      /** @description (typeName=java.util.Map<java.lang.String, com.tccc.kos.ext.dispense.service.nozzle.metrics.NozzleMetrics$Info>) */
+      byIngredients?: components["schemas"]["170aeb40-d829-4aae-b4cb-55c15c480eee"];
+      /** @description (typeName=java.util.Map<java.lang.String, com.tccc.kos.ext.dispense.service.nozzle.metrics.NozzleMetrics$Info>) */
+      byPumps?: components["schemas"]["170aeb40-d829-4aae-b4cb-55c15c480eee"];
+      /** @description (typeName=java.util.Collection<java.lang.String>) */
+      pumpPaths?: components["schemas"]["8ecd7a2e-829a-490e-88a3-3bf617a5ecae"];
+      removed?: boolean;
+      name?: string;
+      /** Format: int64 */
+      lastChangedTimeMS?: number;
+      locked?: boolean;
+    };
+    /** @description (typeName=com.tccc.kos.ext.dispense.service.nozzle.metrics.NozzleMetrics$Info) */
+    "170aeb40-d829-4aae-b4cb-55c15c480eee": components["schemas"]["f2830d0b-33bd-4b66-b67a-73193bc5f09c"];
+    "f2830d0b-33bd-4b66-b67a-73193bc5f09c": {
+      /** Format: double */
+      volume?: number;
+    };
+    "f53d3e2a-4f5c-4622-b51a-2e226184aeaf": {
+      /** Format: double */
+      totalVolume?: number;
+      internal?: boolean;
+      /** Format: int64 */
+      creationTimeMS?: number;
+      name?: string;
+      /** Format: int64 */
+      lastChangedTimeMS?: number;
+      /** Format: date-time */
+      creationDate?: string;
+      locked?: boolean;
+      /** @description (typeName=java.util.Map<java.lang.String, com.tccc.kos.ext.dispense.service.nozzle.metrics.NozzleMetrics$Info>) */
+      byIngredients?: components["schemas"]["cefa8b93-0d01-4056-bc0d-d30b0986f229"];
+      /** @description (typeName=java.util.Map<java.lang.String, com.tccc.kos.ext.dispense.service.nozzle.metrics.NozzleMetrics$Info>) */
+      byPumps?: components["schemas"]["cefa8b93-0d01-4056-bc0d-d30b0986f229"];
+    };
+    /** @description (typeName=com.tccc.kos.ext.dispense.service.nozzle.metrics.NozzleMetrics$Info) */
+    "cefa8b93-0d01-4056-bc0d-d30b0986f229": components["schemas"]["d02a1c94-2a1b-4afe-b786-f96be7d9d3c8"];
+    "d02a1c94-2a1b-4afe-b786-f96be7d9d3c8": unknown;
+    "34a22bb0-b634-43f2-8f88-0826b22d19ed": components["schemas"]["95c6b189-20f0-4999-8e7c-e326bc9cc30e"][];
+    "95c6b189-20f0-4999-8e7c-e326bc9cc30e": {
+      ingredientId?: string;
+      holderPath?: string;
+      /** Format: int64 */
+      createTime?: number;
+      factoryJson?: string;
+      containerId?: string;
+      error?: string;
+    };
+    "b77205bf-f552-426e-89ec-595bd1309604": components["schemas"]["7faf8dde-776b-4d2c-8a1b-7ba949e29341"][];
+    "7faf8dde-776b-4d2c-8a1b-7ba949e29341": {
+      reason?: string;
+      /** Format: date-time */
+      createTime?: string;
+      resolvable?: boolean;
+      /** @description (typeName=java.util.Set<java.lang.String>) */
+      ifaces?: components["schemas"]["c2b901cf-42b2-4fb1-bbaa-d18cfd447958"];
+      /** Format: int32 */
+      id?: number;
+      /** @description (typeName=com.tccc.kos.commons.util.json.JsonViewWrapper) */
+      clientData?: components["schemas"]["b7b3414c-71a5-4ace-ae92-95a45e4cb59a"];
+      type?: string;
+      /** @description (typeName=java.util.Set<java.lang.String>) */
+      tags?: components["schemas"]["c2b901cf-42b2-4fb1-bbaa-d18cfd447958"];
+      /** @description (typeName=com.tccc.kos.commons.core.service.trouble.TroubleInfo) */
+      info?: components["schemas"]["95da3c05-8b5e-4e0d-96f5-bef97e3c6760"];
+      group?: string;
+    };
+    "c2b901cf-42b2-4fb1-bbaa-d18cfd447958": string[];
+    "b7b3414c-71a5-4ace-ae92-95a45e4cb59a": unknown;
+    "95da3c05-8b5e-4e0d-96f5-bef97e3c6760": {
+      color?: string;
+      /** Format: int32 */
+      rank?: number;
+      actionRole?: string;
+      visibleRole?: string;
+    };
+    "f298c456-a639-4eb0-b6ee-d87da4e7c177": components["schemas"]["e82abbbd-c8d8-4ebf-8674-5777e53a41b3"][];
+    "e82abbbd-c8d8-4ebf-8674-5777e53a41b3": {
+      /** Format: int32 */
+      slicePos?: number;
+      /** Format: int64 */
+      createTime?: number;
+      containerId?: string;
+      /** Format: int32 */
+      soldOutCount?: number;
+      /** Format: int64 */
+      lastUpdateTime?: number;
+    };
+  };
+  responses: never;
+  parameters: never;
+  requestBodies: never;
+  headers: never;
+  pathItems: never;
+}
+export type $defs = Record<string, never>;
+export type operations = Record<string, never>;