Skip to main content

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
  • 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


    ChargeDetail

    Supporting information about a charge

    Possible types

    Example

    SupplyOrServiceCharge

    Example

    ConcessionAlreadyExistsErrorType

    ContractParty

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

    Example

    AccountType









    Possible types

    Example

    DoesNotExistErrorType


    Example

    JoinSupplierProcessType

    Example

    SerializerErrorType


    Possible types

    Example

    DoesNotExistErrorType


    Example

    ReadingCreationErrorType

    Possible types

    Example

    InkNewMessage


    Example

    FractionSizeType

    ItemType

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

    Example

    TextType




    Possible types

    Example

    DoesNotExistErrorType




    OrderCustomerType

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

    Example

    AccountType

    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








    SalesRecordType

    A union type representing different kinds of sales records.

    Example

    KrakenDrivenSalesInfoType

    Example

    CardComponentType



    Example

    DuplicateNTCForStandingChargeErrorType

    Possible types

    Example

    InvalidContactDetails