@pax2pay/model-banking 0.1.53 → 0.1.55

package/Realm/index.ts

@@ -1,10 +1,10 @@
 import { isly } from "isly"
+import { Supplier as modelSupplier } from "../Supplier"
 
-export const Realms = ["test", "testUK", "uk", "eu"] as const
-export type Realm = typeof Realms[number]
+export type Realm = typeof Realm.realms[number]
 
 export namespace Realm {
-	export const realms: Realm[] = [...Realms]
+	export const realms = ["test", "testUK", "uk", "eu"] as const
 	export const type: isly.Type<Realm> = isly.union(
 		isly.string("test"),
 		isly.string("testUK"),
@@ -15,4 +15,22 @@ export namespace Realm {
 	export function toString(): string {
 		return realms.toString().replaceAll(",", ", ") + "."
 	}
+	export const suppliers: Record<Realm, modelSupplier[]> = {
+		test: ["paxgiro"],
+		testUK: ["clearbank"],
+		uk: ["clearbank"],
+		eu: [],
+	}
+	export interface Suppliers extends Record<Realm, modelSupplier[]> {
+		test: ["paxgiro"]
+		testUK: ["clearbank"]
+		uk: ["clearbank"]
+		eu: []
+	}
+	export type Supplier<P extends keyof Suppliers> = Pick<Suppliers, P>[P][number]
+	export namespace Supplier {
+		export function is(realm: Realm, supplier: modelSupplier | any): supplier is Supplier<Realm> {
+			return suppliers[realm].includes(supplier)
+		}
+	}
 }

package/Settlement/Entry.ts

@@ -0,0 +1,55 @@
+import { isoly } from "isoly"
+import { isly } from "isly"
+
+export type Entry = Succeeded | Failed
+
+export interface Succeeded {
+	status: "succeeded"
+	type: "capture" | "cancel" | "refund"
+	account: string
+	card: string
+	transaction: string
+	amount: [isoly.Currency, number]
+	fee: [isoly.Currency, number]
+}
+export interface Failed {
+	status: "failed"
+	type?: "capture" | "cancel" | "refund"
+	account?: string
+	card?: string
+	transaction?: string
+	amount?: [isoly.Currency, number]
+	fee?: [isoly.Currency, number]
+	reason?: string
+	data?: any
+}
+export namespace Entry {
+	export namespace Succeeded {
+		export const type = isly.object<Succeeded>({
+			status: isly.string("succeeded"),
+			type: isly.union(isly.string("capture"), isly.string("cancel"), isly.string("refund")),
+			account: isly.string(),
+			card: isly.string(),
+			transaction: isly.string(),
+			amount: isly.tuple(isly.fromIs("Entry.amount", isoly.Currency.is), isly.number()),
+			fee: isly.tuple(isly.fromIs("Entry.fee", isoly.Currency.is), isly.number()),
+		})
+		export const is = type.is
+	}
+	export namespace Failed {
+		export const type = isly.object<Failed>({
+			status: isly.string("failed"),
+			type: isly.union(isly.string("capture"), isly.string("cancel"), isly.string("refund")).optional(),
+			account: isly.string().optional(),
+			card: isly.string().optional(),
+			transaction: isly.string().optional(),
+			amount: isly.tuple(isly.fromIs("Entry.amount", isoly.Currency.is), isly.number()).optional(),
+			fee: isly.tuple(isly.fromIs("Entry.fee", isoly.Currency.is), isly.number()).optional(),
+			reason: isly.string().optional(),
+			data: isly.any().optional(),
+		})
+		export const is = type.is
+	}
+	export const type = isly.union<Entry, Succeeded, Failed>(Succeeded.type, Failed.type)
+	export const is = type.is
+}

package/Settlement/index.ts

@@ -1,40 +1,30 @@
-import { gracely } from "gracely"
 import { isoly } from "isoly"
 import { isly } from "isly"
-import { Transaction } from "../Transaction"
+import { Entry as SettlementEntry } from "./Entry"
 
-export type Settlement = Succeeded | Failed
-
-export interface Base {
-	id: string
-	created: [string, isoly.DateTime]
-	configuration: string
-	status: string
-}
-
-export interface Failed extends Base {
-	status: "failed"
-}
-
-export interface Succeeded extends Base {
-	settled?: { user: string; created: isoly.DateTime; transaction: string }
-	amount: Record<isoly.Currency, number>
-	fee: Record<isoly.Currency, number>
-	entries: {
-		status: "succeeded" | "failed"
-		type: "capture" | "cancel" | "refund"
-		account: string
-		card: string
-		transaction: string
-		amount: [isoly.Currency, number]
-		fee: [isoly.Currency, number]
-	}[]
-	status: "succeeded"
-}
+export type Settlement = Settlement.Succeeded | Settlement.Failed
 
 export namespace Settlement {
-	export const type = isly.union<Settlement, Succeeded, Failed>(
-		isly.object<Succeeded>({
+	export interface Base {
+		id: string
+		created: [string, isoly.DateTime]
+		configuration: string
+		status: string
+	}
+	export interface Succeeded extends Base {
+		settled?: { user: string; created: isoly.DateTime; transaction: string }
+		amount: Partial<Record<isoly.Currency, number>>
+		fee: Partial<Record<isoly.Currency, number>>
+		entries: SettlementEntry[]
+		status: "succeeded"
+	}
+	export interface Failed extends Base {
+		status: "failed"
+		reason: string
+	}
+
+	export namespace Succeeded {
+		export const type = isly.object<Succeeded>({
 			id: isly.string(),
 			created: isly.tuple(isly.string(), isly.fromIs("Settlement.created", isoly.DateTime.is)),
 			configuration: isly.string(),
@@ -47,35 +37,24 @@ export namespace Settlement {
 				.optional(),
 			amount: isly.record(isly.fromIs("Settlement.entries.amount", isoly.Currency.is), isly.number()),
 			fee: isly.record(isly.fromIs("Settlement.entries.fee", isoly.Currency.is), isly.number()),
-			entries: isly
-				.object<{
-					status: "succeeded" | "failed"
-					type: "capture" | "cancel" | "refund"
-					account: string
-					card: string
-					transaction: string
-					amount: [isoly.Currency, number]
-					fee: [isoly.Currency, number]
-				}>({
-					status: isly.string(),
-					type: isly.string(),
-					account: isly.string(),
-					card: isly.string(),
-					transaction: isly.string(),
-					amount: isly.tuple(isly.fromIs("Settlement.entries.amount", isoly.Currency.is), isly.number()),
-					fee: isly.tuple(isly.fromIs("Settlement.entries.amount", isoly.Currency.is), isly.number()),
-				})
-				.array(),
+			entries: SettlementEntry.type.array(),
 			status: isly.string("succeeded"),
-		}),
-		isly.object<Failed>({
+		})
+		export const is = type.is
+	}
+	export namespace Failed {
+		export const type = isly.object<Failed>({
 			id: isly.string(),
 			created: isly.tuple(isly.string(), isly.fromIs("Settlement.created", isoly.DateTime.is)),
 			configuration: isly.string(),
 			status: isly.string("failed"),
+			reason: isly.string(),
 		})
-	)
+		export const is = type.is
+	}
+	export const type = isly.union<Settlement, Succeeded, Failed>(Succeeded.type, Failed.type)
 	export const is = type.is
 	export const flaw = type.flaw
-	export type Result = (Transaction | (gracely.Error & { id: string }))[]
+	export const Entry = SettlementEntry
+	export type Entry = SettlementEntry
 }

package/dist/Realm/index.d.ts

@@ -1,9 +1,20 @@
 import { isly } from "isly";
-export declare const Realms: readonly ["test", "testUK", "uk", "eu"];
-export type Realm = typeof Realms[number];
+import { Supplier as modelSupplier } from "../Supplier";
+export type Realm = typeof Realm.realms[number];
 export declare namespace Realm {
-    const realms: Realm[];
+    const realms: readonly ["test", "testUK", "uk", "eu"];
     const type: isly.Type<Realm>;
     const is: isly.Type.IsFunction<"eu" | "uk" | "test" | "testUK">;
     function toString(): string;
+    const suppliers: Record<Realm, modelSupplier[]>;
+    interface Suppliers extends Record<Realm, modelSupplier[]> {
+        test: ["paxgiro"];
+        testUK: ["clearbank"];
+        uk: ["clearbank"];
+        eu: [];
+    }
+    type Supplier<P extends keyof Suppliers> = Pick<Suppliers, P>[P][number];
+    namespace Supplier {
+        function is(realm: Realm, supplier: modelSupplier | any): supplier is Supplier<Realm>;
+    }
 }

package/dist/Realm/index.js

@@ -1,13 +1,25 @@
 import { isly } from "isly";
-export const Realms = ["test", "testUK", "uk", "eu"];
 export var Realm;
 (function (Realm) {
-    Realm.realms = [...Realms];
+    Realm.realms = ["test", "testUK", "uk", "eu"];
     Realm.type = isly.union(isly.string("test"), isly.string("testUK"), isly.string("uk"), isly.string("eu"));
     Realm.is = Realm.type.is;
     function toString() {
         return Realm.realms.toString().replaceAll(",", ", ") + ".";
     }
     Realm.toString = toString;
+    Realm.suppliers = {
+        test: ["paxgiro"],
+        testUK: ["clearbank"],
+        uk: ["clearbank"],
+        eu: [],
+    };
+    let Supplier;
+    (function (Supplier) {
+        function is(realm, supplier) {
+            return Realm.suppliers[realm].includes(supplier);
+        }
+        Supplier.is = is;
+    })(Supplier = Realm.Supplier || (Realm.Supplier = {}));
 })(Realm || (Realm = {}));
 //# sourceMappingURL=index.js.map

package/dist/Realm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"../","sources":["Realm/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAE3B,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAU,CAAA;AAG7D,MAAM,KAAW,KAAK,CAYrB;AAZD,WAAiB,KAAK;IACR,YAAM,GAAY,CAAC,GAAG,MAAM,CAAC,CAAA;IAC7B,UAAI,GAAqB,IAAI,CAAC,KAAK,CAC/C,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EACnB,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EACrB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EACjB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CACjB,CAAA;IACY,QAAE,GAAG,MAAA,IAAI,CAAC,EAAE,CAAA;IACzB,SAAgB,QAAQ;QACvB,OAAO,MAAA,MAAM,CAAC,QAAQ,EAAE,CAAC,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,GAAG,CAAA;IACrD,CAAC;IAFe,cAAQ,WAEvB,CAAA;AACF,CAAC,EAZgB,KAAK,KAAL,KAAK,QAYrB"}
+{"version":3,"file":"index.js","sourceRoot":"../","sources":["Realm/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAK3B,MAAM,KAAW,KAAK,CA8BrB;AA9BD,WAAiB,KAAK;IACR,YAAM,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAU,CAAA;IAChD,UAAI,GAAqB,IAAI,CAAC,KAAK,CAC/C,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EACnB,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EACrB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EACjB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CACjB,CAAA;IACY,QAAE,GAAG,MAAA,IAAI,CAAC,EAAE,CAAA;IACzB,SAAgB,QAAQ;QACvB,OAAO,MAAA,MAAM,CAAC,QAAQ,EAAE,CAAC,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,GAAG,CAAA;IACrD,CAAC;IAFe,cAAQ,WAEvB,CAAA;IACY,eAAS,GAAmC;QACxD,IAAI,EAAE,CAAC,SAAS,CAAC;QACjB,MAAM,EAAE,CAAC,WAAW,CAAC;QACrB,EAAE,EAAE,CAAC,WAAW,CAAC;QACjB,EAAE,EAAE,EAAE;KACN,CAAA;IAQD,IAAiB,QAAQ,CAIxB;IAJD,WAAiB,QAAQ;QACxB,SAAgB,EAAE,CAAC,KAAY,EAAE,QAA6B;YAC7D,OAAO,MAAA,SAAS,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;QAC3C,CAAC;QAFe,WAAE,KAEjB,CAAA;IACF,CAAC,EAJgB,QAAQ,GAAR,cAAQ,KAAR,cAAQ,QAIxB;AACF,CAAC,EA9BgB,KAAK,KAAL,KAAK,QA8BrB"}

package/dist/Settlement/Entry.d.ts

@@ -0,0 +1,35 @@
+import { isoly } from "isoly";
+import { isly } from "isly";
+export type Entry = Succeeded | Failed;
+export interface Succeeded {
+    status: "succeeded";
+    type: "capture" | "cancel" | "refund";
+    account: string;
+    card: string;
+    transaction: string;
+    amount: [isoly.Currency, number];
+    fee: [isoly.Currency, number];
+}
+export interface Failed {
+    status: "failed";
+    type?: "capture" | "cancel" | "refund";
+    account?: string;
+    card?: string;
+    transaction?: string;
+    amount?: [isoly.Currency, number];
+    fee?: [isoly.Currency, number];
+    reason?: string;
+    data?: any;
+}
+export declare namespace Entry {
+    namespace Succeeded {
+        const type: isly.object.ExtendableType<Succeeded>;
+        const is: isly.Type.IsFunction<Succeeded>;
+    }
+    namespace Failed {
+        const type: isly.object.ExtendableType<Failed>;
+        const is: isly.Type.IsFunction<Failed>;
+    }
+    const type: isly.Type<Entry>;
+    const is: isly.Type.IsFunction<Entry>;
+}

package/dist/Settlement/Entry.js

@@ -0,0 +1,36 @@
+import { isoly } from "isoly";
+import { isly } from "isly";
+export var Entry;
+(function (Entry) {
+    let Succeeded;
+    (function (Succeeded) {
+        Succeeded.type = isly.object({
+            status: isly.string("succeeded"),
+            type: isly.union(isly.string("capture"), isly.string("cancel"), isly.string("refund")),
+            account: isly.string(),
+            card: isly.string(),
+            transaction: isly.string(),
+            amount: isly.tuple(isly.fromIs("Entry.amount", isoly.Currency.is), isly.number()),
+            fee: isly.tuple(isly.fromIs("Entry.fee", isoly.Currency.is), isly.number()),
+        });
+        Succeeded.is = Succeeded.type.is;
+    })(Succeeded = Entry.Succeeded || (Entry.Succeeded = {}));
+    let Failed;
+    (function (Failed) {
+        Failed.type = isly.object({
+            status: isly.string("failed"),
+            type: isly.union(isly.string("capture"), isly.string("cancel"), isly.string("refund")).optional(),
+            account: isly.string().optional(),
+            card: isly.string().optional(),
+            transaction: isly.string().optional(),
+            amount: isly.tuple(isly.fromIs("Entry.amount", isoly.Currency.is), isly.number()).optional(),
+            fee: isly.tuple(isly.fromIs("Entry.fee", isoly.Currency.is), isly.number()).optional(),
+            reason: isly.string().optional(),
+            data: isly.any().optional(),
+        });
+        Failed.is = Failed.type.is;
+    })(Failed = Entry.Failed || (Entry.Failed = {}));
+    Entry.type = isly.union(Succeeded.type, Failed.type);
+    Entry.is = Entry.type.is;
+})(Entry || (Entry = {}));
+//# sourceMappingURL=Entry.js.map

package/dist/Settlement/Entry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Entry.js","sourceRoot":"../","sources":["Settlement/Entry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,OAAO,CAAA;AAC7B,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAwB3B,MAAM,KAAW,KAAK,CA6BrB;AA7BD,WAAiB,KAAK;IACrB,IAAiB,SAAS,CAWzB;IAXD,WAAiB,SAAS;QACZ,cAAI,GAAG,IAAI,CAAC,MAAM,CAAY;YAC1C,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;YAChC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YACtF,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE;YACtB,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE;YACnB,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE;YAC1B,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;YACjF,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;SAC3E,CAAC,CAAA;QACW,YAAE,GAAG,UAAA,IAAI,CAAC,EAAE,CAAA;IAC1B,CAAC,EAXgB,SAAS,GAAT,eAAS,KAAT,eAAS,QAWzB;IACD,IAAiB,MAAM,CAatB;IAbD,WAAiB,MAAM;QACT,WAAI,GAAG,IAAI,CAAC,MAAM,CAAS;YACvC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;YAC7B,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,EAAE;YACjG,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YACjC,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YAC9B,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YACrC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;YAC5F,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;YACtF,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YAChC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;SAC3B,CAAC,CAAA;QACW,SAAE,GAAG,OAAA,IAAI,CAAC,EAAE,CAAA;IAC1B,CAAC,EAbgB,MAAM,GAAN,YAAM,KAAN,YAAM,QAatB;IACY,UAAI,GAAG,IAAI,CAAC,KAAK,CAA2B,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,CAAA;IACxE,QAAE,GAAG,MAAA,IAAI,CAAC,EAAE,CAAA;AAC1B,CAAC,EA7BgB,KAAK,KAAL,KAAK,QA6BrB"}

package/dist/Settlement/index.d.ts

@@ -1,41 +1,40 @@
-import { gracely } from "gracely";
 import { isoly } from "isoly";
 import { isly } from "isly";
-import { Transaction } from "../Transaction";
-export type Settlement = Succeeded | Failed;
-export interface Base {
-    id: string;
-    created: [string, isoly.DateTime];
-    configuration: string;
-    status: string;
-}
-export interface Failed extends Base {
-    status: "failed";
-}
-export interface Succeeded extends Base {
-    settled?: {
-        user: string;
-        created: isoly.DateTime;
-        transaction: string;
-    };
-    amount: Record<isoly.Currency, number>;
-    fee: Record<isoly.Currency, number>;
-    entries: {
-        status: "succeeded" | "failed";
-        type: "capture" | "cancel" | "refund";
-        account: string;
-        card: string;
-        transaction: string;
-        amount: [isoly.Currency, number];
-        fee: [isoly.Currency, number];
-    }[];
-    status: "succeeded";
-}
+import { Entry as SettlementEntry } from "./Entry";
+export type Settlement = Settlement.Succeeded | Settlement.Failed;
 export declare namespace Settlement {
+    interface Base {
+        id: string;
+        created: [string, isoly.DateTime];
+        configuration: string;
+        status: string;
+    }
+    interface Succeeded extends Base {
+        settled?: {
+            user: string;
+            created: isoly.DateTime;
+            transaction: string;
+        };
+        amount: Partial<Record<isoly.Currency, number>>;
+        fee: Partial<Record<isoly.Currency, number>>;
+        entries: SettlementEntry[];
+        status: "succeeded";
+    }
+    interface Failed extends Base {
+        status: "failed";
+        reason: string;
+    }
+    namespace Succeeded {
+        const type: isly.object.ExtendableType<Succeeded>;
+        const is: isly.Type.IsFunction<Succeeded>;
+    }
+    namespace Failed {
+        const type: isly.object.ExtendableType<Failed>;
+        const is: isly.Type.IsFunction<Failed>;
+    }
     const type: isly.Type<Settlement>;
     const is: isly.Type.IsFunction<Settlement>;
     const flaw: isly.Type.FlawFunction;
-    type Result = (Transaction | (gracely.Error & {
-        id: string;
-    }))[];
+    const Entry: typeof SettlementEntry;
+    type Entry = SettlementEntry;
 }

package/dist/Settlement/index.js

@@ -1,39 +1,42 @@
 import { isoly } from "isoly";
 import { isly } from "isly";
+import { Entry as SettlementEntry } from "./Entry";
 export var Settlement;
 (function (Settlement) {
-    Settlement.type = isly.union(isly.object({
-        id: isly.string(),
-        created: isly.tuple(isly.string(), isly.fromIs("Settlement.created", isoly.DateTime.is)),
-        configuration: isly.string(),
-        settled: isly
-            .object({
-            user: isly.string(),
-            created: isly.fromIs("Settlement.settled.created", isoly.DateTime.is),
-            transaction: isly.string(),
-        })
-            .optional(),
-        amount: isly.record(isly.fromIs("Settlement.entries.amount", isoly.Currency.is), isly.number()),
-        fee: isly.record(isly.fromIs("Settlement.entries.fee", isoly.Currency.is), isly.number()),
-        entries: isly
-            .object({
-            status: isly.string(),
-            type: isly.string(),
-            account: isly.string(),
-            card: isly.string(),
-            transaction: isly.string(),
-            amount: isly.tuple(isly.fromIs("Settlement.entries.amount", isoly.Currency.is), isly.number()),
-            fee: isly.tuple(isly.fromIs("Settlement.entries.amount", isoly.Currency.is), isly.number()),
-        })
-            .array(),
-        status: isly.string("succeeded"),
-    }), isly.object({
-        id: isly.string(),
-        created: isly.tuple(isly.string(), isly.fromIs("Settlement.created", isoly.DateTime.is)),
-        configuration: isly.string(),
-        status: isly.string("failed"),
-    }));
+    let Succeeded;
+    (function (Succeeded) {
+        Succeeded.type = isly.object({
+            id: isly.string(),
+            created: isly.tuple(isly.string(), isly.fromIs("Settlement.created", isoly.DateTime.is)),
+            configuration: isly.string(),
+            settled: isly
+                .object({
+                user: isly.string(),
+                created: isly.fromIs("Settlement.settled.created", isoly.DateTime.is),
+                transaction: isly.string(),
+            })
+                .optional(),
+            amount: isly.record(isly.fromIs("Settlement.entries.amount", isoly.Currency.is), isly.number()),
+            fee: isly.record(isly.fromIs("Settlement.entries.fee", isoly.Currency.is), isly.number()),
+            entries: SettlementEntry.type.array(),
+            status: isly.string("succeeded"),
+        });
+        Succeeded.is = Succeeded.type.is;
+    })(Succeeded = Settlement.Succeeded || (Settlement.Succeeded = {}));
+    let Failed;
+    (function (Failed) {
+        Failed.type = isly.object({
+            id: isly.string(),
+            created: isly.tuple(isly.string(), isly.fromIs("Settlement.created", isoly.DateTime.is)),
+            configuration: isly.string(),
+            status: isly.string("failed"),
+            reason: isly.string(),
+        });
+        Failed.is = Failed.type.is;
+    })(Failed = Settlement.Failed || (Settlement.Failed = {}));
+    Settlement.type = isly.union(Succeeded.type, Failed.type);
     Settlement.is = Settlement.type.is;
     Settlement.flaw = Settlement.type.flaw;
+    Settlement.Entry = SettlementEntry;
 })(Settlement || (Settlement = {}));
 //# sourceMappingURL=index.js.map

package/dist/Settlement/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"../","sources":["Settlement/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,OAAO,CAAA;AAC7B,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAgC3B,MAAM,KAAW,UAAU,CA8C1B;AA9CD,WAAiB,UAAU;IACb,eAAI,GAAG,IAAI,CAAC,KAAK,CAC7B,IAAI,CAAC,MAAM,CAAY;QACtB,EAAE,EAAE,IAAI,CAAC,MAAM,EAAE;QACjB,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,oBAAoB,EAAE,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QACxF,aAAa,EAAE,IAAI,CAAC,MAAM,EAAE;QAC5B,OAAO,EAAE,IAAI;aACX,MAAM,CAAiE;YACvE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE;YACnB,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,4BAA4B,EAAE,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;YACrE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE;SAC1B,CAAC;aACD,QAAQ,EAAE;QACZ,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,2BAA2B,EAAE,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;QAC/F,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,wBAAwB,EAAE,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;QACzF,OAAO,EAAE,IAAI;aACX,MAAM,CAQJ;YACF,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE;YACrB,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE;YACnB,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE;YACtB,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE;YACnB,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE;YAC1B,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,2BAA2B,EAAE,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;YAC9F,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,2BAA2B,EAAE,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;SAC3F,CAAC;aACD,KAAK,EAAE;QACT,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;KAChC,CAAC,EACF,IAAI,CAAC,MAAM,CAAS;QACnB,EAAE,EAAE,IAAI,CAAC,MAAM,EAAE;QACjB,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,oBAAoB,EAAE,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QACxF,aAAa,EAAE,IAAI,CAAC,MAAM,EAAE;QAC5B,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;KAC7B,CAAC,CACF,CAAA;IACY,aAAE,GAAG,WAAA,IAAI,CAAC,EAAE,CAAA;IACZ,eAAI,GAAG,WAAA,IAAI,CAAC,IAAI,CAAA;AAE9B,CAAC,EA9CgB,UAAU,KAAV,UAAU,QA8C1B"}
+{"version":3,"file":"index.js","sourceRoot":"../","sources":["Settlement/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,OAAO,CAAA;AAC7B,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAC3B,OAAO,EAAE,KAAK,IAAI,eAAe,EAAE,MAAM,SAAS,CAAA;AAIlD,MAAM,KAAW,UAAU,CAqD1B;AArDD,WAAiB,UAAU;IAmB1B,IAAiB,SAAS,CAkBzB;IAlBD,WAAiB,SAAS;QACZ,cAAI,GAAG,IAAI,CAAC,MAAM,CAAY;YAC1C,EAAE,EAAE,IAAI,CAAC,MAAM,EAAE;YACjB,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,oBAAoB,EAAE,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACxF,aAAa,EAAE,IAAI,CAAC,MAAM,EAAE;YAC5B,OAAO,EAAE,IAAI;iBACX,MAAM,CAAiE;gBACvE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE;gBACnB,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,4BAA4B,EAAE,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACrE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE;aAC1B,CAAC;iBACD,QAAQ,EAAE;YACZ,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,2BAA2B,EAAE,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;YAC/F,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,wBAAwB,EAAE,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;YACzF,OAAO,EAAE,eAAe,CAAC,IAAI,CAAC,KAAK,EAAE;YACrC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;SAChC,CAAC,CAAA;QACW,YAAE,GAAG,UAAA,IAAI,CAAC,EAAE,CAAA;IAC1B,CAAC,EAlBgB,SAAS,GAAT,oBAAS,KAAT,oBAAS,QAkBzB;IACD,IAAiB,MAAM,CAStB;IATD,WAAiB,MAAM;QACT,WAAI,GAAG,IAAI,CAAC,MAAM,CAAS;YACvC,EAAE,EAAE,IAAI,CAAC,MAAM,EAAE;YACjB,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,oBAAoB,EAAE,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACxF,aAAa,EAAE,IAAI,CAAC,MAAM,EAAE;YAC5B,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;YAC7B,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE;SACrB,CAAC,CAAA;QACW,SAAE,GAAG,OAAA,IAAI,CAAC,EAAE,CAAA;IAC1B,CAAC,EATgB,MAAM,GAAN,iBAAM,KAAN,iBAAM,QAStB;IACY,eAAI,GAAG,IAAI,CAAC,KAAK,CAAgC,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,CAAA;IAC7E,aAAE,GAAG,WAAA,IAAI,CAAC,EAAE,CAAA;IACZ,eAAI,GAAG,WAAA,IAAI,CAAC,IAAI,CAAA;IAChB,gBAAK,GAAG,eAAe,CAAA;AAErC,CAAC,EArDgB,UAAU,KAAV,UAAU,QAqD1B"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@pax2pay/model-banking",
-	"version": "0.1.53",
+	"version": "0.1.55",
 	"description": "Library containing data model types and functions for the Pax2Pay Banking API.",
 	"author": "Pax2Pay Ltd",
 	"license": "MIT",