@allisall/sdk 0.0.0-stage → 0.2.0

package/dist/generated/openapi.js

@@ -0,0 +1,4 @@
+// Generated from the API's OpenAPI document by scripts/generate.mjs.
+// Never edit this file by hand: change the document or the script, and
+// regenerate.
+export {};

package/dist/generated/operations.d.ts

@@ -0,0 +1,37 @@
+import type { operations } from "./openapi.js";
+/** The path segment that stands for every item of an array. */
+export declare const ITEMS = "*";
+/** A path to a value in a JSON body: member names, with ITEMS for every item of an array. */
+export type JsonPath = readonly string[];
+/** What the SDK needs to know about one operation, beyond its types. */
+export interface Operation {
+    /** The HTTP method. */
+    readonly method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+    /** The path template, such as "/v1/clients/{id}". */
+    readonly path: string;
+    /** Who may call it, from the operation's access policy. */
+    readonly access: "KeyOnly" | "KeyOrSession" | "SessionOnly" | "Public" | "ShareToken";
+    /** The scope an API key needs, or null when the policy names none. */
+    readonly scope: "ingest" | "read" | "write" | null;
+    /** Whether it takes an Idempotency-Key. */
+    readonly idempotent: boolean;
+    /** The list kind, or null when it is not a list. */
+    readonly list: "keyset" | "offset" | null;
+    /** The request body it takes. */
+    readonly body: "none" | "json" | "merge-patch" | "multipart";
+    /** The status of its success response. */
+    readonly status: number;
+    /** The path of every Money value in its request body. */
+    readonly requestMoney: readonly JsonPath[];
+    /** The path of every Money value in its success response. */
+    readonly responseMoney: readonly JsonPath[];
+}
+/**
+ * The operations the SDK can call, by operationId. Each must be an operation
+ * of the generated types, or the table below fails to compile.
+ */
+export type OperationId = Extract<keyof operations, "commitImport" | "createAgent" | "createApiKey" | "createCalculation" | "createClient" | "createCostLineItem" | "createReport" | "createValueModel" | "deleteAgent" | "deleteCalculation" | "deleteClient" | "deleteCostLineItem" | "deleteReport" | "deleteValueModel" | "getAgent" | "getApiKey" | "getCalculation" | "getClient" | "getClientAnomalies" | "getClientCost" | "getClientRoi" | "getClientValue" | "getClientValueModel" | "getCostLineItem" | "getDashboard" | "getHealth" | "getPriceTable" | "getReport" | "getSharedReport" | "getValueModel" | "ingestEvents" | "listAgents" | "listApiKeys" | "listCalculationReports" | "listClientCalculations" | "listClientEvents" | "listClientOutcomeTypes" | "listClients" | "listCostLineItems" | "listOutcomeTypes" | "listRenewals" | "listValueModels" | "listValueTemplates" | "previewImport" | "publishCalculation" | "reopenCalculation" | "revokeApiKey" | "revokeReport" | "setClientAgents" | "setPriceTable" | "setValueModelLineItems" | "shareReport" | "updateAgent" | "updateClient" | "updateCostLineItem" | "updateReport" | "updateValueModel" | "validateCalculation">;
+/** The operation table, one entry per operation the SDK can call. */
+export declare const OPERATIONS: {
+    readonly [K in OperationId]: Operation;
+};