@ethitrust/sdk 1.0.0 → 1.1.0
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 +2 -6
- package/dist/http.js +1 -1
- package/dist/types.d.ts +1 -24
- package/dist/types.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/http.ts +1 -1
- package/src/types.ts +1 -31
package/README.md
CHANGED
|
@@ -33,12 +33,8 @@ const escrow = await client.orgEscrows.create({
|
|
|
33
33
|
title: 'Website redesign',
|
|
34
34
|
amount: 5000,
|
|
35
35
|
currency: 'ETB',
|
|
36
|
-
escrow_type: '
|
|
36
|
+
escrow_type: 'onetime',
|
|
37
37
|
who_pays_fees: 'split',
|
|
38
|
-
milestones: [
|
|
39
|
-
{ title: 'Wireframes', amount: 1500 },
|
|
40
|
-
{ title: 'Final delivery', amount: 3500 },
|
|
41
|
-
],
|
|
42
38
|
});
|
|
43
39
|
```
|
|
44
40
|
|
|
@@ -53,7 +49,7 @@ const escrow = await client.orgEscrows.create({
|
|
|
53
49
|
| `maxRetries` | `2` | Retries for transient failures (GET / `429` / `5xx`). |
|
|
54
50
|
| `fetch` | global `fetch` | Custom fetch implementation. |
|
|
55
51
|
| `defaultHeaders` | `{}` | Extra headers on every request. |
|
|
56
|
-
| `userAgent` | `@ethitrust/sdk/1.
|
|
52
|
+
| `userAgent` | `@ethitrust/sdk/1.1.0 node` | Override the User-Agent. |
|
|
57
53
|
|
|
58
54
|
## API surface
|
|
59
55
|
|
package/dist/http.js
CHANGED
|
@@ -27,7 +27,7 @@ export class HttpClient {
|
|
|
27
27
|
this.fetchImpl = fImpl.bind(globalThis);
|
|
28
28
|
this.defaultHeaders = {
|
|
29
29
|
Accept: 'application/json',
|
|
30
|
-
'User-Agent': opts.userAgent ?? '@ethitrust/sdk/1.
|
|
30
|
+
'User-Agent': opts.userAgent ?? '@ethitrust/sdk/1.1.0 node',
|
|
31
31
|
...opts.defaultHeaders,
|
|
32
32
|
};
|
|
33
33
|
}
|
package/dist/types.d.ts
CHANGED
|
@@ -2,14 +2,13 @@
|
|
|
2
2
|
* Typed models for the Ethitrust org-escrows API.
|
|
3
3
|
* Generated by hand from the OpenAPI spec (ethi-mono v0.1.0).
|
|
4
4
|
*/
|
|
5
|
-
export type EscrowType = 'onetime'
|
|
5
|
+
export type EscrowType = 'onetime';
|
|
6
6
|
export type EscrowStatus = 'invited' | 'counter_pending_initiator' | 'counter_pending_counterparty' | 'rejected' | 'expired' | 'pending' | 'active' | 'submitted' | 'in_review' | 'completed' | 'disputed' | 'cancelled' | 'refunded';
|
|
7
7
|
export type InitiatorActorType = 'user' | 'organization';
|
|
8
8
|
export type InitiatorRole = 'buyer' | 'seller';
|
|
9
9
|
export type FeePayer = 'buyer' | 'seller' | 'split';
|
|
10
10
|
export type CounterStatus = 'none' | 'awaiting_initiator' | 'awaiting_counterparty' | 'accepted' | 'rejected';
|
|
11
11
|
export type RiskSeverity = 'low' | 'medium' | 'high';
|
|
12
|
-
export type MilestoneStatus = 'pending' | 'in_progress' | 'delivered' | 'completed' | 'disputed';
|
|
13
12
|
export interface RiskFlag {
|
|
14
13
|
code: string;
|
|
15
14
|
message: string;
|
|
@@ -26,27 +25,6 @@ export interface EscrowVolumePoint {
|
|
|
26
25
|
count: number;
|
|
27
26
|
total_amount: number;
|
|
28
27
|
}
|
|
29
|
-
export interface MilestoneRequest {
|
|
30
|
-
title: string;
|
|
31
|
-
description?: string | null;
|
|
32
|
-
amount: number;
|
|
33
|
-
due_date?: string | null;
|
|
34
|
-
/** Defaults to 48 on the server. */
|
|
35
|
-
inspection_hrs?: number;
|
|
36
|
-
}
|
|
37
|
-
export interface MilestoneResponse {
|
|
38
|
-
id: string;
|
|
39
|
-
escrow_id: string;
|
|
40
|
-
title: string;
|
|
41
|
-
description: string | null;
|
|
42
|
-
amount: number;
|
|
43
|
-
due_date: string | null;
|
|
44
|
-
inspection_hrs: number;
|
|
45
|
-
status: MilestoneStatus;
|
|
46
|
-
delivered_at: string | null;
|
|
47
|
-
completed_at: string | null;
|
|
48
|
-
sort_order: number;
|
|
49
|
-
}
|
|
50
28
|
export interface OrganizationInitializeEscrowRequest {
|
|
51
29
|
invitee_email: string;
|
|
52
30
|
/** Defaults to 'onetime'. */
|
|
@@ -64,7 +42,6 @@ export interface OrganizationInitializeEscrowRequest {
|
|
|
64
42
|
dispute_window?: number;
|
|
65
43
|
/** Defaults to 'buyer'. */
|
|
66
44
|
who_pays_fees?: FeePayer;
|
|
67
|
-
milestones?: MilestoneRequest[] | null;
|
|
68
45
|
}
|
|
69
46
|
export interface ListOrgEscrowsParams {
|
|
70
47
|
status?: string;
|
package/dist/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,MAAM,MAAM,UAAU,GAAG,SAAS,
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,MAAM,MAAM,UAAU,GAAG,SAAS,CAAC;AAEnC,MAAM,MAAM,YAAY,GACpB,SAAS,GACT,2BAA2B,GAC3B,8BAA8B,GAC9B,UAAU,GACV,SAAS,GACT,SAAS,GACT,QAAQ,GACR,WAAW,GACX,WAAW,GACX,WAAW,GACX,UAAU,GACV,WAAW,GACX,UAAU,CAAC;AAEf,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,cAAc,CAAC;AACzD,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,QAAQ,CAAC;AAC/C,MAAM,MAAM,QAAQ,GAAG,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAC;AACpD,MAAM,MAAM,aAAa,GACrB,MAAM,GACN,oBAAoB,GACpB,uBAAuB,GACvB,UAAU,GACV,UAAU,CAAC;AACf,MAAM,MAAM,YAAY,GAAG,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAC;AAIrD,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,YAAY,CAAC;CACxB;AAED,MAAM,WAAW,WAAW;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;CAC3C;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;CACtB;AAID,MAAM,WAAW,mCAAmC;IAClD,aAAa,EAAE,MAAM,CAAC;IACtB,6BAA6B;IAC7B,WAAW,CAAC,EAAE,UAAU,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,yBAAyB;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,6BAA6B;IAC7B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,6BAA6B;IAC7B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,2BAA2B;IAC3B,aAAa,CAAC,EAAE,QAAQ,CAAC;CAC1B;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,0BAA0B;IAC1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,0BAA0B;IAC1B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,qBAAqB;IACpC,0BAA0B;IAC1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,0BAA0B;IAC1B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAID,MAAM,WAAW,wBAAwB;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,UAAU,CAAC;IACxB,MAAM,EAAE,YAAY,CAAC;IACrB,oBAAoB,EAAE,kBAAkB,CAAC;IACzC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,cAAc,EAAE,aAAa,CAAC;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,cAAc,EAAE,MAAM,CAAC;IACvB,aAAa,EAAE,QAAQ,CAAC;IACxB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,aAAa,CAAC;IAC9B,4BAA4B,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5C,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,uBAAwB,SAAQ,wBAAwB;IACvE,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,OAAO,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,iBAAiB,EAAE,CAAC;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,uBAAuB;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,OAAO,CAAC;IACpB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,uBAAwB,SAAQ,uBAAuB;IACtE,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa;IACb,mBAAmB,EAAE,MAAM,CAAC;IAC5B,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,UAAU,CAAC,EAAE,QAAQ,EAAE,CAAC;IACxB,YAAY,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;CACnC;AAED,MAAM,WAAW,uBAAuB;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,OAAO,CAAC;IACpB,WAAW,EAAE,OAAO,CAAC;IACrB,cAAc,EAAE,OAAO,CAAC;IACxB,aAAa,EAAE,OAAO,CAAC;IACvB,UAAU,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,uBAAuB;IACtC,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,yBAAyB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1C,gBAAgB,CAAC,EAAE,iBAAiB,EAAE,CAAC;CACxC;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;CAC3C;AAED,MAAM,WAAW,2BAA2B;IAC1C,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,mBAAmB,EAAE,CAAC;IAC9B,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAID,MAAM,WAAW,mBAAmB;IAClC,GAAG,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC/B;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,CAAC,EAAE,mBAAmB,EAAE,CAAC;CAChC"}
|
package/package.json
CHANGED
package/src/http.ts
CHANGED
|
@@ -68,7 +68,7 @@ export class HttpClient {
|
|
|
68
68
|
this.fetchImpl = fImpl.bind(globalThis);
|
|
69
69
|
this.defaultHeaders = {
|
|
70
70
|
Accept: 'application/json',
|
|
71
|
-
'User-Agent': opts.userAgent ?? '@ethitrust/sdk/1.
|
|
71
|
+
'User-Agent': opts.userAgent ?? '@ethitrust/sdk/1.1.0 node',
|
|
72
72
|
...opts.defaultHeaders,
|
|
73
73
|
};
|
|
74
74
|
}
|
package/src/types.ts
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
// ───── Enums ─────────────────────────────────────────────────────────────────
|
|
7
7
|
|
|
8
|
-
export type EscrowType = 'onetime'
|
|
8
|
+
export type EscrowType = 'onetime';
|
|
9
9
|
|
|
10
10
|
export type EscrowStatus =
|
|
11
11
|
| 'invited'
|
|
@@ -32,12 +32,6 @@ export type CounterStatus =
|
|
|
32
32
|
| 'accepted'
|
|
33
33
|
| 'rejected';
|
|
34
34
|
export type RiskSeverity = 'low' | 'medium' | 'high';
|
|
35
|
-
export type MilestoneStatus =
|
|
36
|
-
| 'pending'
|
|
37
|
-
| 'in_progress'
|
|
38
|
-
| 'delivered'
|
|
39
|
-
| 'completed'
|
|
40
|
-
| 'disputed';
|
|
41
35
|
|
|
42
36
|
// ───── Shared sub-types ──────────────────────────────────────────────────────
|
|
43
37
|
|
|
@@ -60,29 +54,6 @@ export interface EscrowVolumePoint {
|
|
|
60
54
|
total_amount: number;
|
|
61
55
|
}
|
|
62
56
|
|
|
63
|
-
export interface MilestoneRequest {
|
|
64
|
-
title: string;
|
|
65
|
-
description?: string | null;
|
|
66
|
-
amount: number;
|
|
67
|
-
due_date?: string | null;
|
|
68
|
-
/** Defaults to 48 on the server. */
|
|
69
|
-
inspection_hrs?: number;
|
|
70
|
-
}
|
|
71
|
-
|
|
72
|
-
export interface MilestoneResponse {
|
|
73
|
-
id: string;
|
|
74
|
-
escrow_id: string;
|
|
75
|
-
title: string;
|
|
76
|
-
description: string | null;
|
|
77
|
-
amount: number;
|
|
78
|
-
due_date: string | null;
|
|
79
|
-
inspection_hrs: number;
|
|
80
|
-
status: MilestoneStatus;
|
|
81
|
-
delivered_at: string | null;
|
|
82
|
-
completed_at: string | null;
|
|
83
|
-
sort_order: number;
|
|
84
|
-
}
|
|
85
|
-
|
|
86
57
|
// ───── Requests ──────────────────────────────────────────────────────────────
|
|
87
58
|
|
|
88
59
|
export interface OrganizationInitializeEscrowRequest {
|
|
@@ -102,7 +73,6 @@ export interface OrganizationInitializeEscrowRequest {
|
|
|
102
73
|
dispute_window?: number;
|
|
103
74
|
/** Defaults to 'buyer'. */
|
|
104
75
|
who_pays_fees?: FeePayer;
|
|
105
|
-
milestones?: MilestoneRequest[] | null;
|
|
106
76
|
}
|
|
107
77
|
|
|
108
78
|
export interface ListOrgEscrowsParams {
|