@allisall/sdk 0.2.0 → 0.4.0

package/dist/resources/onboarding.js

@@ -0,0 +1,34 @@
+// The `onboarding` operations.
+import { call } from "../request.js";
+/** The `onboarding` operations. */
+export class OnboardingOperations {
+    #config;
+    constructor(config) {
+        this.#config = config;
+    }
+    /**
+     * Reads the guided setup's progress: the five steps in their fixed
+     * order, each with whether the workspace's data completes it and when it
+     * was skipped, and `current_step`, the first step neither completed nor
+     * skipped. This is the read for the guided setup's progress.
+     *
+     * Needs the `read` scope. Operation `getOnboarding`.
+     */
+    get(options) {
+        return call(this.#config, "getOnboarding", { options });
+    }
+    /**
+     * Replaces the set of skipped steps, and resolves with the whole
+     * progress. `steps` replaces the whole set: a step left out is no longer
+     * skipped, and `[]` clears every skip. A step already skipped keeps its
+     * `skipped_at`.
+     *
+     * Retried on a failure worth retrying, because a repeat leaves the same
+     * set.
+     *
+     * Needs the `write` scope. Operation `setOnboardingSkippedSteps`.
+     */
+    setSkippedSteps(body, options) {
+        return call(this.#config, "setOnboardingSkippedSteps", { body, options });
+    }
+}

package/dist/resources/reports.d.ts

@@ -1,11 +1,26 @@
 import type { IdempotentRequestOptions, RequestOptions } from "../options.js";
 import type { PagePromise } from "../pagination.js";
 import type { TransportConfig } from "../transport.js";
-import type { ListCalculationReportsQuery, Report, ReportList, ReportPatch, ReportSummary, ReportWithPreview } from "../types.js";
+import type { ListCalculationReportsQuery, ListReportsQuery, Report, ReportList, ReportPatch, ReportSummary, ReportWithPreview, WorkspaceReportList } from "../types.js";
 /** The `reports` operations. */
 export declare class Reports {
     #private;
     constructor(config: TransportConfig);
+    /**
+     * Lists the workspace's reports across calculations, newest first, each
+     * without its disclosures. Await the result for one page; iterate it with
+     * `for await` for every report of every page.
+     *
+     * Pass `page` for a numbered page: its `body` then holds `page` and
+     * `total`. Only that first page is counted; every later page of a walk
+     * continues by cursor from it, and its `page` and `total` are `null`. To
+     * show another numbered page, call this method again with its `page`
+     * rather than `getNextPage()`. A `page` past the end has no items, and the
+     * walk ends there.
+     *
+     * Needs the `read` scope. Operation `listReports`.
+     */
+    list(query?: ListReportsQuery, options?: RequestOptions): PagePromise<ReportSummary, WorkspaceReportList>;
     /**
      * Composes a report on a published calculation, with its disclosures
      * taken from the calculation's coverage.

package/dist/resources/reports.js

@@ -7,6 +7,23 @@ export class Reports {
     constructor(config) {
         this.#config = config;
     }
+    /**
+     * Lists the workspace's reports across calculations, newest first, each
+     * without its disclosures. Await the result for one page; iterate it with
+     * `for await` for every report of every page.
+     *
+     * Pass `page` for a numbered page: its `body` then holds `page` and
+     * `total`. Only that first page is counted; every later page of a walk
+     * continues by cursor from it, and its `page` and `total` are `null`. To
+     * show another numbered page, call this method again with its `page`
+     * rather than `getNextPage()`. A `page` past the end has no items, and the
+     * walk ends there.
+     *
+     * Needs the `read` scope. Operation `listReports`.
+     */
+    list(query, options) {
+        return callPage(this.#config, "listReports", { query, options });
+    }
     /**
      * Composes a report on a published calculation, with its disclosures
      * taken from the calculation's coverage.

package/dist/resources/value-models.d.ts

@@ -11,6 +11,13 @@ export declare class ValueModels {
      * Lists value models. Await the result for one page; iterate it with
      * `for await` for every value model of every page.
      *
+     * Pass `page` for a numbered page: its `body` then holds `page` and
+     * `total`. Only that first page is counted; every later page of a walk
+     * continues by cursor from it, and its `page` and `total` are `null`. To
+     * show another numbered page, call this method again with its `page`
+     * rather than `getNextPage()`. A `page` past the end has no items, and the
+     * walk ends there.
+     *
      * Needs the `read` scope. Operation `listValueModels`.
      */
     list(query?: ListValueModelsQuery, options?: RequestOptions): PagePromise<ValueModelSummary, ValueModelList>;

package/dist/resources/value-models.js

@@ -11,6 +11,13 @@ export class ValueModels {
      * Lists value models. Await the result for one page; iterate it with
      * `for await` for every value model of every page.
      *
+     * Pass `page` for a numbered page: its `body` then holds `page` and
+     * `total`. Only that first page is counted; every later page of a walk
+     * continues by cursor from it, and its `page` and `total` are `null`. To
+     * show another numbered page, call this method again with its `page`
+     * rather than `getNextPage()`. A `page` past the end has no items, and the
+     * walk ends there.
+     *
      * Needs the `read` scope. Operation `listValueModels`.
      */
     list(query, options) {

package/dist/resources/workspace.d.ts

@@ -0,0 +1,15 @@
+import type { RequestOptions } from "../options.js";
+import type { TransportConfig } from "../transport.js";
+import type { Workspace } from "../types.js";
+/** The `workspace` operations. */
+export declare class WorkspaceOperations {
+    #private;
+    constructor(config: TransportConfig);
+    /**
+     * Reads the workspace the credential belongs to: its name, its currency
+     * and when it was created.
+     *
+     * Needs the `read` scope. Operation `getWorkspace`.
+     */
+    get(options?: RequestOptions): Promise<Workspace>;
+}

package/dist/resources/workspace.js

@@ -0,0 +1,18 @@
+// The `workspace` operations.
+import { call } from "../request.js";
+/** The `workspace` operations. */
+export class WorkspaceOperations {
+    #config;
+    constructor(config) {
+        this.#config = config;
+    }
+    /**
+     * Reads the workspace the credential belongs to: its name, its currency
+     * and when it was created.
+     *
+     * Needs the `read` scope. Operation `getWorkspace`.
+     */
+    get(options) {
+        return call(this.#config, "getWorkspace", { options });
+    }
+}

package/dist/types.d.ts

@@ -7,7 +7,7 @@ type Schemas = components["schemas"];
  */
 export type QueryOf<K extends keyof operations> = NonNullable<operations[K]["parameters"]["query"]>;
 /** The known request-level error codes, in the API's catalogue order. */
-export declare const ERROR_CODES: readonly ["invalid_json", "validation_failed", "unauthenticated", "insufficient_scope", "session_required", "account_not_provisioned", "not_found", "no_active_value_model", "method_not_allowed", "idempotency_key_in_use", "client_key_in_use", "agent_key_in_use", "client_has_events", "client_has_calculations", "agent_has_events", "client_key_has_events", "value_model_exists", "value_model_version_stale", "calculation_transition_invalid", "calculation_not_draft", "calculation_not_published", "report_shared", "report_not_shared", "api_key_revoked", "payload_too_large", "uri_too_long", "unsupported_media_type", "idempotency_key_reused", "rate_limited", "internal_error"];
+export declare const ERROR_CODES: readonly ["invalid_json", "validation_failed", "unauthenticated", "insufficient_scope", "session_required", "account_not_provisioned", "not_found", "no_active_value_model", "method_not_allowed", "idempotency_key_in_use", "client_key_in_use", "agent_key_in_use", "client_has_events", "client_has_calculations", "agent_has_events", "client_key_has_events", "value_model_exists", "value_model_version_stale", "calculation_transition_invalid", "calculation_not_draft", "calculation_not_published", "report_shared", "report_not_shared", "api_key_revoked", "invite_expired", "invite_used", "invite_revoked", "invite_email_mismatch", "email_has_workspace", "payload_too_large", "uri_too_long", "unsupported_media_type", "idempotency_key_reused", "rate_limited", "internal_error", "upstream_failed"];
 /** The known field-level error codes, in the API's catalogue order. */
 export declare const FIELD_ERROR_CODES: readonly ["required", "unknown_field", "immutable", "invalid_type", "invalid_format", "invalid_value", "too_long", "too_many", "out_of_range", "too_precise", "duplicate", "too_large", "mutually_exclusive", "unknown_reference", "client_key_required", "currency_mismatch"];
 /** The event categories. */
@@ -154,6 +154,10 @@ export type ClientStatus = Schemas["ClientStatus"];
 export type AgentStatus = Schemas["AgentStatus"];
 export type ValueModelStatus = Schemas["ValueModelStatus"];
 export type CalculationState = Schemas["CalculationState"];
+export type ReportState = Schemas["ReportState"];
+export type RenewalTerm = Schemas["RenewalTerm"];
+export type RenewalTermFilter = Schemas["RenewalTermFilter"];
+export type RenewalWindow = Schemas["RenewalWindow"];
 export type Scope = Schemas["Scope"];
 export type CostTargetKind = Schemas["CostTargetKind"];
 export type EventSource = Schemas["EventSource"];
@@ -211,6 +215,11 @@ export type RoiResult = Schemas["RoiResult"];
 export type Anomalies = Schemas["Anomalies"];
 export type AttributedEvent = Schemas["AttributedEvent"];
 export type ClientEventList = Schemas["ClientEventList"];
+export type EventList = Schemas["EventList"];
+export type EventSummary = Schemas["EventSummary"];
+export type EventDayCount = Schemas["EventDayCount"];
+export type EventCategoryCount = Schemas["EventCategoryCount"];
+export type EventArrivalList = Schemas["EventArrivalList"];
 export type Checklist = Schemas["Checklist"];
 export type ChecklistInput = Schemas["ChecklistInput"];
 export type CalculationSnapshot = Schemas["CalculationSnapshot"];
@@ -236,7 +245,12 @@ export type PreviewEvent = Schemas["PreviewEvent"];
 export type PreviewRow = Schemas["PreviewRow"];
 export type ImportPreview = Schemas["ImportPreview"];
 export type ImportResult = Schemas["ImportResult"];
+export type ImportSummary = Schemas["ImportSummary"];
+export type Import = Schemas["Import"];
+export type AppliedImportMapping = Schemas["AppliedImportMapping"];
+export type ImportDelimiter = Schemas["ImportDelimiter"];
 export type Health = Schemas["Health"];
+export type ImportList = Schemas["ImportList"];
 export type ClientList = Schemas["ClientList"];
 export type AgentList = Schemas["AgentList"];
 export type ValueModelList = Schemas["ValueModelList"];
@@ -245,8 +259,19 @@ export type ValueTemplateList = Schemas["ValueTemplateList"];
 export type CostLineItemList = Schemas["CostLineItemList"];
 export type CalculationList = Schemas["CalculationList"];
 export type ReportList = Schemas["ReportList"];
+export type WorkspaceCalculationList = Schemas["WorkspaceCalculationList"];
+export type WorkspaceReportList = Schemas["WorkspaceReportList"];
 export type RenewalList = Schemas["RenewalList"];
 export type ApiKeyList = Schemas["ApiKeyList"];
+export type Workspace = Schemas["Workspace"];
+export type OnboardingStep = Schemas["OnboardingStep"];
+export type OnboardingStepProgress = Schemas["OnboardingStepProgress"];
+export type Onboarding = Schemas["Onboarding"];
+export type OnboardingSkippedStepsSet = Schemas["OnboardingSkippedStepsSet"];
+export type ListEventsQuery = QueryOf<"listEvents">;
+export type GetEventSummaryQuery = QueryOf<"getEventSummary">;
+export type ListEventArrivalsQuery = QueryOf<"listEventArrivals">;
+export type ListImportsQuery = QueryOf<"listImports">;
 export type ListClientsQuery = QueryOf<"listClients">;
 export type ListClientOutcomeTypesQuery = QueryOf<"listClientOutcomeTypes">;
 export type GetClientValueQuery = QueryOf<"getClientValue">;
@@ -261,7 +286,9 @@ export type ListValueModelsQuery = QueryOf<"listValueModels">;
 export type ListOutcomeTypesQuery = QueryOf<"listOutcomeTypes">;
 export type ListValueTemplatesQuery = QueryOf<"listValueTemplates">;
 export type ListCostLineItemsQuery = QueryOf<"listCostLineItems">;
+export type ListCalculationsQuery = QueryOf<"listCalculations">;
 export type ListCalculationReportsQuery = QueryOf<"listCalculationReports">;
+export type ListReportsQuery = QueryOf<"listReports">;
 export type GetDashboardQuery = QueryOf<"getDashboard">;
 export type ListRenewalsQuery = QueryOf<"listRenewals">;
 export type ListApiKeysQuery = QueryOf<"listApiKeys">;

package/dist/types.js

@@ -36,12 +36,18 @@ export const ERROR_CODES = [
     "report_shared",
     "report_not_shared",
     "api_key_revoked",
+    "invite_expired",
+    "invite_used",
+    "invite_revoked",
+    "invite_email_mismatch",
+    "email_has_workspace",
     "payload_too_large",
     "uri_too_long",
     "unsupported_media_type",
     "idempotency_key_reused",
     "rate_limited",
     "internal_error",
+    "upstream_failed",
 ];
 /** The known field-level error codes, in the API's catalogue order. */
 export const FIELD_ERROR_CODES = [

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.2.0";
+export declare const VERSION = "0.4.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.2.0"; // x-release-please-version
+export const VERSION = "0.4.0"; // x-release-please-version

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allisall/sdk",
-  "version": "0.2.0",
+  "version": "0.4.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": {