@mmzaini/starling-sdk 0.1.0

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

@@ -0,0 +1,43 @@
+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 AccountHolderClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class AccountHolderClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<AccountHolderClient.Options>;
+    constructor(options?: AccountHolderClient.Options);
+    /**
+     *
+     *
+     * Required scopes (any): customer:read, account-holder-type:read.
+     *
+     * @param {AccountHolderClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link errors.StarlingError}
+     * @throws {@link errors.StarlingTimeoutError}
+     *
+     * @example
+     *     await client.accountHolder.get()
+     */
+    get(requestOptions?: AccountHolderClient.RequestOptions): core.HttpResponsePromise<Starling.AccountHolder>;
+    private __get;
+    /**
+     *
+     *
+     * Required scopes (any): account-holder-name:read.
+     *
+     * @param {AccountHolderClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link errors.StarlingError}
+     * @throws {@link errors.StarlingTimeoutError}
+     *
+     * @example
+     *     await client.accountHolder.getName()
+     */
+    getName(requestOptions?: AccountHolderClient.RequestOptions): core.HttpResponsePromise<Starling.AccountHolderName>;
+    private __getName;
+}

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1 @@
+export {};

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,116 @@
+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 AccountsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class AccountsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<AccountsClient.Options>;
+    constructor(options?: AccountsClient.Options);
+    /**
+     * A Feed Export contains a list of all (Settled) transactions on an account for a specified date range in CSV format.
+     *
+     * Required scopes (any): feed-export-csv:read.
+     *
+     * @throws {@link errors.StarlingError}
+     * @throws {@link errors.StarlingTimeoutError}
+     */
+    exportFeed(request: Starling.ExportFeedAccountsRequest, requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
+    private __exportFeed;
+    /**
+     * The account balance is expressed in two ways: cleared balance and effective balance.
+     * * The **cleared balance** is the balance of settled transactions and so does not include pending transactions. The cleared end of day balance is used to calculate interest.
+     * * The **effective balance** is the balance of settled and pending outgoing transactions. This is the balance most commonly presented to the account holder (e.g. in-app).
+     *
+     * `clearedBalance` and `effectiveBalance` hold the values for the main account only, excluding balances in spaces, savings goals etc. `totalClearedBalance` and `totalEffectiveBalance` hold the corresponding values totalled across the main account and all spaces, savings goals etc.
+     *
+     * Many payment types settle almost instantly (e.g. faster payments). Card transactions usually take a few days to settle and will remain pending for this time. We've got a blog post on [how card transactions work](https://www.starlingbank.com/blog/card-transactions-explained/).
+     *
+     * To check whether the account has enough money to make a payment, use the confirmation of funds endpoint instead.
+     *
+     * Required scopes (any): balance:read.
+     *
+     * @param {Starling.GetBalanceAccountsRequest} request
+     * @param {AccountsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link errors.StarlingError}
+     * @throws {@link errors.StarlingTimeoutError}
+     *
+     * @example
+     *     await client.accounts.getBalance({
+     *         accountUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa"
+     *     })
+     */
+    getBalance(request: Starling.GetBalanceAccountsRequest, requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<Starling.BalanceV2>;
+    private __getBalance;
+    /**
+     * Identifiers come in pairs:
+     *
+     * * A bank identifier, which identifies the bank
+     * * An account identifier, which identifiers the account at the bank
+     *
+     * Identifiers can be:
+     * * Sort code and account number for domestic UK payments
+     * * BIC and IBAN for international payments
+     * * ABA and ACH routing numbers for domestic US payments
+     *
+     * Required scopes (any): account-identifier:read.
+     *
+     * @param {Starling.GetIdentifiersAccountsRequest} request
+     * @param {AccountsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link errors.StarlingError}
+     * @throws {@link errors.StarlingTimeoutError}
+     *
+     * @example
+     *     await client.accounts.getIdentifiers({
+     *         accountUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa"
+     *     })
+     */
+    getIdentifiers(request: Starling.GetIdentifiersAccountsRequest, requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<Starling.AccountIdentifiers>;
+    private __getIdentifiers;
+    /**
+     * This endpoint returns a list of the accounts that you can access using the access token you supplied in the request header.
+     *
+     * Each access token is associated with a single account holder, who may have more than one account (for example, a GBP account and a euro account). This endpoint returns all the accounts that the account holder has given you permission to access.
+     *
+     * Note that an account holder in this context is either a personal account holder, or a sole trader account holder, or a business account holder or a joint account holder. An individual person may be more than one of these kinds of account holder, but each kind of account holder is a separate entity and hence requires a separate access token and permission.
+     *
+     * 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.
+     *
+     * Required scopes (any): account:read, account-list:read.
+     *
+     * @param {AccountsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link errors.StarlingError}
+     * @throws {@link errors.StarlingTimeoutError}
+     *
+     * @example
+     *     await client.accounts.list()
+     */
+    list(requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<Starling.Accounts>;
+    private __list;
+    /**
+     *
+     *
+     * Required scopes (any): confirmation-of-funds:read.
+     *
+     * @param {Starling.ConfirmFundsAccountsRequest} request
+     * @param {AccountsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link errors.StarlingError}
+     * @throws {@link errors.StarlingTimeoutError}
+     *
+     * @example
+     *     await client.accounts.confirmFunds({
+     *         accountUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+     *         targetAmountInMinorUnits: 1000000
+     *     })
+     */
+    confirmFunds(request: Starling.ConfirmFundsAccountsRequest, requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<Starling.ConfirmationOfFundsResponse>;
+    private __confirmFunds;
+}

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

@@ -0,0 +1,116 @@
+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 AccountsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class AccountsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<AccountsClient.Options>;
+    constructor(options?: AccountsClient.Options);
+    /**
+     * A Feed Export contains a list of all (Settled) transactions on an account for a specified date range in CSV format.
+     *
+     * Required scopes (any): feed-export-csv:read.
+     *
+     * @throws {@link errors.StarlingError}
+     * @throws {@link errors.StarlingTimeoutError}
+     */
+    exportFeed(request: Starling.ExportFeedAccountsRequest, requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
+    private __exportFeed;
+    /**
+     * The account balance is expressed in two ways: cleared balance and effective balance.
+     * * The **cleared balance** is the balance of settled transactions and so does not include pending transactions. The cleared end of day balance is used to calculate interest.
+     * * The **effective balance** is the balance of settled and pending outgoing transactions. This is the balance most commonly presented to the account holder (e.g. in-app).
+     *
+     * `clearedBalance` and `effectiveBalance` hold the values for the main account only, excluding balances in spaces, savings goals etc. `totalClearedBalance` and `totalEffectiveBalance` hold the corresponding values totalled across the main account and all spaces, savings goals etc.
+     *
+     * Many payment types settle almost instantly (e.g. faster payments). Card transactions usually take a few days to settle and will remain pending for this time. We've got a blog post on [how card transactions work](https://www.starlingbank.com/blog/card-transactions-explained/).
+     *
+     * To check whether the account has enough money to make a payment, use the confirmation of funds endpoint instead.
+     *
+     * Required scopes (any): balance:read.
+     *
+     * @param {Starling.GetBalanceAccountsRequest} request
+     * @param {AccountsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link errors.StarlingError}
+     * @throws {@link errors.StarlingTimeoutError}
+     *
+     * @example
+     *     await client.accounts.getBalance({
+     *         accountUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa"
+     *     })
+     */
+    getBalance(request: Starling.GetBalanceAccountsRequest, requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<Starling.BalanceV2>;
+    private __getBalance;
+    /**
+     * Identifiers come in pairs:
+     *
+     * * A bank identifier, which identifies the bank
+     * * An account identifier, which identifiers the account at the bank
+     *
+     * Identifiers can be:
+     * * Sort code and account number for domestic UK payments
+     * * BIC and IBAN for international payments
+     * * ABA and ACH routing numbers for domestic US payments
+     *
+     * Required scopes (any): account-identifier:read.
+     *
+     * @param {Starling.GetIdentifiersAccountsRequest} request
+     * @param {AccountsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link errors.StarlingError}
+     * @throws {@link errors.StarlingTimeoutError}
+     *
+     * @example
+     *     await client.accounts.getIdentifiers({
+     *         accountUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa"
+     *     })
+     */
+    getIdentifiers(request: Starling.GetIdentifiersAccountsRequest, requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<Starling.AccountIdentifiers>;
+    private __getIdentifiers;
+    /**
+     * This endpoint returns a list of the accounts that you can access using the access token you supplied in the request header.
+     *
+     * Each access token is associated with a single account holder, who may have more than one account (for example, a GBP account and a euro account). This endpoint returns all the accounts that the account holder has given you permission to access.
+     *
+     * Note that an account holder in this context is either a personal account holder, or a sole trader account holder, or a business account holder or a joint account holder. An individual person may be more than one of these kinds of account holder, but each kind of account holder is a separate entity and hence requires a separate access token and permission.
+     *
+     * 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.
+     *
+     * Required scopes (any): account:read, account-list:read.
+     *
+     * @param {AccountsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link errors.StarlingError}
+     * @throws {@link errors.StarlingTimeoutError}
+     *
+     * @example
+     *     await client.accounts.list()
+     */
+    list(requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<Starling.Accounts>;
+    private __list;
+    /**
+     *
+     *
+     * Required scopes (any): confirmation-of-funds:read.
+     *
+     * @param {Starling.ConfirmFundsAccountsRequest} request
+     * @param {AccountsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link errors.StarlingError}
+     * @throws {@link errors.StarlingTimeoutError}
+     *
+     * @example
+     *     await client.accounts.confirmFunds({
+     *         accountUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+     *         targetAmountInMinorUnits: 1000000
+     *     })
+     */
+    confirmFunds(request: Starling.ConfirmFundsAccountsRequest, requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<Starling.ConfirmationOfFundsResponse>;
+    private __confirmFunds;
+}

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

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

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

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

package/dist/generated/api/resources/accounts/client/requests/ConfirmFundsAccountsRequest.d.cts

@@ -0,0 +1,13 @@
+/**
+ * @example
+ *     {
+ *         accountUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+ *         targetAmountInMinorUnits: 1000000
+ *     }
+ */
+export interface ConfirmFundsAccountsRequest {
+    /** Account uid */
+    accountUid: string;
+    /** Target amount in minor units */
+    targetAmountInMinorUnits: number;
+}

package/dist/generated/api/resources/accounts/client/requests/ConfirmFundsAccountsRequest.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @example
+ *     {
+ *         accountUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
+ *         targetAmountInMinorUnits: 1000000
+ *     }
+ */
+export interface ConfirmFundsAccountsRequest {
+    /** Account uid */
+    accountUid: string;
+    /** Target amount in minor units */
+    targetAmountInMinorUnits: number;
+}

package/dist/generated/api/resources/accounts/client/requests/ExportFeedAccountsRequest.d.cts

@@ -0,0 +1,5 @@
+export interface ExportFeedAccountsRequest {
+    accountUid: string;
+    start: string;
+    end?: string;
+}

package/dist/generated/api/resources/accounts/client/requests/ExportFeedAccountsRequest.d.ts

@@ -0,0 +1,5 @@
+export interface ExportFeedAccountsRequest {
+    accountUid: string;
+    start: string;
+    end?: string;
+}

package/dist/generated/api/resources/accounts/client/requests/GetBalanceAccountsRequest.d.cts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         accountUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa"
+ *     }
+ */
+export interface GetBalanceAccountsRequest {
+    /** Account uid */
+    accountUid: string;
+}

package/dist/generated/api/resources/accounts/client/requests/GetBalanceAccountsRequest.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         accountUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa"
+ *     }
+ */
+export interface GetBalanceAccountsRequest {
+    /** Account uid */
+    accountUid: string;
+}

package/dist/generated/api/resources/accounts/client/requests/GetIdentifiersAccountsRequest.d.cts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         accountUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa"
+ *     }
+ */
+export interface GetIdentifiersAccountsRequest {
+    /** Account uid */
+    accountUid: string;
+}

package/dist/generated/api/resources/accounts/client/requests/GetIdentifiersAccountsRequest.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         accountUid: "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa"
+ *     }
+ */
+export interface GetIdentifiersAccountsRequest {
+    /** Account uid */
+    accountUid: string;
+}

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

@@ -0,0 +1,4 @@
+export type { ConfirmFundsAccountsRequest } from "./ConfirmFundsAccountsRequest.cjs";
+export type { ExportFeedAccountsRequest } from "./ExportFeedAccountsRequest.cjs";
+export type { GetBalanceAccountsRequest } from "./GetBalanceAccountsRequest.cjs";
+export type { GetIdentifiersAccountsRequest } from "./GetIdentifiersAccountsRequest.cjs";

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

@@ -0,0 +1,4 @@
+export type { ConfirmFundsAccountsRequest } from "./ConfirmFundsAccountsRequest.js";
+export type { ExportFeedAccountsRequest } from "./ExportFeedAccountsRequest.js";
+export type { GetBalanceAccountsRequest } from "./GetBalanceAccountsRequest.js";
+export type { GetIdentifiersAccountsRequest } from "./GetIdentifiersAccountsRequest.js";

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,50 @@
+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 AddressesClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class AddressesClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<AddressesClient.Options>;
+    constructor(options?: AddressesClient.Options);
+    /**
+     *
+     *
+     * Required scopes (any): address:read.
+     *
+     * @param {AddressesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link errors.StarlingError}
+     * @throws {@link errors.StarlingTimeoutError}
+     *
+     * @example
+     *     await client.addresses.list()
+     */
+    list(requestOptions?: AddressesClient.RequestOptions): core.HttpResponsePromise<Starling.AddressesV2>;
+    private __list;
+    /**
+     *
+     *
+     * Required scopes (any): address:edit. Requires request signing.
+     *
+     * @param {Starling.AddressUpdateRequest} request
+     * @param {AddressesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link errors.StarlingError}
+     * @throws {@link errors.StarlingTimeoutError}
+     *
+     * @example
+     *     await client.addresses.update({
+     *         line1: "1A Admiralty Arch",
+     *         postTown: "London",
+     *         postCode: "SW1A 2WH",
+     *         countryCode: "GB",
+     *         from: "2023-01-01"
+     *     })
+     */
+    update(request: Starling.AddressUpdateRequest, requestOptions?: AddressesClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __update;
+}

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

@@ -0,0 +1,50 @@
+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 AddressesClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class AddressesClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<AddressesClient.Options>;
+    constructor(options?: AddressesClient.Options);
+    /**
+     *
+     *
+     * Required scopes (any): address:read.
+     *
+     * @param {AddressesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link errors.StarlingError}
+     * @throws {@link errors.StarlingTimeoutError}
+     *
+     * @example
+     *     await client.addresses.list()
+     */
+    list(requestOptions?: AddressesClient.RequestOptions): core.HttpResponsePromise<Starling.AddressesV2>;
+    private __list;
+    /**
+     *
+     *
+     * Required scopes (any): address:edit. Requires request signing.
+     *
+     * @param {Starling.AddressUpdateRequest} request
+     * @param {AddressesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link errors.StarlingError}
+     * @throws {@link errors.StarlingTimeoutError}
+     *
+     * @example
+     *     await client.addresses.update({
+     *         line1: "1A Admiralty Arch",
+     *         postTown: "London",
+     *         postCode: "SW1A 2WH",
+     *         countryCode: "GB",
+     *         from: "2023-01-01"
+     *     })
+     */
+    update(request: Starling.AddressUpdateRequest, requestOptions?: AddressesClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __update;
+}

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

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

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

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

package/dist/generated/api/resources/addresses/client/requests/AddressUpdateRequest.d.cts

@@ -0,0 +1,25 @@
+/**
+ * @example
+ *     {
+ *         line1: "1A Admiralty Arch",
+ *         postTown: "London",
+ *         postCode: "SW1A 2WH",
+ *         countryCode: "GB",
+ *         from: "2023-01-01"
+ *     }
+ */
+export interface AddressUpdateRequest {
+    line1: string;
+    line2?: string;
+    line3?: string;
+    postTown: string;
+    postCode: string;
+    /** Country code in ISO 3166-1 alpha-2. NB GB is the official country code for the UK. UK is not the officially assigned code, and so is not valid */
+    countryCode: string;
+    /** The UDPRN of the property */
+    udprn?: string;
+    /** The UMPRN of the property */
+    umprn?: string;
+    /** Date the account holder's residency at this address started */
+    from: string;
+}

package/dist/generated/api/resources/addresses/client/requests/AddressUpdateRequest.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @example
+ *     {
+ *         line1: "1A Admiralty Arch",
+ *         postTown: "London",
+ *         postCode: "SW1A 2WH",
+ *         countryCode: "GB",
+ *         from: "2023-01-01"
+ *     }
+ */
+export interface AddressUpdateRequest {
+    line1: string;
+    line2?: string;
+    line3?: string;
+    postTown: string;
+    postCode: string;
+    /** Country code in ISO 3166-1 alpha-2. NB GB is the official country code for the UK. UK is not the officially assigned code, and so is not valid */
+    countryCode: string;
+    /** The UDPRN of the property */
+    udprn?: string;
+    /** The UMPRN of the property */
+    umprn?: string;
+    /** Date the account holder's residency at this address started */
+    from: string;
+}

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

@@ -0,0 +1 @@
+export type { AddressUpdateRequest } from "./AddressUpdateRequest.cjs";

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

@@ -0,0 +1 @@
+export type { AddressUpdateRequest } from "./AddressUpdateRequest.js";

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

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

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

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

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

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

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

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