Class Attendee

constructor

• new Attendee(
      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,
  ): Attendee

  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[]

        Default

        []
        Copy

      • Optionalcheckin?: {
            [key: string]: {
                checkins?: { counterName?: string; id: string; time: string }[];
                deleted?: string[];
            };
        }

        Checkin

        Default

        {}
        Copy

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

        Default

        {
               *   "isCompanion": false,
               *   "companionNames": {}
               * }
        Copy

      • Optionaldeleted?: boolean

        Deleted

        Default

        false
        Copy

      • 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

        Default

        {}
        Copy

      • Optionaltags?: string[]

        Default

        []
        Copy

      • Optionaltime?: string

        Time Format: date-time

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

        Userdata

        Default

        {}
        Copy

    • AttendeeJSON

  Returns Attendee

branches

checkin

companions

deleted

id

language

Readonlyname

payment

rsvp

tags

time

userdata

addCheckinForBranch

• addCheckinForBranch(args: { branchName: string; checkin: Checkin }): Attendee

  Parameters

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

  Returns Attendee

deleteCheckinForBranch

• deleteCheckinForBranch(
      args: { branchName: string; checkinId: string },
  ): Attendee

  Parameters

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

  Returns Attendee

getCheckinCount

• getCheckinCount(branchName: string, counterName: string): number

  Parameters

  • branchName: string
  • counterName: string

  Returns number

getCheckinsForBranch

• getCheckinsForBranch(branchName: string): Checkins

  Parameters

  • branchName: string

  Returns Checkins

getFieldFlag

• getFieldFlag(fieldKey: string): undefined | boolean

  Parameters

  • fieldKey: string

  Returns undefined | boolean

• getFieldFlag(fieldKey: string, fallback: boolean): boolean

  Parameters

  • fieldKey: string
  • fallback: boolean

  Returns boolean

getFieldNumber

• getFieldNumber(fieldKey: string): undefined | number

  Parameters

  • fieldKey: string

  Returns undefined | number

• getFieldNumber(fieldKey: string, fallback: number): number

  Parameters

  • fieldKey: string
  • fallback: number

  Returns number

getFieldString

• getFieldString(fieldKey: string, fallback?: string): string

  Parameters

  • fieldKey: string
  • fallback: string = ''

  Returns string

getFieldValueString

• getFieldValueString(fieldKey: string): string

  Parameters

  • fieldKey: string

  Returns string

  Deprecated

  Use getFieldString instead

getResponse

• getResponse(
      branchName: string,
      counterName: string,
  ): "no-response" | "negative-response" | "positive-response"

  Parameters

  • branchName: string
  • counterName: string

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

getResponseForBranch

• getResponseForBranch(
      branchName: string,
  ): "no-response" | "negative-response" | "positive-response"

  Parameters

  • branchName: string

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

getRsvpCount

• getRsvpCount(branchName: string, counterName: string): number

  Parameters

  • branchName: string
  • counterName: string

  Returns number

getRsvpCountForBranch

• getRsvpCountForBranch(branchName: string): number

  Parameters

  • branchName: string

  Returns number

hash

• hash(): string

  Returns string

toJSON

• toJSON(): AttendeeJSON

  Returns AttendeeJSON

withUpdates

• withUpdates(
      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 };
          };
      },
  ): Attendee

  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

StaticgenerateID

• generateID(prefix: string): string

  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