@mmzaini/starling-sdk 0.1.0

package/dist/generated/api/types/IdentityV2.d.cts

@@ -0,0 +1,12 @@
+export interface IdentityV2 {
+    accountHolderUid?: string | undefined;
+    expiresAt?: string | undefined;
+    expiresInSeconds?: number | undefined;
+    /** The scopes which this token has permission to use e.g. balance:read */
+    scopes?: string[] | undefined;
+    authenticated?: boolean | undefined;
+    applicationUserUid?: string | undefined;
+    consentExpiresAt?: string | undefined;
+    /** Deprecated, use accountHolderUid instead */
+    customerUid?: string | undefined;
+}

package/dist/generated/api/types/IdentityV2.d.ts

@@ -0,0 +1,12 @@
+export interface IdentityV2 {
+    accountHolderUid?: string | undefined;
+    expiresAt?: string | undefined;
+    expiresInSeconds?: number | undefined;
+    /** The scopes which this token has permission to use e.g. balance:read */
+    scopes?: string[] | undefined;
+    authenticated?: boolean | undefined;
+    applicationUserUid?: string | undefined;
+    consentExpiresAt?: string | undefined;
+    /** Deprecated, use accountHolderUid instead */
+    customerUid?: string | undefined;
+}

package/dist/generated/api/types/Individual.d.cts

@@ -0,0 +1,11 @@
+/**
+ * Information about an individual account holder
+ */
+export interface Individual {
+    title?: string | undefined;
+    firstName?: string | undefined;
+    lastName?: string | undefined;
+    dateOfBirth?: string | undefined;
+    email?: string | undefined;
+    phone?: string | undefined;
+}

package/dist/generated/api/types/Individual.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Information about an individual account holder
+ */
+export interface Individual {
+    title?: string | undefined;
+    firstName?: string | undefined;
+    lastName?: string | undefined;
+    dateOfBirth?: string | undefined;
+    email?: string | undefined;
+    phone?: string | undefined;
+}

package/dist/generated/api/types/InstructLocalPaymentResponse.d.cts

@@ -0,0 +1,7 @@
+/**
+ * Response after attempting to create a local payment
+ */
+export interface InstructLocalPaymentResponse {
+    /** The uid of the payment order created by the instruction. N.B. this will not be the uid of any payment which is created by the payment order */
+    paymentOrderUid?: string | undefined;
+}

package/dist/generated/api/types/InstructLocalPaymentResponse.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Response after attempting to create a local payment
+ */
+export interface InstructLocalPaymentResponse {
+    /** The uid of the payment order created by the instruction. N.B. this will not be the uid of any payment which is created by the payment order */
+    paymentOrderUid?: string | undefined;
+}

package/dist/generated/api/types/JointAccount.d.cts

@@ -0,0 +1,9 @@
+import type * as Starling from "../index.cjs";
+/**
+ * Information about a joint account
+ */
+export interface JointAccount {
+    accountHolderUid?: string | undefined;
+    personOne?: Starling.Individual | undefined;
+    personTwo?: Starling.Individual | undefined;
+}

package/dist/generated/api/types/JointAccount.d.ts

@@ -0,0 +1,9 @@
+import type * as Starling from "../index.js";
+/**
+ * Information about a joint account
+ */
+export interface JointAccount {
+    accountHolderUid?: string | undefined;
+    personOne?: Starling.Individual | undefined;
+    personTwo?: Starling.Individual | undefined;
+}

package/dist/generated/api/types/LastPayment.d.cts

@@ -0,0 +1,8 @@
+import type * as Starling from "../index.cjs";
+/**
+ * Last direct debit payment
+ */
+export interface LastPayment {
+    lastDate?: string | undefined;
+    lastAmount?: Starling.CurrencyAndAmount | undefined;
+}

package/dist/generated/api/types/LastPayment.d.ts

@@ -0,0 +1,8 @@
+import type * as Starling from "../index.js";
+/**
+ * Last direct debit payment
+ */
+export interface LastPayment {
+    lastDate?: string | undefined;
+    lastAmount?: Starling.CurrencyAndAmount | undefined;
+}

package/dist/generated/api/types/Links.d.cts

@@ -0,0 +1,9 @@
+/**
+ * HATEOAS pagination links
+ */
+export interface Links {
+    self: string;
+    first: string;
+    prev?: string | undefined;
+    next?: string | undefined;
+}

package/dist/generated/api/types/Links.d.ts

@@ -0,0 +1,9 @@
+/**
+ * HATEOAS pagination links
+ */
+export interface Links {
+    self: string;
+    first: string;
+    prev?: string | undefined;
+    next?: string | undefined;
+}

package/dist/generated/api/types/LocalTime.d.cts

@@ -0,0 +1,6 @@
+export interface LocalTime {
+    hour?: number | undefined;
+    minute?: number | undefined;
+    second?: number | undefined;
+    nano?: number | undefined;
+}

package/dist/generated/api/types/LocalTime.d.ts

@@ -0,0 +1,6 @@
+export interface LocalTime {
+    hour?: number | undefined;
+    minute?: number | undefined;
+    second?: number | undefined;
+    nano?: number | undefined;
+}

package/dist/generated/api/types/MastercardFeedItem.d.cts

@@ -0,0 +1,8 @@
+import type * as Starling from "../index.cjs";
+export interface MastercardFeedItem {
+    merchantIdentifier?: string | undefined;
+    mcc?: number | undefined;
+    posTimestamp?: Starling.LocalTime | undefined;
+    authorisationCode?: string | undefined;
+    cardLast4?: string | undefined;
+}

package/dist/generated/api/types/MastercardFeedItem.d.ts

@@ -0,0 +1,8 @@
+import type * as Starling from "../index.js";
+export interface MastercardFeedItem {
+    merchantIdentifier?: string | undefined;
+    mcc?: number | undefined;
+    posTimestamp?: Starling.LocalTime | undefined;
+    authorisationCode?: string | undefined;
+    cardLast4?: string | undefined;
+}

package/dist/generated/api/types/NextPaymentDatesResponse.d.cts

@@ -0,0 +1,6 @@
+/**
+ * List of next payment dates of a standing order
+ */
+export interface NextPaymentDatesResponse {
+    nextPaymentDates?: string[] | undefined;
+}

package/dist/generated/api/types/NextPaymentDatesResponse.d.ts

@@ -0,0 +1,6 @@
+/**
+ * List of next payment dates of a standing order
+ */
+export interface NextPaymentDatesResponse {
+    nextPaymentDates?: string[] | undefined;
+}

package/dist/generated/api/types/PaginatedFeedItems.d.cts

@@ -0,0 +1,8 @@
+import type * as Starling from "../index.cjs";
+/**
+ * Paginated feed items with HATEOAS links
+ */
+export interface PaginatedFeedItems {
+    feedItems: Starling.FeedItem[];
+    links: Starling.Links;
+}

package/dist/generated/api/types/PaginatedFeedItems.d.ts

@@ -0,0 +1,8 @@
+import type * as Starling from "../index.js";
+/**
+ * Paginated feed items with HATEOAS links
+ */
+export interface PaginatedFeedItems {
+    feedItems: Starling.FeedItem[];
+    links: Starling.Links;
+}

package/dist/generated/api/types/Payee.d.cts

@@ -0,0 +1,34 @@
+import type * as Starling from "../index.cjs";
+/**
+ * A saved payee
+ */
+export interface Payee {
+    /** The uid of this payee */
+    payeeUid: string;
+    /** Name */
+    payeeName: string;
+    /** Phone number */
+    phoneNumber?: string | undefined;
+    /** INDIVIDUAL */
+    payeeType: Payee.PayeeType;
+    /** First name */
+    firstName?: string | undefined;
+    /** Middle name */
+    middleName?: string | undefined;
+    /** Last name */
+    lastName?: string | undefined;
+    /** Business name */
+    businessName?: string | undefined;
+    /** Date of birth */
+    dateOfBirth?: string | undefined;
+    /** Accounts for this payee */
+    accounts?: Starling.PayeeAccount[] | undefined;
+}
+export declare namespace Payee {
+    /** INDIVIDUAL */
+    const PayeeType: {
+        readonly Business: "BUSINESS";
+        readonly Individual: "INDIVIDUAL";
+    };
+    type PayeeType = (typeof PayeeType)[keyof typeof PayeeType];
+}

package/dist/generated/api/types/Payee.d.ts

@@ -0,0 +1,34 @@
+import type * as Starling from "../index.js";
+/**
+ * A saved payee
+ */
+export interface Payee {
+    /** The uid of this payee */
+    payeeUid: string;
+    /** Name */
+    payeeName: string;
+    /** Phone number */
+    phoneNumber?: string | undefined;
+    /** INDIVIDUAL */
+    payeeType: Payee.PayeeType;
+    /** First name */
+    firstName?: string | undefined;
+    /** Middle name */
+    middleName?: string | undefined;
+    /** Last name */
+    lastName?: string | undefined;
+    /** Business name */
+    businessName?: string | undefined;
+    /** Date of birth */
+    dateOfBirth?: string | undefined;
+    /** Accounts for this payee */
+    accounts?: Starling.PayeeAccount[] | undefined;
+}
+export declare namespace Payee {
+    /** INDIVIDUAL */
+    const PayeeType: {
+        readonly Business: "BUSINESS";
+        readonly Individual: "INDIVIDUAL";
+    };
+    type PayeeType = (typeof PayeeType)[keyof typeof PayeeType];
+}

package/dist/generated/api/types/PayeeAccount.d.cts

@@ -0,0 +1,321 @@
+/**
+ * An account of a payee
+ */
+export interface PayeeAccount {
+    /** The uid of this payee account */
+    payeeAccountUid: string;
+    /** The channel through which the payee was added */
+    payeeChannelType: PayeeAccount.PayeeChannelType;
+    /** Account description */
+    description: string;
+    /** Is this the default account for the owning payee */
+    defaultAccount?: boolean | undefined;
+    /** The country code for the account (ISO 3166-1 alpha-2) */
+    countryCode: PayeeAccount.CountryCode;
+    /** The account identifier */
+    accountIdentifier?: string | undefined;
+    /** The bank identifier */
+    bankIdentifier?: string | undefined;
+    /** The bank identifier type */
+    bankIdentifierType?: PayeeAccount.BankIdentifierType | undefined;
+    /** Secondary reference data (SRD), if applicable */
+    secondaryIdentifier?: string | undefined;
+    lastReferences?: string[] | undefined;
+}
+export declare namespace PayeeAccount {
+    /** The channel through which the payee was added */
+    const PayeeChannelType: {
+        readonly BankAccount: "BANK_ACCOUNT";
+        readonly SettleUp: "SETTLE_UP";
+        readonly Nearby: "NEARBY";
+    };
+    type PayeeChannelType = (typeof PayeeChannelType)[keyof typeof PayeeChannelType];
+    /** The country code for the account (ISO 3166-1 alpha-2) */
+    const CountryCode: {
+        readonly Undefined: "UNDEFINED";
+        readonly Ac: "AC";
+        readonly Ad: "AD";
+        readonly Ae: "AE";
+        readonly Af: "AF";
+        readonly Ag: "AG";
+        readonly Ai: "AI";
+        readonly Al: "AL";
+        readonly Am: "AM";
+        readonly An: "AN";
+        readonly Ao: "AO";
+        readonly Aq: "AQ";
+        readonly Ar: "AR";
+        readonly As: "AS";
+        readonly At: "AT";
+        readonly Au: "AU";
+        readonly Aw: "AW";
+        readonly Ax: "AX";
+        readonly Az: "AZ";
+        readonly Ba: "BA";
+        readonly Bb: "BB";
+        readonly Bd: "BD";
+        readonly Be: "BE";
+        readonly Bf: "BF";
+        readonly Bg: "BG";
+        readonly Bh: "BH";
+        readonly Bi: "BI";
+        readonly Bj: "BJ";
+        readonly Bl: "BL";
+        readonly Bm: "BM";
+        readonly Bn: "BN";
+        readonly Bo: "BO";
+        readonly Bq: "BQ";
+        readonly Br: "BR";
+        readonly Bs: "BS";
+        readonly Bt: "BT";
+        readonly Bu: "BU";
+        readonly Bv: "BV";
+        readonly Bw: "BW";
+        readonly By: "BY";
+        readonly Bz: "BZ";
+        readonly Ca: "CA";
+        readonly Cc: "CC";
+        readonly Cd: "CD";
+        readonly Cf: "CF";
+        readonly Cg: "CG";
+        readonly Ch: "CH";
+        readonly Ci: "CI";
+        readonly Ck: "CK";
+        readonly Cl: "CL";
+        readonly Cm: "CM";
+        readonly Cn: "CN";
+        readonly Co: "CO";
+        readonly Cp: "CP";
+        readonly Cr: "CR";
+        readonly Cs: "CS";
+        readonly Cu: "CU";
+        readonly Cv: "CV";
+        readonly Cw: "CW";
+        readonly Cx: "CX";
+        readonly Cy: "CY";
+        readonly Cz: "CZ";
+        readonly De: "DE";
+        readonly Dg: "DG";
+        readonly Dj: "DJ";
+        readonly Dk: "DK";
+        readonly Dm: "DM";
+        readonly Do: "DO";
+        readonly Dz: "DZ";
+        readonly Ea: "EA";
+        readonly Ec: "EC";
+        readonly Ee: "EE";
+        readonly Eg: "EG";
+        readonly Eh: "EH";
+        readonly Er: "ER";
+        readonly Es: "ES";
+        readonly Et: "ET";
+        readonly Eu: "EU";
+        readonly Ez: "EZ";
+        readonly Fi: "FI";
+        readonly Fj: "FJ";
+        readonly Fk: "FK";
+        readonly Fm: "FM";
+        readonly Fo: "FO";
+        readonly Fr: "FR";
+        readonly Fx: "FX";
+        readonly Ga: "GA";
+        readonly Gb: "GB";
+        readonly Gd: "GD";
+        readonly Ge: "GE";
+        readonly Gf: "GF";
+        readonly Gg: "GG";
+        readonly Gh: "GH";
+        readonly Gi: "GI";
+        readonly Gl: "GL";
+        readonly Gm: "GM";
+        readonly Gn: "GN";
+        readonly Gp: "GP";
+        readonly Gq: "GQ";
+        readonly Gr: "GR";
+        readonly Gs: "GS";
+        readonly Gt: "GT";
+        readonly Gu: "GU";
+        readonly Gw: "GW";
+        readonly Gy: "GY";
+        readonly Hk: "HK";
+        readonly Hm: "HM";
+        readonly Hn: "HN";
+        readonly Hr: "HR";
+        readonly Ht: "HT";
+        readonly Hu: "HU";
+        readonly Ic: "IC";
+        readonly Id: "ID";
+        readonly Ie: "IE";
+        readonly Il: "IL";
+        readonly Im: "IM";
+        readonly In: "IN";
+        readonly Io: "IO";
+        readonly Iq: "IQ";
+        readonly Ir: "IR";
+        readonly Is: "IS";
+        readonly It: "IT";
+        readonly Je: "JE";
+        readonly Jm: "JM";
+        readonly Jo: "JO";
+        readonly Jp: "JP";
+        readonly Ke: "KE";
+        readonly Kg: "KG";
+        readonly Kh: "KH";
+        readonly Ki: "KI";
+        readonly Km: "KM";
+        readonly Kn: "KN";
+        readonly Kp: "KP";
+        readonly Kr: "KR";
+        readonly Kw: "KW";
+        readonly Ky: "KY";
+        readonly Kz: "KZ";
+        readonly La: "LA";
+        readonly Lb: "LB";
+        readonly Lc: "LC";
+        readonly Li: "LI";
+        readonly Lk: "LK";
+        readonly Lr: "LR";
+        readonly Ls: "LS";
+        readonly Lt: "LT";
+        readonly Lu: "LU";
+        readonly Lv: "LV";
+        readonly Ly: "LY";
+        readonly Ma: "MA";
+        readonly Mc: "MC";
+        readonly Md: "MD";
+        readonly Me: "ME";
+        readonly Mf: "MF";
+        readonly Mg: "MG";
+        readonly Mh: "MH";
+        readonly Mk: "MK";
+        readonly Ml: "ML";
+        readonly Mm: "MM";
+        readonly Mn: "MN";
+        readonly Mo: "MO";
+        readonly Mp: "MP";
+        readonly Mq: "MQ";
+        readonly Mr: "MR";
+        readonly Ms: "MS";
+        readonly Mt: "MT";
+        readonly Mu: "MU";
+        readonly Mv: "MV";
+        readonly Mw: "MW";
+        readonly Mx: "MX";
+        readonly My: "MY";
+        readonly Mz: "MZ";
+        readonly Na: "NA";
+        readonly Nc: "NC";
+        readonly Ne: "NE";
+        readonly Nf: "NF";
+        readonly Ng: "NG";
+        readonly Ni: "NI";
+        readonly Nl: "NL";
+        readonly No: "NO";
+        readonly Np: "NP";
+        readonly Nr: "NR";
+        readonly Nt: "NT";
+        readonly Nu: "NU";
+        readonly Nz: "NZ";
+        readonly Om: "OM";
+        readonly Pa: "PA";
+        readonly Pe: "PE";
+        readonly Pf: "PF";
+        readonly Pg: "PG";
+        readonly Ph: "PH";
+        readonly Pk: "PK";
+        readonly Pl: "PL";
+        readonly Pm: "PM";
+        readonly Pn: "PN";
+        readonly Pr: "PR";
+        readonly Ps: "PS";
+        readonly Pt: "PT";
+        readonly Pw: "PW";
+        readonly Py: "PY";
+        readonly Qa: "QA";
+        readonly Re: "RE";
+        readonly Ro: "RO";
+        readonly Rs: "RS";
+        readonly Ru: "RU";
+        readonly Rw: "RW";
+        readonly Sa: "SA";
+        readonly Sb: "SB";
+        readonly Sc: "SC";
+        readonly Sd: "SD";
+        readonly Se: "SE";
+        readonly Sf: "SF";
+        readonly Sg: "SG";
+        readonly Sh: "SH";
+        readonly Si: "SI";
+        readonly Sj: "SJ";
+        readonly Sk: "SK";
+        readonly Sl: "SL";
+        readonly Sm: "SM";
+        readonly Sn: "SN";
+        readonly So: "SO";
+        readonly Sr: "SR";
+        readonly Ss: "SS";
+        readonly St: "ST";
+        readonly Su: "SU";
+        readonly Sv: "SV";
+        readonly Sx: "SX";
+        readonly Sy: "SY";
+        readonly Sz: "SZ";
+        readonly Ta: "TA";
+        readonly Tc: "TC";
+        readonly Td: "TD";
+        readonly Tf: "TF";
+        readonly Tg: "TG";
+        readonly Th: "TH";
+        readonly Tj: "TJ";
+        readonly Tk: "TK";
+        readonly Tl: "TL";
+        readonly Tm: "TM";
+        readonly Tn: "TN";
+        readonly To: "TO";
+        readonly Tp: "TP";
+        readonly Tr: "TR";
+        readonly Tt: "TT";
+        readonly Tv: "TV";
+        readonly Tw: "TW";
+        readonly Tz: "TZ";
+        readonly Ua: "UA";
+        readonly Ug: "UG";
+        readonly Uk: "UK";
+        readonly Um: "UM";
+        readonly Us: "US";
+        readonly Uy: "UY";
+        readonly Uz: "UZ";
+        readonly Va: "VA";
+        readonly Vc: "VC";
+        readonly Ve: "VE";
+        readonly Vg: "VG";
+        readonly Vi: "VI";
+        readonly Vn: "VN";
+        readonly Vu: "VU";
+        readonly Wf: "WF";
+        readonly Ws: "WS";
+        readonly Xi: "XI";
+        readonly Xu: "XU";
+        readonly Xk: "XK";
+        readonly Xx: "XX";
+        readonly Ye: "YE";
+        readonly Yt: "YT";
+        readonly Yu: "YU";
+        readonly Za: "ZA";
+        readonly Zm: "ZM";
+        readonly Zr: "ZR";
+        readonly Zw: "ZW";
+    };
+    type CountryCode = (typeof CountryCode)[keyof typeof CountryCode];
+    /** The bank identifier type */
+    const BankIdentifierType: {
+        readonly SortCode: "SORT_CODE";
+        readonly Swift: "SWIFT";
+        readonly Iban: "IBAN";
+        readonly Aba: "ABA";
+        readonly AbaWire: "ABA_WIRE";
+        readonly AbaAch: "ABA_ACH";
+        readonly Bsb: "BSB";
+    };
+    type BankIdentifierType = (typeof BankIdentifierType)[keyof typeof BankIdentifierType];
+}