You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This fork of the [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped) repository contains specialised type definitions for the Consumer Data Standards (CDS) to support TypeScript projects within the CDR ecosystem. These definitions are aligned with the published [Consumer Data Standards](https://consumerdatastandardsaustralia.github.io/standards/#introduction), ensuring accurate interface representations for CDR API structures.
6
+
7
+
## Using the Type Definitions
8
+
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.
10
+
11
+
This tool:
12
+
13
+
- is maintained regularly to ensure compatibility with the latest Consumer Data Standards.
14
+
- assists Data Holders with regulatory adherence by providing TypeScript type enforcement that reduces errors, increases code quality, and improves development efficiency.
15
+
16
+
## Quick Start Guide
17
+
18
+
Please follow these steps to integrate the CDR-specific type definitions into your TypeScript projects:
19
+
20
+
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
+
32
+
2. **Usage**: Utilise the types in your TypeScript code as needed:
33
+
34
+
```tsx
35
+
import { YourType } from 'your-package';
36
+
37
+
functionprocessData(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.
43
+
44
+
45
+
## Reporting Issues
46
+
47
+
Encountered an issue? We're here to help. Please visit our [issue reporting guidelines](https://d61cds.notion.site/Issue-Reporting-Guidelines-71a329a0658c4b69a232eab95822509b?pvs=4) for submitting an issue.
48
+
49
+
## Stay Updated
50
+
51
+
Join our newsletter to receive the latest updates, release notes, and alerts. [Subscribe here](https://consumerdatastandards.us18.list-manage.com/subscribe?u=fb3bcb1ec5662d9767ab3c414&id=a4414b3906).
52
+
53
+
## Disclaimer
54
+
55
+
The artefacts in this repository are offered without warranty or liability, in accordance with the [MIT licence.](https://github.com/ConsumerDataStandardsAustralia/java-artefacts/blob/master/LICENSE)
56
+
57
+
[The Data Standards Body](https://consumerdatastandards.gov.au/about/) (DSB) develops these artefacts in the course of its work, in order to perform quality assurance on the Australian Consumer Data Right Standards (Data Standards).
58
+
59
+
The DSB makes this repository, and its artefacts, public [on a non-commercial basis](https://github.com/ConsumerDataStandardsAustralia/java-artefacts/blob/master/LICENSE) in the interest of supporting the participants in the CDR ecosystem.
60
+
61
+
The resources of the DSB are primarily directed towards assisting the [Data Standards Chair](https://consumerdatastandards.gov.au/about/) for [developing the Data Standards](https://github.com/ConsumerDataStandardsAustralia/standards).
62
+
63
+
Consequently, the development work provided on the artefacts in this repository is on a best-effort basis, and the DSB acknowledges the use of these tools alone is not sufficient for, nor should they be relied upon with respect to [accreditation](https://www.accc.gov.au/focus-areas/consumer-data-right-cdr-0/cdr-draft-accreditation-guidelines), conformance, or compliance purposes.
* Percentage of calls within the performance threshold for the specified hour. 0.0 means 0%. 1.0 means 100%. Must be a positive value or zero
949
+
*/
950
+
exporttypePerformanceHours=string;
946
951
/* These are the schema definitions stipulated by the Data Standards Body for the admin api. */
947
952
953
+
/**
954
+
* Array of contiguous hourly metrics for the specified day. Each element represents a 1 hour period starting from 12am-1am. Timezone for determining 12am must be consistent but is at the discretion of the Data Holder
* Percentage of calls within the performance thresholds
979
+
* Percentage of calls within Primary Data Holder performance thresholds. Note that Secondary Data Holder performance <b>MUST</b> be excluded from this metric.
* Percentage of calls within the performance threshold for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. 0.0 means 0%. 1.0 means 100%. Values must be a positive or zero
* Percentage of calls within the performance threshold for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. 0.0 means 0%. 1.0 means 100%. Values must be a positive or zero
* Percentage of calls within the performance threshold for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. 0.0 means 0%. 1.0 means 100%. Values must be a positive or zero
* Percentage of calls within the performance threshold for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. 0.0 means 0%. 1.0 means 100%. Values must be a positive or zero
* Percentage of calls within the performance threshold for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. 0.0 means 0%. 1.0 means 100%. Values must be a positive or zero
* Percentage of calls within the performance threshold for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. 0.0 means 0%. 1.0 means 100%. Values must be a positive or zero
* Percentage of calls within the performance threshold for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. 0.0 means 0%. 1.0 means 100%. Values must be a positive or zero
* Percentage of calls within the performance threshold for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. 0.0 means 0%. 1.0 means 100%. Values must be a positive or zero
* Percentage of calls within the performance threshold for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. 0.0 means 0%. 1.0 means 100%. Values must be a positive or zero
1116
1126
*/
1117
-
previousDays?: string[][]|null;
1127
+
previousDays?: PerformancePreviousDays[]|null;
1118
1128
[k: string]: unknown;
1119
1129
};
1120
1130
[k: string]: unknown;
1121
1131
}
1122
-
/* These are the schema definitions stipulated by the Data Standards Body for the admin api. */
1123
-
1124
1132
/**
1125
1133
* Number of calls rejected due to traffic thresholds over time
0 commit comments