@hyperscale0/sdk 1.0.369 → 1.0.378

package/README.md

@@ -6,7 +6,7 @@ TypeScript client for running a Hyperscale Product: customers, payments, schedul
 npm i @hyperscale0/sdk
 ```
 
-The SDK runs a Product that already exists. Create the Product with `hyperscale product create` or in the Build portal, and copy its `prd_…` id. `hyperscale key create --product <id>` shows the key's secret once. Export them as `HYPERSCALE_PRODUCT_ID` and `HYPERSCALE_API_KEY`.
+The SDK runs a Product that already exists. Create the Product with `hyperscale product create` or in Build in the console, and copy its `prd_…` id. `hyperscale key create --product <id>` shows the key's secret once. Export them as `HYPERSCALE_PRODUCT_ID` and `HYPERSCALE_API_KEY`.
 
 ## Quickstart
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyperscale0/sdk",
-  "version": "1.0.369",
+  "version": "1.0.378",
   "description": "JavaScript client and TypeScript types for the Hyperscale Product API.",
   "type": "module",
   "sideEffects": false,
@@ -26,5 +26,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "322072d39306fa6693377bcc812caa40822e93a2"
+  "gitHead": "3dddc83138f66a6fb80a99034af8747eba56a074"
 }

package/platform.d.ts

@@ -146,11 +146,11 @@ export type product_objects_discoverOutput = { readonly "semantics": { readonly
 export type product_objects_executeInput = { readonly "productId": string; readonly "kind": string; readonly "objectId": string; readonly "action": string; readonly "expectedRevision"?: number; readonly "productBuildId"?: string; readonly "digest"?: string; readonly "target"?: ({ readonly "kind": "attachment"; readonly "attachment": string; } | { readonly "kind": "instance"; readonly "attachment": string; readonly "instanceId": string; }); readonly "fields"?: { readonly [key: string]: unknown }; readonly "input"?: { readonly [key: string]: unknown }; readonly "onBehalfOf"?: string; };
 export type product_objects_executeOutput = { readonly "object": { readonly "createdAt": string; readonly "objectId": string; readonly "kind": string; readonly "revision": number; readonly "externalId"?: string; readonly "fields": { readonly [key: string]: unknown }; readonly "productBuildId": string; }; readonly "outcome": ({ readonly "instrument": string; readonly "instanceId": string; readonly "state": string; readonly "moves"?: ReadonlyArray<{ readonly "transferId": string; readonly "amount": string; readonly "currency": string; readonly "sourceAccountId": string; readonly "destinationAccountId": string; readonly "status": "posted" | "reserved" | "released" | "voided"; }>; } | null); readonly "evidence": ReadonlyArray<{ readonly "requirementId": string; readonly "subjectId": string; readonly "protectedInputDigest": string; readonly "adapter": string; readonly "declarationDigest": string; readonly "productBuildId": string; readonly "state": "missing" | "pending" | "satisfied" | "refused" | "stale"; readonly "reference"?: string; readonly "observedAt"?: string; readonly "reasonCode"?: string; }>; readonly "receiptId"?: string; };
 export type product_objects_listInput = { readonly "productId": string; readonly "kind": string; readonly "owner"?: string; readonly "externalId"?: string; /** JSON-encode this object in the HTTP query parameter. */ readonly "filters"?: { readonly [key: string]: string }; readonly "agreementState"?: string; readonly "blockKey"?: "financing.installments" | "escrow.hold" | "money.hold" | "marketplace.listing" | "marketplace.order" | "marketplace.reservation" | "insurance.cover" | "insurance.claim"; readonly "blockMetric"?: "overdue_installments" | "overdue_amount" | "held_funds" | "active_listings" | "awaiting_fulfilment" | "active_reservations" | "active_covers" | "submitted_claims"; readonly "dueField"?: string; readonly "dueFrom"?: string; readonly "dueThrough"?: string; readonly "cursor"?: string; readonly "limit"?: number; };
-export type product_objects_listOutput = { readonly "items": ReadonlyArray<{ readonly "createdAt": string; readonly "objectId": string; readonly "kind": string; readonly "revision": number; readonly "externalId"?: string; readonly "fields": { readonly [key: string]: unknown }; readonly "productBuildId": string; readonly "currency": string; readonly "references": { readonly [key: string]: ReadonlyArray<{ readonly "id": string; readonly "displayTitle": string | null; }> }; readonly "standing": string; readonly "agreements": ReadonlyArray<{ readonly "instanceId": string; readonly "instrument": string; readonly "attachment": string; readonly "block": (({ readonly "key": string; readonly "recordPath": string; readonly "digest": string; } | { readonly "key": string; readonly "recordPath": string; readonly "headerDigest": string; }) | null); readonly "title": string; readonly "state": string; readonly "standing": string; }>; readonly "agreementsComplete": boolean; readonly "nextSchedule": ({ readonly "instanceId": string; readonly "action": string; readonly "title": string; readonly "dueAt": string; readonly "status": "upcoming" | "due"; } | null); readonly "scheduleComplete": boolean; }>; readonly "nextCursor"?: string; readonly "total": number; readonly "facets": { readonly [key: string]: { readonly [key: string]: number } }; };
+export type product_objects_listOutput = { readonly "items": ReadonlyArray<{ readonly "createdAt": string; readonly "objectId": string; readonly "kind": string; readonly "revision": number; readonly "externalId"?: string; readonly "fields": { readonly [key: string]: unknown }; readonly "productBuildId": string; readonly "currency": string; readonly "references": { readonly [key: string]: ReadonlyArray<{ readonly "id": string; readonly "displayTitle": string | null; }> }; readonly "standing": string; readonly "access": "owner" | "party" | "open" | "company"; readonly "agreements": ReadonlyArray<{ readonly "instanceId": string; readonly "instrument": string; readonly "attachment": string; readonly "block": (({ readonly "key": string; readonly "recordPath": string; readonly "digest": string; } | { readonly "key": string; readonly "recordPath": string; readonly "headerDigest": string; }) | null); readonly "title": string; readonly "state": string; readonly "standing": string; }>; readonly "agreementsComplete": boolean; readonly "nextSchedule": ({ readonly "instanceId": string; readonly "action": string; readonly "title": string; readonly "dueAt": string; readonly "status": "upcoming" | "due"; } | null); readonly "scheduleComplete": boolean; }>; readonly "nextCursor"?: string; readonly "total": number; readonly "facets": { readonly [key: string]: { readonly [key: string]: number } }; };
 export type product_objects_previewInput = { readonly "productId": string; readonly "kind": string; readonly "objectId": string; readonly "action": string; readonly "expectedRevision"?: number; readonly "productBuildId"?: string; readonly "digest"?: string; readonly "target"?: ({ readonly "kind": "attachment"; readonly "attachment": string; } | { readonly "kind": "instance"; readonly "attachment": string; readonly "instanceId": string; }); readonly "fields"?: { readonly [key: string]: unknown }; readonly "input"?: { readonly [key: string]: unknown }; readonly "onBehalfOf"?: string; };
 export type product_objects_previewOutput = { readonly "objectId": string; readonly "revision": number; readonly "productBuildId": string; readonly "digest": string; readonly "target": ({ readonly "kind": "attachment"; readonly "attachment": string; } | { readonly "kind": "instance"; readonly "attachment": string; readonly "instanceId": string; }); readonly "evaluatedAt": string; readonly "effectiveAt": string; readonly "availability": ({ readonly "status": "available"; } | { readonly "status": "requires_input"; readonly "subjectFields": ReadonlyArray<string>; readonly "actionInputs": ReadonlyArray<string>; readonly "parties": ReadonlyArray<string>; readonly "reason": string; } | { readonly "status": "unavailable"; readonly "blockers": ReadonlyArray<{ readonly "code": "permission_required" | "state_changed" | "not_due" | "deadline_passed" | "clock_pending" | "condition_not_met" | "already_used" | "evidence_required" | "account_unavailable" | "insufficient_balance" | "setup_required" | "invalid_input" | "operation_pending"; readonly "reason": string; readonly "recheckAt"?: string; readonly "details"?: { readonly "accountId": string; readonly "currency": string; readonly "available": string; readonly "required": string; readonly "shortfall": string; }; readonly "belongsTo"?: { readonly "party": string; readonly "binding"?: "owner" | "actor" | "operator"; readonly "customerId"?: string; }; }>; } | { readonly "status": "unknown"; readonly "reason": string; }); readonly "effects": ReadonlyArray<{ readonly "sourceAccountId": string; readonly "destinationAccountId": string; readonly "amount": string; readonly "currency": "SAR"; readonly "book": "cash" | "claim"; readonly "outcome": "paid" | "held" | "released"; }>; readonly "stateChange": ({ readonly "from": string; readonly "to": string; } | null); readonly "clocks": ReadonlyArray<{ readonly "instrument": string; readonly "action": string; readonly "at": string; }>; };
 export type product_objects_retrieveInput = { readonly "productId": string; readonly "kind": string; readonly "objectId": string; };
-export type product_objects_retrieveOutput = { readonly "createdAt": string; readonly "objectId": string; readonly "kind": string; readonly "revision": number; readonly "externalId"?: string; readonly "fields": { readonly [key: string]: unknown }; readonly "productBuildId": string; readonly "currency": string; readonly "references": { readonly [key: string]: ReadonlyArray<{ readonly "id": string; readonly "displayTitle": string | null; }> }; readonly "standing": string; readonly "agreements": ReadonlyArray<{ readonly "instanceId": string; readonly "instrument": string; readonly "attachment": string; readonly "block": (({ readonly "key": string; readonly "recordPath": string; readonly "digest": string; } | { readonly "key": string; readonly "recordPath": string; readonly "headerDigest": string; }) | null); readonly "title": string; readonly "state": string; readonly "standing": string; readonly "progress": ({ readonly "done": number; readonly "total": number; readonly "word": string; } | null); readonly "nextDueAt": (string | null); }>; readonly "agreementsNextCursor"?: string; };
+export type product_objects_retrieveOutput = { readonly "createdAt": string; readonly "objectId": string; readonly "kind": string; readonly "revision": number; readonly "externalId"?: string; readonly "fields": { readonly [key: string]: unknown }; readonly "productBuildId": string; readonly "currency": string; readonly "references": { readonly [key: string]: ReadonlyArray<{ readonly "id": string; readonly "displayTitle": string | null; }> }; readonly "standing": string; readonly "access": "owner" | "party" | "open" | "company"; readonly "agreements": ReadonlyArray<{ readonly "instanceId": string; readonly "instrument": string; readonly "attachment": string; readonly "block": (({ readonly "key": string; readonly "recordPath": string; readonly "digest": string; } | { readonly "key": string; readonly "recordPath": string; readonly "headerDigest": string; }) | null); readonly "title": string; readonly "state": string; readonly "standing": string; readonly "progress": ({ readonly "done": number; readonly "total": number; readonly "word": string; } | null); readonly "nextDueAt": (string | null); }>; readonly "agreementsNextCursor"?: string; };
 export type product_objects_timeline_listInput = { readonly "productId": string; readonly "kind": string; readonly "objectId": string; readonly "cursor"?: string; readonly "limit"?: number; };
 export type product_objects_timeline_listOutput = { readonly "objectId": string; readonly "items": ReadonlyArray<{ readonly "id": string; readonly "kind": "action_accepted" | "action_refused" | "state_changed" | "money_moved" | "hold_placed" | "hold_released" | "clock" | "evidence" | "provider"; readonly "line": string; readonly "actor": { readonly "role": string; readonly "title": string; readonly "participantId"?: string; readonly "displayName"?: string; readonly "customerId"?: string; readonly "onBehalfOf"?: ({ readonly "kind": "member"; readonly "userId": string; readonly "displayName": string; } | { readonly "kind": "api_key"; readonly "apiKeyId": string; readonly "displayName": string; }); }; readonly "occurredAt": string; readonly "timeBasis": "effective" | "recorded"; readonly "agreement": ({ readonly "instanceId": string; readonly "instrument": string; readonly "attachment": string; readonly "title": string; readonly "productBuildId": string; readonly "digest": string; } | null); readonly "source": { readonly "kind": "audit_event" | "receipt" | "external_confirmation"; readonly "id": string; readonly "operationId": (string | null); readonly "sequence"?: number; }; readonly "state"?: string; readonly "requested"?: true; readonly "reason"?: string; readonly "money"?: { readonly "transferId": string; readonly "amount": string; readonly "currency": string; readonly "book": "cash" | "claim"; readonly "sourceAccountId": string; readonly "destinationAccountId": string; }; readonly "evidence"?: { readonly "evidenceId": string; readonly "provider": string; readonly "outcome": string; readonly "observedAt": string; readonly "reason": string; readonly "instructionId"?: string; }; }>; readonly "nextCursor"?: string; };
 export type product_operation_set_retrieveInput = { readonly "productId": string; };