About Unions
Unions are abstract types that can be used to return one of a number of different objects. They are useful for defining a common set of fields that objects can implement.
Example
EmailEventTypeActionType
Actions are things to do upon a user interaction, such as tapping a button.
Possible types
Example
DeeplinkActionTypeExample
AlternativeNumberValidationErrorTypeBackendScreenType
A backend screen is the top-level container for mobile UI.
Example
ComponentListTypeExample
DoesNotExistErrorTypePossible types
Example
HouseMoveInCancelExceptionErrorTypeCardItemType
Items are sections making up a card.
Example
TextTypeExample
StringCharacteristicValueTypePossible types
Example
ConcessionAlreadyExistsErrorTypeContractParty
Union type representing the subject that entered into a contract, either an Account or Business.
Possible types
Example
AccountTypePossible types
Example
NoSupplyPointsAssociatedWithMirnErrorTypePossible types
Example
MirnAlreadyExistsErrorTypePossible types
Example
AccountUserCanNotFoundErrorTypePossible types
Example
DoesNotExistErrorTypePossible types
- CreateUserProfileEventAndPublishAccountNumberNotProvidedError
- CreateUserProfileEventAndPublishUserIdNotProvidedError
- CreateUserProfileEventAndPublishFinalBillNotFoundError
- CreateUserProfileEventAndPublishOtherValidationError
- CreateUserProfileEventAndPublishClientError
- AccountNotFound
- UserNotFound
- InvalidUserID
Example
CreateUserProfileEventAndPublishAccountNumberNotProvidedErrorPossible types
Example
DoesNotExistErrorTypePossible types
Example
ProductDoesNotExistPossible types
Example
ElectricityAccumulationMeterReadingTypePossible types
- UnsupportedBrandErrorType
- MeterPointIdentifierInvalidErrorType
- AsOfDateInvalidErrorType
- AccountUserIsNotEligibleErrorType
- ProductCodeNotFoundErrorType
- FailedToRetrieveQuoteErrorType
- NoMatchingPropertyFromNMIErrorType
- NoMatchingAccountFoundErrorType
- CanNotCreateAgreementErrorType
- FailedToSwitchProductForAccountErrorType
- CannotProductSwitchOnUnrelatedAccountError
- CannotProductSwitchWithoutLoyaltyCardError
- AccountDoesNotHaveEmailErrorType
- InvalidAddonErrorType
Example
UnsupportedBrandErrorTypePossible types
Example
JoinSupplierProcessTypePossible types
Example
OutOfBoundsPaymentDayErrorTypePossible types
- UnsupportedBrandErrorType
- UserNotFound
- PropertyNotFound
- MissingActiveAgreement
- AsOfDateInvalidErrorType
- AccountUserIsNotEligibleErrorType
- NoMatchingAccountFoundErrorType
- MissingActiveGasSupplyPoint
- WrongMarket
- QuotingNoSupplyPointsFoundOnProperty
- QuotingTermsAndConditionsCanNotBeFound
- QuotingNoSuitableProductsFound
- QuotingUnsupportedMarket
- QuotingEmbeddedProperty
- ProductCodeNotInQuote
- CannotProductSwitchOnUnrelatedAccountError
- CannotProductSwitchWithoutLoyaltyCardError
- InvalidAddonErrorType
- CanNotCreateAgreementErrorType
Example
UnsupportedBrandErrorTypePossible types
Example
ReadingCreationErrorTypePossible types
Example
InkEmailItemType
Items are sections making up a screen. They can be different types, hence Union.
Example
TextTypeLegacyOrderCustomerType
Union type representing a customer, either an account or a business.
Possible types
Example
AccountTypeLegacyOrderLinePeriodType
Union type representing either a date range or a duration for an order line period.
Possible types
Example
LegacyOrderLineDateRangeTypeExample
LineLinkRedirectResponsePossible types
Example
MIRNDiscoveryRequestAlreadyTriggeredErrorTypePossible types
Example
DoesNotExistErrorTypePossible types
Example
BothHouseAndLotNumberErrorTypePossible types
Example
AEMOAPIUnavailableErrorTypePossible types
Example
PaymentPromiseTypePaymentPreferenceUnion
One of PreferredInstructionType or UserManagedPaymentType
Possible types
Example
PreferredInstructionPossible types
- PredictedBillBasicMeterNotSupportedErrorType
- PredictedBillFailedToDeterminePeriodErrorType
- PredictedBillFixedBillingNotSupportedErrorType
- PredictedBillTenantNotFoundErrorType
- PredictedBillReadingNotFoundErrorType
- PredictedBillBasicMetersRequiredOnQuarantineType
- PredictedBillCannotCalculateBillMissingNetworkTariffCodeType
- DuplicateNTCForStandingChargeErrorType
- RangeTooWideErrorType
Example
PredictedBillBasicMeterNotSupportedErrorTypePossible types
Example
DoesNotExistErrorTypePossible types
Example
DoesNotExistErrorTypePossible types
Example
DoesNotExistErrorTypePossible types
Example
DecimalTypePossible types
Example
MultipleMeterpointsValidationErrorTypePossible types
- ExceededMaxSchedulableWorkingDaysErrorType
- MissingPaymentDetailsErrorType
- InvalidVendorForRescheduleErrorType
- InvalidStatusForRescheduleErrorType
- CannotRescheduleForFixedPaymentCustomerErrorType
- CannotRescheduleForReRepresentedPaymentsErrorType
- CannotRescheduleWithMissingAccountStatementErrorType
- CannotRescheduleWithMoreThenOneRescheduledPaymentErrorType
- InvalidTransactionErrorType
- NoRelatedPaymentSchedulesOnPaymentDateErrorType
- UnableToMatchPaymentDateToLedgerSchedulesErrorType
Example
ExceededMaxSchedulableWorkingDaysErrorTypeSalesRecordType
A union type representing different kinds of sales records.
Example
KrakenDrivenSalesInfoTypeExample
ElectricityServiceOrderTypeExample
SpecialCircumstanceRecordTypePossible types
Example
DuplicateNTCForStandingChargeErrorTypePossible types
Example
UnableToDeterminePhoneContactDetailsErrorTypePossible types
Example
CouldNotStartWorkflowErrorTypePossible types
Example
LineUnlinkedResponsePossible types
Example
DoesNotExistErrorTypePossible types
Example
AccountUserCanNotFoundErrorTypePossible types
Example
DoesNotExistErrorTypePossible types
Example
ElectricityFiltersOutput