mirror of
https://github.com/chenasraf/DefinitelyTyped.git
synced 2026-05-18 01:49:01 +00:00
🤖 Merge PR #65811 Added definitions to 1.24.0 by @tom-schier
* 1.19.0 changes, inheritance of interfaces * Added banking 1.22.1 * Updated dcr to 1.22.1 * Added energy 1.22.1 * Added energy_sdh 1.22.1 * Added basic telco definitions * Fixed lint problems * Bug fix in EnergyUsageRead * Applied comments and energy changes * Added v2 versions * Inc version number * More 1.24.0 updates * Added EnergyAccoutnDetailResponseV3 * Fixed lint problems --------- Co-authored-by: tom-schier <schiertxs@gmail.com>
This commit is contained in:
Tomas Schier
@@ -377,7 +377,7 @@ export interface RejectionMetricsV2 {
|
||||
[k: string]: unknown;
|
||||
};
|
||||
/**
|
||||
* Rejection counts for all uauthenticated end points
|
||||
* Rejection counts for all unauthenticated end points
|
||||
*/
|
||||
unauthenticated: {
|
||||
/**
|
||||
@@ -786,7 +786,7 @@ export interface ResponseMetricsListV3 {
|
||||
[k: string]: unknown;
|
||||
};
|
||||
/**
|
||||
* Rejection counts for all uauthenticated end points
|
||||
* Rejection counts for all unauthenticated end points
|
||||
*/
|
||||
unauthenticated: {
|
||||
/**
|
||||
@@ -824,7 +824,7 @@ export interface ResponseMetricsListV3 {
|
||||
[k: string]: unknown;
|
||||
};
|
||||
/**
|
||||
* Number of calls resulting in a rejection due to server execution over time
|
||||
* Number of calls rejected due to traffic thresholds over time
|
||||
*/
|
||||
rejections: {
|
||||
/**
|
||||
|
||||
85
types/consumer-data-standards/banking/index.d.ts
vendored
85
types/consumer-data-standards/banking/index.d.ts
vendored
@@ -722,63 +722,62 @@ export interface BankingAccountDetailV2 extends BankingAccount {
|
||||
[k: string]: unknown;
|
||||
}
|
||||
|
||||
export type BankingAccountDetailV3 = {
|
||||
/* This structure is used in the BankingAccountDetailV3.features property */
|
||||
export interface accV3DetailFeatureObj extends BankingProductFeatureV2 {
|
||||
isActivated?: boolean;
|
||||
}
|
||||
|
||||
export interface BankingAccountDetailV3 extends BankingAccountV2 {
|
||||
/**
|
||||
* A unique ID of the account adhering to the standards for ID permanence
|
||||
* The unmasked BSB for the account. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces
|
||||
*/
|
||||
accountId: string;
|
||||
bsb?: string;
|
||||
/**
|
||||
* Value indicating the number of customers that have ownership of the account, according to the data holder's definition of account ownership. Does not indicate that all account owners are eligible consumers
|
||||
* The unmasked account number for the account. Should not be supplied if the account number is a PAN requiring PCI compliance. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces
|
||||
*/
|
||||
accountOwnership: "UNKNOWN" | "ONE_PARTY" | "TWO_PARTY" | "MANY_PARTY" | "OTHER";
|
||||
accountNumber?: string;
|
||||
/**
|
||||
* Date that the account was created (if known)
|
||||
* Optional field to indicate if this account is part of a bundle that is providing additional benefit for to the customer
|
||||
*/
|
||||
creationDate?: string | null;
|
||||
bundleName?: string;
|
||||
/**
|
||||
* The display name of the account as defined by the bank. This should not incorporate account numbers or PANs. If it does the values should be masked according to the rules of the MaskedAccountString common type.
|
||||
* The type of structure to present account specific fields.
|
||||
*/
|
||||
displayName: string;
|
||||
specificAccountUType?: "creditCard" | "loan" | "termDeposit";
|
||||
termDeposit?: BankingTermDepositAccount[];
|
||||
creditCard?: BankingCreditCardAccount;
|
||||
loan?: BankingLoanAccountV2;
|
||||
/**
|
||||
* Flag indicating that the customer associated with the authorisation is an owner of the account. Does not indicate sole ownership, however. If not present then 'true' is assumed
|
||||
* current rate to calculate interest earned being applied to deposit balances as it stands at the time of the API call
|
||||
*/
|
||||
isOwned?: boolean | null;
|
||||
depositRate?: string;
|
||||
/**
|
||||
* A masked version of the account. Whether BSB/Account Number, Credit Card PAN or another number
|
||||
* The current rate to calculate interest payable being applied to lending balances as it stands at the time of the API call
|
||||
*/
|
||||
maskedNumber: string;
|
||||
lendingRate?: string;
|
||||
/**
|
||||
* A customer supplied nick name for the account
|
||||
* Fully described deposit rates for this account based on the equivalent structure in Product Reference
|
||||
*/
|
||||
nickname?: string | null;
|
||||
depositRates?: BankingProductDepositRate[];
|
||||
/**
|
||||
* Open or closed status for the account. If not present then OPEN is assumed
|
||||
* Fully described deposit rates for this account based on the equivalent structure in Product Reference
|
||||
*/
|
||||
openStatus?: ("CLOSED" | "OPEN") | null;
|
||||
lendingRates?: BankingProductLendingRateV2[];
|
||||
/**
|
||||
* The category to which a product or account belongs. See [here](#product-categories) for more details
|
||||
* Array of features of the account based on the equivalent structure in Product Reference with the following additional field
|
||||
*/
|
||||
productCategory:
|
||||
| "BUSINESS_LOANS"
|
||||
| "CRED_AND_CHRG_CARDS"
|
||||
| "LEASES"
|
||||
| "MARGIN_LOANS"
|
||||
| "OVERDRAFTS"
|
||||
| "PERS_LOANS"
|
||||
| "REGULATED_TRUST_ACCOUNTS"
|
||||
| "RESIDENTIAL_MORTGAGES"
|
||||
| "TERM_DEPOSITS"
|
||||
| "TRADE_FINANCE"
|
||||
| "TRANS_AND_SAVINGS_ACCOUNTS"
|
||||
| "TRAVEL_CARDS";
|
||||
features?: accV3DetailFeatureObj[];
|
||||
/**
|
||||
* The unique identifier of the account as defined by the data holder (akin to model number for the account)
|
||||
* Fees and charges applicable to the account based on the equivalent structure in Product Reference
|
||||
*/
|
||||
productName: string;
|
||||
fees?: BankingProductFee[];
|
||||
/**
|
||||
* The addresses for the account to be used for correspondence
|
||||
*/
|
||||
addresses?: CommonPhysicalAddress[];
|
||||
|
||||
[k: string]: unknown;
|
||||
} & {
|
||||
[k: string]: unknown;
|
||||
};
|
||||
}
|
||||
/* These are the schema definitions stipulated by the Data Standards Body for the banking api. */
|
||||
|
||||
export interface BankingAccountV2 {
|
||||
@@ -932,7 +931,7 @@ export interface BankingBillerPayee {
|
||||
*/
|
||||
billerName: string;
|
||||
/**
|
||||
* BPAY CRN of the Biller (if available).<br/>Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for MaskedPANString. If the contents are are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type.
|
||||
* BPAY CRN of the Biller (if available).<br/>Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for MaskedPANString. If the contents are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type.
|
||||
*/
|
||||
crn?: string | null;
|
||||
[k: string]: unknown;
|
||||
@@ -1256,7 +1255,7 @@ export interface BankingPayeeDetailV2 extends BankingPayeeV2 {
|
||||
*/
|
||||
billerName: string;
|
||||
/**
|
||||
* BPAY CRN of the Biller (if available).<br/>Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for MaskedPANString. If the contents are are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type.
|
||||
* BPAY CRN of the Biller (if available).<br/>Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for MaskedPANString. If the contents are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type.
|
||||
*/
|
||||
crn?: string | null;
|
||||
[k: string]: unknown;
|
||||
@@ -2919,7 +2918,7 @@ export interface BankingScheduledPayment {
|
||||
*/
|
||||
billerName: string;
|
||||
/**
|
||||
* BPAY CRN of the Biller (if available).<br/>Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for MaskedPANString. If the contents are are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type.
|
||||
* BPAY CRN of the Biller (if available).<br/>Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for MaskedPANString. If the contents are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type.
|
||||
*/
|
||||
crn?: string | null;
|
||||
[k: string]: unknown;
|
||||
@@ -3395,7 +3394,7 @@ export interface BankingScheduledPaymentSet {
|
||||
*/
|
||||
billerName: string;
|
||||
/**
|
||||
* BPAY CRN of the Biller (if available).<br/>Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for MaskedPANString. If the contents are are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type.
|
||||
* BPAY CRN of the Biller (if available).<br/>Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for MaskedPANString. If the contents are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type.
|
||||
*/
|
||||
crn?: string | null;
|
||||
[k: string]: unknown;
|
||||
@@ -3548,7 +3547,7 @@ export interface BankingScheduledPaymentTo {
|
||||
*/
|
||||
billerName: string;
|
||||
/**
|
||||
* BPAY CRN of the Biller (if available).<br/>Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for MaskedPANString. If the contents are are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type.
|
||||
* BPAY CRN of the Biller (if available).<br/>Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for MaskedPANString. If the contents are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type.
|
||||
*/
|
||||
crn?: string | null;
|
||||
[k: string]: unknown;
|
||||
@@ -5447,7 +5446,7 @@ export interface ResponseBankingPayeeByIdV2 {
|
||||
*/
|
||||
billerName: string;
|
||||
/**
|
||||
* BPAY CRN of the Biller (if available).<br/>Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for MaskedPANString. If the contents are are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type.
|
||||
* BPAY CRN of the Biller (if available).<br/>Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for MaskedPANString. If the contents are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type.
|
||||
*/
|
||||
crn?: string | null;
|
||||
[k: string]: unknown;
|
||||
@@ -6619,7 +6618,7 @@ export interface ResponseBankingScheduledPaymentsList {
|
||||
*/
|
||||
billerName: string;
|
||||
/**
|
||||
* BPAY CRN of the Biller (if available).<br/>Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for MaskedPANString. If the contents are are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type.
|
||||
* BPAY CRN of the Biller (if available).<br/>Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for MaskedPANString. If the contents are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type.
|
||||
*/
|
||||
crn?: string | null;
|
||||
[k: string]: unknown;
|
||||
|
||||
4
types/consumer-data-standards/dcr/index.d.ts
vendored
4
types/consumer-data-standards/dcr/index.d.ts
vendored
@@ -52,7 +52,7 @@ export type ClientRegistration = {
|
||||
*/
|
||||
grant_types: ("client_credentials" | "authorization_code" | "refresh_token")[];
|
||||
/**
|
||||
* JWE `alg` algorithm with which an id_token is to be encrypted
|
||||
* JWE `alg` algorithm with which an id_token is to be encrypted. Required if OIDC Hybrid Flow (response type `code id_token`) is registered.
|
||||
*/
|
||||
id_token_encrypted_response_alg: string;
|
||||
/**
|
||||
@@ -212,7 +212,7 @@ export interface RegistrationProperties {
|
||||
*/
|
||||
grant_types: ("client_credentials" | "authorization_code" | "refresh_token")[];
|
||||
/**
|
||||
* JWE `alg` algorithm with which an id_token is to be encrypted
|
||||
* JWE `alg` algorithm with which an id_token is to be encrypted. Required if OIDC Hybrid Flow (response type `code id_token`) is registered.
|
||||
*/
|
||||
id_token_encrypted_response_alg: string;
|
||||
/**
|
||||
|
||||
354
types/consumer-data-standards/energy/index.d.ts
vendored
354
types/consumer-data-standards/energy/index.d.ts
vendored
@@ -3221,6 +3221,13 @@ export interface EnergyAccountDetailResponseV2 {
|
||||
meta: Meta;
|
||||
[k: string]: unknown;
|
||||
}
|
||||
|
||||
export interface EnergyAccountDetailResponseV3 {
|
||||
data: EnergyAccountDetailV3;
|
||||
links: Links;
|
||||
meta: Meta;
|
||||
[k: string]: unknown;
|
||||
}
|
||||
/* These are the schema definitions stipulated by the Data Standards Body for the energy api. */
|
||||
|
||||
export interface EnergyAccountDetailV2 extends EnergyAccountBaseV2 {
|
||||
@@ -4638,6 +4645,116 @@ export interface EnergyAccountDetailV2 extends EnergyAccountBaseV2 {
|
||||
}[];
|
||||
[k: string]: unknown;
|
||||
}
|
||||
|
||||
export interface EnergyAccountDetailV3 extends EnergyAccountBaseV2 {
|
||||
/**
|
||||
* The array of plans containing service points and associated plan details
|
||||
*/
|
||||
plans: {
|
||||
/**
|
||||
* Optional display name for the plan provided by the customer to help differentiate multiple plans
|
||||
*/
|
||||
nickname?: string;
|
||||
/**
|
||||
* An array of servicePointIds, representing NMIs, that this account is linked to
|
||||
*/
|
||||
servicePointIds: string[];
|
||||
/**
|
||||
* Mandatory if openStatus is OPEN
|
||||
*/
|
||||
planOverview?: {
|
||||
/**
|
||||
* The name of the plan if one exists
|
||||
*/
|
||||
displayName?: string;
|
||||
/**
|
||||
* The start date of the applicability of this plan
|
||||
*/
|
||||
startDate: string;
|
||||
/**
|
||||
* The end date of the applicability of this plan
|
||||
*/
|
||||
endDate?: string;
|
||||
[k: string]: unknown;
|
||||
};
|
||||
/**
|
||||
* Detail on the plan applicable to this account. Mandatory if openStatus is OPEN
|
||||
*/
|
||||
planDetail?: {
|
||||
/**
|
||||
* The fuel types covered by the plan
|
||||
*/
|
||||
fuelType: "ELECTRICITY" | "GAS" | "DUAL";
|
||||
/**
|
||||
* Flag that indicates that the plan is contingent on the customer taking up an alternate fuel plan from the same retailer (for instance, if the fuelType is ELECTRICITY then a GAS plan from the same retailer must be taken up). Has no meaning if the plan has a fuelType of DUAL. If absent the value is assumed to be false
|
||||
*/
|
||||
isContingentPlan?: boolean;
|
||||
/**
|
||||
* Charges for metering included in the plan
|
||||
*/
|
||||
meteringCharges?: {
|
||||
/**
|
||||
* Display name of the charge
|
||||
*/
|
||||
displayName: string;
|
||||
/**
|
||||
* Description of the charge
|
||||
*/
|
||||
description?: string;
|
||||
/**
|
||||
* Minimum value of the charge if the charge is a range or the absolute value of the charge if no range is specified
|
||||
*/
|
||||
minimumValue: string;
|
||||
/**
|
||||
* The upper limit of the charge if the charge could occur in a range
|
||||
*/
|
||||
maximumValue?: string;
|
||||
/**
|
||||
* The charges that occur on a schedule indicates the frequency. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)
|
||||
*/
|
||||
period?: string;
|
||||
[k: string]: unknown;
|
||||
}[];
|
||||
/**
|
||||
* The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to GAS or DUAL
|
||||
*/
|
||||
gasContract?: EnergyPlanContractV2
|
||||
/**
|
||||
* The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to ELECTRICITY or DUAL
|
||||
*/
|
||||
electricityContract?: EnergyPlanContractV2
|
||||
[k: string]: unknown;
|
||||
};
|
||||
/**
|
||||
* An array of additional contacts that are authorised to act on this account
|
||||
*/
|
||||
authorisedContacts?: {
|
||||
/**
|
||||
* For people with single names this field need not be present. The single name should be in the lastName field
|
||||
*/
|
||||
firstName?: string;
|
||||
/**
|
||||
* For people with single names the single name should be in this field
|
||||
*/
|
||||
lastName: string;
|
||||
/**
|
||||
* Field is mandatory but array may be empty
|
||||
*/
|
||||
middleNames?: string[];
|
||||
/**
|
||||
* Also known as title or salutation. The prefix to the name (e.g. Mr, Mrs, Ms, Miss, Sir, etc)
|
||||
*/
|
||||
prefix?: string;
|
||||
/**
|
||||
* Used for a trailing suffix to the name (e.g. Jr)
|
||||
*/
|
||||
suffix?: string;
|
||||
[k: string]: unknown;
|
||||
}[];
|
||||
[k: string]: unknown;
|
||||
}[];
|
||||
[k: string]: unknown;
|
||||
}
|
||||
/* These are the schema definitions stipulated by the Data Standards Body for the energy api. */
|
||||
|
||||
export interface EnergyAccountListResponse {
|
||||
@@ -5952,7 +6069,7 @@ export interface EnergyInvoiceListResponse {
|
||||
|
||||
export interface EnergyPaymentSchedule {
|
||||
/**
|
||||
* Optional payment amount indicating that a constant payment amount is scheduled to be paid (used in bill smooting scenarios)
|
||||
* Optional payment amount indicating that a constant payment amount is scheduled to be paid (used in bill smoothing scenarios)
|
||||
*/
|
||||
amount?: string | null;
|
||||
/**
|
||||
@@ -6238,9 +6355,122 @@ export interface EnergyPlanContract {
|
||||
variation?: string | null;
|
||||
[k: string]: unknown;
|
||||
}
|
||||
|
||||
/* These are the schema definitions stipulated by the Data Standards Body for the energy api. */
|
||||
|
||||
export interface EnergyPlanContractFull extends EnergyPlanContract {
|
||||
export interface EnergyPlanContractV2 {
|
||||
/**
|
||||
* Free text field containing additional information of the fees for this contract
|
||||
*/
|
||||
additionalFeeInformation?: string | null;
|
||||
/**
|
||||
* Required if pricing model is SINGLE_RATE_CONT_LOAD or TIME_OF_USE_CONT_LOAD or FLEXIBLE_CONT_LOAD
|
||||
*/
|
||||
controlledLoad?: EnergyPlanControlledLoad[];
|
||||
/**
|
||||
* Optional list of discounts available for the contract
|
||||
*/
|
||||
discounts?: EnergyPlanDiscounts[];
|
||||
/**
|
||||
* Eligibility restrictions or requirements
|
||||
*/
|
||||
eligibility?: EnergyPlanEligibility[];
|
||||
/**
|
||||
* An array of fees applicable to the plan
|
||||
*/
|
||||
fees?: EnergyPlanFees[];
|
||||
/**
|
||||
* Optional list of charges applicable to green power
|
||||
*/
|
||||
greenPowerCharges?: EnergyPlanGreenPowerCharges[];
|
||||
/**
|
||||
* Optional list of incentives available for the contract
|
||||
*/
|
||||
incentives?: EnergyPlanIncentives[];
|
||||
/**
|
||||
* Describes intrinsic green power for the plan. If present then the plan includes a percentage of green power in the base plan. Should not be present for gas contracts
|
||||
*/
|
||||
intrinsicGreenPower?: {
|
||||
/**
|
||||
* Percentage of green power intrinsically included in the plan
|
||||
*/
|
||||
greenPercentage: string;
|
||||
[k: string]: unknown;
|
||||
} | null;
|
||||
/**
|
||||
* Flag indicating whether prices are fixed or variable
|
||||
*/
|
||||
isFixed: boolean;
|
||||
/**
|
||||
* Free text field that describes what will occur on or prior to expiry of the fixed contract term or benefit period
|
||||
*/
|
||||
onExpiryDescription?: string | null;
|
||||
/**
|
||||
* Payment options for this contract
|
||||
*/
|
||||
paymentOption: ("PAPER_BILL" | "CREDIT_CARD" | "DIRECT_DEBIT" | "BPAY" | "OTHER")[];
|
||||
/**
|
||||
* The pricing model for the contract. Contracts for gas must use SINGLE_RATE. Note that the detail for the enumeration values are:<ul><li>**SINGLE_RATE** - all energy usage is charged at a single unit rate no matter when it is consumed. Multiple unit rates may exist that correspond to varying volumes of usage i.e. a ‘block’ or ‘step’ tariff (first 50kWh @ X cents, next 50kWh at Y cents etc.</li><li>**SINGLE_RATE_CONT_LOAD** - as above, but with an additional, separate unit rate charged for all energy usage from a controlled load i.e. separately metered appliance like hot water service, pool pump etc.</li><li>**TIME_OF_USE** - energy usage is charged at unit rates that vary dependent on time of day and day of week that the energy is consumed</li><li>**TIME_OF_USE_CONT_LOAD** - as above, but with an additional, separate unit rate charged for all energy usage from a controlled load i.e. separately metered appliance like hot water service, pool pump etc.</li><li>**FLEXIBLE** - energy usage is charged at unit rates that vary based on external factors</li><li>**FLEXIBLE_CONT_LOAD** - as above, but with an additional, separate unit rate charged for all energy usage from a controlled load i.e. separately metered appliance like hot water service, pool pump etc.</li><li>**QUOTA** - all energy usage is charged at a single fixed rate, up to a specified usage quota/allowance. All excess usage beyond the allowance is then charged at a single unit rate (may not be the best way to explain it but it is essentially a ‘subscription’ or telco style product i.e. $50/month for up to 150kWh included usage</li></ul>
|
||||
*/
|
||||
pricingModel:
|
||||
| "SINGLE_RATE"
|
||||
| "SINGLE_RATE_CONT_LOAD"
|
||||
| "TIME_OF_USE"
|
||||
| "TIME_OF_USE_CONT_LOAD"
|
||||
| "FLEXIBLE"
|
||||
| "FLEXIBLE_CONT_LOAD"
|
||||
| "QUOTA";
|
||||
/**
|
||||
* Array of feed in tariffs for solar power
|
||||
*/
|
||||
solarFeedInTariff?: EnergyPlanSolarFeedInTariffV2[];
|
||||
/**
|
||||
* Array of tariff periods
|
||||
*/
|
||||
tariffPeriod: EnergyPlanTariffPeriod[];
|
||||
/**
|
||||
* Required if pricingModel is set to TIME_OF_USE. Defines the time zone to use for calculation of the time of use thresholds. Defaults to AEST if absent
|
||||
*/
|
||||
timeZone?: ("LOCAL" | "AEST") | null;
|
||||
/**
|
||||
* Free text description of price variation policy and conditions for the contract. Mandatory if `isFixed` is false
|
||||
*/
|
||||
variation?: string | null;
|
||||
[k: string]: unknown;
|
||||
}
|
||||
/* These are the schema definitions stipulated by the Data Standards Body for the energy api. */
|
||||
|
||||
export interface EnergyPlanContractFull extends EnergyPlanContractV2 {
|
||||
/**
|
||||
* The term for the contract. If absent assumes no specified term
|
||||
*/
|
||||
termType?: "1_YEAR" | "2_YEAR" | "3_YEAR" | "4_YEAR" | "5_YEAR" | "ONGOING" | "OTHER";
|
||||
/**
|
||||
* Description of the benefit period. Should only be present if termType has the value ONGOING
|
||||
*/
|
||||
benefitPeriod?: string;
|
||||
/**
|
||||
* Free text description of the terms for the contract
|
||||
*/
|
||||
terms?: string;
|
||||
/**
|
||||
* An array of the meter types that this contract is available for
|
||||
*/
|
||||
meterTypes?: string[];
|
||||
/**
|
||||
* Number of days in the cooling off period for the contract. Mandatory for plans with type of MARKET
|
||||
*/
|
||||
coolingOffDays?: number;
|
||||
/**
|
||||
* An array of the available billing schedules for this contract. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)
|
||||
*/
|
||||
billFrequency: string[];
|
||||
[k: string]: unknown;
|
||||
}
|
||||
|
||||
/* These are the schema definitions stipulated by the Data Standards Body for the energy api. */
|
||||
|
||||
export interface EnergyPlanContractFullV2 extends EnergyPlanContractV2 {
|
||||
/**
|
||||
* The term for the contract. If absent assumes no specified term
|
||||
*/
|
||||
@@ -6434,6 +6664,46 @@ export interface EnergyPlanDetail extends EnergyPlan {
|
||||
}
|
||||
/* These are the schema definitions stipulated by the Data Standards Body for the energy api. */
|
||||
|
||||
export interface EnergyPlanDetailV2 extends EnergyPlan {
|
||||
/**
|
||||
* Charges for metering included in the plan
|
||||
*/
|
||||
meteringCharges?: {
|
||||
/**
|
||||
* Display name of the charge
|
||||
*/
|
||||
displayName: string;
|
||||
/**
|
||||
* Description of the charge
|
||||
*/
|
||||
description?: string;
|
||||
/**
|
||||
* Minimum value of the charge if the charge is a range or the absolute value of the charge if no range is specified
|
||||
*/
|
||||
minimumValue: string;
|
||||
/**
|
||||
* The upper limit of the charge if the charge could occur in a range
|
||||
*/
|
||||
maximumValue?: string;
|
||||
/**
|
||||
* The charges that occur on a schedule indicates the frequency. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)
|
||||
*/
|
||||
period?: string;
|
||||
[k: string]: unknown;
|
||||
};
|
||||
/**
|
||||
* The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to GAS or DUAL
|
||||
*/
|
||||
gasContract?: EnergyPlanContractFullV2;
|
||||
/**
|
||||
* The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to ELECTRICITY or DUAL
|
||||
*/
|
||||
electricityContract?: EnergyPlanContractFullV2;
|
||||
[k: string]: unknown;
|
||||
}
|
||||
|
||||
/* These are the schema definitions stipulated by the Data Standards Body for the energy api. */
|
||||
|
||||
/**
|
||||
* Optional list of discounts available for the contract
|
||||
*/
|
||||
@@ -6694,11 +6964,12 @@ export interface EnergyPlanListResponse {
|
||||
/* These are the schema definitions stipulated by the Data Standards Body for the energy api. */
|
||||
|
||||
export interface EnergyPlanResponse {
|
||||
data: EnergyPlanResponse;
|
||||
data: EnergyPlanDetail;
|
||||
links: LinksPaginated;
|
||||
meta?: MetaPaginated | null;
|
||||
[k: string]: unknown;
|
||||
}
|
||||
|
||||
/* These are the schema definitions stipulated by the Data Standards Body for the energy api. */
|
||||
|
||||
/**
|
||||
@@ -6769,6 +7040,83 @@ export interface EnergyPlanSolarFeedInTariff {
|
||||
};
|
||||
[k: string]: unknown;
|
||||
}
|
||||
|
||||
/**
|
||||
* Array of feed in tariffs for solar power
|
||||
*/
|
||||
export interface EnergyPlanSolarFeedInTariffV2 {
|
||||
/**
|
||||
* A description of the tariff
|
||||
*/
|
||||
description?: string;
|
||||
/**
|
||||
* The name of the tariff
|
||||
*/
|
||||
displayName: string;
|
||||
/**
|
||||
* The type of the payer
|
||||
*/
|
||||
payerType: "GOVERNMENT" | "RETAILER";
|
||||
/**
|
||||
* The applicable scheme
|
||||
*/
|
||||
scheme: "PREMIUM" | "OTHER";
|
||||
/**
|
||||
* Represents a constant tariff. Mandatory if tariffUType is set to singleTariff
|
||||
*/
|
||||
singleTariff?: {
|
||||
/**
|
||||
* Array of feed in rates
|
||||
*/
|
||||
rates: {
|
||||
measureUnit?: "KWH"|"KVA"|"KVAR"|"KVARH"|"KW"|"DAYS"|"METER"|"MONTH";
|
||||
unitPrice: string;
|
||||
volume?: number;
|
||||
}[];
|
||||
[k: string]: unknown;
|
||||
};
|
||||
/**
|
||||
* The type of the payer
|
||||
*/
|
||||
tariffUType: "singleTariff" | "timeVaryingTariffs";
|
||||
/**
|
||||
* Represents a tariff based on time. Mandatory if tariffUType is set to timeVaryingTariffs
|
||||
*/
|
||||
timeVaryingTariffs?: {
|
||||
/**
|
||||
* The tariff amount
|
||||
*/
|
||||
rates: {
|
||||
measureUnit?: "KWH"|"KVA"|"KVAR"|"KVARH"|"KW"|"DAYS"|"METER"|"MONTH";
|
||||
unitPrice: string;
|
||||
volume?: number;
|
||||
}[];
|
||||
/**
|
||||
* Array of time periods for which this tariff is applicable
|
||||
*/
|
||||
timeVariations: {
|
||||
/**
|
||||
* The days that the tariff applies to. At least one entry required
|
||||
*/
|
||||
days: ("SUN" | "MON" | "TUE" | "WED" | "THU" | "FRI" | "SAT" | "PUBLIC_HOLIDAYS")[];
|
||||
/**
|
||||
* The end of the time period per day for which the tariff applies. If absent assumes end of day (ie. one second before midnight)
|
||||
*/
|
||||
endTime?: string;
|
||||
/**
|
||||
* The beginning of the time period per day for which the tariff applies. If absent assumes start of day (ie. midnight)
|
||||
*/
|
||||
startTime?: string;
|
||||
[k: string]: unknown;
|
||||
}[];
|
||||
/**
|
||||
* The type of the charging time period. If absent applies to all periods
|
||||
*/
|
||||
type?: "PEAK" | "OFF_PEAK" | "SHOULDER";
|
||||
[k: string]: unknown;
|
||||
};
|
||||
[k: string]: unknown;
|
||||
}
|
||||
/* These are the schema definitions stipulated by the Data Standards Body for the energy api. */
|
||||
|
||||
/**
|
||||
|
||||
2
types/consumer-data-standards/index.d.ts
vendored
2
types/consumer-data-standards/index.d.ts
vendored
@@ -1,4 +1,4 @@
|
||||
// Type definitions for non-npm package consumer-data-standards-browser 5.0
|
||||
// Type definitions for non-npm package consumer-data-standards-browser 6.0
|
||||
// Project: https://github.com/ConsumerDataStandardsAustralia
|
||||
// Definitions by: Tomas Schier <https://github.com/tom-schier>
|
||||
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
||||
|
||||
Reference in New Issue
Block a user