@mmzaini/starling-sdk 0.1.0

package/dist/generated/api/resources/payees/client/requests/ListScheduledPaymentsPayeesRequest.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @example
+ *     {
+ *         payeeUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+ *         accountUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa"
+ *     }
+ */
+export interface ListScheduledPaymentsPayeesRequest {
+    /** Unique identifier of the payee */
+    payeeUid: string;
+    /** Unique identifier of the payee account */
+    accountUid: string;
+}

package/dist/generated/api/resources/payees/client/requests/UpdatePayeesRequest.d.cts

@@ -0,0 +1,30 @@
+import type * as Starling from "../../../../index.cjs";
+/**
+ * @example
+ *     {
+ *         payeeUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+ *         payeeName: "Bob Bobbington",
+ *         payeeType: "BUSINESS"
+ *     }
+ */
+export interface UpdatePayeesRequest {
+    /** Unique identifier of the payee */
+    payeeUid: string;
+    /** Name */
+    payeeName: string;
+    /** Phone number */
+    phoneNumber?: string;
+    payeeType: Starling.PayeeCreationRequest.PayeeType;
+    /** First name */
+    firstName?: string;
+    /** Middle name */
+    middleName?: string;
+    /** Last name */
+    lastName?: string;
+    /** Business name */
+    businessName?: string;
+    /** Date of birth for this payee */
+    dateOfBirth?: string;
+    /** List of accounts for this payee */
+    accounts?: Starling.PayeeAccountCreationRequest[];
+}

package/dist/generated/api/resources/payees/client/requests/UpdatePayeesRequest.d.ts

@@ -0,0 +1,30 @@
+import type * as Starling from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         payeeUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+ *         payeeName: "Bob Bobbington",
+ *         payeeType: "BUSINESS"
+ *     }
+ */
+export interface UpdatePayeesRequest {
+    /** Unique identifier of the payee */
+    payeeUid: string;
+    /** Name */
+    payeeName: string;
+    /** Phone number */
+    phoneNumber?: string;
+    payeeType: Starling.PayeeCreationRequest.PayeeType;
+    /** First name */
+    firstName?: string;
+    /** Middle name */
+    middleName?: string;
+    /** Last name */
+    lastName?: string;
+    /** Business name */
+    businessName?: string;
+    /** Date of birth for this payee */
+    dateOfBirth?: string;
+    /** List of accounts for this payee */
+    accounts?: Starling.PayeeAccountCreationRequest[];
+}

package/dist/generated/api/resources/payees/client/requests/index.d.cts

@@ -0,0 +1,8 @@
+export type { AddAccountPayeesRequest } from "./AddAccountPayeesRequest.cjs";
+export type { DeleteAccountPayeesRequest } from "./DeleteAccountPayeesRequest.cjs";
+export type { DeletePayeesRequest } from "./DeletePayeesRequest.cjs";
+export type { DownloadImagePayeesRequest } from "./DownloadImagePayeesRequest.cjs";
+export type { GetPayeesRequest } from "./GetPayeesRequest.cjs";
+export type { ListPaymentsPayeesRequest } from "./ListPaymentsPayeesRequest.cjs";
+export type { ListScheduledPaymentsPayeesRequest } from "./ListScheduledPaymentsPayeesRequest.cjs";
+export type { UpdatePayeesRequest } from "./UpdatePayeesRequest.cjs";

package/dist/generated/api/resources/payees/client/requests/index.d.ts

@@ -0,0 +1,8 @@
+export type { AddAccountPayeesRequest } from "./AddAccountPayeesRequest.js";
+export type { DeleteAccountPayeesRequest } from "./DeleteAccountPayeesRequest.js";
+export type { DeletePayeesRequest } from "./DeletePayeesRequest.js";
+export type { DownloadImagePayeesRequest } from "./DownloadImagePayeesRequest.js";
+export type { GetPayeesRequest } from "./GetPayeesRequest.js";
+export type { ListPaymentsPayeesRequest } from "./ListPaymentsPayeesRequest.js";
+export type { ListScheduledPaymentsPayeesRequest } from "./ListScheduledPaymentsPayeesRequest.js";
+export type { UpdatePayeesRequest } from "./UpdatePayeesRequest.js";

package/dist/generated/api/resources/payees/exports.d.cts

@@ -0,0 +1,2 @@
+export { PayeesClient } from "./client/Client.cjs";
+export * from "./client/index.cjs";

package/dist/generated/api/resources/payees/exports.d.ts

@@ -0,0 +1,2 @@
+export { PayeesClient } from "./client/Client.js";
+export * from "./client/index.js";

package/dist/generated/api/resources/payees/index.d.cts

@@ -0,0 +1 @@
+export * from "./client/index.cjs";

package/dist/generated/api/resources/payees/index.d.ts

@@ -0,0 +1 @@
+export * from "./client/index.js";

package/dist/generated/api/resources/payments/client/Client.d.cts

@@ -0,0 +1,251 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.cjs";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.cjs";
+import * as core from "../../../../core/index.cjs";
+import type * as Starling from "../../../index.cjs";
+export declare namespace PaymentsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class PaymentsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<PaymentsClient.Options>;
+    constructor(options?: PaymentsClient.Options);
+    /**
+     * Categories are subdivisions of an account.
+     * The default category holds the main balance and transactions. Savings goals and spending spaces are examples of other categories. You can use [`/api/v2/accounts`](#operations-tag-Accounts) to get the default category UID for an account.
+     *
+     * If `startDate` is null, the standing order is awaiting review and has not yet been approved.
+     *
+     * If `cancelledAt` is non-null, the standing order has been cancelled, either by the customer, or as a result of the payment review.
+     *
+     * Required scopes (any): standing-order:read, standing-order-own:read.
+     *
+     * @param {Starling.GetStandingOrderPaymentsRequest} request
+     * @param {PaymentsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link errors.StarlingError}
+     * @throws {@link errors.StarlingTimeoutError}
+     *
+     * @example
+     *     await client.payments.getStandingOrder({
+     *         accountUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+     *         categoryUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+     *         paymentOrderUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa"
+     *     })
+     */
+    getStandingOrder(request: Starling.GetStandingOrderPaymentsRequest, requestOptions?: PaymentsClient.RequestOptions): core.HttpResponsePromise<Starling.StandingOrder>;
+    private __getStandingOrder;
+    /**
+     * Categories are subdivisions of an account.
+     * The default category holds the main balance and transactions. Savings goals and spending spaces are examples of other categories. You can use [`/api/v2/accounts`](#operations-tag-Accounts) to get the default category UID for an account.
+     *
+     * Possible 400 (Bad Request) errors include:
+     *  * `CANNOT_MAKE_REQUESTED_CHANGE`: you cannot make this change to this standing order. You can create a new standing order instead.
+     * * `CANNOT_UPDATE_CANCELLED_PAYMENT_ORDER`: you cannot update this standing order because it has been cancelled.
+     * * `CANNOT_UPDATE_PENDING_PAYMENT_ORDER`: you cannot update this standing order at this time because it is pending. This can happen if the original standing order is awaiting review. In this case, `GET /api/v2/payments/local/account/{accountUid}/category/{categoryUid}/standing-orders/{paymentOrderUid}` will return a null `startDate`.
+     *
+     * Required scopes (any): standing-order:create. Requires request signing.
+     *
+     * @param {Starling.UpdateStandingOrderRequest} request
+     * @param {PaymentsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link errors.StarlingError}
+     * @throws {@link errors.StarlingTimeoutError}
+     *
+     * @example
+     *     await client.payments.updateStandingOrder({
+     *         accountUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+     *         categoryUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+     *         paymentOrderUidPathParam: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+     *         paymentOrderUid: "33443344-3344-3344-3344-334433443344",
+     *         reference: "Payment reference",
+     *         amount: {
+     *             currency: "GBP",
+     *             minorUnits: 123456
+     *         },
+     *         standingOrderRecurrence: {
+     *             startDate: "2019-09-23",
+     *             frequency: "DAILY"
+     *         }
+     *     })
+     */
+    updateStandingOrder(request: Starling.UpdateStandingOrderRequest, requestOptions?: PaymentsClient.RequestOptions): core.HttpResponsePromise<Starling.UpdateStandingOrderResponse>;
+    private __updateStandingOrder;
+    /**
+     * Categories are subdivisions of an account.
+     * The default category holds the main balance and transactions. Savings goals and spending spaces are examples of other categories. You can use [`/api/v2/accounts`](#operations-tag-Accounts) to get the default category UID for an account.
+     *
+     * Possible 400 (Bad Request) errors include:
+     *  * `CANNOT_CANCEL_PENDING_PAYMENT_ORDER`: you cannot cancel this standing order at this time because it is pending. This can happen if the original standing order is awaiting review. In this case, `GET /api/v2/payments/local/account/{accountUid}/category/{categoryUid}/standing-orders/{paymentOrderUid}` returns a null `startDate`.
+     *
+     * Required scopes (any): standing-order:delete. Requires request signing.
+     *
+     * @param {Starling.CancelStandingOrderPaymentsRequest} request
+     * @param {PaymentsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link errors.StarlingError}
+     * @throws {@link errors.StarlingTimeoutError}
+     *
+     * @example
+     *     await client.payments.cancelStandingOrder({
+     *         accountUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+     *         categoryUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+     *         paymentOrderUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa"
+     *     })
+     */
+    cancelStandingOrder(request: Starling.CancelStandingOrderPaymentsRequest, requestOptions?: PaymentsClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __cancelStandingOrder;
+    /**
+     * Categories are subdivisions of an account.
+     * The default category holds the main balance and transactions. Savings goals and spending spaces are examples of other categories. You can use [`/api/v2/accounts`](#operations-tag-Accounts) to get the default category UID for an account.
+     *
+     * Standing orders that are awaiting review are omitted from the list.
+     *
+     * Required scopes (any): standing-order:read, standing-order-own:read.
+     *
+     * @param {Starling.ListStandingOrdersPaymentsRequest} request
+     * @param {PaymentsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link errors.StarlingError}
+     * @throws {@link errors.StarlingTimeoutError}
+     *
+     * @example
+     *     await client.payments.listStandingOrders({
+     *         accountUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+     *         categoryUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa"
+     *     })
+     */
+    listStandingOrders(request: Starling.ListStandingOrdersPaymentsRequest, requestOptions?: PaymentsClient.RequestOptions): core.HttpResponsePromise<Starling.StandingOrdersResponse>;
+    private __listStandingOrders;
+    /**
+     * Categories are subdivisions of an account.
+     * The default category holds the main balance and transactions. Savings goals and spending spaces are examples of other categories. You can use [`/api/v2/accounts`](#operations-tag-Accounts) to get the default category UID for an account.
+     *
+     * The recipient of the standing order must either be defined in the `paymentRecipient` field in the request body  or be an existing payee of the account holder (you can create a new payee using `/api/v2/payees`).
+     *
+     * `externalIdentifier` is a unique identifier for the standing order request, and is generated by you. To ensure idempotency, this must be unique for each standing order request you create.
+     *
+     * Note that the standing order may not be created immediately if we need to review the request. In that case, the request may remain in a `PENDING` state for a while (possibly for a few hours).
+     *
+     * Required scopes (any): standing-order:create. Requires request signing.
+     *
+     * @param {Starling.CreateStandingOrderRequest} request
+     * @param {PaymentsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link errors.StarlingError}
+     * @throws {@link errors.StarlingTimeoutError}
+     *
+     * @example
+     *     await client.payments.createStandingOrder({
+     *         accountUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+     *         categoryUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+     *         externalIdentifier: "a unique identifier to ensure idempotency",
+     *         reference: "Monthly Expenses",
+     *         amount: {
+     *             currency: "GBP",
+     *             minorUnits: 123456
+     *         },
+     *         standingOrderRecurrence: {
+     *             startDate: "2019-09-23",
+     *             frequency: "DAILY"
+     *         }
+     *     })
+     */
+    createStandingOrder(request: Starling.CreateStandingOrderRequest, requestOptions?: PaymentsClient.RequestOptions): core.HttpResponsePromise<Starling.CreateStandingOrderResponse>;
+    private __createStandingOrder;
+    /**
+     *
+     *
+     * Required scopes (any): pay-local:read.
+     *
+     * @param {Starling.GetOrderPaymentsRequest} request
+     * @param {PaymentsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link errors.StarlingError}
+     * @throws {@link errors.StarlingTimeoutError}
+     *
+     * @example
+     *     await client.payments.getOrder({
+     *         paymentOrderUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa"
+     *     })
+     */
+    getOrder(request: Starling.GetOrderPaymentsRequest, requestOptions?: PaymentsClient.RequestOptions): core.HttpResponsePromise<Starling.PaymentOrderV2>;
+    private __getOrder;
+    /**
+     * Note that a payment associated with a payment order may be pending (`paymentStatusDetails.paymentStatus = PENDING`)  or rejected (`paymentStatusDetails.paymentStatus = REJECTED`).
+     *
+     * Required scopes (any): pay-local:read.
+     *
+     * @param {Starling.ListOrderPaymentsPaymentsRequest} request
+     * @param {PaymentsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link errors.StarlingError}
+     * @throws {@link errors.StarlingTimeoutError}
+     *
+     * @example
+     *     await client.payments.listOrderPayments({
+     *         paymentOrderUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa"
+     *     })
+     */
+    listOrderPayments(request: Starling.ListOrderPaymentsPaymentsRequest, requestOptions?: PaymentsClient.RequestOptions): core.HttpResponsePromise<Starling.PaymentOrderPaymentsResponse>;
+    private __listOrderPayments;
+    /**
+     * Categories are subdivisions of an account.
+     * The default category holds the main balance and transactions. Savings goals and spending spaces are examples of other categories. You can use [`/api/v2/accounts`](#operations-tag-Accounts) to get the default category UID for an account.
+     *
+     * If you only want the next payment date, you can also get this from the `nextDate` returned by `GET /api/v2/payments/local/account/{accountUid}/category/{categoryUid}/standing-orders/{paymentOrderUid}`.
+     *
+     * If `nextPaymentDates` is empty for a standing order, the standing order may be awaiting review, or may have been cancelled. Or it may have been a one-off standing order: in this case, `nextDate` will be null too.
+     *
+     * Required scopes (any): standing-order:read.
+     *
+     * @param {Starling.ListUpcomingDatesPaymentsRequest} request
+     * @param {PaymentsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link errors.StarlingError}
+     * @throws {@link errors.StarlingTimeoutError}
+     *
+     * @example
+     *     await client.payments.listUpcomingDates({
+     *         accountUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+     *         categoryUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+     *         paymentOrderUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa"
+     *     })
+     */
+    listUpcomingDates(request: Starling.ListUpcomingDatesPaymentsRequest, requestOptions?: PaymentsClient.RequestOptions): core.HttpResponsePromise<Starling.NextPaymentDatesResponse>;
+    private __listUpcomingDates;
+    /**
+     * Creates and sends an immediate payment within the UK under the Faster Payments Scheme or via SEPA for payments between Euro accounts.
+     *
+     * Categories are subdivisions of an account.
+     * The default category holds the main balance and transactions. Savings goals and spending spaces are examples of other categories. You can use [`/api/v2/accounts`](#operations-tag-Accounts) to get the default category UID for an account.
+     *
+     * The recipient of the payment must either be defined in the `paymentRecipient` field in the request body  or be an existing payee of the account holder (you can create a new payee using `/api/v2/payees`).For payments made using a Personal Access Token, the recipient must be an existing payee defined in the `destinationPayeeAccountUid` field.
+     *
+     * `externalIdentifier` is a unique identifier for the payment request, and is generated by you. To ensure idempotency, this must be unique for each payment request you create.
+     *
+     * Note that the payment may not take place immediately if we need to review the payment request. In that case, the payment may remain in a `PENDING` state for a while (possibly for a few hours).
+     *
+     * Required scopes (any): pay-local:create, pay-local-once:create. Requires request signing.
+     *
+     * @param {Starling.InstructLocalPaymentRequest} request
+     * @param {PaymentsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link errors.StarlingError}
+     * @throws {@link errors.StarlingTimeoutError}
+     *
+     * @example
+     *     await client.payments.create({
+     *         accountUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+     *         categoryUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+     *         externalIdentifier: "Unique identifier to ensure idempotency",
+     *         reference: "December Expenses",
+     *         amount: {
+     *             currency: "GBP",
+     *             minorUnits: 123456
+     *         }
+     *     })
+     */
+    create(request: Starling.InstructLocalPaymentRequest, requestOptions?: PaymentsClient.RequestOptions): core.HttpResponsePromise<Starling.InstructLocalPaymentResponse>;
+    private __create;
+}

package/dist/generated/api/resources/payments/client/Client.d.ts

@@ -0,0 +1,251 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import type * as Starling from "../../../index.js";
+export declare namespace PaymentsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class PaymentsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<PaymentsClient.Options>;
+    constructor(options?: PaymentsClient.Options);
+    /**
+     * Categories are subdivisions of an account.
+     * The default category holds the main balance and transactions. Savings goals and spending spaces are examples of other categories. You can use [`/api/v2/accounts`](#operations-tag-Accounts) to get the default category UID for an account.
+     *
+     * If `startDate` is null, the standing order is awaiting review and has not yet been approved.
+     *
+     * If `cancelledAt` is non-null, the standing order has been cancelled, either by the customer, or as a result of the payment review.
+     *
+     * Required scopes (any): standing-order:read, standing-order-own:read.
+     *
+     * @param {Starling.GetStandingOrderPaymentsRequest} request
+     * @param {PaymentsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link errors.StarlingError}
+     * @throws {@link errors.StarlingTimeoutError}
+     *
+     * @example
+     *     await client.payments.getStandingOrder({
+     *         accountUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+     *         categoryUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+     *         paymentOrderUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa"
+     *     })
+     */
+    getStandingOrder(request: Starling.GetStandingOrderPaymentsRequest, requestOptions?: PaymentsClient.RequestOptions): core.HttpResponsePromise<Starling.StandingOrder>;
+    private __getStandingOrder;
+    /**
+     * Categories are subdivisions of an account.
+     * The default category holds the main balance and transactions. Savings goals and spending spaces are examples of other categories. You can use [`/api/v2/accounts`](#operations-tag-Accounts) to get the default category UID for an account.
+     *
+     * Possible 400 (Bad Request) errors include:
+     *  * `CANNOT_MAKE_REQUESTED_CHANGE`: you cannot make this change to this standing order. You can create a new standing order instead.
+     * * `CANNOT_UPDATE_CANCELLED_PAYMENT_ORDER`: you cannot update this standing order because it has been cancelled.
+     * * `CANNOT_UPDATE_PENDING_PAYMENT_ORDER`: you cannot update this standing order at this time because it is pending. This can happen if the original standing order is awaiting review. In this case, `GET /api/v2/payments/local/account/{accountUid}/category/{categoryUid}/standing-orders/{paymentOrderUid}` will return a null `startDate`.
+     *
+     * Required scopes (any): standing-order:create. Requires request signing.
+     *
+     * @param {Starling.UpdateStandingOrderRequest} request
+     * @param {PaymentsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link errors.StarlingError}
+     * @throws {@link errors.StarlingTimeoutError}
+     *
+     * @example
+     *     await client.payments.updateStandingOrder({
+     *         accountUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+     *         categoryUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+     *         paymentOrderUidPathParam: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+     *         paymentOrderUid: "33443344-3344-3344-3344-334433443344",
+     *         reference: "Payment reference",
+     *         amount: {
+     *             currency: "GBP",
+     *             minorUnits: 123456
+     *         },
+     *         standingOrderRecurrence: {
+     *             startDate: "2019-09-23",
+     *             frequency: "DAILY"
+     *         }
+     *     })
+     */
+    updateStandingOrder(request: Starling.UpdateStandingOrderRequest, requestOptions?: PaymentsClient.RequestOptions): core.HttpResponsePromise<Starling.UpdateStandingOrderResponse>;
+    private __updateStandingOrder;
+    /**
+     * Categories are subdivisions of an account.
+     * The default category holds the main balance and transactions. Savings goals and spending spaces are examples of other categories. You can use [`/api/v2/accounts`](#operations-tag-Accounts) to get the default category UID for an account.
+     *
+     * Possible 400 (Bad Request) errors include:
+     *  * `CANNOT_CANCEL_PENDING_PAYMENT_ORDER`: you cannot cancel this standing order at this time because it is pending. This can happen if the original standing order is awaiting review. In this case, `GET /api/v2/payments/local/account/{accountUid}/category/{categoryUid}/standing-orders/{paymentOrderUid}` returns a null `startDate`.
+     *
+     * Required scopes (any): standing-order:delete. Requires request signing.
+     *
+     * @param {Starling.CancelStandingOrderPaymentsRequest} request
+     * @param {PaymentsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link errors.StarlingError}
+     * @throws {@link errors.StarlingTimeoutError}
+     *
+     * @example
+     *     await client.payments.cancelStandingOrder({
+     *         accountUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+     *         categoryUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+     *         paymentOrderUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa"
+     *     })
+     */
+    cancelStandingOrder(request: Starling.CancelStandingOrderPaymentsRequest, requestOptions?: PaymentsClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __cancelStandingOrder;
+    /**
+     * Categories are subdivisions of an account.
+     * The default category holds the main balance and transactions. Savings goals and spending spaces are examples of other categories. You can use [`/api/v2/accounts`](#operations-tag-Accounts) to get the default category UID for an account.
+     *
+     * Standing orders that are awaiting review are omitted from the list.
+     *
+     * Required scopes (any): standing-order:read, standing-order-own:read.
+     *
+     * @param {Starling.ListStandingOrdersPaymentsRequest} request
+     * @param {PaymentsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link errors.StarlingError}
+     * @throws {@link errors.StarlingTimeoutError}
+     *
+     * @example
+     *     await client.payments.listStandingOrders({
+     *         accountUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+     *         categoryUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa"
+     *     })
+     */
+    listStandingOrders(request: Starling.ListStandingOrdersPaymentsRequest, requestOptions?: PaymentsClient.RequestOptions): core.HttpResponsePromise<Starling.StandingOrdersResponse>;
+    private __listStandingOrders;
+    /**
+     * Categories are subdivisions of an account.
+     * The default category holds the main balance and transactions. Savings goals and spending spaces are examples of other categories. You can use [`/api/v2/accounts`](#operations-tag-Accounts) to get the default category UID for an account.
+     *
+     * The recipient of the standing order must either be defined in the `paymentRecipient` field in the request body  or be an existing payee of the account holder (you can create a new payee using `/api/v2/payees`).
+     *
+     * `externalIdentifier` is a unique identifier for the standing order request, and is generated by you. To ensure idempotency, this must be unique for each standing order request you create.
+     *
+     * Note that the standing order may not be created immediately if we need to review the request. In that case, the request may remain in a `PENDING` state for a while (possibly for a few hours).
+     *
+     * Required scopes (any): standing-order:create. Requires request signing.
+     *
+     * @param {Starling.CreateStandingOrderRequest} request
+     * @param {PaymentsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link errors.StarlingError}
+     * @throws {@link errors.StarlingTimeoutError}
+     *
+     * @example
+     *     await client.payments.createStandingOrder({
+     *         accountUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+     *         categoryUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+     *         externalIdentifier: "a unique identifier to ensure idempotency",
+     *         reference: "Monthly Expenses",
+     *         amount: {
+     *             currency: "GBP",
+     *             minorUnits: 123456
+     *         },
+     *         standingOrderRecurrence: {
+     *             startDate: "2019-09-23",
+     *             frequency: "DAILY"
+     *         }
+     *     })
+     */
+    createStandingOrder(request: Starling.CreateStandingOrderRequest, requestOptions?: PaymentsClient.RequestOptions): core.HttpResponsePromise<Starling.CreateStandingOrderResponse>;
+    private __createStandingOrder;
+    /**
+     *
+     *
+     * Required scopes (any): pay-local:read.
+     *
+     * @param {Starling.GetOrderPaymentsRequest} request
+     * @param {PaymentsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link errors.StarlingError}
+     * @throws {@link errors.StarlingTimeoutError}
+     *
+     * @example
+     *     await client.payments.getOrder({
+     *         paymentOrderUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa"
+     *     })
+     */
+    getOrder(request: Starling.GetOrderPaymentsRequest, requestOptions?: PaymentsClient.RequestOptions): core.HttpResponsePromise<Starling.PaymentOrderV2>;
+    private __getOrder;
+    /**
+     * Note that a payment associated with a payment order may be pending (`paymentStatusDetails.paymentStatus = PENDING`)  or rejected (`paymentStatusDetails.paymentStatus = REJECTED`).
+     *
+     * Required scopes (any): pay-local:read.
+     *
+     * @param {Starling.ListOrderPaymentsPaymentsRequest} request
+     * @param {PaymentsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link errors.StarlingError}
+     * @throws {@link errors.StarlingTimeoutError}
+     *
+     * @example
+     *     await client.payments.listOrderPayments({
+     *         paymentOrderUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa"
+     *     })
+     */
+    listOrderPayments(request: Starling.ListOrderPaymentsPaymentsRequest, requestOptions?: PaymentsClient.RequestOptions): core.HttpResponsePromise<Starling.PaymentOrderPaymentsResponse>;
+    private __listOrderPayments;
+    /**
+     * Categories are subdivisions of an account.
+     * The default category holds the main balance and transactions. Savings goals and spending spaces are examples of other categories. You can use [`/api/v2/accounts`](#operations-tag-Accounts) to get the default category UID for an account.
+     *
+     * If you only want the next payment date, you can also get this from the `nextDate` returned by `GET /api/v2/payments/local/account/{accountUid}/category/{categoryUid}/standing-orders/{paymentOrderUid}`.
+     *
+     * If `nextPaymentDates` is empty for a standing order, the standing order may be awaiting review, or may have been cancelled. Or it may have been a one-off standing order: in this case, `nextDate` will be null too.
+     *
+     * Required scopes (any): standing-order:read.
+     *
+     * @param {Starling.ListUpcomingDatesPaymentsRequest} request
+     * @param {PaymentsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link errors.StarlingError}
+     * @throws {@link errors.StarlingTimeoutError}
+     *
+     * @example
+     *     await client.payments.listUpcomingDates({
+     *         accountUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+     *         categoryUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+     *         paymentOrderUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa"
+     *     })
+     */
+    listUpcomingDates(request: Starling.ListUpcomingDatesPaymentsRequest, requestOptions?: PaymentsClient.RequestOptions): core.HttpResponsePromise<Starling.NextPaymentDatesResponse>;
+    private __listUpcomingDates;
+    /**
+     * Creates and sends an immediate payment within the UK under the Faster Payments Scheme or via SEPA for payments between Euro accounts.
+     *
+     * Categories are subdivisions of an account.
+     * The default category holds the main balance and transactions. Savings goals and spending spaces are examples of other categories. You can use [`/api/v2/accounts`](#operations-tag-Accounts) to get the default category UID for an account.
+     *
+     * The recipient of the payment must either be defined in the `paymentRecipient` field in the request body  or be an existing payee of the account holder (you can create a new payee using `/api/v2/payees`).For payments made using a Personal Access Token, the recipient must be an existing payee defined in the `destinationPayeeAccountUid` field.
+     *
+     * `externalIdentifier` is a unique identifier for the payment request, and is generated by you. To ensure idempotency, this must be unique for each payment request you create.
+     *
+     * Note that the payment may not take place immediately if we need to review the payment request. In that case, the payment may remain in a `PENDING` state for a while (possibly for a few hours).
+     *
+     * Required scopes (any): pay-local:create, pay-local-once:create. Requires request signing.
+     *
+     * @param {Starling.InstructLocalPaymentRequest} request
+     * @param {PaymentsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link errors.StarlingError}
+     * @throws {@link errors.StarlingTimeoutError}
+     *
+     * @example
+     *     await client.payments.create({
+     *         accountUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+     *         categoryUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+     *         externalIdentifier: "Unique identifier to ensure idempotency",
+     *         reference: "December Expenses",
+     *         amount: {
+     *             currency: "GBP",
+     *             minorUnits: 123456
+     *         }
+     *     })
+     */
+    create(request: Starling.InstructLocalPaymentRequest, requestOptions?: PaymentsClient.RequestOptions): core.HttpResponsePromise<Starling.InstructLocalPaymentResponse>;
+    private __create;
+}

package/dist/generated/api/resources/payments/client/index.d.cts

@@ -0,0 +1 @@
+export * from "./requests/index.cjs";

package/dist/generated/api/resources/payments/client/index.d.ts

@@ -0,0 +1 @@
+export * from "./requests/index.js";

package/dist/generated/api/resources/payments/client/requests/CancelStandingOrderPaymentsRequest.d.cts

@@ -0,0 +1,16 @@
+/**
+ * @example
+ *     {
+ *         accountUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+ *         categoryUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+ *         paymentOrderUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa"
+ *     }
+ */
+export interface CancelStandingOrderPaymentsRequest {
+    /** Account uid */
+    accountUid: string;
+    /** Category uid */
+    categoryUid: string;
+    /** Payment order uid */
+    paymentOrderUid: string;
+}

package/dist/generated/api/resources/payments/client/requests/CancelStandingOrderPaymentsRequest.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @example
+ *     {
+ *         accountUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+ *         categoryUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+ *         paymentOrderUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa"
+ *     }
+ */
+export interface CancelStandingOrderPaymentsRequest {
+    /** Account uid */
+    accountUid: string;
+    /** Category uid */
+    categoryUid: string;
+    /** Payment order uid */
+    paymentOrderUid: string;
+}