@vestiarion/sdk 0.2.0 → 0.3.2

package/README.md

@@ -16,7 +16,7 @@ npm install @vestiarion/sdk
 ```
 
 pnpm, Yarn and Bun install it the same way. The package is ESM only. Each version is also served as a tarball, such as
-`https://www.vestiarion.xyz/sdk/vestiarion-sdk-0.2.0.tgz`, which `npm install` takes as it is.
+`https://www.vestiarion.xyz/sdk/vestiarion-sdk-0.3.2.tgz`, which `npm install` takes as it is.
 
 ## Read
 

package/dist/types.d.ts

@@ -5,7 +5,7 @@ export type ApiErrorCode = (typeof API_ERROR_CODES)[number];
 export interface Status {
     /** The workspace's name. */
     businessName: string;
-    /** Payments and yield differ and are reported separately, as in the UI. `unavailable` means the workspace's Circle credentials are stored but could not be read: cycles refuse to pay then rather than simulate, so neither leg is live or simulated. */
+    /** Payments and yield differ and are reported separately, as in the UI. `unavailable` means nothing can pay in the workspace now: its Circle credentials are stored but could not be read; or it is on Arc mainnet with no Circle account connected yet, or not live yet; or Arc mainnet is switched off on this deployment. Cycles refuse to pay then rather than simulate, so neither leg is live or simulated. Yield is also `unavailable` on a network with no yield reserve, such as Arc mainnet. */
     provenance: {
         payments: "live" | "simulate" | "unavailable";
         yield: "live" | "simulate" | "unavailable";
@@ -82,7 +82,7 @@ export interface Invoice {
     escalatedAt: string | null;
     /** Why the agent ruled as it did, verbatim from the decision. */
     agentReasoning: string | null;
-    /** An on-chain hash once the payment settled, else null: on Arc testnet, or for a payout from a Gateway balance the mint on the payee's chain. */
+    /** An on-chain hash once the payment settled, else null: on the workspace's network, or for a payout from a Gateway balance the mint on the payee's chain. */
     txHash: string | null;
     /** What actually left once this invoice was paid; null otherwise, even while a submitted transfer already carries an amount. */
     paidAmount: number | null;
@@ -336,8 +336,8 @@ export interface CreateCounterpartyInput {
     role: "vendor" | "client" | "contractor";
     /** Where the agent pays it. An address added through the API waits for a person in the workspace to confirm it on Counterparties; until then the agent pays nothing to it. */
     address?: string;
-    /** The chain the address receives on. Defaults to `ARC-TESTNET`; only a vendor can be paid on another chain. */
-    chain?: "ARC-TESTNET" | "BASE-SEPOLIA" | "ARB-SEPOLIA" | "ETH-SEPOLIA";
+    /** The chain the address receives on. Defaults to the workspace's own chain: `ARC-TESTNET` on Arc testnet, `ARC` on Arc mainnet. Only a chain the workspace's network pays on is accepted, and only a vendor can be paid on another chain than the workspace's own. */
+    chain?: "ARC-TESTNET" | "BASE-SEPOLIA" | "ARB-SEPOLIA" | "ETH-SEPOLIA" | "ARC";
     /** Where it is based, up to 80 characters; screening uses it. */
     jurisdiction?: string;
     /** The most the agent pays it in one payment, in USDC, with up to 6 decimal places. Required for a vendor or a contractor. */

package/dist/version.d.ts

@@ -1,2 +1,2 @@
 /** This package's version, sent in every request's `User-Agent`. tests/sdk-package.test.ts holds it to package.json. */
-export declare const VERSION = "0.2.0";
+export declare const VERSION = "0.3.2";

package/dist/version.js

@@ -1,2 +1,2 @@
 /** This package's version, sent in every request's `User-Agent`. tests/sdk-package.test.ts holds it to package.json. */
-export const VERSION = "0.2.0";
+export const VERSION = "0.3.2";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vestiarion/sdk",
-  "version": "0.2.0",
+  "version": "0.3.2",
   "description": "A typed client for the Vestiarion API and its signed webhooks.",
   "license": "MIT",
   "type": "module",