Constructors

  • Parameters

    • args:
          | string
          | {
              branches?: string[];
              checkin?: {
                  [key: string]: {
                      checkins?: { counterName?: string; id: string; time: string }[];
                      deleted?: string[];
                  };
              };
              companions?: | {
                  isCompanion?: true;
                  mainGuestId: string;
                  mainGuestName?: string;
              }
              | { companionNames?: { [key: string]: string }; isCompanion?: false };
              deleted?: boolean;
              id: string;
              language: null | string;
              payment?:
                  | null
                  | {
                      amount: number;
                      currency?: "USD"
                      | "EUR"
                      | "CHF";
                      paid: boolean;
                      provider:
                          | "manual"
                          | "sepa"
                          | "credit"
                          | "bank_transfer"
                          | "paypal"
                          | "stripe";
                      reference?: null
                      | string;
                      testmode: boolean;
                      title?: null | string;
                  };
              rsvp?: {
                  [key: string]: | null
                  | {
                      checkinCounters?: string[];
                      personCount: number;
                      tieBreaker?: string;
                      time: null
                      | string;
                  };
              };
              tags?: string[];
              time?: string;
              userdata?: {
                  [key: string]: | null
                  | string
                  | number
                  | boolean
                  | string[]
                  | { file: string; name: string; size: number };
              };
          }
          | AttendeeJSON
      • string
      • {
            branches?: string[];
            checkin?: {
                [key: string]: {
                    checkins?: { counterName?: string; id: string; time: string }[];
                    deleted?: string[];
                };
            };
            companions?: | {
                isCompanion?: true;
                mainGuestId: string;
                mainGuestName?: string;
            }
            | { companionNames?: { [key: string]: string }; isCompanion?: false };
            deleted?: boolean;
            id: string;
            language: null | string;
            payment?:
                | null
                | {
                    amount: number;
                    currency?: "USD"
                    | "EUR"
                    | "CHF";
                    paid: boolean;
                    provider:
                        | "manual"
                        | "sepa"
                        | "credit"
                        | "bank_transfer"
                        | "paypal"
                        | "stripe";
                    reference?: null
                    | string;
                    testmode: boolean;
                    title?: null | string;
                };
            rsvp?: {
                [key: string]: | null
                | {
                    checkinCounters?: string[];
                    personCount: number;
                    tieBreaker?: string;
                    time: null
                    | string;
                };
            };
            tags?: string[];
            time?: string;
            userdata?: {
                [key: string]: | null
                | string
                | number
                | boolean
                | string[]
                | { file: string; name: string; size: number };
            };
        }
        • Optionalbranches?: string[]
          []
          
        • Optionalcheckin?: {
              [key: string]: {
                  checkins?: { counterName?: string; id: string; time: string }[];
                  deleted?: string[];
              };
          }

          Checkin

          {}
          
        • Optionalcompanions?:
              | { isCompanion?: true; mainGuestId: string; mainGuestName?: string }
              | { companionNames?: { [key: string]: string }; isCompanion?: false }
          {
          * "isCompanion": false,
          * "companionNames": {}
          * }
        • Optionaldeleted?: boolean

          Deleted

          false
          
        • id: string

          Id

        • language: null | string

          Language

        • Optionalpayment?:
              | null
              | {
                  amount: number;
                  currency?: "USD"
                  | "EUR"
                  | "CHF";
                  paid: boolean;
                  provider:
                      | "manual"
                      | "sepa"
                      | "credit"
                      | "bank_transfer"
                      | "paypal"
                      | "stripe";
                  reference?: null
                  | string;
                  testmode: boolean;
                  title?: null | string;
              }
        • Optionalrsvp?: {
              [key: string]:
                  | null
                  | {
                      checkinCounters?: string[];
                      personCount: number;
                      tieBreaker?: string;
                      time: null
                      | string;
                  };
          }

          Rsvp

          {}
          
        • Optionaltags?: string[]
          []
          
        • Optionaltime?: string

          Time Format: date-time

        • Optionaluserdata?: {
              [key: string]:
                  | null
                  | string
                  | number
                  | boolean
                  | string[]
                  | { file: string; name: string; size: number };
          }

          Userdata

          {}
          
      • AttendeeJSON

    Returns Attendee

Properties

branches: Set<string> = ...
checkin: Map<string, Checkins> = ...
companions:
    | {
        companionNames?: { [attendeeId: string]: string };
        isCompanion: false;
    }
    | { isCompanion: true; mainGuestId: string; mainGuestName: string } = ...
deleted: boolean = false
id: string
language: null | string = null
name: undefined | string
payment:
    | null
    | {
        amount: number;
        currency?: "USD"
        | "EUR"
        | "CHF";
        paid: boolean;
        provider:
            | "manual"
            | "sepa"
            | "credit"
            | "bank_transfer"
            | "paypal"
            | "stripe";
        reference?: null
        | string;
        testmode: boolean;
        title?: null | string;
    } = null

Type declaration

  • null
  • {
        amount: number;
        currency?: "USD" | "EUR" | "CHF";
        paid: boolean;
        provider:
            | "manual"
            | "sepa"
            | "credit"
            | "bank_transfer"
            | "paypal"
            | "stripe";
        reference?: null
        | string;
        testmode: boolean;
        title?: null | string;
    }
    • amount: number

      Amount

    • Optionalcurrency?: "USD" | "EUR" | "CHF"

      Currency

      CHF
      @enum {string}
    • paid: boolean

      Paid

    • provider: "manual" | "sepa" | "credit" | "bank_transfer" | "paypal" | "stripe"

      Provider

    • Optionalreference?: null | string

      Reference

    • testmode: boolean

      Testmode

    • Optionaltitle?: null | string

      Title

rsvp: Map<string, null | Rsvp> = ...
tags: Set<string> = ...
time: Date
userdata: Map<
    string,
    | null
    | string
    | number
    | boolean
    | string[]
    | { file: string; name: string; size: number },
> = ...

Methods

  • Parameters

    • args: { branchName: string; checkin: Checkin }

    Returns Attendee

  • Parameters

    • args: { branchName: string; checkinId: string }

    Returns Attendee

  • Parameters

    • branchName: string
    • counterName: string

    Returns number

  • Parameters

    • branchName: string

    Returns Checkins

  • Parameters

    • fieldKey: string

    Returns undefined | boolean

  • Parameters

    • fieldKey: string
    • fallback: boolean

    Returns boolean

  • Parameters

    • fieldKey: string

    Returns undefined | number

  • Parameters

    • fieldKey: string
    • fallback: number

    Returns number

  • Parameters

    • fieldKey: string
    • fallback: string = ''

    Returns string

  • Parameters

    • fieldKey: string

    Returns string

    Use getFieldString instead

  • Parameters

    • branchName: string
    • counterName: string

    Returns "no-response" | "negative-response" | "positive-response"

  • Parameters

    • branchName: string

    Returns "no-response" | "negative-response" | "positive-response"

  • Parameters

    • branchName: string
    • counterName: string

    Returns number

  • Parameters

    • branchName: string

    Returns number

  • Returns string

  • Parameters

    • updates: {
          branches?: string[];
          companions?:
              | { isCompanion?: true; mainGuestId: string; mainGuestName?: string }
              | { companionNames?: { [key: string]: string }; isCompanion?: false };
          deletedBranches?: string[];
          deletedTags?: string[];
          language?: string;
          partialPayment?: {
              amount?: number;
              currency?: "USD" | "EUR" | "CHF";
              paid?: boolean;
              provider?:
                  | "manual"
                  | "sepa"
                  | "credit"
                  | "bank_transfer"
                  | "paypal"
                  | "stripe";
          };
          payment?: | null
          | {
              amount: number;
              currency?: "USD"
              | "EUR"
              | "CHF";
              paid: boolean;
              provider:
                  | "manual"
                  | "sepa"
                  | "credit"
                  | "bank_transfer"
                  | "paypal"
                  | "stripe";
              reference?: null
              | string;
              testmode: boolean;
              title?: null | string;
          };
          rsvp?: {
              [key: string]: | null
              | {
                  checkinCounters?: string[];
                  personCount: number;
                  tieBreaker?: string;
                  time: null
                  | string;
              };
          };
          tags?: string[];
          userdata?: {
              [key: string]: | null
              | string
              | number
              | boolean
              | string[]
              | { file: string; name: string; size: number };
          };
      }
      • Optionalbranches?: string[]

        Branches

      • Optionalcompanions?:
            | { isCompanion?: true; mainGuestId: string; mainGuestName?: string }
            | { companionNames?: { [key: string]: string }; isCompanion?: false }
      • OptionaldeletedBranches?: string[]

        Deletedbranches

      • OptionaldeletedTags?: string[]

        Deletedtags

      • Optionallanguage?: string

        Language

      • OptionalpartialPayment?: {
            amount?: number;
            currency?: "USD" | "EUR" | "CHF";
            paid?: boolean;
            provider?:
                | "manual"
                | "sepa"
                | "credit"
                | "bank_transfer"
                | "paypal"
                | "stripe";
        }
        • Optionalamount?: number

          Amount

        • Optionalcurrency?: "USD" | "EUR" | "CHF"

          Currency

        • Optionalpaid?: boolean

          Paid

        • Optionalprovider?: "manual" | "sepa" | "credit" | "bank_transfer" | "paypal" | "stripe"

          Provider

      • Optionalpayment?:
            | null
            | {
                amount: number;
                currency?: "USD"
                | "EUR"
                | "CHF";
                paid: boolean;
                provider:
                    | "manual"
                    | "sepa"
                    | "credit"
                    | "bank_transfer"
                    | "paypal"
                    | "stripe";
                reference?: null
                | string;
                testmode: boolean;
                title?: null | string;
            }
      • Optionalrsvp?: {
            [key: string]:
                | null
                | {
                    checkinCounters?: string[];
                    personCount: number;
                    tieBreaker?: string;
                    time: null
                    | string;
                };
        }

        Rsvp

      • Optionaltags?: string[]

        Tags

      • Optionaluserdata?: {
            [key: string]:
                | null
                | string
                | number
                | boolean
                | string[]
                | { file: string; name: string; size: number };
        }

        Userdata

    Returns Attendee

  • creates a bse36 encoded uuid we use base36 encoding because it is more human readable and also shorter so it fits better into an QR-Code

    Parameters

    • prefix: string

      A prefix - ussually the 1st 3 letters of the instance name are used

    Returns string

    base36 encoded uuid string