@vestiarion/sdk 0.2.0 → 0.3.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/types.d.ts +5 -5
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -16,7 +16,7 @@ npm install @vestiarion/sdk
|
|
|
16
16
|
```
|
|
17
17
|
|
|
18
18
|
pnpm, Yarn and Bun install it the same way. The package is ESM only. Each version is also served as a tarball, such as
|
|
19
|
-
`https://www.vestiarion.xyz/sdk/vestiarion-sdk-0.
|
|
19
|
+
`https://www.vestiarion.xyz/sdk/vestiarion-sdk-0.3.3.tgz`, which `npm install` takes as it is.
|
|
20
20
|
|
|
21
21
|
## Read
|
|
22
22
|
|
package/dist/types.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ export type ApiErrorCode = (typeof API_ERROR_CODES)[number];
|
|
|
5
5
|
export interface Status {
|
|
6
6
|
/** The workspace's name. */
|
|
7
7
|
businessName: string;
|
|
8
|
-
/** Payments and yield differ and are reported separately, as in the UI. `unavailable` means the workspace
|
|
8
|
+
/** 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. */
|
|
9
9
|
provenance: {
|
|
10
10
|
payments: "live" | "simulate" | "unavailable";
|
|
11
11
|
yield: "live" | "simulate" | "unavailable";
|
|
@@ -82,7 +82,7 @@ export interface Invoice {
|
|
|
82
82
|
escalatedAt: string | null;
|
|
83
83
|
/** Why the agent ruled as it did, verbatim from the decision. */
|
|
84
84
|
agentReasoning: string | null;
|
|
85
|
-
/** An on-chain hash once the payment settled, else null: on
|
|
85
|
+
/** 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. */
|
|
86
86
|
txHash: string | null;
|
|
87
87
|
/** What actually left once this invoice was paid; null otherwise, even while a submitted transfer already carries an amount. */
|
|
88
88
|
paidAmount: number | null;
|
|
@@ -152,7 +152,7 @@ export interface Milestone {
|
|
|
152
152
|
amount: number;
|
|
153
153
|
status: "pending" | "verified" | "paid" | "held" | "closed";
|
|
154
154
|
verificationSource: string | null;
|
|
155
|
-
verificationMethod: "unverified" | "github" | "manual" | "seed";
|
|
155
|
+
verificationMethod: "unverified" | "github" | "manual" | "seed" | "asana";
|
|
156
156
|
verificationStatus: "unverified" | "verified" | "not_merged" | "unavailable" | "failed";
|
|
157
157
|
verificationCheckedAt: string | null;
|
|
158
158
|
verifiedAt: string | null;
|
|
@@ -336,8 +336,8 @@ export interface CreateCounterpartyInput {
|
|
|
336
336
|
role: "vendor" | "client" | "contractor";
|
|
337
337
|
/** 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. */
|
|
338
338
|
address?: string;
|
|
339
|
-
/** The chain the address receives on. Defaults to `ARC-TESTNET
|
|
340
|
-
chain?: "ARC-TESTNET" | "BASE-SEPOLIA" | "ARB-SEPOLIA" | "ETH-SEPOLIA";
|
|
339
|
+
/** 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. */
|
|
340
|
+
chain?: "ARC-TESTNET" | "BASE-SEPOLIA" | "ARB-SEPOLIA" | "ETH-SEPOLIA" | "ARC";
|
|
341
341
|
/** Where it is based, up to 80 characters; screening uses it. */
|
|
342
342
|
jurisdiction?: string;
|
|
343
343
|
/** 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
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
/** This package's version, sent in every request's `User-Agent`. tests/sdk-package.test.ts holds it to package.json. */
|
|
2
|
-
export declare const VERSION = "0.
|
|
2
|
+
export declare const VERSION = "0.3.3";
|
package/dist/version.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
/** This package's version, sent in every request's `User-Agent`. tests/sdk-package.test.ts holds it to package.json. */
|
|
2
|
-
export const VERSION = "0.
|
|
2
|
+
export const VERSION = "0.3.3";
|