Skip to content

Commit fa38b65

Browse files
tom-schierabeheron1Tomas Schier
authored
🤖 Merge PR DefinitelyTyped#71695 Updated to comply with release 1.33.0 by @tom-schier
Co-authored-by: abeheron <[email protected]> Co-authored-by: Erez Ben-Aharon <[email protected]> Co-authored-by: Tomas Schier <[email protected]>
1 parent fc75638 commit fa38b65

File tree

6 files changed

+235
-31
lines changed

6 files changed

+235
-31
lines changed

‎types/consumer-data-standards/README.md‎

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This fork of the [DefinitelyTyped](https://github.com/DefinitelyTyped/Definitely
66

77
## Using the Type Definitions
88

9-
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.
9+
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.
1010

1111
This tool:
1212

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

2020
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.
21-
22-
```bash
23-
npm install @types/consumer-data-standards
24-
```
25-
26-
Or
27-
28-
```bash
29-
yarn install @types/consumer-data-standards
30-
```
31-
21+
22+
```bash
23+
npm install @types/consumer-data-standards
24+
```
25+
26+
Or
27+
28+
```bash
29+
yarn install @types/consumer-data-standards
30+
```
31+
3232
2. **Usage**: Utilise the types in your TypeScript code as needed:
33-
34-
```tsx
35-
import { YourType } from 'your-package';
36-
37-
function processData(data: YourType) {
38-
// your code here
39-
}
40-
```
41-
42-
3. **Stay Updated**: Regularly check for updates to ensure you have the latest type definitions.
4333

34+
```tsx
35+
import { YourType } from "your-package";
36+
37+
function processData(data: YourType) {
38+
// your code here
39+
}
40+
```
41+
42+
3. **Stay Updated**: Regularly check for updates to ensure you have the latest type definitions.
4443

4544
## Reporting Issues
4645

‎types/consumer-data-standards/banking/index.d.ts‎

Lines changed: 206 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -877,6 +877,34 @@ export interface BankingProductConstraint {
877877
}
878878
/* These are the schema definitions stipulated by the Data Standards Body for the banking api. */
879879

880+
/* These are the schema definitions stipulated by the Data Standards Body for the banking api. */
881+
882+
export interface BankingProductConstraintV2 {
883+
/**
884+
* Display text providing more information on the constraint.
885+
*/
886+
additionalInfo?: string | null;
887+
/**
888+
* Link to a web page with more information on the constraint.
889+
*/
890+
additionalInfoUri?: string | null;
891+
/**
892+
* Generic field containing additional information relevant to the [_constraintType_](#tocSproductconstrainttypedoc) specified. Whether mandatory or not is dependent on the value of [_constraintType_](#tocSproductconstrainttypedoc).
893+
*/
894+
additionalValue?: string | null;
895+
/**
896+
* The type of constraint described. For further details, refer to [Product Constraint Types](#tocSproductconstrainttypedoc).
897+
*/
898+
constraintType:
899+
| "MAX_BALANCE"
900+
| "MAX_LIMIT"
901+
| "MAX_LVR"
902+
| "MIN_BALANCE"
903+
| "MIN_LIMIT"
904+
| "MIN_LVR"
905+
| "OPENING_BALANCE";
906+
[k: string]: unknown;
907+
}
880908
export interface BankingProductDepositRate {
881909
/**
882910
* Display text providing more information on the rate.
@@ -1443,6 +1471,40 @@ export interface BankingProductDetailV4 extends BankingProductV4 {
14431471
}>;
14441472
[k: string]: unknown;
14451473
}
1474+
1475+
/* These are the schema definitions stipulated by the Data Standards Body for the banking api. */
1476+
1477+
export type BankingProductDetailV5 = BankingProductV4 & {
1478+
/**
1479+
* 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.
1480+
*/
1481+
bundles?: BankingProductBundle[] | null;
1482+
/**
1483+
* Array of features available for the product.
1484+
*/
1485+
features?: BankingProductFeatureV2[] | null;
1486+
/**
1487+
* Constraints on the application for or operation of the product such as minimum balances or limit thresholds.
1488+
*/
1489+
constraints?: BankingProductConstraintV2[] | null;
1490+
/**
1491+
* Eligibility criteria for the product.
1492+
*/
1493+
eligibility?: BankingProductEligibility[] | null;
1494+
/**
1495+
* Fees applicable for the product.
1496+
*/
1497+
fees?: BankingProductFee[] | null;
1498+
/**
1499+
* Interest rates available for deposits.
1500+
*/
1501+
depositRates?: BankingProductDepositRate[] | null;
1502+
/**
1503+
* Interest rates charged against lending balances.
1504+
*/
1505+
lendingRates?: BankingProductLendingRateV2[] | null;
1506+
[k: string]: unknown;
1507+
};
14461508
/* These are the schema definitions stipulated by the Data Standards Body for the banking api. */
14471509

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

2941+
export type BankingTransactionDetailV2 = BankingTransaction & {
2942+
extendedData: {
2943+
/**
2944+
* Label of the originating payer. Mandatory for inbound payment.
2945+
*/
2946+
payer?: string;
2947+
/**
2948+
* 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).
2949+
*/
2950+
payee?: string;
2951+
/**
2952+
* Optional extended data specific to transactions. Currently extended data is supported for NPP service overlays.
2953+
*/
2954+
extensionUType?: "nppPayload";
2955+
/**
2956+
* Required if the _extensionUType_ value is `nppPayload`.
2957+
*/
2958+
nppPayload?: {
2959+
/**
2960+
* An extended string description. Required if the _extensionUType_ value is `nppPayload`.
2961+
*/
2962+
extendedDescription?: string;
2963+
/**
2964+
* An end to end ID for the payment created at initiation.
2965+
*/
2966+
endToEndId?: string;
2967+
/**
2968+
* Purpose of the payment. Format is defined by the NPP standards for the NPP overlay services including Osko (X2P1).
2969+
*/
2970+
purposeCode?: string;
2971+
/**
2972+
* Identifier of the applicable overlay service. The _service_ is used in conjunction with the _serviceVersion_. See [here](#npp-services) for more details.
2973+
*/
2974+
service: "X2P1" | "IFTI" | "BSCT" | "CATSCT";
2975+
/**
2976+
* Two-digit NPP service overlay version with leading zero.
2977+
*/
2978+
serviceVersion: string;
2979+
[k: string]: unknown;
2980+
};
2981+
[k: string]: unknown;
2982+
};
2983+
[k: string]: unknown;
2984+
};
28792985
/**
28802986
* 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).
28812987
*/
@@ -3226,9 +3332,17 @@ export interface MetaPaginatedTransaction {
32263332
*/
32273333
isQueryParamUnsupported?: boolean | null;
32283334
}
3335+
3336+
/**
3337+
* Identifier of the applicable overlay service. The _service_ is used in conjunction with the _serviceVersion_. See [here](#npp-services) for more details.
3338+
*/
3339+
export type NppPaymentService = "X2P1" | "IFTI" | "BSCT" | "CATSCT";
32293340
/* These are the schema definitions stipulated by the Data Standards Body for the banking api. */
32303341
export interface RequestAccountIds {
32313342
data: {
3343+
/**
3344+
* Array of _accountId_ values.
3345+
*/
32323346
accountIds: string[];
32333347
[k: string]: unknown;
32343348
};
@@ -5412,6 +5526,45 @@ export interface ResponseBankingProductByIdV4 {
54125526
}
54135527
/* These are the schema definitions stipulated by the Data Standards Body for the banking api. */
54145528

5529+
/* These are the schema definitions stipulated by the Data Standards Body for the banking api. */
5530+
5531+
export interface ResponseBankingProductByIdV5 {
5532+
data: BankingProductV4 & {
5533+
/**
5534+
* 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.
5535+
*/
5536+
bundles?: BankingProductBundle[] | null;
5537+
/**
5538+
* Array of features available for the product.
5539+
*/
5540+
features?: BankingProductFeatureV2[] | null;
5541+
/**
5542+
* Constraints on the application for or operation of the product such as minimum balances or limit thresholds.
5543+
*/
5544+
constraints?: BankingProductConstraintV2[] | null;
5545+
/**
5546+
* Eligibility criteria for the product.
5547+
*/
5548+
eligibility?: BankingProductEligibility[] | null;
5549+
/**
5550+
* Fees applicable for the product.
5551+
*/
5552+
fees?: BankingProductFee[] | null;
5553+
/**
5554+
* Interest rates available for deposits.
5555+
*/
5556+
depositRates?: BankingProductDepositRate[] | null;
5557+
/**
5558+
* Interest rates charged against lending balances.
5559+
*/
5560+
lendingRates?: BankingProductLendingRateV2[] | null;
5561+
[k: string]: unknown;
5562+
};
5563+
links: Links;
5564+
meta?: null | Meta;
5565+
[k: string]: unknown;
5566+
}
5567+
54155568
export interface ResponseBankingProductListV2 {
54165569
data: {
54175570
/**
@@ -6460,6 +6613,58 @@ export interface ResponseBankingTransactionById {
64606613
}
64616614
/* These are the schema definitions stipulated by the Data Standards Body for the banking api. */
64626615

6616+
/* These are the schema definitions stipulated by the Data Standards Body for the banking api. */
6617+
6618+
export interface ResponseBankingTransactionByIdV2 {
6619+
data: BankingTransaction & {
6620+
extendedData: {
6621+
/**
6622+
* Label of the originating payer. Mandatory for inbound payment.
6623+
*/
6624+
payer?: string;
6625+
/**
6626+
* 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).
6627+
*/
6628+
payee?: string;
6629+
/**
6630+
* Optional extended data specific to transactions. Currently extended data is supported for NPP service overlays.
6631+
*/
6632+
extensionUType?: "nppPayload";
6633+
/**
6634+
* Required if the _extensionUType_ value is `nppPayload`.
6635+
*/
6636+
nppPayload?: {
6637+
/**
6638+
* An extended string description. Required if the _extensionUType_ value is `nppPayload`.
6639+
*/
6640+
extendedDescription?: string;
6641+
/**
6642+
* An end to end ID for the payment created at initiation.
6643+
*/
6644+
endToEndId?: string;
6645+
/**
6646+
* Purpose of the payment. Format is defined by the NPP standards for the NPP overlay services including Osko (X2P1).
6647+
*/
6648+
purposeCode?: string;
6649+
/**
6650+
* Identifier of the applicable overlay service. The _service_ is used in conjunction with the _serviceVersion_. See [here](#npp-services) for more details.
6651+
*/
6652+
service: "X2P1" | "IFTI" | "BSCT" | "CATSCT";
6653+
/**
6654+
* Two-digit NPP service overlay version with leading zero.
6655+
*/
6656+
serviceVersion: string;
6657+
[k: string]: unknown;
6658+
};
6659+
[k: string]: unknown;
6660+
};
6661+
[k: string]: unknown;
6662+
};
6663+
links: Links;
6664+
meta?: Meta;
6665+
[k: string]: unknown;
6666+
}
6667+
64636668
export interface ResponseBankingTransactionList {
64646669
data: {
64656670
transactions: Array<{
@@ -6579,11 +6784,11 @@ export interface ResponseBankingTransactionList {
65796784
* The total number of records in the full set. See [pagination](#pagination).
65806785
*/
65816786
totalRecords: number;
6582-
[k: string]: unknown;
65836787
/**
65846788
* true if "text" query parameter is not supported
65856789
*/
65866790
isQueryParamUnsupported?: boolean | null;
6791+
[k: string]: unknown;
65876792
};
65886793
[k: string]: unknown;
65896794
}

‎types/consumer-data-standards/common/index.d.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -173,15 +173,15 @@ export interface CommonOrganisationDetailV2 extends CommonOrganisation {
173173
*/
174174
thoroughfareNumber1?: number | null;
175175
/**
176-
* Suffix for the thoroughfare number. Only relevant is thoroughfareNumber1 is populated
176+
* Suffix for the thoroughfare number. Only relevant if _thoroughfareNumber1_ is populated
177177
*/
178178
thoroughfareNumber1Suffix?: string | null;
179179
/**
180180
* Second thoroughfare number (only used if the property has a ranged address eg 23-25)
181181
*/
182182
thoroughfareNumber2?: number | null;
183183
/**
184-
* Suffix for the second thoroughfare number. Only relevant is thoroughfareNumber2 is populated
184+
* Suffix for the second thoroughfare number. Only relevant if _thoroughfareNumber2_ is populated
185185
*/
186186
thoroughfareNumber2Suffix?: string | null;
187187
[k: string]: unknown;

‎types/consumer-data-standards/energy/index.d.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5125,7 +5125,7 @@ export interface EnergyPlanSolarFeedInTariffV3 {
51255125
*/
51265126
startDate?: string;
51275127
/**
5128-
* The type of the payer
5128+
* Reference to the applicable tariff structure
51295129
*/
51305130
tariffUType: "singleTariff" | "timeVaryingTariffs";
51315131
/**
@@ -5398,7 +5398,7 @@ export interface EnergyPlanTariffPeriodV2 {
53985398
*/
53995399
dailySupplyCharge?: string;
54005400
/**
5401-
* Specifies if daily supply charge is single or banded. Default value is SINGLE if field not provided
5401+
* Specifies if daily supply charge is single or banded.
54025402
*/
54035403
dailySupplyChargeType?: "SINGLE" | "BAND";
54045404
/**
@@ -5769,15 +5769,15 @@ export interface EnergyServicePointDetail {
57695769
*/
57705770
thoroughfareNumber1?: number | null;
57715771
/**
5772-
* Suffix for the thoroughfare number. Only relevant is thoroughfareNumber1 is populated
5772+
* Suffix for the thoroughfare number. Only relevant if _thoroughfareNumber1_ is populated
57735773
*/
57745774
thoroughfareNumber1Suffix?: string | null;
57755775
/**
57765776
* Second thoroughfare number (only used if the property has a ranged address eg 23-25)
57775777
*/
57785778
thoroughfareNumber2?: number | null;
57795779
/**
5780-
* Suffix for the second thoroughfare number. Only relevant is thoroughfareNumber2 is populated
5780+
* Suffix for the second thoroughfare number. Only relevant if _thoroughfareNumber2_ is populated
57815781
*/
57825782
thoroughfareNumber2Suffix?: string | null;
57835783
[k: string]: unknown;

‎types/consumer-data-standards/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"private": true,
33
"name": "@types/consumer-data-standards",
4-
"version": "7.2.9999",
4+
"version": "7.3.9999",
55
"nonNpm": true,
66
"nonNpmDescription": "consumer-data-standards-browser",
77
"projects": [

‎types/consumer-data-standards/register/index.d.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -758,7 +758,7 @@ export interface ResponseOpenIDProviderConfigMetadata {
758758
*/
759759
jwks_uri: string;
760760
/**
761-
* JSON array containing a list of the OAuth 2.0 response_type values that the CDR Registrer supports
761+
* JSON array containing a list of the OAuth 2.0 response_type values that the CDR Register supports
762762
*/
763763
response_types_supported: string[];
764764
/**

0 commit comments

Comments
 (0)