@allisall/sdk 0.1.0 → 0.4.0

package/dist/resources/imports.d.ts

@@ -0,0 +1,56 @@
+import type { ImportUpload } from "../multipart.js";
+import type { IdempotentRequestOptions, RequestOptions } from "../options.js";
+import type { PagePromise } from "../pagination.js";
+import type { TransportConfig } from "../transport.js";
+import type { Import, ImportList, ImportPreview, ImportResult, ImportSummary, ListImportsQuery } from "../types.js";
+/** The `imports` operations. */
+export declare class Imports {
+    #private;
+    constructor(config: TransportConfig);
+    /**
+     * Lists the workspace's imports, newest first, each with its counts.
+     * Await the result for one page; iterate it with `for await` for every
+     * import 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 `listImports`.
+     */
+    list(query?: ListImportsQuery, options?: RequestOptions): PagePromise<ImportSummary, ImportList>;
+    /**
+     * Reads an import, with the mapping it ran with. Pass that mapping to
+     * `toImportMapping` to send it as the next import's mapping.
+     *
+     * Needs the `read` scope. Operation `getImport`.
+     */
+    get(id: string, options?: RequestOptions): Promise<Import>;
+    /**
+     * Previews a CSV import: parses, maps and validates the file exactly as
+     * `commit` would, and writes nothing.
+     *
+     * Never retried, although it writes nothing; repeat the call to try
+     * again.
+     *
+     * Needs the `ingest` scope. Operation `previewImport`.
+     */
+    preview(upload: ImportUpload, options?: RequestOptions): Promise<ImportPreview>;
+    /**
+     * Imports a CSV file: stores its valid rows and records an import batch.
+     * A problem with one row rejects that row only. The result lists the
+     * problems of the rejected rows, one `errors` entry per problem, up to the
+     * first 1,000; `errors_truncated` says when more were omitted, and the
+     * counts always cover the whole file. Events deduplicate as they do on
+     * ingest.
+     *
+     * Every attempt of the call sends one `Idempotency-Key`, so a retry
+     * cannot record a second import batch.
+     *
+     * Needs the `ingest` scope. Operation `commitImport`.
+     */
+    commit(upload: ImportUpload, options?: IdempotentRequestOptions): Promise<ImportResult>;
+}

package/dist/resources/imports.js

@@ -0,0 +1,63 @@
+// The `imports` operations: a CSV file of events, previewed or committed.
+import { call, callPage } from "../request.js";
+/** The `imports` operations. */
+export class Imports {
+    #config;
+    constructor(config) {
+        this.#config = config;
+    }
+    /**
+     * Lists the workspace's imports, newest first, each with its counts.
+     * Await the result for one page; iterate it with `for await` for every
+     * import 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 `listImports`.
+     */
+    list(query, options) {
+        return callPage(this.#config, "listImports", { query, options });
+    }
+    /**
+     * Reads an import, with the mapping it ran with. Pass that mapping to
+     * `toImportMapping` to send it as the next import's mapping.
+     *
+     * Needs the `read` scope. Operation `getImport`.
+     */
+    get(id, options) {
+        return call(this.#config, "getImport", { path: { id }, options });
+    }
+    /**
+     * Previews a CSV import: parses, maps and validates the file exactly as
+     * `commit` would, and writes nothing.
+     *
+     * Never retried, although it writes nothing; repeat the call to try
+     * again.
+     *
+     * Needs the `ingest` scope. Operation `previewImport`.
+     */
+    preview(upload, options) {
+        return call(this.#config, "previewImport", { body: upload, options });
+    }
+    /**
+     * Imports a CSV file: stores its valid rows and records an import batch.
+     * A problem with one row rejects that row only. The result lists the
+     * problems of the rejected rows, one `errors` entry per problem, up to the
+     * first 1,000; `errors_truncated` says when more were omitted, and the
+     * counts always cover the whole file. Events deduplicate as they do on
+     * ingest.
+     *
+     * Every attempt of the call sends one `Idempotency-Key`, so a retry
+     * cannot record a second import batch.
+     *
+     * Needs the `ingest` scope. Operation `commitImport`.
+     */
+    commit(upload, options) {
+        return call(this.#config, "commitImport", { body: upload, options });
+    }
+}

package/dist/resources/onboarding.d.ts

@@ -0,0 +1,29 @@
+import type { RequestOptions } from "../options.js";
+import type { TransportConfig } from "../transport.js";
+import type { Onboarding, OnboardingSkippedStepsSet } from "../types.js";
+/** The `onboarding` operations. */
+export declare class OnboardingOperations {
+    #private;
+    constructor(config: TransportConfig);
+    /**
+     * 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?: RequestOptions): Promise<Onboarding>;
+    /**
+     * 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: OnboardingSkippedStepsSet, options?: RequestOptions): Promise<Onboarding>;
+}

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/outcome-types.d.ts

@@ -0,0 +1,25 @@
+import type { RequestOptions } from "../options.js";
+import type { PagePromise } from "../pagination.js";
+import type { TransportConfig } from "../transport.js";
+import type { ListClientOutcomeTypesQuery, ListOutcomeTypesQuery, OutcomeTypeList, OutcomeTypeUsage } from "../types.js";
+/** The `outcomeTypes` operations. */
+export declare class OutcomeTypes {
+    #private;
+    constructor(config: TransportConfig);
+    /**
+     * Lists the workspace's outcome types. Await the result for one page;
+     * iterate it with `for await` for every outcome type of every page.
+     *
+     * Needs the `read` scope. Operation `listOutcomeTypes`.
+     */
+    list(query?: ListOutcomeTypesQuery, options?: RequestOptions): PagePromise<OutcomeTypeUsage, OutcomeTypeList>;
+    /**
+     * Lists a client's outcome types. Await the result for one page; iterate
+     * it with `for await` for every outcome type of every page.
+     *
+     * Needs the `read` scope. Operation `listClientOutcomeTypes`.
+     *
+     * @param clientId - the client's id.
+     */
+    listForClient(clientId: string, query?: ListClientOutcomeTypesQuery, options?: RequestOptions): PagePromise<OutcomeTypeUsage, OutcomeTypeList>;
+}

package/dist/resources/outcome-types.js

@@ -0,0 +1,33 @@
+// The `outcomeTypes` operations.
+import { callPage } from "../request.js";
+/** The `outcomeTypes` operations. */
+export class OutcomeTypes {
+    #config;
+    constructor(config) {
+        this.#config = config;
+    }
+    /**
+     * Lists the workspace's outcome types. Await the result for one page;
+     * iterate it with `for await` for every outcome type of every page.
+     *
+     * Needs the `read` scope. Operation `listOutcomeTypes`.
+     */
+    list(query, options) {
+        return callPage(this.#config, "listOutcomeTypes", { query, options });
+    }
+    /**
+     * Lists a client's outcome types. Await the result for one page; iterate
+     * it with `for await` for every outcome type of every page.
+     *
+     * Needs the `read` scope. Operation `listClientOutcomeTypes`.
+     *
+     * @param clientId - the client's id.
+     */
+    listForClient(clientId, query, options) {
+        return callPage(this.#config, "listClientOutcomeTypes", {
+            path: { id: clientId },
+            query,
+            options,
+        });
+    }
+}

package/dist/resources/reports.d.ts

@@ -0,0 +1,92 @@
+import type { IdempotentRequestOptions, RequestOptions } from "../options.js";
+import type { PagePromise } from "../pagination.js";
+import type { TransportConfig } from "../transport.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.
+     *
+     * Every attempt of the call sends one `Idempotency-Key`, so a retry
+     * cannot create a second report.
+     *
+     * Needs the `write` scope. Operation `createReport`.
+     *
+     * @param calculationId - the calculation's id.
+     */
+    createForCalculation(calculationId: string, options?: IdempotentRequestOptions): Promise<Report>;
+    /**
+     * Lists a calculation's reports. Await the result for one page; iterate
+     * it with `for await` for every report of every page. Each item is a
+     * summary without `disclosures`; `get` reads a report with them.
+     *
+     * Needs the `read` scope. Operation `listCalculationReports`.
+     *
+     * @param calculationId - the calculation's id.
+     */
+    listForCalculation(calculationId: string, query?: ListCalculationReportsQuery, options?: RequestOptions): PagePromise<ReportSummary, ReportList>;
+    /**
+     * Reads a report.
+     *
+     * Needs the `read` scope. Operation `getReport`.
+     */
+    get(id: string, options?: RequestOptions): Promise<ReportWithPreview>;
+    /**
+     * Edits a report with a merge patch: a member left out keeps its value,
+     * `null` clears it, and any other value sets it. An array, such as
+     * `disclosures`, replaces the stored one whole.
+     *
+     * Never retried.
+     *
+     * Needs the `write` scope. Operation `updateReport`.
+     */
+    update(id: string, patch: ReportPatch, options?: RequestOptions): Promise<Report>;
+    /**
+     * Deletes an unshared report. A shared report cannot be deleted; revoke
+     * its link instead.
+     *
+     * A retry after a lost response can answer `404` for a delete that
+     * succeeded.
+     *
+     * Needs the `write` scope. Operation `deleteReport`.
+     */
+    delete(id: string, options?: RequestOptions): Promise<void>;
+    /**
+     * Shares a report: mints its share token and seals the report against
+     * edits. Anyone holding the token can read the report, so handle it like
+     * a secret.
+     *
+     * Needs a session token: sharing is a human trust step. An API key is
+     * refused with `403` `session_required`, as an `ApiError`. Never retried.
+     *
+     * Operation `shareReport`.
+     */
+    share(id: string, options?: RequestOptions): Promise<Report>;
+    /**
+     * Revokes a report's link: its share token stops working.
+     *
+     * Needs a session token: it undoes a human trust step. An API key is
+     * refused with `403` `session_required`, as an `ApiError`. Never retried.
+     *
+     * Operation `revokeReport`.
+     */
+    revoke(id: string, options?: RequestOptions): Promise<Report>;
+}

package/dist/resources/reports.js

@@ -0,0 +1,120 @@
+// The `reports` operations: a report on a published calculation, and the
+// human steps that share it and revoke its link.
+import { call, callPage } from "../request.js";
+/** The `reports` operations. */
+export class Reports {
+    #config;
+    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.
+     *
+     * Every attempt of the call sends one `Idempotency-Key`, so a retry
+     * cannot create a second report.
+     *
+     * Needs the `write` scope. Operation `createReport`.
+     *
+     * @param calculationId - the calculation's id.
+     */
+    createForCalculation(calculationId, options) {
+        return call(this.#config, "createReport", {
+            path: { id: calculationId },
+            options,
+        });
+    }
+    /**
+     * Lists a calculation's reports. Await the result for one page; iterate
+     * it with `for await` for every report of every page. Each item is a
+     * summary without `disclosures`; `get` reads a report with them.
+     *
+     * Needs the `read` scope. Operation `listCalculationReports`.
+     *
+     * @param calculationId - the calculation's id.
+     */
+    listForCalculation(calculationId, query, options) {
+        return callPage(this.#config, "listCalculationReports", {
+            path: { id: calculationId },
+            query,
+            options,
+        });
+    }
+    /**
+     * Reads a report.
+     *
+     * Needs the `read` scope. Operation `getReport`.
+     */
+    get(id, options) {
+        return call(this.#config, "getReport", { path: { id }, options });
+    }
+    /**
+     * Edits a report with a merge patch: a member left out keeps its value,
+     * `null` clears it, and any other value sets it. An array, such as
+     * `disclosures`, replaces the stored one whole.
+     *
+     * Never retried.
+     *
+     * Needs the `write` scope. Operation `updateReport`.
+     */
+    update(id, patch, options) {
+        return call(this.#config, "updateReport", {
+            path: { id },
+            body: patch,
+            options,
+        });
+    }
+    /**
+     * Deletes an unshared report. A shared report cannot be deleted; revoke
+     * its link instead.
+     *
+     * A retry after a lost response can answer `404` for a delete that
+     * succeeded.
+     *
+     * Needs the `write` scope. Operation `deleteReport`.
+     */
+    delete(id, options) {
+        return call(this.#config, "deleteReport", { path: { id }, options });
+    }
+    /**
+     * Shares a report: mints its share token and seals the report against
+     * edits. Anyone holding the token can read the report, so handle it like
+     * a secret.
+     *
+     * Needs a session token: sharing is a human trust step. An API key is
+     * refused with `403` `session_required`, as an `ApiError`. Never retried.
+     *
+     * Operation `shareReport`.
+     */
+    share(id, options) {
+        return call(this.#config, "shareReport", { path: { id }, options });
+    }
+    /**
+     * Revokes a report's link: its share token stops working.
+     *
+     * Needs a session token: it undoes a human trust step. An API key is
+     * refused with `403` `session_required`, as an `ApiError`. Never retried.
+     *
+     * Operation `revokeReport`.
+     */
+    revoke(id, options) {
+        return call(this.#config, "revokeReport", { path: { id }, options });
+    }
+}

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

@@ -0,0 +1,99 @@
+import type { MoneyInput } from "../money.js";
+import type { IdempotentRequestOptions, RequestOptions } from "../options.js";
+import type { PagePromise } from "../pagination.js";
+import type { TransportConfig } from "../transport.js";
+import type { ListValueModelsQuery, ListValueTemplatesQuery, ValueLineItemsSet, ValueModel, ValueModelCreate, ValueModelList, ValueModelPatch, ValueModelSummary, ValueTemplate, ValueTemplateList } from "../types.js";
+/** The `valueModels` operations. */
+export declare class ValueModels {
+    #private;
+    constructor(config: TransportConfig);
+    /**
+     * 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>;
+    /**
+     * Reads a value model by its own id: any model in the workspace,
+     * archived ones included.
+     *
+     * Needs the `read` scope. Operation `getValueModel`.
+     *
+     * @param id - the value model's id, not its client's.
+     */
+    get(id: string, options?: RequestOptions): Promise<ValueModel>;
+    /**
+     * Reads a client's active value model.
+     *
+     * Needs the `read` scope. Operation `getClientValueModel`.
+     *
+     * @param clientId - the client's id.
+     */
+    getForClient(clientId: string, options?: RequestOptions): Promise<ValueModel>;
+    /**
+     * Creates a client's value model.
+     *
+     * Every attempt of the call sends one `Idempotency-Key`, so a retry
+     * cannot create a second value model.
+     *
+     * Needs the `write` scope. Operation `createValueModel`.
+     *
+     * @param clientId - the client's id.
+     */
+    createForClient(clientId: string, body: ValueModelCreate, options?: IdempotentRequestOptions): Promise<ValueModel>;
+    /**
+     * Updates a client's active value model with a merge patch: a member
+     * left out keeps its value, `null` clears it, and any other value sets
+     * it.
+     *
+     * Never retried.
+     *
+     * Needs the `write` scope. Operation `updateValueModel`.
+     *
+     * @param clientId - the client's id.
+     */
+    updateForClient(clientId: string, patch: ValueModelPatch, options?: RequestOptions): Promise<ValueModel>;
+    /**
+     * Deletes a client's active value model.
+     *
+     * A retry after a lost response can answer `404` for a delete that
+     * succeeded.
+     *
+     * Needs the `write` scope. Operation `deleteValueModel`.
+     *
+     * @param clientId - the client's id.
+     */
+    deleteForClient(clientId: string, options?: RequestOptions): Promise<void>;
+    /**
+     * Replaces the line items of a client's active value model, as a whole
+     * set. It is guarded by `version`: a stale version is refused rather
+     * than overwriting a co-editor's change.
+     *
+     * Each `unit_value` takes a `Decimal` or a `number`.
+     *
+     * Never retried, because the `version` guard refuses a repeat of a write
+     * that already landed as a stale version. On a `ConnectionError` the
+     * write may have landed: read the value model again for its current
+     * `version` before trying again.
+     *
+     * Needs the `write` scope. Operation `setValueModelLineItems`.
+     *
+     * @param clientId - the client's id.
+     */
+    setLineItemsForClient(clientId: string, body: MoneyInput<ValueLineItemsSet>, options?: RequestOptions): Promise<ValueModel>;
+    /**
+     * Lists value templates. Await the result for one page; iterate it with
+     * `for await` for every template of every page.
+     *
+     * Needs the `read` scope. Operation `listValueTemplates`.
+     */
+    listTemplates(query?: ListValueTemplatesQuery, options?: RequestOptions): PagePromise<ValueTemplate, ValueTemplateList>;
+}