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.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

  • API Site

    • Example

    EmailEventType

    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

    Example

    StringCharacteristicValueType

    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

    DemandResponseCampaignParticipantCommsPreferencesUpdated

    Example

    JoinSupplierProcessType

    Example

    SerializerErrorType

    InitiateAmperageChangeResponse

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

    Possible types

    Example

    AmperageChangeInitiated

    Possible types

    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

    Possible types

    Example

    Integration

    Example

    FractionSizeType

    ItemType

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

    Example

    TextType

    Example

    LineTextMessage

    OrderCustomerType

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

    Possible types

    Example

    Account

    OrderLinePeriodType

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

    Example

    OrderLineDateRangeType

    PaymentPreferenceUnion

    One of PreferredInstructionType or UserManagedPaymentType

    Example

    PreferredInstruction

    Example

    {
  "code": "order-police-report-just-stock",
  "fullName": "information-be-such-help-recognize",
  "displayName": "ball-safe-develop-away-night",
  "description": "control-third-two-billion-despite",
  "availableFrom": "2017-01-08T08:44:14.395435+00:00",
  "availableTo": "1999-10-23T01:13:50.997947+00:00",
  "isHidden": true,
  "term": 68,
  "endsAt": "1988-07-17T11:43:21.851353+00:00",
  "marketName": "draw-American-theory-life-suffer",
  "availabilityStatus": "PUBLIC",
  "termsContractType": "experience-leave-question-court-fish",
  "params": {"key": "value"},
  "hasMinimumTerm": true,
  "minimumTerm": 98,
  "noticePeriod": 93,
  "priceGuaranteeInMonths": 72,
  "priceGuaranteeType": "NONE",
  "isTimeOfUse": true,
  "contractBindingStart": "WITH_CONTRACT_CONFIRMATION"
}

    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

    Example

    SmartFlexChargingError

    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

    Example

    DemandResponseCampaignParticipantTipUpdated