Unions

In this section

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.

  • API Site

    • ActionType

    Actions are things to do upon a user interaction, such as tapping a button.

    Example

    DeeplinkActionType

    BackendScreenType

    A backend screen is the top-level container for mobile UI.

    Example

    ComponentListType

    CardItemType

    Items are sections making up a card.

    Example

    TextType

    ChargeDetail

    Supporting information about a charge

    Possible types

    Example

    SupplyOrServiceCharge

    ContractParty

    Union type representing the subject that entered into a contract, either an Account or Business.

    Possible types

    Example

    Account

    CreateBankTransferPaymentMethodResponse

    Returned when a customer creates a bank transfer payment method from their MyPage.

    Example

    BankTransferPaymentMethodCreated

    CreateKonbiniPaymentMethodResponse

    Returned when a customer creates a Konbini Payment method from their MyPage.

    Example

    KonbiniPaymentMethodCreated

    CreateKonbiniPaymentResponse

    Returned when a customer creates a Konbini Payment from their MyPage.

    Example

    KonbiniPaymentCreated

    CreatePaymentScheduleResponse

    Returned when a customer creates a fixed payment schedule from their MyPage.

    Example

    PaymentScheduleCreated

    Example

    JoinSupplierProcessType

    Example

    SerializerErrorType

    InitiateAmperageChangeResponse

    Returned when a customer initiates an Amperage Change from their MyPage.

    Example

    AmperageChangeInitiated

    Example

    MoveInSuccess

    InitiateMoveOutAndMoveInResponse

    Returned when a customer initiates a Move Out and MoveIn from their MyPage.

    Example

    MoveOutAndMoveInInitiated

    InitiateMoveOutResponse

    Returned when a customer initiates a Move Out from their MyPage.

    Example

    MoveOutInitiated

    Possible types

    Example

    InkNewMessage

    Example

    Integration

    Example

    FractionSizeType

    ItemType

    Items are sections making up a screen. They can be different types, hence Union.

    Example

    TextType

    LegacyOrderCustomerType

    Union type representing a customer, either an account or a business.

    Possible types

    Example

    Account

    LegacyOrderLinePeriodType

    Union type representing either a date range or a duration for an order line period.

    Example

    LegacyOrderLineDateRangeType

    PaymentPreferenceUnion

    One of PreferredInstructionType or UserManagedPaymentType

    Example

    PreferredInstruction

    QuotedSupplyPoint

    DEPRECATED - A single quoted supply point for a customers quote request.

    Example

    QuotedElectricitySupplyPoint

    RegisterDemandResponseCampaignParticipantResponse

    Returned when a customer registers for a Demand Response campaign.

    Example

    RegisterDemandResponseCampaignParticipantRegistered

    SalesRecordType

    A union type representing different kinds of sales records.

    Example

    KrakenDrivenSalesInfoType

    Example

    CardComponentType

    StoreRefundBankAccountResponse

    Returned when a customer stores a refund bank account from their MyPage.

    Example

    RefundBankAccountStored

    SuggestFixedPaymentAmountResponse

    Returned when a customer creates a fixed payment schedule from their MyPage.

    Example

    FixedPaymentAmountSuggested

    SwitchInCorrectionResponse

    Returned when a customer self-services a correction of switch-in data.

    Example

    SwitchInCorrectionPerformed

    SwitchToProductWithFixedFuelCostAdjustmentResponse

    Returned when a customer switches to the fixed FCA product on the consumer site.

    Example

    ProductWithFixedFuelCostAdjustmentSwitched