Class API

api client for the enter backend

Hierarchy

default
- API

Index

Attendees

getAttendee

getAttendee(
    args: {
        attendeeId: string;
        includeDeleted?: boolean;
        instanceName: string;
    },
    options?: FetchOptions,
): Promise<APIResult<Attendee>>
Parameters
- args: { attendeeId: string; includeDeleted?: boolean; instanceName: string }
- options: FetchOptions = {}
Returns Promise<APIResult<Attendee>>
- Defined in api-client/index.ts:147

getAttendeeList

getAttendeeList(
    args: {
        filter?: string;
        includeDeleted?: boolean;
        instanceName: string;
    },
    options?: FetchOptions,
): Promise<APIResult<Attendee[]>>
Parameters
- args: { filter?: string; includeDeleted?: boolean; instanceName: string }
- options: FetchOptions = {}
Returns Promise<APIResult<Attendee[]>>
- Defined in api-client/index.ts:116

getCompanions

getCompanions(
    args: {
        attendeeId: string;
        includeDeleted?: boolean;
        instanceName: string;
    },
    options?: FetchOptions,
): Promise<APIResult<Attendee[]>>
Parameters
- args: { attendeeId: string; includeDeleted?: boolean; instanceName: string }
- options: FetchOptions = {}
Returns Promise<APIResult<Attendee[]>>
- Defined in api-client/index.ts:173

Auth

logout

logout(): Promise<void>
Returns Promise<void>
Inherited from APIBase.logout
- Defined in api-client/api-base.ts:283

`Static`fetchAccessToken

fetchAccessToken(
    args: {
        oidc: { projectId: string; url: string };
        user: { key: string; keyId: string; userId: string };
    },
): Promise<Result<string, { accessToken: string; expires: Date }>>
Parameters
- args: {
  oidc: { projectId: string; url: string };
  user: { key: string; keyId: string; userId: string };
  }
Returns Promise<Result<string, { accessToken: string; expires: Date }>>
Inherited from APIBase.fetchAccessToken
- Defined in api-client/api-base.ts:70

Counts

calculateCustomCounts

calculateCustomCounts(
    args: {
        counter: { filter: string; name: string }[];
        instanceName: string;
    },
    options?: FetchOptions,
): Promise<APIResult<{ [key: string]: number }>>
Get the number of guests for multiple custom filters. e.g. all guests that don't eat meat. This way you don't have to fetch the whole guestlist to calculate those counts.
Parameters
- args: { counter: { filter: string; name: string }[]; instanceName: string }
  - counter: { filter: string; name: string }[]
    A list of CustomCounters. You have to give each of your counts a name name and a filter
  - instanceName: string
- options: FetchOptions = {}
Returns Promise<APIResult<{ [key: string]: number }>>
Example
```
api.calculateCustomCounts({
  instanceName: 'my-instance',
  counter: [
    {
      name: 'vegetarians',
      filter: '&(user.has_food_restriction checked, user.is_vegetatian checked)'
    },
    {
      name: 'other-restrictions',
      filter: '&(user.has_food_restriction checked, user.is_vegetatian unchecked)'
    }
  ]
})
```
- Defined in api-client/index.ts:98

getCheckinCounts

getCheckinCounts(
args: { instanceName: string },
options?: FetchOptions,
): Promise<APIResult<CheckinCounts>>
Parameters
- args: { instanceName: string }
- options: FetchOptions = {}
Returns Promise<APIResult<CheckinCounts>>
- Defined in api-client/index.ts:64

Emails

getRenderedEmail

getRenderedEmail(
    args: {
        attendeeId: string;
        emailName: string;
        instanceName: string;
        mailingId?: null | string;
    },
    options?: FetchOptions,
): Promise<
    APIResult<
        {
            htmlContent: null
            | string;
            plaintextContent: string;
            subject: string;
        },
    >,
>
Parameters
- args: {
      attendeeId: string;
      emailName: string;
      instanceName: string;
      mailingId?: null | string;
  }
- options: FetchOptions = {}
Returns Promise<
    APIResult<
        {
            htmlContent: null
            | string;
            plaintextContent: string;
            subject: string;
        },
    >,
>
- Defined in api-client/index.ts:351

sendEmail

sendEmail(
args: { attendeeId: string; emailName: string; instanceName: string },
options?: FetchOptions,
): Promise<APIResult<null>>
Parameters
- args: { attendeeId: string; emailName: string; instanceName: string }
- options: FetchOptions = {}
Returns Promise<APIResult<null>>
- Defined in api-client/index.ts:330

Events

createEvents

createEvents(
    args: (
        | {
            attendeeId: string;
            event?: "attendee-auth-code-requested";
            id?: string;
            instanceName: string;
        }
        | {
            attendee: {
                branches?: string[];
                checkin?: {
                    [key: string]: {
                        checkins?: {
                            counterName?: (...)
                            | (...);
                            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 };
                };
            };
            event?: "attendee-created";
            id?: string;
            instanceName: string;
        }
        | {
            attendeeId: string;
            event?: "attendee-deleted";
            final: boolean;
            id?: string;
            instanceName: string;
        }
        | {
            attendeeId: string;
            event?: "attendee-responded";
            id?: string;
            instanceName: string;
            isEdit: boolean;
            responseTime?: string;
            rsvp: {
                [key: string]: | null
                | {
                    checkinCounters?: string[];
                    personCount: number;
                    tieBreaker?: string;
                    time: null
                    | string;
                };
            };
        }
        | {
            attendeeId: string;
            event?: "attendee-updated";
            id?: string;
            instanceName: string;
            time?: string;
            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 };
                };
            };
        }
        | {
            attendeeId: string;
            branchName: string;
            checkin: { counterName?: string; id: string; time: string };
            event?: "checkin-created";
            id?: string;
            instanceName: string;
        }
        | {
            attendeeId: string;
            branchName: string;
            checkinId: string;
            event?: "checkin-deleted";
            id?: string;
            instanceName: string;
        }
        | {
            attendeeId: string;
            emailStatus: {
                clicks?: string[];
                clients?: string[];
                mailing_id: string;
                reason?: string
                | string[];
                status:
                    | "pending"
                    | "waiting"
                    | "submitted"
                    | "skipped"
                    | "sent"
                    | "opened"
                    | "clicked"
                    | "invalid"
                    | "rejected"
                    | "unsubscribed";
                time?: null
                | string;
                updated_at?: string;
            };
            event?: "email-status-updated";
            id?: string;
            instanceName: string;
            mailId: string;
        }
        | {
            attendeeId: string;
            emailAddress: string;
            emailName: string;
            event?: "email-unsubscribed";
            id?: string;
            instanceName: string;
        }
        | {
            attendeeId: string;
            event?: "payment-paid";
            id?: string;
            instanceName: string;
            provider?: | null
            | "manual"
            | "sepa"
            | "credit"
            | "bank_transfer"
            | "paypal"
            | "stripe";
        }
    )[],
    options?: FetchOptions,
): Promise<APIResult<null>>
Parameters
- args: (
      | {
          attendeeId: string;
          event?: "attendee-auth-code-requested";
          id?: string;
          instanceName: string;
      }
      | {
          attendee: {
              branches?: string[];
              checkin?: {
                  [key: string]: {
                      checkins?: { counterName?: (...)
                      | (...); 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 };
              };
          };
          event?: "attendee-created";
          id?: string;
          instanceName: string;
      }
      | {
          attendeeId: string;
          event?: "attendee-deleted";
          final: boolean;
          id?: string;
          instanceName: string;
      }
      | {
          attendeeId: string;
          event?: "attendee-responded";
          id?: string;
          instanceName: string;
          isEdit: boolean;
          responseTime?: string;
          rsvp: {
              [key: string]: | null
              | {
                  checkinCounters?: string[];
                  personCount: number;
                  tieBreaker?: string;
                  time: null
                  | string;
              };
          };
      }
      | {
          attendeeId: string;
          event?: "attendee-updated";
          id?: string;
          instanceName: string;
          time?: string;
          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 };
              };
          };
      }
      | {
          attendeeId: string;
          branchName: string;
          checkin: { counterName?: string; id: string; time: string };
          event?: "checkin-created";
          id?: string;
          instanceName: string;
      }
      | {
          attendeeId: string;
          branchName: string;
          checkinId: string;
          event?: "checkin-deleted";
          id?: string;
          instanceName: string;
      }
      | {
          attendeeId: string;
          emailStatus: {
              clicks?: string[];
              clients?: string[];
              mailing_id: string;
              reason?: string
              | string[];
              status:
                  | "pending"
                  | "waiting"
                  | "submitted"
                  | "skipped"
                  | "sent"
                  | "opened"
                  | "clicked"
                  | "invalid"
                  | "rejected"
                  | "unsubscribed";
              time?: null
              | string;
              updated_at?: string;
          };
          event?: "email-status-updated";
          id?: string;
          instanceName: string;
          mailId: string;
      }
      | {
          attendeeId: string;
          emailAddress: string;
          emailName: string;
          event?: "email-unsubscribed";
          id?: string;
          instanceName: string;
      }
      | {
          attendeeId: string;
          event?: "payment-paid";
          id?: string;
          instanceName: string;
          provider?: | null
          | "manual"
          | "sepa"
          | "credit"
          | "bank_transfer"
          | "paypal"
          | "stripe";
      }
  )[]
  - {
        attendeeId: string;
        event?: "attendee-auth-code-requested";
        id?: string;
        instanceName: string;
    }
    attendeeId: string
    Attendeeid
    
    Optionalevent?: "attendee-auth-code-requested"
    Event
    
    Default
    attendee-auth-code-requested
    
    Constant
    Optionalid?: string
    Id Format: uuid
    
    instanceName: string
    Instancename
  - {
        attendee: {
            branches?: string[];
            checkin?: {
                [key: string]: {
                    checkins?: { counterName?: (...) | (...); 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 };
            };
        };
        event?: "attendee-created";
        id?: string;
        instanceName: string;
    }
    attendee: {
        branches?: string[];
        checkin?: {
            [key: string]: {
                checkins?: { counterName?: (...) | (...); 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
    []
    
    Optionalcheckin?: {
        [key: string]: {
            checkins?: { counterName?: (...) | (...); id: string; time: string }[];
            deleted?: string[];
        };
    }
    Checkin
    
    Default
    {}
    
    Optionalcompanions?:
        | { isCompanion?: true; mainGuestId: string; mainGuestName?: string }
        | { companionNames?: { [key: string]: string }; isCompanion?: false }
    Default
    { * "isCompanion": false, * "companionNames": {} * }
    
    Optionaldeleted?: boolean
    Deleted
    
    Default
    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
    
    Default
    {}
    
    Optionaltags?: string[]
    Default
    []
    
    Optionaltime?: string
    Time Format: date-time
    
    Optionaluserdata?: {
        [key: string]:
            | null
            | string
            | number
            | boolean
            | string[]
            | { file: string; name: string; size: number };
    }
    Userdata
    
    Default
    {}
    
    Optionalevent?: "attendee-created"
    Event
    
    Default
    attendee-created
    
    Constant
    Optionalid?: string
    Id Format: uuid
    
    instanceName: string
    Instancename
  - {
        attendeeId: string;
        event?: "attendee-deleted";
        final: boolean;
        id?: string;
        instanceName: string;
    }
    attendeeId: string
    Attendeeid
    
    Optionalevent?: "attendee-deleted"
    Event
    
    Default
    attendee-deleted
    
    Constant
    final: boolean
    Final
    
    Optionalid?: string
    Id Format: uuid
    
    instanceName: string
    Instancename
  - {
        attendeeId: string;
        event?: "attendee-responded";
        id?: string;
        instanceName: string;
        isEdit: boolean;
        responseTime?: string;
        rsvp: {
            [key: string]:
                | null
                | {
                    checkinCounters?: string[];
                    personCount: number;
                    tieBreaker?: string;
                    time: null
                    | string;
                };
        };
    }
    attendeeId: string
    Attendeeid
    
    Optionalevent?: "attendee-responded"
    Event
    
    Default
    attendee-responded
    
    Constant
    Optionalid?: string
    Id Format: uuid
    
    instanceName: string
    Instancename
    
    isEdit: boolean
    Isedit
    
    OptionalresponseTime?: string
    Responsetime Format: date-time
    
    rsvp: {
        [key: string]:
            | null
            | {
                checkinCounters?: string[];
                personCount: number;
                tieBreaker?: string;
                time: null
                | string;
            };
    }
    Rsvp
  - {
        attendeeId: string;
        event?: "attendee-updated";
        id?: string;
        instanceName: string;
        time?: string;
        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 };
            };
        };
    }
    attendeeId: string
    Attendeeid
    
    Optionalevent?: "attendee-updated"
    Event
    
    Default
    attendee-updated
    
    Constant
    Optionalid?: string
    Id Format: uuid
    
    instanceName: string
    Instancename
    
    Optionaltime?: string
    Time Format: date-time
    
    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
  - {
        attendeeId: string;
        branchName: string;
        checkin: { counterName?: string; id: string; time: string };
        event?: "checkin-created";
        id?: string;
        instanceName: string;
    }
    attendeeId: string
    Attendeeid
    
    branchName: string
    Branchname
    
    checkin: { counterName?: string; id: string; time: string }
    OptionalcounterName?: string
    Countername
    
    Default
    main
    
    id: string
    Id Format: uuid
    
    time: string
    Time Format: date-time
    
    Optionalevent?: "checkin-created"
    Event
    
    Default
    checkin-created
    
    Constant
    Optionalid?: string
    Id Format: uuid
    
    instanceName: string
    Instancename
  - {
        attendeeId: string;
        branchName: string;
        checkinId: string;
        event?: "checkin-deleted";
        id?: string;
        instanceName: string;
    }
    attendeeId: string
    Attendeeid
    
    branchName: string
    Branchname
    
    checkinId: string
    Checkinid Format: uuid
    
    Optionalevent?: "checkin-deleted"
    Event
    
    Default
    checkin-deleted
    
    Constant
    Optionalid?: string
    Id Format: uuid
    
    instanceName: string
    Instancename
  - {
        attendeeId: string;
        emailStatus: {
            clicks?: string[];
            clients?: string[];
            mailing_id: string;
            reason?: string | string[];
            status:
                | "pending"
                | "waiting"
                | "submitted"
                | "skipped"
                | "sent"
                | "opened"
                | "clicked"
                | "invalid"
                | "rejected"
                | "unsubscribed";
            time?: null
            | string;
            updated_at?: string;
        };
        event?: "email-status-updated";
        id?: string;
        instanceName: string;
        mailId: string;
    }
    attendeeId: string
    Attendeeid
    
    emailStatus: {
        clicks?: string[];
        clients?: string[];
        mailing_id: string;
        reason?: string | string[];
        status:
            | "pending"
            | "waiting"
            | "submitted"
            | "skipped"
            | "sent"
            | "opened"
            | "clicked"
            | "invalid"
            | "rejected"
            | "unsubscribed";
        time?: null
        | string;
        updated_at?: string;
    }
    Optionalclicks?: string[]
    Description
    for clicked events a url can be provided (those will be merged with clicks from prevois events)
    
    Optionalclients?: string[]
    Description
    for open events a set of email clients can be added (those will be merged with clients from prevois states)
    
    mailing_id: string
    Mailing Id
    
    Description
    the unique id of the bulk or single mailing
    
    Optionalreason?: string | string[]
    Reason
    
    Description
    for error states a reason can be added to the event (reasons will be merged with reasons from prevoius errors)
    
    status:
        | "pending"
        | "waiting"
        | "submitted"
        | "skipped"
        | "sent"
        | "opened"
        | "clicked"
        | "invalid"
        | "rejected"
        | "unsubscribed"
    Status
    
    Optionaltime?: null | string
    Time
    
    Description
    the time the email was sent (this should only be set when setting the status to 'sent')
    
    Optionalupdated_at?: string
    Updated At Format: date-time
    
    Optionalevent?: "email-status-updated"
    Event
    
    Default
    email-status-updated
    
    Constant
    Optionalid?: string
    Id Format: uuid
    
    instanceName: string
    Instancename
    
    mailId: string
    Mailid
  - {
        attendeeId: string;
        emailAddress: string;
        emailName: string;
        event?: "email-unsubscribed";
        id?: string;
        instanceName: string;
    }
    attendeeId: string
    Attendeeid
    
    emailAddress: string
    Emailaddress
    
    emailName: string
    Emailname
    
    Optionalevent?: "email-unsubscribed"
    Event
    
    Default
    email-unsubscribed
    
    Constant
    Optionalid?: string
    Id Format: uuid
    
    instanceName: string
    Instancename
  - {
        attendeeId: string;
        event?: "payment-paid";
        id?: string;
        instanceName: string;
        provider?:
            | null
            | "manual"
            | "sepa"
            | "credit"
            | "bank_transfer"
            | "paypal"
            | "stripe";
    }
    attendeeId: string
    Attendeeid
    
    Optionalevent?: "payment-paid"
    Event
    
    Default
    payment-paid
    
    Constant
    Optionalid?: string
    Id Format: uuid
    
    instanceName: string
    Instancename
    
    Optionalprovider?: null | "manual" | "sepa" | "credit" | "bank_transfer" | "paypal" | "stripe"
    Provider
- options: FetchOptions = {}
Returns Promise<APIResult<null>>
- Defined in api-client/index.ts:379

Fields

getFields

getFields(
args: { instanceName: string },
options?: FetchOptions,
): Promise<APIResult<FieldGroups>>
Parameters
- args: { instanceName: string }
- options: FetchOptions = {}
Returns Promise<APIResult<FieldGroups>>
- Defined in api-client/index.ts:49

Instances

getInstance

getInstance(
args: { instanceName: string },
options?: FetchOptions,
): Promise<APIResult<Instance>>
Parameters
- args: { instanceName: string }
- options: FetchOptions = {}
Returns Promise<APIResult<Instance>>
- Defined in api-client/index.ts:34

getInstanceList

getInstanceList(options?: FetchOptions): Promise<APIResult<Instance[]>>
Parameters
- options: FetchOptions = {}
Returns Promise<APIResult<Instance[]>>
- Defined in api-client/index.ts:21

Other

constructor

new API(
    args: {
        credentials: APICredentials;
        deviceName: string;
        onLogout: (reason?: string) => void;
        requesterId: string;
    },
): API
Parameters
- args: {
      credentials: APICredentials;
      deviceName: string;
      onLogout: (reason?: string) => void;
      requesterId: string;
  }
Returns API
Inherited from APIBase.constructor
- Defined in api-client/api-base.ts:42

`Protected`delete

delete<Path extends keyof paths>(
endpoint: Path,
options: FetchOptions,
): Promise<APIResult<ResponseType<Path, "delete">>>
Type Parameters
- Path extends keyof paths
Parameters
- endpoint: Path
- options: FetchOptions
Returns Promise<APIResult<ResponseType<Path, "delete">>>
Inherited from APIBase.delete
- Defined in api-client/api-base.ts:266

`Protected`get

get<Path extends keyof paths>(
endpoint: Path,
options: FetchOptions,
): Promise<APIResult<ResponseType<Path, "get">>>
Type Parameters
- Path extends keyof paths
Parameters
- endpoint: Path
- options: FetchOptions
Returns Promise<APIResult<ResponseType<Path, "get">>>
Inherited from APIBase.get
- Defined in api-client/api-base.ts:207

`Protected`patch

patch<Path extends keyof paths>(
    endpoint: Path,
    data: RequestBody<Path, "patch">,
    options: FetchOptions,
): Promise<APIResult<ResponseType<Path, "patch">>>
Type Parameters
- Path extends keyof paths
Parameters
- endpoint: Path
- data: RequestBody<Path, "patch">
- options: FetchOptions
Returns Promise<APIResult<ResponseType<Path, "patch">>>
Inherited from APIBase.patch
- Defined in api-client/api-base.ts:251

`Protected`post

post<Path extends keyof paths>(
    endpoint: Path,
    data: RequestBody<Path, "post">,
    options: FetchOptions,
): Promise<APIResult<ResponseType<Path, "post">>>
Type Parameters
- Path extends keyof paths
Parameters
- endpoint: Path
- data: RequestBody<Path, "post">
- options: FetchOptions
Returns Promise<APIResult<ResponseType<Path, "post">>>
Inherited from APIBase.post
- Defined in api-client/api-base.ts:221

`Protected`put

put<Path extends keyof paths>(
    endpoint: Path,
    data: RequestBody<Path, "put">,
    options: FetchOptions,
): Promise<APIResult<ResponseType<Path, "put">>>
Type Parameters
- Path extends keyof paths
Parameters
- endpoint: Path
- data: RequestBody<Path, "put">
- options: FetchOptions
Returns Promise<APIResult<ResponseType<Path, "put">>>
Inherited from APIBase.put
- Defined in api-client/api-base.ts:236

Tokens

generateRegistrationToken

generateRegistrationToken(
    args: {
        check:
            | {
                attendeeId: string;
                flags?: null
                | Record<string, unknown>;
                session_type?: null | string;
            }
            | {
                authCode: string;
                flags?: null
                | Record<string, unknown>;
                session_type?: null | string;
            }
            | {
                flags?: null
                | Record<string, unknown>;
                security_question: {
                    answer: string;
                    attendeeId: string;
                    userdataFieldKey?: string;
                };
                session_type?: null
                | string;
            };
        instanceName: string;
    },
    options?: FetchOptions,
): Promise<APIResult<string>>
Parameters
- args: {
      check:
          | {
              attendeeId: string;
              flags?: null
              | Record<string, unknown>;
              session_type?: null | string;
          }
          | {
              authCode: string;
              flags?: null
              | Record<string, unknown>;
              session_type?: null | string;
          }
          | {
              flags?: null
              | Record<string, unknown>;
              security_question: {
                  answer: string;
                  attendeeId: string;
                  userdataFieldKey?: string;
              };
              session_type?: null
              | string;
          };
      instanceName: string;
  }
- options: FetchOptions = {}
Returns Promise<APIResult<string>>
- Defined in api-client/index.ts:202

User

getUser

getUser(
    options?: FetchOptions,
): Promise<
    APIResult<
        {
            email: string;
            groups: { [key: string]: ("team" | "external")[] };
            isAdmin: boolean;
            permissions: {
                [key: string]: (
                    | "attendees:read"
                    | "attendees:create"
                    | "attendees:write"
                    | "attendees:write:bulk"
                    | "attendees:import"
                    | "attendees:export"
                    | "attendees:delete:soft"
                    | "attendees:delete:final"
                    | "emails:send"
                    | "emails:send:bulk"
                    | "email-config:write"
                    | "eventlog:read"
                    | "pdfs:write"
                    | "pdfs:export"
                    | "payment:write"
                    | "checkins:write"
                    | "branches:write"
                    | "files:write"
                    | "fields:write"
                    | "fields:read"
                    | "templates:write"
                    | "register-flow:write"
                    | "export-config:write"
                    | "instance-info:read"
                    | "instance-info:write"
                    | "domains:manage"
                    | "stats:read"
                    | "stats:write"
                    | "backup:write"
                    | "variables:read"
                    | "variables:write"
                    | "webhooks:read"
                    | "webhooks:write"
                )[];
            };
            userdata: Record<string, unknown>;
            username: string;
        },
    >,
>
Parameters
- options: FetchOptions = {}
Returns Promise<
    APIResult<
        {
            email: string;
            groups: { [key: string]: ("team" | "external")[] };
            isAdmin: boolean;
            permissions: {
                [key: string]: (
                    | "attendees:read"
                    | "attendees:create"
                    | "attendees:write"
                    | "attendees:write:bulk"
                    | "attendees:import"
                    | "attendees:export"
                    | "attendees:delete:soft"
                    | "attendees:delete:final"
                    | "emails:send"
                    | "emails:send:bulk"
                    | "email-config:write"
                    | "eventlog:read"
                    | "pdfs:write"
                    | "pdfs:export"
                    | "payment:write"
                    | "checkins:write"
                    | "branches:write"
                    | "files:write"
                    | "fields:write"
                    | "fields:read"
                    | "templates:write"
                    | "register-flow:write"
                    | "export-config:write"
                    | "instance-info:read"
                    | "instance-info:write"
                    | "domains:manage"
                    | "stats:read"
                    | "stats:write"
                    | "backup:write"
                    | "variables:read"
                    | "variables:write"
                    | "webhooks:read"
                    | "webhooks:write"
                )[];
            };
            userdata: Record<string, unknown>;
            username: string;
        },
    >,
>
- Defined in api-client/index.ts:313

updateUser

updateUser(
    args: { userdata: Record<string, unknown> },
    options?: FetchOptions,
): Promise<
    APIResult<
        {
            email: string;
            groups: { [key: string]: ("team" | "external")[] };
            isAdmin: boolean;
            permissions: {
                [key: string]: (
                    | "attendees:read"
                    | "attendees:create"
                    | "attendees:write"
                    | "attendees:write:bulk"
                    | "attendees:import"
                    | "attendees:export"
                    | "attendees:delete:soft"
                    | "attendees:delete:final"
                    | "emails:send"
                    | "emails:send:bulk"
                    | "email-config:write"
                    | "eventlog:read"
                    | "pdfs:write"
                    | "pdfs:export"
                    | "payment:write"
                    | "checkins:write"
                    | "branches:write"
                    | "files:write"
                    | "fields:write"
                    | "fields:read"
                    | "templates:write"
                    | "register-flow:write"
                    | "export-config:write"
                    | "instance-info:read"
                    | "instance-info:write"
                    | "domains:manage"
                    | "stats:read"
                    | "stats:write"
                    | "backup:write"
                    | "variables:read"
                    | "variables:write"
                    | "webhooks:read"
                    | "webhooks:write"
                )[];
            };
            userdata: Record<string, unknown>;
            username: string;
        },
    >,
>
Parameters
- args: { userdata: Record<string, unknown> }
  - userdata: Record<string, unknown>
    Userdata
- options: FetchOptions = {}
Returns Promise<
    APIResult<
        {
            email: string;
            groups: { [key: string]: ("team" | "external")[] };
            isAdmin: boolean;
            permissions: {
                [key: string]: (
                    | "attendees:read"
                    | "attendees:create"
                    | "attendees:write"
                    | "attendees:write:bulk"
                    | "attendees:import"
                    | "attendees:export"
                    | "attendees:delete:soft"
                    | "attendees:delete:final"
                    | "emails:send"
                    | "emails:send:bulk"
                    | "email-config:write"
                    | "eventlog:read"
                    | "pdfs:write"
                    | "pdfs:export"
                    | "payment:write"
                    | "checkins:write"
                    | "branches:write"
                    | "files:write"
                    | "fields:write"
                    | "fields:read"
                    | "templates:write"
                    | "register-flow:write"
                    | "export-config:write"
                    | "instance-info:read"
                    | "instance-info:write"
                    | "domains:manage"
                    | "stats:read"
                    | "stats:write"
                    | "backup:write"
                    | "variables:read"
                    | "variables:write"
                    | "webhooks:read"
                    | "webhooks:write"
                )[];
            };
            userdata: Record<string, unknown>;
            username: string;
        },
    >,
>
- Defined in api-client/index.ts:320

Variables

createVariable

createVariable(
    args: {
        instanceName: string;
        variable: {
            isPrivate: boolean;
            name: string;
            title: string;
            value: string;
            variableType: "text";
        };
    },
    options?: FetchOptions,
): Promise<
    APIResult<
        {
            isPrivate: boolean;
            name: string;
            title: string;
            value: string;
            variableType: "text";
        },
    >,
>
Parameters
- args: {
      instanceName: string;
      variable: {
          isPrivate: boolean;
          name: string;
          title: string;
          value: string;
          variableType: "text";
      };
  }
- options: FetchOptions = {}
Returns Promise<
    APIResult<
        {
            isPrivate: boolean;
            name: string;
            title: string;
            value: string;
            variableType: "text";
        },
    >,
>
- Defined in api-client/index.ts:254

deleteVariable

deleteVariable(
args: { instanceName: string; variableName: string },
options?: FetchOptions,
): Promise<APIResult<null>>
Parameters
- args: { instanceName: string; variableName: string }
- options: FetchOptions = {}
Returns Promise<APIResult<null>>
- Defined in api-client/index.ts:295

getVariable

getVariable(
    args: { instanceName: string; variableName: string },
    options?: FetchOptions,
): Promise<
    APIResult<
        {
            isPrivate: boolean;
            name: string;
            title: string;
            value: string;
            variableType: "text";
        },
    >,
>
Parameters
- args: { instanceName: string; variableName: string }
- options: FetchOptions = {}
Returns Promise<
    APIResult<
        {
            isPrivate: boolean;
            name: string;
            title: string;
            value: string;
            variableType: "text";
        },
    >,
>
- Defined in api-client/index.ts:236

getVariableList

getVariableList(
    args: { instanceName: string },
    options?: FetchOptions,
): Promise<
    APIResult<
        {
            isPrivate: boolean;
            name: string;
            title: string;
            value: string;
            variableType: "text";
        }[],
    >,
>
Parameters
- args: { instanceName: string }
- options: FetchOptions = {}
Returns Promise<
    APIResult<
        {
            isPrivate: boolean;
            name: string;
            title: string;
            value: string;
            variableType: "text";
        }[],
    >,
>
- Defined in api-client/index.ts:223

updateVariable

updateVariable(
    args: {
        instanceName: string;
        update: {
            isPrivate?: null | boolean;
            title?: null | string;
            value?: null | string;
        };
        variableName: string;
    },
    options?: FetchOptions,
): Promise<
    APIResult<
        {
            isPrivate: boolean;
            name: string;
            title: string;
            value: string;
            variableType: "text";
        },
    >,
>
Parameters
- args: {
      instanceName: string;
      update: {
          isPrivate?: null | boolean;
          title?: null | string;
          value?: null | string;
      };
      variableName: string;
  }
- options: FetchOptions = {}
Returns Promise<
    APIResult<
        {
            isPrivate: boolean;
            name: string;
            title: string;
            value: string;
            variableType: "text";
        },
    >,
>
- Defined in api-client/index.ts:272

Class API

Hierarchy

Index

Attendees

Auth

Counts

Emails

Events

Fields

Instances

Other

Tokens

User

Variables

Attendees

getAttendee

Parameters

Returns Promise<APIResult<Attendee>>

getAttendeeList

Parameters

Returns Promise<APIResult<Attendee[]>>

getCompanions

Parameters

Returns Promise<APIResult<Attendee[]>>

Auth

logout

Returns Promise<void>

StaticfetchAccessToken

Parameters

Returns Promise<Result<string, { accessToken: string; expires: Date }>>

Counts

calculateCustomCounts

Parameters

counter: { filter: string; name: string }[]

instanceName: string

Returns Promise<APIResult<{ [key: string]: number }>>

Example

getCheckinCounts

Parameters

Returns Promise<APIResult<CheckinCounts>>

Emails

getRenderedEmail

Parameters

Returns Promise< APIResult< { htmlContent: null | string; plaintextContent: string; subject: string; }, >,>

sendEmail

Parameters

Returns Promise<APIResult<null>>

Events

createEvents

Parameters

attendeeId: string

Optionalevent?: "attendee-auth-code-requested"

Default

Constant

Optionalid?: string

instanceName: string

Optionalbranches?: string[]

Default

Optionalcheckin?: { [key: string]: { checkins?: { counterName?: (...) | (...); id: string; time: string }[]; deleted?: string[]; };}

Default

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

Default

Optionaldeleted?: boolean

Default

id: string

language: null | string

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; };}

Default

Optionaltags?: string[]

Default

Optionaltime?: string

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

Default

Optionalevent?: "attendee-created"

Default

Constant

Optionalid?: string

instanceName: string

attendeeId: string

`Static`fetchAccessToken

Returns Promise<
APIResult<
{
htmlContent: null
| string;
plaintextContent: string;
subject: string;
},
>,
>

`Optional`event?: "attendee-auth-code-requested"

`Optional`id?: string

`Optional`branches?: string[]

`Optional`checkin?: {
[key: string]: {
checkins?: { counterName?: (...) | (...); id: string; time: string }[];
deleted?: string[];
};
}

`Optional`companions?:
| { isCompanion?: true; mainGuestId: string; mainGuestName?: string }
| { companionNames?: { [key: string]: string }; isCompanion?: false }

`Optional`deleted?: boolean

`Optional`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;
}

`Optional`rsvp?: {
[key: string]:
| null
| {
checkinCounters?: string[];
personCount: number;
tieBreaker?: string;
time: null
| string;
};
}

`Optional`tags?: string[]

`Optional`time?: string

`Optional`userdata?: {
[key: string]:
| null
| string
| number
| boolean
| string[]
| { file: string; name: string; size: number };
}

`Optional`event?: "attendee-created"

`Optional`id?: string

`Optional`event?: "attendee-deleted"

`Optional`id?: string

`Optional`event?: "attendee-responded"

`Optional`id?: string

`Optional`responseTime?: string

rsvp: {
[key: string]:
| null
| {
checkinCounters?: string[];
personCount: number;
tieBreaker?: string;
time: null
| string;
};
}

`Optional`event?: "attendee-updated"

`Optional`id?: string

`Optional`time?: string

`Optional`branches?: string[]

`Optional`companions?:
| { isCompanion?: true; mainGuestId: string; mainGuestName?: string }
| { companionNames?: { [key: string]: string }; isCompanion?: false }

`Optional`deletedBranches?: string[]

`Optional`deletedTags?: string[]

`Optional`language?: string

`Optional`partialPayment?: {
amount?: number;
currency?: "USD" | "EUR" | "CHF";
paid?: boolean;
provider?:
| "manual"
| "sepa"
| "credit"
| "bank_transfer"
| "paypal"
| "stripe";
}

`Optional`amount?: number

`Optional`currency?: "USD" | "EUR" | "CHF"

`Optional`paid?: boolean

`Optional`provider?: "manual" | "sepa" | "credit" | "bank_transfer" | "paypal" | "stripe"

`Optional`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;
}

`Optional`rsvp?: {
[key: string]:
| null
| {
checkinCounters?: string[];
personCount: number;
tieBreaker?: string;
time: null
| string;
};
}

`Optional`tags?: string[]

`Optional`userdata?: {
[key: string]:
| null
| string
| number
| boolean
| string[]
| { file: string; name: string; size: number };
}

`Optional`counterName?: string

`Optional`event?: "checkin-created"

`Optional`id?: string

`Optional`event?: "checkin-deleted"

`Optional`id?: string

emailStatus: {
clicks?: string[];
clients?: string[];
mailing_id: string;
reason?: string | string[];
status:
| "pending"
| "waiting"
| "submitted"
| "skipped"
| "sent"
| "opened"
| "clicked"
| "invalid"
| "rejected"
| "unsubscribed";
time?: null
| string;
updated_at?: string;
}

`Optional`clicks?: string[]

`Optional`clients?: string[]

`Optional`reason?: string | string[]

status:
| "pending"
| "waiting"
| "submitted"
| "skipped"
| "sent"
| "opened"
| "clicked"
| "invalid"
| "rejected"
| "unsubscribed"

`Optional`time?: null | string