Shopvento Docs
Shopvento UI - v0.2.0
    Preparing search index...

    Interface DashboardProps

    Shared authenticated profile, transport, labels, routes and help used by dashboard components.

    interface DashboardProps {
        client: {
            addresses: (signal?: AbortSignal) => Promise<ShopUserShippingAddress[]>;
            booking: (
                value: string,
                signal?: AbortSignal,
            ) => Promise<ShopBookingOrderResponse>;
            bookings: (signal?: AbortSignal) => Promise<ShopBookingOrderResponse[]>;
            cancelReservation: (
                value: number,
            ) => Promise<CustomerTableReservationResponse>;
            createAddress: (
                body: ShopUserShippingAddressRequest,
            ) => Promise<ShopUserShippingAddress>;
            deleteAddress: (value: string) => Promise<Record<string, string>>;
            moveBooking: (
                value: string,
                body: ShopBookingMoveRequest,
            ) => Promise<unknown>;
            newsletterUnsubscribe: () => Promise<Record<string, string>>;
            orders: (signal?: AbortSignal) => Promise<ShopOrder[]>;
            reservation: (
                value: number,
                signal?: AbortSignal,
            ) => Promise<CustomerTableReservationResponse>;
            reservations: (
                signal?: AbortSignal,
            ) => Promise<CustomerTableReservationResponse[]>;
            updateAddress: (
                value: string,
                body: ShopUserShippingAddressRequest,
            ) => Promise<ShopUserShippingAddress>;
            updateEmail: (body: EmailChangeRequest) => Promise<Record<string, string>>;
            updatePassword: (
                body: PasswordUpdateRequest,
            ) => Promise<Record<string, string>>;
            updateProfile: (body: ShopUserProfileUpdate) => Promise<ShopUserProfile>;
            updateReservation: (
                value: number,
                body: CustomerTableReservationUpdate,
            ) => Promise<CustomerTableReservationResponse>;
            voucher: (
                value: string,
                signal?: AbortSignal,
            ) => Promise<ShopVoucherModel>;
            voucherHistory: (
                value: string,
                signal?: AbortSignal,
            ) => Promise<ShopVoucherHistoryEntry[]>;
            vouchers: (signal?: AbortSignal) => Promise<ShopVoucherModel[]>;
            withdraw: (
                value: string,
                body: WithdrawalSelectionRequest | null,
            ) => Promise<CancellationRequestResult>;
            withdrawalItems: (
                value: string,
                signal?: AbortSignal,
            ) => Promise<WithdrawalItemOption[]>;
        };
        eventImage?: (id: number) => string | undefined;
        help: AccountHelp;
        labels: AccountLabels;
        profile: ShopUserProfile;
        routes: AccountRoutes;
    }
    Index
    client eventImage? help labels profile routes
    client: {
        addresses: (signal?: AbortSignal) => Promise<ShopUserShippingAddress[]>;
        booking: (
            value: string,
            signal?: AbortSignal,
        ) => Promise<ShopBookingOrderResponse>;
        bookings: (signal?: AbortSignal) => Promise<ShopBookingOrderResponse[]>;
        cancelReservation: (
            value: number,
        ) => Promise<CustomerTableReservationResponse>;
        createAddress: (
            body: ShopUserShippingAddressRequest,
        ) => Promise<ShopUserShippingAddress>;
        deleteAddress: (value: string) => Promise<Record<string, string>>;
        moveBooking: (
            value: string,
            body: ShopBookingMoveRequest,
        ) => Promise<unknown>;
        newsletterUnsubscribe: () => Promise<Record<string, string>>;
        orders: (signal?: AbortSignal) => Promise<ShopOrder[]>;
        reservation: (
            value: number,
            signal?: AbortSignal,
        ) => Promise<CustomerTableReservationResponse>;
        reservations: (
            signal?: AbortSignal,
        ) => Promise<CustomerTableReservationResponse[]>;
        updateAddress: (
            value: string,
            body: ShopUserShippingAddressRequest,
        ) => Promise<ShopUserShippingAddress>;
        updateEmail: (body: EmailChangeRequest) => Promise<Record<string, string>>;
        updatePassword: (
            body: PasswordUpdateRequest,
        ) => Promise<Record<string, string>>;
        updateProfile: (body: ShopUserProfileUpdate) => Promise<ShopUserProfile>;
        updateReservation: (
            value: number,
            body: CustomerTableReservationUpdate,
        ) => Promise<CustomerTableReservationResponse>;
        voucher: (value: string, signal?: AbortSignal) => Promise<ShopVoucherModel>;
        voucherHistory: (
            value: string,
            signal?: AbortSignal,
        ) => Promise<ShopVoucherHistoryEntry[]>;
        vouchers: (signal?: AbortSignal) => Promise<ShopVoucherModel[]>;
        withdraw: (
            value: string,
            body: WithdrawalSelectionRequest | null,
        ) => Promise<CancellationRequestResult>;
        withdrawalItems: (
            value: string,
            signal?: AbortSignal,
        ) => Promise<WithdrawalItemOption[]>;
    }

    Stable client instance used for API requests.

    Type Declaration

    • addresses: (signal?: AbortSignal) => Promise<ShopUserShippingAddress[]>

      List customer shipping addresses.

    • booking: (value: string, signal?: AbortSignal) => Promise<ShopBookingOrderResponse>

      Read one customer booking by opaque identifier.

    • bookings: (signal?: AbortSignal) => Promise<ShopBookingOrderResponse[]>

      List customer event bookings. Optional signal cancels the read.

    • cancelReservation: (value: number) => Promise<CustomerTableReservationResponse>

      Cancel the supplied customer reservation.

    • createAddress: (body: ShopUserShippingAddressRequest) => Promise<ShopUserShippingAddress>

      Create a customer shipping address.

    • deleteAddress: (value: string) => Promise<Record<string, string>>

      Delete the selected customer shipping address.

    • moveBooking: (value: string, body: ShopBookingMoveRequest) => Promise<unknown>

      Reschedule a booking to the supplied backend timewindow identifier.

    • newsletterUnsubscribe: () => Promise<Record<string, string>>

      Revoke newsletter consent without a request body.

    • orders: (signal?: AbortSignal) => Promise<ShopOrder[]>

      List customer orders. Optional signal cancels the read.

    • reservation: (
          value: number,
          signal?: AbortSignal,
      ) => Promise<CustomerTableReservationResponse>

      Read a customer reservation by opaque identifier.

    • reservations: (signal?: AbortSignal) => Promise<CustomerTableReservationResponse[]>

      List customer table reservations.

    • updateAddress: (
          value: string,
          body: ShopUserShippingAddressRequest,
      ) => Promise<ShopUserShippingAddress>

      Replace the selected customer shipping address.

    • updateEmail: (body: EmailChangeRequest) => Promise<Record<string, string>>

      Request a confirmed account email change.

    • updatePassword: (body: PasswordUpdateRequest) => Promise<Record<string, string>>

      Change the account password.

    • updateProfile: (body: ShopUserProfileUpdate) => Promise<ShopUserProfile>

      Save changed customer profile fields.

    • updateReservation: (
          value: number,
          body: CustomerTableReservationUpdate,
      ) => Promise<CustomerTableReservationResponse>

      Patch only changed reservation fields.

    • voucher: (value: string, signal?: AbortSignal) => Promise<ShopVoucherModel>

      Read a customer voucher by opaque identifier.

    • voucherHistory: (value: string, signal?: AbortSignal) => Promise<ShopVoucherHistoryEntry[]>

      Read a customer voucher usage history.

    • vouchers: (signal?: AbortSignal) => Promise<ShopVoucherModel[]>

      List customer-owned vouchers.

    • withdraw: (
          value: string,
          body: WithdrawalSelectionRequest | null,
      ) => Promise<CancellationRequestResult>

      Request withdrawal for selected eligible quantities.

    • withdrawalItems: (value: string, signal?: AbortSignal) => Promise<WithdrawalItemOption[]>

      Read backend-authoritative withdrawal eligibility per order line.

    eventImage?: (id: number) => string | undefined

    Resolve an optional event image URL by identifier. Optional; omitted unless supplied by the host or backend.

    help: AccountHelp

    Host contact, opening hours and directions.

    labels: AccountLabels

    Host-owned copy overrides or account terminology.

    profile: ShopUserProfile

    Authoritative authenticated profile; null represents a guest.

    routes: AccountRoutes

    Host-owned account routes.

    Settings
    Member Visibility

    On This Page
    Properties