@mft/moneyhub-api-client 4.20.0 → 5.0.0-2

package/dist/types/schema/standing-order.d.ts

@@ -0,0 +1,80 @@
+import { SearchParams } from "../request";
+import type { Balance } from "./balance";
+import type { PaymentActorType, PaymentContext } from "./payment";
+interface Payee {
+    name?: string;
+    sortCodeAccountNumber?: string;
+    iban?: string;
+    pan?: string;
+}
+declare enum Status {
+    ACTIVE = "Active",
+    INACTIVE = "Inactive"
+}
+declare enum FrequencyRepeat {
+    DAILY = "Daily",
+    WEEKLY = "Weekly",
+    MONTHLY = "Monthly",
+    QUARTERLY = "Quarterly",
+    YEARLY = "Yearly"
+}
+export interface Frequency {
+    repeat: FrequencyRepeat;
+    day?: number;
+    week?: number;
+    month?: number;
+    onlyWorkDays?: boolean;
+    region?: string;
+}
+export interface StandingOrder {
+    id: string;
+    status?: Status;
+    reference?: string;
+    frequency: FrequencyRepeat;
+    numberOfPayments?: number;
+    firstPaymentDate?: string;
+    nextPaymentDate?: string;
+    finalPaymentDate?: string;
+    firstPaymentAmount?: Balance;
+    nextPaymentAmount?: Balance;
+    finalPaymentAmount?: Balance;
+    currency?: string;
+}
+export interface StandingOrderWithDetail extends StandingOrder {
+    payee?: Payee;
+}
+export interface AuthRequestStandingOrderPost {
+    payeeId?: string;
+    payeeType?: PaymentActorType;
+    payerId?: string;
+    payerType?: PaymentActorType;
+    context: PaymentContext;
+    reference?: string;
+    numberOfPayments?: number;
+    firstPaymentDate?: string;
+    recurringPaymentDate?: string;
+    finalPaymentDate?: string;
+    firstPaymentAmount?: number;
+    recurringPaymentAmount?: number;
+    finalPaymentAmount?: number;
+    currency?: string;
+}
+export interface StandingOrderSearchParams extends SearchParams {
+    userId?: string;
+}
+declare enum StandingOrderRequestStatus {
+    IN_PROGRESS = "InProgress",
+    INITIATION_PENDING = "InitiationPending",
+    INITIATION_FAILED = "InitiationFailed",
+    INITIATION_COMPLETED = "InitiationCompleted",
+    CANCELLED = "Cancelled"
+}
+export interface StandingOrderRequest {
+    id: string;
+    status?: StandingOrderRequestStatus;
+    createdAt: string;
+    updatedAt?: string;
+    standingOrder: StandingOrder;
+}
+export {};
+//# sourceMappingURL=standing-order.d.ts.map

package/dist/types/schema/standing-order.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"standing-order.d.ts","sourceRoot":"","sources":["../../../types/schema/standing-order.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAC,MAAM,YAAY,CAAA;AACvC,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,WAAW,CAAA;AACtC,OAAO,KAAK,EAAC,gBAAgB,EAAE,cAAc,EAAC,MAAM,WAAW,CAAA;AAE/D,UAAU,KAAK;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED,aAAK,MAAM;IACT,MAAM,WAAW;IACjB,QAAQ,aAAa;CACtB;AAED,aAAK,eAAe;IAClB,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,MAAM,WAAW;CAClB;AAED,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,eAAe,CAAA;IACvB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,eAAe,CAAA;IAC1B,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,uBAAwB,SAAQ,aAAa;IAC5D,KAAK,CAAC,EAAE,KAAK,CAAA;CACd;AAED,MAAM,WAAW,4BAA4B;IAC3C,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,SAAS,CAAC,EAAE,gBAAgB,CAAA;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,SAAS,CAAC,EAAE,gBAAgB,CAAA;IAC5B,OAAO,EAAE,cAAc,CAAA;IACvB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,oBAAoB,CAAC,EAAE,MAAM,CAAA;IAC7B,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,sBAAsB,CAAC,EAAE,MAAM,CAAA;IAC/B,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,yBAA0B,SAAQ,YAAY;IAC7D,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,aAAK,0BAA0B;IAC7B,WAAW,eAAe;IAC1B,kBAAkB,sBAAsB;IACxC,iBAAiB,qBAAqB;IACtC,oBAAoB,wBAAwB;IAC5C,SAAS,cAAc;CACxB;AAED,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,CAAC,EAAE,0BAA0B,CAAA;IACnC,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,aAAa,EAAE,aAAa,CAAA;CAC7B"}

package/dist/types/schema/standing-order.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var Status;
+(function (Status) {
+    Status["ACTIVE"] = "Active";
+    Status["INACTIVE"] = "Inactive";
+})(Status || (Status = {}));
+var FrequencyRepeat;
+(function (FrequencyRepeat) {
+    FrequencyRepeat["DAILY"] = "Daily";
+    FrequencyRepeat["WEEKLY"] = "Weekly";
+    FrequencyRepeat["MONTHLY"] = "Monthly";
+    FrequencyRepeat["QUARTERLY"] = "Quarterly";
+    FrequencyRepeat["YEARLY"] = "Yearly";
+})(FrequencyRepeat || (FrequencyRepeat = {}));
+var StandingOrderRequestStatus;
+(function (StandingOrderRequestStatus) {
+    StandingOrderRequestStatus["IN_PROGRESS"] = "InProgress";
+    StandingOrderRequestStatus["INITIATION_PENDING"] = "InitiationPending";
+    StandingOrderRequestStatus["INITIATION_FAILED"] = "InitiationFailed";
+    StandingOrderRequestStatus["INITIATION_COMPLETED"] = "InitiationCompleted";
+    StandingOrderRequestStatus["CANCELLED"] = "Cancelled";
+})(StandingOrderRequestStatus || (StandingOrderRequestStatus = {}));
+//# sourceMappingURL=standing-order.js.map

package/dist/types/schema/standing-order.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"standing-order.js","sourceRoot":"","sources":["../../../types/schema/standing-order.ts"],"names":[],"mappings":";;AAWA,IAAK,MAGJ;AAHD,WAAK,MAAM;IACT,2BAAiB,CAAA;IACjB,+BAAqB,CAAA;AACvB,CAAC,EAHI,MAAM,KAAN,MAAM,QAGV;AAED,IAAK,eAMJ;AAND,WAAK,eAAe;IAClB,kCAAe,CAAA;IACf,oCAAiB,CAAA;IACjB,sCAAmB,CAAA;IACnB,0CAAuB,CAAA;IACvB,oCAAiB,CAAA;AACnB,CAAC,EANI,eAAe,KAAf,eAAe,QAMnB;AAmDD,IAAK,0BAMJ;AAND,WAAK,0BAA0B;IAC7B,wDAA0B,CAAA;IAC1B,sEAAwC,CAAA;IACxC,oEAAsC,CAAA;IACtC,0EAA4C,CAAA;IAC5C,qDAAuB,CAAA;AACzB,CAAC,EANI,0BAA0B,KAA1B,0BAA0B,QAM9B"}

package/dist/types/schema/sync.d.ts

@@ -0,0 +1,16 @@
+interface SyncAccount {
+    providerId: string;
+    accountId: string;
+}
+export interface ConnectionSync {
+    id: string;
+    connectionId: string;
+    action: "auto-update" | "client-update";
+    method: "ADD" | "UPDATE";
+    fetchStatus: "success" | "error" | "partial" | "mfa-required" | "credentials-error";
+    createdAt: string;
+    fetchedAt: string;
+    accounts: SyncAccount[];
+}
+export {};
+//# sourceMappingURL=sync.d.ts.map

package/dist/types/schema/sync.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sync.d.ts","sourceRoot":"","sources":["../../../types/schema/sync.ts"],"names":[],"mappings":"AAAA,UAAU,WAAW;IACnB,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAA;IACV,YAAY,EAAE,MAAM,CAAA;IACpB,MAAM,EAAE,aAAa,GAAG,eAAe,CAAA;IACvC,MAAM,EAAE,KAAK,GAAG,QAAQ,CAAA;IACxB,WAAW,EAAE,SAAS,GAAG,OAAO,GAAG,SAAS,GAAG,cAAc,GAAG,mBAAmB,CAAA;IACnF,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,WAAW,EAAE,CAAA;CACxB"}

package/dist/types/schema/sync.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=sync.js.map

package/dist/types/schema/sync.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sync.js","sourceRoot":"","sources":["../../../types/schema/sync.ts"],"names":[],"mappings":""}

package/dist/types/schema/tax.d.ts

@@ -0,0 +1,35 @@
+import { SearchParams } from "../request";
+import { Amount } from "./balance";
+export interface TaxSearchParams extends SearchParams {
+    startDate: string;
+    endDate: string;
+}
+interface Details {
+    category: string;
+    amount: {
+        value: number;
+        currency: string;
+    };
+}
+interface TaxReturn {
+    sa105: {
+        income: {
+            total: Amount;
+            details: Details[];
+        };
+        expenditure: {
+            total: Amount;
+            details: Details[];
+        };
+        taxableIncome: {
+            total: Amount;
+        };
+    };
+}
+export interface Tax {
+    startDate: string;
+    endDate: string;
+    taxReturn: TaxReturn;
+}
+export {};
+//# sourceMappingURL=tax.d.ts.map

package/dist/types/schema/tax.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tax.d.ts","sourceRoot":"","sources":["../../../types/schema/tax.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAC,MAAM,YAAY,CAAA;AACvC,OAAO,EAAC,MAAM,EAAC,MAAM,WAAW,CAAA;AAEhC,MAAM,WAAW,eAAgB,SAAQ,YAAY;IACnD,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,UAAU,OAAO;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE;QACN,KAAK,EAAE,MAAM,CAAA;QACb,QAAQ,EAAE,MAAM,CAAA;KACjB,CAAA;CACF;AAED,UAAU,SAAS;IACjB,KAAK,EAAE;QACL,MAAM,EAAE;YACN,KAAK,EAAE,MAAM,CAAA;YACb,OAAO,EAAE,OAAO,EAAE,CAAA;SACnB,CAAA;QACD,WAAW,EAAE;YACX,KAAK,EAAE,MAAM,CAAA;YACb,OAAO,EAAE,OAAO,EAAE,CAAA;SACnB,CAAA;QACD,aAAa,EAAE;YACb,KAAK,EAAE,MAAM,CAAA;SACd,CAAA;KACF,CAAA;CACF;AAED,MAAM,WAAW,GAAG;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,EAAE,SAAS,CAAA;CACrB"}

package/dist/types/schema/tax.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=tax.js.map

package/dist/types/schema/tax.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tax.js","sourceRoot":"","sources":["../../../types/schema/tax.ts"],"names":[],"mappings":""}

package/dist/types/schema/transaction.d.ts

@@ -0,0 +1,127 @@
+import type { Balance } from "./balance";
+export interface RecurringTransactionEstimate {
+    counterpartyId?: string;
+    amount?: Balance;
+    amountRange?: Balance;
+    monthlyAmount?: Balance;
+    predictionSource?: "moneyhub";
+    monthlyAverageOnly?: boolean;
+    dates?: string[];
+}
+import { SearchParams } from "../request";
+import { Amount } from "./balance";
+export interface TransactionFile {
+    id: string;
+    fileType: string;
+    fileName: string;
+    url: string;
+}
+export interface TransactionSplitPost {
+    amount: number;
+    categoryId: string;
+    description: string;
+    projectId?: string;
+}
+export interface TransactionSplit {
+    amount: Amount;
+    categoryId: string;
+    description: string;
+    id: string;
+    projectId?: string;
+}
+export interface TransactionSplitPatch {
+    categoryId?: string;
+    description?: string;
+    projectId?: string;
+}
+export interface TransactionSearchParams extends SearchParams {
+    ids?: string[];
+    startDate?: string;
+    endDate?: string;
+    startDateModified?: string;
+    endDateModified?: string;
+    text?: string;
+    categoryId?: string;
+    accountId?: string;
+    accountIds?: string[];
+    projectId?: string;
+    projectIds?: string;
+    creditDebitIndicator?: string;
+    hasProject?: boolean;
+    contains?: string;
+    hasEnhancedCategory?: string;
+    counterpartyIdsV2?: string[];
+    counterpartiesVersion?: "v2" | "v3";
+    enhancedCategories?: string;
+}
+interface CardInstrument {
+    name?: string;
+    pan?: string;
+    cardSchemeName?: string;
+    authorisationType?: string;
+}
+interface CreditorDebtorAccount {
+    name?: string;
+    sortCode?: string;
+    accountNumber?: string;
+    iban?: string;
+    pan?: string;
+}
+interface CreditorDebtorAgent {
+    name?: string;
+    postalAddress?: object;
+}
+declare type Status = "posted" | "pending";
+export interface Transaction {
+    accountId?: string;
+    amount: Amount;
+    categoryId: string;
+    categoryIdConfirmed: boolean;
+    date: string;
+    dateModified: string;
+    id: string;
+    longDescription: string;
+    providerId?: string;
+    notes: string;
+    shortDescription: string;
+    counterpartyId?: string;
+    status: Status;
+    projectId?: string;
+    enhancedCategories?: object;
+    splits?: TransactionSplit[];
+    transactionCode?: {
+        code: string;
+        subCode: string;
+    };
+    proprietaryTransactionCode: {
+        code: string;
+        issuer?: string;
+    };
+    balance?: Amount;
+    balanceType?: string;
+    statementReference?: string;
+    merchantCategoryCode?: string;
+    cardInstrument?: CardInstrument;
+    creditorAccount?: CreditorDebtorAccount;
+    debtorAccount?: CreditorDebtorAccount;
+    creditorAgent?: CreditorDebtorAgent;
+    debtorAgent?: CreditorDebtorAgent;
+}
+export interface TransactionPost {
+    accountId: string;
+    amount: {
+        value: number;
+    };
+    categoryId: string;
+    categoryIdConfirmed?: boolean;
+    date: string;
+    longDescription: string;
+    shortDescription?: string;
+    notes?: string;
+    status?: Status;
+    projectId?: string;
+    enhancedCategories: object;
+}
+export declare type TransactionPatch = Partial<TransactionPost>;
+export {};
+//# sourceMappingURL=transaction.d.ts.map

package/dist/types/schema/transaction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.d.ts","sourceRoot":"","sources":["../../../types/schema/transaction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,WAAW,CAAA;AAEtC,MAAM,WAAW,4BAA4B;IAC3C,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,gBAAgB,CAAC,EAAE,UAAU,CAAA;IAC7B,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;CACjB;AAED,OAAO,EAAC,YAAY,EAAC,MAAM,YAAY,CAAA;AACvC,OAAO,EAAC,MAAM,EAAC,MAAM,WAAW,CAAA;AAEhC,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,GAAG,EAAE,MAAM,CAAA;CACZ;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,CAAA;IAClB,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,CAAA;IAClB,WAAW,EAAE,MAAM,CAAA;IACnB,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,uBAAwB,SAAQ,YAAY;IAC3D,GAAG,CAAC,EAAE,MAAM,EAAE,CAAA;IACd,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;IACrB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,oBAAoB,CAAC,EAAE,MAAM,CAAA;IAC7B,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC5B,qBAAqB,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACnC,kBAAkB,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED,UAAU,cAAc;IACtB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,iBAAiB,CAAC,EAAE,MAAM,CAAA;CAC3B;AAED,UAAU,qBAAqB;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED,UAAU,mBAAmB;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,aAAK,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAA;AAElC,MAAM,WAAW,WAAW;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,CAAA;IAClB,mBAAmB,EAAE,OAAO,CAAA;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,YAAY,EAAE,MAAM,CAAA;IACpB,EAAE,EAAE,MAAM,CAAA;IACV,eAAe,EAAE,MAAM,CAAA;IACvB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE,MAAM,CAAA;IACb,gBAAgB,EAAE,MAAM,CAAA;IACxB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,MAAM,CAAC,EAAE,gBAAgB,EAAE,CAAA;IAC3B,eAAe,CAAC,EAAE;QAChB,IAAI,EAAE,MAAM,CAAA;QACZ,OAAO,EAAE,MAAM,CAAA;KAChB,CAAA;IACD,0BAA0B,EAAE;QAC1B,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,CAAA;IACD,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,oBAAoB,CAAC,EAAE,MAAM,CAAA;IAC7B,cAAc,CAAC,EAAE,cAAc,CAAA;IAC/B,eAAe,CAAC,EAAE,qBAAqB,CAAA;IACvC,aAAa,CAAC,EAAE,qBAAqB,CAAA;IACrC,aAAa,CAAC,EAAE,mBAAmB,CAAA;IACnC,WAAW,CAAC,EAAE,mBAAmB,CAAA;CAClC;AAED,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE;QACN,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;IACD,UAAU,EAAE,MAAM,CAAA;IAClB,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,eAAe,EAAE,MAAM,CAAA;IACvB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,kBAAkB,EAAE,MAAM,CAAA;CAC3B;AAED,oBAAY,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAC,CAAA"}

package/dist/types/schema/transaction.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=transaction.js.map

package/dist/types/schema/transaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.js","sourceRoot":"","sources":["../../../types/schema/transaction.ts"],"names":[],"mappings":""}

package/dist/types/schema/user.d.ts

@@ -0,0 +1,15 @@
+export interface User {
+    userId: string;
+    clientUserId: string;
+    clientId: string;
+    createdAt: string;
+    updatedAt: string;
+    scopes: string;
+    managedBy: "user" | "client";
+    lastAccessed: string;
+    deletedAt?: string;
+    userType: "test" | "demo" | "live";
+    clientName?: string;
+    connectionIds: string[];
+}
+//# sourceMappingURL=user.d.ts.map

package/dist/types/schema/user.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../../types/schema/user.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,IAAI;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,YAAY,EAAE,MAAM,CAAA;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,GAAG,QAAQ,CAAA;IAC5B,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;IAClC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,aAAa,EAAE,MAAM,EAAE,CAAA;CACxB"}

package/dist/types/schema/user.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=user.js.map

package/dist/types/schema/user.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.js","sourceRoot":"","sources":["../../../types/schema/user.ts"],"names":[],"mappings":""}

package/dist/types/tokens.d.ts

@@ -0,0 +1,40 @@
+import { Client, TokenSet } from "openid-client";
+import type { ApiClientConfig } from "./config";
+export interface TokensRequestsParams {
+    client: Client;
+    config: ApiClientConfig;
+}
+declare type ParamsFromCallback = Partial<{
+    code: string;
+    id_token: string;
+    state: string;
+}>;
+declare type LocalParams = Partial<{
+    state: string;
+    nonce: string;
+    sub: string;
+    max_age: number;
+    response_type: string;
+    code_verifier: string;
+}>;
+export interface TokensRequests {
+    exchangeCodeForTokensLegacy: ({ state, code, nonce, id_token, }: {
+        state: string;
+        code: string;
+        nonce: string;
+        id_token: string;
+    }) => Promise<TokenSet>;
+    exchangeCodeForTokens: ({ paramsFromCallback, localParams, }: {
+        paramsFromCallback: ParamsFromCallback;
+        localParams: LocalParams;
+    }) => Promise<TokenSet>;
+    refreshTokens: ({ refreshToken, }: {
+        refreshToken: string;
+    }) => Promise<TokenSet>;
+    getClientCredentialTokens: ({ scope, sub, }: {
+        scope: string;
+        sub: string;
+    }) => Promise<TokenSet>;
+}
+export {};
+//# sourceMappingURL=tokens.d.ts.map

package/dist/types/tokens.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokens.d.ts","sourceRoot":"","sources":["../../types/tokens.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,MAAM,EAAE,QAAQ,EAAC,MAAM,eAAe,CAAA;AAC9C,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,UAAU,CAAA;AAE7C,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,eAAe,CAAA;CACxB;AAED,aAAK,kBAAkB,GAAG,OAAO,CAAC;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;CACd,CAAC,CAAA;AAEF,aAAK,WAAW,GAAG,OAAO,CAAC;IACzB,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,MAAM,CAAA;IACf,aAAa,EAAE,MAAM,CAAA;IACrB,aAAa,EAAE,MAAM,CAAA;CACtB,CAAC,CAAA;AAEF,MAAM,WAAW,cAAc;IAC7B,2BAA2B,EAAE,CAAC,EAC5B,KAAK,EACL,IAAI,EACJ,KAAK,EACL,QAAQ,GACT,EAAE;QACD,KAAK,EAAE,MAAM,CAAA;QACb,IAAI,EAAE,MAAM,CAAA;QACZ,KAAK,EAAE,MAAM,CAAA;QACb,QAAQ,EAAE,MAAM,CAAA;KACjB,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAA;IAEvB,qBAAqB,EAAE,CAAC,EACtB,kBAAkB,EAClB,WAAW,GACZ,EAAE;QACD,kBAAkB,EAAE,kBAAkB,CAAA;QACtC,WAAW,EAAE,WAAW,CAAA;KACzB,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAA;IAEvB,aAAa,EAAE,CAAC,EACd,YAAY,GACb,EAAE;QACD,YAAY,EAAE,MAAM,CAAA;KACrB,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAA;IAEvB,yBAAyB,EAAE,CAAC,EAC1B,KAAK,EACL,GAAG,GACJ,EAAE;QACD,KAAK,EAAE,MAAM,CAAA;QACb,GAAG,EAAE,MAAM,CAAA;KACZ,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAA;CACxB"}

package/dist/types/tokens.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=tokens.js.map

package/dist/types/tokens.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokens.js","sourceRoot":"","sources":["../../types/tokens.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,13 +1,20 @@
 {
   "name": "@mft/moneyhub-api-client",
-  "version": "4.20.0",
+  "version": "5.0.0-2",
   "description": "Node.JS client for the Moneyhub API",
-  "main": "src/index.js",
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
+  "files": [
+    "dist/*"
+  ],
   "scripts": {
     "lint": "eslint src/ examples/",
-    "test": "mocha --config test/opts/integration.json",
-    "test-ci": "mocha --config test/opts/integration-ci.json || true",
-    "prepush": "npm run lint && npm run test"
+    "test": "mocha --require ts-node/register --config test/opts/integration.json",
+    "test-ci": "mocha --require ts-node/register --config test/opts/integration-ci.json || true",
+    "prepush": "npm run lint && npm run test",
+    "prepare": "npm run build",
+    "build": "tsc",
+    "ts-node": "ts-node"
   },
   "keywords": [
     "moneyhub",
@@ -22,13 +29,19 @@
   "license": "ISC",
   "dependencies": {
     "form-data": "^3.0.1",
-    "got": "^11.8.3",
+    "got": "^11.8.5",
     "jose": "^2.0.5",
     "openid-client": "^4.9.1",
+    "query-string": "^7.1.1",
     "ramda": "^0.27.2"
   },
   "devDependencies": {
     "@mft/eslint-config-momentumft": "^4.0.0",
+    "@types/got": "^9.6.12",
+    "@types/openid-client": "^3.7.0",
+    "@types/ramda": "^0.28.13",
+    "@typescript-eslint/eslint-plugin": "^5.26.0",
+    "@typescript-eslint/parser": "^5.26.0",
     "body-parser": "^1.19.2",
     "chai": "^4.3.6",
     "command-line-args": "^5.2.1",
@@ -38,7 +51,9 @@
     "express": "^4.17.3",
     "husky": "^7.0.4",
     "mocha": "^9.2.2",
-    "mocha-junit-reporter": "^2.0.2"
+    "mocha-junit-reporter": "^2.0.2",
+    "ts-node": "^10.8.0",
+    "typescript": "^4.7.2"
   },
   "husky": {
     "hooks": {

package/readme.md

@@ -43,6 +43,18 @@ The breaking changes when upgrading are outlined below:
 
 For the full list of changes please refer to the [changelog](CHANGELOG.md)
 
+### Upgrading from 4.x
+
+The major upgrade from version 4.x is that the library now caters for TypeScript. To allow for this, the factory method that creates the client instance is now a named export rather than a default export.
+
+```js
+// v4.x
+const Moneyhub = require("@mft/moneyhub-api-client")
+
+// v5.x
+const {Moneyhub} = require("@mft/moneyhub-api-client")
+```
+
 ### Changelog
 
 [Learn about the latest improvements and breaking changes](CHANGELOG.md).
@@ -64,7 +76,7 @@ To use this API client you will need:
 This module exposes a single factory function that accepts the following configuration:
 
 ```javascript
-const Moneyhub = require("@mft/moneyhub-api-client")
+const {Moneyhub} = require("@mft/moneyhub-api-client")
 const moneyhub = await Moneyhub({
   resourceServerUrl: "https://api.moneyhub.co.uk/v2.0",
   identityServiceUrl: "https://identity.moneyhub.co.uk",
@@ -317,7 +329,7 @@ const tokens = await moneyhub.requestObject({
 Use this to create a request uri from a request object
 
 ```javascript
-const tokens = await moneyhub.getRequestUri(requestObject);
+const requestUri = await moneyhub.getRequestUri(requestObject);
 ```
 
 #### `getAuthorizeUrlFromRequestUri`
@@ -325,7 +337,7 @@ const tokens = await moneyhub.getRequestUri(requestObject);
 Use this to retrieve an authorization url from a request uri
 
 ```javascript
-const tokens = await moneyhub.getAuthorizeUrlFromRequestUri({
+const url = await moneyhub.getAuthorizeUrlFromRequestUri({
   requestUri: "request-uri",
 });
 ```
@@ -1286,6 +1298,8 @@ This method returns a list of registered payees. This function uses the scope `p
 const payees = await moneyhub.getPayees({
   limit: "limit", // optional
   offset: "offset", // optional
+  userId: "user-id", // optional
+  hasUserId: true, // optional
 });
 ```
 
@@ -1754,6 +1768,14 @@ This method will resolve with a list of all the Test connections that a user can
 const availableConnections = await moneyhub.listTestConnections();
 ```
 
+#### `listBetaConnections`
+
+This method will resolve with a list of all the Beta connections that a user can connect to.
+
+```javascript
+const availableConnections = await moneyhub.listBetaConnections();
+```
+
 ### OpenID Config
 
 #### `getOpenIdConfig`
@@ -1766,8 +1788,39 @@ const availableConnections = await moneyhub.getOpenIdConfig();
 
 ### Examples
 
-We have a couple of examples under the `/examples` folder that can be helpful to start using our client.
+We have a couple of examples under the `/examples` folder that can be helpful to start using our client. To run them, you'll need to use `ts-node`. If you haven't got it globally installed, you can run examples by executing within the library `npm run ts-node -- <script path here> <options>`
 
 ### Running Tests
 
 Instructions on how to run the integration tests for the API client can be found [here](https://www.notion.so/moneyhub/Moneyhub-API-Client-Tests-Config-0bef6e3cb922425b88f0268c1a999917)
+
+### Adding Tests
+
+The tests use root level Mocha hooks to set up and teardown test data. When adding tests please consider the following:
+- The test data IDs is passed via Mocha context to the individual tests. The test data can be found in the `this.config` object
+- To access the context in tests before or after hook ensure you are declaring as regular function instead of arrow function
+- The context cannot be accessed in the `describe` functions, only in the hooks or tests themselves
+- Any new tests added should either try to use the test data setup at beginning of the run
+- If the read only test user has to be used to create data, the test itself should clear up anything created in the after hook
+- Currently the read only test user is used for getting counterparties, holdings, rental records and regular transactions
+
+### Troubleshooting tests
+
+- If any errors occurr during test setup or teardown, this should appear as happening in the "before all" or "after all" hook in `"{root}"` with the error.
+- Errors in the `before all` hook can cause errors in the `after all` hook as it won't be able to find data to clear up.
+
+## TypeScript
+If you wish to use the client library with TypeScript, we allow you to make use of the types that are returned from our methods. Below is an example usage to get started:
+
+```ts
+import {Moneyhub, ApiClientConfig} from "@mft/moneyhub-api-client"
+const config: ApiClientConfig = {} // your config goes here and is strongly typed
+
+const getAccounts = ({userId}) => {
+  const moneyhub = await Moneyhub(config)
+  const accounts = await moneyhub.getAccounts({userId})
+}
+```
+
+The default export is of the Moneyhub constructor that takes in an argument of the config. You can use `ApiClientConfig` to type that config. The client object that is returned from the constructor can then be used to make API calls. The methods are available with arguments and returns typed.
+

package/.eslintrc

@@ -1,9 +0,0 @@
----
-{
-  extends: "./node_modules/@mft/eslint-config-momentumft/index.js",
-  rules: {
-    "camelcase": "off",
-    "comma-dangle": "off",
-  }
-
-}

package/.github/workflows/main.yml

@@ -1,24 +0,0 @@
-name: npm audit
-
-on:
-  pull_request:
-  push:
-    branches:
-  schedule:
-    - cron: '0 10 * * *'
-
-jobs:
-  scan:
-    name: npm audit
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: install dependencies
-        run: npm ci
-      - uses: oke-py/npm-audit-action@v1.8.4
-        with:
-          audit_level: moderate
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          issue_assignees: oke-py
-          issue_labels: vulnerability,test
-          dedupe_issues: true