Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion attw.json
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,6 @@
"hellosign-sdk",
"html-minifier-terser",
"html-to-text",
"i18next-fs-backend",
"i18next-sprintf-postprocessor",
"ibm_db",
"identicon.js",
Expand Down
4 changes: 4 additions & 0 deletions notNeededPackages.json
Original file line number Diff line number Diff line change
Expand Up @@ -2525,6 +2525,10 @@
"libraryName": "i18next-express-middleware",
"asOfVersion": "1.7.0"
},
"i18next-fs-backend": {
"libraryName": "i18next-fs-backend",
"asOfVersion": "1.2.0"
},
"i18next-xhr-backend": {
"libraryName": "i18next-xhr-backend",
"asOfVersion": "1.4.2"
Expand Down
43 changes: 21 additions & 22 deletions types/consumer-data-standards/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This fork of the [DefinitelyTyped](https://github.com/DefinitelyTyped/Definitely

## Using the Type Definitions

The Data Standards Body publishes the Type Definitions as a [npm package](https://www.npmjs.com/package/@types/consumer-data-standards). To use these type definitions in your TypeScript projects, you can install them via npm as part of your development dependencies. Please refer to the [Quick Start Guide](#quick-start-guide) section below for more information.
The Data Standards Body publishes the Type Definitions as a [npm package](https://www.npmjs.com/package/@types/consumer-data-standards). To use these type definitions in your TypeScript projects, you can install them via npm as part of your development dependencies. Please refer to the [Quick Start Guide](#quick-start-guide) section below for more information.

This tool:

Expand All @@ -18,29 +18,28 @@ This tool:
Please follow these steps to integrate the CDR-specific type definitions into your TypeScript projects:

1. **Install** via npm or Yarn: Depending on your preference, you can use npm or Yarn to install the CDS type definitions package published to npm.
```bash
npm install @types/consumer-data-standards
```
Or
```bash
yarn install @types/consumer-data-standards
```

```bash
npm install @types/consumer-data-standards
```

Or

```bash
yarn install @types/consumer-data-standards
```

2. **Usage**: Utilise the types in your TypeScript code as needed:

```tsx
import { YourType } from 'your-package';

function processData(data: YourType) {
// your code here
}
```

3. **Stay Updated**: Regularly check for updates to ensure you have the latest type definitions.

```tsx
import { YourType } from "your-package";

function processData(data: YourType) {
// your code here
}
```

3. **Stay Updated**: Regularly check for updates to ensure you have the latest type definitions.

## Reporting Issues

Expand Down
207 changes: 206 additions & 1 deletion types/consumer-data-standards/banking/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -877,6 +877,34 @@ export interface BankingProductConstraint {
}
/* These are the schema definitions stipulated by the Data Standards Body for the banking api. */

/* These are the schema definitions stipulated by the Data Standards Body for the banking api. */

export interface BankingProductConstraintV2 {
/**
* Display text providing more information on the constraint.
*/
additionalInfo?: string | null;
/**
* Link to a web page with more information on the constraint.
*/
additionalInfoUri?: string | null;
/**
* Generic field containing additional information relevant to the [_constraintType_](#tocSproductconstrainttypedoc) specified. Whether mandatory or not is dependent on the value of [_constraintType_](#tocSproductconstrainttypedoc).
*/
additionalValue?: string | null;
/**
* The type of constraint described. For further details, refer to [Product Constraint Types](#tocSproductconstrainttypedoc).
*/
constraintType:
| "MAX_BALANCE"
| "MAX_LIMIT"
| "MAX_LVR"
| "MIN_BALANCE"
| "MIN_LIMIT"
| "MIN_LVR"
| "OPENING_BALANCE";
[k: string]: unknown;
}
export interface BankingProductDepositRate {
/**
* Display text providing more information on the rate.
Expand Down Expand Up @@ -1443,6 +1471,40 @@ export interface BankingProductDetailV4 extends BankingProductV4 {
}>;
[k: string]: unknown;
}

/* These are the schema definitions stipulated by the Data Standards Body for the banking api. */

export type BankingProductDetailV5 = BankingProductV4 & {
/**
* An array of bundles that this product participates in. Each bundle is described by free form information but also by a list of product IDs of the other products that are included in the bundle. It is assumed that the current product is included in the bundle also.
*/
bundles?: BankingProductBundle[] | null;
/**
* Array of features available for the product.
*/
features?: BankingProductFeatureV2[] | null;
/**
* Constraints on the application for or operation of the product such as minimum balances or limit thresholds.
*/
constraints?: BankingProductConstraintV2[] | null;
/**
* Eligibility criteria for the product.
*/
eligibility?: BankingProductEligibility[] | null;
/**
* Fees applicable for the product.
*/
fees?: BankingProductFee[] | null;
/**
* Interest rates available for deposits.
*/
depositRates?: BankingProductDepositRate[] | null;
/**
* Interest rates charged against lending balances.
*/
lendingRates?: BankingProductLendingRateV2[] | null;
[k: string]: unknown;
};
/* These are the schema definitions stipulated by the Data Standards Body for the banking api. */

export interface BankingProductDiscount {
Expand Down Expand Up @@ -2876,6 +2938,50 @@ export interface BankingTransactionDetail extends BankingTransaction {
}
/* These are the schema definitions stipulated by the Data Standards Body for the banking api. */

export type BankingTransactionDetailV2 = BankingTransaction & {
extendedData: {
/**
* Label of the originating payer. Mandatory for inbound payment.
*/
payer?: string;
/**
* Label of the target PayID. Mandatory for an outbound payment. The name assigned to the BSB/Account Number or PayID (by the owner of the PayID).
*/
payee?: string;
/**
* Optional extended data specific to transactions. Currently extended data is supported for NPP service overlays.
*/
extensionUType?: "nppPayload";
/**
* Required if the _extensionUType_ value is `nppPayload`.
*/
nppPayload?: {
/**
* An extended string description. Required if the _extensionUType_ value is `nppPayload`.
*/
extendedDescription?: string;
/**
* An end to end ID for the payment created at initiation.
*/
endToEndId?: string;
/**
* Purpose of the payment. Format is defined by the NPP standards for the NPP overlay services including Osko (X2P1).
*/
purposeCode?: string;
/**
* Identifier of the applicable overlay service. The _service_ is used in conjunction with the _serviceVersion_. See [here](#npp-services) for more details.
*/
service: "X2P1" | "IFTI" | "BSCT" | "CATSCT";
/**
* Two-digit NPP service overlay version with leading zero.
*/
serviceVersion: string;
[k: string]: unknown;
};
[k: string]: unknown;
};
[k: string]: unknown;
};
/**
* Australian address formatted according to the file format defined by the [PAF file format](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf).
*/
Expand Down Expand Up @@ -3226,9 +3332,17 @@ export interface MetaPaginatedTransaction {
*/
isQueryParamUnsupported?: boolean | null;
}

/**
* Identifier of the applicable overlay service. The _service_ is used in conjunction with the _serviceVersion_. See [here](#npp-services) for more details.
*/
export type NppPaymentService = "X2P1" | "IFTI" | "BSCT" | "CATSCT";
/* These are the schema definitions stipulated by the Data Standards Body for the banking api. */
export interface RequestAccountIds {
data: {
/**
* Array of _accountId_ values.
*/
accountIds: string[];
[k: string]: unknown;
};
Expand Down Expand Up @@ -5412,6 +5526,45 @@ export interface ResponseBankingProductByIdV4 {
}
/* These are the schema definitions stipulated by the Data Standards Body for the banking api. */

/* These are the schema definitions stipulated by the Data Standards Body for the banking api. */

export interface ResponseBankingProductByIdV5 {
data: BankingProductV4 & {
/**
* An array of bundles that this product participates in. Each bundle is described by free form information but also by a list of product IDs of the other products that are included in the bundle. It is assumed that the current product is included in the bundle also.
*/
bundles?: BankingProductBundle[] | null;
/**
* Array of features available for the product.
*/
features?: BankingProductFeatureV2[] | null;
/**
* Constraints on the application for or operation of the product such as minimum balances or limit thresholds.
*/
constraints?: BankingProductConstraintV2[] | null;
/**
* Eligibility criteria for the product.
*/
eligibility?: BankingProductEligibility[] | null;
/**
* Fees applicable for the product.
*/
fees?: BankingProductFee[] | null;
/**
* Interest rates available for deposits.
*/
depositRates?: BankingProductDepositRate[] | null;
/**
* Interest rates charged against lending balances.
*/
lendingRates?: BankingProductLendingRateV2[] | null;
[k: string]: unknown;
};
links: Links;
meta?: null | Meta;
[k: string]: unknown;
}

export interface ResponseBankingProductListV2 {
data: {
/**
Expand Down Expand Up @@ -6460,6 +6613,58 @@ export interface ResponseBankingTransactionById {
}
/* These are the schema definitions stipulated by the Data Standards Body for the banking api. */

/* These are the schema definitions stipulated by the Data Standards Body for the banking api. */

export interface ResponseBankingTransactionByIdV2 {
data: BankingTransaction & {
extendedData: {
/**
* Label of the originating payer. Mandatory for inbound payment.
*/
payer?: string;
/**
* Label of the target PayID. Mandatory for an outbound payment. The name assigned to the BSB/Account Number or PayID (by the owner of the PayID).
*/
payee?: string;
/**
* Optional extended data specific to transactions. Currently extended data is supported for NPP service overlays.
*/
extensionUType?: "nppPayload";
/**
* Required if the _extensionUType_ value is `nppPayload`.
*/
nppPayload?: {
/**
* An extended string description. Required if the _extensionUType_ value is `nppPayload`.
*/
extendedDescription?: string;
/**
* An end to end ID for the payment created at initiation.
*/
endToEndId?: string;
/**
* Purpose of the payment. Format is defined by the NPP standards for the NPP overlay services including Osko (X2P1).
*/
purposeCode?: string;
/**
* Identifier of the applicable overlay service. The _service_ is used in conjunction with the _serviceVersion_. See [here](#npp-services) for more details.
*/
service: "X2P1" | "IFTI" | "BSCT" | "CATSCT";
/**
* Two-digit NPP service overlay version with leading zero.
*/
serviceVersion: string;
[k: string]: unknown;
};
[k: string]: unknown;
};
[k: string]: unknown;
};
links: Links;
meta?: Meta;
[k: string]: unknown;
}

export interface ResponseBankingTransactionList {
data: {
transactions: Array<{
Expand Down Expand Up @@ -6579,11 +6784,11 @@ export interface ResponseBankingTransactionList {
* The total number of records in the full set. See [pagination](#pagination).
*/
totalRecords: number;
[k: string]: unknown;
/**
* true if "text" query parameter is not supported
*/
isQueryParamUnsupported?: boolean | null;
[k: string]: unknown;
};
[k: string]: unknown;
}
Expand Down
4 changes: 2 additions & 2 deletions types/consumer-data-standards/common/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -173,15 +173,15 @@ export interface CommonOrganisationDetailV2 extends CommonOrganisation {
*/
thoroughfareNumber1?: number | null;
/**
* Suffix for the thoroughfare number. Only relevant is thoroughfareNumber1 is populated
* Suffix for the thoroughfare number. Only relevant if _thoroughfareNumber1_ is populated
*/
thoroughfareNumber1Suffix?: string | null;
/**
* Second thoroughfare number (only used if the property has a ranged address eg 23-25)
*/
thoroughfareNumber2?: number | null;
/**
* Suffix for the second thoroughfare number. Only relevant is thoroughfareNumber2 is populated
* Suffix for the second thoroughfare number. Only relevant if _thoroughfareNumber2_ is populated
*/
thoroughfareNumber2Suffix?: string | null;
[k: string]: unknown;
Expand Down
8 changes: 4 additions & 4 deletions types/consumer-data-standards/energy/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5125,7 +5125,7 @@ export interface EnergyPlanSolarFeedInTariffV3 {
*/
startDate?: string;
/**
* The type of the payer
* Reference to the applicable tariff structure
*/
tariffUType: "singleTariff" | "timeVaryingTariffs";
/**
Expand Down Expand Up @@ -5398,7 +5398,7 @@ export interface EnergyPlanTariffPeriodV2 {
*/
dailySupplyCharge?: string;
/**
* Specifies if daily supply charge is single or banded. Default value is SINGLE if field not provided
* Specifies if daily supply charge is single or banded.
*/
dailySupplyChargeType?: "SINGLE" | "BAND";
/**
Expand Down Expand Up @@ -5769,15 +5769,15 @@ export interface EnergyServicePointDetail {
*/
thoroughfareNumber1?: number | null;
/**
* Suffix for the thoroughfare number. Only relevant is thoroughfareNumber1 is populated
* Suffix for the thoroughfare number. Only relevant if _thoroughfareNumber1_ is populated
*/
thoroughfareNumber1Suffix?: string | null;
/**
* Second thoroughfare number (only used if the property has a ranged address eg 23-25)
*/
thoroughfareNumber2?: number | null;
/**
* Suffix for the second thoroughfare number. Only relevant is thoroughfareNumber2 is populated
* Suffix for the second thoroughfare number. Only relevant if _thoroughfareNumber2_ is populated
*/
thoroughfareNumber2Suffix?: string | null;
[k: string]: unknown;
Expand Down
Loading