@allisall/sdk 0.4.0 → 0.5.0

package/dist/generated/openapi.d.ts

@@ -1143,10 +1143,10 @@ export interface components {
          */
         UndefinedReason: "no_value_model" | "zero_cost" | "no_counted_clients";
         /**
-         * @description A coverage finding on a report. Each kind appears at most once per report. `facts` per kind: `empty` `{}`; `unpriced` `{outcome_types: [{outcome_type, quantity}], outcome_types_omitted}`, at most 100 outcome types by quantity, largest first, with `outcome_types_omitted` counting the rest, which a report composed before the count existed lacks; `key_unset` `{}`; `unmatched` `{keys}`; `unattributable` `{events}`; `precedes` `{}`; `unpriceable` `{models}`; `uncosted` `{events}`; `token_valued` `{events}`; `unattributed` `{line_items}`; `partial` `{line_items}`; `truncated` `{prorated_through}`.
+         * @description A coverage finding on a report. Each kind appears at most once per report. `no_value_model` means the client had no value model for the period. It replaces every other finding about value, so `empty`, `unpriced`, `key_unset`, `unmatched`, `unattributable` and `precedes` never appear beside it. `facts` per kind: `no_value_model` `{}`; `empty` `{}`; `unpriced` `{outcome_types: [{outcome_type, quantity}], outcome_types_omitted}`, at most 100 outcome types by quantity, largest first, with `outcome_types_omitted` counting the rest, which a report composed before the count existed lacks; `key_unset` `{}`; `unmatched` `{keys}`; `unattributable` `{events}`; `precedes` `{}`; `unpriceable` `{models}`; `uncosted` `{events}`; `token_valued` `{events}`; `unattributed` `{line_items}`; `partial` `{line_items}`; `truncated` `{prorated_through}`.
          * @enum {string}
          */
-        DisclosureKind: "empty" | "unpriced" | "key_unset" | "unmatched" | "unattributable" | "precedes" | "unpriceable" | "uncosted" | "token_valued" | "unattributed" | "partial" | "truncated";
+        DisclosureKind: "no_value_model" | "empty" | "unpriced" | "key_unset" | "unmatched" | "unattributable" | "precedes" | "unpriceable" | "uncosted" | "token_valued" | "unattributed" | "partial" | "truncated";
         /**
          * @description Why a client is not counted in the dashboard totals. `not_published_this_period`: it has published, but not for this month. `never_published`: no published calculation for any period. `published_off_grid`: a published calculation overlaps the month without equalling it. `no_value_model` and `zero_cost`: the published figure has no ratio.
          * @enum {string}
@@ -1565,20 +1565,20 @@ export interface components {
             total: components["schemas"]["Money"];
             provenance_note: string;
         };
-        /** @description Every way value could be missing from the total. */
+        /** @description Every way value could be missing from the total. When `value_model` is `null` there is no total: `unpriced_outcome_types` and `unmatched_client_keys` are empty, with their `_omitted` counts `0`; `unattributable_outcome_events` is `0`; `line_items_empty` and `period_precedes_model` are `false`; and `client_key_unset` is reported as usual. A calculation snapshot taken earlier may still carry unpriced outcome types, unmatched client keys and unattributable outcome events here, so read `value_model` first. */
         ValueCoverage: {
-            /** @description Outcome types attributed to the client that no line item prices, by quantity, largest first, then by outcome type compared by Unicode code point. At most 100: `unpriced_outcome_types_omitted` counts the rest. */
+            /** @description Outcome types attributed to the client that no line item prices, by quantity, largest first, then by outcome type compared by Unicode code point. At most 100: `unpriced_outcome_types_omitted` counts the rest. Empty when `value_model` is `null`: with no model nothing is priced, so no type is listed as unpriced. */
             unpriced_outcome_types: components["schemas"]["OutcomeTypeUsage"][];
             /** @description How many unpriced outcome types `unpriced_outcome_types` leaves out, `0` when it lists every one. The totals and counts in the response cover every one. */
             unpriced_outcome_types_omitted: number;
-            /** @description Event client keys that match no client in the workspace, by event count, largest first, then by client key compared by Unicode code point. At most 100: `unmatched_client_keys_omitted` counts the rest. */
+            /** @description Event client keys that match no client in the workspace, by event count, largest first, then by client key compared by Unicode code point. At most 100: `unmatched_client_keys_omitted` counts the rest. Reported only when `value_model` is not `null`; otherwise empty. */
             unmatched_client_keys: {
                 client_key: string;
                 events: number;
             }[];
             /** @description How many unmatched client keys `unmatched_client_keys` leaves out, `0` when it lists every one. */
             unmatched_client_keys_omitted: number;
-            /** @description Outcome events in the workspace that attribute to no client. */
+            /** @description Outcome events in the workspace that attribute to no client. Reported only when `value_model` is not `null`; otherwise `0`. */
             unattributable_outcome_events: number;
             /** @description Whether the client has no `client_key`, so only solo-agent attribution reaches it. */
             client_key_unset: boolean;
@@ -1590,7 +1590,7 @@ export interface components {
         /** @description A value computation. */
         ValueResult: {
             value_model: components["schemas"]["ValueModelRef"] | null;
-            /** @description One line for each line item of the model, in line-item order, so at most 50. An outcome type no line item prices is never a line; it is listed in `coverage.unpriced_outcome_types`. */
+            /** @description One line for each line item of the model, in line-item order, so at most 50. An outcome type no line item prices is never a line; when the client has a value model, it is listed in `coverage.unpriced_outcome_types`. */
             lines: components["schemas"]["ValueLine"][];
             /** @description `null` together with `value_model` when the client has no active model: not priced, which differs from zero. */
             total: components["schemas"]["Money"] | null;
@@ -1912,7 +1912,7 @@ export interface components {
             published_at: components["schemas"]["Instant"] | null;
             /** @description Whether this is the figure for its period: the latest publication covering it. `null` when the calculation is not published. */
             is_current: boolean | null;
-            /** @description How many coverage findings the calculation's frozen figures hold: the disclosures a report on it would list, including those a report leaves out of the shared copy by default. */
+            /** @description How many coverage findings the calculation's frozen figures hold: the disclosures a report composed from it would list, including those a report leaves out of the shared copy by default. When the client had no value model for the period, the findings about value count as one, `no_value_model`. A report keeps the disclosures it was composed with, so a report composed earlier can list a different set, more or fewer than this count. */
             coverage_findings: number;
         };
         CalculationCreate: {
@@ -1953,7 +1953,7 @@ export interface components {
             letterhead_workspace_name: string;
             /** @description Free text, `""` when empty. */
             note: string;
-            /** @description In the order the calculation's coverage produced them. At most 12: each kind appears at most once. */
+            /** @description In the order the calculation's coverage produced them. At most 12: each kind appears at most once, and `no_value_model` never appears beside the six findings about value it replaces. */
             disclosures: components["schemas"]["Disclosure"][];
             /** @description The link token, once shared. `null` before the report is shared. */
             share_token: string | null;
@@ -2010,7 +2010,7 @@ export interface components {
             workspace_name: string;
             /** @description Free text, `""` when empty. */
             note: string;
-            /** @description The included findings only, in report order. At most 12: each kind appears at most once. */
+            /** @description The included findings only, in report order. At most 12: each kind appears at most once, and `no_value_model` never appears beside the six findings about value it replaces. */
             disclosures: components["schemas"]["Disclosure"][];
             period: components["schemas"]["Period"];
             currency: components["schemas"]["Currency"];
@@ -2093,9 +2093,9 @@ export interface components {
             value_by_outcome_omitted: number;
             /** @description The value of the outcome types `value_by_outcome` leaves out, `0` when it lists every one. The `total` of every listed entry plus this equals `value_total` exactly, as decimals, for figures of up to 15 significant digits, so a chart can show the rest as one share without adding money itself. */
             value_by_outcome_omitted_total: components["schemas"]["Money"];
-            /** @description The five agents with the highest cost, by `total`, largest first, then by `agent_id`. */
+            /** @description The five agents with the highest cost across the counted clients' figures, by `total`, largest first, then by `agent_id`. An agent serving several clients is one entry, with its cost summed across them. Only a figure that records cost per agent contributes: `agent_costs_recorded` says how many do. Fewer than five when fewer agents appear in those figures. */
             agent_costs: components["schemas"]["AgentCostLine"][];
-            /** @description Agents with recorded cost in the month. */
+            /** @description How many counted clients have a figure that records cost per agent. A figure records cost per agent even when no agent has any cost. Compare it with `counted`. When it is lower, some figures were published before the API recorded cost per agent, and they never gain it, so `agent_costs` ranks agents over only part of `cost_total`. */
             agent_costs_recorded: number;
             /** @description Unpriced outcome types across the counted clients' figures, by event count, largest first, then by outcome type compared by Unicode code point. An outcome type is grouped ignoring case and surrounding spaces, with its events summed across spellings. At most 100: `unpriced_outcome_types_omitted` counts the rest. */
             unpriced_outcome_types: {

package/dist/version.d.ts

@@ -1,2 +1,2 @@
 /** The SDK's version. The release tooling updates it; never edit it by hand. */
-export declare const VERSION = "0.4.0";
+export declare const VERSION = "0.5.0";

package/dist/version.js

@@ -1,2 +1,2 @@
 /** The SDK's version. The release tooling updates it; never edit it by hand. */
-export const VERSION = "0.4.0"; // x-release-please-version
+export const VERSION = "0.5.0"; // x-release-please-version

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allisall/sdk",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "The allisall SDK for TypeScript and JavaScript: a typed client for the allisall API, from sending events to publishing reports.",
   "license": "Apache-2.0",
   "repository": {