@mmzaini/starling-sdk 0.1.0

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

@@ -0,0 +1,13 @@
+import type * as Starling from "../index.cjs";
+/**
+ * Balance details
+ */
+export interface BalanceV2 {
+    clearedBalance?: Starling.SignedCurrencyAndAmount | undefined;
+    effectiveBalance?: Starling.SignedCurrencyAndAmount | undefined;
+    pendingTransactions?: Starling.SignedCurrencyAndAmount | undefined;
+    acceptedOverdraft?: Starling.SignedCurrencyAndAmount | undefined;
+    amount?: Starling.SignedCurrencyAndAmount | undefined;
+    totalClearedBalance?: Starling.SignedCurrencyAndAmount | undefined;
+    totalEffectiveBalance?: Starling.SignedCurrencyAndAmount | undefined;
+}

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

@@ -0,0 +1,13 @@
+import type * as Starling from "../index.js";
+/**
+ * Balance details
+ */
+export interface BalanceV2 {
+    clearedBalance?: Starling.SignedCurrencyAndAmount | undefined;
+    effectiveBalance?: Starling.SignedCurrencyAndAmount | undefined;
+    pendingTransactions?: Starling.SignedCurrencyAndAmount | undefined;
+    acceptedOverdraft?: Starling.SignedCurrencyAndAmount | undefined;
+    amount?: Starling.SignedCurrencyAndAmount | undefined;
+    totalClearedBalance?: Starling.SignedCurrencyAndAmount | undefined;
+    totalEffectiveBalance?: Starling.SignedCurrencyAndAmount | undefined;
+}

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

@@ -0,0 +1,16 @@
+/**
+ * The details of the batch payment this is part of, if it is
+ */
+export interface BatchPaymentDetails {
+    /** The unique identifier for the batch payment */
+    batchPaymentUid?: string | undefined;
+    /** The type of the batch payment itself */
+    batchPaymentType?: BatchPaymentDetails.BatchPaymentType | undefined;
+}
+export declare namespace BatchPaymentDetails {
+    /** The type of the batch payment itself */
+    const BatchPaymentType: {
+        readonly BulkPayment: "BULK_PAYMENT";
+    };
+    type BatchPaymentType = (typeof BatchPaymentType)[keyof typeof BatchPaymentType];
+}

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

@@ -0,0 +1,16 @@
+/**
+ * The details of the batch payment this is part of, if it is
+ */
+export interface BatchPaymentDetails {
+    /** The unique identifier for the batch payment */
+    batchPaymentUid?: string | undefined;
+    /** The type of the batch payment itself */
+    batchPaymentType?: BatchPaymentDetails.BatchPaymentType | undefined;
+}
+export declare namespace BatchPaymentDetails {
+    /** The type of the batch payment itself */
+    const BatchPaymentType: {
+        readonly BulkPayment: "BULK_PAYMENT";
+    };
+    type BatchPaymentType = (typeof BatchPaymentType)[keyof typeof BatchPaymentType];
+}

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

@@ -0,0 +1,12 @@
+/**
+ * Details of a business account holder
+ */
+export interface Business {
+    companyName?: string | undefined;
+    companyType?: string | undefined;
+    companyCategory?: string | undefined;
+    companySubCategory?: string | undefined;
+    companyRegistrationNumber?: string | undefined;
+    email?: string | undefined;
+    phone?: string | undefined;
+}

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

@@ -0,0 +1,12 @@
+/**
+ * Details of a business account holder
+ */
+export interface Business {
+    companyName?: string | undefined;
+    companyType?: string | undefined;
+    companyCategory?: string | undefined;
+    companySubCategory?: string | undefined;
+    companyRegistrationNumber?: string | undefined;
+    email?: string | undefined;
+    phone?: string | undefined;
+}

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

@@ -0,0 +1,23 @@
+import type * as Starling from "../index.cjs";
+/**
+ * Information about card
+ */
+export interface Card {
+    cardUid: string;
+    publicToken: string;
+    enabled: boolean;
+    walletNotificationEnabled: boolean;
+    posEnabled: boolean;
+    atmEnabled: boolean;
+    onlineEnabled: boolean;
+    mobileWalletEnabled: boolean;
+    gamblingEnabled: boolean;
+    magStripeEnabled: boolean;
+    cancelled: boolean;
+    activationRequested: boolean;
+    activated: boolean;
+    endOfCardNumber: string;
+    currencyFlags: Starling.CurrencyFlag[];
+    cardAssociationUid: string;
+    gamblingToBeEnabledAt?: string | undefined;
+}

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

@@ -0,0 +1,23 @@
+import type * as Starling from "../index.js";
+/**
+ * Information about card
+ */
+export interface Card {
+    cardUid: string;
+    publicToken: string;
+    enabled: boolean;
+    walletNotificationEnabled: boolean;
+    posEnabled: boolean;
+    atmEnabled: boolean;
+    onlineEnabled: boolean;
+    mobileWalletEnabled: boolean;
+    gamblingEnabled: boolean;
+    magStripeEnabled: boolean;
+    cancelled: boolean;
+    activationRequested: boolean;
+    activated: boolean;
+    endOfCardNumber: string;
+    currencyFlags: Starling.CurrencyFlag[];
+    cardAssociationUid: string;
+    gamblingToBeEnabledAt?: string | undefined;
+}

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

@@ -0,0 +1,7 @@
+import type * as Starling from "../index.cjs";
+/**
+ * Wrapper around multiple cards
+ */
+export interface Cards {
+    cards: Starling.Card[];
+}

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

@@ -0,0 +1,7 @@
+import type * as Starling from "../index.js";
+/**
+ * Wrapper around multiple cards
+ */
+export interface Cards {
+    cards: Starling.Card[];
+}

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

@@ -0,0 +1,9 @@
+/**
+ * Response object contain category description
+ */
+export interface CategoryDescription {
+    /** Locale */
+    locale?: string | undefined;
+    /** Display text */
+    displayText?: string | undefined;
+}

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

@@ -0,0 +1,9 @@
+/**
+ * Response object contain category description
+ */
+export interface CategoryDescription {
+    /** Locale */
+    locale?: string | undefined;
+    /** Display text */
+    displayText?: string | undefined;
+}

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

@@ -0,0 +1,6 @@
+export interface ConfirmationOfFundsResponse {
+    /** True if requested amount is available to spend */
+    requestedAmountAvailableToSpend?: boolean | undefined;
+    /** True if spending the requested amount would put the account in overdraft */
+    accountWouldBeInOverdraftIfRequestedAmountSpent?: boolean | undefined;
+}

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

@@ -0,0 +1,6 @@
+export interface ConfirmationOfFundsResponse {
+    /** True if requested amount is available to spend */
+    requestedAmountAvailableToSpend?: boolean | undefined;
+    /** True if spending the requested amount would put the account in overdraft */
+    accountWouldBeInOverdraftIfRequestedAmountSpent?: boolean | undefined;
+}

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

@@ -0,0 +1,4 @@
+/**
+ * Denotes whether a request has been paused in order for the user to approve it.
+ */
+export type ConsentInformation = Record<string, unknown>;

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

@@ -0,0 +1,4 @@
+/**
+ * Denotes whether a request has been paused in order for the user to approve it.
+ */
+export type ConsentInformation = Record<string, unknown>;

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

@@ -0,0 +1,9 @@
+/**
+ * Response after attempting to create a savings goal
+ */
+export interface CreateOrUpdateSavingsGoalResponseV2 {
+    /** Unique identifier of the savings goal */
+    savingsGoalUid?: string | undefined;
+    /** True if the method completed successfully */
+    success?: boolean | undefined;
+}

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

@@ -0,0 +1,9 @@
+/**
+ * Response after attempting to create a savings goal
+ */
+export interface CreateOrUpdateSavingsGoalResponseV2 {
+    /** Unique identifier of the savings goal */
+    savingsGoalUid?: string | undefined;
+    /** True if the method completed successfully */
+    success?: boolean | undefined;
+}

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

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

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

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

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

@@ -0,0 +1,9 @@
+/**
+ * Representation of money
+ */
+export interface CurrencyAndAmount {
+    /** ISO-4217 3 character currency code */
+    currency: string;
+    /** Amount in the minor units of the given currency; eg pence in GBP, cents in EUR */
+    minorUnits: number;
+}

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

@@ -0,0 +1,9 @@
+/**
+ * Representation of money
+ */
+export interface CurrencyAndAmount {
+    /** ISO-4217 3 character currency code */
+    currency: string;
+    /** Amount in the minor units of the given currency; eg pence in GBP, cents in EUR */
+    minorUnits: number;
+}

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

@@ -0,0 +1,7 @@
+/**
+ * Whether spending is enabled on this card for the specified currency
+ */
+export interface CurrencyFlag {
+    enabled: boolean;
+    currency: string;
+}

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

@@ -0,0 +1,7 @@
+/**
+ * Whether spending is enabled on this card for the specified currency
+ */
+export interface CurrencyFlag {
+    enabled: boolean;
+    currency: string;
+}

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

@@ -0,0 +1,33 @@
+import type * as Starling from "../index.cjs";
+/**
+ * Single mandate
+ */
+export interface DirectDebitMandateV2 {
+    uid?: string | undefined;
+    reference?: string | undefined;
+    status?: DirectDebitMandateV2.Status | undefined;
+    source?: DirectDebitMandateV2.Source | undefined;
+    created?: string | undefined;
+    cancelled?: string | undefined;
+    nextDate?: string | undefined;
+    lastDate?: string | undefined;
+    originatorName?: string | undefined;
+    originatorUid?: string | undefined;
+    merchantUid?: string | undefined;
+    lastPayment?: (Starling.LastPayment | null) | undefined;
+    accountUid?: string | undefined;
+    categoryUid?: string | undefined;
+}
+export declare namespace DirectDebitMandateV2 {
+    const Status: {
+        readonly Cancelled: "CANCELLED";
+        readonly Live: "LIVE";
+        readonly PendingCas: "PENDING_CAS";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+    const Source: {
+        readonly Electronic: "ELECTRONIC";
+        readonly Paper: "PAPER";
+    };
+    type Source = (typeof Source)[keyof typeof Source];
+}

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

@@ -0,0 +1,33 @@
+import type * as Starling from "../index.js";
+/**
+ * Single mandate
+ */
+export interface DirectDebitMandateV2 {
+    uid?: string | undefined;
+    reference?: string | undefined;
+    status?: DirectDebitMandateV2.Status | undefined;
+    source?: DirectDebitMandateV2.Source | undefined;
+    created?: string | undefined;
+    cancelled?: string | undefined;
+    nextDate?: string | undefined;
+    lastDate?: string | undefined;
+    originatorName?: string | undefined;
+    originatorUid?: string | undefined;
+    merchantUid?: string | undefined;
+    lastPayment?: (Starling.LastPayment | null) | undefined;
+    accountUid?: string | undefined;
+    categoryUid?: string | undefined;
+}
+export declare namespace DirectDebitMandateV2 {
+    const Status: {
+        readonly Cancelled: "CANCELLED";
+        readonly Live: "LIVE";
+        readonly PendingCas: "PENDING_CAS";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+    const Source: {
+        readonly Electronic: "ELECTRONIC";
+        readonly Paper: "PAPER";
+    };
+    type Source = (typeof Source)[keyof typeof Source];
+}

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

@@ -0,0 +1,7 @@
+import type * as Starling from "../index.cjs";
+/**
+ * List of mandates
+ */
+export interface DirectDebitMandatesV2 {
+    mandates?: Starling.DirectDebitMandateV2[] | undefined;
+}

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

@@ -0,0 +1,7 @@
+import type * as Starling from "../index.js";
+/**
+ * List of mandates
+ */
+export interface DirectDebitMandatesV2 {
+    mandates?: Starling.DirectDebitMandateV2[] | undefined;
+}

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

@@ -0,0 +1,9 @@
+import type * as Starling from "../index.cjs";
+/**
+ * A previous Direct Debit payment
+ */
+export interface DirectDebitPayment {
+    paymentAmount?: Starling.CurrencyAndAmount | undefined;
+    /** Date when direct debit payment was created */
+    createdAt?: string | undefined;
+}

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

@@ -0,0 +1,9 @@
+import type * as Starling from "../index.js";
+/**
+ * A previous Direct Debit payment
+ */
+export interface DirectDebitPayment {
+    paymentAmount?: Starling.CurrencyAndAmount | undefined;
+    /** Date when direct debit payment was created */
+    createdAt?: string | undefined;
+}

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

@@ -0,0 +1,8 @@
+import type * as Starling from "../index.cjs";
+/**
+ * Transaction history for a direct debit
+ */
+export interface DirectDebitPaymentsResponse {
+    /** List of processed direct debit mandate payments */
+    directDebitPayments: Starling.DirectDebitPayment[];
+}

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

@@ -0,0 +1,8 @@
+import type * as Starling from "../index.js";
+/**
+ * Transaction history for a direct debit
+ */
+export interface DirectDebitPaymentsResponse {
+    /** List of processed direct debit mandate payments */
+    directDebitPayments: Starling.DirectDebitPayment[];
+}

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

@@ -0,0 +1,3 @@
+export interface Enabling {
+    enabled: boolean;
+}

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

@@ -0,0 +1,3 @@
+export interface Enabling {
+    enabled: boolean;
+}

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

@@ -0,0 +1,7 @@
+/**
+ * Detail of the error
+ */
+export interface ErrorDetail {
+    /** The error message */
+    message?: string | undefined;
+}

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

@@ -0,0 +1,7 @@
+/**
+ * Detail of the error
+ */
+export interface ErrorDetail {
+    /** The error message */
+    message?: string | undefined;
+}

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

@@ -0,0 +1,8 @@
+import type * as Starling from "../index.cjs";
+/**
+ * Erroneous response wrapper
+ */
+export interface ErrorResponse {
+    errors?: Starling.ErrorDetail[] | undefined;
+    success?: boolean | undefined;
+}

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

@@ -0,0 +1,8 @@
+import type * as Starling from "../index.js";
+/**
+ * Erroneous response wrapper
+ */
+export interface ErrorResponse {
+    errors?: Starling.ErrorDetail[] | undefined;
+    success?: boolean | undefined;
+}